Skip to content

Commit b90a197

Browse files
viestviest
authored
Merge pull request #376 from viest/dev
exception message, reader, PHP8.1
2 parents 5488d16 + b3f9606 commit b90a197

File tree

8 files changed

+156
-37
lines changed

8 files changed

+156
-37
lines changed

‎config.m4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ PHP_ARG_WITH(libxlsxio, system libxlsxio,
88
[ --with-libxlsxio=DIR Use system libxlsxio], no, no)
99

1010
PHP_ARG_ENABLE(reader, enable xlsx reader support,
11-
[ --enable-reader Enable xlsx reader?], no, no)
11+
[ --enable-reader Enable xlsx reader?], yes, yes)
1212

1313
if test "$PHP_XLSWRITER" != "no"; then
1414
xls_writer_sources="

‎include/exception.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ extern zend_class_entry *vtiful_exception_ce;
1717

1818
VTIFUL_STARTUP_FUNCTION(exception);
1919

20+
char* exception_message_map(int code);
21+
2022
#endif

‎include/xlswriter.h‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,12 @@ typedef struct _vtiful_validation_object {
161161
} \
162162
} while(0);
163163

164-
#define WORKSHEET_WRITER_EXCEPTION(error) \
165-
do { \
166-
if(error > LXW_NO_ERROR) { \
167-
zend_throw_exception(vtiful_exception_ce, "Worksheet write exception", error); \
168-
return; \
169-
} \
164+
#define WORKSHEET_WRITER_EXCEPTION(error) \
165+
do { \
166+
if(error > LXW_NO_ERROR) { \
167+
zend_throw_exception(vtiful_exception_ce, exception_message_map(error), error); \
168+
return; \
169+
} \
170170
} while(0)
171171

172172
#define FCALL_TWO_ARGS(bucket) \
@@ -207,6 +207,21 @@ typedef struct _vtiful_validation_object {
207207
#define PROP_OBJ(zv) Z_OBJ_P(zv)
208208
#endif
209209

210+
#if PHP_VERSION_ID < 80000
211+
#define Z_PARAM_STRING_OR_NULL(dest, dest_len) \
212+
Z_PARAM_STRING_EX(dest, dest_len, 1, 0)
213+
#define Z_PARAM_STR_OR_NULL(dest) \
214+
Z_PARAM_STR_EX(dest, 1, 0)
215+
#define Z_PARAM_RESOURCE_OR_NULL(dest) \
216+
Z_PARAM_RESOURCE_EX(dest, 1, 0)
217+
#define Z_PARAM_DOUBLE_OR_NULL(dest, is_null) \
218+
Z_PARAM_DOUBLE_EX(dest, is_null, 1, 0)
219+
#define Z_PARAM_LONG_OR_NULL(dest, is_null) \
220+
Z_PARAM_LONG_EX(dest, is_null, 1, 0)
221+
#define Z_PARAM_ARRAY_OR_NULL(dest) \
222+
Z_PARAM_ARRAY_EX(dest, 1, 0)
223+
#endif
224+
210225
static inline xls_object *php_vtiful_xls_fetch_object(zend_object *obj) {
211226
if (obj == NULL) {
212227
return NULL;

‎kernel/csv.c‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,22 @@ unsigned int xlsx_to_csv(
9494
zend_call_function(fci, fci_cache);
9595

9696
if (Z_TYPE(retval) == IS_ARRAY) {
97+
#if PHP_VERSION_ID >= 80100
98+
ret = php_fputcsv(_stream_t, &retval, delimiter, enclosure, escape_char, NULL);
99+
#else
97100
ret = php_fputcsv(_stream_t, &retval, delimiter, enclosure, escape_char);
101+
#endif
98102
}
99103

100104
zval_ptr_dtor(&retval);
101105
goto CLEAN_UP_SCENE;
102106
}
103107

108+
#if PHP_VERSION_ID >= 80100
109+
ret = php_fputcsv(_stream_t, &_zv_tmp_row, delimiter, enclosure, escape_char, NULL);
110+
#else
104111
ret = php_fputcsv(_stream_t, &_zv_tmp_row, delimiter, enclosure, escape_char);
112+
#endif
105113

106114
CLEAN_UP_SCENE:
107115

‎kernel/excel.c‎

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ PHP_METHOD(vtiful_xls, fileName)
327327
ZEND_PARSE_PARAMETERS_START(1, 2)
328328
Z_PARAM_STR(zs_file_name)
329329
Z_PARAM_OPTIONAL
330-
Z_PARAM_STR(zs_sheet_name)
330+
Z_PARAM_STR_OR_NULL(zs_sheet_name)
331331
ZEND_PARSE_PARAMETERS_END();
332332

333333
ZVAL_COPY(return_value, getThis());
@@ -367,7 +367,7 @@ PHP_METHOD(vtiful_xls, addSheet)
367367

368368
ZEND_PARSE_PARAMETERS_START(0, 1)
369369
Z_PARAM_OPTIONAL
370-
Z_PARAM_STR(zs_sheet_name)
370+
Z_PARAM_STR_OR_NULL(zs_sheet_name)
371371
ZEND_PARSE_PARAMETERS_END();
372372

373373
ZVAL_COPY(return_value, getThis());
@@ -458,7 +458,7 @@ PHP_METHOD(vtiful_xls, constMemory)
458458
ZEND_PARSE_PARAMETERS_START(1, 2)
459459
Z_PARAM_STR(zs_file_name)
460460
Z_PARAM_OPTIONAL
461-
Z_PARAM_STR(zs_sheet_name)
461+
Z_PARAM_STR_OR_NULL(zs_sheet_name)
462462
ZEND_PARSE_PARAMETERS_END();
463463

464464
ZVAL_COPY(return_value, getThis());
@@ -470,7 +470,11 @@ PHP_METHOD(vtiful_xls, constMemory)
470470
if(obj->write_ptr.workbook == NULL) {
471471
xls_file_path(zs_file_name, dir_path, &file_path);
472472

473-
lxw_workbook_options options = {.constant_memory = LXW_TRUE, .tmpdir = NULL};
473+
lxw_workbook_options options = {
474+
.constant_memory = LXW_TRUE,
475+
.tmpdir = NULL,
476+
.use_zip64 = LXW_TRUE
477+
};
474478

475479
if(zs_sheet_name != NULL) {
476480
sheet_name = ZSTR_VAL(zs_sheet_name);
@@ -498,7 +502,7 @@ PHP_METHOD(vtiful_xls, header)
498502
ZEND_PARSE_PARAMETERS_START(1, 2)
499503
Z_PARAM_ARRAY(header)
500504
Z_PARAM_OPTIONAL
501-
Z_PARAM_RESOURCE(zv_format_handle)
505+
Z_PARAM_RESOURCE_OR_NULL(zv_format_handle)
502506
ZEND_PARSE_PARAMETERS_END();
503507

504508
ZVAL_COPY(return_value, getThis());
@@ -596,8 +600,8 @@ PHP_METHOD(vtiful_xls, insertText)
596600
Z_PARAM_LONG(column)
597601
Z_PARAM_ZVAL(data)
598602
Z_PARAM_OPTIONAL
599-
Z_PARAM_STR(format)
600-
Z_PARAM_RESOURCE(format_handle)
603+
Z_PARAM_STR_OR_NULL(format)
604+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
601605
ZEND_PARSE_PARAMETERS_END();
602606

603607
ZVAL_COPY(return_value, getThis());
@@ -629,8 +633,8 @@ PHP_METHOD(vtiful_xls, insertDate)
629633
Z_PARAM_LONG(column)
630634
Z_PARAM_ZVAL(data)
631635
Z_PARAM_OPTIONAL
632-
Z_PARAM_STR(format)
633-
Z_PARAM_RESOURCE(format_handle)
636+
Z_PARAM_STR_OR_NULL(format)
637+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
634638
ZEND_PARSE_PARAMETERS_END();
635639

636640
ZVAL_COPY(return_value, getThis());
@@ -703,9 +707,9 @@ PHP_METHOD(vtiful_xls, insertUrl)
703707
Z_PARAM_LONG(column)
704708
Z_PARAM_STR(url)
705709
Z_PARAM_OPTIONAL
706-
Z_PARAM_STR(text)
707-
Z_PARAM_STR(tool_tip)
708-
Z_PARAM_RESOURCE(format_handle)
710+
Z_PARAM_STR_OR_NULL(text)
711+
Z_PARAM_STR_OR_NULL(tool_tip)
712+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
709713
ZEND_PARSE_PARAMETERS_END();
710714

711715
ZVAL_COPY(return_value, getThis());
@@ -735,8 +739,8 @@ PHP_METHOD(vtiful_xls, insertImage)
735739
Z_PARAM_LONG(column)
736740
Z_PARAM_ZVAL(image)
737741
Z_PARAM_OPTIONAL
738-
Z_PARAM_DOUBLE(width)
739-
Z_PARAM_DOUBLE(height)
742+
Z_PARAM_DOUBLE_OR_NULL(width, _dummy)
743+
Z_PARAM_DOUBLE_OR_NULL(height, _dummy)
740744
ZEND_PARSE_PARAMETERS_END();
741745

742746
ZVAL_COPY(return_value, getThis());
@@ -764,7 +768,7 @@ PHP_METHOD(vtiful_xls, insertFormula)
764768
Z_PARAM_LONG(column)
765769
Z_PARAM_STR(formula)
766770
Z_PARAM_OPTIONAL
767-
Z_PARAM_RESOURCE(format_handle)
771+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
768772
ZEND_PARSE_PARAMETERS_END();
769773

770774
ZVAL_COPY(return_value, getThis());
@@ -853,7 +857,7 @@ PHP_METHOD(vtiful_xls, mergeCells)
853857
Z_PARAM_STR(range)
854858
Z_PARAM_ZVAL(data)
855859
Z_PARAM_OPTIONAL
856-
Z_PARAM_RESOURCE(format_handle)
860+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
857861
ZEND_PARSE_PARAMETERS_END();
858862

859863
ZVAL_COPY(return_value, getThis());
@@ -886,7 +890,7 @@ PHP_METHOD(vtiful_xls, setColumn)
886890
Z_PARAM_STR(range)
887891
Z_PARAM_DOUBLE(width)
888892
Z_PARAM_OPTIONAL
889-
Z_PARAM_RESOURCE(format_handle)
893+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
890894
ZEND_PARSE_PARAMETERS_END();
891895

892896
ZVAL_COPY(return_value, getThis());
@@ -919,7 +923,7 @@ PHP_METHOD(vtiful_xls, setRow)
919923
Z_PARAM_STR(range)
920924
Z_PARAM_DOUBLE(height)
921925
Z_PARAM_OPTIONAL
922-
Z_PARAM_RESOURCE(format_handle)
926+
Z_PARAM_RESOURCE_OR_NULL(format_handle)
923927
ZEND_PARSE_PARAMETERS_END();
924928

925929
ZVAL_COPY(return_value, getThis());
@@ -1041,7 +1045,7 @@ PHP_METHOD(vtiful_xls, timestampFromDateDouble)
10411045
double date = 0;
10421046

10431047
ZEND_PARSE_PARAMETERS_START(1, 1)
1044-
Z_PARAM_DOUBLE(date)
1048+
Z_PARAM_DOUBLE_OR_NULL(date, _dummy)
10451049
ZEND_PARSE_PARAMETERS_END();
10461050

10471051
if (date <= 0) {
@@ -1104,7 +1108,7 @@ PHP_METHOD(vtiful_xls, protection)
11041108

11051109
ZEND_PARSE_PARAMETERS_START(0, 1)
11061110
Z_PARAM_OPTIONAL
1107-
Z_PARAM_STR(password)
1111+
Z_PARAM_STR_OR_NULL(password)
11081112
ZEND_PARSE_PARAMETERS_END();
11091113

11101114
ZVAL_COPY(return_value, getThis());
@@ -1237,8 +1241,8 @@ PHP_METHOD(vtiful_xls, openSheet)
12371241

12381242
ZEND_PARSE_PARAMETERS_START(0, 2)
12391243
Z_PARAM_OPTIONAL
1240-
Z_PARAM_STR(zs_sheet_name)
1241-
Z_PARAM_LONG(zl_flag)
1244+
Z_PARAM_STR_OR_NULL(zs_sheet_name)
1245+
Z_PARAM_LONG_OR_NULL(zl_flag, _dummy)
12421246
ZEND_PARSE_PARAMETERS_END();
12431247

12441248
ZVAL_COPY(return_value, getThis());
@@ -1348,9 +1352,9 @@ PHP_METHOD(vtiful_xls, putCSV)
13481352
ZEND_PARSE_PARAMETERS_START(1, 4)
13491353
Z_PARAM_RESOURCE(fp)
13501354
Z_PARAM_OPTIONAL
1351-
Z_PARAM_STRING(delimiter_str, delimiter_str_len)
1352-
Z_PARAM_STRING(enclosure_str, enclosure_str_len)
1353-
Z_PARAM_STRING(escape_str,escape_str_len)
1355+
Z_PARAM_STRING_OR_NULL(delimiter_str, delimiter_str_len)
1356+
Z_PARAM_STRING_OR_NULL(enclosure_str, enclosure_str_len)
1357+
Z_PARAM_STRING_OR_NULL(escape_str,escape_str_len)
13541358
ZEND_PARSE_PARAMETERS_END();
13551359

13561360
xls_object *obj = Z_XLS_P(getThis());
@@ -1386,9 +1390,9 @@ PHP_METHOD(vtiful_xls, putCSVCallback)
13861390
Z_PARAM_FUNC(fci, fci_cache)
13871391
Z_PARAM_RESOURCE(fp)
13881392
Z_PARAM_OPTIONAL
1389-
Z_PARAM_STRING(delimiter_str, delimiter_str_len)
1390-
Z_PARAM_STRING(enclosure_str, enclosure_str_len)
1391-
Z_PARAM_STRING(escape_str,escape_str_len)
1393+
Z_PARAM_STRING_OR_NULL(delimiter_str, delimiter_str_len)
1394+
Z_PARAM_STRING_OR_NULL(enclosure_str, enclosure_str_len)
1395+
Z_PARAM_STRING_OR_NULL(escape_str,escape_str_len)
13921396
ZEND_PARSE_PARAMETERS_END();
13931397

13941398
xls_object *obj = Z_XLS_P(getThis());
@@ -1440,7 +1444,7 @@ PHP_METHOD(vtiful_xls, nextRow)
14401444

14411445
ZEND_PARSE_PARAMETERS_START(0, 1)
14421446
Z_PARAM_OPTIONAL
1443-
Z_PARAM_ARRAY(zv_type_t)
1447+
Z_PARAM_ARRAY_OR_NULL(zv_type_t)
14441448
ZEND_PARSE_PARAMETERS_END();
14451449

14461450
xls_object *obj = Z_XLS_P(getThis());
@@ -1468,7 +1472,7 @@ PHP_METHOD(vtiful_xls, nextCellCallback)
14681472
ZEND_PARSE_PARAMETERS_START(1, 2)
14691473
Z_PARAM_FUNC(fci, fci_cache)
14701474
Z_PARAM_OPTIONAL
1471-
Z_PARAM_STR(zs_sheet_name)
1475+
Z_PARAM_STR_OR_NULL(zs_sheet_name)
14721476
ZEND_PARSE_PARAMETERS_END();
14731477

14741478
xls_object *obj = Z_XLS_P(getThis());

‎kernel/exception.c‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,53 @@ VTIFUL_STARTUP_FUNCTION(exception) {
3333
return SUCCESS;
3434
}
3535
/* }}} */
36+
37+
/** {{{ exception_message_map
38+
*/
39+
char* exception_message_map(int code) {
40+
switch (code) {
41+
case LXW_ERROR_MEMORY_MALLOC_FAILED:
42+
return "Memory error, failed to malloc() required memory.";
43+
case LXW_ERROR_CREATING_XLSX_FILE:
44+
return "Error creating output xlsx file. Usually a permissions error.";
45+
case LXW_ERROR_CREATING_TMPFILE:
46+
return "Error encountered when creating a tmpfile during file assembly.";
47+
case LXW_ERROR_READING_TMPFILE:
48+
return "Error reading a tmpfile.";
49+
case LXW_ERROR_ZIP_FILE_OPERATION:
50+
return "Zlib error with a file operation while creating xlsx file.";
51+
case LXW_ERROR_ZIP_FILE_ADD:
52+
return "Zlib error when adding sub file to xlsx file.";
53+
case LXW_ERROR_ZIP_CLOSE:
54+
return "Zlib error when closing xlsx file.";
55+
case LXW_ERROR_NULL_PARAMETER_IGNORED:
56+
return "NULL function parameter ignored.";
57+
case LXW_ERROR_PARAMETER_VALIDATION:
58+
return "Function parameter validation error.";
59+
case LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED:
60+
return "Worksheet name exceeds Excel's limit of 31 characters.";
61+
case LXW_ERROR_INVALID_SHEETNAME_CHARACTER:
62+
return "Worksheet name contains invalid.";
63+
case LXW_ERROR_SHEETNAME_ALREADY_USED:
64+
return "Worksheet name is already in use.";
65+
case LXW_ERROR_32_STRING_LENGTH_EXCEEDED:
66+
return "Parameter exceeds Excel's limit of 32 characters.";
67+
case LXW_ERROR_128_STRING_LENGTH_EXCEEDED:
68+
return "Parameter exceeds Excel's limit of 128 characters.";
69+
case LXW_ERROR_255_STRING_LENGTH_EXCEEDED:
70+
return "Parameter exceeds Excel's limit of 255 characters.";
71+
case LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED:
72+
return "String exceeds Excel's limit of 32:767 characters.";
73+
case LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND:
74+
return "Error finding internal string index.";
75+
case LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE:
76+
return "Worksheet row or column index out of range.";
77+
case LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED:
78+
return "Maximum number of worksheet URLs (65530) exceeded.";
79+
case LXW_ERROR_IMAGE_DIMENSIONS:
80+
return "Couldn't read image dimensions or DPI.";
81+
default:
82+
return "Unknown error";
83+
}
84+
}
85+
/* }}} */

‎kernel/help.c‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,14 @@ zend_long date_double_to_timestamp(double value) {
6464
/* {{{ */
6565
unsigned int directory_exists(const char *path) {
6666
zval dir_exists;
67+
68+
#if PHP_VERSION_ID >= 80100
69+
zend_string *zs_path = zend_string_init(path, strlen(path), 0);
70+
php_stat(zs_path, FS_IS_DIR, &dir_exists);
71+
zend_string_release(zs_path);
72+
#else
6773
php_stat(path, strlen(path), FS_IS_DIR, &dir_exists);
74+
#endif
6875

6976
if (Z_TYPE(dir_exists) == IS_FALSE) {
7077
zval_ptr_dtor(&dir_exists);
@@ -79,7 +86,14 @@ unsigned int directory_exists(const char *path) {
7986
/* {{{ */
8087
unsigned int file_exists(const char *path) {
8188
zval file_exists;
89+
90+
#if PHP_VERSION_ID >= 80100
91+
zend_string *zs_path = zend_string_init(path, strlen(path), 0);
92+
php_stat(zs_path, FS_IS_FILE, &file_exists);
93+
zend_string_release(zs_path);
94+
#else
8295
php_stat(path, strlen(path), FS_IS_FILE, &file_exists);
96+
#endif
8397

8498
if (Z_TYPE(file_exists) == IS_FALSE) {
8599
zval_ptr_dtor(&file_exists);

‎tests/writer_exception.phpt‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
--TEST--
2+
Check for vtiful presence
3+
--SKIPIF--
4+
<?php if (!extension_loaded("xlswriter")) print "skip"; ?>
5+
--FILE--
6+
<?php
7+
try {
8+
$config = ['path' => './tests'];
9+
10+
$fileObject = new \Vtiful\Kernel\Excel($config);
11+
12+
$fileObject->constMemory('tutorial.xlsx', 'DemoSheet')
13+
->insertText(1, 0, 'viest')
14+
->insertText(0, 0, 'viest');
15+
} catch (\Vtiful\Kernel\Exception $exception) {
16+
echo $exception->getCode() . PHP_EOL;
17+
echo $exception->getMessage() . PHP_EOL;
18+
}
19+
?>
20+
--CLEAN--
21+
<?php
22+
@unlink(__DIR__ . '/tutorial.xlsx');
23+
?>
24+
--EXPECT--
25+
23
26+
Worksheet row or column index out of range.

0 commit comments

Comments
 (0)