EVE Technology Lab

Teamspeak and phpBB Forums EVE Online API Registration System

Current Version: 1.58
Released: 2011-10-20 (extremely minor revision 2011-10-21)

Features Summary:

• Uses the new, customizable API keys system
• Manages both phpBB (forums) and Teamspeak group membership
• Teamspeak functionality is optional
• Automatically puts users in groups in Teamspeak and phpBB based on EVE corporation via EVE API
• Automatically removes users from those groups if their API information becomes invalid or if they are no longer in a configured corporation
• Automatically switches members between corp. groups if they switch from one configured corp. to another
• Several corporations can be assigned to the same Teamspeak or forums group if desired
• Users can re-do the API registration as many times as they need to
• Provides an admin interface for admins to view a list of registration information and the error log (for troubleshooting)
• Minimum required customizable API key access level and key type (Account or Character) are configurable
• Optionally, sets users' EVE character avatars as their forums avatars (code idea by Rache Le'Bonbon)
• Reasonably well-documented code for easy customization

More Info and Download

Registration Page Screenshot

If anybody has any difficulty installing or using it, I'll be glad to help. As it seems relatively stable now, if I don't respond here on the forums very quickly, you might try sending me an email to get my attention, since the forums don't notify me of replies.

Actually I think I found it. Your using ServerQuery in the code right? So you just have to grant it access to the server via admin panel from your ts3 host. Correct me if I'm wrong.

Magotchi - I am still trying to break it

So far, no problems yet.

For the person who asked about TS hosting, you need to ask your hosting provider to make you a server query account and get the web server that the script is running on "white-listed".

Most hosting companies will not do this under any situation, but I do hosting at decent rates with this mod as an option. mail me and I can help you get set up.



Also, Magotchi, Let me know if you are already working on this, but im trying to get the new api system running with this script.

Let me know if you come up with anything because this is worse than beating my head against a wall.

i just installed this and its very nice but its not adding some people to the appropriate groups on ts. so far it seems server, specifically the people set up as server admins, is this intentional or caused by ts?

After thinking about how to work with the new API system, I have some dramatic changes coming down the pipe, again likely worked on heavily tomorrow (well today I mean since it's 6am'ish my time and I'm awake still).

Summary of Planned Changes in Upcoming Version:

• The new customizable API keys will be required. The access mask and key type will be configurable as described in my previous post.
• There will be a registration page separate from the phpBB registration page. It will still require the user be logged in to the forums to use, though.
• Much less customization will be required to the forums. Adding the Teamspeak Registration table and a link in the forums to the new registration page will be the only required steps in that regard.
• The registration page will be re-usable by the users to re-register as their information (API key, character they want registered, TS UID) changes.
• The registration page will walk users through the process in a much better way, including using AJAX to get the username/usernames of their characters in configured corps. and verifying that all the submitted information is correct.
• (Edit: This ended up not being true.) Registration will require the user to be in the Teamspeak server. It's a long story as to why, but it's for security.
• As another security fix, Unique IDs will be checked to make sure they're not already in use by another registered user.
• Successful registration will update the user's forums username to match their registered player name.
• Checks where there is a failure due to bad key information or where the user is no longer in a registered corp. will, in addition to removing the user's forums and TS rights, also unregister them entirely (not from the forums, but only from this API registration system). This will prevent future unnecessary checks. They can of course still re-register at any time as above.
• The system will use the EVE API CachedUntil timestamp to make its determinations instead of the time of the last check. In cases where the connection to the EVE API server fails during a check, that timestamp will be cleared so that the user is moved to the front of the line for the next check.

There may be more features, and as the above are just based on the program plan I wrote for myself, there is a chance some of them could change as I get into the actual coding.

There won't be much of an upgrade path from the old version other than that most of the things in the config file will stay the same (with a couple new additions). Due to the fact that the API key system is changing, this only makes sense anyway.

I'm going to get some sleep and then get right back on this when I wake up this afternoon.

I've done the vast majority of the work on implementing these changes today (Sunday), and I'll likely finish it tomorrow evening.

I just need to finish some minor things, do some more testing, and make the appropriate changes to the documentation.

I'll be back on it when I get off work Monday evening.

Well mine is done. I'm just still tweaking the documentation as I said. I'll release it tonight.

Update:
The new version is released. Check it out and let me know what you think.

Note: You should completely remove the old version to use this one. At minimum, you must delete your old cron job, delete the line you added to "/includes/ucp/ucp_register.php" in the phpBB installation (starts with "exec"), and delete the custom profile fields related to the system (via Administration Control Panel --> Users and Groups tab --> Custom profile fields). You'll likely also want to delete the "Teamspeak Registration" table from your database, undo any changes you made to your forum (maybe your "ucp_register.html" template) for instruction purposes, delete the old registration system folder, and remove everyone from the forums and TS groups you had configured to work with this system.

Also, it turns out that players aren't required to be connected to the TS server when they register as I had previously stated in my plan.

Update:
LOL. I already released another minor fix version (1.51). The registration form wasn't correctly showing all names from configured corps.

The script already uses the template URL on the registration page for whatever your configured minimum access mask is.

If you read the documentation in config.inc.php, you'll have your answer about what it requires: "These are totally up to you as an admin."

Even an access mask of 0 is enough for this script, as that still gives access to the character list, and that's why it's the default in the config.

Balani: I guess I should put in the requirements that it requires PHP 5.3.0 or greater.

The ( EOL ) sections aren't the problem. It's the ( 'EOL' ) (with a single quote on each side of EOL) that only work in PHP 5.3.0 or greater. You can either upgrade your PHP, or you might be able to just find and replace every occurrence of the second thing with the first thing, and it should work fine, but you might have to put a backslash ( "\" ) before the dollar signs in the javascript section in index.php (located in lines 136 -161). This syntax it's currently using is called Nowdoc in case you're wondering.

Do whatever you want to with the code, but I will have no part of helping you use the Smarty templating engine like EDK uses. Also, this is incredibly easy to customize. There's only one end-user-facing page ('index.php"), and you can make it reference whatever stylesheet you want or just edit the style block in the header.