Generalize source object

ajax/dropdownZone.php

@@ -0,0 +1,54 @@
+<?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/>.
+ *
+ * -------------------------------------------------------------------------
+ */
+
+use GlpiPlugin\Carbon\Source_Zone;
+use GlpiPlugin\Carbon\Zone;
+
+include(__DIR__ . '/../../../inc/includes.php');
+
+// Check if plugin is activated...
+if (!Plugin::isPluginActive('carbon')) {
+    http_response_code(404);
+    die();
+}
+
+// throw new RuntimeException('Required argument missing or incorrect!');
+
+$source_zone_table = Source_Zone::getTable();
+$zone_table = Zone::getTable();
+$source_id = (int) $_POST['plugin_carbon_sources_id'];
+Zone::dropdown([
+    'rand' => (int) $_POST['dom_id'],
+    'condition' => Zone::getRestrictBySourceCondition($source_id),
+    // 'disabled'  => ($source_id === 0),
+    'specific_tags' => ($source_id === 0 ? ['disabled' => 'disabled'] : []),
+]);

ajax/toggleZoneDownload.php

@@ -30,8 +30,8 @@
  * -------------------------------------------------------------------------
  */
 
-use GlpiPlugin\Carbon\CarbonIntensitySource;
-use GlpiPlugin\Carbon\CarbonIntensitySource_Zone;
+use GlpiPlugin\Carbon\Source;
+use GlpiPlugin\Carbon\Source_Zone;
 
 include(__DIR__ . '/../../../inc/includes.php');
 
@@ -41,7 +41,7 @@
     die();
 }
 
