Allow running shell scripts from the FileManager #5804

NiLuJe · 2020-01-31T22:07:51Z

Available via the onHold menu, where I stuck it inside the extra separator below cut/delete/rename. Only on shell scripts (.sh).
That implies making CRe recognize those (which it will, ideally, read as plain text).
Also available in the Favorites onHold menu.
Currently runs in the main process, so, blocking, which feels like the right call to me ;). It's bracketed between InfoMessages to make that clear.

This change is

This'll have broken the button reordering shenanigans...

Since we're blocking the UI ;). Also, gratuitous util.template -> T cleanup

Also, use the basename instead of the full path.

What the hell is os.execute doing with that return code o_O.

NiLuJe · 2020-01-31T22:08:29Z

Currently looks like this:

Any suggestions, @poire-z?

NiLuJe · 2020-01-31T22:08:52Z

@pazos: Should I disable this on Android?

NiLuJe · 2020-01-31T22:09:58Z

Also, @poire-z: did I use the BiDi stuff properly?

NiLuJe · 2020-01-31T22:12:42Z

FWIW, the intended use case is small, simple stuff (say, toggling USBNet, or running a custom sync script (f.g., rclone)).

frontend/apps/filemanager/filemanager.lua

poire-z · 2020-01-31T22:25:00Z

frontend/apps/filemanager/filemanager.lua

        }
+
+        if lfs.attributes(file, "mode") == "file" and string.lower(FrontUtil.getFileNameSuffix(file)) == "sh" then
+            -- NOTE: We populate the empty separator, in order not to mess with the button reordering code in CoverMenu


Nice trick :)

I, err, may have lost a few hairs before realizing that I was mangling the nesting in my first attempts >_<".

poire-z · 2020-01-31T22:28:19Z

frontend/apps/filemanager/filemanager.lua

+                        UIManager:show(script_is_running_msg)
+                        UIManager:scheduleIn(0.5, function()
+                            local rv = os.execute(util.realpath(file))
+                            UIManager:close(script_is_running_msg)
+                            if rv == 0 then
+                                UIManager:show(InfoMessage:new{
+                                    text = _("It exited successfully."),
+                                })


You could also use Trapper:dismissablePopen() (like readerdictionary.lua does for sdcv) to get the script output, and allow interrupting it.

I don't actually care about the output (it's sent to the log, which is just fine by me), only the return code ;).

But the interruptible aspect might be worth looking into, see discussion below ;).

frontend/apps/filemanager/filemanager.lua

Frenzie · 2020-01-31T22:32:12Z

Boy, that's really getting crowded.

Frenzie · 2020-01-31T22:37:50Z

frontend/apps/filemanager/filemanager.lua

        }
+
+        if lfs.attributes(file, "mode") == "file" and string.lower(FrontUtil.getFileNameSuffix(file)) == "sh" then


More of a general remark, but many shellscripts are just "executables" where whether it's a shell script, a python script or even plain old assembly is just an implementation detail.

Yeah, I'd ideally have just chucked a whole load of extensions in DocumentRegistry, and done the check based on the exec bit, but I can't do that because FAT32 :/.

I'll probably add .py to the list, though ;).

But the only one we know for sure is executable is a Lua script :-P

I'm slightly wary of adding lua to the list because of us being full of lua...

frontend/apps/filemanager/filemanager.lua

FrontUtil -> util

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>

pazos · 2020-01-31T22:50:24Z

Yeeeah! Running shell scripts on root account! What can go wrong? 😃 🙉

You'll need a Python interpreter first, of course ;p.

pazos · 2020-01-31T22:58:46Z

Should I disable this on Android?

Yes for this PR. The only problem I see is the ANR, that can be avoided with a dialog on top of the activity (like the animation on 1st launch).

If the script is guarantied to return or is cancellable we're fine. I guess the same happens on other platforms. What happens if the script has a while loop and blocks forever?

NiLuJe · 2020-01-31T23:03:25Z

If the script is guarantied to return or is cancellable we're fine. I guess the same happens on other platforms. What happens if the script has a while loop and blocks forever?

Then it blocks forever ^^.

The other possibility would be chucking it inside a BaseUtil.runInSubProcess which seems a bit iffy for that use-case?

Otherwise, there's what @poire-z proposed above (Trapper:dismissablePopen) which I'm not terribly familiar with.

NiLuJe · 2020-01-31T23:08:12Z

Okay, reading Trapper:dismissablePopen, that only works for stuff that outputs stuff to stdout: it can no longer be cancelled as soon as there's output to be read, which wouldn't work here.

NiLuJe · 2020-01-31T23:11:15Z

That leaves Trapper:dismissableRunInSubprocess, which would probably work but feels a tad overkill here.

