Skip to content

more impact criterias #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
btry wants to merge 2 commits into
base: develop
Choose a base branch
from
+202 −31
Open

more impact criterias #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab9e2cd
docs: source if yearly carbon intensity per country
btry Feb 11, 2026
fb35bde
feat(EmbodiedImpact): support for all criterias of Boaviztapi
btry Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions install/data/carbon_intensity/carbon-intensity-electricity.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Data source:
https://ourworldindata.org/grapher/carbon-intensity-electricity
60 changes: 47 additions & 13 deletions install/mysql/plugin_carbon_empty.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,17 +132,51 @@ CREATE TABLE IF NOT EXISTS `glpi_plugin_carbon_computerusageprofiles` (

CREATE TABLE IF NOT EXISTS `glpi_plugin_carbon_embodiedimpacts` (
`id` int unsigned NOT NULL AUTO_INCREMENT,
`itemtype` varchar(255) DEFAULT NULL,
`itemtype` varchar(255) DEFAULT NULL,
`items_id` int unsigned NOT NULL DEFAULT '0',
`engine` varchar(255) DEFAULT NULL,
`engine_version` varchar(255) DEFAULT NULL,
`date_mod` timestamp NULL DEFAULT NULL,
`gwp` float unsigned DEFAULT '0' COMMENT '(unit gCO2eq) Global warming potential',
`engine` varchar(255) DEFAULT NULL,
`engine_version` varchar(255) DEFAULT NULL,
`date_mod` timestamp NULL DEFAULT NULL,
`gwp` float unsigned DEFAULT '0' COMMENT '(unit gCO2eq) Global warming potential',
`gwp_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`adp` float unsigned DEFAULT '0' COMMENT '(unit gSbeq) Abiotic depletion potential',
`adp` float unsigned DEFAULT '0' COMMENT '(unit gSbeq) Abiotic depletion potential',
`adp_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`pe` float unsigned DEFAULT '0' COMMENT '(unit J) Primary energy',
`pe` float unsigned DEFAULT '0' COMMENT '(unit J) Primary energy',
`pe_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`gwppb` float unsigned DEFAULT '0' COMMENT '(unit g CO2 eq) Climate change - Contribution of biogenic emissions',
`gwppb_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`gwppf` float unsigned DEFAULT '0' COMMENT '(unit g CO2 eq) Climate change - Contribution of fossil fuel emissions',
`gwppf_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`gwpplu` float unsigned DEFAULT '0' COMMENT '(unit g CO2 eq) Climate change - Contribution of emissions from land use change',
`gwpplu_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`ir` float unsigned DEFAULT '0' COMMENT '(unit g U235 eq) Emissions of radionizing substances',
`ir_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`lu` float unsigned DEFAULT '0' COMMENT '(unit none) Land use',
`lu_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`odp` float unsigned DEFAULT '0' COMMENT '(unit g CFC-11 eq) Depletion of the ozone layer',
`odp_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`pm` float unsigned DEFAULT '0' COMMENT '(unit Disease occurrence) Fine particle emissions',
`pm_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`pocp` float unsigned DEFAULT '0' COMMENT '(unit g NMVOC eq) Photochemical ozone formation',
`pocp_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`wu` float unsigned DEFAULT '0' COMMENT '(unit L) Use of water resources',
`wu_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`mips` float unsigned DEFAULT '0' COMMENT '(unit g) Material input per unit of service',
`mips_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`adpe` float unsigned DEFAULT '0' COMMENT '(unit g SB eq) Use of mineral and metal resources',
`adpe_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`adpf` float unsigned DEFAULT '0' COMMENT '(unit J) Use of fossil resources (including nuclear)',
`adpf_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`ap` float unsigned DEFAULT '0' COMMENT '(unit mol H+ eq) Acidification',
`ap_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`ctue` float unsigned DEFAULT '0' COMMENT '(unit CTUe) Freshwater ecotoxicity',
`ctue_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`epf` float unsigned DEFAULT '0' COMMENT '(unit g P eq) Eutrophication of freshwater',
`epf_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`epm` float unsigned DEFAULT '0' COMMENT '(unit g N eq) Eutrophication of marine waters',
`epm_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`ept` float unsigned DEFAULT '0' COMMENT '(unit mol N eq) Terrestrial eutrophication',
`ept_quality` int unsigned NOT NULL DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
PRIMARY KEY (`id`),
UNIQUE KEY `unicity` (`itemtype`, `items_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Expand All @@ -161,12 +195,12 @@ CREATE TABLE IF NOT EXISTS `glpi_plugin_carbon_monitormodels` (
`gwp` int DEFAULT '0' COMMENT '(unit gCO2eq) Global warming potential',
`gwp_source` mediumtext DEFAULT NULL COMMENT 'any information to describe the source, URL preferred',
`gwp_quality` int DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`adp` int DEFAULT '0' COMMENT '(unit gSbEq) Abiotic depletion potential',
`adp_source` mediumtext DEFAULT NULL COMMENT 'any information to describe the source, URL preferred',
`adp_quality` int DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`pe` int DEFAULT '0' COMMENT '(unit J) Primary energy',
`pe_source` mediumtext DEFAULT NULL COMMENT 'any information to describe the source, URL preferred',
`pe_quality` int DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`adp` int DEFAULT '0' COMMENT '(unit gSbEq) Abiotic depletion potential',
`adp_source` mediumtext DEFAULT NULL COMMENT 'any information to describe the source, URL preferred',
`adp_quality` int DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
`pe` int DEFAULT '0' COMMENT '(unit J) Primary energy',
`pe_source` mediumtext DEFAULT NULL COMMENT 'any information to describe the source, URL preferred',
`pe_quality` int DEFAULT '0' COMMENT 'DataTtacking\\AbstractTracked::DATA_QUALITY_* constants',
PRIMARY KEY (`id`),
UNIQUE KEY `unicity` (`monitormodels_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Expand Down
116 changes: 104 additions & 12 deletions src/Impact/Embodied/Boavizta/AbstractAsset.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,30 @@ abstract class AbstractAsset extends AbstractEmbodiedImpact implements AssetInte
/** @var Client instance of the HTTP client */
protected ?Client $client = null;

protected array $criterias = [
'gwp' => 1000, // Kg
'adp' => 1000, // Kg
'pe' => 1000000, // MJ
'gwppb' => 1000, // Kg
'gwppf' => 1000, // Kg
'gwpplu' => 1000, // Kg
'ir' => 1000, // Kg
'lu' => 1, // (no unit)
'odp' => 1000, // Kg
'pm' => 1, // (no unit)
'pocp' => 1000, // Kg
'wu' => 1000, // M^3
'mips' => 1000, // Kg
'adpe' => 1000, // Kg
'adpf' => 1000000, // MJ
'ap' => 1, // mol
'ctue' => 1, // CTUe
// 'ctuh_c' => '', // CTUh request fails when this criteria is added, not a URL encoding issue
'epf' => 1000, // Kg
'epm' => 1000, // Kg
'ept' => 1, // mol
];

// abstract public static function getEngine(CommonDBTM $item): EngineInterface;

/**
Expand Down Expand Up @@ -98,7 +122,23 @@ protected function getVersion(): string
return self::$engine_version;
}

protected function query($description): array
/**
* Get the quety string specifying the impact criterias for the HTTP request
*
* @return string
*/
protected function getCriteriasQueryString(): string
{
return 'criteria=' . implode('&criteria=', array_keys($this->criterias));
}

/**
* Send a HTTP query
*
* @param array $description
* @return array
*/
protected function query(array $description): array
{
try {
$response = $this->client->post($this->endpoint, [
Expand All @@ -115,6 +155,7 @@ protected function query($description): array
/**
* Read the response to find the impacts provided by Boaviztapi
*
* @param array $response
* @return array
*/
protected function parseResponse(array $response): array
Expand All @@ -130,22 +171,73 @@ protected function parseResponse(array $response): array
if ($impact_id === false) {
continue;
}
switch ($type) {
case 'gwp':
$impacts[$impact_id] = $this->parseGwp($response['impacts'][$type]);
break;
case 'adp':
$impacts[$impact_id] = $this->parseAdp($response['impacts'][$type]);
break;
case 'pe':
$impacts[$impact_id] = $this->parsePe($response['impacts'][$type]);
break;
}
$impacts[$impact_id] = $this->parseCriteria($type, $response['impacts'][$type]);
// switch ($type) {
// case 'gwp':
// $impacts[$impact_id] = $this->parseGwp($response['impacts'][$type]);
// break;
// case 'adp':
// $impacts[$impact_id] = $this->parseAdp($response['impacts'][$type]);
// break;
// case 'pe':
// $impacts[$impact_id] = $this->parsePe($response['impacts'][$type]);
// break;
// case 'gwppb':
// break;
// case 'gwppf':
// break;
// case 'gwpplu':
// break;
// case 'ir':
// break;
// case 'lu':
// break;
// case 'odp':
// break;
// case 'pm':
// break;
// case 'pocp':
// break;
// case 'wu':
// break;
// case 'mips':
// break;
// case 'adpe':
// break;
// case 'adpf':
// break;
// case 'ap':
// break;
// case 'ctue':
// break;
// case 'epf':
// break;
// case 'epm':
// break;
// case 'ept':
// break;
// }
}

return $impacts;
}

protected function parseCriteria(string $name, array $impact): ?TrackedFloat
{
if ($impact['embedded'] === 'not implemented') {
return null;
}

$unit_multiplier = $this->criterias[$name];
$value = new TrackedFloat(
$impact['embedded']['value'] * $unit_multiplier,
null,
TrackedFloat::DATA_QUALITY_ESTIMATED
);

return $value;
}

protected function parseGwp(array $impact): ?TrackedFloat
{
if ($impact['embedded'] === 'not implemented') {
Expand Down
1 change: 1 addition & 0 deletions src/Impact/Embodied/Boavizta/Computer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ protected function doEvaluation(): ?array
// adapt $this->endpoint depending on the type of computer (server, laptop, ...)
$type = $this->getType($this->item);
$this->endpoint = $this->getEndpoint($type);
$this->endpoint .= '?' . $this->getCriteriasQueryString();

// Ask for embodied impact only
$handle_hardware = in_array($type, [
Expand Down
6 changes: 6 additions & 0 deletions src/Impact/Embodied/Engine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,19 +131,25 @@
*/
private static function hasModelData(CommonDBTM $item): bool
{
global $DB;

Check failure on line 134 in src/Impact/Embodied/Engine.php

View workflow job for this annotation

GitHub Actions / GLPI 11.0.x - php:8.2 - mariadb:10.6 / Continuous integration 

Missing PHPDoc tag `@var` for global variable $DB

Check failure on line 134 in src/Impact/Embodied/Engine.php

View workflow job for this annotation

GitHub Actions / GLPI 11.0.x - php:8.5 - mariadb:11.8 / Continuous integration 

Missing PHPDoc tag `@var` for global variable $DB

$itemtype = get_class($item);
$glpi_model_class = $itemtype . 'Model';
$glpi_model_class_fk = getForeignKeyFieldForItemType($glpi_model_class);
/**
* @var class-string<AbstractModel> $model_class
*/
$model_class = 'GlpiPlugin\\Carbon\\' . $glpi_model_class;
$model_table = getTableForItemType($model_class);
$glpi_model_id = $item->fields[$glpi_model_class_fk];
$crit = [
$glpi_model_class_fk => $glpi_model_id
];
$types = Type::getImpactTypes();
foreach ($types as $key => $type) {
if (!$DB->fieldExists($model_table, $type)) {
continue;
}
$crit['OR'][] = [
$type . '_quality' => ['<>', AbstractTracked::DATA_QUALITY_UNSET_VALUE]
];
Expand Down
48 changes: 42 additions & 6 deletions src/Impact/Type.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,50 @@

class Type
{
const IMPACT_GWP = 0; // Global warming potential
const IMPACT_ADP = 1; // Abiotic Depletion Potential
const IMPACT_PE = 2; // Primary Energy
const IMPACT_GWP = 0; // Global warming potential
const IMPACT_ADP = 1; // Abiotic Depletion Potential
const IMPACT_PE = 3; // Primary Energy
const IMPACT_GWPPB = 4;
const IMPACT_GWPPF = 5;
const IMPACT_GWPPLU = 6;
const IMPACT_IR = 7;
const IMPACT_LU = 8;
const IMPACT_ODP = 9;
const IMPACT_PM = 10;
const IMPACT_POCP = 11;
const IMPACT_WU = 12;
const IMPACT_MIPS = 13;
const IMPACT_ADPE = 14;
const IMPACT_ADPF = 15;
const IMPACT_AP = 16;
const IMPACT_CTUE = 17;
// const IMPACT_CTUHC = 18;
const IMPACT_EPF = 19;
const IMPACT_EPM = 20;
const IMPACT_EPT = 21;

private static array $impact_types = [
self::IMPACT_GWP => 'gwp',
self::IMPACT_ADP => 'adp',
self::IMPACT_PE => 'pe',
self::IMPACT_GWP => 'gwp',
self::IMPACT_ADP => 'adp',
self::IMPACT_PE => 'pe',
self::IMPACT_GWPPB => 'gwppb',
self::IMPACT_GWPPF => 'gwppf',
self::IMPACT_GWPPLU => 'gwpplu',
self::IMPACT_IR => 'ir',
self::IMPACT_LU => 'lu',
self::IMPACT_ODP => 'odp',
self::IMPACT_PM => 'pm',
self::IMPACT_POCP => 'pocp',
self::IMPACT_WU => 'wu',
self::IMPACT_MIPS => 'mips',
self::IMPACT_ADPE => 'adpe',
self::IMPACT_ADPF => 'adpf',
self::IMPACT_AP => 'ap',
self::IMPACT_CTUE => 'ctue',
// self::IMPACT_CTUHC => 'ctuh_c',
self::IMPACT_EPF => 'epf',
self::IMPACT_EPM => 'epm',
self::IMPACT_EPT => 'ept',
];

public static function getImpactTypes(): array
Expand Down
Loading