From 6205ad80add9c222bde329489c3c86d1a0655a52 Mon Sep 17 00:00:00 2001
From: Adam Williamson <awilliam@redhat.com>
Date: Apr 08 2018 06:19:35 +0000
Subject: Improve human-readable date/time display in web UI


There are many places in the web UI where we take a date/time
(sourced either from a datetime or a timestamp) and turn it
into some kind of human-readable form. There are mouseovers
for the date/time a commit, PR or issue was created, the time
it was last modified, and the date/time on each comment in an
issue or PR, for instance. There were three problems with this.

First, these weren't all consistent. Some used the format string
'%b %d %Y %H:%M:%S', which gives something like "Mar 06 2018
23:44:27", while others used '%Y-%m-%d %H:%M:%S', which gives
something like "2018-03-06 23:44:27". There's no reason these
shouldn't be consistent, AFAICS.

Second, neither of the existing forms indicates the timezone of
the date/time, which is UTC. This isn't obvious for users: they
may well assume the date/time given is in their local timezone.
Ideally I'd actually like to *do* that, but doing it is hard; we
can at least explicitly give the timezone in the string.

Finally, we were constantly duplicating the format strings all
over the templates, where it would make much more sense to just
have a single filter function and use it every time we want to
do this. This enforces consistency, and means that if we do want
to change the format in future, we can change it in one place,
not dozens of them.

This was prompted by #3041 but doesn't entirely fix it.

Signed-off-by: Adam Williamson <awilliam@redhat.com>

---

diff --git a/pagure/templates/_formhelper.html b/pagure/templates/_formhelper.html
index a1d98a1..9c2c6cc 100644
--- a/pagure/templates/_formhelper.html
+++ b/pagure/templates/_formhelper.html
@@ -113,7 +113,7 @@
     <a class="headerlink pull-xs-right" title="Permalink to this headline"
       href="#comment-{{ id }}">
       <span title="{{
-        comment.date_created.strftime('%Y-%m-%d %H:%M:%S')
+        comment.date_created | format_datetime
         }}">{{ comment.date_created | humanize}}</span>
     </a>
   </div>
@@ -121,7 +121,7 @@
     <section class="issue_comment">
       <div>
         <span class="edit_date" title="{{
-            comment.edited_on.strftime('%Y-%m-%d %H:%M:%S') if comment.edited_on
+            comment.edited_on | format_datetime if comment.edited_on
         }}">
         </span>
         <span class="comment_text comment_body">
diff --git a/pagure/templates/forks.html b/pagure/templates/forks.html
index 7e35b51..896f6db 100644
--- a/pagure/templates/forks.html
+++ b/pagure/templates/forks.html
@@ -30,7 +30,7 @@
               </a> forked this project
             </span>
             <span class="commitdate" data-toggle="tooltip" title="{{
-                fork.date_created.strftime('%Y-%m-%d %H:%M:%S') }}">
+                fork.date_created | format_datetime }}">
                 <strong>{{ fork.date_created|humanize }}</strong>
             </span>
           </div>
diff --git a/pagure/templates/issue.html b/pagure/templates/issue.html
index e2ab290..951097e 100644
--- a/pagure/templates/issue.html
+++ b/pagure/templates/issue.html
@@ -33,14 +33,14 @@
 
   <h5 class="text-muted">
     Created <a href="#" data-toggle="tooltip" title="{{
-        issue.date_created.strftime('%b %d %Y %H:%M:%S')
+        issue.date_created | format_datetime
       }}">{{ issue.date_created | humanize}}</a> by <span title="{{
       issue.user.html_title }}">{{ issue.user.user }}</span>
   </h5>
   {% if issue.last_updated %}
     <h5 class="text-muted">
       Modified <a href="#" data-toggle="tooltip" title="{{
-        issue.last_updated.strftime('%b %d %Y %H:%M:%S')
+        issue.last_updated | format_datetime
       }}">{{ issue.last_updated | humanize}}</a>
     </h5>
   {% endif %}
@@ -63,7 +63,7 @@
             <div class="card-header">
               <div>
                 <div class="pull-xs-right text-muted">
-                    <span title="{{ comment.date_created.strftime('%Y-%m-%d %H:%M:%S') }}">{{
+                    <span title="{{ comment.date_created | format_datetime }}">{{
                         comment.date_created | humanize }}</span>
                 </div>
                 <small>{{ comment.comment | markdown | noJS | safe }}</small>
diff --git a/pagure/templates/issues.html b/pagure/templates/issues.html
index d6150f3..c2e0cc7 100644
--- a/pagure/templates/issues.html
+++ b/pagure/templates/issues.html
@@ -263,19 +263,19 @@
               {% endfor%}
             </td>
             <td class="td-open_date nowrap">
-                <span title="{{issue.date_created.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+                <span title="{{issue.date_created | format_datetime}}">{{
                         issue.date_created | humanize}}</span>
             </td>
             {% if status and status|lower != 'open' %}
             <td class="nowrap">
                 {% if issue.closed_at != None %}
