- Drop obsolete script plugins/make_archive.pl.
[squirrelmail.git] / src / addressbook.php
CommitLineData
abdfb4d0 1<?php
134e4174 2
35586184 3/**
4 * addressbook.php
5 *
35586184 6 * Manage personal address book.
7 *
47ccfad4 8 * @copyright &copy; 1999-2006 The SquirrelMail Project Team
4b4abf93 9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
30967a1e 10 * @version $Id$
8f6f9ba5 11 * @package squirrelmail
de00443c 12 * @subpackage addressbook
35586184 13 */
14
30967a1e 15/**
202bcbcc 16 * Include the SquirrelMail initialization file.
30967a1e 17 */
202bcbcc 18include('../include/init.php');
86725763 19
8f6f9ba5 20/** SquirrelMail required files. */
df4162cb 21/* address book functions */
202bcbcc 22require_once(SM_PATH . 'functions/addressbook.php');
df4162cb 23/* form functions */
202bcbcc 24require_once(SM_PATH . 'functions/forms.php');
ffd8224c 25
8f6f9ba5 26/** lets get the global vars we may need */
0b97a708 27
28/* From the address form */
1e12d1ff 29sqgetGlobalVar('addaddr', $addaddr, SQ_POST);
30sqgetGlobalVar('editaddr', $editaddr, SQ_POST);
31sqgetGlobalVar('deladdr', $deladdr, SQ_POST);
32sqgetGlobalVar('sel', $sel, SQ_POST);
33sqgetGlobalVar('oldnick', $oldnick, SQ_POST);
34sqgetGlobalVar('backend', $backend, SQ_POST);
2741cc97 35sqgetGlobalVar('doedit', $doedit, SQ_POST);
0b97a708 36
08e71631 37/* Get sorting order */
38$abook_sort_order = get_abook_sort();
39
703fa6b5 40/* Create page header before addressbook_init in order to display error messages correctly. */
41displayPageHeader($color, 'None');
42
de00443c 43/* Open addressbook with error messages on.
44 remote backends (LDAP) are enabled because they can be used. (list_addr function)
45*/
46$abook = addressbook_init(true, false);
ced653f3 47
48// FIXME: do we have to stop use of address book, when localbackend is not present.
daba719e 49if($abook->localbackend == 0) {
50 plain_error_message(
056a005c 51 _("No personal address book is defined. Contact administrator."),
52 $color);
daba719e 53 exit();
54}
ffd8224c 55
daba719e 56$defdata = array();
57$formerror = '';
58$abortform = false;
59$showaddrlist = true;
60$defselected = array();
07dcee9f 61$form_url = 'addressbook.php';
daba719e 62
f6c945b9 63/* Handle user's actions */
1e12d1ff 64if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
daba719e 65
f6c945b9 66 /**************************************************
67 * Add new address *
68 **************************************************/
39b26252 69 if (isset($addaddr)) {
a123157f 70 if (isset($backend)) {
71 $r = $abook->add($addaddr, $backend);
72 } else {
73 $r = $abook->add($addaddr, $abook->localbackend);
c6554ec0 74 }
ffd8224c 75
f6c945b9 76 /* Handle error messages */
77 if (!$r) {
78 /* Remove backend name from error string */
ffd8224c 79 $errstr = $abook->error;
80 $errstr = ereg_replace('^\[.*\] *', '', $errstr);
81
82 $formerror = $errstr;
83 $showaddrlist = false;
84 $defdata = $addaddr;
85 }
daba719e 86 } else {
ffd8224c 87
f6c945b9 88 /************************************************
89 * Delete address(es) *
90 ************************************************/
91 if ((!empty($deladdr)) && sizeof($sel) > 0) {
daba719e 92 $orig_sel = $sel;
93 sort($sel);
94
f6c945b9 95 /* The selected addresses are identidied by "backend:nickname". *
96 * Sort the list and process one backend at the time */
daba719e 97 $prevback = -1;
98 $subsel = array();
99 $delfailed = false;
100
f6c945b9 101 for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
daba719e 102 list($sbackend, $snick) = explode(':', $sel[$i]);
103
f6c945b9 104 /* When we get to a new backend, process addresses in *
105 * previous one. */
106 if ($prevback != $sbackend && $prevback != -1) {
daba719e 107
108 $r = $abook->remove($subsel, $prevback);
f6c945b9 109 if (!$r) {
daba719e 110 $formerror = $abook->error;
111 $i = sizeof($sel);
112 $delfailed = true;
113 break;
114 }
115 $subsel = array();
116 }
117
f6c945b9 118 /* Queue for processing */
daba719e 119 array_push($subsel, $snick);
120 $prevback = $sbackend;
ffd8224c 121 }
ffd8224c 122
f6c945b9 123 if (!$delfailed) {
daba719e 124 $r = $abook->remove($subsel, $prevback);
f6c945b9 125 if (!$r) { /* Handle errors */
daba719e 126 $formerror = $abook->error;
127 $delfailed = true;
128 }
ffd8224c 129 }
ffd8224c 130
f6c945b9 131 if ($delfailed) {
daba719e 132 $showaddrlist = true;
133 $defselected = $orig_sel;
ffd8224c 134 }
ffd8224c 135
daba719e 136 } else {
137
f6c945b9 138 /***********************************************
139 * Update/modify address *
140 ***********************************************/
141 if (!empty($editaddr)) {
f6c945b9 142 /* Stage one: Copy data into form */
daba719e 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;
147 $defselected = $sel;
148 } else {
149 $abortform = true;
5b61a40d 150 list($ebackend, $enick) = explode(':', current($sel));
daba719e 151 $olddata = $abook->lookup($enick, $ebackend);
5b61a40d 152 // Test if $olddata really contains anything and return an error message if it doesn't
153 if (!$olddata) {
154 error_box(nl2br(htmlspecialchars($abook->error)));
155 } else {
156 /* Display the "new address" form */
157 abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$olddata);
158 echo addHidden('oldnick', $olddata['nickname']).
159 addHidden('backend', $olddata['backend']).
160 addHidden('doedit', '1').
161 '</form>';
162 }
daba719e 163 }
3e87f870 164 } elseif ($doedit == 1) {
f6c945b9 165 /* Stage two: Write new data */
3e87f870 166 $newdata = $editaddr;
167 $r = $abook->modify($oldnick, $newdata, $backend);
daba719e 168
3e87f870 169 /* Handle error messages */
170 if (!$r) {
171 /* Display error */
172 echo html_tag( 'table',
a2b193bc 173 html_tag( 'tr',
174 html_tag( 'td',
175 "\n". '<strong><font color="' . $color[2] .
176 '">' . _("ERROR") . ': ' . $abook->error . '</font></strong>' ."\n",
177 'center' )
178 ),
179 'center', '', 'width="100%"' );
3e87f870 180
181 /* Display the "new address" form again */
182 abook_create_form($form_url,'editaddr',_("Update address"),_("Update address"),$newdata);
183 echo addHidden('oldnick', $oldnick).
184 addHidden('backend', $backend).
185 addHidden('doedit', '1').
186 "\n" . '</form>';
daba719e 187 $abortform = true;
188 }
3e87f870 189 } else {
190 /**
f8a1ed5a 191 * $editaddr is set, but $sel (address selection in address listing)
192 * and $doedit (address edit form) are not set.
3e87f870 193 * Assume that user clicked on "Edit address" without selecting any address.
194 */
195 $formerror = _("Please select address that you want to edit");
196 $showaddrlist = true;
197 } /* end of edit stage detection */
daba719e 198 } /* !empty($editaddr) - Update/modify address */
199 } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
200 } /* !empty($addaddr['nickname']) - Add new address */
201
202 // Some times we end output before forms are printed
203 if($abortform) {
056a005c 204 echo "</body></html>\n";
205 exit();
ffd8224c 206 }
daba719e 207}
ffd8224c 208
209
f6c945b9 210/* =================================================================== *
211 * The following is only executed on a GET request, or on a POST when *
212 * a user is added, or when "delete" or "modify" was successful. *
213 * =================================================================== */
ffd8224c 214
f6c945b9 215/* Display error messages */
216if (!empty($formerror)) {
ac987a56 217 echo html_tag( 'table',
056a005c 218 html_tag( 'tr',
219 html_tag( 'td',
220 "\n". '<br /><strong><font color="' . $color[2] .
35235328 221 '">' . _("ERROR") . ': ' . nl2br(htmlspecialchars($formerror)) . '</font></strong>' ."\n",
056a005c 222 'center' )
223 ),
224 'center', '', 'width="100%"' );
daba719e 225}
ffd8224c 226
227
f6c945b9 228/* Display the address management part */
229if ($showaddrlist) {
230 /* Get and sort address list */
daba719e 231 $alist = $abook->list_addr();
232 if(!is_array($alist)) {
35235328 233 plain_error_message(nl2br(htmlspecialchars($abook->error)), $color);
ffd8224c 234 exit;
daba719e 235 }
ffd8224c 236
daba719e 237 usort($alist,'alistcmp');
238 $prevbackend = -1;
239 $headerprinted = false;
ffd8224c 240
ac987a56 241 echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
ffd8224c 242
f6c945b9 243 /* List addresses */
91821fc0 244 if (count($alist) > 0) {
056a005c 245 echo addForm($form_url, 'post');
7b0ea860 246 if ($abook->add_extra_field) {
247 $abook_fields = 6;
248 } else {
249 $abook_fields = 5;
250 }
91821fc0 251 while(list($undef,$row) = each($alist)) {
056a005c 252
91821fc0 253 /* New table header for each backend */
254 if($prevbackend != $row['backend']) {
92cd1e8e 255 if($prevbackend < 0) {
ac987a56 256 echo html_tag( 'table',
134e4174 257 html_tag( 'tr',
258 html_tag( 'td',
056a005c 259 addSubmit(_("Edit selected"), 'editaddr').
260 addSubmit(_("Delete selected"), 'deladdr'),
7b0ea860 261 'center', '', "colspan=\"$abook_fields\"" )
134e4174 262 ) .
263 html_tag( 'tr',
7b0ea860 264 html_tag( 'td', '&nbsp;<br />', 'center', '', "colspan=\"$abook_fields\"" )
134e4174 265 ),
266 'center' );
2741cc97 267 echo "\n<!-- start of address book table -->\n" .
056a005c 268 html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
269 html_tag( 'tr', "\n" .
270 html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) . "\n" .
271 html_tag( 'th', _("Nickname") .
272 show_abook_sort_button($abook_sort_order, _("sort by nickname"), 0, 1),
273 'left', '', 'width="1%"' ) . "\n" .
91e0dccc 274 html_tag( 'th', _("Name") .
056a005c 275 show_abook_sort_button($abook_sort_order, _("sort by name"), 2, 3),
276 'left', '', 'width="1%"' ) . "\n" .
91e0dccc 277 html_tag( 'th', _("E-mail") .
056a005c 278 show_abook_sort_button($abook_sort_order, _("sort by email"), 4, 5),
279 'left', '', 'width="1%"' ) . "\n" .
280 html_tag( 'th', _("Info") .
281 show_abook_sort_button($abook_sort_order, _("sort by info"), 6, 7),
7b0ea860 282 'left', '', 'width="1%"' ) .
5c4ff7bf 283 ($abook->add_extra_field ? html_tag( 'th', '&nbsp;','left', '', 'width="1%"'): '') .
7b0ea860 284 "\n",
056a005c 285 '', $color[9] ) . "\n";
d9879e29 286 }
287
2741cc97 288 // Separate different backends with <hr />
d9879e29 289 if($prevbackend > 0) {
290 echo html_tag( 'tr',
7b0ea860 291 html_tag( 'td', "<hr />", 'center', '' ,"colspan=\"$abook_fields\"" )
056a005c 292 );
2741cc97 293 }
294
295 // Print backend name
a2b193bc 296 echo html_tag( 'tr',
7b0ea860 297 html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] ,"colspan=\"$abook_fields\"" )
056a005c 298 );
d9879e29 299
91821fc0 300 $line = 0;
301 $headerprinted = true;
302 } /* End of header */
fc93f97c 303
91821fc0 304 $prevbackend = $row['backend'];
056a005c 305
91821fc0 306 /* Check if this user is selected */
19347763 307 $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
056a005c 308
9f6c97c3 309 /* Print one row, with alternating color */
056a005c 310 if ($line % 2) {
9f6c97c3 311 $tr_bgcolor = $color[12];
312 } else {
313 $tr_bgcolor = $color[4];
314 }
7b0ea860 315 echo html_tag( 'tr', '', '', $tr_bgcolor);
316 if ($abook->backends[$row['backend']]->writeable) {
828c58f1 317 $id = $row['backend'].':'.$row['nickname'];
7b0ea860 318 echo html_tag( 'td',
319 '<small>' .
828c58f1 320 addCheckBox("sel[$id]", $selected, $id).
7b0ea860 321 '</small>' ,
322 'center', '', 'valign="top" width="1%"' );
828c58f1 323 $label1 = '<label for="sel_'.$id.'_">'; $label2='</label>';
7b0ea860 324 } else {
325 echo html_tag( 'td',
326 '&nbsp;' ,
327 'center', '', 'valign="top" width="1%"' );
828c58f1 328 $label1 = $label2 = '';
7b0ea860 329 }
5c4ff7bf 330 echo html_tag( 'td',
828c58f1 331 '&nbsp;' . $label1 . htmlspecialchars($row['nickname']) . $label2 . '&nbsp;',
7b0ea860 332 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
333
35235328 334 echo html_tag( 'td',
828c58f1 335 '&nbsp;' . $label1 . htmlspecialchars($row['name']) . $label2 . '&nbsp;',
35235328 336 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' );
7b0ea860 337
338 // email address column
339 echo html_tag( 'td', '', 'left', '', 'valign="top" width="1%" style="white-space: nowrap;"' ) . '&nbsp;';
3d0cada3 340 $email = $abook->full_address($row);
d62c4938 341 echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
056a005c 342 htmlspecialchars($row['email'])).
7b0ea860 343 '&nbsp;</td>'."\n";
344
345 // info column
346 echo html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' );
347
348 // add extra column if third party backend needs it
349 if ($abook->add_extra_field) {
5c4ff7bf 350 echo html_tag( 'td',
7b0ea860 351 '&nbsp;' . (isset($row['extra']) ? $row['extra'] : '') . '&nbsp;',
352 'left', '', 'valign="top" width="1%"' );
353 }
354 echo "</tr>\n";
91821fc0 355 $line++;
daba719e 356 }
2741cc97 357 echo "</table>" .
056a005c 358 "\n<!-- end of address book table -->\n";
d9879e29 359
fc93f97c 360 /* End of list. Add edit/delete select buttons */
91821fc0 361 if ($headerprinted) {
fc93f97c 362 echo html_tag( 'table',
134e4174 363 html_tag( 'tr',
364 html_tag( 'td',
056a005c 365 addSubmit(_("Edit selected"), 'editaddr') .
366 addSubmit(_("Delete selected"), 'deladdr'),
7b0ea860 367 'center', '', "colspan=\"$abook_fields\"" )
134e4174 368 ),
056a005c 369 'center' );
91821fc0 370 }
fc93f97c 371 echo "</form>\n";
daba719e 372 }
f6c945b9 373} /* end of addresslist */
daba719e 374
375
f6c945b9 376/* Display the "new address" form */
c1ac62d4 377echo '<a name="AddAddress"></a>' . "\n";
378abook_create_form($form_url,'addaddr',_("Add to address book"),_("Add address"),$defdata);
fc93f97c 379echo "</form>\n";
daba719e 380
df4162cb 381/* Hook for extra address book blocks */
8811538c 382echo "<!-- start of addressbook_bottom hook-->\n";
daba719e 383do_hook('addressbook_bottom');
8811538c 384echo "\n<!-- end of addressbook_bottom hook-->\n";
5c4ff7bf 385$oTemplate->display('footer.tpl');
828c58f1 386?>