xeps/xep-0329.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>File Information Sharing</title>
  <abstract>This document specifies a simple extension to existing protocols that allows an entity to request information about files.</abstract>
  &LEGALNOTICE;
  <number>0329</number>
  <status>Experimental</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0234</spec>
    <spec>XEP-0059</spec>
    <spec>XEP-0265</spec>
  </dependencies>
  <supersedes>
    <spec>XEP-0135</spec>
  </supersedes>
  <shortname>fis</shortname>
  <author>
      <firstname>Jefry</firstname>
      <surname>Lagrange</surname>
      <email>jefry.reyes@gmail.com</email>
      <jid>j.lagrange@jabber.org</jid>
      <jid>j.lagrange@gajim.org</jid>
  </author>
  &lance;
  <revision>
    <version>0.2</version>
    <date>2013-11-19</date>
    <initials>jl</initials>
    <remark><p>Corrected namespace to use XSF format.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2013-06-11</date>
    <initials>psa</initials>
    <remark><p>Initial published version approved by the XMPP Council.</p></remark>
  </revision>
  <revision>
    <version>0.0.4</version>
    <date>2013-01-26</date>
    <initials>jl</initials>
    <remark>Third draft</remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>XMPP extensions provide ways of transferring files between peers (such as &xep0234; and &xep0096;). However, file transfer is currently limited to needing that the transfer be initiated by the hosting entity. The &xep0234; extension, provides for a way to request files, but it requires the requesting entity to have information about the file being requested, so that it can be uniquely identified. </p>
<p>This document defines an extension which allows the request of information of files being offered by a hosting entity so they can later be requested in a file transfer; If the requesting entity is interested in the file.</p>
<p>&xep0135; is a previous extention that attempted to solve the same problem as this one, but unfortunetly it didn't generate much interest and it got deprecated. This extention aims be a modern replacement for XEP-0135.</p>
<p>IRC users have been able to bypass the limitations of the protocol by using bots that provide information of files and initiate transfer on command. A major downside of this method is that not every user is capable of sharing its files. The aim of this document is to provide a similar functionality while making it easier for users to offer and request information about files. </p>
<p>Microsoft's MSN proprietary IM client, used to provide similar functionality using "Sharing Folders", but this was replaced by Windows Live SkyDrive </p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
  <ol>
    <li>Enable a requesting entity to traverse the shared directory of an offering entity (REQUIRED)</li>
    <li>Enable a requesting entity to get detailed information about files. (REQUIRED)</li>
  </ol>
</section1>
<section1 topic='Assumptions' anchor='assump'>
<!-- Maybe make this into a list -->
    <p> This protocol assumes the existence of one or more shared directories (either virtual or physical). The hosting entity must not advertise empty directories. The hosting entity is responsible of maintaining the structure of those directories (such as not allowing two files with the same name and preventing cycles within directories). The hosting entity is in no way required to present the same shared directories to different requesters. In fact, the reason multiple share directories are allowed, is to make it easier for implementers to manage permissions of who can see what files.</p>
</section1>
<section1 topic='Getting Information About Files ' anchor='disco'>
  <section2 topic='Traversing Files' anchor='traver'>
      <p>If a requesting entity wishes to know what files are being shared by an offering entity, it can do so by sending the following query:</p>
      <example caption='Requester queries the root of the shared folder'>
<![CDATA[
<iq type='get'
    from='juliet@capulet.com/chamber'
    to='romeo@montague.net/home'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" />
</iq>
]]>
      </example>
      <p> If the offering entity wishes to share files with the requesting entity, it may respond with a list of shared folders. It MUST not include any files in this response.</p>
      <example caption='The offering entity responds with shared directories'>
<![CDATA[
<iq type='result'
    from='romeo@montague.net/home'
    to='juliet@capulet.com/chamber'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0">
        <directory name='documents'/>
        <directory name='pics'/>
        <directory name='audio'/>
    </query>
</iq>
]]>
      </example>
      <p>if the offering entity has no files to offer</p>
      <example caption='The offering entity responds with no files'>
<![CDATA[
<iq type='result'
    from='romeo@montague.net/home'
    to='juliet@capulet.com/chamber'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" />
</iq>
]]>
      </example>
      <p>Requesting the list of files and directories within a directory.</p>
      <example caption='The requesting entity wants to know about a particular directory'>
<![CDATA[
<iq type='get'
    from='juliet@capulet.com/chamber'
    to='romeo@montague.net/home'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" node="documents" />
</iq>
]]>
</example>
      <p>When replying with a list of files, the offering entity can choose to either reply with verbose information on the file using the file attributes defined by &xep0234; or it may reply only with the 'name' attribute, which is required and MUST be included in every response.</p>
      <p>It is RECOMENDED, when the list files to be sent is small, that a verbose response be made (in order to avoid going back and forth requesting information), and that a non-verbose reponse be made otherwise. This recomendation is made to save bandwidth.</p>
      <example caption='The offering entity replies with information about a particular directory'>
