Allow preference sections to define CSS class names

Thomas Bruederli

2015-04-17 a3644638aaf0418598196a870204e0b632a4c8ad

 program/steps/addressbook/save.inc

@@ -5,8 +5,11 @@
 | program/steps/addressbook/save.inc                                    |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
 | Licensed under the GNU GPL                                            |
 | Copyright (C) 2005-2013, 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:                                                              |
 |   Save a contact entry or to add a new one                            |
@@ -14,141 +17,103 @@
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id$

*/

$cid = get_input_value('_cid', RCUBE_INPUT_POST);
$CONTACTS      = rcmail_contact_source(null, true, true);
$cid           = rcube_utils::get_input_value('_cid', rcube_utils::INPUT_POST);
$return_action = empty($cid) ? 'add' : 'edit';

// Source changed, display the form again
if (!empty($_GET['_reload'])) {
    $RCMAIL->overwrite_action($return_action);
    return;
}

// cannot edit record
if ($CONTACTS->readonly) {
  $OUTPUT->show_message('contactreadonly', 'error');
  rcmail_overwrite_action($return_action);
  return;
    $OUTPUT->show_message('contactreadonly', 'error');
    $RCMAIL->overwrite_action($return_action);
    return;
}


// handle photo upload for contacts
if ($RCMAIL->action == 'upload-photo') {
    // clear all stored output properties (like scripts and env vars)
    $OUTPUT->reset();

    if ($filepath = $_FILES['_photo']['tmp_name']) {
        // check file type and resize image
        $imageprop = rcmail::imageprops($_FILES['_photo']['tmp_name']);
        
        if ($imageprop['width'] && $imageprop['height']) {
            $maxsize = intval($RCMAIL->config->get('contact_photo_size', 160));
            $tmpfname = tempnam($RCMAIL->config->get('temp_dir'), 'rcmImgConvert');
            $save_hook = 'attachment_upload';
            
            // scale image to a maximum size
            if (($imageprop['width'] > $maxsize || $imageprop['height'] > $maxsize) &&
                  (rcmail::imageconvert(array('in' => $filepath, 'out' => $tmpfname, 'size' => $maxsize.'x'.$maxsize, 'type' => $imageprop['type'])) !== false)) {
                $filepath = $tmpfname;
                $save_hook = 'attachment_save';
            }
            
            // save uploaded file in storage backend
            $attachment = $RCMAIL->plugins->exec_hook($save_hook, array(
                'path' => $filepath,
                'size' => $_FILES['_photo']['size'],
                'name' => $_FILES['_photo']['name'],
                'mimetype' => 'image/' . $imageprop['type'],
            ));
        }
        else
            $attachment['error'] = rcube_label('invalidimageformat');

        if ($attachment['status'] && !$attachment['abort']) {
            $file_id = $attachment['id'];
            $_SESSION['contacts']['files'][$file_id] = $attachment;
            $OUTPUT->command('replace_contact_photo', $file_id);
        }
        else {  // upload failed
            $err = $_FILES['_photo']['error'];
            if ($err == UPLOAD_ERR_INI_SIZE || $err == UPLOAD_ERR_FORM_SIZE)
                $msg = rcube_label(array('name' => 'filesizeerror', 'vars' => array('size' => show_bytes(parse_bytes(ini_get('upload_max_filesize'))))));
            else if ($attachment['error'])
                $msg = $attachment['error'];
            else
                $msg = rcube_label('fileuploaderror');
            
            $OUTPUT->command('display_message', $msg, 'error');
        }
    }
    else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
        // if filesize exceeds post_max_size then $_FILES array is empty,
        // show filesizeerror instead of fileuploaderror
        if ($maxsize = ini_get('post_max_size'))
            $msg = rcube_label(array('name' => 'filesizeerror', 'vars' => array('size' => show_bytes(parse_bytes($maxsize)))));
        else
            $msg = rcube_label('fileuploaderror');
            
        $OUTPUT->command('display_message', $msg, 'error');
    }
    
    $OUTPUT->command('photo_upload_end');
    $OUTPUT->send('iframe');
}


