const (
    // BrowserChrome represents the Chrome and Chromium browser.
    BrowserChrome = "Chrome"

    // BrowserFirefox represents the Firefox browser.
    BrowserFirefox = "Firefox"

    // BrowserSafari  represents the Safari browser.
    BrowserSafari = "Safari"

    // BrowserOpera represents the Opera browser.
    BrowserOpera = "Opera"

    // BrowserEdge represents the Edge browser.
    BrowserEdge = "Edge"

    // BrowserIE represents the Internet Explorer browser.
    BrowserIE = "IE"

    // OSWindows represents the Windows operating system.
    OSWindows = "Windows"

    // OSMac represents the Mac operating system.
    OSMac = "Mac"

    // OSLinux represents a Linux distribution.
    OSLinux = "Linux"

    // OSAndroid represents the Android operating system.
    OSAndroid = "Android"

    // OSiOS represents the iOS operating system.
    OSiOS = "iOS"

    // OSWindowsMobile represents the Windows Mobile operating system.
    OSWindowsMobile = "Windows Mobile"
)

const (

    // GeoLite2Filename is the default filename of the GeoLite2 database.
    GeoLite2Filename = "GeoLite2-Country.mmdb"
)

var NullTenant = NewTenantID(0)

var ScreenClasses = []screenClass{
    {1440, "XXL"},
    {1024, "XL"},
    {800, "L"},
    {600, "M"},
    {415, "S"},
}

type Analyzer struct {
    // contains filtered or unexported fields
}

type AnalyzerConfig struct {
    // Timezone sets the time zone for the result set.
    // If not set, UTC will be used.
    Timezone *time.Location
}

type BaseEntity struct {
    ID       int64         `db:"id" json:"id"`
    TenantID sql.NullInt64 `db:"tenant_id" json:"tenant_id"`
}

type BrowserStats struct {
    Stats

    Browser        sql.NullString `db:"browser" json:"browser"`
    BrowserVersion sql.NullString `db:"browser_version" json:"version"`
}

type CountryStats struct {
    Stats

    CountryCode sql.NullString `db:"country_code" json:"country_code"`
}

type Filter struct {
    // TenantID is the optional tenant ID used to filter results.
    TenantID sql.NullInt64

    // Path is the optional path for the selection.
    Path string

    // From is the start of the selection.
    From time.Time

    // To is the end of the selection.
    To  time.Time
}

type GeoDB struct {
    // contains filtered or unexported fields
}

type GeoDBConfig struct {
    // File is the path (including the filename) to the GeoLite2 country database file.
    // See GeoLite2Filename for the required filename.
    File string

    // Logger is the log.Logger used for logging.
    // Note that this will log the IP address and should therefore only be used for debugging.
    // Set it to nil to disable logging for GeoDB.
    Logger *log.Logger
}

type Growth struct {
    Current        *Stats  `json:"current"`
    Previous       *Stats  `json:"previous"`
    VisitorsGrowth float64 `json:"visitors_growth"`
    SessionsGrowth float64 `json:"sessions_growth"`
    BouncesGrowth  float64 `json:"bounces_growth"`
}

type Hit struct {
    BaseEntity

    Fingerprint    string         `db:"fingerprint" json:"fingerprint"`
    Session        sql.NullTime   `db:"session" json:"session"`
    Path           string         `db:"path" json:"path"`
    URL            sql.NullString `db:"url" json:"url,omitempty"`
    Language       sql.NullString `db:"language" json:"language,omitempty"`
    UserAgent      sql.NullString `db:"user_agent" json:"user_agent,omitempty"`
    Referrer       sql.NullString `db:"referrer" json:"referrer,omitempty"`
    OS             sql.NullString `db:"os" json:"os,omitempty"`
    OSVersion      sql.NullString `db:"os_version" json:"os_version,omitempty"`
    Browser        sql.NullString `db:"browser" json:"browser,omitempty"`
    BrowserVersion sql.NullString `db:"browser_version" json:"browser_version,omitempty"`
    CountryCode    sql.NullString `db:"country_code" json:"country_code"`
    Desktop        bool           `db:"desktop" json:"desktop"`
    Mobile         bool           `db:"mobile" json:"mobile"`
    ScreenWidth    int            `db:"screen_width" json:"screen_width"`
    ScreenHeight   int            `db:"screen_height" json:"screen_height"`
    ScreenClass    sql.NullString `db:"screen_class" json:"screen_class"`
    Time           time.Time      `db:"time" json:"time"`
}

