IRC UDF - Updated Version of Chips' IRC UDF - Release: V1.22 - 09/06/2016 - Technical Writer Needed!

rcmaehl · February 23, 2014

A UDF to connect to IRC using TCP Functions, as well as perform actions once connected.

WANTED: Technical Writer able to create / maintain a helpfile (.chm) using the Autoit helpfile layout for an negotiated rate.

Notes:
Originally created by Chip.
UDF Headers updated compared to old script.
Error and Parameter Handling updated compared to old script.
If you need to bypass the RFC compliance of this UDF, use _IRCRaw.
The majority of the old functions have been modified. It will break most, if not all, scripts using the old UDF.
These commands should work on every server following either RFC 1459 (legacy) or RFC 2812 (preferred).

Potential Uses:
IRC Chat Clients
Chatroom Integration for software
IRC Bots for Channel / Server Administration
IRC Bots for Games such as Hangman, Mafia, and WereWolf
Remote Administration without having to setup your own AutoIt server

Functions:
_IRCChannelInvite
_IRCChannelJoin
_IRCChannelKick
_IRCChannelPart
_IRCChannelTopic
_IRCConnect
_IRCDisconnect
_IRCGetMsg
_IRCMultiMode
_IRCMultiSendMsg
_IRCRaw
_IRCSelfOper
_IRCSelfSetNick
_IRCSelfSetStatus
_IRCServerPing
_IRCServerPong
_IRCServerTime
_IRCServerVersion

Extra Functions:
_IRCReplyTo (IRCExtras.au3)
_IRCStripSpecial (IRCExtras.au3)

Downloads:

Additional Links:
Chips' Old UDF Topic:

DISCLAIMER:
While these downloads are more stable than the ones above, I do not have time to thoroughly test all functions and variable entries. If something doesn't work as expected or gives you an error please check @error and @extended variables then create a reply to this topic.

Changelog:

09/06/2016:

  IRC.au3            Fixed   : Updated Headers to UDF-spec (- instead of =)
  _IRCGetMsg         Fixed   : Incorrect Return Value On Error
  _IRCStripSpecial   Added   : Better documentation of Flags
  _IRCMultiSendMsg   Added   : Better documentation of Flags
  _IRCMultiSendMsg   Fixed   : Max Message Size based on https://forums.unrealircd.org/viewtopic.php?t=6811
  Updated all files to consider themselves a standalone install by default
  All Functions that didn't Return anything now return Number of bytes sent
  Slight Performance Improvements by using Parameter Gating instead of Single Input Single Output

07/21/2016:

  Example.au3        Fixed  : Includes
  Example.au3        Renamed: IRC_Example.au3
  IRC.au3            Changed: Minor Performance Improvements

04/18/2016:

  IRCConstants.au3   Updated: A Ton of New Constants added
  IRCMultiSendMsg    Added  : Color Example
  Increased TCP Timeout in all Examples

04/13/2016:

  CUI.au3            Updated: Errors now output to Error Stream in Console
  (C/G)UI.au3        Fixed  : Userlists (FOR REAL THIS TIME) by being sure to get the current channel
                     Removed: Duplicate Constants File Include
                     Removed: Local Declaration inside of While loop for Performance
                     Updated: TCPTimeout Increased
                     Updated: $sTemp renamed $sStrip for Readibility
  Example.au3        Updated: TCPTimeout Increased
  GUI_Client.au3     Renamed: GUI.au3
  _IRCStripSpecial   Added  : Parameter Checking
                     Updated: Documentation
  _IRCMultiSendMsg   Added  : Additional flags for Message Type (POSSIBLY SCRIPT BREAKING if using $_bTrim!)
                     Updated: Example to show new flags
                     Updated: Increase Max Message Size from 368 To 436
                     
04/09/2016:

  IRC.au3            Updated: All Documentation
                     Added  : Now has a Constaznts file
  _IRCConnnect       Fixed  : Now PROPERLY returns any errors
  _IRCGetMsg         Removed: $_iChars parameter since it gets one packet at a time and parsing is easier
  _IRCReplyTo        Fixed  : Now properly returns username
  _IRCStripSpecial   Added  : Now uses Constants File
  All files are now in a single ZIP
  Includes 2 basic IRC "clients", a CUI, and a GUI

07/15/2015:

  Example.au3        Added  : Improved Debugging
                     Updated: All Space Indents to Tab Idents
  IRC.au3            Removed: Exception skipping @error = -1 in IRCGetMsg() as 3.3.14.0 fixed it

