cone.fileupload 0.8__py3-none-any.whl

cone/fileupload/__init__.py

@@ -0,0 +1,34 @@
+from cone.app import cfg
+from cone.app import main_hook
+from cone.fileupload.browser import static_resources
+import logging
+
+
+logger = logging.getLogger('cone.fileupload')
+
+
+@main_hook
+def initialize_fileupload(config, global_config, settings):
+    # application startup initialization
+
+    # protected CSS
+    cfg.css.protected.append('fileupload-static/fileupload/jquery.fileupload.css')
+    cfg.css.protected.append('fileupload-static/fileupload.css')
+
+    # protected JS
+    cfg.js.protected.append('fileupload-static/fileupload/vendor/tmpl.min.js')
+    cfg.js.protected.append('fileupload-static/fileupload/jquery.iframe-transport.js')
+    cfg.js.protected.append('fileupload-static/fileupload/jquery.fileupload.js')
+    cfg.js.protected.append('fileupload-static/fileupload/jquery.fileupload-process.js')
+    cfg.js.protected.append('fileupload-static/fileupload/jquery.fileupload-validate.js')
+    cfg.js.protected.append('fileupload-static/fileupload/jquery.fileupload-ui.js')
+    cfg.js.protected.append('fileupload-static/fileupload.js')
+
+    # add translation
+    config.add_translation_dirs('cone.fileupload:locale/')
+
+    # static resources
+    config.add_view(static_resources, name='fileupload-static')
+
+    # scan browser package
+    config.scan('cone.fileupload.browser')

cone/fileupload/browser/__init__.py

@@ -0,0 +1,4 @@
+from pyramid.static import static_view
+
+
+static_resources = static_view('static', use_subpath=True)

cone/fileupload/browser/actions.py

@@ -0,0 +1,99 @@
+from cone.app.browser.actions import Action
+from cone.app.browser.actions import ButtonAction
+from cone.app.browser.actions import LinkAction
+from cone.app.browser.contextmenu import context_menu_item
+from pyramid.i18n import get_localizer
+from pyramid.i18n import TranslationStringFactory
+
+
+_ = TranslationStringFactory('cone.fileupload')
+
+
+@context_menu_item(group='childactions', name='add_files')
+class ActionAddFiles(LinkAction):
+    id = 'toolbaraction-add-files'
+    icon = 'glyphicon glyphicon-plus'
+    text = _('action_add_files', default='Add files')
+    bind = None
+    target = None
+
+    @property
+    def display(self):
+        return (
+            self.model.properties.fileupload_contextmenu_actions
+            and self.permitted('add')
+        )
+
+
+@context_menu_item(group='childactions', name='start_upload')
+class ActionStartUpload(ButtonAction):
+    id = 'toolbaraction-start-upload'
+    icon = 'glyphicon glyphicon-upload'
+    text = _('action_start_upload', default='Start Upload')
+    css = 'start'
+    bind = None
+    target = None
+
+    @property
+    def display(self):
+        return (
+            self.model.properties.fileupload_contextmenu_actions
+            and self.permitted('add')
+        )
+
+
+@context_menu_item(group='childactions', name='cancel_upload')
+class ActionCancelUpload(ButtonAction):
+    id = 'toolbaraction-cancel-upload'
+    icon = 'glyphicon glyphicon-ban-circle'
+    text = _('action_cancel_upload', default='Cancel Upload')
+    css = 'cancel'
+    bind = None
+    target = None
+
+    @property
+    def display(self):
+        return (
+            self.model.properties.fileupload_contextmenu_actions
+            and self.permitted('add')
+        )
+
+
+@context_menu_item(group='childactions', name='delete_files')
+class ActionDeleteFiles(ButtonAction):
+    id = 'toolbaraction-delete-files'
+    icon = 'glyphicon glyphicon-trash'
+    text = _('action_delete_files', default='Delete Files')
+    css = 'delete'
+    bind = None
+    target = None
+
+    @property
+    def display(self):
+        return (
+            self.model.properties.fileupload_contextmenu_actions
+            and self.permitted('delete')
+        )
+
+
+@context_menu_item(group='contextactions', name='select_files')
+class ActionSelectFiles(Action):
+    id = 'toolbaraction-select-files'
+    text = _('action_select_files', default='Select Files')
+
+    @property
+    def display(self):
+        return (
+            self.model.properties.fileupload_contextmenu_actions
+            and self.permitted('delete')
+        )
+
+    def render(self):
+        localizer = get_localizer(self.request)
+        return (
+            u'<li class="select-files-action">'
+            u'  <span>{}<input type="checkbox" class="toggle" /></span>'
+            u'</li>'
+        ).format(
+            localizer.translate(self.text)
+        )

