chore: update build action

Bumps [lucide-react](https://github.com/lucide-icons/lucide/tree/HEAD/packages/lucide-react) from 0.438.0 to 0.454.0.
- [Release notes](https://github.com/lucide-icons/lucide/releases)
- [Commits](https://github.com/lucide-icons/lucide/commits/0.454.0/packages/lucide-react)

---
updated-dependencies:
- dependency-name: lucide-react
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.dockerignore

@@ -0,0 +1 @@
+*/*/node_modules

.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    commit-message:
+      prefix: "chore"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: npm
+    commit-message:
+      prefix: "chore"
+    directory: "/frontend/web"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: npm
+    commit-message:
+      prefix: "chore"
+    directory: "/frontend/extension"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "gomod"
+    commit-message:
+      prefix: "chore"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/backend-tests.yml

@@ -0,0 +1,44 @@
+name: Backend Test
+
+on:
+  push:
+    branches:
+      - main
+      - "release/v*.*.*"
+  pull_request:
+    branches: [main]
+
+jobs:
+  go-static-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.23
+          check-latest: true
+          cache: true
+      - name: Verify go.mod is tidy
+        run: |
+          go mod tidy
+          git diff --exit-code
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.61.0
+          args: --verbose --timeout=3m
+          skip-cache: true
+
+  go-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.23
+          check-latest: true
+          cache: true
+      - name: Run all tests
+        run: go test -v ./... | tee test.log; exit ${PIPESTATUS[0]}
+      - name: Pretty print tests running time
+        run: grep --color=never -e '--- PASS:' -e '--- FAIL:' test.log | sed 's/[:()]//g' | awk '{print $2,$3,$4}' | sort -t' ' -nk3 -r | awk '{sum += $3; print $1,$2,$3,sum"s"}'

.github/workflows/build-and-push-release-image.yml

@@ -1,44 +1,83 @@
-name: build-and-push-release-image
+name: build-and-push-stable-image
 
 on:
   push:
-    branches:
-      # Run on pushing branches like `release/1.0.0`
-      - "release/*.*.*"
+    tags:
+      # Match stable and rc versions, such as 'v1.0.0' or 'v0.23.0-rc.0'
+      - "v*.*.*"
+      - "v*.*.*-rc.*"
 
 jobs:
-  build-and-push-release-image:
+  build-and-push-stable-image:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Extract build args
-        # Extract version from branch name
-        # Example: branch name `release/1.0.0` sets up env.VERSION=1.0.0
+        # Extract version number and check if it's an rc version
         run: |
-          echo "VERSION=${GITHUB_REF_NAME#release/}" >> $GITHUB_ENV
+          if [[ "${GITHUB_REF_NAME}" =~ -rc ]]; then
+            echo "PRE_RELEASE=true" >> $GITHUB_ENV
+          else
+            echo "PRE_RELEASE=false" >> $GITHUB_ENV
+          fi
+          echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
 
       - name: Login to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
-          username: stevenlgtm
+          username: yourselfhosted
           password: ${{ secrets.DOCKER_TOKEN }}
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           install: true
+          version: v0.9.1
+
+      # Metadata for stable versions
+      - name: Docker meta for stable
+        id: meta-stable
+        if: env.PRE_RELEASE == 'false'
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            yourselfhosted/slash
+          tags: |
+            type=semver,pattern={{version}},value=${{ env.VERSION }}
+            type=raw,value=stable
+          flavor: |
+            latest=true
+          labels: |
+            org.opencontainers.image.version=${{ env.VERSION }}
+
+      # Metadata for rc versions
+      - name: Docker meta for rc
+        id: meta-rc
+        if: env.PRE_RELEASE == 'true'
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            yourselfhosted/slash
+          tags: |
+            type=raw,value=${{ env.VERSION }}
+          labels: |
+            org.opencontainers.image.version=${{ env.VERSION }}
 
       - name: Build and Push
         id: docker_build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           context: ./
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: stevenlgtm/slash:latest, stevenlgtm/slash:${{ env.VERSION }}
+          tags: ${{ steps.meta-stable.outputs.tags || steps.meta-rc.outputs.tags }}
+          labels: ${{ steps.meta-stable.outputs.labels || steps.meta-rc.outputs.labels }}

.github/workflows/build-and-push-test-image.yml

@@ -8,30 +8,30 @@ jobs:
   build-and-push-test-image:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Login to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
-          username: stevenlgtm
+          username: yourselfhosted
           password: ${{ secrets.DOCKER_TOKEN }}
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           install: true
           version: v0.9.1
 
       - name: Build and Push
         id: docker_build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           context: ./
           file: ./Dockerfile
           platforms: linux/amd64
           push: true
-          tags: stevenlgtm/slash:test
+          tags: yourselfhosted/slash:test

.github/workflows/build-artifacts.yml

@@ -0,0 +1,33 @@
+name: Build artifacts
+
+on:
+  push:
+    tags:
+      - "*"
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.23
+          check-latest: true
+          cache: true
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro'
+          distribution: goreleaser
+          # 'latest', 'nightly', or a semver
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/extension-test.yml

@@ -0,0 +1,48 @@
+name: Extension Test
+
+on:
+  push:
+    branches:
+      - main
+      - "release/v*.*.*"
+  pull_request:
+    branches: [main]
+    paths:
+      - "frontend/extension/**"
+
+jobs:
+  eslint-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4.0.0
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: pnpm
+          cache-dependency-path: "frontend/extension/pnpm-lock.yaml"
+      - run: pnpm install
+        working-directory: frontend/extension
+      - name: Run eslint check
+        run: pnpm lint
+        working-directory: frontend/extension
+
+  extension-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4.0.0
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: pnpm
+          cache-dependency-path: "frontend/extension/pnpm-lock.yaml"
+      - run: pnpm install
+        working-directory: frontend/extension
+      - name: Run extension build
+        run: pnpm build
+        working-directory: frontend/extension

.github/workflows/frontend-test.yml

@@ -0,0 +1,51 @@
+name: Frontend Test
+
+on:
+  push:
+    branches:
+      - main
+      - "release/v*.*.*"
+  pull_request:
+    branches: [main]
+    paths:
+      - "frontend/web/**"
+
+jobs:
+  eslint-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4.0.0
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: pnpm
+          cache-dependency-path: "frontend/web/pnpm-lock.yaml"
+      - run: pnpm install
+        working-directory: frontend/web
+      - name: Run eslint check
+        run: pnpm lint
+        working-directory: frontend/web
+      - name: Run type check
+        run: pnpm type-check
+        working-directory: frontend/web
+
+  frontend-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4.0.0
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: pnpm
+          cache-dependency-path: "frontend/web/pnpm-lock.yaml"
+      - run: pnpm install
+        working-directory: frontend/web
+      - name: Run frontend build
+        run: pnpm build
+        working-directory: frontend/web

.github/workflows/proto-linter.yml

@@ -0,0 +1,34 @@
+name: Proto linter
+
+on:
+  push:
+    branches:
+      - main
+      - "release/v*.*.*"
+  pull_request:
+    branches:
+      - main
+      - "release/*.*.*"
+    paths:
+      - "proto/**"
+
+jobs:
+  lint-protos:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup buf
+        uses: bufbuild/buf-setup-action@v1
+      - name: buf lint
+        uses: bufbuild/buf-lint-action@v1
+        with:
+          input: "proto"
+      - name: buf format
+        run: |
+          if [[ $(buf format -d) ]]; then
+            echo "Run 'buf format -w'"
+            exit 1
+          fi

.github/workflows/tests.yml

@@ -1,80 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches:
-      - main
-      - "release/v*.*.*"
-  pull_request:
-    branches: [main]
-
-jobs:
-  go-static-checks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
-        with:
-          go-version: 1.19
-          check-latest: true
-          cache: true
-      - name: Verify go.mod is tidy
-        run: |
-          go mod tidy
-          git diff --exit-code
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
-        with:
-          args: -v
-          skip-cache: true
-
-  eslint-checks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.4
-        with:
-          version: 8
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "18"
-          cache: pnpm
-          cache-dependency-path: "web/pnpm-lock.yaml"
-      - run: pnpm install
-        working-directory: web
-      - name: Run eslint check
-        run: pnpm lint
-        working-directory: web
-
-  frontend-build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.4
-        with:
-          version: 8
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "18"
-          cache: pnpm
-          cache-dependency-path: "web/pnpm-lock.yaml"
-      - run: pnpm install
-        working-directory: web
-      - name: Run frontend build
-        run: pnpm build
-        working-directory: web
-
-  go-tests:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
-        with:
-          go-version: 1.19
-          check-latest: true
-          cache: true
-      - name: Run all tests
-        run: go test -v ./... | tee test.log; exit ${PIPESTATUS[0]}
-      - name: Pretty print tests running time
-        run: grep --color=never -e '--- PASS:' -e '--- FAIL:' test.log | sed 's/[:()]//g' | awk '{print $2,$3,$4}' | sort -t' ' -nk3 -r | awk '{sum += $3; print $1,$2,$3,sum"s"}'

.gitignore

@@ -4,10 +4,13 @@
 # temp folder
 tmp
 
-# Frontend asset
-web/dist
-
 # build folder
 build
 
 .DS_Store
+
+node_modules
+
+.env
+
+dist/

.golangci.yaml

@@ -1,5 +1,6 @@
 linters:
   enable:
+    - errcheck
     - goimports
     - revive
     - govet
@@ -10,17 +11,26 @@ linters:
     - rowserrcheck
     - nilerr
     - godot
+    - forbidigo
+    - mirror
+    - bodyclose
 
 issues:
+  include:
+    # https://golangci-lint.run/usage/configuration/#command-line-options
   exclude:
     - Rollback
     - fmt.Printf
-    - fmt.Print
 
 linters-settings:
+  goimports:
+    # Put imports beginning with prefix after 3rd-party packages.
+    local-prefixes: github.com/yourselfhosted/slash
   revive:
+    # Default to run all linters so that new rules in the future could automatically be added to the static check.
     enable-all-rules: true
     rules:
+      # The following rules are too strict and make coding harder. We do not enable them for now.
       - name: file-header
         disabled: true
       - name: line-length-limit
@@ -51,14 +61,30 @@ linters-settings:
         disabled: true
       - name: early-return
         disabled: true
+      - name: use-any
+        disabled: true
+      - name: var-naming
+        disabled: true
+      - name: unchecked-type-assertion
+        disabled: true
+      - name: max-control-nesting
+        disabled: true
+      - name: exported
+        arguments:
+          - "disableStutteringCheck"
   gocritic:
     disabled-checks:
       - ifElseChain
   govet:
     settings:
-      printf:
-        funcs:
+      printf: # The name of the analyzer, run `go tool vet help` to see the list of all analyzers
+        funcs: # Run `go tool vet help printf` to see the full configuration of `printf`.
           - common.Errorf
+    enable-all: true
+    disable:
+      - fieldalignment
+      - shadow
   forbidigo:
     forbid:
       - 'fmt\.Errorf(# Please use errors\.Wrap\|Wrapf\|Errorf instead)?'
+      - 'ioutil\.ReadDir(# Please use os\.ReadDir)?'

.goreleaser.yaml

@@ -0,0 +1,38 @@
+version: 1
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+
+builds:
+  - env:
+      - CGO_ENABLED=0
+    main: ./bin/slash
+    binary: slash
+    goos:
+      - linux
+      - darwin
+
+archives:
+  - format: tar.gz
+    # this name template makes the OS and Arch compatible with the results of `uname`.
+    name_template: >-
+      {{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+
+checksum:
+  disable: true
+
+release:
+  draft: true
+  replace_existing_draft: true
+  make_latest: true
+  mode: replace
+  skip_upload: false

.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "go.lintOnSave": "workspace",
-  "go.lintTool": "golangci-lint"
-}

Dockerfile

@@ -1,26 +1,26 @@
 # Build frontend dist.
-FROM node:18.12.1-alpine3.16 AS frontend
+FROM node:18-alpine AS frontend
 WORKDIR /frontend-build
 
-COPY ./web/package.json ./web/pnpm-lock.yaml ./
+COPY . .
+
+WORKDIR /frontend-build/frontend/web
 
 RUN corepack enable && pnpm i --frozen-lockfile
 
-COPY ./web/ .
-
 RUN pnpm build
 
 # Build backend exec file.
-FROM golang:1.19.3-alpine3.16 AS backend
+FROM golang:1.23-alpine AS backend
 WORKDIR /backend-build
 
 COPY . .
-COPY --from=frontend /frontend-build/dist ./server/dist
+COPY --from=frontend /frontend-build/frontend/web/dist /backend-build/server/route/frontend/dist
 
-RUN CGO_ENABLED=0 go build -o slash ./cmd/slash/main.go
+RUN CGO_ENABLED=0 go build -o slash ./bin/slash/main.go
 
 # Make workspace with above generated files.
-FROM alpine:3.16 AS monolithic
+FROM alpine:latest AS monolithic
 WORKDIR /usr/local/slash
 
 RUN apk add --no-cache tzdata

LICENSE

@@ -1,5 +1,5 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,17 +7,15 @@
 
                             Preamble
 
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
+software for all its users.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
 
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
 
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
 
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -72,7 +60,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -631,40 +629,33 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
+    <Slash>
+    Copyright (C) <2023>  <Steven>
+
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+    GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
+    You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
+For more information on this, and how to apply and follow the GNU AGPL, see
 <https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,22 +1,55 @@
 # Slash
 
-<img align="right" src="./resources/logo.png" height="64px" alt="logo">
+**Slash** is an open source, self-hosted platform designed to help you organize, manage, and share your most important links. Easily create customizable, human-readable shortcuts to streamline your link management. Use tags to categorize your links and share them easily with your team or publicly.
 
-**Slash** is a bookmarking and short link service that allows you to save and share links easily. It lets you store and categorize links, generate short URLs for easy sharing, search and filter your saved links, and access them from any device.
+🧩 Browser extension(v1.0.0) now available! - [Chrome Web Store](https://chrome.google.com/webstore/detail/slash/ebaiehmkammnacjadffpicipfckgeobg), [Firefox Add-on](https://addons.mozilla.org/firefox/addon/your-slash/)
 
-Try it out on <a href="https://slash.stevenlgtm.com">Live Demo</a>.
+Getting started with Slash's [Shortcuts](https://github.com/yourselfhosted/slash/blob/main/docs/getting-started/shortcuts.md) and [Collections](https://github.com/yourselfhosted/slash/blob/main/docs/getting-started/collections.md).
+
+[👉 Join our Discord 💬](https://discord.gg/QZqUuUAhDV)
+
+<p>
+  <a href="https://hub.docker.com/r/yourselfhosted/slash"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/yourselfhosted/slash.svg"/></a>
+  <a href="https://discord.gg/QZqUuUAhDV"><img alt="Discord" src="https://img.shields.io/badge/discord-chat-5865f2?logo=discord&logoColor=f5f5f5" /></a>
+</p>
+
+![demo](./docs/assets/demo.png)
+
+## Background
+
+In today's workplace, essential information is often scattered across the cloud in the form of links. We understand the frustration of endlessly searching through emails, messages, and websites just to find the right link. Links are notorious for being unwieldy, complex, and easily lost in the shuffle. Remembering and sharing them can be a challenge.
+
+That's why we developed Slash, a solution that transforms these links into easily accessible, discoverable, and shareable shortcuts(e.g., `s/shortcut`). Say goodbye to link chaos and welcome the organizational ease of Slash into your daily online workflow.
 
 ## Features
 
-- Create customizable `/s/` short links for any URL.
-- Share short links privately or with others.
-- View analytics on short link traffic and sources.
+- Create customizable `s/` short links for any URL.
+- Share short links public or only with your teammates.
+- View analytics on link traffic and sources.
+- Easy access to your shortcuts with browser extension.
+- Share your shortcuts with Collection to anyone, on any browser.
 - Open source self-hosted solution.
 
 ## Deploy with Docker in seconds
 
-> This project is under active development.
-
 ```bash
-docker run -d --name slash -p 5231:5231 -v ~/.slash/:/var/opt/slash stevenlgtm/slash:latest
+docker run -d --name slash -p 5231:5231 -v ~/.slash/:/var/opt/slash yourselfhosted/slash:latest
 ```
+
+Learn more in [Self-hosting Slash with Docker](https://github.com/yourselfhosted/slash/blob/main/docs/install.md).
+
+## Browser Extension
+
+Slash provides a browser extension to help you use your shortcuts in the search bar to go to the corresponding URL.
+
+![browser-extension-example](./docs/assets/browser-extension-example.png)
+
+Learn more in [The Browser Extension of Slash](https://github.com/yourselfhosted/slash/blob/main/docs/install-browser-extension.md).
+
+### Chromium based browsers
+
+For Chromium based browsers(Chrome, Edge, Arc, ...), you can install the extension from the [Chrome Web Store](https://chrome.google.com/webstore/detail/slash/ebaiehmkammnacjadffpicipfckgeobg).
+
+### Firefox
+
+For Firefox, you can install the extension from the [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/your-slash/).

api/v1/activity.go

@@ -1,12 +0,0 @@
-package v1
-
-type ActivityShorcutCreatePayload struct {
-	ShortcutID int `json:"shortcutId"`
-}
-
-type ActivityShorcutViewPayload struct {
-	ShortcutID int    `json:"shortcutId"`
-	IP         string `json:"ip"`
-	Referer    string `json:"referer"`
-	UserAgent  string `json:"userAgent"`
-}

api/v1/analytics.go

@@ -1,128 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-	"strconv"
-
-	"github.com/boojack/slash/store"
-	"github.com/labstack/echo/v4"
-	"github.com/mssola/useragent"
-	"golang.org/x/exp/slices"
-)
-
-type ReferenceInfo struct {
-	Name  string `json:"name"`
-	Count int    `json:"count"`
-}
-
-type DeviceInfo struct {
-	Name  string `json:"name"`
-	Count int    `json:"count"`
-}
-
-type BrowserInfo struct {
-	Name  string `json:"name"`
-	Count int    `json:"count"`
-}
-
-type AnalysisData struct {
-	ReferenceData []ReferenceInfo `json:"referenceData"`
-	DeviceData    []DeviceInfo    `json:"deviceData"`
-	BrowserData   []BrowserInfo   `json:"browserData"`
-}
-
-func (s *APIV1Service) registerAnalyticsRoutes(g *echo.Group) {
-	g.GET("/shortcut/:shortcutId/analytics", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		shortcutID, err := strconv.Atoi(c.Param("shortcutId"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("shortcut id is not a number: %s", c.Param("shortcutId"))).SetInternal(err)
-		}
-		activities, err := s.Store.ListActivities(ctx, &store.FindActivity{
-			Type:  store.ActivityShortcutView,
-			Where: []string{fmt.Sprintf("json_extract(payload, '$.shortcutId') = %d", shortcutID)},
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to get activities, err: %s", err)).SetInternal(err)
-		}
-
-		referenceMap := make(map[string]int)
-		deviceMap := make(map[string]int)
-		browserMap := make(map[string]int)
-		for _, activity := range activities {
-			payload := &ActivityShorcutViewPayload{}
-			if err := json.Unmarshal([]byte(activity.Payload), payload); err != nil {
-				return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to unmarshal payload, err: %s", err)).SetInternal(err)
-			}
-
-			if _, ok := referenceMap[payload.Referer]; !ok {
-				referenceMap[payload.Referer] = 0
-			}
-			referenceMap[payload.Referer]++
-
-			ua := useragent.New(payload.UserAgent)
-			deviceName := ua.OSInfo().Name
-			browserName, _ := ua.Browser()
-
-			if _, ok := deviceMap[deviceName]; !ok {
-				deviceMap[deviceName] = 0
-			}
-			deviceMap[deviceName]++
-
-			if _, ok := browserMap[browserName]; !ok {
-				browserMap[browserName] = 0
-			}
-			browserMap[browserName]++
-		}
-
-		return c.JSON(http.StatusOK, &AnalysisData{
-			ReferenceData: mapToReferenceInfoSlice(referenceMap),
-			DeviceData:    mapToDeviceInfoSlice(deviceMap),
-			BrowserData:   mapToBrowserInfoSlice(browserMap),
-		})
-	})
-}
-
-func mapToReferenceInfoSlice(m map[string]int) []ReferenceInfo {
-	referenceInfoSlice := make([]ReferenceInfo, 0)
-	for key, value := range m {
-		referenceInfoSlice = append(referenceInfoSlice, ReferenceInfo{
-			Name:  key,
-			Count: value,
-		})
-	}
-	slices.SortFunc(referenceInfoSlice, func(i, j ReferenceInfo) bool {
-		return i.Count > j.Count
-	})
-	return referenceInfoSlice
-}
-
-func mapToDeviceInfoSlice(m map[string]int) []DeviceInfo {
-	deviceInfoSlice := make([]DeviceInfo, 0)
-	for key, value := range m {
-		deviceInfoSlice = append(deviceInfoSlice, DeviceInfo{
-			Name:  key,
-			Count: value,
-		})
-	}
-	slices.SortFunc(deviceInfoSlice, func(i, j DeviceInfo) bool {
-		return i.Count > j.Count
-	})
-	return deviceInfoSlice
-}
-
-func mapToBrowserInfoSlice(m map[string]int) []BrowserInfo {
-	browserInfoSlice := make([]BrowserInfo, 0)
-	for key, value := range m {
-		browserInfoSlice = append(browserInfoSlice, BrowserInfo{
-			Name:  key,
-			Count: value,
-		})
-	}
-	slices.SortFunc(browserInfoSlice, func(i, j BrowserInfo) bool {
-		return i.Count > j.Count
-	})
-	return browserInfoSlice
-}

api/v1/auth.go

@@ -1,112 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-
-	"github.com/boojack/slash/api/v1/auth"
-	"github.com/boojack/slash/store"
-
-	"github.com/labstack/echo/v4"
-	"golang.org/x/crypto/bcrypt"
-)
-
-type SignInRequest struct {
-	Email    string `json:"email"`
-	Password string `json:"password"`
-}
-
-type SignUpRequest struct {
-	Nickname string `json:"nickname"`
-	Email    string `json:"email"`
-	Password string `json:"password"`
-}
-
-func (s *APIV1Service) registerAuthRoutes(g *echo.Group, secret string) {
-	g.POST("/auth/signin", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		signin := &SignInRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(signin); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("malformatted signin request, err: %s", err))
-		}
-
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			Email: &signin.Email,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find user by email %s", signin.Email)).SetInternal(err)
-		}
-		if user == nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, fmt.Sprintf("user not found with email %s", signin.Email))
-		} else if user.RowStatus == store.Archived {
-			return echo.NewHTTPError(http.StatusForbidden, fmt.Sprintf("user has been archived with email %s", signin.Email))
-		}
-
-		// Compare the stored hashed password, with the hashed version of the password that was received.
-		if err := bcrypt.CompareHashAndPassword([]byte(user.PasswordHash), []byte(signin.Password)); err != nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, "unmatched email and password")
-		}
-
-		if err := auth.GenerateTokensAndSetCookies(c, user, secret); err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to generate tokens, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, convertUserFromStore(user))
-	})
-
-	g.POST("/auth/signup", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		disallowSignUpSetting, err := s.Store.GetWorkspaceSetting(ctx, &store.FindWorkspaceSetting{
-			Key: store.WorkspaceDisallowSignUp,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to get workspace setting, err: %s", err)).SetInternal(err)
-		}
-		if disallowSignUpSetting != nil && disallowSignUpSetting.Value == "true" {
-			return echo.NewHTTPError(http.StatusForbidden, "sign up has been disabled")
-		}
-
-		signup := &SignUpRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(signup); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("malformatted signup request, err: %s", err)).SetInternal(err)
-		}
-
-		passwordHash, err := bcrypt.GenerateFromPassword([]byte(signup.Password), bcrypt.DefaultCost)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, "failed to generate password hash").SetInternal(err)
-		}
-
-		create := &store.User{
-			Email:        signup.Email,
-			Nickname:     signup.Nickname,
-			PasswordHash: string(passwordHash),
-		}
-		existingUsers, err := s.Store.ListUsers(ctx, &store.FindUser{})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find existing users, err: %s", err)).SetInternal(err)
-		}
-		// The first user to sign up is an admin by default.
-		if len(existingUsers) == 0 {
-			create.Role = store.RoleAdmin
-		} else {
-			create.Role = store.RoleUser
-		}
-
-		user, err := s.Store.CreateUser(ctx, create)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to create user, err: %s", err)).SetInternal(err)
-		}
-
-		if err := auth.GenerateTokensAndSetCookies(c, user, secret); err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to generate tokens, err: %s", err)).SetInternal(err)
-		}
-
-		return c.JSON(http.StatusOK, convertUserFromStore(user))
-	})
-
-	g.POST("/auth/logout", func(c echo.Context) error {
-		auth.RemoveTokensAndCookies(c)
-		c.Response().WriteHeader(http.StatusOK)
-		return nil
-	})
-}

api/v1/auth/auth.go

@@ -1,131 +0,0 @@
-package auth
-
-import (
-	"net/http"
-	"strconv"
-	"time"
-
-	"github.com/boojack/slash/store"
-	"github.com/golang-jwt/jwt/v4"
-	"github.com/labstack/echo/v4"
-	"github.com/pkg/errors"
-)
-
-const (
-	issuer = "slash"
-	// Signing key section. For now, this is only used for signing, not for verifying since we only
-	// have 1 version. But it will be used to maintain backward compatibility if we change the signing mechanism.
-	keyID = "v1"
-	// AccessTokenAudienceName is the audience name of the access token.
-	AccessTokenAudienceName = "user.access-token"
-	// RefreshTokenAudienceName is the audience name of the refresh token.
-	RefreshTokenAudienceName = "user.refresh-token"
-	apiTokenDuration         = 2 * time.Hour
-	accessTokenDuration      = 24 * time.Hour
-	refreshTokenDuration     = 7 * 24 * time.Hour
-	// RefreshThresholdDuration is the threshold duration for refreshing token.
-	RefreshThresholdDuration = 1 * time.Hour
-
-	// CookieExpDuration expires slightly earlier than the jwt expiration. Client would be logged out if the user
-	// cookie expires, thus the client would always logout first before attempting to make a request with the expired jwt.
-	// Suppose we have a valid refresh token, we will refresh the token in 2 cases:
-	// 1. The access token is about to expire in <<refreshThresholdDuration>>
-	// 2. The access token has already expired, we refresh the token so that the ongoing request can pass through.
-	CookieExpDuration = refreshTokenDuration - 1*time.Minute
-	// AccessTokenCookieName is the cookie name of access token.
-	AccessTokenCookieName = "slash.access-token"
-	// RefreshTokenCookieName is the cookie name of refresh token.
-	RefreshTokenCookieName = "slash.refresh-token"
-)
-
-type claimsMessage struct {
-	Name string `json:"name"`
-	jwt.RegisteredClaims
-}
-
-// GenerateAPIToken generates an API token.
-func GenerateAPIToken(username string, userID int, secret string) (string, error) {
-	expirationTime := time.Now().Add(apiTokenDuration)
-	return generateToken(username, userID, AccessTokenAudienceName, expirationTime, []byte(secret))
-}
-
-// GenerateAccessToken generates an access token for web.
-func GenerateAccessToken(username string, userID int, secret string) (string, error) {
-	expirationTime := time.Now().Add(accessTokenDuration)
-	return generateToken(username, userID, AccessTokenAudienceName, expirationTime, []byte(secret))
-}
-
-// GenerateRefreshToken generates a refresh token for web.
-func GenerateRefreshToken(username string, userID int, secret string) (string, error) {
-	expirationTime := time.Now().Add(refreshTokenDuration)
-	return generateToken(username, userID, RefreshTokenAudienceName, expirationTime, []byte(secret))
-}
-
-// GenerateTokensAndSetCookies generates jwt token and saves it to the http-only cookie.
-func GenerateTokensAndSetCookies(c echo.Context, user *store.User, secret string) error {
-	accessToken, err := GenerateAccessToken(user.Email, user.ID, secret)
-	if err != nil {
-		return errors.Wrap(err, "failed to generate access token")
-	}
-
-	cookieExp := time.Now().Add(CookieExpDuration)
-	setTokenCookie(c, AccessTokenCookieName, accessToken, cookieExp)
-
-	// We generate here a new refresh token and saving it to the cookie.
-	refreshToken, err := GenerateRefreshToken(user.Email, user.ID, secret)
-	if err != nil {
-		return errors.Wrap(err, "failed to generate refresh token")
-	}
-	setTokenCookie(c, RefreshTokenCookieName, refreshToken, cookieExp)
-
-	return nil
-}
-
-// RemoveTokensAndCookies removes the jwt token and refresh token from the cookies.
-func RemoveTokensAndCookies(c echo.Context) {
-	// We set the expiration time to the past, so that the cookie will be removed.
-	cookieExp := time.Now().Add(-1 * time.Hour)
-	setTokenCookie(c, AccessTokenCookieName, "", cookieExp)
-	setTokenCookie(c, RefreshTokenCookieName, "", cookieExp)
-}
-
-// setTokenCookie sets the token to the cookie.
-func setTokenCookie(c echo.Context, name, token string, expiration time.Time) {
-	cookie := new(http.Cookie)
-	cookie.Name = name
-	cookie.Value = token
-	cookie.Expires = expiration
-	cookie.Path = "/"
-	// Http-only helps mitigate the risk of client side script accessing the protected cookie.
-	cookie.HttpOnly = true
-	cookie.SameSite = http.SameSiteStrictMode
-	c.SetCookie(cookie)
-}
-
-// generateToken generates a jwt token.
-func generateToken(username string, userID int, aud string, expirationTime time.Time, secret []byte) (string, error) {
-	// Create the JWT claims, which includes the username and expiry time.
-	claims := &claimsMessage{
-		Name: username,
-		RegisteredClaims: jwt.RegisteredClaims{
-			Audience: jwt.ClaimStrings{aud},
-			// In JWT, the expiry time is expressed as unix milliseconds.
-			ExpiresAt: jwt.NewNumericDate(expirationTime),
-			IssuedAt:  jwt.NewNumericDate(time.Now()),
-			Issuer:    issuer,
-			Subject:   strconv.Itoa(userID),
-		},
-	}
-
-	// Declare the token with the HS256 algorithm used for signing, and the claims.
-	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
-	token.Header["kid"] = keyID
-
-	// Create the JWT string.
-	tokenString, err := token.SignedString(secret)
-	if err != nil {
-		return "", err
-	}
-
-	return tokenString, nil
-}

api/v1/common.go

@@ -1,15 +0,0 @@
-package v1
-
-// RowStatus is the status for a row.
-type RowStatus string
-
-const (
-	// Normal is the status for a normal row.
-	Normal RowStatus = "NORMAL"
-	// Archived is the status for an archived row.
-	Archived RowStatus = "ARCHIVED"
-)
-
-func (s RowStatus) String() string {
-	return string(s)
-}

api/v1/jwt.go

@@ -1,202 +0,0 @@
-package v1
-
-import (
-	"fmt"
-	"net/http"
-	"strconv"
-	"strings"
-	"time"
-
-	"github.com/boojack/slash/api/v1/auth"
-	"github.com/boojack/slash/internal/util"
-	"github.com/boojack/slash/store"
-	"github.com/golang-jwt/jwt/v4"
-	"github.com/labstack/echo/v4"
-	"github.com/pkg/errors"
-)
-
-const (
-	// Context section
-	// The key name used to store user id in the context
-	// user id is extracted from the jwt token subject field.
-	userIDContextKey = "user-id"
-)
-
-func getUserIDContextKey() string {
-	return userIDContextKey
-}
-
-// Claims creates a struct that will be encoded to a JWT.
-// We add jwt.RegisteredClaims as an embedded type, to provide fields such as name.
-type Claims struct {
-	Name string `json:"name"`
-	jwt.RegisteredClaims
-}
-
-func extractTokenFromHeader(c echo.Context) (string, error) {
-	authHeader := c.Request().Header.Get("Authorization")
-	if authHeader == "" {
-		return "", nil
-	}
-
-	authHeaderParts := strings.Fields(authHeader)
-	if len(authHeaderParts) != 2 || strings.ToLower(authHeaderParts[0]) != "bearer" {
-		return "", errors.New("Authorization header format must be Bearer {token}")
-	}
-
-	return authHeaderParts[1], nil
-}
-
-func findAccessToken(c echo.Context) string {
-	accessToken := ""
-	cookie, _ := c.Cookie(auth.AccessTokenCookieName)
-	if cookie != nil {
-		accessToken = cookie.Value
-	}
-	if accessToken == "" {
-		accessToken, _ = extractTokenFromHeader(c)
-	}
-
-	return accessToken
-}
-
-func audienceContains(audience jwt.ClaimStrings, token string) bool {
-	for _, v := range audience {
-		if v == token {
-			return true
-		}
-	}
-	return false
-}
-
-// JWTMiddleware validates the access token.
-// If the access token is about to expire or has expired and the request has a valid refresh token, it
-// will try to generate new access token and refresh token.
-func JWTMiddleware(server *APIV1Service, next echo.HandlerFunc, secret string) echo.HandlerFunc {
-	return func(c echo.Context) error {
-		path := c.Path()
-		method := c.Request().Method
-
-		// Pass auth and profile endpoints.
-		if util.HasPrefixes(path, "/api/v1/auth", "/api/v1/workspace/profile") {
-			return next(c)
-		}
-
-		token := findAccessToken(c)
-		if token == "" {
-			// When the request is not authenticated, we allow the user to access the shortcut endpoints for those public shortcuts.
-			if util.HasPrefixes(path, "/s/*") && method == http.MethodGet {
-				return next(c)
-			}
-			auth.RemoveTokensAndCookies(c)
-			return echo.NewHTTPError(http.StatusUnauthorized, "Missing access token")
-		}
-
-		claims := &Claims{}
-		accessToken, err := jwt.ParseWithClaims(token, claims, func(t *jwt.Token) (any, error) {
-			if t.Method.Alg() != jwt.SigningMethodHS256.Name {
-				return nil, errors.Errorf("unexpected access token signing method=%v, expect %v", t.Header["alg"], jwt.SigningMethodHS256)
-			}
-			if kid, ok := t.Header["kid"].(string); ok {
-				if kid == "v1" {
-					return []byte(secret), nil
-				}
-			}
-			return nil, errors.Errorf("unexpected access token kid=%v", t.Header["kid"])
-		})
-
-		generateToken := time.Until(claims.ExpiresAt.Time) < auth.RefreshThresholdDuration
-		if err != nil {
-			var ve *jwt.ValidationError
-			if errors.As(err, &ve) {
-				// If expiration error is the only error, we will clear the err
-				// and generate new access token and refresh token
-				if ve.Errors == jwt.ValidationErrorExpired {
-					generateToken = true
-				}
-			} else {
-				auth.RemoveTokensAndCookies(c)
-				return echo.NewHTTPError(http.StatusUnauthorized, errors.Wrap(err, "Invalid or expired access token"))
-			}
-		}
-
-		if !audienceContains(claims.Audience, auth.AccessTokenAudienceName) {
-			return echo.NewHTTPError(http.StatusUnauthorized, fmt.Sprintf("Invalid access token, audience mismatch, got %q, expected %q.", claims.Audience, auth.AccessTokenAudienceName))
-		}
-
-		// We either have a valid access token or we will attempt to generate new access token and refresh token
-		ctx := c.Request().Context()
-		userID, err := strconv.Atoi(claims.Subject)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Malformed ID in the token.")
-		}
-
-		// Even if there is no error, we still need to make sure the user still exists.
-		user, err := server.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Server error to find user ID: %d", userID)).SetInternal(err)
-		}
-		if user == nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, fmt.Sprintf("Failed to find user ID: %d", userID))
-		}
-
-		if generateToken {
-			generateTokenFunc := func() error {
-				rc, err := c.Cookie(auth.RefreshTokenCookieName)
-				if err != nil {
-					return echo.NewHTTPError(http.StatusUnauthorized, "Failed to generate access token. Missing refresh token.")
-				}
-
-				// Parses token and checks if it's valid.
-				refreshTokenClaims := &Claims{}
-				refreshToken, err := jwt.ParseWithClaims(rc.Value, refreshTokenClaims, func(t *jwt.Token) (any, error) {
-					if t.Method.Alg() != jwt.SigningMethodHS256.Name {
-						return nil, errors.Errorf("unexpected refresh token signing method=%v, expected %v", t.Header["alg"], jwt.SigningMethodHS256)
-					}
-
-					if kid, ok := t.Header["kid"].(string); ok {
-						if kid == "v1" {
-							return []byte(secret), nil
-						}
-					}
-					return nil, errors.Errorf("unexpected refresh token kid=%v", t.Header["kid"])
-				})
-				if err != nil {
-					if err == jwt.ErrSignatureInvalid {
-						return echo.NewHTTPError(http.StatusUnauthorized, "Failed to generate access token. Invalid refresh token signature.")
-					}
-					return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Server error to refresh expired token. User Id %d", userID)).SetInternal(err)
-				}
-
-				if !audienceContains(refreshTokenClaims.Audience, auth.RefreshTokenAudienceName) {
-					return echo.NewHTTPError(http.StatusUnauthorized,
-						fmt.Sprintf("Invalid refresh token, audience mismatch, got %q, expected %q. you may send request to the wrong environment",
-							refreshTokenClaims.Audience,
-							auth.RefreshTokenAudienceName,
-						))
-				}
-
-				// If we have a valid refresh token, we will generate new access token and refresh token
-				if refreshToken != nil && refreshToken.Valid {
-					if err := auth.GenerateTokensAndSetCookies(c, user, secret); err != nil {
-						return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Server error to refresh expired token. User Id %d", userID)).SetInternal(err)
-					}
-				}
-
-				return nil
-			}
-
-			// It may happen that we still have a valid access token, but we encounter issue when trying to generate new token
-			// In such case, we won't return the error.
-			if err := generateTokenFunc(); err != nil && !accessToken.Valid {
-				return err
-			}
-		}
-
-		// Stores userID into context.
-		c.Set(getUserIDContextKey(), userID)
-		return next(c)
-	}
-}

api/v1/redirector.go

@@ -1,112 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-	"net/url"
-	"strings"
-
-	"github.com/boojack/slash/store"
-	"github.com/labstack/echo/v4"
-	"github.com/pkg/errors"
-)
-
-func (s *APIV1Service) registerRedirectorRoutes(g *echo.Group) {
-	g.GET("/*", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		if len(c.ParamValues()) == 0 {
-			return echo.NewHTTPError(http.StatusBadRequest, "invalid shortcut name")
-		}
-
-		shortcutName := c.ParamValues()[0]
-		shortcut, err := s.Store.GetShortcut(ctx, &store.FindShortcut{
-			Name: &shortcutName,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to get shortcut, err: %s", err)).SetInternal(err)
-		}
-		if shortcut == nil {
-			return echo.NewHTTPError(http.StatusNotFound, fmt.Sprintf("not found shortcut with name: %s", shortcutName))
-		}
-		if shortcut.Visibility != store.VisibilityPublic {
-			userID, ok := c.Get(getUserIDContextKey()).(int)
-			if !ok {
-				return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
-			}
-			if shortcut.Visibility == store.VisibilityPrivate && shortcut.CreatorID != userID {
-				return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
-			}
-		}
-
-		if err := s.createShortcutViewActivity(c, shortcut); err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to create activity, err: %s", err)).SetInternal(err)
-		}
-
-		return redirectToShortcut(c, shortcut)
-	})
-}
-
-func redirectToShortcut(c echo.Context, shortcut *store.Shortcut) error {
-	isValidURL := isValidURLString(shortcut.Link)
-	if shortcut.OpenGraphMetadata == nil {
-		if isValidURL {
-			return c.Redirect(http.StatusSeeOther, shortcut.Link)
-		}
-		return c.String(http.StatusOK, shortcut.Link)
-	}
-
-	htmlTemplate := `<html><head>%s</head><body>%s</body></html>`
-	metadataList := []string{
-		fmt.Sprintf(`<title>%s</title>`, shortcut.OpenGraphMetadata.Title),
-		fmt.Sprintf(`<meta name="description" content="%s" />`, shortcut.OpenGraphMetadata.Description),
-		fmt.Sprintf(`<meta property="og:title" content="%s" />`, shortcut.OpenGraphMetadata.Title),
-		fmt.Sprintf(`<meta property="og:description" content="%s" />`, shortcut.OpenGraphMetadata.Description),
-		fmt.Sprintf(`<meta property="og:image" content="%s" />`, shortcut.OpenGraphMetadata.Image),
-		// Twitter related metadata.
-		fmt.Sprintf(`<meta name="twitter:title" content="%s" />`, shortcut.OpenGraphMetadata.Title),
-		fmt.Sprintf(`<meta name="twitter:description" content="%s" />`, shortcut.OpenGraphMetadata.Description),
-		fmt.Sprintf(`<meta name="twitter:image" content="%s" />`, shortcut.OpenGraphMetadata.Image),
-		`<meta name="twitter:card" content="summary_large_image" />`,
-	}
-	if isValidURL {
-		metadataList = append(metadataList, fmt.Sprintf(`<meta property="og:url" content="%s" />`, shortcut.Link))
-	}
-	body := ""
-	if isValidURL {
-		body = fmt.Sprintf(`<script>window.location.href = "%s";</script>`, shortcut.Link)
-	} else {
-		body = shortcut.Link
-	}
-	htmlString := fmt.Sprintf(htmlTemplate, strings.Join(metadataList, ""), body)
-	return c.HTML(http.StatusOK, htmlString)
-}
-
-func (s *APIV1Service) createShortcutViewActivity(c echo.Context, shortcut *store.Shortcut) error {
-	payload := &ActivityShorcutViewPayload{
-		ShortcutID: shortcut.ID,
-		IP:         c.RealIP(),
-		Referer:    c.Request().Referer(),
-		UserAgent:  c.Request().UserAgent(),
-	}
-	payloadStr, err := json.Marshal(payload)
-	if err != nil {
-		return errors.Wrap(err, "Failed to marshal activity payload")
-	}
-	activity := &store.Activity{
-		CreatorID: BotID,
-		Type:      store.ActivityShortcutView,
-		Level:     store.ActivityInfo,
-		Payload:   string(payloadStr),
-	}
-	_, err = s.Store.CreateActivity(c.Request().Context(), activity)
-	if err != nil {
-		return errors.Wrap(err, "Failed to create activity")
-	}
-	return nil
-}
-
-func isValidURLString(s string) bool {
-	_, err := url.ParseRequestURI(s)
-	return err == nil
-}

api/v1/redirector_test.go

@@ -1,33 +0,0 @@
-package v1
-
-import "testing"
-
-func TestIsValidURLString(t *testing.T) {
-	tests := []struct {
-		link     string
-		expected bool
-	}{
-		{
-			link:     "https://google.com",
-			expected: true,
-		},
-		{
-			link:     "http://google.com",
-			expected: true,
-		},
-		{
-			link:     "google.com",
-			expected: false,
-		},
-		{
-			link:     "mailto:email@example.com",
-			expected: true,
-		},
-	}
-
-	for _, test := range tests {
-		if isValidURLString(test.link) != test.expected {
-			t.Errorf("isValidURLString(%s) = %v, expected %v", test.link, !test.expected, test.expected)
-		}
-	}
-}

api/v1/shortcut.go

@@ -1,366 +0,0 @@
-package v1
-
-import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"net/http"
-	"strconv"
-	"strings"
-
-	"github.com/boojack/slash/store"
-	"github.com/pkg/errors"
-
-	"github.com/labstack/echo/v4"
-)
-
-// Visibility is the type of a shortcut visibility.
-type Visibility string
-
-const (
-	// VisibilityPublic is the PUBLIC visibility.
-	VisibilityPublic Visibility = "PUBLIC"
-	// VisibilityWorkspace is the WORKSPACE visibility.
-	VisibilityWorkspace Visibility = "WORKSPACE"
-	// VisibilityPrivate is the PRIVATE visibility.
-	VisibilityPrivate Visibility = "PRIVATE"
-)
-
-func (v Visibility) String() string {
-	return string(v)
-}
-
-type OpenGraphMetadata struct {
-	Title       string `json:"title"`
-	Description string `json:"description"`
-	Image       string `json:"image"`
-}
-
-type Shortcut struct {
-	ID int `json:"id"`
-
-	// Standard fields
-	CreatorID int       `json:"creatorId"`
-	Creator   *User     `json:"creator"`
-	CreatedTs int64     `json:"createdTs"`
-	UpdatedTs int64     `json:"updatedTs"`
-	RowStatus RowStatus `json:"rowStatus"`
-
-	// Domain specific fields
-	Name              string             `json:"name"`
-	Link              string             `json:"link"`
-	Description       string             `json:"description"`
-	Visibility        Visibility         `json:"visibility"`
-	Tags              []string           `json:"tags"`
-	View              int                `json:"view"`
-	OpenGraphMetadata *OpenGraphMetadata `json:"openGraphMetadata"`
-}
-
-type CreateShortcutRequest struct {
-	Name              string             `json:"name"`
-	Link              string             `json:"link"`
-	Description       string             `json:"description"`
-	Visibility        Visibility         `json:"visibility"`
-	Tags              []string           `json:"tags"`
-	OpenGraphMetadata *OpenGraphMetadata `json:"openGraphMetadata"`
-}
-
-type PatchShortcutRequest struct {
-	RowStatus         *RowStatus         `json:"rowStatus"`
-	Name              *string            `json:"name"`
-	Link              *string            `json:"link"`
-	Description       *string            `json:"description"`
-	Visibility        *Visibility        `json:"visibility"`
-	Tags              []string           `json:"tags"`
-	OpenGraphMetadata *OpenGraphMetadata `json:"openGraphMetadata"`
-}
-
-func (s *APIV1Service) registerShortcutRoutes(g *echo.Group) {
-	g.POST("/shortcut", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		create := &CreateShortcutRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(create); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("malformatted post shortcut request, err: %s", err)).SetInternal(err)
-		}
-
-		shortcut, err := s.Store.CreateShortcut(ctx, &store.Shortcut{
-			CreatorID:   userID,
-			Name:        strings.ToLower(create.Name),
-			Link:        create.Link,
-			Description: create.Description,
-			Visibility:  store.Visibility(create.Visibility.String()),
-			Tag:         strings.Join(create.Tags, " "),
-			OpenGraphMetadata: &store.OpenGraphMetadata{
-				Title:       create.OpenGraphMetadata.Title,
-				Description: create.OpenGraphMetadata.Description,
-				Image:       create.OpenGraphMetadata.Image,
-			},
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to create shortcut, err: %s", err)).SetInternal(err)
-		}
-
-		if err := s.createShortcutCreateActivity(ctx, shortcut); err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to create shortcut activity, err: %s", err)).SetInternal(err)
-		}
-
-		shortcutMessage, err := s.composeShortcut(ctx, convertShortcutFromStore(shortcut))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to compose shortcut, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, shortcutMessage)
-	})
-
-	g.PATCH("/shortcut/:shortcutId", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		shortcutID, err := strconv.Atoi(c.Param("shortcutId"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("shortcut ID is not a number: %s", c.Param("shortcutId"))).SetInternal(err)
-		}
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		currentUser, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find user, err: %s", err)).SetInternal(err)
-		}
-
-		shortcut, err := s.Store.GetShortcut(ctx, &store.FindShortcut{
-			ID: &shortcutID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find shortcut, err: %s", err)).SetInternal(err)
-		}
-		if shortcut == nil {
-			return echo.NewHTTPError(http.StatusNotFound, fmt.Sprintf("not found shortcut with id: %d", shortcutID))
-		}
-		if shortcut.CreatorID != userID && currentUser.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusForbidden, "unauthorized to update shortcut")
-		}
-
-		patch := &PatchShortcutRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(patch); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("failed to decode patch shortcut request, err: %s", err)).SetInternal(err)
-		}
-		if patch.Name != nil {
-			name := strings.ToLower(*patch.Name)
-			patch.Name = &name
-		}
-
-		shortcutUpdate := &store.UpdateShortcut{
-			ID:          shortcutID,
-			Name:        patch.Name,
-			Link:        patch.Link,
-			Description: patch.Description,
-		}
-		if patch.RowStatus != nil {
-			shortcutUpdate.RowStatus = (*store.RowStatus)(patch.RowStatus)
-		}
-		if patch.Visibility != nil {
-			shortcutUpdate.Visibility = (*store.Visibility)(patch.Visibility)
-		}
-		if patch.Tags != nil {
-			tag := strings.Join(patch.Tags, " ")
-			shortcutUpdate.Tag = &tag
-		}
-		if patch.OpenGraphMetadata != nil {
-			shortcutUpdate.OpenGraphMetadata = &store.OpenGraphMetadata{
-				Title:       patch.OpenGraphMetadata.Title,
-				Description: patch.OpenGraphMetadata.Description,
-				Image:       patch.OpenGraphMetadata.Image,
-			}
-		}
-		shortcut, err = s.Store.UpdateShortcut(ctx, shortcutUpdate)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to patch shortcut, err: %s", err)).SetInternal(err)
-		}
-
-		shortcutMessage, err := s.composeShortcut(ctx, convertShortcutFromStore(shortcut))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to compose shortcut, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, shortcutMessage)
-	})
-
-	g.GET("/shortcut", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-
-		find := &store.FindShortcut{}
-		if tag := c.QueryParam("tag"); tag != "" {
-			find.Tag = &tag
-		}
-
-		list := []*store.Shortcut{}
-		find.VisibilityList = []store.Visibility{store.VisibilityWorkspace, store.VisibilityPublic}
-		visibleShortcutList, err := s.Store.ListShortcuts(ctx, find)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to fetch shortcut list, err: %s", err)).SetInternal(err)
-		}
-		list = append(list, visibleShortcutList...)
-
-		find.VisibilityList = []store.Visibility{store.VisibilityPrivate}
-		find.CreatorID = &userID
-		privateShortcutList, err := s.Store.ListShortcuts(ctx, find)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to fetch private shortcut list, err: %s", err)).SetInternal(err)
-		}
-		list = append(list, privateShortcutList...)
-
-		shortcutMessageList := []*Shortcut{}
-		for _, shortcut := range list {
-			shortcutMessage, err := s.composeShortcut(ctx, convertShortcutFromStore(shortcut))
-			if err != nil {
-				return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to compose shortcut, err: %s", err)).SetInternal(err)
-			}
-			shortcutMessageList = append(shortcutMessageList, shortcutMessage)
-		}
-		return c.JSON(http.StatusOK, shortcutMessageList)
-	})
-
-	g.GET("/shortcut/:id", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		shortcutID, err := strconv.Atoi(c.Param("id"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("shortcut id is not a number: %s", c.Param("id"))).SetInternal(err)
-		}
-
-		shortcut, err := s.Store.GetShortcut(ctx, &store.FindShortcut{
-			ID: &shortcutID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to fetch shortcut by id, err: %s", err)).SetInternal(err)
-		}
-		if shortcut == nil {
-			return echo.NewHTTPError(http.StatusNotFound, fmt.Sprintf("not found shortcut with id: %d", shortcutID))
-		}
-
-		shortcutMessage, err := s.composeShortcut(ctx, convertShortcutFromStore(shortcut))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to compose shortcut, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, shortcutMessage)
-	})
-
-	g.DELETE("/shortcut/:id", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		shortcutID, err := strconv.Atoi(c.Param("id"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("shortcut id is not a number: %s", c.Param("id"))).SetInternal(err)
-		}
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		currentUser, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find user, err: %s", err)).SetInternal(err)
-		}
-
-		shortcut, err := s.Store.GetShortcut(ctx, &store.FindShortcut{
-			ID: &shortcutID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to fetch shortcut by id, err: %s", err)).SetInternal(err)
-		}
-		if shortcut == nil {
-			return echo.NewHTTPError(http.StatusNotFound, fmt.Sprintf("not found shortcut with id: %d", shortcutID))
-		}
-		if shortcut.CreatorID != userID && currentUser.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusForbidden, "Unauthorized to delete shortcut")
-		}
-
-		err = s.Store.DeleteShortcut(ctx, &store.DeleteShortcut{ID: shortcutID})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to delete shortcut, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, true)
-	})
-}
-
-func (s *APIV1Service) composeShortcut(ctx context.Context, shortcut *Shortcut) (*Shortcut, error) {
-	if shortcut == nil {
-		return nil, nil
-	}
-
-	user, err := s.Store.GetUser(ctx, &store.FindUser{
-		ID: &shortcut.CreatorID,
-	})
-	if err != nil {
-		return nil, errors.Wrap(err, "Failed to get creator")
-	}
-	if user == nil {
-		return nil, errors.New("Creator not found")
-	}
-	shortcut.Creator = convertUserFromStore(user)
-
-	activityList, err := s.Store.ListActivities(ctx, &store.FindActivity{
-		Type:  store.ActivityShortcutView,
-		Level: store.ActivityInfo,
-		Where: []string{fmt.Sprintf("json_extract(payload, '$.shortcutId') = %d", shortcut.ID)},
-	})
-	if err != nil {
-		return nil, errors.Wrap(err, "Failed to list activities")
-	}
-	shortcut.View = len(activityList)
-
-	return shortcut, nil
-}
-
-func convertShortcutFromStore(shortcut *store.Shortcut) *Shortcut {
-	tags := []string{}
-	if shortcut.Tag != "" {
-		tags = append(tags, strings.Split(shortcut.Tag, " ")...)
-	}
-
-	return &Shortcut{
-		ID:          shortcut.ID,
-		CreatedTs:   shortcut.CreatedTs,
-		UpdatedTs:   shortcut.UpdatedTs,
-		CreatorID:   shortcut.CreatorID,
-		Name:        shortcut.Name,
-		Link:        shortcut.Link,
-		Description: shortcut.Description,
-		Visibility:  Visibility(shortcut.Visibility),
-		RowStatus:   RowStatus(shortcut.RowStatus),
-		Tags:        tags,
-		OpenGraphMetadata: &OpenGraphMetadata{
-			Title:       shortcut.OpenGraphMetadata.Title,
-			Description: shortcut.OpenGraphMetadata.Description,
-			Image:       shortcut.OpenGraphMetadata.Image,
-		},
-	}
-}
-
-func (s *APIV1Service) createShortcutCreateActivity(ctx context.Context, shortcut *store.Shortcut) error {
-	payload := &ActivityShorcutCreatePayload{
-		ShortcutID: shortcut.ID,
-	}
-	payloadStr, err := json.Marshal(payload)
-	if err != nil {
-		return errors.Wrap(err, "Failed to marshal activity payload")
-	}
-	activity := &store.Activity{
-		CreatorID: shortcut.CreatorID,
-		Type:      store.ActivityShortcutCreate,
-		Level:     store.ActivityInfo,
-		Payload:   string(payloadStr),
-	}
-	_, err = s.Store.CreateActivity(ctx, activity)
-	if err != nil {
-		return errors.Wrap(err, "Failed to create activity")
-	}
-	return nil
-}

api/v1/url_util.go

@@ -1,31 +0,0 @@
-package v1
-
-import (
-	"fmt"
-	"net/http"
-
-	"github.com/labstack/echo/v4"
-	"go.deanishe.net/favicon"
-)
-
-func (*APIV1Service) registerURLUtilRoutes(g *echo.Group) {
-	// GET /url/favicon?url=...
-	g.GET("/url/favicon", func(c echo.Context) error {
-		url := c.QueryParam("url")
-		icons, err := favicon.Find(url)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("failed to find favicon, err: %s", err))
-		}
-
-		availableIcons := []*favicon.Icon{}
-		for _, icon := range icons {
-			if icon.Width == icon.Height {
-				availableIcons = append(availableIcons, icon)
-			}
-		}
-		if len(availableIcons) == 0 {
-			return echo.NewHTTPError(http.StatusNotFound, "no favicon found")
-		}
-		return c.JSON(http.StatusOK, availableIcons[0].URL)
-	})
-}

api/v1/user.go

@@ -1,311 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-	"net/mail"
-	"strconv"
-
-	"github.com/boojack/slash/store"
-
-	"github.com/labstack/echo/v4"
-	"golang.org/x/crypto/bcrypt"
-)
-
-const (
-	// BotID is the id of bot.
-	BotID = 0
-)
-
-// Role is the type of a role.
-type Role string
-
-const (
-	// RoleAdmin is the ADMIN role.
-	RoleAdmin Role = "ADMIN"
-	// RoleUser is the USER role.
-	RoleUser Role = "USER"
-)
-
-func (r Role) String() string {
-	switch r {
-	case RoleAdmin:
-		return "ADMIN"
-	case RoleUser:
-		return "USER"
-	}
-	return "USER"
-}
-
-type User struct {
-	ID int `json:"id"`
-
-	// Standard fields
-	CreatedTs int64     `json:"createdTs"`
-	UpdatedTs int64     `json:"updatedTs"`
-	RowStatus RowStatus `json:"rowStatus"`
-
-	// Domain specific fields
-	Email    string `json:"email"`
-	Nickname string `json:"nickname"`
-	Role     Role   `json:"role"`
-}
-
-type CreateUserRequest struct {
-	Email    string `json:"email"`
-	Nickname string `json:"nickname"`
-	Password string `json:"password"`
-	Role     Role   `json:"role"`
-}
-
-func (create CreateUserRequest) Validate() error {
-	if create.Email != "" && !validateEmail(create.Email) {
-		return fmt.Errorf("invalid email format")
-	}
-	if create.Nickname != "" && len(create.Nickname) < 3 {
-		return fmt.Errorf("nickname is too short, minimum length is 3")
-	}
-	if len(create.Password) < 3 {
-		return fmt.Errorf("password is too short, minimum length is 3")
-	}
-
-	return nil
-}
-
-type PatchUserRequest struct {
-	RowStatus *RowStatus `json:"rowStatus"`
-	Email     *string    `json:"email"`
-	Nickname  *string    `json:"nickname"`
-	Password  *string    `json:"password"`
-	Role      *Role      `json:"role"`
-}
-
-func (s *APIV1Service) registerUserRoutes(g *echo.Group) {
-	g.POST("/user", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Missing auth session")
-		}
-		currentUser, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, "Failed to find user by id").SetInternal(err)
-		}
-		if currentUser == nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Missing auth session")
-		}
-		if currentUser.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized to create user")
-		}
-
-		userCreate := &CreateUserRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(userCreate); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, "Malformatted post user request").SetInternal(err)
-		}
-		if err := userCreate.Validate(); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, "Invalid user create format").SetInternal(err)
-		}
-
-		passwordHash, err := bcrypt.GenerateFromPassword([]byte(userCreate.Password), bcrypt.DefaultCost)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, "Failed to generate password hash").SetInternal(err)
-		}
-
-		user, err := s.Store.CreateUser(ctx, &store.User{
-			Role:         store.Role(userCreate.Role),
-			Email:        userCreate.Email,
-			Nickname:     userCreate.Nickname,
-			PasswordHash: string(passwordHash),
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, "Failed to create user").SetInternal(err)
-		}
-
-		userMessage := convertUserFromStore(user)
-		return c.JSON(http.StatusOK, userMessage)
-	})
-
-	g.GET("/user", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		list, err := s.Store.ListUsers(ctx, &store.FindUser{})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to list users, err: %s", err)).SetInternal(err)
-		}
-
-		userList := []*User{}
-		for _, user := range list {
-			userList = append(userList, convertUserFromStore(user))
-		}
-		return c.JSON(http.StatusOK, userList)
-	})
-
-	// GET /api/user/me is used to check if the user is logged in.
-	g.GET("/user/me", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing auth session")
-		}
-
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to find user, err: %s", err)).SetInternal(err)
-		}
-
-		return c.JSON(http.StatusOK, convertUserFromStore(user))
-	})
-
-	g.GET("/user/:id", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, err := strconv.Atoi(c.Param("id"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("user id is not a number: %s", c.Param("id"))).SetInternal(err)
-		}
-
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to find user, err: %s", err)).SetInternal(err)
-		}
-
-		return c.JSON(http.StatusOK, convertUserFromStore(user))
-	})
-
-	g.PATCH("/user/:id", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, err := strconv.Atoi(c.Param("id"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("user id is not a number: %s", c.Param("id"))).SetInternal(err)
-		}
-		currentUserID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		currentUser, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &currentUserID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, "failed to find current user").SetInternal(err)
-		}
-		if currentUser == nil {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		if currentUser.ID != userID && currentUser.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusForbidden, "access forbidden for current session user").SetInternal(err)
-		}
-
-		userPatch := &PatchUserRequest{}
-		if err := json.NewDecoder(c.Request().Body).Decode(userPatch); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("failed to decode request body, err: %s", err)).SetInternal(err)
-		}
-
-		updateUser := &store.UpdateUser{
-			ID: userID,
-		}
-		if userPatch.Email != nil {
-			if !validateEmail(*userPatch.Email) {
-				return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("invalid email format: %s", *userPatch.Email))
-			}
-			updateUser.Email = userPatch.Email
-		}
-		if userPatch.Nickname != nil {
-			updateUser.Nickname = userPatch.Nickname
-		}
-		if userPatch.Password != nil && *userPatch.Password != "" {
-			passwordHash, err := bcrypt.GenerateFromPassword([]byte(*userPatch.Password), bcrypt.DefaultCost)
-			if err != nil {
-				return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to hash password, err: %s", err)).SetInternal(err)
-			}
-
-			passwordHashStr := string(passwordHash)
-			updateUser.PasswordHash = &passwordHashStr
-		}
-		if userPatch.RowStatus != nil {
-			rowStatus := store.RowStatus(*userPatch.RowStatus)
-			updateUser.RowStatus = &rowStatus
-		}
-		if userPatch.Role != nil {
-			role := store.Role(*userPatch.Role)
-			updateUser.Role = &role
-		}
-
-		user, err := s.Store.UpdateUser(ctx, updateUser)
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to update user, err: %s", err)).SetInternal(err)
-		}
-
-		return c.JSON(http.StatusOK, convertUserFromStore(user))
-	})
-
-	g.DELETE("/user/:id", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		currentUserID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-		currentUser, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &currentUserID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find current session user, err: %s", err)).SetInternal(err)
-		}
-		if currentUser == nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("current session user not found with ID: %d", currentUserID)).SetInternal(err)
-		}
-		if currentUser.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusForbidden, "access forbidden for current session user").SetInternal(err)
-		}
-
-		userID, err := strconv.Atoi(c.Param("id"))
-		if err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("user id is not a number: %s", c.Param("id"))).SetInternal(err)
-		}
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to find user, err: %s", err)).SetInternal(err)
-		}
-		if user == nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("user not found with ID: %d", userID)).SetInternal(err)
-		}
-		if user.Role == store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("cannot delete admin user with ID: %d", userID)).SetInternal(err)
-		}
-
-		if err := s.Store.DeleteUser(ctx, &store.DeleteUser{
-			ID: userID,
-		}); err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("Failed to delete user, err: %s", err)).SetInternal(err)
-		}
-
-		return c.JSON(http.StatusOK, true)
-	})
-}
-
-// validateEmail validates the email.
-func validateEmail(email string) bool {
-	if _, err := mail.ParseAddress(email); err != nil {
-		return false
-	}
-	return true
-}
-
-// convertUserFromStore converts a store user to a user.
-func convertUserFromStore(user *store.User) *User {
-	return &User{
-		ID:        user.ID,
-		CreatedTs: user.CreatedTs,
-		UpdatedTs: user.UpdatedTs,
-		RowStatus: RowStatus(user.RowStatus),
-		Email:     user.Email,
-		Nickname:  user.Nickname,
-		Role:      Role(user.Role),
-	}
-}

api/v1/user_setting.go

@@ -1,66 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-)
-
-type UserSettingKey string
-
-const (
-	// UserSettingLocaleKey is the key type for user locale.
-	UserSettingLocaleKey UserSettingKey = "locale"
-)
-
-// String returns the string format of UserSettingKey type.
-func (k UserSettingKey) String() string {
-	return string(k)
-}
-
-var (
-	UserSettingLocaleValue = []string{"en", "zh"}
-)
-
-type UserSetting struct {
-	UserID int
-	Key    UserSettingKey `json:"key"`
-	// Value is a JSON string with basic value.
-	Value string `json:"value"`
-}
-
-type UserSettingUpsert struct {
-	UserID int
-	Key    UserSettingKey `json:"key"`
-	Value  string         `json:"value"`
-}
-
-func (upsert UserSettingUpsert) Validate() error {
-	if upsert.Key == UserSettingLocaleKey {
-		localeValue := "en"
-		err := json.Unmarshal([]byte(upsert.Value), &localeValue)
-		if err != nil {
-			return fmt.Errorf("failed to unmarshal user setting locale value")
-		}
-
-		invalid := true
-		for _, value := range UserSettingLocaleValue {
-			if localeValue == value {
-				invalid = false
-				break
-			}
-		}
-		if invalid {
-			return fmt.Errorf("invalid user setting locale value")
-		}
-	} else {
-		return fmt.Errorf("invalid user setting key")
-	}
-
-	return nil
-}
-
-type UserSettingFind struct {
-	UserID int
-
-	Key *UserSettingKey `json:"key"`
-}

api/v1/v1.go

@@ -1,39 +0,0 @@
-package v1
-
-import (
-	"github.com/boojack/slash/server/profile"
-	"github.com/boojack/slash/store"
-
-	"github.com/labstack/echo/v4"
-)
-
-type APIV1Service struct {
-	Profile *profile.Profile
-	Store   *store.Store
-}
-
-func NewAPIV1Service(profile *profile.Profile, store *store.Store) *APIV1Service {
-	return &APIV1Service{
-		Profile: profile,
-		Store:   store,
-	}
-}
-
-func (s *APIV1Service) Start(apiGroup *echo.Group, secret string) {
-	apiV1Group := apiGroup.Group("/api/v1")
-	apiV1Group.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
-		return JWTMiddleware(s, next, secret)
-	})
-	s.registerURLUtilRoutes(apiV1Group)
-	s.registerWorkspaceRoutes(apiV1Group)
-	s.registerAuthRoutes(apiV1Group, secret)
-	s.registerUserRoutes(apiV1Group)
-	s.registerShortcutRoutes(apiV1Group)
-	s.registerAnalyticsRoutes(apiV1Group)
-
-	redirectorGroup := apiGroup.Group("/s")
-	redirectorGroup.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
-		return JWTMiddleware(s, next, secret)
-	})
-	s.registerRedirectorRoutes(redirectorGroup)
-}

api/v1/workspace.go

@@ -1,133 +0,0 @@
-package v1
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-
-	"github.com/boojack/slash/server/profile"
-	"github.com/boojack/slash/store"
-	"github.com/labstack/echo/v4"
-)
-
-type WorkspaceSetting struct {
-	Key   string `json:"key"`
-	Value string `json:"value"`
-}
-
-type WorkspaceSettingUpsert struct {
-	Key   string `json:"key"`
-	Value string `json:"value"`
-}
-
-func (upsert WorkspaceSettingUpsert) Validate() error {
-	if upsert.Key == store.WorkspaceDisallowSignUp.String() {
-		value := false
-		err := json.Unmarshal([]byte(upsert.Value), &value)
-		if err != nil {
-			return fmt.Errorf("failed to unmarshal workspace setting disallow signup value")
-		}
-	} else {
-		return fmt.Errorf("invalid workspace setting key")
-	}
-
-	return nil
-}
-
-type WorkspaceProfile struct {
-	Profile        *profile.Profile `json:"profile"`
-	DisallowSignUp bool             `json:"disallowSignUp"`
-}
-
-func (s *APIV1Service) registerWorkspaceRoutes(g *echo.Group) {
-	g.GET("/workspace/profile", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		workspaceProfile := WorkspaceProfile{
-			Profile:        s.Profile,
-			DisallowSignUp: false,
-		}
-
-		disallowSignUpSetting, err := s.Store.GetWorkspaceSetting(ctx, &store.FindWorkspaceSetting{
-			Key: store.WorkspaceDisallowSignUp,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find workspace setting, err: %s", err)).SetInternal(err)
-		}
-		if disallowSignUpSetting != nil {
-			workspaceProfile.DisallowSignUp = disallowSignUpSetting.Value == "true"
-		}
-
-		return c.JSON(http.StatusOK, workspaceProfile)
-	})
-
-	g.POST("/workspace/setting", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find user, err: %s", err)).SetInternal(err)
-		}
-		if user == nil || user.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
-		}
-
-		upsert := &WorkspaceSettingUpsert{}
-		if err := json.NewDecoder(c.Request().Body).Decode(upsert); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("failed to decode request body, err: %s", err)).SetInternal(err)
-		}
-		if err := upsert.Validate(); err != nil {
-			return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("invalid request body, err: %s", err)).SetInternal(err)
-		}
-
-		workspaceSetting, err := s.Store.UpsertWorkspaceSetting(ctx, &store.WorkspaceSetting{
-			Key:   store.WorkspaceSettingKey(upsert.Key),
-			Value: upsert.Value,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to upsert workspace setting, err: %s", err)).SetInternal(err)
-		}
-		return c.JSON(http.StatusOK, convertWorkspaceSettingFromStore(workspaceSetting))
-	})
-
-	g.GET("/workspace/setting", func(c echo.Context) error {
-		ctx := c.Request().Context()
-		userID, ok := c.Get(getUserIDContextKey()).(int)
-		if !ok {
-			return echo.NewHTTPError(http.StatusUnauthorized, "missing user in session")
-		}
-
-		user, err := s.Store.GetUser(ctx, &store.FindUser{
-			ID: &userID,
-		})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to find user, err: %s", err)).SetInternal(err)
-		}
-		if user == nil || user.Role != store.RoleAdmin {
-			return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
-		}
-
-		list, err := s.Store.ListWorkspaceSettings(ctx, &store.FindWorkspaceSetting{})
-		if err != nil {
-			return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("failed to list workspace settings, err: %s", err)).SetInternal(err)
-		}
-
-		workspaceSettingList := []*WorkspaceSetting{}
-		for _, workspaceSetting := range list {
-			workspaceSettingList = append(workspaceSettingList, convertWorkspaceSettingFromStore(workspaceSetting))
-		}
-		return c.JSON(http.StatusOK, workspaceSettingList)
-	})
-}
-
-func convertWorkspaceSettingFromStore(workspaceSetting *store.WorkspaceSetting) *WorkspaceSetting {
-	return &WorkspaceSetting{
-		Key:   workspaceSetting.Key.String(),
-		Value: workspaceSetting.Value,
-	}
-}

bin/slash/main.go

@@ -0,0 +1,143 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"github.com/yourselfhosted/slash/server"
+	"github.com/yourselfhosted/slash/server/common"
+	"github.com/yourselfhosted/slash/server/profile"
+	"github.com/yourselfhosted/slash/store"
+	"github.com/yourselfhosted/slash/store/db"
+)
+
+const (
+	greetingBanner = `Welcome to Slash!`
+)
+
+var (
+	rootCmd = &cobra.Command{
+		Use:   "slash",
+		Short: `An open source, self-hosted platform for sharing and managing your most frequently used links.`,
+		Run: func(_ *cobra.Command, _ []string) {
+			serverProfile := &profile.Profile{
+				Mode:    viper.GetString("mode"),
+				Port:    viper.GetInt("port"),
+				Data:    viper.GetString("data"),
+				DSN:     viper.GetString("dsn"),
+				Driver:  viper.GetString("driver"),
+				Version: common.GetCurrentVersion(viper.GetString("mode")),
+			}
+			if err := serverProfile.Validate(); err != nil {
+				panic(err)
+			}
+
+			ctx, cancel := context.WithCancel(context.Background())
+			dbDriver, err := db.NewDBDriver(serverProfile)
+			if err != nil {
+				cancel()
+				slog.Error("failed to create db driver", "error", err)
+				return
+			}
+
+			storeInstance := store.New(dbDriver, serverProfile)
+			if err := storeInstance.Migrate(ctx); err != nil {
+				cancel()
+				slog.Error("failed to migrate db", "error", err)
+				return
+			}
+			s, err := server.NewServer(ctx, serverProfile, storeInstance)
+			if err != nil {
+				cancel()
+				slog.Error("failed to create server", "error", err)
+				return
+			}
+
+			c := make(chan os.Signal, 1)
+			// Trigger graceful shutdown on SIGINT or SIGTERM.
+			// The default signal sent by the `kill` command is SIGTERM,
+			// which is taken as the graceful shutdown signal for many systems, eg., Kubernetes, Gunicorn.
+			signal.Notify(c, os.Interrupt, syscall.SIGTERM)
+			go func() {
+				sig := <-c
+				slog.Info(fmt.Sprintf("%s received.\n", sig.String()))
+				s.Shutdown(ctx)
+				cancel()
+			}()
+
+			printGreetings(serverProfile)
+
+			if err := s.Start(ctx); err != nil {
+				if err != http.ErrServerClosed {
+					slog.Error("failed to start server", "error", err)
+					cancel()
+				}
+			}
+
+			// Wait for CTRL-C.
+			<-ctx.Done()
+		},
+	}
+)
+
+func init() {
+	viper.SetDefault("mode", "demo")
+	viper.SetDefault("driver", "sqlite")
+	viper.SetDefault("port", 8082)
+
+	rootCmd.PersistentFlags().String("mode", "demo", `mode of server, can be "prod" or "dev" or "demo"`)
+	rootCmd.PersistentFlags().String("addr", "", "address of server")
+	rootCmd.PersistentFlags().Int("port", 8082, "port of server")
+	rootCmd.PersistentFlags().String("data", "", "data directory")
+	rootCmd.PersistentFlags().String("driver", "sqlite", "database driver")
+	rootCmd.PersistentFlags().String("dsn", "", "database source name(aka. DSN)")
+
+	if err := viper.BindPFlag("mode", rootCmd.PersistentFlags().Lookup("mode")); err != nil {
+		panic(err)
+	}
+	if err := viper.BindPFlag("port", rootCmd.PersistentFlags().Lookup("port")); err != nil {
+		panic(err)
+	}
+	if err := viper.BindPFlag("data", rootCmd.PersistentFlags().Lookup("data")); err != nil {
+		panic(err)
+	}
+	if err := viper.BindPFlag("driver", rootCmd.PersistentFlags().Lookup("driver")); err != nil {
+		panic(err)
+	}
+	if err := viper.BindPFlag("dsn", rootCmd.PersistentFlags().Lookup("dsn")); err != nil {
+		panic(err)
+	}
+
+	viper.SetEnvPrefix("slash")
+	viper.AutomaticEnv()
+}
+
+func printGreetings(serverProfile *profile.Profile) {
+	println("---")
+	println("Server profile")
+	println("dsn:", serverProfile.DSN)
+	println("port:", serverProfile.Port)
+	println("mode:", serverProfile.Mode)
+	println("version:", serverProfile.Version)
+	println("---")
+	println(greetingBanner)
+	fmt.Printf("Version %s has been started on port %d\n", serverProfile.Version, serverProfile.Port)
+	println("---")
+	println("See more in:")
+	fmt.Printf("👉GitHub: %s\n", "https://github.com/yourselfhosted/slash")
+	println("---")
+}
+
+func main() {
+	if err := rootCmd.Execute(); err != nil {
+		panic(err)
+	}
+}

cmd/slash/main.go

@@ -1,130 +0,0 @@
-package main
-
-import (
-	"context"
-	"fmt"
-	"net/http"
-	"os"
-	"os/signal"
-	"syscall"
-
-	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
-	_ "modernc.org/sqlite"
-
-	"github.com/boojack/slash/server"
-	_profile "github.com/boojack/slash/server/profile"
-	"github.com/boojack/slash/store"
-	"github.com/boojack/slash/store/db"
-)
-
-const (
-	greetingBanner = `Welcome to Slash!`
-)
-
-var (
-	profile *_profile.Profile
-	mode    string
-	port    int
-	data    string
-
-	rootCmd = &cobra.Command{
-		Use:   "slash",
-		Short: `A bookmarking and url shortener, save and share your links very easily.`,
-		Run: func(_cmd *cobra.Command, _args []string) {
-			ctx, cancel := context.WithCancel(context.Background())
-			db := db.NewDB(profile)
-			if err := db.Open(ctx); err != nil {
-				cancel()
-				fmt.Printf("failed to open db, error: %+v\n", err)
-				return
-			}
-
-			storeInstance := store.New(db.DBInstance, profile)
-			s, err := server.NewServer(ctx, profile, storeInstance)
-			if err != nil {
-				cancel()
-				fmt.Printf("failed to create server, error: %+v\n", err)
-				return
-			}
-
-			c := make(chan os.Signal, 1)
-			// Trigger graceful shutdown on SIGINT or SIGTERM.
-			// The default signal sent by the `kill` command is SIGTERM,
-			// which is taken as the graceful shutdown signal for many systems, eg., Kubernetes, Gunicorn.
-			signal.Notify(c, os.Interrupt, syscall.SIGTERM)
-			go func() {
-				sig := <-c
-				fmt.Printf("%s received.\n", sig.String())
-				s.Shutdown(ctx)
-				cancel()
-			}()
-
-			println(greetingBanner)
-			fmt.Printf("Version %s has started at :%d\n", profile.Version, profile.Port)
-			if err := s.Start(ctx); err != nil {
-				if err != http.ErrServerClosed {
-					fmt.Printf("failed to start server, error: %+v\n", err)
-					cancel()
-				}
-			}
-
-			// Wait for CTRL-C.
-			<-ctx.Done()
-		},
-	}
-)
-
-func Execute() error {
-	return rootCmd.Execute()
-}
-
-func init() {
-	cobra.OnInitialize(initConfig)
-
-	rootCmd.PersistentFlags().StringVarP(&mode, "mode", "m", "demo", `mode of server, can be "prod" or "dev" or "demo"`)
-	rootCmd.PersistentFlags().IntVarP(&port, "port", "p", 8082, "port of server")
-	rootCmd.PersistentFlags().StringVarP(&data, "data", "d", "", "data directory")
-
-	err := viper.BindPFlag("mode", rootCmd.PersistentFlags().Lookup("mode"))
-	if err != nil {
-		panic(err)
-	}
-	err = viper.BindPFlag("port", rootCmd.PersistentFlags().Lookup("port"))
-	if err != nil {
-		panic(err)
-	}
-	err = viper.BindPFlag("data", rootCmd.PersistentFlags().Lookup("data"))
-	if err != nil {
-		panic(err)
-	}
-
-	viper.SetDefault("mode", "demo")
-	viper.SetDefault("port", 8082)
-	viper.SetEnvPrefix("slash")
-}
-
-func initConfig() {
-	viper.AutomaticEnv()
-	var err error
-	profile, err = _profile.GetProfile()
-	if err != nil {
-		fmt.Printf("failed to get profile, error: %+v\n", err)
-		return
-	}
-
-	println("---")
-	println("Server profile")
-	println("dsn:", profile.DSN)
-	println("port:", profile.Port)
-	println("mode:", profile.Mode)
-	println("version:", profile.Version)
-	println("---")
-}
-
-func main() {
-	err := Execute()
-	if err != nil {
-		panic(err)
-	}
-}

docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3'
+services:
+  slash:
+    image: yourselfhosted/slash:latest
+    container_name: slash
+    ports:
+      - 5231:5231
+    volumes:
+      - slash:/var/opt/slash
+    restart: unless-stopped
+
+volumes:
+  slash:

docs/getting-started/collections.md

@@ -0,0 +1,43 @@
+# Slash Collections
+
+**Slash Collections** introduces a feature to help you better organize and manage related Shortcuts.
+
+## What is a Collection?
+
+A Collection is like a virtual folder where you can group and organize your related Shortcuts. It acts as a container that holds Shortcuts together for a specific purpose or theme. Let's break down the key attributes:
+
+- **Name:** Your chosen label for the Collection. This becomes a crucial part of the URL, enabling direct and quick access to the Collection. For example, if your Collection is named "work-projects", the direct access link would be `c/work-projects`. This user-defined name significantly enhances the accessibility and recognition of your Collections.
+- **Title:** A brief title summarizing the Collection's content.
+- **Description:** A short description explaining what the Collection is about.
+- **Shortcuts:** The Shortcuts included in the Collection.
+- **Visibility:** Settings to control who can access the Collection.
+
+## What Problems Does It Solve?
+
+Slash Collections tackle the challenge of efficiently managing and organizing related Shortcuts. By grouping Shortcuts into Collections, you can create a more structured and accessible workflow. This makes it easier to find, access, and share information based on specific themes or projects.
+
+## How to Use Collections
+
+### Creating a Collection
+
+1. **Define the Collection:** Give your Collection a meaningful name and a descriptive title.
+2. **Add Details:** Provide a brief description of the content within the Collection.
+3. **Add Shortcuts:** Include relevant Shortcuts by selecting them from your existing list.
+4. **Set Visibility:** Choose who should have access to the Collection.
+5. **Save:** Once saved, your Collection is ready to use.
+
+### Accessing Collections
+
+Access a Collection directly by using the assigned name. For example, if your Collection is named "work-projects", the direct access link would be `{YOUR_DOMAIN}/c/work-projects`.
+
+### Updating and Managing Collections
+
+Modify Collection details, such as name, title, or included Shortcuts, to keep your organization streamlined and relevant.
+
+### Sharing Collections
+
+Share Collections by providing the assigned name to collaborators for easy access to grouped Shortcuts.
+
+## Conclusion
+
+Slash Collections offer a user-friendly and organized way to group, manage, and share related Shortcuts. By utilizing the defined Collection attributes, users can seamlessly categorize and access information, promoting collaboration and improving overall productivity.

docs/getting-started/shortcuts.md

@@ -0,0 +1,47 @@
+# Slash Shortcuts
+
+**Slash Shortcuts** is a handy tool designed to make handling and sharing links in your digital workspace a breeze.
+
+## What is a Shortcut?
+
+A Shortcut is a simplified version of a link with essential details, making it easy to remember, organize, and share. Let's break down the key elements:
+
+- **Name:** Your chosen label for the Shortcut. This becomes a crucial part of the URL, enabling direct and quick access to the Shortcut. For example, if your Shortcut is named "meet-john", the direct access link would be `s/meet-john`. This user-defined name significantly enhances the accessibility and recognition of your Shortcuts.
+- **Link:** The original web link you want to streamline.
+- **Title:** A quick overview of what's behind the link.
+- **Tags:** Custom labels for easy sorting.
+- **Description:** A short summary of the content.
+- **Visibility:** Controls who can access the Shortcut.
+
+## How to Use Shortcuts
+
+### Creating a Shortcut
+
+1. **Define the Link:** Paste the original link you want to simplify.
+2. **Add Details:** Give it a name, tags, and a brief description for better organization.
+3. **Set Visibility:** Choose who should be able to access the Shortcut.
+4. **Save:** Once saved, your Shortcut is ready to go.
+
+### Accessing Shortcuts
+
+#### Direct Access
+
+Effortlessly access your Shortcut's content directly by using the assigned name as part of the Slash Shortcuts format.
+
+For example, if your Shortcut is named "meet-john", the direct access link would be `{YOUR_DOMAIN}/s/meet-john`. Simply enter this user-friendly shortcut into your browser to reach the associated content with ease.
+
+#### Browser Extension Access
+
+Install the Slash Shortcuts browser extension for even quicker access. Once installed, simply type `s/meet-john` into your browser's address bar, and the extension will seamlessly redirect you to the corresponding page.
+
+### Updating and Managing Shortcuts
+
+Adjust attributes like name and tags to update a Shortcut. Keep your Shortcuts organized based on categories and visibility settings.
+
+### Sharing Shortcuts
+
+Share Shortcuts by providing the assigned name to collaborators for easy access.
+
+## Conclusion
+
+Shortcuts provide a simple way to manage, organize, and share links within your digital workspace. By using the defined Shortcut attributes, users can easily create, access, and share information, promoting collaboration and boosting productivity.

docs/getting-started/sso.md

@@ -0,0 +1,37 @@
+# Single Sign-On(SSO)
+
+> **Note**: This feature is only available in the **Enterprise** plan.
+
+**Single Sign-On (SSO)** is an authentication method that enables users to securely authenticate with multiple applications and websites by using just one set of credentials.
+
+Slash supports SSO integration with **OAuth 2.0** standard.
+
+## Create a new SSO provider
+
+As an Admin user, you can create a new SSO provider in Setting > Workspace settings > SSO.
+
+![sso-setting](../assets/getting-started/sso-setting.png)
+
+For example, to integrate with GitHub, you might need to fill in the following fields:
+
+![github-sso](../assets/getting-started/github-sso.png)
+
+### Identity provider information
+
+The information is the base concept of OAuth 2.0 and comes from your provider.
+
+- **Client ID** is a public identifier of the custom provider;
+- **Client Secret** is the OAuth2 client secret from identity provider;
+- **Authorization endpoint** is the custom provider's OAuth2 login page address;
+- **Token endpoint** is the API address for obtaining access token;
+- **User endpoint** URL is the API address for obtaining user information by access token;
+- **Scopes** is the scope parameter carried when accessing the OAuth2 URL, which is filled in according to the custom provider;
+
+### User information mapping
+
+For different providers, the structures returned by their user information API are usually not the same. In order to know how to map the user information from an provider into user fields, you need to fill the user information mapping form.
+
+Slash will use the mapping to import the user profile fields when creating new accounts. The most important user field mapping is the identifier which is used to identify the Slash account associated with the OAuth 2.0 login.
+
+- **Identifier** is the field name of primary email in 3rd-party user info;
+- **Display name** is the field name of display name in 3rd-party user info (optional);

docs/getting-started/subscription.md

@@ -0,0 +1,44 @@
+# Subscription
+
+Slash is an open source, self-hosted platform for sharing and managing your most frequently used links. Easily create customizable, human-readable shortcuts to streamline your link management. Our source code is available and accessible on GitHub so anyone can get it, inspect it and review it.
+
+## Plans
+
+### Free
+
+The Free plan is designed for personal use not for commercial use. It allows you to create up to 100 shortcuts and invite up to 5 members.
+
+### Pro
+
+The Pro plan is designed for teams and businesses. It allows you to create unlimited shortcuts and invite unlimited members. It also includes priority support. The Pro plan is $4 per month.
+
+### Team
+
+The Team plan is designed for teams that need more than the Pro plan. It allows you to use Single Sign-On(SSO) and other advanced features. If you need a team plan, please contact us at `yourselfhosted@gmail.com`.
+
+## Using a License Key
+
+After purchasing a Pro or Team plan, you will receive a license key. You can use the license key to activate your plan. Here is how to do it:
+
+1. Log in to your Slash instance as an Admin user.
+2. Go to Settings > Subscription. `https://your-slash-instance.com/setting/subscription`
+3. You will see a form to enter your license key. Enter your license key and click the **Upload license** button.
+4. If the license key is valid, your plan will be activated.
+
+## FAQ
+
+### Can I use the Free plan in my team?
+
+Of course you can. In the free plan, you can invite up to 5 members to your team. If you need more, you should upgrade to the Pro plan.
+
+### How many devices can the license key be used on?
+
+It's unlimited for now, but please do not abuse it.
+
+### Can I get a refund if Slash doesn't meet my needs?
+
+Yes, absolutely! You can contact us with `yourselfhosted@gmail.com`. I will refund you as soon as possible.
+
+### Is there a Lifetime license?
+
+As software requires someone to maintain it, so we won't sell a lifetime service, since humans are not immortal yet. But if you really want it, please contact us `yourselfhosted@gmail.com`.

docs/install-browser-extension.md

@@ -0,0 +1,34 @@
+# The Browser Extension of Slash
+
+Slash provides a browser extension to help you use your shortcuts in the search bar to go to the corresponding URL.
+
+## How to use
+
+### Install the extension
+
+For Chromuim based browsers, you can install the extension from the [Chrome Web Store](https://chrome.google.com/webstore/detail/slash/ebaiehmkammnacjadffpicipfckgeobg).
+
+For Firefox, you can install the extension from the [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/your-slash/).
+
+### Prerequisites
+
+- You need to have a Slash instance running.
+- Sign in with your account on the Slash instance.
+
+### Configure the extension
+
+The extension needs to know the instance url of your Slash. You can configure it by following the steps below:
+
+1. Click on the extension icon and click on the "Settings" button.
+
+   ![](./assets/extension-usage/extension-setting-button.png)
+
+2. Enter the instance url of your Slash and then "Save".
+
+   ![](./assets/extension-usage/extension-setting-page.png)
+
+### Use your shortcuts in the search bar
+
+You can use your shortcuts in the search bar of your browser. For example, if you have a shortcut named `gh` for [GitHub](https://github.com), you can type `s/gh` in the search bar and press `Enter` to go to [GitHub](https://github.com).
+
+![](./assets/extension-usage/shortcut-url.png)

docs/install.md

@@ -0,0 +1,81 @@
+# Self-hosting Slash with Docker
+
+Slash is designed for self-hosting through Docker. No Docker expertise is required to launch your own instance. Just basic understanding of command line and networking.
+
+## Requirements
+
+The only requirement is a server with Docker installed.
+
+## Docker Run
+
+To deploy Slash using docker run, just one command is needed:
+
+```bash
+docker run -d --name slash --publish 5231:5231 --volume ~/.slash/:/var/opt/slash yourselfhosted/slash:latest
+```
+
+This will start Slash in the background and expose it on port `5231`. Data is stored in `~/.slash/`. You can customize the port and data directory.
+
+### Upgrade
+
+To upgrade Slash to latest version, stop and remove the old container first:
+
+```bash
+docker stop slash && docker rm slash
+```
+
+It's recommended but optional to backup database:
+
+```bash
+cp -r ~/.slash/slash_prod.db ~/.slash/slash_prod.db.bak
+```
+
+Then pull the latest image:
+
+```bash
+docker pull yourselfhosted/slash:latest
+```
+
+Finally, restart Slash by following the steps in [Docker Run](#docker-run).
+
+## Docker Compose Run
+
+Assume that docker compose is deployed in the `/opt/slash` directory.
+
+```bash
+mkdir -p /opt/slash && cd /opt/slash
+curl -#LO https://github.com/yourselfhosted/slash/raw/main/docker-compose.yml
+docker compose up -d
+```
+
+This will start Slash in the background and expose it on port `5231`. Data is stored in Docker Volume `slash_slash`. You can customize the port and backup your volume.
+
+## Use PostgreSQL as Database
+
+Slash supports the following database types:
+
+- SQLite (default)
+- PostgreSQL
+
+### Using PostgreSQL
+
+To switch to PostgreSQL, you can use the following steps:
+
+- **--driver** _postgres_ : This argument specifies that Slash should use the `postgres` driver instead of the default `sqlite`.
+
+- **--dsn** _postgresql://postgres:PASSWORD@localhost:5432/slash_ : Provides the connection details for your PostgreSQL server.
+
+You can start Slash with Docker using the following command:
+
+```shell
+docker run -d --name slash --publish 5231:5231 --volume ~/.slash/:/var/opt/slash yourselfhosted/slash:latest --driver postgres --dsn 'postgresql://postgres:PASSWORD@localhost:5432/slash'
+```
+
+Additionally, you can set these configurations via environment variables:
+
+```shell
+SLASH_DRIVER=postgres
+SLASH_DSN=postgresql://root:password@localhost:5432/slash
+```
+
+Note that if the PostgreSQL server is not configured to support SSL connections you will need to add `?sslmode=disable` to the DSN.

docs/privacy-policy.md

@@ -0,0 +1,7 @@
+# Privacy Policy
+
+Slash does not collect, store, or share any data from you.
+
+You can use our application freely and without concern about your personal data being tracked or stored.
+
+Our primary goal is to provide you with a secure and private experience.

extension/background.js

@@ -1,21 +0,0 @@
-import { getSlashData } from "./common.js";
-
-const urlRegex = /https?:\/\/s\/(.+)/;
-
-chrome.tabs.onUpdated.addListener(async (tabId, changeInfo, tab) => {
-  if (typeof tab.url === "string") {
-    const matchResult = urlRegex.exec(tab.url);
-    if (matchResult) {
-      const slashData = await getSlashData();
-      const name = matchResult[1];
-      const url = `${slashData.domain}/s/${name}`;
-      return chrome.tabs.update(tab.id, { url });
-    }
-  }
-});
-
-chrome.omnibox.onInputEntered.addListener(async (text) => {
-  const slashData = await getSlashData();
-  const url = `${slashData.domain}/s/${text}`;
-  return chrome.tabs.update({ url });
-});

extension/common.js

@@ -1,11 +0,0 @@
-export const getSlashData = () => {
-  return new Promise((resolve, reject) => {
-    chrome.storage.local.get(["slash"], (data) => {
-      if (data?.slash) {
-        resolve(data.slash);
-      } else {
-        reject("slash data not found");
-      }
-    });
-  });
-};

extension/manifest.json

@@ -1,18 +0,0 @@
-{
-  "name": "Slash",
-  "description": "",
-  "version": "0.1.0",
-  "manifest_version": 3,
-  "omnibox": {
-    "keyword": "s/"
-  },
-  "action": {
-    "default_popup": "popup.html"
-  },
-  "background": {
-    "service_worker": "background.js",
-    "type": "module"
-  },
-  "permissions": ["tabs", "activeTab", "storage"],
-  "host_permissions": ["*://s/*"]
-}

extension/popup.html

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <body>
-    <h2>Slash extension</h2>
-    <div>
-      <span>Domain</span>
-      <input id="domain-input" type="text" />
-    </div>
-    <div>
-      <button id="save-button">Save</button>
-    </div>
-    <script type="module" src="popup.js"></script>
-  </body>
-</html>

extension/popup.js

@@ -1,23 +0,0 @@
-import { getSlashData } from "./common.js";
-
-const saveButton = document.body.querySelector("#save-button");
-const domainInput = document.body.querySelector("#domain-input");
-
-saveButton.addEventListener("click", () => {
-  chrome.storage.local.set({
-    slash: {
-      domain: domainInput.value,
-    },
-  });
-});
-
-(async () => {
-  try {
-    const slashData = await getSlashData();
-    if (slashData) {
-      domainInput.value = slashData.domain;
-    }
-  } catch (error) {
-    // do nothing.
-  }
-})();

frontend/extension/.gitignore

@@ -0,0 +1,40 @@
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+#cache
+.turbo
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*
+
+out/
+build/
+dist/
+
+.plasmo
+
+# bpp - http://bpp.browser.market/
+keys.json
+
+# typescript
+.tsbuildinfo
+
+src/types/proto

frontend/extension/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  printWidth: 140,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  plugins: [require.resolve("@trivago/prettier-plugin-sort-imports")],
+  importOrder: ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^@/((?!css).+)", "^[./]", "^[../]", "^(.+).css"],
+};

frontend/extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 yourselfhosted
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

frontend/extension/README.md

@@ -0,0 +1 @@
+# Slash Browser Extension

frontend/extension/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "slash-extension",
+  "displayName": "Slash",
+  "version": "1.0.11",
+  "description": "An open source, self-hosted platform for sharing and managing your most frequently used links. Save and share your links very easily.",
+  "scripts": {
+    "dev": "plasmo dev",
+    "build": "plasmo build",
+    "package": "plasmo package",
+    "lint": "eslint --ext .js,.ts,.tsx, src",
+    "lint-fix": "eslint --ext .js,.ts,.tsx, src --fix"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.13.3",
+    "@emotion/styled": "^11.13.0",
+    "@mui/joy": "5.0.0-beta.48",
+    "@plasmohq/storage": "^1.12.0",
+    "classnames": "^2.5.1",
+    "lucide-react": "^0.454.0",
+    "plasmo": "^0.89.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-hot-toast": "^2.4.1"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/chrome": "^0.0.280",
+    "@types/node": "^22.8.6",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "autoprefixer": "^10.4.20",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.37.2",
+    "postcss": "^8.4.47",
+    "prettier": "^3.3.3",
+    "tailwindcss": "^3.4.14",
+    "typescript": "^5.6.3"
+  },
+  "manifest": {
+    "permissions": [
+      "activeTab",
+      "storage",
+      "webRequest"
+    ],
+    "host_permissions": [
+      "*://*/*"
+    ]
+  }
+}

