Merge 2d06cc128b into 252de984cc

* Spec for MSC4230: Flag for animated images

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add x-addedInMatrixVersion property

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

changelogs/client_server/newsfragments/2315.feature

@@ -0,0 +1 @@
+Add `M_USER_LIMIT_EXCEEDED` common error code, as per [MSC4335](https://github.com/matrix-org/matrix-spec-proposals/pull/4335).

changelogs/client_server/newsfragments/2328.feature

@@ -0,0 +1 @@
+Add the `is_animated` flag to the `info` object of the `m.image` msgtype and the `m.sticker` event, as per [MSC4230](https://github.com/matrix-org/matrix-spec-proposals/pull/423O).

changelogs/client_server/newsfragments/2329.clarification

@@ -0,0 +1 @@
+Add link to JSON signing algorithm in server-server auth section for clarity. Contributed by @thetayloredman.

content/client-server-api/_index.md

@@ -147,6 +147,37 @@ state (e.g.: sending messages, account data, etc) and not routes which
 only read state (e.g.: [`/sync`](#get_matrixclientv3sync),
 [`/user/{userId}/account_data/{type}`](#get_matrixclientv3useruseridaccount_datatype), etc).
 
+`M_USER_LIMIT_EXCEEDED`
+: {{% added-in v="1.18" %}} The request cannot be completed because the user has
+exceeded (or the request would cause them to exceed) a limit associated with
+their account. For example, a user may have reached their allocated storage
+quota, reached a maximum number of allowed rooms, devices, or other
+account-scoped resources, or exceeded usage limits for specific features.
+
+: The error response MUST have an `info_uri` field (string), which is a URI
+that the client can present to the user to provide more context on the
+encountered limit and, if applicable, guidance on how to increase the limit.
+The homeserver MAY return different values for `info_uri` depending on the type
+of limit reached.
+
+: The error response MAY include a `can_upgrade` field (boolean, default `false`).
+If `true`, it indicates that the specific limit encountered can be increased,
+for example by upgrading the user's account tier. If absent or `false`, the
+limit is a hard limit that cannot be increased.
+
+: The HTTP status code will depend on depend on the particular endpoint.
+
+: Example response:
+
+  ```json
+  {
+    "errcode": "M_USER_LIMIT_EXCEEDED",
+    "error": "You have exceeded your storage quota of 10GB",
+    "info_uri": "https://example.com/homeserver/about?limit_type=quota",
+    "can_upgrade": true
+  }
+  ```
+
 `M_UNKNOWN`
 : An unknown error has occurred.
 

content/server-server-api.md

@@ -277,12 +277,12 @@ queried from multiple servers to mitigate against DNS spoofing.
 
 Every HTTP request made by a homeserver is authenticated using public
 key digital signatures. The request method, target and body are signed
-by wrapping them in a JSON object and signing it using the JSON signing
-algorithm. The resulting signatures are added as an Authorization header
-with an auth scheme of `X-Matrix`. Note that the target field should
-include the full path starting with `/_matrix/...`, including the `?`
-and any query parameters if present, but should not include the leading
-`https:`, nor the destination server's hostname.
+by wrapping them in a JSON object and signing it using the [JSON signing
+algorithm](/appendices#signing-json). The resulting signatures are added
+as an Authorization header with an auth scheme of `X-Matrix`. Note that
+the target field should include the full path starting with `/_matrix/...`,
+including the `?` and any query parameters if present, but should not
+include the leading `https:`, nor the destination server's hostname.
 
 Step 1 sign JSON:
 

data/event-schemas/examples/m.room.message$m.image.yaml

@@ -7,7 +7,8 @@
         "h": 398,
         "w": 394,
         "mimetype": "image/jpeg",
-        "size": 31037
+        "size": 31037,
+        "is_animated": false
     },
     "url": "mxc://example.org/JWEIFJgwEIhweiWJE",
     "msgtype": "m.image"

data/event-schemas/examples/m.sticker.yaml

@@ -9,7 +9,8 @@
         "mimetype": "image/png",
         "h": 200,
         "w": 140,
-        "size": 73602
+        "size": 73602,
+        "is_animated": true
       },
       "h": 200,
       "thumbnail_url": "mxc://matrix.org/sHhqkFCvSkFwtmvtETOtKnLP",

data/event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml

@@ -34,5 +34,19 @@ properties:
     allOf:
       - $ref: thumbnail_info.yaml
     description: Metadata about the image referred to in `thumbnail_url`.
+  is_animated:
+    x-addedInMatrixVersion: "1.18"
+    description: |-
+      If this flag is `true`, the original image SHOULD be assumed to be
+      animated. If this flag is `false`, the original image SHOULD be assumed to
+      NOT be animated.
+
+      If a sending client is unable to determine whether an image is animated,
+      it SHOULD leave the flag unset.
+
+      Receiving clients MAY use this flag to optimize whether to download the
+      original image rather than a thumbnail if it is animated, but they SHOULD
+      NOT trust this flag.
+    type: boolean
 title: ImageInfo
 type: object