I'm obviously biased by being okay with having this blocking the UI, though ;).

pazos · 2020-01-31T23:22:02Z

Then it blocks forever ^^.

If this is intended then we can make the same in android, replacing InfoMessages by calls to dialog.show and dialog.dismiss. As in other platforms it will block forever if the script does not return. At least it won't be killed by the activity manager.

I'm not sure if is worth the hassle, though

poire-z · 2020-01-31T23:24:05Z

I'm fine whichever way.
(I thought one could build fancy scripts with wget|grep|... and display the output in a TextViewer... but well, whenever I need such fancy stuff, i can patch koreader and have it done in superfancy Lua via some menu item :)

reading Trapper:dismissablePopen, that only works for stuff that outputs stuff to stdout: it can no longer be cancelled as soon as there's output to be read, which wouldn't work here.

You could solve both cases by wrapping the script in something like:

output=`./original_script.sh`; echo "$output" ; echo

poire-z · 2020-02-02T18:51:08Z

(minor remark: it will show Execute shell script even on non-shell .py scripts :)

NiLuJe · 2020-02-02T19:54:47Z

@poire-z: Yeah, but switching to "Execute script" felt wonky to me for some reason (and making the string dynamic depending on the extension seems a wee bit overkill ^^).

NiLuJe · 2020-02-02T21:35:21Z

Actually, making that label templated is trivial, so, wheee! \o/

language

frontend/apps/filemanager/filemanager.lua

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>

NiLuJe · 2020-02-03T17:31:33Z

You mean to say I've been using it wrong for all these years? :D.

Latin, man.

ptrm · 2020-02-03T20:49:11Z

Wow, I've been just looking for an alternative to not check my dropbox book storage via udev event! (as rclone sometimes redownloads a dozen books even after ntp time sync on kobo).

Thanks 😁

Follow-up to <koreader#5804>.

Follow-up to <#5804>.

pazos · 2020-02-05T19:19:58Z

Just spent half and hour implementing a longTaskDialog to be used while running scripts. After that I found that internal/external storage are mounted noexec 🤦‍♂️ So nothing to do in android.

NiLuJe · 2020-02-06T00:19:49Z

@pazos: Does the usual trick of passing the script to the interpreter work, like it does on linux? (i.e., /usr/bin/bash /blah/blah/script.sh).

…5804) * Allow running Shell/Python scripts from the FM * Show an InfoMessage before/after running the script Since we're blocking the UI ;). * Allow running scripts from the favorites menu, too.

Follow-up to <koreader#5804>.

rigogsilva · 2020-07-31T11:45:55Z

I saw python in your comments. Does Koreader support run python scripts? (Android 9.0)

pazos · 2020-07-31T11:59:51Z

I saw python in your comments. Does Koreader support run python scripts? (Android 9.0)

Python isn't bundled in any platform, but is usually available on some of them. Android is not the case unless you have a very customized device.

Bundling python is out of the scope as the disk space required by the interpreter and the "batteries included" is greater than the entire program, including all fonts for all languages and all translations :)

What could be possible for android is to run python or any other interpreted code using intents. Termux is a pretty powerful environment but, AFAIK, it doesn' allow 3rd party apps to execute things directly, because security reasons.

rigogsilva · 2020-07-31T12:18:52Z

Gotcha. I was surprised when I saw that and thought I’d check. Thanks 🙏

NiLuJe added 8 commits January 31, 2020 20:20

Allow running shell scripts from the FM

3997d66

This'll have broken the button reordering shenanigans...

Hrrm.

6073ece

Make that actually work

bb397c3

Show an InfoMessage before/after running the script

78bb3e9

Since we're blocking the UI ;). Also, gratuitous util.template -> T cleanup

Close the initial toast on script exit.

e7a97bb

Also, use the basename instead of the full path.

Allow running scripts from the favorites menu, too.

b1a7487

Fix the return code on failure

257a34f

What the hell is os.execute doing with that return code o_O.

Oh, actually Linux's system() syscall madness ;p.

9420340

Unbreak tests

9169276

Frenzie added this to the 2020.02 milestone Jan 31, 2020

poire-z reviewed Jan 31, 2020

View reviewed changes

BiDi fixes

745636b

Frenzie reviewed Jan 31, 2020

View reviewed changes

NiLuJe and others added 3 commits January 31, 2020 23:42

util -> BaseUtil

9f3743c

FrontUtil -> util

Update frontend/apps/filemanager/filemanager.lua

d4624b8

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>

Update the wording everywhere

45f87d0

Allow running Python scripts, too.

815a57a

You'll need a Python interpreter first, of course ;p.

Disable on Android