frontend/extension/postcss.config.js

@@ -0,0 +1,10 @@
+/* eslint-disable no-undef */
+/**
+ * @type {import('postcss').ProcessOptions}
+ */
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};

frontend/extension/src/background.ts

@@ -0,0 +1,54 @@
+import { Storage } from "@plasmohq/storage";
+
+const storage = new Storage();
+const urlRegex = /https?:\/\/s\/(.+)/;
+
+chrome.webRequest.onBeforeRequest.addListener(
+  (param) => {
+    (async () => {
+      if (!param.url) {
+        return;
+      }
+
+      const shortcutName = getShortcutNameFromUrl(param.url);
+      if (shortcutName) {
+        const instanceUrl = (await storage.getItem<string>("instance_url")) || "";
+        const url = new URL(`/s/${shortcutName}`, instanceUrl);
+        return chrome.tabs.update({ url: url.toString() });
+      }
+    })();
+  },
+  { urls: ["*://s/*", "*://*/search*"] },
+);
+
+const getShortcutNameFromUrl = (urlString: string) => {
+  const matchResult = urlRegex.exec(urlString);
+  if (matchResult === null) {
+    return getShortcutNameFromSearchUrl(urlString);
+  }
+  return matchResult[1];
+};
+
+const getShortcutNameFromSearchUrl = (urlString: string) => {
+  const url = new URL(urlString);
+  if ((url.hostname.endsWith("google.com") || url.hostname.endsWith("bing.com")) && url.pathname === "/search") {
+    const params = new URLSearchParams(url.search);
+    const shortcutName = params.get("q");
+    if (typeof shortcutName === "string" && shortcutName.startsWith("s/")) {
+      return shortcutName.slice(2);
+    }
+  } else if (url.hostname.endsWith("baidu.com") && url.pathname === "/s") {
+    const params = new URLSearchParams(url.search);
+    const shortcutName = params.get("wd");
+    if (typeof shortcutName === "string" && shortcutName.startsWith("s/")) {
+      return shortcutName.slice(2);
+    }
+  } else if (url.hostname.endsWith("duckduckgo.com") && url.pathname === "/") {
+    const params = new URLSearchParams(url.search);
+    const shortcutName = params.get("q");
+    if (typeof shortcutName === "string" && shortcutName.startsWith("s/")) {
+      return shortcutName.slice(2);
+    }
+  }
+  return "";
+};

