3 * @file include/datetime.php
4 * @brief Some functions for date and time related tasks.
7 use Friendica\Core\Config;
10 * @brief Two-level sort for timezones.
16 function timezone_cmp($a, $b) {
17 if (strstr($a, '/') && strstr($b, '/')) {
18 if ( t($a) == t($b)) {
21 return ( t($a) < t($b)) ? -1 : 1;
24 if (strstr($a, '/')) {
26 } elseif (strstr($b, '/')) {
28 } elseif ( t($a) == t($b)) {
32 return ( t($a) < t($b)) ? -1 : 1;
36 * @brief Emit a timezone selector grouped (primarily) by continent
38 * @param string $current Timezone
39 * @return string Parsed HTML output
41 function select_timezone($current = 'America/Los_Angeles') {
43 $timezone_identifiers = DateTimeZone::listIdentifiers();
45 $o ='<select id="timezone_select" name="timezone">';
47 usort($timezone_identifiers, 'timezone_cmp');
49 foreach ($timezone_identifiers as $value) {
50 $ex = explode("/", $value);
52 if ($ex[0] != $continent) {
53 if ($continent != '') {
57 $o .= '<optgroup label="' . t($continent) . '">';
60 $city = substr($value,strpos($value,'/')+1);
66 if ($continent != t('Miscellaneous')) {
68 $continent = t('Miscellaneous');
69 $o .= '<optgroup label="' . t($continent) . '">';
72 $city = str_replace('_', ' ', t($city));
73 $selected = (($value == $current) ? " selected=\"selected\" " : "");
74 $o .= "<option value=\"$value\" $selected >$city</option>";
76 $o .= '</optgroup></select>';
83 * @brief Generating a Timezone selector
85 * Return a select using 'field_select_raw' template, with timezones
86 * groupped (primarily) by continent
87 * arguments follow convetion as other field_* template array:
88 * 'name', 'label', $value, 'help'
90 * @param string $name Name of the selector
91 * @param string $label Label for the selector
92 * @param string $current Timezone
93 * @param string $help Help text
95 * @return string Parsed HTML
97 function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){
98 $options = select_timezone($current);
99 $options = str_replace('<select id="timezone_select" name="timezone">','', $options);
100 $options = str_replace('</select>','', $options);
102 $tpl = get_markup_template('field_select_raw.tpl');
103 return replace_macros($tpl, array(
104 '$field' => array($name, $label, $current, $help, $options),
110 * @brief General purpose date parse/convert function.
112 * @param string $from Source timezone
113 * @param string $to Dest timezone
114 * @param string $s Some parseable date/time string
115 * @param string $fmt Output format recognised from php's DateTime class
116 * http://www.php.net/manual/en/datetime.format.php
118 * @return string Formatted date according to given format
120 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
122 // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
123 // Provide some sane defaults regardless.
131 if ( ($s === '') || (! is_string($s)) ) {
136 * Slight hackish adjustment so that 'zero' datetime actually returns what is intended
137 * otherwise we end up with -0001-11-30 ...
138 * add 32 days so that we at least get year 00, and then hack around the fact that
139 * months and days always start with 1.
142 if (substr($s,0,10) <= '0001-01-01') {
143 $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
144 return str_replace('1','0',$d->format($fmt));
148 $from_obj = new DateTimeZone($from);
149 } catch (Exception $e) {
150 $from_obj = new DateTimeZone('UTC');
154 $d = new DateTime($s, $from_obj);
155 } catch (Exception $e) {
156 logger('datetime_convert: exception: ' . $e->getMessage());
157 $d = new DateTime('now', $from_obj);
161 $to_obj = new DateTimeZone($to);
162 } catch (Exception $e) {
163 $to_obj = new DateTimeZone('UTC');
166 $d->setTimeZone($to_obj);
168 return $d->format($fmt);
173 * @brief Wrapper for date selector, tailored for use in birthday fields.
175 * @param string $dob Date of Birth
176 * @return string Formatted html
179 list($year,$month,$day) = sscanf($dob,'%4d-%2d-%2d');
181 $f = get_config('system', 'birthday_input_format');
185 if ($dob <= '0001-01-01') {
188 $value = (($year) ? datetime_convert('UTC','UTC',$dob,'Y-m-d') : datetime_convert('UTC','UTC',$dob,'m-d'));
191 $age = ((intval($value)) ? age($value, $a->user["timezone"], $a->user["timezone"]) : "");
193 $o = replace_macros(get_markup_template("field_input.tpl"), array(
198 (((intval($age)) > 0 ) ? t('Age: ') . $age : ""),
200 'placeholder="' . t('YYYY-MM-DD or MM-DD') . '"'
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');
208 // $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),false,'dob');
214 * @brief Returns a date selector
216 * @param string $format
217 * Format string, e.g. 'ymd' or 'mdy'. Not currently supported
219 * Unix timestamp of minimum date
221 * Unix timestap of maximum date
222 * @param string $default
223 * Unix timestamp of default date
225 * ID and name of datetimepicker (defaults to "datetimepicker")
227 * @return string Parsed HTML output.
229 function datesel($format, $min, $max, $default, $id = 'datepicker') {
230 return datetimesel($format, $min, $max, $default, '', $id, true, false, '', '');
234 * @brief Returns a time selector
236 * @param string $format
237 * Format string, e.g. 'ymd' or 'mdy'. Not currently supported
239 * Already selected hour
241 * Already selected minute
243 * ID and name of datetimepicker (defaults to "timepicker")
245 * @return string Parsed HTML output.
247 function timesel($format, $h, $m, $id = 'timepicker') {
248 return datetimesel($format, new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
252 * @brief Returns a datetime selector.
254 * @param string $format
255 * format string, e.g. 'ymd' or 'mdy'. Not currently supported
257 * unix timestamp of minimum date
259 * unix timestap of maximum date
260 * @param string $default
261 * unix timestamp of default date
263 * id and name of datetimepicker (defaults to "datetimepicker")
264 * @param bool $pickdate
265 * true to show date picker (default)
266 * @param boolean $picktime
267 * true to show time picker (default)
269 * set minimum date from picker with id $minfrom (none by default)
271 * set maximum date from picker with id $maxfrom (none by default)
272 * @param bool $required default false
274 * @return string Parsed HTML output.
276 * @todo Once browser support is better this could probably be replaced with
277 * native HTML5 date picker.
279 function datetimesel($format, $min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false) {
281 // First day of the week (0 = Sunday)
282 $firstDay = get_pconfig(local_user(), 'system', 'first_day_of_week');
283 if ($firstDay === false) {
287 $lang = substr(get_browser_language(), 0, 2);
289 // Check if the detected language is supported by the picker
290 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"))) {
291 $lang = Config::get('system', 'language', 'en');
298 $dateformat .= 'Y-m-d';
300 if ($pickdate && $picktime) {
304 $dateformat .= 'H:i';
307 $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : '';
308 $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : '';
310 $input_text = $default ? date($dateformat, $default->getTimestamp()) : '';
311 $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : '';
315 $pickers .= ', datepicker: false';
318 $pickers .= ',timepicker: false';
322 $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'";
323 if ($minfrom != '') {
324 $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})";
326 if ($maxfrom != '') {
327 $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})";
330 $readable_format = $dateformat;
331 $readable_format = str_replace('Y','yyyy',$readable_format);
332 $readable_format = str_replace('m','mm',$readable_format);
333 $readable_format = str_replace('d','dd',$readable_format);
334 $readable_format = str_replace('H','HH',$readable_format);
335 $readable_format = str_replace('i','MM',$readable_format);
337 $tpl = get_markup_template('field_input.tpl');
338 $o .= replace_macros($tpl, array(
339 '$field' => array($id, $label, $input_text, '', (($required) ? '*' : ''), 'placeholder="' . $readable_format . '"'),
342 $o .= "<script type='text/javascript'>";
343 $o .= "\$(function () {var picker = \$('#id_$id').datetimepicker({step:5,format:'$dateformat' $minjs $maxjs $pickers $defaultdatejs}); $extra_js})";
350 * @brief Returns a relative date string.
352 * Implements "3 seconds ago" etc.
353 * Based on $posted_date, (UTC).
354 * Results relative to current timezone.
355 * Limited to range of timestamps.
357 * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
358 * @param string $format (optional) Parsed with sprintf()
359 * <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
361 * @return string with relative date
363 function relative_date($posted_date, $format = null) {
365 $localtime = $posted_date . ' UTC';
367 $abs = strtotime($localtime);
369 if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === False) {
373 $etime = time() - $abs;
376 return t('less than a second ago');
379 $a = array( 12 * 30 * 24 * 60 * 60 => array( t('year'), t('years')),
380 30 * 24 * 60 * 60 => array( t('month'), t('months')),
381 7 * 24 * 60 * 60 => array( t('week'), t('weeks')),
382 24 * 60 * 60 => array( t('day'), t('days')),
383 60 * 60 => array( t('hour'), t('hours')),
384 60 => array( t('minute'), t('minutes')),
385 1 => array( t('second'), t('seconds'))
388 foreach ($a as $secs => $str) {
392 // translators - e.g. 22 hours ago, 1 minute ago
394 $format = t('%1$d %2$s ago');
397 return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
403 * @brief Returns timezone correct age in years.
405 * Returns the age in years, given a date of birth, the timezone of the person
406 * whose date of birth is provided, and the timezone of the person viewing the
409 * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
410 * is on New Year's. You live in San Bruno, California.
411 * When exactly are you going to see my age increase?
413 * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
414 * and become a year older. If you wish me happy birthday on January 1
415 * (San Bruno time), you'll be a day late.
417 * @param string $dob Date of Birth
418 * @param string $owner_tz (optional) Timezone of the person of interest
419 * @param string $viewer_tz (optional) Timezone of the person viewing
421 * @return int Age in years
423 function age($dob, $owner_tz = '', $viewer_tz = '') {
424 if (! intval($dob)) {
428 $owner_tz = date_default_timezone_get();
431 $viewer_tz = date_default_timezone_get();
434 $birthdate = datetime_convert('UTC', $owner_tz,$dob . ' 00:00:00+00:00','Y-m-d');
435 list($year, $month, $day) = explode("-", $birthdate);
436 $year_diff = datetime_convert('UTC',$viewer_tz, 'now', 'Y') - $year;
437 $curr_month = datetime_convert('UTC',$viewer_tz, 'now', 'm');
438 $curr_day = datetime_convert('UTC',$viewer_tz, 'now', 'd');
440 if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
448 * @brief Get days of a month in a given year.
450 * Returns number of days in the month of the given year.
451 * $m = 1 is 'January' to match human usage.
454 * @param int $m Month (1=January, 12=December)
456 * @return int Number of days in the given month
458 function get_dim($y, $m) {
461 31, 28, 31, 30, 31, 30,
462 31, 31, 30, 31, 30, 31);
466 } elseif (((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0)) {
474 * @brief Returns the first day in month for a given month, year.
479 * @param int $m Month (1=January, 12=December)
481 * @return string day 0 = Sunday through 6 = Saturday
483 function get_first_dim($y,$m) {
484 $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
486 return datetime_convert('UTC','UTC',$d,'w');
490 * @brief Output a calendar for the given month, year.
492 * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
493 * date 12 will be linked appropriately. Today's date is also noted by
495 * Months count from 1.
498 * @param int $m Month
499 * @param bool $links (default false)
500 * @param string $class
504 * @todo Provide (prev,next) links, define class variations for different size calendars
506 function cal($y = 0,$m = 0, $links = false, $class='') {
507 // month table - start at 1 to match human usage.
510 'January', 'February', 'March',
511 'April' , 'May' , 'June',
512 'July' , 'August' , 'September',
513 'October', 'November', 'December'
516 $thisyear = datetime_convert('UTC', date_default_timezone_get(), 'now','Y');
517 $thismonth = datetime_convert('UTC', date_default_timezone_get(), 'now','m');
522 $m = intval($thismonth);
525 $dn = array('Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday');
526 $f = get_first_dim($y,$m);
532 if (($y == $thisyear) && ($m == $thismonth)) {
533 $tddate = intval(datetime_convert('UTC', date_default_timezone_get(), 'now', 'j'));
536 $str_month = day_translate($mtab[$m]);
537 $o = '<table class="calendar' . $class . '">';
538 $o .= "<caption>$str_month $y</caption><tr>";
539 for ($a = 0; $a < 7; $a ++) {
540 $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
546 if (($dow == $f) && (! $started)) {
550 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
552 $day = str_replace(' ', ' ', sprintf('%2.2d', $d));
554 if (is_array($links) && isset($links[$d])) {
555 $o .= "<a href=\"{$links[$d]}\">$day</a>";
567 if (($dow == 7) && ($d <= $l)) {
573 for ($a = $dow; $a < 7; $a ++) {
574 $o .= '<td> </td>';
578 $o .= '</tr></table>'."\r\n";
584 * @brief Create a birthday event.
586 * Update the year and the birthday.
588 function update_contact_birthdays() {
590 // This only handles foreign or alien networks where a birthday has been provided.
591 // In-network birthdays are handled within local_delivery
593 $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` ");
594 if (dbm::is_result($r)) {
595 foreach ($r as $rr) {
597 logger('update_contact_birthday: ' . $rr['bd']);
599 $nextbd = datetime_convert('UTC','UTC','now','Y') . substr($rr['bd'], 4);
602 * Add new birthday event for this person
604 * $bdtext is just a readable placeholder in case the event is shared
605 * with others. We will replace it during presentation to our $importer
606 * to contain a sparkle link and perhaps a photo.
609 // Check for duplicates
610 $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1",
613 dbesc(datetime_convert('UTC','UTC', $nextbd)),
616 if (dbm::is_result($s)) {
620 $bdtext = sprintf( t('%s\'s birthday'), $rr['name']);
621 $bdtext2 = sprintf( t('Happy Birthday %s'), ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]') ;
623 $r = q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
624 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ",
627 dbesc(datetime_convert()),
628 dbesc(datetime_convert()),
629 dbesc(datetime_convert('UTC','UTC', $nextbd)),
630 dbesc(datetime_convert('UTC','UTC', $nextbd . ' + 1 day ')),
639 q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d",
640 dbesc(substr($nextbd,0,4)),