Skip to content

Fix GLPI 11 compatibility with current Metabase API versions #150

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
whamulti wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix GLPI 11 compatibility with current Metabase API versions #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions inc/apiclient.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,8 @@ public function getDashboardCards($id)
{
$data = $this->httpQuery("dashboard/$id", [], 'GET');

return $data['ordered_cards'] ?? false;
// Metabase renamed 'ordered_cards' to 'dashcards' in newer API versions.
return $data['dashcards'] ?? $data['ordered_cards'] ?? false;
}

public function createOrUpdateCard($card_name, $params = [])
Expand Down Expand Up @@ -657,11 +658,15 @@ public function getCards($collection_id = null)
return $cards;
}

// Metabase's API returns id:"root" for the root collection, but cards
// in it have collection_id: null - normalize before comparing.
$normalized_id = $collection_id === 'root' ? null : $collection_id;

$cards = array_filter(
$cards,
fn($card) => is_array($card)
&& array_key_exists('collection_id', $card)
&& $collection_id === $card['collection_id'],
&& $normalized_id === $card['collection_id'],
);

return $cards;
Expand Down
35 changes: 24 additions & 11 deletions inc/config.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,10 +528,16 @@ public static function displayQuestionJson($question_id)
'display' => $card['display'],
'visualization_settings' => $card['visualization_settings'],
'template_tags' => [],
'sql' => $card['dataset_query']['native']['query'],
// Metabase MBQL 5 moved the native query out of
// dataset_query.native.query into dataset_query.stages[0].native.
'sql' => $card['dataset_query']['native']['query']
?? $card['dataset_query']['stages'][0]['native'],
];

foreach ($card['dataset_query']['native']['template-tags'] as $tag_name => $tag) {
$template_tags = $card['dataset_query']['native']['template-tags']
?? $card['dataset_query']['stages'][0]['template-tags']
?? [];
foreach ($template_tags as $tag_name => $tag) {
$extract['template_tags'][$tag_name] = [
'type' => $tag['type'],
'display_name' => $tag['display-name'],
Expand Down Expand Up @@ -582,13 +588,21 @@ public static function displayDashboardJson($dashboard_id)
$parameters_id[$parameter['id']] = $parameter['slug'];
}

foreach ($dashboard['ordered_cards'] as $card) {
// Metabase renamed 'ordered_cards' to 'dashcards' in newer API versions.
$dashcards = $dashboard['dashcards'] ?? $dashboard['ordered_cards'] ?? [];
foreach ($dashcards as $card) {
// MBQL 5 replaced the top-level dataset_query.type === 'native'
// flag with a dataset_query.stages[0].native structure.
$is_native = isset($card['card']['dataset_query']['type'])
? $card['card']['dataset_query']['type'] === 'native'
: isset($card['card']['dataset_query']['stages'][0]['native']);

if (
isset($card['card_id']) // only question (TODO support markdown cards)
&& $card['card']['dataset_query']['type'] === 'native'
&& $is_native
) { // only native questions
$key = null;
foreach ($_SESSION['metabase']['reports'] as $session_key => $session_report) {
foreach ($_SESSION['metabase']['reports'] ?? [] as $session_key => $session_report) {
if ($session_report['title'] === $card['card']['name']) {
$key = $session_key;
}
Expand All @@ -598,15 +612,14 @@ public static function displayDashboardJson($dashboard_id)
$extract['reports'][$key] = [
'col' => $card['col'],
'row' => $card['row'],
'sizeX' => $card['sizeX'],
'sizeY' => $card['sizeY'],
'sizeX' => $card['sizeX'] ?? $card['size_x'],
'sizeY' => $card['sizeY'] ?? $card['size_y'],
];

foreach ($card['parameter_mappings'] as $mapping) {
$mapping_key = $mapping['target'][1][1];
$field_id = $card['card']['dataset_query']
['native']['template-tags']
[$mapping_key]['dimension'][1];
$field_id = $card['card']['dataset_query']['native']['template-tags'][$mapping_key]['dimension'][1]
?? $card['card']['dataset_query']['stages'][0]['template-tags'][$mapping_key]['dimension'][1];
$field_name = array_search($field_id, $_SESSION['metabase']['fields']);
if ($field_name !== false) {
$extract['reports'][$key]['parameter_mappings']
Expand All @@ -618,7 +631,6 @@ public static function displayDashboardJson($dashboard_id)
}

self::displayPrettyJson($extract);
Html::printCleanArray($dashboard);
}

public static function displayPrettyJson($array = [])
Expand Down Expand Up @@ -809,6 +821,7 @@ public static function install(Migration $migration)
// Encrypt embedded_token, previously stored in plain text
if (!array_key_exists('is_embedded_token_encrypted', $current_config) || !$current_config['is_embedded_token_encrypted']) {
if (!empty($current_config['embedded_token'])) {
$current_config['embedded_token'] = (new GLPIKey())->encrypt($current_config['embedded_token']);

@stonebuzz stonebuzz Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than securing the token directly here, since this class extends GLPI's Config class, you can simply use the Hooks::SECURED_CONFIGS hook.

For example, add the following to the plugin's setup.php file:

$PLUGIN_HOOKS[Hooks::SECURED_CONFIGS]['metabase'] = [
    'embedded_token',
];

This allows GLPI to handle the token as a secured configuration value using the standard mechanism.

Config::setConfigurationValues(
'plugin:metabase',
[
Expand Down
2 changes: 1 addition & 1 deletion public/metabase.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ $(function() {
var type = $(this).data('type');
glpi_ajax_dialog({
dialogclass: 'modal-lg',
url: CFG_GLPI.root_doc + '/' + GLPI_PLUGINS_PATH.metabase + '/ajax/extract_json.php',
url: CFG_GLPI.root_doc + GLPI_PLUGINS_PATH.metabase + '/ajax/extract_json.php',
params: {
id: id,
type: type
Expand Down
Loading