]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/Temporal.php
Merge pull request #13161 from annando/bluesky-activities
[friendica.git] / src / Util / Temporal.php
index 4bc2b03d1b3108feb38f64865890a14bc466af98..acafb66ab60538949a9b0cacd2540b19b2bc7382 100644 (file)
@@ -1,16 +1,33 @@
 <?php
-
 /**
- * @file src/Util/Temporal.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
 
 namespace Friendica\Util;
 
 use DateTime;
 use DateTimeZone;
-use Friendica\Core\L10n;
 use Friendica\Core\Renderer;
 use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Util\Clock\SystemClock;
+use Psr\Clock\ClockInterface;
 
 /**
  * Temporal class
@@ -22,9 +39,10 @@ class Temporal
         *
         * @param string $a
         * @param string $b
+        *
         * @return int
         */
-       private static function timezoneCompareCallback($a, $b)
+       private static function timezoneCompareCallback(string $a, string $b): int
        {
                if (strstr($a, '/') && strstr($b, '/')) {
                        if (DI::l10n()->t($a) == DI::l10n()->t($b)) {
@@ -48,9 +66,10 @@ class Temporal
         * Emit a timezone selector grouped (primarily) by continent
         *
         * @param string $current Timezone
+        *
         * @return string Parsed HTML output
         */
-       public static function getTimezoneSelect($current = 'America/Los_Angeles')
+       public static function getTimezoneSelect(string $current = 'America/Los_Angeles'): string
        {
                $timezone_identifiers = DateTimeZone::listIdentifiers();
 
@@ -105,7 +124,7 @@ class Temporal
         * @return string Parsed HTML
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function getTimezoneField($name = 'timezone', $label = '', $current = 'America/Los_Angeles', $help = '')
+       public static function getTimezoneField(string $name = 'timezone', string $label = '', string $current = 'America/Los_Angeles', string $help = ''): string
        {
                $options = self::getTimezoneSelect($current);
                $options = str_replace('<select id="timezone_select" name="timezone">', '', $options);
@@ -122,21 +141,25 @@ class Temporal
         *
         * @param string $dob Date of Birth
         * @param string $timezone
+        *
         * @return string Formatted HTML
         * @throws \Exception
         */
-       public static function getDateofBirthField(string $dob, string $timezone = 'UTC')
+       public static function getDateofBirthField(string $dob, string $timezone = 'UTC'): string
        {
                list($year, $month, $day) = sscanf($dob, '%4d-%2d-%2d');
 
                if ($dob < '0000-01-01') {
                        $value = '';
+                       $age = 0;
+               } elseif ($dob < '0001-00-00') {
+                       $value = substr($dob, 5);
+                       $age = 0;
                } else {
-                       $value = DateTimeFormat::utc(($year > 1000) ? $dob : '1000-' . $month . '-' . $day, 'Y-m-d');
+                       $value = DateTimeFormat::utc($dob, 'Y-m-d');
+                       $age = self::getAgeByTimezone($value, $timezone);
                }
 
-               $age = (intval($value) ? self::getAgeByTimezone($value, $timezone, $timezone) : "");
-
                $tpl = Renderer::getMarkupTemplate("field_input.tpl");
                $o = Renderer::replaceMacros($tpl,
                        [
@@ -144,7 +167,7 @@ class Temporal
                                'dob',
                                DI::l10n()->t('Birthday:'),
                                $value,
-                               intval($age) > 0 ? DI::l10n()->t('Age: ') . $age : "",
+                               intval($age) > 0 ? DI::l10n()->t('Age: ') . DI::l10n()->tt('%d year old', '%d years old', $age) : '',
                                '',
                                'placeholder="' . DI::l10n()->t('YYYY-MM-DD or MM-DD') . '"'
                        ]
@@ -164,7 +187,7 @@ class Temporal
         * @return string Parsed HTML output.
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function getDateField($min, $max, $default, $id = 'datepicker')
+       public static function getDateField(DateTime $min, DateTime $max, DateTime $default, string $id = 'datepicker'): string
        {
                return self::getDateTimeField($min, $max, $default, '', $id, true, false, '', '');
        }
@@ -179,7 +202,7 @@ class Temporal
         * @return string Parsed HTML output.
         * @throws \Exception
         */
-       public static function getTimeField($h, $m, $id = 'timepicker')
+       public static function getTimeField(string $h, string $m, string $id = 'timepicker'): string
        {
                return self::getDateTimeField(new DateTime(), new DateTime(), new DateTime("$h:$m"), '', $id, false, true);
        }
@@ -207,24 +230,24 @@ class Temporal
        public static function getDateTimeField(
                DateTime $minDate,
                DateTime $maxDate,
-               DateTime $defaultDate,
+               DateTime $defaultDate = null,
                $label,
-               $id       = 'datetimepicker',
-               $pickdate = true,
-               $picktime = true,
-               $minfrom  = '',
-               $maxfrom  = '',
-               $required = false)
+               string $id       = 'datetimepicker',
+               bool $pickdate = true,
+               bool $picktime = true,
+               string $minfrom  = '',
+               string $maxfrom  = '',
+               bool $required = false): string
        {
                // First day of the week (0 = Sunday)
-               $firstDay = DI::pConfig()->get(local_user(), 'system', 'first_day_of_week', 0);
+               $firstDay = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'calendar', 'first_day_of_week', 0);
 
-               $lang = substr(L10n::getCurrentLang(), 0, 2);
+               $lang = substr(DI::l10n()->getCurrentLang(), 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"])) {
+                               ['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 = 'en';
                }
 
@@ -253,7 +276,11 @@ class Temporal
                                $id,
                                $label,
                                $input_text,
-                               '',
+                               DI::l10n()->t(
+                                       'Time zone: <strong>%s</strong> <a href="%s">Change in Settings</a>',
+                                       str_replace('_', ' ', DI::app()->getTimeZone()) . ' (GMT ' . DateTimeFormat::localNow('P') . ')',
+                                       DI::baseUrl() . '/settings'
+                               ),
                                $required ? '*' : '',
                                'placeholder="' . $readable_format . '"'
                        ],
@@ -266,7 +293,7 @@ class Temporal
                                'lang' => $lang,
                                'minfrom' => $minfrom,
                                'maxfrom' => $maxfrom,
-                       ]
+                       ],
                ]);
 
                return $o;
@@ -280,27 +307,40 @@ class Temporal
         * 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()
-        *    <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
+        * @param string|null         $posted_date  MySQL-formatted date string (YYYY-MM-DD HH:MM:SS)
+        * @param bool                $compare_time Compare date (false) or date and time (true). "true" is default.
+        * @param ClockInterface|null $clock
+        *                                  <tt>%1$d %2$s ago</tt>, e.g. 22 hours ago, 1 minute ago
         *
         * @return string with relative date
         */
-       public static function getRelativeDate($posted_date, $format = null)
+       public static function getRelativeDate(string $posted_date = null, bool $compare_time = true, ClockInterface $clock = null): string
        {
-               $localtime = $posted_date . ' UTC';
+               if (empty($posted_date) || $posted_date <= DBA::NULL_DATETIME) {
+                       return DI::l10n()->t('never');
+               }
+
+               $clock = $clock ?? new SystemClock();
 
+               $localtime = $posted_date . ' UTC';
                $abs = strtotime($localtime);
 
-               if (is_null($posted_date) || $posted_date <= DBA::NULL_DATETIME || $abs === false) {
+               if ($abs === false) {
                        return DI::l10n()->t('never');
                }
 
+               $now = $clock->now()->getTimestamp();
+
+               if (!$compare_time) {
+                       $now = mktime(0, 0, 0, date('m', $now), date('d', $now), date('Y', $now));
+                       $abs = mktime(0, 0, 0, date('m', $abs), date('d', $abs), date('Y', $abs));
+               }
+
                $isfuture = false;
-               $etime = time() - $abs;
+               $etime = $now - $abs;
 
-               if ($etime < 1 && $etime >= 0) {
-                       return DI::l10n()->t('less than a second ago');
+               if ($etime >= 0 && $etime < 1) {
+                       return $compare_time ? DI::l10n()->t('less than a second ago') : DI::l10n()->t('today');
                }
 
                if ($etime < 0){
@@ -308,27 +348,26 @@ class Temporal
                        $isfuture = true;
                }
 
-               $a = [12 * 30 * 24 * 60 * 60 => [DI::l10n()->t('year'), DI::l10n()->t('years')],
+               $a = [
+                       12 * 30 * 24 * 60 * 60 => [DI::l10n()->t('year'), DI::l10n()->t('years')],
                        30 * 24 * 60 * 60 => [DI::l10n()->t('month'), DI::l10n()->t('months')],
                        7 * 24 * 60 * 60 => [DI::l10n()->t('week'), DI::l10n()->t('weeks')],
                        24 * 60 * 60 => [DI::l10n()->t('day'), DI::l10n()->t('days')],
                        60 * 60 => [DI::l10n()->t('hour'), DI::l10n()->t('hours')],
                        60 => [DI::l10n()->t('minute'), DI::l10n()->t('minutes')],
-                       1 => [DI::l10n()->t('second'), DI::l10n()->t('seconds')]
+                       1 => [DI::l10n()->t('second'), DI::l10n()->t('seconds')],
                ];
 
                foreach ($a as $secs => $str) {
                        $d = $etime / $secs;
                        if ($d >= 1) {
-                               $r = round($d);
+                               $r = floor($d);
                                // translators - e.g. 22 hours ago, 1 minute ago
-                               if (!$format) {
-                                       if($isfuture){
-                                               $format = DI::l10n()->t('in %1$d %2$s');
-                                       }
-                                       else {
-                                               $format = DI::l10n()->t('%1$d %2$s ago');
-                                       }
+                               if($isfuture){
+                                       $format = DI::l10n()->t('in %1$d %2$s');
+                               }
+                               else {
+                                       $format = DI::l10n()->t('%1$d %2$s ago');
                                }
 
                                return sprintf($format, $r, (($r == 1) ? $str[0] : $str[1]));
@@ -339,48 +378,27 @@ class Temporal
        /**
         * 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.
+        * Returns the age in years, given a date of birth and the timezone of the person
+        * whose date of birth is provided.
         *
-        * @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
+        * @param string $dob      Date of Birth
+        * @param string $timezone Timezone of the person of interest
         *
         * @return int Age in years
         * @throws \Exception
         */
-       public static function getAgeByTimezone($dob, $owner_tz = '', $viewer_tz = '')
+       public static function getAgeByTimezone(string $dob, string $timezone): int
        {
                if (!intval($dob)) {
                        return 0;
                }
-               if (!$owner_tz) {
-                       $owner_tz = date_default_timezone_get();
-               }
-               if (!$viewer_tz) {
-                       $viewer_tz = date_default_timezone_get();
-               }
 
-               $birthdate = DateTimeFormat::convert($dob . ' 00:00:00+00:00', $owner_tz, 'UTC', 'Y-m-d');
-               list($year, $month, $day) = explode("-", $birthdate);
-               $year_diff  = DateTimeFormat::timezoneNow($viewer_tz, 'Y') - $year;
-               $curr_month = DateTimeFormat::timezoneNow($viewer_tz, 'm');
-               $curr_day   = DateTimeFormat::timezoneNow($viewer_tz, 'd');
+               $birthdate = new DateTime($dob . ' 00:00:00', new DateTimeZone($timezone));
+               $currentDate = new DateTime('now', new DateTimeZone('UTC'));
 
-               if (($curr_month < $month) || (($curr_month == $month) && ($curr_day < $day))) {
-                       $year_diff--;
-               }
+               $interval = $birthdate->diff($currentDate);
 
-               return $year_diff;
+               return (int) $interval->format('%y');
        }
 
        /**
@@ -394,7 +412,7 @@ class Temporal
         *
         * @return int Number of days in the given month
         */
-       public static function getDaysInMonth($y, $m)
+       public static function getDaysInMonth(int $y, int $m): int
        {
                return date('t', mktime(0, 0, 0, $m, 1, $y));
        }
@@ -410,7 +428,7 @@ class Temporal
         * @return string day 0 = Sunday through 6 = Saturday
         * @throws \Exception
         */
-       private static function getFirstDayInMonth($y, $m)
+       private static function getFirstDayInMonth(int $y, int $m): string
        {
                $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
 
@@ -435,7 +453,7 @@ class Temporal
         * @throws \Exception
         * @todo  Provide (prev, next) links, define class variations for different size calendars
         */
-       public static function getCalendarTable($y = 0, $m = 0, $links = null, $class = '')
+       public static function getCalendarTable(int $y = 0, int $m = 0, array $links = null, string $class = ''): string
        {
                // month table - start at 1 to match human usage.
                $mtab = [' ',