45dc18d

NiLuJe added 3 commits February 2, 2020 22:29

Will be useful for prettier labels

f2612c6

Minor optimization

63dce14

Fancier labels ;).

67b77ef

Add TL notes, because the patterns might need re-ordering in ssome

b3a6f96

language

Frenzie reviewed Feb 3, 2020

View reviewed changes

frontend/apps/filemanager/filemanager.lua Outdated Show resolved Hide resolved

Frenzie reviewed Feb 3, 2020

View reviewed changes

frontend/apps/filemanager/filemanager.lua Outdated Show resolved Hide resolved

NiLuJe and others added 2 commits February 3, 2020 18:29

Update frontend/apps/filemanager/filemanager.lua

c1f2636

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>

Update frontend/apps/filemanager/filemanager.lua

b30bf34

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>

NiLuJe added 2 commits February 3, 2020 19:53

Missed those

1c6c0cf

Missed a few ;p.

186de68

NiLuJe merged commit 5499d85 into koreader:master Feb 3, 2020

Frenzie added a commit to Frenzie/koreader that referenced this pull request Feb 4, 2020

[chore] Replace ... with … (ellipsis)

b3917a4

Follow-up to <koreader#5804>.

Frenzie mentioned this pull request Feb 4, 2020

[chore] Replace ... with … (ellipsis) #5815

Merged

Frenzie added a commit that referenced this pull request Feb 4, 2020

[chore] Replace ... with … (ellipsis) (#5815)

44c69da

Follow-up to <#5804>.

mwoz123 pushed a commit to mwoz123/koreader that referenced this pull request Mar 29, 2020

[chore] Replace ... with … (ellipsis) (koreader#5815)

d93da21

Follow-up to <koreader#5804>.

poire-z mentioned this pull request Jun 8, 2020

Different hyphenation variants for one language (i.e. German) #6245

Closed

This was referenced Jun 21, 2020

Add the possibility run shell scripts from filemanager on android #6288

Merged

FR: Launcher #4317

Closed

Frenzie mentioned this pull request Oct 21, 2021

Feature Request: Add rsync #5668

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow running shell scripts from the FileManager #5804

Allow running shell scripts from the FileManager #5804

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020

poire-z Jan 31, 2020

NiLuJe Jan 31, 2020

poire-z Jan 31, 2020

NiLuJe Jan 31, 2020

NiLuJe Jan 31, 2020

Frenzie commented Jan 31, 2020

Frenzie Jan 31, 2020

NiLuJe Jan 31, 2020

Frenzie Jan 31, 2020

NiLuJe Jan 31, 2020

pazos commented Jan 31, 2020

pazos commented Jan 31, 2020

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020 •

edited

Loading

pazos commented Jan 31, 2020

poire-z commented Jan 31, 2020

poire-z commented Feb 2, 2020

NiLuJe commented Feb 2, 2020

NiLuJe commented Feb 2, 2020

NiLuJe commented Feb 3, 2020

ptrm commented Feb 3, 2020 •

edited

Loading

pazos commented Feb 5, 2020

NiLuJe commented Feb 6, 2020 •

edited

Loading

rigogsilva commented Jul 31, 2020

pazos commented Jul 31, 2020

rigogsilva commented Jul 31, 2020

		}

		if lfs.attributes(file, "mode") == "file" and string.lower(FrontUtil.getFileNameSuffix(file)) == "sh" then

Allow running shell scripts from the FileManager #5804

Allow running shell scripts from the FileManager #5804

Conversation

NiLuJe commented Jan 31, 2020 • edited Loading

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020 • edited Loading

NiLuJe commented Jan 31, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Frenzie commented Jan 31, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pazos commented Jan 31, 2020

pazos commented Jan 31, 2020

NiLuJe commented Jan 31, 2020

NiLuJe commented Jan 31, 2020 • edited Loading

NiLuJe commented Jan 31, 2020 • edited Loading

pazos commented Jan 31, 2020

poire-z commented Jan 31, 2020

poire-z commented Feb 2, 2020

NiLuJe commented Feb 2, 2020

NiLuJe commented Feb 2, 2020

NiLuJe commented Feb 3, 2020

ptrm commented Feb 3, 2020 • edited Loading

pazos commented Feb 5, 2020

NiLuJe commented Feb 6, 2020 • edited Loading

rigogsilva commented Jul 31, 2020

pazos commented Jul 31, 2020

rigogsilva commented Jul 31, 2020

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020 •

edited

Loading

NiLuJe commented Jan 31, 2020 •

edited

Loading

ptrm commented Feb 3, 2020 •

edited

Loading

NiLuJe commented Feb 6, 2020 •

edited

Loading