<?php
/**
- * SETUP.PHP
- * ---------
- * This is a standard Squirrelmail-1.2 API for plugins.
+ * setup.php
+ *
+ * Squirrelspell setup file, as defined by the SquirrelMail-1.2 API.
+ *
+ * @author Konstantin Riabitsev <icon at duke.edu>
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage squirrelspell
+ * @todo remove sqspell_ prefix from main php scripts.
*/
+
/**
- * This function checks whether the user's USER_AGENT is known to
- * be broken. If so, returns true and the plugin is invisible to the
- * offending browser.
+ * Standard SquirrelMail plugin initialization API.
+ *
+ * @return void
*/
-function soupNazi(){
- global $HTTP_USER_AGENT;
- require ('../plugins/squirrelspell/sqspell_config.php');
- $soup_nazi = false;
-
- $soup_menu = explode(',', $SQSPELL_SOUP_NAZI);
- for ($i = 0; $i < sizeof($soup_menu); $i++) {
- if (stristr($HTTP_USER_AGENT, trim($soup_menu[$i]))) {
- $soup_nazi=true;
- }
- }
- return $soup_nazi;
-}
-
function squirrelmail_plugin_init_squirrelspell() {
- /* Standard initialization API. */
- global $squirrelmail_plugin_hooks;
-
- $squirrelmail_plugin_hooks["compose_button_row"]["squirrelspell"] = "squirrelspell_setup";
- $squirrelmail_plugin_hooks["options_register"]["squirrelspell"] = "squirrelspell_options";
- $squirrelmail_plugin_hooks["options_link_and_description"]["squirrelspell"] = "squirrelspell_options";
+ global $squirrelmail_plugin_hooks;
+ $squirrelmail_plugin_hooks['template_construct_compose_buttons.tpl']['squirrelspell'] =
+ 'squirrelspell_setup';
+ $squirrelmail_plugin_hooks['optpage_register_block']['squirrelspell'] =
+ 'squirrelspell_optpage_register_block';
+ $squirrelmail_plugin_hooks['options_link_and_description']['squirrelspell'] =
+ 'squirrelspell_options';
+ $squirrelmail_plugin_hooks['right_main_after_header']['squirrelspell'] =
+ 'squirrelspell_upgrade';
}
-function squirrelspell_options() {
- // Gets added to the user's OPTIONS page.
- global $optionpages;
-
- if (soupNazi()) {
- return;
- }
-
- /* Register Squirrelspell with the $optionpages array. */
- $optionpages[] = array(
- 'name' => 'SpellChecker Options',
- 'url' => '../plugins/squirrelspell/sqspell_options.php',
- 'desc' => 'Here you may set up how your personal dictionary is stored,
- edit it, or choose which languages should be available to
- you when spell-checking.',
- 'js' => true
- );
+/**
+ * Register option block
+ *
+ * This function formats and adds the plugin and its description to the
+ * Options screen. Code moved to internal function in order to reduce
+ * setup.php size.
+ * @return void
+ */
+function squirrelspell_optpage_register_block() {
+ include_once(SM_PATH . 'plugins/squirrelspell/sqspell_functions.php');
+ squirrelspell_optpage_block_function();
}
+/**
+ * Add spell check button in compose.
+ *
+ * This function adds a "Check Spelling" link to the "Compose" row
+ * during message composition.
+ * @return void
+ */
function squirrelspell_setup() {
- /* Gets added to the COMPOSE buttons row. */
- if (soupNazi()) {
- return;
- }
+ include_once(SM_PATH . 'plugins/squirrelspell/sqspell_functions.php');
+ return squirrelspell_setup_function();
+}
-?>
- <script type="text/javascript">
- <!--
- // using document.write to hide this functionality from people
- // with JavaScript turned off.
- document.write("<input type=\"button\" value=\"Check Spelling\" onclick=\"window.open('../plugins/squirrelspell/sqspell_interface.php', 'sqspell', 'status=yes,width=550,height=370,resizable=yes')\">");
- //-->
- </script>
-<?php
+/**
+ * Upgrade dictionaries
+ *
+ * Transparently upgrades user's dictionaries when message listing is loaded
+ * @since 1.5.1 (sqspell 0.5)
+ */
+function squirrelspell_upgrade() {
+ include_once(SM_PATH . 'plugins/squirrelspell/sqspell_functions.php');
+ squirrelspell_upgrade_function();
}
-?>
+/**
+ * Display SquirrelSpell version
+ * @since 1.5.1 (sqspell 0.5)
+ * @return string plugin's version
+ */
+function squirrelspell_version() {
+ return '0.5';
+}