Compare commits

..

38 Commits

Author SHA1 Message Date
Daniel Legt 3a6c796cac * Reverse Proxy Warning 2022-06-14 23:59:34 +03:00
Daniel Legt 6376fa9128 * Removed the header pass-through 2022-06-13 22:19:49 +03:00
Daniel Legt ca10033ecf Merge branch 'master' of https://github.com/JustKato/FreePad 2022-06-07 02:42:03 +03:00
Daniel Legt b68e5c8e88 REVERT 2022-06-07 02:41:31 +03:00
Daniel Legt 84ccd44fd7 Merge branch 'master' of https://github.com/JustKato/FreePad 2022-06-07 02:26:58 +03:00
Daniel Legt 0a1bff5cd4 * Branch reset 2022-06-07 02:26:55 +03:00
Daniel Legt 7982d564e8 * 2022-06-07 02:25:31 +03:00
Daniel Legt becbf30752 . 2022-06-07 02:04:21 +03:00
Daniel Legt 796a3b07c4 * Debug on live 2022-06-07 01:53:47 +03:00
Daniel Legt 5518103575 * Cleanup 2022-06-07 01:44:48 +03:00
Daniel Legt 177ab62720 * Hopefully a fix 2022-06-07 01:40:25 +03:00
Daniel Legt 5a8ccf20a8 * Quick protocol fix client-side 2022-06-07 01:13:45 +03:00
Daniel Legt a71be11135
Merge pull request #17 from JustKato/feature/web-sockets
Feature/web sockets
2022-06-07 00:56:44 +03:00
Daniel Legt 30dc23c847 * Dynamic updates for highlights 2022-06-07 00:53:25 +03:00
Daniel Legt 0a3b5d50f2 * Default to scroll at the bottom of content 2022-06-07 00:39:05 +03:00
Daniel Legt b4c47ded35 * Better text update follow 2022-06-07 00:37:35 +03:00
Daniel Legt 6e401a416f * Fixed light pad title style 2022-06-07 00:29:30 +03:00
Daniel Legt 3b137c5ed6 * Fixed invisible edit button on Light Mode 2022-06-07 00:28:53 +03:00
Daniel Legt c4f6496e0e * Restyled the Pad title 2022-06-07 00:27:51 +03:00
Daniel Legt ee9516a109 * Fixed annoying alignment of edit/view 2022-06-07 00:20:26 +03:00
Daniel Legt 7dcad9dc31 * Archive Fix 2022-06-07 00:16:27 +03:00
Daniel Legt 1b1fe59877 * Fixed preview not updating 2022-06-07 00:04:49 +03:00
Daniel Legt 6cc1628e77 Real time WebSocket pasting
+ Pad update moved to sockets
+ Pad status updates instantly update
TODO: Fix live text highlight
2022-06-07 00:02:31 +03:00
Daniel Legt bf144c6ecb * Fixed possible bug 2022-06-06 22:50:20 +03:00
Daniel Legt 1d3383c8c6 * Removed deprecated variable 2022-06-06 22:49:55 +03:00
Daniel Legt 4138386fb3 * Some code notes 2022-06-04 16:36:30 +03:00
Daniel Legt cfe2c06dac WebSockets Work started
+ Implemented Gorilla Sockets
+ Implemented a javascript class
+ Golang Struct introduced
+ JSON parsing from the websocket
+ Fail handlers
2022-06-04 16:32:53 +03:00
Daniel Legt 400fd23b3e
Merge pull request #15 from JustKato/feature/admin-interface
Everything seems stable! Been tested just by myself, so if some other people could do some security testing, it'd be awesome!
2022-06-04 13:24:19 +03:00
Daniel Legt bf1d032e68 + Deletion implemented 2022-06-03 23:15:20 +03:00
Daniel Legt faff1ab527 + Deletion Confirmation 2022-06-03 22:59:44 +03:00
Daniel Legt d056a4d429 * Removed debug line 2022-06-03 22:56:53 +03:00
Daniel Legt b710d24a2d * Previous commit 2022-06-03 22:56:25 +03:00
Daniel Legt c3c9aacac3 + Admin interface
+ Pad Listing
@TODO: Add pagination
2022-06-03 22:56:19 +03:00
Daniel Legt d949b3decb Working on the admin interface
+ Implemented login token
+ Routing
+ Admin controller
+ Login Page
* Updated `.env` example
2022-06-02 23:53:32 +03:00
Daniel Legt 662dad90b7
Merge pull request #13 from JustKato/feature/dockerFileBuild
Dockerfile Build Improvements
2022-06-01 21:30:04 +03:00
Daniel Legt 1585d3b158 * Replaced alpine with Scratch
* Changed comments
* Used /src instead of /app twice
2022-06-01 21:28:57 +03:00
Daniel Legt 1d50efe3c6 Dockerfile Build Improvements 2022-06-01 21:24:03 +03:00
Daniel Legt 0f5a352fc6 * Docker Compose example updated 2022-06-01 18:43:35 +03:00
19 changed files with 912 additions and 19 deletions

