IRC.php

<?php

/**
 * This file is part of Peachy MediaWiki Bot API
 *
 * Peachy is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

class IRC {

	/**
	 * IRC Socket connection
	 *
	 * @var object
	 * @access public
	 */
	public $f;

	/**
	 * Channel(s)
	 *
	 * @var string|array
	 * @access private
	 */
	private $chan;

	/**
	 * Construct function, front-end for fsockopen.
	 * @param string $User Username to send to IRC
	 * @param string $Nick Nick to use
	 * @param string $Pass Password to send
	 * @param string $Server Server to connect to
	 * @param string $pgPort Port to use
	 * @param string $Gecos AKA Real Name, Information field, etc.
	 * @param string|array Channel (s) to connect to
	 */
	function __construct( $User, $Nick, $Pass, $Server, $pgPort, $Gecos, $Channel ) {
		$this->f = fsockopen( $Server, $pgPort, $errno, $errstr, 30 );

		if( !$this->f ) {
			die( $errstr . ' (' . $errno . ")\n" );
		}

		pecho( "Logging into IRC as $User into $Server:$pgPort\n\n", PECHO_NOTICE );

		$this->sendToIrc( 'USER ' . $User . ' "' . $Server . '" "localhost" :' . $Gecos . "\n" );
		$this->sendToIrc( 'PASS ' . $Pass . "\n" );
		$this->sendToIrc( 'NICK ' . $Nick . "\n" );

		if( !is_array( $Channel ) ) {
			$this->chan = array( $Channel );
		} else {
			$this->chan = $Channel;
		}
		$this->joinChan( $Channel );
	}

	/**
	 * Destruct function, quits from IRC
	 * @return void
	 */
	public function quit() {
		fwrite( $this->f, 'QUIT ' . "\n" );
	}

	/**
	 * Sends a raw message to IRC
	 * @param string $msg Message to send
	 * @return void
	 */
	public function sendToIrc( $msg ) {
		fwrite( $this->f, $msg );
	}

	/**
	 * Send a message to a channel, formatted in PRIVMSG format
	 * @param string $msg Message to send
	 * @param string $chan Channel to send to
	 * @return void
	 */
	public function sendPrivmsg( $msg, $chan ) {
		pecho( "Sending $msg to $chan...\n\n", PECHO_VERBOSE );
		fwrite( $this->f, "PRIVMSG " . $chan . " :$msg\n" );
	}

	/**
	 * Return the pingpong game
	 * @param string $payload Data from the PING message
	 * @return void
	 */
	public function sendPong( $payload ) {
		fwrite( $this->f, "PONG " . $payload . "\r\n" );
	}

	/**
	 * Joins a channel, or the locally stored channel(s)
	 * @param string $chan Channel to join. Default null.
	 * @return void
	 */
	public function joinChan( $chan = null ) {
		if( !is_null( $chan ) && !is_array( $chan ) ) {
			pecho( "Joining $chan...\n", PECHO_VERBOSE );
			fwrite( $this->f, 'JOIN ' . $chan . "\n" );
			usleep( 5000 );
		} elseif( !is_null( $chan ) ) {
			foreach( $chan as $channel ){
				pecho( "Joining $channel...\n", PECHO_VERBOSE );
				fwrite( $this->f, 'JOIN ' . $channel . "\n" );
				usleep( 5000 );
			}
		}
	}

	/**
	 * Leaves a channel, or the locally stored channel(s)
	 * @param string $chan Channel to part. Default null
	 * @return void
	 */
	public function partChan( $chan = null ) {
		if( !is_null( $chan ) ) {
			pecho( "Parting $chan...\n", PECHO_VERBOSE );
			fwrite( $this->f, 'PART ' . $chan . "\n" );
			usleep( 5000 );
		} else {
			foreach( $this->chan as $chan ){
				pecho( "Parting $chan...\n", PECHO_VERBOSE );
				fwrite( $this->f, 'PART ' . $chan . "\n" );
				usleep( 5000 );
			}
		}
	}

	/**
	 * Splits apart the various parts of an IRC line into usable sections, e.g. !commands, cloaks, etc.
	 * @param string $line Line that IRC sent
	 * @param array $trigger Trigger character for !commands (e.g. !, ., @, etc)
	 * @param bool $feed Whether or not the IRC server is a MediaWiki RC channel
	 * @return array Parsed line
	 * @static
	 */
	public static function parseLine( $line, $trigger, $feed = false ) {
		$return = array();
		$return['trueraw'] = $line;
		$return['truerawmsg'] = explode( " ", $line );
		unset( $return['truerawmsg'][0], $return['truerawmsg'][1], $return['truerawmsg'][2] );
		$return['truerawmsg'] = substr( implode( ' ', $return['truerawmsg'] ), 1 );

		if( $feed ) {
			$line = str_replace( array( "\n", "\r", "\002" ), '', $line );
			$line = preg_replace( '/\003(\d\d?(,\d\d?)?)?/', '', $line );
		} else {
			$line = str_replace( array( "\n", "\r" ), '', $line );
			$line = preg_replace( '/' . chr( 3 ) . '.{2,}/i', '', $line );
		}

		$return['raw'] = $line;

		/*
			Data for a privmsg:
			$d[0] = Nick!User@Host format.
			$d[1] = Action, e.g. "PRIVMSG", "MODE", etc. If it's a message from the server, it's the numerial code
			$d[2] = The channel somethign was spoken in
			$d[3] = The text that was spoken
		*/
		$d = $return['message'] = explode( ' ', $line );
		$return['n!u@h'] = $d[0];

		unset( $return['message'][0], $return['message'][1], $return['message'][2] );
		$return['message'] = substr( implode( ' ', $return['message'] ), 1 );

		$return['nick'] = substr( $d[0], 1 );
		$return['nick'] = explode( '!', $return['nick'] );
		$return['nick'] = $return['nick'][0];

		$return['cloak'] = explode( '@', $d[0] );
		$return['cloak'] = @$return['cloak'][1];

		$return['user'] = explode( '!', $d[0] );
		$return['user'] = explode( '@', $return['user'][1] );
		$return['user'] = $return['user'][0];

		$return['chan'] = strtolower( $d[2] );

		$return['type'] = $return['payload'] = $d[1];

		if( in_array( substr( $return['message'], 0, 1 ), $trigger ) ) {
			$return['command'] = explode( ' ', substr( strtolower( $return['message'] ), 1 ) );
			$return['command'] = $return['command'][0];

			//Get the parameters
			$return['param'] = explode( ' ', $return['message'] );
			unset( $return['param'][0] );
			$return['param'] = implode( ' ', $return['param'] );
			$return['param'] = trim( $return['param'] );
		}

		/*
			End result: 
			$return['raw'] = Raw data
			$return['message'] = The text that appears in the channel
			$return['n!u@h'] = The person who said the line, in N!U@H format
			$return['nick'] = The nick who said the line
			$return['cloak'] = The cloak of the person who said the line
			$return['user'] = The username who said the line
			$return['chan'] = The channel the line was said in
			$return['type'] = The action that was done (eg PRIVMSG, MODE)
			$return['payload'] = For pings, this is $d[1]
			$return['command'] = The command that was said, eg !status (excuding !)
			$return['param'] = Parameters of the command
		*/
		return $return;
	}

	/**
	 * Parses the title, user, etc from a MediaWiki RC feed
	 * @link http://www.mediawiki.org/wiki/Manual:IRC_RC_Bot
	 * @param string $msg Message from feed
	 * @return array Parsed line
	 * @static
	 */
	public static function parseRC( $msg ) {
		if( preg_match( '/^\[\[((Talk|User|Wikipedia|Image|MediaWiki|Template|Help|Category|Portal|Special)(( |_)talk)?:)?([^\x5d]*)\]\] (\S*) (http:\/\/en\.wikipedia\.org\/w\/index\.php\?(oldid|diff)=(\d*)&(rcid|oldid)=(\d*).*|http:\/\/en\.wikipedia\.org\/wiki\/\S+)? \* ([^*]*) \* (\(([^)]*)\))? (.*)$/S', $msg, $m ) ) {

			$return = array();

			//print_r($m);

			$return['namespace'] = $m[2];
			$return['pagename'] = $m[5];
			$return['fullpagename'] = $m[1] . $m[5];
			$return['basepagename'] = explode( '/', $return['fullpagename'] );
			$return['basepagename'] = $return['basepagename'][0];
			$return['subpagename'] = str_replace( $return['basepagename'] . '/', '', $return['fullpagename'] );
			$return['flags'] = str_split( $m[6] );
			$return['action'] = $m[6];
			$return['url'] = $m[7];
			$return['revid'] = $m[9];
			$return['oldid'] = $m[11];
			$return['username'] = $m[12];
			$return['len'] = $m[14];
			$return['comment'] = $m[15];
            $return['timestamp'] = time();
			$return['is_new'] = false;
			$return['is_minor'] = false;
			$return['is_bot'] = false;
			$return['is_delete'] = false;
			$return['actionpage'] = null;

			if( in_array( 'N', $return['flags'] ) ) {
				$return['is_new'] = true;
			}

			if( in_array( 'M', $return['flags'] ) ) {
				$return['is_minor'] = true;
			}

			if( in_array( 'B', $return['flags'] ) ) {
				$return['is_bot'] = true;
			}

			if( $return['action'] == 'delete' ) {
				$return['is_delete'] = true;
				$tmp = explode( '[[', $return['comment'] );
				$tmp = explode( ']]', $tmp[1] );
				$return['actionpage'] = $tmp[0];
				$return['actionpageprefix'] = explode( '/', $return['actionpage'] );
				$return['actionpageprefix'] = $return['actionpageprefix'][0];
			}

			return $return;
		}
	}

    /**
     * @param $errno
     * @return bool|string
     */
    public static function get_error($errno)
    {
        if ($errno != null) {
            switch ($errno) {
                case 401:
                    return "Nickname/Channel is currently unused";
                case 402:
                    return "Server not found";
                case 403:
                    return "Channel not found";
                case 404:
                    return "Cannot send to channel";
                case 405:
                    return "Too many channels joined";
                case 406:
                    return "There was no such nickname";
            }
        } else {
            return false;
        }
	}
}

