[GUI Plugin] Action Chains

[capink]

I have been having some personal issues lately, which means I will not be able to give much time to development of this — and other — plugins, at least for the next few months.

I am sorry for the people who have been asking questions and not getting any reply for me, hope you understand.

[capink]

Originally Posted by ownedbycats

Question: Is there an option to output the results of a template to a dialog box? A bit more convenient than running a saved template in the tester.

That would be the formulas action.

[capink]

Originally Posted by ownedbycats

Is there a way to validate all the chains at once without running them, or otherwise check for invalid Calibre actions? One of my plugins changed some strings so I'd like to check which chains need fixing.

That is a good idea for a new action. Will look at this as soon as I have the time.

[capink]

Originally Posted by chaley

@capink: could you take a look at the View Manager thread starting here? The discussion is about delays when clicking on VL tabs. Clicking on a tab triggers a chain that uses the View Manager. It seems to call save_state *many* times (see the log in this post).

I think it would be best if you reply on the view manager thread.

Will look at this as soon as I have the time. Sorry for the inconvenience and late reply.

[capink]

Originally Posted by tamaracks

I've been using Action Chains a lot for the purpose of marking an action done in the metadata after doing it. But I can't achieve this with Modify EPUB, at least not with the accuracy I'd wish, because of the way that it works. The jobs run asynchronously, and you have to click on a prompt at the end in order to replace the EPUB file.

I have not used the modify epub plugin before. If it is using jobs you can actually wait for them to finish, by checking the option in the attached screenshot (in Calibre Actions settings).

[ownedbycats]

I was worried about the lack of posts. Hope things get better soon.

[DNSB]

Originally Posted by tamaracks

I've been using Action Chains a lot for the purpose of marking an action done in the metadata after doing it. But I can't achieve this with Modify EPUB, at least not with the accuracy I'd wish, because of the way that it works. The jobs run asynchronously, and you have to click on a prompt at the end in order to replace the EPUB file.

You could go into Preferences and customize the Modify Epub plugin to remove the checkmark from Prompt to save epubs.

[tamaracks]

Originally Posted by DNSB

You could go into Preferences and customize the Modify Epub plugin to remove the checkmark from Prompt to save epubs.

I… never noticed that was an option, ha.

[theducks]

Originally Posted by tamaracks

I… never noticed that was an option, ha.

It was not there in the initial release.
Like many, we tend to set things up our way and just use it from then on.
As a regular (and a forum mod who had to do the updated notes when the original creator was not the updater) , I read a lot of posts, so I saw that features request and addition post.

[un_pogaz]

