Integration with vBulletin - MediaWiki/vBulletin Single Sign-On

Overview:
This hack provides single sign-on capability for MediaWiki using your vBulletin users. You must ensure your cookie path in Admin CP is set to '/' for this to work. Also, I have not tested this if your wiki and your forums are on different subdomains - but as long as your have your cookie domain set properly it *should* work. This is not a user bridge - it is a complete single sign-on using your vBulletin user repository.

The install process has been extremely simplified in version 2.x of this product. You only have to edit LocalSettings.php, import a product, and change a setting in your Admin Control Panel. It's been completely packaged as a vBulletin product - unlike the previous hacked up version, heh. I didn't originally plan to release this so I designed it so it worked - not so it could be redistributed. I searched high and low for a functional MediaWiki bridge - almost bought NuHIT's product, and then realized it had been abandoned for over a year.

This hack no longer requires an edit to class_core.php.

I'll do my best to support it, but I can make no promises.

This thread is for discussion of this mod on vB 3.8.x. For vB 3.7.x, please use the MediaWiki/vBulletin Single Sign-On 3.7 thread

Demo of plugin in action: MyMMOGames - Multiplayer Gaming and Media Community

Also, if you use memcached - ensure you do not cache sessions. If you do, restart it at least once a week. If you don't, you'll end up with invalid session errors out of MediaWiki.

Requirements:
MediaWiki Version: 1.11.0-1.14.0
vBulletin Version: 3.6.9-3.8.2

Features:
- Provides single sign on capability between vBulletin and Mediawiki. vBulletin user repository is used
- Configurable sysop/bureaucrat groups
- Configurable disallowed user groups
- Configurable "Who's Online" display
- Counts users viewing wiki in vBulletin's "Who's Online"

Installation/Upgrade:
Please read the included "readme.txt" file in the "docs (do not upload)" folder.

Options:
Admin Control Panel->vBulletin Options->MMOG Wiki Options

Change Log:
1.0.0.0 - Sep 18, 2008
- Initial Release

1.0.3.0 - Sep 29, 2008
- Bugfix: Incorrect redirects for login/logout

2.0.0.0 - Sep 30, 2008
- Feature: Streamlined installation procedure
- Feature: Wiki path set in ACP
- Bugfix: Forum paths no longer hardcoded

2.1.0 - Oct 4, 2008
- Feature: ACP option to use MediaWiki Short URLs
- Feature: ACP option to set sysop groups
- Feature: ACP option to set bureaucrat groups
- Feature: ACP option to disallow login to certain groups
- Feature: ACP option to change WOL display text

2.2.0 - May 1, 2005
- Bugfix: Users are not logged out when logging out of the forum
- Bugfix: No longer requires modification to class_core.php
- Feature: Mediawiki 1.13.0+ supported (verified on 1.14.0 also)

If you like it, please click "mark as installed" The more people that use this, the more time I will make to try and support/update it.

Been pulling your hair out looking for this as long as I have? Nominate it for Mod of the Month =]

AuthPlugin was inspired by and modified from this existing MediaWiki Extension:

http://www.mediawiki.org/wiki/Extension:QISSingleSignOn

[simunaqv]

Originally Posted by benjaminlwells

did you just use the instructions in the readme file?

Ben

I already had the SSO working with vb 3.8.1 on my local setup. I created a separated installation vb 4.0 and upgraded it to vb 4.01 and applied the changes to the AuthPlugin_VBSSO.php file as suggested byBRotondi, and it is working, at least on my local setup.

[bepe]

I've got the whole thing pretty much working now... but had to rewrite almost everything for 4.0.1

... Right now my biggest problem is that the wiki css is somehow in conflict with the vB css
I'm just starting to learn all that php, css suff... but no idea where to continue now

https://vborg.vbsupport.ru/showthread.php?t=235147

[BRotondi]

@bepe: Install Firebug! You can click any element and change CSS and Html realtime. For PHP Xampp is perhaps the best solution.

I'm wondering why this mod works for 4.0.1 on your site... perhaps a Problem with the german version?

[bepe]

It's not really a mod... it's more like a new version

AuthPlugin_vbMediaWiki.php

PHP Code:

<?php
/**
 */
# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html

