From 4a05e8a7e8a39aee331a1d5bc45fbc1710ac6a15 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Fri, 08 Nov 2013 04:57:00 -0500
Subject: [PATCH] Finish advanced prefs feature (#1488829)
---
program/steps/addressbook/import.inc | 356 +++++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 251 insertions(+), 105 deletions(-)
diff --git a/program/steps/addressbook/import.inc b/program/steps/addressbook/import.inc
index 2390e98..60f5d7b 100644
--- a/program/steps/addressbook/import.inc
+++ b/program/steps/addressbook/import.inc
@@ -5,18 +5,19 @@
| program/steps/addressbook/import.inc |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2008-2009, The Roundcube Dev Team |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Import contacts from a vCard or CSV file |
| |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
+ | Author: Aleksander Machniak <machniak@kolabsys.com> |
+-----------------------------------------------------------------------+
-
- $Id: $
-
*/
/**
@@ -26,30 +27,66 @@
{
global $RCMAIL, $OUTPUT;
$target = get_input_value('_target', RCUBE_INPUT_GPC);
-
- $attrib += array('id' => "rcmImportForm");
-
- $abook = new html_hiddenfield(array('name' => '_target', 'value' => $target));
- $form = $abook->show();
- $upload = new html_inputfield(array('type' => 'file', 'name' => '_file', 'id' => 'rcmimportfile', 'size' => 40));
- $form .= html::p(null, html::label('rcmimportfile', rcube_label('importfromfile')) . html::br() . $upload->show());
-
+ $attrib += array('id' => "rcmImportForm");
+
+ $writable_books = $RCMAIL->get_address_sources(true, true);
+
+ $upload = new html_inputfield(array(
+ 'type' => 'file',
+ 'name' => '_file[]',
+ 'id' => 'rcmimportfile',
+ 'size' => 40,
+ 'multiple' => 'multiple',
+ ));
+ $form = html::p(null, html::label('rcmimportfile', rcube_label('importfromfile')) . $upload->show());
+ $table = new html_table(array('cols' => 2));
+
+ // addressbook selector
+ if (count($writable_books) > 1) {
+ $select = new html_select(array('name' => '_target', 'id' => 'rcmimporttarget', 'is_escaped' => true));
+
+ foreach ($writable_books as $book)
+ $select->add($book['name'], $book['id']);
+
+ $table->add('title', html::label('rcmimporttarget', rcube_label('importtarget')));
+ $table->add(null, $select->show($target));
+ }
+ else {
+ $abook = new html_hiddenfield(array('name' => '_target', 'value' => key($writable_books)));
+ $form .= $abook->show();
+ }
+
+ // selector for group import options
+ if (count($writable_books) >= 1 || $writable_books[0]->groups) {
+ $select = new html_select(array('name' => '_groups', 'id' => 'rcmimportgroups', 'is_escaped' => true));
+ $select->add(rcube_label('none'), '0');
+ $select->add(rcube_label('importgroupsall'), '1');
+ $select->add(rcube_label('importgroupsexisting'), '2');
+
+ $table->add('title', html::label('rcmimportgroups', rcube_label('importgroups')));
+ $table->add(null, $select->show(get_input_value('_groups', RCUBE_INPUT_GPC)));
+ }
+
+ // checkbox to replace the entire address book
$check_replace = new html_checkbox(array('name' => '_replace', 'value' => 1, 'id' => 'rcmimportreplace'));
- $form .= html::p(null, $check_replace->show(get_input_value('_replace', RCUBE_INPUT_GPC)) .
- html::label('rcmimportreplace', rcube_label('importreplace')));
-
+ $table->add('title', html::label('rcmimportreplace', rcube_label('importreplace')));
+ $table->add(null, $check_replace->show(get_input_value('_replace', RCUBE_INPUT_GPC)));
+
+ $form .= $table->show(array('id' => null) + $attrib);
+
+ $OUTPUT->set_env('writable_source', !empty($writable_books));
$OUTPUT->add_label('selectimportfile','importwait');
$OUTPUT->add_gui_object('importform', $attrib['id']);
-
- $out = html::p(null, Q(rcube_label('importtext'), 'show'));
-
+
+ $out = html::p(null, Q(rcube_label('importdesc'), 'show'));
+
$out .= $OUTPUT->form_tag(array(
'action' => $RCMAIL->url('import'),
'method' => 'post',
'enctype' => 'multipart/form-data') + $attrib,
$form);
-
+
return $out;
}
@@ -60,15 +97,29 @@
function rcmail_import_confirm($attrib)
{
global $IMPORT_STATS;
-
+
$vars = get_object_vars($IMPORT_STATS);
- $vars['names'] = join(', ', array_map('Q', $IMPORT_STATS->names));
-
- return html::p($attrib, Q(rcube_label(array(
- 'name' => 'importconfirm',
- 'nr' => $IMORT_STATS->inserted,
- 'vars' => $vars,
- )), 'show'));
+ $vars['names'] = $vars['skipped_names'] = '';
+
+ $content = html::p(null, rcube_label(array(
+ 'name' => 'importconfirm',
+ 'nr' => $IMPORT_STATS->inserted,
+ 'vars' => $vars,
+ )) . ($IMPORT_STATS->names ? ':' : '.'));
+
+ if ($IMPORT_STATS->names)
+ $content .= html::p('em', join(', ', array_map('Q', $IMPORT_STATS->names)));
+
+ if ($IMPORT_STATS->skipped) {
+ $content .= html::p(null, rcube_label(array(
+ 'name' => 'importconfirmskipped',
+ 'nr' => $IMPORT_STATS->skipped,
+ 'vars' => $vars,
+ )) . ':');
+ $content .= html::p('em', join(', ', array_map('Q', $IMPORT_STATS->skipped_names)));
+ }
+
+ return html::div($attrib, $content);
}
@@ -79,10 +130,10 @@
{
global $IMPORT_STATS, $OUTPUT;
$target = get_input_value('_target', RCUBE_INPUT_GPC);
-
+
$attrib += array('type' => 'input');
unset($attrib['name']);
-
+
if (is_object($IMPORT_STATS)) {
$attrib['class'] = trim($attrib['class'] . ' mainaction');
$out = $OUTPUT->button(array('command' => 'list', 'prop' => $target, 'label' => 'done') + $attrib);
@@ -93,8 +144,34 @@
$attrib['class'] = trim($attrib['class'] . ' mainaction');
$out .= $OUTPUT->button(array('command' => 'import', 'label' => 'import') + $attrib);
}
-
+
return $out;
+}
+
+
+/**
+ * Returns the matching group id. If group doesn't exist, it'll be created if allowed.
+ */
+function rcmail_import_group_id($group_name, $CONTACTS, $create, &$import_groups)
+{
+ $group_id = 0;
+ foreach ($import_groups as $key => $group) {
+ if (strtolower($group['name']) == strtolower($group_name)) {
+ $group_id = $group['ID'];
+ break;
+ }
+ }
+
+ // create a new group
+ if (!$group_id && $create) {
+ $new_group = $CONTACTS->create_group($group_name);
+ if (!$new_group['ID'])
+ $new_group['ID'] = $new_group['id'];
+ $import_groups[] = $new_group;
+ $group_id = $new_group['ID'];
+ }
+
+ return $group_id;
}
@@ -102,85 +179,154 @@
$importstep = 'rcmail_import_form';
-if ($_FILES['_file']['tmp_name'] && is_uploaded_file($_FILES['_file']['tmp_name'])) {
- $replace = (bool)get_input_value('_replace', RCUBE_INPUT_GPC);
- $target = get_input_value('_target', RCUBE_INPUT_GPC);
- $CONTACTS = $RCMAIL->get_address_book($target, true);
+if (is_array($_FILES['_file'])) {
+ $replace = (bool)get_input_value('_replace', RCUBE_INPUT_GPC);
+ $target = get_input_value('_target', RCUBE_INPUT_GPC);
+ $with_groups = intval(get_input_value('_groups', RCUBE_INPUT_GPC));
- // let rcube_vcard do the hard work :-)
- $vcards = rcube_vcard::import(file_get_contents($_FILES['_file']['tmp_name']));
+ $vcards = array();
+ $upload_error = null;
- // no vcards detected
- if (!count($vcards)) {
- $OUTPUT->show_message('importerror', 'error');
- }
- else if ($CONTACTS->readonly) {
- $OUTPUT->show_message('addresswriterror', 'error');
- }
- else {
- $IMPORT_STATS = new stdClass;
- $IMPORT_STATS->names = array();
- $IMPORT_STATS->count = count($vcards);
- $IMPORT_STATS->inserted = $IMPORT_STATS->skipped = $IMPORT_STATS->nomail = $IMPORT_STATS->errors = 0;
-
- if ($replace)
- $CONTACTS->delete_all();
-
- foreach ($vcards as $vcard) {
- $email = $vcard->email[0];
-
- // skip entries without an e-mail address
- if (empty($email)) {
- $IMPORT_STATS->nomail++;
- continue;
- }
-
- if (!$replace) {
- // compare e-mail address
- $existing = $CONTACTS->search('email', $email, false, false);
- if (!$existing->count) { // compare display name
- $existing = $CONTACTS->search('name', $vcard->displayname, false, false);
- }
- if ($existing->count) {
- $IMPORT_STATS->skipped++;
- continue;
- }
- }
-
- $a_record = array(
- 'name' => $vcard->displayname,
- 'firstname' => $vcard->firstname,
- 'surname' => $vcard->surname,
- 'email' => $email,
- 'vcard' => $vcard->export(),
- );
-
- $plugin = $RCMAIL->plugins->exec_hook('contact_create', array('record' => $a_record, 'source' => null));
- $a_record = $plugin['record'];
+ $CONTACTS = $RCMAIL->get_address_book($target, true);
- // insert record and send response
- if (!$plugin['abort'])
- $success = $CONTACTS->insert($a_record);
- else
- $success = $plugin['result'];
-
- if ($success) {
- $IMPORT_STATS->inserted++;
- $IMPORT_STATS->names[] = $vcard->displayname;
- } else {
- $IMPORT_STATS->errors++;
- }
+ if (!$CONTACTS->groups) {
+ $with_groups = false;
}
- $importstep = 'rcmail_import_confirm';
- }
-}
-else if ($err = $_FILES['_file']['error']) {
- if ($err == UPLOAD_ERR_INI_SIZE || $err == UPLOAD_ERR_FORM_SIZE) {
- $OUTPUT->show_message('filesizeerror', 'error', array('size' => show_bytes(parse_bytes(ini_get('upload_max_filesize')))));
- } else {
- $OUTPUT->show_message('fileuploaderror', 'error');
- }
+ if ($CONTACTS->readonly) {
+ $OUTPUT->show_message('addresswriterror', 'error');
+ }
+ else {
+ foreach ((array)$_FILES['_file']['tmp_name'] as $i => $filepath) {
+ // Process uploaded file if there is no error
+ $err = $_FILES['_file']['error'][$i];
+
+ if ($err) {
+ $upload_error = $err;
+ }
+ else {
+ $file_content = file_get_contents($filepath);
+
+ // let rcube_vcard do the hard work :-)
+ $vcard_o = new rcube_vcard();
+ $vcard_o->extend_fieldmap($CONTACTS->vcard_map);
+ $v_list = $vcard_o->import($file_content);
+
+ if (!empty($v_list)) {
+ $vcards = array_merge($vcards, $v_list);
+ continue;
+ }
+
+ // no vCards found, try CSV
+ $csv = new rcube_csv2vcard($_SESSION['language']);
+ $csv->import($file_content);
+ $v_list = $csv->export();
+
+ if (!empty($v_list)) {
+ $vcards = array_merge($vcards, $v_list);
+ }
+ }
+ }
+ }
+
+ // no vcards detected
+ if (!count($vcards)) {
+ if ($upload_error == UPLOAD_ERR_INI_SIZE || $err == UPLOAD_ERR_FORM_SIZE) {
+ $OUTPUT->show_message('filesizeerror', 'error', array('size' => show_bytes(parse_bytes(ini_get('upload_max_filesize')))));
+ }
+ else if ($upload_error) {
+ $OUTPUT->show_message('fileuploaderror', 'error');
+ }
+ else {
+ $OUTPUT->show_message('importformaterror', 'error');
+ }
+ }
+ else {
+ $IMPORT_STATS = new stdClass;
+ $IMPORT_STATS->names = array();
+ $IMPORT_STATS->skipped_names = array();
+ $IMPORT_STATS->count = count($vcards);
+ $IMPORT_STATS->inserted = $IMPORT_STATS->skipped = $IMPORT_STATS->invalid = $IMPORT_STATS->errors = 0;
+
+ if ($replace) {
+ $CONTACTS->delete_all();
+ }
+
+ if ($with_groups) {
+ $import_groups = $CONTACTS->list_groups();
+ }
+
+ foreach ($vcards as $vcard) {
+ $a_record = $vcard->get_assoc();
+
+ // Generate contact's display name (must be before validation), the same we do in save.inc
+ if (empty($a_record['name'])) {
+ $a_record['name'] = rcube_addressbook::compose_display_name($a_record, true);
+ // Reset it if equals to email address (from compose_display_name())
+ if ($a_record['name'] == $a_record['email'][0]) {
+ $a_record['name'] = '';
+ }
+ }
+
+ // skip invalid (incomplete) entries
+ if (!$CONTACTS->validate($a_record, true)) {
+ $IMPORT_STATS->invalid++;
+ continue;
+ }
+
+ // We're using UTF8 internally
+ $email = $vcard->email[0];
+ $email = rcube_idn_to_utf8($email);
+
+ if (!$replace) {
+ $existing = null;
+ // compare e-mail address
+ if ($email) {
+ $existing = $CONTACTS->search('email', $email, 1, false);
+ }
+ // compare display name if email not found
+ if ((!$existing || !$existing->count) && $vcard->displayname) {
+ $existing = $CONTACTS->search('name', $vcard->displayname, 1, false);
+ }
+ if ($existing && $existing->count) {
+ $IMPORT_STATS->skipped++;
+ $IMPORT_STATS->skipped_names[] = $vcard->displayname ? $vcard->displayname : $email;
+ continue;
+ }
+ }
+
+ $a_record['vcard'] = $vcard->export();
+
+ $plugin = $RCMAIL->plugins->exec_hook('contact_create',
+ array('record' => $a_record, 'source' => null));
+ $a_record = $plugin['record'];
+
+ // insert record and send response
+ if (!$plugin['abort'])
+ $success = $CONTACTS->insert($a_record);
+ else
+ $success = $plugin['result'];
+
+ if ($success) {
+ // assign groups for this contact (if enabled)
+ if ($with_groups && !empty($a_record['groups'])) {
+ foreach (explode(',', $a_record['groups'][0]) as $group_name) {
+ if ($group_id = rcmail_import_group_id($group_name, $CONTACTS, $with_groups == 1, $import_groups)) {
+ $CONTACTS->add_to_group($group_id, $success);
+ }
+ }
+ }
+
+ $IMPORT_STATS->inserted++;
+ $IMPORT_STATS->names[] = $a_record['name'] ? $a_record['name'] : $email;
+ }
+ else {
+ $IMPORT_STATS->errors++;
+ }
+ }
+
+ $importstep = 'rcmail_import_confirm';
+ }
}
--
Gitblit v1.9.1