-                <span title="{{issue.closed_at.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+                <span title="{{issue.closed_at | format_datetime}}">{{
                         issue.closed_at | humanize}}</span>
                 {% endif %}
             </td>
             {% else %}
             <td class="td-mod_date nowrap">
-                <span title="{{issue.last_updated.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+                <span title="{{issue.last_updated | format_datetime}}">{{
                         issue.last_updated | humanize}}</span>
             </td>
             {% endif %}
diff --git a/pagure/templates/pull_request.html b/pagure/templates/pull_request.html
index f155200..13b1d1d 100644
--- a/pagure/templates/pull_request.html
+++ b/pagure/templates/pull_request.html
@@ -85,14 +85,14 @@
 
   <h5 class="text-muted">
     Proposed <a href="#" data-toggle="tooltip" title="{{
-        pull_request.date_created.strftime('%b %d %Y %H:%M:%S')
+        pull_request.date_created | format_datetime
       }}">{{ pull_request.date_created |humanize }}</a>
     by {{ pull_request.user.default_email | avatar(16) | safe
       }} <span title="{{ pull_request.user.html_title }}">{{ pull_request.user.user }}</span>
   </h5>
   <h5 class="text-muted">
     Modified <a href="#" data-toggle="tooltip" title="{{
-        pull_request.last_updated.strftime('%b %d %Y %H:%M:%S')
+        pull_request.last_updated | format_datetime
       }}">{{ pull_request.last_updated |humanize }}</a>
   </h5>
 
@@ -576,7 +576,7 @@
                         onclick="showTab()">{{
                         comment.line }} of {{ comment.filename }}</a>.
                 <div class="pull-xs-right text-muted">
-                    <span title="{{ comment.date_created.strftime('%Y-%m-%d %H:%M:%S') }}">{{
+                    <span title="{{ comment.date_created | format_datetime }}">{{
                         comment.date_created | humanize }}</span></div>
               </div>
                 (<a class="inline-btn small" data-id="{{ loop.index }}">Hide</a>)
@@ -590,7 +590,7 @@
             <div class="card-header">
               <div>
                 <div class="pull-xs-right text-muted">
-                    <span title="{{ comment.date_created.strftime('%Y-%m-%d %H:%M:%S') }}">{{
+                    <span title="{{ comment.date_created | format_datetime }}">{{
                         comment.date_created | humanize }}</span>
                 </div>
                 <small>{{ comment.comment | markdown | noJS | safe }}</small>
diff --git a/pagure/templates/repo_stats.html b/pagure/templates/repo_stats.html
index 17aa328..3971b8e 100644
--- a/pagure/templates/repo_stats.html
+++ b/pagure/templates/repo_stats.html
@@ -66,7 +66,7 @@
                     </a> forked this project
                   </span>
                   <span class="commitdate" data-toggle="tooltip" title="{{
-                      fork.date_created.strftime('%Y-%m-%d %H:%M:%S') }}">
+                      fork.date_created | format_datetime }}">
                       <strong>{{ fork.date_created|humanize }}</strong>
                   </span>
                 </div>
diff --git a/pagure/templates/requests.html b/pagure/templates/requests.html
index aaa399d..75d6a10 100644
--- a/pagure/templates/requests.html
+++ b/pagure/templates/requests.html
@@ -148,17 +148,17 @@
               <span>{{ request.branch }}</span>
             </td>
             <td class="nowrap">
-              <span title="{{request.date_created.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+              <span title="{{request.date_created | format_datetime}}">{{
                 request.date_created | humanize}}</span>
             </td>
             <td class="nowrap">
-              <span title="{{request.last_updated.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+              <span title="{{request.last_updated | format_datetime}}">{{
                 request.updated_on | humanize}}</span>
             </td>
             {% if status|lower not in ['open', 'true'] %}
             <td class="nowrap">
               <span title="{{
-                request.closed_at.strftime('%Y-%m-%d %H:%M:%S')
+                request.closed_at | format_datetime
                 if request.closed_at
               }}">{{
                 request.closed_at | humanize
diff --git a/pagure/templates/roadmap.html b/pagure/templates/roadmap.html
index 2afb27e..d6ee572 100644
--- a/pagure/templates/roadmap.html
+++ b/pagure/templates/roadmap.html
@@ -68,18 +68,18 @@
               {% endfor %}
             </td>
             <td class="td-open_date nowrap">
-              <span title="{{ issue.date_created.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+              <span title="{{ issue.date_created | format_datetime}}">{{
                       issue.date_created | humanize }}</span>
             </td>
             <td class="td-mod_date nowrap">
               {% if status and status|lower == 'closed' %}
                 <span title="{{