cone/fileupload/browser/fileupload.pt

@@ -0,0 +1,54 @@
+<tal:block xmlns:tal="http://xml.zope.org/namespaces/tal"
+           xmlns:ajax="http://namespaces.conestack.org/ajax"
+           omit-tag="True">
+
+  <!-- The file upload form used as target for the file upload widget -->
+  <form id="fileupload"
+        data-url="${context.upload_url}"
+        data-accept_file_types="${context.accept_file_types}"
+        method="POST"
+        enctype="multipart/form-data">
+
+    <!-- The fileupload-buttonbar contains buttons to add/delete files and
+         start/cancel the upload -->
+    <div class="fileupload-buttonbar"
+         tal:define="show_contextmenu context.show_contextmenu">
+
+      <tal:contextmenu condition="show_contextmenu">
+        <tal:menu replace="structure tile('contextmenu')" />
+        <input type="file" name="files[]" multiple="multiple" style="display:none;"/>
+      </tal:contextmenu>
+
+      <tal:toolbar
+        condition="not show_contextmenu"
+        replace="structure tile('fileupload_toolbar')" />
+
+    </div>
+
+    <!-- The global progress state -->
+    <div class="fileupload-progress fade">
+
+      <!-- The global progress bar -->
+      <div class="progress progress-striped active col-md-6"
+           role="progressbar"
+           aria-valuemin="0"
+           aria-valuemax="100">
+        <div class="progress-bar progress-bar-success"
+             style="width:0%;"></div>
+      </div>
+
+      <!-- The extended global progress state -->
+      <div class="progress-extended col-md-6">&nbsp;</div>
+    </div>
+
+    <!-- The table listing the files available for upload/download -->
+    <table role="presentation" class="table table-striped">
+      <tbody class="files"></tbody>
+    </table>
+  </form>
+
+  <tal:i18n_messages replace="structure context.i18n_messages" />
+  <tal:upload_template replace="structure context.upload_template" />
+  <tal:download_template replace="structure context.download_template" />
+
+</tal:block>

cone/fileupload/browser/fileupload.py

