New Ticket     Tickets     Wiki     Browse Source     Timeline     Roadmap     Ticket Reports     Search

Ticket #26664 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

epubcheck @1.0.5_0 problems with shell wrapper

Reported by: jpenney@… Owned by: ryandesign@…
Priority: Normal Milestone:
Component: ports Version: 1.9.1
Keywords: haspatch Cc: oksmith@…
Port: epubcheck

Description

There are number of problems with the epubcheck wrapper script provided with this port:

  • creates temporary files without using/checking TMPDIR or TEMP
  • merges output of STDOUT and STDERR (2>&1)
  • looses the exit code returned by the epubcheck application itself, and instead parses the combined output
  • looses the ability to pass files with spaces in the name (uses $@ instead of "$@")

I'm attaching a patch containing a simplified script that corrects these issues.

Attachments

patch-files-epubcheck.in.diff (471 bytes) - added by jpenney@… 4 years ago.
patch that corrects issues with wrapper script

Change History

Changed 4 years ago by jpenney@…

patch that corrects issues with wrapper script

comment:1 Changed 4 years ago by jmr@…

  • Keywords haspatch added

comment:2 Changed 4 years ago by ryandesign@…

  • Cc oksmith@… added

Cc'ing the author of that wrapper script for comment.

comment:3 in reply to: ↑ description ; follow-up: ↓ 4 Changed 4 years ago by oksmith@…

Well I guess anybody who uses epubcheck in batch process such as a Makefile will have to do everything I tried to provide in the wrapper.

Is there any way to make better what there was instead of clobbering it? I am happy to try to fix it. Please advise.

You may want to review the script associated with the port relames. It doesn't use exec or have double quotes around the $@ and is what I used as the starting point for this script.

Thanks.

Replying to jpenney@…:

There are number of problems with the epubcheck wrapper script provided with this port:

  • creates temporary files without using/checking TMPDIR or TEMP
  • merges output of STDOUT and STDERR (2>&1)
  • looses the exit code returned by the epubcheck application itself, and instead parses the combined output
  • looses the ability to pass files with spaces in the name (uses $@ instead of "$@")

I'm attaching a patch containing a simplified script that corrects these issues.

comment:4 in reply to: ↑ 3 ; follow-up: ↓ 5 Changed 4 years ago by jpenney@…

Replying to oksmith@…:

Is there any way to make better what there was instead of clobbering it? I am happy to try to fix it. Please advise.

You may want to review the script associated with the port relames. It doesn't use exec or have double quotes around the $@ and is what I used as the starting point for this script.

Unless I'm missing something my wrapper and your wrapper achieve the same end result (they run epubcheck, and return an error to the shell when it fails). The only difference being the four points I've called out above don't occur in my wrapper.

Without the double quotes around $@

epubcheck "file one.epub" "filetwo.epub" "file three.epub"

Passes the following arguments:

  • file
  • one.epub
  • filetwo.epub
  • file
  • three.epub

With the double quotes around $@:

  • file one.epub
  • filetwo.epub
  • file three.epub

By using exec the script gracefully steps aside, letting the epubcheck application handle the output streams and the error code (epubcheck already returns exit codes). I often write scripts where I want to silence STDOUT but not STDERR, or capture STDERR only. It's also future proof in that if they change the output or what error codes they return, it'll just keep working.

comment:5 in reply to: ↑ 4 Changed 4 years ago by oksmith@…

You are correct. I just tested it. The use of exec does simply what I was trying to do by parsing the output. It is a much better solution.

I'm sure that other java programs, such as relames which I mentioned above and used as a template, would similarly benefit from the use of exec and double quotes around the $@. You may wish to investigate.

Thanks for making Macports better.

Replying to jpenney@…:

Replying to oksmith@…:

Is there any way to make better what there was instead of clobbering it? I am happy to try to fix it. Please advise.

You may want to review the script associated with the port relames. It doesn't use exec or have double quotes around the $@ and is what I used as the starting point for this script.

Unless I'm missing something my wrapper and your wrapper achieve the same end result (they run epubcheck, and return an error to the shell when it fails). The only difference being the four points I've called out above don't occur in my wrapper.

Without the double quotes around $@

epubcheck "file one.epub" "filetwo.epub" "file three.epub"

Passes the following arguments:

  • file
  • one.epub
  • filetwo.epub
  • file
  • three.epub

With the double quotes around $@:

  • file one.epub
  • filetwo.epub
  • file three.epub

By using exec the script gracefully steps aside, letting the epubcheck application handle the output streams and the error code (epubcheck already returns exit codes). I often write scripts where I want to silence STDOUT but not STDERR, or capture STDERR only. It's also future proof in that if they change the output or what error codes they return, it'll just keep working.

comment:6 Changed 4 years ago by ryandesign@…

  • Owner changed from macports-tickets@… to ryandesign@…
  • Status changed from new to assigned

comment:7 Changed 4 years ago by ryandesign@…

  • Status changed from assigned to closed
  • Resolution set to fixed

Committed the change in r71990.

Note: See TracTickets for help on using tickets.