WorkbookWriter.cs

/*
 * NanoXLSX is a small .NET library to generate and read XLSX (Microsoft Excel 2007 or newer) files in an easy and native way  
 * Copyright Raphael Stoeckli © 2026
 * This library is licensed under the MIT License.
 * You find a copy of the license in project folder or on: http://opensource.org/licenses/MIT
 */
 
using NanoXLSX.Interfaces;
using NanoXLSX.Interfaces.Writer;
using NanoXLSX.Registry;
using NanoXLSX.Registry.Attributes;
using NanoXLSX.Themes;
using NanoXLSX.Utils;
using NanoXLSX.Utils.Xml;
using static NanoXLSX.Enums.Password;
 
namespace NanoXLSX.Internal.Writers
{
    [NanoXlsxPlugIn(PlugInUUID = PlugInUUID.WorkbookWriter)]
    internal class WorkbookWriter : IPluginWriter
    {
        private XmlElement workbook;
        private IPasswordWriter passwordWriter;
 
        #region properties
        public Workbook Workbook { get; set; }

        public XmlElement XmlElement => workbook;
 
        #endregion
        #region constructors
        internal WorkbookWriter()
        {
        }
 
        #endregion
        #region methods
        public void Init(IBaseWriter baseWriter)
        {
            this.Workbook = baseWriter.Workbook;
            IPassword passwordInstance = Workbook.WorkbookProtectionPassword;
            this.passwordWriter = PlugInLoader.GetPlugIn<IPasswordWriter>(PlugInUUID.PasswordWriter, new LegacyPasswordWriter());
            this.passwordWriter.Init(PasswordType.WorkbookProtection, passwordInstance.PasswordHash);
        }

        public void Execute()
        {
            Workbook wb = Workbook;
            workbook = XmlElement.CreateElement("workbook");
            workbook.AddDefaultXmlNameSpace("http://schemas.openxmlformats.org/spreadsheetml/2006/main");
            workbook.AddNameSpaceAttribute("r", "xmlns", "http://schemas.openxmlformats.org/officeDocument/2006/relationships");
            XmlElement workbookPr = workbook.AddChildElement("workbookPr");
            if (wb.WorkbookTheme != null)
            {
                workbookPr.AddAttribute("defaultThemeVersion", Theme.DefaultThemeVersion);
                // TODO: add further workbook properties here
            }
            if (wb.SelectedWorksheet > 0 || wb.Hidden || HasPaneSplitting())
            {
                XmlElement bookViews = workbook.AddChildElement("bookViews");
                XmlElement workbookView = bookViews.AddChildElement("workbookView");
                if (wb.Hidden)
                {
                    workbookView.AddAttribute("visibility", "hidden");
                }
                else
                {
                    workbookView.AddAttribute("activeTab", ParserUtils.ToString(wb.SelectedWorksheet));
                }
            }
            workbook.AddChildElement(GetWorkbookProtectionElement());
            XmlElement sheets = workbook.AddChildElement("sheets");
            if (wb.Worksheets.Count > 0)
            {
                foreach (Worksheet item in wb.Worksheets)
                {
                    XmlElement sheet = sheets.AddChildElementWithAttribute("sheet", "id", "rId" + ParserUtils.ToString(item.SheetID), "", "r");
                    sheet.AddAttribute("sheetId", item.SheetID.ToString());
                    sheet.AddAttribute("name", XmlUtils.SanitizeXmlValue(item.SheetName));
                    if (item.Hidden)
                    {
                        sheet.AddAttribute("state", "hidden");
                    }
                }
            }
            else
            {
                // Fallback on empty workbook
                XmlElement sheet = sheets.AddChildElementWithAttribute("sheet", "id", "rId1", "", "r");
                sheet.AddAttribute("sheetId", "1");
                sheet.AddAttribute("name", "sheet1");
            }
            workbook.AddChildElement(GetDefinedNamesElement());
 
            WriterPlugInHandler.HandleInlineQueuePlugins(ref workbook, Workbook, PlugInUUID.WorkbookInlineWriter);
        }

        private XmlElement GetDefinedNamesElement()
        {
            System.Collections.Generic.IReadOnlyList<DefinedName> names = Workbook.GetDefinedNames();
            if (names.Count == 0)
            {
                return null;
            }
            XmlElement definedNames = XmlElement.CreateElement("definedNames");
            foreach (DefinedName item in names)
            {
                XmlElement definedName = definedNames.AddChildElementWithValue("definedName", XmlUtils.SanitizeXmlValue(GetDefinedNameText(item)));
                definedName.AddAttribute("name", XmlUtils.SanitizeXmlValue(item.Name));
                if (item.LocalSheet != null)
                {
                    int index = Workbook.Worksheets.IndexOf(item.LocalSheet);
                    if (index >= 0)
                    {
                        definedName.AddAttribute("localSheetId", ParserUtils.ToString(index));
                    }
                }
                if (!string.IsNullOrEmpty(item.Comment))
                {
                    definedName.AddAttribute("comment", XmlUtils.SanitizeXmlValue(item.Comment));
                }
            }
            return definedNames;
        }
 
        private static string GetDefinedNameText(DefinedName definedName)
        {
            if ((definedName.Type == DefinedName.NameType.Cell || definedName.Type == DefinedName.NameType.Range)
                && definedName.TargetWorksheet != null)
            {
                string worksheetName = definedName.TargetWorksheet.SheetName.Replace("'", "''");
                return "'" + worksheetName + "'!" + definedName.TextValue;
            }
            if (definedName.Type == DefinedName.NameType.Constant && definedName.Value is string stringValue)
            {
                return "\"" + stringValue.Replace("\"", "\"\"") + "\"";
            }
            return definedName.TextValue;
        }

        private XmlElement GetWorkbookProtectionElement()
        {
            Workbook workbook = Workbook;
            XmlElement workbookProtection = null;
            if (workbook.UseWorkbookProtection)
            {
                workbookProtection = XmlElement.CreateElement("workbookProtection");
                if (workbook.LockWindowsIfProtected)
                {
                    workbookProtection.AddAttribute("lockWindows", "1");
                }
                if (workbook.LockStructureIfProtected)
                {
                    workbookProtection.AddAttribute("lockStructure", "1");
                }
                if (passwordWriter.PasswordIsSet())
                {
                    workbookProtection.AddAttributes(passwordWriter.GetAttributes());
                }
            }
            return workbookProtection;
        }

        private bool HasPaneSplitting()
        {
            foreach (Worksheet worksheet in Workbook.Worksheets)
            {
                if (worksheet.PaneSplitLeftWidth != null || worksheet.PaneSplitTopHeight != null || worksheet.PaneSplitAddress != null)
                {
                    return true;
                }
            }
            return false;
        }
 
        #endregion
 
    }
}