From edeab95cac16e5f17cfcd75a9969d8708bf360ab Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Mon, 12 May 2014 09:22:04 -0400
Subject: [PATCH] Documentation
---
src/main/java/com/gitblit/wicket/pages/RepositoryPage.java | 133 ++++++++++++++++++++++++++------------------
1 files changed, 78 insertions(+), 55 deletions(-)
diff --git a/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java b/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java
index 70a2b9e..a0c9ce0 100644
--- a/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java
+++ b/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java
@@ -21,7 +21,6 @@
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
-import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
@@ -29,6 +28,7 @@
import org.apache.wicket.Component;
import org.apache.wicket.PageParameters;
+import org.apache.wicket.RestartResponseException;
import org.apache.wicket.behavior.SimpleAttributeModifier;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.DropDownChoice;
@@ -46,26 +46,28 @@
import org.slf4j.LoggerFactory;
import com.gitblit.Constants;
-import com.gitblit.GitBlit;
import com.gitblit.GitBlitException;
import com.gitblit.Keys;
-import com.gitblit.PagesServlet;
-import com.gitblit.SyndicationServlet;
+import com.gitblit.extensions.RepositoryNavLinkExtension;
+import com.gitblit.models.NavLink;
+import com.gitblit.models.NavLink.ExternalNavLink;
+import com.gitblit.models.NavLink.PageNavLink;
import com.gitblit.models.ProjectModel;
import com.gitblit.models.RefModel;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.SubmoduleModel;
import com.gitblit.models.UserModel;
import com.gitblit.models.UserRepositoryPreferences;
+import com.gitblit.servlet.PagesServlet;
+import com.gitblit.servlet.SyndicationServlet;
import com.gitblit.utils.ArrayUtils;
+import com.gitblit.utils.BugtraqProcessor;
import com.gitblit.utils.DeepCopier;
import com.gitblit.utils.JGitUtils;
import com.gitblit.utils.RefLogUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.wicket.CacheControl;
import com.gitblit.wicket.GitBlitWebSession;
-import com.gitblit.wicket.PageRegistration;
-import com.gitblit.wicket.PageRegistration.OtherPageLink;
import com.gitblit.wicket.SessionlessForm;
import com.gitblit.wicket.WicketUtils;
import com.gitblit.wicket.panels.LinkPanel;
@@ -88,16 +90,15 @@
private Map<String, SubmoduleModel> submodules;
- private final Map<String, PageRegistration> registeredPages;
private boolean showAdmin;
private boolean isOwner;
public RepositoryPage(PageParameters params) {
super(params);
repositoryName = WicketUtils.getRepositoryName(params);
- String root =StringUtils.getFirstPathElement(repositoryName);
+ String root = StringUtils.getFirstPathElement(repositoryName);
if (StringUtils.isEmpty(root)) {
- projectName = GitBlit.getString(Keys.web.repositoryRootGroupName, "main");
+ projectName = app().settings().getString(Keys.web.repositoryRootGroupName, "main");
} else {
projectName = root;
}
@@ -108,7 +109,7 @@
}
if (!getRepositoryModel().hasCommits) {
- setResponsePage(EmptyRepositoryPage.class, params);
+ throw new RestartResponseException(EmptyRepositoryPage.class, params);
}
if (getRepositoryModel().isCollectingGarbage) {
@@ -139,7 +140,7 @@
UserRepositoryPreferences prefs = user.getPreferences().getRepositoryPreferences(getRepositoryModel().name);
prefs.starred = star;
try {
- GitBlit.self().updateUserModel(user.username, user, false);
+ app().gitblit().reviseUser(user.username, user);
} catch (GitBlitException e) {
logger.error("Failed to update user " + user.username, e);
error(getString("gb.failedToUpdateUser"), false);
@@ -147,12 +148,11 @@
}
}
- // register the available page links for this page and user
- registeredPages = registerPages();
+ // register the available navigation links for this page and user
+ List<NavLink> navLinks = registerNavLinks();
- // standard page links
- List<PageRegistration> pages = new ArrayList<PageRegistration>(registeredPages.values());
- NavigationPanel navigationPanel = new NavigationPanel("repositoryNavPanel", getRepoNavPageClass(), pages);
+ // standard navigation links
+ NavigationPanel navigationPanel = new NavigationPanel("repositoryNavPanel", getRepoNavPageClass(), navLinks);
add(navigationPanel);
add(new ExternalLink("syndication", SyndicationServlet.asLink(getRequest()
@@ -176,64 +176,80 @@
return getClass();
}
- private Map<String, PageRegistration> registerPages() {
+ protected BugtraqProcessor bugtraqProcessor() {
+ return new BugtraqProcessor(app().settings());
+ }
+
+ private List<NavLink> registerNavLinks() {
PageParameters params = null;
if (!StringUtils.isEmpty(repositoryName)) {
params = WicketUtils.newRepositoryParameter(repositoryName);
}
- Map<String, PageRegistration> pages = new LinkedHashMap<String, PageRegistration>();
+ List<NavLink> navLinks = new ArrayList<NavLink>();
Repository r = getRepository();
RepositoryModel model = getRepositoryModel();
// standard links
if (RefLogUtils.getRefLogBranch(r) == null) {
- pages.put("summary", new PageRegistration("gb.summary", SummaryPage.class, params));
+ navLinks.add(new PageNavLink("gb.summary", SummaryPage.class, params));
} else {
- pages.put("summary", new PageRegistration("gb.summary", SummaryPage.class, params));
+ navLinks.add(new PageNavLink("gb.summary", SummaryPage.class, params));
// pages.put("overview", new PageRegistration("gb.overview", OverviewPage.class, params));
- pages.put("reflog", new PageRegistration("gb.reflog", ReflogPage.class, params));
+ navLinks.add(new PageNavLink("gb.reflog", ReflogPage.class, params));
}
- pages.put("commits", new PageRegistration("gb.commits", LogPage.class, params));
- pages.put("tree", new PageRegistration("gb.tree", TreePage.class, params));
- pages.put("compare", new PageRegistration("gb.compare", ComparePage.class, params, true));
- if (GitBlit.getBoolean(Keys.web.allowForking, true)) {
- pages.put("forks", new PageRegistration("gb.forks", ForksPage.class, params, true));
+ navLinks.add(new PageNavLink("gb.commits", LogPage.class, params));
+ navLinks.add(new PageNavLink("gb.tree", TreePage.class, params));
+ if (app().tickets().isReady() && (app().tickets().isAcceptingNewTickets(model) || app().tickets().hasTickets(model))) {
+ PageParameters tParams = WicketUtils.newOpenTicketsParameter(repositoryName);
+ navLinks.add(new PageNavLink("gb.tickets", TicketsPage.class, tParams));
+ }
+ navLinks.add(new PageNavLink("gb.docs", DocsPage.class, params, true));
+ if (app().settings().getBoolean(Keys.web.allowForking, true)) {
+ navLinks.add(new PageNavLink("gb.forks", ForksPage.class, params, true));
}
+ navLinks.add(new PageNavLink("gb.compare", ComparePage.class, params, true));
// conditional links
- // per-repository extra page links
- if (model.useDocs) {
- pages.put("docs", new PageRegistration("gb.docs", DocsPage.class, params, true));
- }
+ // per-repository extra navlinks
if (JGitUtils.getPagesBranch(r) != null) {
- OtherPageLink pagesLink = new OtherPageLink("gb.pages", PagesServlet.asLink(
+ ExternalNavLink pagesLink = new ExternalNavLink("gb.pages", PagesServlet.asLink(
getRequest().getRelativePathPrefixToContextRoot(), repositoryName, null), true);
- pages.put("pages", pagesLink);
+ navLinks.add(pagesLink);
+ }
+
+ UserModel user = UserModel.ANONYMOUS;
+ if (GitBlitWebSession.get().isLoggedIn()) {
+ user = GitBlitWebSession.get().getUser();
+ }
+
+ // add repository nav link extensions
+ List<RepositoryNavLinkExtension> extensions = app().plugins().getExtensions(RepositoryNavLinkExtension.class);
+ for (RepositoryNavLinkExtension ext : extensions) {
+ navLinks.addAll(ext.getNavLinks(user, model));
}
// Conditionally add edit link
showAdmin = false;
- if (GitBlit.getBoolean(Keys.web.authenticateAdminPages, true)) {
- boolean allowAdmin = GitBlit.getBoolean(Keys.web.allowAdministration, false);
+ if (app().settings().getBoolean(Keys.web.authenticateAdminPages, true)) {
+ boolean allowAdmin = app().settings().getBoolean(Keys.web.allowAdministration, false);
showAdmin = allowAdmin && GitBlitWebSession.get().canAdmin();
} else {
- showAdmin = GitBlit.getBoolean(Keys.web.allowAdministration, false);
+ showAdmin = app().settings().getBoolean(Keys.web.allowAdministration, false);
}
isOwner = GitBlitWebSession.get().isLoggedIn()
- && (model.isOwner(GitBlitWebSession.get()
- .getUsername()));
- return pages;
+ && (model.isOwner(GitBlitWebSession.get().getUsername()));
+ return navLinks;
}
protected boolean allowForkControls() {
- return GitBlit.getBoolean(Keys.web.allowForking, true);
+ return app().settings().getBoolean(Keys.web.allowForking, true);
}
@Override
protected void setupPage(String repositoryName, String pageName) {
String projectName = StringUtils.getFirstPathElement(repositoryName);
- ProjectModel project = GitBlit.self().getProjectModel(projectName);
+ ProjectModel project = app().projects().getProjectModel(projectName);
if (project.isUserProject()) {
// user-as-project
add(new LinkPanel("projectTitle", null, project.getDisplayName(),
@@ -250,7 +266,6 @@
}
add(new LinkPanel("repositoryName", null, name, SummaryPage.class,
WicketUtils.newRepositoryParameter(repositoryName)));
- add(new Label("pageName", pageName).setRenderBodyOnly(true));
UserModel user = GitBlitWebSession.get().getUser();
if (user == null) {
@@ -269,7 +284,7 @@
add(new Label("originRepository").setVisible(false));
}
} else {
- RepositoryModel origin = GitBlit.self().getRepositoryModel(model.originRepository);
+ RepositoryModel origin = app().repositories().getRepositoryModel(model.originRepository);
if (origin == null) {
// no origin repository
add(new Label("originRepository").setVisible(false));
@@ -285,6 +300,14 @@
SummaryPage.class, WicketUtils.newRepositoryParameter(model.originRepository)));
add(forkFrag);
}
+ }
+
+ // new ticket button
+ if (user.isAuthenticated && app().tickets().isAcceptingNewTickets(getRepositoryModel())) {
+ String newTicketUrl = getRequestCycle().urlFor(NewTicketPage.class, WicketUtils.newRepositoryParameter(repositoryName)).toString();
+ addToolbarButton("newTicketLink", "fa fa-ticket", getString("gb.new"), newTicketUrl);
+ } else {
+ add(new Label("newTicketLink").setVisible(false));
}
// (un)star link allows a user to star a repository
@@ -308,12 +331,12 @@
}
// fork controls
- if (!allowForkControls() || user == null || !user.isAuthenticated) {
+ if (!allowForkControls() || !user.isAuthenticated) {
// must be logged-in to fork, hide all fork controls
add(new ExternalLink("forkLink", "").setVisible(false));
add(new ExternalLink("myForkLink", "").setVisible(false));
} else {
- String fork = GitBlit.self().getFork(user.username, model.name);
+ String fork = app().repositories().getFork(user.username, model.name);
boolean hasFork = fork != null;
boolean canFork = user.canFork(model);
@@ -365,7 +388,7 @@
protected Repository getRepository() {
if (r == null) {
- Repository r = GitBlit.self().getRepository(repositoryName);
+ Repository r = app().repositories().getRepository(repositoryName);
if (r == null) {
error(getString("gb.canNotLoadRepository") + " " + repositoryName, true);
return null;
@@ -377,10 +400,10 @@
protected RepositoryModel getRepositoryModel() {
if (m == null) {
- RepositoryModel model = GitBlit.self().getRepositoryModel(
+ RepositoryModel model = app().repositories().getRepositoryModel(
GitBlitWebSession.get().getUser(), repositoryName);
if (model == null) {
- if (GitBlit.self().hasRepository(repositoryName, true)) {
+ if (app().repositories().hasRepository(repositoryName, true)) {
// has repository, but unauthorized
authenticationError(getString("gb.unauthorizedAccessForRepository") + " " + repositoryName);
} else {
@@ -452,7 +475,7 @@
return model;
} else {
// extract the repository name from the clone url
- List<String> patterns = GitBlit.getStrings(Keys.git.submoduleUrlPatterns);
+ List<String> patterns = app().settings().getStrings(Keys.git.submoduleUrlPatterns);
String submoduleName = StringUtils.extractRepositoryPath(model.url, patterns.toArray(new String[0]));
// determine the current path for constructing paths relative
@@ -491,7 +514,7 @@
// create a unique, ordered set of candidate paths
Set<String> paths = new LinkedHashSet<String>(candidates);
for (String candidate : paths) {
- if (GitBlit.self().hasRepository(candidate)) {
+ if (app().repositories().hasRepository(candidate)) {
model.hasSubmodule = true;
model.gitblitPath = candidate;
return model;
@@ -505,7 +528,7 @@
}
protected String getShortObjectId(String objectId) {
- return objectId.substring(0, GitBlit.getInteger(Keys.web.shortCommitIdLength, 6));
+ return objectId.substring(0, app().settings().getInteger(Keys.web.shortCommitIdLength, 6));
}
protected void addRefs(Repository r, RevCommit c) {
@@ -514,7 +537,7 @@
protected void addFullText(String wicketId, String text) {
RepositoryModel model = getRepositoryModel();
- String content = GitBlit.self().processCommitMessage(model, text);
+ String content = bugtraqProcessor().processCommitMessage(r, model, text);
String html;
switch (model.commitMessageRenderer) {
case MARKDOWN:
@@ -535,7 +558,7 @@
String address = identity == null ? "" : identity.getEmailAddress();
name = StringUtils.removeNewlines(name);
address = StringUtils.removeNewlines(address);
- boolean showEmail = GitBlit.getBoolean(Keys.web.showEmailAddresses, false);
+ boolean showEmail = app().settings().getBoolean(Keys.web.showEmailAddresses, false);
if (!showEmail || StringUtils.isEmpty(name) || StringUtils.isEmpty(address)) {
String value = name;
if (StringUtils.isEmpty(value)) {
@@ -666,7 +689,7 @@
DropDownChoice<Constants.SearchType> searchType = new DropDownChoice<Constants.SearchType>(
"searchType", Arrays.asList(Constants.SearchType.values()));
searchType.setModel(searchTypeModel);
- add(searchType.setVisible(GitBlit.getBoolean(Keys.web.showSearchTypeSelection, false)));
+ add(searchType.setVisible(app().settings().getBoolean(Keys.web.showSearchTypeSelection, false)));
TextField<String> searchBox = new TextField<String>("searchBox", searchBoxModel);
add(searchBox);
}
@@ -697,8 +720,8 @@
}
}
Class<? extends BasePage> searchPageClass = GitSearchPage.class;
- RepositoryModel model = GitBlit.self().getRepositoryModel(repositoryName);
- if (GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true)
+ RepositoryModel model = app().repositories().getRepositoryModel(repositoryName);
+ if (app().settings().getBoolean(Keys.web.allowLuceneIndexing, true)
&& !ArrayUtils.isEmpty(model.indexedBranches)) {
// this repository is Lucene-indexed
searchPageClass = LuceneSearchPage.class;
--
Gitblit v1.9.1