<![CDATA[
<iq type='result'
    from='romeo@montague.net/home'
    to='juliet@capulet.com/chamber'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" node="documents">
        <file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
            <name>test.txt</name>
            <date>1969-07-21T02:56:15Z</date>
            <desc>This is a test. If this were a real file...</desc>
            <range/>
            <size>1022</size>
            <hash xmlns='urn:xmpp:hashes:1' algo='sha-1'>552da749930852c69ae5d2141d3766b1</hash>
        </file>
        <file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
            <name>test2.txt</name>
        </file>
        <directory name="secret docs" />
    </query>
</iq>
]]>
</example>
      <p>If the requesting entity wants to get detailed information about a file. It can do so by providing its full path.</p>
      <example caption='The requesting entity wants to know about a particular file'>
<![CDATA[
<iq type='get'
    from='juliet@capulet.com/chamber'
    to='romeo@montague.net/home'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" node="documents/test2.txt" />
</iq>
]]>
</example>
      <example caption='The offering entity responds with more information'>
<![CDATA[
<iq type='result'
    from='romeo@montague.net/home'
    to='juliet@capulet.com/chamber'
    id='1234'>
    <query xmlns="urn:xmpp:fis:0" node="test2.txt">
        <file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
            <name>test2.txt</name>
            <size>1000</size>
        </file>
    </query>
</iq>
]]>
</example>
  </section2>
</section1>
<section1 topic='Bandwidth Considerations' anchor='bandwidth'>
    <p> If a considerable amount of files are being shared by the offering entity, it may be the case that the offering entity response might be too be for the server to handle; As there might be a limitation on the size of the stanzas in the current stream. In order to solve this, extensions have been devised and their implementation are hereby recommended along with the implementation of this extension.</p>
    <section2 topic='Using Result Set Management' anchor='resultset'>
        <p>&xep0059; defines a way of limiting the results of a request. There are some considerations to use result sets along with this extension.</p>
        <p>First, it is defined that the requesting entity is the one that sets the limit of the number of items that can be replied. So it is up to the requesting entity to choose a sensible number.</p>
        <p>Second, since this protocol defines a way of handling the directory tree structure by allowing file tags to be children of a directory tags, it becomes difficult to define items for Result Set Management. Therefore, when responding to a request, the offering entity MUST NOT send directory tags with files as their children.         </p>
    </section2>
    <section2 topic='Out of Band Transfer' anchor='out-of-band'>
        <p>One obvious way to overcome the limitations of sending large stanzas in-band, is to transfer that information out of band. &xep0265; could be used for that purpose. It is hereby RECOMMENDED its implementation when the offering entity has a massive amount of files that would not be practical to advertise in-band.</p>
        <p>It is further recommended that when using XEP-0265, the entire directory structure, along with all the files in the shared folder and subfolders, be exchanged in one single reply. Also, all the files attributes should be included. This is to avoid wasting bandwidth initiating out of band streams going back and forth. </p>
    </section2>
</section1>
<section1 topic='Implementation Notes' anchor='implementation'>
    <section2 topic='File identification' anchor='file_id'>
        <p> As it was previously discussed, when requesting detailed information about a file, only the "name" attribute is required, but it is strongly RECOMMENDED that the hash attribute be included, in order to reduce the chances of sending the wrong file. When requesting the file to be transferred using &xep0234;, the information that must be provided has to identify the file uniquely. It is then RECOMMENDED that when requesting a file, the full path of the file in the shared folder be included in the "name" attribute.</p>
        <example>
<![CDATA[
  <jingle xmlns='urn:xmpp:jingle:1'
          action='session-initiate'
          initiator='juliet@capulet.com/chamber'
          sid='uj3b2'>
    <content creator='initiator' name='a-file-request'>
      <description xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
        <request>
          <file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
                <name>pics/test4.png</name>
                <size>10740</size>
          </file>
        </request>
      </description>
]]>
        </example>
    </section2>
    <section2 topic='File Sharing in MUCs' anchor='fis_muc'>
 <p>For the most part, discovering files in a MUC is exactly the same as what has been described in this document. However, it is RECOMMENDED that a participant in a MUC should have a single shared folder associated with the entire room, as opposed to advertise different files to different participants of the room. This is to reduce the complexity of the client software. Also, due to volatile nature of the participants in a room, keeping track of permissions is more trouble than what it is worth.</p>
    </section2>
</section1>
<section1 topic='Security Considerations' anchor='security'>
    <p>A denial of service is possible by repeatedly requesting files. Implementers are advised to take this into consideration and include queues and limits into their implementations.</p>
</section1>
</xep>