2019-12-03 16:23:59 +00:00
|
|
|
package activitypub
|
2019-12-03 14:27:57 +00:00
|
|
|
|
|
|
|
import (
|
2022-01-02 15:26:06 +00:00
|
|
|
"bytes"
|
|
|
|
"encoding/gob"
|
2019-12-03 14:27:57 +00:00
|
|
|
"errors"
|
2020-07-16 19:54:46 +00:00
|
|
|
"reflect"
|
2019-12-03 14:27:57 +00:00
|
|
|
"time"
|
2019-12-18 16:34:47 +00:00
|
|
|
"unsafe"
|
2021-08-15 11:41:01 +00:00
|
|
|
|
|
|
|
"github.com/valyala/fastjson"
|
2019-12-03 14:27:57 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// IntransitiveActivity Instances of IntransitiveActivity are a subtype of Activity representing intransitive actions.
|
|
|
|
// The object property is therefore inappropriate for these activities.
|
|
|
|
type IntransitiveActivity struct {
|
|
|
|
// 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 14:27:57 +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"`
|
2019-12-03 16:23:59 +00:00
|
|
|
// CanReceiveActivities describes one or more entities that either performed or are expected to perform the activity.
|
2019-12-03 14:27:57 +00:00
|
|
|
// Any single activity can have multiple actors. The actor may be specified using an indirect Link.
|
2019-12-03 16:23:59 +00:00
|
|
|
Actor CanReceiveActivities `jsonld:"actor,omitempty"`
|
2019-12-03 14:27:57 +00:00
|
|
|
// Target describes the indirect object, or target, of the activity.
|
|
|
|
// The precise meaning of the target is largely dependent on the type of action being described
|
|
|
|
// but will often be the object of the English preposition "to".
|
|
|
|
// For instance, in the activity "John added a movie to his wishlist",
|
|
|
|
// the target of the activity is John's wishlist. An activity can have more than one target.
|
|
|
|
Target Item `jsonld:"target,omitempty"`
|
|
|
|
// Result describes the result of the activity. For instance, if a particular action results in the creation
|
|
|
|
// of a new resource, the result property can be used to describe that new resource.
|
|
|
|
Result Item `jsonld:"result,omitempty"`
|
|
|
|
// Origin describes an indirect object of the activity from which the activity is directed.
|
|
|
|
// The precise meaning of the origin is the object of the English preposition "from".
|
|
|
|
// For instance, in the activity "John moved an item to List B from List A", the origin of the activity is "List A".
|
|
|
|
Origin Item `jsonld:"origin,omitempty"`
|
|
|
|
// Instrument identifies one or more objects used (or to be used) in the completion of an Activity.
|
|
|
|
Instrument Item `jsonld:"instrument,omitempty"`
|
|
|
|
}
|
|
|
|
|
|
|
|
type (
|
|
|
|
// Arrive is an IntransitiveActivity that indicates that the actor has arrived at the location.
|
|
|
|
// The origin can be used to identify the context from which the actor originated.
|
|
|
|
// The target typically has no defined meaning.
|
|
|
|
Arrive = IntransitiveActivity
|
|
|
|
|
|
|
|
// Travel indicates that the actor is traveling to target from origin.
|
|
|
|
// Travel is an IntransitiveObject whose actor specifies the direct object.
|
|
|
|
// If the target or origin are not specified, either can be determined by context.
|
|
|
|
Travel = IntransitiveActivity
|
|
|
|
)
|
|
|
|
|
|
|
|
// Recipients performs recipient de-duplication on the Activity's To, Bto, CC and BCC properties
|
|
|
|
func (i *IntransitiveActivity) Recipients() ItemCollection {
|
2020-05-15 13:17:35 +00:00
|
|
|
return ItemCollectionDeduplication(&ItemCollection{i.Actor}, &i.To, &i.Bto, &i.CC, &i.BCC, &i.Audience)
|
2019-12-03 14:27:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Clean removes Bto and BCC properties
|
|
|
|
func (i *IntransitiveActivity) Clean() {
|
|
|
|
i.BCC = nil
|
|
|
|
i.Bto = nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetType returns the ActivityVocabulary type of the current Intransitive Activity
|
|
|
|
func (i IntransitiveActivity) GetType() ActivityVocabularyType {
|
|
|
|
return i.Type
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsLink returns false for Activity objects
|
|
|
|
func (i IntransitiveActivity) IsLink() bool {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2019-12-05 18:02:15 +00:00
|
|
|
// GetID returns the ID corresponding to the IntransitiveActivity object
|
|
|
|
func (i IntransitiveActivity) GetID() ID {
|
2019-12-03 15:26:43 +00:00
|
|
|
return i.ID
|
2019-12-03 14:27:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetLink returns the IRI corresponding to the IntransitiveActivity object
|
|
|
|
func (i IntransitiveActivity) GetLink() IRI {
|
|
|
|
return IRI(i.ID)
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsObject returns true for IntransitiveActivity objects
|
|
|
|
func (i IntransitiveActivity) IsObject() bool {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsCollection returns false for IntransitiveActivity objects
|
|
|
|
func (i IntransitiveActivity) IsCollection() bool {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2021-11-12 18:10:31 +00:00
|
|
|
// UnmarshalJSON decodes an incoming JSON document into the receiver object.
|
2019-12-03 14:27:57 +00:00
|
|
|
func (i *IntransitiveActivity) UnmarshalJSON(data []byte) error {
|
2021-08-15 11:41:01 +00:00
|
|
|
p := fastjson.Parser{}
|
|
|
|
val, err := p.ParseBytes(data)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return loadIntransitiveActivity(val, i)
|
2019-12-21 10:05:38 +00:00
|
|
|
}
|
|
|
|
|
2021-11-12 18:10:31 +00:00
|
|
|
// MarshalJSON encodes the receiver object to a JSON document.
|
2019-12-21 10:05:38 +00:00
|
|
|
func (i IntransitiveActivity) MarshalJSON() ([]byte, error) {
|
|
|
|
b := make([]byte, 0)
|
|
|
|
write(&b, '{')
|
|
|
|
|
2021-01-01 12:59:01 +00:00
|
|
|
if !writeIntransitiveActivityJSONValue(&b, i) {
|
2019-12-21 10:05:38 +00:00
|
|
|
return nil, nil
|
2019-12-03 14:27:57 +00:00
|
|
|
}
|
2019-12-21 10:05:38 +00:00
|
|
|
write(&b, '}')
|
|
|
|
return b, nil
|
2019-12-03 14:27:57 +00:00
|
|
|
}
|
|
|
|
|
2021-03-14 18:36:32 +00:00
|
|
|
// UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
|
|
|
|
func (i *IntransitiveActivity) UnmarshalBinary(data []byte) error {
|
2022-01-02 15:26:06 +00:00
|
|
|
return i.GobDecode(data)
|
2021-03-14 18:36:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// MarshalBinary implements the encoding.BinaryMarshaler interface.
|
|
|
|
func (i IntransitiveActivity) MarshalBinary() ([]byte, error) {
|
2022-01-02 15:26:06 +00:00
|
|
|
return i.GobEncode()
|
2021-03-14 18:36:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (i IntransitiveActivity) GobEncode() ([]byte, error) {
|
2022-01-02 15:26:06 +00:00
|
|
|
var mm = make(map[string][]byte)
|
|
|
|
hasData, err := mapIntransitiveActivityProperties(mm, &i)
|
|
|
|
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
|
2021-03-14 18:36:32 +00:00
|
|
|
}
|
|
|
|
|
2022-01-12 17:19:06 +00:00
|
|
|
func (i *IntransitiveActivity) GobDecode(data []byte) error {
|
|
|
|
if len(data) == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
mm, err := gobDecodeObjectAsMap(data)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return unmapIntransitiveActivityProperties(mm, i)
|
2021-03-14 18:36:32 +00:00
|
|
|
}
|
|
|
|
|
2019-12-03 14:27:57 +00:00
|
|
|
// IntransitiveActivityNew initializes a intransitive activity
|
2019-12-05 18:02:15 +00:00
|
|
|
func IntransitiveActivityNew(id ID, typ ActivityVocabularyType) *IntransitiveActivity {
|
2019-12-03 14:27:57 +00:00
|
|
|
if !IntransitiveActivityTypes.Contains(typ) {
|
|
|
|
typ = IntransitiveActivityType
|
|
|
|
}
|
|
|
|
i := IntransitiveActivity{ID: id, Type: typ}
|
|
|
|
i.Name = NaturalLanguageValuesNew()
|
|
|
|
i.Content = NaturalLanguageValuesNew()
|
|
|
|
|
|
|
|
return &i
|
|
|
|
}
|
|
|
|
|
2021-11-12 19:05:08 +00:00
|
|
|
// ToIntransitiveActivity tries to convert it Item to an IntransitiveActivity object
|
2019-12-03 14:27:57 +00:00
|
|
|
func ToIntransitiveActivity(it Item) (*IntransitiveActivity, error) {
|
|
|
|
switch i := it.(type) {
|
2019-12-18 16:34:47 +00:00
|
|
|
case *Activity:
|
|
|
|
return (*IntransitiveActivity)(unsafe.Pointer(i)), nil
|
|
|
|
case Activity:
|
|
|
|
return (*IntransitiveActivity)(unsafe.Pointer(&i)), nil
|
|
|
|
case *Question:
|
|
|
|
return (*IntransitiveActivity)(unsafe.Pointer(i)), nil
|
|
|
|
case Question:
|
|
|
|
return (*IntransitiveActivity)(unsafe.Pointer(&i)), nil
|
2019-12-03 14:27:57 +00:00
|
|
|
case *IntransitiveActivity:
|
|
|
|
return i, nil
|
|
|
|
case IntransitiveActivity:
|
|
|
|
return &i, nil
|
2020-07-16 19:54:46 +00:00
|
|
|
default:
|
|
|
|
// NOTE(marius): this is an ugly way of dealing with the interface conversion error: types from different scopes
|
|
|
|
typ := reflect.TypeOf(new(IntransitiveActivity))
|
|
|
|
if reflect.TypeOf(it).ConvertibleTo(typ) {
|
|
|
|
if i, ok := reflect.ValueOf(it).Convert(typ).Interface().(*IntransitiveActivity); ok {
|
|
|
|
return i, nil
|
|
|
|
}
|
|
|
|
}
|
2019-12-03 14:27:57 +00:00
|
|
|
}
|
|
|
|
return nil, errors.New("unable to convert to intransitive activity")
|
|
|
|
}
|
|
|
|
|
|
|
|
// ArriveNew initializes an Arrive activity
|
2019-12-05 18:02:15 +00:00
|
|
|
func ArriveNew(id ID) *Arrive {
|
2019-12-03 14:27:57 +00:00
|
|
|
a := IntransitiveActivityNew(id, ArriveType)
|
|
|
|
o := Arrive(*a)
|
|
|
|
return &o
|
|
|
|
}
|
|
|
|
|
|
|
|
// TravelNew initializes a Travel activity
|
2019-12-05 18:02:15 +00:00
|
|
|
func TravelNew(id ID) *Travel {
|
2019-12-03 14:27:57 +00:00
|
|
|
a := IntransitiveActivityNew(id, TravelType)
|
|
|
|
o := Travel(*a)
|
|
|
|
return &o
|
|
|
|
}
|