JokeAPI-v2/endpoints/info.js

const http = require("http");
const convertFileFormat = require("../src/fileFormatConverter");
const httpServer = require("../src/httpServer");
const parseURL = require("../src/parseURL");
const jsl = require("svjsl");
const parseJokes = require("../src/parseJokes");
const languages = require("../src/languages");
const settings = require("../settings");
const translate = require("../src/translate");

jsl.unused(http);


const meta = {
    "name": "Info",
    "desc": `Returns a lot of information about ${settings.info.name} and its jokes`,
    "usage": {
        "method": "GET",
        "url": `${settings.info.docsURL}/info`,
        "supportedParams": [
            "format",
            "lang"
        ]
    }
};

/**
 * Calls this endpoint
 * @param {http.IncomingMessage} req The HTTP server request
 * @param {http.ServerResponse} res The HTTP server response
 * @param {Array<String>} url URL path array gotten from the URL parser module
 * @param {Object} params URL query params gotten from the URL parser module
 * @param {String} format The file format to respond with
 */
const call = (req, res, url, params, format) => {
    jsl.unused([req, url, params]);

    let supportedLangsLength = languages.jokeLangs().length;
    let responseText = {};

    let totalJokesCount = (!jsl.isEmpty(parseJokes.jokeCount) ? parseJokes.jokeCount : 0);
    
    let idRangePerLang = {};
    let idRangePerLangXml = [];
    Object.keys(parseJokes.jokeCountPerLang).forEach(lc => {
        let to = (parseJokes.jokeCountPerLang[lc] - 1);
        idRangePerLang[lc] = [ 0, to ];
        idRangePerLangXml.push({
            langCode: lc,
            from: 0,
            to: to
        });
    });

    let systemLanguagesLength = translate.systemLangs().length;

    let lang = (params && params["lang"]) ? params["lang"] : settings.languages.defaultLanguage;

    if(format != "xml")
    {
        responseText = convertFileFormat.auto(format, {
            "error": false,
            "version": settings.info.version,
            "jokes":
            {
                "totalCount": totalJokesCount,
                "categories": [settings.jokes.possible.anyCategoryName, ...settings.jokes.possible.categories],
                "flags": settings.jokes.possible.flags,
                "types": settings.jokes.possible.types,
                "submissionURL": settings.jokes.jokeSubmissionURL,
                "idRange": idRangePerLang,
                "safeJokes": parseJokes.safeJokes
            },
            "formats": settings.jokes.possible.formats,
            "jokeLanguages": supportedLangsLength,
            "systemLanguages": systemLanguagesLength,
            "info": translate(lang, "messageOfTheDay", settings.info.name),
            "timestamp": new Date().getTime()
        }, lang);
    }
    else if(format == "xml")
    {
        responseText = convertFileFormat.auto(format, {
            "error": false,
            "version": settings.info.version,
            "jokes":
            {
                "totalCount": totalJokesCount,
                "categories": {"category": [settings.jokes.possible.anyCategoryName, ...settings.jokes.possible.categories]},
                "flags": {"flag": settings.jokes.possible.flags},
                "types": {"type": settings.jokes.possible.types},
                "submissionURL": settings.jokes.jokeSubmissionURL,
                "idRanges": { "idRange": idRangePerLangXml },
                "safeJokes": { "language": parseJokes.safeJokes }
            },
            "formats": {"format": settings.jokes.possible.formats},
            "jokeLanguages": supportedLangsLength,
            "systemLanguages": systemLanguagesLength,
            "info": translate(lang, "messageOfTheDay", settings.info.name),
            "timestamp": new Date().getTime()
        }, lang);
    }

    httpServer.pipeString(res, responseText, parseURL.getMimeTypeFromFileFormatString(format));
};

module.exports = { meta, call };