Action Chains Resources

[ownedbycats]

Here is a chain that uses templates to convert url/uri identifiers from three public-domain book websites (Project Gutenberg, Standard Ebooks, and Global Grey) to site-specific ones. Mostly because it looks nicer in book details.

Before installing this, go to Preferences > Look & Feel > Book Details > Create rules to convert identifiers into link. Then add these three rules:

Project Gutenberg
Key: gutenberg
Template: https://www.gutenberg.org/ebooks/{id}

Standard Ebooks
Key: standard
Template: https://standardebooks.org/ebooks/{id}

Global Grey
Key: gg
Template: https://www.globalgreyebooks.com/{id}-ebook.html

Note that it uses the publisher field to identify whether to convert the IDs.

[Comfy.n]

Originally Posted by ownedbycats

Here is a chain that uses templates to convert url/uri identifiers from three public-domain book websites (Project Gutenberg, Standard Ebooks, and Global Grey) to site-specific ones. Mostly because it looks nicer in book details.

yes it looks neat and works fine, thank you.

[ownedbycats]

For FanFicFare users, this chain I made to easily add a new StoryURL section. First it copies this to clipboard:

## Test Author - Test Title
[https://www.fanfiction.net/s/123456/1/]

Then it opens personal.ini to paste it in.

[tkshorty]

This module was not created by me but by the creator of FanFicFare. Just wanted to share it
https://www.mobileread.com/forums/sh...postcount=9637
The FFF plugin has a signal it will emit after the "proceed with updating your library" dialog.

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

[capink]

Originally Posted by tkshorty

This module was not created by me but by the creator of FanFicFare. Just wanted to share it
https://www.mobileread.com/forums/sh...postcount=9637
The FFF plugin has a signal it will emit after the "proceed with updating your library" dialog.

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

That's interesting. I added it to the index in the first post. Although this can be automatically available for users of FFF plugin, if this code is copied into a file called action_chains.py in the root folder of the FFF plugin.

[tkshorty]

Originally Posted by capink

That's interesting. I added it to the index in the first post. Although this can be automatically available for users of FFF plugin, if this code is copied into a file called action_chains.py in the root folder of the FFF plugin.

cool. I tried it and it works fine.

I asked JimmXinu to add such a file to his plugin for future updates

[correoparaappzz]

Originally Posted by capink

#!/usr/bin/env python
# ~*~ coding: utf-8 ~*~

__license__ = 'GPL v3'
__copyright__ = '2021, Ahmed Zaki <azaki00.dev@gmail.com>'
__docformat__ = 'restructuredtext en'

from functools import partial

from qt.core import (QApplication, Qt, QTimer, QWidget, QVBoxLayout, QCheckBox, pyqtSignal)

from calibre import prints
from calibre.constants import DEBUG
from calibre.db.listeners import EventType
from calibre.utils.date import now

from calibre_plugins.action_chains.events.base import ChainEvent
import calibre_plugins.action_chains.config as cfg

try:
    load_translations()
except NameError:
    prints("ActionChains::events/books_added.py - exception when loading translations")

class ConfigWidget(QWidget):
    def __init__(self, plugin_action):
        QWidget.__init__(self)
        self.plugin_action = plugin_action
        self.gui = plugin_action.gui
        self.db = self.gui.current_db
        self._init_controls()

    def _init_controls(self):

        l = self.l = QVBoxLayout()
        self.setLayout(l)

        self.select_chk = QCheckBox(_('Select newly added books'))
        self.select_chk.setChecked(True)
        l.addWidget(self.select_chk)
        
        l.addStretch(1)

        self.setMinimumSize(300,300)

    def load_settings(self, settings):
        if settings:
            self.select_chk.setChecked(settings['select_books'])

    def save_settings(self):
        settings = {}
        settings['select_books'] = self.select_chk.isChecked()
        return settings

class BooksAddedEvent(ChainEvent):

    name = 'Books Added'
    books_added = pyqtSignal(object)
    timer_interval = 30

    def __init__(self, plugin_action):
        ChainEvent.__init__(self, plugin_action)
        self.db = plugin_action.gui.current_db
        self.gui.add_db_listener(self.process_event_in_db)
        self.book_created_cache = set()
        self.book_created_cache_last_updated = None
        QTimer.singleShot(self.timer_interval * 1000, self._on_timeout)

    def process_event_in_db(self, db, event_type, event_data):
        if not db.library_id == self.gui.current_db.library_id:
            return
        if event_type == EventType.book_created:
            book_id = event_data[0]
            self.add_to_book_created_cache(book_id, now())
        elif event_type == EventType.books_removed:
            removed_book_ids = event_data[0]
            self.book_created_cache = self.book_created_cache.difference(set(removed_book_ids))
        
    def _on_timeout(self):
        # Make sure no modal widget dialog is present (e.g. add books duplicate dialog). Otherwise, postpone
        if QApplication.instance().activeModalWidget():
            pass
        # postpone event if another action chains is running
        elif self.plugin_action.chainStack:
            pass
        else:
            utime = self.book_created_cache_last_updated
            if utime:
                elapsed = now() - utime
                if elapsed.seconds > 20:
                    QTimer.singleShot(0, partial(self.books_added.emit, self.book_created_cache))
                    QTimer.singleShot(0, self.clean_book_created_cache)
        
        # keep the timer runnig
        QTimer.singleShot(self.timer_interval * 1000, self._on_timeout) 

    def add_to_book_created_cache(self, book_id, timestamp):
        self.book_created_cache.add(book_id)
        self.book_created_cache_last_updated = timestamp

    def clean_book_created_cache(self):
        self.book_created_cache = set()
        self.book_created_cache_last_updated = None
    
    def get_event_signal(self):
        return self.books_added

    def config_widget(self):
        return ConfigWidget

    def pre_chains_event_actions(self, event_args, event_opts):
        if event_opts.get('select_books', False):
            book_ids = event_args[0]
            self.gui.library_view.select_rows(book_ids)
            if DEBUG:
                prints('Action Chains: Books Added Event: Selecting newly added book_ids: {}')

After adding this you should have an event called "Books Added" in the dropdown list of the Event Manager. You can attach whatever chains you want to that event.

Notes:

• The event will automatically select all added books, so that any chains attached to the event can act on them. If whatever reason you don't want this, you can turn it off (Event Manager > Books Added > Event options)
• There is a lag of several seconds before the event is activated. This is done to ensure calibre's adder (and auto-adder) has added all the books.
• You can attach one or more chain(s) to the event: Event Manager > Add Event > Books Added > click settings button next to the event.
• Whenever you change the name of a chain attached to an event, you will need to open the Event Manager to re-attach it.

is there a way to reduse the time?

[webysther]

Originally Posted by correoparaappzz

is there a way to reduse the time?

Hi, for the event 'Books Added' still works in the latest version of calibre? I get this error:

calibre, version 7.24.0
ERROR: Unhandled exception: <b>KeyError</b>:'select_books'

calibre 7.24  embedded-python: True
Linux-4.4.302+-x86_64-with-glibc2.39 Linux ('64bit', 'ELF')
('Linux', '4.4.302+', '#72806 SMP Thu Sep 5 13:45:50 CST 2024')
Python 3.11.5
Interface language: None
EXE path: /opt/calibre/bin/calibre
Successfully initialized third party plugins: DeACSM (0, 0, 16) && Gather KFX-ZIP (from KFX Input) (2, 19, 0) && DeDRM (10, 0, 9) && Package KFX (from KFX Input) (2, 19, 0) && Action Chains (1, 20, 8) && Count Pages (1, 13, 6) && Embed Comic Metadata (1, 6, 6) && Find Duplicates (1, 10, 9) && KFX metadata reader (from KFX Input) (2, 19, 0) && From KFX (2, 19, 0) && KFX Input (2, 19, 0) && Set KFX metadata (from KFX Output) (2, 13, 0) && KFX Output (2, 13, 0) && Obok DeDRM (10, 0, 9)
Traceback (most recent call last):
  File "calibre_plugins.action_chains.gui.events_dialogs", line 280, in _on_event_opts_button_clicked
    d.load_settings(self.event_opts)
  File "calibre_plugins.action_chains.gui.events_dialogs", line 127, in load_settings
    self.widget.load_settings(settings)
  File "Books Added", line 48, in load_settings
KeyError: 'select_books'

Actions works fine, I have created a few actions to title and subtitle of standard ebooks, but for automatic add books this event don't works, if anyone point me to docs for the calibre 7 about the events and how control the selection on gui, maybe I can fix this.

[capink]

Originally Posted by webysther

Actions works fine, I have created a few actions to title and subtitle of standard ebooks, but for automatic add books this event don't works, if anyone point me to docs for the calibre 7 about the events and how control the selection on gui, maybe I can fix this.

I updated the code of the action in post 16 to fix this error. Give a try and report back here.

[capink]

Action to duplicate a book, originally written by bluefish2020

import os

from calibre_plugins.action_chains.actions.base import ChainAction

class DuplicateBookAction(ChainAction):
    name = 'Duplicate Book'
    support_scopes = True

    # code adapted from calibre/gui2/actions/add.py:add_empty()
    def run(self, gui, settings, chain):
        db = gui.current_db
        selected_books = chain.scope().get_book_ids()
        
        ids, orig_fmts = [], []
        for book_id in selected_books:
            metadata = db.get_metadata(book_id, index_is_id=True, get_cover=True, cover_as_data=True)
            orig_fmts = tuple(db.new_api.format(book_id, fmt, as_path=True) for fmt in db.new_api.formats(book_id))
            new_book_id = db.import_book(metadata, orig_fmts)
            ids.append(new_book_id)
            
        self.refresh_gui(gui, len(selected_books))
        # entirely optional: select and mark the copies
        if ids:
            ids.reverse()
            gui.library_view.select_rows(ids)
            db.set_marked_ids({id: 'duplicate' for id in ids})
        # clean up temp files created by new_api.format()
        for path in orig_fmts:
            os.remove(path)                        

    def refresh_gui(self, gui, num):
        gui.library_view.model().books_added(num)
        gui.refresh_cover_browser()
        gui.tags_view.recount()

[patjack]

Added an event to occur at the same time everyday, may add days of the week selections as well later.

from calibre_plugins.action_chains.events import ChainEvent
from qt.core import QApplication, Qt, QWidget, QVBoxLayout, QGroupBox, QLabel, QTimeEdit, QTimer, QTime, pyqtSignal
from calibre.utils.date import now
from calibre import prints
from calibre.constants import DEBUG
from datetime import datetime

class ConfigWidget(QWidget):
    def __init__(self, plugin_action):
        QWidget.__init__(self)
        self.plugin_action = plugin_action
        self.gui = plugin_action.gui
        self.db = self.gui.current_db
        self._init_controls()
    def _init_controls(self):
        l = self.l = QVBoxLayout()
        self.setLayout(l)
        
        time_edit_box = QGroupBox('Trigger time (24h format):')
        time_edit_box_l = QVBoxLayout()
        time_edit_box.setLayout(time_edit_box_l)
        l.addWidget(time_edit_box)
        self.time_edit = QTimeEdit()
        self.time_edit.setDisplayFormat('HH:mm')
        self.time_edit.setTime(QTime.fromString('08:00', 'HH:mm'))
        time_edit_box_l.addWidget(self.time_edit)
        
        l.addStretch(1)
        
        self.setMinimumSize(300,300)

    def load_settings(self, settings):
        if settings:
            self.time_edit.setTime(QTime.fromString(settings['trigger_time'], 'HH:mm'))


    def save_settings(self):
        settings = {}
        settings['trigger_time'] = self.time_edit.time().toString('HH:mm')
        self.plugin_action.plugin_restart_required.emit('events_dialog', 'Timer event interval')
        return settings

class TimeOfDayEvent(ChainEvent):
    name = 'Time of Day'
    time_triggered = pyqtSignal()

    def __init__(self, plugin_action):
        ChainEvent.__init__(self, plugin_action)
        self.last_triggered_date = None
        QTimer.singleShot(5*1000, self.check_time)

    def get_target_time(self):
        event_options = self.get_options()
        target_time = event_options.get('trigger_time','08:00')
        return target_time

    def get_event_signal(self):
        return self.time_triggered
    
    def config_widget(self):
        return ConfigWidget

    def check_time(self):    
        now_time = QTime.currentTime()
        today_str = now().date().isoformat()
        if datetime.now().strftime('%H:%M') + '' == self.get_target_time():
            if self.last_triggered_date != today_str:
                if not self.plugin_action.chainStack:
                    QTimer.singleShot(0, self.time_triggered.emit)
                    self.last_triggered_date = today_str

[dunhill]

Hi everyone, I have a question.
I'd like to have Calibre automatically open a small list of books in the e-book viewer when I open it. I've created a virtual library with the six books I want it to open. But I can't automate the next step.
Could you help me with an action that opens six books from a virtual library?

[theducks]

Originally Posted by dunhill

Hi everyone, I have a question.
I'd like to have Calibre automatically open a small list of books in the e-book viewer when I open it. I've created a virtual library with the six books I want it to open. But I can't automate the next step.
Could you help me with an action that opens six books from a virtual library?

Preferences: Behavior: (right side) Virtual Library to apply...

Oh this post was in Action chains

[dunhill]

Originally Posted by theducks

Preferences: Behavior: (right side) Virtual Library to apply...

Oh this post was in Action chains

I didn't imagine something like this would be planned, and it was making my life complicated. Thanks so much. I'll try it now.

[theducks]

Originally Posted by dunhill

I didn't imagine something like this would be planned, and it was making my life complicated. Thanks so much. I'll try it now.

Be prepared to keep being Amazed as to all the things Kovid and his helpers have included in Calibre

IIRC this one has been there since VL's was first added.