472 lines
13 KiB
Go
472 lines
13 KiB
Go
package activitystreams
|
|
|
|
import (
|
|
"errors"
|
|
"github.com/buger/jsonparser"
|
|
)
|
|
|
|
const CollectionOfItems ActivityVocabularyType = "ItemCollection"
|
|
|
|
var CollectionTypes = ActivityVocabularyTypes{
|
|
CollectionOfItems,
|
|
CollectionType,
|
|
OrderedCollectionType,
|
|
CollectionPageType,
|
|
OrderedCollectionPageType,
|
|
}
|
|
|
|
type CollectionInterface interface {
|
|
ObjectOrLink
|
|
Collection() ItemCollection
|
|
Append(ob Item) error
|
|
Count() uint
|
|
Contains(IRI) 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 {
|
|
Parent
|
|
// 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 preceeding 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 ParentCollection = Collection
|
|
|
|
// OrderedCollection is a subtype of Collection in which members of the logical
|
|
// collection are assumed to always be strictly ordered.
|
|
type OrderedCollection struct {
|
|
Parent
|
|
// 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 preceeding 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.
|
|
OrderedItems ItemCollection `jsonld:"orderedItems,omitempty"`
|
|
}
|
|
|
|
// CollectionPage is a Collection that contains a large number of items and when it becomes impractical
|
|
// for an implementation to serialize every item contained by a Collection using the items (or orderedItems)
|
|
// property alone. In such cases, the items within a Collection can be divided into distinct subsets or "pages".
|
|
type CollectionPage struct {
|
|
ParentCollection
|
|
// Identifies the Collection to which a CollectionPage objects items belong.
|
|
PartOf Item `jsonld:"partOf,omitempty"`
|
|
// In a paged Collection, indicates the next page of items.
|
|
Next Item `jsonld:"next,omitempty"`
|
|
// In a paged Collection, identifies the previous page of items.
|
|
Prev Item `jsonld:"prev,omitempty"`
|
|
}
|
|
|
|
// OrderedCollectionPage type extends from both CollectionPage and OrderedCollection.
|
|
// In addition to the properties inherited from each of those, the OrderedCollectionPage
|
|
// may contain an additional startIndex property whose value indicates the relative index position
|
|
// of the first item contained by the page within the OrderedCollection to which the page belongs.
|
|
type OrderedCollectionPage struct {
|
|
OrderedCollection
|
|
// Identifies the Collection to which a CollectionPage objects items belong.
|
|
PartOf Item `jsonld:"partOf,omitempty"`
|
|
// In a paged Collection, indicates the next page of items.
|
|
Next Item `jsonld:"next,omitempty"`
|
|
// In a paged Collection, identifies the previous page of items.
|
|
Prev Item `jsonld:"prev,omitempty"`
|
|
// A non-negative integer value identifying the relative position within the logical view of a strictly ordered collection.
|
|
StartIndex uint `jsonld:"startIndex,omitempty"`
|
|
}
|
|
|
|
// CollectionNew initializes a new Collection
|
|
func CollectionNew(id ObjectID) *Collection {
|
|
c := Collection{Parent: Parent{ID: id, Type: CollectionType}}
|
|
c.Name = NaturalLanguageValuesNew()
|
|
c.Content = NaturalLanguageValuesNew()
|
|
c.Summary = NaturalLanguageValuesNew()
|
|
return &c
|
|
}
|
|
|
|
// OrderedCollectionNew initializes a new OrderedCollection
|
|
func OrderedCollectionNew(id ObjectID) *OrderedCollection {
|
|
o := OrderedCollection{Parent: Parent{ID: id, Type: OrderedCollectionType}}
|
|
o.Name = NaturalLanguageValuesNew()
|
|
o.Content = NaturalLanguageValuesNew()
|
|
|
|
return &o
|
|
}
|
|
|
|
// CollectionNew initializes a new CollectionPage
|
|
func CollectionPageNew(parent CollectionInterface) *CollectionPage {
|
|
p := CollectionPage{
|
|
PartOf: parent.GetLink(),
|
|
}
|
|
if pc, ok := parent.(*Collection); ok {
|
|
p.ParentCollection = *pc
|
|
}
|
|
p.Type = CollectionPageType
|
|
return &p
|
|
}
|
|
|
|
// OrderedCollectionPageNew initializes a new OrderedCollectionPage
|
|
func OrderedCollectionPageNew(parent CollectionInterface) *OrderedCollectionPage {
|
|
p := OrderedCollectionPage{
|
|
PartOf: parent.GetLink(),
|
|
}
|
|
if pc, ok := parent.(*OrderedCollection); ok {
|
|
p.OrderedCollection = *pc
|
|
}
|
|
p.Type = OrderedCollectionPageType
|
|
return &p
|
|
}
|
|
|
|
// Append adds an element to an OrderedCollection
|
|
func (o *OrderedCollection) Append(ob Item) error {
|
|
o.OrderedItems = append(o.OrderedItems, ob)
|
|
return nil
|
|
}
|
|
|
|
// Count returns the maximum between the length of Items in collection and its TotalItems property
|
|
func (o *OrderedCollection) Count() uint {
|
|
if o.TotalItems > 0 {
|
|
return o.TotalItems
|
|
}
|
|
return uint(len(o.OrderedItems))
|
|
}
|
|
|
|
// Append adds an element to a Collection
|
|
func (c *Collection) Append(ob Item) error {
|
|
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.TotalItems > 0 {
|
|
return c.TotalItems
|
|
}
|
|
return uint(len(c.Items))
|
|
}
|
|
|
|
// Append adds an element to an OrderedCollectionPage
|
|
func (o *OrderedCollectionPage) Append(ob Item) error {
|
|
o.OrderedItems = append(o.OrderedItems, ob)
|
|
return nil
|
|
}
|
|
|
|
// Count returns the maximum between the length of Items in the collection page and its TotalItems property
|
|
func (o *OrderedCollectionPage) Count() uint {
|
|
if o.TotalItems > 0 {
|
|
return o.TotalItems
|
|
}
|
|
return uint(len(o.OrderedItems))
|
|
}
|
|
|
|
// Append adds an element to a CollectionPage
|
|
func (c *CollectionPage) Append(ob Item) error {
|
|
c.Items = append(c.Items, ob)
|
|
return nil
|
|
}
|
|
|
|
// Count returns the maximum between the length of Items in the collection page and its TotalItems property
|
|
func (c *CollectionPage) Count() uint {
|
|
if c.TotalItems > 0 {
|
|
return c.TotalItems
|
|
}
|
|
return uint(len(c.Items))
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
// GetID returns the ObjectID corresponding to the Collection object
|
|
func (c Collection) GetID() *ObjectID {
|
|
return &c.ID
|
|
}
|
|
|
|
// GetLink returns the IRI corresponding to the Collection object
|
|
func (c Collection) GetLink() IRI {
|
|
return IRI(c.ID)
|
|
}
|
|
|
|
// IsObject returns true for a Collection object
|
|
func (c Collection) IsObject() bool {
|
|
return true
|
|
}
|
|
|
|
// GetType returns the OrderedCollection's type
|
|
func (o OrderedCollection) GetType() ActivityVocabularyType {
|
|
return o.Type
|
|
}
|
|
|
|
// IsLink returns false for an OrderedCollection object
|
|
func (o OrderedCollection) IsLink() bool {
|
|
return false
|
|
}
|
|
|
|
// GetID returns the ObjectID corresponding to the OrderedCollection
|
|
func (o OrderedCollection) GetID() *ObjectID {
|
|
return &o.ID
|
|
}
|
|
|
|
// GetLink returns the IRI corresponding to the OrderedCollection object
|
|
func (o OrderedCollection) GetLink() IRI {
|
|
return IRI(o.ID)
|
|
}
|
|
|
|
// IsObject returns true for am OrderedCollection object
|
|
func (o OrderedCollection) IsObject() bool {
|
|
return true
|
|
}
|
|
|
|
// UnmarshalJSON
|
|
func (o *OrderedCollection) UnmarshalJSON(data []byte) error {
|
|
if ItemTyperFunc == nil {
|
|
ItemTyperFunc = JSONGetItemByType
|
|
}
|
|
o.Parent.UnmarshalJSON(data)
|
|
|
|
o.TotalItems = uint(JSONGetInt(data, "totalItems"))
|
|
o.OrderedItems = JSONGetItems(data, "orderedItems")
|
|
|
|
o.Current = JSONGetItem(data, "current")
|
|
o.First = JSONGetItem(data, "first")
|
|
o.Last = JSONGetItem(data, "last")
|
|
|
|
return nil
|
|
}
|
|
|
|
// UnmarshalJSON
|
|
func (c *Collection) UnmarshalJSON(data []byte) error {
|
|
c.Parent.UnmarshalJSON(data)
|
|
|
|
c.TotalItems = uint(JSONGetInt(data, "totalItems"))
|
|
c.Items = JSONGetItems(data, "items")
|
|
|
|
c.Current = JSONGetItem(data, "current")
|
|
c.First = JSONGetItem(data, "first")
|
|
c.Last = JSONGetItem(data, "last")
|
|
|
|
return nil
|
|
}
|
|
|
|
// UnmarshalJSON
|
|
func (o *OrderedCollectionPage) UnmarshalJSON(data []byte) error {
|
|
o.OrderedCollection.UnmarshalJSON(data)
|
|
|
|
o.Next = JSONGetItem(data, "next")
|
|
o.Prev = JSONGetItem(data, "prev")
|
|
o.PartOf = JSONGetItem(data, "partOf")
|
|
|
|
if si, err := jsonparser.GetInt(data, "startIndex"); err != nil {
|
|
o.StartIndex = uint(si)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// UnmarshalJSON
|
|
func (c *CollectionPage) UnmarshalJSON(data []byte) error {
|
|
c.ParentCollection.UnmarshalJSON(data)
|
|
|
|
c.Next = JSONGetItem(data, "next")
|
|
c.Prev = JSONGetItem(data, "prev")
|
|
c.PartOf = JSONGetItem(data, "partOf")
|
|
|
|
return nil
|
|
}
|
|
|
|
/*
|
|
func (c *Collection) MarshalJSON() ([]byte, error) {
|
|
return nil, nil
|
|
}
|
|
|
|
func (o *OrderedCollection) MarshalJSON() ([]byte, error) {
|
|
return nil, nil
|
|
}
|
|
*/
|
|
|
|
// Collection returns the underlying Collection type
|
|
func (c *Collection) Collection() ItemCollection {
|
|
return c.Items
|
|
}
|
|
|
|
// IsCollection returns true for Collection objects
|
|
func (c Collection) IsCollection() bool {
|
|
return true
|
|
}
|
|
|
|
// Collection returns the underlying Collection type
|
|
func (o *OrderedCollection) Collection() ItemCollection {
|
|
return o.OrderedItems
|
|
}
|
|
|
|
// IsCollection returns true for OrderedCollection objects
|
|
func (o OrderedCollection) IsCollection() bool {
|
|
return true
|
|
}
|
|
|
|
// Collection returns the underlying Collection type
|
|
func (c *CollectionPage) Collection() ItemCollection {
|
|
return c.Items
|
|
}
|
|
|
|
// IsCollection returns true for CollectionPage objects
|
|
func (c CollectionPage) IsCollection() bool {
|
|
return true
|
|
}
|
|
|
|
// Collection returns the underlying Collection type
|
|
func (o *OrderedCollectionPage) Collection() ItemCollection {
|
|
return o.OrderedItems
|
|
}
|
|
|
|
// IsCollection returns true for OrderedCollectionPage objects
|
|
func (o OrderedCollectionPage) IsCollection() bool {
|
|
return true
|
|
}
|
|
|
|
// Flatten checks if Item can be flatten to an IRI or array of IRIs and returns it if so
|
|
func Flatten(it Item) Item {
|
|
if it.IsCollection() {
|
|
if c, ok := it.(CollectionInterface); ok {
|
|
it = FlattenItemCollection(c.Collection())
|
|
}
|
|
}
|
|
if it != nil && len(it.GetLink()) > 0 {
|
|
return it.GetLink()
|
|
}
|
|
return it
|
|
}
|
|
|
|
// FlattenItemCollection flattens the Collection's properties from Object type to IRI
|
|
func FlattenItemCollection(c ItemCollection) ItemCollection {
|
|
if c != nil && len(c) > 0 {
|
|
for i, it := range c {
|
|
c[i] = FlattenToIRI(it)
|
|
}
|
|
}
|
|
return c
|
|
}
|
|
|
|
// ToItemCollection
|
|
func ToItemCollection(it Item) (*ItemCollection, error) {
|
|
switch i := it.(type) {
|
|
case *ItemCollection:
|
|
return i, nil
|
|
case ItemCollection:
|
|
return &i, nil
|
|
}
|
|
return nil, errors.New("unable to convert to item collection")
|
|
}
|
|
|
|
// ToCollection
|
|
func ToCollection(it Item) (*Collection, error) {
|
|
switch i := it.(type) {
|
|
case *Collection:
|
|
return i, nil
|
|
case Collection:
|
|
return &i, nil
|
|
}
|
|
return nil, errors.New("unable to convert to collection")
|
|
}
|
|
|
|
// ToCollectionPage
|
|
func ToCollectionPage(it Item) (*CollectionPage, error) {
|
|
switch i := it.(type) {
|
|
case *CollectionPage:
|
|
return i, nil
|
|
case CollectionPage:
|
|
return &i, nil
|
|
}
|
|
return nil, errors.New("unable to convert to collection page")
|
|
}
|
|
|
|
// ToOrderedCollection
|
|
func ToOrderedCollection(it Item) (*OrderedCollection, error) {
|
|
switch i := it.(type) {
|
|
case *OrderedCollection:
|
|
return i, nil
|
|
case OrderedCollection:
|
|
return &i, nil
|
|
}
|
|
return nil, errors.New("unable to convert to ordered collection")
|
|
}
|
|
|
|
// ToOrderedCollectionPage
|
|
func ToOrderedCollectionPage(it Item) (*OrderedCollectionPage, error) {
|
|
switch i := it.(type) {
|
|
case *OrderedCollectionPage:
|
|
return i, nil
|
|
case OrderedCollectionPage:
|
|
return &i, nil
|
|
}
|
|
return nil, errors.New("unable to convert to ordered collection page")
|
|
}
|
|
|
|
// Contains verifies if Collection array contains the received one
|
|
func (c Collection) Contains(r IRI) bool {
|
|
if len(c.Items) == 0 {
|
|
return false
|
|
}
|
|
for _, iri := range c.Items {
|
|
if r.Equals(iri.GetLink(), false) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Contains verifies if OrderedCollection array contains the received one
|
|
func (o OrderedCollection) Contains(r IRI) bool {
|
|
if len(o.OrderedItems) == 0 {
|
|
return false
|
|
}
|
|
for _, iri := range o.OrderedItems {
|
|
if r.Equals(iri.GetLink(), false) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Contains verifies if CollectionPage array contains the received one
|
|
func (c CollectionPage) Contains(r IRI) bool {
|
|
if len(c.Items) == 0 {
|
|
return false
|
|
}
|
|
for _, iri := range c.Items {
|
|
if r.Equals(iri.GetLink(), false) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Contains verifies if OrderedCollectionPage array contains the received one
|
|
func (o OrderedCollectionPage) Contains(r IRI) bool {
|
|
if len(o.OrderedItems) == 0 {
|
|
return false
|
|
}
|
|
for _, iri := range o.OrderedItems {
|
|
if r.Equals(iri.GetLink(), false) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|