From 69f18a09aec6e352ff021cd9c5db806f341b7e48 Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Fri, 01 May 2009 15:04:26 -0400
Subject: [PATCH] Add plugin hooks for creating/saving/deleting identities and contacts
---
program/steps/settings/delete_identity.inc | 8 ++-
program/include/rcube_json_output.php | 17 +++++---
program/steps/addressbook/save.inc | 20 ++++++---
program/steps/settings/save_identity.inc | 19 ++++++---
program/include/rcube_user.php | 2
program/steps/addressbook/delete.inc | 4 +
program/include/rcube_template.php | 15 +++++--
7 files changed, 56 insertions(+), 29 deletions(-)
diff --git a/program/include/rcube_json_output.php b/program/include/rcube_json_output.php
index 7c79157..2fbf9c0 100644
--- a/program/include/rcube_json_output.php
+++ b/program/include/rcube_json_output.php
@@ -33,6 +33,7 @@
private $env = array();
private $texts = array();
private $commands = array();
+ private $message = null;
public $type = 'js';
public $ajax_call = true;
@@ -146,15 +147,19 @@
* @param string Message to display
* @param string Message type [notice|confirm|error]
* @param array Key-value pairs to be replaced in localized text
+ * @param boolean Override last set message
* @uses self::command()
*/
- public function show_message($message, $type='notice', $vars=null)
+ public function show_message($message, $type='notice', $vars=null, $override=true)
{
- $this->command(
- 'display_message',
- rcube_label(array('name' => $message, 'vars' => $vars)),
- $type
- );
+ if ($override || !$this->message) {
+ $this->message = $message;
+ $this->command(
+ 'display_message',
+ rcube_label(array('name' => $message, 'vars' => $vars)),
+ $type
+ );
+ }
}
/**
diff --git a/program/include/rcube_template.php b/program/include/rcube_template.php
index 307bd84..6ceb9ce 100755
--- a/program/include/rcube_template.php
+++ b/program/include/rcube_template.php
@@ -34,6 +34,7 @@
var $config;
var $framed = false;
var $pagetitle = '';
+ var $message = null;
var $env = array();
var $js_env = array();
var $js_commands = array();
@@ -225,14 +226,18 @@
* @param string Message to display
* @param string Message type [notice|confirm|error]
* @param array Key-value pairs to be replaced in localized text
+ * @param boolean Override last set message
* @uses self::command()
*/
- public function show_message($message, $type='notice', $vars=NULL)
+ public function show_message($message, $type='notice', $vars=null, $override=true)
{
- $this->command(
- 'display_message',
- rcube_label(array('name' => $message, 'vars' => $vars)),
- $type);
+ if ($override || !$this->message) {
+ $this->message = $message;
+ $this->command(
+ 'display_message',
+ rcube_label(array('name' => $message, 'vars' => $vars)),
+ $type);
+ }
}
diff --git a/program/include/rcube_user.php b/program/include/rcube_user.php
index 9d4d675..9d5cc5f 100644
--- a/program/include/rcube_user.php
+++ b/program/include/rcube_user.php
@@ -368,7 +368,7 @@
VALUES (".$dbh->now().", ".$dbh->now().", ?, ?, ?, ?)",
strip_newlines($user),
strip_newlines($host),
- strip_newlines($user_email),
+ strip_newlines($data['alias'] ? $data['alias'] : $user_email),
$_SESSION['language']);
if ($user_id = $dbh->insert_id(get_sequence_name('users')))
diff --git a/program/steps/addressbook/delete.inc b/program/steps/addressbook/delete.inc
index df1e407..6ab9cc3 100644
--- a/program/steps/addressbook/delete.inc
+++ b/program/steps/addressbook/delete.inc
@@ -24,7 +24,9 @@
preg_match('/^[a-zA-Z0-9=]+(,[a-zA-Z0-9=]+)*$/', $cid))
)
{
- $deleted = $CONTACTS->delete($cid);
+ $plugin = $RCMAIL->plugins->exec_hook('delete_contact', array('id' => $cid, 'source' => get_input_value('_source', RCUBE_INPUT_GPC)));
+
+ $deleted = !$plugin['abort'] ? $CONTACTS->delete($cid) : false;
if (!$deleted)
{
// send error message
diff --git a/program/steps/addressbook/save.inc b/program/steps/addressbook/save.inc
index 07f7460..3b01a9b 100644
--- a/program/steps/addressbook/save.inc
+++ b/program/steps/addressbook/save.inc
@@ -52,7 +52,10 @@
// update an existing contact
if (!empty($cid))
{
- if ($CONTACTS->update($cid, $a_record))
+ $plugin = $RCMAIL->plugins->exec_hook('save_contact', array('id' => $cid, 'record' => $a_record, 'source' => get_input_value('_source', RCUBE_INPUT_GPC)));
+ $a_record = $plugin['record'];
+
+ if (!$plugin['abort'] && $CONTACTS->update($cid, $a_record))
{
// define list of cols to be displayed
$a_js_cols = array();
@@ -65,13 +68,13 @@
$OUTPUT->command('parent.update_contact_row', $cid, $a_js_cols);
// show confirmation
- $OUTPUT->show_message('successfullysaved', 'confirmation');
+ $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);
rcmail_overwrite_action('show');
}
else
{
// show error message
- $OUTPUT->show_message('errorsaving', 'error');
+ $OUTPUT->show_message('errorsaving', 'error', null, false);
rcmail_overwrite_action('show');
}
}
@@ -85,13 +88,16 @@
// show warning message
if ($existing->count)
{
- $OUTPUT->show_message('contactexists', 'warning');
+ $OUTPUT->show_message('contactexists', 'warning', null, false);
rcmail_overwrite_action('add');
return;
}
+ $plugin = $RCMAIL->plugins->exec_hook('create_contact', array('record' => $a_record, 'source' => get_input_value('_source', RCUBE_INPUT_GPC)));
+ $a_record = $plugin['record'];
+
// insert record and send response
- if ($insert_id = $CONTACTS->insert($a_record))
+ if (!$plugin['abort'] && ($insert_id = $CONTACTS->insert($a_record)))
{
// add contact row or jump to the page where it should appear
$CONTACTS->reset();
@@ -105,14 +111,14 @@
$OUTPUT->command('parent.set_rowcount', rcmail_get_rowcount_text());
// show confirmation
- $OUTPUT->show_message('successfullysaved', 'confirmation');
+ $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);
rcmail_overwrite_action('show');
$_GET['_cid'] = $insert_id;
}
else
{
// show error message
- $OUTPUT->show_message('errorsaving', 'error');
+ $OUTPUT->show_message('errorsaving', 'error', null, false);
rcmail_overwrite_action('add');
}
}
diff --git a/program/steps/settings/delete_identity.inc b/program/steps/settings/delete_identity.inc
index a72a8a7..97c16d5 100644
--- a/program/steps/settings/delete_identity.inc
+++ b/program/steps/settings/delete_identity.inc
@@ -21,11 +21,13 @@
if (($ids = get_input_value('_iid', RCUBE_INPUT_GET)) && preg_match('/^[0-9]+(,[0-9]+)*$/', $ids))
{
- if ($USER->delete_identity($ids)) {
- $OUTPUT->show_message('deletedsuccessfully', 'confirmation');
+ $plugin = $RCMAIL->plugins->exec_hook('delete_identity', array('id' => $ids));
+
+ if (!$plugin['abort'] && $USER->delete_identity($ids)) {
+ $OUTPUT->show_message('deletedsuccessfully', 'confirmation', null, false);
}
else {
- $OUTPUT->show_message('nodeletelastidentity', 'error');
+ $OUTPUT->show_message('nodeletelastidentity', 'error', null, false);
}
// send response
if ($OUTPUT->ajax_call)
diff --git a/program/steps/settings/save_identity.inc b/program/steps/settings/save_identity.inc
index dba385f..754e86c 100644
--- a/program/steps/settings/save_identity.inc
+++ b/program/steps/settings/save_identity.inc
@@ -60,7 +60,11 @@
// update an existing contact
if ($_POST['_iid'])
{
- if ($updated = $USER->update_identity(get_input_value('_iid', RCUBE_INPUT_POST), $save_data))
+ $iid = get_input_value('_iid', RCUBE_INPUT_POST);
+ $plugin = $RCMAIL->plugins->exec_hook('save_identity', array('id' => $iid, 'record' => $save_data));
+ $save_data = $plugin['record'];
+
+ if (!$plugin['abort'] && ($updated = $USER->update_identity($iid, $save_data)))
{
$OUTPUT->show_message('successfullysaved', 'confirmation');
@@ -73,10 +77,10 @@
// ...
}
}
- else if ($DB->is_error())
+ else if ($plugin['abort'] || $DB->is_error())
{
// show error message
- $OUTPUT->show_message('errorsaving', 'error');
+ $OUTPUT->show_message('errorsaving', 'error', null, false);
rcmail_overwrite_action('edit-identity');
return;
}
@@ -88,9 +92,12 @@
if (IDENTITIES_LEVEL == 1)
$save_data['email'] = $RCMAIL->user->get_username();
- if ($save_data['email'] && ($insert_id = $USER->insert_identity($save_data)))
+ $plugin = $RCMAIL->plugins->exec_hook('create_identity', array('id' => $iid, 'record' => $save_data));
+ $save_data = $plugin['record'];
+
+ if (!$plugin['abort'] && $save_data['email'] && ($insert_id = $USER->insert_identity($save_data)))
{
- $OUTPUT->show_message('successfullysaved', 'confirmation');
+ $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);
$_GET['_iid'] = $insert_id;
@@ -100,7 +107,7 @@
else
{
// show error message
- $OUTPUT->show_message('errorsaving', 'error');
+ $OUTPUT->show_message('errorsaving', 'error', null, false);
rcmail_overwrite_action('edit-identity');
return;
}
--
Gitblit v1.9.1