terriajs/lib/Models/Catalog/Esri/ArcGisMapServerCatalogGroup.ts

Geospatial data visualization platform.

import i18next from "i18next";
import { action, computed, makeObservable, override, runInAction } from "mobx";
import URI from "urijs";
import filterOutUndefined from "../../../Core/filterOutUndefined";
import isDefined from "../../../Core/isDefined";
import loadJson from "../../../Core/loadJson";
import replaceUnderscores from "../../../Core/replaceUnderscores";
import runLater from "../../../Core/runLater";
import { networkRequestError } from "../../../Core/TerriaError";
import CatalogMemberMixin from "../../../ModelMixins/CatalogMemberMixin";
import GroupMixin from "../../../ModelMixins/GroupMixin";
import UrlMixin from "../../../ModelMixins/UrlMixin";
import ModelReference from "../../../Traits/ModelReference";
import ArcGisMapServerCatalogGroupTraits from "../../../Traits/TraitsClasses/ArcGisMapServerCatalogGroupTraits";
import { InfoSectionTraits } from "../../../Traits/TraitsClasses/CatalogMemberTraits";
import CommonStrata from "../../Definition/CommonStrata";
import CreateModel from "../../Definition/CreateModel";
import createStratumInstance from "../../Definition/createStratumInstance";
import LoadableStratum from "../../Definition/LoadableStratum";
import { BaseModel, ModelConstructorParameters } from "../../Definition/Model";
import StratumOrder from "../../Definition/StratumOrder";
import proxyCatalogItemUrl from "../proxyCatalogItemUrl";
import ArcGisCatalogGroup from "./ArcGisCatalogGroup";
import { Layer, MapServer } from "./ArcGisInterfaces";
import ArcGisMapServerCatalogItem from "./ArcGisMapServerCatalogItem";

/** The ID we add to our "All layers" ArcGisMapServerCatalogItem if MapServer.singleFusedMapCache is true */
const SINGLE_FUSED_MAP_CACHE_ID = "all-layers";