@@ -0,0 +1,185 @@
+from cone.app.browser import render_main_template
+from cone.app.browser.utils import make_url
+from cone.fileupload.browser import templates
+from cone.tile import Tile
+from cone.tile import tile
+from pyramid.i18n import get_localizer
+from pyramid.i18n import TranslationStringFactory
+from pyramid.view import view_config
+
+
+_ = TranslationStringFactory('cone.fileupload')
+
+
+@tile(
+    name='fileupload_toolbar',
+    path='toolbar.pt',
+    permission='add')
+class FileUploadToolbarTile(Tile):
+    """Tile rendering the file upload toolbar.
+    """
+
+
+@tile(name='fileupload', path='fileupload.pt', permission='add')
+class FileUploadTile(Tile):
+    """Register this tile for specific context if jQuery file upload settings
+    should be customized.
+    """
+    accept_file_types = ''  # e.g. /(\.|\/)(gif|jpe?g|png)$/i
+    i18n_messages_src = templates.I18N_MESSAGES
+    upload_template_src = templates.UPLOAD_TEMPLATE
+    download_template_src = templates.DOWNLOAD_TEMPLATE
+
+    @property
+    def show_contextmenu(self):
+        return self.model.properties.fileupload_contextmenu_actions
+
+    @property
+    def i18n_messages(self):
+        localizer = get_localizer(self.request)
+        translate = localizer.translate
+        return self.i18n_messages_src.format(
+            uploaded_bytes=translate(_(
+                'uploaded_bytes',
+                default='Uploaded bytes exceed file size'
+            )),
+            accept_file_types=translate(_(
+                'accept_file_types',
+                default='File type not allowed'
+            ))
+        )
+
+    @property
+    def upload_template(self):
+        localizer = get_localizer(self.request)
+        translate = localizer.translate
+        return self.upload_template_src.format(
+            processing=translate(_('processing', default=u'Processing...')),
+            start=translate(_('start', default=u'Start')),
+            cancel=translate(_('cancel', default=u'Cancel')),
+        )
+
+    @property
+    def download_template(self):
+        localizer = get_localizer(self.request)
+        translate = localizer.translate
+        return self.download_template_src.format(
+            error=translate(_('error', default=u'Error')),
+            delete=translate(_('delete', default=u'Delete')),
+            cancel=translate(_('cancel', default=u'Cancel')),
+            download=translate(_('download', default=u'Download')),
+        )
+
+    @property
+    def upload_url(self):
+        return make_url(
+            self.request,
+            node=self.model,
+            resource='fileupload_handle'
+        )
+
+
+@view_config(name='fileupload', permission='add')
+def fileupload(model, request):
+    """Fileupload as traversable view.
+    """
+    return render_main_template(model, request, 'fileupload')
+
+
+# unknown mimetype marker
+UNKNOWN_MIMETYPE = object()
+
+
+@view_config(
+    name='fileupload_handle',
+    accept='application/json',
+    renderer='json',
+    permission='add')
+class FileUploadHandle(object):
+    """Abstract file upload handle.
+
+    Subclass this object and register ``fileupload_handle`` tile for specific
+    context.
+
+    Methods ``read_existing`` and ``create_file`` are supposed to be
+    implemented on deriving object.
+    """
+
+    def __init__(self, model, request):
+        self.model = model
+        self.request = request
+
+    def __call__(self):
+        result = dict()
+        # initial reading
+        if self.request.method == 'GET':
+            result['files'] = self.read_existing()
+        # file upload
+        elif self.request.method == 'POST':
+            result['files'] = list()
+            for filedata in self.request.params.values():
+                mimetype = filedata.type or UNKNOWN_MIMETYPE
+                filename = filedata.filename
+                stream = filedata.file
+                res = self.create_file(stream, filename, mimetype)
+                result['files'].append(res)
+        return result
+
+    def read_existing(self):
+        """Read existing files in context and return a list of dicts containing
+        file data.
+
+        [
+            {
+                'name': 'pic.jpg',
+                'size': 841946,
+                'view_url': 'http://example.org/pic.jpg',
+                'download_url': 'http://example.org/pic.jpg/download',
+                'delete_url': 'http://example.org/pic.jpg/filedelete_handle',
+                'delete_type': 'GET',
+            }
+        ]
+        """
+        return []
+
+    def create_file(self, stream, filename, mimetype):
+        """Create file by uploaded stream and return file data dict.
+
+        {
+            'name': 'pic.jpg',
+            'size': 841946,
+            'view_url': 'http://example.org/pic.jpg',
+            'download_url': 'http://example.org/pic.jpg/download',
+            'delete_url': 'http://example.org/pic.jpg/filedelete_handle',
+            'delete_type': 'GET',
+        }
+        """
+        return {
+            'name': filename,
+            'size': 0,
+            'error': (
+                'Abstract ``FileUploadHandle`` does not '
+                'implement ``create_file``'
+            )
+        }
+
+
+@view_config(
+    name='filedelete_handle',
+    accept='application/json',
+    renderer='json',
+    permission='delete')
+def filedelete_handle(model, request):
+    """Delete file and return client data.
+
+    {
+        'files': [{
+            'pic.jpg': True
+        }]
+    }
+    """
+    parent = model.parent
+    name = model.name
+    del parent[name]
+    parent()
+    return {'files': [{name: True}]}

cone/fileupload/browser/static/fileupload/jquery.fileupload-process.js

