user

type CMSCodeStatsByUserMonthYear struct {
	GithubName string `json:"githubname"`
	Month      int    `json:"month"`
	Year       int    `json:"year"`
}

type CMSCodeStatsByUserMonthYearReply struct {
	UserCodeStats []CodeStats `json:"usercodestats"`
}

type CMSUser struct {
	User
	Domain             int         `json:"domain"` // Contractor domain
	GitHubName         string      `json:"githubname"`
	MatrixName         string      `json:"matrixname"`
	ContractorType     int         `json:"contractortype"`
	ContractorName     string      `json:"contractorname"`
	ContractorLocation string      `json:"contractorlocation"`
	ContractorContact  string      `json:"contractorcontact"`
	SupervisorUserIDs  []uuid.UUID `json:"supervisoruserids"`
	ProposalsOwned     []string    `json:"proposalsowned"`
}

type CMSUserByID struct {
	ID string `json:"id"` // Contractor user id
}

type CMSUserByIDReply struct {
	User *CMSUser `json:"user"`
}

type CMSUserSubContractors struct {
	ID string `json:"id"` // Contractor user id
}

type CMSUserSubContractorsReply struct {
	Users []CMSUser `json:"users"`
}

type CMSUsersByContractorType struct {
	ContractorType int `json:"contractortype"` // Contractor type
}

type CMSUsersByContractorTypeReply struct {
	Users []CMSUser `json:"users"`
}

type CMSUsersByDomain struct {
	Domain int `json:"domain"` // Contractor domain
}

type CMSUsersByDomainReply struct {
	Users []CMSUser `json:"users"`
}

type CMSUsersByProposalToken struct {
	Token string `json:"token"` // Proposal token
}

type CMSUsersByProposalTokenReply struct {
	Users []CMSUser `json:"users"`
}

type CodeStats struct {
	ID               string   // UserID + GithubName + Month + Year
	Repository       string   // Repository
	GitHubName       string   // GithubName
	Month            int      // Month of code stats
	Year             int      // Year of code stats
	PRs              []string // All PR URLs
	Reviews          []string // All Reviewed PR URLS
	Commits          []string // All of the commit URLS
	MergedAdditions  int64    // Total merged code additions
	MergedDeletions  int64    // Total merged code deletions
	UpdatedAdditions int64    // Total updated code additions
	UpdatedDeletions int64    // Total updated code deletions
	ReviewAdditions  int64    // Total reviewed code additions
	ReviewDeletions  int64    // Total reviewed code deletions
	CommitAdditions  int64    // Total committed code additions
	CommitDeletions  int64    // Total committed code deletions
}

type Database interface {
	// Add a new user
	UserNew(User) error

	// Update an existing user
	UserUpdate(User) error

	// Return user record given the username
	UserGetByUsername(string) (*User, error)

	// Return user record given its id
	UserGetById(uuid.UUID) (*User, error)

	// Return user record given a public key
	UserGetByPubKey(string) (*User, error)

	// Return a map of public key to user record
	UsersGetByPubKey(pubKeys []string) (map[string]User, error)

	// Insert a user to the database.
	// Intended to be used for migration between databases.
	InsertUser(User) error

	// Iterate over all users
	AllUsers(callbackFn func(u *User)) error

	// Create or update a user session
	SessionSave(Session) error

	// Return a user session given its id
	SessionGetByID(sessionID string) (*Session, error)

	// Delete a user session given its id
	SessionDeleteByID(sessionID string) error

	// Delete all sessions for a user except for the given session IDs
	SessionsDeleteByUserID(id uuid.UUID, exemptSessionIDs []string) error

	// SetPaywallAddressIndex updates the paywall address index.
	SetPaywallAddressIndex(index uint64) error

	// Rotate encryption keys
	RotateKeys(newKeyPath string) error

	// Register a plugin
	RegisterPlugin(Plugin) error

	// Execute a plugin command
	PluginExec(PluginCommand) (*PluginCommandReply, error)

	// Close performs cleanup of the backend.
	Close() error
}

type EmailHistory struct {
	Timestamps []int64 `json:"timestamps"` // Received email UNIX ts

	// LimitWarningSent is used to track users that have hit the rate
	// limit and have already been sent a notification email letting
	// them know that they hit the rate limit.
	LimitWarningSent bool `json:"limitwarningsent"`
}