07/15/2015:

  Example.au3        Added  : Ping Timeout
                     Fixed  : Userlist clipping of last user
  IRC.au3            Fixed  : IRCGetMsg() Hang

07/08/2015:

  Example.au3        Fixed  : User Lists
                     Fixed  : Nickname now switches to backup nickname if first choice is already in use
  IRC.au3            Added  : UDF Index
                     Added  : #include-once
                     Updated: All Functions updated to Single Entry, Single Exit
                     Updated: Now passes Au3Check on -q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

01/15/2015:

  Example.au3        Fixed  : Ampersand channels causing a crash

12/20/2014:

  Example.au3        Fixed  : Nicks not updating on all channel lists when a user changed their nick
                     Fixed  : Nicks not deleting on all channel lists when a user quits the network

12/19/2014:

  Example.au3        Added  : User lists
                     Added  : Channel lists
                     Added  : Bot keeps track of own nick
                     Added  : Secondary nick in case first nick choice is in use.
                     Added  : Extremely Minor performance improvements

  _IRCConnect        Added  : Improved parameter checking
  _IRCGetMsg         Updated: Now only retrieves one packet by default (MAY be script breaking)

10/14/2014:

  Example.au3        Added  : Shutdown TCP on exit
                     Fixed  : $Recipient now gets the actual Recipient instead of the 3rd message
                     Added  : Now exits when told to quit.
  IRC.au3            Added  : Improved Error Reporting (Includes @extended on error)
  _IRCDisconnect     Added  : Close Socket on Disconnect
  _IRCStripSpecial   Added  : Improved Color Stripping

09/28/2014:

  _IRCConnect        Fixed  : Checking if Mode was blank.
  _IRCGetMsg         Fixed  : Spamming of 0 and incorrectly thinking there was an error.

09/28/2014:

  IRC.au3            Fixed  : All functions now return when errors are encountered instead of continuing
  _IRCConnect        Added  : Now returns an error if optional password failed to send
  _IRCGetMsg         Added  : Now returns an error if it failed to receive a custom amount of data
  _IRCServerVersion  Fixed  : Capitalized "Version"

09/26/2014:

  Example.au3        Fixed  : Pings not ending with @CRLF
  IRCExtras.au3      Added  : _IRCStripSpecial(), Cleans special characters sometimes seen in IRC

09/24/2014:

  Example.au3        Added  : Checking for PrivMsg
                     Fixed  : Infinite loop if you removed _IRCDisconnect
                     Updated: Bot now disconnects when receiving "!quit" instead of automatically
  Discontinuted BETA UDF project.

04/20/2014:

  IRCExtras.au3      Added  : Additional IRC Functions
  _IRChangeNick      Renamed: _IRCSelfSetNick (SCRIPT BREAKING! Fix: Replace _IRCChangeNick with _IRCSelfSetNick)
  _IRCGetMsg         Fixed  : Now no longer Splits Packets if Default option is used
  _IRCChannelInvite  Added  : Invites a User to a Channel
  _IRCChannelKick    Added  : Kick a User from a channel
  _IRCJoinChannel    Renamed: _IRCChannelJoin (SCRIPT BREAKING! Fix: Replace _IRCJoinChannel with _IRCChannelJoin)
  _IRCMode           Renamed: _IRCMultiMode (SCRIPT BREAKING! Fix: Replace _IRCMode with _IRCMultiMode)
  _IRCOper           Renamed: _IRCSelfOper (SCRIPT BREAKING! Fix: Replace _IRCOper with _IRCSelfOper)
  _IRCPartChannel    Renamed: _IRCChannelPart (SCRIPT BREAKING! Fix: Replace _IRCPartChannel with _IRCChannelPart)
  _IRCPing           Renamed: _IRCServerPing (SCRIPT BREAKING! Fix: Replace _IRCPing with _IRCServerPing)
  _IRCPong           Renamed: _IRCServerPong (SCRIPT BREAKING! Fix: Replace _IRCPong with _IRCServerPong)
  _IRCSelfSetStatus  Added  : Sets you AFK and un-AFK
  _IRCSendMessage    Renamed: Renamed _IRCMultiSendMsg. (SCRIPT BREAKING Fix: Replace IRCSendMessage with IRCMultiSendMsg)
  _IRCSendMessageRaw Renamed: Renamed _IRCRaw (SCRIPT BREAKING! Fix: Replace _IRCSendMessageRaw with _IRCRaw)
  _IRCServerTime     Added  : Get time from a Server
  _IRCServerVersion  Added  : Get Software Version from a Server
  _IRCTopic          Renamed: _IRCChannelTopic (SCRIPT BREAKING! Fix: Replace _IRCTopic with _IRCChannelTopic)
  Improved Parameter detection in all Functions
  Renamed Functions to show who/what they effect, MASSIVE Script Breaking. Sorry! :/

