banana/banana.inc.php.in

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