XEP-0107: User Mood

This document defines an XMPP protocol extension for communicating information about user moods.

NOTICE: The protocol defined herein is a Draft Standard of the XMPP Standards Foundation. Implementations are encouraged and the protocol is appropriate for deployment in production systems, but some changes to the protocol are possible before it becomes a Final Standard.

Document Information

Series: XEP
Number: 0107
Publisher: XMPP Standards Foundation
Status: Draft
Type: Standards Track
Version: 1.0
Last Updated: 2004-10-20
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-0060
Supersedes: None
Superseded By: None
Short Name: mood
Schema: <http://www.xmpp.org/schemas/mood.xsd>
Wiki Page: <http://wiki.jabber.org/index.php/User Mood (XEP-0107)>

Author Information

Peter Saint-Andre

Email: stpeter@jabber.org
JabberID: stpeter@jabber.org

Ralph Meijer

Email: ralphm@ik.nu
JabberID: ralphm@ik.nu

Legal Notice

This XMPP Extension Protocol is copyright 1999 - 2007 by the XMPP Standards Foundation (XSF) and is in full conformance with the XSF's Intellectual Property Rights Policy <http://www.xmpp.org/extensions/ipr-policy.shtml>. This material may be distributed only subject to the terms and conditions set forth in the Creative Commons Attribution License (<http://creativecommons.org/licenses/by/2.5/>).

Discussion Venue

The preferred venue for discussion of this document is the Standards discussion list: <http://mail.jabber.org/mailman/listinfo/standards>.

Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Conformance Terms

The following keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Table of Contents


1. Introduction
2. Protocol
    2.1. Data Format
    2.2. Pubsub Transport
    2.3. Message Transport
3. Mood Values
4. Mapping to Wireless Village Moods
5. Internationalization Considerations
6. Security Considerations
7. IANA Considerations
8. XMPP Registrar Considerations
    8.1. Protocol Namespaces
9. XML Schema
Notes
Revision History

1. Introduction

This document defines an extension mechanism for capturing "extended presence" data about user moods.

2. Protocol

2.1 Data Format

Information about user moods is provided by the user and propagated on the network by the user's client. The information is structured via a <mood/> element that is qualified by the 'http://jabber.org/protocol/mood' namespace. The mood itself is provided as the element name of a defined child element of the <mood/> element (e.g., <happy/>); one such child element is REQUIRED. The user MAY also specify a natural-language description of, or reason for, the mood in the <text/> child of the <mood/> element, which is OPTIONAL. Here is an example:

<mood xmlns='http://jabber.org/protocol/mood'>
  <happy/>
  <text>Yay, the mood document has been approved!</text>
</mood>

In addition, an application MAY provide a more specific mood value as a properly-namespaced child of the defined element, which extension MUST be ignored if the receiving application does not understand the extended namespace. Here is an example:

<mood xmlns='http://jabber.org/protocol/mood'>
  <happy>
    <ecstatic xmlns='http://ik.nu/ralphm'/>
  </happy>
  <text>Yay, the mood document has been approved!</text>
</mood>

2.2 Pubsub Transport

The <mood/> element SHOULD be communicated by means of Publish-Subscribe [1] or the subset of publish-subscribe specified in Personal Eventing via Pubsub [2], but MAY be provided in a message as well. Because mood information is not pure presence information and can change independently of the user's availability, it SHOULD NOT be provided as an extension to <presence/>.

If the user wishes to publish his mood to all of those who are subscribed to his mood information, the user SHOULD use publish-subscribe (the following examples show use of the publish-subscribe subset specified in XEP-0163).

Example 1. User Publishes Mood

<iq type='set' 
    from='juliet@capulet.com/balcony' 
    to='pubsub.shakespeare.lit' 
    id='publish1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='http://jabber.org/protocol/mood'>
      <item id='a92lvfmlzsd923k'>
        <mood xmlns='http://jabber.org/protocol/mood'>
          <annoyed/>
          <text>curse my nurse!</text>
        </mood>
      </item>
    </publish>
  </pubsub>
</iq>

The mood is then delivered to all subscribers:

Example 2. Mood is Delivered to All Subscribers

<message 
    from='pubsub.shakespeare.lit' 
    to='romeo@montague.net/orchard'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='http://jabber.org/protocol/mood'>
      <item id='a92lvfmlzsd923k'>
        <mood xmlns='http://jabber.org/protocol/mood'>
          <annoyed/>
          <text>curse my nurse!</text>
        </mood>
      </item>
    </items>
  </event>
</message>
.
.
.

