4 * @file src/Util/Temporal.php
7 namespace Friendica\Util;
12 use Friendica\Core\Config;
13 use Friendica\Core\L10n;
14 use Friendica\Core\PConfig;
16 require_once 'boot.php';
17 require_once 'include/text.php';
20 * @brief Temporal class
24 const ATOM = 'Y-m-d\TH:i:s\Z';
25 const MYSQL = 'Y-m-d H:i:s';
28 * @brief Two-level sort for timezones.
34 private static function timezoneCompareCallback($a, $b)
36 if (strstr($a, '/') && strstr($b, '/')) {
37 if (L10n::t($a) == L10n::t($b)) {
40 return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
43 if (strstr($a, '/')) {
45 } elseif (strstr($b, '/')) {
47 } elseif (L10n::t($a) == L10n::t($b)) {
51 return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
55 * @brief Emit a timezone selector grouped (primarily) by continent
57 * @param string $current Timezone
58 * @return string Parsed HTML output
60 public static function getTimezoneSelect($current = 'America/Los_Angeles')
62 $timezone_identifiers = DateTimeZone::listIdentifiers();
64 $o = '<select id="timezone_select" name="timezone">';
66 usort($timezone_identifiers, [self, 'timezoneCompareCallback']);
68 foreach ($timezone_identifiers as $value) {
69 $ex = explode("/", $value);
71 if ($ex[0] != $continent) {
72 if ($continent != '') {
76 $o .= '<optgroup label="' . L10n::t($continent) . '">';
79 $city = substr($value, strpos($value, '/') + 1);
85 if ($continent != L10n::t('Miscellaneous')) {
87 $continent = L10n::t('Miscellaneous');
88 $o .= '<optgroup label="' . L10n::t($continent) . '">';
91 $city = str_replace('_', ' ', L10n::t($city));
92 $selected = (($value == $current) ? " selected=\"selected\" " : "");
93 $o .= "<option value=\"$value\" $selected >$city</option>";
95 $o .= '</optgroup></select>';
100 * @brief Generating a Timezone selector
102 * Return a select using 'field_select_raw' template, with timezones
103 * grouped (primarily) by continent
104 * arguments follow convention as other field_* template array:
105 * 'name', 'label', $value, 'help'
107 * @param string $name Name of the selector
108 * @param string $label Label for the selector
109 * @param string $current Timezone
110 * @param string $help Help text
112 * @return string Parsed HTML
114 public static function getTimezoneField($name = 'timezone', $label = '', $current = 'America/Los_Angeles', $help = '')
116 $options = self::getTimezoneSelect($current);
117 $options = str_replace('<select id="timezone_select" name="timezone">', '', $options);
118 $options = str_replace('</select>', '', $options);
120 $tpl = get_markup_template('field_select_raw.tpl');
121 return replace_macros($tpl, [
122 '$field' => [$name, $label, $current, $help, $options],
127 * convert() shorthand for UTC.
129 * @param string $time A date/time string
130 * @param string $format DateTime format string or Temporal constant
133 public static function utc($time, $format = self::MYSQL)
135 return self::convert($time, 'UTC', 'UTC', $format);
139 * convert() shorthand for local.
141 * @param string $time A date/time string
142 * @param string $format DateTime format string or Temporal constant
145 public static function local($time, $format = self::MYSQL)
147 return self::convert($time, date_default_timezone_get(), 'UTC', $format);
151 * convert() shorthand for timezoned now.
153 * @param string $format DateTime format string or Temporal constant
156 public static function timezoneNow($timezone, $format = self::MYSQL)
158 return self::convert('now', $timezone, 'UTC', $format);
162 * convert() shorthand for local now.
164 * @param string $format DateTime format string or Temporal constant
167 public static function localNow($format = self::MYSQL)
169 return self::local('now', $format);
173 * convert() shorthand for UTC now.
175 * @param string $format DateTime format string or Temporal constant
178 public static function utcNow($format = self::MYSQL)
180 return self::utc('now', $format);
184 * @brief General purpose date parse/convert/format function.
186 * @param string $s Some parseable date/time string
187 * @param string $tz_to Destination timezone
188 * @param string $tz_from Source timezone
189 * @param string $format Output format recognised from php's DateTime class
190 * http://www.php.net/manual/en/datetime.format.php
192 * @return string Formatted date according to given format
194 public static function convert($s = 'now', $tz_to = 'UTC', $tz_from = 'UTC', $format = self::MYSQL)
196 // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
197 // Provide some sane defaults regardless.
206 if (($s === '') || (!is_string($s))) {
211 * Slight hackish adjustment so that 'zero' datetime actually returns what is intended
212 * otherwise we end up with -0001-11-30 ...
213 * add 32 days so that we at least get year 00, and then hack around the fact that
214 * months and days always start with 1.
216 if (substr($s, 0, 10) <= '0001-01-01') {
217 $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
218 return str_replace('1', '0', $d->format($format));
222 $from_obj = new DateTimeZone($tz_from);
223 } catch (Exception $e) {
224 $from_obj = new DateTimeZone('UTC');
228 $d = new DateTime($s, $from_obj);
229 } catch (Exception $e) {
230 logger('datetime_convert: exception: ' . $e->getMessage());
231 $d = new DateTime('now', $from_obj);
235 $to_obj = new DateTimeZone($tz_to);
236 } catch (Exception $e) {
237 $to_obj = new DateTimeZone('UTC');
240 $d->setTimeZone($to_obj);
242 return $d->format($format);
246 * @brief Wrapper for date selector, tailored for use in birthday fields.
248 * @param string $dob Date of Birth
249 * @return string Formatted HTML
251 public static function getDateofBirthField($dob)
253 list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d');
255 if ($dob < '0000-01-01') {
258 $value = self::utc(($year > 1000) ? $dob : '1000-' . $month . '-' . $day, 'Y-m-d');
261 $age = (intval($value) ? age($value, $a->user["timezone"], $a->user["timezone"]) : "");
263 $tpl = get_markup_template("field_input.tpl");
264 $o = replace_macros($tpl,
268 L10n::t('Birthday:'),
270 intval($age) > 0 ? L10n::t('Age: ') . $age : "",
272 'placeholder="' . L10n::t('YYYY-MM-DD or MM-DD') . '"'
280 * @brief Returns a date selector
282 * @param string $min Unix timestamp of minimum date
283 * @param string $max Unix timestap of maximum date
284 * @param string $default Unix timestamp of default date
285 * @param string $id ID and name of datetimepicker (defaults to "datetimepicker")
287 * @return string Parsed HTML output.
289 public static function getDateField($min, $max, $default, $id = 'datepicker')
291 return datetimesel($min, $max, $default, '', $id, true, false, '', '');
295 * @brief Returns a time selector
297 * @param string $h Already selected hour
298 * @param string $m Already selected minute
299 * @param string $id ID and name of datetimepicker (defaults to "timepicker")
301 * @return string Parsed HTML output.
303 public static function getTimeField($h, $m, $id = 'timepicker')
305 return datetimesel(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
309 * @brief Returns a datetime selector.
311 * @param string $min Unix timestamp of minimum date
312 * @param string $max Unix timestamp of maximum date
313 * @param string $default Unix timestamp of default date
314 * @param string $id Id and name of datetimepicker (defaults to "datetimepicker")
315 * @param bool $pickdate true to show date picker (default)
316 * @param bool $picktime true to show time picker (default)
317 * @param string $minfrom set minimum date from picker with id $minfrom (none by default)
318 * @param string $maxfrom set maximum date from picker with id $maxfrom (none by default)
319 * @param bool $required default false
321 * @return string Parsed HTML output.
323 * @todo Once browser support is better this could probably be replaced with
324 * native HTML5 date picker.
326 public static function getDateTimeField($min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true,
327 $picktime = true, $minfrom = '', $maxfrom = '', $required = false)
329 // First day of the week (0 = Sunday)
330 $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
332 $lang = substr(L10n::getBrowserLanguage(), 0, 2);
334 // Check if the detected language is supported by the picker
336 ["ar", "ro", "id", "bg", "fa", "ru", "uk", "en", "el", "de", "nl", "tr", "fr", "es", "th", "pl", "pt", "ch", "se", "kr",
337 "it", "da", "no", "ja", "vi", "sl", "cs", "hu"])) {
338 $lang = Config::get('system', 'language', 'en');
345 $dateformat .= 'Y-m-d';
348 if ($pickdate && $picktime) {
353 $dateformat .= 'H:i';
356 $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : '';
357 $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : '';
359 $input_text = $default ? date($dateformat, $default->getTimestamp()) : '';
360 $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : '';
364 $pickers .= ', datepicker: false';
368 $pickers .= ',timepicker: false';
372 $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'";
373 if ($minfrom != '') {
374 $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})";
377 if ($maxfrom != '') {
378 $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})";
381 $readable_format = $dateformat;
382 $readable_format = str_replace('Y', 'yyyy', $readable_format);
383 $readable_format = str_replace('m', 'mm', $readable_format);
384 $readable_format = str_replace('d', 'dd', $readable_format);
385 $readable_format = str_replace('H', 'HH', $readable_format);
386 $readable_format = str_replace('i', 'MM', $readable_format);
388 $tpl = get_markup_template('field_input.tpl');
389 $o .= replace_macros($tpl,
396 $required ? '*' : '',
397 'placeholder="' . $readable_format . '"'
401 $o .= "<script type='text/javascript'>";
402 $o .= "\$(function () {var picker = \$('#id_$id').datetimepicker({step:5,format:'$dateformat' $minjs $maxjs $pickers $defaultdatejs}); $extra_js})";
409 * @brief Returns a relative date string.
411 * Implements "3 seconds ago" etc.
412 * Based on $posted_date, (UTC).
413 * Results relative to current timezone.
414 * Limited to range of timestamps.
416 * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
417 * @param string $format (optional) Parsed with sprintf()
418 * <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
420 * @return string with relative date
422 public static function getRelativeDate($posted_date, $format = null)
424 $localtime = $posted_date . ' UTC';
426 $abs = strtotime($localtime);
428 if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === false) {
429 return L10n::t('never');
432 $etime = time() - $abs;
435 return L10n::t('less than a second ago');
438 $a = [12 * 30 * 24 * 60 * 60 => [L10n::t('year'), L10n::t('years')],
439 30 * 24 * 60 * 60 => [L10n::t('month'), L10n::t('months')],
440 7 * 24 * 60 * 60 => [L10n::t('week'), L10n::t('weeks')],
441 24 * 60 * 60 => [L10n::t('day'), L10n::t('days')],
442 60 * 60 => [L10n::t('hour'), L10n::t('hours')],
443 60 => [L10n::t('minute'), L10n::t('minutes')],
444 1 => [L10n::t('second'), L10n::t('seconds')]
447 foreach ($a as $secs => $str) {
451 // translators - e.g. 22 hours ago, 1 minute ago
453 $format = L10n::t('%1$d %2$s ago');
456 return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
462 * @brief Returns timezone correct age in years.
464 * Returns the age in years, given a date of birth, the timezone of the person
465 * whose date of birth is provided, and the timezone of the person viewing the
468 * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
469 * is on New Year's. You live in San Bruno, California.
470 * When exactly are you going to see my age increase?
472 * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
473 * and become a year older. If you wish me happy birthday on January 1
474 * (San Bruno time), you'll be a day late.
476 * @param string $dob Date of Birth
477 * @param string $owner_tz (optional) Timezone of the person of interest
478 * @param string $viewer_tz (optional) Timezone of the person viewing
480 * @return int Age in years
482 public static function getAgeByTimezone($dob, $owner_tz = '', $viewer_tz = '')
488 $owner_tz = date_default_timezone_get();
491 $viewer_tz = date_default_timezone_get();
494 $birthdate = self::convert($dob . ' 00:00:00+00:00', $owner_tz, 'UTC', 'Y-m-d');
495 list($year, $month, $day) = explode("-", $birthdate);
496 $year_diff = self::timezoneNow($viewer_tz, 'Y') - $year;
497 $curr_month = self::timezoneNow($viewer_tz, 'm');
498 $curr_day = self::timezoneNow($viewer_tz, 'd');
500 if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
508 * @brief Get days of a month in a given year.
510 * Returns number of days in the month of the given year.
511 * $m = 1 is 'January' to match human usage.
514 * @param int $m Month (1=January, 12=December)
516 * @return int Number of days in the given month
518 public static function getDaysInMonth($y, $m)
520 return date('t', mktime(0, 0, 0, $m, 1, $y));
525 * @brief Returns the first day in month for a given month, year.
530 * @param int $m Month (1=January, 12=December)
532 * @return string day 0 = Sunday through 6 = Saturday
534 public static function getFirstDayInMonth($y, $m)
536 $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
538 return self::utc($d, 'w');
542 * @brief Output a calendar for the given month, year.
544 * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
545 * date 12 will be linked appropriately. Today's date is also noted by
547 * Months count from 1.
550 * @param int $m Month
551 * @param array $links (default null)
552 * @param string $class
556 * @todo Provide (prev, next) links, define class variations for different size calendars
558 public static function getCalendarTable($y = 0, $m = 0, $links = null, $class = '')
560 // month table - start at 1 to match human usage.
562 'January', 'February', 'March',
563 'April', 'May', 'June',
564 'July', 'August', 'September',
565 'October', 'November', 'December'
568 $thisyear = self::localNow('Y');
569 $thismonth = self::localNow('m');
575 $m = intval($thismonth);
578 $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
579 $f = get_first_dim($y, $m);
580 $l = get_dim($y, $m);
585 if (($y == $thisyear) && ($m == $thismonth)) {
586 $tddate = intval(self::localNow('j'));
589 $str_month = day_translate($mtab[$m]);
590 $o = '<table class="calendar' . $class . '">';
591 $o .= "<caption>$str_month $y</caption><tr>";
592 for ($a = 0; $a < 7; $a ++) {
593 $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
599 if (($dow == $f) && (!$started)) {
603 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
605 $day = str_replace(' ', ' ', sprintf('%2.2d', $d));
607 if (x($links, $d) !== false) {
608 $o .= "<a href=\"{$links[$d]}\">$day</a>";
620 if (($dow == 7) && ($d <= $l)) {
627 for ($a = $dow; $a < 7; $a ++) {
628 $o .= '<td> </td>';
632 $o .= '</tr></table>' . "\r\n";