Skip to content

Commit

Permalink
chore: update general setting
Browse files Browse the repository at this point in the history
  • Loading branch information
@boojack
boojack committed May 29, 2024
1 parent 423861d commit b215426
Show file tree
Hide file tree
Showing 8 changed files with 242 additions and 458 deletions.
3 changes: 0 additions & 3 deletions docs/apidocs.swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2077,9 +2077,6 @@ definitions:
apiv1WorkspaceGeneralSetting:
type: object
properties:
instanceUrl:
type: string
description: instance_url is the instance URL.
disallowSignup:
type: boolean
description: disallow_signup is the flag to disallow signup.
Expand Down
12 changes: 5 additions & 7 deletions proto/api/v1/workspace_setting_service.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,16 @@ message WorkspaceSetting {
}

message WorkspaceGeneralSetting {
// instance_url is the instance URL.
string instance_url = 1;
// disallow_signup is the flag to disallow signup.
bool disallow_signup = 2;
bool disallow_signup = 1;
// disallow_password_login is the flag to disallow password login.
bool disallow_password_login = 3;
bool disallow_password_login = 2;
// additional_script is the additional script.
string additional_script = 4;
string additional_script = 3;
// additional_style is the additional style.
string additional_style = 5;
string additional_style = 4;
// custom_profile is the custom profile.
WorkspaceCustomProfile custom_profile = 6;
WorkspaceCustomProfile custom_profile = 5;
}

