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