type Identity struct {
	Key         [identity.PublicKeySize]byte `json:"key"`         // ed25519 public key
	Activated   int64                        `json:"activated"`   // Time key as activated for use
	Deactivated int64                        `json:"deactivated"` // Time key was deactivated
}

type MailerDB interface {
	// EmailHistoriesSave saves the provided email histories to the
	// database. The histories map contains map[userid]EmailHistory.
	EmailHistoriesSave(histories map[uuid.UUID]EmailHistory) error

	// EmailHistoriesGet retrieves the email histories for the provided
	// user IDs. The returned map[userid]EmailHistory will contain an
	// entry for each of the provided user ID. If a provided user ID
	// does not correspond to a user in the database then the entry will
	// be skipped in the returned map. An error is not returned.
	EmailHistoriesGet(users []uuid.UUID) (map[uuid.UUID]EmailHistory, error)
}

type NewCMSCodeStats struct {
	UserCodeStats []CodeStats `json:"usercodestats"`
}

type NewCMSCodeStatsReply struct{}

type NewCMSUser struct {
	Email                     string `json:"email"`
	Username                  string `json:"username"`
	NewUserVerificationToken  []byte `json:"newuserverificationtoken"`
	NewUserVerificationExpiry int64  `json:"newuserverificationtokenexiry"`
	ContractorType            int    `json:"contractortype"`
}

type NewCMSUserReply struct{}

type Plugin struct {
	ID       string
	Version  string
	Settings []PluginSetting
}

type PluginCommand struct {
	ID      string // Plugin identifier
	Command string // Command identifier
	Payload string // Command payload
}

type PluginCommandReply struct {
	ID      string // Plugin identifier
	Command string // Command identifier
	Payload string // Command reply payload
}

type PluginSetting struct {
	Key   string // Name of setting
	Value string // Value of setting
}

type ProposalCredit struct {
	PaywallID       uint64 `json:"paywallid"`       // Proposal paywall ID of associated paywall
	Price           uint64 `json:"price"`           // Credit price in atoms
	DatePurchased   int64  `json:"datepurchased"`   // Unix timestamp of credit purchase
	TxID            string `json:"txid"`            // Payment transaction ID
	CensorshipToken string `json:"censorshiptoken"` // Token of proposal that spent this credit
}

type ProposalPaywall struct {
	ID          uint64 `json:"id"`          // Paywall ID
	CreditPrice uint64 `json:"creditprice"` // Cost per proposal credit in atoms
	Address     string `json:"address"`     // Paywall address
	TxNotBefore int64  `json:"txnotbefore"` // Unix timestamp of minimum timestamp for paywall tx
	PollExpiry  int64  `json:"pollexpiry"`  // Unix timestamp of expiration time of paywall polling
	TxID        string `json:"txid"`        // Payment transaction ID
	TxAmount    uint64 `json:"txamount"`    // Amount sent to paywall address in atoms
	NumCredits  uint64 `json:"numcredits"`  // Number of proposal credits created by payment tx
}

type Session struct {
	ID        string    `json:"id"`        // Unique session ID
	UserID    uuid.UUID `json:"userid"`    // User UUID
	CreatedAt int64     `json:"createdat"` // Created at UNIX timestamp
	Values    string    `json:"values"`    // Encoded session values
}

type UpdateCMSCodeStats struct {
	UserCodeStats []CodeStats `json:"usercodestats"`
}

type UpdateCMSCodeStatsReply struct{}

type UpdateCMSUser struct {
	ID                 uuid.UUID   `json:"id"`
	Domain             int         `json:"domain"` // Contractor domain
	GitHubName         string      `json:"githubname"`
	MatrixName         string      `json:"matrixname"`
	ContractorType     int         `json:"contractortype"`
	ContractorName     string      `json:"contractorname"`
	ContractorLocation string      `json:"contractorlocation"`
	ContractorContact  string      `json:"contractorcontact"`
	SupervisorUserIDs  []uuid.UUID `json:"supervisoruserids"`
	ProposalsOwned     []string    `json:"proposalsowned"`
}

type UpdateCMSUserReply struct{}

