mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-06-23 18:28:49 +02:00
Use the users timezone for showing dates from the database.
In the database the values are now saved in UTC.
This commit is contained in:
parent
adf5db1a0a
commit
d2bae3a4f2
5 changed files with 191 additions and 0 deletions
|
@ -16,6 +16,9 @@ doctrine:
|
||||||
collate: utf8mb4_unicode_ci
|
collate: utf8mb4_unicode_ci
|
||||||
|
|
||||||
url: '%env(resolve:DATABASE_URL)%'
|
url: '%env(resolve:DATABASE_URL)%'
|
||||||
|
types:
|
||||||
|
datetime: App\Helpers\UTCDateTimeType
|
||||||
|
date: App\Helpers\UTCDateTimeType
|
||||||
|
|
||||||
schema_filter: ~^(?!internal|log)~
|
schema_filter: ~^(?!internal|log)~
|
||||||
|
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
locale: 'en' # Set the default language to use her
|
locale: 'en' # Set the default language to use her
|
||||||
|
timezone: 'Europe/Berlin'
|
||||||
partdb_title: 'Part-DB' # The title shown inside of Part-DB (e.g. in the navbar and on homepage)
|
partdb_title: 'Part-DB' # The title shown inside of Part-DB (e.g. in the navbar and on homepage)
|
||||||
banner: '' # The info text shown in the homepage
|
banner: '' # The info text shown in the homepage
|
||||||
use_gravatar: true # Set to false, if no Gravatar images should be used for user profiles.
|
use_gravatar: true # Set to false, if no Gravatar images should be used for user profiles.
|
||||||
|
@ -69,6 +70,10 @@ services:
|
||||||
arguments:
|
arguments:
|
||||||
$base_currency: '%default_currency%'
|
$base_currency: '%default_currency%'
|
||||||
|
|
||||||
|
App\EventSubscriber\TimezoneListener:
|
||||||
|
arguments:
|
||||||
|
$timezone: '%timezone%'
|
||||||
|
|
||||||
App\Services\TranslationExtractor\PermissionExtractor:
|
App\Services\TranslationExtractor\PermissionExtractor:
|
||||||
tags:
|
tags:
|
||||||
- { name: 'translation.extractor', alias: 'permissionExtractor'}
|
- { name: 'translation.extractor', alias: 'permissionExtractor'}
|
104
src/EventSubscriber/TimezoneListener.php
Normal file
104
src/EventSubscriber/TimezoneListener.php
Normal file
|
@ -0,0 +1,104 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* part-db version 0.1
|
||||||
|
* Copyright (C) 2005 Christoph Lechner
|
||||||
|
* http://www.cl-projects.de/
|
||||||
|
*
|
||||||
|
* part-db version 0.2+
|
||||||
|
* Copyright (C) 2009 K. Jacobs and others (see authors.php)
|
||||||
|
* http://code.google.com/p/part-db/
|
||||||
|
*
|
||||||
|
* Part-DB Version 0.4+
|
||||||
|
* Copyright (C) 2016 - 2019 Jan Böhmer
|
||||||
|
* https://github.com/jbtronics
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or
|
||||||
|
* modify it under the terms of the GNU General Public License
|
||||||
|
* as published by the Free Software Foundation; either version 2
|
||||||
|
* 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 General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program; if not, write to the Free Software
|
||||||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace App\EventSubscriber;
|
||||||
|
|
||||||
|
|
||||||
|
use App\Entity\UserSystem\User;
|
||||||
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||||
|
use Symfony\Component\HttpKernel\Event\ControllerEvent;
|
||||||
|
use Symfony\Component\HttpKernel\KernelEvents;
|
||||||
|
use Symfony\Component\Security\Core\Security;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The purpose of this event listener is to set the timezone to the one preferred by the user.
|
||||||
|
* @package App\EventSubscriber
|
||||||
|
*/
|
||||||
|
class TimezoneListener implements EventSubscriberInterface
|
||||||
|
{
|
||||||
|
|
||||||
|
protected $default_timezone;
|
||||||
|
protected $security;
|
||||||
|
|
||||||
|
public function __construct(string $timezone, Security $security)
|
||||||
|
{
|
||||||
|
$this->default_timezone = $timezone;
|
||||||
|
$this->security = $security;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function setTimeZone(ControllerEvent $event)
|
||||||
|
{
|
||||||
|
$timezone = null;
|
||||||
|
|
||||||
|
//Check if the user has set a timezone
|
||||||
|
$user = $this->security->getUser();
|
||||||
|
if ($user instanceof User && !empty($user->getTimezone())) {
|
||||||
|
$timezone = $user->getTimezone();
|
||||||
|
}
|
||||||
|
|
||||||
|
//Fill with default value if needed
|
||||||
|
if ($timezone === null && !empty($this->default_timezone)) {
|
||||||
|
$timezone = $this->default_timezone;
|
||||||
|
}
|
||||||
|
|
||||||
|
//If timezone was configured anywhere set it, otherwise just use the one from php.ini
|
||||||
|
if ($timezone !== null) {
|
||||||
|
date_default_timezone_set($timezone);
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an array of event names this subscriber wants to listen to.
|
||||||
|
*
|
||||||
|
* The array keys are event names and the value can be:
|
||||||
|
*
|
||||||
|
* * The method name to call (priority defaults to 0)
|
||||||
|
* * An array composed of the method name to call and the priority
|
||||||
|
* * An array of arrays composed of the method names to call and respective
|
||||||
|
* priorities, or 0 if unset
|
||||||
|
*
|
||||||
|
* For instance:
|
||||||
|
*
|
||||||
|
* * ['eventName' => 'methodName']
|
||||||
|
* * ['eventName' => ['methodName', $priority]]
|
||||||
|
* * ['eventName' => [['methodName1', $priority], ['methodName2']]]
|
||||||
|
*
|
||||||
|
* @return array The event names to listen to
|
||||||
|
*/
|
||||||
|
public static function getSubscribedEvents()
|
||||||
|
{
|
||||||
|
//Set the timezone shortly before executing the controller
|
||||||
|
return [
|
||||||
|
KernelEvents::CONTROLLER => 'setTimeZone'
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
|
@ -68,6 +68,7 @@ class UserSettingsType extends AbstractType
|
||||||
'attr' => ['class' => 'selectpicker', 'data-live-search' => true],
|
'attr' => ['class' => 'selectpicker', 'data-live-search' => true],
|
||||||
'placeholder' => $this->trans->trans('user_settings.timezone.placeholder'),
|
'placeholder' => $this->trans->trans('user_settings.timezone.placeholder'),
|
||||||
'label' => $this->trans->trans('user.timezone.label'),
|
'label' => $this->trans->trans('user.timezone.label'),
|
||||||
|
'preferred_choices' => ['Europe/Berlin']
|
||||||
])
|
])
|
||||||
->add('theme', ChoiceType::class, [
|
->add('theme', ChoiceType::class, [
|
||||||
'required' => false,
|
'required' => false,
|
||||||
|
|
78
src/Helpers/UTCDateTimeType.php
Normal file
78
src/Helpers/UTCDateTimeType.php
Normal file
|
@ -0,0 +1,78 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* part-db version 0.1
|
||||||
|
* Copyright (C) 2005 Christoph Lechner
|
||||||
|
* http://www.cl-projects.de/
|
||||||
|
*
|
||||||
|
* part-db version 0.2+
|
||||||
|
* Copyright (C) 2009 K. Jacobs and others (see authors.php)
|
||||||
|
* http://code.google.com/p/part-db/
|
||||||
|
*
|
||||||
|
* Part-DB Version 0.4+
|
||||||
|
* Copyright (C) 2016 - 2019 Jan Böhmer
|
||||||
|
* https://github.com/jbtronics
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or
|
||||||
|
* modify it under the terms of the GNU General Public License
|
||||||
|
* as published by the Free Software Foundation; either version 2
|
||||||
|
* 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 General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program; if not, write to the Free Software
|
||||||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace App\Helpers;
|
||||||
|
|
||||||
|
use Doctrine\DBAL\Platforms\AbstractPlatform;
|
||||||
|
use Doctrine\DBAL\Types\ConversionException;
|
||||||
|
use Doctrine\DBAL\Types\DateTimeType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This DateTimeType all dates to UTC, so it can be later used with the timezones.
|
||||||
|
* Taken from here: https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/cookbook/working-with-datetime.html
|
||||||
|
* @package App\Helpers
|
||||||
|
*/
|
||||||
|
class UTCDateTimeType extends DateTimeType
|
||||||
|
{
|
||||||
|
private static $utc;
|
||||||
|
|
||||||
|
public function convertToDatabaseValue($value, AbstractPlatform $platform)
|
||||||
|
{
|
||||||
|
if ($value instanceof \DateTime) {
|
||||||
|
$value->setTimezone(self::$utc);
|
||||||
|
}
|
||||||
|
|
||||||
|
return parent::convertToDatabaseValue($value, $platform);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function convertToPHPValue($value, AbstractPlatform $platform)
|
||||||
|
{
|
||||||
|
if (null === $value || $value instanceof \DateTime) {
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
$converted = \DateTime::createFromFormat(
|
||||||
|
$platform->getDateTimeFormatString(),
|
||||||
|
$value,
|
||||||
|
self::$utc ? self::$utc : self::$utc = new \DateTimeZone('UTC')
|
||||||
|
);
|
||||||
|
|
||||||
|
if (! $converted) {
|
||||||
|
throw ConversionException::conversionFailedFormat(
|
||||||
|
$value,
|
||||||
|
$this->getName(),
|
||||||
|
$platform->getDateTimeFormatString()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $converted;
|
||||||
|
}
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue