File: warnings.go

package info (click to toggle)
snapd 2.71-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,536 kB
  • sloc: ansic: 16,114; sh: 16,105; python: 9,941; makefile: 1,890; exp: 190; awk: 40; xml: 22
file content (89 lines) | stat: -rw-r--r-- 2,717 bytes parent folder | download
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2018 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 (
	"bytes"
	"encoding/json"
	"net/url"
	"time"
)

// A Warning is a short messages that's meant to alert about system events.
// There'll only ever be one Warning with the same message, and it can be
// silenced for a while before repeating. After a (supposedly longer) while
// it'll go away on its own (unless it recurrs).
type Warning struct {
	Message     string        `json:"message"`
	FirstAdded  time.Time     `json:"first-added"`
	LastAdded   time.Time     `json:"last-added"`
	LastShown   time.Time     `json:"last-shown,omitzero"`
	ExpireAfter time.Duration `json:"expire-after,omitempty"`
	RepeatAfter time.Duration `json:"repeat-after,omitempty"`
}

type jsonWarning struct {
	Warning
	ExpireAfter string `json:"expire-after,omitempty"`
	RepeatAfter string `json:"repeat-after,omitempty"`
}

// WarningsOptions contains options for querying snapd for warnings
// supported options:
// - All: return all warnings, instead of only the un-okayed ones.
type WarningsOptions struct {
	All bool
}

// Warnings returns the list of un-okayed warnings.
func (client *Client) Warnings(opts WarningsOptions) ([]*Warning, error) {
	var jws []*jsonWarning
	q := make(url.Values)
	if opts.All {
		q.Add("select", "all")
	}
	_, err := client.doSync("GET", "/v2/warnings", q, nil, nil, &jws)

	ws := make([]*Warning, len(jws))
	for i, jw := range jws {
		ws[i] = &jw.Warning
		ws[i].ExpireAfter, _ = time.ParseDuration(jw.ExpireAfter)
		ws[i].RepeatAfter, _ = time.ParseDuration(jw.RepeatAfter)
	}

	return ws, err
}

type warningsAction struct {
	Action    string    `json:"action"`
	Timestamp time.Time `json:"timestamp"`
}

// Okay asks snapd to chill about the warnings that would have been returned by
// Warnings at the given time.
func (client *Client) Okay(t time.Time) error {
	var body bytes.Buffer
	var op = warningsAction{Action: "okay", Timestamp: t}
	if err := json.NewEncoder(&body).Encode(op); err != nil {
		return err
	}
	_, err := client.doSync("POST", "/v2/warnings", nil, nil, &body, nil)
	return err
}