Merge branch '9783-cwl-error-invalid-dir' closes #9783
[arvados.git] / services / keepstore / s3_volume.go
1 package main
2
3 import (
4         "encoding/base64"
5         "encoding/hex"
6         "flag"
7         "fmt"
8         "io"
9         "log"
10         "net/http"
11         "os"
12         "regexp"
13         "strings"
14         "time"
15
16         "github.com/AdRoll/goamz/aws"
17         "github.com/AdRoll/goamz/s3"
18 )
19
20 var (
21         // ErrS3TrashDisabled is returned by Trash if that operation
22         // is impossible with the current config.
23         ErrS3TrashDisabled = fmt.Errorf("trash function is disabled because -trash-lifetime=0 and -s3-unsafe-delete=false")
24
25         s3AccessKeyFile string
26         s3SecretKeyFile string
27         s3RegionName    string
28         s3Endpoint      string
29         s3Replication   int
30         s3UnsafeDelete  bool
31         s3RaceWindow    time.Duration
32
33         s3ACL = s3.Private
34 )
35
36 const (
37         maxClockSkew  = 600 * time.Second
38         nearlyRFC1123 = "Mon, 2 Jan 2006 15:04:05 GMT"
39 )
40
41 type s3VolumeAdder struct {
42         *volumeSet
43 }
44
45 func (s *s3VolumeAdder) Set(bucketName string) error {
46         if bucketName == "" {
47                 return fmt.Errorf("no container name given")
48         }
49         if s3AccessKeyFile == "" || s3SecretKeyFile == "" {
50                 return fmt.Errorf("-s3-access-key-file and -s3-secret-key-file arguments must given before -s3-bucket-volume")
51         }
52         region, ok := aws.Regions[s3RegionName]
53         if s3Endpoint == "" {
54                 if !ok {
55                         return fmt.Errorf("unrecognized region %+q; try specifying -s3-endpoint instead", s3RegionName)
56                 }
57         } else {
58                 if ok {
59                         return fmt.Errorf("refusing to use AWS region name %+q with endpoint %+q; "+
60                                 "specify empty endpoint (\"-s3-endpoint=\") or use a different region name", s3RegionName, s3Endpoint)
61                 }
62                 region = aws.Region{
63                         Name:       s3RegionName,
64                         S3Endpoint: s3Endpoint,
65                 }
66         }
67         var err error
68         var auth aws.Auth
69         auth.AccessKey, err = readKeyFromFile(s3AccessKeyFile)
70         if err != nil {
71                 return err
72         }
73         auth.SecretKey, err = readKeyFromFile(s3SecretKeyFile)
74         if err != nil {
75                 return err
76         }
77         if flagSerializeIO {
78                 log.Print("Notice: -serialize is not supported by s3-bucket volumes.")
79         }
80         v := NewS3Volume(auth, region, bucketName, s3RaceWindow, flagReadonly, s3Replication)
81         if err := v.Check(); err != nil {
82                 return err
83         }
84         *s.volumeSet = append(*s.volumeSet, v)
85         return nil
86 }
87
88 func s3regions() (okList []string) {
89         for r := range aws.Regions {
90                 okList = append(okList, r)
91         }
92         return
93 }
94
95 func init() {
96         flag.Var(&s3VolumeAdder{&volumes},
97                 "s3-bucket-volume",
98                 "Use the given bucket as a storage volume. Can be given multiple times.")
99         flag.StringVar(
100                 &s3RegionName,
101                 "s3-region",
102                 "",
103                 fmt.Sprintf("AWS region used for subsequent -s3-bucket-volume arguments. Allowed values are %+q.", s3regions()))
104         flag.StringVar(
105                 &s3Endpoint,
106                 "s3-endpoint",
107                 "",
108                 "Endpoint URL used for subsequent -s3-bucket-volume arguments. If blank, use the AWS endpoint corresponding to the -s3-region argument. For Google Storage, use \"https://storage.googleapis.com\".")
109         flag.StringVar(
110                 &s3AccessKeyFile,
111                 "s3-access-key-file",
112                 "",
113                 "File containing the access key used for subsequent -s3-bucket-volume arguments.")
114         flag.StringVar(
115                 &s3SecretKeyFile,
116                 "s3-secret-key-file",
117                 "",
118                 "File containing the secret key used for subsequent -s3-bucket-volume arguments.")
119         flag.DurationVar(
120                 &s3RaceWindow,
121                 "s3-race-window",
122                 24*time.Hour,
123                 "Maximum eventual consistency latency for subsequent -s3-bucket-volume arguments.")
124         flag.IntVar(
125                 &s3Replication,
126                 "s3-replication",
127                 2,
128                 "Replication level reported to clients for subsequent -s3-bucket-volume arguments.")
129         flag.BoolVar(
130                 &s3UnsafeDelete,
131                 "s3-unsafe-delete",
132                 false,
133                 "EXPERIMENTAL. Enable deletion (garbage collection), even though there are known race conditions that can cause data loss.")
134 }
135
136 // S3Volume implements Volume using an S3 bucket.
137 type S3Volume struct {
138         *s3.Bucket
139         raceWindow    time.Duration
140         readonly      bool
141         replication   int
142         indexPageSize int
143 }
144
145 // NewS3Volume returns a new S3Volume using the given auth, region,
146 // and bucket name. The replication argument specifies the replication
147 // level to report when writing data.
148 func NewS3Volume(auth aws.Auth, region aws.Region, bucket string, raceWindow time.Duration, readonly bool, replication int) *S3Volume {
149         return &S3Volume{
150                 Bucket: &s3.Bucket{
151                         S3:   s3.New(auth, region),
152                         Name: bucket,
153                 },
154                 raceWindow:    raceWindow,
155                 readonly:      readonly,
156                 replication:   replication,
157                 indexPageSize: 1000,
158         }
159 }
160
161 // Check returns an error if the volume is inaccessible (e.g., config
162 // error).
163 func (v *S3Volume) Check() error {
164         return nil
165 }
166
167 // getReader wraps (Bucket)GetReader.
168 //
169 // In situations where (Bucket)GetReader would fail because the block
170 // disappeared in a Trash race, getReader calls fixRace to recover the
171 // data, and tries again.
172 func (v *S3Volume) getReader(loc string) (rdr io.ReadCloser, err error) {
173         rdr, err = v.Bucket.GetReader(loc)
174         err = v.translateError(err)
175         if err == nil || !os.IsNotExist(err) {
176                 return
177         }
178         _, err = v.Bucket.Head("recent/"+loc, nil)
179         err = v.translateError(err)
180         if err != nil {
181                 // If we can't read recent/X, there's no point in
182                 // trying fixRace. Give up.
183                 return
184         }
185         if !v.fixRace(loc) {
186                 err = os.ErrNotExist
187                 return
188         }
189         rdr, err = v.Bucket.GetReader(loc)
190         if err != nil {
191                 log.Printf("warning: reading %s after successful fixRace: %s", loc, err)
192                 err = v.translateError(err)
193         }
194         return
195 }
196
197 // Get a block: copy the block data into buf, and return the number of
198 // bytes copied.
199 func (v *S3Volume) Get(loc string, buf []byte) (int, error) {
200         rdr, err := v.getReader(loc)
201         if err != nil {
202                 return 0, err
203         }
204         defer rdr.Close()
205         n, err := io.ReadFull(rdr, buf)
206         switch err {
207         case nil, io.EOF, io.ErrUnexpectedEOF:
208                 return n, nil
209         default:
210                 return 0, v.translateError(err)
211         }
212 }
213
214 // Compare the given data with the stored data.
215 func (v *S3Volume) Compare(loc string, expect []byte) error {
216         rdr, err := v.getReader(loc)
217         if err != nil {
218                 return err
219         }
220         defer rdr.Close()
221         return v.translateError(compareReaderWithBuf(rdr, expect, loc[:32]))
222 }
223
224 // Put writes a block.
225 func (v *S3Volume) Put(loc string, block []byte) error {
226         if v.readonly {
227                 return MethodDisabledError
228         }
229         var opts s3.Options
230         if len(block) > 0 {
231                 md5, err := hex.DecodeString(loc)
232                 if err != nil {
233                         return err
234                 }
235                 opts.ContentMD5 = base64.StdEncoding.EncodeToString(md5)
236         }
237         err := v.Bucket.Put(loc, block, "application/octet-stream", s3ACL, opts)
238         if err != nil {
239                 return v.translateError(err)
240         }
241         err = v.Bucket.Put("recent/"+loc, nil, "application/octet-stream", s3ACL, s3.Options{})
242         return v.translateError(err)
243 }
244
245 // Touch sets the timestamp for the given locator to the current time.
246 func (v *S3Volume) Touch(loc string) error {
247         if v.readonly {
248                 return MethodDisabledError
249         }
250         _, err := v.Bucket.Head(loc, nil)
251         err = v.translateError(err)
252         if os.IsNotExist(err) && v.fixRace(loc) {
253                 // The data object got trashed in a race, but fixRace
254                 // rescued it.
255         } else if err != nil {
256                 return err
257         }
258         err = v.Bucket.Put("recent/"+loc, nil, "application/octet-stream", s3ACL, s3.Options{})
259         return v.translateError(err)
260 }
261
262 // Mtime returns the stored timestamp for the given locator.
263 func (v *S3Volume) Mtime(loc string) (time.Time, error) {
264         _, err := v.Bucket.Head(loc, nil)
265         if err != nil {
266                 return zeroTime, v.translateError(err)
267         }
268         resp, err := v.Bucket.Head("recent/"+loc, nil)
269         err = v.translateError(err)
270         if os.IsNotExist(err) {
271                 // The data object X exists, but recent/X is missing.
272                 err = v.Bucket.Put("recent/"+loc, nil, "application/octet-stream", s3ACL, s3.Options{})
273                 if err != nil {
274                         log.Printf("error: creating %q: %s", "recent/"+loc, err)
275                         return zeroTime, v.translateError(err)
276                 }
277                 log.Printf("info: created %q to migrate existing block to new storage scheme", "recent/"+loc)
278                 resp, err = v.Bucket.Head("recent/"+loc, nil)
279                 if err != nil {
280                         log.Printf("error: created %q but HEAD failed: %s", "recent/"+loc, err)
281                         return zeroTime, v.translateError(err)
282                 }
283         } else if err != nil {
284                 // HEAD recent/X failed for some other reason.
285                 return zeroTime, err
286         }
287         return v.lastModified(resp)
288 }
289
290 // IndexTo writes a complete list of locators with the given prefix
291 // for which Get() can retrieve data.
292 func (v *S3Volume) IndexTo(prefix string, writer io.Writer) error {
293         // Use a merge sort to find matching sets of X and recent/X.
294         dataL := s3Lister{
295                 Bucket:   v.Bucket,
296                 Prefix:   prefix,
297                 PageSize: v.indexPageSize,
298         }
299         recentL := s3Lister{
300                 Bucket:   v.Bucket,
301                 Prefix:   "recent/" + prefix,
302                 PageSize: v.indexPageSize,
303         }
304         for data, recent := dataL.First(), recentL.First(); data != nil; data = dataL.Next() {
305                 if data.Key >= "g" {
306                         // Conveniently, "recent/*" and "trash/*" are
307                         // lexically greater than all hex-encoded data
308                         // hashes, so stopping here avoids iterating
309                         // over all of them needlessly with dataL.
310                         break
311                 }
312                 if !v.isKeepBlock(data.Key) {
313                         continue
314                 }
315
316                 // stamp is the list entry we should use to report the
317                 // last-modified time for this data block: it will be
318                 // the recent/X entry if one exists, otherwise the
319                 // entry for the data block itself.
320                 stamp := data
321
322                 // Advance to the corresponding recent/X marker, if any
323                 for recent != nil {
324                         if cmp := strings.Compare(recent.Key[7:], data.Key); cmp < 0 {
325                                 recent = recentL.Next()
326                                 continue
327                         } else if cmp == 0 {
328                                 stamp = recent
329                                 recent = recentL.Next()
330                                 break
331                         } else {
332                                 // recent/X marker is missing: we'll
333                                 // use the timestamp on the data
334                                 // object.
335                                 break
336                         }
337                 }
338                 t, err := time.Parse(time.RFC3339, stamp.LastModified)
339                 if err != nil {
340                         return err
341                 }
342                 fmt.Fprintf(writer, "%s+%d %d\n", data.Key, data.Size, t.UnixNano())
343         }
344         return nil
345 }
346
347 // Trash a Keep block.
348 func (v *S3Volume) Trash(loc string) error {
349         if v.readonly {
350                 return MethodDisabledError
351         }
352         if t, err := v.Mtime(loc); err != nil {
353                 return err
354         } else if time.Since(t) < blobSignatureTTL {
355                 return nil
356         }
357         if trashLifetime == 0 {
358                 if !s3UnsafeDelete {
359                         return ErrS3TrashDisabled
360                 }
361                 return v.Bucket.Del(loc)
362         }
363         err := v.checkRaceWindow(loc)
364         if err != nil {
365                 return err
366         }
367         err = v.safeCopy("trash/"+loc, loc)
368         if err != nil {
369                 return err
370         }
371         return v.translateError(v.Bucket.Del(loc))
372 }
373
374 // checkRaceWindow returns a non-nil error if trash/loc is, or might
375 // be, in the race window (i.e., it's not safe to trash loc).
376 func (v *S3Volume) checkRaceWindow(loc string) error {
377         resp, err := v.Bucket.Head("trash/"+loc, nil)
378         err = v.translateError(err)
379         if os.IsNotExist(err) {
380                 // OK, trash/X doesn't exist so we're not in the race
381                 // window
382                 return nil
383         } else if err != nil {
384                 // Error looking up trash/X. We don't know whether
385                 // we're in the race window
386                 return err
387         }
388         t, err := v.lastModified(resp)
389         if err != nil {
390                 // Can't parse timestamp
391                 return err
392         }
393         safeWindow := t.Add(trashLifetime).Sub(time.Now().Add(v.raceWindow))
394         if safeWindow <= 0 {
395                 // We can't count on "touch trash/X" to prolong
396                 // trash/X's lifetime. The new timestamp might not
397                 // become visible until now+raceWindow, and EmptyTrash
398                 // is allowed to delete trash/X before then.
399                 return fmt.Errorf("same block is already in trash, and safe window ended %s ago", -safeWindow)
400         }
401         // trash/X exists, but it won't be eligible for deletion until
402         // after now+raceWindow, so it's safe to overwrite it.
403         return nil
404 }
405
406 // safeCopy calls PutCopy, and checks the response to make sure the
407 // copy succeeded and updated the timestamp on the destination object
408 // (PutCopy returns 200 OK if the request was received, even if the
409 // copy failed).
410 func (v *S3Volume) safeCopy(dst, src string) error {
411         resp, err := v.Bucket.PutCopy(dst, s3ACL, s3.CopyOptions{
412                 ContentType:       "application/octet-stream",
413                 MetadataDirective: "REPLACE",
414         }, v.Bucket.Name+"/"+src)
415         err = v.translateError(err)
416         if err != nil {
417                 return err
418         }
419         if t, err := time.Parse(time.RFC3339Nano, resp.LastModified); err != nil {
420                 return fmt.Errorf("PutCopy succeeded but did not return a timestamp: %q: %s", resp.LastModified, err)
421         } else if time.Now().Sub(t) > maxClockSkew {
422                 return fmt.Errorf("PutCopy succeeded but returned an old timestamp: %q: %s", resp.LastModified, t)
423         }
424         return nil
425 }
426
427 // Get the LastModified header from resp, and parse it as RFC1123 or
428 // -- if it isn't valid RFC1123 -- as Amazon's variant of RFC1123.
429 func (v *S3Volume) lastModified(resp *http.Response) (t time.Time, err error) {
430         s := resp.Header.Get("Last-Modified")
431         t, err = time.Parse(time.RFC1123, s)
432         if err != nil && s != "" {
433                 // AWS example is "Sun, 1 Jan 2006 12:00:00 GMT",
434                 // which isn't quite "Sun, 01 Jan 2006 12:00:00 GMT"
435                 // as required by HTTP spec. If it's not a valid HTTP
436                 // header value, it's probably AWS (or s3test) giving
437                 // us a nearly-RFC1123 timestamp.
438                 t, err = time.Parse(nearlyRFC1123, s)
439         }
440         return
441 }
442
443 // Untrash moves block from trash back into store
444 func (v *S3Volume) Untrash(loc string) error {
445         err := v.safeCopy(loc, "trash/"+loc)
446         if err != nil {
447                 return err
448         }
449         err = v.Bucket.Put("recent/"+loc, nil, "application/octet-stream", s3ACL, s3.Options{})
450         return v.translateError(err)
451 }
452
453 // Status returns a *VolumeStatus representing the current in-use
454 // storage capacity and a fake available capacity that doesn't make
455 // the volume seem full or nearly-full.
456 func (v *S3Volume) Status() *VolumeStatus {
457         return &VolumeStatus{
458                 DeviceNum: 1,
459                 BytesFree: BlockSize * 1000,
460                 BytesUsed: 1,
461         }
462 }
463
464 // String implements fmt.Stringer.
465 func (v *S3Volume) String() string {
466         return fmt.Sprintf("s3-bucket:%+q", v.Bucket.Name)
467 }
468
469 // Writable returns false if all future Put, Mtime, and Delete calls
470 // are expected to fail.
471 func (v *S3Volume) Writable() bool {
472         return !v.readonly
473 }
474
475 // Replication returns the storage redundancy of the underlying
476 // device. Configured via command line flag.
477 func (v *S3Volume) Replication() int {
478         return v.replication
479 }
480
481 var s3KeepBlockRegexp = regexp.MustCompile(`^[0-9a-f]{32}$`)
482
483 func (v *S3Volume) isKeepBlock(s string) bool {
484         return s3KeepBlockRegexp.MatchString(s)
485 }
486
487 // fixRace(X) is called when "recent/X" exists but "X" doesn't
488 // exist. If the timestamps on "recent/"+loc and "trash/"+loc indicate
489 // there was a race between Put and Trash, fixRace recovers from the
490 // race by Untrashing the block.
491 func (v *S3Volume) fixRace(loc string) bool {
492         trash, err := v.Bucket.Head("trash/"+loc, nil)
493         if err != nil {
494                 if !os.IsNotExist(v.translateError(err)) {
495                         log.Printf("error: fixRace: HEAD %q: %s", "trash/"+loc, err)
496                 }
497                 return false
498         }
499         trashTime, err := v.lastModified(trash)
500         if err != nil {
501                 log.Printf("error: fixRace: parse %q: %s", trash.Header.Get("Last-Modified"), err)
502                 return false
503         }
504
505         recent, err := v.Bucket.Head("recent/"+loc, nil)
506         if err != nil {
507                 log.Printf("error: fixRace: HEAD %q: %s", "recent/"+loc, err)
508                 return false
509         }
510         recentTime, err := v.lastModified(recent)
511         if err != nil {
512                 log.Printf("error: fixRace: parse %q: %s", recent.Header.Get("Last-Modified"), err)
513                 return false
514         }
515
516         ageWhenTrashed := trashTime.Sub(recentTime)
517         if ageWhenTrashed >= blobSignatureTTL {
518                 // No evidence of a race: block hasn't been written
519                 // since it became eligible for Trash. No fix needed.
520                 return false
521         }
522
523         log.Printf("notice: fixRace: %q: trashed at %s but touched at %s (age when trashed = %s < %s)", loc, trashTime, recentTime, ageWhenTrashed, blobSignatureTTL)
524         log.Printf("notice: fixRace: copying %q to %q to recover from race between Put/Touch and Trash", "recent/"+loc, loc)
525         err = v.safeCopy(loc, "trash/"+loc)
526         if err != nil {
527                 log.Printf("error: fixRace: %s", err)
528                 return false
529         }
530         return true
531 }
532
533 func (v *S3Volume) translateError(err error) error {
534         switch err := err.(type) {
535         case *s3.Error:
536                 if (err.StatusCode == http.StatusNotFound && err.Code == "NoSuchKey") ||
537                         strings.Contains(err.Error(), "Not Found") {
538                         return os.ErrNotExist
539                 }
540                 // Other 404 errors like NoSuchVersion and
541                 // NoSuchBucket are different problems which should
542                 // get called out downstream, so we don't convert them
543                 // to os.ErrNotExist.
544         }
545         return err
546 }
547
548 // EmptyTrash looks for trashed blocks that exceeded trashLifetime
549 // and deletes them from the volume.
550 func (v *S3Volume) EmptyTrash() {
551         var bytesInTrash, blocksInTrash, bytesDeleted, blocksDeleted int64
552
553         // Use a merge sort to find matching sets of trash/X and recent/X.
554         trashL := s3Lister{
555                 Bucket:   v.Bucket,
556                 Prefix:   "trash/",
557                 PageSize: v.indexPageSize,
558         }
559         // Define "ready to delete" as "...when EmptyTrash started".
560         startT := time.Now()
561         for trash := trashL.First(); trash != nil; trash = trashL.Next() {
562                 loc := trash.Key[6:]
563                 if !v.isKeepBlock(loc) {
564                         continue
565                 }
566                 bytesInTrash += trash.Size
567                 blocksInTrash++
568
569                 trashT, err := time.Parse(time.RFC3339, trash.LastModified)
570                 if err != nil {
571                         log.Printf("warning: %s: EmptyTrash: %q: parse %q: %s", v, trash.Key, trash.LastModified, err)
572                         continue
573                 }
574                 recent, err := v.Bucket.Head("recent/"+loc, nil)
575                 if err != nil && os.IsNotExist(v.translateError(err)) {
576                         log.Printf("warning: %s: EmptyTrash: found trash marker %q but no %q (%s); calling Untrash", v, trash.Key, "recent/"+loc, err)
577                         err = v.Untrash(loc)
578                         if err != nil {
579                                 log.Printf("error: %s: EmptyTrash: Untrash(%q): %s", v, loc, err)
580                         }
581                         continue
582                 } else if err != nil {
583                         log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, "recent/"+loc, err)
584                         continue
585                 }
586                 recentT, err := v.lastModified(recent)
587                 if err != nil {
588                         log.Printf("warning: %s: EmptyTrash: %q: parse %q: %s", v, "recent/"+loc, recent.Header.Get("Last-Modified"), err)
589                         continue
590                 }
591                 if trashT.Sub(recentT) < blobSignatureTTL {
592                         if age := startT.Sub(recentT); age >= blobSignatureTTL-v.raceWindow {
593                                 // recent/loc is too old to protect
594                                 // loc from being Trashed again during
595                                 // the raceWindow that starts if we
596                                 // delete trash/X now.
597                                 //
598                                 // Note this means (trashCheckInterval
599                                 // < blobSignatureTTL - raceWindow) is
600                                 // necessary to avoid starvation.
601                                 log.Printf("notice: %s: EmptyTrash: detected old race for %q, calling fixRace + Touch", v, loc)
602                                 v.fixRace(loc)
603                                 v.Touch(loc)
604                                 continue
605                         } else if _, err := v.Bucket.Head(loc, nil); os.IsNotExist(err) {
606                                 log.Printf("notice: %s: EmptyTrash: detected recent race for %q, calling fixRace", v, loc)
607                                 v.fixRace(loc)
608                                 continue
609                         } else if err != nil {
610                                 log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, loc, err)
611                                 continue
612                         }
613                 }
614                 if startT.Sub(trashT) < trashLifetime {
615                         continue
616                 }
617                 err = v.Bucket.Del(trash.Key)
618                 if err != nil {
619                         log.Printf("warning: %s: EmptyTrash: deleting %q: %s", v, trash.Key, err)
620                         continue
621                 }
622                 bytesDeleted += trash.Size
623                 blocksDeleted++
624
625                 _, err = v.Bucket.Head(loc, nil)
626                 if os.IsNotExist(err) {
627                         err = v.Bucket.Del("recent/" + loc)
628                         if err != nil {
629                                 log.Printf("warning: %s: EmptyTrash: deleting %q: %s", v, "recent/"+loc, err)
630                         }
631                 } else if err != nil {
632                         log.Printf("warning: %s: EmptyTrash: HEAD %q: %s", v, "recent/"+loc, err)
633                 }
634         }
635         if err := trashL.Error(); err != nil {
636                 log.Printf("error: %s: EmptyTrash: lister: %s", v, err)
637         }
638         log.Printf("EmptyTrash stats for %v: Deleted %v bytes in %v blocks. Remaining in trash: %v bytes in %v blocks.", v.String(), bytesDeleted, blocksDeleted, bytesInTrash-bytesDeleted, blocksInTrash-blocksDeleted)
639 }
640
641 type s3Lister struct {
642         Bucket     *s3.Bucket
643         Prefix     string
644         PageSize   int
645         nextMarker string
646         buf        []s3.Key
647         err        error
648 }
649
650 // First fetches the first page and returns the first item. It returns
651 // nil if the response is the empty set or an error occurs.
652 func (lister *s3Lister) First() *s3.Key {
653         lister.getPage()
654         return lister.pop()
655 }
656
657 // Next returns the next item, fetching the next page if necessary. It
658 // returns nil if the last available item has already been fetched, or
659 // an error occurs.
660 func (lister *s3Lister) Next() *s3.Key {
661         if len(lister.buf) == 0 && lister.nextMarker != "" {
662                 lister.getPage()
663         }
664         return lister.pop()
665 }
666
667 // Return the most recent error encountered by First or Next.
668 func (lister *s3Lister) Error() error {
669         return lister.err
670 }
671
672 func (lister *s3Lister) getPage() {
673         resp, err := lister.Bucket.List(lister.Prefix, "", lister.nextMarker, lister.PageSize)
674         lister.nextMarker = ""
675         if err != nil {
676                 lister.err = err
677                 return
678         }
679         if resp.IsTruncated {
680                 lister.nextMarker = resp.NextMarker
681         }
682         lister.buf = make([]s3.Key, 0, len(resp.Contents))
683         for _, key := range resp.Contents {
684                 if !strings.HasPrefix(key.Key, lister.Prefix) {
685                         log.Printf("warning: s3Lister: S3 Bucket.List(prefix=%q) returned key %q", lister.Prefix, key.Key)
686                         continue
687                 }
688                 lister.buf = append(lister.buf, key)
689         }
690 }
691
692 func (lister *s3Lister) pop() (k *s3.Key) {
693         if len(lister.buf) > 0 {
694                 k = &lister.buf[0]
695                 lister.buf = lister.buf[1:]
696         }
697         return
698 }