IM Presence Plugin

Added by David Peterson, last edited by David Chui on Jul 09, 2008  (view change) show comment
Name IM Presence NG Plugin
Vendor Atlassian Software Systems (Website)
Authors Jonathan Nolen, David Peterson
Homepage http://confluence.atlassian.com/display/CONFEXT/IM+Presence+Plugin
Issue Management http://developer.atlassian.com/jira/browse/PRES
Categories Communication Macros
Version 2.2
Availability Confluence v2.7 to v2.9-m5
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/IM+Presence+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/impresence-plugin/tags/impresence-plugin-2.2/
Download JAR impresence-plugin-2.2.jar
This plugin can be installed and updated via the Confluence Repository Client.

Compatibility With Confluence

Plugin Version 2.4.5 2.5.8 2.6.2 2.7.3 2.8.2 Tested
2.0  
2.1    
2.2    

Description/Features

Display the presence status of users for a variety of Instant Messaging services.

A simple macro which displays the presence status of users for various Instant Messaging services, such as AIM or MSN.

This can be considered a replacement for the existing macros which come bundled with recent versions of Confluence, as well as the Aim User Status Macro, Google Talk Macro, Sametime status macro, Skype Me User Macro, Wildfire Presence Macro and Yahoo Status macro.

Screenshots

The various services in action.

Downloading & Installing

Option 1

The recommended way of installing is to use the Confluence Repository Client. This will not only make it easier to install, but it will help keep you up to date with this and other plugins.

  1. Open the repository client screen.
  2. Select 'Install' for the IM Presence Plugin entry.

Option 2

Alternately, you can install it manually:

  1. Download impresence-plugin-2.0-rc2.jar
  2. Upload it using Confluence's administration console.

Setup

Once you have installed the plugin, you will have to do some configuration for some of the services to work. There are two main types of setup.

Dummy User

Some (such as Google Talk and MSN) only advertise presence status to logged-in users who have been added to the target user's contact list. As such, the setup process is something like this:

  1. Create a dummy user for the specified service (eg. 'dummy001@hotmail.com')
  2. Enter the user id and password in the configuration screen for that service.

Then, to display the presence of an MSN user, the Confluence editor would enter something like the following:

{im:my_username@hotmail.com|service=MSN}

Behind the scenes, the plugin does the following:

  1. Log in as a dummy user
  2. Add the target user as a contact of the dummy user
  3. Wait for the target user to approve the dummy user to see their status
  4. Report the status of the target user.

Custom Server

Some other services (such as Jabber/Wildfire) need to have the chat server address set. In this case, the procedure is as follows:

  1. Set up the IM Server if necessary.
  2. Enter the server address in the configuration section of the plugin.

Once this is done, presence can be listed as per usual.

Macros

{im:[my username]|service=[my service]}

Details: Outputs an editable dynamic calendar.
Parameters:

Name Required Description
(default) The id/screen name of the user.
service The name of the service. Supported services are: aim, gtalk, icq, msn, sametime, skype, wildfire and yahoo.
showid If set to 'false', the ID/screen name will not be displayed. Defaults to true.

A number of old macro formats are also supported (starting with version 2.0) for compatibility with older im macro plugins. These older formats are:
{aim:[my username]}
{gtalk:[my username@gmail.com]}
{icq:[my username]}
{msn:[my username]}
{sametime:[my username]}
{skype:[my username]}
{skypeme:[my username]}
{skypeme}[my username]{skypeme}
{wildfire:[my username]}
{wildfire}[my username]{wildfire}
{yahoo:[my username]}

Examples

Default display

This displays the status of a Yahoo! Messenger user.

{im:my_username|service=Yahoo}

No User ID

This will display the status without also displaying the user id.

{im:my_username|service=Yahoo|showid=false}

Version History

