mirror of
https://github.com/postfixadmin/postfixadmin.git
synced 2024-09-19 19:22:14 +02:00
e279c77ca5
public/editactive.php edit wrong description text it said this module is used for deleting admin domains mailbos etc modify templates that it is used public/list-virtual.php modify templates that it is used modify the remarks behind arguments and internal , the texteditor thought the text after this was still remark text untl is see */ public/vacation.php and model/VacantionHandel.php adjust date string actionFrom and activeUntil these are written in the database as e.g. 2020-10-01 15:14:00 and 2020-10-30-15:14:00 this should be 2020-10-01 00:00:00 and 2020-10-30 23:59:59 so that it contains all day, this happens if no holiday has been set for the account yet when adjusting the dates, the seconds of until are set to 00 instead of 59. When the holiday is canceled and then action is taken again, the from time to the time when the setting is made. templates/editform.tpl remove blank space templates/list-virtual_mailbox.tpl remove indent tabs
309 lines
11 KiB
PHP
309 lines
11 KiB
PHP
<?php
|
|
|
|
# $Id$
|
|
|
|
class VacationHandler extends PFAHandler
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $db_table = 'vacation';
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $id_field = 'email';
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $domain_field = 'domain';
|
|
|
|
public function init(string $id): bool
|
|
{
|
|
throw new \Exception('VacationHandler is not yet ready to be used with *Handler methods');
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
protected function initStruct()
|
|
{
|
|
$this->struct=array(
|
|
# field name allow display in... type $PALANG label $PALANG description default / options / ...
|
|
# editing? form list
|
|
'email' => pacol($this->new, 1, 1, 'text', 'pLogin_username' , '' , '' ),
|
|
'domain' => pacol(1, 0, 0, 'text', '' , '' , '' ),
|
|
'subject' => pacol(1, 1, 0, 'text', 'pUsersVacation_subject' , '' , '' ),
|
|
'body' => pacol(1, 1, 0, 'text', 'pUsersVacation_body' , '' , '' ),
|
|
'activefrom' => pacol(1, 1, 1, 'text', 'pUsersVacation_activefrom' , '' , '' ),
|
|
'activeuntil' => pacol(1, 1, 1, 'text', 'pUsersVacation_activeuntil' , '' , '' ),
|
|
'active' => pacol(1, 1, 1, 'bool', 'active' , '' , 1 ),
|
|
'created' => pacol(0, 0, 1, 'ts', 'created' , '' ),
|
|
'modified' => pacol(0, 0, 1, 'ts', 'last_modified' , '' ),
|
|
# TODO: add virtual 'notified' column and allow to display who received a vacation response?
|
|
);
|
|
|
|
if ( ! db_pgsql() ) {
|
|
$this->struct['cache'] = pacol(0, 0, 0, 'text', '' , '' , '' ); # leftover from 2.2
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
protected function initMsg()
|
|
{
|
|
$this->msg['error_already_exists'] = 'pCreate_mailbox_username_text_error1'; # TODO: better error message
|
|
$this->msg['error_does_not_exist'] = 'pCreate_mailbox_username_text_error1'; # TODO: better error message
|
|
$this->msg['confirm_delete'] = 'confirm_delete_vacation'; # unused?
|
|
|
|
if ($this->new) {
|
|
$this->msg['logname'] = 'edit_vacation';
|
|
$this->msg['store_error'] = 'pVacation_result_error';
|
|
$this->msg['successmessage'] = 'pVacation_result_removed'; # TODO: or pVacation_result_added - depends on 'active'... -> we probably need a new message
|
|
} else {
|
|
$this->msg['logname'] = 'edit_vacation';
|
|
$this->msg['store_error'] = 'pVacation_result_error';
|
|
$this->msg['successmessage'] = 'pVacation_result_removed'; # TODO: or pVacation_result_added - depends on 'active'... -> we probably need a new message
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function webformConfig()
|
|
{
|
|
return array(
|
|
# $PALANG labels
|
|
'formtitle_create' => 'pUsersVacation_welcome',
|
|
'formtitle_edit' => 'pUsersVacation_welcome',
|
|
'create_button' => 'save',
|
|
|
|
# various settings
|
|
'required_role' => 'admin',
|
|
'listview' => 'list-virtual.php',
|
|
'early_init' => 1, # 0 for create-domain
|
|
);
|
|
}
|
|
|
|
protected function validate_new_id()
|
|
{
|
|
# vacation can only be enabled if a mailbox with this name exists
|
|
if ($this->is_admin) {
|
|
$handler = new MailboxHandler(0, $this->admin_username);
|
|
if ($handler->init($this->id)) {
|
|
return true;
|
|
}
|
|
} else {
|
|
if ($this->id == $this->username) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
# still here? This means the mailbox doesn't exist or the admin/user doesn't have permissions to view it
|
|
$this->errormsg[] = Config::Lang('invalid_parameter');
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function delete()
|
|
{
|
|
$this->errormsg[] = '*** deletion not implemented yet ***';
|
|
return false; # XXX function aborts here! XXX
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $username;
|
|
|
|
/**
|
|
* @param string $username
|
|
*/
|
|
public function __construct($username)
|
|
{
|
|
$this->username = $username;
|
|
$this->id = $username;
|
|
}
|
|
|
|
/**
|
|
* Removes the autoreply alias etc for this user; namely, if they're away we remove their vacation alias and
|
|
* set the vacation table record to false.
|
|
* @return boolean true on success.
|
|
*/
|
|
public function remove()
|
|
{
|
|
if (!$this->updateAlias(0)) {
|
|
return false;
|
|
}
|
|
|
|
// tidy up vacation table.
|
|
$vacation_data = array(
|
|
'active' => db_get_boolean(false),
|
|
);
|
|
$result = db_update('vacation', 'email', $this->username, $vacation_data);
|
|
$result = db_delete('vacation_notification', 'on_vacation', $this->username);
|
|
# TODO db_log() call (maybe except if called from set_away?)
|
|
/* crap error handling; oh for exceptions... */
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return boolean true indicates this server supports vacation messages, and users are able to change their own.
|
|
*/
|
|
public function vacation_supported()
|
|
{
|
|
return Config::bool('vacation') && Config::bool('vacation_control');
|
|
}
|
|
|
|
/**
|
|
* @return boolean true if on vacation, otherwise false
|
|
* Why do we bother storing true/false in the vacation table if the alias dictates it anyway?
|
|
*/
|
|
public function check_vacation()
|
|
{
|
|
$handler = new AliasHandler();
|
|
|
|
if (!$handler->init($this->id)) {
|
|
# print_r($handler->errormsg); # TODO: error handling
|
|
return false;
|
|
}
|
|
|
|
if (!$handler->view()) {
|
|
# print_r($handler->errormsg); # TODO: error handling
|
|
return false;
|
|
}
|
|
|
|
$result = $handler->result();
|
|
|
|
if ($result['on_vacation']) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Retrieve information on someone who is on vacation
|
|
* @return array|boolean stored information on vacation - array(subject - string, message - string, active - boolean, activeFrom - date, activeUntil - date)
|
|
* will return false if no existing data
|
|
*/
|
|
public function get_details()
|
|
{
|
|
$table_vacation = table_by_key('vacation');
|
|
|
|
$sql = "SELECT * FROM $table_vacation WHERE email = :username";
|
|
$result = db_query_all($sql, array('username' => $this->username));
|
|
if (sizeof($result) != 1) {
|
|
return false;
|
|
}
|
|
|
|
$row = $result[0];
|
|
|
|
if (!is_array($row)) {
|
|
return false;
|
|
}
|
|
$boolean = ($row['active'] == db_get_boolean(true));
|
|
# TODO: only return true and store the db result array in $this->whatever for consistency with the other classes
|
|
return array(
|
|
'subject' => isset($row['subject']) ? $row['subject'] : null,
|
|
'body' => isset($row['body']) ? $row['body'] : null,
|
|
'active' => $boolean,
|
|
'interval_time' => isset($row['interval_time']) ? $row['interval_time'] : null,
|
|
'activeFrom' => isset($row['activefrom']) ? $row['activefrom'] : null,
|
|
'activeUntil' => isset($row['activeuntil']) ? $row['activeuntil'] : null
|
|
);
|
|
}
|
|
/**
|
|
* @param string $subject
|
|
* @param string $body
|
|
* @param int $interval_time
|
|
* @param string $activeFrom - something strtotime understands
|
|
* @param string $activeUntil - something strtotime understands
|
|
* @return boolean
|
|
*/
|
|
public function set_away($subject, $body, $interval_time, $activeFrom, $activeUntil)
|
|
{
|
|
$this->remove(); // clean out any notifications that might already have been sent.
|
|
|
|
if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $activeFrom)) {
|
|
$activeFrom .= ' 00:00:00';
|
|
}
|
|
if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $activeUntil)) {
|
|
$activeUntil .= ' 23:59:59';
|
|
}
|
|
|
|
$activeFrom = date("Y-m-d H:i:s", strtotime($activeFrom)); # TODO check if result looks like a valid date
|
|
$activeUntil = date("Y-m-d H:i:s", strtotime($activeUntil)); # TODO check if result looks like a valid date
|
|
list(/*NULL*/, $domain) = explode('@', $this->username);
|
|
|
|
$vacation_data = array(
|
|
'email' => $this->username,
|
|
'domain' => $domain,
|
|
'subject' => $subject,
|
|
'body' => $body,
|
|
'interval_time' => $interval_time,
|
|
'active' => db_get_boolean(true),
|
|
'activefrom' => $activeFrom,
|
|
'activeuntil' => $activeUntil,
|
|
);
|
|
|
|
if (! db_pgsql()) {
|
|
$vacation_data['cache'] = ''; # leftover from 2.2
|
|
}
|
|
|
|
// is there an entry in the vacaton table for the user, or do we need to insert?
|
|
$table_vacation = table_by_key('vacation');
|
|
$result = db_query_one("SELECT * FROM $table_vacation WHERE email = ?", array($this->username));
|
|
if (!empty($result)) {
|
|
$result = db_update('vacation', 'email', $this->username, $vacation_data);
|
|
} else {
|
|
$result = db_insert('vacation', $vacation_data);
|
|
}
|
|
# TODO error check
|
|
# TODO wrap whole function in db_begin / db_commit (or rollback)?
|
|
|
|
return $this->updateAlias(1);
|
|
}
|
|
|
|
/**
|
|
* add/remove the vacation alias
|
|
* @param int $vacationActive
|
|
* @return boolean
|
|
*/
|
|
protected function updateAlias($vacationActive)
|
|
{
|
|
$handler = new AliasHandler();
|
|
|
|
if (!$handler->init($this->id)) {
|
|
# print_r($handler->errormsg); # TODO: error handling
|
|
return false;
|
|
}
|
|
|
|
$values = array(
|
|
'on_vacation' => $vacationActive,
|
|
);
|
|
|
|
if (!$handler->set($values)) {
|
|
# print_r($handler->errormsg); # TODO: error handling
|
|
return false;
|
|
}
|
|
|
|
# TODO: supress logging in AliasHandler if called from VacationHandler (VacationHandler should log itsself)
|
|
|
|
if (!$handler->save()) {
|
|
print_r($handler->errormsg); # TODO: error handling
|
|
return false;
|
|
}
|
|
|
|
# still here? then everything worked
|
|
return true;
|
|
}
|
|
}
|
|
/* vim: set expandtab softtabstop=4 tabstop=4 shiftwidth=4: */
|