diff --git a/package.json b/package.json index 5c31afb..da43c50 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "scripts": { "start": "node ./src/server.js", "start:dev": "nodemon ./src/server.js", - "build": "node node_modules/jsdoc/jsdoc.js --verbose -r src/ -R README.md -d www/doc/server/ && node node_modules/jsdoc/jsdoc.js --verbose -r www/js/ -r README.md -d www/doc/client/" + "build": "node node_modules/jsdoc/jsdoc.js --verbose -r src/ -R README.md -d www/doc/server/ && node node_modules/jsdoc/jsdoc.js --verbose -r www/js/channel -r README.md -d www/doc/client/" }, "devDependencies": { "nodemon": "^3.1.10", diff --git a/www/doc/client/channel.html b/www/doc/client/channel.html new file mode 100644 index 0000000..ca741ff --- /dev/null +++ b/www/doc/client/channel.html @@ -0,0 +1,1263 @@ + + + + + JSDoc: Class: channel + + + + + + + + + + +
+ +

Class: channel

+ + + + + + +
+ +
+ +

channel()

+ +
Class for object containing base code for the Canopy channel client.
+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new channel()

+ + + + + + +
+ Instantiates a new channel object +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

cPanel

+ + + + +
+ Child Canopy Panel Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

channelName

+ + + + +
+ Current connected channels name +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

chatBox

+ + + + +
+ Child Chat Box Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

defaultConfig

+ + + + +
+ Default channel config +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

player

+ + + + +
+ Child Video Player object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userList

+ + + + +
+ Child User List Object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

ytEmbedAPILoaded

+ + + + +
+ Returns true once the ytEmbed API has loaded in from google (eww) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

connect()

+ + + + + + +
+ Handles initial client connection +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

defineListeners()

+ + + + + + +
+ Defines network-related listeners +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

handleClientInfo(data)

+ + + + + + +
+ Handles initial client-metadata ingestion from server upon connection +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Object + + + + Data glob from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

processConfig(key, value)

+ + + + + + +
+ Run once every config change to ensure settings are properly set +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
key + + +String + + + + Setting to change
value + + +* + + + + Value to set setting to
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setDefaults(force, processConfig)

+ + + + + + +
+ Processes and applies default config on any unset settings +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
force + + +Boolean + + + + + + false + + Whether or not to forcefully reset already set settings
processConfig + + +Boolean + + + + + + false + + Whether or not to run the Process Config function once complete
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/www/doc/client/channel.js.html b/www/doc/client/channel.js.html new file mode 100644 index 0000000..995b6e5 --- /dev/null +++ b/www/doc/client/channel.js.html @@ -0,0 +1,298 @@ + + + + + JSDoc: Source: channel.js + + + + + + + + + + +
+ +

Source: channel.js

+ + + + + + +
+
+ 
/*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/>.*/
+
+/**
+ * Class for object containing base code for the Canopy channel client.
+ */
+class channel{
+    /**
+     * Instantiates a new channel object
+     */
+    constructor(){
+        //Establish connetion to the server via socket.io
+        this.connect();
+        //Define socket listeners
+        this.defineListeners();
+
+        /**
+         * Returns true once the ytEmbed API has loaded in from google (eww)
+         */
+        this.ytEmbedAPILoaded = false;
+
+        /**
+         * Current connected channels name
+         */
+        this.channelName = window.location.pathname.split('/c/')[1].split('/')[0];
+
+        /**
+         * Child Video Player object
+         */
+        this.player = new player(this);
+
+        /**
+         * Child Chat Box Object
+         */
+        this.chatBox = new chatBox(this);
+
+        /**
+         * Child User List Object
+         */
+        this.userList = new userList(this);
+        
+        /**
+         * Child Canopy Panel Object
+         */
+        this.cPanel = new cPanel(this);
+
+        //Set defaults for any unset settings and run any required process steps for the current config
+        this.setDefaults(false, true);
+
+        //Freak out any weirdos who take a peek in the dev console for shits n gigs
+        console.log("👁️👄👁️ ℬℴ𝓊𝓃𝒿ℴ𝓊𝓇.");
+    }
+
+    /**
+     * Handles initial client connection
+     */
+    connect(){
+        this.socket = io({
+            extraHeaders: {
+                //Include CSRF token
+                'x-csrf-token': utils.ajax.getCSRFToken()
+            }
+        });
+    }
+
+    /**
+     * Defines network-related listeners
+     */
+    defineListeners(){
+        this.socket.on("connect", () => {
+            document.title = `${this.channelName} - Connected`
+        });
+
+        this.socket.on("kick", async (data) => {
+            if(data.reason == "Invalid CSRF Token!"){
+                //Reload the CSRF token
+                await utils.ajax.reloadCSRFToken();
+
+                //Retry the connection
+                this.connect();
+            }else{
+                new canopyUXUtils.popup(`You have been ${data.type} from the channel for the following reason:<br>${data.reason}`);
+            }
+        });
+
+        this.socket.on("clientMetadata", this.handleClientInfo.bind(this));
+
+        this.socket.on("error", utils.ux.displayResponseError);
+
+        this.socket.on("queue", (data) => {
+            this.queue = new Map(data.queue);
+        });
+
+        this.socket.on("lock", (data) => {
+            this.queueLock = data.locked;
+        });
+    }
+
+    /**
+     * Handles initial client-metadata ingestion from server upon connection
+     * @param {Object} data - Data glob from server
+     */
+    handleClientInfo(data){
+        //Ingest user data
+        this.user = data.user;
+
+        //Re-hydrate permission maps
+        this.user.permMap.site = new Map(data.user.permMap.site);
+        this.user.permMap.chan = new Map(data.user.permMap.chan);
+
+        //Tell the chatbox to handle client info 
+        //should it have its own event listener instead? Guess it's a stylistic choice :P
+        this.chatBox.handleClientInfo(data);
+
+        //Store queue for use by the queue panel
+        this.queue = new Map(data.queue);
+
+        //Store queue lock status
+        this.queueLock = data.queueLock;
+
+        //For each chat held in the chat buffer
+        for(let chat of data.chatBuffer){
+            //Display the chat
+            this.chatBox.displayChat(chat);
+        }
+    }
+
+    /**
+     * Processes and applies default config on any unset settings
+     * @param {Boolean} force - Whether or not to forcefully reset already set settings
+     * @param {Boolean} processConfig - Whether or not to run the Process Config function once complete
+     */
+    setDefaults(force = false, processConfig = false){
+        //Iterate through default config 
+        for(let [key, value] of channel.defaultConfig){
+            //If the setting is unset or function was called forcefully
+            if(force || localStorage.getItem(key) == null){
+                //Set item from default map
+                localStorage.setItem(key, value);
+            }
+
+            //If we're running process steps for the config
+            if(processConfig){
+                //Process the current config value
+                this.processConfig(key, localStorage.getItem(key));
+            }
+        }
+    }
+
+    /**
+     * Run once every config change to ensure settings are properly set
+     * @param {String} key - Setting to change
+     * @param {*} value - Value to set setting to
+     */
+    processConfig(key, value){
+        //Switch/case by config key
+        switch(key){
+            case 'ytPlayerType':
+                const embedScript = document.querySelector(".yt-embed-api");
+                //If the user is running the embedded player and we don't have en embed script loaded
+                if(value == 'embed' && embedScript == null){
+                    //Find our footer
+                    const footer = document.querySelector('footer');
+
+                    //Create new script tag
+                    const ytEmbedAPI = document.createElement('script');
+                    //Link the iframe api from youtube
+                    ytEmbedAPI.src = "https://www.youtube.com/iframe_api";
+                    //set the iframe api script id
+                    ytEmbedAPI.classList.add('yt-embed-api');
+
+                    //Append the script tag to the top of the footer to give everything else access
+                    footer.prepend(ytEmbedAPI);
+                //If we're not using the embed player but the script is loaded
+                }else if(embedScript != null){
+                    //Pull all scripts since the main one might have pulled others
+                    const scripts = document.querySelectorAll('script');
+
+                    //Iterate through all script tags on the page
+                    for(let script of scripts){
+                        //If the script came from youtube
+                        if(script.src.match(/youtube\.com|youtu\.be/)){
+                            //Rip it out
+                            script.remove();
+                        }
+                    }
+                }
+
+                //If the player or mediaHandler isn't loaded
+                if(this.player == null || this.player.mediaHandler == null){
+                    //We're fuggin done here
+                    return;
+                }
+
+
+                //Get current video
+                const nowPlaying = this.player.mediaHandler.nowPlaying;
+
+                //If we're playing a youtube video
+                if(nowPlaying != null && nowPlaying.type == 'yt'){
+                    //Restart the video
+                    this.player.start({media: nowPlaying});
+                }
+
+                //Stop while we're ahead
+                return;
+        }
+    }
+
+    /**
+     * Default channel config
+     */
+    static defaultConfig = new Map([
+        ["ytPlayerType","raw"]
+    ]);
+}
+
+/**
+ * Youtube iframe-embed API entry point
+ */
+function onYouTubeIframeAPIReady(){
+    //Set embed api to true
+    client.ytEmbedAPILoaded = true;
+
+    //Get currently playing item
+    const nowPlaying = client.player.mediaHandler.nowPlaying;
+
+    //If we're playing a youtube video and the official embeds are enabled
+    if(nowPlaying.type == 'yt' && localStorage.getItem('ytPlayerType') == "embed"){
+        //Restart the video now that the embed api has loaded
+        client.player.start({media: nowPlaying});
+    }
+}
+
+const client = new channel();
+
+
+ + + + +
+ + + +
+ + + + + + + diff --git a/www/doc/client/commandPreprocessor.html b/www/doc/client/commandPreprocessor.html new file mode 100644 index 0000000..21290cc --- /dev/null +++ b/www/doc/client/commandPreprocessor.html @@ -0,0 +1,1921 @@ + + + + + JSDoc: Class: commandPreprocessor + + + + + + + + + + +
+ +

Class: commandPreprocessor

+ + + + + + +
+ +
+ +

commandPreprocessor(client)

+ +
Class for object containing chat and command pre-processing logic
+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new commandPreprocessor(client)

+ + + + + + +
+ Instantiates a new commandPreprocessor object +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +channel + + + + Parent client mgmt object
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

client

+ + + + +
+ Parent Client Management object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

commandProcessor

+ + + + +
+ Child Command Processor object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

emotes

+ + + + +
+ Set of arrays containing site-wide, channel-wide, and user-specific emotes +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

buildAutocompleteDictionary() → {Object}

+ + + + + + +
+ Generates auto-complete dictionary from pre-written commands, emotes, and used tokes from servers for use with autocomplete +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Generated Dictionary object +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + + +

defineListeners()

+ + + + + + +
+ Defines Network-Related Listeners +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Fetches emote by link +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
link + + +String + + + + Link to fetch emote with
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ found emote +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + + +

getEmoteNames() → {Array}

+ + + + + + +
+ Generates flat list of emote names +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ List of strings containing emote names +
+ + + +
+
+ Type +
+
+ +Array + + +
+
+ + + + + + + + + + + + + +

preprocess(command)

+ + + + + + +
+ Pre-Processes a single chat/command before sending it off to the server +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
command + + +String + + + + Chat/Command to pre-process
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

processEmotes()

+ + + + + + +
+ Processes emotes refrences in loaded message into links to be further processed by processLinks() +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Processes links into numbered file seperators, putting links into a dedicated array. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

processLocalCommand()

+ + + + + + +
+ Processes local commands, starting with '/' +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

sendRemoteCommand()

+ + + + + + +
+ Transmits message/command off to server +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setChanEmotes(data)

+ + + + + + +
+ Sets channel emotes +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Object + + + + Emote data from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setPersonalEmotes(data)

+ + + + + + +
+ Sets personal emotes +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Object + + + + Emote data from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setSiteEmotes(data)

+ + + + + + +
+ Sets site emotes +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Object + + + + Emote data from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setUsedTokes(data)

+ + + + + + +
+ Sets used tokes +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +Object + + + + Used toke data from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/www/doc/client/commandPreprocessor.js.html b/www/doc/client/commandPreprocessor.js.html new file mode 100644 index 0000000..d2220c7 --- /dev/null +++ b/www/doc/client/commandPreprocessor.js.html @@ -0,0 +1,380 @@ + + + + + JSDoc: Source: commandPreprocessor.js + + + + + + + + + + +
+ +

Source: commandPreprocessor.js

+ + + + + + +
+
+ 
/*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/>.*/
+
+/**
+ * Class for object containing chat and command pre-processing logic
+ */
+class commandPreprocessor{
+    /**
+     * Instantiates a new commandPreprocessor object
+     * @param {channel} client - Parent client mgmt object
+     */
+    constructor(client){
+        /**
+         * Parent Client Management object
+         */
+        this.client = client;
+
+        /**
+         * Child Command Processor object
+         */
+        this.commandProcessor = new commandProcessor(client);
+
+        /**
+         * Set of arrays containing site-wide, channel-wide, and user-specific emotes
+         */
+        this.emotes = {
+            site: [],
+            chan: [],
+            personal: []
+        }
+
+        //define listeners
+        this.defineListeners();
+    }
+
+    /**
+     * Defines Network-Related Listeners
+     */
+    defineListeners(){
+        //When we receive site-wide emote list
+        this.client.socket.on("siteEmotes", this.setSiteEmotes.bind(this));
+        this.client.socket.on("chanEmotes", this.setChanEmotes.bind(this));
+        this.client.socket.on("personalEmotes", this.setPersonalEmotes.bind(this));
+        this.client.socket.on("usedTokes", this.setUsedTokes.bind(this));
+    }
+
+    /**
+     * Pre-Processes a single chat/command before sending it off to the server
+     * @param {String} command - Chat/Command to pre-process
+     */
+    preprocess(command){
+        //Set command and sendFlag
+        this.command = command;
+        this.sendFlag = true;
+
+        //Attempt to process as local command
+        this.processLocalCommand();
+
+        //If we made it through the local command processor
+        if(this.sendFlag){
+            //Set the message to the command
+            this.message = command;
+            //Process message emotes into links
+            this.processEmotes();
+            //Process unmarked links into marked links
+            this.processLinks();
+            //Send command off to server
+            this.sendRemoteCommand();
+        }
+    }
+
+    /**
+     * Processes local commands, starting with '/'
+     */
+    processLocalCommand(){
+        //Create an empty array to hold the command
+        this.commandArray = [];
+        //Split string by words
+        this.commandArray = this.command.split(/\b/g);//Split by word-borders
+        this.argumentArray = this.command.match(/\b\w+\b/g);//Match by words surrounded by borders
+
+        //If this is a local command
+        if(this.commandArray[0] == '/'){
+            //If the command exists
+            if(this.argumentArray != null && this.commandProcessor[this.argumentArray[0].toLowerCase()] != null){
+                //Don't send it to the server
+                this.sendFlag = false;
+
+                //Call the command with the argument array
+                this.commandProcessor[this.argumentArray[0].toLowerCase()](this.argumentArray, this.commandArray);
+            }
+        }
+    }
+
+    /**
+     * Processes emotes refrences in loaded message into links to be further processed by processLinks()
+     */
+    processEmotes(){
+        //inject invisible whitespace in-between emotes to prevent from mushing links together
+        this.message = this.message.replaceAll('][',']ㅤ[');
+
+        //For each list of emotes
+        Object.keys(this.emotes).forEach((key) => {
+            //For each emote in the current list
+            this.emotes[key].forEach((emote) => {
+                //Inject emote links into the message, pad with invisible whitespace to keep link from getting mushed
+                this.message = this.message.replaceAll(`[${emote.name}]`, `ㅤ${emote.link}ㅤ`);
+            });
+        });
+    }
+
+    /**
+     * Processes links into numbered file seperators, putting links into a dedicated array.
+     */
+    processLinks(){
+        //Strip out file seperators in-case the user is being a smart-ass
+        this.message = this.message.replaceAll('␜','');
+        //Split message by links
+        var splitMessage = this.message.split(/(https?:\/\/[^\sㅤ]+)/g);
+        //Create an empty array to hold links
+        this.links = [];
+
+        splitMessage.forEach((chunk, chunkIndex) => {
+            //For each chunk that is a link
+            if(chunk.match(/(https?:\/\/[^\sㅤ]+)/g)){
+                //I looked online for obscure characters that no one would use to prevent people from chatting embed placeholders
+                //Then I found this fucker, turns out it's literally made for the job lmao (even if it was originally intended for paper/magnetic tape)
+                //Replace link with indexed placeholder
+                splitMessage[chunkIndex] = `␜${this.links.length}`
+
+                //push current chunk as link
+                this.links.push(chunk);
+            }
+        });
+
+        //Join the message back together
+        this.message = splitMessage.join('');
+    }
+
+    /**
+     * Transmits message/command off to server
+     */
+    sendRemoteCommand(){
+        this.client.socket.emit("chatMessage",{msg: this.message, links: this.links});
+    }
+
+    /**
+     * Sets site emotes
+     * @param {Object} data - Emote data from server
+     */
+    setSiteEmotes(data){
+        this.emotes.site = data;
+    }
+
+    /**
+     * Sets channel emotes
+     * @param {Object} data - Emote data from server
+     */
+    setChanEmotes(data){
+        this.emotes.chan = data;
+    }
+
+    /**
+     * Sets personal emotes
+     * @param {Object} data - Emote data from server
+     */
+    setPersonalEmotes(data){
+        this.emotes.personal = data;
+    }
+
+    /**
+     * Sets used tokes
+     * @param {Object} data - Used toke data from server
+     */
+    setUsedTokes(data){
+        this.usedTokes = data.tokes;
+    }
+
+    /**
+     * Fetches emote by link
+     * @param {String} link - Link to fetch emote with
+     * @returns {Object} found emote
+     */
+    getEmoteByLink(link){
+        //Create an empty variable to hold the found emote
+        var foundEmote = null;
+
+        //For each list of emotes
+        Object.keys(this.emotes).forEach((key) => {
+            //For each emote in the current list
+            this.emotes[key].forEach((emote) => {
+                //if we found a match
+                if(emote.link == link){
+                    //return the match
+                    foundEmote = emote;
+                }
+            });
+        });
+
+        return foundEmote;
+    }
+
+    /**
+     * Generates flat list of emote names
+     * @returns {Array} List of strings containing emote names
+     */
+    getEmoteNames(){
+        //Create an empty array to hold names
+        let names = [];
+
+        //For every set of emotes
+        for(let set of Object.keys(this.emotes)){
+            //for every emote in the current set of emotes
+            for(let emote of this.emotes[set]){
+                //push the name of the emote to the name list
+                names.push(emote.name);
+            }
+        }
+
+        //return our list of names
+        return names;
+    }
+
+    /**
+     * Generates auto-complete dictionary from pre-written commands, emotes, and used tokes from servers for use with autocomplete
+     * @returns {Object} Generated Dictionary object
+     */
+    buildAutocompleteDictionary(){
+        let dictionary = {
+            tokes: {
+                prefix: '!',
+                postfix: '',
+                cmds: [
+                    ['toke', true]
+                ].concat(injectPerms(this.usedTokes))
+            },
+            //Make sure to add spaces at the end for commands that take arguments
+            //Not necissary but definitely nice to have
+            serverCMD: {
+                prefix: '!',
+                postfix: '',
+                cmds: [
+                    ["whisper ", true],
+                    ["announce ", client.user.permMap.chan.get('announce')],
+                    ["serverannounce ", client.user.permMap.site.get('announce')],
+                    ["clear ", client.user.permMap.chan.get('clearChat')],
+                    ["kick ", client.user.permMap.chan.get('kickUser')],
+                ]
+            },
+            localCMD:{
+                prefix: '/',
+                postfix: '',
+                cmds: [
+                    ["high ", true]
+                ]
+            },
+            usernames:{
+                prefix: '',
+                postfix: '',
+                cmds: injectPerms(Array.from(client.userList.colorMap.keys()))
+            },
+            emotes:{
+                prefix:'[',
+                postfix:']',
+                cmds: injectPerms(this.getEmoteNames())
+            }
+        }; 
+
+        //return our dictionary object
+        return dictionary;
+    
+        function injectPerms(cmds, perm = true){
+            //Create empty array to hold cmds
+            let cmdSet = [];
+
+            //For each cmd
+            for(let cmd of cmds){
+                //Add the cmd with its perm to the cmdset
+                cmdSet.push([cmd, perm]);
+            }
+
+            //return the cmd set
+            return cmdSet;
+        }
+    }
+
+}
+
+/**
+ * Class for Object which contains logic for client-side commands
+ */
+class commandProcessor{
+    /**
+     * Instantiates a new Command Processor object
+     * @param {channel} client - Parent client mgmt object
+     */
+    constructor(client){
+        /**
+         * Parent Client Management object
+         */
+        this.client = client
+    }
+
+    /**
+     * Method handling /high client command
+     * @param {Array} argumentArray - Array of arguments passed down from Command Pre-Processor
+     */
+    high(argumentArray){
+        //If we have an argument
+        if(argumentArray[1]){
+            //Use it to set our high level
+            //Technically this is less of a local command than it would be if it where telling the select to do this
+            //but TTN used to treat this as a local command so fuck it
+            this.client.socket.emit("setHighLevel", {highLevel: argumentArray[1]}); 
+        }
+    }
+}
+
+
+ + + + +
+ + + +
+ + + + + + + diff --git a/www/doc/client/commandProcessor.html b/www/doc/client/commandProcessor.html new file mode 100644 index 0000000..d4960e4 --- /dev/null +++ b/www/doc/client/commandProcessor.html @@ -0,0 +1,430 @@ + + + + + JSDoc: Class: commandProcessor + + + + + + + + + + +
+ +

Class: commandProcessor

+ + + + + + +
+ +
+ +

commandProcessor(client)

+ +
Class for Object which contains logic for client-side commands
+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new commandProcessor(client)

+ + + + + + +
+ Instantiates a new Command Processor object +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +channel + + + + Parent client mgmt object
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

client

+ + + + +
+ Parent Client Management object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

high(argumentArray)

+ + + + + + +
+ Method handling /high client command +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
argumentArray + + +Array + + + + Array of arguments passed down from Command Pre-Processor
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-Bold-webfont.eot b/www/doc/client/fonts/OpenSans-Bold-webfont.eot new file mode 100644 index 0000000..5d20d91 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Bold-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-Bold-webfont.svg b/www/doc/client/fonts/OpenSans-Bold-webfont.svg new file mode 100644 index 0000000..3ed7be4 --- /dev/null +++ b/www/doc/client/fonts/OpenSans-Bold-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-Bold-webfont.woff b/www/doc/client/fonts/OpenSans-Bold-webfont.woff new file mode 100644 index 0000000..1205787 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Bold-webfont.woff differ diff --git a/www/doc/client/fonts/OpenSans-BoldItalic-webfont.eot b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.eot new file mode 100644 index 0000000..1f639a1 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-BoldItalic-webfont.svg b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.svg new file mode 100644 index 0000000..6a2607b --- /dev/null +++ b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-BoldItalic-webfont.woff b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.woff new file mode 100644 index 0000000..ed760c0 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-BoldItalic-webfont.woff differ diff --git a/www/doc/client/fonts/OpenSans-Italic-webfont.eot b/www/doc/client/fonts/OpenSans-Italic-webfont.eot new file mode 100644 index 0000000..0c8a0ae Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Italic-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-Italic-webfont.svg b/www/doc/client/fonts/OpenSans-Italic-webfont.svg new file mode 100644 index 0000000..e1075dc --- /dev/null +++ b/www/doc/client/fonts/OpenSans-Italic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-Italic-webfont.woff b/www/doc/client/fonts/OpenSans-Italic-webfont.woff new file mode 100644 index 0000000..ff652e6 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Italic-webfont.woff differ diff --git a/www/doc/client/fonts/OpenSans-Light-webfont.eot b/www/doc/client/fonts/OpenSans-Light-webfont.eot new file mode 100644 index 0000000..1486840 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Light-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-Light-webfont.svg b/www/doc/client/fonts/OpenSans-Light-webfont.svg new file mode 100644 index 0000000..11a472c --- /dev/null +++ b/www/doc/client/fonts/OpenSans-Light-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-Light-webfont.woff b/www/doc/client/fonts/OpenSans-Light-webfont.woff new file mode 100644 index 0000000..e786074 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Light-webfont.woff differ diff --git a/www/doc/client/fonts/OpenSans-LightItalic-webfont.eot b/www/doc/client/fonts/OpenSans-LightItalic-webfont.eot new file mode 100644 index 0000000..8f44592 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-LightItalic-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-LightItalic-webfont.svg b/www/doc/client/fonts/OpenSans-LightItalic-webfont.svg new file mode 100644 index 0000000..431d7e3 --- /dev/null +++ b/www/doc/client/fonts/OpenSans-LightItalic-webfont.svg @@ -0,0 +1,1835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-LightItalic-webfont.woff b/www/doc/client/fonts/OpenSans-LightItalic-webfont.woff new file mode 100644 index 0000000..43e8b9e Binary files /dev/null and b/www/doc/client/fonts/OpenSans-LightItalic-webfont.woff differ diff --git a/www/doc/client/fonts/OpenSans-Regular-webfont.eot b/www/doc/client/fonts/OpenSans-Regular-webfont.eot new file mode 100644 index 0000000..6bbc3cf Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Regular-webfont.eot differ diff --git a/www/doc/client/fonts/OpenSans-Regular-webfont.svg b/www/doc/client/fonts/OpenSans-Regular-webfont.svg new file mode 100644 index 0000000..25a3952 --- /dev/null +++ b/www/doc/client/fonts/OpenSans-Regular-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/www/doc/client/fonts/OpenSans-Regular-webfont.woff b/www/doc/client/fonts/OpenSans-Regular-webfont.woff new file mode 100644 index 0000000..e231183 Binary files /dev/null and b/www/doc/client/fonts/OpenSans-Regular-webfont.woff differ diff --git a/www/doc/client/global.html b/www/doc/client/global.html new file mode 100644 index 0000000..d122a61 --- /dev/null +++ b/www/doc/client/global.html @@ -0,0 +1,217 @@ + + + + + JSDoc: Global + + + + + + + + + + +
+ +

Global

+ + + + + + +
+ +
+ +

+ + +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + +

Methods

+ + + + + + + +

onYouTubeIframeAPIReady()

+ + + + + + +
+ Youtube iframe-embed API entry point +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/www/doc/client/index.html b/www/doc/client/index.html new file mode 100644 index 0000000..c5f5bb4 --- /dev/null +++ b/www/doc/client/index.html @@ -0,0 +1,96 @@ + + + + + JSDoc: Home + + + + + + + + + + +
+ +

Home

+ + + + + + + + +

+ + + + + + + + + + + + + + + +
+

Canopy - 0.3-INDEV

+

Canopy - /ˈkæ.nə.pi/:

+
    +
  • The upper layer of foliage and branches of a forest, containing the majority of animal life.
    • +
+

Canopy is a community chat & synced video embedding web application, intended to replace fore.st as the server software for ourfore.st. +This new codebase intends to solve the following issues with the current CyTube based software:

+
    +
  • Unmaintained upstream codebase.
    • +
  • Different goals.
    • +
  • Different coding styles.
    • +
  • Obsolete Technology and Dependencies.
    • +
  • General Clunk
    • +
  • Less Unique Community Identity
    • +
+

Canopy intends to be a simple node/express.js app. It leverages yt-dlp and the internet archive REST api for metadata gathering. Persistant storage is handled by mongodb, as it's document based nature inherintly works well for cleanly storing large config documents for user/channel settings, and the low use of inter-collection references within the canopy software. All hardcore security functions like server-side input sanatization, session handling, CSRF mitigation, and password hashing are handled by industry-standard open source libraries such as validator/express-validator, express-sessions, csrf-sync, and bcrypt, however it IS hobbiest software, and it should be treated as such.

+

The Canopy codebase does not, nor will it ever contain:

+
    +
  • Advertisements (targetted or otherwise)
    • +
  • Proprietary Code
    • +
  • Cryptocurrency/Blockchain integration
    • +
  • 'Analytics/Telemtry' spyware
    • +
  • The use of video sources which require proprietary 'Digital Rights Management Ristricitons Malware' such as Widevine.
    • +
+

Thirdparty media providers may or may not contain all of the above atrocities :P (though browser-side DRM extensions will never be required), always use an ad-blocker!

+

Our current goal is to create a cleaner, more modern, purpose-built codebase that has feature-parity with the current version of fore.st, while writing improvements where possible. Once this is accomplished, and ourfore.st has been migrated, work will continue to re-create features from TTN, while also building completely new ones as well.

+

License

+

Canopy is written by the community, and provided under the GNU Affero General Public License v3 in order to prevent Canopy from being used in proprietary software or shitcoin scams.

+
+ + + + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/www/doc/client/scripts/linenumber.js b/www/doc/client/scripts/linenumber.js new file mode 100644 index 0000000..4354785 --- /dev/null +++ b/www/doc/client/scripts/linenumber.js @@ -0,0 +1,25 @@ +/*global document */ +(() => { + const source = document.getElementsByClassName('prettyprint source linenums'); + let i = 0; + let lineNumber = 0; + let lineId; + let lines; + let totalLines; + let anchorHash; + + if (source && source[0]) { + anchorHash = document.location.hash.substring(1); + lines = source[0].getElementsByTagName('li'); + totalLines = lines.length; + + for (; i < totalLines; i++) { + lineNumber++; + lineId = `line${lineNumber}`; + lines[i].id = lineId; + if (lineId === anchorHash) { + lines[i].className += ' selected'; + } + } + } +})(); diff --git a/www/doc/client/scripts/prettify/Apache-License-2.0.txt b/www/doc/client/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/www/doc/client/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/www/doc/client/scripts/prettify/lang-css.js b/www/doc/client/scripts/prettify/lang-css.js new file mode 100644 index 0000000..041e1f5 --- /dev/null +++ b/www/doc/client/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/www/doc/client/scripts/prettify/prettify.js b/www/doc/client/scripts/prettify/prettify.js new file mode 100644 index 0000000..eef5ad7 --- /dev/null +++ b/www/doc/client/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p th:last-child { border-right: 1px solid #ddd; } + +.ancestors, .attribs { color: #999; } +.ancestors a, .attribs a +{ + color: #999 !important; + text-decoration: none; +} + +.clear +{ + clear: both; +} + +.important +{ + font-weight: bold; + color: #950B02; +} + +.yes-def { + text-indent: -1000px; +} + +.type-signature { + color: #aaa; +} + +.name, .signature { + font-family: Consolas, Monaco, 'Andale Mono', monospace; +} + +.details { margin-top: 14px; border-left: 2px solid #DDD; } +.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } +.details dd { margin-left: 70px; } +.details ul { margin: 0; } +.details ul { list-style-type: none; } +.details li { margin-left: 30px; padding-top: 6px; } +.details pre.prettyprint { margin: 0 } +.details .object-value { padding-top: 0; } + +.description { + margin-bottom: 1em; + margin-top: 1em; +} + +.code-caption +{ + font-style: italic; + font-size: 107%; + margin: 0; +} + +.source +{ + border: 1px solid #ddd; + width: 80%; + overflow: auto; +} + +.prettyprint.source { + width: inherit; +} + +.source code +{ + font-size: 100%; + line-height: 18px; + display: block; + padding: 4px 12px; + margin: 0; + background-color: #fff; + color: #4D4E53; +} + +.prettyprint code span.line +{ + display: inline-block; +} + +.prettyprint.linenums +{ + padding-left: 70px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.prettyprint.linenums ol +{ + padding-left: 0; +} + +.prettyprint.linenums li +{ + border-left: 3px #ddd solid; +} + +.prettyprint.linenums li.selected, +.prettyprint.linenums li.selected * +{ + background-color: lightyellow; +} + +.prettyprint.linenums li * +{ + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; +} + +.params .name, .props .name, .name code { + color: #4D4E53; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 100%; +} + +.params td.description > p:first-child, +.props td.description > p:first-child +{ + margin-top: 0; + padding-top: 0; +} + +.params td.description > p:last-child, +.props td.description > p:last-child +{ + margin-bottom: 0; + padding-bottom: 0; +} + +.disabled { + color: #454545; +} diff --git a/www/doc/client/styles/prettify-jsdoc.css b/www/doc/client/styles/prettify-jsdoc.css new file mode 100644 index 0000000..5a2526e --- /dev/null +++ b/www/doc/client/styles/prettify-jsdoc.css @@ -0,0 +1,111 @@ +/* JSDoc prettify.js theme */ + +/* plain text */ +.pln { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* string content */ +.str { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a keyword */ +.kwd { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a comment */ +.com { + font-weight: normal; + font-style: italic; +} + +/* a type name */ +.typ { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a literal value */ +.lit { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* punctuation */ +.pun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp open bracket */ +.opn { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp close bracket */ +.clo { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a markup tag name */ +.tag { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute name */ +.atn { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute value */ +.atv { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a declaration */ +.dec { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a variable name */ +.var { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a function name */ +.fun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; +} diff --git a/www/doc/client/styles/prettify-tomorrow.css b/www/doc/client/styles/prettify-tomorrow.css new file mode 100644 index 0000000..b6f92a7 --- /dev/null +++ b/www/doc/client/styles/prettify-tomorrow.css @@ -0,0 +1,132 @@ +/* Tomorrow Theme */ +/* Original theme - https://github.com/chriskempson/tomorrow-theme */ +/* Pretty printing styles. Used with prettify.js. */ +/* SPAN elements with the classes below are added by prettyprint. */ +/* plain text */ +.pln { + color: #4d4d4c; } + +@media screen { + /* string content */ + .str { + color: #718c00; } + + /* a keyword */ + .kwd { + color: #8959a8; } + + /* a comment */ + .com { + color: #8e908c; } + + /* a type name */ + .typ { + color: #4271ae; } + + /* a literal value */ + .lit { + color: #f5871f; } + + /* punctuation */ + .pun { + color: #4d4d4c; } + + /* lisp open bracket */ + .opn { + color: #4d4d4c; } + + /* lisp close bracket */ + .clo { + color: #4d4d4c; } + + /* a markup tag name */ + .tag { + color: #c82829; } + + /* a markup attribute name */ + .atn { + color: #f5871f; } + + /* a markup attribute value */ + .atv { + color: #3e999f; } + + /* a declaration */ + .dec { + color: #f5871f; } + + /* a variable name */ + .var { + color: #c82829; } + + /* a function name */ + .fun { + color: #4271ae; } } +/* Use higher contrast and text-weight for printable form. */ +@media print, projection { + .str { + color: #060; } + + .kwd { + color: #006; + font-weight: bold; } + + .com { + color: #600; + font-style: italic; } + + .typ { + color: #404; + font-weight: bold; } + + .lit { + color: #044; } + + .pun, .opn, .clo { + color: #440; } + + .tag { + color: #006; + font-weight: bold; } + + .atn { + color: #404; } + + .atv { + color: #060; } } +/* Style */ +/* +pre.prettyprint { + background: white; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 12px; + line-height: 1.5; + border: 1px solid #ccc; + padding: 10px; } +*/ + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; } + +/* IE indents via margin-left */ +li.L0, +li.L1, +li.L2, +li.L3, +li.L4, +li.L5, +li.L6, +li.L7, +li.L8, +li.L9 { + /* */ } + +/* Alternate shading for lines */ +li.L1, +li.L3, +li.L5, +li.L7, +li.L9 { + /* */ } diff --git a/www/doc/client/userList.html b/www/doc/client/userList.html new file mode 100644 index 0000000..74f27cc --- /dev/null +++ b/www/doc/client/userList.html @@ -0,0 +1,1200 @@ + + + + + JSDoc: Class: userList + + + + + + + + + + +
+ +

Class: userList

+ + + + + + +
+ +
+ +

userList(client)

+ +
Class for object containing logic behind userlist UX
+ + +
+ +
+
+ + + + +

Constructor

+ + + +

new userList(client)

+ + + + + + +
+ Instantiates a new userList object +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +channel + + + + Parent client mgmt object
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Members

+ + + +

clickDragger

+ + + + +
+ Click Dragger object for handling userlist resizes +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

client

+ + + + +
+ Parent Client Management object +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

colorMap

+ + + + +
+ Map of usernames to assigned username color +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

toggleIcon

+ + + + +
+ userlist toggle button +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userColors

+ + + + +
+ Userlist color array (Maps to css classes) +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userCount

+ + + + +
+ user count label +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userDiv

+ + + + +
+ users div +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

userList

+ + + + +
+ userlist div +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + + +

defineListeners()

+ + + + + + +
+ Defines network-related event listeners +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

renderUser(user, flair)

+ + + + + + +
+ Renders out a single username to the userlist +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
user + + +String + + + + Username to render
flair + + +String + + + + Flair to render as
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

setupInput()

+ + + + + + +
+ Defines input-related event listeners +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

updateList(list)

+ + + + + + +
+ Updates UX after user list change +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
list + + +Array + + + + Userlist data from server
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:53 GMT-0400 (Eastern Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/www/doc/client/userlist.js.html b/www/doc/client/userlist.js.html new file mode 100644 index 0000000..b1677df --- /dev/null +++ b/www/doc/client/userlist.js.html @@ -0,0 +1,261 @@ + + + + + JSDoc: Source: userlist.js + + + + + + + + + + +
+ +

Source: userlist.js

+ + + + + + +
+
+ 
/*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/>.*/
+
+/**
+ * Class for object containing logic behind userlist UX
+ */
+class userList{
+    /**
+     * Instantiates a new userList object
+     * @param {channel} client - Parent client mgmt object
+     */
+    constructor(client){
+        /**
+         * Parent Client Management object
+         */
+        this.client = client
+
+        /**
+         * Click Dragger object for handling userlist resizes
+         */
+        this.clickDragger = new canopyUXUtils.clickDragger("#chat-panel-users-drag-handle", "#chat-panel-users-div", true, this.client.chatBox.clickDragger);
+        
+        /**
+         * Userlist color array (Maps to css classes)
+         */
+        this.userColors = [
+            "userlist-color0",
+            "userlist-color1",
+            "userlist-color2",
+            "userlist-color3", 
+            "userlist-color4",
+            "userlist-color5",
+            "userlist-color6"];
+        
+        /**
+         * Map of usernames to assigned username color
+         */
+        this.colorMap = new Map();
+
+        /**
+         * users div
+         */
+        this.userDiv = document.querySelector("#chat-panel-users-div");
+
+        /**
+         * userlist div
+         */
+        this.userList = document.querySelector("#chat-panel-users-list-div");
+
+        /**
+         * user count label
+         */
+        this.userCount = document.querySelector("#chat-panel-user-count");
+
+        /**
+         * userlist toggle button
+         */
+        this.toggleIcon = document.querySelector("#chat-panel-users-toggle");
+
+        //Call setup functions
+        this.setupInput();
+        this.defineListeners();
+    }
+
+    /**
+     * Defines input-related event listeners
+     */
+    setupInput(){
+        this.toggleIcon.addEventListener("click", ()=>{this.toggleUI()});
+        this.userCount.addEventListener("click", ()=>{this.toggleUI()});
+    }
+
+    /**
+     * Defines network-related event listeners
+     */
+    defineListeners(){
+        this.client.socket.on('userList', (data) => {
+            this.updateList(data);
+        });
+
+        this.client.socket.on("disconnect", () => {
+            this.updateList([]);
+        })
+    }
+
+    /**
+     * Updates UX after user list change
+     * @param {Array} list - Userlist data from server
+     */
+    updateList(list){
+        //Clear list and set user count
+        this.userCount.textContent = list.length == 1 ? '1 User' : `${list.length} Users`;
+        this.userList.innerHTML = null;
+
+        //create a new map
+        var newMap = new Map();
+
+        //for each user
+        list.forEach((user) => {
+            //randomly pick a color
+            var color = this.userColors[Math.floor(Math.random()*this.userColors.length)]
+
+            //if this user was in the previous colormap
+            if(this.colorMap.get(user.user) != null){
+                //Override with previous color
+                color = this.colorMap.get(user.user);
+            }
+
+            newMap.set(user.user, color);
+            this.renderUser(user, color);
+        });
+
+        this.colorMap = newMap;
+
+        //Make sure we're not cutting the ux off
+        this.clickDragger.fixCutoff();
+    }
+
+    /**
+     * Renders out a single username to the userlist
+     * @param {String} user - Username to render
+     * @param {String} flair - Flair to render as
+     */
+    renderUser(user, flair){
+
+        //Create user span
+        var userSpan = document.createElement('span');
+        userSpan.classList.add('chat-panel-users', 'user-entry');
+
+        //Create high-level label
+        var highLevel = document.createElement('p');
+        highLevel.classList.add("user-list-high-level","high-level");
+        highLevel.textContent = `${user.highLevel}`;
+
+        //Create nameplate
+        var userEntry = document.createElement('p');
+        userEntry.innerText = user.user;
+        userEntry.id = `user-entry-${user.user}`;
+
+        //Override color with flair
+        if(user.flair != "classic"){
+            flair = `flair-${user.flair}`;
+        }
+        //Add classes to classList
+        userEntry.classList.add("chat-panel-users","user-entry",flair); 
+
+        //Add high-level username to nameplate
+        userSpan.appendChild(highLevel);
+        userSpan.appendChild(userEntry);
+
+        //Setup profile tooltip
+        userSpan.addEventListener('mouseenter',(event)=>{utils.ux.displayTooltip(event, `profile?user=${user.user}`, true, null, true);});
+
+        //Setup profile context menu
+        userSpan.addEventListener('click', renderContextMenu.bind(this));
+        userSpan.addEventListener('contextmenu', renderContextMenu.bind(this));
+
+        this.userList.appendChild(userSpan);
+
+        function renderContextMenu(event){
+            //Setup menu map
+            let menuMap = new Map([
+                    ["Profile", ()=>{this.client.cPanel.setActivePanel(new panelObj(this.client, `${user.user}`, `/panel/profile?user=${user.user}`))}],
+                    ["Mention", ()=>{this.client.chatBox.catChat(`${user.user} `)}],
+                    ["Toke With", ()=>{this.client.chatBox.tokeWith(user.user)}],
+            ]);
+
+            if(user.user != "Tokebot" && user.user != this.client.user.user){
+                if(this.client.user.permMap.chan.get("kickUser")){
+                    menuMap.set("Kick", ()=>{this.client.chatBox.commandPreprocessor.preprocess(`!kick ${user.user}`)});
+                }
+
+                if(this.client.user.permMap.chan.get("banUser")){
+                    menuMap.set("Channel Ban", ()=>{new chanBanUserPopup(this.client.channelName, user.user);});
+                }
+
+                if(this.client.user.permMap.site.get("banUser")){
+                    menuMap.set("Site Ban", ()=>{new banUserPopup(user.user);});
+                }
+            }
+
+            //Display the menu
+            utils.ux.displayContextMenu(event, user.user, menuMap);
+        }
+    }
+
+    toggleUI(show = !this.userDiv.checkVisibility()){
+        if(show){
+            this.userDiv.style.display = "flex";
+            this.toggleIcon.classList.replace("bi-caret-left-fill","bi-caret-down-fill");
+            this.clickDragger.fixCutoff();
+        }else{
+            this.userDiv.style.display = "none";
+            this.toggleIcon.classList.replace("bi-caret-down-fill","bi-caret-left-fill");
+        }
+    }
+
+}
+
+
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:53 GMT-0400 (Eastern Daylight Time) +
+ + + + + diff --git a/www/doc/server/activeChannel.html b/www/doc/server/activeChannel.html index e550d80..6e0f755 100644 --- a/www/doc/server/activeChannel.html +++ b/www/doc/server/activeChannel.html @@ -786,7 +786,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_activeChannel.js.html b/www/doc/server/app_channel_activeChannel.js.html index f351621..fbc5fbc 100644 --- a/www/doc/server/app_channel_activeChannel.js.html +++ b/www/doc/server/app_channel_activeChannel.js.html @@ -196,7 +196,7 @@ module.exports = activeChannel;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_channelManager.js.html b/www/doc/server/app_channel_channelManager.js.html index ac28645..51e0812 100644 --- a/www/doc/server/app_channel_channelManager.js.html +++ b/www/doc/server/app_channel_channelManager.js.html @@ -347,7 +347,7 @@ module.exports = channelManager;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_chat.js.html b/www/doc/server/app_channel_chat.js.html index 12a97a2..d013229 100644 --- a/www/doc/server/app_channel_chat.js.html +++ b/www/doc/server/app_channel_chat.js.html @@ -81,7 +81,7 @@ module.exports = chat;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_chatBuffer.js.html b/www/doc/server/app_channel_chatBuffer.js.html index 039412f..11947f7 100644 --- a/www/doc/server/app_channel_chatBuffer.js.html +++ b/www/doc/server/app_channel_chatBuffer.js.html @@ -178,7 +178,7 @@ module.exports = chatBuffer;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_chatHandler.js.html b/www/doc/server/app_channel_chatHandler.js.html index 1fa9eaa..c7ffc23 100644 --- a/www/doc/server/app_channel_chatHandler.js.html +++ b/www/doc/server/app_channel_chatHandler.js.html @@ -376,7 +376,7 @@ module.exports = chatHandler;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_commandPreprocessor.js.html b/www/doc/server/app_channel_commandPreprocessor.js.html index 554d104..f2411c6 100644 --- a/www/doc/server/app_channel_commandPreprocessor.js.html +++ b/www/doc/server/app_channel_commandPreprocessor.js.html @@ -473,7 +473,7 @@ module.exports = commandPreprocessor;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_connectedUser.js.html b/www/doc/server/app_channel_connectedUser.js.html index b37162c..63bc23e 100644 --- a/www/doc/server/app_channel_connectedUser.js.html +++ b/www/doc/server/app_channel_connectedUser.js.html @@ -334,7 +334,7 @@ module.exports = connectedUser;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_media_media.js.html b/www/doc/server/app_channel_media_media.js.html index 08fd81b..1f4249a 100644 --- a/www/doc/server/app_channel_media_media.js.html +++ b/www/doc/server/app_channel_media_media.js.html @@ -83,7 +83,7 @@ module.exports = media;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_media_playlistHandler.js.html b/www/doc/server/app_channel_media_playlistHandler.js.html index 0a01917..02d6a5c 100644 --- a/www/doc/server/app_channel_media_playlistHandler.js.html +++ b/www/doc/server/app_channel_media_playlistHandler.js.html @@ -1180,7 +1180,7 @@ module.exports = playlistHandler;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_media_queue.js.html b/www/doc/server/app_channel_media_queue.js.html index eb6d75f..7ffd44f 100644 --- a/www/doc/server/app_channel_media_queue.js.html +++ b/www/doc/server/app_channel_media_queue.js.html @@ -1795,7 +1795,7 @@ module.exports = queue;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_media_queuedMedia.js.html b/www/doc/server/app_channel_media_queuedMedia.js.html index d8ba89f..6bf4702 100644 --- a/www/doc/server/app_channel_media_queuedMedia.js.html +++ b/www/doc/server/app_channel_media_queuedMedia.js.html @@ -165,7 +165,7 @@ module.exports = queuedMedia;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/app_channel_tokebot.js.html b/www/doc/server/app_channel_tokebot.js.html index f272b14..14732da 100644 --- a/www/doc/server/app_channel_tokebot.js.html +++ b/www/doc/server/app_channel_tokebot.js.html @@ -273,7 +273,7 @@ module.exports = tokebot;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/channelManager.html b/www/doc/server/channelManager.html index 5cc831d..5e1c56b 100644 --- a/www/doc/server/channelManager.html +++ b/www/doc/server/channelManager.html @@ -1991,7 +1991,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/chat.html b/www/doc/server/chat.html index 1103ae6..890fa38 100644 --- a/www/doc/server/chat.html +++ b/www/doc/server/chat.html @@ -329,7 +329,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/chatBuffer.html b/www/doc/server/chatBuffer.html index b33a017..6df7d3c 100644 --- a/www/doc/server/chatBuffer.html +++ b/www/doc/server/chatBuffer.html @@ -829,7 +829,7 @@ Left here since it seems like good form anywho, since this would be a private, o
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/chatHandler.html b/www/doc/server/chatHandler.html index 534792b..72a56ca 100644 --- a/www/doc/server/chatHandler.html +++ b/www/doc/server/chatHandler.html @@ -3686,7 +3686,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/commandPreprocessor.html b/www/doc/server/commandPreprocessor.html index 999c40f..5d60fbd 100644 --- a/www/doc/server/commandPreprocessor.html +++ b/www/doc/server/commandPreprocessor.html @@ -1246,7 +1246,7 @@ These arrays are used to handle further command/chat processing
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/commandProcessor.html b/www/doc/server/commandProcessor.html index 562c247..698151b 100644 --- a/www/doc/server/commandProcessor.html +++ b/www/doc/server/commandProcessor.html @@ -1831,7 +1831,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/connectedUser.html b/www/doc/server/connectedUser.html index 8e2281c..8e48e2f 100644 --- a/www/doc/server/connectedUser.html +++ b/www/doc/server/connectedUser.html @@ -1879,7 +1879,7 @@ Having to crawl through these sockets is that. Because the other ways seem more
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/global.html b/www/doc/server/global.html index a6340bb..9bc98d7 100644 --- a/www/doc/server/global.html +++ b/www/doc/server/global.html @@ -7377,7 +7377,7 @@ Warns server admin against unsafe config options.
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/index.html b/www/doc/server/index.html index 5d31476..91b924e 100644 --- a/www/doc/server/index.html +++ b/www/doc/server/index.html @@ -87,7 +87,7 @@ This new codebase intends to solve the following issues with the current CyTube
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/media.html b/www/doc/server/media.html index e0a1b6d..05f1463 100644 --- a/www/doc/server/media.html +++ b/www/doc/server/media.html @@ -352,7 +352,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/playlistHandler.html b/www/doc/server/playlistHandler.html index 3efb58f..b507305 100644 --- a/www/doc/server/playlistHandler.html +++ b/www/doc/server/playlistHandler.html @@ -5108,7 +5108,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/queue.html b/www/doc/server/queue.html index 5166e19..0dcfeda 100644 --- a/www/doc/server/queue.html +++ b/www/doc/server/queue.html @@ -5805,7 +5805,7 @@ Called auto-magically by the Synchronization Timer
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/queuedMedia.html b/www/doc/server/queuedMedia.html index fc2445c..6dae2ba 100644 --- a/www/doc/server/queuedMedia.html +++ b/www/doc/server/queuedMedia.html @@ -936,7 +936,7 @@
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_channelBanSchema.js.html b/www/doc/server/schemas_channel_channelBanSchema.js.html index 52c503d..f75fc05 100644 --- a/www/doc/server/schemas_channel_channelBanSchema.js.html +++ b/www/doc/server/schemas_channel_channelBanSchema.js.html @@ -101,7 +101,7 @@ module.exports = channelBanSchema;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_channelPermissionSchema.js.html b/www/doc/server/schemas_channel_channelPermissionSchema.js.html index 4beb50c..60a8dfb 100644 --- a/www/doc/server/schemas_channel_channelPermissionSchema.js.html +++ b/www/doc/server/schemas_channel_channelPermissionSchema.js.html @@ -169,7 +169,7 @@ module.exports = channelPermissionSchema;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_channelSchema.js.html b/www/doc/server/schemas_channel_channelSchema.js.html index 7e669b8..143bfc4 100644 --- a/www/doc/server/schemas_channel_channelSchema.js.html +++ b/www/doc/server/schemas_channel_channelSchema.js.html @@ -934,7 +934,7 @@ module.exports = mongoose.model("channel", channelSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_chatSchema.js.html b/www/doc/server/schemas_channel_chatSchema.js.html index 7fc66fc..f2ecd6a 100644 --- a/www/doc/server/schemas_channel_chatSchema.js.html +++ b/www/doc/server/schemas_channel_chatSchema.js.html @@ -96,7 +96,7 @@ module.exports = chatSchema;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_media_mediaSchema.js.html b/www/doc/server/schemas_channel_media_mediaSchema.js.html index 5cf4ba9..79f37b8 100644 --- a/www/doc/server/schemas_channel_media_mediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_mediaSchema.js.html @@ -96,7 +96,7 @@ module.exports = mediaSchema;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html b/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html index c2e909d..f5e8950 100644 --- a/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_playlistMediaSchema.js.html @@ -124,7 +124,7 @@ module.exports = mediaSchema.discriminator('saved', playlistMediaProperties);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_media_playlistSchema.js.html b/www/doc/server/schemas_channel_media_playlistSchema.js.html index 5d9cc3b..3bb51f6 100644 --- a/www/doc/server/schemas_channel_media_playlistSchema.js.html +++ b/www/doc/server/schemas_channel_media_playlistSchema.js.html @@ -174,7 +174,7 @@ module.exports = playlistSchema;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html b/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html index bd2431c..b1f0ac2 100644 --- a/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html +++ b/www/doc/server/schemas_channel_media_queuedMediaSchema.js.html @@ -113,7 +113,7 @@ module.exports = mediaSchema.discriminator('queued', queuedProperties);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_emoteSchema.js.html b/www/doc/server/schemas_emoteSchema.js.html index 258c270..d08a919 100644 --- a/www/doc/server/schemas_emoteSchema.js.html +++ b/www/doc/server/schemas_emoteSchema.js.html @@ -164,7 +164,7 @@ module.exports = mongoose.model("emote", emoteSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_flairSchema.js.html b/www/doc/server/schemas_flairSchema.js.html index 3329d2a..657647f 100644 --- a/www/doc/server/schemas_flairSchema.js.html +++ b/www/doc/server/schemas_flairSchema.js.html @@ -118,7 +118,7 @@ module.exports = mongoose.model("flair", flairSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_permissionSchema.js.html b/www/doc/server/schemas_permissionSchema.js.html index 3659f64..8f40f49 100644 --- a/www/doc/server/schemas_permissionSchema.js.html +++ b/www/doc/server/schemas_permissionSchema.js.html @@ -356,7 +356,7 @@ module.exports = mongoose.model("permissions", permissionSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_statSchema.js.html b/www/doc/server/schemas_statSchema.js.html index 3f276ed..c61fbf9 100644 --- a/www/doc/server/schemas_statSchema.js.html +++ b/www/doc/server/schemas_statSchema.js.html @@ -240,7 +240,7 @@ module.exports = mongoose.model("statistics", statSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html b/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html index 59a8416..4c5a68e 100644 --- a/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html +++ b/www/doc/server/schemas_tokebot_tokeCommandSchema.js.html @@ -160,7 +160,7 @@ module.exports = mongoose.model("tokeCommand", tokeCommandSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_user_emailChangeSchema.js.html b/www/doc/server/schemas_user_emailChangeSchema.js.html index a4da1f1..9a392c1 100644 --- a/www/doc/server/schemas_user_emailChangeSchema.js.html +++ b/www/doc/server/schemas_user_emailChangeSchema.js.html @@ -222,7 +222,7 @@ module.exports = mongoose.model("emailChange", emailChangeSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_user_passwordResetSchema.js.html b/www/doc/server/schemas_user_passwordResetSchema.js.html index 16d75cc..16be6b7 100644 --- a/www/doc/server/schemas_user_passwordResetSchema.js.html +++ b/www/doc/server/schemas_user_passwordResetSchema.js.html @@ -198,7 +198,7 @@ module.exports = mongoose.model("passwordReset", passwordResetSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_user_userBanSchema.js.html b/www/doc/server/schemas_user_userBanSchema.js.html index c33bec5..6f532e3 100644 --- a/www/doc/server/schemas_user_userBanSchema.js.html +++ b/www/doc/server/schemas_user_userBanSchema.js.html @@ -521,7 +521,7 @@ module.exports = mongoose.model("userBan", userBanSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/schemas_user_userSchema.js.html b/www/doc/server/schemas_user_userSchema.js.html index 5b3dce6..10ee9d0 100644 --- a/www/doc/server/schemas_user_userSchema.js.html +++ b/www/doc/server/schemas_user_userSchema.js.html @@ -888,7 +888,7 @@ module.exports.userModel = mongoose.model("user", userSchema);
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/tokebot.html b/www/doc/server/tokebot.html index f6696dc..5e3f64b 100644 --- a/www/doc/server/tokebot.html +++ b/www/doc/server/tokebot.html @@ -841,7 +841,7 @@ I would now, but I don't want to break shit in a comment-only commit.
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_altchaUtils.js.html b/www/doc/server/utils_altchaUtils.js.html index 3ce1fb9..3230072 100644 --- a/www/doc/server/utils_altchaUtils.js.html +++ b/www/doc/server/utils_altchaUtils.js.html @@ -118,7 +118,7 @@ module.exports.verify = async function(payload, uniqueSecret = ''){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_configCheck.js.html b/www/doc/server/utils_configCheck.js.html index 0eb55a1..f230ed1 100644 --- a/www/doc/server/utils_configCheck.js.html +++ b/www/doc/server/utils_configCheck.js.html @@ -108,7 +108,7 @@ module.exports.securityCheck = function(){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_hashUtils.js.html b/www/doc/server/utils_hashUtils.js.html index 18c927e..4ccb566 100644 --- a/www/doc/server/utils_hashUtils.js.html +++ b/www/doc/server/utils_hashUtils.js.html @@ -103,7 +103,7 @@ module.exports.hashIP = function(ip){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_linkUtils.js.html b/www/doc/server/utils_linkUtils.js.html index 3eeb13f..53c42b2 100644 --- a/www/doc/server/utils_linkUtils.js.html +++ b/www/doc/server/utils_linkUtils.js.html @@ -146,7 +146,7 @@ module.exports.markLink = async function(link){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_loggerUtils.js.html b/www/doc/server/utils_loggerUtils.js.html index 233351f..53e51ab 100644 --- a/www/doc/server/utils_loggerUtils.js.html +++ b/www/doc/server/utils_loggerUtils.js.html @@ -207,7 +207,7 @@ module.exports.errorMiddleware = function(err, req, res, next){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_mailUtils.js.html b/www/doc/server/utils_mailUtils.js.html index e5abb54..067fd69 100644 --- a/www/doc/server/utils_mailUtils.js.html +++ b/www/doc/server/utils_mailUtils.js.html @@ -140,7 +140,7 @@ module.exports.sendAddressVerification = async function(requestDB, userDB, newEm
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_media_internetArchiveUtils.js.html b/www/doc/server/utils_media_internetArchiveUtils.js.html index 5c28a5d..da6f930 100644 --- a/www/doc/server/utils_media_internetArchiveUtils.js.html +++ b/www/doc/server/utils_media_internetArchiveUtils.js.html @@ -154,7 +154,7 @@ module.exports.fetchMetadata = async function(fullID, title){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_media_yanker.js.html b/www/doc/server/utils_media_yanker.js.html index e34f4c7..63610fd 100644 --- a/www/doc/server/utils_media_yanker.js.html +++ b/www/doc/server/utils_media_yanker.js.html @@ -193,7 +193,7 @@ module.exports.getMediaType = async function(url){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_media_ytdlpUtils.js.html b/www/doc/server/utils_media_ytdlpUtils.js.html index 17bb3d2..66c0dae 100644 --- a/www/doc/server/utils_media_ytdlpUtils.js.html +++ b/www/doc/server/utils_media_ytdlpUtils.js.html @@ -186,7 +186,7 @@ async function ytdlpFetch(link, format = 'b'){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_regexUtils.js.html b/www/doc/server/utils_regexUtils.js.html index a3db8ae..fd9f1a1 100644 --- a/www/doc/server/utils_regexUtils.js.html +++ b/www/doc/server/utils_regexUtils.js.html @@ -69,7 +69,7 @@ module.exports.escapeRegex = function(string){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_scheduler.js.html b/www/doc/server/utils_scheduler.js.html index 7161597..500ce72 100644 --- a/www/doc/server/utils_scheduler.js.html +++ b/www/doc/server/utils_scheduler.js.html @@ -105,7 +105,7 @@ module.exports.kickoff = function(){
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/doc/server/utils_sessionUtils.js.html b/www/doc/server/utils_sessionUtils.js.html index 05c32c5..c2ca71d 100644 --- a/www/doc/server/utils_sessionUtils.js.html +++ b/www/doc/server/utils_sessionUtils.js.html @@ -236,7 +236,7 @@ module.exports.maxAttempts = maxAttempts;
- Documentation generated by JSDoc 4.0.4 on Tue Sep 02 2025 07:43:33 GMT-0400 (Eastern Daylight Time) + Documentation generated by JSDoc 4.0.4 on Wed Sep 03 2025 07:51:51 GMT-0400 (Eastern Daylight Time)
diff --git a/www/js/channel/channel.js b/www/js/channel/channel.js index 3f9df64..3a9d511 100644 --- a/www/js/channel/channel.js +++ b/www/js/channel/channel.js @@ -14,26 +14,47 @@ 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 .*/ +/** + * Class for object containing base code for the Canopy channel client. + */ class channel{ + /** + * Instantiates a new channel object + */ constructor(){ //Establish connetion to the server via socket.io this.connect(); //Define socket listeners this.defineListeners(); - //Flag youtube iframe-embed api as unloaded + /** + * Returns true once the ytEmbed API has loaded in from google (eww) + */ this.ytEmbedAPILoaded = false; - //Scrape channel name off URL + /** + * Current connected channels name + */ this.channelName = window.location.pathname.split('/c/')[1].split('/')[0]; - //Create the Video Player Object + /** + * Child Video Player object + */ this.player = new player(this); - //Create the Chat Box Object + + /** + * Child Chat Box Object + */ this.chatBox = new chatBox(this); - //Create the User List Object + + /** + * Child User List Object + */ this.userList = new userList(this); - //Create the Canopy Panel Object + + /** + * Child Canopy Panel Object + */ this.cPanel = new cPanel(this); //Set defaults for any unset settings and run any required process steps for the current config @@ -43,6 +64,9 @@ class channel{ console.log("👁️👄👁️ ℬℴ𝓊𝓃𝒿ℴ𝓊𝓇."); } + /** + * Handles initial client connection + */ connect(){ this.socket = io({ extraHeaders: { @@ -52,6 +76,9 @@ class channel{ }); } + /** + * Defines network-related listeners + */ defineListeners(){ this.socket.on("connect", () => { document.title = `${this.channelName} - Connected` @@ -82,6 +109,10 @@ class channel{ }); } + /** + * Handles initial client-metadata ingestion from server upon connection + * @param {Object} data - Data glob from server + */ handleClientInfo(data){ //Ingest user data this.user = data.user; @@ -107,6 +138,11 @@ class channel{ } } + /** + * Processes and applies default config on any unset settings + * @param {Boolean} force - Whether or not to forcefully reset already set settings + * @param {Boolean} processConfig - Whether or not to run the Process Config function once complete + */ setDefaults(force = false, processConfig = false){ //Iterate through default config for(let [key, value] of channel.defaultConfig){ @@ -124,6 +160,11 @@ class channel{ } } + /** + * Run once every config change to ensure settings are properly set + * @param {String} key - Setting to change + * @param {*} value - Value to set setting to + */ processConfig(key, value){ //Switch/case by config key switch(key){ @@ -179,12 +220,17 @@ class channel{ } } + /** + * Default channel config + */ static defaultConfig = new Map([ ["ytPlayerType","raw"] ]); } -//Youtube iframe-embed API load handler +/** + * Youtube iframe-embed API entry point + */ function onYouTubeIframeAPIReady(){ //Set embed api to true client.ytEmbedAPILoaded = true; diff --git a/www/js/channel/chat.js b/www/js/channel/chat.js index a6cfa84..81624fd 100644 --- a/www/js/channel/chat.js +++ b/www/js/channel/chat.js @@ -13,25 +13,59 @@ 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 .*/ + +/** + * Class for Object which represents Canopy Chat Box UI + */ class chatBox{ + /** + * Instantiates a new Chat Box object + * @param {channel} client - Parent client Management Object + */ constructor(client){ - //Client Object + /** + * Parent CLient Management Object + */ this.client = client - //Booleans + /** + * Whether or not chat-size should be locked to current media aspect ratio + */ this.aspectLock = true; + + /** + * Whether or not the chat box should auto-scroll on new chat + */ this.autoScroll = true; - //Numbers + /** + * Chat Buffer Scroll Top on last scroll + */ this.lastPos = 0; + + /** + * Height of Chat Buffer on last scroll + */ this.lastHeight = 0; + + /** + * Width of Chat Buffer on last scroll + */ this.lastWidth = 0; - //clickDragger object + /** + * Click-Dragger Object for handling dynamic chat/video split re-sizing + */ this.clickDragger = new canopyUXUtils.clickDragger("#chat-panel-drag-handle", "#chat-panel-div"); - //Preprocessor objects + /** + * Command Pre-Processor Object + */ this.commandPreprocessor = new commandPreprocessor(client); + + /** + * Chat Post-Processor Object + */ this.chatPostprocessor = new chatPostprocessor(client); //Element Nodes @@ -145,8 +179,6 @@ class chatBox{ chatBody.classList.add("chat-panel-buffer","chat-entry-body"); chatEntry.appendChild(chatBody); - console.log(data); - //Append the post-processed chat-body to the chat buffer this.chatBuffer.appendChild(this.chatPostprocessor.postprocess(chatEntry, data)); diff --git a/www/js/channel/commandPreprocessor.js b/www/js/channel/commandPreprocessor.js index 49f9fc4..6486cc9 100644 --- a/www/js/channel/commandPreprocessor.js +++ b/www/js/channel/commandPreprocessor.js @@ -13,10 +13,29 @@ 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 .*/ + +/** + * Class for object containing chat and command pre-processing logic + */ class commandPreprocessor{ + /** + * Instantiates a new commandPreprocessor object + * @param {channel} client - Parent client Management Object + */ constructor(client){ + /** + * Parent Client Management object + */ this.client = client; + + /** + * Child Command Processor object + */ this.commandProcessor = new commandProcessor(client); + + /** + * Set of arrays containing site-wide, channel-wide, and user-specific emotes + */ this.emotes = { site: [], chan: [], @@ -27,6 +46,9 @@ class commandPreprocessor{ this.defineListeners(); } + /** + * Defines Network-Related Listeners + */ defineListeners(){ //When we receive site-wide emote list this.client.socket.on("siteEmotes", this.setSiteEmotes.bind(this)); @@ -35,21 +57,34 @@ class commandPreprocessor{ this.client.socket.on("usedTokes", this.setUsedTokes.bind(this)); } + /** + * Pre-Processes a single chat/command before sending it off to the server + * @param {String} command - Chat/Command to pre-process + */ preprocess(command){ //Set command and sendFlag this.command = command; this.sendFlag = true; + //Attempt to process as local command this.processLocalCommand(); + //If we made it through the local command processor if(this.sendFlag){ + //Set the message to the command this.message = command; + //Process message emotes into links this.processEmotes(); + //Process unmarked links into marked links this.processLinks(); + //Send command off to server this.sendRemoteCommand(); } } + /** + * Processes local commands, starting with '/' + */ processLocalCommand(){ //Create an empty array to hold the command this.commandArray = []; @@ -70,6 +105,9 @@ class commandPreprocessor{ } } + /** + * Processes emotes refrences in loaded message into links to be further processed by processLinks() + */ processEmotes(){ //inject invisible whitespace in-between emotes to prevent from mushing links together this.message = this.message.replaceAll('][',']ㅤ['); @@ -84,6 +122,9 @@ class commandPreprocessor{ }); } + /** + * Processes links into numbered file seperators, putting links into a dedicated array. + */ processLinks(){ //Strip out file seperators in-case the user is being a smart-ass this.message = this.message.replaceAll('␜',''); @@ -109,26 +150,50 @@ class commandPreprocessor{ this.message = splitMessage.join(''); } + /** + * Transmits message/command off to server + */ sendRemoteCommand(){ this.client.socket.emit("chatMessage",{msg: this.message, links: this.links}); } + /** + * Sets site emotes + * @param {Object} data - Emote data from server + */ setSiteEmotes(data){ this.emotes.site = data; } + /** + * Sets channel emotes + * @param {Object} data - Emote data from server + */ setChanEmotes(data){ this.emotes.chan = data; } + /** + * Sets personal emotes + * @param {Object} data - Emote data from server + */ setPersonalEmotes(data){ this.emotes.personal = data; } + /** + * Sets used tokes + * @param {Object} data - Used toke data from server + */ setUsedTokes(data){ this.usedTokes = data.tokes; } + /** + * Fetches emote by link + * @param {String} link - Link to fetch emote with + * @returns {Object} found emote + */ getEmoteByLink(link){ //Create an empty variable to hold the found emote var foundEmote = null; @@ -148,6 +213,10 @@ class commandPreprocessor{ return foundEmote; } + /** + * Generates flat list of emote names + * @returns {Array} List of strings containing emote names + */ getEmoteNames(){ //Create an empty array to hold names let names = []; @@ -165,6 +234,10 @@ class commandPreprocessor{ return names; } + /** + * Generates auto-complete dictionary from pre-written commands, emotes, and used tokes from servers for use with autocomplete + * @returns {Object} Generated Dictionary object + */ buildAutocompleteDictionary(){ let dictionary = { tokes: { @@ -226,11 +299,25 @@ class commandPreprocessor{ } +/** + * Class for Object which contains logic for client-side commands + */ class commandProcessor{ + /** + * Instantiates a new Command Processor object + * @param {channel} client - Parent client mgmt object + */ constructor(client){ + /** + * Parent Client Management object + */ this.client = client } + /** + * Method handling /high client command + * @param {Array} argumentArray - Array of arguments passed down from Command Pre-Processor + */ high(argumentArray){ //If we have an argument if(argumentArray[1]){ diff --git a/www/js/channel/cpanel.js b/www/js/channel/cpanel.js index 3e5fa2c..53c2f44 100644 --- a/www/js/channel/cpanel.js +++ b/www/js/channel/cpanel.js @@ -14,39 +14,114 @@ 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 .*/ +/** + * Class for Object containing code for managing the Canopy Panel UX + */ class cPanel{ + /** + * Instantiates a new Canopy Panel Management object + * @param {channel} client - Parent client Management Object + */ constructor(client){ - //Client Object + /** + * Parent Client Management object + */ this.client = client; - //Panel Objects + /** + * Active Panel Object + */ this.activePanel = null; + + /** + * Pinned Panel Object + */ this.pinnedPanel = null; + + /** + * Popped Panel Objects + */ this.poppedPanels = []; - //ClickDragger Objects + /** + * Click-Dragger object for re-sizable active panel + */ this.activePanelDragger = new canopyUXUtils.clickDragger("#cpanel-active-drag-handle", "#cpanel-active-div", false, null, false); + + /** + * Click-Dragger object for re-sizable pinned panel + */ this.pinnedPanelDragger = new canopyUXUtils.clickDragger("#cpanel-pinned-drag-handle", "#cpanel-pinned-div", false, this.client.chatBox.clickDragger); //Element Nodes //Active Panel + /** + * Active Panel Container + */ this.activePanelDiv = document.querySelector("#cpanel-active-div"); + + /** + * Active Panel Title + */ this.activePanelTitle = document.querySelector("#cpanel-active-title"); + + /** + * Active Title Document Div + */ this.activePanelDoc = document.querySelector("#cpanel-active-doc"); + + /** + * Active Panel Pin Icon + */ this.activePanelPinIcon = document.querySelector("#cpanel-active-pin-icon"); + + /** + * Active Panel Pop-Out Icon + */ this.activePanelPopoutIcon = document.querySelector("#cpanel-active-popout-icon"); + + /** + * Active Panel Close Icon + */ this.activePanelCloseIcon = document.querySelector("#cpanel-active-close-icon"); + //Pinned Panel + /** + * Pinned Panel Contianer + */ this.pinnedPanelDiv = document.querySelector("#cpanel-pinned-div"); + + /** + * Pinned Panel Title + */ this.pinnedPanelTitle = document.querySelector("#cpanel-pinned-title"); + + /** + * Pinned Panel Document Div + */ this.pinnedPanelDoc = document.querySelector("#cpanel-pinned-doc"); + + /** + * Pinned Panel Un-Pin Icon + */ this.pinnedPanelUnpinIcon = document.querySelector("#cpanel-pinned-unpin-icon"); + + /** + * Pinned Panel Pop-Out Icon + */ this.pinnedPanelPopoutIcon = document.querySelector("#cpanel-pinned-popout-icon"); + + /** + * Pinned Panel Close Icon + */ this.pinnedPanelCloseIcon = document.querySelector("#cpanel-pinned-close-icon"); this.setupInput(); } + /** + * Defines input-related event listeners + */ setupInput(){ this.activePanelCloseIcon.addEventListener("click", this.hideActivePanel.bind(this)); this.activePanelPinIcon.addEventListener("click", this.pinPanel.bind(this)); @@ -56,6 +131,11 @@ class cPanel{ this.pinnedPanelPopoutIcon.addEventListener("click", this.popPinnedPanel.bind(this)); } + /** + * Sets Active Panel + * @param {panelObj} panel - Panel Object to set as active + * @param {String} panelBody - innerHTML of Panel, pulls from panelObj.getPage() if empty + */ async setActivePanel(panel, panelBody){ //Set active panel this.activePanel = panel; @@ -73,6 +153,11 @@ class cPanel{ this.activePanel.docSwitch(); } + /** + * Hides active panel + * @param {Event} event - Event passed down from Input Handler + * @param {Boolean} keepAlive - Prevents closing panel if true + */ hideActivePanel(event, keepAlive = false){ if(!keepAlive){ this.activePanel.closer(); @@ -86,16 +171,27 @@ class cPanel{ this.activePanel = null; } + /** + * Pins active panel + */ pinPanel(){ this.setPinnedPanel(this.activePanel, this.activePanelDoc.innerHTML); this.hideActivePanel(null, true); } + /** + * Pop's out active panel + */ popActivePanel(){ this.popPanel(this.activePanel, this.activePanelDoc.innerHTML); this.hideActivePanel(null, true); } + /** + * Sets pinned panel + * @param {panelObj} panel - Panel Object to apply to panel + * @param {String} panelBody - Raw HTML to inject into panel body, defaults to panel page if null + */ async setPinnedPanel(panel, panelBody){ //Set pinned panel this.pinnedPanel = panel; @@ -117,6 +213,11 @@ class cPanel{ this.pinnedPanelDragger.fixCutoff(); } + /** + * Hides pinned panel + * @param {Event} event - Passed down input event + * @param {Boolean} keepAlive - Prevents panel.closer() from running if true + */ hidePinnedPanel(event, keepAlive = false){ this.pinnedPanelDiv.style.display = "none"; @@ -127,16 +228,27 @@ class cPanel{ this.pinnedPanel = null; } + /** + * Sets pinned panel to active + */ unpinPanel(){ this.setActivePanel(this.pinnedPanel, this.pinnedPanelDoc.innerHTML); this.hidePinnedPanel(null, true); } + /** + * Pops pinned panel + */ popPinnedPanel(){ this.popPanel(this.pinnedPanel, this.pinnedPanelDoc.innerHTML); this.hidePinnedPanel(null, true); } + /** + * Pops a new pop-out panel + * @param {panelObj} panel - panelObj to apply to the panel + * @param {String} panelBody - Raw HTML to inject into panel body, injects panel default if left to null + */ popPanel(panel, panelBody){ var newPanel = new poppedPanel(panel, panelBody, this) @@ -145,15 +257,48 @@ class cPanel{ } +/** + * Template Class for other Classes for Objects which represent a single Canopy Panel + */ class panelObj{ + /** + * Instantiates a new Panel Object + * @param {channel} client - Parent client Management Object + * @param {String} name - Panel Name + * @param {String} pageURL - Panel Default Page URL + * @param {Document} panelDocument - Panel Document + */ constructor(client, name = "Placeholder Panel", pageURL = "/panel/placeholder", panelDocument = window.document){ + /** + * Panel Name + */ this.name = name; + + /** + * Panel Default Page URL + */ this.pageURL = pageURL; + + /** + * Panel Document + */ this.panelDocument = panelDocument; + + /** + * Current root document panel doc lives within + */ this.ownerDoc = this.panelDocument.ownerDocument == null ? this.panelDocument : this.panelDocument.ownerDocument; + + /** + * Parent Client Management object + */ this.client = client; } + /** + * Fetches panel page from the server + * @returns {String} Raw panel doc HTML + */ async getPage(){ var response = await fetch(this.pageURL,{ method: "GET", @@ -162,39 +307,84 @@ class panelObj{ return await response.text(); } + /** + * Handles Document/Panel Changes + */ docSwitch(){ //Set owner doc this.ownerDoc = this.panelDocument.ownerDocument == null ? this.panelDocument : this.panelDocument.ownerDocument; } + /** + * Called upon panel close/exit + */ closer(){ } } +/** + * Class for Objects which represent a single instance of a popped-out panel + */ class poppedPanel{ + /** + * Instantiates a new Popped Panel Object + * @param {panelObj} panel - Panel Object to apply to Popped Panel + * @param {String} panelBody - Raw HTML to inject into panel body, defaults to panel page if null + * @param {cPanel} cPanel - Parent Canopy Panel Management Object + */ constructor(panel, panelBody, cPanel){ - //Set Panel Object + /** + * Panel Object to apply to Popped Panel + */ this.panel = panel; - //Set Panel Body + + /** + * Raw HTML to inject into panel body, defaults to panel page if null + */ this.panelBody = panelBody; - //Set Window Placeholder + + /** + * Browser Window taken up by the Popped Panel + */ this.window = null; - //Element Node Placeholders + /** + * Popped Panel Container Div + */ this.pinnedPanelDiv = null; + + /** + * Popped Panel Title + */ this.pinnedPanelTitle = null; + + /** + * Popped Panel Document Div + */ this.pinnedPanelDoc = null; + + /** + * Popped Panel Close Icon + */ this.pinnedPanelCloseIcon = null; - //Functions + /** + * Parent Canopy Panel Management Object + */ this.cPanel = cPanel; + /** + * Disables this.panel.closer() calls from this.closer() + */ this.keepAlive = false; //Continue constructor asynchrnously this.asyncConstructor(); } + /** + * Continuation of constructor method for asynchronous function calls + */ async asyncConstructor(){ //Set panel body properly this.panelBody = (this.panelBody == null || this.panelBody == "") ? await this.panel.getPage() : this.panelBody; @@ -203,12 +393,18 @@ class poppedPanel{ this.popContainer(); } + /** + * Pops/Opens container window upon start + */ popContainer(){ //Set Window Object this.window = window.open("/panel/popoutContainer","",`menubar=no,height=850,width=600`); this.window.addEventListener("load", this.fillContainer.bind(this)); } + /** + * Fills container window with Popped Panel container elements + */ fillContainer(){ //Set Element Nodes this.panelDiv = this.window.document.querySelector("#cpanel-div"); @@ -231,12 +427,18 @@ class poppedPanel{ this.setupInput(); } + /** + * Defines default input-related popped-panel Event Listeners + */ setupInput(){ this.panelPopinIcon.addEventListener("click", this.unpop.bind(this)); this.panelPinIcon.addEventListener("click", this.pin.bind(this)); this.window.addEventListener("unload", this.closer.bind(this)); } + /** + * Called upon close/exit of panel + */ closer(){ if(!this.keepAlive){ this.panel.closer(); @@ -245,6 +447,9 @@ class poppedPanel{ this.cPanel.poppedPanels.splice(this.cPanel.poppedPanels.indexOf(this),1); } + /** + * Un-pops panel into active-panel slot + */ unpop(){ //Set active panel this.cPanel.setActivePanel(this.panel, this.panelDoc.innerHTML); @@ -255,6 +460,9 @@ class poppedPanel{ this.window.close(); } + /** + * Pins panel next to chat + */ pin(){ this.cPanel.setPinnedPanel(this.panel, this.panelDoc.innerHTML); diff --git a/www/js/channel/player.js b/www/js/channel/player.js index 2b7ccd1..7982f73 100644 --- a/www/js/channel/player.js +++ b/www/js/channel/player.js @@ -14,37 +14,116 @@ 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 .*/ +/** + * Class for objects which represent Canopy Player UX + */ class player{ + /** + * Instantiates a new Canopy Player object + * @param {channel} client - Parent client Management Object + */ constructor (client){ - //client obj + /** + * Parent CLient Management Object + */ this.client = client; - //booleans + /** + * Whether or not the mouse cursor is floating over player UX + */ this.onUI = false; + + /** + * Whether or not player scrub is locked to sync signal from the server + */ this.syncLock = true; - //timers + /** + * Player UX Stow-Away timer + */ this.uiTimer = setTimeout(this.toggleUI.bind(this), 1500, false); //elements + /** + * Top-Level Player Container Div + */ this.playerDiv = document.querySelector("#media-panel-div"); + + /** + * Player Element Container Div + */ this.videoContainer = document.querySelector("#media-panel-video-container") + + /** + * Page Nav-Par + */ this.navBar = document.querySelector("#navbar"); + + /** + * Auto-Hiding Player UI + */ this.uiBar = document.querySelector("#media-panel-head-div"); + + /** + * Player Title Label + */ this.title = document.querySelector("#media-panel-title-paragraph"); + + /** + * Player Show Video Icon + */ this.showVideoIcon = document.querySelector("#chat-panel-show-video-icon"); + + /** + * Player Hide Video Icon + */ this.hideVideoIcon = document.querySelector("#media-panel-div-toggle-icon"); + + /** + * Player Syncronization Icon + */ this.syncIcon = document.querySelector("#media-panel-sync-icon"); + + /** + * Player Cinema-Mode Icon + */ this.cinemaModeIcon = document.querySelector("#media-panel-cinema-mode-icon"); + + /** + * Player Filp Video Y Icon + */ this.flipYIcon = document.querySelector("#media-panel-flip-vertical-icon") + + /** + * Player Flip Video X Icon + */ this.flipXIcon = document.querySelector("#media-panel-flip-horizontal-icon") + + /** + * Player Media Reload Icon + */ this.reloadIcon = document.querySelector("#media-panel-reload-icon"); - //Numbers + /** + * Tolerance between timestamp from server and actual media before corrective seek for pre-recorded media + */ this.syncTolerance = 0.4; - //Might seem weird to keep this here instead of the HLS handler, but remember we may want to support other livestream services in the future... + + /** + * Tolerance in livestream delay before corrective seek to live. + * + * Might seem weird to keep this here instead of the HLS handler, but remember we may want to support other livestream services in the future... + */ this.streamSyncTolerance = 2; + + /** + * Forced time to wait between sync checks, heavily decreases chance of seek-banging without reducing syncornization accuracy + */ this.syncDelta = 6; + + /** + * Current Player Volume + */ this.volume = 1; //run setup functions @@ -52,6 +131,9 @@ class player{ this.defineListeners(); } + /** + * Defines Input-Related Event Listeners for the player + */ setupInput(){ //UIBar Movement Detection this.playerDiv.addEventListener("mousemove", this.popUI.bind(this)); @@ -69,6 +151,9 @@ class player{ this.reloadIcon.addEventListener("click", this.reload.bind(this)); } + /** + * Define Network-Related Event Listeners for the player + */ defineListeners(){ this.client.socket.on("start", this.start.bind(this)); this.client.socket.on("sync", this.sync.bind(this)); @@ -76,6 +161,10 @@ class player{ this.client.socket.on("updateCurrentRawFile", this.updateCurrentRawFile.bind(this)); } + /** + * Handles command from server to start media + * @param {Object} data - Media Metadata from server + */ start(data){ //If we have an active media handler if(this.mediaHandler != null){ @@ -122,6 +211,10 @@ class player{ this.mediaHandler.sync(data.timestamp); } + /** + * Handles synchronization command from server + * @param {Object} data - Syncrhonization Data from Server + */ sync(data){ if(this.mediaHandler != null){ //Get timestamp @@ -142,12 +235,18 @@ class player{ } } + /** + * Reloads the media player + */ reload(){ if(this.mediaHandler != null){ this.mediaHandler.reload(); } } + /** + * Handles End-Media Commands from the Server + */ end(){ //Call the media handler finisher this.mediaHandler.end(); @@ -159,6 +258,10 @@ class player{ this.lockSync(); } + /** + * Handles Raw-File Metadata Updates from the Server + * @param {Object} data - Updadated Raw-File link from Server + */ updateCurrentRawFile(data){ //typecheck the media handler to see if we really need to do any of this shit, if not... if(this.mediaHandler.type == 'ytEmbed'){ @@ -176,6 +279,9 @@ class player{ this.start({media: currentItem}); } + /** + * Locks player seek to synced timestamp from the server + */ lockSync(){ //Enable syncing this.syncLock = true; @@ -195,6 +301,9 @@ class player{ } } + /** + * Un-locks player seek to synced timestamp from the server + */ unlockSync(){ //Unlight the sync icon since we're no longer actively synced this.syncIcon.classList.remove('positive'); @@ -203,6 +312,9 @@ class player{ this.syncLock = false; } + /** + * Flips the video horizontally + */ flipX(){ //I'm lazy const transform = this.videoContainer.style.transform; @@ -222,6 +334,9 @@ class player{ } } + /** + * Flips the video vertically + */ flipY(){ //I'm lazy const transform = this.videoContainer.style.transform; @@ -241,6 +356,10 @@ class player{ } } + /** + * Displays UI after player-related input + * @param {Event} event - Event passed through by event handler + */ popUI(event){ this.toggleUI(true); clearTimeout(this.uiTimer); @@ -249,10 +368,18 @@ class player{ } } + /** + * Toggles UI-Bar on or off + * @param {Boolean} show - Whether or not to show the UI-Bar. Defaults to toggle if left unspecified. + */ toggleUI(show = this.uiBar.style.display == "none"){ this.uiBar.style.display = show ? "flex" : "none"; } + /** + * Toggles video on or off + * @param {Boolean} show - Whether or not to show the video player. Defaults to toggle if left unspecified + */ toggleVideo(show = !this.playerDiv.checkVisibility()){ if(show){ this.playerDiv.style.display = "flex"; @@ -266,6 +393,10 @@ class player{ this.client.chatBox.handleVideoToggle(show); } + /** + * Toggles Cinema Mode on or off + * @param {Boolean} cinema - Whether or not to enter Cinema Mode. Defaults to toggle if left unspecified + */ toggleCinemaMode(cinema = !this.navBar.checkVisibility()){ if(cinema){ this.navBar.style.display = "flex"; @@ -277,12 +408,19 @@ class player{ this.client.chatBox.resizeAspect(); } + /** + * Informs the class when the user's mouse curosr enters and leaves the UI area + * @param {Boolean} onUI - Whether or not onUI should be toggled true + */ setOnUI(onUI){ this.onUI = onUI; this.popUI(); } - //This way other classes don't need to worry about media handler + /** + * Calculates ratio of current media object + * @returns {Number} Current media aspect ratio as a single floating point number + */ getRatio(){ //If we have no media handler if(this.mediaHandler == null){ diff --git a/www/js/channel/userlist.js b/www/js/channel/userlist.js index b72c394..d25be63 100644 --- a/www/js/channel/userlist.js +++ b/www/js/channel/userlist.js @@ -14,15 +14,28 @@ 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 .*/ +/** + * Class for object containing logic behind userlist UX + */ class userList{ + /** + * Instantiates a new userList object + * @param {channel} client - Parent client mgmt object + */ constructor(client){ - //Client object + /** + * Parent Client Management object + */ this.client = client - //Click Dragger Object + /** + * Click Dragger object for handling userlist resizes + */ this.clickDragger = new canopyUXUtils.clickDragger("#chat-panel-users-drag-handle", "#chat-panel-users-div", true, this.client.chatBox.clickDragger); - //Strings + /** + * Userlist color array (Maps to css classes) + */ this.userColors = [ "userlist-color0", "userlist-color1", @@ -32,13 +45,29 @@ class userList{ "userlist-color5", "userlist-color6"]; - //Maps + /** + * Map of usernames to assigned username color + */ this.colorMap = new Map(); - //Element Nodes + /** + * users div + */ this.userDiv = document.querySelector("#chat-panel-users-div"); + + /** + * userlist div + */ this.userList = document.querySelector("#chat-panel-users-list-div"); + + /** + * user count label + */ this.userCount = document.querySelector("#chat-panel-user-count"); + + /** + * userlist toggle button + */ this.toggleIcon = document.querySelector("#chat-panel-users-toggle"); //Call setup functions @@ -46,12 +75,17 @@ class userList{ this.defineListeners(); } - //Setup functions + /** + * Defines input-related event listeners + */ setupInput(){ this.toggleIcon.addEventListener("click", ()=>{this.toggleUI()}); this.userCount.addEventListener("click", ()=>{this.toggleUI()}); } + /** + * Defines network-related event listeners + */ defineListeners(){ this.client.socket.on('userList', (data) => { this.updateList(data); @@ -62,6 +96,10 @@ class userList{ }) } + /** + * Updates UX after user list change + * @param {Array} list - Userlist data from server + */ updateList(list){ //Clear list and set user count this.userCount.textContent = list.length == 1 ? '1 User' : `${list.length} Users`; @@ -91,6 +129,11 @@ class userList{ this.clickDragger.fixCutoff(); } + /** + * Renders out a single username to the userlist + * @param {String} user - Username to render + * @param {String} flair - Flair to render as + */ renderUser(user, flair){ //Create user span