{{.Version}}: human readable listing

From 60bbf40bfc8b720f176faef55b5403986db86f8c Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 26 Sep 2021 15:18:44 +0300 Subject: [PATCH] Refactor -help, remove -root --- README | 2 +- doc/ucspi.texi | 2 +- fileutils.go | 2 +- hr.go | 4 +-- integrity.go | 12 +++---- json.go | 2 +- list.go | 6 ++-- main.go | 68 +++++++++++++++++------------------- refresh.go | 4 +-- upload.go | 2 +- usage.go | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++ 11 files changed, 144 insertions(+), 54 deletions(-) create mode 100644 usage.go diff --git a/README b/README index bd87b59..16122c9 100644 --- a/README +++ b/README @@ -1,2 +1,2 @@ GoCheese is Python private package repository and caching proxy. -See gocheese.{info,texi} and INSTALL for more documentation. +See doc/gocheese.info and INSTALL for more documentation. diff --git a/doc/ucspi.texi b/doc/ucspi.texi index 45d8fe3..0927113 100644 --- a/doc/ucspi.texi +++ b/doc/ucspi.texi @@ -17,7 +17,7 @@ umask 077 umask 022 mkdir -p packages exec setuidgid gocheese tcpserver -DRH -l 0 ::0 8080 \ - gocheese -ucspi -passwd passwd + gocheese -ucspi -passwd passwd /path/to/packages EOF # cat > log/run < - {{.Version}}: human readable listing + {{.Version}}: packages

