File: patch6_2.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 (174 lines) | stat: -rw-r--r-- 6,105 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
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
// -*- 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 patch

import (
	"encoding/json"
	"errors"
	"fmt"
	"time"

	"github.com/snapcore/snapd/overlord/state"
	"github.com/snapcore/snapd/snap"
)

type patch62SideInfo struct {
	RealName          string        `yaml:"name,omitempty" json:"name,omitempty"`
	SnapID            string        `yaml:"snap-id" json:"snap-id"`
	Revision          snap.Revision `yaml:"revision" json:"revision"`
	Channel           string        `yaml:"channel,omitempty" json:"channel,omitempty"`
	Contact           string        `yaml:"contact,omitempty" json:"contact,omitempty"`
	EditedTitle       string        `yaml:"title,omitempty" json:"title,omitempty"`
	EditedSummary     string        `yaml:"summary,omitempty" json:"summary,omitempty"`
	EditedDescription string        `yaml:"description,omitempty" json:"description,omitempty"`
	Private           bool          `yaml:"private,omitempty" json:"private,omitempty"`
	Paid              bool          `yaml:"paid,omitempty" json:"paid,omitempty"`
}

type patch62Flags struct {
	DevMode          bool `json:"devmode,omitempty"`
	JailMode         bool `json:"jailmode,omitempty"`
	Classic          bool `json:"classic,omitempty"`
	TryMode          bool `json:"trymode,omitempty"`
	Revert           bool `json:"revert,omitempty"`
	RemoveSnapPath   bool `json:"remove-snap-path,omitempty"`
	IgnoreValidation bool `json:"ignore-validation,omitempty"`
	Required         bool `json:"required,omitempty"`
	SkipConfigure    bool `json:"skip-configure,omitempty"`
	Unaliased        bool `json:"unaliased,omitempty"`
	Amend            bool `json:"amend,omitempty"`
	IsAutoRefresh    bool `json:"is-auto-refresh,omitempty"`
	NoReRefresh      bool `json:"no-rerefresh,omitempty"`
	RequireTypeBase  bool `json:"require-base-type,omitempty"`
}

type patch62SnapState struct {
	SnapType string             `json:"type"`
	Sequence []*patch62SideInfo `json:"sequence"`
	Active   bool               `json:"active,omitempty"`
	Current  snap.Revision      `json:"current"`
	Channel  string             `json:"channel,omitempty"`
	patch62Flags
	Aliases              any        `json:"aliases,omitempty"`
	AutoAliasesDisabled  bool       `json:"auto-aliases-disabled,omitempty"`
	AliasesPending       bool       `json:"aliases-pending,omitempty"`
	UserID               int        `json:"user-id,omitempty"`
	InstanceKey          string     `json:"instance-key,omitempty"`
	CohortKey            string     `json:"cohort-key,omitempty"`
	RefreshInhibitedTime *time.Time `json:"refresh-inhibited-time,omitempty"`
}

type patch62SnapSetup struct {
	Channel   string    `json:"channel,omitempty"`
	UserID    int       `json:"user-id,omitempty"`
	Base      string    `json:"base,omitempty"`
	Type      snap.Type `json:"type,omitempty"`
	PlugsOnly bool      `json:"plugs-only,omitempty"`
	CohortKey string    `json:"cohort-key,omitempty"`
	Prereq    []string  `json:"prereq,omitempty"`
	patch62Flags
	SnapPath     string           `json:"snap-path,omitempty"`
	DownloadInfo any              `json:"download-info,omitempty"`
	SideInfo     *patch62SideInfo `json:"side-info,omitempty"`
	patch62auxStoreInfo
	InstanceKey string `json:"instance-key,omitempty"`
}

type patch62auxStoreInfo struct {
	Media any `json:"media,omitempty"`
}

func hasSnapdSnapID(snapst patch62SnapState) bool {
	for _, seq := range snapst.Sequence {
		if snap.IsSnapd(seq.SnapID) {
			return true
		}
	}
	return false
}

// patch6_2:
//   - ensure snapd snaps in the snapstate have TypeSnapd for backward compatibility with old snapd snap releases.
//   - ensure snapd snaps have TypeSnapd in pending install tasks.
func patch6_2(st *state.State) error {
	var snaps map[string]*json.RawMessage
	if err := st.Get("snaps", &snaps); err != nil && !errors.Is(err, state.ErrNoState) {
		return fmt.Errorf("internal error: cannot get snaps: %s", err)
	}

	var hasSnapdSnap bool
	// check if we have snapd snap with TypeSnapd already in state, in such case
	// we shouldn't try to migrate any other snaps because we can have at most
	// one snapd snap.
	for _, raw := range snaps {
		var snapst patch62SnapState
		if err := json.Unmarshal([]byte(*raw), &snapst); err != nil {
			return err
		}
		if hasSnapdSnapID(snapst) && snapst.SnapType == string(snap.TypeSnapd) {
			hasSnapdSnap = true
			break
		}
	}

	// Migrate snapstate unless we have a snapd snap with TypeSnapd already set.
	if !hasSnapdSnap {
		for name, raw := range snaps {
			var snapst patch62SnapState
			if err := json.Unmarshal([]byte(*raw), &snapst); err != nil {
				return err
			}
			if hasSnapdSnapID(snapst) {
				snapst.SnapType = string(snap.TypeSnapd)
				data, err := json.Marshal(snapst)
				if err != nil {
					return err
				}
				newRaw := json.RawMessage(data)
				snaps[name] = &newRaw
				st.Set("snaps", snaps)
				// We can have at most one snapd snap
				break
			}
		}
	}

	// migrate tasks' snap setup
	for _, task := range st.Tasks() {
		chg := task.Change()
		if chg != nil && chg.Status().Ready() {
			continue
		}

		var snapsup patch62SnapSetup
		err := task.Get("snap-setup", &snapsup)
		if err != nil && !errors.Is(err, state.ErrNoState) {
			return fmt.Errorf("internal error: cannot get snap-setup of task %s: %s", task.ID(), err)
		}

		if err == nil && snapsup.SideInfo != nil {
			if snapsup.Type != snap.TypeSnapd && snap.IsSnapd(snapsup.SideInfo.SnapID) {
				snapsup.Type = snap.TypeSnapd
				task.Set("snap-setup", snapsup)
			}
		}
	}
	return nil
}