Add config options/remove comments

.gitignore

@@ -31,9 +31,6 @@ fl_notes.txt
 # custom style
 ckan/public/base/less/custom.less
 
-# webassets
-ckan/public/webassets
-
 # nosetest coverage output
 .coverage
 htmlcov/*

ckan/config/deployment.ini_tmpl

@@ -160,6 +160,12 @@ ckan.feeds.author_link =
 #ckan.max_resource_size = 10
 #ckan.max_image_size = 2
 
+## Webassets Settings
+#ckan.webassets.use_x_sendfile = false
+#ckan.webassets.external = false
+#ckan.webassets.path = /var/lib/ckan/webassets
+
+
 ## Datapusher settings
 
 # Make sure you have set up the DataStore

ckan/config/middleware/flask_app.py

@@ -31,7 +31,8 @@
 from ckan.common import config, g, request, ungettext
 import ckan.lib.app_globals as app_globals
 import ckan.lib.plugins as lib_plugins
-
+import ckan.plugins.toolkit as toolkit
+from ckan.lib.webassets_tools import get_webassets_path
 
 from ckan.plugins import PluginImplementations
 from ckan.plugins.interfaces import IBlueprint, IMiddleware, ITranslation
@@ -41,7 +42,6 @@
                         set_controller_and_action
                         )
 
-import ckan.lib.plugins as lib_plugins
 import logging
 from logging.handlers import SMTPHandler
 log = logging.getLogger(__name__)
@@ -185,14 +185,7 @@ def hello_world_post():
         return 'Hello World, this was posted to Flask'
 
     # WebAssets
-    public_folder = config.get('ckan.base_public_folder')
-    webassets_folder = os.path.join(
-        os.path.dirname(ckan.__file__), public_folder, 'webassets'
-    )
-
-    @app.route('/webassets/<path:path>')
-    def webassets(path):
-        return send_from_directory(webassets_folder, path)
+    _setup_webassets(app)
 
     # Auto-register all blueprints defined in the `views` folder
     _register_core_blueprints(app)
@@ -504,3 +497,16 @@ def filter(self, log_record):
     context_provider = ContextualFilter()
     app.logger.addFilter(context_provider)
     app.logger.addHandler(mail_handler)
+
+
+def _setup_webassets(app):
+    app.use_x_sendfile = toolkit.asbool(
+        config.get('ckan.webassets.use_x_sendfile')
+    )
+
+    if not toolkit.asbool(config.get('ckan.webassets.external')):
+        webassets_folder = get_webassets_path()
+
+        @app.route('/webassets/<path:path>')
+        def webassets(path):
+            return send_from_directory(webassets_folder, path)

ckan/lib/jinja_extensions.py

@@ -324,10 +324,6 @@ class ResourceExtension(BaseExtension):
 
     @classmethod
     def _call(cls, args, kwargs):
-        log.warn(
-            '`resource` tag is deprecated. '
-            'Use `assets`'
-            '<https://docs.ckan.org/en/latest/theming/webassets.html> instead')
         assert len(args) == 1
         assert len(kwargs) == 0
         h.include_resource(args[0], **kwargs)

ckan/lib/webassets_tools.py

@@ -2,14 +2,15 @@
 
 import logging
 import os
+import tempfile
 
 from markupsafe import Markup
-
 from webassets import Environment
 from webassets.loaders import YAMLLoader
 
 from ckan.common import config, g
 
+
 logger = logging.getLogger(__name__)
 env = None
 
@@ -32,6 +33,7 @@ def create_library(name, path):
     # with the same name twice. For now, let's just pop existing
     # bundle and avoid name-conflicts
     # TODO: make PR into webassets with preferable solution
+    # Issue: https://github.com/miracle2k/webassets/issues/519
     for name, bundle in bundles.items():
         env._named_bundles.pop(name, None)
         env.register(name, bundle)
@@ -42,13 +44,14 @@ def create_library(name, path):
 def webassets_init():
     global env
 
+    static_path = get_webassets_path()
+
     public = config.get(u'ckan.base_public_folder')
 
     public_folder = os.path.abspath(os.path.join(
         os.path.dirname(__file__), u'..', public))
 
     base_path = os.path.join(public_folder, u'base')
-    static_path = os.path.join(public_folder, u'webassets')
 
     env = Environment()
     env.directory = static_path
@@ -137,3 +140,22 @@ def render_assets(type_):
     tags = u'\n'.join([_to_tag(asset, type_) for asset in assets[type_]])
     collection[:] = []
     return Markup(tags)
+
+
+def get_webassets_path():
+    webassets_path = config.get('ckan.webassets.path')
+
+    if not webassets_path:
+        storage_path = config.get(
+            'ckan.storage_path'
+        ) or tempfile.gettempdir()
+
+        if storage_path:
+            webassets_path = os.path.join(storage_path, 'webassets')
+
+    if not webassets_path:
+        raise RuntimeError(
+            'Either `ckan.webassets.path` or `ckan.storage_path` '
+            'must be specified'
+        )
+    return webassets_path

ckan/templates/package/new_resource.html

@@ -20,6 +20,5 @@
 
 {% block scripts %}
   {{ super() }}
-  {#% resource 'vendor/fileupload' %#}
   {% asset 'vendor/fileupload' %}
 {% endblock %}

ckan/templates/package/resource_edit_base.html

@@ -37,6 +37,5 @@ <h1 class="hide-heading">{% block form_title %}{{ _('Edit resource') }}{% endblo
 
 {% block scripts %}
   {{ super() }}
-  {#% resource 'vendor/fileupload' %#}
   {% asset 'vendor/fileupload' %}
 {% endblock %}

ckan/templates/package/resource_views.html

@@ -17,7 +17,6 @@
       {% endfor %}
     </ul>
   </div>
-  {#% resource 'vendor/reorder' %#}
   {% asset 'vendor/reorder' %}
 {% endblock %}
 

ckan/templates/package/resources.html

@@ -26,7 +26,6 @@
 {% block scripts %}
   {{ super() }}
   {% if has_reorder %}
-    {#% resource 'vendor/reorder' %#}
     {% asset 'vendor/reorder' %}
   {% endif %}
 {% endblock %}

ckan/templates/page.html

@@ -128,14 +128,9 @@ <h1>My page content</h1>
 {%- endblock -%}
 
 {%- block scripts %}
-  {#% resource 'base/main' %#}
   {% asset 'base/main' %}
-
-  {#% resource 'base/ckan' %#}
   {% asset 'base/ckan' %}
-
   {% if g.tracking_enabled %}
-    {#% resource 'base/tracking.js' %#}
     {% asset 'base/tracking' %}
   {% endif %}
   {{ super() }}

ckanext/datatablesview/templates/datatables/datatables_view.html

@@ -53,7 +53,6 @@
     <input type="hidden" name="filters" value="{{ request.args.get('filters', '')|e }}" />
   </form>
 
-  {#% resource 'ckanext-datatablesview/main' %#}
   {% asset 'ckanext-datatablesview/main' %}
 {% endblock %}
 

ckanext/example_theme_docs/v15_fanstatic/templates/base.html

@@ -3,12 +3,11 @@
 {% block styles %}
   {{ super() }}
 
-  {# Import example_theme.css using Fanstatic.
-    'example_theme/' is the name that the example_theme/fanstatic directory
-    was registered with when the toolkit.add_resource() function was called.
-    'example_theme.css' is the path to the CSS file, relative to the root of
-    the fanstatic directory. #}
-  {#% resource 'example_theme/example_theme.css' %#}
+  {# Import example_theme.css using Webassets.  'example_theme/' is
+    the name that the example_theme/fanstatic directory was registered
+    with when the toolkit.add_resource() function was called.
+    'example_theme' is the name to the Webassets bundle file,
+    registered inside webassets.yml file. #}
   {% asset 'example_theme/example_theme' %}
 
 {% endblock %}

ckanext/example_theme_docs/v16_initialize_a_javascript_module/templates/snippets/package_item.html

@@ -3,10 +3,9 @@
 {% block content %}
   {{ super() }}
 
-  {# Use Fanstatic to include our custom JavaScript module.
+  {# Use Webassets to include our custom JavaScript module.
     A <script> tag for the module will be inserted in the right place at the
     bottom of the page. #}
-  {#% resource 'example_theme/example_theme_popover.js' %#}
   {% asset 'example_theme/example_theme' %}
 
   {# Apply our JavaScript module to an HTML element. The data-module attribute,

ckanext/example_theme_docs/v17_popover/templates/snippets/package_item.html

@@ -2,7 +2,6 @@
 
 {% block content %}
   {{ super() }}
-  {#% resource 'example_theme/example_theme_popover.js' %#}
   {% asset 'example_theme/example_theme' %}
 
   {# Apply our JavaScript module to an HTML <button> element.

ckanext/example_theme_docs/v18_snippet_api/templates/snippets/package_item.html

@@ -3,8 +3,6 @@
 {% block content %}
   {{ super() }}
 
-  {#% resource 'example_theme/example_theme_popover.js' %#}
-  {#% resource 'example_theme/example_theme_popover.css' %#}
   {% asset 'example_theme/example_theme' %}
 
   <button data-module="example_theme_popover"

ckanext/example_theme_docs/v21_custom_jquery_plugin/templates/snippets/package_item.html

@@ -3,9 +3,6 @@
 {% block content %}
   {{ super() }}
 
-  {#% resource 'example_theme/example_theme_popover.js' %#}
-  {#% resource 'example_theme/example_theme_popover.css' %#}
-  {#% resource 'example_theme/jquery.greenify.js' %#}
   {% asset 'example_theme/example_theme' %}
 
 

ckanext/reclineview/theme/templates/recline_view.html

@@ -15,7 +15,6 @@ <h4 class="loading-dialog">
     </h4>
   </div>
 
-  {#% resource 'ckanext-reclineview/main' %#}
   {% asset 'ckanext-reclineview/main' %}
 {% endblock %}
 

ckanext/stats/templates/ckanext/stats/index.html

@@ -189,6 +189,5 @@ <h2 class="module-heading"><i class="fa fa-bar-chart-o fa-medium"></i> {{ _('Sta
 
 {% block scripts %}
   {{ super() }}
-  {#% resource "ckanext_stats/stats" %#}
   {% asset "ckanext_stats/stats" %}
 {% endblock %}

ckanext/textview/theme/templates/text_view.html

@@ -20,6 +20,5 @@
   {% endblock %}
 
 
-  {#% resource 'ckanext-textview/main' %#}
   {% asset 'ckanext-textview/main' %}
 {% endblock %}