Dashlet extraction

2026-04-30 14:08:46 +02:00 · 2026-01-16 18:47:28 +01:00
parent efc6e6730b
commit 3c80c93b4f
29 changed files with 2871 additions and 2521 deletions
--- a/sources/Application/Dashlet/Service/DashletService.php
+++ b/sources/Application/Dashlet/Service/DashletService.php
@@ -0,0 +1,143 @@
+<?php
+
+/*
+ * @copyright   Copyright (C) 2010-2026 Combodo SAS
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Application\Dashlet\Service;
+
+use Combodo\iTop\Application\Dashlet\DashletException;
+use Combodo\iTop\DesignDocument;
+use Combodo\iTop\DesignElement;
+use Dict;
+use utils;
+
+class DashletService
+{
+	private static DashletService $oInstance;
+	private array $aDashlets = [];
+
+	protected function __construct()
+	{
+	}
+
+	final public static function GetInstance(): DashletService
+	{
+		if (!isset(static::$oInstance)) {
+			static::$oInstance = new DashletService();
+		}
+
+		return static::$oInstance;
+	}
+
+	/**
+	 * @return array
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 * @throws \DOMFormatException
+	 */
+	public function GetAvailableDashlets(): array
+	{
+		$this->InitDashletDefinitions();
+
+		return $this->aDashlets;
+	}
+
+	/**
+	 * @param string $sXMLContent
+	 *
+	 * @return \Combodo\iTop\DesignElement
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 */
+	private function GetDomNode(string $sXMLContent): DesignElement
+	{
+		$oDoc = new DesignDocument();
+		libxml_clear_errors();
+		$oDoc->loadXML($sXMLContent);
+		$aErrors = libxml_get_errors();
+		if (count($aErrors) > 0) {
+			throw new DashletException('Dashlets definition not correctly formatted!');
+		}
+
+		/** @var \Combodo\iTop\DesignElement $oRoot */
+		$oRoot = $oDoc->firstChild;
+
+		return $oRoot;
+	}
+
+	/**
+	 * @return string
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 */
+	private function GetXMLContent(): string
+	{
+		$sPath = utils::GetAbsoluteModulePath('core')."dashlets.xml";
+		if (!file_exists($sPath)) {
+			throw new DashletException("Dashlets definition not present");
+		}
+
+		return file_get_contents($sPath);
+	}
+
+	/**
+	 * @param string $sClass
+	 *
+	 * @return bool
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 * @throws \DOMFormatException
+	 */
+	public function IsDashletAvailable(string $sClass)
+	{
+		$this->InitDashletDefinitions();
+
+		return array_key_exists($sClass, $this->aDashlets);
+	}
+
+	/**
+	 * @param string $sClass
+	 *
+	 * @return array
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 */
+	public function GetDashletDefinition(string $sClass): array
+	{
+		if ($this->IsDashletAvailable($sClass)) {
+			return $this->aDashlets[$sClass];
+		}
+
+		throw new DashletException('Dashlets definition '.json_encode($sClass).' not present');
+	}
+
+	/**
+	 * @return void
+	 * @throws \Combodo\iTop\Application\Dashlet\DashletException
+	 * @throws \DOMFormatException
+	 */
+	private function InitDashletDefinitions(): void
+	{
+		if (count($this->aDashlets) === 0) {
+			$this->aDashlets = [];
+
+			$oDashletsNode = $this->GetDomNode($this->GetXMLContent());
+			/** @var DesignElement $oDashletNode */
+			foreach ($oDashletsNode->getElementsByTagName('dashlet') as $oDashletNode) {
+				$sType = $oDashletNode->getAttribute('id');
+				$aInfo = [
+					'label'             => Dict::S($oDashletNode->GetChildText('label')),
+					'icon'              => $oDashletNode->GetChildText('icon'),
+					'description'       => Dict::S($oDashletNode->GetChildText('description')),
+					'min_width'         => intval($oDashletNode->GetChildText('min_width', '2')),
+					'min_height'        => intval($oDashletNode->GetChildText('min_height', '1')),
+					'preferred_width'   => intval($oDashletNode->GetChildText('preferred_width', '2')),
+					'preferred_height'  => intval($oDashletNode->GetChildText('preferred_height', '1')),
+					'can_create_by_oql' => boolval($oDashletNode->GetChildText('can_create_by_oql', 'false')),
+				];
+				$this->aDashlets[$sType] = $aInfo;
+			}
+
+			uasort($this->aDashlets, function ($a, $b) {
+				return strcmp($a['label'], $b['label']);
+			});
+		}
+	}
+}