-                    issue.closed_at.strftime('%Y-%m-%d %H:%M:%S')
+                    issue.closed_at | format_datetime
                     if issue.closed_at
                     }}">{{
                       issue.closed_at | humanize }}</span>
               {% else %}
-              <span title="{{ issue.last_updated.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+              <span title="{{ issue.last_updated | format_datetime}}">{{
                       issue.last_updated | humanize }}</span>
               {% endif %}
             </td>
diff --git a/pagure/templates/user_issues.html b/pagure/templates/user_issues.html
index bc433f7..a8a29f0 100644
--- a/pagure/templates/user_issues.html
+++ b/pagure/templates/user_issues.html
@@ -66,11 +66,11 @@
                   </a>
                 </td>
                 <td class="nowrap">
-                    <span title="{{issue.date_created.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+                    <span title="{{issue.date_created | format_datetime}}">{{
                         issue.date_created | humanize}}</span>
                 </td>
                 <td class="nowrap">
-                    <span title="{{issue.last_updated.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+                    <span title="{{issue.last_updated | format_datetime}}">{{
                         issue.last_updated | humanize}}</span>
                 </td>
                 <td>
diff --git a/pagure/templates/user_list.html b/pagure/templates/user_list.html
index cf3af3e..ffccea5 100644
--- a/pagure/templates/user_list.html
+++ b/pagure/templates/user_list.html
@@ -59,7 +59,7 @@
           </a>
           <div class="repo_desc">
             <small>{{ user.user }} joined <span title="{{
-            user.created.strftime('%Y-%m-%d %H:%M:%S') }}">{{
+            user.created | format_datetime }}">{{
             user.created | humanize }}</span></small>
           </div>
           <div class="project_metadata">
diff --git a/pagure/templates/user_requests.html b/pagure/templates/user_requests.html
index 9cb59b6..d2406f0 100644
--- a/pagure/templates/user_requests.html
+++ b/pagure/templates/user_requests.html
@@ -90,7 +90,7 @@
               </span>
             </td>
             <td class="nowrap">
-              <span title="{{request.date_created.strftime('%Y-%m-%d %H:%M:%S')}}">{{
+              <span title="{{request.date_created | format_datetime}}">{{
                 request.date_created | humanize}}</span>
             </td>
             <td class="nowrap">
diff --git a/pagure/ui/filters.py b/pagure/ui/filters.py
index 8794b0c..dcb430f 100644
--- a/pagure/ui/filters.py
+++ b/pagure/ui/filters.py
@@ -13,7 +13,6 @@
 # pylint: disable=too-many-locals
 
 
-import datetime
 import textwrap
 import urlparse
 
@@ -62,11 +61,19 @@ def humanize_date(date):
 
 
 @UI_NS.app_template_filter('format_ts')
+@UI_NS.app_template_filter('format_datetime')
 def format_ts(string):
-    """ Template filter transforming a timestamp to a date
+    """ Template filter transforming a timestamp, datetime or anything
+    else arrow.get() can handle to a human-readable date
     """
-    dattime = datetime.datetime.fromtimestamp(int(string))
-    return dattime.strftime('%b %d %Y %H:%M:%S')
+    # We *could* enhance this by allowing users to specify preferred
+    # timezone, localized time format etc. and customizing this display
+    # to user's preferences. But we don't have that, so for now, we
+    # always use UTC timezone, and we don't use localized forms like
+    # %b or %d because they will be 'localized' for the *server*.
+    # This format should be pretty 'locale-neutral'.
+    arr = arrow.get(string)
+    return arr.strftime('%Y-%m-%d %H:%M:%S %Z')
 
 
 @UI_NS.app_template_filter('format_loc')
@@ -210,8 +217,7 @@ def format_loc(loc, commit=None, filename=None, tree_id=None, prequest=None,
 
                 if comment.edited_on:
                     templ_edited = tpl_edited % ({
-                        'edit_date': comment.edited_on.strftime(
-                            '%b %d %Y %H:%M:%S'),
+                        'edit_date': format_ts(comment.edited_on),
                         'human_edit_date': humanize_date(comment.edited_on),
                         'user': comment.editor.user,
                     })
@@ -253,8 +259,7 @@ def format_loc(loc, commit=None, filename=None, tree_id=None, prequest=None,
                             'user_html': comment.user.html_title,
                             'avatar_url': avatar_url(
                                 comment.user.default_email, 16),
-                            'date': comment.date_created.strftime(
-                                '%b %d %Y %H:%M:%S'),
+                            'date': format_ts(comment.date_created),
                             'human_date': humanize_date(comment.date_created),
                             'comment': markdown_filter(comment.comment),
                             'commentid': comment.id,