4bd3401ccaf4c6092fcf2b98e09a2a04828f8099
2 /********************************************************************************
3 * banana/protocoleinterface.inc.php : interface for box access
4 * ------------------------
6 * This file is part of the banana distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
10 require_once dirname(__FILE__
) . '/banana.inc.php';
11 require_once dirname(__FILE__
) . '/protocoleinterface.inc.php';
12 require_once dirname(__FILE__
) . '/message.inc.php';
14 class BananaMBox
implements BananaProtocoleInterface
17 private $filesize = null
;
18 private $current_id = null
;
19 private $at_beginning = false
;
20 private $file_cache = null
;
22 private $_lasterrno = 0;
23 private $_lasterror = null
;
25 private $count = null
;
26 private $new_messages = null
;
27 private $messages = null
;
29 /** Build a protocole handler plugged on the given box
31 public function __construct()
33 $filename = $this->getFileName(Banana
::$group);
34 if (is_null($filename)) {
37 $this->filesize
= filesize($filename);
38 $this->file
= @fopen
($filename, 'r');
40 $this->_lasterrno
= 1;
41 $this->_lasterror
= _b_('Can\'t open file');
44 $this->current_id
= 0;
45 $this->at_beginning
= true
;
50 public function __destruct()
57 /** Indicate if the Protocole handler has been succesfully built
59 public function isValid()
61 return !Banana
::$group ||
$this->file
;
64 /** Indicate last error n°
66 public function lastErrNo()
68 return $this->_lasterrno
;;
71 /** Indicate last error text
73 public function lastError()
75 return $this->_lasterror
;
78 /** Return the description of the current box
80 public function getDescription()
85 /** Return the list of the boxes
86 * @param mode Kind of boxes to list
87 * @param since date of last check (for new boxes and new messages)
88 * @param withstats Indicated whether msgnum and unread must be set in the result
89 * @return Array(boxname => array(desc => boxdescripton, msgnum => number of message, unread =>number of unread messages)
91 public function getBoxList($mode = Banana
::BOXES_ALL
, $since = 0, $withstats = false
)
93 return array(Banana
::$group => array('desc' => '', 'msgnum' => 0, 'unread' => 0));
97 * @param id Id of the emssage (can be either an Message-id or a message index)
98 * @return A BananaMessage or null if the given id can't be retreived
100 public function &getMessage($id)
103 if (!is_numeric($id)) {
104 if (!Banana
::$spool) {
107 $id = Banana
::$spool->ids
[$id];
109 $message = $this->readMessages(array($id));
110 if (empty($message)) {
114 return new BananaMessage($message[$id]['message']);
117 /** Return the sources of the given message
119 public function getMessageSource($id)
122 if (!is_numeric($id)) {
123 if (!Banana
::$spool) {
126 $id = Banana
::$spool->ids
[$id];
128 $message = $this->readMessages(array($id));
129 return implode("\n", $message[$id]['message']);
132 /** Compute the number of messages of the box
134 private function getCount()
136 $this->count
= count(Banana
::$spool->overview
);
137 $max = @max
(array_keys(Banana
::$spool->overview
));
138 if ($max && Banana
::$spool->overview
[$max]->storage
['next'] == $this->filesize
) {
139 $this->new_messages
= 0;
141 $this->new_messages
= $this->countMessages($this->count
);
142 $this->count +
= $this->new_messages
;
146 /** Return the indexes of the messages presents in the Box
147 * @return Array(number of messages, MSGNUM of the first message, MSGNUM of the last message)
149 public function getIndexes()
151 if (is_null($this->count
)) {
154 return array($this->count
, 0, $this->count
- 1);
157 /** Return the message headers (in BananaMessage) for messages from firstid to lastid
158 * @return Array(id => array(headername => headervalue))
160 public function &getMessageHeaders($firstid, $lastid, array $msg_headers = array())
162 $msg_headers = array_map('strtolower', $msg_headers);
163 $messages =& $this->readMessages(range($firstid, $lastid), true
);
164 $msg_headers = array_map('strtolower', $msg_headers);
166 foreach ($msg_headers as $header) {
167 foreach ($messages as $id=>&$message) {
168 if (!isset($headers[$id])) {
169 $headers[$id] = array('beginning' => $message['beginning'], 'end' => $message['end']);
171 if ($header == 'date') {
172 $headers[$id][$header] = @strtotime
($message['message'][$header]);
174 $headers[$id][$header] = @$message['message'][$header];
178 unset($this->messages
);
183 /** Add storage data in spool overview
185 public function updateSpool(array &$messages)
187 foreach ($messages as $id=>&$data) {
188 if (isset(Banana
::$spool->overview
[$id])) {
189 Banana
::$spool->overview
[$id]->storage
['offset'] = $data['beginning'];
190 Banana
::$spool->overview
[$id]->storage
['next'] = $data['end'];
195 /** Return the indexes of the new messages since the give date
196 * @return Array(MSGNUM of new messages)
198 public function getNewIndexes($since)
200 if (is_null($this->new_messages
)) {
203 return range($this->count
- $this->new_messages
, $this->count
- 1);
206 /** Return wether or not the protocole can be used to add new messages
208 public function canSend()
213 /** Return false because we can't cancel a mail
215 public function canCancel()
220 /** Return the list of requested headers
221 * @return Array('header1', 'header2', ...) with the key 'dest' for the destination header
222 * and 'reply' for the reply header, eg:
223 * * for a mail: Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To')
224 * * for a post: Array('From', 'Subject', 'dest' => 'Newsgroups', 'reply' => 'Followup-To')
226 public function requestedHeaders()
228 return Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To');
232 * @return true if it was successfull
234 public function send(BananaMessage
&$message)
240 * @return true if it was successfull
242 public function cancel(BananaMessage
&$message)
247 /** Return the protocole name
249 public function name()
254 /** Return the spool filename
256 public function filename()
258 @list
($mail, $domain) = explode('@', Banana
::$group);
260 if (isset($domain)) {
261 $file = $domain . '_';
263 return $file . $mail;
267 # Filesystem functions
270 protected function getFileName($box)
275 @list
($mail, $domain) = explode('@', $box);
276 return Banana
::$mbox_path . '/' . $mail;
283 /** Go to the given message
285 private function goTo($id)
287 if ($this->current_id
== $id && $this->at_beginning
) {
291 fseek($this->file
, 0);
292 $this->current_id
= 0;
293 $this->at_beginning
= true
;
295 } elseif (isset(Banana
::$spool->overview
[$id]) ||
isset($this->messages
[$id])) {
296 if (isset(Banana
::$spool->overview
[$id])) {
297 $pos = Banana
::$spool->overview
[$id]->storage
['offset'];
299 $pos = $this->messages
[$id]['beginning'];
301 if (fseek($this->file
, $pos) == 0) {
302 $this->current_id
= $id;
303 $this->at_beginning
= true
;
306 $this->current_id
= null
;
307 $this->_lasterrno
= 2;
308 $this->_lasterror
= _b_('Can\'t find message ') . $id;
312 $max = @max
(array_keys(Banana
::$spool->overview
));
316 if ($id <= $max && $max != 0) {
317 $this->current_id
= null
;
318 $this->_lasterrno
= 3;
319 $this->_lasterror
= _b_('Invalid message index ') . $id;
322 if (!$this->goTo($max)) {
325 if (feof($this->file
)) {
326 $this->current_id
= null
;
327 $this->_lasterrno
= 4;
328 $this->_lasterror
= _b_('Requested index does not exists or file has been truncated');
331 while ($this->readCurrentMessage(true
) && $this->current_id
< $id);
332 if ($this->current_id
== $id) {
335 $this->current_id
= null
;
336 $this->_lasterrno
= 5;
337 $this->_lasterror
= _b_('Requested index does not exists or file has been truncated');
342 private function countMessages($from = 0)
344 $this->messages
=& $this->readMessages(array($from), true
, true
);
345 return count($this->messages
);
348 /** Read the current message (identified by current_id)
349 * @param needFrom_ BOOLEAN is true if the first line *must* be a From_ line
350 * @param alignNext BOOLEAN is true if the buffer must be aligned at the beginning of the next From_ line
351 * @return message sources (without storage data)
353 private function &readCurrentMessage($stripBody = false
, $needFrom_ = true
, $alignNext = true
)
355 $file_cache =& $this->file_cache
;
356 if ($file_cache && $file_cache != ftell($this->file
)) {
362 while(!feof($this->file
)) {
363 // Process file cache
364 if ($file_cache) { // this is a From_ line
366 $this->at_beginning
= false
;
372 $line = rtrim(fgets($this->file
), "\r\n");
374 // Process From_ line
375 if ($needFrom_ ||
!$msg ||
$canFrom_) {
376 if (substr($line, 0, 5) == 'From ') { // this is a From_ line
382 $this->current_id++
; // we are finally in the next message
383 if ($alignNext) { // align the file pointer at the beginning of the new message
384 $this->at_beginning
= true
;
385 $file_cache = ftell($this->file
);
389 } elseif ($needFrom_) {
394 // Process non-From_ lines
395 if (substr($line, 0, 6) == '>From ') { // remove inline From_ quotation
396 $line = substr($line, 1);
398 if (!$stripBody ||
!$inBody) {
399 $msg[] = $line; // add the line to the message source
401 $canFrom_ = empty($line); // check if next line can be a From_ line
402 if ($canFrom_ && !$inBody && $stripBody) {
405 $this->at_beginning
= false
;
407 if (!feof($this->file
) && !$canFrom_) {
413 /** Read message with the given ids
414 * @param ids ARRAY of ids to look for
415 * @param strip BOOLEAN if true, only headers are retrieved
416 * @param from BOOLEAN if true, process all messages from max(ids) to the end of the mbox
417 * @return Array(Array('message' => message sources (or parsed message headers if $strip is true),
418 * 'beginning' => offset of message beginning,
419 * 'end' => offset of message end))
421 private function &readMessages(array $ids, $strip = false
, $from = false
)
423 if ($this->messages
) {
424 return $this->messages
;
428 while ((count($ids) ||
$from) && !feof($this->file
)) {
430 $id = array_shift($ids);
434 if ($id != $this->current_id ||
!$this->at_beginning
) {
435 if (!$this->goTo($id)) {
439 $beginning = ftell($this->file
);
440 $message =& $this->readCurrentMessage($strip, false
);
442 $message =& BananaMimePart
::parseHeaders($message);
444 $end = ftell($this->file
);
445 $messages[$id] = array('message' => $message, 'beginning' => $beginning, 'end' => $end);
451 // vim:set et sw=4 sts=4 ts=4: