WikkaWithphpBB:Wikka

Using the phpBB users table for logging in

See also:

WikkaIntegration

Using Wikka with phpBB3

This is a very simple hack to get Wikka to read from the users table of a phpBB database rather than its own. It is assuming that you have installed your Wikka into the same database as phpBB and that your phpBB tables are prefixed with "phpbb_" ("phpbb3_" for the v3.0 examples) and that their names have not been edited.

This will allow users from your phpBB forum to login to your wiki with their existing username and password.

Please note that for suggested changes phpBB and wikka should use the same database - otherwise it is necessary to give rights to wikka's database to read phpBB's database - and to write name of phpBB's database before its tables.

Note: these methods are used to integrate phpBB 2.x. For phpBB 3.x, see Using Wikka with phpBB3

Method 1

/Wikka.php (in Wikka 1.1.6.2 its /libs/Wakka.class.php)

Find:

function LoadUser($name, $password = 0) { return $this->LoadSingle("select * from ".$this->config['table_prefix']."users where name = '".mysql_real_escape_string($name)."' ".($password === 0 ? "" : "and password = '".mysql_real_escape_string($password)."'")." limit 1"); }

Replace with:

function LoadUser($name, $password = 0) { return $this->LoadSingle("select * from ".phpbb_."users where username = '".mysql_real_escape_string($name)."' ".($password === 0 ? "" : "and user_password = '".mysql_real_escape_string($password)."'")." limit 1"); }

Find:

function LoadUsers() { return $this->LoadAll("select * from ".$this->config['table_prefix']."users order by name"); }

Replace with:

function LoadUsers() { return $this->LoadAll("select * from ".phpbb_."users order by username"); }

Find:

function GetUserName() { if ($user = $this->GetUser()) $name = $user["name"]; else if (!$name = gethostbyaddr($_SERVER["REMOTE_ADDR"])) $name = $_SERVER["REMOTE_ADDR"]; return $name; }

Replace with:

function GetUserName() { if ($user = $this->GetUser()) $name = $user["username"]; else if (!$name = gethostbyaddr($_SERVER["REMOTE_ADDR"])) $name = $_SERVER["REMOTE_ADDR"]; return $name; }

Find:

function SetUser($user) { $_SESSION["user"] = $user; $this->SetPersistentCookie("user_name", $user["name"]); $this->SetPersistentCookie("pass", $user["password"]); }

Replace with:

function SetUser($user) { $_SESSION["user"] = $user; $this->SetPersistentCookie("user_name", $user["username"]); $this->SetPersistentCookie("pass", $user["user_password"]); }

/handlers/page/acls.php

Find:

echo "\t".'<option value="'.$this->htmlspecialchars_ent($user['name']).'">'.$user['name'].'</option>'."\n";

Replace with:

echo "\t".'<option value="'.$this->htmlspecialchars_ent($user['username']).'">'.$user['username'].'</option>'."\n";

added by KiltanneN - feel free to remove or correct

/actions/usersettings.php

Find:

case (md5($_POST['password']) != $existingUser['password']):

Replace with:

case (md5($_POST['password']) != $existingUser['user_password']):

added by EniBevoli - fix to show the name of the user again in the User Settings page

Find:

<td>Hello, <?php echo $this->Link($user['name']) ?>!</td>

Replace with:

<td>Hello, <?php echo $this->Link($user['username']) ?>!</td>

added by KiltanneN - feel free to remove or correct
I changed several things in the highscores.php code. Mostly they were changing the "name" to "username" but there was also the table prefix thing that had to be fixed up. Here's the full code:

/actions/highscores.php

<?php
# highscores.php {{HighScores}}
# by Chris Tessmer
# 19 Dec 2002
# license: GPL

$str = 'SELECT Count(*) AS cnt, `username` FROM phpbb_users, ' ;
$str .= $this->config["table_prefix"].'pages ';
$str .= "WHERE `username` = `owner` AND `latest` = 'Y' GROUP BY username ORDER BY cnt DESC;";
$rankQuery = $this->Query( $str );

$str = 'SELECT COUNT(*) FROM '.$this->config["table_prefix"].'pages WHERE `latest` = \'Y\' ';
$totalQuery = $this->Query( $str );
$total = mysql_result($totalQuery, 0);

print( "<blockquote><table>" );

