Refactoring JS, adding note for upload requests, better view for public upload

Author: Forceu

build/go-generate/minifyStaticContent.go

@@ -72,16 +72,10 @@ func getPaths() []converter {
 		Name:       "wasm_exec JS",
 	})
 	result = append(result, converter{
-		InputPath:  pathPrefix + "js/dateformat.js",
-		OutputPath: pathPrefix + "js/min/dateformat.min.js",
+		InputPath:  pathPrefix + "js/all_public.js",
+		OutputPath: pathPrefix + "js/min/all_public.min.js",
 		Type:       "text/javascript",
-		Name:       "Dateformat JS",
-	})
-	result = append(result, converter{
-		InputPath:  pathPrefix + "js/uuid.js",
-		OutputPath: pathPrefix + "js/min/uuid.min.js",
-		Type:       "text/javascript",
-		Name:       "UUID JS",
+		Name:       "Public functions JS",
 	})
 	return result
 }

internal/configuration/database/provider/sqlite/Sqlite.go

@@ -60,6 +60,7 @@ func (p DatabaseProvider) Upgrade(currentDbVersion int) {
 										"maxSize"	INTEGER NOT NULL,
 										"creation"	INTEGER NOT NULL,
 										"apiKey"	TEXT NOT NULL UNIQUE,
+										"note"	TEXT NOT NULL,
 										PRIMARY KEY("id")
 									 );
 									CREATE TABLE "Presign" (
@@ -227,6 +228,7 @@ func (p DatabaseProvider) createNewDatabase() error {
 			"maxSize"	INTEGER NOT NULL,
 			"creation"	INTEGER NOT NULL,
 			"apiKey"	TEXT NOT NULL UNIQUE,
+			"note"	TEXT NOT NULL,
 			PRIMARY KEY("id")
 		);
 		CREATE TABLE "Presign" (

internal/configuration/database/provider/sqlite/filerequests.go

@@ -17,14 +17,15 @@ type schemaFileRequests struct {
 	MaxSize  int
 	Creation int64
 	ApiKey   string
+	Note     string
 }
 
 // GetFileRequest returns the FileRequest or false if not found
 func (p DatabaseProvider) GetFileRequest(id string) (models.FileRequest, bool) {
 	var rowResult schemaFileRequests
 	row := p.sqliteDb.QueryRow("SELECT * FROM UploadRequests WHERE Id = ?", id)
 	err := row.Scan(&rowResult.Id, &rowResult.Name, &rowResult.UserId, &rowResult.Expiry,
-		&rowResult.MaxFiles, &rowResult.MaxSize, &rowResult.Creation, &rowResult.ApiKey)
+		&rowResult.MaxFiles, &rowResult.MaxSize, &rowResult.Creation, &rowResult.ApiKey, &rowResult.Note)
 	if err != nil {
 		if errors.Is(err, sql.ErrNoRows) {
 			return models.FileRequest{}, false
@@ -41,6 +42,7 @@ func (p DatabaseProvider) GetFileRequest(id string) (models.FileRequest, bool) {
 		Expiry:       rowResult.Expiry,
 		CreationDate: rowResult.Creation,
 		ApiKey:       rowResult.ApiKey,
+		Notes:        rowResult.Note,
 	}
 	return result, true
 }
@@ -54,7 +56,7 @@ func (p DatabaseProvider) GetAllFileRequests() []models.FileRequest {
 	for rows.Next() {
 		rowData := schemaFileRequests{}
 		err = rows.Scan(&rowData.Id, &rowData.Name, &rowData.UserId, &rowData.Expiry, &rowData.MaxFiles,
-			&rowData.MaxSize, &rowData.Creation, &rowData.ApiKey)
+			&rowData.MaxSize, &rowData.Creation, &rowData.ApiKey, &rowData.Note)
 		helper.Check(err)
 		result = append(result, models.FileRequest{
 			Id:           rowData.Id,
@@ -65,6 +67,7 @@ func (p DatabaseProvider) GetAllFileRequests() []models.FileRequest {
 			Expiry:       rowData.Expiry,
 			CreationDate: rowData.Creation,
 			ApiKey:       rowData.ApiKey,
+			Notes:        rowData.Note,
 		})
 	}
 	return result
@@ -81,10 +84,13 @@ func (p DatabaseProvider) SaveFileRequest(request models.FileRequest) {
 		Expiry:   request.Expiry,
 		Creation: request.CreationDate,
 		ApiKey:   request.ApiKey,
+		Note:     request.Notes,
 	}
 
-	_, err := p.sqliteDb.Exec("INSERT OR REPLACE INTO UploadRequests (id, name, userid, expiry, maxFiles, maxSize, creation, apiKey) VALUES  (?, ?, ?, ?, ?, ?, ?, ?)",
-		newData.Id, newData.Name, newData.UserId, newData.Expiry, newData.MaxFiles, newData.MaxSize, newData.Creation, newData.ApiKey)
+	_, err := p.sqliteDb.Exec(`INSERT OR REPLACE INTO UploadRequests
+   				 (id, name, userid, expiry, maxFiles, maxSize, creation, apiKey, note) 
+         			 VALUES  (?, ?, ?, ?, ?, ?, ?, ?, ?)`,
+		newData.Id, newData.Name, newData.UserId, newData.Expiry, newData.MaxFiles, newData.MaxSize, newData.Creation, newData.ApiKey, newData.Note)
 	helper.Check(err)
 }
 

internal/models/FileRequest.go

@@ -8,23 +8,25 @@ import (
 )
 
 type FileRequest struct {
-	Id            string   `json:"id" redis:"id"`                     // The internal ID of the file request
-	UserId        int      `json:"userid" redis:"userid"`             // The user ID of the owner
-	MaxFiles      int      `json:"maxfiles" redis:"maxfiles"`         // The maximum number of files allowed
-	MaxSize       int      `json:"maxsize" redis:"maxsize"`           // The maximum file size allowed in MB
-	Expiry        int64    `json:"expiry" redis:"expiry"`             // The expiry time of the file request
-	CreationDate  int64    `json:"creationdate" redis:"creationdate"` // The timestamp of the file request creation
-	Name          string   `json:"name" redis:"name"`                 // The given name for the file request
-	ApiKey        string   `json:"apikey" redis:"apikey"`             // The API key related to the file request
-	UploadedFiles int      `json:"uploadedfiles" redis:"-"`           // Contains the number of uploaded files for this request. Needs to be calculated with Populate()
-	LastUpload    int64    `json:"lastupload" redis:"-"`              // Contains the timestamp of the last upload for this request. Needs to be calculated with Populate()
-	TotalFileSize int64    `json:"totalfilesize" redis:"-"`           // Contains the file size of all uploaded files. Needs to be calculated with Populate()
-	FileIdList    []string `json:"fileidlist" redis:"-"`              // Contains an array of the IDs of all uploaded files. Needs to be calculated with Populate()
-	Files         []File   `json:"-" redis:"-"`                       // Contains an array of the IDs of all uploaded files. Needs to be calculated with Populate()
+	Id              string   `json:"id" redis:"id"`                     // The internal ID of the file request
+	UserId          int      `json:"userid" redis:"userid"`             // The user ID of the owner
+	MaxFiles        int      `json:"maxfiles" redis:"maxfiles"`         // The maximum number of files allowed
+	MaxSize         int      `json:"maxsize" redis:"maxsize"`           // The maximum file size allowed in MB
+	Expiry          int64    `json:"expiry" redis:"expiry"`             // The expiry time of the file request
+	CreationDate    int64    `json:"creationdate" redis:"creationdate"` // The timestamp of the file request creation
+	Name            string   `json:"name" redis:"name"`                 // The given name for the file request
+	ApiKey          string   `json:"apikey" redis:"apikey"`             // The API key related to the file request
+	Notes           string   `json:"notes" redis:"notes"`               // The custom note that was set for this file request
+	UploadedFiles   int      `json:"uploadedfiles" redis:"-"`           // Contains the number of uploaded files for this request. Needs to be calculated with Populate()
+	CombinedMaxSize int      `json:"combinedmaxsize" redis:"-"`         // The lesser of MaxSize and the server's max upload size. Needs to be calculated with Populate()
+	LastUpload      int64    `json:"lastupload" redis:"-"`              // Contains the timestamp of the last upload for this request. Needs to be calculated with Populate()
+	TotalFileSize   int64    `json:"totalfilesize" redis:"-"`           // Contains the file size of all uploaded files. Needs to be calculated with Populate()
+	FileIdList      []string `json:"fileidlist" redis:"-"`              // Contains an array of the IDs of all uploaded files. Needs to be calculated with Populate()
+	Files           []File   `json:"-" redis:"-"`                       // Contains an array of the IDs of all uploaded files. Needs to be calculated with Populate()
 }
 
 // Populate inserts the number of uploaded files and the last upload date
-func (f *FileRequest) Populate(files map[string]File) {
+func (f *FileRequest) Populate(files map[string]File, maxServerSize int) {
 	f.FileIdList = make([]string, 0)
 	f.Files = make([]File, 0)
 	for _, file := range files {
@@ -38,6 +40,10 @@ func (f *FileRequest) Populate(files map[string]File) {
 			}
 		}
 	}
+	f.CombinedMaxSize = f.MaxSize
+	if f.MaxSize == 0 || f.MaxSize > maxServerSize {
+		f.CombinedMaxSize = maxServerSize
+	}
 }
 
 // GetReadableDateLastUpdate returns the last update date as YYYY-MM-DD HH:MM:SS
@@ -67,3 +73,19 @@ func (f *FileRequest) IsUnlimitedFiles() bool {
 func (f *FileRequest) IsUnlimitedTime() bool {
 	return f.Expiry == 0
 }
+
+func (f *FileRequest) IsExpired() bool {
+	return !f.IsUnlimitedTime() && time.Now().Unix() > f.Expiry
+}
+
+func (f *FileRequest) HasRestrictions() bool {
+	return !(f.IsUnlimitedSize() && f.IsUnlimitedFiles() && f.IsUnlimitedTime())
+}
+
+func (f *FileRequest) FilesRemaining() int {
+	result := f.MaxFiles - f.UploadedFiles
+	if result < 0 {
+		return 0
+	}
+	return result
+}

internal/storage/filerequest/Filerequest.go

@@ -3,6 +3,7 @@ package filerequest
 import (
 	"time"
 
+	"github.com/forceu/gokapi/internal/configuration"
 	"github.com/forceu/gokapi/internal/configuration/database"
 	"github.com/forceu/gokapi/internal/helper"
 	"github.com/forceu/gokapi/internal/models"
@@ -25,7 +26,7 @@ func Get(id string) (models.FileRequest, bool) {
 	if !ok {
 		return models.FileRequest{}, false
 	}
-	result.Populate(database.GetAllMetadata())
+	result.Populate(database.GetAllMetadata(), configuration.Get().MaxFileSizeMB)
 	return result, true
 }
 
@@ -35,8 +36,9 @@ func GetAll() []models.FileRequest {
 		return result
 	}
 	allFiles := database.GetAllMetadata()
+	maxServerSize := configuration.Get().MaxFileSizeMB
 	for i, request := range result {
-		request.Populate(allFiles)
+		request.Populate(allFiles, maxServerSize)
 		result[i] = request
 	}
 	return result

internal/webserver/Webserver.go

@@ -916,11 +916,11 @@ func showPublicUpload(w http.ResponseWriter, r *http.Request) {
 
 	config := configuration.Get()
 
-	view := filerequestView{
+	view := publicUploadView{
 		PublicName:    config.PublicName,
-		ApiKey:        apiKey,
-		FileRequestId: fileRequestId,
-		ChunkSize:     configuration.Get().ChunkSize,
+		ChunkSize:     config.ChunkSize,
+		MaxServerSize: config.MaxFileSizeMB,
+		FileRequest:   &request,
 		CustomContent: customStaticInfo,
 	}
 
@@ -1111,13 +1111,13 @@ type oauthErrorView struct {
 	CustomContent        customStatic
 }
 
-// A view containing parameters for a generic template
-type filerequestView struct {
+// A view containing parameters for the public upload page
+type publicUploadView struct {
 	IsAdminView    bool
 	IsDownloadView bool
 	PublicName     string
-	ApiKey         string
-	FileRequestId  string
 	ChunkSize      int
+	MaxServerSize  int
 	CustomContent  customStatic
+	FileRequest    *models.FileRequest
 }

internal/webserver/api/Api.go

@@ -976,6 +976,9 @@ func apiURequestSave(w http.ResponseWriter, r requestParser, user models.User) {
 	if request.IsMaxSizeSet {
 		uploadRequest.MaxSize = request.MaxSize
 	}
+	if request.IsNotesSet {
+		uploadRequest.Notes = request.Notes
+	}
 	database.SaveFileRequest(uploadRequest)
 	uploadRequest, ok = filerequest.Get(uploadRequest.Id)
 	if isNewRequest {

internal/webserver/api/routing.go

@@ -681,13 +681,15 @@ func (p *paramURequestDelete) ProcessParameter(_ *http.Request) error {
 type paramURequestSave struct {
 	Id            string `header:"id"`
 	Name          string `header:"name" supportBase64:"true"`
+	Notes         string `header:"notes" supportBase64:"true"`
 	Expiry        int64  `header:"expiry"`
 	MaxFiles      int    `header:"maxfiles"`
 	MaxSize       int    `header:"maxsize"`
 	IsNameSet     bool
 	IsExpirySet   bool
 	IsMaxFilesSet bool
 	IsMaxSizeSet  bool
+	IsNotesSet    bool
 
 	foundHeaders map[string]bool
 }
@@ -705,6 +707,9 @@ func (p *paramURequestSave) ProcessParameter(_ *http.Request) error {
 	if p.foundHeaders["maxsize"] {
 		p.IsMaxSizeSet = true
 	}
+	if p.foundHeaders["notes"] {
+		p.IsNotesSet = true
+	}
 	return nil
 }
 

internal/webserver/api/routingParsing.go

@@ -1391,6 +1391,17 @@
               "type": "string"
             }
           },
+          {
+            "name": "notes",
+            "in": "header",
+            "description": "The public notes for the request. If the notes includes non-ANSI characters, you can encode them with base64, by adding 'base64:' at the beginning, e.g. 'base64:ZmlsZW5hbWU='",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "expiry",
             "in": "header",
@@ -1936,7 +1947,7 @@
           "id": {
             "type": "string",
             "description": "The internal ID of the file request",
-            "example": "137"
+            "example": "caep3Ooquu6phoo"
           },
           "userid": {
             "type": "integer",
@@ -1973,6 +1984,11 @@
             "description": "The given name for the file request",
             "example": "Book list entries"
           },
+          "notes": {
+            "type": "string",
+            "description": "The public notes for the file request",
+            "example": "Please make sure to upload revision 1 files"
+          },
           "apikey": {
             "type": "string",
             "description": "The API key that is used for uploading files for this request",