write.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  1. /*
  2. +----------------------------------------------------------------------+
  3. | XlsWriter Extension |
  4. +----------------------------------------------------------------------+
  5. | Copyright (c) 2017-2018 The Viest |
  6. +----------------------------------------------------------------------+
  7. | http://www.viest.me |
  8. +----------------------------------------------------------------------+
  9. | Author: viest <[email protected]> |
  10. +----------------------------------------------------------------------+
  11. */
  12. #include "include.h"
  13. /*
  14. * According to the zval type written to the file
  15. */
  16. void type_writer(zval *value, zend_long row, zend_long columns, xls_resource_t *res, zend_string *format)
  17. {
  18. lxw_format *value_format = NULL;
  19. switch (Z_TYPE_P(value)) {
  20. case IS_STRING:
  21. worksheet_write_string(res->worksheet, row, columns, ZSTR_VAL(zval_get_string(value)), NULL);
  22. break;
  23. case IS_LONG:
  24. if(format) {
  25. value_format = workbook_add_format(res->workbook);
  26. format_set_num_format(value_format, ZSTR_VAL(format));
  27. worksheet_write_number(res->worksheet, row, columns, zval_get_long(value), value_format);
  28. } else {
  29. worksheet_write_number(res->worksheet, row, columns, zval_get_long(value), NULL);
  30. }
  31. break;
  32. case IS_DOUBLE:
  33. if(format) {
  34. value_format = workbook_add_format(res->workbook);
  35. format_set_num_format(value_format, ZSTR_VAL(format));
  36. worksheet_write_number(res->worksheet, row, columns, zval_get_double(value), value_format);
  37. } else {
  38. worksheet_write_number(res->worksheet, row, columns, zval_get_double(value), NULL);
  39. }
  40. break;
  41. }
  42. }
  43. /*
  44. * Write the image to the file
  45. */
  46. void image_writer(zval *value, zend_long row, zend_long columns, double width, double height, xls_resource_t *res)
  47. {
  48. lxw_image_options options = {.x_scale = width, .y_scale = height};
  49. worksheet_insert_image_opt(res->worksheet, row, columns, ZSTR_VAL(zval_get_string(value)), &options);
  50. }
  51. /*
  52. * Write the image to the file
  53. */
  54. void formula_writer(zval *value, zend_long row, zend_long columns, xls_resource_t *res)
  55. {
  56. worksheet_write_formula(res->worksheet, row, columns, ZSTR_VAL(zval_get_string(value)), NULL);
  57. }
  58. void chart_writer(zend_long row, zend_long columns, xls_resource_chart_t *chart_resource, xls_resource_t *res)
  59. {
  60. worksheet_insert_chart(res->worksheet, row, columns, chart_resource->chart);
  61. }
  62. /*
  63. * Add the autofilter.
  64. */
  65. void auto_filter(zend_string *range, xls_resource_t *res)
  66. {
  67. worksheet_autofilter(res->worksheet, RANGE(ZSTR_VAL(range)));
  68. }
  69. /*
  70. * Merge cells.
  71. */
  72. void merge_cells(zend_string *range, zend_string *value, xls_resource_t *res)
  73. {
  74. worksheet_merge_range(res->worksheet, RANGE(ZSTR_VAL(range)), ZSTR_VAL(value), NULL);
  75. }
  76. /*
  77. * Set column format
  78. */
  79. void set_column(zend_string *range, double width, xls_resource_t *res, lxw_format *format)
  80. {
  81. worksheet_set_column(res->worksheet, COLS(ZSTR_VAL(range)), width, format);
  82. }
  83. /*
  84. * Set row format
  85. */
  86. void set_row(zend_string *range, double height, xls_resource_t *res, lxw_format *format)
  87. {
  88. char *rows = ZSTR_VAL(range);
  89. if (strchr(rows, ':')) {
  90. worksheet_set_rows(ROWS(rows), height, res, format);
  91. } else {
  92. worksheet_set_row(res->worksheet, ROW(rows), height, format);
  93. }
  94. }
  95. /*
  96. * Set rows format
  97. */
  98. void worksheet_set_rows(lxw_row_t start, lxw_row_t end, double height, xls_resource_t *res, lxw_format *format)
  99. {
  100. while (1) {
  101. worksheet_set_row(res->worksheet, end, height, format);
  102. if (end == start)
  103. break;
  104. end--;
  105. }
  106. }
  107. /*
  108. * Call finalization code and close file.
  109. */
  110. lxw_error
  111. workbook_file(xls_resource_t *self)
  112. {
  113. lxw_worksheet *worksheet = NULL;
  114. lxw_packager *packager = NULL;
  115. lxw_error error = LXW_NO_ERROR;
  116. /* Add a default worksheet if non have been added. */
  117. if (!self->workbook->num_sheets)
  118. workbook_add_worksheet(self->workbook, NULL);
  119. /* Ensure that at least one worksheet has been selected. */
  120. if (self->workbook->active_sheet == 0) {
  121. worksheet = STAILQ_FIRST(self->workbook->worksheets);
  122. worksheet->selected = 1;
  123. worksheet->hidden = 0;
  124. }
  125. /* Set the active sheet. */
  126. STAILQ_FOREACH(worksheet, self->workbook->worksheets, list_pointers) {
  127. if (worksheet->index == self->workbook->active_sheet)
  128. worksheet->active = 1;
  129. }
  130. /* Set the defined names for the worksheets such as Print Titles. */
  131. _prepare_defined_names(self->workbook);
  132. /* Prepare the drawings, charts and images. */
  133. _prepare_drawings(self->workbook);
  134. /* Add cached data to charts. */
  135. _add_chart_cache_data(self->workbook);
  136. /* Create a packager object to assemble sub-elements into a zip file. */
  137. packager = lxw_packager_new(self->workbook->filename, self->workbook->options.tmpdir);
  138. /* If the packager fails it is generally due to a zip permission error. */
  139. if (packager == NULL) {
  140. fprintf(stderr, "[ERROR] workbook_close(): "
  141. "Error creating '%s'. "
  142. "Error = %s\n", self->workbook->filename, strerror(errno));
  143. error = LXW_ERROR_CREATING_XLSX_FILE;
  144. goto mem_error;
  145. }
  146. /* Set the workbook object in the packager. */
  147. packager->workbook = self->workbook;
  148. /* Assemble all the sub-files in the xlsx package. */
  149. error = lxw_create_package(packager);
  150. /* Error and non-error conditions fall through to the cleanup code. */
  151. if (error == LXW_ERROR_CREATING_TMPFILE) {
  152. fprintf(stderr, "[ERROR] workbook_close(): "
  153. "Error creating tmpfile(s) to assemble '%s'. "
  154. "Error = %s\n", self->workbook->filename, strerror(errno));
  155. }
  156. /* If LXW_ERROR_ZIP_FILE_OPERATION then errno is set by zlib. */
  157. if (error == LXW_ERROR_ZIP_FILE_OPERATION) {
  158. fprintf(stderr, "[ERROR] workbook_close(): "
  159. "Zlib error while creating xlsx file '%s'. "
  160. "Error = %s\n", self->workbook->filename, strerror(errno));
  161. }
  162. /* The next 2 error conditions don't set errno. */
  163. if (error == LXW_ERROR_ZIP_FILE_ADD) {
  164. fprintf(stderr, "[ERROR] workbook_close(): "
  165. "Zlib error adding file to xlsx file '%s'.\n",
  166. self->workbook->filename);
  167. }
  168. if (error == LXW_ERROR_ZIP_CLOSE) {
  169. fprintf(stderr, "[ERROR] workbook_close(): "
  170. "Zlib error closing xlsx file '%s'.\n", self->workbook->filename);
  171. }
  172. mem_error:
  173. lxw_packager_free(packager);
  174. return error;
  175. }
  176. void _php_vtiful_xls_close(zend_resource *rsrc TSRMLS_DC)
  177. {
  178. }
  179. /*
  180. * Iterate through the worksheets and store any defined names used for print
  181. * ranges or repeat rows/columns.
  182. */
  183. STATIC void
  184. _prepare_defined_names(lxw_workbook *self)
  185. {
  186. lxw_worksheet *worksheet;
  187. char app_name[LXW_DEFINED_NAME_LENGTH];
  188. char range[LXW_DEFINED_NAME_LENGTH];
  189. char area[LXW_MAX_CELL_RANGE_LENGTH];
  190. char first_col[8];
  191. char last_col[8];
  192. STAILQ_FOREACH(worksheet, self->worksheets, list_pointers) {
  193. /*
  194. * Check for autofilter settings and store them.
  195. */
  196. if (worksheet->autofilter.in_use) {
  197. lxw_snprintf(app_name, LXW_DEFINED_NAME_LENGTH,
  198. "%s!_FilterDatabase", worksheet->quoted_name);
  199. lxw_rowcol_to_range_abs(area,
  200. worksheet->autofilter.first_row,
  201. worksheet->autofilter.first_col,
  202. worksheet->autofilter.last_row,
  203. worksheet->autofilter.last_col);
  204. lxw_snprintf(range, LXW_DEFINED_NAME_LENGTH, "%s!%s",
  205. worksheet->quoted_name, area);
  206. /* Autofilters are the only defined name to set the hidden flag. */
  207. _store_defined_name(self, "_xlnm._FilterDatabase", app_name, range, worksheet->index, LXW_TRUE);
  208. }
  209. /*
  210. * Check for Print Area settings and store them.
  211. */
  212. if (worksheet->print_area.in_use) {
  213. lxw_snprintf(app_name, LXW_DEFINED_NAME_LENGTH,
  214. "%s!Print_Area", worksheet->quoted_name);
  215. /* Check for print area that is the max row range. */
  216. if (worksheet->print_area.first_row == 0
  217. && worksheet->print_area.last_row == LXW_ROW_MAX - 1) {
  218. lxw_col_to_name(first_col,
  219. worksheet->print_area.first_col, LXW_FALSE);
  220. lxw_col_to_name(last_col,
  221. worksheet->print_area.last_col, LXW_FALSE);
  222. lxw_snprintf(area, LXW_MAX_CELL_RANGE_LENGTH - 1, "$%s:$%s",
  223. first_col, last_col);
  224. }
  225. /* Check for print area that is the max column range. */
  226. else if (worksheet->print_area.first_col == 0
  227. && worksheet->print_area.last_col == LXW_COL_MAX - 1) {
  228. lxw_snprintf(area, LXW_MAX_CELL_RANGE_LENGTH - 1, "$%d:$%d",
  229. worksheet->print_area.first_row + 1,
  230. worksheet->print_area.last_row + 1);
  231. }
  232. else {
  233. lxw_rowcol_to_range_abs(area,
  234. worksheet->print_area.first_row,
  235. worksheet->print_area.first_col,
  236. worksheet->print_area.last_row,
  237. worksheet->print_area.last_col);
  238. }
  239. lxw_snprintf(range, LXW_DEFINED_NAME_LENGTH, "%s!%s",
  240. worksheet->quoted_name, area);
  241. _store_defined_name(self, "_xlnm.Print_Area", app_name,
  242. range, worksheet->index, LXW_FALSE);
  243. }
  244. /*
  245. * Check for repeat rows/cols. aka, Print Titles and store them.
  246. */
  247. if (worksheet->repeat_rows.in_use || worksheet->repeat_cols.in_use) {
  248. if (worksheet->repeat_rows.in_use
  249. && worksheet->repeat_cols.in_use) {
  250. lxw_snprintf(app_name, LXW_DEFINED_NAME_LENGTH,
  251. "%s!Print_Titles", worksheet->quoted_name);
  252. lxw_col_to_name(first_col,
  253. worksheet->repeat_cols.first_col, LXW_FALSE);
  254. lxw_col_to_name(last_col,
  255. worksheet->repeat_cols.last_col, LXW_FALSE);
  256. lxw_snprintf(range, LXW_DEFINED_NAME_LENGTH,
  257. "%s!$%s:$%s,%s!$%d:$%d",
  258. worksheet->quoted_name, first_col,
  259. last_col, worksheet->quoted_name,
  260. worksheet->repeat_rows.first_row + 1,
  261. worksheet->repeat_rows.last_row + 1);
  262. _store_defined_name(self, "_xlnm.Print_Titles", app_name,
  263. range, worksheet->index, LXW_FALSE);
  264. }
  265. else if (worksheet->repeat_rows.in_use) {
  266. lxw_snprintf(app_name, LXW_DEFINED_NAME_LENGTH,
  267. "%s!Print_Titles", worksheet->quoted_name);
  268. lxw_snprintf(range, LXW_DEFINED_NAME_LENGTH,
  269. "%s!$%d:$%d", worksheet->quoted_name,
  270. worksheet->repeat_rows.first_row + 1,
  271. worksheet->repeat_rows.last_row + 1);
  272. _store_defined_name(self, "_xlnm.Print_Titles", app_name,
  273. range, worksheet->index, LXW_FALSE);
  274. }
  275. else if (worksheet->repeat_cols.in_use) {
  276. lxw_snprintf(app_name, LXW_DEFINED_NAME_LENGTH,
  277. "%s!Print_Titles", worksheet->quoted_name);
  278. lxw_col_to_name(first_col,
  279. worksheet->repeat_cols.first_col, LXW_FALSE);
  280. lxw_col_to_name(last_col,
  281. worksheet->repeat_cols.last_col, LXW_FALSE);
  282. lxw_snprintf(range, LXW_DEFINED_NAME_LENGTH,
  283. "%s!$%s:$%s", worksheet->quoted_name,
  284. first_col, last_col);
  285. _store_defined_name(self, "_xlnm.Print_Titles", app_name,
  286. range, worksheet->index, LXW_FALSE);
  287. }
  288. }
  289. }
  290. }
  291. /*
  292. * Iterate through the worksheets and set up any chart or image drawings.
  293. */
  294. STATIC void
  295. _prepare_drawings(lxw_workbook *self)
  296. {
  297. lxw_worksheet *worksheet;
  298. lxw_image_options *image_options;
  299. uint16_t chart_ref_id = 0;
  300. uint16_t image_ref_id = 0;
  301. uint16_t drawing_id = 0;
  302. STAILQ_FOREACH(worksheet, self->worksheets, list_pointers) {
  303. if (STAILQ_EMPTY(worksheet->image_data)
  304. && STAILQ_EMPTY(worksheet->chart_data))
  305. continue;
  306. drawing_id++;
  307. STAILQ_FOREACH(image_options, worksheet->chart_data, list_pointers) {
  308. chart_ref_id++;
  309. #ifdef HAVE_LXW_CHARTSHEET_NEW
  310. lxw_worksheet_prepare_chart(worksheet, chart_ref_id, drawing_id,
  311. image_options, 0);
  312. #else
  313. lxw_worksheet_prepare_chart(worksheet, chart_ref_id, drawing_id,
  314. image_options);
  315. #endif
  316. if (image_options->chart)
  317. STAILQ_INSERT_TAIL(self->ordered_charts, image_options->chart,
  318. ordered_list_pointers);
  319. }
  320. STAILQ_FOREACH(image_options, worksheet->image_data, list_pointers) {
  321. if (image_options->image_type == LXW_IMAGE_PNG)
  322. self->has_png = LXW_TRUE;
  323. if (image_options->image_type == LXW_IMAGE_JPEG)
  324. self->has_jpeg = LXW_TRUE;
  325. if (image_options->image_type == LXW_IMAGE_BMP)
  326. self->has_bmp = LXW_TRUE;
  327. image_ref_id++;
  328. lxw_worksheet_prepare_image(worksheet, image_ref_id, drawing_id,
  329. image_options);
  330. }
  331. }
  332. self->drawing_count = drawing_id;
  333. }
  334. /*
  335. * Add "cached" data to charts to provide the numCache and strCache data for
  336. * series and title/axis ranges.
  337. */
  338. STATIC void
  339. _add_chart_cache_data(lxw_workbook *self)
  340. {
  341. lxw_chart *chart;
  342. lxw_chart_series *series;
  343. STAILQ_FOREACH(chart, self->ordered_charts, ordered_list_pointers) {
  344. _populate_range(self, chart->title.range);
  345. _populate_range(self, chart->x_axis->title.range);
  346. _populate_range(self, chart->y_axis->title.range);
  347. if (STAILQ_EMPTY(chart->series_list))
  348. continue;
  349. STAILQ_FOREACH(series, chart->series_list, list_pointers) {
  350. _populate_range(self, series->categories);
  351. _populate_range(self, series->values);
  352. _populate_range(self, series->title.range);
  353. }
  354. }
  355. }
  356. /*
  357. * Process and store the defined names. The defined names are stored with
  358. * the Workbook.xml but also with the App.xml if they refer to a sheet
  359. * range like "Sheet1!:A1". The defined names are store in sorted
  360. * order for consistency with Excel. The names need to be normalized before
  361. * sorting.
  362. */
  363. STATIC lxw_error
  364. _store_defined_name(lxw_workbook *self, const char *name, const char *app_name, const char *formula, int16_t index, uint8_t hidden)
  365. {
  366. lxw_worksheet *worksheet;
  367. lxw_defined_name *defined_name;
  368. lxw_defined_name *list_defined_name;
  369. char name_copy[LXW_DEFINED_NAME_LENGTH];
  370. char *tmp_str;
  371. char *worksheet_name;
  372. /* Do some checks on the input data */
  373. if (!name || !formula)
  374. return LXW_ERROR_NULL_PARAMETER_IGNORED;
  375. if (lxw_utf8_strlen(name) > LXW_DEFINED_NAME_LENGTH ||
  376. lxw_utf8_strlen(formula) > LXW_DEFINED_NAME_LENGTH) {
  377. return LXW_ERROR_128_STRING_LENGTH_EXCEEDED;
  378. }
  379. /* Allocate a new defined_name to be added to the linked list of names. */
  380. defined_name = calloc(1, sizeof(struct lxw_defined_name));
  381. RETURN_ON_MEM_ERROR(defined_name, LXW_ERROR_MEMORY_MALLOC_FAILED);
  382. /* Copy the user input string. */
  383. lxw_strcpy(name_copy, name);
  384. /* Set the worksheet index or -1 for a global defined name. */
  385. defined_name->index = index;
  386. defined_name->hidden = hidden;
  387. /* Check for local defined names like like "Sheet1!name". */
  388. tmp_str = strchr(name_copy, '!');
  389. if (tmp_str == NULL) {
  390. /* The name is global. We just store the defined name string. */
  391. lxw_strcpy(defined_name->name, name_copy);
  392. }
  393. else {
  394. /* The name is worksheet local. We need to extract the sheet name
  395. * and map it to a sheet index. */
  396. /* Split the into the worksheet name and defined name. */
  397. *tmp_str = '\0';
  398. tmp_str++;
  399. worksheet_name = name_copy;
  400. /* Remove any worksheet quoting. */
  401. if (worksheet_name[0] == '\'')
  402. worksheet_name++;
  403. if (worksheet_name[strlen(worksheet_name) - 1] == '\'')
  404. worksheet_name[strlen(worksheet_name) - 1] = '\0';
  405. /* Search for worksheet name to get the equivalent worksheet index. */
  406. STAILQ_FOREACH(worksheet, self->worksheets, list_pointers) {
  407. if (strcmp(worksheet_name, worksheet->name) == 0) {
  408. defined_name->index = worksheet->index;
  409. lxw_strcpy(defined_name->normalised_sheetname,
  410. worksheet_name);
  411. }
  412. }
  413. /* If we didn't find the worksheet name we exit. */
  414. if (defined_name->index == -1)
  415. goto mem_error;
  416. lxw_strcpy(defined_name->name, tmp_str);
  417. }
  418. /* Print titles and repeat title pass in the name used for App.xml. */
  419. if (app_name) {
  420. lxw_strcpy(defined_name->app_name, app_name);
  421. lxw_strcpy(defined_name->normalised_sheetname, app_name);
  422. }
  423. else {
  424. lxw_strcpy(defined_name->app_name, name);
  425. }
  426. /* We need to normalize the defined names for sorting. This involves
  427. * removing any _xlnm namespace and converting it to lowercase. */
  428. tmp_str = strstr(name_copy, "_xlnm.");
  429. if (tmp_str)
  430. lxw_strcpy(defined_name->normalised_name, defined_name->name + 6);
  431. else
  432. lxw_strcpy(defined_name->normalised_name, defined_name->name);
  433. lxw_str_tolower(defined_name->normalised_name);
  434. lxw_str_tolower(defined_name->normalised_sheetname);
  435. /* Strip leading "=" from the formula. */
  436. if (formula[0] == '=')
  437. lxw_strcpy(defined_name->formula, formula + 1);
  438. else
  439. lxw_strcpy(defined_name->formula, formula);
  440. /* We add the defined name to the list in sorted order. */
  441. list_defined_name = TAILQ_FIRST(self->defined_names);
  442. if (list_defined_name == NULL ||
  443. _compare_defined_names(defined_name, list_defined_name) < 1) {
  444. /* List is empty or defined name goes to the head. */
  445. TAILQ_INSERT_HEAD(self->defined_names, defined_name, list_pointers);
  446. return LXW_NO_ERROR;
  447. }
  448. TAILQ_FOREACH(list_defined_name, self->defined_names, list_pointers) {
  449. int res = _compare_defined_names(defined_name, list_defined_name);
  450. /* The entry already exists. We exit and don't overwrite. */
  451. if (res == 0)
  452. goto mem_error;
  453. /* New defined name is inserted in sorted order before other entries. */
  454. if (res < 0) {
  455. TAILQ_INSERT_BEFORE(list_defined_name, defined_name,
  456. list_pointers);
  457. return LXW_NO_ERROR;
  458. }
  459. }
  460. /* If the entry wasn't less than any of the entries in the list we add it
  461. * to the end. */
  462. TAILQ_INSERT_TAIL(self->defined_names, defined_name, list_pointers);
  463. return LXW_NO_ERROR;
  464. mem_error:
  465. free(defined_name);
  466. return LXW_ERROR_MEMORY_MALLOC_FAILED;
  467. }
  468. /*
  469. * Compare two defined_name structures.
  470. */
  471. static int
  472. _compare_defined_names(lxw_defined_name *a, lxw_defined_name *b)
  473. {
  474. int res = strcmp(a->normalised_name, b->normalised_name);
  475. /* Primary comparison based on defined name. */
  476. if (res)
  477. return res;
  478. /* Secondary comparison based on worksheet name. */
  479. res = strcmp(a->normalised_sheetname, b->normalised_sheetname);
  480. return res;
  481. }
  482. /* Convert a chart range such as Sheet1!$A$1:$A$5 to a sheet name and row-col
  483. * dimensions, or vice-versa. This gives us the dimensions to read data back
  484. * from the worksheet.
  485. */
  486. STATIC void
  487. _populate_range_dimensions(lxw_workbook *self, lxw_series_range *range)
  488. {
  489. char formula[LXW_MAX_FORMULA_RANGE_LENGTH] = { 0 };
  490. char *tmp_str;
  491. char *sheetname;
  492. /* If neither the range formula or sheetname is defined then this probably
  493. * isn't a valid range.
  494. */
  495. if (!range->formula && !range->sheetname) {
  496. range->ignore_cache = LXW_TRUE;
  497. return;
  498. }
  499. /* If the sheetname is already defined it was already set via
  500. * chart_series_set_categories() or chart_series_set_values().
  501. */
  502. if (range->sheetname)
  503. return;
  504. /* Ignore non-contiguous range like (Sheet1!$A$1:$A$2,Sheet1!$A$4:$A$5) */
  505. if (range->formula[0] == '(') {
  506. range->ignore_cache = LXW_TRUE;
  507. return;
  508. }
  509. /* Create a copy of the formula to modify and parse into parts. */
  510. lxw_snprintf(formula, LXW_MAX_FORMULA_RANGE_LENGTH, "%s", range->formula);
  511. /* Check for valid formula. TODO. This needs stronger validation. */
  512. tmp_str = strchr(formula, '!');
  513. if (tmp_str == NULL) {
  514. range->ignore_cache = LXW_TRUE;
  515. return;
  516. }
  517. else {
  518. /* Split the formulas into sheetname and row-col data. */
  519. *tmp_str = '\0';
  520. tmp_str++;
  521. sheetname = formula;
  522. /* Remove any worksheet quoting. */
  523. if (sheetname[0] == '\'')
  524. sheetname++;
  525. if (sheetname[strlen(sheetname) - 1] == '\'')
  526. sheetname[strlen(sheetname) - 1] = '\0';
  527. /* Check that the sheetname exists. */
  528. if (!workbook_get_worksheet_by_name(self, sheetname)) {
  529. LXW_WARN_FORMAT2("workbook_add_chart(): worksheet name '%s' "
  530. "in chart formula '%s' doesn't exist.",
  531. sheetname, range->formula);
  532. range->ignore_cache = LXW_TRUE;
  533. return;
  534. }
  535. range->sheetname = lxw_strdup(sheetname);
  536. range->first_row = lxw_name_to_row(tmp_str);
  537. range->first_col = lxw_name_to_col(tmp_str);
  538. if (strchr(tmp_str, ':')) {
  539. /* 2D range. */
  540. range->last_row = lxw_name_to_row_2(tmp_str);
  541. range->last_col = lxw_name_to_col_2(tmp_str);
  542. }
  543. else {
  544. /* 1D range. */
  545. range->last_row = range->first_row;
  546. range->last_col = range->first_col;
  547. }
  548. }
  549. }
  550. /*
  551. * Populate the data cache of a chart data series by reading the data from the
  552. * relevant worksheet and adding it to the cached in the range object as a
  553. * list of points.
  554. *
  555. * Note, the data cache isn't strictly required by Excel but it helps if the
  556. * chart is embedded in another application such as PowerPoint and it also
  557. * helps with comparison testing.
  558. */
  559. STATIC void
  560. _populate_range_data_cache(lxw_workbook *self, lxw_series_range *range)
  561. {
  562. lxw_worksheet *worksheet;
  563. lxw_row_t row_num;
  564. lxw_col_t col_num;
  565. lxw_row *row_obj;
  566. lxw_cell *cell_obj;
  567. struct lxw_series_data_point *data_point;
  568. uint16_t num_data_points = 0;
  569. /* If ignore_cache is set then don't try to populate the cache. This flag
  570. * may be set manually, for testing, or due to a case where the cache
  571. * can't be calculated.
  572. */
  573. if (range->ignore_cache)
  574. return;
  575. /* Currently we only handle 2D ranges so ensure either the rows or cols
  576. * are the same.
  577. */
  578. if (range->first_row != range->last_row
  579. && range->first_col != range->last_col) {
  580. range->ignore_cache = LXW_TRUE;
  581. return;
  582. }
  583. /* Check that the sheetname exists. */
  584. worksheet = workbook_get_worksheet_by_name(self, range->sheetname);
  585. if (!worksheet) {
  586. LXW_WARN_FORMAT2("workbook_add_chart(): worksheet name '%s' "
  587. "in chart formula '%s' doesn't exist.",
  588. range->sheetname, range->formula);
  589. range->ignore_cache = LXW_TRUE;
  590. return;
  591. }
  592. /* We can't read the data when worksheet optimization is on. */
  593. if (worksheet->optimize) {
  594. range->ignore_cache = LXW_TRUE;
  595. return;
  596. }
  597. /* Iterate through the worksheet data and populate the range cache. */
  598. for (row_num = range->first_row; row_num <= range->last_row; row_num++) {
  599. row_obj = lxw_worksheet_find_row(worksheet, row_num);
  600. for (col_num = range->first_col; col_num <= range->last_col;
  601. col_num++) {
  602. data_point = calloc(1, sizeof(struct lxw_series_data_point));
  603. if (!data_point) {
  604. range->ignore_cache = LXW_TRUE;
  605. return;
  606. }
  607. cell_obj = lxw_worksheet_find_cell(row_obj, col_num);
  608. if (cell_obj) {
  609. if (cell_obj->type == NUMBER_CELL) {
  610. data_point->number = cell_obj->u.number;
  611. }
  612. if (cell_obj->type == STRING_CELL) {
  613. data_point->string = lxw_strdup(cell_obj->sst_string);
  614. data_point->is_string = LXW_TRUE;
  615. range->has_string_cache = LXW_TRUE;
  616. }
  617. }
  618. else {
  619. data_point->no_data = LXW_TRUE;
  620. }
  621. STAILQ_INSERT_TAIL(range->data_cache, data_point, list_pointers);
  622. num_data_points++;
  623. }
  624. }
  625. range->num_data_points = num_data_points;
  626. }
  627. /* Set the range dimensions and set the data cache.
  628. */
  629. STATIC void
  630. _populate_range(lxw_workbook *self, lxw_series_range *range)
  631. {
  632. _populate_range_dimensions(self, range);
  633. _populate_range_data_cache(self, range);
  634. }