You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
697 lines
21 KiB
PHP
697 lines
21 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Folders Access Control Lists Management (RFC4314, RFC2086)
|
|
*
|
|
* @version 0.6.1
|
|
* @author Aleksander Machniak <alec@alec.pl>
|
|
*
|
|
*
|
|
* Copyright (C) 2011, Kolab Systems AG
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 2
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
class acl extends rcube_plugin
|
|
{
|
|
public $task = 'settings|addressbook|calendar';
|
|
|
|
private $rc;
|
|
private $supported = null;
|
|
private $mbox;
|
|
private $ldap;
|
|
private $specials = array('anyone', 'anonymous');
|
|
|
|
/**
|
|
* Plugin initialization
|
|
*/
|
|
function init()
|
|
{
|
|
$this->rc = rcmail::get_instance();
|
|
|
|
// Register hooks
|
|
$this->add_hook('folder_form', array($this, 'folder_form'));
|
|
// kolab_addressbook plugin
|
|
$this->add_hook('addressbook_form', array($this, 'folder_form'));
|
|
$this->add_hook('calendar_form_kolab', array($this, 'folder_form'));
|
|
// Plugin actions
|
|
$this->register_action('plugin.acl', array($this, 'acl_actions'));
|
|
$this->register_action('plugin.acl-autocomplete', array($this, 'acl_autocomplete'));
|
|
}
|
|
|
|
/**
|
|
* Handler for plugin actions (AJAX)
|
|
*/
|
|
function acl_actions()
|
|
{
|
|
$action = trim(get_input_value('_act', RCUBE_INPUT_GPC));
|
|
|
|
// Connect to IMAP
|
|
$this->rc->imap_init();
|
|
$this->rc->imap_connect();
|
|
|
|
// Load localization and configuration
|
|
$this->add_texts('localization/');
|
|
$this->load_config();
|
|
|
|
if ($action == 'save') {
|
|
$this->action_save();
|
|
}
|
|
else if ($action == 'delete') {
|
|
$this->action_delete();
|
|
}
|
|
else if ($action == 'list') {
|
|
$this->action_list();
|
|
}
|
|
|
|
// Only AJAX actions
|
|
$this->rc->output->send();
|
|
}
|
|
|
|
/**
|
|
* Handler for user login autocomplete request
|
|
*/
|
|
function acl_autocomplete()
|
|
{
|
|
$this->load_config();
|
|
|
|
$search = get_input_value('_search', RCUBE_INPUT_GPC, true);
|
|
$users = array();
|
|
|
|
if ($this->init_ldap()) {
|
|
$this->ldap->set_pagesize(15);
|
|
$result = $this->ldap->search('*', $search);
|
|
|
|
foreach ($result->records as $record) {
|
|
$user = $record['uid'];
|
|
|
|
if (is_array($user)) {
|
|
$user = array_filter($user);
|
|
$user = $user[0];
|
|
}
|
|
|
|
if ($user) {
|
|
if ($record['name'])
|
|
$user = $record['name'] . ' (' . $user . ')';
|
|
|
|
$users[] = $user;
|
|
}
|
|
}
|
|
}
|
|
|
|
sort($users, SORT_LOCALE_STRING);
|
|
|
|
$this->rc->output->command('ksearch_query_results', $users, $search);
|
|
$this->rc->output->send();
|
|
}
|
|
|
|
/**
|
|
* Handler for 'folder_form' hook
|
|
*
|
|
* @param array $args Hook arguments array (form data)
|
|
*
|
|
* @return array Hook arguments array
|
|
*/
|
|
function folder_form($args)
|
|
{
|
|
// Edited folder name (empty in create-folder mode)
|
|
$mbox_imap = $args['options']['name'];
|
|
if (!strlen($mbox_imap)) {
|
|
return $args;
|
|
}
|
|
/*
|
|
// Do nothing on protected folders (?)
|
|
if ($args['options']['protected']) {
|
|
return $args;
|
|
}
|
|
*/
|
|
// Namespace root
|
|
if ($args['options']['is_root']) {
|
|
return $args;
|
|
}
|
|
|
|
// Get MYRIGHTS
|
|
if (!($myrights = $args['options']['rights'])) {
|
|
return $args;
|
|
}
|
|
|
|
// Do nothing if no ACL support
|
|
if (!$this->rc->imap->get_capability('ACL')) {
|
|
return $args;
|
|
}
|
|
|
|
// Load localization and include scripts
|
|
$this->load_config();
|
|
$this->add_texts('localization/', array('deleteconfirm', 'norights',
|
|
'nouser', 'deleting', 'saving'));
|
|
$this->include_script('acl.js');
|
|
$this->rc->output->include_script('list.js');
|
|
$this->include_stylesheet($this->local_skin_path().'/acl.css');
|
|
|
|
// add Info fieldset if it doesn't exist
|
|
if (!isset($args['form']['props']['fieldsets']['info']))
|
|
$args['form']['props']['fieldsets']['info'] = array(
|
|
'name' => rcube_label('info'),
|
|
'content' => array());
|
|
|
|
// Display folder rights to 'Info' fieldset
|
|
$args['form']['props']['fieldsets']['info']['content']['myrights'] = array(
|
|
'label' => Q($this->gettext('myrights')),
|
|
'value' => $this->acl2text($myrights)
|
|
);
|
|
|
|
// Return if not folder admin
|
|
if (!in_array('a', $myrights)) {
|
|
return $args;
|
|
}
|
|
|
|
// The 'Sharing' tab
|
|
$this->mbox = $mbox_imap;
|
|
$this->rc->output->set_env('acl_users_source', (bool) $this->rc->config->get('acl_users_source'));
|
|
$this->rc->output->set_env('mailbox', $mbox_imap);
|
|
$this->rc->output->add_handlers(array(
|
|
'acltable' => array($this, 'templ_table'),
|
|
'acluser' => array($this, 'templ_user'),
|
|
'aclrights' => array($this, 'templ_rights'),
|
|
));
|
|
|
|
$args['form']['sharing'] = array(
|
|
'name' => Q($this->gettext('sharing')),
|
|
'content' => $this->rc->output->parse('acl.table', false, false),
|
|
);
|
|
|
|
return $args;
|
|
}
|
|
|
|
/**
|
|
* Creates ACL rights table
|
|
*
|
|
* @param array $attrib Template object attributes
|
|
*
|
|
* @return string HTML Content
|
|
*/
|
|
function templ_table($attrib)
|
|
{
|
|
if (empty($attrib['id']))
|
|
$attrib['id'] = 'acl-table';
|
|
|
|
$out = $this->list_rights($attrib);
|
|
|
|
$this->rc->output->add_gui_object('acltable', $attrib['id']);
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Creates ACL rights form (rights list part)
|
|
*
|
|
* @param array $attrib Template object attributes
|
|
*
|
|
* @return string HTML Content
|
|
*/
|
|
function templ_rights($attrib)
|
|
{
|
|
// Get supported rights
|
|
$supported = $this->rights_supported();
|
|
|
|
// depending on server capability either use 'te' or 'd' for deleting msgs
|
|
$deleteright = implode(array_intersect(str_split('ted'), $supported));
|
|
|
|
$out = '';
|
|
$ul = '';
|
|
$input = new html_checkbox();
|
|
|
|
// Advanced rights
|
|
$attrib['id'] = 'advancedrights';
|
|
foreach ($supported as $val) {
|
|
$id = "acl$val";
|
|
$ul .= html::tag('li', null,
|
|
$input->show('', array(
|
|
'name' => "acl[$val]", 'value' => $val, 'id' => $id))
|
|
. html::label(array('for' => $id, 'title' => $this->gettext('longacl'.$val)),
|
|
$this->gettext('acl'.$val)));
|
|
}
|
|
|
|
$out = html::tag('ul', $attrib, $ul, html::$common_attrib);
|
|
|
|
// Simple rights
|
|
$ul = '';
|
|
$attrib['id'] = 'simplerights';
|
|
$items = array(
|
|
'read' => 'lrs',
|
|
'write' => 'wi',
|
|
'delete' => $deleteright,
|
|
'other' => preg_replace('/[lrswi'.$deleteright.']/', '', implode($supported)),
|
|
);
|
|
|
|
foreach ($items as $key => $val) {
|
|
$id = "acl$key";
|
|
$ul .= html::tag('li', null,
|
|
$input->show('', array(
|
|
'name' => "acl[$val]", 'value' => $val, 'id' => $id))
|
|
. html::label(array('for' => $id, 'title' => $this->gettext('longacl'.$key)),
|
|
$this->gettext('acl'.$key)));
|
|
}
|
|
|
|
$out .= "\n" . html::tag('ul', $attrib, $ul, html::$common_attrib);
|
|
|
|
$this->rc->output->set_env('acl_items', $items);
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Creates ACL rights form (user part)
|
|
*
|
|
* @param array $attrib Template object attributes
|
|
*
|
|
* @return string HTML Content
|
|
*/
|
|
function templ_user($attrib)
|
|
{
|
|
// Create username input
|
|
$attrib['name'] = 'acluser';
|
|
|
|
$textfield = new html_inputfield($attrib);
|
|
|
|
$fields['user'] = html::label(array('for' => 'iduser'), $this->gettext('username'))
|
|
. ' ' . $textfield->show();
|
|
|
|
// Add special entries
|
|
if (!empty($this->specials)) {
|
|
foreach ($this->specials as $key) {
|
|
$fields[$key] = html::label(array('for' => 'id'.$key), $this->gettext($key));
|
|
}
|
|
}
|
|
|
|
$this->rc->output->set_env('acl_specials', $this->specials);
|
|
|
|
// Create list with radio buttons
|
|
if (count($fields) > 1) {
|
|
$ul = '';
|
|
$radio = new html_radiobutton(array('name' => 'usertype'));
|
|
foreach ($fields as $key => $val) {
|
|
$ul .= html::tag('li', null, $radio->show($key == 'user' ? 'user' : '',
|
|
array('value' => $key, 'id' => 'id'.$key))
|
|
. $val);
|
|
}
|
|
|
|
$out = html::tag('ul', array('id' => 'usertype'), $ul, html::$common_attrib);
|
|
}
|
|
// Display text input alone
|
|
else {
|
|
$out = $fields['user'];
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Creates ACL rights table
|
|
*
|
|
* @param array $attrib Template object attributes
|
|
*
|
|
* @return string HTML Content
|
|
*/
|
|
private function list_rights($attrib=array())
|
|
{
|
|
// Get ACL for the folder
|
|
$acl = $this->rc->imap->get_acl($this->mbox);
|
|
|
|
if (!is_array($acl)) {
|
|
$acl = array();
|
|
}
|
|
|
|
// Keep special entries (anyone/anonymous) on top of the list
|
|
if (!empty($this->specials) && !empty($acl)) {
|
|
foreach ($this->specials as $key) {
|
|
if (isset($acl[$key])) {
|
|
$acl_special[$key] = $acl[$key];
|
|
unset($acl[$key]);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Sort the list by username
|
|
uksort($acl, 'strnatcasecmp');
|
|
|
|
if (!empty($acl_special)) {
|
|
$acl = array_merge($acl_special, $acl);
|
|
}
|
|
|
|
// Get supported rights and build column names
|
|
$supported = $this->rights_supported();
|
|
|
|
// depending on server capability either use 'te' or 'd' for deleting msgs
|
|
$deleteright = implode(array_intersect(str_split('ted'), $supported));
|
|
|
|
// Use advanced or simple (grouped) rights
|
|
$advanced = $this->rc->config->get('acl_advanced_mode');
|
|
|
|
if ($advanced) {
|
|
$items = array();
|
|
foreach ($supported as $sup) {
|
|
$items[$sup] = $sup;
|
|
}
|
|
}
|
|
else {
|
|
$items = array(
|
|
'read' => 'lrs',
|
|
'write' => 'wi',
|
|
'delete' => $deleteright,
|
|
'other' => preg_replace('/[lrswi'.$deleteright.']/', '', implode($supported)),
|
|
);
|
|
}
|
|
|
|
// Create the table
|
|
$attrib['noheader'] = true;
|
|
$table = new html_table($attrib);
|
|
|
|
// Create table header
|
|
$table->add_header('user', $this->gettext('identifier'));
|
|
foreach (array_keys($items) as $key) {
|
|
$table->add_header('acl'.$key, $this->gettext('shortacl'.$key));
|
|
}
|
|
|
|
$i = 1;
|
|
$js_table = array();
|
|
foreach ($acl as $user => $rights) {
|
|
if ($this->rc->imap->conn->user == $user) {
|
|
continue;
|
|
}
|
|
|
|
// filter out virtual rights (c or d) the server may return
|
|
$userrights = array_intersect($rights, $supported);
|
|
$userid = html_identifier($user);
|
|
|
|
if (!empty($this->specials) && in_array($user, $this->specials)) {
|
|
$user = $this->gettext($user);
|
|
}
|
|
|
|
$table->add_row(array('id' => 'rcmrow'.$userid));
|
|
$table->add('user', Q($user));
|
|
|
|
foreach ($items as $key => $right) {
|
|
$in = $this->acl_compare($userrights, $right);
|
|
switch ($in) {
|
|
case 2: $class = 'enabled'; break;
|
|
case 1: $class = 'partial'; break;
|
|
default: $class = 'disabled'; break;
|
|
}
|
|
$table->add('acl' . $key . ' ' . $class, '');
|
|
}
|
|
|
|
$js_table[$userid] = implode($userrights);
|
|
}
|
|
|
|
$this->rc->output->set_env('acl', $js_table);
|
|
$this->rc->output->set_env('acl_advanced', $advanced);
|
|
|
|
$out = $table->show();
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Handler for ACL update/create action
|
|
*/
|
|
private function action_save()
|
|
{
|
|
$mbox = trim(get_input_value('_mbox', RCUBE_INPUT_GPC, true)); // UTF7-IMAP
|
|
$user = trim(get_input_value('_user', RCUBE_INPUT_GPC));
|
|
$acl = trim(get_input_value('_acl', RCUBE_INPUT_GPC));
|
|
$oldid = trim(get_input_value('_old', RCUBE_INPUT_GPC));
|
|
|
|
$acl = array_intersect(str_split($acl), $this->rights_supported());
|
|
|
|
if (!empty($this->specials) && in_array($user, $this->specials)) {
|
|
$username = $this->gettext($user);
|
|
}
|
|
else {
|
|
if (!strpos($user, '@') && ($realm = $this->get_realm())) {
|
|
$user .= '@' . rcube_idn_to_ascii(preg_replace('/^@/', '', $realm));
|
|
}
|
|
$username = $user;
|
|
}
|
|
|
|
if ($acl && $user && $user != $_SESSION['username'] && strlen($mbox)) {
|
|
$result = $this->rc->imap->set_acl($mbox, $user, $acl);
|
|
}
|
|
|
|
if ($result) {
|
|
$ret = array('id' => html_identifier($user),
|
|
'username' => $username, 'acl' => implode($acl), 'old' => $oldid);
|
|
$this->rc->output->command('acl_update', $ret);
|
|
$this->rc->output->show_message($oldid ? 'acl.updatesuccess' : 'acl.createsuccess', 'confirmation');
|
|
}
|
|
else {
|
|
$this->rc->output->show_message($oldid ? 'acl.updateerror' : 'acl.createerror', 'error');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handler for ACL delete action
|
|
*/
|
|
private function action_delete()
|
|
{
|
|
$mbox = trim(get_input_value('_mbox', RCUBE_INPUT_GPC, true)); //UTF7-IMAP
|
|
$user = trim(get_input_value('_user', RCUBE_INPUT_GPC));
|
|
|
|
$user = explode(',', $user);
|
|
|
|
foreach ($user as $u) {
|
|
if ($this->rc->imap->delete_acl($mbox, $u)) {
|
|
$this->rc->output->command('acl_remove_row', html_identifier($u));
|
|
}
|
|
else {
|
|
$error = true;
|
|
}
|
|
}
|
|
|
|
if (!$error) {
|
|
$this->rc->output->show_message('acl.deletesuccess', 'confirmation');
|
|
}
|
|
else {
|
|
$this->rc->output->show_message('acl.deleteerror', 'error');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handler for ACL list update action (with display mode change)
|
|
*/
|
|
private function action_list()
|
|
{
|
|
if (in_array('acl_advanced_mode', (array)$this->rc->config->get('dont_override'))) {
|
|
return;
|
|
}
|
|
|
|
$this->mbox = trim(get_input_value('_mbox', RCUBE_INPUT_GPC, true)); // UTF7-IMAP
|
|
$advanced = trim(get_input_value('_mode', RCUBE_INPUT_GPC));
|
|
$advanced = $advanced == 'advanced' ? true : false;
|
|
|
|
// Save state in user preferences
|
|
$this->rc->user->save_prefs(array('acl_advanced_mode' => $advanced));
|
|
|
|
$out = $this->list_rights();
|
|
|
|
$out = preg_replace(array('/^<table[^>]+>/', '/<\/table>$/'), '', $out);
|
|
|
|
$this->rc->output->command('acl_list_update', $out);
|
|
}
|
|
|
|
/**
|
|
* Creates <UL> list with descriptive access rights
|
|
*
|
|
* @param array $rights MYRIGHTS result
|
|
*
|
|
* @return string HTML content
|
|
*/
|
|
function acl2text($rights)
|
|
{
|
|
if (empty($rights)) {
|
|
return '';
|
|
}
|
|
|
|
$supported = $this->rights_supported();
|
|
$list = array();
|
|
$attrib = array(
|
|
'name' => 'rcmyrights',
|
|
'style' => 'margin:0; padding:0 15px;',
|
|
);
|
|
|
|
foreach ($supported as $right) {
|
|
if (in_array($right, $rights)) {
|
|
$list[] = html::tag('li', null, Q($this->gettext('acl' . $right)));
|
|
}
|
|
}
|
|
|
|
if (count($list) == count($supported))
|
|
return Q($this->gettext('aclfull'));
|
|
|
|
return html::tag('ul', $attrib, implode("\n", $list));
|
|
}
|
|
|
|
/**
|
|
* Compares two ACLs (according to supported rights)
|
|
*
|
|
* @param array $acl1 ACL rights array (or string)
|
|
* @param array $acl2 ACL rights array (or string)
|
|
*
|
|
* @param int Comparision result, 2 - full match, 1 - partial match, 0 - no match
|
|
*/
|
|
function acl_compare($acl1, $acl2)
|
|
{
|
|
if (!is_array($acl1)) $acl1 = str_split($acl1);
|
|
if (!is_array($acl2)) $acl2 = str_split($acl2);
|
|
|
|
$rights = $this->rights_supported();
|
|
|
|
$acl1 = array_intersect($acl1, $rights);
|
|
$acl2 = array_intersect($acl2, $rights);
|
|
$res = array_intersect($acl1, $acl2);
|
|
|
|
$cnt1 = count($res);
|
|
$cnt2 = count($acl2);
|
|
|
|
if ($cnt1 == $cnt2)
|
|
return 2;
|
|
else if ($cnt1)
|
|
return 1;
|
|
else
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Get list of supported access rights (according to RIGHTS capability)
|
|
*
|
|
* @return array List of supported access rights abbreviations
|
|
*/
|
|
function rights_supported()
|
|
{
|
|
if ($this->supported !== null) {
|
|
return $this->supported;
|
|
}
|
|
|
|
$capa = $this->rc->imap->get_capability('RIGHTS');
|
|
|
|
if (is_array($capa)) {
|
|
$rights = strtolower($capa[0]);
|
|
}
|
|
else {
|
|
$rights = 'cd';
|
|
}
|
|
|
|
return $this->supported = str_split('lrswi' . $rights . 'pa');
|
|
}
|
|
|
|
/**
|
|
* Username realm detection.
|
|
*
|
|
* @return string Username realm (domain)
|
|
*/
|
|
private function get_realm()
|
|
{
|
|
// When user enters a username without domain part, realm
|
|
// alows to add it to the username (and display correct username in the table)
|
|
|
|
if (isset($_SESSION['acl_username_realm'])) {
|
|
return $_SESSION['acl_username_realm'];
|
|
}
|
|
|
|
// find realm in username of logged user (?)
|
|
list($name, $domain) = explode('@', $_SESSION['username']);
|
|
|
|
// Use (always existent) ACL entry on the INBOX for the user to determine
|
|
// whether or not the user ID in ACL entries need to be qualified and how
|
|
// they would need to be qualified.
|
|
if (empty($domain)) {
|
|
$acl = $this->rc->imap->get_acl('INBOX');
|
|
if (is_array($acl)) {
|
|
$regexp = '/^' . preg_quote($_SESSION['username'], '/') . '@(.*)$/';
|
|
$regexp = '/^' . preg_quote('aleksander.machniak', '/') . '@(.*)$/';
|
|
foreach (array_keys($acl) as $name) {
|
|
if (preg_match($regexp, $name, $matches)) {
|
|
$domain = $matches[1];
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $_SESSION['acl_username_realm'] = $domain;
|
|
}
|
|
|
|
/**
|
|
* Initializes autocomplete LDAP backend
|
|
*/
|
|
private function init_ldap()
|
|
{
|
|
if ($this->ldap)
|
|
return $this->ldap->ready;
|
|
|
|
// get LDAP config
|
|
$config = $this->rc->config->get('acl_users_source');
|
|
|
|
if (empty($config)) {
|
|
return false;
|
|
}
|
|
|
|
// not an array, use configured ldap_public source
|
|
if (!is_array($config)) {
|
|
$ldap_config = (array) $this->rc->config->get('ldap_public');
|
|
$config = $ldap_config[$config];
|
|
}
|
|
|
|
$uid_field = $this->rc->config->get('acl_users_field', 'mail');
|
|
$filter = $this->rc->config->get('acl_users_filter');
|
|
|
|
if (empty($uid_field) || empty($config)) {
|
|
return false;
|
|
}
|
|
|
|
// get name attribute
|
|
if (!empty($config['fieldmap'])) {
|
|
$name_field = $config['fieldmap']['name'];
|
|
}
|
|
// ... no fieldmap, use the old method
|
|
if (empty($name_field)) {
|
|
$name_field = $config['name_field'];
|
|
}
|
|
|
|
// add UID field to fieldmap, so it will be returned in a record with name
|
|
$config['fieldmap'] = array(
|
|
'name' => $name_field,
|
|
'uid' => $uid_field,
|
|
);
|
|
|
|
// search in UID and name fields
|
|
$config['search_fields'] = array_values($config['fieldmap']);
|
|
$config['required_fields'] = array($uid_field);
|
|
|
|
// set search filter
|
|
if ($filter)
|
|
$config['filter'] = $filter;
|
|
|
|
// disable vlv
|
|
$config['vlv'] = false;
|
|
|
|
// Initialize LDAP connection
|
|
$this->ldap = new rcube_ldap($config,
|
|
$this->rc->config->get('ldap_debug'),
|
|
$this->rc->config->mail_domain($_SESSION['imap_host']));
|
|
|
|
return $this->ldap->ready;
|
|
}
|
|
}
|