models

package
v0.0.0-...-1b95147 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 23, 2024 License: BSD-3-Clause Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ContentTypeHtml     = "html"
	ContentTypeJson     = "json"
	ContentTypeText     = "text"
	ContentTypeMarkdown = "markdown"
	ContentTypeImage    = "image"
	ContentTypeVideo    = "video"
	ContentTypeAudio    = "audio"
	ContentTypeFile     = "file"
)
View Source 
const (
	DefaultCategoryUUIDSize = 12
	DefaultPageIDSize       = 14
)
View Source 
const ENV_CMS_API_PREFIX = "CMS_API_PREFIX"
View Source 
const KEY_CMS_API_HOST = "CMS_API_HOST"
View Source 
const KEY_CMS_EXTERNAL_UPLOADER = "CMS_EXTERNAL_UPLOADER"
View Source 
const KEY_CMS_GUEST_ACCESS_API = "CMS_GUEST_ACCESS_API"
View Source 
const KEY_CMS_MEDIA_HOST = "CMS_MEDIA_HOST"
View Source 
const KEY_CMS_MEDIA_PREFIX = "CMS_MEDIA_PREFIX"
View Source 
const KEY_CMS_RELATION_COUNT = "CMS_RELATION_COUNT"
View Source 
const KEY_CMS_SUGGESTION_COUNT = "CMS_SUGGESTION_COUNT"
View Source 
const KEY_CMS_UPLOAD_DIR = "CMS_UPLOAD_DIR"

Variables

View Source 
var ContentTypes = []carrot.AdminSelectOption{
	{Value: ContentTypeJson, Label: "JSON"},
	{Value: ContentTypeHtml, Label: "HTML"},
	{Value: ContentTypeText, Label: "PlainText"},
	{Value: ContentTypeMarkdown, Label: "Markdown"},
	{Value: ContentTypeImage, Label: "Image"},
	{Value: ContentTypeVideo, Label: "Video"},
	{Value: ContentTypeAudio, Label: "Audio"},
	{Value: ContentTypeFile, Label: "File"},
}
View Source 
var ErrDraftIsInvalid = errors.New("draft is invalid")
View Source 
var ErrInvalidPathAndName = errors.New("invalid path and name")
View Source 
var ErrPageIsNotPublish = errors.New("page is not publish")
View Source 
var ErrPostIsNotPublish = errors.New("post is not publish")
View Source 
var ErrUnauthorized = errors.New("unauthorized")
View Source 
var ErrUploadsDirNotConfigured = errors.New("uploads dir not configured")

Functions

func CreateFolder 

func CreateFolder(db *gorm.DB, parent, name string, user *carrot.User) (string, error)

func GetTagsByCategory 

func GetTagsByCategory(db *gorm.DB, contentType string, form *TagsForm) ([]string, error)

Query tags by category

func MakeDuplicate 

func MakeDuplicate(db *gorm.DB, obj any) error

func MakeMediaPublish 

func MakeMediaPublish(db *gorm.DB, siteID, path, name string, obj any, publish bool) error

func MakePublish 

func MakePublish(db *gorm.DB, siteID, ID string, obj any, publish bool) error

func PrepareStoreLocalDir 

func PrepareStoreLocalDir(db *gorm.DB) (string, error)

func QueryContentByTags 

func QueryContentByTags(db *gorm.DB, contentType string, form *QueryByTagsForm) ([]string, error)

func QueryTags 

func QueryTags(db *gorm.DB) ([]string, error)

func RemoveDirectory 

func RemoveDirectory(db *gorm.DB, path string) (string, error)

func RemoveFile 

func RemoveFile(db *gorm.DB, path, name string) error

func SafeDraft 

func SafeDraft(db *gorm.DB, siteID, ID string, obj any, draft string) error

func StoreExternal 

func StoreExternal(externalUploader, path, name string, data []byte) (string, error)

func StoreLocal 

func StoreLocal(uploadDir, storePath string, data []byte) (string, error)

Types

type BaseContent 

type BaseContent struct {
	UpdatedAt   time.Time    `json:"updatedAt" gorm:"index"`
	CreatedAt   time.Time    `json:"createdAt" gorm:"index"`
	Thumbnail   string       `json:"thumbnail,omitempty" gorm:"size:500"`
	Tags        string       `json:"tags,omitempty" gorm:"size:200;index"`
	Title       string       `json:"title,omitempty" gorm:"size:200"`
	Alt         string       `json:"alt,omitempty"`
	Description string       `json:"description,omitempty"`
	Keywords    string       `json:"keywords,omitempty"`
	CreatorID   uint         `json:"-"`
	Creator     carrot.User  `json:"-"`
	Author      string       `json:"author" gorm:"size:64"`
	Published   bool         `json:"published"`
	PublishedAt sql.NullTime `json:"publishedAt" gorm:"index"`
	ContentType string       `json:"contentType" gorm:"size:32"`
	Remark      string       `json:"remark"`
}

