From 90d5e02cca934cdf8d582873f5bf13e710c12393 Mon Sep 17 00:00:00 2001 From: James Moger Date: Thu, 24 Oct 2013 15:44:44 -0400 Subject: [PATCH] Remove "show readme" flag in favor of automatic detection Automatic detection also will now also display a plain text "readme" or "readme.txt" file. Change-Id: Id6be729bdc469e7a5cfd1f4144df340a6b93475e --- releases.moxie | 2 + src/main/java/com/gitblit/GitBlit.java | 2 - .../gitblit/client/EditRepositoryDialog.java | 7 -- .../com/gitblit/models/RepositoryModel.java | 2 - .../java/com/gitblit/utils/MarkdownUtils.java | 15 +++++ .../wicket/pages/EditRepositoryPage.html | 25 ++++--- .../wicket/pages/EditRepositoryPage.java | 1 - .../gitblit/wicket/pages/RepositoryPage.java | 2 +- .../com/gitblit/wicket/pages/SummaryPage.html | 11 ++- .../com/gitblit/wicket/pages/SummaryPage.java | 67 +++++++++++-------- 10 files changed, 78 insertions(+), 56 deletions(-) diff --git a/releases.moxie b/releases.moxie index 6dfb7446..df1ecce4 100644 --- a/releases.moxie +++ b/releases.moxie @@ -23,6 +23,8 @@ r20: { - Updated default binary and Lucene ignore extensions - Change the WAR baseFolder context parameter to a JNDI env-entry to improve enterprise deployments - Removed internal Gitblit ref exclusions in the upload pack + - Removed "show readme" setting in favor of automatic detection + - Support plain text "readme" files additions: - Added branch graph image servlet based on EGit's branch graph renderer (issue-194) - Added option to render Markdown commit messages (issue-203) diff --git a/src/main/java/com/gitblit/GitBlit.java b/src/main/java/com/gitblit/GitBlit.java index a23dd8c2..f313b6e3 100644 --- a/src/main/java/com/gitblit/GitBlit.java +++ b/src/main/java/com/gitblit/GitBlit.java @@ -2015,7 +2015,6 @@ public class GitBlit implements ServletContextListener { model.verifyCommitter = getConfig(config, "verifyCommitter", false); model.showRemoteBranches = getConfig(config, "showRemoteBranches", hasOrigin); model.isFrozen = getConfig(config, "isFrozen", false); - model.showReadme = getConfig(config, "showReadme", false); model.skipSizeCalculation = getConfig(config, "skipSizeCalculation", false); model.skipSummaryMetrics = getConfig(config, "skipSummaryMetrics", false); model.commitMessageRenderer = CommitMessageRenderer.fromName(getConfig(config, "commitMessageRenderer", @@ -2578,7 +2577,6 @@ public class GitBlit implements ServletContextListener { config.setBoolean(Constants.CONFIG_GITBLIT, null, "verifyCommitter", repository.verifyCommitter); config.setBoolean(Constants.CONFIG_GITBLIT, null, "showRemoteBranches", repository.showRemoteBranches); config.setBoolean(Constants.CONFIG_GITBLIT, null, "isFrozen", repository.isFrozen); - config.setBoolean(Constants.CONFIG_GITBLIT, null, "showReadme", repository.showReadme); config.setBoolean(Constants.CONFIG_GITBLIT, null, "skipSizeCalculation", repository.skipSizeCalculation); config.setBoolean(Constants.CONFIG_GITBLIT, null, "skipSummaryMetrics", repository.skipSummaryMetrics); config.setString(Constants.CONFIG_GITBLIT, null, "federationStrategy", diff --git a/src/main/java/com/gitblit/client/EditRepositoryDialog.java b/src/main/java/com/gitblit/client/EditRepositoryDialog.java index f4d94505..1c499ee1 100644 --- a/src/main/java/com/gitblit/client/EditRepositoryDialog.java +++ b/src/main/java/com/gitblit/client/EditRepositoryDialog.java @@ -94,8 +94,6 @@ public class EditRepositoryDialog extends JDialog { private JCheckBox showRemoteBranches; - private JCheckBox showReadme; - private JCheckBox skipSizeCalculation; private JCheckBox skipSummaryMetrics; @@ -216,8 +214,6 @@ public class EditRepositoryDialog extends JDialog { showRemoteBranches = new JCheckBox( Translation.get("gb.showRemoteBranchesDescription"), anRepository.showRemoteBranches); - showReadme = new JCheckBox(Translation.get("gb.showReadmeDescription"), - anRepository.showReadme); skipSizeCalculation = new JCheckBox( Translation.get("gb.skipSizeCalculationDescription"), anRepository.skipSizeCalculation); @@ -312,8 +308,6 @@ public class EditRepositoryDialog extends JDialog { .add(newFieldPanel(Translation.get("gb.enableIncrementalPushTags"), useIncrementalPushTags)); fieldsPanel.add(newFieldPanel(Translation.get("gb.showRemoteBranches"), showRemoteBranches)); - fieldsPanel.add(newFieldPanel(Translation.get("gb.showReadme"), - showReadme)); fieldsPanel .add(newFieldPanel(Translation.get("gb.skipSizeCalculation"), skipSizeCalculation)); @@ -567,7 +561,6 @@ public class EditRepositoryDialog extends JDialog { repository.useDocs = useDocs.isSelected(); repository.useIncrementalPushTags = useIncrementalPushTags.isSelected(); repository.showRemoteBranches = showRemoteBranches.isSelected(); - repository.showReadme = showReadme.isSelected(); repository.skipSizeCalculation = skipSizeCalculation.isSelected(); repository.skipSummaryMetrics = skipSummaryMetrics.isSelected(); repository.maxActivityCommits = (Integer) maxActivityCommits.getSelectedItem(); diff --git a/src/main/java/com/gitblit/models/RepositoryModel.java b/src/main/java/com/gitblit/models/RepositoryModel.java index 2476834a..88854652 100644 --- a/src/main/java/com/gitblit/models/RepositoryModel.java +++ b/src/main/java/com/gitblit/models/RepositoryModel.java @@ -58,7 +58,6 @@ public class RepositoryModel implements Serializable, Comparable federationSets; public boolean isFederated; @@ -208,7 +207,6 @@ public class RepositoryModel implements Serializable, Comparable$1"); + String html = "
" + text + "
"; + return html; + } + + /** * Returns the html version of the markdown source text. * diff --git a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html index 6e41a7de..d8939e75 100644 --- a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html +++ b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html @@ -36,14 +36,13 @@ - - - - -   + + + + @@ -52,15 +51,15 @@
- + - + - - - + + + @@ -73,7 +72,7 @@
- +
diff --git a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java index cde60314..f0afb57c 100644 --- a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java +++ b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java @@ -448,7 +448,6 @@ public class EditRepositoryPage extends RootSubPage { form.add(new CheckBox("useDocs")); form.add(new CheckBox("useIncrementalPushTags")); form.add(new CheckBox("showRemoteBranches")); - form.add(new CheckBox("showReadme")); form.add(new CheckBox("skipSizeCalculation")); form.add(new CheckBox("skipSummaryMetrics")); List maxActivityCommits = Arrays.asList(-1, 0, 25, 50, 75, 100, 150, 200, 250, 500 ); diff --git a/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java b/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java index dabaed03..b31bc3b5 100644 --- a/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java +++ b/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java @@ -204,7 +204,7 @@ public abstract class RepositoryPage extends RootPage { // conditional links // per-repository extra page links - if (model.showReadme || model.useDocs) { + if (model.useDocs) { pages.put("docs", new PageRegistration("gb.docs", DocsPage.class, params, true)); } if (JGitUtils.getPagesBranch(r) != null) { diff --git a/src/main/java/com/gitblit/wicket/pages/SummaryPage.html b/src/main/java/com/gitblit/wicket/pages/SummaryPage.html index 3dd1eb4b..69cd3903 100644 --- a/src/main/java/com/gitblit/wicket/pages/SummaryPage.html +++ b/src/main/java/com/gitblit/wicket/pages/SummaryPage.html @@ -48,7 +48,16 @@
- + + +
+ + +
+
+
+
+ diff --git a/src/main/java/com/gitblit/wicket/pages/SummaryPage.java b/src/main/java/com/gitblit/wicket/pages/SummaryPage.java index cc9697c6..0a138371 100644 --- a/src/main/java/com/gitblit/wicket/pages/SummaryPage.java +++ b/src/main/java/com/gitblit/wicket/pages/SummaryPage.java @@ -137,47 +137,56 @@ public class SummaryPage extends RepositoryPage { add(new TagsPanel("tagsPanel", repositoryName, r, numberRefs).hideIfEmpty()); add(new BranchesPanel("branchesPanel", getRepositoryModel(), r, numberRefs, false).hideIfEmpty()); - if (getRepositoryModel().showReadme) { - String htmlText = null; - String markdownText = null; - String readme = null; - try { - RevCommit head = JGitUtils.getCommit(r, null); - List markdownExtensions = GitBlit.getStrings(Keys.web.markdownExtensions); - List paths = JGitUtils.getFilesInPath(r, null, head); - for (PathModel path : paths) { - if (!path.isTree()) { - String name = path.name.toLowerCase(); - - if (name.startsWith("readme")) { - if (name.indexOf('.') > -1) { - String ext = name.substring(name.lastIndexOf('.') + 1); - if (markdownExtensions.contains(ext)) { - readme = path.name; - break; - } + String htmlText = null; + String markdownText = null; + String readme = null; + boolean isMarkdown = false; + try { + RevCommit head = JGitUtils.getCommit(r, null); + List markdownExtensions = GitBlit.getStrings(Keys.web.markdownExtensions); + List paths = JGitUtils.getFilesInPath(r, null, head); + for (PathModel path : paths) { + if (!path.isTree()) { + String name = path.name.toLowerCase(); + if (name.equals("readme") || name.equals("readme.txt")) { + readme = path.name; + isMarkdown = false; + } else if (name.startsWith("readme")) { + if (name.indexOf('.') > -1) { + String ext = name.substring(name.lastIndexOf('.') + 1); + if (markdownExtensions.contains(ext)) { + readme = path.name; + isMarkdown = true; + break; } } } } - if (!StringUtils.isEmpty(readme)) { - String [] encodings = GitBlit.getEncodings(); - markdownText = JGitUtils.getStringContent(r, head.getTree(), readme, encodings); + } + if (!StringUtils.isEmpty(readme)) { + String [] encodings = GitBlit.getEncodings(); + markdownText = JGitUtils.getStringContent(r, head.getTree(), readme, encodings); + if (isMarkdown) { htmlText = MarkdownUtils.transformMarkdown(markdownText); + } else { + htmlText = MarkdownUtils.transformPlainText(markdownText); } - } catch (Exception e) { - logger.error("failed to transform markdown", e); - markdownText = MessageFormat.format("
{0}: {1}
{2}", getString("gb.error"), getString("gb.markdownFailure"), markdownText); - htmlText = StringUtils.breakLinesForHtml(markdownText); } - Fragment fragment = new Fragment("readme", "markdownPanel"); + } catch (Exception e) { + logger.error("failed to transform markdown", e); + markdownText = MessageFormat.format("
{0}: {1}
{2}", getString("gb.error"), getString("gb.markdownFailure"), markdownText); + htmlText = MarkdownUtils.transformPlainText(markdownText); + } + + if (StringUtils.isEmpty(htmlText)) { + add(new Label("readme").setVisible(false)); + } else { + Fragment fragment = new Fragment("readme", isMarkdown ? "markdownPanel" : "plaintextPanel"); fragment.add(new Label("readmeFile", readme)); // Add the html to the page Component content = new Label("readmeContent", htmlText).setEscapeModelStrings(false); fragment.add(content.setVisible(!StringUtils.isEmpty(htmlText))); add(fragment); - } else { - add(new Label("readme").setVisible(false)); } // Display an activity line graph -- 2.39.5