Merge branch 'settings_py'

Sergio Oliveira
2 parents 2fedfd73 fd31cbb7
Showing 13 changed files with 295 additions and 139 deletions Show diff stats
.gitignore
colab/plugins/context_processors.py
colab/plugins/templates/plugins/menu_template.html
colab/plugins/templatetags/plugins.py
colab/plugins/urls.py
colab/plugins/utils/menu.py
colab/settings.py
colab/utils/conf.py
docs/source/user.rst
tests/config_settings.py
tests/plugins.d/gitlab.py
tests/run.py
tests/settings.yaml
@@ -3,7 +3,7 @@
 *.pot
 *.pyc
 *.pyo
-*.egg
+*.egg*
 local_settings.py
 project_cfg.py
  
@@ -2,10 +2,10 @@
 from django.conf import settings
  
  
-def proxied_apps(request):
-    proxied_apps = {}
+def colab_apps(request):
+    colab_apps = {}
  
     for app_name, app in settings.COLAB_APPS.items():
-        proxied_apps[app_name] = app
+        colab_apps[app_name] = app
  
-    return {'proxy': proxied_apps}
+    return {'plugins': colab_apps}
 {% for title, links in menu_links.items %}
   {% if links|length == 1 %}
-    {% for text, link in links %}
+    {% for colab_url in links %}
       <li>
-        <a href="{{ link }}">{{ title }}</a>
+        <a href="{{ colab_url.url }}">{{ title }}</a>
       </li>
     {% endfor %}
   {% else %}
     <li class="dropdown">
       <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ title }} <b class="caret"></b></a>
       <ul class="dropdown-menu">
-        {% for text, link in links %}
-          <li><a href="{{ link }}">{{ text }}</a></li>
+        {% for colab_url in links %}
+          <li><a href="{{ colab_url.url }}">{{ colab_url.display }}</a></li>
         {% endfor %}
       </ul>
     </li>
@@ -3,45 +3,48 @@ from collections import OrderedDict
 from django import template
 from django.core.cache import cache
 from django.template.loader import render_to_string
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import get_language
  
 register = template.Library()
  
  
 @register.simple_tag(takes_context=True)
 def plugins_menu(context):
+
     if context['user'].is_authenticated():
         cache_key = 'colab-proxy-menu-authenticated'
     else:
         cache_key = 'colab-proxy-menu-anonymous'
  
+    lang = get_language()
+    cache_key += '-{}'.format(lang)
+
     menu_from_cache = cache.get(cache_key)
  
     if menu_from_cache:
         return menu_from_cache
  
     menu_links = OrderedDict()
-    proxied_apps = context.get('proxy', {})
+    colab_apps = context.get('plugins', {})
  
-    for app_name, app in proxied_apps.items():
-        if not app.get('menu'):
+    for app_name, app in colab_apps.items():
+        if not app.get('menu_urls'):
             continue
  
-        menu = app.get('menu')
-        title = menu.get('title', app_name)
-        links = menu.get('links', tuple()).items()
-        if context['user'].is_active:
-            links += menu.get('auth_links', tuple()).items()
-
-        if not links:
-            continue
+        menu = app.get('menu_urls')
+        title = app.get('menu_title', app_name)
  
         if title not in menu_links:
-            menu_links[_(title)] = []
+            menu_links[title] = []
+
+        for colab_url in menu:
+            if not context['user'].is_active and colab_url.auth:
+                continue
+
+            menu_links[title].append(colab_url)
  
-        for text, link in links:
-            url = link
-            menu_links[_(title)].append((_(text), url))
+        if not menu_links[title]:
+            del menu_links[title]
  
     menu = render_to_string('plugins/menu_template.html',
                             {'menu_links': menu_links})
@@ -14,8 +14,8 @@ for app_name, app in settings.COLAB_APPS.items():
     urls = app.get('urls')
     if not urls.get('include'):
         raise ImproperlyConfigured(undef_url_include_msg)
-    print urls['include']
     urlpatterns += patterns('',
         url(urls.get('prefix', r''), include(urls['include'],
             namespace=urls.get('namespace'))),
-    )
 \ No newline at end of file
