This is an old revision of the document!
Table of Contents
phpBB 3 (authentication) integration
Features
- Completely using phpBB's authentication system, you don't have to login in DokuWiki again if you're already logged in in phpBB and vice versa. The same applies to log out of course.
- Using phpBB's groups for DokuWiki's access control list. Some default groups are already implemented (even if they are not displayed on DokuWiki's configuration page):
- REGISTERED: default group (replaces group user)
- ADMINISTRATORS: administrator/super user (replaces group admin)
- GLOBAL_MODERATORS: managers
Features missing
- User registration
- Full name display (phpBB doesn't have full name information in the user profile by default, username is displayed instead)
- Integration with Mediamanager, pictures are not shown in the wiki anymore (path problem?)1)
- Language support
Installation instructions
To get this to work with the most Release Candidate version of DokuWiki “Adora Bell 10-09-2912” and PHPBB3 only do the following steps marked with =Adora Bell=
To get this to work with the most recent stable version of DokuWiki “Angua 25-01-2012” and PHPBB3 only do the following steps marked with =Angua=
To get this to work with the outdated version of DokuWiki “Rincewind” and PHPBB3 only do the following steps marked with =Rincewind=
To install this mod, you can:
- follow these steps:
- create
inc/auth/phpbb3.class.php - edit
inc/init.php - edit
inc/utf8.php - edit
inc/cache.php - edit
feed.php - edit
lib/exe/css.php=Angua= =Adora Belle= Do Not do for Rincewind - edit
lib/exe/js.php=Angua= =Adora Belle= Do Not do for Rincewind - edit
inc/load.php=Angua= =Adora Belle= Do Not do for Rincewind - edit
inc/auth/mysql.class.php=Adora Belle=
orCreate inc/auth/phpbb3.class.php
=Angua= =Rincewind= =Adora Belle=
Create a file in the inc/auth/ directory with the filename phpbb3.class.php and the following content :
- phpbb3.class.php
<?php /** * phpBB3 authentication backend * * Uses external Trust mechanism to check against phpBB's * user cookie. phpBB's PHPBB_ROOT_PATH must be defined correctly. * * @author Markus Henn <brezelman@yahoo.de> */ define('IN_PHPBB', true); global $phpbb_root_path; global $db; global $cache; global $phpEx; global $user; global $config; global $conf; global $dbhost; global $dbport; global $dbname; global $dbuser; global $dbpasswd; global $table_prefix; global $phpbb_auth; $phpEx = substr(strrchr(__FILE__, '.'), 1); if(strpos($_SERVER['PHP_SELF'], "/lib/plugins/") !== false) { $phpbb_root_path = '../../../'.$phpbb_root_path; } if(strpos($_SERVER['PHP_SELF'], "/lib/exe/") !== false) { $phpbb_root_path = '../../'.$phpbb_root_path; } require_once(DOKU_INC.'inc/auth/mysql.class.php'); require_once($phpbb_root_path.'common.'.$phpEx); //config is loaded in common file, but $dbpasswd is unset there, too, so we have to reload it require($phpbb_root_path.'config.'.$phpEx); $user->session_begin(); //$auth will be used by DokuWiki, so copy phpBB's $auth to another variable $phpbb_auth = $auth; $phpbb_auth->acl($user->data); class auth_phpbb3 extends auth_mysql { function auth_phpbb3() { $this->cando['external'] = true; $this->cando['logoff'] = true; global $conf; // get global vars from phpBB config global $dbhost; global $dbport; global $dbname; global $dbuser; global $dbpasswd; global $table_prefix; // set group config vars $conf['defaultgroup'] = 'REGISTERED'; $conf['superuser'] = '@ADMINISTRATORS'; $conf['manager'] = '@GLOBAL_MODERATORS'; // now set up the mysql config strings $conf['auth']['mysql']['server'] = $dbhost.':'.$dbport; $conf['auth']['mysql']['user'] = $dbuser; $conf['auth']['mysql']['password'] = $dbpasswd; $conf['auth']['mysql']['database'] = $dbname; //unset $db* variables, so noone can hack them unset($dbpasswd); unset($dbuser); unset($dbhost); unset($dbport); unset($dbname); $conf['auth']['mysql']['TablesToLock']= array("{$table_prefix}users", "{$table_prefix}users AS u", "{$table_prefix}groups", "{$table_prefix}groups AS g", "{$table_prefix}user_group", "{$table_prefix}user_group AS ug"); $conf['auth']['mysql']['checkPass'] = "SELECT user_password AS pass FROM {$table_prefix}users WHERE username='%{user}'"; $conf['auth']['mysql']['getUserInfo'] = "SELECT user_password AS pass, username AS name, user_email AS mail FROM {$table_prefix}users WHERE username='%{user}'"; $conf['auth']['mysql']['getGroups'] = "SELECT group_name as `group` FROM {$table_prefix}groups g, {$table_prefix}users u, {$table_prefix}user_group ug WHERE u.user_id = ug.user_id AND g.group_id = ug.group_id AND u.username='%{user}'"; $conf['auth']['mysql']['getUsers'] = "SELECT DISTINCT username AS user FROM {$table_prefix}users AS u LEFT JOIN {$table_prefix}user_group AS ug ON u.user_id=ug.user_id LEFT JOIN {$table_prefix}groups AS g ON ug.group_id=g.group_id"; $conf['auth']['mysql']['FilterLogin'] = "username LIKE '%{user}'"; $conf['auth']['mysql']['FilterName'] = "username LIKE '%{name}'"; $conf['auth']['mysql']['FilterEmail'] = "user_email LIKE '%{email}'"; $conf['auth']['mysql']['FilterGroup'] = "group_name LIKE '%{group}'"; $conf['auth']['mysql']['SortOrder'] = "ORDER BY username"; $conf['auth']['mysql']['getUserID'] = "SELECT user_id AS id FROM {$table_prefix}users WHERE username='%{user}'"; $conf['auth']['mysql']['getGroupID'] = "SELECT group_id AS id FROM {$table_prefix}groups WHERE group_name='%{group}'"; /* $conf['auth']['mysql']['addUser'] = "INSERT INTO {$table_prefix}users (username, user_password, user_email) VALUES ('%{user}', '%{pass}', '%{email}')"; $conf['auth']['mysql']['addGroup'] = "INSERT INTO {$table_prefix}groups (group_name) VALUES ('%{group}')"; $conf['auth']['mysql']['addUserGroup']= "INSERT INTO {$table_prefix}user_group (user_id, group_id) VALUES ('%{uid}', '%{gid}')"; $conf['auth']['mysql']['updateUser'] = "UPDATE {$table_prefix}users SET"; $conf['auth']['mysql']['UpdateLogin'] = "username='%{user}'"; $conf['auth']['mysql']['UpdatePass'] = "user_password='%{pass}'"; $conf['auth']['mysql']['UpdateEmail'] = "user_email='%{email}'"; //$conf['auth']['mysql']['UpdateName'] = $conf['auth']['mysql']['UpdateLogin']; $conf['auth']['mysql']['UpdateTarget']= "WHERE user_id=%{uid}"; $conf['auth']['mysql']['delGroup'] = "DELETE FROM {$table_prefix}groups WHERE group_id='%{gid}'"; $conf['auth']['mysql']['delUser'] = "DELETE FROM {$table_prefix}users WHERE user_id='%{uid}'"; $conf['auth']['mysql']['delUserRefs'] = "DELETE FROM {$table_prefix}user_group WHERE user_id='%{uid}'"; $conf['auth']['mysql']['delUserGroup']= "DELETE FROM {$table_prefix}user_group WHERE user_id='%{uid}' AND group_id='%{gid}'"; */ // call mysql constructor $this->auth_mysql(); } function trustExternal($username, $password, $sticky = false) { global $USERINFO; global $conf; global $user; global $phpbb_auth; $sticky ? $sticky = true : $sticky = false; // sanity check // someone used the login form if(!empty($username)) { // run phpBB's login function define('IN_LOGIN', true); $login = $phpbb_auth->login($username, $password, $sticky); if($login['status'] != LOGIN_SUCCESS) { return false; } } if(!$user->data['is_registered']) { return false; } $USERINFO['name'] = $user->data['username']; $USERINFO['mail'] = $user->data['user_email']; if($this->_openDB()) { $USERINFO['grps'] = $this->_getGroups($USERINFO['name']); } $_SERVER['REMOTE_USER'] = $user->data['username']; $_SESSION[DOKU_COOKIE]['auth']['user'] = $user->data['username']; $_SESSION[DOKU_COOKIE]['auth']['pass'] = $user->data['user_password']; $_SESSION[DOKU_COOKIE]['auth']['info'] = $USERINFO; return true; } function logoff() { global $user; $user->session_kill(); } } ?>
Since =Adora Belle= you have to change this part:
// call mysql constructor $this->auth_mysql();
By this :
// call mysql constructor $parent::__construct();
This is because the auth_mysql class is now in PHP5 and uses the new constructor (construct())
==== Edit inc/init.php ===
=Angua= =Rincewind= =Adora Belle=
In the file inc/init.php search for the following line:
<code php>$_REQUEST = array_merge($_GET,$_POST);</code>
Comment it out by adding // in front of the line like this:
<code php>$_REQUEST = array_merge($_GET,$_POST);</code>
We have to do this because phpBB uses $_REQUEST for its cookies.
==== Edit inc/utf8.php ====
=Angua= =Rincewind= =Adora Belle=
There are some functions in the file inc/utf8.php already defined by phpBB, these are:
* utf8_strlen
* utf8_substr
* utf8_strtolower
* utf8_strtoupper
* utf8_ucfirst
* utf8_strpos
* utf8_basename =Adora Belle=
So we only let DokuWiki define these functions if we're not using phpBB by adding an check around these function: <code php>if(!defined('IN_PHPBB')) { … }</code>
=== Example: utf8_strlen ===
replace:
<code php>function utf8_strlen($string){
return strlen(utf8_decode($string));
}</code>
with:
<code php>if(!defined('IN_PHPBB')){
function utf8_strlen($string){
return strlen(utf8_decode($string));
}
}</code>
==== Edit inc/cache.php ====
=Angua= =Rincewind= =Adora Belle=
The last problem we have is that DokuWiki and phpBB both have a cache class. We can just rename this class in DokuWiki. To do so we open the file inc/cache.php and search for:
<code php>class cache {</code>
replace this line with:
<code php>class wiki_cache {</code>
Search for:
<code php>function cache($key,$ext) {</code>
and replace it with:
<code php>function wiki_cache($key,$ext) {</code>
Search for:
<code php>class cache_parser extends cache {</code>
and replace it with:
<code php>class cache_parser extends wiki_cache {</code>
Search for:
<code php>parent::cache($file.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],'.'.$mode);</code>
and replace it with:
<code php>parent::wiki_cache($file.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],'.'.$mode);</code>
==== Edit feed.php ====
=Angua= =Rincewind= =Adora Belle=
Knowing we have just renamed the cache class (see above) and knowing this class is called in feed.php, we also need to rename the calling to make RSS/Atom feeds works.
Find:
<code php>
$cache = new cache($key, '.feed');
</code>
and replace with:
<code php>
$cache = new wiki_cache($key, '.feed');
</code>
Otherwise you will have a very nice “XML Parsing Error”.
==== Edit lib/exe/css.php ====
=Angua= =Adora Belle= Do Not do for Rincewind
=Angua=
Knowing we have just renamed the cache class (see above) and knowing this class is called in lib/exe/css.php, we also need to rename the calling to make skin works.
Find:
<code php>
The generated script depends on some dynamic options
$cache = new cache('styles'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'].DOKU_BASE.$tplinc.$mediatype,'.css');
</code>
and replace with:
<code php>
The generated script depends on some dynamic options
$cache = new wiki_cache('styles'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'].DOKU_BASE.$tplinc.$mediatype,'.css');
</code>
=Adora Belle=
Find:
<code php>
The generated script depends on some dynamic options
$cache = new cache('styles'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'].DOKU_BASE.$tplinc.$type,'.css');
</code>
and replace with:
<code php>
The generated script depends on some dynamic options
$cache = new wiki_cache('styles'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'].DOKU_BASE.$tplinc.$type,'.css');
</code>
==== Edit lib/exe/js.php ====
=Angua= =Adora Belle= Do Not do for Rincewind
Knowing we have just renamed the cache class (see above) and knowing this class is called in lib/exe/js.php, we also need to rename the calling to make javascript works.
Find:
<code php>
The generated script depends on some dynamic options
$cache = new cache('scripts'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],
'.js');
</code>
and replace with:
<code php>
The generated script depends on some dynamic options
$cache = new wiki_cache('scripts'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'],
'.js');
</code>
==== Edit inc/load.php ====
=Angua= =Adora Belle= Do Not do for Rincewind
Knowing we have just renamed the cache class (see above) and knowing this class is in inc/load.php, we also need to rename the name to make css and javascript works.
Find:
<code php>
'cache' ⇒ DOKU_INC.'inc/cache.php',
</code>
and replace with:
<code php>
'wiki_cache' ⇒ DOKU_INC.'inc/cache.php',
</code>
==== Edit inc/auth/mysql.class.php ====
=Adora Belle=
I am not a php expert so I don't know how this affects things or security but between Angua and Adora Belle the mysql.class.php was re-written which I think affects the phpbb3.class.php file written at the top of this page so it needs to be re-written… if anyone can do that then please replace it but for now it appears to work if you replace the code with the previous Angua code… A temporary fix until someone with better php knowledge can help. djSupport
Replace the code in Andora Belle mysql.class.php:
with the previous code below from Angua:
<file php inc/auth/mysql.class.php><?php
/
* MySQLP authentication backend
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @author Chris Smith chris [at] jalakai [dot] co [dot] uk
* @author Matthias Grimm matthias [dot] grimmm [at] sourceforge [dot] net
*/
class auth_mysql extends auth_basic {
var $dbcon = 0;
var $dbver = 0; database version
var $dbrev = 0; database revision
var $dbsub = 0; database subrevision
var $cnf = null;
var $defaultgroup = “”;
/
* Constructor
*
* checks if the mysql interface is available, otherwise it will
* set the variable $success of the basis class to false
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function auth_mysql() {
global $conf;
$this→cnf = $conf['auth']['mysql'];
if (method_exists($this, 'auth_basic'))
parent::auth_basic();
if(!function_exists('mysql_connect')) {
if ($this→cnf['debug'])
msg(“MySQL err: PHP MySQL extension not found.”,-1,LINE,FILE);
$this→success = false;
return;
}
default to UTF-8, you rarely want something else
if(!isset($this→cnf['charset'])) $this→cnf['charset'] = 'utf8';
$this→defaultgroup = $conf['defaultgroup'];
set capabilities based upon config strings set
if (empty($this→cnf['server']) || empty($this→cnf['user']) ||
!isset($this→cnf['password']) || empty($this→cnf['database'])){
if ($this→cnf['debug'])
msg(“MySQL err: insufficient configuration.”,-1,LINE,FILE);
$this→success = false;
return;
}
$this→cando['addUser'] = $this→_chkcnf(array('getUserInfo',
'getGroups',
'addUser',
'getUserID',
'getGroupID',
'addGroup',
'addUserGroup'),true);
$this→cando['delUser'] = $this→_chkcnf(array('getUserID',
'delUser',
'delUserRefs'),true);
$this→cando['modLogin'] = $this→_chkcnf(array('getUserID',
'updateUser',
'UpdateTarget'),true);
$this→cando['modPass'] = $this→cando['modLogin'];
$this→cando['modName'] = $this→cando['modLogin'];
$this→cando['modMail'] = $this→cando['modLogin'];
$this→cando['modGroups'] = $this→_chkcnf(array('getUserID',
'getGroups',
'getGroupID',
'addGroup',
'addUserGroup',
'delGroup',
'getGroupID',
'delUserGroup'),true);
/* getGroups is not yet supported
$this→cando['getGroups'] = $this→_chkcnf(array('getGroups',
'getGroupID'),false); */
$this→cando['getUsers'] = $this→_chkcnf(array('getUsers',
'getUserInfo',
'getGroups'),false);
$this→cando['getUserCount'] = $this→_chkcnf(array('getUsers'),false);
}
/
* Check if the given config strings are set
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
* @return bool
*/
function _chkcnf($keys, $wop=false){
foreach ($keys as $key){
if (empty($this→cnf[$key])) return false;
}
/* write operation and lock array filled with tables names? */
if ($wop && (!is_array($this→cnf['TablesToLock']) ||
!count($this→cnf['TablesToLock']))){
return false;
}
return true;
}
/
* Checks if the given user exists and the given plaintext password
* is correct. Furtheron it might be checked wether the user is
* member of the right group
*
* Depending on which SQL string is defined in the config, password
* checking is done here (getpass) or by the database (passcheck)
*
* @param $user user who would like access
* @param $pass user's clear text password to check
* @return bool
*
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function checkPass($user,$pass){
$rc = false;
if($this→_openDB()) {
$sql = str_replace('%{user}',$this→_escape($user),$this→cnf['checkPass']);
$sql = str_replace('%{pass}',$this→_escape($pass),$sql);
$sql = str_replace('%{dgroup}',$this→_escape($this→defaultgroup),$sql);
$result = $this→_queryDB($sql);
if($result !== false && count($result) == 1) {
if($this→cnf['forwardClearPass'] == 1)
$rc = true;
else
$rc = auth_verifyPassword($pass,$result[0]['pass']);
}
$this→_closeDB();
}
return $rc;
}
/
* [public function]
*
* Returns info about the given user needs to contain
* at least these fields:
* name string full name of the user
* mail string email addres of the user
* grps array list of groups the user is in
*
* @param $user user's nick to get data for
*
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function getUserData($user){
if($this→_openDB()) {
$this→_lockTables(“READ”);
$info = $this→_getUserInfo($user);
$this→_unlockTables();
$this→_closeDB();
} else
$info = false;
return $info;
}
/
* [public function]
*
* Create a new User. Returns false if the user already exists,
* null when an error occurred and true if everything went well.
*
* The new user will be added to the default group by this
* function if grps are not specified (default behaviour).
*
* @param $user nick of the user
* @param $pwd clear text password
* @param $name full name of the user
* @param $mail email address
* @param $grps array of groups the user should become member of
*
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @author Chris Smith chris [at] jalakai [dot] co [dot] uk
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function createUser($user,$pwd,$name,$mail,$grps=null){
if($this→_openDB()) {
if 2) !== false)
return false; user already exists
set defaultgroup if no groups were given
if ($grps == null)
$grps = array($this→defaultgroup);
$this→_lockTables(“WRITE”);
$pwd = $this→cnf['forwardClearPass'] ? $pwd : auth_cryptPassword($pwd);
$rc = $this→_addUser($user,$pwd,$name,$mail,$grps);
$this→_unlockTables();
$this→_closeDB();
if ($rc) return true;
}
return null; return error
}
/
* Modify user data [public function]
*
* An existing user dataset will be modified. Changes are given in an array.
*
* The dataset update will be rejected if the user name should be changed
* to an already existing one.
*
* The password must be provides unencrypted. Pasword cryption is done
* automatically if configured.
*
* If one or more groups could't be updated, an error would be set. In
* this case the dataset might already be changed and we can't rollback
* the changes. Transactions would be really usefull here.
*
* modifyUser() may be called without SQL statements defined that are
* needed to change group membership (for example if only the user profile
* should be modified). In this case we asure that we don't touch groups
* even $changes['grps'] is set by mistake.
*
* @param $user nick of the user to be changed
* @param $changes array of field/value pairs to be changed (password
* will be clear text)
* @return bool true on success, false on error
*
* @author Chris Smith chris [at] jalakai [dot] co [dot] uk
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function modifyUser($user, $changes) {
$rc = false;
if (!is_array($changes) || !count($changes))
return true; nothing to change
if($this→_openDB()) {
$this→_lockTables(“WRITE”);
if 3)) {
$rc = $this→_updateUserInfo($changes, $uid);
if ($rc && isset($changes['grps']) && $this→cando['modGroups']) {
$groups = $this→_getGroups($user);
$grpadd = array_diff($changes['grps'], $groups);
$grpdel = array_diff($groups, $changes['grps']);
foreach($grpadd as $group)
if 4) == false)
$rc = false;
foreach($grpdel as $group)
if 5) == false)
$rc = false;
}
}
$this→_unlockTables();
$this→_closeDB();
}
return $rc;
}
/
* [public function]
*
* Remove one or more users from the list of registered users
*
* @param array $users array of users to be deleted
* @return int the number of users deleted
*
* @author Christopher Smith chris [at] jalakai [dot] co [dot] uk
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function deleteUsers($users) {
$count = 0;
if($this→_openDB()) {
if (is_array($users) && count($users)) {
$this→_lockTables(“WRITE”);
foreach ($users as $user) {
if ($this→_delUser($user))
$count++;
}
$this→_unlockTables();
}
$this→_closeDB();
}
return $count;
}
/
* [public function]
*
* Counts users which meet certain $filter criteria.
*
* @param array $filter filter criteria in item/pattern pairs
* @return count of found users.
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function getUserCount($filter=array()) {
$rc = 0;
if($this→_openDB()) {
$sql = $this→_createSQLFilter($this→cnf['getUsers'], $filter);
if ($this→dbver >= 4) {
$sql = substr($sql, 6); /* remove 'SELECT' or 'select' */
$sql = “SELECT SQL_CALC_FOUND_ROWS”.$sql.“ LIMIT 1”;
$this→_queryDB($sql);
$result = $this→_queryDB(“SELECT FOUND_ROWS()”);
$rc = $result[0]['FOUND_ROWS()'];
} else if 6))
$rc = count($result);
$this→_closeDB();
}
return $rc;
}
/
* Bulk retrieval of user data. [public function]
*
* @param first index of first user to be returned
* @param limit max number of users to be returned
* @param filter array of field/pattern pairs
* @return array of userinfo (refer getUserData for internal userinfo details)
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function retrieveUsers($first=0,$limit=10,$filter=array()) {
$out = array();
if($this→_openDB()) {
$this→_lockTables(“READ”);
$sql = $this→_createSQLFilter($this→cnf['getUsers'], $filter);
$sql .= “ ”.$this→cnf['SortOrder'].“ LIMIT $first, $limit”;
$result = $this→_queryDB($sql);
if (!empty($result)) {
foreach ($result as $user)
if 7))
$out[$user['user']] = $info;
}
$this→_unlockTables();
$this→_closeDB();
}
return $out;
}
/
* Give user membership of a group [public function]
*
* @param $user
* @param $group
* @return bool true on success, false on error
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function joinGroup($user, $group) {
$rc = false;
if ($this→_openDB()) {
$this→_lockTables(“WRITE”);
$rc = $this→_addUserToGroup($user, $group);
$this→_unlockTables();
$this→_closeDB();
}
return $rc;
}
/
* Remove user from a group [public function]
*
* @param $user user that leaves a group
* @param $group group to leave
* @return bool
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function leaveGroup($user, $group) {
$rc = false;
if ($this→_openDB()) {
$this→_lockTables(“WRITE”);
$uid = $this→_getUserID($user);
$rc = $this→_delUserFromGroup($user, $group);
$this→_unlockTables();
$this→_closeDB();
}
return $rc;
}
/
* MySQL is case-insensitive
*/
function isCaseSensitive(){
return false;
}
/
* Adds a user to a group.
*
* If $force is set to '1' non existing groups would be created.
*
* The database connection must already be established. Otherwise
* this function does nothing and returns 'false'. It is strongly
* recommended to call this function only after all participating
* tables (group and usergroup) have been locked.
*
* @param $user user to add to a group
* @param $group name of the group
* @param $force '1' create missing groups
* @return bool 'true' on success, 'false' on error
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _addUserToGroup($user, $group, $force=0) {
$newgroup = 0;
if 8) {
$gid = $this→_getGroupID($group);
if (!$gid) {
if ($force) { create missing groups
$sql = str_replace('%{group}',$this→_escape($group),$this→cnf['addGroup']);
$gid = $this→_modifyDB($sql);
$newgroup = 1; group newly created
}
if (!$gid) return false; group didn't exist and can't be created
}
$sql = $this→cnf['addUserGroup'];
if(strpos($sql,'%{uid}') !== false){
$uid = $this→_getUserID($user);
$sql = str_replace('%{uid}', $this→_escape($uid),$sql);
}
$sql = str_replace('%{user}', $this→_escape($user),$sql);
$sql = str_replace('%{gid}', $this→_escape($gid),$sql);
$sql = str_replace('%{group}',$this→_escape($group),$sql);
if ($this→_modifyDB($sql) !== false) return true;
if ($newgroup) { remove previously created group on error
$sql = str_replace('%{gid}', $this→_escape($gid),$this→cnf['delGroup']);
$sql = str_replace('%{group}',$this→_escape($group),$sql);
$this→_modifyDB($sql);
}
}
return false;
}
/
* Remove user from a group
*
* @param $user user that leaves a group
* @param $group group to leave
* @return bool true on success, false on error
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _delUserFromGroup($user, $group) {
$rc = false;
if 9) {
$sql = $this→cnf['delUserGroup'];
if(strpos($sql,'%{uid}') !== false){
$uid = $this→_getUserID($user);
$sql = str_replace('%{uid}', $this→_escape($uid),$sql);
}
$gid = $this→_getGroupID($group);
if ($gid) {
$sql = str_replace('%{user}', $this→_escape($user),$sql);
$sql = str_replace('%{gid}', $this→_escape($gid),$sql);
$sql = str_replace('%{group}',$this→_escape($group),$sql);
$rc = $this→_modifyDB($sql) == 0 ? true : false;
}
}
return $rc;
}
/
* Retrieves a list of groups the user is a member off.
*
* The database connection must already be established
* for this function to work. Otherwise it will return
* 'false'.
*
* @param $user user whose groups should be listed
* @return bool false on error
* @return array array containing all groups on success
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _getGroups($user) {
$groups = array();
if($this→dbcon) {
$sql = str_replace('%{user}',$this→_escape($user),$this→cnf['getGroups']);
$result = $this→_queryDB($sql);
if($result !== false && count($result)) {
foreach($result as $row)
$groups[] = $row['group'];
}
return $groups;
}
return false;
}
/
* Retrieves the user id of a given user name
*
* The database connection must already be established
* for this function to work. Otherwise it will return
* 'false'.
*
* @param $user user whose id is desired
* @return user id
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _getUserID($user) {
if($this→dbcon) {
$sql = str_replace('%{user}',$this→_escape($user),$this→cnf['getUserID']);
$result = $this→_queryDB($sql);
return $result === false ? false : $result[0]['id'];
}
return false;
}
/
* Adds a new User to the database.
*
* The database connection must already be established
* for this function to work. Otherwise it will return
* 'false'.
*
* @param $user login of the user
* @param $pwd encrypted password
* @param $name full name of the user
* @param $mail email address
* @param $grps array of groups the user should become member of
* @return bool
*
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @author Chris Smith chris [at] jalakai [dot] co [dot] uk
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _addUser($user,$pwd,$name,$mail,$grps){
if($this→dbcon && is_array($grps)) {
$sql = str_replace('%{user}', $this→_escape($user),$this→cnf['addUser']);
$sql = str_replace('%{pass}', $this→_escape($pwd),$sql);
$sql = str_replace('%{name}', $this→_escape($name),$sql);
$sql = str_replace('%{email}',$this→_escape($mail),$sql);
$uid = $this→_modifyDB($sql);
if ($uid) {
foreach($grps as $group) {
$gid = $this→_addUserToGroup($user, $group, 1);
if ($gid === false) break;
}
if ($gid) return true;
else {
/* remove the new user and all group relations if a group can't
* be assigned. Newly created groups will remain in the database
* and won't be removed. This might create orphaned groups but
* is not a big issue so we ignore this problem here.
*/
$this→_delUser($user);
if ($this→cnf['debug'])
msg (“MySQL err: Adding user '$user' to group '$group' failed.”,-1,LINE,FILE);
}
}
}
return false;
}
/
* Deletes a given user and all his group references.
*
* The database connection must already be established
* for this function to work. Otherwise it will return
* 'false'.
*
* @param $user user whose id is desired
* @return bool
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _delUser($user) {
if($this→dbcon) {
$uid = $this→_getUserID($user);
if ($uid) {
$sql = str_replace('%{uid}',$this→_escape($uid),$this→cnf['delUserRefs']);
$this→_modifyDB($sql);
$sql = str_replace('%{uid}',$this→_escape($uid),$this→cnf['delUser']);
$sql = str_replace('%{user}', $this→_escape($user),$sql);
$this→_modifyDB($sql);
return true;
}
}
return false;
}
/
* getUserInfo
*
* Gets the data for a specific user The database connection
* must already be established for this function to work.
* Otherwise it will return 'false'.
*
* @param $user user's nick to get data for
* @return bool false on error
* @return array user info on success
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _getUserInfo($user){
$sql = str_replace('%{user}',$this→_escape($user),$this→cnf['getUserInfo']);
$result = $this→_queryDB($sql);
if($result !== false && count($result)) {
$info = $result[0];
$info['grps'] = $this→_getGroups($user);
return $info;
}
return false;
}
/
* Updates the user info in the database
*
* Update a user data structure in the database according changes
* given in an array. The user name can only be changes if it didn't
* exists already. If the new user name exists the update procedure
* will be aborted. The database keeps unchanged.
*
* The database connection has already to be established for this
* function to work. Otherwise it will return 'false'.
*
* The password will be crypted if necessary.
*
* @param $changes array of items to change as pairs of item and value
* @param $uid user id of dataset to change, must be unique in DB
* @return true on success or false on error
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _updateUserInfo($changes, $uid) {
$sql = $this→cnf['updateUser'].“ ”;
$cnt = 0;
$err = 0;
if($this→dbcon) {
foreach ($changes as $item ⇒ $value) {
if ($item == 'user') {
if 10)) {
$err = 1; /* new username already exists */
break; /* abort update */
}
if ($cnt++ > 0) $sql .= “, ”;
$sql .= str_replace('%{user}',$value,$this→cnf['UpdateLogin']);
} else if ($item == 'name') {
if ($cnt++ > 0) $sql .= “, ”;
$sql .= str_replace('%{name}',$value,$this→cnf['UpdateName']);
} else if ($item == 'pass') {
if (!$this→cnf['forwardClearPass'])
$value = auth_cryptPassword($value);
if ($cnt++ > 0) $sql .= “, ”;
$sql .= str_replace('%{pass}',$value,$this→cnf['UpdatePass']);
} else if ($item == 'mail') {
if ($cnt++ > 0) $sql .= “, ”;
$sql .= str_replace('%{email}',$value,$this→cnf['UpdateEmail']);
}
}
if ($err == 0) {
if ($cnt > 0) {
$sql .= “ ”.str_replace('%{uid}', $uid, $this→cnf['UpdateTarget']);
if(get_class($this) == 'auth_mysql') $sql .= “ LIMIT 1”; some PgSQL inheritance comp.
$this→_modifyDB($sql);
}
return true;
}
}
return false;
}
/
* Retrieves the group id of a given group name
*
* The database connection must already be established
* for this function to work. Otherwise it will return
* 'false'.
*
* @param $group group name which id is desired
* @return group id
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _getGroupID($group) {
if($this→dbcon) {
$sql = str_replace('%{group}',$this→_escape($group),$this→cnf['getGroupID']);
$result = $this→_queryDB($sql);
return $result === false ? false : $result[0]['id'];
}
return false;
}
/
* Opens a connection to a database and saves the handle for further
* usage in the object. The successful call to this functions is
* essential for most functions in this object.
*
* @return bool
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _openDB() {
if (!$this→dbcon) {
$con = @mysql_connect ($this→cnf['server'], $this→cnf['user'], $this→cnf['password']);
if ($con) {
if 11)) {
if 12) == 1) {
$this→dbver = $result[1];
$this→dbrev = $result[2];
$this→dbsub = $result[3];
}
$this→dbcon = $con;
if(!empty($this→cnf['charset'])){
mysql_query('SET CHARACTER SET “' . $this→cnf['charset'] . '”', $con);
}
return true; connection and database successfully opened
} else {
mysql_close ($con);
if ($this→cnf['debug'])
msg(“MySQL err: No access to database {$this→cnf['database']}.”,-1,LINE,FILE);
}
} else if ($this→cnf['debug'])
msg (“MySQL err: Connection to {$this→cnf['user']}@{$this→cnf['server']} not possible.”,
-1,LINE,FILE);
return false; connection failed
}
return true; connection already open
}
/
* Closes a database connection.
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _closeDB() {
if ($this→dbcon) {
mysql_close ($this→dbcon);
$this→dbcon = 0;
}
}
/
* Sends a SQL query to the database and transforms the result into
* an associative array.
*
* This function is only able to handle queries that returns a
* table such as SELECT.
*
* @param $query SQL string that contains the query
* @return array with the result table
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _queryDB($query) {
if($this→cnf['debug'] >= 2){
msg('MySQL query: '.hsc($query),0,LINE,FILE);
}
$resultarray = array();
if ($this→dbcon) {
$result = @mysql_query($query,$this→dbcon);
if ($result) {
while 13) !== false)
$resultarray[]=$t;
mysql_free_result ($result);
return $resultarray;
}
if ($this→cnf['debug'])
msg('MySQL err: '.mysql_error($this→dbcon),-1,LINE,FILE);
}
return false;
}
/
* Sends a SQL query to the database
*
* This function is only able to handle queries that returns
* either nothing or an id value such as INPUT, DELETE, UPDATE, etc.
*
* @param $query SQL string that contains the query
* @return insert id or 0, false on error
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _modifyDB($query) {
if ($this→dbcon) {
$result = @mysql_query($query,$this→dbcon);
if ($result) {
$rc = mysql_insert_id($this→dbcon); give back ID on insert
if ($rc !== false) return $rc;
}
if ($this→cnf['debug'])
msg('MySQL err: '.mysql_error($this→dbcon),-1,LINE,FILE);
}
return false;
}
/
* Locked a list of tables for exclusive access so that modifications
* to the database can't be disturbed by other threads. The list
* could be set with $conf['auth']['mysql']['TablesToLock'] = array()
*
* If aliases for tables are used in SQL statements, also this aliases
* must be locked. For eg. you use a table 'user' and the alias 'u' in
* some sql queries, the array must looks like this (order is important):
* array(“user”, “user AS u”);
*
* MySQL V3 is not able to handle transactions with COMMIT/ROLLBACK
* so that this functionality is simulated by this function. Nevertheless
* it is not as powerful as transactions, it is a good compromise in safty.
*
* @param $mode could be 'READ' or 'WRITE'
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _lockTables($mode) {
if ($this→dbcon) {
if (is_array($this→cnf['TablesToLock']) && !empty($this→cnf['TablesToLock'])) {
if ($mode == “READ” || $mode == “WRITE”) {
$sql = “LOCK TABLES ”;
$cnt = 0;
foreach ($this→cnf['TablesToLock'] as $table) {
if ($cnt++ != 0) $sql .= “, ”;
$sql .= “$table $mode”;
}
$this→_modifyDB($sql);
return true;
}
}
}
return false;
}
/
* Unlock locked tables. All existing locks of this thread will be
* abrogated.
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _unlockTables() {
if ($this→dbcon) {
$this→_modifyDB(“UNLOCK TABLES”);
return true;
}
return false;
}
/
* Transforms the filter settings in an filter string for a SQL database
* The database connection must already be established, otherwise the
* original SQL string without filter criteria will be returned.
*
* @param $sql SQL string to which the $filter criteria should be added
* @param $filter array of filter criteria as pairs of item and pattern
* @return SQL string with attached $filter criteria on success
* @return the original SQL string on error.
*
* @author Matthias Grimm matthiasgrimm [at] users [dot] sourceforge [dot] net
*/
function _createSQLFilter($sql, $filter) {
$SQLfilter = “”;
$cnt = 0;
if ($this→dbcon) {
foreach ($filter as $item ⇒ $pattern) {
$tmp = '%'.$this→_escape($pattern).'%';
if ($item == 'user') {
if ($cnt++ > 0) $SQLfilter .= “ AND ”;
$SQLfilter .= str_replace('%{user}',$tmp,$this→cnf['FilterLogin']);
} else if ($item == 'name') {
if ($cnt++ > 0) $SQLfilter .= “ AND ”;
$SQLfilter .= str_replace('%{name}',$tmp,$this→cnf['FilterName']);
} else if ($item == 'mail') {
if ($cnt++ > 0) $SQLfilter .= “ AND ”;
$SQLfilter .= str_replace('%{email}',$tmp,$this→cnf['FilterEmail']);
} else if ($item == 'grps') {
if ($cnt++ > 0) $SQLfilter .= “ AND ”;
$SQLfilter .= str_replace('%{group}',$tmp,$this→cnf['FilterGroup']);
}
}
we have to check SQLfilter here and must not use $cnt because if
any of cnf['Filter????'] is not defined, a malformed SQL string
would be generated.
if (strlen($SQLfilter)) {
$glue = strpos(strtolower($sql),“where”) ? “ AND ” : “ WHERE ”;
$sql = $sql.$glue.$SQLfilter;
}
}
return $sql;
}
/
* Escape a string for insertion into the database
*
* @author Andreas Gohr andi [at] splitbrain [dot] org
* @param string $string The string to escape
* @param boolean $like Escape wildcard chars as well?
*/
function _escape($string,$like=false){
if($this→dbcon){
$string = mysql_real_escape_string($string, $this→dbcon);
}else{
$string = addslashes($string);
}
if($like){
$string = addcslashes($string,'%_');
}
return $string;
}
}
Setup VIM: ex: et ts=2 :
</file>
==== Set configuration variables ====
=Angua= =Rincewind= =Adora Belle=
The last thing we have to do is: enable it! The file conf/local.protected.php is the best location to do so, because DokuWiki doesn't touch this file. If the file doesn't exist, you have to create it. Add these lines:
<code php local.protected.php><?php
/*
* phpBB3
*/
define('IN_PHPBB', true);
$phpbb_root_path = 'phpBB3/';
$conf['authtype'] = 'phpbb3';
?></code>
$phpbb_root_path has to be the relative path to phpBB from the DokuWiki directory, e.g. if phpBB is installed on the same level as DokuWiki, e.g. DokuWiki in var/user/dokuwiki and phpBB in var/user/forum/, $php_root_path has to be set to ../forum/.
I did this, but it wouldn't authenticate me. I tried pasting it in local.php, and it worked just fine. Is there a step missing?
===== phpBB3 Settings =====
==== Cookie Settings ====
=Angua= =Rincewind= =Adora Belle=
In order for the above integration to work well, it is important that the cookie settings in the phpBB3 ACP (admin control panel) are set right. For example, with wrong cookie settings, first logging in at your phpBB3 forum, then browsing your DokuWiki pages will forcibly log you out when you next load a page of your forum.
If your phpBB3 forum is installed at www.yourdomain.com/phpBB3/ and your DokuWiki is installed at www.yourdomain.com/dokuwiki/, then you should not set the “Cookie path” on the “Cookie Settings” page in the phpBB3 ACP to /phpBB3/ – that will cause the very behaviour mentioned in the example above.
Instead, set the “Cookie path” to /, and it should work as expected.
carstenfuchs [at] t [dash] online [dot] de
==== Security Settings ====
An other thing to check in the phpbb3 ACP is “Validate referrer” in the Security settings. If this setting is set to “Validate path too” the integration will not work and you will experience exactly the same issue that is described above in case of wrong cookie path. For this reason please set “Validate referrer” to “Validate host” or “none” but never to “Validate path”.
Be care…
===== Credits =====
* Thanks to Nathan Brittles who gave me the basic ideas in a thread in the official phpBB (phpBB3) forum.
===== Comments / Problems =====
* I had some problems getting this integration to work, it would not authenticate. But, I found the problem: If $_SERVER['PHP_AUTH_USER'] is set on your server, it will try to log in with that. If you have that problem, you can either unset it, or remove the corresponding code in inc/auth.php.
* For German phpbb3: Dont use ÄÖÜ for Usernames, it will not authenticate! It is possible to restrict those usernames in phpbb3 registration settings. Use ASCII Usernames instead.
* Additional info provided for Adora Belle (fixed now for me with php 5.3) Regards, djSupport