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
  34 Register your addon hooks during installation.
  35
  36     Addon::registerHook($hookname, $file, $function);
  37
  38 $hookname is a string and corresponds to a known Friendica PHP hook.
  39
  40 $file is a pathname relative to the top-level Friendica directory.
  41 This *should* be 'addon/*addon_name*/*addon_name*.php' in most cases.
  42
  43 $function is a string and is the name of the function which will be executed when the hook is called.
  44
  45 #### Arguments
  46 Your hook callback functions will be called with at least one and possibly two arguments
  47
  48     function myhook_function(App $a, &$b) {
  49
  50     }
  51
  52
  53 If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
  54
  55 ##### $a
  56 $a is the Friendica 'App' class.
  57 It contains a wealth of information about the current state of Friendica:
  58
  59 * which module has been called,
  60 * configuration information,
  61 * the page contents at the point the hook was invoked,
  62 * profile and user information, etc.
  63
  64 It is recommeded you call this '$a' to match its usage elsewhere.
  65
  66 ##### $b
  67 $b can be called anything you like.
  68 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.
  69 Remember to declare it with '&' if you wish to alter it.
  70
  71 JavaScript addon hooks
  72 ---
  73
  74 #### PHP part
  75 Make sure your JavaScript addon file (addon/*addon_name*/*addon_name*.js) is listed in the document response.
  76
  77 In your addon install function, add:
  78
  79     Addon::registerHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
  80
  81 In your addon uninstall function, add:
  82
  83     Addon::unregisterHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
  84
  85 Then, add your addon name to the *addon_hooks* template variable array:
  86
  87      function <addon_name>_template_vars($a, &$arr)
  88        {
  89          if (!array_key_exists('addon_hooks',$arr['vars']))
  90          {
  91             $arr['vars']['addon_hooks'] = array();
  92          }
  93        $arr['vars']['addon_hooks'][] = "<addon_name>";
  94        }
  95
  96 #### JavaScript part
  97 Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
  98
  99     Addon_registerHook(type,hookfnstr);
 100
 101 *type* is the name of the hook and corresponds to a known Friendica JavaScript hook.
 102 *hookfnstr* is the name of your JavaScript function to execute.
 103
 104 No arguments are provided to your JavaScript callback function. Example:
 105
 106     function myhook_function() {
 107
 108     }
 109
 110 Modules
 111 ---
 112
 113 Addons may also act as "modules" and intercept all page requests for a given URL path.
 114 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.
 115
 116 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.
 117 These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
 118 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).
 119 This will include:
 120
 121     $a->argc = 3
 122     $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
 123
 124 Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
 125 They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
 126 You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
 127
 128 Templates
 129 ---
 130
 131 If your addon needs some template, you can use the Friendica template system.
 132 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
 133
 134 Put your tpl files in the *templates/* subfolder of your addon.
 135
 136 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
 137
 138     # load template file. first argument is the template name,
 139     # second is the addon path relative to friendica top folder
 140     $tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
 141
 142     # apply template. first argument is the loaded template,
 143     # second an array of 'name'=>'values' to pass to template
 144     $output = replace_macros($tpl,array(
 145         'title' => 'My beautiful addon',
 146     ));
 147
 148 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
 149
 150 Current PHP hooks
 151 -------------
 152
 153 ### 'authenticate'
 154 'authenticate' is called when a user attempts to login.
 155 $b is an array containing:
 156
 157     'username' => the supplied username
 158     'password' => the supplied password
 159     'authenticated' => set this to non-zero to authenticate the user.
 160     'user_record' => successful authentication must also return a valid user record from the database
 161
 162 ### 'logged_in'
 163 'logged_in' is called after a user has successfully logged in.
 164 $b contains the $a->user array.
 165
 166 ### 'display_item'
 167 'display_item' is called when formatting a post for display.
 168 $b is an array:
 169
 170     'item' => The item (array) details pulled from the database
 171     'output' => the (string) HTML representation of this item prior to adding it to the page
 172
 173 ### 'post_local'
 174 * called when a status post or comment is entered on the local system
 175 * $b is the item array of the information to be stored in the database
 176 * Please note: body contents are bbcode - not HTML
 177
 178 ### 'post_local_end'
 179 * called when a local status post or comment has been stored on the local system
 180 * $b is the item array of the information which has just been stored in the database
 181 * Please note: body contents are bbcode - not HTML
 182
 183 ### 'post_remote'
 184 * called when receiving a post from another source. This may also be used to post local activity or system generated messages.
 185 * $b is the item array of information to be stored in the database and the item body is bbcode.
 186
 187 ### 'settings_form'
 188 * called when generating the HTML for the user Settings page
 189 * $b is the (string) HTML of the settings page before the final '</form>' tag.
 190
 191 ### 'settings_post'
 192 * called when the Settings pages are submitted
 193 * $b is the $_POST array
 194
 195 ### 'addon_settings'
 196 * called when generating the HTML for the addon settings page
 197 * $b is the (string) HTML of the addon settings page before the final '</form>' tag.
 198
 199 ### 'addon_settings_post'
 200 * called when the Addon Settings pages are submitted
 201 * $b is the $_POST array
 202
 203 ### 'profile_post'
 204 * called when posting a profile page
 205 * $b is the $_POST array
 206
 207 ### 'profile_edit'
 208 'profile_edit' is called prior to output of profile edit page.
 209 $b is an array containing:
 210
 211     'profile' => profile (array) record from the database
 212     'entry' => the (string) HTML of the generated entry
 213
 214 ### 'profile_advanced'
 215 * called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
 216 * $b is the (string) HTML representation of the generated profile
 217 * The profile array details are in $a->profile.
 218
 219 ### 'directory_item'
 220 'directory_item' is called from the Directory page when formatting an item for display.
 221 $b is an array:
 222
 223     'contact' => contact (array) record for the person from the database
 224     'entry' => the (string) HTML of the generated entry
 225
 226 ### 'profile_sidebar_enter'
 227 * called prior to generating the sidebar "short" profile for a page
 228 * $b is the person's profile array
 229
 230 ### 'profile_sidebar'
 231 'profile_sidebar is called when generating the sidebar "short" profile for a page.
 232 $b is an array:
 233
 234     'profile' => profile (array) record for the person from the database
 235     'entry' => the (string) HTML of the generated entry
 236
 237 ### 'contact_block_end'
 238 is called when formatting the block of contacts/friends on a profile sidebar has completed.
 239 $b is an array:
 240
 241     'contacts' => array of contacts
 242     'output' => the (string) generated HTML of the contact block
 243
 244 ### 'bbcode'
 245 * called during conversion of bbcode to html
 246 * $b is a string converted text
 247
 248 ### 'html2bbcode'
 249 * called during conversion of html to bbcode (e.g. remote message posting)
 250 * $b is a string converted text
 251
 252 ### 'page_header'
 253 * called after building the page navigation section
 254 * $b is a string HTML of nav region
 255
 256 ### 'personal_xrd'
 257 'personal_xrd' is called prior to output of personal XRD file.
 258 $b is an array:
 259
 260     'user' => the user record for the person
 261     'xml' => the complete XML to be output
 262
 263 ### 'home_content'
 264 * called prior to output home page content, shown to unlogged users
 265 * $b is (string) HTML of section region
 266
 267 ### 'contact_edit'
 268 is called when editing contact details on an individual from the Contacts page.
 269 $b is an array:
 270
 271     'contact' => contact record (array) of target contact
 272     'output' => the (string) generated HTML of the contact edit page
 273
 274 ### 'contact_edit_post'
 275 * called when posting the contact edit page.
 276 * $b is the $_POST array
 277
 278 ### 'init_1'
 279 * called just after DB has been opened and before session start
 280 * $b is not used or passed
 281
 282 ### 'page_end'
 283 * called after HTML content functions have completed
 284 * $b is (string) HTML of content div
 285
 286 ### 'avatar_lookup'
 287 'avatar_lookup' is called when looking up the avatar.
 288 $b is an array:
 289
 290     'size' => the size of the avatar that will be looked up
 291     'email' => email to look up the avatar for
 292     'url' => the (string) generated URL of the avatar
 293
 294 ### 'emailer_send_prepare'
 295 'emailer_send_prepare' called from Emailer::send() before building the mime message.
 296 $b is an array, params to Emailer::send()
 297
 298     'fromName' => name of the sender
 299     'fromEmail' => email fo the sender
 300     'replyTo' => replyTo address to direct responses
 301     'toEmail' => destination email address
 302     'messageSubject' => subject of the message
 303     'htmlVersion' => html version of the message
 304     'textVersion' => text only version of the message
 305     'additionalMailHeader' => additions to the smtp mail header
 306
 307 ### 'emailer_send'
 308 is called before calling PHP's mail().
 309 $b is an array, params to mail()
 310
 311     'to'
 312     'subject'
 313     'body'
 314     'headers'
 315
 316 ### 'nav_info'
 317 is called after the navigational menu is build in include/nav.php.
 318 $b is an array containing $nav from nav.php.
 319
 320 ### 'template_vars'
 321 is called before vars are passed to the template engine to render the page.
 322 The registered function can add,change or remove variables passed to template.
 323 $b is an array with:
 324
 325     'template' => filename of template
 326     'vars' => array of vars passed to template
 327
 328 ### 'acl_lookup_end'
 329 is called after the other queries have passed.
 330 The registered function can add, change or remove the acl_lookup() variables.
 331
 332     'results' => array of the acl_lookup() vars
 333
 334 ### 'prepare_body_init'
 335 Called at the start of prepare_body
 336 Hook data:
 337     'item' => item array (input/output)
 338
 339 ### 'prepare_body_content_filter'
 340 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
 341 just add the reason to the filter_reasons element of the hook data.
 342 Hook data:
 343     'item' => item array (input)
 344     'filter_reasons' => reasons array (input/output)
 345
 346 ### 'prepare_body'
 347 Called after the HTML conversion in prepare_body.
 348 Hook data:
 349     'item' => item array (input)
 350     'html' => converted item body (input/output)
 351     'is_preview' => post preview flag (input)
 352     'filter_reasons' => reasons array (input)
 353
 354 ### 'prepare_body_final'
 355 Called at the end of prepare_body.
 356 Hook data:
 357     'item' => item array (input)
 358     'html' => converted item body (input/output)
 359
 360 ### 'magic_auth_success'
 361 Called when a magic-auth was successful.
 362 Hook data:
 363     'visitor' => array with the contact record of the visitor
 364     'url' => the query string
 365
 366 Current JavaScript hooks
 367 -------------
 368
 369 ### 'postprocess_liveupdate'
 370 Called at the end of the live update process (XmlHttpRequest)
 371
 372 Complete list of hook callbacks
 373 ---
 374
 375 Here is a complete list of all hook callbacks with file locations (as of 01-Apr-2018). Please see the source for details of any hooks not documented above.
 376
 377 ### index.php
 378
 379     Addon::callHooks('init_1');
 380     Addon::callHooks('app_menu', $arr);
 381     Addon::callHooks('page_content_top', $a->page['content']);
 382     Addon::callHooks($a->module.'_mod_init', $placeholder);
 383     Addon::callHooks($a->module.'_mod_init', $placeholder);
 384     Addon::callHooks($a->module.'_mod_post', $_POST);
 385     Addon::callHooks($a->module.'_mod_afterpost', $placeholder);
 386     Addon::callHooks($a->module.'_mod_content', $arr);
 387     Addon::callHooks($a->module.'_mod_aftercontent', $arr);
 388     Addon::callHooks('page_end', $a->page['content']);
 389
 390 ### include/api.php
 391
 392     Addon::callHooks('logged_in', $a->user);
 393     Addon::callHooks('authenticate', $addon_auth);
 394     Addon::callHooks('logged_in', $a->user);
 395
 396 ### include/enotify.php
 397
 398     Addon::callHooks('enotify', $h);
 399     Addon::callHooks('enotify_store', $datarray);
 400     Addon::callHooks('enotify_mail', $datarray);
 401     Addon::callHooks('check_item_notification', $notification_data);
 402
 403 ### include/conversation.php
 404
 405     Addon::callHooks('conversation_start', $cb);
 406     Addon::callHooks('render_location', $locate);
 407     Addon::callHooks('display_item', $arr);
 408     Addon::callHooks('display_item', $arr);
 409     Addon::callHooks('item_photo_menu', $args);
 410     Addon::callHooks('jot_tool', $jotplugins);
 411
 412 ### include/security.php
 413
 414     Addon::callHooks('logged_in', $a->user);
 415
 416 ### include/text.php
 417
 418     Addon::callHooks('contact_block_end', $arr);
 419     Addon::callHooks('poke_verbs', $arr);
 420     Addon::callHooks('prepare_body_init', $item);
 421     Addon::callHooks('prepare_body_content_filter', $hook_data);
 422     Addon::callHooks('prepare_body', $hook_data);
 423     Addon::callHooks('prepare_body_final', $hook_data);
 424
 425 ### include/items.php
 426
 427     Addon::callHooks('page_info_data', $data);
 428
 429 ### mod/directory.php
 430
 431     Addon::callHooks('directory_item', $arr);
 432
 433 ### mod/xrd.php
 434
 435     Addon::callHooks('personal_xrd', $arr);
 436
 437 ### mod/ping.php
 438
 439     Addon::callHooks('network_ping', $arr);
 440
 441 ### mod/parse_url.php
 442
 443     Addon::callHooks("parse_link", $arr);
 444
 445 ### mod/manage.php
 446
 447     Addon::callHooks('home_init', $ret);
 448
 449 ### mod/acl.php
 450
 451     Addon::callHooks('acl_lookup_end', $results);
 452
 453 ### mod/network.php
 454
 455     Addon::callHooks('network_content_init', $arr);
 456     Addon::callHooks('network_tabs', $arr);
 457
 458 ### mod/friendica.php
 459
 460     Addon::callHooks('about_hook', $o);
 461
 462 ### mod/subthread.php
 463
 464     Addon::callHooks('post_local_end', $arr);
 465
 466 ### mod/profiles.php
 467
 468     Addon::callHooks('profile_post', $_POST);
 469     Addon::callHooks('profile_edit', $arr);
 470
 471 ### mod/settings.php
 472
 473     Addon::callHooks('addon_settings_post', $_POST);
 474     Addon::callHooks('connector_settings_post', $_POST);
 475     Addon::callHooks('display_settings_post', $_POST);
 476     Addon::callHooks('settings_post', $_POST);
 477     Addon::callHooks('addon_settings', $settings_addons);
 478     Addon::callHooks('connector_settings', $settings_connectors);
 479     Addon::callHooks('display_settings', $o);
 480     Addon::callHooks('settings_form', $o);
 481
 482 ### mod/photos.php
 483
 484     Addon::callHooks('photo_post_init', $_POST);
 485     Addon::callHooks('photo_post_file', $ret);
 486     Addon::callHooks('photo_post_end', $foo);
 487     Addon::callHooks('photo_post_end', $foo);
 488     Addon::callHooks('photo_post_end', $foo);
 489     Addon::callHooks('photo_post_end', $foo);
 490     Addon::callHooks('photo_post_end', intval($item_id));
 491     Addon::callHooks('photo_upload_form', $ret);
 492
 493 ### mod/profile.php
 494
 495     Addon::callHooks('profile_advanced', $o);
 496
 497 ### mod/home.php
 498
 499     Addon::callHooks('home_init', $ret);
 500     Addon::callHooks("home_content", $content);
 501
 502 ### mod/poke.php
 503
 504     Addon::callHooks('post_local_end', $arr);
 505
 506 ### mod/contacts.php
 507
 508     Addon::callHooks('contact_edit_post', $_POST);
 509     Addon::callHooks('contact_edit', $arr);
 510
 511 ### mod/tagger.php
 512
 513     Addon::callHooks('post_local_end', $arr);
 514
 515 ### mod/lockview.php
 516
 517     Addon::callHooks('lockview_content', $item);
 518
 519 ### mod/uexport.php
 520
 521     Addon::callHooks('uexport_options', $options);
 522
 523 ### mod/register.php
 524
 525     Addon::callHooks('register_post', $arr);
 526     Addon::callHooks('register_form', $arr);
 527
 528 ### mod/item.php
 529
 530     Addon::callHooks('post_local_start', $_REQUEST);
 531     Addon::callHooks('post_local', $datarray);
 532     Addon::callHooks('post_local_end', $datarray);
 533
 534 ### mod/editpost.php
 535
 536     Addon::callHooks('jot_tool', $jotplugins);
 537
 538 ### src/Network/FKOAuth1.php
 539
 540     Addon::callHooks('logged_in', $a->user);
 541
 542 ### src/Render/FriendicaSmartyEngine.php
 543
 544     Addon::callHooks("template_vars", $arr);
 545
 546 ### src/Model/Item.php
 547
 548     Addon::callHooks('post_local', $item);
 549     Addon::callHooks('post_remote', $item);
 550     Addon::callHooks('post_local_end', $posted_item);
 551     Addon::callHooks('post_remote_end', $posted_item);
 552     Addon::callHooks('tagged', $arr);
 553     Addon::callHooks('post_local_end', $new_item);
 554
 555 ### src/Model/Contact.php
 556
 557     Addon::callHooks('contact_photo_menu', $args);
 558     Addon::callHooks('follow', $arr);
 559
 560 ### src/Model/Profile.php
 561
 562     Addon::callHooks('profile_sidebar_enter', $profile);
 563     Addon::callHooks('profile_sidebar', $arr);
 564     Addon::callHooks('profile_tabs', $arr);
 565     Addon::callHooks('zrl_init', $arr);
 566     Addon::callHooks('magic_auth_success', $arr);
 567
 568 ### src/Model/Event.php
 569
 570     Addon::callHooks('event_updated', $event['id']);
 571     Addon::callHooks("event_created", $event['id']);
 572
 573 ### src/Model/User.php
 574
 575     Addon::callHooks('register_account', $uid);
 576     Addon::callHooks('remove_user', $user);
 577
 578 ### src/Content/Text/BBCode.php
 579
 580     Addon::callHooks('bbcode', $text);
 581     Addon::callHooks('bb2diaspora', $text);
 582
 583 ### src/Content/Text/HTML.php
 584
 585     Addon::callHooks('html2bbcode', $message);
 586
 587 ### src/Content/Smilies.php
 588
 589     Addon::callHooks('smilie', $params);
 590
 591 ### src/Content/Feature.php
 592
 593     Addon::callHooks('isEnabled', $arr);
 594     Addon::callHooks('get', $arr);
 595
 596 ### src/Content/ContactSelector.php
 597
 598     Addon::callHooks('network_to_name', $nets);
 599     Addon::callHooks('gender_selector', $select);
 600     Addon::callHooks('sexpref_selector', $select);
 601     Addon::callHooks('marital_selector', $select);
 602
 603 ### src/Content/OEmbed.php
 604
 605     Addon::callHooks('oembed_fetch_url', $embedurl, $j);
 606
 607 ### src/Content/Nav.php
 608
 609     Addon::callHooks('page_header', $a->page['nav']);
 610     Addon::callHooks('nav_info', $nav);
 611
 612 ### src/Worker/Directory.php
 613
 614     Addon::callHooks('globaldir_update', $arr);
 615
 616 ### src/Worker/Notifier.php
 617
 618     Addon::callHooks('notifier_end', $target_item);
 619
 620 ### src/Worker/Queue.php
 621
 622     Addon::callHooks('queue_predeliver', $r);
 623     Addon::callHooks('queue_deliver', $params);
 624
 625 ### src/Module/Login.php
 626
 627     Addon::callHooks('authenticate', $addon_auth);
 628     Addon::callHooks('login_hook', $o);
 629
 630 ### src/Module/Logout.php
 631
 632     Addon::callHooks("logging_out");
 633
 634 ### src/Object/Post.php
 635
 636     Addon::callHooks('render_location', $locate);
 637     Addon::callHooks('display_item', $arr);
 638
 639 ### src/Core/ACL.php
 640
 641     Addon::callHooks('contact_select_options', $x);
 642     Addon::callHooks($a->module.'_pre_'.$selname, $arr);
 643     Addon::callHooks($a->module.'_post_'.$selname, $o);
 644     Addon::callHooks($a->module.'_pre_'.$selname, $arr);
 645     Addon::callHooks($a->module.'_post_'.$selname, $o);
 646     Addon::callHooks('jot_networks', $jotnets);
 647
 648 ### src/Core/Worker.php
 649
 650     Addon::callHooks("proc_run", $arr);
 651
 652 ### src/Util/Emailer.php
 653
 654     Addon::callHooks('emailer_send_prepare', $params);
 655     Addon::callHooks("emailer_send", $hookdata);
 656
 657 ### src/Util/Map.php
 658
 659     Addon::callHooks('generate_map', $arr);
 660     Addon::callHooks('generate_named_map', $arr);
 661     Addon::callHooks('Map::getCoordinates', $arr);
 662
 663 ### src/Util/Network.php
 664
 665     Addon::callHooks('avatar_lookup', $avatar);
 666
 667 ### src/Util/ParseUrl.php
 668
 669     Addon::callHooks("getsiteinfo", $siteinfo);
 670
 671 ### src/Protocol/DFRN.php
 672
 673     Addon::callHooks('atom_feed_end', $atom);
 674     Addon::callHooks('atom_feed_end', $atom);
 675
 676 ### view/js/main.js
 677
 678     callAddonHooks("postprocess_liveupdate");