View File

@ -21,4 +21,8 @@ CLEANUP_MAX_AGE=43200 # Default is a month
# Maximum pad file lenght, this is in characters, a character is one byte.
# Default: 524288 ( 500kb )
MAXIMUM_PAD_SIZE=524288
MAXIMUM_PAD_SIZE=524288
# Your admin access token
# If the value is not defined the admin interface will not be available
# ADMIN_TOKEN=SUPER_SECRET_ADMIN_TOKEN

View File

@ -1,9 +1,27 @@
FROM alpine
# Importing golang 1.18 to use as a builder for our source
FROM golang:1.18 as builder
# Use the /src directory as a workdir
WORKDIR /src
# Copy the src to /src
COPY . ./
# Download dependencies
RUN go mod download
# Build the executable
RUN CGO_ENABLED=0 go build -a -installsuffix cgo -o freepad .
# Import alpine linux as a base
FROM scratch
LABEL version="1.4.0"
# Copy the distribution files
COPY ./dist /app
# Copy the files from the builder to the new image
COPY --from=builder /src/freepad /app/freepad
COPY --from=builder /src/templates /app/templates
COPY --from=builder /src/static /app/static
# Make /app the work directory
WORKDIR /app

View File

@ -19,6 +19,29 @@ The project is absolutely free to use, you can extend the code and even contribu
The current maintainer and creator is `Kato Twofold`
# 🛑 About reverse proxying 🛑
If you are looking to reverse proxy this program, please keep in mind that the websockets have specific settings regarding reverse proxying, I have tried using `Apache2` but to no luck, if someone could give a suggestion as to how to set up my own program on `Apache2` it'd be amazing.
On `Nginx` it's rather simple, here is my reverse proxy for the demo at [pad.justkato.me](https://pad.justkato.me/)
```nginx
server {
# Define the basic information such as server name and log location
server_name pad.justkato.me
access_log logs/pad.justkato.me.access.log main;
# setup the reverse proxy
location / {
proxy_pass http://127.0.0.1:1626;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
# WebSocket support !! Important !!
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
}
```
![Gopher](static/img/banner_prerequisites.png)

View File

@ -3,13 +3,13 @@ version: '3'
services:
freepad:
# Uncomment the bellow to use the production docker image from the docker repository
# image:
image: justkato/freepad
# Comment the build line if you are just looking to use a docker-compose file
build: .
# build: .
# I don't recommend changing the 8080 as there would be no reason to,
# simply change the 3113 port to anything you would like for the container to listen on
ports:
- 3113:8080
- 8080:8080
# This will read from your .env variables, in that file you will find the documentation as well
environment:
- DOMAIN_BASE

2
go.mod
View File

