Simple PHP IRC Logger is a simple PHP IRC Bot class designed to connect to an IRC server, and generate HTML log files. It is based on a modified version of  Simple PHP IRC Bot. This script is designed and intended to be built upon for your needs, so if you have any problems please ask in our forum. Please also follow some of the notes below for guidance. For future updates and scripts, don’t forget to subscribe.

Features and Functions

• !join #channel – Joins the specified IRC channel
• !part #channel – Leaves the specified IRC channel
• !say #channel Message – Says message in the specified IRC channel
• !restart – Quits and restarts the script. (Helpful while testing the script)
• !shutdown – Quits and stops the script.

Usage and output:

<random-user> !say #nystic_chat hello there
<wildphp-bot> hello there

• Enable/Disable Logging (PHP Script Variable)
• Enable/Disable Logging Warning Message (PHP Script Variable)

Note the script in the current version of the script, all joined channels will be added to the single log file for the day.

Installation

1. Download or copy paste the script from this page
2. (Optional) If downloaded rename the file to bot.php ( Sorry, the blog will only allow me to upload it as log-bot.txt)
3. Edit the $config array in the script to the server settings, should be self explanatory
4. Download and install XAMPP
5. Place bot.php in the htdocs folder of your XAMPP installation
6. Don’t forget to start the Apache server by pressing the start button in the XAMPP Control Panel
7. Go to http://localhost/log-bot.php, and the bot should connect and join the channel you specified in about 30 seconds
8. If you have warning enabled the bot should say “Chat Logging has been [Enabled]” when entering the default room
9. If you have logging enabled an HTML file should appear in the same directory, it will be updated when anyone says something in the room

Code

Download log-bot.txt (Right click, Save As…)

or

<?php

/**
* Simple PHP IRC Logger
*
* PHP Version 5
*
* LICENSE: This source file is subject to Creative Commons Attribution
* 3.0 License that is available through the world-wide-web at the following URI:
* http://creativecommons.org/licenses/by/3.0/.  Basically you are free to adapt
* and use this script commercially/non-commercially. My only requirement is that
* you keep this header as an attribution to my work. Enjoy!
*
* @category   Chat Room Scipt
* @package    Simple PHP IRC Logger
* @author     Super3boy <admin@wildphp.com>
* @copyright  2010, The Nystic Network
* @license    http://creativecommons.org/licenses/by/3.0/
* @link       http://wildphp.com (Visit for updated versions and more free scripts!)
* @version    1.0.0 (Last updated 04-04-2010)
*
*/

//So the bot doesn't stop.
set_time_limit(0);
ini_set('display_errors', 'on');

/* --- Varibles and Config Info --- */

//Sample connection data.
$config = array(
//General Config Info
'server' => 'chat.freenode.net',
'port'   => 6667,
'name'   => 'wildphp-bot',
'nick'   => 'wildphp-bot',
'pass'   => '',

//Logging Config Info
'channel' => '#nystic_chat',
'logging' => true,
'warning' => true,
);

/*
//Set your connection data.
$config = array(
//General Config Info
'server' => 'irc.example.com',
'port'   => 6667,
'name'   => 'real name',
'nick'   => 'user',
'pass'   => 'pass',

//Logging Config Info
'channel' => '#channel',
'logging' => true,
'warning' => true,
);
*/

/* --- IRCBot Class --- */

