Eggdrop Irc Manager

[Akex]

Informations

Port of Velocd hacks here : https://vborg.vbsupport.ru/showthread.php?s=&threadid=61570

I needed this hack on my forum and I decided to share it with you

I didn't create any code, just modified it to suit vBulletin 3.5.x code, and added phrases to allow quick translation :).

Description

A script which report your channel activity on you forum homepage. It give informations about ops, halfops, voice, normal users, topic, channel activity.

It will put theses infos under whosonline row in forumhome. You can see on the demo (bottom of this post), that the informations are under navbar (will put it in next version).

All you need is an eggdrop : http://www.egghelp.org/ and a channel to scan :).

Installation

1 : Upload all files in forum root folder to your ftp (follow the folder hierarchy)

2 : Import the product in vBulletin (product-eggdrop_irc_manager.xml)

3 : Go to admincp > vBulletin Options > Eggdrop irc manager options and edit irckey.

4 : Edit ircrefresh.tcl, set the irckey (same as above), path of irconline.php, channel

5 : Upload ircrefresh.tcl to your eggdropt script forlder
For Eggdrop, usually "/home/{username}/eggdrop/scripts"
For Windrop, usually "c:\windrop\scripts"

6 : Modify your eggdrop conf, add "sources scripts/ircrefresh.tcl" at the bottom of the file

7 : Rehash your eggdrop (.rehash in dcc window in mirc)

8 : First things to do after installation :

First refresh your admincp :), then go to irc channels menu and set a new channel.


As a bot owner, type !refresh to manually refresh the channel. Type !startact to do the initial start of the activity timer. Both these commands should be performed when you first place your bot on the channel or after you rehash it when installing the script. You wont have to run these scripts again, unless your bot exits the channel.



Demos

http://forum.vbulletin-fr.org/

Support

Don't ask how to set up an irc channel (it's not the purpose of this topic)
Don't ask how to set up an eggdrop : http://www.egghelp.org/

Changelog

=============== 1.0.0.1 ===============

Adding of two options (Admincp > vBulletin Options > Eggdrop irc manager)
Irckey : Do not need to edit irconline.php anymore, just set the key in admincp
Irc informations position : You have now 4 diff?rent positions (Not sure it works if you edited FORUMHOME template) : Below navbar, above forum, below forum, below who's online.Bug fix :
Template caching
Alteration of FORUMHOME template in plugin (forgot to put the code in ...) try to remove FORUMHOME modifcations you made with this script and test 'Irc informations position' option :).** Don't forget to click install ;)

[Akex]

No need of template modifications as I created a plugin which modifies the forumhome template.

If you can't manage to get the forumhome template edited do this :

Template forumhome :

Find :


<!-- end logged-in users -->


Below add :


<!-- start logged in IRC -->

$irc_channels

<!-- end logged in IRC -->'

[Hoffi]

Ah... So I do not need to release my Port I just wanted to do yet. ;)

[bang]

if your port has any additional features, please release it! :)

[Akex]

You can be sure I will do it.

[XanTrax]

Apparently dreamhost doesnt allow an eggdrop on their hosting. Can anyone else confirm this?

[soulface]

aaahhhhh, been waiting for this...

* soulface installed & working gr8

Just need to fix this :p

Page generated in 0.53140 seconds with 44 queries (1 queries for uncached templates) [Server Loads: 0.15 0.15 : 0.10]
Uncached templates: irc_loggedin (1)

<plugins>
<plugin active="1" product="vbulletin">
<title>Cache irc_loggedin</title>
<hookname>cache_templates</hookname>
<phpcode><![CDATA[$globaltemplates = array_merge($globaltemplates, array('irc_loggedin'));]]></phpcode>
</plugin>
</plugins>

[PitchouneN64ngc]

More simple to include this plugin in the style_fetch hook with this code:

$globaltemplates[] = 'irc_loggedin';

Akex, I've put this modification on vbulletin-fr.org, you can get in from there :)

[Akex]

Well, I just forgot to put this :/, I wanted to but as lot of stuff do to, I forgot.

Will fix it in the next version :).

[Akex]

New version : 1.0.0.1 see the changelog above :).

[soulface]

hmmmm Below navbar & below forum working but above forum & below who's online not working... :/

