2020-06-05 14:06:59 +00:00
|
|
|
const fs = require('fs-extra'); // Reading README.md
|
|
|
|
const path = require('path'); // Get the correct path for README.md
|
|
|
|
const fetch = require('node-fetch'); // Make calls to Reddit from Node.js
|
|
|
|
const qs = require('qs'); // Properly build a query for node-fetch POST
|
2020-06-05 14:30:23 +00:00
|
|
|
const moment = require('moment'); // Time-related functions
|
2020-06-02 21:20:31 +00:00
|
|
|
|
2020-06-05 14:06:59 +00:00
|
|
|
// REDDIT_: For authentication with Reddit API. Oauth MUST be used. ID and Secret come from a "script" app type.
|
2020-06-02 21:20:31 +00:00
|
|
|
const REDDIT_USER = process.env.REDDIT_USER || 'username';
|
|
|
|
const REDDIT_PASS = process.env.REDDIT_PASS || 'password';
|
|
|
|
const REDDIT_CLIENT_ID = process.env.REDDIT_CLIENT_ID || 'clientid';
|
|
|
|
const REDDIT_CLIENT_SECRET = process.env.REDDIT_CLIENT_SECRET || 'clientsecret';
|
2020-06-05 14:06:59 +00:00
|
|
|
|
|
|
|
// WIKI_: For the Reddit Wiki
|
2020-06-02 21:20:31 +00:00
|
|
|
const WIKI_SUBREDDIT = 'privacy';
|
2020-06-08 14:01:10 +00:00
|
|
|
const WIKI_PAGE = 'de-google';
|
2020-06-05 14:06:59 +00:00
|
|
|
const WIKI_REASON = 'Automated edit from GitHub repo: https://github.com/tycrek/degoogle';
|
|
|
|
|
|
|
|
// Helps POST data be submitted properly
|
2020-06-02 21:20:31 +00:00
|
|
|
const CONTENT_TYPE = 'application/x-www-form-urlencoded';
|
|
|
|
|
2020-06-05 14:06:59 +00:00
|
|
|
updateWiki();
|
2020-06-02 21:20:31 +00:00
|
|
|
|
2020-06-05 14:06:59 +00:00
|
|
|
/**
|
|
|
|
* Update the Reddit wiki
|
|
|
|
*/
|
2020-06-02 21:20:31 +00:00
|
|
|
function updateWiki() {
|
2020-06-05 14:06:59 +00:00
|
|
|
// Endpoints for each of our fetches to Reddit
|
2020-06-02 21:20:31 +00:00
|
|
|
let endpoints = {
|
|
|
|
revisions: `https://old.reddit.com/r/${WIKI_SUBREDDIT}/wiki/revisions/${WIKI_PAGE}.json`,
|
|
|
|
token: 'https://www.reddit.com/api/v1/access_token',
|
|
|
|
edit: `https://oauth.reddit.com/r/${WIKI_SUBREDDIT}/api/wiki/edit`
|
|
|
|
};
|
2020-06-05 14:06:59 +00:00
|
|
|
|
|
|
|
// Initial basic authorization for getting the Oauth token
|
2020-06-02 21:20:31 +00:00
|
|
|
let basicAuth = `Basic ${Buffer.from(REDDIT_CLIENT_ID + ':' + REDDIT_CLIENT_SECRET).toString('base64')}`;
|
|
|
|
|
2020-06-05 14:06:59 +00:00
|
|
|
let lastId, token;
|
2020-06-08 14:01:10 +00:00
|
|
|
|
2020-06-05 14:06:59 +00:00
|
|
|
getLastRevision(endpoints.revisions)
|
|
|
|
.then((mLastId) => lastId = mLastId)
|
|
|
|
.then(() => getToken(endpoints.token, basicAuth))
|
|
|
|
.then((mToken) => token = mToken)
|
|
|
|
.then(() => putWiki(endpoints.edit, lastId, token))
|
|
|
|
.catch((err) => (console.error(err), process.exit(1)));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the last revision ID on the Wiki. Required otherwise editing the wiki fails
|
|
|
|
* @param {String} endpoint Endpoint of where to get the ID's
|
|
|
|
*/
|
|
|
|
function getLastRevision(endpoint) {
|
|
|
|
return new Promise((resolve, reject) => {
|
|
|
|
fetch(endpoint)
|
|
|
|
.then((response) => response.json())
|
|
|
|
.then((json) => json.data.children[0].id) // children[0] is the most recent edit
|
|
|
|
.then((lastId) => resolve(lastId))
|
|
|
|
.catch((err) => reject(err));
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets an Oauth token used to edit the Wiki
|
|
|
|
* @param {String} endpoint Endpoint of where to get the token
|
|
|
|
* @param {String} auth Initial authorization data to get the better Oauth data
|
|
|
|
*/
|
|
|
|
function getToken(endpoint, auth) {
|
|
|
|
return new Promise((resolve, reject) => {
|
|
|
|
fetch(endpoint, {
|
2020-06-02 21:20:31 +00:00
|
|
|
method: 'POST',
|
2020-06-05 14:06:59 +00:00
|
|
|
headers: { 'Authorization': auth, 'Content-Type': CONTENT_TYPE },
|
2020-06-02 21:20:31 +00:00
|
|
|
body: qs.stringify({ grant_type: 'password', username: REDDIT_USER, password: REDDIT_PASS })
|
2020-06-05 14:06:59 +00:00
|
|
|
})
|
|
|
|
.then((response) => response.json())
|
|
|
|
.then((json) => json.access_token)
|
|
|
|
.then((token) => resolve(token))
|
|
|
|
.catch((err) => reject(err));
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Post the contents from the README into the wiki
|
|
|
|
* @param {String} endpoint Endpoint for editing the wiki
|
|
|
|
* @param {String} lastId Revision ID for the Wiki
|
|
|
|
* @param {String} token Oauth token for authenticating with the Reddit API
|
|
|
|
*/
|
|
|
|
function putWiki(endpoint, lastId, token) {
|
|
|
|
return new Promise((resolve, reject) => {
|
|
|
|
fetch(endpoint, {
|
2020-06-02 21:20:31 +00:00
|
|
|
method: 'POST',
|
2020-06-05 14:06:59 +00:00
|
|
|
headers: { 'Authorization': `bearer ${token}`, 'Content-Type': CONTENT_TYPE },
|
2020-06-02 21:20:31 +00:00
|
|
|
body: qs.stringify({
|
2020-06-05 14:30:23 +00:00
|
|
|
content: fixContent(fs.readFileSync(path.join(__dirname, 'README.md')).toString()),
|
2020-06-02 21:20:31 +00:00
|
|
|
page: WIKI_PAGE,
|
|
|
|
reason: WIKI_REASON,
|
|
|
|
previous: lastId
|
|
|
|
})
|
2020-06-05 14:06:59 +00:00
|
|
|
})
|
|
|
|
.then((response) => response.json())
|
|
|
|
.then((json) => {
|
|
|
|
if (Object.keys(json).length == 0) resolve();
|
|
|
|
else throw Error(json);
|
|
|
|
})
|
|
|
|
.catch((err) => reject(err));
|
|
|
|
});
|
2020-06-03 22:40:34 +00:00
|
|
|
}
|
2020-06-05 14:30:23 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Fixes certain images to only show text on the Reddit wiki
|
|
|
|
* @param {String} content The content in README.md
|
|
|
|
*/
|
|
|
|
function fixContent(content) {
|
|
|
|
// Fix updated timestamp
|
2020-06-05 14:34:26 +00:00
|
|
|
content = content.replace(/\!\[Updated\](.*?)square\)/g, `#### Updated: ${moment().format('MMMM Do YYYY')}`);
|
2020-06-05 14:30:23 +00:00
|
|
|
|
|
|
|
// Fix published timestamps
|
|
|
|
content = content.replace(/\!\[Published\]\(https\:\/\/img\.shields\.io\/badge\//g, '**');
|
|
|
|
content = content.replace(/-informational\?style=flat-square\)/g, '**');
|
|
|
|
|
|
|
|
return content;
|
|
|
|
}
|