include/datetime.php

   1 <?php
   2 /**
   3  * @file include/datetime.php
   4  * @brief Some functions for date and time related tasks.
   5  */
   6
   7 use Friendica\Core\Config;
   8 use Friendica\Core\PConfig;
   9 use Friendica\Database\DBM;
  10
  11 /**
  12  * @brief Two-level sort for timezones.
  13  *
  14  * @param string $a
  15  * @param string $b
  16  * @return int
  17  */
  18 function timezone_cmp($a, $b) {
  19         if (strstr($a, '/') && strstr($b, '/')) {
  20                 if ( t($a) == t($b)) {
  21                         return 0;
  22                 }
  23                 return ( t($a) < t($b)) ? -1 : 1;
  24         }
  25
  26         if (strstr($a, '/')) {
  27                 return -1;
  28         } elseif (strstr($b, '/')) {
  29                 return  1;
  30         } elseif ( t($a) == t($b)) {
  31                 return 0;
  32         }
  33
  34         return ( t($a) < t($b)) ? -1 : 1;
  35 }
  36
  37 /**
  38  * @brief Emit a timezone selector grouped (primarily) by continent
  39  *
  40  * @param string $current Timezone
  41  * @return string Parsed HTML output
  42  */
  43 function select_timezone($current = 'America/Los_Angeles') {
  44
  45         $timezone_identifiers = DateTimeZone::listIdentifiers();
  46
  47         $o ='<select id="timezone_select" name="timezone">';
  48
  49         usort($timezone_identifiers, 'timezone_cmp');
  50         $continent = '';
  51         foreach ($timezone_identifiers as $value) {
  52                 $ex = explode("/", $value);
  53                 if (count($ex) > 1) {
  54                         if ($ex[0] != $continent) {
  55                                 if ($continent != '') {
  56                                         $o .= '</optgroup>';
  57                                 }
  58                                 $continent = $ex[0];
  59                                 $o .= '<optgroup label="' . t($continent) . '">';
  60                         }
  61                         if (count($ex) > 2) {
  62                                 $city = substr($value,strpos($value,'/')+1);
  63                         } else {
  64                                 $city = $ex[1];
  65                         }
  66                 } else {
  67                         $city = $ex[0];
  68                         if ($continent != t('Miscellaneous')) {
  69                                 $o .= '</optgroup>';
  70                                 $continent = t('Miscellaneous');
  71                                 $o .= '<optgroup label="' . t($continent) . '">';
  72                         }
  73                 }
  74                 $city = str_replace('_', ' ',  t($city));
  75                 $selected = (($value == $current) ? " selected=\"selected\" " : "");
  76                 $o .= "<option value=\"$value\" $selected >$city</option>";
  77         }
  78         $o .= '</optgroup></select>';
  79         return $o;
  80 }
  81
  82
  83
  84 /**
  85  * @brief Generating a Timezone selector
  86  *
  87  * Return a select using 'field_select_raw' template, with timezones
  88  * groupped (primarily) by continent
  89  * arguments follow convetion as other field_* template array:
  90  * 'name', 'label', $value, 'help'
  91  *
  92  * @param string $name Name of the selector
  93  * @param string $label Label for the selector
  94  * @param string $current Timezone
  95  * @param string $help Help text
  96  *
  97  * @return string Parsed HTML
  98  */
  99 function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){
 100         $options = select_timezone($current);
 101         $options = str_replace('<select id="timezone_select" name="timezone">','', $options);
 102         $options = str_replace('</select>','', $options);
 103
 104         $tpl = get_markup_template('field_select_raw.tpl');
 105         return replace_macros($tpl, array(
 106                 '$field' => array($name, $label, $current, $help, $options),
 107         ));
 108
 109 }
 110
 111 /**
 112  * @brief General purpose date parse/convert function.
 113  *
 114  * @param string $from Source timezone
 115  * @param string $to Dest timezone
 116  * @param string $s Some parseable date/time string
 117  * @param string $fmt Output format recognised from php's DateTime class
 118  *   http://www.php.net/manual/en/datetime.format.php
 119  *
 120  * @return string Formatted date according to given format
 121  */
 122 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
 123
 124         // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
 125         // Provide some sane defaults regardless.
 126
 127         if ($from === '') {
 128                 $from = 'UTC';
 129         }
 130         if ($to === '') {
 131                 $to = 'UTC';
 132         }
 133         if ( ($s === '') || (! is_string($s)) ) {
 134                 $s = 'now';
 135         }
 136
 137         /*
 138          * Slight hackish adjustment so that 'zero' datetime actually returns what is intended
 139          * otherwise we end up with -0001-11-30 ...
 140          * add 32 days so that we at least get year 00, and then hack around the fact that
 141          * months and days always start with 1.
 142          */
 143
 144         if (substr($s,0,10) <= '0001-01-01') {
 145                 $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
 146                 return str_replace('1','0',$d->format($fmt));
 147         }
 148
 149         try {
 150                 $from_obj = new DateTimeZone($from);
 151         } catch (Exception $e) {
 152                 $from_obj = new DateTimeZone('UTC');
 153         }
 154
 155         try {
 156                 $d = new DateTime($s, $from_obj);
 157         } catch (Exception $e) {
 158                 logger('datetime_convert: exception: ' . $e->getMessage());
 159                 $d = new DateTime('now', $from_obj);
 160         }
 161
 162         try {
 163                 $to_obj = new DateTimeZone($to);
 164         } catch (Exception $e) {
 165                 $to_obj = new DateTimeZone('UTC');
 166         }
 167
 168         $d->setTimeZone($to_obj);
 169
 170         return $d->format($fmt);
 171 }
 172
 173
 174 /**
 175  * @brief Wrapper for date selector, tailored for use in birthday fields.
 176  *
 177  * @param string $dob Date of Birth
 178  * @return string Formatted html
 179  */
 180 function dob($dob) {
 181         list($year,$month,$day) = sscanf($dob,'%4d-%2d-%2d');
 182
 183         if ($dob <= '0001-01-01') {
 184                 $value = '';
 185         } else {
 186                 $value = (($year) ? datetime_convert('UTC','UTC',$dob,'Y-m-d') : datetime_convert('UTC','UTC',$dob,'m-d'));
 187         }
 188
 189         $age = ((intval($value)) ? age($value, $a->user["timezone"], $a->user["timezone"]) : "");
 190
 191         $o = replace_macros(get_markup_template("field_input.tpl"), array(
 192                 '$field' => array(
 193                         'dob',
 194                         t('Birthday:'),
 195                         $value,
 196                         (((intval($age)) > 0 ) ? t('Age: ') . $age : ""),
 197                         '',
 198                         'placeholder="' . t('YYYY-MM-DD or MM-DD') . '"'
 199                 )
 200         ));
 201
 202         /// @TODO Old-lost code?
 203 //      if ($dob && $dob > '0001-01-01')
 204 //              $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),mktime(0,0,0,$month,$day,$year), 'dob');
 205 //      else
 206 //              $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),false,'dob');
 207
 208         return $o;
 209 }
 210
 211 /**
 212  * @brief Returns a date selector
 213  *
 214  * @param string $format
 215  *  Format string, e.g. 'ymd' or 'mdy'. Not currently supported
 216  * @param string $min
 217  *  Unix timestamp of minimum date
 218  * @param string $max
 219  *  Unix timestap of maximum date
 220  * @param string $default
 221  *  Unix timestamp of default date
 222  * @param string $id
 223  *  ID and name of datetimepicker (defaults to "datetimepicker")
 224  *
 225  * @return string Parsed HTML output.
 226  */
 227 function datesel($min, $max, $default, $id = 'datepicker')
 228 {
 229         return datetimesel($min, $max, $default, '', $id, true, false, '', '');
 230 }
 231
 232 /**
 233  * @brief Returns a time selector
 234  *
 235  * @param $h
 236  *  Already selected hour
 237  * @param $m
 238  *  Already selected minute
 239  * @param string $id
 240  *  ID and name of datetimepicker (defaults to "timepicker")
 241  *
 242  * @return string Parsed HTML output.
 243  */
 244 function timesel($h, $m, $id = 'timepicker')
 245 {
 246         return datetimesel(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
 247 }
 248
 249 /**
 250  * @brief Returns a datetime selector.
 251  *
 252  * @param string $min
 253  *  unix timestamp of minimum date
 254  * @param string $max
 255  *  unix timestap of maximum date
 256  * @param string $default
 257  *  unix timestamp of default date
 258  * @param string $id
 259  *  id and name of datetimepicker (defaults to "datetimepicker")
 260  * @param bool $pickdate
 261  *  true to show date picker (default)
 262  * @param boolean $picktime
 263  *  true to show time picker (default)
 264  * @param $minfrom
 265  *  set minimum date from picker with id $minfrom (none by default)
 266  * @param $maxfrom
 267  *  set maximum date from picker with id $maxfrom (none by default)
 268  * @param bool $required default false
 269  *
 270  * @return string Parsed HTML output.
 271  *
 272  * @todo Once browser support is better this could probably be replaced with
 273  * native HTML5 date picker.
 274  */
 275 function datetimesel($min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false)
 276 {
 277         // First day of the week (0 = Sunday)
 278         $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
 279
 280         $lang = substr(get_browser_language(), 0, 2);
 281
 282         // Check if the detected language is supported by the picker
 283         if (!in_array($lang, array("ar", "ro", "id", "bg", "fa", "ru", "uk", "en", "el", "de", "nl", "tr", "fr", "es", "th", "pl", "pt", "ch", "se", "kr", "it", "da", "no", "ja", "vi", "sl", "cs", "hu"))) {
 284                 $lang = Config::get('system', 'language', 'en');
 285         }
 286
 287         $o = '';
 288         $dateformat = '';
 289
 290         if ($pickdate) {
 291                 $dateformat .= 'Y-m-d';
 292         }
 293         if ($pickdate && $picktime) {
 294                 $dateformat .= ' ';
 295         }
 296         if ($picktime) {
 297                 $dateformat .= 'H:i';
 298         }
 299
 300         $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : '';
 301         $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : '';
 302
 303         $input_text = $default ? date($dateformat, $default->getTimestamp()) : '';
 304         $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : '';
 305
 306         $pickers = '';
 307         if (!$pickdate) {
 308                 $pickers .= ', datepicker: false';
 309         }
 310         if (!$picktime) {
 311                 $pickers .= ',timepicker: false';
 312         }
 313
 314         $extra_js = '';
 315         $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'";
 316         if ($minfrom != '') {
 317                 $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})";
 318         }
 319         if ($maxfrom != '') {
 320                 $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})";
 321         }
 322
 323         $readable_format = $dateformat;
 324         $readable_format = str_replace('Y','yyyy',$readable_format);
 325         $readable_format = str_replace('m','mm',$readable_format);
 326         $readable_format = str_replace('d','dd',$readable_format);
 327         $readable_format = str_replace('H','HH',$readable_format);
 328         $readable_format = str_replace('i','MM',$readable_format);
 329
 330         $tpl = get_markup_template('field_input.tpl');
 331         $o .= replace_macros($tpl, array(
 332                         '$field' => array($id, $label, $input_text, '', (($required) ? '*' : ''), 'placeholder="' . $readable_format . '"'),
 333                 ));
 334
 335         $o .= "<script type='text/javascript'>";
 336         $o .= "\$(function () {var picker = \$('#id_$id').datetimepicker({step:5,format:'$dateformat' $minjs $maxjs $pickers $defaultdatejs}); $extra_js})";
 337         $o .= "</script>";
 338
 339         return $o;
 340 }
 341
 342 /**
 343  * @brief Returns a relative date string.
 344  *
 345  * Implements "3 seconds ago" etc.
 346  * Based on $posted_date, (UTC).
 347  * Results relative to current timezone.
 348  * Limited to range of timestamps.
 349  *
 350  * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
 351  * @param string $format (optional) Parsed with sprintf()
 352  *    <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
 353  *
 354  * @return string with relative date
 355  */
 356 function relative_date($posted_date, $format = null) {
 357
 358         $localtime = $posted_date . ' UTC';
 359
 360         $abs = strtotime($localtime);
 361
 362         if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === False) {
 363                  return t('never');
 364         }
 365
 366         $etime = time() - $abs;
 367
 368         if ($etime < 1) {
 369                 return t('less than a second ago');
 370         }
 371
 372         $a = array( 12 * 30 * 24 * 60 * 60  =>  array( t('year'),   t('years')),
 373                                 30 * 24 * 60 * 60       =>  array( t('month'),  t('months')),
 374                                 7  * 24 * 60 * 60       =>  array( t('week'),   t('weeks')),
 375                                 24 * 60 * 60            =>  array( t('day'),    t('days')),
 376                                 60 * 60                 =>  array( t('hour'),   t('hours')),
 377                                 60                      =>  array( t('minute'), t('minutes')),
 378                                 1                       =>  array( t('second'), t('seconds'))
 379         );
 380
 381         foreach ($a as $secs => $str) {
 382                 $d = $etime / $secs;
 383                 if ($d >= 1) {
 384                         $r = round($d);
 385                         // translators - e.g. 22 hours ago, 1 minute ago
 386                         if (!$format) {
 387                                 $format = t('%1$d %2$s ago');
 388                         }
 389
 390                         return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
 391                 }
 392         }
 393 }
 394
 395 /**
 396  * @brief Returns timezone correct age in years.
 397  *
 398  * Returns the age in years, given a date of birth, the timezone of the person
 399  * whose date of birth is provided, and the timezone of the person viewing the
 400  * result.
 401  *
 402  * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
 403  * is on New Year's. You live in San Bruno, California.
 404  * When exactly are you going to see my age increase?
 405  *
 406  * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
 407  * and become a year older. If you wish me happy birthday on January 1
 408  * (San Bruno time), you'll be a day late.
 409  *
 410  * @param string $dob Date of Birth
 411  * @param string $owner_tz (optional) Timezone of the person of interest
 412  * @param string $viewer_tz (optional) Timezone of the person viewing
 413  *
 414  * @return int Age in years
 415  */
 416 function age($dob, $owner_tz = '', $viewer_tz = '') {
 417         if (! intval($dob)) {
 418                 return 0;
 419         }
 420         if (! $owner_tz) {
 421                 $owner_tz = date_default_timezone_get();
 422         }
 423         if (! $viewer_tz) {
 424                 $viewer_tz = date_default_timezone_get();
 425         }
 426
 427         $birthdate = datetime_convert('UTC', $owner_tz,$dob . ' 00:00:00+00:00','Y-m-d');
 428         list($year, $month, $day) = explode("-", $birthdate);
 429         $year_diff  = datetime_convert('UTC',$viewer_tz, 'now', 'Y') - $year;
 430         $curr_month = datetime_convert('UTC',$viewer_tz, 'now', 'm');
 431         $curr_day   = datetime_convert('UTC',$viewer_tz, 'now', 'd');
 432
 433         if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
 434                 $year_diff--;
 435         }
 436
 437         return $year_diff;
 438 }
 439
 440 /**
 441  * @brief Get days of a month in a given year.
 442  *
 443  * Returns number of days in the month of the given year.
 444  * $m = 1 is 'January' to match human usage.
 445  *
 446  * @param int $y Year
 447  * @param int $m Month (1=January, 12=December)
 448  *
 449  * @return int Number of days in the given month
 450  */
 451 function get_dim($y, $m) {
 452
 453         $dim = array( 0,
 454                 31, 28, 31, 30, 31, 30,
 455                 31, 31, 30, 31, 30, 31);
 456
 457         if ($m != 2) {
 458                 return $dim[$m];
 459         } elseif (((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0)) {
 460                 return 29;
 461         }
 462
 463         return $dim[2];
 464 }
 465
 466 /**
 467  * @brief Returns the first day in month for a given month, year.
 468  *
 469  * Months start at 1.
 470  *
 471  * @param int $y Year
 472  * @param int $m Month (1=January, 12=December)
 473  *
 474  * @return string day 0 = Sunday through 6 = Saturday
 475  */
 476 function get_first_dim($y,$m) {
 477         $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
 478
 479         return datetime_convert('UTC','UTC',$d,'w');
 480 }
 481
 482 /**
 483  * @brief Output a calendar for the given month, year.
 484  *
 485  * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
 486  * date 12 will be linked appropriately. Today's date is also noted by
 487  * altering td class.
 488  * Months count from 1.
 489  *
 490  * @param int $y Year
 491  * @param int $m Month
 492  * @param bool $links (default false)
 493  * @param string $class
 494  *
 495  * @return string
 496  *
 497  * @todo Provide (prev,next) links, define class variations for different size calendars
 498  */
 499 function cal($y = 0,$m = 0, $links = false, $class='') {
 500         // month table - start at 1 to match human usage.
 501
 502         $mtab = array(' ',
 503                 'January', 'February', 'March',
 504                 'April'  , 'May'     , 'June',
 505                 'July'   , 'August'  , 'September',
 506                 'October', 'November', 'December'
 507         );
 508
 509         $thisyear = datetime_convert('UTC', date_default_timezone_get(), 'now','Y');
 510         $thismonth = datetime_convert('UTC', date_default_timezone_get(), 'now','m');
 511         if (! $y) {
 512                 $y = $thisyear;
 513         }
 514         if (! $m) {
 515                 $m = intval($thismonth);
 516         }
 517
 518         $dn = array('Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday');
 519         $f = get_first_dim($y,$m);
 520         $l = get_dim($y,$m);
 521         $d = 1;
 522         $dow = 0;
 523         $started = false;
 524
 525         if (($y == $thisyear) && ($m == $thismonth)) {
 526                 $tddate = intval(datetime_convert('UTC', date_default_timezone_get(), 'now', 'j'));
 527         }
 528
 529         $str_month = day_translate($mtab[$m]);
 530         $o = '<table class="calendar' . $class . '">';
 531         $o .= "<caption>$str_month $y</caption><tr>";
 532         for ($a = 0; $a < 7; $a ++) {
 533                 $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
 534         }
 535
 536         $o .= '</tr><tr>';
 537
 538         while ($d <= $l) {
 539                 if (($dow == $f) && (! $started)) {
 540                         $started = true;
 541                 }
 542
 543                 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
 544                 $o .= "<td $today>";
 545                 $day = str_replace(' ', '&nbsp;', sprintf('%2.2d', $d));
 546                 if ($started) {
 547                         if (is_array($links) && isset($links[$d])) {
 548                                 $o .=  "<a href=\"{$links[$d]}\">$day</a>";
 549                         } else {
 550                                 $o .= $day;
 551                         }
 552
 553                         $d ++;
 554                 } else {
 555                         $o .= '&nbsp;';
 556                 }
 557
 558                 $o .= '</td>';
 559                 $dow ++;
 560                 if (($dow == 7) && ($d <= $l)) {
 561                         $dow = 0;
 562                         $o .= '</tr><tr>';
 563                 }
 564         }
 565         if ($dow) {
 566                 for ($a = $dow; $a < 7; $a ++) {
 567                         $o .= '<td>&nbsp;</td>';
 568                 }
 569         }
 570
 571         $o .= '</tr></table>'."\r\n";
 572
 573         return $o;
 574 }
 575
 576 /**
 577  * @brief Create a birthday event.
 578  *
 579  * Update the year and the birthday.
 580  */
 581 function update_contact_birthdays() {
 582
 583         // This only handles foreign or alien networks where a birthday has been provided.
 584         // In-network birthdays are handled within local_delivery
 585
 586         $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` ");
 587         if (DBM::is_result($r)) {
 588                 foreach ($r as $rr) {
 589
 590                         logger('update_contact_birthday: ' . $rr['bd']);
 591
 592                         $nextbd = datetime_convert('UTC','UTC','now','Y') . substr($rr['bd'], 4);
 593
 594                         /*
 595                          * Add new birthday event for this person
 596                          *
 597                          * $bdtext is just a readable placeholder in case the event is shared
 598                          * with others. We will replace it during presentation to our $importer
 599                          * to contain a sparkle link and perhaps a photo.
 600                          */
 601
 602                         // Check for duplicates
 603                         $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1",
 604                                 intval($rr['uid']),
 605                                 intval($rr['id']),
 606                                 dbesc(datetime_convert('UTC','UTC', $nextbd)),
 607                                 dbesc('birthday'));
 608
 609                         if (DBM::is_result($s)) {
 610                                 continue;
 611                         }
 612
 613                         $bdtext = sprintf( t('%s\'s birthday'), $rr['name']);
 614                         $bdtext2 = sprintf( t('Happy Birthday %s'), ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]') ;
 615
 616                         $r = q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
 617                                 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ",
 618                                 intval($rr['uid']),
 619                                 intval($rr['id']),
 620                                 dbesc(datetime_convert()),
 621                                 dbesc(datetime_convert()),
 622                                 dbesc(datetime_convert('UTC','UTC', $nextbd)),
 623                                 dbesc(datetime_convert('UTC','UTC', $nextbd . ' + 1 day ')),
 624                                 dbesc($bdtext),
 625                                 dbesc($bdtext2),
 626                                 dbesc('birthday'),
 627                                 intval(0)
 628                         );
 629
 630
 631                         // update bdyear
 632                         q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d",
 633                                 dbesc(substr($nextbd,0,4)),
 634                                 dbesc($nextbd),
 635                                 intval($rr['uid']),
 636                                 intval($rr['id'])
 637                         );
 638
 639                 }
 640         }
 641 }