Straightening out the language string situation in the JS calendar (bug 1455137)

The main thing this fixes, is that it causes the JS calendar to use ONLY the
new lang strings pieform_calendar_dateformat & pieform_calendar_timeformat,
for its formatting. These strings are in strftime() format, and are converted
into the JQuery Datepicker/Timepicker format by PHP (if we change to a different
calendar plugin in the future, we can change the PHP conversion function).

This fixes the bug where translators could break the calendar by changing the
JS format strings so they no longer matched the PHP format strings.

As a side effect of this change, I've also made it so that the help strings
are derived from the format string, and are translatable.

behatnotneeded: Date field is already tested by resume_page.feature

Change-Id: I152962cc27f36f93b51ee0327ed942fb089f7f5b

htdocs/admin/users/search.php

@@ -65,7 +65,6 @@ $calendar = array(
     'defaultvalue' => strtotime($search->loggedindate),
     'caloptions'   => array(
         'showsTime'      => true,
-        'ifFormat'       => get_string('strftimedatetimeshort'),
     ),
 );
 $calendarform = new Pieform(array(

htdocs/artefact/plans/lib.php

@@ -467,6 +467,7 @@ class ArtefactTypeTask extends ArtefactType {
     *
     */
     public static function get_taskform_elements($parent, $task=null) {
+        require_once('pieforms/pieform/elements/calendar.php');
         $elements = array(
             'title' => array(
                 'type' => 'text',
@@ -482,12 +483,10 @@ class ArtefactTypeTask extends ArtefactType {
                 'type'       => 'calendar',
                 'caloptions' => array(
                     'showsTime'      => false,
-                    'ifFormat'       => '%Y/%m/%d',
-                    'dateFormat'     => 'yy/mm/dd',
                 ),
                 'defaultvalue' => null,
                 'title' => get_string('completiondate', 'artefact.plans'),
-                'description' => get_string('dateformatguide'),
+                'description' => get_string('dateformatguide1', 'mahara', pieform_element_calendar_human_readable_dateformat()),
                 'rules' => array(
                     'required' => true,
                 ),

htdocs/artefact/resume/index.php

@@ -19,6 +19,7 @@ define('RESUME_SUBPAGE', 'index');
 require_once(dirname(dirname(dirname(__FILE__))) . '/init.php');
 define('TITLE', get_string('resume', 'artefact.resume'));
 require_once('pieforms/pieform.php');
+require_once('pieforms/pieform/elements/calendar.php');
 safe_require('artefact', 'resume');
 
 if (!PluginArtefactResume::is_active()) {
@@ -57,16 +58,14 @@ $personalinformationform = pieform(array(
                     'type'       => 'calendar',
                     'caloptions' => array(
                         'showsTime'      => false,
-                        'ifFormat'       => '%Y/%m/%d',
-                        'dateFormat'     => 'yy/mm/dd',
-                        ),
+                    ),
                     'defaultvalue' => (
                             (!empty($personalinformation) && null !== $personalinformation->get_composite('dateofbirth'))
                             ? $personalinformation->get_composite('dateofbirth')+3600
                             : null
                     ),
                     'title' => get_string('dateofbirth', 'artefact.resume'),
-                    'description' => get_string('dateofbirthformatguide'),
+                    'description' => get_string('dateofbirthformatguide1', 'mahara', pieform_element_calendar_human_readable_dateformat()),
                 ),
                 'placeofbirth' => array(
                     'type' => 'text',

htdocs/lang/en.utf8/langconfig.php

@@ -12,8 +12,8 @@
 defined('INTERNAL') || die();
 
 $string['parentlanguage'] = '';
-$string['calendar_dateFormat'] = 'yy/mm/dd';
-$string['calendar_timeFormat'] = 'HH:mm';
+$string['pieform_calendar_dateformat'] = '%%Y/%%m/%%d';
+$string['pieform_calendar_timeformat'] = '%%H:%%M';
 $string['strftimedate'] = '%%e %%B %%Y';
 $string['strftimedateshort'] = '%%d %%B';
 $string['strftimedatetime'] = '%%d %%B %%Y, %%l:%%M %%p';

htdocs/lang/en.utf8/mahara.php

@@ -164,9 +164,9 @@ $string['lastjoined'] = 'Last joined';
 $string['date'] = 'Date';
 $string['earliest'] = 'Earliest';
 $string['latest'] = 'Latest';
-$string['dateformatguide'] = 'Use the format YYYY/MM/DD';
-$string['dateofbirthformatguide'] = 'Use the format YYYY/MM/DD';
-$string['datetimeformatguide'] = 'Use the format YYYY/MM/DD HH:MM';
+$string['dateformatguide1'] = 'Use the format %s';
+$string['dateofbirthformatguide1'] = 'Use the format %s';
+$string['datetimeformatguide1'] = 'Use the format %s';
 $string['filterresultsby'] = 'Filter results by:';
 $string['tagfilter_all'] = 'All';
 $string['tagfilter_file'] = 'Files';

htdocs/lang/en.utf8/pieforms.php

@@ -19,6 +19,20 @@ $string['element.bytes.invalidvalue'] = 'Value must be a number';
 
 $string['element.calendar.invalidvalue'] = 'Invalid date/time specified';
 $string['element.calendar.opendatepicker'] = 'Open date picker';
+$string['element.calendar.format.help.dayofmonth1digit'] = 'D';
+$string['element.calendar.format.help.dayofmonth2digits'] = 'DD';
+$string['element.calendar.format.help.month2digit'] = 'MM';
+$string['element.calendar.format.help.year2digit'] = 'YY';
+$string['element.calendar.format.help.year4digit'] = 'YYYY';
+$string['element.calendar.format.help.24hour1digit'] = 'H';
+$string['element.calendar.format.help.24hour2digits'] = 'HH';
+$string['element.calendar.format.help.12hour1digit'] = 'H';
+$string['element.calendar.format.help.12hour2digits'] = 'HH';
+$string['element.calendar.format.help.minute2digits'] = 'MM';
+$string['element.calendar.format.help.second2digits'] = 'SS';
+$string['element.calendar.format.help.ampmlowercase'] = 'am';
+$string['element.calendar.format.help.ampmuppercase'] = 'AM';
+
 
 $string['element.date.monthnames'] = 'January,February,March,April,May,June,July,August,September,October,November,December';
 $string['element.date.specify'] = 'Set date';

htdocs/lib/form/elements/viewacl.php

@@ -67,8 +67,20 @@ function pieform_element_viewacl(Pieform $form, $element) {
                 if ($strlen($item['name']) > 30) {
                     $item['shortname'] = str_shorten_text($item['name'], 30, true);
                 }
+
+                $datetimeformat = get_string('pieform_calendar_dateformat', 'langconfig') . ' ' . get_string('pieform_calendar_timeformat', 'langconfig');
+                $rawstopdate = (array_key_exists('stopdate', $item) ? $item['stopdate'] : null);
+                foreach (array('startdate', 'stopdate') as $datetype) {
+                    if (empty($item[$datetype])) {
+                        unset($item[$datetype]);
+                    }
+                    else {
+                        $item[$datetype] = Pieform::hsc(strftime($datetimeformat, $item[$datetype]));
+                    }
+                }
+
                 // only show access that is still current. Expired access will be deleted if the form is saved
-                if ($form->is_submitted() || empty($item['stopdate']) || (time() <= strtotime($item['stopdate']))) {
+                if ($form->is_submitted() || !$rawstopdate || (time() <= $rawstopdate)) {
                     $accesslist[] = $item;
                 }
                 if (!empty($item['locked'])) {
@@ -162,9 +174,7 @@ function pieform_element_viewacl(Pieform $form, $element) {
         $faves[] = $fave;
     }
     require_once(get_config('libroot') . 'pieforms/pieform/elements/calendar.php');
-    $options = array('dateFormat' => get_string('calendar_dateFormat', 'langconfig'),
-                     'timeFormat' => get_string('calendar_timeFormat', 'langconfig'),
-                     'stepHour' => 1,
+    $options = array('stepHour' => 1,
                      'stepMinute' => 5,
                      );
     $options = pieform_element_calendar_get_lang_strings($options, $LANGDIRECTION);
@@ -237,5 +247,16 @@ function pieform_element_viewacl_get_value(Pieform $form, $element) {
     else if (isset($element['defaultvalue'])) {
         $values = $element['defaultvalue'];
     }
+    // Convert dates to epochs
+    if ($form->is_submitted() && $values) {
+        foreach ($values as &$value) {
+            if (!empty($value['startdate'])) {
+                $value['startdate'] = pieform_element_calendar_convert_to_epoch($value['startdate']);
+            }
+            if (!empty($value['stopdate'])) {
+                $value['stopdate'] = pieform_element_calendar_convert_to_epoch($value['stopdate']);
+            }
+        }
+    }
     return $values;
 }

htdocs/lib/pieforms/pieform/elements/calendar.php

@@ -40,21 +40,24 @@ function pieform_element_calendar(Pieform $form, $element) {
     global $LANGDIRECTION;
 
     $id = $form->get_name() . '_' . $element['name'];
-    $value = $form->get_value($element);
-    if ($value) {
-        $value = Pieform::hsc(strftime($element['caloptions']['ifFormat'], $value));
-    }
 
     // Build the configuring javascript
     $options = array_merge($element['caloptions'], array('inputField' => $id));
-    if (empty($options['dateFormat'])) {
-        $options['dateFormat'] = get_string('calendar_dateFormat', 'langconfig');
-    }
-    // Set up default timeFormat if needed
-    if (!empty($options['showsTime']) && empty($options['timeFormat'])) {
-        $options['timeFormat'] = get_string('calendar_timeFormat', 'langconfig');
-    }
+    $options['dateFormat'] = pieform_element_calendar_convert_dateformat(get_string('pieform_calendar_dateformat', 'langconfig'));
+    $options['timeFormat'] = pieform_element_calendar_convert_timeformat(get_string('pieform_calendar_timeformat', 'langconfig'));
     $options = pieform_element_calendar_get_lang_strings($options, $LANGDIRECTION);
+
+    $value = $form->get_value($element);
+    if ($value) {
+        if (!empty($options['showsTime'])) {
+                    $format = get_string('pieform_calendar_dateformat', 'langconfig');
+        }
+        else {
+            $format = get_string('pieform_calendar_dateformat', 'langconfig') . ' ' . get_string('pieform_calendar_timeformat', 'langconfig');
+        }
+        $value = Pieform::hsc(strftime($format, $value));
+    }
+
     // Build the HTML
     $result = '<input type="text"'
         . $form->element_attributes($element)
@@ -114,6 +117,139 @@ function pieform_element_calendar(Pieform $form, $element) {
     return $result;
 }
 
+/**
+ * Returns a (hopefully) human-readable version of the date format. To be used in help strings.
+ * @return string
+ */
+function pieform_element_calendar_human_readable_dateformat() {
+    static $formatstring = null;
+    if ($formatstring) {
+        return $formatstring;
+    }
+
+    $replacements = array(
+        '%e' => get_string('element.calendar.format.help.dayofmonth1digit', 'pieforms'),
+        '%d' => get_string('element.calendar.format.help.dayofmonth2digits', 'pieforms'),
+        '%m' => get_string('element.calendar.format.help.month2digit', 'pieforms'),
+        '%y' => get_string('element.calendar.format.help.year2digit', 'pieforms'),
+        '%Y' => get_string('element.calendar.format.help.year4digit', 'pieforms'),
+    );
+
+    $formatstring = str_replace(
+        array_keys($replacements),
+        array_values($replacements),
+        get_string('pieform_calendar_dateformat', 'langconfig')
+    );
+
+    return $formatstring;
+}
+
+/**
+ * Returns a (hopefully) human-readable version of the time format. To be used in help strings.
+ * @return string
+ */
+function pieform_element_calendar_human_readable_timeformat() {
+    static $formatstring = null;
+    if ($formatstring) {
+        return $formatstring;
+    }
+
+    $replacements = array(
+        '%k' => get_string('element.calendar.format.help.24hour1digit', 'pieforms'),
+        '%H' => get_string('element.calendar.format.help.24hour2digits', 'pieforms'),
+        '%l' => get_string('element.calendar.format.help.12hour1digit', 'pieforms'),
+        '%I' => get_string('element.calendar.format.help.12hour2digits', 'pieforms'),
+        '%M' => get_string('element.calendar.format.help.minute2digits', 'pieforms'),
+        '%S' => get_string('element.calendar.format.help.second2digits', 'pieforms'),
+        '%P' => get_string('element.calendar.format.help.ampmlowercase', 'pieforms'),
+        '%p' => get_string('element.calendar.format.help.ampmuppercase', 'pieforms'),
+    );
+
+    $formatstring = str_replace(
+        array_keys($replacements),
+        array_values($replacements),
+        get_string('pieform_calendar_timeformat', 'langconfig')
+    );
+
+    return $formatstring;
+}
+
+/**
+ * Returns a (hopefully) human-readable version of the date & time format. To be used in help strings.
+ * @return string
+ */
+function pieform_element_calendar_human_readable_datetimeformat() {
+    return pieform_element_calendar_human_readable_dateformat() . ' ' . pieform_element_calendar_human_readable_timeformat();
+}
+
+/**
+ * Converts a date format string from PHP strftime format to
+ * JQuery UI calendar format. (Only covers basic formatting options shared
+ * in common between the two formats.)
+ *
+ * strftime: http://php.net/strftime
+ * JQuery UI calendar: http://api.jqueryui.com/datepicker/#utility-formatDate
+ *
+ * @param string $format A date format in PHP strftime format
+ * @return string The equivalent format in JQuery UI calendar format
+ */
+function pieform_element_calendar_convert_dateformat($format) {
+    // We typically use doubled percentage marks in our lang strings because
+    // they get passed through printf.
+    $format = str_replace('%%', '%', $format);
+
+    $replacements = array(
+            '%e' => 'd',  // day of month (no leading zero)
+            '%d' => 'dd', // day of month (two digit)
+            '%m' => 'mm', // month of year (two digit)
+            '%y' => 'y',  // year (two digit)
+            '%Y' => 'yy', // year (four digit)
+            // strtotime only works in English. So no non-digit formats
+//             '%a' => 'D',  // day name short (Mon - Sun)
+//             '%A' => 'DD', // day name long (Monday - Sunday)
+//             '%b' => 'M',  // month name short (Jan - Dec)
+//             '%B' => 'MM', // month name long (January - December)
+    );
+    return str_replace(
+            array_keys($replacements),
+            array_values($replacements),
+            $format
+    );
+}
+
+/**
+ * Converts a time format string from PHP strftime format to
+ * JQuery UI timepicker format. (Only covers basic formatting options shared
+ * in common between the two formats.)
+ *
+ * strftime: http://php.net/strftime
+ * JQuery UI timepicker: http://trentrichardson.com/examples/timepicker/
+ *
+ * @param string $format A time format in PHP strftime format
+ * @return string The equivalent format in JQuery UI timepicker format
+ */
+function pieform_element_calendar_convert_timeformat($format) {
+    // We typically use doubled percentage marks in our lang strings because
+    // they get passed through printf.
+    $format = str_replace('%%', '%', $format);
+
+    $replacements = array(
+            '%k' => "H", // Hour (24-hour, no leading 0)
+            '%H' => 'HH', // Hour (24-hour, 2 digits)
+            '%l' => "h", // Hour (12-hour, no leading 0)
+            '%I' => 'hh', // Hour (12-hour, 2 digits)
+            '%M' => 'mm', // Minute (2 digits)
+            '%S' => 'ss', // Second (2 digits)
+            '%P' => 'tt', // am or pm for AM/PM
+            '%p' => 'TT', // AM or PM for AM/PM
+    );
+    return str_replace(
+            array_keys($replacements),
+            array_values($replacements),
+            $format
+    );
+}
+
 /**
  * Sets default attributes of the calendar element.
  *
@@ -124,10 +260,7 @@ function pieform_element_calendar_set_attributes($element) {
     global $THEME;
     $element['jsroot']   = get_config('wwwroot') . 'js/jquery/jquery-ui/';
     $element['language'] = substr(current_language(), 0, 2);
-    $element['caloptions']['ifFormat'] = isset($element['caloptions']['ifFormat']) ? $element['caloptions']['ifFormat'] : '%Y/%m/%d';
-    $element['caloptions']['dateFormat'] = isset($element['caloptions']['dateFormat']) ? $element['caloptions']['dateFormat'] : get_string('calendar_dateFormat', 'langconfig');
-    $element['caloptions']['timeFormat'] = isset($element['caloptions']['timeFormat']) ? $element['caloptions']['timeFormat'] : get_string('calendar_timeFormat', 'langconfig');
-
+    $element['caloptions']['showsTime'] = true;
     return $element;
 }
 
@@ -196,8 +329,7 @@ function pieform_element_calendar_get_value(Pieform $form, $element) {
             return null;
         }
 
-        $value = strtotime($global[$name]);
-
+        $value = pieform_element_calendar_convert_to_epoch($global[$name]);
         if ($value === false) {
             $form->set_error($name, $form->i18n('element', 'calendar', 'invalidvalue', $element));
             return null;
@@ -212,6 +344,37 @@ function pieform_element_calendar_get_value(Pieform $form, $element) {
     return null;
 }
 
+/**
+ * Convert the user-submitted string from the calendar input, into a Unix epoch.
+ * If it can't do the conversion, it returns boolean false.
+ *
+ * @param string $date
+ * @return integer|false
+ */
+function pieform_element_calendar_convert_to_epoch($date) {
+    $value = false;
+
+    // If they're using a "dmy" format, replace the separators with dots to tell strtotime() it's not mdy.
+    // (See http://php.net/manual/en/function.strtotime.php#refsect1-function.strtotime-notes)
+    $dateformat = get_string('pieform_calendar_dateformat', 'langconfig');
+    if (preg_match('/%[ed].*%[m].*%[yY]/', $dateformat)) {
+        $value = strtotime(preg_replace('/[^0-9]/', '.', $date));
+    }
+
+    // If that didn't work, then just try doing strtotime on the plain value
+    if ($value === false) {
+        $value = strtotime($date);
+    }
+
+    // And if that still didn't work, then maybe langconfig has an mdy format, but the user entered
+    // a dmy format. So try it one more time, replacing the separators with dots.
+    if ($value === false) {
+        $value = strtotime(preg_replace('/[^0-9]/', '.', $date));
+    }
+
+    return $value;
+}
+
 /**
  * Retrieves the values of the internationalised strings for a calendar
  * The $form is not passed in so that we can fetch this array from outside a pieform

htdocs/theme/raw/templates/form/viewacl.tpl

@@ -119,7 +119,7 @@ jQuery(function($) {
 
         function setDatePicker(target) {
             target.datetimepicker({
-                dateFormat: 'yy/mm/dd',
+                dateFormat: "{{str(tag='pieform_calendar_dateformat' section='langconfig')|pieform_element_calendar_convert_dateformat}}",
                 showOtherMonths: true,
                 selectOtherMonths: true,
                 showButtonPanel: true,

htdocs/view/access.php

@@ -187,7 +187,7 @@ $form['elements']['more'] = array(
 $form['elements']['accesslist'] = array(
     'type'          => 'viewacl',
     'allowcomments' => $allowcomments,
-    'defaultvalue'  => $view->get_access(get_string('strftimedatetimeshort')),
+    'defaultvalue'  => $view->get_access('%s'),
     'viewtype'      => $view->get('type'),
     'isformgroup' => false
 );
@@ -293,21 +293,19 @@ $form['elements']['more']['elements']['overrides'] = array(
 $form['elements']['more']['elements']['startdate'] = array(
     'type'         => 'calendar',
     'title'        => get_string('startdate','view'),
-    'description'  => get_string('datetimeformatguide'),
+    'description'  => get_string('datetimeformatguide1', 'mahara', pieform_element_calendar_human_readable_datetimeformat()),
     'defaultvalue' => isset($view) ? strtotime($view->get('startdate')) : null,
     'caloptions'   => array(
         'showsTime'      => true,
-        'ifFormat'       => get_string('strftimedatetimeshort'),
     ),
 );
 $form['elements']['more']['elements']['stopdate'] = array(
     'type'         => 'calendar',
     'title'        => get_string('stopdate','view'),
-    'description'  => get_string('datetimeformatguide'),
+    'description'  => get_string('datetimeformatguide1', 'mahara', pieform_element_calendar_human_readable_datetimeformat()),
     'defaultvalue' => isset($view) ? strtotime($view->get('stopdate')) : null,
     'caloptions'   => array(
         'showsTime'      => true,
-        'ifFormat'       => get_string('strftimedatetimeshort'),
     ),
 );
 
@@ -393,32 +391,30 @@ function editaccess_validate(Pieform $form, $values) {
     if ($values['accesslist']) {
         $dateformat = get_string('strftimedatetimeshort');
         foreach ($values['accesslist'] as &$item) {
-            if (empty($item['startdate'])) {
-                $item['startdate'] = null;
-            }
-            else if (!$item['startdate'] = strptime($item['startdate'], $dateformat)) {
-                $SESSION->add_error_msg(get_string('datetimeformatguide'));
+
+            if (isset($item['startdate']) && $item['startdate'] === false) {
+                $SESSION->add_error_msg(get_string('datetimeformatguide1', 'mahara', pieform_element_calendar_human_readable_dateformat()));
                 $form->set_error('accesslist', '');
                 break;
             }
-            if (empty($item['stopdate'])) {
-                $item['stopdate'] = null;
-            }
-            else if (!$item['stopdate'] = strptime($item['stopdate'], $dateformat)) {
-                $SESSION->add_error_msg(get_string('datetimeformatguide'));
+
+            if (isset($item['stopdate']) && $item['stopdate'] === false) {
+                $SESSION->add_error_msg(get_string('datetimeformatguide1', 'mahara', pieform_element_calendar_human_readable_dateformat()));
                 $form->set_error('accesslist', '');
                 break;
             }
+
             if ($item['type'] == 'loggedin' && !$item['startdate'] && !$item['stopdate']) {
                 $loggedinaccess = true;
             }
-            $now = strptime(date('Y/m/d H:i'), $dateformat);
-            if ($item['stopdate'] && ptimetotime($now) > ptimetotime($item['stopdate'])) {
+
+            $now = time();
+            if ($item['stopdate'] && $now > $item['stopdate']) {
                 $SESSION->add_error_msg(get_string('newstopdatecannotbeinpast', 'view', $accesstypestrings[$item['type']]));
                 $form->set_error('accesslist', '');
                 break;
             }
-            if ($item['startdate'] && $item['stopdate'] && ptimetotime($item['startdate']) > ptimetotime($item['stopdate'])) {
+            if ($item['startdate'] && $item['stopdate'] && $item['startdate'] > $item['stopdate']) {
                 $SESSION->add_error_msg(get_string('newstartdatemustbebeforestopdate', 'view', $accesstypestrings[$item['type']]));
                 $form->set_error('accesslist', '');
                 break;
@@ -459,15 +455,6 @@ function editaccess_submit(Pieform $form, $values) {
                 unset($values['accesslist'][$i]);
             }
         }
-
-        foreach ($values['accesslist'] as &$item) {
-            if (!empty($item['startdate'])) {
-                $item['startdate'] = ptimetotime(strptime($item['startdate'], $dateformat));
-            }
-            if (!empty($item['stopdate'])) {
-                $item['stopdate'] = ptimetotime(strptime($item['stopdate'], $dateformat));
-            }
-        }
     }
 
     $viewconfig = array(
@@ -563,7 +550,7 @@ $smarty = smarty(
     array(),
     array(),
     array(
-        'mahara' => array('From', 'To', 'datetimeformatguide'),
+        'mahara' => array('From', 'To'),
         'view' => array('startdate', 'stopdate', 'addaccess', 'addaccessinstitution', 'addaccessgroup'),
         'artefact.comment' => array('Comments', 'Allow', 'Moderate')
     ),

htdocs/view/urls.php

@@ -85,7 +85,6 @@ for ($i = 0; $i < count($records); $i++) {
             'defaultvalue' => !empty($r->startdate) ? strtotime($r->startdate) : null,
             'caloptions'   => array(
                 'showsTime'      => true,
-                'ifFormat'       => get_string('strftimedatetimeshort'),
             ),
         ),
         'stopdate'  => array(
@@ -95,7 +94,6 @@ for ($i = 0; $i < count($records); $i++) {
             'defaultvalue' => !empty($r->stopdate) ? strtotime($r->stopdate) : null,
             'caloptions'   => array(
                 'showsTime'      => true,
-                'ifFormat'       => get_string('strftimedatetimeshort'),
             ),
         ),
     );