type Category 

type Category struct {
	SiteID string        `json:"siteId" gorm:"uniqueIndex:,composite:_site_uuid"`
	Site   Site          `json:"-"`
	UUID   string        `json:"uuid" gorm:"size:12;uniqueIndex:,composite:_site_uuid"`
	Name   string        `json:"name" gorm:"size:200"`
	Items  CategoryItems `json:"items,omitempty"`
	Count  int           `json:"count" gorm:"-"`
}

func QueryCategoryWithCount 

func QueryCategoryWithCount(db *gorm.DB, siteId, contentObject string) ([]Category, error)

func (*Category) FindItem 

func (category *Category) FindItem(path string) *CategoryItem

type CategoryItem 

type CategoryItem struct {
	Path     string        `json:"path"`
	Name     string        `json:"name"`
	Icon     *ContentIcon  `json:"icon,omitempty"`
	Children CategoryItems `json:"children,omitempty"`
	Count    int           `json:"count" gorm:"-"`
}

func (*CategoryItem) Scan 

func (s *CategoryItem) Scan(input interface{}) error

func (CategoryItem) Value 

func (s CategoryItem) Value() (driver.Value, error)

type CategoryItems 

type CategoryItems []CategoryItem

func (*CategoryItems) Scan 

func (s *CategoryItems) Scan(input interface{}) error

func (CategoryItems) Value 

func (s CategoryItems) Value() (driver.Value, error)

type ContentIcon 

type ContentIcon carrot.AdminIcon

func (*ContentIcon) Scan 

func (s *ContentIcon) Scan(input interface{}) error

func (ContentIcon) Value 

func (s ContentIcon) Value() (driver.Value, error)

type ContentQueryResult 

type ContentQueryResult struct {
	*carrot.QueryResult
	Relations   []RelationContent `json:"relations,omitempty"`
	Suggestions []RelationContent `json:"suggestions,omitempty"`
}

type Media 

type Media struct {
	BaseContent
	Size       int64  `json:"size"`
	Directory  bool   `json:"directory" gorm:"index"`
	Path       string `json:"path" gorm:"size:200;uniqueIndex:,composite:_path_name"`
	Name       string `json:"name" gorm:"size:200;uniqueIndex:,composite:_path_name"`
	Ext        string `json:"ext" gorm:"size:100"`
	Dimensions string `json:"dimensions" gorm:"size:200"` // x*y
	StorePath  string `json:"-" gorm:"size:300"`
	External   bool   `json:"external"`
	PublicUrl  string `json:"publicUrl,omitempty" gorm:"-"`
}

func GetMedia 

func GetMedia(db *gorm.DB, path, name string) (*Media, error)

func (*Media) BuildPublicUrls 

func (m *Media) BuildPublicUrls(mediaHost string, mediaPrefix string)

type MediaFolder 

type MediaFolder struct {
	Name         string `json:"name"`
	Path         string `json:"path"`
	FilesCount   int64  `json:"filesCount"`
	FoldersCount int64  `json:"foldersCount"`
}

func ListFolders 

func ListFolders(db *gorm.DB, path string) ([]MediaFolder, error)

type Page 

type Page struct {
	BaseContent
	SiteID       string `json:"siteId" gorm:"primaryKey;uniqueIndex:,composite:_site_id"`
	Site         Site   `json:"-"`
	ID           string `json:"id" gorm:"primaryKey;size:100;uniqueIndex:,composite:_site_id"`
	IsDraft      bool   `json:"isDraft"`
	Draft        string `json:"-"`
	Body         string `json:"body"`
	PreviewURL   string `json:"previewUrl,omitempty" gorm:"size:200"`
	CategoryID   string `json:"categoryId,omitempty" gorm:"size:64;index:,composite:_category_id_path" label:"Category"`
	CategoryPath string `json:"categoryPath,omitempty" gorm:"size:64;index:,composite:_category_id_path"`
}

type Post 

type Post struct {
	BaseContent
	SiteID       string `json:"siteId" gorm:"primaryKey;uniqueIndex:,composite:_site_id"`
	Site         Site   `json:"-"`
	ID           string `json:"id" gorm:"primaryKey;size:100;uniqueIndex:,composite:_site_id"`
	IsDraft      bool   `json:"isDraft"`
	Draft        string `json:"-"`
	Body         string `json:"body"`
	PreviewURL   string `json:"previewUrl,omitempty" gorm:"size:200"`
	CategoryID   string `json:"categoryId,omitempty" gorm:"size:64;index:,composite:_category_id_path" label:"Category"`
	CategoryPath string `json:"categoryPath,omitempty" gorm:"size:64;index:,composite:_category_id_path"`
}