class IRCBot {

//This is going to hold our TCP/IP connection
var $socket;

//This is going to hold all of the messages both server and client
var $ex = array();
//var $logging = true;

/*
Construct item, opens the server connection, logs the bot in
@param array
*/

function __construct($config)
{
$this->socket = fsockopen($config['server'], $config['port']);
$this->login($config);
$this->main($config);
}

/*
Logs the bot in on the server
@param array
*/

function login($config)
{
$this->send_data('USER', $config['nick'].' wildphp.com '.$config['nick'].' :'.$config['name']);
$this->send_data('NICK', $config['nick']);
$this->join_channel($config['channel']);

if($config['logging']) {
$date = date("n-j-y");
$time = date('h:i:s A');
$logfile = fopen("$date-log.html","a");
fwrite($logfile,"<br/>**************** Logging Started at $time ****************<br/>");
fclose($logfile);

//Warn that logging has been enabled
if($config['warning']) {
$this->send_data('PRIVMSG '.$config['channel'].' :', "Chat Logging has been [Enabled]");
}
}
}

/*
This is the workhorse function, grabs the data from the server and displays on the browser
*/

function main($config)
{
$data = fgets($this->socket, 256);

echo nl2br($data);

flush();

$this->ex = explode(' ', $data);

if($this->ex[0] == 'PING')
{
$this->send_data('PONG', $this->ex[0]); //Plays ping-pong with the server to stay connected.
}

//Logs the chat
if($config['logging'])
{
$logtxt = $this->filter_log($this->ex[1], $this->ex[2], $this->ex[0], $this->get_msg($this->ex)); //Gets human readable text from irc data
if($logtxt != null) { //Writes to log if it is a message
$date = date("n-j-y");
$logfile = fopen("$date-log.html","a");
fwrite($logfile,"$logtxt<br />");
fclose($logfile);
}
}

$command = str_replace(array(chr(10), chr(13)), '', $this->ex[3]);

switch($command) //List of commands the bot responds to from a user.
{
case ':!join':
$this->join_channel($this->ex[4]);
break;

case ':!quit':
$this->send_data('QUIT', 'Wildphp.com Made Bot');
break;

case ':!op':
$this->op_user();
break;

case ':!deop':
$this->op_user('','', false);
break;

case ':!protect':
$this->protect_user();
break;

case ':!say':
$message = "";
for($i=4; $i <= (count($this->ex)); $i++)
{
$message .= $this->ex[$i]." ";
}

$this->send_data('PRIVMSG '.$config['channel'].' :', $message);
break;

case ':!restart':
//Warn that logging has been disabled
if($config['warning']) {
$this->send_data('PRIVMSG '.$config['channel'].' :', "Chat Logging has been [Disabled]");
}

echo "<meta http-equiv=\"refresh\" content=\"3\">";
if($config['logging']) {
$date = date("n-j-y");
$time = date('h:i:s A');
$logfile = fopen("$date-log.html","a");
fwrite($logfile,"<br/>**************** Logging Ended at $time ****************<br/>");
fclose($logfile);
}
exit;
case ':!shutdown':
//Warn that logging has been disabled
if($config['warning']) {
$this->send_data('PRIVMSG '.$config['channel'].' :', "Chat Logging has been [Disabled]");
}

if($config['logging']) {
$date = date("n-j-y");
$time = date('h:i:s A');
$logfile = fopen("$date-log.html","a");
fwrite($logfile,"<br/>**************** Logging Ended at $time ****************<br/>");
fclose($logfile);
}
exit;
}

$this->main($config);
}

/* --- IRCBot Class's Functions --- */

function filter_log($type, $chan, $nick, $msg)
{
$nick = ltrim($nick, ":");
$nick = substr($nick, 0, strpos($nick, "!"));

$msg = ltrim($msg, ":");

if($type == "PRIVMSG")
{
return date("[H:i]")." &amp;amp;lt;".$nick."&amp;amp;gt; ".$msg;
}
return null    ;
}

function get_msg($arr)
{
$message = "";
for($i=3; $i <= (count($this->ex)); $i++)
{
$message .= $this->ex[$i]." ";
}
return $message;
}

function send_data($cmd, $msg = null) //displays stuff to the broswer and sends data to the server.
{
if($msg == null)
{
fputs($this->socket, $cmd."\r\n");
echo '<strong>'.$cmd.'</strong><br />';
} else {

fputs($this->socket, $cmd.' '.$msg."\r\n");
echo '<strong>'.$cmd.' '.$msg.'</strong><br />';
}

}

function join_channel($channel) //Joins a channel, used in the join function.
{
if(is_array($channel))
{
foreach($channel as $chan)
{
$this->send_data('JOIN', $chan);
}

} else {
$this->send_data('JOIN', $channel);
}
}

function protect_user($user = '')
{
if($user == '')
{
if(php_version() >= '5.3.0')
{
$user = strstr($this->ex[0], '!', true);
} else {
$length = strstr($this->ex[0], '!');
$user   = substr($this->ex[0], 0, $length);
}
}

$this->send_data('MODE', $this->ex[2] . ' +a ' . $user);
}

function op_user($channel = '', $user = '', $op = true) {
if($channel == '' || $user == '')
{
if($channel == '')
{
$channel = $this->ex[2];
}

if($user == '')
{

if(php_version() >= '5.3.0')
{
$user = strstr($this->ex[0], '!', true);
} else {
$length = strstr($this->ex[0], '!');
$user   = substr($this->ex[0], 0, $length);
}
}
}

if($op)
{
$this->send_data('MODE', $channel . ' +o ' . $user);
} else {
$this->send_data('MODE', $channel . ' -o ' . $user);
}
}
}

