From 47ca61d8ba41f363745f6d0f93cb8efafa92564b Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Thu, 13 Jun 2024 09:06:46 +0800 Subject: [PATCH] Improve detecting empty files (#31332) Co-authored-by: silverwind --- options/locale/locale_en-US.ini | 1 + routers/web/repo/blame.go | 2 -- routers/web/repo/setting/lfs.go | 1 + routers/web/repo/view.go | 7 +++---- templates/repo/blame.tmpl | 2 ++ templates/repo/file_info.tmpl | 4 ++-- templates/repo/settings/lfs_file.tmpl | 6 ++---- templates/repo/view_file.tmpl | 2 ++ templates/shared/fileisempty.tmpl | 3 +++ templates/shared/filetoolarge.tmpl | 2 +- web_src/css/repo.css | 12 ++++++++++++ 11 files changed, 29 insertions(+), 13 deletions(-) create mode 100644 templates/shared/fileisempty.tmpl diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 539715b3f9c..fbada5472c5 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -1238,6 +1238,7 @@ file_view_rendered = View Rendered file_view_raw = View Raw file_permalink = Permalink file_too_large = The file is too large to be shown. +file_is_empty = The file is empty. code_preview_line_from_to = Lines %[1]d to %[2]d in %[3]s code_preview_line_in = Line %[1]d in %[2]s invisible_runes_header = `This file contains invisible Unicode characters` diff --git a/routers/web/repo/blame.go b/routers/web/repo/blame.go index 1887e4d95da..3e76ea6df43 100644 --- a/routers/web/repo/blame.go +++ b/routers/web/repo/blame.go @@ -99,8 +99,6 @@ func RefBlame(ctx *context.Context) { } ctx.Data["NumLines"], err = blob.GetBlobLineCount() - ctx.Data["NumLinesSet"] = true - if err != nil { ctx.NotFound("GetBlobLineCount", err) return diff --git a/routers/web/repo/setting/lfs.go b/routers/web/repo/setting/lfs.go index 6dddade066e..2891556d6fc 100644 --- a/routers/web/repo/setting/lfs.go +++ b/routers/web/repo/setting/lfs.go @@ -303,6 +303,7 @@ func LFSFileGet(ctx *context.Context) { rd := charset.ToUTF8WithFallbackReader(io.MultiReader(bytes.NewReader(buf), dataRc), charset.ConvertOpts{}) // Building code view blocks with line number on server side. + // FIXME: the logic is not right here: it first calls EscapeControlReader then calls HTMLEscapeString: double-escaping escapedContent := &bytes.Buffer{} ctx.Data["EscapeStatus"], _ = charset.EscapeControlReader(rd, escapedContent, ctx.Locale) diff --git a/routers/web/repo/view.go b/routers/web/repo/view.go index 386ef7be5ce..0aa3fe1efd7 100644 --- a/routers/web/repo/view.go +++ b/routers/web/repo/view.go @@ -286,6 +286,7 @@ func renderReadmeFile(ctx *context.Context, subfolder string, readmeFile *git.Tr ctx.Data["FileIsText"] = fInfo.isTextFile ctx.Data["FileName"] = path.Join(subfolder, readmeFile.Name()) + ctx.Data["FileSize"] = fInfo.fileSize ctx.Data["IsLFSFile"] = fInfo.isLFSFile if fInfo.isLFSFile { @@ -301,7 +302,6 @@ func renderReadmeFile(ctx *context.Context, subfolder string, readmeFile *git.Tr // Pretend that this is a normal text file to display 'This file is too large to be shown' ctx.Data["IsFileTooLarge"] = true ctx.Data["IsTextFile"] = true - ctx.Data["FileSize"] = fInfo.fileSize return } @@ -552,7 +552,6 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry) { } else { ctx.Data["NumLines"] = bytes.Count(buf, []byte{'\n'}) + 1 } - ctx.Data["NumLinesSet"] = true language, err := files_service.TryGetContentLanguage(ctx.Repo.GitRepo, ctx.Repo.CommitID, ctx.Repo.TreePath) if err != nil { @@ -606,8 +605,8 @@ func renderFile(ctx *context.Context, entry *git.TreeEntry) { break } - // TODO: this logic seems strange, it duplicates with "isRepresentableAsText=true", it is not the same as "LFSFileGet" in "lfs.go" - // maybe for this case, the file is a binary file, and shouldn't be rendered? + // TODO: this logic duplicates with "isRepresentableAsText=true", it is not the same as "LFSFileGet" in "lfs.go" + // It is used by "external renders", markupRender will execute external programs to get rendered content. if markupType := markup.Type(blob.Name()); markupType != "" { rd := io.MultiReader(bytes.NewReader(buf), dataRc) ctx.Data["IsMarkup"] = true diff --git a/templates/repo/blame.tmpl b/templates/repo/blame.tmpl index 4ad3ed85c9a..3e7cd920662 100644 --- a/templates/repo/blame.tmpl +++ b/templates/repo/blame.tmpl @@ -32,6 +32,8 @@
{{if .IsFileTooLarge}} {{template "shared/filetoolarge" dict "RawFileLink" .RawFileLink}} + {{else if not .FileSize}} + {{template "shared/fileisempty"}} {{else}} diff --git a/templates/repo/file_info.tmpl b/templates/repo/file_info.tmpl index 823cf1b7d8c..b63af68973d 100644 --- a/templates/repo/file_info.tmpl +++ b/templates/repo/file_info.tmpl @@ -4,12 +4,12 @@ {{ctx.Locale.Tr "repo.symbolic_link"}} {{end}} - {{if .NumLinesSet}}{{/* Explicit attribute needed to show 0 line changes */}} + {{if ne .NumLines nil}}
{{.NumLines}} {{ctx.Locale.TrN .NumLines "repo.line" "repo.lines"}}
{{end}} - {{if .FileSize}} + {{if ne .FileSize nil}}
{{FileSize .FileSize}}{{if .IsLFSFile}} ({{ctx.Locale.Tr "repo.stored_lfs"}}){{end}}
diff --git a/templates/repo/settings/lfs_file.tmpl b/templates/repo/settings/lfs_file.tmpl index a015cc8bd1a..f6fac05b691 100644 --- a/templates/repo/settings/lfs_file.tmpl +++ b/templates/repo/settings/lfs_file.tmpl @@ -16,10 +16,8 @@
{{if .IsFileTooLarge}} {{template "shared/filetoolarge" dict "RawFileLink" .RawFileLink}} - {{else if .IsMarkup}} - {{if .FileContent}}{{.FileContent | SafeHTML}}{{end}} - {{else if .IsPlainText}} - 
{{if .FileContent}}{{.FileContent | SafeHTML}}{{end}}
+ {{else if not .FileSize}} + {{template "shared/fileisempty"}} {{else if not .IsTextFile}}
{{if .IsImageFile}} diff --git a/templates/repo/view_file.tmpl b/templates/repo/view_file.tmpl index 0a34b6c325b..0ec400cfe91 100644 --- a/templates/repo/view_file.tmpl +++ b/templates/repo/view_file.tmpl @@ -91,6 +91,8 @@
{{if .IsFileTooLarge}} {{template "shared/filetoolarge" dict "RawFileLink" .RawFileLink}} + {{else if not .FileSize}} + {{template "shared/fileisempty"}} {{else if .IsMarkup}} {{if .FileContent}}{{.FileContent}}{{end}} {{else if .IsPlainText}} diff --git a/templates/shared/fileisempty.tmpl b/templates/shared/fileisempty.tmpl new file mode 100644 index 00000000000..a92bcbcdbcd --- /dev/null +++ b/templates/shared/fileisempty.tmpl @@ -0,0 +1,3 @@ +
+ {{ctx.Locale.Tr "repo.file_is_empty"}} +
diff --git a/templates/shared/filetoolarge.tmpl b/templates/shared/filetoolarge.tmpl index 8842fb1b911..cb23864ec8e 100644 --- a/templates/shared/filetoolarge.tmpl +++ b/templates/shared/filetoolarge.tmpl @@ -1,4 +1,4 @@ -
+
{{ctx.Locale.Tr "repo.file_too_large"}} {{if .RawFileLink}}{{ctx.Locale.Tr "repo.file_view_raw"}}{{end}}
diff --git a/web_src/css/repo.css b/web_src/css/repo.css index 0e3d06650e1..357a4ee1950 100644 --- a/web_src/css/repo.css +++ b/web_src/css/repo.css @@ -1706,6 +1706,18 @@ td .commit-summary { .file-view.markup { padding: 1em 2em; } + +.file-view.markup:has(.file-not-rendered-prompt) { + padding: 0; /* let the file-not-rendered-prompt layout itself */ +} + +.file-not-rendered-prompt { + padding: 1rem; + text-align: center; + font-size: 1rem !important; /* use consistent styles for various containers (code, markup, etc) */ + line-height: var(--line-height-default) !important; /* same as above */ +} + .repository .activity-header { display: flex; justify-content: space-between;