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