بدون توضیح

Zach DeCook c5b861f4a5 index: decode xmpp%3a uri if encoded 1 سال پیش
assets 5617b399af Add graphics 2 سال پیش
lang 385004df10 URIs: Add Contact Invitation with IBR 2 سال پیش
stylesheets dd106c063b URIs: Add register URIs 2 سال پیش
LICENSE eff90ea151 Licensed under MIT 4 سال پیش
README.md 385004df10 URIs: Add Contact Invitation with IBR 2 سال پیش
clients_Android.json c17f50c068 Android clients: Only use F-Droid links 2 سال پیش
clients_Linux.json 3422715e31 Add Converse aans Psi 2 سال پیش
clients_OSX.json 4dd12c3061 Add list of apps for Mac 2 سال پیش
clients_Tizen.json 8d085752cd Add list of apps for Tizen 2 سال پیش
clients_Windows.json a76b2b7172 Add list of apps for Windows 2 سال پیش
clients_iOS.json 7c62fd0ead Add Siskin IM and Jitsi Meet 2 سال پیش
index.php c5b861f4a5 index: decode xmpp%3a uri if encoded 1 سال پیش

README.md

PHP XMPP Invitation Landing Page

This is an XMPP invitation landing page that client developers or XMPP server admins can host on their servers. It allows users to send XMPP invitations (contacts or chat rooms) to people who do not have an XMPP client yet. This is part of the Easy XMPP initiative to improve the "first contact" experience.

For the JID romeo@xmpp.example, it will create the following page (live example):

Invitation from Romeo

Romeo has invited you to chat

[Add Romeo to Contact List]

xmpp:romeo@xmpp.example

If this link does not work, you need to install and configure an XMPP client, and visit this page again afterwards.

[snipped client list and disclaimer]

Principal operation

  • Romeo clicks on his XMPP client's "Create Invitation" button
    • The server provides the URI, and
    • either the server provides an invite web page link, or the client transforms the link into a landing page link.
  • Romeo sends the resulting invitation link via E-Mail, SMS, QR-Code, A5S2 messenger or any other means to Juliet.
  • Juliet opens the link in a web browser, which has a button linking to the xmpp: URI
    • If Juliet has an XMPP client, it will handle the button click and open the "Add to roster" dialog
    • If Juliet does not have an XMPP client, the link won't work. She must install a client and return to the link later

Supported URIs

Design decisions

  • The (privacy sensitive) JID and parameters are put into the Query String, which is transmitted to the hosting server
  • The fragment is parsed by the receiving server, this doesn't require JavaScript
  • User agent string is parsed server-side.

Privacy considerations

Don't use an instance from an untrusted server administrator. A malicious server administrator could use the URI (just the same as someone who intercepted the message).

Inspiration

This project was forked from easy-xmpp-invitation, which implements this with client-side javascript.

License

This code is licensed under the MIT License.