Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

service

package

Go to main page

Versions in this module

v1

v1.1.4

Feb 4, 2024

Changes in this version

type BaseCommentService

+ IncreaseLike func(ctx context.Context, commentID int32) error

type OptionService

+ GetAdminURLPath func(ctx context.Context) (string, error)

type PhotoService

+ CreateBatch func(ctx context.Context, photosParam []*param.Photo) ([]*entity.Photo, error)

v1.1.3

Oct 27, 2023

v1.1.2

Oct 15, 2023

Changes in this version

type ThemeService

+ Fetch func(ctx context.Context, themeURL string) (*dto.ThemeProperty, error)

v1.1.1

Mar 19, 2023

v1.1.0

Mar 11, 2023

v1.0.8

Feb 2, 2023

v1.0.7

Jan 28, 2023

Changes in this version

type BackupType

+ const JSONData

type OptionService

+ GetActivatedThemeID func(ctx context.Context) (string, error)

v1.0.6

Dec 22, 2022

v1.0.5

Dec 18, 2022

Changes in this version

type CategoryService

+ GetByName func(ctx context.Context, name string) (*entity.Category, error)

+ type ExportImport interface

+ CreateByMarkdown func(ctx context.Context, filename string, reader io.Reader) (*entity.Post, error)

+ ExportMarkdown func(ctx context.Context, needFrontMatter bool) (string, error)

type TagService

+ GetByName func(ctx context.Context, name string) (*entity.Tag, error)

v1.0.4

Dec 3, 2022 GO-2023-1509

GO-2023-1509: Path Traversal in github.com/go-sonic/sonic

Changes in this version

type BackupService

+ ListToBackupItems func(ctx context.Context) ([]string, error)

v1.0.3

Nov 16, 2022 GO-2023-1509

GO-2023-1509: Path Traversal in github.com/go-sonic/sonic

v1.0.2

Nov 13, 2022 GO-2023-1509

GO-2023-1509: Path Traversal in github.com/go-sonic/sonic

v1.0.1

Nov 7, 2022 GO-2023-1509

GO-2023-1509: Path Traversal in github.com/go-sonic/sonic

v1.0.0

Nov 6, 2022 GO-2023-1509

GO-2023-1509: Path Traversal in github.com/go-sonic/sonic

Changes in this version

+ type AdminService interface

+ Auth func(ctx context.Context, loginParam param.LoginParam) (*dto.AuthTokenDTO, error)

+ Authenticate func(ctx context.Context, loginParam param.LoginParam) (*entity.User, error)

+ ClearToken func(ctx context.Context) error

+ GetEnvironments func(ctx context.Context) *dto.EnvironmentDTO

+ GetLogFiles func(ctx context.Context, lines int64) (string, error)

+ RefreshToken func(ctx context.Context, refreshToken string) (*dto.AuthTokenDTO, error)

+ SendResetPasswordCode func(ctx context.Context, resetParam param.ResetPasswordParam) error

+ type AttachmentService interface

+ ConvertToDTO func(ctx context.Context, attachment *entity.Attachment) (*dto.AttachmentDTO, error)

+ ConvertToDTOs func(ctx context.Context, attachments []*entity.Attachment) ([]*dto.AttachmentDTO, error)

+ Delete func(ctx context.Context, attachmentID int32) (*entity.Attachment, error)

+ DeleteBatch func(ctx context.Context, ids []int32) ([]*entity.Attachment, error)

+ GetAllMediaTypes func(ctx context.Context) ([]string, error)

+ GetAllTypes func(ctx context.Context) ([]consts.AttachmentType, error)

+ GetAttachment func(ctx context.Context, attachmentID int32) (*entity.Attachment, error)

+ Page func(ctx context.Context, queryParam *param.AttachmentQuery) ([]*entity.Attachment, int64, error)

+ Update func(ctx context.Context, id int32, updateParam *param.AttachmentUpdate) (*entity.Attachment, error)

+ Upload func(ctx context.Context, fileHeader *multipart.FileHeader) (*dto.AttachmentDTO, error)

+ type AuthenticateService interface