frontend/extension/src/components/Logo.tsx

@@ -0,0 +1,12 @@
+import classNames from "classnames";
+import Icon from "./Icon";
+
+interface Props {
+  className?: string;
+}
+
+const Logo = ({ className }: Props) => {
+  return <Icon.CircleSlash className={classNames("dark:text-gray-500", className)} strokeWidth={1.5} />;
+};
+
+export default Logo;

frontend/extension/src/context/context.ts

@@ -0,0 +1,18 @@
+import { createContext, useContext } from "react";
+
+interface Context {
+  instanceUrl?: string;
+  setInstanceUrl: (instanceUrl: string) => void;
+}
+
+export const StorageContext = createContext<Context>({
+  instanceUrl: undefined,
+  setInstanceUrl: () => {},
+});
+
+const useStorageContext = () => {
+  const context = useContext(StorageContext);
+  return context;
+};
+
+export default useStorageContext;

frontend/extension/src/context/index.ts

@@ -0,0 +1,4 @@
+import useStorageContext from "./context";
+import StorageContextProvider from "./provider";
+
+export { useStorageContext, StorageContextProvider };

frontend/extension/src/context/provider.tsx

@@ -0,0 +1,41 @@
+import { Storage } from "@plasmohq/storage";
+import { useEffect, useState } from "react";
+import { StorageContext } from "./context";
+
+interface Props {
+  children: React.ReactNode;
+}
+
+const StorageContextProvider = ({ children }: Props) => {
+  const storage = new Storage();
+  const [instanceUrl, setInstanceUrl] = useState<string | undefined>(undefined);
+  const [isInitialized, setIsInitialized] = useState(false);
+
+  useEffect(() => {
+    (async () => {
+      const instanceUrl = await storage.get("instance_url");
+
+      setInstanceUrl(instanceUrl);
+      setIsInitialized(true);
+    })();
+
+    storage.watch({
+      instance_url: (c) => {
+        setInstanceUrl(c.newValue);
+      },
+    });
+  }, []);
+
+  return (
+    <StorageContext.Provider
+      value={{
+        instanceUrl,
+        setInstanceUrl: (instanceUrl: string) => storage.set("instance_url", instanceUrl),
+      }}
+    >
+      {isInitialized && children}
+    </StorageContext.Provider>
+  );
+};
+
+export default StorageContextProvider;

