From b0689bd500ccc347b6ecda63cd39269696e5a157 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Tue, 21 Jun 2011 03:56:40 -0400
Subject: [PATCH] - Set css class name on directory list row according to readonly flag and 'class' data provided by plugins
---
program/steps/addressbook/func.inc | 356 +++++++++++++++++++++++++++++++++++++++--------------------
1 files changed, 235 insertions(+), 121 deletions(-)
diff --git a/program/steps/addressbook/func.inc b/program/steps/addressbook/func.inc
index 336dd44..0f2d757 100644
--- a/program/steps/addressbook/func.inc
+++ b/program/steps/addressbook/func.inc
@@ -19,91 +19,134 @@
*/
-// add list of address sources to client env
-$js_list = $RCMAIL->get_address_sources();
-
-// select source
-$source = get_input_value('_source', RCUBE_INPUT_GPC);
-
-// if source is not set use first directory
-if (empty($source))
- $source = $js_list[key($js_list)]['id'];
-
-// instantiate a contacts object according to the given source
-$CONTACTS = $RCMAIL->get_address_book($source);
-
-$CONTACTS->set_pagesize($CONFIG['pagesize']);
-
-// set list properties and session vars
-if (!empty($_GET['_page']))
- $CONTACTS->set_page(($_SESSION['page'] = intval($_GET['_page'])));
-else
- $CONTACTS->set_page(isset($_SESSION['page']) ?$_SESSION['page'] : 1);
-
-if (!empty($_REQUEST['_gid']))
- $CONTACTS->set_group(get_input_value('_gid', RCUBE_INPUT_GPC));
-
-// set message set for search result
-if (!empty($_REQUEST['_search']) && isset($_SESSION['search'][$_REQUEST['_search']]))
- $CONTACTS->set_search_set($_SESSION['search'][$_REQUEST['_search']]);
-
-// set data source env
-$OUTPUT->set_env('source', $source ? $source : '0');
-$OUTPUT->set_env('readonly', $CONTACTS->readonly, false);
-if (!$OUTPUT->ajax_call) {
- $OUTPUT->set_env('address_sources', $js_list);
- $OUTPUT->set_pagetitle(rcube_label('addressbook'));
-}
-
+$SEARCH_MODS_DEFAULT = array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
// general definition of contact coltypes
$CONTACT_COLTYPES = array(
- 'name' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('name')),
- 'firstname' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('firstname')),
- 'surname' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('surname')),
- 'middlename' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('middlename')),
- 'prefix' => array('type' => 'text', 'size' => 8, 'limit' => 1, 'label' => rcube_label('nameprefix')),
- 'suffix' => array('type' => 'text', 'size' => 8, 'limit' => 1, 'label' => rcube_label('namesuffix')),
- 'nickname' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('nickname')),
- 'jobtitle' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('jobtitle')),
- 'organization' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('organization')),
- 'department' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('department')),
- 'gender' => array('type' => 'select', 'limit' => 1, 'label' => rcube_label('gender'), 'options' => array('male' => rcube_label('male'), 'female' => rcube_label('female'))),
- 'maidenname' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('maidenname')),
- 'email' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('email'), 'subtypes' => array('home','work','other')),
- 'phone' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('phone'), 'subtypes' => array('home','home2','work','work2','mobile','main','homefax','workfax','car','pager','video','assistant','other')),
+ 'name' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('name'), 'category' => 'main'),
+ 'firstname' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('firstname'), 'category' => 'main'),
+ 'surname' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('surname'), 'category' => 'main'),
+ 'email' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('email'), 'subtypes' => array('home','work','other'), 'category' => 'main'),
+ 'middlename' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('middlename'), 'category' => 'main'),
+ 'prefix' => array('type' => 'text', 'size' => 8, 'limit' => 1, 'label' => rcube_label('nameprefix'), 'category' => 'main'),
+ 'suffix' => array('type' => 'text', 'size' => 8, 'limit' => 1, 'label' => rcube_label('namesuffix'), 'category' => 'main'),
+ 'nickname' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('nickname'), 'category' => 'main'),
+ 'jobtitle' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('jobtitle'), 'category' => 'main'),
+ 'organization' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('organization'), 'category' => 'main'),
+ 'department' => array('type' => 'text', 'size' => 19, 'limit' => 1, 'label' => rcube_label('department'), 'category' => 'main'),
+ 'gender' => array('type' => 'select', 'limit' => 1, 'label' => rcube_label('gender'), 'options' => array('male' => rcube_label('male'), 'female' => rcube_label('female')), 'category' => 'personal'),
+ 'maidenname' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('maidenname'), 'category' => 'personal'),
+ 'phone' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('phone'), 'subtypes' => array('home','home2','work','work2','mobile','main','homefax','workfax','car','pager','video','assistant','other'), 'category' => 'main'),
'address' => array('type' => 'composite', 'label' => rcube_label('address'), 'subtypes' => array('home','work','other'), 'childs' => array(
- 'street' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('street')),
- 'locality' => array('type' => 'text', 'size' => 28, 'label' => rcube_label('locality')),
- 'zipcode' => array('type' => 'text', 'size' => 8, 'label' => rcube_label('zipcode')),
- 'region' => array('type' => 'text', 'size' => 12, 'label' => rcube_label('region')),
- 'country' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('country')),
- )),
- 'birthday' => array('type' => 'date', 'size' => 12, 'label' => rcube_label('birthday'), 'limit' => 1, 'render_func' => 'rcmail_format_date_col'),
- 'anniversary' => array('type' => 'date', 'size' => 12, 'label' => rcube_label('anniversary'), 'limit' => 1, 'render_func' => 'rcmail_format_date_col'),
- 'website' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('website'), 'subtypes' => array('homepage','work','blog','other')),
- 'im' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('instantmessenger'), 'subtypes' => array('aim','icq','msn','yahoo','jabber','skype','other')),
+ 'street' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('street'), 'category' => 'main'),
+ 'locality' => array('type' => 'text', 'size' => 28, 'label' => rcube_label('locality'), 'category' => 'main'),
+ 'zipcode' => array('type' => 'text', 'size' => 8, 'label' => rcube_label('zipcode'), 'category' => 'main'),
+ 'region' => array('type' => 'text', 'size' => 12, 'label' => rcube_label('region'), 'category' => 'main'),
+ 'country' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('country'), 'category' => 'main'),
+ ), 'category' => 'main'),
+ 'birthday' => array('type' => 'date', 'size' => 12, 'label' => rcube_label('birthday'), 'limit' => 1, 'render_func' => 'rcmail_format_date_col', 'category' => 'personal'),
+ 'anniversary' => array('type' => 'date', 'size' => 12, 'label' => rcube_label('anniversary'), 'limit' => 1, 'render_func' => 'rcmail_format_date_col', 'category' => 'personal'),
+ 'website' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('website'), 'subtypes' => array('homepage','work','blog','other'), 'category' => 'main'),
+ 'im' => array('type' => 'text', 'size' => 40, 'label' => rcube_label('instantmessenger'), 'subtypes' => array('aim','icq','msn','yahoo','jabber','skype','other'), 'category' => 'main'),
'notes' => array('type' => 'textarea', 'size' => 40, 'rows' => 15, 'label' => rcube_label('notes'), 'limit' => 1),
- 'photo' => array('type' => 'image', 'limit' => 1),
- 'assistant' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('assistant')),
- 'manager' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('manager')),
- 'spouse' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('spouse')),
+ 'photo' => array('type' => 'image', 'limit' => 1, 'category' => 'main'),
+ 'assistant' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('assistant'), 'category' => 'personal'),
+ 'manager' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('manager'), 'category' => 'personal'),
+ 'spouse' => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('spouse'), 'category' => 'personal'),
// TODO: define fields for vcards like GEO, KEY
);
-// reduce/extend $CONTACT_COLTYPES with specification from the current $CONTACT object
-if (is_array($CONTACTS->coltypes)) {
- // remove cols not listed by the backend class
- $contact_cols = $CONTACTS->coltypes[0] ? array_flip($CONTACTS->coltypes) : $CONTACTS->coltypes;
- $CONTACT_COLTYPES = array_intersect_key($CONTACT_COLTYPES, $contact_cols);
- // add associative coltypes definition
- if (!$CONTACTS->coltypes[0]) {
- foreach ($CONTACTS->coltypes as $col => $colprop)
- $CONTACT_COLTYPES[$col] = $CONTACT_COLTYPES[$col] ? array_merge($CONTACT_COLTYPES[$col], $colprop) : $colprop;
+
+// Addressbook UI
+if (!$RCMAIL->action && !$OUTPUT->ajax_call) {
+ // add list of address sources to client env
+ $js_list = $RCMAIL->get_address_sources();
+
+ $source = get_input_value('_source', RCUBE_INPUT_GPC);
+
+ // use first directory by default
+ if (!strlen($source) || !isset($js_list[$source]))
+ $source = $js_list[key($js_list)]['id'];
+
+ // find writeable source
+ foreach ($js_list as $s) {
+ if (!$s['readonly']) {
+ $OUTPUT->set_env('writable_source', $s['id']);
+ break;
+ }
}
+
+ $search_mods = $RCMAIL->config->get('addressbook_search_mods', $SEARCH_MODS_DEFAULT);
+ $OUTPUT->set_env('search_mods', $search_mods);
+ $OUTPUT->set_env('address_sources', $js_list);
+
+ $OUTPUT->set_pagetitle(rcube_label('addressbook'));
+ $_SESSION['addressbooks_count'] = count($js_list);
+
+ $CONTACTS = rcmail_contact_source($source, true);
}
-$OUTPUT->set_env('photocol', is_array($CONTACT_COLTYPES['photo']));
+
+// instantiate a contacts object according to the given source
+function rcmail_contact_source($source=null, $init_env=false)
+{
+ global $RCMAIL, $OUTPUT, $CONFIG, $CONTACT_COLTYPES;
+
+ if (!strlen($source)) {
+ $source = get_input_value('_source', RCUBE_INPUT_GPC);
+ }
+
+ if (!strlen($source)) {
+ return null;
+ }
+
+ // Get object
+ $CONTACTS = $RCMAIL->get_address_book($source);
+ $CONTACTS->set_pagesize($CONFIG['pagesize']);
+
+ // set list properties and session vars
+ if (!empty($_GET['_page']))
+ $CONTACTS->set_page(($_SESSION['page'] = intval($_GET['_page'])));
+ else
+ $CONTACTS->set_page(isset($_SESSION['page']) ? $_SESSION['page'] : 1);
+
+ if (!empty($_REQUEST['_gid']))
+ $CONTACTS->set_group(get_input_value('_gid', RCUBE_INPUT_GPC));
+
+ if (!$init_env)
+ return $CONTACTS;
+
+ $OUTPUT->set_env('readonly', $CONTACTS->readonly);
+ $OUTPUT->set_env('source', $source);
+
+ // reduce/extend $CONTACT_COLTYPES with specification from the current $CONTACT object
+ if (is_array($CONTACTS->coltypes)) {
+ // remove cols not listed by the backend class
+ $contact_cols = $CONTACTS->coltypes[0] ? array_flip($CONTACTS->coltypes) : $CONTACTS->coltypes;
+ $CONTACT_COLTYPES = array_intersect_key($CONTACT_COLTYPES, $contact_cols);
+ // add associative coltypes definition
+ if (!$CONTACTS->coltypes[0]) {
+ foreach ($CONTACTS->coltypes as $col => $colprop)
+ $CONTACT_COLTYPES[$col] = $CONTACT_COLTYPES[$col] ? array_merge($CONTACT_COLTYPES[$col], $colprop) : $colprop;
+ }
+ }
+
+ $OUTPUT->set_env('photocol', is_array($CONTACT_COLTYPES['photo']));
+
+ return $CONTACTS;
+}
+
+
+function rcmail_default_source($writable=false)
+{
+ global $RCMAIL;
+
+ // get list of address sources
+ $list = $RCMAIL->get_address_sources($writable);
+
+ // use first directory by default
+ return $list[key($list)]['id'];
+}
function rcmail_directory_list($attrib)
@@ -116,23 +159,37 @@
$out = '';
$local_id = '0';
$jsdata = array();
- $current = get_input_value('_source', RCUBE_INPUT_GPC);
+
$line_templ = html::tag('li', array(
- 'id' => 'rcmli%s', 'class' => 'addressbook %s'),
+ 'id' => 'rcmli%s', 'class' => '%s'),
html::a(array('href' => '%s',
'rel' => '%s',
'onclick' => "return ".JS_OBJECT_NAME.".command('list','%s',this)"), '%s'));
- // currently selected is the first address source in the list
- if (!isset($current))
- $current = strval(key((array)$OUTPUT->env['address_sources']));
+ $sources = (array) $OUTPUT->env['address_sources'];
+ reset($sources);
- foreach ((array)$OUTPUT->env['address_sources'] as $j => $source) {
+ // currently selected source
+ $current = get_input_value('_source', RCUBE_INPUT_GPC);
+ if (!strlen($current) || !isset($sources[$source]))
+ $current = strval(key($sources));
+
+ foreach ($sources as $j => $source) {
$id = strval($source['id'] ? $source['id'] : $j);
$js_id = JQ($id);
+
+ // set class name(s)
+ $class_name = 'addressbook';
+ if ($current === $id)
+ $class_name .= ' selected';
+ if ($source['readonly'])
+ $class_name .= ' readonly';
+ if ($source['class'])
+ $class_name .= ' ' . $source['class'];
+
$out .= sprintf($line_templ,
html_identifier($id),
- ($current === $id ? 'selected' : ''),
+ $class_name,
Q(rcmail_url(null, array('_source' => $id))),
$source['id'],
$js_id, (!empty($source['name']) ? Q($source['name']) : Q($id)));
@@ -221,10 +278,15 @@
// define list of cols to be displayed
$a_show_cols = array('name');
-
+
while ($row = $result->next()) {
$a_row_cols = array();
-
+
+ // build contact ID with source ID
+ if (isset($row['sourceid'])) {
+ $row['ID'] = $row['ID'].'-'.$row['sourceid'];
+ }
+
// format each col
foreach ($a_show_cols as $col)
$a_row_cols[$col] = Q($row[$col]);
@@ -241,7 +303,7 @@
if (!$attrib['id'])
$attrib['id'] = 'rcmcontactframe';
-
+
$attrib['name'] = $attrib['id'];
$OUTPUT->set_env('contentframe', $attrib['name']);
@@ -264,12 +326,14 @@
}
-function rcmail_get_rowcount_text()
+function rcmail_get_rowcount_text($result=null)
{
- global $CONTACTS;
-
+ global $CONTACTS, $CONFIG;
+
// read nr of contacts
- $result = $CONTACTS->get_result();
+ if (!$result) {
+ $result = $CONTACTS->get_result();
+ }
if (!$result) {
$result = $CONTACTS->count();
}
@@ -281,7 +345,7 @@
'name' => 'contactsfromto',
'vars' => array(
'from' => $result->first + 1,
- 'to' => min($result->count, $result->first + $CONTACTS->page_size),
+ 'to' => min($result->count, $result->first + $CONFIG['pagesize']),
'count' => $result->count)
));
@@ -298,7 +362,7 @@
&& ($label = preg_replace('/(\d+)$/', '', $label))
&& rcube_label_exists($label))
return rcube_label($label) . ' ' . $m[1];
-
+
return ucfirst($type);
}
@@ -317,11 +381,11 @@
$del_button = $attrib['deleteicon'] ? html::img(array('src' => $CONFIG['skin_path'] . $attrib['deleteicon'], 'alt' => rcube_label('delete'))) : rcube_label('delete');
unset($attrib['deleteicon']);
$out = '';
-
+
// get default coltypes
$coltypes = $GLOBALS['CONTACT_COLTYPES'];
- $coltype_lables = array();
-
+ $coltype_labels = array();
+
foreach ($coltypes as $col => $prop) {
if ($prop['subtypes']) {
$subtype_names = array_map('rcmail_get_type_label', $prop['subtypes']);
@@ -331,7 +395,7 @@
}
if ($prop['childs']) {
foreach ($prop['childs'] as $childcol => $cp)
- $coltype_lables[$childcol] = array('label' => $cp['label']);
+ $coltype_labels[$childcol] = array('label' => $cp['label']);
}
}
@@ -346,10 +410,9 @@
// render head section with name fields (not a regular list of rows)
if ($section == 'head') {
$content = '';
-
- // TODO: use the save name composition function as in save.inc
- $names_arr = array($record['prefix'], $record['firstname'], $record['middlename'], $record['surname'], $record['suffix']);
- if ($record['name'] == join(' ', array_filter($names_arr)))
+
+ // unset display name if it is composed from name parts (same composition function as in save.inc)
+ if ($record['name'] == rcube_addressbook::compose_display_name(array('name' => '') + (array)$record))
unset($record['name']);
// group fields
@@ -365,6 +428,10 @@
// skip cols unknown to the backend
if (!$coltypes[$col])
continue;
+
+ // only string values are expected here
+ if (is_array($record[$col]))
+ $record[$col] = join(' ', $record[$col]);
if ($RCMAIL->action == 'show') {
if (!empty($record[$col]))
@@ -382,7 +449,7 @@
}
$content .= html::div($blockname, $fields);
}
-
+
if ($edit_mode)
$content .= html::p('addfield', $select_add->show(null));
@@ -514,13 +581,13 @@
else // row without label
$rows .= html::div('row', html::div('contactfield', $val));
}
-
+
// add option to the add-field menu
if (!$colprop['limit'] || $coltypes[$field]['count'] < $colprop['limit']) {
$select_add->add($colprop['label'], $col);
$select_add->_count++;
}
-
+
// wrap rows in fieldgroup container
$content .= html::tag('fieldset', array('class' => 'contactfieldgroup ' . ($colprop['subtypes'] ? 'contactfieldgroupmulti ' : '') . 'contactcontroller' . $col, 'style' => ($rows ? null : 'display:none')),
($colprop['subtypes'] ? html::tag('legend', null, Q($colprop['label'])) : ' ') .
@@ -541,7 +608,7 @@
}
if ($edit_mode) {
- $RCMAIL->output->set_env('coltypes', $coltypes + $coltype_lables);
+ $RCMAIL->output->set_env('coltypes', $coltypes + $coltype_labels);
$RCMAIL->output->set_env('delbutton', $del_button);
$RCMAIL->output->add_label('delete');
}
@@ -553,29 +620,34 @@
function rcmail_contact_photo($attrib)
{
global $CONTACTS, $CONTACT_COLTYPES, $RCMAIL, $CONFIG;
-
+
+ if (!$CONTACT_COLTYPES['photo'])
+ return '';
+
if ($result = $CONTACTS->get_result())
$record = $result->first();
-
+
$photo_img = $attrib['placeholder'] ? $CONFIG['skin_path'] . $attrib['placeholder'] : 'program/blank.gif';
+ $RCMAIL->output->set_env('photo_placeholder', $photo_img);
unset($attrib['placeholder']);
-
- if ($CONTACT_COLTYPES['photo']) {
- $RCMAIL->output->set_env('photo_placeholder', $photo_img);
-
- if ($record['photo'])
- $photo_img = $RCMAIL->url(array('_action' => 'photo', '_cid' => $record['ID'], '_source' => $_REQUEST['_source']));
- $img = html::img(array('src' => $photo_img, 'border' => 1, 'alt' => ''));
- $content = html::div($attrib, $img);
-
- if ($RCMAIL->action == 'edit' || $RCMAIL->action == 'add') {
- $RCMAIL->output->add_gui_object('contactphoto', $attrib['id']);
- $hidden = new html_hiddenfield(array('name' => '_photo', 'id' => 'ff_photo'));
- $content .= $hidden->show();
- }
- }
-
- return $content;
+
+ if (strpos($record['photo'], 'http:') === 0)
+ $photo_img = $record['photo'];
+ else if ($record['photo'])
+ $photo_img = $RCMAIL->url(array('_action' => 'photo', '_cid' => $record['ID'], '_source' => $_REQUEST['_source']));
+ else
+ $ff_value = '-del-'; // will disable delete-photo action
+
+ $img = html::img(array('src' => $photo_img, 'border' => 1, 'alt' => ''));
+ $content = html::div($attrib, $img);
+
+ if ($RCMAIL->action == 'edit' || $RCMAIL->action == 'add') {
+ $RCMAIL->output->add_gui_object('contactphoto', $attrib['id']);
+ $hidden = new html_hiddenfield(array('name' => '_photo', 'id' => 'ff_photo', 'value' => $ff_value));
+ $content .= $hidden->show();
+ }
+
+ return $content;
}
@@ -586,6 +658,48 @@
}
+/**
+ * Returns contact ID(s) and source(s) from GET/POST data
+ *
+ * @return array List of contact IDs per-source
+ */
+function rcmail_get_cids()
+{
+ // contact ID (or comma-separated list of IDs) is provided in two
+ // forms. If _source is an empty string then the ID is a string
+ // containing contact ID and source name in form: <ID>-<SOURCE>
+
+ $cid = get_input_value('_cid', RCUBE_INPUT_GPC);
+ $source = get_input_value('_source', RCUBE_INPUT_GPC);
+
+ if (!preg_match('/^[a-zA-Z0-9\+\/=_-]+(,[a-zA-Z0-9\+\/=_-]+)*$/', $cid)) {
+ return array();
+ }
+
+ $cid = explode(',', $cid);
+ $got_source = strlen($source);
+ $result = array();
+
+ // create per-source contact IDs array
+ foreach ($cid as $id) {
+ // if _source is not specified we'll find it from decoded ID
+ if (!$got_source) {
+ list ($c, $s) = explode('-', $id, 2);
+ if (strlen($s)) {
+ $result[$s][] = $c;
+ }
+ else if (strlen($source)) {
+ $result[$source][] = $c;
+ }
+ }
+ else {
+ $result[$source][] = $id;
+ }
+ }
+
+ return $result;
+}
+
// register UI objects
$OUTPUT->add_handlers(array(
'directorylist' => 'rcmail_directory_list',
--
Gitblit v1.9.1