Migration to python 3.4 and TurboGear 2.3.4

README.md

@@ -68,7 +68,7 @@ Tracim is licensed under the terms of the
 
 Tracim is a web application:
 
-* developed with python 3.
+* developed with python >=3.4.
 * based on the [TurboGears](http://www.turbogears.org/) web framework.
 * relying on [PostgreSQL](http://www.postgresql.org/) as the storage engine.
 
@@ -136,14 +136,11 @@ Get the sources from Bitbucket:
 
 ### Setting-up python virtualenv ###
 
-_Reminder : Tracim is developped and tested using python3._
+_Reminder : Tracim is developped and tested using python3.4._
 
 Tracim uses virtualenv as deployment environment. This ensure that there will be no 
 conflict between system-wide python installation and Tracim required ones.
 
-**Note**: If you're using python3.4 or more, modify ``install/requirements.txt`` file to remove
-``wsgiref`` package and change ``tgext.pluggable`` to ``0.5.4`` version.
-
     SITE_PACKAGES_PATH=`python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"`
     virtualenv -p /usr/bin/python3 tg2env
     source tg2env/bin/activate
@@ -155,9 +152,6 @@ conflict between system-wide python installation and Tracim required ones.
     
 Notes:
 
-* Patchs are applied in a two-step process because some dependencies require to be patched before other packages installation
-* Debian: you may get errors with stevedore/pbr which is not supported by python 3.2
-(debian version of python 3). This is not a real problem
 * Ubuntu (at least 14.04): please update the site-package path with your version of python
 
 ## Database Setup ##

install/requirements.txt

@@ -3,24 +3,24 @@ Beaker==1.6.4
 CherryPy==3.6.0
 FormEncode==1.3.0a1
 Genshi==0.7
-Mako==1.0.0
-MarkupSafe==0.15
+Mako==1.0.3
+MarkupSafe==0.23
 PasteDeploy==1.5.2
-SQLAlchemy==0.9.8
+SQLAlchemy==1.0.11
 Tempita==0.5.3dev
-TurboGears2==2.3.4
-WebOb==1.4
+TurboGears2==2.3.7
+WebOb==1.6.0a0
 WebTest==1.4.2
-alembic==0.6.7
+alembic==0.8.4
 argparse==1.2.1
 backlash==0.0.6
 beautifulsoup4==4.3.2
 cliff==1.8.0
 cmd2==0.6.7
 coverage==4.0a1
-crank==0.7.1
+crank==0.7.3
 decorator==3.4.0
-gearbox==0.0.6
+gearbox==0.0.7
 itsdangerous==0.24
 nose==1.3.4
 pbr==0.10.0
@@ -34,17 +34,16 @@ six==1.8.0
 speaklater==1.3
 sprox==0.9.4
 stevedore==1.1.0
-tg.devtools==2.3.4
+tg.devtools==2.3.7
 tgext.admin==0.6.4
 tgext.asyncjob==0.3.1
 tgext.crud==0.7.3
-tgext.pluggable==0.5.2
-transaction==1.4.3
+tgext.pluggable==0.5.4
+transaction==1.4.4
 tw2.core==2.2.2
 tw2.forms==2.2.2.1
 waitress==0.8.9
-wsgiref==0.1.2
-zope.interface==4.1.1
-zope.sqlalchemy==0.7.5
+zope.interface==4.1.3
+zope.sqlalchemy==0.7.6
 tgapp-resetpassword==0.1.3
 lxml

tracim/setup.py

@@ -32,7 +32,7 @@ testpkgs=['WebTest >= 1.2.3',
                ]
 
 install_requires=[
-    "TurboGears2 >= 2.3.1",
+    "TurboGears2 >= 2.3.7",
     "Genshi",
     "Mako",
     "zope.sqlalchemy >= 0.4",

tracim/tracim/config/app_cfg.py

@@ -24,6 +24,7 @@ from tg.i18n import lazy_ugettext as l_
 
 import tracim
 from tracim import model
+from tracim.lib import app_globals, helpers
 from tracim.lib.base import logger
 from tracim.model.data import ActionDescription
 from tracim.model.data import ContentType
@@ -288,4 +289,10 @@ class CFG(object):
 #
 # OR
 #
+
+# Add some variable to each templates
+base_config.variable_provider = lambda: {
+    'CFG': CFG.get_instance()
+}
+
 plug(base_config, 'tgext.asyncjob')

tracim/tracim/lib/helpers.py

@@ -11,7 +11,6 @@ from markupsafe import Markup
 
 import tg
 from tg.i18n import ugettext as _
-from tracim.config.app_cfg import CFG
 
 from tracim.lib import app_globals as plag
 
@@ -83,15 +82,6 @@ class ICON(object):
   Shared = '<i class="fa fa-group"></i>'
   Private = '<i class="fa fa-key"></i>'
 
-def show_email_stuff():
-    """
-    this function is used in order to show/hide link for sending password reset through email
-    """
-    return CFG.get_instance().EMAIL_NOTIFICATION_ACTIVATED
-
-def tracker_js():
-    return CFG.get_instance().TRACKER_JS_CONTENT
-
 def IconPath(icon_size, icon_path):
     return tg.url('/assets/icons/{0}x{0}/{1}.png'.format(icon_size, icon_path))
 
@@ -176,7 +166,7 @@ def delete_label_for_item(item) -> str:
     """
     return ContentType._DELETE_LABEL[item.type]
 
-def is_item_still_editable(item):
+def is_item_still_editable(CFG, item):
     if item.type.id != 'comment':
         return False
 
@@ -208,6 +198,3 @@ def shorten(text: str, maxlength: int, add_three_points=True) -> str:
             result += '…'
 
     return result
-
-from tracim.config.app_cfg import CFG as CFG_ORI
-CFG = CFG_ORI.get_instance() # local CFG var is an instance of CFG class found in app_cfg

tracim/tracim/lib/notifications.py

@@ -11,8 +11,6 @@ from mako.template import Template
 from tg.i18n import lazy_ugettext as l_
 from tg.i18n import ugettext as _
 
-from tracim.config.app_cfg import CFG
-
 from tracim.lib.base import logger
 from tracim.lib.email import SmtpConfiguration
 from tracim.lib.email import EmailSender
@@ -46,6 +44,8 @@ class NotifierFactory(object):
 
     @classmethod
     def create(cls, current_user: User=None) -> INotifier:
+        # TODO: Find a way to import properly without cyclic import
+        from tracim.config.app_cfg import CFG
         cfg = CFG.get_instance()
         if not cfg.EMAIL_NOTIFICATION_ACTIVATED:
             return DummyNotifier(current_user)
@@ -69,6 +69,8 @@ class RealNotifier(object):
         :return:
         """
         logger.info(self, 'Instantiating Real Notifier')
+        # TODO: Find a way to import properly without cyclic import
+        from tracim.config.app_cfg import CFG
         cfg = CFG.get_instance()
 
         self._user = current_user
@@ -78,6 +80,8 @@ class RealNotifier(object):
                                        cfg.EMAIL_NOTIFICATION_SMTP_PASSWORD)
 
     def notify_content_update(self, content: Content):
+        # TODO: Find a way to import properly without cyclic import
+        from tracim.config.app_cfg import CFG
         global_config = CFG.get_instance()
 
         if content.get_last_action().id not \
@@ -174,7 +178,7 @@ class EmailNotifier(object):
     and other stuff related to the turbogears environment)
     """
 
-    def __init__(self, smtp_config: SmtpConfiguration, global_config: CFG):
+    def __init__(self, smtp_config: SmtpConfiguration, global_config):
         self._smtp_config = smtp_config
         self._global_config = global_config
 

tracim/tracim/templates/index.mak

@@ -2,7 +2,7 @@
 <%namespace name="TIM" file="tracim.templates.pod"/>
 
 <%def name="title()">
-  ${h.CFG.WEBSITE_TITLE|n}
+  ${CFG.WEBSITE_TITLE|n}
 </%def>
 
 
@@ -11,17 +11,17 @@
         <div>
             <div class="row">
                 <div class="col-sm-offset-3 col-sm-6">
-                    <h1 class="text-center" style="color: ${h.CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${h.CFG.WEBSITE_TITLE|n}</b></h1>
-                    <p class="text-center" style="color: ${h.CFG.WEBSITE_HOME_TITLE_COLOR};">${h.CFG.WEBSITE_SUBTITLE|n}</p>
+                    <h1 class="text-center" style="color: ${CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${CFG.WEBSITE_TITLE|n}</b></h1>
+                    <p class="text-center" style="color: ${CFG.WEBSITE_HOME_TITLE_COLOR};">${CFG.WEBSITE_SUBTITLE|n}</p>
                 </div>
             </div>
 
             <div class="row">
                 <div class="col-sm-offset-3 col-sm-2">
                     <a class="thumbnail">
-                        <img src="${h.CFG.WEBSITE_HOME_IMAGE_URL}" alt="">
+                        <img src="${CFG.WEBSITE_HOME_IMAGE_URL}" alt="">
                     </a>
-                    <p>${h.CFG.WEBSITE_HOME_TAG_LINE|n}</p>
+                    <p>${CFG.WEBSITE_HOME_TAG_LINE|n}</p>
                     
 
                 </div>
@@ -50,7 +50,7 @@
                                 <button type="submit" class="btn btn-small btn-success text-right">
                                     <i class="fa fa-check"></i> ${_('Login')}
                                 </button>
-                                % if h.show_email_stuff():
+                                % if CFG.EMAIL_NOTIFICATION_ACTIVATED:
                                     <div class="pull-left">
                                         <a class="btn btn-link" href="${tg.url('/reset_password')}"><i class="fa fa-magic"></i> ${_('Forgot password?')}</a>
                                     </div>
@@ -61,7 +61,7 @@
                 </div>
             </div>
             <div class="row">
-                <div class="col-sm-offset-3 col-sm-6 text-center">${h.CFG.WEBSITE_HOME_BELOW_LOGIN_FORM|n}</div>
+                <div class="col-sm-offset-3 col-sm-6 text-center">${CFG.WEBSITE_HOME_BELOW_LOGIN_FORM|n}</div>
             </div>
 
 

tracim/tracim/templates/mail/content_update_body_html.mak

@@ -63,7 +63,7 @@
     
     <div id="footer">
         <p>
-            ${_('{user_display_name}, you receive this email because you are registered on <i>{website_title}</i> and you are <i>{user_role_label}</i> in the workspace <a href="{workspace_url}">{workspace_label}</a>.').format(user_display_name=user_display_name, user_role_label=user_role_label, workspace_url=result.item.workspace.url, workspace_label=workspace_label, website_title=h.CFG.WEBSITE_TITLE)|n}
+            ${_('{user_display_name}, you receive this email because you are registered on <i>{website_title}</i> and you are <i>{user_role_label}</i> in the workspace <a href="{workspace_url}">{workspace_label}</a>.').format(user_display_name=user_display_name, user_role_label=user_role_label, workspace_url=result.item.workspace.url, workspace_label=workspace_label, website_title=CFG.WEBSITE_TITLE)|n}
         </p>
         <hr/>
         <p>

tracim/tracim/templates/mail/content_update_body_text.mak

@@ -15,7 +15,7 @@ Hope you'll switch your mail client configuration and enjoy Tracim :)
 --------------------------------------------------------------------------------
 
 
-You receive this email because you are registered on /${h.CFG.WEBSITE_TITLE}/
+You receive this email because you are registered on /${CFG.WEBSITE_TITLE}/
 and you are /${user_role_label}/ in the workspace /${workspace_label}/
 ${result.item.workspace.url}
 

tracim/tracim/templates/master_anonymous.mak

@@ -17,7 +17,7 @@
 
     <body class="${self.body_class()}" style="
     height: 100%;
-    background: url(${h.CFG.WEBSITE_HOME_BACKGROUND_IMAGE_URL}) no-repeat center bottom scroll;
+    background: url(${CFG.WEBSITE_HOME_BACKGROUND_IMAGE_URL}) no-repeat center bottom scroll;
     -webkit-background-size: cover;
     -moz-background-size: cover;
     background-size: cover;
@@ -44,7 +44,7 @@
             });
         </script>
 
-        ${h.tracker_js()|n}
+        ${CFG.TRACKER_JS_CONTENT|n}
     </body>
 
 <%def name="content_wrapper()">

tracim/tracim/templates/master_authenticated.mak

@@ -32,7 +32,7 @@
         ${self.footer()}
 
         <script src="${tg.url('/assets/js/bootstrap.min.js')}"></script>
-        ${h.tracker_js()|n}
+        ${CFG.TRACKER_JS_CONTENT|n}
     </body>
 
 <%def name="content_wrapper()">

tracim/tracim/templates/master_no_toolbar_no_login.mak

@@ -46,7 +46,7 @@
         <script src="${tg.url('/javascript/external/google-code-prettify/prettify.js')}"></script>
         <script src="${tg.url('/javascript/external/bootstrap-wysiwyg.js')}"></script>
         <script src="/javascript/external/bootstrap-datetimepicker.min.js"></script>
-        ${h.tracker_js()|n}
+        ${CFG.TRACKER_JS_CONTENT|n}
     </body>
 
 <%def name="content_wrapper()">

tracim/tracim/templates/reset_password_change_password.mak

@@ -1,13 +1,13 @@
 <%inherit file="local:templates.master_anonymous"/>
 
-<%def name="title()">${h.CFG.WEBSITE_TITLE|n} - ${_('Change Password Request')}</%def>
+<%def name="title()">${CFG.WEBSITE_TITLE|n} - ${_('Change Password Request')}</%def>
 
 <div class="container-fluid">
     <div class="row-fluid">
         <div>
             <div class="row">
                 <div class="col-sm-offset-3 col-sm-5">
-                    <h1 class="text-center" style="color: ${h.CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${h.CFG.WEBSITE_TITLE}</b></h1>
+                    <h1 class="text-center" style="color: ${CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${CFG.WEBSITE_TITLE}</b></h1>
                 </div>
             </div>
             <div class="row">

tracim/tracim/templates/reset_password_index.mak

@@ -1,13 +1,13 @@
 <%inherit file="local:templates.master_anonymous"/>
 
-<%def name="title()">${h.CFG.WEBSITE_TITLE|n} - ${_('Password Reset Request')}</%def>
+<%def name="title()">${CFG.WEBSITE_TITLE|n} - ${_('Password Reset Request')}</%def>
 
 <div class="container-fluid">
     <div class="row-fluid">
         <div>
             <div class="row">
                 <div class="col-sm-offset-3 col-sm-5">
-                    <h1 class="text-center" style="color: ${h.CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${h.CFG.WEBSITE_TITLE}</b></h1>
+                    <h1 class="text-center" style="color: ${CFG.WEBSITE_HOME_TITLE_COLOR};"><b>${CFG.WEBSITE_TITLE}</b></h1>
                 </div>
             </div>
             <div class="row">

tracim/tracim/templates/user_workspace_widgets.mak

@@ -356,7 +356,7 @@
                     <div class="pull-right text-right t-timeline-item-moment" title="${h.date_time(event.created)|n}">
                         ${_('{delta} ago').format(delta=event.created_as_delta)}
 
-                        % if h.is_item_still_editable(event) and event.owner.id==user.id:
+                        % if h.is_item_still_editable(CFG, event) and event.owner.id==user.id:
                             <br/>
                                 <a class="t-timeline-comment-delete-button" href="${event.urls.delete}">
                                     ${_('delete')} ${ICON.FA('fa fa-trash-o')}

tracim/tracim/tests/library/test_helpers.py

@@ -6,6 +6,7 @@ from nose.tools import eq_
 from nose.tools import ok_
 
 import tracim.lib.helpers as h
+from tracim.config.app_cfg import CFG
 from tracim.model.data import Content
 from tracim.model.data import ContentType
 from tracim.model.data import Workspace
@@ -16,6 +17,7 @@ from tracim.model.serializers import DictLikeClass
 
 from tracim.tests import TestStandard
 
+config = CFG.get_instance()
 
 
 class TestHelpers(TestStandard):
@@ -23,7 +25,7 @@ class TestHelpers(TestStandard):
     def test_is_item_still_editable(self):
         item = DictLikeClass()
 
-        h.CFG.DATA_UPDATE_ALLOWED_DURATION = 0
+        config.DATA_UPDATE_ALLOWED_DURATION = 0
         item.created = datetime.datetime.now() - datetime.timedelta(0, 10)
 
         item.type = DictLikeClass({'id': 5})
@@ -32,15 +34,15 @@ class TestHelpers(TestStandard):
         item.type.id = 'comment'
         eq_(False, h.is_item_still_editable(item))
 
-        h.CFG.DATA_UPDATE_ALLOWED_DURATION = -1
+        config.DATA_UPDATE_ALLOWED_DURATION = -1
         item.type.id = 'comment'
         item.created = datetime.datetime.now() - datetime.timedelta(0, 10)
         eq_(True, h.is_item_still_editable(item))
 
-        h.CFG.DATA_UPDATE_ALLOWED_DURATION = 12
+        config.DATA_UPDATE_ALLOWED_DURATION = 12
         item.created = datetime.datetime.now() - datetime.timedelta(0, 10)
         eq_(True, h.is_item_still_editable(item), 'created: {}, now: {}'.format(item.created, datetime.datetime.now())) # This test will pass only if the test duration is less than 120s !!!
 
-        h.CFG.DATA_UPDATE_ALLOWED_DURATION = 8
+        config.DATA_UPDATE_ALLOWED_DURATION = 8
         item.created = datetime.datetime.now() - datetime.timedelta(0, 10)
         eq_(False, h.is_item_still_editable(item))