functions/abook_local_file.php

   1 <?php
   2 /**
   3  * abook_local_file.php
   4  *
   5  * Copyright (c) 1999-2005 The SquirrelMail Project Team
   6  * Licensed under the GNU GPL. For full terms see the file COPYING.
   7  *
   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     /* ========================== Private ======================= */
  86
  87     /**
  88      * Constructor
  89      * @param array $param backend options
  90      * @return bool
  91      */
  92     function abook_local_file($param) {
  93         $this->sname = _("Personal address book");
  94         $this->umask = Umask();
  95
  96         if(is_array($param)) {
  97             if(empty($param['filename'])) {
  98                 return $this->set_error('Invalid parameters');
  99             }
 100             if(!is_string($param['filename'])) {
 101                 return $this->set_error($param['filename'] . ': '.
 102                      _("Not a file name"));
 103             }
 104
 105             $this->filename = $param['filename'];
 106
 107             if(isset($param['create'])) {
 108                 $this->create = $param['create'];
 109             }
 110             if(isset($param['umask'])) {
 111                 $this->umask = $param['umask'];
 112             }
 113             if(isset($param['name'])) {
 114                 $this->sname = $param['name'];
 115             }
 116             if(isset($param['detect_writeable'])) {
 117                 $this->detect_writeable = $param['detect_writeable'];
 118             }
 119             if(!empty($param['writeable'])) {
 120                 $this->writeable = $param['writeable'];
 121             }
 122             if(isset($param['listing'])) {
 123                 $this->listing = $param['listing'];
 124             }
 125
 126             $this->open(true);
 127         } else {
 128             $this->set_error('Invalid argument to constructor');
 129         }
 130     }
 131
 132     /**
 133      * Open the addressbook file and store the file pointer.
 134      * Use $file as the file to open, or the class' own
 135      * filename property. If $param is empty and file is
 136      * open, do nothing.
 137      * @param bool $new is file already opened
 138      * @return bool
 139      */
 140     function open($new = false) {
 141         $this->error = '';
 142         $file   = $this->filename;
 143         $create = $this->create;
 144         $fopenmode = (($this->writeable && is_writable($file)) ? 'a+' : 'r');
 145
 146         /* Return true is file is open and $new is unset */
 147         if($this->filehandle && !$new) {
 148             return true;
 149         }
 150
 151         /* Check that new file exitsts */
 152         if((!(file_exists($file) && is_readable($file))) && !$create) {
 153             return $this->set_error("$file: " . _("No such file or directory"));
 154         }
 155
 156         /* Close old file, if any */
 157         if($this->filehandle) { $this->close(); }
 158
 159         umask($this->umask);
 160         if (! $this->detect_writeable) {
 161             $fh = @fopen($file,$fopenmode);
 162             if ($fh) {
 163                 $this->filehandle = &$fh;
 164                 $this->filename = $file;
 165             } else {
 166                 return $this->set_error("$file: " . _("Open failed"));
 167             }
 168         } else {
 169             /* Open file. First try to open for reading and writing,
 170              * but fall back to read only. */
 171             $fh = @fopen($file, 'a+');
 172             if($fh) {
 173                 $this->filehandle = &$fh;
 174                 $this->filename   = $file;
 175                 $this->writeable  = true;
 176             } else {
 177                 $fh = @fopen($file, 'r');
 178                 if($fh) {
 179                     $this->filehandle = &$fh;
 180                     $this->filename   = $file;
 181                     $this->writeable  = false;
 182                 } else {
 183                     return $this->set_error("$file: " . _("Open failed"));
 184                 }
 185             }
 186         }
 187         return true;
 188     }
 189
 190     /** Close the file and forget the filehandle */
 191     function close() {
 192         @fclose($this->filehandle);
 193         $this->filehandle = 0;
 194         $this->filename   = '';
 195         $this->writable   = false;
 196     }
 197
 198     /** Lock the datafile - try 20 times in 5 seconds */
 199     function lock() {
 200         for($i = 0 ; $i < 20 ; $i++) {
 201             if(flock($this->filehandle, 2 + 4))
 202                 return true;
 203             else
 204                 usleep(250000);
 205         }
 206         return false;
 207     }
 208
 209     /** Unlock the datafile */
 210     function unlock() {
 211         return flock($this->filehandle, 3);
 212     }
 213
 214     /**
 215      * Overwrite the file with data from $rows
 216      * NOTE! Previous locks are broken by this function
 217      * @param array $rows new data
 218      * @return bool
 219      */
 220     function overwrite(&$rows) {
 221         $this->unlock();
 222         $newfh = @fopen($this->filename.'.tmp', 'w');
 223
 224         if(!$newfh) {
 225             return $this->set_error($this->filename. '.tmp:' . _("Open failed"));
 226         }
 227
 228         for($i = 0, $cnt=sizeof($rows) ; $i < $cnt ; $i++) {
 229             if(is_array($rows[$i])) {
 230                 for($j = 0, $cnt_part=count($rows[$i]) ; $j < $cnt_part ; $j++) {
 231                     $rows[$i][$j] = $this->quotevalue($rows[$i][$j]);
 232                 }
 233                 $tmpwrite = sq_fwrite($newfh, join('|', $rows[$i]) . "\n");
 234                 if ($tmpwrite === FALSE) {
 235                     return $this->set_error($this->filename . '.tmp:' . _("Write failed"));
 236                 }
 237             }
 238         }
 239
 240         fclose($newfh);
 241         if (!@copy($this->filename . '.tmp' , $this->filename)) {
 242           return $this->set_error($this->filename . ':' . _("Unable to update"));
 243         }
 244         @unlink($this->filename . '.tmp');
 245         $this->unlock();
 246         $this->open(true);
 247         return true;
 248     }
 249
 250     /* ========================== Public ======================== */
 251
 252     /**
 253      * Search the file
 254      * @param string $expr search expression
 255      * @return array search results
 256      */
 257     function search($expr) {
 258
 259         /* To be replaced by advanded search expression parsing */
 260         if(is_array($expr)) { return; }
 261
 262         /* Make regexp from glob'ed expression
 263          * May want to quote other special characters like (, ), -, [, ], etc. */
 264         $expr = str_replace('?', '.', $expr);
 265         $expr = str_replace('*', '.*', $expr);
 266
 267         $res = array();
 268         if(!$this->open()) {
 269             return false;
 270         }
 271         @rewind($this->filehandle);
 272
 273         while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
 274             $line = join(' ', $row);
 275             if(eregi($expr, $line)) {
 276                 array_push($res, array('nickname'  => $row[0],
 277                     'name'      => $row[1] . ' ' . $row[2],
 278                     'firstname' => $row[1],
 279                     'lastname'  => $row[2],
 280                     'email'     => $row[3],
 281                     'label'     => $row[4],
 282                     'backend'   => $this->bnum,
 283                     'source'    => &$this->sname));
 284             }
 285         }
 286
 287         return $res;
 288     }
 289
 290     /**
 291      * Lookup alias
 292      * @param string $alias alias
 293      * @return array search results
 294      */
 295     function lookup($alias) {
 296         if(empty($alias)) {
 297             return array();
 298         }
 299
 300         $alias = strtolower($alias);
 301
 302         $this->open();
 303         @rewind($this->filehandle);
 304
 305         while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
 306             if(strtolower($row[0]) == $alias) {
 307                 return array('nickname'  => $row[0],
 308                   'name'      => $row[1] . ' ' . $row[2],
 309                   'firstname' => $row[1],
 310                   'lastname'  => $row[2],
 311                   'email'     => $row[3],
 312                   'label'     => $row[4],
 313                   'backend'   => $this->bnum,
 314                   'source'    => &$this->sname);
 315             }
 316         }
 317
 318         return array();
 319     }
 320
 321     /**
 322      * List all addresses
 323      * @return array list of all addresses
 324      */
 325     function list_addr() {
 326         $res = array();
 327
 328         if(isset($this->listing) && !$this->listing) {
 329             return array();
 330         }
 331
 332         $this->open();
 333         @rewind($this->filehandle);
 334
 335         while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
 336             array_push($res, array('nickname'  => $row[0],
 337                 'name'      => $row[1] . ' ' . $row[2],
 338                 'firstname' => $row[1],
 339                 'lastname'  => $row[2],
 340                 'email'     => $row[3],
 341                 'label'     => $row[4],
 342                 'backend'   => $this->bnum,
 343                 'source'    => &$this->sname));
 344         }
 345         return $res;
 346     }
 347
 348     /**
 349      * Add address
 350      * @param array $userdata new data
 351      * @return bool
 352      */
 353     function add($userdata) {
 354         if(!$this->writeable) {
 355             return $this->set_error(_("Addressbook is read-only"));
 356         }
 357         /* See if user exists already */
 358         $ret = $this->lookup($userdata['nickname']);
 359         if(!empty($ret)) {
 360             return $this->set_error(sprintf(_("User '%s' already exist"),
 361                    $ret['nickname']));
 362         }
 363
 364         /* Here is the data to write */
 365         $data = $this->quotevalue($userdata['nickname']) . '|' .
 366                 $this->quotevalue($userdata['firstname']) . '|' .
 367                 $this->quotevalue($userdata['lastname']) . '|' .
 368                 $this->quotevalue($userdata['email']) . '|' .
 369                 $this->quotevalue($userdata['label']);
 370
 371         /* Strip linefeeds */
 372         $data = ereg_replace("[\r\n]", ' ', $data);
 373         /* Add linefeed at end */
 374         $data = $data . "\n";
 375
 376         /* Reopen file, just to be sure */
 377         $this->open(true);
 378         if(!$this->writeable) {
 379             return $this->set_error(_("Addressbook is read-only"));
 380         }
 381
 382         /* Lock the file */
 383         if(!$this->lock()) {
 384             return $this->set_error(_("Could not lock datafile"));
 385         }
 386
 387         /* Write */
 388         $r = sq_fwrite($this->filehandle, $data);
 389
 390         /* Unlock file */
 391         $this->unlock();
 392
 393         /* Test write result */
 394         if($r === FALSE) {
 395             /* Fail */
 396             $this->set_error(_("Write to addressbook failed"));
 397             return FALSE;
 398         }
 399
 400         return TRUE;
 401     }
 402
 403     /**
 404      * Delete address
 405      * @param string $alias alias that has to be deleted
 406      * @return bool
 407      */
 408     function remove($alias) {
 409         if(!$this->writeable) {
 410             return $this->set_error(_("Addressbook is read-only"));
 411         }
 412
 413         /* Lock the file to make sure we're the only process working
 414          * on it. */
 415         if(!$this->lock()) {
 416             return $this->set_error(_("Could not lock datafile"));
 417         }
 418
 419         /* Read file into memory, ignoring nicknames to delete */
 420         @rewind($this->filehandle);
 421         $i = 0;
 422         $rows = array();
 423         while($row = @fgetcsv($this->filehandle, 2048, '|')) {
 424             if(!in_array($row[0], $alias)) {
 425                 $rows[$i++] = $row;
 426             }
 427         }
 428
 429         /* Write data back */
 430         if(!$this->overwrite($rows)) {
 431             $this->unlock();
 432             return false;
 433         }
 434
 435         $this->unlock();
 436         return true;
 437     }
 438
 439     /**
 440      * Modify address
 441      * @param string $alias modified alias
 442      * @param array $userdata new data
 443      * @return bool true, if operation successful
 444      */
 445     function modify($alias, $userdata) {
 446         if(!$this->writeable) {
 447             return $this->set_error(_("Addressbook is read-only"));
 448         }
 449
 450         /* See if user exists */
 451         $ret = $this->lookup($alias);
 452         if(empty($ret)) {
 453             return $this->set_error(sprintf(_("User '%s' does not exist"),
 454                 $alias));
 455         }
 456
 457         /* Lock the file to make sure we're the only process working
 458          * on it. */
 459         if(!$this->lock()) {
 460             return $this->set_error(_("Could not lock datafile"));
 461         }
 462
 463         /* Read file into memory, modifying the data for the
 464          * user identified by $alias */
 465         $this->open(true);
 466         @rewind($this->filehandle);
 467         $i = 0;
 468         $rows = array();
 469         while($row = @fgetcsv($this->filehandle, 2048, '|')) {
 470             if(strtolower($row[0]) != strtolower($alias)) {
 471                 $rows[$i++] = $row;
 472             } else {
 473                 $rows[$i++] = array(0 => $userdata['nickname'],
 474                                     1 => $userdata['firstname'],
 475                                     2 => $userdata['lastname'],
 476                                     3 => $userdata['email'],
 477                                     4 => $userdata['label']);
 478             }
 479         }
 480
 481         /* Write data back */
 482         if(!$this->overwrite($rows)) {
 483             $this->unlock();
 484             return false;
 485         }
 486
 487         $this->unlock();
 488         return true;
 489     }
 490
 491     /**
 492      * Function for quoting values before saving
 493      * @param string $value string that has to be quoted
 494      * @param string quoted string
 495      */
 496     function quotevalue($value) {
 497         /* Quote the field if it contains | or ". Double quotes need to
 498          * be replaced with "" */
 499         if(ereg("[|\"]", $value)) {
 500             $value = '"' . str_replace('"', '""', $value) . '"';
 501         }
 502         return $value;
 503     }
 504
 505 } /* End of class abook_local_file */
 506 ?>