[Akex]

As it works for me, I thinks it's because the html code searched (for replacement) is not in the FORUMHOME template.

I put here the list of searched strings :

Below the navbar : $navbar

Above the forum : <!-- main -->

Below the forum : <!-- what's going on box -->

Below who's online : <!-- end logged-in users --></if>

[soulface]

hmm thx akex, my forumhome templates is heavy modified, so had to fix this things, but 1 thing i couldnt make it work is bellow who's online. so just edit in plugins area from $search = '#<!-- end logged-in users -->\s*?"\) : \(""\)\)\\."#';
to
$search = '#<!-- end logged-in users -->#';.
now its working in all area :p

[Akex]

OK, good to read that :).

[Reef]

I don't understand the channel setup and probably am trying the wrong things.. The info for the eggdrop is done and running however I can't figure out how to connect to it..

Could someone please give me an example of the correct info/format to put in the below options?

Handle #
Server

Thanks

[Akex]

Eg.

Handle : #vborg
Server : irc.vbulletin.org

[Reef]

Thanks for the reply

So is Handle actually the room name then?

I just can't figure out how it connects to the proper room and the bot itself in the room...

[Akex]

It doesn't connect to the room. The Eggdrop sends a http request to irconline.php with informations as url arguments.

[Man1c M0g]

WHOA! I've been looking for a conversion of VeloCD's hack for MONTHS! Many thanks m8 - you are my hero of the moment! :D

[El_Muerte]

I can't get it to work. It updates the channel title, but not the activity or the users.

[Akex]

Ok I forgot to put in my first post the first things to do after install ...

I update it ...



As a bot owner, type !refresh to manually refresh the channel. Type !startact to do the initial start of the activity timer. Both these commands should be performed when you first place your bot on the channel or after you rehash it when installing the script. You wont have to run these scripts again, unless your bot exits the channel.


Try that :), It should work then.

[El_Muerte]

ok fixed it... halfops wasn't supported

[JaniU]

My egg is working ok and it is sending information to the irconeline.php, so the IRC part whould be just fine. I just can't get this to show anything in the forum. It does not change the FORUMHOME template for whatever reason so I have been trying to add that $irc_channels in various places in the FORUMHOME, but nothing shows up. I don't get any errors either.

Any ideas??

----

Okey I got it working :)
Funny thing, I never logged out from admin after importing the product and stuff. So it never gave me the menu where to set the channel. So I had not done that and I realized it from looking at the screen shots. Perhaps it should say in the instructions, for us dummies, that you might need to logout and login to get all the new menus :)

[DragoZERO]

Apparently dreamhost doesnt allow an eggdrop on their hosting. Can anyone else confirm this?

Yeah.. I just sent a support ticket in like 20 minutes ago and I had this reply:

Hello,

On Fri, 17 Mar 2006, you wrote:

> I would like to inquire about the current policy of using IRC bots to
> report channel stats to a forum. Thank you.
>

Sorry, such processes are prohibited on our shared webservers.

James

[Akex]

My egg is working ok and it is sending information to the irconeline.php, so the IRC part whould be just fine. I just can't get this to show anything in the forum. It does not change the FORUMHOME template for whatever reason so I have been trying to add that $irc_channels in various places in the FORUMHOME, but nothing shows up. I don't get any errors either.

Any ideas??

----

Okey I got it working :)
Funny thing, I never logged out from admin after importing the product and stuff. So it never gave me the menu where to set the channel. So I had not done that and I realized it from looking at the screen shots. Perhaps it should say in the instructions, for us dummies, that you might need to logout and login to get all the new menus :)

Ok I will add it ;)

[Necron]

For thoes who don't allow guests to view anything,

open irconline.php, find
require_once('./global.php')
and replace with
require_once('./includes/init.php');

should fix it

[mikeylikesitz]

i cant get this to update. bot is running timer and updating to me in dcc, but no update on forumhome. any ideas?

[Akex]

Did you put the correct url in ircrefresh.tcl ?

[mikeylikesitz]

yes, it has to be something i missed, but i cant see what.

[Akex]

You have to set : in ircrefresh.tcl : the url, the key also (has to be the same than the one defined in admincp/vBulletin Options/eggdrop irc manager options) ...

