├── start.sh ├── config.json ├── SECURITY.md ├── src ├── utils │ ├── database.js │ ├── utils.js │ └── table.js ├── commands │ ├── list.js │ ├── delete.js │ ├── deploy.js │ ├── info.js │ └── create.js ├── error.js ├── server │ ├── public │ │ ├── index.html │ │ └── 404.html │ └── index.js └── index.js ├── .github ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── workflows │ └── codeql-analysis.yml └── CODE_OF_CONDUCT.md ├── package.json ├── example └── database.js ├── README.md └── LICENSE /start.sh: -------------------------------------------------------------------------------- 1 | echo Installing Dependencies 2 | 3 | npm install 4 | 5 | echo Starting... 6 | 7 | npm start 8 | -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "token": "Discord Bot Token", 3 | "owner_id": "UserID", 4 | "prefix": "Discord Bot Prefix", 5 | "database_uri": "Database_URI", 6 | "debug": "Debug Logs", 7 | "PORT": "Port To Listen" 8 | } 9 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | | Version | Supported | 6 | | ------- | ------------------ | 7 | | 1.0.0^ | :white_check_mark: | 8 | | 1.0.1^ | :white_check_mark: | 9 | 10 | ## Reporting a Vulnerability 11 | 12 | 1. Create An [Issue](./issue/new) 13 | 2. Describe The Vulnerability 14 | -------------------------------------------------------------------------------- /src/utils/database.js: -------------------------------------------------------------------------------- 1 | class Database { 2 | 3 | constructor(data) { 4 | 5 | } 6 | 7 | get() { 8 | 9 | } 10 | 11 | set(name, value) { 12 | 13 | } 14 | 15 | delete(name) { 16 | 17 | } 18 | 19 | list() { 20 | 21 | } 22 | } 23 | 24 | module.exports = Database; 25 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing To [Shortem](https://github.com/BotStudios/shortem) 2 | 3 | Make sure to run your code and see if its working before making a pull request. 4 | 5 | ## Steps 6 | 1. Fork This Repository 7 | 2. Make Some Changes ( You Can Only Contribute Javascript Codes ) 8 | 3. Run Your Code, See If Its Working 9 | 4. Make A Pull Request ! 10 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Shortem", 3 | "version": "1.0.1", 4 | "description": "", 5 | "license": "GPL-3.0", 6 | "main": "src/index.js", 7 | "scripts": { 8 | "start": "node src/index.js", 9 | "test": "echo \"Error: no test specified\" && exit 1" 10 | }, 11 | "repository": { 12 | "type": "git", 13 | "url": "https://github.com/BotStudios/shortem" 14 | }, 15 | "dependencies": { 16 | "@discordjs/rest": "^0.1.0-canary.0", 17 | "discord-api-types": "^0.24.0", 18 | "discord.js": "^13.3.0", 19 | "dotenv": "^10.0.0", 20 | "express": "^4.17.1", 21 | "helmet": "^4.6.0", 22 | "joi": "^17.4.2" 23 | }, 24 | "engines": { 25 | "node": ">=16.2.0" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/commands/list.js: -------------------------------------------------------------------------------- 1 | const { MessageAttachment } = require('discord.js'); 2 | const Table = require('./../utils/table.js'); 3 | module.exports = { 4 | name: 'list', 5 | async execute(msg, db) { 6 | const data = await db.list(); 7 | if(!data[0])return await msg.reply({ embeds: [{ description: 'Database Was Empty', color: '#e83838' }], ephemeral: true }); 8 | 9 | var table = new Table({ 10 | head: ['Slug', 'URL'], 11 | borders: true 12 | }); 13 | for(i in data){ 14 | table.push({ 15 | [`${data[i]}`]: `${await db.get(data[i])}`, 16 | }); 17 | } 18 | 19 | 20 | await msg.reply({ files: [new MessageAttachment(Buffer.from(`${table.toString()}`, 'utf-8'), 'list.txt')]}) 21 | }, 22 | }; 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Node.js Version** 27 | - Version [e.g. 16.6.0] 28 | 29 | **Additional context** 30 | Add any other context about the problem here. 31 | -------------------------------------------------------------------------------- /src/error.js: -------------------------------------------------------------------------------- 1 | const config = require('./config.json'); 2 | const Database = require('./utils/database.js'); 3 | const database = new Database(); 4 | require('dotenv').config(); 5 | 6 | 7 | if(!config.token && !process.env.token)throw new Error("Please Provide A Token"); 8 | if(!config.prefix && !process.env.prefix)throw new Error("Please Provide A Prefix"); 9 | if(!config.owner_id && !process.env.owner_id)throw new Error("Please Provide An Owner ID"); 10 | if(!config.PORT && !process.env.PORT)throw new Error("Please Provide A Port To Listen"); 11 | 12 | (async () => { 13 | if(!Array.isArray(await database.list()))throw new Error("Please Specify Database Methods\nExample : https://github.com/BotStudios/shortem/tree/main/example") 14 | })() 15 | -------------------------------------------------------------------------------- /src/commands/delete.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: 'delete', 3 | async execute(msg, db) { 4 | var slug = msg.options.getString('slug'); 5 | 6 | if(!slug)return await msg.reply({ embeds: [{ description: 'Something Went Wrong', color: '#e83838' }], ephemeral: true }); 7 | 8 | const data = await db.get(slug); 9 | if(!data)return await msg.reply({ embeds: [{ description: 'Slug Does Not Exist', color: '#e83838' }], ephemeral: true }); 10 | 11 | await db.delete(slug).then(async () => { 12 | await msg.reply({ 13 | embeds: [{ 14 | title: 'Deleted !', 15 | description: `**Slug:** \`${slug}\`\n**URL:** \`${data}\``, 16 | color: '#03fc2c' 17 | }] 18 | }) 19 | }) 20 | }, 21 | }; 22 | -------------------------------------------------------------------------------- /src/server/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Shortem 7 | 39 | 40 | 41 |

