├── CNAME ├── _config.yml ├── .gitignore ├── bot ├── utils │ ├── index.js │ ├── imageUtils.js │ └── stringUtils.js ├── libs │ ├── index.js │ ├── logger.js │ ├── post.js │ ├── userAccount.js │ ├── redditSnooper.js │ ├── image.js │ └── setup.js ├── package.json └── beepboop.js ├── README.md ├── CONTRIBUTING.md └── LICENSE /CNAME: -------------------------------------------------------------------------------- 1 | xavierteo.dev -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /bot/node_modules 2 | /bot/cookies/gitgagged.json 3 | /bot/assets/images/* 4 | /bot/configs/config.json 5 | /bot/cookies/ 6 | /bot/configs/ 7 | /bot/eng.traineddata 8 | /bot/test.js 9 | /bot/logs/* 10 | .DS_Store 11 | *.log 12 | -------------------------------------------------------------------------------- /bot/utils/index.js: -------------------------------------------------------------------------------- 1 | //-- Import all utils --// 2 | const imageUtils = require("./imageUtils"); 3 | const stringUtils = require("./stringUtils"); 4 | 5 | //-- Export them as one object --// 6 | module.exports = { 7 | ...imageUtils, 8 | ...stringUtils, 9 | }; 10 | -------------------------------------------------------------------------------- /bot/libs/index.js: -------------------------------------------------------------------------------- 1 | //-- Import all libs --// 2 | const setup = require("./setup"); 3 | const image = require("./image"); 4 | const post = require("./post"); 5 | const userAccount = require("./userAccount"); 6 | const redditSnooper = require("./redditSnooper"); 7 | 8 | //-- Export them as one object --// 9 | module.exports = { 10 | ...setup, 11 | ...image, 12 | ...post, 13 | ...userAccount, 14 | ...redditSnooper 15 | }; 16 | -------------------------------------------------------------------------------- /bot/utils/imageUtils.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const path = require("path"); 3 | 4 | //-- Functions --// 5 | /** 6 | * Checks a url to determine whether or not it points to an image 7 | * @param {string} url The url to check 8 | * @returns Whether or the url points to an image 9 | */ 10 | function isImage(url) { 11 | //Defines accepted image extensions 12 | const imageExts = [".png", ".jpg", ".jpeg"]; 13 | 14 | //Derives the extension of the file (if any) from the url 15 | const extension = path.extname(url); 16 | 17 | //Determines whether or not the url leads to an image and returns the result 18 | return imageExts.includes(extension); 19 | } 20 | 21 | module.exports = { 22 | isImage 23 | }; 24 | -------------------------------------------------------------------------------- /bot/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "reddits-nightmare", 3 | "version": "2.0.0", 4 | "description": "A bot that reuploads popular posts from subreddits onto Instagram", 5 | "main": "beepboop.js", 6 | "scripts": { 7 | "start": "node beepboop.js" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/Garlicvideos/reddits-nightmare.git" 12 | }, 13 | "keywords": [ 14 | "reddit", 15 | "bot", 16 | "instagram", 17 | "repost" 18 | ], 19 | "author": "Garlicvideos", 20 | "license": "GPL-3.0-or-later", 21 | "bugs": { 22 | "url": "https://github.com/Garlicvideos/reddits-nightmare/issues" 23 | }, 24 | "homepage": "https://github.com/Garlicvideos/reddits-nightmare#readme", 25 | "dependencies": { 26 | "cli-progress": "^3.11.2", 27 | "fs": "0.0.1-security", 28 | "instagram-private-api": "^1.46.1", 29 | "path": "^0.12.7", 30 | "readline": "^1.3.0", 31 | "reddit-snooper": "github:Axiver/reddit-snooper", 32 | "request": "^2.88.0", 33 | "sharp": "^0.34.1", 34 | "tesseract.js": "^6.0.1", 35 | "winston": "^3.8.2", 36 | "wordpos": "^2.0.0" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /bot/libs/logger.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const { createLogger, format, transports } = require('winston'); 3 | const { combine, timestamp, label, printf } = format; 4 | 5 | //Import utility functions and libs 6 | const { capitalizeFirstLetter: capitalFirst } = require("../utils/stringUtils"); 7 | 8 | //-- Create Winston logger --// 9 | //Create the logging format 10 | const customFormat = printf(({ level, message, label = "General", timestamp }) => { 11 | //Format the timestamp 12 | timestamp = new Date(timestamp).toLocaleString(); 13 | 14 | //Return the logging format 15 | return `[${timestamp}] [${label}] ${level}: ${message}`; 16 | }); 17 | 18 | /** 19 | * Creates a logger format 20 | * @param {string} loggerName The name of the logger 21 | * @param {boolean} enableColor Whether or not to enable colors 22 | * @returns A logger format object 23 | */ 24 | const loggerFormat = (loggerName, enableColor) => combine( 25 | label({ label: loggerName }), 26 | timestamp(), 27 | //Make the first letter of every logger level uppercase 28 | format(logLevel => { 29 | logLevel.level = capitalFirst(logLevel.level); 30 | return logLevel; 31 | })(), 32 | //Dynamically adds support for colors 33 | ...(enableColor ? [format.colorize(), customFormat]: [customFormat]), 34 | ); 35 | 36 | /** 37 | * Creates a new winston logger instance 38 | * @param {string} loggerName The name of the logger (Used as the label) 39 | */ 40 | function create(loggerName) { 41 | //Creates the logger 42 | const logger = createLogger({ 43 | level: 'debug', 44 | format: loggerFormat(loggerName), 45 | transports: [ 46 | /** 47 | * Logs of "Info" level and below gets printed to console 48 | * Logs of "Error" level and below gets written to the error log 49 | * Logs of "Debug" level and below gets written to the combined log 50 | */ 51 | new transports.Console({ level: "info", format: loggerFormat(loggerName, true)}), 52 | new transports.File({ filename: './logs/error.log', level: 'error' }), 53 | new transports.File({ filename: './logs/combined.log' }), 54 | /** 55 | * Log to a module-specific log file 56 | */ 57 | new transports.File({ filename: `./logs/${loggerName.toLowerCase()}.log` }), 58 | ], 59 | }); 60 | 61 | return logger; 62 | } 63 | 64 | //Export the logger instance 65 | module.exports = create; -------------------------------------------------------------------------------- /bot/utils/stringUtils.js: -------------------------------------------------------------------------------- 1 | //-- Functions --// 2 | /** 3 | * Checks if string contains an element in a array 4 | * @param {*} string The string to check 5 | * @param {*} pattern An array of strings to check for 6 | * @returns Whether or not the string contains an element in a array 7 | */ 8 | function contains(string, pattern) { 9 | //Loops through the string array 10 | for (const word of pattern) { 11 | //-- Checks if the string contains the current element --// 12 | //Construct a regular expression 13 | const regex = new RegExp(`\\b${word}\\b`, "i") 14 | 15 | //Perform the check 16 | if (string.match(regex)) { 17 | //The string contains the current element 18 | return true; 19 | } 20 | }; 21 | 22 | //The string does not contain any of the elements in the array 23 | return false; 24 | } 25 | 26 | /** 27 | * Replaces special characters in a string 28 | * @param {string} string A string to replace the special characters of 29 | * @returns A string without special characters 30 | */ 31 | function replaceSpecialChars(string) { 32 | //Define the replacement for each special character 33 | const specialCharacters = [/\?/g, /\//g, /\/g, /\"/g, /\*/g, /\\/g, /\:/g]; 34 | const replacement = ["[q]", "[s]", "[l]", "[m]", "[quo]", "[st]", "[bs]", "[col]"]; 35 | 36 | //Replace special characters into filesystem-compatible ones 37 | for (let i = 0; i < specialCharacters.length; i++) { 38 | string = string.replace(specialCharacters[i], replacement[i]); 39 | } 40 | 41 | return string; 42 | } 43 | 44 | /** 45 | * Adds special characters back to a string 46 | * @param {string} string A string to restore the special characters back to 47 | * @returns A string with its special characters restored 48 | */ 49 | function restoreSpecialCharacters(string) { 50 | //Remove file extensions from caption and add back special characters 51 | const specialCharacters = ["?", "/", "<", ">", "\"", "*", "\\", ":", "", "", ""]; 52 | const replacement = ["[q]", "[s]", "[l]", "[m]", "[quo]", "[st]", "[bs]", "[col]", ".jpg", ".jpeg", ".png"]; 53 | 54 | //Replace filesystem-compatible characters with the special characters they represent 55 | for (let i = 0; i < specialCharacters.length; i++) { 56 | string = string.replace(replacement[i], specialCharacters[i]); 57 | } 58 | 59 | return string; 60 | } 61 | 62 | /** 63 | * Capitalizes the first letter of a string 64 | * @param {string} string The string to format 65 | * @returns The formatted string 66 | */ 67 | function capitalizeFirstLetter(string) { 68 | return string[0].toUpperCase() + string.slice(1); 69 | } 70 | 71 | module.exports = { 72 | contains, 73 | replaceSpecialChars, 74 | restoreSpecialCharacters, 75 | capitalizeFirstLetter 76 | }; 77 | -------------------------------------------------------------------------------- /bot/beepboop.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const { IgApiClient } = require("instagram-private-api"); 3 | const logger = require("./libs/logger")("Instagram"); 4 | 5 | //Initialise IG API client 6 | const ig = new IgApiClient(); 7 | 8 | //Import utility functions and libs 9 | const { makeDirs, setup, login, snoopReddit, askQuestion, chooseInstaPhoto } = require("./libs/"); 10 | 11 | //-- Functions --// 12 | /** 13 | * Retrieves the configured upload frequency 14 | * @param {object} configs Config data 15 | */ 16 | function getUploadFrequency(configs) { 17 | //Retrieve upload frequency from configs 18 | const frequency = configs["frequency"]; 19 | 20 | //Check if a valid upload frequency is configured 21 | if (Number.isNaN(frequency)) { 22 | //Invalid frequency configured 23 | logger.warn("Invalid upload frequency configured, defaulting to once every 25 mins"); 24 | return 1.5e+6; 25 | } 26 | 27 | //Check if the upload frequency configured is less than a minute 28 | if (frequency < 60 * 1000) { 29 | //Upload frequency is too short 30 | logger.warn("Configured upload frequency is too short (must be > 1 min), defaulting to once every 25 mins"); 31 | return 1.5e+6; 32 | } 33 | 34 | return frequency; 35 | } 36 | 37 | async function start() { 38 | //-- Fail-safe checks --// 39 | //List of needed directories 40 | const directories = [ 41 | "./configs", 42 | "./cookies", 43 | "./logs", 44 | { 45 | "./assets": [ 46 | { 47 | "/images": [ 48 | "/approved", 49 | "/nsfw", 50 | "/rejected", 51 | "/uploaded", 52 | "/error", 53 | ] 54 | }, 55 | ] 56 | }, 57 | ]; 58 | 59 | //Create any required directories that do not exist 60 | await makeDirs(directories, ""); 61 | 62 | //Perform first time setup if required 63 | await setup(); 64 | 65 | //-- Login to Instagram --// 66 | //Load config file 67 | const configs = require("./configs/config.json").instagram; 68 | 69 | //Initialises the instagram password 70 | let insta_password; 71 | 72 | //Request for user's Instagram password if they did not store it in config.json 73 | if (!configs["insta_password"]) { 74 | const question = "What is the password associated with '" + configs["insta_username"] + "'? (Required to login) \n"; 75 | insta_password = await askQuestion(question); 76 | } else { 77 | insta_password = configs["insta_password"]; 78 | } 79 | 80 | //Create a new Instagram session 81 | await login(configs["insta_username"], insta_password, ig); 82 | 83 | //Activates reddit crawler 84 | snoopReddit(); 85 | 86 | //-- Upload every (25) minutes --// 87 | //Retrieve the configured upload frequency 88 | const frequency = getUploadFrequency(configs); 89 | logger.info(`Uploading with a frequency of every ${frequency}ms`); 90 | 91 | //You may change the upload frequency if you wish. (The number below is in milliseconds) 92 | setInterval(() => { 93 | chooseInstaPhoto(ig) 94 | }, frequency); 95 | 96 | //chooseInstaPhoto(ig); 97 | } 98 | 99 | //Activates the bot 100 | start(); 101 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # reddits-nightmare 2 | 3 | Don't you ever want to become the enemy of the people? [reddits-nightmare](https://github.com/Garlicvideos/reddits-nightmare) is a bot that downloads any post from any subreddit, along with the post's title, and reuploads it to Instagram, causing massive havoc and ruins relationships once your close friends or families find out. 4 | 5 | ## Getting started 6 | 7 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Installing for notes on how to deploy the project on a live system. 8 | 9 | ### Prerequisites 10 | 11 | You need Node.js and npm (which comes with Node.js) to use this bot. 12 | 13 | [Download Node.js and npm](https://nodejs.org/en/) 14 | 15 | ### Installing 16 | #### The bot 17 | Download the bot by going to [the releases page](https://github.com/Garlicvideos/reddits-nightmare/releases) and download the zip of the latest release. 18 | 19 | #### Node packages 20 | 21 | After downloading Nodejs, npm and the bot, `cd` into the directory you installed the bot to and run `npm i`. It should automatically install all the needed modules for this bot to work. 22 | 23 | #### Setup 24 | ##### Automated 25 | 26 | This is the method I recommend as there isn't a reason for you to be performing the installation manually **at all**. 27 | 28 | Run `npm run start` and the bot will perform first time setup. When the bot asks you if you want to use automated setup, type `y` or `yes`. 29 | 30 | It will then ask you several questions. To find out what these questions mean and their significance, as well as how to answer them correctly (The bot is almost fool-proof, but that doesn't mean it can't be broken), please go to the [config explanation page](https://github.com/Garlicvideos/reddits-nightmare/wiki/Configurations) 31 | 32 | 33 | ##### Manual 34 | 35 | Setting up manually is highly discouraged as human error will likely occur. 36 | But maybe you're adventurous. Head on over to the [manual installation guide](https://github.com/Garlicvideos/reddits-nightmare/wiki/Manual-Installation) for instructions on how to setup this bot by yourself, without the help of modern technology. 37 | 38 | #### Modification of files 39 | 40 | To add in your custom captions, open up `/configs/customcaption.txt` (or create the file, if it doesn't already exist,) and save your custom caption into the contents of the file. 41 | 42 | `config.json` and `subreddits.txt` is open for modification in case you entered any info wrongly. 43 | To fix either of the files, simply delete it and follow the steps [shown above here](#setup), for the file again. 44 | 45 | It is not recommended for you to manually modify the aforementioned files. 46 | 47 | ## Contributing 48 | 49 | Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. 50 | 51 | ## Authors 52 | 53 | * **Axiver** - [Axiver](https://github.com/Axiver) 54 | 55 | See also the list of [contributors](https://github.com/Garlicvideos/reddits-nightmare/contributors) who participated in this project. 56 | 57 | ## License 58 | 59 | This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the [LICENSE](LICENSE) file for details 60 | 61 | ## If you like what I do, please consider keeping me alive 62 | 63 | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/XavierTeoZK) 64 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 11 | build. 12 | 2. Update the README.md with details of changes to the interface, this includes new environment 13 | variables, exposed ports, useful file locations and container parameters. 14 | 3. Increase the version numbers in any examples files and the README.md to the new version that this 15 | Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 16 | 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 17 | do not have permission to do that, you may request the second reviewer to merge it for you. 18 | 19 | ## Code of Conduct 20 | 21 | ### Our Pledge 22 | 23 | In the interest of fostering an open and welcoming environment, we as 24 | contributors and maintainers pledge to making participation in our project and 25 | our community a harassment-free experience for everyone, regardless of age, body 26 | size, disability, ethnicity, gender identity and expression, level of experience, 27 | nationality, personal appearance, race, religion, or sexual identity and 28 | orientation. 29 | 30 | ### Our Standards 31 | 32 | Examples of behavior that contributes to creating a positive environment 33 | include: 34 | 35 | * Using welcoming and inclusive language 36 | * Being respectful of differing viewpoints and experiences 37 | * Gracefully accepting constructive criticism 38 | * Focusing on what is best for the community 39 | * Showing empathy towards other community members 40 | 41 | Examples of unacceptable behavior by participants include: 42 | 43 | * The use of sexualized language or imagery and unwelcome sexual attention or 44 | advances 45 | * Trolling, insulting/derogatory comments, and personal or political attacks 46 | * Public or private harassment 47 | * Publishing others' private information, such as a physical or electronic 48 | address, without explicit permission 49 | * Other conduct which could reasonably be considered inappropriate in a 50 | professional setting 51 | 52 | ### Our Responsibilities 53 | 54 | Project maintainers are responsible for clarifying the standards of acceptable 55 | behavior and are expected to take appropriate and fair corrective action in 56 | response to any instances of unacceptable behavior. 57 | 58 | Project maintainers have the right and responsibility to remove, edit, or 59 | reject comments, commits, code, wiki edits, issues, and other contributions 60 | that are not aligned to this Code of Conduct, or to ban temporarily or 61 | permanently any contributor for other behaviors that they deem inappropriate, 62 | threatening, offensive, or harmful. 63 | 64 | ### Scope 65 | 66 | This Code of Conduct applies both within project spaces and in public spaces 67 | when an individual is representing the project or its community. Examples of 68 | representing a project or community include using an official project e-mail 69 | address, posting via an official social media account, or acting as an appointed 70 | representative at an online or offline event. Representation of a project may be 71 | further defined and clarified by project maintainers. 72 | 73 | ### Enforcement 74 | 75 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 76 | reported by contacting `Garlicvideos#5659` on Discord. All 77 | complaints will be reviewed and investigated and will result in a response that 78 | is deemed necessary and appropriate to the circumstances. The project team is 79 | obligated to maintain confidentiality with regard to the reporter of an incident. 80 | Further details of specific enforcement policies may be posted separately. 81 | 82 | Project maintainers who do not follow or enforce the Code of Conduct in good 83 | faith may face temporary or permanent repercussions as determined by other 84 | members of the project's leadership. 85 | 86 | ### Attribution 87 | 88 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 89 | available at [http://contributor-covenant.org/version/1/4][version] 90 | 91 | [homepage]: http://contributor-covenant.org 92 | [version]: http://contributor-covenant.org/version/1/4/ 93 | -------------------------------------------------------------------------------- /bot/libs/post.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const WordPOS = require("wordpos"); 3 | const fs = require("fs"); 4 | const logger = require("./logger")("Instagram"); 5 | 6 | //Import utility functions and libs 7 | const { parseImage, ocr } = require("../libs/image"); 8 | const { restoreSpecialCharacters } = require("../utils/stringUtils"); 9 | 10 | //-- Functions --// 11 | /** 12 | * Filters and formats nouns as hashtags 13 | * @param {string[]} nouns The nouns to format and filter 14 | * @returns Valid nouns as hashtags 15 | */ 16 | function formatNouns(nouns) { 17 | return new Promise((resolve) => { 18 | //Loop through all nouns 19 | for (let i = 0; i < nouns.length; i++) { 20 | //Check if the noun is valid (Remove junk nouns like Aut Abg Oue) 21 | if (nouns[i].length < 4) { 22 | //The noun is junk 23 | nouns.splice(i, 1); 24 | i--; 25 | } else { 26 | //The noun is valid, format it into a hashtag 27 | nouns[i] = "#" + nouns[i].toLowerCase(); 28 | } 29 | } 30 | 31 | //Loop over, resolve with the result 32 | resolve(nouns); 33 | }); 34 | } 35 | 36 | /** 37 | * Filters and formats adjectives as hashtags 38 | * @param {string[]} nouns Nouns to filter against 39 | * @param {string[]} adjective The adjectives to format and filter 40 | * @returns Valid adjectives as hashtags 41 | */ 42 | function formatAdjectives(nouns, adjective) { 43 | return new Promise((resolve) => { 44 | //Loop through all adjectives 45 | for (let i = 0; i < adjective.length; i++) { 46 | //Check if the adjective is valid (Remove junk adjectives like Aut Abh Oue) 47 | if (adjective[i].length < 4) { 48 | //The adjective is junk 49 | adjective.splice(i, 1); 50 | i--; 51 | } else { 52 | //The adjective is valid, format it into a hashtag 53 | adjective[i] = "#" + adjective[i].toLowerCase(); 54 | 55 | //Check if it is a duplicate of a noun 56 | if (nouns.includes(adjective[i])) { 57 | //It is a duplicate, remove the adjective 58 | adjective.splice(i, 1); 59 | i--; 60 | } 61 | } 62 | } 63 | 64 | //Loop over, resolve with the result 65 | resolve(adjective); 66 | }); 67 | } 68 | 69 | /** 70 | * Generate hashtags from a string (Finds nouns and adjectives) 71 | * @param {string} imagePath The path to the image 72 | * @param {string} string A string to generate hashtags off of 73 | * @returns Generated hashtags 74 | */ 75 | function generateHashtags(imagePath, string) { 76 | return new Promise(async (resolve) => { 77 | //Load config file 78 | const configs = require("../configs/config.json").postProcess; 79 | 80 | //Checks if the user wants OCR 81 | let ocrText = ""; 82 | if (configs["ocr"] == "yes") { 83 | //Perform OCR on the image 84 | ocrText = await ocr(imagePath); 85 | } 86 | 87 | //Combine OCR text with string provided 88 | string += ` ${ocrText}`; 89 | 90 | //Initialise WordPOS 91 | const wordpos = new WordPOS(); 92 | 93 | //Find nouns from the string 94 | wordpos.getNouns(string, async (result) => { 95 | //Filters the nouns and formats the result into hashtags 96 | const nouns = await formatNouns(result); 97 | 98 | //Find adjectives from the string 99 | wordpos.getAdjectives(string, async (result) => { 100 | //Filters the adjectives and formats the result into hashtags 101 | const adjective = await formatAdjectives(nouns, result); 102 | 103 | //Join both nouns and adjectives together 104 | const hashtags = nouns.join(" ") + " " + adjective.join(" "); 105 | 106 | //Resolves with the result 107 | resolve(hashtags); 108 | }); 109 | }); 110 | }); 111 | } 112 | 113 | /** 114 | * Gets the custom caption set by the user in customcaption.txt 115 | * @returns The custom caption set by the user 116 | */ 117 | function getCustomCaption() { 118 | return new Promise((resolve, reject) => { 119 | //Reads the file 120 | fs.readFile("./configs/customcaption.txt", "utf8", (err, data) => { 121 | //Resolve with the result 122 | resolve(data); 123 | }); 124 | }); 125 | } 126 | 127 | /** 128 | * Post to instagram 129 | * @param {object} image The image to upload 130 | * @param {string} filename The name of the image file 131 | * @param {string} caption The image caption 132 | * @param {Object} ig Instagram client 133 | */ 134 | async function postToInsta(image, filename, caption, ig) { 135 | //Declares the path of the image 136 | const imagePath = "./assets/images/approved/" + filename; 137 | 138 | //Derive image caption 139 | const hashtags = await generateHashtags(imagePath, caption.toLowerCase()); 140 | const customcaption = await getCustomCaption(); 141 | const finalCaption = caption + customcaption + "\n\n\n" + hashtags; 142 | 143 | //Uploads the image to Instagram 144 | await ig.publish.photo({ 145 | //Reads the file into buffer before uploading 146 | file: image, 147 | caption: finalCaption, 148 | }).then((result) => { 149 | //Checks if the image upload was successful 150 | if (result.status == "ok") { 151 | //The image upload was a success 152 | logger.info("Uploaded image '" + caption + "' to Instagram."); 153 | 154 | //Ensures that the same image does not get reuploaded twice by moving it to the uploaded dir 155 | fs.rename(imagePath, "./assets/images/uploaded/" + filename, (err) => { 156 | if (err) 157 | logger.error("There was an error while trying to mark the image as uploaded: " + err); 158 | else 159 | logger.info("Image has been marked as uploaded!"); 160 | }); 161 | } 162 | }).catch((err) => { 163 | //An error occurred 164 | logger.error("There was a problem uploading the Image to Instagram (Did they detect us as a bot?): " + err); 165 | fs.rename(imagePath, "./assets/images/error/" + filename, (err) => { 166 | if (err) 167 | logger.error("There was an error while trying to unapprove the image: " + err); 168 | else 169 | logger.info("The image has been unapproved."); 170 | }); 171 | }); 172 | } 173 | 174 | /** 175 | * Chooses an image to upload to Instagram 176 | * @returns Path of the image to upload 177 | * @param {Object} ig Instagram client 178 | */ 179 | async function chooseInstaPhoto(ig) { 180 | //Retrieves an array of all approved images 181 | const files = fs.readdirSync("./assets/images/approved/"); 182 | 183 | //Checks if there are any images to upload 184 | if (files.length === 0) { 185 | //There are no images to upload 186 | logger.info("No images to upload to instagram!"); 187 | return; 188 | } 189 | 190 | //Chooses a random image 191 | const fileName = files[Math.floor(Math.random() * files.length)]; 192 | const filePath = "./assets/images/approved/" + fileName; 193 | 194 | //Changes the caption from filesystem format back to human readable format 195 | const caption = restoreSpecialCharacters(fileName); 196 | logger.info("Uploading post with caption: " + caption); 197 | 198 | //Parses the image such that it will fit instagram's allowed aspect ratio 199 | const parsedImage = await parseImage(filePath); 200 | 201 | //Checks if the image can be uploaded (Image matches allowed aspect ratio OR image could be resized to fit the allowed aspect ratio) 202 | if (!parsedImage) { 203 | //The aspect ratio is unacceptable 204 | logger.error("Error encountered while uploading image: unapproving image due to an unacceptable aspect ratio"); 205 | fs.rename(filePath, "./assets/images/error/" + fileName, (err) => { 206 | if (err) 207 | logger.error("Error encountered while unapproving image: " + err); 208 | }); 209 | 210 | //Upload another image by repeating the process 211 | logger.info("Uploading a different image..."); 212 | chooseInstaPhoto(ig); 213 | return; 214 | } 215 | 216 | //The aspect ratio is acceptable, upload the image 217 | postToInsta(parsedImage, fileName, caption, ig); 218 | return; 219 | } 220 | 221 | module.exports = { 222 | chooseInstaPhoto 223 | }; 224 | -------------------------------------------------------------------------------- /bot/libs/userAccount.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const { IgCheckpointError, IgLoginBadPasswordError, IgChallengeWrongCodeError } = require("instagram-private-api"); 3 | const Bluebird = require("bluebird"); 4 | const fs = require("fs"); 5 | const logger = require("./logger")("Instagram"); 6 | 7 | //Import utility functions and libs 8 | const { askQuestion } = require("./setup"); 9 | 10 | //-- Global Declarations --// 11 | const cookieLocation = "./cookies/session.json"; 12 | 13 | //-- Functions --// 14 | /** 15 | * Saves instagram session as a cookie 16 | * @param {Object} ig Instagram client 17 | */ 18 | function saveSession(ig) { 19 | return new Promise(async (resolve, reject) => { 20 | //Serializes the cookie 21 | const cookie = await ig.state.serialize(); 22 | delete cookie.constants; //This deletes the version info, so you'll always use the version provided by the library 23 | 24 | //Saves the cookie to disk 25 | fs.writeFile(cookieLocation, JSON.stringify(cookie), (err, result) => { 26 | if (err) 27 | logger.error("There was an error while saving session data: " + err); 28 | }); 29 | 30 | resolve(); 31 | }); 32 | } 33 | 34 | /** 35 | * Check if a session exists 36 | * @returns Whether or not the session exists 37 | */ 38 | function findSession() { 39 | //Checks if the file exists 40 | return fs.existsSync(cookieLocation); 41 | } 42 | 43 | /** 44 | * Load the session 45 | * @returns The session object 46 | */ 47 | function loadSession() { 48 | /** 49 | * require() path is relative to the file loading it, whereas fs is relative to the primary script 50 | * The location of the cookie is provided relative to the file being ran (beepboop.js) 51 | * Therefore, we need to append a "." to the filepath because this file is in a sibling folder (/libs/) of /cookies/ 52 | * :)))))))))))))) 53 | */ 54 | const session = require("." + cookieLocation); 55 | return session; 56 | } 57 | 58 | /** 59 | * Deletes the session cookie 60 | * @returns {void} 61 | */ 62 | function deleteSession() { 63 | //Delete the session cookie 64 | fs.unlink(cookieLocation, (err) => { 65 | if (err) 66 | logger.error("There was an error while deleting the session cookie: " + err); 67 | }); 68 | } 69 | 70 | /** 71 | * Sends the challenge code to Instagram 72 | * @param {Object} ig Instagram client 73 | */ 74 | async function solveChallenge(ig) { 75 | return new Promise(async (resolve, reject) => { 76 | //Asks the user for the code 77 | const question = "What is the code Instagram sent you? (It can be found in your Email/SMS)\n"; 78 | const challengeCode = await askQuestion(question); 79 | 80 | //Sends the code to Instagram 81 | await Bluebird.try(async () => { 82 | console.log(await ig.challenge.sendSecurityCode(challengeCode)); 83 | if (ig.account) { 84 | //Serialize session cookie (This gets invoked after every call to Instagram) 85 | ig.request.end$.subscribe(async () => { 86 | await saveSession(ig); 87 | }); 88 | logger.info("Successfully logged in to Instagram!"); 89 | resolve(); 90 | } 91 | }).catch(IgChallengeWrongCodeError, async () => { 92 | //The code entered was wrong, so we call this function again 93 | console.log("The code given was incorrect! Please type it in again."); 94 | solveChallenge(ig); 95 | }); 96 | }); 97 | } 98 | 99 | /** 100 | * Logs in to Instagram 101 | * @param {string} username The account username 102 | * @param {string} password The account password 103 | * @param {Object} ig Instagram client 104 | */ 105 | async function login(username, password, ig) { 106 | return new Promise(async (resolve, reject) => { 107 | //Load config file 108 | const configs = require("../configs/config.json"); 109 | 110 | //Generates a ID for Instagram 111 | ig.state.generateDevice(username); 112 | 113 | //-- Attempt to login via saved cookie --// 114 | //Check if a session cookie exists 115 | if (findSession()) { 116 | //A session cookie is saved on the disk, import the saved cookie 117 | await ig.state.deserialize(loadSession()); 118 | 119 | //Checks if the cookie was loaded successfully 120 | const user = await ig.account.currentUser(); 121 | if (user) { 122 | //Serialize session cookie (This gets invoked after every call to Instagram) 123 | ig.request.end$.subscribe(async () => { 124 | await saveSession(ig); 125 | }); 126 | 127 | //Login successful 128 | logger.info("Successfully logged in to Instagram!"); 129 | resolve(); 130 | } else { 131 | //Delete the session cookie 132 | // deleteSession(); 133 | 134 | //Attempt to relogin 135 | await login(username, password, ig); 136 | resolve(); 137 | } 138 | } else { 139 | //-- Unable to login via cookie, attempt logging in via username and password --// 140 | //Login procedure 141 | await Bluebird.try(async () => { 142 | //Execute usual requests in the android app, not required but reduces suspicion from Instagram 143 | // await ig.simulate.preLoginFlow(); 144 | 145 | //Login 146 | if (await ig.account.login(username, password, ig)) { 147 | //Create a new session cookie 148 | await saveSession(ig); 149 | 150 | //Update session cookie after every request to Instagram 151 | ig.request.end$.subscribe(async () => { 152 | await saveSession(ig); 153 | }); 154 | 155 | //Login successful 156 | logger.info("Successfully logged in to Instagram!"); 157 | resolve(); 158 | } 159 | 160 | //Execute requests normally done post-login, reduces suspicion 161 | // XXX process.nextTick(async() => await ig.simulate.postLoginFlow()); 162 | }).catch(IgLoginBadPasswordError, async () => { 163 | //The password entered is wrong, so we ask the user for the correct one 164 | const retryPassword = await askQuestion("\nThe password for the Instagram account '" + username + "'' is incorrect. Please type the correct password.\n"); 165 | 166 | //-- Save the correct one to config.json if "Remember me" is enabled --// 167 | //Check if the user enabled "Remember me" 168 | if (configs.instagram["insta_password"]) { 169 | //"Remember me" is enabled, update the saved password 170 | configs.instagram["insta_password"] = retryPassword; 171 | fs.writeFile("./configs/config.json", JSON.stringify(configs), (err) => { 172 | if (err) 173 | logger.error("There was an error while trying to update config.json with the new password: " + err); 174 | }); 175 | } 176 | 177 | //-- Attempt to relogin --// 178 | await login(username, retryPassword, ig); 179 | resolve(); 180 | }).catch(IgCheckpointError, async () => { 181 | /** 182 | * This portion should THEORETICALLY work. I've never had my account get challenged before, so I have nothing to test it on. 183 | * In the event that this does not work, please open a new issue at https://github.com/Garlicvideos/reddits-nightmare/issues/new 184 | */ 185 | //Instagram wants us to prove that we are human 186 | logger.info("Human verification received from Instagram! Solving challenge..."); 187 | 188 | //Initiates the challenge 189 | await Bluebird.try(async () => { 190 | await ig.challenge.auto(true); 191 | console.log(ig.state.challenge); 192 | }).catch(IgCheckpointError, async () => { 193 | //Call the checkpoint solving team 194 | await solveChallenge(ig); 195 | /* 196 | //Temporary workaround 197 | console.log("\nInstagram wants us to prove that we are human! Unfortunately, this means that you will need to login to this Instagram account manually using a web browser or your mobile phone."); 198 | console.log("After logging in, solve the challenge and re-run this bot. The bot will now exit."); 199 | process.exit(0); 200 | */ 201 | }); 202 | }); 203 | } 204 | }); 205 | } 206 | 207 | module.exports = { 208 | login 209 | }; -------------------------------------------------------------------------------- /bot/libs/redditSnooper.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const fs = require("fs"); 3 | const request = require("request"); 4 | const cliProgress = require("cli-progress"); 5 | const logger = require("./logger")("Snooper"); 6 | 7 | //Initialize reddit api library 8 | const Snooper = require("reddit-snooper"); 9 | const snooper = new Snooper({ 10 | automatic_retries: true, // automatically handles condition when reddit says 'you are doing this too much' 11 | api_requests_per_minute: 60, // api requests will be spread out in order to play nicely with Reddit 12 | }); 13 | 14 | //Import utility functions and libs 15 | const { formatFileName } = require("./image"); 16 | const { isImage } = require("../utils/imageUtils"); 17 | 18 | //-- Functions --// 19 | /** 20 | * Fixes invalid subreddits 21 | * @param {string[]} subreddits An array of subreddits 22 | * @returns Valid array of subreddits 23 | */ 24 | function fixSubreddits(subreddits) { 25 | return new Promise((resolve, reject) => { 26 | /** 27 | * Filters out invalid subreddits 28 | * 1. Subreddits must have a minimum of 2 characters 29 | */ 30 | const result = subreddits.filter((subreddit) => { 31 | //Removes any subreddit that does not meet the 2 character minimum 32 | if (subreddit.length < 2) { 33 | logger.info("Found a subreddit that does not reach the 2 character minimum, fixing..."); 34 | return false; 35 | } 36 | 37 | if (!subreddit) { 38 | //Subreddit is an empty or null value 39 | return false; 40 | } 41 | 42 | //Subreddit has passed all checks 43 | return true; 44 | }); 45 | 46 | //Resolve with the result 47 | resolve(result); 48 | }); 49 | } 50 | 51 | /** 52 | * Strings subreddits from config into a searchable URL and helps to resolve any errors in the subreddit list 53 | * @returns Subreddits in the format of 'subreddit1+subreddit2+subreddit3' 54 | */ 55 | function stringSubreddits() { 56 | return new Promise((resolve, reject) => { 57 | //Check if the subreddit list exists 58 | if (!fs.existsSync("./configs/subreddits.txt")) { 59 | //Subreddit list does not exist 60 | logger.warn("Subreddit config file does not exist, defaulting to r/all."); 61 | 62 | //Create the list with r/all as the subreddit 63 | fs.writeFile("./configs/subreddits.txt", "all", () => { 64 | logger.info("Created missing file 'subreddits.txt' in './configs'"); 65 | }); 66 | 67 | //Resolve with the result 68 | return resolve(["all"]); 69 | } 70 | 71 | //The subreddit list exists, read from it 72 | fs.readFile("./configs/subreddits.txt", "utf8", async (err, data) => { 73 | //Checks if there was any error reading the file 74 | if (err) { 75 | //There was an error reading the file, default to r/all 76 | logger.warn("An error occurred while reading file 'subreddits.txt' in './configs', defaulting to r/all"); 77 | fs.writeFile("./configs/subreddits.txt", "all", () => {}); 78 | return resolve(["all"]); 79 | } 80 | 81 | //File read successfully, check if the file is empty 82 | if (data.length === 0) { 83 | //The file is empty, default to r/all 84 | data = "all"; 85 | logger.warn("Subreddit list is empty, defaulting to r/all."); 86 | fs.writeFile("./configs/subreddits.txt", "all", () => {}); 87 | return resolve(["all"]); 88 | } 89 | 90 | //File is not empty, convert from string to array 91 | const subreddits = data.split(","); 92 | const content = await fixSubreddits(subreddits); 93 | 94 | //Checks if the subreddits.txt file was broken 95 | if (content.join() !== subreddits.join()) { 96 | //The file was broken and it has been fixed 97 | fs.writeFile("./configs/subreddits.txt", content, () => { 98 | logger.info("Fixed the subreddit list"); 99 | }); 100 | } 101 | 102 | //Joins the subreddits array with a "+" (For use in HTTP query) 103 | const result = content.join("+"); 104 | resolve(result); 105 | }); 106 | }); 107 | } 108 | 109 | /** 110 | * Downloads posts from reddit 111 | * @param {string} url The url of the post 112 | * @param {string} postTitle The title of the post 113 | * @param {boolean} nsfw Whether or not the post is NSFW 114 | */ 115 | async function download(url, postTitle, nsfw) { 116 | //Checks the length of post title 117 | if (postTitle.length > 250) { 118 | //The post's title is over the 250 character limit 119 | return; 120 | } 121 | 122 | //Determines the path of the file for storage in the filesystem 123 | const filepath = await formatFileName(postTitle, url, nsfw); 124 | 125 | //Prepares to download the image 126 | request.head(url, (err, res, body) => { 127 | //If the file already exists, it means that it was downloaded before, thus it will not download again. 128 | if (!fs.existsSync(filepath)) { 129 | //-- The file has never been downloaded before, download it --// 130 | logger.verbose(`Downloading '${postTitle}' from ${url} to ${filepath}`); 131 | 132 | //Open a write stream to the target path 133 | const filetoPipe = fs.createWriteStream(filepath); 134 | 135 | //Creates a progress bar 136 | const progressBar = new cliProgress.SingleBar({ 137 | format: `Downloading '${postTitle}' |{bar}| {percentage}% | {value}/{total} Chunks | Speed: {speed}`, 138 | barCompleteChar: "\u2588", 139 | barIncompleteChar: "\u2591", 140 | hideCursor: true, 141 | clearOnComplete: true, 142 | linewrap: true, 143 | }); 144 | 145 | //Initialises the bar 146 | progressBar.start(100, 0, { 147 | speed: "N/A", 148 | }); 149 | 150 | //Download the image and pipe it to the file 151 | filetoPipe 152 | .on("open", () => { 153 | request(url) 154 | .pipe(filetoPipe) 155 | .on("response", (data) => { 156 | //Retrieve the total number of chunks of the payload 157 | const totalChunks = parseInt(data.headers["content-length"]); 158 | 159 | //Start the progress bar 160 | progressBar.start(totalChunks); 161 | }) 162 | .on("data", (chunk) => { 163 | //Update the progress bar on every chunk received 164 | progressBar.increment(chunk.length); 165 | }) 166 | .on("close", () => { 167 | //Download complete, close pipe 168 | filetoPipe.end(); 169 | 170 | //Stop the progress bar 171 | progressBar.stop(); 172 | logger.info(`Downloaded '${postTitle}'`); 173 | }); 174 | }) 175 | .on("error", (err) => { 176 | //Stop the progress bar 177 | progressBar.stop(); 178 | logger.error(`Unable to download '${postTitle}': `, err); 179 | }); 180 | } 181 | }); 182 | } 183 | 184 | /** 185 | * Crawls reddit for popular posts to leech off of 186 | */ 187 | async function snoopReddit() { 188 | //Load config file 189 | const configs = require("../configs/config.json").snooper; 190 | 191 | //Configure the crawler 192 | let options = { 193 | listing: configs.sort, // 'hot' OR 'rising' OR 'controversial' OR 'top_day' OR 'top_hour' OR 'top_month' OR 'top_year' OR 'top_all' 194 | limit: configs.top, // how many posts you want to watch? if any of these spots get overtaken by a new post an event will be emitted, 50 is 2 pages 195 | }; 196 | 197 | //Reformat the subreddit list 198 | const subreddits = await stringSubreddits(); 199 | 200 | //Begins snooping 201 | snooper.watcher 202 | .getListingWatcher(subreddits, options) 203 | .on("item", (item) => { 204 | //If post is a image and has a supported file format 205 | if ((item.kind = "t3" && isImage(item.data.url))) { 206 | //Retrieves information about the post 207 | const postUrl = item.data.url; 208 | const postTitle = item.data.title; 209 | const postID = item.data.id; 210 | const nsfw = item.data.over_18; 211 | 212 | //Downloads the post 213 | download(postUrl, postTitle, nsfw); 214 | } 215 | }) 216 | .on("error", (err) => { 217 | logger.error(`Unable to scrape reddit: `, err); 218 | }); 219 | 220 | // logger.warn( 221 | // "The reddit snooper module has been disabled as it has been broken by the Reddit API changes. Please check the README for more information." 222 | // ); 223 | } 224 | 225 | module.exports = { 226 | snoopReddit, 227 | }; 228 | -------------------------------------------------------------------------------- /bot/libs/image.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const fs = require("fs"); 3 | const path = require("path"); 4 | const sharp = require('sharp'); 5 | const cliProgress = require('cli-progress'); 6 | const { createWorker } = require("tesseract.js"); 7 | 8 | //Import utility functions and libs 9 | const { replaceSpecialChars, contains, capitalizeFirstLetter } = require("../utils/stringUtils"); 10 | 11 | //-- Functions --// 12 | /** 13 | * Formats the file name to save to Filesystem 14 | * @param {string} postTitle The title of the post 15 | * @param {string} postUrl The url of the post 16 | * @param {boolean} nsfw Whether or not the post is nsfw 17 | * @returns The formatted file path for the image 18 | */ 19 | function formatFileName(postTitle, postUrl, nsfw) { 20 | return new Promise(async (resolve, reject) => { 21 | //Initialise logger 22 | const logger = require("./logger")("Snooper"); 23 | 24 | //Define an array of forbidden words 25 | const forbiddenWords = ["reddit", "r/", "comments", "upvote", "downvote", "retweet", "mods", "me", "i", "my", "i've"]; 26 | 27 | //Reformats the filename so that it complies with window's strict filesystem rules 28 | postTitle = replaceSpecialChars(postTitle); 29 | 30 | //Initialises the resultant filename 31 | let filename; 32 | 33 | //-- Determines the directory the image should be stored in --// 34 | //Checks if post is NSFW 35 | if (nsfw) { 36 | //The post is NSFW 37 | logger.info("Found a potentially NSFW post (Will require manual approval): " + postTitle); 38 | filename = "./assets/images/nsfw/" + postTitle + path.extname(postUrl); 39 | return resolve(filename); 40 | } 41 | 42 | //Checks if the post contains words in the forbidden list 43 | if (contains(postTitle, forbiddenWords)) { 44 | //The post contains forbidden words 45 | logger.info("Image: " + postTitle + " is rejected due to the title having reddit related words"); 46 | filename = "./assets/images/rejected/" + postTitle + path.extname(postUrl); 47 | return resolve(filename); 48 | } 49 | 50 | //Checks if the file was previously downloaded. If it is, returns the path of the old file and thus it will not be downloaded again 51 | if (fs.existsSync("./assets/images/uploaded/" + postTitle + path.extname(postUrl))) { 52 | //It has been downloaded before 53 | filename = "./assets/images/uploaded/" + postTitle + path.extname(postUrl); 54 | return resolve(filename); 55 | } 56 | 57 | //Checks if the post has been previously downloaded and has previously caused an error 58 | if (fs.existsSync("./assets/images/error/" + postTitle + path.extname(postUrl))) { 59 | //The post has caused an error before 60 | filename = "./assets/images/error/" + postTitle + path.extname(postUrl); 61 | return resolve(filename); 62 | } 63 | 64 | //The post is brand new! 65 | filename = "./assets/images/approved/" + postTitle + path.extname(postUrl); 66 | resolve(filename); 67 | }); 68 | } 69 | 70 | /** 71 | * Uses OCR to obtain words from the image 72 | * @param {string} imagePath The path to the image 73 | * @returns OCR result 74 | */ 75 | function ocr(imagePath) { 76 | return new Promise(async (resolve, reject) => { 77 | //-- Creates a new progress bar in CLI --// 78 | //Initialise logger 79 | const logger = require("./logger")("OCR"); 80 | 81 | //Derives the name of the file to be processed 82 | const fileName = path.basename(imagePath); 83 | 84 | //Creates the bar 85 | const progressBar = new cliProgress.SingleBar({ 86 | format: `[${new Date().toISOString()}] [OCR] Info : Processing '${fileName}' | {status} |{bar}| {percentage}%`, 87 | barCompleteChar: '\u2588', 88 | barIncompleteChar: '\u2591', 89 | hideCursor: true, 90 | clearOnComplete: true, 91 | linewrap: true 92 | }); 93 | 94 | //Initialises the bar 95 | progressBar.start(100, 0, { 96 | speed: "N/A", 97 | status: "N/A" 98 | }); 99 | 100 | //-- Creates and configures OCR worker --// 101 | const worker = await createWorker("eng", 1, { 102 | logger: (m) => { 103 | progressBar.update(m.progress * 100, { 104 | status: capitalizeFirstLetter(m.status) 105 | }); 106 | }, 107 | }); 108 | 109 | //Perform OCR on the image 110 | const { 111 | data: { 112 | text 113 | }, 114 | } = await worker.recognize(imagePath); 115 | 116 | //Terminate the OCR worker 117 | await worker.terminate(); 118 | 119 | //Stop the bar 120 | progressBar.stop(); 121 | 122 | //Print OCR complete log 123 | logger.info(`Processed '${fileName}'`); 124 | 125 | //Resolve with the result 126 | resolve(text); 127 | }); 128 | } 129 | 130 | /** 131 | * Checks if the aspect ratio of a image can be uploaded to instagram, and if it can't it will attempt to resize it 132 | * Even though there is a catch at the part where it uploads to catch rejected aspect ratios, 133 | * It is a good idea to catch it here first before it reaches their servers to 134 | * Prevent them from detecting us as a bot 135 | * @param {string} imagePath Path to the image being checked 136 | * @returns Whether or not the ratio of the image is acceptable 137 | */ 138 | function parseImage(imagePath) { 139 | return new Promise(async (resolve, reject) => { 140 | //-- Auto scales and crops images that do not fit the allowed aspect ratios --// 141 | //Define allowed aspect ratios 142 | //Allowed aspect ratios are obtained from https://help.instagram.com/1631821640426723 143 | const allowedRatios = { 144 | width: { 145 | lowerLimit: 320, 146 | upperLimit: 1080 147 | }, 148 | height: { 149 | lowerLimit: 566, 150 | upperLimit: 1350 151 | } 152 | } 153 | 154 | //Read the image to buffer (Also obtains image metadata) 155 | let image = await sharp(imagePath).rotate().toBuffer({resolveWithObject: true}); 156 | 157 | /** 158 | * Resizes/crops image based on width 159 | */ 160 | //Check if the image fits the allowed width 161 | if (image.info.width < allowedRatios.width.lowerLimit || image.info.width > allowedRatios.width.upperLimit) { 162 | //-- Image does not meet the allowed width, attempt to resize it --// 163 | //Check if the image is closer to the lower limit 164 | if (allowedRatios.width.lowerLimit - image.info.width >= image.info.width - allowedRatios.width.upperLimit) { 165 | //The image is closer to the lower limit, resize it to match 166 | image = await sharp(image.data).resize({ width: allowedRatios.width.lowerLimit}).toBuffer({resolveWithObject: true}); 167 | } else { 168 | //The image is closer to the upper limit, resize it to match 169 | image = await sharp(image.data).resize({ width: allowedRatios.width.upperLimit}).toBuffer({resolveWithObject: true}); 170 | } 171 | } 172 | 173 | /** 174 | * Resizes/crops image based on height 175 | */ 176 | //Check if the image fits the allowed height 177 | if (image.info.height < allowedRatios.height.lowerLimit || image.info.height > allowedRatios.height.upperLimit) { 178 | //-- Image does not meet the allowed height, attempt to trim/letterbox it --// 179 | //Check if the image is closer to the lower limit 180 | if (allowedRatios.height.lowerLimit - image.info.height >= image.info.height - allowedRatios.height.upperLimit) { 181 | //The image is closer to the lower limit, calculate the width to resize to 182 | const newWidth = Math.floor((allowedRatios.height.lowerLimit / image.info.height) * image.info.width); 183 | 184 | //Check if the newly calculated width exceeds the maximum acceptable width 185 | if (newWidth > allowedRatios.width.upperLimit) { 186 | //The newly calculated width exceeds the maximum allowed 187 | //Resize the image to the max width 188 | const resizedImage = await sharp(image.data).resize({ width: allowedRatios.width.upperLimit }).toBuffer({resolveWithObject: true}); 189 | 190 | //-- Add blurred borders to the side of the image --// 191 | //Generate a blurred image and overlay the resized image on top of it 192 | image = await sharp(image.data).resize({ width: resizedImage.info.width, height: resizedImage.info.width }).blur(400).composite([{input: resizedImage.data, gravity: "center"}]).toBuffer({resolveWithObject: true}); 193 | } else { 194 | //The newly calculated width is ok 195 | //Resize the image 196 | image = await sharp(image.data).resize(newWidth, allowedRatios.height.lowerLimit).toBuffer({resolveWithObject: true}); 197 | } 198 | } else { 199 | //The image is closer to the upper limit, crop the image (Vertically and horizontally anchored) 200 | image = await sharp(image.data).resize(image.info.width, allowedRatios.height.upperLimit).toBuffer({resolveWithObject: true}); 201 | } 202 | } 203 | 204 | //The image has been parsed 205 | resolve(image.data); 206 | }); 207 | } 208 | 209 | module.exports = { 210 | formatFileName, 211 | ocr, 212 | parseImage 213 | }; 214 | -------------------------------------------------------------------------------- /bot/libs/setup.js: -------------------------------------------------------------------------------- 1 | //-- Import required libraries --// 2 | const fs = require("fs"); 3 | const readline = require("readline"); 4 | const logger = require("./logger")("Setup"); 5 | 6 | //-- Functions --// 7 | /** 8 | * Asks the user a question 9 | * @param {string} question The question to be asked 10 | * @param {object} rl An existing readline instance 11 | * @returns The user's response 12 | */ 13 | function askQuestion(question, rl) { 14 | return new Promise((resolve, reject) => { 15 | //Check if a readline instance was provided 16 | if (rl != null) { 17 | //A readline instance was provided, resume the instance 18 | rl.resume(); 19 | 20 | //Prompt the user with the question 21 | rl.question(question, (answer) => { 22 | //Pause the readline instance 23 | rl.pause(); 24 | 25 | //Resolve with the result 26 | resolve(answer); 27 | }); 28 | } else { 29 | //No readline instance was provided 30 | //Create one and hook to console 31 | rl = readline.createInterface({ 32 | input: process.stdin, 33 | output: process.stdout, 34 | }); 35 | 36 | //Prompt the user with the question 37 | rl.question(question, (answer) => { 38 | //Unhook readline 39 | rl.close(); 40 | 41 | //Resolve with the result 42 | resolve(answer); 43 | }); 44 | } 45 | }); 46 | } 47 | 48 | /** 49 | * Directory creation 50 | * @param {string | string[] | object} dirs The directories to create 51 | * @param {string} parentDir The parent directory 52 | */ 53 | function makeDirs(dirs, parentDir) { 54 | return new Promise((resolve, reject) => { 55 | /** 56 | * Creates a directory from a string 57 | */ 58 | //Check if the element is a string 59 | if (typeof dirs === "string") { 60 | //Check if the directory already exists 61 | if (!fs.existsSync(parentDir + dirs)) { 62 | //The directory does not exist, create it 63 | fs.mkdirSync(parentDir + dirs); 64 | logger.info("Created missing directory:" + parentDir + dirs); 65 | 66 | resolve(); 67 | return; 68 | } 69 | } 70 | 71 | /** 72 | * Creates directories from an array 73 | */ 74 | //Check if the dirs passed in is an array 75 | if (Array.isArray(dirs)) { 76 | //An array of directories was passed in 77 | //Create every directory in the array 78 | dirs.forEach((dir) => { 79 | //Creates the directory 80 | makeDirs(dir, parentDir); 81 | }); 82 | 83 | resolve(); 84 | return; 85 | } 86 | 87 | /** 88 | * Creates directories from an object 89 | */ 90 | //Check if the element is an object 91 | if (typeof dirs === "object") { 92 | //The item is an object, loop through it 93 | for (const key in dirs) { 94 | //Checks if the object has any keys to check through 95 | if (Object.prototype.hasOwnProperty.call(dirs, key)) { 96 | //Yes it does, create the directory 97 | makeDirs(key, parentDir); 98 | 99 | //Parent directory created, create its sub-directories 100 | makeDirs(dirs[key], parentDir + key); 101 | 102 | resolve(); 103 | return; 104 | } 105 | } 106 | } 107 | 108 | resolve(); 109 | }); 110 | } 111 | 112 | /** 113 | * Creates the necessary config files 114 | * @param {string[]} subreddits An array of whitelisted subreddits 115 | * @param {object} logindetails Instagram login details 116 | * @param {object} postProcessConfig Post-processing configurations 117 | * @param {object} snooperConfig Reddit snooper configurations 118 | */ 119 | async function createConfigs(subreddits, logindetails, postProcessConfig, snooperConfig) { 120 | return new Promise((resolve, reject) => { 121 | //-- Create general config file (config.json) --// 122 | //Joins login configuration, postProcess configuration and snooper configurations together 123 | const joinedConfigs = { instagram: logindetails, postProcess: postProcessConfig, snooper: snooperConfig }; 124 | 125 | //Create general config file 126 | fs.writeFile("./configs/config.json", JSON.stringify(joinedConfigs), (err) => { 127 | //Checks for any errors 128 | if (!err) { 129 | //File creation successful 130 | logger.info("Created config.json containing configurations"); 131 | } else { 132 | logger.error("Encountered an error creating './configs/config.json'! Error: " + err); 133 | process.exit(1); 134 | } 135 | }); 136 | 137 | //Checks if the subreddits file exists 138 | if (!fs.existsSync("./configs/subreddits.txt")) { 139 | //It does not exist, string the subreddits together and create the subreddit config file 140 | fs.writeFile("./configs/subreddits.txt", subreddits.join(), (err) => { 141 | if (err) { 142 | logger.error("Encountered an error creating './configs/subreddits.txt'! Error: " + err); 143 | process.exit(1); 144 | } else { 145 | logger.info("Created subreddits.txt containing a list of subreddits to read from."); 146 | } 147 | }); 148 | } 149 | 150 | //Checks if the custom caption file exists 151 | if (!fs.existsSync("./configs/customcaption.txt")) { 152 | //It does note exist, create file to store user's custom caption 153 | fs.writeFile("./configs/customcaption.txt", "", (err) => { 154 | if (err) { 155 | logger.error("Encountered an error creating './configs/customcaption.txt'! Error: " + err); 156 | process.exit(1); 157 | } else { 158 | logger.info("Created missing file: ./configs/customcaption.txt"); 159 | } 160 | }); 161 | } 162 | 163 | //Wait a second for everything to be created. There's gotta be a better way to do this, I'll figure it out in the future. 164 | setTimeout(() => { 165 | //Check if all the config files are present. If so, return true. 166 | if (fs.existsSync("./configs/customcaption.txt") && fs.existsSync("./configs/config.json") && fs.existsSync("./configs/subreddits.txt")) { 167 | resolve(true); 168 | } else { 169 | logger.info("There was a problem creating the config files. The bot will now exit."); 170 | process.exit(1); 171 | } 172 | }, 1000); 173 | }); 174 | } 175 | 176 | /** 177 | * Configures the reddit snooper 178 | * @param {Object} rl Readline instance 179 | * @returns Reddit snooper settings 180 | */ 181 | function setupSnooper(rl) { 182 | return new Promise(async (resolve, reject) => { 183 | //Initialises the settings object 184 | const settings = {}; 185 | 186 | //-- Configures post sorting order --// 187 | //Asks the user which sorting method they'd prefer 188 | const answer = await askQuestion("\nHow would you like the bot to sort? (Defaults to hot) [hot/top_24/top_day/controversial/rising] \n", rl); 189 | const sortingMethod = answer.toLowerCase(); 190 | 191 | //Checks for and saves a valid response 192 | switch (sortingMethod) { 193 | case "hot": 194 | settings["sort"] = "hot"; 195 | break; 196 | case "top_24": 197 | settings["sort"] = "top_24"; 198 | break; 199 | case "top_day": 200 | settings["sort"] = "top_day"; 201 | break; 202 | case "controversial": 203 | settings["sort"] = "controversial"; 204 | break; 205 | case "rising": 206 | settings["sort"] = "rising"; 207 | break; 208 | default: 209 | settings["sort"] = "hot"; 210 | console.log("Invalid response received, defaulting to 'hot'"); 211 | } 212 | 213 | //-- Configures the number of posts to be monitored --// 214 | //Asks the user how many posts they'd like the bot to monitor 215 | const monitorCount = await askQuestion("\nHow many posts would you like to monitor? (E.g. Top 10 posts of hot | Defaults to 15) [1-100]\n", rl); 216 | 217 | //Checks for and saves a valid response 218 | if (!isNaN(monitorCount) && monitorCount > 0) { 219 | settings["top"] = monitorCount; 220 | } else { 221 | console.log("Invalid response received, defaulting to 15."); 222 | settings["top"] = 15; 223 | } 224 | 225 | //Resolve with the result 226 | resolve(settings); 227 | }); 228 | } 229 | 230 | /** 231 | * Asks user for their instgram login details 232 | * @param {object} rl Readline instance 233 | * @returns Instagram client settings 234 | */ 235 | function setupInstagram(rl) { 236 | return new Promise(async (resolve, reject) => { 237 | //Initialise settings object 238 | const settings = {}; 239 | 240 | //-- Configures the Instagram login credentials --// 241 | //Asks the user for their instagram username 242 | const username = await askQuestion("\nWhat is your Instagram account username? \n", rl); 243 | 244 | //Saves the username to the settings object 245 | settings["insta_username"] = username; 246 | 247 | //Asks the user for whether or not they'd like the "Remember me" feature 248 | const answer = await askQuestion('\nWould you like to enable "Remember me"? (This stores your Instagram password as plaintext on your local machine, resulting in weaker security. (It is not recommended to enable this as you only need to type in your password once every now and then anyways, due to the usage of sessions)\n', rl); 249 | const rememberMe = answer.toLowerCase(); 250 | 251 | //Checks for a valid response 252 | if (rememberMe == "y" || rememberMe == "yes") { 253 | //The user wants the "Remember Me" feature 254 | //Asks the user for their password 255 | const password = await askQuestion('\nWhat is the password associated with Instagram account "' + settings["insta_username"] + '"?\n', rl); 256 | 257 | //Saves the password to the settings object 258 | settings["insta_password"] = password; 259 | } 260 | 261 | //-- Configures the upload frequency --// 262 | //Asks the user how often they'd like the bot to upload to instagram 263 | const frequency = await askQuestion("\nHow often (in milliseconds) would you like the bot to upload to Instagram? (Cannot be faster than once every minute) (Defaults to once every 25 minutes aka 1.5e+6 or 1500000)\n"); 264 | 265 | //Checks for an invalid response 266 | if (Number.isNaN(frequency) || frequency < 60 * 1000) { 267 | //The interval provided is invalid, default to once every 25 mins 268 | console.log("Invalid response received, defaulting to 1.5e+6."); 269 | 270 | //Save to settings object 271 | settings["frequency"] = 1.5e+6; 272 | } else { 273 | //A valid response was received, save the frequency to the settings object 274 | settings["frequency"] = frequency; 275 | } 276 | 277 | //Resolves with the result 278 | resolve(settings); 279 | }); 280 | } 281 | 282 | /** 283 | * Configures the snooper's whitelisted subreddits 284 | * @param {object} rl Readline instance 285 | * @returns Whitelisted subreddits 286 | */ 287 | function setupSubreddits(rl) { 288 | return new Promise(async (resolve, reject) => { 289 | //-- Configures the subreddits to whitelist --// 290 | //Asks the user for the subreddits they'd like to whitelist 291 | let subreddits = await askQuestion("\nWhat subreddit(s) do you want to whitelist? \n(r/all works too. Do NOT include 'r/'. Seperate using commas. Make sure the subreddit exists, or the bot will spit out errors/crash later on.)", rl); 292 | 293 | //Formats the response 294 | //Checks if the user has any "r/"s 295 | if (subreddits.includes("r/")) { 296 | //Removes any "r/" from the input 297 | subreddits = subreddits.replace(/r\//g, ""); 298 | } 299 | 300 | //Removes spaces in the user's input 301 | subreddits = subreddits.replace(/ /g, ""); 302 | 303 | //Parses the response into an array 304 | const result = subreddits.split(","); 305 | 306 | //Resolves with the result 307 | resolve(result); 308 | }); 309 | } 310 | 311 | /** 312 | * Configures post-processing options 313 | * @param {object} rl Readline instance 314 | * @returns Post-processing options 315 | */ 316 | function setupPostProcessing(rl) { 317 | return new Promise(async (resolve, reject) => { 318 | //Initialises the settings object 319 | const settings = {}; 320 | 321 | //-- Configures automatic hashtags --// 322 | //Asks the user whether or not they'd like for hashtags to be generated automatically 323 | let answer = await askQuestion("\nWould you like the bot to automatically generate hashtags for you? [y/cancel] \n", rl); 324 | const autoHashtags = answer.toLowerCase(); 325 | 326 | //Checks for and saves a valid response 327 | if (autoHashtags == "y" || autoHashtags == "yes") { 328 | settings["autohashtags"] = "yes"; 329 | } else { 330 | settings["autohashtags"] = "no"; 331 | } 332 | 333 | //-- Configures OCR --// 334 | //Asks the user if they'd like for OCR to be enabled 335 | answer = await askQuestion("\nWould you like OCR to be enabled? (Scans images for text and uses them as hashtags) [y/cancel] \n", rl); 336 | const enableOCR = answer.toLowerCase(); 337 | 338 | //Checks for and saves a valid response 339 | if (enableOCR == "y" || enableOCR == "yes") { 340 | settings["ocr"] = "yes"; 341 | } else { 342 | settings["ocr"] = "no"; 343 | } 344 | 345 | //Resolves with the result 346 | resolve(settings); 347 | }); 348 | } 349 | 350 | /** 351 | * Performs first time setup 352 | */ 353 | function setup() { 354 | return new Promise(async (resolve, reject) => { 355 | //Check if account credential file exists 356 | if (!fs.existsSync("./configs/config.json")) { 357 | //If no, perform first time setup 358 | logger.info("Performing first time setup"); 359 | 360 | //Hook to console 361 | const rl = readline.createInterface({ 362 | input: process.stdin, 363 | output: process.stdout, 364 | }); 365 | 366 | //Asks if the user wants automatic setup 367 | const response = await askQuestion("Would you like to automatically configure the config file? (You will have to do this manually if you answer no) [y/n] \n", rl); 368 | const answer = response.toLowerCase(); 369 | 370 | //Checks for a valid response 371 | if (answer !== "y" && answer !== "yes") { 372 | //User does not want automatic configuration 373 | console.log("Okay, but you need to perform manual setup or the bot will refuse to start."); 374 | console.log("Read the documentation at https://github.com/Garlicvideos/reddits-nightmare/wiki for more information."); 375 | 376 | //End readline and exit nodejs 377 | rl.close(); 378 | process.exit(0); 379 | } 380 | 381 | //-- User wants automatic configuration, begin setup process --// 382 | //Request for user's Instagram login details 383 | const logindetails = await setupInstagram(rl); 384 | 385 | //Configures the reddit snooper 386 | const snooperConfig = await setupSnooper(rl); 387 | 388 | //Check if the subreddits file exists 389 | let subreddits = undefined; 390 | if (!fs.existsSync("./configs/subreddits.txt")) { 391 | //The subreddit file does not exist, create it 392 | subreddits = await setupSubreddits(rl); 393 | } 394 | 395 | //Request for post-processing configuration 396 | const postProcessConfig = await setupPostProcessing(rl); 397 | 398 | //Creates remaining configuration files 399 | if (!await createConfigs(subreddits, logindetails, postProcessConfig, snooperConfig)) { 400 | //An error has occurred 401 | logger.error("An unknown error has occurred while performing automatic setup."); 402 | reject(); 403 | } 404 | 405 | //Setup complete, end readline 406 | rl.close(); 407 | logger.info("Setup complete. Booting!"); 408 | } else { 409 | //No setup is required, all prerequisites are present 410 | logger.info("Prerequisites present, booting!"); 411 | } 412 | 413 | resolve(); 414 | }); 415 | } 416 | 417 | module.exports = { 418 | askQuestion, 419 | makeDirs, 420 | setup 421 | }; -------------------------------------------------------------------------------- /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 | Copyright (C) 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 | --------------------------------------------------------------------------------