egroupware/mail/inc/class.mail_acl.inc.php

518 lines
15 KiB
PHP
Raw Normal View History

2013-11-15 18:22:46 +01:00
<?php
/**
* EGroupware - Mail Folder ACL- interface class
*
* @link http://www.egroupware.org
* @package mail
* @author Hadi Nategh [hn@stylite.de]
* @copyright (c) 2013-16 by Stylite AG <info-AT-stylite.de>
2013-11-15 18:22:46 +01:00
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
2014-04-03 14:31:52 +02:00
* @version $Id$
2013-11-15 18:22:46 +01:00
*/
use EGroupware\Api;
2016-05-03 21:17:44 +02:00
use EGroupware\Api\Framework;
use EGroupware\Api\Etemplate;
use EGroupware\Api\Mail;
2013-11-15 18:22:46 +01:00
class mail_acl
{
/**
* Methods callable via menuaction
*
* @var array
*/
var $public_functions = array(
'edit' => True,
);
2013-11-28 16:08:41 +01:00
/**
* static used define abbrevations for common access rights
*
* @array
*
*/
var $aclRightsAbbrvs = array(
'lrs' => array('label'=>'readable','title'=>'Allows a user to read the contents of the mailbox.'),
'lprs' => array('label'=>'post','title'=>'Allows a user to read the mailbox and post to it through the delivery system by sending mail to the submission address of the mailbox.'),
'ilprs' => array('label'=>'append','title'=>'Allows a user to read the mailbox and append messages to it, either via IMAP or through the delivery system.'),
'ilprsw' => array('label'=>'write','title'=>'Allows a user to read the maibox, post to it, append messages to it, and delete messages or the mailbox itself. The only right not given is the right to change the ACL of the mailbox.'),
'aeiklprstwx'=> array('label'=>'all','title'=>'The user has all possible rights on the mailbox. This is usually granted to users only on the mailboxes they own.'),
2013-11-28 16:08:41 +01:00
'custom' => array('label'=>'custom','title'=>'User defined combination of rights for the ACL'),
);
2013-11-15 18:22:46 +01:00
/**
* imap object instanciated in constructor for account to edit
2013-11-15 18:22:46 +01:00
*
* @var Mail\Imap
2013-11-15 18:22:46 +01:00
*/
var $imap;
2013-11-28 16:08:41 +01:00
2013-11-15 18:22:46 +01:00
/**
*
* @var mail_account
2013-11-15 18:22:46 +01:00
*/
var $current_account;
2013-11-15 18:22:46 +01:00
/**
* Edit folder ACLs of account(s)
2013-11-15 18:22:46 +01:00
*
* @param string $content = null
* @param array $msg = ''
2013-11-28 16:08:41 +01:00
*
2013-11-15 18:22:46 +01:00
*/
function edit(array $content=null ,$msg='')
{
2016-05-03 21:17:44 +02:00
$tmpl = new Etemplate('mail.acl');
if (!is_array($content))
{
$acc_id = $_GET['acc_id']?$_GET['acc_id']:$GLOBALS['egw_info']['user']['preferences']['mail']['ActiveProfileID'];
if (isset($_GET['account_id']) && !isset($GLOBALS['egw_info']['user']['apps']['admin']))
{
2016-05-03 21:17:44 +02:00
Framework::window_close(lang('Permission denied'));
}
$account_id = $_GET['account_id'];
}
else
{
$acc_id = $content['acc_id'];
$account_id = $content['account_id'];
}
$account = Mail\Account::read($acc_id, $account_id);
$this->imap = $account->imapServer(isset($account_id) ? (int)$account_id : false);
$mailbox = $_GET['mailbox']? base64_decode($_GET['mailbox']): $content['mailbox'][0];
if (empty($mailbox))
{
$mailbox = $this->imap->isAdminConnection ? $this->imap->getUserMailboxString($this->imap->isAdminConnection) : 'INBOX';
}
if (!$this->imap->isAdminConnection)
{
$tmpl->setElementAttribute('mailbox', 'autocomplete_url', 'mail.mail_compose.ajax_searchFolder');
}
else
{
//Todo: Implement autocomplete_url function with admin stuffs consideration
}
// Unset the content if folder is changed, in order to read acl rights for new selected folder
if (!is_array($content['button']) && is_array($content['mailbox']) && !is_array($content['grid']['delete'])) unset($content);
2013-11-15 18:22:46 +01:00
if (!is_array($content))
{
if (!empty($mailbox))
{
$content['mailbox'] = $mailbox;
2013-11-28 16:08:41 +01:00
$acl = (array)$this->retrive_acl($mailbox, $msg);
$n = 1;
foreach ($acl as $key => $value)
2013-11-28 16:08:41 +01:00
{
$virtuals = array_pop(array_values((array)$value));
$rights = array_shift(array_values((array)$value));
2013-11-28 16:08:41 +01:00
foreach ($rights as $right)
2013-11-28 16:08:41 +01:00
{
$content['grid'][$n]['acl_'. $right] = true;
}
$virtualD = array('e','t');
$content['grid'][$n]['acl_c'] = array_diff($virtuals['c'],array_intersect($rights,$virtuals['c']))? false: true; //c=kx more information rfc4314, Obsolote Rights
$content['grid'][$n]['acl_d'] = array_diff($virtualD,array_intersect($rights,$virtuals['d']))? false: true; //d=et more information rfc4314, Obsolote Rights
sort($rights);
$acl_abbrvs = implode('',$rights);
2013-11-28 16:08:41 +01:00
if (array_key_exists($acl_abbrvs, $this->aclRightsAbbrvs))
{
$content['grid'][$n]['acl'] = $acl_abbrvs;
}
else
{
$content['grid'][$n]['acl'] = 'custom';
}
if (($user = $this->imap->getMailBoxAccountId($key)))
{
$content['grid'][$n++]['acc_id'] = $user;
}
else
{
$content['grid'][$n++]['acc_id'] = $key;
}
2013-11-28 16:08:41 +01:00
}
//error_log(__METHOD__."() acl=".array2string($acl).' --> grid='.array2string($content['grid']));
2013-11-15 18:22:46 +01:00
}
//Set the acl entry in the last row with lrs as default ACL
array_push($content['grid'], array(
'acc_id'=>'',
'acl_l' => true,
'acl_r' => true,
'acl_s' => true));
2013-11-15 18:22:46 +01:00
}
2013-11-28 16:08:41 +01:00
else
{
list($button) = @each($content['button']);
if (!empty ($content['grid']['delete']))
{
$button = 'delete';
}
switch ($button)
{
case 'save':
case 'apply':
if ($content)
{
$validation_err = $this->update_acl($content,$msg);
if ($validation_err)
{
foreach ($validation_err as &$row)
{
$tmpl->set_validation_error('grid['.$row.']'.'[acc_id]', "You must fill this field!");
}
}
//Add new row at the end
if ($content['grid'][count($content['grid'])]['acc_id'])
array_push($content['grid'], array('acc_id'=>''));
2013-11-28 16:08:41 +01:00
}
else
{
$msg .= "\n".lang("Error: Could not save ACL").' '.lang("reason!");
}
//Send message
2016-05-03 21:17:44 +02:00
Framework::message($msg);
2013-11-28 16:08:41 +01:00
if ($button == "apply") break;
//Fall through
2013-11-28 16:08:41 +01:00
case 'cancel':
2016-05-03 21:17:44 +02:00
Framework::window_close();
exit;
2013-11-28 16:08:41 +01:00
case 'delete':
$aclRvmCnt = $this->remove_acl($content, $msg);
if (is_array($aclRvmCnt))
{
$content['grid'] = $aclRvmCnt;
}
else
{
error_log(__METHOD__.__LINE__. "()" . "The remove_acl suppose to return an array back, something is wrong there");
}
2016-05-03 21:17:44 +02:00
Framework::message($msg);
2013-11-28 16:08:41 +01:00
}
}
$readonlys = $sel_options = array();
2013-11-28 16:08:41 +01:00
$sel_options['acl'] = $this->aclRightsAbbrvs;
//Make the account owner's fields all readonly as owner has all rights and should not be able to change them
foreach($content['grid'] as $key => $fields)
{
if ($fields['acc_id'] == $this->imap->acc_imap_username ||
$fields['acc_id'][0] == $this->imap->acc_imap_username)
{
foreach (array_keys($fields) as $index)
{
$readonlys['grid'][$key][$index] = true;
}
$readonlys['grid']['delete['.$key.']'] = true;
$readonlys['grid'][$key]['acl_recursive'] = true;
$preserv ['grid'][$key] = $fields;
$preserv['grid'][$key]['acl_recursive'] = false;
}
}
//Make entry row's delete button readonly
$readonlys['grid']['delete['.count($content['grid']).']'] = true;
$preserv['mailbox'] = $content['mailbox'];
$preserv['acc_id'] = $acc_id;
$preserv['account_id'] = $account_id;
$content['grid']['account_type'] = $this->imap->supportsGroupAcl() ? 'both' : 'accounts';
// set a custom autocomplete method for mailbox taglist
if ($account_id)
{
$tmpl->setElementAttribute('mailbox', 'autocomplete_url', __CLASS__.'::ajax_folders');
$tmpl->setElementAttribute('mailbox', 'autocomplete_params', array(
'acc_id' => $acc_id,
'account_id' => $account_id,
));
}
2013-11-28 16:08:41 +01:00
$tmpl->exec('mail.mail_acl.edit', $content, $sel_options, $readonlys, $preserv,2);
2013-11-15 18:22:46 +01:00
}
/**
* Autocomplete for folder taglist
*
2016-05-03 21:17:44 +02:00
* @throws Api\Exception\NoPermission\Admin
*/
public static function ajax_folders()
{
if (!empty($_GET['account_id']) && !$GLOBALS['egw_info']['user']['apps']['admin'])
{
2016-05-03 21:17:44 +02:00
throw new Api\Exception\NoPermission\Admin;
}
$account = Mail\Account::read($_GET['acc_id'], $_GET['account_id']);
$imap = $account->imapServer(!empty($_GET['account_id']) ? (int)$_GET['account_id'] : false);
$mailbox = $imap->isAdminConnection ? $imap->getUserMailboxString($imap->isAdminConnection) : 'INBOX';
$folders = array();
foreach(self::getSubfolders($mailbox, $imap) as $folder)
{
if (stripos($folder, $_GET['query']) !== false)
{
$folders[] = array(
'id' => $folder,
'label' => $folder,
);
}
}
// switch regular JSON response handling off
2016-05-03 21:17:44 +02:00
Api\Json\Request::isJSONRequest(false);
header('Content-Type: application/json; charset=utf-8');
echo json_encode($folders);
exit;
}
2013-11-15 18:22:46 +01:00
/**
2013-11-28 16:08:41 +01:00
* Update ACL rights of a folder or including subfolders for an account(s)
2013-11-15 18:22:46 +01:00
*
2013-11-28 16:08:41 +01:00
* @param array $content content including the acl rights
* @param Boolean $recursive boolean flag FALSE|TRUE. If it is FALSE, only the folder take in to account, but in case of TRUE
* the mailbox including all its subfolders will be considered.
* @param string $msg Message
*
2013-11-15 18:22:46 +01:00
*/
2013-11-28 16:08:41 +01:00
function update_acl ($content, &$msg)
2013-11-15 18:22:46 +01:00
{
2013-11-28 16:08:41 +01:00
$validator = array();
2013-11-28 16:08:41 +01:00
foreach ($content['grid'] as $keys => $value)
{
$recursive = $value['acl_recursive'];
2013-11-28 16:08:41 +01:00
unset($value['acc_id']);
unset($value['acl_recursive']);
unset($value['acl']);
2013-11-28 16:08:41 +01:00
$options = array();
foreach (array_keys($value) as $key)
2013-11-28 16:08:41 +01:00
{
if ($value[$key] == true)
{
$right = explode("acl_" ,$key);
if ($right[1] === 'c') $right[1] = 'kx'; // c = kx , rfc 4314
if ($right[1] === 'd') $right[1] = 'et'; // d = et , rfc 4314
2013-11-28 16:08:41 +01:00
$options['rights'] .= $right[1];
}
}
$username = $content['grid'][$keys]['acc_id'] == $this->imap->acc_imap_username
?$content['grid'][$keys]['acc_id']:$content['grid'][$keys]['acc_id'][0];
//error_log(__METHOD__."(".__LINE__.") setACL($content[mailbox], $username, ".array2string($options).", $recursive)");
if (is_numeric($username) && ($u = $this->imap->getMailBoxUserName($username)))
{
$username = $u;
}
if (!empty($username))
2013-11-28 16:08:41 +01:00
{
//error_log(__METHOD__."() setACL($content[mailbox], $username, ".array2string($options).", $recursive)");
if (($ret=$this->setACL($content['mailbox'], $username, $options, $recursive, $msg)))
{
$msg = lang("The Folder %1 's ACLs saved", $content['mailbox']);
}
else
{
$msg = lang('Error while setting ACL for folder %1!', $content['mailbox']).' '.$msg;
}
2013-11-28 16:08:41 +01:00
}
else
{
if($keys !== count($content['grid']))
{
array_push($validator, $keys);
$msg = lang("Error:Could not save the ACL! Because some names are empty!");
2013-11-28 16:08:41 +01:00
}
}
}
if (is_array($validator))
{
return $validator;
}
2013-11-15 18:22:46 +01:00
}
/**
* Retrive Folder ACL rights
2013-11-28 16:08:41 +01:00
* @todo rights 'c' and 'd' should be fixed
2013-11-15 18:22:46 +01:00
*/
function retrive_acl ($mailbox, &$msg)
{
2013-11-28 16:08:41 +01:00
if (($acl = $this->getACL($mailbox)))
2013-11-15 18:22:46 +01:00
{
$msg = lang('ACL rights retrived successfully');
2013-11-28 16:08:41 +01:00
return $acl;
2013-11-15 18:22:46 +01:00
}
else
{
2013-11-28 16:08:41 +01:00
$msg = lang('Get ACL rights failed from IMAP server!');
2013-11-15 18:22:46 +01:00
}
}
2013-11-28 16:08:41 +01:00
/**
* remove_acl
* This method take content of acl rights, and will delete the one from ACL IMAP,
* for selected folder and/or its subfolders
2013-11-28 16:08:41 +01:00
*
* @param Array $content content array of popup window
* @param string $msg message
*
* @return Array An array as new content for grid
2013-11-28 16:08:41 +01:00
*/
function remove_acl($content, &$msg)
2013-11-28 16:08:41 +01:00
{
$row_num = array_keys($content['grid']['delete'],"pressed");
if ($row_num) $row_num = $row_num[0];
$recursive = $content['grid'][$row_num]['acl_recursive'];
2013-11-28 16:08:41 +01:00
$identifier = $content['grid'][$row_num]['acc_id'][0];
if (is_array($content['mailbox'])) $content['mailbox'] = $content['mailbox'][0];
if (is_numeric($identifier) && ($u = $this->imap->getMailBoxUserName($identifier)))
{
$identifier = $u;
}
//error_log(__METHOD__.__LINE__."(".$content['mailbox'].", ".$identifier.", ".$recursive.")");
if(($res = $this->deleteACL($content['mailbox'], $identifier,$recursive)))
{
unset($content['grid'][$row_num]);
unset($content['grid']['delete']);
if ($recursive)
{
$msg = lang("The %1 's acl, including its subfolders, removed from the %2",$content['mailbox'],$identifier);
}
else
{
$msg = lang("The %1 's acl removed from the %2",$content['mailbox'],$identifier);
}
return array_combine(range(1, count($content['grid'])), array_values($content['grid']));
}
else
{
$msg = lang("An error happend while trying to remove ACL rights from the account %1!",$identifier);
return false;
}
2013-11-28 16:08:41 +01:00
}
/**
* Delete ACL rights of a folder or including subfolders from an account
*
* @param String $mailbox folder name that needs to be edited
* @param String $identifier The identifier to delete.
* @param Boolean $recursive boolean flag FALSE|TRUE. If it is FALSE, only the folder take in to account, but in case of TRUE
* the mailbox including all its subfolders will be considered.
*
* @return Boolean FALSE in case of any exceptions and TRUE in case of success
2013-11-28 16:08:41 +01:00
*/
function deleteACL ($mailbox, $identifier, $recursive)
{
if ($recursive)
2013-11-28 16:08:41 +01:00
{
$folders = self::getSubfolders($mailbox, $this->imap);
2013-11-28 16:08:41 +01:00
}
else
2013-11-28 16:08:41 +01:00
{
$folders = (array)$mailbox;
}
foreach($folders as $sbFolders)
{
try
{
$this->imap->deleteACL($sbFolders, $identifier);
}
catch (Exception $e)
{
error_log(__METHOD__. "Could not delete ACL rights of folder " . $mailbox . " for account ". $identifier ." because of " .$e->getMessage());
return false;
}
2013-11-28 16:08:41 +01:00
}
return true;
}
2013-11-28 16:08:41 +01:00
/**
* Get subfolders of a mailbox
*
* @param string $mailbox structural folder name
* @param Mail\Imap $imap
* @return Array an array including all subfolders of given mailbox| returns an empty array in case of no subfolders
*/
protected static function getSubfolders($mailbox, Mail\Imap $imap)
{
$delimiter = $imap->getDelimiter();
$nameSpace = $imap->getNameSpace();
$prefix = $imap->getFolderPrefixFromNamespace($nameSpace, $mailbox);
if (($subFolders = $imap->getMailBoxesRecursive($mailbox, $delimiter, $prefix)))
{
return $subFolders;
}
else
{
return array();
}
2013-11-28 16:08:41 +01:00
}
/**
* Set ACL rights of a folder or including subfolders to an account
* @param String $mailbox folder name that needs to be edited
* @param String $identifier The identifier to set.
2013-11-28 16:08:41 +01:00
* @param Array $options Additional options:
* - rights: (string) The rights to alter or set.
* - action: (string, optional) If 'add' or 'remove', adds or removes the
* specified rights. Sets the rights otherwise.
2013-11-28 16:08:41 +01:00
* @param Boolean $recursive boolean flag FALSE|TRUE. If it is FALSE, only the folder take in to account, but in case of TRUE
* the mailbox including all its subfolders will be considered.
* @param String $msg message
* @return Boolean FALSE in case of any exceptions and TRUE in case of success,
2013-11-28 16:08:41 +01:00
*
*/
function setACL($mailbox, $identifier,$options, $recursive, &$msg)
2013-11-28 16:08:41 +01:00
{
if ($recursive)
2013-11-28 16:08:41 +01:00
{
$folders = self::getSubfolders($mailbox, $this->imap);
2013-11-28 16:08:41 +01:00
}
else
2013-11-28 16:08:41 +01:00
{
$folders = (array)$mailbox;
}
foreach($folders as $sbFolders)
{
try
{
$this->imap->setACL($sbFolders,$identifier,$options);
}
catch (Exception $e)
{
$msg = $e->getMessage();
error_log(__METHOD__. "Could not set ACL rights on folder " . $mailbox . " for account ". $identifier . " because of " .$e->getMessage());
return false;
}
2013-11-28 16:08:41 +01:00
}
return true;
2013-11-28 16:08:41 +01:00
}
/**
* Get ACL rights of a folder from an account
*
* @param String $mailbox folder name that needs to be read
* @return Boolean FALSE in case of any exceptions and if TRUE in case of success,
*/
function getACL ($mailbox)
{
2014-04-22 16:15:58 +02:00
try
2013-11-28 16:08:41 +01:00
{
$acl = $this->imap->getACL($mailbox);
2014-04-22 16:15:58 +02:00
return $acl;
} catch (Exception $e) {
error_log(__METHOD__. "Could not get ACL rights from folder " . $mailbox . " because of " .$e->getMessage());
return false;
2013-11-28 16:08:41 +01:00
}
}
}