export class MapServerStratum extends LoadableStratum(
  ArcGisMapServerCatalogGroupTraits
) {
  static stratumName = "mapServer";

  constructor(
    private readonly _catalogGroup:
      | ArcGisMapServerCatalogGroup
      | ArcGisCatalogGroup,
    private readonly _mapServer: MapServer
  ) {
    super();
    makeObservable(this);
  }

  duplicateLoadableStratum(model: BaseModel): this {
    return new MapServerStratum(
      model as ArcGisMapServerCatalogGroup,
      this._mapServer
    ) as this;
  }

  /** returns an array of the parent layers id's */
  findParentLayers(layerId: number): number[] {
    const parentLayerIds: number[] = [];
    const layer = this.layers.find((l) => l.id === layerId);
    if (layer !== undefined) {
      parentLayerIds.push(layer.id);
      if (layer.parentLayerId !== -1) {
        parentLayerIds.push(...this.findParentLayers(layer.parentLayerId));
      }
    }
    return parentLayerIds;
  }

  @computed get name() {
    if (
      this._mapServer.documentInfo &&
      this._mapServer.documentInfo.Title &&
      this._mapServer.documentInfo.Title.length > 0
    ) {
      return replaceUnderscores(this._mapServer.documentInfo.Title);
    }
  }

  @computed get info() {
    return [
      createStratumInstance(InfoSectionTraits, {
        name: i18next.t(
          "models.arcGisMapServerCatalogGroup.serviceDescription"
        ),
        content: this._mapServer.serviceDescription
      }),
      createStratumInstance(InfoSectionTraits, {
        name: i18next.t("models.arcGisMapServerCatalogGroup.dataDescription"),
        content: this._mapServer.description
      }),
      createStratumInstance(InfoSectionTraits, {
        name: i18next.t("models.arcGisMapServerCatalogGroup.copyrightText"),
        content: this._mapServer.copyrightText
      })
    ];
  }

  @computed get dataCustodian() {
    if (
      this._mapServer.documentInfo &&
      this._mapServer.documentInfo.Author &&
      this._mapServer.documentInfo.Author.length > 0
    ) {
      return this._mapServer.documentInfo.Author;
    }
  }

  static async load(
    catalogGroup: ArcGisMapServerCatalogGroup | ArcGisCatalogGroup
  ): Promise<MapServerStratum> {
    const uri = new URI(catalogGroup.url).addQuery("f", "json");

    if (catalogGroup.token) {
      uri.addQuery("token", catalogGroup.token);
    }

    const mapServer: MapServer | undefined = await loadJson(
      proxyCatalogItemUrl(catalogGroup, uri.toString())
    );

    // Is this really a MapServer REST response?
    if (!mapServer || (!mapServer.layers && !mapServer.subLayers)) {
      throw networkRequestError({
        title: i18next.t(
          "models.arcGisMapServerCatalogGroup.invalidServiceTitle"
        ),
        message: i18next.t(
          "models.arcGisMapServerCatalogGroup.invalidServiceMessage"
        )
      });
    }
    const stratum = new MapServerStratum(catalogGroup, mapServer);
    return stratum;
  }

  @computed get tilesOnly() {
    return (
      this._mapServer.singleFusedMapCache &&
      this._mapServer.capabilities?.includes("TilesOnly")
    );
  }

  @computed
  get members(): ModelReference[] {
    if (this.tilesOnly) {
      return [`${this._catalogGroup.uniqueId}/${SINGLE_FUSED_MAP_CACHE_ID}`];
    }

    return filterOutUndefined(
      this.layers
        .map((layer) => {
          if (!isDefined(layer.id) || layer.parentLayerId !== -1) {
            return undefined;
          }
          return this._catalogGroup.uniqueId + "/" + layer.id;
        })
        .concat(
          this.subLayers.map((subLayer) => {
            if (!isDefined(subLayer.id)) {
              return undefined;
            }
            return this._catalogGroup.uniqueId + "/" + subLayer.id;
          })
        )
    );
  }

  private get layers() {
    return this._mapServer.layers || [];
  }

  private get subLayers() {
    return this._mapServer.subLayers || [];
  }

  @action
  createMembersFromLayers() {
    if (this.tilesOnly) this.createMemberForSingleFusedMapCache();
    else this.layers.forEach((layer) => this.createMemberFromLayer(layer));
  }

  @action
  private createMemberForSingleFusedMapCache() {
    const id = `${this._catalogGroup.uniqueId}/${SINGLE_FUSED_MAP_CACHE_ID}`;
    let model = this._catalogGroup.terria.getModelById(
      ArcGisMapServerCatalogItem,
      id
    );
    if (model === undefined) {
      model = new ArcGisMapServerCatalogItem(id, this._catalogGroup.terria);
      this._catalogGroup.terria.addModel(model);
    }

    // Replace the stratum inherited from the parent group.
    model.strata.delete(CommonStrata.definition);

    model.setTrait(
      CommonStrata.definition,
      "name",
      i18next
        .t("models.arcGisMapServerCatalogGroup.singleFusedMapCacheLayerName")
        .toString()
    );
    model.setTrait(CommonStrata.definition, "url", this._catalogGroup.url);
    if (this._catalogGroup.token) {
      model.setTrait(
        CommonStrata.definition,
        "token",
        this._catalogGroup.token
      );
    }
  }

  @action
  private createMemberFromLayer(layer: Layer) {
    if (!isDefined(layer.id)) {
      return;
    }
    const id = this._catalogGroup.uniqueId;
    let layerId = id + "/" + layer.id;

    const parentLayers = this.findParentLayers(layer.id);

    if (parentLayers.length > 0) {
      layerId = id + "/" + parentLayers.reverse().join("/");
    }

    let model: ArcGisMapServerCatalogItem | ArcGisMapServerCatalogGroup;

    // Treat layer as a group if it has type "Group Layer" - or has subLayers
    if (
      layer.type === "Group Layer" ||
      (Array.isArray(layer.subLayerIds) && layer.subLayerIds.length > 0)
    ) {
      const existingModel = this._catalogGroup.terria.getModelById(
        ArcGisMapServerCatalogGroup,
        layerId
      );
      if (existingModel === undefined) {
        model = new ArcGisMapServerCatalogGroup(
          layerId,
          this._catalogGroup.terria
        );
        this._catalogGroup.terria.addModel(model);
      } else {
        model = existingModel;
      }
    } else {
      const existingModel = this._catalogGroup.terria.getModelById(
        ArcGisMapServerCatalogItem,
        layerId
      );

      if (existingModel === undefined) {
        model = new ArcGisMapServerCatalogItem(
          layerId,
          this._catalogGroup.terria
        );
        this._catalogGroup.terria.addModel(model);
      } else {
        model = existingModel;
      }
    }

    // Replace the stratum inherited from the parent group.
    model.strata.delete(CommonStrata.definition);

    model.setTrait(
      CommonStrata.definition,
      "name",
      replaceUnderscores(layer.name)
    );

    const uri = new URI(this._catalogGroup.url).segment(layer.id.toString()); // Convert layer id to string as segment(0) means something different.
    model.setTrait(CommonStrata.definition, "url", uri.toString());

    if (this._catalogGroup.token) {
      if (model instanceof ArcGisMapServerCatalogItem)
        model.setTrait(
          CommonStrata.definition,
          "token",
          this._catalogGroup.token
        );
      if (model instanceof ArcGisMapServerCatalogGroup)
        model.setTrait(
          CommonStrata.definition,
          "token",
          this._catalogGroup.token
        );
    }
  }
}

StratumOrder.addLoadStratum(MapServerStratum.stratumName);

export default class ArcGisMapServerCatalogGroup extends UrlMixin(
  GroupMixin(CatalogMemberMixin(CreateModel(ArcGisMapServerCatalogGroupTraits)))
) {
  static readonly type = "esri-mapServer-group";

  constructor(...args: ModelConstructorParameters) {
    super(...args);
    makeObservable(this);
  }

  get type() {
    return ArcGisMapServerCatalogGroup.type;
  }

  get typeName() {
    return i18next.t("models.arcGisMapServerCatalogGroup.name");
  }

  @override
  get cacheDuration(): string {
    if (isDefined(super.cacheDuration)) {
      return super.cacheDuration;
    }
    return "1d";
  }

  protected async forceLoadMetadata(): Promise<void> {
    const stratum = await MapServerStratum.load(this);
    runInAction(() => {
      this.strata.set(MapServerStratum.stratumName, stratum);
    });
  }

  protected async forceLoadMembers() {
    const mapServerStratum = this.strata.get(MapServerStratum.stratumName) as
      | MapServerStratum
      | undefined;
    if (mapServerStratum) {
      await runLater(() => mapServerStratum.createMembersFromLayers());
    }
  }
}