+ CategoryAuthenticate func(ctx context.Context, categoryID int32, password string) (bool, error)

+ PostAuthenticate func(ctx context.Context, post *entity.Post, password string) (bool, error)

+ type BackupService interface

+ BackupWholeSite func(ctx context.Context) (*dto.BackupDTO, error)

+ DeleteFile func(ctx context.Context, path string, filename string) error

+ ExportData func(ctx context.Context) (*dto.BackupDTO, error)

+ ExportMarkdown func(ctx context.Context, needFrontMatter bool) (*dto.BackupDTO, error)

+ GetBackup func(ctx context.Context, filename string, backupType BackupType) (*dto.BackupDTO, error)

+ GetBackupFilePath func(ctx context.Context, path string, filename string) (string, error)

+ ImportMarkdown func(ctx context.Context, fileHeader *multipart.FileHeader) error

+ ListFiles func(ctx context.Context, path string, backupType BackupType) ([]*dto.BackupDTO, error)

+ type BackupType string

+ const JsonData

+ const Markdown

+ const WholeSite

+ type BaseCommentService interface

+ BuildAvatarURL func(ctx context.Context, gravatarMD5 string, ...) (string, error)

+ ConvertParam func(commentParam *param.Comment) *entity.Comment

+ CountByContentID func(ctx context.Context, contentID int32, commentType consts.CommentType, ...) (int64, error)

+ CountByStatusAndContentIDs func(ctx context.Context, status consts.CommentStatus, contentIDs []int32) (map[int32]int64, error)

+ CountChildren func(ctx context.Context, parentCommentIDs []int32) (map[int32]int64, error)

+ Create func(ctx context.Context, comment *entity.Comment) (*entity.Comment, error)

+ CreateBy func(ctx context.Context, commentParam *param.Comment) (*entity.Comment, error)

+ Delete func(ctx context.Context, commentID int32) error

+ DeleteBatch func(ctx context.Context, commentIDs []int32) error

+ GetByContentID func(ctx context.Context, contentID int32, contentType consts.CommentType, ...) ([]*entity.Comment, error)

+ GetByID func(ctx context.Context, commentID int32) (*entity.Comment, error)

+ GetChildren func(ctx context.Context, parentCommentID int32, contentID int32, ...) ([]*entity.Comment, error)

+ LGetByIDs func(ctx context.Context, commentIDs []int32) ([]*entity.Comment, error)

+ Page func(ctx context.Context, commentQuery param.CommentQuery, ...) ([]*entity.Comment, int64, error)

+ Update func(ctx context.Context, comment *entity.Comment) (*entity.Comment, error)

+ UpdateStatus func(ctx context.Context, commentID int32, commentStatus consts.CommentStatus) (*entity.Comment, error)

+ UpdateStatusBatch func(ctx context.Context, commentIDs []int32, commentStatus consts.CommentStatus) ([]*entity.Comment, error)

+ type BaseMFAService interface

+ GenerateMFAQRCode func(ctx context.Context, content string) (string, error)

+ UseMFA func(mfaType consts.MFAType) bool

+ type BasePostService interface

+ BuildFullPath func(ctx context.Context, post *entity.Post) (string, error)

+ CreateOrUpdate func(ctx context.Context, post *entity.Post, categoryIDs, tagIDs []int32, ...) (*entity.Post, error)

+ Delete func(ctx context.Context, postID int32) error

+ DeleteBatch func(ctx context.Context, postIDs []int32) error

+ GenerateSummary func(ctx context.Context, htmlContent string) string

+ GetByPostID func(ctx context.Context, postID int32) (*entity.Post, error)

+ GetByPostIDs func(ctx context.Context, postIDs []int32) (map[int32]*entity.Post, error)

+ GetBySlug func(ctx context.Context, slug string) (*entity.Post, error)

+ GetByStatus func(ctx context.Context, status []consts.PostStatus, postType consts.PostType, ...) ([]*entity.Post, error)

+ IncreaseVisit func(ctx context.Context, postID int32)

