1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
<?php
/**
* abook_local_file.php
*
* Copyright (c) 1999-2002 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* Backend for addressbook as a pipe separated file
*
* An array with the following elements must be passed to
* the class constructor (elements marked ? are optional):
*
* filename => path to addressbook file
* ? create => if true: file is created if it does not exist.
* ? umask => umask set before opening file.
*
* NOTE. This class should not be used directly. Use the
* "AddressBook" class instead.
*
* $Id: abook_local_file.php,v 1.18 2002/04/06 21:26:37 graf25 Exp $
*/
class abook_local_file extends addressbook_backend {
var $btype = 'local';
var $bname = 'local_file';
var $filename = '';
var $filehandle = 0;
var $create = false;
var $umask;
/* ========================== Private ======================= */
/* Constructor */
function abook_local_file($param) {
$this->sname = _("Personal address book");
$this->umask = Umask();
if(is_array($param)) {
if(empty($param['filename'])) {
return $this->set_error('Invalid parameters');
}
if(!is_string($param['filename'])) {
return $this->set_error($param['filename'] . ': '.
_("Not a file name"));
}
$this->filename = $param['filename'];
if($param['create']) {
$this->create = true;
}
if(isset($param['umask'])) {
$this->umask = $param['umask'];
}
if(!empty($param['name'])) {
$this->sname = $param['name'];
}
$this->open(true);
} else {
$this->set_error('Invalid argument to constructor');
}
}
/* Open the addressbook file and store the file pointer.
* Use $file as the file to open, or the class' own
* filename property. If $param is empty and file is
* open, do nothing. */
function open($new = false) {
$this->error = '';
$file = $this->filename;
$create = $this->create;
/* Return true is file is open and $new is unset */
if($this->filehandle && !$new) {
return true;
}
/* Check that new file exitsts */
if((!(file_exists($file) && is_readable($file))) && !$create) {
return $this->set_error("$file: " . _("No such file or directory"));
}
/* Close old file, if any */
if($this->filehandle) { $this->close(); }
/* Open file. First try to open for reading and writing,
* but fall back to read only. */
umask($this->umask);
$fh = @fopen($file, 'a+');
if($fh) {
$this->filehandle = &$fh;
$this->filename = $file;
$this->writeable = true;
} else {
$fh = @fopen($file, 'r');
if($fh) {
$this->filehandle = &$fh;
$this->filename = $file;
$this->writeable = false;
} else {
return $this->set_error("$file: " . _("Open failed"));
}
}
return true;
}
/* Close the file and forget the filehandle */
function close() {
@fclose($this->filehandle);
$this->filehandle = 0;
$this->filename = '';
$this->writable = false;
}
/* Lock the datafile - try 20 times in 5 seconds */
function lock() {
for($i = 0 ; $i < 20 ; $i++) {
if(flock($this->filehandle, 2 + 4))
return true;
else
usleep(250000);
}
return false;
}
/* Lock the datafile */
function unlock() {
return flock($this->filehandle, 3);
}
/* Overwrite the file with data from $rows
* NOTE! Previous locks are broken by this function */
function overwrite(&$rows) {
$this->unlock();
$newfh = @fopen($this->filename, 'w');
if(!$newfh) {
return $this->set_error("$file: " . _("Open failed"));
}
for($i = 0 ; $i < sizeof($rows) ; $i++) {
if(is_array($rows[$i])) {
for($j = 0 ; $j < count($rows[$i]) ; $j++) {
$rows[$i][$j] = $this->quotevalue($rows[$i][$j]);
}
fwrite($newfh, join('|', $rows[$i]) . "\n");
}
}
fclose($newfh);
$this->unlock();
$this->open(true);
return true;
}
/* ========================== Public ======================== */
/* Search the file */
function search($expr) {
/* To be replaced by advanded search expression parsing */
if(is_array($expr)) { return; }
/* Make regexp from glob'ed expression
* May want to quote other special characters like (, ), -, [, ], etc. */
$expr = str_replace('?', '.', $expr);
$expr = str_replace('*', '.*', $expr);
$res = array();
if(!$this->open()) {
return false;
}
@rewind($this->filehandle);
while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
$line = join(' ', $row);
if(eregi($expr, $line)) {
array_push($res, array('nickname' => $row[0],
'name' => $row[1] . ' ' . $row[2],
'firstname' => $row[1],
'lastname' => $row[2],
'email' => $row[3],
'label' => $row[4],
'backend' => $this->bnum,
'source' => &$this->sname));
}
}
return $res;
}
/* Lookup alias */
function lookup($alias) {
if(empty($alias)) {
return array();
}
$alias = strtolower($alias);
$this->open();
@rewind($this->filehandle);
while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
if(strtolower($row[0]) == $alias) {
return array('nickname' => $row[0],
'name' => $row[1] . ' ' . $row[2],
'firstname' => $row[1],
'lastname' => $row[2],
'email' => $row[3],
'label' => $row[4],
'backend' => $this->bnum,
'source' => &$this->sname);
}
}
return array();
}
/* List all addresses */
function list_addr() {
$res = array();
$this->open();
@rewind($this->filehandle);
while ($row = @fgetcsv($this->filehandle, 2048, '|')) {
array_push($res, array('nickname' => $row[0],
'name' => $row[1] . ' ' . $row[2],
'firstname' => $row[1],
'lastname' => $row[2],
'email' => $row[3],
'label' => $row[4],
'backend' => $this->bnum,
'source' => &$this->sname));
}
return $res;
}
/* Add address */
function add($userdata) {
if(!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
/* See if user exists already */
$ret = $this->lookup($userdata['nickname']);
if(!empty($ret)) {
return $this->set_error(sprintf(_("User '%s' already exist"),
$ret['nickname']));
}
/* Here is the data to write */
$data = $this->quotevalue($userdata['nickname']) . '|' .
$this->quotevalue($userdata['firstname']) . '|' .
$this->quotevalue($userdata['lastname']) . '|' .
$this->quotevalue($userdata['email']) . '|' .
$this->quotevalue($userdata['label']);
/* Strip linefeeds */
$data = ereg_replace("[\r\n]", ' ', $data);
/* Add linefeed at end */
$data = $data . "\n";
/* Reopen file, just to be sure */
$this->open(true);
if(!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
/* Lock the file */
if(!$this->lock()) {
return $this->set_error(_("Could not lock datafile"));
}
/* Write */
$r = fwrite($this->filehandle, $data);
/* Unlock file */
$this->unlock();
/* Test write result and exit if OK */
if($r > 0) return true;
/* Fail */
$this->set_error(_("Write to addressbook failed"));
return false;
}
/* Delete address */
function remove($alias) {
if(!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
/* Lock the file to make sure we're the only process working
* on it. */
if(!$this->lock()) {
return $this->set_error(_("Could not lock datafile"));
}
/* Read file into memory, ignoring nicknames to delete */
@rewind($this->filehandle);
$i = 0;
$rows = array();
while($row = @fgetcsv($this->filehandle, 2048, '|')) {
if(!in_array($row[0], $alias)) {
$rows[$i++] = $row;
}
}
/* Write data back */
if(!$this->overwrite($rows)) {
$this->unlock();
return false;
}
$this->unlock();
return true;
}
/* Modify address */
function modify($alias, $userdata) {
if(!$this->writeable) {
return $this->set_error(_("Addressbook is read-only"));
}
/* See if user exists */
$ret = $this->lookup($alias);
if(empty($ret)) {
return $this->set_error(sprintf(_("User '%s' does not exist"),
$alias));
}
/* Lock the file to make sure we're the only process working
* on it. */
if(!$this->lock()) {
return $this->set_error(_("Could not lock datafile"));
}
/* Read file into memory, modifying the data for the
* user identified by $alias */
$this->open(true);
@rewind($this->filehandle);
$i = 0;
$rows = array();
while($row = @fgetcsv($this->filehandle, 2048, '|')) {
if(strtolower($row[0]) != strtolower($alias)) {
$rows[$i++] = $row;
} else {
$rows[$i++] = array(0 => $userdata['nickname'],
1 => $userdata['firstname'],
2 => $userdata['lastname'],
3 => $userdata['email'],
4 => $userdata['label']);
}
}
/* Write data back */
if(!$this->overwrite($rows)) {
$this->unlock();
return false;
}
$this->unlock();
return true;
}
/* Function for quoting values before saving */
function quotevalue($value) {
/* Quote the field if it contains | or ". Double quotes need to
* be replaced with "" */
if(ereg("[|\"]", $value)) {
$value = '"' . str_replace('"', '""', $value) . '"';
}
return $value;
}
} /* End of class abook_local_file */
?>
|
