From d478ef6c6d93f4b7f27b40ebe6b46af9759f415f Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Wed, 24 Jan 2018 20:47:33 -0500 Subject: [PATCH] Add Util\Temporal to src - Map include/datetime functions to Temporal methods - Move update_contact_birthdays() to Model\Contact::updateBirthdays() --- include/datetime.php | 615 ++---------------------------------------- src/Model/Contact.php | 57 +++- src/Util/Temporal.php | 578 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 653 insertions(+), 597 deletions(-) create mode 100644 src/Util/Temporal.php diff --git a/include/datetime.php b/include/datetime.php index 9ff2f1ac68..ff7b2a9a61 100644 --- a/include/datetime.php +++ b/include/datetime.php @@ -4,633 +4,58 @@ * @brief Some functions for date and time related tasks. */ -use Friendica\Core\Config; -use Friendica\Core\L10n; -use Friendica\Core\PConfig; -use Friendica\Database\DBM; +use Friendica\Model\Contact; +use Friendica\Util\Temporal; -/** - * @brief Two-level sort for timezones. - * - * @param string $a - * @param string $b - * @return int - */ -function timezone_cmp($a, $b) { - if (strstr($a, '/') && strstr($b, '/')) { - if (L10n::t($a) == L10n::t($b)) { - return 0; - } - return (L10n::t($a) < L10n::t($b)) ? -1 : 1; - } - - if (strstr($a, '/')) { - return -1; - } elseif (strstr($b, '/')) { - return 1; - } elseif (L10n::t($a) == L10n::t($b)) { - return 0; - } - - return (L10n::t($a) < L10n::t($b)) ? -1 : 1; -} - -/** - * @brief Emit a timezone selector grouped (primarily) by continent - * - * @param string $current Timezone - * @return string Parsed HTML output - */ function select_timezone($current = 'America/Los_Angeles') { - - $timezone_identifiers = DateTimeZone::listIdentifiers(); - - $o =''; - return $o; + return Temporal::getTimezoneSelect($current); } - - -/** - * @brief Generating a Timezone selector - * - * Return a select using 'field_select_raw' template, with timezones - * groupped (primarily) by continent - * arguments follow convetion as other field_* template array: - * 'name', 'label', $value, 'help' - * - * @param string $name Name of the selector - * @param string $label Label for the selector - * @param string $current Timezone - * @param string $help Help text - * - * @return string Parsed HTML - */ -function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){ - $options = select_timezone($current); - $options = str_replace('','', $options); - - $tpl = get_markup_template('field_select_raw.tpl'); - return replace_macros($tpl, [ - '$field' => [$name, $label, $current, $help, $options], - ]); - +function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help = ''){ + return Temporal::getTimezoneField($name, $label, $current, $help); } -/** - * @brief General purpose date parse/convert function. - * - * @param string $from Source timezone - * @param string $to Dest timezone - * @param string $s Some parseable date/time string - * @param string $fmt Output format recognised from php's DateTime class - * http://www.php.net/manual/en/datetime.format.php - * - * @return string Formatted date according to given format - */ function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") { - - // Defaults to UTC if nothing is set, but throws an exception if set to empty string. - // Provide some sane defaults regardless. - - if ($from === '') { - $from = 'UTC'; - } - if ($to === '') { - $to = 'UTC'; - } - if ( ($s === '') || (! is_string($s)) ) { - $s = 'now'; - } - - /* - * Slight hackish adjustment so that 'zero' datetime actually returns what is intended - * otherwise we end up with -0001-11-30 ... - * add 32 days so that we at least get year 00, and then hack around the fact that - * months and days always start with 1. - */ - - if (substr($s,0,10) <= '0001-01-01') { - $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC')); - return str_replace('1','0',$d->format($fmt)); - } - - try { - $from_obj = new DateTimeZone($from); - } catch (Exception $e) { - $from_obj = new DateTimeZone('UTC'); - } - - try { - $d = new DateTime($s, $from_obj); - } catch (Exception $e) { - logger('datetime_convert: exception: ' . $e->getMessage()); - $d = new DateTime('now', $from_obj); - } - - try { - $to_obj = new DateTimeZone($to); - } catch (Exception $e) { - $to_obj = new DateTimeZone('UTC'); - } - - $d->setTimeZone($to_obj); - - return $d->format($fmt); + return Temporal::convert($s, $to, $from, $fmt); } - -/** - * @brief Wrapper for date selector, tailored for use in birthday fields. - * - * @param string $dob Date of Birth - * @return string Formatted html - */ -function dob($dob) -{ - list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d'); - - if ($dob < '0000-01-01') { - $value = ''; - } else { - $value = (($year > 1000) ? datetime_convert('UTC', 'UTC', $dob, 'Y-m-d') : datetime_convert('UTC', 'UTC', '1000-' . $month . '-'. $day, 'm-d')); - } - - $age = (intval($value) ? age($value, $a->user["timezone"], $a->user["timezone"]) : ""); - - $o = replace_macros(get_markup_template("field_input.tpl"), [ - '$field' => [ - 'dob', - L10n::t('Birthday:'), - $value, - (((intval($age)) > 0 ) ? L10n::t('Age: ') . $age : ""), - '', - 'placeholder="' . L10n::t('YYYY-MM-DD or MM-DD') . '"' - ] - ]); - - return $o; +function dob($dob) { + return Temporal::getDateofBirthField($dob); } -/** - * @brief Returns a date selector - * - * @param string $min - * Unix timestamp of minimum date - * @param string $max - * Unix timestap of maximum date - * @param string $default - * Unix timestamp of default date - * @param string $id - * ID and name of datetimepicker (defaults to "datetimepicker") - * - * @return string Parsed HTML output. - */ -function datesel($min, $max, $default, $id = 'datepicker') -{ - return datetimesel($min, $max, $default, '', $id, true, false, '', ''); +function datesel($min, $max, $default, $id = 'datepicker') { + return Temporal::getDateField($min, $max, $default, $id); } -/** - * @brief Returns a time selector - * - * @param $h - * Already selected hour - * @param $m - * Already selected minute - * @param string $id - * ID and name of datetimepicker (defaults to "timepicker") - * - * @return string Parsed HTML output. - */ -function timesel($h, $m, $id = 'timepicker') -{ - return datetimesel(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true); +function timesel($h, $m, $id = 'timepicker') { + return Temporal::getTimeField($h, $m, $id); } -/** - * @brief Returns a datetime selector. - * - * @param string $min - * unix timestamp of minimum date - * @param string $max - * unix timestap of maximum date - * @param string $default - * unix timestamp of default date - * @param string $id - * id and name of datetimepicker (defaults to "datetimepicker") - * @param bool $pickdate - * true to show date picker (default) - * @param boolean $picktime - * true to show time picker (default) - * @param $minfrom - * set minimum date from picker with id $minfrom (none by default) - * @param $maxfrom - * set maximum date from picker with id $maxfrom (none by default) - * @param bool $required default false - * - * @return string Parsed HTML output. - * - * @todo Once browser support is better this could probably be replaced with - * native HTML5 date picker. - */ -function datetimesel($min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false) -{ - // First day of the week (0 = Sunday) - $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0); - - $lang = substr(L10n::getBrowserLanguage(), 0, 2); - - // Check if the detected language is supported by the picker - 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"])) { - $lang = Config::get('system', 'language', 'en'); - } - - $o = ''; - $dateformat = ''; - - if ($pickdate) { - $dateformat .= 'Y-m-d'; - } - if ($pickdate && $picktime) { - $dateformat .= ' '; - } - if ($picktime) { - $dateformat .= 'H:i'; - } - - $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : ''; - $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : ''; - - $input_text = $default ? date($dateformat, $default->getTimestamp()) : ''; - $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : ''; - - $pickers = ''; - if (!$pickdate) { - $pickers .= ', datepicker: false'; - } - if (!$picktime) { - $pickers .= ',timepicker: false'; - } - - $extra_js = ''; - $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'"; - if ($minfrom != '') { - $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})"; - } - if ($maxfrom != '') { - $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})"; - } - - $readable_format = $dateformat; - $readable_format = str_replace('Y','yyyy',$readable_format); - $readable_format = str_replace('m','mm',$readable_format); - $readable_format = str_replace('d','dd',$readable_format); - $readable_format = str_replace('H','HH',$readable_format); - $readable_format = str_replace('i','MM',$readable_format); - - $tpl = get_markup_template('field_input.tpl'); - $o .= replace_macros($tpl, [ - '$field' => [$id, $label, $input_text, '', (($required) ? '*' : ''), 'placeholder="' . $readable_format . '"'], - ]); - - $o .= ""; - - return $o; +function datetimesel($min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, $picktime = true, $minfrom = '', $maxfrom = '', $required = false) { + return Temporal::getDateTimeField($min, $max, $default, $label, $id, $pickdate, $picktime, $minfrom, $maxfrom, $required); } -/** - * @brief Returns a relative date string. - * - * Implements "3 seconds ago" etc. - * Based on $posted_date, (UTC). - * Results relative to current timezone. - * Limited to range of timestamps. - * - * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS) - * @param string $format (optional) Parsed with sprintf() - * %1$d %2$s ago, e.g. 22 hours ago, 1 minute ago - * - * @return string with relative date - */ function relative_date($posted_date, $format = null) { - - $localtime = $posted_date . ' UTC'; - - $abs = strtotime($localtime); - - if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === false) { - return L10n::t('never'); - } - - $etime = time() - $abs; - - if ($etime < 1) { - return L10n::t('less than a second ago'); - } - - $a = [ 12 * 30 * 24 * 60 * 60 => [L10n::t('year'), L10n::t('years')], - 30 * 24 * 60 * 60 => [L10n::t('month'), L10n::t('months')], - 7 * 24 * 60 * 60 => [L10n::t('week'), L10n::t('weeks')], - 24 * 60 * 60 => [L10n::t('day'), L10n::t('days')], - 60 * 60 => [L10n::t('hour'), L10n::t('hours')], - 60 => [L10n::t('minute'), L10n::t('minutes')], - 1 => [L10n::t('second'), L10n::t('seconds')] - ]; - - foreach ($a as $secs => $str) { - $d = $etime / $secs; - if ($d >= 1) { - $r = round($d); - // translators - e.g. 22 hours ago, 1 minute ago - if (!$format) { - $format = L10n::t('%1$d %2$s ago'); - } - - return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1])); - } - } + return Temporal::getRelativeDate($posted_date, $format); } -/** - * @brief Returns timezone correct age in years. - * - * Returns the age in years, given a date of birth, the timezone of the person - * whose date of birth is provided, and the timezone of the person viewing the - * result. - * - * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday - * is on New Year's. You live in San Bruno, California. - * When exactly are you going to see my age increase? - * - * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating - * and become a year older. If you wish me happy birthday on January 1 - * (San Bruno time), you'll be a day late. - * - * @param string $dob Date of Birth - * @param string $owner_tz (optional) Timezone of the person of interest - * @param string $viewer_tz (optional) Timezone of the person viewing - * - * @return int Age in years - */ function age($dob, $owner_tz = '', $viewer_tz = '') { - if (! intval($dob)) { - return 0; - } - if (! $owner_tz) { - $owner_tz = date_default_timezone_get(); - } - if (! $viewer_tz) { - $viewer_tz = date_default_timezone_get(); - } - - $birthdate = datetime_convert('UTC', $owner_tz,$dob . ' 00:00:00+00:00','Y-m-d'); - list($year, $month, $day) = explode("-", $birthdate); - $year_diff = datetime_convert('UTC',$viewer_tz, 'now', 'Y') - $year; - $curr_month = datetime_convert('UTC',$viewer_tz, 'now', 'm'); - $curr_day = datetime_convert('UTC',$viewer_tz, 'now', 'd'); - - if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) { - $year_diff--; - } - - return $year_diff; + return Temporal::getAgeByTimezone($dob, $owner_tz, $viewer_tz); } -/** - * @brief Get days of a month in a given year. - * - * Returns number of days in the month of the given year. - * $m = 1 is 'January' to match human usage. - * - * @param int $y Year - * @param int $m Month (1=January, 12=December) - * - * @return int Number of days in the given month - */ function get_dim($y, $m) { - - $dim = [ 0, - 31, 28, 31, 30, 31, 30, - 31, 31, 30, 31, 30, 31]; - - if ($m != 2) { - return $dim[$m]; - } elseif (((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0)) { - return 29; - } - - return $dim[2]; + return Temporal::getDaysInMonth($y, $m); } -/** - * @brief Returns the first day in month for a given month, year. - * - * Months start at 1. - * - * @param int $y Year - * @param int $m Month (1=January, 12=December) - * - * @return string day 0 = Sunday through 6 = Saturday - */ function get_first_dim($y,$m) { - $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m)); - - return datetime_convert('UTC','UTC',$d,'w'); + return Temporal::getFirstDayInMonth($y, $m); } -/** - * @brief Output a calendar for the given month, year. - * - * If $links are provided (array), e.g. $links[12] => 'http://mylink' , - * date 12 will be linked appropriately. Today's date is also noted by - * altering td class. - * Months count from 1. - * - * @param int $y Year - * @param int $m Month - * @param array $links (default null) - * @param string $class - * - * @return string - * - * @todo Provide (prev,next) links, define class variations for different size calendars - */ function cal($y = 0, $m = 0, $links = null, $class = '') { - // month table - start at 1 to match human usage. - $mtab = [' ', - 'January', 'February', 'March', - 'April' , 'May' , 'June', - 'July' , 'August' , 'September', - 'October', 'November', 'December' - ]; - - $thisyear = datetime_convert('UTC', date_default_timezone_get(), 'now', 'Y'); - $thismonth = datetime_convert('UTC', date_default_timezone_get(), 'now', 'm'); - if (!$y) { - $y = $thisyear; - } - - if (!$m) { - $m = intval($thismonth); - } - - $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']; - $f = get_first_dim($y, $m); - $l = get_dim($y, $m); - $d = 1; - $dow = 0; - $started = false; - - if (($y == $thisyear) && ($m == $thismonth)) { - $tddate = intval(datetime_convert('UTC', date_default_timezone_get(), 'now', 'j')); - } - - $str_month = day_translate($mtab[$m]); - $o = ''; - $o .= ""; - for ($a = 0; $a < 7; $a ++) { - $o .= ''; - } - - $o .= ''; - - while ($d <= $l) { - if (($dow == $f) && (! $started)) { - $started = true; - } - - $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : ''); - $o .= "'; - $dow ++; - if (($dow == 7) && ($d <= $l)) { - $dow = 0; - $o .= ''; - } - } - if ($dow) { - for ($a = $dow; $a < 7; $a ++) { - $o .= ''; - } - } - - $o .= '
$str_month $y
' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '
"; - $day = str_replace(' ', ' ', sprintf('%2.2d', $d)); - if ($started) { - if (x($links, $d) !== false) { - $o .= "$day"; - } else { - $o .= $day; - } - - $d ++; - } else { - $o .= ' '; - } - - $o .= '
 