+ UpdateDraftContent func(ctx context.Context, postID int32, content string) (*entity.Post, error)

+ UpdateStatus func(ctx context.Context, postID int32, status consts.PostStatus) (*entity.Post, error)

+ UpdateStatusBatch func(ctx context.Context, status consts.PostStatus, postIDs []int32) ([]*entity.Post, error)

+ type CategoryService interface

+ ConvertToCategoryDTO func(ctx context.Context, e *entity.Category) (*dto.CategoryDTO, error)

+ ConvertToCategoryDTOs func(ctx context.Context, categories []*entity.Category) ([]*dto.CategoryDTO, error)

+ Count func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, categoryParam *param.Category) (*entity.Category, error)

+ Delete func(ctx context.Context, categoryID int32) error

+ GetByID func(ctx context.Context, id int32) (*entity.Category, error)

+ GetBySlug func(ctx context.Context, slug string) (*entity.Category, error)

+ GetChildCategory func(ctx context.Context, parentCategoryID int32) ([]*entity.Category, error)

+ IsCategoriesEncrypt func(ctx context.Context, categoryIDs ...int32) (bool, error)

+ ListAll func(ctx context.Context, sort *param.Sort) ([]*entity.Category, error)

+ ListAsTree func(ctx context.Context, sort *param.Sort, fillPassword bool) ([]*vo.CategoryVO, error)

+ ListByIDs func(ctx context.Context, categoryIDs []int32) ([]*entity.Category, error)

+ ListCategoryWithPostCountDTO func(ctx context.Context, sort *param.Sort) ([]*dto.CategoryWithPostCount, error)

+ Update func(ctx context.Context, categoryParam *param.Category) (*entity.Category, error)

+ UpdateBatch func(ctx context.Context, categoryParams []*param.Category) ([]*entity.Category, error)

+ type ClientOptionService interface

+ type EmailService interface

+ SendTemplateEmail func(ctx context.Context, to, subject string, content string) error

+ SendTextEmail func(ctx context.Context, to, subject, content string) error

+ TestConnection func() error

+ type InstallService interface

+ InstallBlog func(ctx context.Context, installParam param.Install) error

+ type JournalCommentService interface

+ CountByStatus func(ctx context.Context, status consts.CommentStatus) (int64, error)

+ CountByStatusAndJournalID func(ctx context.Context, status consts.CommentStatus, journalIDs []int32) (map[int32]int64, error)

+ UpdateBy func(ctx context.Context, commentID int32, commentParam *param.Comment) (*entity.Comment, error)

+ type JournalService interface

+ ConvertToDTO func(journal *entity.Journal) *dto.Journal

+ ConvertToWithCommentDTOList func(ctx context.Context, journals []*entity.Journal) ([]*dto.JournalWithComment, error)

+ Count func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, journalParam *param.Journal) (*entity.Journal, error)

+ Delete func(ctx context.Context, journalID int32) error

+ GetByJournalIDs func(ctx context.Context, journalIDs []int32) (map[int32]*entity.Journal, error)

+ IncreaseLike func(ctx context.Context, journalID int32) error

+ ListJournal func(ctx context.Context, journalQuery param.JournalQuery) ([]*entity.Journal, int64, error)

+ Page func(ctx context.Context, page param.Page, sort *param.Sort) ([]*entity.Journal, int64, error)

+ Update func(ctx context.Context, journalID int32, journalParam *param.Journal) (*entity.Journal, error)

+ type LinkService interface

+ ConvertToDTO func(ctx context.Context, link *entity.Link) *dto.Link

+ ConvertToDTOs func(ctx context.Context, links []*entity.Link) []*dto.Link

+ ConvertToLinkTeamVO func(ctx context.Context, links []*entity.Link) []*vo.LinkTeamVO

+ Count func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, linkParam *param.Link) (*entity.Link, error)

+ Delete func(ctx context.Context, id int32) error

+ GetByID func(ctx context.Context, id int32) (*entity.Link, error)

+ List func(ctx context.Context, sort *param.Sort) ([]*entity.Link, error)

+ ListTeams func(ctx context.Context) ([]string, error)

