Finish hierarchical groups browsing in LDAP address books; add according UI...

Thomas Bruederli

2013-02-07 86552ffc8f0f76651747a1faaed9bbda6d015f98

Finish hierarchical groups browsing in LDAP address books; add according UI elements and styles to the skins; adapt habavior of the compose address book widget

 program/js/app.js

@@ -251,7 +251,7 @@
          }
        }
        else if (this.env.action == 'compose') {
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor', 'list-adresses', 'search', 'reset-search', 'extwin'];
          this.env.compose_commands = ['send-attachment', 'remove-attachment', 'send', 'cancel', 'toggle-editor', 'list-adresses', 'pushgroup', 'search', 'reset-search', 'extwin'];

          if (this.env.drafts_mailbox)
            this.env.compose_commands.push('savedraft')
@@ -323,6 +323,8 @@

        this.enable_command('add', 'import', this.env.writable_source);
        this.enable_command('list', 'listgroup', 'pushgroup', 'listsearch', 'advanced-search', true);

        this.env.address_group_stack = [];

        if (this.gui_objects.contactslist) {
          this.contact_list = new rcube_list_widget(this.gui_objects.contactslist,
@@ -1081,7 +1083,11 @@
        break;

      case 'pushgroup':
        // TODO: so some magic stuff here
        // add group ID to stack
        this.env.address_group_stack.push(props.id);
        if (obj && event)
          rcube_event.cancel(event);

      case 'listgroup':
        this.reset_qsearch();
        this.list_contacts(props.source, props.id);
@@ -3061,7 +3067,13 @@

  this.compose_recipient_select = function(list)
  {
    this.enable_command('add-recipient', list.selection.length > 0);
    var id, n, recipients = 0;
    for (n=0; n < list.selection.length; n++) {
      id = list.selection[n];
      if (this.env.contactdata[id])
        recipients++;
    }
    this.enable_command('add-recipient', recipients);
  };

  this.compose_add_recipient = function(field)
@@ -4030,7 +4042,7 @@
    if (this.preview_timer)
      clearTimeout(this.preview_timer);

    var n, id, sid, ref = this, writable = false,
    var n, id, sid, contact, ref = this, writable = false,
      source = this.env.source ? this.env.address_sources[this.env.source] : null;

    if (id = list.get_single_selection())
@@ -4044,29 +4056,35 @@
      // we'll also need to know sources used in selection for copy
      // and group-addmember operations (drag&drop)
      this.env.selection_sources = [];
      if (!source) {
        for (n in list.selection) {

      if (source) {
        this.env.selection_sources.push(this.env.source);
      }

      for (n in list.selection) {
        contact = list.data[list.selection[n]];
        if (!source) {
          sid = String(list.selection[n]).replace(/^[^-]+-/, '');
          if (sid && this.env.address_sources[sid]) {
            writable = writable || !this.env.address_sources[sid].readonly;
            writable = writable || (!this.env.address_sources[sid].readonly && !contact.readonly);
            this.env.selection_sources.push(sid);
          }
        }
        this.env.selection_sources = $.unique(this.env.selection_sources);
        else {
          writable = writable || (!source.readonly && !contact.readonly);
        }
      }
      else {
        this.env.selection_sources.push(this.env.source);
        writable = !source.readonly;
      }

      this.env.selection_sources = $.unique(this.env.selection_sources);
    }

    // if a group is currently selected, and there is at least one contact selected
    // thend we can enable the group-remove-selected command
    this.enable_command('group-remove-selected', this.env.group && list.selection.length > 0);
    this.enable_command('group-remove-selected', this.env.group && list.selection.length > 0 && writable);
    this.enable_command('compose', this.env.group || list.selection.length > 0);
    this.enable_command('export-selected', list.selection.length > 0);
    this.enable_command('edit', id && writable);
    this.enable_command('delete', list.selection.length && writable);
    this.enable_command('delete', list.selection.length > 0 && writable);

    return false;
  };
@@ -4094,10 +4112,28 @@
    else if (!this.env.search_request)
      folder = group ? 'G'+src+group : src;

    this.select_folder(folder, '', true);

    this.env.source = src;
    this.env.group = group;

    // truncate groups listing stack
    var index = $.inArray(this.env.group, this.env.address_group_stack);
    if (index < 0)
      this.env.address_group_stack = [];
    else
      this.env.address_group_stack = this.env.address_group_stack.slice(0,index);

    // make sure the current group is on top of the stack
    if (this.env.group) {
      this.env.address_group_stack.push(this.env.group);

      // mark the first group on the stack as selected in the directory list
      folder = 'G'+src+this.env.address_group_stack[0];
    }
    else if (this.gui_objects.addresslist_title) {
        $(this.gui_objects.addresslist_title).html(this.get_label('contacts'));
    }

    this.select_folder(folder, '', true);

    // load contacts remotely
    if (this.gui_objects.contactslist) {
@@ -4160,15 +4196,19 @@
    this.enable_command('compose', this.env.group ? true : false);
  };

  this.set_group_prop = function(prop)
  {
    if (this.gui_objects.addresslist_title)
      $(this.gui_objects.addresslist_title).html(prop.name);

    this.triggerEvent('groupupdate', prop);
  };

  // load contact record
  this.load_contact = function(cid, action, framed)
  {
    var win, url = {}, target = window,
      rec = this.contact_list.data[cid];

    if (rec && rec.type == 'group') {
      alert('group ' + cid)
    }

    if (win = this.get_frame_window(this.env.contentframe)) {
      url._framed = 1;
@@ -4178,7 +4218,9 @@
      // load dummy content, unselect selected row(s)
      if (!cid)
        this.contact_list.clear_selection();
      this.enable_command('delete', 'compose', 'export-selected', cid);

      this.enable_command('compose', rec.email);
      this.enable_command('export-selected', rec._type != 'group');
    }
    else if (framed)
      return false;

 program/lib/Roundcube/rcube_ldap.php

@@ -924,7 +924,7 @@
            // We have a connection but no result set, attempt to get one.
            if (empty($this->filter)) {
                // The filter is not set, set it.
                $this->filter = $this->prop['filter'];
                $this->filter = $prop['filter'];
            }

            $count = (int) $this->_exec_search($prop, true);
@@ -1299,7 +1299,7 @@
            // change the group membership of the contact
            if ($this->groups) {
                $group_ids = $this->get_record_groups($dn);
                foreach ($group_ids as $group_id)
                foreach ($group_ids as $group_id => $group_prop)
                {
                    $this->remove_from_group($group_id, $dn);
                    $this->add_to_group($group_id, $newdn);
@@ -1365,7 +1365,7 @@
            if ($this->groups) {
                $dn = self::dn_encode($dn);
                $group_ids = $this->get_record_groups($dn);
                foreach ($group_ids as $group_id) {
                foreach ($group_ids as $group_id => $group_prop) {
                    $this->remove_from_group($group_id, $dn);
                }
            }
@@ -1735,11 +1735,11 @@
            // list regular groups configuration as special filter
            if (!empty($this->prop['groups']['filter'])) {
                $id = '__groups__';
                $groups[$id] = array('ID' => $id, 'name' => rcube_label('groups')) + $this->prop['groups'];
                $groups[$id] = array('ID' => $id, 'name' => rcube_label('groups'), 'virtual' => true) + $this->prop['groups'];
            }

            foreach ($this->prop['group_filters'] as $id => $prop) {
                $groups[$id] = $prop + array('ID' => $id, 'name' => ucfirst($id));
                $groups[$id] = $prop + array('ID' => $id, 'name' => ucfirst($id), 'virtual' => true);
            }

            return $groups;
@@ -1830,7 +1830,7 @@
            $dn = self::dn_decode($group_id);

            $this->_debug("C: Read Group [dn: $dn]");
            if ($result = @ldap_read($this->conn, $dn, '(objectClass=*)', array('dn','objectClass','member','uniqueMember','memberURL',$name_attr))) {
            if ($result = @ldap_read($this->conn, $dn, '(objectClass=*)', array('dn','objectClass','member','uniqueMember','memberURL',$name_attr,$this->fieldmap['email']))) {
                $list = ldap_get_entries($this->conn, $result);
                $entry = $list[0];
                $group_name = is_array($entry[$name_attr]) ? $entry[$name_attr][0] : $entry[$name_attr];
@@ -1858,10 +1858,7 @@
     */
    function get_group($group_id)
    {
        if (($group_cache = $this->cache->get('groups')) === null)
            $group_cache = $this->_fetch_groups();

        $group_data = $group_cache[$group_id];
        $group_data = $this->get_group_entry($group_id);
        unset($group_data['dn'], $group_data['member_attr']);

        return $group_data;
@@ -2040,7 +2037,7 @@

        $this->_debug("C: Search [$filter][dn: $base_dn]");

        $res = @ldap_search($this->conn, $base_dn, $filter, array($name_attr));
        $res = @ldap_search($this->conn, $base_dn, $filter, array('dn', $name_attr));
        if ($res === false)
        {
            $this->_debug("S: ".ldap_error($this->conn));
@@ -2053,8 +2050,8 @@
        for ($i=0; $i<$ldap_data["count"]; $i++)
        {
            $group_name = $ldap_data[$i][$name_attr][0];
            $group_id = self::dn_encode($group_name);
            $groups[$group_id] = $group_id;
            $group_id = self::dn_encode($ldap_data[$i]['dn']);
            $groups[$group_id] = array('ID' => $group_id, 'name' => $group_name, 'dn' => $ldap_data[$i]['dn']);
        }
        return $groups;
    }

 program/steps/addressbook/func.inc

@@ -343,6 +343,8 @@

    while ($row = $result->next()) {
        $row['CID'] = $row['ID'];
        $row['email'] = reset(rcube_addressbook::get_col_values('email', $row, true));

        $source_id = $OUTPUT->get_env('source');
        $a_row_cols = array();
        $classes = array($row['_type'] ? $row['_type'] : 'person');
@@ -367,7 +369,7 @@
                            'href' => '#list',
                            'rel' => $row['ID'],
                            'title' => rcube_label('listgroup'),
                            'onclick' => sprintf("return %s.command('pushgroup',{'source':'%s','id':'%s'},this)", JS_OBJECT_NAME, $source_id, $row['CID']),
                            'onclick' => sprintf("return %s.command('pushgroup',{'source':'%s','id':'%s'},this,event)", JS_OBJECT_NAME, $source_id, $row['CID']),
                        ), '&raquo;');
                    }
                    break;
@@ -383,8 +385,22 @@
        if ($row['readonly'])
            $classes[] = 'readonly';

        $OUTPUT->command($prefix.'add_contact_row', $row['ID'], $a_row_cols, join(' ', $classes), $row);
        $OUTPUT->command($prefix.'add_contact_row', $row['ID'], $a_row_cols, join(' ', $classes), array_intersect_key($row, array('ID'=>1,'readonly'=>1,'_type'=>1,'email'=>1,'name'=>1)));
    }
}


function rcmail_contacts_list_title($attrib)
{
    global $OUTPUT;

    $attrib += array('label' => 'contacts', 'id' => 'rcmabooklisttitle', 'tag' => 'span');
    unset($attrib['name']);

    $OUTPUT->add_gui_object('addresslist_title', $attrib['id']);
    $OUTPUT->add_label('contacts');

    return html::tag($attrib['tag'], $attrib, rcube_label($attrib['label']), html::$common_attrib);
}


@@ -456,7 +472,7 @@

function rcmail_contact_form($form, $record, $attrib = null)
{
    global $RCMAIL, $CONFIG;
    global $RCMAIL;

    // Allow plugins to modify contact form content
    $plugin = $RCMAIL->plugins->exec_hook('contact_form', array(
@@ -465,7 +481,7 @@
    $form = $plugin['form'];
    $record = $plugin['record'];
    $edit_mode = $RCMAIL->action != 'show';
    $del_button = $attrib['deleteicon'] ? html::img(array('src' => $CONFIG['skin_path'] . $attrib['deleteicon'], 'alt' => rcube_label('delete'))) : rcube_label('delete');
    $del_button = $attrib['deleteicon'] ? html::img(array('src' => $RCMAIL->output->get_skin_file($attrib['deleteicon']), 'alt' => rcube_label('delete'))) : rcube_label('delete');
    unset($attrib['deleteicon']);
    $out = '';

@@ -731,12 +747,15 @@

function rcmail_contact_photo($attrib)
{
    global $SOURCE_ID, $CONTACTS, $CONTACT_COLTYPES, $RCMAIL, $CONFIG;
    global $SOURCE_ID, $CONTACTS, $CONTACT_COLTYPES, $RCMAIL;

    if ($result = $CONTACTS->get_result())
        $record = $result->first();

    $photo_img = $attrib['placeholder'] ? $CONFIG['skin_path'] . $attrib['placeholder'] : 'program/resources/blank.gif';
    $photo_img = $attrib['placeholder'] ? $RCMAIL->output->get_skin_file($attrib['placeholder']) : 'program/resources/blank.gif';
    if ($record['_type'] == 'group' && $attrib['placeholdergroup'])
        $photo_img = $RCMAIL->output->get_skin_file($attrib['placeholdergroup']);

    $RCMAIL->output->set_env('photo_placeholder', $photo_img);
    unset($attrib['placeholder']);

@@ -820,6 +839,7 @@
    'directorylist' => 'rcmail_directory_list',
//  'groupslist' => 'rcmail_contact_groups',
    'addresslist' => 'rcmail_contacts_list',
    'addresslisttitle' => 'rcmail_contacts_list_title',
    'addressframe' => 'rcmail_contact_frame',
    'recordscountdisplay' => 'rcmail_rowcount_display',
    'searchform' => array($OUTPUT, 'search_form')

 program/steps/addressbook/list.inc

@@ -81,6 +81,11 @@
        $OUTPUT->show_message('contactsearchonly', 'notice');
        $OUTPUT->command('command', 'advanced-search');
    }

    if ($CONTACTS->group_id) {
        $OUTPUT->command('set_group_prop', array('ID' => $CONTACTS->group_id)
            + array_intersect_key((array)$CONTACTS->get_group($CONTACTS->group_id), array('name'=>1,'email'=>1)));
    }
}

// update message count display

 program/steps/addressbook/show.inc

@@ -215,8 +215,11 @@
    $checkbox = new html_checkbox(array('name' => '_gid[]',
        'class' => 'groupmember', 'disabled' => $CONTACTS->readonly));

    foreach ($GROUPS as $group) {
    foreach (array_merge($GROUPS, $members) as $group) {
        $gid = $group['ID'];
        if ($seen[$gid]++)
            continue;

        $table->add(null, $checkbox->show($members[$gid] ? $gid : null,
            array('value' => $gid, 'id' => 'ff_gid' . $gid)));
        $table->add(null, html::label('ff_gid' . $gid, Q($group['name'])));

 program/steps/mail/list_contacts.inc

@@ -73,8 +73,11 @@
        $CONTACTS->set_pagesize($page_size);
        $CONTACTS->set_page($page);

        if ($group_id = get_input_value('_gid', RCUBE_INPUT_GPC)) {
            $CONTACTS->set_group($group_id);
        }
        // list groups of this source (on page one)
        if ($CONTACTS->groups && $CONTACTS->list_page == 1) {
        else if ($CONTACTS->groups && $CONTACTS->list_page == 1) {
            foreach ($CONTACTS->list_groups() as $group) {
                $CONTACTS->reset();
                $CONTACTS->set_group($group['ID']);
@@ -89,6 +92,19 @@
                            'contactgroup' => html::span(array('title' => $email), Q($group['name']))), 'group');
                    }
                }
                // make virtual groups clickable to list their members
                else if ($group_prop['virtual']) {
                    $row_id = 'G'.$group['ID'];
                    $OUTPUT->command('add_contact_row', $row_id, array(
                        'contactgroup' => html::a(array(
                            'href' => '#list',
                            'rel' => $row['ID'],
                            'title' => rcube_label('listgroup'),
                            'onclick' => sprintf("return %s.command('pushgroup',{'source':'%s','id':'%s'},this,event)", JS_OBJECT_NAME, $source, $group['ID']),
                        ), Q($group['name']) . '&nbsp;' . html::span('action', '&raquo;'))),
                        'group',
                        array('ID' => $group['ID'], 'name' => $group['name'], 'virtual' => true));
                }
                // show group with count
                else if (($result = $CONTACTS->count()) && $result->count) {
                    $row_id = 'E'.$group['ID'];
@@ -97,10 +113,12 @@
                        'contactgroup' => Q($group['name'] . ' (' . intval($result->count) . ')')), 'group');
                }
            }

            $CONTACTS->reset();
            $CONTACTS->set_group(0);
        }

        // get contacts for this user
        $CONTACTS->set_group(0);
        $result = $CONTACTS->list_records($afields);
    }
}
@@ -118,10 +136,13 @@
        foreach ($emails as $i => $email) {
            $row_id = $row['ID'].$i;
            $jsresult[$row_id] = format_email_recipient($email, $name);
            $classname = $row['_type'] == 'group' ? 'group' : 'person';
            $keyname = $row['_type'] == 'group' ? 'contactgroup' : 'contact';

            $OUTPUT->command('add_contact_row', $row_id, array(
                'contact' => html::span(array('title' => $email), Q($name ? $name : $email) .
                $keyname => html::span(array('title' => $email), Q($name ? $name : $email) .
                    ($name && count($emails) > 1 ? '&nbsp;' . html::span('email', Q($email)) : '')
                )), 'person');
                )), $classname);
        }
    }
}

 skins/classic/addressbook.css

