MickSlash
/
F95API
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of https://github.com/MillenniumEarl/F95API into master

pull/19/head
MillenniumEarl 2020-10-12 14:27:16 +02:00
parent 44b45a7b7b b5444f7057
commit 627bd13c8a
6 changed files with 135 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/index.js
View File

@ -482,7 +482,7 @@ async function loginF95(browser, username, password) {
await page.waitForNavigation({ await page.waitForNavigation({
waitUntil: shared.WAIT_STATEMENT, waitUntil: shared.WAIT_STATEMENT,
}); // Wait for page to load }); // Wait for page to load
// Prepare result // Prepare result
let result = new LoginResult(); let result = new LoginResult();

58
app/scripts/constants/css-selectors.js
View File

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

9
app/scripts/game-scraper.js
View File

@ -77,7 +77,7 @@ module.exports.getGameInfo = async function (browser, url) {
* @param {GameInfo} info Information about the game * @param {GameInfo} info Information about the game
* @returns {Promise<String>} Online version of the game * @returns {Promise<String>} Online version of the game
*/ */
module.exports.getGameVersionFromTitle = async function(browser, info) { module.exports.getGameVersionFromTitle = async function (browser, info) {
let page = await preparePage(browser); // Set new isolated page let page = await preparePage(browser); // Set new isolated page
await page.setCookie(...shared.cookies); // Set cookies to avoid login await page.setCookie(...shared.cookies); // Set cookies to avoid login
await page.goto(info.f95url, { await page.goto(info.f95url, {
@ -87,8 +87,7 @@ module.exports.getGameVersionFromTitle = async function(browser, info) {
// Get the title // Get the title
let titleHTML = await page.evaluate( let titleHTML = await page.evaluate(
/* istanbul ignore next */ /* istanbul ignore next */
(selector) => (selector) => document.querySelector(selector).innerHTML,
document.querySelector(selector).innerHTML,
selectors.GAME_TITLE selectors.GAME_TITLE
); );
let title = HTMLParser.parse(titleHTML).childNodes.pop().rawText; let title = HTMLParser.parse(titleHTML).childNodes.pop().rawText;
@ -97,9 +96,9 @@ module.exports.getGameVersionFromTitle = async function(browser, info) {
let startIndex = title.indexOf("[") + 1; let startIndex = title.indexOf("[") + 1;
let endIndex = title.indexOf("]", startIndex); let endIndex = title.indexOf("]", startIndex);
let version = title.substring(startIndex, endIndex).trim().toUpperCase(); let version = title.substring(startIndex, endIndex).trim().toUpperCase();
if(version.startsWith("V")) version = version.replace("V", ""); // Replace only the first occurrence if (version.startsWith("V")) version = version.replace("V", ""); // Replace only the first occurrence
return version; return version;
} };
//#region Private methods //#region Private methods
/** /**

128
app/scripts/game-searcher.js
View File

@ -1,15 +1,13 @@
"use strict"; "use strict";
// Public modules from npm // Public modules from npm
const puppeteer = require('puppeteer'); const puppeteer = require("puppeteer");
// Modules from file // Modules from file
const shared = require("./shared.js"); const shared = require("./shared.js");
const constURLs = require("./constants/urls.js"); const constURLs = require("./constants/urls.js");
const selectors = require("./constants/css-selectors.js"); const selectors = require("./constants/css-selectors.js");
const { const { preparePage } = require("./puppeteer-helper.js");
preparePage,
} = require("./puppeteer-helper.js");
/** /**
* @protected * @protected
@ -18,42 +16,42 @@ const {
* @param {String} gamename Name of the game to search for * @param {String} gamename Name of the game to search for
* @returns {Promise<String[]>} List of URL of possible games obtained from the preliminary research on the F95 portal * @returns {Promise<String[]>} List of URL of possible games obtained from the preliminary research on the F95 portal
*/ */
module.exports.getSearchGameResults = async function(browser, gamename) { module.exports.getSearchGameResults = async function (browser, gamename) {
if (shared.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(...shared.cookies); // Set cookies to avoid login await page.setCookie(...shared.cookies); // Set cookies to avoid login
await page.goto(constURLs.F95_SEARCH_URL, { await page.goto(constURLs.F95_SEARCH_URL, {
waitUntil: shared.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(selectors.SEARCH_FORM_TEXTBOX); await page.waitForSelector(selectors.SEARCH_FORM_TEXTBOX);
await page.waitForSelector(selectors.TITLE_ONLY_CHECKBOX); await page.waitForSelector(selectors.TITLE_ONLY_CHECKBOX);
await page.waitForSelector(selectors.SEARCH_BUTTON); await page.waitForSelector(selectors.SEARCH_BUTTON);
await page.type(selectors.SEARCH_FORM_TEXTBOX, gamename); // Type the game we desire await page.type(selectors.SEARCH_FORM_TEXTBOX, gamename); // Type the game we desire
await page.click(selectors.TITLE_ONLY_CHECKBOX); // Select only the thread with the game in the titles await page.click(selectors.TITLE_ONLY_CHECKBOX); // Select only the thread with the game in the titles
await page.click(selectors.SEARCH_BUTTON); // Execute search await page.click(selectors.SEARCH_BUTTON); // Execute search
await page.waitForNavigation({ await page.waitForNavigation({
waitUntil: shared.WAIT_STATEMENT, waitUntil: shared.WAIT_STATEMENT,
}); // Wait for page to load }); // Wait for page to load
// Select all conversation titles // Select all conversation titles
let resultsThread = await page.$$(selectors.SEARCH_THREADS_RESULTS_BODY); let resultsThread = await page.$$(selectors.SEARCH_THREADS_RESULTS_BODY);
// For each element found extract the info about the conversation // For each element found extract the info about the conversation
if (shared.debug) console.log("Extracting info from conversations"); if (shared.debug) console.log("Extracting info from conversations");
let results = []; let results = [];
for (let element of resultsThread) { for (let element of resultsThread) {
let gameUrl = await getOnlyGameThreads(page, element); let gameUrl = await getOnlyGameThreads(page, element);
if (gameUrl !== null) results.push(gameUrl); if (gameUrl !== null) results.push(gameUrl);
} }
if (shared.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;
} };
//#region Private methods //#region Private methods
/** /**
@ -64,16 +62,16 @@ module.exports.getSearchGameResults = async function(browser, gamename) {
* @return {Promise<String>} URL of the game/mod or null if the URL is not of a game * @return {Promise<String>} URL of the game/mod or null if the URL is not of a game
*/ */
async function getOnlyGameThreads(page, divHandle) { async function getOnlyGameThreads(page, divHandle) {
// Obtain the elements containing the basic information // Obtain the elements containing the basic information
let titleHandle = await divHandle.$(selectors.THREAD_TITLE); let titleHandle = await divHandle.$(selectors.THREAD_TITLE);
let forumHandle = await divHandle.$(selectors.SEARCH_THREADS_MEMBERSHIP); let forumHandle = await divHandle.$(selectors.SEARCH_THREADS_MEMBERSHIP);
// Get the forum where the thread was posted
let forum = await getMembershipForum(page, forumHandle);
if(forum !== "GAMES" && forum != "MODS") return null;
// Get the URL of the thread from the title // Get the forum where the thread was posted
return await getThreadURL(page, titleHandle); let forum = await getMembershipForum(page, forumHandle);
if (forum !== "GAMES" && forum != "MODS") return null;
// Get the URL of the thread from the title
return await getThreadURL(page, titleHandle);
} }
/** /**
@ -81,26 +79,26 @@ async function getOnlyGameThreads(page, divHandle) {
* Obtain the membership forum of the thread passed throught "handle". * Obtain the membership forum of the thread passed throught "handle".
* @param {puppeteer.Page} page Page containing the conversation to be analyzed * @param {puppeteer.Page} page Page containing the conversation to be analyzed
* @param {puppeteer.ElementHandle} handle Handle containing the forum membership * @param {puppeteer.ElementHandle} handle Handle containing the forum membership
* @returns {Promise<String>} Uppercase membership category * @returns {Promise<String>} Uppercase membership category
*/ */
async function getMembershipForum(page, handle) { async function getMembershipForum(page, handle) {
// The link can be something like: // The link can be something like:
// + /forums/request.NUMBER/ // + /forums/request.NUMBER/
// + /forums/game-recommendations-identification.NUMBER/ // + /forums/game-recommendations-identification.NUMBER/
// + /forums/games.NUMBER/ <-- We need this // + /forums/games.NUMBER/ <-- We need this
let link = await page.evaluate( let link = await page.evaluate(
/* istanbul ignore next */ /* istanbul ignore next */
(e) => e.getAttribute('href'), (e) => e.getAttribute("href"),
handle handle
); );
// Parse link // Parse link
link = link.replace("/forums/", ""); link = link.replace("/forums/", "");
let endIndex = link.indexOf("."); let endIndex = link.indexOf(".");
let forum = link.substring(0, endIndex); let forum = link.substring(0, endIndex);
return forum.toUpperCase(); return forum.toUpperCase();
} }
/** /**
@ -111,12 +109,12 @@ async function getMembershipForum(page, handle) {
* @returns {Promise<String>} URL of the thread * @returns {Promise<String>} URL of the thread
*/ */
async function getThreadURL(page, handle) { async function getThreadURL(page, handle) {
let relativeURLThread = await page.evaluate( let relativeURLThread = await page.evaluate(
/* istanbul ignore next */ /* istanbul ignore next */
(e) => e.querySelector("a").href, (e) => e.querySelector("a").href,
handle handle
); );
let urlThread = new URL(relativeURLThread, constURLs.F95_BASE_URL).toString(); let urlThread = new URL(relativeURLThread, constURLs.F95_BASE_URL).toString();
return urlThread; return urlThread;
} }
//#endregion Private methods //#endregion Private methods

59
app/scripts/puppeteer-helper.js
View File

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

13
test/index-test.js
View File

@ -3,8 +3,8 @@
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 sleep = require('sleep'); const sleep = require("sleep");
const dotenv = require('dotenv'); const dotenv = require("dotenv");
dotenv.config(); dotenv.config();
const COOKIES_SAVE_PATH = "./f95cache/cookies.json"; const COOKIES_SAVE_PATH = "./f95cache/cookies.json";
@ -26,9 +26,9 @@ 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
before("Set isolation", function() { before("Set isolation", function () {
F95API.setIsolation(true); F95API.setIsolation(true);
}) });
beforeEach("Remove all cookies", function () { beforeEach("Remove all cookies", function () {
// Runs before each test in this block // Runs before each test in this block
@ -42,7 +42,7 @@ describe("Login without cookies", function () {
it("Test with valid credentials", async function () { it("Test with valid credentials", async function () {
// Gain exclusive use of the cookies // Gain exclusive use of the cookies
while (testOrder !== 0) randomSleep(); while (testOrder !== 0) randomSleep();
const result = await F95API.login(USERNAME, PASSWORD); const result = await F95API.login(USERNAME, PASSWORD);
expect(result.success).to.be.true; expect(result.success).to.be.true;
expect(result.message).equal("Authentication successful"); expect(result.message).equal("Authentication successful");
@ -221,7 +221,8 @@ describe("Check game update", function () {
// This test depend on the data on F95Zone at // This test depend on the data on F95Zone at
// https://f95zone.to/threads/perverted-education-v0-9701-april-ryan.1854/ // https://f95zone.to/threads/perverted-education-v0-9701-april-ryan.1854/
let url = "https://f95zone.to/threads/perverted-education-v0-9701-april-ryan.1854/"; let url =
"https://f95zone.to/threads/perverted-education-v0-9701-april-ryan.1854/";
const result = await F95API.getGameDataFromURL(url); const result = await F95API.getGameDataFromURL(url);
result.version = "0.9600"; result.version = "0.9600";