6 * @copyright © 1999-2007 The SquirrelMail Project Team
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
9 * @package squirrelmail
10 * @subpackage addressbook
14 * Backend for address book as a pipe separated file
16 * Stores the address book in a local file
18 * An array with the following elements must be passed to
19 * the class constructor (elements marked ? are optional):
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
31 * NOTE. This class should not be used directly. Use the
32 * "AddressBook" class instead.
33 * @package squirrelmail
35 class abook_local_file
extends addressbook_backend
{
45 var $bname = 'local_file';
48 * File used to store data
58 * Create file, if it not present
63 * Detect, if address book is writeable by checking file permisions
66 var $detect_writeable = true;
68 * Control write access to address book
70 * Option does not have any effect, if 'detect_writeable' is 'true'
73 var $writeable = false;
75 * controls listing of address book
85 * Sets max entry size (number of bytes used for all address book fields
86 * (including escapes) + 4 delimiters + 1 linefeed)
90 var $line_length = 2048;
92 /* ========================== Private ======================= */
96 * @param array $param backend options
99 function abook_local_file($param) {
100 $this->sname
= _("Personal Address Book");
101 $this->umask
= Umask();
103 if(is_array($param)) {
104 if(empty($param['filename'])) {
105 return $this->set_error('Invalid parameters');
107 if(!is_string($param['filename'])) {
108 return $this->set_error($param['filename'] . ': '.
109 _("Not a file name"));
112 $this->filename
= $param['filename'];
114 if(isset($param['create'])) {
115 $this->create
= $param['create'];
117 if(isset($param['umask'])) {
118 $this->umask
= $param['umask'];
120 if(isset($param['name'])) {
121 $this->sname
= $param['name'];
123 if(isset($param['detect_writeable'])) {
124 $this->detect_writeable
= $param['detect_writeable'];
126 if(!empty($param['writeable'])) {
127 $this->writeable
= $param['writeable'];
129 if(isset($param['listing'])) {
130 $this->listing
= $param['listing'];
132 if(isset($param['line_length']) && ! empty($param['line_length'])) {
133 $this->line_length
= (int) $param['line_length'];
138 $this->set_error('Invalid argument to constructor');
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
147 * @param bool $new is file already opened
150 function open($new = false) {
152 $file = $this->filename
;
153 $create = $this->create
;
154 $fopenmode = (($this->writeable
&& sq_is_writable($file)) ?
'a+' : 'r');
156 /* Return true is file is open and $new is unset */
157 if($this->filehandle
&& !$new) {
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"));
166 /* Close old file, if any */
167 if($this->filehandle
) { $this->close(); }
170 if (! $this->detect_writeable
) {
171 $fh = @fopen
($file,$fopenmode);
173 $this->filehandle
= &$fh;
174 $this->filename
= $file;
176 return $this->set_error("$file: " . _("Open failed"));
179 /* Open file. First try to open for reading and writing,
180 * but fall back to read only. */
181 $fh = @fopen
($file, 'a+');
183 $this->filehandle
= &$fh;
184 $this->filename
= $file;
185 $this->writeable
= true;
187 $fh = @fopen
($file, 'r');
189 $this->filehandle
= &$fh;
190 $this->filename
= $file;
191 $this->writeable
= false;
193 return $this->set_error("$file: " . _("Open failed"));
200 /** Close the file and forget the filehandle */
202 @fclose
($this->filehandle
);
203 $this->filehandle
= 0;
204 $this->filename
= '';
205 $this->writable
= false;
208 /** Lock the datafile - try 20 times in 5 seconds */
210 for($i = 0 ; $i < 20 ; $i++
) {
211 if(flock($this->filehandle
, 2 +
4))
219 /** Unlock the datafile */
221 return flock($this->filehandle
, 3);
225 * Overwrite the file with data from $rows
226 * NOTE! Previous locks are broken by this function
227 * @param array $rows new data
230 function overwrite(&$rows) {
232 $newfh = @fopen
($this->filename
.'.tmp', 'w');
235 return $this->set_error($this->filename
. '.tmp:' . _("Open failed"));
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]);
243 $tmpwrite = sq_fwrite($newfh, join('|', $rows[$i]) . "\n");
244 if ($tmpwrite === FALSE) {
245 return $this->set_error($this->filename
. '.tmp:' . _("Write failed"));
251 if (!@copy
($this->filename
. '.tmp' , $this->filename
)) {
252 return $this->set_error($this->filename
. ':' . _("Unable to update"));
254 @unlink
($this->filename
. '.tmp');
255 @chmod
($this->filename
, 0600);
261 /* ========================== Public ======================== */
265 * @param string $expr search expression
266 * @return array search results
268 function search($expr) {
270 /* To be replaced by advanded search expression parsing */
271 if(is_array($expr)) { return; }
273 // don't allow wide search when listing is disabled.
274 if ($expr=='*' && ! $this->listing
)
277 /* Make regexp from glob'ed expression
278 * May want to quote other special characters like (, ), -, [, ], etc. */
279 $expr = str_replace('?', '.', $expr);
280 $expr = str_replace('*', '.*', $expr);
286 @rewind
($this->filehandle
);
288 while ($row = @fgetcsv
($this->filehandle
, $this->line_length
, '|')) {
291 * address book is corrupted.
294 error_box(_("Address book is corrupted. Required fields are missing."));
295 $oTemplate->display('footer.tpl');
298 $line = join(' ', $row);
300 * TODO: regexp search is supported only in local_file backend.
301 * Do we check format of regexp or ignore errors?
303 // errors on eregi call are suppressed in order to prevent display of regexp compilation errors
304 if(@eregi
($expr, $line)) {
305 array_push($res, array('nickname' => $row[0],
306 'name' => $this->fullname($row[1], $row[2]),
307 'firstname' => $row[1],
308 'lastname' => $row[2],
311 'backend' => $this->bnum
,
312 'source' => &$this->sname
));
321 * Lookup an address by the indicated field.
323 * @param string $value The value to look up
324 * @param integer $field The field to look in, should be one
325 * of the SM_ABOOK_FIELD_* constants
326 * defined in include/constants.php
327 * (OPTIONAL; defaults to nickname field)
328 * NOTE: uniqueness is only guaranteed
329 * when the nickname field is used here;
330 * otherwise, the first matching address
333 * @return array Array with lookup results when the value
334 * was found, an empty array if the value was
338 function lookup($value, $field=SM_ABOOK_FIELD_NICKNAME
) {
343 $value = strtolower($value);
346 @rewind
($this->filehandle
);
348 while ($row = @fgetcsv
($this->filehandle
, $this->line_length
, '|')) {
351 * address book is corrupted.
354 error_box(_("Address book is corrupted. Required fields are missing."));
355 $oTemplate->display('footer.tpl');
358 if(strtolower($row[$field]) == $value) {
359 return array('nickname' => $row[0],
360 'name' => $this->fullname($row[1], $row[2]),
361 'firstname' => $row[1],
362 'lastname' => $row[2],
365 'backend' => $this->bnum
,
366 'source' => &$this->sname
);
376 * @return array list of all addresses
378 function list_addr() {
381 if(isset($this->listing
) && !$this->listing
) {
386 @rewind
($this->filehandle
);
388 while ($row = @fgetcsv
($this->filehandle
, $this->line_length
, '|')) {
391 * address book is corrupted. Don't be nice to people that
392 * violate address book formating.
395 error_box(_("Address book is corrupted. Required fields are missing."));
396 $oTemplate->display('footer.tpl');
399 array_push($res, array('nickname' => $row[0],
400 'name' => $this->fullname($row[1], $row[2]),
401 'firstname' => $row[1],
402 'lastname' => $row[2],
405 'backend' => $this->bnum
,
406 'source' => &$this->sname
));
414 * @param array $userdata new data
417 function add($userdata) {
418 if(!$this->writeable
) {
419 return $this->set_error(_("Address book is read-only"));
421 /* See if user exists already */
422 $ret = $this->lookup($userdata['nickname']);
424 // i18n: don't use html formating in translation
425 return $this->set_error(sprintf(_("User \"%s\" already exists"),$ret['nickname']));
428 /* Here is the data to write */
429 $data = $this->quotevalue($userdata['nickname']) . '|' .
430 $this->quotevalue($userdata['firstname']) . '|' .
431 $this->quotevalue((!empty($userdata['lastname'])?
$userdata['lastname']:'')) . '|' .
432 $this->quotevalue($userdata['email']) . '|' .
433 $this->quotevalue((!empty($userdata['label'])?
$userdata['label']:''));
435 /* Strip linefeeds */
436 $data = ereg_replace("[\r\n]", ' ', $data);
439 * Make sure that entry fits into allocated record space.
440 * One byte is reserved for linefeed
442 if (strlen($data) >= $this->line_length
) {
443 return $this->set_error(_("Address book entry is too big"));
446 /* Add linefeed at end */
447 $data = $data . "\n";
449 /* Reopen file, just to be sure */
451 if(!$this->writeable
) {
452 return $this->set_error(_("Address book is read-only"));
457 return $this->set_error(_("Could not lock datafile"));
461 $r = sq_fwrite($this->filehandle
, $data);
466 /* Test write result */
469 $this->set_error(_("Write to address book failed"));
478 * @param string $alias alias that has to be deleted
481 function remove($alias) {
482 if(!$this->writeable
) {
483 return $this->set_error(_("Address book is read-only"));
486 /* Lock the file to make sure we're the only process working
489 return $this->set_error(_("Could not lock datafile"));
492 /* Read file into memory, ignoring nicknames to delete */
493 @rewind
($this->filehandle
);
496 while($row = @fgetcsv
($this->filehandle
, $this->line_length
, '|')) {
497 if(!in_array($row[0], $alias)) {
502 /* Write data back */
503 if(!$this->overwrite($rows)) {
514 * @param string $alias modified alias
515 * @param array $userdata new data
516 * @return bool true, if operation successful
518 function modify($alias, $userdata) {
519 if(!$this->writeable
) {
520 return $this->set_error(_("Address book is read-only"));
523 /* See if user exists */
524 $ret = $this->lookup($alias);
526 // i18n: don't use html formating in translation
527 return $this->set_error(sprintf(_("User \"%s\" does not exist"),$alias));
530 /* If the alias changed, see if the new alias exists */
531 if (strtolower($alias) != strtolower($userdata['nickname'])) {
532 $ret = $this->lookup($userdata['nickname']);
534 return $this->set_error(sprintf(_("User \"%s\" already exists"), $userdata['nickname']));
538 /* Lock the file to make sure we're the only process working
541 return $this->set_error(_("Could not lock datafile"));
544 /* calculate userdata size */
545 $data = $this->quotevalue($userdata['nickname']) . '|'
546 . $this->quotevalue($userdata['firstname']) . '|'
547 . $this->quotevalue((!empty($userdata['lastname'])?
$userdata['lastname']:'')) . '|'
548 . $this->quotevalue($userdata['email']) . '|'
549 . $this->quotevalue((!empty($userdata['label'])?
$userdata['label']:''));
550 /* make sure that it fits into allocated space */
551 if (strlen($data) >= $this->line_length
) {
552 return $this->set_error(_("Address book entry is too big"));
555 /* Read file into memory, modifying the data for the
556 * user identified by $alias */
558 @rewind
($this->filehandle
);
561 while($row = @fgetcsv
($this->filehandle
, $this->line_length
, '|')) {
562 if(strtolower($row[0]) != strtolower($alias)) {
565 $rows[$i++
] = array(0 => $userdata['nickname'],
566 1 => $userdata['firstname'],
567 2 => (!empty($userdata['lastname'])?
$userdata['lastname']:''),
568 3 => $userdata['email'],
569 4 => (!empty($userdata['label'])?
$userdata['label']:''));
573 /* Write data back */
574 if(!$this->overwrite($rows)) {
584 * Function for quoting values before saving
585 * @param string $value string that has to be quoted
586 * @param string quoted string
588 function quotevalue($value) {
589 /* Quote the field if it contains | or ". Double quotes need to
590 * be replaced with "" */
591 if(ereg("[|\"]", $value)) {
592 $value = '"' . str_replace('"', '""', $value) . '"';