6 * Copyright (c) 1999-2004 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * Manage personal address book.
12 * @package squirrelmail
15 /** Path for SquirrelMail required files. */
16 define('SM_PATH','../');
18 /** SquirrelMail required files. */
19 require_once(SM_PATH
. 'include/validate.php');
20 require_once(SM_PATH
. 'functions/global.php');
21 require_once(SM_PATH
. 'functions/display_messages.php');
22 require_once(SM_PATH
. 'functions/addressbook.php');
23 require_once(SM_PATH
. 'functions/strings.php');
24 require_once(SM_PATH
. 'functions/html.php');
25 require_once(SM_PATH
. 'functions/forms.php');
27 /** lets get the global vars we may need */
28 sqgetGlobalVar('key', $key, SQ_COOKIE
);
30 sqgetGlobalVar('username', $username, SQ_SESSION
);
31 sqgetGlobalVar('onetimepad',$onetimepad, SQ_SESSION
);
32 sqgetGlobalVar('base_uri', $base_uri, SQ_SESSION
);
33 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION
);
35 /* From the address form */
36 sqgetGlobalVar('addaddr', $addaddr, SQ_POST
);
37 sqgetGlobalVar('editaddr', $editaddr, SQ_POST
);
38 sqgetGlobalVar('deladdr', $deladdr, SQ_POST
);
39 sqgetGlobalVar('sel', $sel, SQ_POST
);
40 sqgetGlobalVar('oldnick', $oldnick, SQ_POST
);
41 sqgetGlobalVar('backend', $backend, SQ_POST
);
42 sqgetGlobalVar('doedit', $doedit, SQ_POST
);
46 * @param string $label
47 * @param string $field
50 * @param array $values
53 function addressbook_inp_field($label, $field, $name, $size, $values, $add) {
55 $value = ( isset($values[$field]) ?
$values[$field] : '');
57 $td_str = addInput($name.'['.$field.']', $value, $size)
60 return html_tag( 'tr' ,
61 html_tag( 'td', $label . ':', 'right', $color[4]) .
62 html_tag( 'td', $td_str, 'left', $color[4])
68 * Output form to add and modify address data
70 function address_form($name, $submittext, $values = array()) {
71 global $color, $squirrelmail_language;
73 if ($squirrelmail_language == 'ja_JP')
75 echo html_tag( 'table',
76 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
77 ' <SMALL>' . _("Must be unique") . '</SMALL>') .
78 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
79 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
80 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
81 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
82 list_writable_backends($name) .
85 '<INPUT TYPE=submit NAME="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
87 'center', $color[4], 'colspan="2"')
89 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
91 echo html_tag( 'table',
92 addressbook_inp_field(_("Nickname"), 'nickname', $name, 15, $values,
93 ' <SMALL>' . _("Must be unique") . '</SMALL>') .
94 addressbook_inp_field(_("E-mail address"), 'email', $name, 45, $values, '') .
95 addressbook_inp_field(_("First name"), 'firstname', $name, 45, $values, '') .
96 addressbook_inp_field(_("Last name"), 'lastname', $name, 45, $values, '') .
97 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
98 list_writable_backends($name) .
101 '<INPUT TYPE=submit NAME="' . htmlentities($name) . '[SUBMIT]" VALUE="' .
103 'center', $color[4], 'colspan="2"')
105 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
109 function list_writable_backends($name) {
110 global $color, $abook;
111 if ( $name != 'addaddr' ) { return; }
112 if ( $abook->numbackends
> 1 ) {
113 $ret = "<select name=backend>";
114 $backends = $abook->get_backend_list();
115 while (list($undef,$v) = each($backends)) {
117 $ret .= '<OPTION VALUE=' . $v->bnum
;
118 $ret .= '>' . $v->sname
. "\n";
122 return html_tag( 'tr',
123 html_tag( 'td', _("Add to:"),'right', $color[4] ) .
124 html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
126 return html_tag( 'tr',
128 addHidden('backend', '1'),
129 'center', $color[4], 'colspan="2"')) . "\n";
133 /* Open addressbook, with error messages on but without LDAP (the *
134 * second "true"). Don't need LDAP here anyway */
135 $abook = addressbook_init(true, true);
136 if($abook->localbackend
== 0) {
138 _("No personal address book is defined. Contact administrator."),
143 displayPageHeader($color, 'None');
148 $showaddrlist = true;
149 $defselected = array();
150 $form_url = 'addressbook.php';
153 /* Handle user's actions */
154 if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER
) && $req_method == 'POST') {
156 /**************************************************
158 **************************************************/
159 if (isset($addaddr)) {
160 foreach( $addaddr as $k => $adr ) {
161 $addaddr[$k] = strip_tags( $adr );
163 if (isset($backend)) {
164 $r = $abook->add($addaddr, $backend);
166 $r = $abook->add($addaddr, $abook->localbackend
);
169 /* Handle error messages */
171 /* Remove backend name from error string */
172 $errstr = $abook->error
;
173 $errstr = ereg_replace('^\[.*\] *', '', $errstr);
175 $formerror = $errstr;
176 $showaddrlist = false;
181 /************************************************
182 * Delete address(es) *
183 ************************************************/
184 if ((!empty($deladdr)) && sizeof($sel) > 0) {
188 /* The selected addresses are identidied by "backend:nickname". *
189 * Sort the list and process one backend at the time */
194 for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++
) {
195 list($sbackend, $snick) = explode(':', $sel[$i]);
197 /* When we get to a new backend, process addresses in *
199 if ($prevback != $sbackend && $prevback != -1) {
201 $r = $abook->remove($subsel, $prevback);
203 $formerror = $abook->error
;
211 /* Queue for processing */
212 array_push($subsel, $snick);
213 $prevback = $sbackend;
217 $r = $abook->remove($subsel, $prevback);
218 if (!$r) { /* Handle errors */
219 $formerror = $abook->error
;
225 $showaddrlist = true;
226 $defselected = $orig_sel;
231 /***********************************************
232 * Update/modify address *
233 ***********************************************/
234 if (!empty($editaddr)) {
236 /* Stage one: Copy data into form */
237 if (isset($sel) && sizeof($sel) > 0) {
238 if(sizeof($sel) > 1) {
239 $formerror = _("You can only edit one address at the time");
240 $showaddrlist = true;
244 list($ebackend, $enick) = explode(':', $sel[0]);
245 $olddata = $abook->lookup($enick, $ebackend);
247 /* Display the "new address" form */
248 echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' .
253 "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
254 'center', $color[0] )
256 'center', '', 'width="100%" ' );
257 address_form("editaddr", _("Update address"), $olddata);
258 echo addHidden('oldnick', $olddata['nickname']).
259 addHidden('backend', $olddata['backend']).
260 addHidden('doedit', '1').
265 /* Stage two: Write new data */
267 $newdata = $editaddr;
268 $r = $abook->modify($oldnick, $newdata, $backend);
270 /* Handle error messages */
273 echo html_tag( 'table',
276 "\n". '<strong><font color="' . $color[2] .
277 '">' . _("ERROR") . ': ' . $abook->error
. '</font></strong>' ."\n",
280 'center', '', 'width="100%"' );
282 /* Display the "new address" form again */
283 echo '<FORM ACTION="' . $form_url .
284 '" METHOD="POST">' . "\n" .
288 "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
289 'center', $color[0] )
291 'center', '', 'width="100%"' );
292 address_form("editaddr", _("Update address"), $newdata);
294 addHidden('oldnick', $oldnick).
295 addHidden('backend', $backend).
296 addHidden('doedit', '1').
302 /* Should not get here... */
303 plain_error_message(_("Unknown error"), $color);
307 } /* !empty($editaddr) - Update/modify address */
308 } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
309 } /* !empty($addaddr['nickname']) - Add new address */
311 // Some times we end output before forms are printed
313 echo "</BODY></HTML>\n";
319 /* =================================================================== *
320 * The following is only executed on a GET request, or on a POST when *
321 * a user is added, or when "delete" or "modify" was successful. *
322 * =================================================================== */
324 /* Display error messages */
325 if (!empty($formerror)) {
326 echo html_tag( 'table',
329 "\n". '<br><strong><font color="' . $color[2] .
330 '">' . _("ERROR") . ': ' . $formerror . '</font></strong>' ."\n",
333 'center', '', 'width="100%"' );
337 /* Display the address management part */
339 /* Get and sort address list */
340 $alist = $abook->list_addr();
341 if(!is_array($alist)) {
342 plain_error_message($abook->error
, $color);
346 usort($alist,'alistcmp');
348 $headerprinted = false;
350 echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
353 if (count($alist) > 0) {
354 echo '<FORM ACTION="' . $form_url . '" METHOD="POST">' . "\n";
355 while(list($undef,$row) = each($alist)) {
357 /* New table header for each backend */
358 if($prevbackend != $row['backend']) {
359 if($prevbackend < 0) {
360 echo html_tag( 'table',
363 '<INPUT TYPE=submit NAME=editaddr VALUE="' .
364 _("Edit selected") . "\">\n" .
365 '<INPUT TYPE=submit NAME=deladdr VALUE="' .
366 _("Delete selected") . "\">\n",
367 'center', '', 'colspan="5"' )
370 html_tag( 'td', ' <br>', 'center', '', 'colspan="5"' )
375 echo html_tag( 'table',
377 html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
379 'center', '', 'width="95%"' ) ."\n"
380 . html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
381 html_tag( 'tr', "\n" .
382 html_tag( 'th', ' ', 'left', '', 'width="1%"' ) .
383 html_tag( 'th', _("Nickname"), 'left', '', 'width="1%"' ) .
384 html_tag( 'th', _("Name"), 'left', '', 'width="1%"' ) .
385 html_tag( 'th', _("E-mail"), 'left', '', 'width="1%"' ) .
386 html_tag( 'th', _("Info"), 'left', '', 'width="1%"' ) ,
387 '', $color[9] ) . "\n";
390 $headerprinted = true;
391 } /* End of header */
393 $prevbackend = $row['backend'];
395 /* Check if this user is selected */
396 $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
400 if ($line %
2) { $tr_bgcolor = $color[0]; }
401 if ($squirrelmail_language == 'ja_JP')
403 echo html_tag( 'tr', '', '', $tr_bgcolor) .
406 addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']).
408 'center', '', 'valign="top" width="1%"' ) .
409 html_tag( 'td', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
410 html_tag( 'td', ' ' . $row['lastname'] . ' ' . $row['firstname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
411 html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . ' ';
413 echo html_tag( 'tr', '', '', $tr_bgcolor) .
416 '<INPUT TYPE=checkbox ' . $selected . ' NAME="sel[]" VALUE="' .
417 $row['backend'] . ':' . $row['nickname'] . '"></SMALL>' ,
418 'center', '', 'valign="top" width="1%"' ) .
419 html_tag( 'td', ' ' . $row['nickname'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
420 html_tag( 'td', ' ' . $row['name'] . ' ', 'left', '', 'valign="top" width="1%" nowrap' ) .
421 html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . ' ';
423 $email = $abook->full_address($row);
424 echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
425 htmlspecialchars($row['email']) ) .
427 html_tag( 'td', ' ' . htmlspecialchars($row['label']) . ' ', 'left', '', 'valign="top" width="1%"' ) .
432 /* End of list. Close table. */
433 if ($headerprinted) {
436 '<INPUT TYPE="submit" NAME="editaddr" VALUE="' . _("Edit selected") .
438 '<INPUT TYPE="submit" NAME="deladdr" VALUE="' . _("Delete selected") .
440 'center', '', 'colspan="5"' )
443 echo '</table></FORM>';
445 } /* end of addresslist */
448 /* Display the "new address" form */
449 echo '<a name="AddAddress"></a>' . "\n" .
450 '<FORM ACTION="' . $form_url . '" NAME=f_add METHOD="POST">' . "\n" .
453 html_tag( 'td', "\n". '<strong>' . _("Add to address book") . '</strong>' . "\n",
457 , 'center', '', 'width="100%"' ) ."\n";
458 address_form('addaddr', _("Add address"), $defdata);
461 /* Add hook for anything that wants on the bottom */
462 do_hook('addressbook_bottom');