PHP Action Plugin

Plug In Actions
1

I found keyboard maestro extremely useful, and I think it is quite amazing.

The one action type I did not find was to run an arbitrary PHP script, so I made one.

I chose to convert the parameters and variables to $p{camel case param name} and ${camel case variable name} for convenience (I keep forgetting KMPARAM_ and KMVAR_ , I find them too long).

eg:

A prompt for the user with "User Name" becomes: $userName in the script.

The action can accept either a path to a PHP file, or a PHP script , or both .. or non if you find it useful ... :smile:

I've attached my zip file, as well as an example for usage I hope that others will find this useful.

Please let me know if you have any questions about this (or if it does not work for some reason).

Macro Example:

f4554ff240820db8.png1074×1250

t.php from the macro:
t.php.zip (199 Bytes)

The PHP script plugin:
PHP Script.zip (11.4 KB)

2

Nice one. Thanks for sharing!

3

Nice plugin! But what’s the purpose of the ‘Temporary Folder’ variable?

4

That’s a very good question ! :slight_smile:

I took a closer look at my code, and I actually hard coded /var/tmp in some places , so there is no reason to have that field on the plugin side of things (it will just confuse some people).

I attached a new version that does not need it.

Essentially the script writes a temporary PHP file when entering raw PHP to the text box, and than it executes it, and cleans it when it is done.

Cheers

Alon
PHP Script.zip (10.4 KB)

5

ok, this is a new version (yet again), fixed a minor bug …

Cheers

Alon
PHP Script.zip (10.4 KB)

6

Ok, thank you for the clarification but the new version no longer works :sob:

7

Well, it took me a "bit" of time. I retested the script, I am not sure where the issue is.

Just in case, I will re-upload the plugin.

Also, please do not forget to run the following command on your keyboard maestro after re-applying the new plugin:

tell application "Keyboard Maestro" to reload
tell application "Keyboard Maestro Engine" to reload

It is described here: http://www.keyboardmaestro.com/documentation/6/pluginactions.html

Please let me know if you still find issues. If you do, please be specific with what you try to achieve.PHP Script.zip (9.6 KB)

8

Thank you very much. It works now. I probably forgot to reload Keyboard Maestro the first time. Great plugin!

9

Is it possible to assign the content of the system clipboard to a variable and process this one via PHP within your plugin? Or are only variables accepted that are entered via a prompt?

10

Yes, any variable defined in Keyboard Maestro should work with the plugin.

11

Did you get this sorted?
I’ve done a dump of get_defined_vars() and there is no reference in there to get the current clipboard.
How is this done?

12

Take a look at this example:

What I do in the example below in keyboard maestro, is to get the content of the clipboard, and assign it to a variable named "test".

In the PHP script, I am simply "echoing" the variable "$v_test".

Hopefully that makes more sense.

Let me know

Screen Shot 2017-05-25 at 9.05.16 PM.png889×452 38.6 KB

14

I'm getting "Too Large For Environment" as output as soon as KM input variable exceeds 49 lines.

(I tested it. 49 lines will still work fine. But as soon as it's 50 lines or more, I get this error, no matter the actual content of my script - even if it's just a single "echo".)

55
Screen Shot 2019-09-02 at 14.49.55.png1498×1260 74.3 KB

15

I just tried it with very simple input (60 lines). Seems to work.
Maybe the limit is based on something else.

Is it ok for you to share the full content you try to push through, or even create some test input for me to try?

Also, where do you see the error message?

32%20AM
Screen Shot 2019-09-02 at 8.27.32 AM.png3256×2408 584 KB

16

32
Screen Shot 2019-10-03 at 12.08.32.png2710×1394 428 KB

Below is the text. If I remove a single character, the output works. For instance, if I remove the "h" (last character of the last word), PHP will run.

16
Screen Shot 2019-10-03 at 12.15.16.png2556×1498 526 KB

According to https://mothereff.in/byte-counter, the breaking point seems to be 6,723 bytes. One byte more and I get "too large for environment".

Weird, isn't it?

This is the text:

test.txt.zip (1.9 KB)

17

I think I know what the problem is.

KM sends all variables to PHP as environment variables.

When I run the PHP command

var_dump($_ENV);

I see the contents of all my KM variables.

And apparently, there is a maximum size that the sum of these environment variables can have:

All environment variables must live together in a single environment block, which itself has a limit of 32767 characters

It seems to me that one way to fix this would be to delete all KM vars not relevant to the current script. However, I don't want to do that, because these variables serve a purpose in other macros.

A better solution for me would be if I could run PHP and only send those variables to PHP which I actually need for the current script. I just don't know how to do that.

18

Update: Seems like I fixed it. Used the Macro posted here to display, sort and clear variables. Deleted variables until I was well below the 32k character count. Then it worked.

19

That's great, good job! :slight_smile:

If anyone from Keyboard Maestro is monitoring, It might be a good feature to add to send only the variables the macro is using to help with this limitation ...

1 Like
20

@peternlewis, I agree. This should apply to ALL Execute Script Actions.
IMO, it would be best to provide an option on these actions dealing with which KM Variables to send:

  • Only those variables used in the Macro.
  • Only those variables provided in a list
  • All variables

The default could be "All variables" so that it would not break any existing Macros.

1 Like
21

KM could actually pre-parse the script to see which of the KM variables are used in it, and only afterwards pass it on to PHP, with only those variables provided as environment variables. No human intervention needed then.

1 Like