04/06/2014:

  _IRCGetMsg         Added  : Use to get IRC Messages.
  _IRCSetTopic       Changed: Now named _IRCTopic (SCRIPT BREAKING! Fix: Replace _IRCSetTopic with _IRCTopic)
                     Changed: Can now be used to query topic and does so by default. Use "" to blank the topic
  All functions now thoroughly check their parameters
  Updated all functions to use @extended to some errors
  Fixed @error returning 0 by starting all errors at 1 instead of 0

03/20/2014:

  _IRCChangeMode     Changed: Now named _IRCMode (SCRIPT BREAKING! Fix: Replace _IRCChangeMode with _IRCMode)
                     Changed: $_sMode is now OPTIONAL. Allowing the command to be used to Query current mode as well
  _IRCConnect        Fixed  : Missing Colon Before $_sRealName. It should now allow Real Names with spaces
  _IRCDisconnect     Fixed  : Issue with Blank Messages. Should now properly blank to Default
  _IRCPing           Changed: $_Server is now REQUIRED. (SCRIPT BREAKING! Fix: Specify a server as Parameter 2)
  _IRCSendMessage    Added  : $_bTrim, Trims message if too long instead of breaking up the message, Default is true
  _IRCSetTopic       Added  : Command for setting a Channel Topic
  Updated Most Functions to include better error checking
  Updated Most Channel Related Functions to check for valid channels

03/16/2014:

  _IRCChangeMode     Added  : Optional parameters for channel modes
                     Changed: Parameter ordering Target is now before Mode (SCRIPT BREAKING! Fix: Swap Parameters 2 and 3)
  _IRCConnect        Changed: No longer exits the script on error, instead returns TCPConnect Error Code
  _IRCJoinChannel    Added  : Now Supports Channel Passwords
  _IRCOper           Added  : Command for IRC Server Operator Login
  Updated All Functions to have UDF standard error codes

02/24/2014:

  _IRCSendMessage    Changed: Split Into _IRCSendMessage and _IRCSendMessageRaw (SCRIPT BREAKING! No Simple Fix Available)

02/23/2014:

  Made variables comply to UDF Standards http://www.autoitscript.com/autoit3/udfs/UDF_Standards.htm
  Removed MsgBoxes left over from old UDF
  Updated / Uploaded IRC.au3

Known and Reported Bugs:

Message output only displays ANSI characters in CUI. (Can't Fix)
Freenode requires registration for part messages thus the part message in example doesn't show up (Can't fix)
Messages (e.g. PRIVMSG) are not forwarded?, when it contains umlauts/german mutations and when the message only contains a dot '.' (Unconfirmed)

Warnings:

Do NOT send a lot of messages at once. MOST networks will disconnect you. SOME networks will permanently ban you. A MINORITY will harshly retailiate.

Do NOT use the Sleep() function in your scripts. It prevents you from receiving any new data, can disconnect your from the network, and have other undesired consequences. Use the TimerInit() and TimerDiff() functions and possibly a message queue.

To Do:

Possibly add in SSL functionality
Create More Functions for IRC commands
An entire IRC daemon written in AutoIt
Possibly Include Kips TCP UDF for ASync Port Listening in Example
Create Additional UDFs for extras such as CTCP, DCC, and Error Lookup
Experiment with having functions check for the reply and see if reliable.

Upcoming Changes:

To Be Decided

Support:

Support for this UDF can be obtained in my Discord Server

Edited March 11, 2021 by rcmaehl
Add support link

guinness · February 23, 2014

UDFs shouldn't use MsgBox() to report errors, this is down to the developer to decide. You have quite a bit of work to do before calling this a UDF.

rcmaehl · February 23, 2014

UDFs shouldn't use MsgBox() to report errors, this is down to the developer to decide. You have quite a bit of work to do before calling this a UDF.

I'll upload a new version without them (They were left in from the original UDF) and the Variable names updated in a bit.

rcmaehl · March 16, 2014

Update:

