xlnt/source/serialization/workbook_serializer.cpp

// Copyright (c) 2014-2016 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file
#include <algorithm>

#include <xlnt/packaging/app_properties.hpp>
#include <xlnt/packaging/document_properties.hpp>
#include <xlnt/packaging/manifest.hpp>
#include <xlnt/packaging/relationship.hpp>
#include <xlnt/serialization/workbook_serializer.hpp>
#include <xlnt/serialization/xml_document.hpp>
#include <xlnt/serialization/xml_node.hpp>
#include <xlnt/utils/datetime.hpp>
#include <xlnt/utils/exceptions.hpp>
#include <xlnt/workbook/named_range.hpp>
#include <xlnt/workbook/workbook.hpp>
#include <xlnt/workbook/worksheet_iterator.hpp>
#include <xlnt/worksheet/range_reference.hpp>
#include <xlnt/worksheet/worksheet.hpp>

#include <detail/constants.hpp>

namespace {

xlnt::datetime w3cdtf_to_datetime(const std::string &string)
{
    xlnt::datetime result(1900, 1, 1);
    auto separator_index = string.find('-');
    result.year = std::stoi(string.substr(0, separator_index));
    result.month = std::stoi(string.substr(separator_index + 1, string.find('-', separator_index + 1)));
    separator_index = string.find('-', separator_index + 1);
    result.day = std::stoi(string.substr(separator_index + 1, string.find('T', separator_index + 1)));
    separator_index = string.find('T', separator_index + 1);
    result.hour = std::stoi(string.substr(separator_index + 1, string.find(':', separator_index + 1)));
    separator_index = string.find(':', separator_index + 1);
    result.minute = std::stoi(string.substr(separator_index + 1, string.find(':', separator_index + 1)));
    separator_index = string.find(':', separator_index + 1);
    result.second = std::stoi(string.substr(separator_index + 1, string.find('Z', separator_index + 1)));
    return result;
}

std::string fill(const std::string &string, std::size_t length = 2)
{
    if (string.size() >= length)
    {
        return string;
    }

    return std::string(length - string.size(), '0') + string;
}

std::string datetime_to_w3cdtf(const xlnt::datetime &dt)
{
    return std::to_string(dt.year) + "-" + fill(std::to_string(dt.month)) + "-" + fill(std::to_string(dt.day)) + "T" +
           fill(std::to_string(dt.hour)) + ":" + fill(std::to_string(dt.minute)) + ":" +
           fill(std::to_string(dt.second)) + "Z";
}

} // namespace

