AutoHotkey Community

The content of a script

General considerations
a) When I was at school (during the mainframe era) it was generally admitted that the user needed 2 to 5 seconds between the reception of the application screen and the key that send it back to the application having filled the various fields. Now the processor are smaller and more powerful but the users remain the same... So I add a fixed sleep before each actions except the last one that has a random sleep to make simulation more realistic. Total of sleeps is in the low part of the 2 to 5 s. range because I don't take into account processing time.
b) Ahk is fast (order of magnitude few ms.), FF and its Javascript functions is slow (order of magnitude few 1/10 of a s.). You need to synchronize them : sometimes it is not needed (e.g. you change the size of the screen), in the functions of the library it is built in (using the content of the clipboard), but when the page call a Javascript function during or at the end of loading or when you have clicked a button, I don't know a method to verify that the function has finished so I put a long sleep (order of magnitude 1 s.) : this is included in the range of a) .
c) the servers and the programming of an application have a cost. It is paid by your country, a foundation, a company that uses it as a service to its customers, or by advertisement. In this case, either the advertisement use a part of each screen and you don't take it into account or the application forces (before going to its next screen) a choice between some banners that bring you to an advertisement screen that you have to close in the processing of your script (see below).

The structure of a script is always the same : start part, N screens, closing part. You can see that in the distributed scripts.

1) start part
a) Call to the application site using e.g. :
Run, www.autohotkey.com/forum/login.php,Max ; i.e. any URL can be launched.
If there is a disconnect/logoff link or function it is often good to use it here to be sure to start in a clean situation. You are redirected to a more classic screen.
b) initialization of parameters of the script
c) wait till the page has finished loading using :
 rc := fini()

2) for each screen
a) verify that we are on a right screen. In fact there can be several right screens according the circumstances e.g. nothing new since your last access, something new, loop finished, etc. and the processing may change according this. This is the reason why I have put this here and not at the end of the previous item.
To verify this you have different methods and functions already written, if they are not sufficient code your own and propose it for inclusion in the library if you use it several scripts.
You can verify on Title, URL, Source or a combination or a part of them.
 There are basic functions : AHK WinGetTitle command, retURL() RETurns URL (in fact the content of the address bar that with some systems include the true URL and parameters generally separated by a ? ), sdom() returns Source of DOM.
 There are also elaborate functions that do verification, exit from the script if this fail (be cautious if you have to accept several screens) and set global the verified variable (Title, vURL, source) : vertit(x) VERifies that TITle contains x, verURL(x) VERifies that the URL is x or URLcont(x) verifies that the URL CONTains x, versourc(x) VERify that the SOURCe of DOM contains x.
b) do the processing of the screen : fill fields, click on buttons, extract some informations or a combination of these with the programming that goes around, eventually log some results. The last action is generally to click somewhere (a link or a function) to go to the next screen of the application.
c) special case : the application has forced (before going to its next screen) a choice between some banners that bring you to an advertisement screen. I close it with :
SetTitleMatchMode 2
;WinClose [, WinTitle, WinText, SecondsToWait, ExcludeTitle, ExcludeText]
WinClose , Firefox, ,0 , The_application_screen_I_wait_for_Title,
d) wait till the page has finished loading using :
 rc := fini()

3) Closing part
If there is a disconnect/logoff button click it (to have a clean end of the application) and wait : This may also be considered as a particular case of 2) .
I close (at the end of the script) the instance of FFX opened by run with :
SetTitleMatchMode 2
WinClose , Firefox, ,0
Then you may do some log recording e.g. using Dur(x) DURation of script to write the last record of the log before
exit ; end of script
or any other cleaning process.

1) Define the necessary additional shortcuts to AHK

Open Firefox .. Tools tab .. choose "configure keys" or "KeyConfig" (or press Ctrl-Shift-F12 hotkey) to open the small KeyConfig window.
Choose "Add a new key" to open open the small "KeyConfig - Key Editor" window.
At the "Name" field, enter the name or "identity" for the hotkey (eg "AHK loading in progress"). This will help you to locate it later if wish to change it (KeyConfig displays them in alphabetical order). I suggest using the prefix "ahk_" for any autohotkeys you add.
Click in main area (text "/*CODE*/" will disappear), and paste the JavaScript code for the hotkey (what is between "Code:" and the "---" separator line). Click "OK", and you will return to the "KeyConfig" main window.
Ensure your newly-created shortcut is selected, and click in the blank edit box at the bottom.
Hold-down your desired hotkey combination (eg Ctrl-Alt-b). You will see some text appear in box representing the hotkey combination you just pressed.
Click "Apply" then "close"


