[GUI Plugin] Action Chains

[capink]

Try this:

id_path_map = {}
for row in rows:
    book_id = self.gui.library_view.model().id(row)
    id_path_map[book_id] = dpath
self.gui.current_db.new_api.set_field('#custompath', id_path_map)

[Dzib]

Works fine, thanks
Another question, not related : if I make a new chain with open with action, how to use the serie in the template but only if it's not null ?
I've tried with an if else statement but it's not working

[capink]

Originally Posted by Dzib

Works fine, thanks

Append the following code under the run() method:

        col_name = '#custompath'
        db = gui.current_db
        id_path_map = {}
        for book_id in chain.scope().get_book_ids():
            fmt_paths = []
            fname = chain.evaluate_template(opts.template, book_id)
            if single_dir:
                fname = os.path.basename(fname)
            if opts.formats == 'all':
                formats = db.formats(book_id, index_is_id=True)
            else:
                formats = settings['formats']
            for fmt in [fmt.strip().lower() for fmt in formats.split(',')]:
                fmt_paths.append(os.path.join(path, f'{fname}.{fmt.lower()}'))
            id_path_map[book_id] = ','.join(fmt_paths)
        db.new_api.set_field(col_name, id_path_map)

Note: If you save more than one format per book, the above code will add them all to the custom column as comma separated list.

Originally Posted by Dzib

Another question, not related : if I make a new chain with open with action, how to use the serie in the template but only if it's not null ?
I've tried with an if else statement but it's not working

Consult the template language manual under the "Conditionally including text" section.

[capink]

Originally Posted by capink

Append the following code under the run() method

Another way to do this without having to hard code the custom column name, is to append this instead to the run() method:

        db = gui.current_db
        for book_id in chain.scope().get_book_ids():
            fmt_paths = []
            fname = chain.evaluate_template(opts.template, book_id)
            if single_dir:
                fname = os.path.basename(fname)
            if opts.formats == 'all':
                formats = db.formats(book_id, index_is_id=True)
            else:
                formats = settings['formats']
            for fmt in [fmt.strip().lower() for fmt in formats.split(',')]:
                fmt_paths.append(os.path.join(path, f'{fname}.{fmt.lower()}'))
            chain.set_book_var(book_id, 'save_to_disk_path', ','.join(fmt_paths))

Now, in your chain, add a second "Single Field Edit", choose the custom column from the dropdown menu and add the following template:

program:
	book_vars('save_to_disk_path')

[chaley]

Originally Posted by capink

Another way to do this without having to hard code the custom column name, is to append this instead to the run() method:

IIRC this can produce a value that isn't the "real" path generated by Save to Disk. The Save to Disk function will truncate segments of the path so the path length fits within the 250 character limit calibre enforces on the path length. The resulting path is also "sanitized" to remove any characters that shouldn't be in paths, for example colons, control characters, question marks, asterisks, etc.

The only way I know to get the "real" path is to include the calibre ID somewhere in the path, walk the resulting book folders to generate the full path to a book, then use the ID to insert that path into the book's metadata.

[capink]

Originally Posted by chaley

IIRC this can produce a value that isn't the "real" path generated by Save to Disk. The Save to Disk function will truncate segments of the path so the path length fits within the 250 character limit calibre enforces on the path length. The resulting path is also "sanitized" to remove any characters that shouldn't be in paths, for example colons, control characters, question marks, asterisks, etc.

The only way I know to get the "real" path is to include the calibre ID somewhere in the path, walk the resulting book folders to generate the full path to a book, then use the ID to insert that path into the book's metadata.

Ahhh. I totally missed that. Using the id would work so long as the user includes it in the template in a pre-defined format that allows for parsing. Also the default template does not include the id.

