[GUI Plugin] Action Chains

[capink]

Originally Posted by chaley

@capink: specifying a separator in a for statement and the function list_remove_duplicates(l, sep) are now available in master source.

Thanks for both. I don't seem to know how to use the new for loop. I am trying to modify your previous template to this:

program:
	all_authors = category_items('authors');
	res = '';
	for a in '&' all_authors:
		ratings = from_search('rating', strcat('rating:true and author"=', a, '"'));
		if ratings then
			avg = divide(mean(ratings), 2);
			res = list_union(res, strcat(a, ':', avg), ',')
		fi
	rof;
	res

Obviously I am doing something wrong (and probably silly) here.

[chaley]

Originally Posted by capink

Thanks for both. I don't seem to know how to use the new for loop. I am trying to modify your previous template to this:

The syntax is

	for a in authors separator '&':

I used the keyword 'separator' to remove some ambiguity in the language parser. Note that the 'thing' following the keyword is an arbitrary expression. You can do something like this, admittedly a bit strange:

	for a in authors separator if something then '&' else ',' fi:

[capink]

Originally Posted by chaley

[/CODE]I used the keyword 'separator' to remove some ambiguity in the language parser.

That makes senese. It is now working for me.

program:
	book_ids = from_selection('id');
	all_authors = category_items('authors',book_ids);
	res = '';
	for a in all_authors separator '&':
		ratings = from_search('rating', strcat('rating:true and author:"=', a, '"'));
		if ratings then
			avg = divide(mean(ratings), 2);
			res = list_union(res, strcat(a, ':', avg), ',')
		fi
	rof;
	res

Using all authors without restricting them using from_search() or from_selection() on large libraries is not recommended as it is verrrrrrry slow.

Originally Posted by chaley

Note that the 'thing' following the keyword is an arbitrary expression.

Wow. I will sure come up with a use for that sometime in the future.

[capink]

Also turns out subitems() automatically removes duplicates anyway. So this works fine to get the top level genres:

program:
    genres = category_items('#genre');
    subitems(genres, 0, 1)

[ownedbycats]

Question: In View Manager, I have a view called "On Device." I use a one-action chain and Event Manager to switch to it when the device plug in.

Is it possible to make a condition to make it not run if the view is already set to On Device?

Thank you!

[capink]

You will need a custom template function to check for that. Taking a quick look at the view manager code, this can be easily done using this template:

from calibre_plugins.action_chains.templates import TemplateFunction

class ViewManagerLastVIew(TemplateFunction):

    name = 'view_manager_last_view'
    arg_count = 0

    def evaluate(self, formatter, kwargs, mi, locals):
        import calibre_plugins.view_manager.config as cfg
        gui = self.plugin_action.gui
        library_config = cfg.get_library_config(gui.current_db)
        return library_config.get(cfg.KEY_LAST_VIEW, '')

Copy/Paste the above code into the module manager. Now you can use this function in a condition as follows:

Template        : program: view_manager_last_view()
Datatype        : text
Comparison      : !=
Condition Value : On Device

However, your request uncovers another problem. When the conditions are not met, an error dialog will pop-up. This might not be suitable for events. I can turn this off for events and let it fail silently, or add an option in the conditions dialog to make the error dialog optional. Will think about it to see which of these two options is more suitable, and then add it later.

In the mean time, you can test the above to see whether it works.

[ownedbycats]

A while ago I did some experimenting and found that adding the condition to the actions rather than the chain itself doesn't result in error. This is clumsy though, and doesn't work if you want to use other conditions for the specific actions.

But it works well enough for a single-action chain, and the code above worked.

[Venia Legendi]

Hello, what a great plugin, I have lots of very convenient chains.

Is it possible to call the calibre action "Edit metadata in bulk" with preset to "Change cover: Set from e-book files" and directly execute this? I think this should work with a module, but I have no idea how to start here. Any hints are highly appreciated, thanks.

[capink]

You can try the following code (copy/past into the module editor):

from calibre.ebooks.metadata.meta import metadata_from_formats
from calibre_plugins.action_chains.actions.base import ChainAction

class CoverFromBook(ChainAction):

    name = 'Cover from book'
    support_scopes = True

    def run(self, gui, settings, chain):
        db = gui.current_db.new_api
        book_ids = chain.scope().get_book_ids()
        for book_id in book_ids:
            fmts = db.formats(book_id, verify_formats=False)
            paths = list(filter(None, [db.format_abspath(book_id, fmt) for fmt in fmts]))
            mi = metadata_from_formats(paths)
            if mi.cover_data:
                cdata = mi.cover_data[-1]
            if cdata is not None:
                db.set_cover({book_id: cdata})

