]> git.mxchange.org Git - friendica.git/blob - doc/Addons.md
5d4be6db160ec750e3bf73a491a1cd22344365c9
[friendica.git] / doc / Addons.md
1 Friendica Addon development
2 ==============
3
4 * [Home](help)
5
6 Please see the sample addon 'randplace' for a working example of using some of these features.
7 Addons work by intercepting event hooks - which must be registered.
8 Modules work by intercepting specific page requests (by URL path).
9
10 Addon names cannot contain spaces or other punctuation and are used as filenames and function names.
11 You may supply a "friendly" name within the comment block.
12 Each addon must contain both an install and an uninstall function based on the addon name.
13 For instance "addon1name_install()".
14 These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
15 The install and uninstall functions will also be called (i.e. re-installed) if the addon changes after installation.
16 Therefore your uninstall should not destroy data and install should consider that data may already exist.
17 Future extensions may provide for "setup" amd "remove".
18
19 Addons should contain a comment block with the four following parameters:
20
21     /*
22      * Name: My Great Addon
23      * Description: This is what my addon does. It's really cool.
24      * Version: 1.0
25      * Author: John Q. Public <john@myfriendicasite.com>
26      */
27
28 Please also add a README or README.md file to the addon directory.
29 It will be displayed in the admin panel and should include some further information in addition to the header information.
30
31 ## PHP addon hooks
32
33 Register your addon hooks during installation.
34
35     \Friendica\Core\Hook::register($hookname, $file, $function);
36
37 $hookname is a string and corresponds to a known Friendica PHP hook.
38
39 $file is a pathname relative to the top-level Friendica directory.
40 This *should* be 'addon/*addon_name*/*addon_name*.php' in most cases.
41
42 $function is a string and is the name of the function which will be executed when the hook is called.
43
44 ### Arguments
45 Your hook callback functions will be called with at least one and possibly two arguments
46
47     function myhook_function(App $a, &$b) {
48
49     }
50
51
52 If you wish to make changes to the calling data, you must declare them as reference variables (with `&`) during function declaration.
53
54 #### $a
55 $a is the Friendica `App` class.
56 It contains a wealth of information about the current state of Friendica:
57
58 * which module has been called,
59 * configuration information,
60 * the page contents at the point the hook was invoked,
61 * profile and user information, etc.
62
63 It is recommeded you call this `$a` to match its usage elsewhere.
64
65 #### $b
66 $b can be called anything you like.
67 This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
68 Remember to declare it with `&` if you wish to alter it.
69
70 ## Global stylesheets
71
72 If your addon requires adding a stylesheet on all pages of Friendica, add the following hook:
73
74 ```php
75 function <addon>_install()
76 {
77         \Friendica\Core\Hook::register('head', __FILE__, '<addon>_head');
78         ...
79 }
80
81
82 function <addon>_head(App $a)
83 {
84         $a->registerStylesheet(__DIR__ . '/relative/path/to/addon/stylesheet.css');
85 }
86 ```
87
88 `__DIR__` is the folder path of your addon.
89
90 ## JavaScript
91
92 ### Global scripts
93
94 If your addon requires adding a script on all pages of Friendica, add the following hook:
95
96
97 ```php
98 function <addon>_install()
99 {
100         \Friendica\Core\Hook::register('footer', __FILE__, '<addon>_footer');
101         ...
102 }
103
104 function <addon>_footer(App $a)
105 {
106         $a->registerFooterScript(__DIR__ . '/relative/path/to/addon/script.js');
107 }
108 ```
109
110 `__DIR__` is the folder path of your addon.
111
112 ### JavaScript hooks
113
114 The main Friendica script provides hooks via events dispatched on the `document` property.
115 In your Javascript file included as described above, add your event listener like this:
116
117 ```js
118 document.addEventListener(name, callback);
119 ```
120
121 - *name* is the name of the hook and corresponds to a known Friendica JavaScript hook.
122 - *callback* is a JavaScript anonymous function to execute.
123
124 More info about Javascript event listeners: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
125
126 #### Current JavaScript hooks
127
128 ##### postprocess_liveupdate
129 Called at the end of the live update process (XmlHttpRequest) and on a post preview.
130 No additional data is provided.
131
132 ## Modules
133
134 Addons may also act as "modules" and intercept all page requests for a given URL path.
135 In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
136
137 If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.
138 These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
139 So http://my.web.site/addon/arg1/arg2 would look for a module named "addon" and pass its module functions the $a App structure (which is available to many components).
140 This will include:
141
142 ```php
143 $a->argc = 3
144 $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
145 ```
146
147 Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
148 They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
149 You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
150
151 ## Templates
152
153 If your addon needs some template, you can use the Friendica template system.
154 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
155
156 Put your tpl files in the *templates/* subfolder of your addon.
157
158 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
159
160 ```php
161 # load template file. first argument is the template name,
162 # second is the addon path relative to friendica top folder
163 $tpl = Renderer::getMarkupTemplate('mytemplate.tpl', 'addon/addon_name/');
164
165 # apply template. first argument is the loaded template,
166 # second an array of 'name' => 'values' to pass to template
167 $output = Renderer::replaceMacros($tpl, array(
168         'title' => 'My beautiful addon',
169 ));
170 ```
171
172 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
173
174 ## Current PHP hooks
175
176 ### authenticate
177 Called when a user attempts to login.
178 `$b` is an array containing:
179
180 - **username**: the supplied username
181 - **password**: the supplied password
182 - **authenticated**: set this to non-zero to authenticate the user.
183 - **user_record**: successful authentication must also return a valid user record from the database
184
185 ### logged_in
186 Called after a user has successfully logged in.
187 `$b` contains the `$a->user` array.
188
189 ### display_item
190 Called when formatting a post for display.
191 $b is an array:
192
193 - **item**: The item (array) details pulled from the database
194 - **output**: the (string) HTML representation of this item prior to adding it to the page
195
196 ### post_local
197 Called when a status post or comment is entered on the local system.
198 `$b` is the item array of the information to be stored in the database.
199 Please note: body contents are bbcode - not HTML.
200
201 ### post_local_end
202 Called when a local status post or comment has been stored on the local system.
203 `$b` is the item array of the information which has just been stored in the database.
204 Please note: body contents are bbcode - not HTML
205
206 ### post_remote
207 Called when receiving a post from another source. This may also be used to post local activity or system generated messages.
208 `$b` is the item array of information to be stored in the database and the item body is bbcode.
209
210 ### settings_form
211 Called when generating the HTML for the user Settings page.
212 `$b` is the HTML string of the settings page before the final `</form>` tag.
213
214 ### settings_post
215 Called when the Settings pages are submitted.
216 `$b` is the $_POST array.
217
218 ### addon_settings
219 Called when generating the HTML for the addon settings page.
220 `$b` is the (string) HTML of the addon settings page before the final `</form>` tag.
221
222 ### addon_settings_post
223 Called when the Addon Settings pages are submitted.
224 `$b` is the $_POST array.
225
226 ### profile_post
227 Called when posting a profile page.
228 `$b` is the $_POST array.
229
230 ### profile_edit
231 Called prior to output of profile edit page.
232 `$b` is an array containing:
233
234 - **profile**: profile (array) record from the database
235 - **entry**: the (string) HTML of the generated entry
236
237 ### profile_advanced
238 Called when the HTML is generated for the Advanced profile, corresponding to the Profile tab within a person's profile page.
239 `$b` is the HTML string representation of the generated profile.
240 The profile array details are in `$a->profile`.
241
242 ### directory_item
243 Called from the Directory page when formatting an item for display.
244 `$b` is an array:
245
246 - **contact**: contact record array for the person from the database
247 - **entry**: the HTML string of the generated entry
248
249 ### profile_sidebar_enter
250 Called prior to generating the sidebar "short" profile for a page.
251 `$b` is the person's profile array
252
253 ### profile_sidebar
254 Called when generating the sidebar "short" profile for a page.
255 `$b` is an array:
256
257 - **profile**: profile record array for the person from the database
258 - **entry**: the HTML string of the generated entry
259
260 ### contact_block_end
261 Called when formatting the block of contacts/friends on a profile sidebar has completed.
262 `$b` is an array:
263
264 - **contacts**: array of contacts
265 - **output**: the generated HTML string of the contact block
266
267 ### bbcode
268 Called after conversion of bbcode to HTML.
269 `$b` is an HTML string converted text.
270
271 ### html2bbcode
272 Called after tag conversion of HTML to bbcode (e.g. remote message posting)
273 `$b` is a string converted text
274
275 ### head
276 Called when building the `<head>` sections.
277 Stylesheets should be registered using this hook.
278 `$b` is an HTML string of the `<head>` tag.
279
280 ### page_header
281 Called after building the page navigation section.
282 `$b` is a string HTML of nav region.
283
284 ### personal_xrd
285 Called prior to output of personal XRD file.
286 `$b` is an array:
287
288 - **user**: the user record array for the person
289 - **xml**: the complete XML string to be output
290
291 ### home_content
292 Called prior to output home page content, shown to unlogged users.
293 `$b` is the HTML sring of section region.
294
295 ### contact_edit
296 Called when editing contact details on an individual from the Contacts page.
297 $b is an array:
298
299 - **contact**: contact record (array) of target contact
300 - **output**: the (string) generated HTML of the contact edit page
301
302 ### contact_edit_post
303 Called when posting the contact edit page.
304 `$b` is the `$_POST` array
305
306 ### init_1
307 Called just after DB has been opened and before session start.
308 No hook data.
309
310 ### page_end
311 Called after HTML content functions have completed.
312 `$b` is (string) HTML of content div.
313
314 ### footer
315 Called after HTML content functions have completed.
316 Deferred Javascript files should be registered using this hook.
317 `$b` is (string) HTML of footer div/element.
318
319 ### avatar_lookup
320 Called when looking up the avatar. `$b` is an array:
321
322 - **size**: the size of the avatar that will be looked up
323 - **email**: email to look up the avatar for
324 - **url**: the (string) generated URL of the avatar
325
326 ### emailer_send_prepare
327 Called from `Emailer::send()` before building the mime message.
328 `$b` is an array of params to `Emailer::send()`.
329
330 - **fromName**: name of the sender
331 - **fromEmail**: email fo the sender
332 - **replyTo**: replyTo address to direct responses
333 - **toEmail**: destination email address
334 - **messageSubject**: subject of the message
335 - **htmlVersion**: html version of the message
336 - **textVersion**: text only version of the message
337 - **additionalMailHeader**: additions to the smtp mail header
338
339 ### emailer_send
340 Called before calling PHP's `mail()`.
341 `$b` is an array of params to `mail()`.
342
343 - **to**
344 - **subject**
345 - **body**
346 - **headers**
347
348 ### load_config
349 Called during `App` initialization to allow addons to load their own configuration file(s) with `App::loadConfigFile()`.
350
351 ### nav_info
352 Called after the navigational menu is build in `include/nav.php`.
353 `$b` is an array containing `$nav` from `include/nav.php`.
354
355 ### template_vars
356 Called before vars are passed to the template engine to render the page.
357 The registered function can add,change or remove variables passed to template.
358 `$b` is an array with:
359
360 - **template**: filename of template
361 - **vars**: array of vars passed to the template
362
363 ### acl_lookup_end
364 Called after the other queries have passed.
365 The registered function can add, change or remove the `acl_lookup()` variables.
366
367 - **results**: array of the acl_lookup() vars
368
369 ### prepare_body_init
370 Called at the start of prepare_body
371 Hook data:
372
373 - **item** (input/output): item array
374
375 ### prepare_body_content_filter
376 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
377 just add the reason to the filter_reasons element of the hook data.
378 Hook data:
379
380 - **item**: item array (input)
381 - **filter_reasons** (input/output): reasons array
382
383 ### prepare_body
384 Called after the HTML conversion in `prepare_body()`.
385 Hook data:
386
387 - **item** (input): item array
388 - **html** (input/output): converted item body
389 - **is_preview** (input): post preview flag
390 - **filter_reasons** (input): reasons array
391
392 ### prepare_body_final
393 Called at the end of `prepare_body()`.
394 Hook data:
395
396 - **item**: item array (input)
397 - **html**: converted item body (input/output)
398
399 ### put_item_in_cache
400 Called after `prepare_text()` in `put_item_in_cache()`.
401 Hook data:
402
403 - **item** (input): item array
404 - **rendered-html** (input/output): final item body HTML
405 - **rendered-hash** (input/output): original item body hash
406
407 ### magic_auth_success
408 Called when a magic-auth was successful.
409 Hook data:
410
411     visitor => array with the contact record of the visitor
412     url => the query string
413
414 ### jot_networks
415 Called when displaying the post permission screen.
416 Hook data is a list of form fields that need to be displayed along the ACL.
417 Form field array structure is:
418
419 - **type**: `checkbox` or `select`.
420 - **field**: Standard field data structure to be used by `field_checkbox.tpl` and `field_select.tpl`.
421
422 For `checkbox`, **field** is:
423   - [0] (String): Form field name; Mandatory. 
424   - [1]: (String): Form field label; Optional, default is none.
425   - [2]: (Boolean): Whether the checkbox should be checked by default; Optional, default is false.
426   - [3]: (String): Additional help text; Optional, default is none.
427   - [4]: (String): Additional HTML attributes; Optional, default is none.
428
429 For `select`, **field** is:
430   - [0] (String): Form field name; Mandatory.
431   - [1] (String): Form field label; Optional, default is none.
432   - [2] (Boolean): Default value to be selected by default; Optional, default is none.
433   - [3] (String): Additional help text; Optional, default is none.
434   - [4] (Array): Associative array of options. Item key is option value, item value is option label; Mandatory. 
435
436
437
438 ## Complete list of hook callbacks
439
440 Here is a complete list of all hook callbacks with file locations (as of 24-Sep-2018). Please see the source for details of any hooks not documented above.
441
442 ### index.php
443
444     Hook::callAll('init_1');
445     Hook::callAll('app_menu', $arr);
446     Hook::callAll('page_content_top', $a->page['content']);
447     Hook::callAll($a->module.'_mod_init', $placeholder);
448     Hook::callAll($a->module.'_mod_init', $placeholder);
449     Hook::callAll($a->module.'_mod_post', $_POST);
450     Hook::callAll($a->module.'_mod_afterpost', $placeholder);
451     Hook::callAll($a->module.'_mod_content', $arr);
452     Hook::callAll($a->module.'_mod_aftercontent', $arr);
453     Hook::callAll('page_end', $a->page['content']);
454
455 ### include/api.php
456
457     Hook::callAll('logged_in', $a->user);
458     Hook::callAll('authenticate', $addon_auth);
459     Hook::callAll('logged_in', $a->user);
460
461 ### include/enotify.php
462
463     Hook::callAll('enotify', $h);
464     Hook::callAll('enotify_store', $datarray);
465     Hook::callAll('enotify_mail', $datarray);
466     Hook::callAll('check_item_notification', $notification_data);
467
468 ### include/conversation.php
469
470     Hook::callAll('conversation_start', $cb);
471     Hook::callAll('render_location', $locate);
472     Hook::callAll('display_item', $arr);
473     Hook::callAll('display_item', $arr);
474     Hook::callAll('item_photo_menu', $args);
475     Hook::callAll('jot_tool', $jotplugins);
476
477 ### include/text.php
478
479     Hook::callAll('contact_block_end', $arr);
480     Hook::callAll('poke_verbs', $arr);
481     Hook::callAll('put_item_in_cache', $hook_data);
482     Hook::callAll('prepare_body_init', $item);
483     Hook::callAll('prepare_body_content_filter', $hook_data);
484     Hook::callAll('prepare_body', $hook_data);
485     Hook::callAll('prepare_body_final', $hook_data);
486
487 ### include/items.php
488
489     Hook::callAll('page_info_data', $data);
490
491 ### mod/directory.php
492
493     Hook::callAll('directory_item', $arr);
494
495 ### mod/xrd.php
496
497     Hook::callAll('personal_xrd', $arr);
498
499 ### mod/ping.php
500
501     Hook::callAll('network_ping', $arr);
502
503 ### mod/parse_url.php
504
505     Hook::callAll("parse_link", $arr);
506
507 ### mod/manage.php
508
509     Hook::callAll('home_init', $ret);
510
511 ### mod/acl.php
512
513     Hook::callAll('acl_lookup_end', $results);
514
515 ### mod/network.php
516
517     Hook::callAll('network_content_init', $arr);
518     Hook::callAll('network_tabs', $arr);
519
520 ### mod/friendica.php
521
522     Hook::callAll('about_hook', $o);
523
524 ### mod/subthread.php
525
526     Hook::callAll('post_local_end', $arr);
527
528 ### mod/profiles.php
529
530     Hook::callAll('profile_post', $_POST);
531     Hook::callAll('profile_edit', $arr);
532
533 ### mod/settings.php
534
535     Hook::callAll('addon_settings_post', $_POST);
536     Hook::callAll('connector_settings_post', $_POST);
537     Hook::callAll('display_settings_post', $_POST);
538     Hook::callAll('settings_post', $_POST);
539     Hook::callAll('addon_settings', $settings_addons);
540     Hook::callAll('connector_settings', $settings_connectors);
541     Hook::callAll('display_settings', $o);
542     Hook::callAll('settings_form', $o);
543
544 ### mod/photos.php
545
546     Hook::callAll('photo_post_init', $_POST);
547     Hook::callAll('photo_post_file', $ret);
548     Hook::callAll('photo_post_end', $foo);
549     Hook::callAll('photo_post_end', $foo);
550     Hook::callAll('photo_post_end', $foo);
551     Hook::callAll('photo_post_end', $foo);
552     Hook::callAll('photo_post_end', intval($item_id));
553     Hook::callAll('photo_upload_form', $ret);
554
555 ### mod/profile.php
556
557     Hook::callAll('profile_advanced', $o);
558
559 ### mod/home.php
560
561     Hook::callAll('home_init', $ret);
562     Hook::callAll("home_content", $content);
563
564 ### mod/poke.php
565
566     Hook::callAll('post_local_end', $arr);
567
568 ### mod/contacts.php
569
570     Hook::callAll('contact_edit_post', $_POST);
571     Hook::callAll('contact_edit', $arr);
572
573 ### mod/tagger.php
574
575     Hook::callAll('post_local_end', $arr);
576
577 ### mod/lockview.php
578
579     Hook::callAll('lockview_content', $item);
580
581 ### mod/uexport.php
582
583     Hook::callAll('uexport_options', $options);
584
585 ### mod/register.php
586
587     Hook::callAll('register_post', $arr);
588     Hook::callAll('register_form', $arr);
589
590 ### mod/item.php
591
592     Hook::callAll('post_local_start', $_REQUEST);
593     Hook::callAll('post_local', $datarray);
594     Hook::callAll('post_local_end', $datarray);
595
596 ### mod/editpost.php
597
598     Hook::callAll('jot_tool', $jotplugins);
599
600 ### src/Network/FKOAuth1.php
601
602     Hook::callAll('logged_in', $a->user);
603
604 ### src/Render/FriendicaSmartyEngine.php
605
606     Hook::callAll("template_vars", $arr);
607
608 ### src/App.php
609
610     Hook::callAll('load_config');
611     Hook::callAll('head');
612     Hook::callAll('footer');
613
614 ### src/Model/Item.php
615
616     Hook::callAll('post_local', $item);
617     Hook::callAll('post_remote', $item);
618     Hook::callAll('post_local_end', $posted_item);
619     Hook::callAll('post_remote_end', $posted_item);
620     Hook::callAll('tagged', $arr);
621     Hook::callAll('post_local_end', $new_item);
622
623 ### src/Model/Contact.php
624
625     Hook::callAll('contact_photo_menu', $args);
626     Hook::callAll('follow', $arr);
627
628 ### src/Model/Profile.php
629
630     Hook::callAll('profile_sidebar_enter', $profile);
631     Hook::callAll('profile_sidebar', $arr);
632     Hook::callAll('profile_tabs', $arr);
633     Hook::callAll('zrl_init', $arr);
634     Hook::callAll('magic_auth_success', $arr);
635
636 ### src/Model/Event.php
637
638     Hook::callAll('event_updated', $event['id']);
639     Hook::callAll("event_created", $event['id']);
640
641 ### src/Model/User.php
642
643     Hook::callAll('register_account', $uid);
644     Hook::callAll('remove_user', $user);
645
646 ### src/Content/Text/BBCode.php
647
648     Hook::callAll('bbcode', $text);
649     Hook::callAll('bb2diaspora', $text);
650
651 ### src/Content/Text/HTML.php
652
653     Hook::callAll('html2bbcode', $message);
654
655 ### src/Content/Smilies.php
656
657     Hook::callAll('smilie', $params);
658
659 ### src/Content/Feature.php
660
661     Hook::callAll('isEnabled', $arr);
662     Hook::callAll('get', $arr);
663
664 ### src/Content/ContactSelector.php
665
666     Hook::callAll('network_to_name', $nets);
667     Hook::callAll('gender_selector', $select);
668     Hook::callAll('sexpref_selector', $select);
669     Hook::callAll('marital_selector', $select);
670
671 ### src/Content/OEmbed.php
672
673     Hook::callAll('oembed_fetch_url', $embedurl, $j);
674
675 ### src/Content/Nav.php
676
677     Hook::callAll('page_header', $a->page['nav']);
678     Hook::callAll('nav_info', $nav);
679
680 ### src/Worker/Directory.php
681
682     Hook::callAll('globaldir_update', $arr);
683
684 ### src/Worker/Notifier.php
685
686     Hook::callAll('notifier_end', $target_item);
687
688 ### src/Worker/Queue.php
689
690     Hook::callAll('queue_predeliver', $r);
691     Hook::callAll('queue_deliver', $params);
692
693 ### src/Module/Login.php
694
695     Hook::callAll('authenticate', $addon_auth);
696     Hook::callAll('login_hook', $o);
697
698 ### src/Module/Logout.php
699
700     Hook::callAll("logging_out");
701
702 ### src/Object/Post.php
703
704     Hook::callAll('render_location', $locate);
705     Hook::callAll('display_item', $arr);
706
707 ### src/Core/ACL.php
708
709     Hook::callAll('contact_select_options', $x);
710     Hook::callAll($a->module.'_pre_'.$selname, $arr);
711     Hook::callAll($a->module.'_post_'.$selname, $o);
712     Hook::callAll($a->module.'_pre_'.$selname, $arr);
713     Hook::callAll($a->module.'_post_'.$selname, $o);
714     Hook::callAll('jot_networks', $jotnets);
715
716 ### src/Core/Authentication.php
717
718     Hook::callAll('logged_in', $a->user);
719
720 ### src/Core/Hook.php
721
722     self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata);
723
724 ### src/Core/Worker.php
725
726     Hook::callAll("proc_run", $arr);
727
728 ### src/Util/Emailer.php
729
730     Hook::callAll('emailer_send_prepare', $params);
731     Hook::callAll("emailer_send", $hookdata);
732
733 ### src/Util/Map.php
734
735     Hook::callAll('generate_map', $arr);
736     Hook::callAll('generate_named_map', $arr);
737     Hook::callAll('Map::getCoordinates', $arr);
738
739 ### src/Util/Network.php
740
741     Hook::callAll('avatar_lookup', $avatar);
742
743 ### src/Util/ParseUrl.php
744
745     Hook::callAll("getsiteinfo", $siteinfo);
746
747 ### src/Protocol/DFRN.php
748
749     Hook::callAll('atom_feed_end', $atom);
750     Hook::callAll('atom_feed_end', $atom);
751
752 ### view/js/main.js
753
754     document.dispatchEvent(new Event('postprocess_liveupdate'));