One other way is to follow calibre's own way of sanitizing and shortening paths. Something like this:

        from calibre.library.save_to_disk import sanitize_args, get_path_components
        db = gui.current_db
        for book_id in chain.scope().get_book_ids():
            fmt_paths = []
            root, opts, length = sanitize_args(path, opts)
            mi = db.get_metadata(book_id, index_is_id=True)
            components = get_path_components(opts, mi, book_id, length)
            extensionless_path = os.path.sep.join(components)
            if single_dir:
                extensionless_path = components[-1]
            if opts.formats == 'all':
                formats = db.formats(book_id, index_is_id=True)
            else:
                formats = settings['formats']
            for fmt in [fmt.strip().lower() for fmt in formats.split(',')]:
                fmt_paths.append(os.path.join(root, f'{extensionless_path}.{fmt.lower()}'))
            chain.set_book_vars(book_id, 'save_to_disk_path', ','.join(fmt_paths))

[Dzib]

Woaw, your code works perfect !
Many thanks to you & to chaley

[lalf]

Hello, I am trying to run 2 different types of Add Book actions, where one handles the metadata with the name, and the other with the content of the ebook (i go more in details here) https://www.mobileread.com/forums/sh...15&postcount=1

I tried the Add Book action but it seems to not have the metadata handling part that Calibre has. Is it possible adding it? It could fix the issue I have currently as I need to have metadata handled differently for 2 types of books (2 different folders).

Thanks for your work !

[ownedbycats]

Is there an action that can select the first item in the book list? This would be for use after refreshing the book sort, which depending on book can sometimes send me a few hundred books down.

[capink]

Originally Posted by lalf

Hello, I am trying to run 2 different types of Add Book actions, where one handles the metadata with the name, and the other with the content of the ebook (i go more in details here) https://www.mobileread.com/forums/sh...15&postcount=1

I tried the Add Book action but it seems to not have the metadata handling part that Calibre has. Is it possible adding it? It could fix the issue I have currently as I need to have metadata handled differently for 2 types of books (2 different folders).

Thanks for your work !

The add action calls calibre Adder, which follows the settings in calibre to decided whether to read metadata from book or from filename.

What you can do, is use the GetFileName plugin, which stores the filename in custom column. With this you can use Action Chains to add the book and apply the metadata from the GetFileName column. Action allows you to use Calibre Template language to write data to column using regex.

[capink]

Originally Posted by ownedbycats

Is there an action that can select the first item in the book list? This would be for use after refreshing the book sort, which depending on book can sometimes send me a few hundred books down.

Selection Modifier.

[correoparaappzz]

Hi, i don't know what i'm doing.

i use "Event Manager" to show me the books i'm currently reading every time i change library, all good

But now I want it to show me my TBR in case I don't have books in Currently Reading, and i don't know how

[capink]

To be able to offer specific help, I need more details regarding how you keep track of currently reading and TBR. I need the custom column names and the datatype of these custom columns.

[correoparaappzz]

Originally Posted by capink

To be able to offer specific help, I need more details regarding how you keep track of currently reading and TBR. I need the custom column names and the datatype of these custom columns.

this is what i have

[capink]

There are two solutions:

1. Create a New chain
   
   Create a new chain with a single action: "Search Using Templates", using the following Templates:
   
   

   program:
       if from_search('id', '#reading_status:"=Currently Reading"') then
           '#reading_status:"=Currently Reading"'
       else
           '#reading_status:"=TBR"'
       fi

   Note: Make sure the option "Template output is a calibre search" is chosen.
   
   
   
2. Modify your existing chain
   
   Modify you chain as follows:
   • Make sure in the first "Selection Modifier" action the option "Select first book in current view" is selected.
   • Add a second "Selection Modifier" action with this search:
     
     

     #reading_status:"=TBR"

     Note, however, that you must put this condition on it (Right click > Add/Modify conditions):
     

     template = program: from_selection('id')
     datatype = text
     comparison = "!="
     condition value =

The first solution is the simpler solution. But since your #reading_status is a composite column, I think the second might perform better. Experiment with the two and see what fits you better.

Edit: The two template functions from_search() and from_selection() are only available in Action Chains plugin. @chaley has since introduced a template function called book_values() that can replace from_search().