type User struct {
	ID                  uuid.UUID `json:"id"`                  // Unique user uuid
	Email               string    `json:"email"`               // Email address
	Username            string    `json:"username"`            // Unique username
	HashedPassword      []byte    `json:"hashedpassword"`      // Blowfish hash
	Admin               bool      `json:"admin"`               // Is user an admin
	EmailNotifications  uint64    `json:"emailnotifications"`  // Email notification setting
	LastLoginTime       int64     `json:"lastlogintime"`       // Unix timestamp of last login
	FailedLoginAttempts uint64    `json:"failedloginattempts"` // Sequential failed login attempts
	Deactivated         bool      `json:"deactivated"`         // Is account deactivated

	// Verification tokens and their expirations
	NewUserVerificationToken        []byte `json:"newuserverificationtoken"`
	NewUserVerificationExpiry       int64  `json:"newuserverificationtokenexiry"`
	ResendNewUserVerificationExpiry int64  `json:"resendnewuserverificationtoken"`
	UpdateKeyVerificationToken      []byte `json:"updatekeyverificationtoken"`
	UpdateKeyVerificationExpiry     int64  `json:"updatekeyverificationexpiry"`
	ResetPasswordVerificationToken  []byte `json:"resetpasswordverificationtoken"`
	ResetPasswordVerificationExpiry int64  `json:"resetpasswordverificationexpiry"`

	// PaywallAddressIndex is the index that is used to generate the
	// paywall address for the user. The same paywall address is used
	// for the user registration paywall and for proposal credit
	// paywalls. The index is set during the new user record creation
	// and is sequential.
	// XXX why is this an uint64 when hdkeychain requires a uint32?
	PaywallAddressIndex uint64 `json:"paywalladdressindex"`

	// User registration paywall info
	NewUserPaywallAddress string `json:"newuserpaywalladdress"`
	NewUserPaywallAmount  uint64 `json:"newuserpaywallamount"`
	NewUserPaywallTx      string `json:"newuserpaywalltx"`

	// NewUserPaywallTxNotBeore is the minimum UNIX time (in seconds)
	// required for the block containing the transaction sent to
	// NewUserPaywallAddress. If the user has already paid, this field
	// will be empty.
	NewUserPaywallTxNotBefore int64 `json:"newuserpaywalltxnotbefore"`

	// The UNIX time (in seconds) for when the server will stop polling
	// the server for transactions at NewUserPaywallAddress. If the
	// user has already paid, this field will be empty.
	NewUserPaywallPollExpiry int64 `json:"newuserpaywallpollexpiry"`

	// User access times for proposal comments. The access time is a
	// Unix timestamp of the last time the user accessed a proposal's
	// comments.
	// [token]accessTime
	ProposalCommentsAccessTimes map[string]int64 `json:"proposalcommentsaccesstime"`

	// All identities the user has ever used. We allow the user to change
	// identities to deal with key loss. An identity can be in one of three
	// states: inactive, active, or deactivated.
	//
	// Inactive identities
	// An identity is consider inactive until it has been verified.
	// An unverified user will have an inactive identity.
	// A user will only ever have one inactive identity at a time.
	//
	// Active identities
	// A verified user will always have one active identity.
	// A verified user may have both an active and inactive identity if
	// they have requested a new identity but have not yet verified it.
	//
	// Deactivated identities
	// An identity is deactivated when it is replaced by a new identity.
	// The key of a deactivated identity is no longer valid.
	// An identity cannot be re-activated once it has been deactivated.
	Identities []Identity `json:"identities"`

	// All proposal paywalls that have been issued to the user in chronological
	// order.
	ProposalPaywalls []ProposalPaywall `json:"proposalpaywalls"`

	// All proposal credits that have been purchased by the user, but have not
	// yet been used to submit a proposal.  Once a credit is used to submit a
	// proposal, it is updated with the proposal's censorship token and moved to
	// the user's spent proposal credits list.  The price that the proposal
	// credit was purchased at is in atoms.
	UnspentProposalCredits []ProposalCredit `json:"unspentproposalcredits"`

	// All credits that have been purchased by the user and have already been
	// used to submit proposals.  Spent credits have a proposal censorship token
	// associated with them to signify that they have been spent. The price that
	// the proposal credit was purchased at is in atoms.
	SpentProposalCredits []ProposalCredit `json:"spentproposalcredits"`

	// TOTP Secret Key and type of TOTP being used.
	TOTPSecret             string  `json:"totpsecret"`
	TOTPType               int     `json:"totptype"`
	TOTPVerified           bool    `json:"totpverified"` // whether current totp secret has been verified with
	TOTPLastUpdated        []int64 `json:"totplastupdated"`
	TOTPLastFailedCodeTime []int64 `json:"totplastfailedcodetime"`
}