Merge a protocole independent version of spoolgen in Banana itself
[banana.git] / banana / banana.inc.php.in
CommitLineData
78cd27b3 1<?php
2/********************************************************************************
ab02e8a9 3* banana/banana.inc.php : banana main file
78cd27b3 4* --------------------------
5*
6* This file is part of the banana distribution
7* Copyright: See COPYING files that comes with this distribution
8********************************************************************************/
9
10class Banana
11{
78cd27b3 12
7972645b 13#######
14# Configuration variables
15#######
16
17### General ###
18 static public $profile = Array( 'signature' => '',
19 'headers' => array('From' => 'Anonymous <anonymouse@example.com>'),
20 'display' => 0,
21 'lastnews' => 0,
22 'locale' => 'fr_FR',
23 'subscribe' => array(),
24 'autoup' => 1);
25 static public $boxpattern;
ed3717e5 26 static public $withtabs = true;
7972645b 27
28### Spool ###
29 static public $spool_max = 3000;
30 static public $spool_tbefore = 5;
31 static public $spool_tafter = 5;
32 static public $spool_tmax = 50;
e0f557df 33 static public $spool_boxlist = true;
7972645b 34
35### Message processing ###
36 static public $msgparse_headers = array('content-disposition', 'content-transfer-encoding',
ab02e8a9 37 'content-type', 'content-id', 'date', 'followup-to',
38 'from', 'message-id', 'newsgroups', 'organization',
39 'references', 'subject', 'x-face', 'in-reply-to',
40 'to', 'cc', 'reply-to');
4f6a209a 41
7972645b 42### Message display ###
43 static public $msgshow_headers = array('from', 'newsgroups', 'followup-to', 'to', 'cc', 'reply-to',
44 'organization', 'date', 'references', 'in-reply-to');
bf791d69 45 static public $msgshow_mimeparts = array('multipart/report', 'multipart/mixed', 'text/html', 'text/plain', 'text/enriched', 'text', 'message');
7972645b 46 static public $msgshow_xface = true;
47 static public $msgshow_wrap = 78;
3be61f09 48 static public $msgshow_externalimages = false;
ed3717e5 49 static public $msgshow_withthread = true;
78cd27b3 50
87514711 51 /** Match an url
bf791d69 52 * Should be included in a regexp delimited using /, !, , or @ (eg: "/$url_regexp/ui")
87514711 53 * If it matches, return 3 main parts :
54 * \\1 and \\3 are delimiters
55 * \\2 is the url
56 *
57 * eg : preg_match("!$url_regexp!i", "[http://www.polytechnique.org]", $matches);
58 * $matches[1] = "["
59 * $matches[2] = "http://www.polytechnique.org"
60 * $matches[3] = "]"
61 */
e0f557df 62 static public $msgshow_url = '(["\[])?((?:[a-z]+:\/\/|www\.)(?:[\.\,\;\!]*[a-z\@0-9~%$£µ&i#\-+=_\/\?]+)+)(["\]])?';
78cd27b3 63
7972645b 64### Message edition ###
65 static public $msgedit_canattach = true;
66 static public $msgedit_maxfilesize = 100000;
f12fdb59 67 /** Global headers to use for messages
a1937df3 68 */
7972645b 69 static public $msgedit_headers = array('Mime-Version' => '1.0', 'User-Agent' => 'Banana @VERSION@');
bf791d69 70 /** Mime type order for quoting
71 */
72 static public $msgedit_mimeparts = array('multipart/report', 'multipart/mixed', 'text/plain', 'text/enriched', 'text/html', 'text', 'message');
73
7972645b 74### Protocole ###
a1937df3 75 /** News serveur to use
76 */
7972645b 77 static public $nntp_host = 'news://localhost:119/';
ab02e8a9 78
7972645b 79 static public $mbox_path = '/var/mail';
ab02e8a9 80
7972645b 81### Debug ###
ab02e8a9 82 static public $debug_nntp = false;
83 static public $debug_smarty = false;
84
85
7972645b 86#######
87# Constants
88#######
89
ab02e8a9 90 // Actions
91 const ACTION_BOX_NEEDED = 1; // mask
92 const ACTION_BOX_LIST = 2;
93 const ACTION_BOX_SUBS = 4;
94 const ACTION_MSG_LIST = 3;
95 const ACTION_MSG_READ = 5;
96 const ACTION_MSG_NEW = 9;
97 const ACTION_MSG_CANCEL = 17;
98
99 // Box list view
100 const BOXES_ALL = 0;
101 const BOXES_SUB = 1;
102 const BOXES_NEW = 2;
103
104 // Spool view mode
105 const SPOOL_ALL = 0;
106 const SPOOL_UNREAD = 1;
107
7972645b 108
109#######
110# Runtime variables
111#######
112
113 static public $protocole = null;
114 static public $spool = null;
115 static public $message = null;
116 static public $page = null;
117
118 static public $group = null;
119 static public $artid = null;
120 static public $action = null;
121 static public $part = null;
122 static public $first = null;
123
ab02e8a9 124 /** Class parameters storage
125 */
126 public $params;
78cd27b3 127
7972645b 128
129#######
130# Banana Implementation
131#######
132
ab02e8a9 133 /** Build the instance of Banana
134 * This constructor only call \ref loadParams, connect to the server, and build the Smarty page
135 * @param protocole Protocole to use
f6df9eb2 136 */
ab02e8a9 137 public function __construct($params = null, $protocole = 'NNTP', $pageclass = 'BananaPage')
78cd27b3 138 {
ab02e8a9 139 Banana::load('text.func');
140 if (is_null($params)) {
141 $this->params = $_GET;
1786dc36 142 } else {
ab02e8a9 143 $this->params = $params;
1786dc36 144 }
ab02e8a9 145 $this->loadParams();
1786dc36 146
ab02e8a9 147 // connect to protocole handler
ab02e8a9 148 $classname = 'Banana' . $protocole;
7972645b 149 if (!class_exists($classname)) {
150 Banana::load($protocole);
151 }
ab02e8a9 152 Banana::$protocole = new $classname(Banana::$group);
78cd27b3 153
ab02e8a9 154 // build the page
155 if ($pageclass == 'BananaPage') {
156 Banana::load('page');
3c3d29bb 157 }
ab02e8a9 158 Banana::$page = new $pageclass;
159 }
78cd27b3 160
ab02e8a9 161 /** Fill state vars (Banana::$group, Banana::$artid, Banana::$action, Banana;:$part, Banana::$first)
162 */
163 protected function loadParams()
164 {
165 Banana::$group = isset($this->params['group']) ? $this->params['group'] : null;
166 Banana::$artid = isset($this->params['artid']) ? $this->params['artid'] : null;
167 Banana::$first = isset($this->params['first']) ? $this->params['first'] : null;
168 Banana::$part = isset($this->params['part']) ? $this->params['part'] : 'text';
169
170 // Look for the action to execute
171 if (is_null(Banana::$group)) {
ded3974d 172 if (isset($this->params['action']) && $this->params['action'] == 'subscribe') {
ab02e8a9 173 Banana::$action = Banana::ACTION_BOX_SUBS;
78cd27b3 174 } else {
ab02e8a9 175 Banana::$action = Banana::ACTION_BOX_LIST;
78cd27b3 176 }
ab02e8a9 177 return;
178 }
179 $action = isset($this->params['action']) ? $this->params['action'] : null;
180 if (is_null(Banana::$artid)) {
181 if ($action == 'new') {
182 Banana::$action = Banana::ACTION_MSG_NEW;
183 } else {
184 Banana::$action = Banana::ACTION_MSG_LIST;
7a0e2710 185 }
ab02e8a9 186 return;
187 }
188 switch ($action) {
189 case 'new':
190 Banana::$action = Banana::ACTION_MSG_NEW;
191 return;
192 case 'cancel':
193 Banana::$action = Banana::ACTION_MSG_CANCEL;
194 return;
195 default:
196 Banana::$action = Banana::ACTION_MSG_READ;
78cd27b3 197 }
198 }
199
ab02e8a9 200 /** Run Banana
201 * This function need user profile to be initialised
202 */
203 public function run()
78cd27b3 204 {
ab02e8a9 205 // Configure locales
206 setlocale(LC_ALL, Banana::$profile['locale']);
78cd27b3 207
ab02e8a9 208 // Check if the state is valid
209 if (Banana::$protocole->lastErrNo()) {
d8d416c4 210 return Banana::$page->kill(_b_('Une erreur a été rencontrée lors de la connexion au serveur') . '<br />'
ab02e8a9 211 . Banana::$protocole->lastError());
212 }
213 if (!Banana::$protocole->isValid()) {
214 return Banana::$page->kill(_b_('Connexion non-valide'));
215 }
216 if (Banana::$action & Banana::ACTION_BOX_NEEDED) {
7972645b 217 if(Banana::$boxpattern && !preg_match('/' . Banana::$boxpattern . '/i', $group)) {
ab02e8a9 218 Banana::$page->setPage('group');
d8d416c4 219 return Banana::$page->kill(_b_("Ce newsgroup n'existe pas ou vous n'avez pas l'autorisation d'y accéder"));
ab02e8a9 220 }
221 }
78cd27b3 222
ab02e8a9 223 // Dispatch to the action handlers
224 switch (Banana::$action) {
225 case Banana::ACTION_BOX_SUBS:
226 $error = $this->action_subscribe();
227 break;
228 case Banana::ACTION_BOX_LIST:
229 $error = $this->action_listBoxes();
230 break;
231 case Banana::ACTION_MSG_LIST:
232 $error = $this->action_showThread(Banana::$group, Banana::$first);
233 break;
234 case Banana::ACTION_MSG_READ:
235 $error = $this->action_showMessage(Banana::$group, Banana::$artid, Banana::$part);
236 break;
237 case Banana::ACTION_MSG_NEW:
238 $error = $this->action_newMessage(Banana::$group, Banana::$artid);
239 break;
240 case Banana::ACTION_MSG_CANCEL:
241 $error = $this->action_cancelMessage(Banana::$group, Banana::$artid);
242 break;
243 default:
d8d416c4 244 $error = _b_("L'action demandée n'est pas supportée par Banana");
ab02e8a9 245 }
246
247 // Generate the page
248 if (is_string($error)) {
249 return Banana::$page->kill($error);
250 }
251 return Banana::$page->run();
78cd27b3 252 }
253
ab02e8a9 254 /**************************************************************************/
255 /* actions */
256 /**************************************************************************/
257 protected function action_saveSubs($groups)
78cd27b3 258 {
ab02e8a9 259 Banana::$profile['subscribe'] = $groups;
260 return true;
78cd27b3 261 }
262
ab02e8a9 263 protected function action_subscribe()
78cd27b3 264 {
ab02e8a9 265 Banana::$page->setPage('subscribe');
266 if (isset($_POST['validsubs'])) {
267 $this->action_saveSubs(array_keys($_POST['subscribe']));
268 Banana::$page->redirect();
856dc84a 269 }
ab02e8a9 270 $groups = Banana::$protocole->getBoxList(Banana::BOXES_ALL);
271 Banana::$page->assign('groups', $groups);
272 return true;
78cd27b3 273 }
274
ab02e8a9 275 protected function action_listBoxes()
7a0e2710 276 {
ab02e8a9 277 Banana::$page->setPage('forums');
278 $groups = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
279 $newgroups = Banana::$protocole->getBoxList(Banana::BOXES_NEW, Banana::$profile['lastnews'], true);
280 Banana::$page->assign('groups', $groups);
281 Banana::$page->assign('newgroups', $newgroups);
282 return true;
7a0e2710 283 }
284
ab02e8a9 285 protected function action_showThread($group, $first)
78cd27b3 286 {
ab02e8a9 287 Banana::$page->setPage('thread');
288 if (!$this->loadSpool($group)) {
289 return _b_('Impossible charger la liste des messages de ') . $group;
78cd27b3 290 }
e0f557df 291 if (Banana::$spool_boxlist) {
292 $groups = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
293 Banana::$page->assign('groups', $groups);
294 }
7972645b 295 Banana::$page->assign('msgbypage', Banana::$spool_tmax);
ab02e8a9 296 return true;
78cd27b3 297 }
298
ab02e8a9 299 protected function action_showMessage($group, $artid, $partid = 'text')
78cd27b3 300 {
ab02e8a9 301 Banana::$page->setPage('message');
9bc195d6 302 $istext = $partid == 'text' || $partid == 'source'
25c20c41 303 || preg_match('!^[-a-z0-9_]+/[-a-z0-9_]+$!', $partid);
9bc195d6 304 if ($istext) {
ab02e8a9 305 $this->loadSpool($group);
306 }
307 $msg =& $this->loadMessage($group, $artid);
308 if (is_null($msg)) {
309 $this->loadSpool($group);
310 $this->removeMessage($group, $artid);
d8d416c4 311 return _b_('Le message demandé n\'existe pas. Il est possible qu\'il ait été annulé');
ab02e8a9 312 }
313 if ($partid == 'xface') {
314 $msg->getXFace();
315 exit;
9bc195d6 316 } elseif (!$istext) {
ab02e8a9 317 $part = $msg->getPartById($partid);
318 if (!is_null($part)) {
319 $part->send(true);
52cafcf1 320 }
ab02e8a9 321 $part = $msg->getFile($partid);
322 if (!is_null($part)) {
323 $part->send();
78cd27b3 324 }
ab02e8a9 325 exit;
9bc195d6 326 } elseif ($partid == 'text') {
327 Banana::$page->assign('body', $msg->getFormattedBody());
328 } elseif ($partid == 'source') {
b188e462 329 $text = Banana::$protocole->getMessageSource($artid);
330 if (!is_utf8($text)) {
331 $text = utf8_encode($text);
332 }
333 Banana::$page->assign('body', '<pre>' . banana_htmlentities($text) . '</pre>');
9bc195d6 334 } else {
335 Banana::$page->assign('body', $msg->getFormattedBody($partid));
78cd27b3 336 }
9bc195d6 337
7972645b 338 if (Banana::$profile['autoup']) {
339 Banana::$spool->markAsRead($artid);
340 }
e0f557df 341 if (Banana::$spool_boxlist) {
342 $groups = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
343 Banana::$page->assign('groups', $groups);
344 }
ab02e8a9 345 Banana::$page->assign_by_ref('message', $msg);
7972645b 346 Banana::$page->assign('headers', Banana::$msgshow_headers);
ab02e8a9 347 return true;
78cd27b3 348 }
349
ab02e8a9 350 protected function action_newMessage($group, $artid)
78cd27b3 351 {
ab02e8a9 352 Banana::$page->setPage('new');
353 if (!Banana::$protocole->canSend()) {
354 return _b_('Vous n\'avez pas le droit de poster');
355 }
356 $hdrs = Banana::$protocole->requestedHeaders();
357 $headers = array();
358 foreach ($hdrs as $header) {
359 $headers[$header] = array('name' => BananaMessage::translateHeaderName($header));
7972645b 360 if (isset(Banana::$profile['headers'][$header])) {
361 $headers[$header]['fixed'] = Banana::$profile['headers'][$header];
78cd27b3 362 }
363 }
ab02e8a9 364 if (isset($_POST['sendmessage'])) {
365 $hdr_values = array();
366 foreach ($hdrs as $header) {
367 $hdr_values[$header] = isset($headers[$header]['fixed']) ? $headers[$header]['fixed'] : @$_POST[$header];
f6df9eb2 368 }
ab02e8a9 369 if ($artid) {
370 $old =& $this->loadMessage($group, $artid);
371 $hdr_values['References'] = $old->getHeaderValue('references') . $old->getHeaderValue('message-id');
856dc84a 372 }
ab02e8a9 373 $msg = null;
374 if (empty($hdr_values['Subject'])) {
375 Banana::$page->trig(_b_('Le message doit avoir un sujet'));
7972645b 376 } elseif (Banana::$msgedit_canattach && isset($_FILES['attachment'])) {
ab02e8a9 377 $uploaded = $_FILES['attachment'];
378 if (!is_uploaded_file($uploaded['tmp_name'])) {
d8d416c4 379 Banana::$page->trig(_b_('Une erreur est survenue lors du téléchargement du fichier'));
ab02e8a9 380 } else {
381 $msg = BananaMessage::newMessage($hdr_values, $_POST['body'], $uploaded);
382 }
383 } else {
384 $msg = BananaMessage::newMessage($hdr_values, $_POST['body']);
385 }
386 if (!is_null($msg)) {
387 if (Banana::$protocole->send($msg)) {
388 Banana::$page->redirect(array('group' => $group, 'artid' => $artid));
389 }
390 Banana::$page->trig(_b_('Une erreur est survenue lors de l\'envoi du message :') . '<br />'
391 . Banana::$protocole->lastError());
f6df9eb2 392 }
78cd27b3 393 } else {
ab02e8a9 394 if (!is_null($artid)) {
395 $msg =& $this->loadMessage($group, $artid);
d8d416c4 396 $body = $msg->getSender() . _b_(' a écrit :') . "\n" . $msg->quote();
ab02e8a9 397 $subject = $msg->getHeaderValue('subject');
398 $headers['Subject']['user'] = 'Re: ' . preg_replace("/^re\s*:\s*/i", '', $subject);
399 $target = $msg->getHeaderValue($hdrs['reply']);
400 if (empty($target)) {
401 $target = $group;
402 }
403 $headers[$hdrs['dest']]['user'] =& $target;
404 } else {
405 $body = '';
406 $headers[$hdrs['dest']]['user'] = $group;
856dc84a 407 }
7972645b 408 if (Banana::$profile['signature']) {
409 $body .= "\n\n-- \n" . Banana::$profile['signature'];
ab02e8a9 410 }
411 Banana::$page->assign('body', $body);
78cd27b3 412 }
ab02e8a9 413
7972645b 414 Banana::$page->assign('maxfilesize', Banana::$msgedit_maxfilesize);
415 Banana::$page->assign('can_attach', Banana::$msgedit_canattach);
ab02e8a9 416 Banana::$page->assign('headers', $headers);
856dc84a 417 return true;
78cd27b3 418 }
419
ab02e8a9 420 protected function action_cancelMessage($group, $artid)
78cd27b3 421 {
ab02e8a9 422 Banana::$page->setPage('cancel');
423 $msg =& $this->loadMessage($group, $artid);
424 if (!$msg->canCancel()) {
425 return _b_('Vous n\'avez pas les droits suffisants pour supprimer ce message');
426 }
427 if (isset($_POST['cancel'])) {
428 $this->loadSpool($group);
429 $ndx = Banana::$spool->getNdX($id) - 1;
430 if (!Banana::$protocole->cancel($msg)) {
431 return _b_('Une erreur s\'est produite lors de l\'annulation du message :') . '<br />'
432 . Banana::$protocole->lastError();
433 }
434 if ($ndx < 50) {
435 $ndx = 0;
436 }
437 $this->removeMessage($group, $artid);
438 Banana::$page->redirect(Array('group' => $group, 'first' => $ndx));
856dc84a 439 }
d759a2ba 440
ab02e8a9 441 Banana::$page->assign_by_ref('message', $msg);
d759a2ba 442 Banana::$page->assign('body', $msg->getFormattedBody());
443 Banana::$page->assign('headers', Banana::$msgshow_headers);
856dc84a 444 return true;
78cd27b3 445 }
446
ab02e8a9 447 /**************************************************************************/
a40f3908 448 /* Spoolgen functions */
449 /**************************************************************************/
450
451 private function checkErrors()
452 {
453 if (Banana::$protocole->lastErrno()) {
454 echo "\nL'erreur suivante s'est produite : "
455 . Banana::$protocole->lastErrno() . " "
456 . Banana::$protocole->lastError() . "\n";
457 return false;
458 }
459 return true;
460 }
461
462 static public function createAllSpool(array $protos)
463 {
464 foreach ($protos as $proto) {
465 $banana = new Banana(array(), $proto);
466
467 if (!$banana->checkErrors()) {
468 continue;
469 }
470 $groups = Banana::$protocole->getBoxList();
471 if (!$banana->checkErrors()) {
472 continue;
473 }
474
475 print "** $proto **\n";
476 foreach (array_keys($groups) as $g) {
477 print "Generating spool for $g : ";
478 Banana::$group = $g;
479 $spool = $banana->loadSpool($g);
480 if (!$banana->checkErrors()) {
481 break;
482 }
483 print "done.\n";
484 unset($spool);
485 }
486 print "\n";
487 }
488 }
489
490 /**************************************************************************/
ab02e8a9 491 /* Private functions */
492 /**************************************************************************/
493
916e4a56 494 protected function loadSpool($group)
78cd27b3 495 {
ab02e8a9 496 Banana::load('spool');
497 if (!Banana::$spool || Banana::$spool->group != $group) {
e0f557df 498 $clean = false;
ab02e8a9 499 if ($group == @$_SESSION['banana_group'] && isset($_SESSION['banana_spool'])) {
500 Banana::$spool = unserialize($_SESSION['banana_spool']);
7b98ea62 501 $clean = @(Banana::$profile['lastnews'] != $_SESSION['banana_lastnews']);
a5980eae 502 } else {
503 unset($_SESSION['banana_message']);
504 unset($_SESSION['banana_artid']);
505 unset($_SESSION['banana_showhdr']);
7972645b 506 }
7b98ea62 507 BananaSpool::getSpool($group, Banana::$profile['lastnews'], Banana::$profile['autoup'] || $clean);
ab02e8a9 508 $_SESSION['banana_group'] = $group;
7972645b 509 if (!Banana::$profile['display']) {
510 $_SESSION['banana_spool'] = serialize(Banana::$spool);
7b98ea62 511 $_SESSION['banana_lastnews'] = Banana::$profile['lastnews'];
7972645b 512 }
ab02e8a9 513 Banana::$spool->setMode(Banana::$profile['display'] ? Banana::SPOOL_UNREAD : Banana::SPOOL_ALL);
78cd27b3 514 }
ab02e8a9 515 return true;
78cd27b3 516 }
517
916e4a56 518 protected function &loadMessage($group, $artid)
78cd27b3 519 {
ab02e8a9 520 Banana::load('message');
521 if ($group == @$_SESSION['banana_group'] && $artid == @$_SESSION['banana_artid']
522 && isset($_SESSION['banana_message'])) {
523 $message = unserialize($_SESSION['banana_message']);
7972645b 524 Banana::$msgshow_headers = $_SESSION['banana_showhdr'];
ab02e8a9 525 } else {
526 $message = Banana::$protocole->getMessage($artid);
527 $_SESSION['banana_group'] = $group;
528 $_SESSION['banana_artid'] = $artid;
529 $_SESSION['banana_message'] = serialize($message);
7972645b 530 $_SESSION['banana_showhdr'] = Banana::$msgshow_headers;
ab02e8a9 531 }
532 Banana::$message =& $message;
533 return $message;
78cd27b3 534 }
d28aa62d 535
916e4a56 536 protected function removeMessage($group, $artid)
d28aa62d 537 {
ab02e8a9 538 Banana::$spool->delId($artid);
539 if ($group == $_SESSION['banana_group']) {
7972645b 540 if (!Banana::$profile['display']) {
541 $_SESSION['banana_spool'] = serialize(Banana::$spool);
542 }
ab02e8a9 543 if ($artid == $_SESSION['banana_artid']) {
544 unset($_SESSION['banana_message']);
545 unset($_SESSION['banana_showhdr']);
546 unset($_SESSION['banana_artid']);
d28aa62d 547 }
d28aa62d 548 }
ab02e8a9 549 return true;
d28aa62d 550 }
f12fdb59 551
ab02e8a9 552 static private function load($file)
f12fdb59 553 {
ab02e8a9 554 $file = strtolower($file) . '.inc.php';
555 if (!@include_once dirname(__FILE__) . "/$file") {
556 require_once $file;
557 }
f12fdb59 558 }
78cd27b3 559}
560
d8d416c4 561// vim:set et sw=4 sts=4 ts=4 enc=utf-8:
78cd27b3 562?>