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 | 93 ++++++++++++++++++++++++++++------------------ 1 files changed, 57 insertions(+), 36 deletions(-) diff --git a/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java b/src/main/java/com/gitblit/wicket/pages/RepositoryPage.java index 0552c30..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; @@ -48,24 +48,26 @@ import com.gitblit.Constants; 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.MessageProcessor; 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,14 +90,13 @@ 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 = app().settings().getString(Keys.web.repositoryRootGroupName, "main"); } else { @@ -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 { - app().gitblit().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,42 +176,57 @@ return getClass(); } - protected MessageProcessor messageProcessor() { - return new MessageProcessor(app().settings()); + protected BugtraqProcessor bugtraqProcessor() { + return new BugtraqProcessor(app().settings()); } - private Map<String, PageRegistration> registerPages() { + 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("docs", new PageRegistration("gb.docs", DocsPage.class, params, true)); - pages.put("compare", new PageRegistration("gb.compare", ComparePage.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)) { - pages.put("forks", new PageRegistration("gb.forks", ForksPage.class, params, 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 + // 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 @@ -223,9 +238,8 @@ 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() { @@ -252,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) { @@ -289,6 +302,14 @@ } } + // 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 if (user.isAuthenticated) { PageParameters starParams = DeepCopier.copy(getPageParameters()); @@ -310,7 +331,7 @@ } // 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)); @@ -516,7 +537,7 @@ protected void addFullText(String wicketId, String text) { RepositoryModel model = getRepositoryModel(); - String content = messageProcessor().processCommitMessage(model, text); + String content = bugtraqProcessor().processCommitMessage(r, model, text); String html; switch (model.commitMessageRenderer) { case MARKDOWN: -- Gitblit v1.9.1