fix: decode the name of the backup file

[valtterikantanen]

what is this pull request about?

This pull request features a fix to a bug that occurs when working with LaTeX files whose names include characters with diacritics (e.g. å, ä, and ö that are used in Finnish and Swedish among many other languages).

does this relate to an existing issue?

No.

does this change any existing behaviour?

Yes.

what does this add?

When calling latexindent.pl with the -w flag, latexindent.pl will make a copy of the original file before overwriting it. However, if the file path contains characters with diacritics, latexindent.pl will not work, instead it prints an error message. For example, create a directory called äö and add a LaTeX file called äö.tex inside it. äö.tex can have the following content:

\begin{document}
Some text...
    \end{document}

When calling latexindent.pl -w äö/äö.tex, the following error message will be printed:

FATAL Could not write to backup file äö/äö.bak0. Please check permissions.
      Exiting, no indentation done.

With the fix that I made, the problem goes away and the output is how it's supposed to be:

\begin{document}
Some text...
\end{document}

how do I test this?

Please consider the example given above.

anything else?

Please notice that I have never written any Perl code before this. Nevertheless this seems to be working. Documentation about the decode method can be found here.

[cmhughes]

Thanks very much, that's really helpful. I've merged this and it'll be part of the next release.

[cmhughes]

For reference, see also ee82ad0

[valtterikantanen]

Thank you for your quick response! I updated latexindent to v3.20.5 and tried the example on my previous comment. I noticed that there's still something wrong. After calling latexindent.pl -w äö/äö.tex, latexindent prints an error message but a different one than before:

FATAL Could not find directory ��
      Exiting, no indentation done.

If I cd into äö and try latexindent.pl -w äö.tex, everything goes well:

\begin{document}
Some text...
\end{document}

Does the same error occur on your computer?

EDIT: The same error occurs without the -w switch.

EDIT 2: It seems that latexindent works correctly if I comment out this line:

latexindent.pl/LatexIndent/LogFile.pm

Line 133 in 55307eb

${$self}{cruftDirectory} = decode( "utf-8", ${$self}{cruftDirectory} );

[cmhughes]

Thanks for the follow-up.

I can confirm the behaviour you describe.

As of 1b859d3 I have updated develop branch which I hope fixes this. I have done the following tests

latexindent.pl -s -w äö.tex -g diacritics0.log
latexindent.pl -s -w äö/äö.tex 
latexindent.pl -s äö.tex -l äö.yaml -g diacritics.log
latexindent.pl -s äö.tex -l äö.yaml -g diacritics1.log -o=+-mod1
latexindent.pl -s äö.tex -l äö.yaml -g diacritics2.log -o=+-mod2 -c ./äö
latexindent.pl -s äö.tex -l äö.yaml -g äö-log-file.log -o=+-mod3 -c ./äö
latexindent.pl -s äö.tex -l äö.yaml -g diacritics3.log -o=+-äö1

Can you get the develop branch and test at your end?

[valtterikantanen]

I ran the tests and everything is working now.

[cmhughes]

Thanks I'll get this released soon.

[cmhughes]

https://github.com/cmhughes/latexindent.pl/releases