@ -4,6 +4,8 @@ go 1.15
require (
github.com/gin-gonic/gin v1.7.7
github.com/google/uuid v1.3.0 // indirect
github.com/gorilla/websocket v1.5.0 // indirect
github.com/joho/godotenv v1.4.0
github.com/mrz1836/go-sanitize v1.1.5
github.com/ulule/limiter/v3 v3.10.0

4
go.sum
View File

@ -38,6 +38,10 @@ github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg=
github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=

View File

@ -0,0 +1,62 @@
package controllers
import (
"crypto/sha512"
"encoding/hex"
"fmt"
"net/http"
"github.com/JustKato/FreePad/lib/helper"
"github.com/gin-gonic/gin"
)
func AdminMiddleware(router *gin.RouterGroup) {
// Handl
router.Use(func(ctx *gin.Context) {
// Check which route we are accessing
fmt.Println(`Accesing: `, ctx.Request.RequestURI)
// Check if the request is other than the login request
if ctx.Request.RequestURI != "/admin/login" {
// Check if the user is logged-in
fmt.Println(`Checking if admin`)
if !IsAdmin(ctx) {
// Not an admin, redirect to homepage
ctx.Redirect(http.StatusTemporaryRedirect, "/")
ctx.Abort()
fmt.Println(`Not an admin!`)
return
}
}
})
}
func IsAdmin(ctx *gin.Context) bool {
adminToken, err := ctx.Cookie("admin_token")
if err != nil {
return false
}
// Encode the real token
sha512Hasher := sha512.New()
sha512Hasher.Write([]byte(helper.GetAdminToken()))
hashHexToken := sha512Hasher.Sum(nil)
trueToken := hex.EncodeToString(hashHexToken)
// Check if the user's admin token matches the token
if adminToken != "" && adminToken == trueToken {
// Yep, it's the admin!
return true
}
// Definitely not an admin
return false
}

View File

@ -72,3 +72,18 @@ func GetCacheMapLimit() int {
return rez
}
// Get the admin token used to authenticate as an admin
func GetAdminToken() string {
// Get the admin login from the environment
adminToken, exists := os.LookupEnv("ADMIN_TOKEN")
// Check if the admin token was defined
if !exists {
// The admin token was not defined, disable admin logins
return ""
}
// Return the admin token
return adminToken
}

View File

@ -26,6 +26,13 @@ type Post struct {
Views uint32 `json:"views"`
}
func (p *Post) Delete() error {
filePath := path.Join(getStorageDirectory(), p.Name)
// Remove the file and return the result
return os.Remove(filePath)
}
// Get the path to the views JSON
func getViewsFilePath() (string, error) {
// Get the path to the storage then append the const name for the storage file
@ -94,7 +101,7 @@ func LoadViewsCache() error {
return nil
}
func AddViewToPost(postName string) uint32 {
func AddViewToPost(postName string, incrementViews bool) uint32 {
// Lock the viewers mapping
viewersLock.Lock()
@ -104,8 +111,10 @@ func AddViewToPost(postName string) uint32 {
ViewsCache[postName] = 0
}
// Add to the counter
ViewsCache[postName]++
if incrementViews {
// Add to the counter
ViewsCache[postName]++
}
// Unlock
viewersLock.Unlock()
@ -175,7 +184,7 @@ func getStorageDirectory() string {
}
// Get a post from the file system
func GetPost(fileName string) Post {
func GetPost(fileName string, incrementViews bool) Post {
// Get the base storage directory and make sure it exists
storageDir := getStorageDirectory()
@ -183,7 +192,7 @@ func GetPost(fileName string) Post {
filePath := fmt.Sprintf("%s%s", storageDir, fileName)
// Get the post views and add 1 to them
postViews := AddViewToPost(fileName)
postViews := AddViewToPost(fileName, incrementViews)
p := Post{
Name: fileName,
@ -295,3 +304,30 @@ func CleanupPosts(age int) {
}
}
func GetAllPosts() []Post {
// Initialize the list of posts
postList := []Post{}
// Get the posts storage directory
storageDir := getStorageDirectory()
// Read the directory listing
files, err := os.ReadDir(storageDir)
// Check if thereh as been an issues with reading the directory contents
if err != nil {
// Log the error
fmt.Println("Error::GetAllPosts:", err)
// Return an empty list to have a clean fallback
return []Post{}
}
// Go through all of the files
for _, v := range files {
// Process the file into a pad
postList = append(postList, GetPost(v.Name(), false))
}
// Return the post list
return postList
}

View File

@ -0,0 +1,95 @@
package routes
import (
"encoding/hex"
"fmt"
"net/http"
"github.com/JustKato/FreePad/lib/controllers"
"github.com/JustKato/FreePad/lib/helper"
"github.com/JustKato/FreePad/lib/objects"
"github.com/gin-gonic/gin"
"crypto/sha512"
)
var adminLoginToken string = ""
func AdminRoutes(router *gin.RouterGroup) {
adminLoginToken = helper.GetAdminToken()
// Apply the admin middleware for identification
controllers.AdminMiddleware(router)
// Admin login route
router.GET("/login", func(ctx *gin.Context) {
ctx.HTML(200, "admin_login.html", gin.H{
"title": "Login Login",
"domain_base": helper.GetDomainBase(),
})
})
router.POST("/login", func(ctx *gin.Context) {
// Get the value of the admin token
adminToken := ctx.PostForm("admin-token")
// Check if the input admin token matches our admin token
if adminLoginToken != "" && adminLoginToken == adminToken {
sha512Hasher := sha512.New()
sha512Hasher.Write([]byte(adminToken))
// Set the cookie to be an admin
hashHexToken := sha512Hasher.Sum(nil)
hashToken := hex.EncodeToString(hashHexToken)
// Set the cookie
ctx.SetCookie("admin_token", hashToken, 60*60, "/", helper.GetDomainBase(), true, true)
ctx.Request.Method = "GET"
// Redirect the user to the admin page
ctx.Redirect(http.StatusFound, "/admin/view")
return
} else {
ctx.Request.Method = "GET"
// Redirect the user to the admin page
ctx.Redirect(http.StatusFound, "/admin/login?fail")
return
}
})
router.GET("/delete/:padname", func(ctx *gin.Context) {
// Get the pad name that we bout' to delete
padName := ctx.Param("padname")
// Try and get the pad, check if valid
pad := objects.GetPost(padName, false)
// Delete the pad
err := pad.Delete()
fmt.Println(err)
// Redirect the user to the admin page
ctx.Redirect(http.StatusFound, "/admin/view")
})
// Admin view route
router.GET("/view", func(ctx *gin.Context) {
// Get all of the pads as a listing
padList := objects.GetAllPosts()
ctx.HTML(200, "admin_view.html", gin.H{
"title": "Admin",
"padList": padList,
"domain_base": helper.GetDomainBase(),
})
})
}

View File

@ -41,7 +41,7 @@ func HomeRoutes(router *gin.Engine) {
}
postName = sanitize.XSS(sanitize.SingleLine(postName))
post := objects.GetPost(postName)
post := objects.GetPost(postName, true)
c.HTML(200, "page.html", gin.H{
"title": postName,

View File

@ -0,0 +1,197 @@
package socketmanager
import (
"encoding/json"
"errors"
"fmt"
"github.com/JustKato/FreePad/lib/objects"
"github.com/gin-gonic/gin"
"github.com/google/uuid"
"github.com/gorilla/websocket"
)
var wsUpgrader = websocket.Upgrader{
ReadBufferSize: 1024, // TODO: Make it configurable via the .env file
WriteBufferSize: 1024, // TODO: Make it configurable via the .env file
}
// The pad socket map caches all of the existing sockets
var padSocketMap map[string]map[string]*websocket.Conn = make(map[string]map[string]*websocket.Conn)
// TODO: Use generics so that we can take string messages, that'd be nice!
type SocketMessage struct {
EventType string `json:"eventType"`
PadName string `json:"padName"`
Message map[string]interface{} `json:"message"`
}
// Bind the websockets to the gin router
func BindSocket(router *gin.RouterGroup) {
router.GET("/get/:pad", func(ctx *gin.Context) {
// Get the name of the pad to assign to this socket
padName := ctx.Param("pad")
// Upgrade the socket connection
webSocketUpgrade(ctx, padName)
})
}
func webSocketUpgrade(ctx *gin.Context, padName string) {
conn, err := wsUpgrader.Upgrade(ctx.Writer, ctx.Request, nil)
if err != nil {
fmt.Printf("Failed to set websocket upgrade: %v\n", err)
return
}
// Check if we have any sockets in this padName
if _, ok := padSocketMap[padName]; !ok {
// Initialize a new map of sockets
padSocketMap[padName] = make(map[string]*websocket.Conn)
}
// Give this socket a token
socketToken := uuid.NewString()
// Set the current connection at the socket Token position
padSocketMap[padName][socketToken] = conn
// Somone just connected
UpdatePadStatus(padName)
// Start listening to this socket
for {
// Try Read the JSON input from the socket
_, msg, err := conn.ReadMessage()
// Check if anything but a read limit was created
if err != nil && !errors.Is(err, websocket.ErrReadLimit) {
// Remove self from the cache
delete(padSocketMap[padName], socketToken)
// Somone just disconnected
UpdatePadStatus(padName)
break
}
if err != nil {
// There has been an error reading the message
fmt.Println("Failed to read from the socket but probably still connected")
// Skip this cycle
continue
}
// Init the variable
var p SocketMessage
// Try and parse the json
err = json.Unmarshal([]byte(msg), &p)
if err != nil {
// There has been an error reading the message
fmt.Println("Failed to parse the JSON", err)
// Skip this cycle
continue
}
// Pass the message to the proper handlers
handleSocketMessage(p, socketToken, padName)
}
}
// Handle the socket's message
func handleSocketMessage(msg SocketMessage, socketToken string, padName string) {
// Check if this is a pad Update
if msg.EventType == `padUpdate` {
handlePadUpdate(msg, socketToken, padName)
// Serialize the message
serialized, err := json.Marshal(msg)
// Check if there was an error
if err != nil {
fmt.Println(`Failed to broadcast the padUpdate`, err)
// Stop the execution
return
}
// Alert all the other pads other than this one.
for k, pad := range padSocketMap[padName] {
// Check if this is the same socket.
if k == socketToken {
// Skip self
continue
}
// Send the message to the others.
pad.WriteMessage(websocket.TextMessage, serialized)
}
}
}
func handlePadUpdate(msg SocketMessage, socketToken string, padName string) {
// Check if the msg content is valid
if _, ok := msg.Message[`content`]; !ok {
fmt.Printf("Failed to update pad %s, invalid message\n", padName)
return
}
// Check that the content is string
newPadContent, ok := msg.Message[`content`].(string)
if !ok {
fmt.Printf("Type assertion failed for %s, invalid message\n", padName)
return
}
// Get the pad
pad := objects.GetPost(padName, false)
// Update the pad contents
pad.Content = newPadContent
// Save to file
objects.WritePost(pad)
}
// Update the current users of the pad about the amount of live viewers.
func UpdatePadStatus(padName string) {
// Grab info about the map's key
sockets, ok := padSocketMap[padName]
// Check if the pad is set and has sockets connected.
if !ok || len(sockets) < 1 {
// Quit
return
}
// Generate the message
msg := SocketMessage{
EventType: `statusUpdate`,
PadName: padName,
Message: gin.H{
// Send the current amount of live viewers
"currentViewers": len(sockets),
},
}
BroadcastMessage(padName, msg)
}
func BroadcastMessage(padName string, msg SocketMessage) {
// Grab info about the map's key
sockets, ok := padSocketMap[padName]
// Check if the pad is set and has sockets connected.
if !ok || len(sockets) < 1 {
// Quit
return
}
// Get all the participants of the pad group
for _, s := range sockets {
// Send the message to the socket
s.WriteJSON(msg)
}
}

View File

@ -7,6 +7,7 @@ import (
"github.com/JustKato/FreePad/lib/controllers"
"github.com/JustKato/FreePad/lib/objects"
"github.com/JustKato/FreePad/lib/routes"
"github.com/JustKato/FreePad/lib/socketmanager"
"github.com/gin-gonic/gin"
"github.com/joho/godotenv"
)
@ -46,9 +47,15 @@ func main() {
// Implement the rate limiter
controllers.DoRateLimit(router)
// Admin Routing
routes.AdminRoutes(router.Group("/admin"))
// Add Routes
routes.HomeRoutes(router)
// Bind the Web Sockets
socketmanager.BindSocket(router.Group("/ws"))
router.Run(":8080")
}

View File

@ -45,6 +45,24 @@ main#main-card {
tab-size: 2;
font-family: 'Roboto Mono', monospace !important;
padding-top: 2rem;
}
#padTitle {
padding: .3rem .75rem !important;
border-radius: .25rem;
display: inline-block;
}
.dark #padTitle {
color: #db3384;
background-color: rgba(0, 0, 0, 0.10);
}
.light #padTitle {
color: #555273;
border: 1px solid rgba(0, 0, 0, 0.15);
}
#pad-content-area {
@ -54,11 +72,16 @@ main#main-card {
flex-flow: column;
}
.light .edit-content-text {
color: white !important;
}
.edit-content-text {
display: none;
}
.read-only-content .edit-content-text {
margin-top: 1rem;
display: block !important;
}
@ -78,6 +101,9 @@ main#main-card {
max-height: calc(17rem + 30vh);
min-height: 17rem;
overflow: auto;
padding-top: 2rem;
margin-top: 1rem;
}
textarea:focus,

View File

@ -138,7 +138,10 @@ function renderArchivesSelection() {
let resp = confirm("Load contents of pad from memory? This will overwrite the current pad for everyone.");
if (!!resp) {
document.getElementById(`pad-content`).value = a.content;
// Update visually for the client
updatePadContent(a.content);
// Send the update
window.socket.sendPadUpdate();
}
})
@ -210,6 +213,8 @@ function setTextareaPreview(t = true) {
padContentArea.classList.add(`read-only-content`);
prev.scrollTop = prev.scrollHeight;
textarea.classList.add(`hidden`);
} else {
// Toggle edit mode

261
static/js/ws.js Normal file
View File

@ -0,0 +1,261 @@
class PadSocket {
/**
* @type {WebSocket}
*/
ws = null;
/**
* @type {String}
*/
padName = null;
/**
* The actual textarea you write in
* @type {HTMLTextAreaElement}
*/
padContents = null;
/**
* The <code> of the preview
* @type {HTMLElement}
*/
padPreview = null;
/**
* Create a new PadSocket
* @param {string} padName The name of the pad
* @param {string} connUrl The URL to the websocket
*/
constructor(padName, connUrl = null) {
// Assign the pad name
this.padName = padName;
// Check if a connection URL was mentioned
if ( connUrl == null ) {
let connProtocol = `ws://`;
if ( window.location.protocol == `https:` ) {
connProtocol = `wss://`;
}
// Try and connect to the local websocket
connUrl = connProtocol + window.location.host + `/ws/get/${padName}`;
}
// Connect to the websocket
const ws = new WebSocket(connUrl);
// Bind the onMessage function
ws.onmessage = this.handleMessage;
ws.onopen = () => {
updateStatus(`Established`, `text-success`);
}
function onFail() {
updateStatus(`Connection Failed`, `text-dangerous`);
}
// Try and reconnect on failure
ws.onclose = onFail;
ws.onerror = onFail;
// Assign the websocket
this.ws = ws;
// Get all relevant references from the HTML
this.padContents = document.getElementById(`pad-content`);
this.padPreview = document.getElementById(`textarea-preview`);
}
/**
* @description Send a message to the server
* @param {string} eventType The type of event, this can be anything really, it's just used for routing by the server
* @param {Object} message The message to send out to the server, this can only be of format string but JSON is parsed.
*/
sendMessage = (eventType, message) => {
if ( this.ws.readyState !== WebSocket.OPEN ) {
throw new Error(`The websocket connection is not active`);
}
// Check if the message is a string
if ( typeof message !== 'object' ) {
// Convert the message into a map[string]interface{}
message = {
"message": message,
};
}
// TODO: Compress the message, usually we will be sending the whole body of the pad from the client to the server or vice-versa.
this.ws.send( JSON.stringify({
eventType,
padName: this.padName,
message,
}))
}
/**
* Handle the message from the socket based on the message type
* @param {MessageEvent} e The websocket message
*/
handleMessage = ev => {
updateStatus(`Catching Message`, `text-white`);
// Check if the message has valid data
if ( !!ev.data ) {
// Try and parse the data
let parsedData = null;
try {
parsedData = JSON.parse(ev.data);
} catch ( err ) {
console.error(`Failed to parse the WebSocket data`,err);
updateStatus(`Parse Fail`, `text-warning`);
}
if ( !!!parsedData['message'] ) {
console.error(`Failed to find the message`)
updateStatus(`Message Fail`, `text-warning`);
return;
}
// Check if this is a pad Content Update
if ( parsedData['eventType'] === `padUpdate`) {
// Pass on the parsed data
this.onPadUpdate(parsedData);
} // Check if this is a pad Status Update
else if ( parsedData['eventType'] === `statusUpdate`) {
// Pass on the parsed data
this.onStatusUpdate(parsedData);
}
updateStatus(`Established`, `text-success`);
}
}
/**
* Whenever a pad update is trigered, run this function
* @param {Object} The response from the server
*/
onPadUpdate = data => {
// Check that the content is clear
if ( !!data['message']['content'] ) {
// Send over the new content to be updated.
updatePadContent(data['message']['content']);
}
}
onStatusUpdate = data => {
// Check that the content is clear
if ( !!data['message']['currentViewers'] ) {
// Get the amount of viewers reported by the server
const viewerCount = Number(data['message']['currentViewers']);
// Check if this is a valid number
if ( Number.isNaN(viewerCount) ) {
// Looks like this is a malformed message
return console.error(`Malformed Message`, data);
}
// Send over the new content to be updated.
updatePadViewers(viewerCount);
}
}
/**
* Sending a pad update for each keystroke to the server.
* @param {String} msg The new contents of the pad
*/
sendPadUpdate = msg => {
// Get the contents of the pad
const padContents = this.padContents.value;
// Send the data over the webSocket
this.sendMessage(`padUpdate`, {
"content": padContents,
});
updatePadContent(padContents, false);
}
}
/**
* Update the contents of the pad
* @param {String} newContent
*/
function updatePadContent(newContent, textArea = true) {
// Update the textarea
if ( textArea ) {
document.getElementById(`pad-content`).value = newContent;
}
// Update the preview
const prev = document.getElementById(`textarea-preview`);
const shouldScroll = prev.scrollTop >= (prev.scrollHeight - Number(getComputedStyle(prev).height.replace(/px/g, ''))) * 0.98;
prev.innerHTML = escapeHtml(newContent);
prev.classList.remove(`language-undefined`);
prev.classList.forEach( c => {
if ( c.indexOf(`language-`) != -1 ) {
prev.classList.remove(c);
}
})
try { // highlights
hljs.highlightElement(document.getElementById(`textarea-preview`));
} catch ( err ) {
console.err(err);
}
// Check if we should follow the bottom scrolling
if (shouldScroll) {
prev.scrollTop = prev.scrollHeight;
}
}
function updatePadViewers(vc) {
// Get the reference to the viewers count inputElement
/**
* @type {HTMLInputElement}
*/
const viewerCount = document.getElementById(`currentViewers`);
// Get the amount of total viewers
const totalViews = viewerCount.value.split("|")[1].trim();
// Set back the real value
viewerCount.value = `${vc} | ${totalViews}`;
}
function connectSocket() {
// Check if the socket is established
if ( !!!window.socket || window.socket.readyState !== WebSocket.OPEN ) {
updateStatus(`Connecting...`, `text-warning`);
// Connect the socket
window.socket = new PadSocket(padTitle);
}
}
// TODO: Test if this is actually necessary or the DOMContentLoaded event would suffice
// wait for the whole window to load
window.addEventListener(`load`, e => {
connectSocket()
})
// lol
function escapeHtml(html){
const text = document.createTextNode(html);
const p = document.createElement('p');
p.appendChild(text);
const content = p.innerHTML;
p.remove();
return content;
}

View File

@ -0,0 +1,42 @@
{{ template "inc/header.html" .}}
<body>
<main id="main-card" class="container rounded mt-5 shadow-sm">
<div class="p-3">
<a href="/" class="logo-container w-100 d-flex mb-4">
<img src="/static/img/logo_transparent.png" alt="Logo" style="max-width: 50%; margin: 0 auto;" class="mx-auto">
</a>
<div class="form-group my-4">
<form class="search-action input-group" method="post" action="/admin/login">
<input autocomplete="off" type="password" class="form-control form-control-lg" name="admin-token" placeholder="Your Admin token" aria-label="Your Admin token" aria-describedby="admin-token-button" id="admin-token">
<button class="btn btn-primary" type="submit" id="admin-token-button">
<svg xmlns="http://www.w3.org/2000/svg" width="24 " height="24 " fill="currentColor" class="bi bi-box-arrow-in-right" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M6 3.5a.5.5 0 0 1 .5-.5h8a.5.5 0 0 1 .5.5v9a.5.5 0 0 1-.5.5h-8a.5.5 0 0 1-.5-.5v-2a.5.5 0 0 0-1 0v2A1.5 1.5 0 0 0 6.5 14h8a1.5 1.5 0 0 0 1.5-1.5v-9A1.5 1.5 0 0 0 14.5 2h-8A1.5 1.5 0 0 0 5 3.5v2a.5.5 0 0 0 1 0v-2z"/>
<path fill-rule="evenodd" d="M11.854 8.354a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H1.5a.5.5 0 0 0 0 1h8.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3z"/>
</svg>
</button>
</form>
<small class="text-muted">Access the admin interface for FreePad, this can only be done through the Admin Token.</small>
</div>
</div>
<footer class="text-muted py-5 border-top text-center">
<p class="mb-1">
FreePad by <a href="https://justkato.me/">©Kato Twofold</a>
</p>
<p class="mb-0">
FreePad is freely available over on our <a href="https://github.com/JustKato/FreePad">GitHub</a>
</p>
</footer>
</main>
{{ template "inc/theme-toggle.html" .}}
</body>
{{ template "inc/footer.html" .}}

View File

@ -0,0 +1,94 @@
{{ template "inc/header.html" .}}
<style>
.pad-instance {
display: flex;
flex-flow: row;
justify-content: space-between;
align-items: center;
}
#pad-list {
max-height: 30rem;
overflow-x: hidden;
overflow-y: auto;
}
.pad-name {
max-width: 30%;
overflow: hidden;
}
</style>
<body>
<main id="main-card" class="container rounded mt-5 shadow-sm">
<div class="p-3">
<a href="/" class="logo-container w-100 d-flex mb-4">
<img src="/static/img/logo_transparent.png" alt="Logo" style="max-width: 50%; margin: 0 auto;" class="mx-auto">
</a>
<div class="form-group my-4 border-top p-3 border">
<div class="pad-instance my-2 border-bottom">
<div class="pad-name col-5">
Pad Name
</div>
<div class="pad-last-view col-1">
Views
</div>
<div class="pad-last-modified col-4">
Create Date
</div>
<div class="col-2">
Actions
</div>
</div>
<div id="pad-list" >
{{ range $indx, $element := .padList }}
<div class="pad-instance my-2">
<div class="pad-name col-5">
<a href="/{{ $element.Name }}">
{{ $element.Name }}
</a>
</div>
<div class="pad-last-view col-1">
{{ $element.Views }}
</div>
<div class="pad-last-modified col-4">
{{ $element.LastModified }}
</div>
<div class="col-2">
<div onclick="doDelete({{ $element.Name }})" class="btn btn-danger">
Delete
</div>
</div>
</div>
{{ end }}
</div>
</div>
</div>
</main>
{{ template "inc/theme-toggle.html" .}}
</body>
<script>
function doDelete(id) {
// Confirm deletion
if ( confirm("Confirm pad deletion?") ) {
// Do delete
window.location.href = `/admin/delete/${id}`;
}
}
</script>
{{ template "inc/footer.html" .}}

View File

@ -35,7 +35,9 @@
</div>
<h2 class="mb-4">{{.title}}</h2>
<h2 class="mb-4" id="padTitle">
{{.title}}
</h2>
<div id="pad-content-area">
<div class="btn-sm btn" id="pad-content-toggler" onclick="toggleTextareaPreview()">
@ -53,8 +55,7 @@
<pre><code id="textarea-preview" class="form-control hidden">{{.post_content}}</code></pre>
<textarea maxlength="{{.maximumPadSize}}" name="pad-content" id="pad-content" onchange="sendMyData(this)"
onkeydown="updateStatus(`Not Saved`, `text-warning`); toggleWritingWatch(this)"
<textarea maxlength="{{.maximumPadSize}}" name="pad-content" id="pad-content" onkeyup="window.socket.sendPadUpdate()"
class="form-control hidden">{{.post_content}}</textarea>
</div>
@ -73,7 +74,7 @@
</div>
</div>
<div class="col-md-12 col-lg-4 col-xl-4 mt-4 mt-lg-0 mt-xl-0" title="Current Viewers">
<div class="col-md-12 col-lg-4 col-xl-4 mt-4 mt-lg-0 mt-xl-0" title="Current Viewers | Total Views">
<div class="input-group">
<span class="input-group-text">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor"
@ -86,7 +87,7 @@
</path>
</svg>
</span>
<input type="text" class="form-control" readonly value="{{.views}}">
<input type="text" class="form-control" readonly value="1 | {{.views}}" id="currentViewers">
</div>
</div>
@ -209,6 +210,7 @@
{{ template "inc/theme-toggle.html" .}}
</body>
<script src="/static/js/ws.js"></script>
<script src="/static/js/fileSaver.js"></script>
<script src="/static/js/pad.js"></script>
<script src="/static/js/pad-scripts.js"></script>