$i = 0;
while( $row = mysql_fetch_array($rankQuery) )
{
$i++;
$str = '<tr>';
$str .= "<td>$i. </td>";
$str .= '<td>'. $this->Format( $row["username"] ) .'</td>';
$str .= '<td> </td>';
$str .= '<td> </td>';
$str .= '<td>'.$row["cnt"].'</td>';
$str .= '<td> </td>';
$str .= '<td>'. round( ($row["cnt"]/$total)*100, 2).'% </td>';
$str .= '</tr>';
print( $str );
}
print( "</table></blockquote>" );
?>

Method 2

Added by JeremyCoates

Advantages over Method 1:

Better SQL reduces number of code changes required

Still allows use of Wakka user settings

Shows how to enforce Wiki Names in phpBB code

/Wikka.php (in Wikka 1.1.6.2 its /libs/Wakka.class.php)

Find:

Replace with:

/**
* PHPBB Integration
*
* function LoadUser($name, $password = 0) { return $this->LoadSingle("select * from ".$this->config['table_prefix']."users where name = '".mysql_real_escape_string($name)."' ".($password === 0 ? "" : "and password = '".mysql_real_escape_string($password)."'")." limit 1"); }
*/
function LoadUser($name, $password = 0) { $user = $this->LoadSingle("select
p.username as name
,p.user_password as password
,p.user_email as email
,p.user_regdate as signuptime
,w.revisioncount
,w.changescount
,w.doubleclickedit
,w.show_comments
from ".phpbb_."users p
left join " . $this->config['table_prefix'] . "users w ON p.username = w.name
where p.username = '".mysql_real_escape_string($name)."' ".($password === 0 ? "" : "and p.user_password = '".mysql_real_escape_string($password)."'")." and p.user_active = 1 limit 1");
if (isset($user['signuptime'])) {
$user['signuptime'] = date('Y-m-d H:i:s', $user['signuptime']);
}

return $user;
}

Find:

function LoadUsers() { return $this->LoadAll("select * from ".$this->config['table_prefix']."users order by name"); }

Replace with:

/**
* PHPBB Integration
*
* function LoadUsers() { return $this->LoadAll("select * from ".$this->config['table_prefix']."users order by name"); }
*/
function LoadUsers() { $users = $this->LoadAll("select
p.username as name
,p.user_password as password
,p.user_email as email
,p.user_regdate as signuptime
,w.revisioncount
,w.changescount
,w.doubleclickedit
,w.show_comments
from ".phpbb_."users p
left join " . $this->config['table_prefix'] . "users w ON p.username = w.name
where p.user_active = 1
order by username");

foreach ($users as $key => $user) {

if (isset($user['signuptime'])) {
$user['signuptime'] = date('Y-m-d H:i:s', $user['signuptime']);
}
$users[$key] = $user;
}

return $users;
}

/actions/usersettings.php

Find:

default: // input is valid
$this->Query('UPDATE '.$this->config['table_prefix'].'users SET '.
"email = '".mysql_real_escape_string($email)."', ".
"doubleclickedit = '".mysql_real_escape_string($doubleclickedit)."', ".
"show_comments = '".mysql_real_escape_string($show_comments)."', ".
"revisioncount = '".mysql_real_escape_string($revisioncount)."', ".
"changescount = '".mysql_real_escape_string($changescount)."' ".
"WHERE name = '".$user['name']."' LIMIT 1");

Replace with:

default: // input is valid
/**
* PHPBB Integration
*
* Insert the user into the Wakka users table
*/
$tmpUser = $this->LoadUser($user['name']);
if (is_null($tmpUser['show_comments'])) {
$this->Query("INSERT INTO ".$this->config['table_prefix']."users SET ".
"signuptime = '".mysql_real_escape_string($user['signuptime'])."',".
"name = '".mysql_real_escape_string($user['name'])."', ".
"email = '".mysql_real_escape_string($user['email'])."'");
}
/**
* End PHPBB Integration
*/
$this->Query('UPDATE '.$this->config['table_prefix'].'users SET '.
"email = '".mysql_real_escape_string($email)."', ".
"doubleclickedit = '".mysql_real_escape_string($doubleclickedit)."', ".
"show_comments = '".mysql_real_escape_string($show_comments)."', ".
"revisioncount = '".mysql_real_escape_string($revisioncount)."', ".
"changescount = '".mysql_real_escape_string($changescount)."' ".
"WHERE name = '".$user['name']."' LIMIT 1");

/actions/highscores.php

Find:

$str = 'SELECT Count(*) AS cnt, `name` FROM ';
$str .= $this->config["table_prefix"] . 'users, ' ;
$str .= $this->config["table_prefix"].'pages ';
$str .= "WHERE `name` = `owner` AND `latest` = 'Y' GROUP BY name ORDER BY cnt DESC;";

Replace with:

$str = 'SELECT Count(*) AS cnt, `username` AS name FROM phpbb_users, ' ;
$str .= $this->config["table_prefix"].'pages ';
$str .= "WHERE `username` = `owner` AND `latest` = 'Y' GROUP BY username ORDER BY cnt DESC;";

Configuration to disable UserRegistration is still required, either patch for 1.1.6.2 or update config setting in 1.1.6.3 (or later) see UserRegistration for more details.

PHPBB 2.0.x

If you want to force Wiki names in PHPBB logins (it will save pain later!)

/includes/functions_validate.php

Find (in function validate_username):

Replace with:

// Don't allow " and ALT-255 in username.
if (strstr($username, '"') || strstr($username, '"') || strstr($username, chr(160)))
{
return array('error' => true, 'error_msg' => $lang['Username_invalid']);
}

/**
* Wikka Integration
* Wiki Username validation
*/
$include_path = get_include_path();
set_include_path(get_include_path() . PATH_SEPARATOR . realpath(dirname(__FILE__) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..'));
include_once('wikka.config.php');
include_once('libs/Wakka.class.php');

class WakkaPHPBBHack extends Wakka {
function WakkaPHPBBHack($config) {
parent::Wakka($config);
ob_start();
include_once('actions/usersettings.php');
ob_end_clean();
}
}
$wakka = new WakkaPHPBBHack($wakkaConfig);
set_include_path($include_path);
// Check for wiki names
if (!$wakka->IsWikiName($username)) {
return array('error' => true, 'error_msg' => preg_replace('`[#"]`', '', ERROR_WIKINAME));
}
// Check for reserved pages in wiki
if ($wakka->ExistsPage($username)) {
return array('error' => true, 'error_msg' => ERROR_RESERVED_PAGENAME);
}
/**
* End Wikka integration
*/

return array('error' => false, 'error_msg' => '');

Wikka Wiki and phpBB: using phpBB user information and allow Wikka-specific user settings

Added on July 29, 2005 by EniBevoli

I still have to make a easily readable diff output (such as "Find" - "Replace with" above; I already translated some text strings to German, so diff'ing is currently a mess) so that other users can edit their own files, but since I have finally come to a solution outlined below, I thought it would be a beneficial for others to simply post my results right away. The existing work on the Wikka Wiki / phpBB integration was a big starting point; without this information, I wouldn't even had a clue what to do. :)

Features / How it works:

Wikka uses phhBB for user logins, i.e. name and password of users are authenticated against the phpBB database

Users can configure some Wikka-specific settings via the User Settings page (for some settings, there is no point in changing them at the User Settings page; e.g., the email or the password field: the user should change this in his phpBB profile)

Whenever an existing phpBB user logs into Wikka, a Wikka user with the same name is created - if it does not already exist - for storing Wikka-specific settings (such as show_comments) as there is no counterpart for such settings in phpBB (and I don't want to alter the phpBB table structure)

Requirements:
- After the integration of Wikka Wiki and phpBB is done, user registration via Wikka Wiki must be disabled, new accounts should only be added via phpBB; see UserRegistration for more information about how to disable user registration

It took me quite some time to figure out why turning off "double click edit" didn't work - it is a bug with Wikka Wiki 1.1.6.0. :) I don't include the bug fix here, since it is already outlined in WikkaBugs.

Changed files:

wikka.php

handlers/page/acls.php

handlers/page/show.php (to fix the double click edit bug)

actions/usersettings.php

actions/highscore.php

As I said, I'm still compiling the changes in an easily readable format and will update this page when I'm done.

To Do / Questions / Open Issues:

phpBB users with non-camelcase usernames (e.g., "John") seem to work flawlessly on my installation even though I expected problems; any comments from the developers?

I am quite sure that the code quality is...ahm..."suboptimal". I basically tried to get it to work in the first place (I downloaded WikkaWiki today for the first time), so please don't flame me; instead, help to fix it!

CategoryUserContributions

Wikka : WikkaWithphpBB