6 * Manage personal address book.
8 * @copyright © 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
12 * @subpackage addressbook
16 * Include the SquirrelMail initialization file.
18 include('../include/init.php');
20 /** SquirrelMail required files. */
21 /* address book functions */
22 require_once(SM_PATH
. 'functions/addressbook.php');
24 require_once(SM_PATH
. 'functions/forms.php');
26 /** lets get the global vars we may need */
28 /* From the address form */
29 sqgetGlobalVar('addaddr', $addaddr, SQ_POST
);
30 sqgetGlobalVar('editaddr', $editaddr, SQ_POST
);
31 sqgetGlobalVar('deladdr', $deladdr, SQ_POST
);
32 sqgetGlobalVar('sel', $sel, SQ_POST
);
33 sqgetGlobalVar('oldnick', $oldnick, SQ_POST
);
34 sqgetGlobalVar('backend', $backend, SQ_POST
);
35 sqgetGlobalVar('doedit', $doedit, SQ_POST
);
37 /* Get sorting order */
38 $abook_sort_order = get_abook_sort();
40 /* Create page header before addressbook_init in order to display error messages correctly. */
41 displayPageHeader($color, 'None');
43 /* Open addressbook with error messages on.
44 remote backends (LDAP) are enabled because they can be used. (list_addr function)
46 $abook = addressbook_init(true, false);
48 // FIXME: do we have to stop use of address book, when localbackend is not present.
49 if($abook->localbackend
== 0) {
51 _("No personal address book is defined. Contact administrator."),
60 $defselected = array();
61 $form_url = 'addressbook.php';
63 /* Handle user's actions */
64 if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER
) && $req_method == 'POST') {
66 /**************************************************
68 **************************************************/
69 if (isset($addaddr)) {
70 if (isset($backend)) {
71 $r = $abook->add($addaddr, $backend);
73 $r = $abook->add($addaddr, $abook->localbackend
);
76 /* Handle error messages */
78 /* Remove backend name from error string */
79 $errstr = $abook->error
;
80 $errstr = ereg_replace('^\[.*\] *', '', $errstr);
83 $showaddrlist = false;
88 /************************************************
89 * Delete address(es) *
90 ************************************************/
91 if ((!empty($deladdr)) && sizeof($sel) > 0) {
95 /* The selected addresses are identidied by "backend:nickname". *
96 * Sort the list and process one backend at the time */
101 for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++
) {
102 list($sbackend, $snick) = explode(':', $sel[$i]);
104 /* When we get to a new backend, process addresses in *
106 if ($prevback != $sbackend && $prevback != -1) {
108 $r = $abook->remove($subsel, $prevback);
110 $formerror = $abook->error
;
118 /* Queue for processing */
119 array_push($subsel, $snick);
120 $prevback = $sbackend;
124 $r = $abook->remove($subsel, $prevback);
125 if (!$r) { /* Handle errors */
126 $formerror = $abook->error
;
132 $showaddrlist = true;
133 $defselected = $orig_sel;
138 /***********************************************
139 * Update/modify address *
140 ***********************************************/
141 if (!empty($editaddr)) {
142 /* Stage one: Copy data into form */
143 if (isset($sel) && sizeof($sel) > 0) {
144 if(sizeof($sel) > 1) {
145 $formerror = _("You can only edit one address at the time");
146 $showaddrlist = true;
150 list($ebackend, $enick) = explode(':', $sel[0]);
151 $olddata = $abook->lookup($enick, $ebackend);
152 // FIXME: Test if $olddata really contains anything and return an error message if it doesn't
154 /* Display the "new address" form */
155 abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$olddata);
156 echo addHidden('oldnick', $olddata['nickname']).
157 addHidden('backend', $olddata['backend']).
158 addHidden('doedit', '1').
161 } elseif ($doedit == 1) {
162 /* Stage two: Write new data */
163 $newdata = $editaddr;
164 $r = $abook->modify($oldnick, $newdata, $backend);
166 /* Handle error messages */
169 echo html_tag( 'table',
172 "\n". '<strong><font color="' . $color[2] .
173 '">' . _("ERROR") . ': ' . $abook->error
. '</font></strong>' ."\n",
176 'center', '', 'width="100%"' );
178 /* Display the "new address" form again */
179 abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$newdata);
180 echo addHidden('oldnick', $oldnick).
181 addHidden('backend', $backend).
182 addHidden('doedit', '1').
188 * $editaddr is set, but $sel (address selection in address listing)
189 * and $doedit (address edit form) are not set.
190 * Assume that user clicked on "Edit address" without selecting any address.
192 $formerror = _("Please select address that you want to edit");
193 $showaddrlist = true;
194 } /* end of edit stage detection */
195 } /* !empty($editaddr) - Update/modify address */
196 } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
197 } /* !empty($addaddr['nickname']) - Add new address */
199 // Some times we end output before forms are printed
201 echo "</body></html>\n";
207 /* =================================================================== *
208 * The following is only executed on a GET request, or on a POST when *
209 * a user is added, or when "delete" or "modify" was successful. *
210 * =================================================================== */
212 /* Display error messages */
213 if (!empty($formerror)) {
214 echo html_tag( 'table',
217 "\n". '<br /><strong><font color="' . $color[2] .
218 '">' . _("ERROR") . ': ' . nl2br(htmlspecialchars($formerror)) . '</font></strong>' ."\n",
221 'center', '', 'width="100%"' );
225 /* Display the address management part */
227 /* Get and sort address list */
228 $alist = $abook->list_addr();
229 if(!is_array($alist)) {
230 plain_error_message(nl2br(htmlspecialchars($abook->error
)), $color);
234 usort($alist,'alistcmp');
236 $headerprinted = false;
238 echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
241 if (count($alist) > 0) {
242 echo addForm($form_url, 'post');
243 if ($abook->add_extra_field
) {
248 while(list($undef,$row) = each($alist)) {
250 /* New table header for each backend */
251 if($prevbackend != $row['backend']) {
252 if($prevbackend < 0) {
253 echo html_tag( 'table',
256 addSubmit(_("Edit selected"), 'editaddr').
257 addSubmit(_("Delete selected"), 'deladdr'),
258 'center', '', "colspan=\"$abook_fields\"" )
261 html_tag( 'td', ' <br />', 'center', '', "colspan=\"$abook_fields\"" )
264 echo "\n<!-- start of address book table -->\n" .
265 html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
266 html_tag( 'tr', "\n" .
267 html_tag( 'th', ' ', 'left', '', 'width="1%"' ) . "\n" .
268 html_tag( 'th', _("Nickname") .
269 show_abook_sort_button($abook_sort_order, _("sort by nickname"), 0, 1),
270 'left', '', 'width="1%"' ) . "\n" .
271 html_tag( 'th', _("Name") .
272 show_abook_sort_button($abook_sort_order, _("sort by name"), 2, 3),
273 'left', '', 'width="1%"' ) . "\n" .
274 html_tag( 'th', _("E-mail") .
275 show_abook_sort_button($abook_sort_order, _("sort by email"), 4, 5),
276 'left', '', 'width="1%"' ) . "\n" .
277 html_tag( 'th', _("Info") .
278 show_abook_sort_button($abook_sort_order, _("sort by info"), 6, 7),
279 'left', '', 'width="1%"' ) .
280 ($abook->add_extra_field ?
html_tag( 'th', ' ','left', '', 'width="1%"'): '') .
282 '', $color[9] ) . "\n";
285 // Separate different backends with <hr />
286 if($prevbackend > 0) {
288 html_tag( 'td', "<hr />", 'center', '' ,"colspan=\"$abook_fields\"" )
292 // Print backend name
294 html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] ,"colspan=\"$abook_fields\"" )
298 $headerprinted = true;
299 } /* End of header */
301 $prevbackend = $row['backend'];
303 /* Check if this user is selected */
304 $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
306 /* Print one row, with alternating color */
308 $tr_bgcolor = $color[12];
310 $tr_bgcolor = $color[4];
312 echo html_tag( 'tr', '', '', $tr_bgcolor);
313 if ($abook->backends
[$row['backend']]->writeable
) {
316 addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']).
318 'center', '', 'valign="top" width="1%"' );
322 'center', '', 'valign="top" width="1%"' );
325 ' ' . htmlspecialchars($row['nickname']) . ' ',
326 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
329 ' ' . htmlspecialchars($row['name']) . ' ',
330 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
332 // email address column
333 echo html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . ' ';
334 $email = $abook->full_address($row);
335 echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
336 htmlspecialchars($row['email'])).
340 echo html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', 'left', '', 'valign="top" width="1%"' );
342 // add extra column if third party backend needs it
343 if ($abook->add_extra_field
) {
345 ' ' . (isset($row['extra']) ?
$row['extra'] : '') . ' ',
346 'left', '', 'valign="top" width="1%"' );
352 "\n<!-- end of address book table -->\n";
354 /* End of list. Add edit/delete select buttons */
355 if ($headerprinted) {
356 echo html_tag( 'table',
359 addSubmit(_("Edit selected"), 'editaddr') .
360 addSubmit(_("Delete selected"), 'deladdr'),
361 'center', '', "colspan=\"$abook_fields\"" )
367 } /* end of addresslist */
370 /* Display the "new address" form */
371 echo '<a name="AddAddress"></a>' . "\n";
372 abook_create_form($form_url,'addaddr',_("Add to address book"),_("Add address"),$defdata);
375 /* Hook for extra address book blocks */
376 echo "<!-- start of addressbook_bottom hook-->\n";
377 do_hook('addressbook_bottom');
378 echo "\n<!-- end of addressbook_bottom hook-->\n";
379 $oTemplate->display('footer.tpl');