message WorkspaceCustomProfile {
Expand Down
261 changes: 125 additions & 136 deletions proto/gen/api/v1/workspace_setting_service.pb.go
View file

Large diffs are not rendered by default.

217 changes: 103 additions & 114 deletions proto/gen/store/workspace_setting.pb.go
View file

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions proto/store/workspace_setting.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,16 @@ message WorkspaceBasicSetting {
}

message WorkspaceGeneralSetting {
// instance_url is the instance URL.
string instance_url = 1;
// disallow_signup is the flag to disallow signup.
bool disallow_signup = 2;
bool disallow_signup = 1;
// disallow_password_login is the flag to disallow password login.
bool disallow_password_login = 3;
bool disallow_password_login = 2;
// additional_script is the additional script.
string additional_script = 4;
string additional_script = 3;
// additional_style is the additional style.
string additional_style = 5;
string additional_style = 4;
// custom_profile is the custom profile.
WorkspaceCustomProfile custom_profile = 6;
WorkspaceCustomProfile custom_profile = 5;
}

message WorkspaceCustomProfile {
Expand Down
2 changes: 0 additions & 2 deletions server/router/api/v1/workspace_setting_service.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ func convertWorkspaceGeneralSettingFromStore(setting *storepb.WorkspaceGeneralSe
return nil
}
generalSetting := &v1pb.WorkspaceGeneralSetting{
InstanceUrl: setting.InstanceUrl,
DisallowSignup: setting.DisallowSignup,
DisallowPasswordLogin: setting.DisallowPasswordLogin,
AdditionalScript: setting.AdditionalScript,
Expand All @@ -144,7 +143,6 @@ func convertWorkspaceGeneralSettingToStore(setting *v1pb.WorkspaceGeneralSetting
return nil
}
generalSetting := &storepb.WorkspaceGeneralSetting{
InstanceUrl: setting.InstanceUrl,
DisallowSignup: setting.DisallowSignup,
DisallowPasswordLogin: setting.DisallowPasswordLogin,
AdditionalScript: setting.AdditionalScript,
Expand Down
145 changes: 4 additions & 141 deletions server/router/frontend/frontend.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,11 @@ package frontend
import (
"context"
"embed"
"fmt"
"io/fs"
"net/http"
"strings"

"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/yourselfhosted/gomark/parser"
"github.com/yourselfhosted/gomark/parser/tokenizer"
"github.com/yourselfhosted/gomark/renderer"

"github.com/usememos/memos/internal/util"
"github.com/usememos/memos/server/profile"
Expand All @@ -22,11 +17,6 @@ import (
//go:embed dist
var embeddedFiles embed.FS

const (
// maxMetadataDescriptionLength is the maximum length of metadata description.
maxMetadataDescriptionLength = 256
)

type FrontendService struct {
Profile *profile.Profile
Store *store.Store
Expand All @@ -41,7 +31,7 @@ func NewFrontendService(profile *profile.Profile, store *store.Store) *FrontendS

func (s *FrontendService) Serve(ctx context.Context, e *echo.Echo) {

Check failure on line 32 in server/router/frontend/frontend.go

View workflow job for this annotation

GitHub Actions / go-static-checks 

unused-parameter: parameter 'ctx' seems to be unused, consider removing or renaming it as _ (revive)
skipper := func(c echo.Context) bool {
return util.HasPrefixes(c.Path(), "/o", "/api", "/memos.api.v1", "/robots.txt", "/sitemap.xml", "/m/:name")
return util.HasPrefixes(c.Path(), "/api", "/memos.api.v1")
}

// Use echo static middleware to serve the built dist folder.
Expand All @@ -51,151 +41,24 @@ func (s *FrontendService) Serve(ctx context.Context, e *echo.Echo) {
Filesystem: getFileSystem("dist"),
Skipper: skipper,
}))
g := e.Group("assets")
// Use echo gzip middleware to compress the response.
// Reference: https://echo.labstack.com/docs/middleware/gzip
g.Use(middleware.GzipWithConfig(middleware.GzipConfig{
e.Group("assets").Use(middleware.GzipWithConfig(middleware.GzipConfig{
Level: 5,
}))
g.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
}), func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
c.Response().Header().Set(echo.HeaderCacheControl, "max-age=31536000, immutable")
return next(c)
}
})
g.Use(middleware.StaticWithConfig(middleware.StaticConfig{
}, middleware.StaticWithConfig(middleware.StaticConfig{
Filesystem: getFileSystem("dist/assets"),
}))

s.registerRoutes(e)
s.registerFileRoutes(ctx, e)
}

func (s *FrontendService) registerRoutes(e *echo.Echo) {
rawIndexHTML := getRawIndexHTML()

e.GET("/m/:uid", func(c echo.Context) error {
ctx := c.Request().Context()
uid := c.Param("uid")
memo, err := s.Store.GetMemo(ctx, &store.FindMemo{
UID: &uid,
})
if err != nil {
return c.HTML(http.StatusOK, rawIndexHTML)
}
if memo == nil {
return c.HTML(http.StatusOK, rawIndexHTML)
}
creator, err := s.Store.GetUser(ctx, &store.FindUser{
ID: &memo.CreatorID,
})
if err != nil {
return c.HTML(http.StatusOK, rawIndexHTML)
}

// Inject memo metadata into `index.html`.
indexHTML := strings.ReplaceAll(rawIndexHTML, "<!-- memos.metadata.head -->", generateMemoMetadata(memo, creator).String())
indexHTML = strings.ReplaceAll(indexHTML, "<!-- memos.metadata.body -->", fmt.Sprintf("<!-- memos.memo.%d -->", memo.ID))
return c.HTML(http.StatusOK, indexHTML)
})
}

func (s *FrontendService) registerFileRoutes(ctx context.Context, e *echo.Echo) {
workspaceGeneralSetting, err := s.Store.GetWorkspaceGeneralSetting(ctx)
if err != nil {
return
}
instanceURL := workspaceGeneralSetting.GetInstanceUrl()
if instanceURL == "" {
return
}

e.GET("/robots.txt", func(c echo.Context) error {
robotsTxt := fmt.Sprintf(`User-agent: *
Allow: /
Host: %s
Sitemap: %s/sitemap.xml`, instanceURL, instanceURL)
return c.String(http.StatusOK, robotsTxt)
})

e.GET("/sitemap.xml", func(c echo.Context) error {
ctx := c.Request().Context()
urlsets := []string{}
// Append memo list.
memoList, err := s.Store.ListMemos(ctx, &store.FindMemo{
VisibilityList: []store.Visibility{store.Public},
})
if err != nil {
return err
}
for _, memo := range memoList {
urlsets = append(urlsets, fmt.Sprintf(`<url><loc>%s</loc></url>`, fmt.Sprintf("%s/m/%s", instanceURL, memo.UID)))
}
sitemap := fmt.Sprintf(`<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">%s</urlset>`, strings.Join(urlsets, "\n"))
return c.XMLBlob(http.StatusOK, []byte(sitemap))
})
}

func getFileSystem(path string) http.FileSystem {
fs, err := fs.Sub(embeddedFiles, path)
if err != nil {
panic(err)
}

return http.FS(fs)
}

func generateMemoMetadata(memo *store.Memo, creator *store.User) *Metadata {
metadata := getDefaultMetadata()
metadata.Title = fmt.Sprintf("%s(@%s) on Memos", creator.Nickname, creator.Username)
if memo.Visibility == store.Public {
tokens := tokenizer.Tokenize(memo.Content)
nodes, _ := parser.Parse(tokens)
description := renderer.NewStringRenderer().Render(nodes)
if len(description) == 0 {
description = memo.Content
}
if len(description) > maxMetadataDescriptionLength {
description = description[:maxMetadataDescriptionLength] + "..."
}
metadata.Description = description
}

return metadata
}

func getRawIndexHTML() string {
bytes, _ := embeddedFiles.ReadFile("dist/index.html")
return string(bytes)
}

type Metadata struct {
Title string
Description string
ImageURL string
}

func getDefaultMetadata() *Metadata {
return &Metadata{
Title: "Memos",
Description: "A privacy-first, lightweight note-taking service. Easily capture and share your great thoughts.",
ImageURL: "/logo.webp",
}
}

func (m *Metadata) String() string {
metadataList := []string{
fmt.Sprintf(`<meta name="description" content="%s" />`, m.Description),
fmt.Sprintf(`<meta property="og:title" content="%s" />`, m.Title),
fmt.Sprintf(`<meta property="og:description" content="%s" />`, m.Description),
fmt.Sprintf(`<meta property="og:image" content="%s" />`, m.ImageURL),
`<meta property="og:type" content="website" />`,
// Twitter related fields.
fmt.Sprintf(`<meta property="twitter:title" content="%s" />`, m.Title),
fmt.Sprintf(`<meta property="twitter:description" content="%s" />`, m.Description),
fmt.Sprintf(`<meta property="twitter:image" content="%s" />`, m.ImageURL),
`<meta name="twitter:card" content="summary" />`,
`<meta name="twitter:creator" content="memos" />`,
}
return strings.Join(metadataList, "\n")
}
48 changes: 0 additions & 48 deletions web/src/components/Settings/WorkspaceSection.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,26 +64,6 @@ const WorkspaceSection = () => {
showUpdateCustomizedProfileDialog();
};

const handleInstanceUrlChanged = (value: string) => {
setWorkspaceGeneralSetting({ ...workspaceGeneralSetting, instanceUrl: value });
};

const handleSaveInstanceUrl = async () => {
try {
await workspaceSettingServiceClient.setWorkspaceSetting({
setting: {
name: `${WorkspaceSettingPrefix}${WorkspaceSettingKey.GENERAL}`,
generalSetting: workspaceGeneralSetting,
},
});
} catch (error: any) {
console.error(error);
toast.error(error.response.data.message);
return;
}
toast.success("Instance URL updated");
};

const handleAdditionalStyleChanged = (value: string) => {
setWorkspaceGeneralSetting({ ...workspaceGeneralSetting, additionalStyle: value });
};
Expand Down Expand Up @@ -196,34 +176,6 @@ const WorkspaceSection = () => {
onChange={(event) => handleDisablePasswordLoginChanged(event.target.checked)}
/>
</div>
<div className="space-y-2 border rounded-md py-2 px-3 dark:border-zinc-700">
<div className="w-full flex flex-row justify-between items-center">
<div className="flex flex-row items-center">
<div className="w-auto flex items-center">
<span className="mr-1">Instance URL</span>
</div>
</div>
<Button variant="outlined" color="neutral" onClick={handleSaveInstanceUrl}>
{t("common.save")}
</Button>
</div>
<Input
className="w-full"
placeholder={"Should be started with http:// or https://"}
value={workspaceGeneralSetting.instanceUrl}
onChange={(event) => handleInstanceUrlChanged(event.target.value)}
/>
<div className="w-full">
<Link
className="text-gray-500 text-sm inline-flex flex-row justify-start items-center hover:underline hover:text-blue-600"
to="https://usememos.com/docs/advanced-settings/seo"
target="_blank"
>
{t("common.learn-more")}
<Icon.ExternalLink className="inline w-4 h-auto ml-1" />
</Link>
</div>
</div>
<div className="space-y-2 border rounded-md py-2 px-3 dark:border-zinc-700">
<div className="w-full flex flex-row justify-between items-center">
<span>{t("setting.system-section.additional-style")}</span>
Expand Down

0 comments on commit b215426

Please sign in to comment.