Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathLocation.php
More file actions
747 lines (684 loc) · 24.8 KB
/
Copy pathLocation.php
File metadata and controls
747 lines (684 loc) · 24.8 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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
<?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 CommonDBChild;
use CommonDBTM;
use CommonGLPI;
use Config as GlpiConfig;
use DateTime;
use DBmysql;
use DBmysqlIterator;
use DbUtils;
use Geocoder\Exception\Exception;
use Geocoder\Exception\QuotaExceeded;
use Geocoder\Geocoder;
use Geocoder\Query\GeocodeQuery;
use Glpi\Application\View\TemplateRenderer;
use Glpi\DBAL\QueryExpression;
use GlpiPlugin\Carbon\DataSource\Lca\Boaviztapi\Client as BoaviztapiClient;
use Html;
use League\ISO3166\ISO3166;
use Location as GlpiLocation;
use LogicException;
use MassiveAction;
use Override;
/**
* Additional data for a location. Extends the Location object from GLPI with aditional fields
*/
class Location extends CommonDBChild
{
// From CommonDBRelation
public static $itemtype = GlpiLocation::class;
public static $items_id = 'locations_id';
#[Override]
public static function getIcon()
{
return 'ti ti-map-2';
}
#[Override]
public function getTabNameForItem(CommonGLPI $item, $withtemplate = 0)
{
if ($item instanceof GlpiLocation) {
return self::createTabEntry(__('Environmental impact', 'carbon'), 0);
}
return '';
}
#[Override]
public static function displayTabContentForItem(CommonGLPI $item, $tabnum = 1, $withtemplate = 0)
{
if ($item instanceof GlpiLocation) {
/** @var GlpiLocation $item */
$location = new self();
$location->showForLocation($item);
}
return true;
}
#[Override]
public function prepareInputForAdd($input)
{
if (isset($input['plugin_carbon_sources_id']) && isset($input['plugin_carbon_zones_id'])) {
$source_zone = new Source_Zone();
$source_zone->getFromDBByCrit([
'plugin_carbon_sources_id' => $input['plugin_carbon_sources_id'],
'plugin_carbon_zones_id' => $input['plugin_carbon_zones_id'],
]);
if (!$source_zone->isNewItem()) {
$input['plugin_carbon_sources_zones_id'] = $source_zone->getID();
}
}
return $input;
}
#[Override]
public function prepareInputForUpdate($input)
{
if (isset($input['plugin_carbon_sources_id']) && isset($input['plugin_carbon_zones_id'])) {
$source_zone = new Source_Zone();
$source_zone->getFromDBByCrit([
'plugin_carbon_sources_id' => $input['plugin_carbon_sources_id'],
'plugin_carbon_zones_id' => $input['plugin_carbon_zones_id'],
]);
if (!$source_zone->isNewItem()) {
$input['plugin_carbon_sources_zones_id'] = $source_zone->getID();
} else {
$input['plugin_carbon_sources_zones_id'] = 0;
}
}
if (($input['plugin_carbon_sources_id'] ?? 0) == 0) {
$input['plugin_carbon_sources_zones_id'] = 0;
}
return $input;
}
public function showForLocation(GlpiLocation $item, array $options = [])
{
/** @var DBmysql $DB */
global $DB;
$this->getFromDBByCrit(['locations_id' => $item->getID()]);
if ($this->isNewItem()) {
$this->add(['locations_id' => $item->getID()]);
}
$source_zone_table = Source_Zone::getTable();
$source_table = Source::getTable();
$iterator = $DB->request([
'SELECT' => [
Source_Zone::getTableField('plugin_carbon_sources_id') . ' AS sources_id',
Source_Zone::getTableField('plugin_carbon_zones_id') . ' AS zones_id',
],
'FROM' => $source_table,
'LEFT JOIN' => [
$source_zone_table => [
'FKEY' => [
$source_zone_table => 'plugin_carbon_sources_id',
$source_table => 'id',
],
],
],
'WHERE' => [
'is_carbon_intensity_source' => 1,
Source_Zone::getTableField('id') => $this->fields['plugin_carbon_sources_zones_id'],
],
]);
$row = $iterator->current();
$source_id = $row['sources_id'] ?? 0;
$zone_id = $row['zones_id'] ?? 0;
if ($source_id === 0) {
$zone_id = 0;
}
TemplateRenderer::getInstance()->display('@carbon/location.html.twig', [
'item' => $this,
'params' => [
'candel' => false,
],
'source_id' => $source_id,
'zone_id' => $zone_id,
'zone_condition' => Zone::getRestrictBySourceCondition($source_id),
]);
return true;
}
#[Override]
public static function showMassiveActionsSubForm(MassiveAction $ma)
{
switch ($ma->getAction()) {
case 'MassUpdateBoaviztaZone':
echo '<div>';
echo __('Boavizta zone', 'carbon') . ' ';
BoaviztapiClient::dropdownBoaviztaZone('_boavizta_zone');
echo '</div>';
echo '<br /><br />' . Html::submit(_x('button', 'Post'), ['name' => 'massiveaction']);
return true;
case 'MassUpdateCarbonIntensityFeed':
echo '<div>';
echo __('Carbon intensity source and zone', 'carbon') . ' ';
$template_renderer = TemplateRenderer::getInstance();
$template_renderer->display('@carbon/components/form/source_zone_selector.html.twig', [
'source_id' => 0,
'zone_id' => 0,
'zone_condition' => [],
]);
echo '</div>';
echo '<br /><br />' . Html::submit(_x('button', 'Post'), ['name' => 'massiveaction']);
return true;
}
return parent::showMassiveActionsSubForm($ma);
}
#[Override]
public static function processMassiveActionsForOneItemtype(MassiveAction $ma, CommonDBTM $item, array $ids)
{
switch ($ma->getAction()) {
case 'MassUpdateBoaviztaZone':
foreach ($ids as $id) {
if ($item->getFromDB($id) && self::updateBoaviztaZone($item, $ma->POST['_boavizta_zone'])) {
$ma->itemDone($item->getType(), $id, MassiveAction::ACTION_OK);
} else {
$ma->itemDone($item->getType(), $id, MassiveAction::ACTION_KO);
}
}
return;
case 'MassUpdateCarbonIntensityFeed':
$source_zone = new Source_Zone();
$source_zone->getFromDBByCrit([
'plugin_carbon_sources_id' => $ma->POST['plugin_carbon_sources_id'] ?? 0,
'plugin_carbon_zones_id' => $ma->POST['plugin_carbon_zones_id'] ?? 0,
]);
if ($source_zone->isNewItem()) {
$input['plugin_carbon_sources_zones_id'] = $source_zone->getID();
foreach ($ids as $id) {
$ma->itemDone(get_class($item), $id, MassiveAction::ACTION_KO);
}
return;
}
foreach ($ids as $id) {
if ($item->getFromDB($id) && self::updateCarbonIntensitySourceZone($item, $source_zone)) {
$ma->itemDone(get_class($item), $id, MassiveAction::ACTION_OK);
} else {
$ma->itemDone(get_class($item), $id, MassiveAction::ACTION_KO);
}
}
return;
}
}
/**
* Update the location with the Boavizta zone
*
* @param CommonDBTM $item Computer to update
* @param string $zone pwoer consumption to set
* @return bool
*/
public static function updateBoaviztaZone(CommonDBTM $item, string $zone): bool
{
$location = new self();
$core_location_id = $item->getID();
$location->getFromDBByCrit([
'locations_id' => $core_location_id,
]);
if ($location->isNewItem()) {
$id = $location->add([
'locations_id' => $core_location_id,
'boavizta_zone' => $zone,
]);
return !$location->isNewId($id);
} else {
return $location->update([
'id' => $location->getID(),
'boavizta_zone' => $zone,
]);
}
}
public static function updateCarbonIntensitySourceZone(CommonDBTM $item, Source_Zone $source_zone): bool
{
return $item->update([
'id' => $item->getID(),
'_plugin_carbon_sources_zones_id' => $source_zone->getID(),
]);
}
#[Override]
public static function getSpecificValueToDisplay($field, $values, array $options = [])
{
switch ($field) {
case 'boavizta_zone':
$categories = BoaviztapiClient::getZones();
return $categories[$values['boavizta_zone']] ?? '';
}
return '';
}
#[Override]
public static function getSpecificValueToSelect($field, $name = '', $values = '', array $options = [])
{
switch ($field) {
case 'boavizta_zone':
$options['values'] = $values;
return BoaviztapiClient::dropdownBoaviztaZone($name, $options);
}
return '';
}
/**
* callback when a GLPI location is added
*
* @param CommonDBTM $item
* @param Geocoder $geocoder
* @return void
*/
public function onGlpiLocationAdd(CommonDBTM $item, Geocoder $geocoder)
{
$enabled = GlpiConfig::getConfigurationValue('plugin:carbon', 'geocoding_enabled');
if (!empty($enabled)) {
if (!isset($item->input['_boavizta_zone']) || $item->input['_boavizta_zone'] == '' || $item->input['_boavizta_zone'] == '0') {
try {
$item->input['_boavizta_zone'] = $this->getCountryCode($item, $geocoder);
} catch (QuotaExceeded $e) {
trigger_error($e->getMessage(), E_USER_WARNING);
}
}
}
$this->setBoaviztaZone($item);
}
/**
* callback when a GLPI location is updated
*
* @param CommonDBTM $item
* @return void
*/
public function onGlpiLocationUpdate(CommonDBTM $item)
{
$this->enableCarbonIntensityDownload($item);
}
/**
* callback when a GLPI location is updated
*
* @param CommonDBTM $item
* @param Geocoder $geocoder
* @return void
*/
public function onGlpiLocationPreUpdate(CommonDBTM $item, Geocoder $geocoder)
{
$enabled = GlpiConfig::getConfigurationValue('plugin:carbon', 'geocoding_enabled');
if (!empty($enabled)) {
if (!isset($item->input['_boavizta_zone']) || $item->input['_boavizta_zone'] == '0') {
try {
$item->input['_boavizta_zone'] = $this->getCountryCode($item, $geocoder);
} catch (QuotaExceeded $e) {
trigger_error($e->getMessage(), E_USER_WARNING);
}
}
}
$this->setBoaviztaZone($item);
$this->setSourceZone($item);
}
/**
* Enable download of carbon intensity data for a location
*
* @param CommonDBTM $item Location
* @return bool true if a zone download has been enabled
*/
protected function enableCarbonIntensityDownload(CommonDBTM $item): bool
{
$source_zone = new Source_Zone();
/** @var GlpiLocation $item */
$source_zone->getFromDbByItem($item);
if ($source_zone->isNewItem()) {
return false;
}
return $source_zone->toggleZone(true);
}
/**
* Tells if the carbon intensity download is enabled
*
* @param CommonDBTM $item
* @return bool
*/
public function isCarbonIntensityDownloadEnabled(CommonDBTM $item): bool
{
$source_zone = new Source_Zone();
/** @var GlpiLocation $item */
if (!$source_zone->getFromDbByItem($item)) {
return false;
}
return $source_zone->fields['is_download_enabled'] === 1;
}
/**
* Get request to find carbon intensity sources
*
* @param array $crit Criterias
* @return array
*/
public static function getCarbonIntensityDataSourceRequest(array $crit = []): array
{
$carbon_intensity_table = CarbonIntensity::getTable();
$source_zone_table = Source_Zone::getTable();
$source_table = Source::getTable();
$location_table = Location::getTable();
$source_zone_fk = Source_Zone::getForeignKeyField();
$source_fk = Source::getForeignKeyField();
$zone_fk = Zone::getForeignKeyField();
$request = [
'COUNT' => 'count',
'FROM' => $location_table,
'INNER JOIN' => [
$source_zone_table => [
'ON' => [
$source_zone_table => 'id',
$location_table => $source_zone_fk,
],
],
$source_table => [
'ON' => [
$source_table => 'id',
$source_zone_table => $source_fk,
[
'AND' => [
Source::getTableField('is_carbon_intensity_source') => 1,
],
],
],
],
],
'LEFT JOIN' => [
$source_zone_table . ' AS alternate_sources_zones' => [
'ON' => [
$source_zone_table => 'plugin_carbon_zones_id',
'alternate_sources_zones' => 'plugin_carbon_zones_id',
],
],
$source_table . ' AS alternate_sources' => [
'ON' => [
'alternate_sources' => 'id',
'alternate_sources_zones' => $source_fk,
[
'AND' => [
'alternate_sources.is_carbon_intensity_source' => 1,
'alternate_sources.fallback_level' => ['>', new QueryExpression(Source::getTableField('fallback_level'))],
],
],
],
],
$carbon_intensity_table => [
'ON' => [
$carbon_intensity_table => $zone_fk,
$source_zone_table => $zone_fk,
[
'AND' => [
'OR' => [
[CarbonIntensity::getTableField($source_fk) => new QueryExpression(Source_Zone::getTableField($source_fk))],
[CarbonIntensity::getTableField($source_fk) => new QueryExpression('alternate_sources_zones.' . $source_fk)],
],
],
],
],
],
],
'WHERE' => $crit,
];
return $request;
}
/**
* Tells if a location has fallback carbon intensity data
*
* @param CommonDBTM $item
* @return bool
*/
public function hasFallbackCarbonIntensityData(CommonDBTM $item): bool
{
/** @var DBmysql $DB */
global $DB;
if ($item->getType() === GlpiLocation::class) {
$location_id = $item->getID();
} else {
$location_id = $item->fields['locations_id'];
}
$request = self::getCarbonIntensityDataSourceRequest([
Location::getTableField('locations_id') => $location_id,
'OR' => [
// Primary source is a fallback or alternate source is a fallback
'NOT' => ['alternate_sources.id' => null],
Source::getTableField('fallback_level') => ['>', 0],
],
]);
$result = $DB->request($request);
return ($result->current()['count'] > 0);
}
/**
* Associate a Boavizta zone for a location (added or updated)
*
* @param CommonDBTM $item
* @return bool true if a zone has been set
*/
protected function setBoaviztaZone(CommonDBTM $item): bool
{
if (!isset($item->input['_boavizta_zone'])) {
return false;
}
$this->getFromDBByCrit([
'locations_id' => $item->getID(),
]);
if ($this->isNewItem()) {
return false !== $this->add([
'locations_id' => $item->getID(),
'boavizta_zone' => $item->input['_boavizta_zone'],
]);
}
return $this->update([
'id' => $this->getID(),
'boavizta_zone' => $item->input['_boavizta_zone'],
]);
}
/**
* Associate a Source_Zone object for a location
*/
protected function setSourceZone(CommonDBTM $item): bool
{
if (!isset($item->input['_plugin_carbon_sources_zones_id'])) {
return false;
}
$this->getFromDBByCrit([
'locations_id' => $item->getID(),
]);
if ($this->isNewItem()) {
return false !== $this->add([
'locations_id' => $item->getID(),
'plugin_carbon_sources_zones_id' => $item->input['_plugin_carbon_sources_zones_id'],
]);
}
return $this->update([
'id' => $this->getID(),
'plugin_carbon_sources_zones_id' => $item->input['_plugin_carbon_sources_zones_id'],
]);
}
public function onGlpiLocationPrePurge(CommonDBTM $item): bool
{
$this->getFromDBByCrit([
'locations_id' => $item->getID(),
]);
if ($this->isNewItem()) {
return true;
}
return $this->delete($this->fields, true);
}
/**
* Find the country code of a location based on its address, town, state and country
*
* @param CommonDBTM $item
* @param Geocoder $geocoder
* @return string
*
* @throws Exception
*/
public function getCountryCode(CommonDBTM $item, Geocoder $geocoder): string
{
$location_elements = [
// $item->input['address'] ?? $item->fields['address'],
$item->input['town'] ?? $item->fields['town'],
$item->input['state'] ?? $item->fields['state'],
$item->input['country'] ?? $item->fields['country'],
];
$location_elements = array_filter($location_elements);
if ($location_elements === []) {
return '';
}
$location_string = implode(', ', $location_elements);
try {
$result = $geocoder->geocodeQuery(GeocodeQuery::create($location_string));
} catch (QuotaExceeded $e) {
throw $e;
} catch (Exception $e) {
trigger_error($e->getMessage(), E_USER_WARNING);
return '';
}
if ($result->isEmpty()) {
return '';
}
$location = $result->get(0);
$alpha2_code = $location->getCountry()->getCode();
$data = (new ISO3166())->alpha2($alpha2_code);
$alpha3_code = $data['alpha3'];
return $alpha3_code;
}
/**
* Get an iterator for incomplete locations
*
* @param array $where aditional request parameters (WHERE, LIMIT, etc.)
* @return DBmysqlIterator
*/
public static function getIncompleteLocations(array $where = []): DBmysqlIterator
{
/** @var DBmysql $DB */
global $DB;
$where = array_diff_key($where, [
'FROM' => '',
'SELECT' => '',
'COUNT' => '',
'GROUPBY' => '',
]);
// SQL request to get unsolved locations, using the query builder of GLPI
$glpi_location_table = GlpiLocation::getTable();
$location_table = self::getTable();
$request = [
'SELECT' => [
$glpi_location_table => 'id',
$location_table => 'boavizta_zone',
],
'FROM' => $glpi_location_table,
'LEFT JOIN' => [
$location_table => [
'ON' => [
$location_table => 'locations_id',
$glpi_location_table => 'id',
],
],
],
'WHERE' => [
[
'OR' => [
['boavizta_zone' => null],
['boavizta_zone' => ''],
],
],
],
];
$request = array_merge_recursive($request, $where);
$result = $DB->request($request);
return $result;
}
public function getSourceZoneId(): int
{
/** @var DBmysql $DB */
global $DB;
if ($this->isNewItem()) {
return 0;
}
if (!Source_Zone::isNewID($this->fields['plugin_carbon_sources_zones_id'])) {
return $this->fields['plugin_carbon_sources_zones_id'];
}
$location_table = self::getTable();
$glpi_location_table = GlpiLocation::getTable();
$ancestors = (new DbUtils())->getAncestorsOf($glpi_location_table, $this->fields['locations_id']);
if (count($ancestors) === 0) {
return 0;
}
$ancestors = array_values($ancestors); // Drop keys
$request = [
'SELECT' => self::getTableField('plugin_carbon_sources_zones_id'),
'FROM' => $glpi_location_table,
'INNER JOIN' => [
$location_table => [
'FKEY' => [
$glpi_location_table => 'id',
$location_table => 'locations_id',
],
],
],
'WHERE' => [
GlpiLocation::getTableField('id') => $ancestors,
self::getTableField('plugin_carbon_sources_zones_id') => ['>', 0],
],
'ORDER' => 'level DESC',
'LIMIT' => '1',
];
$iterator = $DB->request($request);
if ($iterator->count() === 0) {
return 0;
}
return $iterator->current()['plugin_carbon_sources_zones_id'];
}
/**
* Get the boavizta zone code the asset belongs to
*
* @param CommonDBTM $item
* @param DateTime $date Date for which the zone must be found
* @return string|null
*/
public static function getZoneCode(CommonDBTM $item, ?DateTime $date = null): ?string
{
// TODO: use date to find where was the asset at the given date
if ($date === null) {
$item_table = getTableForItemType($item::class);
$glpi_location_table = getTableForItemType(GlpiLocation::class);
$location_table = self::getTable();
$location = new Location();
$found = $location->getFromDBByRequest([
'INNER JOIN' => [
$glpi_location_table => [
'FKEY' => [
$location_table => 'locations_id',
$glpi_location_table => 'id',
],
],
],
'WHERE' => [
GlpiLocation::getTableField('id') => $item->fields['locations_id'],
],
]);
if ($found === false) {
return null;
}
return $location->fields['boavizta_zone'];
}
throw new LogicException('Not implemented yet');
}
}
You can’t perform that action at this time.