@@ -224,6 +224,37 @@
  -o-text-overflow: ellipsis;
}

#contacts-table .contact.readonly td
{
  font-style: italic;
}

#contacts-table td.name
{
  width: 95%;
}

#contacts-table td.action
{
  width: 12px;
  padding: 0px 6px 0 4px;
  text-align: right;
}

#contacts-table td.action a
{
  font-size: 16px;
  font-weight: bold;
  font-style: normal;
  text-decoration: none;
  color: #333;
}

#contacts-table .selected td.action a
{
  color: #fff;
}

#contacts-box
{
  position: absolute;

 skins/classic/images/contactgroup.png

 skins/classic/mail.css

@@ -1666,6 +1666,14 @@
  -o-text-overflow: ellipsis;
}

#contacts-table td span.email
{
  display: inline;
  color: #ccc;
  font-style: italic;
  margin-left: 0.5em;
}

#abookcountbar
{
  margin-top: 4px;

 skins/classic/templates/addressbook.html

@@ -74,7 +74,7 @@
<div id="addressscreen">

<div id="addresslist">
<div class="boxtitle"><roundcube:label name="contacts" /></div>
<roundcube:object name="addresslisttitle" label="contacts" tag="div" class="boxtitle" />
<div class="boxlistcontent">
<roundcube:object name="addresslist" id="contacts-table" class="records-table" cellspacing="0" summary="Contacts list" noheader="true" />
</div>

 skins/classic/templates/contact.html

@@ -13,7 +13,7 @@
    <div id="sourcename"><roundcube:label name="addressbook" />: <roundcube:var name="env:sourcename" /></div>
  <roundcube:endif />

  <div id="contactphoto"><roundcube:object name="contactphoto" id="contactpic" placeholder="/images/contactpic.png" /></div>
  <div id="contactphoto"><roundcube:object name="contactphoto" id="contactpic" placeholder="/images/contactpic.png" placeholderGroup="/images/contactgroup.png" /></div>
  <roundcube:object name="contacthead" id="contacthead" />
  <div style="clear:both"></div>
  <div id="contacttabs">

 skins/larry/addressbook.css

@@ -75,10 +75,6 @@
    text-overflow: ellipsis;
}

