deluge-webapi 0.5.0__tar.gz

deluge_webapi-0.5.0/AUTHORS

@@ -0,0 +1,14 @@
+deluge-webapi authors
+=====================
+
+Created by Igor `idle sign` Starikov.
+
+
+Contributors
+------------
+
+theonedemon <https://github.com/theonedemon>
+Daniel Marcos <https://github.com/dmarcosl>
+Brandon Gillis <https://github.com/BrandonGillis>
+Ivan Filippov <https://github.com/ivanfilippov>
+griest024 <https://github.com/griest024>

deluge_webapi-0.5.0/CHANGELOG

@@ -0,0 +1,40 @@
+deluge-webapi changelog
+=======================
+
+v0.5.0
+------
+* CORS patching is moved into the WebUI part of the plugin, where the JSON component lives, fixing KeyError: 'JSON' when the WebUI and the daemon run in separate processes; changing CORS settings now requires a WebUI restart (close #36)
+* The plugin package is renamed into `deluge_webapi` to comply with the Deluge 2 plugin naming requirements (close #25)
+
+v0.4.0
+------
+* Added support for Deluge 2
+* get_torrents will now accept a comma separated string in addition to accepting a list for field filters
+* Future support for Deluge 1.x is no longer possible, please use the older eggs
+
+v0.3.1
+------
+* Added CORS settings for WebUI.
+
+
+v0.3.0
+------
+* Add CORS support.
+* Added CORS settings for GTK.
+
+
+v0.2.1
+------
+* Fixed add_rorrent download_location not honored (see #8).
+
+
+v0.2.0
+------
++ Plugin updated to work with Deluge 1.3.15
++ `add_torrent` now returns torrent id (hash) (see #5).
++ `remove_torrent` now returns the result of core function instad of `True`.
+
+
+v0.1.0
+------
++ Basic functionality.

deluge_webapi-0.5.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014-2019 Igor `idle sign` Starikov
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the deluge-webapi nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

deluge_webapi-0.5.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include AUTHORS
+include CHANGELOG
+include LICENSE
+include README.rst
+
+include docs/Makefile
+recursive-include docs *.rst
+recursive-include docs *.py
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * empty

deluge_webapi-0.5.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: deluge-webapi
+Version: 0.5.0
+Summary: Plugin for Deluge WebUI providing sane JSON API.
+Author-email: Igor `idle sign` Starikov <idlesign@yandex.ru>
+License: BSD 3-Clause License
+Project-URL: Homepage, https://github.com/idlesign/deluge-webapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: End Users/Desktop
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Dynamic: license-file
+
+deluge-webapi
+=============
+https://github.com/idlesign/deluge-webapi
+
+
+.. image:: https://img.shields.io/pypi/v/deluge-webapi.svg
+    :target: https://pypi.python.org/pypi/deluge-webapi
+
+
+Description
+-----------
+
+*Plugin for Deluge WebUI providing sane JSON API.*
+
+Exposes some sane JSON API through Deluge WebUI (missing out of the box or restyled) so that you can manipulate
+Deluge from your programs using HTTP requests.
+
+Supported methods:
+
+* ``get_torrents``
+* ``add_torrent`` (magnet or file)
+* ``remove_torrent``
+* ``get_api_version``
+
+Deluge is a lightweight, Free Software, cross-platform BitTorrent client. Download it at http://deluge-torrent.org/
+
+.. note:: Use egg version 0.4.0 or higher for Deluge 2
+.. note:: Use egg version 0.3.2 or lower for Deluge 1.x
+
+
+Installation
+------------
+
+1. Get plugin egg file, from ``dist/`` (https://github.com/idlesign/deluge-webapi/tree/master/dist) directory.
+
+2. Open Deluge Web UI, go to "Preferences -> Plugins -> Install plugin" and choose egg file.
+
+3. Activate ``WebAPI`` plugin.
+
+4. In case you use Client-Server setup, you'll need to install the plugin both on client and server, see - https://dev.deluge-torrent.org/wiki/Plugins#Client-ServerSetups
+
+
+.. note::
+
+    To build .egg file from source code yourself use ``python setup.py bdist_egg`` command in source code directory.
+
+
+Documentation
+-------------
+
+http://deluge-webapi.readthedocs.org/

deluge_webapi-0.5.0/README.rst

@@ -0,0 +1,51 @@
+deluge-webapi
+=============
+https://github.com/idlesign/deluge-webapi
+
+
+.. image:: https://img.shields.io/pypi/v/deluge-webapi.svg
+    :target: https://pypi.python.org/pypi/deluge-webapi
+
+
+Description
+-----------
+
+*Plugin for Deluge WebUI providing sane JSON API.*
+
+Exposes some sane JSON API through Deluge WebUI (missing out of the box or restyled) so that you can manipulate
+Deluge from your programs using HTTP requests.
+
+Supported methods:
+
+* ``get_torrents``
+* ``add_torrent`` (magnet or file)
+* ``remove_torrent``
+* ``get_api_version``
+
+Deluge is a lightweight, Free Software, cross-platform BitTorrent client. Download it at http://deluge-torrent.org/
+
+.. note:: Use egg version 0.4.0 or higher for Deluge 2
+.. note:: Use egg version 0.3.2 or lower for Deluge 1.x
+
+
+Installation
+------------
+
+1. Get plugin egg file, from ``dist/`` (https://github.com/idlesign/deluge-webapi/tree/master/dist) directory.
+
+2. Open Deluge Web UI, go to "Preferences -> Plugins -> Install plugin" and choose egg file.
+
+3. Activate ``WebAPI`` plugin.
+
+4. In case you use Client-Server setup, you'll need to install the plugin both on client and server, see - https://dev.deluge-torrent.org/wiki/Plugins#Client-ServerSetups
+
+
+.. note::
+
+    To build .egg file from source code yourself use ``python setup.py bdist_egg`` command in source code directory.
+
+
+Documentation
+-------------
+
+http://deluge-webapi.readthedocs.org/

deluge_webapi-0.5.0/deluge_webapi/__init__.py

@@ -0,0 +1,28 @@
+VERSION = (0, 5, 0)
+
+
+try:
+    from deluge.plugins.init import PluginInitBase
+
+    class CorePlugin(PluginInitBase):
+        def __init__(self, plugin_name):
+            from .core import Core as _plugin_cls
+            self._plugin_cls = _plugin_cls
+            super(CorePlugin, self).__init__(plugin_name)
+
+    class Gtk3UIPlugin(PluginInitBase):
+        def __init__(self, plugin_name):
+            from .gtk3ui import Gtk3UI as _plugin_cls
+            self._plugin_cls = _plugin_cls
+            super(Gtk3UIPlugin, self).__init__(plugin_name)
+
+    class WebUIPlugin(PluginInitBase):
+        def __init__(self, plugin_name):
+            from .webui import WebUI as _plugin_cls
+            self._plugin_cls = _plugin_cls
+            super(WebUIPlugin, self).__init__(plugin_name)
+
+
+except ImportError:
+    # That's what we do when this import prevents docs from being built.
+    pass

deluge_webapi-0.5.0/deluge_webapi/common.py

@@ -0,0 +1,17 @@
+from importlib.resources import files
+
+from packaging import version
+
+from deluge.common import get_version
+
+DEFAULT_PREFS = {
+    "enable_cors": False,
+    "allowed_origin": [],
+}
+
+# twisted uses byte strings in deluge version 2.1.0 onward
+use_bytes = version.parse(get_version()) >= version.parse("2.1.0")
+
+
+def get_resource(filename):
+    return str(files("deluge_webapi").joinpath("data", filename))

deluge_webapi-0.5.0/deluge_webapi/core.py

@@ -0,0 +1,35 @@
+import logging
+
+import deluge.configmanager
+from deluge.core.rpcserver import export
+from deluge.plugins.pluginbase import CorePluginBase
+
+from .common import DEFAULT_PREFS
+
+LOGGER = logging.getLogger(__name__)
+
+
+class Core(CorePluginBase):
+
+    def enable(self):
+        LOGGER.info('Enabling WebAPI plugin CORE ...')
+
+        self.config = deluge.configmanager.ConfigManager('webapi.conf', DEFAULT_PREFS)
+
+    def disable(self):
+        LOGGER.info('Disabling WebAPI plugin CORE ...')
+
+        self.config.save()
+
+    @export
+    def set_config(self, config):
+        """sets the config dictionary"""
+
+        for key in config.keys():
+            self.config[key] = config[key]
+
+        self.config.save()
+
+    @export
+    def get_config(self):
+        return self.config.config

deluge_webapi-0.5.0/deluge_webapi/data/config.ui

@@ -0,0 +1,146 @@
+<?xml version="1.0"?>
+<interface>
+  <!-- interface-requires gtk+ 2.24 -->
+  <!-- interface-naming-policy toplevel-contextual -->
+  <object class="GtkWindow" id="window1">
+    <property name="can_focus">False</property>
+    <child>
+      <object class="GtkHBox" id="prefs_box">
+        <property name="visible">True</property>
+        <property name="can_focus">False</property>
+        <child>
+          <object class="GtkLayout" id="layout1">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <child>
+              <object class="GtkCheckButton" id="enable_cors">
+                <property name="label" translatable="yes">enable CORS (cross-origin request)</property>
+                <property name="width_request">247</property>
+                <property name="height_request">80</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">False</property>
+                <property name="use_action_appearance">False</property>
+                <property name="draw_indicator">True</property>
+              </object>
+              <packing>
+                <property name="x">18</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkLabel" id="label1">
+                <property name="width_request">152</property>
+                <property name="height_request">21</property>
+                <property name="visible">True</property>
+                <property name="can_focus">False</property>
+                <property name="xalign">0</property>
+                <property name="yalign">0</property>
+                <property name="label" translatable="yes">Allowed domain name :</property>
+              </object>
+              <packing>
+                <property name="x">19</property>
+                <property name="y">60</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkEntry" id="new_domain">
+                <property name="width_request">153</property>
+                <property name="height_request">27</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="invisible_char">&#x25CF;</property>
+                <property name="primary_icon_activatable">False</property>
+                <property name="secondary_icon_activatable">False</property>
+                <property name="primary_icon_sensitive">True</property>
+                <property name="secondary_icon_sensitive">True</property>
+              </object>
+              <packing>
+                <property name="x">67</property>
+                <property name="y">286</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="add_button">
+                <property name="label" translatable="yes">Add</property>
+                <property name="width_request">49</property>
+                <property name="height_request">27</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_action_appearance">False</property>
+              </object>
+              <packing>
+                <property name="x">16</property>
+                <property name="y">286</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkTreeView" id="listview_allowed_domains">
+                <property name="width_request">263</property>
+                <property name="height_request">194</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+              </object>
+              <packing>
+                <property name="x">16</property>
+                <property name="y">84</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkScrolledWindow" id="scrolledwindow_allowed_domains">
+                <property name="width_request">356</property>
+                <property name="height_request">197</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="hscrollbar_policy">automatic</property>
+                <property name="vscrollbar_policy">automatic</property>
+                <child>
+                  <placeholder/>
+                </child>
+              </object>
+              <packing>
+                <property name="x">16</property>
+                <property name="y">81</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="remove_button">
+                <property name="label" translatable="yes">Remove</property>
+                <property name="width_request">69</property>
+                <property name="height_request">27</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_action_appearance">False</property>
+              </object>
+              <packing>
+                <property name="x">221</property>
+                <property name="y">286</property>
+              </packing>
+            </child>
+            <child>
+              <object class="GtkButton" id="remove_all_button">
+                <property name="label" translatable="yes">Remove all</property>
+                <property name="width_request">82</property>
+                <property name="height_request">27</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_action_appearance">False</property>
+              </object>
+              <packing>
+                <property name="x">290</property>
+                <property name="y">286</property>
+              </packing>
+            </child>
+          </object>
+          <packing>
+            <property name="expand">True</property>
+            <property name="fill">True</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>

deluge_webapi-0.5.0/deluge_webapi/data/webapi.js

@@ -0,0 +1,198 @@
+
+WebApiPanel = Ext.extend(Ext.form.FormPanel, {
+
+
+    constructor: function(config) {
+
+        config = Ext.apply({
+            title: _('WebAPI'),
+            border: false,
+            labelWidth: 10,
+            autoHeight: true
+        }, config);
+
+        WebApiPanel.superclass.constructor.call(this, config);
+    },
+    initComponent: function() {
+        WebApiPanel.superclass.initComponent.call(this);
+        this.opts = new Deluge.OptionsManager();
+
+        var fieldset = this.add({
+            xtype: 'fieldset',
+            title: _('WebAPI Settings'),
+            defaultType: 'checkbox',
+            autoHeight: true
+        });
+
+        this.opts.bind('enable_cors', fieldset.add({
+            name: 'enable_cors',
+            id: 'enable_cors',
+            height: 22,
+            fieldLabel: '',
+            labelSeparator: '',
+            boxLabel: _('Enable CORS (cross-origin request)')
+        }));
+
+        this.list = this.add({
+            xtype: 'listview',
+            height: 150,
+            store: new Ext.data.ArrayStore({
+                fields: [
+                    { name: 'domain', mapping: 0 }
+                ]
+            }),
+            columns: [{
+                id: 'domain',
+                header: _('Allowed domain'),
+                width: 1,
+                sortable: true,
+                dataIndex: 'domain'
+            }],
+            singleSelect: true,
+            autoExpandColumn: 'domain',
+            listeners: {
+                selectionchange: { fn: this.onDomainSelect, scope: this }
+            }
+        });
+
+        this.panel = this.add({
+            region: 'center',
+            autoScroll: true,
+            items: [this.list]
+        });
+
+        this.domain_name = this.opts.bind('domain_name', fieldset.add({
+            fieldLabel: '',
+            xtype: 'textfield',
+            anchor: '50%',
+            name: 'domain_name',
+            id: 'domain_name',
+            autoWidth: true,
+            value: ''
+        }));
+
+        this.toolbar = this.add({
+            fieldLabel: _(''),
+            name: 'list_toolbar',
+            xtype: 'container',
+            layout: 'hbox',
+            items: [
+                {
+                    xtype: 'button',
+                    text: 'Add'
+                },
+                this.domain_name,
+                {
+                    xtype: 'button',
+                    text: 'Remove'
+                },
+                {
+                    xtype: 'button',
+                    text: 'Remove all'
+                }
+            ]
+        });
+
+        this.toolbar.getComponent(0).setHandler(this.addDomain, this);
+        this.toolbar.getComponent(2).setHandler(this.removeDomain, this);
+        this.toolbar.getComponent(3).setHandler(this.removeAllDomain, this);
+
+        deluge.preferences.on('show', this.onPreferencesShow, this);
+    },
+
+    removeDomain: function() {
+        if (!this.selectedDomain) return;
+        var index = this.list.getStore().find('domain', this.selectedDomain);
+        if (index == -1) return;
+        this.list.getStore().removeAt(index);
+        index = this.allowedDomains.indexOf(this.selectedDomain);
+        if (index !== -1) this.allowedDomains.splice(index, 1);
+        this.selectedDomain = false;
+    },
+
+    removeAllDomain: function() {
+        this.list.getStore().removeAll();
+        this.allowedDomains = [];
+        this.selectedDomain = false;
+    },
+
+    onDomainSelect: function (dv, selections) {
+        if (selections.length === 0) return;
+        var r = dv.getRecords(selections)[0];
+        this.selectedDomain = r.get('domain');
+    },
+
+    addDomain: function() {
+        var changed = this.opts.getDirty();
+        if (!Ext.isObjectEmpty(changed)) {
+            if (!Ext.isEmpty(changed['domain_name'])) {
+                changed['domain_name'] = changed['domain_name'];
+                this.allowedDomains.push(changed['domain_name']);
+                this.updateDomainsGrid();
+            }
+        }
+    },
+
+    updateDomainsGrid: function () {
+        var Domains = [];
+        Ext.each(this.allowedDomains, function (domain) {
+                Domains.push([domain]);
+        }, this);
+        this.list.getStore().loadData(Domains);
+    },
+
+    onPreferencesShow: function () {
+        deluge.client.webapi.get_config({
+            success: function (config) {
+                if (!Ext.isEmpty(config['enable_cors'])) {
+                    config['enable_cors'] = config['enable_cors'];
+                }
+                if (!Ext.isEmpty(config['allowed_origin'])) {
+                    config['allowed_origin'] = config['allowed_origin'];
+                }
+                this.allowedDomains = config['allowed_origin'];
+                this.updateDomainsGrid();
+                this.opts.set(config);
+            },
+            scope: this
+        });
+    },
+
+    onApply: function(e) {
+        var changed = this.opts.getDirty();
+        if (!Ext.isObjectEmpty(changed)) {
+            if (!Ext.isEmpty(changed['enable_cors'])) {
+                changed['enable_cors'] = changed['enable_cors'];
+            }
+            deluge.client.webapi.set_config(changed, {
+                success: this.onSetConfig,
+                scope: this
+            });
+        }
+        var config = {};
+        config['allowed_origin'] = this.allowedDomains;
+        console.log(config);
+        deluge.client.webapi.set_config(config);
+    },
+
+    onSetConfig: function() {
+        this.opts.commit();
+    }
+
+});
+
+
+WebApiPlugin = Ext.extend(Deluge.Plugin, {
+
+    name: 'WebAPI',
+
+    onDisable: function() {
+        deluge.preferences.removePage(this.prefsPage);
+    },
+
+    onEnable: function() {
+        this.prefsPage = deluge.preferences.addPage(new WebApiPanel());
+    }
+});
+
+Deluge.registerPlugin('WebAPI', WebApiPlugin);