As mentioned in XEP-0060, the stanza containing the event notification or payload MAY also include 'replyto' data (as specified by the Extended Stanza Addressing [3] protocol) to provide an explicit association between the published data and the user:

Example 3. Event notification with extended stanza addressing

<message 
    from='pubsub.shakespeare.lit' 
    to='romeo@montague.net/orchard'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='http://jabber.org/protocol/mood'>
      <item id='a92lvfmlzsd923k'>
        <mood xmlns='http://jabber.org/protocol/mood'>
          <annoyed/>
          <text>curse my nurse!</text>
        </mood>
      </item>
    </items>
  </event>
  <addresses xmlns='http://jabber.org/protocol/address'>
    <address type='replyto' jid='juliet@capulet.com'/>
  </addresses>
</message>

2.3 Message Transport

A user MAY also provide a mood extension in a specific message, in order to lend a defined emotional tone to the message.

Example 4. User Provides Mood in Message

<message from='romeo@montague.net/orchard'
         to='juliet@capulet.com/balcony'
         type='chat'>
  <body>A thousand times good night!</body>
  <mood xmlns='http://jabber.org/protocol/mood'/>
    <sad/>
  </mood>
</message>

The <mood/> element could even contain a URL reference structured according to the Out-of-Band Data [4] protocol:

Example 5. User Provides Mood and URL in Message

<message from='ralphm@ik.nu/work'
         to='stpeter@jabber.org/home'
         type='chat'>
  <body>Cool!</body>
  <mood xmlns='http://jabber.org/protocol/mood'>
    <happy/>
    <text>Yay, the mood document has been published!</text>
    <x xmlns='jabber:x:oob'>
      <url>http://www.xmpp.org/extensions/xep-0107.html</url>
    </x>
  </mood>
</message>

3. Mood Values

There exist various theories of human affect, mood, and emotion, including those promulgated by Frijda [5], Ortony et al. [6], and Wierzbicka [7]. The taxonomy provided here mostly follows the Affective Knowledge Representation that has been defined by Lisetti [8] in an effort to harmonize the prevailing theories in this area. Furthermore, the taxonomy provided here includes a number of physical states in addition to moods, and also takes into account the specific context of instant messaging, including work done by other standards development organizations (e.g., the Wireless Village specifications contributed to the Open Mobile Alliance (OMA) [9]) and instant messaging service providers (e.g., ICQ).

The mood values defined in this taxonomy are as follows:

4. Mapping to Wireless Village Moods

The Wireless Village (now "IMPS") specifications for mobile instant messaging define a number of presence attributes, encapsulated in the "StatusMood" information element [10]. The following values are defined for StatusMood in Wireless Village, all of which map one-to-one from Wireless Village to the same values (albeit lowercase) in Jabber:

The full range of moods defined herein is richer than that defined in Wireless Village; no mapping is provided by this specification for mood values that are not present in Wireless Village, and any such mapping is the responsibility of a gateway between the two systems.

5. Internationalization Considerations

The XML character data values of the <value/> elements is not intended to be presented to a human user and thus there is no special reason to include an 'xml:lang' attribute unless the sender includes a <text/> element as well (as explained in RFC 2277 [11], "internationalization is for humans"). It is the responsibility of the receiving application to provide localized text strings associated with the XML character data values defined herein, or some other appropriate presentation (e.g., graphical images that represent the mood).

6. Security Considerations

Because user moods may be published to a large number of pubsub subscribers, users should take care in approving subscribers and in characterizing their current moods.

7. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [12].

8. XMPP Registrar Considerations

8.1 Protocol Namespaces

The XMPP Registrar [13] includes 'http://jabber.org/protocol/mood' in its registry of protocol namespaces.

9. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/mood'
    xmlns='http://jabber.org/protocol/mood'
    elementFormDefault='qualified'>

  <xs:element name='mood'>
    <xs:complexType>
      <xs:sequence>
	<xs:choice>
          <xs:element name='afraid' type='empty'/>
          <xs:element name='amazed' type='empty'/>
          <xs:element name='angry' type='empty'/>
          <xs:element name='annoyed' type='empty'/>
          <xs:element name='anxious' type='empty'/>
          <xs:element name='aroused' type='empty'/>
          <xs:element name='ashamed' type='empty'/>
          <xs:element name='bored' type='empty'/>
          <xs:element name='brave' type='empty'/>
          <xs:element name='calm' type='empty'/>
          <xs:element name='cold' type='empty'/>
          <xs:element name='confused' type='empty'/>
          <xs:element name='contented' type='empty'/>
          <xs:element name='cranky' type='empty'/>
          <xs:element name='curious' type='empty'/>
          <xs:element name='depressed' type='empty'/>
          <xs:element name='disappointed' type='empty'/>
          <xs:element name='disgusted' type='empty'/>
          <xs:element name='distracted' type='empty'/>
          <xs:element name='embarrassed' type='empty'/>
          <xs:element name='excited' type='empty'/>
          <xs:element name='flirtatious' type='empty'/>
          <xs:element name='frustrated' type='empty'/>
          <xs:element name='grumpy' type='empty'/>
          <xs:element name='guilty' type='empty'/>
          <xs:element name='happy' type='empty'/>
          <xs:element name='hot' type='empty'/>
          <xs:element name='humbled' type='empty'/>
          <xs:element name='humiliated' type='empty'/>
          <xs:element name='hungry' type='empty'/>
          <xs:element name='hurt' type='empty'/>
          <xs:element name='impressed' type='empty'/>
          <xs:element name='in_awe' type='empty'/>
          <xs:element name='in_love' type='empty'/>
          <xs:element name='indignant' type='empty'/>
          <xs:element name='interested' type='empty'/>
          <xs:element name='intoxicated' type='empty'/>
          <xs:element name='invincible' type='empty'/>
          <xs:element name='jealous' type='empty'/>
          <xs:element name='lonely' type='empty'/>
          <xs:element name='mean' type='empty'/>
          <xs:element name='moody' type='empty'/>
          <xs:element name='nervous' type='empty'/>
          <xs:element name='neutral' type='empty'/>
          <xs:element name='offended' type='empty'/>
          <xs:element name='playful' type='empty'/>
          <xs:element name='proud' type='empty'/>
          <xs:element name='relieved' type='empty'/>
          <xs:element name='remorseful' type='empty'/>
          <xs:element name='restless' type='empty'/>
          <xs:element name='sad' type='empty'/>
          <xs:element name='sarcastic' type='empty'/>
          <xs:element name='serious' type='empty'/>
          <xs:element name='shocked' type='empty'/>
          <xs:element name='shy' type='empty'/>
          <xs:element name='sick' type='empty'/>
          <xs:element name='sleepy' type='empty'/>
          <xs:element name='stressed' type='empty'/>
          <xs:element name='surprised' type='empty'/>
          <xs:element name='thirsty' type='empty'/>
          <xs:element name='worried' type='empty'/>
	</xs:choice>
        <xs:element name='text' minOccurs='0' type='xs:string'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>

Notes

1. XEP-0060: Publish-Subscribe <http://www.xmpp.org/extensions/xep-0060.html>.

2. XEP-0163: Personal Eventing via Pubsub <http://www.xmpp.org/extensions/xep-0163.html>.

3. XEP-0033: Extended Stanza Addressing <http://www.xmpp.org/extensions/xep-0033.html>.

4. XEP-0066: Out of Band Data <http://www.xmpp.org/extensions/xep-0066.html>.

5. Frijda, N. 1986. The Emotions. New York: Cambridge University Press.

6. Ortony, A., Clore, G., and Collins, A. 1988. The Cognitive Structure of Emotions. Hillsdale, NJ: Erlbaum.

7. Wierzbicka, A. 1992. Defining Emotion Concepts. Cognitive Science 16: 539-581.

8. Lisetti, C. 2002. Personality, Affect, and Emotion Taxonomy for Socially Intelligent Agents. In Proceedings of FLAIRS 2002. Menlo Park, CA: AAAI Press.

9. The Open Mobile Alliance is the focal point for the development of mobile service enabler specifications, which support the creation of interoperable end-to-end mobile services. For further information, see <http://www.openmobilealliance.org/>.

10. The Wireless Village Initiative: Presence Attributes v1.1 (WV-029); for further information, visit <http://www.openmobilealliance.org/tech/affiliates/wv/wvindex.html>.

11. RFC 2277: IETF Policy on Character Sets and Languages <http://tools.ietf.org/html/rfc2277>.

12. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

13. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://www.xmpp.org/registrar/>.

Revision History

Version 1.0 (2004-10-20)

Per a vote of the Jabber Council, advanced status to Draft; per Council discussion, also added two additional moods and adjusted structure to use elements rather than XML character data. (psa/rm)

Version 0.6 (2004-09-15)

Added internationalization considerations. (psa)

Version 0.5 (2004-04-25)

Corrected several errors; added reference to XEP-0033. (psa)

Version 0.4 (2004-02-19)

Minor fixes to text and schema. (psa)

Version 0.3 (2003-08-01)

Added more moods. (psa)

Version 0.2 (2003-07-23)

Expanded the information format; changed primary container to use pubsub. (psa)

Version 0.1 (2003-07-22)

Initial version. (psa)

END