functions/abook_local_file.php

   1 <?php
   2
   3 /**
   4  * abook_local_file.php
   5  *
   6  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
   7  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   8  * @version $Id$
   9  * @package squirrelmail
  10  * @subpackage addressbook
  11  */
  12
  13 /**
  14  * Backend for address book as a pipe separated file
  15  *
  16  * Stores the address book in a local file
  17  *
  18  * An array with the following elements must be passed to
  19  * the class constructor (elements marked ? are optional):
  20  *<pre>
  21  *   filename  => path to addressbook file
  22  * ? create    => if true: file is created if it does not exist.
  23  * ? umask     => umask set before opening file.
  24  * ? name      => name of address book.
  25  * ? detect_writeable => detect address book access permissions by
  26  *                checking file permissions.
  27  * ? writeable => allow writing into address book. Used only when
  28  *                detect_writeable is set to false.
  29  * ? listing   => enable/disable listing
  30  *</pre>
  31  * NOTE. This class should not be used directly. Use the
  32  *       "AddressBook" class instead.
  33  * @package squirrelmail
  34  */
  35 class abook_local_file extends addressbook_backend {
  36     /**
  37      * Backend type
  38      * @var string
  39      */
  40     var $btype = 'local';
  41     /**
  42      * Backend name
  43      * @var string
  44      */
  45     var $bname = 'local_file';
  46
  47     /**
  48      * File used to store data
  49      * @var string
  50      */
  51     var $filename = '';
  52     /**
  53      * File handle
  54      * @var object
  55      */
  56     var $filehandle = 0;
  57     /**
  58      * Create file, if it not present
  59      * @var bool
  60      */
  61     var $create = false;
  62     /**
  63      * Detect, if address book is writeable by checking file permisions
  64      * @var bool
  65      */
  66     var $detect_writeable   = true;
  67     /**
  68      * Control write access to address book
  69      *
  70      * Option does not have any effect, if 'detect_writeable' is 'true'
  71      * @var bool
  72      */
  73     var $writeable = false;
  74     /**
  75      * controls listing of address book
  76      * @var bool
  77      */
  78     var $listing = true;
  79     /**
  80      * Umask of the file
  81      * @var string
  82      */
  83     var $umask;
  84     /**
  85      * Sets max entry size (number of bytes used for all address book fields
  86      * (including escapes) + 4 delimiters + 1 linefeed)
  87      * @var integer
  88      * @since 1.5.2
  89      */
  90     var $line_length = 2048;
  91
  92     /* ========================== Private ======================= */
  93
  94     /**
  95      * Constructor
  96      * @param array $param backend options
  97      * @return bool
  98      */
  99     function abook_local_file($param) {
 100         $this->sname = _("Personal Address Book");
 101         $this->umask = Umask();
 102
 103         if(is_array($param)) {
 104             if(empty($param['filename'])) {
 105                 return $this->set_error('Invalid parameters');
 106             }
 107             if(!is_string($param['filename'])) {
 108                 return $this->set_error($param['filename'] . ': '.
 109                      _("Not a file name"));
 110             }
 111
 112             $this->filename = $param['filename'];
 113
 114             if(isset($param['create'])) {
 115                 $this->create = $param['create'];
 116             }
 117             if(isset($param['umask'])) {
 118                 $this->umask = $param['umask'];
 119             }
 120             if(isset($param['name'])) {
 121                 $this->sname = $param['name'];
 122             }
 123             if(isset($param['detect_writeable'])) {
 124                 $this->detect_writeable = $param['detect_writeable'];
 125             }
 126             if(!empty($param['writeable'])) {
 127                 $this->writeable = $param['writeable'];
 128             }
 129             if(isset($param['listing'])) {
 130                 $this->listing = $param['listing'];
 131             }
 132             if(isset($param['line_length']) && ! empty($param['line_length'])) {
 133                 $this->line_length = (int) $param['line_length'];
 134             }
 135
 136             $this->open(true);
 137         } else {
 138             $this->set_error('Invalid argument to constructor');
 139         }
 140     }
 141
 142     /**
 143      * Open the addressbook file and store the file pointer.
 144      * Use $file as the file to open, or the class' own
 145      * filename property. If $param is empty and file is
 146      * open, do nothing.
 147      * @param bool $new is file already opened
 148      * @return bool
 149      */
 150     function open($new = false) {
 151         $this->error = '';
 152         $file   = $this->filename;
 153         $create = $this->create;
 154         $fopenmode = (($this->writeable && sq_is_writable($file)) ? 'a+' : 'r');
 155
 156         /* Return true is file is open and $new is unset */
 157         if($this->filehandle && !$new) {
 158             return true;
 159         }
 160
 161         /* Check that new file exitsts */
 162         if((!(file_exists($file) && is_readable($file))) && !$create) {
 163             return $this->set_error("$file: " . _("No such file or directory"));
 164         }
 165
 166         /* Close old file, if any */
 167         if($this->filehandle) { $this->close(); }
 168
 169         umask($this->umask);
 170         if (! $this->detect_writeable) {
 171             $fh = @fopen($file,$fopenmode);
 172             if ($fh) {
 173                 $this->filehandle = &$fh;
 174                 $this->filename = $file;
 175             } else {
 176                 return $this->set_error("$file: " . _("Open failed"));
 177             }
 178         } else {
 179             /* Open file. First try to open for reading and writing,
 180              * but fall back to read only. */
 181             $fh = @fopen($file, 'a+');
 182             if($fh) {
 183                 $this->filehandle = &$fh;
 184                 $this->filename   = $file;
 185                 $this->writeable  = true;
 186             } else {
 187                 $fh = @fopen($file, 'r');
 188                 if($fh) {
 189                     $this->filehandle = &$fh;
 190                     $this->filename   = $file;
 191                     $this->writeable  = false;
 192                 } else {
 193                     return $this->set_error("$file: " . _("Open failed"));
 194                 }
 195             }
 196         }
 197         return true;
 198     }
 199
 200     /** Close the file and forget the filehandle */
 201     function close() {
 202         @fclose($this->filehandle);
 203         $this->filehandle = 0;
 204         $this->filename   = '';
 205         $this->writable   = false;
 206     }
 207
 208     /** Lock the datafile - try 20 times in 5 seconds */
 209     function lock() {
 210         for($i = 0 ; $i < 20 ; $i++) {
 211             if(flock($this->filehandle, 2 + 4))
 212                 return true;
 213             else
 214                 usleep(250000);
 215         }
 216         return false;
 217     }
 218
 219     /** Unlock the datafile */
 220     function unlock() {
 221         return flock($this->filehandle, 3);
 222     }
 223
 224     /**
 225      * Overwrite the file with data from $rows
 226      * NOTE! Previous locks are broken by this function
 227      * @param array $rows new data
 228      * @return bool
 229      */
 230     function overwrite(&$rows) {
 231         $this->unlock();
 232         $newfh = @fopen($this->filename.'.tmp', 'w');
 233
 234         if(!$newfh) {
 235             return $this->set_error($this->filename. '.tmp:' . _("Open failed"));
 236         }
 237
 238         for($i = 0, $cnt=sizeof($rows) ; $i < $cnt ; $i++) {
 239             if(is_array($rows[$i])) {
 240                 for($j = 0, $cnt_part=count($rows[$i]) ; $j < $cnt_part ; $j++) {
 241                     $rows[$i][$j] = $this->quotevalue($rows[$i][$j]);
 242                 }
 243                 $tmpwrite = sq_fwrite($newfh, join('|', $rows[$i]) . "\n");
 244                 if ($tmpwrite === FALSE) {
 245                     return $this->set_error($this->filename . '.tmp:' . _("Write failed"));
 246                 }
 247             }
 248         }
 249
 250         fclose($newfh);
 251         if (!@copy($this->filename . '.tmp' , $this->filename)) {
 252           return $this->set_error($this->filename . ':' . _("Unable to update"));
 253         }
 254         @unlink($this->filename . '.tmp');
 255         $this->unlock();
 256         $this->open(true);
 257         return true;
 258     }
 259
 260     /* ========================== Public ======================== */
 261
 262     /**
 263      * Search the file
 264      * @param string $expr search expression
 265      * @return array search results
 266      */
 267     function search($expr) {
 268
 269         /* To be replaced by advanded search expression parsing */
 270         if(is_array($expr)) { return; }
 271
 272         // don't allow wide search when listing is disabled.
 273         if ($expr=='*' && ! $this->listing)
 274             return array();
 275
 276         /* Make regexp from glob'ed expression
 277          * May want to quote other special characters like (, ), -, [, ], etc. */
 278         $expr = str_replace('?', '.', $expr);
 279         $expr = str_replace('*', '.*', $expr);
 280
 281         $res = array();
 282         if(!$this->open()) {
 283             return false;
 284         }
 285         @rewind($this->filehandle);
 286
 287         while ($row = @fgetcsv($this->filehandle, $this->line_length, '|')) {
 288             if (count($row)<5) {
 289                 /**
 290                  * address book is corrupted.
 291                  */
 292                 global $oTemplate;
 293                 error_box(_("Address book is corrupted. Required fields are missing."));
 294                 $oTemplate->display('footer.tpl');
 295                 die();
 296             } else {
 297                 $line = join(' ', $row);
 298                 /**
 299                  * TODO: regexp search is supported only in local_file backend.
 300                  * Do we check format of regexp or ignore errors?
 301                  */
 302                 // errors on eregi call are suppressed in order to prevent display of regexp compilation errors
 303                 if(@eregi($expr, $line)) {
 304                     array_push($res, array('nickname'  => $row[0],
 305                         'name'      => $this->fullname($row[1], $row[2]),
 306                         'firstname' => $row[1],
 307                         'lastname'  => $row[2],
 308                         'email'     => $row[3],
 309                         'label'     => $row[4],
 310                         'backend'   => $this->bnum,
 311                         'source'    => &$this->sname));
 312                 }
 313             }
 314         }
 315
 316         return $res;
 317     }
 318
 319     /**
 320      * Lookup an address by the indicated field.
 321      *
 322      * @param string  $value The value to look up
 323      * @param integer $field The field to look in, should be one
 324      *                       of the SM_ABOOK_FIELD_* constants
 325      *                       defined in include/constants.php
 326      *                       (OPTIONAL; defaults to nickname field)
 327      *                       NOTE: uniqueness is only guaranteed
 328      *                       when the nickname field is used here;
 329      *                       otherwise, the first matching address
 330      *                       is returned.
 331      *
 332      * @return array Array with lookup results when the value
 333      *               was found, an empty array if the value was
 334      *               not found.
 335      *
 336      */
 337     function lookup($value, $field=SM_ABOOK_FIELD_NICKNAME) {
 338         if(empty($value)) {
 339             return array();
 340         }
 341
 342         $value = strtolower($value);
 343
 344         $this->open();
 345         @rewind($this->filehandle);
 346
 347         while ($row = @fgetcsv($this->filehandle, $this->line_length, '|')) {
 348             if (count($row)<5) {
 349                 /**
 350                  * address book is corrupted.
 351                  */
 352                 global $oTemplate;
 353                 error_box(_("Address book is corrupted. Required fields are missing."));
 354                 $oTemplate->display('footer.tpl');
 355                 die();
 356             } else {
 357                 if(strtolower($row[$field]) == $value) {
 358                    return array('nickname'  => $row[0],
 359                       'name'      => $this->fullname($row[1], $row[2]),
 360                       'firstname' => $row[1],
 361                       'lastname'  => $row[2],
 362                       'email'     => $row[3],
 363                       'label'     => $row[4],
 364                       'backend'   => $this->bnum,
 365                       'source'    => &$this->sname);
 366                 }
 367             }
 368         }
 369
 370         return array();
 371     }
 372
 373     /**
 374      * List all addresses
 375      * @return array list of all addresses
 376      */
 377     function list_addr() {
 378         $res = array();
 379
 380         if(isset($this->listing) && !$this->listing) {
 381             return array();
 382         }
 383
 384         $this->open();
 385         @rewind($this->filehandle);
 386
 387         while ($row = @fgetcsv($this->filehandle, $this->line_length, '|')) {
 388             if (count($row)<5) {
 389                 /**
 390                  * address book is corrupted. Don't be nice to people that
 391                  * violate address book formating.
 392                  */
 393                 global $oTemplate;
 394                 error_box(_("Address book is corrupted. Required fields are missing."));
 395                 $oTemplate->display('footer.tpl');
 396                 die();
 397             } else {
 398                 array_push($res, array('nickname'  => $row[0],
 399                     'name'      => $this->fullname($row[1], $row[2]),
 400                     'firstname' => $row[1],
 401                     'lastname'  => $row[2],
 402                     'email'     => $row[3],
 403                     'label'     => $row[4],
 404                     'backend'   => $this->bnum,
 405                     'source'    => &$this->sname));
 406             }
 407         }
 408         return $res;
 409     }
 410
 411     /**
 412      * Add address
 413      * @param array $userdata new data
 414      * @return bool
 415      */
 416     function add($userdata) {
 417         if(!$this->writeable) {
 418             return $this->set_error(_("Address book is read-only"));
 419         }
 420         /* See if user exists already */
 421         $ret = $this->lookup($userdata['nickname']);
 422         if(!empty($ret)) {
 423             // i18n: don't use html formating in translation
 424             return $this->set_error(sprintf(_("User \"%s\" already exists"),$ret['nickname']));
 425         }
 426
 427         /* Here is the data to write */
 428         $data = $this->quotevalue($userdata['nickname']) . '|' .
 429                 $this->quotevalue($userdata['firstname']) . '|' .
 430                 $this->quotevalue((!empty($userdata['lastname'])?$userdata['lastname']:'')) . '|' .
 431                 $this->quotevalue($userdata['email']) . '|' .
 432                 $this->quotevalue((!empty($userdata['label'])?$userdata['label']:''));
 433
 434         /* Strip linefeeds */
 435         $data = ereg_replace("[\r\n]", ' ', $data);
 436
 437         /**
 438          * Make sure that entry fits into allocated record space.
 439          * One byte is reserved for linefeed
 440          */
 441         if (strlen($data) >= $this->line_length) {
 442             return $this->set_error(_("Address book entry is too big"));
 443         }
 444
 445         /* Add linefeed at end */
 446         $data = $data . "\n";
 447
 448         /* Reopen file, just to be sure */
 449         $this->open(true);
 450         if(!$this->writeable) {
 451             return $this->set_error(_("Address book is read-only"));
 452         }
 453
 454         /* Lock the file */
 455         if(!$this->lock()) {
 456             return $this->set_error(_("Could not lock datafile"));
 457         }
 458
 459         /* Write */
 460         $r = sq_fwrite($this->filehandle, $data);
 461
 462         /* Unlock file */
 463         $this->unlock();
 464
 465         /* Test write result */
 466         if($r === FALSE) {
 467             /* Fail */
 468             $this->set_error(_("Write to address book failed"));
 469             return FALSE;
 470         }
 471
 472         return TRUE;
 473     }
 474
 475     /**
 476      * Delete address
 477      * @param string $alias alias that has to be deleted
 478      * @return bool
 479      */
 480     function remove($alias) {
 481         if(!$this->writeable) {
 482             return $this->set_error(_("Address book is read-only"));
 483         }
 484
 485         /* Lock the file to make sure we're the only process working
 486          * on it. */
 487         if(!$this->lock()) {
 488             return $this->set_error(_("Could not lock datafile"));
 489         }
 490
 491         /* Read file into memory, ignoring nicknames to delete */
 492         @rewind($this->filehandle);
 493         $i = 0;
 494         $rows = array();
 495         while($row = @fgetcsv($this->filehandle, $this->line_length, '|')) {
 496             if(!in_array($row[0], $alias)) {
 497                 $rows[$i++] = $row;
 498             }
 499         }
 500
 501         /* Write data back */
 502         if(!$this->overwrite($rows)) {
 503             $this->unlock();
 504             return false;
 505         }
 506
 507         $this->unlock();
 508         return true;
 509     }
 510
 511     /**
 512      * Modify address
 513      * @param string $alias modified alias
 514      * @param array $userdata new data
 515      * @return bool true, if operation successful
 516      */
 517     function modify($alias, $userdata) {
 518         if(!$this->writeable) {
 519             return $this->set_error(_("Address book is read-only"));
 520         }
 521
 522         /* See if user exists */
 523         $ret = $this->lookup($alias);
 524         if(empty($ret)) {
 525             // i18n: don't use html formating in translation
 526             return $this->set_error(sprintf(_("User \"%s\" does not exist"),$alias));
 527         }
 528
 529         /* If the alias changed, see if the new alias exists */
 530         if (strtolower($alias) != strtolower($userdata['nickname'])) {
 531             $ret = $this->lookup($userdata['nickname']);
 532             if (!empty($ret)) {
 533                 return $this->set_error(sprintf(_("User \"%s\" already exists"), $userdata['nickname']));
 534             }
 535         }
 536
 537         /* Lock the file to make sure we're the only process working
 538          * on it. */
 539         if(!$this->lock()) {
 540             return $this->set_error(_("Could not lock datafile"));
 541         }
 542
 543         /* calculate userdata size */
 544         $data = $this->quotevalue($userdata['nickname']) . '|'
 545             . $this->quotevalue($userdata['firstname']) . '|'
 546             . $this->quotevalue((!empty($userdata['lastname'])?$userdata['lastname']:'')) . '|'
 547             . $this->quotevalue($userdata['email']) . '|'
 548             . $this->quotevalue((!empty($userdata['label'])?$userdata['label']:''));
 549         /* make sure that it fits into allocated space */
 550         if (strlen($data) >= $this->line_length) {
 551             return $this->set_error(_("Address book entry is too big"));
 552         }
 553
 554         /* Read file into memory, modifying the data for the
 555          * user identified by $alias */
 556         $this->open(true);
 557         @rewind($this->filehandle);
 558         $i = 0;
 559         $rows = array();
 560         while($row = @fgetcsv($this->filehandle, $this->line_length, '|')) {
 561             if(strtolower($row[0]) != strtolower($alias)) {
 562                 $rows[$i++] = $row;
 563             } else {
 564                 $rows[$i++] = array(0 => $userdata['nickname'],
 565                                     1 => $userdata['firstname'],
 566                                     2 => (!empty($userdata['lastname'])?$userdata['lastname']:''),
 567                                     3 => $userdata['email'],
 568                                     4 => (!empty($userdata['label'])?$userdata['label']:''));
 569             }
 570         }
 571
 572         /* Write data back */
 573         if(!$this->overwrite($rows)) {
 574             $this->unlock();
 575             return false;
 576         }
 577
 578         $this->unlock();
 579         return true;
 580     }
 581
 582     /**
 583      * Function for quoting values before saving
 584      * @param string $value string that has to be quoted
 585      * @param string quoted string
 586      */
 587     function quotevalue($value) {
 588         /* Quote the field if it contains | or ". Double quotes need to
 589          * be replaced with "" */
 590         if(ereg("[|\"]", $value)) {
 591             $value = '"' . str_replace('"', '""', $value) . '"';
 592         }
 593         return $value;
 594     }
 595 }