/**
 * Authentication plugin interface. Instantiate a subclass of AuthPlugin
 * and set $wgAuth to it to authenticate against some external tool.
 *
 * The default behavior is not to do anything, and use the local user
 * database for all authentication. A subclass can require that all
 * accounts authenticate externally, or use it only as a fallback; also
 * you can transparently create internal wiki accounts the first time
 * someone logs in who can be authenticated externally.
 */

$current_dir = getcwd();
chdir( '../forum' );
require_once( "global.php" );
require_once( "includes/functions.php" );
chdir( $current_dir );

require_once( "$IP/includes/AuthPlugin.php" );

/**
 * Users can't change their passwords here
 */
class AuthPlugin_vbMediaWiki extends AuthPlugin {

    public function allowPasswordChange() {
        return false;
    }
}
$wgAuth = new AuthPlugin_vbMediaWiki();

/**
 * Set the 'vbmediawikiskin' skin as default and prevent users from changing it
 * - we have only one integrated skin right now
 */
$wgDefaultSkin   = 'vbwikiskin';
$wgAllowUserSkin = false;

/**
 * Disable email and real name
 * - Not sure yet how to solve conflicts between vBulletin and MediWiki user data changes
 */
$wgEnableEmail   = false;
$wgAllowRealName = false;

/**
 * Disable 'pretty' URLs, e.g. index.php/Page_title
 * - We need to disable it or rewrite code for vBulletin's "Who's Online"
 */
$wgUsePathInfo = false;

/**
 * Set this to false to avoid forcing the first letter of links to capitals.
 * - vBulletin user names can be lower case, so we need that
 */
$wgCapitalLinks = false;
 
/**
 * Disabling new user registrations and anonymous edits
 * - vBulletin user names can be lower case, so we need that
 */
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['edit'] = false;

/**
 * Disable manual login and logout functions for all users and remove the ChangePassword page
 * - vBulletin will do the login/logout stuff and also the Password should be changes there
 */
function SpecialPage_initListHook( &$aSpecialPages )
{
    unset( $aSpecialPages['Userlogout'] );
    unset( $aSpecialPages['Userlogin'] );
    unset( $aSpecialPages['Resetpass'] );
    return true;
}
$wgHooks['SpecialPage_initList'][] = 'SpecialPage_initListHook';

/**
 * Remove login and logout buttons for all users
 * - vBulletin shows them in the navbar anyway
 */
function PersonalUrlsHook( &$personal_urls, &$title )
{
    unset( $personal_urls["login"] );
    unset( $personal_urls["logout"] );
    unset( $personal_urls['anonlogin'] );    
    return true;
}
$wgHooks['PersonalUrls'][] = 'PersonalUrlsHook';

/**
 * User Group Translation
 * - NoLogin:    Can't login to wiki... only to vBulletin
 * - Sysop:      Wiki Administrators
 * - Bureaucrat: Could edit user rights... but they will be reseted anyway
 *               It's more clear if we only allow a group like moderators to Administrate the Wiki
 */
$vwNoLoginGroups    = array();
$vwSysopGroups      = array(6,7);
$vwBureaucratGroups = array(6);

/**
 * Minimum number of posts a user need in to login to the Wiki 
 * - This is a community portal... only real members of the community should edit the Wiki
 */
$vwMinReputationPosts       = 5;
$vwMinReputationPostsNotice = 'wiki_posts';

/**
 * Sync user to vBulletin
 * - Same user for the Wiki as in vBulletin
 */
