db

type APIKey struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	Active           bool
	CreatedByUserID  int64
	Description      string //so user can identify what the api key is used for
	K                string //the actual api key

	//JOINed fields
	CreatedByUsername string

	//Calculated fields
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	Timezone          string //extra data for above fields for displaying in GUI.
}

type ActivityLog struct {
	ID               int64
	DatetimeCreated  string //no default in CREATE TABLE so that we can set value using golang since we will also set TimestampCreated using golang.
	TimestampCreated int64  //nanoseconds, for sorting, no default in CREATE TABLE since handling nanoseconds with DEFAULT and SQLite is a pain/impossible.
	Method           string //GET, POST, etc.
	URL              string //the endpoint accessed
	RemoteIP         string
	UserAgent        string
	TimeDuration     int64  //milliseconds it took for server to complete the request
	PostFormValues   string //json encoded form values passed in request
	Referrer         string //page the user is on that caused this request to be made.

	//either CreatedByUserID or CreatedByAPIKeyID is provided, never both
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	//JOINed fields
	Username          string
	APIKeyDescription string
	APIKeyK           string //the actual api key

	//Calculated fields
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	Timezone          string //extra data for above fields for displaying in GUI.
}

type App struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	CreatedByUserID  int64
	Active           bool

	Name             string
	DaysToExpiration int                    //the number of days to add on to "today" to calculate a default expiration date of a license
	FileFormat       licensefile.FileFormat //yaml, json, etc. the format of the data stored in the text file.
	ShowLicenseID    bool                   //if the ID field of a created license file will be populated/non-zero.
	ShowAppName      bool                   //if the Application field of a created license file will be populated/non-blank.

	//DownloadFilename is the name of the license file when downloaded. This defaults to
	//"appname-license.txt" but can be customized using {{}} placeholders.
	//Placeholders:
	// - {ext} is replaced with the file format's extension prepended by a period (ex: .json);
	// - {appName} is replaced with the app's name, in lowercase and with spaces replaced by underscores.
	// - {licenseID} is replaced with the license's ID.
	DownloadFilename string
}

type AppSettings struct {
	ID               int64
	DatetimeModified string

	EnableActivityLogging bool //whether or not the app tracks user activity (page views, endpoints, etc.)
	AllowAPIAccess        bool //whether or not external access to this app is allowed
	Allow2FactorAuth      bool //if 2 factor authentication can be used
	Force2FactorAuth      bool //if all users are required to have 2 factor auth enabled prior to logging in (check if at least one user has 2fa enabled first to prevent lock out!)
	ForceSingleSession    bool //user can only be logged into the app in one browser at a time. used as a security tool.
}

type AuthorizedBrowser struct {
	ID              int64
	DatetimeCreated string
	UserID          int64
	RemoteIP        string
	UserAgent       string
	Cookie          string //a token saved to user's cookie so that if user resets browser we reprompt for 2fa token
	Timestamp       int64  //so we can force asking for a 2fa code after so much time regardless if browser is trusted
	Active          bool
}

type CustomFieldDefined struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	CreatedByUserID  int64
	Active           bool

	AppID        int64           //what app this field is for.
	Type         customFieldType //field type
	Name         string          //
	Instructions string          //what field is for and expected value

	//defaults to populate GUI when user is creating a new key
	IntegerDefaultValue     null.Int
	DecimalDefaultValue     null.Float
	TextDefaultValue        null.String
	BoolDefaultValue        null.Bool
	MultiChoiceDefaultValue null.String
	DateDefaultIncrement    null.Int //number of days incremented from "today", date license is being created

	//validation for value chosen/given in gui
	NumberMinValue     null.Float  //for integers and decimals
	NumberMaxValue     null.Float  //""
	MultiChoiceOptions null.String //semicolon separated list of options

	//When saving a license, we retrieve the defined fields for an app
	//and set the value for each field using the same list of objects
	//returned just for ease of use and not changing types. Therefore,
	//we need fields in this struct to store the chosen/provided
	//values for each field. Only one of these fields is populated per
	//the Type field. These are only populated when saving/creating a
	//new license.
	IntegerValue     int64   `json:",omitempty"`
	Decimalvalue     float64 `json:",omitempty"`
	TextValue        string  `json:",omitempty"`
	BoolValue        bool    `json:",omitempty"`
	MultiChoiceValue string  `json:",omitempty"`
	DateValue        string  `json:",omitempty"`
}

