Added section in channel settings to update description and thumbnail.

This commit is contained in:
rainbow napkin 2025-06-11 06:23:10 -04:00
parent 4001ad2f13
commit 370a08cb03
8 changed files with 271 additions and 17 deletions

View file

@ -0,0 +1,90 @@
/*Canopy - The next generation of stoner streaming software
Copyright (C) 2024-2025 Rainbownapkin and the TTN Community
This program is free software: you can redistribute it and/or modify
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 Affero General Public License for more details.
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/>.*/
//NPM Imports
const {validationResult, matchedData} = require('express-validator');
//local imports
const channelModel = require('../../../schemas/channel/channelSchema');
const {exceptionHandler} = require('../../../utils/loggerUtils');
//get thumby
module.exports.get = async function(req, res){
try{
//Pull validated result
const validResult = validationResult(req);
//if everything validated proper
if(validResult.isEmpty()){
//Get matched data
const data = matchedData(req);
//pull channel
const chanDB = await channelModel.findOne({name: data.chanName});
//Null check channel
if(chanDB == null){
throw loggerUtils.exceptionSmith("Channel not found.", "validation");
}
//return thumby
res.status(200);
return res.send({description: chanDB.description});
}else{
res.status(400);
res.send({errors: validResult.array()})
}
}catch(err){
exceptionHandler(res, err);
}
}
//Post function
module.exports.post = async function(req, res){
try{
//Pull validated result
const validResult = validationResult(req);
//if everything validated proper
if(validResult.isEmpty()){
//Get matched data
const data = matchedData(req);
//pull channel
const chanDB = await channelModel.findOne({name: data.chanName});
//Null check channel
if(chanDB == null){
throw loggerUtils.exceptionSmith("Channel not found.", "validation");
}
//Set thumbnail
chanDB.description = data.description;
//Save channel doc
await chanDB.save();
//return thumby
res.status(200);
return res.send({description: chanDB.description});
}else{
res.status(400);
res.send({errors: validResult.array()})
}
}catch(err){
exceptionHandler(res, err);
}
}

View file

@ -0,0 +1,90 @@
/*Canopy - The next generation of stoner streaming software
Copyright (C) 2024-2025 Rainbownapkin and the TTN Community
This program is free software: you can redistribute it and/or modify
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 Affero General Public License for more details.
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/>.*/
//NPM Imports
const {validationResult, matchedData} = require('express-validator');
//local imports
const channelModel = require('../../../schemas/channel/channelSchema');
const {exceptionHandler} = require('../../../utils/loggerUtils');
//get thumby
module.exports.get = async function(req, res){
try{
//Pull validated result
const validResult = validationResult(req);
//if everything validated proper
if(validResult.isEmpty()){
//Get matched data
const data = matchedData(req);
//pull channel
const chanDB = await channelModel.findOne({name: data.chanName});
//Null check channel
if(chanDB == null){
throw loggerUtils.exceptionSmith("Channel not found.", "validation");
}
//return thumby
res.status(200);
return res.send({thumbnail: chanDB.thumbnail});
}else{
res.status(400);
res.send({errors: validResult.array()})
}
}catch(err){
exceptionHandler(res, err);
}
}
//Post function
module.exports.post = async function(req, res){
try{
//Pull validated result
const validResult = validationResult(req);
//if everything validated proper
if(validResult.isEmpty()){
//Get matched data
const data = matchedData(req);
//pull channel
const chanDB = await channelModel.findOne({name: data.chanName});
//Null check channel
if(chanDB == null){
throw loggerUtils.exceptionSmith("Channel not found.", "validation");
}
//Set thumbnail
chanDB.thumbnail = data.thumbnail;
//Save channel doc
await chanDB.save();
//return thumby
res.status(200);
return res.send({thumbnail: chanDB.thumbnail});
}else{
res.status(400);
res.send({errors: validResult.array()})
}
}catch(err){
exceptionHandler(res, err);
}
}

View file

