Implement address book widget on compose screen

thomascube

2012-01-05 eeb73cc21ae499f74a2e749d8f824bbc27bb3620

Implement address book widget on compose screen

 program/js/app.js

@@ -3,7 +3,7 @@
 | Roundcube Webmail Client Script                                       |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2011, Kolab Systems AG                                  |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
@@ -30,6 +30,7 @@
  this.command_handlers = {};
  this.onloads = [];
  this.messages = {};
  this.group2expand = {};

  // create protected reference to myself
  this.ref = 'rcmail';
@@ -246,7 +247,8 @@
          }
        }
        else if (this.env.action == 'compose') {
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor'];
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor',
            'list-adresses', 'add-recipient', 'firstpage', 'previouspage', 'nextpage', 'lastpage'];

          if (this.env.drafts_mailbox)
            this.env.compose_commands.push('savedraft')
@@ -265,6 +267,20 @@

          // init message compose form
          this.init_messageform();

          // init address book widget
          if (this.gui_objects.contactslist) {
            this.contact_list = new rcube_list_widget(this.gui_objects.contactslist,
              { multiselect:true, draggable:false, keyboard:false });
            this.contact_list.addEventListener('select', function(o){ ref.compose_recipeint_select(o); });
            this.contact_list.addEventListener('dblclick', function(o){ ref.compose_add_recipient('to'); });
            this.contact_list.init();
          }

          if (this.gui_objects.adressbookslist) {
            this.gui_objects.folderlist = this.gui_objects.adressbookslist;
            this.enable_command('list-adresses', true);
          }
        }
        // show printing dialog
        else if (this.env.action == 'print' && this.env.uid)
@@ -944,6 +960,15 @@

      case 'insert-sig':
        this.change_identity($("[name='_from']")[0], true);
        break;

      case 'list-adresses':
        this.list_contacts(props);
        this.enable_command('add-recipient', false);
        break;

      case 'add-recipient':
        this.compose_add_recipient(props);
        break;

      case 'reply-all':
@@ -1977,10 +2002,10 @@
    if (page > 0 && page <= this.env.pagecount) {
      this.env.current_page = page;

      if (this.task == 'mail')
        this.list_mailbox(this.env.mailbox, page);
      else if (this.task == 'addressbook')
      if (this.task == 'addressbook' || this.contact_list)
        this.list_contacts(this.env.source, this.env.group, page);
      else if (this.task == 'mail')
        this.list_mailbox(this.env.mailbox, page);
    }
  };

