Integration with vBulletin - Steam Connect - Sign in with your Steam Account! [RC3]

Steam Connect

INFO

-- Steam Connect Addon for vBulletin 4.2.x;
Development Platform := vBulletin 4.1.3 - 4.2.0, Debian Linux, PHP5, MySQL5, apache2;
Dependencies := lib cUrl (PHP), openid (included);
Author := Andreas "Radon" Rudolph, Disasterpiece;
Contact := radon@purgatory-labs.de, https://vborg.vbsupport.ru/member.php?u=198844
Homepage := http://purgatory-labs.de


WHAT YOU SHOULD KNOW BEFORE INSTALLING

This addon is Unsupported as of 2015 until further notice. I have not enough time or interest in vbulletin to keep this alive.

This addon provides a framework for future extensions which make use of the Steam API.
It helps to determine the SteamID of an user. Unless older methods of inserting the steam
id into a user field, the addon lets the user authenticate with Steam OpenID, therefore
you can trust 100%, that this particular user is the same user as the Steam-ID provided.

Users can link their Steam ID to their forum account or they can create a new account
using details pulled from their Steam Profile.
Like the Facebook connect plugin, it allows users to quickly set up a forum account without
having to define a password or an email address. This option can be disabled in the AdminCP,
however it is encouraged to allow users to use this quick-register feature, since they
already authenticated themselves through steam, so any additional password or email
authentication is just unnecessary.

If the user decides to un-link his forum account with his steam-profile, he has to set up
a password and email first, so the forum account remains usable after this.

At the moment, the addon is in its second RC state, which means that the current versions contain mostly bugfixes and are candidates for a full release.
Until now, the product worked without major problems in productive environments. Although it is stable as is, the author doesn't provide any guarantee.
Due to the nature of the addon and how vBulletin manages 3rd party code inclusion, additional
login and register methods have been provided by the plugin. It is discouraged to use the
plugin on high profile communities in this early development state.

If you have any further questions, feel free to post in this thread.


F.A.Q. / General Issues / Error Messages

"There has been a problem with the OpenID libary: No OpenID Server found at http://steamcommunity.com/openid"
- Additionally, a 503 HTTP error is thrown. Simple solution: Wait. Steam Community servers are overloaded/down right now, there's nothing you can do about it

Do NOT uninstall the mod if you want to keep the linked users records. Upgrading means uploading the new product xml file for the new version and choose "overwrite" in the upload dialog.
The Installer will handle the update process by its own. Uninstalling the product will erase all the table fields which contain the steam link data.


STEAM CONNECT ADDONS

- Steam Mini Profiles


INSTALL HOWTO

[Disasterpiece]

CHANGELOG

v1.4.5rc3

- Fixed rare error with secondary usergroups being stored in the wrong format causing a Database Error
(When updating the plugin file, a function repairs all existing database entries once)
- Fixed new user sometimes not being assigned the correct usergroups when registering/linking/unlinking
- Fixed scheduled/maintenance tasks not updating steam user's usergroups correctly
- Fixed stc_cache using object references instead of the actual values
- Fixed the user's display group sometimes not updating correctly
- Fixed scheduled/maintenance tasks clearing the cache, even if memcached system is used
- Fixed scheduled/maintenance tasks sometimes not writing their output into the logfile
- Fixed some typos/errors in the options description text
- Added the option to force an email address in quick register
- Added the option to force the primary steam usergroup as the display group
- Added the option to immediately check if the user is member of the specified steamgroup. This should be disabled if the steam
group is too huge, (remember that for each page the script needs to query, the registration process is delayed 1 second)
in which case the correct steamgroup dependant usergroup is assigned the next time the scheduled task runs.

v1.4.4rc3

- Fixed a bug which would cause intense logfile spamming
- Fixed steam sessions not being permanent

v1.4.3rc3