+ Update func(ctx context.Context, id int32, linkParam *param.Link) (*entity.Link, error)

+ type LogService interface

+ Clear func(ctx context.Context) error

+ ConvertToDTO func(log *entity.Log) *dto.Log

+ PageLog func(ctx context.Context, page param.Page, sort *param.Sort) ([]*entity.Log, int64, error)

+ type MenuService interface

+ ConvertToDTO func(ctx context.Context, menu *entity.Menu) *dto.Menu

+ ConvertToDTOs func(ctx context.Context, menus []*entity.Menu) []*dto.Menu

+ Create func(ctx context.Context, menuParam *param.Menu) (*entity.Menu, error)

+ CreateBatch func(ctx context.Context, menuParams []*param.Menu) ([]*entity.Menu, error)

+ Delete func(ctx context.Context, id int32) error

+ DeleteBatch func(ctx context.Context, ids []int32) error

+ GetByID func(ctx context.Context, id int32) (*entity.Menu, error)

+ GetMenuCount func(ctx context.Context) (int64, error)

+ List func(ctx context.Context, sort *param.Sort) ([]*entity.Menu, error)

+ ListAsTree func(ctx context.Context, sort *param.Sort) ([]*vo.Menu, error)

+ ListAsTreeByTeam func(ctx context.Context, team string, sort *param.Sort) ([]*vo.Menu, error)

+ ListByTeam func(ctx context.Context, team string, sort *param.Sort) ([]*entity.Menu, error)

+ ListTeams func(ctx context.Context) ([]string, error)

+ Update func(ctx context.Context, id int32, menuParam *param.Menu) (*entity.Menu, error)

+ UpdateBatch func(ctx context.Context, menuParams []*param.Menu) ([]*entity.Menu, error)

+ type MetaService interface

+ ConvertToMetaDTO func(meta *entity.Meta) *dto.Meta

+ ConvertToMetaDTOs func(metas []*entity.Meta) []*dto.Meta

+ GetPostMeta func(ctx context.Context, postID int32) ([]*entity.Meta, error)

+ GetPostsMeta func(ctx context.Context, postIDs []int32) (map[int32][]*entity.Meta, error)

+ type OneTimeTokenService interface

+ Create func(value string) string

+ Get func(oneTimeToken string) (string, bool)

+ type OptionService interface

+ GetActivatedThemeId func(ctx context.Context) (string, error)

+ GetArchivePrefix func(ctx context.Context) (string, error)

+ GetAttachmentType func(ctx context.Context) consts.AttachmentType

+ GetBlogBaseURL func(ctx context.Context) (string, error)

+ GetCategoryPrefix func(ctx context.Context) (string, error)

+ GetIndexPageSize func(ctx context.Context) int

+ GetJournalPrefix func(ctx context.Context) (string, error)

+ GetLinkPrefix func(ctx context.Context) (string, error)

+ GetLinksPrefix func(ctx context.Context) (string, error)

+ GetOrByDefault func(ctx context.Context, p property.Property) interface{}

+ GetOrByDefaultWithErr func(ctx context.Context, p property.Property, defaultValue interface{}) (interface{}, error)

+ GetPathSuffix func(ctx context.Context) (string, error)

+ GetPhotoPrefix func(ctx context.Context) (string, error)

+ GetPostPermalinkType func(ctx context.Context) (consts.PostPermalinkType, error)

+ GetPostSort func(ctx context.Context) param.Sort

+ GetPostSummaryLength func(ctx context.Context) int

+ GetSheetPermalinkType func(ctx context.Context) (consts.SheetPermaLinkType, error)

+ GetSheetPrefix func(ctx context.Context) (string, error)

+ GetTagPrefix func(ctx context.Context) (string, error)

+ IsEnabledAbsolutePath func(ctx context.Context) (bool, error)

+ ListAllOption func(ctx context.Context) ([]*dto.Option, error)

+ Save func(ctx context.Context, optionMap map[string]string) error

+ type PhotoService interface

+ ConvertToDTO func(ctx context.Context, photo *entity.Photo) *dto.Photo

