Source for file addressbook.php

Documentation is available at addressbook.php

  1. <?php
  2.  
  3. /**
  4.  * addressbook.php
  5.  *
  6.  * Manage personal address book.
  7.  *
  8.  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: addressbook.php,v 1.58.2.26 2006/10/07 11:58:42 tokul Exp $
  11.  * @package squirrelmail
  12.  * @subpackage addressbook
  13.  */
  14.  
  15. /**
  16.  * Path for SquirrelMail required files.
  17.  * @ignore
  18.  */
  19. define('SM_PATH','../');
  20.  
  21. /** SquirrelMail required files. */
  22. require_once(SM_PATH . 'include/validate.php');
  23. require_once(SM_PATH . 'functions/global.php');
  24. require_once(SM_PATH . 'functions/display_messages.php');
  25. require_once(SM_PATH . 'functions/addressbook.php');
  26. require_once(SM_PATH . 'functions/strings.php');
  27. require_once(SM_PATH . 'functions/html.php');
  28. require_once(SM_PATH . 'functions/forms.php');
  29.  
  30. /** lets get the global vars we may need */
  31. sqgetGlobalVar('key',       $key,           SQ_COOKIE);
  32.  
  33. sqgetGlobalVar('username',  $username,      SQ_SESSION);
  34. sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);
  35. sqgetGlobalVar('base_uri',  $base_uri,      SQ_SESSION);
  36. sqgetGlobalVar('delimiter', $delimiter,     SQ_SESSION);
  37.  
  38. /* From the address form */
  39. sqgetGlobalVar('addaddr',   $addaddr,   SQ_POST);
  40. sqgetGlobalVar('editaddr',  $editaddr,  SQ_POST);
  41. sqgetGlobalVar('deladdr',   $deladdr,   SQ_POST);
  42. sqgetGlobalVar('sel',       $sel,       SQ_POST);
  43. sqgetGlobalVar('oldnick',   $oldnick,   SQ_POST);
  44. sqgetGlobalVar('backend',   $backend,   SQ_POST);
  45. sqgetGlobalVar('doedit',    $doedit,    SQ_POST);
  46.  
  47. /* Get sorting order */
  48. $abook_sort_order = get_abook_sort();
  49.  
  50. /**
  51.  * Make an input field
  52.  * @param string $label 
  53.  * @param string $field 
  54.  * @param string $name 
  55.  * @param string $size 
  56.  * @param array $values 
  57.  * @param string $add 
  58.  */
  59. function addressbook_inp_field($label, $field, $name, $size, $values, $add) {
  60.     global $color;
  61.     $value = ( isset($values[$field]) ? $values[$field] : '');
  62.  
  63.     $td_str = addInput($name.'['.$field.']', $value, $size)
  64.         . $add ;
  65.  
  66.     return html_tag( 'tr' ,
  67.             html_tag( 'td', $label . ':', 'right', $color[4]) .
  68.             html_tag( 'td', $td_str, 'left', $color[4])
  69.             )
  70.         . "\n";
  71. }
  72.  
  73. /**
  74.  * Output form to add and modify address data
  75.  */
  76. function address_form($name, $submittext, $values = array()) {
  77.     global $color, $squirrelmail_language;
  78.  
  79.     if ($squirrelmail_language == 'ja_JP') {
  80.         echo html_tag( 'table',
  81.                 addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
  82.                     ' <small>' . _("Must be unique") . '</small>') .
  83.                 addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
  84.                 addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
  85.                 addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
  86.                 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
  87.                 list_writable_backends($name) .
  88.                 html_tag( 'tr',
  89.                     html_tag( 'td',
  90.                         addSubmit($submittext, $name.'[SUBMIT]'),
  91.                         'center', $color[4], 'colspan="2"')
  92.                     )
  93.                 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
  94.     } else {
  95.         echo html_tag( 'table',
  96.                 addressbook_inp_field(_("Nickname"),     'nickname', $name, 15, $values,
  97.                     ' <small>' . _("Must be unique") . '</small>') .
  98.                 addressbook_inp_field(_("E-mail address"),  'email', $name, 45, $values, '') .
  99.                 addressbook_inp_field(_("First name"),  'firstname', $name, 45, $values, '') .
  100.                 addressbook_inp_field(_("Last name"),    'lastname', $name, 45, $values, '') .
  101.                 addressbook_inp_field(_("Additional info"), 'label', $name, 45, $values, '') .
  102.                 list_writable_backends($name) .
  103.                 html_tag( 'tr',
  104.                     html_tag( 'td',
  105.                         addSubmit($submittext, $name.'[SUBMIT]') ,
  106.                         'center', $color[4], 'colspan="2"')
  107.                     )
  108.                 , 'center', '', 'border="0" cellpadding="1" width="90%"') ."\n";
  109.     }
  110. }
  111.  
  112.  
  113. /**
  114.  * Provides list of writeable backends.
  115.  * Works only when address is added ($name='addaddr')
  116.  * @param string $name name of form
  117.  * @return string html formated backend field (select or hidden)
  118.  */
  119. function list_writable_backends($name) {
  120.     global $color, $abook;
  121.     if ( $name != 'addaddr' ) { return; }
  122.     $writeable_abook = 1;
  123.     if ( $abook->numbackends > 1 ) {
  124.         $backends = $abook->get_backend_list();
  125.         $writeable_abooks=array();
  126.         while (list($undef,$v) = each($backends)) {
  127.             if ($v->writeable) {
  128.                 // add each backend to array
  129.                 $writeable_abooks[$v->bnum]=$v->sname;
  130.                 // save backend number
  131.                 $writeable_abook=$v->bnum;
  132.             }
  133.         }
  134.         if (count($writeable_abooks)>1) {
  135.             // we have more than one writeable backend
  136.             $ret=addSelect('backend',$writeable_abooks,null,true);
  137.             return html_tag( 'tr',
  138.                              html_tag( 'td', _("Add to:"),'right', $color[4] ) .
  139.                              html_tag( 'td', $ret, 'left', $color[4] )) . "\n";
  140.         }
  141.     }
  142.     // Only one backend exists or is writeable.
  143.     return html_tag( 'tr',
  144.                      html_tag( 'td',
  145.                                addHidden('backend', $writeable_abook),
  146.                                'center', $color[4], 'colspan="2"')) . "\n";
  147. }
  148.  
  149. /* Create page header before addressbook_init in order to  display error messages correctly. */
  150. displayPageHeader($color, 'None');
  151.  
  152. /* Open addressbook, with error messages on but without LDAP (the *
  153.  * second "true"). Don't need LDAP here anyway                    */
  154. $abook = addressbook_init(true, true);
  155. if($abook->localbackend == 0) {
  156.     plain_error_message(
  157.             _("No personal address book is defined. Contact administrator."),
  158.             $color);
  159.     exit();
  160. }
  161.  
  162. $defdata   = array();
  163. $formerror = '';
  164. $abortform = false;
  165. $showaddrlist = true;
  166. $defselected  = array();
  167. $form_url = 'addressbook.php';
  168.  
  169.  
  170. /* Handle user's actions */
  171. if(sqgetGlobalVar('REQUEST_METHOD', $req_method, SQ_SERVER) && $req_method == 'POST') {
  172.  
  173.     /************************************************
  174.      * Add new address                                *
  175.      **************************************************/
  176.  
  177.     if (isset($addaddr)) {
  178.         if (isset($backend)) {
  179.             $r = $abook->add($addaddr, $backend);
  180.         } else {
  181.             $r = $abook->add($addaddr, $abook->localbackend);
  182.         }
  183.  
  184.         /* Handle error messages */
  185.         if (!$r) {
  186.             /* Remove backend name from error string */
  187.             $errstr = $abook->error;
  188.             $errstr = ereg_replace('^\[.*\] *', '', $errstr);
  189.  
  190.             $formerror = $errstr;
  191.             $showaddrlist = false;
  192.             $defdata = $addaddr;
  193.         }
  194.     } else {
  195.  
  196.         /**********************************************
  197.          * Delete address(es)                           *
  198.          ************************************************/
  199.  
  200.         if ((!empty($deladdr)) && sizeof($sel) > 0) {
  201.             $orig_sel = $sel;
  202.             sort($sel);
  203.  
  204.             /* The selected addresses are identidied by "backend:nickname". *
  205.              * Sort the list and process one backend at the time            */
  206.             $prevback  = -1;
  207.             $subsel    = array();
  208.             $delfailed = false;
  209.  
  210.             for ($i = 0 ; (($i < sizeof($sel)) && !$delfailed) ; $i++) {
  211.                 list($sbackend, $snick) = explode(':', $sel[$i]);
  212.  
  213.                 /* When we get to a new backend, process addresses in *
  214.                  * previous one.                                      */
  215.                 if ($prevback != $sbackend && $prevback != -1) {
  216.  
  217.                     $r = $abook->remove($subsel, $prevback);
  218.                     if (!$r) {
  219.                         $formerror = $abook->error;
  220.                         $i = sizeof($sel);
  221.                         $delfailed = true;
  222.                         break;
  223.                     }
  224.                     $subsel   = array();
  225.                 }
  226.  
  227.                 /* Queue for processing */
  228.                 array_push($subsel, $snick);
  229.                 $prevback = $sbackend;
  230.             }
  231.  
  232.             if (!$delfailed) {
  233.                 $r = $abook->remove($subsel, $prevback);
  234.                 if (!$r) { /* Handle errors */
  235.                     $formerror = $abook->error;
  236.                     $delfailed = true;
  237.                 }
  238.             }
  239.  
  240.             if ($delfailed) {
  241.                 $showaddrlist = true;
  242.                 $defselected  = $orig_sel;
  243.             }
  244.  
  245.         } else {
  246.  
  247.             /*********************************************
  248.              * Update/modify address                       *
  249.              ***********************************************/
  250.  
  251.             if (!empty($editaddr)) {
  252.  
  253.                 /* Stage one: Copy data into form */
  254.                 if (isset($sel) && sizeof($sel) > 0) {
  255.                     if(sizeof($sel) > 1) {
  256.                         $formerror = _("You can only edit one address at the time");
  257.                         $showaddrlist = true;
  258.                         $defselected = $sel;
  259.                     } else {
  260.                         $abortform = true;
  261.                         list($ebackend, $enick) = explode(':', $sel[0]);
  262.                         $olddata = $abook->lookup($enick, $ebackend);
  263.  
  264.                         /* Display the "new address" form */
  265.                         echo addForm($form_url, 'post').
  266.                             html_tag( 'table',
  267.                                     html_tag( 'tr',
  268.                                         html_tag( 'td',
  269.                                             "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
  270.                                             'center', $color[0] )
  271.                                         ),
  272.                                     'center', '', 'width="100%" ' );
  273.                         address_form("editaddr", _("Update address"), $olddata);
  274.                         echo addHidden('oldnick', $olddata['nickname']).
  275.                             addHidden('backend', $olddata['backend']).
  276.                             addHidden('doedit', '1').
  277.                             '</form>';
  278.                     }
  279.                 } elseif ($doedit == 1) {
  280.                     /* Stage two: Write new data */
  281.                     $newdata = $editaddr;
  282.                     $r = $abook->modify($oldnick, $newdata, $backend);
  283.  
  284.                     /* Handle error messages */
  285.                     if (!$r) {
  286.                         /* Display error */
  287.                         echo html_tag( 'table',
  288.                                  html_tag( 'tr',
  289.                                      html_tag( 'td',
  290.                                                "\n". '<strong><font color="' . $color[2] .
  291.                                                '">' . _("ERROR") . ': ' . htmlspecialchars($abook->error) . '</font></strong>' ."\n",
  292.                                                'center' )
  293.                                            ),
  294.                                        'center', '', 'width="100%"' );
  295.  
  296.                         /* Display the "new address" form again */
  297.                         echo addForm($form_url, 'post').
  298.                             html_tag( 'table',
  299.                                 html_tag( 'tr',
  300.                                     html_tag( 'td',
  301.                                               "\n". '<strong>' . _("Update address") . '</strong>' ."\n",
  302.                                               'center', $color[0] )
  303.                                           ),
  304.                                       'center', '', 'width="100%"' );
  305.                         address_form("editaddr", _("Update address"), $newdata);
  306.                         echo 
  307.                             addHidden('oldnick', $oldnick).
  308.                             addHidden('backend', $backend).
  309.                             addHidden('doedit',  '1').
  310.                             "\n" . '</form>';
  311.                         $abortform = true;
  312.                     }
  313.                 } else {
  314.                     /**
  315.                      * $editaddr is set, but $sel (address selection in address listing)
  316.                      * and $doedit (address edit form) are not set.
  317.                      * Assume that user clicked on "Edit address" without selecting any address.
  318.                      */
  319.                     $formerror = _("Please select address that you want to edit");
  320.                     $showaddrlist = true;
  321.                 } /* end of edit stage detection */
  322.             } /* !empty($editaddr)                  - Update/modify address */
  323.         } /* (!empty($deladdr)) && sizeof($sel) > 0 - Delete address(es) */
  324.     } /* !empty($addaddr['nickname'])               - Add new address */
  325.  
  326.     // Some times we end output before forms are printed
  327.         if($abortform) {
  328.         echo "</body></html>\n";
  329.         exit();
  330.     }
  331. }
  332.  
  333.  
  334. /* =================================================================== *
  335.  * The following is only executed on a GET request, or on a POST when  *
  336.  * a user is added, or when "delete" or "modify" was successful.       *
  337.  * =================================================================== */
  338.  
  339. /* Display error messages */
  340. if (!empty($formerror)) {
  341.     echo html_tag( 'table',
  342.             html_tag( 'tr',
  343.                 html_tag( 'td',
  344.                     "\n". '<br /><strong><font color="' . $color[2] .
  345.                     '">' . _("ERROR") . ': ' . htmlspecialchars($formerror) . '</font></strong>' ."\n",
  346.                     'center' )
  347.                 ),
  348.             'center', '', 'width="100%"' );
  349. }
  350.  
  351.  
  352. /* Display the address management part */
  353. if ($showaddrlist) {
  354.     /* Get and sort address list */
  355.     $alist = $abook->list_addr();
  356.     if(!is_array($alist)) {
  357.         $abook->error = htmlspecialchars($abook->error);
  358.         plain_error_message($abook->error, $color);
  359.         exit;
  360.     }
  361.  
  362.     usort($alist,'alistcmp');
  363.     $prevbackend = -1;
  364.     $headerprinted = false;
  365.  
  366.     echo html_tag( 'p', '<a href="#AddAddress">' . _("Add address") . '</a>', 'center' ) . "\n";
  367.  
  368.     /* List addresses */
  369.     if (count($alist) > 0) {
  370.         echo addForm($form_url, 'post');
  371.         if ($abook->add_extra_field) {
  372.             $abook_fields = 6;
  373.         } else {
  374.             $abook_fields = 5;
  375.         }
  376.         while(list($undef,$row) = each($alist)) {
  377.  
  378.             /* New table header for each backend */
  379.             if($prevbackend != $row['backend']) {
  380.                 if($prevbackend < 0) {
  381.                     echo html_tag( 'table',
  382.                             html_tag( 'tr',
  383.                                 html_tag( 'td',
  384.                                     addSubmit(_("Edit selected"), 'editaddr').
  385.                                     addSubmit(_("Delete selected"), 'deladdr'),
  386.                                     'center', '', "colspan=\"$abook_fields\"" )
  387.                                 ) .
  388.                             html_tag( 'tr',
  389.                                 html_tag( 'td', '&nbsp;<br />', 'center', '', 'colspan="5"' )
  390.                                 ),
  391.                             'center' );
  392.                 }
  393.  
  394.                 echo html_tag( 'table',
  395.                         html_tag( 'tr',
  396.                             html_tag( 'td', "\n" . '<strong>' . $row['source'] . '</strong>' . "\n", 'center', $color[0] )
  397.                             ),
  398.                         'center', '', 'width="95%"' ) ."\n".
  399.                     html_tag( 'table', '', 'center', '', 'border="0" cellpadding="1" cellspacing="0" width="90%"' ) .
  400.                     html_tag( 'tr', "\n" .
  401.                             html_tag( 'th', '&nbsp;', 'left', '', 'width="1%"' ) .
  402.                             html_tag( 'th', _("Nickname") . 
  403.                                       show_abook_sort_button($abook_sort_order, _("sort by nickname"), 0, 1),
  404.                                       'left', '', 'width="1%"' ) .
  405.                             html_tag( 'th', _("Name") .
  406.                                       show_abook_sort_button($abook_sort_order, _("sort by name"), 2, 3),
  407.                                       'left', '', 'width="1%"' ) .
  408.                             html_tag( 'th', _("E-mail").
  409.                                       show_abook_sort_button($abook_sort_order, _("sort by email"), 4, 5),
  410.                                       'left', '', 'width="1%"' ) .
  411.                             html_tag( 'th', _("Info").
  412.                                       show_abook_sort_button($abook_sort_order, _("sort by info"), 6, 7),
  413.                                       'left', '', 'width="1%"' ) .
  414.                             ($abook->add_extra_field ? html_tag( 'th', '&nbsp;','left', '', 'width="1%"'): ''),
  415.                             '', $color[9] ) . "\n";
  416.  
  417.                 $line = 0;
  418.                 $headerprinted = true;
  419.             } /* End of header */
  420.  
  421.             $prevbackend = $row['backend'];
  422.  
  423.             /* Check if this user is selected */
  424.             $selected = in_array($row['backend'] . ':' . $row['nickname'], $defselected);
  425.  
  426.             /* Print one row, with alternating color */
  427.             if ($line % 2) {
  428.                 $tr_bgcolor = $color[12];
  429.             } else {
  430.                 $tr_bgcolor = $color[4];
  431.             }
  432.             if ($squirrelmail_language == 'ja_JP') {
  433.                 echo html_tag( 'tr', '', '', $tr_bgcolor);
  434.                 if ($abook->backends[$row['backend']]->writeable) {
  435.                     echo html_tag( 'td',
  436.                             '<small>' .
  437.                             addCheckBox('sel[]', $selected, $row['backend'].':'.$row['nickname']).
  438.                             '</small>' ,
  439.                             'center', '', 'valign="top" width="1%"' );
  440.                 } else {
  441.                     echo html_tag( 'td',
  442.                             '&nbsp;' ,
  443.                             'center', '', 'valign="top" width="1%"' );
  444.                 }
  445.                 echo html_tag( 'td', '&nbsp;' . htmlspecialchars($row['nickname']) . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) . 
  446.                     html_tag( 'td', '&nbsp;' . htmlspecialchars($row['lastname']) . ' ' . htmlspecialchars($row['firstname']) . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
  447.                     html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . '&nbsp;';
  448.             } else {
  449.                 echo html_tag( 'tr', '', '', $tr_bgcolor);
  450.                 if ($abook->backends[$row['backend']]->writeable) {
  451.                     echo html_tag( 'td',
  452.                             '<small>' .
  453.                             addCheckBox('sel[]', $selected, $row['backend'] . ':' . $row['nickname']).
  454.                             '</small>' ,
  455.                             'center', '', 'valign="top" width="1%"' );
  456.                 } else {
  457.                     echo html_tag( 'td',
  458.                             '&nbsp;' ,
  459.                             'center', '', 'valign="top" width="1%"' );
  460.                 }
  461.                 echo html_tag( 'td', '&nbsp;' . htmlspecialchars($row['nickname']) . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
  462.                     html_tag( 'td', '&nbsp;' . htmlspecialchars($row['name']) . '&nbsp;', 'left', '', 'valign="top" width="1%" nowrap' ) .
  463.                     html_tag( 'td', '', 'left', '', 'valign="top" width="1%" nowrap' ) . '&nbsp;';
  464.             }
  465.             $email = $abook->full_address($row);
  466.             echo makeComposeLink('src/compose.php?send_to='.rawurlencode($email),
  467.                     htmlspecialchars($row['email'])).
  468.                 '&nbsp;</td>'."\n".
  469.                 html_tag( 'td', '&nbsp;' . htmlspecialchars($row['label']) . '&nbsp;', 'left', '', 'valign="top" width="1%"' );
  470.  
  471.             // add extra column if third party backend needs it
  472.                         if ($abook->add_extra_field) {
  473.                 echo html_tag( 'td',
  474.                                '&nbsp;' . (isset($row['extra']) ? $row['extra'] : '') . '&nbsp;',
  475.                                'left', '', 'valign="top" width="1%"' );
  476.             }
  477.  
  478.             echo "</tr>\n";
  479.             $line++;
  480.         }
  481.  
  482.         /* End of list. Close table. */
  483.         if ($headerprinted) {
  484.             echo html_tag( 'tr',
  485.                     html_tag( 'td',
  486.                         addSubmit(_("Edit selected"), 'editaddr') .
  487.                         addSubmit(_("Delete selected"), 'deladdr'),
  488.                         'center', '', "colspan=\"$abook_fields\"" )
  489.                     );
  490.         }
  491.         echo '</table></form>';
  492.     }
  493. } /* end of addresslist */
  494.  
  495.  
  496. /* Display the "new address" form */
  497. echo '<a name="AddAddress"></a>' . "\n" .
  498.     addForm($form_url, 'post', 'f_add').
  499.     html_tag( 'table',  
  500.         html_tag( 'tr',
  501.             html_tag( 'td', "\n". '<strong>' . sprintf(_("Add to %s"), $abook->localbackendname) . '</strong>' . "\n",
  502.                 'center', $color[0]
  503.                 )
  504.             )
  505.         , 'center', '', 'width="95%"' ) ."\n";
  506. address_form('addaddr', _("Add address"), $defdata);
  507. echo "</form>\n";
  508.  
  509. /* Add hook for anything that wants on the bottom */
  510. do_hook('addressbook_bottom');
  511. ?>
  512. </body></html>

Documentation generated on Sat, 07 Oct 2006 16:29:51 +0300 by phpDocumentor 1.3.0RC6