64ca8f0a40af6d3f7f6a8e333dadd7510731b5af
[squirrelmail.git] / doc / Development / plugin.txt
1 $Id$
2
3 In addition to this document, please check out the SquirrelMail
4 development FAQ for more information.  Also, help writing plugins
5 is easily obtained by posting to the squirrelmail-plugins mailing
6 list.  (See details about mailing lists on the website)
7
8 FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ
9 Plugin Development ->
10        http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins
11
12
13 A FEW NOTES ON THE PLUGIN ARCHITECTURE
14 ======================================
15
16 The plugin architecture of SquirrelMail is designed to make it possible
17 to add new features without having to patch SquirrelMail itself.
18 Functionality like password changing, displaying ads and calendars should
19 be possible to add as plugins.
20
21
22 The Idea
23 --------
24
25 The idea is to be able to run random code at given places in the
26 SquirrelMail code. This random code should then be able to do whatever
27 needed to enhance the functionality of SquirrelMail. The places where
28 code can be executed are called "hooks".
29
30 There are some limitations in what these hooks can do. It is difficult
31 to use them to change the layout and to change functionality that
32 already is in SquirrelMail.
33
34 Some way for the plugins to interact with the help subsystem and
35 translations will be provided.
36
37
38 The Implementation
39 ------------------
40
41 The plugin jumping off point in the main SquirrelMail code is in the
42 file functions/plugin.php.  In places where hooks are made available,
43 they are executed by calling the function do_hook('hookname').  The
44 do_hook function then traverses the array
45 $squirrelmail_plugin_hooks['hookname'] and executes all the functions
46 that are named in that array.  Those functions are placed there when
47 plugins register themselves with SquirrelMail as discussed below.  A
48 plugin may add its own internal functions to this array under any
49 hook name provided by the SquirrelMail developers.
50
51 A plugin must reside in a subdirectory in the plugins/ directory. The
52 name of the subdirectory is considered to be the name of the plugin.
53 (The plugin will not function correctly if this is not the case.)
54
55 To start using a plugin, its name must be added to the $plugins array
56 in config.php like this:
57
58    $plugins[0] = 'plugin_name';
59
60 When a plugin is registered, the file plugins/plugin_name/setup.php is
61 included and the function squirrelmail_plugin_init_plugin_name() is
62 called with no parameters.  That function is where the plugin may
63 register itself against any hooks it wishes to take advantage of.
64
65
66 WRITING PLUGINS
67 ===============
68
69 All plugins must contain a file called setup.php and must include a
70 function called squirrelmail_plugin_init_plugin_name() therein.  Since
71 including numerous plugins can slow SquirrelMail performance
72 considerably, the setup.php file should contain little else.  Any
73 functions that are registered against plugin hooks should do little
74 more than call another function in a different file.
75
76 Any other files used by the plugin should also be placed in the
77 plugin directory (or subdirectory thereof) and should contain the
78 bulk of the plugin logic.
79
80 The function squirrelmail_plugin_init_plugin_name() is called to
81 initalize a plugin. This function could look something like this (if
82 the plugin was named "demo" and resided in the directory plugins/demo/):
83
84 function squirrelmail_plugin_init_demo ()
85 {
86    global $squirrelmail_plugin_hooks;
87
88    $squirrelmail_plugin_hooks['generic_header']['demo'] = 'plugin_demo_header';
89    $squirrelmail_plugin_hooks['menuline']['demo'] = 'plugin_demo_menuline';
90 }
91
92 Please note that as of SquirrelMail 1.5.0, this function will no longer
93 be called at run time and will instead be called only once at configure-
94 time.  Thus, the inclusion of any dynamic code (anything except hook
95 registration) here is strongly discouraged.
96
97 In this example, the "demo" plugin should also have two other functions
98 in its setup.php file called plugin_demo_header() and plugin_demo_menuline().
99 The first of these might look something like this:
100
101 function plugin_demo_header()
102 {
103    include_once(SM_PATH . 'plugins/demo/functions.php');
104    plugin_demo_header_do();
105 }
106
107 The function called plugin_demo_header_do() would be in the file called
108 functions.php in the demo plugin directory and would contain the plugin's
109 core logic for the "generic_header" hook.
110
111
112 Including Other Files
113 ---------------------
114
115 A plugin may need to reference functionality provided in other
116 files, and therefore need to include those files.  Most of the
117 core SquirrelMail functions are already available to your plugin
118 unless it has any files that are requested directly by the client
119 browser (custom options page, etc.).  In this case, you'll need
120 to make sure you include the files you need (see below).
121
122 Note that as of SquirrelMail 1.4.0, all files are accessed using a
123 constant called SM_PATH that always contains the relative path to
124 the main SquirrelMail directory.  This constant is always available
125 for you to use when including other files from the SquirrelMail core,
126 your own plugin, or other plugins, should the need arise.  If any of
127 your plugin files are requested directly from the client browser,
128 you will need to define this constant before you do anything else:
129
130   define('SM_PATH', '../../');
131
132 Files are included like this:
133
134   include_once(SM_PATH . 'include/validate.php');
135
136 When including files, please make sure to use the include_once() function
137 and NOT include(), require(), or require_once(), since these all are much
138 less efficient than include_once() and can have a cumulative effect on
139 SquirrelMail performance.
140
141 The files that you may need to include in a plugin will vary greatly
142 depending upon what the plugin is designed to do.  For files that are
143 requested directly by the client browser, we strongly recommend that
144 you include the file include/validate.php, since it will set up the
145 SquirrelMail environment automatically.  It will ensure the the user
146 has been authenticated and is currently logged in, load all user
147 preferences, include internationalization support, call stripslashes()
148 on all incoming data (if magic_quotes_gpc is on), and initialize and
149 include all other basic SquirrelMail resources and functions.  You may
150 see other plugins that directly include other SquirrelMail files, but
151 that is no longer necessary and is a hold-over from older SquirrelMail
152 versions.
153
154 List of files, that are included by include/validate.php (If SquirrelMail
155 version is not listed, files are included from v.1.3.2.):
156    1. class/mime.class.php
157       1.1. class/mime/Rfc822Header.class.php
158       1.2. class/mime/MessageHeader.class.php
159       1.3. class/mime/AddressStructure.class.php
160       1.4. class/mime/Message.class.php
161       1.5. class/mime/SMimeMessage.class.php
162       1.6. class/mime/Disposition.class.php
163       1.7. class/mime/Language.class.php
164       1.8. class/mime/ContentType.class.php
165    2. functions/global.php
166    3. functions/strings.php
167    4. config/config.php
168       4.1. config/config_local.php (from 1.4.0rc1)
169    5. functions/i18n.php
170       5.1. functions/global.php (from 1.4.0)
171    6. functions/auth.php
172    7. include/load_prefs.php
173       7.1. include/validate.php
174       7.2. functions/prefs.php
175       7.3. functions/plugin.php
176          7.3.1. functions/global.php (from 1.4.0 and 1.5.0)
177          7.3.2. functions/prefs.php (from 1.5.1)
178       7.4. functions/constants.php
179       7.5. do_hook('loading_prefs')
180          7.5.1. files loaded by plugins that use 'loading_prefs'
181    8. functions/page_header.php
182       8.1. functions/strings.php
183       8.2. functions/html.php
184       8.3. functions/imap_mailbox.php
185          8.3.1. functions/imap_utf7_local.php
186       8.4. functions/global.php
187    9. functions/prefs.php
188       9.1. functions/global.php
189       9.2. $prefs_backend (only in 1.4.3 and 1.5.0)
190            do_hook_function('prefs_backend') (since 1.4.4 and 1.5.1)
191            functions/db_prefs.php
192            functions/file_prefs.php
193          9.2.1. functions/display_messages.php
194                 (loaded only by file_prefs.php)
195          9.2.2. files loaded by plugin that uses 'prefs_backend'
196
197 Hook Types:  Parameters and Return Values
198 -----------------------------------------
199
200 Hooks, when executed, are called with differing parameters and may or may
201 not take return values, all depending on the type of hook being called and
202 the context in which it is being used.  On the source side (where the hook
203 call originates), all hooks have at least one parameter, which is the
204 name of the hook.  After that, things get complicated.
205
206    do_hook
207    -------
208    Most hook calls don't pass any data and don't ask for anything back.
209    These always use the do_hook call.  A limited number of do_hook calls do
210    pass some extra parameters, in which case your plugin may modify the
211    given data if you do so by reference.  It is not necessary to return
212    anything from your function in such a case; modifying the parameter
213    data by reference is what does the job (although the hook call itself
214    (in the source) must grab the return value for this to work).  Note
215    that in this case, the parameter to your hook function will be an array,
216    the first element simply being the hook name, followed by any other
217    parameters that may have been included in the actual hook call in the
218    source.  Modify parameters with care!
219
220    do_hook_function
221    ----------------
222    This hook type was intended to be the main hook type used when the
223    source needs to get something back from your plugin.  It is somewhat
224    limited in that it will only use the value returned from the LAST
225    plugin registered against the hook.  The source for this hook might
226    use the return value for internal purposes, or might expect you to
227    provide text or HTML to be sent to the client browser (you'll have to
228    look at its use in context to understand how you should return values
229    here).  The parameters that your hook function gets will be anything
230    you see AFTER the hook name in the actual hook call in the source.
231    These cannot be changed in the same way that the do_hook parameters
232    can be.
233
234    concat_hook_function
235    --------------------
236    This is a newer hook type meant to address the shortcomings of
237    do_hook_function; specifically in that it uses the return values of
238    all plugins registered against the hook.  In order to do so, the
239    return value is assumed to be a string, which is just piled on top
240    of whatever it got from the other plugins working on the same hook.
241    Again, you'll have to inspect the source code to see how such data
242    is put to use, but most of the time, it is used to create a string
243    of HTML to be inserted into the output page.  The parameters that
244    your hook function will get are the same as for the do_hook_function;
245    they are anything AFTER the hook name in the actual hook call in the
246    source.
247
248    boolean_hook_function
249    ---------------------
250    The newest of the SquirrelMail hooks, this type is used to let all
251    plugins registered against the hook to "vote" for some action.  What
252    that action is is entirely dependent on how the hook is used in the
253    source (look for yourself).  Plugins make their "vote" by returning
254    TRUE or FALSE.  This hook may be configured to "tally votes" in one
255    of three ways.  This configuration is done with the third parameter
256    in the hook call in the source:
257       > 0  --  Any one or more TRUEs will override any FALSEs
258       < 0  --  Any one or more FALSEs will override any TRUEs
259       = 0  --  Majority wins.  Ties are broken in this case with
260                the last parameter in the hook call in the source.
261    Your hook function will get the second paramter in the hook call in
262    the source as its parameter (this might be an array if multiple values
263    need to be passed).
264
265 See below for further discussion of special hook types and the values
266
267
268 List of Hooks
269 -------------
270
271 This is a list of all hooks currently available in SquirrelMail, ordered
272 by file.  Note that this list is accurate as of June 17, 2003 (should be
273 close to what is contained in release 1.4.1, plus or minus a hook or two),
274 but may be out of date soon thereafter.  You never know.  ;-)
275
276   Hook Name                      Found In                        Called With(#)
277   ---------                      --------                        --------------
278   abook_init                     functions/addressbook.php       do_hook
279   abook_add_class                functions/addressbook.php       do_hook
280   loading_constants              functions/constants.php         do_hook
281   logout_error                   functions/display_messages.php  do_hook
282   error_box                      functions/display_messages.php  concat_hook
283   get_pref_override              functions/file_prefs.php        hook_func
284   get_pref                       functions/file_prefs.php        hook_func
285   special_mailbox                functions/imap_mailbox.php      hook_func
286 % rename_or_delete_folder        functions/imap_mailbox.php      hook_func
287   mailbox_index_before           functions/mailbox_display.php   do_hook
288   mailbox_form_before            functions/mailbox_display.php   do_hook
289   mailbox_index_after            functions/mailbox_display.php   do_hook
290   check_handleAsSent_result      functions/mailbox_display.php   do_hook
291   subject_link                   functions/mailbox_display.php   concat_hook
292   mailbox_display_buttons        functions/mailbox_display.php   do_hook
293   mailbox_display_button_action  functions/mailbox_display.php   hook_func
294   message_body                   functions/mime.php              do_hook
295 ^ attachment $type0/$type1       functions/mime.php              do_hook
296   attachments_bottom             functions/mime.php              hook_func
297   decode_body                    functions/mime.php              hook_func
298   generic_header                 functions/page_header.php       do_hook
299   menuline                       functions/page_header.php       do_hook
300   prefs_backend                  functions/prefs.php             hook_func
301   loading_prefs                  include/load_prefs.php          do_hook
302   addrbook_html_search_below     src/addrbook_search_html.php    do_hook
303   addressbook_bottom             src/addressbook.php             do_hook
304   compose_form                   src/compose.php                 do_hook
305   compose_bottom                 src/compose.php                 do_hook
306   compose_button_row             src/compose.php                 do_hook
307   compose_send                   src/compose.php                 do_hook
308   folders_bottom                 src/folders.php                 do_hook
309   help_top                       src/help.php                    do_hook
310   help_chapter                   src/help.php                    do_hook
311   help_bottom                    src/help.php                    do_hook
312   left_main_after_each_folder    src/left_main.php               concat_hook
313   left_main_before               src/left_main.php               do_hook
314   left_main_after                src/left_main.php               do_hook
315   login_cookie                   src/login.php                   do_hook
316   login_top                      src/login.php                   do_hook
317   login_form                     src/login.php                   do_hook
318   login_bottom                   src/login.php                   do_hook
319 * optpage_set_loadinfo           src/options.php                 do_hook
320 * optpage_loadhook_personal      src/options.php                 do_hook
321 * optpage_loadhook_display       src/options.php                 do_hook
322 * optpage_loadhook_highlight     src/options.php                 do_hook
323 * optpage_loadhook_folder        src/options.php                 do_hook
324 * optpage_loadhook_order         src/options.php                 do_hook
325 * options_personal_save          src/options.php                 do_hook
326 * options_display_save           src/options.php                 do_hook
327 * options_folder_save            src/options.php                 do_hook
328 * options_save                   src/options.php                 do_hook
329 * optpage_register_block         src/options.php                 do_hook
330 * options_link_and_description   src/options.php                 do_hook
331 * options_personal_inside        src/options.php                 do_hook
332 * options_display_inside         src/options.php                 do_hook
333 * options_highlight_inside       src/options.php                 do_hook
334 * options_folder_inside          src/options.php                 do_hook
335 * options_order_inside           src/options.php                 do_hook
336 * options_personal_bottom        src/options.php                 do_hook
337 * options_display_bottom         src/options.php                 do_hook
338 * options_highlight_bottom       src/options.php                 do_hook
339 * options_folder_bottom          src/options.php                 do_hook
340 * options_order_bottom           src/options.php                 do_hook
341 * options_highlight_bottom       src/options_highlight.php       do_hook
342 & options_identities_process     src/options_identities.php      do_hook
343 & options_identities_top         src/options_identities.php      do_hook
344 &% options_identities_renumber   src/options_identities.php      do_hook
345 & options_identities_table       src/options_identities.php      concat_hook
346 & options_identities_buttons     src/options_identities.php      concat_hook
347   message_body                   src/printer_friendly_bottom.php do_hook
348   read_body_header               src/read_body.php               do_hook
349   read_body_menu_top             src/read_body.php               hook_func
350   read_body_menu_bottom          src/read_body.php               do_hook
351   read_body_header_right         src/read_body.php               do_hook
352   read_body_top                  src/read_body.php               do_hook
353   read_body_bottom               src/read_body.php               do_hook
354   login_before                   src/redirect.php                do_hook
355   login_verified                 src/redirect.php                do_hook
356   generic_header                 src/right_main.php              do_hook
357   right_main_after_header        src/right_main.php              do_hook
358   right_main_bottom              src/right_main.php              do_hook
359   search_before_form             src/search.php                  do_hook
360   search_after_form              src/search.php                  do_hook
361   search_bottom                  src/search.php                  do_hook
362   logout                         src/signout.php                 do_hook
363   webmail_top                    src/webmail.php                 do_hook
364   webmail_bottom                 src/webmail.php                 concat_hook
365   logout_above_text              src/signout.php                 concat_hook
366 O info_bottom                    plugins/info/options.php        do_hook
367
368 % = This hook is used in multiple places in the given file
369 # = Called with hook type (see below)
370 & = Special identity hooks (see below)
371 ^ = Special attachments hook (see below)
372 * = Special options hooks (see below)
373 O = Optional hook provided by a particular plugin
374
375
376 (#) Called With
377 ---------------
378 Each hook is called using the hook type specified in the list above:
379    do_hook       do_hook()
380    hook_func     do_hook_function()
381    concat_hook   concat_hook_function()
382
383
384 (&) Identity Hooks
385 ------------------
386 This set of hooks is passed special information in the array of arguments:
387
388 options_identities_process
389
390    This hook is called at the top of the Identities page, which is
391    most useful when the user has changed any identity settings - this
392    is where you'll want to save any custom information you are keeping
393    for each identity or catch any custom submit buttons that you may
394    have added to the identities page.  The arguments to this hook are:
395
396       [0] = hook name (always "options_identities_process")
397       [1] = should I run the SaveUpdateFunction() (alterable)
398
399    Obviously, set the second array element to 1/true if you want to
400    trigger SaveUpdateFunction() after the hook is finished - by default,
401    it will not be called.
402
403 options_identities_renumber
404
405    This hook is called when one of the identities is being renumbered,
406    such as if the user had three identities and deletes the second -
407    this hook would be called with an array that looks like this:
408    ('options_identities_renumber', 2, 1).  The arguments to this hook
409    are:
410
411       [0] = hook name (always "options_identities_renumber")
412       [1] = being renumbered from ('default' or 1 through (# idents) - 1)
413       [2] = being renumbered to ('default' or 1 through (# idents) - 1)
414
415 options_identities_table
416
417    This hook allows you to insert additional rows into the table that
418    holds each identity.  The arguments to this hook are:
419
420       [0] = additional html attributes applied to table row.
421             use it like this in your plugin:
422                <tr "<?php echo $args[0]; ?>">
423       [1] = is this an empty section (the one at the end of the list)?
424       [2] = what is the 'post' value? (ident # or empty string if default)
425
426    You need to return any HTML you would like to add to the table.
427    You could add a table row with code similar to this:
428
429       function demo_identities_table(&$args)
430       {
431          return '<tr bgcolor="' . $args[0] . '"><td>&nbsp;</td><td>'
432               . 'YOUR CODE HERE' . '</td></tr>' . "\n";
433       }
434
435    First hook argument was modified in 1.4.5/1.5.1. In SquirrelMail 1.4.1-1.4.4 
436    and 1.5.0 argument contains only background color. You should use 
437    <tr bgcolor="<?php echo $args[0]; ?>"> in these SquirrelMail versions.
438
439 options_identities_buttons
440
441    This hook allows you to add a button (or other HTML) to the row of
442    buttons under each identity.  The arguments to this hook are:
443
444       [0] = is this an empty section (the one at the end of the list)?
445       [1] = what is the 'post' value? (ident # or empty string if default)
446
447    You need to return any HTML you would like to add here.  You could add
448    a button with code similar to this:
449
450       function demo_identities_button(&$args)
451       {
452          return '<input type="submit" name="demo_button_' . $args[1]
453               . '" value="Press Me" />';
454       }
455
456
457 (^) Attachment Hooks
458 --------------------
459 When a message has attachments, this hook is called with the MIME types.  For
460 instance, a .zip file hook is "attachment application/x-zip".  The hook should
461 probably show a link to do a specific action, such as "Verify" or "View" for a
462 .zip file.  Thus, to register your plugin for .zip attachments, you'd do this
463 in setup.php (assuming your plugin is called "demo"):
464
465    $squirrelmail_plugin_hooks['attachment application/x-zip']['demo']
466       = 'demo_handle_zip_attachment';
467
468 This is a breakdown of the data passed in the array to the hook that is called:
469
470   [0] = Hook's name ('attachment text/plain')
471   [1] = Array of links of actions (see below) (alterable)
472   [2] = Used for returning to mail message (startMessage)
473   [3] = Used for finding message to display (id)
474   [4] = Mailbox name, urlencode()'d (urlMailbox)
475   [5] = Entity ID inside mail message (ent)
476   [6] = Default URL to go to when filename is clicked on (alterable)
477   [7] = Filename that is displayed for the attachment
478   [8] = Sent if message was found from a search (where)
479   [9] = Sent if message was found from a search (what)
480
481 To set up links for actions, you assign them like this:
482
483   $Args[1]['<plugin_name>']['href'] = 'URL to link to';
484   $Args[1]['<plugin_name>']['text'] = _("What to display");
485   $Args[1]['<plugin_name>']['extra'] = 'extra stuff, such as an <img ...> tag';
486
487 Note: _("What to display") is explained in the section about
488 internationalization.
489
490 You can leave the 'text' empty and put an image tag in 'extra' to show an
491 image-only link for the attachment, or do the opposite (leave 'extra' empty)
492 to display a text-only link.
493
494 It's also possible to specify a hook as "attachment type0/*",
495 for example "attachment text/*". This hook will be executed whenever there's
496 no more specific rule available for that type.
497
498 Putting all this together, the demo_handle_zip_attachment() function should
499 look like this (note the argument being passed):
500
501    function demo_handle_zip_attachment(&$Args)
502    {
503       include_once(SM_PATH . 'plugins/demo/functions.php');
504       demo_handle_zip_attachment_do($Args);
505    }
506
507 And the demo_handle_zip_attachment_do() function in the
508 plugins/demo/functions.php file would typically (but not necessarily)
509 display a custom link:
510
511    function demo_handle_zip_attachment_do(&$Args)
512    {
513       $Args[1]['demo']['href'] = SM_PATH . 'plugins/demo/zip_handler.php?'
514          . 'passed_id=' . $Args[3] . '&mailbox=' . $Args[4]
515          . '&passed_ent_id=' . $Args[5];
516       $Args[1]['demo']['text'] = _("Show zip contents");
517    }
518
519 The file plugins/demo/zip_handler.php can now do whatever it needs with the
520 attachment (note that this will hand information about how to retrieve the
521 source message from the IMAP server as GET varibles).
522
523
524 (*) Options
525 -----------
526 Before you start adding user preferences to your plugin, please take a moment
527 to think about it:  in some cases, more options may not be a good thing.
528 Having too many options can be confusing.  Thinking from the user's
529 perspective, will the proposed options actually be used?  Will users
530 understand what these options are for?
531
532 There are two ways to add options for your plugin.  When you only have a few
533 options that don't merit an entirely new preferences page, you can incorporate
534 them into an existing section of SquirrelMail preferences (Personal
535 Information, Display Preferences, Message Highlighting, Folder Preferences or
536 Index Order).  Or, if you have an extensive number of settings or for some
537 reason need a separate page for the user to interact with, you can create your
538 own preferences page.
539
540
541 Integrating Your Options Into Existing SquirrelMail Preferences Pages
542 ---------------------------------------------------------------------
543
544 There are two ways to accomplish the integration of your plugin's settings
545 into another preferences page.  The first method is to add the HTML code
546 for your options directly to the preferences page of your choice.  Although
547 currently very popular, this method will soon be deprecated, so avoid it
548 if you can.  That said, here is how it works.  :)  Look for any of the hooks
549 named as "options_<pref page>_inside", where <pref page> is "display",
550 "personal", etc.  For this example, we'll use "options_display_inside" and,
551 as above, "demo" as our plugin name:
552
553   1.  In setup.php in the squirrelmail_plugin_init_demo() function:
554
555          $squirrelmail_plugin_hooks['options_display_inside']['demo']
556             = 'demo_show_options';
557
558       Note that there are also hooks such as "options_display_bottom",
559       however, they place your options at the bottom of the preferences
560       page, which is usually not desirable (mostly because they also
561       come AFTER the HTML FORM tag is already closed).  It is possible
562       to use these hooks if you want to create your own FORM with custom
563       submission logic.
564
565   2.  Assuming the function demo_show_options() calls another function
566       elsewhere called demo_show_options_do(), that function should have
567       output similar to this (note that you will be inserting code into
568       a table that is already defined with two columns, so please be sure
569       to keep this framework in your plugin):
570
571          ------cut here-------
572          <tr>
573             <td>
574                OPTION_NAME
575             </td>
576             <td>
577                OPTION_INPUT
578             </td>
579          </tr>
580          ------cut here-------
581
582       Of course, you can place any text where OPTION_NAME is and any input
583       tags where OPTION_INPUT is.
584
585   3.  You will want to use the "options_<pref page>_save" hook (in this case,
586       "options_display_save") to save the user's settings after they have
587       pressed the "Submit" button.  Again, back in setup.php in the
588       squirrelmail_plugin_init_demo() function:
589
590          $squirrelmail_plugin_hooks['options_display_save']['demo']
591             = 'demo_save_options';
592
593   4.  Assuming the function demo_save_options() calls another function
594       elsewhere called demo_save_options_do(), that function should put
595       the user's settings into permanent storage (see the preferences
596       section below for more information).  This example assumes that
597       in the preferences page, the INPUT tag's NAME attribute was set
598       to "demo_option":
599
600          global $data_dir, $username;
601          sqgetGlobalVar('demo_option', $demo_option);
602          setPref($data_dir, $username, 'demo_option', $demo_option);
603
604
605 The second way to add options to one of the SquirrelMail preferences page is
606 to use one of the "optpage_loadhook_<pref page>" hooks.  The sent_subfolders
607 plugin has an excellent example of this method.  Briefly, this way of adding
608 options consists of adding some plugin-specific information to a predefined
609 data structure which SquirrelMail then uses to build the HTML input forms
610 for you.  This is the preferred method of building options lists going forward.
611
612   1.  We'll use the "optpage_loadhook_display" hook to add a new group of
613       options to the display preferences page.  In setup.php in the
614       squirrelmail_plugin_init_demo() function:
615
616          $squirrelmail_plugin_hooks['optpage_loadhook_display']['demo']
617             = 'demo_options';
618
619   2.  Assuming the function demo_options() calls another function elsewhere
620       called demo_options_do(), that function needs to add a new key to two
621       arrays, $optpage_data['grps'] and $optpage_data['vals'].  The value
622       associated with that key should simply be a section heading for your
623       plugin on the preferences page for the $optpage_data['grps'] array,
624       and yet another array with all of your plugin's options for the
625       $optpage_data['vals'] array.  The options are built as arrays (yes,
626       that's four levels of nested arrays) that specify attributes that are
627       used by SquirrelMail to build your HTML input tags automatically.
628       This example includes just one input element, a SELECT (drop-down)
629       list:
630
631          global $optpage_data;
632          $optpage_data['grps']['DEMO_PLUGIN'] = 'Demo Options';
633          $optionValues = array();
634          $optionValues[] = array(
635             'name'    => 'plugin_demo_favorite_color',
636             'caption' => 'Please Choose Your Favorite Color',
637             'type'    => SMOPT_TYPE_STRLIST,
638             'refresh' => SMOPT_REFRESH_ALL,
639             'posvals' => array(0 => 'red',
640                                1 => 'blue',
641                                2 => 'green',
642                                3 => 'orange'),
643             'save'    => 'save_plugin_demo_favorite_color'
644          );
645          $optpage_data['vals']['DEMO_PLUGIN'] = $optionValues;
646
647       The array that you use to specify each plugin option has the following
648       possible attributes:
649
650          name           The name of this setting, which is used not only for
651                         the INPUT tag name, but also for the name of this
652                         setting in the user's preferences
653          caption        The text that prefaces this setting on the preferences
654                         page
655          trailing_text  Text that follows a text input or select list input on
656                         the preferences page (useful for indicating units,
657                         meanings of special values, etc.)
658          type           The type of INPUT element, which should be one of:
659                            SMOPT_TYPE_STRING     String/text input
660                            SMOPT_TYPE_STRLIST    Select list input
661                            SMOPT_TYPE_TEXTAREA   Text area input
662                            SMOPT_TYPE_INTEGER    Integer input
663                            SMOPT_TYPE_FLOAT      Floating point number input
664                            SMOPT_TYPE_BOOLEAN    Boolean (yes/no radio buttons)
665                                                  input
666                            SMOPT_TYPE_HIDDEN     Hidden input (not actually
667                                                  shown on preferences page)
668                            SMOPT_TYPE_COMMENT    Text is shown (specified by the
669                                                  'comment' attribute), but no
670                                                  user input is needed
671                            SMOPT_TYPE_FLDRLIST   Select list of IMAP folders
672          refresh        Indicates if a link should be shown to refresh part or
673                         all of the window (optional).  Possible values are:
674                            SMOPT_REFRESH_NONE         No refresh link is shown
675                            SMOPT_REFRESH_FOLDERLIST   Link is shown to refresh
676                                                       only the folder list
677                            SMOPT_REFRESH_ALL          Link is shown to refresh
678                                                     the entire window
679          initial_value  The value that should initially be placed in this
680                         INPUT element
681          posvals        For select lists, this should be an associative array,
682                         where each key is an actual input value and the
683                         corresponding value is what is displayed to the user
684                         for that list item in the drop-down list
685          value          Specify the default/preselected value for this option
686                         input
687          save           You may indicate that special functionality needs to be
688                         used instead of just saving this setting by giving the
689                         name of a function to call when this value would
690                         otherwise just be saved in the user's preferences
691          size           Specifies the size of certain input items (typically
692                         textual inputs).  Possible values are:
693                            SMOPT_SIZE_TINY
694                            SMOPT_SIZE_SMALL
695                            SMOPT_SIZE_MEDIUM
696                            SMOPT_SIZE_LARGE
697                            SMOPT_SIZE_HUGE
698                            SMOPT_SIZE_NORMAL
699          comment        For SMOPT_TYPE_COMMENT type options, this is the text
700                         displayed to the user
701          script         This is where you may add any additional javascript
702                         or other code to the user input
703          post_script    You may specify some script (usually Javascript) that
704                         will be placed after (outside of) the INPUT tag.
705          htmlencoded    disables html sanitizing. WARNING - don't use it, if user
706                         input is possible in option or use own sanitizing functions.
707                         Currently works only with SMOPT_TYPE_STRLIST.
708
709       Note that you do not have to create a whole new section on the options
710       page if you merely want to add a simple input item or two to an options
711       section that already exists.  For example, the Display Options page has
712       these groups:
713
714          0  -  General Display Options
715          1  -  Mailbox Display Options
716          2  -  Message Display and Composition
717
718       To add our previous input drop-down to the Mailbox Display Options,
719       we would not have to create our own group; just add it to group
720       number one:
721
722          global $optpage_data;
723          $optpage_data['vals'][1][] = array(
724             'name'    => 'plugin_demo_favorite_color',
725             'caption' => 'Please Choose Your Favorite Color',
726             'type'    => SMOPT_TYPE_STRLIST,
727             'refresh' => SMOPT_REFRESH_ALL,
728             'posvals' => array(0 => 'red',
729                                1 => 'blue',
730                                2 => 'green',
731                                3 => 'orange'),
732             'save'    => 'save_plugin_demo_favorite_color'
733          );
734
735   3.  If you indicated a 'save' attribute for any of your options, you must
736       create that function (you'll only need to do this if you need to do
737       some special processing for one of your settings).  The function gets
738       one parameter, which is an object with mostly the same attributes you
739       defined when you made the option above... the 'new_value' (and possibly
740       'value', which is the current value for this setting) is the most useful
741       attribute in this context:
742
743          function save_plugin_demo_favorite_color($option)
744          {
745             // if user chose orange, make note that they are really dumb
746             if ($option->new_value == 3)
747             {
748                // more code here as needed
749             }
750
751             // don't even save this setting if user chose green (old
752             // setting will remain)
753             if ($option->new_value == 2)
754                return;
755
756             // for all other colors, save as normal
757             save_option($option);
758          }
759
760
761 Creating Your Own Preferences Page
762 ----------------------------------
763
764 It is also possible to create your own preferences page for a plugin.  This
765 is particularly useful when your plugin has numerous options or needs to
766 offer special interaction with the user (for things such as changing password,
767 etc.).  Here is an outline of how to do so (again, using the "demo" plugin
768 name):
769
770   1.  Add a new listing to the main Options page.  Older versions of
771       SquirrelMail offered a hook called "options_link_and_description"
772       although its use is deprecated (and it is harder to use in that
773       it requires you to write your own HTML to add the option).  Instead,
774       you should always use the "optpage_register_block" hook where you
775       create a simple array that lets SquirrelMail build the HTML
776       to add the plugin options entry automatically.  In setup.php in the
777       squirrelmail_plugin_init_demo() function:
778
779          $squirrelmail_plugin_hooks['optpage_register_block']['demo']
780             = 'demo_options_block';
781
782   2.  Assuming the function demo_options_block() calls another function
783       elsewhere called demo_options_block_do(), that function only needs
784       to create a simple array and add it to the $optpage_blocks array:
785
786          global $optpage_blocks;
787          $optpage_blocks[] = array(
788              'name' => 'Favorite Color Settings',
789              'url'  => SM_PATH . 'plugins/demo/options.php',
790              'desc' => 'Change your favorite color & find new exciting colors',
791              'js'   => FALSE
792          );
793
794       The array should have four elements:
795          name   The title of the plugin's options as it will be displayed on
796                 the Options page
797          url    The URI that points to your plugin's custom preferences page
798          desc   A description of what the preferences page offers the user,
799                 displayed on the Options page below the title
800          js     Indicates if this option page requires the client browser
801                 to be Javascript-capable.  Should be TRUE or FALSE.
802
803   3.  There are two different ways to create the actual preferences page
804       itself.  One is to simply write all of your own HTML and other
805       interactive functionality, while the other is to define some data
806       structures that allow SquirrelMail to build your user inputs and save
807       your data automatically.
808
809       Building your own page is wide open, and for ideas, you should look at
810       any of the plugins that currently have their own preferences pages.  If
811       you do this, make sure to read step number 4 below for information on
812       saving settings.  In order to maintain security, consistant look and
813       feel, internationalization support and overall integrity, there are just
814       a few things you should always do in this case:  define the SM_PATH
815       constant, include the file include/validate.php (see the section about
816       including other files above) and make a call to place the standard page
817       heading at the top of your preferences page.  The top of your PHP file
818       might look something like this:
819
820          define('SM_PATH', '../../');
821          include_once(SM_PATH . 'include/validate.php');
822          global $color;
823          displayPageHeader($color, 'None');
824
825       From here you are on your own, although you are encouraged to do things
826       such as use the $color array to keep your HTML correctly themed, etc.
827
828       If you want SquirrelMail to build your preferences page for you,
829       creating input forms and automatically saving users' settings, then
830       you should change the 'url' attribute in the options block you created
831       in step number 2 above to read as follows:
832
833          'url' => SM_PATH . 'src/options.php?optpage=plugin_demo',
834
835       Now, you will need to use the "optpage_set_loadinfo" hook to tell
836       SquirrelMail about your new preferences page.  In setup.php in the
837       squirrelmail_plugin_init_demo() function:
838
839          $squirrelmail_plugin_hooks['optpage_set_loadinfo']['demo']
840             = 'demo_optpage_loadinfo';
841
842       Assuming the function demo_optpage_loadinfo() calls another function
843       elsewhere called demo_optpage_loadinfo_do(), that function needs to
844       define values for four variables (make sure you test to see that it
845       is your plugin that is being called by checking the GET variable you
846       added to the url just above):
847
848          global $optpage, $optpage_name, $optpage_file,
849                 $optpage_loader, $optpage_loadhook;
850          if ($optpage == 'plugin_demo')
851          {
852             $optpage_name = "Favorite Color Preferences";
853             $optpage_file = SM_PATH . 'plugins/demo/options.php';
854             $optpage_loader = 'load_optpage_data_demo';
855             $optpage_loadhook = 'optpage_loadhook_demo';
856          }
857
858       Now you are ready to build all of your options.  In the file you
859       indicated for the variable $optpage_file above, you'll need to create
860       a function named the same as the value you used for $optpage_loader
861       above.  In this example, the file plugins/demo/options.php should
862       have at least this function in it:
863
864          function load_optpage_data_demo()
865          {
866             $optpage_data = array();
867             $optpage_data['grps']['DEMO_PLUGIN'] = 'Demo Options';
868             $optionValues = array();
869             $optionValues[] = array(
870                'name'    => 'plugin_demo_favorite_color',
871                'caption' => 'Please Choose Your Favorite Color',
872                'type'    => SMOPT_TYPE_STRLIST,
873                'refresh' => SMOPT_REFRESH_ALL,
874                'posvals' => array(0 => 'red',
875                                   1 => 'blue',
876                                   2 => 'green',
877                                   3 => 'orange'),
878                'save'    => 'save_plugin_demo_favorite_color'
879             );
880             $optpage_data['vals']['DEMO_PLUGIN'] = $optionValues;
881             return $optpage_data;
882          }
883
884       For a detailed description of how you build these options, please read
885       step number 2 for the second method of adding options to an existing
886       preferences page above.  Notice that the only difference here is in the
887       very first and last lines of this function where you are actually
888       creating and returning the options array instead of just adding onto it.
889
890       That's all there is to it - SquirrelMail will create a preferences page
891       titled as you indicated for $optpage_name above, and other plugins
892       can even add extra options to this new preferences page.  To do so,
893       they should use the hook name you specified for $optpage_loadhook above
894       and use the second method for adding option settings to existing
895       preferences pages described above.
896
897   4.  Saving your options settings: if you used the second method in step
898       number 3 above, your settings will be saved automatically (or you can
899       define special functions to save special settings such as the
900       save_plugin_demo_favorite_color() function in the example described
901       above) and there is probably no need to follow this step.  If you
902       created your own preferences page from scratch, you'll need to follow
903       this step.  First, you need to register your plugin against the
904       "options_save" hook.  In setup.php in the squirrelmail_plugin_init_demo()
905       function:
906
907          $squirrelmail_plugin_hooks['options_save']['demo']
908             = 'demo_save_options';
909
910       Assuming the function demo_save_options() calls another function
911       elsewhere called demo_save_options_do(), that function needs to grab
912       all of your POST and/or GET settings values and save them in the user's
913       preferences (for more about preferences, see that section below).  Since
914       this is a generic hook called for all custom preferences pages, you
915       should always set "optpage" as a POST or GET variable with a string that
916       uniquely identifies your plugin:
917
918          <input type="hidden" name="optpage" value="plugin_demo" />
919
920       Now in your demo_save_options_do() function, do something like this:
921
922          global $username, $data_dir, $optpage, $favorite_color;
923          if ($optpage == 'plugin_demo')
924          {
925             sqgetGlobalVar('favorite_color', $favorite_color, SQ_FORM);
926             setPref($data_dir, $username, 'favorite_color', $favorite_color);
927          }
928
929       Note that $favorite_color may not need to be globalized, although
930       experience has shown that some versions of PHP don't behave as expected
931       unless you do so.  Even when you use SquirrelMail's built-in preferences
932       page generation functionality, you may still use this hook, although
933       there should be no need to do so.  If you need to do some complex
934       validation routines, note that it might be better to do so in the file
935       you specified as the "$optpage_file" (in our example, that was the
936       plugins/demo/options.php file), since at this point, you can still
937       redisplay your preferences page.  You could put code similar to this
938       in the plugins/demp/options.php file (note that there is no function;
939       this code needs to be executed at include time):
940
941          global $optmode;
942          if ($optmode == 'submit')
943          {
944             // do something here such as validation, etc
945             if (you want to redisplay your preferences page)
946                $optmode = '';
947          }
948
949
950 Preferences
951 -----------
952
953 Saving and retrieving user preferences is very easy in SquirrelMail.
954 SquirrelMail supports preference storage in files or in a database
955 backend, however, the code you need to write to manipulate preferences
956 is the same in both cases.
957
958 Setting preferences:
959
960    Setting preferences is done for you if you use the built-in facilities
961    for automatic options construction and presentation (see above).  If
962    you need to manually set preferences, however, all you need to do is:
963
964       global $data_dir, $username;
965       setPref($data_dir, $username, 'pref_name', $pref_value);
966
967    Where "pref_name" is the key under which the value will be stored
968    and "pref_value" is a variable that should contain the actual
969    preference value to be stored.
970
971 Loading preferences:
972
973    There are two approaches to retrieving plugin (or any other) preferences.
974    You can grab individual preferences one at a time or you can add your
975    plugin's preferences to the routine that loads up user preferences at
976    the beginning of each page request.  If you do the latter, making sure
977    to place your preference variables into the global scope, they will be
978    immediately available in all other plugin code.  To retrieve a single
979    preference value at any time, do this:
980
981       global $data_dir, $username;
982       $pref_value = getPref($data_dir, $username, 'pref_name', 'default value');
983
984    Where "pref_name" is the preference you are retrieving, "default_value"
985    is what will be returned if the preference is not found for this user,
986    and, of course, "pref_value" is the variable that will get the actual
987    preference value.
988
989    To have all your preferences loaded at once when each page request is
990    made, you'll need to register a function against the "loading_prefs" hook.
991    For our "demo" plugin, in setup.php in the squirrelmail_plugin_init_demo()
992    function:
993
994       $squirrelmail_plugin_hooks['loading_prefs']['demo']
995          = 'demo_load_prefs';
996
997    Assuming the function demo_load_prefs() calls another function
998    elsewhere called demo_load_prefs_do(), that function just needs to
999    pull out any all all preferences you'll be needing elsewhere:
1000
1001       global $data_dir, $username, $pref_value;
1002       $pref_value = getPref($data_dir, $username, 'pref_name', 'default value');
1003
1004    Remember to globalize each preference, or this code is useless.
1005
1006
1007 Internationalization
1008 --------------------
1009
1010 Although this document may only be available in English, we sure hope that you
1011 are thinking about making your plugin useful to the thousands of non-English
1012 speaking SquirrelMail users out there!  It is almost rude not to do so, and
1013 it isn't much trouble, either.  This document will only describe how you can
1014 accomplish the internationalization of a plugin.  For more general information
1015 about PHP and SquirrelMail translation facilities, see:
1016
1017 http://www.squirrelmail.org/wiki/wiki.php?LanguageTranslation
1018
1019 The unofficial way to internationalize a plugin is to put all plugin output
1020 into the proper format but to rely on the SquirrelMail translation facilities
1021 for all the rest.  If the plugin were really to get translated, you'd need
1022 to make sure that all output strings for your plugin are either added to or
1023 already exist in the main SquirrelMail locale files.
1024
1025 The better way to make sure your plugin is translated is to create your own
1026 locale files and what is called a "gettext domain" (see the link above for
1027 more information).
1028
1029 There are three basic steps to getting your plugins internationalized:  put
1030 all output into the proper format, switch gettext domains and create locale
1031 files.
1032
1033   1.  Putting plugin output into the correct format is quite easy.  The hard
1034       part is making sure you catch every last echo statement.  You need to
1035       echo text like this:
1036
1037          echo _("Hello");
1038
1039       So, even in the HTML segments of your plugin files, you need to do this:
1040
1041          <input type="submit" value="<?php echo _("Submit"); ?>" />
1042
1043       You can put any text you want inside of the quotes (you MUST use double
1044       quotes!), including HTML tags, etc.  What you should think carefully
1045       about is that some languages may use different word ordering, so this
1046       might be problematic:
1047
1048          echo _("I want to eat a ") . $fruitName . _(" before noon");
1049
1050       Because some languages (Japanese, for instance) would need to translate
1051       such a sentence to "Before noon " . $fruitName . " I want to eat", but
1052       with the format above, they are stuck having to translate each piece
1053       separately.  You might want to reword your original sentence:
1054
1055          echo _("This is what I want to eat before noon: ") . $fruitName;
1056
1057       Note:
1058       Support for single quotes in gettext was added somewhere along gettext
1059       0.11.x (release dates 2002-01-31--08-06). This means that strings could
1060       be written as:
1061
1062       echo _('Hello');
1063
1064       However, gettext 0.10.40 is currently the oldest version available at the
1065       GNU site. It's still used in some Linux and BSD distributions/versions.
1066       Since it's still in common use and it doesn't support single quoted
1067       strings, double quoted strings are the preferred way when writing a
1068       plugin.
1069
1070   2.  By default, the SquirrelMail gettext domain is always in use.  That
1071       means that any text in the format described above will be translated
1072       using the locale files found in the main SquirrelMail locale directory.
1073       Unless your plugin produces no output or only output that is in fact
1074       translated under the default SquirrelMail domain, you need to create
1075       your own gettext domain.  The PHP for doing so is very simple.  At
1076       the top of any file that produces any output, place the following code
1077       (again, using "demo" as the plugin name):
1078
1079          bindtextdomain('demo', SM_PATH . 'plugins/demo/locale');
1080          textdomain('demo');
1081
1082       Now all output will be translated using your own custom locale files.
1083       Please be sure to switch back to the SquirrelMail domain at the end
1084       of the file, or many of the other SquirrelMail files may misbehave:
1085
1086          bindtextdomain('squirrelmail', SM_PATH . 'locale');
1087          textdomain('squirrelmail');
1088
1089       Note that if, in the middle of your plugin file, you use any
1090       SquirrelMail functions that send output to the browser, you'll need
1091       to temporarily switch back to the SquirrelMail domain:
1092
1093          bindtextdomain('squirrelmail', SM_PATH . 'locale');
1094          textdomain('squirrelmail');
1095          displayPageHeader($color, 'None');
1096          bindtextdomain('demo', SM_PATH . 'plugins/demo/locale');
1097          textdomain('demo');
1098
1099       Note that technically speaking, you only need to have one bindtextdomain
1100       call per file, you should always use it before every textdomain call,
1101       since PHP installations without gettext compiled into them will not
1102       function properly if you do not.
1103
1104   3.  Finally, you just need to create your own locale.  You should create
1105       a directory structure like this in the plugin directory:
1106
1107          demo
1108            |
1109            ------locale
1110                     |
1111                     ------de_DE
1112                     |       |
1113                     |       ------LC_MESSAGES
1114                     |
1115                     ------ja_JP
1116                             |
1117                             ------LC_MESSAGES
1118
1119       Create a directories such as de_DE for each language (de_DE is German,
1120       ja_JP is Japanese, etc. - check the SquirrelMail locale directory for
1121       a fairly comprehensive listing).  Inside of each LC_MESSAGES directory
1122       you should place two files, one with your translations in it, called
1123       <plugin name>.po (in this case, "demo.po"), and one that is a compiled
1124       version of the ".po" file, called <plugin name>.mo (in this case,
1125       "demo.mo").  On most linux systems, there is a tool you can use to pull
1126       out most of the strings that you need to have translated from your PHP
1127       files into a sample .po file:
1128
1129          xgettext --keyword=_ -d <plugin name> -s -C *.php
1130
1131          --keyword option tells xgettext what your strings are enclosed in
1132          -d is the domain of your plugin which should be the plugin's name
1133          -s tells xgettext to sort the results and remove duplicate strings
1134          -C means you are translating a file with C/C++ type syntax (ie. PHP)
1135          *.php is all the files you want translations for
1136
1137       Note, however, that this will not always pick up all strings, so you
1138       should double-check manually.  Of course, it's easiest if you just keep
1139       track of all your strings as you are coding your plugin.  Your .po file
1140       will now look something like:
1141
1142          # SOME DESCRIPTIVE TITLE.
1143          # Copyright (C) YEAR Free Software Foundation, Inc.
1144          # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
1145          #
1146          #, fuzzy
1147          msgid ""
1148          msgstr ""
1149          "Project-Id-Version: PACKAGE VERSION\n"
1150          "POT-Creation-Date: 2003-06-18 11:22-0600\n"
1151          "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1152          "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1153          "Language-Team: LANGUAGE <LL@li.org>\n"
1154          "MIME-Version: 1.0\n"
1155          "Content-Type: text/plain; charset=CHARSET\n"
1156          "Content-Transfer-Encoding: ENCODING\n"
1157
1158          #: functions.php:45
1159          msgid "Hello"
1160          msgstr ""
1161
1162          #: functions.php:87
1163          msgid "Favorite Color"
1164          msgstr ""
1165
1166       You should change the header to look something more like:
1167
1168          # Copyright (c) 1999-2005 The SquirrelMail Project Team
1169          # Roland Bauerschmidt <rb@debian.org>, 1999.
1170          # $Id$
1171          msgid ""
1172          msgstr ""
1173          "Project-Id-Version: plugin-name version\n"
1174          "POT-Creation-Date: 2003-01-21 19:21+0100\n"
1175          "PO-Revision-Date: 2003-01-21 21:01+0100\n"
1176          "Last-Translator: Juergen Edner <juergen.edner@epost.de>\n"
1177          "Language-Team: German <squirrelmail-i18n@lists.sourceforge.net>\n"
1178          "MIME-Version: 1.0\n"
1179          "Content-Type: text/plain; charset=ISO-8859-1\n"
1180          "Content-Transfer-Encoding: 8bit\n"
1181
1182       The most important thing to change here is the charset on the next to
1183       last line.  You'll want to keep a master copy of the .po file and make
1184       a copy for each language you have a translation for.  You'll need to
1185       translate each string in the .po file:
1186
1187          msgid "Hello"
1188          msgstr "Guten Tag"
1189
1190       After you're done translating, you can create the .mo file very simply
1191       by running the following command (available on most linux systems):
1192
1193          msgfmt -o <plugin name>.mo <plugin name>.po
1194
1195       In the case of the "demo" plugin:
1196
1197          msgfmt -o demo.mo demo.po
1198
1199       Please be sure that the .po and .mo files both are named exactly the
1200       same as the domain you bound in step 2 above and everything else works
1201       automatically.  In SquirrelMail, go to Options -> Display Preferences
1202       and change your Language setting to see the translations in action!
1203
1204
1205
1206 Documenting the Code (Optional)
1207 -------------------------------
1208
1209 If you wish, you can use phpdoc (Javadoc-style) comments, when documenting your
1210 code.
1211
1212 If you follow the standards that are followed between SquirrelMail core &
1213 plugin developers, the resulted documentation can be included with the rest of
1214 the SquirrelMail code & API documentation. Specifically, in the page-level
1215 docblock, declare the package to be 'plugins', and the subpackage to be the
1216 name of your plugin. For instance:
1217
1218 /**
1219  * demo.php
1220  *
1221  * Copyright (c) 2005 My Name <my-email-address>
1222  * Licensed under the GNU GPL. For full terms see the file COPYING.
1223  *
1224  * @package plugins
1225  * @subpackage demo
1226  */
1227
1228 The rest is up to you. Try to follow some common sense and document what is
1229 really needed. Documenting the code properly can be a big help not only to
1230 yourself, but to those who will take a look at your code, fix the bugs and even
1231 improve it, in the true open-source spirit that SquirrelMail was built upon.
1232
1233 For more information about phpdocumentor and how to write proper-tagged
1234 comments, you are directed at:
1235
1236 http://phpdocu.sourceforge.net/
1237
1238
1239
1240 PLUGIN STANDARDS AND REQUIREMENTS
1241 =================================
1242
1243 The SquirrelMail project has some important goals, such as avoiding the
1244 use of JavaScript, avoiding non-standard HTML tags, keeping file sizes
1245 small and providing the fastest webmail client on the Internet.  As such,
1246 we'd like it if plugin authors coded with the same goals in mind that the
1247 core developers do.  Common sense is always a good tool to have in your
1248 programming repertoire, but below is an outline of some standards that we
1249 ask you as a plugin developer to meet.  Depending upon how far you bend
1250 these rules, we may not want to post your plugin on the SquirrelMail
1251 website... and of course, no one really wants your efforts to go to waste
1252 and for the SquirrelMail community to miss out on a potentially useful
1253 plugin, so please try to follow these guidelines as closely as possible.
1254
1255
1256 Small setup.php
1257 ---------------
1258
1259 In order for SquirrelMail to remain fast and lean, we are now asking
1260 that all plugin authors remove all unnecessary functionality from setup.php
1261 and refactor it into another file.  There are a few ways to accomplish
1262 this, none of which are difficult.  At a minimum, you'll want to have the
1263 squirrelmail_plugin_init_<plugin name>() function in setup.php, and naturally,
1264 you'll need functions that are merely stubs for each hook that you are using.
1265 One (but not the only) way to do it is:
1266
1267    function squirrelmail_plugin_init_demo()
1268    {
1269       global $squirrelmail_plugin_hooks;
1270       $squirrelmail_plugin_hooks['generic_header']['demo'] = 'plugin_demo_header';
1271    }
1272    function plugin_demo_header()
1273    {
1274       include_once(SM_PATH . 'plugins/demo/functions.php');
1275       plugin_demo_header_do();
1276    }
1277
1278
1279 Internationalization
1280 --------------------
1281
1282 Q: What is more disappointing to users in France who would make good
1283    use of your plugin than learning that it is written entirely in English?
1284 A: Learning that they cannot send you a French translation file for your
1285    plugin.
1286
1287 There are thousands of users out there whose native tongue is not English,
1288 and when you develop your plugin without going through the three simple steps
1289 needed to internationalize it, you are effectively writing them all off.
1290 PLEASE consider internationalizing your plugin!
1291
1292
1293 Developing with E_ALL
1294 ---------------------
1295
1296 When you are developing your plugin, you should always have error reporting
1297 turned all the way up.  You can do this by changing two settings in your
1298 php.ini and restarting your web server:
1299
1300    display_errors = On
1301    error_reporting  =  E_ALL
1302
1303 This way, you'll be sure to see all Notices, Warnings and Errors that your
1304 code generates (it's OK, really, it happens to the best of us... except me!).
1305 Please make sure to fix them all before you release the plugin.
1306
1307
1308 Compatibility with register_globals=Off
1309 ---------------------------------------
1310
1311 Most sensible systems administrators now run their PHP systems with the
1312 setting "register_globals" as OFF.  This is a prudent security setting,
1313 and as the SquirrelMail core code has long since been upgraded to work
1314 in such an environment, we are now requiring that all plugins do the same.
1315 Compatibility with this setting amounts to little more than explicitly
1316 gathering any and all variables you sent from a <form> tag as GET or POST
1317 values instead of just assuming that they will be placed in the global
1318 scope automatically.  There is nothing more to do than this:
1319
1320    global $favorite_color;
1321    sqgetGlobalVar('favorite_color', $favorite_color, SQ_FORM);
1322
1323
1324 Security considerations
1325 -----------------------
1326
1327 All plugin authors should consider the security implications of their
1328 plugin. Of course, if you call external programs you have to use great
1329 care, but the following issues are important to nearly every plugin.
1330
1331 - Escape any untrusted data before you output it. This is to prevent
1332 cross site scripting attacks. It means that you have to htmlspecialchars()
1333 every variable that comes in through the URL, a mail message or other
1334 external factors, before outputting it.
1335
1336 - Make sure that your plugin doesn't perform its function when it's not
1337 enabled. If you just call hooks, your hooks won't be called when the
1338 plugin is disabled, but if you also supply extra .php files, you should
1339 check if they perform any function if accessed directly. If they do, you
1340 should check at the start of that file whether the plugin is enabled in the
1341 config, and if not, exit the script. Example:
1342   global $plugins;
1343   if ( !in_array('mypluginname', $plugins) ) {
1344       die("Plugin not enabled in SquirrelMail configuration.");
1345   }
1346
1347 If you have any questions about this or are unsure, please contact the
1348 mailinglist or IRC channel, because security is very important for a
1349 widely used application like SquirrelMail!
1350
1351
1352 Extra Blank Lines
1353 -----------------
1354
1355 It may seem innocuous, but if you have any blank lines either before the
1356 first <?php tag or after the last ?> tag in any of your plugin files, you
1357 you will break SquirrelMail in ways that may seem entirely unrelated.  For
1358 instance, this will often cause a line feed character to be included with
1359 email attachments when they are viewed or downloaded, rendering them useless!
1360
1361
1362 include_once
1363 ------------
1364
1365 When including files, please make sure to use the include_once() function
1366 and NOT include(), require(), or require_once(), since these all are much
1367 less efficient than include_once() and can have a cumulative effect on
1368 SquirrelMail performance.
1369
1370
1371 Version Reporting
1372 -----------------
1373
1374 In order for systems administrators to keep better track of your plugin and
1375 get upgrades more efficiently, you are requested to make version information
1376 available to SquirrelMail in a format that it understands.  There are two
1377 ways to do this.  Presently, we are asking that you do both, since we are
1378 still in a transition period between the two.  This is painless, so please
1379 be sure to include it:
1380
1381   1.  Create a file called "version" in the plugin directory.  That file
1382       should have only two lines: the first line should have the name of
1383       the plugin as named on the SquirrelMail web site (this is often a
1384       prettified version of the plugin directory name), the second line
1385       must have the version and nothing more.  So for our "demo" plugin,
1386       whose name on the web site might be something like "Demo Favorite
1387       Colors", the file plugins/demo/version should have these two lines:
1388
1389          Demo Favorite Colors
1390          1.0
1391
1392   2.  In setup.php, you should have a function called <plugin name>_version().
1393       That function should return the version of your plugin.  For the "demo"
1394       plugin, that should look like this:
1395
1396          function demo_version()
1397          {
1398             return '1.0';
1399          }
1400
1401
1402 Configuration Files
1403 -------------------
1404
1405 It is common to need a configuration file that holds some variables that
1406 are set up at install time.  For ease of installation and maintenance, you
1407 should place all behavioral settings in a config file, isolated from the
1408 rest of your plugin code.  A typical file name to use is "config.php".  If
1409 you are using such a file, you should NOT include a file called "config.php"
1410 in your plugin distribution, but instead a copy of that file called
1411 "config.php.sample".  This helps systems administrators avoid overwriting
1412 the "config.php" files and losing all of their setup information when they
1413 upgrade your plugin.
1414
1415
1416 Session Variables
1417 -----------------
1418
1419 In the past, there have been some rather serious issues with PHP sessions
1420 and SquirrelMail, and certain people have worked long and hard to ensure
1421 that these problems no longer occur in an extremely wide variety of OS/PHP/
1422 web server environments.  Thus, if you need to place any values into the
1423 user's session, there are some built-in SquirrelMail functions that you are
1424 strongly encouraged to make use of.  Using them also makes your job easier.
1425
1426   1.  To place a variable into the session:
1427
1428          global $favorite_color;
1429          $favoriteColor = 'green';
1430          sqsession_register($favorite_color, 'favorite_color');
1431
1432       Strictly speaking, globalizing the variable shouldn't be necessary,
1433       but certain versions of PHP seem to behave more predictably if you do.
1434
1435   2.  To retrieve a variable from the session:
1436
1437          global $favorite_color;
1438          sqgetGlobalVar('favorite_color', $favorite_color, SQ_SESSION);
1439
1440   3.  You can also check for the presence of a variable in the session:
1441
1442          if (sqsession_is_registered('favorite_color'))
1443             // do something important
1444
1445   4.  To remove a variable from the session:
1446
1447          global $favorite_color;
1448          sqsession_unregister('favorite_color');
1449
1450       Strictly speaking, globalizing the variable shouldn't be necessary,
1451       but certain versions of PHP seem to behave more predictably if you do.
1452
1453
1454 Form Variables
1455 --------------
1456
1457 You are also encouraged to use SquirrelMail's built-in facilities to
1458 retrieve variables from POST and GET submissions.  This is also much
1459 easier on you and makes sure that all PHP installations are accounted
1460 for (such as those that don't make the $_POST array automatically
1461 global, etc.):
1462
1463    global $favorite_color;
1464    sqgetGlobalVar('favorite_color', $favorite_color, SQ_FORM);
1465
1466
1467 Files In Plugin Directory
1468 -------------------------
1469
1470 There are a few files that you should make sure to include when you build
1471 your final plugin distribution:
1472
1473   1.  A copy of the file index.php from the main plugins directory.  When
1474       working in your plugin directory, just copy it in like this:
1475
1476          $ cp ../index.php .
1477
1478       This will redirect anyone who tries to browse to your plugin directory
1479       to somewhere more appropriate.  If you create other directories under
1480       your plugin directory, you may copy the file there as well to be extra
1481       safe.  If you are storing sensitive configuration files or other data
1482       in such a directory, you could even include a .htaccess file with the
1483       contents "Deny From All" that will disallow access to that directory
1484       entirely (when the target system is running the Apache web server).
1485       Keep in mind that not all web servers will honor an .htaccess file, so
1486       don't depend on it for security. Make sure not to put such a file in
1487       your main plugin directory!
1488
1489   2.  A file that describes your plugin and offers detailed instructions for
1490       configuration or help with troubleshooting, etc.  This file is usually
1491       entitled "README".  Some useful sections to include might be:
1492
1493          Plugin Name and Author
1494          Current Version
1495          Plugin Features
1496          Detailed Plugin Description
1497          How-to for Plugin Configuration
1498          Change Log
1499          Future Ideas/Enhancements/To Do List
1500
1501   3.  A file that explains how to install your plugin.  This file is typically
1502       called "INSTALL".  If you do not require any special installation
1503       actions, you can probably copy one from another plugin or use this as
1504       a template:
1505
1506          Installing the Demo Plugin
1507          ==========================
1508
1509          1) Start with untaring the file into the plugins directory.
1510             Here is a example for the 1.0 version of the Demo plugin.
1511
1512            $ cd plugins
1513            $ tar -zxvf demo-1.0-1.4.0.tar.gz
1514
1515          2) Change into the demo directory, copy config.php.sample
1516             to config.php and edit config.php, making adjustments as
1517             you deem necessary.  For more detailed explanations about
1518             each of these parameters, consult the README file.
1519
1520            $ cd demo
1521            $ cp config.php.sample config.php
1522            $ vi config.php
1523
1524
1525          3) Then go to your config directory and run conf.pl.  Choose
1526             option 8 and move the plugin from the "Available Plugins"
1527             category to the "Installed Plugins" category.  Save and exit.
1528
1529            $ cd ../../config/
1530            $ ./conf.pl
1531
1532
1533          Upgrading the Demo Plugin
1534          =========================
1535
1536          1) Start with untaring the file into the plugins directory.
1537             Here is a example for the 3.1 version of the demo plugin.
1538
1539            $ cd plugins
1540            $ tar -zxvf demo-3.1-1.4.0.tar.gz
1541
1542
1543          2) Change into the demo directory, check your config.php
1544             file against the new version, to see if there are any new
1545             settings that you must add to your config.php file.
1546
1547            $ diff -Nau config.php config.php.sample
1548
1549             Or simply replace your config.php file with the provided sample
1550             and reconfigure the plugin from scratch (see step 2 under the
1551             installation procedure above).
1552
1553
1554 COMPATIBILITY WITH OLDER VERSIONS OF SQUIRRELMAIL
1555 =================================================
1556
1557 Whenever new versions of SquirrelMail are released, there is always a
1558 considerable lag time before it is widely adopted.  During that transitional
1559 time, especially when the new SquirrelMail version contains any architectural
1560 and/or functional changes, plugin developers are put in a unique and very
1561 difficult position.  That is, there will be people running both the old and
1562 new versions of SquirrelMail who want to use your plugin, and you will
1563 probably want to accomodate them both.
1564
1565 The easiest way to keep both sides happy is to keep two different versions
1566 of your pluign up to date, one that runs under the older SquirrelMail, and
1567 one that requires the newest SquirrelMail.  This is inconvenient, however,
1568 especially if you are continuing to develop the plugin.  Depending on the
1569 changes the SquirrelMail has implemented in the new version, you may be able
1570 to include code that can auto-sense SquirrelMail version and make adjustments
1571 on the fly.  There is a function available to you for determining the
1572 SquirrelMail version called check_sm_version() and it can be used as such:
1573
1574    check_sm_version(1, 4, 0)
1575
1576 This will return TRUE if the SquirrelMail being used is at least 1.4.0, and
1577 FALSE otherwise.
1578
1579 As this document is written, we are in a transition period between versions
1580 1.2.11 and 1.4.0.  There is a plugin called "Compatibilty" that is intended
1581 for use by plugin authors so they can develop one version of their plugin
1582 and seamlessly support both 1.2.x and 1.4.x SquirrelMail installations.  For
1583 more information about how to use the "Compatibility" plugin, download it and
1584 read its README file or see:
1585
1586    http://www.squirrelmail.org/wiki/wiki.php?PluginUpgrading
1587
1588
1589 REQUESTING NEW HOOKS
1590 ====================
1591
1592 It's impossible to foresee all of the places where hooks might be useful
1593 (it's also impossible to put in hooks everywhere!), so you might need to
1594 negotiate the insertion of a new hook to make your plugin work.  In order
1595 to do so, you should post such a request to the squirrelmail-devel mailing
1596 list.
1597
1598
1599 HOW TO RELEASE YOUR PLUGIN
1600 ==========================
1601
1602 As long as you've consulted the list of plugin standards and done your
1603 best to follow them, there's little standing in the way of great fame as an
1604 official SquirrelMail plugin developer.
1605
1606   1.  Make a distribution file.  There is a convenient Perl script in
1607       the plugins directory that will help you do this:
1608
1609          make_archive.pl -v demo 1.0 1.4.0
1610
1611       -v    is optional and indicates that the script should run in verbose mode
1612       demo  is the name of your plugin
1613       1.0   is the version of your plugin
1614       1.4.0 is the version of SquirrelMail that is required to run your plugin
1615
1616       You can also create the distribution file manually in most *nix
1617       environments by running this command from the plugins directory (NOT
1618       your plugin directory):
1619
1620          $ tar czvf demo-1.0-1.4.0.tar.gz demo
1621
1622       Where "demo" is the name of your plugin, "1.0" is the version of
1623       your plugin, and "1.4.0" is the version of SquirrelMail required
1624       to use your plugin.
1625
1626   2.  Consult the SquirrelMail web site for contact information for the
1627       Plugins Team Leaders, to whom you should make your request.  If they
1628       do not respond, you should feel free to ask for help contacting them
1629       on the squirrelmail-plugins mailing list.
1630
1631          http://www.squirrelmail.org/wiki/wiki.php?SquirrelMailLeadership
1632