@ -22,7 +22,7 @@ const { Router } = require('express');
//Models //Models
const permissionModel = require("../../schemas/permissionSchema"); const permissionModel = require("../../schemas/permissionSchema");
const channelModel = require("../../schemas/channel/channelSchema"); const channelModel = require("../../schemas/channel/channelSchema");
//Valudators //Validators
const channelValidator = require("../../validators/channelValidator"); const channelValidator = require("../../validators/channelValidator");
const accountValidator = require("../../validators/accountValidator"); const accountValidator = require("../../validators/accountValidator");
const {channelPermissionValidator} = require("../../validators/permissionsValidator"); const {channelPermissionValidator} = require("../../validators/permissionsValidator");
@ -30,6 +30,8 @@ const tokebotValidator = require("../../validators/tokebotValidator");
const emoteValidator = require("../../validators/emoteValidator"); const emoteValidator = require("../../validators/emoteValidator");
//Controllers //Controllers
const registerController = require("../../controllers/api/channel/registerController"); const registerController = require("../../controllers/api/channel/registerController");
const thumbnailController = require("../../controllers/api/channel/thumbnailController");
const descriptionController = require("../../controllers/api/channel/descriptionController");
const listController = require("../../controllers/api/channel/listController"); const listController = require("../../controllers/api/channel/listController");
const settingsController = require("../../controllers/api/channel/settingsController"); const settingsController = require("../../controllers/api/channel/settingsController");
const permissionsController = require("../../controllers/api/channel/permissionsController") const permissionsController = require("../../controllers/api/channel/permissionsController")
@ -42,8 +44,10 @@ const emoteController = require('../../controllers/api/channel/emoteController')
//globals //globals
const router = Router(); const router = Router();
//user authentication middleware //Set validator functions
router.use("/register",permissionModel.reqPermCheck("registerChannel")); router.use("/register",permissionModel.reqPermCheck("registerChannel"));
router.use("/thumbnail",channelValidator.name("chanName"));
router.use("/description",channelValidator.name("chanName"));
router.use("/settings", channelValidator.name('chanName')); router.use("/settings", channelValidator.name('chanName'));
router.use("/permissions", channelValidator.name('chanName')); router.use("/permissions", channelValidator.name('chanName'));
router.use("/rank", channelValidator.name('chanName')); router.use("/rank", channelValidator.name('chanName'));
@ -55,6 +59,12 @@ router.use("/emote", channelValidator.name('chanName'));
//routing functions //routing functions
//register //register
router.post('/register', channelValidator.name(), channelValidator.description(), channelValidator.thumbnail(), registerController.post); router.post('/register', channelValidator.name(), channelValidator.description(), channelValidator.thumbnail(), registerController.post);
//Thumbnail
router.get('/thumbnail', thumbnailController.get);
router.post('/thumbnail', channelValidator.thumbnail(), thumbnailController.post);
//Description
router.get('/description', descriptionController.get);
router.post('/description', channelValidator.description(), descriptionController.post);
//list //list
router.get('/list', channelModel.reqPermCheck("manageChannel"), listController.get); router.get('/list', channelModel.reqPermCheck("manageChannel"), listController.get);
//settings //settings

View file

@ -26,7 +26,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>. %>
<%- include('partial/navbar', {user}); %> <%- include('partial/navbar', {user}); %>
<h1 class="panel-title"><%- channel.name %> - Channel Settings</h1> <h1 class="panel-title"><%- channel.name %> - Channel Settings</h1>
<div class="admin-panel-container-div"> <div class="admin-panel-container-div">
<%- include('partial/channelSettings/description.ejs', {channel}); %> <%- include('partial/channelSettings/info.ejs', {channel}); %>
<%- include('partial/channelSettings/userList.ejs'); %> <%- include('partial/channelSettings/userList.ejs'); %>
<%- include('partial/channelSettings/banList.ejs'); %> <%- include('partial/channelSettings/banList.ejs'); %>
<%- include('partial/channelSettings/settings.ejs'); %> <%- include('partial/channelSettings/settings.ejs'); %>

View file

@ -68,8 +68,16 @@ img.admin-list-entry-item{
margin: 0; margin: 0;
} }
#channel-info-thumbnail {
max-width: 8em;
max-height: 8em;
align-self: center;
}
#channel-info-thumbnail-span div{ #channel-info-thumbnail-span div{
position: relative; position: relative;
display: flex;
flex-direction: column;
} }
#channel-info-description-span{ #channel-info-description-span{
@ -83,12 +91,12 @@ img.admin-list-entry-item{
left: calc(50% - 4.5em); left: calc(50% - 4.5em);
} }
#channel-info-description-prompt{ #channel-info-description-prompt{
resize: vertical; resize: vertical;
width: 100%; width: 100%;
min-height: 2em; min-height: 2em;
max-height: 8em; max-height: 8em;
height: 8em;
} }
#channel-rank-title{ #channel-rank-title{

View file

