speckle-sharp-connectors/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Utils/ArcGisDocumentStore.cs

using System.Xml.Linq;
using ArcGIS.Desktop.Core.Events;
using ArcGIS.Desktop.Framework.Threading.Tasks;
using ArcGIS.Desktop.Mapping;
using ArcGIS.Desktop.Mapping.Events;
using Speckle.Connectors.DUI.Bridge;
using Speckle.Connectors.DUI.Models;
using Speckle.Connectors.Utils;
using Speckle.Newtonsoft.Json;

namespace Speckle.Connectors.ArcGIS.Utils;

public class ArcGISDocumentStore : DocumentModelStore
{
  public ArcGISDocumentStore(
    JsonSerializerSettings serializerOption,
    ITopLevelExceptionHandler topLevelExceptionHandler
  )
    : base(serializerOption, true)
  {
    ActiveMapViewChangedEvent.Subscribe(a => topLevelExceptionHandler.CatchUnhandled(() => OnMapViewChanged(a)), true);
    ProjectSavingEvent.Subscribe(
      _ =>
      {
        topLevelExceptionHandler.CatchUnhandled(OnProjectSaving);
        return Task.CompletedTask;
      },
      true
    );
    ProjectClosingEvent.Subscribe(
      _ =>
      {
        topLevelExceptionHandler.CatchUnhandled(OnProjectClosing);
        return Task.CompletedTask;
      },
      true
    );

    // in case plugin was loaded into already opened Map, read metadata from the current Map
    if (IsDocumentInit == false && MapView.Active != null)
    {
      IsDocumentInit = true;
      ReadFromFile();
      OnDocumentChanged();
    }
  }

  private void OnProjectClosing()
  {
    if (MapView.Active is null)
    {
      return;
    }

    WriteToFile();
  }

  private void OnProjectSaving()
  {
    if (MapView.Active is not null)
    {
      WriteToFile();
    }
  }

  /// <summary>
  /// On map view switch, this event trigger twice, first for outgoing view, second for incoming view.
  /// </summary>
  private void OnMapViewChanged(ActiveMapViewChangedEventArgs args)
  {
    if (args.IncomingView is null)
    {
      return;
    }

    IsDocumentInit = true;
    ReadFromFile();
    OnDocumentChanged();
  }

  public override void WriteToFile()
  {
    Map map = MapView.Active.Map;
    QueuedTask.Run(() =>
    {
      // Read existing metadata - To prevent messing existing metadata. 🤞 Hope other add-in developers will do same :D
      var existingMetadata = map.GetMetadata();

      // Parse existing metadata
      XDocument existingXmlDocument = !string.IsNullOrEmpty(existingMetadata)
        ? XDocument.Parse(existingMetadata)
        : new XDocument(new XElement("metadata"));

      string serializedModels = Serialize();

      XElement xmlModelCards = new("SpeckleModelCards", serializedModels);

      // Check if SpeckleModelCards element already exists at root and update it
      var speckleModelCardsElement = existingXmlDocument.Root?.Element("SpeckleModelCards");
      if (speckleModelCardsElement != null)
      {
        speckleModelCardsElement.ReplaceWith(xmlModelCards);
      }
      else
      {
        existingXmlDocument.Root?.Add(xmlModelCards);
      }

      map.SetMetadata(existingXmlDocument.ToString());
    });
  }

  public override void ReadFromFile()
  {
    Map map = MapView.Active.Map;
    QueuedTask.Run(() =>
    {
      var metadata = map.GetMetadata();
      var root = XDocument.Parse(metadata).Root;
      var element = root?.Element("SpeckleModelCards");
      if (element is null)
      {
        Models = new();
        return;
      }

      string modelsString = element.Value;
      Models = Deserialize(modelsString).NotNull();
    });
  }
}