@@ -2966,6 +2991,38 @@
      .attr('autocomplete', 'off');
  };

  this.compose_recipeint_select = function(list)
  {
    this.enable_command('add-recipient', list.selection.length > 0);
  };

  this.compose_add_recipient = function(field)
  {
    var recipients = [], input = $('#_'+field);
    
    if (this.contact_list && this.contact_list.selection.length) {
      for (var id, n=0; n < this.contact_list.selection.length; n++) {
        id = this.contact_list.selection[n];
        if (id && this.env.contactdata[id]) {
          recipients.push(this.env.contactdata[id]);

          // group is added, expand it
          if (id.charAt(0) == 'E' && this.env.contactdata[id].indexOf('@') < 0 && input.length) {
            var gid = id.substr(1);
            this.group2expand[gid] = { name:this.env.contactdata[id], input:input.get(0) };
            this.http_request('group-expand', '_source='+urlencode(this.env.source)+'&_gid='+urlencode(gid), false);
          }
        }
      }
    }

    if (recipients.length && input.length) {
      var oldval = input.val();
      input.val((oldval ? oldval + this.env.recipients_delimiter : '') + recipients.join(this.env.recipients_delimiter));
      this.triggerEvent('add-recipient', { field:field, recipients:recipients });
    }
  };

  // checks the input fields before sending a message
  this.check_compose_input = function(cmd)
  {
@@ -3637,8 +3694,7 @@
    // insert all members of a group
    if (typeof this.env.contacts[id] === 'object' && this.env.contacts[id].id) {
      insert += this.env.contacts[id].name + this.env.recipients_delimiter;
      this.group2expand = $.extend({}, this.env.contacts[id]);
      this.group2expand.input = this.ksearch_input;
      this.group2expand[this.env.contacts[id].id] = $.extend({ input: this.ksearch_input }, this.env.contacts[id]);
      this.http_request('mail/group-expand', '_source='+urlencode(this.env.contacts[id].source)+'&_gid='+urlencode(this.env.contacts[id].id), false);
    }
    else if (typeof this.env.contacts[id] === 'string') {
@@ -3659,10 +3715,10 @@

  this.replace_group_recipients = function(id, recipients)
  {
    if (this.group2expand && this.group2expand.id == id) {
      this.group2expand.input.value = this.group2expand.input.value.replace(this.group2expand.name, recipients);
      this.triggerEvent('autocomplete_insert', { field:this.group2expand.input, insert:recipients });
      this.group2expand = null;
    if (this.group2expand[id]) {
      this.group2expand[id].input.value = this.group2expand[id].input.value.replace(this.group2expand[id].name, recipients);
      this.triggerEvent('autocomplete_insert', { field:this.group2expand[id].input, insert:recipients });
      this.group2expand[id] = null;
    }
  };

@@ -4001,7 +4057,7 @@
    if (this.env.search_request)
      url += '&_search='+this.env.search_request;

    this.http_request('list', url, lock);
    this.http_request(this.env.task == 'mail' ? 'list-contacts' : 'list', url, lock);
  };

  this.list_contacts_clear = function()
@@ -6038,7 +6094,7 @@
          this.enable_command('purge', this.purge_mailbox_test());
          this.enable_command('expand-all', 'expand-unread', 'collapse-all', this.env.threading && this.env.messagecount);

          if (response.action == 'list' || response.action == 'search') {
          if ((response.action == 'list' || response.action == 'search') && this.message_list) {
            this.msglist_select(this.message_list);
            this.triggerEvent('listupdate', { folder:this.env.mailbox, rowcount:this.message_list.rowcount });
          }

 program/steps/mail/compose.inc

@@ -5,7 +5,7 @@
 | program/steps/mail/compose.inc                                        |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
@@ -1471,6 +1471,58 @@
}


function rcmail_adressbook_list($attrib = array())
{
    global $RCMAIL, $OUTPUT;

    $attrib += array('id' => 'rcmdirectorylist');

    $out = '';
    $line_templ = html::tag('li', array(
        'id' => 'rcmli%s', 'class' => '%s'),
        html::a(array('href' => '#list',
            'rel' => '%s',
            'onclick' => "return ".JS_OBJECT_NAME.".command('list-adresses','%s',this)"), '%s'));

    foreach ($RCMAIL->get_address_sources() as $j => $source) {
        $id = strval(strlen($source['id']) ? $source['id'] : $j);
        $js_id = JQ($id);

        // set class name(s)
        $class_name = 'addressbook';
        if ($source['class_name'])
            $class_name .= ' ' . $source['class_name'];

        $out .= sprintf($line_templ,
            html_identifier($id),
            $class_name,
            $source['id'],
            $js_id, (!empty($source['name']) ? Q($source['name']) : Q($id)));
    }

    $OUTPUT->add_gui_object('adressbookslist', $attrib['id']);

    return html::tag('ul', $attrib, $out, html::$common_attrib);
}

// return the contacts list as HTML table
function rcmail_contacts_list($attrib = array())
{
    global $OUTPUT;

    $attrib += array('id' => 'rcmAddressList');

    // set client env
    $OUTPUT->add_gui_object('contactslist', $attrib['id']);
    $OUTPUT->set_env('pagecount', 0);
    $OUTPUT->set_env('current_page', 0);
    $OUTPUT->include_script('list.js');

    return rcube_table_output($attrib, array(), array('name'), 'ID');
}



// register UI objects
$OUTPUT->add_handlers(array(
  'composeheaders' => 'rcmail_compose_headers',
@@ -1484,6 +1536,8 @@
  'receiptcheckbox' => 'rcmail_receipt_checkbox',
  'dsncheckbox' => 'rcmail_dsn_checkbox',
  'storetarget' => 'rcmail_store_target_selection',
  'adressbooks' => 'rcmail_adressbook_list',
  'addresslist' => 'rcmail_contacts_list',
));

$OUTPUT->send('compose');

 program/steps/mail/list_contacts.inc

New file
@@ -0,0 +1,87 @@
<?php

/*
 +-----------------------------------------------------------------------+
 | program/steps/mail/list_contacts.inc                                  |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2012, The Roundcube Dev Team                            |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
 |   Send contacts list to client (as remote response)                   |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id$

*/

$jsenv = array();
$source = get_input_value('_source', RCUBE_INPUT_GPC);
$CONTACTS = $RCMAIL->get_address_book($source);
$PAGE_SIZE = $RCMAIL->config->get('addressbook_pagesize', $RCMAIL->config->get('pagesize', 50));

if ($CONTACTS && $CONTACTS->ready) {
    // set list properties
    $CONTACTS->set_pagesize($PAGE_SIZE);
    $CONTACTS->set_page(max(1, intval($_GET['_page'])));

    // list groups of this source (on page one)
    if ($CONTACTS->groups && $CONTACTS->list_page == 1) {
        foreach ($CONTACTS->list_groups() as $group) {
            $CONTACTS->reset();
            $CONTACTS->set_group($group['ID']);
            $group_prop = $CONTACTS->get_group($group['ID']);

            // group (distribution list) with email address(es)
            if ($group_prop['email']) {
                foreach ((array)$group_prop['email'] as $email) {
                    $row_id = 'G'.$group['ID'];
                    $jsresult[$row_id] = format_email_recipient($email, $group['name']);
                    $OUTPUT->command('add_contact_row', $row_id, array(
                        'contactgroup' => html::span(array('title' => $email), Q($group['name']))));
                }
            }
            // show group with count
            else if (($result = $CONTACTS->count()) && $result->count) {
                $row_id = 'E'.$group['ID'];
                $jsresult[$row_id] = $group['name'];
                $OUTPUT->command('add_contact_row', $row_id, array(
                    'contactgroup' => Q($group['name'] . ' (' . intval($result->count) . ')')));
            }
        }
    }

    // get contacts for this user
    $CONTACTS->set_group(0);
    $result = $CONTACTS->list_records(array('name', 'email'));

    if (!$result->count && $result->searchonly) {
        $OUTPUT->show_message('contactsearchonly', 'notice');
    }
    else if (!empty($result) && $result->count > 0) {
        // create javascript list
        while ($row = $result->next()) {
            $name = rcube_addressbook::compose_display_name($row, true);

            // add record for every email address of the contact
            foreach ($CONTACTS->get_col_values('email', $row, true) as $i => $email) {
                $row_id = $row['ID'].$i;
                $jsresult[$row_id] = format_email_recipient($email, $name);
                $OUTPUT->command('add_contact_row', $row_id, array(
                    'contact' => html::span(array('title' => $email), Q($name ? $name : $email))));
            }
        }
    }
}

// update env
$OUTPUT->set_env('contactdata', $jsresult);
$OUTPUT->set_env('pagecount', ceil($result->count / $PAGE_SIZE));
$OUTPUT->command('set_page_buttons');

// send response
$OUTPUT->send();