friendica/src/Util/DateTimeFormat.php

256 lines
6.5 KiB
PHP

<?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 Friendica\Core\Logger;
use DateTime;
use DateTimeZone;
use Exception;
/**
* Temporal class
*/
class DateTimeFormat
{
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 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.
*
* @param string $time A date/time string
* @param string $format DateTime format string or Temporal constant
* @return string
* @throws Exception
*/
public static function utc(string $time, string $format = self::MYSQL): string
{
return self::convert($time, 'UTC', 'UTC', $format);
}
/**
* convert() shorthand for local.
*
* @param string $time A date/time string
* @param string $format DateTime format string or Temporal constant
* @return string
* @throws Exception
*/
public static function local($time, $format = self::MYSQL)
{
return self::convert($time, self::$localTimezone, 'UTC', $format);
}
/**
* convert() shorthand for timezoned now.
*
* @param $timezone
* @param string $format DateTime format string or Temporal constant
* @return string
* @throws Exception
*/
public static function timezoneNow($timezone, $format = self::MYSQL)
{
return self::convert('now', $timezone, 'UTC', $format);
}
/**
* convert() shorthand for local now.
*
* @param string $format DateTime format string or Temporal constant
* @return string
* @throws Exception
*/
public static function localNow($format = self::MYSQL)
{
return self::local('now', $format);
}
/**
* convert() shorthand for UTC now.
*
* @param string $format DateTime format string or Temporal constant
* @return string
* @throws Exception
*/
public static function utcNow(string $format = self::MYSQL): string
{
return self::utc('now', $format);
}
/**
* General purpose date parse/convert/format function.
*
* @param string $s Some parseable date/time string
* @param string $tz_to Destination timezone
* @param string $tz_from Source timezone
* @param string $format 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
* @throws Exception
*/
public static function convert(string $s = 'now', string $tz_to = 'UTC', string $tz_from = 'UTC', string $format = self::MYSQL): string
{
// Defaults to UTC if nothing is set, but throws an exception if set to empty string.
// Provide some sane defaults regardless.
if ($tz_from === '') {
$tz_from = 'UTC';
}
if ($tz_to === '') {
$tz_to = 'UTC';
}
if (($s === '') || (!is_string($s))) {
$s = 'now';
}
// Lowest possible datetime value
if (substr($s, 0, 10) <= '0001-01-01') {
$d = new DateTime('now', new DateTimeZone('UTC'));
$d->setDate(1, 1, 1)->setTime(0, 0);
return $d->format($format);
}
try {
$from_obj = new DateTimeZone($tz_from);
} catch (Exception $e) {
$from_obj = new DateTimeZone('UTC');
}
try {
$d = new DateTime($s, $from_obj);
} catch (Exception $e) {
try {
$d = new DateTime(self::fix($s), $from_obj);
} catch (\Throwable $e) {
Logger::warning('DateTimeFormat::convert: exception: ' . $e->getMessage());
$d = new DateTime('now', $from_obj);
}
}
try {
$to_obj = new DateTimeZone($tz_to);
} catch (Exception $e) {
$to_obj = new DateTimeZone('UTC');
}
$d->setTimezone($to_obj);
return $d->format($format);
}
/**
* Fix weird date formats.
*
* Note: This method isn't meant to sanitize valid date/time strings, for example it will mangle relative date
* strings like "now - 3 days".
*
* @see \Friendica\Test\src\Util\DateTimeFormatTest::dataFix() for a list of examples handled by this method.
* @param string $dateString
* @return string
*/
public static function fix(string $dateString): string
{
$search = ['Mär', 'März', 'Mai', 'Juni', 'Juli', 'Okt', 'Dez', 'ET' , 'ZZ', ' - ', '&#x2B;', '&amp;#43;', ' (Coordinated Universal Time)'];
$replace = ['Mar', 'Mar' , 'May', 'Jun' , 'Jul' , 'Oct', 'Dec', 'EST', 'Z' , ', ' , '+' , '+' , ''];
$dateString = str_replace($search, $replace, $dateString);
$pregPatterns = [
['#(\w+), (\d+ \w+ \d+) (\d+:\d+:\d+) (.+)#', '$2 $3 $4'],
['#(\d+:\d+) (\w+), (\w+) (\d+), (\d+)#', '$1 $2 $3 $4 $5'],
];
foreach ($pregPatterns as $pattern) {
$dateString = preg_replace($pattern[0], $pattern[1], $dateString);
}
return $dateString;
}
/**
* 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;
}
}