EPPlus/Drawing/Vml/ExcelVmlDrawingCommentCollection.cs

/*******************************************************************************
 * You may amend and distribute as you like, but don't remove this header!
 *
 * EPPlus provides server-side generation of Excel 2007/2010 spreadsheets.
 * See http://www.codeplex.com/EPPlus for details.
 *
 * Copyright (C) 2011  Jan Källman
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * The GNU Lesser General Public License can be viewed at http://www.opensource.org/licenses/lgpl-license.php
 * If you unfamiliar with this license or have questions about it, here is an http://www.gnu.org/licenses/gpl-faq.html
 *
 * All code and executables are provided "as is" with no warranty either express or implied.
 * The author accepts no liability for any damage or loss of business that this product may cause.
 *
 * Code change notes:
 *
 * Author							Change						Date
 * ******************************************************************************
 * Jan Källman		Initial Release		        2010-06-01
 * Jan Källman		License changed GPL-->LGPL 2011-12-16
 *******************************************************************************/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Xml;

namespace OfficeOpenXml.Drawing.Vml;

internal class ExcelVmlDrawingCommentCollection : ExcelVmlDrawingBaseCollection, IEnumerable {
  internal RangeCollection _drawings;

  internal ExcelVmlDrawingCommentCollection(ExcelPackage pck, ExcelWorksheet ws, Uri uri)
      : base(pck, ws, uri) {
    if (uri == null) {
      VmlDrawingXml.LoadXml(CreateVmlDrawings());
      _drawings = new(new());
    } else {
      AddDrawingsFromXml(ws);
    }
  }

  protected void AddDrawingsFromXml(ExcelWorksheet ws) {
    var nodes = VmlDrawingXml.SelectNodes("//v:shape", NameSpaceManager);
    var list = new List<IRangeId>();
    foreach (XmlNode node in nodes) {
      var rowNode = node.SelectSingleNode("x:ClientData/x:Row", NameSpaceManager);
      var colNode = node.SelectSingleNode("x:ClientData/x:Column", NameSpaceManager);
      if (rowNode != null && colNode != null) {
        var row = int.Parse(rowNode.InnerText) + 1;
        var col = int.Parse(colNode.InnerText) + 1;
        list.Add(new ExcelVmlDrawingComment(node, ws.Cells[row, col], NameSpaceManager));
      } else {
        list.Add(new ExcelVmlDrawingComment(node, ws.Cells[1, 1], NameSpaceManager));
      }
    }
    list.Sort((r1, r2) =>
        (r1.RangeID < r2.RangeID
                ? -1
                : r1.RangeID > r2.RangeID
                    ? 1
                    : 0)); //Vml drawings are not sorted. Sort to avoid missmatches.
    _drawings = new(list);
  }

  private string CreateVmlDrawings() {
    string vml = string.Format(
        "<xml xmlns:v=\"{0}\" xmlns:o=\"{1}\" xmlns:x=\"{2}\">",
        ExcelPackage._schemaMicrosoftVml,
        ExcelPackage._schemaMicrosoftOffice,
        ExcelPackage._schemaMicrosoftExcel);

    vml += "<o:shapelayout v:ext=\"edit\">";
    vml += "<o:idmap v:ext=\"edit\" data=\"1\"/>";
    vml += "</o:shapelayout>";

    vml +=
        "<v:shapetype id=\"_x0000_t202\" coordsize=\"21600,21600\" o:spt=\"202\" path=\"m,l,21600r21600,l21600,xe\">";
    vml += "<v:stroke joinstyle=\"miter\" />";
    vml += "<v:path gradientshapeok=\"t\" o:connecttype=\"rect\" />";
    vml += "</v:shapetype>";
    vml += "</xml>";

    return vml;
  }

  internal ExcelVmlDrawingComment Add(ExcelRangeBase cell) {
    XmlNode node = AddDrawing(cell);
    var draw = new ExcelVmlDrawingComment(node, cell, NameSpaceManager);
    _drawings.Add(draw);
    return draw;
  }

  private XmlNode AddDrawing(ExcelRangeBase cell) {
    int row = cell.Start.Row,
        col = cell.Start.Column;
    var node = VmlDrawingXml.CreateElement("v", "shape", ExcelPackage._schemaMicrosoftVml);

    var id = ExcelCellBase.GetCellId(cell.Worksheet.SheetID, cell._fromRow, cell._fromCol);
    var ix = _drawings.IndexOf(id);
    if (ix < 0 && (~ix < _drawings.Count)) {
      ix = ~ix;
      var prevDraw = _drawings[ix] as ExcelVmlDrawingBase;
      prevDraw.TopNode.ParentNode.InsertBefore(node, prevDraw.TopNode);
    } else {
      VmlDrawingXml.DocumentElement.AppendChild(node);
    }

    node.SetAttribute("id", GetNewId());
    node.SetAttribute("type", "#_x0000_t202");
    node.SetAttribute("style", "position:absolute;z-index:1; visibility:hidden");
    //node.SetAttribute("style", "position:absolute; margin-left:59.25pt;margin-top:1.5pt;width:108pt;height:59.25pt;z-index:1; visibility:hidden");
    node.SetAttribute("fillcolor", "#ffffe1");
    node.SetAttribute("insetmode", ExcelPackage._schemaMicrosoftOffice, "auto");

    string vml = "<v:fill color2=\"#ffffe1\" />";
    vml += "<v:shadow on=\"t\" color=\"black\" obscured=\"t\" />";
    vml += "<v:path o:connecttype=\"none\" />";
    vml += "<v:textbox style=\"mso-direction-alt:auto\">";
    vml += "<div style=\"text-align:left\" />";
    vml += "</v:textbox>";
    vml += "<x:ClientData ObjectType=\"Note\">";
    vml += "<x:MoveWithCells />";
    vml += "<x:SizeWithCells />";
    vml += string.Format(
        "<x:Anchor>{0}, 15, {1}, 2, {2}, 31, {3}, 1</x:Anchor>",
        col,
        row - 1,
        col + 2,
        row + 3);
    vml += "<x:AutoFill>False</x:AutoFill>";
    vml += string.Format("<x:Row>{0}</x:Row>", row - 1);
    ;
    vml += string.Format("<x:Column>{0}</x:Column>", col - 1);
    vml += "</x:ClientData>";

    node.InnerXml = vml;
    return node;
  }

  private int _nextID;

  /// <summary>
  /// returns the next drawing id.
  /// </summary>
  /// <returns></returns>
  internal string GetNewId() {
    if (_nextID == 0) {
      foreach (ExcelVmlDrawingComment draw in this) {
        if (draw.Id.Length > 3 && draw.Id.StartsWith("vml")) {
          if (int.TryParse(draw.Id.Substring(3, draw.Id.Length - 3), out var id)) {
            if (id > _nextID) {
              _nextID = id;
            }
          }
        }
      }
    }
    _nextID++;
    return "vml" + _nextID;
  }

  internal ExcelVmlDrawingBase this[ulong rangeId] => _drawings[rangeId] as ExcelVmlDrawingComment;

  internal bool ContainsKey(ulong rangeId) {
    return _drawings.ContainsKey(rangeId);
  }

  internal int Count => _drawings.Count;

  public IEnumerator GetEnumerator() {
    return _drawings;
  }

  IEnumerator IEnumerable.GetEnumerator() {
    return _drawings;
  }
}