type CustomFieldResult struct {
	ID              int64
	DatetimeCreated string

	//a license can be created by a user or via an api call.
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	LicenseID            int64           //what license this result was set for
	CustomFieldDefinedID int64           //what field this result is related to
	CustomFieldType      customFieldType //field type, since type could be changed on defined field
	CustomFieldName      string          //name of field when result was set, since name could be changed on defined field

	IntegerValue     null.Int    //provided result value for an integer field
	DecimalValue     null.Float  //provided result value for a decminal field.
	TextValue        null.String //provided result value for a text field
	BoolValue        null.Bool   //provided result for a boolean field
	MultiChoiceValue null.String //chosen result for a multi choice field
	DateValue        null.String //provided result for a date field
}

type DownloadHistory struct {
	ID               int64
	DatetimeCreated  string //no default in CREATE TABLE so that we can set value using golang since we will also set TimestampCreated using golang.
	TimestampCreated int64  //nanoseconds, for sorting, no default in CREATE TABLE since handling nanoseconds with DEFAULT and SQLite is a pain/impossible.
	LicenseID        int64

	//a license can be creatd by a user or via an api call.
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	//Calculated fields
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	Timezone          string //extra data for above fields for displaying in GUI.

	//JOINed fields
	CreatedByUsername          null.String
	CreatedByAPIKeyDescription null.String
}

type KeyPair struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	CreatedByUserID  int64
	Active           bool

	AppID               int64                       //what app this key pair is for
	Name                string                      //something descriptive for times when you have multiple key pairs for an app.
	PrivateKey          string                      `json:"-"` //should never leave this app
	PublicKey           string                      //embedded in your application you want to verify the licenses on.
	AlgorithmType       licensefile.KeyPairAlgoType //what algorithm was used to generate the key pair. ex: ecdsa.
	PrivateKeyEncrypted bool                        //true when private key is encrypted with config file encryption key

	//Default sets whether or not this keypair is the default key
	//to use when creating a new license for this app. This keypair
	//will be selected in the select menu automatically when the
	//parent app is chosen for a new license. Only one keypair for
	//an app can be set as default, obviously. If the default keypair
	//is deleted another is not set automatically.
	IsDefault bool
}

type KeyValue struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	Active           bool

	//The actual data being stored
	K          string //key name
	V          string //value
	Type       string //string, float, bool, int, etc. Something to help when converting to datatype for usage. Matches golang type.
	Expiration int64  //a unix timestamp of when key and value should no longer be used, a TTL value. set to 0 for no expiration
}

