From 4c835e61e8ea2d5af2acf0c85c3c1f0d06f419df Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 26 Oct 2011 17:19:55 -0400
Subject: [PATCH] Documentation.
---
src/com/gitblit/client/EditRepositoryDialog.java | 330 ++++++++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 279 insertions(+), 51 deletions(-)
diff --git a/src/com/gitblit/client/EditRepositoryDialog.java b/src/com/gitblit/client/EditRepositoryDialog.java
index 756128a..55f5268 100644
--- a/src/com/gitblit/client/EditRepositoryDialog.java
+++ b/src/com/gitblit/client/EditRepositoryDialog.java
@@ -16,6 +16,7 @@
package com.gitblit.client;
import java.awt.BorderLayout;
+import java.awt.Component;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
@@ -23,8 +24,15 @@
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
+import java.awt.event.KeyEvent;
+import java.text.MessageFormat;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
import java.util.List;
+import java.util.Set;
+import javax.swing.DefaultComboBoxModel;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JCheckBox;
@@ -32,21 +40,34 @@
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JLabel;
+import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
+import javax.swing.JRootPane;
+import javax.swing.JTabbedPane;
import javax.swing.JTextField;
+import javax.swing.KeyStroke;
+import javax.swing.ListCellRenderer;
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.Constants.FederationStrategy;
import com.gitblit.models.RepositoryModel;
-import com.gitblit.models.UserModel;
import com.gitblit.utils.StringUtils;
+/**
+ * Dialog to create/edit a repository.
+ *
+ * @author James Moger
+ */
public class EditRepositoryDialog extends JDialog {
private static final long serialVersionUID = 1L;
+ private final String repositoryName;
+
private final RepositoryModel repository;
+
+ private boolean isCreate;
private boolean canceled = true;
@@ -62,91 +83,132 @@
private JCheckBox showReadme;
+ private JCheckBox skipSizeCalculation;
+
+ private JCheckBox skipSummaryMetrics;
+
private JCheckBox isFrozen;
private JComboBox accessRestriction;
private JComboBox federationStrategy;
- private JComboBox owner;
+ private JComboBox ownerField;
private JPalette<String> usersPalette;
private JPalette<String> setsPalette;
- public EditRepositoryDialog(List<UserModel> allusers) {
- this(new RepositoryModel(), allusers);
- setTitle("Create Repository");
+ private Set<String> repositoryNames;
+
+ public EditRepositoryDialog() {
+ this(new RepositoryModel());
+ this.isCreate = true;
+ setTitle(Translation.get("gb.newRepository"));
}
- public EditRepositoryDialog(RepositoryModel aRepository, List<UserModel> allUsers) {
+ public EditRepositoryDialog(RepositoryModel aRepository) {
super();
+ this.repositoryName = aRepository.name;
this.repository = new RepositoryModel();
- initialize(aRepository, allUsers);
+ this.repositoryNames = new HashSet<String>();
+ this.isCreate = false;
+ initialize(aRepository);
setModal(true);
- setTitle("Edit Repository: " + aRepository.name);
+ setResizable(false);
+ setTitle(Translation.get("gb.edit") + ": " + aRepository.name);
setIconImage(new ImageIcon(getClass().getResource("/gitblt-favicon.png")).getImage());
}
- private void initialize(RepositoryModel anRepository, List<UserModel> allUsers) {
+ @Override
+ protected JRootPane createRootPane() {
+ KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
+ JRootPane rootPane = new JRootPane();
+ rootPane.registerKeyboardAction(new ActionListener() {
+ public void actionPerformed(ActionEvent actionEvent) {
+ setVisible(false);
+ }
+ }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
+ return rootPane;
+ }
+
+ private void initialize(RepositoryModel anRepository) {
nameField = new JTextField(anRepository.name == null ? "" : anRepository.name, 35);
descriptionField = new JTextField(anRepository.description == null ? ""
: anRepository.description, 35);
- owner = new JComboBox(allUsers.toArray());
- if (!StringUtils.isEmpty(anRepository.owner)) {
- UserModel currentOwner = null;
- for (UserModel user : allUsers) {
- if (user.username.equalsIgnoreCase(anRepository.owner)) {
- currentOwner = user;
- break;
- }
- }
- owner.setSelectedItem(currentOwner);
- }
+ JTextField originField = new JTextField(anRepository.origin == null ? ""
+ : anRepository.origin, 40);
+ originField.setEditable(false);
- useTickets = new JCheckBox("distributed Ticgit issues", anRepository.useTickets);
- useDocs = new JCheckBox("enumerates Markdown documentation in repository",
- anRepository.useDocs);
- showRemoteBranches = new JCheckBox("show remote branches", anRepository.showRemoteBranches);
- showReadme = new JCheckBox("show a \"readme\" Markdown file on the summary page",
+ ownerField = new JComboBox();
+
+ useTickets = new JCheckBox(Translation.get("gb.useTicketsDescription"),
+ anRepository.useTickets);
+ useDocs = new JCheckBox(Translation.get("gb.useDocsDescription"), anRepository.useDocs);
+ showRemoteBranches = new JCheckBox(Translation.get("gb.showRemoteBranchesDescription"),
+ anRepository.showRemoteBranches);
+ showReadme = new JCheckBox(Translation.get("gb.showReadmeDescription"),
anRepository.showReadme);
- isFrozen = new JCheckBox("deny push operations", anRepository.isFrozen);
+ skipSizeCalculation = new JCheckBox(Translation.get("gb.skipSizeCalculationDescription"),
+ anRepository.skipSizeCalculation);
+ skipSummaryMetrics = new JCheckBox(Translation.get("gb.skipSummaryMetricsDescription"),
+ anRepository.skipSummaryMetrics);
+ isFrozen = new JCheckBox(Translation.get("gb.isFrozenDescription"), anRepository.isFrozen);
accessRestriction = new JComboBox(AccessRestrictionType.values());
+ accessRestriction.setRenderer(new AccessRestrictionRenderer());
accessRestriction.setSelectedItem(anRepository.accessRestriction);
- federationStrategy = new JComboBox(FederationStrategy.values());
+ // federation strategies - remove ORIGIN choice if this repository has
+ // no origin.
+ List<FederationStrategy> federationStrategies = new ArrayList<FederationStrategy>(
+ Arrays.asList(FederationStrategy.values()));
+ if (StringUtils.isEmpty(anRepository.origin)) {
+ federationStrategies.remove(FederationStrategy.FEDERATE_ORIGIN);
+ }
+ federationStrategy = new JComboBox(federationStrategies.toArray());
+ federationStrategy.setRenderer(new FederationStrategyRenderer());
federationStrategy.setSelectedItem(anRepository.federationStrategy);
JPanel fieldsPanel = new JPanel(new GridLayout(0, 1));
- fieldsPanel.add(newFieldPanel("name", nameField));
- fieldsPanel.add(newFieldPanel("description", descriptionField));
- fieldsPanel.add(newFieldPanel("owner", owner));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.name"), nameField));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.description"), descriptionField));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.origin"), originField));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.owner"), ownerField));
- fieldsPanel.add(newFieldPanel("enable tickets", useTickets));
- fieldsPanel.add(newFieldPanel("enable docs", useDocs));
- fieldsPanel.add(newFieldPanel("show remote branches", showRemoteBranches));
- fieldsPanel.add(newFieldPanel("show readme", showReadme));
- fieldsPanel.add(newFieldPanel("is frozen", isFrozen));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.enableTickets"), useTickets));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.enableDocs"), useDocs));
+ fieldsPanel
+ .add(newFieldPanel(Translation.get("gb.showRemoteBranches"), showRemoteBranches));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.showReadme"), showReadme));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.skipSizeCalculation"),
+ skipSizeCalculation));
+ fieldsPanel
+ .add(newFieldPanel(Translation.get("gb.skipSummaryMetrics"), skipSummaryMetrics));
+ fieldsPanel.add(newFieldPanel(Translation.get("gb.isFrozen"), isFrozen));
usersPalette = new JPalette<String>();
JPanel accessPanel = new JPanel(new BorderLayout(5, 5));
- accessPanel.add(newFieldPanel("access restriction", accessRestriction), BorderLayout.NORTH);
- accessPanel.add(newFieldPanel("permitted users", usersPalette), BorderLayout.CENTER);
+ accessPanel.add(newFieldPanel(Translation.get("gb.accessRestriction"), accessRestriction),
+ BorderLayout.NORTH);
+ accessPanel.add(newFieldPanel(Translation.get("gb.permittedUsers"), usersPalette),
+ BorderLayout.CENTER);
setsPalette = new JPalette<String>();
JPanel federationPanel = new JPanel(new BorderLayout(5, 5));
- federationPanel.add(newFieldPanel("federation strategy", federationStrategy),
+ federationPanel.add(
+ newFieldPanel(Translation.get("gb.federationStrategy"), federationStrategy),
BorderLayout.NORTH);
- federationPanel.add(newFieldPanel("federation sets", setsPalette), BorderLayout.CENTER);
+ federationPanel.add(newFieldPanel(Translation.get("gb.federationSets"), setsPalette),
+ BorderLayout.CENTER);
- JPanel panel = new JPanel(new BorderLayout(5, 5));
- panel.add(fieldsPanel, BorderLayout.NORTH);
- panel.add(accessPanel, BorderLayout.CENTER);
- panel.add(federationPanel, BorderLayout.SOUTH);
+ JTabbedPane panel = new JTabbedPane(JTabbedPane.TOP);
+ panel.addTab(Translation.get("gb.general"), fieldsPanel);
+ panel.addTab(Translation.get("gb.accessRestriction"), accessPanel);
+ panel.addTab(Translation.get("gb.federation"), federationPanel);
- JButton createButton = new JButton("Save");
+ JButton createButton = new JButton(Translation.get("gb.save"));
createButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent event) {
if (validateFields()) {
@@ -156,7 +218,7 @@
}
});
- JButton cancelButton = new JButton("Cancel");
+ JButton cancelButton = new JButton(Translation.get("gb.cancel"));
cancelButton.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent event) {
canceled = true;
@@ -184,7 +246,6 @@
getContentPane().setLayout(new BorderLayout(5, 5));
getContentPane().add(centerPanel, BorderLayout.CENTER);
pack();
- setLocationRelativeTo(null);
}
private JPanel newFieldPanel(String label, JComponent comp) {
@@ -198,17 +259,114 @@
}
private boolean validateFields() {
- // TODO validate input and populate model
+ String rname = nameField.getText();
+ if (StringUtils.isEmpty(rname)) {
+ error("Please enter a repository name!");
+ return false;
+ }
+
+ // automatically convert backslashes to forward slashes
+ rname = rname.replace('\\', '/');
+ // Automatically replace // with /
+ rname = rname.replace("//", "/");
+
+ // prohibit folder paths
+ if (rname.startsWith("/")) {
+ error("Leading root folder references (/) are prohibited.");
+ return false;
+ }
+ if (rname.startsWith("../")) {
+ error("Relative folder references (../) are prohibited.");
+ return false;
+ }
+ if (rname.contains("/../")) {
+ error("Relative folder references (../) are prohibited.");
+ return false;
+ }
+
+ // confirm valid characters in repository name
+ Character c = StringUtils.findInvalidCharacter(rname);
+ if (c != null) {
+ error(MessageFormat.format("Illegal character ''{0}'' in repository name!", c));
+ return false;
+ }
+
+ // verify repository name uniqueness on create
+ if (isCreate) {
+ // force repo names to lowercase
+ // this means that repository name checking for rpc creation
+ // is case-insensitive, regardless of the Gitblit server's
+ // filesystem
+ if (repositoryNames.contains(rname.toLowerCase())) {
+ error(MessageFormat.format(
+ "Can not create repository ''{0}'' because it already exists.", rname));
+ return false;
+ }
+ } else {
+ // check rename collision
+ if (!repositoryName.equalsIgnoreCase(rname)) {
+ if (repositoryNames.contains(rname.toLowerCase())) {
+ error(MessageFormat.format(
+ "Failed to rename ''{0}'' because ''{1}'' already exists.",
+ repositoryName, rname));
+ return false;
+ }
+ }
+ }
+
+ if (accessRestriction.getSelectedItem() == null) {
+ error("Please select access restriction!");
+ return false;
+ }
+
+ if (federationStrategy.getSelectedItem() == null) {
+ error("Please select federation strategy!");
+ return false;
+ }
+
+ repository.name = rname;
+ repository.description = descriptionField.getText();
+ repository.owner = ownerField.getSelectedItem() == null ? null : ownerField
+ .getSelectedItem().toString();
+ repository.useTickets = useTickets.isSelected();
+ repository.useDocs = useDocs.isSelected();
+ repository.showRemoteBranches = showRemoteBranches.isSelected();
+ repository.showReadme = showReadme.isSelected();
+ repository.skipSizeCalculation = skipSizeCalculation.isSelected();
+ repository.skipSummaryMetrics = skipSummaryMetrics.isSelected();
+ repository.isFrozen = isFrozen.isSelected();
+
+ repository.accessRestriction = (AccessRestrictionType) accessRestriction.getSelectedItem();
+ repository.federationStrategy = (FederationStrategy) federationStrategy.getSelectedItem();
+
+ if (repository.federationStrategy.exceeds(FederationStrategy.EXCLUDE)) {
+ repository.federationSets = setsPalette.getSelections();
+ }
return true;
}
- private void showValidationError(String message) {
- JOptionPane.showMessageDialog(EditRepositoryDialog.this, message, "Validation Error",
- JOptionPane.ERROR_MESSAGE);
+ private void error(String message) {
+ JOptionPane.showMessageDialog(EditRepositoryDialog.this, message,
+ Translation.get("gb.error"), JOptionPane.ERROR_MESSAGE);
}
- public void setUsers(List<String> all, List<String> selected) {
+ public void setUsers(String owner, List<String> all, List<String> selected) {
+ ownerField.setModel(new DefaultComboBoxModel(all.toArray()));
+ if (!StringUtils.isEmpty(owner)) {
+ ownerField.setSelectedItem(owner);
+ }
usersPalette.setObjects(all, selected);
+ }
+
+ public void setRepositories(List<RepositoryModel> repositories) {
+ repositoryNames.clear();
+ for (RepositoryModel repository : repositories) {
+ // force repo names to lowercase
+ // this means that repository name checking for rpc creation
+ // is case-insensitive, regardless of the Gitblit server's
+ // filesystem
+ repositoryNames.add(repository.name.toLowerCase());
+ }
}
public void setFederationSets(List<String> all, List<String> selected) {
@@ -221,4 +379,74 @@
}
return repository;
}
+
+ public List<String> getPermittedUsers() {
+ return usersPalette.getSelections();
+ }
+
+ /**
+ * ListCellRenderer to display descriptive text about the access
+ * restriction.
+ *
+ */
+ private class AccessRestrictionRenderer extends JLabel implements ListCellRenderer {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public Component getListCellRendererComponent(JList list, Object value, int index,
+ boolean isSelected, boolean cellHasFocus) {
+ if (value instanceof AccessRestrictionType) {
+ AccessRestrictionType restriction = (AccessRestrictionType) value;
+ switch (restriction) {
+ case NONE:
+ setText(Translation.get("gb.notRestricted"));
+ break;
+ case PUSH:
+ setText(Translation.get("gb.pushRestricted"));
+ break;
+ case CLONE:
+ setText(Translation.get("gb.cloneRestricted"));
+ break;
+ case VIEW:
+ setText(Translation.get("gb.viewRestricted"));
+ break;
+ }
+ } else {
+ setText(value.toString());
+ }
+ return this;
+ }
+ }
+
+ /**
+ * ListCellRenderer to display descriptive text about the federation
+ * strategy.
+ */
+ private class FederationStrategyRenderer extends JLabel implements ListCellRenderer {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public Component getListCellRendererComponent(JList list, Object value, int index,
+ boolean isSelected, boolean cellHasFocus) {
+ if (value instanceof FederationStrategy) {
+ FederationStrategy strategy = (FederationStrategy) value;
+ switch (strategy) {
+ case EXCLUDE:
+ setText(Translation.get("gb.excludeFromFederation"));
+ break;
+ case FEDERATE_THIS:
+ setText(Translation.get("gb.federateThis"));
+ break;
+ case FEDERATE_ORIGIN:
+ setText(Translation.get("gb.federateOrigin"));
+ break;
+ }
+ } else {
+ setText(value.toString());
+ }
+ return this;
+ }
+ }
}
--
Gitblit v1.9.1