aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2017-01-07 14:30:42 +0100
committerArthurHoaro <arthur@hoa.ro>2017-03-06 21:11:12 +0100
commit52b503105d389d1796698114573ff618b2ad34a2 (patch)
treed636098fe0864db98c175cd7dfda19a1c069eb82
parent1255a42cfed9ce419962c6cf29181a66c7e22bb8 (diff)
downloadShaarli-52b503105d389d1796698114573ff618b2ad34a2.tar.gz
Shaarli-52b503105d389d1796698114573ff618b2ad34a2.tar.zst
Shaarli-52b503105d389d1796698114573ff618b2ad34a2.zip
Improve datetime display
Use php-intl extension to display datetimes a bit more nicely, depending on the locale. What changes: * the day is no longer displayed * day number and month are ordered according to the locale * the timezone is more readable (UTC+1 instead of CET)
-rw-r--r--application/Utils.php72
-rw-r--r--tests/UtilsTest.php46
-rw-r--r--tests/languages/bootstrap.php7
-rw-r--r--tests/languages/de/UtilsDeTest.php25
-rw-r--r--tests/languages/en/UtilsEnTest.php25
-rw-r--r--tests/languages/fr/UtilsFrTest.php25
-rw-r--r--tpl/default/linklist.html5
-rw-r--r--tpl/vintage/linklist.html4
8 files changed, 174 insertions, 35 deletions
diff --git a/application/Utils.php b/application/Utils.php
index 19fb7116..a936b09f 100644
--- a/application/Utils.php
+++ b/application/Utils.php
@@ -225,44 +225,46 @@ function autoLocale($headerLocale)
225 $encodings = ['utf8', 'UTF-8']; 225 $encodings = ['utf8', 'UTF-8'];
226 if (!empty($matches[2])) { 226 if (!empty($matches[2])) {
227 $second = [strtoupper($matches[2]), strtolower($matches[2])]; 227 $second = [strtoupper($matches[2]), strtolower($matches[2])];
228 $attempts = arrays_combination([$first, $separators, $second, ['.'], $encodings]); 228 $attempts = cartesian_product_generator([$first, $separators, $second, ['.'], $encodings]);
229 } else { 229 } else {
230 $attempts = arrays_combination([$first, $separators, $first, ['.'], $encodings]); 230 $attempts = cartesian_product_generator([$first, $separators, $first, ['.'], $encodings]);
231 } 231 }
232 } 232 }
233 } 233 }
234 setlocale(LC_ALL, $attempts); 234 setlocale(LC_ALL, implode('implode', iterator_to_array($attempts)));
235} 235}
236 236
237/** 237/**
238 * Combine multiple arrays of string to get all possible strings. 238 * Build a Generator object representing the cartesian product from given $items.
239 * The order is important because this doesn't shuffle the entries.
240 * 239 *
241 * Example: 240 * Example:
242 * [['a'], ['b', 'c']] 241 * [['a'], ['b', 'c']]
243 * will generate: 242 * will generate:
244 * - ab 243 * [
245 * - ac 244 * ['a', 'b'],
246 * 245 * ['a', 'c'],
247 * TODO PHP 5.6: use the `...` operator instead of an array of array. 246 * ]
248 * 247 *
249 * @param array $items array of array of string 248 * @param array $items array of array of string
250 * 249 *
251 * @return array Combined string from the input array. 250 * @return Generator representing the cartesian product of given array.
251 *
252 * @see https://en.wikipedia.org/wiki/Cartesian_product
252 */ 253 */
253function arrays_combination($items) 254function cartesian_product_generator($items)
254{ 255{
255 $out = ['']; 256 if (empty($items)) {
256 foreach ($items as $item) { 257 yield [];
257 $add = []; 258 }
258 foreach ($item as $element) { 259 $subArray = array_pop($items);
259 foreach ($out as $key => $existingEntry) { 260 if (empty($subArray)) {
260 $add[] = $existingEntry . $element; 261 return;
261 } 262 }
263 foreach (cartesian_product_generator($items) as $item) {
264 foreach ($subArray as $value) {
265 yield $item + [count($item) => $value];
262 } 266 }
263 $out = $add;
264 } 267 }
265 return $out;
266} 268}
267 269
268/** 270/**
@@ -303,3 +305,33 @@ function normalize_spaces($string)
303{ 305{
304 return preg_replace('/\s{2,}/', ' ', trim($string)); 306 return preg_replace('/\s{2,}/', ' ', trim($string));
305} 307}
308
309/**
310 * Format the date according to the locale.
311 *
312 * Requires php-intl to display international datetimes,
313 * otherwise default format '%c' will be returned.
314 *
315 * @param DateTime $date to format.
316 * @param bool $intl Use international format if true.
317 *
318 * @return bool|string Formatted date, or false if the input is invalid.
319 */
320function format_date($date, $intl = true)
321{
322 if (! $date instanceof DateTime) {
323 return false;
324 }
325
326 if (! $intl || ! class_exists('IntlDateFormatter')) {
327 return strftime('%c', $date->getTimestamp());
328 }
329
330 $formatter = new IntlDateFormatter(
331 setlocale(LC_TIME, 0),
332 IntlDateFormatter::LONG,
333 IntlDateFormatter::LONG
334 );
335
336 return $formatter->format($date);
337}
diff --git a/tests/UtilsTest.php b/tests/UtilsTest.php
index b8f608b9..e70cc1ae 100644
--- a/tests/UtilsTest.php
+++ b/tests/UtilsTest.php
@@ -23,7 +23,12 @@ class UtilsTest extends PHPUnit_Framework_TestCase
23 23
24 // Expected log date format 24 // Expected log date format
25 protected static $dateFormat = 'Y/m/d H:i:s'; 25 protected static $dateFormat = 'Y/m/d H:i:s';
26 26
27 /**
28 * @var string Save the current timezone.
29 */
30 protected static $defaultTimeZone;
31
27 32
28 /** 33 /**
29 * Assign reference data 34 * Assign reference data
@@ -31,6 +36,17 @@ class UtilsTest extends PHPUnit_Framework_TestCase
31 public static function setUpBeforeClass() 36 public static function setUpBeforeClass()
32 { 37 {
33 self::$sidHashes = ReferenceSessionIdHashes::getHashes(); 38 self::$sidHashes = ReferenceSessionIdHashes::getHashes();
39 self::$defaultTimeZone = date_default_timezone_get();
40 // Timezone without DST for test consistency
41 date_default_timezone_set('Africa/Nairobi');
42 }
43
44 /**
45 * Reset the timezone
46 */
47 public static function tearDownAfterClass()
48 {
49 date_default_timezone_set(self::$defaultTimeZone);
34 } 50 }
35 51
36 /** 52 /**
@@ -286,20 +302,28 @@ class UtilsTest extends PHPUnit_Framework_TestCase
286 /** 302 /**
287 * Test arrays_combine 303 * Test arrays_combine
288 */ 304 */
289 public function testArraysCombination() 305 public function testCartesianProductGenerator()
290 { 306 {
291 $arr = [['ab', 'cd'], ['ef', 'gh'], ['ij', 'kl'], ['m']]; 307 $arr = [['ab', 'cd'], ['ef', 'gh'], ['ij', 'kl'], ['m']];
292 $expected = [ 308 $expected = [
293 'abefijm', 309 ['ab', 'ef', 'ij', 'm'],
294 'cdefijm', 310 ['ab', 'ef', 'kl', 'm'],
295 'abghijm', 311 ['ab', 'gh', 'ij', 'm'],
296 'cdghijm', 312 ['ab', 'gh', 'kl', 'm'],
297 'abefklm', 313 ['cd', 'ef', 'ij', 'm'],
298 'cdefklm', 314 ['cd', 'ef', 'kl', 'm'],
299 'abghklm', 315 ['cd', 'gh', 'ij', 'm'],
300 'cdghklm', 316 ['cd', 'gh', 'kl', 'm'],
301 ]; 317 ];
302 $this->assertEquals($expected, arrays_combination($arr)); 318 $this->assertEquals($expected, iterator_to_array(cartesian_product_generator($arr)));
303 } 319 }
304 320
321 /**
322 * Test date_format() with invalid parameter.
323 */
324 public function testDateFormatInvalid()
325 {
326 $this->assertFalse(format_date([]));
327 $this->assertFalse(format_date(null));
328 }
305} 329}
diff --git a/tests/languages/bootstrap.php b/tests/languages/bootstrap.php
new file mode 100644
index 00000000..95609210
--- /dev/null
+++ b/tests/languages/bootstrap.php
@@ -0,0 +1,7 @@
1<?php
2if (! empty('UT_LOCALE')) {
3 setlocale(LC_ALL, getenv('UT_LOCALE'));
4}
5
6require_once 'vendor/autoload.php';
7
diff --git a/tests/languages/de/UtilsDeTest.php b/tests/languages/de/UtilsDeTest.php
new file mode 100644
index 00000000..8a740389
--- /dev/null
+++ b/tests/languages/de/UtilsDeTest.php
@@ -0,0 +1,25 @@
1<?php
2
3require_once 'tests/UtilsTest.php';
4
5
6class UtilsDeTest extends UtilsTest
7{
8 /**
9 * Test date_format().
10 */
11 public function testDateFormat()
12 {
13 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
14 $this->assertRegExp('/1. Januar 2017 (um )?10:11:12 GMT\+0?3(:00)?/', format_date($date, true));
15 }
16
17 /**
18 * Test date_format() using builtin PHP function strftime.
19 */
20 public function testDateFormatDefault()
21 {
22 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
23 $this->assertEquals('So 01 Jan 2017 10:11:12 EAT', format_date($date, false));
24 }
25}
diff --git a/tests/languages/en/UtilsEnTest.php b/tests/languages/en/UtilsEnTest.php
new file mode 100644
index 00000000..60bcb653
--- /dev/null
+++ b/tests/languages/en/UtilsEnTest.php
@@ -0,0 +1,25 @@
1<?php
2
3require_once 'tests/UtilsTest.php';
4
5
6class UtilsEnTest extends UtilsTest
7{
8 /**
9 * Test date_format().
10 */
11 public function testDateFormat()
12 {
13 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
14 $this->assertRegExp('/January 1, 2017 (at )?10:11:12 AM GMT\+0?3(:00)?/', format_date($date, true));
15 }
16
17 /**
18 * Test date_format() using builtin PHP function strftime.
19 */
20 public function testDateFormatDefault()
21 {
22 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
23 $this->assertEquals('Sun 01 Jan 2017 10:11:12 AM EAT', format_date($date, false));
24 }
25}
diff --git a/tests/languages/fr/UtilsFrTest.php b/tests/languages/fr/UtilsFrTest.php
new file mode 100644
index 00000000..890308d3
--- /dev/null
+++ b/tests/languages/fr/UtilsFrTest.php
@@ -0,0 +1,25 @@
1<?php
2
3require_once 'tests/UtilsTest.php';
4
5
6class UtilsFrTest extends UtilsTest
7{
8 /**
9 * Test date_format().
10 */
11 public function testDateFormat()
12 {
13 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
14 $this->assertRegExp('/1 janvier 2017 (à )?10:11:12 UTC\+0?3(:00)?/', format_date($date));
15 }
16
17 /**
18 * Test date_format() using builtin PHP function strftime.
19 */
20 public function testDateFormatDefault()
21 {
22 $date = DateTime::createFromFormat('Ymd_His', '20170101_101112');
23 $this->assertEquals('dim. 01 janv. 2017 10:11:12 EAT', format_date($date, false));
24 }
25}
diff --git a/tpl/default/linklist.html b/tpl/default/linklist.html
index a9712704..9bc3ba1a 100644
--- a/tpl/default/linklist.html
+++ b/tpl/default/linklist.html
@@ -171,10 +171,11 @@
171 <div class="linklist-item-infos-dateblock pure-u-lg-3-8 pure-u-1"> 171 <div class="linklist-item-infos-dateblock pure-u-lg-3-8 pure-u-1">
172 <a href="?{$value.shorturl}" title="{'Permalink'|t}"> 172 <a href="?{$value.shorturl}" title="{'Permalink'|t}">
173 {if="!$hide_timestamps || isLoggedIn()"} 173 {if="!$hide_timestamps || isLoggedIn()"}
174 {$updated=$value.updated_timestamp ? 'Edited: '. strftime('%c', $value.updated_timestamp) : 'Permalink'} 174 {$updated=$value.updated_timestamp ? 'Edited: '. format_date($value.updated) : 'Permalink'}
175 <span class="linkdate" title="{$updated}"> 175 <span class="linkdate" title="{$updated}">
176 <i class="fa fa-clock-o"></i> 176 <i class="fa fa-clock-o"></i>
177 {function="strftime('%c', $value.timestamp)"}{if="$value.updated_timestamp"}*{/if} 177 {$value.created|format_date}
178 {if="$value.updated_timestamp"}*{/if}
178 &middot; 179 &middot;
179 </span> 180 </span>
180 {/if} 181 {/if}
diff --git a/tpl/vintage/linklist.html b/tpl/vintage/linklist.html
index 5accc92f..fc116667 100644
--- a/tpl/vintage/linklist.html
+++ b/tpl/vintage/linklist.html
@@ -99,11 +99,11 @@
99 <br> 99 <br>
100 {if="$value.description"}<div class="linkdescription">{$value.description}</div>{/if} 100 {if="$value.description"}<div class="linkdescription">{$value.description}</div>{/if}
101 {if="!$hide_timestamps || isLoggedIn()"} 101 {if="!$hide_timestamps || isLoggedIn()"}
102 {$updated=$value.updated_timestamp ? 'Edited: '. strftime('%c', $value.updated_timestamp) : 'Permalink'} 102 {$updated=$value.updated_timestamp ? 'Edited: '. format_date($value.updated) : 'Permalink'}
103 <span class="linkdate" title="Permalink"> 103 <span class="linkdate" title="Permalink">
104 <a href="?{$value.shorturl}"> 104 <a href="?{$value.shorturl}">
105 <span title="{$updated}"> 105 <span title="{$updated}">
106 {function="strftime('%c', $value.timestamp)"} 106 {$value.created|format_date}
107 {if="$value.updated_timestamp"}*{/if} 107 {if="$value.updated_timestamp"}*{/if}
108 </span> 108 </span>
109 - permalink 109 - permalink