1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
package service
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"strings"
"time"
"github.com/armanlife/firefox-vpn-client/core/internal/config"
"github.com/armanlife/firefox-vpn-client/core/internal/proxy"
"github.com/armanlife/firefox-vpn-client/core/internal/serverlist"
)
// Client calls a running service's dashboard API with the local token
// from the data folder. The tray uses it whether the service runs in its own
// process or in another one.
type Client struct {
paths DataPaths
http *http.Client
}
func NewClient(paths DataPaths) *Client {
return &Client{paths: paths, http: &http.Client{
Timeout: 60 * time.Second,
Transport: &http.Transport{Proxy: nil, DisableKeepAlives: true},
}}
}
// TrayStatus is the part of GET /api/status the tray shows.
type TrayStatus struct {
State struct {
Phase string `json:"phase"`
Message string `json:"message"`
Code string `json:"code"`
} `json:"state"`
Proxy *TrayProxy `json:"proxy"`
ActiveAccount *AccountView `json:"active_account"`
Accounts map[string]int `json:"accounts"`
Version string `json:"version"`
// Exit is where the public IP check found the traffic leaving, which
// names the place even for the recommended (anycast) location.
Exit *struct {
CountryCode string `json:"country_code"`
CountryName string `json:"country_name"`
City string `json:"city"`
} `json:"exit"`
// SystemProxy is the system_proxy.mode setting.
SystemProxy string `json:"system_proxy"`
// SystemProxyByHost: the process serving the folder applies the mode
// itself.
SystemProxyByHost bool `json:"system_proxy_by_host"`
// SystemProxyRetake rises when the user asks to set the system proxy
// again after another program replaced it.
SystemProxyRetake uint64 `json:"system_proxy_retake"`
// AutoConnecting: the system proxy waits for auto-connect's test.
AutoConnecting bool `json:"auto_connecting"`
// OpenFolderRequest rises when the dashboard asks to open the data
// folder.
OpenFolderRequest uint64 `json:"open_folder_request"`
}
// SetSystemProxy sets the system_proxy.mode setting.
func (c *Client) SetSystemProxy(ctx context.Context, mode string) error {
return c.Do(ctx, http.MethodPost, "/api/system-proxy", map[string]string{"mode": mode}, nil)
}
// DashboardURL returns the loopback URL of the dashboard configured in the
// data folder.
func (c *Client) DashboardURL() (string, error) {
cfg, _, err := config.Load(c.paths.Config)
if err != nil {
return "", err
}
if !cfg.Dashboard.Enabled {
return "", errors.New("the dashboard is disabled in config.json")
}
return "http://" + loopbackAddr(cfg.Dashboard.Listen), nil
}
// DashboardPageURL returns the address of the dashboard page, for a
// browser on this machine.
func (c *Client) DashboardPageURL() (string, error) {
base, err := c.DashboardURL()
if err != nil {
return "", err
}
return base + appPath, nil
}
// loopbackAddr turns a listen address into one this machine can dial.
func loopbackAddr(listen string) string {
host, port, err := net.SplitHostPort(listen)
if err != nil {
return listen
}
ip := net.ParseIP(host)
switch {
case host == "" || (ip != nil && ip.IsUnspecified()):
host = "127.0.0.1"
case ip == nil && !strings.EqualFold(host, "localhost"):
host = "127.0.0.1"
}
return net.JoinHostPort(host, port)
}
// Do calls the API; body is sent as JSON ("{}" when nil) for every method
// but GET, and the response is decoded into out when it is not nil.
func (c *Client) Do(ctx context.Context, method, path string, body, out any) error {
base, err := c.DashboardURL()
if err != nil {
return err
}
token, err := readLocalToken(c.paths.LocalToken)
if err != nil {
return fmt.Errorf("the service is not running (no local API token): %w", err)
}
var reader io.Reader
if method != http.MethodGet {
payload := []byte("{}")
if body != nil {
if payload, err = json.Marshal(body); err != nil {
return err
}
}
reader = bytes.NewReader(payload)
}
req, err := http.NewRequestWithContext(ctx, method, base+path, reader)
if err != nil {
return err
}
req.Header.Set(localTokenHeader, token)
if reader != nil {
req.Header.Set("Content-Type", "application/json")
}
resp, err := c.http.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
data, err := io.ReadAll(io.LimitReader(resp.Body, 1<<20))
if err != nil {
return err
}
if resp.StatusCode/100 != 2 {
var apiErr struct {
Error string `json:"error"`
}
if json.Unmarshal(data, &apiErr) == nil && apiErr.Error != "" {
return fmt.Errorf("%s (HTTP %d)", apiErr.Error, resp.StatusCode)
}
return fmt.Errorf("HTTP %d", resp.StatusCode)
}
if out == nil {
return nil
}
return json.Unmarshal(data, out)
}
func (c *Client) Status(ctx context.Context) (TrayStatus, error) {
var st TrayStatus
err := c.Do(ctx, http.MethodGet, "/api/status", nil, &st)
return st, err
}
func (c *Client) ConnectionTest(ctx context.Context) (proxy.ConnectionTestResult, error) {
var result proxy.ConnectionTestResult
err := c.Do(ctx, http.MethodPost, "/api/test", nil, &result)
return result, err
}
// ExitApp asks the process hosting the service (the tray) to stop.
func (c *Client) ExitApp(ctx context.Context) error {
return c.Do(ctx, http.MethodPost, "/api/app/exit", nil, nil)
}
func (c *Client) RestartProxy(ctx context.Context) error {
return c.Do(ctx, http.MethodPost, "/api/proxy/restart", nil, nil)
}
// TrayProxy is the running proxy in TrayStatus.
type TrayProxy struct {
Listen string `json:"listen"`
CountryCode string `json:"country_code"`
CountryName string `json:"country_name"`
CityName string `json:"city_name"`
// SleepingSince is set while the proxy sleeps (proxy.idle_sleep).
SleepingSince time.Time `json:"sleeping_since"`
}
// Summary is the tray icon's hover text: the connection state with, when
// connected, the country, and while waiting or failing, a short reason.
func (st TrayStatus) Summary() string {
switch st.State.Phase {
case PhaseRunning:
status := "Connected"
if st.Proxy != nil && !st.Proxy.SleepingSince.IsZero() {
status = "Sleeping (wakes on the next connection)"
}
if place := st.place(); place != "" {
status += " · " + place
}
return status
case PhaseStarting:
return "Starting…"
case PhaseOff:
return "Proxy off"
case PhaseWaiting:
if st.State.Code == CodeWaitingForNetwork {
return MessageWaitingForNetwork
}
return withReason("Waiting", st.reason())
case PhaseError:
return withReason("Error", st.reason())
}
return "Unknown state"
}
// summaryReasonRunes caps the reason in Summary; the full message is on
// the dashboard and the status screen.
const summaryReasonRunes = 60
// reason is the state's message in a few words: a fixed text for the
// known codes, else the message's first sentence, shortened.
func (st TrayStatus) reason() string {
switch st.State.Code {
case CodeNoAccounts:
return "Add an account"
case CodeNoUsableAccount:
return "No usable account"
case CodeProxyPortInUse:
return "The proxy's port is in use"
}
text := strings.TrimSpace(st.State.Message)
if i := strings.Index(text, ". "); i > 0 {
text = text[:i]
}
if r := []rune(text); len(r) > summaryReasonRunes {
text = strings.TrimSpace(string(r[:summaryReasonRunes-1])) + "…"
}
return text
}
func withReason(status, reason string) string {
if reason == "" {
return status
}
return status + ": " + reason
}
// place is where the traffic leaves: the city and country of the public
// IP when known, else the selected location unless it is Mozilla's
// recommended one, which names no place ("Recommended location").
func (st TrayStatus) place() string {
if e := st.Exit; e != nil {
country := e.CountryName
if country == "" {
country = e.CountryCode
}
switch {
case e.City != "" && country != "":
return e.City + ", " + country
case country != "":
return country
}
}
if st.Proxy != nil && !strings.EqualFold(st.Proxy.CountryCode, serverlist.RecommendedCountryCode) {
return st.Proxy.CountryName
}
return ""
}