-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.go
More file actions
896 lines (798 loc) · 24.5 KB
/
Copy pathmain.go
File metadata and controls
896 lines (798 loc) · 24.5 KB
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
package main
import (
"context"
"fmt"
"html"
"io"
"io/fs"
"mime"
"net"
"net/http"
"os"
"os/exec"
"os/signal"
"path"
"path/filepath"
"runtime"
"sort"
"strings"
"syscall"
"time"
"github.com/dector/nettw"
servfs "github.com/dector/serv/fs"
"github.com/dector/serv/middleware"
"github.com/dector/serv/pages"
"github.com/dector/serv/preview"
"github.com/pkg/errors"
"github.com/urfave/cli/v3"
"golang.org/x/term"
)
const servBanner = `
███████╗███████╗██████╗ ██╗ ██╗
██╔════╝██╔════╝██╔══██╗██║ ██║
███████╗█████╗ ██████╔╝██║ ██║
╚════██║██╔══╝ ██╔══██╗╚██╗ ██╔╝
███████║███████╗██║ ██║ ╚████╔╝
╚══════╝╚══════╝╚═╝ ╚═╝ ╚═══╝`
func main() {
G.Init()
app := &cli.Command{
Name: "serv",
Usage: "Serve static files",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "port",
Aliases: []string{"p"},
Value: fmt.Sprintf("%d", DefaultPort),
Usage: "HTTP server port",
},
&cli.BoolFlag{
Name: "version",
Aliases: []string{"v"},
Value: false,
Usage: "Print version and exit",
},
&cli.StringFlag{
Name: "mode",
Aliases: []string{"m"},
Value: string(serveModePreview),
Usage: "Serving mode: preview/p or file/f",
},
&cli.StringFlag{
Name: "dir-resolve",
Usage: "Directory resolution: readme-first/rf, index-first/if, readme-only/ro, index-only/io, none/n",
},
&cli.BoolFlag{
Name: "no-index-resolve",
Value: false,
Hidden: true,
Usage: "Deprecated: use --dir-resolve instead",
},
&cli.BoolFlag{
Name: "preview",
Aliases: []string{"P"},
Value: false,
Hidden: true,
Usage: "Deprecated: use --mode preview instead",
},
&cli.BoolFlag{
Name: "open",
Aliases: []string{"o"},
Value: false,
Usage: "Open the served URL in the default browser",
},
&cli.StringFlag{
Name: "expose-tailscale",
Aliases: []string{"T"},
Value: exposeTailscaleDefaultValue,
DefaultText: "local port",
HideDefault: true,
Usage: "Expose via Tailscale Serve; optional value sets HTTPS port",
},
&cli.BoolFlag{
Name: "verbose",
Value: false,
Usage: "Print verbose command output",
},
&cli.BoolFlag{
Name: "browser",
Aliases: []string{"B"},
Value: false,
Hidden: true,
Usage: "Deprecated: use --open/-o instead",
},
},
Arguments: []cli.Argument{
&cli.StringArg{
Name: "file",
UsageText: "path to file or directory to serve",
},
},
Action: serveAction,
}
if err := app.Run(context.Background(), normalizeExposeTailscaleArgs(os.Args)); err != nil {
fmt.Fprintf(os.Stderr, "Error: %+v\n", err)
os.Exit(1)
}
}
type serveMode string
type dirResolveStrategy string
type serveConfig struct {
Mode serveMode
DirResolve dirResolveStrategy
}
type recoveryLink struct {
Label string
Query string
}
const (
serveModePreview serveMode = "preview"
serveModeFile serveMode = "file"
dirResolveReadmeFirst dirResolveStrategy = "readme-first"
dirResolveIndexFirst dirResolveStrategy = "index-first"
dirResolveReadmeOnly dirResolveStrategy = "readme-only"
dirResolveIndexOnly dirResolveStrategy = "index-only"
dirResolveNone dirResolveStrategy = "none"
)
const (
ansiReset = "\x1b[0m"
ansiBold = "\x1b[1m"
ansiGreen = "\x1b[32m"
ansiMutedGreen = "\x1b[38;5;65m"
ansiBrightCyan = "\x1b[96m"
ansiWhite = "\x1b[37m"
ansiUnderline = "\x1b[4m"
)
func shouldUseColor(stdoutIsTerminal bool, lookupEnv func(string) (string, bool)) bool {
if _, ok := lookupEnv("NO_COLOR"); ok {
return false
}
if termValue, ok := lookupEnv("TERM"); ok && termValue == "dumb" {
return false
}
if forceColor, ok := lookupEnv("FORCE_COLOR"); ok && forceColor != "" && forceColor != "0" {
return true
}
return stdoutIsTerminal
}
func colorize(value string, codes ...string) string {
return strings.Join(codes, "") + value + ansiReset
}
func printBanner(version string, useColor bool) {
lines := strings.Split(servBanner, "\n")
if len(lines) == 0 {
return
}
if len(lines) > 1 {
bannerHead := strings.Join(lines[:len(lines)-1], "\n")
if useColor {
bannerHead = colorize(bannerHead, ansiMutedGreen)
}
fmt.Println(bannerHead)
}
bannerTail := lines[len(lines)-1]
versionText := fmt.Sprintf("v. %s", version)
if useColor {
bannerTail = colorize(bannerTail, ansiMutedGreen)
versionText = colorize(versionText, ansiWhite)
}
fmt.Printf("%s %s\n\n", bannerTail, versionText)
}
func browserCommand(goos, url string) (string, []string, bool) {
switch goos {
case "linux":
return "xdg-open", []string{url}, true
case "darwin":
return "open", []string{url}, true
case "windows":
return "rundll32", []string{"url.dll,FileProtocolHandler", url}, true
default:
return "", nil, false
}
}
func openBrowser(url string) error {
name, args, ok := browserCommand(runtime.GOOS, url)
if !ok {
return errors.Errorf("opening browser is not supported on %s", runtime.GOOS)
}
return exec.Command(name, args...).Start()
}
func waitForTCP(addr string, timeout time.Duration) error {
deadline := time.Now().Add(timeout)
for {
conn, err := net.DialTimeout("tcp", addr, 100*time.Millisecond)
if err == nil {
_ = conn.Close()
return nil
}
if time.Now().After(deadline) {
return err
}
time.Sleep(50 * time.Millisecond)
}
}
func openBrowserWhenReady(port, url string) {
go func() {
if err := waitForTCP(net.JoinHostPort("127.0.0.1", port), 2*time.Second); err != nil {
fmt.Fprintf(os.Stderr, "Warning: server did not become ready for browser launch: %v\n", err)
return
}
if err := openBrowser(url); err != nil {
fmt.Fprintf(os.Stderr, "Warning: failed to open browser: %v\n", err)
}
}()
}
func servedURL(port string) string {
return fmt.Sprintf("http://localhost:%s", port)
}
func printLaunchInfo(version, rootFile, port string) {
useColor := shouldUseColor(term.IsTerminal(int(os.Stdout.Fd())), os.LookupEnv)
printBanner(version, useColor)
bullet := "●"
pathText := rootFile
if useColor {
bullet = colorize(bullet, ansiGreen)
pathText = colorize(pathText, ansiBold)
}
fmt.Printf("%s serving %s\n", bullet, pathText)
printURLLine(servedURL(port))
}
func printURLLine(url string) {
useColor := shouldUseColor(term.IsTerminal(int(os.Stdout.Fd())), os.LookupEnv)
urlText := url
if useColor {
urlText = colorize(urlText, ansiBrightCyan, ansiUnderline)
}
fmt.Printf(" %s\n", urlText)
}
func parseServeMode(value string) (serveMode, error) {
switch strings.ToLower(value) {
case "preview", "p", "":
return serveModePreview, nil
case "file", "f":
return serveModeFile, nil
default:
return "", errors.Errorf("invalid mode %q (expected preview/p or file/f)", value)
}
}
func parseDirResolveStrategy(value string) (dirResolveStrategy, error) {
switch strings.ToLower(value) {
case "readme-first", "rf", "":
return dirResolveReadmeFirst, nil
case "index-first", "if":
return dirResolveIndexFirst, nil
case "readme-only", "ro":
return dirResolveReadmeOnly, nil
case "index-only", "io":
return dirResolveIndexOnly, nil
case "none", "n":
return dirResolveNone, nil
default:
return "", errors.Errorf("invalid dir-resolve %q", value)
}
}
func effectiveServeConfig(cmd *cli.Command) (serveConfig, error) {
mode, err := parseServeMode(cmd.String("mode"))
if err != nil {
return serveConfig{}, err
}
if cmd.Bool("preview") {
fmt.Fprintln(os.Stderr, "Warning: --preview is deprecated; use --mode preview instead.")
if cmd.IsSet("mode") && mode == serveModeFile {
return serveConfig{}, errors.New("--preview cannot be combined with --mode file")
}
mode = serveModePreview
}
strategy := dirResolveReadmeFirst
if mode == serveModeFile {
strategy = dirResolveNone
}
if cmd.IsSet("dir-resolve") {
strategy, err = parseDirResolveStrategy(cmd.String("dir-resolve"))
if err != nil {
return serveConfig{}, err
}
}
if cmd.Bool("no-index-resolve") {
fmt.Fprintln(os.Stderr, "Warning: --no-index-resolve is deprecated; use --dir-resolve instead.")
if cmd.IsSet("dir-resolve") {
fmt.Fprintln(os.Stderr, "Warning: --no-index-resolve ignored because --dir-resolve was provided.")
} else if mode == serveModePreview {
strategy = dirResolveReadmeOnly
}
}
return serveConfig{Mode: mode, DirResolve: strategy}, nil
}
func listenAddr(host, port string) string {
if host == "" {
return ":" + port
}
return net.JoinHostPort(host, port)
}
func isTCPPortAvailableOnHost(host, port string) bool {
ln, err := net.Listen("tcp", listenAddr(host, port))
if err != nil {
return false
}
_ = ln.Close()
return true
}
func isTCPPortAvailable(port string) bool {
return isTCPPortAvailableOnHost("127.0.0.1", port)
}
type listenConfig struct {
Port nettw.Port
BindAddr string
ReadyAddr string
}
type portAvailabilityFunc func(host, port string) bool
type portPickerFunc func(requestedPort, rootFile string, exposeTailscale bool) (nettw.Port, error)
func pickLocalPort(requestedPort, rootFile string, exposeTailscale bool) (nettw.Port, error) {
if exposeTailscale {
return nettw.ParsePortOrPickAnother("random", nettw.WithIgnoreInvalidPort(true), nettw.WithSeed(rootFile), nettw.WithPortRange(49152, 65535))
}
return nettw.ParsePortOrPickAnother(requestedPort, nettw.WithSeed(rootFile))
}
func detectListenConfig(requestedPort string, portIsSet bool, rootFile string, exposeTailscale bool, available portAvailabilityFunc, pickPort portPickerFunc) (listenConfig, error) {
var port nettw.Port
if !exposeTailscale {
if parsedPort, err := validateTCPPort(requestedPort); err == nil && available("127.0.0.1", parsedPort) {
port = nettw.Port{Str: parsedPort}
} else {
pickedPort, err := pickPort(requestedPort, rootFile, false)
if err != nil {
return listenConfig{}, err
}
port = pickedPort
}
} else if portIsSet {
parsedPort, err := validateTCPPort(requestedPort)
if err != nil {
return listenConfig{}, fmt.Errorf("invalid --port: %w", err)
}
if !available("127.0.0.1", parsedPort) {
return listenConfig{}, errors.Errorf("local port %s is not available", parsedPort)
}
port = nettw.Port{Str: parsedPort}
} else {
pickedPort, err := pickPort("random", rootFile, true)
if err != nil {
return listenConfig{}, err
}
port = pickedPort
}
readyAddr := net.JoinHostPort("127.0.0.1", port.Str)
bindAddr := listenAddr("", port.Str)
if exposeTailscale || !available("", port.Str) {
bindAddr = readyAddr
}
return listenConfig{Port: port, BindAddr: bindAddr, ReadyAddr: readyAddr}, nil
}
func selectListenConfig(cmd *cli.Command, rootFile string, exposeTailscale bool) (listenConfig, error) {
return detectListenConfig(cmd.String("port"), cmd.IsSet("port"), rootFile, exposeTailscale, isTCPPortAvailableOnHost, pickLocalPort)
}
func checkTailscaleReady(ctx context.Context, runner tailscaleRunner, tailscalePort string) error {
if err := runner.LookPath(); err != nil {
return errors.New("tailscale is not installed or not found in PATH; install Tailscale to use --expose-tailscale")
}
status, err := runner.StatusJSON(ctx)
if err != nil {
if isNoTailscaleServeConfig(status) {
return nil
}
return errors.Errorf("failed to check Tailscale Serve status: %v\n%s", err, strings.TrimSpace(string(status)))
}
if tailscaleStatusHasHTTPSPort(status, tailscalePort) {
return errors.Errorf("Tailscale HTTPS port %s is already configured", tailscalePort)
}
return nil
}
func serveWithTailscale(ctx context.Context, server *http.Server, listener net.Listener, readyAddr, localPort, tailscalePort string, verbose bool, runner tailscaleRunner) error {
serverErr := make(chan error, 1)
go func() {
serverErr <- server.Serve(listener)
}()
if err := waitForTCP(readyAddr, 2*time.Second); err != nil {
_ = server.Shutdown(context.Background())
return errors.Wrap(err, "server did not become ready for Tailscale exposure")
}
stdout := io.Writer(os.Stdout)
stderr := io.Writer(os.Stderr)
var urlCh <-chan string
if !verbose {
urlWriter := newTailscaleURLWriter()
stdout = urlWriter
stderr = urlWriter
urlCh = urlWriter.URL()
} else {
fmt.Printf("Exposing via Tailscale HTTPS port %s -> http://127.0.0.1:%s\n", tailscalePort, localPort)
}
tailscaleProc, err := runner.StartServe(ctx, tailscalePort, localPort, stdout, stderr)
if err != nil {
_ = server.Shutdown(context.Background())
return errors.Wrap(err, "failed to start tailscale serve")
}
tailscaleErr := make(chan error, 1)
go func() {
tailscaleErr <- tailscaleProc.Wait()
}()
if !verbose {
select {
case url := <-urlCh:
printURLLine(url)
case err := <-tailscaleErr:
_ = server.Shutdown(context.Background())
if err != nil {
return errors.Wrap(err, "tailscale serve failed")
}
return nil
case <-time.After(2 * time.Second):
}
}
signalCtx, stopSignals := signal.NotifyContext(ctx, os.Interrupt, syscall.SIGTERM)
defer stopSignals()
shutdownTailscale := func() {
_ = tailscaleProc.Interrupt()
select {
case <-tailscaleErr:
case <-time.After(3 * time.Second):
_ = tailscaleProc.Kill()
<-tailscaleErr
}
}
select {
case err := <-serverErr:
shutdownTailscale()
if errors.Is(err, http.ErrServerClosed) {
return nil
}
return err
case err := <-tailscaleErr:
_ = server.Shutdown(context.Background())
if err != nil {
return errors.Wrap(err, "tailscale serve failed")
}
return nil
case <-signalCtx.Done():
_ = server.Shutdown(context.Background())
shutdownTailscale()
return nil
}
}
func serveAction(ctx context.Context, cmd *cli.Command) error {
if cmd.Bool("version") {
fmt.Println(G.Version)
return nil
}
serveConfig, err := effectiveServeConfig(cmd)
if err != nil {
return err
}
rootFile := cmd.StringArg("file")
rootFile, err = filepath.Abs(rootFile)
if err != nil {
return errors.Wrap(err, "failed to get absolute path")
}
if _, err := os.Stat(rootFile); os.IsNotExist(err) {
return errors.Errorf("file does not exist: %s", rootFile)
}
exposeTailscale := cmd.IsSet("expose-tailscale")
listenConfig, err := selectListenConfig(cmd, rootFile, exposeTailscale)
if err != nil {
return err
}
tailscaleConfig, err := parseExposeTailscaleConfig(exposeTailscale, cmd.String("expose-tailscale"), listenConfig.Port.Str)
if err != nil {
return err
}
if tailscaleConfig.Enabled {
if err := checkTailscaleReady(ctx, realTailscaleRunner{}, tailscaleConfig.Port); err != nil {
return err
}
}
// Create filesystem rooted at the specified directory or file's parent
var fsys fs.FS
var basePath string
rootInfo, err := os.Stat(rootFile)
if err != nil {
return errors.Wrap(err, "failed to stat root file")
}
if rootInfo.IsDir() {
fsys = os.DirFS(rootFile)
basePath = "."
} else {
// If serving a single file, use its parent directory as the filesystem root
parentDir := filepath.Dir(rootFile)
fsys = os.DirFS(parentDir)
basePath = filepath.Base(rootFile)
}
mux := http.NewServeMux()
mux.HandleFunc("/", middleware.WithLogging(func(w http.ResponseWriter, r *http.Request) {
// Clean the URL path and handle root requests
requestedPath := path.Clean(r.URL.Path)
if requestedPath == "/" {
requestedPath = basePath
} else {
// For non-root requests, join with basePath if serving a directory
if rootInfo.IsDir() {
requestedPath = path.Join(basePath, requestedPath[1:]) // remove leading slash
} else {
// If serving a single file, only allow requests to that file
if requestedPath != "/"+filepath.Base(rootFile) && requestedPath != "/" {
http.NotFound(w, r)
return
}
requestedPath = basePath
}
}
// Use fs.Stat to get file info securely within the filesystem
fileInfo, err := fs.Stat(fsys, requestedPath)
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
http.NotFound(w, r)
return
}
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
if fileInfo.IsDir() {
serveFolder(w, r, requestedPath, fsys, fileInfo, rootFile, serveConfig)
} else {
if err := serveFile(w, r, requestedPath, fsys, serveConfig); err != nil {
serveFileError(w, r, "Serve error", err, nil)
}
}
}))
if cmd.Bool("browser") {
fmt.Fprintln(os.Stderr, "Warning: --browser/-B is deprecated and will be removed in a future release. Use --open/-o instead.")
}
server := &http.Server{Addr: listenConfig.BindAddr, Handler: mux}
listener, err := net.Listen("tcp", listenConfig.BindAddr)
if err != nil {
return err
}
printLaunchInfo(G.Version, rootFile, listenConfig.Port.Str)
if cmd.Bool("open") || cmd.Bool("browser") {
openBrowserWhenReady(listenConfig.Port.Str, servedURL(listenConfig.Port.Str))
}
if !tailscaleConfig.Enabled {
return server.Serve(listener)
}
return serveWithTailscale(ctx, server, listener, listenConfig.ReadyAddr, listenConfig.Port.Str, tailscaleConfig.Port, cmd.Bool("verbose"), realTailscaleRunner{})
}
func requestDirResolveStrategy(r *http.Request, fallback dirResolveStrategy) dirResolveStrategy {
if r == nil || r.URL == nil {
return fallback
}
value := r.URL.Query().Get("resolve")
if value == "" {
return fallback
}
strategy, err := parseDirResolveStrategy(value)
if err != nil {
return fallback
}
return strategy
}
func directoryCandidatePaths(fsys fs.FS, dir string, strategy dirResolveStrategy) []string {
readme := func() []string {
if p, ok := findReadme(fsys, dir); ok {
return []string{p}
}
return nil
}
index := []string{path.Join(dir, "index.html")}
switch strategy {
case dirResolveReadmeFirst:
return append(readme(), index...)
case dirResolveIndexFirst:
return append(index, readme()...)
case dirResolveReadmeOnly:
return readme()
case dirResolveIndexOnly:
return index
default:
return nil
}
}
func selectDirectoryCandidate(fsys fs.FS, dir string, strategy dirResolveStrategy) (string, bool) {
for _, candidate := range directoryCandidatePaths(fsys, dir, strategy) {
info, err := fs.Stat(fsys, candidate)
if err == nil && !info.IsDir() {
return candidate, true
}
}
return "", false
}
func findReadme(fsys fs.FS, dir string) (string, bool) {
entries, err := fs.ReadDir(fsys, dir)
if err != nil {
return "", false
}
for _, entry := range entries {
if entry.IsDir() {
continue
}
if isReadmeName(entry.Name()) {
return path.Join(dir, entry.Name()), true
}
}
return "", false
}
func isReadmeName(name string) bool {
allowed := map[string]bool{"readme.md": true, "readme.markdown": true, "readme.mdown": true, "readme.mkd": true}
return allowed[strings.ToLower(name)]
}
func buildSideMenu(r *http.Request, dir string, currentPath string, fsys fs.FS) *preview.SideMenu {
menu := &preview.SideMenu{CurrentPath: displayDirPath(dir)}
entries, err := fs.ReadDir(fsys, dir)
if err != nil {
menu.Error = "Could not load directory menu."
return menu
}
if !isRootDirPath(dir) {
menu.Items = append(menu.Items, preview.SideMenuItem{
Label: "../",
Href: sideMenuHref(r, "../"),
Title: "../",
})
}
sort.SliceStable(entries, func(i, j int) bool {
if entries[i].IsDir() != entries[j].IsDir() {
return entries[i].IsDir()
}
return strings.ToLower(entries[i].Name()) < strings.ToLower(entries[j].Name())
})
currentName := path.Base(currentPath)
for _, entry := range entries {
name := entry.Name()
label := name
href := sideMenuHref(r, name)
if entry.IsDir() {
label = name + "/"
href = sideMenuHref(r, name+"/")
}
menu.Items = append(menu.Items, preview.SideMenuItem{
Label: label,
Href: href,
Title: label,
IsDir: entry.IsDir(),
IsCurrent: !entry.IsDir() && name == currentName,
})
}
return menu
}
func displayDirPath(dir string) string {
clean := path.Clean(dir)
if clean == "." || clean == "/" {
return "/"
}
return "/" + strings.Trim(clean, "/") + "/"
}
func isRootDirPath(dir string) bool {
clean := path.Clean(dir)
return clean == "." || clean == "/"
}
func sideMenuHref(r *http.Request, href string) string {
if r == nil || r.URL == nil || r.URL.RawQuery == "" {
return href
}
return href + "?" + r.URL.RawQuery
}
func shouldRenderPreview(r *http.Request, requestedPath string, mode serveMode) bool {
if !preview.CanPreview(requestedPath) {
return false
}
if r != nil && r.URL != nil {
query := r.URL.Query()
if query.Get("raw") == "1" {
return false
}
if query.Get("preview") == "1" {
return true
}
}
return mode == serveModePreview
}
func urlWithQuery(r *http.Request, query string) string {
if r == nil || r.URL == nil {
return "?" + query
}
u := *r.URL
q := u.Query()
for _, part := range strings.Split(query, "&") {
key, value, ok := strings.Cut(part, "=")
if ok {
q.Set(key, value)
} else {
q.Set(key, "")
}
}
u.RawQuery = q.Encode()
return u.String()
}
func directoryRecoveryLinks(strategy dirResolveStrategy) []recoveryLink {
links := []recoveryLink{{Label: "Show directory listing", Query: "resolve=none"}}
switch strategy {
case dirResolveReadmeFirst, dirResolveReadmeOnly:
links = append(links, recoveryLink{Label: "Try index.html", Query: "resolve=index-only"})
case dirResolveIndexFirst, dirResolveIndexOnly:
links = append(links, recoveryLink{Label: "Try README", Query: "resolve=readme-only"})
}
return links
}
func serveFolder(lw http.ResponseWriter, r *http.Request, requestedPath string, fsys fs.FS, rootInfo fs.FileInfo, rootFile string, config serveConfig) {
strategy := requestDirResolveStrategy(r, config.DirResolve)
if strategy != dirResolveNone {
if candidate, ok := selectDirectoryCandidate(fsys, requestedPath, strategy); ok {
if isReadmeName(path.Base(candidate)) && shouldRenderPreview(r, candidate, config.Mode) {
if err := servePreviewFile(lw, r, candidate, fsys, preview.Options{SideMenu: buildSideMenu(r, requestedPath, candidate, fsys)}); err != nil {
serveFileError(lw, r, "Serve error", err, directoryRecoveryLinks(strategy))
}
return
}
if err := serveFile(lw, r, candidate, fsys, config); err != nil {
serveFileError(lw, r, "Serve error", err, directoryRecoveryLinks(strategy))
}
return
}
}
fullPath := filepath.Join(rootFile, requestedPath)
if !rootInfo.IsDir() {
fullPath = rootFile // serving single file's parent, but this shouldn't happen
}
node, err := servfs.GetFsNode(fullPath)
if err != nil {
http.Error(lw, err.Error(), http.StatusInternalServerError)
return
}
lw.Write(pages.GenerateFolderPage(node, requestedPath, G.Version))
}
func serveFile(lw http.ResponseWriter, r *http.Request, requestedPath string, fsys fs.FS, config serveConfig) error {
content, err := fs.ReadFile(fsys, requestedPath)
if err != nil {
return err
}
if shouldRenderPreview(r, requestedPath, config.Mode) {
return writePreview(lw, r, requestedPath, content, preview.Options{})
}
// Serve the file using MIME-by-extension behavior for raw responses.
contentType := mime.TypeByExtension(filepath.Ext(requestedPath))
if contentType != "" {
lw.Header().Set("Content-Type", contentType)
}
_, err = lw.Write(content)
return err
}
func servePreviewFile(lw http.ResponseWriter, r *http.Request, requestedPath string, fsys fs.FS, options preview.Options) error {
content, err := fs.ReadFile(fsys, requestedPath)
if err != nil {
return err
}
return writePreview(lw, r, requestedPath, content, options)
}
func writePreview(lw http.ResponseWriter, r *http.Request, requestedPath string, content []byte, options preview.Options) error {
rendered, err := preview.RenderWithOptions(requestedPath, content, options)
if err != nil {
serveFileError(lw, r, "Preview error", err, []recoveryLink{{Label: "View raw file", Query: "raw=1"}})
return nil
}
lw.Header().Set("Content-Type", "text/html; charset=utf-8")
_, err = lw.Write(rendered)
return err
}
func serveFileError(lw http.ResponseWriter, r *http.Request, title string, err error, links []recoveryLink) {
lw.Header().Set("Content-Type", "text/html; charset=utf-8")
lw.WriteHeader(http.StatusInternalServerError)
fmt.Fprintf(lw, "<!doctype html><html><head><meta charset=\"utf-8\"><title>%s</title></head><body><h1>%s</h1><p>%s</p>", html.EscapeString(title), html.EscapeString(title), html.EscapeString(err.Error()))
for _, link := range links {
fmt.Fprintf(lw, "<p><a href=\"%s\">%s</a></p>", html.EscapeString(urlWithQuery(r, link.Query)), html.EscapeString(link.Label))
}
fmt.Fprint(lw, "</body></html>")
}
func detectContentType(node *servfs.FsNode) (string, error) {
if node.Info.IsDir() {
return "", errors.New("not implemented")
}
return mime.TypeByExtension(filepath.Ext(node.Path)), nil
}