xmpp/xmpp.php

   1 <?php
   2 /**
   3  * Name: XMPP (Jabber)
   4  * Description: Embedded XMPP (Jabber) client
   5  * Version: 0.1
   6  * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
   7  */
   8
   9 use Friendica\App;
  10 use Friendica\Core\Config;
  11 use Friendica\Core\Hook;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\PConfig;
  14 use Friendica\Core\Renderer;
  15 use Friendica\Util\Strings;
  16
  17 function xmpp_install()
  18 {
  19         Hook::register('addon_settings', 'addon/xmpp/xmpp.php', 'xmpp_addon_settings');
  20         Hook::register('addon_settings_post', 'addon/xmpp/xmpp.php', 'xmpp_addon_settings_post');
  21         Hook::register('page_end', 'addon/xmpp/xmpp.php', 'xmpp_script');
  22         Hook::register('logged_in', 'addon/xmpp/xmpp.php', 'xmpp_login');
  23 }
  24
  25 function xmpp_uninstall()
  26 {
  27         Hook::unregister('addon_settings', 'addon/xmpp/xmpp.php', 'xmpp_addon_settings');
  28         Hook::unregister('addon_settings_post', 'addon/xmpp/xmpp.php', 'xmpp_addon_settings_post');
  29         Hook::unregister('page_end', 'addon/xmpp/xmpp.php', 'xmpp_script');
  30         Hook::unregister('logged_in', 'addon/xmpp/xmpp.php', 'xmpp_login');
  31 }
  32
  33 function xmpp_addon_settings_post()
  34 {
  35         if (!local_user() || empty($_POST['xmpp-settings-submit'])) {
  36                 return;
  37         }
  38
  39         PConfig::set(local_user(), 'xmpp', 'enabled', defaults($_POST, 'xmpp_enabled', false));
  40         PConfig::set(local_user(), 'xmpp', 'individual', defaults($_POST, 'xmpp_individual', false));
  41         PConfig::set(local_user(), 'xmpp', 'bosh_proxy', defaults($_POST, 'xmpp_bosh_proxy', ''));
  42
  43         info(L10n::t('XMPP settings updated.') . EOL);
  44 }
  45
  46 function xmpp_addon_settings(App $a, &$s)
  47 {
  48         if (!local_user()) {
  49                 return;
  50         }
  51
  52         /* Add our stylesheet to the xmpp so we can make our settings look nice */
  53
  54         $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->getBaseURL() . '/addon/xmpp/xmpp.css' . '" media="all" />' . "\r\n";
  55
  56         /* Get the current state of our config variable */
  57
  58         $enabled = intval(PConfig::get(local_user(), 'xmpp', 'enabled'));
  59         $enabled_checked = (($enabled) ? ' checked="checked" ' : '');
  60
  61         $individual = intval(PConfig::get(local_user(), 'xmpp', 'individual'));
  62         $individual_checked = (($individual) ? ' checked="checked" ' : '');
  63
  64         $bosh_proxy = PConfig::get(local_user(), "xmpp", "bosh_proxy");
  65
  66         /* Add some HTML to the existing form */
  67         $s .= '<span id="settings_xmpp_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_xmpp_expanded\'); openClose(\'settings_xmpp_inflated\');">';
  68         $s .= '<h3>' . L10n::t('XMPP-Chat (Jabber)') . '</h3>';
  69         $s .= '</span>';
  70         $s .= '<div id="settings_xmpp_expanded" class="settings-block" style="display: none;">';
  71         $s .= '<span class="fakelink" onclick="openClose(\'settings_xmpp_expanded\'); openClose(\'settings_xmpp_inflated\');">';
  72         $s .= '<h3>' . L10n::t('XMPP-Chat (Jabber)') . '</h3>';
  73         $s .= '</span>';
  74
  75         $s .= '<div id="xmpp-settings-wrapper">';
  76         $s .= '<label id="xmpp-enabled-label" for="xmpp-enabled">' . L10n::t('Enable Webchat') . '</label>';
  77         $s .= '<input id="xmpp-enabled" type="checkbox" name="xmpp_enabled" value="1" ' . $enabled_checked . '/>';
  78         $s .= '<div class="clear"></div>';
  79
  80         if (Config::get("xmpp", "central_userbase")) {
  81                 $s .= '<label id="xmpp-individual-label" for="xmpp-individual">' . L10n::t('Individual Credentials') . '</label>';
  82                 $s .= '<input id="xmpp-individual" type="checkbox" name="xmpp_individual" value="1" ' . $individual_checked . '/>';
  83                 $s .= '<div class="clear"></div>';
  84         }
  85
  86         if (!Config::get("xmpp", "central_userbase") || PConfig::get(local_user(), "xmpp", "individual")) {
  87                 $s .= '<label id="xmpp-bosh-proxy-label" for="xmpp-bosh-proxy">' . L10n::t('Jabber BOSH host') . '</label>';
  88                 $s .= ' <input id="xmpp-bosh-proxy" type="text" name="xmpp_bosh_proxy" value="' . $bosh_proxy . '" />';
  89                 $s .= '<div class="clear"></div>';
  90         }
  91
  92         $s .= '</div>';
  93
  94         /* provide a submit button */
  95
  96         $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="xmpp-settings-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';
  97 }
  98
  99 function xmpp_login()
 100 {
 101         if (empty($_SESSION['allow_api'])) {
 102                 $password = Strings::getRandomHex(16);
 103                 PConfig::set(local_user(), 'xmpp', 'password', $password);
 104         }
 105 }
 106
 107 function xmpp_addon_admin(App $a, &$o)
 108 {
 109         $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/xmpp/');
 110
 111         $o = Renderer::replaceMacros($t, [
 112                 '$submit' => L10n::t('Save Settings'),
 113                 '$bosh_proxy' => ['bosh_proxy', L10n::t('Jabber BOSH host'), Config::get('xmpp', 'bosh_proxy'), ''],
 114                 '$central_userbase' => ['central_userbase', L10n::t('Use central userbase'), Config::get('xmpp', 'central_userbase'), L10n::t('If enabled, users will automatically login to an ejabberd server that has to be installed on this machine with synchronized credentials via the "auth_ejabberd.php" script.')],
 115         ]);
 116 }
 117
 118 function xmpp_addon_admin_post()
 119 {
 120         $bosh_proxy = (!empty($_POST['bosh_proxy']) ? trim($_POST['bosh_proxy']) : '');
 121         $central_userbase = (!empty($_POST['central_userbase']) ? intval($_POST['central_userbase']) : false);
 122
 123         Config::set('xmpp', 'bosh_proxy', $bosh_proxy);
 124         Config::set('xmpp', 'central_userbase', $central_userbase);
 125
 126         info(L10n::t('Settings updated.') . EOL);
 127 }
 128
 129 function xmpp_script(App $a)
 130 {
 131         xmpp_converse($a);
 132 }
 133
 134 function xmpp_converse(App $a)
 135 {
 136         if (!local_user()) {
 137                 return;
 138         }
 139
 140         if (defaults($_GET, "mode", '') == "minimal") {
 141                 return;
 142         }
 143
 144         if ($a->is_mobile || $a->is_tablet) {
 145                 return;
 146         }
 147
 148         if (!PConfig::get(local_user(), "xmpp", "enabled")) {
 149                 return;
 150         }
 151
 152         if (in_array($a->query_string, ["admin/federation/"])) {
 153                 return;
 154         }
 155
 156         $a->page['htmlhead'] .= '<link type="text/css" rel="stylesheet" media="screen" href="addon/xmpp/converse/css/converse.css" />' . "\n";
 157         $a->page['htmlhead'] .= '<script src="addon/xmpp/converse/builds/converse.min.js"></script>' . "\n";
 158
 159         if (Config::get("xmpp", "central_userbase") && !PConfig::get(local_user(), "xmpp", "individual")) {
 160                 $bosh_proxy = Config::get("xmpp", "bosh_proxy");
 161
 162                 $password = PConfig::get(local_user(), "xmpp", "password", '', true);
 163
 164                 if ($password == "") {
 165                         $password = Strings::getRandomHex(16);
 166                         PConfig::set(local_user(), "xmpp", "password", $password);
 167                 }
 168
 169                 $jid = $a->user["nickname"] . "@" . $a->getHostName() . "/converse-" . Strings::getRandomHex(5);
 170
 171                 $auto_login = "auto_login: true,
 172                         authentication: 'login',
 173                         jid: '$jid',
 174                         password: '$password',
 175                         allow_logout: false,";
 176         } else {
 177                 $bosh_proxy = PConfig::get(local_user(), "xmpp", "bosh_proxy");
 178
 179                 $auto_login = "";
 180         }
 181
 182         if ($bosh_proxy == "") {
 183                 return;
 184         }
 185
 186         if (in_array($a->argv[0], ["manage", "logout"])) {
 187                 $additional_commands = "converse.user.logout();\n";
 188         } else {
 189                 $additional_commands = "";
 190         }
 191
 192         $on_ready = "";
 193
 194         $initialize = "converse.initialize({
 195                                         bosh_service_url: '$bosh_proxy',
 196                                         keepalive: true,
 197                                         message_carbons: false,
 198                                         forward_messages: false,
 199                                         play_sounds: true,
 200                                         sounds_path: 'addon/xmpp/converse/sounds/',
 201                                         roster_groups: false,
 202                                         show_controlbox_by_default: false,
 203                                         show_toolbar: true,
 204                                         allow_contact_removal: false,
 205                                         allow_registration: false,
 206                                         hide_offline_users: true,
 207                                         allow_chat_pending_contacts: false,
 208                                         allow_dragresize: true,
 209                                         auto_away: 0,
 210                                         auto_xa: 0,
 211                                         csi_waiting_time: 300,
 212                                         auto_reconnect: true,
 213                                         $auto_login
 214                                         xhr_user_search: false
 215                                 });\n";
 216
 217         $a->page['htmlhead'] .= "<script>
 218                                         require(['converse'], function (converse) {
 219                                                 $initialize
 220                                                 converse.listen.on('ready', function (event) {
 221                                                         $on_ready
 222                                                 });
 223                                                 $additional_commands
 224                                         });
 225                                 </script>";
 226 }