github-starred/libxlsxwriter
2
0
Fork 0
mirror of https://github.com/jmcnamara/libxlsxwriter.git synced 2026-05-15 14:15:54 -06:00
Code Issues 16 Projects Packages Wiki Activity Actions

[GH-ISSUE #310] Zip file not properly closed after file write error #250

New issue
Closed
opened 2026-05-05 12:02:12 -06:00 by gitea-mirror · 9 comments
gitea-mirror commented 2026-05-05 12:02:12 -06:00
Owner
Copy link

Originally created by @matthiasstraka on GitHub (Sep 24, 2020).
Original GitHub issue: https://github.com/jmcnamara/libxlsxwriter/issues/310

Originally assigned to: @jmcnamara on GitHub.

I am having an issue with writing an xlsx file to a disk that is already full. A write error is reported (in _add_file_to_zip) but the corresponding zip file remains open when reporting the error to the caller of workbook_close. This prevents me from erasing a failed xlsx file.

How to reproduce:

  • Create small RAM disk (or choose disk with low remaining storage space)
  • Write large XLSX file to it
Originally created by @matthiasstraka on GitHub (Sep 24, 2020). Original GitHub issue: https://github.com/jmcnamara/libxlsxwriter/issues/310 Originally assigned to: @jmcnamara on GitHub. I am having an issue with writing an xlsx file to a disk that is already full. A write error is reported (in _add_file_to_zip) but the corresponding zip file remains open when reporting the error to the caller of workbook_close. This prevents me from erasing a failed xlsx file. How to reproduce: - Create small RAM disk (or choose disk with low remaining storage space) - Write large XLSX file to it
gitea-mirror 2026-05-05 12:02:12 -06:00
gitea-mirror commented 2026-05-05 12:02:17 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 24, 2020):

Thanks for the report. I'll look into it.

<!-- gh-comment-id:698296719 --> @jmcnamara commented on GitHub (Sep 24, 2020): Thanks for the report. I'll look into it.
gitea-mirror commented 2026-05-05 12:02:20 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 24, 2020):

Can you try the fix on the gh310 branch to see if it resolves your issue.

<!-- gh-comment-id:698349095 --> @jmcnamara commented on GitHub (Sep 24, 2020): Can you try the fix on the gh310 branch to see if it resolves your issue.
gitea-mirror commented 2026-05-05 12:02:22 -06:00
Author
Owner
Copy link

@matthiasstraka commented on GitHub (Sep 25, 2020):

Thanks, this looks better. Sorry for not fixing it myself as I do not have the time to check for side effects at the moment.
I would also suggest swapping fclose(worksheet->file); and RETURN_ON_ERROR(err); in _write_worksheet_files and maybe call zipCloseFileInZip(self->zipfile); in the error paths of _add_file_to_zip or clean up zipfile in an approriate way.

<!-- gh-comment-id:698758960 --> @matthiasstraka commented on GitHub (Sep 25, 2020): Thanks, this looks better. Sorry for not fixing it myself as I do not have the time to check for side effects at the moment. I would also suggest swapping `fclose(worksheet->file);` and `RETURN_ON_ERROR(err);` in __write_worksheet_files_ and maybe call `zipCloseFileInZip(self->zipfile);` in the error paths of __add_file_to_zip_ or clean up zipfile in an approriate way.
gitea-mirror commented 2026-05-05 12:02:23 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 25, 2020):

I would also suggest swapping fclose(worksheet->file); and RETURN_ON_ERROR(err); in _write_worksheet_files and maybe call zipCloseFileInZip(self->zipfile); in the error paths of _add_file_to_zip or clean up zipfile in an approriate way.

Good suggestions. I'll look into that.

<!-- gh-comment-id:698761272 --> @jmcnamara commented on GitHub (Sep 25, 2020): > I would also suggest swapping `fclose(worksheet->file);` and `RETURN_ON_ERROR(err);` in __write_worksheet_files_ and maybe call `zipCloseFileInZip(self->zipfile);` in the error paths of __add_file_to_zip_ or clean up zipfile in an approriate way. Good suggestions. I'll look into that.
gitea-mirror commented 2026-05-05 12:02:25 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 25, 2020):

I've force pushed an updated version onto the same branch: 2c8cf48

Try it out for your failing test case if you get a chance.

<!-- gh-comment-id:698776793 --> @jmcnamara commented on GitHub (Sep 25, 2020): I've force pushed an updated version onto the same branch: 2c8cf48 Try it out for your failing test case if you get a chance.
gitea-mirror commented 2026-05-05 12:02:27 -06:00
Author
Owner
Copy link

@matthiasstraka commented on GitHub (Sep 25, 2020):

I tested you commits and can happily report that both the current temporary file and the xlsx-zip file are closed when my disk runs full. Thus, I can delete the file after writing failed and no temporary files stay around. This issue is fixed for me.

<!-- gh-comment-id:698836228 --> @matthiasstraka commented on GitHub (Sep 25, 2020): I tested you commits and can happily report that both the current temporary file and the xlsx-zip file are closed when my disk runs full. Thus, I can delete the file after writing failed and no temporary files stay around. This issue is fixed for me.
gitea-mirror commented 2026-05-05 12:02:29 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 25, 2020):

Cool thanks for the feedback @matthiasstraka

I'll do a bit more testing and merge it up to main.

<!-- gh-comment-id:698840698 --> @jmcnamara commented on GitHub (Sep 25, 2020): Cool thanks for the feedback @matthiasstraka I'll do a bit more testing and merge it up to main.
gitea-mirror commented 2026-05-05 12:02:31 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Sep 25, 2020):

@matthiasstraka Thanks for testing.

