1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\UsersManager\UserNotifications;
use Exception;
use Piwik\Container\StaticContainer;
use Piwik\Date;
use Piwik\Log\LoggerInterface;
use Piwik\Option;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Scheduler\Schedule\Monthly;
use Piwik\Scheduler\Task;
/**
* Send user notifications for each provider
*/
class UserNotifierTask extends Task
{
public const LAST_RUN_TIME_OPTION_NAME = 'UserNotifier.lastRunTime';
public function __construct()
{
$monthlyOnFirst = new Monthly();
$monthlyOnFirst->setDay(1);
parent::__construct($this, 'dispatchNotifications', null, $monthlyOnFirst);
}
/**
* Get a list of providers (class names) that may provide user notifications to be dispatched
*
* @return array
*/
private function getUserNotificationProviderClasses(): array
{
return PluginManager::getInstance()->findMultipleComponents(
'UserNotifications',
UserNotificationProviderInterface::class
);
}
/**
* Dispatch notifications for each provider and its users
*/
public function dispatchNotifications()
{
$container = StaticContainer::getContainer();
$logger = $container->get(LoggerInterface::class);
try {
Option::set(self::LAST_RUN_TIME_OPTION_NAME, (string) Date::factory('today')->getTimestamp());
$notificationsToDispatchCount = 0;
$notificationsDispatchedCount = 0;
foreach ($this->getUserNotificationProviderClasses() as $providerClass) {
/** @var UserNotificationProviderInterface $provider */
$provider = $container->get($providerClass);
$providerUserNotificationsForDispatch = $provider->getUserNotificationsForDispatch();
$notificationsToDispatchCount += count($providerUserNotificationsForDispatch);
foreach ($providerUserNotificationsForDispatch as $userNotification) {
$dispatched = $userNotification->dispatch();
if ($dispatched) {
$provider->setUserNotificationDispatched($userNotification->getUsers());
$notificationsDispatchedCount++;
}
}
}
if ($notificationsToDispatchCount) {
$logger->info(
"Number of user notifications dispatched: {number} of {total}.",
['number' => $notificationsDispatchedCount, 'total' => $notificationsToDispatchCount]
);
} else {
$logger->info("No user notifications to dispatch, task rescheduled.");
}
} catch (Exception $ex) {
$container->get(LoggerInterface::class)->error($ex);
throw $ex;
}
}
}
|
