Fixed max value check, improved request value fetching

[friendica.git] / src / Util / DateTimeFormat.php

diff --git a/src/Util/DateTimeFormat.php b/src/Util/DateTimeFormat.php
index 0b47a16f1549b5fa86c4417bc1bd6949c6684c5c..41cd16d2f41464bc692a63963b6109ba1e37dee1 100644 (file)
--- a/src/Util/DateTimeFormat.php
+++ b/src/Util/DateTimeFormat.php
@@ -1,7 +1,22 @@
 <?php
-
 /**
- * @file src/Util/DateTimeFormat.php
+ * @copyright Copyright (C) 2010-2022, 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;
@@ -12,13 +27,22 @@ use DateTimeZone;
 use Exception;
 
 /**
- * @brief Temporal class
+ * Temporal class
  */
 class DateTimeFormat
 {
-       const ATOM = 'Y-m-d\TH:i:s\Z';
+       const ATOM  = 'Y-m-d\TH:i:s\Z';
        const MYSQL = 'Y-m-d H:i:s';
-       const HTTP = 'D, d M Y H:i:s \G\M\T';
+       const HTTP  = 'D, d M Y H:i:s \G\M\T';
+       const JSON  = 'Y-m-d\TH:i:s.v\Z';
+       const API   = 'D M d H:i:s +0000 Y';
+
+       static $localTimezone = 'UTC';
+
+       public static function setLocalTimeZone(string $timezone)
+       {
+               self::$localTimezone = $timezone;
+       }
 
        /**
         * convert() shorthand for UTC.
@@ -28,7 +52,7 @@ class DateTimeFormat
         * @return string
         * @throws Exception
         */
-       public static function utc($time, $format = self::MYSQL)
+       public static function utc(string $time, string $format = self::MYSQL): string
        {
                return self::convert($time, 'UTC', 'UTC', $format);
        }
@@ -43,7 +67,7 @@ class DateTimeFormat
         */
        public static function local($time, $format = self::MYSQL)
        {
-               return self::convert($time, date_default_timezone_get(), 'UTC', $format);
+               return self::convert($time, self::$localTimezone, 'UTC', $format);
        }
 
        /**
@@ -78,13 +102,13 @@ class DateTimeFormat
         * @return string
         * @throws Exception
         */
-       public static function utcNow($format = self::MYSQL)
+       public static function utcNow(string $format = self::MYSQL): string
        {
                return self::utc('now', $format);
        }
 
        /**
-        * @brief General purpose date parse/convert/format function.
+        * General purpose date parse/convert/format function.
         *
         * @param string $s       Some parseable date/time string
         * @param string $tz_to   Destination timezone
@@ -134,7 +158,7 @@ class DateTimeFormat
                try {
                        $d = new DateTime($s, $from_obj);
                } catch (Exception $e) {
-                       Logger::log('DateTimeFormat::convert: exception: ' . $e->getMessage());
+                       Logger::notice('DateTimeFormat::convert: exception: ' . $e->getMessage());
                        $d = new DateTime('now', $from_obj);
                }
 
@@ -144,8 +168,62 @@ class DateTimeFormat
                        $to_obj = new DateTimeZone('UTC');
                }
 
-               $d->setTimeZone($to_obj);
+               $d->setTimezone($to_obj);
 
                return $d->format($format);
        }
+
+       /**
+        * Checks, if the given string is a date with the pattern YYYY-MM
+        *
+        * @param string $dateString The given date
+        *
+        * @return boolean True, if the date is a valid pattern
+        */
+       public function isYearMonth(string $dateString)
+       {
+               // Check format (2019-01, 2019-1, 2019-10)
+               if (!preg_match('/^([12]\d{3}-(1[0-2]|0[1-9]|\d))$/', $dateString)) {
+                       return false;
+               }
+
+               $date = DateTime::createFromFormat('Y-m', $dateString);
+
+               if (!$date) {
+                       return false;
+               }
+
+               try {
+                       $now = new DateTime();
+               } catch (\Throwable $t) {
+                       return false;
+               }
+
+               if ($date > $now) {
+                       return false;
+               }
+
+               return true;
+       }
+
+       /**
+        * Checks, if the given string is a date with the pattern YYYY-MM-DD
+        *
+        * @param string $dateString The given date
+        *
+        * @return boolean True, if the date is a valid pattern
+        */
+       public function isYearMonthDay(string $dateString)
+       {
+               $date = DateTime::createFromFormat('Y-m-d', $dateString);
+               if (!$date) {
+                       return false;
+               }
+
+               if (DateTime::getLastErrors()['error_count'] || DateTime::getLastErrors()['warning_count']) {
+                       return false;
+               }
+
+               return true;
+       }
 }