- Fixed quotes in Steam usernames messing up the register template
- Fixed browser error when redirecting from steam login back to the forum url (primarily) on Windows machines
(directed to https:// instead of http://, now replaced with an option in the STC settings)
- Fixed group maintenance function not using cache for group data when the maintenance operation is split up in multiple steps
- Fixed potential security flaw in useradministration if using custom query fields
- Added Cron job to update user <-> steam group assocations every night (basically does what the mainenance script does, now once every night)
- Added option to disallow unlinking of steamaccount. In this case, unlinking is only possible through admincp
- Added ability to unlink account completely with a checkbox as the last field, updating usergroups as well.
(before, if you set the steamid to empty string, it only removed the steam assocation, but didn't change the usergroups)
- Added memcached as optional cache system
- Reworked file cache system
- Updated steamconnect cache dir option, now a writable cache directory is required.
- Updated some option description strings to better describe which values to use.
- General code optimization

v1.4.2rc2

- Fixed User steam information displaying for the wrong user in private message view
- Fixed vBulletin not redirecting properly when linking/unlinking the steam account
- Fixed vBulletin sometimes redirecting to the wrong url after a successful steamid login.
- Added a Maintenance Task to reassign steam-dependant usergroups. This should help with users having the correct usergroup
when one of these values is changed in the admincp.

v1.4rc1

- Fixed vbulletin sometimes creating an empty stc cache file
- Fixed Link status in the Usercp displaying numbers instead of phrases for the profile visibility
- Added optional steam group membership verification and dependant forum usergroup assignment
- Added function to retrieve steam group information including memberlist
- Added lots of hooks in the login2.php
- Added scheduled task to cleanup old cache/datastore files
- Improved Steam button showing as "Signed in with STEAM" if you are logged in with an account which is linked.
- Minor code improvements

v1.3.2rc1

- Fixed a typo

v1.3b

- Fixed a bug that would cause stc to download profile data on each page request if additional fields are specified
- Added Blacklist to prevent ceratin steamids from registering/linking accounts
- Added logging to follow most important actions like linking/unlinking of accounts
- Added timeout option to http requests
- Added option to globally include additional profilefields
- Added option to enable script profiling for admins if you want to see actual execution times (you can find this as
a by default deactivated plugin in the plugin list)
- Improved caching and page load size

v1.2.2b

- Fixed the manual assignment of Steam-IDs in the admin panel producing malformed Steam64 IDs

v1.2.1b

- Fixed a syntax error appearing if you saved user details in admincp.

[NOTES for upgrader: No files did change, just upload and overwrite the product xml file./]

v1.2b

- Added steam connect control area inside user administration interface
- Added a steam icon in user postbit and profile to indicate that the user has linked his/her profile (postbit_steam_icon)
- Added steam avatar urls to postbit template with {vb:raw post.steamavatar} where steamavatar can be replaced
by "steamavatarmedium" and "steamavatarfull" as well for picking the correct size
- Added the ability to set a secondary usergroup for users linking their steam profile
- Added a userfield "steam_code" to the user table, where the coded steam id in the form STEAM_0:0:12345 is stored
as well as the function calc_steam_code($steam_id) to calculate the coded steam id from the steam friend id
on the fly
- Changed steam button being a form to a normal image link to avoid interferance with other html forms
- Fixed the steam button not redirecting to the steam login page in certain cases

v1.1.1b
- Fixed wrong function name causing errors on older php versions

[NOTES for upgrader: functions_steamconnect.php is the only updated file, just replace the old file in includes/]

v1.1b
- Fixed birthday fields not working correctly
- Fixed an issue with friendly_url while attempting to link two accounts
- Added profile data caching
- Added Steam Avatar URLs to postbit template as {vb:raw post.steamavatar}, {vb:raw post.steamavatarmedium}
and {vb:raw post.steamavatarfull} (disabled by default)
- Improved steam button, now using a separate template and being included via {vb:raw steam_button}

[NOTES for upgrader: You may want to replace the steam button code in your header template with the new
button code since now there's a template for easy customization.]

v1.0b
- Initial Beta Release


INSTALL


1) Upload all the files inside "upload" directory to their respective locations

2) Import the product xml file as an Addon inside your AdminCP

3) Navigate to Settings > "Steam Connect Settings" and configure the product to fit your needs.
You should also include a Steam API key, the link can be found below the setting entry.

3.1) (Optional) If you would like to separate normal Forum users from those, who set up their
account via quick-register, you may create a separate usergroup and set the usergroup
in the respective setting in the Product's options. This way, every quick-register user
will be set to this primary usergroup.

4) To make the steam sign-in button visible, you need to place this code where you'd like
the button to appear:

