atom/entry.go

package atomfeed

import (
	"encoding/xml"
	"errors"
	"fmt"
	"mime"
	"strings"
)

// It is advisable that each atom:entry element contain a non-empty atom:title
// element, a non-empty atom:content element when that element is present, and
// a non-empty atom:summary element when the entry contains no atom:content
// element.
type Entry struct {
	*CommonAttributes
	Authors      []*Person           `xml:"author,omitempty"`
	Categories   []*Category         `xml:"category,omitempty"`
	Content      Content             `xml:"content,omitempty"`
	Contributors []*Person           `xml:"contributors,omitempty"`
	ID           *ID                 `xml:"id"`
	Links        []*Link             `xml:"link,omitempty"`
	Published    *Date               `xml:"published,omitempty"`
	Rights       Text                `xml:"rights,omitempty"`
	Source       *Source             `xml:"source,omitempty"`
	Summary      Text                `xml:"summary,omitempty"`
	Title        Text                `xml:"title"`
	Updated      *Date               `xml:"updated"`
	Extensions   []*ExtensionElement `xml:",any,omitempty"`
}

// atom:entry elements MUST contain one or more atom:author elements, unless
// the atom:entry contains an atom:source element that contains an atom:author
// element or, in an Atom Feed Document, the atom:feed element contains an
// atom:author element itself.
func (e *Entry) checkAuthors() error {
	if e.Authors == nil {
		if e.Source.Authors == nil {
			return errors.New("no authors set in entry")
		}
	} else {
		for i, a := range e.Authors {
			if err := a.Check(); err != nil {
				return fmt.Errorf("author element %v of entry: %v", i, err)
			}
		}
	}

	return nil
}

func alternateRelExists(l []*Link) bool {
	for _, link := range l {
		if link.Rel == "alternate" {
			return true
		}
	}

	return false
}

func (e *Entry) AddExtension(name string, value any) {
	e.Extensions = append(e.Extensions, &ExtensionElement{XMLName: xml.Name{Local: name}, Value: value})
}

func (e *Entry) Check() error {
	if e.ID == nil {
		return errors.New("no id element of entry")
	} else {
		if err := e.ID.Check(); err != nil {
			return fmt.Errorf("id element of entry: %v", err)
		}
	}

	if err := e.checkAuthors(); err != nil {
		return fmt.Errorf("entry %v: %v", e.ID.URI, err)
	}

	for i, c := range e.Categories {
		if err := c.Check(); err != nil {
			return fmt.Errorf("category element %v of entry %v: %v", i, e.ID.URI, err)
		}
	}

	if e.Content != nil {
		if err := e.Content.Check(); err != nil {
			return fmt.Errorf("content element of entry %v: %v", e.ID.URI, err)
		}
	} else {
		// atom:entry elements that contain no child atom:content element MUST
		// contain at least one atom:link element with a rel attribute value of
		// "alternate".
		if !alternateRelExists(e.Links) {
			return errors.New("no content element of entry %v and no link element with rel \"alternate\"")
		}
	}

	for i, c := range e.Contributors {
		if err := c.Check(); err != nil {
			return fmt.Errorf("contributor element %v of entry %v: %v", i, e.ID.URI, err)
		}
	}

	for i, l := range e.Links {
		if err := l.Check(); err != nil {
			return fmt.Errorf("link element %v of entry %v: %v", i, e.ID.URI, err)
		}
	}
	if hasAlternateDuplicateLinks(e.Links) {
		return fmt.Errorf("links with with a rel attribute value of \"alternate\" and duplicate type and hreflang attribute values found in entry %v", e.ID.URI)
	}

	if e.Published != nil {
		if err := e.Published.Check(); err != nil {
			return fmt.Errorf("published element of entry %v: %v", e.ID.URI, err)
		}
	}

	if e.Rights != nil {
		if err := e.Rights.Check(); err != nil {
			return fmt.Errorf("rights element of entry %v: %v", e.ID.URI, err)
		}
	}

	if e.Source != nil {
		if err := e.Source.Check(); err != nil {
			return fmt.Errorf("source element of entry %v: %v", e.ID.URI, err)
		}
	}

	if e.Summary != nil {
		if err := e.Summary.Check(); err != nil {
			return fmt.Errorf("summary element of entry %v: %v", e.ID.URI, err)
		}
	} else {
		// atom:entry elements MUST contain an atom:summary element in either
		// of the following cases:
		// the atom:entry contains an atom:content that has a "src" attribute
		// (and is thus empty).
		if e.Content.hasSRC() {
			return fmt.Errorf("no summary element of entry %v but content of type out of line content", e.ID.URI)
		}
		// the atom:entry contains content that is encoded in Base64; i.e., the
		// "type" attribute of atom:content is a MIME media type [MIMEREG], but
		// is not an XML media type [RFC3023], does not begin with "text/", and
		// does not end with "/xml" or "+xml".
		mediaType, _, err := mime.ParseMediaType(e.Content.getType())
		if err != nil {
			return fmt.Errorf("type attribute of content element of entry %v: %v", e.ID.URI, err)
		}
		if !isXMLMediaType(mediaType) && !strings.HasPrefix(mediaType, "text/") {
			return fmt.Errorf("no summary element of entry %v but media type not xml", e.ID.URI)
		}
	}

	if e.Title == nil {
		return fmt.Errorf("no title element of entry %v", e.ID.URI)
	} else {
		if err := e.Title.Check(); err != nil {
			return fmt.Errorf("title element of entry %v: %v", e.ID.URI, err)
		}
	}

	if e.Updated == nil {
		return fmt.Errorf("no updated element of entry %v", e.ID.URI)
	} else {
		if err := e.Updated.Check(); err != nil {
			return fmt.Errorf("updated element of entry %v: %v", e.ID.URI, err)
		}
	}

	for i, x := range e.Extensions {
		if err := x.Check(); err != nil {
			return fmt.Errorf("extension element %v of entry %v: %v", i, e.ID.URI, err)
		}
	}

	return nil
}