dxcc

Documentation

Index

• Constants
• Variables
• func ToUcWord(s string) string
• type Client
  • func NewClient(ctx context.Context, cfg config.Config, dbClient db.DBClient) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) FetchAndStore(ctx context.Context)
  • func (c *Client) FetchAndStoreData(ctx context.Context)
  • func (c *Client) GetDxccInfo(ctx context.Context, callsign string, lookupDate *time.Time) (*DxccInfo, error)
  • func (c *Client) GetEntities() map[int]DxccEntity
  • func (c *Client) GetException(call string) (*DxccInfo, bool)
  • func (c *Client) GetExceptions() map[string]DxccException
  • func (c *Client) GetHTTPClient() *http.Client
  • func (c *Client) GetLastDownloadTime(ctx context.Context) (time.Time, error)
  • func (c *Client) GetPrefix(prefix string) (*DxccInfo, bool)
  • func (c *Client) GetPrefixes() map[string]DxccPrefix
  • func (c *Client) LoadMaps(ctx context.Context) error
  • func (c *Client) LoadMapsFromDB(ctx context.Context) error
  • func (c *Client) SetHTTPDoer(d HTTPDoer)
  • func (c *Client) StartUpdater(ctx context.Context)
• type ClubLogXML
• type CtyXML
• type DxccEntity
• type DxccException
• type DxccInfo
• type DxccPrefix
• type Entities
• type Entity
• type Exception
• type Exceptions
• type HTTPDoer
• type Prefix
• type Prefixes

Constants

const (
	DBFileName = "dxcc.db" // Made public for use in main and tests

)

Variables

var FlagEmojis = map[string]string{

	"1":   "🇨🇦",
	"291": "🇺🇸",
	"50":  "🇲🇽",
	"70":  "🇨🇺",
	"105": "🇺🇸",

	"100": "🇦🇷",
	"108": "🇧🇷",
	"144": "🇺🇾",
	"112": "🇨🇱",
	"116": "🇨🇴",
	"136": "🇵🇪",
	"140": "🇻🇪",
	"120": "🇪🇨",
	"124": "🇬🇾",
	"132": "🇵🇾",
	"129": "🇬🇫",

	"10":  "🇳🇱",
	"14":  "🇦🇹",
	"15":  "🇧🇪",
	"503": "🇨🇿",
	"160": "🇩🇰",
	"224": "🇫🇮",
	"227": "🇫🇷",
	"230": "🇩🇪",
	"236": "🇬🇷",
	"239": "🇭🇺",
	"251": "🇮🇸",
	"245": "🇮🇪",
	"248": "🇮🇹",
	"260": "🇲🇨",
	"266": "🇳🇴",
	"269": "🇵🇱",
	"272": "🇵🇹",
	"54":  "🇷🇺",
	"281": "🇪🇸",
	"284": "🇸🇪",
	"287": "🇨🇭",
	"288": "🇺🇦",
	"223": "🇬🇧",
	"212": "🇧🇬",
	"275": "🇷🇴",

	"339": "🇯🇵",
	"318": "🇨🇳",
	"137": "🇰🇷",
	"324": "🇮🇳",
	"387": "🇹🇭",
	"293": "🇻🇳",
	"327": "🇮🇩",
	"375": "🇵🇭",
	"381": "🇸🇬",
	"333": "🇲🇾",
	"390": "🇹🇼",
	"321": "🇭🇰",

	"150": "🇦🇺",
	"170": "🇳🇿",
	"176": "🇫🇯",
	"163": "🇵🇬",
	"158": "🇻🇺",
	"162": "🇳🇨",
	"175": "🇵🇫",

	"462": "🇿🇦",
	"478": "🇪🇬",
	"430": "🇰🇪",
	"450": "🇳🇬",
	"446": "🇲🇦",
	"474": "🇹🇳",
	"438": "🇲🇬",
	"453": "🇷🇪",
	"165": "🇲🇺",

	"13":  "🇦🇶",
	"460": "",
	"901": "",
}

FlagEmojis is a comprehensive mapping of DXCC ID (as string) to emoji flag. This covers the most common amateur radio countries and entities.

Functions

func ToUcWord

func ToUcWord(s string) string