+ ConvertToDTOs func(ctx context.Context, photos []*entity.Photo) []*dto.Photo

+ Create func(ctx context.Context, photoParam *param.Photo) (*entity.Photo, error)

+ Delete func(ctx context.Context, id int32) error

+ GetByID func(ctx context.Context, id int32) (*entity.Photo, error)

+ GetPhotoCount func(ctx context.Context) (int64, error)

+ IncreaseLike func(ctx context.Context, id int32) error

+ List func(ctx context.Context, sort *param.Sort) ([]*entity.Photo, error)

+ ListByTeam func(ctx context.Context, team string, sort *param.Sort) ([]*entity.Photo, error)

+ ListTeams func(ctx context.Context) ([]string, error)

+ Page func(ctx context.Context, page param.Page, sort *param.Sort) ([]*entity.Photo, int64, error)

+ Update func(ctx context.Context, id int32, photoParam *param.Photo) (*entity.Photo, error)

+ type PostCategoryService interface

+ ListByCategoryID func(ctx context.Context, categoryID int32, status consts.PostStatus) ([]*entity.Post, error)

+ ListByPostIDs func(ctx context.Context, postIDs []int32) ([]*entity.PostCategory, error)

+ ListCategoryByPostID func(ctx context.Context, postID int32) ([]*entity.Category, error)

+ ListCategoryMapByPostID func(ctx context.Context, postIDs []int32) (map[int32][]*entity.Category, error)

+ type PostCommentService interface

+ CountByStatus func(ctx context.Context, status consts.CommentStatus) (int64, error)

+ CreateBy func(ctx context.Context, commentParam *param.Comment) (*entity.Comment, error)

+ UpdateBy func(ctx context.Context, commentID int32, commentParam *param.Comment) (*entity.Comment, error)

+ type PostService interface

+ CountByStatus func(ctx context.Context, status consts.PostStatus) (int64, error)

+ CountLike func(ctx context.Context) (int64, error)

+ CountVisit func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, postParam *param.Post) (*entity.Post, error)

+ GetNextPosts func(ctx context.Context, post *entity.Post, size int) ([]*entity.Post, error)

+ GetPrevPosts func(ctx context.Context, post *entity.Post, size int) ([]*entity.Post, error)

+ IncreaseLike func(ctx context.Context, postID int32) error

+ Page func(ctx context.Context, postQuery param.PostQuery) ([]*entity.Post, int64, error)

+ Preview func(ctx context.Context, postID int32) (string, error)

+ Update func(ctx context.Context, postID int32, postParam *param.Post) (*entity.Post, error)

+ type PostTagService interface

+ ListAllTagWithPostCount func(ctx context.Context, sort *param.Sort) ([]*dto.TagWithPostCount, error)

+ ListPostByTagID func(ctx context.Context, tagID int32, status consts.PostStatus) ([]*entity.Post, error)

+ ListTagByPostID func(ctx context.Context, postID int32) ([]*entity.Tag, error)

+ ListTagMapByPostID func(ctx context.Context, postIDs []int32) (map[int32][]*entity.Tag, error)

+ PagePost func(ctx context.Context, postQuery param.PostQuery) ([]*entity.Post, int64, error)

+ type SheetCommentService interface

+ CountByStatus func(ctx context.Context, status consts.CommentStatus) (int64, error)

+ type SheetService interface

+ CountLike func(ctx context.Context) (int64, error)

+ CountVisit func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, sheetParam *param.Sheet) (*entity.Post, error)

+ ListIndependentSheets func(ctx context.Context) ([]*dto.IndependentSheet, error)

+ Page func(ctx context.Context, page param.Page, sort *param.Sort) ([]*entity.Post, int64, error)

+ Preview func(ctx context.Context, sheetID int32) (string, error)

+ Update func(ctx context.Context, sheetID int32, sheetParam *param.Sheet) (*entity.Post, error)

+ type StatisticService interface

+ Statistic func(ctx context.Context) (*dto.Statistic, error)

+ StatisticWithUser func(ctx context.Context) (*dto.StatisticWithUser, error)