//Start the bot
$bot = new IRCBot($config);
?>

Warning

This script uses PHP sockets, and most shared hosting and some servers have it disabled by default. This script runs continuously so it is not recommended to run on shared hosting accounts. We recommend you run it locally using the instructions below.

Conclusion

Thanks for trying out our Simple PHP IRC Logger. You can check out the base class here. If their are any bugs in the code please let us know right away. Also thanks to KillerAuzzie for the for tutorial/basecode.

Simple PHP IRC Bot, is a simple PHP IRC Bot class designed to connect to an IRC server, run a few simple commands.  This script is designed and intended to be built upon, perhaps you could build a PHP IRC Client, so please follow some of the notes below for guidance. This bot is based off a PHP IRC Bot tutorial done on our sister site. In the coming weeks more specialized PHP IRC Bots will be made from this script. It will be expanded and modified for many uses including channel logging and channel moderation, so don’t forget to subscribe.

Warning

This script uses PHP sockets, and most shared hosting and some servers have it disabled by default. This script runs continuously so it is not recommended to run on shared hosting accounts. We recommend you run it locally using the instructions below.

Installation

1. Download or copy paste the script from this page
2. (Optional) If downloaded rename the file to bot.php ( Sorry, the blog will only allow me to upload it as bot.txt)
3. Edit the $config array in the script to the server settings, should be self explanatory
4. Download and install XAMPP
5. Place bot.php in the htdocs folder of your XAMPP installation
6. Don’t forget to start the Apache server by pressing the start button in the XAMPP Control Panel
7. Go to http://localhost/bot.php, and the bot should connect and join the channel you specified in about 30 seconds

Code

Download bot.txt (Right click, Save As…)

or

<?php

/**
* Simple PHP IRC Bot
*
* PHP Version 5
*
* LICENSE: This source file is subject to Creative Commons Attribution
* 3.0 License that is available through the world-wide-web at the following URI:
* http://creativecommons.org/licenses/by/3.0/.  Basically you are free to adapt
* and use this script commercially/non-commercially. My only requirement is that
* you keep this header as an attribution to my work. Enjoy!
*
* @category   Chat Room Scipt
* @package    Simple PHP IRC Bot
* @author     Super3boy <admin@wildphp.com>
* @copyright  2010, The Nystic Network
* @license    http://creativecommons.org/licenses/by/3.0/
* @link       http://wildphp.com (Visit for updated versions and more free scripts!)
* @version    1.0.0 (Last updated 03-20-2010)
*
*/

//So the bot doesnt stop.
set_time_limit(0);
ini_set('display_errors', 'on');

//Sample connection data.
$config = array(
'server' => 'chat.freenode.net',
'port'   => 6667,
'channel' => '#nystic_chat',
'name'   => 'wildphp-bot',
'nick'   => 'wildphp-bot',
'pass'   => '',
);

