/
Utilities.php
162 lines (144 loc) · 5.03 KB
/
Utilities.php
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
152
153
154
155
156
157
158
159
160
161
162
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\services;
use Craft;
use craft\base\UtilityInterface;
use craft\events\RegisterComponentTypesEvent;
use craft\queue\QueueInterface;
use craft\utilities\AssetIndexes;
use craft\utilities\ClearCaches;
use craft\utilities\DbBackup;
use craft\utilities\DeprecationErrors;
use craft\utilities\FindAndReplace;
use craft\utilities\Migrations;
use craft\utilities\PhpInfo;
use craft\utilities\ProjectConfig as ProjectConfigUtility;
use craft\utilities\QueueManager;
use craft\utilities\SystemMessages as SystemMessagesUtility;
use craft\utilities\SystemReport;
use craft\utilities\Updates as UpdatesUtility;
use craft\utilities\Upgrade;
use yii\base\Component;
/**
* The Utilities service provides APIs for managing utilities.
*
* An instance of the service is available via [[\craft\base\ApplicationTrait::getUtilities()|`Craft::$app->utilities()`]].
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0.0
*/
class Utilities extends Component
{
/**
* @event RegisterComponentTypesEvent The event that is triggered when registering utilities.
*
* Utilities must implement [[UtilityInterface]]. [[\craft\base\Utility]] provides a base implementation.
*
* Read more about creating utilities in the [documentation](https://craftcms.com/docs/4.x/extend/utilities.html).
* ---
* ```php
* use craft\events\RegisterComponentTypesEvent;
* use craft\services\Utilities;
* use yii\base\Event;
*
* Event::on(Utilities::class,
* Utilities::EVENT_REGISTER_UTILITY_TYPES,
* function(RegisterComponentTypesEvent $event) {
* $event->types[] = MyUtilityType::class;
* }
* );
* ```
*/
public const EVENT_REGISTER_UTILITY_TYPES = 'registerUtilityTypes';
/**
* Returns all available utility type classes.
*
* @return string[]
* @phpstan-return class-string<UtilityInterface>[]
*/
public function getAllUtilityTypes(): array
{
$utilityTypes = [
Upgrade::class,
UpdatesUtility::class,
SystemReport::class,
ProjectConfigUtility::class,
PhpInfo::class,
];
if (Craft::$app->getEdition() === Craft::Pro) {
$utilityTypes[] = SystemMessagesUtility::class;
}
if (!empty(Craft::$app->getVolumes()->getAllVolumes())) {
$utilityTypes[] = AssetIndexes::class;
}
// Ensure we only implement queue if we can use the corresponding web based controller.
if (Craft::$app->getQueue() instanceof QueueInterface) {
$utilityTypes[] = QueueManager::class;
}
$utilityTypes[] = ClearCaches::class;
$utilityTypes[] = DeprecationErrors::class;
$utilityTypes[] = DbBackup::class;
$utilityTypes[] = FindAndReplace::class;
$utilityTypes[] = Migrations::class;
$event = new RegisterComponentTypesEvent([
'types' => $utilityTypes,
]);
$this->trigger(self::EVENT_REGISTER_UTILITY_TYPES, $event);
$disabledUtilities = array_flip(Craft::$app->getConfig()->getGeneral()->disabledUtilities);
return array_values(array_filter($event->types, function(string $class) use ($disabledUtilities) {
/** @var string|UtilityInterface $class */
return !isset($disabledUtilities[$class::id()]);
}));
}
/**
* Returns all utility type classes that the user has permission to use.
*
* @return string[]
*/
public function getAuthorizedUtilityTypes(): array
{
$utilityTypes = [];
foreach ($this->getAllUtilityTypes() as $class) {
if ($this->checkAuthorization($class)) {
$utilityTypes[] = $class;
}
}
return $utilityTypes;
}
/**
* Returns whether the current user is authorized to use a given utility.
*
* @param string $class The utility class
* @phpstan-param class-string<UtilityInterface> $class
* @return bool
*/
public function checkAuthorization(string $class): bool
{
/** @var string|UtilityInterface $class */
/** @phpstan-var class-string<UtilityInterface>|UtilityInterface $class */
$utilityId = $class::id();
$user = Craft::$app->getUser();
return $utilityId === ProjectConfigUtility::id() ? $user->getIsAdmin() : $user->checkPermission('utility:' . $utilityId);
}
/**
* Returns a utility class by its ID
*
* @param string $id
* @return string|null
*/
public function getUtilityTypeById(string $id): ?string
{
foreach ($this->getAllUtilityTypes() as $class) {
/** @var string|UtilityInterface $class */
/** @phpstan-var class-string<UtilityInterface>|UtilityInterface $class */
if ($class::id() === $id) {
return $class;
}
}
return null;
}
}