Forum Home Enhancements - TSxView: simple live viewer for Teamspeak 2 & 3

++++ ATTENTION! ++++++++++++++++++++++

This mod is outdated and has been replaced with an advanced version, covering more features: https://vborg.vbsupport.ru/showthread.php?t=264573

Because the mod has been completely rewritten, this isn't considered a simple "update".
Please install the new mod as I won't offer any more support for this one.

+++++++++++++++++++++++++++++++++++




[Old version:]

Welcome everyone!

You can find here a simple Teamspeak online-viewer for your forum.
You don't have to edit core files, just a small plugin file with a php libary and everything should work fine.

If you want to have an overview about how it's looking in the end, check out the screenshots included with this post.

The vBulletin 3.8.x Version of this mod is located here.



INFO
====

Current Version: (please report bugs, issues and any other feedback)
Author: Andreas Rudolph <radon@ggmj.de> (aka Radon)

This is a vB 3 / 4 Plugin with a simple who-is-in-teamspeak box.
Tested with:
- TS2
- TS3 Beta 9
- vBulletin 4.0.0
- vBulletin 3.8.2


ADDITIONAL FILES
================

There are two libaries included with this script which are necessary for php-sided teamspeak query.
You don't need both files, if you're using one teamspeak version only.

ts2status.php by Guido van Biemen (aka MrGuide@NL)
ts3status.php by Sebastien Gerard <sebeuu@gmail.com>


INSTALLATION
============

Extract the archive and upload the libary files into "/forum/includes/" directory.
Install the correct plugin xml file in your vBulletin ACP.
If you are updating, make sure to allow overriding of previous plugin versions.


UPGRADING
=========

To upgrade the plugin, proceed as you'd install a new product by navigating to the
"Plugins & Products -> Manage Products" group and klick "[Add/Import Product]"
Choose the pluginfile for your vBulletin version and make sure to check "Allow Overwrite" before
you import the updated plugin.

If you have problems after upgrading the plugin, write down your plugin's settings, un-install the
addon and install it again.

If you made any changes to the templates, the template records will not be deleted!
After the installation you'll have to re-enter your configurations, because these won't be saved!


CONFIGURATION
=============

By default the plugin is disabled in its options to prevent error warnings.
You can access the configuration by "Settings -> Teamspeakx Viewer".
After you entered the correct information, you can enable the viewer with the first option.

The most important settings:

- Enable / Disable TSxViewer:
This should be enabled for the actual plugin to work. Make sure to enable it *after* you
configured your plugin.

- Teamspeak Version:
If you want to query a TS2 server, switch this to "NO", otherwise leave it to "YES".

- Server IP:
Simply enter the IP, you're using to connect to your teamspeak server.

- Teamspeak 2 Port:
If you're using Teamspeak 2, you have to specify the connection port. This is important,
because if more virtual servers are running on the same machine, this port is used to
identify the correct server and it's used to display a Join link so user can connect through
your forum.
This is the port number you use in your Teamspeak 2 application behind the IP.
If you're using this ip in your TS2 Connection window: "123.123.123.123:8767", your TS2 port
is "8767".
If you're using Teamspeak 3, this setting is obsolete, because the port is transfered
through the query anyway.

- Queryport:
The teamspeak server uses a certain port where it listens for incoming queries.
For TS2 servers, you find this port in the server.ini file, which is located in the same
directory as the server binary is.
In the server.ini, look for a like called "TCPQueryPort". The port number is the value
after the "=".
For TS3 servers, you find this port in the ts3server.ini file, which is located in the same
directory as the server binary is.
In the ts3server.ini, look for a like called "query_port". The port number is the value
after the "=".

If you don't have access to these ini files, ask your server administrator or server
provider for these informations.

- VServer ID:
Teamspeak 3 servers aren't identified by their port number anymore.
Each virtual server gets an unique ID to differ it from the others.
In order to query the correct Teamspeak server, you have to specify its id. This is
important, if the machine TS3 is running on, provides more virtual servers than one.
In this case, you may ask your server provider for the correct ID of your server or ask your
server admin.
You usually find this ID in the server's log files too.