Version Date State License Price
Show description 2.2 (#7) 09 Jul 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Maintenance release. Please click here for the list of fixes.

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.1 (#6) 12 Mar 2008 Stable Freeware / Open Source (BSD) Free

Release Notes
function initializeColumnWidth(columnArray) { var columnWidths = {}; if (columnArray == undefined || columnArray.length <= 0) return columnWidths; // compute for the space that can be allocated, the overhead of the columns are also accounted for var spaceRemaining = getWindowWidth() - (37 + (columnArray.length*11)); var hasSummary = false; var columnsWithWidth = 0; var otherColumnWidth = 140; // set the widths for columns with default column width for (var i=0; i columnsWithWidth)) { otherColumnWidth = spaceRemaining / (columnArray.length - columnsWithWidth); // adjust the size the columns with for (var i=0; iJira Issues', page: 1, useRp: false, rp: 1000, showTableToggleBtn: true, height: 160, onSubmit: onSubmitFunction_jiraissues_1, onError: onErrorFunction_jiraissues_1, onReload: onReloadFunction_jiraissues_1, errormsg: 'Connection Error', pagestat: 'Displaying {from} to {to} of {total} items', procmsg: 'Processing, please wait...', nomsg: 'No items' }); });

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.0 (#5) 17 Oct 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

  • Added support for old-format macros (to match macros in other, now obsolete, plugins).

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.0-rc3 (#4) 02 Oct 2006 Prerelease Freeware / Open Source (BSD) Free

Release Notes

  • Fixed the Yahoo! presence image.

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.0-rc2 (#3) 27 Jun 2006 Prerelease Freeware / Open Source (BSD) Free

Release Notes

  • Fixed the path to the notation guide help file.

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.0-rc1 (#2) 22 Jun 2006 Prerelease Freeware / Open Source (BSD) Free

Release Notes

  • Added Wildfire and Sametime support.
  • Fixed small display bug with Skype output.
  • Updated license details in source code to BSD.
  • Miscellaneous cosmetic tweaks.

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Show description 2.0-dr1 (#1) 22 Jun 2006 Beta Freeware / Open Source (BSD) Free

Release Notes

  • Initial version.

Contributors

  • Jonathan Nolen — Developer
  • David Peterson — Developer

Labels

atlassian-supported atlassian-supported Delete
confluence20 confluence20 Delete
confluence21 confluence21 Delete
confluence22 confluence22 Delete
repository_current repository_current Delete
communication communication Delete
plugin plugin Delete
macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (30)

 

  1. Jul 04, 2006

    Mickaël Rémond says:

    Hello, Why isn't the Google Talk plugin simply a generic Jabber plugin ? If it w...

    Hello,

    Why isn't the Google Talk plugin simply a generic Jabber plugin ? If it work with Google Talk, it will work with any Jabber server, but you have to enable the configuration to allow to define the server name.

    We are developers of ejabberd and we would like to use this plugin on our server.

    How do you want to proceed ?

    Do you want us to submit a patch ? 

    1. Jul 04, 2006

      David Peterson says:

      Yeah, probably should have just made a standard Jabber plugin. Feel free to subm...

      Yeah, probably should have just made a standard Jabber plugin. Feel free to submit the patch - that will certainly be faster than waiting for it to get added from my end - I just have too much on my plate at the moment.

      1. Sep 19, 2006

        Nikolay Gorylenko says:

        And, please do not forget about hosted GMail users. They use not only <login>@gm...

        And, please do not forget about hosted GMail users.
        They use not only <login>@gmail.com for xmpp auth, but <login>@<domain.name>.
        If you'll not stick to talk.google.com login scheme, you'll automatically add generic jabber server support.

        Yes, i know about special auth process for GTalk, and yes, it needs special work-around.
        But please, jabber is not GTalk! only

  2. Jul 12, 2006

    Roshan Jhunja says:

    We currently use the SIP service of Windows Messenger for intranet company commu...

    We currently use the SIP service of Windows Messenger for intranet company communication.  Is it possible somehow to get the plugin to query our local service rather than Microsoft's?

    1. Jul 17, 2006

      David Peterson says:

      Not at this point. If you can point me towards a Java API that lets you access i...

      Not at this point. If you can point me towards a Java API that lets you access it, it should be possible to add at some point in the future...

  3. Jul 12, 2006

    Michael Bosch says:

    Is anyone having problems with the Yahoo presence monitor not picking up the sta...

    Is anyone having problems with the Yahoo presence monitor not picking up the status of their Yahoo account properly?

    Just curious. Mine always shows me logged out.

    1. Jul 12, 2006

      Michael Bosch says:

      BTW, I know it's not the macro...but I followed the Yahoo instructions on how to...

      BTW, I know it's not the macro...but I followed the Yahoo instructions on how to show presence to others so I'm just curious if others have seen this issue with Yahoo.

      1. Jul 17, 2006

        David Peterson says:

        Yeah, Yahoo seems flakey. Not sure what to do about that, other than trying to d...

        Yeah, Yahoo seems flakey. Not sure what to do about that, other than trying to do more direct presence checking (as opposed to just displaying the image Yahoo returns).

  4. Jul 17, 2006

    Gordon Rogier says:

    Relating to the DummyUser approach, is this supported for Sametime mode?&nbsp; a...

    Relating to the DummyUser approach, is this supported for Sametime mode?  also how about AIM mode?  If so, how is the dummy user configured for both of these modes?

    Does the Sametime mode still require STLinks toolkit to be installed on the Sametime servers ?

     thnx.  ~G

    1. Jul 17, 2006

      David Peterson says:

      As far as I know, Sametime doesn't need a dummy user. It does, however, require ...

      As far as I know, Sametime doesn't need a dummy user. It does, however, require STLinks to be installed on the Sametime server and for that server to be set in the config for this plugin.

      And as for AIM, it should Just Work (tm) - they don't seem to have the same security restrictions as MSN and Google Talk.

  5. Aug 09, 2006

    Peter R. says:

    Would it be possible to add Microsoft Live Communications Server (Office Communi...

    Would it be possible to add Microsoft Live Communications Server (Office Communicator) Support? We recently migrated off of Sametime and on to LCS. Thanks.

    1. Aug 09, 2006

      David Peterson says:

      That depends if there is a Java library around which works with LCS. Do you know...

      That depends if there is a Java library around which works with LCS. Do you know of any? I'm pretty sure the one I'm using does not support it.

      Of course, if Microsoft has published the protocols, one could write a whole new support library for it. But that one wouldn't be me at present, due to time constraints...

      1. Oct 24, 2006

        Peter R. says:

        After doing some casual checking, I've determined that no, no Java library exist...

        After doing some casual checking, I've determined that no, no Java library exists for LCS. Oh well, someday...

      2. Jan 11, 2008

        Mark Ziesemer says:

        I just found the "Microsoft Office Communicator Web Access AJAX Service SDK 1.0"...

        I just found the "Microsoft Office Communicator Web Access AJAX Service SDK 1.0" at http://www.microsoft.com/downloads/details.aspx?FamilyId=A839967B-680F-41E6-99B4-F020319BBD88&displaylang=en.

        Included is a .chm help file that documents how to communicate with Communicator using AJAX / JSON. It also includes some sample applications, including for C# and JavaScript. I tried the C# sample, then writing a new sample application that re-used the "AjaxServices" project to just retrieve presence information. That portion of "AjaxServices" (which is also just a "sample") appears to be broken, as no PresenceEvent's are generated. However, I did see the data coming back in the raw response XML, so it definitely looks possible! I also don't see anything that would prevent easily duplicating this functionality from within Java.

        The only requirement I see worth mentioning is that this communicates with an AJAX filter and extension installed on a "Communicator Web Access" server, which may or may not be available in some environments.

        Another promising link I found is "Microsoft Presence Sample for AJAX Based Web Client" at http://www.microsoft.com/downloads/details.aspx?FamilyID=54b55a17-fa00-4b37-a487-929f7732de83&displaylang=en, though I haven't even looked at it yet.

  6. Oct 24, 2006

    Menso Heus says:

    Plugin works great for AIM and Skype, but after creating a dummy MSN account and...

    Plugin works great for AIM and Skype, but after creating a dummy MSN account and adding it to my buddy list I receive the following error from the plugin instead of the status information:

    Any ideas on how to fix this? The tag added is

    An administrator must configure your server's MSN/Windows Messenger Service before you can use this macro.

    Running Conf 2.2.9

    1. Oct 25, 2006

      David Peterson says:

      Hi Menso, Unfortunately neither the error message nor the macro code you're usi...

      Hi Menso,

      Unfortunately neither the error message nor the macro code you're using are visible. Could you create an issue in JIRA for this problem instead? Go here to do so.

      Thanks.

      1. Oct 25, 2006

        Menso Heus says:

        Hi David, &nbsp;Sorry, should have escaped the characters :) Anyway, the first e...

        Hi David,

         Sorry, should have escaped the characters Anyway, the first error was caused by me (didn't add the @hotmail.com to the MSN dummy account login). Now I've done that and the dummy account has asked my MSN account to be added. I've given permission for this and when I log in with the dummy account through web messenger I can see my real MSN account being online. The plugin however still gives me the following error:

        Waiting for 'myuseraccount' to confirm the request

        It keeps giving this, even after signing in and out.

  7. Feb 06, 2007

    David Malmquist says:

    I would like to see a flag in this plugin that lets you modify the click command...

    I would like to see a flag in this plugin that lets you modify the click command, most useful for skype, instead of call go to chat. Thanks

    {im:username|service=service|clickcommand=chat}

  8. Mar 01, 2007

    Nicolas Bertrand says:

    I am experiencing some problems with this macro. I am getting the following exc...

    I am experiencing some problems with this macro.

    I am getting the following exception error:

     
Error formatting macro: im: java.lang.NullPointerException


     {im:dummybuddy@googlemail.com|service=GTALK}

    we are on confluence v.2.3.3 and plugin version 2.0-rc3.

    Thanks for your help

    1. Mar 14, 2007

      François Nonnenmacher says:

      Same here, same versions, but for MSN. And this error appeared only after I adde...

      Same here, same versions, but for MSN. And this error appeared only after I added the configured dummy account to my personal MSN contact list (before that the macro would display fine, with a gray dot).

  9. Jul 04, 2007

    thomas menzel says:

    Hi i have a featurerequest and post it here since i dont know where else to put ...

    Hi i have a featurerequest and post it here since i dont know where else to put it:

    skype supports also other actions except call which is the default operation as it seems. maybe other IMs do that too!?

    hence i'd like to suggest to extend the macro like so:

    {im:[my username]|service=[my service]|action=[IM action]|alias=[display text]}

    Details: Inserts a presence icon and IM link.
    Parameters:

    Name Required Description
    (default) The id/screen name of the user.
    service The name of the service. Supported services are: aim, gtalk, icq, msn, sametime, skype, wildfire and yahoo.
    showid If set to 'false', the ID/screen name will not be displayed. Defaults to true.
    Note: The ID is still shown as part of the link on mouseover-event in the statusbar of the browser.
    action A IM specific action. If not given then the default action is used. Default actions are service specific.
    alias Instead of displaying the user id of the IM this shows the given text. Works like the normal link alias.

    For skype this would change the link to this pattern:

     skype:<userid>?<action>

  10. Oct 03, 2007

    David Hennessy says:

    Hi David &nbsp;I am looking to integrate 12 Planet IM