Skip to content

Commit

Permalink
Make Mermaid.js limit configurable
Browse files Browse the repository at this point in the history
Add `MERMAID_MAX_SOURCE_CHARACTERS` to `[markup]` settings
to make the maximum size of a mermaid render configurable.

Fix #16513

Signed-off-by: Andrew Thornton <art27@cantab.net>
  • Loading branch information
zeripath committed Jul 22, 2021
1 parent 81091c4 commit 5a45258
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 5 deletions.
9 changes: 9 additions & 0 deletions custom/conf/app.example.ini
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.)
;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
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.)

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
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
1 change: 1 addition & 0 deletions modules/templates/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@ func NewFuncMap() []template.FuncMap {
html += "</span>"
return template.HTML(html)
},
"MermaidMaxSourceCharacters": setting.MermaidMaxSourceCharacters,
}}
}

Expand Down
1 change: 1 addition & 0 deletions templates/base/head.tmpl
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
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

0 comments on commit 5a45258

Please sign in to comment.