open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

feat(contacts): Show time difference for users in different timezones

Browse Source 
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
pull/50214/head
Ferdinand Thiessen 12 months ago
parent b2d1df7f87
commit 84f0fc88cc
No known key found for this signature in database
GPG Key ID: 45FAE7268762B400
2 changed files with 123 additions and 32 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 49
      lib/private/Contacts/ContactsMenu/Providers/LocalTimeProvider.php
  2. 106
      tests/lib/Contacts/ContactsMenu/Providers/LocalTimeProviderTest.php

49
lib/private/Contacts/ContactsMenu/Providers/LocalTimeProvider.php
Unescape View File

@ -17,6 +17,7 @@ use OCP\IConfig;
use OCP\IDateTimeFormatter;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\L10N\IFactory as IL10NFactory;
class LocalTimeProvider implements IProvider {
@ -28,6 +29,7 @@ class LocalTimeProvider implements IProvider {
private ITimeFactory $timeFactory,
private IDateTimeFormatter $dateTimeFormatter,
private IConfig $config,
private IUserSession $currentSession,
) {
}
@ -35,14 +37,51 @@ class LocalTimeProvider implements IProvider {
$targetUserId = $entry->getProperty('UID');
$targetUser = $this->userManager->get($targetUserId);
if (!empty($targetUser)) {
$timezone = $this->config->getUserValue($targetUser->getUID(), 'core', 'timezone') ?: $this->config->getSystemValueString('default_timezone', 'UTC');
$dateTimeZone = new \DateTimeZone($timezone);
$localTime = $this->dateTimeFormatter->formatTime($this->timeFactory->getDateTime(), 'short', $dateTimeZone);
$timezoneStringTarget = $this->config->getUserValue($targetUser->getUID(), 'core', 'timezone') ?: $this->config->getSystemValueString('default_timezone', 'UTC');
$timezoneTarget = new \DateTimeZone($timezoneStringTarget);
$localTimeTarget = $this->timeFactory->getDateTime('now', $timezoneTarget);
$localTimeString = $this->dateTimeFormatter->formatTime($localTimeTarget, 'short', $timezoneTarget);
$iconUrl = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'actions/recent.svg'));
$l = $this->l10nFactory->get('lib');
$profileActionText = $l->t('Local time: %s', [$localTime]);
$currentUser = $this->currentSession->getUser();
if ($currentUser !== null) {
$timezoneStringCurrent = $this->config->getUserValue($currentUser->getUID(), 'core', 'timezone') ?: $this->config->getSystemValueString('default_timezone', 'UTC');
$timezoneCurrent = new \DateTimeZone($timezoneStringCurrent);
$localTimeCurrent = $this->timeFactory->getDateTime('now', $timezoneCurrent);
// Get the timezone offsets to GMT on this very time (needed to handle daylight saving time)
$timeOffsetCurrent = $timezoneCurrent->getOffset($localTimeCurrent);
$timeOffsetTarget = $timezoneTarget->getOffset($localTimeTarget);
// Get the difference between the current users offset to GMT and then targets user to GMT
$timeOffset = $timeOffsetTarget - $timeOffsetCurrent;
if ($timeOffset === 0) {
// No offset means both users are in the same timezone
$timeOffsetString = $l->t('same time');
} else {
// We need to cheat here as the offset could be up to 26h we can not use formatTime.
$hours = abs((int)($timeOffset / 3600));
$minutes = abs(($timeOffset / 60) % 60);
// TRANSLATORS %n hours in a short form
$hoursString = $l->n('%nh', '%nh', $hours);
// TRANSLATORS %n minutes in a short form
$minutesString = $l->n('%nm', '%nm', $minutes);
$timeOffsetString = ($hours > 0 ? $hoursString : '') . ($minutes > 0 ? $minutesString : '');
if ($timeOffset > 0) {
// TRANSLATORS meaning the user is %s time ahead - like 1h30m
$timeOffsetString = $l->t('%s ahead', [$timeOffsetString]);
} else {
// TRANSLATORS meaning the user is %s time behind - like 1h30m
$timeOffsetString = $l->t('%s behind', [$timeOffsetString]);
}
}
$profileActionText = "{$localTimeString} • {$timeOffsetString}";
} else {
$profileActionText = $l->t('Local time: %s', [$localTimeString]);
}
$iconUrl = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'actions/recent.svg'));
$action = $this->actionFactory->newLinkAction($iconUrl, $profileActionText, '#', 'timezone');
// Order after the profile page
$action->setPriority(19);

106
tests/lib/Contacts/ContactsMenu/Providers/LocalTimeProviderTest.php
Unescape View File

