Gregoriotex falis when there is a space in filename.

[warej]

At first sorry if I'll write something stupid - I'm not much experienced with TeX and I'm absolutely new to Gregorio.

But from what I've observed, there is a bug with not quoting file names, which leads to compilation errors, when gabc file, tex file, or some directory on path to them contains a space in it's name ("ResHodie Nobis.gabc").

At first I've found the bug (missing quotes) at this line. Fixing them locally was not enough - caused another error, so I decided to leave it to someone, who's more into the project.

Environment info

OS: Windows 7 x64
Gregoriotex version (comment from gregoriotex.tex file):
% [2016/07/05 v4.2.0-rc2 GregorioTeX system.]% PARSE_VERSION_DATE_LTX

Compilation log

This is LuaTeX, Version 0.95.0 (TeX Live 2016/W32TeX) 
 system commands enabled.
("./Res_Hodie nobis.tex"
LaTeX2e <2016/03/31> patch level 2
Babel <3.9r> and hyphenation patterns for 1 language(s) loaded.
(c:/texlive/2016/texmf-dist/tex/latex/base/article.cls
Document Class: article 2014/09/29 v1.4h Standard LaTeX document class
(c:/texlive/2016/texmf-dist/tex/latex/base/size10.clo))
(c:/texlive/2016/texmf-dist/tex/latex/fontspec/fontspec.sty
(c:/texlive/2016/texmf-dist/tex/latex/l3kernel/expl3.sty
(c:/texlive/2016/texmf-dist/tex/latex/l3kernel/expl3-code.tex)
(c:/texlive/2016/texmf-dist/tex/latex/l3kernel/l3pdfmode.def))
(c:/texlive/2016/texmf-dist/tex/latex/l3packages/xparse/xparse.sty)
(c:/texlive/2016/texmf-dist/tex/luatex/luaotfload/luaotfload.sty(using write ca
che: C:/texlive/2016/texmf-var/luatex-cache/generic)(using read cache: C:/texli
ve/2016/texmf-var/luatex-cache/generic C:/Users/virt/.texlive2016/texmf-var/lua
tex-cache/generic)
luaotfload | main : initialization completed in 0.344 seconds)
(c:/texlive/2016/texmf-dist/tex/latex/fontspec/fontspec-luatex.sty
(c:/texlive/2016/texmf-dist/tex/latex/base/fontenc.sty
(c:/texlive/2016/texmf-dist/tex/latex/euenc/eu2enc.def)
(c:/texlive/2016/texmf-dist/tex/latex/euenc/eu2lmr.fd)(load luc: C:/texlive/201
6/texmf-var/luatex-cache/generic/fonts/otl/lmroman10-regular.luc))
(c:/texlive/2016/texmf-dist/tex/xelatex/xunicode/xunicode.sty
(c:/texlive/2016/texmf-dist/tex/latex/tipa/t3enc.def(load luc: C:/texlive/2016/
texmf-var/luatex-cache/generic/fonts/otl/lmromanslant10-regular.luc)(load luc: 
C:/texlive/2016/texmf-var/luatex-cache/generic/fonts/otl/lmroman10-italic.luc)(
load luc: C:/texlive/2016/texmf-var/luatex-cache/generic/fonts/otl/lmroman10-bo
ld.luc) (c:/texlive/2016/texmf-dist/tex/latex/euenc/eu2lmss.fd)(load luc: C:/te
xlive/2016/texmf-var/luatex-cache/generic/fonts/otl/lmsans10-regular.luc))
(c:/texlive/2016/texmf-dist/tex/latex/graphics/graphicx.sty
(c:/texlive/2016/texmf-dist/tex/latex/graphics/keyval.sty)
(c:/texlive/2016/texmf-dist/tex/latex/graphics/graphics.sty
(c:/texlive/2016/texmf-dist/tex/latex/graphics/trig.sty)
(c:/texlive/2016/texmf-dist/tex/latex/graphics-cfg/graphics.cfg)
(c:/texlive/2016/texmf-dist/tex/latex/graphics-def/luatex.def
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/infwarerr.sty)
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/ltxcmds.sty)))))
(c:/texlive/2016/texmf-dist/tex/latex/fontspec/fontspec.cfg)))
(c:/texlive/texmf-local/tex/lualatex/gregoriotex/gregoriotex.sty
(c:/texlive/2016/texmf-dist/tex/latex/xcolor/xcolor.sty
(c:/texlive/2016/texmf-dist/tex/latex/graphics-cfg/color.cfg))
(c:/texlive/2016/texmf-dist/tex/latex/oberdiek/kvoptions.sty
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/kvsetkeys.sty
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/etexcmds.sty
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/ifluatex.sty))))
(c:/texlive/2016/texmf-dist/tex/luatex/luatexbase/luatexbase.sty
(c:/texlive/2016/texmf-dist/tex/luatex/ctablestack/ctablestack.sty))
(c:/texlive/2016/texmf-dist/tex/luatex/luamplib/luamplib.sty)
(c:/texlive/2016/texmf-dist/tex/generic/xstring/xstring.sty
(c:/texlive/2016/texmf-dist/tex/generic/xstring/xstring.tex))
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-main.tex
("Res_Hodie nobis".gaux)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-spaces.tex)(load luc
: C:/texlive/2016/texmf-var/luatex-cache/generic/fonts/otl/greciliae.luc)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-chars.tex)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-signs.tex)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-syllable.tex)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-symbols.tex(load luc
: C:/texlive/2016/texmf-var/luatex-cache/generic/fonts/otl/greextra.luc))
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gsp-default.tex)
(c:/texlive/texmf-local/tex/luatex/gregoriotex/gregoriotex-nabc.tex)))

