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