* * Copyright (C) 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 as published by * the Free Software Foundation, either version 3 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, see http://www.gnu.org/licenses/. */ class acl extends rcube_plugin { public $task = 'settings'; private $rc; private $supported = null; private $mbox; private $ldap; private $specials = ['anyone', 'anonymous']; /** * Plugin initialization */ function init() { $this->rc = rcmail::get_instance(); // Register hooks $this->add_hook('folder_form', [$this, 'folder_form']); // Plugin actions $this->register_action('plugin.acl', [$this, 'acl_actions']); $this->register_action('plugin.acl-autocomplete', [$this, 'acl_autocomplete']); } /** * Handler for plugin actions (AJAX) */ function acl_actions() { $action = trim(rcube_utils::get_input_string('_act', rcube_utils::INPUT_GPC)); // Connect to IMAP $this->rc->storage_init(); // 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 = rcube_utils::get_input_string('_search', rcube_utils::INPUT_GPC, true); $reqid = rcube_utils::get_input_string('_reqid', rcube_utils::INPUT_GPC); $users = []; $keys = []; if ($this->init_ldap()) { $max = (int) $this->rc->config->get('autocomplete_max', 15); $mode = (int) $this->rc->config->get('addressbook_search_mode'); $this->ldap->set_pagesize($max); $result = $this->ldap->search('*', $search, $mode); foreach ($result->records as $record) { $user = $record['uid']; if (is_array($user) && !empty($user)) { $user = array_filter($user); $user = $user[0]; } if ($user) { $display = rcube_addressbook::compose_search_name($record); $user = ['name' => $user, 'display' => $display]; $users[] = $user; $keys[] = $display ?: $user['name']; } } if ($this->rc->config->get('acl_groups')) { $prefix = $this->rc->config->get('acl_group_prefix'); $group_field = $this->rc->config->get('acl_group_field', 'name'); $result = $this->ldap->list_groups($search, $mode); foreach ($result as $record) { $group = $record['name']; $group_id = is_array($record[$group_field]) ? $record[$group_field][0] : $record[$group_field]; if ($group) { $users[] = ['name' => ($prefix ?: '') . $group_id, 'display' => $group, 'type' => 'group']; $keys[] = $group; } } } } if (count($users)) { // sort users index asort($keys, SORT_LOCALE_STRING); // re-sort users according to index foreach ($keys as $idx => $val) { $keys[$idx] = $users[$idx]; } $users = array_values($keys); } $this->rc->output->command('ksearch_query_results', $users, $search, $reqid); $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) { $mbox_imap = $args['options']['name'] ?? ''; $myrights = $args['options']['rights'] ?? ''; // Edited folder name (empty in create-folder mode) if (!strlen($mbox_imap)) { return $args; } /* // Do nothing on protected folders (?) if (!empty($args['options']['protected'])) { return $args; } */ // Get MYRIGHTS if (empty($myrights)) { return $args; } // Load localization and include scripts $this->load_config(); $this->specials = $this->rc->config->get('acl_specials', $this->specials); $this->add_texts('localization/', ['deleteconfirm', 'norights', 'nouser', 'deleting', 'saving', 'newuser', 'editperms']); $this->rc->output->add_label('save', 'cancel'); $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'] = [ 'name' => $this->rc->gettext('info'), 'content' => [] ]; // Display folder rights to 'Info' fieldset $args['form']['props']['fieldsets']['info']['content']['myrights'] = [ 'label' => rcube::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([ 'acltable' => [$this, 'templ_table'], 'acluser' => [$this, 'templ_user'], 'aclrights' => [$this, 'templ_rights'], ]); $this->rc->output->set_env('autocomplete_max', (int) $this->rc->config->get('autocomplete_max', 15)); $this->rc->output->set_env('autocomplete_min_length', $this->rc->config->get('autocomplete_min_length')); $this->rc->output->add_label('autocompletechars', 'autocompletemore'); $args['form']['sharing'] = [ 'name' => rcube::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(); // give plugins the opportunity to adjust this list $data = $this->rc->plugins->exec_hook('acl_rights_supported', ['rights' => $supported, 'folder' => $this->mbox, 'labels' => []] ); $supported = $data['rights']; // 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 $key => $val) { $id = "acl$val"; $ul .= html::tag('li', null, $input->show('', ['name' => "acl[$val]", 'value' => $val, 'id' => $id]) . html::label(['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 = [ 'read' => 'lrs', 'write' => 'wi', 'delete' => $deleteright, 'other' => preg_replace('/[lrswi'.$deleteright.']/', '', implode($supported)), ]; // give plugins the opportunity to adjust this list $data = $this->rc->plugins->exec_hook('acl_rights_simple', ['rights' => $items, 'folder' => $this->mbox, 'labels' => [], 'titles' => []] ); foreach ($data['rights'] as $key => $val) { $id = "acl$key"; $title = !empty($data['titles'][$key]) ? $data['titles'][$key] : $this->gettext('longacl'.$key); $label = !empty($data['labels'][$key]) ? $data['labels'][$key] : $this->gettext('acl'.$key); $ul .= html::tag('li', null, $input->show('', ['name' => "acl[$val]", 'value' => $val, 'id' => $id]) . html::label(['for' => $id, 'title' => $title], $label) ); } $out .= "\n" . html::tag('ul', $attrib, $ul, html::$common_attrib); $this->rc->output->set_env('acl_items', $data['rights']); 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 $class = !empty($attrib['class']) ? $attrib['class'] : ''; $attrib['name'] = 'acluser'; $attrib['class'] = 'form-control'; $textfield = new html_inputfield($attrib); $label = html::label(['for' => $attrib['id'], 'class' => 'input-group-text'], $this->gettext('username')); $fields['user'] = html::div('input-group', html::span('input-group-prepend', $label) . ' ' . $textfield->show() ); // Add special entries if (!empty($this->specials)) { foreach ($this->specials as $key) { $fields[$key] = html::label(['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 = ''; foreach ($fields as $key => $val) { $radio = new html_radiobutton(['name' => 'usertype']); $radio = $radio->show($key == 'user' ? 'user' : '', ['value' => $key, 'id' => 'id' . $key]); $ul .= html::tag('li', null, $radio . $val); } $out = html::tag('ul', ['id' => 'usertype', 'class' => $class], $ul, html::$common_attrib); } // Display text input alone else { $out = html::div($class, $fields['user']); } return $out; } /** * Creates ACL rights table * * @param array $attrib Template object attributes * * @return string HTML Content */ private function list_rights($attrib = []) { // Get ACL for the folder $acl = $this->rc->storage->get_acl($this->mbox); if (!is_array($acl)) { $acl = []; } // 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(); // give plugins the opportunity to adjust this list $data = $this->rc->plugins->exec_hook('acl_rights_supported', ['rights' => $supported, 'folder' => $this->mbox, 'labels' => []] ); $supported = $data['rights']; // 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 = []; foreach ($supported as $sup) { $items[$sup] = $sup; } } else { $items = [ 'read' => 'lrs', 'write' => 'wi', 'delete' => $deleteright, 'other' => preg_replace('/[lrswi'.$deleteright.']/', '', implode($supported)), ]; // give plugins the opportunity to adjust this list $data = $this->rc->plugins->exec_hook('acl_rights_simple', ['rights' => $items, 'folder' => $this->mbox, 'labels' => []] ); $items = $data['rights']; } // Create the table $attrib['noheader'] = true; $table = new html_table($attrib); $self = $this->rc->get_user_name(); $js_table = []; // Create table header $table->add_header('user', $this->gettext('identifier')); foreach (array_keys($items) as $key) { $label = !empty($data['labels'][$key]) ? $data['labels'][$key] : $this->gettext('shortacl' . $key); $table->add_header(['class' => 'acl' . $key, 'title' => $label], $label); } foreach ($acl as $user => $rights) { if ($user === $self) { continue; } // filter out virtual rights (c or d) the server may return $userrights = array_intersect($rights, $supported); $userid = rcube_utils::html_identifier($user); $title = null; if (!empty($this->specials) && in_array($user, $this->specials)) { $username = $this->gettext($user); } else { $username = $this->resolve_acl_identifier($user, $title); } $table->add_row(['id' => 'rcmrow' . $userid, 'data-userid' => $user]); $table->add(['class' => 'user text-nowrap', 'title' => $title], html::a(['id' => 'rcmlinkrow' . $userid], rcube::Q($username)) ); 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(rcube_utils::get_input_string('_mbox', rcube_utils::INPUT_POST, true)); // UTF7-IMAP $user = trim(rcube_utils::get_input_string('_user', rcube_utils::INPUT_POST)); $acl = trim(rcube_utils::get_input_string('_acl', rcube_utils::INPUT_POST)); $oldid = trim(rcube_utils::get_input_string('_old', rcube_utils::INPUT_POST)); $acl = array_intersect(str_split($acl), $this->rights_supported()); $users = $oldid ? [$user] : explode(',', $user); $result = 0; $self = $this->rc->get_user_name(); foreach ($users as $user) { $user = trim($user); $username = ''; $prefix = $this->rc->config->get('acl_groups') ? $this->rc->config->get('acl_group_prefix') : ''; if ($prefix && strpos($user, $prefix) === 0) { $username = $user; } else if (!empty($this->specials) && in_array($user, $this->specials)) { $username = $this->gettext($user); } else if (!empty($user)) { if (!strpos($user, '@') && ($realm = $this->get_realm())) { $user .= '@' . rcube_utils::idn_to_ascii(preg_replace('/^@/', '', $realm)); } // Make sure it's valid email address to prevent from "disappearing folder" // issue in Cyrus IMAP e.g. when the acl user identifier contains spaces inside. if (strpos($user, '@') && !rcube_utils::check_email($user, false)) { $user = null; } $username = $user; } if (!$acl || !$user || !strlen($mbox)) { continue; } $user = $this->mod_login($user); $username = $this->mod_login($username); if ($user != $self && $username != $self) { if ($this->rc->storage->set_acl($mbox, $user, $acl)) { $display = $this->resolve_acl_identifier($username, $title); $this->rc->output->command('acl_update', [ 'id' => rcube_utils::html_identifier($user), 'username' => $username, 'title' => $title, 'display' => $display, 'acl' => implode($acl), 'old' => $oldid ]); $result++; } } } if ($result) { $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(rcube_utils::get_input_string('_mbox', rcube_utils::INPUT_POST, true)); //UTF7-IMAP $user = trim(rcube_utils::get_input_string('_user', rcube_utils::INPUT_POST)); $user = explode(',', $user); foreach ($user as $u) { $u = trim($u); if ($this->rc->storage->delete_acl($mbox, $u)) { $this->rc->output->command('acl_remove_row', rcube_utils::html_identifier($u)); } else { $error = true; } } if (empty($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(rcube_utils::get_input_string('_mbox', rcube_utils::INPUT_GPC, true)); // UTF7-IMAP $advanced = trim(rcube_utils::get_input_string('_mode', rcube_utils::INPUT_GPC)); $advanced = $advanced == 'advanced'; // Save state in user preferences $this->rc->user->save_prefs(['acl_advanced_mode' => $advanced]); $out = $this->list_rights(); $out = preg_replace(['/^]+>/', '/<\/table>$/'], '', $out); $this->rc->output->command('acl_list_update', $out); } /** * Creates