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 class Banana
  11 {
  12
  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;
  26     static public $withtabs = true;
  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;
  33     static public $spool_boxlist = true;
  34
  35 ### Message processing ###
  36     static public $msgparse_headers = array('content-disposition', 'content-transfer-encoding',
  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');
  41
  42 ### Message display ###
  43     static public $msgshow_headers   = array('from', 'newsgroups', 'followup-to', 'to', 'cc', 'reply-to',
  44                                        'organization', 'date', 'references', 'in-reply-to');
  45     static public $msgshow_mimeparts = array('multipart/report', 'multipart/mixed', 'text/html', 'text/plain', 'text/enriched', 'text', 'message');
  46     static public $msgshow_xface     = true;
  47     static public $msgshow_wrap      = 78;
  48     static public $msgshow_externalimages = false;
  49     static public $msgshow_withthread = true;
  50
  51     /** Match an url
  52      * Should be included in a regexp delimited using /, !, , or @ (eg: "/$url_regexp/ui")
  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      */
  62     static public $msgshow_url     = '(["\[])?((?:[a-z]+:\/\/|www\.)(?:[\.\,\;\!]*[a-z\@0-9~%$£µ&i#\-+=_\/\?]+)+)(["\]])?';
  63
  64 ### Message edition ###
  65     static public $msgedit_canattach  = true;
  66     static public $msgedit_maxfilesize = 100000;
  67     /** Global headers to use for messages
  68      */
  69     static public $msgedit_headers  = array('Mime-Version' => '1.0', 'User-Agent' => 'Banana @VERSION@');
  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
  74 ### Protocole ###
  75     /** News serveur to use
  76      */
  77     static public $nntp_host   = 'news://localhost:119/';
  78
  79     static public $mbox_path   = '/var/mail';
  80
  81 ### Debug ###
  82     static public $debug_nntp   = false;
  83     static public $debug_smarty = false;
  84
  85
  86 #######
  87 # Constants
  88 #######
  89
  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
 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
 124     /** Class parameters storage
 125      */
 126     public $params;
 127
 128
 129 #######
 130 # Banana Implementation
 131 #######
 132
 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
 136      */
 137     public function __construct($params = null, $protocole = 'NNTP', $pageclass = 'BananaPage')
 138     {
 139         Banana::load('text.func');
 140         if (is_null($params)) {
 141             $this->params = $_GET;
 142         } else {
 143             $this->params = $params;
 144         }
 145         $this->loadParams();
 146
 147         // connect to protocole handler
 148         $classname = 'Banana' . $protocole;
 149         if (!class_exists($classname)) {
 150             Banana::load($protocole);
 151         }
 152         Banana::$protocole = new $classname(Banana::$group);
 153
 154         // build the page
 155         if ($pageclass == 'BananaPage') {
 156             Banana::load('page');
 157         }
 158         Banana::$page = new $pageclass;
 159     }
 160
 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)) {
 172             if (isset($this->params['action']) && $this->params['action'] == 'subscribe') {
 173                 Banana::$action = Banana::ACTION_BOX_SUBS;
 174             } else {
 175                 Banana::$action = Banana::ACTION_BOX_LIST;
 176             }
 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;
 185             }
 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;
 197         }
 198     }
 199
 200     /** Run Banana
 201      * This function need user profile to be initialised
 202      */
 203     public function run()
 204     {
 205         // Configure locales
 206         setlocale(LC_ALL,  Banana::$profile['locale']);
 207
 208         // Check if the state is valid
 209         if (Banana::$protocole->lastErrNo()) {
 210             return Banana::$page->kill(_b_('Une erreur a été rencontrée lors de la connexion au serveur') . '<br />'
 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) {
 217             if(Banana::$boxpattern && !preg_match('/' . Banana::$boxpattern . '/i', $group)) {
 218                 Banana::$page->setPage('group');
 219                 return Banana::$page->kill(_b_("Ce newsgroup n'existe pas ou vous n'avez pas l'autorisation d'y accéder"));
 220             }
 221         }
 222
 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:
 244             $error = _b_("L'action demandée n'est pas supportée par Banana");
 245         }
 246
 247         // Generate the page
 248         if (is_string($error)) {
 249             return Banana::$page->kill($error);
 250         }
 251         return Banana::$page->run();
 252     }
 253
 254     /**************************************************************************/
 255     /* actions                                                                */
 256     /**************************************************************************/
 257     protected function action_saveSubs($groups)
 258     {
 259         Banana::$profile['subscribe'] = $groups;
 260         return true;
 261     }
 262
 263     protected function action_subscribe()
 264     {
 265         Banana::$page->setPage('subscribe');
 266         if (isset($_POST['validsubs'])) {
 267             $this->action_saveSubs(array_keys($_POST['subscribe']));
 268             Banana::$page->redirect();
 269         }
 270         $groups = Banana::$protocole->getBoxList(Banana::BOXES_ALL);
 271         Banana::$page->assign('groups', $groups);
 272         return true;
 273     }
 274
 275     protected function action_listBoxes()
 276     {
 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;
 283     }
 284
 285     protected function action_showThread($group, $first)
 286     {
 287         Banana::$page->setPage('thread');
 288         if (!$this->loadSpool($group)) {
 289             return _b_('Impossible charger la liste des messages de ') . $group;
 290         }
 291         if (Banana::$spool_boxlist) {
 292             $groups = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
 293             Banana::$page->assign('groups', $groups);
 294         }
 295         Banana::$page->assign('msgbypage', Banana::$spool_tmax);
 296         return true;
 297     }
 298
 299     protected function action_showMessage($group, $artid, $partid = 'text')
 300     {
 301         Banana::$page->setPage('message');
 302         $istext = $partid == 'text' || $partid == 'source'
 303                 || preg_match('!^[-a-z0-9_]+/[-a-z0-9_]+$!', $partid);
 304         if ($istext) {
 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);
 311             return _b_('Le message demandé n\'existe pas. Il est possible qu\'il ait été annulé');
 312         }
 313         if ($partid == 'xface') {
 314             $msg->getXFace();
 315             exit;
 316         } elseif (!$istext) {
 317             $part = $msg->getPartById($partid);
 318             if (!is_null($part)) {
 319                 $part->send(true);
 320             }
 321             $part = $msg->getFile($partid);
 322             if (!is_null($part)) {
 323                 $part->send();
 324             }
 325             exit;
 326         } elseif ($partid == 'text') {
 327             Banana::$page->assign('body', $msg->getFormattedBody());
 328         } elseif ($partid == 'source') {
 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>');
 334         } else {
 335             Banana::$page->assign('body', $msg->getFormattedBody($partid));
 336         }
 337
 338         if (Banana::$profile['autoup']) {
 339             Banana::$spool->markAsRead($artid);
 340         }
 341         if (Banana::$spool_boxlist) {
 342             $groups    = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
 343             Banana::$page->assign('groups', $groups);
 344         }
 345         Banana::$page->assign_by_ref('message', $msg);
 346         Banana::$page->assign('headers', Banana::$msgshow_headers);
 347         return true;
 348     }
 349
 350     protected function action_newMessage($group, $artid)
 351     {
 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));
 360             if (isset(Banana::$profile['headers'][$header])) {
 361                 $headers[$header]['fixed'] = Banana::$profile['headers'][$header];
 362             }
 363         }
 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];
 368             }
 369             if ($artid) {
 370                 $old =& $this->loadMessage($group, $artid);
 371                 $hdr_values['References'] = $old->getHeaderValue('references') . $old->getHeaderValue('message-id');
 372             }
 373             $msg = null;
 374             if (empty($hdr_values['Subject'])) {
 375                 Banana::$page->trig(_b_('Le message doit avoir un sujet'));
 376             } elseif (Banana::$msgedit_canattach && isset($_FILES['attachment'])) {
 377                 $uploaded = $_FILES['attachment'];
 378                 if (!is_uploaded_file($uploaded['tmp_name'])) {
 379                     Banana::$page->trig(_b_('Une erreur est survenue lors du téléchargement du fichier'));
 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());
 392             }
 393         } else {
 394             if (!is_null($artid)) {
 395                 $msg    =& $this->loadMessage($group, $artid);
 396                 $body    = $msg->getSender() . _b_(' a écrit :') . "\n" . $msg->quote();
 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;
 407             }
 408             if (Banana::$profile['signature']) {
 409                 $body .=  "\n\n-- \n" . Banana::$profile['signature'];
 410             }
 411             Banana::$page->assign('body', $body);
 412         }
 413
 414         Banana::$page->assign('maxfilesize', Banana::$msgedit_maxfilesize);
 415         Banana::$page->assign('can_attach', Banana::$msgedit_canattach);
 416         Banana::$page->assign('headers', $headers);
 417         return true;
 418     }
 419
 420     protected function action_cancelMessage($group, $artid)
 421     {
 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));
 439         }
 440
 441         Banana::$page->assign_by_ref('message', $msg);
 442         Banana::$page->assign('body', $msg->getFormattedBody());
 443         Banana::$page->assign('headers', Banana::$msgshow_headers);
 444         return true;
 445     }
 446
 447     /**************************************************************************/
 448     /* Private functions                                                      */
 449     /**************************************************************************/
 450
 451     protected function loadSpool($group)
 452     {
 453         Banana::load('spool');
 454         if (!Banana::$spool || Banana::$spool->group != $group) {
 455             $clean = false;
 456             if ($group == @$_SESSION['banana_group'] && isset($_SESSION['banana_spool'])) {
 457                 Banana::$spool = unserialize($_SESSION['banana_spool']);
 458                 $clean = @(Banana::$profile['lastnews'] != $_SESSION['banana_lastnews']);
 459             } else {
 460                 unset($_SESSION['banana_message']);
 461                 unset($_SESSION['banana_artid']);
 462                 unset($_SESSION['banana_showhdr']);
 463             }
 464             BananaSpool::getSpool($group, Banana::$profile['lastnews'], Banana::$profile['autoup'] || $clean);
 465             $_SESSION['banana_group'] = $group;
 466             if (!Banana::$profile['display']) {
 467                 $_SESSION['banana_spool'] = serialize(Banana::$spool);
 468                 $_SESSION['banana_lastnews'] = Banana::$profile['lastnews'];
 469             }
 470             Banana::$spool->setMode(Banana::$profile['display'] ? Banana::SPOOL_UNREAD : Banana::SPOOL_ALL);
 471         }
 472         return true;
 473     }
 474
 475     protected function &loadMessage($group, $artid)
 476     {
 477         Banana::load('message');
 478         if ($group == @$_SESSION['banana_group'] && $artid == @$_SESSION['banana_artid']
 479             && isset($_SESSION['banana_message'])) {
 480             $message = unserialize($_SESSION['banana_message']);
 481             Banana::$msgshow_headers = $_SESSION['banana_showhdr'];
 482         }  else {
 483             $message = Banana::$protocole->getMessage($artid);
 484             $_SESSION['banana_group'] = $group;
 485             $_SESSION['banana_artid'] = $artid;
 486             $_SESSION['banana_message'] = serialize($message);
 487             $_SESSION['banana_showhdr'] = Banana::$msgshow_headers;
 488         }
 489         Banana::$message =& $message;
 490         return $message;
 491     }
 492
 493     protected function removeMessage($group, $artid)
 494     {
 495         Banana::$spool->delId($artid);
 496         if ($group == $_SESSION['banana_group']) {
 497             if (!Banana::$profile['display']) {
 498                 $_SESSION['banana_spool'] = serialize(Banana::$spool);
 499             }
 500             if ($artid == $_SESSION['banana_artid']) {
 501                 unset($_SESSION['banana_message']);
 502                 unset($_SESSION['banana_showhdr']);
 503                 unset($_SESSION['banana_artid']);
 504             }
 505         }
 506         return true;
 507     }
 508
 509     static private function load($file)
 510     {
 511         $file = strtolower($file) . '.inc.php';
 512         if (!@include_once dirname(__FILE__) . "/$file") {
 513             require_once $file;
 514         }
 515     }
 516 }
 517
 518 // vim:set et sw=4 sts=4 ts=4 enc=utf-8:
 519 ?>