-
Notifications
You must be signed in to change notification settings - Fork 573
/
packages.go
299 lines (255 loc) · 8.74 KB
/
packages.go
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2015-2022 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package client
import (
"errors"
"fmt"
"net/url"
"strings"
"time"
"golang.org/x/xerrors"
"github.com/snapcore/snapd/snap"
)
// Snap holds the data for a snap as obtained from snapd.
type Snap struct {
ID string `json:"id"`
Title string `json:"title,omitempty"`
Summary string `json:"summary"`
Description string `json:"description"`
DownloadSize int64 `json:"download-size,omitempty"`
Icon string `json:"icon,omitempty"`
InstalledSize int64 `json:"installed-size,omitempty"`
InstallDate *time.Time `json:"install-date,omitempty"`
Name string `json:"name"`
Publisher *snap.StoreAccount `json:"publisher,omitempty"`
StoreURL string `json:"store-url,omitempty"`
// Developer is also the publisher's username for historic reasons.
Developer string `json:"developer"`
Status string `json:"status"`
Type string `json:"type"`
Base string `json:"base,omitempty"`
Version string `json:"version"`
Channel string `json:"channel"`
TrackingChannel string `json:"tracking-channel,omitempty"`
IgnoreValidation bool `json:"ignore-validation"`
Revision snap.Revision `json:"revision"`
Confinement string `json:"confinement"`
Private bool `json:"private"`
DevMode bool `json:"devmode"`
JailMode bool `json:"jailmode"`
TryMode bool `json:"trymode,omitempty"`
Apps []AppInfo `json:"apps,omitempty"`
Broken string `json:"broken,omitempty"`
License string `json:"license,omitempty"`
CommonIDs []string `json:"common-ids,omitempty"`
MountedFrom string `json:"mounted-from,omitempty"`
CohortKey string `json:"cohort-key,omitempty"`
Links map[string][]string `json:"links,omitempy"`
// legacy fields before we had links
Contact string `json:"contact"`
Website string `json:"website,omitempty"`
Prices map[string]float64 `json:"prices,omitempty"`
Screenshots []snap.ScreenshotInfo `json:"screenshots,omitempty"`
Media snap.MediaInfos `json:"media,omitempty"`
Categories []snap.CategoryInfo `json:"categories,omitempty"`
// The flattended channel map with $track/$risk
Channels map[string]*snap.ChannelSnapInfo `json:"channels,omitempty"`
// The ordered list of tracks that contains channels
Tracks []string `json:"tracks,omitempty"`
Health *SnapHealth `json:"health,omitempty"`
// Hold is the time until which the snap's refreshes are held by the user.
Hold *time.Time `json:"hold,omitempty"`
// GatingHold is the time until which the snap's refreshes are held by a snap.
GatingHold *time.Time `json:"gating-hold,omitempty"`
// if RefreshInhibit is nil, then there is no pending refresh.
RefreshInhibit *SnapRefreshInhibit `json:"refresh-inhibit,omitempty"`
// Components is a list of the snap components
Components []Component `json:"components,omitempty"`
}
type SnapHealth struct {
Revision snap.Revision `json:"revision"`
Timestamp time.Time `json:"timestamp"`
Status string `json:"status"`
Message string `json:"message,omitempty"`
Code string `json:"code,omitempty"`
}
type SnapRefreshInhibit struct {
// ProceedTime is the time after which a pending refresh is forced for a
// running snap in the next auto-refresh.
//
// NOTE: ProceedTime may be in the past, if a refresh is still pending and
// the snap applications are being monitored.
ProceedTime time.Time `json:"proceed-time"`
}
// Statuses and types a snap may have.
const (
StatusAvailable = "available"
StatusInstalled = "installed"
StatusActive = "active"
StatusRemoved = "removed"
StatusPriced = "priced"
TypeApp = "app"
TypeKernel = "kernel"
TypeGadget = "gadget"
TypeOS = "os"
StrictConfinement = "strict"
DevModeConfinement = "devmode"
ClassicConfinement = "classic"
)
type ResultInfo struct {
SuggestedCurrency string `json:"suggested-currency"`
}
// FindOptions supports exactly one of the following options:
// - Refresh: only return snaps that are refreshable
// - Private: return snaps that are private
// - Query: only return snaps that match the query string
type FindOptions struct {
// Query is a term to search by or a prefix (if Prefix is true)
Query string
Prefix bool
CommonID string
Category string
// Section is deprecated, use Category instead.
Section string
Private bool
Scope string
Refresh bool
}
var ErrNoSnapsInstalled = errors.New("no snaps installed")
type ListOptions struct {
All bool
}
// Information about a category
type Category struct {
Name string `json:"name"`
}
// List returns the list of all snaps installed on the system
// with names in the given list; if the list is empty, all snaps.
func (client *Client) List(names []string, opts *ListOptions) ([]*Snap, error) {
if opts == nil {
opts = &ListOptions{}
}
q := make(url.Values)
if opts.All {
q.Add("select", "all")
}
if len(names) > 0 {
q.Add("snaps", strings.Join(names, ","))
}
snaps, _, err := client.snapsFromPath("/v2/snaps", q)
if err != nil {
return nil, err
}
if len(snaps) == 0 {
return nil, ErrNoSnapsInstalled
}
return snaps, nil
}
// Sections returns the list of existing snap sections in the store
// This is deprecated, use Categories() instead.
func (client *Client) Sections() ([]string, error) {
var sections []string
_, err := client.doSync("GET", "/v2/sections", nil, nil, nil, §ions)
if err != nil {
fmt := "cannot get snap sections: %w"
return nil, xerrors.Errorf(fmt, err)
}
return sections, nil
}
// Categories returns the list of existing snap categories in the store
func (client *Client) Categories() ([]*Category, error) {
var categories []*Category
_, err := client.doSync("GET", "/v2/categories", nil, nil, nil, &categories)
if err != nil {
return nil, fmt.Errorf("cannot get snap categories: %w", err)
}
return categories, nil
}
// Find returns a list of snaps available for install from the
// store for this system and that match the query
func (client *Client) Find(opts *FindOptions) ([]*Snap, *ResultInfo, error) {
if opts == nil {
opts = &FindOptions{}
}
q := url.Values{}
if opts.Prefix {
q.Set("name", opts.Query+"*")
} else {
if opts.CommonID != "" {
q.Set("common-id", opts.CommonID)
}
if opts.Query != "" {
q.Set("q", opts.Query)
}
}
switch {
case opts.Refresh && opts.Private:
return nil, nil, fmt.Errorf("cannot specify refresh and private together")
case opts.Refresh:
q.Set("select", "refresh")
case opts.Private:
q.Set("select", "private")
}
if opts.Category != "" {
q.Set("category", opts.Category)
}
if opts.Section != "" {
q.Set("section", opts.Section)
}
if opts.Scope != "" {
q.Set("scope", opts.Scope)
}
return client.snapsFromPath("/v2/find", q)
}
func (client *Client) FindOne(name string) (*Snap, *ResultInfo, error) {
q := url.Values{}
q.Set("name", name)
snaps, ri, err := client.snapsFromPath("/v2/find", q)
if err != nil {
fmt := "cannot find snap %q: %w"
return nil, nil, xerrors.Errorf(fmt, name, err)
}
if len(snaps) == 0 {
return nil, nil, fmt.Errorf("cannot find snap %q", name)
}
return snaps[0], ri, nil
}
func (client *Client) snapsFromPath(path string, query url.Values) ([]*Snap, *ResultInfo, error) {
var snaps []*Snap
ri, err := client.doSync("GET", path, query, nil, nil, &snaps)
if e, ok := err.(*Error); ok {
return nil, nil, e
}
if err != nil {
fmt := "cannot list snaps: %w"
return nil, nil, xerrors.Errorf(fmt, err)
}
return snaps, ri, nil
}
// Snap returns the most recently published revision of the snap with the
// provided name.
func (client *Client) Snap(name string) (*Snap, *ResultInfo, error) {
var snap *Snap
path := fmt.Sprintf("/v2/snaps/%s", name)
ri, err := client.doSync("GET", path, nil, nil, nil, &snap)
if err != nil {
fmt := "cannot retrieve snap %q: %w"
return nil, nil, xerrors.Errorf(fmt, name, err)
}
return snap, ri, nil
}