// read POST values into hash array
$a_record = array();
foreach ($GLOBALS['CONTACT_COLTYPES'] as $col => $colprop) {
  $fname = '_'.$col;
  if ($colprop['composite'])
    continue;
  // gather form data of composite fields
  if ($colprop['childs']) {
    $values = array();
    foreach ($colprop['childs'] as $childcol => $cp) {
      $vals = get_input_value('_'.$childcol, RCUBE_INPUT_POST);
      foreach ((array)$vals as $i => $val)
        $values[$i][$childcol] = $val;
    if ($colprop['composite']) {
        continue;
    }
    $subtypes = get_input_value('_subtype_' . $col, RCUBE_INPUT_POST);
    foreach ($subtypes as $i => $subtype)
      if ($values[$i])
        $a_record[$col.':'.$subtype][] = $values[$i];
  }
  // assign values and subtypes
  else if (is_array($_POST[$fname])) {
    $values = get_input_value($fname, RCUBE_INPUT_POST);
    $subtypes = get_input_value('_subtype_' . $col, RCUBE_INPUT_POST);
    foreach ($values as $i => $val) {
      $subtype = $subtypes[$i] ? ':'.$subtypes[$i] : '';
      $a_record[$col.$subtype][] = $val;

    $fname = '_'.$col;

    // gather form data of composite fields
    if ($colprop['childs']) {
        $values = array();
        foreach ($colprop['childs'] as $childcol => $cp) {
            $vals = rcube_utils::get_input_value('_'.$childcol, rcube_utils::INPUT_POST, true);
            foreach ((array)$vals as $i => $val) {
                $values[$i][$childcol] = $val;
            }
        }

        $subtypes = isset($_REQUEST['_subtype_' . $col]) ? (array)rcube_utils::get_input_value('_subtype_' . $col, rcube_utils::INPUT_POST) : array('');
        foreach ($subtypes as $i => $subtype) {
            $suffix = $subtype ? ':'.$subtype : '';
            if ($values[$i]) {
                $a_record[$col.$suffix][] = $values[$i];
            }
        }
    }
  }
  else if (isset($_POST[$fname])) {
    $a_record[$col] = get_input_value($fname, RCUBE_INPUT_POST);
  }
    // assign values and subtypes
    else if (is_array($_POST[$fname])) {
        $values   = rcube_utils::get_input_value($fname, rcube_utils::INPUT_POST, true);
        $subtypes = rcube_utils::get_input_value('_subtype_' . $col, rcube_utils::INPUT_POST);

        foreach ($values as $i => $val) {
            if ($col == 'email') {
                // extract email from full address specification, e.g. "Name" <addr@domain.tld>
                $addr = rcube_mime::decode_address_list($val, 1, false);
                if (!empty($addr) && ($addr = array_pop($addr)) && $addr['mailto']) {
                    $val = $addr['mailto'];
                }
            }

            $subtype = $subtypes[$i] ? ':'.$subtypes[$i] : '';
            $a_record[$col.$subtype][] = $val;
        }
    }
    else if (isset($_POST[$fname])) {
        $a_record[$col] = rcube_utils::get_input_value($fname, rcube_utils::INPUT_POST, true);

        // normalize the submitted date strings
        if ($colprop['type'] == 'date') {
            if ($a_record[$col] && ($dt = rcube_utils::anytodatetime($a_record[$col]))) {
                $a_record[$col] = $dt->format('Y-m-d');
            }
            else {
                unset($a_record[$col]);
            }
        }
    }
}

if (empty($a_record['name']))
  $a_record['name'] = join(' ', array_filter(array($a_record['prefix'], $a_record['firstname'], $a_record['middlename'], $a_record['surname'], $a_record['suffix'],)));
// Generate contact's display name (must be before validation)
if (empty($a_record['name'])) {
    $a_record['name'] = rcube_addressbook::compose_display_name($a_record, true);


// Basic input checks (TODO: delegate to $CONTACTS instance)
if (empty($a_record['name'])/* || empty($a_record['email'])*/) {
  $OUTPUT->show_message('formincomplete', 'warning');
  rcmail_overwrite_action($return_action);
  return;
    // Reset it if equals to email address (from compose_display_name())
    $email = rcube_addressbook::get_col_values('email', $a_record, true);
    if ($a_record['name'] == $email[0]) {
        $a_record['name'] = '';
    }
}

// Validity checks
foreach ($CONTACTS->get_col_values('email', $a_record, true) as $email) {
  if (strlen($email)) {
    $_email = rcube_idn_to_ascii($email);
    if (!check_email($_email)) {
      $OUTPUT->show_message('emailformaterror', 'warning', array('email' => $email));
      rcmail_overwrite_action($return_action);
      return;
    }
  }
// do input checks (delegated to $CONTACTS instance)
if (!$CONTACTS->validate($a_record)) {
    $err = (array)$CONTACTS->get_error();
    $OUTPUT->show_message($err['message'] ? rcube::Q($err['message']) : 'formincomplete', 'warning');
    $GLOBALS['EDIT_RECORD'] = $a_record;  // store submitted data to be used in edit form
    $RCMAIL->overwrite_action($return_action);
    return;
}

// get raw photo data if changed
@@ -163,115 +128,128 @@
    }
    else
        unset($a_record['photo']);
    

    // cleanup session data
    $RCMAIL->plugins->exec_hook('attachments_cleanup', array());
    $RCMAIL->plugins->exec_hook('attachments_cleanup', array('group' => 'contact'));
    $RCMAIL->session->remove('contacts');
}

$source = rcube_utils::get_input_value('_source', rcube_utils::INPUT_GPC);

// update an existing contact
if (!empty($cid))
{
  $plugin = $RCMAIL->plugins->exec_hook('contact_update',
    array('id' => $cid, 'record' => $a_record, 'source' => get_input_value('_source', RCUBE_INPUT_GPC)));
  $a_record = $plugin['record'];
if (!empty($cid)) {
    $plugin = $RCMAIL->plugins->exec_hook('contact_update',
        array('id' => $cid, 'record' => $a_record, 'source' => $source));
    $a_record = $plugin['record'];

  if (!$plugin['abort'])
    $result = $CONTACTS->update($cid, $a_record);
  else
    $result = $plugin['result'];
    if (!$plugin['abort'])
        $result = $CONTACTS->update($cid, $a_record);
    else
        $result = $plugin['result'];

  if ($result) {
    // LDAP DN change
    if (is_string($result) && strlen($result)>1) {
      $newcid = $result;
      // change cid in POST for 'show' action
      $_POST['_cid'] = $newcid;
    if ($result) {
        // show confirmation
        $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);

        // in search mode, just reload the list (#1490015)
        if ($_REQUEST['_search']) {
            $OUTPUT->command('parent.command', 'list');
            $OUTPUT->send('iframe');
        }

        // LDAP DN change
        if (is_string($result) && strlen($result)>1) {
            $newcid = $result;
            // change cid in POST for 'show' action
            $_POST['_cid'] = $newcid;
        }

        // define list of cols to be displayed
        $a_js_cols = array();
        $record = $CONTACTS->get_record($newcid ? $newcid : $cid, true);
        $record['email'] = reset($CONTACTS->get_col_values('email', $record, true));
        $record['name']  = rcube_addressbook::compose_list_name($record);

        foreach (array('name') as $col) {
            $a_js_cols[] = rcube::Q((string)$record[$col]);
        }

        // performance: unset some big data items we don't need here
        $record = array_intersect_key($record, array('ID' => 1,'email' => 1,'name' => 1));
        $record['_type'] = 'person';

        // update the changed col in list
        $OUTPUT->command('parent.update_contact_row', $cid, $a_js_cols, $newcid, $source, $record);

        $RCMAIL->overwrite_action('show');
    }

    // define list of cols to be displayed
    $a_js_cols = array();
    $record = $CONTACTS->get_record($newcid ? $newcid : $cid, true);

    foreach (array('name', 'email') as $col)
      $a_js_cols[] = (string)$record[$col];

    // update the changed col in list
    $OUTPUT->command('parent.update_contact_row', $cid, $a_js_cols, $newcid);

    // show confirmation
    $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);
    rcmail_overwrite_action('show');
  }
  else {
    // show error message
    $err = $CONTACTS->get_error();
    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
    rcmail_overwrite_action('show');
  }
    else {
        // show error message
        $err = $CONTACTS->get_error();
        $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
        $RCMAIL->overwrite_action('show');
    }
}

// insert a new contact
else {
  // check for existing contacts
  $existing = false;
  foreach ($CONTACTS->get_col_values('email', $a_record, true) as $email) {
      if (($res = $CONTACTS->search('email', $email, true, false)) && $res->count) {
          $existing = true;
          break;
      }
  }
    // Name of the addressbook already selected on the list
    $orig_source = rcube_utils::get_input_value('_orig_source', rcube_utils::INPUT_GPC);

  // show warning message
  if ($existing) {
    $OUTPUT->show_message('contactexists', 'warning', null, false);
    rcmail_overwrite_action('add');
    return;
  }

  $plugin = $RCMAIL->plugins->exec_hook('contact_create', array(
    'record' => $a_record, 'source' => get_input_value('_source', RCUBE_INPUT_GPC)));
  $a_record = $plugin['record'];

  // insert record and send response
  if (!$plugin['abort'])
    $insert_id = $CONTACTS->insert($a_record);
  else
    $insert_id = $plugin['result'];


  if ($insert_id) {
    // add new contact to the specified group
    if ($CONTACTS->groups && $CONTACTS->group_id) {
      $plugin = $RCMAIL->plugins->exec_hook('group_addmembers', array('group_id' => $CONTACTS->group_id, 'ids' => $insert_id, 'source' => $source));

      if (!$plugin['abort']) {
        if (($maxnum = $RCMAIL->config->get('max_group_members', 0)) && ($CONTACTS->count()->count + 1 > $maxnum))
          $OUTPUT->show_message('maxgroupmembersreached', 'warning', array('max' => $maxnum));

        $CONTACTS->add_to_group($gid, $plugin['ids']);
      }
    if (!strlen($source)) {
        $source = $orig_source;
    }
    
    // add contact row or jump to the page where it should appear
    $CONTACTS->reset();
    $result = $CONTACTS->search($CONTACTS->primary_key, $insert_id);

    rcmail_js_contacts_list($result, 'parent.');
    $OUTPUT->command('parent.contact_list.select', $insert_id);
    // show notice if existing contacts with same e-mail are found
    foreach ($CONTACTS->get_col_values('email', $a_record, true) as $email) {
        if ($email && ($res = $CONTACTS->search('email', $email, 1, false, true)) && $res->count) {
            $OUTPUT->show_message('contactexists', 'notice', null, false);
            break;
        }
    }

    // update record count display
    $CONTACTS->reset();
    $OUTPUT->command('parent.set_rowcount', rcmail_get_rowcount_text());
    $plugin = $RCMAIL->plugins->exec_hook('contact_create', array(
        'record' => $a_record, 'source' => $source));
    $a_record = $plugin['record'];

    // show confirmation
    $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);
    $OUTPUT->send('iframe');
  }
  else {
    // show error message
    $err = $CONTACTS->get_error();
    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
    rcmail_overwrite_action('add');
  }
    // insert record and send response
    if (!$plugin['abort'])
        $insert_id = $CONTACTS->insert($a_record);
    else
        $insert_id = $plugin['result'];

    if ($insert_id) {
        $CONTACTS->reset();

        // add new contact to the specified group
        if ($CONTACTS->groups && $CONTACTS->group_id) {
            $plugin = $RCMAIL->plugins->exec_hook('group_addmembers', array(
                'group_id' => $CONTACTS->group_id, 'ids' => $insert_id, 'source' => $source));

            if (!$plugin['abort']) {
                if (($maxnum = $RCMAIL->config->get('max_group_members', 0)) && ($CONTACTS->count()->count + 1 > $maxnum)) {
                    // @FIXME: should we remove the contact?
                    $msgtext = $RCMAIL->gettext(array('name' => 'maxgroupmembersreached', 'vars' => array('max' => $maxnum)));
                    $OUTPUT->command('parent.display_message', $msgtext, 'warning');
                }
                else {
                    $CONTACTS->add_to_group($plugin['group_id'], $plugin['ids']);
                }
            }
        }

        // show confirmation
        $OUTPUT->show_message('successfullysaved', 'confirmation', null, false);

        $OUTPUT->command('parent.set_rowcount', $RCMAIL->gettext('loading'));
        $OUTPUT->command('parent.list_contacts');

        $OUTPUT->send('iframe');
    }
    else {
        // show error message
        $err = $CONTACTS->get_error();
        $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
        $RCMAIL->overwrite_action('add');
    }
}