<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
<header>
  <title>User Browsing</title>
  <abstract>This document defines an XMPP protocol extension for communicating information about the web pages a user visits.</abstract>
  
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<permissions>Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.</permissions>
<warranty>## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##</warranty>
<liability>In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.</liability>
<conformance>This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
  <number>0195</number>
  <status>Deferred</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0060</spec>
    <spec>XEP-0163</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  
  <author>
    <firstname>Peter</firstname>
    <surname>Saint-Andre</surname>
    <email>stpeter@stpeter.im</email>
    <jid>stpeter@jabber.org</jid>
    <uri>https://stpeter.im/</uri>
  </author>

  <revision>
    <version>0.3</version>
    <date>2008-09-25</date>
    <initials>psa</initials>
    <remark><p>Modified namespace in accordance with protocol versioning policies.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2007-10-03</date>
    <initials>psa</initials>
    <remark><p>Updated in accordance with XEP-0163.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2006-08-30</date>
    <initials>psa</initials>
    <remark><p>Initial version.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2006-08-28</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic="Introduction" anchor="intro">
  <p><span class="ref"><link url="https://xmpp.org/extensions/xep-0060.html">Publish-Subscribe (XEP-0060)</link></span> <note>XEP-0060: Publish-Subscribe &lt;<link url="https://xmpp.org/extensions/xep-0060.html">https://xmpp.org/extensions/xep-0060.html</link>&gt;.</note> and <span class="ref"><link url="https://xmpp.org/extensions/xep-0163.html">Personal Eventing Protocol (XEP-0163)</link></span> <note>XEP-0163: Personal Eventing Protocol &lt;<link url="https://xmpp.org/extensions/xep-0163.html">https://xmpp.org/extensions/xep-0163.html</link>&gt;.</note> can be used to publish a wide variety of "extended presence" information about users. This document specifies an extended presence payload format that communicates information about the web pages a user visits. This information may be of interest to a user's contacts and can also be used in social networking applications (e.g., co-browsing and web swarms).</p>
</section1>
<section1 topic="Protocol" anchor="protocol">
  <section2 topic="Container Element and Child Elements" anchor="protocol-elements">
    <p>Information about web pages is provided by the user (or automated integration with browsers or other systems) and is propagated on the network by the user's client. The information container for web page data is a &lt;page/&gt; element that is qualified by the 'urn:xmpp:browsing:0' namespace (see <link url="#ns">Protocol Namespaces</link> regarding issuance of one or more permanent namespaces). The web page information itself is provided as the XML character data of the following children of the &lt;page/&gt; element:</p>
    <table caption="Child Elements">
      <tr>
        <th>Element</th>
        <th>Description</th>
        <th>Example</th>
        <th>Datatype</th>
        <th>Inclusion</th>
      </tr>
      <tr>
        <td>description</td>
        <td>The value of the "description" META tag</td>
        <td>The weblog of Peter Saint-Andre</td>
        <td>xs:string</td>
        <td>OPTIONAL</td>
      </tr>
      <tr>
        <td>keywords</td>
        <td>The value of the "keywords" META tag</td>
        <td>stpeter, Peter Saint-Andre, weblog, jabber, xmpp</td>
        <td>xs:string</td>
        <td>OPTIONAL</td>
      </tr>
      <tr>
        <td>title</td>
        <td>The value of the &lt;title/&gt; element</td>
        <td>one small voice</td>
        <td>xs:string</td>
        <td>OPTIONAL</td>
      </tr>
      <tr>
        <td>uri</td>
        <td>The URI of the page (usually but not necessarily an HTTP URL)</td>
        <td>https://stpeter.im/</td>
        <td>xs:anyURI</td>
        <td>REQUIRED</td>
      </tr>
    </table>
    <p>NOTE: The datatypes specified above are defined in <span class="ref"><link url="http://www.w3.org/TR/xmlschema11-2/">XML Schema Part 2</link></span> <note>XML Schema Part 2: Datatypes &lt;<link url="http://www.w3.org/TR/xmlschema11-2/">http://www.w3.org/TR/xmlschema11-2/</link>&gt;.</note>.</p>
  </section2>
  <section2 topic="Transport Mechanism" anchor="protocol-transport">
    <p>When a user visits a web page, its client may publish that fact to a PEP node whose NodeID is "urn:xmpp:browsing:0" (see <link url="#ns">Protocol Namespaces</link> regarding issuance of one or more permanent namespaces) or to a generic pubsub node. Because browsing information is not pure presence information and can change independently of the user's availability, it SHOULD NOT be provided as an extension to the &lt;presence/&gt; stanza type.</p>
    <example caption="User Publishes Browsing Information"><![CDATA[
<iq type='set' from='stpeter@jabber.org/work' id='browsing1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:browsing:0'>
      <item id='da6abe63d1e5ed45a6de466732abff72e6fccb93'>
        <page xmlns='urn:xmpp:browsing:0'>
          <uri>https://stpeter.im/</uri>
        </page>
      </item>
    </publish>
  </pubsub>
</iq>
]]></example>
    <p>The browsing information is then delivered to all subscribers:</p>
    <example caption="Browsing Information is Delivered to All Subscribers"><![CDATA[
<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:browsing:0'>
      <item id='da6abe63d1e5ed45a6de466732abff72e6fccb93'>
        <page xmlns='urn:xmpp:browsing:0'>
          <uri>https://stpeter.im/</uri>
        </page>
      </item>
    </items>
  </event>
</message>
]]></example>
    <p>When the user stops browsing the page (e.g., by closing the browser window or tab), the user's client SHOULD send an empty &lt;page/&gt; element with the same ItemID:</p>
    <example caption="User Publishes Stop Information"><![CDATA[
<iq type='set' from='stpeter@jabber.org/work' id='browsing2'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:browsing:0'>
      <item id='da6abe63d1e5ed45a6de466732abff72e6fccb93'>
        <page xmlns='urn:xmpp:browsing:0'/>
      </item>
    </publish>
  </pubsub>
</iq>
]]></example>
    <example caption="Stop Information is Delivered to All Subscribers"><![CDATA[
<message from='stpeter@jabber.org' to='maineboy@jabber.org'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:browsing:0'>
      <item id='da6abe63d1e5ed45a6de466732abff72e6fccb93'>
        <page xmlns='urn:xmpp:browsing:0'/>
      </item>
    </items>
  </event>
</message>
]]></example>
  </section2>