/*
//Set your connection data.
$config = array(
'server' => 'example.com',
'port'   => 6667,
'channel' => '#channel',
'name'   => 'real name',
'nick'   => 'user',
'pass'   => 'pass',
);
*/

class IRCBot {

//This is going to hold our TCP/IP connection
var $socket;

//This is going to hold all of the messages both server and client
var $ex = array();

/*

Construct item, opens the server connection, logs the bot in
@param array

*/

function __construct($config)

{
$this->socket = fsockopen($config['server'], $config['port']);
$this->login($config);
$this->main($config);
}

/*

Logs the bot in on the server
@param array

*/

function login($config)
{
$this->send_data('USER', $config['nick'].' wildphp.com '.$config['nick'].' :'.$config['name']);
$this->send_data('NICK', $config['nick']);
$this->join_channel($config['channel']);
}

/*

This is the workhorse function, grabs the data from the server and displays on the browser

*/

function main($config)
{
$data = fgets($this->socket, 256);

echo nl2br($data);

flush();

$this->ex = explode(' ', $data);

if($this->ex[0] == 'PING')
{
$this->send_data('PONG', $this->ex[1]); //Plays ping-pong with the server to stay connected.
}

$command = str_replace(array(chr(10), chr(13)), '', $this->ex[3]);

switch($command) //List of commands the bot responds to from a user.
{
case ':!join':
$this->join_channel($this->ex[4]);
break;
case ':!part':
$this->send_data('PART '.$this->ex[4].' :', 'Wildphp.com Free IRC Bot Script');
break;

case ':!say':
$message = "";
for($i=5; $i <= (count($this->ex)); $i++)
{
$message .= $this->ex[$i]." ";
}

$this->send_data('PRIVMSG '.$this->ex[4].' :', $message);
break;

case ':!restart':
echo "<meta http-equiv=\"refresh\" content=\"5\">";
exit;
case ':!shutdown':
$this->send_data('QUIT', 'Wildphp.com Free IRC Bot Script');
exit;
}

$this->main($config);
}

function send_data($cmd, $msg = null) //displays stuff to the broswer and sends data to the server.
{
if($msg == null)
{
fputs($this->socket, $cmd."\r\n");
echo '<strong>'.$cmd.'</strong><br />';
} else {

fputs($this->socket, $cmd.' '.$msg."\r\n");
echo '<strong>'.$cmd.' '.$msg.'</strong><br />';
}

}

function join_channel($channel) //Joins a channel, used in the join function.
{

if(is_array($channel))
{
foreach($channel as $chan)
{
$this->send_data('JOIN', $chan);
}

} else {
$this->send_data('JOIN', $channel);
}
}
}

//Start the bot
$bot = new IRCBot($config);
?>

Features and Functions

• !join #channel – Joins the specified IRC channel
• !part #channel – Leaves the specified IRC channel
• !say #channel Message – Says message in the specified IRC channel
• !restart – Quits and restarts the script. (Helpful while testing the script)
• !shutdown – Quits and stops the script.

Usage and output:

<random-user> !say #nystic_chat hello there
<wildphp-bot> hello there

Code Lines of Note

• Lines 24 – 48: This is where you set your connection data
• Line 101: Prints all the output you see on the screen
• Line 115-140: Contains all commands
• Line 180: Stats the bot

Conclusion

Thanks for trying out our PHP IRC bot. If their are any bugs in the code please let us know right away. Also thanks to KillerAuzzie for the for tutorial/basecode.

<html>
<head>
<title>Flipping Forms Tutorial</title>
</head>
<body>
The following is a form: <br/>

<form action="index.php" method="get">
What is your favorite book?: <input type="text" name="book" /><br/>
What is your favorite movie?: <input type="text" name="movie" /><br/>
What is your favorite website?: <input type="text" name="website" /><br/>
<input type="submit" />
</form>
</body>
</html>

