Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ratify Message IDs #377

Merged
merged 4 commits into from May 15, 2019
Merged

Ratify Message IDs #377

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5546819
Ratify Message IDs
DanielOaks Apr 9, 2019
c891df4
Some suggestions that seem reasonable
DanielOaks May 9, 2019
6aefadc
Compromise text
DanielOaks May 14, 2019
0a64281
Review fix
DanielOaks May 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 14 additions & 24 deletions extensions/message-ids.md
View file
Open in desktop
@@ -1,25 +1,13 @@
---
title: IRCv3 Message IDs
layout: spec
work-in-progress: true
copyrights:
-
name: "James Wheare"
period: 2016
email: "james@irccloud.com"
---

## Notes for implementing work-in-progress version

This is a work-in-progress specification.

Software implementing this work-in-progress specification MUST NOT use the
unprefixed `msgid` tag name. Instead, implementations SHOULD use
the `draft/msgid` tag name to be interoperable with other software
implementing a compatible work-in-progress version.

The final version of the specification will use an unprefixed tag name.

## Introduction

This specification describes a message tag indicating a server supplied unique ID for events.
Expand All @@ -38,17 +26,17 @@ This specification doesn't define any capabilities of its own, but the [`message

### Tags

This specification adds the `draft/msgid` tag, which has a required value.
This specification adds the `msgid` tag, which has a required value.

Servers MAY attach this tag on any event. If this tag is being used, it SHOULD be attached to all `PRIVMSG` and `NOTICE` events.

#### Tag value

The tag value is chosen by the originating server and MUST be unique, meaning any other message transmitted on the entire network at any time MUST NOT share the same value.
The tag value MUST be a unique ID chosen by the originating server. Uniqueness in this context means that any other message transmitted on the entire network at any time MUST NOT share the same value.

However, if a message is re-transmitted as-is, for example with the [`chathistory`](./batch/chathistory-3.3.html) batch type, the ID SHOULD be reused. As a result, clients MUST accept shared IDs.

The tag value MUST be treated as a case sensitive opaque identifier. Clients MUST NOT use case folding or normalization when comparing IDs.
Clients MUST treat the ID as a case sensitive opaque identifier. Clients MUST NOT use case folding or normalization when comparing IDs.

### Relationships with other specifications

Expand All @@ -75,6 +63,8 @@ Networks might also consider the risk of collisions when there's a chance of mer

Although clients are required to treat IDs as case sensitive opaque values, servers might still choose a case insensitive ID format internally.

Servers might wish to encode additional information within the ID, for internal use only. For instance, including account information for the author in an ID could enable authenticated message edits or deletes, without having to maintain and consult a separate message store. This requires careful attention to several concerns: security, privacy, and backwards and forwards compatibility of different ID generation schemes.

## Client implementation considerations

This section is non-normative.
Expand All @@ -91,40 +81,40 @@ This section is non-normative, message IDs are not required to be UUIDs or have

A channel `PRIVMSG` sent by the server:

S: @draft/msgid=63E1033A051D4B41B1AB1FA3CF4B243E :nick!user@host PRIVMSG #channel :Hello!
S: @msgid=63E1033A051D4B41B1AB1FA3CF4B243E :nick!user@host PRIVMSG #channel :Hello!

A private `PRIVMSG` sent by the server:

S: @draft/msgid=server1-1480339715754191-21 :nick!user@host PRIVMSG me :Hello!
S: @msgid=server1-1480339715754191-21 :nick!user@host PRIVMSG me :Hello!

A channel `NOTICE` sent by the server:

S: @draft/msgid=G6PuDDBWQYmu3HmXXOAPzA :nick!user@host NOTICE #channel :Hello!
S: @msgid=G6PuDDBWQYmu3HmXXOAPzA :nick!user@host NOTICE #channel :Hello!

A private `NOTICE` sent by the server:

S: @draft/msgid=ticketid-5 :nick!user@host NOTICE me :Hello!
S: @msgid=ticketid-5 :nick!user@host NOTICE me :Hello!

A channel `JOIN` sent by the server:

S: @draft/msgid=msgid123 :nick!user@host JOIN #channel account :Real Name
S: @msgid=msgid123 :nick!user@host JOIN #channel account :Real Name

A channel `PRIVMSG` sent by the server, and a possible client response. The `+example/reply` tag is a non-standard example:

S: @draft/msgid=msgid1 :nick!user@host PRIVMSG #channel :Hello!
S: @msgid=msgid1 :nick!user@host PRIVMSG #channel :Hello!
C: @+example/reply=msgid1 :nick2!user2@host2 PRIVMSG #channel :Hello to you!

Two channel `PRIVMSG` messages sent by the server, with possible non-standard example annotations to indicate split message concatenation:

S: @draft/msgid=msgid1;example/split :nick!user@host PRIVMSG #channel :Hello
S: @draft/msgid=msgid2;example/concat=msgid1 :nick!user@host PRIVMSG #channel : World
S: @msgid=msgid1;example/split :nick!user@host PRIVMSG #channel :Hello
S: @msgid=msgid2;example/concat=msgid1 :nick!user@host PRIVMSG #channel : World

A client negotiating the `message-tags` capability to enable and disable messages tagged with IDs.

S: :nick!user@host PRIVMSG #channel :Hello
C: CAP REQ message-tags
S: :irc.example.com CAP me ACK :message-tags
S: @draft/msgid=msgid-a :nick!user@host PRIVMSG #channel :Hello again
S: @msgid=msgid-a :nick!user@host PRIVMSG #channel :Hello again
C: CAP REQ -message-tags
S: :irc.example.com CAP me ACK :-message-tags
S: :nick!user@host PRIVMSG #channel :Another hello