frontend/extension/src/options.tsx

@@ -0,0 +1,105 @@
+import { Button, CssVarsProvider, Input } from "@mui/joy";
+import { useEffect, useState } from "react";
+import { Toaster, toast } from "react-hot-toast";
+import Icon from "./components/Icon";
+import Logo from "./components/Logo";
+import { StorageContextProvider, useStorageContext } from "./context";
+import "./style.css";
+
+interface SettingState {
+  instanceUrl: string;
+}
+
+const IndexOptions = () => {
+  const context = useStorageContext();
+  const [settingState, setSettingState] = useState<SettingState>({
+    instanceUrl: context.instanceUrl || "",
+  });
+
+  useEffect(() => {
+    setSettingState({
+      instanceUrl: context.instanceUrl || "",
+    });
+  }, [context]);
+
+  const setPartialSettingState = (partialSettingState: Partial<SettingState>) => {
+    setSettingState((prevState) => ({
+      ...prevState,
+      ...partialSettingState,
+    }));
+  };
+
+  const handleSaveSetting = () => {
+    context.setInstanceUrl(settingState.instanceUrl);
+    toast.success("Setting saved");
+  };
+
+  return (
+    <div className="w-full px-4">
+      <div className="w-full flex flex-row justify-center items-center">
+        <a
+          className="bg-yellow-100 dark:bg-yellow-500 dark:opacity-70 mt-12 py-2 px-3 rounded-full border dark:border-yellow-600 flex flex-row justify-start items-center cursor-pointer shadow hover:underline hover:text-blue-600"
+          href="https://github.com/yourselfhosted/slash#browser-extension"
+          target="_blank"
+        >
+          <Icon.HelpCircle className="w-4 h-auto" />
+          <span className="mx-1 text-sm">Need help? Check out the docs</span>
+          <Icon.ExternalLink className="w-4 h-auto" />
+        </a>
+      </div>
+
+      <div className="w-full max-w-lg mx-auto flex flex-col justify-start items-start py-12">
+        <h2 className="flex flex-row justify-start items-center mb-6 text-2xl dark:text-gray-400">
+          <Logo className="w-10 h-auto mr-2" />
+          <span>Slash</span>
+          <span className="mx-2 text-gray-400">/</span>
+          <span>Setting</span>
+        </h2>
+
+        <div className="w-full flex flex-col justify-start items-start">
+          <div className="w-full flex flex-col justify-start items-start mb-4">
+            <div className="mb-2 text-base w-full flex flex-row justify-between items-center">
+              <span className="dark:text-gray-400">Instance URL</span>
+              {context.instanceUrl !== "" && (
+                <a
+                  className="text-sm flex flex-row justify-start items-center underline text-blue-600 hover:opacity-80"
+                  href={context.instanceUrl}
+                  target="_blank"
+                >
+                  <span className="mr-1">Go to my Slash</span>
+                  <Icon.ExternalLink className="w-4 h-auto" />
+                </a>
+              )}
+            </div>
+            <div className="relative w-full">
+              <Input
+                className="w-full"
+                type="text"
+                placeholder="The url of your Slash instance. e.g., https://slash.example.com"
+                value={settingState.instanceUrl}
+                onChange={(e) => setPartialSettingState({ instanceUrl: e.target.value })}
+              />
+            </div>
+          </div>
+
+          <div className="w-full mt-6 flex flex-row justify-end">
+            <Button onClick={handleSaveSetting}>Save</Button>
+          </div>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+const Options = () => {
+  return (
+    <StorageContextProvider>
+      <CssVarsProvider>
+        <IndexOptions />
+        <Toaster position="top-center" />
+      </CssVarsProvider>
+    </StorageContextProvider>
+  );
+};
+
+export default Options;

frontend/extension/src/popup.tsx

@@ -0,0 +1,95 @@
+import { Button, CssVarsProvider } from "@mui/joy";
+import { Toaster } from "react-hot-toast";
+import Icon from "@/components/Icon";
+import Logo from "@/components/Logo";
+import { StorageContextProvider, useStorageContext } from "./context";
+import "./style.css";
+
+const IndexPopup = () => {
+  const context = useStorageContext();
+  const isInitialized = context.instanceUrl;
+
+  const handleSettingButtonClick = () => {
+    chrome.runtime.openOptionsPage();
+  };
+
+  const handleRefreshButtonClick = () => {
+    chrome.runtime.reload();
+    chrome.browserAction.setPopup({ popup: "" });
+  };
+
+  return (
+    <div className="w-full min-w-[512px] px-4 pt-4">
+      <div className="w-full flex flex-row justify-between items-center">
+        <div className="flex flex-row justify-start items-center dark:text-gray-400">
+          <Logo className="w-6 h-auto mr-1" />
+          <span className="">Slash</span>
+        </div>
+      </div>
+
+      <div className="w-full mt-4">
+        {isInitialized ? (
+          <>
+            <p className="w-full mb-2">
+              <span>Your instance URL is </span>
+              <a
+                className="inline-flex flex-row justify-start items-center underline text-blue-600 hover:opacity-80"
+                href={context.instanceUrl}
+                target="_blank"
+              >
+                <span className="mr-1">{context.instanceUrl}</span>
+                <Icon.ExternalLink className="w-4 h-auto" />
+              </a>
+            </p>
+            <div className="w-full flex flex-row justify-between items-center mb-2">
+              <div className="flex flex-row justify-start items-center gap-2">
+                <Button size="sm" variant="outlined" color="neutral" onClick={handleSettingButtonClick}>
+                  <Icon.Settings className="w-5 h-auto text-gray-500 dark:text-gray-400 mr-1" />
+                  Setting
+                </Button>
+                <Button
+                  size="sm"
+                  variant="outlined"
+                  color="neutral"
+                  component="a"
+                  href="https://github.com/yourselfhosted/slash"
+                  target="_blank"
+                >
+                  <Icon.Github className="w-5 h-auto text-gray-500 dark:text-gray-400 mr-1" />
+                  GitHub
+                </Button>
+              </div>
+            </div>
+          </>
+        ) : (
+          <div className="w-full flex flex-col justify-start items-center">
+            <Icon.Cookie strokeWidth={1} className="w-20 h-auto mb-4 text-gray-400" />
+            <p className="dark:text-gray-400">Please set your instance URL first.</p>
+            <div className="w-full flex flex-row justify-center items-center py-4">
+              <Button size="sm" color="primary" onClick={handleSettingButtonClick}>
+                <Icon.Settings className="w-5 h-auto mr-1" /> Go to Setting
+              </Button>
+              <span className="mx-2 dark:text-gray-400">Or</span>
+              <Button size="sm" variant="outlined" color="neutral" onClick={handleRefreshButtonClick}>
+                <Icon.RefreshCcw className="w-5 h-auto mr-1" /> Refresh
+              </Button>
+            </div>
+          </div>
+        )}
+      </div>
+    </div>
+  );
+};
+
+const Popup = () => {
+  return (
+    <StorageContextProvider>
+      <CssVarsProvider>
+        <IndexPopup />
+        <Toaster position="top-center" />
+      </CssVarsProvider>
+    </StorageContextProvider>
+  );
+};
+
+export default Popup;

frontend/extension/src/style.css

@@ -5,8 +5,21 @@
 body,
 html,
 #root {
-  @apply text-base w-full h-full;
+  @apply text-base dark:bg-zinc-900;
   font-family: -apple-system, BlinkMacSystemFont, "PingFang SC", "Noto Sans", "Noto Sans CJK SC", "Microsoft YaHei UI", "Microsoft YaHei",
     "WenQuanYi Micro Hei", sans-serif, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol",
     "Noto Color Emoji";
 }
+
+@layer utilities {
+  /* Hide scrollbar for Chrome, Safari and Opera */
+  .no-scrollbar::-webkit-scrollbar {
+    display: none;
+  }
+
+  /* Hide scrollbar for IE, Edge and Firefox */
+  .no-scrollbar {
+    -ms-overflow-style: none; /* IE and Edge */
+    scrollbar-width: none; /* Firefox */
+  }
+}

frontend/extension/tailwind.config.js

@@ -0,0 +1,8 @@
+/* eslint-disable no-undef */
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  mode: "jit",
+  darkMode: "class",
+  content: ["./**/*.tsx"],
+  plugins: [],
+};

