Documentation du module Bot

Soumis par kolossaldrupal le mar, 23/06/2009 - 18:00

Référence en anglais sur drupal.org : 16 Mars 2009 - 00h49 - http://drupal.org/node/401104

Documentation initiale pour développer des modules (ro)bot.

Pour travailler avec IRC, bot.module utilise la classe PHP net_smartic.

L'objet global $irc

$irc est l'objet créé quand on exécute bot_start.php. C'est un objet Net_SmartIRC(). La configuration de la connexion IRC s'effectue en paramétrant certaines valeurs appartenant à cet objet.

Exemple :

$irc->setAutoReconnect((boolean)variable_get('bot_auto_reconnect', 1)); fait que le bot se reconnecte au serveur en cas de déconnexion.

Plusieurs configurations sont paramétrées dans bot_start.php (pour les paramètres précis, vérifiez le code-source) : $irc->setDebug(), $irc->setAutoReconnect(), $irc->setAutoRetry(), $irc->setChannelSyncing(), $irc->setUseSockets(), $irc->registerActionhandler(), $irc->registerTimehandler().

Après le paramètrage et l'enregistrement des callbacks, le bot est connecté et loggué, puis il rejoint les canaux configuré et démarre l'écoute.

Certaines propriétés de $irc, comme $irc_channel, qui est un tableau, deviennent disponibles après la connexion au canal, assurez-vous donc de vérifier la variable avant d'effectuer une boucle sur ses éléments.

Documentation de l'objet $irc

Après avoir rejoint les canaux, beaucoup d'objets $irc sont renseignés avec des détails intéressants du réseau.

Exemple de $irc->channel(array):

Array
(
    [#test] => Net_SmartIRC_channel Object
        (
            [name] => #test
            [key] =>
            [users] => Array
                (
                    [bot] => Net_SmartIRC_channeluser Object
                        (
                            [op] =>
                            [voice] =>
                            [nick] => bot
                            [ident] => ~bot
                            [host] => localhost
                            [realname] =>
                            [ircop] =>
                            [away] =>
                            [server] =>
                            [hopcount] =>
                        )

                    [balu] => Net_SmartIRC_channeluser Object
                        (
                            [op] =>
                            [voice] =>
                            [nick] => balu
                            [ident] =>
                            [host] =>
                            [realname] =>
                            [ircop] =>
                            [away] =>
                            [server] =>
                            [hopcount] =>
                        )

                )

            [ops] => Array
                (
                )

            [voices] => Array
                (
                )

            [bans] => Array
                (
                )

            [topic] =>
            [mode] =>
        )

)