type HitOptions struct {
    // TenantID is optionally saved with a hit to split the data between multiple tenants.
    TenantID sql.NullInt64

    // URL can be set to manually overwrite the URL stored for this request.
    // This will also affect the Path, except it is set too.
    URL string

    // Path can be set to manually overwrite the path stored for the request.
    // This will also affect the URL.
    Path string

    // Referrer can be set to manually overwrite the referrer from the request.
    Referrer string

    // ReferrerDomainBlacklist is used to filter out unwanted referrers from the Referrer header.
    // This can be used to filter out traffic from your own site or subdomains.
    // To filter your own domain and subdomains, add your domain to the list and set ReferrerDomainBlacklistIncludesSubdomains to true.
    // This way the referrer for blog.mypage.com -> mypage.com won't be saved.
    ReferrerDomainBlacklist []string

    // ReferrerDomainBlacklistIncludesSubdomains set to true to include all subdomains in the ReferrerDomainBlacklist,
    // or else subdomains must explicitly be included in the blacklist.
    // If the blacklist contains domain.com, sub.domain.com and domain.com will be treated as equals.
    ReferrerDomainBlacklistIncludesSubdomains bool

    // ScreenWidth sets the screen width to be stored with the hit.
    ScreenWidth int

    // ScreenHeight sets the screen height to be stored with the hit.
    ScreenHeight int
    // contains filtered or unexported fields
}

type LanguageStats struct {
    Stats

    Language sql.NullString `db:"language" json:"language"`
}

type OSStats struct {
    Stats

    OS        sql.NullString `db:"os" json:"os"`
    OSVersion sql.NullString `db:"os_version" json:"version"`
}

type PathVisitors struct {
    Path  string  `json:"path"`
    Stats []Stats `json:"stats"`
}

type PostgresConfig struct {
    // Logger is the log.Logger used for logging.
    // The default log will be used printing to os.Stdout with "pirsch" in its prefix in case it is not set.
    Logger *log.Logger
}

type PostgresStore struct {
    DB *sqlx.DB
    // contains filtered or unexported fields
}

type Processor struct {
    // contains filtered or unexported fields
}

type ReferrerStats struct {
    Stats

    Referrer sql.NullString `db:"referrer" json:"referrer"`
}

type ScreenStats struct {
    Stats

    Width  int            `db:"width" json:"width"`
    Height int            `db:"height" json:"height"`
    Class  sql.NullString `db:"class" json:"class"`
}

type Stats struct {
    BaseEntity

    Day              time.Time      `db:"day" json:"day"`
    Path             sql.NullString `db:"path" json:"path"`
    Visitors         int            `db:"visitors" json:"visitors"`
    Sessions         int            `db:"sessions" json:"sessions"`
    Bounces          int            `db:"bounces" json:"bounces"`
    RelativeVisitors float64        `db:"-" json:"relative_visitors"`
    BounceRate       float64        `db:"-" json:"bounce_rate"`
}