.
  _IRCChangeMode     Added  : Optional parameters for channel modes
                     Changed: Parameter ordering Target is now before Mode (SCRIPT BREAKING! Fix: Swap Parameters 2 and 3)
  _IRCConnect        Changed: No longer exits the script on error, instead returns TCPConnect Error Code
  _IRCJoinChannel    Added  : Now Supports Channel Passwords
  _IRCOper           Added  : Command for IRC Server Operator Login
  Updated All Functions to have UDF standard error codes

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · March 20, 2014

Update:

.
  _IRCChangeMode     Changed: Now named _IRCMode (SCRIPT BREAKING! Fix: Replace _IRCChangeMode with _IRCMode)
                     Changed: $_sMode is now OPTIONAL. Allowing the command to be used to Query current mode as well
  _IRCConnect        Fixed  : Missing Colon Before $_sRealName. It should now allow Real Names with spaces
  _IRCDisconnect     Fixed  : Issue with Blank Messages. Should now properly blank to Default
  _IRCPing           Changed: $_Server is now REQUIRED. (SCRIPT BREAKING! Fix: Specify a server as Parameter 2)
  _IRCSendMessage    Added  : $_bTrim, Trims message if too long instead of breaking up the message, Default is true
  _IRCSetTopic       Added  : Command for setting a Channel Topic
  Updated Most Functions to include better error checking
  Updated Most Channel Related Functions to check for valid channels

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · April 6, 2014

Update:

.
  _IRCGetMsg         Added  : Use to get IRC Messages.
  _IRCSetTopic       Changed: Now named _IRCTopic (SCRIPT BREAKING! Fix: Replace _IRCSetTopic with _IRCTopic)
                     Changed: Can now be used to query topic and does so by default. Use "" to blank the topic
  All functions now thoroughly check their parameters
  Updated all functions to use @extended to some errors
  Fixed @error returning 0 by starting all errors at 1 instead of 0

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · April 20, 2014

Update:

.
  IRCExtras.au3      Added  : Additional IRC Functions
  _IRChangeNick      Renamed: _IRCSelfSetNick (SCRIPT BREAKING! Fix: Replace _IRCChangeNick with _IRCSelfSetNick)
  _IRCGetMsg         Fixed  : Now no longer Splits Packets if Default option is used
  _IRCChannelInvite  Added  : Invites a User to a Channel
  _IRCChannelKick    Added  : Kick a User from a channel
  _IRCJoinChannel    Renamed: _IRCChannelJoin (SCRIPT BREAKING! Fix: Replace _IRCJoinChannel with _IRCChannelJoin)
  _IRCMode           Renamed: _IRCMultiMode (SCRIPT BREAKING! Fix: Replace _IRCMode with _IRCMultiMode)
  _IRCOper           Renamed: _IRCSelfOper (SCRIPT BREAKING! Fix: Replace _IRCOper with _IRCSelfOper)
  _IRCPartChannel    Renamed: _IRCChannelPart (SCRIPT BREAKING! Fix: Replace _IRCPartChannel with _IRCChannelPart)
  _IRCPing           Renamed: _IRCServerPing (SCRIPT BREAKING! Fix: Replace _IRCPing with _IRCServerPing)
  _IRCPong           Renamed: _IRCServerPong (SCRIPT BREAKING! Fix: Replace _IRCPong with _IRCServerPong)
  _IRCSelfSetStatus  Added  : Sets you AFK and un-AFK
  _IRCSendMessage    Renamed: Renamed _IRCMultiSendMsg. (SCRIPT BREAKING Fix: Replace IRCSendMessage with IRCMultiSendMsg)
  _IRCSendMessageRaw Renamed: Renamed _IRCRaw (SCRIPT BREAKING! Fix: Replace _IRCSendMessageRaw with _IRCRaw)
  _IRCServerTime     Added  : Get time from a Server
  _IRCServerVersion  Added  : Get Software Version from a Server
  _IRCTopic          Renamed: _IRCChannelTopic (SCRIPT BREAKING! Fix: Replace _IRCTopic with _IRCChannelTopic)
  Improved Parameter detection in all Functions
  Renamed Functions to show who/what they effect, MASSIVE Script Breaking. Sorry! :/

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · April 28, 2014

Any feedback or requested features would be appreciated. It would help me decide what to put out sooner and what I can put off.

D00M4N · June 6, 2014

great !! , thx for your job

NobodyKue · July 2, 2014

That's great, thank you very much!

can you add something like "return userlist"? like an "/who" and after that it parses the server responses.