[mikeylikesitz]

yes, they are all set and everything matches

[El_Muerte]

[feature request]
Add an irc channel setting to ignore a set of usernames.

[Akex]

yes, they are all set and everything matches

Maybe the http module is not loaded ... which version of eggdrop do you use ?


[feature request]
Add an irc channel setting to ignore a set of usernames.


I was thinking about it :), as I don't want my eggdrop username to be displayed.

[mikeylikesitz]

eggdrop v1.6.17: I havent thought to look to make sure the http module isnt loaded, ill look thru the config and check.

Edit: i dont have the http module, do you have a link to one to use?

[Akex]

eggdrop v1.6.17, http is loaded with the eggdrop, so it's not the problem :(.


In irconline.php

under

require_once('./global.php');

Add this :

$tmp = fopen("ircdebug.txt", "a");
fwrite($tmp, $_POST['activity']);
fclose($tmp);

It's just for debug purpose.


Then write !startact, and live your channel. This action will make the eggdrop call the irconline.php.

Then look at ircdebug.txt on your ftp and see if it exists and something written in it :).

[mikeylikesitz]

are we sure it loads with eggdrop? any other ideas?

[Akex]

Try the file modification I put above and say me if something is created (it should take some minutes to refresh and write in the file).

[mikeylikesitz]

i dont see that it created a debug file anywhere. I have the irconline.php file in my forum root dir and the ircrefresh.tcl in my bot scripts dir just to give you an idea of where im at

[Akex]

It seems ircrefresh.tcl can't call irconline.php :(. Can't do anything about that.

[mikeylikesitz]

hmm, i dont see any reason it cant. its a dedicated server with the bot runing from my /home and the www running from apache on same machine, there isnt any blocking that im aware of.

[mikeylikesitz]

anyone else have this issue?

[Sooner95]

Thank you!

installed

[XanTrax]

Ok for some reason its all up to date, the eggdrop is calling the file and giving me the info I need. For some reason though it wont print stuff on my forum home, it prints fine in the adminCP and shows everything there including the topic and everything. Ive added the $ircchannels or whatever it was to the forumhome and the header and other places to get it to show and it doesnt show still. Any ideas for why it wont show on my forum home?

[XanTrax]

Bump, anyone else have this problem of it not displaying?

[mikeylikesitz]

seems you and i are in the same boat, im having the same issue

[Akex]

Ok for some reason its all up to date, the eggdrop is calling the file and giving me the info I need. For some reason though it wont print stuff on my forum home, it prints fine in the adminCP and shows everything there including the topic and everything. Ive added the $ircchannels or whatever it was to the forumhome and the header and other places to get it to show and it doesnt show still. Any ideas for why it wont show on my forum home?

Maybe you can give your website url to see how the product shows on forumhome ...

[XanTrax]

It doesnt show at all on the forum home. Whether I select the location in ACP or place it myself manually it doesnt show.

www.vacdisabled.net

Is my site.

[Akex]

If it doesn't show on forumhome, it means that you did not add a channel in ACP.

[XanTrax]

Like I just said I did add a channel and it shows up in the AdminCP below the add a channel thing. It doesnt show on forumhome.

This is in ACP under the IRC Channels => Manage options....


Handle Server Topic Activity Online Online max Date of max Users Edit
#vacdisabled irc.vacdisabled.net [-?-] #vacdisabled - For anyone and everyone of VAC Disabled ? ? ? ? Idle #cheatsupport if you need help with cheats ? Idle #coding for programming - http://208.98.35.152:10220/ irc stats [-?-] 36 40 03-25-2006 @c0re, @Deft, @Jimz0r, @Nick, @scanner-vd, @sexy+++++, @Skynster, @VACDisabled, @wm0t, %SilverNoma, {%[Private]hOmEbOy-JeSuS}, +derek48838, +Dread`Knight, +dugb0t`sleep`kik, +Elettro_AFK, +invision620, +Khan, +Kris, +Mich, +mohtiv, +p1v, +phoe, +sfx, +Shawn, +siN, +SqWaw, +srdeuss, +^Styles^, {+Diger[a]ti}, {+[-RxP-]Amu}, {+[-RxP-]Killer-Orange}, {+[-RxP-]Tr0y[aKa]TriLL}, {+[2x]5yph3r}, An7hrax, CrazyLord, mind-friend