@ -20,27 +20,22 @@ use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\L10N\IFactory as IL10NFactory;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;
class LocalTimeProviderTest extends TestCase {
/** @var IActionFactory|MockObject */
private $actionFactory;
/** @var IL10N|MockObject */
private $l;
/** @var IL10NFactory|MockObject */
private $l10nFactory;
/** @var IURLGenerator|MockObject */
private $urlGenerator;
/** @var IUserManager|MockObject */
private $userManager;
/** @var ITimeFactory|MockObject */
private $timeFactory;
/** @var IDateTimeFormatter|MockObject */
private $dateTimeFormatter;
/** @var IConfig|MockObject */
private $config;
private IActionFactory&MockObject $actionFactory;
private IL10N&MockObject $l;
private IL10NFactory&MockObject $l10nFactory;
private IURLGenerator&MockObject $urlGenerator;
private IUserManager&MockObject $userManager;
private ITimeFactory&MockObject $timeFactory;
private IUserSession&MockObject $userSession;
private IDateTimeFormatter&MockObject $dateTimeFormatter;
private IConfig&MockObject $config;
private LocalTimeProvider $provider;
@ -55,11 +50,18 @@ class LocalTimeProviderTest extends TestCase {
->will($this->returnCallback(function ($text, $parameters = []) {
return vsprintf($text, $parameters);
}));
$this->l->expects($this->any())
->method('n')
->will($this->returnCallback(function ($text, $textPlural, $n, $parameters = []) {
$formatted = str_replace('%n', (string)$n, $n === 1 ? $text : $textPlural);
return vsprintf($formatted, $parameters);
}));
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->userManager = $this->createMock(IUserManager::class);
$this->timeFactory = $this->createMock(ITimeFactory::class);
$this->dateTimeFormatter = $this->createMock(IDateTimeFormatter::class);
$this->config = $this->createMock(IConfig::class);
$this->userSession = $this->createMock(IUserSession::class);
$this->provider = new LocalTimeProvider(
$this->actionFactory,
@ -68,11 +70,50 @@ class LocalTimeProviderTest extends TestCase {
$this->userManager,
$this->timeFactory,
$this->dateTimeFormatter,
$this->config
$this->config,
$this->userSession,
);
}
public function testProcess(): void {
public static function dataTestProcess(): array {
return [
'no current user' => [
false,
null,
null,
'Local time: 10:24',
],
'both UTC' => [
true,
null,
null,
'10:24 • same time',
],
'both same time zone' => [
true,
'Europe/Berlin',
'Europe/Berlin',
'11:24 • same time',
],
'1h behind' => [
true,
'Europe/Berlin',
'Europe/London',
'10:24 • 1h behind',
],
'4:45h ahead' => [
true,
'Europe/Berlin',
'Asia/Kathmandu',
'16:09 • 4h45m ahead',
],
];
}
/**
* @dataProvider dataTestProcess
*/
public function testProcess(bool $hasCurrentUser, ?string $currentUserTZ, ?string $targetUserTZ, string $expected): void {
$entry = $this->createMock(IEntry::class);
$entry->expects($this->once())
->method('getProperty')
@ -91,18 +132,29 @@ class LocalTimeProviderTest extends TestCase {
->with('lib')
->willReturn($this->l);
$this->config->method('getUserValue')
->with('user1', 'core', 'timezone')
->willReturn('America/Los_Angeles');
$this->config->method('getSystemValueString')
->with('default_timezone', 'UTC')
->willReturn('UTC');
$this->config
->method('getUserValue')
->willReturnMap([
['user1', 'core', 'timezone', '', $targetUserTZ],
['currentUser', 'core', 'timezone', '', $currentUserTZ],
]);
if ($hasCurrentUser) {
$currentUser = $this->createMock(IUser::class);
$currentUser->method('getUID')
->willReturn('currentUser');
$this->userSession->method('getUser')
->willReturn($currentUser);
}
$now = new \DateTime('2023-01-04 10:24:43');
$this->timeFactory->method('getDateTime')
->willReturn($now);
->willReturnCallback(fn ($time, $tz) => (new \DateTime('2023-01-04 10:24:43', new \DateTimeZone('UTC')))->setTimezone($tz));
$now = new \DateTime('2023-01-04 10:24:43');
$this->dateTimeFormatter->method('formatTime')
->with($now, 'short', $this->anything())
->willReturn('01:24');
->willReturnCallback(fn (\DateTime $time) => $time->format('H:i'));
$this->urlGenerator->method('imagePath')
->willReturn('actions/recent.svg');
@ -115,7 +167,7 @@ class LocalTimeProviderTest extends TestCase {
->method('newLinkAction')
->with(
'https://localhost/actions/recent.svg',
'Local time: 01:24',
$expected,
'#',
'timezone'
)

Write Preview
Loading…
Cancel
Save