Made the webmail_top hook work again for plugins that want to change the URI of the...
[squirrelmail.git] / src / webmail.php
index 78764eb5d8a1a5b8fbe1b7d4aef20d9da81c6cf8..3a1293b441f496ecfebc2075ce208fb23dac06d3 100644 (file)
 <?php
+/**
+ * webmail.php -- Displays the main frameset
+ *
+ * This file generates the main frameset. The files that are
+ * shown can be given as parameters. If the user is not logged in
+ * this file will verify username and password.
+ *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
 
-   /**
-    **  webmail.php -- Displays the main frameset
-    **
-    **  Copyright (c) 1999-2000 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  This file generates the main frameset. The files that are
-    **  shown can be given as parameters. If the user is not logged in
-    **  this file will verify username and password.
-    **
-    **/
-
-   session_start();
-
-   if (!isset($i18n_php))
-      include ("../functions/i18n.php");
-
-   if(!isset($username)) {
-      set_up_language($squirrelmail_language);
-      echo _("You need a valid user and password to access this page!");
-      exit;
-   }
-
-   include ("../config/config.php");
-   include ("../functions/prefs.php");
-   include ("../functions/imap.php");
-   if (!isset($plugin_php))
-      include ("../functions/plugin.php");
-   if (!isset($auth_php))
-      include ("../functions/auth.php");
-   if (!isset($strings_php))
-      include ("../functions/strings.php");
-
-   include ("../src/load_prefs.php");
-
-   // We'll need this to later have a noframes version
-   set_up_language(getPref($data_dir, $username, "language"));
-
-   echo "<html><head>\n";
-   echo "<TITLE>";
-   echo "$org_title";
-   echo "</TITLE>";
-   $ishelp = substr(getenv(REQUEST_URI),-8);                   // If calling help, set left frame to 300
-   
-       $bar_size = $left_size;
-   
-   if ($location_of_bar == 'right')
-   {
-      echo "<FRAMESET COLS=\"*, $left_size\" NORESIZE=yes BORDER=0>";
-   } else {
-      echo "<FRAMESET COLS=\"$left_size, *\" NORESIZE BORDER=0>";
-   }
+/** This is the webmail page */
+define('PAGE_NAME', 'webmail');
 
 /**
-    There are three ways to call webmail.php
-    1.  webmail.php
-         - This just loads the default entry screen.
-    2.  webmail.php?right_frame=right_main.php&sort=X&startMessage=X&mailbox=XXXX
-         - This loads the frames starting at the given values.
-    3.  webmail.php?right_frame=folders.php
-         - Loads the frames with the Folder options in the right frame.
-
-    This was done to create a pure HTML way of refreshing the folder list since
-    we would like to use as little Javascript as possible.
-**/
-   if ($right_frame == "right_main.php") {
-      $urlMailbox = urlencode($mailbox);
-      $right_frame_url = "right_main.php?mailbox=$urlMailbox&sort=$sort&startMessage=$startMessage";
-   } else if ($right_frame == "options.php") {
-      $right_frame_url = "options.php";
-   } else if ($right_frame == "folders.php") {
-      $right_frame_url = "folders.php";
-   } else {
-      if (!isset($just_logged_in)) $just_logged_in = 0;
-      $right_frame_url = "right_main.php?just_logged_in=$just_logged_in";
-   }
-
-   if ($location_of_bar == 'right')
-   {
-      echo "<FRAME SRC=\"$right_frame_url\" NAME=\"right\">";
-      echo "<FRAME SRC=\"left_main.php\" NAME=\"left\">";
-   }
-   else
-   {
-      echo "<FRAME SRC=\"left_main.php\" NAME=\"left\">";
-      echo "<FRAME SRC=\"$right_frame_url\" NAME=\"right\">";
-   }
-
-?>
-</FRAMESET>
-</HEAD></HTML>
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
+
+if (sqgetGlobalVar('sort', $sort)) {
+    $sort = (int) $sort;
+}
+
+if (sqgetGlobalVar('startMessage', $startMessage)) {
+    $startMessage = (int) $startMessage;
+}
+
+if (!sqgetGlobalVar('mailbox', $mailbox)) {
+    $mailbox = 'INBOX';
+}
+
+sqgetGlobalVar('right_frame', $right_frame, SQ_GET);
+
+if(!sqgetGlobalVar('mailtodata', $mailtodata)) {
+    $mailtourl = 'mailtodata='.urlencode($mailtodata);
+} else {
+    $mailtourl = '';
+}
+
+// Determine the size of the left frame
+$left_size = getPref($data_dir, $username, 'left_size');
+if ($left_size == "") {
+    if (isset($default_left_size)) {
+         $left_size = $default_left_size;
+    }
+    else {
+        $left_size = 200;
+    }
+}
+
+// Determine where the navigation frame should be
+$location_of_bar = getPref($data_dir, $username, 'location_of_bar');
+if (isset($languages[$squirrelmail_language]['DIR']) &&
+    strtolower($languages[$squirrelmail_language]['DIR']) == 'rtl') {
+    $temp_location_of_bar = 'right';
+} else {
+    $temp_location_of_bar = 'left';
+}
+if ($location_of_bar == '') {
+    $location_of_bar = $temp_location_of_bar;
+}
+
+// this value may be changed by a plugin, but initialize
+// it first to avoid register_globals headaches
+//
+$right_frame_url = '';
+do_hook('webmail_top', $null);
+
+// Determine the main frame URL
+/*
+ * There are three ways to call webmail.php
+ * 1.  webmail.php
+ *      - This just loads the default entry screen.
+ * 2.  webmail.php?right_frame=right_main.php&sort=X&startMessage=X&mailbox=XXXX
+ *      - This loads the frames starting at the given values.
+ * 3.  webmail.php?right_frame=folders.php
+ *      - Loads the frames with the Folder options in the right frame.
+ *
+ * This was done to create a pure HTML way of refreshing the folder list since
+ * we would like to use as little Javascript as possible.
+ *
+ * The test for // should catch any attempt to include off-site webpages into
+ * our frameset.
+ *
+ * Note that plugins are allowed to completely and freely override the URI
+ * used for the "right" (content) frame, and they do so by modifying the
+ * global variable $right_frame_url.
+ *
+ */
+if (empty($right_frame) || (strpos(urldecode($right_frame), '//') !== false)) {
+    $right_frame = '';
+}
+if ( strpos($right_frame,'?') ) {
+    $right_frame_file = substr($right_frame,0,strpos($right_frame,'?'));
+} else {
+    $right_frame_file = $right_frame;
+}
+if (empty($right_frame_url)) {
+    switch($right_frame) {
+        case 'right_main.php':
+            $right_frame_url = "right_main.php?mailbox=".urlencode($mailbox)
+                           . (!empty($sort)?"&amp;sort=$sort":'')
+                           . (!empty($startMessage)?"&amp;startMessage=$startMessage":'');
+            break;
+        case 'options.php':
+            $right_frame_url = 'options.php';
+            break;
+        case 'folders.php':
+            $right_frame_url = 'folders.php';
+            break;
+        case 'compose.php':
+            $right_frame_url = 'compose.php?' . $mailtourl;
+            break;
+        case '':
+            $right_frame_url = 'right_main.php';
+            break;
+        default:
+            $right_frame_url =  urlencode($right_frame);
+            break;
+    }
+}
+
+$oErrorHandler->setDelayedErrors(true);
+
+$oTemplate->assign('nav_size', $left_size);
+$oTemplate->assign('nav_on_left', $location_of_bar=='left');
+$oTemplate->assign('right_frame_url', $right_frame_url);
+
+displayHtmlHeader($org_title, '', false, true);
+
+$oTemplate->display('webmail.tpl');
+