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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Joas Schilling <coding@schilljs.com>
* @author John Molakvoæ <skjnldsv@protonmail.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/
namespace OC;
use Closure;
use OC\AppFramework\Bootstrap\Coordinator;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Services\InitialStateProvider;
use OCP\IInitialStateService;
use OCP\IServerContainer;
use Psr\Log\LoggerInterface;
class InitialStateService implements IInitialStateService {
/** @var LoggerInterface */
private $logger;
/** @var string[][] */
private $states = [];
/** @var Closure[][] */
private $lazyStates = [];
/** @var Coordinator */
private $bootstrapCoordinator;
/** @var IServerContainer */
private $container;
public function __construct(LoggerInterface $logger, Coordinator $bootstrapCoordinator, IServerContainer $container) {
$this->logger = $logger;
$this->bootstrapCoordinator = $bootstrapCoordinator;
$this->container = $container;
}
public function provideInitialState(string $appName, string $key, $data): void {
// Scalars and JsonSerializable are fine
if (is_scalar($data) || $data instanceof \JsonSerializable || is_array($data)) {
if (!isset($this->states[$appName])) {
$this->states[$appName] = [];
}
$this->states[$appName][$key] = json_encode($data);
return;
}
$this->logger->warning('Invalid '. $key . ' data provided to provideInitialState by ' . $appName);
}
public function provideLazyInitialState(string $appName, string $key, Closure $closure): void {
if (!isset($this->lazyStates[$appName])) {
$this->lazyStates[$appName] = [];
}
$this->lazyStates[$appName][$key] = $closure;
}
/**
* Invoke all callbacks to populate the `states` property
*/
private function invokeLazyStateCallbacks(): void {
foreach ($this->lazyStates as $app => $lazyStates) {
foreach ($lazyStates as $key => $lazyState) {
$startTime = microtime(true);
$this->provideInitialState($app, $key, $lazyState());
$endTime = microtime(true);
$duration = $endTime - $startTime;
if ($duration > 1) {
$this->logger->warning('Lazy initial state provider for {key} took {duration} seconds.', [
'app' => $app,
'key' => $key,
'duration' => round($duration, 2),
]);
}
}
}
$this->lazyStates = [];
}
/**
* Load the lazy states via the IBootstrap mechanism
*/
private function loadLazyStates(): void {
$context = $this->bootstrapCoordinator->getRegistrationContext();
if ($context === null) {
// To early, nothing to do yet
return;
}
$initialStates = $context->getInitialStates();
foreach ($initialStates as $initialState) {
try {
$provider = $this->container->query($initialState->getService());
} catch (QueryException $e) {
// Log an continue. We can be fault tolerant here.
$this->logger->error('Could not load initial state provider dynamically: ' . $e->getMessage(), [
'exception' => $e,
'app' => $initialState->getAppId(),
]);
continue;
}
if (!($provider instanceof InitialStateProvider)) {
// Log an continue. We can be fault tolerant here.
$this->logger->error('Initial state provider is not an InitialStateProvider instance: ' . $initialState->getService(), [
'app' => $initialState->getAppId(),
]);
}
$this->provideInitialState($initialState->getAppId(), $provider->getKey(), $provider);
}
}
public function getInitialStates(): array {
$this->invokeLazyStateCallbacks();
$this->loadLazyStates();
$appStates = [];
foreach ($this->states as $app => $states) {
foreach ($states as $key => $value) {
$appStates["$app-$key"] = $value;
}
}
return $appStates;
}
}
|
