mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
e4c9153d16
* fix a few bare URLs * make mdl happy * make Weathermap.md as mdl happy as possible * make Varnish.md as mdl happy as possible * make Two-Factor-Auth.md mdl happy * touch one header for Syslog.md, but little can be done about the rest * make Sub-Directory.md as mdl happy as possible * make SNMP-Trap-Handler.md lint happy * make SNMP-Proxy.md mdl happy * make Smokeping.md as mdl happy as possible * make Services.md mdl happy * make RRDTune.md mdl happy * cleanup RRDCached.md as much as possible * make RRDCached-Security.md mdl happy * make Rancid.md as mdl happy as possible * make Proxmox.md mdl happy * make Plugin-System.md as mdl happy as possible * make PeeringDB.md mdl happy * make Oxidized.md more lint happy * make Network-Map.md mdl happy * make MIB-based-polling.md as mdl happy as possible * make Metric-Storage.md mdl happy * make IRC-Bot.md as mdl happy as possible * make IRC-Bot-Extensions.md as mdl happy as possible * make * make Graylog.md mdl happy * make Gateone.md mdl happy * make Fast-Ping-Check.md mdl happy * make Distributed-Poller.md as mdl happy as possible * make Dispatcher-Service.md as mdl happy as possible * make Device-Groups.md mdl happy * make Dell-OpenManage.md mdl happy * make Dashboard.md mdl happy * make Customizing-the-Web-UI.md as mdl happy as possible * make Component.md mdl happy * make Billing-Module.md mdl happy * make Auto-Discovery.md mostly mdl happy * make Authentication.md as mdl happy as possible * tidy up a few lines in Applications.md * make Agent-Setup.md as mdl happy as possible * make metrics/OpenTSDB.md mdl happy * spelling fix
92 lines
3.6 KiB
Markdown
92 lines
3.6 KiB
Markdown
source: Extensions/IRC-Bot-Extensions.md
|
|
path: blob/master/doc/
|
|
|
|
# Quick Guide
|
|
|
|
Okay this is a very quick walk-through in writing own `commands` for the IRC-Bot.
|
|
|
|
First of all, create a file in `includes/ircbot`, the file-name should
|
|
be in this format: `command.inc.php`.
|
|
|
|
When editing the file, do not open nor close PHP-tags.
|
|
Any variable you assign will be discarded as soon as your command returns.
|
|
Some variables, specially all listed under `$this->`, have special meanings or effects.
|
|
Before a command is executed, the IRC-Bot ensures that the
|
|
MySQL-Socket is working, that `$this->user` points to the right user
|
|
and that the user is authenticated.
|
|
Below you will find a table with related functions and attributes.
|
|
You can chain-load any built-in command by calling `$this->_command("My Parameters")`.
|
|
You cannot chain-load external commands.
|
|
|
|
To enable your command, edit your `config.php` and add something like this:
|
|
|
|
```php
|
|
...
|
|
$config['irc_external'][] = "mycommand";
|
|
...
|
|
```
|
|
|
|
See: [Example](#example)
|
|
|
|
# Functions and Attributes
|
|
|
|
... that are accessible from within an extension
|
|
|
|
## Functions
|
|
|
|
Function( (Type) $Variable [= Default] [,...] ) | Returns | Description
|
|
--- | --- | ---
|
|
`$this->getChan( )` | `String` | Returns `channel` of current event.
|
|
`$this->getData( (boolean) $Block = false )` | `String/Boolean` | Returns a `line` from the IRC-Buffer if it's not matched against any other `command`. If `$Block` is `true`, wait until a suitable line is returned.
|
|
`$this->getUser( )` | `String` | Returns `nick` of current user. Not to confuse with `$this->user`!
|
|
`$this->get_user( )` | `Array` | See `$this->user` in Attributes.
|
|
`$this->irc_raw( (string) $Protocol )` | `Boolean` | Sends raw IRC-Protocol.
|
|
`$this->isAuthd( )` | `Boolean` | `true` if the user is authenticated.
|
|
`$this->joinChan( (string) $Channel )` | `Boolean` | Joins given `$Channel`.
|
|
`$this->log( (string) $Message )` | `Boolean` | Logs given `$Message` into `STDOUT`.
|
|
`$this->read( (string) $Buffer )` | `String/Boolean` | Returns a `line` from given `$Buffer` or `false` if there's nothing suitable inside the Buffer. Please use `$this->getData()` for handler-safe data retrieval.
|
|
`$this->respond( (string) $Message )` | `Boolean` | Responds to the `request` auto-detecting channel or private message.
|
|
|
|
## Attributes
|
|
|
|
Attribute | Type | Description
|
|
--- | --- | ---
|
|
`$params` | `String` | Contains all arguments that are passed to the `.command`.
|
|
`$this->chan` | `Array` | Channels that are configured.
|
|
`$this->commands` | `Array` | Contains accessible `commands`.
|
|
`$this->config` | `Array` | Contains `$config` from `config.php`.
|
|
`$this->data` | `String` | Contains raw IRC-Protocol.
|
|
`$this->debug` | `Boolean` | Debug-Flag.
|
|
`$this->external` | `Array` | Contains loaded extra `commands`.
|
|
`$this->nick` | `String` | Bot's `nick` on the IRC.
|
|
`$this->pass` | `String` | IRC-Server's passphrase.
|
|
`$this->port` | `Int` | IRC-Server's port-number.
|
|
`$this->server` | `String` | IRC-Server's hostname.
|
|
`$this->ssl` | `Boolean` | SSL-Flag.
|
|
`$this->tick` | `Int` | Interval to check buffers in microseconds.
|
|
`$this->user` | `Array` | Array containing details about the `user` that sent the `request`.
|
|
|
|
# Example
|
|
|
|
`includes/ircbot/join-ng.inc.php`
|
|
|
|
```php
|
|
if( $this->user['level'] != 10 ) {
|
|
return $this->respond("Sorry only admins can make me join.");
|
|
}
|
|
if( $this->getChan() == "#noc") {
|
|
$this->respond("Joining $params");
|
|
$this->joinChan($params);
|
|
} else {
|
|
$this->respond("Sorry, only people from #noc can make join.");
|
|
}
|
|
```
|
|
|
|
`config.php`
|
|
|
|
```php
|
|
...
|
|
$config['irc_external'][] = "join-ng";
|
|
...
|
|
```
|