{vb:raw steam_button}

In the example, it was placed inside of the header template below the content:

<div class="ad_global_header">
    {vb:raw ad_location.global_header1}
    {vb:raw ad_location.global_header2}
</div>

If you want the button to be included in a different template, make sure you specify the template name
in the according Product setting in AdminCP > Settings > Steam Connect Settings > "Sign In Button Location"

5) To make the steam sign-in button to appear in the register form, open the "register" template,
search for the following code:

		<vb:if condition="$show['coppa']">
			<div class="blockrow">{vb:rawphrase until_receive_signed_form}</div>
		</vb:if>

BELOW add:

		<h3 class="blocksubhead">{vb:rawphrase stc_steamconnect}</h3>
		<div class="section">
			<div class="blockrow">
				{vb:raw steam_button}
			</div>
		</div>

6) To make the steam icon appear in the postbit where the messenger icons are, open the "postbit" template
and search for:

				<div class="imlinks">
					{vb:raw post.icqicon} {vb:raw post.aimicon} {vb:raw post.msnicon} {vb:raw post.yahooicon} {vb:raw post.skypeicon}
				</div>

depending on the position you want the icon to appear, place a {vb:raw post.steamicon} in the list to the
others.


7) Done!


KNOWN ISSUES

- Does not work with COPPA yet and is not intended to do so
- Does not work as "only" way to register. Needs to be parallel with regular registrations
- On Windows servers, cache time in the admincp might not display properly


EXTENDING UPON THIS ADDON


Every developer is welcome to build own addons on the steam connect feature.

The only thing you need is the steamid, which is provided in all userinfo queries!

Check out the file "includes/functions_steamconnect.php" to get an overview of what's already there.
In future updates, some helper functions might be added to assist you with content pulling from
Steam's API.
You also may check out the plugin "provide steamid in postbit" where you can get a feeling on how
Steamconnect can provide you user information quickly and uncomplicated.

Also, it's a good idea to include a dependency to the Add-On-ID "steamconnect" when building
your own addons. This way you can ensure that the user has Steam Connect installed.

If you have any further questions about how to build upon the Steam Connect product
or have any suggestions/feedback, you may contact me @ vbulletin.org via PM
or per email: radon [at] rn86 [dot] de

[i3lack]

This is pretty Cool I will be installing after i get home with update on this Thanks Nominated!

[Trek]

This has a LOT of potential and as I run a gaming site... could be exactly what some of my members have been asking for. I'll grab it and run it through the paces!

One question, it seems like it might be out of scope for this mod, but we have a steam group for our community and we'd like to be able to list some of that information (who's online, who's playing what, etc) on our website. Would that be possible at all with this mod?

[legatw]

can you realize for 3.8 this mod?

[Disasterpiece]

Originally Posted by Trek

This has a LOT of potential and as I run a gaming site... could be exactly what some of my members have been asking for. I'll grab it and run it through the paces!

One question, it seems like it might be out of scope for this mod, but we have a steam group for our community and we'd like to be able to list some of that information (who's online, who's playing what, etc) on our website. Would that be possible at all with this mod?

This is exactly what will be coming in the next time. But first I want to eliminate potential issues and get feedback for the core functionalitites. Updates like Steam groups and full Game stats in Userprofiles are well possible! For example a mini-steam info in postbit: https://vborg.vbsupport.ru/showthread.php?t=266884

If you have any suggestions on small addons which use the steam api, you can send me your suggestions via PM. More will come soon!

[erie1555]

I would REALLY like to see this go further on and would defiantly use this mod.
Getting an error saying 'You have entered an invalid birthday.', when I'm entering a valid birthday

[Disasterpiece]

The Birthday fields doesnt Quite seem to work yet, Works for me if its blank. Will Be Adressed in the Next update.

I Received Great Feedback so far, more will follow in the next days!

[Disasterpiece]

Originally Posted by legatw

can you realize for 3.8 this mod?

That's a negative sorry.
I don't use vb3 anymore and the architecture is Too different.
There's Not much benefit for me As Long As its a free addon

[i3lack]

im having a little problem how do i get the sign in to work? i have installed it and when i click on the sign in steam it takes me to a page that shows me i typed my password wrong