Source: modules/Config.js

  1. /**
  2.  * @module modules/Config.js
  3.  * @name Config
  4.  * @copyright 2023 3Liz
  5.  * @author DHONT René-Luc
  6.  * @license MPL-2.0
  7.  */
  9. import { ValidationError } from './Errors.js';
  10. import { deepFreeze } from './config/Tools.js';
  11. import { MetadataConfig } from './config/Metadata.js';
  12. import { OptionsConfig } from './config/Options.js';
  13. import { LayersConfig } from './config/Layer.js';
  14. import { BaseLayersConfig } from './config/BaseLayer.js';
  15. import { LocateByLayerConfig } from './config/Locate.js';
  16. import { AttributeLayersConfig } from './config/AttributeTable.js';
  17. import { TooltipLayersConfig } from './config/Tooltip.js';
  18. import { EditionLayersConfig } from './config/Edition.js';
  19. import { TimeManagerLayersConfig } from './config/TimeManager.js';
  20. import { FormFilterConfig } from './config/FormFilter.js';
  21. import { ThemesConfig } from './config/Theme.js';
  22. import { DatavizOptionsConfig, DatavizLayersConfig } from './config/Dataviz.js';
  23. import { buildLayerTreeConfig, LayerTreeGroupConfig } from './config/LayerTree.js';
  24. import { buildLayersOrder } from './config/LayersOrder.js';
  26. /**
  27.  * @typedef WfsFeatureType
  28.  * @type {object}
  29.  * @property {string} Name  - The layer typename.
  30.  * @property {string} Title - The layer title.
  31.  * @property {string} SRS   - The layer CRS code.
  32.  * @property {number[]} LatLongBoundingBox - The layer bounding box in the layer CRS
  33.  */
  35. /**
  36.  * @class
  37.  * @name Config
  38.  */
  39. export class Config {
  41.     /**
  42.      * Create a new Config object
  43.      * @param {object} cfg               - the lizmap config object
  44.      * @param {object} wmsCapabilities   - the WMS capabilities
  45.      * @param {object} [wfsCapabilities] - the WFS capabilities
  46.      */
  47.     constructor(cfg, wmsCapabilities, wfsCapabilities) {
  48.         if (!cfg || typeof cfg !== "object") {
  49.             throw new ValidationError('The config is not an Object! It\'s '+(typeof cfg));
  50.         }
  52.         if (Object.getOwnPropertyNames(cfg).length == 0) {
  53.             throw new ValidationError('The config is empty!');
  54.         }
  56.         if (!wmsCapabilities || typeof wmsCapabilities !== "object") {
  57.             throw new ValidationError('The WMS Capabilities is not an Object! It\'s '+(typeof wmsCapabilities));
  58.         }
  60.         if (Object.getOwnPropertyNames(wmsCapabilities).length == 0) {
  61.             throw new ValidationError('The WMS Capabilities is empty!');
  62.         }
  64.         this._theConfig = null;
  65.         this._theWmsCapabilities = null;
  66.         this._theWfsCapabilities = null;
  67.         this._options = null;
  68.         this._layers = null;
  69.         this._layerTree = null;
  70.         this._invalidLayers = null;
  71.         this._baselayers = null;
  72.         this._layersOrder = null;
  73.         this._hasMetadata = true;
  74.         this._metadata = null;
  75.         this._hasLocateByLayer = true;
  76.         this._locateByLayer = null;
  77.         this._hasAttributeLayers = true;
  78.         this._attributeLayers = null;
  79.         this._hasTimemanagerLayers = true;
  80.         this._timemanagerLayers = null;
  81.         this._hasRelations = true;
  82.         this._hasPrintTemplates = true;
  83.         this._hasTooltipLayers = true;
  84.         this._tooltipLayers = null;
  85.         this._hasEditionLayers = true;
  86.         this._editionLayers = null;
  87.         this._hasFormFilterLayers = true;
  88.         this._formFilterLayers = null;
  89.         this._hasLoginFilteredLayers = true;
  90.         this._hasThemes = true;
  91.         this._themes = null;
  92.         this._hasDatavizConfig = true;
  93.         this._datavizLayers = null;
  94.         this._datavizOptions = null;
  96.         const theConfig = deepFreeze(cfg);
  98.         // checking config
  99.         const mandatoryConfigProperties = [
  100.             'options',
  101.             'layers',
  102.             'datavizLayers' // needed for locale property to build plot
  103.         ];
  104.         for (const prop of mandatoryConfigProperties) {
  105.             if (!theConfig.hasOwnProperty(prop)) {
  106.                 throw new ValidationError('No `' + prop + '` in the config!');
  107.             }
  108.         }
  110.         const theWmsCapabilities = deepFreeze(wmsCapabilities);
  112.         // checking WMS Capabilities
  113.         const mandatoryWmsCapabilitiesgProperties = [
  114.             'Capability', //needed for  layers tree
  115.         ];
  116.         for (const prop of mandatoryWmsCapabilitiesgProperties) {
  117.             if (!theWmsCapabilities.hasOwnProperty(prop)) {
  118.                 throw new ValidationError('No `' + prop + '` in the WMS Capabilities!');
  119.             }
  120.         }
  121.         this._theConfig = theConfig;
  122.         this._theWmsCapabilities = theWmsCapabilities;
  123.         if (wfsCapabilities) {
  124.             this._theWfsCapabilities = deepFreeze(wfsCapabilities);
  125.         }
  127.         const optionalConfigProperties = [
  128.             'metadata',
  129.             'locateByLayer',
  130.             'attributeLayers',
  131.             'timemanagerLayers',
  132.             'relations',
  133.             'printTemplates',
  134.             'tooltipLayers',
  135.             'editionLayers',
  136.             'formFilterLayers',
  137.             'loginFilteredLayers',
  138.             'themes'
  139.         ];
  140.         for (const prop of optionalConfigProperties) {
  141.             if (!theConfig.hasOwnProperty(prop)
  142.                 || Object.getOwnPropertyNames(theConfig[prop]).length == 0) {
  143.                 this['_has'+prop.charAt(0).toUpperCase() + prop.slice(1)] = false;
  144.             }
  145.         }
  147.         // check datavizConfig
  148.         if ((!theConfig.datavizLayers.hasOwnProperty('layers')
  149.             || Object.getOwnPropertyNames(theConfig.datavizLayers.layers).length == 0)
  150.             && (!theConfig.datavizLayers.hasOwnProperty('dataviz')
  151.             || Object.getOwnPropertyNames(theConfig.datavizLayers.dataviz).length == 0)) {
  152.             this._hasDatavizConfig = false;
  153.         }
  154.     }
  156.     /**
  157.      * Config options
  158.      * @type {OptionsConfig}
  159.      */
  160.     get options() {
  161.         if (this._options != null) {
  162.             return this._options;
  163.         }
  164.         this._options = new OptionsConfig(this._theConfig.options);
  165.         return this._options;
  166.     }
  168.     /**
  169.      * Config layers
  170.      * @type {LayersConfig}
  171.      */
  172.     get layers() {
  173.         if (this._layers != null) {
  174.             return this._layers;
  175.         }
  176.         this._layers = new LayersConfig(this._theConfig.layers);
  177.         return this._layers;
  178.     }
  180.     /**
  181.      * Root tree layer group
  182.      * @type {LayerTreeGroupConfig}
  183.      */
  184.     get layerTree() {
  185.         if (this._layerTree == null) {
  186.             this._invalidLayers = [];
  187.             this._layerTree = buildLayerTreeConfig(
  188.                 this._theWmsCapabilities.Capability.Layer,
  189.                 this.layers,
  190.                 this._invalidLayers,
  191.             );
  192.         }
  193.         return this._layerTree;
  194.     }
  196.     /**
  197.      * List of invalid layers, not found in the Lizmap configuration file, but found in the WMS GetCapabilities.
  198.      * @type {string[]}
  199.      */
  200.     get invalidLayersNotFoundInCfg() {
  201.         if (this._invalidLayers == null) {
  202.             this.layerTree;
  203.         }
  204.         return this._invalidLayers;
  205.     }
  207.     /**
  208.      * Config base layers
  209.      * @type {BaseLayersConfig}
  210.      */
  211.     get baseLayers() {
  212.         if (this._baselayers != null) {
  213.             return this._baselayers;
  214.         }
  215.         let baseLayersCfg = {};
  216.         if (this._theConfig.hasOwnProperty('baseLayers')) {
  217.             baseLayersCfg = this._theConfig.baseLayers;
  218.         }
  219.         let baseLayerTreeItem = null;
  220.         for (const layerTreeItem of this.layerTree.getChildren()) {
  221.             if ( layerTreeItem.name.toLowerCase() == 'baselayers') {
  222.                 baseLayerTreeItem = layerTreeItem;
  223.                 break;
  224.             }
  225.         }
  226.         let hiddenTreeItem = null;
  227.         for (const layerTreeItem of this.layerTree.getChildren()) {
  228.             if ( layerTreeItem.name.toLowerCase() == 'hidden') {
  229.                 hiddenTreeItem = layerTreeItem;
  230.                 break;
  231.             }
  232.         }
  233.         this._baselayers = new BaseLayersConfig(baseLayersCfg, this._theConfig.options, this.layers, baseLayerTreeItem, hiddenTreeItem);
  234.         return this._baselayers;
  235.     }
  237.     /**
  238.      * Layer names displaying order like in QGIS
  239.      *
  240.      * The first one in this list is the top one in the map
  241.      * The last one in this list is the bottom one in the map
  242.      * @type {string[]}
  243.      */
  244.     get layersOrder() {
  245.         if (this._layersOrder == null) {
  246.             this._layersOrder = buildLayersOrder(this._theConfig, this.layerTree);
  247.         }
  248.         return [...this._layersOrder];
  249.     }
  251.     /**
  252.      * The list of format for file export
  253.      * @type {string[]}
  254.      */
  255.     get vectorLayerResultFormat() {
  256.         const formats = [];
  257.         if ( this._theWfsCapabilities == null ){
  258.             return formats;
  259.         }
  261.         for (const request of this._theWfsCapabilities.Capability.Request) {
  262.             if (request.name != 'GetFeature') {
  263.                 continue;
  264.             }
  265.             return request.ResultFormat
  266.         }
  267.         return formats;
  268.     }
  270.     /**
  271.      * The list of WFS feature type
  272.      * @type {WfsFeatureType[]}
  273.      */
  274.     get vectorLayerFeatureTypeList() {
  275.         const featureTypes = [];
  276.         if ( this._theWfsCapabilities == null ){
  277.             return featureTypes;
  278.         }
  279.         if ( this._theWfsCapabilities.FeatureTypeList &&
  280.             this._theWfsCapabilities.FeatureTypeList.FeatureType
  281.         ) {
  282.             return this._theWfsCapabilities.FeatureTypeList.FeatureType;
  283.         }
  284.         return featureTypes;
  285.     }
  287.     /**
  288.      * Config metadata
  289.      * @type {MetadataConfig}
  290.      */
  291.     get metadata() {
  292.         if (this._metadata != null) {
  293.             return this._metadata;
  294.         }
  295.         if (this._hasMetadata) {
  296.             this._metadata = new MetadataConfig(this._theConfig.metadata);
  297.         } else {
  298.             this._metadata = new MetadataConfig();
  299.         }
  300.         return this._metadata;
  301.     }
  303.     /**
  304.      * Locate by layer config is defined
  305.      * @type {boolean}
  306.      */
  307.     get hasLocateByLayer() {
  308.         return this._hasLocateByLayer;
  309.     }
  311.     /**
  312.      * Config locateByLayer
  313.      * @type {LocateByLayerConfig|null}
  314.      */
  315.     get locateByLayer() {
  316.         if (this._hasLocateByLayer) {
  317.             if (this._locateByLayer != null) {
  318.                 return this._locateByLayer;
  319.             }
  320.             this._locateByLayer = new LocateByLayerConfig(this._theConfig.locateByLayer);
  321.         }
  322.         return this._locateByLayer;
  323.     }
  325.     /**
  326.      * Attribute layers config is defined
  327.      * @type {boolean}
  328.      */
  329.     get hasAttributeLayers() {
  330.         return this._hasAttributeLayers;
  331.     }
  333.     /**
  334.      * Config attribueLayers
  335.      * @type {AttributeLayersConfig|null}
  336.      */
  337.     get attributeLayers() {
  338.         if (this._hasAttributeLayers) {
  339.             if (this._attributeLayers != null) {
  340.                 return this._attributeLayers;
  341.             }
  342.             this._attributeLayers = new AttributeLayersConfig(this._theConfig.attributeLayers);
  343.         }
  344.         return this._attributeLayers;
  345.     }
  347.     /**
  348.      * Time manager config is defined
  349.      * @type {boolean}
  350.      */
  351.     get hasTimemanagerLayers() {
  352.         return this._hasTimemanagerLayers;
  353.     }
  355.     /**
  356.      * Config timemanagerLayers
  357.      * @type {AttributeLayersConfig|null}
  358.      */
  359.     get timemanagerLayers() {
  360.         if (this._hasTimemanagerLayers) {
  361.             if (this._timemanagerLayers != null) {
  362.                 return this._timemanagerLayers;
  363.             }
  364.             this._timemanagerLayers = new TimeManagerLayersConfig(this._theConfig.timemanagerLayers);
  365.         }
  366.         return this._timemanagerLayers;
  367.     }
  369.     /**
  370.      * Relations config is defined
  371.      * @type {boolean}
  372.      */
  373.     get hasRelations() {
  374.         return this._hasRelations;
  375.     }
  377.     /**
  378.      * Print templates config is defined
  379.      * @type {boolean}
  380.      */
  381.     get hasPrintTemplates() {
  382.         return this._hasPrintTemplates;
  383.     }
  385.     /**
  386.      * Tooltip layers config is defined
  387.      * @type {boolean}
  388.      */
  389.     get hasTooltipLayers() {
  390.         return this._hasTooltipLayers;
  391.     }
  393.     /**
  394.      * Config tooltipLayers
  395.      * @type {TooltipLayersConfig|null}
  396.      */
  397.     get tooltipLayers() {
  398.         if (this._hasTooltipLayers) {
  399.             if (this._tooltipLayers != null) {
  400.                 return this._tooltipLayers;
  401.             }
  402.             this._tooltipLayers = new TooltipLayersConfig(this._theConfig.tooltipLayers);
  403.         }
  404.         return this._tooltipLayers;
  405.     }
  407.     /**
  408.      * Edition layers config is defined
  409.      * @type {boolean}
  410.      */
  411.     get hasEditionLayers() {
  412.         return this._hasEditionLayers;
  413.     }
  415.     /**
  416.      * Config editionLayers
  417.      * @type {EditionLayersConfig|null}
  418.      */
  419.     get editionLayers() {
  420.         if (this._hasEditionLayers) {
  421.             if (this._editionLayers != null) {
  422.                 return this._editionLayers;
  423.             }
  424.             this._editionLayers = new EditionLayersConfig(this._theConfig.editionLayers);
  425.         }
  426.         return this._editionLayers;
  427.     }
  429.     /**
  430.      * Form filter layers config is defined
  431.      * @type {boolean}
  432.      */
  433.     get hasFormFilterLayers() {
  434.         return this._hasFormFilterLayers;
  435.     }
  437.     /**
  438.      * Config formFilterLayers
  439.      * @type {FormFilterConfig|null}
  440.      */
  441.     get formFilterLayers() {
  442.         if (this.hasFormFilterLayers) {
  443.             if (this._formFilterLayers != null) {
  444.                 return this._formFilterLayers;
  445.             }
  446.             this._formFilterLayers = new FormFilterConfig(this._theConfig.formFilterLayers);
  447.         }
  448.         return this._formFilterLayers;
  449.     }
  451.     /**
  452.      * Login filtered layers config is defined
  453.      * @type {boolean}
  454.      */
  455.     get hasLoginFilteredLayers() {
  456.         return this._hasLoginFilteredLayers;
  457.     }
  459.     /**
  460.      * Themes config is defined
  461.      * @type {boolean}
  462.      */
  463.     get hasThemes() {
  464.         return this._hasThemes;
  465.     }
  467.     /**
  468.      * Config themes
  469.      * @type {ThemesConfig|null}
  470.      */
  471.     get themes() {
  472.         if (this.hasThemes) {
  473.             if (this._themes != null) {
  474.                 return this._themes;
  475.             }
  476.             this._themes = new ThemesConfig(this._theConfig.themes);
  477.         }
  478.         return this._themes;
  479.     }
  481.     /**
  482.      * Dataviz locale
  483.      * @type {string}
  484.      */
  485.     get datavizLocale() {
  486.         return this._theConfig.datavizLayers.locale;
  487.     }
  489.     /**
  490.      * Dataviz config is defined
  491.      * @type {boolean}
  492.      */
  493.     get hasDatavizConfig() {
  494.         return this._hasDatavizConfig;
  495.     }
  497.     /**
  498.      * Config datavizLayers
  499.      * @type {DatavizLayersConfig|null}
  500.      */
  501.     get datavizLayers() {
  502.         if (this._hasDatavizConfig) {
  503.             if (this._datavizLayers != null) {
  504.                 return this._datavizLayers;
  505.             }
  506.             this._datavizLayers = new DatavizLayersConfig(this._theConfig.datavizLayers.layers);
  507.         }
  508.         return this._datavizLayers;
  509.     }
  511.     /**
  512.      * Config datavizOptions
  513.      * @type {DatavizOptionsConfig|null}
  514.      */
  515.     get datavizOptions() {
  516.         if (this._hasDatavizConfig) {
  517.             if (this._datavizOptions != null) {
  518.                 return this._datavizOptions;
  519.             }
  520.             this._datavizOptions = new DatavizOptionsConfig(this._theConfig.datavizLayers.dataviz);
  521.         }
  522.         return this._datavizOptions;
  523.     }
  524. }