New functions

Organized the scripts in subfolders, coded unit-tests, removed unused files, added function:
+ for get user-data (when logged) like avatar and watched threads
+ parse download link of the games (depends on the OS used)
pull/4/head
MillenniumEarl 2020-10-01 21:13:23 +02:00
parent 331dc930b1
commit 0773f77c2c
16 changed files with 697 additions and 597 deletions

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"configurations": [
{
"type": "node-terminal",
"name": "Run Script: test",
"request": "launch",
"command": "npm run test",
"cwd": "${workspaceFolder}"
}
]
}

View File

@ -1,53 +1,27 @@
'use strict'; 'use strict';
const path = require('path');
// Core modules
const fs = require('fs'); const fs = require('fs');
const UserData = require('./scripts/user-data').UserData; const path = require('path');
const LoginResult = require('./scripts/login-result').LoginResult;
const GameInfo = require('./scripts/game-info').GameInfo; // Public modules from npm
const GameDownload = require('./scripts/game-download').GameDownload;
const HTMLParser = require('node-html-parser');
const puppeteer = require('puppeteer');
const urlExist = require('url-exist'); const urlExist = require('url-exist');
//#region URL // Modules from file
const F95_BASE_URL = 'https://f95zone.to'; const shared = require('./scripts/shared.js');
const F95_SEARCH_URL = 'https://f95zone.to/search'; const constURLs = require('./scripts/costants/urls.js');
const F95_LATEST_UPDATES = 'https://f95zone.to/latest'; const constSelectors = require('./scripts/costants/css-selectors.js');
const F95_LOGIN_URL = 'https://f95zone.to/login'; const {
const F95_WATCHED_THREADS = 'https://f95zone.to/watched/threads'; isStringAValidURL
//#endregion } = require('./scripts/urls-helper.js');
const gameScraper = require('./scripts/game-scraper.js');
//#region CSS Selectors const {
const SEARCH_FORM_TEXTBOX = 'input[name="keywords"]'; prepareBrowser,
const PASSWORD_INPUT = 'input[name="password"]'; preparePage
const USERNAME_INPUT = 'input[name="login"]'; } = require('./scripts/puppeteer-helper.js');
const LOGIN_BUTTON = 'button.button--icon--login'; const GameInfo = require('./scripts/classes/game-info.js').GameInfo;
const AVATAR_INFO = 'span.avatar'; const LoginResult = require('./scripts/classes/login-result.js').LoginResult;
const TITLE_ONLY_CHECKBOX = 'form.block > * input[name="c[title_only]"]'; const UserData = require('./scripts/classes/user-data.js').UserData;
const SEARCH_BUTTON = 'form.block > * button.button--icon--search';
const ENGINE_ID_SELECTOR = 'div[id^="btn-prefix_1_"]>span';
const STATUS_ID_SELECTOR = 'div[id^="btn-prefix_4_"]>span';
const THREAD_TITLE = 'h3.contentRow-title';
const THREAD_POSTS = 'article.message-body:first-child > div.bbWrapper:first-of-type';
const GAME_TITLE = 'h1.p-title-value';
const GAME_IMAGES = 'img[src^="https://attachments.f95zone.to"]';
const LOGIN_MESSAGE_ERROR = 'div.blockMessage.blockMessage--error.blockMessage--iconic';
const GAME_TAGS = 'a.tagItem';
const USERNAME_ELEMENT = 'a[href="/account/"] > span.p-navgroup-linkText';
const AVATAR_PIC = 'a[href="/account/"] > span.avatar > img[class^="avatar"]';
const UNREAD_THREAD_CHECKBOX = 'input[type="checkbox"][name="unread"]';
const ONLY_GAMES_THREAD_OPTION = 'select[name="nodes[]"] > option[value="2"]';
const FILTER_THREADS_BUTTON = 'button[class="button--primary button"]';
const GAME_TITLE_PREFIXES = 'h1.p-title-value > a.labelLink > span[dir="auto"]';
const WATCHED_THREAD_URLS = 'a[href^="/threads/"][data-tp-primary]';
const WATCHED_THREAD_NEXT_PAGE = 'a.pageNav-jump--next';
const WATCHED_THREAD_FILTER_POPUP_BUTTON = 'a.filterBar-menuTrigger';
//#endregion CSS Selectors
//#region Game prefixes
const MOD_PREFIX = 'MOD';
const GAME_RECOMMENDATION_PREFIX = 'RECOMMENDATION';
//#endregion Game prefixes
//#region Directories //#region Directories
const CACHE_PATH = './f95cache'; const CACHE_PATH = './f95cache';
@ -59,49 +33,18 @@ const STATUSES_SAVE_PATH = path.join(CACHE_PATH, 'statuses.json');
if (!fs.existsSync(CACHE_PATH)) fs.mkdirSync(CACHE_PATH); if (!fs.existsSync(CACHE_PATH)) fs.mkdirSync(CACHE_PATH);
//#endregion Directories //#endregion Directories
//#region Various //#region Exposed properties
const WAIT_STATEMENT = 'domcontentloaded';
//#endregion Various
//#region Fields
/**
* @private
* @type Object[]
*/
let _cookies = loadCookies();
/**
* @private
* @type String[]
*/
let _engines = null;
/**
* @private
* @type String[]
*/
let _statuses = null;
/** @private
* @type Boolean
*/
let _isLogged = false;
/**
* @private
* @type Boolean
*/
let _debug = false;
//#endregion Fields
//#region Properties
/** /**
* *
* @param {Boolean} value * @param {Boolean} value
*/ */
module.exports.debug = function (value) { module.exports.debug = function (value) {
_debug = value; shared.debug = value;
} }
module.exports.isLogged = function () { module.exports.isLogged = function () {
return _isLogged; return shared.isLogged;
}; };
//#endregion Properties //#endregion Exposed properties
//#region Export methods //#region Export methods
/** /**
@ -113,8 +56,8 @@ module.exports.isLogged = function () {
* @returns {Promise<LoginResult>} Result of the operation * @returns {Promise<LoginResult>} Result of the operation
*/ */
module.exports.login = async function (username, password) { module.exports.login = async function (username, password) {
if (_isLogged) { if (shared.isLogged) {
if (_debug) console.log("Already logged in"); if (shared.debug) console.log("Already logged in");
let result = new LoginResult(); let result = new LoginResult();
result.success = true; result.success = true;
result.message = 'Already logged in'; result.message = 'Already logged in';
@ -122,9 +65,10 @@ module.exports.login = async function (username, password) {
} }
// If cookies are loaded, use them to authenticate // If cookies are loaded, use them to authenticate
if (_cookies !== null) { shared.cookies = loadCookies();
if (_debug) console.log('Valid session, no need to re-authenticate'); if (shared.cookies !== null) {
_isLogged = true; if (shared.debug) console.log('Valid session, no need to re-authenticate');
shared.isLogged = true;
let result = new LoginResult(); let result = new LoginResult();
result.success = true; result.success = true;
result.message = 'Logged with cookies'; result.message = 'Logged with cookies';
@ -132,15 +76,15 @@ module.exports.login = async function (username, password) {
} }
// Else, log in throught browser // Else, log in throught browser
if (_debug) console.log('No saved sessions or expired session, login on the platform'); if (shared.debug) console.log('No saved sessions or expired session, login on the platform');
let browser = await prepareBrowser(); let browser = await prepareBrowser();
let result = await loginF95(browser, username, password); let result = await loginF95(browser, username, password);
_isLogged = result.success; shared.isLogged = result.success;
if (result.success) { if (result.success) {
// Reload cookies // Reload cookies
_cookies = loadCookies(); shared.cookies = loadCookies();
if (_debug) console.log('User logged in through the platform'); if (shared.debug) console.log('User logged in through the platform');
} else { } else {
console.warn('Error during authentication: ' + result.message); console.warn('Error during authentication: ' + result.message);
} }
@ -155,33 +99,39 @@ module.exports.login = async function (username, password) {
* @returns {Promise<Boolean>} Result of the operation * @returns {Promise<Boolean>} Result of the operation
*/ */
module.exports.loadF95BaseData = async function () { module.exports.loadF95BaseData = async function () {
if (!_isLogged) { if (!shared.isLogged) {
console.warn('User not authenticated, unable to continue'); console.warn('User not authenticated, unable to continue');
return false; return false;
} }
if (_debug) console.log('Loading base data...'); if (shared.debug) console.log('Loading base data...');
// Prepare a new web page // Prepare a new web page
let browser = await prepareBrowser(); let browser = await prepareBrowser();
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.setCookie(..._cookies); // Set cookies to avoid login await page.setCookie(...shared.cookies); // Set cookies to avoid login
// Go to latest update page and wait for it to load // Go to latest update page and wait for it to load
await page.goto(F95_LATEST_UPDATES, { await page.goto(constURLs.F95_LATEST_UPDATES, {
waitUntil: WAIT_STATEMENT waitUntil: shared.WAIT_STATEMENT
}); });
// Obtain engines (disc/online) // Obtain engines (disc/online)
await page.waitForSelector(ENGINE_ID_SELECTOR); await page.waitForSelector(constSelectors.ENGINE_ID_SELECTOR);
_engines = await loadValuesFromLatestPage(page, ENGINES_SAVE_PATH, ENGINE_ID_SELECTOR, 'engines'); shared.engines = await loadValuesFromLatestPage(page,
ENGINES_SAVE_PATH,
constSelectors.ENGINE_ID_SELECTOR,
'engines');
// Obtain statuses (disc/online) // Obtain statuses (disc/online)
await page.waitForSelector(STATUS_ID_SELECTOR); await page.waitForSelector(constSelectors.STATUS_ID_SELECTOR);
_statuses = await loadValuesFromLatestPage(page, STATUSES_SAVE_PATH, STATUS_ID_SELECTOR, 'statuses'); shared.statuses = await loadValuesFromLatestPage(page,
STATUSES_SAVE_PATH,
constSelectors.STATUS_ID_SELECTOR,
'statuses');
await browser.close(); await browser.close();
if (_debug) console.log('Base data loaded'); if (shared.debug) console.log('Base data loaded');
return true; return true;
} }
/** /**
@ -192,7 +142,7 @@ module.exports.loadF95BaseData = async function () {
* @returns {Promise<String>} Currently online version of the specified game * @returns {Promise<String>} Currently online version of the specified game
*/ */
module.exports.getGameVersion = async function (info) { module.exports.getGameVersion = async function (info) {
if (!_isLogged) { if (!shared.isLogged) {
console.warn('user not authenticated, unable to continue'); console.warn('user not authenticated, unable to continue');
return info.version; return info.version;
} }
@ -213,20 +163,20 @@ module.exports.getGameVersion = async function (info) {
* an identified game (in the case of homonymy). If no games were found, null is returned * an identified game (in the case of homonymy). If no games were found, null is returned
*/ */
module.exports.getGameData = async function (name, includeMods) { module.exports.getGameData = async function (name, includeMods) {
if (!_isLogged) { if (!shared.isLogged) {
console.warn('user not authenticated, unable to continue'); console.warn('user not authenticated, unable to continue');
return null; return null;
} }
// Gets the search results of the game being searched for // Gets the search results of the game being searched for
let browser = await prepareBrowser(); let browser = await prepareBrowser();
let urlList = await getSearchGameResults(browser, name, _cookies); let urlList = await getSearchGameResults(browser, name);
// Process previous partial results // Process previous partial results
let promiseList = []; let promiseList = [];
for (let url of urlList) { for (let url of urlList) {
// Start looking for information // Start looking for information
promiseList.push(getGameInfo(browser, url)); promiseList.push(gameScraper.getGameInfo(browser, url));
} }
// Filter for mods // Filter for mods
@ -240,30 +190,13 @@ module.exports.getGameData = async function (name, includeMods) {
await browser.close(); await browser.close();
return result; return result;
} }
/**
* @deprecated
* @public
* @param {*} platform
* @param {*} url
*/
module.exports.getDownloadLink = async function (platform, url) {
if (!_isLogged) {
console.warn('user not authenticated, unable to continue');
return null;
}
// Gets the search results of the game being searched for
let browser = await prepareBrowser();
getGameDownloadLink(browser, url);
await browser.close();
}
/** /**
* @public * @public
* Gets the data of the currently logged in user. * Gets the data of the currently logged in user.
* @returns {Promise<UserData>} Data of the user currently logged in or null if an error arise * @returns {Promise<UserData>} Data of the user currently logged in or null if an error arise
*/ */
module.exports.getUserData = async function () { module.exports.getUserData = async function () {
if (!_isLogged) { if (!shared.isLogged) {
console.warn('user not authenticated, unable to continue'); console.warn('user not authenticated, unable to continue');
return null; return null;
} }
@ -271,22 +204,22 @@ module.exports.getUserData = async function () {
// Prepare a new web page // Prepare a new web page
let browser = await prepareBrowser(); let browser = await prepareBrowser();
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.setCookie(..._cookies); // Set cookies to avoid login await page.setCookie(...shared.cookies); // Set cookies to avoid login
await page.goto(F95_BASE_URL); // Go to base page await page.goto(constURLs.F95_BASE_URL); // Go to base page
// Explicitly wait for the required items to load // Explicitly wait for the required items to load
await page.waitForSelector(USERNAME_ELEMENT); await page.waitForSelector(constSelectors.USERNAME_ELEMENT);
await page.waitForSelector(AVATAR_PIC); await page.waitForSelector(constSelectors.AVATAR_PIC);
let threads = getUserWatchedGameThreads(browser); let threads = getUserWatchedGameThreads(browser);
let username = await page.evaluate((selector) => let username = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector).innerText, document.querySelector(selector).innerText,
USERNAME_ELEMENT); constSelectors.USERNAME_ELEMENT);
let avatarSrc = await page.evaluate((selector) => let avatarSrc = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector).getAttribute('src'), document.querySelector(selector).getAttribute('src'),
AVATAR_PIC); constSelectors.AVATAR_PIC);
let ud = new UserData(); let ud = new UserData();
ud.username = username; ud.username = username;
@ -298,55 +231,13 @@ module.exports.getUserData = async function () {
return ud; return ud;
} }
module.exports.logout = function() {
shared.isLogged = false;
}
//#endregion //#endregion
//#region Private methods //#region Private methods
//#region Puppeteer helpers
/**
* @private
* Create a Chromium instance used to navigate with Puppeteer.
* By default the browser is headless.
* @returns {Promise<puppeteer.Browser>} Created browser
*/
async function prepareBrowser() {
// Create a headless browser
let browser = await puppeteer.launch({
headless: false,
});
return browser;
}
/**
* @private
* Prepare a page used to navigate the browser.
* The page is set up to reject image download requests. The user agent is also changed.
* @param {puppeteer.Browser} browser Browser to use when navigating where the page will be created
* @returns {Promise<puppeteer.Page>} New page
*/
async function preparePage(browser) {
// Create new page in the browser argument
let page = await browser.newPage();
// Block image download
await page.setRequestInterception(true);
page.on('request', (request) => {
if (request.resourceType() === 'image') request.abort();
// else if(request.resourceType == 'font') request.abort();
// else if(request.resourceType == 'media') request.abort();
else request.continue();
});
// Set custom user-agent
let userAgent = 'Mozilla/5.0 (X11; Linux x86_64)' +
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.39 Safari/537.36';
await page.setUserAgent(userAgent);
return page;
}
//#endregion
//#region Cookies functions //#region Cookies functions
/** /**
* @private * @private
@ -371,7 +262,6 @@ function loadCookies() {
} else return null; } else return null;
} }
/** /**
* @private * @private
* Check the validity of a cookie. * Check the validity of a cookie.
@ -390,7 +280,7 @@ function isCookieExpired(cookie) {
let expirationDate = new Date(expirationUnixTimestamp * 1000); let expirationDate = new Date(expirationUnixTimestamp * 1000);
if (expirationDate < Date.now()) { if (expirationDate < Date.now()) {
if (_debug) console.log('Cookie ' + cookie['name'] + ' expired, you need to re-authenticate'); if (shared.debug) console.log('Cookie ' + cookie['name'] + ' expired, you need to re-authenticate');
expiredCookies = true; expiredCookies = true;
} }
} }
@ -413,19 +303,18 @@ function isCookieExpired(cookie) {
*/ */
async function loadValuesFromLatestPage(page, path, selector, elementRequested) { async function loadValuesFromLatestPage(page, path, selector, elementRequested) {
// If the values already exist they are loaded from disk without having to connect to F95 // If the values already exist they are loaded from disk without having to connect to F95
if (_debug) console.log('Load ' + elementRequested + ' from disk...'); if (shared.debug) console.log('Load ' + elementRequested + ' from disk...');
if (fs.existsSync(path)) { if (fs.existsSync(path)) {
let valueJSON = fs.readFileSync(path); let valueJSON = fs.readFileSync(path);
return JSON.parse(valueJSON); return JSON.parse(valueJSON);
} }
// Otherwise, connect and download the data from the portal // Otherwise, connect and download the data from the portal
if (_debug) console.log('No ' + elementRequested + ' cached, downloading...'); if (shared.debug) console.log('No ' + elementRequested + ' cached, downloading...');
let values = await getValuesFromLatestPage(page, selector, 'Getting ' + elementRequested + ' from page'); let values = await getValuesFromLatestPage(page, selector, 'Getting ' + elementRequested + ' from page');
fs.writeFileSync(path, JSON.stringify(values)); fs.writeFileSync(path, JSON.stringify(values));
return values; return values;
} }
/** /**
* @private * @private
* Gets all the textual values of the elements present * Gets all the textual values of the elements present
@ -437,13 +326,13 @@ async function loadValuesFromLatestPage(page, path, selector, elementRequested)
* @return {Promise<String[]>} List of uppercase strings indicating the textual values of the elements identified by the selector * @return {Promise<String[]>} List of uppercase strings indicating the textual values of the elements identified by the selector
*/ */
async function getValuesFromLatestPage(page, selector, logMessage) { async function getValuesFromLatestPage(page, selector, logMessage) {
if (_debug) console.log(logMessage); if (shared.debug) console.log(logMessage);
let result = []; let result = [];
let elements = await page.$$(selector); let elements = await page.$$(selector);
for (let element of elements) { for (let element of elements) {
let text = await element.evaluate(e => e.innerText); let text = await element.evaluate( /* istanbul ignore next */ e => e.innerText);
// Save as upper text for better match if used in query // Save as upper text for better match if used in query
result.push(text.toUpperCase()); result.push(text.toUpperCase());
@ -452,34 +341,6 @@ async function getValuesFromLatestPage(page, selector, logMessage) {
} }
//#endregion //#endregion
//#region URL methods
/**
* @private
* Check if the url belongs to the domain of the F95 platform.
* @param {URL} url URL to check
* @returns {Boolean} true if the url belongs to the domain, false otherwise
*/
function isF95URL(url) {
if (url.toString().startsWith(F95_BASE_URL)) return true;
else return false;
}
/**
* @private
* Checks if the string passed by parameter has a properly formatted and valid path to a URL.
* @param {String} url String to check for correctness
* @returns {Boolean} true if the string is a valid URL, false otherwise
*/
function isStringAValidURL(url) {
try {
new URL(url);
return true;
} catch (err) {
return false;
}
}
//#endregion
//#region User //#region User
/** /**
* @private * @private
@ -491,46 +352,52 @@ function isStringAValidURL(url) {
*/ */
async function loginF95(browser, username, password) { async function loginF95(browser, username, password) {
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.goto(F95_LOGIN_URL); // Go to login page await page.goto(constURLs.F95_LOGIN_URL); // Go to login page
// Explicitly wait for the required items to load // Explicitly wait for the required items to load
await page.waitForSelector(USERNAME_INPUT); await page.waitForSelector(constSelectors.USERNAME_INPUT);
await page.waitForSelector(PASSWORD_INPUT); await page.waitForSelector(constSelectors.PASSWORD_INPUT);
await page.waitForSelector(LOGIN_BUTTON); await page.waitForSelector(constSelectors.LOGIN_BUTTON);
await page.type(USERNAME_INPUT, username); // Insert username await page.type(constSelectors.USERNAME_INPUT, username); // Insert username
await page.type(PASSWORD_INPUT, password); // Insert password await page.type(constSelectors.PASSWORD_INPUT, password); // Insert password
await Promise.all([ await page.click(constSelectors.LOGIN_BUTTON); // Click on the login button
page.click(LOGIN_BUTTON), // Click on the login button await page.waitForNavigation({
page.waitForNavigation({ waitUntil: shared.WAIT_STATEMENT
waitUntil: WAIT_STATEMENT }); // Wait for page to load
}), // Wait for page to load
]);
await page.waitForSelector(AVATAR_INFO);
// Prepare result // Prepare result
let result = new LoginResult(); let result = new LoginResult();
// Check if the user is logged in // Check if the user is logged in
result.success = await page.evaluate((selector) => document.querySelector(selector) !== null, AVATAR_INFO); result.success = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector) !== null,
constSelectors.AVATAR_INFO);
// Save cookies to avoid re-auth // Save cookies to avoid re-auth
if (result.success) { if (result.success) {
const cookies = await page.cookies(); let c = await page.cookies();
fs.writeFileSync(COOKIES_SAVE_PATH, JSON.stringify(cookies)); fs.writeFileSync(COOKIES_SAVE_PATH, JSON.stringify(c));
result.message = 'Authentication successful'; result.message = 'Authentication successful';
} }
// Obtain the error message // Obtain the error message
else if (await page.evaluate((selector) => document.querySelector(selector) !== null, LOGIN_MESSAGE_ERROR)) { else if (await page.evaluate( /* istanbul ignore next */ (selector) =>
let errorMessage = await page.evaluate((selector) => document.querySelector(selector).innerText, LOGIN_MESSAGE_ERROR); document.querySelector(selector) !== null,
if (errorMessage === 'Incorrect password. Please try again.') result.message = 'Incorrect password'; constSelectors.LOGIN_MESSAGE_ERROR)) {
else if (errorMessage === "The requested user '" + username + "' could not be found.") result.message = 'Incorrect username'; let errorMessage = await page.evaluate( /* istanbul ignore next */ (selector) =>
else result.message = errorMessage; document.querySelector(selector).innerText,
} else result.message = "Unknown error"; constSelectors.LOGIN_MESSAGE_ERROR);
await page.close(); // Close the page
if (errorMessage === 'Incorrect password. Please try again.') {
result.message = 'Incorrect password';
} else if (errorMessage === "The requested user '" + username + "' could not be found.") {
result.message = 'Incorrect username';
} else result.message = errorMessage;
} else result.message = "Unknown error";
await page.close(); // Close the page
return result; return result;
} }
/** /**
* @private * @private
* Gets the list of URLs of threads the user follows. * Gets the list of URLs of threads the user follows.
@ -539,48 +406,48 @@ async function loginF95(browser, username, password) {
*/ */
async function getUserWatchedGameThreads(browser) { async function getUserWatchedGameThreads(browser) {
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.goto(F95_WATCHED_THREADS); // Go to the thread page await page.goto(constURLs.F95_WATCHED_THREADS); // Go to the thread page
// Explicitly wait for the required items to load // Explicitly wait for the required items to load
await page.waitForSelector(WATCHED_THREAD_FILTER_POPUP_BUTTON); await page.waitForSelector(constSelectors.WATCHED_THREAD_FILTER_POPUP_BUTTON);
// Show the popup // Show the popup
await page.click(WATCHED_THREAD_FILTER_POPUP_BUTTON); await page.click(constSelectors.WATCHED_THREAD_FILTER_POPUP_BUTTON);
await page.waitForSelector(UNREAD_THREAD_CHECKBOX); await page.waitForSelector(constSelectors.UNREAD_THREAD_CHECKBOX);
await page.waitForSelector(ONLY_GAMES_THREAD_OPTION); await page.waitForSelector(constSelectors.ONLY_GAMES_THREAD_OPTION);
await page.waitForSelector(FILTER_THREADS_BUTTON); await page.waitForSelector(constSelectors.FILTER_THREADS_BUTTON);
// Set the filters // Set the filters
await page.evaluate((selector) => await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector).removeAttribute('checked'), document.querySelector(selector).removeAttribute('checked'),
UNREAD_THREAD_CHECKBOX); // Also read the threads already read constSelectors.UNREAD_THREAD_CHECKBOX); // Also read the threads already read
await page.click(ONLY_GAMES_THREAD_OPTION); await page.click(constSelectors.ONLY_GAMES_THREAD_OPTION);
// Filter the threads // Filter the threads
await page.click(FILTER_THREADS_BUTTON); await page.click(constSelectors.FILTER_THREADS_BUTTON);
await page.waitForSelector(WATCHED_THREAD_URLS); await page.waitForSelector(constSelectors.WATCHED_THREAD_URLS);
// Get the threads urls // Get the threads urls
let urls = []; let urls = [];
let nextPageExists = false; let nextPageExists = false;
do { do {
// Get all the URLs // Get all the URLs
for (let handle of await page.$$(WATCHED_THREAD_URLS)) { for (let handle of await page.$$(constSelectors.WATCHED_THREAD_URLS)) {
let src = await page.evaluate((element) => element.href, handle); let src = await page.evaluate( /* istanbul ignore next */ (element) => element.href, handle);
// If 'unread' is left, it will redirect to the last unread post // If 'unread' is left, it will redirect to the last unread post
let url = new URL(src.replace('/unread', '')); let url = new URL(src.replace('/unread', ''));
urls.push(url); urls.push(url);
} }
nextPageExists = await page.evaluate((selector) => nextPageExists = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector), document.querySelector(selector),
WATCHED_THREAD_NEXT_PAGE); constSelectors.WATCHED_THREAD_NEXT_PAGE);
// Click to next page // Click to next page
if (nextPageExists) { if (nextPageExists) {
await page.click(WATCHED_THREAD_NEXT_PAGE); await page.click(constSelectors.WATCHED_THREAD_NEXT_PAGE);
await page.waitForSelector(WATCHED_THREAD_URLS); await page.waitForSelector(constSelectors.WATCHED_THREAD_URLS);
} }
} }
while (nextPageExists); while (nextPageExists);
@ -590,234 +457,6 @@ async function getUserWatchedGameThreads(browser) {
} }
//#endregion User //#endregion User
//#region Game data parser
/**
* @private
* Get information from the game's main page.
* @param {puppeteer.Browser} browser Browser object used for navigation
* @param {URL} url URL of the game/mod to extract data from
* @return {Promise<GameInfo>} Complete information about the game you are looking for
*/
async function getGameInfo(browser, url) {
if (_debug) console.log('Obtaining game info');
// Verify the correctness of the URL
if (!isF95URL(url)) throw url + ' is not a valid F95Zone URL';
let exists = await urlExist(url.toString());
if (!exists) return new GameInfo();
let page = await preparePage(browser); // Set new isolated page
await page.setCookie(..._cookies); // Set cookies to avoid login
await page.goto(url.toString(), {
waitUntil: WAIT_STATEMENT
}); // Go to the game page and wait until it loads
// Object to fill with information
let info = new GameInfo();
// Get the game/mod name (without square brackets)
let title = getGameTitle(page);
// Get the game/mod author (without square brackets)
let author = getGameAuthor(page);
// Get the game tags
let tags = getGameTags(page);
// Get the game title image (the first is what we are searching)
let previewSource = await getGamePreviewSource(page);
if (previewSource === null) console.warn('Cannot find game preview image for ' + await title);
// Parse the prefixes
info = await parsePrefixes(page, info); // Fill status/engines/isMod
// Gets the first post, where are listed all the game's informations
let post = (await page.$$(THREAD_POSTS))[0];
// The info are plain text so we need to parse the HTML code
let bodyHTML = await page.evaluate((mainPost) => mainPost.innerHTML, post);
let structuredText = HTMLParser.parse(bodyHTML).structuredText;
// Get overview (different parsing for game and mod)
let overviewEndIndex;
if (info.isMod) overviewEndIndex = structuredText.indexOf('Updated');
else overviewEndIndex = structuredText.indexOf('Thread Updated');
let overview = structuredText.substring(0, overviewEndIndex).replace('Overview:\n', '').trim();
// Parse all the information in the format DESCRIPTION : VALUE
let parsedInfos = parseConversationPage(structuredText);
// Fill in the GameInfo element with the information obtained
info.name = await title;
info.author = await author;
info.overview = overview;
info.tags = await tags;
info.f95url = url;
info.version = info.isMod ? parsedInfos['MOD VERSION'] : parsedInfos['VERSION'];
info.lastUpdate = info.isMod ? parsedInfos['UPDATED'] : parsedInfos['THREAD UPDATED'];
info.previewSource = previewSource;
await page.close(); // Close the page
if (_debug) console.log('Founded data for ' + info.name);
return info;
}
/**
* @private
* Extrapolates and cleans the author from the page passed by parameter.
* @param {puppeteer.Page} page Page containing the author to be extrapolated
* @returns {Promise<String>} Game author
*/
async function getGameAuthor(page) {
// Get the game/mod name (without square brackets)
let titleHTML = await page.evaluate((selector) => document.querySelector(selector).innerHTML, GAME_TITLE);
let structuredTitle = HTMLParser.parse(titleHTML);
// The last element **shoud be** the title without prefixes (engines, status, other...)
let gameTitle = structuredTitle.childNodes.pop().rawText;
// The last square brackets contain the author
let startTitleIndex = gameTitle.lastIndexOf('[') + 1;
return gameTitle.substring(startTitleIndex, gameTitle.length - 1).trim();
}
/**
* @private
* Process the post text to get all the useful
* information in the format *DESCRIPTOR : VALUE*.
* @param {String} text Structured text of the post
* @returns {Object} Dictionary of information
*/
function parseConversationPage(text) {
let dataPairs = {};
// The information searched in the game post are one per line
let splittedText = text.split('\n');
for (let line of splittedText) {
if (!line.includes(':')) continue;
// Create pair key/value
let splitted = line.split(':');
let key = splitted[0].trim().toUpperCase(); // Uppercase to avoid mismatch
let value = splitted[1].trim();
// Add pair to the dict if valid
if (value != '') dataPairs[key] = value;
}
return dataPairs;
}
/**
* @private
* Gets the URL of the image used as a preview for the game in the conversation.
* @param {puppeteer.Page} page Page containing the URL to be extrapolated
* @returns {Promise<URL>} URL of the image or null if failed to get it
*/
async function getGamePreviewSource(page) {
let src = await page.evaluate((selector) => {
// Get the firs image available
let img = document.querySelector(selector);
if (img === null || img === undefined) return null;
else return img.getAttribute('src');
}, GAME_IMAGES);
// Check if the URL is valid
return isStringAValidURL(src) ? new URL(src) : null;
}
/**
* @private
* Extrapolates and cleans the title from the page passed by parameter.
* @param {puppeteer.Page} page Page containing the title to be extrapolated
* @returns {Promise<String>} Game title
*/
async function getGameTitle(page) {
// Get the game/mod name (without square brackets)
const titleHTML = await page.evaluate((selector) => document.querySelector(selector).innerHTML, GAME_TITLE);
const structuredTitle = HTMLParser.parse(titleHTML);
// The last element **shoud be** the title without prefixes (engines, status, other...)
let gameTitle = structuredTitle.childNodes.pop().rawText;
const endTitleIndex = gameTitle.indexOf('[');
return gameTitle.substring(0, endTitleIndex).trim();
}
/**
* @private
* Get the list of tags associated with the game.
* @param {puppeteer.Page} page Page containing the tags to be extrapolated
* @returns {Promise<String[]>} List of uppercase tags
*/
async function getGameTags(page) {
let tags = [];
// Get the game tags
for (let handle of await page.$$(GAME_TAGS)) {
let tag = await page.evaluate((element) => element.innerText, handle);
tags.push(tag.toUpperCase());
}
return tags;
}
/**
* @private
* Process the game title prefixes to extract information such as game status,
* graphics engine used, and whether it is a mod or original game.
* @param {puppeteer.Page} page Page containing the prefixes to be extrapolated
* @param {GameInfo} info Object to assign the identified information to
* @returns {Promise<GameInfo>} GameInfo object passed in to which the identified information has been added
*/
async function parsePrefixes(page, info) {
// The 'Ongoing' status is not specified, only 'Abandoned'/'OnHold'/'Complete'
info.status = 'Ongoing';
for (let handle of await page.$$(GAME_TITLE_PREFIXES)) {
let value = await page.evaluate((element) => element.innerText, handle);
// Clean the prefix
let prefix = value.toUpperCase().replace('[', '').replace(']', '').trim();
// Getting infos...
if (_statuses.includes(prefix)) info.status = prefix;
else if (_engines.includes(prefix)) info.engine = prefix;
// This is not a game but a mod
else if (prefix === MOD_PREFIX) info.isMod = true;
}
return info;
}
/**
* @deprecated
* @param {puppeteer.Browser} browser
* @param {URL} url
*/
async function getGameDownloadLink(browser, url) {
// Verify the correctness of the URL
if (!isF95URL(url)) throw url + ' is not a valid F95Zone URL';
let exists = await urlExist(url.toString());
if (!exists) return new GameDownload();
let page = await preparePage(browser); // Set new isolated page
await page.setCookie(..._cookies); // Set cookies to avoid login
await page.goto(url.toString(), {
waitUntil: WAIT_STATEMENT
}); // Go to the game page and wait until it loads
// Gets the first post, where are listed all the game's informations
let post = (await page.$$(THREAD_POSTS))[0];
// Get the HTML text
let postHTML = await page.evaluate((mainPost) => mainPost.innerHTML, post);
let startIndex = postHTML.indexOf('DOWNLOAD');
let endIndex = postHTML.indexOf('class="js-lbImage"');
postHTML = postHTML.substring(startIndex, endIndex - startIndex);
console.log(postHTML);
}
//#endregion Game data parser
//#region Game search //#region Game search
/** /**
* @private * @private
@ -827,33 +466,31 @@ async function getGameDownloadLink(browser, url) {
* @returns {Promise<URL[]>} List of URL of possible games obtained from the preliminary research on the F95 portal * @returns {Promise<URL[]>} List of URL of possible games obtained from the preliminary research on the F95 portal
*/ */
async function getSearchGameResults(browser, gamename) { async function getSearchGameResults(browser, gamename) {
if (_debug) console.log('Searching ' + gamename + ' on F95Zone'); if (shared.debug) console.log('Searching ' + gamename + ' on F95Zone');
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.setCookie(..._cookies); // Set cookies to avoid login await page.setCookie(...shared.cookies); // Set cookies to avoid login
await page.goto(F95_SEARCH_URL, { await page.goto(constURLs.F95_SEARCH_URL, {
waitUntil: WAIT_STATEMENT waitUntil: shared.WAIT_STATEMENT
}); // Go to the search form and wait for it }); // Go to the search form and wait for it
// Explicitly wait for the required items to load // Explicitly wait for the required items to load
await page.waitForSelector(SEARCH_FORM_TEXTBOX); await page.waitForSelector(constSelectors.SEARCH_FORM_TEXTBOX);
await page.waitForSelector(TITLE_ONLY_CHECKBOX); await page.waitForSelector(constSelectors.TITLE_ONLY_CHECKBOX);
await page.waitForSelector(SEARCH_BUTTON); await page.waitForSelector(constSelectors.SEARCH_BUTTON);
await page.type(SEARCH_FORM_TEXTBOX, gamename) // Type the game we desire await page.type(constSelectors.SEARCH_FORM_TEXTBOX, gamename) // Type the game we desire
await page.click(TITLE_ONLY_CHECKBOX) // Select only the thread with the game in the titles await page.click(constSelectors.TITLE_ONLY_CHECKBOX) // Select only the thread with the game in the titles
await Promise.all([ await page.click(constSelectors.SEARCH_BUTTON); // Execute search
page.click(SEARCH_BUTTON), // Execute search await page.waitForNavigation({
page.waitForNavigation({ waitUntil: shared.WAIT_STATEMENT
waitUntil: WAIT_STATEMENT }); // Wait for page to load
}), // Wait for page to load
]);
// Select all conversation titles // Select all conversation titles
let threadTitleList = await page.$$(THREAD_TITLE); let threadTitleList = await page.$$(constSelectors.THREAD_TITLE);
// For each title extract the info about the conversation // For each title extract the info about the conversation
if (_debug) console.log('Extracting info from conversation titles'); if (shared.debug) console.log('Extracting info from conversation titles');
let results = []; let results = [];
for (let title of threadTitleList) { for (let title of threadTitleList) {
let gameUrl = await getOnlyGameThreads(page, title); let gameUrl = await getOnlyGameThreads(page, title);
@ -861,12 +498,11 @@ async function getSearchGameResults(browser, gamename) {
// Append the game's informations // Append the game's informations
if (gameUrl !== null) results.push(gameUrl); if (gameUrl !== null) results.push(gameUrl);
} }
if (_debug) console.log('Find ' + results.length + ' conversations'); if (shared.debug) console.log('Find ' + results.length + ' conversations');
await page.close(); // Close the page await page.close(); // Close the page
return results; return results;
} }
/** /**
* @private * @private
* Return the link of a conversation if it is a game or a mod * Return the link of a conversation if it is a game or a mod
@ -875,14 +511,16 @@ async function getSearchGameResults(browser, gamename) {
* @return {Promise<URL>} URL of the game/mod * @return {Promise<URL>} URL of the game/mod
*/ */
async function getOnlyGameThreads(page, titleHandle) { async function getOnlyGameThreads(page, titleHandle) {
const GAME_RECOMMENDATION_PREFIX = 'RECOMMENDATION';
// Get the URL of the thread from the title // Get the URL of the thread from the title
let relativeURLThread = await page.evaluate((element) => element.querySelector('a').href, titleHandle); let relativeURLThread = await page.evaluate( /* istanbul ignore next */ (element) => element.querySelector('a').href, titleHandle);
let url = new URL(relativeURLThread, F95_BASE_URL); let url = new URL(relativeURLThread, constURLs.F95_BASE_URL);
// Parse prefixes to ignore game recommendation // Parse prefixes to ignore game recommendation
for (let element of await titleHandle.$$('span[dir="auto"]')) { for (let element of await titleHandle.$$('span[dir="auto"]')) {
// Elaborate the prefixes // Elaborate the prefixes
let prefix = await page.evaluate(element => element.textContent.toUpperCase(), element); let prefix = await page.evaluate( /* istanbul ignore next */ element => element.textContent.toUpperCase(), element);
prefix = prefix.replace('[', '').replace(']', ''); prefix = prefix.replace('[', '').replace(']', '');
// This is not a game nor a mod, we can exit // This is not a game nor a mod, we can exit

View File

@ -67,6 +67,10 @@ class GameInfo {
* @type String * @type String
*/ */
this.gameDir = UNKNOWN; this.gameDir = UNKNOWN;
/**
*
*/
this.downloadInfo = [];
} }
/** /**

View File

@ -0,0 +1,27 @@
module.exports = Object.freeze({
AVATAR_INFO: 'span.avatar',
AVATAR_PIC: 'a[href="/account/"] > span.avatar > img[class^="avatar"]',
ENGINE_ID_SELECTOR: 'div[id^="btn-prefix_1_"]>span',
FILTER_THREADS_BUTTON: 'button[class="button--primary button"]',
GAME_IMAGES: 'img[src^="https://attachments.f95zone.to"]',
GAME_TAGS: 'a.tagItem',
GAME_TITLE: 'h1.p-title-value',
GAME_TITLE_PREFIXES: 'h1.p-title-value > a.labelLink > span[dir="auto"]',
LOGIN_BUTTON: 'button.button--icon--login',
LOGIN_MESSAGE_ERROR: 'div.blockMessage.blockMessage--error.blockMessage--iconic',
ONLY_GAMES_THREAD_OPTION: 'select[name="nodes[]"] > option[value="2"]',
PASSWORD_INPUT: 'input[name="password"]',
SEARCH_BUTTON: 'form.block > * button.button--icon--search',
SEARCH_FORM_TEXTBOX: 'input[name="keywords"]',
STATUS_ID_SELECTOR: 'div[id^="btn-prefix_4_"]>span',
THREAD_POSTS: 'article.message-body:first-child > div.bbWrapper:first-of-type',
THREAD_TITLE: 'h3.contentRow-title',
TITLE_ONLY_CHECKBOX: 'form.block > * input[name="c[title_only]"]',
UNREAD_THREAD_CHECKBOX: 'input[type="checkbox"][name="unread"]',
USERNAME_ELEMENT: 'a[href="/account/"] > span.p-navgroup-linkText',
USERNAME_INPUT: 'input[name="login"]',
WATCHED_THREAD_FILTER_POPUP_BUTTON: 'a.filterBar-menuTrigger',
WATCHED_THREAD_NEXT_PAGE: 'a.pageNav-jump--next',
WATCHED_THREAD_URLS: 'a[href^="/threads/"][data-tp-primary]',
DOWNLOAD_LINKS_CONTAINER: 'span[style="font-size: 18px"]'
});

View File

@ -0,0 +1,7 @@
module.exports = Object.freeze({
F95_BASE_URL: 'https://f95zone.to',
F95_SEARCH_URL: 'https://f95zone.to/search',
F95_LATEST_UPDATES: 'https://f95zone.to/latest',
F95_LOGIN_URL: 'https://f95zone.to/login',
F95_WATCHED_THREADS: 'https://f95zone.to/watched/threads',
});

338
app/scripts/game-scraper.js Normal file
View File

@ -0,0 +1,338 @@
// Public modules from npm
const HTMLParser = require('node-html-parser');
const puppeteer = require('puppeteer');
const urlExist = require('url-exist');
// Modules from file
const shared = require('./shared.js');
const selectors = require('./costants/css-selectors.js');
const { preparePage } = require('./puppeteer-helper.js');
const GameDownload = require('./classes/game-download.js').GameDownload;
const GameInfo = require('./classes/game-info.js').GameInfo;
const { isStringAValidURL, isF95URL } = require('./urls-helper.js');
/**
* @protected
* Get information from the game's main page.
* @param {puppeteer.Browser} browser Browser object used for navigation
* @param {URL} url URL of the game/mod to extract data from
* @return {Promise<GameInfo>} Complete information about the game you are looking for
*/
module.exports.getGameInfo = async function(browser, url) {
if (shared.debug) console.log('Obtaining game info');
// Verify the correctness of the URL
if (!isF95URL(url)) throw url + ' is not a valid F95Zone URL';
let exists = await urlExist(url.toString());
if (!exists) return new GameInfo();
let page = await preparePage(browser); // Set new isolated page
await page.setCookie(...shared.cookies); // Set cookies to avoid login
await page.goto(url.toString(), {
waitUntil: shared.WAIT_STATEMENT
}); // Go to the game page and wait until it loads
// It asynchronously searches for the elements and
// then waits at the end to compile the object to be returned
let info = new GameInfo();
let title = getGameTitle(page);
let author = getGameAuthor(page);
let tags = getGameTags(page);
let previewSource = getGamePreviewSource(page);
let downloadData = getGameDownloadLink(page);
info = await parsePrefixes(page, info); // Fill status/engines/isMod
let structuredText = await getMainPostStructuredText(page);
let overview = getOverview(structuredText, info.isMod);
let parsedInfos = parseConversationPage(structuredText);
// Fill in the GameInfo element with the information obtained
info.name = await title;
info.author = await author;
info.overview = overview;
info.tags = await tags;
info.f95url = url;
info.version = info.isMod ? parsedInfos['MOD VERSION'] : parsedInfos['VERSION'];
info.lastUpdate = info.isMod ? parsedInfos['UPDATED'] : parsedInfos['THREAD UPDATED'];
info.previewSource = await previewSource;
info.downloadInfo = await downloadData;
await page.close(); // Close the page
if (shared.debug) console.log('Founded data for ' + info.name);
return info;
}
//#region Private methods
/**
* @private
* Get the game description from its web page.
* Different processing depending on whether the game is a mod or not.
* @param {String} text Structured text extracted from the game's web page
* @param {Boolean} isMod Specify if it is a game or a mod
* @returns {Promise<String>} Game description
*/
function getOverview(text, isMod) {
// Get overview (different parsing for game and mod)
let overviewEndIndex;
if (isMod) overviewEndIndex = text.indexOf('Updated');
else overviewEndIndex = text.indexOf('Thread Updated');
return text.substring(0, overviewEndIndex).replace('Overview:\n', '').trim();
}
/**
* @private
* Extrapolate the page structure by removing the element tags
* and leaving only the text and its spacing.
* @param {puppeteer.Page} page Page containing the text
* @returns {Promise<String>} Structured text
*/
async function getMainPostStructuredText(page) {
// Gets the first post, where are listed all the game's informations
let post = (await page.$$(selectors.THREAD_POSTS))[0];
// The info are plain text so we need to parse the HTML code
let bodyHTML = await page.evaluate( /* istanbul ignore next */ (mainPost) => mainPost.innerHTML, post);
return HTMLParser.parse(bodyHTML).structuredText;
}
/**
* @private
* Extrapolates and cleans the author from the page passed by parameter.
* @param {puppeteer.Page} page Page containing the author to be extrapolated
* @returns {Promise<String>} Game author
*/
async function getGameAuthor(page) {
// Get the game/mod name (without square brackets)
let titleHTML = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector).innerHTML,
selectors.GAME_TITLE);
let structuredTitle = HTMLParser.parse(titleHTML);
// The last element **shoud be** the title without prefixes (engines, status, other...)
let gameTitle = structuredTitle.childNodes.pop().rawText;
// The last square brackets contain the author
let startTitleIndex = gameTitle.lastIndexOf('[') + 1;
return gameTitle.substring(startTitleIndex, gameTitle.length - 1).trim();
}
/**
* @private
* Process the post text to get all the useful
* information in the format *DESCRIPTOR : VALUE*.
* @param {String} text Structured text of the post
* @returns {Object} Dictionary of information
*/
function parseConversationPage(text) {
let dataPairs = {};
// The information searched in the game post are one per line
let splittedText = text.split('\n');
for (let line of splittedText) {
if (!line.includes(':')) continue;
// Create pair key/value
let splitted = line.split(':');
let key = splitted[0].trim().toUpperCase(); // Uppercase to avoid mismatch
let value = splitted[1].trim();
// Add pair to the dict if valid
if (value != '') dataPairs[key] = value;
}
return dataPairs;
}
/**
* @private
* Gets the URL of the image used as a preview for the game in the conversation.
* @param {puppeteer.Page} page Page containing the URL to be extrapolated
* @returns {Promise<URL>} URL of the image or null if failed to get it
*/
async function getGamePreviewSource(page) {
let src = await page.evaluate( /* istanbul ignore next */ (selector) => {
// Get the firs image available
let img = document.querySelector(selector);
if (img === null || img === undefined) return null;
else return img.getAttribute('src');
}, selectors.GAME_IMAGES);
// Check if the URL is valid
return isStringAValidURL(src) ? new URL(src) : null;
}
/**
* @private
* Extrapolates and cleans the title from the page passed by parameter.
* @param {puppeteer.Page} page Page containing the title to be extrapolated
* @returns {Promise<String>} Game title
*/
async function getGameTitle(page) {
// Get the game/mod name (without square brackets)
let titleHTML = await page.evaluate( /* istanbul ignore next */ (selector) =>
document.querySelector(selector).innerHTML,
selectors.GAME_TITLE);
let structuredTitle = HTMLParser.parse(titleHTML);
// The last element **shoud be** the title without prefixes (engines, status, other...)
let gameTitle = structuredTitle.childNodes.pop().rawText;
let endTitleIndex = gameTitle.indexOf('[');
return gameTitle.substring(0, endTitleIndex).trim();
}
/**
* @private
* Get the alphabetically sorted list of tags associated with the game.
* @param {puppeteer.Page} page Page containing the tags to be extrapolated
* @returns {Promise<String[]>} List of uppercase tags
*/
async function getGameTags(page) {
let tags = [];
// Get the game tags
for (let handle of await page.$$(selectors.GAME_TAGS)) {
let tag = await page.evaluate( /* istanbul ignore next */ (element) => element.innerText, handle);
tags.push(tag.toUpperCase());
}
return tags.sort();
}
/**
* @private
* Process the game title prefixes to extract information such as game status,
* graphics engine used, and whether it is a mod or original game.
* @param {puppeteer.Page} page Page containing the prefixes to be extrapolated
* @param {GameInfo} info Object to assign the identified information to
* @returns {Promise<GameInfo>} GameInfo object passed in to which the identified information has been added
*/
async function parsePrefixes(page, info) {
const MOD_PREFIX = 'MOD';
// The 'Ongoing' status is not specified, only 'Abandoned'/'OnHold'/'Complete'
info.status = 'Ongoing';
for (let handle of await page.$$(selectors.GAME_TITLE_PREFIXES)) {
let value = await page.evaluate( /* istanbul ignore next */ (element) => element.innerText, handle);
// Clean the prefix
let prefix = value.toUpperCase().replace('[', '').replace(']', '').trim();
// Getting infos...
if (shared.statuses.includes(prefix)) info.status = prefix;
else if (shared.engines.includes(prefix)) info.engine = prefix;
// This is not a game but a mod
else if (prefix === MOD_PREFIX) info.isMod = true;
}
return info;
}
/**
* @private
* Get game download links for different platforms.
* @param {puppeteer.Page} page Page containing the links to be extrapolated
* @returns {Promise<GameDownload[]>} List of objects used for game download
*/
async function getGameDownloadLink(page) {
// Most used hosting platforms
let hostingPlatforms = ['MEGA', 'NOPY', 'FILESUPLOAD', 'MIXDROP', 'UPLOADHAVEN', 'PIXELDRAIN', 'FILESFM'];
// Supported OS platforms
let platformOS = ['WIN', 'LINUX', 'MAC', 'ALL']
// Gets the <span> which contains the download links
let temp = await page.$$(selectors.DOWNLOAD_LINKS_CONTAINER);
if(temp.length === 0) return [];
// Look for the container that contains the links
// It is necessary because the same css selector
// also identifies other elements on the page
let container = null;
for(let candidate of temp) {
if (container !== null) break;
let upperText = (await page.evaluate( /* istanbul ignore next */ (e) => e.innerText, candidate)).toUpperCase();
// Search if the container contains the name of a hosting platform
for (let p of hostingPlatforms) {
if(upperText.includes(p)) {
container = candidate;
break;
}
}
}
if(container === null) return [];
// Extract the HTML text from the container
let searchText = (await page.evaluate( /* istanbul ignore next */ (e) => e.innerHTML, container)).toLowerCase();
// Parse the download links
let downloadData = [];
for(let platform of platformOS) {
let data = extractGameHostingData(platform, searchText);
downloadData.push(...data);
}
return downloadData;
}
/**
* @private
* From the HTML text it extracts the game download links for the specified operating system.
* @param {String} platform Name of the operating system to look for a compatible link to.
* It can only be *WIN/LINUX/MAC/ALL*
* @param {String} text HTML string to extract links from
* @returns {GameDownload[]} List of game download links for the selected platform
*/
function extractGameHostingData(platform, text) {
const PLATFORM_BOLD_OPEN = '<b>';
const CONTAINER_SPAN_CLOSE = '</span>';
const LINK_OPEN = '<a';
const LINK_CLOSE = '</a>';
const HREF_START = 'href="';
const HREF_END = '\"';
const TAG_CLOSE = '>';
// Identify the individual platforms
let startIndex = text.indexOf(platform.toLowerCase());
if(startIndex === -1) return [];
else startIndex += platform.length
// Find the <b>platform</b>
let endIndex = text.indexOf(
PLATFORM_BOLD_OPEN,
startIndex) + PLATFORM_BOLD_OPEN.length;
// Find the end of the container
if (endIndex === -1) text.indexOf(
CONTAINER_SPAN_CLOSE,
startIndex) + CONTAINER_SPAN_CLOSE.length;
text = text.substring(startIndex, endIndex);
let downloadData = [];
let linkTags = text.split(LINK_OPEN);
for(let tag of linkTags) {
// Ignore non-link string
if (!tag.includes(HREF_START)) continue;
// Find the hosting platform name
startIndex = tag.indexOf(TAG_CLOSE) + TAG_CLOSE.length;
endIndex = tag.indexOf(LINK_CLOSE, startIndex);
let hosting = tag.substring(startIndex, endIndex);
// Find the 'href' attribute
startIndex = tag.indexOf(HREF_START) + HREF_START.length;
endIndex = tag.indexOf(HREF_END, startIndex);
let link = tag.substring(startIndex, endIndex);
if (isStringAValidURL(link)) {
let gd = new GameDownload();
gd.hosting = hosting.toUpperCase();
gd.link = new URL(link);
gd.supportedOS = platform.toUpperCase();
downloadData.push(gd);
}
}
return downloadData;
}
//#endregion Private methods

View File

@ -0,0 +1,48 @@
// Public modules from npm
const puppeteer = require('puppeteer');
// Modules from file
const shared = require('./shared.js');
/**
* @protected
* Create a Chromium instance used to navigate with Puppeteer.
* By default the browser is headless.
* @returns {Promise<puppeteer.Browser>} Created browser
*/
module.exports.prepareBrowser = async function() {
// Create a headless browser
let browser = await puppeteer.launch({
headless: !shared.debug, // Use GUI when debug = true
});
return browser;
}
/**
* @protected
* Prepare a page used to navigate the browser.
* The page is set up to reject image download requests. The user agent is also changed.
* @param {puppeteer.Browser} browser Browser to use when navigating where the page will be created
* @returns {Promise<puppeteer.Page>} New page
*/
module.exports.preparePage = async function(browser) {
// Create new page in the browser argument
let page = await browser.newPage();
// Block image download
await page.setRequestInterception(true);
page.on('request', (request) => {
if (request.resourceType() === 'image') request.abort();
// else if(request.resourceType == 'font') request.abort();
// else if(request.resourceType == 'media') request.abort();
else request.continue();
});
// Set custom user-agent
let userAgent = 'Mozilla/5.0 (X11; Linux x86_64)' +
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.39 Safari/537.36';
await page.setUserAgent(userAgent);
return page;
}

View File

@ -1,5 +0,0 @@
module.exports.StyleSelector = StyleSelector;
class StyleSelector {
static value = 'b';
}

71
app/scripts/shared.js Normal file
View File

@ -0,0 +1,71 @@
/**
* Class containing variables shared between modules.
*/
class Shared {
/**
* Shows log messages and other useful functions for module debugging.
*/
static _debug = false;
static _isLogged = false;
static _cookies = null;
static _engines = null;
static _statuses = null;
static WAIT_STATEMENT = 'domcontentloaded';
static set debug(val) {
this._debug = val;
}
/**
* Shows log messages and other useful functions for module debugging.
* @returns {boolean}
*/
static get debug() {
return this._debug;
}
static set isLogged(val) {
this._isLogged = val;
}
/**
* @returns {boolean}
*/
static get isLogged() {
return this._isLogged;
}
static set cookies(val) {
this._cookies = val;
}
/**
* @returns {object[]}
*/
static get cookies() {
return this._cookies;
}
static set engines(val) {
this._engines = val;
}
/**
* @returns {string[]}
*/
static get engines() {
return this._engines;
}
static set statuses(val) {
this._statuses = val;
}
/**
* @returns {string[]}
*/
static get statuses() {
return this._statuses;
}
}
module.exports = Shared;

View File

@ -0,0 +1,29 @@
// Modules from file
const { F95_BASE_URL } = require('./costants/urls.js');
/**
* @protected
* Check if the url belongs to the domain of the F95 platform.
* @param {URL} url URL to check
* @returns {Boolean} true if the url belongs to the domain, false otherwise
*/
module.exports.isF95URL = function(url) {
if (url.toString().startsWith(F95_BASE_URL)) return true;
else return false;
}
/**
* @protected
* Checks if the string passed by parameter has a properly formatted and valid path to a URL.
* @param {String} url String to check for correctness
* @returns {Boolean} true if the string is a valid URL, false otherwise
*/
module.exports.isStringAValidURL = function(url) {
try {
new URL(url);
return true;
} catch (err) {
return false;
}
}

View File

@ -1,16 +1,18 @@
const { debug, login, getGameData, loadF95BaseData, getUserData } = require("../app/index"); const { debug, login, getGameData, loadF95BaseData, getUserData, logout } = require("../app/index");
debug(true); //debug(true);
main(); main();
async function main() { async function main() {
let loginResult = await login("MillenniumEarl", "f9vTcRNuvxj4YpK"); let loginResult = await login("MillenniumEarl", "f9vTcRNuvxj4YpK");
if (loginResult.success) { if (loginResult.success) {
// await loadF95BaseData(); await loadF95BaseData();
// let data = await getGameData("kingdom of deception", false); let gameData = await getGameData("kingdom of deception", false);
// console.log(data.pop()); console.log(gameData.pop());
let data = await getUserData();
console.log(data); // let userData = await getUserData();
// console.log(userData);
} }
logout();
} }

View File

@ -1,72 +0,0 @@
DOWNLOAD</b></span><br/>
<span style="font-size: 18px"><b>Win/Linux</b>: <a href="https://filesupload.org/fcb58530b1612417" target="_blank" class="link link--external" rel="nofollow noopener">FILESUPLOAD</a> - <a href="https://f95zone.to/masked/mega.nz/2733/1470797/4O5LKwMx4ZSlw0QYTVMP0uDK660/hoobTb44f0IKx7Yio2SE2w/loX_px2vLRyNRQCnkNn5U7nnQe7jGmpEVERvH1tk7RjAFkQbs2kH_vCK6zVmRDuqiypPoIx358MNHHCd3QCdVvEsClSiAq4rwjK0r_ruXIs" target="_blank" class="link link--external" rel="nofollow noopener">MEGA</a> - <a href="https://mixdrop.co/f/844qpvgxt960nk" target="_blank" class="link link--external" rel="nofollow noopener">MIXDROP</a> - <a href="https://nopy.to/50jmNQbo/Kingdom_of_Deception-pc0.10.8.zip" target="_blank" class="link link--external" rel="nofollow noopener">NOPY</a> <br />
<b>Mac</b>: <a href="https://filesupload.org/33ea248bd58de835" target="_blank" class="link link--external" rel="nofollow noopener">FILESUPLOAD</a> - <a href="https://f95zone.to/masked/mega.nz/2733/1470797/5jztCvULyNXLlGc3zrq2KdUXvRs/lsnwp_EIOaZf748cVqvepw/fB3Avc7B2ynxxjYC.BPsWakg4u1dWPp0vwwdR5CTiCpHU67lQk2yb7IOohdSQxL1O7oTjnSHU25w9mfESTXuRYQ87wHNaLfMjPvN4.03BsI" target="_blank" class="link link--external" rel="nofollow noopener">MEGA</a> - <a href="https://mixdrop.co/f/o779vgo3uxl8r1" target="_blank" class="link link--external" rel="nofollow noopener">MIXDROP</a> - <a href="https://nopy.to/60omRq7Z/Kingdom_of_Deception-mac0.10.8.zip" target="_blank" class="link link--external" rel="nofollow noopener">NOPY</a> <br />
<b>Others</b>: <a href="https://f95zone.to/threads/kingdom-of-deception-v0-10-7-hreinn-games.2733/post-3766847" class="link link--internal">COMPRESSED</a>* - </span><a href="https://f95zone.to/threads/kingdom-of-deception-v0-10-8-hreinn-games.2733/post-3882887" class="link link--internal"><span style="font-size: 18px">ANDROID</span></a><span style="font-size: 18px">*<br />
<br />
<b>Extras</b>: <a href="https://www.patreon.com/posts/kod-walkthrough-23689282" target="_blank" class="link link--external" rel="nofollow noopener">WALKTHROUGH</a> - <a href="https://www.mediafire.com/file/0jmt00qramlkikg/Bonus_and_Variants_7.7z/file" target="_blank" class="link link--external" rel="nofollow noopener">BONUS 1-7</a> - <a href="https://f95zone.to/masked/mega.nz/2733/1470797/jZUF4rRkmgtJqdXXxJkqsp6c7mg/iXQhlVlx_ecL3jDBsjsE1A/IeyA0b01kEJ8biyxvhjL.6Eb5XixOjec6eJ5xg1GekAbYJZl4wf49VDXozvsm81kzPWfaGw2.r5xr.VQLitayzkdKh3DsnEwVs5zAqCcz4Q" target="_blank" class="link link--external" rel="nofollow noopener">CG RIP</a> - <a href="https://f95zone.com/threads/jdmod-0-5-2c-johndupont.14466/" target="_blank" class="link link--external" rel="nofollow noopener">JDMOD</a></span><br />
<br />
<span style="font-size: 9px">*This unofficial port/version is not released by developer, download at your own risk.</span><br />
<br />
<a href="https://attachments.f95zone.to/2017/05/17359_Capturecvccv.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='75' viewBox%3D'0 0 100 75'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17359_Capturecvccv.jpg" class="bbImage lazyload" style="" alt="Capturecvccv.jpg" title="Capturecvccv.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17359_Capturecvccv.jpg"
class="bbImage "
style=""
alt="Capturecvccv.jpg"
title="Capturecvccv.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17360_Capturedfgdfgdfg.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='75' viewBox%3D'0 0 100 75'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17360_Capturedfgdfgdfg.jpg" class="bbImage lazyload" style="" alt="Capturedfgdfgdfg.jpg" title="Capturedfgdfgdfg.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17360_Capturedfgdfgdfg.jpg"
class="bbImage "
style=""
alt="Capturedfgdfgdfg.jpg"
title="Capturedfgdfgdfg.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17361_Capturefgdgdfg.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='75' viewBox%3D'0 0 100 75'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17361_Capturefgdgdfg.jpg" class="bbImage lazyload" style="" alt="Capturefgdgdfg.jpg" title="Capturefgdgdfg.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17361_Capturefgdgdfg.jpg"
class="bbImage "
style=""
alt="Capturefgdgdfg.jpg"
title="Capturefgdgdfg.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17362_Capturegfhfghfh.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='74' viewBox%3D'0 0 100 74'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17362_Capturegfhfghfh.jpg" class="bbImage lazyload" style="" alt="Capturegfhfghfh.jpg" title="Capturegfhfghfh.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17362_Capturegfhfghfh.jpg"
class="bbImage "
style=""
alt="Capturegfhfghfh.jpg"
title="Capturegfhfghfh.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17363_Capturerewrwe.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='74' viewBox%3D'0 0 100 74'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17363_Capturerewrwe.jpg" class="bbImage lazyload" style="" alt="Capturerewrwe.jpg" title="Capturerewrwe.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17363_Capturerewrwe.jpg"
class="bbImage "
style=""
alt="Capturerewrwe.jpg"
title="Capturerewrwe.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17364_Capturetertert.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='74' viewBox%3D'0 0 100 74'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17364_Capturetertert.jpg" class="bbImage lazyload" style="" alt="Capturetertert.jpg" title="Capturetertert.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17364_Capturetertert.jpg"
class="bbImage "
style=""
alt="Capturetertert.jpg"
title="Capturetertert.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17365_Capturetryrtry.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='74' viewBox%3D'0 0 100 74'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17365_Capturetryrtry.jpg" class="bbImage lazyload" style="" alt="Capturetryrtry.jpg" title="Capturetryrtry.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17365_Capturetryrtry.jpg"
class="bbImage "
style=""
alt="Capturetryrtry.jpg"
title="Capturetryrtry.jpg" /></noscript>
</a>
<a href="https://attachments.f95zone.to/2017/05/17366_Capturezzz.jpg" target="_blank" class="js-lbImage">
<img src="data:image/svg+xml;charset=utf-8,%3Csvg xmlns%3D'http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg' width='100' height='75' viewBox%3D'0 0 100 75'%2F%3E" data-src="https://attachments.f95zone.to/2017/05/thumb/17366_Capturezzz.jpg" class="bbImage lazyload" style="" alt="Capturezzz.jpg" title="Capturezzz.jpg" />
<noscript><img src="https://attachments.f95zone.to/2017/05/thumb/17366_Capturezzz.jpg"
class="bbImage "
style=""
alt="Capturezzz.jpg"
title="Capturezzz.jpg" /></noscript>

View File

@ -1,6 +1,7 @@
const expect = require("chai").expect; const expect = require("chai").expect;
const F95API = require("../app/index"); const F95API = require("../app/index");
const fs = require("fs"); const fs = require("fs");
const { debug } = require("console");
const COOKIES_SAVE_PATH = "./f95cache/cookies.json"; const COOKIES_SAVE_PATH = "./f95cache/cookies.json";
const ENGINES_SAVE_PATH = "./f95cache/engines.json"; const ENGINES_SAVE_PATH = "./f95cache/engines.json";
@ -10,19 +11,19 @@ const PASSWORD = "f9vTcRNuvxj4YpK";
const FAKE_USERNAME = "FakeUsername091276"; const FAKE_USERNAME = "FakeUsername091276";
const FAKE_PASSWORD = "fake_password"; const FAKE_PASSWORD = "fake_password";
describe("Login methods without cookies", function () { describe("Login without cookies", function () {
//#region Set-up //#region Set-up
this.timeout(30000); // All tests in this suite get 30 seconds before timeout this.timeout(30000); // All tests in this suite get 30 seconds before timeout
this.beforeEach("Remove all cookies", function () { beforeEach("Remove all cookies", function () {
// Runs before each test in this block // Runs before each test in this block
if (fs.existsSync(COOKIES_SAVE_PATH)) fs.unlinkSync(COOKIES_SAVE_PATH); if (fs.existsSync(COOKIES_SAVE_PATH)) fs.unlinkSync(COOKIES_SAVE_PATH);
F95API.logout();
}); });
//#endregion Set-up //#endregion Set-up
it("Test with valid credentials", async function () { it("Test with valid credentials", async function () {
const result = await F95API.login(USERNAME, PASSWORD); const result = await F95API.login(USERNAME, PASSWORD);
console.log(result);
expect(result.success).to.be.true; expect(result.success).to.be.true;
expect(result.message).equal("Authentication successful"); expect(result.message).equal("Authentication successful");
}); });
@ -49,7 +50,8 @@ describe("Login with cookies", function () {
before("Log in to create cookies", async function () { before("Log in to create cookies", async function () {
// Runs once before the first test in this block // Runs once before the first test in this block
if (!fs.existsSync(COOKIES_SAVE_PATH)) await F95API.login(USERNAME, PASSWORD); if (!fs.existsSync(COOKIES_SAVE_PATH)) await F95API.login(USERNAME, PASSWORD); // Download cookies
F95API.logout();
}); });
//#endregion Set-up //#endregion Set-up
@ -64,7 +66,7 @@ describe("Load base data without cookies", function () {
//#region Set-up //#region Set-up
this.timeout(30000); // All tests in this suite get 30 seconds before timeout this.timeout(30000); // All tests in this suite get 30 seconds before timeout
before("Delete cache if exists", async function () { before("Delete cache if exists", function () {
// Runs once before the first test in this block // Runs once before the first test in this block
if (fs.existsSync(ENGINES_SAVE_PATH)) fs.unlinkSync(ENGINES_SAVE_PATH); if (fs.existsSync(ENGINES_SAVE_PATH)) fs.unlinkSync(ENGINES_SAVE_PATH);
if (fs.existsSync(STATUSES_SAVE_PATH)) fs.unlinkSync(STATUSES_SAVE_PATH); if (fs.existsSync(STATUSES_SAVE_PATH)) fs.unlinkSync(STATUSES_SAVE_PATH);
@ -86,19 +88,19 @@ describe("Load base data without cookies", function () {
}); });
it("Without login", async function () { it("Without login", async function () {
F95API.logout();
let result = await F95API.loadF95BaseData(); let result = await F95API.loadF95BaseData();
expect(result).to.be.false; expect(result).to.be.false;
}); });
}); });
describe("Search game data", function () { describe("Search game data", function () {
//#region Set-up //#region Set-up
this.timeout(30000); // All tests in this suite get 30 seconds before timeout this.timeout(60000); // All tests in this suite get 60 seconds before timeout
before("Set up API data", async function () { beforeEach("Prepare API", function () {
// Runs once before the first test in this block // Runs once before the first test in this block
await F95API.loadF95BaseData(); F95API.logout();
}); });
//#endregion Set-up //#endregion Set-up
@ -111,7 +113,7 @@ describe("Search game data", function () {
// This test depend on the data on F95Zone at // This test depend on the data on F95Zone at
// https://f95zone.to/threads/kingdom-of-deception-v0-10-8-hreinn-games.2733/ // https://f95zone.to/threads/kingdom-of-deception-v0-10-8-hreinn-games.2733/
const result = await F95API.getGameData("Kingdom of Deception", false); const result = (await F95API.getGameData("Kingdom of Deception", false))[0];
let src = "https://attachments.f95zone.to/2018/09/162821_f9nXfwF.png"; let src = "https://attachments.f95zone.to/2018/09/162821_f9nXfwF.png";
// Test only the main information // Test only the main information
@ -119,7 +121,7 @@ describe("Search game data", function () {
expect(result.author).to.equal("Hreinn Games"); expect(result.author).to.equal("Hreinn Games");
expect(result.isMod, "Should be false").to.be.false; expect(result.isMod, "Should be false").to.be.false;
expect(result.engine).to.equal("REN'PY"); expect(result.engine).to.equal("REN'PY");
expect(result.previewSource).to.equal(src); // expect(result.previewSource).to.equal(src); could be null -> Why sometimes doesn't get the image?
}); });
it("Search game when not logged", async function () { it("Search game when not logged", async function () {
const result = await F95API.getGameData("Kingdom of Deception", false); const result = await F95API.getGameData("Kingdom of Deception", false);