type Store interface {
    // NewTx creates a new transaction and panic on failure.
    NewTx() *sqlx.Tx

    // Commit commits given transaction and logs the error.
    Commit(*sqlx.Tx)

    // Rollback rolls back given transaction and logs the error.
    Rollback(*sqlx.Tx)

    // SaveHits persists a list of hits.
    SaveHits([]Hit) error

    // DeleteHitsByDay deletes all hits on given day.
    DeleteHitsByDay(*sqlx.Tx, sql.NullInt64, time.Time) error

    // SaveVisitorStats saves VisitorStats.
    SaveVisitorStats(*sqlx.Tx, *VisitorStats) error

    // SaveVisitorTimeStats saves VisitorTimeStats.
    SaveVisitorTimeStats(*sqlx.Tx, *VisitorTimeStats) error

    // SaveLanguageStats saves LanguageStats.
    SaveLanguageStats(*sqlx.Tx, *LanguageStats) error

    // SaveReferrerStats saves ReferrerStats.
    SaveReferrerStats(*sqlx.Tx, *ReferrerStats) error

    // SaveOSStats saves OSStats.
    SaveOSStats(*sqlx.Tx, *OSStats) error

    // SaveBrowserStats saves BrowserStats.
    SaveBrowserStats(*sqlx.Tx, *BrowserStats) error

    // SaveScreenStats saves ScreenStats.
    SaveScreenStats(*sqlx.Tx, *ScreenStats) error

    // SaveCountryStats saves CountryStats.
    SaveCountryStats(*sqlx.Tx, *CountryStats) error

    // Session returns the hits session timestamp for given fingerprint and max age.
    Session(sql.NullInt64, string, time.Time) time.Time

    // HitDays returns the distinct days with at least one hit.
    HitDays(sql.NullInt64) ([]time.Time, error)

    // HitPaths returns the distinct paths for given day.
    HitPaths(sql.NullInt64, time.Time) ([]string, error)

    // Paths returns the distinct paths for given time frame.
    Paths(sql.NullInt64, time.Time, time.Time) ([]string, error)

    // CountVisitors returns the visitor count for given day.
    CountVisitors(*sqlx.Tx, sql.NullInt64, time.Time) *Stats

    // CountVisitorsByPath returns the visitor count for given day, path, and if the platform should be included or not.
    CountVisitorsByPath(*sqlx.Tx, sql.NullInt64, time.Time, string, bool) ([]VisitorStats, error)

    // CountVisitorsByPathAndHour returns the visitor count for given day and path grouped by hour of day.
    CountVisitorsByHour(*sqlx.Tx, sql.NullInt64, time.Time) ([]VisitorTimeStats, error)

    // CountVisitorsByPathAndLanguage returns the visitor count for given day and path grouped by language.
    CountVisitorsByPathAndLanguage(*sqlx.Tx, sql.NullInt64, time.Time, string) ([]LanguageStats, error)

    // CountVisitorsByPathAndReferrer returns the visitor count for given day and path grouped by referrer.
    CountVisitorsByPathAndReferrer(*sqlx.Tx, sql.NullInt64, time.Time, string) ([]ReferrerStats, error)

    // CountVisitorsByPathAndOS returns the visitor count for given day and path grouped by operating system and operating system version.
    CountVisitorsByPathAndOS(*sqlx.Tx, sql.NullInt64, time.Time, string) ([]OSStats, error)

    // CountVisitorsByPathAndBrowser returns the visitor count for given day and path grouped by browser and browser version.
    CountVisitorsByPathAndBrowser(*sqlx.Tx, sql.NullInt64, time.Time, string) ([]BrowserStats, error)

    // CountVisitorsByLanguage returns the visitor count for given day grouped by language.
    CountVisitorsByLanguage(*sqlx.Tx, sql.NullInt64, time.Time) ([]LanguageStats, error)

    // CountVisitorsByReferrer returns the visitor count for given day grouped by referrer.
    CountVisitorsByReferrer(*sqlx.Tx, sql.NullInt64, time.Time) ([]ReferrerStats, error)

    // CountVisitorsByOS returns the visitor count for given day grouped by operating system.
    CountVisitorsByOS(*sqlx.Tx, sql.NullInt64, time.Time) ([]OSStats, error)

    // CountVisitorsByBrowser returns the visitor count for given day grouped by browser.
    CountVisitorsByBrowser(*sqlx.Tx, sql.NullInt64, time.Time) ([]BrowserStats, error)

    // CountVisitorsByScreenSize returns the visitor count for given day grouped by screen size (width and height).
    CountVisitorsByScreenSize(*sqlx.Tx, sql.NullInt64, time.Time) ([]ScreenStats, error)

    // CountVisitorsByScreenClass returns the visitor count for given day grouped by screen class.
    CountVisitorsByScreenClass(*sqlx.Tx, sql.NullInt64, time.Time) ([]ScreenStats, error)

    // CountVisitorsByCountryCode returns the visitor count for given day grouped by country code.
    CountVisitorsByCountryCode(*sqlx.Tx, sql.NullInt64, time.Time) ([]CountryStats, error)

    // CountVisitorsByPlatform returns the visitor count for given day grouped by platform.
    CountVisitorsByPlatform(*sqlx.Tx, sql.NullInt64, time.Time) *VisitorStats

    // CountVisitorsByPathAndMaxOneHit returns the visitor count for given day and optional path with a maximum of one hit.
    // This returns the absolut number of hits without further page calls and is used to calculate the bounce rate.
    CountVisitorsByPathAndMaxOneHit(*sqlx.Tx, sql.NullInt64, time.Time, string) int

    // ActiveVisitors returns the active visitor count for given duration.
    ActiveVisitors(sql.NullInt64, time.Time) int

    // ActivePageVisitors returns the active visitors grouped by path for given duration.
    ActivePageVisitors(sql.NullInt64, time.Time) ([]Stats, error)

    // Visitors returns the visitors for given time frame grouped by days.
    Visitors(sql.NullInt64, time.Time, time.Time) ([]Stats, error)

    // VisitorHours returns the visitors for given time frame grouped by hour of day.
    VisitorHours(sql.NullInt64, time.Time, time.Time) ([]VisitorTimeStats, error)

    // VisitorLanguages returns the visitors for given time frame grouped by language.
    VisitorLanguages(sql.NullInt64, time.Time, time.Time) ([]LanguageStats, error)

    // VisitorReferrer returns the visitor count for given time frame grouped by referrer.
    VisitorReferrer(sql.NullInt64, time.Time, time.Time) ([]ReferrerStats, error)

    // VisitorOS returns the visitor count for given time frame grouped by operating system.
    VisitorOS(sql.NullInt64, time.Time, time.Time) ([]OSStats, error)

    // VisitorBrowser returns the visitor count for given time frame grouped by browser.
    VisitorBrowser(sql.NullInt64, time.Time, time.Time) ([]BrowserStats, error)

    // VisitorPlatform returns the visitor count for given time frame grouped by platform.
    VisitorPlatform(sql.NullInt64, time.Time, time.Time) *VisitorStats

    // VisitorScreenSize returns the visitor count for given time frame grouped by screen size (width and height).
    VisitorScreenSize(sql.NullInt64, time.Time, time.Time) ([]ScreenStats, error)

    // VisitorScreenClass returns the visitor count for given time frame grouped by screen class.
    VisitorScreenClass(sql.NullInt64, time.Time, time.Time) ([]ScreenStats, error)

    // VisitorCountry returns the visitor count for given time frame grouped by country code.
    VisitorCountry(sql.NullInt64, time.Time, time.Time) ([]CountryStats, error)

    // PageVisitors returns the visitors for given path and time frame grouped by days.
    PageVisitors(sql.NullInt64, string, time.Time, time.Time) ([]Stats, error)

    // PageReferrer returns the visitors for given path and time frame grouped by referrer.
    PageReferrer(sql.NullInt64, string, time.Time, time.Time) ([]ReferrerStats, error)

    // PageLanguages returns the visitors for given path and time frame grouped by language.
    PageLanguages(sql.NullInt64, string, time.Time, time.Time) ([]LanguageStats, error)

    // PageOS returns the visitors for given path and time frame grouped by operating system.
    PageOS(sql.NullInt64, string, time.Time, time.Time) ([]OSStats, error)

    // PageBrowser returns the visitors for given path and time frame grouped by browser.
    PageBrowser(sql.NullInt64, string, time.Time, time.Time) ([]BrowserStats, error)

    // PagePlatform returns the visitors for given path and time frame grouped by platform.
    PagePlatform(sql.NullInt64, string, time.Time, time.Time) *VisitorStats

    // VisitorsSum returns the sum of the visitors, sessions, and bounces for given time frame and path.
    // The path is optional.
    VisitorsSum(sql.NullInt64, time.Time, time.Time, string) (*Stats, error)
}

