minisrv/zefie_wtvp_minisrv/WTVDownloadList.js

/**
 * wtv/download-list creation helper class
 * By: zefie
 */
class WTVDownloadList {

    download_list = "";
    service_name = "";
    content_type = "wtv/download-list";
    wtvshared = null;
    clientShowAlert = null;

    /**
     * Constructs the WTVDownloadList Class
     * @param {string} service_name Service name to use in wtv-urls
     */
    constructor(service_name = "wtv-disk") {
        var { WTVShared, clientShowAlert } = require('./WTVShared.js');
        this.wtvshared = new WTVShared();
        this.clientShowAlert = clientShowAlert;
        this.service_name = service_name
        this.clear();
    }

    /**
     * Clears the download list
     */
    clear() {
        this.download_list = "";
    }

    /**
     * Alias to clear() (clears the download list)
     */
    reset() {
        this.clear();
    }

    /**
     * Returns the download list.
     * @returns {string} Download list for client;
     */
    getDownloadList() {
        return this.download_list;
    }

    /**
     * Adds a DISPLAY command to the download list
     * @param {string} message Message to display to the client
     */
    display(message) {
        this.download_list += "DISPLAY " + message + "\n\n";
    }

    /**
     * Adds an EXECUTE command to the download list
     * @param {string} command client command to execute
     */
    execute(command) {
        this.download_list += "EXECUTE " + command + "\n\n";
    }

    /**
     * Adds a CREATE partition command to the download list
     * @param {string} path file://Disk/ path to desired partition
     * @param {string} size Size of the desired partition
     */
    createPartition(path, size) {
        this.download_list += "CREATE " + path + "\n";
        this.download_list += "partition-size: " + size + "\n\n";
    }

    /**
     * Adds a CREATE-GROUP command to the download list
     * @param {string} name Group name
     * @param {string} path file://Disk/ path of desired group
     * @param {string} state Group state
     * @param {boolean|null} service_owned Sets service owned flag. (null = don't set)
     */
    createGroup(name, path, state = 'invalid', service_owned = null) {
        this.download_list += "CREATE-GROUP " + name + "\n";
        this.download_list += "state: " + state + "\n";
        if (service_owned !== null) this.download_list += "service-owned: " + service_owned + "\n";
        this.download_list += "base: " + path + "\n\n";
    }

    /**
     * An alias for createGroup() that handles creating the '-UPDATE' group for you
     * @param {string} name Group name
     * @param {string} path file://Disk/ path of desired group
     * @param {string} state Group state
     * @param {boolean} service_owned Sets service owned flag.
     */
    createUpdateGroup(name, path, state = 'invalid', service_owned = false) {
        this.createGroup(name + "-UPDATE", path, state);
        this.createGroup(name, path, state, service_owned);
    }

    /**
     * Adds a DELETE command to the download list
     * @param {string} path Non-absolute path of client destination file (relative to group base) if group defined, otherwise absolute file://Disk/ path to delete
     * @param {string} group Group to which it belongs
     */
    delete(path, group = null) {
        this.download_list += "DELETE " + path + "\n";
        if (group !== null) this.download_list += "group: " + group + "\n\n";
    }

    /**
     * Adds a PUT command to the download list
     * @param {string} path Absolute file://Disk/ path of a file to upload to the service
     * @param {string} destination Destination address (wtv url on service) in which to POST upload the file to
     */
    put(path, destination) {
        this.download_list += "PUT " + path + "\n";
        this.download_list += "location: " + destination + "\n";
    }

    /**
    * Alias to put() for User Store
    * @param {string} path Absolute file://Disk/ path of a file to upload to the service
    * @param {string} destination Destination file path in the User Store
    */
    putUserStoreDest(path, destination) {
        this.download_list += "PUT " + path + "\n";
        this.download_list += "location: " + this.service_name + ":/userstore?partialPath="+escape(destination) + "\n";
    }

    /**
     * Alias to putUserStoreDest() that generates the destination
     * @param {any} path
     */
    putUserStore(path) {
        var destination = path.replace("file://", "");
        this.download_list += "PUT " + path + "\n";
        this.download_list += "location: " + this.service_name + ":/userstore?partialPath=" + escape(destination) + "\n";
    }
    /**
     * Adds a GET command to the download list
     * @param {string} file Non-absolute path of client destination file (relative to group base)
     * @param {string} path Absolute file://Disk/ path of destination
     * @param {string} source wtv-url to fetch file from
     * @param {string} group Group this file belongs to
     * @param {string} display Message to display while working on this file
     * @param {string} checksum md5sum of the file
     * @param {string} file_permission File permissions
     */
    get(file, path, source, group, checksum = null, file_permission = 'r') {
        this.download_list += "GET " + file + "\n";
        this.download_list += "group: " + group + "-UPDATE\n";
        this.download_list += "location: " + source + "\n";
        this.download_list += "file-permission: " + file_permission + "\n";
        if (checksum != null) this.download_list += "wtv-checksum: " + checksum + "\n";
        this.download_list += "service-source-location: /webtv/content/" + source.substr(source.indexOf('-') + 1, source.indexOf(':/') - source.indexOf('-') - 1) + "d/" + source.substr(source.indexOf(':/') + 2) + "\n";
        this.download_list += "client-dest-location: " + path + "\n\n";
    }