.` ) var ( - Root = flag.String("root", "./packages", "Path to packages directory") - Bind = flag.String("bind", "[::]:8080", "Address to bind to") - MaxClients = flag.Int("maxclients", 128, "Maximal amount of simultaneous clients") - DoUCSPI = flag.Bool("ucspi", false, "Work as UCSPI-TCP service") + Root string + Bind = flag.String("bind", DefaultBind, "") + MaxClients = flag.Int("maxclients", DefaultMaxClients, "") + DoUCSPI = flag.Bool("ucspi", false, "") - TLSCert = flag.String("tls-cert", "", "Path to TLS X.509 certificate") - TLSKey = flag.String("tls-key", "", "Path to TLS X.509 private key") + TLSCert = flag.String("tls-cert", "", "") + TLSKey = flag.String("tls-key", "", "") - NoRefreshURLPath = flag.String("norefresh", "/norefresh/", "Non-refreshing URL path") - RefreshURLPath = flag.String("refresh", "/simple/", "Auto-refreshing URL path") - GPGUpdateURLPath = flag.String("gpgupdate", "/gpgupdate/", "GPG forceful refreshing URL path") - JSONURLPath = flag.String("json", "/pypi/", "JSON API URL path") + NoRefreshURLPath = flag.String("norefresh", DefaultNoRefreshURLPath, "") + RefreshURLPath = flag.String("refresh", DefaultRefreshURLPath, "") + GPGUpdateURLPath = flag.String("gpgupdate", DefaultGPGUpdateURLPath, "") + JSONURLPath = flag.String("json", DefaultJSONURLPath, "") - PyPIURL = flag.String("pypi", "https://pypi.org/simple/", "Upstream (PyPI) URL") - PyPICertHash = flag.String("pypi-cert-hash", "", "Authenticate upstream by its X.509 certificate's SPKI SHA256 hash") - JSONURL = flag.String("pypi-json", "https://pypi.org/pypi/", "Enable and use specified JSON API upstream URL") + PyPIURL = flag.String("pypi", DefaultPyPIURL, "") + JSONURL = flag.String("pypi-json", DefaultJSONURL, "") + PyPICertHash = flag.String("pypi-cert-hash", "", "") - PasswdPath = flag.String("passwd", "", "Path to FIFO for upload authentication") - PasswdListPath = flag.String("passwd-list", "", "Path to FIFO for login listing") - PasswdCheck = flag.Bool("passwd-check", false, "Run password checker") + PasswdPath = flag.String("passwd", "", "") + PasswdListPath = flag.String("passwd-list", "", "") + PasswdCheck = flag.Bool("passwd-check", false, "") - LogTimestamped = flag.Bool("log-timestamped", false, "Prepend timestmap to log messages") - FSCK = flag.Bool("fsck", false, "Check integrity of all packages (errors are in stderr)") - DoVersion = flag.Bool("version", false, "Print version information") - DoWarranty = flag.Bool("warranty", false, "Print warranty information") + LogTimestamped = flag.Bool("log-timestamped", false, "") + FSCK = flag.Bool("fsck", false, "") + DoVersion = flag.Bool("version", false, "") + DoWarranty = flag.Bool("warranty", false, "") Killed bool ) func servePkg(w http.ResponseWriter, r *http.Request, pkgName, filename string) { log.Println(r.RemoteAddr, "get", filename) - path := filepath.Join(*Root, pkgName, filename) + path := filepath.Join(Root, pkgName, filename) if _, err := os.Stat(path); os.IsNotExist(err) { if !refreshDir(w, r, pkgName, filename, false) { return @@ -143,6 +131,7 @@ func handler(w http.ResponseWriter, r *http.Request) { } func main() { + flag.Usage = usage flag.Parse() if *DoWarranty { fmt.Println(Warranty) @@ -162,6 +151,15 @@ func main() { log.SetOutput(os.Stdout) } + if len(flag.Args()) != 1 { + usage() + os.Exit(1) + } + Root = flag.Args()[0] + if _, err := os.Stat(Root); err != nil { + log.Fatalln(err) + } + if *FSCK { if !goodIntegrity() { os.Exit(1) @@ -287,11 +285,9 @@ func main() { log.Println( UserAgent, "ready:", - "root:", *Root, + "root:", Root, "bind:", *Bind, "pypi:", *PyPIURL, - "json:", *JSONURL, - "hr: /", ) if *TLSCert == "" { err = server.Serve(ln) diff --git a/refresh.go b/refresh.go index 67efe57..b97d2be 100644 --- a/refresh.go +++ b/refresh.go @@ -85,11 +85,11 @@ func refreshDir( pkgName, filenameGet string, gpgUpdate bool, ) bool { - if _, err := os.Stat(filepath.Join(*Root, pkgName, InternalFlag)); err == nil { + if _, err := os.Stat(filepath.Join(Root, pkgName, InternalFlag)); err == nil { return true } c := http.Client{Transport: &PyPIHTTPTransport} - dirPath := filepath.Join(*Root, pkgName) + dirPath := filepath.Join(Root, pkgName) now := time.Now() var allReleases map[string][]*PkgReleaseInfo diff --git a/upload.go b/upload.go index 669e414..9ce5540 100644 --- a/upload.go +++ b/upload.go @@ -67,7 +67,7 @@ func serveUpload(w http.ResponseWriter, r *http.Request) { return } pkgName := strings.ToLower(NormalizationRe.ReplaceAllString(pkgNames[0], "-")) - dirPath := filepath.Join(*Root, pkgName) + dirPath := filepath.Join(Root, pkgName) gpgSigsExpected := make(map[string]struct{}) now := time.Now().UTC() diff --git a/usage.go b/usage.go new file mode 100644 index 0000000..3959d6a --- /dev/null +++ b/usage.go @@ -0,0 +1,94 @@ +/* +GoCheese -- Python private package repository and caching proxy +Copyright (C) 2019-2021 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, version 3 of the License. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +package main + +import ( + "fmt" + "os" +) + +const ( + DefaultBind = "[::]:8080" + DefaultMaxClients = 128 + DefaultNoRefreshURLPath = "/norefresh/" + DefaultRefreshURLPath = "/simple/" + DefaultGPGUpdateURLPath = "/gpgupdate/" + DefaultJSONURLPath = "/pypi/" + DefaultPyPIURL = "https://pypi.org/simple/" + DefaultJSONURL = "https://pypi.org/pypi/" + + Warranty = `This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, version 3 of the License. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .` +) + +func usage() { + fmt.Fprintf(os.Stderr, `Usage: gocheese [OPTIONS ...] /path/to/packages + +Network transport options: + -ucspi -- Work as UCSPI-TCP service instead of listening + -bind HOST:PORT -- TCP address to bind to (default: %s) + -maxclients N -- Maximal amount of simultaneous clients (default: %d) + +TLS enabling options: + -tls-cert PEM -- Path to TLS X.509 certificate + -tls-key PEM -- Path to TLS X.509 private key + +HTTP endpoints: + -norefresh URLPATH -- Non-refreshing Simple API path (default: %s) + -refresh URLPATH -- Auto-refreshing Simple API path (default: %s) + -gpgupdate URLPATH -- GPG forceful refreshing path (default: %s) + -json URLPATH -- JSON API path (default: %s) + +Upstream PyPI: + -pypi URL -- Upstream Simple API (default: %s) + -pypi-json URL -- Enable and use specified JSON API (default: %s) + Disabled if empty. + -pypi-cert-hash HEX(SHA256(SPKI)) -- Authenticate upstream by its + X.509 certificate's hash +Password management: + -passwd PATH -- Path to readable FIFO for loading passwords + -passwd-list PATH -- Path to writeable FIFO for listing logins + -passwd-check -- Verify passwords format from stdin, then exit + +Other options: + -log-timestamped -- Prepend timestamp to log messages + -fsck -- Run integrity check of all packages + -version -- Print version information + -warranty -- Print warranty information + +GOCHEESE_NO_SYNC=1 environment variable disable filesystem fsyncs. +`, + DefaultBind, + DefaultMaxClients, + DefaultNoRefreshURLPath, + DefaultRefreshURLPath, + DefaultGPGUpdateURLPath, + DefaultJSONURLPath, + DefaultPyPIURL, + DefaultJSONURLPath, + ) +} -- 2.44.0