Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

extract the subversion address from the repo connection settings (anonymous and dev) to use it with the svn executable.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@384947 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier 2006-03-10 23:13:28 +00:00
parent 49e6ddb737
commit 7b212ef60f
2 changed files with 311 additions and 318 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

293
xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java
View File

@ -21,41 +21,33 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.StringUtils;
import org.apache.maven.scm.manager.NoSuchScmProviderException;
import org.apache.maven.scm.manager.ScmManager;
import org.apache.maven.scm.provider.clearcase.ClearCaseScmProvider; import org.apache.maven.scm.provider.clearcase.ClearCaseScmProvider;
import org.apache.maven.scm.provider.clearcase.repository.ClearCaseScmProviderRepository; import org.apache.maven.scm.provider.clearcase.repository.ClearCaseScmProviderRepository;
import org.apache.maven.scm.provider.perforce.PerforceScmProvider; import org.apache.maven.scm.provider.perforce.PerforceScmProvider;
import org.apache.maven.scm.provider.perforce.repository.PerforceScmProviderRepository; import org.apache.maven.scm.provider.perforce.repository.PerforceScmProviderRepository;
import org.apache.maven.scm.provider.starteam.StarteamScmProvider; import org.apache.maven.scm.provider.starteam.StarteamScmProvider;
import org.apache.maven.scm.provider.starteam.repository.StarteamScmProviderRepository; import org.apache.maven.scm.provider.starteam.repository.StarteamScmProviderRepository;
import org.apache.maven.scm.repository.ScmRepository;
import org.apache.maven.scm.repository.ScmRepositoryException; import org.apache.maven.scm.repository.ScmRepositoryException;
import org.apache.maven.util.EnhancedStringTokenizer; import org.apache.maven.util.EnhancedStringTokenizer;
/** /**
* Utility class to manage SCM informations. * Utility class to manage SCM informations. NOTE: This is very CVS specific,
* NOTE: This is very CVS specific, but I would like to try additional SCM * but I would like to try additional SCM package like subversion ASAP.
* package like subversion ASAP.
* *
* @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
* @author <a href="mailto:aheritier@apache.org">Arnaud Heritier</a> * @author <a href="mailto:aheritier@apache.org">Arnaud Heritier</a>
* @version $Id$ * @version $Id$
*/ */
public final class ScmUtil public final class ScmUtil {
{
/** /**
* Get the SCM type. * Get the SCM type.
* *
* @param scmConnection the scm connection to analyse. * @param scmConnection
* the scm connection to analyse.
* @return the scm type : cvs, svn , ... * @return the scm type : cvs, svn , ...
*/ */
public String getScmType( final String scmConnection ) public String getScmType(final String scmConnection) {
{ if (isValid(scmConnection)) {
if ( isValid( scmConnection ) )
{
return splitSCMConnection(scmConnection)[1]; return splitSCMConnection(scmConnection)[1];
} }
@ -63,44 +55,39 @@ public final class ScmUtil
} }
/** /**
* Get cvs connection string. * Get cvs connection string. Used in
* Used in xdocs/src/plugin-resources/templates/scm/cvs.xml. * xdocs/src/plugin-resources/templates/scm/cvs.xml. If username == "",
* If username == "", assumes anonymous (pserver) connection. In this case, * assumes anonymous (pserver) connection. In this case, inserts a separator
* inserts a separator (':' or '|') between the username and '@' to indicate * (':' or '|') between the username and '@' to indicate that there is a
* that there is a password and that it is empty. * password and that it is empty. If username != "" it replaces username in
* If username != "" it replaces username in conn. * conn.
* *
* @param conn six token connection string * @param conn
* @param username username override if non-empty. * six token connection string
* @param username
* username override if non-empty.
* @return CVS root. * @return CVS root.
*/ */
public String getCvsConnection( String conn, String username ) public String getCvsConnection(String conn, String username) {
{
String[] tokens = splitSCMConnection(conn); String[] tokens = splitSCMConnection(conn);
if ( !tokens[1].equals( "cvs" ) ) if (!tokens[1].equals("cvs")) {
{
return ""; return "";
} }
String separator = getSCMConnectionSeparator(conn); String separator = getSCMConnectionSeparator(conn);
if ( tokens[3].indexOf( '@' ) >= 0 ) if (tokens[3].indexOf('@') >= 0) {
{ if (username.length() == 0) {
if ( username.length() == 0 ) username = tokens[3].substring(0, tokens[3].indexOf('@'))
{
username =
tokens[3].substring( 0, tokens[3].indexOf( '@' ) )
+ separator; + separator;
} }
tokens[3] = tokens[3] = username + "@"
username + "@"
+ tokens[3].substring(tokens[3].indexOf('@') + 1); + tokens[3].substring(tokens[3].indexOf('@') + 1);
} }
String result = String result = tokens[0] + ":" + tokens[1] + separator + tokens[2]
tokens[0] + ":" + tokens[1] + separator + tokens[2]
+ separator + tokens[3] + separator + tokens[4] + separator + separator + tokens[3] + separator + tokens[4] + separator
+ tokens[5]; + tokens[5];
@ -108,20 +95,17 @@ public final class ScmUtil
} }
/** /**
* Get cvs module. Used in * Get cvs module. Used in xdocs/src/plugin-resources/templates/scm/cvs.xml.
* xdocs/src/plugin-resources/templates/scm/cvs.xml.
* *
* @param conn six token connection string * @param conn
* six token connection string
* @return CVS module. * @return CVS module.
*/ */
public String getCvsModule( String conn ) public String getCvsModule(String conn) {
{ if (isValid(conn)) {
if ( isValid( conn ) )
{
String[] tokens = splitSCMConnection(conn); String[] tokens = splitSCMConnection(conn);
if ( !tokens[1].equals( "cvs" ) ) if (!tokens[1].equals("cvs")) {
{
return ""; return "";
} }
@ -132,16 +116,42 @@ public final class ScmUtil
} }
/** /**
* Create the documentation to provide an developer access with a <code>Perforce</code> SCM. * Get svn connection string. Used in
* For example, generate the following command line: * xdocs/src/plugin-resources/templates/scm/svn.xml. It removes the first
* <p>p4 -H hostname -p port -u username -P password path</p> * two elements (scm:svn:)
* <p>p4 -H hostname -p port -u username -P password path submit -c changement</p>
* *
* @param perforceRepo * @param conn
* @see <a href="http://www.perforce.com/perforce/doc.051/manuals/cmdref/index.html">http://www.perforce.com/perforce/doc.051/manuals/cmdref/index.html</> * the repository connection
* @return CVS root.
*/ */
public String developerAccessPerforce( String devConnection ) public String getSvnConnection(String conn) {
{ if (conn != null && conn.length() > 8
&& "svn".equals(conn.substring(4, 7)))
return conn.substring(8);
else {
System.err
.println("Your subversion connection does not seem to be valid: "
+ conn);
return "";
}
}
/**
* Create the documentation to provide an developer access with a
* <code>Perforce</code> SCM. For example, generate the following command
* line:
* <p>
* p4 -H hostname -p port -u username -P password path
* </p>
* <p>
* p4 -H hostname -p port -u username -P password path submit -c changement
* </p>
*
* @param devConnection
* @see <a
* href="http://www.perforce.com/perforce/doc.051/manuals/cmdref/index.html">http://www.perforce.com/perforce/doc.051/manuals/cmdref/index.html</>
*/
public String developerAccessPerforce(String devConnection) {
StringBuffer command = new StringBuffer(); StringBuffer command = new StringBuffer();
char delim = getSCMConnectionSeparator(devConnection).charAt(0); char delim = getSCMConnectionSeparator(devConnection).charAt(0);
@ -150,25 +160,21 @@ public final class ScmUtil
String scmSpecificUrl = devConnection.substring(13); String scmSpecificUrl = devConnection.substring(13);
try try {
{ perforceRepo = (PerforceScmProviderRepository) perforceProvider
perforceRepo = (PerforceScmProviderRepository) .makeProviderScmRepository(scmSpecificUrl, delim);
perforceProvider.makeProviderScmRepository( scmSpecificUrl, delim ); } catch (ScmRepositoryException e) {
} System.err
catch (ScmRepositoryException e) .println("Your developerConnection does not seem to be valid: "
{ + e.getMessage());
System.err.println( "Your developerConnection does not seem to be valid: " + e.getMessage() );
return ""; return "";
} }
command.append("p4"); command.append("p4");
if ( !StringUtils.isEmpty( perforceRepo.getHost() ) ) if (!StringUtils.isEmpty(perforceRepo.getHost())) {
{
command.append(" -H ").append(perforceRepo.getHost()); command.append(" -H ").append(perforceRepo.getHost());
} }
if ( perforceRepo.getPort() > 0 ) if (perforceRepo.getPort() > 0) {
{
command.append(" -p " + perforceRepo.getPort()); command.append(" -p " + perforceRepo.getPort());
} }
command.append(" -u username"); command.append(" -u username");
@ -184,15 +190,21 @@ public final class ScmUtil
// Starteam // Starteam
/** /**
* Create the documentation to provide an developer access with a <code>Starteam</code> SCM. * Create the documentation to provide an developer access with a
* For example, generate the following command line: * <code>Starteam</code> SCM. For example, generate the following command
* <p>stcmd co -x -nologo -stop -p myusername:mypassword@myhost:1234/projecturl -is</p> * line:
* <p>stcmd ci -x -nologo -stop -p myusername:mypassword@myhost:1234/projecturl -f NCI -is</p> * <p>
* stcmd co -x -nologo -stop -p myusername:mypassword@myhost:1234/projecturl
* -is
* </p>
* <p>
* stcmd ci -x -nologo -stop -p myusername:mypassword@myhost:1234/projecturl
* -f NCI -is
* </p>
* *
* @param starteamRepo * @param devConnection
*/ */
public String developerAccessStarteam( String devConnection ) public String developerAccessStarteam(String devConnection) {
{
StringBuffer command = new StringBuffer(); StringBuffer command = new StringBuffer();
char delim = getSCMConnectionSeparator(devConnection).charAt(0); char delim = getSCMConnectionSeparator(devConnection).charAt(0);
@ -202,20 +214,21 @@ public final class ScmUtil
String scmSpecificUrl = devConnection.substring(13); String scmSpecificUrl = devConnection.substring(13);
try try {
{ starteamRepo = (StarteamScmProviderRepository) starteamProvider
starteamRepo = (StarteamScmProviderRepository) .makeProviderScmRepository(scmSpecificUrl, delim);
starteamProvider.makeProviderScmRepository( scmSpecificUrl, delim ); } catch (ScmRepositoryException e) {
} System.err
catch (ScmRepositoryException e) .println("Your developerConnection does not seem to be valid: "
{ + e.getMessage());
System.err.println( "Your developerConnection does not seem to be valid: " + e.getMessage() );
return ""; return "";
} }
// Safety: remove the username/password if present // Safety: remove the username/password if present
String fullUrl = StringUtils.replace( starteamRepo.getFullUrl(), starteamRepo.getUser(), "username" ); String fullUrl = StringUtils.replace(starteamRepo.getFullUrl(),
fullUrl = StringUtils.replace( fullUrl, starteamRepo.getPassword(), "password" ); starteamRepo.getUser(), "username");
fullUrl = StringUtils.replace(fullUrl, starteamRepo.getPassword(),
"password");
command.append("stcmd co -x -nologo -stop -p "); command.append("stcmd co -x -nologo -stop -p ");
command.append(fullUrl); command.append(fullUrl);
@ -228,16 +241,17 @@ public final class ScmUtil
return command.toString(); return command.toString();
} }
/** /**
* Create the documentation to provide an developer access with a <code>Clearcase</code> SCM. * Create the documentation to provide an developer access with a
* For example, generate the following command line: * <code>Clearcase</code> SCM. For example, generate the following command
* <p>cleartool checkout module</p> * line:
* <p>
* cleartool checkout module
* </p>
* *
* @param clearCaseRepo * @param devConnection
*/ */
public String developerAccessClearCase( String devConnection ) public String developerAccessClearCase(String devConnection) {
{
StringBuffer command = new StringBuffer(); StringBuffer command = new StringBuffer();
char delim = getSCMConnectionSeparator(devConnection).charAt(0); char delim = getSCMConnectionSeparator(devConnection).charAt(0);
@ -247,44 +261,39 @@ public final class ScmUtil
String scmSpecificUrl = devConnection.substring(14); String scmSpecificUrl = devConnection.substring(14);
try try {
{ clearCaseRepo = (ClearCaseScmProviderRepository) clearCaseProvider
clearCaseRepo = (ClearCaseScmProviderRepository) .makeProviderScmRepository(scmSpecificUrl, delim);
clearCaseProvider.makeProviderScmRepository( scmSpecificUrl, delim ); } catch (ScmRepositoryException e) {
} System.err
catch (ScmRepositoryException e) .println("Your developerConnection does not seem to be valid: "
{ + e.getMessage());
System.err.println( "Your developerConnection does not seem to be valid: " + e.getMessage() );
return ""; return "";
} }
command.append( "cleartool checkout " ).append( clearCaseRepo.getViewName( "id" ) ); command.append("cleartool checkout ").append(
clearCaseRepo.getViewName("id"));
return command.toString(); return command.toString();
} }
/** /**
* Splits an SCM string into parts. * Splits an SCM string into parts.
* *
* @param connection * @param connection
* @return A string array of SCM parts * @return A string array of SCM parts
*/ */
public String[] splitSCMConnection( String connection ) public String[] splitSCMConnection(String connection) {
{ if (connection == null) {
if ( connection == null )
{
throw new NullPointerException("repository connection is null"); throw new NullPointerException("repository connection is null");
} }
if ( connection.length() < 5 ) if (connection.length() < 5) {
{
throw new IllegalArgumentException( throw new IllegalArgumentException(
"repository connection is too short"); "repository connection is too short");
} }
if ( !connection.startsWith( "scm:" ) ) if (!connection.startsWith("scm:")) {
{
throw new IllegalArgumentException( throw new IllegalArgumentException(
"repository connection must start with scm:"); "repository connection must start with scm:");
} }
@ -294,30 +303,22 @@ public final class ScmUtil
// If the tokenizer is going to work correctly then the character // If the tokenizer is going to work correctly then the character
// following "scm" must be the same as the delimiter, which is not // following "scm" must be the same as the delimiter, which is not
// always the case. Therefor we give it a modified connection. // always the case. Therefor we give it a modified connection.
String modifiedConnection = String modifiedConnection = "scm" + delimiter + connection.substring(4);
"scm" + delimiter + connection.substring( 4 );
EnhancedStringTokenizer tok = EnhancedStringTokenizer tok = new EnhancedStringTokenizer(
new EnhancedStringTokenizer( modifiedConnection, delimiter ); modifiedConnection, delimiter);
String[] tokens = tokenizerToArray(tok); String[] tokens = tokenizerToArray(tok);
// for a valid repository, it should be scm:<provider> at least // for a valid repository, it should be scm:<provider> at least
if ( ( tokens.length >= 1 ) && tokens[1].equals( "cvs" ) ) if ((tokens.length >= 1) && tokens[1].equals("cvs")) {
{ if ((tokens.length >= 2) && tokens[2].equals("local")) {
if ( ( tokens.length >= 2 ) && tokens[2].equals( "local" ) ) if (tokens.length == 6) {
{ if ((tokens[3].length() > 0) && !tokens[3].equals("local")) {
if ( tokens.length == 6 )
{
if ( ( tokens[3].length() > 0 )
&& !tokens[3].equals( "local" ) )
{
throw new IllegalArgumentException( throw new IllegalArgumentException(
"cvs local repository connection string must specify 5 tokens, or an empty 3rd token if 6"); "cvs local repository connection string must specify 5 tokens, or an empty 3rd token if 6");
} }
} } else if (tokens.length == 5) {
else if ( tokens.length == 5 )
{
String[] newTokens = new String[6]; String[] newTokens = new String[6];
newTokens[0] = tokens[0]; newTokens[0] = tokens[0];
@ -327,16 +328,13 @@ public final class ScmUtil
newTokens[4] = tokens[3]; newTokens[4] = tokens[3];
newTokens[5] = tokens[4]; newTokens[5] = tokens[4];
tokens = newTokens; tokens = newTokens;
} } else {
else
{
throw new IllegalArgumentException( throw new IllegalArgumentException(
"cvs local repository connection string doesn't contain five tokens"); "cvs local repository connection string doesn't contain five tokens");
} }
} }
if ( tokens.length != 6 ) if (tokens.length != 6) {
{
throw new IllegalArgumentException( throw new IllegalArgumentException(
"cvs repository connection string doesn't contain six tokens"); "cvs repository connection string doesn't contain six tokens");
} }
@ -347,22 +345,18 @@ public final class ScmUtil
/** /**
* Get the separator used in an SCM string * Get the separator used in an SCM string
*
* @param connection * @param connection
* @return String that can be either ":" or "|" * @return String that can be either ":" or "|"
*/ */
public String getSCMConnectionSeparator( String connection ) public String getSCMConnectionSeparator(String connection) {
{ if (connection == null) {
if ( connection == null )
{
throw new NullPointerException("repository connection is null"); throw new NullPointerException("repository connection is null");
} }
if ( connection.indexOf( "|" ) != -1 ) if (connection.indexOf("|") != -1) {
{
return "|"; return "|";
} } else {
else
{
return ":"; return ":";
} }
} }
@ -374,12 +368,10 @@ public final class ScmUtil
* @param tok * @param tok
* @return String[] * @return String[]
*/ */
public String[] tokenizerToArray( EnhancedStringTokenizer tok ) public String[] tokenizerToArray(EnhancedStringTokenizer tok) {
{
List l = new ArrayList(); List l = new ArrayList();
while ( tok.hasMoreTokens() ) while (tok.hasMoreTokens()) {
{
l.add(tok.nextToken()); l.add(tok.nextToken());
} }
@ -387,17 +379,16 @@ public final class ScmUtil
} }
/** /**
* Simple check for a value in the POM. Due to the Jelly swizzling fields that aren't set come * Simple check for a value in the POM. Due to the Jelly swizzling fields
* out as empty strings. This will not be required when the new lazy evaluation mechanism is put * that aren't set come out as empty strings. This will not be required when
* in place. * the new lazy evaluation mechanism is put in place.
* *
* @param value POM value to test. * @param value
* POM value to test.
* @return Is the value valid. * @return Is the value valid.
*/ */
protected boolean isValid( String value ) protected boolean isValid(String value) {
{ if ((value != null) && !value.trim().equals("")) {
if ( ( value != null ) && !value.trim().equals( "" ) )
{
return true; return true;
} }

6
xdoc/src/plugin-resources/templates/scm/svn.xml
View File

@ -12,6 +12,7 @@
#if ($repository.connection && $repository.connection != '') #if ($repository.connection && $repository.connection != '')
#set ($connscm = $scmUtil.getScmType($repository.connection)) #set ($connscm = $scmUtil.getScmType($repository.connection))
#set ($svnconn = $scmUtil.getSvnConnection($repository.connection))
#set ($conn = $repository.connection) #set ($conn = $repository.connection)
@ -40,13 +41,14 @@
bundle="plugin-resources.templates.templates" /> bundle="plugin-resources.templates.templates" />
</p> </p>
<source>svn checkout $conn $project.artifactId</source> <source>svn checkout $svnconn $project.artifactId</source>
</subsection> </subsection>
#end #end
#if ($repository.developerConnection && $repository.developerConnection != '') #if ($repository.developerConnection && $repository.developerConnection != '')
#set ($connscm = $scmUtil.getScmType($repository.developerConnection)) #set ($connscm = $scmUtil.getScmType($repository.developerConnection))
#set ($svnconn = $scmUtil.getSvnConnection($repository.developerConnection))
#set ($conn = $repository.developerConnection) #set ($conn = $repository.developerConnection)
@ -77,7 +79,7 @@
bundle="plugin-resources.templates.templates" /> bundle="plugin-resources.templates.templates" />
</p> </p>
<source>svn checkout $conn $project.artifactId</source> <source>svn checkout $svnconn $project.artifactId</source>
</subsection> </subsection>