function UserLoadFromSessionHook( $user, &$result ) {
    global $vbulletin;
    global $vwNoLoginGroups, $vwSysopGroups, $vwBureaucratGroups;
    global $vwMinReputationPosts, $vwMinReputationPostsNotice;

    // check if user is authenticated (by another hook)
    if ( $user != null ) {
        if ( !$user->isAnon() ) {
            // User is not anonymous. 
            // Check for the existence of a valid vB userid.  If we don't have one, log the old user out.
            if ( $vbulletin->userinfo['userid'] == 0 ) {
                $user->logout();
            }

            // Check vwNoLoginGroups
            // If they're logged in and shouldn't be, log them out!
            if ( is_member_of( $vbulletin->userinfo, $vwNoLoginGroups ) ) {
                $user->logout();
                break;
            }
            
            if( $vbulletin->userinfo['posts'] < $vwMinReputationPosts ) {
                
                if( $vwMinReputationPostsNotice != null ) {
                    $vbulletin->noticecache = array(
                        $vwMinReputationPostsNotice => array(
                            'has_x_postcount' => array(0,$vwMinReputationPosts + 1)
                        )
                    );
                }
                
                $user->logout();
                break;
            }

            return true;
        }
        $user->logout();
    }
    
    if ( $vbulletin->userinfo['userid'] )
    {
        // Check vwNoLoginGroups
        if ( is_member_of( $vbulletin->userinfo, $vwNoLoginGroups ) ) {
            return true;
        }

        if( $vbulletin->userinfo['posts'] < $vwMinReputationPosts ) {
            
            if( $vwMinReputationPostsNotice != null ) {
                $vbulletin->noticecache = array(
                    $vwMinReputationPostsNotice => array(
                        'has_x_postcount' => array(0,$vwMinReputationPosts + 1)
                    )
                );
            }
            
            return true;
        }
            
        $username = $vbulletin->userinfo['username'];

        if ( $username ) {
            $u = User::newFromName( $username );
            if (is_null($u)) {
                // Invalid username or some other error...
                return;
            }
            if ( $u->getID() == 0 ) {
                $u->addToDatabase();
                $u->setToken();
            }
            else $u->loadFromDatabase();
            
            $user = $u;
            $user->setOption( 'rememberpassword', 1 );
            $user->saveSettings();
            $user->setCookies();
            
            // Check vwSysopGroups.
            $user->removeGroup( 'sysop' );
            if ( is_member_of( $vbulletin->userinfo, $vwSysopGroups ) ) {
                $user->addGroup( 'sysop' );
            }

            // Check vwBureaucratGroups.
            $user->removeGroup( 'bureaucrat' );
            if ( is_member_of( $vbulletin->userinfo, $vwBureaucratGroups ) ) {
                $user->addGroup( 'bureaucrat' );
            }
        }
    }
    else $user->logout();

    return true;
}    
$wgHooks['UserLoadFromSession'][] = 'UserLoadFromSessionHook';

and there are much more changes, like a new wiki skin and other changes for getting the vB WOL working right

[bepe]

Originally Posted by BRotondi

@bepe: Install Firebug! You can click any element and change CSS and Html realtime. For PHP Xampp is perhaps the best solution.

I'm wondering why this mod works for 4.0.1 on your site... perhaps a Problem with the german version?

thank you so much!! Firebug is just perfect for it ... did not know that tool yet :$

[BRotondi]

Originally Posted by bepe

It's not really a mod... it's more like a new version

AuthPlugin_vbMediaWiki.php

It works! Pasted your above code in my wiki\includes\AuthPlugin_vBSSO.php and WOW! 1001 Thanks!!

Bruno

[Digital Jedi]

Originally Posted by BRotondi

Modifications

• For use with Wiki short-URLs you should remove this in product-mmog_wiki.xml (after installation in Plugin "MMOG Wiki: Online Location Hack"):

      <phpcode><![CDATA[if (strpos($userinfo['location'], ( $vbulletin->options['mmog_wiki_path'] . '/' )) !== false)

so you can use /w which will work with /w/... and /wiki/...

If checking for /w ist not enough, you could also use multiple

if (...) {$userinfo['activity'] = 'wiki';}

• For German platforms you may change the hardcoded english in product-mmog_wiki.xm:

$userinfo['action'] = 'Viewing Wiki';

Greetings, Bruno

I tried this, and while it did work for the Wiki, it also rewrote users playing in ibProArcade. The link stayed the same, but it said they were viewing the wiki.

[BRotondi]

Ngh... and again not working 100% after upgrading to 4.0.2 ...

The "who is online" gives me no wiki-link, and unallowed users have an empty login-window in in the wiki (instead of the IP) ... Now I'm testing vbMediaWiki (Beta AddOn) which is VERY interesting:

• Edit-counter like Mediawiki Edits in Postbit & Profile
• Tab for the Wiki
• Wiki is included in the forum (same Header)

Greetings, Bruno

[Art Andrews]

I saw someone asked earlier if the wiki and vb could be on separate dbs and the answer was "yes." Can they be on separate domains and still have a single login?

[luan7749]

Could I use bbcode in this addon ?