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 | 275 ++++++++++++++++++++++++++++++++----------------------
1 files changed, 164 insertions(+), 111 deletions(-)
diff --git a/src/com/gitblit/wicket/pages/SummaryPage.java b/src/com/gitblit/wicket/pages/SummaryPage.java
index 84e78b4..e753e5d 100644
--- a/src/com/gitblit/wicket/pages/SummaryPage.java
+++ b/src/com/gitblit/wicket/pages/SummaryPage.java
@@ -1,149 +1,202 @@
+/*
+ * 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.util.Date;
+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 java.util.Map;
import org.apache.wicket.PageParameters;
import org.apache.wicket.markup.html.basic.Label;
-import org.apache.wicket.markup.repeater.Item;
-import org.apache.wicket.markup.repeater.data.DataView;
-import org.apache.wicket.markup.repeater.data.ListDataProvider;
-import org.eclipse.jgit.lib.ObjectId;
+import org.apache.wicket.markup.html.link.BookmarkablePageLink;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
+import org.wicketstuff.googlecharts.Chart;
+import org.wicketstuff.googlecharts.ChartAxis;
+import org.wicketstuff.googlecharts.ChartAxisType;
+import org.wicketstuff.googlecharts.ChartProvider;
+import org.wicketstuff.googlecharts.ChartType;
+import org.wicketstuff.googlecharts.IChartData;
+import org.wicketstuff.googlecharts.LineStyle;
+import org.wicketstuff.googlecharts.MarkerType;
+import org.wicketstuff.googlecharts.ShapeMarker;
+import com.gitblit.Constants;
+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.wicket.GitBlitWebApp;
-import com.gitblit.wicket.GitBlitWebSession;
-import com.gitblit.wicket.LinkPanel;
-import com.gitblit.wicket.RepositoryPage;
+import com.gitblit.utils.MarkdownUtils;
+import com.gitblit.utils.MetricUtils;
+import com.gitblit.utils.StringUtils;
+import com.gitblit.utils.TimeUtils;
import com.gitblit.wicket.WicketUtils;
-import com.gitblit.wicket.models.RefModel;
-import com.gitblit.wicket.panels.HeadLinksPanel;
-import com.gitblit.wicket.panels.RefsPanel;
-import com.gitblit.wicket.panels.ShortLogLinksPanel;
-import com.gitblit.wicket.panels.TagLinksPanel;
-
+import com.gitblit.wicket.panels.BranchesPanel;
+import com.gitblit.wicket.panels.LogPanel;
+import com.gitblit.wicket.panels.TagsPanel;
public class SummaryPage extends RepositoryPage {
public SummaryPage(PageParameters params) {
- super(params, "summary");
+ super(params);
+
+ int numberCommits = GitBlit.getInteger(Keys.web.summaryCommitCount, 20);
+ if (numberCommits <= 0) {
+ numberCommits = 20;
+ }
+ int numberRefs = GitBlit.getInteger(Keys.web.summaryRefsCount, 5);
Repository r = getRepository();
- final Map<ObjectId, List<String>> allRefs = JGitUtils.getAllRefs(r);
+ List<Metric> metrics = null;
+ Metric metricsTotal = null;
+ if (GitBlit.getBoolean(Keys.web.generateActivityGraph, true)) {
+ metrics = MetricUtils.getDateMetrics(r, null, true, null);
+ metricsTotal = metrics.remove(0);
+ }
- String owner = JGitUtils.getRepositoryOwner(r);
- GitBlitWebSession session = GitBlitWebSession.get();
- String lastchange = session.formatDateTimeLong(JGitUtils.getLastChange(r));
- String cloneurl = GitBlitWebApp.get().getCloneUrl(repositoryName);
+ addSyndicationDiscoveryLink();
// repository description
- add(new Label("repositoryDescription", description));
- add(new Label("repositoryOwner", owner));
- add(new Label("repositoryLastChange", lastchange));
- add(new Label("repositoryCloneUrl", cloneurl));
+ add(new Label("repositoryDescription", getRepositoryModel().description));
+ add(new Label("repositoryOwner", getRepositoryModel().owner));
- int summaryCount = 16;
+ add(WicketUtils.createTimestampLabel("repositoryLastChange", JGitUtils.getLastChange(r, null),
+ getTimeZone()));
+ if (metricsTotal == null) {
+ add(new Label("branchStats", ""));
+ } else {
+ 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)));
- // shortlog
- add(new LinkPanel("shortlog", "title", "shortlog", ShortLogPage.class, newRepositoryParameter()));
+ List<String> repositoryUrls = new ArrayList<String>();
- List<RevCommit> commits = JGitUtils.getRevLog(r, summaryCount);
- ListDataProvider<RevCommit> dp = new ListDataProvider<RevCommit>(commits);
- DataView<RevCommit> shortlogView = new DataView<RevCommit>("commit", dp) {
- private static final long serialVersionUID = 1L;
- int counter = 0;
+ 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)));
+ break;
+ case CLONE:
+ add(WicketUtils.newImage("accessRestrictionIcon", "lock_pull_16x16.png",
+ getAccessRestrictions().get(accessRestriction)));
+ break;
+ case VIEW:
+ add(WicketUtils.newImage("accessRestrictionIcon", "shield_16x16.png",
+ getAccessRestrictions().get(accessRestriction)));
+ break;
+ default:
+ add(WicketUtils.newClearPixel("accessRestrictionIcon").setVisible(false));
+ }
+ StringBuilder sb = new StringBuilder();
+ sb.append(WicketUtils.getHostURL(getRequestCycle().getRequest()));
+ sb.append(Constants.GIT_PATH);
+ sb.append(repositoryName);
+ repositoryUrls.add(sb.toString());
+ } else {
+ add(WicketUtils.newClearPixel("accessRestrictionIcon").setVisible(false));
+ }
+ repositoryUrls.addAll(GitBlit.self().getOtherCloneUrls(repositoryName));
- public void populateItem(final Item<RevCommit> item) {
- RevCommit entry = item.getModelObject();
- Date date = JGitUtils.getCommitDate(entry);
+ add(new Label("repositoryCloneUrl", StringUtils.flattenStrings(repositoryUrls, "<br/>"))
+ .setEscapeModelStrings(false));
- item.add(createShortlogDateLabel("commitDate", date));
+ add(new LogPanel("commitsPanel", repositoryName, null, r, numberCommits, 0));
+ add(new TagsPanel("tagsPanel", repositoryName, r, numberRefs).hideIfEmpty());
+ add(new BranchesPanel("branchesPanel", getRepositoryModel(), r, numberRefs).hideIfEmpty());
- String author = entry.getAuthorIdent().getName();
- item.add(createAuthorLabel("commitAuthor", author));
+ 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();
- String shortMessage = entry.getShortMessage();
- String trimmedMessage = trimShortLog(shortMessage);
- LinkPanel shortlog = new LinkPanel("commitShortMessage", "list subject", trimmedMessage, CommitPage.class, newCommitParameter(entry.getName()));
- if (!shortMessage.equals(trimmedMessage)) {
- WicketUtils.setHtmlTitle(shortlog, shortMessage);
+ if (name.startsWith("readme")) {
+ if (name.indexOf('.') > -1) {
+ String ext = name.substring(name.lastIndexOf('.') + 1);
+ if (markdownExtensions.contains(ext)) {
+ readme = path.name;
+ break;
+ }
+ }
+ }
+ }
}
- item.add(shortlog);
-
- item.add(new RefsPanel("commitRefs", entry, allRefs));
-
- item.add(new ShortLogLinksPanel("commitLinks", repositoryName, entry.getName()));
-
- setAlternatingBackground(item, counter);
- counter++;
- }
- };
- add(shortlogView);
- add(new LinkPanel("shortlogMore", "link", "...", ShortLogPage.class, newRepositoryParameter()));
-
- // tags
- List<RefModel> tags = JGitUtils.getTags(r, summaryCount);
- add(new LinkPanel("tags", "title", "tags", TagsPage.class, newRepositoryParameter()));
-
- ListDataProvider<RefModel> tagsDp = new ListDataProvider<RefModel>(tags);
- DataView<RefModel> tagView = new DataView<RefModel>("tag", tagsDp) {
- private static final long serialVersionUID = 1L;
- int counter = 0;
-
- public void populateItem(final Item<RefModel> item) {
- final RefModel entry = item.getModelObject();
-
- item.add(createDateLabel("tagDate", entry.getDate()));
-
- item.add(new LinkPanel("tagName", "list name", entry.getDisplayName(), CommitPage.class, newCommitParameter(entry.getCommitId().getName())));
-
- if (entry.getCommitId().equals(entry.getObjectId())) {
- // lightweight tag on commit object
- item.add(new Label("tagDescription", ""));
- } else {
- // tag object
- item.add(new LinkPanel("tagDescription", "list subject", entry.getShortLog(), TagPage.class, newCommitParameter(entry.getObjectId().getName())));
+ if (!StringUtils.isEmpty(readme)) {
+ String markdownText = JGitUtils.getStringContent(r, head.getTree(), readme);
+ htmlText = MarkdownUtils.transformMarkdown(markdownText);
}
-
- item.add(new TagLinksPanel("tagLinks", repositoryName, entry));
-
- setAlternatingBackground(item, counter);
- counter++;
+ } catch (ParseException p) {
+ error(p.getMessage());
}
- };
- add(tagView);
- add(new LinkPanel("tagsMore", "link", "...", TagsPage.class, newRepositoryParameter()));
- // heads
- List<RefModel> heads = JGitUtils.getHeads(r, summaryCount);
- add(new LinkPanel("heads", "title", "heads", HeadsPage.class, newRepositoryParameter()));
+ // Add the html to the page
+ add(new Label("readme", htmlText).setEscapeModelStrings(false).setVisible(
+ !StringUtils.isEmpty(htmlText)));
+ } else {
+ add(new Label("readme").setVisible(false));
+ }
- ListDataProvider<RefModel> headsDp = new ListDataProvider<RefModel>(heads);
- DataView<RefModel> headsView = new DataView<RefModel>("head", headsDp) {
- private static final long serialVersionUID = 1L;
- int counter = 0;
+ // Display an activity line graph
+ insertActivityGraph(metrics);
+ }
- public void populateItem(final Item<RefModel> item) {
- final RefModel entry = item.getModelObject();
+ @Override
+ protected String getPageName() {
+ return getString("gb.summary");
+ }
- item.add(createDateLabel("headDate", entry.getDate()));
+ private void insertActivityGraph(List<Metric> metrics) {
+ if ((metrics != null) && (metrics.size() > 0)
+ && GitBlit.getBoolean(Keys.web.generateActivityGraph, true)) {
+ IChartData data = WicketUtils.getChartData(metrics);
- item.add(new LinkPanel("headName", "list name", entry.getDisplayName(), ShortLogPage.class, newCommitParameter(entry.getName())));
+ 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 });
+ provider.addAxis(dateAxis);
- item.add(new HeadLinksPanel("headLinks", repositoryName, entry));
+ ChartAxis commitAxis = new ChartAxis(ChartAxisType.LEFT);
+ 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));
- setAlternatingBackground(item, counter);
- counter++;
- }
- };
- add(headsView);
-
- // close the repository
- r.close();
-
- // footer
- addFooter();
+ add(new Chart("commitsChart", provider));
+ } else {
+ add(WicketUtils.newBlankImage("commitsChart"));
+ }
}
}
--
Gitblit v1.9.1