$Id$
-In addition to this document, please check out the SquirrelMail
-development FAQ for more information. Also, help writing plugins
+In addition to this document, please check out the SquirrelMail
+development FAQ for more information. Also, help writing plugins
is easily obtained by posting to the squirrelmail-plugins mailing
list. (See details about mailing lists on the website)
FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ
-Plugin Development ->
+Plugin Development ->
http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins
A FEW NOTES ON THE PLUGIN ARCHITECTURE
======================================
-The plugin architecture of SquirrelMail is designed to make it possible
-to add new features without having to patch SquirrelMail itself.
-Functionality like password changing, displaying ads and calendars should
+The plugin architecture of SquirrelMail is designed to make it possible
+to add new features without having to patch SquirrelMail itself.
+Functionality like password changing, displaying ads and calendars should
be possible to add as plugins.
The plugin jumping off point in the main SquirrelMail code is in the
file functions/plugin.php. In places where hooks are made available,
-they are executed by calling the function do_hook('hookname'). The
-do_hook function then traverses the array
-$squirrelmail_plugin_hooks['hookname'] and executes all the functions
-that are named in that array. Those functions are placed there when
-plugins register themselves with SquirrelMail as discussed below. A
-plugin may add its own internal functions to this array under any
+they are executed by calling the function do_hook('hookname'). The
+do_hook function then traverses the array
+$squirrelmail_plugin_hooks['hookname'] and executes all the functions
+that are named in that array. Those functions are placed there when
+plugins register themselves with SquirrelMail as discussed below. A
+plugin may add its own internal functions to this array under any
hook name provided by the SquirrelMail developers.
A plugin must reside in a subdirectory in the plugins/ directory. The
-name of the subdirectory is considered to be the name of the plugin.
+name of the subdirectory is considered to be the name of the plugin.
(The plugin will not function correctly if this is not the case.)
To start using a plugin, its name must be added to the $plugins array
When a plugin is registered, the file plugins/plugin_name/setup.php is
included and the function squirrelmail_plugin_init_plugin_name() is
-called with no parameters. That function is where the plugin may
+called with no parameters. That function is where the plugin may
register itself against any hooks it wishes to take advantage of.
WRITING PLUGINS
===============
-All plugins must contain a file called setup.php and must include a
-function called squirrelmail_plugin_init_plugin_name() therein. Since
-including numerous plugins can slow SquirrelMail performance
-considerably, the setup.php file should contain little else. Any
-functions that are registered against plugin hooks should do little
+All plugins must contain a file called setup.php and must include a
+function called squirrelmail_plugin_init_plugin_name() therein. Since
+including numerous plugins can slow SquirrelMail performance
+considerably, the setup.php file should contain little else. Any
+functions that are registered against plugin hooks should do little
more than call another function in a different file.
-Any other files used by the plugin should also be placed in the
-plugin directory (or subdirectory thereof) and should contain the
+Any other files used by the plugin should also be placed in the
+plugin directory (or subdirectory thereof) and should contain the
bulk of the plugin logic.
The function squirrelmail_plugin_init_plugin_name() is called to
-initalize a plugin. This function could look something like this (if
+initalize a plugin. This function could look something like this (if
the plugin was named "demo" and resided in the directory plugins/demo/):
-function squirrelmail_plugin_init_demo ()
+function squirrelmail_plugin_init_demo ()
{
global $squirrelmail_plugin_hooks;
Please note that as of SquirrelMail 1.5.0, this function will no longer
be called at run time and will instead be called only once at configure-
-time. Thus, the inclusion of any dynamic code (anything except hook
+time. Thus, the inclusion of any dynamic code (anything except hook
registration) here is strongly discouraged.
In this example, the "demo" plugin should also have two other functions
Including Other Files
---------------------
-A plugin may need to reference functionality provided in other
+A plugin may need to reference functionality provided in other
files, and therefore need to include those files. Most of the
core SquirrelMail functions are already available to your plugin
unless it has any files that are requested directly by the client
-browser (custom options page, etc.). In this case, you'll need
+browser (custom options page, etc.). In this case, you'll need
to make sure you include the files you need (see below).
Note that as of SquirrelMail 1.4.0, all files are accessed using a
constant called SM_PATH that always contains the relative path to
-the main SquirrelMail directory. This constant is always available
-for you to use when including other files from the SquirrelMail core,
-your own plugin, or other plugins, should the need arise. If any of
-your plugin files are requested directly from the client browser,
+the main SquirrelMail directory. This constant is always available
+for you to use when including other files from the SquirrelMail core,
+your own plugin, or other plugins, should the need arise. If any of
+your plugin files are requested directly from the client browser,
you will need to define this constant before you do anything else:
define('SM_PATH', '../../');
include_once(SM_PATH . 'include/validate.php');
When including files, please make sure to use the include_once() function
-and NOT include(), require(), or require_once(), since these all are much
-less efficient than include_once() and can have a cumulative effect on
+and NOT include(), require(), or require_once(), since these all are much
+less efficient than include_once() and can have a cumulative effect on
SquirrelMail performance.
The files that you may need to include in a plugin will vary greatly
depending upon what the plugin is designed to do. For files that are
-requested directly by the client browser, we strongly recommend that
-you include the file include/validate.php, since it will set up the
-SquirrelMail environment automatically. It will ensure the the user
-has been authenticated and is currently logged in, load all user
+requested directly by the client browser, we strongly recommend that
+you include the file include/validate.php, since it will set up the
+SquirrelMail environment automatically. It will ensure the the user
+has been authenticated and is currently logged in, load all user
preferences, include internationalization support, call stripslashes()
-on all incoming data (if magic_quotes_gpc is on), and initialize and
-include all other basic SquirrelMail resources and functions. You may
-see other plugins that directly include other SquirrelMail files, but
-that is no longer necessary and is a hold-over from older SquirrelMail
+on all incoming data (if magic_quotes_gpc is on), and initialize and
+include all other basic SquirrelMail resources and functions. You may
+see other plugins that directly include other SquirrelMail files, but
+that is no longer necessary and is a hold-over from older SquirrelMail
versions.
+List of files, that are included by include/validate.php (If SquirrelMail
+version is not listed, files are included from v.1.3.2.):
+ 1. class/mime.class.php
+ 1.1. class/mime/Rfc822Header.class.php
+ 1.2. class/mime/MessageHeader.class.php
+ 1.3. class/mime/AddressStructure.class.php
+ 1.4. class/mime/Message.class.php
+ 1.5. class/mime/SMimeMessage.class.php
+ 1.6. class/mime/Disposition.class.php
+ 1.7. class/mime/Language.class.php
+ 1.8. class/mime/ContentType.class.php
+ 2. functions/global.php
+ 3. functions/strings.php
+ 4. config/config.php
+ 4.1. config/config_local.php (from 1.4.0rc1)
+ 5. functions/i18n.php
+ 5.1. functions/global.php (from 1.4.0)
+ 6. functions/auth.php
+ 7. include/load_prefs.php
+ 7.1. include/validate.php
+ 7.2. functions/prefs.php
+ 7.3. functions/plugin.php
+ 7.3.1. functions/global.php (from 1.4.0 and 1.5.0)
+ 7.3.2. functions/prefs.php (from 1.5.1)
+ 7.4. functions/constants.php
+ 7.5. do_hook('loading_prefs')
+ 8. functions/page_header.php
+ 8.1. functions/strings.php
+ 8.2. functions/html.php
+ 8.3. functions/imap_mailbox.php
+ 8.3.1. functions/imap_utf7_local.php
+ 8.4. functions/global.php
+ 9. functions/prefs.php
+ 9.1. functions/global.php
+ 9.2. $prefs_backend (from 1.4.3rc1 and 1.5.0)
+ functions/db_prefs.php
+ functions/file_prefs.php
+ 9.2.1. functions/display_messages.php
+ (loaded only by file_prefs.php)
Hook Types: Parameters and Return Values
-----------------------------------------
-Hooks, when executed, are called with one parameter, an array of data
-that is passed to the hook. The first element in the array is the name
-of the hook that is being called. Any other elements in the array are
-dependant on the type of hook that is being called. Most hooks do not
-pass any other data, but be sure to check the hook you are using for
-any useful information it may provide. Generally speaking, in the case
-that any extra data is available here, your plugin should NOT change
-it unless you know what you are doing or it is documented otherwise.
-See below for further discussion of special hook types and the values
+Hooks, when executed, are called with differing parameters and may or may
+not take return values, all depending on the type of hook being called and
+the context in which it is being used. On the source side (where the hook
+call originates), all hooks have at least one parameter, which is the
+name of the hook. After that, things get complicated.
+
+ do_hook
+ -------
+ Most hook calls don't pass any data and don't ask for anything back.
+ These always use the do_hook call. A limited number of do_hook calls do
+ pass some extra parameters, in which case your plugin may modify the
+ given data if you do so by reference. It is not necessary to return
+ anything from your function in such a case; modifying the parameter
+ data by reference is what does the job (although the hook call itself
+ (in the source) must grab the return value for this to work). Note
+ that in this case, the parameter to your hook function will be an array,
+ the first element simply being the hook name, followed by any other
+ parameters that may have been included in the actual hook call in the
+ source. Modify parameters with care!
+
+ do_hook_function
+ ----------------
+ This hook type was intended to be the main hook type used when the
+ source needs to get something back from your plugin. It is somewhat
+ limited in that it will only use the value returned from the LAST
+ plugin registered against the hook. The source for this hook might
+ use the return value for internal purposes, or might expect you to
+ provide text or HTML to be sent to the client browser (you'll have to
+ look at its use in context to understand how you should return values
+ here). The parameters that your hook function gets will be anything
+ you see AFTER the hook name in the actual hook call in the source.
+ These cannot be changed in the same way that the do_hook parameters
+ can be.
+
+ concat_hook_function
+ --------------------
+ This is a newer hook type meant to address the shortcomings of
+ do_hook_function; specifically in that it uses the return values of
+ all plugins registered against the hook. In order to do so, the
+ return value is assumed to be a string, which is just piled on top
+ of whatever it got from the other plugins working on the same hook.
+ Again, you'll have to inspect the source code to see how such data
+ is put to use, but most of the time, it is used to create a string
+ of HTML to be inserted into the output page. The parameters that
+ your hook function will get are the same as for the do_hook_function;
+ they are anything AFTER the hook name in the actual hook call in the
+ source.
+
+ boolean_hook_function
+ ---------------------
+ The newest of the SquirrelMail hooks, this type is used to let all
+ plugins registered against the hook to "vote" for some action. What
+ that action is is entirely dependent on how the hook is used in the
+ source (look for yourself). Plugins make their "vote" by returning
+ TRUE or FALSE. This hook may be configured to "tally votes" in one
+ of three ways. This configuration is done with the third parameter
+ in the hook call in the source:
+ > 0 -- Any one or more TRUEs will override any FALSEs
+ < 0 -- Any one or more FALSEs will override any TRUEs
+ = 0 -- Majority wins. Ties are broken in this case with
+ the last parameter in the hook call in the source.
+ Your hook function will get the second paramter in the hook call in
+ the source as its parameter (this might be an array if multiple values
+ need to be passed).
-Most hooks, when executed, are called using the do_hook() function,
-where no return value is used. There are a limited number of hooks,
-however, that are called using the do_hook_function() and
-concat_hook_function() function calls. Both of these hook types may
-use the value returned by your plugin for its own purposes or to
-display in the resultant HTML output (you need to research the specific
-hook to determine its use). The do_hook_function() type hook will
-only use the return value it retrieves from the LAST plugin in the
-list of plugins registered against such a hook, whereas the
-concat_hook_function() type hook will concatenate the return values
-from all plugins that are registered against the hook and use that
-value (usually as a string of HTML code to output to the client).
+See below for further discussion of special hook types and the values
List of Hooks
Hook Name Found In Called With(#)
--------- -------- --------------
+ abook_init functions/addressbook.php do_hook
+ abook_add_class functions/addressbook.php do_hook
loading_constants functions/constants.php do_hook
+ logout_error functions/display_messages.php do_hook
+ error_box functions/display_messages.php concat_hook
get_pref_override functions/file_prefs.php hook_func
get_pref functions/file_prefs.php hook_func
special_mailbox functions/imap_mailbox.php hook_func
% rename_or_delete_folder functions/imap_mailbox.php hook_func
- msg_envelope functions/mailbox_display.php do_hook
mailbox_index_before functions/mailbox_display.php do_hook
mailbox_form_before functions/mailbox_display.php do_hook
mailbox_index_after functions/mailbox_display.php do_hook
check_handleAsSent_result functions/mailbox_display.php do_hook
subject_link functions/mailbox_display.php concat_hook
mailbox_display_buttons functions/mailbox_display.php do_hook
+ mailbox_display_button_action functions/mailbox_display.php hook_func
message_body functions/mime.php do_hook
^ attachment $type0/$type1 functions/mime.php do_hook
attachments_bottom functions/mime.php hook_func
+ decode_body functions/mime.php hook_func
generic_header functions/page_header.php do_hook
menuline functions/page_header.php do_hook
internal_link functions/page_header.php hook_func
left_main_after_each_folder src/left_main.php concat_hook
left_main_before src/left_main.php do_hook
left_main_after src/left_main.php do_hook
- create_collapse_link src/left_main.php hook_func
login_cookie src/login.php do_hook
login_top src/login.php do_hook
login_form src/login.php do_hook
login_bottom src/login.php do_hook
- move_before_move src/move_messages.php do_hook
- move_messages_button_action src/move_messages.php concat_hook
* optpage_set_loadinfo src/options.php do_hook
* optpage_loadhook_personal src/options.php do_hook
* optpage_loadhook_display src/options.php do_hook
& options_identities_buttons src/options_identities.php concat_hook
message_body src/printer_friendly_bottom.php do_hook
read_body_header src/read_body.php do_hook
- read_body_menu_top src/read_body.php do_hook
+ read_body_menu_top src/read_body.php hook_func
read_body_menu_bottom src/read_body.php do_hook
read_body_header_right src/read_body.php do_hook
- html_top src/read_body.php do_hook
read_body_top src/read_body.php do_hook
read_body_bottom src/read_body.php do_hook
- html_bottom src/read_body.php do_hook
login_before src/redirect.php do_hook
login_verified src/redirect.php do_hook
generic_header src/right_main.php do_hook
search_bottom src/search.php do_hook
logout src/signout.php do_hook
webmail_top src/webmail.php do_hook
- webmail_bottom src/webmail.php do_hook
+ webmail_bottom src/webmail.php concat_hook
logout_above_text src/signout.php concat_hook
-
+ O info_bottom plugins/info/options.php do_hook
+
% = This hook is used in multiple places in the given file
# = Called with hook type (see below)
& = Special identity hooks (see below)
^ = Special attachments hook (see below)
* = Special options hooks (see below)
+O = optional hook used by plugin
(#) Called With
options_identities_process
- This hook is called at the top of the Identities page, which is
+ This hook is called at the top of the Identities page, which is
most useful when the user has changed any identity settings - this
is where you'll want to save any custom information you are keeping
for each identity or catch any custom submit buttons that you may
options_identities_renumber
This hook is called when one of the identities is being renumbered,
- such as if the user had three identities and deletes the second -
+ such as if the user had three identities and deletes the second -
this hook would be called with an array that looks like this:
('options_identities_renumber', 2, 1). The arguments to this hook
are:
[0] = hook name (always "options_identities_renumber")
[1] = being renumbered from ('default' or 1 through (# idents) - 1)
[2] = being renumbered to ('default' or 1 through (# idents) - 1)
-
+
options_identities_table
This hook allows you to insert additional rows into the table that
holds each identity. The arguments to this hook are:
[0] = color of table (use it like this in your plugin:
- <tr bgcolor="<?PHP echo $info[1]?>">
+ <tr bgcolor="<?php echo $info[1]; ?>">
[1] = is this an empty section (the one at the end of the list)?
[2] = what is the 'post' value? (ident # or empty string if default)
You need to return any HTML you would like to add to the table.
You could add a table row with code similar to this:
- function demo_identities_table(&$args)
+ function demo_identities_table(&$args)
{
return '<tr bgcolor="' . $args[0] . '"><td> </td><td>'
. 'YOUR CODE HERE' . '</td></tr>' . "\n";
}
-
+
options_identities_buttons
This hook allows you to add a button (or other HTML) to the row of
[0] = is this an empty section (the one at the end of the list)?
[1] = what is the 'post' value? (ident # or empty string if default)
- You need to return any HTML you would like to add here. You could add
+ You need to return any HTML you would like to add here. You could add
a button with code similar to this:
function demo_identities_button(&$args)
{
return '<input type="submit" name="demo_button_' . $args[1]
- . '" value="Press Me">';
+ . '" value="Press Me" />';
}
[7] = Filename that is displayed for the attachment
[8] = Sent if message was found from a search (where)
[9] = Sent if message was found from a search (what)
-
+
To set up links for actions, you assign them like this:
-
+
$Args[1]['<plugin_name>']['href'] = 'URL to link to';
- $Args[1]['<plugin_name>']['text'] = 'What to display';
-
+ $Args[1]['<plugin_name>']['text'] = _("What to display");
+
+Note: _("What to display") is explained in the section about
+internationalization.
+
It's also possible to specify a hook as "attachment type0/*",
for example "attachment text/*". This hook will be executed whenever there's
no more specific rule available for that type.
function demo_handle_zip_attachment_do(&$Args)
{
$Args[1]['demo']['href'] = SM_PATH . 'plugins/demo/zip_handler.php?'
- . 'passed_id=' . $Args[3] . '&mailbox=' . $Args[4]
+ . 'passed_id=' . $Args[3] . '&mailbox=' . $Args[4]
. '&passed_ent_id=' . $Args[5];
- $Args[1]['demo']['text'] = 'show zip contents';
+ $Args[1]['demo']['text'] = _("Show zip contents");
}
The file plugins/demo/zip_handler.php can now do whatever it needs with the
(*) Options
-----------
Before you start adding user preferences to your plugin, please take a moment
-to think about it: in some cases, more options may not be a good thing.
-Having too many options can be confusing. Thinking from the user's
+to think about it: in some cases, more options may not be a good thing.
+Having too many options can be confusing. Thinking from the user's
perspective, will the proposed options actually be used? Will users
understand what these options are for?
There are two ways to add options for your plugin. When you only have a few
options that don't merit an entirely new preferences page, you can incorporate
-them into an existing section of SquirrelMail preferences (Personal
-Information, Display Preferences, Message Highlighting, Folder Preferences or
-Index Order). Or, if you have an extensive number of settings or for some
+them into an existing section of SquirrelMail preferences (Personal
+Information, Display Preferences, Message Highlighting, Folder Preferences or
+Index Order). Or, if you have an extensive number of settings or for some
reason need a separate page for the user to interact with, you can create your
own preferences page.
---------------------------------------------------------------------
There are two ways to accomplish the integration of your plugin's settings
-into another preferences page. The first method is to add the HTML code
+into another preferences page. The first method is to add the HTML code
for your options directly to the preferences page of your choice. Although
currently very popular, this method will soon be deprecated, so avoid it
-if you can. That said, here is how it works. :) Look for any of the hooks
-named as "options_<pref page>_inside", where <pref page> is "display",
-"personal", etc. For this example, we'll use "options_display_inside" and,
+if you can. That said, here is how it works. :) Look for any of the hooks
+named as "options_<pref page>_inside", where <pref page> is "display",
+"personal", etc. For this example, we'll use "options_display_inside" and,
as above, "demo" as our plugin name:
1. In setup.php in the squirrelmail_plugin_init_demo() function:
- $squirrelmail_plugin_hooks['options_display_inside']['demo']
+ $squirrelmail_plugin_hooks['options_display_inside']['demo']
= 'demo_show_options';
Note that there are also hooks such as "options_display_bottom",
<td>
OPTION_INPUT
</td>
- </tr>
+ </tr>
------cut here-------
Of course, you can place any text where OPTION_NAME is and any input
- tags where OPTION_INPUT is.
+ tags where OPTION_INPUT is.
3. You will want to use the "options_<pref page>_save" hook (in this case,
"options_display_save") to save the user's settings after they have
- pressed the "Submit" button. Again, back in setup.php in the
+ pressed the "Submit" button. Again, back in setup.php in the
squirrelmail_plugin_init_demo() function:
- $squirrelmail_plugin_hooks['options_display_save']['demo']
+ $squirrelmail_plugin_hooks['options_display_save']['demo']
= 'demo_save_options';
4. Assuming the function demo_save_options() calls another function
The second way to add options to one of the SquirrelMail preferences page is
to use one of the "optpage_loadhook_<pref page>" hooks. The sent_subfolders
-plugin is an excellent example of this method. Briefly, this way of adding
+plugin has an excellent example of this method. Briefly, this way of adding
options consists of adding some plugin-specific information to a predefined
data structure which SquirrelMail then uses to build the HTML input forms
for you. This is the preferred method of building options lists going forward.
1. We'll use the "optpage_loadhook_display" hook to add a new group of
- options to the display preferences page. In setup.php in the
+ options to the display preferences page. In setup.php in the
squirrelmail_plugin_init_demo() function:
- $squirrelmail_plugin_hooks['optpage_loadhook_display']['demo']
+ $squirrelmail_plugin_hooks['optpage_loadhook_display']['demo']
= 'demo_options';
2. Assuming the function demo_options() calls another function elsewhere
arrays, $optpage_data['grps'] and $optpage_data['vals']. The value
associated with that key should simply be a section heading for your
plugin on the preferences page for the $optpage_data['grps'] array,
- and yet another array with all of your plugin's options for the
- $optpage_data['vals'] array. The options are built as arrays (yes,
+ and yet another array with all of your plugin's options for the
+ $optpage_data['vals'] array. The options are built as arrays (yes,
that's four levels of nested arrays) that specify attributes that are
used by SquirrelMail to build your HTML input tags automatically.
This example includes just one input element, a SELECT (drop-down)
setting in the user's preferences
caption The text that prefaces this setting on the preferences
page
+ trailing_text Text that follows a text input or select list input on
+ the preferences page (useful for indicating units,
+ meanings of special values, etc.)
type The type of INPUT element, which should be one of:
SMOPT_TYPE_STRING String/text input
SMOPT_TYPE_STRLIST Select list input
SMOPT_TYPE_INTEGER Integer input
SMOPT_TYPE_FLOAT Floating point number input
SMOPT_TYPE_BOOLEAN Boolean (yes/no radio buttons)
- input
+ input
SMOPT_TYPE_HIDDEN Hidden input (not actually
shown on preferences page)
SMOPT_TYPE_COMMENT Text is shown (specified by the
only the folder list
SMOPT_REFRESH_ALL Link is shown to refresh
the entire window
- initial_value The value that should initially be placed in this
+ initial_value The value that should initially be placed in this
INPUT element
posvals For select lists, this should be an associative array,
where each key is an actual input value and the
input
save You may indicate that special functionality needs to be
used instead of just saving this setting by giving the
- name of a function to call when this value would
+ name of a function to call when this value would
otherwise just be saved in the user's preferences
size Specifies the size of certain input items (typically
textual inputs). Possible values are:
SMOPT_SIZE_NORMAL
comment For SMOPT_TYPE_COMMENT type options, this is the text
displayed to the user
- script This is where you may add any additional javascript
+ script This is where you may add any additional javascript
or other code to the user input
post_script You may specify some script (usually Javascript) that
will be placed after (outside of) the INPUT tag.
+ htmlencoded disables html sanitizing. WARNING - don't use it, if user
+ input is possible in option or use own sanitizing functions.
+ Currently works only with SMOPT_TYPE_STRLIST.
+
+ Note that you do not have to create a whole new section on the options
+ page if you merely want to add a simple input item or two to an options
+ section that already exists. For example, the Display Options page has
+ these groups:
+
+ 0 - General Display Options
+ 1 - Mailbox Display Options
+ 2 - Message Display and Composition
+
+ To add our previous input drop-down to the Mailbox Display Options,
+ we would not have to create our own group; just add it to group
+ number one:
+
+ global $optpage_data;
+ $optpage_data['vals'][1][] = array(
+ 'name' => 'plugin_demo_favorite_color',
+ 'caption' => 'Please Choose Your Favorite Color',
+ 'type' => SMOPT_TYPE_STRLIST,
+ 'refresh' => SMOPT_REFRESH_ALL,
+ 'posvals' => array(0 => 'red',
+ 1 => 'blue',
+ 2 => 'green',
+ 3 => 'orange'),
+ 'save' => 'save_plugin_demo_favorite_color'
+ );
3. If you indicated a 'save' attribute for any of your options, you must
create that function (you'll only need to do this if you need to do
some special processing for one of your settings). The function gets
- one parameter, which is an object with mostly the same attributes you
+ one parameter, which is an object with mostly the same attributes you
defined when you made the option above... the 'new_value' (and possibly
'value', which is the current value for this setting) is the most useful
attribute in this context:
----------------------------------
It is also possible to create your own preferences page for a plugin. This
-is particularly useful when your plugin has numerous options or needs to
+is particularly useful when your plugin has numerous options or needs to
offer special interaction with the user (for things such as changing password,
etc.). Here is an outline of how to do so (again, using the "demo" plugin
name):
- 1. Add a new listing to the main Options page. Older versions of
+ 1. Add a new listing to the main Options page. Older versions of
SquirrelMail offered a hook called "options_link_and_description"
although its use is deprecated (and it is harder to use in that
it requires you to write your own HTML to add the option). Instead,
create a simple array that lets SquirrelMail build the HTML
to add the plugin options entry automatically. In setup.php in the
squirrelmail_plugin_init_demo() function:
-
+
$squirrelmail_plugin_hooks['optpage_register_block']['demo']
= 'demo_options_block';
js Indicates if this option page requires the client browser
to be Javascript-capable. Should be TRUE or FALSE.
- 3. There are two different ways to create the actual preferences page
- itself. One is to simply write all of your own HTML and other
- interactive functionality, while the other is to define some data
+ 3. There are two different ways to create the actual preferences page
+ itself. One is to simply write all of your own HTML and other
+ interactive functionality, while the other is to define some data
structures that allow SquirrelMail to build your user inputs and save
- your data automatically.
+ your data automatically.
- Building your own page is wide open, and for ideas, you should look at
+ Building your own page is wide open, and for ideas, you should look at
any of the plugins that currently have their own preferences pages. If
- you do this, make sure to read step number 4 below for information on
- saving settings. In order to maintain security, consistant look and
+ you do this, make sure to read step number 4 below for information on
+ saving settings. In order to maintain security, consistant look and
feel, internationalization support and overall integrity, there are just
a few things you should always do in this case: define the SM_PATH
constant, include the file include/validate.php (see the section about
From here you are on your own, although you are encouraged to do things
such as use the $color array to keep your HTML correctly themed, etc.
- If you want SquirrelMail to build your preferences page for you,
- creating input forms and automatically saving users' settings, then
+ If you want SquirrelMail to build your preferences page for you,
+ creating input forms and automatically saving users' settings, then
you should change the 'url' attribute in the options block you created
in step number 2 above to read as follows:
'url' => SM_PATH . 'src/options.php?optpage=plugin_demo',
- Now, you will need to use the "optpage_set_loadinfo" hook to tell
- SquirrelMail about your new preferences page. In setup.php in the
+ Now, you will need to use the "optpage_set_loadinfo" hook to tell
+ SquirrelMail about your new preferences page. In setup.php in the
squirrelmail_plugin_init_demo() function:
-
+
$squirrelmail_plugin_hooks['optpage_set_loadinfo']['demo']
= 'demo_optpage_loadinfo';
Assuming the function demo_optpage_loadinfo() calls another function
- elsewhere called demo_optpage_loadinfo_do(), that function needs to
- define values for four variables (make sure you test to see that it
+ elsewhere called demo_optpage_loadinfo_do(), that function needs to
+ define values for four variables (make sure you test to see that it
is your plugin that is being called by checking the GET variable you
added to the url just above):
-
- global $optpage, $optpage_name, $optpage_file,
+
+ global $optpage, $optpage_name, $optpage_file,
$optpage_loader, $optpage_loadhook;
if ($optpage == 'plugin_demo')
{
4. Saving your options settings: if you used the second method in step
number 3 above, your settings will be saved automatically (or you can
- define special functions to save special settings such as the
+ define special functions to save special settings such as the
save_plugin_demo_favorite_color() function in the example described
above) and there is probably no need to follow this step. If you
created your own preferences page from scratch, you'll need to follow
this step. First, you need to register your plugin against the
"options_save" hook. In setup.php in the squirrelmail_plugin_init_demo()
function:
-
+
$squirrelmail_plugin_hooks['options_save']['demo']
= 'demo_save_options';
elsewhere called demo_save_options_do(), that function needs to grab
all of your POST and/or GET settings values and save them in the user's
preferences (for more about preferences, see that section below). Since
- this is a generic hook called for all custom preferences pages, you
+ this is a generic hook called for all custom preferences pages, you
should always set "optpage" as a POST or GET variable with a string that
uniquely identifies your plugin:
- <input type="hidden" name="optpage" value="plugin_demo">
+ <input type="hidden" name="optpage" value="plugin_demo" />
Now in your demo_save_options_do() function, do something like this:
sqgetGlobalVar('favorite_color', $favorite_color, SQ_FORM);
setPref($data_dir, $username, 'favorite_color', $favorite_color);
}
-
- Note that $favorite_color may not need to be globalized, although
+
+ Note that $favorite_color may not need to be globalized, although
experience has shown that some versions of PHP don't behave as expected
unless you do so. Even when you use SquirrelMail's built-in preferences
- page generation functionality, you may still use this hook, although
- there should be no need to do so. If you need to do some complex
+ page generation functionality, you may still use this hook, although
+ there should be no need to do so. If you need to do some complex
validation routines, note that it might be better to do so in the file
you specified as the "$optpage_file" (in our example, that was the
- plugins/demo/options.php file), since at this point, you can still
+ plugins/demo/options.php file), since at this point, you can still
redisplay your preferences page. You could put code similar to this
in the plugins/demp/options.php file (note that there is no function;
this code needs to be executed at include time):
global $optmode;
- if ($optmode == 'submit')
+ if ($optmode == 'submit')
{
// do something here such as validation, etc
if (you want to redisplay your preferences page)
-----------
Saving and retrieving user preferences is very easy in SquirrelMail.
-SquirrelMail supports preference storage in files or in a database
+SquirrelMail supports preference storage in files or in a database
backend, however, the code you need to write to manipulate preferences
is the same in both cases.
-Setting preferences:
+Setting preferences:
Setting preferences is done for you if you use the built-in facilities
for automatic options construction and presentation (see above). If
setPref($data_dir, $username, 'pref_name', $pref_value);
Where "pref_name" is the key under which the value will be stored
- and "pref_value" is a variable that should contain the actual
+ and "pref_value" is a variable that should contain the actual
preference value to be stored.
Loading preferences:
There are two approaches to retrieving plugin (or any other) preferences.
You can grab individual preferences one at a time or you can add your
- plugin's preferences to the routine that loads up user preferences at
+ plugin's preferences to the routine that loads up user preferences at
the beginning of each page request. If you do the latter, making sure
to place your preference variables into the global scope, they will be
immediately available in all other plugin code. To retrieve a single
made, you'll need to register a function against the "loading_prefs" hook.
For our "demo" plugin, in setup.php in the squirrelmail_plugin_init_demo()
function:
-
+
$squirrelmail_plugin_hooks['loading_prefs']['demo']
= 'demo_load_prefs';
more information).
There are three basic steps to getting your plugins internationalized: put
-all output into the proper format, switch gettext domains and create locale
+all output into the proper format, switch gettext domains and create locale
files.
1. Putting plugin output into the correct format is quite easy. The hard
So, even in the HTML segments of your plugin files, you need to do this:
- <input type="submit" value="<?php echo _("Submit") ?>">
+ <input type="submit" value="<?php echo _("Submit"); ?>" />
You can put any text you want inside of the quotes (you MUST use double
- quotes!), including HTML tags, etc. What you should think carefully
- about is that some languages may use different word ordering, so this
+ quotes!), including HTML tags, etc. What you should think carefully
+ about is that some languages may use different word ordering, so this
might be problematic:
echo _("I want to eat a ") . $fruitName . _(" before noon");
Because some languages (Japanese, for instance) would need to translate
- such a sentence to "Before noon " . $fruitName . " I want to eat", but
- with the format above, they are stuck having to translate each piece
+ such a sentence to "Before noon " . $fruitName . " I want to eat", but
+ with the format above, they are stuck having to translate each piece
separately. You might want to reword your original sentence:
echo _("This is what I want to eat before noon: ") . $fruitName;
out most of the strings that you need to have translated from your PHP
files into a sample .po file:
- xgettext --keyword=_ -d <plugin name> -s -C *.php
+ xgettext --keyword=_ -d <plugin name> -s -C *.php
--keyword option tells xgettext what your strings are enclosed in
-d is the domain of your plugin which should be the plugin's name
-C means you are translating a file with C/C++ type syntax (ie. PHP)
*.php is all the files you want translations for
- Note, however, that this will not always pick up all strings, so you
+ Note, however, that this will not always pick up all strings, so you
should double-check manually. Of course, it's easiest if you just keep
track of all your strings as you are coding your plugin. Your .po file
will now look something like:
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: ENCODING\n"
-
+
#: functions.php:45
msgid "Hello"
msgstr ""
-
+
#: functions.php:87
msgid "Favorite Color"
msgstr ""
-
+
You should change the header to look something more like:
# Copyright (c) 1999-2003 The Squirrelmail Development Team
# Roland Bauerschmidt <rb@debian.org>, 1999.
+ # $Id$
msgid ""
msgstr ""
- "Project-Id-Version: $Id: squirrelmail.po,v 1.10 2003/06/04 15:01:59
- philippe_mingo Exp $\n"
+ "Project-Id-Version: plugin-name version\n"
"POT-Creation-Date: 2003-01-21 19:21+0100\n"
"PO-Revision-Date: 2003-01-21 21:01+0100\n"
"Last-Translator: Juergen Edner <juergen.edner@epost.de>\n"
The most important thing to change here is the charset on the next to
last line. You'll want to keep a master copy of the .po file and make
- a copy for each language you have a translation for. You'll need to
+ a copy for each language you have a translation for. You'll need to
translate each string in the .po file:
msgid "Hello"
msgstr "Guten Tag"
- After you're done translating, you can create the .mo file very simply
+ After you're done translating, you can create the .mo file very simply
by running the following command (available on most linux systems):
msgfmt -o <plugin name>.mo <plugin name>.po
and change your Language setting to see the translations in action!
+
+Documenting the Code (Optional)
+-------------------------------
+
+If you wish, you can use phpdoc (Javadoc-style) comments, when documenting your
+code.
+
+If you follow the standards that are followed between Squirrelmail core &
+plugin developers, the resulted documentation can be included with the rest of
+the Squirrelmail code & API documentation. Specifically, in the page-level
+docblock, declare the package to be 'plugins', and the subpackage to be the
+name of your plugin. For instance:
+
+/**
+ * demo.php
+ *
+ * Copyright (c) 2003 My Name <my-email-address>
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * @package plugins
+ * @subpackage demo
+ */
+
+The rest is up to you. Try to follow some common sense and document what is
+really needed. Documenting the code properly can be a big help not only to
+yourself, but to those who will take a look at your code, fix the bugs and even
+improve it, in the true open-source spirit that Squirrelmail was built upon.
+
+For more information about phpdocumentor and how to write proper-tagged
+comments, you are directed at:
+
+http://phpdocu.sourceforge.net/
+
+
+
PLUGIN STANDARDS AND REQUIREMENTS
=================================
small and providing the fastest webmail client on the Internet. As such,
we'd like it if plugin authors coded with the same goals in mind that the
core developers do. Common sense is always a good tool to have in your
-programming repertoire, but below is an outline of some standards that we
-ask you as a plugin developer to meet. Depending upon how far you bend
-these rules, we may not want to post your plugin on the SquirrelMail
+programming repertoire, but below is an outline of some standards that we
+ask you as a plugin developer to meet. Depending upon how far you bend
+these rules, we may not want to post your plugin on the SquirrelMail
website... and of course, no one really wants your efforts to go to waste
and for the SquirrelMail community to miss out on a potentially useful
plugin, so please try to follow these guidelines as closely as possible.
you'll need functions that are merely stubs for each hook that you are using.
One (but not the only) way to do it is:
- function squirrelmail_plugin_init_demo()
+ function squirrelmail_plugin_init_demo()
{
global $squirrelmail_plugin_hooks;
$squirrelmail_plugin_hooks['generic_header']['demo'] = 'plugin_demo_header';
Internationalization
--------------------
-Q: What is more disappointing to users in France who would make good
+Q: What is more disappointing to users in France who would make good
use of your plugin than learning that it is written entirely in English?
A: Learning that they cannot send you a French translation file for your
plugin.
There are thousands of users out there whose native tongue is not English,
and when you develop your plugin without going through the three simple steps
-needed to internationalize it, you are effectively writing them all off.
+needed to internationalize it, you are effectively writing them all off.
PLEASE consider internationalizing your plugin!
------------
When including files, please make sure to use the include_once() function
-and NOT include(), require(), or require_once(), since these all are much
-less efficient than include_once() and can have a cumulative effect on
+and NOT include(), require(), or require_once(), since these all are much
+less efficient than include_once() and can have a cumulative effect on
SquirrelMail performance.
In order for systems administrators to keep better track of your plugin and
get upgrades more efficiently, you are requested to make version information
-available to SquirrelMail in a format that it understands. There are two
-ways to do this. Presently, we are asking that you do both, since we are
-still in a transition period between the two. This is painless, so please
+available to SquirrelMail in a format that it understands. There are two
+ways to do this. Presently, we are asking that you do both, since we are
+still in a transition period between the two. This is painless, so please
be sure to include it:
1. Create a file called "version" in the plugin directory. That file
should have only two lines: the first line should have the name of
the plugin as named on the SquirrelMail web site (this is often a
- prettified version of the plugin directory name), the second line
+ prettified version of the plugin directory name), the second line
must have the version and nothing more. So for our "demo" plugin,
- whose name on the web site might be something like "Demo Favorite
+ whose name on the web site might be something like "Demo Favorite
Colors", the file plugins/demo/version should have these two lines:
Demo Favorite Colors
should place all behavioral settings in a config file, isolated from the
rest of your plugin code. A typical file name to use is "config.php". If
you are using such a file, you should NOT include a file called "config.php"
-in your plugin distribution, but instead a copy of that file called
+in your plugin distribution, but instead a copy of that file called
"config.php.sample". This helps systems administrators avoid overwriting
the "config.php" files and losing all of their setup information when they
upgrade your plugin.
In the past, there have been some rather serious issues with PHP sessions
and SquirrelMail, and certain people have worked long and hard to ensure
that these problems no longer occur in an extremely wide variety of OS/PHP/
-web server environments. Thus, if you need to place any values into the
-user's session, there are some built-in SquirrelMail functions that you are
+web server environments. Thus, if you need to place any values into the
+user's session, there are some built-in SquirrelMail functions that you are
strongly encouraged to make use of. Using them also makes your job easier.
1. To place a variable into the session:
- global $favorite_color;
+ global $favorite_color;
$favoriteColor = 'green';
sqsession_register($favorite_color, 'favorite_color');
Form Variables
--------------
-You are also encouraged to use SquirrelMail's built-in facilities to
+You are also encouraged to use SquirrelMail's built-in facilities to
retrieve variables from POST and GET submissions. This is also much
easier on you and makes sure that all PHP installations are accounted
-for (such as those that don't make the $_POST array automatically
+for (such as those that don't make the $_POST array automatically
global, etc.):
global $favorite_color;
There are a few files that you should make sure to include when you build
your final plugin distribution:
- 1. A copy of the file index.php from the main plugins directory. When
+ 1. A copy of the file index.php from the main plugins directory. When
working in your plugin directory, just copy it in like this:
$ cp ../index.php .
your plugin directory, you may copy the file there as well to be extra
safe. If you are storing sensitive configuration files or other data
in such a directory, you could even include a .htaccess file with the
- contents "Deny From All" that will disallow access to that directory
+ contents "Deny From All" that will disallow access to that directory
entirely (when the target system is running the Apache web server).
Keep in mind that not all web servers will honor an .htaccess file, so
don't depend on it for security. Make sure not to put such a file in
your main plugin directory!
- 2. A file that describes your plugin and offers detailed instructions for
- configuration or help with troubleshooting, etc. This file is usually
+ 2. A file that describes your plugin and offers detailed instructions for
+ configuration or help with troubleshooting, etc. This file is usually
entitled "README". Some useful sections to include might be:
Plugin Name and Author
Future Ideas/Enhancements/To Do List
3. A file that explains how to install your plugin. This file is typically
- called "INSTALL". If you do not require any special installation
+ called "INSTALL". If you do not require any special installation
actions, you can probably copy one from another plugin or use this as
a template:
to config.php and edit config.php, making adjustments as
you deem necessary. For more detailed explanations about
each of these parameters, consult the README file.
-
+
$ cd demo
$ cp config.php.sample config.php
$ vi config.php
-
-
+
+
3) Then go to your config directory and run conf.pl. Choose
option 8 and move the plugin from the "Available Plugins"
category to the "Installed Plugins" category. Save and exit.
-
+
$ cd ../../config/
$ ./conf.pl
-
+
Upgrading the Demo Plugin
=========================
settings that you must add to your config.php file.
$ diff -Nau config.php config.php.sample
-
+
Or simply replace your config.php file with the provided sample
and reconfigure the plugin from scratch (see step 2 under the
installation procedure above).
time, especially when the new SquirrelMail version contains any architectural
and/or functional changes, plugin developers are put in a unique and very
difficult position. That is, there will be people running both the old and
-new versions of SquirrelMail who want to use your plugin, and you will
+new versions of SquirrelMail who want to use your plugin, and you will
probably want to accomodate them both.
The easiest way to keep both sides happy is to keep two different versions
especially if you are continuing to develop the plugin. Depending on the
changes the SquirrelMail has implemented in the new version, you may be able
to include code that can auto-sense SquirrelMail version and make adjustments
-on the fly. There is a function available to you for determining the
+on the fly. There is a function available to you for determining the
SquirrelMail version called check_sm_version() and it can be used as such:
check_sm_version(1, 4, 0)
1.0 is the version of your plugin
1.4.0 is the version of SquirrelMail that is required to run your plugin
- You can also create the distribution file manually in most *nix
- environments by running this command from the plugins directory (NOT
+ You can also create the distribution file manually in most *nix
+ environments by running this command from the plugins directory (NOT
your plugin directory):
$ tar czvf demo-1.0-1.4.0.tar.gz demo
to use your plugin.
2. Consult the SquirrelMail web site for contact information for the
- Plugins Team Leaders, to whom you should make your request. If they
- do not respond, you should feel free to ask for help contacting them
+ Plugins Team Leaders, to whom you should make your request. If they
+ do not respond, you should feel free to ask for help contacting them
on the squirrelmail-plugins mailing list.
http://www.squirrelmail.org/wiki/wiki.php?SquirrelMailLeadership
projects / squirrelmail.git / blobdiff