[REL] IRC plugin v1.1 (with filterscript)

[Jacob]

Cross-compatible IRC plugin v1.1
With this plugin, you can connect to, send and receive messages to and from IRC servers!

New features of 1.1

• Dozens of bugs resolved, server crashes fixed
• Supports multiple connections at the same time (upto 5)
• Properly supported as a filterscript
• New native ircGetUserLevel will get any user's level (~, @, etc) in any joined channel
• New native ircGetUserList will get the entire userlist of any joined channel separated by spaces
• New native ircSendRawCommand will send any raw IRC command to the server, giving you complete control
• Callbacks are now called properly (from the same thread), circumventing the majority of Linux crashes

How to install
First, download the package from the link at the bottom of this post.  You may either compile the project yourself (I have provided makefiles for both windows and Linux) or use the already-compiled libraries in the plugins directory.

• Plugin: copy irc.dll (or irc.so if you're on Linux) to your /plugins directory.
• Include: copy a_irc.inc to your /pawn/includes directory.
• Example filterscript: copy ircFS.amx and ircFS.pwn to your /filterscripts directory.

How to use

• Natives: these are functions you can call from PAWN.
  
  • ircConnect(server[], port, user[]) - connects to an IRC server. This will return a connection ID.  You will use this ID as the first parameter of all the other natives. Password parameter was removed in 1.1.
  • ircSay(connection, channel[], message[]) - sends a message to an IRC channel.
  • ircJoinChan(connection, channel[]) - joins an IRC channel.
  • ircPartChan(connection, channel[]) - parts a joined IRC channel.
  • ircGetUserList(connection, channel[], dest[], size) - places the userlist of the requested channel into 'dest' parameter
  • ircGetUserLevel(connection, channel[], user[], dest[]) - places the user level of the requested user into 'dest' parameter
  • ircSendRawCommand(connection, cmd[]) - sends a raw command to the IRC server (i.e: 'NICK :jacob123' will change your bot's name to jacob123
  • ircSetMode(connection, channel[], modes[], users[]) - set channel modes (providing server is an op)
  • ircDisconnect(connection) - disconnects from the requested IRC server (must use connection ID
  • ircPollEvents() - you must call this function every 500ms if you want the callbacks below to be executed. See example filterscript.

• Callbacks: these are functions called by the plugin.
  
  • ircOnConnect(connection) - called when a connection is established.
  • ircOnUserSay(connection, channel[], user[], message[]) - called when a user says something in an active channel.
  • ircOnUserPart(connection, channel[], user[]) - called when a user parts an active channel.
  • ircOnUserJoin(connection, channel[], user[]) - called when a user joins an active channel.

1.1 release notes

• 1.1 uses callbacks in a totally different way that has resolved crashes. For you to take advantage of the new callback system, you must call the native ircPollEvents in a 500ms timer.  See the example filterscript.
• The password parameter from 1.0 has been removed in 1.1 due to a crash it was causing.  To identify your bot with NickServ, use ircSendRawCommand.  See the example filterscript.
• When calling ircGetUserLevel, the size of dest[] must be 4.  The following levels are supported by the plugin:
  • ~ owner
  • @ op
  • & admin
  • % halfop
  • + voice
  • - normal user

Download 1.1

• Complete package mirrored by Towlies (dev.sa-mp.com is down)
• Complete package mirrored by Towlies (secondary mirror)
• Windows plugin only irc.dll
• Linux plugin only irc.so
• Browse the 1.1 source using Trac
• Example PAWN filterscript that makes use of this plugin

[Nissandrifter]

Nice script. I was wondering, is it possible whether to make it detect whether the person in the IRC channel has an admin status or higher. Cause I was thinking of adding stuff like .ban and .kick, and I dont really want anyone to be able to use them commands

[Sneaky!]

aw nice script ya got there

[Jacob]

Nice script. I was wondering, is it possible whether to make it detect whether the person in the IRC channel has an admin status or higher. Cause I was thinking of adding stuff like .ban and .kick, and I dont really want anyone to be able to use them commands

It is now!  I have updated both the Windows and Linux IRC libraries with the following PAWN natives:

• ircIsOp(channel[], user[]) - returns true if user is an op in the specified channel.
• ircSetMode(channel[], modes[], users[]) - set channel modes (providing server is an op)

I have also added Nickserv compatibility. This means the 'password' parameter of ircConnect can also identify you with Nickserv!

[Ramjet.]

Very nice Jacob!

I can already see a new era of SA-MP IRC Echo tools .

Cheers,
Ramjet.

[yom]

Nice work! thanks i will test it and learn from it

[Boylett]

I was trying to make one of these but couldnt work out how to use strtok in C++ (and my reference site went down). Well done

[The Azer]

Very nice Jacob this is a good example of how plugins are a great addition to SA:MP <3

[Sypher]

The Plugin-man strikes again. Nice! I turned it into a filterscript for easy editing, and it works perfectly.
It connects really fast.

I'd like to request some expanded functionality, if possible: sending & receiving private messages.
Do you think that's possible? It would be really useful
I saw some of the code already in your plugin but its currently not in a_irc.inc..

Also, getting the IRC userlist into an array would be a nice feature as well.

[Static]

I was trying to make one of these but couldnt work out how to use strtok in C++ (and my reference site went down). Well done

I know I probably shouldn't but http://www.cplusplus.com/reference/clibrary/cstring/strtok.html

Nice work jacob, will come in useful for a number of reasons.

[Jacob]

I'd like to request some expanded functionality, if possible: sending & receiving private messages.
Do you think that's possible? It would be really useful

It's already possible; using ircSay, you can also send private messages to users.  Just insert the username as the channel[] parameter and you're good to go.  This is the same case for ircOnUserSay.

Server admins: previously, using format() in ircOnUserSay would be dangerous as users could crash the server by typing the % character.  This has been fixed in the Windows version, please re-download! I will update the Linux library tomorrow when I have more time. (6/02/07)

[Simon]

Woah. Awesome, easy to set up and easy to use. I'm gonna have a good fun with this .

[d.wine]

Amazing! First nice plugin I see.

[MaXx001]

Really nice plugin! Easy to use and  it just works!

I have one question: How do i send commands?

if i send "/join #meh" with ircSay then it is just displayed as a message and is not registered as a command.

Maybe an ircCommand(channel[], command[]) would do the trick

[Simon]

Maybe an ircCommand(channel[], command[]) would do the trick

Yes, something like that would be nice.

Also things like in mIRC when you can type /msg %#chan and it will send the message to halfops and higher (without beeping).

Maybe a ircIsLevel(channel[], user[], level); or maybe even a ircGetLevel(channel[], user[]) to check if a user is a certain level.