There were still some possible, but unlikely, paths that could return an error without a cleanup. I think all of them are covered now.

When you get a chance can you test once more with the code on the same branch: dfbc07c

No rush.

<!-- gh-comment-id:699083621 --> @jmcnamara commented on GitHub (Sep 25, 2020): @matthiasstraka Thanks for testing. There were still some possible, but unlikely, paths that could return an error without a cleanup. I think all of them are covered now. When you get a chance can you test once more with the code on the same branch: dfbc07c No rush.
gitea-mirror commented 2026-05-05 12:02:35 -06:00
Author
Owner
Copy link

@jmcnamara commented on GitHub (Oct 2, 2020):

Fixed and merged to main. Thanks for the report.

<!-- gh-comment-id:702925160 --> @jmcnamara commented on GitHub (Oct 2, 2020): Fixed and merged to main. Thanks for the report.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
coverity
cmake-improvements
cmake_pkgconfig_fix
ctest
button
tables
autofilter
dtoa
iwyu
openssl
gentoo
gh310
condition_format
rich_string_html
header_footer_images
custom_data_labels
object_position
gh265
constant_mode_comments2
constant_mode_comments
vml
md5
vcpkg
hyperlinks
api_refactor
win_fopen
gh203
rich_strings
chartsheet
in_mem_image
gh192
revert-162-master
data_validation
meson
charts
scan_build
utf8_strlen
tmpfileplus
custom_properties
insert_image
default_row
control_chars
worksheet_protect
dev
red_black
panes
mkstemp
defined_names
optimise
wip
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.9
v1.1.8
RELEASE_1.1.7
RELEASE_1.1.6
RELEASE_1.1.5
RELEASE_1.1.4
RELEASE_1.1.3
RELEASE_1.1.2
RELEASE_1.1.1
RELEASE_1.1.0
RELEASE_1.0.9
RELEASE_1.0.8
RELEASE_1.0.7
RELEASE_1.0.6
RELEASE_1.0.5
RELEASE_1.0.4
RELEASE_1.0.3
RELEASE_1.0.2
RELEASE_1.0.1
RELEASE_1.0.0
RELEASE_0.9.9
RELEASE_0.9.8
RELEASE_0.9.7
RELEASE_0.9.6
RELEASE_0.9.5
RELEASE_0.9.4
RELEASE_0.9.3
RELEASE_0.9.2
RELEASE_0.9.1
RELEASE_0.9.0
RELEASE_0.8.9
RELEASE_0.8.8
RELEASE_0.8.7
RELEASE_0.8.6
RELEASE_0.8.5
RELEASE_0.8.4
RELEASE_0.8.3
RELEASE_0.8.2
RELEASE_0.8.1
RELEASE_0.8.0
RELEASE_0.7.9
RELEASE_0.7.8
RELEASE_0.7.7
RELEASE_0.7.6
RELEASE_0.7.5
RELEASE_0.7.4
RELEASE_0.7.3
RELEASE_0.7.2
RELEASE_0.7.1
RELEASE_0.7.0
RELEASE_0.6.9
RELEASE_0.6.8
RELEASE_0.6.7
RELEASE_0.6.6
RELEASE_0.6.5
RELEASE_0.6.4
RELEASE_0.6.3
RELEASE_0.6.2
RELEASE_0.6.1
RELEASE_0.6.0
RELEASE_0.5.9
RELEASE_0.5.8
RELEASE_0.5.7
RELEASE_0.5.6
RELEASE_0.5.5
RELEASE_0.5.4
RELEASE_0.5.3
RELEASE_0.5.2
RELEASE_0.5.1
RELEASE_0.5.0
RELEASE_0.4.9
RELEASE_0.4.8
RELEASE_0.4.7
RELEASE_0.4.6
RELEASE_0.4.5
RELEASE_0.4.4
RELEASE_0.4.3
RELEASE_0.4.2
RELEASE_0.4.1
RELEASE_0.4.0
RELEASE_0.3.9
RELEASE_0.3.8
RELEASE_0.3.7
RELEASE_0.3.6
RELEASE_0.3.5
RELEASE_0.3.4
RELEASE_0.3.3
RELEASE_0.3.2
RELEASE_0.3.1
RELEASE_0.3.0
RELEASE_0.2.9
RELEASE_0.2.8
RELEASE_0.2.7
RELEASE_0.2.6
RELEASE_0.2.5
RELEASE_0.2.4
RELEASE_0.2.3
RELEASE_0.2.2
RELEASE_0.2.1
RELEASE_0.2.0
RELEASE_0.1.9
RELEASE_0.1.8
RELEASE_0.1.7
RELEASE_0.1.6
RELEASE_0.1.5
RELEASE_0.1.4
RELEASE_0.1.3
RELEASE_0.1.2
RELEASE_0.1.1
RELEASE_0.1.0
RELEASE_0.0.9
RELEASE_0.0.8
RELEASE_0.0.7
RELEASE_0.0.6
RELEASE_0.0.5
RELEASE_0.0.4
RELEASE_0.0.3
RELEASE_0.0.2
RELEASE_0.0.1
Labels
Clear labels   
awaiting user feedback

   
bug

   
cmake

   
cmake

   
docs

   
feature request

   
in progress

   
long term

   
medium term

   
medium term

   
pull-request

Mirrored from GitHub Pull Request

  
question

   
question

   
ready to close

   
short term

   
under investigation

   
wontfix
No labels
awaiting user feedback
bug
cmake
cmake
docs
feature request
in progress
long term
medium term
medium term
pull-request
question
question
ready to close
short term
under investigation
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/libxlsxwriter#250
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?