From c5dfd60d174a9841e64e4097cecab5aea5c422d0 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sat, 12 Apr 2014 12:26:17 -0400 Subject: [PATCH] Documentation --- src/main/java/com/gitblit/wicket/pages/RootPage.java | 176 ++++++++++++++++++++++++++++++++++++++++++---------------- 1 files changed, 127 insertions(+), 49 deletions(-) diff --git a/src/main/java/com/gitblit/wicket/pages/RootPage.java b/src/main/java/com/gitblit/wicket/pages/RootPage.java index 3025151..5ccc3a4 100644 --- a/src/main/java/com/gitblit/wicket/pages/RootPage.java +++ b/src/main/java/com/gitblit/wicket/pages/RootPage.java @@ -27,11 +27,15 @@ import java.util.List; import java.util.Map; import java.util.Set; +import java.util.TreeSet; import java.util.concurrent.atomic.AtomicInteger; import java.util.regex.Pattern; import org.apache.wicket.MarkupContainer; import org.apache.wicket.PageParameters; +import org.apache.wicket.behavior.HeaderContributor; +import org.apache.wicket.markup.html.IHeaderContributor; +import org.apache.wicket.markup.html.IHeaderResponse; import org.apache.wicket.markup.html.basic.Label; import org.apache.wicket.markup.html.form.PasswordTextField; import org.apache.wicket.markup.html.form.TextField; @@ -42,15 +46,16 @@ import org.apache.wicket.protocol.http.WebResponse; import com.gitblit.Constants; -import com.gitblit.GitBlit; import com.gitblit.Keys; import com.gitblit.models.RepositoryModel; import com.gitblit.models.TeamModel; import com.gitblit.models.UserModel; +import com.gitblit.utils.ModelUtils; import com.gitblit.utils.StringUtils; import com.gitblit.wicket.GitBlitWebSession; import com.gitblit.wicket.PageRegistration; import com.gitblit.wicket.PageRegistration.DropDownMenuItem; +import com.gitblit.wicket.PageRegistration.DropDownToggleItem; import com.gitblit.wicket.SessionlessForm; import com.gitblit.wicket.WicketUtils; import com.gitblit.wicket.panels.GravatarImage; @@ -59,9 +64,9 @@ /** * Root page is a topbar, navigable page like Repositories, Users, or * Federation. - * + * * @author James Moger - * + * */ public abstract class RootPage extends BasePage { @@ -81,9 +86,54 @@ @Override protected void setupPage(String repositoryName, String pageName) { - boolean authenticateView = GitBlit.getBoolean(Keys.web.authenticateViewPages, false); - boolean authenticateAdmin = GitBlit.getBoolean(Keys.web.authenticateAdminPages, true); - boolean allowAdmin = GitBlit.getBoolean(Keys.web.allowAdministration, true); + + // CSS header overrides + add(new HeaderContributor(new IHeaderContributor() { + private static final long serialVersionUID = 1L; + + @Override + public void renderHead(IHeaderResponse response) { + StringBuilder buffer = new StringBuilder(); + buffer.append("<style type=\"text/css\">\n"); + buffer.append(".navbar-inner {\n"); + final String headerBackground = app().settings().getString(Keys.web.headerBackgroundColor, null); + if (!StringUtils.isEmpty(headerBackground)) { + buffer.append(MessageFormat.format("background-color: {0};\n", headerBackground)); + } + final String headerBorder = app().settings().getString(Keys.web.headerBorderColor, null); + if (!StringUtils.isEmpty(headerBorder)) { + buffer.append(MessageFormat.format("border-bottom: 1px solid {0} !important;\n", headerBorder)); + } + buffer.append("}\n"); + final String headerBorderFocus = app().settings().getString(Keys.web.headerBorderFocusColor, null); + if (!StringUtils.isEmpty(headerBorderFocus)) { + buffer.append(".navbar ul li:focus, .navbar .active {\n"); + buffer.append(MessageFormat.format("border-bottom: 4px solid {0};\n", headerBorderFocus)); + buffer.append("}\n"); + } + final String headerForeground = app().settings().getString(Keys.web.headerForegroundColor, null); + if (!StringUtils.isEmpty(headerForeground)) { + buffer.append(".navbar ul.nav li a {\n"); + buffer.append(MessageFormat.format("color: {0};\n", headerForeground)); + buffer.append("}\n"); + buffer.append(".navbar ul.nav .active a {\n"); + buffer.append(MessageFormat.format("color: {0};\n", headerForeground)); + buffer.append("}\n"); + } + final String headerHover = app().settings().getString(Keys.web.headerHoverColor, null); + if (!StringUtils.isEmpty(headerHover)) { + buffer.append(".navbar ul.nav li a:hover {\n"); + buffer.append(MessageFormat.format("color: {0} !important;\n", headerHover)); + buffer.append("}\n"); + } + buffer.append("</style>\n"); + response.renderString(buffer.toString()); + } + })); + + boolean authenticateView = app().settings().getBoolean(Keys.web.authenticateViewPages, false); + boolean authenticateAdmin = app().settings().getBoolean(Keys.web.authenticateAdminPages, true); + boolean allowAdmin = app().settings().getBoolean(Keys.web.allowAdministration, true); if (authenticateAdmin) { showAdmin = allowAdmin && GitBlitWebSession.get().canAdmin(); @@ -99,7 +149,7 @@ setStatelessHint(true); } } - + if (authenticateView || authenticateAdmin) { if (GitBlitWebSession.get().isLoggedIn()) { UserMenu userFragment = new UserMenu("userPanel", "userMenuFragment", RootPage.this); @@ -111,19 +161,19 @@ } else { add(new Label("userPanel").setVisible(false)); } - - boolean showRegistrations = GitBlit.canFederate() - && GitBlit.getBoolean(Keys.web.showFederationRegistrations, false); + + boolean showRegistrations = app().federation().canFederate() + && app().settings().getBoolean(Keys.web.showFederationRegistrations, false); // navigation links List<PageRegistration> pages = new ArrayList<PageRegistration>(); if (!authenticateView || (authenticateView && GitBlitWebSession.get().isLoggedIn())) { -// pages.add(new PageRegistration("gb.home", HomePage.class, -// getRootPageParameters())); + pages.add(new PageRegistration(GitBlitWebSession.get().isLoggedIn() ? "gb.myDashboard" : "gb.dashboard", MyDashboardPage.class, + getRootPageParameters())); pages.add(new PageRegistration("gb.repositories", RepositoriesPage.class, getRootPageParameters())); pages.add(new PageRegistration("gb.activity", ActivityPage.class, getRootPageParameters())); - if (GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true)) { + if (app().settings().getBoolean(Keys.web.allowLuceneIndexing, true)) { pages.add(new PageRegistration("gb.search", LuceneSearchPage.class)); } if (showAdmin) { @@ -137,7 +187,7 @@ addDropDownMenus(pages); } } - + NavigationPanel navPanel = new NavigationPanel("navPanel", getRootNavPageClass(), pages); add(navPanel); @@ -146,7 +196,7 @@ if (!StringUtils.isEmpty(cachedMessage)) { error(cachedMessage); } else if (showAdmin) { - int pendingProposals = GitBlit.self().getPendingFederationProposals().size(); + int pendingProposals = app().federation().getPendingFederationProposals().size(); if (pendingProposals == 1) { info(getString("gb.OneProposalToReview")); } else if (pendingProposals > 1) { @@ -157,7 +207,7 @@ super.setupPage(repositoryName, pageName); } - + protected Class<? extends BasePage> getRootNavPageClass() { return getClass(); } @@ -178,11 +228,11 @@ // remove days back parameter if it is the default value if (params.containsKey("db") - && params.getInt("db") == GitBlit.getInteger(Keys.web.activityDuration, 14)) { + && params.getInt("db") == app().settings().getInteger(Keys.web.activityDuration, 7)) { params.remove("db"); } return params; - } + } } return null; } @@ -200,9 +250,9 @@ session.setUser(user); // Set Cookie - if (GitBlit.getBoolean(Keys.web.allowCookieAuthentication, false)) { + if (app().settings().getBoolean(Keys.web.allowCookieAuthentication, false)) { WebResponse response = (WebResponse) getRequestCycle().getResponse(); - GitBlit.self().setCookie(response, user); + app().authentication().setCookie(response.getHttpServletResponse(), user); } if (!session.continueRequest()) { @@ -219,11 +269,11 @@ } } } - + protected List<RepositoryModel> getRepositoryModels() { if (repositoryModels.isEmpty()) { final UserModel user = GitBlitWebSession.get().getUser(); - List<RepositoryModel> repositories = GitBlit.self().getRepositoryModels(user); + List<RepositoryModel> repositories = app().repositories().getRepositoryModels(user); repositoryModels.addAll(repositories); Collections.sort(repositoryModels); } @@ -255,7 +305,7 @@ List<String> sets = new ArrayList<String>(setMap.keySet()); Collections.sort(sets); for (String set : sets) { - filters.add(new DropDownMenuItem(MessageFormat.format("{0} ({1})", set, + filters.add(new DropDownToggleItem(MessageFormat.format("{0} ({1})", set, setMap.get(set).get()), "set", set, params)); } // divider @@ -267,7 +317,7 @@ List<TeamModel> teams = new ArrayList<TeamModel>(user.teams); Collections.sort(teams); for (TeamModel team : teams) { - filters.add(new DropDownMenuItem(MessageFormat.format("{0} ({1})", team.name, + filters.add(new DropDownToggleItem(MessageFormat.format("{0} ({1})", team.name, team.repositories.size()), "team", team.name, params)); } // divider @@ -275,14 +325,14 @@ } // custom filters - String customFilters = GitBlit.getString(Keys.web.customFilters, null); + String customFilters = app().settings().getString(Keys.web.customFilters, null); if (!StringUtils.isEmpty(customFilters)) { boolean addedExpression = false; List<String> expressions = StringUtils.getStringsFromValue(customFilters, "!!!"); for (String expression : expressions) { if (!StringUtils.isEmpty(expression)) { addedExpression = true; - filters.add(new DropDownMenuItem(null, "x", expression, params)); + filters.add(new DropDownToggleItem(null, "x", expression, params)); } } // if we added any custom expressions, add a divider @@ -295,18 +345,40 @@ protected List<DropDownMenuItem> getTimeFilterItems(PageParameters params) { // days back choices - additive parameters - int daysBack = GitBlit.getInteger(Keys.web.activityDuration, 14); + int daysBack = app().settings().getInteger(Keys.web.activityDuration, 7); + int maxDaysBack = app().settings().getInteger(Keys.web.activityDurationMaximum, 30); if (daysBack < 1) { - daysBack = 14; + daysBack = 7; } + if (daysBack > maxDaysBack) { + daysBack = maxDaysBack; + } + PageParameters clonedParams; + if (params == null) { + clonedParams = new PageParameters(); + } else { + clonedParams = new PageParameters(params); + } + + if (!clonedParams.containsKey("db")) { + clonedParams.put("db", daysBack); + } + List<DropDownMenuItem> items = new ArrayList<DropDownMenuItem>(); - Set<Integer> choicesSet = new HashSet<Integer>(Arrays.asList(daysBack, 14, 28, 60, 90, 180)); + Set<Integer> choicesSet = new TreeSet<Integer>(app().settings().getIntegers(Keys.web.activityDurationChoices)); + if (choicesSet.isEmpty()) { + choicesSet.addAll(Arrays.asList(1, 3, 7, 14, 21, 28)); + } List<Integer> choices = new ArrayList<Integer>(choicesSet); Collections.sort(choices); String lastDaysPattern = getString("gb.lastNDays"); for (Integer db : choices) { - String txt = MessageFormat.format(lastDaysPattern, db); - items.add(new DropDownMenuItem(txt, "db", db.toString(), params)); + if (db == 1) { + items.add(new DropDownMenuItem(getString("gb.time.today"), "db", db.toString(), clonedParams)); + } else { + String txt = MessageFormat.format(lastDaysPattern, db); + items.add(new DropDownMenuItem(txt, "db", db.toString(), clonedParams)); + } } items.add(new DropDownMenuItem()); return items; @@ -322,7 +394,7 @@ String userName = WicketUtils.getUsername(params); if (StringUtils.isEmpty(projectName)) { if (!StringUtils.isEmpty(userName)) { - projectName = "~" + userName; + projectName = ModelUtils.getPersonalPath(userName); } } String repositoryName = WicketUtils.getRepositoryName(params); @@ -330,6 +402,7 @@ String regex = WicketUtils.getRegEx(params); String team = WicketUtils.getTeam(params); int daysBack = params.getInt("db", 0); + int maxDaysBack = app().settings().getInteger(Keys.web.activityDurationMaximum, 30); List<RepositoryModel> availableModels = getRepositoryModels(); Set<RepositoryModel> models = new HashSet<RepositoryModel>(); @@ -347,8 +420,8 @@ if (!StringUtils.isEmpty(projectName)) { // try named project - hasParameter = true; - if (projectName.equalsIgnoreCase(GitBlit.getString(Keys.web.repositoryRootGroupName, "main"))) { + hasParameter = true; + if (projectName.equalsIgnoreCase(app().settings().getString(Keys.web.repositoryRootGroupName, "main"))) { // root project/group for (RepositoryModel model : availableModels) { if (model.name.indexOf('/') == -1) { @@ -398,7 +471,7 @@ // need TeamModels first List<TeamModel> teamModels = new ArrayList<TeamModel>(); for (String name : teams) { - TeamModel teamModel = GitBlit.self().getTeamModel(name); + TeamModel teamModel = app().users().getTeamModel(name); if (teamModel != null) { teamModels.add(teamModel); } @@ -420,6 +493,9 @@ // time-filter the list if (daysBack > 0) { + if (maxDaysBack > 0 && daysBack > maxDaysBack) { + daysBack = maxDaysBack; + } Calendar cal = Calendar.getInstance(); cal.set(Calendar.HOUR_OF_DAY, 0); cal.set(Calendar.MINUTE, 0); @@ -435,14 +511,14 @@ } models = timeFiltered; } - + List<RepositoryModel> list = new ArrayList<RepositoryModel>(models); Collections.sort(list); return list; } - + /** - * Inline login form. + * Inline login form. */ private class LoginForm extends Fragment { private static final long serialVersionUID = 1L; @@ -460,7 +536,7 @@ String username = RootPage.this.username.getObject(); char[] password = RootPage.this.password.getObject().toCharArray(); - UserModel user = GitBlit.self().authenticate(username, password); + UserModel user = app().authentication().authenticate(username, password); if (user == null) { error(getString("gb.invalidUsernameOrPassword")); } else if (user.username.equals(Constants.FEDERATION_USER)) { @@ -482,11 +558,11 @@ add(loginForm); } } - + /** * Menu for the authenticated user. */ - static class UserMenu extends Fragment { + class UserMenu extends Fragment { private static final long serialVersionUID = 1L; @@ -496,24 +572,26 @@ GitBlitWebSession session = GitBlitWebSession.get(); UserModel user = session.getUser(); - boolean editCredentials = GitBlit.self().supportsCredentialChanges(user); + boolean editCredentials = app().authentication().supportsCredentialChanges(user); boolean standardLogin = session.authenticationType.isStandard(); - if (GitBlit.getBoolean(Keys.web.allowGravatar, true)) { - add(new GravatarImage("username", user.getDisplayName(), - user.emailAddress, "navbarGravatar", 20, false, false)); + if (app().settings().getBoolean(Keys.web.allowGravatar, true)) { + add(new GravatarImage("username", user, "navbarGravatar", 20, false)); } else { add(new Label("username", user.getDisplayName())); } add(new Label("displayName", user.getDisplayName())); - - add(new BookmarkablePageLink<Void>("myProfile", + + add(new BookmarkablePageLink<Void>("newRepository", + EditRepositoryPage.class).setVisible(user.canAdmin() || user.canCreate())); + + add(new BookmarkablePageLink<Void>("myProfile", UserPage.class, WicketUtils.newUsernameParameter(user.username))); - add(new BookmarkablePageLink<Void>("changePassword", + add(new BookmarkablePageLink<Void>("changePassword", ChangePasswordPage.class).setVisible(editCredentials)); - + add(new BookmarkablePageLink<Void>("logout", LogoutPage.class).setVisible(standardLogin)); } -- Gitblit v1.9.1