2019-12-03 16:23:59 +00:00
|
|
|
package activitypub
|
2017-09-11 20:45:57 +00:00
|
|
|
|
2018-07-24 21:11:08 +00:00
|
|
|
import (
|
2019-08-21 20:21:32 +00:00
|
|
|
"errors"
|
2019-12-03 15:05:39 +00:00
|
|
|
"time"
|
2019-12-04 18:33:15 +00:00
|
|
|
"unsafe"
|
2018-07-24 21:11:08 +00:00
|
|
|
)
|
2018-06-09 12:05:46 +00:00
|
|
|
|
2019-12-01 18:27:45 +00:00
|
|
|
const CollectionOfItems ActivityVocabularyType = "ItemCollection"
|
|
|
|
|
2019-05-16 09:08:27 +00:00
|
|
|
var CollectionTypes = ActivityVocabularyTypes{
|
2019-12-01 18:27:45 +00:00
|
|
|
CollectionOfItems,
|
2018-10-18 18:19:18 +00:00
|
|
|
CollectionType,
|
|
|
|
OrderedCollectionType,
|
|
|
|
CollectionPageType,
|
|
|
|
OrderedCollectionPageType,
|
|
|
|
}
|
2017-09-16 18:20:33 +00:00
|
|
|
|
2018-04-09 11:10:27 +00:00
|
|
|
type CollectionInterface interface {
|
2018-07-20 16:18:13 +00:00
|
|
|
ObjectOrLink
|
2019-12-01 18:27:45 +00:00
|
|
|
Collection() ItemCollection
|
2018-10-04 18:33:32 +00:00
|
|
|
Append(ob Item) error
|
2019-06-02 14:45:37 +00:00
|
|
|
Count() uint
|
2019-08-23 18:39:28 +00:00
|
|
|
Contains(IRI) bool
|
2018-04-09 11:10:27 +00:00
|
|
|
}
|
|
|
|
|
2018-07-18 15:39:27 +00:00
|
|
|
// Collection is a subtype of Activity Pub Object that represents ordered or unordered sets of Activity Pub Object or Link instances.
|
2017-09-11 20:45:57 +00:00
|
|
|
type Collection struct {
|
2019-12-03 15:05:39 +00:00
|
|
|
// ID provides the globally unique identifier for anActivity Pub Object or Link.
|
2019-12-05 18:02:15 +00:00
|
|
|
ID ID `jsonld:"id,omitempty"`
|
2019-12-03 15:05:39 +00:00
|
|
|
// Type identifies the Activity Pub Object or Link type. Multiple values may be specified.
|
|
|
|
Type ActivityVocabularyType `jsonld:"type,omitempty"`
|
|
|
|
// Name a simple, human-readable, plain-text name for the object.
|
|
|
|
// HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
|
|
|
|
Name NaturalLanguageValues `jsonld:"name,omitempty,collapsible"`
|
|
|
|
// Attachment identifies a resource attached or related to an object that potentially requires special handling.
|
|
|
|
// The intent is to provide a model that is at least semantically similar to attachments in email.
|
|
|
|
Attachment Item `jsonld:"attachment,omitempty"`
|
|
|
|
// AttributedTo identifies one or more entities to which this object is attributed. The attributed entities might not be Actors.
|
|
|
|
// For instance, an object might be attributed to the completion of another activity.
|
|
|
|
AttributedTo Item `jsonld:"attributedTo,omitempty"`
|
|
|
|
// Audience identifies one or more entities that represent the total population of entities
|
|
|
|
// for which the object can considered to be relevant.
|
|
|
|
Audience ItemCollection `jsonld:"audience,omitempty"`
|
|
|
|
// Content or textual representation of the Activity Pub Object encoded as a JSON string.
|
|
|
|
// By default, the value of content is HTML.
|
|
|
|
// The mediaType property can be used in the object to indicate a different content type.
|
|
|
|
// (The content MAY be expressed using multiple language-tagged values.)
|
|
|
|
Content NaturalLanguageValues `jsonld:"content,omitempty,collapsible"`
|
|
|
|
// Context identifies the context within which the object exists or an activity was performed.
|
|
|
|
// The notion of "context" used is intentionally vague.
|
|
|
|
// The intended function is to serve as a means of grouping objects and activities that share a
|
|
|
|
// common originating context or purpose. An example could be all activities relating to a common project or event.
|
|
|
|
Context Item `jsonld:"context,omitempty"`
|
|
|
|
// MediaType when used on an Object, identifies the MIME media type of the value of the content property.
|
|
|
|
// If not specified, the content property is assumed to contain text/html content.
|
|
|
|
MediaType MimeType `jsonld:"mediaType,omitempty"`
|
|
|
|
// EndTime the date and time describing the actual or expected ending time of the object.
|
|
|
|
// When used with an Activity object, for instance, the endTime property specifies the moment
|
|
|
|
// the activity concluded or is expected to conclude.
|
|
|
|
EndTime time.Time `jsonld:"endTime,omitempty"`
|
|
|
|
// Generator identifies the entity (e.g. an application) that generated the object.
|
|
|
|
Generator Item `jsonld:"generator,omitempty"`
|
|
|
|
// Icon indicates an entity that describes an icon for this object.
|
|
|
|
// The image should have an aspect ratio of one (horizontal) to one (vertical)
|
|
|
|
// and should be suitable for presentation at a small size.
|
|
|
|
Icon Item `jsonld:"icon,omitempty"`
|
|
|
|
// Image indicates an entity that describes an image for this object.
|
|
|
|
// Unlike the icon property, there are no aspect ratio or display size limitations assumed.
|
|
|
|
Image Item `jsonld:"image,omitempty"`
|
|
|
|
// InReplyTo indicates one or more entities for which this object is considered a response.
|
|
|
|
InReplyTo Item `jsonld:"inReplyTo,omitempty"`
|
|
|
|
// Location indicates one or more physical or logical locations associated with the object.
|
|
|
|
Location Item `jsonld:"location,omitempty"`
|
|
|
|
// Preview identifies an entity that provides a preview of this object.
|
|
|
|
Preview Item `jsonld:"preview,omitempty"`
|
|
|
|
// Published the date and time at which the object was published
|
|
|
|
Published time.Time `jsonld:"published,omitempty"`
|
|
|
|
// Replies identifies a Collection containing objects considered to be responses to this object.
|
|
|
|
Replies Item `jsonld:"replies,omitempty"`
|
|
|
|
// StartTime the date and time describing the actual or expected starting time of the object.
|
|
|
|
// When used with an Activity object, for instance, the startTime property specifies
|
|
|
|
// the moment the activity began or is scheduled to begin.
|
|
|
|
StartTime time.Time `jsonld:"startTime,omitempty"`
|
|
|
|
// Summary a natural language summarization of the object encoded as HTML.
|
|
|
|
// *Multiple language tagged summaries may be provided.)
|
|
|
|
Summary NaturalLanguageValues `jsonld:"summary,omitempty,collapsible"`
|
|
|
|
// Tag one or more "tags" that have been associated with an objects. A tag can be any kind of Activity Pub Object.
|
|
|
|
// The key difference between attachment and tag is that the former implies association by inclusion,
|
|
|
|
// while the latter implies associated by reference.
|
|
|
|
Tag ItemCollection `jsonld:"tag,omitempty"`
|
|
|
|
// Updated the date and time at which the object was updated
|
|
|
|
Updated time.Time `jsonld:"updated,omitempty"`
|
|
|
|
// URL identifies one or more links to representations of the object
|
|
|
|
URL LinkOrIRI `jsonld:"url,omitempty"`
|
|
|
|
// To identifies an entity considered to be part of the public primary audience of an Activity Pub Object
|
|
|
|
To ItemCollection `jsonld:"to,omitempty"`
|
|
|
|
// Bto identifies anActivity Pub Object that is part of the private primary audience of this Activity Pub Object.
|
|
|
|
Bto ItemCollection `jsonld:"bto,omitempty"`
|
|
|
|
// CC identifies anActivity Pub Object that is part of the public secondary audience of this Activity Pub Object.
|
|
|
|
CC ItemCollection `jsonld:"cc,omitempty"`
|
|
|
|
// BCC identifies one or more Objects that are part of the private secondary audience of this Activity Pub Object.
|
|
|
|
BCC ItemCollection `jsonld:"bcc,omitempty"`
|
|
|
|
// Duration when the object describes a time-bound resource, such as an audio or video, a meeting, etc,
|
|
|
|
// the duration property indicates the object's approximate duration.
|
|
|
|
// The value must be expressed as an xsd:duration as defined by [ xmlschema11-2],
|
|
|
|
// section 3.3.6 (e.g. a period of 5 seconds is represented as "PT5S").
|
|
|
|
Duration time.Duration `jsonld:"duration,omitempty"`
|
2019-12-03 19:50:26 +00:00
|
|
|
// This is a list of all Like activities with this object as the object property, added as a side effect.
|
|
|
|
// The likes collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges
|
|
|
|
// of an authenticated user or as appropriate when no authentication is given.
|
|
|
|
Likes Item `jsonld:"likes,omitempty"`
|
|
|
|
// This is a list of all Announce activities with this object as the object property, added as a side effect.
|
|
|
|
// The shares collection MUST be either an OrderedCollection or a Collection and MAY be filtered on privileges
|
|
|
|
// of an authenticated user or as appropriate when no authentication is given.
|
|
|
|
Shares Item `jsonld:"shares,omitempty"`
|
|
|
|
// Source property is intended to convey some sort of source from which the content markup was derived,
|
|
|
|
// as a form of provenance, or to support future editing by clients.
|
|
|
|
// In general, clients do the conversion from source to content, not the other way around.
|
|
|
|
Source Source `jsonld:"source,omitempty"`
|
2018-10-10 15:13:21 +00:00
|
|
|
// In a paged Collection, indicates the page that contains the most recently updated member items.
|
|
|
|
Current ObjectOrLink `jsonld:"current,omitempty"`
|
2018-10-18 09:48:02 +00:00
|
|
|
// In a paged Collection, indicates the furthest preceeding page of items in the collection.
|
2018-10-10 15:13:21 +00:00
|
|
|
First ObjectOrLink `jsonld:"first,omitempty"`
|
|
|
|
// In a paged Collection, indicates the furthest proceeding page of the collection.
|
|
|
|
Last ObjectOrLink `jsonld:"last,omitempty"`
|
2017-09-12 15:47:49 +00:00
|
|
|
// A non-negative integer specifying the total number of objects contained by the logical view of the collection.
|
|
|
|
// This number might not reflect the actual number of items serialized within the Collection object instance.
|
2019-03-03 12:51:05 +00:00
|
|
|
TotalItems uint `jsonld:"totalItems"`
|
2017-09-12 15:47:49 +00:00
|
|
|
// Identifies the items contained in a collection. The items might be ordered or unordered.
|
2017-10-02 09:53:09 +00:00
|
|
|
Items ItemCollection `jsonld:"items,omitempty"`
|
2017-09-11 20:45:57 +00:00
|
|
|
}
|
|
|
|
|
2019-12-19 12:30:18 +00:00
|
|
|
type (
|
|
|
|
// FollowersCollection is a collection of followers
|
|
|
|
FollowersCollection = Followers
|
|
|
|
|
|
|
|
// Followers is a Collection type
|
|
|
|
Followers = Collection
|
|
|
|
|
|
|
|
// FollowingCollection is a list of everybody that the actor has followed, added as a side effect.
|
|
|
|
// The following collection MUST be either an OrderedCollection or a Collection and MAY
|
|
|
|
// be filtered on privileges of an authenticated user or as appropriate when no authentication is given.
|
|
|
|
FollowingCollection = Following
|
|
|
|
|
|
|
|
// Following is a type alias for a simple Collection
|
|
|
|
Following = Collection
|
|
|
|
)
|
|
|
|
|
2018-03-25 18:54:51 +00:00
|
|
|
// CollectionNew initializes a new Collection
|
2019-12-05 18:02:15 +00:00
|
|
|
func CollectionNew(id ID) *Collection {
|
2019-12-03 15:05:39 +00:00
|
|
|
c := Collection{ID: id, Type: CollectionType}
|
2019-02-21 16:54:11 +00:00
|
|
|
c.Name = NaturalLanguageValuesNew()
|
|
|
|
c.Content = NaturalLanguageValuesNew()
|
|
|
|
c.Summary = NaturalLanguageValuesNew()
|
2018-06-09 12:05:46 +00:00
|
|
|
return &c
|
2017-09-12 15:47:49 +00:00
|
|
|
}
|
|
|
|
|
2018-10-24 09:28:55 +00:00
|
|
|
// OrderedCollectionNew initializes a new OrderedCollection
|
2019-12-05 18:02:15 +00:00
|
|
|
func OrderedCollectionNew(id ID) *OrderedCollection {
|
2019-12-03 15:05:39 +00:00
|
|
|
o := OrderedCollection{ID: id, Type: OrderedCollectionType}
|
2019-02-21 16:54:11 +00:00
|
|
|
o.Name = NaturalLanguageValuesNew()
|
|
|
|
o.Content = NaturalLanguageValuesNew()
|
2017-09-12 15:47:49 +00:00
|
|
|
|
2018-06-09 12:05:46 +00:00
|
|
|
return &o
|
2017-09-11 21:16:43 +00:00
|
|
|
}
|
|
|
|
|
2019-12-05 18:02:15 +00:00
|
|
|
// GetID returns the ID corresponding to the Collection object
|
|
|
|
func (c Collection) GetID() ID {
|
2019-12-03 15:26:43 +00:00
|
|
|
return c.ID
|
2019-06-02 14:45:37 +00:00
|
|
|
}
|
|
|
|
|
2018-07-16 13:58:36 +00:00
|
|
|
// GetType returns the Collection's type
|
2018-10-04 19:04:31 +00:00
|
|
|
func (c Collection) GetType() ActivityVocabularyType {
|
2018-06-09 12:05:46 +00:00
|
|
|
return c.Type
|
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
|
|
|
// IsLink returns false for a Collection object
|
2018-10-04 19:04:31 +00:00
|
|
|
func (c Collection) IsLink() bool {
|
2018-06-09 12:05:46 +00:00
|
|
|
return false
|
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
|
|
|
// IsObject returns true for a Collection object
|
2018-10-04 19:04:31 +00:00
|
|
|
func (c Collection) IsObject() bool {
|
2018-06-09 12:05:46 +00:00
|
|
|
return true
|
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// IsCollection returns true for Collection objects
|
|
|
|
func (c Collection) IsCollection() bool {
|
|
|
|
return true
|
2018-06-09 12:05:46 +00:00
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// GetLink returns the IRI corresponding to the Collection object
|
|
|
|
func (c Collection) GetLink() IRI {
|
|
|
|
return IRI(c.ID)
|
2018-06-09 12:05:46 +00:00
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// Collection returns the Collection's items
|
|
|
|
func (c Collection) Collection() ItemCollection {
|
|
|
|
return c.Items
|
2018-06-09 12:05:46 +00:00
|
|
|
}
|
2018-07-16 13:58:36 +00:00
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// Append adds an element to a Collection
|
|
|
|
func (c *Collection) Append(ob Item) error {
|
|
|
|
c.Items = append(c.Items, ob)
|
|
|
|
return nil
|
2018-10-11 18:48:38 +00:00
|
|
|
}
|
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// Count returns the maximum between the length of Items in collection and its TotalItems property
|
|
|
|
func (c *Collection) Count() uint {
|
|
|
|
if c.TotalItems > 0 {
|
|
|
|
return c.TotalItems
|
|
|
|
}
|
|
|
|
return uint(len(c.Items))
|
2018-06-09 12:05:46 +00:00
|
|
|
}
|
2018-07-07 19:27:34 +00:00
|
|
|
|
2019-12-03 15:05:39 +00:00
|
|
|
// Contains verifies if Collection array contains the received one
|
|
|
|
func (c Collection) Contains(r IRI) bool {
|
|
|
|
if len(c.Items) == 0 {
|
|
|
|
return false
|
2019-05-18 20:45:54 +00:00
|
|
|
}
|
2019-12-03 15:05:39 +00:00
|
|
|
for _, iri := range c.Items {
|
|
|
|
if r.Equals(iri.GetLink(), false) {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
2018-07-24 21:11:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// UnmarshalJSON
|
|
|
|
func (c *Collection) UnmarshalJSON(data []byte) error {
|
2019-12-21 14:14:43 +00:00
|
|
|
return loadCollection(data, c)
|
2018-07-24 21:11:08 +00:00
|
|
|
}
|
|
|
|
|
2019-12-19 12:35:05 +00:00
|
|
|
// MarshalJSON
|
|
|
|
func (c Collection) MarshalJSON() ([]byte, error) {
|
2019-12-19 16:05:12 +00:00
|
|
|
b := make([]byte, 0)
|
2019-12-19 12:35:05 +00:00
|
|
|
notEmpty := false
|
2019-12-19 16:05:12 +00:00
|
|
|
write(&b, '{')
|
2019-12-19 12:35:05 +00:00
|
|
|
|
|
|
|
OnObject(c, func(o *Object) error {
|
2019-12-21 09:44:32 +00:00
|
|
|
notEmpty = writeObjectValue(&b, *o)
|
2019-12-19 12:35:05 +00:00
|
|
|
return nil
|
|
|
|
})
|
|
|
|
if c.Current != nil {
|
|
|
|
notEmpty = writeItemProp(&b, "current", c.Current) || notEmpty
|
|
|
|
}
|
|
|
|
if c.First != nil {
|
|
|
|
notEmpty = writeItemProp(&b, "first", c.First) || notEmpty
|
|
|
|
}
|
|
|
|
if c.Last != nil {
|
|
|
|
notEmpty = writeItemProp(&b, "last", c.Last) || notEmpty
|
|
|
|
}
|
2020-01-20 11:13:18 +00:00
|
|
|
notEmpty = writeIntProp(&b, "totalItems", int64(c.TotalItems)) || notEmpty
|
2019-12-19 12:35:05 +00:00
|
|
|
if c.Items != nil {
|
|
|
|
notEmpty = writeItemCollectionProp(&b, "items", c.Items) || notEmpty
|
|
|
|
}
|
|
|
|
if notEmpty {
|
2019-12-19 16:05:12 +00:00
|
|
|
write(&b, '}')
|
|
|
|
return b, nil
|
2019-12-19 12:35:05 +00:00
|
|
|
}
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
|
2019-08-21 20:21:32 +00:00
|
|
|
// ToCollection
|
|
|
|
func ToCollection(it Item) (*Collection, error) {
|
|
|
|
switch i := it.(type) {
|
|
|
|
case *Collection:
|
|
|
|
return i, nil
|
|
|
|
case Collection:
|
|
|
|
return &i, nil
|
2019-12-04 18:33:15 +00:00
|
|
|
case *CollectionPage:
|
|
|
|
return (*Collection)(unsafe.Pointer(i)), nil
|
|
|
|
case CollectionPage:
|
|
|
|
return (*Collection)(unsafe.Pointer(&i)), nil
|
2019-08-21 20:21:32 +00:00
|
|
|
}
|
|
|
|
return nil, errors.New("unable to convert to collection")
|
|
|
|
}
|
2019-12-19 12:30:18 +00:00
|
|
|
|
|
|
|
// FollowingNew initializes a new Following
|
|
|
|
func FollowingNew() *Following {
|
|
|
|
id := ID("following")
|
|
|
|
|
|
|
|
i := Following{ID: id, Type: CollectionType}
|
|
|
|
i.Name = NaturalLanguageValuesNew()
|
|
|
|
i.Content = NaturalLanguageValuesNew()
|
|
|
|
i.Summary = NaturalLanguageValuesNew()
|
|
|
|
|
|
|
|
i.TotalItems = 0
|
|
|
|
|
|
|
|
return &i
|
|
|
|
}
|
2020-03-29 16:26:30 +00:00
|
|
|
|
|
|
|
// ItemMatches
|
|
|
|
func (c Collection) ItemMatches(it Item) bool {
|
|
|
|
return c.Items.Contains(it.GetLink())
|
|
|
|
}
|