Now the difference between GET and POST is a matter of visibility. When we hit the submit the POST data “magically” goes to the next page. With GET the data is put on the end of URL. When you hit submit you should see something like this on the end of your URL ?book=Harry+Potter&movie=Star+Wars&website=WildPHP+of+Course! .To print out the variables like last time we just use $_GET instead of $_POST:

Printed Results:

<?php
//Print out our GET Data
echo “Favorite Book: “.$_GET["book"];
echo “Favorite Movie: “.$_GET["movie"];
echo “Favorite Movie: “.$_GET["website"];
?>

Sample Output:

Favorite Book: Harry Potter
Favorite Movie: Star Wars
Favorite Website: WildPHP of Course!

Now that the data is viewable in the URL it probably won’t be the best idea to send passwords or sensitive data via GET. GET however can be very useful because we can pass information to PHP without having to fill out a form. If you look above at the URL you are at right now you can see GET in use. Using the info in the URL, PHP knows what post to pull up.

If you want to create a GET variable in a URL just follow this simple format: ?varname=value&varname2=value2. Notice that it always starts with a question mark, and additional values can be added with an ampersand(&).

<html>
<head>
<title>Flipping Forms Tutorial</title>
</head>
<body>
The following is a form: <br/>

<form action="index.php" method="post">
What is your favorite book?: <input type="text" name="book" /><br/>
What is your favorite movie?: <input type="text" name="movie" /><br/>
What is your favorite website?: <input type="text" name="website" /><br/>
<input type="submit" />
</form>
</body>
</html>

If you didn’t notice the slight change I made was method=”post”. This specifies the type of data our form should send. Now on to the PHP. Putting some text in box and hitting submit is not going to do us much good, so let’s capture it and print it out. Put this PHP code under the </form> tag.

Printed Results:<br/>

<?php
//Print out our Post Data
echo "Favorite Book: ".$_POST["book"]."<br/>";
echo "Favorite Movie: ".$_POST["movie"]."<br/>";
echo "Favorite Website: ".$_POST["website"]."<br/>";
?>

Sample Output:

Favorite Book: Harry Potter
Favorite Movie: Star Wars
Favorite Website: WildPHP of Course!

As you can see from the code we get the post data and print it out once you hit submit. The simple $_POST["var name"] statement allows us to do that.

<html>
<head>
<title>Flipping Forms Tutorial</title>
</head>
<body>
The following is a form:
</body>
</html>

In previous tutorials we have manually entered our integers and strings. For this we needed access to our PHP file to change the values. This would not be particularly helpful to a typical user on your website. HTML forms allow us to submit values to PHP which we can process. Let’s make a simple form

<html>
<head>
<title>Flipping Forms Tutorial</title>
</head>
<body>
The following is a form:

<form action="index.php">
What is your favorite book?: <input type="text" name="book" />
What is your favorite movie?: <input type="text" name="movie" />
What is your favorite website?: <input type="text" name="website" />
<input type="submit" />
</form>

</body>
</html>

Let’s go through the HTML one part at a time. If you are already well versed in HTML you should be able to skip this tutorial, and move on to the next one on POST.

Action=”index.php” – This line is the document that you are directed to after you hit the submit button. I am assuming you are still using index.php to run your PHP code .If you are not, you will have to modify it to the one you are using. You can direct it to a completely different one to run your PHP code there as well (more in the next tutorial).

<input type=”text” name=”book” /> – In this line we have the textbox type which is text for textbox. We also have a name which is very important. Follow the same rules as the PHP variable names to keep everything simple. We will use this name to access it in PHP so keep it simple and short.

<input type=”submit” /> – Our submit button. You can also add value=”Your Text”, to change the text from “Submit Query”.

Now that you have a little more knowledge with PHP forms, we can move on to more fun things!

Questions

Q: What is a loop?

Show Answer ▼

Q: What is the syntax when using a For loop?

Show Answer ▼

<?php
for ( counting var; conditional statement; increment var)
{
//code
}
?>

Q: What is the syntax for a While loop?

