[GUI Plugin] FanFicFare

[ownedbycats]

Originally Posted by JimmXinu

Someone over on github #1073 has asked:

Some basic research found this and this post.

I've proven that I can add a pyqtSignal() to FFF, emit() it after the "proceed with updating your library" dialog and get an Action Chains custom ChainEvent module to fire a chain.

The questions I have are:

1. What events in FFF should have signals that Action Chains can monitor?
2. What information, if any, can or should be passed via the signal(s)?

I was thinking of requesting something similar myself!

I would have it upon adding/updating a new fic, primarily. I have a 'fanfiction cleanup' chain that handles a bit of Calibre metadata processing that can't be done with FFF itself.

[JimmXinu]

Originally Posted by JimmXinu

I've proven that I can add a pyqtSignal() to FFF, emit() it after the "proceed with updating your library" dialog and get an Action Chains custom ChainEvent module to fire a chain.

The questions I have are:

1. What events in FFF should have signals that Action Chains can monitor?
2. What information, if any, can or should be passed via the signal(s)?

More info: There are three times in FFF plugin that self.gui.proceed_question() will be called:

1. Successful update or new download of normal book(s), and (optionally) update of error column for any failures.
2. Successful update or new download of Anthology book. (Update/download aborts if no stories in the anthology succeeded.)
3. Update of error column only when all updates/downloads fail (optionally).

If all of these cases emit the same signal, is that useful? Or is someone going to ask to have them separated immediately?

[bigwoof]

Originally Posted by JimmXinu

[*]Successful update or new download of normal book(s), and (optionally) update of error column for any failures.[*]Successful update or new download of Anthology book. (Update/download aborts if no stories in the anthology succeeded.)[*]Update of error column only when all updates/downloads fail (optionally).

I have a chain that I run only when new books are added (it sets all the tags properly). so something that runs when new books are added would be great.

Thanks!

[ownedbycats]

Originally Posted by JimmXinu

More info: There are three times in FFF plugin that self.gui.proceed_question() will be called:

1. Successful update or new download of normal book(s), and (optionally) update of error column for any failures.
2. Successful update or new download of Anthology book. (Update/download aborts if no stories in the anthology succeeded.)
3. Update of error column only when all updates/downloads fail (optionally).

If all of these cases emit the same signal, is that useful? Or is someone going to ask to have them separated immediately?

I think some separation for new and updated books makes sense.

[JimmXinu]

Originally Posted by bigwoof

I have a chain that I run only when new books are added (it sets all the tags properly). so something that runs when new books are added would be great.

Originally Posted by ownedbycats

I think some separation for new and updated books makes sense.

That's not actually on offer. FFF can and does download new stories and update existing stories at the same time. And errors, all in the same library update.

I assume you'll have to design your Action Chains to find and select the books to operate on based on the metadata written to the library columns by FFF.

I honestly haven't pursued a deep understanding of Action Chains.

FFF has options to mark Success/Fail/Chapter Error books and then 'show' them, but even then, the books are not selected.

[ownedbycats]

In my specific case, I design my chains to be as non-destructive as possible (I've accidentally run it over non-fanfics and gotten zero changes), but it might be a concern for other users.

[JimmXinu]

New Test Version

2024-05-28
- Add download_finished_signal for Action Chains #1073
- New Site: touchfluffytail.org (#1071) thanks dbhmw

The FFF plugin has a signal it will emit after the "proceed with updating your library" dialog.

The code for the Action Chains Module I tested with is:

from calibre_plugins.action_chains.events import ChainEvent

class SearchChanged(ChainEvent):

    # replace with the name of your event
    name = 'FFF done'

    def get_event_signal(self):
        return self.gui.iactions['FanFicFare'].download_finished_signal

All I've done with it is call a chain that printed 'HERE!'.

[johansolo]

First of all, this plugin is wonderfull!!!

And now with my question.

I have downloaded several stories from Scribblehub. (The conversion was perfect I only had to edit personal.ini to modify the css and add indentation.)

But I use KOReader to read epubs and the cover is tiny.

I have seen that cover.xhtml does not have "<link href="stylesheet.css" type="text/css" rel="stylesheet"/>" and "<img src="images/cover.jpg" alt="cover "/>" has no class.

Is there a way to add that code automatically so later I can tinkering with personal.ini to adjust css?

Thanks.

SFW link
https://www.scribblehub.com/series/1...iverse-litrpg/

Screenshots from KOReader and Calibre reader attached. The KOReader screenshot my appear large but the e-reader actually has only 6''.

EDIT: Sorry for my English, is not my native language.

[JimmXinu]

Originally Posted by johansolo

Is there a way to add that code automatically so later I can tinkering with personal.ini to adjust css?

You can customize the HTML generated for cover.xhtml using the cover_content setting. Changing it to include <link href="stylesheet.css" type="text/css" rel="stylesheet"/> should be easy enough.

See CustomOutput wiki page.

Also, be aware that by default FFF reduces the size of large cover images to a 'reasonable' default:

[epub]
# ...
## Resize images down to width, height, preserving aspect ratio.
## Nook size, with margin.
image_max_size: 580, 725

Your example already has a smaller image, so it wouldn't matter in that case.

[ownedbycats]

Originally Posted by JimmXinu

The FFF plugin has a signal it will emit after the "proceed with updating your library" dialog.

The code for the Action Chains Module I tested with is:

from calibre_plugins.action_chains.events import ChainEvent

class SearchChanged(ChainEvent):

    # replace with the name of your event
    name = 'FFF done'

    def get_event_signal(self):
        return self.gui.iactions['FanFicFare'].download_finished_signal

All I've done with it is call a chain that printed 'HERE!'.

If 'mark added/updated books when finished' is enabled, these selection modifier settings will select all updated books.



I created a chain with this selection modifier and then a chain caller to my fanfic cleanup chain. Seems to work as intended.

[JimmXinu]

That reminds me about something that could be helpful.

FFF actually uses different marks for successful, failed and chapter error, as well as for an updated/created anthology:

• fff_success
• fff_failed
• fff_chapter_error
• fff_anthology

Technically, each book is marked with a sequence number like, "fff_success_0001" so that order is also preserved.