Difference between revisions of "IRC:exec aliases"

From SoylentNews
Jump to: navigation, search
(~staff)
m (added some aliases)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[IRC:exec]]
 
[[IRC:exec]]
 +
 +
a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides<br>
  
 
==~==
 
==~==
Line 22: Line 24:
  
 
==~comments==
 
==~comments==
 +
https://soylentnews.org/~crutchy/journal/1098
  
 
==~count==
 
==~count==
Line 91: Line 94:
  
 
==~kick==
 
==~kick==
 +
 +
syntax: ~kick %nick%<br>
 +
kicks %nick% from the channel. admin-only command
  
 
==~kill==
 
==~kill==
 +
 +
syntax: ~kill %pid%<br>
 +
kills process run by exec with process id %pid%<br>
 +
admin-only command<br>
 +
only works for processes run by exec. processes outside exec aren't affected by this command
  
 
==~killall==
 
==~killall==
 +
 +
kills all processes being run by the bot at the time. admin-only command
  
 
==~last==
 
==~last==
 
~last &lt;nick&gt;
 
~last &lt;nick&gt;
 +
 +
==~link==
 +
 +
syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -
 +
 +
can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern
 +
 +
will return a list of one or more %id% => %content% if %search% matches either %id% or %content%
 +
 +
==~links==
 +
 +
alias of ~link
  
 
==~list==
 
==~list==
~list (lists available commands)
+
syntax: ~list<br>
 +
lists available commands that don't require elevated privs
  
 
==~list-auth==
 
==~list-auth==
~list-auth (lists available commands requiring NickServ account authorization)
+
syntax: ~list-auth<br>
 +
lists available commands requiring nickserv authentication
  
 
==~location==
 
==~location==
~location code
+
~location %name%<br>
 +
returns the location associated with the specified name
  
 
==~lock==
 
==~lock==
~lock alias (treats all lines entered as being prefixed with alias, channel-specific)
+
syntax: ~lock %alias%<br>
 +
treats all lines entered as being prefixed with alias, channel-specific<br>
 +
see also: ~unlock
 +
 
 +
==~lockdown==
 +
syntax: ~lockdown<br>
 +
admins-only<br>
 +
bot must be op<br>
 +
MODE $dest +ntipm
  
 
==~log==
 
==~log==
 +
 +
syntax: ~log param=value ...<br>
 +
returns data from chromas' logging website<br>
 +
refer to http://chromas.0x.no/s/soylent_log.php for more info
  
 
==~moo==
 
==~moo==
 +
 +
apt-get moo
  
 
==~op==
 
==~op==
 +
 +
syntax: ~op [%nick%]<br>
 +
admin-only command<br>
 +
%nick% is optional<br>
 +
if %nick% isn't specified, will op the calling admin<br>
 +
if %nick% is supplied, will op the specified %nick%<br>
 +
bot must be op in channel
 +
 +
==~openthepodbaydoors==
 +
 +
fortune -s -o
  
 
==~part==
 
==~part==
~part (bot leaves channel)
+
instruct bot to leave the current channel, or a different channel with optional parameter<br />
 +
syntax: ~part [channel]
  
 
==~php==
 
==~php==
Line 139: Line 193:
  
 
==rofl==
 
==rofl==
 +
 +
==~rps==
 +
 +
infinite asynchronous play-by-irc rock/paper/scissors<br>
 +
syntax: ~rps [ranks|r|p|s]<br>
 +
rankings: http://ix.io/nAz<br>
 +
handicap = losses/wins/turns*rounds*100<br>
 +
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/rps.php
  
 
==~say==
 
==~say==
Line 147: Line 209:
 
~sed on|off<br>
 
~sed on|off<br>
 
[nick[:|,|&gt;|.] ]s/pattern/replace[/[g]] (similar to SedBot)
 
[nick[:|,|&gt;|.] ]s/pattern/replace[/[g]] (similar to SedBot)
 +
 +
==~seen==
  
 
==~staff==
 
==~staff==
 
syntax: ~staff meeting<br>
 
syntax: ~staff meeting<br>
 
displays meeting info from either the site news slashbox or the board meeting wiki page
 
displays meeting info from either the site news slashbox or the board meeting wiki page
 +
 +
==~submit==
  
 
==~suggest==
 
==~suggest==
 +
 +
==~tell==
  
 
==~tests==
 
==~tests==
  
 
==~time==
 
==~time==
~time location
+
Syntax: ~time location<br />
 +
Related commands: ~time-add ~time-del ~location<br />
 +
Developer(s): crutchy<br />
 +
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php
  
 
==~time-add==
 
==~time-add==
Line 174: Line 245:
  
 
==~unlock==
 
==~unlock==
Syntax:<br>
+
Syntax: ~unlock<br>
~unlock<br>
+
Related commands: ~lock<br>
Related commands:<br>
+
Developers: crutchy<br>
~lock<br>
+
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php
Developers:<br>
 
crutchy<br>
 
Sources:<br>
 
https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php
 
  
 
==~up==
 
==~up==
  
 
==~users==
 
==~users==
 +
 +
syntax: ~users %command% %subject%<br>
 +
admin-only command<br>
 +
where %command% is one of:<br>
 +
===nicks===
 +
%subject% is the channel that you want to get a listing of nicks for
 +
===channels===
 +
%subject% is the nick that you want to get a list of channels for
 +
===all-channels===
 +
%subject% not applicable for this command<br>
 +
returns a listing of all channels that stored users are members of
 +
