-
-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add statusesvisible convenience function * add minID + onlyPublic to account statuses get * move swagger collection stuff to common * start working on Outbox GETting * move functions into federationProcessor * outboxToASCollection * add statusesvisible convenience function * add minID + onlyPublic to account statuses get * move swagger collection stuff to common * start working on Outbox GETting * move functions into federationProcessor * outboxToASCollection * bit more work on outbox paging * wrapNoteInCreate function * test + hook up the processor functions * don't do prev + next links on empty reply * test get outbox through api * don't fail on no status entries * add outbox implementation doc * typo
- Loading branch information
1 parent
26a95ad
commit 4b1d9d3
Showing
38 changed files
with
1,851 additions
and
470 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # ActivityPub Outbox | ||
|
|
||
| GoToSocial implements Outboxes for Actors (ie., instance accounts) following the ActivityPub specification [here](https://www.w3.org/TR/activitypub/#outbox). | ||
|
|
||
| To get an [OrderedCollection](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection) of Activities that an Actor has published recently, remote servers can do a `GET` request to a user's outbox. The address of this will be something like `https://example.org/users/whatever/outbox`. | ||
|
|
||
| The server will return an OrderedCollection of the following structure: | ||
|
|
||
| ```json | ||
| { | ||
| "@context": "https://www.w3.org/ns/activitystreams", | ||
| "id": "https://example.org/users/whatever/outbox", | ||
| "type": "OrderedCollection", | ||
| "first": "https://example.org/users/whatever/outbox?page=true" | ||
| } | ||
| ``` | ||
|
|
||
| Note that the `OrderedCollection` itself contains no items. Callers must dereference the `first` page to start getting items. For example, a `GET` to `https://example.org/users/whatever/outbox?page=true` will produce something like the following: | ||
|
|
||
| ```json | ||
| { | ||
| "id": "https://example.org/users/whatever/outbox?page=true", | ||
| "type": "OrderedCollectionPage", | ||
| "next": "https://example.org/users/whatever/outbox?max_id=01FJC1Q0E3SSQR59TD2M1KP4V8&page=true", | ||
| "prev": "https://example.org/users/whatever/outbox?min_id=01FJC1Q0E3SSQR59TD2M1KP4V8&page=true", | ||
| "partOf": "https://example.org/users/whatever/outbox", | ||
| "orderedItems": [ | ||
| "id": "https://example.org/users/whatever/statuses/01FJC1MKPVX2VMWP2ST93Q90K7/activity", | ||
| "type": "Create", | ||
| "actor": "https://example.org/users/whatever", | ||
| "published": "2021-10-18T20:06:18Z", | ||
| "to": [ | ||
| "https://www.w3.org/ns/activitystreams#Public" | ||
| ], | ||
| "cc": [ | ||
| "https://example.org/users/whatever/followers" | ||
| ], | ||
| "object": "https://example.org/users/whatever/statuses/01FJC1MKPVX2VMWP2ST93Q90K7" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| The `orderedItems` array will contain up to 30 entries. To get more entries beyond that, the caller can use the `next` link provided in the response. | ||
|
|
||
| Note that in the returned `orderedItems`, all activity types will be `Create`. On each activity, the `object` field will be the AP URI of an original public status created by the Actor who owns the Outbox (ie., a `Note` with `https://www.w3.org/ns/activitystreams#Public` in the `to` field, which is not a reply to another status). Callers can use the returned AP URIs to dereference the content of the notes. | ||
|
|
||
| Contrary to the ActivityPub spec, GoToSocial will deny requests that are not HTTP signed--that is, unauthenticated requests. This is consistent with GoToSocial's authentication policies for other federation API endpoints. This is to ensure that GoToSocial can deny requests from domains or users that have been blocked either by the GoToSocial instance itself (domain block), or by the individual owner of the Outbox. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| /* | ||
| GoToSocial | ||
| Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org | ||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU Affero General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU Affero General Public License for more details. | ||
| You should have received a copy of the GNU Affero General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package user | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "strconv" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| // OutboxGETHandler swagger:operation GET /users/{username}/outbox s2sOutboxGet | ||
| // | ||
| // Get the public outbox collection for an actor. | ||
| // | ||
| // Note that the response will be a Collection with a page as `first`, as shown below, if `page` is `false`. | ||
| // | ||
| // If `page` is `true`, then the response will be a single `CollectionPage` without the wrapping `Collection`. | ||
| // | ||
| // HTTP signature is required on the request. | ||
| // | ||
| // --- | ||
| // tags: | ||
| // - s2s/federation | ||
| // | ||
| // produces: | ||
| // - application/activity+json | ||
| // | ||
| // parameters: | ||
| // - name: username | ||
| // type: string | ||
| // description: Username of the account. | ||
| // in: path | ||
| // required: true | ||
| // - name: page | ||
| // type: boolean | ||
| // description: Return response as a CollectionPage. | ||
| // in: query | ||
| // default: false | ||
| // - name: min_id | ||
| // type: string | ||
| // description: Minimum ID of the next status, used for paging. | ||
| // in: query | ||
| // - name: max_id | ||
| // type: string | ||
| // description: Maximum ID of the next status, used for paging. | ||
| // in: query | ||
| // | ||
| // responses: | ||
| // '200': | ||
| // in: body | ||
| // schema: | ||
| // "$ref": "#/definitions/swaggerCollection" | ||
| // '400': | ||
| // description: bad request | ||
| // '401': | ||
| // description: unauthorized | ||
| // '403': | ||
| // description: forbidden | ||
| // '404': | ||
| // description: not found | ||
| func (m *Module) OutboxGETHandler(c *gin.Context) { | ||
| l := logrus.WithFields(logrus.Fields{ | ||
| "func": "OutboxGETHandler", | ||
| "url": c.Request.RequestURI, | ||
| }) | ||
|
|
||
| requestedUsername := c.Param(UsernameKey) | ||
| if requestedUsername == "" { | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": "no username specified in request"}) | ||
| return | ||
| } | ||
|
|
||
| page := false | ||
| pageString := c.Query(PageKey) | ||
| if pageString != "" { | ||
| i, err := strconv.ParseBool(pageString) | ||
| if err != nil { | ||
| l.Debugf("error parsing page string: %s", err) | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": "couldn't parse page query param"}) | ||
| return | ||
| } | ||
| page = i | ||
| } | ||
|
|
||
| minID := "" | ||
| minIDString := c.Query(MinIDKey) | ||
| if minIDString != "" { | ||
| minID = minIDString | ||
| } | ||
|
|
||
| maxID := "" | ||
| maxIDString := c.Query(MaxIDKey) | ||
| if maxIDString != "" { | ||
| maxID = maxIDString | ||
| } | ||
|
|
||
| format, err := negotiateFormat(c) | ||
| if err != nil { | ||
| c.JSON(http.StatusNotAcceptable, gin.H{"error": fmt.Sprintf("could not negotiate format with given Accept header(s): %s", err)}) | ||
| return | ||
| } | ||
| l.Tracef("negotiated format: %s", format) | ||
|
|
||
| ctx := transferContext(c) | ||
|
|
||
| outbox, errWithCode := m.processor.GetFediOutbox(ctx, requestedUsername, page, maxID, minID, c.Request.URL) | ||
| if errWithCode != nil { | ||
| l.Info(errWithCode.Error()) | ||
| c.JSON(errWithCode.Code(), gin.H{"error": errWithCode.Safe()}) | ||
| return | ||
| } | ||
|
|
||
| b, mErr := json.Marshal(outbox) | ||
| if mErr != nil { | ||
| err := fmt.Errorf("could not marshal json: %s", mErr) | ||
| l.Error(err) | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
|
|
||
| c.Data(http.StatusOK, format, b) | ||
| } |
Oops, something went wrong.