Add directory support for wiki

Author: lunny

routers/web/repo/wiki.go

@@ -11,6 +11,7 @@ import (
 	"io"
 	"net/http"
 	"net/url"
+	"path"
 	"path/filepath"
 	"strings"
 
@@ -72,6 +73,7 @@ func MustEnableWiki(ctx *context.Context) {
 // PageMeta wiki page meta information
 type PageMeta struct {
 	Name         string
+	IsDir        bool
 	SubURL       string
 	GitEntryName string
 	UpdatedUnix  timeutil.TimeStamp
@@ -190,8 +192,23 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
 		return nil, nil
 	}
 
+	reqPath := util.PathJoinRelX(ctx.PathParamRaw("*"))
+	p, err := url.PathUnescape(reqPath)
+	if err != nil {
+		ctx.ServerError("PathUnescape", err)
+		return nil, nil
+	}
+	dirPath, pageName := path.Split(p)
+	pageName = strings.TrimSuffix(pageName, ".md")
+	treePath := wiki_service.WebDirPathToGitPath(wiki_service.WebPath(dirPath))
+	tree, err := commit.SubTree(treePath)
+	if err != nil {
+		ctx.ServerError("SubTree", err)
+		return nil, nil
+	}
+
 	// Get page list.
-	entries, err := commit.ListEntries()
+	entries, err := tree.ListEntries()
 	if err != nil {
 		if wikiRepo != nil {
 			wikiRepo.Close()
@@ -227,13 +244,12 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
 	ctx.Data["Pages"] = pages
 
 	// get requested page name
-	pageName := wiki_service.WebPathFromRequest(ctx.PathParamRaw("*"))
 	if len(pageName) == 0 {
 		pageName = "Home"
 	}
 
-	_, displayName := wiki_service.WebPathToUserTitle(pageName)
-	ctx.Data["PageURL"] = wiki_service.WebPathToURLPath(pageName)
+	_, displayName := wiki_service.WebPathToUserTitle(wiki_service.WebPath(pageName))
+	ctx.Data["PageURL"] = wiki_service.WebPathToURLPath(wiki_service.WebPath(pageName))
 	ctx.Data["old_title"] = displayName
 	ctx.Data["Title"] = displayName
 	ctx.Data["title"] = displayName
@@ -242,7 +258,7 @@ func renderViewPage(ctx *context.Context) (*git.Repository, *git.TreeEntry) {
 	isFooter := pageName == "_Footer"
 
 	// lookup filename in wiki - get gitTree entry , real filename
-	entry, pageFilename, noEntry, isRaw := wikiEntryByName(ctx, commit, pageName)
+	entry, pageFilename, noEntry, isRaw := wikiEntryByName(ctx, commit, wiki_service.WebPath(p))
 	if noEntry {
 		ctx.Redirect(ctx.Repo.RepoLink + "/wiki/?action=_pages")
 	}
@@ -647,7 +663,8 @@ func WikiPages(ctx *context.Context) {
 		return
 	}
 
-	treePath := "" // To support list sub folders' pages in the future
+	dirPath := util.PathJoinRelX(ctx.PathParamRaw("*"))
+	treePath := wiki_service.WebDirPathToGitPath(wiki_service.WebPath(dirPath))
 	tree, err := commit.SubTree(treePath)
 	if err != nil {
 		ctx.ServerError("SubTree", err)
@@ -669,22 +686,33 @@ func WikiPages(ctx *context.Context) {
 
 	pages := make([]PageMeta, 0, len(entries))
 	for _, entry := range entries {
-		if !entry.Entry.IsRegular() {
+		if !entry.Entry.IsRegular() && !entry.Entry.IsDir() {
 			continue
 		}
-		wikiName, err := wiki_service.GitPathToWebPath(entry.Entry.Name())
-		if err != nil {
-			if repo_model.IsErrWikiInvalidFileName(err) {
-				continue
+		var wikiName wiki_service.WebPath
+		if entry.Entry.IsDir() {
+			wikiName, err = wiki_service.GitDirPathToWebPath(entry.Entry.Name())
+			if err != nil {
+				ctx.ServerError("GitDirPathToWebPath", err)
+				return
+			}
+		} else {
+			wikiName, err = wiki_service.GitPathToWebPath(entry.Entry.Name())
+			if err != nil {
+				if repo_model.IsErrWikiInvalidFileName(err) {
+					continue
+				}
+				ctx.ServerError("GitPathToWebPath", err)
+				return
 			}
-			ctx.ServerError("WikiFilenameToName", err)
-			return
 		}
 		_, displayName := wiki_service.WebPathToUserTitle(wikiName)
+		urlPath := path.Join(string(dirPath), string(wikiName))
 		pages = append(pages, PageMeta{
 			Name:         displayName,
-			SubURL:       wiki_service.WebPathToURLPath(wikiName),
-			GitEntryName: entry.Entry.Name(),
+			IsDir:        entry.Entry.IsDir(),
+			SubURL:       wiki_service.WebPathToURLPath(wiki_service.WebPath(urlPath)),
+			GitEntryName: path.Join(string(dirPath), entry.Entry.Name()),
 			UpdatedUnix:  timeutil.TimeStamp(entry.Commit.Author.When.Unix()),
 		})
 	}

services/wiki/wiki_path.go

@@ -99,6 +99,10 @@ func WebPathToGitPath(s WebPath) string {
 		return util.PathJoinRelX(ret)
 	}
 
+	return WebDirPathToGitPath(s) + ".md"
+}
+
+func WebDirPathToGitPath(s WebPath) string {
 	a := strings.Split(string(s), "/")
 	for i := range a {
 		shouldAddDashMarker := hasDashMarker(a[i])
@@ -107,7 +111,7 @@ func WebPathToGitPath(s WebPath) string {
 		a[i] = strings.ReplaceAll(a[i], "%20", " ") // space is safe to be kept in git path
 		a[i] = strings.ReplaceAll(a[i], "+", " ")
 	}
-	return strings.Join(a, "/") + ".md"
+	return strings.Join(a, "/")
 }
 
 func GitPathToWebPath(s string) (wp WebPath, err error) {
@@ -126,6 +130,18 @@ func GitPathToWebPath(s string) (wp WebPath, err error) {
 	return WebPath(strings.Join(a, "/")), nil
 }
 
+func GitDirPathToWebPath(s string) (wp WebPath, err error) {
+	a := strings.Split(s, "/")
+	for i := range a {
+		shouldAddDashMarker := hasDashMarker(a[i])
+		if a[i], err = unescapeSegment(a[i]); err != nil {
+			return "", err
+		}
+		a[i] = escapeSegToWeb(a[i], shouldAddDashMarker)
+	}
+	return WebPath(strings.Join(a, "/")), nil
+}
+
 func WebPathToUserTitle(s WebPath) (dir, display string) {
 	dir = path.Dir(string(s))
 	display = path.Base(string(s))

templates/repo/wiki/pages.tmpl

@@ -16,8 +16,8 @@
 				{{range .Pages}}
 					<tr>
 						<td>
-							{{svg "octicon-file"}}
-							<a href="{{$.RepoLink}}/wiki/{{.SubURL}}">{{.Name}}</a>
+							{{if .IsDir}}{{svg "octicon-file-directory"}}{{else}}{{svg "octicon-file"}}{{end}}
+							<a href="{{$.RepoLink}}/wiki/{{.SubURL}}{{if .IsDir}}?action=_pages{{end}}">{{.Name}}</a>
 							<a class="wiki-git-entry" href="{{$.RepoLink}}/wiki/{{.GitEntryName | PathEscape}}" data-tooltip-content="{{ctx.Locale.Tr "repo.wiki.original_git_entry_tooltip"}}">{{svg "octicon-chevron-right"}}</a>
 						</td>
 						{{$timeSince := DateUtils.TimeSince .UpdatedUnix}}