ToUcWord is an exported wrapper for toUcWord used by tests.

Types

type Client

type Client struct {

	// Expose for testing
	PrefixesMap   map[string]DxccPrefix
	ExceptionsMap map[string]DxccException
	EntitiesMap   map[int]DxccEntity
	// Testing hook to override http client behavior
	HTTPClient HTTPDoer
	// TestFallback when true enables a small, test-only fallback mapping for missing entities.
	TestFallback bool
	// contains filtered or unexported fields
}

Client manages DXCC data.

func NewClient

func NewClient(ctx context.Context, cfg config.Config, dbClient db.DBClient) (*Client, error)

NewClient creates and returns a new DXCC client.

func (*Client) Close

func (c *Client) Close() error

Close gracefully shuts down the DXCC client's resources.

func (*Client) FetchAndStore

func (c *Client) FetchAndStore(ctx context.Context)

FetchAndStore exposes the internal fetchAndStoreData for tests.

func (*Client) FetchAndStoreData

func (c *Client) FetchAndStoreData(ctx context.Context)

func (*Client) GetDxccInfo

func (c *Client) GetDxccInfo(ctx context.Context, callsign string, lookupDate *time.Time) (*DxccInfo, error)

GetDxccInfo performs a DXCC lookup for a given callsign. It also takes an optional 'lookupDate' for historical lookups, though current implementation mainly relies on current loaded data.

func (*Client) GetEntities

func (c *Client) GetEntities() map[int]DxccEntity

GetEntities exposes the internal entities map for tests.

func (*Client) GetException

func (c *Client) GetException(call string) (*DxccInfo, bool)

GetException checks if a callsign has a hardcoded exception entry. Returns (entity, found).

func (*Client) GetExceptions

func (c *Client) GetExceptions() map[string]DxccException

GetExceptions exposes the internal exceptions map for tests.

func (*Client) GetHTTPClient

func (c *Client) GetHTTPClient() *http.Client

GetHTTPClient exposes the internal http client for tests.

func (*Client) GetLastDownloadTime

func (c *Client) GetLastDownloadTime(ctx context.Context) (time.Time, error)

GetLastDownloadTime retrieves when DXCC data was last downloaded.

func (*Client) GetPrefix

func (c *Client) GetPrefix(prefix string) (*DxccInfo, bool)

GetPrefix looks up a prefix in the DXCC prefix map. Returns (entity, found).

func (*Client) GetPrefixes

func (c *Client) GetPrefixes() map[string]DxccPrefix

GetPrefixes exposes the internal prefixes map for tests.

func (*Client) LoadMaps

func (c *Client) LoadMaps(ctx context.Context) error

LoadMaps exposes the internal loadMapsFromDB functionality for tests.

func (*Client) LoadMapsFromDB

func (c *Client) LoadMapsFromDB(ctx context.Context) error

Compatibility aliases for tests: previous tests expect these names.

func (*Client) SetHTTPDoer

func (c *Client) SetHTTPDoer(d HTTPDoer)

SetHTTPDoer allows tests to inject a custom HTTP client that satisfies HTTPDoer.

func (*Client) StartUpdater

func (c *Client) StartUpdater(ctx context.Context)

StartUpdater starts the periodic update job for DXCC data. Note: Does NOT perform an initial check - main.go handles that synchronously before calling this.

type ClubLogXML

type ClubLogXML struct {
	XMLName    xml.Name   `xml:"clublog"`
	Date       string     `xml:"date,attr"`
	Prefixes   Prefixes   `xml:"prefixes"`
	Exceptions Exceptions `xml:"exceptions"`
	Entities   Entities   `xml:"entities"`
}

ClubLogXML represents the root of the new Club Log XML format.

type CtyXML

type CtyXML struct {
	XMLName    xml.Name   `xml:"cty"`
	Prefixes   Prefixes   `xml:"prefixes"`
	Exceptions Exceptions `xml:"exceptions"`
	Entities   Entities   `xml:"entities"`
}

CtyXML represents the root of the legacy cty.xml file.

type DxccEntity

