IRC bot v PHP - 4. časť
Michal Pirchala / 19. 12. 2010, 00:00
Dnes si vytvoríme prvý modul. Bude slúžiť na spúšťanie našich vlastných príkazov.
V priečinku modules vytvoríme nový súbor s názvom napríklad commands. Príkazy budeme, podobne ako moduly, ukladať do samostatného priečinka. Priečinok commands vytvoríme v priečinku, kde máme jadro bota. Modul commands bude obsahovať toto:
<?php
if (preg_match("/^\!([a-zA-Z]*)/", $message, $match)){
include ('commands/'.$match[1]);
}
?>
Príkazy sa budú spúšťať v tvare !PRIKAZ. Meno príkazu môže obsahovať iba malé, alebo veľké znaky a-b (bez diakritiky). Príkaz sa vloží do skriptu z priečinku commands. (Pozor: nie ../commands, pretože modul „sa nevykoná v priečinku modules", teda ho nemá nastavený ako pracovný priečinok.)
Prvý príkaz
Vytvoríme prvý jednoduchý príkaz, ktorý vypíše späť text, ktorý mu pošleme v parametri. Bude sa spúšťať takto:
!echo text na vypísanie
V priečinku commands vytvoríme nový súbor echo a vložíme tam tento kód:
<?php
if (preg_match("/^\!echo (.*)$/", $message, $match)){
Send('PRIVMSG '.$act_chan.' :'.$match[1]);
}
?>
Do poľa premennej $match sa nám uloží všetko, čo nasleduje po „!echo ", a to pošleme do aktuálneho kanálu.
Výpis textu budeme používať dosť často. A ak bude vypisovaný text obsahovať viac riadkov, museli by sme v každom príkaze riešiť jeho „rozbitie" na jednotlivé riadky a tieto potom osobitne posielať. Preto bude vhodnejšie napísať si funkciu, ktorá toto všetko spraví za nás, a ak budeme potrebovať poslať nejaký text (aj s viacerými riadkami), iba zavoláme túto funkciu, ktorá spraví všetko potrebné za nás. Do sekcie Funkcie si pridáme funkciu sendmsg() ktorej v prvom parametri predáme kanál, do ktorého chceme správu poslať, a v druhom samotnú správu.
function sendmsg($channel, $msg){
$msg = explode("\n", $msg);
foreach ($msg as $msg1){
$msg1 = explode("\r", $msg1);
foreach ($msg1 as $row){
if (empty($row)) continue;
Send('PRIVMSG '.$channel.' :'.$row);
sleep(1);
}
}
}
Najprv si rozdelíme text na časti oddelené „\n". Niekedy sa môže stať, že budeme mať nové riadky oddelené nie znakom „\n" ale „\r". Preto ich potom ešte pre istotu rozdelíme týmto znakom a až tak pošleme. Čakanie 1 sekundu medzi jednotlivými riadkami je tam z dôvodu, aby nás server neoznačil za niekoho, kto ostatných obťažuje častým posielaním nezmyselných správ (po nejakom čase nepretržitého posielania by s nami dokonca ukončil spojenie).
A kód príkazu echo upravíme takto:
<?php
if (preg_match("/^\!echo (.*)$/", $message, $match)){
sendmsg($act_chan, $match[1]);
}
?>
Ako to funguje
Rozumieť programu, ktorý chceme rozširovať, je jedna z najdäležitejších vecí a preto detailnejšie popíšem celé fungovanie spustenia príkazu echo.
Jadro zoberie jeden riadok dát, ktorý dostalo od servera. Časť kódu, označená ako SPRAVA, získa z tohto riadku text správy, odosielateľa, jeho host a kanál. Nastáva zavedenie modulov. Modul commands skontroluje, či správa nieje v tvare „!nejakytext" (v našom konkrétnom prípade v tvare „!echo"). Ak nie, nespraví nič. Ale ak áno, vloží (funkciou include) skript zo zložky commands s názvom „nejakytext" (v našom prípade „echo"). Tento skript už vykoná, čo má v sebe zapísané. Náš príkaz echo získa text, ktorý nasledoval za „!echo ". Ten pošle funkcii sendmsg, ktorá ho rozdelí na jednotlivé riadky a konečne odošle pomocou funkcie Send.
Ďalšie príkazy
Quit
Doteraz sa náš bot nedal vypnúť (pomocou poslania správy v IRC). Vypínať budeme pomocou príkazu !quit. V priečinku commands vytvoríme súbor quit s týmto obsahom:
<?php
if ($sender=='VÁŠ NICK'){
Send("QUIT :Odchádzam");
die();
}
?>
Podmienka slúži nato, aby ste vášho bota mohli vypnúť iba vy. Samozrejme, namiesto „VÁŠ NICK" si doplňte nick, pod ktorým vystupujete na IRC. Ďalej pošleme serveru správu QUIT so správou „Odchádzam" a ukončíme beh skriptu.
Vtip
Náš bot ma slúžiť aj na zábavu, takže vtipy mu vo výbave nesmú chýbať. Vtipy budú vyberané z databázy (naplniť si ju už musíte sami). Tabuľka vtipy bude obsahovať stĺpce cat (kategória) a text. Príkaz vtip sa bude spúšťať bez parametru - vyberie sa náhodný vtip z ľubovoľnej kategórie alebo s parametrom „cat X", kde X označuje číslo kategórie, takže budeme vyberať náhodný vtip z danej kategórie alebo ešte s parametrom „categories", kedy nám príkaz vypíše všetky možné kategórie.
SQL príkaz na vytvorenie tabuľky:
CREATE TABLE `vtipy` (
`cat` int(11) NOT NULL,
`TEXT` varchar(1000) NOT NULL
) ENGINE=MyISAM DEFAULT CHARSET=utf8;
PHP kód príkazu:
if (preg_match("/^\!vtip categories$/", $message, $match)){
$cats = "ID - Meno kategórie\n";
$cats .= "1 - alkohol\n";
$cats .= "2 - blondínky\n";
$cats .= "3 - autá\n";
$cats .= "4 - policajti\n";
$cats .= "5 - deti\n";
$cats .= "6 - počítače a internet\n";
$cats .= "7 - morbídne\n";
$cats .= "8 - politici\n";
$cats .= "9 - otázky a odpovede\n";
$cats .= "10 - inzeráty\n";
//ID a nazvy kategorii vtipov mozte pouzit samozrejme vlastne
sendmsg($act_chan, $cats);
} else {
if (preg_match("/^\!vtip cat ([0-9]{1,3})$/", $message, $match)){ //ak uzivatel zadal kategoriu, zostavime SQL prikaz podla toho
$sql = mysql_fetch_array(mysql_query("SELECT * FROM `vtipy` WHERE `cat`='".mysql_real_escape_string($match[1])."' order by RAND()"));
} else { //inak vyberieme nahodny vtip
$sql = mysql_fetch_array(mysql_query("SELECT * FROM `vtipy` order by RAND()"));
}
sendmsg($sql['text']);
}
Pri určovaní názvov premenných musíte dávať pozor, aby ste neprepísali nejakú premennú, ktorú využíva jadro alebo by ju ešte mohli využiť ďalšie moduly, ktoré sa vykonajú neskôr. Dá sa to riešiť napríklad tak, že v každom module budete používať pre premenné prefix, napríklad názov modulu. Je to trocha nepraktické ale účel to plní (ja osobne to nepoužívam).
Command
Príkaz command budeme používať na odoslanie IRC príkazu naším botom. Napríklad ak by sme chceli aby sa pripojil na nejaký kanál, poslal nejakú správu a podobne. Aby nemohli príkazy posielať ostatní užívatelia, tiež použijeme podmienku, aby bot ignoroval všetky príkazy ktoré budu poslané z iného, ako nášho nicku.
if (preg_match("/^\!command (.*)$/", $message, $match) && $sender=='NÁŠ NICK'){
Send($match[1]);
}
Príklad použitia:
!command JOIN #nejaky_kanal
Z príkladu je jasné, že pre používanie tohto príkazu musíte ovládať IRC príkazy.
Záver
Naprogramovali sme prvý modul, ktorý slúži na vykonávanie príkazov, a hneď aj zopár jednoduchých príkazov. Nabudúce spravíme modul na logovanie (zapisovanie) správ do súboru.