' . "\r\n"; - - return $o; + return Temporal::getCalendarTable($y, $m, $links, $class); } -/** - * @brief Create a birthday event. - * - * Update the year and the birthday. - */ function update_contact_birthdays() { - - // This only handles foreign or alien networks where a birthday has been provided. - // In-network birthdays are handled within local_delivery - - $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` "); - if (DBM::is_result($r)) { - foreach ($r as $rr) { - - logger('update_contact_birthday: ' . $rr['bd']); - - $nextbd = datetime_convert('UTC','UTC','now','Y') . substr($rr['bd'], 4); - - /* - * Add new birthday event for this person - * - * $bdtext is just a readable placeholder in case the event is shared - * with others. We will replace it during presentation to our $importer - * to contain a sparkle link and perhaps a photo. - */ - - // Check for duplicates - $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1", - intval($rr['uid']), - intval($rr['id']), - dbesc(datetime_convert('UTC','UTC', $nextbd)), - dbesc('birthday')); - - if (DBM::is_result($s)) { - continue; - } - - $bdtext = L10n::t('%s\'s birthday', $rr['name']); - $bdtext2 = L10n::t('Happy Birthday %s', ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]'); - - q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`) - VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ", - intval($rr['uid']), - intval($rr['id']), - dbesc(datetime_convert()), - dbesc(datetime_convert()), - dbesc(datetime_convert('UTC','UTC', $nextbd)), - dbesc(datetime_convert('UTC','UTC', $nextbd . ' + 1 day ')), - dbesc($bdtext), - dbesc($bdtext2), - dbesc('birthday'), - intval(0) - ); - - - // update bdyear - q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d", - dbesc(substr($nextbd,0,4)), - dbesc($nextbd), - intval($rr['uid']), - intval($rr['id']) - ); - - } - } + return Contact::updateBirthdays(); } diff --git a/src/Model/Contact.php b/src/Model/Contact.php index 3ec9f5ab48..4f3a9ca739 100644 --- a/src/Model/Contact.php +++ b/src/Model/Contact.php @@ -12,15 +12,16 @@ use Friendica\Core\PConfig; use Friendica\Core\System; use Friendica\Core\Worker; use Friendica\Database\DBM; -use Friendica\Network\Probe; use Friendica\Model\Photo; use Friendica\Model\Profile; -use Friendica\Protocol\Diaspora; +use Friendica\Network\Probe; use Friendica\Protocol\DFRN; +use Friendica\Protocol\Diaspora; use Friendica\Protocol\OStatus; use Friendica\Protocol\PortableContact; use Friendica\Protocol\Salmon; use Friendica\Util\Network; +use Friendica\Util\Temporal; use dba; require_once 'boot.php'; @@ -1468,4 +1469,56 @@ class Contact extends BaseObject Contact::remove($contact['id']); } } + + /** + * @brief Create a birthday event. + * + * Update the year and the birthday. + */ + public static function updateBirthdays() + { + // This only handles foreign or alien networks where a birthday has been provided. + // In-network birthdays are handled within local_delivery + + $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` "); + if (DBM::is_result($r)) { + foreach ($r as $rr) { + logger('update_contact_birthday: ' . $rr['bd']); + + $nextbd = Temporal::convert('now', 'UTC', 'UTC', 'Y') . substr($rr['bd'], 4); + + /* + * Add new birthday event for this person + * + * $bdtext is just a readable placeholder in case the event is shared + * with others. We will replace it during presentation to our $importer + * to contain a sparkle link and perhaps a photo. + */ + + // Check for duplicates + $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1", + intval($rr['uid']), intval($rr['id']), dbesc(Temporal::convert($nextbd)), dbesc('birthday')); + + if (DBM::is_result($s)) { + continue; + } + + $bdtext = L10n::t('%s\'s birthday', $rr['name']); + $bdtext2 = L10n::t('Happy Birthday %s', ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]'); + + q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`) + VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ", intval($rr['uid']), intval($rr['id']), + dbesc(Temporal::convert()), dbesc(Temporal::convert()), dbesc(Temporal::convert($nextbd)), + dbesc(Temporal::convert($nextbd . ' + 1 day ')), dbesc($bdtext), dbesc($bdtext2), dbesc('birthday'), + intval(0) + ); + + + // update bdyear + q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d", dbesc(substr($nextbd, 0, 4)), + dbesc($nextbd), intval($rr['uid']), intval($rr['id']) + ); + } + } + } } diff --git a/src/Util/Temporal.php b/src/Util/Temporal.php new file mode 100644 index 0000000000..1ec7741803 --- /dev/null +++ b/src/Util/Temporal.php @@ -0,0 +1,578 @@ +'; + + usort($timezone_identifiers, [self, 'timezoneCompareCallback']); + $continent = ''; + foreach ($timezone_identifiers as $value) { + $ex = explode("/", $value); + if (count($ex) > 1) { + if ($ex[0] != $continent) { + if ($continent != '') { + $o .= ''; + } + $continent = $ex[0]; + $o .= ''; + } + if (count($ex) > 2) { + $city = substr($value, strpos($value, '/') + 1); + } else { + $city = $ex[1]; + } + } else { + $city = $ex[0]; + if ($continent != L10n::t('Miscellaneous')) { + $o .= ''; + $continent = L10n::t('Miscellaneous'); + $o .= ''; + } + } + $city = str_replace('_', ' ', L10n::t($city)); + $selected = (($value == $current) ? " selected=\"selected\" " : ""); + $o .= ""; + } + $o .= ''; + return $o; + } + + /** + * @brief Generating a Timezone selector + * + * Return a select using 'field_select_raw' template, with timezones + * grouped (primarily) by continent + * arguments follow convention as other field_* template array: + * 'name', 'label', $value, 'help' + * + * @param string $name Name of the selector + * @param string $label Label for the selector + * @param string $current Timezone + * @param string $help Help text + * + * @return string Parsed HTML + */ + public static function getTimezoneField($name = 'timezone', $label = '', $current = 'America/Los_Angeles', $help = '') + { + $options = Temporal::getTimezoneSelect($current); + $options = str_replace('', '', $options); + + $tpl = get_markup_template('field_select_raw.tpl'); + return replace_macros($tpl, [ + '$field' => [$name, $label, $current, $help, $options], + ]); + } + + /** + * @brief General purpose date parse/convert function. + * + * @param string $s Some parseable date/time string + * @param string $from Source timezone + * @param string $to Dest timezone + * @param string $fmt Output format recognised from php's DateTime class + * http://www.php.net/manual/en/datetime.format.php + * + * @return string Formatted date according to given format + */ + public static function convert($s = 'now', $to = 'UTC', $from = 'UTC', $fmt = "Y-m-d H:i:s") + { + // Defaults to UTC if nothing is set, but throws an exception if set to empty string. + // Provide some sane defaults regardless. + if ($from === '') { + $from = 'UTC'; + } + + if ($to === '') { + $to = 'UTC'; + } + + if (($s === '') || (!is_string($s))) { + $s = 'now'; + } + + /* + * Slight hackish adjustment so that 'zero' datetime actually returns what is intended + * otherwise we end up with -0001-11-30 ... + * add 32 days so that we at least get year 00, and then hack around the fact that + * months and days always start with 1. + */ + + if (substr($s, 0, 10) <= '0001-01-01') { + $d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC')); + return str_replace('1', '0', $d->format($fmt)); + } + + try { + $from_obj = new DateTimeZone($from); + } catch (Exception $e) { + $from_obj = new DateTimeZone('UTC'); + } + + try { + $d = new DateTime($s, $from_obj); + } catch (Exception $e) { + logger('datetime_convert: exception: ' . $e->getMessage()); + $d = new DateTime('now', $from_obj); + } + + try { + $to_obj = new DateTimeZone($to); + } catch (Exception $e) { + $to_obj = new DateTimeZone('UTC'); + } + + $d->setTimeZone($to_obj); + + return $d->format($fmt); + } + + /** + * @brief Wrapper for date selector, tailored for use in birthday fields. + * + * @param string $dob Date of Birth + * @return string Formatted HTML + */ + public static function getDateofBirthField($dob) + { + list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d'); + + if ($dob < '0000-01-01') { + $value = ''; + } else { + $value = Temporal::convert(($year > 1000) ? $dob : '1000-' . $month . '-' . $day, 'UTC', 'UTC', 'Y-m-d'); + } + + $age = (intval($value) ? age($value, $a->user["timezone"], $a->user["timezone"]) : ""); + + $tpl = get_markup_template("field_input.tpl"); + $o = replace_macros($tpl, + [ + '$field' => [ + 'dob', + L10n::t('Birthday:'), + $value, + intval($age) > 0 ? L10n::t('Age: ') . $age : "", + '', + 'placeholder="' . L10n::t('YYYY-MM-DD or MM-DD') . '"' + ] + ]); + + return $o; + } + + /** + * @brief Returns a date selector + * + * @param string $min Unix timestamp of minimum date + * @param string $max Unix timestap of maximum date + * @param string $default Unix timestamp of default date + * @param string $id ID and name of datetimepicker (defaults to "datetimepicker") + * + * @return string Parsed HTML output. + */ + public static function getDateField($min, $max, $default, $id = 'datepicker') + { + return datetimesel($min, $max, $default, '', $id, true, false, '', ''); + } + + /** + * @brief Returns a time selector + * + * @param string $h Already selected hour + * @param string $m Already selected minute + * @param string $id ID and name of datetimepicker (defaults to "timepicker") + * + * @return string Parsed HTML output. + */ + public static function getTimeField($h, $m, $id = 'timepicker') + { + return datetimesel(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true); + } + + /** + * @brief Returns a datetime selector. + * + * @param string $min Unix timestamp of minimum date + * @param string $max Unix timestamp of maximum date + * @param string $default Unix timestamp of default date + * @param string $id Id and name of datetimepicker (defaults to "datetimepicker") + * @param bool $pickdate true to show date picker (default) + * @param bool $picktime true to show time picker (default) + * @param string $minfrom set minimum date from picker with id $minfrom (none by default) + * @param string $maxfrom set maximum date from picker with id $maxfrom (none by default) + * @param bool $required default false + * + * @return string Parsed HTML output. + * + * @todo Once browser support is better this could probably be replaced with + * native HTML5 date picker. + */ + public static function getDateTimeField($min, $max, $default, $label, $id = 'datetimepicker', $pickdate = true, + $picktime = true, $minfrom = '', $maxfrom = '', $required = false) + { + // First day of the week (0 = Sunday) + $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0); + + $lang = substr(L10n::getBrowserLanguage(), 0, 2); + + // Check if the detected language is supported by the picker + 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"])) { + $lang = Config::get('system', 'language', 'en'); + } + + $o = ''; + $dateformat = ''; + + if ($pickdate) { + $dateformat .= 'Y-m-d'; + } + + if ($pickdate && $picktime) { + $dateformat .= ' '; + } + + if ($picktime) { + $dateformat .= 'H:i'; + } + + $minjs = $min ? ",minDate: new Date({$min->getTimestamp()}*1000), yearStart: " . $min->format('Y') : ''; + $maxjs = $max ? ",maxDate: new Date({$max->getTimestamp()}*1000), yearEnd: " . $max->format('Y') : ''; + + $input_text = $default ? date($dateformat, $default->getTimestamp()) : ''; + $defaultdatejs = $default ? ",defaultDate: new Date({$default->getTimestamp()}*1000)" : ''; + + $pickers = ''; + if (!$pickdate) { + $pickers .= ', datepicker: false'; + } + + if (!$picktime) { + $pickers .= ',timepicker: false'; + } + + $extra_js = ''; + $pickers .= ",dayOfWeekStart: " . $firstDay . ",lang:'" . $lang . "'"; + if ($minfrom != '') { + $extra_js .= "\$('#id_$minfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({minDate: currentDateTime})}})"; + } + + if ($maxfrom != '') { + $extra_js .= "\$('#id_$maxfrom').data('xdsoft_datetimepicker').setOptions({onChangeDateTime: function (currentDateTime) { \$('#id_$id').data('xdsoft_datetimepicker').setOptions({maxDate: currentDateTime})}})"; + } + + $readable_format = $dateformat; + $readable_format = str_replace('Y', 'yyyy', $readable_format); + $readable_format = str_replace('m', 'mm', $readable_format); + $readable_format = str_replace('d', 'dd', $readable_format); + $readable_format = str_replace('H', 'HH', $readable_format); + $readable_format = str_replace('i', 'MM', $readable_format); + + $tpl = get_markup_template('field_input.tpl'); + $o .= replace_macros($tpl, + [ + '$field' => [ + $id, + $label, + $input_text, + '', + $required ? '*' : '', + 'placeholder="' . $readable_format . '"' + ], + ]); + + $o .= ""; + + return $o; + } + + /** + * @brief Returns a relative date string. + * + * Implements "3 seconds ago" etc. + * Based on $posted_date, (UTC). + * Results relative to current timezone. + * Limited to range of timestamps. + * + * @param string $posted_date MySQL-formatted date string (YYYY-MM-DD HH:MM:SS) + * @param string $format (optional) Parsed with sprintf() + * %1$d %2$s ago, e.g. 22 hours ago, 1 minute ago + * + * @return string with relative date + */ + public static function getRelativeDate($posted_date, $format = null) + { + $localtime = $posted_date . ' UTC'; + + $abs = strtotime($localtime); + + if (is_null($posted_date) || $posted_date <= NULL_DATE || $abs === false) { + return L10n::t('never'); + } + + $etime = time() - $abs; + + if ($etime < 1) { + return L10n::t('less than a second ago'); + } + + $a = [12 * 30 * 24 * 60 * 60 => [L10n::t('year'), L10n::t('years')], + 30 * 24 * 60 * 60 => [L10n::t('month'), L10n::t('months')], + 7 * 24 * 60 * 60 => [L10n::t('week'), L10n::t('weeks')], + 24 * 60 * 60 => [L10n::t('day'), L10n::t('days')], + 60 * 60 => [L10n::t('hour'), L10n::t('hours')], + 60 => [L10n::t('minute'), L10n::t('minutes')], + 1 => [L10n::t('second'), L10n::t('seconds')] + ]; + + foreach ($a as $secs => $str) { + $d = $etime / $secs; + if ($d >= 1) { + $r = round($d); + // translators - e.g. 22 hours ago, 1 minute ago + if (!$format) { + $format = L10n::t('%1$d %2$s ago'); + } + + return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1])); + } + } + } + + /** + * @brief Returns timezone correct age in years. + * + * Returns the age in years, given a date of birth, the timezone of the person + * whose date of birth is provided, and the timezone of the person viewing the + * result. + * + * Why? Bear with me. Let's say I live in Mittagong, Australia, and my birthday + * is on New Year's. You live in San Bruno, California. + * When exactly are you going to see my age increase? + * + * A: 5:00 AM Dec 31 San Bruno time. That's precisely when I start celebrating + * and become a year older. If you wish me happy birthday on January 1 + * (San Bruno time), you'll be a day late. + * + * @param string $dob Date of Birth + * @param string $owner_tz (optional) Timezone of the person of interest + * @param string $viewer_tz (optional) Timezone of the person viewing + * + * @return int Age in years + */ + public static function getAgeByTimezone($dob, $owner_tz = '', $viewer_tz = '') + { + if (!intval($dob)) { + return 0; + } + if (!$owner_tz) { + $owner_tz = date_default_timezone_get(); + } + if (!$viewer_tz) { + $viewer_tz = date_default_timezone_get(); + } + + $birthdate = Temporal::convert($dob . ' 00:00:00+00:00', $owner_tz, 'UTC', 'Y-m-d'); + list($year, $month, $day) = explode("-", $birthdate); + $year_diff = Temporal::convert('now', $viewer_tz, 'UTC', 'Y') - $year; + $curr_month = Temporal::convert('now', $viewer_tz, 'UTC', 'm'); + $curr_day = Temporal::convert('now', $viewer_tz, 'UTC', 'd'); + + if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) { + $year_diff--; + } + + return $year_diff; + } + + /** + * @brief Get days of a month in a given year. + * + * Returns number of days in the month of the given year. + * $m = 1 is 'January' to match human usage. + * + * @param int $y Year + * @param int $m Month (1=January, 12=December) + * + * @return int Number of days in the given month + */ + public static function getDaysInMonth($y, $m) + { + return date('t', mktime(0, 0, 0, $m, 1, $y)); + ; + } + + /** + * @brief Returns the first day in month for a given month, year. + * + * Months start at 1. + * + * @param int $y Year + * @param int $m Month (1=January, 12=December) + * + * @return string day 0 = Sunday through 6 = Saturday + */ + public static function getFirstDayInMonth($y, $m) + { + $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m)); + + return Temporal::convert($d, 'UTC', 'UTC', 'w'); + } + + /** + * @brief Output a calendar for the given month, year. + * + * If $links are provided (array), e.g. $links[12] => 'http://mylink' , + * date 12 will be linked appropriately. Today's date is also noted by + * altering td class. + * Months count from 1. + * + * @param int $y Year + * @param int $m Month + * @param array $links (default null) + * @param string $class + * + * @return string + * + * @todo Provide (prev, next) links, define class variations for different size calendars + */ + public static function getCalendarTable($y = 0, $m = 0, $links = null, $class = '') + { + // month table - start at 1 to match human usage. + $mtab = [' ', + 'January', 'February', 'March', + 'April', 'May', 'June', + 'July', 'August', 'September', + 'October', 'November', 'December' + ]; + + $thisyear = Temporal::convert('now', date_default_timezone_get(), 'UTC', 'Y'); + $thismonth = Temporal::convert('now', date_default_timezone_get(), 'UTC', 'm'); + if (!$y) { + $y = $thisyear; + } + + if (!$m) { + $m = intval($thismonth); + } + + $dn = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']; + $f = get_first_dim($y, $m); + $l = get_dim($y, $m); + $d = 1; + $dow = 0; + $started = false; + + if (($y == $thisyear) && ($m == $thismonth)) { + $tddate = intval(Temporal::convert('now', date_default_timezone_get(), 'UTC', 'j')); + } + + $str_month = day_translate($mtab[$m]); + $o = ''; + $o .= ""; + for ($a = 0; $a < 7; $a ++) { + $o .= ''; + } + + $o .= ''; + + while ($d <= $l) { + if (($dow == $f) && (!$started)) { + $started = true; + } + + $today = (((isset($tddate)) && ($tddate == $d)) ? "class=\"today\" " : ''); + $o .= "'; + $dow ++; + if (($dow == 7) && ($d <= $l)) { + $dow = 0; + $o .= ''; + } + } + + if ($dow) { + for ($a = $dow; $a < 7; $a ++) { + $o .= ''; + } + } + + $o .= '
$str_month $y
' . mb_substr(day_translate($dn[$a]), 0, 3, 'UTF-8') . '
"; + $day = str_replace(' ', ' ', sprintf('%2.2d', $d)); + if ($started) { + if (x($links, $d) !== false) { + $o .= "$day"; + } else { + $o .= $day; + } + + $d ++; + } else { + $o .= ' '; + } + + $o .= '
 
' . "\r\n"; + + return $o; + } +}