Parsing QGIS Project with PHP XMLReader instead of DOM

assets/src/components/FeatureToolbar.js

@@ -333,7 +333,8 @@ export default class FeatureToolbar extends HTMLElement {
         this._layouts = mainLizmap.config?.layouts;
 
         mainLizmap.config?.printTemplates.map((template, index) => {
-            if (this._layerId === template?.atlas?.coverageLayer && template?.atlas?.enabled === '1') {
+            if (this._layerId === template?.atlas?.coverageLayer
+                && (template?.atlas?.enabled === '1' || template?.atlas?.enabled === true)) {
                 // Lizmap >= 3.7
                 if (mainLizmap.config?.layouts?.list) {
                     if (mainLizmap.config?.layouts?.list?.[index]?.enabled) {

assets/src/components/Print.js

@@ -57,7 +57,7 @@ export default class Print extends HTMLElement {
                     // Filtering printTemplates by atlas enabled
                     // and since 3.7 by layout enabled
                     mainLizmap.config?.printTemplates.map((template, index) => {
-                        if (template?.atlas?.enabled === '0'){
+                        if (template?.atlas?.enabled === '0' || template?.atlas?.enabled === false){
                             // Lizmap >= 3.7
                             if (layouts?.list) {
                                 if(layouts.list?.[index]?.enabled){

assets/src/legacy/attributeTable.js

@@ -1781,6 +1781,31 @@ var lizAttributeTable = function() {
                     && config.attributeLayers[aName]['attributetableconfig']
                     && !$.isEmptyObject(config.attributeLayers[aName]['attributetableconfig']['columns'])
                 ){
+                    if (!('column' in config.attributeLayers[aName]['attributetableconfig']['columns'])) {
+                        var atc = config.attributeLayers[aName]['attributetableconfig']['columns'];
+                        if(atc.length == 0){
+                            return colToReturn;
+                        }
+                        var lizcols = columns.slice(0, firstDisplayedColIndex);
+                        var newcolumns = [];
+                        for (var x in atc) {
+                            var colx = atc[x];
+                            // Do nothing if the item does not reference a field
+                            if (colx.type != 'field') {
+                                continue;
+                            }
+                            for (const column of columns) {
+                                if (!('data' in column)) {
+                                    continue;
+                                }
+                                if (colx.name == column.data) {
+                                    newcolumns.push(column);
+                                }
+                            }
+                        }
+                        colToReturn['columns'] = lizcols.concat(newcolumns);
+                        return colToReturn;
+                    }
                     var atc = config.attributeLayers[aName]['attributetableconfig']['columns']['column'];
                     if(atc.length == 0){
                         return colToReturn;

assets/src/legacy/switcher-layers-actions.js

@@ -304,7 +304,7 @@ var lizLayerActionButtons = function() {
                                 }
 
                                 layerOrGroup.checked = true;
-                                layerOrGroup.expanded = layerParams?.expanded === "1";
+                                layerOrGroup.expanded = layerParams?.expanded === "1" || layerParams?.expanded === true;
 
                                 // `symbologyChildren` is empty for some time if the theme switches
                                 // the layer style from simple to categorized.

lizmap/modules/lizmap/lib/App/XmlTools.php

@@ -14,14 +14,14 @@
 
 class XmlTools
 {
-    /*
-     * Interprets a string of XML into an object
+    /**
+     * Interprets a string of XML into an object.
      *
      * @param string $xml_str a well-formed XML string
      *
-     * @return SimpleXmlElement|string an object of class SimpleXMLElement with properties
-     *                                 containing the data held within the XML document, or
-     *                                 a string containing the error message.
+     * @return \SimpleXmlElement|string an object of class SimpleXMLElement with properties
+     *                                  containing the data held within the XML document, or
+     *                                  a string containing the error message
      */
     public static function xmlFromString($xml_str)
     {
@@ -34,14 +34,14 @@ public static function xmlFromString($xml_str)
         return $xml;
     }
 
-    /*
-     * Interprets an XML file into an object
+    /**
+     * Interprets an XML file into an object.
      *
      * @param string $xml_path the path to the xml file
      *
-     * @return SimpleXmlElement|string an object of class SimpleXMLElement with properties
-     *                                 containing the data held within the XML document, or
-     *                                 a string containing the error message.
+     * @return \SimpleXmlElement|string an object of class SimpleXMLElement with properties
+     *                                  containing the data held within the XML document, or
+     *                                  a string containing the error message
      */
     public static function xmlFromFile($xml_path)
     {
@@ -54,12 +54,12 @@ public static function xmlFromFile($xml_path)
         return $xml;
     }
 
-    /*
-     * Get XML error message
+    /**
+     * Get XML error message.
      *
      * Build an error message based on LibXMLError object
      *
-     * @return string the error message.
+     * @return string the error message
      */
     private static function xmlErrorMsg()
     {
@@ -89,7 +89,76 @@ private static function xmlErrorMsg()
             $msg .= 'Column: '.$error->column.' ';
             $msg .= trim($error->message);
         }
+        // Clear libxml error buffer
+        libxml_clear_errors();
 
         return $msg;
     }
+
+    /**
+     * Interprets a string of XML into an XML Pull parser.
+     * It acts as a cursor going forward on the document stream and stopping at each node on the way.
+     *
+     * @param string $xml_str a well-formed XML string
+     *
+     * @return \XMLReader an object of class XMLReader with properties at the root document element
+     *                    containing the data held within the XML document
+     */
+    public static function xmlReaderFromString($xml_str)
+    {
+        $oXml = new \XMLReader();
+        // Set XML
+        if (!$oXml->XML($xml_str)) {
+            throw new \Exception(self::xmlErrorMsg());
+        }
+
+        // Read until we are at the root document element
+        while ($oXml->read()) {
+            if ($oXml->nodeType == \XMLReader::ELEMENT
+                && $oXml->depth == 0) {
+                break;
+            }
+        }
+
+        $errorMsg = self::xmlErrorMsg();
+        if ($errorMsg !== '') {
+            throw new \Exception($errorMsg);
+        }
+
+        return $oXml;
+    }
+
+    /**
+     * Interprets an XML file into an XML pull parser.
+     * It acts as a cursor going forward on the document stream and stopping at each node on the way.
+     *
+     * @param string $xml_path the path to the xml file
+     *
+     * @return \XMLReader an object of class XMLReader with properties at the root document element
+     *                    containing the data held within the XML document
+     */
+    public static function xmlReaderFromFile($xml_path)
+    {
+        $oXml = new \XMLReader();
+
+        // Open file
+        if (!$oXml->open($xml_path)) {
+            throw new \Exception(self::xmlErrorMsg());
+        }
+
+        // Read until we are at the root document element
+        while ($oXml->read()) {
+            if ($oXml->nodeType == \XMLReader::ELEMENT
+                && $oXml->depth == 0) {
+                break;
+            }
+        }
+
+        $errorMsg = self::xmlErrorMsg();
+        if ($errorMsg !== '') {
+            throw new \Exception($errorMsg);
+        }
+
+        return $oXml;
+    }
 }

lizmap/modules/lizmap/lib/Project/Project.php

@@ -261,36 +261,7 @@ protected function readProject()
      */
     protected function getLayersWithLabels()
     {
-        // Keep a list of layer ids for which to replace the code by labels
-        $layersWithLabeledFields = array();
-
-        // Attribute layers
-        foreach ($this->cfg->getAttributeLayers() as $key => $config) {
-            if ($config->hideLayer == 'True') {
-                continue;
-            }
-            $layersWithLabeledFields[] = $config->layerId;
-        }
-
-        // Dataviz layers
-        foreach ($this->cfg->getDatavizLayers() as $o => $config) {
-            $layerId = $config->layerId;
-            if (array_key_exists($layerId, $layersWithLabeledFields)) {
-                continue;
-            }
-            $layersWithLabeledFields[] = $config->layerId;
-        }
-
-        // Form filter layers
-        foreach ($this->cfg->getFormFilterLayers() as $o => $config) {
-            $layerId = $config->layerId;
-            if (array_key_exists($layerId, $layersWithLabeledFields)) {
-                continue;
-            }
-            $layersWithLabeledFields[] = $config->layerId;
-        }
-
-        return $layersWithLabeledFields;
+        return $this->cfg->getLayersWithLabels();
     }
 
     public function getQgisPath()
@@ -1757,13 +1728,11 @@ protected function readAttributeLayers(QgisProject $xml, ProjectConfig $cfg)
     }
 
     /**
-     * @param \SimpleXMLElement $xml
-     *
      * @return int[]
      */
     protected function readLayersOrder(QgisProject $xml)
     {
-        return $this->qgis->readLayersOrder($xml, $this->getLayers());
+        return $xml->readLayersOrder($this->cfg->getLayers());
     }
 
     /**

lizmap/modules/lizmap/lib/Project/ProjectConfig.php

@@ -522,6 +522,49 @@ public function getDatavizLayers()
         return $this->datavizLayers;
     }
 
+    /**
+     * List of the layers configured in the tools
+     * Attribute table, form filter & dataviz.
+     *
+     * We use this list to find all the fields for which
+     * we need to replace the code by their corresponding labels
+     *
+     * @return array<string> Array of layer ids
+     */
+    public function getLayersWithLabels()
+    {
+        // Keep a list of layer ids for which to replace the code by labels
+        $layersWithLabeledFields = array();
+
+        // Attribute layers
+        foreach ($this->getAttributeLayers() as $key => $config) {
+            if ($config->hideLayer == 'True') {
+                continue;
+            }
+            $layersWithLabeledFields[] = $config->layerId;
+        }
+
+        // Dataviz layers
+        foreach ($this->getDatavizLayers() as $o => $config) {
+            $layerId = $config->layerId;
+            if (array_key_exists($layerId, $layersWithLabeledFields)) {
+                continue;
+            }
+            $layersWithLabeledFields[] = $config->layerId;
+        }
+
+        // Form filter layers
+        foreach ($this->getFormFilterLayers() as $o => $config) {
+            $layerId = $config->layerId;
+            if (array_key_exists($layerId, $layersWithLabeledFields)) {
+                continue;
+            }
+            $layersWithLabeledFields[] = $config->layerId;
+        }
+
+        return $layersWithLabeledFields;
+    }
+
     /** Get the HTML template built from the Drag and drop layout
      * and override the original datavizTemplate configuration option.
      *

lizmap/modules/lizmap/lib/Project/ProjectMainData.php

@@ -244,53 +244,16 @@ public function getData()
      */
     protected function readXmlProject($qgs_path)
     {
-        $oXml = new \XMLReader();
-
-        // Open file
-        if (!$oXml->open($qgs_path)) {
-            throw new UnknownLizmapProjectException('The file '.$qgs_path.' cannot be parsed.');
-        }
+        $xmlReader = App\XmlTools::xmlReaderFromFile($qgs_path);
 
         $data = array();
         // Read until we are at the root document element
-        while ($oXml->read()) {
-            if ($oXml->nodeType == \XMLReader::ELEMENT
-                && $oXml->depth == 1
-                && $oXml->localName == 'properties') {
-                $data = array_merge($data, $this->readXmlProperties($oXml));
-            }
-        }
-        $errorMsg = '';
-        foreach (libxml_get_errors() as $error) {
-            if ($errorMsg !== '') {
-                $errorMsg .= '\n';
+        while ($xmlReader->read()) {
+            if ($xmlReader->nodeType == \XMLReader::ELEMENT
+                && $xmlReader->depth == 1
+                && $xmlReader->localName == 'properties') {
+                $data = array_merge($data, $this->readXmlProperties($xmlReader));
             }
-
-            switch ($error->level) {
-                case LIBXML_ERR_WARNING:
-                    $errorMsg .= 'Warning '.$error->code.': ';
-
-                    break;
-
-                case LIBXML_ERR_ERROR:
-                    $errorMsg .= 'Error '.$error->code.': ';
-
-                    break;
-
-                case LIBXML_ERR_FATAL:
-                    $errorMsg .= 'Fatal Error '.$error->code.': ';
-
-                    break;
-            }
-            $errorMsg .= 'Line: '.$error->line.' ';
-            $errorMsg .= 'Column: '.$error->column.' ';
-            $errorMsg .= trim($error->message);
-        }
-        // Clear libxml error buffer
-        libxml_clear_errors();
-
-        if ($errorMsg !== '') {
-            throw new \Exception($errorMsg);
         }
 
         return $data;