7027794f |
1 | <?php |
2 | /******************************************************************************** |
3 | * banana/protocoleinterface.inc.php : interface for box access |
4 | * ------------------------ |
5 | * |
6 | * This file is part of the banana distribution |
7 | * Copyright: See COPYING files that comes with this distribution |
8 | ********************************************************************************/ |
9 | |
10 | require_once dirname(__FILE__) . '/banana.inc.php'; |
11 | require_once dirname(__FILE__) . '/protocoleinterface.inc.php'; |
12 | require_once dirname(__FILE__) . '/message.inc.php'; |
13 | |
14 | class BananaMBox implements BananaProtocoleInterface |
15 | { |
19fc7e1d |
16 | private $debug = false; |
6a684b9b |
17 | private $bt = array(); |
18 | |
7027794f |
19 | private $_lasterrno = 0; |
20 | private $_lasterror = null; |
19fc7e1d |
21 | |
0e25d15d |
22 | public function __construct() |
7027794f |
23 | { |
19fc7e1d |
24 | $this->debug = Banana::$debug_mbox; |
7027794f |
25 | } |
19fc7e1d |
26 | |
7027794f |
27 | public function isValid() |
28 | { |
c28d3016 |
29 | return true; |
30 | //!Banana::$group || $this->file; |
7027794f |
31 | } |
32 | |
598a1c53 |
33 | /** Indicate last error n° |
7027794f |
34 | */ |
35 | public function lastErrNo() |
36 | { |
37 | return $this->_lasterrno;; |
38 | } |
39 | |
40 | /** Indicate last error text |
41 | */ |
42 | public function lastError() |
43 | { |
44 | return $this->_lasterror; |
45 | } |
46 | |
47 | /** Return the description of the current box |
48 | */ |
49 | public function getDescription() |
50 | { |
51 | return null; |
52 | } |
53 | |
54 | /** Return the list of the boxes |
55 | * @param mode Kind of boxes to list |
56 | * @param since date of last check (for new boxes and new messages) |
57 | * @param withstats Indicated whether msgnum and unread must be set in the result |
58 | * @return Array(boxname => array(desc => boxdescripton, msgnum => number of message, unread =>number of unread messages) |
59 | */ |
60 | public function getBoxList($mode = Banana::BOXES_ALL, $since = 0, $withstats = false) |
61 | { |
0e25d15d |
62 | return array(Banana::$group => array('desc' => '', 'msgnum' => 0, 'unread' => 0)); |
7027794f |
63 | } |
64 | |
19fc7e1d |
65 | private function &getRawMessage($id) |
7027794f |
66 | { |
7d3f4749 |
67 | $message = null; |
7a5823f9 |
68 | if (!is_numeric($id)) { |
19fc7e1d |
69 | if (!Banana::$spool) { |
7d3f4749 |
70 | return $message; |
7027794f |
71 | } |
72 | $id = Banana::$spool->ids[$id]; |
73 | } |
19fc7e1d |
74 | $options = array ('-m ' . $id); |
6c6b7002 |
75 | $this->getMBoxPosition($options, $id); |
19fc7e1d |
76 | return $this->callHelper('-b', $options); |
77 | } |
78 | |
79 | /** Return a message |
80 | * @param id Id of the emssage (can be either an Message-id or a message index) |
81 | * @return A BananaMessage or null if the given id can't be retreived |
82 | */ |
83 | public function &getMessage($id) |
84 | { |
85 | $messages =& $this->getRawMessage($id); |
86 | if ($messages) { |
87 | $messages = new BananaMessage($messages); |
88 | } |
89 | return $messages; |
7027794f |
90 | } |
91 | |
7a5823f9 |
92 | /** Return the sources of the given message |
93 | */ |
94 | public function getMessageSource($id) |
19fc7e1d |
95 | { |
96 | $message =& $this->getRawMessage($id); |
97 | if ($message) { |
98 | $message = implode("\n", $message); |
c28d3016 |
99 | } |
19fc7e1d |
100 | return $message; |
7a5823f9 |
101 | } |
102 | |
103 | /** Compute the number of messages of the box |
104 | */ |
7027794f |
105 | private function getCount() |
106 | { |
19fc7e1d |
107 | $options = array(); |
dc5f77ad |
108 | if (@filesize($this->getFileName()) == Banana::$spool->storage['size']) { |
345c3a85 |
109 | return max(Banana::$spool->ids) + 1; |
dc5f77ad |
110 | } |
6c6b7002 |
111 | $this->getMBoxPosition($options); |
19fc7e1d |
112 | $val =& $this->callHelper('-c', $options); |
113 | if (!$val) { |
114 | return 0; |
115 | } |
116 | return intval(trim($val[0])); |
7027794f |
117 | } |
118 | |
119 | /** Return the indexes of the messages presents in the Box |
120 | * @return Array(number of messages, MSGNUM of the first message, MSGNUM of the last message) |
121 | */ |
122 | public function getIndexes() |
123 | { |
19fc7e1d |
124 | $count = $this->getCount(); |
125 | return array($count, 0, $count - 1); |
7027794f |
126 | } |
127 | |
128 | /** Return the message headers (in BananaMessage) for messages from firstid to lastid |
129 | * @return Array(id => array(headername => headervalue)) |
130 | */ |
131 | public function &getMessageHeaders($firstid, $lastid, array $msg_headers = array()) |
132 | { |
19fc7e1d |
133 | $headers = null; |
134 | $options = array(); |
135 | $options[] = "-m $firstid:$lastid"; |
6c6b7002 |
136 | $this->getMboxPosition($options, $firstid); |
19fc7e1d |
137 | $lines =& $this->callHelper('-d', $options, $msg_headers); |
138 | if (!$lines) { |
c28d3016 |
139 | return $headers; |
140 | } |
19fc7e1d |
141 | $headers = array(); |
345c3a85 |
142 | $in_message = false; |
143 | $get_pos = true; |
144 | $hname = null; |
145 | foreach ($lines as $key=>&$line) { |
146 | if (!$in_message) { |
147 | if (!empty($line)) { |
148 | $id = intval($line); |
149 | $in_message = true; |
150 | $get_pos = true; |
7027794f |
151 | } |
345c3a85 |
152 | } elseif ($get_pos) { |
153 | $headers[$id] = array('beginning' => intval($line)); |
154 | $get_pos = false; |
155 | } elseif (empty($line) && empty($hname)) { |
156 | $in_message = false; |
157 | } elseif (empty($hname)) { |
158 | $hname = $line; |
159 | } elseif ($hname == 'date') { |
160 | $headers[$id][$hname] = @strtotime($line); |
161 | $hname = null; |
162 | } else { |
163 | BananaMimePart::decodeHeader($line, $hname); |
164 | $headers[$id][$hname] = $line; |
165 | $hname = null; |
7027794f |
166 | } |
345c3a85 |
167 | unset($lines[$key]); |
7027794f |
168 | } |
7027794f |
169 | return $headers; |
170 | } |
171 | |
172 | /** Add storage data in spool overview |
173 | */ |
174 | public function updateSpool(array &$messages) |
175 | { |
176 | foreach ($messages as $id=>&$data) { |
177 | if (isset(Banana::$spool->overview[$id])) { |
178 | Banana::$spool->overview[$id]->storage['offset'] = $data['beginning']; |
7027794f |
179 | } |
180 | } |
dc5f77ad |
181 | Banana::$spool->storage['size'] = @filesize($this->getFileName()); |
7027794f |
182 | } |
183 | |
184 | /** Return the indexes of the new messages since the give date |
185 | * @return Array(MSGNUM of new messages) |
186 | */ |
187 | public function getNewIndexes($since) |
188 | { |
703b83c3 |
189 | $this->open(); |
c28d3016 |
190 | if (is_null($this->file)) { |
191 | return array(); |
192 | } |
7027794f |
193 | if (is_null($this->new_messages)) { |
194 | $this->getCount(); |
195 | } |
196 | return range($this->count - $this->new_messages, $this->count - 1); |
197 | } |
198 | |
199 | /** Return wether or not the protocole can be used to add new messages |
200 | */ |
201 | public function canSend() |
202 | { |
203 | return true; |
204 | } |
205 | |
206 | /** Return false because we can't cancel a mail |
207 | */ |
208 | public function canCancel() |
209 | { |
210 | return false; |
211 | } |
212 | |
213 | /** Return the list of requested headers |
214 | * @return Array('header1', 'header2', ...) with the key 'dest' for the destination header |
215 | * and 'reply' for the reply header, eg: |
216 | * * for a mail: Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To') |
217 | * * for a post: Array('From', 'Subject', 'dest' => 'Newsgroups', 'reply' => 'Followup-To') |
218 | */ |
219 | public function requestedHeaders() |
220 | { |
221 | return Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To'); |
222 | } |
223 | |
224 | /** Send a message |
225 | * @return true if it was successfull |
226 | */ |
227 | public function send(BananaMessage &$message) |
228 | { |
e1debf92 |
229 | $headers = $message->getHeaders(); |
230 | $to = $headers['To']; |
231 | $subject = $headers['Subject']; |
232 | unset($headers['To']); |
233 | unset($headers['Subject']); |
234 | $hdrs = ''; |
235 | foreach ($headers as $key=>$value) { |
236 | if (!empty($value)) { |
237 | $hdrs .= "$key: $value\r\n"; |
238 | } |
239 | } |
240 | $body = $message->get(false); |
241 | return mail($to, $subject, $body, $hdrs); |
7027794f |
242 | } |
243 | |
244 | /** Cancel a message |
245 | * @return true if it was successfull |
246 | */ |
247 | public function cancel(BananaMessage &$message) |
248 | { |
249 | return false; |
250 | } |
251 | |
252 | /** Return the protocole name |
253 | */ |
254 | public function name() |
255 | { |
256 | return 'MBOX'; |
257 | } |
258 | |
e9360b11 |
259 | /** Return the spool filename |
260 | */ |
261 | public function filename() |
262 | { |
263 | @list($mail, $domain) = explode('@', Banana::$group); |
264 | $file = ""; |
265 | if (isset($domain)) { |
266 | $file = $domain . '_'; |
267 | } |
268 | return $file . $mail; |
269 | } |
270 | |
6a684b9b |
271 | /** Return the execution backtrace |
272 | */ |
273 | public function backtrace() |
274 | { |
275 | if ($this->debug) { |
276 | return $this->bt; |
277 | } else { |
278 | return null; |
279 | } |
280 | } |
281 | |
7027794f |
282 | ####### |
283 | # Filesystem functions |
284 | ####### |
285 | |
c28d3016 |
286 | protected function getFileName() |
7027794f |
287 | { |
c28d3016 |
288 | if (is_null(Banana::$group)) { |
7027794f |
289 | return null; |
290 | } |
c28d3016 |
291 | @list($mail, $domain) = explode('@', Banana::$group); |
e9360b11 |
292 | return Banana::$mbox_path . '/' . $mail; |
7027794f |
293 | } |
294 | |
295 | ####### |
296 | # MBox parser |
297 | ####### |
6c6b7002 |
298 | |
299 | /** Add the '-p' optioin for callHelper |
300 | */ |
dc5f77ad |
301 | private function getMBoxPosition(array &$options, $id = null) |
6c6b7002 |
302 | { |
303 | if (Banana::$spool->overview) { |
dc5f77ad |
304 | if (!is_null($id) && isset(Banana::$spool->overview[$id])) { |
6c6b7002 |
305 | $key = $id; |
306 | } else { |
dc5f77ad |
307 | $key = max(Banana::$spool->ids); |
6c6b7002 |
308 | if (!is_null($id) && $key >= $id) { |
309 | return; |
310 | } |
311 | } |
312 | if (isset(Banana::$spool->overview[$key]->storage['offset'])) { |
313 | $options[] = '-p ' . $key . ':' . Banana::$spool->overview[$key]->storage['offset']; |
314 | } |
315 | } |
316 | } |
7027794f |
317 | |
19fc7e1d |
318 | private function &callHelper($action, array $options = array(), array $headers = array()) |
7027794f |
319 | { |
19fc7e1d |
320 | $action .= ' -f ' . $this->getFileName(); |
321 | $cmd = Banana::$mbox_helper . " $action " . implode(' ', $options) . ' ' . implode(' ', $headers); |
322 | if ($this->debug) { |
19fc7e1d |
323 | $start = microtime(true); |
7027794f |
324 | } |
19fc7e1d |
325 | exec($cmd, $out, $return); |
326 | if ($this->debug) { |
6a684b9b |
327 | $this->bt[] = array('action' => $cmd, 'time' => (microtime(true) - $start), |
6c6b7002 |
328 | 'code' => $return, 'response' => count($out), 'error' => $return ? "Helper failed" : null); |
7027794f |
329 | } |
19fc7e1d |
330 | if ($return != 0) { |
331 | $this->_lasterrorno = 1; |
332 | $this->_lasterrorcode = "Helper failed"; |
333 | $out = null; |
7027794f |
334 | } |
19fc7e1d |
335 | return $out; |
7027794f |
336 | } |
337 | } |
338 | |
598a1c53 |
339 | // vim:set et sw=4 sts=4 ts=4 enc=utf-8: |
7027794f |
340 | ?> |