Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Mermaid.js limit configurable #16519

Merged
merged 6 commits into from
Jul 24, 2021
Merged

Make Mermaid.js limit configurable #16519

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5a45258
Make Mermaid.js limit configurable
zeripath Jul 22, 2021
01dd8a2
fixup! Make Mermaid.js limit configurable
zeripath Jul 22, 2021
0687305
Update custom/conf/app.example.ini
zeripath Jul 23, 2021
be948a2
Merge branch 'main' into fix-16513-make-mermaid-limit-configurable
zeripath Jul 23, 2021
2a65910
Update docs/content/doc/advanced/config-cheat-sheet.en-us.md
zeripath Jul 23, 2021
b587091
Merge branch 'main' into fix-16513-make-mermaid-limit-configurable
lunny Jul 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions custom/conf/app.example.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1985,6 +1985,15 @@ PATH =
;; Show template execution time in the footer
;SHOW_FOOTER_TEMPLATE_LOAD_TIME = true


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;[markup]
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Set the maximum number of characters in a mermaid source. (Set to -1 to disable limits.)
zeripath marked this conversation as resolved.
Show resolved Hide resolved
;MERMAID_MAX_SOURCE_CHARACTERS = 5000

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;[markup.sanitizer.1]
Expand Down
2 changes: 2 additions & 0 deletions docs/content/doc/advanced/config-cheat-sheet.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,8 @@ NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take ef

## Markup (`markup`)

- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: Set the maximum size of a Mermaid source. (Set to -1 to disable.)
zeripath marked this conversation as resolved.
Show resolved Hide resolved

Gitea can support Markup using external tools. The example below will add a markup named `asciidoc`.

```ini
Expand Down
6 changes: 4 additions & 2 deletions modules/setting/markup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ import (

// ExternalMarkupRenderers represents the external markup renderers
var (
ExternalMarkupRenderers []*MarkupRenderer
ExternalSanitizerRules []MarkupSanitizerRule
ExternalMarkupRenderers []*MarkupRenderer
ExternalSanitizerRules []MarkupSanitizerRule
MermaidMaxSourceCharacters int
)

// MarkupRenderer defines the external parser configured in ini
Expand All @@ -40,6 +41,7 @@ type MarkupSanitizerRule struct {
}

func newMarkup() {
MermaidMaxSourceCharacters = Cfg.Section("markup").Key("MERMAID_MAX_SOURCE_CHARACTERS").MustInt(5000)
ExternalMarkupRenderers = make([]*MarkupRenderer, 0, 10)
ExternalSanitizerRules = make([]MarkupSanitizerRule, 0, 10)

Expand Down
3 changes: 3 additions & 0 deletions modules/templates/helper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,9 @@ func NewFuncMap() []template.FuncMap {
html += "</span>"
return template.HTML(html)
},
"MermaidMaxSourceCharacters": func() int {
return setting.MermaidMaxSourceCharacters
},
}}
}

Expand Down
1 change: 1 addition & 0 deletions templates/base/head.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
{{ end }}
]).values()),
{{end}}
MermaidMaxSourceCharacters: {{MermaidMaxSourceCharacters}},
};
</script>
<link rel="icon" href="{{AssetUrlPrefix}}/img/logo.svg" type="image/svg+xml">
Expand Down
6 changes: 3 additions & 3 deletions web_src/js/markup/mermaid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const MAX_SOURCE_CHARACTERS = 5000;
const {MermaidMaxSourceCharacters} = window.config;

function displayError(el, err) {
el.closest('pre').classList.remove('is-loading');
Expand Down Expand Up @@ -26,8 +26,8 @@ export async function renderMermaid(els) {
});

for (const el of els) {
if (el.textContent.length > MAX_SOURCE_CHARACTERS) {
displayError(el, new Error(`Mermaid source of ${el.textContent.length} characters exceeds the maximum allowed length of ${MAX_SOURCE_CHARACTERS}.`));
if (MermaidMaxSourceCharacters >= 0 && el.textContent.length > MermaidMaxSourceCharacters) {
displayError(el, new Error(`Mermaid source of ${el.textContent.length} characters exceeds the maximum allowed length of ${MermaidMaxSourceCharacters}.`));
continue;
}

Expand Down