Desktop integration (stashapp#2073)

* Open stash in system tray on Windows/MacOS
* Add desktop notifications
* MacOS Bundling
* Add binary icon

Co-authored-by: WithoutPants <[email protected]>

Author: kermieisinthehouse

.github/workflows/build.yml

@@ -13,7 +13,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  COMPILER_IMAGE: stashapp/compiler:5
+  COMPILER_IMAGE: stashapp/compiler:6
 
 jobs:
   build:
@@ -91,12 +91,11 @@ jobs:
     - name: Compile for all supported platforms
       run: |
         docker exec -t build /bin/bash -c "make cross-compile-windows"
-        docker exec -t build /bin/bash -c "make cross-compile-osx-intel"
-        docker exec -t build /bin/bash -c "make cross-compile-osx-applesilicon"
+        docker exec -t build /bin/bash -c "make cross-compile-macos"
         docker exec -t build /bin/bash -c "make cross-compile-linux"
         docker exec -t build /bin/bash -c "make cross-compile-linux-arm64v8"
         docker exec -t build /bin/bash -c "make cross-compile-linux-arm32v7"
-        docker exec -t build /bin/bash -c "make cross-compile-pi"
+        docker exec -t build /bin/bash -c "make cross-compile-linux-arm32v6"
 
     - name: Cleanup build container
       run: docker rm -f -v build
@@ -121,8 +120,8 @@ jobs:
       if: ${{ github.event_name == 'pull_request' && github.base_ref != 'refs/heads/develop' && github.base_ref != 'refs/heads/master'}}
       uses: actions/upload-artifact@v2
       with:
-        name: stash-osx
-        path: dist/stash-osx
+        name: Stash-macos.zip
+        path: dist/Stash-macos.zip
 
     - name: Upload Linux binary
       # only upload binaries for pull requests
@@ -145,13 +144,12 @@ jobs:
         automatic_release_tag: latest_develop
         title: "${{ env.STASH_VERSION }}: Latest development build"
         files: |
-          dist/stash-osx
-          dist/stash-osx-applesilicon
+          dist/Stash-macos.zip
           dist/stash-win.exe
           dist/stash-linux
           dist/stash-linux-arm64v8
           dist/stash-linux-arm32v7
-          dist/stash-pi
+          dist/stash-linux-arm32v6
           CHECKSUMS_SHA1
 
     - name: Master release
@@ -161,13 +159,12 @@ jobs:
         token: "${{ secrets.GITHUB_TOKEN }}"
         allow_override: true
         files: |
-          dist/stash-osx
-          dist/stash-osx-applesilicon
+          dist/Stash-macos.zip
           dist/stash-win.exe
           dist/stash-linux
           dist/stash-linux-arm64v8
           dist/stash-linux-arm32v7
-          dist/stash-pi
+          dist/stash-linux-arm32v6
           CHECKSUMS_SHA1
         gzip: false
 

.github/workflows/golangci-lint.yml

@@ -9,7 +9,7 @@ on:
   pull_request:
 
 env:
-  COMPILER_IMAGE: stashapp/compiler:5
+  COMPILER_IMAGE: stashapp/compiler:6
 
 jobs:
   golangci:

Makefile

@@ -1,19 +1,24 @@
-IS_WIN =
+IS_WIN_SHELL =
 ifeq (${SHELL}, sh.exe)
-  IS_WIN = true
+  IS_WIN_SHELL = true
 endif
 ifeq (${SHELL}, cmd)
-  IS_WIN = true
+  IS_WIN_SHELL = true
 endif
 
-ifdef IS_WIN
+ifdef IS_WIN_SHELL
   SEPARATOR := &&
   SET := set
 else
   SEPARATOR := ;
   SET := export
 endif
 
+IS_WIN_OS =
+ifeq ($(OS),Windows_NT)
+	IS_WIN_OS = true
+endif
+
 # set LDFLAGS environment variable to any extra ldflags required
 # set OUTPUT to generate a specific binary name
 
@@ -46,9 +51,13 @@ ifndef OFFICIAL_BUILD
 endif
 
 build: pre-build
+ifdef IS_WIN_OS
+PLATFORM_SPECIFIC_LDFLAGS := -H windowsgui
+endif
+build:
 	$(eval LDFLAGS := $(LDFLAGS) -X 'github.com/stashapp/stash/pkg/api.version=$(STASH_VERSION)' -X 'github.com/stashapp/stash/pkg/api.buildstamp=$(BUILD_DATE)' -X 'github.com/stashapp/stash/pkg/api.githash=$(GITHASH)')
-	$(eval LDFLAGS := $(LDFLAGS) -X 'github.com/stashapp/stash/pkg/api.officialBuild=$(OFFICIAL_BUILD)')
-	go build $(OUTPUT) -mod=vendor -v -tags "sqlite_omit_load_extension osusergo netgo" $(GO_BUILD_FLAGS) -ldflags "$(LDFLAGS) $(EXTRA_LDFLAGS)"
+	$(eval LDFLAGS := $(LDFLAGS) -X 'github.com/stashapp/stash/pkg/manager/config.officialBuild=$(OFFICIAL_BUILD)')
+	go build $(OUTPUT) -mod=vendor -v -tags "sqlite_omit_load_extension osusergo netgo" $(GO_BUILD_FLAGS) -ldflags "$(LDFLAGS) $(EXTRA_LDFLAGS) $(PLATFORM_SPECIFIC_LDFLAGS)"
 
 # strips debug symbols from the release build
 build-release: EXTRA_LDFLAGS := -s -w
@@ -65,23 +74,38 @@ cross-compile-windows: export GOARCH := amd64
 cross-compile-windows: export CC := x86_64-w64-mingw32-gcc
 cross-compile-windows: export CXX := x86_64-w64-mingw32-g++
 cross-compile-windows: OUTPUT := -o dist/stash-win.exe
+cross-compile-windows: PLATFORM_SPECIFIC_LDFLAGS := -H windowsgui
 cross-compile-windows: build-release-static
 
-cross-compile-osx-intel: export GOOS := darwin
-cross-compile-osx-intel: export GOARCH := amd64
-cross-compile-osx-intel: export CC := o64-clang
-cross-compile-osx-intel: export CXX := o64-clang++
-cross-compile-osx-intel: OUTPUT := -o dist/stash-osx
+cross-compile-macos-intel: export GOOS := darwin
+cross-compile-macos-intel: export GOARCH := amd64
+cross-compile-macos-intel: export CC := o64-clang
+cross-compile-macos-intel: export CXX := o64-clang++
+cross-compile-macos-intel: OUTPUT := -o dist/stash-macos-intel
 # can't use static build for OSX
-cross-compile-osx-intel: build-release
+cross-compile-macos-intel: build-release
 
-cross-compile-osx-applesilicon: export GOOS := darwin
-cross-compile-osx-applesilicon: export GOARCH := arm64
-cross-compile-osx-applesilicon: export CC := oa64e-clang
-cross-compile-osx-applesilicon: export CXX := oa64e-clang++
-cross-compile-osx-applesilicon: OUTPUT := -o dist/stash-osx-applesilicon
+cross-compile-macos-applesilicon: export GOOS := darwin
+cross-compile-macos-applesilicon: export GOARCH := arm64
+cross-compile-macos-applesilicon: export CC := oa64e-clang
+cross-compile-macos-applesilicon: export CXX := oa64e-clang++
+cross-compile-macos-applesilicon: OUTPUT := -o dist/stash-macos-applesilicon
 # can't use static build for OSX
-cross-compile-osx-applesilicon: build-release
+cross-compile-macos-applesilicon: build-release
+
+cross-compile-macos: 
+	rm -rf dist/Stash.app dist/Stash-macos.zip
+	make cross-compile-macos-applesilicon
+	make cross-compile-macos-intel
+	# Combine into one universal binary
+	lipo -create -output dist/stash-macos-universal dist/stash-macos-intel dist/stash-macos-applesilicon
+	rm dist/stash-macos-intel dist/stash-macos-applesilicon
+	# Place into bundle and zip up
+	cp -R scripts/macos-bundle dist/Stash.app
+	mkdir dist/Stash.app/Contents/MacOS
+	mv dist/stash-macos-universal dist/Stash.app/Contents/MacOS/stash
+	cd dist && zip -r Stash-macos.zip Stash.app && cd ..
+	rm -rf dist/Stash.app
 
 cross-compile-linux: export GOOS := linux
 cross-compile-linux: export GOARCH := amd64
@@ -101,21 +125,20 @@ cross-compile-linux-arm32v7: export CC := arm-linux-gnueabihf-gcc
 cross-compile-linux-arm32v7: OUTPUT := -o dist/stash-linux-arm32v7
 cross-compile-linux-arm32v7: build-release-static
 
-cross-compile-pi: export GOOS := linux
-cross-compile-pi: export GOARCH := arm
-cross-compile-pi: export GOARM := 6
-cross-compile-pi: export CC := arm-linux-gnueabi-gcc
-cross-compile-pi: OUTPUT := -o dist/stash-pi
-cross-compile-pi: build-release-static
+cross-compile-linux-arm32v6: export GOOS := linux
+cross-compile-linux-arm32v6: export GOARCH := arm
+cross-compile-linux-arm32v6: export GOARM := 6
+cross-compile-linux-arm32v6: export CC := arm-linux-gnueabi-gcc
+cross-compile-linux-arm32v6: OUTPUT := -o dist/stash-linux-arm32v6
+cross-compile-linux-arm32v6: build-release-static
 
 cross-compile-all:
 	make cross-compile-windows
-	make cross-compile-osx-intel
-	make cross-compile-osx-applesilicon
+	make cross-compile-macos
 	make cross-compile-linux
 	make cross-compile-linux-arm64v8
 	make cross-compile-linux-arm32v7
-	make cross-compile-pi
+	make cross-compile-linux-arm32v6
 
 # Regenerates GraphQL files
 generate: generate-backend generate-frontend

README.md

@@ -22,12 +22,14 @@ For further information you can [read the in-app manual](ui/v2.5/src/docs/en).
 
 <img src="docs/readme_assets/windows_logo.svg" width="100%" height="75"> Windows | <img src="docs/readme_assets/mac_logo.svg" width="100%" height="75"> MacOS| <img src="docs/readme_assets/linux_logo.svg" width="100%" height="75"> Linux | <img src="docs/readme_assets/docker_logo.svg" width="100%" height="75"> Docker
 :---:|:---:|:---:|:---:
-[Latest Release](https://github.com/stashapp/stash/releases/latest/download/stash-win.exe) <br /> <sup><sub>[Development Preview](https://github.com/stashapp/stash/releases/download/latest_develop/stash-win.exe)</sub></sup> | [Latest Release (Apple Silicon)](https://github.com/stashapp/stash/releases/latest/download/stash-osx-applesilicon) <br /> <sup><sub>[Development Preview (Apple Silicon)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-osx-applesilicon)</sub></sup> <br>[Latest Release (Intel)](https://github.com/stashapp/stash/releases/latest/download/stash-osx) <br /> <sup><sub>[Development Preview (Intel)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-osx)</sub></sup> | [Latest Release (amd64)](https://github.com/stashapp/stash/releases/latest/download/stash-linux) <br /> <sup><sub>[Development Preview (amd64)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-linux)</sub></sup> <br /> [More Architectures...](https://github.com/stashapp/stash/releases/latest) | [Instructions](docker/production/README.md) <br /> <sup><sub> [Sample docker-compose.yml](docker/production/docker-compose.yml)</sub></sup>
+[Latest Release](https://github.com/stashapp/stash/releases/latest/download/stash-win.exe) <br /> <sup><sub>[Development Preview](https://github.com/stashapp/stash/releases/download/latest_develop/stash-win.exe)</sub></sup> | [Latest Release](https://github.com/stashapp/stash/releases/latest/download/Stash-macos.app.zip) <br /> <sup><sub>[Development Preview](https://github.com/stashapp/stash/releases/download/latest_develop/Stash-macos.app.zip)</sub></sup> | [Latest Release (amd64)](https://github.com/stashapp/stash/releases/latest/download/stash-linux) <br /> <sup><sub>[Development Preview (amd64)](https://github.com/stashapp/stash/releases/download/latest_develop/stash-linux)</sub></sup> <br /> [More Architectures...](https://github.com/stashapp/stash/releases/latest) | [Instructions](docker/production/README.md) <br /> <sup><sub> [Sample docker-compose.yml](docker/production/docker-compose.yml)</sub></sup>
 
 ## Getting Started
-Run the executable (double click the exe on windows or run `./stash-osx` / `./stash-linux` from the terminal on macOS / Linux) to get started.
+Run the executable by double-clicking it.
 
-*Note for Windows users:* Running the app might present a security prompt since the binary isn't yet signed.  Bypass this by clicking "more info" and then the "run anyway" button.
+*Note for Mac users:* Running the app will present a security prompt since the binary isn't yet signed. Bypass this by right (ctrl) clicking on the app and hitting "Open", then "Open" in the next popup.
+
+*Note for Windows users:* Running the app might present a security prompt since the binary isn't yet signed. Bypass this by clicking "more info" and then the "run anyway" button.
 
 #### FFMPEG
 Stash requires ffmpeg. If you don't have it installed, Stash will download a copy for you. It is recommended that Linux users install `ffmpeg` from their distro's package manager.

docker/compiler/Dockerfile

@@ -20,7 +20,7 @@ RUN apt-get update && \
 	gcc-arm-linux-gnueabi libc-dev-armel-cross linux-libc-dev-armel-cross \
     gcc-arm-linux-gnueabihf libc-dev-armhf-cross \
     gcc-aarch64-linux-gnu libc-dev-arm64-cross \
-	nodejs yarn --no-install-recommends || exit 1; \
+	nodejs yarn zip --no-install-recommends || exit 1; \
 	rm -rf /var/lib/apt/lists/*;
 
 # Cross compile setup

docker/compiler/Makefile

@@ -1,6 +1,6 @@
 user=stashapp
 repo=compiler
-version=5
+version=6
 
 latest:
 	docker build -t ${user}/${repo}:latest .

docker/compiler/README.md

@@ -1,5 +1,3 @@
 Modified from https://github.com/bep/dockerfiles/tree/master/ci-goreleaser
 
-When the dockerfile is changed, the version number should be incremented in the Makefile and the new version tag should be pushed to docker hub. The `scripts/cross-compile.sh` script should also be updated to use the new version number tag, and `.travis.yml` needs to be updated to pull the correct image tag.
-
-A MacOS univeral binary can be created using `lipo -create -output stash-osx-universal stash-osx stash-osx-applesilicon`, available in the image.
+When the dockerfile is changed, the version number should be incremented in the Makefile and the new version tag should be pushed to docker hub. The `scripts/cross-compile.sh` script should also be updated to use the new version number tag, and the github workflow files need to be updated to pull the correct image tag.

go.mod

@@ -38,15 +38,20 @@ require (
 	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5
 	golang.org/x/image v0.0.0-20210220032944-ac19c3e999fb
 	golang.org/x/net v0.0.0-20211123203042-d83791d6bcd9
-	golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf
-	golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b // indirect
+	golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e
+	golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b
 	golang.org/x/text v0.3.7
 	golang.org/x/tools v0.1.5 // indirect
 	gopkg.in/sourcemap.v1 v1.0.5 // indirect
 	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
+	github.com/apenwarr/fixconsole v0.0.0-20191012055117-5a9f6489cc29
+	github.com/go-chi/httplog v0.2.1
+	github.com/go-toast/toast v0.0.0-20190211030409-01e6764cf0a4
+	github.com/kermieisinthehouse/gosx-notifier v0.1.1
+	github.com/kermieisinthehouse/systray v1.2.3
 	github.com/lucasb-eyer/go-colorful v1.2.0
 	github.com/vearutop/statigz v1.1.6
 	github.com/vektah/gqlparser/v2 v2.0.1
@@ -55,10 +60,12 @@ require (
 require (
 	github.com/agnivade/levenshtein v1.1.0 // indirect
 	github.com/antchfx/xpath v1.2.0 // indirect
+	github.com/apenwarr/w32 v0.0.0-20190407065021-aa00fece76ab // indirect
 	github.com/chromedp/sysutil v1.0.0 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/go-chi/chi/v5 v5.0.0 // indirect
 	github.com/gobwas/httphead v0.1.0 // indirect
 	github.com/gobwas/pool v0.2.1 // indirect
 	github.com/gobwas/ws v1.1.0-rc.5 // indirect
@@ -77,10 +84,11 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect
+	github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/rs/zerolog v1.18.0 // indirect
+	github.com/rs/zerolog v1.18.1-0.20200514152719-663cbb4c8469 // indirect
 	github.com/russross/blackfriday/v2 v2.0.1 // indirect
 	github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
 	github.com/spf13/cast v1.4.1 // indirect