frontend/extension/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "plasmo/templates/tsconfig.base",
+  "exclude": ["node_modules"],
+  "include": [".plasmo/index.d.ts", "./**/*.ts", "./**/*.tsx"],
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+    "baseUrl": "."
+  }
+}

frontend/locales/README.md

@@ -0,0 +1,3 @@
+# Translation files
+
+This directory contains the translation files for the frontend including web and browser extension.

frontend/locales/en.json

@@ -0,0 +1,82 @@
+{
+  "common": {
+    "about": "About",
+    "loading": "Loading",
+    "cancel": "Cancel",
+    "save": "Save",
+    "create": "Create",
+    "download": "Download",
+    "edit": "Edit",
+    "delete": "Delete",
+    "language": "Language",
+    "search": "Search",
+    "email": "Email",
+    "password": "Password",
+    "account": "Account",
+    "or": "Or"
+  },
+  "auth": {
+    "sign-in": "Sign in",
+    "sign-up": "Sign up",
+    "sign-out": "Sign out",
+    "create-your-account": "Create your account",
+    "host-tip": "You are registering as Admin.",
+    "sign-in-with": "Sign in with {{provider}}"
+  },
+  "analytics": {
+    "self": "Analytics",
+    "top-sources": "Top sources",
+    "source": "Source",
+    "visitors": "Visitors",
+    "devices": "Devices",
+    "browser": "Browser",
+    "browsers": "Browsers",
+    "operating-system": "Operating System"
+  },
+  "shortcut": {
+    "visits": "{{count}} visits",
+    "visibility": {
+      "workspace": {
+        "self": "Workspace",
+        "description": "Workspace members can access"
+      },
+      "public": {
+        "self": "Public",
+        "description": "Public on the internet"
+      }
+    }
+  },
+  "filter": {
+    "all": "All",
+    "personal": "Personal",
+    "compact-mode": "Compact mode",
+    "order-by": "Order by",
+    "direction": "Direction"
+  },
+  "user": {
+    "self": "User",
+    "nickname": "Nickname",
+    "email": "Email",
+    "role": "Role",
+    "profile": "Profile"
+  },
+  "settings": {
+    "self": "Setting",
+    "preference": {
+      "self": "Preference",
+      "color-theme": "Color theme"
+    },
+    "workspace": {
+      "self": "Workspace settings",
+      "custom-style": "Custom style",
+      "disallow-user-registration": {
+        "self": "Disallow user registration"
+      },
+      "default-visibility": "Default visibility",
+      "member": {
+        "self": "Member",
+        "add": "Add member"
+      }
+    }
+  }
+}

