Skip to content

Fix: title from filename is now used only as fallback when exporting#10282

Merged
Frenzie merged 1 commit into
koreader:masterfrom
Mochitto:single_export_title
Apr 1, 2023
Merged

Fix: title from filename is now used only as fallback when exporting#10282
Frenzie merged 1 commit into
koreader:masterfrom
Mochitto:single_export_title

Conversation

@Mochitto

@Mochitto Mochitto commented Apr 1, 2023 •
edited by Frenzie
Loading

Copy link
Copy Markdown
Contributor

Solves #10281

The current implementation of the naming system for single imports automatically uses a fallback to avoid illegal characters.

The fix implements a way to check if the title from the metadata does have illegal characters before using the original filename as a fallback.

I think this was the original intent, as signaled from the comment in the function (see in changes).

This allows for more consistency across the export plugin and uses the original filename only when metadata is missing.

This change is Reviewable

@Frenzie

Frenzie commented Apr 1, 2023

Copy link
Copy Markdown
Member

This plugin is very old at its core. Note that a number of years ago I added http://koreader.rocks/doc/modules/util.html#getSafeFilename so you potentially may not need any special logic.

@Mochitto Mochitto force-pushed the single_export_title branch from d89fd0e to 2bcee8c Compare April 1, 2023 15:26
@Mochitto

Mochitto commented Apr 1, 2023

Copy link
Copy Markdown
Contributor Author

That's awesome, thanks @Frenzie :)
I've updated the code to use the util's method and it seems to work great!

@Frenzie Frenzie added the Plugin label Apr 1, 2023
Frenzie
Frenzie approved these changes Apr 1, 2023
View reviewed changes
Comment thread plugins/exporter.koplugin/clip.lua Outdated
@Frenzie Frenzie added this to the 2023.04 milestone Apr 1, 2023
@Mochitto Mochitto force-pushed the single_export_title branch from 2bcee8c to 84f25bc Compare April 1, 2023 21:06
@Mochitto Mochitto force-pushed the single_export_title branch from 84f25bc to 0b1144a Compare April 1, 2023 21:16
@Frenzie Frenzie merged commit d39cc78 into koreader:master Apr 1, 2023
@Frenzie

Frenzie commented Apr 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Btw, certain keywords like close(s) and fix(es) are special in most of the GitHub/GitLab/Gitea type of tools, while solves is not. We may use this to our advantage to distinguish when we'd like auto-close to happen and when we don't.

Hence you'll see us saying something like references #1234 or work toward solving #1234 instead of work toward fixing #1234 for example. (I don't know if we've used solved here before but regardless. ^_^)

@Mochitto Mochitto deleted the single_export_title branch April 1, 2023 21:50
@poire-z

poire-z commented Apr 1, 2023

Copy link
Copy Markdown
Contributor

