feat: default visibility (thomiceli#155)

Signed-off-by: jolheiser <[email protected]>

internal/db/gist.go

@@ -1,22 +1,56 @@
 package db
 
 import (
- "github.com/labstack/echo/v4"
- "github.com/thomiceli/opengist/internal/git"
- "gorm.io/gorm"
+ "fmt"
  "os/exec"
  "strings"
  "time"
+
+ "github.com/labstack/echo/v4"
+ "github.com/thomiceli/opengist/internal/git"
+ "gorm.io/gorm"
+)
+
+type Visibility int
+
+const (
+ PublicVisibility Visibility = iota
+ UnlistedVisibility
+ PrivateVisibility
 )
 
+func (v Visibility) Next() Visibility {
+ switch v {
+ case PublicVisibility:
+ return UnlistedVisibility
+ case UnlistedVisibility:
+ return PrivateVisibility
+ default:
+ return PublicVisibility
+ }
+}
+
+func ParseVisibility[T string | int](v T) (Visibility, error) {
+ switch s := fmt.Sprint(v); s {
+ case "0":
+ return PublicVisibility, nil
+ case "1":
+ return UnlistedVisibility, nil
+ case "2":
+ return PrivateVisibility, nil
+ default:
+ return -1, fmt.Errorf("unknown visibility %q", s)
+ }
+}
+
 type Gist struct {
  ID uint `gorm:"primaryKey"`
  Uuid string
  Title string
  Preview string
  PreviewFilename string
  Description string
- Private int // 0: public, 1: unlisted, 2: private
+ Private Visibility // 0: public, 1: unlisted, 2: private
  UserID uint
  User User
  NbFiles int
@@ -386,12 +420,12 @@ func (gist *Gist) UpdatePreviewAndCount() error {
 // -- DTO -- //
 
 type GistDTO struct {
- Title string `validate:"max=250" form:"title"`
- Description string `validate:"max=1000" form:"description"`
- Private int  `validate:"number,min=0,max=2" form:"private"`
- Files []FileDTO `validate:"min=1,dive"`
- Name []string `form:"name"`
- Content []string `form:"content"`
+ Title string  `validate:"max=250" form:"title"`
+ Description string  `validate:"max=1000" form:"description"`
+ Private Visibility `validate:"number,min=0,max=2" form:"private"`
+ Files []FileDTO  `validate:"min=1,dive"`
+ Name []string  `form:"name"`
+ Content []string  `form:"content"`
 }
 
 type FileDTO struct {

internal/db/user.go

@@ -100,7 +100,6 @@ func GetUsersFromEmails(emailsSet map[string]struct{}) (map[string]*User, error)
  err := db.
  Where("email IN ?", emails).
  Find(&users).Error
-
  if err != nil {
  return nil, err
  }

internal/web/gist.go

@@ -4,16 +4,17 @@ import (
  "archive/zip"
  "bytes"
  "errors"
- "github.com/google/uuid"
- "github.com/labstack/echo/v4"
- "github.com/thomiceli/opengist/internal/config"
- "github.com/thomiceli/opengist/internal/db"
- "gorm.io/gorm"
  "html/template"
  "net/url"
  "regexp"
  "strconv"
  "strings"
+
+ "github.com/google/uuid"
+ "github.com/labstack/echo/v4"
+ "github.com/thomiceli/opengist/internal/config"
+ "github.com/thomiceli/opengist/internal/db"
+ "gorm.io/gorm"
 )
 
 func gistInit(next echo.HandlerFunc) echo.HandlerFunc {
@@ -30,7 +31,7 @@ func gistInit(next echo.HandlerFunc) echo.HandlerFunc {
  return notFound("Gist not found")
  }
 
- if gist.Private == 2 {
+ if gist.Private == db.PrivateVisibility {
  if currUser == nil || currUser.ID != gist.UserID {
  return notFound("Gist not found")
  }
@@ -433,7 +434,7 @@ func processCreate(ctx echo.Context) error {
 }
 
 func toggleVisibility(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
 
  gist.Private = (gist.Private + 1) % 3
  if err := gist.Update(); err != nil {
@@ -445,7 +446,7 @@ func toggleVisibility(ctx echo.Context) error {
 }
 
 func deleteGist(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
 
  if err := gist.Delete(); err != nil {
  return errorRes(500, "Error deleting this gist", err)
@@ -456,7 +457,7 @@ func deleteGist(ctx echo.Context) error {
 }
 
 func like(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
  currentUser := getUserLogged(ctx)
 
  hasLiked, err := currentUser.HasLiked(gist)
@@ -482,7 +483,7 @@ func like(ctx echo.Context) error {
 }
 
 func fork(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
  currentUser := getUserLogged(ctx)
 
  alreadyForked, err := gist.GetForkParent(currentUser)
@@ -535,7 +536,6 @@ func fork(ctx echo.Context) error {
 func rawFile(ctx echo.Context) error {
  gist := getData(ctx, "gist").(*db.Gist)
  file, err := gist.File(ctx.Param("revision"), ctx.Param("file"), false)
-
  if err != nil {
  return errorRes(500, "Error getting file content", err)
  }
@@ -550,7 +550,6 @@ func rawFile(ctx echo.Context) error {
 func downloadFile(ctx echo.Context) error {
  gist := getData(ctx, "gist").(*db.Gist)
  file, err := gist.File(ctx.Param("revision"), ctx.Param("file"), false)
-
  if err != nil {
  return errorRes(500, "Error getting file content", err)
  }
@@ -572,7 +571,7 @@ func downloadFile(ctx echo.Context) error {
 }
 
 func edit(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
 
  files, err := gist.Files("HEAD")
  if err != nil {
@@ -586,8 +585,8 @@ func edit(ctx echo.Context) error {
 }
 
 func downloadZip(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
- var revision = ctx.Param("revision")
+ gist := getData(ctx, "gist").(*db.Gist)
+ revision := ctx.Param("revision")
 
  files, err := gist.Files(revision)
  if err != nil {
@@ -631,7 +630,7 @@ func downloadZip(ctx echo.Context) error {
 }
 
 func likes(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
 
  pageInt := getPage(ctx)
 
@@ -650,7 +649,7 @@ func likes(ctx echo.Context) error {
 }
 
 func forks(ctx echo.Context) error {
- var gist = getData(ctx, "gist").(*db.Gist)
+ gist := getData(ctx, "gist").(*db.Gist)
  pageInt := getPage(ctx)
 
  currentUser := getUserLogged(ctx)

internal/web/git_http.go

@@ -6,13 +6,6 @@ import (
  "encoding/base64"
  "errors"
  "fmt"
- "github.com/google/uuid"
- "github.com/labstack/echo/v4"
- "github.com/rs/zerolog/log"
- "github.com/thomiceli/opengist/internal/db"
- "github.com/thomiceli/opengist/internal/git"
- "github.com/thomiceli/opengist/internal/memdb"
- "gorm.io/gorm"
  "net/http"
  "os"
  "os/exec"
@@ -21,6 +14,14 @@ import (
  "strconv"
  "strings"
  "time"
+
+ "github.com/google/uuid"
+ "github.com/labstack/echo/v4"
+ "github.com/rs/zerolog/log"
+ "github.com/thomiceli/opengist/internal/db"
+ "github.com/thomiceli/opengist/internal/git"
+ "github.com/thomiceli/opengist/internal/memdb"
+ "gorm.io/gorm"
 )
 
 var routes = []struct {
@@ -73,7 +74,7 @@ func gitHttp(ctx echo.Context) error {
  // - user wants to clone/pull a private gist
  // - gist is not found (obfuscation)
  // - admin setting to require login is set to true
- if isPull && gist.Private != 2 && gist.ID != 0 && !getData(ctx, "RequireLogin").(bool) {
+ if isPull && gist.Private != db.PrivateVisibility && gist.ID != 0 && !getData(ctx, "RequireLogin").(bool) {
  return route.handler(ctx)
  }