-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpackage.go
More file actions
313 lines (272 loc) · 6.98 KB
/
package.go
File metadata and controls
313 lines (272 loc) · 6.98 KB
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
package anki
import (
"archive/zip"
"crypto/sha1"
"errors"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"github.com/lftk/anki/pb"
"google.golang.org/protobuf/proto"
)
// Pack packs a collection into a zip file.
func Pack(w *zip.Writer, dir string) error {
meta := &pb.PackageMetadata{
Version: pb.PackageMetadata_VERSION_LATEST,
}
if err := writeMetadata(w, meta); err != nil {
return err
}
if err := writeDatabase(w, databasePath(dir)); err != nil {
return err
}
return writeMediaEntries(w, mediaDir(dir))
}
// Unpack unpacks a collection from a zip file.
func Unpack(r *zip.Reader, dir string) error {
meta, err := detectMetadata(r)
if err != nil {
return err
}
if err = restoreDatabase(r, meta, databasePath(dir)); err != nil {
return err
}
return restoreMediaEntries(r, meta, mediaDir(dir))
}
// isLegacyVersion checks if the package metadata is for a legacy version.
func isLegacyVersion(meta *pb.PackageMetadata) bool {
return meta.Version == pb.PackageMetadata_VERSION_LEGACY_1 ||
meta.Version == pb.PackageMetadata_VERSION_LEGACY_2
}
// zstdCompressed checks if the package is zstd compressed.
func zstdCompressed(meta *pb.PackageMetadata) bool {
return !isLegacyVersion(meta)
}
// databaseName returns the database name based on the package metadata.
func databaseName(meta *pb.PackageMetadata) string {
switch meta.Version {
case pb.PackageMetadata_VERSION_LEGACY_1:
return "collection.anki2"
case pb.PackageMetadata_VERSION_LEGACY_2:
return "collection.anki21"
default: // PackageMetadata_VERSION_LATEST
return "collection.anki21b"
}
}
// databasePath returns the path to the database file.
func databasePath(dir string) string {
return filepath.Join(dir, "collection.db")
}
// mediaDir returns the path to the media directory.
func mediaDir(dir string) string {
return filepath.Join(dir, "media")
}
// restoreFile restores a file from a zip archive.
func restoreFile(r *zip.Reader, meta *pb.PackageMetadata, name string, path string) error {
src, err := zipOpen(r, name, zstdCompressed(meta))
if err != nil {
return err
}
defer src.Close() //nolint:errcheck
dst, err := os.Create(path)
if err != nil {
return err
}
defer dst.Close() //nolint:errcheck
_, err = io.Copy(dst, src)
return err
}
// restoreDatabase restores the database from a zip archive.
func restoreDatabase(r *zip.Reader, meta *pb.PackageMetadata, path string) error {
return restoreFile(r, meta, databaseName(meta), path)
}
// writeDatabase writes the database to a zip archive.
func writeDatabase(w *zip.Writer, path string) error {
src, err := os.Open(path)
if err != nil {
return err
}
defer src.Close() //nolint:errcheck
dst, err := zipCreate(w, "collection.anki21b", true)
if err != nil {
return err
}
defer dst.Close() //nolint:errcheck
_, err = io.Copy(dst, src)
return err
}
// restoreMediaEntries restores media entries from a zip archive.
func restoreMediaEntries(r *zip.Reader, meta *pb.PackageMetadata, dir string) error {
if err := os.Mkdir(dir, 0755); err != nil {
return err
}
media, err := readMediaEntries(r)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
err = nil
}
return err
}
for i, entry := range media.Entries {
err = restoreFile(r, meta, fmt.Sprint(i), filepath.Join(dir, entry.Name))
if err != nil {
return err
}
}
return nil
}
// readMediaEntries reads media entries from a zip archive.
func readMediaEntries(r *zip.Reader) (*pb.MediaEntries, error) {
b, err := zipReadAll(r, "media", true)
if err != nil {
return nil, err
}
var media pb.MediaEntries
if err := proto.Unmarshal(b, &media); err != nil {
return nil, err
}
return &media, nil
}
// writeMediaEntries writes media entries to a zip archive.
func writeMediaEntries(w *zip.Writer, dir string) error {
var media pb.MediaEntries
fn := func(path string, d fs.DirEntry, err error) error {
if err != nil || d.IsDir() {
return err
}
sha1, err := writeMediaEntry(w, path, fmt.Sprint(len(media.Entries)))
if err != nil {
return err
}
rel, err := filepath.Rel(dir, path)
if err != nil {
return err
}
fi, err := d.Info()
if err != nil {
return err
}
media.Entries = append(media.Entries,
&pb.MediaEntries_MediaEntry{
Name: rel,
Size: uint32(fi.Size()),
Sha1: sha1,
},
)
return nil
}
if err := filepath.WalkDir(dir, fn); err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return err
}
}
b, err := proto.Marshal(&media)
if err != nil {
return err
}
return zipWrite(w, "media", true, b)
}
// writeMediaEntry writes a single media entry to a zip archive.
func writeMediaEntry(w *zip.Writer, path, name string) ([]byte, error) {
src, err := os.Open(path)
if err != nil {
return nil, err
}
defer src.Close() //nolint:errcheck
dst, err := zipCreate(w, name, true)
if err != nil {
return nil, err
}
defer dst.Close() //nolint:errcheck
h := sha1.New()
_, err = io.Copy(io.MultiWriter(h, dst), src)
if err != nil {
return nil, err
}
return h.Sum(nil), nil
}
// detectMetadata detects the package metadata from a zip archive.
func detectMetadata(r *zip.Reader) (*pb.PackageMetadata, error) {
meta, err := readMetadata(r)
if err == nil {
return meta, nil
}
if !errors.Is(err, fs.ErrNotExist) {
return nil, err
}
ver := pb.PackageMetadata_VERSION_LEGACY_1
if _, ok := zipLookup(r, "collection.anki21"); ok {
ver = pb.PackageMetadata_VERSION_LEGACY_2
}
return &pb.PackageMetadata{Version: ver}, nil
}
// readMetadata reads the package metadata from a zip archive.
func readMetadata(r *zip.Reader) (*pb.PackageMetadata, error) {
b, err := zipReadAll(r, "meta", false)
if err != nil {
return nil, err
}
var meta pb.PackageMetadata
if err := proto.Unmarshal(b, &meta); err != nil {
return nil, err
}
return &meta, nil
}
// writeMetadata writes the package metadata to a zip archive.
func writeMetadata(w *zip.Writer, meta *pb.PackageMetadata) error {
b, err := proto.Marshal(meta)
if err != nil {
return err
}
return zipWrite(w, "meta", false, b)
}
// backup creates a backup of a collection.
func backup(src, dst string) error {
if err := os.Mkdir(dst, 0755); err != nil {
if !errors.Is(err, fs.ErrExist) {
return err
}
}
if err := copyFile(databasePath(src), databasePath(dst)); err != nil {
return err
}
return copyDir(mediaDir(src), mediaDir(dst))
}
// copyDir copies a directory.
func copyDir(src, dst string) error {
return filepath.WalkDir(src, func(path string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
rel, err := filepath.Rel(src, path)
if err != nil {
return err
}
dstPath := filepath.Join(dst, rel)
if d.IsDir() {
err = os.MkdirAll(dstPath, 0755)
if errors.Is(err, os.ErrExist) {
err = nil
}
return err
}
return copyFile(path, dstPath)
})
}
// copyFile copies a file.
func copyFile(src, dst string) error {
r, err := os.Open(src)
if err != nil {
return err
}
defer r.Close() //nolint:errcheck
w, err := os.Create(dst)
if err != nil {
return err
}
defer w.Close() //nolint:errcheck
_, err = io.Copy(w, r)
return err
}