James Moger
2012-09-10 fabe060d3a435f116128851f828e35c2af5fde67
src/com/gitblit/client/GitblitClient.java
@@ -15,188 +15,599 @@
 */
package com.gitblit.client;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.EventQueue;
import java.awt.Font;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import javax.swing.ImageIcon;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JPasswordField;
import javax.swing.JTabbedPane;
import javax.swing.JTextField;
import javax.swing.KeyStroke;
import javax.swing.UIManager;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import com.gitblit.Constants;
import com.gitblit.Constants.AccessRestrictionType;
import com.gitblit.Constants.AuthorizationControl;
import com.gitblit.GitBlitException.ForbiddenException;
import com.gitblit.GitBlitException.NotAllowedException;
import com.gitblit.GitBlitException.UnauthorizedException;
import com.gitblit.GitBlitException.UnknownRequestException;
import com.gitblit.Keys;
import com.gitblit.models.FederationModel;
import com.gitblit.models.FeedEntryModel;
import com.gitblit.models.FeedModel;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.ServerSettings;
import com.gitblit.models.ServerStatus;
import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
import com.gitblit.utils.ArrayUtils;
import com.gitblit.utils.RpcUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.SyndicationUtils;
/**
 * Sample RPC application.
 * GitblitClient is a object that retrieves data from a Gitblit server, caches
 * it for local operations, and allows updating or creating Gitblit objects.
 * 
 * @author James Moger
 * 
 */