Which is my IRC channel, all the users on it, and the correct status and yet it still will not show.

[Kacela]

Ok for some reason its all up to date, the eggdrop is calling the file and giving me the info I need. For some reason though it wont print stuff on my forum home, it prints fine in the adminCP and shows everything there including the topic and everything. Ive added the $ircchannels or whatever it was to the forumhome and the header and other places to get it to show and it doesnt show still. Any ideas for why it wont show on my forum home?I was having the same problem until I went through and found the code I needed to add to each of my skins FORUMHOME template:Template forumhome :
Find :<!-- end logged-in users -->
Below add :<!-- start logged in IRC -->

$irc_channels

<!-- end logged in IRC -->

[Akex]

you may mean "don't include the trailing ;" :). I edit my instructions as I did not notice this mistake.


You didn't have to read the code to find this :). As I said, if template auto edit doesn't work, edit forumhome template like said on this post :

https://vborg.vbsupport.ru/showpost.php?p=925075&postcount=2

[XanTrax]

Tried that...Still wont work.

[XanTrax]

Ok got it working. I guess it just needed to wait for it to refresh and get the info before it actually printed everything. Thanks for all your help.

[jancarlo]

Thank you! Installed.

A problem, if I close the usergrup not loged and not register, “Can View Forum” does not modernize the list to me user.

jancarlo

[dookie]

Very nice, *installed* :)

When a user has ] or/and [ in his nickname, it shows the brackets { }.
Any ideas?

https://vborg.vbsupport.ru/

[Royalridge]

Very nice, *installed* :)

When a user has ] or/and [ in his nickname, it shows the brackets { }.
Any ideas?

http://dookie.devinity.de/pic/ircrefresh.jpg
It's to do with the way TCL (the scripting eggdrop uses) handles escaping characters. Rather than doing something like \[ to show a bracket it wraps the whole string in braces {}

[dookie]

Got it :)

Search
if {[onchan $user $chan]} {
incr num_users

if {[isop $user $chan]} {
lappend ops "@$user"
} elseif {[ishalfop $user $chan]} {
lappend halfops "%$user"
} elseif {[isvoice $user $chan]} {
lappend voiced "+$user"
} else {
lappend normal $user
}
}

And replace it with:
if {[onchan $user $chan]} {
incr num_users

if {[isop $user $chan]} {
append ops "@$user "
} elseif {[ishalfop $user $chan]} {
append halfops "%$user "
} elseif {[isvoice $user $chan]} {
append voiced "+$user "
} else {
append normal "$user "
}
}

[Snatch]

I use eggdrop 1.6.18 since one day. Now he shows me on the Forum the Topic of the chan but not the Users.

Can U halp plz?

[Snatch]

Does this hack run in 3.6.2 ?

[Cocko]

Does this hack run in 3.6.2 ?

anybody tried for 3.6.x ?

[prawn]

Works like a charm on 3.6.4. Any ideas how to fix the special chars being displaced correctly? Ä, ö, ü, etc.

[HondaATC]

Hey guys I'm having a little bit of a problem. I got the eggdrop all setup and configured, added the script to its config file. I changed the settings in the Administration panel, but when I type in my IRC server, chat.3wheelerworldforums.com its cutting off the .com I guess because its so long. Consequently, my stats on the index are not updating or even showing anything other then zero. I'm using 3.6.5 Any help would be really appreciated.

[HondaATC]

Well the stats seemed to have fixed themselves (refresh period perhaps or something?) But My server name is still to long to be displayed on the forum. Not a big deal though.

Thanks for the most excellent mod that does infact work with the 3.6 series :D


edit: The only other thing I did notice that isn't working, is the activity bar. You can check it on my homepage http://www.3wheelerworldforums.com

[JohnBee]

Installed(thanks).

It looked like it's working but I have to admit it wasn't easy getting this mod to work on a local testserver /windrop. Took about 2 hours of tinkering and adjusting to get it going.