type PublishLog 

type PublishLog struct {
	ID        uint        `json:"id" gorm:"primarykey"`
	CreatedAt time.Time   `json:"createdAt"`
	AuthorID  uint        `json:"-"`
	Author    carrot.User `json:"author"`
	Content   string      `json:"content" gorm:"size:12;index:idx_content_with_id"`    // post_id or page_id
	ContentID string      `json:"contentId" gorm:"size:100;index:idx_content_with_id"` // post_id or page_id
	Body      string      `json:"body"`
}

type QueryByTagsForm 

type QueryByTagsForm struct {
	Tags  []string `json:"tags" binding:"required"`
	Limit int      `json:"limit"`
	Pos   int      `json:"pos"`
	TagsForm
}

type QueryByTagsResult 

type QueryByTagsResult struct {
	Items []any `json:"items"`
	Total int   `json:"total"`
	Limit int   `json:"limit"`
	Pos   int   `json:"pos"`
}

type RelationContent 

type RelationContent struct {
	BaseContent
	SiteID string `json:"siteId"`
	ID     string `json:"id"`
}

func GetRelations 

func GetRelations(db *gorm.DB, siteId, categoryId, categoryPath, postId string, maxCount int) ([]RelationContent, error)

func GetSuggestions 

func GetSuggestions(db *gorm.DB, siteId, categoryId, categoryPath, postId string, maxCount int) ([]RelationContent, error)

type RenderCategory 

type RenderCategory struct {
	UUID     string `json:"uuid"`
	Name     string `json:"name"`
	Path     string `json:"path,omitempty"`
	PathName string `json:"pathName,omitempty"`
}

func NewRenderCategory 

func NewRenderCategory(db *gorm.DB, categoryID, categoryPath string) *RenderCategory

type RenderContent 

type RenderContent struct {
	BaseContent
	ID          string            `json:"id"`
	SiteID      string            `json:"siteId"`
	Category    *RenderCategory   `json:"category,omitempty"`
	PageData    any               `json:"data,omitempty"`
	PostBody    string            `json:"body,omitempty"`
	IsDraft     bool              `json:"isDraft"`
	Relations   []RelationContent `json:"relations,omitempty"`
	Suggestions []RelationContent `json:"suggestions,omitempty"`
}

func NewRenderContentFromPage 

func NewRenderContentFromPage(db *gorm.DB, page *Page) *RenderContent

func NewRenderContentFromPost 

func NewRenderContentFromPost(db *gorm.DB, post *Post, relations bool) *RenderContent

type Site 

type Site struct {
	UpdatedAt time.Time `json:"updatedAt"`
	CreatedAt time.Time `json:"createdAt"`
	Domain    string    `json:"domain" gorm:"primarykey;size:200"`
	Name      string    `json:"name" gorm:"size:200"`
	Preview   string    `json:"preview" gorm:"size:200"`
	Disallow  bool      `json:"disallow"`
}

func (Site) String 

func (s Site) String() string

type StringArray 

type StringArray []string

func (*StringArray) Scan 

func (s *StringArray) Scan(input interface{}) error

func (StringArray) Value 

func (s StringArray) Value() (driver.Value, error)

type SummaryResult 

type SummaryResult struct {
	SiteCount     int64            `json:"sites"`
	PageCount     int64            `json:"pages"`
	PostCount     int64            `json:"posts"`
	CategoryCount int64            `json:"categories"`
	MediaCount    int64            `json:"media"`
	LatestPosts   []*RenderContent `json:"latestPosts"`
	BuildTime     string           `json:"buildTime"`
	CanExport     bool             `json:"canExport"`
}

func GetSummary 

func GetSummary(db *gorm.DB) (result SummaryResult)

type TagsForm 

type TagsForm struct {
	SiteId       string `json:"siteId"`
	CategoryId   string `json:"categoryId"`
	CategoryPath string `json:"categoryPath"`
}

type UploadResult 

type UploadResult struct {
	PublicUrl   string `json:"publicUrl"`
	Thumbnail   string `json:"thumbnail"`
	Path        string `json:"path"`
	Name        string `json:"name"`
	External    bool   `json:"external"`
	StorePath   string `json:"storePath"`
	Dimensions  string `json:"dimensions"`
	Ext         string `json:"ext"`
	Size        int64  `json:"size"`
	ContentType string `json:"contentType"`
}

func UploadFile 

func UploadFile(db *gorm.DB, path, name string, reader io.Reader) (*UploadResult, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.