4lyric/src/modules/musixmatch.js

Get lyrics from 4 sites, lyrics.com, musixmatch.com, azlyrics.com and lyricslive.com [2.0 branch]

const { join } = require('path');
const { readFileSync } = require('fs');
const UserAgents = readFileSync(join(__dirname, '..', 'user-agents.txt')).toString().split('\n');

const fetch = require('node-fetch');
const { select } = require('xpath');
const { DOMParser } = require('xmldom');

const SEARCH_URL = 'https://www.musixmatch.com/search/';

class MusixMatch {
    /**
     * @returns {string} Random user agent
     */
    get useragent() {
        const h = UserAgents[Math.floor(Math.random() * UserAgents.length)];
        return Buffer.from(h, 'ascii').toString().trim();
    }

    /**
     * Fetches a list of song lyric URLs based on the query.
     * @param {string} query
     * @returns {string[]} URL list
     */
    async fetchURLs(q) {
        try {
            const res = await fetch(SEARCH_URL + encodeURIComponent(q), {
                headers: { // headers found after making a search
                    'Host': 'www.musixmatch.com',
                    'User-Agent': this.useragent,
                    'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
                    'Accept-Language': 'en-US,en;q=0.5',
                    'Referer': 'https://www.musixmatch.com/search/',
                    'Upgrade-Insecure-Requests': 1,
                    'Cache-Control': 'max-age=0',
                }
            });

            if(res.status !== 200) throw new Error(`Received status ${res.status} (${res.statusText})`);

            return this.parseURLs(await res.text());
        } catch(err) {
            throw err;
        }
    }

    /**
     * Parses the HTML fetched previously, returning an array of URLs.
     * @param {string} html
     * @returns Array of URLs
     */
    parseURLs(t) {
        const doc = new DOMParser({ errorHandler: {warning:()=>{}, error:()=>{}} }).parseFromString(t);
        const nodes = select('//a[@class="title"]', doc);        
        const list = [];

        // go through each node and each attribute
        for(let j = 0; j < nodes.length; j++) {
            for(let i = 0; i < nodes[j].attributes.length; i++) {
                if(nodes[j].attributes[i.toString()].nodeName === 'href') { // keys are stored as strings
                    list.push('https://musixmatch.com' + nodes[j].attributes[i.toString()].value);
                    break;
                }
            }
        }

        return list;
    }

    /**
     * Fetch lyrics from specified URL
     * @param {string} url 
     */
    async fetchLyrics(url) {
        if(typeof url !== 'string') throw new Error('URL must be of type string');
        if(!/https?:\/\/(www.)?musixmatch.com\/lyrics\//.test(url)) throw new Error('Invalid URL ' + url);

        const res = await fetch(url, {
            headers: {
                'Host': 'www.musixmatch.com',
                'User-Agent': this.useragent,
                'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
                'Accept-Language': 'en-US,en;q=0.5',
                'Upgrade-Insecure-Requests': 1,
                'Cache-Control': 'max-age=0'
            }
        });

        if(res.status !== 200) throw new Error(`Received status ${res.status} (${res.statusText})`);

        return this.parseLyrics(await res.text());
    }

    /**
     * Parse the page's HTML and return the lyrics.
     * @param {string} html 
     * @returns {Array<string>} Array of lyric blocks
     */
    parseLyrics(t) {
        const doc = new DOMParser({ errorHandler: {warning:()=>{}, error:()=>{}} }).parseFromString(t);
        const nodes = select('//span[@class="lyrics__content__ok"]', doc);        
        const lyrics = [];

        for(let j = 0; j < nodes.length; j++) {
            if(typeof nodes[j].firstChild !== 'undefined' && typeof nodes[j].firstChild.data !== 'undefined') {
                lyrics.push(nodes[j].firstChild.data);
            }
        }

        return lyrics;
    }
}

module.exports = MusixMatch;