Skip to content

Fix for issue: Sanitization of generated filenames (remove LaTeX commands) #12188 #12802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 25, 2025
Merged

Fix for issue: Sanitization of generated filenames (remove LaTeX commands) #12188 #12802

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57112f2
Fix #12188: Remove LaTeX commands from generated filenames
wanling0000 Mar 23, 2025
d3e99a5
Change in described
wanling0000 Mar 23, 2025
7330a1e
Change in CHANGELOG.md: describe LaTeX filename cleanup (Closes #12188)
wanling0000 Mar 23, 2025
7536793
Fix test case style and markdown format in CHANGELOG
wanling0000 Mar 23, 2025
17a2fe3
Refactor: use class constant and method chaining
wanling0000 Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
- We fixed an issue where an exception would occur when running abbreviate journals for multiple entries. [#12634](https://github.com/JabRef/jabref/issues/12634)
- We fixed an issue where JabRef displayed dropdown triangle in wrong place in "Search for unlinked local files" dialog [#12713](https://github.com/JabRef/jabref/issues/12713)
- We fixed an issue where JabRef would not open if an invalid external journal abbreviation path was encountered. [#12776](https://github.com/JabRef/jabref/issues/12776)
- We fixed a bug where LaTeX commands were not removed from filenames generated using the `[bibtexkey] - [fulltitle]` pattern. [#12188](https://github.com/JabRef/jabref/issues/12188)

### Removed

Expand Down
6 changes: 5 additions & 1 deletion src/main/java/org/jabref/logic/util/io/FileUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

import org.jabref.logic.FilePreferences;
import org.jabref.logic.citationkeypattern.BracketedPattern;
import org.jabref.logic.layout.format.RemoveLatexCommandsFormatter;
import org.jabref.logic.util.StandardFileType;
import org.jabref.model.database.BibDatabase;
import org.jabref.model.database.BibDatabaseContext;
Expand Down Expand Up @@ -329,9 +330,12 @@ public static String createFileNameFromPattern(BibDatabase database, BibEntry en
if (targetName.isEmpty()) {
targetName = entry.getCitationKey().orElse("default");
}

// Remove LaTeX commands (e.g., \mkbibquote{}) from expanded fields before cleaning filename
// See: https://github.com/JabRef/jabref/issues/12188
Comment on lines +335 to +336
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment should be in JavaDoc format since it explains the method's behavior. Regular comments should not be used for method documentation according to best practices.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is inside a method, so I kept it as a regular inline one

targetName = new RemoveLatexCommandsFormatter().format(targetName);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make this a class constant (private static final ...). This saves some time when executing this (we use this pattern in other places in JabRef)

Keep the empty line before.

// Removes illegal characters from filename
targetName = FileNameCleaner.cleanFileName(targetName);

return targetName;
}

Expand Down
11 changes: 11 additions & 0 deletions src/test/java/org/jabref/logic/util/io/FileUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,17 @@ void getLinkedFileNameByYearAuthorFirstpage() {
assertEquals("1868_Kitsune_567", FileUtil.createFileNameFromPattern(null, entry, fileNamePattern));
}

@Test
void getLinkedFileNameRemovesLatexCommands() {
String pattern = "[citationkey] - [fulltitle]";
BibEntry entry = new BibEntry();
entry.setCitationKey("BrayBuildingCommunity");
entry.setField(StandardField.TITLE, "Building \\mkbibquote{Community}");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chain - .withCitationKey and .withField.

String expected = "BrayBuildingCommunity - Building Community";
String result = FileUtil.createFileNameFromPattern(null, entry, pattern);
assertEquals(expected, result);
}

@Test
void getFileExtensionSimpleFile() {
assertEquals("pdf", FileUtil.getFileExtension(Path.of("test.pdf")).get());
Expand Down