From ed21d23885c2f112e5c5650e9436870b1ac99392 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Tue, 05 Jul 2011 17:32:45 -0400
Subject: [PATCH] Documentation. Added JavaDoc. Clarified repository access restriction.
---
src/com/gitblit/wicket/pages/SummaryPage.java | 181 +++++++++++++++++++++++---------------------
1 files changed, 95 insertions(+), 86 deletions(-)
diff --git a/src/com/gitblit/wicket/pages/SummaryPage.java b/src/com/gitblit/wicket/pages/SummaryPage.java
index c596e87..e753e5d 100644
--- a/src/com/gitblit/wicket/pages/SummaryPage.java
+++ b/src/com/gitblit/wicket/pages/SummaryPage.java
@@ -1,18 +1,32 @@
+/*
+ * Copyright 2011 gitblit.com.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package com.gitblit.wicket.pages;
import java.awt.Color;
import java.awt.Dimension;
import java.text.MessageFormat;
+import java.text.ParseException;
import java.util.ArrayList;
import java.util.List;
-import javax.servlet.http.HttpServletRequest;
-
import org.apache.wicket.PageParameters;
import org.apache.wicket.markup.html.basic.Label;
-import org.apache.wicket.protocol.http.WebRequest;
+import org.apache.wicket.markup.html.link.BookmarkablePageLink;
import org.eclipse.jgit.lib.Repository;
-import org.wicketstuff.googlecharts.AbstractChartData;
+import org.eclipse.jgit.revwalk.RevCommit;
import org.wicketstuff.googlecharts.Chart;
import org.wicketstuff.googlecharts.ChartAxis;
import org.wicketstuff.googlecharts.ChartAxisType;
@@ -27,12 +41,14 @@
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.GitBlit;
import com.gitblit.Keys;
+import com.gitblit.models.Metric;
+import com.gitblit.models.PathModel;
import com.gitblit.utils.JGitUtils;
+import com.gitblit.utils.MarkdownUtils;
+import com.gitblit.utils.MetricUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.TimeUtils;
-import com.gitblit.wicket.RepositoryPage;
import com.gitblit.wicket.WicketUtils;
-import com.gitblit.wicket.models.Metric;
import com.gitblit.wicket.panels.BranchesPanel;
import com.gitblit.wicket.panels.LogPanel;
import com.gitblit.wicket.panels.TagsPanel;
@@ -42,68 +58,64 @@
public SummaryPage(PageParameters params) {
super(params);
- int numCommitsDef = 20;
- int numRefsDef = 5;
-
- int numberCommits = GitBlit.self().settings().getInteger(Keys.web.summaryCommitCount, numCommitsDef);
+ int numberCommits = GitBlit.getInteger(Keys.web.summaryCommitCount, 20);
if (numberCommits <= 0) {
- numberCommits = numCommitsDef;
+ numberCommits = 20;
}
-
- int numberRefs = GitBlit.self().settings().getInteger(Keys.web.summaryRefsCount, numRefsDef);
- if (numberRefs <= 0) {
- numberRefs = numRefsDef;
- }
+ int numberRefs = GitBlit.getInteger(Keys.web.summaryRefsCount, 5);
Repository r = getRepository();
List<Metric> metrics = null;
Metric metricsTotal = null;
- if (GitBlit.self().settings().getBoolean(Keys.web.generateActivityGraph, true)) {
- metrics = JGitUtils.getDateMetrics(r);
+ if (GitBlit.getBoolean(Keys.web.generateActivityGraph, true)) {
+ metrics = MetricUtils.getDateMetrics(r, null, true, null);
metricsTotal = metrics.remove(0);
}
+
+ addSyndicationDiscoveryLink();
// repository description
add(new Label("repositoryDescription", getRepositoryModel().description));
add(new Label("repositoryOwner", getRepositoryModel().owner));
- add(WicketUtils.createTimestampLabel("repositoryLastChange", JGitUtils.getLastChange(r), getTimeZone()));
+ add(WicketUtils.createTimestampLabel("repositoryLastChange", JGitUtils.getLastChange(r, null),
+ getTimeZone()));
if (metricsTotal == null) {
- add(new Label("repositoryStats", ""));
+ add(new Label("branchStats", ""));
} else {
- add(new Label("repositoryStats", MessageFormat.format("{0} commits and {1} tags in {2}", metricsTotal.count, metricsTotal.tag, TimeUtils.duration(metricsTotal.duration))));
+ add(new Label("branchStats",
+ MessageFormat.format("{0} commits and {1} tags in {2}", metricsTotal.count,
+ metricsTotal.tag, TimeUtils.duration(metricsTotal.duration))));
}
+ add(new BookmarkablePageLink<Void>("metrics", MetricsPage.class,
+ WicketUtils.newRepositoryParameter(repositoryName)));
List<String> repositoryUrls = new ArrayList<String>();
- if (GitBlit.self().settings().getBoolean(Keys.git.enableGitServlet, true)) {
+ if (GitBlit.getBoolean(Keys.git.enableGitServlet, true)) {
AccessRestrictionType accessRestriction = getRepositoryModel().accessRestriction;
switch (accessRestriction) {
case NONE:
add(WicketUtils.newClearPixel("accessRestrictionIcon").setVisible(false));
break;
case PUSH:
- add(WicketUtils.newImage("accessRestrictionIcon", "lock_go_16x16.png", getAccessRestrictions().get(accessRestriction)));
+ add(WicketUtils.newImage("accessRestrictionIcon", "lock_go_16x16.png",
+ getAccessRestrictions().get(accessRestriction)));
break;
case CLONE:
- add(WicketUtils.newImage("accessRestrictionIcon", "lock_pull_16x16.png", getAccessRestrictions().get(accessRestriction)));
+ add(WicketUtils.newImage("accessRestrictionIcon", "lock_pull_16x16.png",
+ getAccessRestrictions().get(accessRestriction)));
break;
case VIEW:
- add(WicketUtils.newImage("accessRestrictionIcon", "shield_16x16.png", getAccessRestrictions().get(accessRestriction)));
+ add(WicketUtils.newImage("accessRestrictionIcon", "shield_16x16.png",
+ getAccessRestrictions().get(accessRestriction)));
break;
default:
add(WicketUtils.newClearPixel("accessRestrictionIcon").setVisible(false));
}
-
- HttpServletRequest req = ((WebRequest) getRequestCycle().getRequest()).getHttpServletRequest();
StringBuilder sb = new StringBuilder();
- sb.append(req.getScheme());
- sb.append("://");
- sb.append(req.getServerName());
- if ((req.getScheme().equals("http") && req.getServerPort() != 80) || (req.getScheme().equals("https") && req.getServerPort() != 443)) {
- sb.append(":" + req.getServerPort());
- }
- sb.append(Constants.GIT_SERVLET_PATH);
+ sb.append(WicketUtils.getHostURL(getRequestCycle().getRequest()));
+ sb.append(Constants.GIT_PATH);
sb.append(repositoryName);
repositoryUrls.add(sb.toString());
} else {
@@ -111,11 +123,48 @@
}
repositoryUrls.addAll(GitBlit.self().getOtherCloneUrls(repositoryName));
- add(new Label("repositoryCloneUrl", StringUtils.flattenStrings(repositoryUrls, "<br/>")).setEscapeModelStrings(false));
+ add(new Label("repositoryCloneUrl", StringUtils.flattenStrings(repositoryUrls, "<br/>"))
+ .setEscapeModelStrings(false));
add(new LogPanel("commitsPanel", repositoryName, null, r, numberCommits, 0));
- add(new TagsPanel("tagsPanel", repositoryName, r, numberRefs));
- add(new BranchesPanel("branchesPanel", getRepositoryModel(), r, numberRefs));
+ add(new TagsPanel("tagsPanel", repositoryName, r, numberRefs).hideIfEmpty());
+ add(new BranchesPanel("branchesPanel", getRepositoryModel(), r, numberRefs).hideIfEmpty());
+
+ if (getRepositoryModel().showReadme) {
+ String htmlText = null;
+ try {
+ RevCommit head = JGitUtils.getCommit(r, null);
+ List<String> markdownExtensions = GitBlit.getStrings(Keys.web.markdownExtensions);
+ List<PathModel> paths = JGitUtils.getFilesInPath(r, null, head);
+ String readme = null;
+ 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;
+ }
+ }
+ }
+ }
+ }
+ if (!StringUtils.isEmpty(readme)) {
+ String markdownText = JGitUtils.getStringContent(r, head.getTree(), readme);
+ htmlText = MarkdownUtils.transformMarkdown(markdownText);
+ }
+ } catch (ParseException p) {
+ error(p.getMessage());
+ }
+ // Add the html to the page
+ add(new Label("readme", htmlText).setEscapeModelStrings(false).setVisible(
+ !StringUtils.isEmpty(htmlText)));
+ } else {
+ add(new Label("readme").setVisible(false));
+ }
// Display an activity line graph
insertActivityGraph(metrics);
@@ -127,18 +176,21 @@
}
private void insertActivityGraph(List<Metric> metrics) {
- if (metrics.size() > 0 && GitBlit.self().settings().getBoolean(Keys.web.generateActivityGraph, true)) {
- IChartData data = getChartData(metrics);
+ if ((metrics != null) && (metrics.size() > 0)
+ && GitBlit.getBoolean(Keys.web.generateActivityGraph, true)) {
+ IChartData data = WicketUtils.getChartData(metrics);
- ChartProvider provider = new ChartProvider(new Dimension(400, 100), ChartType.LINE, data);
+ ChartProvider provider = new ChartProvider(new Dimension(400, 100), ChartType.LINE,
+ data);
ChartAxis dateAxis = new ChartAxis(ChartAxisType.BOTTOM);
- dateAxis.setLabels(new String[] { metrics.get(0).name, metrics.get(metrics.size() / 2).name, metrics.get(metrics.size() - 1).name });
+ dateAxis.setLabels(new String[] { metrics.get(0).name,
+ metrics.get(metrics.size() / 2).name, metrics.get(metrics.size() - 1).name });
provider.addAxis(dateAxis);
ChartAxis commitAxis = new ChartAxis(ChartAxisType.LEFT);
- commitAxis.setLabels(new String[] { "", String.valueOf((int) maxValue(metrics)) });
+ commitAxis.setLabels(new String[] { "",
+ String.valueOf((int) WicketUtils.maxValue(metrics)) });
provider.addAxis(commitAxis);
-
provider.setLineStyles(new LineStyle[] { new LineStyle(2, 4, 0), new LineStyle(0, 4, 1) });
provider.addShapeMarker(new ShapeMarker(MarkerType.CIRCLE, Color.BLUE, 1, -1, 5));
@@ -146,48 +198,5 @@
} else {
add(WicketUtils.newBlankImage("commitsChart"));
}
- }
-
- protected IChartData getChartData(List<Metric> metrics) {
- final double[] commits = new double[metrics.size()];
- final double[] tags = new double[metrics.size()];
- int i = 0;
- double max = 0;
- for (Metric m : metrics) {
- commits[i] = m.count;
- if (m.tag > 0) {
- tags[i] = m.count;
- } else {
- tags[i] = -1d;
- }
- max = Math.max(max, m.count);
- i++;
- }
- IChartData data = new AbstractChartData(max) {
- private static final long serialVersionUID = 1L;
-
- public double[][] getData() {
- return new double[][] { commits, tags };
- }
- };
- return data;
- }
-
- protected String[] getNames(List<Metric> results) {
- String[] names = new String[results.size()];
- for (int i = 0; i < results.size(); i++) {
- names[i] = results.get(i).name;
- }
- return names;
- }
-
- protected double maxValue(List<Metric> metrics) {
- double max = Double.MIN_VALUE;
- for (Metric m : metrics) {
- if (m.count > max) {
- max = m.count;
- }
- }
- return max;
}
}
--
Gitblit v1.9.1