4 * Description: Embedded XMPP (Jabber) client
6 * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
11 use Friendica\Core\Config;
12 use Friendica\Core\Hook;
13 use Friendica\Core\L10n;
14 use Friendica\Core\Renderer;
16 use Friendica\Util\Strings;
18 function xmpp_install()
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');
26 function xmpp_uninstall()
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');
34 function xmpp_addon_settings_post()
36 if (!local_user() || empty($_POST['xmpp-settings-submit'])) {
40 DI::pConfig()->set(local_user(), 'xmpp', 'enabled', $_POST['xmpp_enabled'] ?? false);
41 DI::pConfig()->set(local_user(), 'xmpp', 'individual', $_POST['xmpp_individual'] ?? false);
42 DI::pConfig()->set(local_user(), 'xmpp', 'bosh_proxy', $_POST['xmpp_bosh_proxy'] ?? '');
44 info(DI::l10n()->t('XMPP settings updated.') . EOL);
47 function xmpp_addon_settings(App $a, &$s)
53 /* Add our stylesheet to the xmpp so we can make our settings look nice */
55 DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/xmpp/xmpp.css' . '" media="all" />' . "\r\n";
57 /* Get the current state of our config variable */
59 $enabled = intval(DI::pConfig()->get(local_user(), 'xmpp', 'enabled'));
60 $enabled_checked = (($enabled) ? ' checked="checked" ' : '');
62 $individual = intval(DI::pConfig()->get(local_user(), 'xmpp', 'individual'));
63 $individual_checked = (($individual) ? ' checked="checked" ' : '');
65 $bosh_proxy = DI::pConfig()->get(local_user(), "xmpp", "bosh_proxy");
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>' . DI::l10n()->t('XMPP-Chat (Jabber)') . '</h3>';
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>' . DI::l10n()->t('XMPP-Chat (Jabber)') . '</h3>';
76 $s .= '<div id="xmpp-settings-wrapper">';
77 $s .= '<label id="xmpp-enabled-label" for="xmpp-enabled">' . DI::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>';
81 if (Config::get("xmpp", "central_userbase")) {
82 $s .= '<label id="xmpp-individual-label" for="xmpp-individual">' . DI::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>';
87 if (!Config::get("xmpp", "central_userbase") || DI::pConfig()->get(local_user(), "xmpp", "individual")) {
88 $s .= '<label id="xmpp-bosh-proxy-label" for="xmpp-bosh-proxy">' . DI::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>';
95 /* provide a submit button */
97 $s .= '<div class="settings-submit-wrapper" ><input type="submit" name="xmpp-settings-submit" class="settings-submit" value="' . DI::l10n()->t('Save Settings') . '" /></div></div>';
100 function xmpp_login()
102 if (empty($_SESSION['allow_api'])) {
103 $password = Strings::getRandomHex(16);
104 DI::pConfig()->set(local_user(), 'xmpp', 'password', $password);
108 function xmpp_addon_admin(App $a, &$o)
110 $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/xmpp/');
112 $o = Renderer::replaceMacros($t, [
113 '$submit' => DI::l10n()->t('Save Settings'),
114 '$bosh_proxy' => ['bosh_proxy', DI::l10n()->t('Jabber BOSH host'), Config::get('xmpp', 'bosh_proxy'), ''],
115 '$central_userbase' => ['central_userbase', DI::l10n()->t('Use central userbase'), Config::get('xmpp', 'central_userbase'), DI::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.')],
119 function xmpp_addon_admin_post()
121 $bosh_proxy = (!empty($_POST['bosh_proxy']) ? trim($_POST['bosh_proxy']) : '');
122 $central_userbase = (!empty($_POST['central_userbase']) ? intval($_POST['central_userbase']) : false);
124 Config::set('xmpp', 'bosh_proxy', $bosh_proxy);
125 Config::set('xmpp', 'central_userbase', $central_userbase);
127 info(DI::l10n()->t('Settings updated.') . EOL);
130 function xmpp_script(App $a)
135 function xmpp_converse(App $a)
141 if (($_GET['mode'] ?? '') == 'minimal') {
145 if (DI::mode()->isMobile() || DI::mode()->isMobile()) {
149 if (!DI::pConfig()->get(local_user(), "xmpp", "enabled")) {
153 if (in_array(DI::args()->getQueryString(), ["admin/federation/"])) {
157 DI::page()['htmlhead'] .= '<link type="text/css" rel="stylesheet" media="screen" href="addon/xmpp/converse/css/converse.css" />' . "\n";
158 DI::page()['htmlhead'] .= '<script src="addon/xmpp/converse/builds/converse.min.js"></script>' . "\n";
160 if (Config::get("xmpp", "central_userbase") && !DI::pConfig()->get(local_user(), "xmpp", "individual")) {
161 $bosh_proxy = Config::get("xmpp", "bosh_proxy");
163 $password = DI::pConfig()->get(local_user(), "xmpp", "password", '', true);
165 if ($password == "") {
166 $password = Strings::getRandomHex(16);
167 DI::pConfig()->set(local_user(), "xmpp", "password", $password);
170 $jid = $a->user["nickname"] . "@" . DI::baseUrl()->getHostname() . "/converse-" . Strings::getRandomHex(5);
172 $auto_login = "auto_login: true,
173 authentication: 'login',
175 password: '$password',
176 allow_logout: false,";
178 $bosh_proxy = DI::pConfig()->get(local_user(), "xmpp", "bosh_proxy");
183 if ($bosh_proxy == "") {
187 if (in_array($a->argv[0], ["delegation", "logout"])) {
188 $additional_commands = "converse.user.logout();\n";
190 $additional_commands = "";
195 $initialize = "converse.initialize({
196 bosh_service_url: '$bosh_proxy',
198 message_carbons: false,
199 forward_messages: false,
201 sounds_path: 'addon/xmpp/converse/sounds/',
202 roster_groups: false,
203 show_controlbox_by_default: false,
205 allow_contact_removal: false,
206 allow_registration: false,
207 hide_offline_users: true,
208 allow_chat_pending_contacts: false,
209 allow_dragresize: true,
212 csi_waiting_time: 300,
213 auto_reconnect: true,
215 xhr_user_search: false
218 DI::page()['htmlhead'] .= "<script>
219 require(['converse'], function (converse) {
221 converse.listen.on('ready', function (event) {