egroupware/emailadmin/inc/class.bo.inc.php

737 lines
22 KiB
PHP

<?php
/***************************************************************************\
* eGroupWare *
* http://www.egroupware.org *
* http://www.linux-at-work.de *
* Written by : Lars Kneschke [lkneschke@linux-at-work.de] *
* ------------------------------------------------- *
* 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 2 of the License, or (at your *
* option) any later version. *
\***************************************************************************/
/* $Id$ */
class bo
{
var $sessionData;
var $LDAPData;
var $SMTPServerType = array(); // holds a list of config options
var $IMAPServerType = array(); // holds a list of config options
var $imapClass; // holds the imap/pop3 class
var $smtpClass; // holds the smtp class
function bo($_profileID=-1,$_restoreSesssion=true)
{
$this->soemailadmin =& CreateObject('emailadmin.so');
$this->SMTPServerType = array(
'1' => array(
'fieldNames' => array(
'smtpServer',
'smtpPort',
'smtpAuth',
'ea_smtp_auth_username',
'ea_smtp_auth_password',
'smtpType'
),
'description' => lang('standard SMTP-Server'),
'classname' => 'defaultsmtp'
),
'2' => array(
'fieldNames' => array(
'smtpServer',
'smtpPort',
'smtpAuth',
'ea_smtp_auth_username',
'ea_smtp_auth_password',
'smtpType',
'editforwardingaddress',
'smtpLDAPServer',
'smtpLDAPAdminDN',
'smtpLDAPAdminPW',
'smtpLDAPBaseDN',
'smtpLDAPUseDefault'
),
'description' => 'Postfix (qmail Schema)',
'classname' => 'postfixldap'
),
'3' => array(
'fieldNames' => array(
'smtpServer',
'smtpPort',
'smtpAuth',
'ea_smtp_auth_username',
'ea_smtp_auth_password',
'smtpType',
),
'description' => 'Postfix (inetOrgPerson Schema)',
'classname' => 'postfixinetorgperson'
),
'4' => array(
'fieldNames' => array(
'smtpServer',
'smtpPort',
'smtpAuth',
'ea_smtp_auth_username',
'ea_smtp_auth_password',
'smtpType',
'editforwardingaddress',
),
'description' => 'Plesk SMTP-Server (Qmail)',
'classname' => 'smtpplesk'
),
'5' => array(
'fieldNames' => array(
'smtpServer',
'smtpPort',
'smtpAuth',
'ea_smtp_auth_username',
'ea_smtp_auth_password',
'smtpType',
'editforwardingaddress',
'smtpLDAPServer',
'smtpLDAPAdminDN',
'smtpLDAPAdminPW',
'smtpLDAPBaseDN',
'smtpLDAPUseDefault'
),
'description' => 'Postfix (dbmail Schema)',
'classname' => 'postfixdbmailuser'
),
);
$this->IMAPServerType = array(
/* '1' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient'
),
'description' => 'standard POP3 server',
'protocol' => 'pop3',
'classname' => 'defaultpop'
),*/
'2' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient'
),
'description' => 'standard IMAP server',
'protocol' => 'imap',
'classname' => 'defaultimap'
),
'3' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient',
'imapEnableCyrusAdmin',
'imapAdminUsername',
'imapAdminPW',
'imapEnableSieve',
'imapSieveServer',
'imapSievePort'
),
'description' => 'Cyrus IMAP Server',
'protocol' => 'imap',
'classname' => 'cyrusimap'
),
'4' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient',
'imapEnableSieve',
'imapSieveServer',
'imapSievePort'
),
'description' => 'DBMail (qmailUser schema)',
'protocol' => 'imap',
'classname' => 'dbmailqmailuser'
),
'5' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient',
),
'description' => 'Plesk IMAP Server (Courier)',
'protocol' => 'imap',
'classname' => 'pleskimap'
),
'6' => array(
'fieldNames' => array(
'imapServer',
'imapPort',
'imapType',
'imapLoginType',
'imapTLSEncryption',
'imapTLSAuthentication',
'imapoldcclient',
'imapEnableSieve',
'imapSieveServer',
'imapSievePort'
),
'description' => 'DBMail (dbmailUser schema)',
'protocol' => 'imap',
'classname' => 'dbmaildbmailuser'
),
);
if ($_restoreSesssion) $this->restoreSessionData();
if($_profileID >= 0)
{
$this->profileID = $_profileID;
$this->profileData = $this->getProfile($_profileID);
$this->imapClass =& CreateObject('emailadmin.'.$this->IMAPServerType[$this->profileData['imapType']]['classname']);
$this->smtpClass =& CreateObject('emailadmin.'.$this->SMTPServerType[$this->profileData['smtpType']]['classname']);
}
}
function addAccount($_hookValues)
{
if (is_object($this->imapClass))
{
#ExecMethod("emailadmin.".$this->imapClass.".addAccount",$_hookValues,3,$this->profileData);
$this->imapClass->addAccount($_hookValues);
}
if (is_object($this->smtpClass))
{
#ExecMethod("emailadmin.".$this->smtpClass.".addAccount",$_hookValues,3,$this->profileData);
$this->smtpClass->addAccount($_hookValues);
}
}
function deleteAccount($_hookValues)
{
if (is_object($this->imapClass))
{
#ExecMethod("emailadmin.".$this->imapClass.".deleteAccount",$_hookValues,3,$this->profileData);
$this->imapClass->deleteAccount($_hookValues);
}
if (is_object($this->smtpClass))
{
#ExecMethod("emailadmin.".$this->smtpClass.".deleteAccount",$_hookValues,3,$this->profileData);
$this->smtpClass->deleteAccount($_hookValues);
}
}
function deleteProfile($_profileID)
{
$this->soemailadmin->deleteProfile($_profileID);
}
function encodeHeader($_string, $_encoding='q')
{
switch($_encoding)
{
case "q":
if(!preg_match("/[\x80-\xFF]/",$_string))
{
// nothing to quote, only 7 bit ascii
return $_string;
}
$string = imap_8bit($_string);
$stringParts = explode("=\r\n",$string);
while(list($key,$value) = each($stringParts))
{
if(!empty($retString)) $retString .= " ";
$value = str_replace(" ","_",$value);
// imap_8bit does not convert "?"
// it does not need, but it should
$value = str_replace("?","=3F",$value);
$retString .= "=?".strtoupper($this->displayCharset)."?Q?" . $value. "?=";
}
#exit;
return $retString;
break;
default:
return $_string;
}
}
function getAccountEmailAddress($_accountName, $_profileID)
{
$profileData = $this->getProfile($_profileID);
#$smtpClass = $this->SMTPServerType[$profileData['smtpType']]['classname'];
$smtpClass =& CreateObject('emailadmin.'.$this->SMTPServerType[$profileData['smtpType']]['classname']);
#return empty($smtpClass) ? False : ExecMethod("emailadmin.$smtpClass.getAccountEmailAddress",$_accountName,3,$profileData);
return is_object($smtpClass) ? $smtpClass->getAccountEmailAddress($_accountName) : False;
}
function getFieldNames($_serverTypeID, $_class)
{
switch($_class)
{
case 'imap':
return $this->IMAPServerType[$_serverTypeID]['fieldNames'];
break;
case 'smtp':
return $this->SMTPServerType[$_serverTypeID]['fieldNames'];
break;
}
}
# function getIMAPClass($_profileID)
# {
# if(!is_object($this->imapClass))
# {
# $profileData = $this->getProfile($_profileID);
# $this->imapClass =& CreateObject('emailadmin.cyrusimap',$profileData);
# }
#
# return $this->imapClass;
# }
function getIMAPServerTypes() {
foreach($this->IMAPServerType as $key => $value) {
$retData[$key]['description'] = $value['description'];
$retData[$key]['protocol'] = $value['protocol'];
}
return $retData;
}
function getLDAPStorageData($_serverid)
{
$storageData = $this->soemailadmin->getLDAPStorageData($_serverid);
return $storageData;
}
function getMailboxString($_folderName)
{
if (is_object($this->imapClass))
{
return ExecMethod("emailadmin.".$this->imapClass.".getMailboxString",$_folderName,3,$this->profileData);
return $this->imapClass->getMailboxString($_folderName);
}
else
{
return false;
}
}
function getProfile($_profileID)
{
$profileData = $this->soemailadmin->getProfileList($_profileID);
$found = false;
if (is_array($profileData) && count($profileData))
{
foreach($profileData as $n => $data)
{
if ($data['ProfileID'] == $_profileID)
{
$found = $n;
break;
}
}
}
if ($found === false) // no existing profile selected
{
if (is_array($profileData) && count($profileData)) { // if we have a profile use that
reset($profileData);
list($found,$data) = each($profileData);
$this->profileID = $_profileID = $data['profileID'];
} elseif ($GLOBALS['egw_info']['server']['smtp_server']) { // create a default profile, from the data in the api config
$this->profileID = $_profileID = $this->soemailadmin->addProfile(array(
'description' => $GLOBALS['egw_info']['server']['smtp_server'],
'defaultDomain' => $GLOBALS['egw_info']['server']['mail_suffix'],
'organisationName' => '',
'userDefinedAccounts' => '',
),array(
'smtpServer' => $GLOBALS['egw_info']['server']['smtp_server'],
'smtpPort' => $GLOBALS['egw_info']['server']['smtp_port'],
'smtpAuth' => '',
'smtpType' => '1',
),array(
'imapServer' => $GLOBALS['egw_info']['server']['mail_server'] ?
$GLOBALS['egw_info']['server']['mail_server'] : $GLOBALS['egw_info']['server']['smtp_server'],
'imapPort' => '143',
'imapType' => '2', // imap
'imapLoginType' => $GLOBALS['egw_info']['server']['mail_login_type'] ?
$GLOBALS['egw_info']['server']['mail_login_type'] : 'standard',
'imapTLSEncryption' => '0',
'imapTLSAuthentication' => '',
'imapoldcclient' => '',
));
$profileData[$found = 0] = array(
'smtpType' => '1',
'imapType' => '2',
);
}
}
$fieldNames = array();
if (isset($profileData[$found]))
{
$fieldNames = array_merge($this->SMTPServerType[$profileData[$found]['smtpType']]['fieldNames'],
$this->IMAPServerType[$profileData[$found]['imapType']]['fieldNames']);
}
$fieldNames[] = 'description';
$fieldNames[] = 'defaultDomain';
$fieldNames[] = 'profileID';
$fieldNames[] = 'organisationName';
$fieldNames[] = 'userDefinedAccounts';
$fieldNames[] = 'ea_appname';
$fieldNames[] = 'ea_group';
$profileData = $this->soemailadmin->getProfile($_profileID, $fieldNames);
$profileData['imapTLSEncryption'] = ($profileData['imapTLSEncryption'] == 'yes' ? 1 : (int)$profileData['imapTLSEncryption']);
return $profileData;
}
function getProfileList($_profileID='')
{
return $this->soemailadmin->getProfileList($_profileID);
}
function getSMTPServerTypes()
{
foreach($this->SMTPServerType as $key => $value)
{
$retData[$key] = $value['description'];
}
return $retData;
}
function getUserProfile($_appName='', $_groups='')
{
$appName = ($_appName != '' ? $_appName : $GLOBALS['egw_info']['flags']['currentapp']);
if(!is_array($_groups)) {
// initialize with 0 => means no group id
$groups = array(0);
$userGroups = $GLOBALS['egw']->accounts->membership($GLOBALS['egw_info']['user']['account_id']);
foreach((array)$userGroups as $groupInfo) {
$groups[] = $groupInfo['account_id'];
}
} else {
$groups = $_groups;
}
if($data = $this->soemailadmin->getUserProfile($appName, $groups)) {
$eaPreferences =& CreateObject('emailadmin.ea_preferences');
// fetch the IMAP / incomming server data
$icClass = isset($this->IMAPServerType[$data['imapType']]) ? $this->IMAPServerType[$data['imapType']]['classname'] : 'defaultimap';
$icServer =& CreateObject('emailadmin.'.$icClass);
$icServer->encryption = ($data['imapTLSEncryption'] == 'yes' ? 1 : (int)$data['imapTLSEncryption']);
$icServer->host = $data['imapServer'];
$icServer->port = $data['imapPort'];
$icServer->validatecert = $data['imapTLSAuthentication'] == 'yes';
$icServer->username = $GLOBALS['egw_info']['user']['account_lid'];
$icServer->password = $GLOBALS['egw_info']['user']['passwd'];
$icServer->loginType = $data['imapLoginType'];
$icServer->domainName = $data['defaultDomain'];
$icServer->loginName = $data['imapLoginType'] == 'standard' ? $GLOBALS['egw_info']['user']['account_lid'] : $GLOBALS['egw_info']['user']['account_lid'].'@'.$data['defaultDomain'];
$icServer->enableCyrusAdmin = ($data['imapEnableCyrusAdmin'] == 'yes');
$icServer->adminUsername = $data['imapAdminUsername'];
$icServer->adminPassword = $data['imapAdminPW'];
$icServer->enableSieve = ($data['imapEnableSieve'] == 'yes');
$icServer->sievePort = $data['imapSievePort'];
$eaPreferences->setIncomingServer($icServer);
// fetch the SMTP / outgoing server data
$ogClass = isset($this->SMTPServerType[$data['smtpType']]) ? $this->SMTPServerType[$data['smtpType']]['classname'] : 'defaultsmtp';
$ogServer =& CreateObject('emailadmin.'.$ogClass);
$ogServer->host = $data['smtpServer'];
$ogServer->port = $data['smtpPort'];
$ogServer->editForwardingAddress = ($data['editforwardingaddress'] == 'yes');
$ogServer->smtpAuth = $data['smtpAuth'] == 'yes';
if($ogServer->smtpAuth) {
if(!empty($data['ea_smtp_auth_username'])) {
$ogServer->username = $data['ea_smtp_auth_username'];
$ogServer->password = $data['ea_smtp_auth_password'];
} else {
$ogServer->username = $GLOBALS['egw_info']['user']['account_lid'];
$ogServer->password = $GLOBALS['egw_info']['user']['passwd'];
}
}
$eaPreferences->setOutgoingServer($ogServer);
foreach($ogServer->getAccountEmailAddress($GLOBALS['egw_info']['user']['account_lid']) as $emailAddresses)
{
$identity =& CreateObject('emailadmin.ea_identity');
$identity->emailAddress = $emailAddresses['address'];
$identity->realName = $emailAddresses['name'];
$identity->default = ($emailAddresses['type'] == 'default');
$identity->organization = $data['organisationName'];
$eaPreferences->setIdentity($identity);
}
$eaPreferences->userDefinedAccounts = ($data['userDefinedAccounts'] == 'yes');
return $eaPreferences;
}
return false;
}
function getUserData($_accountID)
{
$userGroups = $GLOBALS['egw']->accounts->membership($_accountID);
$groups = array(0);
foreach((array)$userGroups as $groupInfo) {
$groups[] = $groupInfo['account_id'];
}
if($userProfile = $this->getUserProfile('felamimail', $groups)) {
$icServer = $userProfile->getIncomingServer(0);
if(is_a($icServer, 'defaultimap') && $username = $GLOBALS['egw']->accounts->id2name($_accountID)) {
$icUserData = $icServer->getUserData($username);
}
$ogServer = $userProfile->getOutgoingServer(0);
if(is_a($ogServer, 'defaultsmtp')) {
$ogUserData = $ogServer->getUserData($_accountID);
}
return $icUserData + $ogUserData;
}
return false;
}
function restoreSessionData()
{
$this->sessionData = $GLOBALS['egw']->session->appsession('session_data');
$this->userSessionData = $GLOBALS['egw']->session->appsession('user_session_data');
}
function saveSMTPForwarding($_accountID, $_forwardingAddress, $_keepLocalCopy)
{
if (is_object($this->smtpClass))
{
#$smtpClass = &CreateObject('emailadmin.'.$this->smtpClass,$this->profileID);
#$smtpClass->saveSMTPForwarding($_accountID, $_forwardingAddress, $_keepLocalCopy);
$this->smtpClass->saveSMTPForwarding($_accountID, $_forwardingAddress, $_keepLocalCopy);
}
}
/**
* called by the validation hook in setup
*
* @param array $settings following keys: mail_server, mail_server_type {IMAP|IMAPS|POP-3|POP-3S},
* mail_login_type {standard|vmailmgr}, mail_suffix (domain), smtp_server, smpt_port, smtp_auth_user, smtp_auth_passwd
*/
function setDefaultProfile($settings)
{
if (($profiles = $this->soemailadmin->getProfileList(0,true)))
{
$profile = array_shift($profiles);
}
else
{
$profile = array(
'smtpType' => 1,
'description' => 'default profile (created by setup)',
'ea_appname' => '',
'ea_group' => 0,
);
}
foreach(array(
'mail_server' => 'imapServer',
'mail_server_type' => array(
'imap' => array(
'imapType' => 2,
'imapPort' => 143,
'imapTLSEncryption' => 0,
),
'imaps' => array(
'imapType' => 2,
'imapPort' => 993,
'imapTLSEncryption' => 'yes',
),
/* 'pop3' => array(
'imapType' => 1,
'imapPort' => 110,
'imapTLSEncryption' => 0,
),
'pop3s' => array(
'imapType' => 1,
'imapPort' => 995,
'imapTLSEncryption' => '1',
),*/
),
'mail_login_type' => 'imapLoginType',
'mail_suffix' => 'defaultDomain',
'smtp_server' => 'smtpServer',
'smpt_port' => 'smtpPort',
'smtp_auth_user' => 'ea_smtp_auth_username',
'smtp_auth_passwd' => 'ea_smtp_auth_password',
) as $setup_name => $ea_name_data)
{
if (!is_array($ea_name_data))
{
$profile[$ea_name_data] = $settings[$setup_name];
if ($setup_name == 'smtp_auth_user') $profile['stmpAuth'] = !empty($settings['smtp_auth_user']);
}
else
{
foreach($ea_name_data as $setup_val => $ea_data)
{
if ($setup_val == $settings[$setup_name])
{
foreach($ea_data as $var => $val)
{
if ($var != 'imapType' || $val != 2 || $profile[$var] < 3) // dont kill special imap server types
{
$profile[$var] = $val;
}
}
break;
}
}
}
}
$this->soemailadmin->updateProfile($profile);
//echo "<p>EMailAdmin profile update: ".print_r($profile,true)."</p>\n"; exit;
}
function saveProfile($_globalSettings, $_smtpSettings, $_imapSettings)
{
if(!isset($_imapSettings['imapTLSAuthentication'])) {
$_imapSettings['imapTLSAuthentication'] = true;
}
if(!isset($_globalSettings['profileID'])) {
$_globalSettings['ea_order'] = count($this->getProfileList()) + 1;
$this->soemailadmin->addProfile($_globalSettings, $_smtpSettings, $_imapSettings);
} else {
$this->soemailadmin->updateProfile($_globalSettings, $_smtpSettings, $_imapSettings);
}
$all = $_globalSettings+$_smtpSettings+$_imapSettings;
if (!$all['ea_group'] && !$all['ea_application']) // standard profile update eGW config
{
$new_config = array();
foreach(array(
'imapServer' => 'mail_server',
'imapType' => 'mail_server_type',
'imapLoginType' => 'mail_login_type',
'defaultDomain' => 'mail_suffix',
'smtpServer' => 'smtp_server',
'smtpPort' => 'smpt_port',
)+($all['smtpAuth'] ? array(
'ea_smtp_auth_username' => 'smtp_auth_user',
'ea_smtp_auth_password' => 'smtp_auth_passwd',
) : array()) as $ea_name => $config_name)
{
if (isset($all[$ea_name]))
{
if ($ea_name != 'imapType')
{
$new_config[$config_name] = $all[$ea_name];
}
else // imap type
{
$new_config[$config_name] = ($all['imapType'] == 1 ? 'pop3' : 'imap').($all['imapTLSEncryption'] ? 's' : '');
}
}
}
if (count($new_config))
{
$config =& CreateObject('phpgwapi.config','phpgwapi');
foreach($new_config as $name => $value)
{
$config->save_value($name,$value,'phpgwapi');
}
//echo "<p>eGW configuration update: ".print_r($new_config,true)."</p>\n";
}
}
}
function saveSessionData()
{
$GLOBALS['egw']->session->appsession('session_data','',$this->sessionData);
$GLOBALS['egw']->session->appsession('user_session_data','',$this->userSessionData);
}
function saveUserData($_accountID, $_formData) {
$groups = array_merge(array(0),(array)$GLOBALS['egw']->accounts->memberships($_accountID,true));
if($userProfile = $this->getUserProfile('felamimail', $groups)) {
$ogServer = $userProfile->getOutgoingServer(0);
if(is_a($ogServer, 'defaultsmtp')) {
$ogServer->setUserData($_accountID,
(array)$_formData['mailAlternateAddress'],
(array)$_formData['mailForwardingAddress'],
$_formData['deliveryMode'],
$_formData['accountStatus'],
$_formData['mailLocalAddress']
);
}
$icServer = $userProfile->getIncomingServer(0);
if(is_a($icServer, 'defaultimap') && $username = $GLOBALS['egw']->accounts->id2name($_accountID)) {
$icServer->setUserData($username, $_formData['quotaLimit']);
}
// calling a hook to allow other apps to monitor the changes
$_formData['account_id'] = $_accountID;
$_formData['location'] = 'editaccountemail';
$GLOBALS['egw']->hooks->process($_formData);
return true;
}
return false;
}
function setOrder($_order) {
if(is_array($_order)) {
$this->soemailadmin->setOrder($_order);
}
}
function updateAccount($_hookValues) {
if (is_object($this->imapClass)) {
#ExecMethod("emailadmin.".$this->imapClass.".updateAccount",$_hookValues,3,$this->profileData);
$this->imapClass->updateAccount($_hookValues);
}
if (is_object($this->smtpClass)) {
#ExecMethod("emailadmin.".$this->smtpClass.".updateAccount",$_hookValues,3,$this->profileData);
$this->smtpClass->updateAccount($_hookValues);
}
}
}
?>