hudson.plugins.scm_sync_configuration.scms.impl.ScmSyncSubversionSCM Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm-sync-configuration Show documentation
SCM Sync Configuration Hudson plugin is aimed at 2 main features : First, keep sync'ed your config.xml (and other ressources) hudson files with a SCM repository (backup), Secondly, track changes (and author) made on every file with commit messages.
The newest version!
package hudson.plugins.scm_sync_configuration.scms.impl;

import hudson.plugins.scm_sync_configuration.scms.SCM;
import hudson.plugins.scm_sync_configuration.scms.SCMCredentialConfiguration;
import hudson.scm.SubversionSCM;
import hudson.scm.SubversionSCM.DescriptorImpl.Credential;

import java.lang.reflect.Field;
import java.util.Map;
import java.util.logging.Level;

import org.kohsuke.stapler.StaplerRequest;
import org.tmatesoft.svn.core.SVNErrorMessage;
import org.tmatesoft.svn.core.SVNException;
import org.tmatesoft.svn.core.SVNURL;
import org.tmatesoft.svn.core.auth.SVNAuthentication;
import org.tmatesoft.svn.core.auth.SVNPasswordAuthentication;
import org.tmatesoft.svn.core.auth.SVNSSHAuthentication;
import org.tmatesoft.svn.core.auth.SVNSSLAuthentication;
import org.tmatesoft.svn.core.auth.SVNUserNameAuthentication;
import org.tmatesoft.svn.core.internal.wc.DefaultSVNAuthenticationManager;
import org.tmatesoft.svn.core.io.SVNRepository;
import org.tmatesoft.svn.core.io.SVNRepositoryFactory;
import org.tmatesoft.svn.core.wc.SVNWCUtil;

public class ScmSyncSubversionSCM extends SCM {

	private static final String SCM_URL_PREFIX="scm:svn:";
	
	public ScmSyncSubversionSCM(){
		super("Subversion", "svn/config.jelly", "hudson.scm.SubversionSCM", "/hudson/plugins/scm_sync_configuration/ScmSyncConfigurationPlugin/scms/svn/url-help.jelly");
	}
	
	public String createScmUrlFromRequest(StaplerRequest req) {
		String repoURL = req.getParameter("repositoryUrl");
		if(repoURL == null){ return null; }
		else { return SCM_URL_PREFIX+repoURL; }
	}
	public String extractScmUrlFrom(String scmUrl) {
		return scmUrl.substring(SCM_URL_PREFIX.length());
	}
	public SCMCredentialConfiguration extractScmCredentials(String scmUrl) {
		LOGGER.info("Extracting SVN Credentials for url : "+scmUrl);
		String realm = retrieveRealmFor(scmUrl);
		if(realm != null){
			LOGGER.fine("Extracted realm from "+scmUrl+" is <"+realm+">");
			SubversionSCM.DescriptorImpl subversionDescriptor = (SubversionSCM.DescriptorImpl)getSCMDescriptor();
			try {
				Field credentialField = SubversionSCM.DescriptorImpl.class.getDeclaredField("credentials");
				credentialField.setAccessible(true);
				Map credentials = (Map)credentialField.get(subversionDescriptor);
				Credential cred = credentials.get(realm);
				if(cred == null){
					LOGGER.severe("No credentials are stored in Hudson for realm <"+realm+"> !");
					return null;
				}
				String kind = "";
				return createSCMCredentialConfiguration(cred.createSVNAuthentication(kind));
			} catch (SecurityException e) {
				LOGGER.log(Level.SEVERE, "'credentials' field not readable on SubversionSCM.DescriptorImpl !");
			} catch (NoSuchFieldException e) {
				LOGGER.log(Level.SEVERE, "'credentials' field not readable on SubversionSCM.DescriptorImpl !");
			} catch (IllegalArgumentException e) {
				LOGGER.log(Level.SEVERE, "'credentials' field not accessible on "+String.valueOf(subversionDescriptor)+" !");
			} catch (IllegalAccessException e) {
				LOGGER.log(Level.SEVERE, "'credentials' field not accessible on "+String.valueOf(subversionDescriptor)+" !");
			} catch (SVNException e) {
				LOGGER.log(Level.WARNING, "Error creating SVN authentication from realm <"+realm+"> !", e);
			}
		}
		return null;
	}
	
	private String retrieveRealmFor(String scmURL) {
		final String[] realms = new String[]{ null };
		
        SVNRepository repository;
        try {
			repository = SVNRepositoryFactory.create(SVNURL.parseURIDecoded(scmURL));
            repository.setTunnelProvider(SVNWCUtil.createDefaultOptions(true));
        }catch(SVNException e){
        	LOGGER.throwing(SVNRepositoryFactory.class.getName(), "create", e);
        	LOGGER.severe("Error while creating SVNRepository : "+e.getMessage());
        	return null;
        }
		try {
            repository.setAuthenticationManager(new DefaultSVNAuthenticationManager(SVNWCUtil.getDefaultConfigurationDirectory(), true, "", "", null, "") {
                @Override
                public SVNAuthentication getFirstAuthentication(String kind, String realm, SVNURL url) throws SVNException {
                	realms[0] = realm;
                	return super.getFirstAuthentication(kind, realm, url);
                }
                @Override
                public SVNAuthentication getNextAuthentication(String kind, String realm, SVNURL url) throws SVNException {
                	realms[0] = realm;
                	return super.getNextAuthentication(kind, realm, url);
                }

                @Override
                public void acknowledgeAuthentication(boolean accepted, String kind, String realm, SVNErrorMessage errorMessage, SVNAuthentication authentication) throws SVNException {
                	realms[0] = realm;
                	super.acknowledgeAuthentication(accepted, kind, realm, errorMessage, authentication);
                }
            });
            repository.testConnection();
            
		} catch (SVNException e) {
			// If a problem happens, don't do anything, it implies realm doesn't exist in current cache
		}

		return realms[0];
	}
	
	/**
	 * Ugly method to convert a SVN authentication into a SCMCredentialConfiguration
	 */
	public SCMCredentialConfiguration createSCMCredentialConfiguration(SVNAuthentication auth){
		if(auth instanceof SVNPasswordAuthentication){
			SVNPasswordAuthentication passAuth = (SVNPasswordAuthentication)auth;
			return new SCMCredentialConfiguration(passAuth.getUserName(), passAuth.getPassword());
		} else if(auth instanceof SVNSSHAuthentication){
			SVNSSHAuthentication sshAuth = (SVNSSHAuthentication)auth;
			return new SCMCredentialConfiguration(sshAuth.getUserName(), sshAuth.getPassword(), sshAuth.getPassphrase(), sshAuth.getPrivateKey());
		} else if(auth instanceof SVNSSLAuthentication){
			SVNSSLAuthentication sslAuth = (SVNSSLAuthentication)auth;
			return new SCMCredentialConfiguration(sslAuth.getUserName(), sslAuth.getPassword());
		} else if(auth instanceof SVNUserNameAuthentication){
			SVNUserNameAuthentication unameAuth = (SVNUserNameAuthentication)auth;
			return new SCMCredentialConfiguration(unameAuth.getUserName());
		}
		return null;
	}
}