-
-
Notifications
You must be signed in to change notification settings - Fork 176
/
export.go
474 lines (400 loc) · 11.2 KB
/
export.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
// Copyright © Martin Tournoij – This file is part of GoatCounter and published
// under the terms of a slightly modified EUPL v1.2 license, which can be found
// in the LICENSE file or at https://license.goatcounter.com
package goatcounter
import (
"compress/gzip"
"context"
"encoding/csv"
"fmt"
"io"
"os"
"reflect"
"strings"
"time"
"zgo.at/blackmail"
"zgo.at/errors"
"zgo.at/zdb"
"zgo.at/zlog"
"zgo.at/zstd/zbool"
"zgo.at/zstd/zcrypto"
"zgo.at/zstd/zint"
"zgo.at/zstd/ztime"
)
const ExportVersion = "2"
type Export struct {
ID int64 `db:"export_id" json:"id,readonly"`
SiteID int64 `db:"site_id" json:"site_id,readonly"`
// The hit ID this export was started from.
StartFromHitID int64 `db:"start_from_hit_id" json:"start_from_hit_id"`
// Last hit ID that was exported; can be used as start_from_hit_id.
LastHitID *int64 `db:"last_hit_id" json:"last_hit_id,readonly"`
Path string `db:"path" json:"path,readonly"` // {omitdoc}
CreatedAt time.Time `db:"created_at" json:"created_at,readonly"`
FinishedAt *time.Time `db:"finished_at" json:"finished_at,readonly"`
NumRows *int `db:"num_rows" json:"num_rows,readonly"`
// File size in MB.
Size *string `db:"size" json:"size,readonly"`
// SHA256 hash.
Hash *string `db:"hash" json:"hash,readonly"`
// Any errors that may have occured.
Error *string `db:"error" json:"error,readonly"`
}
func (e *Export) ByID(ctx context.Context, id int64) error {
return errors.Wrapf(zdb.Get(ctx, e,
`/* Export.ByID */ select * from exports where export_id=$1 and site_id=$2`,
id, MustGetSite(ctx).ID), "Export.ByID %d", id)
}
// Create a new export.
//
// Inserts a row in exports table and returns open file pointer to the
// destination file.
func (e *Export) Create(ctx context.Context, startFrom int64) (*os.File, error) {
site := MustGetSite(ctx)
e.SiteID = site.ID
e.CreatedAt = ztime.Now()
e.StartFromHitID = startFrom
e.Path = fmt.Sprintf("%s%sgoatcounter-export-%s-%s-%d.csv.gz",
os.TempDir(), string(os.PathSeparator), site.Code,
e.CreatedAt.Format("20060102T150405Z"), startFrom)
var err error
e.ID, err = zdb.InsertID(ctx, "export_id",
`insert into exports (site_id, path, created_at, start_from_hit_id) values (?, ?, ?, ?)`,
e.SiteID, e.Path, e.CreatedAt, e.StartFromHitID)
if err != nil {
return nil, errors.Wrap(err, "Export.Create")
}
fp, err := os.Create(e.Path)
return fp, errors.Wrap(err, "Export.Create")
}
// Export all data to a CSV file.
func (e *Export) Run(ctx context.Context, fp *os.File, mailUser bool) {
l := zlog.Module("export").Field("id", e.ID)
l.Print("export started")
gzfp := gzip.NewWriter(fp)
defer fp.Close() // No need to error-check; just for safety.
defer gzfp.Close()
c := csv.NewWriter(gzfp)
c.Write([]string{ExportVersion + "Path", "Title", "Event", "UserAgent",
"Browser", "System", "Session", "Bot", "Referrer", "Referrer scheme",
"Screen size", "Location", "FirstVisit", "Date"})
var exportErr error
e.LastHitID = &e.StartFromHitID
var z int
e.NumRows = &z
for {
var (
hits ExportRows
last int64
)
last, exportErr = hits.Export(ctx, 5000, *e.LastHitID)
e.LastHitID = &last
if len(hits) == 0 {
break
}
if exportErr != nil {
break
}
*e.NumRows += len(hits)
for _, hit := range hits {
c.Write([]string{hit.Path, hit.Title, hit.Event, hit.UserAgent,
hit.Browser, hit.System, hit.Session.String(), hit.Bot, hit.Ref,
hit.RefScheme, hit.Size, hit.Location, hit.FirstVisit,
hit.CreatedAt})
}
c.Flush()
exportErr = c.Error()
if exportErr != nil {
break
}
// Small amount of breathing space.
if !Config(ctx).Dev {
time.Sleep(500 * time.Millisecond)
}
}
if exportErr != nil {
l.Field("export", e).Error(exportErr)
err := zdb.Exec(ctx,
`update exports set error=$1 where export_id=$2`,
exportErr.Error(), e.ID)
if err != nil {
zlog.Error(err)
}
_ = gzfp.Close()
_ = fp.Close()
_ = os.Remove(fp.Name())
return
}
err := gzfp.Close()
if err != nil {
l.Error(err)
return
}
err = fp.Sync() // Ensure stat is correct.
if err != nil {
l.Error(err)
return
}
stat, err := fp.Stat()
size := "0"
if err == nil {
size = fmt.Sprintf("%.1f", float64(stat.Size())/1024/1024)
if size == "0.0" {
size = "0.1"
}
}
e.Size = &size
err = fp.Close()
if err != nil {
l.Error(err)
return
}
hash, err := zcrypto.HashFile(e.Path)
e.Hash = &hash
if err != nil {
l.Error(err)
return
}
now := ztime.Now()
err = zdb.Exec(ctx, `update exports set
finished_at=$1, num_rows=$2, size=$3, hash=$4, last_hit_id=$5
where export_id=$6`,
&now, e.NumRows, e.Size, e.Hash, e.LastHitID, e.ID)
if err != nil {
zlog.Error(err)
}
if mailUser {
site := MustGetSite(ctx)
user := GetUser(ctx)
err = blackmail.Send("GoatCounter export ready",
blackmail.From("GoatCounter export", Config(ctx).EmailFrom),
blackmail.To(user.Email),
blackmail.BodyMustText(TplEmailExportDone{ctx, *site, *user, *e}.Render))
if err != nil {
l.Error(err)
}
}
}
func (e Export) Exists() bool {
if e.Path == "" {
return false
}
_, err := os.Stat(e.Path)
return err == nil
}
type Exports []Export
func (e *Exports) List(ctx context.Context) error {
return errors.Wrap(zdb.Select(ctx, e, `/* Exports.List */
select * from exports where site_id=$1 order by created_at desc limit 10`,
MustGetSite(ctx).ID), "Exports.List")
}
// Import data from an export.
//
// The persist() callback will be called for every hit; you usually want to
// collect a bunch of them and then persist them.
//
// After everything is done, this will be called once more with an empty hit and
// final set to true, to persist the last batch.
func Import(
ctx context.Context, fp io.Reader, replace, email bool,
persist func(Hit, bool),
) (*time.Time, error) {
site := MustGetSite(ctx)
l := zlog.Module("import").Field("site", site.ID).Field("replace", replace)
l.Print("import started")
c := csv.NewReader(fp)
header, err := c.Read()
if err != nil {
return nil, errors.Wrap(err, "goatcounter.Import")
}
if len(header) == 0 || !strings.HasPrefix(header[0], ExportVersion) {
return nil, errors.Errorf(
"goatcounter.Import: wrong version of CSV database: %s (expected: %s)",
header[0][:1], ExportVersion)
}
if replace {
err := site.DeleteAll(ctx)
if err != nil {
l.Error(err)
return nil, errors.Wrap(err, "goatcounter.Import")
}
}
var (
sessions = make(map[zint.Uint128]zint.Uint128)
n = 0
errs = errors.NewGroup(50)
firstHitAt = site.FirstHitAt
)
for {
line, err := c.Read()
if err == io.EOF {
break
}
if errs.Append(err) {
continue
}
var row ExportRow
err = row.Read(line)
if errs.Append(err) {
continue
}
hit, err := row.Hit(ctx, site.ID)
if errs.Append(err) {
continue
}
if hit.CreatedAt.Before(firstHitAt) {
firstHitAt = hit.CreatedAt
}
// Map session IDs to new session IDs.
s, ok := sessions[row.Session]
if !ok {
sessions[row.Session] = Memstore.SessionID()
s = sessions[row.Session]
}
hit.Session = s
persist(hit, false)
n++
}
persist(Hit{}, true)
l.Printf("imported %d rows", n)
if errs.Len() > 0 {
l.Error(errs)
}
if email {
// Send email after 10s delay to make sure the cron task has finished
// updating all the rows.
time.Sleep(10 * time.Second)
err = blackmail.Send("GoatCounter import ready",
blackmail.From("GoatCounter import", Config(ctx).EmailFrom),
blackmail.To(GetUser(ctx).Email),
blackmail.BodyMustText(TplEmailImportDone{ctx, *site, n, errs}.Render))
if err != nil {
l.Error(err)
}
}
if firstHitAt.Equal(site.FirstHitAt) {
return nil, nil
}
return &firstHitAt, nil
}
// TODO: would be nice to have generic csv marshal/unmarshaler, so you can do:
//
// Path string `csv:"1"`
//
// Or something, or perhaps even get by header:
//
// Path string `csv:"path"`
//
// Looks like there's some existing stuff for that already:
//
// https://github.com/gocarina/gocsv
// https://github.com/jszwec/csvutil
type ExportRow struct { // Fields in order!
ID int64 `db:"hit_id"`
SiteID int64 `db:"site_id"`
Path string `db:"path"`
Title string `db:"title"`
Event string `db:"event"`
UserAgent string `db:"ua"`
Browser string `db:"browser"`
System string `db:"system"`
Session zint.Uint128 `db:"session"`
Bot string `db:"bot"`
Ref string `db:"ref"`
RefScheme string `db:"ref_s"`
Size string `db:"size"`
Location string `db:"loc"`
FirstVisit string `db:"first"`
CreatedAt string `db:"created_at"`
}
func (row *ExportRow) Read(line []string) error {
const offset = 2 // Ignore first n fields
values := reflect.ValueOf(row).Elem()
if len(line) != values.NumField()-offset {
return fmt.Errorf("wrong number of fields: %d (want: %d)", len(line), values.NumField()-offset)
}
for i := offset; i <= len(line)+1; i++ {
f := values.Field(i)
v := line[i-offset]
switch f.Kind() {
default:
case reflect.Array:
zi, _ := zint.ParseUint128(v, 16)
f.Set(reflect.ValueOf(zi))
case reflect.Ptr:
f.Set(reflect.New(f.Type().Elem()))
f.Elem().SetString(v)
case reflect.String:
f.SetString(v)
}
}
return nil
}
func (row ExportRow) Hit(ctx context.Context, siteID int64) (Hit, error) {
hit := Hit{
Site: siteID,
Path: row.Path,
Title: row.Title,
Ref: row.Ref,
UserAgentHeader: row.UserAgent,
Location: row.Location, // TODO: validate from list?
}
v := NewValidate(ctx)
v.Required("path", row.Path)
hit.Event = zbool.Bool(v.Boolean("event", row.Event))
hit.Bot = int(v.Integer("bot", row.Bot))
hit.FirstVisit = zbool.Bool(v.Boolean("firstVisit", row.FirstVisit))
hit.CreatedAt = v.Date("createdAt", row.CreatedAt, time.RFC3339)
if row.RefScheme != "" {
v.Include("refScheme", row.RefScheme,
[]string{*RefSchemeHTTP, *RefSchemeOther, *RefSchemeGenerated, *RefSchemeCampaign})
if row.RefScheme != "" {
hit.RefScheme = &row.RefScheme
}
}
if row.Size != "" {
err := hit.Size.UnmarshalText([]byte(row.Size))
return hit, err
}
return hit, v.ErrorOrNil()
}
type ExportRows []ExportRow
// Export all hits for a site, including bot requests.
func (h *ExportRows) Export(ctx context.Context, limit, paginate int64) (int64, error) {
if limit == 0 || limit > 5000 {
limit = 5000
}
err := zdb.Select(ctx, h, `
select
hits.hit_id,
hits.site_id,
paths.path,
paths.title,
paths.event,
coalesce(browsers.name || ' ' || browsers.version, '') as browser,
coalesce(systems.name || ' ' || systems.version, '') as system,
hits.session,
hits.bot,
coalesce(refs.ref, '') as ref,
coalesce(refs.ref_scheme, '') as ref_s,
coalesce(sizes.size, '') as size,
coalesce(hits.location, '') as loc,
hits.first_visit as first,
hits.created_at
from hits
join paths using (path_id)
left join refs using (ref_id)
left join sizes using (size_id)
left join browsers using (browser_id)
left join systems using (system_id)
where hits.site_id=$1 and hit_id>$2
order by hit_id asc
limit $3`,
MustGetSite(ctx).ID, paginate, limit)
last := paginate
if len(*h) > 0 {
hh := *h
last = hh[len(hh)-1].ID
}
return last, errors.Wrap(err, "Hits.List")
}