Hey, a make a module.
The purpose of this module is to update the title and/or author sorting key, like the options in the Bulk Metadata dialog, options that are unavailable via Action Chains (I won't open the huge Bulk Metadata dialog just to check the same 2 options everytime => go on to make a non-interactive module).

I remember you had created a thread to reference different user modules (and other event managers), but I couldn't find it.
If it exists, it would be nice to have an explicit link in the description (so that we can look for it before breaking our heads to do things ourselves, especially if we don't understand anything in code)

Here is the code of the module:
EDIT: code moved into the dedicated thread

[Terisa de morgan]

Originally Posted by un_pogaz

Hey, a make a module.
The purpose of this module is to update the title and/or author sorting key, like the options in the Bulk Metadata dialog, options that are unavailable via Action Chains (I won't open the huge Bulk Metadata dialog just to check the same 2 options everytime=> go on to make a non-interactive module).

Thank you for the module. I guess you were looking for something like this, that it's included in the first post. I don't know if you were talking about something different.

[un_pogaz]

That's it! Thanks.
I was searching with the term "module" (not script), that's why I couldn't find it.

[Terisa de morgan]

Originally Posted by un_pogaz

That's it! Thanks.
I was searching with the term "module" (not script), that's why I couldn't find it.

Thank you for your module, it works fine (tested now after using QualityCheck )

[capink]

Originally Posted by un_pogaz

Hey, a make a module.
The purpose of this module is to update the title and/or author sorting key, like the options in the Bulk Metadata dialog, options that are unavailable via Action Chains (I won't open the huge Bulk Metadata dialog just to check the same 2 options everytime => go on to make a non-interactive module).

I remember you had created a thread to reference different user modules (and other event managers), but I couldn't find it.
If it exists, it would be nice to have an explicit link in the description (so that we can look for it before breaking our heads to do things ourselves, especially if we don't understand anything in code)

Here is the code of the module:
EDIT: code moved into the dedicated thread

Thanks for your contribution. I added a link to your module in the first post of the Action Chains Scripts thread.

One suggestion I have is to make the action support the scopes feature as illustrated in the code below (modifications highlighted in blue)

import os, copy

try:
    from qt.core import (QApplication, Qt, QWidget, QGridLayout, QHBoxLayout, QVBoxLayout,
                            QGroupBox, QCheckBox)
except ImportError:
    from PyQt5.Qt import (QApplication, Qt, QWidget, QGridLayout, QHBoxLayout, QVBoxLayout,
                            QGroupBox, QCheckBox)

from calibre import prints
from calibre.constants import DEBUG

from calibre_plugins.action_chains.actions.base import ChainAction

class BulkSortKeyAction(ChainAction):
    
    # the name of your action
    name = 'Bulk Sort Key'
    
    support_scopes = True
    
    def run(self, gui, settings, chain):
        
        cache = gui.current_db.new_api
        self.ids = chain.scope().get_book_ids()
        #self.ids = gui.current_view().selectionModel().selectedRows()
        if not self.ids or len(self.ids) == 0:
            return
        #self.ids = gui.library_view.get_selected_ids()
        
        if settings.get(KEY.SORT_TITLE, DEFAULT[KEY.SORT_TITLE]):
            from calibre.ebooks.metadata import title_sort
            
            lang_map = cache.all_field_for('languages', self.ids)
            title_map = cache.all_field_for('title', self.ids)
            
            def get_sort(book_id):
                try:
                    lang = lang_map[book_id][0]
                except (KeyError, IndexError, TypeError, AttributeError):
                    lang = DEFAULT_LANG
                return title_sort(title_map[book_id], lang=lang)
            
            cache.set_field('sort', {bid:get_sort(bid) for bid in self.ids})
        
        if settings.get(KEY.SORT_AUTHOR, DEFAULT[KEY.SORT_AUTHOR]):
            author_sort_map = cache.author_sort_strings_for_books(self.ids)
            cache.set_field('author_sort', {book_id: ' & '.join(author_sort_map[book_id]) for book_id in author_sort_map})


    def config_widget(self):
        return ConfigWidget

class KEY:
    SORT_AUTHOR = 'sort_author'
    SORT_TITLE = 'sort_title'

DEFAULT = {}
DEFAULT[KEY.SORT_AUTHOR] = True
DEFAULT[KEY.SORT_TITLE] = True

#set DEFAULT_LANG title sort to the user interface
def get_iso_language():
    from calibre.utils.localization import set_translators, _load_iso639
    iso639 = _load_iso639()
    rslt = 'eng'
    lang = set_translators.lang.split('_')[0].lower()
    if len(lang) == 3:
        if lang in iso639['codes3']:
            rslt = lang
    elif len(lang) == 2:
        rslt = iso639['2to3'].get(lang, rslt)
    elif len(lang) > 3:
        rslt = iso639['name_map'].get(lang, rslt)
    return rslt
DEFAULT_LANG = get_iso_language()

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)
        
        gb_opts = QGroupBox(_("Options"), self)
        l.addWidget(gb_opts)
        l_opts = QVBoxLayout()
        gb_opts.setLayout(l_opts)
        
        self.chk_sort_author = QCheckBox(_("A&utomatically set author sort"))
        self.chk_sort_author.setChecked(DEFAULT[KEY.SORT_AUTHOR])
        self.chk_sort_author.setToolTip(_("This will cause the author sort field to be automatically updated\n"
                                            " based on the authors field for each selected book. Note that if\n"
                                            " you use the control above to set authors in bulk, the author sort\n"
                                            " field is updated anyway, regardless of the value of this checkbox."))
        l_opts.addWidget(self.chk_sort_author)
        
        self.chk_sort_title = QCheckBox(_("Update &title sort"))
        self.chk_sort_title.setChecked(DEFAULT[KEY.SORT_TITLE])
        self.chk_sort_title.setToolTip(_("Update title sort based on the current title. This will be applied only after other changes to title."))
        l_opts.addWidget(self.chk_sort_title)
        
        l.addStretch(1)
        
        self.setMinimumSize(300,100)

    def load_settings(self, settings):
        if not settings:
            settings = copy.deepcopy(DEFAULT)
        
        self.chk_sort_author.setChecked(settings.get(KEY.SORT_AUTHOR, DEFAULT[KEY.SORT_AUTHOR]))
        self.chk_sort_title.setChecked(settings.get(KEY.SORT_TITLE, DEFAULT[KEY.SORT_TITLE]))

    def save_settings(self):
        settings = {}
        settings[KEY.SORT_AUTHOR] = self.chk_sort_author.isChecked()
        settings[KEY.SORT_TITLE] = self.chk_sort_title.isChecked()
        return settings

[un_pogaz]

Oh, I hadn't followed that addition.
Added.