Difference between revisions of "IRC:exec aliases"

From SoylentNews
Jump to: navigation, search
m (~time)
m (~comments)
Line 22: Line 22:

Revision as of 00:00, 22 March 2015















~count <nick>



~define term


~define-add term, meaning












~find-first <text>


~find-last <text>


~first <nick>





~header <header> <url>
returns value of header (if found)
fails silently if error occurs or header not found







~isup host[:port] (checks connection, returns http status if found)


~join #channel (don't have to be channel op)





~last <nick>


~list (lists available commands)


~list-auth (lists available commands requiring NickServ account authorization)


~location code


~lock alias (treats all lines entered as being prefixed with alias, channel-specific)





instruct bot to leave the current channel, or a different channel with optional parameter
syntax: ~part [channel]





~queue (returns number of SN submissions in the queue)


~rainbow text








~sed on|off
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)


syntax: ~staff meeting
displays meeting info from either the site news slashbox or the board meeting wiki page




~time location
Related commands:





~translate tolang text (auto-detects source lang, eg: ~translate en prueba)


~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)



Related commands:





~weather location
~weather JFK
~weather vostok, aq
Related commands:


Syntax: ~weather-add name location
Developer(s): crutchy
Related commands:
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands.
If a name already exists, setting it again will overwrite the existing named location.
Names cannot be deleted at this stage.
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights.
<crutchy> ~weather-add crutchy melbourne australia
<exec> code "crutchy" set for location "melbourne australia"





the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

   ~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are: "global on|off" (enables or disables all live scripts) "kill" (a shorcut for disabling all live scripts) "enable %script-name%" (enables an individual live script) "disable %script-name%" (disables an individual live script) "delete-script %script-name%" (deletes a live script from memory) "open %script-name%" (opens a live script for editing in the active channel) "close" (closes the currently open live script in the active channel) "code" (outputs a line-numbered code listing of the currently open live script in the active channel) "list" (outputs a listing of available live scripts, and highlights enabled scripts) "replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script) "delete-line [L]%line-number%" (deletes a line of code in the currently open live script) "insert [L]%line-number% %code%" (inserts a line of code in the currently open live script) "add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.