frontend/locales/fr.json

@@ -0,0 +1,79 @@
+{
+  "common": {
+    "about": "À propos",
+    "loading": "Chargement",
+    "cancel": "Annuler",
+    "save": "Sauver",
+    "create": "Créer",
+    "download": "Télécharger",
+    "edit": "Modifier",
+    "delete": "Supprimer",
+    "language": "Langue",
+    "search": "Recherche",
+    "email": "E-mail",
+    "password": "Mot de passe",
+    "account": "Compte"
+  },
+  "auth": {
+    "sign-in": "Se connecter",
+    "sign-up": "S'inscrire",
+    "sign-out": "Se déconnecter",
+    "create-your-account": "Créez votre compte"
+  },
+  "analytics": {
+    "self": "Analyse",
+    "top-sources": "Principales sources",
+    "source": "Source",
+    "visitors": "Visiteurs",
+    "devices": "Dispositifs",
+    "browser": "Navigateur",
+    "browsers": "Navigateurs",
+    "operating-system": "Systèmes d'exploitation"
+  },
+  "shortcut": {
+    "visits": "{{count}} visites",
+    "visibility": {
+      "workspace": {
+        "self": "Espace de travail",
+        "description": "Les membres de l'espace de travail ont accès"
+      },
+      "public": {
+        "self": "Public",
+        "description": "Visible par tous sur Internet"
+      }
+    }
+  },
+  "filter": {
+    "all": "Tout",
+    "mine": "Le mien",
+    "compact-mode": "Mode compact",
+    "order-by": "Commandé par",
+    "direction": "Direction"
+  },
+  "user": {
+    "self": "Utilisateur",
+    "nickname": "Surnom",
+    "email": "E-mail",
+    "role": "Rôle",
+    "profile": "Profil",
+    "action": {
+      "add-user": "Ajouter utilisateur"
+    }
+  },
+  "settings": {
+    "self": "Paramètres",
+    "preference": {
+      "self": "Préférence",
+      "color-theme": "Thème de couleur"
+    },
+    "workspace": {
+      "self": "Paramètres de l'espace de travail",
+      "custom-style": "Style personnalisé",
+      "enable-user-signup": {
+        "self": "Activer l'inscription des utilisateurs",
+        "description": "Une fois activé, d'autres utilisateurs peuvent s'inscrire."
+      },
+      "default-visibility": "Visibilité par défaut"
+    }
+  }
+}

frontend/locales/hu.json

@@ -0,0 +1,80 @@
+{
+  "common": {
+    "about": "Névjegy",
+    "loading": "Betöltés",
+    "cancel": "Mégse",
+    "save": "Mentés",
+    "create": "Létrehozás",
+    "download": "Letöltés",
+    "edit": "Szerkesztés",
+    "delete": "Törlés",
+    "language": "Nyelv",
+    "search": "Keresés",
+    "email": "Email",
+    "password": "Jelszó",
+    "account": "Fiók"
+  },
+  "auth": {
+    "sign-in": "Bejelentkezés",
+    "sign-up": "Regisztráció",
+    "sign-out": "Kijelentkezés",
+    "create-your-account": "Fiók létrehozás",
+    "host-tip": "Adminisztrátorként regisztrál."
+  },
+  "analytics": {
+    "self": "Analitika",
+    "top-sources": "Legfontosabb források",
+    "source": "Forrás",
+    "visitors": "Látogatók",
+    "devices": "Eszközök",
+    "browser": "Böngésző",
+    "browsers": "Böngészők",
+    "operating-system": "Operációs rendszer"
+  },
+  "shortcut": {
+    "visits": "{{count}} látogatás",
+    "visibility": {
+      "workspace": {
+        "self": "Munkaterület",
+        "description": "A munkaterület tagjai hozzáférhetnek"
+      },
+      "public": {
+        "self": "Nyilvános",
+        "description": "Mindenki számára látható az interneten"
+      }
+    }
+  },
+  "filter": {
+    "all": "Összes",
+    "mine": "Saját",
+    "compact-mode": "Kompakt mód",
+    "order-by": "Rendezés",
+    "direction": "Irány"
+  },
+  "user": {
+    "self": "Felhasználó",
+    "nickname": "Becenév",
+    "email": "Email",
+    "role": "Szerep",
+    "profile": "Profil",
+    "action": {
+      "add-user": "Felhasználó hozzáadása"
+    }
+  },
+  "settings": {
+    "self": "Beállítás",
+    "preference": {
+      "self": "Preferencia",
+      "color-theme": "Színtéma"
+    },
+    "workspace": {
+      "self": "Munkaterület beállítások",
+      "custom-style": "Egyéni stílus",
+      "enable-user-signup": {
+        "self": "Felhasználói regisztráció engedélyezése",
+        "description": "Ha engedélyezve van, más felhasználók is regisztrálhatnak."
+      },
+      "default-visibility": "Alapértelmezett láthatóság"
+    }
+  }
+}

frontend/locales/ja.json

@@ -0,0 +1,80 @@
+{
+  "common": {
+    "about": "About",
+    "loading": "読込中",
+    "cancel": "取消",
+    "save": "保存",
+    "create": "作成",
+    "download": "ダウンロード",
+    "edit": "編集",
+    "delete": "削除",
+    "language": "言語",
+    "search": "検索",
+    "email": "Eメール",
+    "password": "パスワード",
+    "account": "アカウント"
+  },
+  "auth": {
+    "sign-in": "サインイン",
+    "sign-up": "登録",
+    "sign-out": "サインアウト",
+    "create-your-account": "アカウントを作成してください",
+    "host-tip": "管理者として登録されています。"
+  },
+  "analytics": {
+    "self": "分析",
+    "top-sources": "トップソース",
+    "source": "ソース",
+    "visitors": "訪問者",
+    "devices": "デバイス",
+    "browser": "ブラウザ",
+    "browsers": "ブラウザ",
+    "operating-system": "オペレーティングシステム"
+  },
+  "shortcut": {
+    "visits": "{{count}} 回訪問",
+    "visibility": {
+      "workspace": {
+        "self": "ワークスペース",
+        "description": "ワークスペースメンバーがアクセスできます"
+      },
+      "public": {
+        "self": "公開",
+        "description": "誰でもアクセスできます"
+      }
+    }
+  },
+  "filter": {
+    "all": "全て",
+    "mine": "自分",
+    "compact-mode": "コンパクトモード",
+    "order-by": "順序",
+    "direction": "方向"
+  },
+  "user": {
+    "self": "ユーザー",
+    "nickname": "ニックネーム",
+    "email": "Eメール",
+    "role": "役割",
+    "profile": "プロフィール",
+    "action": {
+      "add-user": "ユーザーの追加"
+    }
+  },
+  "settings": {
+    "self": "設定",
+    "preference": {
+      "self": "プリファレンス",
+      "color-theme": "カラーテーマ"
+    },
+    "workspace": {
+      "self": "ワークスペースの設定",
+      "custom-style": "カスタムスタイル",
+      "enable-user-signup": {
+        "self": "ユーザーの登録を有効にする",
+        "description": "有効にすると他のユーザーが登録できるようになります。"
+      },
+      "default-visibility": "デフォルトの表示"
+    }
+  }
+}

frontend/locales/ru.json

@@ -0,0 +1,80 @@
+{
+  "common": {
+    "about": "Информация",
+    "loading": "Загружается",
+    "cancel": "Отменить",
+    "save": "Сохранить",
+    "create": "Создать",
+    "download": "Загрузить",
+    "edit": "Редактировать",
+    "delete": "Удалить",
+    "language": "Язык",
+    "search": "Поиск",
+    "email": "Email",
+    "password": "Пароль",
+    "account": "Аккаунт"
+  },
+  "auth": {
+    "sign-in": "Войти",
+    "sign-up": "Регистрация",
+    "sign-out": "Выйти",
+    "create-your-account": "Создать аккаунт",
+    "host-tip": "Вы зарегистрированы как Admin."
+  },
+  "analytics": {
+    "self": "Аналитика",
+    "top-sources": "Лучшие источники",
+    "source": "Источник",
+    "visitors": "Посетители",
+    "devices": "Устройства",
+    "browser": "Браузер",
+    "browsers": "Браузеры",
+    "operating-system": "Операционная система"
+  },
+  "shortcut": {
+    "visits": "{{count}} перехода",
+    "visibility": {
+      "workspace": {
+        "self": "Команда",
+        "description": "Члены команды имеют доступ"
+      },
+      "public": {
+        "self": "Публичная",
+        "description": "Видимая для всех из интернета"
+      }
+    }
+  },
+  "filter": {
+    "all": "Все",
+    "mine": "Мои",
+    "compact-mode": "Компактный режим",
+    "order-by": "Создана",
+    "direction": "Путь"
+  },
+  "user": {
+    "self": "Пользователь",
+    "nickname": "Имя пользователя",
+    "email": "Email",
+    "role": "Роль",
+    "profile": "Профиль",
+    "action": {
+      "add-user": "Добавить пользователя"
+    }
+  },
+  "settings": {
+    "self": "Настройки",
+    "preference": {
+      "self": "Внешний вид",
+      "color-theme": "Цветовая схема"
+    },
+    "workspace": {
+      "self": "Настройки команды",
+      "custom-style": "Пользовательский стиль",
+      "enable-user-signup": {
+        "self": "Разрешить регистрацию пользователей",
+        "description": "После включения, другие пользователи смогут зарегистрироваться."
+      },
+      "default-visibility": "Отображение по умолчанию"
+    }
+  }
+}

frontend/locales/tr.json

