transmission/web/javascript/remote.js

/**
 * Copyright © Charles Kerr, Dave Perrett, Malcolm Jarvis and Bruno Bierbaumer
 *
 * This file is licensed under the GPLv2.
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 */

var RPC = {
    _DaemonVersion: 'version',
    _DownSpeedLimit: 'speed-limit-down',
    _DownSpeedLimited: 'speed-limit-down-enabled',
    _QueueMoveTop: 'queue-move-top',
    _QueueMoveBottom: 'queue-move-bottom',
    _QueueMoveUp: 'queue-move-up',
    _QueueMoveDown: 'queue-move-down',
    _Root: '../rpc',
    _TurtleDownSpeedLimit: 'alt-speed-down',
    _TurtleState: 'alt-speed-enabled',
    _TurtleUpSpeedLimit: 'alt-speed-up',
    _UpSpeedLimit: 'speed-limit-up',
    _UpSpeedLimited: 'speed-limit-up-enabled'
};

function TransmissionRemote(controller) {
    this.initialize(controller);
    return this;
}

TransmissionRemote.prototype = {
    /*
     * Constructor
     */
    initialize: function (controller) {
        this._controller = controller;
        this._error = '';
        this._token = '';
    },

    /*
     * Display an error if an ajax request fails, and stop sending requests
     * or on a 409, globally set the X-Transmission-Session-Id and resend
     */
    ajaxError: function (request, error_string, exception, ajaxObject) {
        var token;
        var remote = this;

        // set the Transmission-Session-Id on a 409
        if (request.status === 409 && (token = request.getResponseHeader('X-Transmission-Session-Id'))) {
            remote._token = token;
            $.ajax(ajaxObject);
            return;
        };

        remote._error = request.responseText ? request.responseText.trim().replace(/(<([^>]+)>)/ig, "") : "";
        if (!remote._error.length) {
            remote._error = 'Server not responding';
        };

        dialog.confirm('Connection Failed',
            'Could not connect to the server. You may need to reload the page to reconnect.',
            'Details',
            function () {
                alert(remote._error);
            },
            'Dismiss');
        remote._controller.togglePeriodicSessionRefresh(false);
    },

    appendSessionId: function (XHR) {
        if (this._token) {
            XHR.setRequestHeader('X-Transmission-Session-Id', this._token);
        };
    },

    sendRequest: function (data, callback, context, async) {
        var remote = this;
        if (typeof (async) != 'boolean') {
            async = true;
        };

        var ajaxSettings = {
            url: RPC._Root,
            type: 'POST',
            contentType: 'json',
            dataType: 'json',
            cache: false,
            data: JSON.stringify(data),
            beforeSend: function (XHR) {
                remote.appendSessionId(XHR);
            },
            error: function (request, error_string, exception) {
                remote.ajaxError(request, error_string, exception, ajaxSettings);
            },
            success: callback,
            context: context,
            async: async
        };

        $.ajax(ajaxSettings);
    },

    loadDaemonPrefs: function (callback, context, async) {
        var o = {
            method: 'session-get'
        };
        this.sendRequest(o, callback, context, async);
    },

    checkPort: function (callback, context, async) {
        var o = {
            method: 'port-test'
        };
        this.sendRequest(o, callback, context, async);
    },

    renameTorrent: function (torrentIds, oldpath, newname, callback, context) {
        var o = {
            method: 'torrent-rename-path',
            arguments: {
                'ids': torrentIds,
                'path': oldpath,
                'name': newname
            }
        };
        this.sendRequest(o, callback, context);
    },

    loadDaemonStats: function (callback, context, async) {
        var o = {
            method: 'session-stats'
        };
        this.sendRequest(o, callback, context, async);
    },

    updateTorrents: function (torrentIds, fields, callback, context) {
        var o = {
            method: 'torrent-get',
            arguments: {
                'fields': fields
            }
        };
        if (torrentIds) {
            o['arguments'].ids = torrentIds;
        };
        this.sendRequest(o, function (response) {
            var args = response['arguments'];
            callback.call(context, args.torrents, args.removed);
        });
    },

    getFreeSpace: function (dir, callback, context) {
        var remote = this;
        var o = {
            method: 'free-space',
            arguments: {
                path: dir
            }
        };
        this.sendRequest(o, function (response) {
            var args = response['arguments'];
            callback.call(context, args.path, args['size-bytes']);
        });
    },

    changeFileCommand: function (torrentId, fileIndices, command) {
        var remote = this,
            args = {
                ids: [torrentId]
            };
        args[command] = fileIndices;
        this.sendRequest({
            arguments: args,
            method: 'torrent-set'
        }, function () {
            remote._controller.refreshTorrents([torrentId]);
        });
    },

    sendTorrentSetRequests: function (method, torrent_ids, args, callback, context) {
        if (!args) {
            args = {};
        };
        args['ids'] = torrent_ids;
        var o = {
            method: method,
            arguments: args
        };
        this.sendRequest(o, callback, context);
    },

    sendTorrentActionRequests: function (method, torrent_ids, callback, context) {
        this.sendTorrentSetRequests(method, torrent_ids, null, callback, context);
    },

    startTorrents: function (torrent_ids, noqueue, callback, context) {
        var name = noqueue ? 'torrent-start-now' : 'torrent-start';
        this.sendTorrentActionRequests(name, torrent_ids, callback, context);
    },
    stopTorrents: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests('torrent-stop', torrent_ids, callback, context);
    },

    moveTorrents: function (torrent_ids, new_location, callback, context) {
        var remote = this;
        this.sendTorrentSetRequests('torrent-set-location', torrent_ids, {
            "move": true,
            "location": new_location
        }, callback, context);
    },

    removeTorrents: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests('torrent-remove', torrent_ids, callback, context);
    },
    removeTorrentsAndData: function (torrents) {
        var remote = this;
        var o = {
            method: 'torrent-remove',
            arguments: {
                'delete-local-data': true,
                ids: []
            }
        };

        if (torrents) {
            for (var i = 0, len = torrents.length; i < len; ++i) {
                o.arguments.ids.push(torrents[i].getId());
            };
        };
        this.sendRequest(o, function () {
            remote._controller.refreshTorrents();
        });
    },
    verifyTorrents: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests('torrent-verify', torrent_ids, callback, context);
    },
    reannounceTorrents: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests('torrent-reannounce', torrent_ids, callback, context);
    },
    addTorrentByUrl: function (url, options) {
        var remote = this;
        if (url.match(/^[0-9a-f]{40}$/i)) {
            url = 'magnet:?xt=urn:btih:' + url;
        }
        var o = {
            method: 'torrent-add',
            arguments: {
                paused: (options.paused),
                filename: url
            }
        };
        this.sendRequest(o, function () {
            remote._controller.refreshTorrents();
        });
    },
    savePrefs: function (args) {
        var remote = this;
        var o = {
            method: 'session-set',
            arguments: args
        };
        this.sendRequest(o, function () {
            remote._controller.loadDaemonPrefs();
        });
    },
    updateBlocklist: function () {
        var remote = this;
        var o = {
            method: 'blocklist-update'
        };
        this.sendRequest(o, function () {
            remote._controller.loadDaemonPrefs();
        });
    },

    // Added queue calls
    moveTorrentsToTop: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests(RPC._QueueMoveTop, torrent_ids, callback, context);
    },
    moveTorrentsToBottom: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests(RPC._QueueMoveBottom, torrent_ids, callback, context);
    },
    moveTorrentsUp: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests(RPC._QueueMoveUp, torrent_ids, callback, context);
    },
    moveTorrentsDown: function (torrent_ids, callback, context) {
        this.sendTorrentActionRequests(RPC._QueueMoveDown, torrent_ids, callback, context);
    }
};