| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * SquirrelMail Preview Pane Plugin |
| 5 | * |
| 6 | * @copyright © 1999-2007 The SquirrelMail Project Team |
| 7 | * @author Paul Lesneiwski <paul@squirrelmail.org> |
| 8 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
| 9 | * @version $Id$ |
| 10 | * @package plugins |
| 11 | * @subpackage preview_pane |
| 12 | * |
| 13 | */ |
| 14 | |
| 15 | |
| 16 | /** |
| 17 | * Build user options for display on "Display Preferences" page |
| 18 | * |
| 19 | */ |
| 20 | function preview_pane_show_options_do() |
| 21 | { |
| 22 | |
| 23 | if (!checkForJavascript()) return; |
| 24 | |
| 25 | global $data_dir, $username; |
| 26 | $use_previewPane = getPref($data_dir, $username, 'use_previewPane', 0); |
| 27 | $previewPane_vertical_split = getPref($data_dir, $username, 'previewPane_vertical_split', 0); |
| 28 | $previewPane_size = getPref($data_dir, $username, 'previewPane_size', 300); |
| 29 | $pp_refresh_message_list = getPref($data_dir, $username, 'pp_refresh_message_list', 1); |
| 30 | |
| 31 | |
| 32 | global $optpage_data; |
| 33 | $optpage_data['vals'][1][] = array( |
| 34 | 'name' => 'use_previewPane', |
| 35 | 'caption' => _("Show Message Preview Pane"), |
| 36 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 37 | 'initial_value' => $use_previewPane, |
| 38 | 'refresh' => SMOPT_REFRESH_ALL, |
| 39 | ); |
| 40 | $optpage_data['vals'][1][] = array( |
| 41 | 'name' => 'previewPane_vertical_split', |
| 42 | 'caption' => _("Split Preview Pane Vertically"), |
| 43 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 44 | 'initial_value' => $previewPane_vertical_split, |
| 45 | 'refresh' => SMOPT_REFRESH_ALL, |
| 46 | ); |
| 47 | $optpage_data['vals'][1][] = array( |
| 48 | 'name' => 'previewPane_size', |
| 49 | 'caption' => _("Message Preview Pane Size"), |
| 50 | 'type' => SMOPT_TYPE_INTEGER, |
| 51 | 'initial_value' => $previewPane_size, |
| 52 | 'refresh' => SMOPT_REFRESH_ALL, |
| 53 | 'size' => SMOPT_SIZE_TINY, |
| 54 | ); |
| 55 | $optpage_data['vals'][1][] = array( |
| 56 | 'name' => 'pp_refresh_message_list', |
| 57 | 'caption' => _("Always Refresh Message List<br />When Using Preview Pane"), |
| 58 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 59 | 'initial_value' => $pp_refresh_message_list, |
| 60 | 'refresh' => SMOPT_REFRESH_ALL, |
| 61 | ); |
| 62 | |
| 63 | } |
| 64 | |
| 65 | |
| 66 | /** |
| 67 | * This function determines if the preview pane is in use |
| 68 | * (and JavaScript is available) |
| 69 | * |
| 70 | * @return boolean TRUE if the preview pane should be showing currently. |
| 71 | * |
| 72 | */ |
| 73 | function show_preview_pane() |
| 74 | { |
| 75 | $use_previewPane = getPref($data_dir, $username, 'use_previewPane', 0); |
| 76 | return (checkForJavascript() && $use_previewPane); |
| 77 | } |
| 78 | |
| 79 | |
| 80 | /** |
| 81 | * Construct button that clears out any preview pane |
| 82 | * contents and inserts JavaScript function used by |
| 83 | * message subject link onclick handler. Also disallows |
| 84 | * the message list to be loaded into the bottom frame. |
| 85 | * |
| 86 | */ |
| 87 | function preview_pane_message_list_do() |
| 88 | { |
| 89 | |
| 90 | if (!checkForJavascript()) return; |
| 91 | |
| 92 | global $plugins, $archive_mail_button_has_been_printed, |
| 93 | $username, $data_dir, $PHP_SELF, $base_uri; |
| 94 | |
| 95 | |
| 96 | $output = ''; |
| 97 | $use_previewPane = getPref($data_dir, $username, 'use_previewPane', 0); |
| 98 | |
| 99 | |
| 100 | // add refresh function called from code built in function |
| 101 | // preview_pane_change_message_target_do() |
| 102 | // |
| 103 | if ($use_previewPane == 1 |
| 104 | && getPref($data_dir, $username, 'pp_refresh_message_list', 1) == 1) |
| 105 | { |
| 106 | // sqgetGlobalVar('REQUEST_URI', $request_uri, SQ_SERVER); |
| 107 | $request_uri = $PHP_SELF; |
| 108 | $output .= "<script type=\"text/javascript\">\n<!--\n function pp_refresh() { document.location = '$request_uri'; }\n// -->\n</script>\n"; |
| 109 | } |
| 110 | |
| 111 | |
| 112 | if ($use_previewPane == 1) |
| 113 | { |
| 114 | // why isn't this already available? |
| 115 | include_once(SM_PATH . 'functions/forms.php'); |
| 116 | |
| 117 | $output .= addButton(_("Clear Preview"), 'clear_preview', |
| 118 | array('onclick' => 'parent.bottom.document.location=\'' |
| 119 | . $base_uri . '/plugins/preview_pane/empty_frame.php\'; ')) |
| 120 | |
| 121 | |
| 122 | |
| 123 | // don't let message list load into preview pane at all |
| 124 | // |
| 125 | . "\n<script language='javascript' type='text/javascript'>\n" |
| 126 | . "<!--\n" |
| 127 | . "\n" |
| 128 | . " if (self.name == 'bottom')\n" |
| 129 | . " {\n" |
| 130 | . " document.location = '" . $base_uri . "plugins/preview_pane/empty_frame.php'\n" |
| 131 | . " }\n" |
| 132 | . "//-->\n" |
| 133 | . "</script>\n"; |
| 134 | } |
| 135 | |
| 136 | return array('mailbox_index_after' => $output); |
| 137 | |
| 138 | } |
| 139 | |
| 140 | |
| 141 | /** |
| 142 | * Points message targets to open in the preview pane |
| 143 | * (and possibly refresh message list as well) |
| 144 | * |
| 145 | */ |
| 146 | function preview_pane_change_message_target_do() |
| 147 | { |
| 148 | |
| 149 | if (!checkForJavascript()) return; |
| 150 | |
| 151 | global $data_dir, $username, $target, $onclick, $PHP_SELF; |
| 152 | // sqgetGlobalVar('REQUEST_URI', $request_uri, SQ_SERVER); |
| 153 | $request_uri = $PHP_SELF; |
| 154 | |
| 155 | |
| 156 | if (getPref($data_dir, $username, 'use_previewPane', 0) == 1) |
| 157 | { |
| 158 | $pp_refresh_message_list = getPref($data_dir, $username, 'pp_refresh_message_list', 1); |
| 159 | |
| 160 | $target = 'bottom'; |
| 161 | if ($pp_refresh_message_list) |
| 162 | // introduce a delay so read messages actually refresh after they are read |
| 163 | // $onclick .= ' onclick="document.location=\'' . $request_uri . '\'; " '; |
| 164 | $onclick .= ' setTimeout(\'pp_refresh()\', 500); '; |
| 165 | } |
| 166 | |
| 167 | } |
| 168 | |
| 169 | |
| 170 | |