Documentation
¶
Index ¶
- Constants
- type DatabaseObject
- func (dbo *DatabaseObject) ApprovePreRegUser(email cm.Email) (err error)
- func (dbo *DatabaseObject) ApproveUserByEmail(email cm.Email) (err error)
- func (dbo *DatabaseObject) AttachVerificationCodeToPreRegUser(email cm.Email, code cm.VerificationCode) (err error)
- func (dbo *DatabaseObject) AttachVerificationCodeToPreSession(userId cmb.Id, requestId cm.RequestId, code cm.VerificationCode) (err error)
- func (dbo *DatabaseObject) CheckVerificationCodeForLogIn(requestId cm.RequestId, code cm.VerificationCode) (ok bool, err error)
- func (dbo *DatabaseObject) CheckVerificationCodeForPreReg(email cm.Email, code cm.VerificationCode) (ok bool, err error)
- func (dbo *DatabaseObject) CheckVerificationCodeForPwdChange(requestId cm.RequestId, code cm.VerificationCode) (ok bool, err error)
- func (dbo *DatabaseObject) CheckVerificationCodesForEmailChange(requestId cm.RequestId, codeOld cm.VerificationCode, ...) (ok bool, err error)
- func (dbo *DatabaseObject) CountAllUsers() (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountEmailChangesByUserId(userId cmb.Id) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountLoggedUsers() (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountPasswordChangesByUserId(userId cmb.Id) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountPreSessionsByUserEmail(email cm.Email) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountRegistrationsReadyForApproval() (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountSessionsByUserEmail(email cm.Email) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountSessionsByUserId(userId cmb.Id) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountUsersWithEmail(email cm.Email) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountUsersWithEmailAbleToLogIn(email cm.Email) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CountUsersWithName(name cm.Name) (n cmb.Count, err error)
- func (dbo *DatabaseObject) CreateEmailChangeRequest(ecr *am.EmailChange) (err error)
- func (dbo *DatabaseObject) CreatePasswordChangeRequest(pcr *am.PasswordChange) (err error)
- func (dbo *DatabaseObject) CreatePreSession(userId cmb.Id, requestId cm.RequestId, userIPAB net.IP, pwdSalt []byte, ...) (err error)
- func (dbo *DatabaseObject) CreateSession(userId cmb.Id, userIPAB net.IP) (lastInsertedId cmb.Id, err error)
- func (dbo *DatabaseObject) DeleteAbandonedPreSessions() (err error)
- func (dbo *DatabaseObject) DeleteEmailChangeByRequestId(requestId cm.RequestId) (err error)
- func (dbo *DatabaseObject) DeletePasswordChangeByRequestId(requestId cm.RequestId) (err error)
- func (dbo *DatabaseObject) DeletePreRegUserIfNotApprovedByEmail(email cm.Email) (err error)
- func (dbo *DatabaseObject) DeletePreSessionByRequestId(requestId cm.RequestId) (err error)
- func (dbo *DatabaseObject) DeleteSession(sessionId cmb.Id, userId cmb.Id, userIPAB net.IP) (err error)
- func (dbo *DatabaseObject) DeleteSessionByUserId(userId cmb.Id) (err error)
- func (dbo *DatabaseObject) GetEmailChangeByRequestId(requestId cm.RequestId) (ecr *am.EmailChange, err error)
- func (dbo *DatabaseObject) GetListOfAllUsers() (userIds []cmb.Id, err error)
- func (dbo *DatabaseObject) GetListOfAllUsersOnPage(pageNumber cmb.Count, pageSize cmb.Count) (userIds []cmb.Id, err error)
- func (dbo *DatabaseObject) GetListOfLoggedUsers() (userIds []cmb.Id, err error)
- func (dbo *DatabaseObject) GetListOfLoggedUsersOnPage(pageNumber cmb.Count, pageSize cmb.Count) (userIds []cmb.Id, err error)
- func (dbo *DatabaseObject) GetListOfRegistrationsReadyForApproval(pageNumber cmb.Count, pageSize cmb.Count) (rrfas []am.RegistrationReadyForApproval, err error)
- func (dbo *DatabaseObject) GetPasswordChangeByRequestId(requestId cm.RequestId) (pcr *am.PasswordChange, err error)
- func (dbo *DatabaseObject) GetPreSessionByRequestId(requestId cm.RequestId) (preSession *am.PreSession, err error)
- func (dbo *DatabaseObject) GetPreparedStatementByIndex(i int) (ps *sql.Stmt)
- func (dbo *DatabaseObject) GetSessionByUserId(userId cmb.Id) (session *am.Session, err error)
- func (dbo *DatabaseObject) GetUserById(userId cmb.Id) (user *am.User, err error)
- func (dbo *DatabaseObject) GetUserIdByEmail(email cm.Email) (userId cmb.Id, err error)
- func (dbo *DatabaseObject) GetUserLastBadActionTimeById(userId cmb.Id) (lastBadActionTime *time.Time, err error)
- func (dbo *DatabaseObject) GetUserLastBadLogInTimeByEmail(email cm.Email) (lastBadLogInTime *time.Time, err error)
- func (dbo *DatabaseObject) GetUserNameById(userId cmb.Id) (userName *cm.Name, err error)
- func (dbo *DatabaseObject) GetUserPasswordById(userId cmb.Id) (password *[]byte, err error)
- func (dbo *DatabaseObject) GetUserRolesById(userId cmb.Id) (roles *cm.UserRoles, err error)
- func (dbo *DatabaseObject) Init() (err error)
- func (dbo *DatabaseObject) InsertPreRegisteredUser(email cm.Email) (err error)
- func (dbo *DatabaseObject) RegisterPreRegUser(email cm.Email) (err error)
- func (dbo *DatabaseObject) RejectRegistrationRequest(id cmb.Id) (err error)
- func (dbo *DatabaseObject) SaveIncident(module cm.Module, incidentType cm.IncidentType, email cm.Email, ...) (err error)
- func (dbo *DatabaseObject) SaveIncidentWithoutUserIPA(module cm.Module, incidentType cm.IncidentType, email cm.Email) (err error)
- func (dbo *DatabaseObject) SaveLogEvent(logEvent *am.LogEvent) (err error)
- func (dbo *DatabaseObject) SetEmailChangeVFlags(userId cmb.Id, requestId cm.RequestId, ecvf *am.EmailChangeVerificationFlags) (err error)
- func (dbo *DatabaseObject) SetPasswordChangeVFlags(userId cmb.Id, requestId cm.RequestId, ...) (err error)
- func (dbo *DatabaseObject) SetPreRegUserData(email cm.Email, code cm.VerificationCode, name cm.Name, password []byte) (err error)
- func (dbo *DatabaseObject) SetPreRegUserEmailSendStatus(emailSendStatus cmb.Flag, email cm.Email) (err error)
- func (dbo *DatabaseObject) SetPreSessionCaptchaFlags(userId cmb.Id, requestId cm.RequestId, isVerifiedByCaptcha cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetPreSessionEmailSendStatus(userId cmb.Id, requestId cm.RequestId, emailSendStatus cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetPreSessionPasswordFlag(userId cmb.Id, requestId cm.RequestId, isVerifiedByPassword cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetPreSessionVerificationFlag(userId cmb.Id, requestId cm.RequestId, isVerifiedByEmail cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetUserEmail(userId cmb.Id, email cm.Email, newEmail cm.Email) (err error)
- func (dbo *DatabaseObject) SetUserPassword(userId cmb.Id, email cm.Email, newPassword []byte) (err error)
- func (dbo *DatabaseObject) SetUserRoleAuthor(userId cmb.Id, isRoleEnabled cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetUserRoleCanLogIn(userId cmb.Id, isRoleEnabled cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetUserRoleReader(userId cmb.Id, isRoleEnabled cmb.Flag) (err error)
- func (dbo *DatabaseObject) SetUserRoleWriter(userId cmb.Id, isRoleEnabled cmb.Flag) (err error)
- func (dbo *DatabaseObject) UpdatePreSessionRequestId(userId cmb.Id, requestIdOld cm.RequestId, requestIdNew cm.RequestId) (err error)
- func (dbo *DatabaseObject) UpdateUserBanTime(userId cmb.Id) (err error)
- func (dbo *DatabaseObject) UpdateUserLastBadActionTimeById(userId cmb.Id) (err error)
- func (dbo *DatabaseObject) UpdateUserLastBadLogInTimeByEmail(email cm.Email) (err error)
- func (dbo *DatabaseObject) ViewUserParametersById(userId cmb.Id) (userParameters *cm.UserParameters, err error)
- type SystemParameters
- type TableNames
Constants ¶
View Source
const ( TablePreRegisteredUsers = "PreRegisteredUsers" TableUsers = "Users" TablePreSessions = "PreSessions" TableSessions = "Sessions" TableIncidents = "Incidents" TablePasswordChanges = "PasswordChanges" TableEmailChanges = "EmailChanges" TableLogEvents = "LogEvents" )
View Source
const ( DbPsid_CountUsersWithEmail = 0 DbPsid_InsertPreRegisteredUser = 1 DbPsid_AttachVerificationCodeToPreRegUser = 2 DbPsid_CheckVerificationCodeForPreReg = 3 DbPsid_DeletePreRegUserIfNotApprovedByEmail = 4 DbPsid_ApprovePreRegUserEmail = 5 DbPsid_SetPreRegUserData = 6 DbPsid_ApprovePreRegUser = 7 DbPsid_RegisterPreRegUserP1 = 8 DbPsid_RegisterPreRegUserP2 = 9 DbPsid_CountUsersWithName = 10 DbPsid_ClearPreRegUsersTable = 11 DbPsid_CountUsersWithEmailAbleToLogIn = 12 DbPsid_DeleteAbandonedPreSessions = 13 DbPsid_CountSessionsByUserEmail = 14 DbPsid_CountPreSessionsByUserEmail = 15 DbPsid_GetUserLastBadLogInTimeByEmail = 16 DbPsid_CreatePreSession = 17 DbPsid_GetUserIdByEmail = 18 DbPsid_UpdateUserLastBadLogInTimeByEmail = 19 DbPsid_GetPreSessionByRequestId = 20 DbPsid_GetUserPasswordById = 21 DbPsid_DeletePreSessionByRequestId = 22 DbPsid_SetPreSessionCaptchaFlag = 23 DbPsid_SetPreSessionPasswordFlag = 24 DbPsid_AttachVerificationCodeToPreSession = 25 DbPsid_UpdatePreSessionRequestId = 26 DbPsid_CheckVerificationCodeForLogIn = 27 DbPsid_SetPreSessionVerificationFlag = 28 DbPsid_CreateSession = 29 DbPsid_ClearSessions = 30 DbPsid_GetUserById = 31 DbPsid_GetSessionByUserId = 32 DbPsid_DeleteSession = 33 DbPsid_SaveIncident = 34 DbPsid_SaveIncidentWithoutUserIPA = 35 DbPsid_GetListOfLoggedUsers = 36 DbPsid_CountSessionsByUserId = 37 DbPsid_GetUserRolesById = 38 DbPsid_GetUserParametersById = 39 DbPsid_SetUserRoleAuthor = 40 DbPsid_SetUserRoleWriter = 41 DbPsid_SetUserRoleReader = 42 DbPsid_SetUserRoleCanLogIn = 43 DbPsid_DeleteSessionByUserId = 44 DbPsid_UpdateUserBanTime = 45 DbPsid_SetPreRegUserEmailSendStatus = 46 DbPsid_SetPreSessionEmailSendStatus = 47 DbPsid_ClearPasswordChangesTable = 48 DbPsid_CountPasswordChangesByUserId = 49 DbPsid_UpdateUserLastBadActionTimeById = 50 DbPsid_GetUserLastBadActionTimeById = 51 DbPsid_CreatePasswordChangeRequest = 52 DbPsid_GetPasswordChangeByRequestId = 53 DbPsid_DeletePasswordChangeByRequestId = 54 DbPsid_CheckVerificationCodeForPwdChange = 55 DbPsid_SetPasswordChangeVFlags = 56 DbPsid_SetUserPassword = 57 DbPsid_CountEmailChangesByUserId = 58 DbPsid_CreateEmailChangeRequest = 59 DbPsid_GetEmailChangeByRequestId = 60 DbPsid_DeleteEmailChangeByRequestId = 61 DbPsid_CheckVerificationCodesForEmailChange = 62 DbPsid_SetEmailChangeVFlags = 63 DbPsid_SetUserEmail = 64 DbPsid_SaveLogEvent = 65 DbPsid_ClearEmailChangesTable = 66 DbPsid_CountAllUsers = 67 DbPsid_GetListOfAllUsersOnPage = 68 DbPsid_CountRegistrationsReadyForApproval = 69 DbPsid_GetListOfRegistrationsReadyForApproval = 70 DbPsid_RejectRegistrationRequest = 71 DbPsid_GetUserNameById = 72 DbPsid_GetListOfLoggedUsersOnPage = 73 DbPsid_CountLoggedUsers = 74 DbPsid_GetListOfAllUsers = 75 )
Indices of prepared statements.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DatabaseObject ¶
type DatabaseObject struct { cdbo.DatabaseObject // contains filtered or unexported fields }
func NewDatabaseObject ¶
func NewDatabaseObject(settings as.DbSettings, sp SystemParameters) (dbo *DatabaseObject)
func (*DatabaseObject) ApprovePreRegUser ¶
func (dbo *DatabaseObject) ApprovePreRegUser(email cm.Email) (err error)
func (*DatabaseObject) ApproveUserByEmail ¶
func (dbo *DatabaseObject) ApproveUserByEmail(email cm.Email) (err error)
func (*DatabaseObject) AttachVerificationCodeToPreRegUser ¶
func (dbo *DatabaseObject) AttachVerificationCodeToPreRegUser(email cm.Email, code cm.VerificationCode) (err error)
func (*DatabaseObject) AttachVerificationCodeToPreSession ¶
func (dbo *DatabaseObject) AttachVerificationCodeToPreSession(userId cmb.Id, requestId cm.RequestId, code cm.VerificationCode) (err error)
func (*DatabaseObject) CheckVerificationCodeForLogIn ¶
func (dbo *DatabaseObject) CheckVerificationCodeForLogIn(requestId cm.RequestId, code cm.VerificationCode) (ok bool, err error)
func (*DatabaseObject) CheckVerificationCodeForPreReg ¶
func (dbo *DatabaseObject) CheckVerificationCodeForPreReg(email cm.Email, code cm.VerificationCode) (ok bool, err error)
func (*DatabaseObject) CheckVerificationCodeForPwdChange ¶
func (dbo *DatabaseObject) CheckVerificationCodeForPwdChange(requestId cm.RequestId, code cm.VerificationCode) (ok bool, err error)
func (*DatabaseObject) CheckVerificationCodesForEmailChange ¶
func (dbo *DatabaseObject) CheckVerificationCodesForEmailChange(requestId cm.RequestId, codeOld cm.VerificationCode, codeNew cm.VerificationCode) (ok bool, err error)
func (*DatabaseObject) CountAllUsers ¶ added in v0.0.16
func (dbo *DatabaseObject) CountAllUsers() (n cmb.Count, err error)
func (*DatabaseObject) CountEmailChangesByUserId ¶
func (*DatabaseObject) CountLoggedUsers ¶ added in v0.0.54
func (dbo *DatabaseObject) CountLoggedUsers() (n cmb.Count, err error)
func (*DatabaseObject) CountPasswordChangesByUserId ¶
func (*DatabaseObject) CountPreSessionsByUserEmail ¶
func (*DatabaseObject) CountRegistrationsReadyForApproval ¶ added in v0.0.21
func (dbo *DatabaseObject) CountRegistrationsReadyForApproval() (n cmb.Count, err error)
func (*DatabaseObject) CountSessionsByUserEmail ¶
func (*DatabaseObject) CountSessionsByUserId ¶
func (*DatabaseObject) CountUsersWithEmail ¶
func (*DatabaseObject) CountUsersWithEmailAbleToLogIn ¶
func (*DatabaseObject) CountUsersWithName ¶
func (*DatabaseObject) CreateEmailChangeRequest ¶
func (dbo *DatabaseObject) CreateEmailChangeRequest(ecr *am.EmailChange) (err error)
func (*DatabaseObject) CreatePasswordChangeRequest ¶
func (dbo *DatabaseObject) CreatePasswordChangeRequest(pcr *am.PasswordChange) (err error)
func (*DatabaseObject) CreatePreSession ¶
func (*DatabaseObject) CreateSession ¶
func (*DatabaseObject) DeleteAbandonedPreSessions ¶
func (dbo *DatabaseObject) DeleteAbandonedPreSessions() (err error)
func (*DatabaseObject) DeleteEmailChangeByRequestId ¶
func (dbo *DatabaseObject) DeleteEmailChangeByRequestId(requestId cm.RequestId) (err error)
func (*DatabaseObject) DeletePasswordChangeByRequestId ¶
func (dbo *DatabaseObject) DeletePasswordChangeByRequestId(requestId cm.RequestId) (err error)
func (*DatabaseObject) DeletePreRegUserIfNotApprovedByEmail ¶
func (dbo *DatabaseObject) DeletePreRegUserIfNotApprovedByEmail(email cm.Email) (err error)
func (*DatabaseObject) DeletePreSessionByRequestId ¶
func (dbo *DatabaseObject) DeletePreSessionByRequestId(requestId cm.RequestId) (err error)
func (*DatabaseObject) DeleteSession ¶
func (*DatabaseObject) DeleteSessionByUserId ¶
func (dbo *DatabaseObject) DeleteSessionByUserId(userId cmb.Id) (err error)
func (*DatabaseObject) GetEmailChangeByRequestId ¶
func (dbo *DatabaseObject) GetEmailChangeByRequestId(requestId cm.RequestId) (ecr *am.EmailChange, err error)
func (*DatabaseObject) GetListOfAllUsers ¶ added in v0.0.16
func (dbo *DatabaseObject) GetListOfAllUsers() (userIds []cmb.Id, err error)
func (*DatabaseObject) GetListOfAllUsersOnPage ¶ added in v0.0.54
func (*DatabaseObject) GetListOfLoggedUsers ¶
func (dbo *DatabaseObject) GetListOfLoggedUsers() (userIds []cmb.Id, err error)
func (*DatabaseObject) GetListOfLoggedUsersOnPage ¶ added in v0.0.54
func (*DatabaseObject) GetListOfRegistrationsReadyForApproval ¶ added in v0.0.21
func (dbo *DatabaseObject) GetListOfRegistrationsReadyForApproval(pageNumber cmb.Count, pageSize cmb.Count) (rrfas []am.RegistrationReadyForApproval, err error)
func (*DatabaseObject) GetPasswordChangeByRequestId ¶
func (dbo *DatabaseObject) GetPasswordChangeByRequestId(requestId cm.RequestId) (pcr *am.PasswordChange, err error)
func (*DatabaseObject) GetPreSessionByRequestId ¶
func (dbo *DatabaseObject) GetPreSessionByRequestId(requestId cm.RequestId) (preSession *am.PreSession, err error)
func (*DatabaseObject) GetPreparedStatementByIndex ¶
func (dbo *DatabaseObject) GetPreparedStatementByIndex(i int) (ps *sql.Stmt)
func (*DatabaseObject) GetSessionByUserId ¶
func (*DatabaseObject) GetUserById ¶
func (*DatabaseObject) GetUserIdByEmail ¶
func (*DatabaseObject) GetUserLastBadActionTimeById ¶
func (*DatabaseObject) GetUserLastBadLogInTimeByEmail ¶
func (*DatabaseObject) GetUserNameById ¶ added in v0.0.38
func (*DatabaseObject) GetUserPasswordById ¶
func (dbo *DatabaseObject) GetUserPasswordById(userId cmb.Id) (password *[]byte, err error)
func (*DatabaseObject) GetUserRolesById ¶
func (*DatabaseObject) Init ¶
func (dbo *DatabaseObject) Init() (err error)
Init connects to the database, initialises the tables and prepares SQL statements.
func (*DatabaseObject) InsertPreRegisteredUser ¶
func (dbo *DatabaseObject) InsertPreRegisteredUser(email cm.Email) (err error)
func (*DatabaseObject) RegisterPreRegUser ¶
func (dbo *DatabaseObject) RegisterPreRegUser(email cm.Email) (err error)
func (*DatabaseObject) RejectRegistrationRequest ¶ added in v0.0.22
func (dbo *DatabaseObject) RejectRegistrationRequest(id cmb.Id) (err error)
func (*DatabaseObject) SaveIncident ¶
func (dbo *DatabaseObject) SaveIncident(module cm.Module, incidentType cm.IncidentType, email cm.Email, userIPAB net.IP) (err error)
func (*DatabaseObject) SaveIncidentWithoutUserIPA ¶
func (dbo *DatabaseObject) SaveIncidentWithoutUserIPA(module cm.Module, incidentType cm.IncidentType, email cm.Email) (err error)
func (*DatabaseObject) SaveLogEvent ¶
func (dbo *DatabaseObject) SaveLogEvent(logEvent *am.LogEvent) (err error)
func (*DatabaseObject) SetEmailChangeVFlags ¶
func (dbo *DatabaseObject) SetEmailChangeVFlags(userId cmb.Id, requestId cm.RequestId, ecvf *am.EmailChangeVerificationFlags) (err error)
func (*DatabaseObject) SetPasswordChangeVFlags ¶
func (dbo *DatabaseObject) SetPasswordChangeVFlags(userId cmb.Id, requestId cm.RequestId, pcvf *am.PasswordChangeVerificationFlags) (err error)
func (*DatabaseObject) SetPreRegUserData ¶
func (dbo *DatabaseObject) SetPreRegUserData(email cm.Email, code cm.VerificationCode, name cm.Name, password []byte) (err error)
func (*DatabaseObject) SetPreRegUserEmailSendStatus ¶
func (*DatabaseObject) SetPreSessionCaptchaFlags ¶
func (*DatabaseObject) SetPreSessionEmailSendStatus ¶
func (*DatabaseObject) SetPreSessionPasswordFlag ¶
func (*DatabaseObject) SetPreSessionVerificationFlag ¶
func (*DatabaseObject) SetUserEmail ¶
func (*DatabaseObject) SetUserPassword ¶
func (*DatabaseObject) SetUserRoleAuthor ¶
func (*DatabaseObject) SetUserRoleCanLogIn ¶
func (*DatabaseObject) SetUserRoleReader ¶
func (*DatabaseObject) SetUserRoleWriter ¶
func (*DatabaseObject) UpdatePreSessionRequestId ¶
func (*DatabaseObject) UpdateUserBanTime ¶
func (dbo *DatabaseObject) UpdateUserBanTime(userId cmb.Id) (err error)
func (*DatabaseObject) UpdateUserLastBadActionTimeById ¶
func (dbo *DatabaseObject) UpdateUserLastBadActionTimeById(userId cmb.Id) (err error)
func (*DatabaseObject) UpdateUserLastBadLogInTimeByEmail ¶
func (dbo *DatabaseObject) UpdateUserLastBadLogInTimeByEmail(email cm.Email) (err error)
func (*DatabaseObject) ViewUserParametersById ¶
func (dbo *DatabaseObject) ViewUserParametersById(userId cmb.Id) (userParameters *cm.UserParameters, err error)
type SystemParameters ¶
SystemParameters stores various system parameters not directly related to the database.
Click to show internal directories.
Click to hide internal directories.