ab02e8a9 |
1 | <?php |
2 | /******************************************************************************** |
3 | * banana/nntp.inc.php : NNTP protocole handler |
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__) . '/message.inc.php'; |
12 | require_once dirname(__FILE__) . '/nntpcore.inc.php'; |
13 | require_once dirname(__FILE__) . '/protocoleinterface.inc.php'; |
14 | |
15 | class BananaNNTP extends BananaNNTPCore implements BananaProtocoleInterface |
16 | { |
ab02e8a9 |
17 | private $description = null; |
18 | private $ingroup = null; |
19 | |
20 | private $mode = null; |
21 | private $boxes = null; |
22 | |
23 | /** Build a protocole handler plugged on the given box |
24 | */ |
916e4a56 |
25 | public function __construct() |
ab02e8a9 |
26 | { |
7972645b |
27 | $url = parse_url(Banana::$nntp_host); |
ab02e8a9 |
28 | if ($url['scheme'] == 'nntps' || $url['scheme'] == 'snntp') { |
29 | $url['host'] = 'ssl://' . $url['host']; |
30 | } |
31 | if (!isset($url['port'])) { |
32 | $url['port'] = 119; |
33 | } |
34 | if (!isset($url['user'])) { |
35 | parent::__construct($url['host'], $url['port']); |
36 | } else { |
37 | parent::__construct($url['host'], $url['port'], 120, false); |
38 | $this->authinfo($url['user'], $url['pass']); |
39 | } |
ab02e8a9 |
40 | } |
41 | |
42 | /** Return the descript;ion of the current box |
43 | */ |
44 | public function getDescription() |
45 | { |
46 | if ($this->description) { |
47 | return $this->description; |
48 | } |
916e4a56 |
49 | $descs = $this->xgtitle(Banana::$group); |
50 | if (isset($descs[Banana::$group])) { |
51 | $this->description = $descs[Banana::$group]; |
ab02e8a9 |
52 | } |
53 | return $this->description; |
54 | } |
55 | |
56 | /** Return the list of the boxes |
57 | * @param mode Kind of boxes to list |
58 | * @param since date of last check (for new boxes and new messages) |
59 | * @return Array(boxname => array(desc => boxdescripton, msgnum => number of message, unread =>number of unread messages) |
60 | */ |
61 | public function getBoxList($mode = Banana::BOXES_ALL, $since = 0, $withstats = false) |
62 | { |
63 | if (!is_array($this->boxes) || $this->mode != $mode) { |
64 | $descs = $this->xgtitle(); |
65 | if ($mode == Banana::BOXES_NEW && $since) { |
66 | $list = $this->newgroups($since); |
67 | } else { |
68 | $list = $this->listGroups(); |
69 | if ($mode == Banana::BOXES_SUB) { |
70 | $sub = array_flip(Banana::$profile['subscribe']); |
71 | $list = array_intersect_key($list, $sub); |
72 | } |
73 | } |
74 | $this->boxes = array(); |
75 | foreach ($list as $group=>&$infos) { |
76 | if (isset($descs[$group])) { |
77 | $desc = $descs[$group]; |
78 | if (!is_utf8($desc)) { |
79 | $desc = utf8_encode($desc); |
80 | } |
81 | $this->boxes[$group] = array('desc' => $desc); |
82 | } else { |
83 | $this->boxes[$group] = array('desc' => null); |
84 | } |
85 | } |
86 | ksort($this->boxes); |
87 | } |
88 | if ($withstats) { |
89 | foreach ($this->boxes as $group=>&$desc) { |
90 | list($msgnum, $first, $last, $groupname) = $this->group($group); |
91 | $this->ingroup = $group; |
92 | $new = count($this->newnews($group, $since)); |
93 | $desc['msgnum'] = $msgnum; |
94 | $desc['unread'] = $new; |
95 | } |
96 | } |
97 | return $this->boxes; |
98 | } |
99 | |
100 | /** Return a message |
101 | * @param id Id of the emssage (can be either an Message-id or a message index) |
ab02e8a9 |
102 | * @return A BananaMessage or null if the given id can't be retreived |
103 | */ |
9bc195d6 |
104 | public function &getMessage($id) |
ab02e8a9 |
105 | { |
9bc195d6 |
106 | if (is_numeric($id) && Banana::$group != $this->ingroup) { |
ab02e8a9 |
107 | if (is_null(Banana::$spool)) { |
916e4a56 |
108 | $this->group(Banana::$group); |
109 | $this->ingroup = Banana::$group; |
ab02e8a9 |
110 | } else { |
111 | $id = array_search($id, Banana::$spool->ids); |
112 | } |
113 | } |
114 | $data = $this->article($id); |
115 | if ($data !== false) { |
116 | return new BananaMessage($data); |
117 | } |
118 | return null; |
119 | } |
120 | |
9bc195d6 |
121 | /** Return the sources of the message |
122 | */ |
123 | public function getMessageSource($id) |
124 | { |
125 | if (is_numeric($id) && Banana::$group != $this->ingroup) { |
126 | if (is_null(Banana::$spool)) { |
127 | $this->group(Banana::$group); |
128 | $this->ingroup = Banana::$group; |
129 | } else { |
130 | $id = array_search($id, Banana::$spool->ids); |
131 | } |
132 | } |
133 | $data = $this->article($id); |
134 | if ($data !== false) { |
135 | return implode("\n", $data); |
136 | } |
137 | return null; |
138 | } |
139 | |
ab02e8a9 |
140 | /** Return the indexes of the messages presents in the Box |
141 | * @return Array(number of messages, MSGNUM of the first message, MSGNUM of the last message) |
142 | */ |
143 | public function getIndexes() |
144 | { |
916e4a56 |
145 | list($msgnum, $first, $last, $groupname) = $this->group(Banana::$group); |
146 | $this->ingroup = Banana::$group; |
ab02e8a9 |
147 | return array($msgnum, $first, $last); |
148 | } |
149 | |
150 | /** Return the message headers (in BananaMessage) for messages from firstid to lastid |
151 | * @return Array(id => array(headername => headervalue)) |
152 | */ |
153 | public function &getMessageHeaders($firstid, $lastid, array $msg_headers = array()) |
154 | { |
155 | $messages = array(); |
156 | foreach ($msg_headers as $header) { |
157 | $headers = $this->xhdr($header, $firstid, $lastid); |
158 | array_walk($headers, array('BananaMimePart', 'decodeHeader')); |
159 | $header = strtolower($header); |
160 | if ($header == 'date') { |
161 | $headers = array_map('strtotime', $headers); |
162 | } |
163 | foreach ($headers as $id=>&$value) { |
164 | if (!isset($messages[$id])) { |
165 | $messages[$id] = array(); |
166 | } |
167 | $messages[$id][$header] =& $value; |
168 | } |
169 | } |
170 | return $messages; |
171 | } |
172 | |
173 | /** Add protocole specific data in the spool |
174 | */ |
175 | public function updateSpool(array &$messages) |
176 | { |
177 | return true; |
178 | } |
179 | |
180 | /** Return the indexes of the new messages since the give date |
181 | * @return Array(MSGNUM of new messages) |
182 | */ |
183 | public function getNewIndexes($since) |
184 | { |
916e4a56 |
185 | return $this->newnews(Banana::$group, $since); |
ab02e8a9 |
186 | } |
187 | |
188 | /** Return true if can post |
189 | */ |
190 | public function canSend() |
191 | { |
192 | return $this->isValid(); |
193 | } |
194 | |
195 | /** Return true if can cancel |
196 | */ |
197 | public function canCancel() |
198 | { |
199 | return $this->isValid(); |
200 | } |
201 | |
202 | /** Return the list of requested header for a new post |
203 | */ |
204 | public function requestedHeaders() |
205 | { |
206 | return Array('From', 'Subject', 'dest' => 'Newsgroups', 'reply' => 'Followup-To', 'Organization'); |
207 | } |
208 | |
209 | /** Send the message |
210 | */ |
211 | public function send(BananaMessage &$message) |
212 | { |
213 | $sources = $message->get(true); |
214 | return $this->post($sources); |
215 | } |
216 | |
217 | /** Cancel the message |
218 | */ |
219 | public function cancel(BananaMessage &$message) |
220 | { |
221 | $headers = Array('From' => Banana::$profile['From'], |
916e4a56 |
222 | 'Newsgroups' => Banana::$group, |
ab02e8a9 |
223 | 'Subject' => 'cmsg ' . $message->getHeaderValue('message-id'), |
224 | 'Control' => 'cancel ' . $message->getHeaderValue('message-id')); |
7972645b |
225 | $headers = array_merge($headers, Banana::$msgedit_headers); |
ab02e8a9 |
226 | $body = 'Message canceled with Banana'; |
227 | $msg = BananaMessage::newMessage($headers, $body); |
228 | return $this->send($msg); |
229 | } |
230 | |
231 | /** Return the protocole name |
232 | */ |
233 | public function name() |
234 | { |
235 | return 'NNTP'; |
236 | } |
ab02e8a9 |
237 | |
7972645b |
238 | /** Return the filename for the spool |
239 | */ |
240 | public function filename() |
241 | { |
242 | $url = parse_url(Banana::$nntp_host); |
243 | $file = ''; |
244 | if (isset($url['host'])) { |
245 | $file .= $url['host'] . '_'; |
246 | } |
247 | if (isset($url['port'])) { |
248 | $file .= $url['port'] . '_'; |
249 | } |
250 | $file .= Banana::$group; |
251 | return $file; |
252 | } |
ab02e8a9 |
253 | } |
ab02e8a9 |
254 | |
255 | // vim:set et sw=4 sts=4 ts=4: |
256 | ?> |