LaTeX Warning: Unused global option(s):
    [14pt].

No file "Res_Hodie nobis".aux.
(c:/texlive/2016/texmf-dist/tex/latex/tipa/t3cmr.fd)
(c:/texlive/2016/texmf-dist/tex/context/base/mkii/supp-pdf.mkii
[Loading MPS to PDF converter (version 2006.09.02).]
) (c:/texlive/2016/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
(c:/texlive/2016/texmf-dist/tex/latex/oberdiek/grfext.sty
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/kvdefinekeys.sty))
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/pdftexcmds.sty
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/ifpdf.sty)
(c:/texlive/2016/texmf-dist/tex/generic/oberdiek/luatex-loader.sty
(c:/texlive/2016/texmf-dist/scripts/oberdiek/oberdiek.luatex.lua)))
(c:/texlive/2016/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg))ignored arguments: nobis-4_2_0-rc2.glog Res_Hodie nobis.gabc
Usage: gregorio [OPTION]... [-s | INPUT_FILE]
Try 'gregorio --help' for more information.
Proceeding anyway...
error: can't open file nobis-4_2_0-rc2.gtex for reading
c:/texlive/
2016/texmf-dist/tex/latex/base/ltluatex.lua:109: 
Module gregoriotex Error: 
(gregoriotex)             An error occured when compiling the score file
(gregoriotex)             'Res_Hodie nobis.gabc' with gregorio.
(gregoriotex)             Please check your score file. on input line 10

stack traceback:
    [C]: in function 'error'
    c:/texlive/2016/texmf-dist/tex/latex/base/ltluatex.lua:109: in function <c:/te
xlive/2016/texmf-dist/tex/latex/base/ltluatex.lua:108>
    (...tail calls...)
    ...xlive/texmf-local/tex/luatex/gregoriotex/gregoriotex.lua:737: in function '
compile_gabc'
    ...xlive/texmf-local/tex/luatex/gregoriotex/gregoriotex.lua:791: in function '
include_score'
    [\directlua]:1: in main chunk.
\gre@gregorioscore ...allowdeprecated@asboolean )}
                                                  \or \gre@debugmsg {compile...

l.10 \gregorioscore{Res_Hodie nobis}

? 

[eroux]

Interesting, thanks a lot for the report! Here the culprit is more LuaTeX than Gregorio, but the line you indicated clearly could be improved, and we could also replace all filename-unfriendly characters (_, @, space, etc.) with hyphens...

[eschwab]

I thought that we allow _ in filenames since we tack on the version number as 4_2_0-rc3? In any case I have the following list of characters in filenames to swap out with hyphens:

space + & % * ? $ @ : ; & ! #

Am I missing any?

[eroux]

oh, you're right about _. I think your list is enough, it should be quite easy to add a character if we missed one anyway

[henryso]

How about ", ', and `?

[warej]

Well, but if I get it right, the file names are created on the basis of existing .tex or .gabc files, so if previous file exists in the filesystem => it must contain only valid characters.
That's why I'd suggest to only escape spaces|quote whole name to support names with spaces.
Just 0.02€ from my side.

[eroux]

well, why not all these characters also, although I doubt it will be helpful... but who knows...

[warej]

imo quoting each parameter (e.g. $> command -file "some/test/file with spaces and $%") prevents shell from interpreting them.
And having the same name for tex file, gabc file and all other, created automatically is convenient. When you'd replace some signs with - or _, the name will be different (not much, but different). I'm not sure if it won't break some features (e.g. automatic temporary files cleanup).

[henryso]

The problem is with TeX. TeX interprets certain characters in a weird way, doing things like collapsing multiple spaces into one, and there's no perfect way to "quote" the filename, which is why @eroux said the problem is more with LuaTeX than Gregorio per se. The proposition is really a workaround to the weirdness of TeX. It's pretty much not a good idea to have filenames with spaces in them when dealing with TeX.

[eschwab]

The implementation that I am working on does this (for auto or force compile only):

• Takes the filename given in \gregorioscore.
• Separates the path to the file and the root of the filename: Chant/Hymns/Salve Regina.gabc becomes Chant/Hynms/ and Salve Regina
• Cleans up unwanted characters from the root of the filename: Salve Regina becomes Salve-Regina
• Adds the path back to the cleaned up name with the necessary extensions: Chant/Hymns/Salve-Regina.{glog,gtex}
• Then what gets put in the gregorio command is properly quoted for the shell.
• What goes to TeX is a clean "TeX friendly" filename.

The benefit of this is that the original filename is not changed on disk, so no surprises to the user. All the auto-generated files are "TeX friendly" and should still picked up by our garbage collection / old version cleanup.

[eroux]

sounds good to me

[eroux]

@eschwab any news on this?

[eschwab]

Yes, I have a fix ready. Just need to run the tests which I should have time to do tomorrow since the semester is finally over.

[eschwab]

For the changlog entry should this be filed under the Fixed or Added section?

[henryso]

I'd say fixed. Most people would consider the old behavior a bug. Henry

…

On December 27, 2016 3:25:02 PM "Rev. Br. Elijah Schwab, O.Carm" ***@***.***> wrote: For the changlog entry should this be filed under the Fixed or Added section? -- You are receiving this because you commented. Reply to this email directly or view it on GitHub: #1224 (comment)

[rpspringuel]

What's the status here? Can this go into 5.0?

[eschwab]

Fixed by #1344