type TimeOfDayVisitors struct {
    Day   time.Time          `json:"day"`
    Stats []VisitorTimeStats `json:"stats"`
}

type Tracker struct {
    // contains filtered or unexported fields
}

type TrackerConfig struct {
    // Worker sets the number of workers that are used to store hits.
    // Must be greater or equal to 1.
    Worker int

    // WorkerBufferSize is the size of the buffer used to store hits.
    // Must be greater than 0. The hits are stored in batch when the buffer is full.
    WorkerBufferSize int

    // WorkerTimeout sets the timeout used to store hits.
    // This is used to allow the workers to store hits even if the buffer is not full yet.
    // It's recommended to set this to a few seconds.
    // If you leave it 0, the default timeout is used, else it is limted to 60 seconds.
    WorkerTimeout time.Duration

    // ReferrerDomainBlacklist see HitOptions.ReferrerDomainBlacklist.
    ReferrerDomainBlacklist []string

    // ReferrerDomainBlacklistIncludesSubdomains see HitOptions.ReferrerDomainBlacklistIncludesSubdomains.
    ReferrerDomainBlacklistIncludesSubdomains bool

    // Sessions enables/disables session tracking.
    // It's enabled by default.
    Sessions bool

    // SessionMaxAge is used to define how long a session runs at maximum.
    // Set to two hours by default.
    SessionMaxAge time.Duration

    // SessionCleanupInterval sets the session cache lifetime.
    // If not passed, the default will be used.
    SessionCleanupInterval time.Duration

    // GeoDB enables/disabled mapping IPs to country codes.
    // Can be set/updated at runtime by calling Tracker.SetGeoDB.
    GeoDB *GeoDB

    // Logger is the log.Logger used for logging.
    // The default log will be used printing to os.Stdout with "pirsch" in its prefix in case it is not set.
    Logger *log.Logger
}

type UserAgent struct {
    // Browser is the browser name.
    Browser string

    // BrowserVersion is the browser (non technical) version number.
    BrowserVersion string

    // OS is the operating system.
    OS  string

    // OSVersion is the operating system version number.
    OSVersion string
}

type VisitorStats struct {
    Stats

    PlatformDesktop         int     `db:"platform_desktop" json:"platform_desktop"`
    PlatformMobile          int     `db:"platform_mobile" json:"platform_mobile"`
    PlatformUnknown         int     `db:"platform_unknown" json:"platform_unknown"`
    RelativePlatformDesktop float64 `db:"-" json:"relative_platform_desktop"`
    RelativePlatformMobile  float64 `db:"-" json:"relative_platform_mobile"`
    RelativePlatformUnknown float64 `db:"-" json:"relative_platform_unknown"`
}

type VisitorTimeStats struct {
    Stats

    Hour int `db:"hour" json:"hour"`
}