type DxccEntity struct {
	ADIF   int       `json:"adif"`
	Name   string    `json:"name"`
	Prefix string    `json:"prefix"`
	ITUZ   int       `json:"ituz"`
	CQZ    int       `json:"cqz"`
	Cont   string    `json:"cont"`
	Long   float64   `json:"long"`
	Lat    float64   `json:"lat"`
	Start  time.Time `json:"start"`
	End    time.Time `json:"end"`
}

DxccEntity represents a row in the dxcc_entities table.

type DxccException

type DxccException DxccPrefix // Same structure as DxccPrefix for simplicity

DxccException represents a row in the dxcc_exceptions table.

type DxccInfo

type DxccInfo struct {
	Cont      string  `json:"cont"`
	Entity    string  `json:"entity"`
	Flag      string  `json:"flag"` // Emoji flag
	DXCCID    int     `json:"dxcc_id"`
	CQZ       int     `json:"cqz"`
	ITUZ      int     `json:"ituz"`
	Latitude  float64 `json:"lat"`
	Longitude float64 `json:"lng"`
}

DxccInfo holds comprehensive DXCC information for a callsign. This is the output format from the lookup.

type DxccPrefix

type DxccPrefix struct {
	Call   string    `json:"call"`
	Entity string    `json:"entity"`
	ADIF   int       `json:"adif"`
	CQZ    int       `json:"cqz"`
	Cont   string    `json:"cont"`
	Long   float64   `json:"long"`
	Lat    float64   `json:"lat"`
	Start  time.Time `json:"start"` // Stored as TEXT (ISO 8601) in DB
	End    time.Time `json:"end"`   // Stored as TEXT (ISO 8601) in DB
}

DxccPrefix represents a row in the dxcc_prefixes table.

type Entities

type Entities struct {
	XMLName xml.Name `xml:"entities"`
	Entity  []Entity `xml:"entity"`
}

Entities holds a list of Entity records.

type Entity

type Entity struct {
	XMLName xml.Name `xml:"entity"`
	ADIF    int      `xml:"adif,attr"`
	Name    string   `xml:"name"`   // Often the same as 'entity' in prefix, but can differ.
	Prefix  string   `xml:"prefix"` // Primary prefix for the entity
	ITUZ    int      `xml:"ituz"`   // ITU Zone is here
	CQZ     int      `xml:"cqz"`
	Cont    string   `xml:"cont"`
	Long    float64  `xml:"long"`
	Lat     float64  `xml:"lat"`
	Start   string   `xml:"start"`
	End     string   `xml:"end"`
}

Entity represents a single DXCC entity entry (for global entity data like ITU zone).

type Exception

type Exception struct {
	XMLName  xml.Name `xml:"exception"`
	RecordID int      `xml:"record,attr"`
	Call     string   `xml:"call"`
	Entity   string   `xml:"entity"`
	ADIF     int      `xml:"adif"`
	CQZ      int      `xml:"cqz"`
	Cont     string   `xml:"cont"`
	Long     float64  `xml:"long"`
	Lat      float64  `xml:"lat"`
	Start    string   `xml:"start"`
	End      string   `xml:"end"`
}

Exception represents a single DXCC exception entry.

type Exceptions

type Exceptions struct {
	XMLName   xml.Name    `xml:"exceptions"`
	Exception []Exception `xml:"exception"`
}

Exceptions holds a list of Exception records.

type HTTPDoer

type HTTPDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPDoer is a minimal interface for http clients used in tests.

type Prefix

type Prefix struct {
	XMLName  xml.Name `xml:"prefix"`
	RecordID int      `xml:"record,attr"` // 'record' attribute
	Call     string   `xml:"call"`
	Entity   string   `xml:"entity"`
	ADIF     int      `xml:"adif"`
	CQZ      int      `xml:"cqz"`
	Cont     string   `xml:"cont"`
	Long     float64  `xml:"long"`
	Lat      float64  `xml:"lat"`
	Start    string   `xml:"start"` // Will parse to time.Time
	End      string   `xml:"end"`   // Will parse to time.Time
}

Prefix represents a single DXCC prefix entry.

type Prefixes

type Prefixes struct {
	XMLName xml.Name `xml:"prefixes"`
	Prefix  []Prefix `xml:"prefix"`
}

Prefixes holds a list of Prefix records.