[Venia Legendi]

Originally Posted by capink

You can try the following code (copy/past into the module editor):

Wow, that works like charm, you made my day, thank you.

[ownedbycats]

Did program: connected_device_name('main') get changed? This condition always shows up as true even with nothing plugged in:



EDIT: I just noticed the addition of the new option. Sorry.

[capink]

Some conditions slowed down the menu loading (e.g selection_count() when thousands of books are selected), so I made disabling menu entries based on conditions optional in version 0.6.5.

[compurandom]

Originally Posted by capink

Some conditions slowed down the menu loading (e.g selection_count() when thousands of books are selected), so I made disabling menu entries based on conditions optional in version 0.6.5.

Would it be faster / possible to have a function that returned selection count as 0, 1, or many? That might be a better fit for determining if a menu entry should be enabled or not.

[capink]

You can already do that by using the selection_count() function which returns the exact number of selected books, and combine that with the comparison operators (= | != | > |<) in the condition evaluator dialog. (see attached screenshot)

Having a function that returns the selection count as 0, 1, or many will not improve performance as it still needs to make the same call that takes time when a lot of books are selected:

len(gui.current_view().selectionModel().selectedRows())

[ownedbycats]

I have this code:

      {
        "active": true,
        "chain_settings": {
          "chain_links": [
            {
              "action_name": "Single Field Edit",
              "action_settings": {
                "col_name": "#kobocoll",
                "template": "program:\n\tg = field('#genres');\n\tk = field('#kobocoll');\n\tif list_contains(g, ',', '^Fanfiction$', '1', '') then\n\t\tk = list_union(k, 'Fanfiction', ',')\n\tfi;\n\tif list_contains(g, ',', '^Cozy Mystery$', '1', '') then\n\t\tk = list_union(k, 'Cozy Mysteries', ',')\n\tfi;\n\tif list_contains(g, ',', '^Horses$', '1', '') then\n\t\tk = list_union(k, 'Horses', ',')\n\tfi;\n\tif list_contains(g, ',', '^(Fantasy|Science Fiction)$', '1', '') then\n\t\tk = list_union(k, 'Fantasy & Sci-Fi', ',')\n\tfi;\n\tk",
                "value_type": "template"
              },
              "comment": "Update #kobocoll column"
            },
            {
              "action_name": "Calibre Actions",
              "action_settings": {
                "disable_busy_cursor": false,
                "selection": [
                  {
                    "display": "Send to device",
                    "path": [
                      "Send To Device"
                    ]
                  }
                ]
              },
              "comment": "Send to device if device is connected",
              "condition_settings": {
                "cmp_type": "=",
                "datatype": "text",
                "template": "program: connected_device_name('main')",
                "value": "Kobo Aura HD"
              }
            },
            {
              "action_name": "Calibre Actions",
              "action_settings": {
                "disable_busy_cursor": false,
                "selection": [
                  {
                    "display": "Add to list: Send to Device",
                    "path": [
                      "Reading List",
                      "Add to list",
                      "Add to list: Send to Device"
                    ],
                    "paths_text": "Add to list|Add to list: Send to Device"
                  }
                ]
              },
              "comment": "Add to \"Send to Device\" list if device is not connected",
              "condition_settings": {
                "cmp_type": "=",
                "datatype": "text",
                "template": "program: connected_device_name('main')",
                "value": ""
              }
            },
            {
              "action_name": "Single Field Edit",
              "action_settings": {
                "col_name": "#onkobo",
                "template": "program:\n\tif and(\tcheck_yes_no('#onkobo', '', '', 1),) then \t'False' \n\telse 'True'\n\tfi",
                "value_type": "template"
              },
              "comment": "Set #onkobo column"
            }
          ],
          "refresh_gui": true
        },
        "image": "sync.png",
        "menuText": "Send to Device",
        "subMenu": ""
      },

However i noticed a slight glitch with it. When I eject my Kobo, sometimes the conditional doesn't update (the template value in the evaluator confirms this) and it tries to do the wrong actions (and predictably fail) the next time I run the chain. When this happens my two greyed-out chains are also available.

Any idea why?