f14fbeebb4b02cc33d9107e2f749bc61f5958e80
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 $messages = $this->readMessages(array($id));
110 if (!empty($messages)) {
111 $message = new BananaMessage($messages[$id]['message']);
116 /** Return the sources of the given message
118 public function getMessageSource($id)
121 if (!is_numeric($id)) {
122 if (!Banana
::$spool) {
125 $id = Banana
::$spool->ids
[$id];
127 $message = $this->readMessages(array($id));
128 return implode("\n", $message[$id]['message']);
131 /** Compute the number of messages of the box
133 private function getCount()
135 $this->count
= count(Banana
::$spool->overview
);
136 $max = @max
(array_keys(Banana
::$spool->overview
));
137 if ($max && Banana
::$spool->overview
[$max]->storage
['next'] == $this->filesize
) {
138 $this->new_messages
= 0;
140 $this->new_messages
= $this->countMessages($this->count
);
141 $this->count +
= $this->new_messages
;
145 /** Return the indexes of the messages presents in the Box
146 * @return Array(number of messages, MSGNUM of the first message, MSGNUM of the last message)
148 public function getIndexes()
150 if (is_null($this->count
)) {
153 return array($this->count
, 0, $this->count
- 1);
156 /** Return the message headers (in BananaMessage) for messages from firstid to lastid
157 * @return Array(id => array(headername => headervalue))
159 public function &getMessageHeaders($firstid, $lastid, array $msg_headers = array())
161 $msg_headers = array_map('strtolower', $msg_headers);
162 $messages =& $this->readMessages(range($firstid, $lastid), true
);
163 $msg_headers = array_map('strtolower', $msg_headers);
165 foreach ($msg_headers as $header) {
166 foreach ($messages as $id=>&$message) {
167 if (!isset($headers[$id])) {
168 $headers[$id] = array('beginning' => $message['beginning'], 'end' => $message['end']);
170 if ($header == 'date') {
171 $headers[$id][$header] = @strtotime
($message['message'][$header]);
173 $headers[$id][$header] = @$message['message'][$header];
177 unset($this->messages
);
182 /** Add storage data in spool overview
184 public function updateSpool(array &$messages)
186 foreach ($messages as $id=>&$data) {
187 if (isset(Banana
::$spool->overview
[$id])) {
188 Banana
::$spool->overview
[$id]->storage
['offset'] = $data['beginning'];
189 Banana
::$spool->overview
[$id]->storage
['next'] = $data['end'];
194 /** Return the indexes of the new messages since the give date
195 * @return Array(MSGNUM of new messages)
197 public function getNewIndexes($since)
199 if (is_null($this->new_messages
)) {
202 return range($this->count
- $this->new_messages
, $this->count
- 1);
205 /** Return wether or not the protocole can be used to add new messages
207 public function canSend()
212 /** Return false because we can't cancel a mail
214 public function canCancel()
219 /** Return the list of requested headers
220 * @return Array('header1', 'header2', ...) with the key 'dest' for the destination header
221 * and 'reply' for the reply header, eg:
222 * * for a mail: Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To')
223 * * for a post: Array('From', 'Subject', 'dest' => 'Newsgroups', 'reply' => 'Followup-To')
225 public function requestedHeaders()
227 return Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To');
231 * @return true if it was successfull
233 public function send(BananaMessage
&$message)
235 $headers = $message->getHeaders();
236 $to = $headers['To'];
237 $subject = $headers['Subject'];
238 unset($headers['To']);
239 unset($headers['Subject']);
241 foreach ($headers as $key=>$value) {
242 if (!empty($value)) {
243 $hdrs .= "$key: $value\r\n";
246 $body = $message->get(false
);
247 return mail($to, $subject, $body, $hdrs);
251 * @return true if it was successfull
253 public function cancel(BananaMessage
&$message)
258 /** Return the protocole name
260 public function name()
265 /** Return the spool filename
267 public function filename()
269 @list
($mail, $domain) = explode('@', Banana
::$group);
271 if (isset($domain)) {
272 $file = $domain . '_';
274 return $file . $mail;
278 # Filesystem functions
281 protected function getFileName($box)
286 @list
($mail, $domain) = explode('@', $box);
287 return Banana
::$mbox_path . '/' . $mail;
294 /** Go to the given message
296 private function goTo($id)
298 if ($this->current_id
== $id && $this->at_beginning
) {
302 fseek($this->file
, 0);
303 $this->current_id
= 0;
304 $this->at_beginning
= true
;
306 } elseif (isset(Banana
::$spool->overview
[$id]) ||
isset($this->messages
[$id])) {
307 if (isset(Banana
::$spool->overview
[$id])) {
308 $pos = Banana
::$spool->overview
[$id]->storage
['offset'];
310 $pos = $this->messages
[$id]['beginning'];
312 if (fseek($this->file
, $pos) == 0) {
313 $this->current_id
= $id;
314 $this->at_beginning
= true
;
317 $this->current_id
= null
;
318 $this->_lasterrno
= 2;
319 $this->_lasterror
= _b_('Can\'t find message ') . $id;
323 $max = @max
(array_keys(Banana
::$spool->overview
));
327 if ($id <= $max && $max != 0) {
328 $this->current_id
= null
;
329 $this->_lasterrno
= 3;
330 $this->_lasterror
= _b_('Invalid message index ') . $id;
333 if (!$this->goTo($max)) {
336 if (feof($this->file
)) {
337 $this->current_id
= null
;
338 $this->_lasterrno
= 4;
339 $this->_lasterror
= _b_('Requested index does not exists or file has been truncated');
342 while ($this->readCurrentMessage(true
) && $this->current_id
< $id);
343 if ($this->current_id
== $id) {
346 $this->current_id
= null
;
347 $this->_lasterrno
= 5;
348 $this->_lasterror
= _b_('Requested index does not exists or file has been truncated');
353 private function countMessages($from = 0)
355 $this->messages
=& $this->readMessages(array($from), true
, true
);
356 return count($this->messages
);
359 /** Read the current message (identified by current_id)
360 * @param needFrom_ BOOLEAN is true if the first line *must* be a From_ line
361 * @param alignNext BOOLEAN is true if the buffer must be aligned at the beginning of the next From_ line
362 * @return message sources (without storage data)
364 private function &readCurrentMessage($stripBody = false
, $needFrom_ = true
, $alignNext = true
)
366 $file_cache =& $this->file_cache
;
367 if ($file_cache && $file_cache != ftell($this->file
)) {
373 while(!feof($this->file
)) {
374 // Process file cache
375 if ($file_cache) { // this is a From_ line
377 $this->at_beginning
= false
;
383 $line = rtrim(fgets($this->file
), "\r\n");
385 // Process From_ line
386 if ($needFrom_ ||
!$msg ||
$canFrom_) {
387 if (substr($line, 0, 5) == 'From ') { // this is a From_ line
393 $this->current_id++
; // we are finally in the next message
394 if ($alignNext) { // align the file pointer at the beginning of the new message
395 $this->at_beginning
= true
;
396 $file_cache = ftell($this->file
);
400 } elseif ($needFrom_) {
405 // Process non-From_ lines
406 if (substr($line, 0, 6) == '>From ') { // remove inline From_ quotation
407 $line = substr($line, 1);
409 if (!$stripBody ||
!$inBody) {
410 $msg[] = $line; // add the line to the message source
412 $canFrom_ = empty($line); // check if next line can be a From_ line
413 if ($canFrom_ && !$inBody && $stripBody) {
416 $this->at_beginning
= false
;
418 if (!feof($this->file
) && !$canFrom_) {
424 /** Read message with the given ids
425 * @param ids ARRAY of ids to look for
426 * @param strip BOOLEAN if true, only headers are retrieved
427 * @param from BOOLEAN if true, process all messages from max(ids) to the end of the mbox
428 * @return Array(Array('message' => message sources (or parsed message headers if $strip is true),
429 * 'beginning' => offset of message beginning,
430 * 'end' => offset of message end))
432 private function &readMessages(array $ids, $strip = false
, $from = false
)
434 if ($this->messages
) {
435 return $this->messages
;
439 while ((count($ids) ||
$from) && !feof($this->file
)) {
441 $id = array_shift($ids);
445 if ($id != $this->current_id ||
!$this->at_beginning
) {
446 if (!$this->goTo($id)) {
450 $beginning = ftell($this->file
);
451 $message =& $this->readCurrentMessage($strip, false
);
453 $message =& BananaMimePart
::parseHeaders($message);
455 $end = ftell($this->file
);
456 $messages[$id] = array('message' => $message, 'beginning' => $beginning, 'end' => $end);
462 // vim:set et sw=4 sts=4 ts=4 enc=utf-8: