Net_SmartIRC
pear.php.net
Net_SmartIRC is a PHP class for communication with IRC networks
Net_SmartIRC is a PHP class for communication with IRC networks, which conforms to the RFC 2812 (IRC protocol). It's an API that handles all IRC protocol messages. This class is designed for creating IRC bots, chats and show irc related info on webpages.

Full featurelist of Net_SmartIRC ------------------------------------- - full object oriented programmed - every received IRC message is parsed into an ircdata object (it contains following info: from, nick, ident, host, channel, message, type, rawmessage) - actionhandler for the API on different types of messages (channel/notice/query/kick/join..) callbacks can be registered - messagehandler for the API class based messagehandling, using IRC reply codes - time events callbacks to methods in intervals - send/receive floodprotection - detects and changes nickname on nickname collisions - autoreconnect, if connection is lost - autoretry for connecting to IRC servers - debugging/logging system with log levels (destination can be file, stdout, syslog or browserout) - supports fsocks and PHP socket extension - supports PHP 4.1.x to 4.3.2 (also PHP 5.0.0b1) - sendbuffer with a queue that has 3 priority levels (high, medium, low) plus a bypass level (critical) - channel syncing (tracking of users/modes/topic etc in objects) - user syncing (tracking the user in channels, nick/ident/host/realname/server/hopcount in objects) - when channel syncing is acticated the following functions are available: isJoined isOpped isVoiced isBanned - on reconnect all joined channels will be rejoined, also when keys are used - own CTCP version reply can be set - IRC commands: pass op deop voice devoice ban unban join part action message notice query ctcp mode topic nick invite list names kick who whois whowas quit
Mirco 'meebey' Bauer
meebey
mail@meebey.net yes
Nicolas CHAILLAN
nicos
nicos@php.net yes
2010-10-25
23:16:18
1.0.2
1.0.0
stable
stable
LGPL
Automatically built QA release Req #16526 Colour and bold codes are not supported - giggsey
4.4.4
1.7.0
0.2.5
0.2.5
beta
beta
2002-09-02
LGPL
v0.2.5 ------ - improved socket handling - bufferedsend fix - new version number system - cpu usage reduced - added changelog file
0.2.6
0.2.6
beta
beta
2002-10-12
LGPL
v0.2.6 ------ * phpSmartIRCclass.inc.php: - phpSmartIRCclass.inc renamed to phpSmartIRCclass.inc.php because of security reasons - changed function_exists() to get_loaded_extensions() for checking if the PHP build has real socket support - log() changed to create Linux style formated logs - new methods for logging (daemon style) log() for add log entries setlogdestination() can be STDOUT or FILE setlogfile() sets the file - changed received data processing in rawreceive()

* HOWTO: - added a mini howto for using the class

* DOCUMENTATION: - added class documentation of the project

* CREDITS: - added credits file
0.3.0
0.3.0
beta
beta
2002-10-23
LGPL
v0.3.0 ----- * phpSmartIRCclass.inc.php: - added "Ping? Pong!" log message for debugging - added real linux/windows syslog logging to setlogdestination(). - new method listen_for() makes it possible to show irc related information on a homepage, like how many users on a channel are.

* HOWTO: - added how to run/call the selfwritten bot

* DOCUMENTATION: - added (missing) explaination for new methods

* example2.php: - new examplefile with the new listen_for() method
0.3.2
0.3.2
stable
stable
2002-11-05
LGPL
v0.3.2 ------ * phpSmartIRCclass.inc.php: - Replaced all quotes by single quote where possible for speedup. - Added _disconnecttime for doing a clean IRC quit. - Added Zend IDE style documentation for parameter variables types and method descriptions. - Spaces in nickname and username will be automaticly removed. - Nicknamecollisions are automaticly detected and nickname will be changed to nickname with 3 random numbers. - New method nicknameuse(). - Fixed a serious fsock bug. - Added new type TYPE_ERROR. - Fixed wrong usage of & when calling methods with params that are called by reference. - Fixed a debug message "DEBUG: disconnected", now it will only occur when debug mode is enabled. - listen_for() will now do a quickdisconnect, for a big speedup. - Changed logging system, now with debug levels, default is DEBUG_NOTICE. - Added benchmark system, now its possible to time things for doing optimizations. - New methods: benchmark(), benchmarktstart(), benchmarkend() and show_benchmark() for the benchmark system - Added microint(), for getting the microtime as float, needed for the benchmarks. - Added a couple of log() calls, for different debug levels. - fsockets now runs in non blocking mode, because of broken? getstatus for fsockets. - Added mode() method, for chaning modes of a user or channel. - Added op() and deop() method. Added ban() and unban() method (thx for diff file to Peter Petermann).

* DOCUMENTATION: - added documentation for new logging system - added the whole DEBUG_* list

