[GUI Plugin] Action Chains

[capink]

Originally Posted by nqk

I want to extract a certain file from the txtz file to certain folder. I create this cmd file with only one line, and it works (drag and drop or open-with in Windows Exlorer)

"C:\Program Files\7-Zip\7z.exe" e %1 -o"D:\Temp" file-to-extract -y

However, the "Open with" action in this Plugin (with binarypath being the path to the cmd file) doesn't do anything.

Please help me to config the ActionChain to make it work.

At present, my work around is
1) In Windows, set the cmd file as "default app" to open txtz file (which I don't really like)
2) In Acction Chain, use "Open with default app".

This is not a good solution, I think.

I will be limited in how much I can help you with this, because I'm not on Windows.

My suggestion for you is to save the above command as a batch file (I suppose that is what you mean by cmd file), and add the path to the batch file using the "choose binary" button. This way you don't need to set the cmd file as the default app.

Edit: If the above solution fails (maybe batch files cannot be executed the same way bash files are in linux), you can use the following code in "Run Python Code Action"

import subprocess

def run(gui, settings, chain):
    db = gui.current_db
    output_dir = 'D:\Temp'
    for book_id in chain.scope().get_book_ids():
        path_to_txtz = db.format_abspath(book_id, 'TXTZ', index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_txtz:
            print(f'Book {title} does not have format: TXTZ')
            continue
        cmd = f'"C:\Program Files\7-Zip\7z.exe" e {path_to_txtz} -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd)
        if result.returncode != 0:
            prints(f'Command error: Return code is {result.returncode} when running command for file: {path_to_txtz}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            prints()

[nqk]

Originally Posted by capink

I will be limited in how much I can help you with this, because I'm not on Windows.

My suggestion for you is to save the above command as a batch file (I suppose that is what you mean by cmd file), and add the path to the batch file using the "choose binary" button. This way you don't need to set the cmd file as the default app.

Edit: If the above solution fails (maybe batch files cannot be executed the same way bash files are in linux), you can use the following code in "Run Python Code Action"

import subprocess

def run(gui, settings, chain):
    db = gui.current_db
    output_dir = 'D:\Temp'
    for book_id in chain.scope().get_book_ids():
        path_to_txtz = db.format_abspath(book_id, 'TXTZ', index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_txtz:
            print(f'Book {title} does not have format: TXTZ')
            continue
        cmd = f'"C:\Program Files\7-Zip\7z.exe" e {path_to_txtz} -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd)
        if result.returncode != 0:
            prints(f'Command error: Return code is {result.returncode} when running command for file: {path_to_txtz}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            prints()

Thank you for your response.

1) the path to the batch file (yes, cmd file is the batch file) was entered to the "Choose binary" box. It was my first choice. But it doesn't run. I think the path of the file is not sent to the cmd file.

2) Thank for your code, but it returns error (with Run Python Code action)

calibre 7.3  embedded-python: True
Windows-10-10.0.19045-SP0 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.19045')
Python 3.11.5
Windows: ('10', '10.0.19045', 'SP0', 'Multiprocessor Free')
Interface language: None
Successfully initialized third party plugins: Action Chains (1, 18, 20) && Count Pages (1, 13, 4) && Editor Chains (1, 1, 0) && EpubMerge (2, 17, 0) && Goodreads (1, 7, 9) && Goodreads Sync (1, 16, 4) && Resize Cover (1, 2, 0)
Traceback (most recent call last):
  File "calibre_plugins.action_chains.action", line 451, in run_chain
  File "calibre_plugins.action_chains.chains", line 403, in run
  File "calibre_plugins.action_chains.chains", line 208, in _run_loop
  File "calibre_plugins.action_chains.chains", line 181, in _run_loop
  File "calibre_plugins.action_chains.actions.code", line 174, in run
  File "module", line 13, in run
  File "subprocess.py", line 548, in run
  File "subprocess.py", line 1026, in __init__
  File "subprocess.py", line 1538, in _execute_child
FileNotFoundError: [WinError 2] The system cannot find the file specified

[capink]

OK. Try this:

import subprocess
import os
from calibre.constants import iswindows, isosx

def run(gui, settings, chain):
    fmt = 'TXTZ'
    db = gui.current_db
    output_dir = 'D:\Temp'
    path_to_binary = 'C:\Program Files\7-Zip\7z.exe'
    clean_env = dict(os.environ)
    kw = {'env': clean_env, 'shell':True, 'capture_output': True}
    if iswindows:
        kw['DETACHED_PROCESS'] = 0x00000008
        del clean_env['PATH']
    elif isosx:
        if path_to_binary.lower().endswith(".app"):
            path_to_binary = 'open -a ' + path_to_binary
    else: #Linux
        clean_env['LD_LIBRARY_PATH'] = ''
    for book_id in chain.scope().get_book_ids():
        path_to_format = db.format_abspath(book_id, fmt, index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_format:
            print(f'Book {title} does not have format: {fmt}')
            continue
        cmd = f'"{path_to_binary}" e {path_to_format} -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd, **kw)
        if result.returncode != 0:
            prints(f'Command error: Return code is {result.returncode} when running command for file: {path_to_format}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            prints()

[nqk]

Sorry to have bugged you this much.

But it returns new error

  File "subprocess.py", line 548, in run
TypeError: Popen.__init__() got an unexpected keyword argument 'DETACHED_PROCESS'

[capink]

Originally Posted by nqk

Sorry to have bugged you this much.

But it returns new error

  File "subprocess.py", line 548, in run
TypeError: Popen.__init__() got an unexpected keyword argument 'DETACHED_PROCESS'

No problem. We are trying to work this out. And I might use this to improve the stock Open With action. The problem is that the action was designed with the assumption that the format would be the last argument, which is not the case in your command.

Anyway, try this:

import subprocess
import os
from calibre.constants import iswindows, isosx

def run(gui, settings, chain):
    fmt = 'TXTZ'
    db = gui.current_db
    output_dir = 'D:\Temp'
    path_to_binary = 'C:\Program Files\7-Zip\7z.exe'
    clean_env = dict(os.environ)
    kw = {'env': clean_env, 'shell':True, 'capture_output': True}
    if iswindows:
        del clean_env['PATH']
    elif isosx:
        if path_to_binary.lower().endswith(".app"):
            path_to_binary = 'open -a ' + path_to_binary
    else: #Linux
        clean_env['LD_LIBRARY_PATH'] = ''
    for book_id in chain.scope().get_book_ids():
        path_to_format = db.format_abspath(book_id, fmt, index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_format:
            print(f'Book {title} does not have format: {fmt}')
            continue
        cmd = f'"{path_to_binary}" e {path_to_format} -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd, **kw)
        if result.returncode != 0:
            prints(f'Command error: Return code is {result.returncode} when running command for file: {path_to_format}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            prints()

[nqk]

I have a feeling that it's almost there. Because it has now come to the print command.

NameError: name 'prints' is not defined

and if I managed to change 'prints' to 'print' in the code, it returns

  File "module", line 29, in run
NameError: name 'sys' is not defined

[capink]

Originally Posted by nqk

I have a feeling that it's almost there. Because it has now come to the print command.

NameError: name 'prints' is not defined

I'm afraid not. That part of the code only runs if the command fails for some reason. Anyway, here we go:

import subprocess
import os
from calibre.constants import iswindows, isosx
import sys

def run(gui, settings, chain):
    fmt = 'TXTZ'
    db = gui.current_db
    output_dir = 'D:\Temp'
    path_to_binary = 'C:\Program Files\7-Zip\7z.exe'
    clean_env = dict(os.environ)
    kw = {'env': clean_env, 'shell':True, 'capture_output': True}
    if iswindows:
        del clean_env['PATH']
    elif isosx:
        if path_to_binary.lower().endswith(".app"):
            path_to_binary = 'open -a ' + path_to_binary
    else: #Linux
        clean_env['LD_LIBRARY_PATH'] = ''
    for book_id in chain.scope().get_book_ids():
        path_to_format = db.format_abspath(book_id, fmt, index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_format:
            print(f'Book {title} does not have format: {fmt}')
            continue
        cmd = f'"{path_to_binary}" e {path_to_format} -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd, **kw)
        if result.returncode != 0:
            print(f'Command error: Return code is {result.returncode} when running command for file: {path_to_format}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            print()

[nqk]

With this piece of codes, it went through but did not do the job. No extraction was made. And if I run this on a book without TXTZ format, no error message pops up.

[capink]

In both cases it does print an output, but you have to use calibre-debug -g

[nqk]

Originally Posted by capink

In both cases it does print an output, but you have to use calibre-debug -g

In the debug windows, I can see that it prints out the wrong path to 7zip.exe

cmd: "C:\Program Files-Zipz.exe" e C:\Users\my path\to\xyz (12248)\xyz- adbc.txtz -o"D:\Temp" images/abc.jpg -y

stderr: The filename, directory name, or volume label syntax is incorrect.

And the path to the txtz file is not enclosed in ""

[capink]

This should solve both issues, hopefully:

import subprocess
import os
import sys
from calibre.constants import iswindows, isosx

#import pathlib
#exec = pathlib.PureWindowsPath(path).as_posix()

def run(gui, settings, chain):
    fmt = 'TXTZ'
    db = gui.current_db
    output_dir = 'D:\Temp'
    path_to_binary = 'C:\Program Files\\7-Zip\\7z.exe'
    clean_env = dict(os.environ)
    kw = {'env': clean_env, 'shell':True, 'capture_output': True}
    if iswindows:
        del clean_env['PATH']
        path_to_binary = os.path.normpath(path_to_binary)
    elif isosx:
        if path_to_binary.lower().endswith(".app"):
            path_to_binary = 'open -a ' + path_to_binary
    else: #Linux
        clean_env['LD_LIBRARY_PATH'] = ''
    for book_id in chain.scope().get_book_ids():
        path_to_format = db.format_abspath(book_id, fmt, index_is_id=True)
        title = db.title(book_id, index_is_id=True)
        if not path_to_format:
            print(f'Book {title} does not have format: {fmt}')
            continue
        if iswindows:
            path_to_format = os.path.normpath(path_to_format)
        cmd = f'"{path_to_binary}" e "{path_to_format}" -o"{output_dir}" file-to-extract -y'
        result = subprocess.run(cmd, **kw)
        if result.returncode != 0:
            print(f'Command error: Return code is {result.returncode} when running command for file: {path_to_format}\ncmd: {cmd}')
            sys.stdout.buffer.write(b'stderr: ' + result.stderr)
            print()

[nqk]

Thank you for your work.

I have tested and it could extract the file successfully. The purpose is fulfilled.

For testing purpose, I ran it on a book without txtz format, it returned:

  File "ntpath.py", line 540, in normpath
TypeError: expected str, bytes or os.PathLike object, not NoneType

I think I will have to figure out how to set condition (it only runs on books with the intended format). The "condition" and "scope" areas look alien to me.

and {path_to_format} looks like a built-in variable. Where can I find the list of built-in variables like this? I'm interested in path to current book folder [current book data folder].

I realize that if this code works out and if I can get necessary variables, I can have external apps (command line interface) do a lot of things.

[capink]

Originally Posted by nqk

and {path_to_format} looks like a built-in variable. Where can I find the list of built-in variables like this? I'm interested in path to current book folder

No. It is not a built-in variable. It was defined earlier in the code above it.

Originally Posted by nqk

I realize that if this code works out and if I can get necessary variables, I can have external apps (command line interface) do a lot of things.

I've already modified the plugin to solve some of these problems. The test version is attached to this post below.

You can help test by trying out these three scenarios:

1. Entering the path of the batch file that failed before (it must have a .bat or .cmd extension), and see whether the modifications made to the plugin helps run it as intended. (see screenshot number 1)
2. If the above fails, repeat but this time check the "Execute command through shell" option. (see screenshot number 2)
3. Entering the whole command we used yesterday and replacing the format file with the variable {inputfile} (see screenshot number 3)

[nqk]

1) and 2) don't work. Debug window doesn't show any error, but saying "Action Chains: chain (test Open With) finished in: 0:00:00.078117"

3) works. And I personally prefer this. Looks pretty much easy to understand. Even if 1 and 2 worked, I would use 3) as it doesn't require external setup.

If "containing folder" is selected, the variable name is still {inputfile}?

[capink]

Originally Posted by nqk

1) and 2) don't work. Debug window doesn't show any error, but saying "Action Chains: chain (test Open With) finished in: 0:00:00.078117"

3) works. And I personally prefer this. Looks pretty much easy to understand. Even if 1 and 2 worked, I would use 3) as it doesn't require external setup.

I understand your preference, but I wanted to make running batch files possible for people who might want to run multiple commands that can only be packed inside a shell script. Not having Windows to test on makes this difficult for me, so I give up for now.

Originally Posted by nqk

If "containing folder" is selected, the variable name is still {inputfile}?

Yes. It passes for any option you choose in the path groupbox including "containing folder", covers and templates.