fast_excel 0.5.0 → 0.6.1

data/libxlsxwriter/src/workbook.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.
  *
  */
 
@@ -12,6 +13,7 @@
 #include "xlsxwriter/utility.h"
 #include "xlsxwriter/packager.h"
 #include "xlsxwriter/hash_table.h"
+#include "xlsxwriter/hash_table.h"
 
 STATIC int _worksheet_name_cmp(lxw_worksheet_name *name1,
                                lxw_worksheet_name *name2);
@@ -230,12 +232,30 @@ lxw_workbook_free(lxw_workbook *workbook)
         free(workbook->image_md5s);
     }
 
+    if (workbook->embedded_image_md5s) {
+        for (image_md5 =
+             RB_MIN(lxw_image_md5s, workbook->embedded_image_md5s); image_md5;
+             image_md5 = next_image_md5) {
+
+            next_image_md5 =
+                RB_NEXT(lxw_image_md5s, workbook->embedded_image_md5s,
+                        image_md5);
+            RB_REMOVE(lxw_image_md5s, workbook->embedded_image_md5s,
+                      image_md5);
+            free(image_md5->md5);
+            free(image_md5);
+        }
+
+        free(workbook->embedded_image_md5s);
+    }
+
     if (workbook->header_image_md5s) {
         for (image_md5 = RB_MIN(lxw_image_md5s, workbook->header_image_md5s);
              image_md5; image_md5 = next_image_md5) {
 
             next_image_md5 =
-                RB_NEXT(lxw_image_md5s, workbook->image_md5, image_md5);
+                RB_NEXT(lxw_image_md5s, workbook->header_image_md5s,
+                        image_md5);
             RB_REMOVE(lxw_image_md5s, workbook->header_image_md5s, image_md5);
             free(image_md5->md5);
             free(image_md5);
@@ -249,7 +269,7 @@ lxw_workbook_free(lxw_workbook *workbook)
              image_md5; image_md5 = next_image_md5) {
 
             next_image_md5 =
-                RB_NEXT(lxw_image_md5s, workbook->image_md5, image_md5);
+                RB_NEXT(lxw_image_md5s, workbook->background_md5s, image_md5);
             RB_REMOVE(lxw_image_md5s, workbook->background_md5s, image_md5);
             free(image_md5->md5);
             free(image_md5);
@@ -677,6 +697,9 @@ _store_defined_name(lxw_workbook *self, const char *name,
     if (!name || !formula)
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
 
+    if (lxw_str_is_empty(name) || lxw_str_is_empty(formula))
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+
     if (lxw_utf8_strlen(name) > LXW_DEFINED_NAME_LENGTH ||
         lxw_utf8_strlen(formula) > LXW_DEFINED_NAME_LENGTH) {
         return LXW_ERROR_128_STRING_LENGTH_EXCEEDED;
@@ -709,11 +732,16 @@ _store_defined_name(lxw_workbook *self, const char *name,
         tmp_str++;
         worksheet_name = name_copy;
 
+        if (lxw_str_is_empty(tmp_str) || lxw_str_is_empty(worksheet_name))
+            goto mem_error;
+
         /* Remove any worksheet quoting. */
         if (worksheet_name[0] == '\'')
             worksheet_name++;
-        if (worksheet_name[strlen(worksheet_name) - 1] == '\'')
+        if (strlen(worksheet_name) > 0
+            && worksheet_name[strlen(worksheet_name) - 1] == '\'') {
             worksheet_name[strlen(worksheet_name) - 1] = '\0';
+        }
 
         /* Search for worksheet name to get the equivalent worksheet index. */
         STAILQ_FOREACH(sheet, self->sheets, list_pointers) {
@@ -932,16 +960,28 @@ _populate_range_dimensions(lxw_workbook *self, lxw_series_range *range)
         return;
     }
     else {
+        /* Check for empty string. */
+        if (lxw_str_is_empty(tmp_str)) {
+            range->ignore_cache = LXW_TRUE;
+            return;
+        }
+
         /* Split the formulas into sheetname and row-col data. */
         *tmp_str = '\0';
         tmp_str++;
         sheetname = formula;
 
+        if (lxw_str_is_empty(tmp_str) || lxw_str_is_empty(sheetname)) {
+            range->ignore_cache = LXW_TRUE;
+            return;
+        }
+
         /* Remove any worksheet quoting. */
         if (sheetname[0] == '\'')
             sheetname++;
-        if (sheetname[strlen(sheetname) - 1] == '\'')
+        if (strlen(sheetname) > 0 && sheetname[strlen(sheetname) - 1] == '\'') {
             sheetname[strlen(sheetname) - 1] = '\0';
+        }
 
         /* Check that the sheetname exists. */
         if (!workbook_get_worksheet_by_name(self, sheetname)) {
@@ -1064,6 +1104,7 @@ _prepare_drawings(lxw_workbook *self)
         }
 
         if (STAILQ_EMPTY(worksheet->image_props)
+            && STAILQ_EMPTY(worksheet->embedded_image_props)
             && STAILQ_EMPTY(worksheet->chart_data)
             && !worksheet->has_header_vml && !worksheet->has_background_image) {
             continue;
@@ -1071,6 +1112,48 @@ _prepare_drawings(lxw_workbook *self)
 
         drawing_id++;
 
+        /* Prepare embedded worksheet images. */
+        STAILQ_FOREACH(object_props, worksheet->embedded_image_props,
+                       list_pointers) {
+
+            _store_image_type(self, object_props->image_type);
+
+            /* Check for images with alt-text. */
+            if (object_props->description)
+                self->has_embedded_image_descriptions = LXW_TRUE;
+
+            /* Check for duplicate images and only store the first instance. */
+            if (object_props->md5) {
+                tmp_image_md5.md5 = object_props->md5;
+                found_duplicate_image = RB_FIND(lxw_image_md5s,
+                                                self->embedded_image_md5s,
+                                                &tmp_image_md5);
+            }
+
+            if (found_duplicate_image) {
+                ref_id = found_duplicate_image->id;
+                object_props->is_duplicate = LXW_TRUE;
+            }
+            else {
+                image_ref_id++;
+                ref_id = image_ref_id;
+                self->num_embedded_images++;
+
+#ifndef USE_NO_MD5
+                new_image_md5 = calloc(1, sizeof(lxw_image_md5));
+#endif
+                if (new_image_md5 && object_props->md5) {
+                    new_image_md5->id = ref_id;
+                    new_image_md5->md5 = lxw_strdup(object_props->md5);
+
+                    RB_INSERT(lxw_image_md5s, self->embedded_image_md5s,
+                              new_image_md5);
+                }
+            }
+
+            worksheet_set_error_cell(worksheet, object_props, ref_id);
+        }
+
         /* Prepare background images. */
         if (worksheet->has_background_image) {
 
@@ -1532,6 +1615,9 @@ _write_workbook_pr(lxw_workbook *self)
     if (self->vba_codename)
         LXW_PUSH_ATTRIBUTES_STR("codeName", self->vba_codename);
 
+    if (self->use_1904_epoch)
+        LXW_PUSH_ATTRIBUTES_STR("date1904", "1");
+
     LXW_PUSH_ATTRIBUTES_STR("defaultThemeVersion", "124226");
 
     lxw_xml_empty_tag(self->file, "workbookPr", &attributes);
@@ -1551,8 +1637,8 @@ _write_workbook_view(lxw_workbook *self)
     LXW_INIT_ATTRIBUTES();
     LXW_PUSH_ATTRIBUTES_STR("xWindow", "240");
     LXW_PUSH_ATTRIBUTES_STR("yWindow", "15");
-    LXW_PUSH_ATTRIBUTES_STR("windowWidth", "16095");
-    LXW_PUSH_ATTRIBUTES_STR("windowHeight", "9660");
+    LXW_PUSH_ATTRIBUTES_INT("windowWidth", self->window_width);
+    LXW_PUSH_ATTRIBUTES_INT("windowHeight", self->window_height);
 
     if (self->first_sheet)
         LXW_PUSH_ATTRIBUTES_INT("firstSheet", self->first_sheet);
@@ -1812,6 +1898,11 @@ workbook_new_opt(const char *filename, lxw_workbook_options *options)
     GOTO_LABEL_ON_MEM_ERROR(workbook->image_md5s, mem_error);
     RB_INIT(workbook->image_md5s);
 
+    /* Add the embedded image MD5 tree. */
+    workbook->embedded_image_md5s = calloc(1, sizeof(struct lxw_image_md5s));
+    GOTO_LABEL_ON_MEM_ERROR(workbook->embedded_image_md5s, mem_error);
+    RB_INIT(workbook->embedded_image_md5s);
+
     /* Add the header image MD5 tree. */
     workbook->header_image_md5s = calloc(1, sizeof(struct lxw_image_md5s));
     GOTO_LABEL_ON_MEM_ERROR(workbook->header_image_md5s, mem_error);
@@ -1886,6 +1977,8 @@ workbook_new_opt(const char *filename, lxw_workbook_options *options)
     }
 
     workbook->max_url_length = 2079;
+    workbook->window_width = 16095;
+    workbook->window_height = 9660;
 
     return workbook;
 
@@ -1905,7 +1998,8 @@ workbook_add_worksheet(lxw_workbook *self, const char *sheetname)
     lxw_worksheet *worksheet = NULL;
     lxw_worksheet_name *worksheet_name = NULL;
     lxw_error error;
-    lxw_worksheet_init_data init_data = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
+    lxw_worksheet_init_data init_data =
+        { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
     char *new_name = NULL;
 
     if (sheetname) {
@@ -1946,6 +2040,7 @@ workbook_add_worksheet(lxw_workbook *self, const char *sheetname)
     init_data.tmpdir = self->options.tmpdir;
     init_data.default_url_format = self->default_url_format;
     init_data.max_url_length = self->max_url_length;
+    init_data.use_1904_epoch = self->use_1904_epoch;
 
     /* Create a new worksheet object. */
     worksheet = lxw_worksheet_new(&init_data);
@@ -1989,7 +2084,8 @@ workbook_add_chartsheet(lxw_workbook *self, const char *sheetname)
     lxw_chartsheet *chartsheet = NULL;
     lxw_chartsheet_name *chartsheet_name = NULL;
     lxw_error error;
-    lxw_worksheet_init_data init_data = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
+    lxw_worksheet_init_data init_data =
+        { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
     char *new_name = NULL;
 
     if (sheetname) {
@@ -2071,6 +2167,12 @@ workbook_add_chart(lxw_workbook *self, uint8_t type)
 {
     lxw_chart *chart;
 
+    if (type == LXW_CHART_NONE || type > LXW_CHART_RADAR_FILLED) {
+        LXW_WARN_FORMAT1("workbook_add_chart(): invalid chart type: %d",
+                         type);
+        return NULL;
+    }
+
     /* Create a new chart object. */
     chart = lxw_chart_new(type);
 
@@ -2154,8 +2256,16 @@ workbook_close(lxw_workbook *self)
         if (worksheet->index == self->active_sheet)
             worksheet->active = LXW_TRUE;
 
-        if (worksheet->has_dynamic_arrays)
+        if (worksheet->has_dynamic_functions) {
+            self->has_metadata = LXW_TRUE;
+            self->has_dynamic_functions = LXW_TRUE;
+
+        }
+
+        if (!STAILQ_EMPTY(worksheet->embedded_image_props)) {
             self->has_metadata = LXW_TRUE;
+            self->has_embedded_images = LXW_TRUE;
+        }
     }
 
     /* Set workbook and worksheet VBA codenames if a macro has been added. */
@@ -2375,6 +2485,12 @@ workbook_set_custom_property_string(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_custom_property_string(): "
+                        "parameter 'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     if (!value) {
         LXW_WARN_FORMAT("workbook_set_custom_property_string(): "
                         "parameter 'value' cannot be NULL.");
@@ -2422,6 +2538,12 @@ workbook_set_custom_property_number(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_custom_property_number(): parameter "
+                        "'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     if (lxw_utf8_strlen(name) > 255) {
         LXW_WARN_FORMAT("workbook_set_custom_property_number(): parameter "
                         "'name' exceeds Excel length limit of 255.");
@@ -2457,6 +2579,12 @@ workbook_set_custom_property_integer(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_custom_property_integer(): parameter "
+                        "'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     if (strlen(name) > 255) {
         LXW_WARN_FORMAT("workbook_set_custom_property_integer(): parameter "
                         "'name' exceeds Excel length limit of 255.");
@@ -2492,6 +2620,12 @@ workbook_set_custom_property_boolean(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_custom_property_boolean(): parameter "
+                        "'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     if (lxw_utf8_strlen(name) > 255) {
         LXW_WARN_FORMAT("workbook_set_custom_property_boolean(): parameter "
                         "'name' exceeds Excel length limit of 255.");
@@ -2527,6 +2661,12 @@ workbook_set_custom_property_datetime(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_custom_property_datetime(): parameter "
+                        "'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     if (lxw_utf8_strlen(name) > 255) {
         LXW_WARN_FORMAT("workbook_set_custom_property_datetime(): parameter "
                         "'name' exceeds Excel length limit of 255.");
@@ -2539,6 +2679,10 @@ workbook_set_custom_property_datetime(lxw_workbook *self, const char *name,
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_datetime_validate(datetime) != LXW_NO_ERROR) {
+        return LXW_ERROR_DATETIME_VALIDATION;
+    }
+
     /* Create a struct to hold the custom property. */
     custom_property = calloc(1, sizeof(struct lxw_custom_property));
     RETURN_ON_MEM_ERROR(custom_property, LXW_ERROR_MEMORY_MALLOC_FAILED);
@@ -2625,6 +2769,13 @@ workbook_unset_default_url_format(lxw_workbook *self)
 lxw_error
 workbook_validate_sheet_name(lxw_workbook *self, const char *sheetname)
 {
+    if (sheetname == NULL)
+        return LXW_ERROR_NULL_PARAMETER_IGNORED;
+
+    /* Check for empty worksheet name. */
+    if (lxw_str_is_empty(sheetname))
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+
     /* Check the UTF-8 length of the worksheet name. */
     if (lxw_utf8_strlen(sheetname) > LXW_SHEETNAME_MAX)
         return LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED;
@@ -2723,6 +2874,12 @@ workbook_set_vba_name(lxw_workbook *self, const char *name)
         return LXW_ERROR_NULL_PARAMETER_IGNORED;
     }
 
+    if (lxw_str_is_empty(name)) {
+        LXW_WARN_FORMAT("workbook_set_vba_name(): parameter "
+                        "'name' cannot be an empty string.");
+        return LXW_ERROR_PARAMETER_IS_EMPTY;
+    }
+
     self->vba_codename = lxw_strdup(name);
 
     return LXW_NO_ERROR;
@@ -2736,3 +2893,27 @@ workbook_read_only_recommended(lxw_workbook *self)
 {
     self->read_only = 2;
 }
+
+/*
+ * Use the 1904 epoch for dates in the workbook.
+ */
+void
+workbook_use_1904_epoch(lxw_workbook *self)
+{
+    self->use_1904_epoch = LXW_TRUE;
+}
+
+/*
+ * Set the size of a workbook window.
+ */
+void
+workbook_set_size(lxw_workbook *workbook, uint16_t width, uint16_t height)
+{
+    /* Convert the width/height to twips at 96 dpi. */
+    if (width)
+        workbook->window_width = width * 1440 / 96;
+
+    if (height)
+        workbook->window_height = height * 1440 / 96;
+
+}