PhuongHieu · July 7, 2014

good work. thanks

rcmaehl · September 27, 2014

On 6/6/2014 at 8:28 AM, D00M4N said:

great !! , thx for your job

On 7/7/2014 at 3:12 AM, PhuongHieu said:

good work. thanks

Thanks for feedback!

On 7/2/2014 at 0:43 PM, NobodyKue said:

That's great, thank you very much!

can you add something like "return userlist"? like an "/who" and after that it parses the server responses.

Working on that. There's a possible issue if a message other than the response gets sent to the function before the actual response occurs. I'm working on away to solve this.

Also.

Updates:

.
  Example.au3        Added  : Checking for PrivMsg
                     Fixed  : Pings not ending with @CRLF
                     Fixed  : Infinite loop if you removed _IRCDisconnect
                     Updated: Bot now disconnects when receiving "!quit" instead of automatically
  IRCExtras.au3      Added  : _IRCStripSpecial(), Cleans special characters sometimes seen in IRC
  Discontinuted BETA UDF project.

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · September 28, 2014

Updates:

.
  IRC.au3            Fixed  : All functions now return when errors are encountered instead of continuing
  _IRCConnect        Added  : Now returns an error if optional password failed to send
                     Fixed  : Checking if Mode was blank.
                     Fixed  : Spamming of 0 and incorrectly thinking there was an error.
  _IRCGetMsg         Added  : Now returns an error if it failed to receive a custom amount of data
  _IRCServerVersion  Fixed  : Capitalized "Version"

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · October 15, 2014

Update:

.
  Example.au3        Added  : Shutdown TCP on exit
                     Fixed  : $Recipient now gets the actual Recipient instead of the 3rd message
                     Added  : Now exits when told to quit.
  IRC.au3            Added  : Improved Error Reporting (Includes @extended on error)
  _IRCDisconnect     Added  : Close Socket on Disconnect
  _IRCStripSpecial   Added  : Improved Color Stripping

Notes:

My main goal for the next version is to add in functioning user lists to the Example. While I could put this off to the user to figure out how to do this, It'd be more user-friendly to give an example of this. As such, I will be experimenting with multiple forms on github and will likely not push an update to the forums for some time, unless a bug is discovered in an existing function.

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · October 27, 2014

Thanks to >Manadar's TrayIRC it looks like I might be able to add in user lists by the end of next month. Channel list, a key part of user lists for when a nick changes, has been completed, but I'm still working on user lists.

Edited October 27, 2014 by rcmaehl

Hans15 · December 16, 2014

Hey rcmaehl,

very nice IRC udf you made i have request / question regarding it: is there a plan to implement SSL? Or could some1 with enough knowledge help me in adressing the SSL DLLs directly to create a SSL connect?

thanks and keep up the good work your doing

rcmaehl · December 18, 2014

Hey rcmaehl,

very nice IRC udf you made i have request / question regarding it: is there a plan to implement SSL? Or could some1 with enough knowledge help me in adressing the SSL DLLs directly to create a SSL connect?

thanks and keep up the good work your doing

There are plans to eventually add in SSL, however they're not anytime soon due to my lack of knowledge on how to use it.

Edited December 18, 2014 by rcmaehl

rcmaehl · December 20, 2014

Update:

.
  Example.au3        Added  : User lists
                     Added  : Channel lists
                     Added  : Bot keeps track of own nick
                     Added  : Secondary nick in case first nick choice is in use.
                     Added  : Extremely Minor performance improvements
  _IRCConnect        Added  : Improved parameter checking
  _IRCGetMsg         Updated: Now only retrieves one packet by default (MAY be script breaking)

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · December 21, 2014

Update:

.
  Example.au3        Fixed  : Nicks not updating on all channel lists when a user changed their nick
                     Fixed  : Nicks not deleting on all channel lists when a user quits the network

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

rcmaehl · January 15, 2015

Update:

.
  Example.au3        Fixed  : Ampersand channels causing a crash

Edited April 13, 2016 by rcmaehl
Reduce Post Size and Clean up Formatting

IRC UDF - Updated Version of Chips' IRC UDF - Release: V1.22 - 09/06/2016 - Technical Writer Needed!

Recommended Posts

Link to comment

Share on other sites

Top Posters In This Topic

Top Posters In This Topic

Popular Posts

rcmaehl

guinness

Hans15

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Create an account or sign in to comment

Create an account

Sign in

Recently Browsing 0 members

Similar Content