Adding upstream version 0.0~git20250501.71edba4.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-05-18 22:06:39 +02:00 · 2025-05-18 22:06:39 +02:00 · c8085bda34
commit c8085bda34
parent c6ff472a6d
87 changed files with 24009 additions and 0 deletions
--- a/collection.go
+++ b/collection.go
@ -0,0 +1,439 @@
+package activitypub
+
+import (
+	"bytes"
+	"encoding/gob"
+	"fmt"
+	"time"
+	"unsafe"
+
+	"github.com/valyala/fastjson"
+)
+
+const CollectionOfIRIs ActivityVocabularyType = "IRICollection"
+const CollectionOfItems ActivityVocabularyType = "ItemCollection"
+
+var CollectionTypes = ActivityVocabularyTypes{
+	CollectionOfItems,
+	CollectionType,
+	OrderedCollectionType,
+	CollectionPageType,
+	OrderedCollectionPageType,
+}
+
+// Collections
+//
+// https://www.w3.org/TR/activitypub/#collections
+//
+// [ActivityStreams] defines the collection concept; ActivityPub defines several collections with special behavior.
+//
+// Note that ActivityPub makes use of ActivityStreams paging to traverse large sets of objects.
+//
+// Note that some of these collections are specified to be of type OrderedCollection specifically,
+// while others are permitted to be either a Collection or an OrderedCollection.
+// An OrderedCollection MUST be presented consistently in reverse chronological order.
+//
+// NOTE
+// What property is used to determine the reverse chronological order is intentionally left as an implementation detail.
+// For example, many SQL-style databases use an incrementing integer as an identifier, which can be reasonably used for
+// handling insertion order in most cases. In other databases, an insertion time timestamp may be preferred.
+// What is used isn't important, but the ordering of elements must remain intact, with newer items first.
+// A property which changes regularly, such a "last updated" timestamp, should not be used.
+type Collections interface {
+	Collection | CollectionPage | OrderedCollection | OrderedCollectionPage | ItemCollection | IRIs
+}
+
+type CollectionInterface interface {
+	ObjectOrLink
+	Collection() ItemCollection
+	Append(ob ...Item) error
+	Count() uint
+	Contains(Item) bool
+}
+
+// Collection is a subtype of Activity Pub Object that represents ordered or unordered sets of Activity Pub Object or Link instances.
+type Collection struct {
+	// ID provides the globally unique identifier for anActivity Pub Object or Link.
+	ID ID `jsonld:"id,omitempty"`
+	// 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 Item `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"`
+	// 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"`
+	// In a paged Collection, indicates the page that contains the most recently updated member items.
+	Current ObjectOrLink `jsonld:"current,omitempty"`
+	// In a paged Collection, indicates the furthest preceding page of items in the collection.
+	First ObjectOrLink `jsonld:"first,omitempty"`
+	// In a paged Collection, indicates the furthest proceeding page of the collection.
+	Last ObjectOrLink `jsonld:"last,omitempty"`
+	// 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.
+	TotalItems uint `jsonld:"totalItems"`
+	// Identifies the items contained in a collection. The items might be ordered or unordered.
+	Items ItemCollection `jsonld:"items,omitempty"`
+}
+
+type (
+	// FollowersCollection is a collection of followers
+	FollowersCollection = 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 = Collection
+)
+
+// CollectionNew initializes a new Collection
+func CollectionNew(id ID) *Collection {
+	c := Collection{ID: id, Type: CollectionType}
+	c.Name = NaturalLanguageValuesNew()
+	c.Content = NaturalLanguageValuesNew()
+	c.Summary = NaturalLanguageValuesNew()
+	return &c
+}
+
+// OrderedCollectionNew initializes a new OrderedCollection
+func OrderedCollectionNew(id ID) *OrderedCollection {
+	o := OrderedCollection{ID: id, Type: OrderedCollectionType}
+	o.Name = NaturalLanguageValuesNew()
+	o.Content = NaturalLanguageValuesNew()
+
+	return &o
+}
+
+// GetID returns the ID corresponding to the Collection object
+func (c Collection) GetID() ID {
+	return c.ID
+}
+
+// GetType returns the Collection's type
+func (c Collection) GetType() ActivityVocabularyType {
+	return c.Type
+}
+
+// IsLink returns false for a Collection object
+func (c Collection) IsLink() bool {
+	return false
+}
+
+// IsObject returns true for a Collection object
+func (c Collection) IsObject() bool {
+	return true
+}
+
+// IsCollection returns true for Collection objects
+func (c Collection) IsCollection() bool {
+	return true
+}
+
+// GetLink returns the IRI corresponding to the Collection object
+func (c Collection) GetLink() IRI {
+	return IRI(c.ID)
+}
+
+// Collection returns the Collection's items
+func (c Collection) Collection() ItemCollection {
+	return c.Items
+}
+
+// Append adds an element to a Collection
+func (c *Collection) Append(it ...Item) error {
+	for _, ob := range it {
+		if c.Items.Contains(ob) {
+			continue
+		}
+		c.Items = append(c.Items, ob)
+	}
+	return nil
+}
+
+// Count returns the maximum between the length of Items in collection and its TotalItems property
+func (c *Collection) Count() uint {
+	if c == nil {
+		return 0
+	}
+	return uint(len(c.Items))
+}
+
+// Contains verifies if Collection array contains the received one
+func (c Collection) Contains(r Item) bool {
+	if len(c.Items) == 0 {
+		return false
+	}
+	for _, it := range c.Items {
+		if ItemsEqual(it, r) {
+			return true
+		}
+	}
+	return false
+}
+
+// UnmarshalJSON decodes an incoming JSON document into the receiver object.
+func (c *Collection) UnmarshalJSON(data []byte) error {
+	par := fastjson.Parser{}
+	val, err := par.ParseBytes(data)
+	if err != nil {
+		return err
+	}
+	return JSONLoadCollection(val, c)
+}
+
+// MarshalJSON encodes the receiver object to a JSON document.
+func (c Collection) MarshalJSON() ([]byte, error) {
+	b := make([]byte, 0)
+	notEmpty := false
+	JSONWrite(&b, '{')
+
+	OnObject(c, func(o *Object) error {
+		notEmpty = JSONWriteObjectValue(&b, *o)
+		return nil
+	})
+	if c.Current != nil {
+		notEmpty = JSONWriteItemProp(&b, "current", c.Current) || notEmpty
+	}
+	if c.First != nil {
+		notEmpty = JSONWriteItemProp(&b, "first", c.First) || notEmpty
+	}
+	if c.Last != nil {
+		notEmpty = JSONWriteItemProp(&b, "last", c.Last) || notEmpty
+	}
+	notEmpty = JSONWriteIntProp(&b, "totalItems", int64(c.TotalItems)) || notEmpty
+	if c.Items != nil {
+		notEmpty = JSONWriteItemCollectionProp(&b, "items", c.Items, false) || notEmpty
+	}
+	if notEmpty {
+		JSONWrite(&b, '}')
+		return b, nil
+	}
+	return nil, nil
+}
+
+// UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
+func (c *Collection) UnmarshalBinary(data []byte) error {
+	return c.GobDecode(data)
+}
+
+// MarshalBinary implements the encoding.BinaryMarshaler interface.
+func (c Collection) MarshalBinary() ([]byte, error) {
+	return c.GobEncode()
+}
+
+func (c Collection) GobEncode() ([]byte, error) {
+	mm := make(map[string][]byte)
+	hasData, err := mapCollectionProperties(mm, c)
+	if err != nil {
+		return nil, err
+	}
+	if !hasData {
+		return []byte{}, nil
+	}
+	bb := bytes.Buffer{}
+	g := gob.NewEncoder(&bb)
+	if err := g.Encode(mm); err != nil {
+		return nil, err
+	}
+	return bb.Bytes(), nil
+}
+
+func (c *Collection) GobDecode(data []byte) error {
+	if len(data) == 0 {
+		return nil
+	}
+	mm, err := gobDecodeObjectAsMap(data)
+	if err != nil {
+		return err
+	}
+	return unmapCollectionProperties(mm, c)
+}
+
+func (c Collection) Format(s fmt.State, verb rune) {
+	switch verb {
+	case 's', 'v':
+		_, _ = fmt.Fprintf(s, "%T[%s] { totalItems: %d }", c, c.Type, c.TotalItems)
+	}
+}
+
+// ToCollection
+func ToCollection(it Item) (*Collection, error) {
+	switch i := it.(type) {
+	case *Collection:
+		return i, nil
+	case Collection:
+		return &i, nil
+	case *CollectionPage:
+		return (*Collection)(unsafe.Pointer(i)), nil
+	case CollectionPage:
+		return (*Collection)(unsafe.Pointer(&i)), nil
+	// NOTE(marius): let's try again to convert OrderedCollection -> Collection, as they have the same
+	// shape in memory.
+	case *OrderedCollection:
+		return (*Collection)(unsafe.Pointer(i)), nil
+	case OrderedCollection:
+		return (*Collection)(unsafe.Pointer(&i)), nil
+	case *OrderedCollectionPage:
+		return (*Collection)(unsafe.Pointer(i)), nil
+	case OrderedCollectionPage:
+		return (*Collection)(unsafe.Pointer(&i)), nil
+	default:
+		return reflectItemToType[Collection](it)
+	}
+}
+
+// ItemsMatch
+func (c Collection) ItemsMatch(col ...Item) bool {
+	for _, it := range col {
+		if match := c.Items.Contains(it); !match {
+			return false
+		}
+	}
+	return true
+}
+
+// Equals
+func (c Collection) Equals(with Item) bool {
+	if IsNil(with) {
+		return false
+	}
+	if !with.IsCollection() {
+		return false
+	}
+	result := true
+	_ = OnCollection(with, func(w *Collection) error {
+		_ = OnObject(w, func(wo *Object) error {
+			if !wo.Equals(c) {
+				result = false
+				return nil
+			}
+			return nil
+		})
+		if w.TotalItems > 0 {
+			if w.TotalItems != c.TotalItems {
+				result = false
+				return nil
+			}
+		}
+		if w.Current != nil {
+			if !ItemsEqual(c.Current, w.Current) {
+				result = false
+				return nil
+			}
+		}
+		if w.First != nil {
+			if !ItemsEqual(c.First, w.First) {
+				result = false
+				return nil
+			}
+		}
+		if w.Last != nil {
+			if !ItemsEqual(c.Last, w.Last) {
+				result = false
+				return nil
+			}
+		}
+		if w.Items != nil {
+			if !ItemsEqual(c.Items, w.Items) {
+				result = false
+				return nil
+			}
+		}
+		return nil
+	})
+	return result
+}
+
+func (c *Collection) Recipients() ItemCollection {
+	aud := c.Audience
+	return ItemCollectionDeduplication(&c.To, &c.CC, &c.Bto, &c.BCC, &aud)
+}
+
+func (c *Collection) Clean() {
+	_ = OnObject(c, func(o *Object) error {
+		o.Clean()
+		return nil
+	})
+}