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