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(); |
6c6b7002 |
108 | $this->getMBoxPosition($options); |
19fc7e1d |
109 | $val =& $this->callHelper('-c', $options); |
110 | if (!$val) { |
111 | return 0; |
112 | } |
113 | return intval(trim($val[0])); |
7027794f |
114 | } |
115 | |
116 | /** Return the indexes of the messages presents in the Box |
117 | * @return Array(number of messages, MSGNUM of the first message, MSGNUM of the last message) |
118 | */ |
119 | public function getIndexes() |
120 | { |
19fc7e1d |
121 | $count = $this->getCount(); |
122 | return array($count, 0, $count - 1); |
7027794f |
123 | } |
124 | |
125 | /** Return the message headers (in BananaMessage) for messages from firstid to lastid |
126 | * @return Array(id => array(headername => headervalue)) |
127 | */ |
128 | public function &getMessageHeaders($firstid, $lastid, array $msg_headers = array()) |
129 | { |
19fc7e1d |
130 | $headers = null; |
131 | $options = array(); |
132 | $options[] = "-m $firstid:$lastid"; |
6c6b7002 |
133 | $this->getMboxPosition($options, $firstid); |
19fc7e1d |
134 | $lines =& $this->callHelper('-d', $options, $msg_headers); |
135 | if (!$lines) { |
c28d3016 |
136 | return $headers; |
137 | } |
19fc7e1d |
138 | $headers = array(); |
139 | while ($lines) { |
140 | $id = array_shift($lines); |
141 | if ($id === '') { |
142 | continue; |
143 | } |
144 | $offset = array_shift($lines); |
145 | if ($offset === '') { |
146 | continue; |
147 | } |
148 | $id = intval($id); |
149 | $headers[$id] = array('beginning' => intval($offset)); |
150 | while (true) { |
151 | $hname = array_shift($lines); |
152 | if ($hname === '') { |
153 | break; |
154 | } |
155 | $hval = array_shift($lines); |
156 | if ($hval === '') { |
157 | break; |
7027794f |
158 | } |
19fc7e1d |
159 | if ($hname == 'date') { |
160 | $headers[$id][$hname] = @strtotime($hval); |
7027794f |
161 | } else { |
19fc7e1d |
162 | $headers[$id][$hname] = $hval; |
7027794f |
163 | } |
164 | } |
19fc7e1d |
165 | if (!isset($headers[$id]['date'])) { |
166 | print_r($id); |
167 | print_r($offset); |
168 | print_r($headers[$id]); |
169 | } |
7027794f |
170 | } |
19fc7e1d |
171 | array_walk_recursive($headers, array('BananaMimePart', 'decodeHeader')); |
7027794f |
172 | return $headers; |
173 | } |
174 | |
175 | /** Add storage data in spool overview |
176 | */ |
177 | public function updateSpool(array &$messages) |
178 | { |
179 | foreach ($messages as $id=>&$data) { |
180 | if (isset(Banana::$spool->overview[$id])) { |
181 | Banana::$spool->overview[$id]->storage['offset'] = $data['beginning']; |
7027794f |
182 | } |
183 | } |
184 | } |
185 | |
186 | /** Return the indexes of the new messages since the give date |
187 | * @return Array(MSGNUM of new messages) |
188 | */ |
189 | public function getNewIndexes($since) |
190 | { |
703b83c3 |
191 | $this->open(); |
c28d3016 |
192 | if (is_null($this->file)) { |
193 | return array(); |
194 | } |
7027794f |
195 | if (is_null($this->new_messages)) { |
196 | $this->getCount(); |
197 | } |
198 | return range($this->count - $this->new_messages, $this->count - 1); |
199 | } |
200 | |
201 | /** Return wether or not the protocole can be used to add new messages |
202 | */ |
203 | public function canSend() |
204 | { |
205 | return true; |
206 | } |
207 | |
208 | /** Return false because we can't cancel a mail |
209 | */ |
210 | public function canCancel() |
211 | { |
212 | return false; |
213 | } |
214 | |
215 | /** Return the list of requested headers |
216 | * @return Array('header1', 'header2', ...) with the key 'dest' for the destination header |
217 | * and 'reply' for the reply header, eg: |
218 | * * for a mail: Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To') |
219 | * * for a post: Array('From', 'Subject', 'dest' => 'Newsgroups', 'reply' => 'Followup-To') |
220 | */ |
221 | public function requestedHeaders() |
222 | { |
223 | return Array('From', 'Subject', 'dest' => 'To', 'Cc', 'Bcc', 'reply' => 'Reply-To'); |
224 | } |
225 | |
226 | /** Send a message |
227 | * @return true if it was successfull |
228 | */ |
229 | public function send(BananaMessage &$message) |
230 | { |
e1debf92 |
231 | $headers = $message->getHeaders(); |
232 | $to = $headers['To']; |
233 | $subject = $headers['Subject']; |
234 | unset($headers['To']); |
235 | unset($headers['Subject']); |
236 | $hdrs = ''; |
237 | foreach ($headers as $key=>$value) { |
238 | if (!empty($value)) { |
239 | $hdrs .= "$key: $value\r\n"; |
240 | } |
241 | } |
242 | $body = $message->get(false); |
243 | return mail($to, $subject, $body, $hdrs); |
7027794f |
244 | } |
245 | |
246 | /** Cancel a message |
247 | * @return true if it was successfull |
248 | */ |
249 | public function cancel(BananaMessage &$message) |
250 | { |
251 | return false; |
252 | } |
253 | |
254 | /** Return the protocole name |
255 | */ |
256 | public function name() |
257 | { |
258 | return 'MBOX'; |
259 | } |
260 | |
e9360b11 |
261 | /** Return the spool filename |
262 | */ |
263 | public function filename() |
264 | { |
265 | @list($mail, $domain) = explode('@', Banana::$group); |
266 | $file = ""; |
267 | if (isset($domain)) { |
268 | $file = $domain . '_'; |
269 | } |
270 | return $file . $mail; |
271 | } |
272 | |
6a684b9b |
273 | /** Return the execution backtrace |
274 | */ |
275 | public function backtrace() |
276 | { |
277 | if ($this->debug) { |
278 | return $this->bt; |
279 | } else { |
280 | return null; |
281 | } |
282 | } |
283 | |
7027794f |
284 | ####### |
285 | # Filesystem functions |
286 | ####### |
287 | |
c28d3016 |
288 | protected function getFileName() |
7027794f |
289 | { |
c28d3016 |
290 | if (is_null(Banana::$group)) { |
7027794f |
291 | return null; |
292 | } |
c28d3016 |
293 | @list($mail, $domain) = explode('@', Banana::$group); |
e9360b11 |
294 | return Banana::$mbox_path . '/' . $mail; |
7027794f |
295 | } |
296 | |
297 | ####### |
298 | # MBox parser |
299 | ####### |
6c6b7002 |
300 | |
301 | /** Add the '-p' optioin for callHelper |
302 | */ |
303 | private function getMBoxPosition(array &$option, $id = null) |
304 | { |
305 | if (Banana::$spool->overview) { |
306 | if (!is_null($id) && Banana::$spool->overview[$id]) { |
307 | $key = $id; |
308 | } else { |
309 | $key = max(array_keys(Banana::$spool->overview)); |
310 | if (!is_null($id) && $key >= $id) { |
311 | return; |
312 | } |
313 | } |
314 | if (isset(Banana::$spool->overview[$key]->storage['offset'])) { |
315 | $options[] = '-p ' . $key . ':' . Banana::$spool->overview[$key]->storage['offset']; |
316 | } |
317 | } |
318 | } |
7027794f |
319 | |
19fc7e1d |
320 | private function &callHelper($action, array $options = array(), array $headers = array()) |
7027794f |
321 | { |
19fc7e1d |
322 | $action .= ' -f ' . $this->getFileName(); |
323 | $cmd = Banana::$mbox_helper . " $action " . implode(' ', $options) . ' ' . implode(' ', $headers); |
324 | if ($this->debug) { |
19fc7e1d |
325 | $start = microtime(true); |
7027794f |
326 | } |
19fc7e1d |
327 | exec($cmd, $out, $return); |
328 | if ($this->debug) { |
6a684b9b |
329 | $this->bt[] = array('action' => $cmd, 'time' => (microtime(true) - $start), |
6c6b7002 |
330 | 'code' => $return, 'response' => count($out), 'error' => $return ? "Helper failed" : null); |
7027794f |
331 | } |
19fc7e1d |
332 | if ($return != 0) { |
333 | $this->_lasterrorno = 1; |
334 | $this->_lasterrorcode = "Helper failed"; |
335 | $out = null; |
7027794f |
336 | } |
19fc7e1d |
337 | return $out; |
7027794f |
338 | } |
339 | } |
340 | |
598a1c53 |
341 | // vim:set et sw=4 sts=4 ts=4 enc=utf-8: |
7027794f |
342 | ?> |