TROUBLESHOOTING / F.A.Q
=======================

- I get the error message "Socket error" or "Connection refused"
-> This is mostly the case, if you entered the wrong IP or port information.
Regardless if the port and ip is correct, the script sends a query to ask if the server
is "there" and answers. If no answer comes back, the script gives back these error messages.
Also check if you use the correct connection method. If your server is Teamspeak 2, it makes
no sense to query it with Teamspeak 3 methods and vice-versa.

- The who-is-online list prints out players who aren't on my server
-> You probably entered the wrong server port (for TS2) or the wrong vServerID (for TS3) and
the script is querying the wrong server.
Make sure you're using your server's data.

- I'm getting a blank site with PHP errors of classes that could not be found
-> You forgot to upload the query libaries or you put it in the wrong place.
Make sure you uploaded the necessary php files into the ./forum/includes directory and set
the correct permissions so the webserver can access it.
Also check if you're using the correct version.
If you update the plugin file, always update the libary file(s) too!


CUSTOMIZATION
=============

To customize the template, you'll find it in the forumhome Templategroup as "forumhome_tsviewer"
If you want advanced customization of the output code, you have to edit the plugin code.

To display the viewer in a different position, you can edit the output template hook.
In the plugin's code, find
"$hookpos = 'forumhome_wgo_pos'.$vbulletin->options['tsx_displayposition'];"
And change the 'forumhome_wgo_pos' to any other hook you want the output to appear.
Since the forumhome template has 5 positions (forumhome_wgo_pos1, forumhome_wgo_pos2, ...,
forumhome_wgo_pos5), you have to remove
"$vbulletin->options['tsx_displayposition'];"
if your preferred hook has no number at its end.
If there is no output at all, you probably used an invalid hookname.

For usage with teamspeak2, you can also put an icon file "teamspeak.gif" into the misc dir of your
image folder. This icon will be displayed on the left side of the output row.
If you want to use an other icon file or rebuild the output row, you have to edit the forumhome_tsview
template to fit your needs.


CHANGELOG
=========

12/01/09
- First non-beta Release starting at v1.1
- Fixed a formatting error in ts3status.php libary file
- Fixed tabs and whitespaces in xml files causing plugin installation to fail in rare cases.

04/01/09
- General code-cleanup
- Some additions for the settings descriptions
- Added setting for password-protected servers
- Added joinlink support for passworded servers
- Minor changes in ts3status.php

01/01/09
- Initial release

[BadgerDog]

Originally Posted by FF|Skyrider

Got reports that this plugin makes the forum home very very slow and giving tons of error in the server backlogs. Can anyone confirm this?

With the mod turned ON or OFF, we see no perceivable difference when tested with Pingdom tools using 4.04pl1 of vBulletin.

Regards,
Doug

[Disasterpiece]

Originally Posted by FF|Skyrider

Got reports that this plugin makes the forum home very very slow and giving tons of error in the server backlogs. Can anyone confirm this?

Could be caused by a long respone time from the teamspeak servers. Try reducing your query timeout value.
Also, when you ping your teamspeak server from the machine the forum is hosted on, what latency times do you get?

[BadgerDog]

Well, I've been using this excellent mod for almost a year and it's been working fine, however, two days agi it stopped working and began presenting this error message when anyone tries to connect to the server fron vb4.04pl ...

TS3 Server returned the following error: error id=2568 msg=insufficient client permissions failed_permid=8472

We've changed nothing and the host provider (Lightspeed) claims they've changed nothing.

When we click the link to join the server, we get this error message:

<11:53:38>
Trying to connect to server on 174.xx.xx.xx:9987
Failed to connect to server

I put XX's in to preserve privacy.

The host provider keeps insisting we have the wrong port and claim it should be 4128 and not 9987 as shown. I keep telling them that 4128 is NOT used for TS3 and they say a port IS required. I don't even know where the value 9987 is coming from?

What a circle jerk, considering everything was working fine for almost a year, so something must be different on their end?

I tried a manual connect to our server using the TS3 client and 174.xx.xx.xx:4128 and it works fine, which confuses me even more?

