package propertyurl import ( "fmt" anyuri "github.com/go-fed/activity/streams/values/anyURI" vocab "github.com/go-fed/activity/streams/vocab" "net/url" ) // UrlPropertyIterator is an iterator for a property. It is permitted to be one of // multiple value types. At most, one type of value can be present, or none at // all. Setting a value will clear the other types of values so that only one // of the 'Is' methods will return true. It is possible to clear all values, // so that this property is empty. type UrlPropertyIterator struct { anyURIMember *url.URL LinkMember vocab.LinkInterface unknown []byte iri *url.URL alias string myIdx int parent vocab.UrlPropertyInterface } // NewUrlPropertyIterator creates a new url property. func NewUrlPropertyIterator() *UrlPropertyIterator { return &UrlPropertyIterator{alias: ""} } // deserializeUrlPropertyIterator creates an iterator from an element that has // been unmarshalled from a text or binary format. func deserializeUrlPropertyIterator(i interface{}, aliasMap map[string]string) (*UrlPropertyIterator, error) { alias := "" if a, ok := aliasMap["https://www.w3.org/TR/activitystreams-vocabulary"]; ok { alias = a } if m, ok := i.(map[string]interface{}); ok { if v, err := mgr.DeserializeLinkActivityStreams()(m, aliasMap); err != nil { this := &UrlPropertyIterator{ LinkMember: v, alias: alias, } return this, nil } } else if v, err := anyuri.DeserializeAnyURI(i); err != nil { this := &UrlPropertyIterator{ alias: alias, anyURIMember: v, } return this, nil } else if v, ok := i.([]byte); ok { this := &UrlPropertyIterator{ alias: alias, unknown: v, } return this, nil } return nil, fmt.Errorf("could not deserialize %q property", "url") } // GetAnyURI returns the value of this property. When IsAnyURI returns false, // GetAnyURI will return an arbitrary value. func (this UrlPropertyIterator) GetAnyURI() *url.URL { return this.anyURIMember } // GetIRI returns the IRI of this property. When IsIRI returns false, GetIRI will // return an arbitrary value. func (this UrlPropertyIterator) GetIRI() *url.URL { return this.iri } // GetLink returns the value of this property. When IsLink returns false, GetLink // will return an arbitrary value. func (this UrlPropertyIterator) GetLink() vocab.LinkInterface { return this.LinkMember } // HasAny returns true if any of the different values is set. func (this UrlPropertyIterator) HasAny() bool { return this.IsAnyURI() || this.IsLink() || this.iri != nil } // IsAnyURI returns true if this property has a type of "anyURI". When true, use // the GetAnyURI and SetAnyURI methods to access and set this property. func (this UrlPropertyIterator) IsAnyURI() bool { return this.anyURIMember != nil } // IsIRI returns true if this property is an IRI. When true, use GetIRI and SetIRI // to access and set this property func (this UrlPropertyIterator) IsIRI() bool { return this.iri != nil } // IsLink returns true if this property has a type of "Link". When true, use the // GetLink and SetLink methods to access and set this property. func (this UrlPropertyIterator) IsLink() bool { return this.LinkMember != nil } // JSONLDContext returns the JSONLD URIs required in the context string for this // property and the specific values that are set. The value in the map is the // alias used to import the property's value or values. func (this UrlPropertyIterator) JSONLDContext() map[string]string { m := map[string]string{"https://www.w3.org/TR/activitystreams-vocabulary": this.alias} var child map[string]string if this.IsLink() { child = this.GetLink().JSONLDContext() } /* Since the literal maps in this function are determined at code-generation time, this loop should not overwrite an existing key with a new value. */ for k, v := range child { m[k] = v } return m } // KindIndex computes an arbitrary value for indexing this kind of value. This is // a leaky API detail only for folks looking to replace the go-fed // implementation. Applications should not use this method. func (this UrlPropertyIterator) KindIndex() int { if this.IsAnyURI() { return 0 } if this.IsLink() { return 1 } if this.IsIRI() { return -2 } return -1 } // LessThan compares two instances of this property with an arbitrary but stable // comparison. Applications should not use this because it is only meant to // help alternative implementations to go-fed to be able to normalize // nonfunctional properties. func (this UrlPropertyIterator) LessThan(o vocab.UrlPropertyIteratorInterface) bool { idx1 := this.KindIndex() idx2 := o.KindIndex() if idx1 < idx2 { return true } else if idx1 > idx2 { return false } else if this.IsAnyURI() { return anyuri.LessAnyURI(this.GetAnyURI(), o.GetAnyURI()) } else if this.IsLink() { return this.GetLink().LessThan(o.GetLink()) } else if this.IsIRI() { return this.iri.String() < o.GetIRI().String() } return false } // Name returns the name of this property: "url". func (this UrlPropertyIterator) Name() string { return "url" } // Next returns the next iterator, or nil if there is no next iterator. func (this UrlPropertyIterator) Next() vocab.UrlPropertyIteratorInterface { if this.myIdx+1 >= this.parent.Len() { return nil } else { return this.parent.At(this.myIdx + 1) } } // Prev returns the previous iterator, or nil if there is no previous iterator. func (this UrlPropertyIterator) Prev() vocab.UrlPropertyIteratorInterface { if this.myIdx-1 < 0 { return nil } else { return this.parent.At(this.myIdx - 1) } } // SetAnyURI sets the value of this property. Calling IsAnyURI afterwards returns // true. func (this *UrlPropertyIterator) SetAnyURI(v *url.URL) { this.clear() this.anyURIMember = v } // SetIRI sets the value of this property. Calling IsIRI afterwards returns true. func (this *UrlPropertyIterator) SetIRI(v *url.URL) { this.clear() this.iri = v } // SetLink sets the value of this property. Calling IsLink afterwards returns true. func (this *UrlPropertyIterator) SetLink(v vocab.LinkInterface) { this.clear() this.LinkMember = v } // clear ensures no value of this property is set. Calling HasAny or any of the // 'Is' methods afterwards will return false. func (this *UrlPropertyIterator) clear() { this.anyURIMember = nil this.LinkMember = nil this.unknown = nil this.iri = nil } // serialize converts this into an interface representation suitable for // marshalling into a text or binary format. Applications should not need this // function as most typical use cases serialize types instead of individual // properties. It is exposed for alternatives to go-fed implementations to use. func (this UrlPropertyIterator) serialize() (interface{}, error) { if this.IsAnyURI() { return anyuri.SerializeAnyURI(this.GetAnyURI()) } else if this.IsLink() { return this.GetLink().Serialize() } else if this.IsIRI() { return this.iri.String(), nil } return this.unknown, nil } // UrlProperty is the non-functional property "url". It is permitted to have one // or more values, and of different value types. type UrlProperty struct { properties []*UrlPropertyIterator alias string } // DeserializeUrlProperty creates a "url" property from an interface // representation that has been unmarshalled from a text or binary format. func DeserializeUrlProperty(m map[string]interface{}, aliasMap map[string]string) (vocab.UrlPropertyInterface, error) { alias := "" if a, ok := aliasMap["https://www.w3.org/TR/activitystreams-vocabulary"]; ok { alias = a } var this *UrlProperty propName := "url" if len(alias) > 0 { propName = fmt.Sprintf("%s:%s", alias, "url") } if i, ok := m[propName]; ok { this := &UrlProperty{ alias: alias, properties: []*UrlPropertyIterator{}, } if list, ok := i.([]interface{}); ok { for _, iterator := range list { if p, err := deserializeUrlPropertyIterator(iterator, aliasMap); err != nil { return this, err } else if p != nil { this.properties = append(this.properties, p) } } } else { if p, err := deserializeUrlPropertyIterator(i, aliasMap); err != nil { return this, err } else if p != nil { this.properties = append(this.properties, p) } } // Set up the properties for iteration. for idx, ele := range this.properties { ele.parent = this ele.myIdx = idx } } return this, nil } // NewUrlProperty creates a new url property. func NewUrlProperty() *UrlProperty { return &UrlProperty{alias: ""} } // AppendAnyURI appends a anyURI value to the back of a list of the property // "url". Invalidates iterators that are traversing using Prev. func (this *UrlProperty) AppendAnyURI(v *url.URL) { this.properties = append(this.properties, &UrlPropertyIterator{ alias: this.alias, anyURIMember: v, myIdx: this.Len(), parent: this, }) } // AppendIRI appends an IRI value to the back of a list of the property "url" func (this *UrlProperty) AppendIRI(v *url.URL) { this.properties = append(this.properties, &UrlPropertyIterator{ alias: this.alias, iri: v, myIdx: this.Len(), parent: this, }) } // AppendLink appends a Link value to the back of a list of the property "url". // Invalidates iterators that are traversing using Prev. func (this *UrlProperty) AppendLink(v vocab.LinkInterface) { this.properties = append(this.properties, &UrlPropertyIterator{ LinkMember: v, alias: this.alias, myIdx: this.Len(), parent: this, }) } // At returns the property value for the specified index. Panics if the index is // out of bounds. func (this UrlProperty) At(index int) vocab.UrlPropertyIteratorInterface { return this.properties[index] } // Begin returns the first iterator, or nil if empty. Can be used with the // iterator's Next method and this property's End method to iterate from front // to back through all values. func (this UrlProperty) Begin() vocab.UrlPropertyIteratorInterface { if this.Empty() { return nil } else { return this.properties[0] } } // Empty returns returns true if there are no elements. func (this UrlProperty) Empty() bool { return this.Len() == 0 } // End returns beyond-the-last iterator, which is nil. Can be used with the // iterator's Next method and this property's Begin method to iterate from // front to back through all values. func (this UrlProperty) End() vocab.UrlPropertyIteratorInterface { return nil } // JSONLDContext returns the JSONLD URIs required in the context string for this // property and the specific values that are set. The value in the map is the // alias used to import the property's value or values. func (this UrlProperty) JSONLDContext() map[string]string { m := map[string]string{"https://www.w3.org/TR/activitystreams-vocabulary": this.alias} for _, elem := range this.properties { child := elem.JSONLDContext() /* Since the literal maps in this function are determined at code-generation time, this loop should not overwrite an existing key with a new value. */ for k, v := range child { m[k] = v } } return m } // KindIndex computes an arbitrary value for indexing this kind of value. This is // a leaky API method specifically needed only for alternate implementations // for go-fed. Applications should not use this method. Panics if the index is // out of bounds. func (this UrlProperty) KindIndex(idx int) int { return this.properties[idx].KindIndex() } // Len returns the number of values that exist for the "url" property. func (this UrlProperty) Len() (length int) { return len(this.properties) } // Less computes whether another property is less than this one. Mixing types // results in a consistent but arbitrary ordering func (this UrlProperty) Less(i, j int) bool { idx1 := this.KindIndex(i) idx2 := this.KindIndex(j) if idx1 < idx2 { return true } else if idx1 == idx2 { if idx1 == 0 { lhs := this.properties[i].GetAnyURI() rhs := this.properties[j].GetAnyURI() return anyuri.LessAnyURI(lhs, rhs) } else if idx1 == 1 { lhs := this.properties[i].GetLink() rhs := this.properties[j].GetLink() return lhs.LessThan(rhs) } else if idx1 == -2 { lhs := this.properties[i].GetIRI() rhs := this.properties[j].GetIRI() return lhs.String() < rhs.String() } } return false } // LessThan compares two instances of this property with an arbitrary but stable // comparison. Applications should not use this because it is only meant to // help alternative implementations to go-fed to be able to normalize // nonfunctional properties. func (this UrlProperty) LessThan(o vocab.UrlPropertyInterface) bool { l1 := this.Len() l2 := o.Len() l := l1 if l2 < l1 { l = l2 } for i := 0; i < l; i++ { if this.properties[i].LessThan(o.At(i)) { return true } else if o.At(i).LessThan(this.properties[i]) { return false } } return l1 < l2 } // Name returns the name of this property: "url". func (this UrlProperty) Name() string { return "url" } // PrependAnyURI prepends a anyURI value to the front of a list of the property // "url". Invalidates all iterators. func (this *UrlProperty) PrependAnyURI(v *url.URL) { this.properties = append([]*UrlPropertyIterator{{ alias: this.alias, anyURIMember: v, myIdx: 0, parent: this, }}, this.properties...) for i := 1; i < this.Len(); i++ { (this.properties)[i].myIdx = i } } // PrependIRI prepends an IRI value to the front of a list of the property "url". func (this *UrlProperty) PrependIRI(v *url.URL) { this.properties = append([]*UrlPropertyIterator{{ alias: this.alias, iri: v, myIdx: 0, parent: this, }}, this.properties...) for i := 1; i < this.Len(); i++ { (this.properties)[i].myIdx = i } } // PrependLink prepends a Link value to the front of a list of the property "url". // Invalidates all iterators. func (this *UrlProperty) PrependLink(v vocab.LinkInterface) { this.properties = append([]*UrlPropertyIterator{{ LinkMember: v, alias: this.alias, myIdx: 0, parent: this, }}, this.properties...) for i := 1; i < this.Len(); i++ { (this.properties)[i].myIdx = i } } // Remove deletes an element at the specified index from a list of the property // "url", regardless of its type. Panics if the index is out of bounds. // Invalidates all iterators. func (this *UrlProperty) Remove(idx int) { (this.properties)[idx].parent = nil copy((this.properties)[idx:], (this.properties)[idx+1:]) (this.properties)[len(this.properties)-1] = &UrlPropertyIterator{} this.properties = (this.properties)[:len(this.properties)-1] for i := idx; i < this.Len(); i++ { (this.properties)[i].myIdx = i } } // Serialize converts this into an interface representation suitable for // marshalling into a text or binary format. Applications should not need this // function as most typical use cases serialize types instead of individual // properties. It is exposed for alternatives to go-fed implementations to use. func (this UrlProperty) Serialize() (interface{}, error) { s := make([]interface{}, 0, len(this.properties)) for _, iterator := range this.properties { if b, err := iterator.serialize(); err != nil { return s, err } else { s = append(s, b) } } return s, nil } // SetAnyURI sets a anyURI value to be at the specified index for the property // "url". Panics if the index is out of bounds. Invalidates all iterators. func (this *UrlProperty) SetAnyURI(idx int, v *url.URL) { (this.properties)[idx].parent = nil (this.properties)[idx] = &UrlPropertyIterator{ alias: this.alias, anyURIMember: v, myIdx: idx, parent: this, } } // SetIRI sets an IRI value to be at the specified index for the property "url". // Panics if the index is out of bounds. func (this *UrlProperty) SetIRI(idx int, v *url.URL) { (this.properties)[idx].parent = nil (this.properties)[idx] = &UrlPropertyIterator{ alias: this.alias, iri: v, myIdx: idx, parent: this, } } // SetLink sets a Link value to be at the specified index for the property "url". // Panics if the index is out of bounds. Invalidates all iterators. func (this *UrlProperty) SetLink(idx int, v vocab.LinkInterface) { (this.properties)[idx].parent = nil (this.properties)[idx] = &UrlPropertyIterator{ LinkMember: v, alias: this.alias, myIdx: idx, parent: this, } } // Swap swaps the location of values at two indices for the "url" property. func (this UrlProperty) Swap(i, j int) { this.properties[i], this.properties[j] = this.properties[j], this.properties[i] }