(Also, you don't need to open both an issue AND a PR that fixes the issue - you can just submit the PR, describing what it fixes.)

@Frenzie

Frenzie commented Apr 1, 2023

Copy link
Copy Markdown
Member

I interpreted that as opening an issue and then realizing it was easy to fix but if that wasn't the case, indeed you can just open a PR. But do try to put most of the same info in the PR of course, to explain what it's good for, how to reproduce, etc. ^_^

@Mochitto

Mochitto commented Apr 1, 2023

Copy link
Copy Markdown
Contributor Author

Thank you all for your help, patience and the useful hints 😄🌸

TranHHoang added a commit to TranHHoang/koreader that referenced this pull request May 26, 2023
@TranHHoang
Merge tag 'v2023.04' into custom
c8c4a28 
KOReader 2023.04 "Solar Panel"

![koreader-2023-04-fs8](https://user-images.githubusercontent.com/202757/234975122-d7739c71-74aa-4cb0-a086-72a4bba70f52.png)

It's been another busy month squashing many bugs. Our Mac users will be happy to hear that I told macOS we've supported HiDPI since long before anyone came up with such terminology (koreader#10341), and that the program can now natively build on M1 devices (koreader#10291).

Solar panel credit: <https://openclipart.org/detail/294030/solar-energy> by gnokii

We'd like to thank all contributors for their efforts. Some highlights since the previous release include:

* Readerzooming: fix use of default settings (koreader#10205) @hius07
* ButtonDialog/ButtonDialogTitle: consistent 'width' handling (koreader#10230) @poire-z
* MovableContainer: add support for anchoring initial position (koreader#10230) @poire-z
* Book map, Page browser: add top left menu (koreader#10230) @poire-z
* Book style tweak: add button with CSS suggestions (koreader#10230) @poire-z
* crengine: fix parsing of multibytes encodings (koreader#10230) @poire-z
* readerstyletweak: update profiles on unregistering in dispatcher (koreader#10247) @hius07
* Filesearcher: add search in book metadata (koreader#10198) @hius07
* Fix: Updated legacy directory, which crashed the program (koreader#10260) @Mochitto
* ReaderLink: allow a forward location stack (koreader#10228) @yparitcher
* BookInfo: add page information (koreader#10255) @hius07
* Center pdf manual zoom mode (koreader#10246) @nairyosangha
* File browser: add Folder Menu (koreader#10275) @hius07
* Calendar view: add options to change start time of days (koreader#10254) @weijiuqiao
* filechooser: fix crash on "unreadable content" (koreader#10283) @hius07
* Sync book statistics: add to dispatcher (koreader#10285) @ptrm
* [plugin] Exporter: use util.getSafeFilename() to remove illegal characters from output filename (koreader#10282) @Mochitto
* readerbookmark: fix writing pdf annotation (koreader#10287) @hius07
* Folder Menu: sign for Home folder (koreader#10288) @hius07
* ListMenu: show mark for books with highlights (koreader#10276) @hius07
* Calendar view's day view: thicker separator at 00:00 (koreader#10289) @poire-z
* PageBrowser: tweak scrolling behaviour at book start/end (koreader#10289) @poire-z
* Make `kodev check` feature complete (koreader#8682) @yparitcher
* macOS: support for M1 building (koreader#10291) @ptrm
* Reader: do not apply font size and spacing out of range (koreader#10295, koreader#10307) @hius07
* File browser: show Folder Menu on long-press on Home icon (koreader#10298) @hius07
* SSH.koplugin: fix cant stop SSH server bug when pid file's stale (koreader#10300) @weijiuqiao
* PM: Optimize task queue handling around standby (koreader#10203) @zwim
* statistic.koplugin: fix today's timeline showing next day when within custom offset (koreader#10299) @weijiuqiao
* ReaderThumbnails: update cached page thumbnail on bookmark note change (koreader#10303) @hius07
* SDL: add multitouch support (koreader#10334) @Frenzie
* SDL: add HiDPI support (koreader#10341) @Frenzie
* BookInfo: fix crash on show cover (koreader#10315) @hius07
* Deal with table.pack corner-cases properly (koreader#10350) @NiLuJe
* Android: add Tagus Gea support (<koreader/android-luajit-launcher#412>) @Alfedi

[Full changelog](koreader/koreader@v2023.03...v2023.04) — [closed milestone issues](https://github.com/koreader/koreader/milestone/63?closed=1)

---

Installation instructions: [Android](https://github.com/koreader/koreader/wiki/Installation-on-Android-devices) • [Cervantes](https://github.com/koreader/koreader/wiki/Installation-on-BQ-devices) • [ChromeOS](https://github.com/koreader/koreader/wiki/Installation-on-Chromebook-devices) • [Kindle](https://github.com/koreader/koreader/wiki/Installation-on-Kindle-devices) • [Kobo](https://github.com/koreader/koreader/wiki/Installation-on-Kobo-devices) • [PocketBook](https://github.com/koreader/koreader/wiki/Installation-on-PocketBook-devices) • [ReMarkable](https://github.com/koreader/koreader/wiki/Installation-on-ReMarkable) • [Desktop Linux](https://github.com/koreader/koreader/wiki/Installation-on-desktop-linux) • [MacOS](https://github.com/koreader/koreader/wiki/Installation-on-MacOS)
0xstillb pushed a commit to 0xstillb/koreader-thai that referenced this pull request May 9, 2026
@Mochitto
[plugin] Exporter: use util.getSafeFilename() to remove illegal chara…
b9e91ac 
…cters from output filename (koreader#10282)

Fixes koreader#10281.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Frenzie Frenzie Frenzie approved these changes
@poire-z poire-z poire-z left review comments

Assignees

No one assigned

Labels

Plugin

Projects

None yet

Milestone

2023.04

Development

Successfully merging this pull request may close these issues.

3 participants

@Mochitto @Frenzie @poire-z