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
|
package main
import (
"archive/tar"
"bufio"
"bytes"
"crypto"
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"io"
"io/fs"
"net/http"
"net/url"
"os"
"runtime/debug"
"strconv"
"strings"
"github.com/google/uuid"
"github.com/klauspost/compress/zstd"
"github.com/spf13/pflag"
)
// By default the version information is retrieved from VCS. If not available during build,
// override this variable using linker flags to change the displayed version.
// Example: `-ldflags "-X main.versionOverride=v1.2.3"`
var versionOverride = ""
func versionInfo() string {
version := "(unknown)"
if versionOverride != "" {
version = versionOverride
} else if buildInfo, ok := debug.ReadBuildInfo(); ok {
version = buildInfo.Main.Version
}
return fmt.Sprintf("git-pages-cli %s", version)
}
var passwordFlag = pflag.String("password", "", "password for DNS challenge authorization")
var tokenFlag = pflag.String("token", "", "token for forge authorization")
var challengeFlag = pflag.Bool("challenge", false, "compute DNS challenge entry from password (output zone file record)")
var challengeBareFlag = pflag.Bool("challenge-bare", false, "compute DNS challenge entry from password (output bare TXT value)")
var uploadGitFlag = pflag.String("upload-git", "", "replace site with contents of specified git repository")
var uploadDirFlag = pflag.String("upload-dir", "", "replace whole site or a path with contents of specified directory")
var deleteFlag = pflag.Bool("delete", false, "delete whole site or a path")
var debugManifestFlag = pflag.Bool("debug-manifest", false, "retrieve site manifest as ProtoJSON, for debugging")
var serverFlag = pflag.String("server", "", "hostname of server to connect to")
var pathFlag = pflag.String("path", "", "partially update site at specified path")
var parentsFlag = pflag.Bool("parents", false, "create parent directories of --path")
var atomicFlag = pflag.Bool("atomic", false, "require partial updates to be atomic")
var incrementalFlag = pflag.Bool("incremental", false, "make --upload-dir only upload changed files")
var verboseFlag = pflag.BoolP("verbose", "v", false, "display more information for debugging")
var versionFlag = pflag.BoolP("version", "V", false, "display version information")
func singleOperation() bool {
operations := 0
if *challengeFlag {
operations++
}
if *challengeBareFlag {
operations++
}
if *uploadDirFlag != "" {
operations++
}
if *uploadGitFlag != "" {
operations++
}
if *deleteFlag {
operations++
}
if *debugManifestFlag {
operations++
}
if *versionFlag {
operations++
}
return operations == 1
}
func gitBlobSHA256(data []byte) string {
h := crypto.SHA256.New()
h.Write([]byte("blob "))
h.Write([]byte(strconv.FormatInt(int64(len(data)), 10)))
h.Write([]byte{0})
h.Write(data)
return hex.EncodeToString(h.Sum(nil))
}
func displayFS(root fs.FS, prefix string) error {
return fs.WalkDir(root, ".", func(name string, entry fs.DirEntry, err error) error {
if err != nil {
return err
}
switch {
case entry.Type().IsDir():
fmt.Fprintf(os.Stderr, "dir %s%s\n", prefix, name)
case entry.Type().IsRegular():
fmt.Fprintf(os.Stderr, "file %s%s\n", prefix, name)
case entry.Type() == fs.ModeSymlink:
fmt.Fprintf(os.Stderr, "symlink %s%s\n", prefix, name)
default:
fmt.Fprintf(os.Stderr, "other %s%s\n", prefix, name)
}
return nil
})
}
// It doesn't make sense to use incremental updates for very small files since the cost of
// repeating a request to fill in a missing blob is likely to be higher than any savings gained.
const incrementalSizeThreshold = 256
func archiveFS(writer io.Writer, root fs.FS, prefix string, needBlobs []string) (err error) {
requestedSet := make(map[string]struct{})
for _, hash := range needBlobs {
requestedSet[hash] = struct{}{}
}
zstdWriter, _ := zstd.NewWriter(writer)
tarWriter := tar.NewWriter(zstdWriter)
if err = fs.WalkDir(root, ".", func(name string, entry fs.DirEntry, err error) error {
if err != nil {
return err
}
header := &tar.Header{}
data := []byte{}
if prefix == "" && name == "." {
return nil
} else if name == "." {
header.Name = prefix
} else {
header.Name = prefix + name
}
switch {
case entry.Type().IsDir():
header.Typeflag = tar.TypeDir
header.Name += "/"
case entry.Type().IsRegular():
header.Typeflag = tar.TypeReg
if data, err = fs.ReadFile(root, name); err != nil {
return err
}
if *incrementalFlag && len(data) > incrementalSizeThreshold {
hash := gitBlobSHA256(data)
if _, requested := requestedSet[hash]; !requested {
header.Typeflag = tar.TypeSymlink
header.Linkname = "/git/blobs/" + hash
data = nil
}
}
case entry.Type() == fs.ModeSymlink:
header.Typeflag = tar.TypeSymlink
if header.Linkname, err = fs.ReadLink(root, name); err != nil {
return err
}
default:
return errors.New("tar: cannot add non-regular file")
}
header.Size = int64(len(data))
if err = tarWriter.WriteHeader(header); err != nil {
return err
}
if _, err = tarWriter.Write(data); err != nil {
return err
}
return err
}); err != nil {
return
}
if err = tarWriter.Close(); err != nil {
return
}
if err = zstdWriter.Close(); err != nil {
return
}
return
}
// Stream archive data without ever loading the entire working set into RAM.
func streamArchiveFS(root fs.FS, prefix string, needBlobs []string) io.ReadCloser {
reader, writer := io.Pipe()
go func() {
err := archiveFS(writer, root, prefix, needBlobs)
if err != nil {
writer.CloseWithError(err)
} else {
writer.Close()
}
}()
return reader
}
func makeWhiteout(path string) (reader io.Reader) {
buffer := &bytes.Buffer{}
tarWriter := tar.NewWriter(buffer)
tarWriter.WriteHeader(&tar.Header{
Typeflag: tar.TypeChar,
Name: path,
})
tarWriter.Flush()
return buffer
}
const usageExitCode = 125
func usage() {
fmt.Fprintf(os.Stderr,
"Usage: %s <site-url> {--challenge|--upload-git url|--upload-dir path|--delete} [options...]\n",
os.Args[0],
)
pflag.PrintDefaults()
}
func main() {
pflag.Usage = usage
pflag.Parse()
if !singleOperation() || (!*versionFlag && len(pflag.Args()) != 1) {
pflag.Usage()
os.Exit(usageExitCode)
}
if *versionFlag {
fmt.Fprintln(os.Stdout, versionInfo())
os.Exit(0)
}
if *passwordFlag != "" && *tokenFlag != "" {
fmt.Fprintf(os.Stderr, "--password and --token are mutually exclusive")
os.Exit(usageExitCode)
}
var pathPrefix string
if *pathFlag != "" {
if *uploadDirFlag == "" && !*deleteFlag {
fmt.Fprintf(os.Stderr, "--path requires --upload-dir or --delete")
os.Exit(usageExitCode)
} else {
pathPrefix = strings.Trim(*pathFlag, "/") + "/"
}
}
var err error
siteURL, err := url.Parse(pflag.Args()[0])
if err != nil {
fmt.Fprintf(os.Stderr, "error: invalid site URL: %s\n", err)
os.Exit(1)
}
var request *http.Request
var uploadDir *os.Root
switch {
case *challengeFlag || *challengeBareFlag:
if *passwordFlag == "" {
*passwordFlag = uuid.NewString()
fmt.Fprintf(os.Stderr, "password: %s\n", *passwordFlag)
}
challenge := sha256.Sum256(fmt.Appendf(nil, "%s %s", siteURL.Hostname(), *passwordFlag))
if *challengeBareFlag {
fmt.Fprintf(os.Stdout, "%x\n", challenge)
} else {
fmt.Fprintf(os.Stdout, "_git-pages-challenge.%s. 3600 IN TXT \"%x\"\n", siteURL.Hostname(), challenge)
}
os.Exit(0)
case *uploadGitFlag != "":
uploadGitUrl, err := url.Parse(*uploadGitFlag)
if err != nil {
fmt.Fprintf(os.Stderr, "error: invalid repository URL: %s\n", err)
os.Exit(1)
}
requestBody := []byte(uploadGitUrl.String())
request, err = http.NewRequest("PUT", siteURL.String(), bytes.NewReader(requestBody))
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
request.Header.Add("Content-Type", "application/x-www-form-urlencoded")
case *uploadDirFlag != "":
uploadDir, err = os.OpenRoot(*uploadDirFlag)
if err != nil {
fmt.Fprintf(os.Stderr, "error: invalid directory: %s\n", err)
os.Exit(1)
}
if *verboseFlag {
err := displayFS(uploadDir.FS(), pathPrefix)
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
}
if *pathFlag == "" {
request, err = http.NewRequest("PUT", siteURL.String(), nil)
} else {
request, err = http.NewRequest("PATCH", siteURL.String(), nil)
}
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
request.Body = streamArchiveFS(uploadDir.FS(), pathPrefix, []string{})
request.ContentLength = -1
request.Header.Add("Content-Type", "application/x-tar+zstd")
request.Header.Add("Accept", "application/vnd.git-pages.unresolved;q=1.0, text/plain;q=0.9")
if *parentsFlag {
request.Header.Add("Create-Parents", "yes")
} else {
request.Header.Add("Create-Parents", "no")
}
case *deleteFlag:
if *pathFlag == "" {
request, err = http.NewRequest("DELETE", siteURL.String(), nil)
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
} else {
request, err = http.NewRequest("PATCH", siteURL.String(), makeWhiteout(pathPrefix))
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
request.Header.Add("Content-Type", "application/x-tar")
}
case *debugManifestFlag:
manifestURL := siteURL.ResolveReference(&url.URL{Path: ".git-pages/manifest.json"})
request, err = http.NewRequest("GET", manifestURL.String(), nil)
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
default:
panic("no operation chosen")
}
request.Header.Add("User-Agent", versionInfo())
if request.Method == "PATCH" {
if *atomicFlag {
request.Header.Add("Atomic", "yes")
request.Header.Add("Race-Free", "yes") // deprecated name, to be removed soon
} else {
request.Header.Add("Atomic", "no")
request.Header.Add("Race-Free", "no") // deprecated name, to be removed soon
}
}
switch {
case *passwordFlag != "":
request.Header.Add("Authorization", fmt.Sprintf("Pages %s", *passwordFlag))
case *tokenFlag != "":
request.Header.Add("Forge-Authorization", fmt.Sprintf("token %s", *tokenFlag))
}
if *serverFlag != "" {
// Send the request to `--server` host, but set the `Host:` header to the site host.
// This allows first-time publishing to proceed without the git-pages server yet having
// a TLS certificate for the site host (which has a circular dependency on completion of
// first-time publishing).
newURL := *request.URL
newURL.Host = *serverFlag
request.URL = &newURL
request.Header.Set("Host", siteURL.Host)
}
displayServer := *verboseFlag
for {
response, err := http.DefaultClient.Do(request)
if err != nil {
fmt.Fprintf(os.Stderr, "error: %s\n", err)
os.Exit(1)
}
if displayServer {
fmt.Fprintf(os.Stderr, "server: %s\n", response.Header.Get("Server"))
displayServer = false
}
if *debugManifestFlag {
if response.StatusCode == http.StatusOK {
io.Copy(os.Stdout, response.Body)
fmt.Fprintf(os.Stdout, "\n")
} else {
io.Copy(os.Stderr, response.Body)
os.Exit(1)
}
} else { // an update operation
if *verboseFlag {
fmt.Fprintf(os.Stderr, "response: %d %s\n",
response.StatusCode, response.Header.Get("Content-Type"))
}
if response.StatusCode == http.StatusUnprocessableEntity &&
response.Header.Get("Content-Type") == "application/vnd.git-pages.unresolved" {
needBlobs := []string{}
scanner := bufio.NewScanner(response.Body)
for scanner.Scan() {
needBlobs = append(needBlobs, scanner.Text())
}
response.Body.Close()
if *verboseFlag {
fmt.Fprintf(os.Stderr, "incremental: need %d blobs\n", len(needBlobs))
}
request.Body = streamArchiveFS(uploadDir.FS(), pathPrefix, needBlobs)
continue // resubmit
} else if response.StatusCode == http.StatusOK {
fmt.Fprintf(os.Stdout, "result: %s\n", response.Header.Get("Update-Result"))
io.Copy(os.Stdout, response.Body)
} else {
fmt.Fprintf(os.Stderr, "result: error\n")
io.Copy(os.Stderr, response.Body)
os.Exit(1)
}
}
break
}
}
|