@ -41,6 +41,7 @@ class chanInfo{
//Create description prompt //Create description prompt
this.descriptionInput = document.createElement("textarea"); this.descriptionInput = document.createElement("textarea");
this.descriptionInput.id = "channel-info-description-prompt"; this.descriptionInput.id = "channel-info-description-prompt";
this.descriptionInput.value = this.description.textContent;
//Setup Input Event Handlers //Setup Input Event Handlers
this.setupInput(); this.setupInput();
@ -58,50 +59,71 @@ class chanInfo{
this.thumbnailInput.style.display = enabled ? "" : "none"; this.thumbnailInput.style.display = enabled ? "" : "none";
if(enabled){ if(enabled){
//focus thumbnail input
this.thumbnailInput.focus();
//Remove interactive class from thumby
this.thumbnail.classList.remove('interactive'); this.thumbnail.classList.remove('interactive');
}else{ }else{
//add interactive class to thumby
this.thumbnail.classList.add('interactive'); this.thumbnail.classList.add('interactive');
} }
} }
submitThumbnail(event){ async submitThumbnail(event){
//If we hit didnt hit enter or escape //If we hit didnt hit enter or escape
if(!(event.key == "Enter" || event.key == "Escape") && event.key != null){ if(!(event.key == "Enter" || event.key == "Escape") && event.key != null){
//bail! //bail!
return; return;
//Only returns w/ content after this point
}else if(event.key == "Escape" && event.key != null){
//Toggle prompt
this.toggleThumbnailPrompt(false);
return;
} }
//Send update off to server and wait for response
const data = await utils.ajax.setChannelThumbnail(this.channel, this.thumbnailInput.value);
//Set new image from updated thumby
this.thumbnail.src = data.thumbnail;
//Toggle prompt //Toggle prompt
this.toggleThumbnailPrompt(false); this.toggleThumbnailPrompt(false);
//Only returns after this point
if(event.key != "Enter" && event.key != null){
return;
}
} }
toggleDescriptionPrompt(enabled){ toggleDescriptionPrompt(enabled){
if(enabled){ if(enabled){
this.description.replaceWith(this.descriptionInput); this.description.replaceWith(this.descriptionInput);
this.descriptionInput.focus()
}else{ }else{
this.descriptionInput.replaceWith(this.description); this.descriptionInput.replaceWith(this.description);
} }
} }
submitDescription(event){ async submitDescription(event){
//If we hit didnt hit enter (without shift) or escape //If we hit didnt hit enter (without shift) or escape
if(!((event.key == "Enter" && !event.shiftKey) || event.key == "Escape") && event.key != null){ if(!((event.key == "Enter" && !event.shiftKey) || event.key == "Escape") && event.key != null){
//bail! //bail!
return; return;
}else if(event.key == "Escape" && event.key != null){
//Toggle prompt
this.toggleDescriptionPrompt(false);
return;
} }
//Stop newline from being processed
event.preventDefault();
//Set Description
const data = await utils.ajax.setChannelDescription(this.channel, this.descriptionInput.value);
//Unescape entities from server-side sanatization and safely put the newly made un-safe text inside of the element via .textContent.
//Ensuring sanatized content displays proper, and that any unsanatized content that some how made it through is still safe.
this.description.textContent = utils.unescapeEntities(data.description);
//Toggle prompt //Toggle prompt
this.toggleDescriptionPrompt(false); this.toggleDescriptionPrompt(false);
//Only returns after this point
if(event.key != "Enter" && !event.shiftKey && event.key != null){
return;
}
} }
} }

View file

@ -872,6 +872,40 @@ class canopyAjaxUtils{
} }
} }
async setChannelThumbnail(chanName, thumbnail){
var response = await fetch(`/api/channel/thumbnail`,{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-csrf-token": utils.ajax.getCSRFToken()
},
body: JSON.stringify({chanName, thumbnail})
});
if(response.ok){
return await response.json();
}else{
utils.ux.displayResponseError(await response.json());
}
}
async setChannelDescription(chanName, description){
var response = await fetch(`/api/channel/description`,{
method: "POST",
headers: {
"Content-Type": "application/json",
"x-csrf-token": utils.ajax.getCSRFToken()
},
body: JSON.stringify({chanName, description})
});
if(response.ok){
return await response.json();
}else{
utils.ux.displayResponseError(await response.json());
}
}
async setChannelSetting(chanName, settingsMap){ async setChannelSetting(chanName, settingsMap){
var response = await fetch(`/api/channel/settings`,{ var response = await fetch(`/api/channel/settings`,{
method: "POST", method: "POST",