Problems encountered were as follows:
---------------------------------------------------------------
1. Install says to add "sources scripts/ircrefresh.tcl" to eggdrop.conf
Windrop uses "source scripts/ircrefresh.tcl" command instead
2. Windrop http package wasn't configured to load.
Copied http.tlc from X:\Windrop\lib\tcl8.4\http2.5\ to \Windrop\scripts and added the line source scripts/http.tcl in eggdrop.conf before source scripts/ircrefresh.tcl from step 1.

3. Configured Eggdrop IRC Manager Options under vBulletin Options but failed to see the new IRC Channels Manager in the ACP menu listing(did not refresh after product install)

4. Rehashing the bot failed to load script. Issued DCC .restart command instead.

5. Changed the channel title and forumhome finally displayed stats

Hope this helps someone.

[JohnBee]

PS. installed and running on


vBulletin 3.6.8
Conference Room 2.4
Windrop 1.6.18

[JohnBee]

Well the stats seemed to have fixed themselves (refresh period perhaps or something?) But My server name is still to long to be displayed on the forum. Not a big deal though.

Thanks for the most excellent mod that does infact work with the 3.6 series :D


edit: The only other thing I did notice that isn't working, is the activity bar. You can check it on my homepage http://www.3wheelerworldforums.com
Exact same problems here(sadly)

My server url/ port is to long and thus truncated by the script.
The stats activity meter doesn't work.

I don't know why but ever since the eggdrop addon's came about for vbulletin, they have always been subject to buggy operation and sparse support.

[JohnBee]

Well the stats seemed to have fixed themselves (refresh period perhaps or something?) But My server name is still to long to be displayed on the forum. Not a big deal though.

Thanks for the most excellent mod that does infact work with the 3.6 series :D


edit: The only other thing I did notice that isn't working, is the activity bar. You can check it on my homepage http://www.3wheelerworldforums.com
I found a way to fix the truncated server name. The max character limit is set to 25 in the product, so we can adjust that to whatever we like. Unfortunately, I was not able to make the changes within the loaded product/plugin templates so I had to uninstall and re-install the product in order for the changes to take effect.

Here is the edit:
Open product-eggdrop_irc_manager.1.0.0.1.xml in a script compliant editor(I used Dreamweaver) and find the line(usually 12):
server varchar(25) NOT NULL default '',
Change the (25) to (30) or something higher. Save and re-import the product and the max character value for that field will be longer.

Hope this helps.

[JohnBee]

I have a question...

In the event that a forum has guest forum permissions turned off, the eggdrop cannot access the irconline.php file(forum permission). Is there a way to move irconline.php to higher dir level on the server and what needs to be changed in order to do that?

[HondaATC]