-if (!CarbonIntensitySource::canView()) {
+if (!Source::canView()) {
     // Will die
     http_response_code(403);
     die();
@@ -52,7 +52,7 @@
     die();
 }
 
-$source_zone = new CarbonIntensitySource_Zone();
+$source_zone = new Source_Zone();
 if (!$source_zone->getFromDB($_GET['id'])) {
     http_response_code(403);
     die();

front/computertype.form.php

@@ -32,20 +32,20 @@
 
 use Glpi\Exception\Http\NotFoundHttpException;
 use GlpiPlugin\Carbon\ComputerType;
+use ComputerType as GlpiComputerType;
 
 include(__DIR__ . '/../../../inc/includes.php');
 
 if (!Plugin::isPluginActive('carbon')) {
     throw new NotFoundHttpException();
 }
 
-Session::checkRight('config', UPDATE);
+Session::checkRight(GlpiComputerType::$rightname, UPDATE);
 
 $item = new ComputerType();
 
 if (isset($_POST['update'])) {
-    // Add a new Form
-    Session::checkRight('entity', UPDATE);
+    Session::checkRight(GlpiComputerType::$rightname, UPDATE);
     $item->update($_POST);
     Html::back();
 }

front/location.form.php

@@ -0,0 +1,53 @@
+<?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/>.
+ *
+ * -------------------------------------------------------------------------
+ */
+
+use Glpi\Exception\Http\NotFoundHttpException;
+use GlpiPlugin\Carbon\Location;
+use Location as GlpiLocation;
+
+include(__DIR__ . "/../../../inc/includes.php");
+
+if (!Plugin::isPluginActive('carbon')) {
+    throw new NotFoundHttpException();
+}
+
+Session::checkRight(GlpiLocation::$rightname, UPDATE);
+
+$item = new Location();
+
+if (isset($_POST['update'])) {
+    Session::checkRight(GlpiLocation::$rightname, UPDATE);
+    $item->update($_POST);
+    Html::back();
+}
+
+Html::back();

front/monitortype.form.php

@@ -34,18 +34,18 @@
 
 use GlpiPlugin\Carbon\MonitorType;
 use Glpi\Exception\Http\NotFoundHttpException;
+use MonitorType as GlpiMonitorType;
 
 if (!Plugin::isPluginActive('carbon')) {
     throw new NotFoundHttpException();
 }
 
-Session::checkRight('config', UPDATE);
+Session::checkRight(GlpiMonitorType::$rightname, UPDATE);
 
 $item = new MonitorType();
 
 if (isset($_POST['update'])) {
-    // Add a new Form
-    Session::checkRight('entity', UPDATE);
+    Session::checkRight(GlpiMonitorType::$rightname, UPDATE);
     $item->update($_POST);
     Html::back();
 }

front/networkequipmenttype.form.php

@@ -32,20 +32,20 @@
 
 use Glpi\Exception\Http\NotFoundHttpException;
 use GlpiPlugin\Carbon\NetworkEquipmentType;
+use NetworkEquipmentType as GlpiNetworkEquipmentType;
 
 include(__DIR__ . '/../../../inc/includes.php');
 
 if (!Plugin::isPluginActive('carbon')) {
     throw new NotFoundHttpException();
 }
 
-Session::checkRight('config', UPDATE);
+Session::checkRight(GlpiNetworkEquipmentType::$rightname, UPDATE);
 
 $item = new NetworkEquipmentType();
 
 if (isset($_POST['update'])) {
-    // Add a new Form
-    Session::checkRight('entity', UPDATE);
+    Session::checkRight(GlpiNetworkEquipmentType::$rightname, UPDATE);
     $item->update($_POST);
     Html::back();
 }

hook.php

@@ -36,14 +36,14 @@
 use GlpiPlugin\Carbon\Install;
 use GlpiPlugin\Carbon\Uninstall;
 use GlpiPlugin\Carbon\UsageInfo;
-use GlpiPlugin\Carbon\CarbonIntensitySource;
+use GlpiPlugin\Carbon\Source;
 use GlpiPlugin\Carbon\Zone;
 use ComputerType as GlpiComputerType;
 use GlpiPlugin\Carbon\CarbonEmission;
 use GlpiPlugin\Carbon\CarbonIntensity;
 use MonitorType as GlpiMonitorType;
 use NetworkEquipmentType as GlpiNetworkEquipmentType;
-use GlpiPlugin\Carbon\CarbonIntensitySource_Zone;
+use GlpiPlugin\Carbon\Source_Zone;
 use GlpiPlugin\Carbon\Config;
 use GlpiPlugin\Carbon\EmbodiedImpact;
 use GlpiPlugin\Carbon\Location;
@@ -120,7 +120,7 @@ function plugin_carbon_getDropdown()
 {
     return [
         ComputerUsageProfile::class  => ComputerUsageProfile::getTypeName(),
-        CarbonIntensitySource::class => CarbonIntensitySource::getTypeName(),
+        Source::class => Source::getTypeName(),
         Zone::class   => Zone::getTypeName(),
         CarbonIntensity::class       => CarbonIntensity::getTypeName(),
     ];
@@ -153,25 +153,11 @@ function plugin_carbon_getAddSearchOptionsNew($itemtype): array
 }
 
 /**
- * Callback before showing save / update button on an item form
+ * Callback when an object is added into the database
  *
- * @param array $params 'item' => CommonDBTM
- *                       'options => array
+ * @param CommonDBTM $item item being added
  * @return void
  */
-function plugin_carbon_postItemForm(array $params)
-{
-    switch ($params['item']->getType()) {
-        case GlpiLocation::class:
-            $location = new Location();
-            $location->getFromDBByCrit([
-                GlpiLocation::getForeignKeyField() => $params['item']->getID(),
-            ]);
-            $location->showForm($location->getID());
-            break;
-    }
-}
-
 function plugin_carbon_hook_add_asset(CommonDBTM $item)
 {
     if (!in_array($item::getType(), PLUGIN_CARBON_TYPES)) {
@@ -184,21 +170,20 @@ function plugin_carbon_hook_add_asset(CommonDBTM $item)
     if (GlpiLocation::isNewID($item->fields[$location_fk])) {
         return;
     }
-    $zone = Zone::getByAsset($item);
-    if ($zone === null) {
-        return;
-    }
-    $source_zone = new CarbonIntensitySource_Zone();
-    $source_zone->getFromDBByCrit([
-        $zone->getForeignKeyField() => $zone->fields['id'],
-        CarbonIntensitySource::getForeignKeyField() => $zone->fields['plugin_carbon_carbonintensitysources_id_historical'],
-    ]);
-    if ($source_zone->isNewItem()) {
+
+    $source_zone = new Source_Zone();
+    if ($source_zone->getFromDbByItem($item) === false) {
         return;
     }
     $source_zone->toggleZone(true);
 }
 
+/**
+ * Callback when an item is being updated in the database
+ *
+ * @param CommonDBTM $item item being updated
+ * @return void
+ */
 function plugin_carbon_hook_update_asset(CommonDBTM $item)
 {
     if (!in_array($item::getType(), PLUGIN_CARBON_TYPES)) {
@@ -211,14 +196,14 @@ function plugin_carbon_hook_update_asset(CommonDBTM $item)
     if (GlpiLocation::isNewID($item->fields[$location_fk])) {
         return;
     }
-    $zone = Zone::getByAsset($item);
-    if ($zone === null) {
+    $zone = new Zone();
+    if ($zone->getByAsset($item) === false) {
         return;
     }
-    $source_zone = new CarbonIntensitySource_Zone();
+    $source_zone = new Source_Zone();
     $source_zone->getFromDBByCrit([
         $zone->getForeignKeyField() => $zone->fields['id'],
-        CarbonIntensitySource::getForeignKeyField() => $zone->fields['plugin_carbon_carbonintensitysources_id_historical'],
+        Source::getForeignKeyField() => $zone->fields['plugin_carbon_sources_id_historical'],
     ]);
     if ($source_zone->isNewItem()) {
         return;

install/Install.php

@@ -35,8 +35,6 @@
 use Config;
 use DBmysql;
 use DirectoryIterator;
-use Glpi\Message\MessageType;
-use Glpi\Toolbox\Sanitizer;
 use Migration;
 use Plugin;
 
@@ -247,16 +245,18 @@ private function getMigrationsToDo(string $current_version): array
      *
      * @param string $name Name of the zone
      * @param int $is_fallback Is the zone a fallback zone (1) or not (0)
+     * @param int $is_carbon_intensity_source Does the source provide carbon intensity (1) or not (0)
      * @return int ID of the zone
      */
-    public static function getOrCreateSource(string $name, int $is_fallback = 1): int
+    public static function getOrCreateSource(string $name, int $is_fallback = 1, int $is_carbon_intensity_source = 1): int
     {
-        $source = new CarbonIntensitySource();
+        $source = new Source();
         $source->getFromDBByCrit(['name' => $name]);
         if ($source->isNewItem()) {
             $source->add([
                 'name' => $name,
                 'is_fallback' => $is_fallback,
+                'is_carbon_intensity_source' => $is_carbon_intensity_source,
             ]);
             /** @phpstan-ignore if.alwaysTrue */
             if ($source->isNewItem()) {
@@ -280,7 +280,7 @@ public static function getOrCreateZone(string $name, int $source_id): int
         if ($zone->isNewItem()) {
             $zone->add([
                 'name' => $name,
-                'plugin_carbon_carbonintensitysources_id_historical' => $source_id,
+                'plugin_carbon_sources_id_historical' => $source_id,
             ]);
             /** @phpstan-ignore if.alwaysTrue */
             if ($zone->isNewItem()) {
@@ -294,22 +294,31 @@ public static function getOrCreateZone(string $name, int $source_id): int
     /**
      * Link a carbon intensity source to a zone
      *
-     * @param int $source_id ID of the carbon intensity source
-     * @param int $zone_id ID of the zone
-     * @return int ID of the link
+     * @param int    $source_id ID of the carbon intensity source
+     * @param int    $zone_id ID of the zone
+     * @param string $code Identifier of the zone used by the source
+     * @return int   ID of the link
      */
-    public static function linkSourceZone(int $source_id, int $zone_id): int
+    public static function linkSourceZone(int $source_id, int $zone_id, string $code = ''): int
     {
-        $source_zone = new CarbonIntensitySource_Zone();
+        $source_zone = new Source_Zone();
         $source_zone->getFromDBByCrit([
-            'plugin_carbon_carbonintensitysources_id' => $source_id,
-            'plugin_carbon_zones_id'                  => $zone_id,
+            'plugin_carbon_sources_id' => $source_id,
+            'plugin_carbon_zones_id'   => $zone_id,
         ]);
         if ($source_zone->isNewItem()) {
             $source_zone->add([
-                'plugin_carbon_carbonintensitysources_id' => $source_id,
-                'plugin_carbon_zones_id'                  => $zone_id,
+                'plugin_carbon_sources_id' => $source_id,
+                'plugin_carbon_zones_id'   => $zone_id,
+                'code'                     => $code
             ]);
+        } else {
+            if ($source_zone->fields['code'] !== $code) {
+                $source_zone->update([
+                    'id'   => $source_zone->getID(),
+                    'code' => $code,
+                ]);
+            }
         }
 
         return $source_zone->getID();