F95API/app/scripts/searcher.js

"use strict";

// Public modules from npm
const cheerio = require("cheerio");

// Modules from file
const { fetchHTMLWithAuth } = require("./network-helper.js");
const shared = require("./shared.js");
const f95Selector = require("./constants/css-selector.js");

//#region Public methods
/**
 * @protected
 * Search for a game on F95Zone and return a list of URLs, one for each search result.
 * @param {String} name Game name
 * @param {Credentials} credentials Platform access credentials
 * @returns {Promise<String[]>} URLs of results
 */
module.exports.searchGame = async function (name, credentials) {
    shared.logger.info(`Searching games with name ${name}`);

    // Replace the whitespaces with +
    const searchName = encodeURIComponent(name.toUpperCase());
    
    // Prepare the URL (only title, search in the "Games" section, order by relevance)
    const url = `https://f95zone.to/search/83456043/?q=${searchName}&t=post&c[child_nodes]=1&c[nodes][0]=2&c[title_only]=1&o=relevance`;

    // Fetch and parse the result URLs
    return await fetchResultURLs(url, credentials);
};

/**
 * @protected
 * Search for a mod on F95Zone and return a list of URLs, one for each search result.
 * @param {String} name Mod name
 * @param {Credentials} credentials Platform access credentials
 * @returns {Promise<String[]>} URLs of results
 */
module.exports.searchMod = async function (name, credentials) {
    shared.logger.info(`Searching mods with name ${name}`);
    
    // Replace the whitespaces with +
    const searchName = encodeURIComponent(name.toUpperCase());

    // Prepare the URL (only title, search in the "Mods" section, order by relevance)
    const url = `https://f95zone.to/search/83459796/?q=${searchName}&t=post&c[child_nodes]=1&c[nodes][0]=41&c[title_only]=1&o=relevance`;

    // Fetch and parse the result URLs
    return await fetchResultURLs(url, credentials);
};
//#endregion Public methods

//#region Private methods
/**
 * @private
 * Gets the URLs of the threads resulting from the F95Zone search.
 * @param {String} url Search URL
 * @param {Credentials} credentials Platform access credentials
 * @return {Promise<String[]>} List of URLs
 */
async function fetchResultURLs(url, credentials) {
    shared.logger.info(`Fetching ${url}...`);

    // Fetch HTML and prepare Cheerio
    const html = await fetchHTMLWithAuth(url, credentials);
    const $ = cheerio.load(html);

    // Here we get all the DIV that are the body of the various query results
    const results = $("body").find(f95Selector.GS_RESULT_BODY);

    // Than we extract the URLs
    const urls = results.map((idx, el) => {
        const elementSelector = $(el);
        return extractLinkFromResult(elementSelector);
    }).get();

    return urls;
}

/**
 * @private
 * Look for the URL to the thread referenced by the item.
 * @param {cheerio.Cheerio} selector Element to search
 * @returns {String} URL to thread
 */
function extractLinkFromResult(selector) {
    const link = selector
        .find(f95Selector.GS_RESULT_THREAD_TITLE)
        .attr("href")
        .trim();

    return link;
}
//#endregion Private methods