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