3 * @file include/datetime.php
4 * @brief Some functions for date and time related tasks.
7 use Friendica\Core\Config;
8 use Friendica\Core\PConfig;
9 use Friendica\Database\DBM;
12 * @brief Two-level sort for timezones.
18 function timezone_cmp($a, $b) {
19 if (strstr($a, '/') && strstr($b, '/')) {
20 if ( t($a) == t($b)) {
23 return ( t($a) < t($b)) ? -1 : 1;
26 if (strstr($a, '/')) {
28 } elseif (strstr($b, '/')) {
30 } elseif ( t($a) == t($b)) {
34 return ( t($a) < t($b)) ? -1 : 1;
38 * @brief Emit a timezone selector grouped (primarily) by continent
40 * @param string $current Timezone
41 * @return string Parsed HTML output
43 function select_timezone($current = 'America/Los_Angeles') {
45 $timezone_identifiers = DateTimeZone::listIdentifiers();
47 $o ='<select id="timezone_select" name="timezone">';
49 usort($timezone_identifiers, 'timezone_cmp');
51 foreach ($timezone_identifiers as $value) {
52 $ex = explode("/", $value);
54 if ($ex[0] != $continent) {
55 if ($continent != '') {
59 $o .= '<optgroup label="' . t($continent) . '">';
62 $city = substr($value,strpos($value,'/')+1);
68 if ($continent != t('Miscellaneous')) {
70 $continent = t('Miscellaneous');
71 $o .= '<optgroup label="' . t($continent) . '">';
74 $city = str_replace('_', ' ', t($city));
75 $selected = (($value == $current) ? " selected=\"selected\" " : "");
76 $o .= "<option value=\"$value\" $selected >$city</option>";
78 $o .= '</optgroup></select>';
85 * @brief Generating a Timezone selector
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'
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
97 * @return string Parsed HTML
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);
104 $tpl = get_markup_template('field_select_raw.tpl');
105 return replace_macros($tpl, array(
106 '$field' => array($name, $label, $current, $help, $options),
112 * @brief General purpose date parse/convert function.
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
120 * @return string Formatted date according to given format
122 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
124 // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
125 // Provide some sane defaults regardless.
133 if ( ($s === '') || (! is_string($s)) ) {
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.
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));
150 $from_obj = new DateTimeZone($from);
151 } catch (Exception $e) {
152 $from_obj = new DateTimeZone('UTC');
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);
163 $to_obj = new DateTimeZone($to);
164 } catch (Exception $e) {
165 $to_obj = new DateTimeZone('UTC');
168 $d->setTimeZone($to_obj);
170 return $d->format($fmt);
175 * @brief Wrapper for date selector, tailored for use in birthday fields.
177 * @param string $dob Date of Birth
178 * @return string Formatted html
181 list($year,$month,$day) = sscanf($dob,'%4d-%2d-%2d');
183 $f = Config::get('system', 'birthday_input_format');
187 if ($dob <= '0001-01-01') {
190 $value = (($year) ? datetime_convert('UTC','UTC',$dob,'Y-m-d') : datetime_convert('UTC','UTC',$dob,'m-d'));
193 $age = ((intval($value)) ? age($value, $a->user["timezone"], $a->user["timezone"]) : "");
195 $o = replace_macros(get_markup_template("field_input.tpl"), array(
200 (((intval($age)) > 0 ) ? t('Age: ') . $age : ""),
202 'placeholder="' . t('YYYY-MM-DD or MM-DD') . '"'
206 /// @TODO Old-lost code?
207 // if ($dob && $dob > '0001-01-01')
208 // $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),mktime(0,0,0,$month,$day,$year), 'dob');
210 // $o = datesel($f,mktime(0,0,0,0,0,1900),mktime(),false,'dob');
216 * @brief Returns a date selector
218 * @param string $format
219 * Format string, e.g. 'ymd' or 'mdy'. Not currently supported
221 * Unix timestamp of minimum date
223 * Unix timestap of maximum date
224 * @param string $default
225 * Unix timestamp of default date
227 * ID and name of datetimepicker (defaults to "datetimepicker")
229 * @return string Parsed HTML output.
231 function datesel($format, $min, $max, $default, $id = 'datepicker') {
232 return datetimesel($format, $min, $max, $default, '', $id, true, false, '', '');
236 * @brief Returns a time selector
238 * @param string $format
239 * Format string, e.g. 'ymd' or 'mdy'. Not currently supported
241 * Already selected hour
243 * Already selected minute
245 * ID and name of datetimepicker (defaults to "timepicker")
247 * @return string Parsed HTML output.
249 function timesel($format, $h, $m, $id = 'timepicker') {
250 return datetimesel($format, new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
254 * @brief Returns a datetime selector.
256 * @param string $format
257 * format string, e.g. 'ymd' or 'mdy'. Not currently supported
259 * unix timestamp of minimum date
261 * unix timestap of maximum date
262 * @param string $default
263 * unix timestamp of default date
265 * id and name of datetimepicker (defaults to "datetimepicker")
266 * @param bool $pickdate
267 * true to show date picker (default)
268 * @param boolean $picktime
269 * true to show time picker (default)
271 * set minimum date from picker with id $minfrom (none by default)
273 * set maximum date from picker with id $maxfrom (none by default)
274 * @param bool $required default false
276 * @return string Parsed HTML output.
278 * @todo Once browser support is better this could probably be replaced with
279 * native HTML5 date picker.
281 function datetimesel($format, $min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false) {
283 // First day of the week (0 = Sunday)
284 $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
286 $lang = substr(get_browser_language(), 0, 2);
288 // Check if the detected language is supported by the picker
289 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"))) {
290 $lang = Config::get('system', 'language', 'en');
297 $dateformat .= 'Y-m-d';
299 if ($pickdate && $picktime) {
303 $dateformat .= 'H:i';
306 $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : '';
307 $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : '';
309 $input_text = $default ? date($dateformat, $default->getTimestamp()) : '';
310 $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : '';
314 $pickers .= ', datepicker: false';
317 $pickers .= ',timepicker: false';
321 $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'";
322 if ($minfrom != '') {
323 $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})";
325 if ($maxfrom != '') {
326 $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})";
329 $readable_format = $dateformat;
330 $readable_format = str_replace('Y','yyyy',$readable_format);
331 $readable_format = str_replace('m','mm',$readable_format);
332 $readable_format = str_replace('d','dd',$readable_format);
333 $readable_format = str_replace('H','HH',$readable_format);
334 $readable_format = str_replace('i','MM',$readable_format);
336 $tpl = get_markup_template('field_input.tpl');
337 $o .= replace_macros($tpl, array(
338 '$field' => array($id, $label, $input_text, '', (($required) ? '*' : ''), 'placeholder="' . $readable_format . '"'),
341 $o .= "<script type='text/javascript'>";
342 $o .= "\$(function () {var picker = \$('#id_$id').datetimepicker({step:5,format:'$dateformat' $minjs $maxjs $pickers $defaultdatejs}); $extra_js})";
349 * @brief Returns a relative date string.
351 * Implements "3 seconds ago" etc.
352 * Based on $posted_date, (UTC).
353 * Results relative to current timezone.
354 * Limited to range of timestamps.
356 * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
357 * @param string $format (optional) Parsed with sprintf()
358 * <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
360 * @return string with relative date
362 function relative_date($posted_date, $format = null) {
364 $localtime = $posted_date . ' UTC';
366 $abs = strtotime($localtime);
368 if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === False) {
372 $etime = time() - $abs;
375 return t('less than a second ago');
378 $a = array( 12 * 30 * 24 * 60 * 60 => array( t('year'), t('years')),
379 30 * 24 * 60 * 60 => array( t('month'), t('months')),
380 7 * 24 * 60 * 60 => array( t('week'), t('weeks')),
381 24 * 60 * 60 => array( t('day'), t('days')),
382 60 * 60 => array( t('hour'), t('hours')),
383 60 => array( t('minute'), t('minutes')),
384 1 => array( t('second'), t('seconds'))
387 foreach ($a as $secs => $str) {
391 // translators - e.g. 22 hours ago, 1 minute ago
393 $format = t('%1$d %2$s ago');
396 return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
402 * @brief Returns timezone correct age in years.
404 * Returns the age in years, given a date of birth, the timezone of the person
405 * whose date of birth is provided, and the timezone of the person viewing the
408 * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday
409 * is on New Year's. You live in San Bruno, California.
410 * When exactly are you going to see my age increase?
412 * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating
413 * and become a year older. If you wish me happy birthday on January 1
414 * (San Bruno time), you'll be a day late.
416 * @param string $dob Date of Birth
417 * @param string $owner_tz (optional) Timezone of the person of interest
418 * @param string $viewer_tz (optional) Timezone of the person viewing
420 * @return int Age in years
422 function age($dob, $owner_tz = '', $viewer_tz = '') {
423 if (! intval($dob)) {
427 $owner_tz = date_default_timezone_get();
430 $viewer_tz = date_default_timezone_get();
433 $birthdate = datetime_convert('UTC', $owner_tz,$dob . ' 00:00:00+00:00','Y-m-d');
434 list($year, $month, $day) = explode("-", $birthdate);
435 $year_diff = datetime_convert('UTC',$viewer_tz, 'now', 'Y') - $year;
436 $curr_month = datetime_convert('UTC',$viewer_tz, 'now', 'm');
437 $curr_day = datetime_convert('UTC',$viewer_tz, 'now', 'd');
439 if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
447 * @brief Get days of a month in a given year.
449 * Returns number of days in the month of the given year.
450 * $m = 1 is 'January' to match human usage.
453 * @param int $m Month (1=January, 12=December)
455 * @return int Number of days in the given month
457 function get_dim($y, $m) {
460 31, 28, 31, 30, 31, 30,
461 31, 31, 30, 31, 30, 31);
465 } elseif (((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0)) {
473 * @brief Returns the first day in month for a given month, year.
478 * @param int $m Month (1=January, 12=December)
480 * @return string day 0 = Sunday through 6 = Saturday
482 function get_first_dim($y,$m) {
483 $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
485 return datetime_convert('UTC','UTC',$d,'w');
489 * @brief Output a calendar for the given month, year.
491 * If $links are provided (array), e.g. $links[12] => 'http://mylink' ,
492 * date 12 will be linked appropriately. Today's date is also noted by
494 * Months count from 1.
497 * @param int $m Month
498 * @param bool $links (default false)
499 * @param string $class
503 * @todo Provide (prev,next) links, define class variations for different size calendars
505 function cal($y = 0,$m = 0, $links = false, $class='') {
506 // month table - start at 1 to match human usage.
509 'January', 'February', 'March',
510 'April' , 'May' , 'June',
511 'July' , 'August' , 'September',
512 'October', 'November', 'December'
515 $thisyear = datetime_convert('UTC', date_default_timezone_get(), 'now','Y');
516 $thismonth = datetime_convert('UTC', date_default_timezone_get(), 'now','m');
521 $m = intval($thismonth);
524 $dn = array('Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday');
525 $f = get_first_dim($y,$m);
531 if (($y == $thisyear) && ($m == $thismonth)) {
532 $tddate = intval(datetime_convert('UTC', date_default_timezone_get(), 'now', 'j'));
535 $str_month = day_translate($mtab[$m]);
536 $o = '<table class="calendar' . $class . '">';
537 $o .= "<caption>$str_month $y</caption><tr>";
538 for ($a = 0; $a < 7; $a ++) {
539 $o .= '<th>' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '</th>';
545 if (($dow == $f) && (! $started)) {
549 $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : '');
551 $day = str_replace(' ', ' ', sprintf('%2.2d', $d));
553 if (is_array($links) && isset($links[$d])) {
554 $o .= "<a href=\"{$links[$d]}\">$day</a>";
566 if (($dow == 7) && ($d <= $l)) {
572 for ($a = $dow; $a < 7; $a ++) {
573 $o .= '<td> </td>';
577 $o .= '</tr></table>'."\r\n";
583 * @brief Create a birthday event.
585 * Update the year and the birthday.
587 function update_contact_birthdays() {
589 // This only handles foreign or alien networks where a birthday has been provided.
590 // In-network birthdays are handled within local_delivery
592 $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` ");
593 if (DBM::is_result($r)) {
594 foreach ($r as $rr) {
596 logger('update_contact_birthday: ' . $rr['bd']);
598 $nextbd = datetime_convert('UTC','UTC','now','Y') . substr($rr['bd'], 4);
601 * Add new birthday event for this person
603 * $bdtext is just a readable placeholder in case the event is shared
604 * with others. We will replace it during presentation to our $importer
605 * to contain a sparkle link and perhaps a photo.
608 // Check for duplicates
609 $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1",
612 dbesc(datetime_convert('UTC','UTC', $nextbd)),
615 if (DBM::is_result($s)) {
619 $bdtext = sprintf( t('%s\'s birthday'), $rr['name']);
620 $bdtext2 = sprintf( t('Happy Birthday %s'), ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]') ;
622 $r = q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
623 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ",
626 dbesc(datetime_convert()),
627 dbesc(datetime_convert()),
628 dbesc(datetime_convert('UTC','UTC', $nextbd)),
629 dbesc(datetime_convert('UTC','UTC', $nextbd . ' + 1 day ')),
638 q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d",
639 dbesc(substr($nextbd,0,4)),