How can I get this mod to pass 4128 in its "connect string", even though it's a TS3 server and says it shouldn't need it, which as of two days ago seems to satisfy something on the host and permit it to connect, or am I misdiagnosing the problem altogether?

Appreciate any feedback ...

Regards,
Doug

[Disasterpiece]

Well, you could try to change that 9987 to 4128, that would be the obvious case.
When you connect to your ts3 server using teamspeak 3, what does the connection window say exactly? You have an IP and a port there, and this is the same connection info required for the joinlink to work.

9987 is the default port, so if you didn't need to specify it in your ts3 before, you should now need to do so, because if you leave it blank, ts3 automatically tries port 9987 first.

[BadgerDog]

Originally Posted by Disasterpiece

Well, you could try to change that 9987 to 4128, that would be the obvious case.

Thanks ..

Where do I make that change in your code? That's the value in the TS3 host settings and has been for the last year.

Originally Posted by Disasterpiece

When you connect to your ts3 server using teamspeak 3, what does the connection window say exactly?

It says in the TS3 client window when the program loads and executes:

============================
Trying to connect to server on 174.137.xx.xx:9987
Failed to connect to server
============================

Originally Posted by Disasterpiece

You have an IP and a port there, and this is the same connection info required for the joinlink to work. 9987 is the default port, so if you didn't need to specify it in your ts3 before, you should now need to do so, because if you leave it blank, ts3 automatically tries port 9987 first.

I think you're right and perhaps a new iteration of TS3 server code expects to see a specific port now. So, where can I specific that port it in the mod's AdminCP screen?

The only place it would go (I think) is in your mod's AdminCP field for TS2:

Teamspeak 2 Port
Which port to use for join link
TS2 Default: 8767
TS3 Default: -ignored-

However, I don't use TS2 and so it's a irrelevant entry? BTW, the value 4128 has been plugged in there for the last year and the TS3 client always connected properly, but even with this field blank as a test, I still get the error message from the TS3 client shown above.

As I said, if I manually use the TS3 client by just loading it on it's own outside of vBulletin without using your mode, it loads fine, as long as I use port 4128. TS3 client shows:

========================================
Trying to connect to server on 174.137.xx.xxx:4128
Connected to server
For help goto http://www.InstantTeamSpeak.com/team...er-support.php
You subscribed to all channels
========================================

If I hover over the link created by this mod in order to load the TS3 client, it shows ...

ts3server://174.137.xx.xx/?port=&nickname=Badger&password=test

Note port= has no value, but I don't think it ever has when it ran the TS3 client over the last year. I ran a test and simply typed the above line into the browser, except I put a value in the field port= that the mod hasn't been adding.

ts3server://174.137.xx.xx/?port=4128&nickname=Badger&password=test

It executes fine ...

So, I suspect that the TS3 server code now requires a port field value (like TS2 servers do), which it never has in the past? How can I get it to put 4128 in that field, if there's no AdminCP field to out it in?

Thanks for any guidance... :up:

Regards,
Doug

[Disasterpiece]

Yeah, heard of that bug before. Weird, I'm sure I double-checked, oh well.

I'll update the above mod files tonight, this should solve the problem.

[BadgerDog]

Originally Posted by Disasterpiece

Yeah, heard of that bug before. Weird, I'm sure I double-checked, oh well.

I'll update the above mod files tonight, this should solve the problem.

Much appreciated ... :up:

I'm baffled why it work flawlessly for almost a year, then all of a sudden not connect any longer to our TS3 server.

Anyway, if there was a field to plug in the port for a TS3, that embedded the value in the load string as I showed above, it would probably address the problem that's cropped up for whatever reason.

Thanks again ...

Regards,
Doug

[SteveLV702]

I am getting

Currently in TS: -1 User
TS3 Server returned the following error: error id=2568 msg=insufficient client permissions failed_permid=8470
Join Teamspeak

[Disasterpiece]

Hi Digital_Mayhem, this is a teamspeak-related issue, the server has not set the correct permissions to allow scripts to query the server.

If you have problems finding this properties, ask here: http://forum.teamspeak.com/forum.php

[SteveLV702]

grrrr searching teamspeak forums and cant find a thing on script permissions :'(