*
* Syntax:
* ~~GROUPMGR|[groups to manage]|[allowed users and groups]~~
*
* Examples:
* ~~GROUPMGR|posters|@moderators~~
* Members of group 'posters' can be managed by group 'moderators'
*
* ~~GROUPMGR|groupa, groupb|joe, @admin~~
* Members of groups 'groupa' and 'groupb' can be managed by user 'joe'
* members of the 'admin' group
*
* Note: superuser groups can only be managed by super users,
* forbidden groups can be configured,
* and users cannot remove themselves from the group that lets them access
* the group manager (including admins)
*
* Note: if require_conf_namespace config option is set, then plugin looks in
* conf_namespace:$ID for configuration. Plugin will also check config
* namespace if a placeholder tag is used (~~GROUPMGR~~). This is the
* default configuration for security reasons.
*
*/
// must be run within Dokuwiki
if (!defined('DOKU_INC')) die();
if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once DOKU_PLUGIN.'syntax.php';
function remove_item_by_value($val, $arr, $preserve = true) {
if (empty($arr) || !is_array($arr)) { return false; }
foreach(array_keys($arr,$val) as $key){ unset($arr[$key]); }
return ($preserve) ? $arr : array_values($arr);
}
class syntax_plugin_groupmgr extends DokuWiki_Syntax_Plugin {
/**
* Plugin information
*/
function getInfo(){
return array(
'author' => 'Alex Forencich',
'email' => 'alex@alexforencich.com',
'date' => '2010-11-28',
'name' => 'Group Manager Syntax plugin',
'desc' => 'Embeddable group manager',
'url' => 'http://www.alexforencich.com/'
);
}
/**
* Plugin type
*/
function getType() {
return 'substition';
}
/**
* PType
*/
function getPType() {
return 'normal';
}
/**
* Sort order
*/
function getSort() {
return 160;
}
/**
* Register syntax handler
*/
function connectTo($mode) {
$this->Lexer->addSpecialPattern('~~GROUPMGR\|[^~]*?~~',$mode,'plugin_groupmgr');
$this->Lexer->addSpecialPattern('~~GROUPMGR~~',$mode,'plugin_groupmgr');
}
/**
* Handle match
*/
function handle($match, $state, $pos, &$handler){
$data = array(null, $state, $pos);
if (strlen($match) == 12)
return $data;
// Strip away tag
$match = substr($match, 11, -2);
// split arguments
$ar = explode("|", $match);
$match = array();
// reorganize into array
foreach ($ar as $it) {
$ar2 = explode(",", $it);
foreach ($ar2 as &$it2)
$it2 = trim($it2);
$match[] = $ar2;
}
// pass to render method
$data[0] = $match;
return $data;
}
/**
* Render it
*/
function render($mode, &$renderer, $data) {
global $auth;
global $lang;
global $INFO;
global $conf;
global $ID;
// we are parsing a submitted comment...
if (isset($_REQUEST['comment']))
return false;
// disable caching
$renderer->info['cache'] = false;
$this->setupLocale();
if (!method_exists($auth,"retrieveUsers")) return false;
if ($mode == 'xhtml') {
// need config namespace?
if ($this->getConf('require_conf_namespace')) {
// set it to null, it will be reloaded anyway
$data[0] = null;
}
$conf_namespace = $this->getConf('conf_namespace');
// empty tag?
if (is_null($data[0]) || count($data[0]) == 0) {
// load from conf namespace
// build page name
$conf_page = "";
if (substr($ID, 0, strlen($conf_namespace)) != $conf_namespace) {
$conf_page .= $conf_namespace;
if (substr($conf_page, -1) != ':') $conf_page .= ":";
}
$conf_page .= $ID;
// get file name
$fn = wikiFN($conf_page);
if (!file_exists($fn))
return false;
// read file
$page = file_get_contents($fn);
// find config tag
$i = preg_match('/~~GROUPMGR\|[^~]*?~~/', $page, &$match);
if ($i == 0)
return false;
// parse config
$match = substr($match[0], 11, -2);
$ar = explode("|", $match);
$match = array();
// reorganize into array
foreach ($ar as $it) {
$ar2 = explode(",", $it);
foreach ($ar2 as &$it2)
$it2 = trim($it2);
$match[] = $ar2;
}
// pass to render method
$data[0] = $match;
}
// don't render if an argument hasn't been specified
if (!isset($data[0][0]) || !isset($data[0][1]))
return false;
$grplst = $data[0][0];
$authlst = $data[0][1];
// parse forbidden groups
$forbiddengrplst = array();
$str = $this->getConf('forbidden_groups');
if (isset($str)) {
$arr = explode(",", $str);
foreach ($arr as $val) {
$val = trim($val);
$forbiddengrplst[] = $val;
}
}
// parse admin groups
$admingrplst = array();
if (isset($conf['superuser'])) {
$arr = explode(",", $conf['superuser']);
foreach ($arr as $val) {
$val = trim($val);
if ($val[0] == "@") {
$val = substr($val, 1);
$admingrplst[] = $val;
}
}
}
// forbid admin groups if user is not a superuser
if (!$INFO['isadmin']) {
foreach ($admingrplst as $val) {
$forbiddengrplst[] = $val;
}
}
// remove forbidden groups from group list
foreach ($forbiddengrplst as $val) {
$grplst = remove_item_by_value($val, $grplst, false);
}
// build array of user's credentials
$check = array($_SERVER['REMOTE_USER']);
if (is_array($INFO['userinfo'])) {
foreach ($INFO['userinfo']['grps'] as $val) {
$check[] = "@" . $val;
}
}
// does user have permission?
// Also, save authenticated group for later
$authbygrp = "";
$ok = 0;
foreach ($authlst as $val) {
if (in_array($val, $check)) {
$ok = 1;
if ($val[0] == "@") {
$authbygrp = substr($val, 1);
}
}
}
// continue if user has explicit permission or is an admin
if ($INFO['isadmin'] || $ok) {
// authorized
$status = 0;
// nab user info
$users = $auth->retrieveUsers(0, 0, array());
// open form
$renderer->doc .= "";
// display relevant status message
if ($status == 1) {
msg($this->lang['updatesuccess'], 1);
} else if ($status == 2) {
msg($this->lang['updatefailed'], -1);
}
} else {
// not authorized
$renderer->doc .= "