Closes #118: Allow user to specify his timezone

tracim/migration/versions/2cd20ff3d23a_user_timezone.py

+"""user_timezone
+
+Revision ID: 2cd20ff3d23a
+Revises: b4b8d57b54e5
+Create Date: 2016-11-08 11:32:00.903232
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '2cd20ff3d23a'
+down_revision = 'b4b8d57b54e5'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('users', sa.Column('timezone', sa.Unicode(length=255), server_default='', nullable=False))
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('users', 'timezone')
+    ### end Alembic commands ###

tracim/tracim/controllers/user.py

 # -*- coding: utf-8 -*-
+import pytz
 from webob.exc import HTTPForbidden
 
 from tracim import model  as pm
 
         dictified_user = Context(CTX.USER).toDict(current_user, 'user')
         fake_api = DictLikeClass(next_url=next_url)
-        return DictLikeClass(result=dictified_user, fake_api=fake_api)
+        return DictLikeClass(
+            result=dictified_user,
+            fake_api=fake_api,
+            timezones=pytz.all_timezones,
+        )
 
     @tg.expose('tracim.templates.workspace.edit')
-    def put(self, user_id, name, email, next_url=None):
+    def put(self, user_id, name, email, timezone, next_url=None):
         user_id = tmpl_context.current_user.user_id
         current_user = tmpl_context.current_user
         assert user_id==current_user.user_id
         # Only keep allowed field update
         updated_fields = self._clean_update_fields({
             'name': name,
-            'email': email
+            'email': email,
+            'timezone': timezone,
         })
 
         api = UserApi(tmpl_context.current_user)

tracim/tracim/lib/helpers.py

 
 import datetime
 
+import pytz
 import slugify
-from babel.dates import format_date, format_time
+from babel.dates import format_date
+from babel.dates import format_time
 from markupsafe import Markup
 
 import tg
+from tg import tmpl_context
 from tg.i18n import ugettext as _
 
 from tracim.lib import app_globals as plag
 from tracim.lib.content import ContentApi
 from tracim.lib.userworkspace import RoleApi
 from tracim.lib.workspace import WorkspaceApi
-from tracim.model import User
 
 from tracim.model.data import ContentStatus
 from tracim.model.data import Content
 from tracim.model.data import UserRoleInWorkspace
 from tracim.model.data import Workspace
 
+
+def get_with_timezone(
+        datetime_object: datetime.datetime,
+        to_timezone: str='',
+        default_from_timezone: str='UTC',
+) -> datetime.datetime:
+    """
+    Change timezone of a date
+    :param datetime_object: datetime to update
+    :param to_timezone: timezone name, if equal to '',
+    try to grap current user timezone. If no given timezone name and no
+    current user timezone, return original date time
+    :param default_from_timezone: datetime original timezone if datetime
+    object is naive
+    :return: datetime updated
+    """
+    # If no to_timezone, try to grab from current user
+    if not to_timezone and tmpl_context.current_user:
+        to_timezone = tmpl_context.current_user.timezone
+
+    # If no to_timezone, return original datetime
+    if not to_timezone:
+        return datetime_object
+
+    # If datetime_object have not timezone, set new from default_from_timezone
+    if not datetime_object.tzinfo:
+        from_tzinfo = pytz.timezone(default_from_timezone)
+        datetime_object = from_tzinfo.localize(datetime_object)
+
+    new_tzinfo = pytz.timezone(to_timezone)
+    return datetime_object.astimezone(new_tzinfo)
+
+
 def date_time_in_long_format(datetime_object, format=''):
 
     current_locale = tg.i18n.get_lang()[0]

tracim/tracim/lib/user.py

     def get_one_by_id(self, id: int) -> User:
         return self._base_query().filter(User.user_id==id).one()
 
-    def update(self, user: User, name: str=None, email: str=None, do_save=True):
+    def update(
+            self,
+            user: User,
+            name: str=None,
+            email: str=None,
+            do_save=True,
+            timezone: str='',
+    ):
         if name is not None:
             user.display_name = name
 
         if email is not None:
             user.email = email
 
+        user.timezone = timezone
+
         if do_save:
             self.save(user)
 

tracim/tracim/model/auth.py

     created = Column(DateTime, default=datetime.now)
     is_active = Column(Boolean, default=True, nullable=False)
     imported_from = Column(Unicode(32), nullable=True)
+    timezone = Column(Unicode(255), nullable=False, server_default='')
     _webdav_left_digest_response_hash = Column('webdav_left_digest_response_hash', Unicode(128))
     auth_token = Column(Unicode(255))
     auth_token_created = Column(DateTime)

tracim/tracim/model/serializers.py

     result['enabled'] = user.is_active
     result['profile'] = user.profile
     result['has_password'] = user.password!=None
+    result['timezone'] = user.timezone
     return result
 
 
     result['enabled'] = user.is_active
     result['profile'] = user.profile
     result['calendar_url'] = user.calendar_url
+    result['timezone'] = user.timezone
 
     return result
 

tracim/tracim/templates/admin/workspace_getone.mak

 <%def name="TITLE_ROW()">
     <div class="row-fluid">
         <div>
-            <%
-                subtitle = _('created on {}'.format(h.formatLongDateAndTime(result.workspace.created)))
-            %>
+            <% created_localized = h.get_with_timezone(result.workspace.created) %>
+            <% subtitle = _('created on {}'.format(h.formatLongDateAndTime(created_localized))) %>
             ${ROW.TITLE_ROW(_('Workspace {}').format(result.workspace.label), 'fa-bank', 'col-md-offset-3 col-md-7', 't-user-color', subtitle)}
         </div>
     </div>

tracim/tracim/templates/file/getone.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="tracim-less-visible">
-          <p>${_('file created on {date} at {time} by <b>{author}</b>').format(date=h.date(result.file.created), time=h.time(result.file.created), author=result.file.owner.name)|n}</p>
+            <% created_localized = h.get_with_timezone(result.file.created) %>
+          <p>${_('file created on {date} at {time} by <b>{author}</b>').format(date=h.date(created_localized), time=h.time(created_localized), author=result.file.owner.name)|n}</p>
         </div>
     </div>
 </div>
                 </tr>
                 <tr>
                     <td class="tracim-title">${_('Modified')}</td>
-                    <td>${h.format_short(result.file.created)|n} ${_('by {}').format(result.file.owner.name)}</td>
+                    <% created_localized = h.get_with_timezone(result.file.created) %>
+                    <td>${h.format_short(created_localized)|n} ${_('by {}').format(result.file.owner.name)}</td>
                 </tr>
             </table>
         </div>

tracim/tracim/templates/folder/getone.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="tracim-less-visible">
-          <p>${_('folder created on {date} at {time} by <b>{author}</b>').format(date=h.date(result.folder.created), time=h.time(result.folder.created), author=result.folder.owner.name)|n}</p>
+            <% created_localized = h.get_with_timezone(result.folder.created) %>
+          <p>${_('folder created on {date} at {time} by <b>{author}</b>').format(date=h.date(created_localized), time=h.time(created_localized), author=result.folder.owner.name)|n}</p>
         </div>
     </div>
 </div>

tracim/tracim/templates/page/getone.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="tracim-less-visible">
-          <p>${_('page created on {date} at {time} by <b>{author}</b>').format(date=h.date(result.page.created), time=h.time(result.page.created), author=result.page.owner.name)|n}</p>
+            <% created_localized = h.get_with_timezone(result.page.created) %>
+          <p>${_('page created on {date} at {time} by <b>{author}</b>').format(date=h.date(created_localized), time=h.time(created_localized), author=result.page.owner.name)|n}</p>
         </div>
     </div>
 </div>

tracim/tracim/templates/search/display.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="tracim-less-visible">
-##          <p>${_('folder created on {date} at {time} by <b>{author}</b>').format(date=h.date(result.folder.created), time=h.time(result.folder.created), author=result.folder.owner.name)|n}</p>
+            <% created_localized = h.get_with_timezone(result.folder.created) %>
+##          <p>${_('folder created on {date} at {time} by <b>{author}</b>').format(date=h.date(created_localized), time=h.time(created_localized), author=result.folder.owner.name)|n}</p>
         </div>
     </div>
 </div>

tracim/tracim/templates/thread/getone.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="tracim-less-visible">
-          <p>${_('page created on {date} at {time} by <b>{author}</b>').format(date=h.date(result.thread.created), time=h.time(result.thread.created), author=result.thread.owner.name)|n}</p>
+            <% created_localized = h.get_with_timezone(result.thread.created) %>
+          <p>${_('page created on {date} at {time} by <b>{author}</b>').format(date=h.date(created_localized), time=h.time(created_localized), author=result.thread.owner.name)|n}</p>
         </div>
     </div>
 </div>

tracim/tracim/templates/user_workspace_forms.mak

                 <span class="info readonly">${_('This calendar URL will work with CalDav compatibles clients')}</span>
                 <input id="calendar" type="text" class="form-control"  disabled="disabled" value="${user.calendar_url}" />
             </div>
+            <div class="form-group">
+                <label for="timezone">${_('Timezone')}</label>
+                <span class="info readonly">${_('Dates will be displayed with this timezone')}</span>
+                <select id="timezone" name="timezone" class="form-control">
+                    <option value=""></option>
+                    % for timezone in timezones:
+                        % if timezone == user.timezone:
+                            <option value="${timezone}" selected>${timezone}</option>
+                        % else:
+                            <option value="${timezone}">${timezone}</option>
+                        % endif
+                    % endfor
+                </select>
+            </div>
         </div>
         <div class="modal-footer">
             <span class="pull-right t-modal-form-submit-button">

tracim/tracim/templates/user_workspace_widgets.mak

 </%def>
 
 <%def name="SECURED_TIMELINE_ITEM(user, item)">
+##     <% created_localized = h.get_with_timezone(item.created) %>
 ##     <div class="row t-odd-or-even t-hacky-thread-comment-border-top">
 ##         <div class="col-sm-7 col-sm-offset-3">
 ##             <div class="t-timeline-item">
 ##                 <h5 style="margin: 0;">
 ##                     <span class="tracim-less-visible">${_('<strong>{}</strong> wrote:').format(item.owner.name)|n}</span>
 ##
-##                     <div class="pull-right text-right t-timeline-item-moment" title="${h.date_time(item.created)|n}">
+##                     <div class="pull-right text-right t-timeline-item-moment" title="${h.date_time(created_localized)|n}">
 ##                         ${_('{delta} ago').format(delta=item.created_as_delta)}
 ##
 ##                         % if h.is_item_still_editable(item) and item.owner.id==user.id:
 </%def>
 
 <%def name="SECURED_HISTORY_VIRTUAL_EVENT(user, event)">
+    <% created_localized = h.get_with_timezone(event.created) %>
     <% is_new_css_class = 't-is-new-content' if event.is_new else '' %>
 
     <div class="row t-odd-or-even t-hacky-thread-comment-border-top ${is_new_css_class}">
                         <span class="tracim-less-visible">${_('{} by <strong>{}</strong>').format(event.label, event.owner.name)|n}</span>
                     % endif
 
-                    <div class="pull-right text-right t-timeline-item-moment" title="${h.date_time(event.created)|n}">
+                    <div class="pull-right text-right t-timeline-item-moment" title="${h.date_time(created_localized)|n}">
                         ${_('{delta} ago').format(delta=event.created_as_delta)}
 
                         % if h.is_item_still_editable(CFG, event) and event.owner.id==user.id:
 </%def>
 
 <%def name="SECURED_HISTORY_VIRTUAL_EVENT_AS_TABLE_ROW(user, event, current_revision_id)">
+    <% created_localized = h.get_with_timezone(event.created) %>
     <%
         warning_or_not = ('', 'warning')[current_revision_id==event.id]
         row_css = 't-is-new-content' if event.is_new else warning_or_not
         <td class="t-less-visible">
             <span class="label label-default">${ICON.FA_FW(event.type.icon)} ${event.type.label}</span>
         </td>
-        <td title="${h.date_time(event.created)|n}">${_('{delta} ago').format(delta=event.created_as_delta)}</td>
+        <td title="${h.date_time(created_localized)|n}">${_('{delta} ago').format(delta=event.created_as_delta)}</td>
         <td>${event.owner.name}</td>
 ## FIXME - REMOVE                            <td>${event}</td>
 

tracim/tracim/templates/workspace/getone.mak

         </h1>
 
         <div style="margin: -1.5em auto -1.5em auto;" class="t-less-visible">
-          <p>${_('workspace created on {date} at {time}').format(date=h.date(result.workspace.created), time=h.time(result.workspace.created))|n}</p>
+            <% created_localized = h.get_with_timezone(result.workspace.created) %>
+          <p>${_('workspace created on {date} at {time}').format(date=h.date(created_localized), time=h.time(created_localized))|n}</p>
         </div>
     </div>
 </div>

tracim/tracim/tests/library/test_helpers.py

 # -*- coding: utf-8 -*-
 
 import datetime
+from unittest.mock import MagicMock
 
+import pytz
+from babel.dates import get_timezone
 from nose.tools import eq_
-from nose.tools import ok_
+from tg.request_local import TurboGearsContextMember
+from tg.util.webtest import test_context
+from tg import tmpl_context
 
 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
-
-from tracim.model.serializers import Context
-from tracim.model.serializers import CTX
 from tracim.model.serializers import DictLikeClass
-
 from tracim.tests import TestStandard
 
 
         config.DATA_UPDATE_ALLOWED_DURATION = 8
         item.created = datetime.datetime.now() - datetime.timedelta(0, 10)
         eq_(False, h.is_item_still_editable(config, item))
+
+    def test_unit__change_datetime_timezone__ok__with_naive_and_current_user(self):  # nopep8
+        user_mock = MagicMock(timezone='America/Guadeloupe')
+
+        with test_context(self.app):
+            tmpl_context.current_user = user_mock
+            naive_datetime = datetime.datetime(2000, 1, 1, 0, 0, 0)
+
+            new_datetime = h.get_with_timezone(
+                datetime_object=naive_datetime,
+                default_from_timezone='UTC',
+                to_timezone='',  # user_mock.timezone should be used
+            )
+
+            eq_(str(new_datetime), '1999-12-31 20:00:00-04:00')