public class GitblitClient extends JFrame {
public class GitblitClient implements Serializable {
   private static final long serialVersionUID = 1L;
   private JTabbedPane serverTabs;
   private GitblitRegistration localhost = new GitblitRegistration("default",
         "https://localhost:8443", "admin", "admin".toCharArray());
   private List<GitblitRegistration> registrations = new ArrayList<GitblitRegistration>();
   private JMenu recentMenu;
   private static final Date NEVER = new Date(0);
   private GitblitClient() {
      super();
   protected final GitblitRegistration reg;
   public final String url;
   public final String account;
   private final char[] password;
   private volatile int protocolVersion;
   private volatile boolean allowManagement;
   private volatile boolean allowAdministration;
   private volatile ServerSettings settings;
   private final List<RepositoryModel> allRepositories;
   private final List<UserModel> allUsers;
   private final List<TeamModel> allTeams;
   private final List<FederationModel> federationRegistrations;
   private final List<FeedModel> availableFeeds;
   private final List<FeedEntryModel> syndicatedEntries;
   private final Set<String> subscribedRepositories;
   private ServerStatus status;
   public GitblitClient(GitblitRegistration reg) {
      this.reg = reg;
      this.url = reg.url;
      this.account = reg.account;
      this.password = reg.password;
      this.allUsers = new ArrayList<UserModel>();
      this.allTeams = new ArrayList<TeamModel>();
      this.allRepositories = new ArrayList<RepositoryModel>();
      this.federationRegistrations = new ArrayList<FederationModel>();
      this.availableFeeds = new ArrayList<FeedModel>();
      this.syndicatedEntries = new ArrayList<FeedEntryModel>();
      this.subscribedRepositories = new HashSet<String>();
   }
   private void initialize() {
      setContentPane(getCenterPanel());
      setIconImage(new ImageIcon(getClass().getResource("/gitblt-favicon.png")).getImage());
   public void login() throws IOException {
      protocolVersion = RpcUtils.getProtocolVersion(url, account, password);
      refreshSettings();
      refreshAvailableFeeds();
      refreshRepositories();
      refreshSubscribedFeeds(0);
      setTitle("Gitblit RPC Client v" + Constants.VERSION + " (" + Constants.VERSION_DATE + ")");
      setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
      setSize(950, 600);
      try {
         // credentials may not have administrator access
         // or server may have disabled rpc management
         refreshUsers();
         if (protocolVersion > 1) {
            refreshTeams();
         }
         allowManagement = true;
      } catch (UnauthorizedException e) {
      } catch (ForbiddenException e) {
      } catch (NotAllowedException e) {
      } catch (UnknownRequestException e) {
      } catch (IOException e) {
         e.printStackTrace();
      }
      try {
         // credentials may not have administrator access
         // or server may have disabled rpc administration
         refreshStatus();
         allowAdministration = true;
      } catch (UnauthorizedException e) {
      } catch (ForbiddenException e) {
      } catch (NotAllowedException e) {
      } catch (UnknownRequestException e) {
      } catch (IOException e) {
         e.printStackTrace();
      }
   }
   public void setVisible(boolean value) {
      if (value) {
         if (registrations.size() == 0) {
            // default prompt
            if (loginPrompt(localhost)) {
               pack();
            }
         } else if (registrations.size() == 1) {
            // single registration prompt
            if (loginPrompt(registrations.get(0))) {
               pack();
   public int getProtocolVersion() {
      return protocolVersion;
   }
   public boolean allowManagement() {
      return allowManagement;
   }
   public boolean allowAdministration() {
      return allowAdministration;
   }
   public boolean isOwner(RepositoryModel model) {
      return account != null && account.equalsIgnoreCase(model.owner);
   }
   public String getURL(String action, String repository, String objectId) {
      boolean mounted = settings.get(Keys.web.mountParameters).getBoolean(true);
      StringBuilder sb = new StringBuilder();
      sb.append(url);
      sb.append('/');
      sb.append(action);
      sb.append('/');
      if (mounted) {
         // mounted url/action/repository/objectId
         sb.append(StringUtils.encodeURL(repository));
         if (!StringUtils.isEmpty(objectId)) {
            sb.append('/');
            sb.append(objectId);
         }
         return sb.toString();
      } else {
         // parameterized url/action/&r=repository&h=objectId
         sb.append("?r=");
         sb.append(repository);
         if (!StringUtils.isEmpty(objectId)) {
            sb.append("&h=");
            sb.append(objectId);
         }
         return sb.toString();
      }
   }
   public AccessRestrictionType getDefaultAccessRestriction() {
      String restriction = null;
      if (settings.hasKey(Keys.git.defaultAccessRestriction)) {
         restriction = settings.get(Keys.git.defaultAccessRestriction).currentValue;
      }
      return AccessRestrictionType.fromName(restriction);
   }
   public AuthorizationControl getDefaultAuthorizationControl() {
      String authorization = null;
      if (settings.hasKey(Keys.git.defaultAuthorizationControl)) {
         authorization = settings.get(Keys.git.defaultAuthorizationControl).currentValue;
      }
      return AuthorizationControl.fromName(authorization);
   }
   /**
    * Returns the list of pre-receive scripts the repository inherited from the
    * global settings and team affiliations.
    *
    * @param repository
    *            if null only the globally specified scripts are returned
    * @return a list of scripts
    */
   public List<String> getPreReceiveScriptsInherited(RepositoryModel repository) {
      Set<String> scripts = new LinkedHashSet<String>();
      // Globals
      for (String script : settings.get(Keys.groovy.preReceiveScripts).getStrings()) {
         if (script.endsWith(".groovy")) {
            scripts.add(script.substring(0, script.lastIndexOf('.')));
         } else {
            scripts.add(script);
         }
      }
      // Team Scripts
      if (repository != null) {
         for (String teamname : getPermittedTeamnames(repository)) {
            TeamModel team = getTeamModel(teamname);
            if (!ArrayUtils.isEmpty(team.preReceiveScripts)) {
               scripts.addAll(team.preReceiveScripts);
            }
         }
         super.setVisible(value);
         setLocationRelativeTo(null);
      }
      return new ArrayList<String>(scripts);
   }
   private JMenuBar setupMenu() {
      JMenuBar menuBar = new JMenuBar();
      JMenu serversMenu = new JMenu(Translation.get("gb.servers"));
      menuBar.add(serversMenu);
      recentMenu = new JMenu(Translation.get("gb.recent"));
      serversMenu.add(recentMenu);
      JMenuItem login = new JMenuItem(Translation.get("gb.login") + "...");
      login.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_L, KeyEvent.CTRL_DOWN_MASK, false));
      login.addActionListener(new ActionListener() {
         public void actionPerformed(ActionEvent event) {
            loginPrompt(localhost);
   /**
    * Returns the list of all available Groovy pre-receive push hook scripts
    * that are not already inherited by the repository. Script files must have
    * .groovy extension
    *
    * @param repository
    *            optional parameter
    * @return list of available hook scripts
    */
   public List<String> getPreReceiveScriptsUnused(RepositoryModel repository) {
      Set<String> inherited = new TreeSet<String>(getPreReceiveScriptsInherited(repository));
      // create list of available scripts by excluding inherited scripts
      List<String> scripts = new ArrayList<String>();
      for (String script : settings.pushScripts) {
         if (!inherited.contains(script)) {
            scripts.add(script);
         }
      });
      serversMenu.add(login);
      return menuBar;
   }
   private JPanel newLabelPanel(String text, JTextField field) {
      JLabel label = new JLabel(text);
      label.setFont(label.getFont().deriveFont(Font.BOLD));
      label.setPreferredSize(new Dimension(75, 10));
      JPanel jpanel = new JPanel(new BorderLayout());
      jpanel.add(label, BorderLayout.WEST);
      jpanel.add(field, BorderLayout.CENTER);
      return jpanel;
   }
   private JPanel getCenterPanel() {
      serverTabs = new JTabbedPane(JTabbedPane.TOP);
      JMenuBar menubar = setupMenu();
      JPanel panel = new JPanel(new BorderLayout());
      panel.add(menubar, BorderLayout.NORTH);
      panel.add(serverTabs, BorderLayout.CENTER);
      return panel;
   }
   private boolean loginPrompt(GitblitRegistration reg) {
      JTextField urlField = new JTextField(reg.url, 30);
      JTextField nameField = new JTextField(reg.name);
      JTextField accountField = new JTextField(reg.account);
      JPasswordField passwordField = new JPasswordField(new String(reg.password));
      JPanel panel = new JPanel(new GridLayout(0, 1, 5, 5));
      panel.add(newLabelPanel(Translation.get("gb.name"), nameField));
      panel.add(newLabelPanel(Translation.get("gb.url"), urlField));
      panel.add(newLabelPanel(Translation.get("gb.username"), accountField));
      panel.add(newLabelPanel(Translation.get("gb.password"), passwordField));
      int result = JOptionPane.showConfirmDialog(GitblitClient.this, panel,
            Translation.get("gb.login"), JOptionPane.OK_CANCEL_OPTION);
      if (result != JOptionPane.OK_OPTION) {
         return false;
      }
      String url = urlField.getText();
      if (StringUtils.isEmpty(url)) {
         return false;
      return scripts;
   }
   /**
    * Returns the list of post-receive scripts the repository inherited from
    * the global settings and team affiliations.
    *
    * @param repository
    *            if null only the globally specified scripts are returned
    * @return a list of scripts
    */
   public List<String> getPostReceiveScriptsInherited(RepositoryModel repository) {
      Set<String> scripts = new LinkedHashSet<String>();
      // Global Scripts
      for (String script : settings.get(Keys.groovy.postReceiveScripts).getStrings()) {
         if (script.endsWith(".groovy")) {
            scripts.add(script.substring(0, script.lastIndexOf('.')));
         } else {
            scripts.add(script);
         }
      }
      reg = new GitblitRegistration(nameField.getText(), url, accountField.getText(),
            passwordField.getPassword());
      boolean success = login(reg);
      registrations.add(0, reg);
      rebuildRecentMenu();
      // Team Scripts
      if (repository != null) {
         for (String teamname : getPermittedTeamnames(repository)) {
            TeamModel team = getTeamModel(teamname);
            if (!ArrayUtils.isEmpty(team.postReceiveScripts)) {
               scripts.addAll(team.postReceiveScripts);
            }
         }
      }
      return new ArrayList<String>(scripts);
   }
   /**
    * Returns the list of unused Groovy post-receive push hook scripts that are
    * not already inherited by the repository. Script files must have .groovy
    * extension
    *
    * @param repository
    *            optional parameter
    * @return list of available hook scripts
    */
   public List<String> getPostReceiveScriptsUnused(RepositoryModel repository) {
      Set<String> inherited = new TreeSet<String>(getPostReceiveScriptsInherited(repository));
      // create list of available scripts by excluding inherited scripts
      List<String> scripts = new ArrayList<String>();
      if (!ArrayUtils.isEmpty(settings.pushScripts)) {
         for (String script : settings.pushScripts) {
            if (!inherited.contains(script)) {
               scripts.add(script);
            }
         }
      }
      return scripts;
   }
   public ServerSettings getSettings() {
      return settings;
   }
   public ServerStatus getStatus() {
      return status;
   }
   public String getSettingDescription(String key) {
      return settings.get(key).description;
   }
   public List<RepositoryModel> refreshRepositories() throws IOException {
      Map<String, RepositoryModel> repositories = RpcUtils
            .getRepositories(url, account, password);
      allRepositories.clear();
      allRepositories.addAll(repositories.values());
      Collections.sort(allRepositories);
      markSubscribedFeeds();
      return allRepositories;
   }
   public List<UserModel> refreshUsers() throws IOException {
      List<UserModel> users = RpcUtils.getUsers(url, account, password);
      allUsers.clear();
      allUsers.addAll(users);
      return allUsers;
   }
   public List<TeamModel> refreshTeams() throws IOException {
      List<TeamModel> teams = RpcUtils.getTeams(url, account, password);
      allTeams.clear();
      allTeams.addAll(teams);
      return allTeams;
   }
   public ServerSettings refreshSettings() throws IOException {
      settings = RpcUtils.getSettings(url, account, password);
      return settings;
   }
   public ServerStatus refreshStatus() throws IOException {
      status = RpcUtils.getStatus(url, account, password);
      return status;
   }
   public List<String> getBranches(String repository) {
      List<FeedModel> feeds = getAvailableFeeds(repository);
      List<String> branches = new ArrayList<String>();
      for (FeedModel feed : feeds) {
         branches.add(feed.branch);
      }
      Collections.sort(branches);
      return branches;
   }
   public List<FeedModel> getAvailableFeeds() {
      return availableFeeds;
   }
   public List<FeedModel> getAvailableFeeds(RepositoryModel repository) {
      return getAvailableFeeds(repository.name);
   }
   public List<FeedModel> getAvailableFeeds(String repository) {
      List<FeedModel> repositoryFeeds = new ArrayList<FeedModel>();
      if (repository == null) {
         return repositoryFeeds;
      }
      for (FeedModel feed : availableFeeds) {
         if (feed.repository.equalsIgnoreCase(repository)) {
            repositoryFeeds.add(feed);
         }
      }
      return repositoryFeeds;
   }
   public List<FeedModel> refreshAvailableFeeds() throws IOException {
      List<FeedModel> feeds = RpcUtils.getBranchFeeds(url, account, password);
      availableFeeds.clear();
      availableFeeds.addAll(feeds);
      markSubscribedFeeds();
      return availableFeeds;
   }
   public List<FeedEntryModel> refreshSubscribedFeeds(int page) throws IOException {
      Set<FeedEntryModel> allEntries = new HashSet<FeedEntryModel>();
      if (reg.feeds.size() > 0) {
         for (FeedModel feed : reg.feeds) {
            feed.lastRefreshDate = feed.currentRefreshDate;
            feed.currentRefreshDate = new Date();
            List<FeedEntryModel> entries = SyndicationUtils.readFeed(url, feed.repository,
                  feed.branch, -1, page, account, password);
            allEntries.addAll(entries);
         }
      }
      reg.cacheFeeds();
      syndicatedEntries.clear();
      syndicatedEntries.addAll(allEntries);
      Collections.sort(syndicatedEntries);
      return syndicatedEntries;
   }
   public void updateSubscribedFeeds(List<FeedModel> list) {
      reg.updateSubscribedFeeds(list);
      markSubscribedFeeds();
   }
   private void markSubscribedFeeds() {
      subscribedRepositories.clear();
      for (FeedModel feed : availableFeeds) {
         // mark feed in the available list as subscribed
         feed.subscribed = reg.feeds.contains(feed);
         if (feed.subscribed) {
            subscribedRepositories.add(feed.repository.toLowerCase());
         }
      }
   }
   public Date getLastFeedRefresh(String repository, String branch) {
      FeedModel feed = new FeedModel();
      feed.repository = repository;
      feed.branch = branch;
      if (reg.feeds.contains(feed)) {
         int idx = reg.feeds.indexOf(feed);
         feed = reg.feeds.get(idx);
         return feed.lastRefreshDate;
      }
      return NEVER;
   }
   public boolean isSubscribed(RepositoryModel repository) {
      return subscribedRepositories.contains(repository.name.toLowerCase());
   }
   public List<FeedEntryModel> getSyndicatedEntries() {
      return syndicatedEntries;
   }
   public List<FeedEntryModel> log(String repository, String branch, int numberOfEntries, int page)
         throws IOException {
      return SyndicationUtils.readFeed(url, repository, branch, numberOfEntries, page, account,
            password);
   }
   public List<FeedEntryModel> search(String repository, String branch, String fragment,
         Constants.SearchType type, int numberOfEntries, int page) throws IOException {
      return SyndicationUtils.readSearchFeed(url, repository, branch, fragment, type,
            numberOfEntries, page, account, password);
   }
   public List<FederationModel> refreshFederationRegistrations() throws IOException {
      List<FederationModel> list = RpcUtils.getFederationRegistrations(url, account, password);
      federationRegistrations.clear();
      federationRegistrations.addAll(list);
      return federationRegistrations;
   }
   public List<UserModel> getUsers() {
      return allUsers;
   }
   public List<String> getUsernames() {
      List<String> usernames = new ArrayList<String>();
      for (UserModel user : this.allUsers) {
         usernames.add(user.username);
      }
      Collections.sort(usernames);
      return usernames;
   }
   public List<String> getPermittedUsernames(RepositoryModel repository) {
      List<String> usernames = new ArrayList<String>();
      for (UserModel user : this.allUsers) {
         if (user.repositories.contains(repository.name)) {
            usernames.add(user.username);
         }
      }
      return usernames;
   }
   public List<TeamModel> getTeams() {
      return allTeams;
   }
   public List<String> getTeamnames() {
      List<String> teamnames = new ArrayList<String>();
      for (TeamModel team : this.allTeams) {
         teamnames.add(team.name);
      }
      Collections.sort(teamnames);
      return teamnames;
   }
   public List<String> getPermittedTeamnames(RepositoryModel repository) {
      List<String> teamnames = new ArrayList<String>();
      for (TeamModel team : this.allTeams) {
         if (team.repositories.contains(repository.name)) {
            teamnames.add(team.name);
         }
      }
      return teamnames;
   }
   public TeamModel getTeamModel(String name) {
      for (TeamModel team : allTeams) {
         if (team.name.equalsIgnoreCase(name)) {
            return team;
         }
      }
      return null;
   }
   public List<String> getFederationSets() {
      return settings.get(Keys.federation.sets).getStrings();
   }
   public List<RepositoryModel> getRepositories() {
      return allRepositories;
   }
   public boolean createRepository(RepositoryModel repository, List<String> permittedUsers)
         throws IOException {
      return createRepository(repository, permittedUsers, null);
   }
   public boolean createRepository(RepositoryModel repository, List<String> permittedUsers,
         List<String> permittedTeams) throws IOException {
      boolean success = true;
      success &= RpcUtils.createRepository(repository, url, account, password);
      if (permittedUsers != null && permittedUsers.size() > 0) {
         // if new repository has named members, set them
         success &= RpcUtils.setRepositoryMembers(repository, permittedUsers, url, account,
               password);
      }
      if (permittedTeams != null && permittedTeams.size() > 0) {
         // if new repository has named teams, set them
         success &= RpcUtils.setRepositoryTeams(repository, permittedTeams, url, account,
               password);
      }
      return success;
   }
   private boolean login(GitblitRegistration reg) {
      try {
         GitblitPanel panel = new GitblitPanel(reg);
         panel.login();
         serverTabs.addTab(reg.name, panel);
         int idx = serverTabs.getTabCount() - 1;
         serverTabs.setSelectedIndex(idx);
         serverTabs.setTabComponentAt(idx, new ClosableTabComponent(reg.name, null, serverTabs,
               panel));
         return true;
      } catch (IOException e) {
         JOptionPane.showMessageDialog(GitblitClient.this, e.getMessage(),
               Translation.get("gb.error"), JOptionPane.ERROR_MESSAGE);
      }
      return false;
   public boolean updateRepository(String name, RepositoryModel repository,
         List<String> permittedUsers) throws IOException {
      return updateRepository(name, repository, permittedUsers, null);
   }
   private void rebuildRecentMenu() {
      recentMenu.removeAll();
      for (final GitblitRegistration reg : registrations) {
         JMenuItem item = new JMenuItem(reg.name);
         item.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
               login(reg);
            }
         });
         recentMenu.add(item);
   public boolean updateRepository(String name, RepositoryModel repository,
         List<String> permittedUsers, List<String> permittedTeams) throws IOException {
      boolean success = true;
      success &= RpcUtils.updateRepository(name, repository, url, account, password);
      // set the repository members
      if (permittedUsers != null) {
         success &= RpcUtils.setRepositoryMembers(repository, permittedUsers, url, account,
               password);
      }
      if (permittedTeams != null) {
         success &= RpcUtils.setRepositoryTeams(repository, permittedTeams, url, account,
               password);
      }
      return success;
   }
   public static void main(String[] args) {
      EventQueue.invokeLater(new Runnable() {
         public void run() {
            try {
               UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
            } catch (Exception e) {
            }
            GitblitClient frame = new GitblitClient();
            frame.initialize();
            frame.setVisible(true);
         }
      });
   public boolean deleteRepository(RepositoryModel repository) throws IOException {
      return RpcUtils.deleteRepository(repository, url, account, password);
   }
   public boolean clearRepositoryCache() throws IOException {
      return RpcUtils.clearRepositoryCache(url, account, password);
   }
   public boolean createUser(UserModel user) throws IOException {
      return RpcUtils.createUser(user, url, account, password);
   }
   public boolean updateUser(String name, UserModel user) throws IOException {
      return RpcUtils.updateUser(name, user, url, account, password);
   }
   public boolean deleteUser(UserModel user) throws IOException {
      return RpcUtils.deleteUser(user, url, account, password);
   }
   public boolean createTeam(TeamModel team) throws IOException {
      return RpcUtils.createTeam(team, url, account, password);
   }
   public boolean updateTeam(String name, TeamModel team) throws IOException {
      return RpcUtils.updateTeam(name, team, url, account, password);
   }
   public boolean deleteTeam(TeamModel team) throws IOException {
      return RpcUtils.deleteTeam(team, url, account, password);
   }
   public boolean updateSettings(Map<String, String> newSettings) throws IOException {
      return RpcUtils.updateSettings(newSettings, url, account, password);
   }
}