+    )
+
@@ -0,0 +1,25 @@
+from django.core.urlresolvers import reverse_lazy
+
+
+class ColabUrl(object):
+    def __init__(self, display, url, auth):
+        self.display = display
+        self.url = url
+        self.auth = auth
+
+
+def colab_url_factory(namespace):
+
+    def url(display, viewname, namespace=namespace, args=tuple(),
+            kwargs={}, auth=False):
+
+        if namespace:
+            rev_viewname = ':'.join((namespace, viewname))
+        else:
+            rev_viewname = viewname
+
+        url = reverse_lazy(rev_viewname, args=args, kwargs=kwargs)
+
+        return ColabUrl(display, url, auth)
+
+    return url
@@ -194,7 +194,7 @@ TEMPLATE_CONTEXT_PROCESSORS = (
     'django.core.context_processors.request',
     'django_mobile.context_processors.is_mobile',
     'colab.super_archives.context_processors.mailarchive',
-    'colab.plugins.context_processors.proxied_apps',
+    'colab.plugins.context_processors.colab_apps',
     'colab.home.context_processors.robots',
     'colab.home.context_processors.ribbon',
     'colab.home.context_processors.google_analytics',
@@ -280,8 +280,13 @@ CONVERSEJS_SHOW_ONLY_ONLINE_USERS = True
 TASTYPIE_DEFAULT_FORMATS = ['json', ]
  
 from .utils.conf import load_yaml_settings
+from .utils.conf import load_py_settings
+from .utils.conf import load_colab_apps
+
 locals().update(load_yaml_settings())
  
+locals().update(load_py_settings())
+
 if locals().get('RAVEN_DSN', False):
     RAVEN_CONFIG = {
         'dsn': RAVEN_DSN + '?timeout=30',  # noqa
@@ -291,6 +296,8 @@ if locals().get(&#39;RAVEN_DSN&#39;, False):
 BROWSERID_ENABLED = locals().get('BROWSERID_ENABLED') or False
 SOCIAL_NETWORK_ENABLED = locals().get('SOCIAL_NETWORK_ENABLED') or False
  
+locals().update(load_colab_apps())
+
 COLAB_APPS = locals().get('COLAB_APPS') or {}
 PROXIED_APPS = {}
  
  
 import os
+import sys
+
+import warnings
+
 import yaml
  
 import yamlordereddictloader
  
 from django.core.exceptions import ImproperlyConfigured
  
+import importlib
+
+
+USING_YAML_SETTINGS = False
+
  
 class InaccessibleYAMLSettings(ImproperlyConfigured):
     """Settings YAML is Inaccessible.
@@ -29,22 +38,144 @@ def _load_yaml_file(yaml_path):
  
 def load_yaml_settings():
     settings_dir = '/etc/colab/settings.d'
-    yaml_path = os.getenv('COLAB_SETTINGS', '/etc/colab/settings.yaml')
+    yaml_path = os.getenv('COLAB_YAML_SETTINGS', '/etc/colab/settings.yaml')
  
-    if not os.path.exists(yaml_path):
-        msg = "The yaml file {} does not exist".format(yaml_path)
-        raise InaccessibleYAMLSettings(msg)
+    if os.path.exists(yaml_path):
+        global USING_YAML_SETTINGS
+        USING_YAML_SETTINGS = True
+        warnings.warn("YAML Settings file is deprecated. Use Py file instead.")
+    else:
+        return {}
  
     yaml_settings = _load_yaml_file(yaml_path)
  
+    parse_yml_menus(yaml_settings)
+
     # Try to read settings from settings.d
     if os.path.exists(settings_dir):
         for file_name in os.listdir(settings_dir):
             if file_name.endswith('.yaml') or file_name.endswith('yml'):
                 file_path = os.path.join(settings_dir, file_name)
                 yaml_settings_d = _load_yaml_file(file_path)
+
+                parse_yml_menus(yaml_settings_d)
+
                 yaml_settings.update(yaml_settings_d)
  
     return yaml_settings or {}
  
-yaml_settings = load_yaml_settings()
+
+class InaccessiblePySettings(ImproperlyConfigured):
+    """Settings.py is Inaccessible.
+
+    Check if the file exists and if you have read permissions."""
+
+
+def _load_py_file(py_path, path):
+    original_path = sys.path
+
+    sys.path = [path]
+    try:
+        py_settings = importlib.import_module(py_path)
+
+    except IOError:
+        msg = ('Could not open settings file {}. Please '
+               'check if the file exists and if user '
+               'has read rights.').format(py_path)
+        raise InaccessiblePySettings(msg)
+
+    except SyntaxError as excpt:
+        msg = ('Syntax Error: {}'.format(excpt))
+        raise InaccessiblePySettings(msg)
+
+    finally:
+        sys.path = original_path
+
+    py_setting = {var: getattr(py_settings, var) for var in dir(py_settings)
+                  if not var.startswith('__')}
+
+    return py_setting
+
+
+def load_py_settings():
+    settings_dir = '/etc/colab/settings.d'
+    settings_file = os.getenv('COLAB_SETTINGS', '/etc/colab/settings.py')
+    settings_module = settings_file.split('.')[-2].split('/')[-1]
+    py_path = "/".join(settings_file.split('/')[:-1])
+
+    global USING_YAML_SETTINGS
+    if not os.path.exists(py_path) and not USING_YAML_SETTINGS:
+        msg = "The py file {} does not exist".format(py_path)
+        raise InaccessiblePySettings(msg)
+    elif USING_YAML_SETTINGS:
+        return {}
+
+    py_settings = _load_py_file(settings_module, py_path)
+
+    # Try to read settings from settings.d
+
+    if os.path.exists(settings_dir):
+        return py_settings
+        for file_name in os.listdir(settings_dir):
+            if file_name.endswith('.py'):
+                file_module = file_name.split('.')[0]
+                py_settings_d = _load_py_file(file_module, settings_dir)
+                py_settings.update(py_settings_d)
+
+    return py_settings
+
+
+def load_colab_apps():
+    plugins_dir = os.getenv('COLAB_PLUGINS', '/etc/colab/plugins.d/')
+
+    global USING_YAML_SETTINGS
+    if USING_YAML_SETTINGS:
+        return {}
+
+    COLAB_APPS = {}
+
+    # Try to read settings from plugins.d
+    if os.path.exists(plugins_dir):
+        for file_name in os.listdir(plugins_dir):
+            if file_name.endswith('.py'):
+                file_module = file_name.split('.')[0]
+                py_settings_d = _load_py_file(file_module, plugins_dir)
+                fields = ['verbose_name', 'upstream', 'urls',
+                          'menu_urls', 'middlewares', 'dependencies',
+                          'context_processors']
+
+                app_name = py_settings_d.get('name')
+                if not app_name:
+                    warnings.warn("Plugin missing name variable")
+                    continue
+
+                COLAB_APPS[app_name] = {}
+                COLAB_APPS[app_name]['menu_title'] = \
+                    py_settings_d.get('menu_title')
+
+                for key in fields:
+                    value = py_settings_d.get(key)
+                    if value:
+                        COLAB_APPS[app_name][key] = value
+
+    return {'COLAB_APPS': COLAB_APPS}
+
+
+def parse_yml_menus(yaml_settings):
+    if 'COLAB_APPS' in yaml_settings:
+        for key, plugin in yaml_settings['COLAB_APPS'].items():
+            if 'menu' in plugin:
+                parse_yml_tuples(yaml_settings['COLAB_APPS'][key]['menu'])
+
+
+def parse_yml_tuples(menu):
+    dict_links = menu['links']
+    dict_auth_links = menu['auth_links']
+    menu['links'] = tuple()
+    menu['auth_links'] = tuple()
+
+    for key, value in dict_links.items():
+        menu['links'] += ((key, value),)
+
+    for key, value in dict_auth_links.items():
+        menu['auth_links'] += ((key, value),)
@@ -14,41 +14,33 @@ Install
  
 Plugins
 -------
-.. attribute:: COLAB_APPS
+.. attribute:: name
  
-   :default: None
+Declares the absolute name of the plugin app as a python import path. Example:
+directory.something.someplugin
+
+.. attribute:: verbose_name
  
-   Describes the activated plugins and its configurations. It's necessary to describe
-   for each app its name as the variable. The apps described here can be devided into
-   two categories, that beeing, colab proxy apps and third-party apps.
-   The upstream variable is only needed to colab proxy apps.
+Delclare the description name of the plugin.
  
 .. attribute:: upstream
  
-Declares the upstream server url of the proxy. Only declare if the plugin is a proxy.
+Declares the upstream server url of the proxy. Only declare if the plugin is a
+proxy.
  
-dependecies
-+++++++++++
+.. attribute:: middlewares
  
-    A list of the plugin dependecies that will be added to INSTALLED_APPS.
-    This doesn't automatically install the python dependecies, only add to django apps.
+Declares the middlewares of the plugin in a list format.
  
+.. attribute:: context_processors
  
-menu
-++++
+Declares the context processors of the plugin in a list format too.
  
-.. attribute:: title
+.. attribute:: dependency
  
-    Declares the menu title.
-.. attribute:: links
-
-    Declares the menu items and its links.
-.. attribute:: auth_links
-
-    Declares the menu items and its links when the user authenticated.
-.. attribute:: dependecies
-
-Declares a list of the plugin dependecies.
+Declares the additional installed apps that this plugin depends on.
+This doesn't automatically install the python dependecies, only add to django
+apps.
  
 urls
 ++++
@@ -63,16 +55,35 @@ urls
  
     Declares the namespace for the url.
  
-context_processors
-++++++++++++++++++
+menu
+++++
  
-    Declares the plugin context processors.
+These variables defines the menu title and links of the plugin.
  
-middlewares
-+++++++++++
+.. attribute:: menu_title
+
+    Declares the menu title.
+.. attribute:: menu_links
+
+    Declares the menu items and its links.
+    This should be a tuple object with several colab_url elements.
+    The colab_url_factory creates a factory for your links along with your
+    namespace.
+    The auth parameter indicates wether the link should only be displayed when
+    the user is logged in.
+
+Example:
+
+.. code-block:: python
  
-    Declares the plugin middlewares.
+    from colab.plugins.utils.menu import colab_url_factory
  
+    url = colab_url_factory('plugin_app_name')
+
+    menu_urls = (
+       url(display=_('Profile'), viewname='profile', kwargs={'path': '/profile/'}, auth=True),
+       url(display=_('Profile Two'), viewname='profile2', kwargs={'path': '/profile/2'}, auth=True),
+    )
  
 Extra Template Folders
 ++++++++++++++++++++++
@@ -113,12 +124,12 @@ SVN
 .. TODO
  
 Social Networks
-++++
++++++++++++++++
 .. attribute:: SOCIAL_NETWORK_ENABLED
  
    :default: False
  
-   When this variable is True, the social networks fields, like Facebook and 
+   When this variable is True, the social networks fields, like Facebook and
    Twitter, are added in user profile. By default, this fields are disabled.
  
 Auth
@@ -0,0 +1,11 @@
+SECRET_KEY = 'ddddddddddddddddddddddddddddddddddddddddddddddddddddddaddddddddd'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'HOST': 'localhost',
+        'NAME': 'colab',
+        'USER': 'colab',
+        'PASSWORD': 'colab',
+    }
+}
@@ -0,0 +1,39 @@
+from django.utils.translation import ugettext_lazy as _
+
+name = 'colab.plugins.gitlab'
+verbose_name = 'Gitlab Proxy'
+
+upstream = 'localhost'
+#middlewares = []
+
+menu = {
+'title': _('Code'),
+'links': (
+    (_('Public Projects'), 'public/projects'),
+),
+'auth_links': (
+    (_('Profile'), 'profile'),
+    (_('New Project'), 'projects/new'),
+    (_('Projects'), 'dashboard/projects'),
+    (_('Groups'), 'profile/groups'),
+    (_('Issues'), 'dashboard/issues'),
+    (_('Merge Requests'), 'dashboard/merge_requests'),
+
+),
+}
+
+
+#  dpaste:
+#    dependencies:
+#      - 'mptt'
+#    urls:
+#      include: 'dpaste.urls.dpaste'
+#      prefix:  '^paste/'
+#      namespace: 'dpaste'
+#    menu:
+#      title: 'Dpaste'
+#      links:
+#        Public Projects:  '/paste'
+#      auth_links:
+#        Profile: '/projects'
+#        New Project: '/projects/new'
@@ -4,7 +4,9 @@ import os
 import sys
  
 os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings'
-os.environ['COLAB_SETTINGS'] = 'tests/settings.yaml'
+os.environ['COLAB_SETTINGS'] = 'tests/config_settings.py'
+os.environ['COLAB_YAML_SETTINGS'] = 'tests/settings.yaml'
+os.environ['COLAB_PLUGINS'] = 'tests/plugins.d'
 os.environ['COVERAGE_PROCESS_START'] = '.coveragerc'
 os.environ['REUSE_DB'] = '0'
  
@@ -1,73 +0,0 @@
-
-
-## Set to false in production
-DEBUG: true
-TEMPLATE_DEBUG: true
-
-## System admins
-ADMINS: &admin
-  -
-    - John Foo
-    - john@example.com
-  -
-    - Mary Bar
-    - mary@example.com
-
-MANAGERS: *admin
-
-COLAB_FROM_ADDRESS: '"Colab" <noreply@example.com>'
-SERVER_EMAIL: '"Colab" <noreply@example.com>'
-
-EMAIL_HOST: localhost
-EMAIL_PORT: 25
-EMAIL_SUBJECT_PREFIX: '[colab]'
-
-SECRET_KEY: 'hu8-)szdcjjsz%f02gt$5djbluxc$v0a%01l)di6oi)np7%8lu'
-
-#  Must use it without trailing slash
-SITE_URL: 'http://localhost:8000'
-BROWSERID_AUDIENCES:
-  - http://localhost:8000
-#  - http://example.com
-#  - https://example.org
-#  - http://example.net
-
-ALLOWED_HOSTS:
-  - localhost
-#  - example.com
-#  - example.org
-#  - example.net
-
-### Uncomment to enable Broswer ID protocol for authentication
-# BROWSERID_ENABLED: True
-
-### Uncomment to enable Converse.js
-# CONVERSEJS_ENABLED: True
-
-### Uncomment to enable auto-registration
-# CONVERSEJS_AUTO_REGISTER: 'xmpp.example.com'
-
-## Database settings
-DATABASES:
-  default:
-    ENGINE: django.db.backends.postgresql_psycopg2
-    HOST: localhost
-    NAME: colab
-    USER: colab
-    PASSWORD: colab
-
-## Disable indexing
-ROBOTS_NOINDEX: false
-
-### Log errors to Sentry instance
-# RAVEN_DSN: 'http://public:secret@example.com/1'
-
-### Colab proxied apps
-COLAB_APPS:
-  colab.plugins.gitlab:
-    upstream: 'http://localhost:8090/gitlab/'
-    private_token: ''
-#   colab.plugins.trac:
-#     upstream: 'http://localhost:5000/trac/'
-
-
...	...	@@ -3,7 +3,7 @@
3	3	*.pot
4	4	*.pyc
5	5	*.pyo
6		-*.egg
	6	+.egg
7	7	local_settings.py
8	8	project_cfg.py
9	9
...	...
...	...	@@ -2,10 +2,10 @@
2	2	from django.conf import settings
3	3
4	4
5		-def proxied_apps(request):
6		- proxied_apps = {}
	5	+def colab_apps(request):
	6	+ colab_apps = {}
7	7
8	8	for app_name, app in settings.COLAB_APPS.items():
9		- proxied_apps[app_name] = app
	9	+ colab_apps[app_name] = app
10	10
11		- return {'proxy': proxied_apps}
	11	+ return {'plugins': colab_apps}
...	...
1	1	{% for title, links in menu_links.items %}
2	2	{% if links\|length == 1 %}
3		- {% for text, link in links %}
	3	+ {% for colab_url in links %}
4	4	<li>
5		- <a href="{{ link }}">{{ title }}</a>
	5	+ <a href="{{ colab_url.url }}">{{ title }}</a>
6	6	</li>
7	7	{% endfor %}
8	8	{% else %}
9	9	<li class="dropdown">
10	10	<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ title }} <b class="caret"></b></a>
11	11	<ul class="dropdown-menu">
12		- {% for text, link in links %}
13		- <li><a href="{{ link }}">{{ text }}</a></li>
	12	+ {% for colab_url in links %}
	13	+ <li><a href="{{ colab_url.url }}">{{ colab_url.display }}</a></li>
14	14	{% endfor %}
15	15	</ul>
16	16	</li>
...	...
...	...	@@ -3,45 +3,48 @@ from collections import OrderedDict
3	3	from django import template
4	4	from django.core.cache import cache
5	5	from django.template.loader import render_to_string
6		-from django.utils.translation import ugettext_lazy as _
	6	+from django.utils.translation import get_language
7	7
8	8	register = template.Library()
9	9
10	10
11	11	@register.simple_tag(takes_context=True)
12	12	def plugins_menu(context):
	13	+
13	14	if context['user'].is_authenticated():
14	15	cache_key = 'colab-proxy-menu-authenticated'
15	16	else:
16	17	cache_key = 'colab-proxy-menu-anonymous'
17	18
	19	+ lang = get_language()
	20	+ cache_key += '-{}'.format(lang)
	21	+
18	22	menu_from_cache = cache.get(cache_key)
19	23
20	24	if menu_from_cache:
21	25	return menu_from_cache
22	26
23	27	menu_links = OrderedDict()
24		- proxied_apps = context.get('proxy', {})
	28	+ colab_apps = context.get('plugins', {})
25	29
26		- for app_name, app in proxied_apps.items():
27		- if not app.get('menu'):
	30	+ for app_name, app in colab_apps.items():
	31	+ if not app.get('menu_urls'):
28	32	continue
29	33
30		- menu = app.get('menu')
31		- title = menu.get('title', app_name)
32		- links = menu.get('links', tuple()).items()
33		- if context['user'].is_active:
34		- links += menu.get('auth_links', tuple()).items()
35		-
36		- if not links:
37		- continue
	34	+ menu = app.get('menu_urls')
	35	+ title = app.get('menu_title', app_name)
38	36
39	37	if title not in menu_links:
40		- menu_links[_(title)] = []
	38	+ menu_links[title] = []
	39	+
	40	+ for colab_url in menu:
	41	+ if not context['user'].is_active and colab_url.auth:
	42	+ continue
	43	+
	44	+ menu_links[title].append(colab_url)
41	45
42		- for text, link in links:
43		- url = link
44		- menu_links[_(title)].append((_(text), url))
	46	+ if not menu_links[title]:
	47	+ del menu_links[title]
45	48
46	49	menu = render_to_string('plugins/menu_template.html',
47	50	{'menu_links': menu_links})
...	...
...	...	@@ -14,8 +14,8 @@ for app_name, app in settings.COLAB_APPS.items():
14	14	urls = app.get('urls')
15	15	if not urls.get('include'):
16	16	raise ImproperlyConfigured(undef_url_include_msg)
17		- print urls['include']
18	17	urlpatterns += patterns('',
19	18	url(urls.get('prefix', r''), include(urls['include'],
20	19	namespace=urls.get('namespace'))),
21		- )
22	20	\ No newline at end of file
	21	+ )
	22	+
...	...
...	...	@@ -0,0 +1,25 @@
	1	+from django.core.urlresolvers import reverse_lazy
	2	+
	3	+
	4	+class ColabUrl(object):
	5	+ def __init__(self, display, url, auth):
	6	+ self.display = display
	7	+ self.url = url
	8	+ self.auth = auth
	9	+
	10	+
	11	+def colab_url_factory(namespace):
	12	+
	13	+ def url(display, viewname, namespace=namespace, args=tuple(),
	14	+ kwargs={}, auth=False):
	15	+
	16	+ if namespace:
	17	+ rev_viewname = ':'.join((namespace, viewname))
	18	+ else:
	19	+ rev_viewname = viewname
	20	+
	21	+ url = reverse_lazy(rev_viewname, args=args, kwargs=kwargs)
	22	+
	23	+ return ColabUrl(display, url, auth)
	24	+
	25	+ return url
...	...
...	...	@@ -194,7 +194,7 @@ TEMPLATE_CONTEXT_PROCESSORS = (
194	194	'django.core.context_processors.request',
195	195	'django_mobile.context_processors.is_mobile',
196	196	'colab.super_archives.context_processors.mailarchive',
197		- 'colab.plugins.context_processors.proxied_apps',
	197	+ 'colab.plugins.context_processors.colab_apps',
198	198	'colab.home.context_processors.robots',
199	199	'colab.home.context_processors.ribbon',
200	200	'colab.home.context_processors.google_analytics',
...	...	@@ -280,8 +280,13 @@ CONVERSEJS_SHOW_ONLY_ONLINE_USERS = True
280	280	TASTYPIE_DEFAULT_FORMATS = ['json', ]
281	281
282	282	from .utils.conf import load_yaml_settings
	283	+from .utils.conf import load_py_settings
	284	+from .utils.conf import load_colab_apps
	285	+
283	286	locals().update(load_yaml_settings())
284	287
	288	+locals().update(load_py_settings())
	289	+
285	290	if locals().get('RAVEN_DSN', False):
286	291	RAVEN_CONFIG = {
287	292	'dsn': RAVEN_DSN + '?timeout=30', # noqa
...	...	@@ -291,6 +296,8 @@ if locals().get('RAVEN_DSN', False):
291	296	BROWSERID_ENABLED = locals().get('BROWSERID_ENABLED') or False
292	297	SOCIAL_NETWORK_ENABLED = locals().get('SOCIAL_NETWORK_ENABLED') or False
293	298
	299	+locals().update(load_colab_apps())
	300	+
294	301	COLAB_APPS = locals().get('COLAB_APPS') or {}
295	302	PROXIED_APPS = {}
296	303
...	...
1	1
2	2	import os
	3	+import sys
	4	+
	5	+import warnings
	6	+
3	7	import yaml
4	8
5	9	import yamlordereddictloader
6	10
7	11	from django.core.exceptions import ImproperlyConfigured
8	12
	13	+import importlib
	14	+
	15	+
	16	+USING_YAML_SETTINGS = False
	17	+
9	18
10	19	class InaccessibleYAMLSettings(ImproperlyConfigured):
11	20	"""Settings YAML is Inaccessible.
...	...	@@ -29,22 +38,144 @@ def _load_yaml_file(yaml_path):
29	38
30	39	def load_yaml_settings():
31	40	settings_dir = '/etc/colab/settings.d'
32		- yaml_path = os.getenv('COLAB_SETTINGS', '/etc/colab/settings.yaml')
	41	+ yaml_path = os.getenv('COLAB_YAML_SETTINGS', '/etc/colab/settings.yaml')
33	42
34		- if not os.path.exists(yaml_path):
35		- msg = "The yaml file {} does not exist".format(yaml_path)
36		- raise InaccessibleYAMLSettings(msg)
	43	+ if os.path.exists(yaml_path):
	44	+ global USING_YAML_SETTINGS
	45	+ USING_YAML_SETTINGS = True
	46	+ warnings.warn("YAML Settings file is deprecated. Use Py file instead.")
	47	+ else:
	48	+ return {}
37	49
38	50	yaml_settings = _load_yaml_file(yaml_path)
39	51
	52	+ parse_yml_menus(yaml_settings)
	53	+
40	54	# Try to read settings from settings.d
41	55	if os.path.exists(settings_dir):
42	56	for file_name in os.listdir(settings_dir):
43	57	if file_name.endswith('.yaml') or file_name.endswith('yml'):
44	58	file_path = os.path.join(settings_dir, file_name)
45	59	yaml_settings_d = _load_yaml_file(file_path)
	60	+
	61	+ parse_yml_menus(yaml_settings_d)
	62	+
46	63	yaml_settings.update(yaml_settings_d)
47	64
48	65	return yaml_settings or {}
49	66
50		-yaml_settings = load_yaml_settings()
	67	+
	68	+class InaccessiblePySettings(ImproperlyConfigured):
	69	+ """Settings.py is Inaccessible.
	70	+
	71	+ Check if the file exists and if you have read permissions."""
	72	+
	73	+
	74	+def _load_py_file(py_path, path):
	75	+ original_path = sys.path
	76	+
	77	+ sys.path = [path]
	78	+ try:
	79	+ py_settings = importlib.import_module(py_path)
	80	+
	81	+ except IOError:
	82	+ msg = ('Could not open settings file {}. Please '
	83	+ 'check if the file exists and if user '
	84	+ 'has read rights.').format(py_path)
	85	+ raise InaccessiblePySettings(msg)
	86	+
	87	+ except SyntaxError as excpt:
	88	+ msg = ('Syntax Error: {}'.format(excpt))
	89	+ raise InaccessiblePySettings(msg)
	90	+
	91	+ finally:
	92	+ sys.path = original_path
	93	+
	94	+ py_setting = {var: getattr(py_settings, var) for var in dir(py_settings)
	95	+ if not var.startswith('__')}
	96	+
	97	+ return py_setting
	98	+
	99	+
	100	+def load_py_settings():
	101	+ settings_dir = '/etc/colab/settings.d'
	102	+ settings_file = os.getenv('COLAB_SETTINGS', '/etc/colab/settings.py')
	103	+ settings_module = settings_file.split('.')[-2].split('/')[-1]
	104	+ py_path = "/".join(settings_file.split('/')[:-1])
	105	+
	106	+ global USING_YAML_SETTINGS
	107	+ if not os.path.exists(py_path) and not USING_YAML_SETTINGS:
	108	+ msg = "The py file {} does not exist".format(py_path)
	109	+ raise InaccessiblePySettings(msg)
	110	+ elif USING_YAML_SETTINGS:
	111	+ return {}
	112	+
	113	+ py_settings = _load_py_file(settings_module, py_path)
	114	+
	115	+ # Try to read settings from settings.d
	116	+
	117	+ if os.path.exists(settings_dir):
	118	+ return py_settings
	119	+ for file_name in os.listdir(settings_dir):
	120	+ if file_name.endswith('.py'):
	121	+ file_module = file_name.split('.')[0]
	122	+ py_settings_d = _load_py_file(file_module, settings_dir)
	123	+ py_settings.update(py_settings_d)
	124	+
	125	+ return py_settings
	126	+
	127	+
	128	+def load_colab_apps():
	129	+ plugins_dir = os.getenv('COLAB_PLUGINS', '/etc/colab/plugins.d/')
	130	+
	131	+ global USING_YAML_SETTINGS
	132	+ if USING_YAML_SETTINGS:
	133	+ return {}
	134	+
	135	+ COLAB_APPS = {}
	136	+
	137	+ # Try to read settings from plugins.d
	138	+ if os.path.exists(plugins_dir):
	139	+ for file_name in os.listdir(plugins_dir):
	140	+ if file_name.endswith('.py'):
	141	+ file_module = file_name.split('.')[0]
	142	+ py_settings_d = _load_py_file(file_module, plugins_dir)
	143	+ fields = ['verbose_name', 'upstream', 'urls',
	144	+ 'menu_urls', 'middlewares', 'dependencies',
	145	+ 'context_processors']
	146	+
	147	+ app_name = py_settings_d.get('name')
	148	+ if not app_name:
	149	+ warnings.warn("Plugin missing name variable")
	150	+ continue
	151	+
	152	+ COLAB_APPS[app_name] = {}
	153	+ COLAB_APPS[app_name]['menu_title'] = \
	154	+ py_settings_d.get('menu_title')
	155	+
	156	+ for key in fields:
	157	+ value = py_settings_d.get(key)
	158	+ if value:
	159	+ COLAB_APPS[app_name][key] = value
	160	+
	161	+ return {'COLAB_APPS': COLAB_APPS}
	162	+
	163	+
	164	+def parse_yml_menus(yaml_settings):
	165	+ if 'COLAB_APPS' in yaml_settings:
	166	+ for key, plugin in yaml_settings['COLAB_APPS'].items():
	167	+ if 'menu' in plugin:
	168	+ parse_yml_tuples(yaml_settings['COLAB_APPS'][key]['menu'])
	169	+
	170	+
	171	+def parse_yml_tuples(menu):
	172	+ dict_links = menu['links']
	173	+ dict_auth_links = menu['auth_links']
	174	+ menu['links'] = tuple()
	175	+ menu['auth_links'] = tuple()
	176	+
	177	+ for key, value in dict_links.items():
	178	+ menu['links'] += ((key, value),)
	179	+
	180	+ for key, value in dict_auth_links.items():
	181	+ menu['auth_links'] += ((key, value),)
...	...
...	...	@@ -14,41 +14,33 @@ Install
14	14
15	15	Plugins
16	16	-------
17		-.. attribute:: COLAB_APPS
	17	+.. attribute:: name
18	18
19		- :default: None
	19	+Declares the absolute name of the plugin app as a python import path. Example:
	20	+directory.something.someplugin
	21	+
	22	+.. attribute:: verbose_name
20	23
21		- Describes the activated plugins and its configurations. It's necessary to describe
22		- for each app its name as the variable. The apps described here can be devided into
23		- two categories, that beeing, colab proxy apps and third-party apps.
24		- The upstream variable is only needed to colab proxy apps.
	24	+Delclare the description name of the plugin.
25	25
26	26	.. attribute:: upstream
27	27
28		-Declares the upstream server url of the proxy. Only declare if the plugin is a proxy.
	28	+Declares the upstream server url of the proxy. Only declare if the plugin is a
	29	+proxy.
29	30
30		-dependecies
31		-+++++++++++
	31	+.. attribute:: middlewares
32	32
33		- A list of the plugin dependecies that will be added to INSTALLED_APPS.
34		- This doesn't automatically install the python dependecies, only add to django apps.
	33	+Declares the middlewares of the plugin in a list format.
35	34
	35	+.. attribute:: context_processors
36	36
37		-menu
38		-++++
	37	+Declares the context processors of the plugin in a list format too.
39	38
40		-.. attribute:: title
	39	+.. attribute:: dependency
41	40
42		- Declares the menu title.
43		-.. attribute:: links
44		-
45		- Declares the menu items and its links.
46		-.. attribute:: auth_links
47		-
48		- Declares the menu items and its links when the user authenticated.
49		-.. attribute:: dependecies
50		-
51		-Declares a list of the plugin dependecies.
	41	+Declares the additional installed apps that this plugin depends on.
	42	+This doesn't automatically install the python dependecies, only add to django
	43	+apps.
52	44
53	45	urls
54	46	++++
...	...	@@ -63,16 +55,35 @@ urls
63	55
64	56	Declares the namespace for the url.
65	57
66		-context_processors
67		-++++++++++++++++++
	58	+menu
	59	+++++
68	60
69		- Declares the plugin context processors.
	61	+These variables defines the menu title and links of the plugin.
70	62
71		-middlewares
72		-+++++++++++
	63	+.. attribute:: menu_title
	64	+
	65	+ Declares the menu title.
	66	+.. attribute:: menu_links
	67	+
	68	+ Declares the menu items and its links.
	69	+ This should be a tuple object with several colab_url elements.
	70	+ The colab_url_factory creates a factory for your links along with your
	71	+ namespace.
	72	+ The auth parameter indicates wether the link should only be displayed when
	73	+ the user is logged in.
	74	+
	75	+Example:
	76	+
	77	+.. code-block:: python
73	78
74		- Declares the plugin middlewares.
	79	+ from colab.plugins.utils.menu import colab_url_factory
75	80
	81	+ url = colab_url_factory('plugin_app_name')
	82	+
	83	+ menu_urls = (
	84	+ url(display=_('Profile'), viewname='profile', kwargs={'path': '/profile/'}, auth=True),
	85	+ url(display=_('Profile Two'), viewname='profile2', kwargs={'path': '/profile/2'}, auth=True),
	86	+ )
76	87
77	88	Extra Template Folders
78	89	++++++++++++++++++++++
...	...	@@ -113,12 +124,12 @@ SVN
113	124	.. TODO
114	125
115	126	Social Networks
116		-++++
	127	++++++++++++++++
117	128	.. attribute:: SOCIAL_NETWORK_ENABLED
118	129
119	130	:default: False
120	131
121		- When this variable is True, the social networks fields, like Facebook and
	132	+ When this variable is True, the social networks fields, like Facebook and
122	133	Twitter, are added in user profile. By default, this fields are disabled.
123	134
124	135	Auth
...	...
...	...	@@ -0,0 +1,11 @@
	1	+SECRET_KEY = 'ddddddddddddddddddddddddddddddddddddddddddddddddddddddaddddddddd'
	2	+
	3	+DATABASES = {
	4	+ 'default': {
	5	+ 'ENGINE': 'django.db.backends.postgresql_psycopg2',
	6	+ 'HOST': 'localhost',
	7	+ 'NAME': 'colab',
	8	+ 'USER': 'colab',
	9	+ 'PASSWORD': 'colab',
	10	+ }
	11	+}
...	...