]> git.mxchange.org Git - friendica.git/blob - include/datetime.php
Security t()
[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\L10n;
9 use Friendica\Core\PConfig;
10 use Friendica\Database\DBM;
11
12 /**
13  * @brief Two-level sort for timezones.
14  *
15  * @param string $a
16  * @param string $b
17  * @return int
18  */
19 function timezone_cmp($a, $b) {
20         if (strstr($a, '/') && strstr($b, '/')) {
21                 if (L10n::t($a) == L10n::t($b)) {
22                         return 0;
23                 }
24                 return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
25         }
26
27         if (strstr($a, '/')) {
28                 return -1;
29         } elseif (strstr($b, '/')) {
30                 return  1;
31         } elseif (L10n::t($a) == L10n::t($b)) {
32                 return 0;
33         }
34
35         return (L10n::t($a) < L10n::t($b)) ? -1 : 1;
36 }
37
38 /**
39  * @brief Emit a timezone selector grouped (primarily) by continent
40  *
41  * @param string $current Timezone
42  * @return string Parsed HTML output
43  */
44 function select_timezone($current = 'America/Los_Angeles') {
45
46         $timezone_identifiers = DateTimeZone::listIdentifiers();
47
48         $o ='<select id="timezone_select" name="timezone">';
49
50         usort($timezone_identifiers, 'timezone_cmp');
51         $continent = '';
52         foreach ($timezone_identifiers as $value) {
53                 $ex = explode("/", $value);
54                 if (count($ex) > 1) {
55                         if ($ex[0] != $continent) {
56                                 if ($continent != '') {
57                                         $o .= '</optgroup>';
58                                 }
59                                 $continent = $ex[0];
60                                 $o .= '<optgroup label="' . L10n::t($continent) . '">';
61                         }
62                         if (count($ex) > 2) {
63                                 $city = substr($value,strpos($value,'/')+1);
64                         } else {
65                                 $city = $ex[1];
66                         }
67                 } else {
68                         $city = $ex[0];
69                         if ($continent != L10n::t('Miscellaneous')) {
70                                 $o .= '</optgroup>';
71                                 $continent = L10n::t('Miscellaneous');
72                                 $o .= '<optgroup label="' . L10n::t($continent) . '">';
73                         }
74                 }
75                 $city = str_replace('_', ' ', L10n::t($city));
76                 $selected = (($value == $current) ? " selected=\"selected\" " : "");
77                 $o .= "<option value=\"$value\" $selected >$city</option>";
78         }
79         $o .= '</optgroup></select>';
80         return $o;
81 }
82
83
84
85 /**
86  * @brief Generating a Timezone selector
87  *
88  * Return a select using 'field_select_raw' template, with timezones
89  * groupped (primarily) by continent
90  * arguments follow convetion as other field_* template array:
91  * 'name', 'label', $value, 'help'
92  *
93  * @param string $name Name of the selector
94  * @param string $label Label for the selector
95  * @param string $current Timezone
96  * @param string $help Help text
97  *
98  * @return string Parsed HTML
99  */
100 function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){
101         $options = select_timezone($current);
102         $options = str_replace('<select id="timezone_select" name="timezone">','', $options);
103         $options = str_replace('</select>','', $options);
104
105         $tpl = get_markup_template('field_select_raw.tpl');
106         return replace_macros($tpl, [
107                 '$field' => [$name, $label, $current, $help, $options],
108         ]);
109
110 }
111
112 /**
113  * @brief General purpose date parse/convert function.
114  *
115  * @param string $from Source timezone
116  * @param string $to Dest timezone
117  * @param string $s Some parseable date/time string
118  * @param string $fmt Output format recognised from php's DateTime class
119  *   http://www.php.net/manual/en/datetime.format.php
120  *
121  * @return string Formatted date according to given format
122  */
123 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
124
125         // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
126         // Provide some sane defaults regardless.
127
128         if ($from === '') {
129                 $from = 'UTC';
130         }
131         if ($to === '') {
132                 $to = 'UTC';
133         }
134         if ( ($s === '') || (! is_string($s)) ) {
135                 $s = 'now';
136         }
137
138         /*
139          * Slight hackish adjustment so that 'zero' datetime actually returns what is intended
140          * otherwise we end up with -0001-11-30 ...
141          * add 32 days so that we at least get year 00, and then hack around the fact that
142          * months and days always start with 1.
143          */
144
145         if (substr($s,0,10) <= '0001-01-01') {
146                 $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
147                 return str_replace('1','0',$d->format($fmt));
148         }
149
150         try {
151                 $from_obj = new DateTimeZone($from);
152         } catch (Exception $e) {
153                 $from_obj = new DateTimeZone('UTC');
154         }
155
156         try {
157                 $d = new DateTime($s, $from_obj);
158         } catch (Exception $e) {
159                 logger('datetime_convert: exception: ' . $e->getMessage());
160                 $d = new DateTime('now', $from_obj);
161         }
162
163         try {
164                 $to_obj = new DateTimeZone($to);
165         } catch (Exception $e) {
166                 $to_obj = new DateTimeZone('UTC');
167         }
168
169         $d->setTimeZone($to_obj);
170
171         return $d->format($fmt);
172 }
173
174
175 /**
176  * @brief Wrapper for date selector, tailored for use in birthday fields.
177  *
178  * @param string $dob Date of Birth
179  * @return string Formatted html
180  */
181 function dob($dob)
182 {
183         list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d');
184
185         if ($dob <= '0001-01-01') {
186                 $value = '';
187         } else {
188                 $value = (($year) ? datetime_convert('UTC','UTC',$dob,'Y-m-d') : datetime_convert('UTC','UTC',$dob,'m-d'));
189         }
190
191         $age = ((intval($value)) ? age($value, $a->user["timezone"], $a->user["timezone"]) : "");
192
193         $o = replace_macros(get_markup_template("field_input.tpl"), [
194                 '$field' => [
195                         'dob',
196                         t('Birthday:'),
197                         $value,
198                         (((intval($age)) > 0 ) ? L10n::t('Age: ') . $age : ""),
199                         '',
200                         'placeholder="' . L10n::t('YYYY-MM-DD or MM-DD') . '"'
201                 ]
202         ]);
203
204         /// @TODO Old-lost code?
205         //      if ($dob && $dob > '0001-01-01')
206         //              $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),mktime(0,0,0,$month,$day,$year), 'dob');
207         //      else
208         //              $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),false,'dob');
209
210         return $o;
211 }
212
213 /**
214  * @brief Returns a date selector
215  *
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(L10n::getBrowserLanguage(), 0, 2);
281
282         // Check if the detected language is supported by the picker
283         if (!in_array($lang, ["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, [
332                         '$field' => [$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 L10n::t('never');
364         }
365
366         $etime = time() - $abs;
367
368         if ($etime < 1) {
369                 return L10n::t('less than a second ago');
370         }
371
372         $a = [ 12 * 30 * 24 * 60 * 60  =>  [L10n::t('year'),   L10n::t('years')],
373                                 30 * 24 * 60 * 60       =>  [L10n::t('month'),  L10n::t('months')],
374                                 7  * 24 * 60 * 60       =>  [L10n::t('week'),   L10n::t('weeks')],
375                                 24 * 60 * 60            =>  [L10n::t('day'),    L10n::t('days')],
376                                 60 * 60                 =>  [L10n::t('hour'),   L10n::t('hours')],
377                                 60                      =>  [L10n::t('minute'), L10n::t('minutes')],
378                                 1                       =>  [L10n::t('second'), L10n::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 = L10n::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 = [ 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 array  $links (default null)
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 = null, $class = '')
500 {
501         // month table - start at 1 to match human usage.
502         $mtab = [' ',
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
515         if (!$m) {
516                 $m = intval($thismonth);
517         }
518
519         $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
520         $f = get_first_dim($y, $m);
521         $l = get_dim($y, $m);
522         $d = 1;
523         $dow = 0;
524         $started = false;
525
526         if (($y == $thisyear) && ($m == $thismonth)) {
527                 $tddate = intval(datetime_convert('UTC', date_default_timezone_get(), 'now', 'j'));
528         }
529
530         $str_month = day_translate($mtab[$m]);
531         $o = '<table class="calendar' . $class . '">';
532         $o .= "<caption>$str_month $y</caption><tr>";
533         for ($a = 0; $a < 7; $a ++) {
534                 $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
535         }
536
537         $o .= '</tr><tr>';
538
539         while ($d <= $l) {
540                 if (($dow == $f) && (! $started)) {
541                         $started = true;
542                 }
543
544                 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
545                 $o .= "<td $today>";
546                 $day = str_replace(' ', '&nbsp;', sprintf('%2.2d', $d));
547                 if ($started) {
548                         if (x($links, $d) !== false) {
549                                 $o .= "<a href=\"{$links[$d]}\">$day</a>";
550                         } else {
551                                 $o .= $day;
552                         }
553
554                         $d ++;
555                 } else {
556                         $o .= '&nbsp;';
557                 }
558
559                 $o .= '</td>';
560                 $dow ++;
561                 if (($dow == 7) && ($d <= $l)) {
562                         $dow = 0;
563                         $o .= '</tr><tr>';
564                 }
565         }
566         if ($dow) {
567                 for ($a = $dow; $a < 7; $a ++) {
568                         $o .= '<td>&nbsp;</td>';
569                 }
570         }
571
572         $o .= '</tr></table>' . "\r\n";
573
574         return $o;
575 }
576
577 /**
578  * @brief Create a birthday event.
579  *
580  * Update the year and the birthday.
581  */
582 function update_contact_birthdays() {
583
584         // This only handles foreign or alien networks where a birthday has been provided.
585         // In-network birthdays are handled within local_delivery
586
587         $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` ");
588         if (DBM::is_result($r)) {
589                 foreach ($r as $rr) {
590
591                         logger('update_contact_birthday: ' . $rr['bd']);
592
593                         $nextbd = datetime_convert('UTC','UTC','now','Y') . substr($rr['bd'], 4);
594
595                         /*
596                          * Add new birthday event for this person
597                          *
598                          * $bdtext is just a readable placeholder in case the event is shared
599                          * with others. We will replace it during presentation to our $importer
600                          * to contain a sparkle link and perhaps a photo.
601                          */
602
603                         // Check for duplicates
604                         $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1",
605                                 intval($rr['uid']),
606                                 intval($rr['id']),
607                                 dbesc(datetime_convert('UTC','UTC', $nextbd)),
608                                 dbesc('birthday'));
609
610                         if (DBM::is_result($s)) {
611                                 continue;
612                         }
613
614                         $bdtext = sprintf(L10n::t('%s\'s birthday'), $rr['name']);
615                         $bdtext2 = sprintf(L10n::t('Happy Birthday %s'), ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]') ;
616
617                         q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
618                                 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ",
619                                 intval($rr['uid']),
620                                 intval($rr['id']),
621                                 dbesc(datetime_convert()),
622                                 dbesc(datetime_convert()),
623                                 dbesc(datetime_convert('UTC','UTC', $nextbd)),
624                                 dbesc(datetime_convert('UTC','UTC', $nextbd . ' + 1 day ')),
625                                 dbesc($bdtext),
626                                 dbesc($bdtext2),
627                                 dbesc('birthday'),
628                                 intval(0)
629                         );
630
631
632                         // update bdyear
633                         q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d",
634                                 dbesc(substr($nextbd,0,4)),
635                                 dbesc($nextbd),
636                                 intval($rr['uid']),
637                                 intval($rr['id'])
638                         );
639
640                 }
641         }
642 }