+ type TagService interface

+ ConvertToDTO func(ctx context.Context, tag *entity.Tag) (*dto.Tag, error)

+ ConvertToDTOs func(ctx context.Context, tags []*entity.Tag) ([]*dto.Tag, error)

+ CountAllTag func(ctx context.Context) (int64, error)

+ Create func(ctx context.Context, tagParam *param.Tag) (*entity.Tag, error)

+ Delete func(ctx context.Context, id int32) error

+ GetByID func(ctx context.Context, id int32) (*entity.Tag, error)

+ GetBySlug func(ctx context.Context, slug string) (*entity.Tag, error)

+ ListAll func(ctx context.Context, sort *param.Sort) ([]*entity.Tag, error)

+ ListByIDs func(ctx context.Context, tagIDs []int32) ([]*entity.Tag, error)

+ Update func(ctx context.Context, id int32, tagParam *param.Tag) (*entity.Tag, error)

+ type ThemeService interface

+ ActivateTheme func(ctx context.Context, themeID string) (*dto.ThemeProperty, error)

+ DeleteTheme func(ctx context.Context, themeID string, deleteSettings bool) error

+ DeleteThemeSettings func(ctx context.Context, themeID string) error

+ GetActivateTheme func(ctx context.Context) (*dto.ThemeProperty, error)

+ GetThemeByID func(ctx context.Context, themeID string) (*dto.ThemeProperty, error)

+ GetThemeConfig func(ctx context.Context, themeID string) ([]*dto.ThemeConfigGroup, error)

+ GetThemeFileContent func(ctx context.Context, themeID, absPath string) (string, error)

+ GetThemeGroupSettingMap func(ctx context.Context, themeID, group string) (map[string]interface{}, error)

+ GetThemeSettingMap func(ctx context.Context, themeID string) (map[string]interface{}, error)

+ ListAllTheme func(ctx context.Context) ([]*dto.ThemeProperty, error)

+ ListCustomTemplates func(ctx context.Context, themeID, prefix string) ([]string, error)

+ ListThemeFiles func(ctx context.Context, themeID string) ([]*dto.ThemeFile, error)

+ ReloadTheme func(ctx context.Context) error

+ Render func(ctx context.Context, name string) (string, error)

+ SaveThemeSettings func(ctx context.Context, themeID string, settings map[string]interface{}) error

+ TemplateExist func(ctx context.Context, template string) (bool, error)

+ UpdateThemeByUpload func(ctx context.Context, themeID string, file *multipart.FileHeader) (*dto.ThemeProperty, error)

+ UpdateThemeFile func(ctx context.Context, themeID, absPath, content string) error

+ UploadTheme func(ctx context.Context, file *multipart.FileHeader) (*dto.ThemeProperty, error)

+ type TwoFactorTOTPMFAService interface

+ GenerateOTPKey func(ctx context.Context, keyID string) (key, optURL string, err error)

+ GenerateTFACode func(tfaKey string) (string, error)

+ ValidateTFACode func(tfaKey, tfaCode string) bool

+ type UserService interface

+ ConvertToDTO func(ctx context.Context, user *entity.User) *dto.User

+ CreateByParam func(ctx context.Context, userParam param.User) (*entity.User, error)

+ EncryptPassword func(ctx context.Context, plainPassword string) string

+ GetAllUser func(ctx context.Context) ([]*entity.User, error)

+ GetByEmail func(ctx context.Context, email string) (*entity.User, error)

+ GetByID func(ctx context.Context, id int32) (*entity.User, error)

+ GetByUsername func(ctx context.Context, username string) (*entity.User, error)

+ MustNotExpire func(ctx context.Context, expireTime *time.Time) error

+ PasswordMatch func(ctx context.Context, hashedPassword, plainPassword string) bool

+ Update func(ctx context.Context, userParam *param.User) (*entity.User, error)

+ UpdateMFA func(ctx context.Context, mfaKey string, mfaType consts.MFAType, mfaCode string) error

+ UpdatePassword func(ctx context.Context, oldPassword string, newPassword string) error