type License struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	Active           bool

	//a license can be created by a user or via an api call.
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	//details chosen/provided in gui by user
	KeyPairID      int64  //the keypair used to sign the license
	CompanyName    string //company this license is for
	ContactName    string //who requested this license
	PhoneNumber    string //contact info
	Email          string //contact info
	IssueDate      string //yyyy-mm-dd format
	IssueTimestamp int64  //unix timestamp in seconds
	ExpireDate     string //yyyy-mm-dd format

	//The signature generated using the private key from the keypair. This is
	//generated once when the license is first created using the the common
	//license details and the common field results stored in the app's file
	//format. This is set to "" when license data is saved so we can get a
	//license ID before the license data is signed since some licenses contain
	//the license ID.
	Signature string

	//This is set to true ONLY after a license's data is saved, the signature
	//is created, and we reread the signed license file and check the signature
	//with the public key. This is used to ensure that a license can actually
	//be verified as authentic with the respective public key.
	Verified bool

	//These fields are copied from the app's details when the license
	//is created.
	AppName       string
	FileFormat    licensefile.FileFormat
	ShowLicenseID bool
	ShowAppName   bool

	//Calculated fields
	Expired           bool   //true if Expire date is greater than current date
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	IssueDateTZ       string // " " " "
	Timezone          string //extra data for above fields for displaying in GUI.

	//JOINed fields
	KeyPairAlgoType            licensefile.KeyPairAlgoType
	CreatedByUsername          null.String
	CreatedByAPIKeyDescription null.String
	AppID                      int64
	AppFileFormat              licensefile.FileFormat
	AppDownloadFilename        string
	RenewedFromLicenseID       null.Int
	RenewedToLicenseID         null.Int
}

type LicenseNote struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	Active           bool

	//a note can be added by a user or via an api call.
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	LicenseID int64
	Note      string

	//Calculated fields
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	Timezone          string //extra data for above fields for displaying in GUI.

	//JOINed fields
	CreatedByUsername          null.String
	CreatedByAPIKeyDescription null.String
}

type MultiCustomFieldResult []CustomFieldResult

type RenewalRelationship struct {
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	Active           bool

	//a license can be created by a user or via an api call.
	CreatedByUserID   null.Int
	CreatedByAPIKeyID null.Int

	FromLicenseID int64
	ToLicenseID   int64
}

type User struct {
	//Basics.
	ID               int64
	DatetimeCreated  string
	DatetimeModified string
	CreatedByUserID  int64
	Active           bool

	Username            string
	Password            string `json:"-"`
	BadPasswordAttempts uint8  `json:"-"`

	//Access control permissions.
	Administrator  bool //can user create other users, apps, signing details, etc.
	CreateLicenses bool //can user create licenses.
	ViewLicenses   bool //can user view and download licenses.

	//2 factor auth stuff
	//Using "Two" not "2" since golang struct fields must start with letter.
	TwoFactorAuthEnabled     bool   //does the user use 2 factor auth
	TwoFactorAuthSecret      string `json:"-"` //the shared secret used to validate 2fa tokens
	TwoFactorAuthBadAttempts uint8  `json:"-"` //the number of bad 2fa tokens provides, increases the time taken to verify tokens to reduce impact of brute forcing 2fa tokens

	//Have to use different field names since struct tags block using Password field.
	//Only used when sending data into app; adding user or updating password.
	PasswordInput1 string
	PasswordInput2 string
}

type UserLogin struct {
	ID                 int64 //not stored in cookie because it is easily guessed & incremented to find "next" session
	UserID             int64
	DatetimeCreated    string
	DatetimeModified   string
	RemoteIP           string
	UserAgent          string
	TwoFATokenProvided bool //whether or not a 2FA token was provided upon logging in.

	//This is a random, long value that will be stored in a cookie set for the user to
	//identify the login. This is used, over the ID field, since the ID field can easily
	//be guessed and incremented to find the "next" session. We will use this value,
	//from the cookie, to look up the logged in user's data when needed.
	CookieValue string

	//This is used to force a user to log out, force a users session to be marked as
	//invalid, prior to hitting the expiration. This is useful for forcing users to
	//log out for diagnostics, low level fixing of database, security, etc. This is
	//also used, by setting to false, when a user's password is changed so that all
	//currently logged in sessions need to re-provide the password, again for security.
	Active bool

	//When a user's session will expire. This is reset, extended, each time the user
	//visits a new page on the app.
	Expiration int64

	//JOINed fields
	Username string

	//Calculated fields
	DatetimeCreatedTZ string //DatetimeCreated converted to timezone per config file.
	Timezone          string //extra data for above fields for displaying in GUI.
}