Hey John, did you end up with the problem I was/am having on the activity meter never changing? I poked around inside the product file numerous times looking to see if I could edit the values to perhaps lower them, but I never did see anything. I don't think its the character limit, because I ended up using just the IP address for my server instead. I don't have the answer to your question about irconline.php, sorry :(

[Floris]

Will there be a re-release for 3.7 ?

[HondaATC]

I hope so, cause this mod a lone might keep my from upgrading if there isn't.

[Ingress]

I'd also be interested in an update for 3.7.x.

Ingress

[reesev]

this works fine for 3.7

[tweakmonkey]

Great mod!
Works fine for me with 3.7.2 and eggdrop 1.6.18. It took a few minutes to show who was in there but works fine now.

One question: Can you show the who's chatting dialog on other template pages? I tried $irc_channels but it does not show anything except on forum_home. Any suggestions?

EDIT - I just changed the hook position to global_start for now to make this work.

One problem I'm seeing is it says "Array" as a member in the list. Like:
Topic: robots are cool, but so are sponges
@mattdev, @tweakmonkey, @Voltron, Array, Array, juballharsha

EDIT 2 - In case anyone else had this problem, I fixed it by editing the Plugin called [Eggdrop IRC Manager]forum template alteration:
$replace = '<!-- start logged in IRC -->

$irc_channels

<!-- end logged in IRC -->';

switch ($vbulletin->options['eim_location']) {

case 1:
$search = '#\$navbar#';
$replace = '\\0 ' . $replace;
break;

case 2:
$search = '#<!-- main -->#';
$replace .= ' \\0';
break;

case 3:
$search = '#<!-- what\'s going on box -->#';
$replace .= ' \\0';
break;

case 4:
$search = '#<!-- end logged-in users -->\s*?"\) : \(""\)\)\\."#';
$replace = '\\0 ' . $replace;
break;
}

$vbulletin->templatecache['FORUMHOME'] = preg_replace($search, $replace, $vbulletin->templatecache['FORUMHOME']);

/////////// Eggdrop IRC Manager - By Velocd ///////////
/////////// Ported By Akex ///////////


$channels = $db->query_read("
SELECT *
FROM " . TABLE_PREFIX . "irc_channel
");

while ($channel = $db->fetch_array($channels))
{
$nick_style = explode('||', $channel['nick_style']);

$ops = explode(' ', $channel['operators']);
$halfops = explode(' ', $channel['halfops']);
$voiced = explode(' ', $channel['voiced']);
$users = explode(' ', $channel['users']);

if (!empty($ops[0]))
{
foreach ($ops AS $op)
{
if ($op != "Array")
$channel['nick_list'] .= str_replace('{nick}', $op, $nick_style[0] . ', ');

}
}

if (!empty($halfops[0]))
{
foreach ($halfops AS $halfop)
{
if ($halfop != "Array")
$channel['nick_list'] .= str_replace('{nick}', $halfop, $nick_style[1] . ', ');
}
}

if (!empty($voiced[0]))
{
foreach ($voiced AS $voice)
{
if ($voice != "Array")
$channel['nick_list'] .= str_replace('{nick}', $voice, $nick_style[2]) . ', ';
}
}

if (!empty($users[0]))
{
foreach ($users AS $user)
{
if ($user!= "Array")
$channel['nick_list'] .= str_replace('{nick}', $user, $nick_style[3]) . ', ';
}
}

$channel['nick_list'] = substr($channel['nick_list'], 0, -2);

if ($channel['activity'] > 40)
{
$channel['alevel'] = 5;
}
else if($channel['activity'] == 0)
{
$channel['alevel'] = 0;
}
else
{
$channel['activity'] = $channel['activity']/8;

$channel['alevel'] = round($channel['activity']);

if ($channel['alevel'] < 1)
{
$channel['alevel'] = 1;
}
}

$channel['aname'] = $channel["act$channel[alevel]"];

$channel['online_max'] = number_format($channel['online_max']);
$channel['online'] = number_format($channel['online']);

$channel['date_max'] = vbdate($vbulletin->options['dateformat'], $channel['dateline_max']);
$channel['time_max'] = vbdate($vbulletin->options['timeformat'], $channel['dateline_max']);

eval('$irc_channels .= "' . fetch_template('irc_loggedin') . '";');

unset($channel['nick_list']);
}


//////////////////////////

To check to see if the array was blank and only contained "Array", I added:
if ($user!= "Array")
if ($op!= "Array")
if ($halfop!= "Array")
if ($voice!= "Array")

[tweakmonkey]

Another feature I wanted was to have the topic being shown on my site automatically link URLs, since they are often used in IRC topics.

To do this, edit the [Eggdrop IRC manager]Forumhome template alteration in the Plugin and Plugin Manager in the control panel.

Find the line:
$channel['dateline_max']);

Below it add:
$channel['topic'] = preg_replace('@(https?://([-\w\.]+)+(:\d+)?(/([\w/_\.]*(\?\S+)?)?)?)@', '<a href="$1" target="_blank">$1</a>', $channel['topic']);

[Raptor]

I have it working - shows on forumhome also

Only have 2 problems so far

Topic isn't showing

Activity Graphic isn't changing

Suggestions ?

Other than that its working great on vb 3.8.4 PL2

[HondaATC]

I never got the activity graphic working for my setup. The topic does refresh after a while. You need someone to leave/rejoin for it to change if I remember correctly.

[Raptor]

Yep I got the Topic sorted (just had to change it in the channel)

Everything works now except the Activity Graphic.

[Warnink]

Unfortunately this has stopped working for vb4, would anyone be willing to make it compatible again as it was a great addition to our board, I'd do it myself but I wouldn't know where to start.

Also for the people having trouble with the acivity graphic, you need to put the images in the images folder of your style then they'll show up just fine.

[HondaATC]

I could definitely use this on my 4.0 site too. I could make it. Work if I had enough time to gmess with it.