===count===
 +
%subject% is the channel that you want the user count of
 +
===data===
 +
%subject% is the nick that you want to return stored data for
 +
===account===
 +
%subject% is the nick that you want to find out the nickserv account of
  
 
==~voice==
 
==~voice==
Line 192: Line 276:
 
Syntax:<br>
 
Syntax:<br>
 
~weather location<br>
 
~weather location<br>
weather data courtesy of the APRS Citizen Weather Observer Program (CWOP) @ http://weather.gladstonefamily.net/<br>
 
 
Examples:<br>
 
Examples:<br>
 
~weather JFK<br>
 
~weather JFK<br>
 
~weather vostok, aq<br>
 
~weather vostok, aq<br>
~weather crutchy<br>
 
 
Related commands:<br>
 
Related commands:<br>
 
~weather-add<br>
 
~weather-add<br>
Line 231: Line 313:
 
==~wiki==
 
==~wiki==
  
 +
==~x==
 +
 +
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.
 +
 +
==!isr==
 +
In Soviet Russia, x2 x1s YOU!
 +
 +
==.macro==
 +
 +
syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>
 +
 +
syntax to delete: .macro <trigger> -
 +
 +
<chanlist> is comma-separated or * for any
 +
 +
Used to set a PRIVMSG or INTERNAL macro.
 +
 +
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130
 +
 +
==.relays==
 +
Outputs a list of freenode channel relays currently active.
 +
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111
 +
 +
==systemctl==
 +
syntax: systemctl %subject%<br>
 +
tries to do %subject% and fails
  
 
[[Category:IRC]]
 
[[Category:IRC]]
 
[[Category:IRC:exec]]
 
[[Category:IRC:exec]]

Latest revision as of 11:37, 23 January 2016

IRC:exec

a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides

~

~bot

~bucket

~buckets-dump

~buckets-flush

~buckets-list

~buckets-load

~buckets-save

~chart

~cid

~comments

https://soylentnews.org/~crutchy/journal/1098

~count

~count <nick>

~cowsay

~define

~define term

~define-add

~define-add term, meaning

~define-count

~define-delete

~define-list

~define-source-edit

~define-source-param

~define-sources

~deop

~dest-clear

~dest-override

~devoice

~find-first

~find-first <text>

~find-last

~find-last <text>

~first

~first <nick>

~fortune

~g'day

~gday

~header

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

~header-login

~help

~ignore

~invite

~ircd

~isup

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

~join

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

~kick

syntax: ~kick %nick%
kicks %nick% from the channel. admin-only command

~kill

syntax: ~kill %pid%
kills process run by exec with process id %pid%
admin-only command
only works for processes run by exec. processes outside exec aren't affected by this command

~killall

kills all processes being run by the bot at the time. admin-only command

~last

~last <nick>

~link

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

~links

alias of ~link

~list

syntax: ~list
lists available commands that don't require elevated privs

~list-auth

syntax: ~list-auth
lists available commands requiring nickserv authentication

~location

~location %name%
returns the location associated with the specified name

~lock

syntax: ~lock %alias%
treats all lines entered as being prefixed with alias, channel-specific
see also: ~unlock

~lockdown

syntax: ~lockdown
admins-only
bot must be op
MODE $dest +ntipm

~log

syntax: ~log param=value ...
returns data from chromas' logging website
refer to http://chromas.0x.no/s/soylent_log.php for more info

~moo

apt-get moo

~op

syntax: ~op [%nick%]
admin-only command
%nick% is optional
if %nick% isn't specified, will op the calling admin
if %nick% is supplied, will op the specified %nick%
bot must be op in channel

~openthepodbaydoors

fortune -s -o

~part

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

~php

~ps

~q

~queue

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

~rainbow

~rainbow text

~rehash

~remind

~restart

rofl

~rps

infinite asynchronous play-by-irc rock/paper/scissors
syntax: ~rps [ranks|r|p|s]
rankings: http://ix.io/nAz
handicap = losses/wins/turns*rounds*100
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/rps.php

~say

~scramble

~sed

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

~seen

~staff

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

~submit

~suggest

~tell

~tests

~time

Syntax: ~time location
Related commands: ~time-add ~time-del ~location
Developer(s): crutchy
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

~time-add

~time-del

~title

~translate

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

~translate-sl

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

~unignore

~unlock

Syntax: ~unlock
Related commands: ~lock
Developers: crutchy
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

~up

~users

syntax: ~users %command% %subject%
admin-only command
where %command% is one of:

nicks

%subject% is the channel that you want to get a listing of nicks for

channels

%subject% is the nick that you want to get a list of channels for

all-channels

%subject% not applicable for this command
returns a listing of all channels that stored users are members of

count

%subject% is the channel that you want the user count of

data

%subject% is the nick that you want to return stored data for

account

%subject% is the nick that you want to find out the nickserv account of

~voice

~weather

Syntax:
~weather location
Examples:
~weather JFK
~weather vostok, aq
Related commands:
~weather-add
~time-add
Developers:
crutchy
Sources:
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

~weather-add

Syntax: ~weather-add name location
Developer(s): crutchy
Sources:
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php
Related commands:
~weather
~time
~time-add
~location
Description:
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"

~weather-del

~welcome

~wiki

~x

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.

!isr

In Soviet Russia, x2 x1s YOU!

.macro

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

.relays

Outputs a list of freenode channel relays currently active. https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

systemctl

syntax: systemctl %subject%
tries to do %subject% and fails