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