Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathZone.php
More file actions
401 lines (363 loc) · 11.6 KB
/
Copy pathZone.php
File metadata and controls
401 lines (363 loc) · 11.6 KB
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<?php
/**
* -------------------------------------------------------------------------
* Carbon plugin for GLPI
*
* @copyright Copyright (C) 2024-2025 Teclib' and contributors.
* @license https://www.gnu.org/licenses/gpl-3.0.txt GPLv3+
* @link https://github.com/pluginsGLPI/carbon
*
* -------------------------------------------------------------------------
*
* LICENSE
*
* This file is part of Carbon plugin for GLPI.
*
* 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* -------------------------------------------------------------------------
*/
namespace GlpiPlugin\Carbon;
use CommonDBTM;
use CommonDropdown;
use CommonGLPI;
use DateTime;
use DbUtils;
use Location as GlpiLocation;
use LogicException;
use Override;
use Session;
/**
* Usage profile of a computer
*/
class Zone extends CommonDropdown
{
#[Override]
public static function getTypeName($nb = 0)
{
return _n("Carbon intensity zone", "Carbon intensity zones", $nb, 'carbon');
}
#[Override]
public static function canCreate(): bool
{
return false;
}
#[Override]
public static function canUpdate(): bool
{
return true;
}
#[Override]
public static function canDelete(): bool
{
return false;
}
#[Override]
public static function canPurge(): bool
{
return false;
}
#[Override]
public function defineTabs($options = [])
{
$tabs = parent::defineTabs($options);
$this->addStandardTab(Source::class, $tabs, $options);
return $tabs;
}
#[Override]
public function getTabNameForItem(CommonGLPI $item, $withtemplate = 0)
{
if (!$withtemplate) {
$nb = 0;
/** @var CommonDBTM $item */
switch ($item->getType()) {
case Source::class:
if ($_SESSION['glpishow_count_on_tabs']) {
$nb = (new DbUtils())->countElementsInTable(
Source_Zone::getTable(),
[Source::getForeignKeyField() => $item->getID()]
);
}
return self::createTabEntry(self::getTypeName(Session::getPluralNumber()), $nb);
}
}
return '';
}
#[Override]
public function prepareInputForUpdate($input)
{
unset($input['name']);
return $input;
}
#[Override]
public static function displayTabContentForItem(CommonGLPI $item, $tabnum = 1, $withtemplate = 0)
{
/** @var CommonDBTM $item */
switch ($item->getType()) {
case Source::class:
Source_Zone::showForSource($item);
}
return true;
}
#[Override]
public function rawSearchOptions()
{
$tab = parent::rawSearchOptions();
$tab[] = [
'id' => SearchOptions::HISTORICAL_DATA_DL_ENABLED,
'table' => Source_Zone::getTable(),
'field' => 'is_download_enabled',
'name' => __('Download enabled', 'carbon'),
'datatype' => 'bool',
'joinparams' => [
'jointype' => 'child',
],
];
return $tab;
}
// /**
// * Get a zone by a location criteria
// *
// * @param CommonDBTM $item
// * @return Zone|null
// * @todo : de-staticify the method
// */
// public static function getByLocation(CommonDBTM $item): ?Zone
// {
// if ($item->isNewItem()) {
// return null;
// }
// $request = self::getByLocationRequest();
// $request['WHERE'] = [
// Location::getTableField('locations_id') => $item->getID(),
// ];
// $zone = new self();
// if (!$zone->getFromDBByRequest($request)) {
// return null;
// }
// return $zone;
// }
// /**
// * Get the request fragment to find a zone by location
// *
// * @return array Request fragment
// */
// private static function getByLocationRequest(): array
// {
// $location_table = Location::getTable();
// $source_zone_table = Source_Zone::getTable();
// $zone_table = Zone::getTable();
// return [
// 'INNER JOIN' => [
// $source_zone_table => [
// 'FKEY' => [
// $zone_table => 'id',
// $source_zone_table => 'plugin_carbon_zones_id',
// ]
// ],
// $location_table => [
// 'FKEY' => [
// $location_table => 'plugin_carbon_sources_zones_id',
// $source_zone_table => 'id'
// ]
// ],
// ],
// ];
// }
/**
* Get the request fragment to find a zone by asset
* @template T of CommonDBTM
* @param class-string<T> $itemtype asset type
* @return array Request fragment
*/
private static function getByAssetRequest(string $itemtype): array
{
$dbUtil = new DbUtils();
$location_table = $dbUtil->getTableForItemType(Location::class);
$source_zone_table = $dbUtil->getTableForItemType(Source_Zone::class);
$zone_table = $dbUtil->getTableForItemType(Zone::class);
$itemtype_table = $dbUtil->getTableForItemType($itemtype);
$request = [
'INNER JOIN' => [
$source_zone_table => [
'FKEY' => [
$zone_table => 'id',
$source_zone_table => 'plugin_carbon_zones_id',
],
],
$location_table => [
'FKEY' => [
$location_table => 'plugin_carbon_sources_zones_id',
$source_zone_table => 'id',
],
],
$itemtype_table => [
'FKEY' => [
$itemtype_table => 'locations_id',
$location_table => 'locations_id',
],
],
],
];
return $request;
}
/**
* Get a zone by an asset criteria
*
* @param CommonDBTM $item
* @return bool
*/
public function getByAsset(CommonDBTM $item): bool
{
if (!isset($item->fields[GlpiLocation::getForeignKeyField()])) {
return false;
}
if ($item->isNewItem()) {
return false;
}
$request = self::getByAssetRequest($item->getType());
$request['WHERE'] = [
$item::getTableField('id') => $item->getID(),
];
return $this->getFromDBByRequest($request);
}
/**
* Check if the zone has a historical data source.
* It does not checks if carbon intensity samples are available.
*
* @return bool
*/
public function hasHistoricalDataSource(): bool
{
if ($this->isNewItem()) {
return false;
}
$source_zone_table = getTableForItemType(Source_Zone::class);
$source_table = getTableForItemType(Source::class);
$zone_table = getTableForItemType(Zone::class);
$source = new Source();
return $source->getFromDBByRequest([
'INNER JOIN' => [
$source_zone_table => [
'ON' => [
$source_table => 'id',
$source_zone_table => getForeignKeyFieldForItemType(Source::class),
],
],
$zone_table => [
'ON' => [
$zone_table => 'id',
$source_zone_table => self::getForeignKeyField(),
],
],
],
'WHERE' => [
self::getTableField('id') => $this->fields['id'],
Source::getTableField('is_carbon_intensity_source') => 1,
Source::getTableField('fallback_level') => 0,
],
]);
}
/**
* Get the zone the asset belongs to
* Location's country must match a zone name
*
* @param CommonDBTM $item
* @param null|DateTime $date Date for which the zone must be found
* @param bool $use_country Do not search by state first
* @return bool true if found in DB, false otherwise
*/
public function getByItem(CommonDBTM $item, ?DateTime $date = null, bool $use_country = false): bool
{
if ($item->isNewItem()) {
return false;
}
// TODO: use date to find where was the asset at the given date
if ($date === null) {
$item_table = $item->getTable();
$glpi_location_table = GlpiLocation::getTable();
$zone_table = Zone::getTable();
$request = [
'INNER JOIN' => [
$glpi_location_table => [
'FKEY' => [
$zone_table => 'name',
$glpi_location_table => 'state',
],
],
$item_table => [
'FKEY' => [
$item_table => GlpiLocation::getForeignKeyField(),
$glpi_location_table => 'id',
],
],
],
'WHERE' => [
$item_table . '.id' => $item->getID(),
],
];
$found = false;
if (!$use_country) {
$found = $this->getFromDBByRequest($request);
}
if ($found) {
return true;
}
// no state found, fallback to country
$request['INNER JOIN'][$glpi_location_table]['FKEY'][$glpi_location_table] = 'country';
return $this->getFromDBByRequest($request);
}
throw new LogicException('Not implemented yet');
}
/**
* Undocumented function
*
* @param int $source_id
* @return array a request fragment
*/
public static function getRestrictBySourceCondition(int $source_id): array
{
$source_zone_table = Source_Zone::getTable();
$zone_table = Zone::getTable();
return [
'LEFT JOIN' => [
$source_zone_table => [
'FKEY' => [
$source_zone_table => 'plugin_carbon_zones_id',
$zone_table => 'id',
],
],
],
'WHERE' => [
Source_Zone::getTableField('plugin_carbon_sources_id') => $source_id,
],
];
}
/**
* get or create an item
*
* @param array $params
* @param array $where
* @return self|null
*/
public function getOrCreate(array $params, array $where): ?self
{
if (!$this->getFromDBByCrit($where)) {
$this->add(array_merge($where, $params));
return $this;
}
$this->update(array_merge($where, $params, ['id' => $this->getID()]));
return $this;
}
}
You can’t perform that action at this time.