#contacts-table .contact.readonly td {
    font-style: italic;
}

#directorylist li.addressbook a {
    background-position: 6px -766px;
}
@@ -131,6 +127,28 @@
    left: 20px;
}

#contacts-table .contact.readonly td {
    font-style: italic;
}

#contacts-table td.name {
    width: 95%;
}

#contacts-table td.action {
    width: 24px;
    padding: 4px;
}

#contacts-table td.action a {
    display: block;
    width: 16px;
    height: 14px;
    text-indent: -5000px;
    overflow: hidden;
    background: url(images/listicons.png) -2px -1180px no-repeat;
}

#contacts-table .contact td.name {
    background-position: 6px -1603px;
}
@@ -151,6 +169,11 @@
    font-weight: bold;
}

#addresslist .boxtitle {
    padding-right: 95px;
    overflow: hidden;
    text-overflow: ellipsis;
}

#contact-frame {
    position: absolute;

 skins/larry/ie7hacks.css

@@ -41,6 +41,7 @@
.boxfooter .listbutton .inner,
.attachmentslist li a.delete,
.attachmentslist li a.cancelupload,
#contacts-table td.action a,
.previewheader .iconlink,
.minimal #taskbar .button-inner {
    /* workaround for text-indent which also offsets the background image */

 skins/larry/images/contactgroup.png

 skins/larry/images/listicons.png

 skins/larry/mail.css