</section1>
<section1 topic="Security Considerations" anchor="security">
  <p>The web pages that a user visits may be sensitive. A client MUST provide a way for a user to configure which pages or types of pages will not be published (e.g., via user preferences).</p>
</section1>
<section1 topic="IANA Considerations" anchor="iana">
  <p>This document requires no interaction with the <span class="ref"><link url="http://www.iana.org/">Internet Assigned Numbers Authority (IANA)</link></span> <note>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 &lt;<link url="http://www.iana.org/">http://www.iana.org/</link>&gt;.</note>.</p>
</section1>
<section1 topic="XMPP Registrar Considerations" anchor="registrar">
  <section2 topic="Protocol Namespaces" anchor="registrar-ns">
    <p>This specification defines the following XML namespace:</p>
    <ul>
      <li>urn:xmpp:browsing:0</li>
    </ul>
    <p>Upon advancement of this specification from a status of Experimental to a status of Draft, the <span class="ref"><link url="https://xmpp.org/registrar/">XMPP Registrar</link></span> <note>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 &lt;<link url="https://xmpp.org/registrar/">https://xmpp.org/registrar/</link>&gt;.</note> shall add the foregoing namespace to the registry located at &lt;<link url="https://xmpp.org/registrar/namespaces.html">https://xmpp.org/registrar/namespaces.html</link>&gt;, as described in Section 4 of <span class="ref"><link url="https://xmpp.org/extensions/xep-0053.html">XMPP Registrar Function (XEP-0053)</link></span> <note>XEP-0053: XMPP Registrar Function &lt;<link url="https://xmpp.org/extensions/xep-0053.html">https://xmpp.org/extensions/xep-0053.html</link>&gt;.</note>.</p>
  </section2>
  <section2 topic="Namespace Versioning" anchor="registrar-versioning">
    <p>If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of <cite>XEP-0053</cite>.</p>
  </section2>
</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='urn:xmpp:browsing:0'
    xmlns='urn:xmpp:browsing:0'
    elementFormDefault='qualified'>

  <xs:element name='page'>
    <xs:complexType>
      <xs:sequence minOccurs='0'>
        <xs:element name='description' type='xs:string' minOccurs='0'/>
        <xs:element name='keywords' type='xs:string' minOccurs='0'/>
        <xs:element name='title' type='xs:string' minOccurs='0'/>
        <xs:element name='uri' type='xs:anyURI'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>
]]></code>
</section1>
</xep>
