Add --quiet flag [#117] (#261)

* also use logger everywhere instead of fmt.Printf, with the exception of commands like show which print to stdout.

Author: bdon

main.go

@@ -3,6 +3,7 @@ package main
 import (
 	"context"
 	"fmt"
+	"io"
 	"log"
 	"net/http"
 	"net/url"
@@ -28,6 +29,8 @@ var (
 )
 
 var cli struct {
+	Quiet bool `help:"Silence logging and progress output" short:"q"`
+
 	Show struct {
 		Path       string `arg:""`
 		Bucket     string `help:"Remote bucket"`
@@ -126,6 +129,9 @@ func main() {
 
 	logger := log.New(os.Stdout, "", log.Ldate|log.Ltime|log.Lshortfile)
 	ctx := kong.Parse(&cli)
+	if cli.Quiet {
+		logger.SetOutput(io.Discard)
+	}
 
 	switch ctx.Command() {
 	case "show <path>":

pmtiles/cluster.go

@@ -65,6 +65,6 @@ func Cluster(logger *log.Logger, InputPMTiles string, deduplicate bool) error {
 	if err != nil {
 		return err
 	}
-	fmt.Printf("total directory size %d (%f%% of original)\n", newHeader.RootLength+newHeader.LeafDirectoryLength, float64(newHeader.RootLength+newHeader.LeafDirectoryLength)/float64(header.RootLength+header.LeafDirectoryLength)*100)
+	logger.Printf("total directory size %d (%f%% of original)\n", newHeader.RootLength+newHeader.LeafDirectoryLength, float64(newHeader.RootLength+newHeader.LeafDirectoryLength)/float64(header.RootLength+header.LeafDirectoryLength)*100)
 	return nil
 }

pmtiles/extract.go

@@ -370,7 +370,7 @@ func Extract(ctx context.Context, logger *log.Logger, bucketURL string, key stri
 
 	overfetchLeaves, _ := MergeRanges(leafRanges, overfetch)
 	numOverfetchLeaves := overfetchLeaves.Len()
-	fmt.Printf("fetching %d dirs, %d chunks, %d requests\n", len(leaves), len(leafRanges), overfetchLeaves.Len())
+	logger.Printf("fetching %d dirs, %d chunks, %d requests\n", len(leaves), len(leafRanges), overfetchLeaves.Len())
 
 	for {
 		if overfetchLeaves.Len() == 0 {
@@ -410,7 +410,7 @@ func Extract(ctx context.Context, logger *log.Logger, bucketURL string, key stri
 		return tileEntries[i].TileID < tileEntries[j].TileID
 	})
 
-	fmt.Printf("Region tiles %d, result tile entries %d\n", relevantSet.GetCardinality(), len(tileEntries))
+	logger.Printf("Region tiles %d, result tile entries %d\n", relevantSet.GetCardinality(), len(tileEntries))
 
 	// 6. create the new header and chunk list
 	// we now need to re-encode this entry list using cumulative offsets
@@ -419,7 +419,7 @@ func Extract(ctx context.Context, logger *log.Logger, bucketURL string, key stri
 	overfetchRanges, totalBytes := MergeRanges(tileParts, overfetch)
 
 	numOverfetchRanges := overfetchRanges.Len()
-	fmt.Printf("fetching %d tiles, %d chunks, %d requests\n", len(reencoded), len(tileParts), overfetchRanges.Len())
+	logger.Printf("fetching %d tiles, %d chunks, %d requests\n", len(reencoded), len(tileParts), overfetchRanges.Len())
 
 	// TODO: takes up too much RAM
 	// construct the directories
@@ -561,13 +561,13 @@ func Extract(ctx context.Context, logger *log.Logger, bucketURL string, key stri
 		}
 	}
 
-	fmt.Printf("Completed in %v with %v download threads (%v tiles/s).\n", time.Since(start), downloadThreads, float64(len(reencoded))/float64(time.Since(start).Seconds()))
+	logger.Printf("Completed in %v with %v download threads (%v tiles/s).\n", time.Since(start), downloadThreads, float64(len(reencoded))/float64(time.Since(start).Seconds()))
 	totalRequests := 2                  // header + root
 	totalRequests += numOverfetchLeaves // leaves
 	totalRequests++                     // metadata
 	totalRequests += numOverfetchRanges
-	fmt.Printf("Extract required %d total requests.\n", totalRequests)
-	fmt.Printf("Extract transferred %s (overfetch %v) for an archive size of %s\n", humanize.Bytes(totalBytes), overfetch, humanize.Bytes(totalActualBytes))
+	logger.Printf("Extract required %d total requests.\n", totalRequests)
+	logger.Printf("Extract transferred %s (overfetch %v) for an archive size of %s\n", humanize.Bytes(totalBytes), overfetch, humanize.Bytes(totalActualBytes))
 
 	return nil
 }

pmtiles/makesync.go

@@ -197,6 +197,6 @@ func Makesync(logger *log.Logger, cliVersion string, fileName string, blockSizeK
 
 	serializeSyncBlocks(output, blocks)
 
-	fmt.Printf("Created syncfile with %d blocks.\n", len(blocks))
+	logger.Printf("Created syncfile with %d blocks.\n", len(blocks))
 	return nil
 }

pmtiles/merge.go

@@ -3,7 +3,6 @@ package pmtiles
 import (
 	"fmt"
 	"github.com/RoaringBitmap/roaring/roaring64"
-	"github.com/schollz/progressbar/v3"
 	"io"
 	"log"
 	"math"
@@ -290,7 +289,8 @@ func Merge(logger *log.Logger, inputs []string) error {
 		handle.Seek(int64(headers[idx].TileDataOffset), io.SeekStart)
 	}
 
-	bar := progressbar.DefaultBytes(
+	bar := defaultBytesProgressbar(
+		logger,
 		int64(tileDataLength),
 		"merging tile data",
 	)

pmtiles/sync.go

@@ -218,7 +218,7 @@ func Sync(logger *log.Logger, oldVersion string, newVersion string, dryRun bool)
 	blocksMatched := float64(len(have)) / float64(len(blocks)) * 100
 	pct := float64(toTransfer) / float64(totalRemoteBytes) * 100
 
-	fmt.Printf("%d/%d blocks matched (%.1f%%), need to transfer %s/%s (%.1f%%).\n", len(have), len(blocks), blocksMatched, humanize.Bytes(toTransfer), humanize.Bytes(totalRemoteBytes), pct)
+	logger.Printf("%d/%d blocks matched (%.1f%%), need to transfer %s/%s (%.1f%%).\n", len(have), len(blocks), blocksMatched, humanize.Bytes(toTransfer), humanize.Bytes(totalRemoteBytes), pct)
 
 	ranges := make([]srcDstRange, 0)
 	for _, v := range wanted {
@@ -242,7 +242,7 @@ func Sync(logger *log.Logger, oldVersion string, newVersion string, dryRun bool)
 		}
 	}
 
-	fmt.Printf("need %d chunks\n", len(ranges))
+	logger.Printf("need %d chunks\n", len(ranges))
 
 	if !dryRun {
 		req, err := http.NewRequest("HEAD", newVersion, nil)
@@ -382,6 +382,6 @@ func Sync(logger *log.Logger, oldVersion string, newVersion string, dryRun bool)
 		}
 	}
 
-	fmt.Printf("Completed sync in %v.\n", time.Since(start))
+	logger.Printf("Completed sync in %v.\n", time.Since(start))
 	return nil
 }

pmtiles/verify.go

@@ -13,7 +13,7 @@ import (
 
 // Verify that an archive's header statistics are correct,
 // and that tiles are propertly ordered if clustered=true.
-func Verify(_ *log.Logger, file string) error {
+func Verify(logger *log.Logger, file string) error {
 	start := time.Now()
 	ctx := context.Background()
 
@@ -120,13 +120,13 @@ func Verify(_ *log.Logger, file string) error {
 			}
 
 			if e.Offset+uint64(e.Length) > header.TileDataLength {
-				fmt.Printf("Invalid: %v outside of tile data section", e)
+				logger.Printf("Invalid: %v outside of tile data section", e)
 			}
 
 			if header.Clustered {
 				if !offsets.Contains(e.Offset) {
 					if e.Offset != currentOffset {
-						fmt.Printf("Invalid: out-of-order entry %v in clustered archive", e)
+						logger.Printf("Invalid: out-of-order entry %v in clustered archive", e)
 					}
 					currentOffset += uint64(e.Length)
 				}
@@ -166,6 +166,6 @@ func Verify(_ *log.Logger, file string) error {
 		return fmt.Errorf("Invalid: bounds has area <= 0: clients may not display tiles correctly")
 	}
 
-	fmt.Printf("Completed verify in %v.\n", time.Since(start))
+	logger.Printf("Completed verify in %v.\n", time.Since(start))
 	return nil
 }