database

type BreakdownItem struct {
	UnitCount     float64       // Count of the unit per item
	UnitName      string        // Unit name
	Counter       int           // Counter of this item in the list of items
	Distance      float64       // Distance in this item
	TotalDistance float64       // Total distance in all items up to and including this item
	Duration      time.Duration // Duration in this item
	TotalDuration time.Duration // Total duration in all items up to and including this item
	Speed         float64       // Speed in this item
	FirstPoint    *MapPoint     // First GPS point in this item
	LastPoint     *MapPoint     // Last GPS point in this item
	IsBest        bool          // Whether this item is the best of the list
	IsWorst       bool          // Whether this item is the worst of the list
}

type Bucket struct {
	Bucket              string        `json:",omitempty"` // The name of the bucket
	WorkoutType         WorkoutType   // The type of the workout
	Workouts            int           // The number of workouts in the bucket
	Distance            float64       `json:",omitempty"` // The total distance in the bucket
	Up                  float64       `json:",omitempty"` // The total up elevation in the bucket
	Duration            time.Duration `json:",omitempty"` // The total duration in the bucket
	AverageSpeed        float64       `json:",omitempty"` // The average speed in the bucket
	AverageSpeedNoPause float64       `json:",omitempty"` // The average speed without pause in the bucket
	MaxSpeed            float64       `json:",omitempty"` // The max speed in the bucket
}

type Config struct {
	gorm.Model
	// These options can be changed at runtime, configured through the database
	// If they are set through the environment to a non-default value, that will
	// take precedence
	RegistrationDisabled bool `mapstructure:"registration_disabled" form:"registration_disabled"`
	SocialsDisabled      bool `mapstructure:"socials_disabled" form:"socials_disabled"`

	// These options are read from the config file or environment only
	Logging          bool   `mapstructure:"logging" gorm:"-"`
	Debug            bool   `mapstructure:"debug" gorm:"-"`
	Bind             string `mapstructure:"bind" gorm:"-"`
	JWTEncryptionKey string `mapstructure:"jwt_encryption_key" gorm:"-"`
	DatabaseDriver   string `mapstructure:"database_driver" gorm:"-"`
	DSN              string `mapstructure:"dsn" gorm:"-"`
}

type GPXData struct {
	gorm.Model
	WorkoutID uint   `gorm:"not null;uniqueIndex"` // The ID of the workout
	Content   []byte `gorm:"type:text"`            // The file content
	Checksum  []byte `gorm:"not null;uniqueIndex"` // The checksum of the content
	Filename  string // The filename of the file
}

type MapCenter struct {
	Lat float64 // The latitude of the center of the workout
	Lng float64 // The longitude of the center of the workout
}

type MapData struct {
	gorm.Model
	WorkoutID     uint            `gorm:"not null;uniqueIndex"` // The workout this data belongs to
	Creator       string          // The tool that created this workout
	Name          string          // The name of the workout
	Center        MapCenter       `gorm:"serializer:json"` // The center of the workout (in coordinates)
	Address       *geo.Address    `gorm:"serializer:json"` // The address of the workout
	TotalDistance float64         // The total distance of the workout
	TotalDuration time.Duration   // The total duration of the workout
	MaxSpeed      float64         // The maximum speed of the workout
	PauseDuration time.Duration   // The total pause duration of the workout
	MinElevation  float64         // The minimum elevation of the workout
	MaxElevation  float64         // The maximum elevation of the workout
	TotalUp       float64         // The total distance up of the workout
	TotalDown     float64         // The total distance down of the workout
	Details       *MapDataDetails `json:",omitempty"` // The details of the workout

	Points []MapPoint `gorm:"serializer:json" json:"-"` // To be removed
}

type MapDataDetails struct {
	gorm.Model
	MapDataID uint       // The ID of the map data these details belong to
	Points    []MapPoint `gorm:"serializer:json"` // The GPS points of the workout
}

type MapPoint struct {
	Lat           float64       // The latitude of the point
	Lng           float64       // The longitude of the point
	Distance      float64       // The distance from the previous point
	TotalDistance float64       // The total distance of the workout up to this point
	Duration      time.Duration // The duration from the previous point
	TotalDuration time.Duration // The total duration of the workout up to this point
	Time          time.Time     // The time the point was recorded
	Elevation     float64       // The elevation of the point
}

