mirror of
https://github.com/moparisthebest/xeps
synced 2024-12-21 15:18:51 -05:00
7bc1d72c10
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1675 4b5297f7-1745-476d-ba37-a9c6900126ab
203 lines
11 KiB
XML
203 lines
11 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
|
<!ENTITY % ents SYSTEM 'xep.ent'>
|
|
%ents;
|
|
]>
|
|
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
|
<xep>
|
|
<header>
|
|
<title>Last Activity</title>
|
|
<abstract>This specification defines an XMPP protocol extension for communicating information about the last activity associated with an XMPP entity. It is typically used by an IM client to retrieve the most recent presence information from an offline contact by sending a last activity request to the server that hosts the account controlled by the contact.</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0012</number>
|
|
<status>Draft</status>
|
|
<type>Standards Track</type>
|
|
<sig>Standards</sig>
|
|
<dependencies>
|
|
<spec>XMPP Core</spec>
|
|
<spec>XMPP IM</spec>
|
|
</dependencies>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>iq-last</shortname>
|
|
<schemaloc>
|
|
<url>http://www.xmpp.org/schemas/iq-last.xsd</url>
|
|
</schemaloc>
|
|
&jer;
|
|
&temas;
|
|
&stpeter;
|
|
<revision>
|
|
<version>1.2</version>
|
|
<date>2007-02-15</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Per a vote of the XMPP Council, changed from Historical and Active to Standards Track and Draft; added Implementation Notes and clarified text throughout; added proviso to security considerations regarding client support; added section on Service Discovery.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.1</version>
|
|
<date>2004-01-22</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Editorial revisions.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.0</version>
|
|
<date>2002-01-22</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Changed status to Active.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.3</version>
|
|
<date>2002-01-14</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Made appropriate changes to reflect status as informational.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2002-01-04</date>
|
|
<initials>tjm</initials>
|
|
<remark><p>Converted to XML format.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2001-01-25</date>
|
|
<initials>jm</initials>
|
|
<remark><p>Initial version from website.</p></remark>
|
|
</revision>
|
|
</header>
|
|
<section1 topic='Introduction' anchor='intro'>
|
|
<p>It is often helpful to know the time of the last activity associated with a entity. The canonical usage is to discover when a disconnected user last accessed the server. The 'jabber:iq:last' namespace provides a method for retrieving that information. The 'jabber:iq:last' namespace can also be used to discover when a connected user was last active on the server (i.e., the user's idle time) or to query servers and components about their current uptime.</p>
|
|
</section1>
|
|
<section1 topic='Protocol' anchor='protocol'>
|
|
<p>In order to request last activity information regarding another entity, the requesting entity shall send an &IQ; stanza of type "get" to the target entity, containing a &QUERY; element qualified by the 'jabber:iq:last' namespace:</p>
|
|
<example caption='Last Activity Query'><![CDATA[
|
|
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com' type='get' id='last1'>
|
|
<query xmlns='jabber:iq:last'/>
|
|
</iq>
|
|
]]></example>
|
|
<p>The target entity MUST return either an IQ-result or an IQ-error. When returning an IQ-result, the target entity sends an &IQ; stanza of type='result' containing a &QUERY; element with a REQUIRED 'seconds' attribute and OPTIONAL XML character data.</p>
|
|
<example caption='Last Activity Response'><![CDATA[
|
|
<iq from='juliet@capulet.com' to='romeo@montague.net/orchard' type='result' id='last1'>
|
|
<query xmlns='jabber:iq:last' seconds='903'/>
|
|
</iq>
|
|
]]></example>
|
|
<p>The requesting entity must interpret the IQ-result based on the responding entity's JID type in order to determine the meaning of the information. Specifically, the information means something different depending on whether the responding entity has a JID of the form 'host', 'user@host', or 'user@host/resource'. These differences are explained more fully below.</p>
|
|
</section1>
|
|
<section1 topic='Offline User Query' anchor='offline'>
|
|
<p>The primary usage of the 'jabber:iq:last' namespace is to find out how long ago a user logged out (and, additionally, what their status message was at that time). This primary usage assumes that the IQ-get is sent to a bare JID &BAREJID;. When used in this way, the &QUERY; element contained in the IQ-result has a 'seconds' attribute, which is the number of seconds that have passed since the user last logged out. In addition, the element MAY contain XML character data that specifies the status message of the last unavailable presence received from the user. An example is shown below:</p>
|
|
<example caption='Last Activity Query'><![CDATA[
|
|
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com' type='get' id='last1'>
|
|
<query xmlns='jabber:iq:last'/>
|
|
</iq>
|
|
|
|
<iq from='juliet@capulet.com' to='romeo@montague.net/orchard' type='result' id='last1'>
|
|
<query xmlns='jabber:iq:last' seconds='903'>Heading Home</query>
|
|
</iq>
|
|
]]></example>
|
|
<p>In this example, the user logged out fifteen minutes and three seconds ago, and when they logged out they sent a presence packet of type='unavailable' whose <status/> element contained the text "Heading Home".</p>
|
|
<p>If the user has at least one available resource when the server receives the request, the response SHOULD contain an empty <query/> element whose 'seconds' attribute is set to a value of '0'.</p>
|
|
<p>Note well that, as specified in &xmppcore; and &xmppim;, an IQ query sent to a JID of the form user@host is handled by a server on the user's behalf, not forwarded to one or more active resources. In addition, a server MUST NOT return last activity information to an entity that is not authorized to view the user's presence information (normally via presence subscription), and MUST return a "Forbidden" error in response to such a request (for information about error conditions, refer to &xep0086;).</p>
|
|
</section1>
|
|
<section1 topic='Online User Query' anchor='online'>
|
|
<p>When the IQ-get is sent to a full JID (&LOCALFULL;), the responding entity MAY respond with the idle time of the user.</p>
|
|
<example caption='Online User Last Query'><![CDATA[
|
|
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' type='get' id='last2'>
|
|
<query xmlns='jabber:iq:last'/>
|
|
</iq>
|
|
|
|
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='result' id='last2'>
|
|
<query xmlns='jabber:iq:last' seconds='123'/>
|
|
</iq>
|
|
]]></example>
|
|
<p>In this example, the user has been idle for about two minutes.</p>
|
|
<p>Support for this functionality is OPTIONAL (a client that does not support the protocol, or that does not wish to divulge this information, SHOULD return a &unavailable; error).</p>
|
|
<example caption='Service Unavailable Error'><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='error' id='last2'>
|
|
<query xmlns='jabber:iq:last'/>
|
|
<error code='503' type='cancel'>
|
|
<service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
|
|
</error>
|
|
</iq>
|
|
]]></example>
|
|
<p>If there is no available resource matching the user@host/resource in the 'to' attribute of the request, the server MUST follow the rules in <strong>XMPP IM</strong> in order to determine what error stanza to return.</p>
|
|
</section1>
|
|
<section1 topic='Server and Component Query' anchor='server'>
|
|
<p>When the IQ-get namespace is sent to a server or component (i.e., to a JID of the form 'host'), the information contained in the IQ reply reflects the uptime of the JID sending the reply. The seconds attribute is how long the host has been up. The &QUERY; element SHOULD NOT contain XML character data.</p>
|
|
<example caption='Server/Component Last Query'><![CDATA[
|
|
<iq from='romeo@montague.net/orchard' to='capulet.com' type='get' id='last3'>
|
|
<query xmlns='jabber:iq:last'/>
|
|
</iq>
|
|
|
|
<iq from='capulet.com' to='romeo@montague.net/orchard' type='result' id='last3'>
|
|
<query xmlns='jabber:iq:last' seconds='123456'/>
|
|
</iq>
|
|
]]></example>
|
|
<p>In this example, the server has been up for a little more than 34 hours.</p>
|
|
</section1>
|
|
<section1 topic='Determining Support' anchor='disco'>
|
|
<p>In order for a requesting entity to determine if a responding entity supports result set management, it SHOULD send a &xep0030; information request to the responding entity:</p>
|
|
<example caption='Requesting entity queries responding entity regarding protocol support'><![CDATA[
|
|
<iq from='stpeter@jabber.org/roundabout'
|
|
to='jabber.org'
|
|
id='disco1'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
|
</iq>
|
|
]]></example>
|
|
<example caption='Responding entity communicates protocol support'><![CDATA[
|
|
<iq from='jabber.org'
|
|
to='stpeter@jabber.org/roundabout'
|
|
id='disco1'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'>
|
|
...
|
|
<feature var='jabber:iq:last'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
</section1>
|
|
<section1 topic='Implementation Notes' anchor='impl'>
|
|
<p>The information contained in an IQ reply for this namespace is inherently ambiguous. Specifically, for a bare JID &LOCALBARE; the information is the time since the JID was last connected to its server; for a full JID &LOCALFULL; the information is the time since the resource was last active in the context of an existing session; and for a bare domain the information is the uptime for the server or component. An application must take these differences into account when presenting the information to a human user.</p>
|
|
</section1>
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<p>A server MUST NOT allow an unauthorized entity to learn a user's network availability by sending a Last Activity request to a JID of the form user@host or user@host/resource; i.e., Last Activity information MAY be divulged only to those entities that have permission to view the user's presence via a presence subscription (potentially as restricted by &xep0016; or &xep0191;).</p>
|
|
<p>A client MUST provide a way for a human user to disable sending of Last Activity responses from the client's full JID &LOCALFULL;.</p>
|
|
</section1>
|
|
<section1 topic='IANA Considerations' anchor='iana'>
|
|
<p>This document requires no interaction with &IANA;.</p>
|
|
</section1>
|
|
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
|
<p>No action on the part of the ®ISTRAR; is necessary as a result of this document, since 'jabber:iq:last' is already a registered protocol namespace.</p>
|
|
</section1>
|
|
<section1 topic='XML Schema' anchor='schema'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='jabber:iq:last'
|
|
xmlns='jabber:iq:last'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:annotation>
|
|
<xs:documentation>
|
|
The protocol documented by this schema is defined in
|
|
XEP-0012: http://www.xmpp.org/extensions/xep-0012.html
|
|
</xs:documentation>
|
|
</xs:annotation>
|
|
|
|
<xs:element name='query'>
|
|
<xs:complexType>
|
|
<xs:simpleContent>
|
|
<xs:extension base='xs:string'>
|
|
<xs:attribute
|
|
name='seconds'
|
|
type='xs:unsignedLong'
|
|
use='optional'/>
|
|
</xs:extension>
|
|
</xs:simpleContent>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section1>
|
|
</xep>
|