Shortem

42 |
43 |

View Source : Github

44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /src/server/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Shortem - 404 7 | 39 | 40 | 41 |

404 Not Found

42 |
43 |

View Source : Github

44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /src/server/index.js: -------------------------------------------------------------------------------- 1 | const express = require('express'); 2 | const app = express(); 3 | const path = require('path'); 4 | const helmet = require('helmet'); 5 | const db = require('./../utils/utils.js').db; 6 | const config = require('./../config.json'); 7 | const notFoundPath = path.join(__dirname, 'public/404.html'); 8 | 9 | app.enable('trust proxy'); 10 | 11 | app.use(helmet()); // Add On Some Headers 12 | app.use(express.json()); // Return JSON Data 13 | app.use(express.static('./public')); 14 | 15 | 16 | /*app.get('/', async (req,res) => { 17 | Use HTML 18 | Or redirect : 19 | res.redirect('https://github.com/BotStudios/shortem') 20 | })*/ 21 | 22 | app.get('/:id', async (req,res) => { 23 | const slug = req.params.id; 24 | try { 25 | var url = await db.get(slug); 26 | if (url) { 27 | return res.redirect(`${url}`); 28 | } 29 | return res.status(404).sendFile(notFoundPath); 30 | } catch (error) { 31 | return res.status(404).sendFile(notFoundPath); 32 | } 33 | }) 34 | 35 | app.use((req, res, next) => { 36 | res.status(404).sendFile(notFoundPath); 37 | }); 38 | 39 | 40 | app.listen(config.token || process.env.PORT) 41 | 42 | -------------------------------------------------------------------------------- /src/utils/utils.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * Shortem 3 | * (c) 2021 Joe Lee 4 | * Released under the Apache-2.0 License. 5 | * https://github.com/BotStudios/shortem 6 | */ 7 | const Database = require('./database.js'); 8 | const db = new Database(); 9 | 10 | exports.repeat = function (str, times) { 11 | return Array(times + 1).join(str) 12 | } 13 | 14 | exports.truncate = function (str, length, chr) { 15 | chr = chr || '…' 16 | return str.length >= length ? str.substr(0, length - chr.length) + chr : str 17 | } 18 | 19 | function options (defaults, opts) { 20 | for (var p in opts) { 21 | if (opts[p] && opts[p].constructor && opts[p].constructor === Object) { 22 | defaults[p] = defaults[p] || {} 23 | options(defaults[p], opts[p]) 24 | } else { 25 | defaults[p] = opts[p] 26 | } 27 | } 28 | 29 | return defaults 30 | }; 31 | 32 | exports.strlen = function (str) { 33 | var code = /\u001b\[(?:\d*;){0,5}\d*m/g 34 | var stripped = ('' + (str != null ? str : '')).replace(code, '') 35 | var split = stripped.split('\n') 36 | return split.reduce(function (memo, s) { return (s.length > memo) ? s.length : memo }, 0) 37 | } 38 | 39 | 40 | exports.options = options 41 | exports.db = db 42 | 43 | -------------------------------------------------------------------------------- /example/database.js: -------------------------------------------------------------------------------- 1 | const monk = require('monk'); 2 | const urls = monk(MONGODB_URI); 3 | const db = urls.get('shortem') 4 | db.createIndex({ slug: 1 }, { unique: true }); 5 | 6 | // MongoDB 7 | class mongoDatabase { 8 | 9 | constructor(data) { 10 | 11 | } 12 | 13 | async get(name) { 14 | var data = await db.findOne({ slug: name }); 15 | if(data){ 16 | return data.url; 17 | } 18 | } 19 | 20 | async set(name, value) { 21 | return await db.insert({ 22 | url: value, 23 | slug: name 24 | }); 25 | } 26 | 27 | async delete(name) { 28 | return await db.remove({ 29 | slug: name 30 | }); 31 | } 32 | 33 | async list() { 34 | var data = await db.find({ }); 35 | var list = []; 36 | for(var i of data){ 37 | list.push( 38 | `${i.slug}` 39 | ) 40 | } 41 | return list; 42 | } 43 | } 44 | 45 | // Replit Database 46 | /* 47 | const Database = require('@replit/database'); 48 | const db = new Database(); 49 | 50 | class replitDatabase { 51 | 52 | constructor(data) { 53 | 54 | } 55 | 56 | async get(name) { 57 | return await db.get(name); 58 | } 59 | 60 | async set(name, value) { 61 | return await db.set(name, value); 62 | } 63 | 64 | async delete(name) { 65 | return await db.delete(name) 66 | } 67 | 68 | async list() { 69 | return await db.list() 70 | } 71 | } 72 | */ 73 | 74 | module.exports = mongoDatabase; 75 | -------------------------------------------------------------------------------- /src/commands/deploy.js: -------------------------------------------------------------------------------- 1 | const { SlashCommandBuilder } = require('@discordjs/builders') 2 | , { REST } = require('@discordjs/rest') 3 | , { Routes } = require('discord-api-types/v9'); 4 | require('dotenv').config(); 5 | 6 | const deploy = (client, message, config) => { 7 | if(message.author.id != config.owner_id || message.author.id != process.env.owner_id)return; 8 | const commands = [ 9 | new SlashCommandBuilder().setName('create').setDescription('Create A Slug').addStringOption(option => option.setName('slug').setDescription('Enter A Slug').setRequired(true)).addStringOption(option => option.setName('url').setDescription('Enter A URL').setRequired(true)), 10 | 11 | new SlashCommandBuilder().setName('delete').setDescription('Delete A Slug').addStringOption(option => option.setName('slug').setDescription('Enter A Slug To Delete').setRequired(true)), 12 | 13 | new SlashCommandBuilder().setName('info').setDescription('Get Information Of A Slug').addStringOption(option => option.setName('slug').setDescription('Enter A Slug')).addStringOption(option => option.setName('url').setDescription('Enter A Url')), 14 | 15 | new SlashCommandBuilder().setName('list').setDescription('Get A List Of Slugs') 16 | ] 17 | .map(command => command.toJSON()); 18 | 19 | const rest = new REST({ version: '9' }).setToken(config.token || process.env.token); 20 | 21 | rest.put(Routes.applicationCommands(client.user.id), { body: commands }) 22 | .then(() => console.log('Successfully registered application commands.')) 23 | .catch(console.error); 24 | 25 | } 26 | 27 | module.exports = deploy; 28 | -------------------------------------------------------------------------------- /src/commands/info.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: 'info', 3 | execute: async (msg, db) => { 4 | var url = msg.options.getString('url'); 5 | var slug = msg.options.getString('slug'); 6 | 7 | if(!url && !slug)return await msg.reply({ embeds: [{ description: 'Please Provide A URL Or Slug', color: '#e83838' }], ephemeral: true }); 8 | 9 | if(slug){ 10 | var data = await db.get(slug); 11 | if(!data)return await msg.reply({ embeds: [{ description: 'This Slug Does Not Exist', color: '#e83838' }], ephemeral: true }); 12 | 13 | await msg.reply({ 14 | embeds: [{ 15 | description: `**Slug:** \`${slug}\`\n**URL:** \`${data}\``, 16 | color: '#03fc2c' 17 | }] 18 | }) 19 | }else { 20 | var data = await db.list(); 21 | if(!data[0])return await msg.reply({ embeds: [{ description: 'Database Was Empty', color: '#e83838' }], ephemeral: true }); 22 | 23 | var list = []; 24 | for(i in data){ 25 | list.push({ 26 | [`${await db.get(data[i])}`]: `${data[i]}` 27 | }) 28 | } 29 | 30 | var find = list.find(e => e[`${url}`]); 31 | for(i in find){ 32 | slug = find[i] 33 | } 34 | if(slug){ 35 | await msg.reply({ 36 | embeds: [{ 37 | description: `**Slug:** \`${slug}\`\n**URL:** \`${url}\``, 38 | color: '#03fc2c' 39 | }] 40 | }) 41 | }else { 42 | await msg.reply({ embeds: [{ description: 'This URL Does Not Exist', color: '#e83838' }], ephemeral: true }); 43 | } 44 | } 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/commands/create.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: 'create', 3 | async execute(msg, db, Joi) { 4 | var slug = msg.options.getString('slug'); 5 | var url = msg.options.getString('url'); 6 | 7 | if(!slug || !url)return await msg.reply({ embeds: [{ description: 'Something Went Wrong', color: '#e83838' }], ephemeral: true }); 8 | 9 | if(!url.startsWith('https://') && !url.startsWith('http://')){ 10 | return await msg.reply({ embeds: [{ description: 'Please Provide A Protocol', color: '#e83838' }], ephemeral: true }); 11 | } 12 | if(url.startsWith('https://') || url.startsWith('http://')){ 13 | url = url.substring(url.indexOf("/")+2); 14 | } 15 | 16 | if(url.includes('/')){ 17 | url = url.split('/')[0]; 18 | } 19 | 20 | const data = await db.get(slug); 21 | if(data)return await msg.reply({ embeds: [{ description: 'Slug Exist', color: '#e83838' }], ephemeral: true }); 22 | 23 | const schema = Joi.object({ 24 | url: Joi.string().domain({ tlds: true }).required(), 25 | slug: Joi.string().pattern(/^[\w\-]+$/i).required() 26 | }); 27 | try{ 28 | await schema.validateAsync({ 29 | url: url, 30 | slug: slug 31 | }); 32 | }catch(e){ 33 | return msg.reply({ embeds: [{ description: 'Please Provide A Valid URL & Slug', color: '#e83838' }], ephemeral: true }); 34 | } 35 | await db.set(slug, msg.options.getString('url')).then(async () => { 36 | await msg.reply({ 37 | embeds: [{ 38 | title: 'Success !', 39 | description: `**Slug:** \`${slug}\`\n**URL:** \`${msg.options.getString('url')}\``, 40 | color: '#03fc2c' 41 | }] 42 | }) 43 | }) 44 | }, 45 | }; 46 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Shortem 2 | A URL Shortener That Allow Users To Interact With Its API Through A Discord Bot 3 | 4 | ## About 5 | - Supports Multiple [Databases](./example/database.js) 6 | - Performant 7 | - Uses [discord.js](https://github.com/discordjs/discord.js) v13 8 | - Uses Slash Commands 9 | - Validates URL 10 | - Customizable, Using Command Handling Method 11 | 12 | ## Commands/API 13 | - `/create ` - Create A Slug 14 | - `/delete ` - Delete A Slug 15 | - `/list` - A List Of Available Slugs 16 | - `/info ` - View Slug's Information 17 | - `deploy` - Deploy Slash Commands ( Owner ) 18 | 19 | ## Requirements 20 | - Node.js 16.2.0^ ( see why : [here](https://github.com/BotStudios/shortem/wiki/node.js-16.2.0%5E-is-required,-why-%3F) ) 21 | - Install All Required Dependencies 22 | 23 | ## Setup 24 | 1. Clone This Repository ( By `git clone` Or [`create-shortem-app`](https://npmjs.com/create-shortem-app) ) 25 | 2. Edit The [Config File](./config.json) 26 | 3. Run The Bot `npm start` / `node src/index.js` 27 | 28 | ## Credits 29 | **Code** 30 | 31 | - Inspired by [CodingGarden/miniature-umbrella](https://github.com/CodingGarden/miniature-umbrella) 32 | - Using some of [Todo Bot](https://discord.com/oauth2/authorize?client_id=824842524441968640&scope=bot&permissions=523328)'s concept 33 | 34 | **Dependencies** 35 | 36 | [discord.js](https://npmjs.com/discord.js), [@discordjs/rest](https://npmjs.com/@discordjs/rest), [discord-api-types](https://npmjs.com/discord-api-types), [dotenv](https://npmjs.com/dotenv), [express](https://npmjs.com/express), [helmet](https://npmjs.com/helmet), [joi](https://npmjs.com/joi) 37 | 38 | **Contributors** 39 | 40 | [@joeleeofficial](https://github.com/joeleeofficial), [@leecheeyong](https://github.com/leecheeyong) 41 | 42 | ## License 43 | This project is available as open source under the terms of the [GPL-3.0 License](./LICENSE) 44 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | # The branches below must be a subset of the branches above 8 | branches: [ main ] 9 | schedule: 10 | - cron: '25 12 * * 6' 11 | 12 | jobs: 13 | analyze: 14 | name: Analyze 15 | runs-on: ubuntu-latest 16 | permissions: 17 | actions: read 18 | contents: read 19 | security-events: write 20 | 21 | strategy: 22 | fail-fast: false 23 | matrix: 24 | language: [ 'javascript' ] 25 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] 26 | # Learn more: 27 | # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed 28 | 29 | steps: 30 | - name: Checkout repository 31 | uses: actions/checkout@v2 32 | 33 | # Initializes the CodeQL tools for scanning. 34 | - name: Initialize CodeQL 35 | uses: github/codeql-action/init@v1 36 | with: 37 | languages: ${{ matrix.language }} 38 | # If you wish to specify custom queries, you can do so here or in a config file. 39 | # By default, queries listed here will override any specified in a config file. 40 | # Prefix the list here with "+" to use these queries and those in the config file. 41 | # queries: ./path/to/local/query, your-org/your-repo/queries@main 42 | 43 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 44 | # If this step fails, then you should remove it and run the build manually (see below) 45 | - name: Autobuild 46 | uses: github/codeql-action/autobuild@v1 47 | 48 | # ℹ️ Command-line programs to run using the OS shell. 49 | # 📚 https://git.io/JvXDl 50 | 51 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 52 | # and modify them (or add more) to build your code if your project 53 | # uses a compiled language 54 | 55 | #- run: | 56 | # make bootstrap 57 | # make release 58 | 59 | - name: Perform CodeQL Analysis 60 | uses: github/codeql-action/analyze@v1 61 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * Shortem v2.6.14 3 | * (c) 2021 Joe Lee 4 | * Released under the Apache License. 5 | * https://github.com/BotStudios/shortem 6 | */ 7 | const { Client, Intents, Collection } = require('discord.js') 8 | , client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] }) 9 | , { db } = require('./utils/utils.js') 10 | , Joi = require('joi') 11 | , fs = require('fs') 12 | , deploy = require('./commands/deploy.js') 13 | , config = require('./../config.json') 14 | , commandFiles = fs.readdirSync('./commands').filter(file => file.endsWith('.js')); 15 | client.commands = new Collection(); 16 | require('./error.js'); 17 | require('dotenv').config(); 18 | require('./server'); 19 | 20 | 21 | client.once('ready', () => { 22 | console.log(client.user.tag); 23 | 24 | for (const file of commandFiles) { 25 | if(file != 'deploy.js'){ 26 | const command = require(`./commands/${file}`); 27 | client.commands.set(command.name, command, config); 28 | } 29 | } 30 | }) 31 | 32 | 33 | client.on('messageCreate', async message => { 34 | var prefix = config.prefix || process.env.prefix; 35 | if (!message.content.startsWith(prefix) || message.author.bot) return; 36 | const args = message.content.slice(prefix.length).trim().split(' '); 37 | const command = args.shift().toLowerCase(); 38 | if(command == "deploy"){ 39 | deploy(client, message, config); 40 | } 41 | 42 | }) 43 | 44 | 45 | client.on('interactionCreate', async interaction => { 46 | if (!interaction.isCommand()) return; 47 | const command = client.commands.get(interaction.commandName); 48 | if (!command) return; 49 | try { 50 | await command.execute(interaction, db, Joi); 51 | } catch (error) { 52 | console.error(error); 53 | await interaction.reply({ embeds: [{ description: 'Something Went Wrong', color: '#e83838' }], ephemeral: true }); 54 | } 55 | }); 56 | 57 | 58 | /* 59 | client.on('interactionCreate', async message => { 60 | if(!interaction.isCommand()) return; 61 | try{ 62 | var content = message.commandName; 63 | switch(content){ 64 | case "create": 65 | create(message, db); 66 | break; 67 | 68 | case "delete": 69 | del(message, db); 70 | break; 71 | 72 | case "info": 73 | info(message, db); 74 | break; 75 | 76 | case "list": 77 | list(message, db); 78 | break; 79 | 80 | default: 81 | await message.reply('This Command Does Not Exist !'); 82 | } 83 | }catch(e){ 84 | console.error(e) 85 | } 86 | })*/ 87 | if(config.debug){ 88 | client.on('error', (err) => console.log(err)); 89 | client.on('debug', (err) => console.log(err)); 90 | } 91 | client.login(config.token || process.env.token) 92 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | tojoeleeofficial@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /src/utils/table.js: -------------------------------------------------------------------------------- 1 | var utils = require('./utils.js') 2 | var repeat = utils.repeat 3 | var truncate = utils.truncate 4 | 5 | 6 | function Table (options) { 7 | this.options = utils.options({ 8 | chars: { 9 | 'top': '─', 10 | 'top-mid': '┬', 11 | 'top-left': '┌', 12 | 'top-right': '┐', 13 | 'bottom': '─', 14 | 'bottom-mid': '┴', 15 | 'bottom-left': '└', 16 | 'bottom-right': '┘', 17 | 'left': '│', 18 | 'left-mid': '├', 19 | 'mid': '─', 20 | 'mid-mid': '┼', 21 | 'right': '│', 22 | 'right-mid': '┤', 23 | 'middle': '│' 24 | }, 25 | truncate: '…', 26 | colWidths: [], 27 | colAligns: [], 28 | style: { 29 | 'padding-left': 1, 30 | 'padding-right': 1, 31 | head: ['red'], 32 | border: ['grey'], 33 | compact: false 34 | }, 35 | head: [] 36 | }, options) 37 | 38 | if (options.borders == false) { 39 | this.options.chars = { 40 | 'top': '', 41 | 'top-mid': '', 42 | 'top-left': '', 43 | 'top-right': '', 44 | 'bottom': '', 45 | 'bottom-mid': '', 46 | 'bottom-left': '', 47 | 'bottom-right': '', 48 | 'left': '', 49 | 'left-mid': '', 50 | 'mid': '', 51 | 'mid-mid': '', 52 | 'right': '', 53 | 'right-mid': '', 54 | 'middle': '' 55 | } 56 | } 57 | }; 58 | 59 | Table.prototype = new Array 60 | 61 | Table.prototype.__defineGetter__('width', function () { 62 | var str = this.toString().split('\n') 63 | if (str.length) return str[0].length 64 | return 0 65 | }) 66 | 67 | Table.prototype.render = 68 | Table.prototype.toString = function () { 69 | var ret = '' 70 | var options = this.options 71 | var style = options.style 72 | var head = options.head 73 | var chars = options.chars 74 | var truncater = options.truncate 75 | var colWidths = options.colWidths || new Array(this.head.length) 76 | var totalWidth = 0 77 | 78 | if (!head.length && !this.length) return '' 79 | 80 | if (!colWidths.length) { 81 | var everyRows = this.slice(0) 82 | if (head.length) { everyRows = everyRows.concat([head]) }; 83 | 84 | everyRows.forEach(function (cells) { 85 | if (Array.isArray(cells) && cells.length) { 86 | extractColumnWidths(cells) 87 | 88 | } else { 89 | var headerCell = Object.keys(cells)[0] 90 | var valueCell = cells[headerCell] 91 | 92 | colWidths[0] = Math.max(colWidths[0] || 0, getWidth(headerCell) || 0) 93 | 94 | if (Array.isArray(valueCell) && valueCell.length) { 95 | extractColumnWidths(valueCell, 1) 96 | } else { 97 | colWidths[1] = Math.max(colWidths[1] || 0, getWidth(valueCell) || 0) 98 | } 99 | } 100 | }) 101 | }; 102 | 103 | totalWidth = (colWidths.length === 1 ? colWidths[0] : colWidths.reduce( 104 | function (a, b) { 105 | return a + b 106 | })) + colWidths.length + 1 107 | 108 | function extractColumnWidths (arr, offset) { 109 | offset = offset || 0 110 | arr.forEach(function (cell, i) { 111 | colWidths[i + offset] = Math.max(colWidths[i + offset] || 0, getWidth(cell) || 0) 112 | }) 113 | }; 114 | 115 | function getWidth (obj) { 116 | return typeof obj === 'object' && obj && obj.width !== undefined 117 | ? obj.width 118 | : ((typeof obj === 'object' && obj !== null ? utils.strlen(obj.text) : utils.strlen(obj)) + (style['padding-left'] || 0) + (style['padding-right'] || 0)) 119 | } 120 | 121 | function line (line, left, right, intersection) { 122 | var width = 0 123 | line = left + repeat(line, totalWidth - 2) + right 124 | 125 | colWidths.forEach(function (w, i) { 126 | if (i === colWidths.length - 1) return 127 | width += w + 1 128 | line = line.substr(0, width) + intersection + line.substr(width + 1) 129 | }) 130 | 131 | return applyStyles(options.style.border, line) 132 | }; 133 | 134 | function lineTop () { 135 | var l = line(chars.top, 136 | chars['top-left'] || chars.top, 137 | chars['top-right'] || chars.top, 138 | chars['top-mid']) 139 | if (l) { 140 | ret += l + '\n' 141 | } 142 | }; 143 | 144 | function generateRow (items, style) { 145 | var cells = [] 146 | var maxHeight = 0 147 | 148 | if (!Array.isArray(items) && typeof items === 'object') { 149 | var key = Object.keys(items)[0] 150 | var value = items[key] 151 | var firstCellHead = true 152 | 153 | if (Array.isArray(value)) { 154 | items = value 155 | items.unshift(key) 156 | } else { 157 | items = [key, value] 158 | } 159 | } 160 | 161 | items.forEach(function (item, i) { 162 | var contents = (item === null || item === undefined ? '' : item).toString().split('\n').reduce(function (memo, l) { 163 | memo.push(string(l, i)) 164 | return memo 165 | }, []) 166 | 167 | var height = contents.length 168 | if (height > maxHeight) { maxHeight = height }; 169 | 170 | cells.push({ contents: contents, height: height }) 171 | }) 172 | 173 | var lines = new Array(maxHeight) 174 | cells.forEach(function (cell, i) { 175 | cell.contents.forEach(function (line, j) { 176 | if (!lines[j]) { lines[j] = [] }; 177 | if (style || (firstCellHead && i === 0 && options.style.head)) { 178 | line = applyStyles(options.style.head, line) 179 | } 180 | 181 | lines[j].push(line) 182 | }) 183 | 184 | for (var j = cell.height, l = maxHeight; j < l; j++) { 185 | if (!lines[j]) { lines[j] = [] }; 186 | lines[j].push(string('', i)) 187 | } 188 | }) 189 | 190 | var ret = '' 191 | lines.forEach(function (line, index) { 192 | if (ret.length > 0) { 193 | ret += '\n' + applyStyles(options.style.border, chars.left) 194 | } 195 | 196 | ret += line.join(applyStyles(options.style.border, chars.middle)) + applyStyles(options.style.border, chars.right) 197 | }) 198 | 199 | return applyStyles(options.style.border, chars.left) + ret 200 | }; 201 | 202 | function applyStyles (styles, subject) { 203 | if (!subject) { 204 | return '' 205 | } 206 | 207 | styles.forEach(function (style) { 208 | subject = subject 209 | }) 210 | 211 | return subject 212 | }; 213 | 214 | function string (str, index) { 215 | str = String(typeof str === 'object' && str.text ? str.text : str) 216 | var length = utils.strlen(str) 217 | var width = colWidths[index] - (style['padding-left'] || 0) - (style['padding-right'] || 0) 218 | var align = options.colAligns[index] || 'left' 219 | 220 | return repeat(' ', style['padding-left'] || 0) + 221 | (length === width ? str 222 | : (length < width 223 | ? str.padEnd((width + (str.length - length)), ' ', align === 'left' ? 'right' 224 | : (align === 'middle' ? 'both' : 'left')) 225 | : (truncater ? truncate(str, width, truncater) : str)) 226 | ) + 227 | repeat(' ', style['padding-right'] || 0) 228 | }; 229 | 230 | if (head.length) { 231 | lineTop() 232 | 233 | ret += generateRow(head, style.head) + '\n' 234 | } 235 | 236 | if (this.length) { 237 | this.forEach(function (cells, i) { 238 | if (!head.length && i === 0) { lineTop() } else { 239 | if (!style.compact || i < (!!head.length) ? 1 : 0 || cells.length === 0) { 240 | var l = line(chars.mid 241 | , chars['left-mid'] 242 | , chars['right-mid'] 243 | , chars['mid-mid']) 244 | if (l) { ret += l + '\n' } 245 | } 246 | } 247 | 248 | if (Array.isArray(cells) && !cells.length) { 249 | return 250 | } else { 251 | ret += generateRow(cells) + '\n' 252 | }; 253 | }) 254 | } 255 | 256 | var l = line(chars.bottom, 257 | chars['bottom-left'] || chars.bottom, 258 | chars['bottom-right'] || chars.bottom, 259 | chars['bottom-mid']) 260 | if (l) { 261 | ret += l 262 | } else { 263 | 264 | ret = ret.slice(0, -1) 265 | } 266 | 267 | return ret 268 | } 269 | 270 | module.exports = Table 271 | 272 | module.exports.version = '2.0.0' 273 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Shortem Copyright (C) 2021-2022 Lee Chee Yong 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------