class SimpleIRC {

	private $server;
	private $pgPort;
	private $user;
	private $pass;
	private $nick;
	private $channel;
	private $callback;

	function __construct( $server, $pgPort = 6667, $user, $pass, $nick, $channel, $callback = null ) {
		global $pgIRCTrigger, $pgHooks;

		if( func_num_args() > 6 ) {
			$this->server = $server;
			$this->port = $pgPort;
			$this->user = $user;
			$this->pass = $pass;
			$this->nick = $nick;
			$this->channel = $channel;
			$this->callback = $callback;
		} else {
			$this->server = $server;
			$this->port = 6667;
			$this->user = $pgPort;
			$this->pass = $user;
			$this->nick = $pass;
			$this->channel = $nick;
			$this->callback = $channel;
		}

		$pgHooks['SimpleIRCPrivMSG'][] = $callback;

		$irc = new IRC( $this->user, $this->nick, $this->pass, $this->server, $this->port, "Peachy IRC Bot Version " . PEACHYVERSION, $this->channel );

		while( !feof( $irc->f ) ){

			$parsed = IRC::parseLine( fgets( $irc->f, 1024 ), $pgIRCTrigger, true );

			if( @$parsed['n!u@h'] == 'PING' ) {
				$irc->sendPong( $parsed['payload'] );
			}

			if( @$parsed['type'] == '376' || @$parser['type'] == '422' ) {
				$feed->joinChan();
				sleep( 5 );
			}

			if( @$parsed['type'] == 'PRIVMSG' ) {
				Hooks::runHook( 'SimpleIRCPrivMSG', array( &$parsed, &$irc, &$this ) );
			}
		}
	}

}