@@ -0,0 +1,170 @@
+/*
+ * jQuery File Upload Processing Plugin
+ * https://github.com/blueimp/jQuery-File-Upload
+ *
+ * Copyright 2012, Sebastian Tschan
+ * https://blueimp.net
+ *
+ * Licensed under the MIT license:
+ * https://opensource.org/licenses/MIT
+ */
+
+/* global define, require */
+
+(function (factory) {
+  'use strict';
+  if (typeof define === 'function' && define.amd) {
+    // Register as an anonymous AMD module:
+    define(['jquery', './jquery.fileupload'], factory);
+  } else if (typeof exports === 'object') {
+    // Node/CommonJS:
+    factory(require('jquery'), require('./jquery.fileupload'));
+  } else {
+    // Browser globals:
+    factory(window.jQuery);
+  }
+})(function ($) {
+  'use strict';
+
+  var originalAdd = $.blueimp.fileupload.prototype.options.add;
+
+  // The File Upload Processing plugin extends the fileupload widget
+  // with file processing functionality:
+  $.widget('blueimp.fileupload', $.blueimp.fileupload, {
+    options: {
+      // The list of processing actions:
+      processQueue: [
+        /*
+                {
+                    action: 'log',
+                    type: 'debug'
+                }
+                */
+      ],
+      add: function (e, data) {
+        var $this = $(this);
+        data.process(function () {
+          return $this.fileupload('process', data);
+        });
+        originalAdd.call(this, e, data);
+      }
+    },
+
+    processActions: {
+      /*
+            log: function (data, options) {
+                console[options.type](
+                    'Processing "' + data.files[data.index].name + '"'
+                );
+            }
+            */
+    },
+
+    _processFile: function (data, originalData) {
+      var that = this,
+        // eslint-disable-next-line new-cap
+        dfd = $.Deferred().resolveWith(that, [data]),
+        chain = dfd.promise();
+      this._trigger('process', null, data);
+      $.each(data.processQueue, function (i, settings) {
+        var func = function (data) {
+          if (originalData.errorThrown) {
+            // eslint-disable-next-line new-cap
+            return $.Deferred().rejectWith(that, [originalData]).promise();
+          }
+          return that.processActions[settings.action].call(
+            that,
+            data,
+            settings
+          );
+        };
+        chain = chain[that._promisePipe](func, settings.always && func);
+      });
+      chain
+        .done(function () {
+          that._trigger('processdone', null, data);
+          that._trigger('processalways', null, data);
+        })
+        .fail(function () {
+          that._trigger('processfail', null, data);
+          that._trigger('processalways', null, data);
+        });
+      return chain;
+    },
+
+    // Replaces the settings of each processQueue item that
+    // are strings starting with an "@", using the remaining
+    // substring as key for the option map,
+    // e.g. "@autoUpload" is replaced with options.autoUpload:
+    _transformProcessQueue: function (options) {
+      var processQueue = [];
+      $.each(options.processQueue, function () {
+        var settings = {},
+          action = this.action,
+          prefix = this.prefix === true ? action : this.prefix;
+        $.each(this, function (key, value) {
+          if ($.type(value) === 'string' && value.charAt(0) === '@') {
+            settings[key] =
+              options[
+                value.slice(1) ||
+                  (prefix
+                    ? prefix + key.charAt(0).toUpperCase() + key.slice(1)
+                    : key)
+              ];
+          } else {
+            settings[key] = value;
+          }
+        });
+        processQueue.push(settings);
+      });
+      options.processQueue = processQueue;
+    },
+
+    // Returns the number of files currently in the processing queue:
+    processing: function () {
+      return this._processing;
+    },
+
+    // Processes the files given as files property of the data parameter,
+    // returns a Promise object that allows to bind callbacks:
+    process: function (data) {
+      var that = this,
+        options = $.extend({}, this.options, data);
+      if (options.processQueue && options.processQueue.length) {
+        this._transformProcessQueue(options);
+        if (this._processing === 0) {
+          this._trigger('processstart');
+        }
+        $.each(data.files, function (index) {
+          var opts = index ? $.extend({}, options) : options,
+            func = function () {
+              if (data.errorThrown) {
+                // eslint-disable-next-line new-cap
+                return $.Deferred().rejectWith(that, [data]).promise();
+              }
+              return that._processFile(opts, data);
+            };
+          opts.index = index;
+          that._processing += 1;
+          that._processingQueue = that._processingQueue[that._promisePipe](
+            func,
+            func
+          ).always(function () {
+            that._processing -= 1;
+            if (that._processing === 0) {
+              that._trigger('processstop');
+            }
+          });
+        });
+      }
+      return this._processingQueue;
+    },
+
+    _create: function () {
+      this._super();
+      this._processing = 0;
+      // eslint-disable-next-line new-cap
+      this._processingQueue = $.Deferred().resolveWith(this).promise();
+    }
+  });
+});