* HOWTO: - changed parameter description for debug()

* example.php: - replaced all quotes by singlequotes where possible. - fixed wrong usage of message()

* example2.php: - replaced all quotes by singlquotes where possible. - added benchmark test to the example
0.4.0
0.4.0
stable
stable
2002-11-26
LGPL
v0.4.0 ------ * phpSmartIRCclass.inc.php: - fixed serious socket bug The buffer of the socket got full because only 512 bytes were read at once, which caused losing some IRC messages that are comming fast like the MOTD. Now it will read 10240 bytes at once, and doesn't loose any IRC message. - fixed sendbuffer The sendbuffer will only be sent, when the class is fully connected and registered on the IRC network. Before if a nickname collision happened, all sent IRC commands from the buffer were ignored by the IRC server. - fixed socket status Socket handling is now compatible with PHP 4.3 dev. - fixed $_nick When the nickname got changed because of nickname is already in use, $_nick will be updated. (thanks for the hint to Andreas Streichardt). - fixed actionhandler ids (unregister caused that the other ids were changed). - fixed TYPE_TOPIC to the right bitoperator value. - added a reference to the IRC class in actionhandler callbacks WARNING: all user writtin methods have to be changed!! method( &$data ) _has to be changed_ to method( &$irc, &$data ) If you don't change those, your IRC scripts will _not_ work anymore! - changed internal methodnames to _methodname - changed sendbuffer Now it uses configurable senddelay, instead of static 2 messages per second (send flood protection). - changed TYPEs All TYPE_* are now bitwise constants, register_actionhandler() can now react to more than one message type. - added TYPE_ACTION for those common /me messages. - added timeevents Added method register_timehandler() unregister_timeid() and reordertimehandler(). Those timehandler can be used to call methods in specified intervalls, e.g. for timeevents. Added needed class CphpSmartIRCclass_timehandler. - moved all IRC related defines to defines.inc.php. - changed if() elseif() structures where possible to switch() for clearer/faster code. - added more debug messages for actionhandler. - added unregister_actionhandler() and unregister_actionid() method. Also added needed reorderactionhandler(), which is called after an unregister methods was called. - added $data->channel to actionhandler callback.

* defines.inc.php: - initial import. - now all IRC related defines are now in this file instead of phpSmartIRCclass.inc.php.

* DOCUMENTATION: - updated/added methods description

* example.php: - changed user function parameter to new style ( &$irc and &$data ). - added TYPE_NOTICE to query_test example.
0.5.0
0.5.0
stable
stable
2003-01-07
LGPL
v0.5.0 ------ fixes: - fixed critical bug in the main _rawreceive() for() loop, messages were lost.

changes: - License changed from GPL to LGPL. - updated in all files the copyright year. - changed documentation tags in front of all methods to the phpDocumentator compatible format. - improved connect() errorhandling. - changed login() parameters to $nick, $realname, $usermode = 0, $username = null, $password = null. - changed join() parameters to $channelarray, $key = null. - changed kick() parameters to $channel, $nicknamearray, $reason = null. - changed listenFor() parameters to $messagetype return value is now the result, instead the of a reference to the result parameter. - sendbuffer has now 3 queues: high, medium and low high sends 2 messages, then 1 of medium low is only send if high _and_ medium is empty. - select() call for sockets is strongly optimized

new: - phpDocumentator package tags. - include() for messagehandler.php (needed for the new API). - setChannelSynching() method, for enabling the channel synching. - setCtcpVersion() method, for changing the ctcp version reply string. - setReceiveTimeout() method, for changing the receive timeout. - setTransmitTimeout() method, for changing the transmit timeout. - setAutoReconnect() method, for enabling the autoreconnect feature. - channel variable, a reference to _channels because $object->channel("#chan")->topic is not possible in PHP4 (ZE1). - reconnect() method, it will reconnect and also join all channels. - channel() method, getting a reference to the channel, only if channelsynching is on. - added ident, host, messageex and rawmessageex variables to the Net_SmartIRC_data class. - class Net_SmartIRC_user, stores info about one user, only used if channelsynching is on. - class Net_SmartIRC_channel, stores info about one channel, only used if channelsynching is on.
0.5.1
0.5.1
stable
stable
2003-01-17
LGPL
v0.5.1: ------- fixes: - major bugs in ChannelSynching fixed. - fsocks support fixed. - setUseSocket() method fixed. If false was passed as parameter, it tried to load the socket extension. Also warnings are now suppressed with @ in front of dl(). - fixed a typo in reconnect(). - missing SMARTIRC_DEBUG_CHANNELSYNCHING constant added.

changes: - new design for HTML documentation used (PEAR template). - moved all examples to their own directory (examples/). - moved the documentation to docs/HTML/. - added new file descriptions to README. - removed not needed parts of DOCUMENTATION (most is now in the HTML version). - updated the HTML documentation.

