search

Module Reference

gkScript is a chai module that offers different features:

hashtag
gkScript main object

All gkScript module features are available through a global gkScript object:

class gkScript
{
    string executionType();    // returns "exe", "service" or "docker"
    // Helper functions
    time_t time();
    time_t utcOffset();
    string timeString(time_t val, bool convertToLocalTime = true);
    int tick();    // tick-count in milliseconds
    string expandString(string);
    string getKnownFolder(string);

    sleep(milliseconds);
    string getCommandLine();
    vector<string> getArgList();
    string getNetworkId(bool appendGateway);
    int getConnectionCost(string host);
    string getUserSID();
    string getUserUPN();
    string getMailAddress();
    bool waitForNetwork(milliseconds);

    map<string, string> getUrlParameter(string url);
    string urlEncode(string);
    string pathEncode(string);    // same as urlEncode, but does not encode '/'
    string hexEncode(string);
    string base64Encode(string);
    string base64Decode(string);
    string toLower(string);
    string utf16ToUtf8(string);
    string utf8ToUtf16(string);
    string jScriptStringEncode(string);
    bool matchWildCard(string pattern, string test);
    int getCodePage();

    string randomFill(size);

    bool cryptProtect(string in, bool toLocalMachine, string &out);
    bool cryptUnprotect(string in, string &out);
    bool exportCertStore(string path, string password);

    // Settings store
    bool setString(Key, Value);
    string getString(Key);
    bool setInt(Key, Value);
    integer getInt(Key);

    // Logging functions
    LogLevel getLogLevel();
    setLogLevel(level);

    logError(string);
    logInfo(string);
    logDebug(string);

    bool exportLog(string);
    setPowermode(bool on);     // on: prevent idle power off

    // WMI
    map<string Name, Value> wmiQuery(string Path, string Query);

    // Processes and Threads
    bool shellExecute(hwnd, string verb, string path);
    int executeProcess(string commandLine, string stdin, string &stdout, string &stderr, unsigned int timeout);
    handle runProcess(string commandLine);
    handle openProcess(int processId);
    bool wait(handle, milliseconds);             // can wait for processes, threads, events
    bool terminateProcess(handle, int exitCode);
    wmQuitProcess(int processId);    // send WM_QUIT to all windows of that process
    int getExitCode(handle);
    handle runThread(string chaiCommand);
    bool terminateThread(handle, int exitCode);

    // Events
    handle createEvent();
    setEvent(handle);
    resetEvent(handle);

    // script tool
    ScriptTool ScriptTool(bool with_gkScript);
};

hashtag
Helper functions

Most helpers are easy to understand. See below for some samples:

hashtag
urlEncode - getUrlParameter

hashtag
matchWildCard

Script
Function

bool gkScript::matchWildCard(string pattern, string test)

Tests for a case insensitive match of test against pattern. Pattern may contain wild cards '*' and '?'

hashtag
Network helper functions

Script
Function

gkScript::waitForNetwork(milliseconds)

Wait until an internet connection is established and returns true. If a timeout occurs, the function returns false

gkScript.waitForNetwork(0);

Query network status

gkScript::getNetworkId()

Returns the hex encoded Id of the network (the MAC-Address of the Gateway)

gkScript::getNetworkId(true)

Append the IP address of the Gateway

Script
Function

gkScript::getConnectionCost(host)

Returns the cost flags for a connection to the specified host. See https://msdn.microsoft.com/de-de/library/windows/desktop/hh437608(v=vs.85).aspx for a definition of WCM_CONNECTION_COST flags

hashtag
Logging

Logging amount is controlled by LogLevel values:

Logging functions are part of the gkScript class:

hashtag
Tray Icon

gkScript offers the following functions to control the tray icon (client.exe only):

hashtag
WMI

Script
Function

gkScript::wmiQuery(Path, Query)

Executes WMI queries. Path is the object path of the WMI namespace to query, e.g. ROOT\CIMV2 Query is the WQL query to execute.

The following code is a WMI query sample:

hashtag
Script Tool

The scriptTool class is a sandbox for ChaiScripts. You can call scripts without messing up your own environment...

Script
Function

gkScript.ScriptTool(true)

gkScript object inside the sandbox

gkScript.ScriptTool(false)

Creates a sandbox without gkScript object

{

} ScriptTool instances do not have an exit() command {}

The following code is a ScriptTool sample:

Last updated

Was this helpful?