    /**
     * Adds a RENAME command to the download list
     * @param {string} srcfile Non-absolute path of client source file (relative to source group base)
     * @param {string} destfile Non-absolute path of client destination file (relative to destination group base)
     * @param {string} srcgroup Source Group
     * @param {string} destgroup Destination Group
     */
    rename(srcfile, destfile, srcgroup, destgroup) {
        this.download_list += "RENAME " + srcfile + "\n";
        this.download_list += "group: " + srcgroup + "-UPDATE\n";
        this.download_list += "destination-group: " + destgroup + "\n";
        this.download_list += "location: " + destfile + "\n\n";
    }

    /**
     * Adds a SET-GROUP command to the download list
     * @param {string} group Group to set state of
     * @param {string} state State to set group to
     * @param {string} version Version to set group to
     */
    setGroup(group, state, version) {
        this.download_list += "SET-GROUP " + group + "\n";
        this.download_list += "state: " + state + "\n";
        this.download_list += "version: " + version + "\n";
        this.download_list += "last-checkup-time: " + new Date().toUTCString().replace("GMT", "+0000") + "\n\n";
    }

    /**
     * Adds a DELETE-GROUP command to the download list
     * @param {string} group Group to delete
     */
    deleteGroup(group) {
        this.download_list += "DELETE-GROUP " + group + "\n\n";
    }

    /**
     * An alias for deleteGroup() that handles deleting the '-UPDATE' group files for you
     * @param {string} group Group to delete
     * @param {string} path Group base path
     */
    deleteGroupUpdate(group, path) {
        this.deleteGroup(group + "-UPDATE");
        this.delete(path + ".GROUP-UPDATE/");
    }

   /**
    * Generates the Download page
    * @param {object} minisrv_config minisrv config object
    * @param {string} title Page title
    * @param {string} group
    * @param {string|null} diskmap
    * @param {string|null} main_message Message displayed in the center of the page
    * @param {string|null} message Initial progress bar message
    * @param {boolean|null} force_update Force this update even if the client reports the files are synced
    * @param {string|null} success_url Where the client goes when the process succeeds
    * @param {string|null} fail_url  Where the client goes when the process fails.
    * @param {string|null} url Use your own URL for client:fetch?source= instead of our generated one
    * @returns {string} HTML Download Page
    */
    getSyncPage(minisrv_config, title, group, diskmap = null, main_message = null, message = null, force_update = null, success_url = null, fail_url = null, url = null) {
        // Begin Set defaults
        if (main_message === null) main_message = "Your receiver is downloading files.";

        if (message === null) message = "Retrieving files";

        if (force_update === null) force_update = false;

        if (url === null) url = this.service_name + ":/sync?diskmap=" + escape(diskmap) + "&force=" + force_update;

        if (success_url === null) success_url = new this.clientShowAlert({
            'image': minisrv_config.config.service_logo,
            'message': "Download successful!",
            'buttonlabel1': "Okay",
            'buttonaction1': "client:goback",
            'noback': true,
        }).getURL();

        if (fail_url === null) fail_url = new this.clientShowAlert({
            'image': minisrv_config.config.service_logo,
            'message': "Download failed...",
            'buttonlabel1': "Okay...",
            'buttonaction1': "client:goback",
            'noback': true,
        }).getURL();
        // End set defaults
        return `<html>
<head>
        <meta
                http-equiv=refresh
                    content="0;url=client:Fetch?group=${escape(group)}&source=${escape(url)}&message=${escape(message)}"
        >
        <display downloadsuccess="${success_url}" downloadfail="${fail_url}">
        <title>${title}</title>
</head>
<body bgcolor=#0 text=#42CC55 fontsize=large hspace=0 vspace=0>
<table cellspacing=0 cellpadding=0>
        <tr>
                <td width=104 height=74 valign=middle align=center bgcolor=3B3A4D>
                        <img src="${minisrv_config.config.service_logo}" width=86 height=64>
                <td width=20 valign=top align=left bgcolor=3B3A4D>
                        <spacer>
                <td colspan=2 width=436 valign=middle align=left bgcolor=3B3A4D>
                        <font color=D6DFD0 size=+2><blackface><shadow>
                                <spacer type=block width=1 height=4>
                                <br>
                                        ${message}
                                </shadow>
                                </blackface>
                        </font>
        <tr>
                <td width=104 height=20>
                <td width=20>
                <td width=416>
                <td width=20>
        <tr>
                <td colspan=2>
                <td>
                        <font size=+1>
                               ${main_message}
                                <p>This may take a while.
                        </font>
        <tr>
                <td colspan=2>
                <td>
                        <br><br>
                        <font color=white>
                        <progressindicator name="downloadprogress"
                           message="Preparing..."
                           height=40 width=250>
                        </font>
</table>
</body>
</html>

`
    }

}

module.exports = WTVDownloadList;