new: - example5/6/7.php added. - setAutoRetry() method added. Autoretrying of connecting to the IRC server, is now supported.
0.5.5
0.5.5
stable
stable
2003-07-23
LGPL
v0.5.5: ------- fixes: - fixed a bug in _rawreceive() messages were parsed wrong which caused problems with kick reasons. (thx to sniper for reporting this). - fixed bug in message() CTCP ACTION messages had missing \001 at the end. - fixed a bug in quit(), which caused quit messages not to be sent to the server. - fixed reconnect() bug, it sent the channel join requests right after connect(), and tried to join a channel without a name. - fixes in ChannelSync code When a user joins a channel after SmartIRC, no WHO info is updated in the user object. Fixed wrong update of channel mode when rpl_channelmodeis received. Fixed bug in _mode() method, which caused wrong handling of mode changes. Topic updates are now tracked (thanks to sniper). Fixed bug which caused fatal errors with ChannelSync enabled (closes sf.net bug #705269). Fixed bug in _event_mode(), unhandled modes were stored wrong. Fixed bug in _event_rpl_namreply(), which caused that the first char of the first nick of a namreply got cut (closes sf.net bug #747832). - fixed bug in _checktimer() Which caused problems when a timehandler is unregistered. - fixed _gettye() It wasn't recognizing SMARTIRC_TYPE_ACTION. - removed if(!$obj) check for newly created objects (closes PHP bug #24622), required for PHP 4.1.2 compatibility.

changes: - removed all irc commands from SmartIRC.php they have now their own file (SmartIRC/irccommands.php). - Net_SmartIRC_messagehandler class now extends Net_SmartIRC_irccommands. - removed the 1. parameter (&$irc) of all message handlers, not needed anymore. - renamed class Net_SmartIRC_user to Net_SmartIRC_channeluser, added class Net_SmartIRC_ircuser. - added prefix _event to all message handlers (needed because of class restructuring). - tweaked filling of the ircdata objects. - log() now checks the passed debug level bitwise. - $data->message will be null instead of random garbage, if the IRC message has no colon (the message part), - All methods that depend on ChannelSync mode, checks if it's enabled. - Optimized the usage of time() for $this->_lastrx. - updated the URL of a SmartIRC based bot (atbs). - _loggedin is now set to false when the socket is dead, required for proper working reconnect(). - on a reconnect(), the logfile won't be overwritten anymore. - updated phpdoc tags. - all access to the channel array now uses strtolower() for the key. - fixed typo in function name setChannelSynching(), now it's called setChannelSyncing() with a BC wrapper. - removed all SMARTIRC_ prefixes for debug output. - changed isJoined($channel) to isJoined($channel, $nickname) for checking if the specified user is joined. - removed "destructors", because they don't free the memory.

new: - added isOpped() isVoiced() isBanned(). - added debug output and debug level for the messageparser. - reconnect() uses now the channel key if one exists. - added channel key syncing in _mode(). - when an actionhandler message regex has a leading '/' then the regex is used as it is, this allows complex perl regex's. - added message type SMARTIRC_TYPE_CTCP_REQUEST and SMARTIRC_CTCTP_REPLY for more advanced CTCP. - added new log destinations SMARTIRC_NONE and SMARTIRC_BROWSEROUT (for firendly browserouput). When the script is called from a browser, the BROWSEROUT will automatic be used (closed sf.net bug #708155). - added error handling for socket_select() in _rawreceive(). - added getMessage() to Net_SmartIRC_Error class. - added debug level for ChannelSync code (SMARTIRC_DEBUG_CHANNELSYNCING). - added filename and linenumber to debug output. - added key property to channel class. - added to all IRC commands optional $priority parameter with default value SMARTIRC_MEDIUM. - added isError() for more advanced errorhandling, needed for encapsulation. - added _isValidType() method, which checks for valid SMARTIRC_TYPE_* types.
1.0.1
1.0.0
stable
stable
2009-07-18
LGPL
QA release Updated to package 2.0

Bug #1950 Constructor calls ignore_user_abort(true) - undocumented and not always desired amir Bug #3064 Doesn't work with php 5.0.3 meebey Request #4727 Req Regarding Examples amir Bug #5220 connect() returns in some situations no false amir Bug #6525 When joining empty channel channel array is wrong amir Bug #9848 fix for "Only variable references..." warning amir Bug #10118 quit command doesn't disconnect the socket amir Request #10119 Req CTCP version reply should be fully configurable amir Request #13056 Allow multiple actionhandlers to execute amir
1.0.2
1.0.0
stable
stable
2010-10-25
LGPL
Automatically built QA release Req #16526 Colour and bold codes are not supported - giggsey