src/Util/Temporal.php

   1 <?php
   2
   3 /**
   4  * @file src/Util/Temporal.php
   5  */
   6
   7 namespace Friendica\Util;
   8
   9 use DateTime;
  10 use DateTimeZone;
  11 use Friendica\Core\Config;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\PConfig;
  14
  15 require_once 'boot.php';
  16 require_once 'include/text.php';
  17
  18 /**
  19  * @brief Temporal class
  20  */
  21 class Temporal
  22 {
  23         /**
  24          * @brief Two-level sort for timezones.
  25          *
  26          * @param string $a
  27          * @param string $b
  28          * @return int
  29          */
  30         private static function timezoneCompareCallback($a, $b)
  31         {
  32                 if (strstr($a, '/') && strstr($b, '/')) {
  33                         if (L10n::t($a) == L10n::t($b)) {
  34                                 return 0;
  35                         }
  36                         return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
  37                 }
  38
  39                 if (strstr($a, '/')) {
  40                         return -1;
  41                 } elseif (strstr($b, '/')) {
  42                         return 1;
  43                 } elseif (L10n::t($a) == L10n::t($b)) {
  44                         return 0;
  45                 }
  46
  47                 return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
  48         }
  49
  50         /**
  51          * @brief Emit a timezone selector grouped (primarily) by continent
  52          *
  53          * @param string $current Timezone
  54          * @return string Parsed HTML output
  55          */
  56         public static function getTimezoneSelect($current = 'America/Los_Angeles')
  57         {
  58                 $timezone_identifiers = DateTimeZone::listIdentifiers();
  59
  60                 $o = '<select id="timezone_select" name="timezone">';
  61
  62                 usort($timezone_identifiers, [self, 'timezoneCompareCallback']);
  63                 $continent = '';
  64                 foreach ($timezone_identifiers as $value) {
  65                         $ex = explode("/", $value);
  66                         if (count($ex) > 1) {
  67                                 if ($ex[0] != $continent) {
  68                                         if ($continent != '') {
  69                                                 $o .= '</optgroup>';
  70                                         }
  71                                         $continent = $ex[0];
  72                                         $o .= '<optgroup label="' . L10n::t($continent) . '">';
  73                                 }
  74                                 if (count($ex) > 2) {
  75                                         $city = substr($value, strpos($value, '/') + 1);
  76                                 } else {
  77                                         $city = $ex[1];
  78                                 }
  79                         } else {
  80                                 $city = $ex[0];
  81                                 if ($continent != L10n::t('Miscellaneous')) {
  82                                         $o .= '</optgroup>';
  83                                         $continent = L10n::t('Miscellaneous');
  84                                         $o .= '<optgroup label="' . L10n::t($continent) . '">';
  85                                 }
  86                         }
  87                         $city = str_replace('_', ' ', L10n::t($city));
  88                         $selected = (($value == $current) ? " selected=\"selected\" " : "");
  89                         $o .= "<option value=\"$value\" $selected >$city</option>";
  90                 }
  91                 $o .= '</optgroup></select>';
  92                 return $o;
  93         }
  94
  95         /**
  96          * @brief Generating a Timezone selector
  97          *
  98          * Return a select using 'field_select_raw' template, with timezones
  99          * grouped (primarily) by continent
 100          * arguments follow convention as other field_* template array:
 101          * 'name', 'label', $value, 'help'
 102          *
 103          * @param string $name Name of the selector
 104          * @param string $label Label for the selector
 105          * @param string $current Timezone
 106          * @param string $help Help text
 107          *
 108          * @return string Parsed HTML
 109          */
 110         public static function getTimezoneField($name = 'timezone', $label = '', $current = 'America/Los_Angeles', $help = '')
 111         {
 112                 $options = self::getTimezoneSelect($current);
 113                 $options = str_replace('<select id="timezone_select" name="timezone">', '', $options);
 114                 $options = str_replace('</select>', '', $options);
 115
 116                 $tpl = get_markup_template('field_select_raw.tpl');
 117                 return replace_macros($tpl, [
 118                         '$field' => [$name, $label, $current, $help, $options],
 119                 ]);
 120         }
 121
 122         /**
 123          * @brief Wrapper for date selector, tailored for use in birthday fields.
 124          *
 125          * @param string $dob Date of Birth
 126          * @return string Formatted HTML
 127          */
 128         public static function getDateofBirthField($dob)
 129         {
 130                 list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d');
 131
 132                 if ($dob < '0000-01-01') {
 133                         $value = '';
 134                 } else {
 135                         $value = DateTimeFormat::utc(($year > 1000) ? $dob : '1000-' . $month . '-' . $day, 'Y-m-d');
 136                 }
 137
 138                 $age = (intval($value) ? self::getAgeByTimezone($value, $a->user["timezone"], $a->user["timezone"]) : "");
 139
 140                 $tpl = get_markup_template("field_input.tpl");
 141                 $o = replace_macros($tpl,
 142                         [
 143                         '$field' => [
 144                                 'dob',
 145                                 L10n::t('Birthday:'),
 146                                 $value,
 147                                 intval($age) > 0 ? L10n::t('Age: ') . $age : "",
 148                                 '',
 149                                 'placeholder="' . L10n::t('YYYY-MM-DD or MM-DD') . '"'
 150                         ]
 151                 ]);
 152
 153                 return $o;
 154         }
 155
 156         /**
 157          * @brief Returns a date selector
 158          *
 159          * @param string $min     Unix timestamp of minimum date
 160          * @param string $max     Unix timestap of maximum date
 161          * @param string $default Unix timestamp of default date
 162          * @param string $id      ID and name of datetimepicker (defaults to "datetimepicker")
 163          *
 164          * @return string Parsed HTML output.
 165          */
 166         public static function getDateField($min, $max, $default, $id = 'datepicker')
 167         {
 168                 return self::getDateTimeField($min, $max, $default, '', $id, true, false, '', '');
 169         }
 170
 171         /**
 172          * @brief Returns a time selector
 173          *
 174          * @param string $h  Already selected hour
 175          * @param string $m  Already selected minute
 176          * @param string $id ID and name of datetimepicker (defaults to "timepicker")
 177          *
 178          * @return string Parsed HTML output.
 179          */
 180         public static function getTimeField($h, $m, $id = 'timepicker')
 181         {
 182                 return self::getDateTimeField(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
 183         }
 184
 185         /**
 186          * @brief Returns a datetime selector.
 187          *
 188          * @param DateTime $minDate     Minimum date
 189          * @param DateTime $maxDate     Maximum date
 190          * @param DateTime $defaultDate Default date
 191          * @param string   $id          Id and name of datetimepicker (defaults to "datetimepicker")
 192          * @param bool     $pickdate    true to show date picker (default)
 193          * @param bool     $picktime    true to show time picker (default)
 194          * @param string   $minfrom     set minimum date from picker with id $minfrom (none by default)
 195          * @param string   $maxfrom     set maximum date from picker with id $maxfrom (none by default)
 196          * @param bool     $required    default false
 197          *
 198          * @return string Parsed HTML output.
 199          *
 200          * @todo Once browser support is better this could probably be replaced with
 201          * native HTML5 date picker.
 202          */
 203         public static function getDateTimeField(
 204                 DateTime $minDate,
 205                 DateTime $maxDate,
 206                 DateTime $defaultDate,
 207                 $label,
 208                 $id       = 'datetimepicker',
 209                 $pickdate = true,
 210                 $picktime = true,
 211                 $minfrom  = '',
 212                 $maxfrom  = '',
 213                 $required = false)
 214         {
 215                 // First day of the week (0 = Sunday)
 216                 $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
 217
 218                 $lang = substr(L10n::getBrowserLanguage(), 0, 2);
 219
 220                 // Check if the detected language is supported by the picker
 221                 if (!in_array($lang,
 222                                 ["ar", "ro", "id", "bg", "fa", "ru", "uk", "en", "el", "de", "nl", "tr", "fr", "es", "th", "pl", "pt", "ch", "se", "kr",
 223                                 "it", "da", "no", "ja", "vi", "sl", "cs", "hu"])) {
 224                         $lang = Config::get('system', 'language', 'en');
 225                 }
 226
 227                 $o = '';
 228                 $dateformat = '';
 229
 230                 if ($pickdate) {
 231                         $dateformat .= 'Y-m-d';
 232                 }
 233
 234                 if ($pickdate && $picktime) {
 235                         $dateformat .= ' ';
 236                 }
 237
 238                 if ($picktime) {
 239                         $dateformat .= 'H:i';
 240                 }
 241
 242                 $input_text = $defaultDate ? date($dateformat, $defaultDate->getTimestamp()) : '';
 243
 244                 $readable_format = str_replace(['Y', 'm', 'd', 'H', 'i'], ['yyyy', 'mm', 'dd', 'HH', 'MM'], $dateformat);
 245
 246                 $tpl = get_markup_template('field_datetime.tpl');
 247                 $o .= replace_macros($tpl, [
 248                         '$field' => [
 249                                 $id,
 250                                 $label,
 251                                 $input_text,
 252                                 '',
 253                                 $required ? '*' : '',
 254                                 'placeholder="' . $readable_format . '"'
 255                         ],
 256                         '$datetimepicker' => [
 257                                 'minDate' => $minDate,
 258                                 'maxDate' => $maxDate,
 259                                 'defaultDate' => $defaultDate,
 260                                 'dateformat' => $dateformat,
 261                                 'firstDay' => $firstDay,
 262                                 'lang' => $lang,
 263                                 'minfrom' => $minfrom,
 264                                 'maxfrom' => $maxfrom,
 265                         ]
 266                 ]);
 267
 268                 return $o;
 269         }
 270
 271         /**
 272          * @brief Returns a relative date string.
 273          *
 274          * Implements "3 seconds ago" etc.
 275          * Based on $posted_date, (UTC).
 276          * Results relative to current timezone.
 277          * Limited to range of timestamps.
 278          *
 279          * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
 280          * @param string $format (optional) Parsed with sprintf()
 281          *    <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
 282          *
 283          * @return string with relative date
 284          */
 285         public static function getRelativeDate($posted_date, $format = null)
 286         {
 287                 $localtime = $posted_date . ' UTC';
 288
 289                 $abs = strtotime($localtime);
 290
 291                 if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === false) {
 292                         return L10n::t('never');
 293                 }
 294
 295                 $etime = time() - $abs;
 296
 297                 if ($etime < 1) {
 298                         return L10n::t('less than a second ago');
 299                 }
 300
 301                 $a = [12 * 30 * 24 * 60 * 60 => [L10n::t('year'), L10n::t('years')],
 302                         30 * 24 * 60 * 60 => [L10n::t('month'), L10n::t('months')],
 303                         7 * 24 * 60 * 60 => [L10n::t('week'), L10n::t('weeks')],
 304                         24 * 60 * 60 => [L10n::t('day'), L10n::t('days')],
 305                         60 * 60 => [L10n::t('hour'), L10n::t('hours')],
 306                         60 => [L10n::t('minute'), L10n::t('minutes')],
 307                         1 => [L10n::t('second'), L10n::t('seconds')]
 308                 ];
 309
 310                 foreach ($a as $secs => $str) {
 311                         $d = $etime / $secs;
 312                         if ($d >= 1) {
 313                                 $r = round($d);
 314                                 // translators - e.g. 22 hours ago, 1 minute ago
 315                                 if (!$format) {
 316                                         $format = L10n::t('%1$d %2$s ago');
 317                                 }
 318
 319                                 return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
 320                         }
 321                 }
 322         }
 323
 324         /**
 325          * @brief Returns timezone correct age in years.
 326          *
 327          * Returns the age in years, given a date of birth, the timezone of the person
 328          * whose date of birth is provided, and the timezone of the person viewing the
 329          * result.
 330          *
 331          * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
 332          * is on New Year's. You live in San Bruno, California.
 333          * When exactly are you going to see my age increase?
 334          *
 335          * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
 336          * and become a year older. If you wish me happy birthday on January 1
 337          * (San Bruno time), you'll be a day late.
 338          *
 339          * @param string $dob Date of Birth
 340          * @param string $owner_tz (optional) Timezone of the person of interest
 341          * @param string $viewer_tz (optional) Timezone of the person viewing
 342          *
 343          * @return int Age in years
 344          */
 345         public static function getAgeByTimezone($dob, $owner_tz = '', $viewer_tz = '')
 346         {
 347                 if (!intval($dob)) {
 348                         return 0;
 349                 }
 350                 if (!$owner_tz) {
 351                         $owner_tz = date_default_timezone_get();
 352                 }
 353                 if (!$viewer_tz) {
 354                         $viewer_tz = date_default_timezone_get();
 355                 }
 356
 357                 $birthdate = DateTimeFormat::convert($dob . ' 00:00:00+00:00', $owner_tz, 'UTC', 'Y-m-d');
 358                 list($year, $month, $day) = explode("-", $birthdate);
 359                 $year_diff  = DateTimeFormat::timezoneNow($viewer_tz, 'Y') - $year;
 360                 $curr_month = DateTimeFormat::timezoneNow($viewer_tz, 'm');
 361                 $curr_day   = DateTimeFormat::timezoneNow($viewer_tz, 'd');
 362
 363                 if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
 364                         $year_diff--;
 365                 }
 366
 367                 return $year_diff;
 368         }
 369
 370         /**
 371          * @brief Get days of a month in a given year.
 372          *
 373          * Returns number of days in the month of the given year.
 374          * $m = 1 is 'January' to match human usage.
 375          *
 376          * @param int $y Year
 377          * @param int $m Month (1=January, 12=December)
 378          *
 379          * @return int Number of days in the given month
 380          */
 381         public static function getDaysInMonth($y, $m)
 382         {
 383                 return date('t', mktime(0, 0, 0, $m, 1, $y));
 384         }
 385
 386         /**
 387          * @brief Returns the first day in month for a given month, year.
 388          *
 389          * Months start at 1.
 390          *
 391          * @param int $y Year
 392          * @param int $m Month (1=January, 12=December)
 393          *
 394          * @return string day 0 = Sunday through 6 = Saturday
 395          */
 396         private static function getFirstDayInMonth($y, $m)
 397         {
 398                 $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
 399
 400                 return DateTimeFormat::utc($d, 'w');
 401         }
 402
 403         /**
 404          * @brief Output a calendar for the given month, year.
 405          *
 406          * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
 407          * date 12 will be linked appropriately. Today's date is also noted by
 408          * altering td class.
 409          * Months count from 1.
 410          *
 411          * @param int    $y Year
 412          * @param int    $m Month
 413          * @param array  $links (default null)
 414          * @param string $class
 415          *
 416          * @return string
 417          *
 418          * @todo Provide (prev, next) links, define class variations for different size calendars
 419          */
 420         public static function getCalendarTable($y = 0, $m = 0, $links = null, $class = '')
 421         {
 422                 // month table - start at 1 to match human usage.
 423                 $mtab = [' ',
 424                         'January', 'February', 'March',
 425                         'April', 'May', 'June',
 426                         'July', 'August', 'September',
 427                         'October', 'November', 'December'
 428                 ];
 429
 430                 $thisyear = DateTimeFormat::localNow('Y');
 431                 $thismonth = DateTimeFormat::localNow('m');
 432                 if (!$y) {
 433                         $y = $thisyear;
 434                 }
 435
 436                 if (!$m) {
 437                         $m = intval($thismonth);
 438                 }
 439
 440                 $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
 441                 $f = self::getFirstDayInMonth($y, $m);
 442                 $l = self::getDaysInMonth($y, $m);
 443                 $d = 1;
 444                 $dow = 0;
 445                 $started = false;
 446
 447                 if (($y == $thisyear) && ($m == $thismonth)) {
 448                         $tddate = intval(DateTimeFormat::localNow('j'));
 449                 }
 450
 451                 $str_month = day_translate($mtab[$m]);
 452                 $o = '<table class="calendar' . $class . '">';
 453                 $o .= "<caption>$str_month $y</caption><tr>";
 454                 for ($a = 0; $a < 7; $a ++) {
 455                         $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
 456                 }
 457
 458                 $o .= '</tr><tr>';
 459
 460                 while ($d <= $l) {
 461                         if (($dow == $f) && (!$started)) {
 462                                 $started = true;
 463                         }
 464
 465                         $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
 466                         $o .= "<td $today>";
 467                         $day = str_replace(' ', '&nbsp;', sprintf('%2.2d', $d));
 468                         if ($started) {
 469                                 if (x($links, $d) !== false) {
 470                                         $o .= "<a href=\"{$links[$d]}\">$day</a>";
 471                                 } else {
 472                                         $o .= $day;
 473                                 }
 474
 475                                 $d ++;
 476                         } else {
 477                                 $o .= '&nbsp;';
 478                         }
 479
 480                         $o .= '</td>';
 481                         $dow ++;
 482                         if (($dow == 7) && ($d <= $l)) {
 483                                 $dow = 0;
 484                                 $o .= '</tr><tr>';
 485                         }
 486                 }
 487
 488                 if ($dow) {
 489                         for ($a = $dow; $a < 7; $a ++) {
 490                                 $o .= '<td>&nbsp;</td>';
 491                         }
 492                 }
 493
 494                 $o .= '</tr></table>' . "\r\n";
 495
 496                 return $o;
 497         }
 498 }