bump ui

.github/workflows/deploy.yml

@@ -1,63 +0,0 @@
-name: deploy
-
-on:
-  push:
-    tags:
-      - '*'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-
-    - name: Set up Go
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.19.1
-      id: go
-
-    - name: Set env
-      run: echo "GIT_TAG=`echo $(git describe --tags --abbrev=0)`" >> $GITHUB_ENV
-
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v1.2.0
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1.6.0
-
-    - name: Login to DockerHub
-      uses: docker/login-action@v1.10.0
-      with:
-        username: ${{ secrets.DOCKER_USER }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-
-    - name: Build and release on dockerhub
-      uses: docker/build-push-action@v2.7.0
-      with:
-        file: support/build.Dockerfile
-        push: true
-        platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
-        tags: pldubouilh/gossa:latest,pldubouilh/gossa:${{github.ref_name}}
-
-    - name: Build all artifacts
-      run: make build-all
-
-    - name: "Release gh release versioned"
-      uses: ncipollo/release-action@58ae73b360456532aafd58ee170c045abbeaee37
-      with:
-        allowUpdates: true
-        artifacts: "builds/*"
-        token: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: "Release gh release latest"
-      uses: ncipollo/release-action@58ae73b360456532aafd58ee170c045abbeaee37
-      with:
-        tag: latest
-        name: Latest
-        allowUpdates: true
-        artifacts: "builds/*"
-        token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/go.yml

@@ -1,15 +1,16 @@
-name: always
+name: ci
-on: [push]
+on: [push, pull_request]
 jobs:
+
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
 
-    - name: Set up Go
+    - name: Set up Go 1.12
       uses: actions/setup-go@v1
       with:
-        go-version: 1.19.1
+        go-version: 1.12
       id: go
 
     - name: Check out code into the Go module directory
@@ -19,4 +20,3 @@ jobs:
 
     - name: Run
       run: make ci
-

.github/workflows/rc.yml

@@ -1,39 +0,0 @@
-name: rc
-
-on:
-  push:
-    branches:
-      - 'rc/**'
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Set up Go
-      uses: actions/setup-go@v1
-      with:
-        go-version: 1.19.1
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-
-    - name: Run
-      run: make ci
-
-    - name: Build all artifacts
-      run: make build-all
-
-    - name: "Release gh release prerelease"
-      uses: ncipollo/release-action@58ae73b360456532aafd58ee170c045abbeaee37
-      with:
-        allowUpdates: true
-        prerelease: true
-        tag: "rc"
-        artifacts: "builds/*"
-        token: ${{ secrets.GITHUB_TOKEN }}
-

.gitignore

@@ -4,10 +4,7 @@ gossa-linux-arm
 gossa-linux-arm64
 gossa-mac
 gossa-windows.exe
-builds
-gossa.test
 
-*.out
 .vscode
 test-fixture/*
 test-fixture/*/*
@@ -41,8 +38,4 @@ test-fixture/*/*
 !test-fixture/fancy-path
 !test-fixture/fancy-path/*
 !test-fixture/ext/*
-!test-fixture/ext
+!test-fixture/ext
-!test-fixture/.some-hidden-file
-!test-fixture/hols/.hidden-folder
-!test-fixture/hols/.hidden-folder/some-file
-!test-fixture/compress/hols-sym

Makefile

@@ -1,74 +1,56 @@
-FLAGS := -ldflags "-s -w" -trimpath
-NOCGO := CGO_ENABLED=0
-
 build:
+	cp src/gossa.go gossa.go
+	make -C gossa-ui/
 	go vet && go fmt
-	${NOCGO} go build ${FLAGS} -o gossa
+	CGO_ENABLED=0 go build gossa.go
-
+	rm gossa.go
-install:
-	sudo cp gossa /usr/local/bin
 
 run:
+	make build
 	./gossa -verb=true test-fixture
 
-run-ro:
-	./gossa -verb=true -ro=true test-fixture
-
 run-extra:
+	make build
 	./gossa -verb=true -prefix="/fancy-path/" -k=false -symlinks=true test-fixture
 
-ci: build-all test
+ci:
-	echo "done"
+	-@cd test-fixture && ln -s ../support .
-
+	make build
-test:
+	timeout 15 make run &
-	-@cd test-fixture && ln -s ../support .; true
+	sleep 16 && timeout 15 make run-extra &
-	go test -cover -c -tags testrunmain
+	cp src/gossa_test.go . && go test
-
+	rm gossa_test.go
-	timeout -s SIGINT 3 ./gossa.test -test.coverprofile=normal.out -test.run '^TestRunMain' -verb=true test-fixture &
-	sleep 2
-	go test -run TestNormal
-	sleep 1
-
-	timeout -s SIGINT 3 ./gossa.test -test.coverprofile=extra.out -test.run '^TestRunMain' -prefix='/fancy-path/' -k=false -symlinks=true test-fixture &
-	sleep 2
-	go test -run TestExtra
-	sleep 1
-
-	timeout -s SIGINT 3 ./gossa.test -test.coverprofile=ro.out -test.run '^TestRunMain' -ro=true test-fixture &
-	sleep 2
-	go test -run TestRo
-	sleep 1
-
-	# gocovmerge ro.out extra.out normal.out > all.out
-	# go tool cover -html all.out
-	# go tool cover -func=all.out | grep main | grep '9.\..\%'
 
 watch:
-	ls gossa.go gossa_test.go gossa-ui/* | entr -rc make build run
+	ls src/* gossa-ui/* | entr -rc make run
 
 watch-extra:
-	ls gossa.go gossa_test.go gossa-ui/* | entr -rc make build run-extra
+	ls src/* gossa-ui/* | entr -rc make run-extra
 
-watch-ro:
+watch-ci:
-	ls gossa.go gossa_test.go gossa-ui/* | entr -rc make build run-ro
+	ls src/* gossa-ui/* | entr -rc make ci
 
-watch-test:
+build-all:
-	ls gossa.go gossa_test.go gossa-ui/* | entr -rc make test
+	cp src/gossa.go gossa.go
-
+	make -C gossa-ui/
-build-all: build
+	env CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build gossa.go
-	${NOCGO}  GOOS=linux    GOARCH=amd64  go build ${FLAGS} -o builds/gossa-linux-x64
+	mv gossa gossa-linux64
-	${NOCGO}  GOOS=linux    GOARCH=arm    go build ${FLAGS} -o builds/gossa-linux-arm
+	env GOOS=linux GOARCH=arm go build gossa.go
-	${NOCGO}  GOOS=linux    GOARCH=arm64  go build ${FLAGS} -o builds/gossa-linux-arm64
+	mv gossa gossa-linux-arm
-	${NOCGO}  GOOS=darwin   GOARCH=amd64  go build ${FLAGS} -o builds/gossa-mac-x64
+	env GOOS=linux GOARCH=arm64 go build gossa.go
-	${NOCGO}  GOOS=darwin   GOARCH=arm64  go build ${FLAGS} -o builds/gossa-mac-arm64
+	mv gossa gossa-linux-arm64
-	${NOCGO}  GOOS=windows  GOARCH=amd64  go build ${FLAGS} -o builds/gossa-windows.exe
+	env GOOS=darwin GOARCH=amd64 go build gossa.go
-	sha256sum builds/*
+	mv gossa gossa-mac
+	env GOOS=windows GOARCH=amd64 go build gossa.go
+	mv gossa.exe gossa-windows.exe
+	rm gossa.go
 
 clean:
+	-rm gossa.go
+	-rm gossa_test.go
 	-rm gossa
 	-rm gossa-linux64
 	-rm gossa-linux-arm
 	-rm gossa-linux-arm64
 	-rm gossa-mac
 	-rm gossa-windows.exe
-

go.mod

@@ -1,3 +0,0 @@
-module github.com/pldubouilh/gossa
-
-go 1.16

gossa.go

@@ -1,271 +0,0 @@
-package main
-
-import (
-	"archive/zip"
-	"compress/gzip"
-	_ "embed"
-	"encoding/json"
-	"errors"
-	"flag"
-	"fmt"
-	"html"
-	"html/template"
-	"io"
-	"io/fs"
-	"io/ioutil"
-	"log"
-	"net/http"
-	"net/url"
-	"os"
-	"path/filepath"
-	"sort"
-	"strconv"
-	"strings"
-)
-
-type rpcCall struct {
-	Call string   `json:"call"`
-	Args []string `json:"args"`
-}
-
-var rootPath = ""
-var handler http.Handler
-
-func check(e error) {
-	if e != nil {
-		panic(e)
-	}
-}
-
-func exitPath(w http.ResponseWriter, s ...interface{}) {
-	if r := recover(); r != nil {
-		log.Println("error", s, r)
-		w.WriteHeader(500)
-		w.Write([]byte("error"))
-	} else if *verb {
-		log.Println(s...)
-	}
-}
-
-func humanize(bytes int64) string {
-	b := float64(bytes)
-	u := 0
-	for {
-		if b < 1024 {
-			return strconv.FormatFloat(b, 'f', 1, 64) + [9]string{"B", "k", "M", "G", "T", "P", "E", "Z", "Y"}[u]
-		}
-		b = b / 1024
-		u++
-	}
-}
-
-func replyList(w http.ResponseWriter, r *http.Request, fullPath string, path string) {
-	_files, err := ioutil.ReadDir(fullPath)
-	check(err)
-	sort.Slice(_files, func(i, j int) bool { return strings.ToLower(_files[i].Name()) < strings.ToLower(_files[j].Name()) })
-
-	if !strings.HasSuffix(path, "/") {
-		path += "/"
-	}
-
-	title := "/" + strings.TrimPrefix(path, *extraPath)
-	p := pageTemplate{}
-	if path != *extraPath {
-		p.RowsFolders = append(p.RowsFolders, rowTemplate{"../", "../", "", "folder"})
-	}
-	p.ExtraPath = template.HTML(html.EscapeString(*extraPath))
-	p.Ro = *ro
-	p.Title = template.HTML(html.EscapeString(title))
-
-	for _, el := range _files {
-		if *skipHidden && strings.HasPrefix(el.Name(), ".") {
-			continue // dont print hidden files if we're not allowed
-		}
-		if !*symlinks && el.Mode()&os.ModeSymlink != 0 {
-			continue // dont print symlinks if were not allowed
-		}
-
-		el, err := os.Stat(fullPath + "/" + el.Name())
-		if err != nil {
-			log.Println("error - cant stat a file", err)
-			continue
-		}
-
-		href := url.PathEscape(el.Name())
-		if el.IsDir() && strings.HasPrefix(href, "/") {
-			href = strings.Replace(href, "/", "", 1)
-		}
-		if el.IsDir() {
-			p.RowsFolders = append(p.RowsFolders, rowTemplate{el.Name() + "/", template.HTML(href), "", "folder"})
-		} else {
-			sl := strings.Split(el.Name(), ".")
-			ext := strings.ToLower(sl[len(sl)-1])
-			p.RowsFiles = append(p.RowsFiles, rowTemplate{el.Name(), template.HTML(href), humanize(el.Size()), ext})
-		}
-	}
-
-	if strings.Contains(r.Header.Get("Accept-Encoding"), "gzip") {
-		w.Header().Set("Content-Type", "text/html")
-		w.Header().Add("Content-Encoding", "gzip")
-		gz, err := gzip.NewWriterLevel(w, gzip.BestSpeed) // BestSpeed is Much Faster than default - base on a very unscientific local test, and only ~30% larger (compression remains still very effective, ~6x)
-		check(err)
-		defer gz.Close()
-		templateParsed.Execute(gz, p)
-	} else {
-		templateParsed.Execute(w, p)
-	}
-}
-
-func doContent(w http.ResponseWriter, r *http.Request) {
-	if !strings.HasPrefix(r.URL.Path, *extraPath) { // redir when were not hitting the supplementary path if one is set
-		http.Redirect(w, r, *extraPath, http.StatusFound)
-		return
-	}
-
-	path := html.UnescapeString(r.URL.Path)
-	defer exitPath(w, "get content", path)
-	fullPath := enforcePath(path)
-	stat, errStat := os.Stat(fullPath)
-	check(errStat)
-
-	if stat.IsDir() {
-		replyList(w, r, fullPath, path)
-	} else {
-		handler.ServeHTTP(w, r)
-	}
-}
-
-func upload(w http.ResponseWriter, r *http.Request) {
-	path := r.Header.Get("gossa-path")
-	defer exitPath(w, "upload", path)
-
-	path, err := url.PathUnescape(path)
-	check(err)
-	reader, err := r.MultipartReader()
-	check(err)
-	part, err := reader.NextPart()
-	if err != nil && err != io.EOF { // errs EOF when no more parts to process
-		check(err)
-	}
-	dst, err := os.Create(enforcePath(path))
-	check(err)
-	io.Copy(dst, part)
-	w.Write([]byte("ok"))
-}
-
-func zipRPC(w http.ResponseWriter, r *http.Request) {
-	zipPath := r.URL.Query().Get("zipPath")
-	zipName := r.URL.Query().Get("zipName")
-	defer exitPath(w, "zip", zipPath)
-	zipFullPath := enforcePath(zipPath)
-	_, err := os.Lstat(zipFullPath)
-	check(err)
-	w.Header().Add("Content-Disposition", "attachment; filename=\""+zipName+".zip\"")
-	zipWriter := zip.NewWriter(w)
-	defer zipWriter.Close()
-
-	err = filepath.Walk(zipFullPath, func(path string, f fs.FileInfo, err error) error {
-		check(err)
-		if f.IsDir() {
-			return nil
-		}
-
-		rel, err := filepath.Rel(zipFullPath, path)
-		check(err)
-		if *skipHidden && (strings.HasPrefix(rel, ".") || strings.HasPrefix(f.Name(), ".")) {
-			return nil // hidden files not allowed
-		}
-		if f.Mode()&os.ModeSymlink != 0 {
-			panic(errors.New("symlink not allowed in zip downloads")) // filepath.Walk doesnt support symlinks
-		}
-
-		header, err := zip.FileInfoHeader(f)
-		check(err)
-		header.Name = filepath.ToSlash(rel) // make the paths consistent between OSes
-		header.Method = zip.Store
-		headerWriter, err := zipWriter.CreateHeader(header)
-		check(err)
-		file, err := os.Open(path)
-		check(err)
-		defer file.Close()
-		_, err = io.Copy(headerWriter, file)
-		check(err)
-		return nil
-	})
-
-	check(err)
-}
-
-func rpc(w http.ResponseWriter, r *http.Request) {
-	var err error
-	var rpc rpcCall
-	defer exitPath(w, "rpc", rpc)
-	bodyBytes, err := ioutil.ReadAll(r.Body)
-	check(err)
-	json.Unmarshal(bodyBytes, &rpc)
-
-	if rpc.Call == "mkdirp" {
-		err = os.MkdirAll(enforcePath(rpc.Args[0]), os.ModePerm)
-	} else if rpc.Call == "mv" {
-		err = os.Rename(enforcePath(rpc.Args[0]), enforcePath(rpc.Args[1]))
-	} else if rpc.Call == "rm" {
-		err = os.RemoveAll(enforcePath(rpc.Args[0]))
-	}
-
-	check(err)
-	w.Write([]byte("ok"))
-}
-
-func enforcePath(p string) string {
-	joined := filepath.Join(rootPath, strings.TrimPrefix(p, *extraPath))
-	fp, err := filepath.Abs(joined)
-	sl, _ := filepath.EvalSymlinks(fp) // err skipped as it would error for unexistent files (RPC check). The actual behaviour is tested below
-
-	// panic if we had a error getting absolute path,
-	// ... or if path doesnt contain the prefix path we expect,
-	// ... or if we're skipping hidden folders, and one is requested,
-	// ... or if we're skipping symlinks, path exists, and a symlink out of bound requested
-	if err != nil || !strings.HasPrefix(fp, rootPath) || *skipHidden && strings.Contains(p, "/.") || !*symlinks && len(sl) > 0 && !strings.HasPrefix(sl, rootPath) {
-		panic(errors.New("invalid path"))
-	}
-
-	return fp
-}
-
-func main() {
-	if flag.Parse(); len(flag.Args()) > 0 {
-		rootPath = flag.Args()[0]
-	} else {
-		fmt.Printf("\nusage: ./gossa ~/directory-to-share\n\n")
-		flag.PrintDefaults()
-		os.Exit(1)
-	}
-
-	var err error
-	rootPath, err = filepath.Abs(rootPath)
-	check(err)
-	server := &http.Server{Addr: *host + ":" + *port, Handler: handler}
-
-	// clean shutdown - used only for coverage test
-	// go func() {
-	// 	sigchan := make(chan os.Signal, 1)
-	// 	signal.Notify(sigchan, os.Interrupt)
-	// 	<-sigchan
-	// 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
-	// 	defer cancel()
-	// 	server.Shutdown(ctx)
-	// }()
-
-	if !*ro {
-		http.HandleFunc(*extraPath+"rpc", rpc)
-		http.HandleFunc(*extraPath+"post", upload)
-	}
-	http.HandleFunc(*extraPath+"zip", zipRPC)
-	http.HandleFunc("/", doContent)
-	handler = http.StripPrefix(*extraPath, http.FileServer(http.Dir(rootPath)))
-
-	fmt.Printf("Gossa starting on directory %s\nListening on http://%s:%s%s\n", rootPath, *host, *port, *extraPath)
-	if err = server.ListenAndServe(); err != http.ErrServerClosed {
-		check(err)
-	}
-}

gossa_embed.go

@@ -1,50 +0,0 @@
-package main
-
-import (
-	_ "embed"
-	"encoding/base64"
-	"flag"
-	"html/template"
-	"strings"
-)
-
-//go:embed gossa-ui/script.js
-var scriptJs string
-
-//go:embed gossa-ui/style.css
-var styleCss string
-
-//go:embed gossa-ui/favicon.svg
-var faviconSvg []byte
-
-//go:embed gossa-ui/ui.tmpl
-var templateStr string
-
-// fill in template
-var templateCss = strings.Replace(templateStr, "css_will_be_here", styleCss, 1)
-var templateCssJs = strings.Replace(templateCss, "js_will_be_here", scriptJs, 1)
-var templateCssJssIcon = strings.Replace(templateCssJs, "favicon_will_be_here", base64.StdEncoding.EncodeToString(faviconSvg), 2)
-var templateParsed, _ = template.New("").Parse(templateCssJssIcon)
-
-type rowTemplate struct {
-	Name string
-	Href template.HTML
-	Size string
-	Ext  string
-}
-
-type pageTemplate struct {
-	Title       template.HTML
-	ExtraPath   template.HTML
-	Ro          bool
-	RowsFiles   []rowTemplate
-	RowsFolders []rowTemplate
-}
-
-var host = flag.String("h", "127.0.0.1", "host to listen to")
-var port = flag.String("p", "8001", "port to listen to")
-var extraPath = flag.String("prefix", "/", "url prefix at which gossa can be reached, e.g. /gossa/ (slashes of importance)")
-var symlinks = flag.Bool("symlinks", false, "follow symlinks \033[4mWARNING\033[0m: symlinks will by nature allow to escape the defined path (default: false)")
-var verb = flag.Bool("verb", false, "verbosity")
-var skipHidden = flag.Bool("k", true, "\nskip hidden files")
-var ro = flag.Bool("ro", false, "read only mode (no upload, rename, move, etc...)")

readme.md

@@ -1,35 +1,29 @@
 gossa
 =============
 
-![e](https://user-images.githubusercontent.com/760637/71449335-790a4200-274a-11ea-80be-4c536fbad8a1.gif)
+![e](https://user-images.githubusercontent.com/760637/64541706-a3163080-d322-11e9-85ef-a4d8001fa6a5.gif)
 
 [![build status](https://github.com/pldubouilh/gossa/workflows/ci/badge.svg)](https://github.com/pldubouilh/gossa/actions)
+[![docker build status](https://img.shields.io/docker/cloud/build/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
 [![docker pulls](https://img.shields.io/docker/pulls/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
 [![github downloads](https://img.shields.io/github/downloads/pldubouilh/gossa/total.svg?logo=github)](https://github.com/pldubouilh/gossa/releases)
 
-a fast and simple webserver for your files, that's dependency-free and with under 250 lines of code, easy to review.
+a fast and simple webserver for your files, that's dependency-free and with under 200 lines of code, easy to review.
 
 a [simple UI](https://github.com/pldubouilh/gossa-ui) comes as default, featuring :
 
-  * 🔍 files/directories browser & handler
+  * 🔍 files/directories browser
-  * 📩 drag-and-drop uploader
+  * 📩 drag-and-drop file/directory uploader
-  * 🥂 fast golang static server
+  * 🗺️ files handling - move/rename/delete
-  * 💾 90s web UI that prints in milliseconds
+  * 📸 picture browser
-  * 📸 video streaming & picture browser
+  * 📽️ video streaming
-  * ✍️ simple note editor
+  * ✍️ simple text editor
-  * ⌨️ keyboard navigation
+  * ⌨️ keyboard shortcuts
-  * 🚀 lightweight and dependency free codebase
+  * 🥂 speed - will easily fill available bandwidth
-  * 🔒 >95% test coverage and reproducible builds
+  * 🔒 safe - easy/secure multi account setup
-  * 💑 easy multi account setup, read-only mode
-  * ✨ PWA enabled
 
 ### build
 built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases) - or simply `make build` this repo.
-all builds are reproducible, checkout the hashes on the release page.
-
-arch linux users can also install through the [user repos](https://aur.archlinux.org/packages/gossa/) - e.g. `yay -S gossa`
-
-automatic boot-time startup can be handled with a user systemd service - see [support](https://github.com/pldubouilh/gossa/tree/master/support)
 
 ### usage
 ```sh
@@ -38,9 +32,6 @@ automatic boot-time startup can be handled with a user systemd service - see [su
 % ./gossa -h 192.168.100.33 ~/storage
 ```
 
-### shortcuts
-press `Ctrl/Cmd + h` to see all the UI/keyboard shortcuts.
-
 ### fancier setups
 release images are pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa), e.g. :
 
@@ -49,6 +40,8 @@ release images are pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gos
 % sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
 ```
 
-in a do-one-thing-well mindset, HTTPS and authentication has been left to middlewares and proxies. [sample caddy configs](https://github.com/pldubouilh/gossa/blob/master/support/) are available to quickly setup multi users setups along with https.
+in a do-one-thing-well mindset, HTTPS and authentication has been left to middlewares and proxies. for instance [caddy](https://caddyserver.com/) handles this very well - have a look at this small [caddy config](https://github.com/pldubouilh/gossa/blob/master/support/Caddyfile) with authentication and option for HTTPS that works along with gossa.
 
+### shortcuts
+the default UI is fully usable by through keyboard/UI shortcuts - press `Ctrl/Cmd + h` to see them all.
 

src/gossa.go

@@ -0,0 +1,198 @@
+package main
+
+import (
+	"encoding/json"
+	"errors"
+	"flag"
+	"fmt"
+	"html"
+	"html/template"
+	"io"
+	"io/ioutil"
+	"log"
+	"net/http"
+	"net/url"
+	"os"
+	"path/filepath"
+	"strconv"
+	"strings"
+)
+
+var host = flag.String("h", "127.0.0.1", "host to listen to")
+var port = flag.String("p", "8001", "port to listen to")
+var history = flag.Bool("history", true, "keep history for paths visited. default location is path/.gossa_history")
+var extraPath = flag.String("prefix", "/", "url prefix at which gossa can be reached, e.g. /gossa/ (slashes of importance)")
+var symlinks = flag.Bool("symlinks", false, "follow symlinks \033[4mWARNING\033[0m: symlinks will by nature allow to escape the defined path (default: false)")
+var verb = flag.Bool("verb", false, "verbosity")
+var skipHidden = flag.Bool("k", true, "\nskip hidden files")
+var initPath = "."
+
+var fs http.Handler
+var page, _ = template.New("pageTemplate").Parse(`template_will_be_here`)
+
+type rowTemplate struct {
+	Name string
+	Href template.HTML
+	Size string
+	Ext  string
+}
+
+type pageTemplate struct {
+	Title       template.HTML
+	ExtraPath   template.HTML
+	RowsFiles   []rowTemplate
+	RowsFolders []rowTemplate
+}
+
+type rpcCall struct {
+	Call string   `json:"call"`
+	Args []string `json:"args"`
+}
+
+func check(e error) {
+	if e != nil {
+		panic(e)
+	}
+}
+
+func exitPath(w http.ResponseWriter, s ...interface{}) {
+	if r := recover(); r != nil {
+		log.Println("error", s, r)
+		w.WriteHeader(500)
+		w.Write([]byte("error"))
+	} else if *verb {
+		log.Println(s...)
+	}
+}
+
+func humanize(bytes int64) string {
+	b := float64(bytes)
+	u := 0
+	for {
+		if b < 1024 {
+			return strconv.FormatFloat(b, 'f', 1, 64) + [9]string{"B", "k", "M", "G", "T", "P", "E", "Z", "Y"}[u]
+		}
+		b = b / 1024
+		u++
+	}
+}
+
+func replyList(w http.ResponseWriter, r *http.Request, fullPath string, path string) {
+	_files, err := ioutil.ReadDir(fullPath)
+	check(err)
+	if !strings.HasSuffix(path, "/") {
+		path += "/"
+	}
+
+	title := "/" + strings.TrimPrefix(path, *extraPath)
+	p := pageTemplate{}
+	if path != *extraPath {
+		p.RowsFolders = append(p.RowsFolders, rowTemplate{"../", "../", "", "folder"})
+	}
+	p.ExtraPath = template.HTML(html.EscapeString(*extraPath))
+	p.Title = template.HTML(html.EscapeString(title))
+
+	for _, el := range _files {
+		if *skipHidden && strings.HasPrefix(el.Name(), ".") {
+			continue
+		}
+		el, _ = os.Stat(fullPath + "/" + el.Name())
+		href := url.PathEscape(el.Name())
+		if el.IsDir() && strings.HasPrefix(href, "/") {
+			href = strings.Replace(href, "/", "", 1)
+		}
+		if el.IsDir() {
+			p.RowsFolders = append(p.RowsFolders, rowTemplate{el.Name() + "/", template.HTML(href), "", "folder"})
+		} else {
+			sl := strings.Split(el.Name(), ".")
+			p.RowsFiles = append(p.RowsFiles, rowTemplate{el.Name(), template.HTML(href), humanize(el.Size()), strings.ToLower(sl[len(sl)-1])})
+		}
+	}
+
+	page.Execute(w, p)
+}
+
+func doContent(w http.ResponseWriter, r *http.Request) {
+	if !strings.HasPrefix(r.URL.Path, *extraPath) {
+		http.Redirect(w, r, *extraPath, 302)
+		return
+	}
+
+	path := html.UnescapeString(r.URL.Path)
+	defer exitPath(w, "get content", path)
+	fullPath := checkPath(path)
+	stat, errStat := os.Stat(fullPath)
+	check(errStat)
+
+	if stat.IsDir() {
+		replyList(w, r, fullPath, path)
+	} else {
+		fs.ServeHTTP(w, r)
+	}
+}
+
+func upload(w http.ResponseWriter, r *http.Request) {
+	path, _ := url.PathUnescape(r.Header.Get("gossa-path"))
+	defer exitPath(w, "upload", path)
+	reader, _ := r.MultipartReader()
+	part, _ := reader.NextPart()
+	dst, _ := os.Create(checkPath(path))
+	io.Copy(dst, part)
+	w.Write([]byte("ok"))
+}
+
+func rpc(w http.ResponseWriter, r *http.Request) {
+	var err error
+	var rpc rpcCall
+	bodyBytes, _ := ioutil.ReadAll(r.Body)
+	json.Unmarshal(bodyBytes, &rpc)
+	defer exitPath(w, "rpc", rpc)
+	ret := "ok"
+
+	if rpc.Call == "mkdirp" {
+		err = os.MkdirAll(checkPath(rpc.Args[0]), os.ModePerm)
+	} else if rpc.Call == "mv" {
+		err = os.Rename(checkPath(rpc.Args[0]), checkPath(rpc.Args[1]))
+	} else if rpc.Call == "rm" {
+		err = os.RemoveAll(checkPath(rpc.Args[0]))
+	}
+
+	check(err)
+	w.Write([]byte(ret))
+}
+
+func checkPath(p string) string {
+	joined := filepath.Join(initPath, strings.TrimPrefix(p, *extraPath))
+	fp, err := filepath.Abs(joined)
+	sl, _ := filepath.EvalSymlinks(fp)
+
+	if err != nil || !strings.HasPrefix(fp, initPath) || *skipHidden && strings.Contains(p, "/.") || !*symlinks && len(sl) > 0 && !strings.HasPrefix(sl, initPath) {
+		panic(errors.New("invalid path"))
+	}
+
+	return fp
+}
+
+func main() {
+	var err error
+	flag.Usage = func() {
+		fmt.Printf("\nusage: ./gossa ~/directory-to-share\n\n")
+		flag.PrintDefaults()
+	}
+
+	flag.Parse()
+	if len(flag.Args()) > 0 {
+		initPath = flag.Args()[0]
+	}
+
+	initPath, err = filepath.Abs(initPath)
+	check(err)
+
+	http.HandleFunc(*extraPath+"rpc", rpc)
+	http.HandleFunc(*extraPath+"post", upload)
+	http.HandleFunc("/", doContent)
+	fs = http.StripPrefix(*extraPath, http.FileServer(http.Dir(initPath)))
+	fmt.Printf("Gossa startig on directory %s\nListening on http://%s:%s%s\n", initPath, *host, *port, *extraPath)
+	err = http.ListenAndServe(*host+":"+*port, nil)
+	check(err)
+}

src/gossa_test.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"archive/zip"
 	"bytes"
 	"fmt"
 	"io/ioutil"
@@ -9,6 +8,7 @@ import (
 	"regexp"
 	"strings"
 	"testing"
+	"time"
 )
 
 func dieMaybe(t *testing.T, err error) {
@@ -22,29 +22,11 @@ func trimSpaces(str string) string {
 	return space.ReplaceAllString(str, " ")
 }
 
-func getRaw(t *testing.T, url string) []byte {
+func get(t *testing.T, url string) string {
 	resp, err := http.Get(url)
 	dieMaybe(t, err)
 	body, err := ioutil.ReadAll(resp.Body)
 	dieMaybe(t, err)
-	return body
-}
-
-func getZip(t *testing.T, needle string, dest string) (int, bool) {
-	b := getRaw(t, dest)
-	unzipped, err := zip.NewReader(bytes.NewReader(b), int64(len(b)))
-	dieMaybe(t, err)
-	length := len(unzipped.File)
-	for _, file := range unzipped.File {
-		if file.Name == needle {
-			return length, true
-		}
-	}
-	return length, false
-}
-
-func get(t *testing.T, url string) string {
-	body := getRaw(t, url)
 	return trimSpaces(string(body))
 }
 
@@ -102,20 +84,13 @@ func fetchAndTestDefault(t *testing.T, url string) string {
 	return body0
 }
 
-func doTestRegular(t *testing.T, url string, testExtra bool) {
+func doTest(t *testing.T, url string, testExtra bool) {
 	var payload, path, body0, body1, body2 string
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test fetching default path")
 	fetchAndTestDefault(t, url)
 
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test fetching another page")
-	body0 = get(t, url+"/hols")
-	if !strings.Contains(body0, "glasgow.jpg") {
-		t.Fatal("fetching a subfolder failed")
-	}
-
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test fetching an invalid path - redirected to root")
 	fetchAndTestDefault(t, url+"../../")
@@ -138,30 +113,6 @@ func doTestRegular(t *testing.T, url string, testExtra bool) {
 		fetchAndTestDefault(t, url+path) // extra path will just redirect to root dir
 	}
 
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test zipping of folder 中文")
-	len, foundFile := getZip(t, "檔案.html", url+"zip?zipPath=%2F%E4%B8%AD%E6%96%87%2F&zipName=%E4%B8%AD%E6%96%87")
-	if len != 1 || !foundFile {
-		t.Fatal("invalid zip generated")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test zipping of folder with hidden file")
-	_, foundHidden := getZip(t, ".hidden-folder/some-file", url+"zip?zipPath=%2fhols%2f&zipName=hols")
-	if foundHidden && !testExtra {
-		t.Fatal("invalid zip generated - shouldnt contain hidden folder")
-	} else if !foundHidden && testExtra {
-		t.Fatal("invalid zip generated - should contain hidden folder")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test zip invalid path")
-	body0 = get(t, url+"zip?zipPath=%2Ftmp&zipName=subdir")
-	println(body0)
-	if body0 != `error` {
-		t.Fatal("zip passed for invalid path")
-	}
-
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test mkdir rpc")
 	body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/AAA"]}`)
@@ -223,20 +174,12 @@ func doTestRegular(t *testing.T, url string, testExtra bool) {
 
 	// ~~~~~~~~~~~~~~~~~
 	fmt.Println("\r\n~~~~~~~~~~ test symlink, should succeed: ", testExtra)
-	body0 = get(t, url+"/support/")
+	body0 = get(t, url+"/support/readme.md")
-	hasListing := strings.Contains(body0, `readme.md`)
+	hasReadme := strings.Contains(body0, `the master branch is automatically built and pushed`)
-	body1 = get(t, url+"/support/readme.md")
-	hasReadme := strings.Contains(body1, `the master branch is automatically built and pushed`)
-
 	if !testExtra && hasReadme {
-		t.Fatal("error symlink file reached where illegal")
+		t.Fatal("error symlink reached where illegal")
 	} else if testExtra && !hasReadme {
-		t.Fatal("error symlink file unreachable")
+		t.Fatal("error symlink unreachable")
-	}
-	if !testExtra && hasListing {
-		t.Fatal("error symlink folder reached where illegal")
-	} else if testExtra && !hasListing {
-		t.Fatal("error symlink folder unreachable")
 	}
 
 	if testExtra {
@@ -286,87 +229,20 @@ func doTestRegular(t *testing.T, url string, testExtra bool) {
 	if body0 != `ok` {
 		t.Fatal("cleanup errored #2")
 	}
-
-	fmt.Printf("\r\n=========\r\n")
 }
 
-func doTestReadonly(t *testing.T, url string) {
+func TestGetFolder(t *testing.T) {
-	var payload, path, body0, body1 string
+	time.Sleep(6 * time.Second)
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test fetching default path")
-	fetchAndTestDefault(t, url)
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test fetching an invalid path - redirected to root")
-	fetchAndTestDefault(t, url+"../../")
-	fetchAndTestDefault(t, url+"hols/../../")
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test fetching regular files")
-	body0 = get(t, url+"subdir_with%20space/file_with%20space.html")
-	body1 = get(t, url+"fancy-path/a")
-	if body0 != `<b>spacious!!</b> ` || body1 != `fancy! ` {
-		t.Fatal("fetching a regular file errored")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test fetching a invalid file")
-	path = "../../../../../../../../../../etc/passwd"
-	if get(t, url+path) != `error` {
-		t.Fatal("fetching a invalid file didnt errored")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test mkdir rpc")
-	body0 = postJSON(t, url+"rpc", `{"call":"mkdirp","args":["/AAA"]}`)
-	if body0 == `ok` {
-		t.Fatal("mkdir rpc passed - should not be allowed")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test post file")
-	path = "%2F%E1%84%92%E1%85%A1%20%E1%84%92%E1%85%A1" // "하 하" encoded
-	payload = "123 하"
-	body0 = postDummyFile(t, url, path, payload)
-	get(t, url+path)
-	if body0 == `ok` {
-		t.Fatal("post file passed - should not be allowed")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test mv rpc")
-	body0 = postJSON(t, url+"rpc", `{"call":"mv","args":["/AAA", "/hols/AAA"]}`)
-	fetchAndTestDefault(t, url)
-	if body0 == `ok` {
-		t.Fatal("mv rpc passed - should not be allowed")
-	}
-
-	// ~~~~~~~~~~~~~~~~~
-	fmt.Println("\r\n~~~~~~~~~~ test rm rpc & cleanup")
-	body0 = postJSON(t, url+"rpc", `{"call":"rm","args":["/hols/AAA"]}`)
-	if body0 == `ok` {
-		t.Fatal("cleanup passed - should not be allowed")
-	}
-
-	fmt.Printf("\r\n=========\r\n")
-}
-
-func TestNormal(t *testing.T) {
 	fmt.Println("========== testing normal path ============")
-	doTestRegular(t, "http://127.0.0.1:8001/", false)
+	url := "http://127.0.0.1:8001/"
-}
+	doTest(t, url, false)
 
-func TestExtra(t *testing.T) {
+	fmt.Printf("\r\n=========\r\n")
-	fmt.Println("========== testing extras options ============")
+	time.Sleep(10 * time.Second)
-	doTestRegular(t, "http://127.0.0.1:8001/fancy-path/", true)
-}
 
-func TestRo(t *testing.T) {
+	url = "http://127.0.0.1:8001/fancy-path/"
-	fmt.Println("========== testing read only ============")
+	fmt.Println("========== testing at fancy path ============")
-	doTestReadonly(t, "http://127.0.0.1:8001/")
+	doTest(t, url, true)
-}
 
-func TestRunMain(t *testing.T) {
+	fmt.Printf("\r\n=========\r\n")
-	main()
 }

support/Caddyfile

@@ -0,0 +1,8 @@
+# Caddy config
+# to enable https just set a valid domain (e.g. mydomain.com) instead of :8080 - how simple !
+# authentication has been setup with 2 users, alice and bob
+
+:8080
+basicauth / alice paul
+basicauth / bob dylan
+proxy / 127.0.0.1:8001

support/build.Dockerfile

@@ -1,10 +1,11 @@
-FROM golang:1.18 as builder
+FROM golang:latest as builder
 COPY . /gossaSrc
 RUN cd /gossaSrc && make
 
-FROM alpine:3.15
+FROM alpine
-ENV UID="1000" GID="1000" HOST="0.0.0.0" PORT="8001" PREFIX="/" FOLLOW_SYMLINKS="false" SKIP_HIDDEN_FILES="true" DATADIR="/shared" READONLY="false" VERB="false"
+ENV UID="1000" GID="1000" HOST="0.0.0.0" PORT="8001" PREFIX="/" FOLLOW_SYMLINKS="false" SKIP_HIDDEN_FILES="true" DATADIR="/shared"
+EXPOSE 8001
 RUN apk add --no-cache su-exec
-COPY ./support/entrypoint.sh /entrypoint.sh
 COPY --from=builder /gossaSrc/gossa /gossa
-ENTRYPOINT "/entrypoint.sh"
+RUN echo -e 'exec su-exec ${UID}:${GID} /gossa -h ${HOST} -p ${PORT} -k=${SKIP_HIDDEN_FILES} --symlinks=${FOLLOW_SYMLINKS} --prefix=${PREFIX} ${DATADIR}'>> /start.sh
+ENTRYPOINT [ "sh", "/start.sh" ]

support/caddy.Dockerfile

@@ -0,0 +1,8 @@
+FROM pldubouilh/gossa
+
+RUN apk update && apk add curl ca-certificates caddy
+
+ENV UID="1000" GID="1000" HOST="127.0.0.1" PORT="8001" PREFIX="/" FOLLOW_SYMLINKS="false" SKIP_HIDDEN_FILES="true" DATADIR="/shared"
+EXPOSE 443
+RUN echo -e 'exec su-exec ${UID}:${GID} /gossa -h ${HOST} -p ${PORT} -k=${SKIP_HIDDEN_FILES} --symlinks=${FOLLOW_SYMLINKS} --prefix=${PREFIX} ${DATADIR} & \n caddy' > /start.sh
+ENTRYPOINT [ "sh", "/start.sh" ]

support/entrypoint.sh

@@ -1,2 +0,0 @@
-#!/bin/sh
-exec su-exec ${UID}:${GID} /gossa -h ${HOST} -p ${PORT} -k=${SKIP_HIDDEN_FILES} -ro=${READONLY} --symlinks=${FOLLOW_SYMLINKS} --prefix=${PREFIX} --verb=${VERB} ${DATADIR}

support/readme.md

@@ -1,126 +1,27 @@
-## run as a service
-
-use the `service` file provided here to use as a systemd service.
-
-```sh
-# edit service file
-
-# copy over our service, and start. Notice no sudo with systemctl command !
-% mkdir -p ~/.config/systemd/user/
-% cp service ~/.config/systemd/user/gossa.service
-% systemctl --user start gossa
-
-# enable at boot time
-% systemctl --user enable gossa
-```
-
-## run with docker
-
 the master branch is automatically built and pushed to [dockerhub](https://hub.docker.com/r/pldubouilh/gossa) under `pldubouilh/gossa`.
 
 ```sh
 # pull from dockerhub and run
-% mkdir ~/LocalDirToShare
 % sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
-
-# options are settable through env. variabes. all the options are the build.Dockerfile
-% sudo docker run -e PREFIX="/gossa/" -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
 ```
 
 if you prefer building the image yourself :
 
 ```sh
 # build gossa within a build container, needs to be ran within the sources, ../ from here, and run
-% mkdir ~/LocalDirToShare
 % docker build -t gossa -f support/build.Dockerfile .
 % sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa
 ```
 
-a docker-compose example image is also provided. running docker compose should be straightforward : `docker-compose up .` have a look in `docker-compose.yml` for further configuration.
+the options are settable through environment variables that can be passed starting off the docker image.
 
-## multi-account setup
+a fancy docker image using [Caddy](https://caddyserver.com/) is also provided. have a look at the simple config file `Caddyfile`, it shows how to use http basic authentication, and automatic TLS for hands-free https 🎉
-
-authentication / user routing has been left out of the design of gossa, as simple tools are already available for this purpose. [caddy](https://caddyserver.com/v1/) is used here as an example, but other proxy can be used in a similar fashion.
-
-### example 1 root, multiple read-only users
-
-this sample caddy config will
- + enable https on the domain myserver.com
- + password protect the access
- + route the root user requests to 1 gossa instance
- + route user1 and user2 requests to a readonly gossa instance
 
 ```sh
-myserver.com
+# checkout the caddy config, build, and run docker image
-
+% vim caddy.Dockerfile
-# proxy regular and read only instance
+% docker build -t gossa-caddy -f caddy.Dockerfile .
-proxy /   127.0.0.1:8001
+% sudo docker run -v ~/LocalDirToShare:/shared -v `pwd`/Caddyfile:/Caddyfile --net=host gossa-caddy
-proxy /ro 127.0.0.1:8002 { without /ro }
-
-# reroute non-root user to read-only
-# cm9... is the output of `printf "root:password" | base64`
-rewrite {
-  if {>Authorization} not "Basic cm9vdDpwYXNzd29yZA=="
-  to /ro/{path}
-}
-
-# gate access
-basicauth / root     password
-basicauth / ro_user1 passworduser1
-basicauth / ro_user2 passworduser2
 ```
 
-then simply start the 2 gossa instances, and caddy
+a docker-compose example image is also provided. running docker compose should be straightforward : `docker-compose up .` have a look in `docker-compose.yml` for further configuration.
-
-```sh
-# start an instance in readonly
-% ./gossa -ro=true -p 8002 ~/folder &
-
-# start an instance with access to hidden files
-% ./gossa -k=false  -p 8001 ~/folder &
-
-# start caddy
-% ./caddy
-```
-
-### example 2 users on 2 different folders
-
-this sample caddy config will
- + enable https on the domain myserver.com
- + password protect the access
- + route user1 to own folder
- + route user2 to own folder
- + share a folder between 2 users with a symlink
-
-```sh
-myserver.com
-
-proxy /user1 127.0.0.1:8001 { without /user1 }
-proxy /user2 127.0.0.1:8002 { without /user2 }
-
-basicauth / user1 passworduser1
-basicauth / user2 passworduser2
-
-rewrite {
-  if {>Authorization} is "Basic dXNlcjE6cGFzc3dvcmR1c2VyMQ=="
-  to /user1/{path}
-}
-
-rewrite {
-  if {>Authorization} is "Basic dXNlcjI6cGFzc3dvcmR1c2VyMg=="
-  to /user2/{path}
-}
-```
-
-start 2 gossa instances, and caddy
-
-```sh
-# create symlink to share folder between 2 users
-% ln -s /path/shared test/user1
-% ln -s /path/shared test/user2
-
-# start gossa & caddy
-% ./gossa -p 8001 -symlinks=true test/user1 &
-% ./gossa -p 8002 -symlinks=true test/user2 &
-% ./caddy
-```

support/service

@@ -1,13 +0,0 @@
-[Unit]
-Description=Gossa service for mytestfolder
-Wants=network-online.target
-After=network-online.target
-
-# note: absolute paths are necessary here
-[Service]
-ExecStart=/usr/bin/gossa /home/joe/mytestfolder
-Restart=always
-RestartSec=30
-
-[Install]
-WantedBy=multi-user.target

test-fixture/.some-hidden-file

@@ -1 +0,0 @@
-hidden !

test-fixture/compress/hols-sym

@@ -1 +0,0 @@
-../hols

test-fixture/hols/.hidden-folder/some-file

@@ -1 +0,0 @@
-I'm hidden by my directory!