ccdff59da7bd13b52921e82af73e61b37e7a4246
[squirrelmail.git] / doc / plugin.txt
1 A FEW NOTES ON THE PLUGIN ARCHITECTURE
2 ======================================
3
4 The plugin architecture of SquirrelMail is designed to make it
5 possible to add new features without having to patch SquirrelMail
6 itself. At the moment the plugin part of SquirrelMail should be
7 considered "alpha" or "beta" quality code.
8
9 Until the functionality and code is more stable, be prepared for
10 plugins to suddenly stop working.
11
12 Functionality like password changing, displaying ads and calendars
13 should be possible to add as plugins.
14
15
16 The idea
17 --------
18
19 The idea is to be able to run random code at given places in the
20 SquirrelMail code. This random code should then be able to do whatever
21 needed to enhance the functionality of SquirrelMail. The places where
22 code can be executed are called "hooks".
23
24 There are some limitations in what these hooks can do. It is difficult
25 to use them to change the layout and to change functionality that
26 already is in SquirrelMail.
27
28 Some way for the plugins to interact with the help subsystem and
29 translations will be provided.
30
31
32 The implementation
33 ------------------
34
35 In the main SquirrelMail files the file functions/plugin.php. In
36 places where hooks are made available they are executed by calling the
37 function do_hook("hookname").
38
39 The do_hook traverses the array $squirrelmail_plugin_hooks["hookname"]
40 and executes all the functions that are named in that array.
41
42 A plugin must reside in a subdirectory in the plugins/ directory. The
43 name of the subdirectory is considered the name of the plugin.
44
45 To start using a plugin, its name must be added to the $plugins array
46 in config.php like this:
47
48   $plugins[0] = "plugin_name";
49
50 When a plugin is registered the file plugins/plugin_name/setup.php is
51 included and the function squirrelmail_plugin_init_plugin_name is
52 called with no parameters.
53
54
55 Writing plugins
56 ---------------
57
58 A plugin must consist of at least a file called setup.php. All other
59 files the plugin consist of should also be in the plugin directory.
60
61 The function squirrelmail_plugin_init_plugin_name is called to
62 initalize a plugin. This function could look something like this:
63
64 function squirrelmail_plugin_init_demo () {
65   global $squirrelmail_plugin_hooks;
66
67   $squirrelmail_plugin_hooks["generic_header"]["demo"] = "plugin_demo_header";
68   $squirrelmail_plugin_hooks["menuline"]["demo"] = "plugin_demo_menuline";
69 }
70
71 Note that the SquirrelMail files assume that all other SquirrelMail
72 files are available as ../directory/file. This means that if some file
73 in the plugin directory is requested, it must do a chdir("..") before
74 including any of the standard SquirrelMail files.
75
76
77 Hook Data Passed
78 ----------------
79 Hooks, when executed, are called with one parameter, an array of data
80 that is passed to the hook.  The first element in the array is the name
81 of the hook that is being called.  Any other elements in the array are
82 dependant on the type of hook that is being called.
83
84 Some of the information in the array may be changed.  By default, the
85 plugins should never change data unless it is documented otherwise.
86
87
88 List of hooks
89 -------------
90   generic_header                  functions/page_header.php
91   menuline                        functions/page_header.php
92   compose_button_row              src/compose.php
93   compose_bottom                  src/compose.php
94   compose_form                    src/compose.php
95   compose_send                    src/compose.php
96   left_main_before                src/left_main.php
97   left_main_after                 src/left_main.php
98   * options_save                  src/options.php  (see note on options)
99   * options_link_and_description  src/options.php  (see note on options)
100   * options_highlight_bottom      src/options_highlight.php
101   * options_personal_bottom       src/options_personal.php
102   * options_personal_inside       src/options_personal.php
103   * options_personal_save         src/options_personal.php
104   * options_display_bottom        src/options_display.php
105   * options_display_inside        src/options_display.php
106   * options_display_save          src/options_display.php
107   * options_folders_bottom        src/options_folders.php
108   * options_folders_inside        src/options_folders.php
109   * options_folders_save          src/options_folders.php
110   & options_identities_process    src/options_identities.php
111   & options_identities_top        src/options_identities.php
112   & options_identities_renumber   src/options_identities.php (multiple places)
113   & options_identities_table      src/options_identities.php
114   & options_identities_buttons    src/options_identities.php
115   logout                          src/signout.php
116   login_before                    src/webmail.php
117   login_verified                  src/webmail.php
118   loading_prefs                   src/load_prefs.php
119   mailbox_index_before            functions/mailbox_display.php
120   mailbox_index_after             functions/mailbox_display.php
121   mailbox_form_before             functions/mailbox_display.php
122   subject_link                    functions/mailbox_display.php
123   right_main_after_header         src/right_main.php
124   right_main_bottom               src/right_main.php
125   login_top                       src/login.php
126   login_bottom                    src/login.php
127   html_top                        src/read_body.php
128   read_body_top                   src/read_body.php
129   read_body_bottom                src/read_body.php
130   html_bottom                     src/read_body.php
131   read_body_header                src/read_body.php
132   read_body_header_right          src/read_body.php
133   search_before_form              src/search.php
134   search_after_form               src/search.php
135   search_bottom                   src/search.php
136   help_top                        src/help.php
137   help_bottom                     src/help.php
138   help_chapter                    src/help.php
139   addrbook_html_search_below      src/addrbook_search_html.php
140   addressbook_bottom              src/addressbook.php
141   ^ attachment $type0/$type1      functions/mime.php (see note on attachments)
142    
143    
144 (*) Options
145 -----------
146 There are two ways to do options for your plugin.  First, you can incorporate it
147 into an existing section of the preferences (Display, Personal, or Folders).
148 The second way, you create your own section that they can choose from and it 
149 displays its own range of options.
150
151
152 First:  Integrating into existing options
153 -----------------------------------------
154 There are two hooks you need to use for this one:
155
156 1.  options_YOUCHOOSE_inside
157     This is the code that goes inside the table for the section you choose.  Since
158     it is going inside an existing table, it must be in this form:
159     ------cut here-------
160       <tr>
161          <td>
162             OPTION_NAME
163          </td>
164          <td>
165             OPTION_INPUT
166          </td>
167       </tr>   
168     ------cut here-------
169
170 2.  options_YOUCHOOSE_save
171     This is the code that saves your preferences into the users' preference 
172     file.  For an example of how to do this, see src/options.php.
173
174     
175 Second:  Create your own section
176 -------------------------------
177 It is possible to create your own options sections with plugins.  There are
178 three hooks you will need to use.
179
180 1.  options_link_and_description
181     This creates the link and has a description that are shown on the options
182     page.  This should output HTML that looks like this.  Make sure to read
183     the section on outputting your own pages.
184
185     -----cut here-----  
186       function my_plugin_name_my_function() {
187          global $color
188          ?>
189          <table width=50% cellpadding=3 cellspacing=0 border=0 align=center>
190             <tr>
191                <td bgcolor="<? echo $color[9] ?>">
192                   <a href="../plugins/YOUR_PLUGIN/YOUR_OPTIONS.php">YOUR OPTIONS NAME</a>
193                </td>
194             </tr>
195             <tr>
196                <td bgcolor="<? echo $color[0] ?>">
197                   YOUR DESCRIPTION
198                </td>
199             </tr>
200          </table>
201          <?php
202       }
203     -----cut here-----  
204
205 2.  options_save
206     Here is the code that you need to do to save your options in the 
207     preference files or manipulate whatever data you are trying to change
208     through the options section.  You can look at options.php for details 
209     on how this is to be done.
210
211 3.  loading_prefs (optional)
212     If you are wanting to save preferences to the preference files, then
213     you need to do this step as well.  Otherwise if you are manipulating
214     other data, ignore this step.
215
216     You should put the code in here that loads your preferences back
217     into usable variables.  Examples of this can be found in the file
218     src/load_prefs.php
219
220
221 (&) Identity Hooks
222 ------------------
223 Some hooks are passed special information in the array of arguments.  See
224 the SpamCop plugin for how to use them.
225
226 options_identities_process
227    [0] = Hook's name
228    [1] = Should I run the SaveUpdateFunction() (alterable)
229
230 options_identities_renumber
231    [0] = Hook's name
232    [1] = Renumber it from ('default' or 1 through # idents - 1)
233    [2] = Renumber it to (same thing)
234    
235 options_identities_table
236    [0] = Hook's name
237    [1] = Color of table (use it like   <tr<?PHP echo $Info[1]?>>   in your
238          plugin)
239    [2] = Is this an empty section?
240    [3] = What is the 'post' value?
241   
242 options_identities_buttons
243    [0] = Hook's name
244    [1] = Is this an empty section (the one at the end of the list)?
245    [2] = What is the 'post' value?
246
247
248 (^) Attachment Hooks
249 --------------------
250 When a message has attachments, this hook is called with the MIME types.  For
251 instance, a .zip file hook is "attachment application/x-zip".  The hook should
252 probably show a link to do a specific action, such as "Verify" or "View" for a
253 .zip file.
254
255 This is a breakdown of the data passed in the array to the hook that is called:
256
257   [0] = Hook's name ('attachment text/plain')
258   [1] = Array of links of actions (more below) (Alterable)
259   [2] = Used for returning to mail message (startMessage)
260   [3] = Used for finding message to display (id)
261   [4] = Mailbox name, urlencode()'d (urlMailbox)
262   [5] = Entity ID inside mail message (ent)
263   [6] = Default URL to go to when filename is clicked on (Alterable)
264   [7] = Filename that is displayed for the attachment
265   [8] = Sent if message was found from a search (where)
266   [9] = Sent if message was found from a search (what)
267   
268 To set up links for actions, you assign them like this:
269   
270   $Args[1]['your_plugin_name']['href'] = 'URL to link to';
271   $Args[1]['your_plugin_name']['text'] = 'What to display';
272     
273
274 Outputting Your Own Pages
275 -------------------------
276
277 Often, when you want to provide your own customized options screen or create
278 another web page instead of just using standard hooks, you will be creating
279 your own .php files.  An example of this is the attachment_common plugin's
280 image.php file.
281
282 To make sure that security is maintained and standards are followed, the top
283 of your PHP script should look very similar to this:
284
285   <?PHP
286     /* This is my php file.
287      * description goes here.
288      */
289      
290     chdir('..');
291     include('../src/validate.php');
292     
293 The validate.php script will include internationalization support,
294 config.php variables, strings.php functions, and also authenticate that the
295 user is truly logged in.  Validate.php also calls stripslashes() on incoming
296 data (if gpc_magic_quotes() is on).  You should never need to worry about
297 that stuff again.  As a warning, this has only really been ironed out in
298 1.1.1.  If you create/modify a plugin to follow these rules, you must
299 mention that it requires SquirrelMail 1.1.1 or later.
300
301 After that, if you need further functions, just use
302
303   include('../functions/filename.php');
304   
305 in your script.  Since 1.0.5, it was no longer necessary (nor recommended)
306 to use the "if (! isset($filename_php))" syntax.