fast_excel 0.6.0 → 0.6.1

data/libxlsxwriter/src/packager.c

@@ -39,7 +39,8 @@
  * The Packager class coordinates the classes that represent the
  * elements of the package and writes them into the XLSX file.
  *
- * Copyright 2014-2022, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * SPDX-License-Identifier: BSD-2-Clause
+ * Copyright 2014-2026, John McNamara, jmcnamara@cpan.org.
  *
  */
 
@@ -49,13 +50,13 @@
 #include "xlsxwriter/hash_table.h"
 #include "xlsxwriter/utility.h"
 
-STATIC lxw_error _add_file_to_zip(lxw_packager *self, FILE * file,
+STATIC lxw_error _add_file_to_zip(lxw_packager *self, FILE *file,
                                   const char *filename);
 
 STATIC lxw_error _add_buffer_to_zip(lxw_packager *self, const char *buffer,
                                     size_t buffer_size, const char *filename);
 
-STATIC lxw_error _add_to_zip(lxw_packager *self, FILE * file,
+STATIC lxw_error _add_to_zip(lxw_packager *self, FILE *file,
                              char **buffer, size_t *buffer_size,
                              const char *filename);
 
@@ -382,9 +383,43 @@ _write_image_files(lxw_packager *self)
         else
             worksheet = sheet->u.worksheet;
 
-        if (STAILQ_EMPTY(worksheet->image_props))
+        if (STAILQ_EMPTY(worksheet->image_props)
+            && STAILQ_EMPTY(worksheet->embedded_image_props))
             continue;
 
+        STAILQ_FOREACH(object_props, worksheet->embedded_image_props,
+                       list_pointers) {
+
+            if (object_props->is_duplicate)
+                continue;
+
+            lxw_snprintf(filename, LXW_FILENAME_LENGTH,
+                         "xl/media/image%d.%s", index++,
+                         object_props->extension);
+
+            if (!object_props->is_image_buffer) {
+                /* Check that the image file exists and can be opened. */
+                image_stream = lxw_fopen(object_props->filename, "rb");
+                if (!image_stream) {
+                    LXW_WARN_FORMAT1("Error adding image to xlsx file: file "
+                                     "doesn't exist or can't be opened: %s.",
+                                     object_props->filename);
+                    return LXW_ERROR_CREATING_TMPFILE;
+                }
+
+                err = _add_file_to_zip(self, image_stream, filename);
+                fclose(image_stream);
+            }
+            else {
+                err = _add_buffer_to_zip(self,
+                                         object_props->image_buffer,
+                                         object_props->image_buffer_size,
+                                         filename);
+            }
+
+            RETURN_ON_ERROR(err);
+        }
+
         STAILQ_FOREACH(object_props, worksheet->image_props, list_pointers) {
 
             if (object_props->is_duplicate)
@@ -1052,6 +1087,10 @@ _write_metadata_file(lxw_packager *self)
         goto mem_error;
     }
 
+    metadata->has_embedded_images = self->workbook->has_embedded_images;
+    metadata->num_embedded_images = self->workbook->num_embedded_images;
+    metadata->has_dynamic_functions = self->workbook->has_dynamic_functions;
+
     lxw_metadata_assemble_xml_file(metadata);
 
     err = _add_to_zip(self, metadata->file, &buffer, &buffer_size,
@@ -1066,6 +1105,177 @@ mem_error:
     return err;
 }
 
+/*
+ * Write the rdrichvalue.xml file.
+ */
+STATIC lxw_error
+_write_rich_value_file(lxw_packager *self)
+{
+    lxw_error err = LXW_NO_ERROR;
+    lxw_rich_value *rich_value;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+
+    if (!self->workbook->has_embedded_images)
+        return LXW_NO_ERROR;
+
+    rich_value = lxw_rich_value_new();
+    if (!rich_value) {
+        err = LXW_ERROR_MEMORY_MALLOC_FAILED;
+        goto mem_error;
+    }
+
+    rich_value->workbook = self->workbook;
+
+    rich_value->file =
+        lxw_get_filehandle(&buffer, &buffer_size, self->tmpdir);
+    if (!rich_value->file) {
+        err = LXW_ERROR_CREATING_TMPFILE;
+        goto mem_error;
+    }
+
+    lxw_rich_value_assemble_xml_file(rich_value);
+
+    err = _add_to_zip(self, rich_value->file, &buffer, &buffer_size,
+                      "xl/richData/rdrichvalue.xml");
+
+    fclose(rich_value->file);
+    free(buffer);
+
+mem_error:
+    lxw_rich_value_free(rich_value);
+
+    return err;
+}
+
+/*
+ * Write the richValueRel.xml file.
+ */
+STATIC lxw_error
+_write_rich_value_rel_file(lxw_packager *self)
+{
+    lxw_error err = LXW_NO_ERROR;
+    lxw_rich_value_rel *rich_value_rel;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+
+    if (!self->workbook->has_embedded_images)
+        return LXW_NO_ERROR;
+
+    rich_value_rel = lxw_rich_value_rel_new();
+    if (!rich_value_rel) {
+        err = LXW_ERROR_MEMORY_MALLOC_FAILED;
+        goto mem_error;
+    }
+
+    rich_value_rel->num_embedded_images = self->workbook->num_embedded_images;
+
+    rich_value_rel->file =
+        lxw_get_filehandle(&buffer, &buffer_size, self->tmpdir);
+    if (!rich_value_rel->file) {
+        err = LXW_ERROR_CREATING_TMPFILE;
+        goto mem_error;
+    }
+
+    lxw_rich_value_rel_assemble_xml_file(rich_value_rel);
+
+    err = _add_to_zip(self, rich_value_rel->file, &buffer, &buffer_size,
+                      "xl/richData/richValueRel.xml");
+
+    fclose(rich_value_rel->file);
+    free(buffer);
+
+mem_error:
+    lxw_rich_value_rel_free(rich_value_rel);
+
+    return err;
+}
+
+/*
+ * Write the rdRichValueTypes.xml file.
+ */
+STATIC lxw_error
+_write_rich_value_types_file(lxw_packager *self)
+{
+    lxw_error err = LXW_NO_ERROR;
+    lxw_rich_value_types *rich_value_types;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+
+    if (!self->workbook->has_embedded_images)
+        return LXW_NO_ERROR;
+
+    rich_value_types = lxw_rich_value_types_new();
+    if (!rich_value_types) {
+        err = LXW_ERROR_MEMORY_MALLOC_FAILED;
+        goto mem_error;
+    }
+
+    rich_value_types->file =
+        lxw_get_filehandle(&buffer, &buffer_size, self->tmpdir);
+    if (!rich_value_types->file) {
+        err = LXW_ERROR_CREATING_TMPFILE;
+        goto mem_error;
+    }
+
+    lxw_rich_value_types_assemble_xml_file(rich_value_types);
+
+    err = _add_to_zip(self, rich_value_types->file, &buffer, &buffer_size,
+                      "xl/richData/rdRichValueTypes.xml");
+
+    fclose(rich_value_types->file);
+    free(buffer);
+
+mem_error:
+    lxw_rich_value_types_free(rich_value_types);
+
+    return err;
+}
+
+/*
+ * Write the rdrichvaluestructure.xml file.
+ */
+STATIC lxw_error
+_write_rich_value_structure_file(lxw_packager *self)
+{
+    lxw_error err = LXW_NO_ERROR;
+    lxw_rich_value_structure *rich_value_structure;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+
+    if (!self->workbook->has_embedded_images)
+        return LXW_NO_ERROR;
+
+    rich_value_structure = lxw_rich_value_structure_new();
+    if (!rich_value_structure) {
+        err = LXW_ERROR_MEMORY_MALLOC_FAILED;
+        goto mem_error;
+    }
+
+    rich_value_structure->has_embedded_image_descriptions =
+        self->workbook->has_embedded_image_descriptions;
+
+    rich_value_structure->file =
+        lxw_get_filehandle(&buffer, &buffer_size, self->tmpdir);
+    if (!rich_value_structure->file) {
+        err = LXW_ERROR_CREATING_TMPFILE;
+        goto mem_error;
+    }
+
+    lxw_rich_value_structure_assemble_xml_file(rich_value_structure);
+
+    err = _add_to_zip(self, rich_value_structure->file, &buffer, &buffer_size,
+                      "xl/richData/rdrichvaluestructure.xml");
+
+    fclose(rich_value_structure->file);
+    free(buffer);
+
+mem_error:
+    lxw_rich_value_structure_free(rich_value_structure);
+
+    return err;
+}
+
 /*
  * Write the custom.xml file.
  */
@@ -1326,6 +1536,9 @@ _write_content_types_file(lxw_packager *self)
     if (workbook->has_metadata)
         lxw_ct_add_metadata(content_types);
 
+    if (workbook->has_embedded_images)
+        lxw_ct_add_rich_value(content_types);
+
     lxw_content_types_assemble_xml_file(content_types);
 
     err = _add_to_zip(self, content_types->file, &buffer, &buffer_size,
@@ -1396,6 +1609,9 @@ _write_workbook_rels_file(lxw_packager *self)
     if (workbook->has_metadata)
         lxw_add_document_relationship(rels, "/sheetMetadata", "metadata.xml");
 
+    if (workbook->has_embedded_images)
+        lxw_add_rich_value_relationship(rels);
+
     lxw_relationships_assemble_xml_file(rels);
 
     err = _add_to_zip(self, rels->file, &buffer, &buffer_size,
@@ -1714,6 +1930,75 @@ mem_error:
     return err;
 }
 
+/*
+ * Write the richValueRel.xml.rels files for embedded images.
+ */
+STATIC lxw_error
+_write_rich_value_rels_file(lxw_packager *self)
+{
+    lxw_workbook *workbook = self->workbook;
+    lxw_sheet *sheet;
+    lxw_worksheet *worksheet;
+    lxw_object_properties *object_props;
+
+    lxw_relationships *rels;
+    char *buffer = NULL;
+    size_t buffer_size = 0;
+    char sheetname[LXW_FILENAME_LENGTH] = { 0 };
+    char target[LXW_FILENAME_LENGTH] = { 0 };
+    lxw_error err = LXW_NO_ERROR;
+    uint32_t index = 1;
+
+    if (!workbook->has_embedded_images)
+        return LXW_NO_ERROR;
+
+    rels = lxw_relationships_new();
+
+    rels->file = lxw_get_filehandle(&buffer, &buffer_size, self->tmpdir);
+    if (!rels->file) {
+        lxw_free_relationships(rels);
+        return LXW_ERROR_CREATING_TMPFILE;
+    }
+
+    STAILQ_FOREACH(sheet, workbook->sheets, list_pointers) {
+        if (sheet->is_chartsheet)
+            continue;
+        else
+            worksheet = sheet->u.worksheet;
+
+        if (STAILQ_EMPTY(worksheet->embedded_image_props))
+            continue;
+
+        STAILQ_FOREACH(object_props, worksheet->embedded_image_props,
+                       list_pointers) {
+
+            if (object_props->is_duplicate)
+                continue;
+
+            lxw_snprintf(target, LXW_FILENAME_LENGTH,
+                         "../media/image%d.%s", index++,
+                         object_props->extension);
+
+            lxw_add_document_relationship(rels, "/image", target);
+
+        }
+
+    }
+
+    lxw_snprintf(sheetname, LXW_FILENAME_LENGTH,
+                 "xl/richData/_rels/richValueRel.xml.rels");
+
+    lxw_relationships_assemble_xml_file(rels);
+
+    err = _add_to_zip(self, rels->file, &buffer, &buffer_size, sheetname);
+
+    fclose(rels->file);
+    free(buffer);
+    lxw_free_relationships(rels);
+
+    return err;
+}
+
 /*
  * Write the _rels/.rels xml file.
  */
@@ -1770,7 +2055,7 @@ mem_error:
  ****************************************************************************/
 
 STATIC lxw_error
-_add_file_to_zip(lxw_packager *self, FILE * file, const char *filename)
+_add_file_to_zip(lxw_packager *self, FILE *file, const char *filename)
 {
     int16_t error = ZIP_OK;
     size_t size_read;
@@ -1862,7 +2147,7 @@ _add_buffer_to_zip(lxw_packager *self, const char *buffer, size_t buffer_size,
 }
 
 STATIC lxw_error
-_add_to_zip(lxw_packager *self, FILE * file, char **buffer,
+_add_to_zip(lxw_packager *self, FILE *file, char **buffer,
             size_t *buffer_size, const char *filename)
 {
     /* Flush to ensure buffer is updated when using a memory-backed file. */
@@ -1953,6 +2238,21 @@ lxw_create_package(lxw_packager *self)
     error = _write_metadata_file(self);
     RETURN_AND_ZIPCLOSE_ON_ERROR(error);
 
+    error = _write_rich_value_file(self);
+    RETURN_AND_ZIPCLOSE_ON_ERROR(error);
+
+    error = _write_rich_value_rel_file(self);
+    RETURN_AND_ZIPCLOSE_ON_ERROR(error);
+
+    error = _write_rich_value_types_file(self);
+    RETURN_AND_ZIPCLOSE_ON_ERROR(error);
+
+    error = _write_rich_value_structure_file(self);
+    RETURN_AND_ZIPCLOSE_ON_ERROR(error);
+
+    error = _write_rich_value_rels_file(self);
+    RETURN_AND_ZIPCLOSE_ON_ERROR(error);
+
     error = _write_app_file(self);
     RETURN_AND_ZIPCLOSE_ON_ERROR(error);
 

data/libxlsxwriter/src/relationships.c

@@ -3,7 +3,8 @@
  *
  * Used in conjunction with the libxlsxwriter library.
  *
- * Copyright 2014-2022, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * SPDX-License-Identifier: BSD-2-Clause
+ * Copyright 2014-2026, John McNamara, jmcnamara@cpan.org.
  *
  */
 
@@ -243,3 +244,26 @@ lxw_add_worksheet_relationship(lxw_relationships *self, const char *type,
 {
     _add_relationship(self, LXW_SCHEMA_DOCUMENT, type, target, target_mode);
 }
+
+/*
+ * Add a richValue relationship to sheet .rels xml files.
+ */
+void
+lxw_add_rich_value_relationship(lxw_relationships *self)
+{
+    _add_relationship(self,
+                      "http://schemas.microsoft.com/office/2022/10/relationships/",
+                      "richValueRel", "richData/richValueRel.xml", NULL);
+    _add_relationship(self,
+                      "http://schemas.microsoft.com/office/2017/06/relationships/",
+                      "rdRichValue", "richData/rdrichvalue.xml", NULL);
+    _add_relationship(self,
+                      "http://schemas.microsoft.com/office/2017/06/relationships/",
+                      "rdRichValueStructure",
+                      "richData/rdrichvaluestructure.xml", NULL);
+    _add_relationship(self,
+                      "http://schemas.microsoft.com/office/2017/06/relationships/",
+                      "rdRichValueTypes", "richData/rdRichValueTypes.xml",
+                      NULL);
+
+}

data/libxlsxwriter/src/rich_value.c

@@ -0,0 +1,191 @@
+/*****************************************************************************
+ * rich_value - A library for creating Excel XLSX rich_value files.
+ *
+ * Used in conjunction with the libxlsxwriter library.
+ *
+ * Copyright 2014-2026, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ */
+
+#include "xlsxwriter/xmlwriter.h"
+#include "xlsxwriter/rich_value.h"
+#include "xlsxwriter/utility.h"
+
+/*
+ * Forward declarations.
+ */
+
+/*****************************************************************************
+ *
+ * Private functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Create a new rich_value object.
+ */
+lxw_rich_value *
+lxw_rich_value_new(void)
+{
+    lxw_rich_value *rich_value = calloc(1, sizeof(lxw_rich_value));
+    GOTO_LABEL_ON_MEM_ERROR(rich_value, mem_error);
+
+    return rich_value;
+
+mem_error:
+    lxw_rich_value_free(rich_value);
+    return NULL;
+}
+
+/*
+ * Free a rich_value object.
+ */
+void
+lxw_rich_value_free(lxw_rich_value *rich_value)
+{
+    if (!rich_value)
+        return;
+
+    free(rich_value);
+}
+
+/*****************************************************************************
+ *
+ * XML functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Write the XML declaration.
+ */
+STATIC void
+_rich_value_xml_declaration(lxw_rich_value *self)
+{
+    lxw_xml_declaration(self->file);
+}
+
+/*****************************************************************************
+ *
+ * XML file assembly functions.
+ *
+ ****************************************************************************/
+
+/*
+ * Write the <v> element.
+ */
+STATIC void
+_rich_value_write_v(lxw_rich_value *self, char *value)
+{
+    lxw_xml_data_element(self->file, "v", value, NULL);
+
+}
+
+/*
+ * Write the <rv> element.
+ */
+STATIC void
+_rich_value_write_rv(lxw_rich_value *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("s", "0");
+
+    lxw_xml_start_tag(self->file, "rv", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the metadata for each embedded image.
+ */
+void
+lxw_rich_value_write_images(lxw_rich_value *self)
+{
+
+    lxw_workbook *workbook = self->workbook;
+    lxw_sheet *sheet;
+    lxw_worksheet *worksheet;
+    lxw_object_properties *object_props;
+    char value[LXW_UINT32_T_LENGTH];
+    uint32_t index = 0;
+    uint8_t type = 5;
+
+    STAILQ_FOREACH(sheet, workbook->sheets, list_pointers) {
+        if (sheet->is_chartsheet)
+            continue;
+        else
+            worksheet = sheet->u.worksheet;
+
+        STAILQ_FOREACH(object_props, worksheet->embedded_image_props,
+                       list_pointers) {
+
+            if (object_props->is_duplicate)
+                continue;
+
+            if (object_props->decorative)
+                type = 6;
+
+            /* Write the rv element. */
+            _rich_value_write_rv(self);
+
+            /* Write the v element. */
+            lxw_snprintf(value, LXW_UINT32_T_LENGTH, "%u", index);
+            _rich_value_write_v(self, value);
+
+            lxw_snprintf(value, LXW_UINT32_T_LENGTH, "%u", type);
+            _rich_value_write_v(self, value);
+
+            if (object_props->description && *object_props->description)
+                _rich_value_write_v(self, object_props->description);
+
+            lxw_xml_end_tag(self->file, "rv");
+
+            index++;
+        }
+    }
+}
+
+/*
+ * Write the <rvData> element.
+ */
+STATIC void
+_rich_value_write_rv_data(lxw_rich_value *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char xmlns[] =
+        "http://schemas.microsoft.com/office/spreadsheetml/2017/richdata";
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("xmlns", xmlns);
+    LXW_PUSH_ATTRIBUTES_INT("count", self->workbook->num_embedded_images);
+
+    lxw_xml_start_tag(self->file, "rvData", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Assemble and write the XML file.
+ */
+void
+lxw_rich_value_assemble_xml_file(lxw_rich_value *self)
+{
+    /* Write the XML declaration. */
+    _rich_value_xml_declaration(self);
+
+    /* Write the rvData element. */
+    _rich_value_write_rv_data(self);
+
+    lxw_rich_value_write_images(self);
+
+    lxw_xml_end_tag(self->file, "rvData");
+}
+
+/*****************************************************************************
+ *
+ * Public functions.
+ *
+ ****************************************************************************/