@@ -0,0 +1,79 @@
+{
+  "common": {
+    "about": "Hakkında",
+    "loading": "Yükleniyor",
+    "cancel": "İptal",
+    "save": "Kaydet",
+    "create": "Oluştur",
+    "download": "İndir",
+    "edit": "Düzenle",
+    "delete": "Sil",
+    "language": "Dil",
+    "search": "Ara",
+    "email": "E-posta",
+    "password": "Şifre",
+    "account": "Hesap"
+  },
+  "auth": {
+    "sign-in": "Giriş yap",
+    "sign-up": "Kaydol",
+    "sign-out": "Çıkış yap",
+    "create-your-account": "Hesabınızı oluşturun"
+  },
+  "analytics": {
+    "self": "Analizler",
+    "top-sources": "En İyi Kaynaklar",
+    "source": "Kaynak",
+    "visitors": "Ziyâretçiler",
+    "devices": "Cihazlar",
+    "browser": "Tarayıcı",
+    "browsers": "Tarayıcılar",
+    "operating-system": "İşletim Sistemi"
+  },
+  "shortcut": {
+    "visits": "{{count}} ziyaret",
+    "visibility": {
+      "workspace": {
+        "self": "Çalışma Alanı",
+        "description": "Çalışma alanı üyeleri erişebilir"
+      },
+      "public": {
+        "self": "Herkese açık",
+        "description": "İnternette herkese görünür"
+      }
+    }
+  },
+  "filter": {
+    "all": "Hepsi",
+    "mine": "Benim",
+    "compact-mode": "Kompakt mod",
+    "order-by": "Sırala",
+    "direction": "Yön"
+  },
+  "user": {
+    "self": "Kullanıcı",
+    "nickname": "Takma ad",
+    "email": "E-posta",
+    "role": "Rol",
+    "profile": "Profil",
+    "action": {
+      "add-user": "Kullanıcı ekle"
+    }
+  },
+  "settings": {
+    "self": "Ayarlar",
+    "preference": {
+      "self": "Tercihler",
+      "color-theme": "Renk teması"
+    },
+    "workspace": {
+      "self": "Çalışma alanı ayarları",
+      "custom-style": "Özel stil",
+      "enable-user-signup": {
+        "self": "Kullanıcı kaydını etkinleştir",
+        "description": "Etkinleştirildiğinde, diğer kullanıcılar kaydolabilir."
+      },
+      "default-visibility": "Varsayılan görünürlük"
+    }
+  }
+}

frontend/locales/zh.json

@@ -0,0 +1,79 @@
+{
+  "common": {
+    "about": "关于",
+    "loading": "加载中",
+    "cancel": "取消",
+    "save": "保存",
+    "create": "创建",
+    "download": "下载",
+    "edit": "编辑",
+    "delete": "删除",
+    "language": "语言",
+    "search": "搜索",
+    "email": "邮箱",
+    "password": "密码",
+    "account": "账号"
+  },
+  "auth": {
+    "sign-in": "登录",
+    "sign-up": "注册",
+    "sign-out": "退出登录",
+    "create-your-account": "创建账号"
+  },
+  "analytics": {
+    "self": "分析",
+    "top-sources": "热门来源",
+    "source": "来源",
+    "visitors": "访客数",
+    "devices": "设备",
+    "browser": "浏览器",
+    "browsers": "浏览器",
+    "operating-system": "操作系统"
+  },
+  "shortcut": {
+    "visits": "{{count}} 次访问",
+    "visibility": {
+      "workspace": {
+        "self": "工作区",
+        "description": "工作区成员可以访问"
+      },
+      "public": {
+        "self": "公开的",
+        "description": "公开至互联网"
+      }
+    }
+  },
+  "filter": {
+    "all": "所有",
+    "personal": "我的",
+    "compact-mode": "紧凑模式",
+    "order-by": "排序方式",
+    "direction": "方向"
+  },
+  "user": {
+    "self": "用户",
+    "nickname": "昵称",
+    "email": "邮箱",
+    "role": "角色",
+    "profile": "账号",
+    "action": {
+      "add-user": "添加用户"
+    }
+  },
+  "settings": {
+    "self": "设置",
+    "preference": {
+      "self": "偏好设置",
+      "color-theme": "主题"
+    },
+    "workspace": {
+      "self": "系统设置",
+      "custom-style": "自定义样式",
+      "enable-user-signup": {
+        "self": "启用用户注册",
+        "description": "允许其他用户注册新账号"
+      },
+      "default-visibility": "默认可见性"
+    }
+  }
+}

frontend/web/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:react/recommended", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["react", "@typescript-eslint", "prettier"],
+  "ignorePatterns": ["node_modules", "dist", "public"],
+  "rules": {
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ],
+    "@typescript-eslint/no-explicit-any": ["off"],
+    "react/react-in-jsx-scope": "off",
+    "react/jsx-no-target-blank": "off"
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  }
+}

frontend/web/.gitignore

@@ -3,3 +3,4 @@ node_modules
 dist
 dist-ssr
 *.local
+src/types/proto

frontend/web/.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  printWidth: 140,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  plugins: [require.resolve("@trivago/prettier-plugin-sort-imports")],
+  importOrder: ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^@/((?!less).+)", "^[./]", "^(.+).less"],
+};

frontend/web/index.html