Show Answer ▼

<?php
while ( conditional statement)
{
//code
}
?>

Q: What is an infinite loop?

Show Answer ▼

Q: What is an array index?

Show Answer ▼

Programming Projects

Project One: Write a program that prints out “I Love WildPHP.com!” 10 times. Use While and For loops.

Show Answer ▼

<?php
//For Loop
for($i=1; $i<=5; $i++)
{
echo "I Love WildPHP.com! ";
}

//While Loop
$i=1;
while($i<=5)
{
echo "I Love WildPHP.com! ";
$i++;
}
?>

Project Two: Write a loop that will add all the numbers in the following integer array: 22, 56, 7, 32, and 11.

Show Answer ▼

<?php
//Declare Array
$numbers = array(22, 56, 7, 32, 11);

//Sum Variable
$sum = 0;

//For Loop
for($i=0; $i<5; $i++)
{
$sum += $numbers[$i];
}

echo "The sum is ".$sum;
?>

Arrays can store all types of values from string to integers to many different types we have yet to go over. Lets try out a simple array before we move on to our example:

<?php
//One way to declare an array
$apartment = array("Ground Floor","Floor 1","Floor 2","Floor 3");

//Other way to declare an array
$apartment[0]="Ground Floor";
$apartment[1]="Floor 1";
$apartment[2]="Floor 2";
$apartment[3]="Floor 3";

//Print out a floor name
echo $apartment[2];
?>

Output:

Floor 2

Think of an array as a stack of variables. Instead of creating a bunch of variables, we can simply create an array. The individual values in an array, by it’s index. If your confused you can think of an array as a building with individual values on each floor. If we specify we want to go to index or “floor” 0, remember we always start from zero in PHP, we might find a stored value like “chocolate.” If we where to go to 6th index or “floor” we could find a value like vanilla.

<?php
//Declare our array
$flavors = array("Chocolate ", "Strawberry ", "Butter pecan ", "Neapolitan ",
"Vanilla fudge ripple ", "French vanilla ", "Vanilla ", "Cookies and cream ");

//Edit a flavor
$flavors[0] = "Chocolate chip ";

//Print our flavors
echo "Our Flavors: ";
for($i=0; $i<=7; $i++)
{
echo $flavors[$i];
}
?>

Output:

Our Flavors: Chocolate chip Strawberry Butter pecan Neapolitan Vanilla fudge ripple French vanilla Vanilla Cookies and cream

Wwe can do the same thing more efficiently with arrays. We can easily add other ice cream flavor, and have it print out for us without adding additional lines.

A while loop has a much simpler format than the for loop.Thinking back to the previous tutorial, the second argument in the for statement was a condition. In a while loop this is the only thing we need. Let’s use the example from the previous tutorial and repeat it in a while loop.

<?php
//First Declare the Counter Variable
$i=1;
//Same Conditional Statement as the For Loop
while($i <= 5)
{
echo "This is a test. ";
//Increment must be in the loop or
//we will have an infinite loop
$i++;
}
?>

The comments above should provide some guidance regarding how the while loops are similar to for loops. We cannot declare the counter variable inside the statement, we must declare it before. Also, we must make sure to make the counter variable change inside the loop or it will just go on forever.

It’s best to use while loops when you want the loop to be dynamic rather than static. For our for loop example we counted down from 10 to 0. We knew that we needed to count down from 10 to 0, so it was quite easy to use a for statement to do this. You would use a while if you really did not know.

For example, if you wanted to count from two random numbers, in this case 6 to 17, your code would look something like this:

<?php
$start = 6;
$end = 17;

echo "We are counting from ".$start." to ".$end.". ";

while($start <= $end)
{
echo $start."... ";
$start++;
}

echo " All Done!";
?>

Output:

We are counting from 6 to 17. 6… 7… 8… 9… 10… 11… 12… 13… 14… 15… 16… 17… All Done!

It is up to you to decide if you want to used Wild While Loops or Flash For Loops.