jarn.xmpp.core 0.3

Buildout

A sample buildout you can use as a starting point can be found at jarn.xmpp.buildout. Wokkel on which jarn.xmpp.twisted depends upon has not had a release for a while, so you will need to either use a development version or add:

find-links = http://dist.jarn.com/public

to your buildout to get an updated version.

Setting up ejabberd (>=2.1.5)

./bin/ejabberdctl register admin localhost your_password

Setting up your front-end proxy

On the client-side every authenticated user will be connected to your jabber server through an emulated bidirectional stream through HTTP. To allow for this you need a proxy in front of Plone that will be redirecting the XMPP stream to your XMPP server. It is possible to do without one using the inferior solution of Flash plugins but this is not going to be supported.

So assuming you run nginx as a proxy at port 8080 for the domain localhost, Zope listens on 8081, there exists a Plone site with id Plone and your ejabberd has the http_bind configured for port 5280, your nginx configuration will look like this:

http {
    server {
        listen       8080;
        server_name  localhost;
        location ~ ^/http-bind/ {
            proxy_pass http://localhost:5280;
        }

        location / {
            proxy_pass http://localhost:8081/VirtualHostBase/http/localhost:8080/Plone/VirtualHostRoot/;
        }
    }
  }

Setting up your Plone instances

Your instances will need to maintain a connection to the administrator account of your XMPP server. This is accomplished through Twisted and you will need to run a Twisted reactor on each of them. To do so include this in your instance section of your buildout:

zcml-additional =
  <configure xmlns="http://namespaces.zope.org/zope">
    <include package="jarn.xmpp.twisted" file="reactor.zcml" />
  </configure>

Again, it will help you to have a look at the sample buildout provided in jarn.xmpp.buildout.

Setting up a new Plone site

• Start ejabberd (if you used the recipe to build ejabberd, bin/ejabberd will do the job).

• Start the Nginx frontend. bin/frontend start

• Start your zope instance.

• Access Zope directly at http://localhost:8081/manage and create a new Plone site with jarn.xmpp.core (or jarn.xmpp.collaboration if you want that package installed as well).

• Go to the Plone control panel, into the registry settings. Edit the jarn.xmpp.* settings to reflect your installation, passwords etc.

• Restart your Plone instance.

• Upon the first request the administrator will log to his account. You should see things happening in the logs and if there are any errors something might be wrong with your installation.

• Setup the the users and pubsub nodes. You do this by calling @@setup-xmpp like http://localhost:8080/@@setup-xmpp. The form will not report any errors as everything will happen asynchronously but you will get the results/failures on the console.

If you are going to use this on an existing site, you only need to perform the last step after making sure that your XMPP admin is connected.

Making sure things work ;)

This is a complex infrastructure so it can be hard to know what goes wrong sometimes. Do not despair, here are a few things to try:

• Make sure your ejabberd is running. Connect to it normal client as the admin user.

• Verify that http-binding is setup properly on ejabberd. Visiting http://localhost:5280/http-bind should tell you it’s working.

• Verify that XMPP requests will get properly through your proxy. Visiting http://localhost:8080/http-bind/ should give you the same result as above.

• When you start your Zope instance in foreground you can verify the Twisted reactor is running fine:

  2011-09-01 14:37:38 INFO jarn.xmpp.twisted Starting Twisted reactor...
  2011-09-01 14:37:38 INFO jarn.xmpp.twisted Twisted reactor started
  2011-09-01 14:37:38 INFO Zope Ready to handle requests

• After the first request to the site, you should also see in the logs:

  2011-09-01 14:45:48 INFO jarn.xmpp.core XMPP admin client has authenticated succesfully.

• After having run @@setup-xmpp, logging-in to the Plone site with a user should also authenticate him with the XMPP server. This is indicated in the logs by:

  2011-09-01 14:45:50 INFO jarn.xmpp.core Pre-binded ggozad@localhost/auto-QravOoyEeE

0.3 - Unreleased

• Support one-level threading on pubsub nodes. [ggozad]

• Allow users to subscribe to individual nodes. [ggozad]

• Load PubSub items asyncronously. [ggozad]

• Implement XEP-0049 private storage on XMPP. [ggozad]

• Implement vCard 2.0 support. Allows all user meta-data/avatars to be stored on the XMPP server, avoiding all calls to Plone. [ggozad]

• Fix rare condition where a Safari browser would really misbehave and sometimes crash. Reverted patch to Strophe to allow WebKit browsers to make a synchronous instead of async call to disconnect on page unload. [ggozad]

• Styling! [mishunov]

• Update German translations [potzenheimer]

• Update french translation [toutpt]

0.23 - 2011-11-02

• Add German translations [potzenheimer]

• Added Italian translation [giacomos]

• Added French translation [toutpt]

0.22 - 2011-11-02

• i18n support. Norwegian and Greek for the time being. [ggozad]

• Provide a portlet that shows a PubSub feed. [ggozad]

• Fixed magic link error when the url points to a binary. https://github.com/ggozad/jarn.xmpp.core/issues/13 [ggozad]

0.21 - 2011-10-27

• Do not track user’s geolocation unless it’s necessary. [ggozad]

• Proxy the downloading of favicons (Closes #11). [ggozad]

• Link portrait to personal stream in feed views. (Closes #10). [ggozad]

• “Pretty dates” for the pubsub feed. (Closes #8). [ggozad]

0.2 - 2011-10-20

• Add geolocation capabilities. Posting to feeds can now include geolocation data. [ggozad]

• Use sessionStorage for user-info data, so that they are only fetched once per session. [ggozad]

0.2b1 - 2011-10-09

• Design and implement awesome UI for messaging, presence, pubsub feeds. [mishunov, ggozad]

• Replace python views/utilities for publishing to nodes by js. [ggozad]

• Provide a pubsub item view and load them asynchronously in the pubsub feed view. [ggozad]

• Start using sessionStorage in browsers where this is supported. [ggozad]

• Remove multi-user chat. It will go in again properly when the use-cases have been defined. [ggozad]

0.1b4 - 2011-09-30

• Revert to using Strophe 1.0.1 as a workaround against broken xml parser that insists on escaping everything. [ggozad]

0.1b3 - 2011-09-18

• Patch strophe to make synchronous requests in order to be able to really disconnect on onbeforeunload. This is to stop WebKit-based browsers from keeping users connected until they timeout. Also, no longer use minified versions of strophe libraries, since we patch them. [ggozad]

• Documentation updates. [tkimnguyen]

0.1b2 - 2011-09-02

• Fix startup subscriber to not do anything if the product has not been installed. This allows you to install on an existing site. [ggozad]

• Update to Strophe 1.0.2 [ggozad]

0.1b1 - 2011-09-01

• Simplified configuration and fixed confusing typos in the registry [ggozad]

• The admin client now handles failures to connect as well as getting disconnected. When this happens, the admin client utility will get unregistered and will retry on the next request. [ggozad]

• A viewlet is now available through which all actions can be performed. [ggozad]

• Added recipe in buildout to build ejabberd. Requires a working erlang installation. [ggozad]

• JS fixes [ggozad]

0.1a3 - 2011-06-06

• Included recipe to generate a working ejabberd.cfg using collective.recipe.template. [ggozad]

• Added some basic tests for pubsub. [ggozad]

• Run tests requiring the EJABBERD layer only when level 2 is specified on the testrunner. [ggozad]

0.1a2 - 2011-05-11

• Updated documentation on how to add a recent wokkel. [ggozad]

0.1a1 - 2011-05-09

• Initial release [ggozad]