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