@@ -1224,6 +1224,19 @@
    text-overflow: ellipsis;
}

#contacts-table td.contactgroup a {
    color: #376572;
    text-decoration: none;
}

#contacts-table td.contactgroup a span {
    display: inline-block;
    font-size: 16px;
    font-weight: bold;
    line-height: 11px;
    margin-left: 0.3em;
}

#contacts-table tr:first-child td {
    border-top: 0;
}

 skins/larry/templates/addressbook.html

@@ -50,7 +50,7 @@

<!-- contacts list -->
<div id="addresslist" class="uibox listbox">
<h2 class="boxtitle"><roundcube:label name="contacts" /></h2>
<roundcube:object name="addresslisttitle" label="contacts" tag="h2" class="boxtitle" />
<div class="scroller withfooter">
<roundcube:object name="addresslist" id="contacts-table" class="listing" noheader="true" />
</div>

 skins/larry/templates/contact.html

@@ -13,7 +13,7 @@
        <div id="sourcename"><roundcube:label name="addressbook" />: <roundcube:var name="env:sourcename" /></div>
    <roundcube:endif />

    <div id="contactphoto"><roundcube:object name="contactphoto" id="contactpic" placeholder="/images/contactpic.png" /></div>
    <div id="contactphoto"><roundcube:object name="contactphoto" id="contactpic" placeholder="/images/contactpic.png" placeholderGroup="/images/contactgroup.png" /></div>
    <roundcube:object name="contacthead" id="contacthead" />
    <br style="clear:both" />