namespace xlnt {

workbook_serializer::workbook_serializer(workbook &wb) : workbook_(wb)
{
}

void workbook_serializer::read_properties_core(const xml_document &xml)
{
    auto &props = workbook_.get_properties();
    auto root_node = xml.get_child("cp:coreProperties");

    props.excel_base_date = calendar::windows_1900;

    if (root_node.has_child("dc:creator"))
    {
        props.creator = root_node.get_child("dc:creator").get_text();
    }
    
    if (root_node.has_child("cp:lastModifiedBy"))
    {
        props.last_modified_by = root_node.get_child("cp:lastModifiedBy").get_text();
    }
    
    if (root_node.has_child("dcterms:created"))
    {
        std::string created_string = root_node.get_child("dcterms:created").get_text();
        props.created = w3cdtf_to_datetime(created_string);
    }
    
    if (root_node.has_child("dcterms:modified"))
    {
        std::string modified_string = root_node.get_child("dcterms:modified").get_text();
        props.modified = w3cdtf_to_datetime(modified_string);
    }
}

void workbook_serializer::read_properties_app(const xml_document &xml)
{
    auto &props = workbook_.get_app_properties();
    auto root_node = xml.get_child("Properties");

    if(root_node.has_child("Application"))
    {
        props.application = root_node.get_child("Application").get_text();
    }

    if(root_node.has_child("DocSecurity"))
    {
        props.doc_security = std::stoi(root_node.get_child("DocSecurity").get_text());
    }

    if(root_node.has_child("ScaleCrop"))
    {
        props.scale_crop = root_node.get_child("ScaleCrop").get_text() == "true";
    }

    if(root_node.has_child("Company"))
    {
        props.company = root_node.get_child("Company").get_text();
    }

    if(root_node.has_child("ScaleCrop"))
    {
        props.links_up_to_date = root_node.get_child("ScaleCrop").get_text() == "true";
    }

    if(root_node.has_child("SharedDoc"))
    {
        props.shared_doc = root_node.get_child("SharedDoc").get_text() == "true";
    }

    if(root_node.has_child("HyperlinksChanged"))
    {
        props.hyperlinks_changed = root_node.get_child("HyperlinksChanged").get_text() == "true";
    }

    if(root_node.has_child("AppVersion"))
    {
        props.app_version = root_node.get_child("AppVersion").get_text();
    }
}

xml_document workbook_serializer::write_properties_core() const
{
    auto &props = workbook_.get_properties();

    xml_document xml;

    auto root_node = xml.add_child("cp:coreProperties");

    xml.add_namespace("cp", "http://schemas.openxmlformats.org/package/2006/metadata/core-properties");
    xml.add_namespace("dc", "http://purl.org/dc/elements/1.1/");
    xml.add_namespace("dcmitype", "http://purl.org/dc/dcmitype/");
    xml.add_namespace("dcterms", "http://purl.org/dc/terms/");
    xml.add_namespace("xsi", "http://www.w3.org/2001/XMLSchema-instance");

    root_node.add_child("dc:creator").set_text(props.creator);
    root_node.add_child("cp:lastModifiedBy").set_text(props.last_modified_by);
    root_node.add_child("dcterms:created").set_text(datetime_to_w3cdtf(props.created));
    root_node.get_child("dcterms:created").add_attribute("xsi:type", "dcterms:W3CDTF");
    root_node.add_child("dcterms:modified").set_text(datetime_to_w3cdtf(props.modified));
    root_node.get_child("dcterms:modified").add_attribute("xsi:type", "dcterms:W3CDTF");
    root_node.add_child("dc:title").set_text(props.title);
    root_node.add_child("dc:description");
    root_node.add_child("dc:subject");
    root_node.add_child("cp:keywords");
    root_node.add_child("cp:category");

    return xml;
}

xml_document workbook_serializer::write_properties_app() const
{
    xml_document xml;

    auto root_node = xml.add_child("Properties");

    xml.add_namespace("", "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties");
    xml.add_namespace("vt", "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes");
    
    auto &properties = workbook_.get_app_properties();

    root_node.add_child("Application").set_text(properties.application);
    root_node.add_child("DocSecurity").set_text(std::to_string(properties.doc_security));
    root_node.add_child("ScaleCrop").set_text(properties.scale_crop ? "true" : "false");
    
    auto company_node = root_node.add_child("Company");
    
    if (!properties.company.empty())
    {
        company_node.set_text(properties.company);
    }
    
    root_node.add_child("LinksUpToDate").set_text(properties.links_up_to_date ? "true" : "false");
    root_node.add_child("SharedDoc").set_text(properties.shared_doc ? "true" : "false");
    root_node.add_child("HyperlinksChanged").set_text(properties.hyperlinks_changed ? "true" : "false");
    root_node.add_child("AppVersion").set_text(properties.app_version);

    // TODO what is this stuff?
    
    auto heading_pairs_node = root_node.add_child("HeadingPairs");
    auto heading_pairs_vector_node = heading_pairs_node.add_child("vt:vector");
    heading_pairs_vector_node.add_attribute("size", "2");
    heading_pairs_vector_node.add_attribute("baseType", "variant");
    heading_pairs_vector_node.add_child("vt:variant").add_child("vt:lpstr").set_text("Worksheets");
    heading_pairs_vector_node.add_child("vt:variant")
        .add_child("vt:i4")
        .set_text(std::to_string(workbook_.get_sheet_names().size()));

    auto titles_of_parts_node = root_node.add_child("TitlesOfParts");
    auto titles_of_parts_vector_node = titles_of_parts_node.add_child("vt:vector");
    titles_of_parts_vector_node.add_attribute("size", std::to_string(workbook_.get_sheet_names().size()));
    titles_of_parts_vector_node.add_attribute("baseType", "lpstr");

    for (auto ws : workbook_)
    {
        titles_of_parts_vector_node.add_child("vt:lpstr").set_text(ws.get_title());
    }

    return xml;
}

xml_document workbook_serializer::write_workbook() const
{
    std::size_t num_visible = 0;

    for (auto ws : workbook_)
    {
        if (ws.get_page_setup().get_sheet_state() == sheet_state::visible)
        {
            num_visible++;
        }
    }

    if (num_visible == 0)
    {
        throw xlnt::value_error();
    }

    xml_document xml;

    auto root_node = xml.add_child("workbook");

    xml.add_namespace("", "http://schemas.openxmlformats.org/spreadsheetml/2006/main");
    xml.add_namespace("r", "http://schemas.openxmlformats.org/officeDocument/2006/relationships");

    auto file_version_node = root_node.add_child("fileVersion");
    file_version_node.add_attribute("appName", "xl");
    file_version_node.add_attribute("lastEdited", "4");
    file_version_node.add_attribute("lowestEdited", "4");
    file_version_node.add_attribute("rupBuild", "4505");

    auto workbook_pr_node = root_node.add_child("workbookPr");
    workbook_pr_node.add_attribute("codeName", "ThisWorkbook");
    workbook_pr_node.add_attribute("defaultThemeVersion", "124226");
    workbook_pr_node.add_attribute("date1904",
                                   workbook_.get_properties().excel_base_date == calendar::mac_1904 ? "1" : "0");

    auto book_views_node = root_node.add_child("bookViews");
    auto workbook_view_node = book_views_node.add_child("workbookView");
    workbook_view_node.add_attribute("activeTab", "0");
    workbook_view_node.add_attribute("autoFilterDateGrouping", "1");
    workbook_view_node.add_attribute("firstSheet", "0");
    workbook_view_node.add_attribute("minimized", "0");
    workbook_view_node.add_attribute("showHorizontalScroll", "1");
    workbook_view_node.add_attribute("showSheetTabs", "1");
    workbook_view_node.add_attribute("showVerticalScroll", "1");
    workbook_view_node.add_attribute("tabRatio", "600");
    workbook_view_node.add_attribute("visibility", "visible");

    auto sheets_node = root_node.add_child("sheets");
    auto defined_names_node = root_node.add_child("definedNames");

    for (const auto &relationship : workbook_.get_relationships())
    {
        if (relationship.get_type() == relationship::type::worksheet)
        {
            // TODO: this is ugly
            std::string sheet_index_string = relationship.get_target_uri();
            sheet_index_string = sheet_index_string.substr(0, sheet_index_string.find('.'));
            sheet_index_string = sheet_index_string.substr(sheet_index_string.find_last_of('/'));
            auto iter = sheet_index_string.end();
            iter--;
            while (isdigit(*iter))
                iter--;
            auto first_digit = iter - sheet_index_string.begin();
            sheet_index_string = sheet_index_string.substr(static_cast<std::string::size_type>(first_digit + 1));
            std::size_t sheet_index = static_cast<std::size_t>(std::stoll(sheet_index_string) - 1);

            auto ws = workbook_.get_sheet_by_index(sheet_index);

            auto sheet_node = sheets_node.add_child("sheet");
            sheet_node.add_attribute("name", ws.get_title());
            sheet_node.add_attribute("sheetId", std::to_string(sheet_index + 1));
            sheet_node.add_attribute("r:id", relationship.get_id());

            if (ws.has_auto_filter())
            {
                auto defined_name_node = defined_names_node.add_child("definedName");
                defined_name_node.add_attribute("name", "_xlnm._FilterDatabase");
                defined_name_node.add_attribute("hidden", "1");
                defined_name_node.add_attribute("localSheetId", "0");
                std::string name =
                    "'" + ws.get_title() + "'!" + range_reference::make_absolute(ws.get_auto_filter()).to_string();
                defined_name_node.set_text(name);
            }
        }
    }

    auto calc_pr_node = root_node.add_child("calcPr");
    calc_pr_node.add_attribute("calcId", "124519");
    calc_pr_node.add_attribute("calcMode", "auto");
    calc_pr_node.add_attribute("fullCalcOnLoad", "1");

    return xml;
}

xml_node workbook_serializer::write_named_ranges() const
{
    xlnt::xml_node named_ranges_node;

    for (auto &named_range : workbook_.get_named_ranges())
    {
        named_ranges_node.add_child(named_range.get_name());
    }

    return named_ranges_node;
}

} // namespace xlnt