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