type Profile struct {
	gorm.Model
	UserID              uint        // The ID of the user who owns this profile
	APIActive           bool        `form:"api_active"`            // Whether the user's API key is active
	Language            string      `form:"language"`              // The user's preferred language
	TotalsShow          WorkoutType `form:"totals_show"`           // What workout type of totals to show
	Timezone            string      `form:"timezone"`              // The user's preferred timezone
	AutoImportDirectory string      `form:"auto_import_directory"` // The user's preferred directory for auto-import
	SocialsDisabled     bool        `form:"socials_disabled"`      // Whether social sharing buttons are disabled when viewing a workout
	PreferFullDate      bool        `form:"prefer_full_date"`      // Whether to show full dates in the workout details

	PreferredUnits UserPreferredUnits `gorm:"serializer:json"` // The user's preferred units

	User *User `gorm:"foreignKey:UserID" json:"-"` // The user who owns this profile
}

type StatConfig struct {
	Since string `query:"since"`
	Per   string `query:"per"`
}

type Statistics struct {
	UserID       uint                              // The user ID
	BucketFormat string                            // The bucket format in strftime format
	Buckets      map[WorkoutType]map[string]Bucket // The statistics buckets
}

type User struct {
	gorm.Model
	Password string `form:"-"        gorm:"type:varchar(128);not null"`            // The user's password as bcrypt hash
	Salt     string `form:"-"        gorm:"type:varchar(16);not null"`             // The salt used to hash the user's password
	Username string `form:"username" gorm:"uniqueIndex;not null;type:varchar(32)"` // The user's username
	Name     string `form:"name"     gorm:"type:varchar(64);not null"`             // The user's name
	APIKey   string `gorm:"type:varchar(32)"`                                      // The user's API key
	Active   bool   `form:"active"`                                                // Whether the user is active
	Admin    bool   `form:"admin"`                                                 // Whether the user is an admin

	Profile  Profile   // The user's profile settings
	Workouts []Workout `json:"-"` // The user's workouts
	// contains filtered or unexported fields
}

type UserPreferredUnits struct {
	SpeedRaw     string `form:"speed" json:"speed"`         // The user's preferred speed unit
	DistanceRaw  string `form:"distance" json:"distance"`   // The user's preferred distance unit
	ElevationRaw string `form:"elevation" json:"elevation"` // The user's preferred elevation unit
}

type Workout struct {
	gorm.Model
	Name   string      `gorm:"not null"`                                  // The name of the workout
	Date   *time.Time  `gorm:"not null;uniqueIndex:idx_start_user"`       // The timestamp the workout was recorded
	UserID uint        `gorm:"not null;index;uniqueIndex:idx_start_user"` // The ID of the user who owns the workout
	Dirty  bool        // Whether the workout has been modified and the details should be re-rendered
	User   *User       // The user who owns the workout
	Notes  string      // The notes associated with the workout, in markdown
	Type   WorkoutType // The type of the workout
	Data   *MapData    `json:",omitempty"` // The map data associated with the workout
	GPX    *GPXData    `json:",omitempty"` // The file data associated with the workout

	MapData  *MapData `gorm:"serializer:json;column:data" json:"-"` // To be removed
	GPXData  []byte   `gorm:"type:text" json:"-"`                   // To be removed
	Filename string   `json:"-"`                                    // To be removed
	Checksum []byte   `gorm:"default:'legacy'" json:"-"`            // To be removed
}

type WorkoutBreakdown struct {
	Unit  string
	Items []BreakdownItem
}

type WorkoutRecord struct {
	WorkoutType         WorkoutType    // The type of the workout
	Active              bool           // Whether there is any data in the record
	AverageSpeed        float64Record  // The record with the maximum average speed
	AverageSpeedNoPause float64Record  // The record with the maximum average speed without pause
	MaxSpeed            float64Record  // The record with the maximum max speed
	Distance            float64Record  // The record with the maximum distance
	TotalUp             float64Record  // The record with the maximum up elevation
	Duration            durationRecord // The record with the maximum duration
}

type WorkoutType string