Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

$#!
	_get_obj_id, Bot
	_SendIndividualMessage, Bot
A
	About zBot
	addForum, Configs
$	admin Configs Monitor
B
	backgroundChecks
$	bot
	Bot
%	bot_background_activity, Bot
%	botConfig, Configs
$	botname, Configs
	BUILD, Bot
C
	callback_maker, Bot
	ChangeStatus, Bot
%	client_start_time, Bot
$	conferenceServer, Configs
	Configs
	Configuration Variables, Configs
%	connection_hash, Bot
%	connection_session_id, Bot
D
$	desc, Help
$	description, Say
%	descriptions, Plugins
	Disconnect, Bot
E
$	enableLogging, Configs
@	EXPORT Configs Plugins
F
%	forum_join_grace, Bot
%	forum_join_time, Bot
%	forums, Configs
%	forums_and_responses, Bot
	Functions Global Bot Configs Helloworld Help Jokes Monitor Plugins Say
G
	get_alias, Bot
	get_messages_this_hour, Bot
	get_responses, Bot
	get_safety_mode, Bot
	getAdmin, Configs
	getBotConfig, Configs
	getBotName, Configs
	getConferenceServer, Configs
	getDesc, Plugins
	getDf, Monitor
	getFunc, Plugins
	getIdleFunc, Plugins
	getJoke, Jokes
	getLogfile, Configs
	getLogging, Configs
	getPlugins, Plugins
	GetRoster, Bot
	getShortDesc, Plugins
	getTop, Monitor
H
	Helloworld
	Help
I
	idlefunc, Helloworld
@	idlefunctions, Plugins
%	ignore_messages, Bot
	InIQ, Bot
	init
	InitJabber, Bot
	isInForum, Configs
	isOwnConferenceOnly, Configs
J
%	jabber_client, Bot
	JabberPresenceMessage, Bot
	JoinForeignForum, Bot
	JoinForum, Bot
@	jokes, Jokes
	Jokes
K
@	keywords, Configs
L
$	logfile, Configs
%	loop_sleep_time, Bot
M
%	max_message_size, Bot
%	max_messages_per_hour, Bot
%	message_delay, Bot
%	message_function, Bot
%	messages_sent_today, Bot
	Monitor
N
	newMessage
O
$	ownConferenceOnly, Configs
P
	Plugin Hashes, Plugins
%	plugins, Plugins
	Plugins
	printAbout, Help
	printHelloWorld, Helloworld
	printHelp, Help
	Process, Bot
%	process_timeout, Bot
	ProcessJabberMessage, Bot
R
	ReconnectToServer, Bot
	registerPlugin, Plugins
	removeForum, Configs
	RequestVersion, Bot
	respond_to_self_messages, Bot
S
%	safety_mode, Bot
	say, Say
	Say
	SendGroupMessage, Bot
	SendJabberMessage, Bot
	SendPersonalMessage, Bot
	SetForumSubject, Bot
%	shortDescriptions, Plugins
	Start, Bot
	START, Bot
V
	Variables Global Bot Configs Help Jokes Monitor Plugins Say
$	VERSION, Bot
Z
	zbot.pl

sub _get_obj_id : PRIVATE

sub _SendIndividualMessage : PRIVATE

zBot is a Jabber bot written in Perl.

sub addForum

Adds a Forum to the list of forums

JID of admin

my $admin

Name of admin user

sub backgroundChecks

Is called in regular intervals defined at Configs “loop_sleep_time” in seconds (standard 15 seconds)

my $bot

Object of Net::Jabber::Bot class

my %bot_background_activity : ATTR

Configuration hash for Net::Jabber::Bot

Name of the Bot

sub BUILD

sub callback_maker : PRIVATE

sub ChangeStatus

my %client_start_time :ATTR

URL of own conference server

my %connection_hash : ATTR

my %connection_session_id : ATTR

my $desc

my $description

Hash of plugins with key=command and value=description of plugin for help command

sub Disconnect

1 to enable logging in $logfile

our @EXPORT

my %forum_join_grace: ATTR

my %forum_join_time : ATTR

Hash of MUCs to connect to with a reference to a list of Strings to react to.

my %forums_and_responses: ATTR

sub get_alias

sub get_messages_this_hour

sub get_responses

sub get_safety_mode

sub getAdmin

JID of admin

sub getBotConfig

sub getBotName

Name of the bot

sub getConferenceServer

URL of confernece server

sub getDesc

Looksup the description of a plugin

sub getDf

Output of command df -h

sub getFunc

Is called when Bot gets a message.

sub getIdleFunc

Is called every 15 seconds

sub getJoke

sub getLogfile

Name of the logfile

sub getLogging

1 if logging is enabled

sub getPlugins

a list of all plugin keys

sub GetRoster

sub getShortDesc

short Description for a Plugin

sub getTop

Output of top command

sub idlefunc

This routine is called automaticaly every 15 seconds

List of refereces to idlefunctions of plugins (this function gets called every 15 seconds)

my %ignore_messages : ATTR

sub InIQ

sub init

Is called at startup.

sub InitJabber : PRIVATE

sub isInForum

Determines if Bot ins active in a given Forum

sub isOwnConferenceOnly

Tests if bot is only allowed to enter rooms in own conference server

my %jabber_client : ATTR

sub JabberPresenceMessage

sub JoinForeignForum

sub JoinForum

my @jokes

List of Strings to react to in MUC (empty string means: react to everything)

Name of file to log conversations

my %loop_sleep_time : ATTR

my %max_message_size: ATTR

my %max_messages_per_hour: ATTR

my %message_delay: ATTR

my %message_function : ATTR

my %messages_sent_today: ATTR

sub newMessage

Is called when Bot gets a message Should react on message, call plugins and answer

1 to restrict access to own confernece server.

Hash of plugins with key=command and value=reference to function in plugin

sub printAbout

sub printHelloWorld

This routine gets the user and parameters as arguments and should return the string that should be printed.

sub printHelp

sub Process

my %process_timeout : ATTR

sub ProcessJabberMessage

sub ReconnectToServer

sub registerPlugin

Is called from each plugin to register Adds plugin to %plugins and %descriptions

sub removeForum

Removes a Forum from the list of forums

sub RequestVersion : PRIVATE

sub respond_to_self_messages

my %safety_mode: ATTR

sub say

sub SendGroupMessage

sub SendJabberMessage

sub SendPersonalMessage

sub SetForumSubject

Hash of plugins with key=command and value=shortdescription of plugin to give a short description for each plugin at the help command

sub Start

sub START

our $VERSION