Better support of multipart emails for rendering and quoting
[banana.git] / banana / banana.inc.php.in
index d3e983e..82bb114 100644 (file)
@@ -9,43 +9,43 @@
 
 class Banana
 {
-    static public $maxspool    = 3000;
 
-    static public $parse_hdr   = array('content-disposition', 'content-transfer-encoding',
+#######
+# Configuration variables
+#######
+
+### General ###
+    static public $profile = Array( 'signature'  => '',
+                                    'headers' => array('From' => 'Anonymous <anonymouse@example.com>'),
+                                    'display' => 0,
+                                    'lastnews' => 0,
+                                    'locale'  => 'fr_FR',
+                                    'subscribe' => array(),
+                                    'autoup' => 1);
+    static public $boxpattern;
+
+### Spool ###
+    static public $spool_max     = 3000;
+    static public $spool_tbefore = 5;
+    static public $spool_tafter  = 5;
+    static public $spool_tmax    = 50;
+
+### Message processing ###
+    static public $msgparse_headers = array('content-disposition', 'content-transfer-encoding',
                                        'content-type', 'content-id', 'date', 'followup-to',
                                        'from', 'message-id', 'newsgroups', 'organization',
                                        'references', 'subject', 'x-face', 'in-reply-to',
                                        'to', 'cc', 'reply-to');
-    static public $show_hdr    = array('from', 'newsgroups', 'followup-to', 'to', 'cc', 'reply-to',
-                                       'organization', 'date', 'references', 'in-reply-to');
-
-    /** Favorites MIMEtypes to use, by order for reading multipart messages
-     */
-    static public $body_mime   = array('text/html', 'text/plain', 'text/enriched', 'text', 'message');
-
-    /** Indicate wether posting attachment is allowed
-     */
-    static public $can_attach  = true;
-    /** Maximum allowed file size for attachment
-     */
-    static public $maxfilesize = 100000;
-    /** Indicate wether x-face should be skinned as specials data or not
-     */
-    static public $formatxface = true;
 
-    /** Regexp for selecting newsgroups to show (if empty, match all newsgroups)
-     * ex : '^xorg\..*' for xorg.*
-     */
-    static public $grp_pattern = null;
-
-    static public $tbefore     = 5;
-    static public $tafter      = 5;
-    static public $tmax        = 50;
+### Message display ###
+    static public $msgshow_headers   = array('from', 'newsgroups', 'followup-to', 'to', 'cc', 'reply-to',
+                                       'organization', 'date', 'references', 'in-reply-to');
+    static public $msgshow_mimeparts = array('multipart/report', 'multipart/mixed', 'text/html', 'text/plain', 'text/enriched', 'text', 'message');
+    static public $msgshow_xface     = true;
+    static public $msgshow_wrap      = 78;
 
-    static public $wrap        = 78;
-    
     /** Match an url
-     * Should be included in a regexp delimited using /, !, , or @ (eg: "/$url_regexp/i")
+     * Should be included in a regexp delimited using /, !, , or @ (eg: "/$url_regexp/ui")
      * If it matches, return 3 main parts :
      *  \\1 and \\3 are delimiters
      *  \\2 is the url
@@ -55,37 +55,34 @@ class Banana
      *   $matches[2] = "http://www.polytechnique.org"
      *   $matches[3] = "]"
      */
-    static public $url_regexp  = '(["\[])?((?:[a-z]+:\/\/|www\.)(?:[\.\,\;\!]*[a-z\@0-9~%$£µ&i#\-+=_\/\?]+)+)(["\]])?';
+    static public $msgshow_url  = '(["\[])?((?:[a-z]+:\/\/|www\.)(?:[\.\,\;\!]*[a-z\@0-9~%$£µ&i#\-+=_\/\?]+)+)(["\]])?';
 
+### Message edition ###
+    static public $msgedit_canattach  = true;
+    static public $msgedit_maxfilesize = 100000;
     /** Global headers to use for messages
      */
-    static public $custom_hdr  = array('Mime-Version' => '1.0', 'User-Agent' => 'Banana @VERSION@');
-
-    /** News serveur to use
+    static public $msgedit_headers  = array('Mime-Version' => '1.0', 'User-Agent' => 'Banana @VERSION@');
+    /** Mime type order for quoting
      */
-    static public $host        = 'news://localhost:119/';
+    static public $msgedit_mimeparts = array('multipart/report', 'multipart/mixed', 'text/plain', 'text/enriched', 'text/html', 'text', 'message');
 
-    /** User profile
+### Protocole ###
+    /** News serveur to use
      */
-    static public $profile     = Array( 'From' => 'Anonymous <anonymouse@example.com>', 'sig'  => '',
-                                        'Organization'  => '', 'custom_hdr' => array(), 'display' => 0,
-                                        'lastnews' => 0, 'locale'  => 'fr_FR', 'subscribe' => array());
-
-    static public $protocole   = null;
-    static public $spool       = null;
-    static public $message     = null;
-    static public $page        = null;
+    static public $nntp_host   = 'news://localhost:119/';
 
-    static public $group       = null;
-    static public $artid       = null;
-    static public $action      = null;
-    static public $part        = null;
-    static public $first       = null;
+    static public $mbox_path   = '/var/mail';
 
+### Debug ###
     static public $debug_nntp   = false;
     static public $debug_smarty = false;
 
 
+#######
+# Constants
+#######    
+
     // Actions
     const ACTION_BOX_NEEDED = 1; // mask
     const ACTION_BOX_LIST   = 2;
@@ -104,10 +101,31 @@ class Banana
     const SPOOL_ALL    = 0;
     const SPOOL_UNREAD = 1;
 
+
+#######
+# Runtime variables
+#######
+
+    static public $protocole   = null;
+    static public $spool       = null;
+    static public $message     = null;
+    static public $page        = null;
+
+    static public $group       = null;
+    static public $artid       = null;
+    static public $action      = null;
+    static public $part        = null;
+    static public $first       = null;
+
     /** Class parameters storage
      */
     public $params;
 
+
+#######
+# Banana Implementation
+#######
+
     /** Build the instance of Banana
      * This constructor only call \ref loadParams, connect to the server, and build the Smarty page
      * @param protocole Protocole to use
@@ -123,8 +141,10 @@ class Banana
         $this->loadParams();
 
         // connect to protocole handler
-        Banana::load($protocole);
         $classname = 'Banana' . $protocole;
+        if (!class_exists($classname)) {
+            Banana::load($protocole);
+        }    
         Banana::$protocole = new $classname(Banana::$group);
 
         // build the page
@@ -145,7 +165,7 @@ class Banana
 
         // Look for the action to execute
         if (is_null(Banana::$group)) {
-            if (isset($this->params['subscribe'])) {
+            if (isset($this->params['action']) && $this->params['action'] == 'subscribe') {
                 Banana::$action = Banana::ACTION_BOX_SUBS;
             } else {
                 Banana::$action = Banana::ACTION_BOX_LIST;
@@ -173,27 +193,6 @@ class Banana
         }
     }
 
-    /** Register an action to show on banana page
-     * @param action_code HTML code of the action
-     * @param pages ARRAY pages where to show the action (null == every pages)
-     * @return true if success
-     */
-    public function registerAction($action_code, array $pages = null)
-    {
-        return Banana::$page->registerAction($action_code, $pages);
-    }
-
-    /** Register a new page
-     * @param name Name of the page
-     * @param text Text for the tab of the page
-     * @param template Template path for the page if null, the page is not handled by banana
-     * @return true if success
-     */
-    public function registerPage($name, $text, $template = null)
-    {
-        return Banana::$page->registerPage($name, $text, $template);
-    }
-
     /** Run Banana
      * This function need user profile to be initialised
      */
@@ -204,16 +203,16 @@ class Banana
         
         // Check if the state is valid
         if (Banana::$protocole->lastErrNo()) {
-            return Banana::$page->kill(_b_('Une erreur a été rencontrée lors de la connexion au serveur') . '<br />'
+            return Banana::$page->kill(_b_('Une erreur a été rencontrée lors de la connexion au serveur') . '<br />'
                                       . Banana::$protocole->lastError());
         }
         if (!Banana::$protocole->isValid()) {
             return Banana::$page->kill(_b_('Connexion non-valide'));
         }
         if (Banana::$action & Banana::ACTION_BOX_NEEDED) {
-            if(isset(Banana::$grp_pattern) && !preg_match('/' . Banana::$grp_pattern . '/', $group)) {
+            if(Banana::$boxpattern && !preg_match('/' . Banana::$boxpattern . '/i', $group)) {
                 Banana::$page->setPage('group');        
-                return Banana::$page->kill(_b_("Ce newsgroup n'existe pas ou vous n'avez pas l'autorisation d'y accéder"));
+                return Banana::$page->kill(_b_("Ce newsgroup n'existe pas ou vous n'avez pas l'autorisation d'y accéder"));
             }
         }
 
@@ -238,7 +237,7 @@ class Banana
             $error = $this->action_cancelMessage(Banana::$group, Banana::$artid);
             break;
           default:
-            $error = _b_("L'action demandée n'est pas supportée par Banana");
+            $error = _b_("L'action demandée n'est pas supportée par Banana");
         }
 
         // Generate the page
@@ -286,7 +285,7 @@ class Banana
             return _b_('Impossible charger la liste des messages de ') . $group;
         }
         $groups = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
-        Banana::$page->assign('msgbypage', Banana::$tmax);
+        Banana::$page->assign('msgbypage', Banana::$spool_tmax);
         Banana::$page->assign('groups', $groups);
         return true;
     }
@@ -294,19 +293,21 @@ class Banana
     protected function action_showMessage($group, $artid, $partid = 'text')
     {
         Banana::$page->setPage('message');
-        if ($partid == 'text') {
+        $istext = $partid == 'text' || $partid == 'source'
+                || preg_match('!^[-a-z0-9_]+/[-a-z0-9_]+$!', $partid);
+        if ($istext) {
             $this->loadSpool($group);
         }
         $msg =& $this->loadMessage($group, $artid);
         if (is_null($msg)) {
             $this->loadSpool($group);
             $this->removeMessage($group, $artid);
-            return _b_('Le message demandé n\'existe pas. Il est possible qu\'il ait été annulé');
+            return _b_('Le message demandé n\'existe pas. Il est possible qu\'il ait été annulé');
         }
         if ($partid == 'xface') {
             $msg->getXFace();
             exit;
-        } elseif ($partid != 'text') {
+        } elseif (!$istext) {
             $part = $msg->getPartById($partid);
             if (!is_null($part)) {
                 $part->send(true);
@@ -316,11 +317,25 @@ class Banana
                 $part->send();
             }
             exit;
+        } elseif ($partid == 'text') {
+            Banana::$page->assign('body', $msg->getFormattedBody());
+        } elseif ($partid == 'source') {
+            $text = Banana::$protocole->getMessageSource($artid);
+            if (!is_utf8($text)) {
+                $text = utf8_encode($text);
+            }
+            Banana::$page->assign('body', '<pre>' . banana_htmlentities($text) . '</pre>');
+        } else {
+            Banana::$page->assign('body', $msg->getFormattedBody($partid));
+        }
+
+        if (Banana::$profile['autoup']) {
+            Banana::$spool->markAsRead($artid);
         }
         $groups    = Banana::$protocole->getBoxList(Banana::BOXES_SUB, Banana::$profile['lastnews'], true);
         Banana::$page->assign('groups', $groups);
         Banana::$page->assign_by_ref('message', $msg);
-        Banana::$page->assign('headers', Banana::$show_hdr);
+        Banana::$page->assign('headers', Banana::$msgshow_headers);
         return true;
     }
 
@@ -334,8 +349,8 @@ class Banana
         $headers = array();
         foreach ($hdrs as $header) {
             $headers[$header] = array('name' => BananaMessage::translateHeaderName($header));
-            if (isset(Banana::$profile[$header])) {
-                $headers[$header]['fixed'] = Banana::$profile[$header];
+            if (isset(Banana::$profile['headers'][$header])) {
+                $headers[$header]['fixed'] = Banana::$profile['headers'][$header];
             }
         }
         if (isset($_POST['sendmessage'])) {
@@ -350,10 +365,10 @@ class Banana
             $msg = null;
             if (empty($hdr_values['Subject'])) {
                 Banana::$page->trig(_b_('Le message doit avoir un sujet'));
-            } elseif (Banana::$can_attach && isset($_FILES['attachment'])) {
+            } elseif (Banana::$msgedit_canattach && isset($_FILES['attachment'])) {
                 $uploaded = $_FILES['attachment'];
                 if (!is_uploaded_file($uploaded['tmp_name'])) {
-                    Banana::$page->trig(_b_('Une erreur est survenue lors du téléchargement du fichier'));
+                    Banana::$page->trig(_b_('Une erreur est survenue lors du téléchargement du fichier'));
                 } else {
                     $msg = BananaMessage::newMessage($hdr_values, $_POST['body'], $uploaded);
                 }
@@ -370,7 +385,7 @@ class Banana
         } else {
             if (!is_null($artid)) {
                 $msg    =& $this->loadMessage($group, $artid);
-                $body    = $msg->getSender() . _b_(' a écrit :') . "\n" . $msg->quote();
+                $body    = $msg->getSender() . _b_(' a écrit :') . "\n" . $msg->quote();
                 $subject = $msg->getHeaderValue('subject');
                 $headers['Subject']['user'] = 'Re: ' . preg_replace("/^re\s*:\s*/i", '', $subject);
                 $target  = $msg->getHeaderValue($hdrs['reply']);
@@ -382,14 +397,14 @@ class Banana
                 $body    = '';
                 $headers[$hdrs['dest']]['user'] = $group;
             }
-            if (Banana::$profile['sig']) {
-                $body .=  "\n\n-- \n" . Banana::$profile['sig'];
+            if (Banana::$profile['signature']) {
+                $body .=  "\n\n-- \n" . Banana::$profile['signature'];
             }
             Banana::$page->assign('body', $body);
         }
 
-        Banana::$page->assign('maxfilesize', Banana::$maxfilesize);
-        Banana::$page->assign('can_attach', Banana::$can_attach);
+        Banana::$page->assign('maxfilesize', Banana::$msgedit_maxfilesize);
+        Banana::$page->assign('can_attach', Banana::$msgedit_canattach);
         Banana::$page->assign('headers', $headers);
         return true;
     }
@@ -428,10 +443,12 @@ class Banana
         if (!Banana::$spool || Banana::$spool->group != $group) {
             if ($group == @$_SESSION['banana_group'] && isset($_SESSION['banana_spool'])) {
                 Banana::$spool = unserialize($_SESSION['banana_spool']);
-            }    
+            }
             BananaSpool::getSpool($group, Banana::$profile['lastnews']);
             $_SESSION['banana_group'] = $group;
-            $_SESSION['banana_spool'] = serialize(Banana::$spool);
+            if (!Banana::$profile['display']) {
+                $_SESSION['banana_spool'] = serialize(Banana::$spool);
+            }
             Banana::$spool->setMode(Banana::$profile['display'] ? Banana::SPOOL_UNREAD : Banana::SPOOL_ALL);
         }
         return true;
@@ -443,13 +460,13 @@ class Banana
         if ($group == @$_SESSION['banana_group'] && $artid == @$_SESSION['banana_artid']
             && isset($_SESSION['banana_message'])) {
             $message = unserialize($_SESSION['banana_message']);
-            Banana::$show_hdr = $_SESSION['banana_showhdr'];
+            Banana::$msgshow_headers = $_SESSION['banana_showhdr'];
         }  else {
             $message = Banana::$protocole->getMessage($artid);
             $_SESSION['banana_group'] = $group;
             $_SESSION['banana_artid'] = $artid;
             $_SESSION['banana_message'] = serialize($message);
-            $_SESSION['banana_showhdr'] = Banana::$show_hdr;
+            $_SESSION['banana_showhdr'] = Banana::$msgshow_headers;
         }
         Banana::$message =& $message;
         return $message;
@@ -459,7 +476,9 @@ class Banana
     {
         Banana::$spool->delId($artid);
         if ($group == $_SESSION['banana_group']) {
-            $_SESSION['banana_spool'] = serialize(Banana::$spool);
+            if (!Banana::$profile['display']) {
+                $_SESSION['banana_spool'] = serialize(Banana::$spool);
+            }    
             if ($artid == $_SESSION['banana_artid']) {
                 unset($_SESSION['banana_message']);
                 unset($_SESSION['banana_showhdr']);
@@ -478,5 +497,5 @@ class Banana
     }
 }
 
-// vim:set et sw=4 sts=4 ts=4
+// vim:set et sw=4 sts=4 ts=4 enc=utf-8:
 ?>