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