@@ -2,9 +2,10 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" href="/logo.png" type="image/*" />
+    <link rel="icon" href="/logo.svg" type="image/*" />
     <meta name="theme-color" content="#FFFFFF" />
     <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
+    <!-- slash.metadata -->
     <title>Slash</title>
   </head>
   <body>

frontend/web/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "slash",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "serve": "vite preview",
+    "lint": "eslint --ext .js,.ts,.tsx, src",
+    "lint-fix": "eslint --ext .js,.ts,.tsx, src --fix",
+    "type-check": "tsc --noEmit --skipLibCheck",
+    "postinstall": "cd ../../proto && buf generate"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.13.3",
+    "@emotion/styled": "^11.13.0",
+    "@mui/joy": "5.0.0-beta.48",
+    "@reduxjs/toolkit": "^2.3.0",
+    "classnames": "^2.5.1",
+    "copy-to-clipboard": "^3.3.3",
+    "dayjs": "^1.11.13",
+    "i18next": "^23.16.4",
+    "lodash-es": "^4.17.21",
+    "lucide-react": "^0.446.0",
+    "nice-grpc-web": "^3.3.5",
+    "qrcode.react": "^4.1.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-hot-toast": "^2.4.1",
+    "react-i18next": "^15.1.0",
+    "react-router-dom": "^6.27.0",
+    "react-use": "^17.5.1",
+    "tailwindcss": "^3.4.14",
+    "uuid": "^10.0.0",
+    "zustand": "^5.0.1"
+  },
+  "devDependencies": {
+    "@bufbuild/buf": "^1.46.0",
+    "@bufbuild/protobuf": "^2.2.2",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/lodash-es": "^4.17.12",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "@vitejs/plugin-react-swc": "^3.7.1",
+    "autoprefixer": "^10.4.20",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.37.2",
+    "long": "^5.2.3",
+    "postcss": "^8.4.47",
+    "prettier": "^3.3.3",
+    "protobufjs": "^7.4.0",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.10"
+  },
+  "resolutions": {
+    "csstype": "3.1.2"
+  }
+}

frontend/web/public/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-circle-slash"><line x1="9" x2="15" y1="15" y2="9"/><circle cx="12" cy="12" r="10"/></svg>

frontend/web/src/App.tsx

@@ -0,0 +1,81 @@
+import { useColorScheme } from "@mui/joy";
+import { useEffect } from "react";
+import { Outlet } from "react-router-dom";
+import DemoBanner from "@/components/DemoBanner";
+import { useWorkspaceStore } from "@/stores";
+import useNavigateTo from "./hooks/useNavigateTo";
+import { FeatureType } from "./stores/workspace";
+
+function App() {
+  const navigateTo = useNavigateTo();
+  const { mode: colorScheme } = useColorScheme();
+  const workspaceStore = useWorkspaceStore();
+
+  // Redirect to sign up page if no instance owner.
+  useEffect(() => {
+    if (!workspaceStore.profile.owner) {
+      navigateTo("/auth/signup", {
+        replace: true,
+      });
+    }
+  }, [workspaceStore.profile]);
+
+  useEffect(() => {
+    const styleEl = document.createElement("style");
+    styleEl.innerHTML = workspaceStore.setting.customStyle;
+    styleEl.setAttribute("type", "text/css");
+    document.body.insertAdjacentElement("beforeend", styleEl);
+  }, [workspaceStore.setting.customStyle]);
+
+  useEffect(() => {
+    const hasCustomBranding = workspaceStore.checkFeatureAvailable(FeatureType.CustomeBranding);
+    if (!hasCustomBranding || !workspaceStore.setting.branding) {
+      return;
+    }
+
+    const favicon = document.querySelector("link[rel='icon']") as HTMLLinkElement;
+    favicon.href = new TextDecoder().decode(workspaceStore.setting.branding);
+  }, [workspaceStore.setting.branding]);
+
+  useEffect(() => {
+    const root = document.documentElement;
+    if (colorScheme === "light") {
+      root.classList.remove("dark");
+    } else if (colorScheme === "dark") {
+      root.classList.add("dark");
+    } else {
+      const darkMediaQuery = window.matchMedia("(prefers-color-scheme: dark)");
+      if (darkMediaQuery.matches) {
+        root.classList.add("dark");
+      } else {
+        root.classList.remove("dark");
+      }
+
+      const handleColorSchemeChange = (e: MediaQueryListEvent) => {
+        if (e.matches) {
+          root.classList.add("dark");
+        } else {
+          root.classList.remove("dark");
+        }
+      };
+      try {
+        darkMediaQuery.addEventListener("change", handleColorSchemeChange);
+      } catch (error) {
+        console.error("failed to initial color scheme listener", error);
+      }
+
+      return () => {
+        darkMediaQuery.removeEventListener("change", handleColorSchemeChange);
+      };
+    }
+  }, [colorScheme]);
+
+  return (
+    <>
+      <DemoBanner />
+      <Outlet />
+    </>
+  );
+}
+
+export default App;

frontend/web/src/components/AboutDialog.tsx

@@ -1,4 +1,5 @@
 import { Button, Link, Modal, ModalDialog } from "@mui/joy";
+import { useTranslation } from "react-i18next";
 import Icon from "./Icon";
 
 interface Props {
@@ -7,24 +8,25 @@ interface Props {
 
 const AboutDialog: React.FC<Props> = (props: Props) => {
   const { onClose } = props;
+  const { t } = useTranslation();
 
   return (
     <Modal open={true}>
       <ModalDialog>
         <div className="w-full flex flex-row justify-between items-center">
-          <span className="text-lg font-medium">About</span>
+          <span className="text-lg font-medium">{t("common.about")}</span>
           <Button variant="plain" onClick={onClose}>
             <Icon.X className="w-5 h-auto text-gray-600" />
           </Button>
         </div>
         <div className="max-w-full w-80 sm:w-96">
           <p>
-            <span className="font-medium">Slash</span> is a bookmarking and short link service that allows you to save and share links
-            easily.
+            <span className="font-medium">Slash</span> is an open source, self-hosted platform for sharing and managing your most frequently
+            used links.
           </p>
           <div className="mt-1">
-            <span className="mr-2">See more in:</span>
-            <Link variant="plain" href="https://github.com/boojack/slash">
+            <span className="mr-2">Source code:</span>
+            <Link variant="plain" href="https://github.com/yourselfhosted/slash" target="_blank">
               GitHub
             </Link>
           </div>

frontend/web/src/components/Alert.tsx

@@ -45,7 +45,7 @@ const Alert: React.FC<Props> = (props: Props) => {
   return (
     <Modal open={true}>
       <ModalDialog>
-        <div className="flex flex-row justify-between items-center w-80 mb-4">
+        <div className="flex flex-row justify-between items-center w-80">
           <span className="text-lg font-medium">{title}</span>
           <Button variant="plain" onClick={handleCloseBtnClick}>
             <Icon.X className="w-5 h-auto text-gray-600" />
@@ -54,7 +54,7 @@ const Alert: React.FC<Props> = (props: Props) => {
         <div className="w-80">
           <p className="content-text mb-4">{content}</p>
           <div className="w-full flex flex-row justify-end items-center space-x-2">
-            <Button variant="plain" onClick={handleCloseBtnClick}>
+            <Button variant="plain" color="neutral" onClick={handleCloseBtnClick}>
               {closeBtnText}
             </Button>
             <Button color={style} onClick={handleConfirmBtnClick}>

frontend/web/src/components/AnalyticsView.tsx

@@ -0,0 +1,150 @@
+import classNames from "classnames";
+import { useEffect, useState } from "react";
+import { useTranslation } from "react-i18next";
+import { shortcutServiceClient } from "@/grpcweb";
+import { GetShortcutAnalyticsResponse } from "@/types/proto/api/v1/shortcut_service";
+import Icon from "./Icon";
+
+interface Props {
+  shortcutId: number;
+  className?: string;
+}
+
+const AnalyticsView: React.FC<Props> = (props: Props) => {
+  const { shortcutId, className } = props;
+  const { t } = useTranslation();
+  const [analytics, setAnalytics] = useState<GetShortcutAnalyticsResponse | null>(null);
+  const [selectedDeviceTab, setSelectedDeviceTab] = useState<"os" | "browser">("browser");
+
+  useEffect(() => {
+    shortcutServiceClient.getShortcutAnalytics({ id: shortcutId }).then((response) => {
+      setAnalytics(response);
+    });
+  }, []);
+
+  return (
+    <div className={classNames("relative w-full", className)}>
+      {analytics ? (
+        <>
+          <div className="w-full">
+            <p className="w-full h-8 px-2 dark:text-gray-500">{t("analytics.top-sources")}</p>
+            <div className="w-full mt-1 overflow-hidden shadow ring-1 ring-black ring-opacity-5 rounded-lg dark:ring-zinc-800">
+              <div className="w-full divide-y divide-gray-300 dark:divide-zinc-700">
+                <div className="w-full flex flex-row justify-between items-center">
+                  <span className="py-2 px-2 text-left font-semibold text-sm text-gray-500">{t("analytics.source")}</span>
+                  <span className="py-2 pr-2 text-right font-semibold text-sm text-gray-500">{t("analytics.visitors")}</span>
+                </div>
+                <div className="w-full divide-y divide-gray-200 dark:divide-zinc-800">
+                  {analytics.references.length === 0 && (
+                    <div className="w-full flex flex-row justify-center items-center py-6 text-gray-400">
+                      <Icon.PackageOpen className="w-6 h-auto" />
+                      <p className="ml-2">No data found.</p>
+                    </div>
+                  )}
+                  {analytics.references.map((reference) => (
+                    <div key={reference.name} className="w-full flex flex-row justify-between items-center">
+                      <span className="whitespace-nowrap py-2 px-2 text-sm truncate text-gray-900 dark:text-gray-500">
+                        {reference.name ? (
+                          <a className="hover:underline hover:text-blue-600" href={reference.name} target="_blank">
+                            {reference.name}
+                          </a>
+                        ) : (
+                          "Direct"
+                        )}
+                      </span>
+                      <span className="whitespace-nowrap py-2 pr-2 text-sm text-gray-500 text-right shrink-0">{reference.count}</span>
+                    </div>
+                  ))}
+                </div>
+              </div>
+            </div>
+          </div>
+
+          <div className="w-full">
+            <div className="w-full h-8 px-2 flex flex-row justify-between items-center">
+              <span className="dark:text-gray-500">{t("analytics.devices")}</span>
+              <div>
+                <button
+                  className={`whitespace-nowrap border-b-2 px-1 text-sm font-medium ${
+                    selectedDeviceTab === "browser"
+                      ? "border-blue-600 text-blue-600"
+                      : "border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700 dark:hover:border-zinc-700"
+                  }`}
+                  onClick={() => setSelectedDeviceTab("browser")}
+                >
+                  {t("analytics.browser")}
+                </button>
+                <span className="text-gray-200 font-mono mx-1 dark:text-gray-500">/</span>
+                <button
+                  className={`whitespace-nowrap border-b-2 px-1 text-sm font-medium ${
+                    selectedDeviceTab === "os"
+                      ? "border-blue-600 text-blue-600"
+                      : "border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700 dark:hover:border-zinc-700"
+                  }`}
+                  onClick={() => setSelectedDeviceTab("os")}
+                >
+                  OS
+                </button>
+              </div>
+            </div>
+
+            <div className="w-full mt-1 overflow-hidden shadow ring-1 ring-black ring-opacity-5 rounded-lg dark:ring-zinc-800">
+              {selectedDeviceTab === "browser" ? (
+                <div className="w-full divide-y divide-gray-300 dark:divide-zinc-700">
+                  <div className="w-full flex flex-row justify-between items-center">
+                    <span className="py-2 px-2 text-left text-sm font-semibold text-gray-500">{t("analytics.browsers")}</span>
+                    <span className="py-2 pr-2 text-right text-sm font-semibold text-gray-500">{t("analytics.visitors")}</span>
+                  </div>
+                  <div className="w-full divide-y divide-gray-200 dark:divide-zinc-800">
+                    {analytics.browsers.length === 0 && (
+                      <div className="w-full flex flex-row justify-center items-center py-6 text-gray-400">
+                        <Icon.PackageOpen className="w-6 h-auto" />
+                        <p className="ml-2">No data found.</p>
+                      </div>
+                    )}
+                    {analytics.browsers.map((reference) => (
+                      <div key={reference.name} className="w-full flex flex-row justify-between items-center">
+                        <span className="whitespace-nowrap py-2 px-2 text-sm text-gray-900 truncate dark:text-gray-500">
+                          {reference.name || "Unknown"}
+                        </span>
+                        <span className="whitespace-nowrap py-2 pr-2 text-sm text-gray-500 text-right shrink-0">{reference.count}</span>
+                      </div>
+                    ))}
+                  </div>
+                </div>
+              ) : (
+                <div className="w-full divide-y divide-gray-300">
+                  <div className="w-full flex flex-row justify-between items-center">
+                    <span className="py-2 px-2 text-left text-sm font-semibold text-gray-500">{t("analytics.operating-system")}</span>
+                    <span className="py-2 pr-2 text-right text-sm font-semibold text-gray-500">{t("analytics.visitors")}</span>
+                  </div>
+                  <div className="w-full divide-y divide-gray-200">
+                    {analytics.devices.length === 0 && (
+                      <div className="w-full flex flex-row justify-center items-center py-6 text-gray-400">
+                        <Icon.PackageOpen className="w-6 h-auto" />
+                        <p className="ml-2">No data found.</p>
+                      </div>
+                    )}
+                    {analytics.devices.map((device) => (
+                      <div key={device.name} className="w-full flex flex-row justify-between items-center">
+                        <span className="whitespace-nowrap py-2 px-2 text-sm text-gray-900 truncate">{device.name || "Unknown"}</span>
+                        <span className="whitespace-nowrap py-2 pr-2 text-sm text-gray-500 text-right shrink-0">{device.count}</span>
+                      </div>
+                    ))}
+                  </div>
+                </div>
+              )}
+            </div>
+          </div>
+        </>
+      ) : (
+        <div className="absolute py-12 w-full flex flex-row justify-center items-center opacity-80">
+          <Icon.Loader className="mr-2 w-5 h-auto animate-spin" />
+          {t("common.loading")}
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default AnalyticsView;

frontend/web/src/components/BetaBadge.tsx

@@ -0,0 +1,9 @@
+const BetaBadge = () => {
+  return (
+    <div className="text-xs border px-1 text-gray-500 bg-gray-100 rounded-full dark:bg-zinc-800 dark:border-zinc-700">
+      <span>Beta</span>
+    </div>
+  );
+};
+
+export default BetaBadge;

frontend/web/src/components/ChangePasswordDialog.tsx

@@ -1,8 +1,9 @@
 import { Button, Input, Modal, ModalDialog } from "@mui/joy";
 import { useState } from "react";
 import { toast } from "react-hot-toast";
-import useLoading from "../hooks/useLoading";
-import useUserStore from "../stores/v1/user";
+import { useTranslation } from "react-i18next";
+import useLoading from "@/hooks/useLoading";
+import { useUserStore } from "@/stores";
 import Icon from "./Icon";
 
 interface Props {
@@ -11,6 +12,7 @@ interface Props {
 
 const ChangePasswordDialog: React.FC<Props> = (props: Props) => {
   const { onClose } = props;
+  const { t } = useTranslation();
   const userStore = useUserStore();
   const [newPassword, setNewPassword] = useState("");
   const [newPasswordAgain, setNewPasswordAgain] = useState("");
@@ -44,15 +46,18 @@ const ChangePasswordDialog: React.FC<Props> = (props: Props) => {
 
     requestState.setLoading();
     try {
-      userStore.patchUser({
-        id: userStore.getCurrentUser().id,
-        password: newPassword,
-      });
+      userStore.patchUser(
+        {
+          id: userStore.getCurrentUser().id,
+          password: newPassword,
+        },
+        ["password"],
+      );
       onClose();
       toast("Password changed");
     } catch (error: any) {
       console.error(error);
-      toast.error(error.response.data.message);
+      toast.error(error.details);
     }
     requestState.setFinish();
   };
@@ -60,7 +65,7 @@ const ChangePasswordDialog: React.FC<Props> = (props: Props) => {
   return (
     <Modal open={true}>
       <ModalDialog>
-        <div className="flex flex-row justify-between items-center w-80 mb-4">
+        <div className="flex flex-row justify-between items-center w-80">
           <span className="text-lg font-medium">Change Password</span>
           <Button variant="plain" onClick={handleCloseBtnClick}>
             <Icon.X className="w-5 h-auto text-gray-600" />
@@ -77,10 +82,10 @@ const ChangePasswordDialog: React.FC<Props> = (props: Props) => {
           </div>
           <div className="w-full flex flex-row justify-end items-center space-x-2">
             <Button variant="plain" disabled={requestState.isLoading} onClick={handleCloseBtnClick}>
-              Cancel
+              {t("common.cancel")}
             </Button>
             <Button color="primary" disabled={requestState.isLoading} loading={requestState.isLoading} onClick={handleSaveBtnClick}>
-              Save
+              {t("common.save")}
             </Button>
           </div>
         </div>

frontend/web/src/components/CollectionView.tsx

@@ -0,0 +1,148 @@
+import { Tooltip } from "@mui/joy";
+import classNames from "classnames";
+import copy from "copy-to-clipboard";
+import { useState } from "react";
+import toast from "react-hot-toast";
+import { useTranslation } from "react-i18next";
+import { Link } from "react-router-dom";
+import { absolutifyLink } from "@/helpers/utils";
+import useNavigateTo from "@/hooks/useNavigateTo";
+import useResponsiveWidth from "@/hooks/useResponsiveWidth";
+import { useCollectionStore, useShortcutStore, useUserStore } from "@/stores";
+import { Collection } from "@/types/proto/api/v1/collection_service";
+import { Shortcut } from "@/types/proto/api/v1/shortcut_service";
+import { showCommonDialog } from "./Alert";
+import CreateCollectionDialog from "./CreateCollectionDrawer";
+import Icon from "./Icon";
+import ShortcutView from "./ShortcutView";
+import Dropdown from "./common/Dropdown";
+
+interface Props {
+  collection: Collection;
+}
+
+const CollectionView = (props: Props) => {
+  const { collection } = props;
+  const { t } = useTranslation();
+  const { sm } = useResponsiveWidth();
+  const navigateTo = useNavigateTo();
+  const userStore = useUserStore();
+  const currentUser = userStore.getCurrentUser();
+  const collectionStore = useCollectionStore();
+  const shortcutList = useShortcutStore().getShortcutList();
+  const [showEditDialog, setShowEditDialog] = useState<boolean>(false);
+  const shortcuts = collection.shortcutIds
+    .map((shortcutId) => shortcutList.find((shortcut) => shortcut?.id === shortcutId))
+    .filter(Boolean) as any as Shortcut[];
+  const showAdminActions = currentUser.id === collection.creatorId;
+
+  const handleCopyCollectionLink = () => {
+    copy(absolutifyLink(`/c/${collection.name}`));
+    toast.success("Collection link copied to clipboard.");
+  };
+
+  const handleDeleteCollectionButtonClick = () => {
+    showCommonDialog({
+      title: "Delete Collection",
+      content: `Are you sure to delete collection \`${collection.name}\`? You cannot undo this action.`,
+      style: "danger",
+      onConfirm: async () => {
+        await collectionStore.deleteCollection(collection.id);
+      },
+    });
+  };
+
+  const handleShortcutClick = (shortcut: Shortcut) => {
+    navigateTo(`/shortcut/${shortcut.id}`);
+  };
+
+  const handleOpenAllShortcutsButtonClick = () => {
+    shortcuts.forEach((shortcut: Shortcut) => window.open(`/s/${shortcut.name}`));
+  };
+
+  return (
+    <>
+      <div className={classNames("w-full flex flex-col justify-start items-start border rounded-lg hover:shadow dark:border-zinc-800")}>
+        <div className="bg-gray-100 dark:bg-zinc-800 px-3 py-2 w-full flex flex-row justify-between items-center rounded-t-lg">
+          <div className="w-auto flex flex-col justify-start items-start mr-2">
+            <div className="w-full truncate">
+              <Link className="leading-6 font-medium dark:text-gray-400" to={`/c/${collection.name}`} viewTransition>
+                {collection.title}
+              </Link>
+              <span className="ml-1 leading-6 text-gray-500 dark:text-gray-400" onClick={handleCopyCollectionLink}>
+                (c/{collection.name})
+              </span>
+            </div>
+            <p className="text-sm text-gray-500">{collection.description}</p>
+          </div>
+          <div className="flex flex-row justify-end items-center shrink-0 gap-2">
+            <Tooltip title="Share" placement="top" arrow>
+              <Link className="w-auto text-gray-400 cursor-pointer hover:text-gray-500" to={`/c/${collection.name}`} target="_blank">
+                <Icon.Share className="w-4 h-auto" />
+              </Link>
+            </Tooltip>
+            <Tooltip title="Open all" placement="top" arrow>
+              <button
+                className="w-auto text-gray-400 cursor-pointer hover:text-gray-500"
+                onClick={() => handleOpenAllShortcutsButtonClick()}
+              >
+                <Icon.ArrowUpRight className="w-5 h-auto" />
+              </button>
+            </Tooltip>
+            {showAdminActions && (
+              <Dropdown
+                trigger={
+                  <button className="flex flex-row justify-center items-center rounded text-gray-400 cursor-pointer hover:text-gray-500">
+                    <Icon.MoreVertical className="w-4 h-auto" />
+                  </button>
+                }
+                actionsClassName="!w-28 text-sm"
+                actions={
+                  <>
+                    <button
+                      className="w-full px-2 flex flex-row justify-start items-center text-left dark:text-gray-400 leading-8 cursor-pointer rounded hover:bg-gray-100 dark:hover:bg-zinc-800 disabled:cursor-not-allowed disabled:bg-gray-100 disabled:opacity-60"
+                      onClick={() => setShowEditDialog(true)}
+                    >
+                      <Icon.Edit className="w-4 h-auto mr-2" /> {t("common.edit")}
+                    </button>
+                    <button
+                      className="w-full px-2 flex flex-row justify-start items-center text-left text-red-600 dark:text-gray-400 leading-8 cursor-pointer rounded hover:bg-gray-100 dark:hover:bg-zinc-800 disabled:cursor-not-allowed disabled:bg-gray-100 disabled:opacity-60"
+                      onClick={() => {
+                        handleDeleteCollectionButtonClick();
+                      }}
+                    >
+                      <Icon.Trash className="w-4 h-auto mr-2" /> {t("common.delete")}
+                    </button>
+                  </>
+                }
+              ></Dropdown>
+            )}
+          </div>
+        </div>
+        <div className="w-full p-3 flex flex-row justify-start items-start flex-wrap gap-3">
+          {shortcuts.map((shortcut) => {
+            return (
+              <ShortcutView
+                key={shortcut.id}
+                className="!w-auto"
+                shortcut={shortcut}
+                alwaysShowLink={!sm}
+                onClick={() => handleShortcutClick(shortcut)}
+              />
+            );
+          })}
+        </div>
+      </div>
+
+      {showEditDialog && (
+        <CreateCollectionDialog
+          collectionId={collection.id}
+          onClose={() => setShowEditDialog(false)}
+          onConfirm={() => setShowEditDialog(false)}
+        />
+      )}
+    </>
+  );
+};
+
+export default CollectionView;

frontend/web/src/components/CreateAccessTokenDialog.tsx

@@ -0,0 +1,137 @@
+import { Button, Input, Modal, ModalDialog, Radio, RadioGroup } from "@mui/joy";
+import { useState } from "react";
+import { toast } from "react-hot-toast";
+import { useTranslation } from "react-i18next";
+import { userServiceClient } from "@/grpcweb";
+import useLoading from "@/hooks/useLoading";
+import { useUserStore } from "@/stores";
+import Icon from "./Icon";
+
+interface Props {
+  onClose: () => void;
+  onConfirm?: () => void;
+}
+
+const expirationOptions = [
+  {
+    label: "8 hours",
+    value: 3600 * 8,
+  },
+  {
+    label: "1 month",
+    value: 3600 * 24 * 30,
+  },
+  {
+    label: "Never",
+    value: 0,
+  },
+];
+
+interface State {
+  description: string;
+  expiration: number;
+}
+
+const CreateAccessTokenDialog: React.FC<Props> = (props: Props) => {
+  const { onClose, onConfirm } = props;
+  const { t } = useTranslation();
+  const currentUser = useUserStore().getCurrentUser();
+  const [state, setState] = useState({
+    description: "",
+    expiration: 3600 * 8,
+  });
+  const requestState = useLoading(false);
+
+  const setPartialState = (partialState: Partial<State>) => {
+    setState({
+      ...state,
+      ...partialState,
+    });
+  };
+
+  const handleDescriptionInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setPartialState({
+      description: e.target.value,
+    });
+  };
+
+  const handleRoleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setPartialState({
+      expiration: Number(e.target.value),
+    });
+  };
+
+  const handleSaveBtnClick = async () => {
+    if (!state.description) {
+      toast.error("Description is required");
+      return;
+    }
+
+    try {
+      await userServiceClient.createUserAccessToken({
+        id: currentUser.id,
+        description: state.description,
+        expiresAt: state.expiration ? new Date(Date.now() + state.expiration * 1000) : undefined,
+      });
+
+      if (onConfirm) {
+        onConfirm();
+      }
+      onClose();
+    } catch (error: any) {
+      console.error(error);
+      toast.error(error.details);
+    }
+  };
+
+  return (
+    <Modal open={true}>
+      <ModalDialog>
+        <div className="flex flex-row justify-between items-center w-80">
+          <span className="text-lg font-medium">Create Access Token</span>
+          <Button variant="plain" onClick={onClose}>
+            <Icon.X className="w-5 h-auto text-gray-600" />
+          </Button>
+        </div>
+        <div>
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <span className="mb-2">
+              Description <span className="text-red-600">*</span>
+            </span>
+            <div className="relative w-full">
+              <Input
+                className="w-full"
+                type="text"
+                placeholder="Some description"
+                value={state.description}
+                onChange={handleDescriptionInputChange}
+              />
+            </div>
+          </div>
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <span className="mb-2">
+              Expiration <span className="text-red-600">*</span>
+            </span>
+            <div className="w-full flex flex-row justify-start items-center text-base">
+              <RadioGroup orientation="horizontal" value={state.expiration} onChange={handleRoleInputChange}>
+                {expirationOptions.map((option) => (
+                  <Radio key={option.value} value={option.value} checked={state.expiration === option.value} label={option.label} />
+                ))}
+              </RadioGroup>
+            </div>
+          </div>
+          <div className="w-full flex flex-row justify-end items-center mt-4 space-x-2">
+            <Button color="neutral" variant="plain" disabled={requestState.isLoading} loading={requestState.isLoading} onClick={onClose}>
+              {t("common.cancel")}
+            </Button>
+            <Button color="primary" disabled={requestState.isLoading} loading={requestState.isLoading} onClick={handleSaveBtnClick}>
+              {t("common.create")}
+            </Button>
+          </div>
+        </div>
+      </ModalDialog>
+    </Modal>
+  );
+};
+
+export default CreateAccessTokenDialog;

frontend/web/src/components/CreateCollectionDrawer.tsx

@@ -0,0 +1,274 @@
+import { Button, Checkbox, DialogActions, DialogContent, DialogTitle, Divider, Drawer, Input, ModalClose } from "@mui/joy";
+import { isUndefined } from "lodash-es";
+import { useEffect, useState } from "react";
+import { toast } from "react-hot-toast";
+import { useTranslation } from "react-i18next";
+import useLoading from "@/hooks/useLoading";
+import { useCollectionStore, useShortcutStore, useWorkspaceStore } from "@/stores";
+import { Collection } from "@/types/proto/api/v1/collection_service";
+import { Visibility } from "@/types/proto/api/v1/common";
+import { Shortcut } from "@/types/proto/api/v1/shortcut_service";
+import Icon from "./Icon";
+import ShortcutView from "./ShortcutView";
+
+interface Props {
+  collectionId?: number;
+  onClose: () => void;
+  onConfirm?: () => void;
+}
+
+interface State {
+  collectionCreate: Collection;
+}
+
+const CreateCollectionDrawer: React.FC<Props> = (props: Props) => {
+  const { onClose, onConfirm, collectionId } = props;
+  const { t } = useTranslation();
+  const workspaceStore = useWorkspaceStore();
+  const collectionStore = useCollectionStore();
+  const shortcutList = useShortcutStore().getShortcutList();
+  const [state, setState] = useState<State>({
+    collectionCreate: Collection.fromPartial({
+      visibility: Visibility.WORKSPACE,
+    }),
+  });
+  const [selectedShortcuts, setSelectedShortcuts] = useState<Shortcut[]>([]);
+  const isCreating = isUndefined(collectionId);
+  const loadingState = useLoading(!isCreating);
+  const requestState = useLoading(false);
+  const unselectedShortcuts = shortcutList
+    .filter((shortcut) => {
+      if (state.collectionCreate.visibility === Visibility.PUBLIC) {
+        return shortcut.visibility === Visibility.PUBLIC;
+      } else if (state.collectionCreate.visibility === Visibility.WORKSPACE) {
+        return shortcut.visibility === Visibility.PUBLIC || shortcut.visibility === Visibility.WORKSPACE;
+      } else {
+        return true;
+      }
+    })
+    .filter((shortcut) => !selectedShortcuts.find((selectedShortcut) => selectedShortcut.id === shortcut.id));
+
+  const setPartialState = (partialState: Partial<State>) => {
+    setState({
+      ...state,
+      ...partialState,
+    });
+  };
+
+  useEffect(() => {
+    if (workspaceStore.setting.defaultVisibility !== Visibility.VISIBILITY_UNSPECIFIED) {
+      setPartialState({
+        collectionCreate: Object.assign(state.collectionCreate, {
+          visibility: workspaceStore.setting.defaultVisibility,
+        }),
+      });
+    }
+  }, []);
+
+  useEffect(() => {
+    (async () => {
+      if (collectionId) {
+        const collection = await collectionStore.getOrFetchCollectionById(collectionId);
+        if (collection) {
+          setState({
+            ...state,
+            collectionCreate: Object.assign(state.collectionCreate, {
+              ...collection,
+            }),
+          });
+          setSelectedShortcuts(
+            collection.shortcutIds
+              .map((shortcutId) => shortcutList.find((shortcut) => shortcut.id === shortcutId))
+              .filter(Boolean) as Shortcut[],
+          );
+          loadingState.setFinish();
+        }
+      }
+    })();
+  }, [collectionId]);
+
+  if (loadingState.isLoading) {
+    return null;
+  }
+
+  const handleNameInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setPartialState({
+      collectionCreate: Object.assign(state.collectionCreate, {
+        name: e.target.value.replace(/\s+/g, "-"),
+      }),
+    });
+  };
+
+  const handleTitleInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setPartialState({
+      collectionCreate: Object.assign(state.collectionCreate, {
+        title: e.target.value,
+      }),
+    });
+  };
+
+  const handleDescriptionInputChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setPartialState({
+      collectionCreate: Object.assign(state.collectionCreate, {
+        description: e.target.value,
+      }),
+    });
+  };
+
+  const handleSaveBtnClick = async () => {
+    if (!state.collectionCreate.name || !state.collectionCreate.title) {
+      toast.error("Please fill in required fields.");
+      return;
+    }
+    if (selectedShortcuts.length === 0) {
+      toast.error("Please select at least one shortcut.");
+      return;
+    }
+
+    try {
+      if (!isCreating) {
+        await collectionStore.updateCollection(
+          {
+            id: collectionId,
+            name: state.collectionCreate.name,
+            title: state.collectionCreate.title,
+            description: state.collectionCreate.description,
+            visibility: state.collectionCreate.visibility,
+            shortcutIds: selectedShortcuts.map((shortcut) => shortcut.id),
+          },
+          ["name", "title", "description", "visibility", "shortcut_ids"],
+        );
+      } else {
+        await collectionStore.createCollection({
+          ...state.collectionCreate,
+          shortcutIds: selectedShortcuts.map((shortcut) => shortcut.id),
+        });
+      }
+
+      if (onConfirm) {
+        onConfirm();
+      } else {
+        onClose();
+      }
+    } catch (error: any) {
+      console.error(error);
+      toast.error(error.details);
+    }
+  };
+
+  return (
+    <Drawer anchor="right" open={true} onClose={onClose}>
+      <DialogTitle>{isCreating ? "Create Collection" : "Edit Collection"}</DialogTitle>
+      <ModalClose />
+      <DialogContent className="w-full max-w-full">
+        <div className="overflow-y-auto w-full mt-2 px-4 pb-4 sm:w-[24rem]">
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <span className="mb-2">
+              Name <span className="text-red-600">*</span>
+            </span>
+            <Input
+              className="w-full"
+              type="text"
+              startDecorator="c/"
+              placeholder="An easy name to remember"
+              value={state.collectionCreate.name}
+              onChange={handleNameInputChange}
+            />
+          </div>
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <span className="mb-2">
+              Title <span className="text-red-600">*</span>
+            </span>
+            <div className="relative w-full">
+              <Input
+                className="w-full"
+                type="text"
+                placeholder="A short title of your collection"
+                value={state.collectionCreate.title}
+                onChange={handleTitleInputChange}
+              />
+            </div>
+          </div>
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <span className="mb-2">Description</span>
+            <div className="relative w-full">
+              <Input
+                className="w-full"
+                type="text"
+                placeholder="A slightly longer description"
+                value={state.collectionCreate.description}
+                onChange={handleDescriptionInputChange}
+              />
+            </div>
+          </div>
+          <div className="w-full flex flex-col justify-start items-start mb-3">
+            <Checkbox
+              className="w-full dark:text-gray-400"
+              checked={state.collectionCreate.visibility === Visibility.PUBLIC}
+              label={t(`shortcut.visibility.public.description`)}
+              onChange={(e) =>
+                setPartialState({
+                  collectionCreate: Object.assign(state.collectionCreate, {
+                    visibility: e.target.checked ? Visibility.PUBLIC : Visibility.WORKSPACE,
+                  }),
+                })
+              }
+            />
+          </div>
+          <Divider className="text-gray-500" />
+          <div className="w-full flex flex-col justify-start items-start mt-3 mb-3">
+            <p className="mb-2">
+              <span>Shortcuts</span>
+              <span className="opacity-60">({selectedShortcuts.length})</span>
+              {selectedShortcuts.length === 0 && <span className="ml-2 italic opacity-80 text-sm">(Select a shortcut first)</span>}
+            </p>
+            <div className="w-full py-1 px-px flex flex-row justify-start items-start flex-wrap overflow-hidden gap-2">
+              {selectedShortcuts.map((shortcut) => {
+                return (
+                  <ShortcutView
+                    key={shortcut.id}
+                    className="!w-auto select-none max-w-[40%] cursor-pointer bg-gray-100 shadow dark:bg-zinc-800 dark:border-zinc-700 dark:text-gray-400"
+                    shortcut={shortcut}
+                    onClick={() => {
+                      setSelectedShortcuts([...selectedShortcuts.filter((selectedShortcut) => selectedShortcut.id !== shortcut.id)]);
+                    }}
+                  />
+                );
+              })}
+              {unselectedShortcuts.map((shortcut) => {
+                return (
+                  <ShortcutView
+                    key={shortcut.id}
+                    className="!w-auto select-none max-w-[40%] border-dashed cursor-pointer"
+                    shortcut={shortcut}
+                    onClick={() => {
+                      setSelectedShortcuts([...selectedShortcuts, shortcut]);
+                    }}
+                  />
+                );
+              })}
+              {selectedShortcuts.length + unselectedShortcuts.length === 0 && (
+                <div className="w-full flex flex-row justify-center items-center text-gray-400">
+                  <Icon.PackageOpen className="w-6 h-auto" />
+                  <p className="ml-2">No shortcuts found.</p>
+                </div>
+              )}
+            </div>
+          </div>
+        </div>
+      </DialogContent>
+      <DialogActions>
+        <div className="w-full flex flex-row justify-end items-center px-3 py-4 space-x-2">
+          <Button color="neutral" variant="plain" disabled={requestState.isLoading} loading={requestState.isLoading} onClick={onClose}>
+            {t("common.cancel")}
+          </Button>
+          <Button color="primary" disabled={requestState.isLoading} loading={requestState.isLoading} onClick={handleSaveBtnClick}>
+            {t("common.save")}
+          </Button>
+        </div>
+      </DialogActions>
+    </Drawer>
+  );
+};
+
+export default CreateCollectionDrawer;