XEP-0501: Pubsub Stories

Abstract
This specification defines a way of publishing Stories over XMPP.
Author
Timothée Jaussoin
Copyright
© 2024 – 2024 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

Experimental

WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.
Type
Standards Track
Version
0.2.0 (2024-12-20)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Glossary

Story
An item stored in a Stories Pubsub node.

2. Introduction

Introduced by Snapchat in 2012 Stories are a way for users to share content that can be viewed for a specific amount of time in chronological order.

PubSub Social Feed (XEP-0472) [1] already defines a generic way of publishing social content on XMPP. This extension defines a way to publish Stories content on a user Personal Eventing Protocol (XEP-0163) [2] node.

This extension extends PubSub Social Feed (XEP-0472) [1] by defining a new Profile (see Profiles) called Pubsub Stories.

3. Discovery

If an entity implements Pubsub Stories, it MUST specify the 'urn:xmpp:pubsub-social-feed:1' and 'urn:xmpp:pubsub-social-feed:stories:0' features in its service discovery information features as specified in Service Discovery (XEP-0030) [3] and the Entity Capabilities profile specified in Entity Capabilities (XEP-0115) [4].

If an entity wish to receive notifications from a contact when a Story is published it should also declares it in its service discovery followed by "+notify"

Example 1. The entity responds with Stories feature
  <iq type='result'
      id='disco1'
      from='juliet@capulet.lit/sabo239'
      to='romeo@montegue.lit/30d3d8'>
    <query xmlns='http://jabber.org/protocol/disco#info'>
      ...
      <feature var='urn:xmpp:pubsub-social-feed:1'/>
      <feature var='urn:xmpp:pubsub-social-feed:stories:0'/>
      <feature var='urn:xmpp:pubsub-social-feed:stories:0+notify'/>
      ...
    </query>
  </iq>

4. Protocol

4.1 Pubsub Stories profile

This profile is defined by the Pubsub type "urn:xmpp:pubsub-social-feed:stories:0" and is hosted on a "urn:xmpp:pubsub-social-feed:stories:0" Personal Eventing Protocol (XEP-0163) [2] node.

All the items published in a Pubsub Stories node MUST have only one attached media. This media MUST be of type "enclosure" as specified in RFC 4287 [5].

Example 2. An Atom attached picture
<link rel='enclosure' href='https://capulet.lit/upload/romeo-story.jpg' type='image/jpeg' title='Stories 03-02-1597'/>

4.1.1 Pubsub Node Configuration

Stories node MUST base their default configuration on the Base Profile and:

  1. The "pubsub#type" MUST be set to "urn:xmpp:pubsub-social-feed:stories:0"
  2. The "pubsub#access_model" SHOULD be set to "presence".
  3. The "pubsub#item_expire" SHOULD be set, usually 24 hours (86400).

5. Business Rules

If the "pubsub#item_expire" value is set subscribers clients MUST hide or destroy the received items once they expire.

If the "pubsub#item_expire" value is not set publishers clients SHOULD retract the items after a specific amount of time, usually 24 hours.

6. Security Considerations

There are no security features or concerns related to this proposal.

7. IANA Considerations

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

8. XMPP Registrar Considerations

The XMPP Registrar [7] is requested to issue an initial namespace of "urn:xmpp:pubsub-social-feed:stories:0".

9. XML Schema

This specification re-uses the schema for the Atom content format, i.e., the 'http://www.w3.org/2005/Atom' namespace (see RFC 4287 [5] ).

Appendices

Appendix A: Document Information

Series
XEP
Number
0501
Publisher
XMPP Standards Foundation
Status
Experimental
Type
Standards Track
Version
0.2.0
Last Updated
2024-12-20
Approving Body
XMPP Council
Dependencies
XMPP Core, XMPP IM, XEP-0060, XEP-0163, XEP-0472, RFC 4287
Supersedes
None
Superseded By
None
Short Name
ps
Source Control
HTML

This document in other formats: XML  PDF

Appendix B: Author Information

Timothée Jaussoin
Email
edhelas@movim.eu
JabberID
edhelas@movim.eu
URI
https://edhelas.movim.eu

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

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.

Disclaimer of 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. ##

Limitation of 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.

IPR 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 <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) 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.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Given that this XMPP Extension Protocol normatively references IETF technologies, discussion on the <xsf-ietf@xmpp.org> list might also be appropriate.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements 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".

Appendix G: Notes

1. XEP-0472: PubSub Social Feed <https://xmpp.org/extensions/xep-0472.html>.

2. XEP-0163: Personal Eventing Protocol <https://xmpp.org/extensions/xep-0163.html>.

3. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

4. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.

5. RFC 4287: The Atom Syndication Format <http://tools.ietf.org/html/rfc4287>.

6. 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/>.

7. 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 <https://xmpp.org/registrar/>.

Appendix H: Revision History

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

  1. Version 0.2.0 (2024-12-20)

    Add pubsub#item_expire in the node configuration

    tj
  2. Version 0.1.0 (2024-12-19)

    Promoted to Experimental

    XEP Editor: dg
  3. Version 0.0.1 (2024-12-03)
    Initial version.
    tj

Appendix I: Bib(La)TeX Entry

@report{jaussoin2024ps,
  title = {Pubsub Stories},
  author = {Jaussoin, Timothée},
  type = {XEP},
  number = {0501},
  version = {0.2.0},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-0501.html},
  date = {2024-12-03/2024-12-20},
}

END