catalogaclview

Documentation

Overview

Package catalogaclview is a layer on top of catalog (same business model) which apply ACL rules before performing any action

Index

• type ACLViewCatalogAdapter
• type AlbumInView
• type ListAlbumsFilter
• type Sharing
• type View
  • func (v *View) ListAlbums(filter ListAlbumsFilter) ([]*AlbumInView, error)
  • func (v *View) ListMediasFromAlbum(albumId catalog.AlbumId) (*catalog.MediaPage, error)

Types

type ACLViewCatalogAdapter

type ACLViewCatalogAdapter interface {
	FindAllAlbums(owner ownermodel.Owner) ([]*catalog.Album, error)
	FindAlbums(keys []catalog.AlbumId) ([]*catalog.Album, error)
	ListMedias(albumId catalog.AlbumId, request catalog.PageRequest) (*catalog.MediaPage, error)
}

type AlbumInView

type AlbumInView struct {
	*catalog.Album
	SharedWith    map[usermodel.UserId]aclcore.ScopeType // SharedWith is the list of emails to which this album is shared with the scope (Visitor or Contributor)
	DirectlyOwned bool                                   // DirectlyOwned is set to true when the user is an owner of the album
}

type ListAlbumsFilter

type ListAlbumsFilter struct {
	OnlyDirectlyOwned bool // OnlyDirectlyOwned provides a sub-view where only resources directly owned by user are displayed and accessible
}

type Sharing

type Sharing struct {
	MainUser   string // MainUser is the user having the "owner:main" grant
	Owner      string
	FolderName string
}

Sharing is caring.

type View

type View struct {
	UserEmail      string                  // UserEmail from which the catalog is seen
	CatalogRules   catalogacl.CatalogRules // CatalogRules is rules to use to authorise or deny accesses
	CatalogAdapter ACLViewCatalogAdapter   // CatalogAdapter is a proxy to the catalog domain
}

func (*View) ListAlbums

func (v *View) ListAlbums(filter ListAlbumsFilter) ([]*AlbumInView, error)

ListAlbums returns albums visible by the user (owned by current user, and shared to him)

func (*View) ListMediasFromAlbum

func (v *View) ListMediasFromAlbum(albumId catalog.AlbumId) (*catalog.MediaPage, error)

ListMediasFromAlbum returns medias contained on the album if user is allowed