2) Modify an existing shortcut

Open Firefox .. Tools tab .. choose "configure keys" or "KeyConfig" (or press Ctrl-Shift-F12 hotkey) to open the KeyConfig window.
Click the key you want to change. If it can be changed the button will change to "Edit this key". Click on this button.
Make the changes (for example adding "ahk_" before the name).
You can also edit other entries by double clicking the item Which opens the "keyconfig - Key Editor" screen view with a new random name for the key, which you can type over (ie it creates a copy of the definition), you can then edit the JavaScript code and assign a key combination as above if required.
Click "Apply" then "close"


3) List of shortcuts
=================================================================================================
The line "---------------" is not part of the code : it is only there to separate shortcuts
=================================================================================================
Ctrl-Alt-b

Name: AHK Loading in progress
Note: b as "Busy": "NotBusy

Code:
    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);

    ClipboardHelper.copyString(gBrowser.mIsBusy ? "Busy" : "NotBusy");
-------------------------------------------------------------------------------------------------
Shift-Ctrl-F / Ctrl-Shift-F

Name: AHK result of Find
Note: Companion of Ctrl f, f as "found": "Not_found"

Code:
    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);

    if(gFindBar._findField.getAttribute("status") == "notfound")
      ClipboardHelper.copyString("Not_found");
    else
      ClipboardHelper.copyString("found");
-------------------------------------------------------------------------------------------------
Shift-Ctrl-U / Ctrl-Shift-U

Name: AHK source clipboard
Note: Ctrl U shows the source

Code:
    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);

    var request = new XMLHttpRequest();
    request.open("GET", "view-source:"+content.location, false);
    request.send(null);

    ClipboardHelper.copyString(request.responseText.replace (/\n/g, "\ r\n"));
-------------------------------------------------------------------------------------------------
Shift-Alt-U / Alt-Shift-U

Name: AHK source into DOM clipboard
Note: Ctrl U shows the source

Code:
    var node = content.document.documentElement.cloneNode(true);
    var dummy = content.document.createElement(dummy);
    dummy.appendChild(node);

    html = dummy.innerHTML.replace(/\n/g, "\r\n");

    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);
    ClipboardHelper.copyString(html);
-------------------------------------------------------------------------------------------------
Shift-Ctrl-M / Ctrl-Shift-M   (or Shift-Alt-M / Alt-Shift-M)

Name: AHK Maximize
Note: Maximize the window

Code:
    window.maximize();
-------------------------------------------------------------------------------------------------
? ? ?

Name: AHK Minimize
Note: Minimize the window (not used by any script)

Code:
    window.restore();
-------------------------------------------------------------------------------------------------
Ctrl-m

Name: Maximize AHK to 3 quarters
Note: The former combination of Minimize

Code:
    window.resizeTo(window.screen.availWidth /4 *3, window.screen.availHeight /4 *3);
-------------------------------------------------------------------------------------------------
Ctrl q

Name: AHK Xpath
Note: Ctrl X too dangerous, already used ctrl p, Q is near P
      Xpath select an html tag and click on it

Code:
    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);

    var clipboard = readFromClipboard().match(/(Nigel);([0-9]+);(.*)/);
    if(!clipboard) return;

    try {
    var node = content.document.evaluate(clipboard [3], content.document, null, 7, null).snapshotItem(clipboard[2]-1);
    } Catch(err) { ClipboardHelper.copyString(err); return; }

    if(!node) {
     ClipboardHelper.copyString("NotFound"); return;
    }

    ClipboardHelper.copyString("Found");
    node.focus();

    var e = content.document.createEvent("MouseEvents");
    e.initMouseEvent("click", true, true, null, 1, 0, 0, 0, 0, false, false, false, false, 0, null);
    node.dispatchEvent(e);
-------------------------------------------------------------------------------------------------
Shift-Alt-L / Alt-Shift-L

Name: AHK URL into clipboard
Note: The letter is not one. The equivalent Ctrl-C

Code:
    var ClipboardHelper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
    . getService(Components.interfaces.nsIClipboardHelper);

    ClipboardHelper.copyString(gURLBar.value);
-------------------------------------------------------------------------------------------------

rc := versourc("Google - Mozilla Firefox")