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

[mLipok]

You should learn more about using #include

In your case you should use:

#include "IRCConstants.au3"

instead:

#include <IRCConstants.au3>

 

[TheDcoder]

Nice catch @mLipok, I forgot to post that here.

[rcmaehl]

22 hours ago, mLipok said:

Here is little refactored function:
 

Func _IRCChannelInvite($_vIRC, $_sUser, $_sChannel)
    Select ;Parameter Checking, Trust No One
        Case $_vIRC = ""
            Return SetError(1, 1, 0)
        Case $_vIRC = -1
            Return SetError(1, 2, 0)
        Case $_sUser = ""
            Return SetError(2, 1, 0)
        Case StringInStr($_sUser, " ")
            Return SetError(2, 2, 0)
        Case $_sChannel = ""
            Return SetError(3, 1, 0)
        Case Not $_sChannel = ""
            Switch AscW(StringLeft($_sChannel, 1))
                Case Not 33 And Not 35 And Not 38 And Not 43
                    Return SetError(3, 2, 0)
            EndSwitch
        Case StringInStr($_sChannel, " ")
            Return SetError(3, 2, 0)
    EndSelect
    
    TCPSend($_vIRC, "INVITE " & $_sUser & " " & $_sChannel & @CRLF)
    If @error Then Return SetError(4, @error & @extended, 0)

    Return 1
EndFunc   ;==>_IRCChannelInvite

---

Func _IRCChannelJoin($_vIRC, $_sChannels, $_sKeys = "")
    Select ;Parameter Checking, Trust No One
        Case $_vIRC = ""
            Return SetError(1, 1, 0)
        Case $_vIRC = -1
            Return SetError(1, 2, 0)
        Case $_sChannels = ""
            Return SetError(2, 1, 0)
        Case StringInStr($_sChannels, " ")
            Return SetError(2, 2, 0)
    EndSelect

    If Not $_sKeys = "" Then $_sKeys = " " & $_sKeys
    TCPSend($_vIRC, "JOIN " & $_sChannels & $_sKeys & @CRLF)
    If @error Then Return SetError(3, @error & @extended, 0)
    
    Return 1
EndFunc   ;==>_IRCChannelJoin

---

Try to refactor the other ones.

 

 

---

Why you are using @error & @extended ?

If @error Then Return SetError(3, @error & @extended, 0)

This is strange to me.

This is strange also because TCPSend not setting @extended (according to HelpFile).

 

I've been using both to try to future proof anyone having errors with my functions. I originally had tried @error & " - " & @extended but SetError strips out non-numerals. Will add code improvements by tomorrow (Sunday EST time)

[TheDcoder]

Ah, yes, @error and @extended can only be numbers, something which I recently learned .

[rcmaehl]

22 hours ago, mLipok said:

You should learn more about using #include

In your case you should use:

#include "IRCConstants.au3"

instead:

#include <IRCConstants.au3>

 

You'll have to forgive the double reply, the mobile AutoIt forums aren't as friendly as I'd like. Anyway, I originally had it that way but tried to future proof it towards inclusion into AutoIt. Hence, the install instructions on the GitHub.

[guinness]

28 minutes ago, TheDcoder said:

Ah, yes, @error and @extended can only be numbers, something which I recently learned .

Help states this

[TheDcoder]

@guinness Yup, that is where I got to know.

[rcmaehl]

@mLipok

Current UDF function returns are based off

I might revert them as they'd give a slight performance improvement by returning the script from the function a little earlier.

[mLipok]

@Mat answer is 3,5 year old.
I'm curious what he think now about this old answer, and about my statement:

---

7 hours ago, rcmaehl said:

hey'd give a slight performance improvement by returning the script from the function a little earlier.

This is true.
But this is also easier to understand the code. You do not must go throught entire function code to see whats happend next.
Also debuging is much easier as you do not must to check if any other function line not changing @error @extended 

mLipok

 

[rcmaehl]

Looking for feedback

Survey: What data would you like to see returned when a function is successful?

Edited August 26, 2016 by rcmaehl

[TheDcoder]

7 hours ago, rcmaehl said:

Survey: What data would you like to see returned when a function is successful?

When I visited that page:

Quote

Welcome to: poll.me

This Web page is parked for FREE, courtesy of GoDaddy.com.

 

[rcmaehl]

On 8/24/2016 at 0:08 AM, TheDcoder said:

When I visited that page:

 

WHOOPS. It only copied half the URL. Fixed

[TheDcoder]

Well... All 3 votes for " The number of bytes sent"

[rcmaehl]

2 minutes ago, TheDcoder said:

Well... All 3 votes for " The number of bytes sent"

I'm actually kinda relieved, It's the easiest to implement, but I'll be leaving the poll up for another week or two.

Edited August 26, 2016 by rcmaehl

[TheDcoder]

2 minutes ago, rcmaehl said:

I'm actually kinda relieved, It's the easiest to implement

The hardest would be the "next" packet I guess?

[rcmaehl]

18 minutes ago, TheDcoder said:

The hardest would be the "next" packet I guess?

Yep, slightly more difficult because of having to deal with adding more error checking.

Edited August 26, 2016 by rcmaehl

[TheDcoder]

1 minute ago, rcmaehl said:

Yep, slightly more difficult because of having to deal with adding more error checking.

Yup .

[rcmaehl]

Will be removing the poll on the 7th. Current results are 4 for Number of bytes sent, zilch everything else. I've drafted an update version of this UDFs and put it on a separate branch on github. If it's still the leader on the 7th I'll merge the branch.

 

Also upcoming is proper message length limitations (360 characters) after setting the maximum length of the values the receiver would see, based on this article plus RFC2812 commands. I'm working on improving calculations of this function to allow slightly longer messages based if the length of those values is at the maximum or not.

Edited September 5, 2016 by rcmaehl

[rcmaehl]

Update:

.
  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

 

Edited December 15, 2017 by rcmaehl

[TheDcoder]

Nice! I am working on my IRC UDF too, expect a update from me soon .