-[](https://travis-ci.com/la5nta/pat)
-[](https://ci.appveyor.com/project/martinhpedersen/pat)
+[](https://github.com/la5nta/pat/actions)
[](https://goreportcard.com/report/github.com/la5nta/pat)
[](https://liberapay.com/la5nta)
@@ -17,12 +16,12 @@ It is mainly developed for Linux, but is also known to run on OS X, Windows and
* Message composer/reader (basic mailbox functionality).
* Auto-shrink image attachments.
* Post position reports with location from local GPS, browser location or manual entry.
-* Rig control (using hamlib) for winmor PTT and QSY.
+* Rig control (using hamlib).
* CRON-like syntax for execution of scheduled commands (e.g. QSY or connect).
* Built in http-server with web interface (mobile friendly).
* Git style command line interface.
* Listen for P2P connections using multiple modes concurrently.
-* AX.25, telnet, WINMOR and ARDOP support.
+* AX.25, telnet, PACTOR and ARDOP support.
* Experimental gzip message compression (See "Gzip experiment" below).
##### Example
@@ -65,6 +64,7 @@ Copyright (c) 2020 Martin Hebnes Pedersen LA5NTA
* DL1THM - Torsten Harenberg
* HB9GPA - Matthias Renner
+* K0RET - Ryan Turner
* K0SWE - Chris Keller
* KD8DRX - Will Davidson
* KE8HMG - Andrew Huebner
@@ -72,9 +72,10 @@ Copyright (c) 2020 Martin Hebnes Pedersen LA5NTA
* LA3QMA - Kai Günter Brandt
* LA4TTA - Erlend Grimseid
* LA5NTA - Martin Hebnes Pedersen
+* N2YGK - Alan Crosswell
+* VE7GNU - Doug Collinge
* W6IPA - JC Martin
* WY2K - Benjamin Seidenberg
-* VE7GNU - Doug Collinge
## Thanks to
diff --git a/cfg/ax25_engine.go b/cfg/ax25_engine.go
new file mode 100644
index 00000000..387508dd
--- /dev/null
+++ b/cfg/ax25_engine.go
@@ -0,0 +1,28 @@
+package cfg
+
+import (
+ "encoding/json"
+ "fmt"
+)
+
+const (
+ AX25EngineAGWPE AX25Engine = "agwpe"
+ AX25EngineLinux = "linux"
+ AX25EngineSerialTNC = "serial-tnc"
+)
+
+type AX25Engine string
+
+func (a *AX25Engine) UnmarshalJSON(p []byte) error {
+ var str string
+ if err := json.Unmarshal(p, &str); err != nil {
+ return err
+ }
+ switch v := AX25Engine(str); v {
+ case AX25EngineLinux, AX25EngineAGWPE, AX25EngineSerialTNC:
+ *a = v
+ return nil
+ default:
+ return fmt.Errorf("invalid AX.25 engine '%s'", v)
+ }
+}
diff --git a/cfg/ax25_engine_libax25.go b/cfg/ax25_engine_libax25.go
new file mode 100644
index 00000000..87f4fa29
--- /dev/null
+++ b/cfg/ax25_engine_libax25.go
@@ -0,0 +1,6 @@
+//go:build libax25
+// +build libax25
+
+package cfg
+
+func DefaultAX25Engine() AX25Engine { return AX25EngineLinux }
diff --git a/cfg/ax25_engine_other.go b/cfg/ax25_engine_other.go
new file mode 100644
index 00000000..99064004
--- /dev/null
+++ b/cfg/ax25_engine_other.go
@@ -0,0 +1,6 @@
+//go:build !libax25
+// +build !libax25
+
+package cfg
+
+func DefaultAX25Engine() AX25Engine { return AX25EngineAGWPE }
diff --git a/cfg/config.go b/cfg/config.go
index d2cd93d6..2c0fc005 100644
--- a/cfg/config.go
+++ b/cfg/config.go
@@ -6,6 +6,9 @@ package cfg
import (
"encoding/json"
+ "fmt"
+ "net"
+ "strconv"
"strings"
"github.com/la5nta/wl2k-go/transport/ardop"
@@ -73,24 +76,27 @@ type Config struct {
// Connect aliases
//
- // Example: {"LA1B-10": "ax25:///LD5GU/LA1B-10", "LA1B": "winmor://LA3F?freq=5350"}
+ // Example: {"LA1B-10": "ax25:///LD5GU/LA1B-10", "LA1B": "ardop://LA3F?freq=5350"}
// Any occurrence of the substring "{mycall}" will be replaced with user's callsign.
ConnectAliases map[string]string `json:"connect_aliases"`
// Methods to listen for incoming P2P connections by default.
//
- // Example: ["ax25", "winmor", "telnet", "ardop"]
+ // Example: ["ax25", "telnet", "ardop"]
Listen []string `json:"listen"`
// Hamlib rigs available (with reference name) for ptt and frequency control.
HamlibRigs map[string]HamlibConfig `json:"hamlib_rigs"`
AX25 AX25Config `json:"ax25"` // See AX25Config.
+ AX25Linux AX25LinuxConfig `json:"ax25_linux"` // See AX25LinuxConfig.
+ AGWPE AGWPEConfig `json:"agwpe"` // See AGWPEConfig.
SerialTNC SerialTNCConfig `json:"serial-tnc"` // See SerialTNCConfig.
- Winmor WinmorConfig `json:"winmor"` // See WinmorConfig.
Ardop ArdopConfig `json:"ardop"` // See ArdopConfig.
Pactor PactorConfig `json:"pactor"` // See PactorConfig.
Telnet TelnetConfig `json:"telnet"` // See TelnetConfig.
+ VaraHF VaraConfig `json:"varahf"` // See VaraConfig.
+ VaraFM VaraConfig `json:"varafm"` // See VaraConfig.
// See GPSdConfig.
GPSd GPSdConfig `json:"gpsd"`
@@ -105,26 +111,20 @@ type Config struct {
// # Connect to telnet once every hour
// "@hourly": "connect telnet"
//
- // # Change winmor listen frequency based on hour of day
- // "00 10 * * *": "freq winmor:7350.000", # 40m from 10:00
- // "00 18 * * *": "freq winmor:5347.000", # 60m from 18:00
- // "00 22 * * *": "freq winmor:3602.000" # 80m from 22:00
+ // # Change ardop listen frequency based on hour of day
+ // "00 10 * * *": "freq ardop:7350.000", # 40m from 10:00
+ // "00 18 * * *": "freq ardop:5347.000", # 60m from 18:00
+ // "00 22 * * *": "freq ardop:3602.000" # 80m from 22:00
Schedule map[string]string `json:"schedule"`
// By default, Pat posts your callsign and running version to the Winlink CMS Web Services
//
// Set to true if you don't want your information sent.
VersionReportingDisabled bool `json:"version_reporting_disabled"`
-
- // Path to root of the Winlink Standard_Forms folder.
- // Unzip after downloading from winlink.org
- //
- // Deprecated: in favor of the --forms flag
- FormsPath string `json:"forms_path,omitempty"`
}
type HamlibConfig struct {
- // The network type ("serial" or "tcp"). Use 'tcp' for rigctld.
+ // The network type ("serial" or "tcp"). Use 'tcp' for rigctld (default).
//
// (For serial support: build with "-tags libhamlib".)
Network string `json:"network,omitempty"`
@@ -139,45 +139,76 @@ type HamlibConfig struct {
VFO string `json:"VFO"`
}
-type WinmorConfig struct {
- // Network address of the Winmor TNC (e.g. localhost:8500).
+type ArdopConfig struct {
+ // Network address of the Ardop TNC (e.g. localhost:8515).
Addr string `json:"addr"`
- // Bandwidth to use when getting an inbound connection (500/1600).
- InboundBandwidth int `json:"inbound_bandwidth"`
-
- // TX audio drive level
- //
- // Set to 0 to use WINMOR defaults
- DriveLevel int `json:"drive_level"`
+ // Default/listen ARQ bandwidth (200/500/1000/2000 MAX/FORCED).
+ ARQBandwidth ardop.Bandwidth `json:"arq_bandwidth"`
// (optional) Reference name to the Hamlib rig to control frequency and ptt.
Rig string `json:"rig"`
// Set to true if hamlib should control PTT (SignaLink=false, most rigexpert=true).
PTTControl bool `json:"ptt_ctrl"`
+
+ // (optional) Send ID frame at a regular interval when the listener is active (unit is seconds)
+ BeaconInterval int `json:"beacon_interval"`
+
+ // Send FSK CW ID after an ID frame.
+ CWID bool `json:"cwid_enabled"`
}
-type ArdopConfig struct {
- // Network address of the Ardop TNC (e.g. localhost:8515).
+type VaraConfig struct {
+ // Network host of the VARA modem (defaults to localhost:8300).
Addr string `json:"addr"`
- // ARQ bandwidth (200/500/1000/2000 MAX/FORCED).
- ARQBandwidth ardop.Bandwidth `json:"arq_bandwidth"`
+ // Default/listen bandwidth (HF: 500/2300/2750 Hz).
+ Bandwidth int `json:"bandwidth"`
// (optional) Reference name to the Hamlib rig to control frequency and ptt.
Rig string `json:"rig"`
// Set to true if hamlib should control PTT (SignaLink=false, most rigexpert=true).
PTTControl bool `json:"ptt_ctrl"`
+}
- // (optional) Send ID frame at a regular interval when the listener is active (unit is seconds)
- BeaconInterval int `json:"beacon_interval"`
+// UnmarshalJSON implements VaraConfig JSON unmarshalling with support for legacy format.
+func (v *VaraConfig) UnmarshalJSON(b []byte) error {
+ type newFormat VaraConfig
+ legacy := struct {
+ newFormat
+ Host string `json:"host"`
+ CmdPort int `json:"cmdPort"`
+ DataPort int `json:"dataPort"`
+ }{}
+ if err := json.Unmarshal(b, &legacy); err != nil {
+ return err
+ }
+ if legacy.newFormat.Addr == "" && legacy.Host != "" {
+ legacy.newFormat.Addr = fmt.Sprintf("%s:%d", legacy.Host, legacy.CmdPort)
+ }
+ *v = VaraConfig(legacy.newFormat)
+ if !v.IsZero() && v.CmdPort() <= 0 {
+ return fmt.Errorf("invalid addr format")
+ }
+ return nil
+}
- // Send FSK CW ID after an ID frame.
- CWID bool `json:"cwid_enabled"`
+func (v VaraConfig) IsZero() bool { return v == (VaraConfig{}) }
+
+func (v VaraConfig) Host() string {
+ host, _, _ := net.SplitHostPort(v.Addr)
+ return host
}
+func (v VaraConfig) CmdPort() int {
+ _, portStr, _ := net.SplitHostPort(v.Addr)
+ port, _ := strconv.Atoi(portStr)
+ return port
+}
+func (v VaraConfig) DataPort() int { return v.CmdPort() + 1 }
+
type PactorConfig struct {
// Path/port to TNC device (e.g. /dev/ttyUSB0 or COM1).
Path string `json:"path"`
@@ -216,17 +247,41 @@ type SerialTNCConfig struct {
// Type of TNC (currently only 'kenwood').
Type string `json:"type"`
+
+ // (optional) Reference name to the Hamlib rig for frequency control.
+ Rig string `json:"rig"`
+}
+
+type AGWPEConfig struct {
+ // The TCP address of the TNC.
+ Addr string `json:"addr"`
+
+ // The AGWPE "radio port" (0-3).
+ RadioPort int `json:"radio_port"`
}
type AX25Config struct {
- // axport to use (as defined in /etc/ax25/axports).
- Port string `json:"port"`
+ // The AX.25 engine to be used.
+ //
+ // Valid options are:
+ // - linux
+ // - agwpe
+ // - serial-tnc
+ Engine AX25Engine `json:"engine"`
+
+ // (optional) Reference name to the Hamlib rig for frequency control.
+ Rig string `json:"rig"`
+
+ // DEPRECATED: See AX25Linux.Port.
+ AXPort string `json:"port,omitempty"`
// Optional beacon when listening for incoming packet-p2p connections.
Beacon BeaconConfig `json:"beacon"`
+}
- // (optional) Reference name to the Hamlib rig for frequency control.
- Rig string `json:"rig"`
+type AX25LinuxConfig struct {
+ // axport to use (as defined in /etc/ax25/axports). Only applicable to ax25 engine 'linux'.
+ Port string `json:"port"`
}
type BeaconConfig struct {
@@ -241,16 +296,20 @@ type BeaconConfig struct {
}
type GPSdConfig struct {
- // enable GPSd support in web interface
- // WARNING: If you enable GPSd http endpoint (enable_http) you might
- // expose your current position to anyone who has access to Pat!!!
+ // Enable GPSd proxy for HTTP (web GUI)
+ //
+ // Caution: Your GPS position will be accessible to any network device able to access Pat's HTTP interface.
EnableHTTP bool `json:"enable_http"`
- // Use server time instead of timestamp provided by GPSd (e.g for older GPS
- // device with week roll-over issue)
+ // Allow Winlink forms to use GPSd for aquiring your position.
+ //
+ // Caution: Your current GPS position will be automatically injected, without your explicit consent, into forms requesting such information.
+ AllowForms bool `json:"allow_forms"`
+
+ // Use server time instead of timestamp provided by GPSd (e.g for older GPS device with week roll-over issue).
UseServerTime bool `json:"use_server_time"`
- // Address and port of GPSd server (e.g. localhost:2947)
+ // Address and port of GPSd server (e.g. localhost:2947).
Addr string `json:"addr"`
}
@@ -264,22 +323,25 @@ var DefaultConfig = Config{
Listen: []string{},
HTTPAddr: "localhost:8080",
AX25: AX25Config{
- Port: "wl2k",
+ Engine: DefaultAX25Engine(),
Beacon: BeaconConfig{
Every: 3600,
Message: "Winlink P2P",
Destination: "IDENT",
},
},
+ AX25Linux: AX25LinuxConfig{
+ Port: "wl2k",
+ },
SerialTNC: SerialTNCConfig{
Path: "/dev/ttyUSB0",
SerialBaud: 9600,
HBaud: 1200,
Type: "Kenwood",
},
- Winmor: WinmorConfig{
- Addr: "localhost:8500",
- InboundBandwidth: 1600,
+ AGWPE: AGWPEConfig{
+ Addr: "localhost:8000",
+ RadioPort: 0,
},
Ardop: ArdopConfig{
Addr: "localhost:8515",
@@ -294,15 +356,20 @@ var DefaultConfig = Config{
ListenAddr: ":8774",
Password: "",
},
+ VaraHF: VaraConfig{
+ Addr: "localhost:8300",
+ Bandwidth: 2300,
+ },
+ VaraFM: VaraConfig{
+ Addr: "localhost:8300",
+ },
GPSd: GPSdConfig{
EnableHTTP: false, // Default to false to help protect privacy of unknowing users (see github.com//issues/146)
+ AllowForms: false, // Default to false to help protect location privacy of unknowing users
UseServerTime: false,
Addr: "localhost:2947", // Default listen address for GPSd
},
GPSdAddrLegacy: "",
Schedule: map[string]string{},
HamlibRigs: map[string]HamlibConfig{},
-
- // Path to root of the unzipped Winlink Standard_Forms folder.
- FormsPath: "",
}
diff --git a/cfg/example_config.json b/cfg/example_config.json
deleted file mode 100644
index d9939f7f..00000000
--- a/cfg/example_config.json
+++ /dev/null
@@ -1,56 +0,0 @@
-{
- "mycall": "LA5NTA",
- "secure_login_password": "my_not_so_secret_password",
- "auxiliary_addresses": ["LE1OF"],
- "locator": "JP20qe",
- "connect_aliases": {
- "LA1B@60m": "winmor:///LA1B?freq=5310.00",
- "LA1B-10": "ax25:///LA1B-10"
- },
- "hamlib_rigs": {
- "ft897": {
- "network": "tcp",
- "address": "localhost:4532"
- }
- },
- "ax25": {
- "port": "tmd710",
- "beacon": {
- "every": 3600,
- "message": "Winlink P2P",
- "destination": "IDENT"
- }
- },
- "serial-tnc": {
- "path": "/dev/ttyUSB0",
- "hbaud": 1200,
- "serial_baud": 9600,
- "type": "Kenwood"
- },
- "winmor": {
- "addr": "la5nta.local.mesh:8500",
- "inbound_bandwidth": 500,
- "rig": "ft897",
- "ptt_ctrl": false
- },
- "ardop": {
- "addr": "localhost:8515",
- "arq_bandwidth": {"Forced":false, "Max":500},
- "beacon_interval": 0,
- "cwid_enabled": true,
- "rig": "ft897",
- "ptt_ctrl": false
- },
- "telnet": {
- "listen_addr": ":8774",
- "password": ""
- },
- "schedule": {
- "*/30 * * * *": "connect offgrid"
- },
- "gpsd": {
- "enable_http": false,
- "use_server_time": false,
- "addr": "localhost:2947"
- }
-}
diff --git a/cli_composer.go b/cli_composer.go
index 5b5c1418..ef6e19b6 100644
--- a/cli_composer.go
+++ b/cli_composer.go
@@ -8,6 +8,7 @@ package main
import (
"bufio"
"bytes"
+ "context"
"fmt"
"io"
"io/ioutil"
@@ -102,11 +103,14 @@ func composeMessageHeader(replyMsg *fbb.Message) *fbb.Message {
return msg
}
-func composeMessage(args []string) {
+func composeMessage(ctx context.Context, args []string) {
set := pflag.NewFlagSet("compose", pflag.ExitOnError)
+ // From default is --mycall but it can be overriden with -r
+ from := set.StringP("from", "r", fOptions.MyCall, "")
subject := set.StringP("subject", "s", "", "")
attachments := set.StringArrayP("attachment", "a", nil, "")
ccs := set.StringArrayP("cc", "c", nil, "")
+ p2pOnly := set.BoolP("p2p-only", "", false, "")
set.Parse(args)
// Remaining args are recipients
@@ -122,14 +126,13 @@ func composeMessage(args []string) {
// Check if any args are set. If so, go non-interactive
// Otherwise, interactive
if (len(*subject) + len(*attachments) + len(*ccs) + len(recipients)) > 0 {
- noninteractiveComposeMessage(*subject, *attachments, *ccs, recipients)
+ noninteractiveComposeMessage(*from, *subject, *attachments, *ccs, recipients, *p2pOnly)
} else {
interactiveComposeMessage(nil)
}
}
-func noninteractiveComposeMessage(subject string, attachments []string,
- ccs []string, recipients []string) {
+func noninteractiveComposeMessage(from string, subject string, attachments []string, ccs []string, recipients []string, p2pOnly bool) {
// We have to verify the args here. Follow the same pattern as main()
// We'll allow a missing recipient if CC is present (or vice versa)
if len(recipients)+len(ccs) <= 0 {
@@ -143,7 +146,7 @@ func noninteractiveComposeMessage(subject string, attachments []string,
}
msg := fbb.NewMessage(fbb.Private, fOptions.MyCall)
- msg.SetFrom(fOptions.MyCall)
+ msg.SetFrom(from)
for _, to := range recipients {
msg.AddTo(to)
}
@@ -171,11 +174,14 @@ func noninteractiveComposeMessage(subject string, attachments []string,
}
msg.SetBody(string(body))
+ if p2pOnly {
+ msg.Header.Set("X-P2POnly", "true")
+ }
postMessage(msg)
}
-// This is currently an alias for interactiveComposeMessage but keeping as a seperate
+// This is currently an alias for interactiveComposeMessage but keeping as a separate
// call path for the future
func composeReplyMessage(replyMsg *fbb.Message) {
interactiveComposeMessage(replyMsg)
@@ -264,7 +270,7 @@ func readAttachment(path string) (*fbb.File, error) {
name := filepath.Base(path)
var resizeImage bool
- if isImageMediaType(name, "") {
+ if isConvertableImageMediaType(name, "") {
fmt.Print("This seems to be an image. Auto resize? [Y/n]: ")
ans := readLine()
resizeImage = ans == "" || strings.EqualFold("y", ans)
@@ -293,7 +299,7 @@ func readLine() string {
return strings.TrimSpace(str)
}
-func composeFormReport(args []string) {
+func composeFormReport(ctx context.Context, args []string) {
var tmplPathArg string
set := pflag.NewFlagSet("form", pflag.ExitOnError)
@@ -304,7 +310,7 @@ func composeFormReport(args []string) {
formMsg, err := formsMgr.ComposeForm(tmplPathArg, msg.Subject())
if err != nil {
- log.Printf("failed to compose message for template %s", tmplPathArg)
+ log.Printf("failed to compose message for template: %v", err)
return
}
@@ -326,8 +332,10 @@ func composeFormReport(args []string) {
msg.SetBody(formMsg.Body)
- attachmentFile := fbb.NewFile(formMsg.AttachmentName, []byte(formMsg.AttachmentXML))
- msg.AddFile(attachmentFile)
+ if xml := formMsg.AttachmentXML; xml != "" {
+ attachmentFile := fbb.NewFile(formMsg.AttachmentName, []byte(xml))
+ msg.AddFile(attachmentFile)
+ }
postMessage(msg)
}
diff --git a/config.go b/config.go
index 4196410a..5884837f 100644
--- a/config.go
+++ b/config.go
@@ -5,24 +5,37 @@
package main
import (
- "bytes"
"encoding/json"
"fmt"
"log"
"os"
"path"
- "path/filepath"
"strings"
+ "github.com/kelseyhightower/envconfig"
"github.com/la5nta/pat/cfg"
+ "github.com/la5nta/pat/internal/buildinfo"
"github.com/la5nta/pat/internal/debug"
)
func LoadConfig(cfgPath string, fallback cfg.Config) (config cfg.Config, err error) {
config, err = ReadConfig(cfgPath)
- if os.IsNotExist(err) {
- return fallback, WriteConfig(fallback, cfgPath)
- } else if err != nil {
+ switch {
+ case os.IsNotExist(err):
+ config = fallback
+ if err := WriteConfig(config, cfgPath); err != nil {
+ return config, err
+ }
+ case err != nil:
+ return config, err
+ }
+
+ // Environment variables overrides values from the config file
+ if err := envconfig.Process(buildinfo.AppName, &config); err != nil {
+ return config, err
+ }
+ // Environment variables for hamlib rigs (custom syntax not handled by envconfig)
+ if err := readRigsFromEnv(&config.HamlibRigs); err != nil {
return config, err
}
@@ -34,64 +47,119 @@ func LoadConfig(cfgPath string, fallback cfg.Config) (config cfg.Config, err err
config.ConnectAliases["telnet"] = cfg.DefaultConfig.ConnectAliases["telnet"]
}
+ // TODO: Remove after some release cycles (2023-05-21)
+ // Rewrite deprecated serial-tnc:// aliases to ax25-serial-tnc://
+ var deprecatedAliases []string
+ for k, v := range config.ConnectAliases {
+ if !strings.HasPrefix(v, MethodSerialTNCDeprecated+"://") {
+ continue
+ }
+ deprecatedAliases = append(deprecatedAliases, k)
+ config.ConnectAliases[k] = strings.Replace(v, MethodSerialTNCDeprecated, MethodAX25SerialTNC, 1)
+ }
+ if len(deprecatedAliases) > 0 {
+ log.Printf("Alias(es) %s uses deprecated transport scheme %s://. Please use %s:// instead.", strings.Join(deprecatedAliases, ", "), MethodSerialTNCDeprecated, MethodAX25SerialTNC)
+ }
+
// Ensure ServiceCodes has a default value
if len(config.ServiceCodes) == 0 {
config.ServiceCodes = cfg.DefaultConfig.ServiceCodes
}
+ // Ensure we have a default AX.25 engine
+ if config.AX25.Engine == "" {
+ config.AX25.Engine = cfg.DefaultAX25Engine()
+ }
+
+ // Ensure we have a default AGWPE config
+ if config.AGWPE == (cfg.AGWPEConfig{}) {
+ config.AGWPE = cfg.DefaultConfig.AGWPE
+ }
+
+ // Ensure we have a default AX.25 Linux config
+ if config.AX25Linux == (cfg.AX25LinuxConfig{}) {
+ config.AX25Linux = cfg.DefaultConfig.AX25Linux
+ }
+ // TODO: Remove after some release cycles (2023-04-30)
+ if v := config.AX25.AXPort; v != "" && v != config.AX25Linux.Port {
+ log.Println("Using deprecated configuration option ax25.port. Please set ax25_linux.port instead.")
+ config.AX25Linux.Port = v
+ }
+
// Ensure Pactor has a default value
if config.Pactor == (cfg.PactorConfig{}) {
config.Pactor = cfg.DefaultConfig.Pactor
}
- // TODO: Remove after some release cycles (2019-09-29)
- if config.GPSdAddrLegacy != "" {
- config.GPSd.Addr = config.GPSdAddrLegacy
+ // Ensure VARA FM and VARA HF has default values
+ if config.VaraHF.IsZero() {
+ config.VaraHF = cfg.DefaultConfig.VaraHF
+ }
+ if config.VaraFM.IsZero() {
+ config.VaraFM = cfg.DefaultConfig.VaraFM
}
- // TODO: config FormsPath is deprecated in favor of --forms flag
- homeDir, _ := os.UserHomeDir()
- formsOldDefault := filepath.Join(homeDir, ".wl2k", "Standard_Forms")
- // Ignore the old default config value
- if config.FormsPath == formsOldDefault {
- config.FormsPath = ""
+ // Ensure GPSd has a default value
+ if config.GPSd == (cfg.GPSdConfig{}) {
+ config.GPSd = cfg.DefaultConfig.GPSd
}
- if config.FormsPath != "" {
- log.Println("Using deprecated configuration option 'forms_path'. Please use --forms flag instead.")
- // clean up FormsPath (normalizes trailing slashes, and embedded '.' )
- config.FormsPath = filepath.Clean(config.FormsPath)
- config.FormsPath = strings.ReplaceAll(config.FormsPath, "\\", "/")
+ // TODO: Remove after some release cycles (2019-09-29)
+ if v := config.GPSdAddrLegacy; v != "" && v != config.GPSd.Addr {
+ log.Println("Using deprecated configuration option gpsd_addr. Please set gpsd.addr instead.")
+ config.GPSd.Addr = v
}
+ // Ensure SerialTNC has a default hbaud and serialbaud
+ if config.SerialTNC.HBaud == 0 {
+ config.SerialTNC.HBaud = cfg.DefaultConfig.SerialTNC.HBaud
+ }
+ if config.SerialTNC.SerialBaud == 0 {
+ config.SerialTNC.SerialBaud = cfg.DefaultConfig.SerialTNC.SerialBaud
+ }
// Compatibility for the old baudrate field for serial-tnc
- if v := config.SerialTNC.BaudrateLegacy; v != 0 && config.SerialTNC.HBaud == 0 {
+ if v := config.SerialTNC.BaudrateLegacy; v != 0 && v != config.SerialTNC.HBaud {
+ // Since we changed the default value from 9600 to 1200, we can't warn about this without causing confusion.
debug.Printf("Legacy serial_tnc.baudrate config detected (%d). Translating to serial_tnc.hbaud.", v)
config.SerialTNC.HBaud = v
- config.SerialTNC.BaudrateLegacy = 0
}
+
return config, nil
}
-func replaceDeprecatedCMSHostname(path string, data []byte) ([]byte, error) {
- const o = "@server.winlink.org:8772/wl2k"
- const n = "@cms.winlink.org:8772/wl2k"
-
- if !bytes.Contains(data, []byte(o)) {
- return data, nil
- }
-
- data = bytes.ReplaceAll(data, []byte(o), []byte(n))
-
- f, err := os.Open(path)
- if err != nil {
- return data, err
- }
- stat, err := f.Stat()
- f.Close()
- if err != nil {
- return data, err
+// readRigsFromEnv reads hamlib rigs config from environment.
+// Syntax: PAT_HAMLIB_RIGS_{rig name}_{ATTRIBUTE}
+// _{ATTRIBUTE} is optional (defaults to _ADDRESS).
+// Examples:
+// - PAT_HAMLIB_RIGS_rig1_NETWORK=tcp
+// - PAT_HAMLIB_RIGS_rig1_ADDRESS=localhost:8080
+// - PAT_HAMLIB_RIGS_rig1_VFO=A
+// - PAT_HAMLIB_RIGS_rig2=localhost:8080
+func readRigsFromEnv(rigs *map[string]cfg.HamlibConfig) error {
+ prefix := strings.ToUpper(buildinfo.AppName) + "_HAMLIB_RIGS_"
+ for _, env := range os.Environ() {
+ attribute, value, _ := strings.Cut(env, "=")
+ if !strings.HasPrefix(attribute, prefix) {
+ continue
+ }
+ attribute = strings.TrimPrefix(attribute, prefix)
+ name, attribute, _ := strings.Cut(attribute, "_")
+ if *rigs == nil {
+ *rigs = make(map[string]cfg.HamlibConfig)
+ }
+ rig := (*rigs)[name]
+ switch attribute {
+ case "ADDRESS", "":
+ rig.Address = value
+ case "NETWORK":
+ rig.Network = value
+ case "VFO":
+ rig.VFO = value
+ default:
+ return fmt.Errorf("invalid attribute '%s' for rig '%s'", attribute, name)
+ }
+ (*rigs)[name] = rig
}
- return data, os.WriteFile(path, data, stat.Mode())
+ return nil
}
func ReadConfig(path string) (config cfg.Config, err error) {
@@ -99,16 +167,6 @@ func ReadConfig(path string) (config cfg.Config, err error) {
if err != nil {
return
}
-
- // TODO: Remove after some release cycles (2017-11-09)
- data, err = replaceDeprecatedCMSHostname(path, data)
- if err != nil {
- fmt.Println("Failed to rewrite deprecated CMS hostname:", err)
- fmt.Println("Please update your config's 'telnet' connect alias manually to:")
- fmt.Println(cfg.DefaultConfig.ConnectAliases["telnet"])
- fmt.Println("")
- }
-
err = json.Unmarshal(data, &config)
return
}
diff --git a/config_test.go b/config_test.go
new file mode 100644
index 00000000..5d7653cc
--- /dev/null
+++ b/config_test.go
@@ -0,0 +1,62 @@
+package main
+
+import (
+ "os"
+ "strings"
+ "testing"
+
+ "github.com/la5nta/pat/cfg"
+)
+
+func TestReadRigsFromEnv(t *testing.T) {
+ const prefix = "PAT_HAMLIB_RIGS"
+ unset := func() {
+ for _, env := range os.Environ() {
+ key, _, _ := strings.Cut(env, "=")
+ if strings.HasPrefix(key, prefix) {
+ os.Unsetenv(key)
+ }
+ }
+ }
+ t.Run("simple", func(t *testing.T) {
+ defer unset()
+ var rigs map[string]cfg.HamlibConfig
+ os.Setenv(prefix+"_rig", "localhost:4532")
+ if err := readRigsFromEnv(&rigs); err != nil {
+ t.Fatal(err)
+ }
+ if got := rigs["rig"]; (got != cfg.HamlibConfig{Address: "localhost:4532"}) {
+ t.Fatalf("Got unexpected config: %#v", got)
+ }
+ })
+ t.Run("with VFO", func(t *testing.T) {
+ defer unset()
+ var rigs map[string]cfg.HamlibConfig
+ os.Setenv(prefix+"_rig", "localhost:4532")
+ os.Setenv(prefix+"_rig_VFO", "A")
+ if err := readRigsFromEnv(&rigs); err != nil {
+ t.Fatal(err)
+ }
+ if got := rigs["rig"]; (got != cfg.HamlibConfig{Address: "localhost:4532", VFO: "A"}) {
+ t.Fatalf("Got unexpected config: %#v", got)
+ }
+ })
+ t.Run("full", func(t *testing.T) {
+ defer unset()
+ var rigs map[string]cfg.HamlibConfig
+ os.Setenv(prefix+"_rig_ADDRESS", "/dev/ttyS0")
+ os.Setenv(prefix+"_rig_NETWORK", "serial")
+ os.Setenv(prefix+"_rig_VFO", "B")
+ if err := readRigsFromEnv(&rigs); err != nil {
+ t.Fatal(err)
+ }
+ expect := cfg.HamlibConfig{
+ Address: "/dev/ttyS0",
+ Network: "serial",
+ VFO: "B",
+ }
+ if got := rigs["rig"]; got != expect {
+ t.Fatalf("Got unexpected config: %#v", got)
+ }
+ })
+}
diff --git a/connect.go b/connect.go
index 6c1639ea..df8614eb 100644
--- a/connect.go
+++ b/connect.go
@@ -5,27 +5,39 @@
package main
import (
+ "context"
+ "errors"
"fmt"
"log"
"strconv"
"strings"
"time"
+ "github.com/la5nta/pat/cfg"
+ "github.com/la5nta/pat/internal/debug"
+
"github.com/harenber/ptc-go/v2/pactor"
"github.com/la5nta/wl2k-go/transport"
"github.com/la5nta/wl2k-go/transport/ardop"
- "github.com/la5nta/wl2k-go/transport/winmor"
+ "github.com/la5nta/wl2k-go/transport/ax25/agwpe"
+ "github.com/n8jja/Pat-Vara/vara"
- // Register other dialers
+ // Register stateless dialers
_ "github.com/la5nta/wl2k-go/transport/ax25"
_ "github.com/la5nta/wl2k-go/transport/telnet"
)
var (
dialing *transport.URL // The connect URL currently being dialed (if any)
- wmTNC *winmor.TNC // Pointer to the WINMOR TNC used by Listen and Connect
- adTNC *ardop.TNC // Pointer to the ARDOP TNC used by Listen and Connect
- pModem *pactor.Modem
+
+ adTNC *ardop.TNC // Pointer to the ARDOP TNC used by Listen and Connect
+ agwpeTNC *agwpe.TNCPort // Pointer to the AGWPE TNC combined TNC and Port
+ pModem *pactor.Modem
+ varaHFModem *vara.Modem
+ varaFMModem *vara.Modem
+
+ // Context cancellation function for aborting while dialing.
+ dialCancelFunc func() = func() {}
)
func hasSSID(str string) bool { return strings.Contains(str, "-") }
@@ -46,21 +58,39 @@ func Connect(connectStr string) (success bool) {
return Connect(aliased)
}
+ // Hack around bug in frontend which may occur if the status updates too quickly.
+ if websocketHub != nil {
+ defer func() { time.Sleep(time.Second); websocketHub.UpdateStatus() }()
+ }
+
+ debug.Printf("connectStr: %s", connectStr)
url, err := transport.ParseURL(connectStr)
if err != nil {
log.Println(err)
return false
}
+ // TODO: Remove after some release cycles (2023-05-21)
+ // Rewrite legacy serial-tnc scheme.
+ if url.Scheme == MethodSerialTNCDeprecated {
+ log.Printf("Transport scheme %s:// is deprecated, use %s:// instead.", MethodSerialTNCDeprecated, MethodAX25SerialTNC)
+ url.Scheme = MethodAX25SerialTNC
+ }
+
+ // Rewrite the generic ax25:// scheme to use a specified AX.25 engine.
+ if url.Scheme == MethodAX25 {
+ url.Scheme = defaultAX25Method()
+ }
+
// Init TNCs
switch url.Scheme {
- case MethodArdop:
- if err := initArdopTNC(); err != nil {
+ case MethodAX25AGWPE:
+ if err := initAGWPE(); err != nil {
log.Println(err)
return
}
- case MethodWinmor:
- if err := initWinmorTNC(); err != nil {
+ case MethodArdop:
+ if err := initArdopTNC(); err != nil {
log.Println(err)
return
}
@@ -73,6 +103,16 @@ func Connect(connectStr string) (success bool) {
log.Println(err)
return
}
+ case MethodVaraHF:
+ if err := initVaraHFModem(); err != nil {
+ log.Println(err)
+ return
+ }
+ case MethodVaraFM:
+ if err := initVaraFMModem(); err != nil {
+ log.Println(err)
+ return
+ }
}
// Set default userinfo (mycall)
@@ -83,9 +123,9 @@ func Connect(connectStr string) (success bool) {
// Set default host interface address
if url.Host == "" {
switch url.Scheme {
- case MethodAX25:
- url.Host = config.AX25.Port
- case MethodSerialTNC:
+ case MethodAX25Linux:
+ url.Host = config.AX25Linux.Port
+ case MethodAX25SerialTNC:
url.Host = config.SerialTNC.Path
if hbaud := config.SerialTNC.HBaud; hbaud > 0 {
url.Params.Set("hbaud", fmt.Sprint(hbaud))
@@ -107,13 +147,11 @@ func Connect(connectStr string) (success bool) {
return
}
- switch url.Scheme {
- case MethodAX25, MethodSerialTNC:
+ if strings.HasPrefix(url.Scheme, MethodAX25) {
log.Printf("Radio-Only is not available for %s", url.Scheme)
return
- default:
- url.SetUser(url.User.Username() + "-T")
}
+ url.SetUser(url.User.Username() + "-T")
}
// QSY
@@ -136,29 +174,30 @@ func Connect(connectStr string) (success bool) {
switch url.Scheme {
case MethodArdop:
waitBusy(adTNC)
- case MethodWinmor:
- waitBusy(wmTNC)
}
- // Catch interrupts (signals) while dialing, so users can abort ardop/winmor connects.
- doneHandleInterrupt := handleInterrupt()
+ ctx, cancel := context.WithCancel(context.Background())
+ dialCancelFunc = func() { dialing = nil; cancel() }
+ defer dialCancelFunc()
// Signal web gui that we are dialing a connection
dialing = url
websocketHub.UpdateStatus()
log.Printf("Connecting to %s (%s)...", url.Target, url.Scheme)
- conn, err := transport.DialURL(url)
+ conn, err := transport.DialURLContext(ctx, url)
// Signal web gui that we are no longer dialing
dialing = nil
websocketHub.UpdateStatus()
- close(doneHandleInterrupt)
-
eventLog.LogConn("connect "+connectStr, currFreq, conn, err)
- if err != nil {
+ switch {
+ case errors.Is(err, context.Canceled):
+ log.Printf("Connect cancelled")
+ return
+ case err != nil:
log.Printf("Unable to establish connection to remote: %s", err)
return
}
@@ -212,48 +251,6 @@ func waitBusy(b transport.BusyChannelChecker) {
}
}
-func initWinmorTNC() error {
- if wmTNC != nil && wmTNC.Ping() == nil {
- return nil
- }
-
- if wmTNC != nil {
- wmTNC.Close()
- }
-
- var err error
- wmTNC, err = winmor.Open(config.Winmor.Addr, fOptions.MyCall, config.Locator)
- if err != nil {
- return fmt.Errorf("WINMOR TNC initialization failed: %w", err)
- }
-
- if config.Winmor.DriveLevel != 0 {
- if err := wmTNC.SetDriveLevel(config.Winmor.DriveLevel); err != nil {
- log.Println("Failed to set WINMOR drive level:", err)
- }
- }
-
- if v, err := wmTNC.Version(); err != nil {
- return fmt.Errorf("WINMOR TNC initialization failed: %s", err)
- } else {
- log.Printf("WINMOR TNC v%s initialized", v)
- }
-
- transport.RegisterDialer(MethodWinmor, wmTNC)
-
- if !config.Winmor.PTTControl {
- return nil
- }
-
- rig, ok := rigs[config.Winmor.Rig]
- if !ok {
- return fmt.Errorf("unable to set PTT rig '%s': not defined or not loaded", config.Winmor.Rig)
- }
- wmTNC.SetPTT(rig)
-
- return nil
-}
-
func initArdopTNC() error {
if adTNC != nil && adTNC.Ping() == nil {
return nil
@@ -314,3 +311,103 @@ func initPactorModem(cmdlineinit string) error {
return nil
}
+
+func initVaraHFModem() error {
+ if varaHFModem != nil && varaHFModem.Ping() {
+ return nil
+ }
+ if varaHFModem != nil {
+ varaHFModem.Close()
+ }
+ m, err := initVaraModem(MethodVaraHF, config.VaraHF)
+ if err != nil {
+ return err
+ }
+ if bw := config.VaraHF.Bandwidth; bw != 0 {
+ if err := m.SetBandwidth(fmt.Sprint(bw)); err != nil {
+ m.Close()
+ return err
+ }
+ }
+ varaHFModem = m
+ return nil
+}
+
+func initVaraFMModem() error {
+ if varaFMModem != nil && varaFMModem.Ping() {
+ return nil
+ }
+ if varaFMModem != nil {
+ varaFMModem.Close()
+ }
+ m, err := initVaraModem(MethodVaraFM, config.VaraFM)
+ if err != nil {
+ return err
+ }
+ varaFMModem = m
+ return nil
+}
+
+func initVaraModem(scheme string, conf cfg.VaraConfig) (*vara.Modem, error) {
+ vConf := vara.ModemConfig{
+ Host: conf.Host(),
+ CmdPort: conf.CmdPort(),
+ DataPort: conf.DataPort(),
+ }
+ m, err := vara.NewModem(scheme, fOptions.MyCall, vConf)
+ if err != nil {
+ return nil, fmt.Errorf("vara initialization failed: %w", err)
+ }
+ transport.RegisterDialer(scheme, m)
+
+ if conf.PTTControl {
+ rig, ok := rigs[conf.Rig]
+ if !ok {
+ m.Close()
+ return nil, fmt.Errorf("unable to set PTT rig '%s': not defined or not loaded", conf.Rig)
+ }
+ m.SetPTT(rig)
+ }
+ v, _ := m.Version()
+ log.Printf("VARA modem (%s) initialized", v)
+ return m, nil
+}
+
+func initAGWPE() error {
+ if agwpeTNC != nil && agwpeTNC.Ping() == nil {
+ return nil
+ }
+
+ if agwpeTNC != nil {
+ agwpeTNC.Close()
+ }
+
+ var err error
+ agwpeTNC, err = agwpe.OpenPortTCP(config.AGWPE.Addr, config.AGWPE.RadioPort, fOptions.MyCall)
+ if err != nil {
+ return fmt.Errorf("AGWPE TNC initialization failed: %w", err)
+ }
+
+ if v, err := agwpeTNC.Version(); err != nil {
+ return fmt.Errorf("AGWPE TNC initialization failed: %w", err)
+ } else {
+ log.Printf("AGWPE TNC (%s) initialized", v)
+ }
+
+ transport.RegisterContextDialer(MethodAX25AGWPE, agwpeTNC)
+ return nil
+}
+
+// defaultAX25Method resolves the generic ax25:// scheme to a implementation specific scheme.
+func defaultAX25Method() string {
+ switch config.AX25.Engine {
+ case cfg.AX25EngineAGWPE:
+ return MethodAX25AGWPE
+ case cfg.AX25EngineSerialTNC:
+ return MethodAX25SerialTNC
+ case cfg.AX25EngineLinux:
+ return MethodAX25Linux
+ default:
+ panic(fmt.Sprintf("invalid ax25 engine: %s", config.AX25.Engine))
+ }
+}
diff --git a/convert_image.go b/convert_image.go
index e1459efe..c67329c9 100644
--- a/convert_image.go
+++ b/convert_image.go
@@ -17,7 +17,7 @@ import (
"github.com/nfnt/resize"
)
-func isImageMediaType(filename, contentType string) bool {
+func isConvertableImageMediaType(filename, contentType string) bool {
var mediaType string
if contentType != "" {
mediaType, _, _ = mime.ParseMediaType(contentType)
@@ -26,7 +26,13 @@ func isImageMediaType(filename, contentType string) bool {
mediaType = mime.TypeByExtension(path.Ext(filename))
}
- return strings.HasPrefix(mediaType, "image/")
+ switch mediaType {
+ case "image/svg+xml":
+ // This is a text file
+ return false
+ default:
+ return strings.HasPrefix(mediaType, "image/")
+ }
}
func convertImage(orig []byte) ([]byte, error) {
diff --git a/debian/changelog b/debian/changelog
deleted file mode 100644
index f1d45d3c..00000000
--- a/debian/changelog
+++ /dev/null
@@ -1,270 +0,0 @@
-pat (0.12.1-1) stable; urgency=medium
-
- * Add support for configurable telnet dial timeout (for Iridium GO users)
- * Add support for scriptable message composition
- * Add CLI command `env` for retrieving related environment variables (for scripting)
- * More reliable Forms updates by using a new API for retrieving latest version and archive URL
- * Improve websocket handling
- * Fix bug in Forms update procedure that would delete the OS temp directory in rare cases
- * Fix bug with pactor serial communication on macOS (Darwin)
- * Fix bug with Web GUI and Message IDs containing the hash (`#`) symbol
-
- -- Martin Hebnes Pedersen