blob: a6ff1d745e79a8c1a6702a18d1e539929325f68f [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.apache.archiva.common.utils;<a name="line.1"></a>
<FONT color="green">002</FONT> <a name="line.2"></a>
<FONT color="green">003</FONT> /*<a name="line.3"></a>
<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<FONT color="green">013</FONT> *<a name="line.13"></a>
<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.commons.lang.StringUtils;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.regex.Matcher;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.regex.Pattern;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Version utility methods.<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> public class VersionUtil<a name="line.30"></a>
<FONT color="green">031</FONT> {<a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * These are the version patterns found in the filenames of the various artifact's versions IDs.<a name="line.33"></a>
<FONT color="green">034</FONT> * These patterns are all tackling lowercase version IDs.<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> private static final String versionPatterns[] =<a name="line.36"></a>
<FONT color="green">037</FONT> new String[]{ "([0-9][_.0-9a-z]*)", "(snapshot)", "(g?[_.0-9ab]*(pre|rc|g|m)[_.0-9]*)", "(dev[_.0-9]*)",<a name="line.37"></a>
<FONT color="green">038</FONT> "(alpha[_.0-9]*)", "(beta[_.0-9]*)", "(rc[_.0-9]*)",<a name="line.38"></a>
<FONT color="green">039</FONT> // "(test[_.0-9]*)", -- omitted for MRM-681, can be reinstated as part of MRM-712<a name="line.39"></a>
<FONT color="green">040</FONT> "(debug[_.0-9]*)", "(unofficial[_.0-9]*)", "(current)", "(latest)", "(fcs)", "(release[_.0-9]*)",<a name="line.40"></a>
<FONT color="green">041</FONT> "(nightly)", "(final)", "(incubating)", "(incubator)", "([ab][_.0-9]+)" };<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> public static final String SNAPSHOT = "SNAPSHOT";<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> public static final Pattern UNIQUE_SNAPSHOT_PATTERN = Pattern.compile( "^(.*)-([0-9]{8}\\.[0-9]{6})-([0-9]+)$" );<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> public static final Pattern TIMESTAMP_PATTERN = Pattern.compile( "^([0-9]{8})\\.([0-9]{6})$" );<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> public static final Pattern GENERIC_SNAPSHOT_PATTERN = Pattern.compile( "^(.*)-" + SNAPSHOT );<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private static final Pattern VERSION_MEGA_PATTERN =<a name="line.51"></a>
<FONT color="green">052</FONT> Pattern.compile( StringUtils.join( versionPatterns, '|' ), Pattern.CASE_INSENSITIVE );<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> /**<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;p&gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * Tests if the unknown string contains elements that identify it as a version string (or not).<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;/p&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * &lt;p/&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;p&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * The algorithm tests each part of the string that is delimited by a '-' (dash) character.<a name="line.60"></a>
<FONT color="green">061</FONT> * If 75% or more of the sections are identified as 'version' strings, the result is<a name="line.61"></a>
<FONT color="green">062</FONT> * determined to be of a high probability to be version identifier string.<a name="line.62"></a>
<FONT color="green">063</FONT> * &lt;/p&gt;<a name="line.63"></a>
<FONT color="green">064</FONT> *<a name="line.64"></a>
<FONT color="green">065</FONT> * @param unknown the unknown string to test.<a name="line.65"></a>
<FONT color="green">066</FONT> * @return true if the unknown string is likely a version string.<a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> public static boolean isVersion( String unknown )<a name="line.68"></a>
<FONT color="green">069</FONT> {<a name="line.69"></a>
<FONT color="green">070</FONT> String versionParts[] = StringUtils.split( unknown, '-' );<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> Matcher mat;<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> int countValidParts = 0;<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> for ( int i = 0; i &lt; versionParts.length; i++ )<a name="line.76"></a>
<FONT color="green">077</FONT> {<a name="line.77"></a>
<FONT color="green">078</FONT> String part = versionParts[i];<a name="line.78"></a>
<FONT color="green">079</FONT> mat = VERSION_MEGA_PATTERN.matcher( part );<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> if ( mat.matches() )<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> if ( i == 0 ) // loosen rule to return true if first token matches<a name="line.83"></a>
<FONT color="green">084</FONT> {<a name="line.84"></a>
<FONT color="green">085</FONT> return true;<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> countValidParts++;<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /* Calculate version probability as true if 3/4's of the input string has pieces of<a name="line.91"></a>
<FONT color="green">092</FONT> * of known version identifier strings.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> int threshold = (int) Math.floor( Math.max( (double) 1.0, (double) ( versionParts.length * 0.75 ) ) );<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> return ( countValidParts &gt;= threshold );<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> /**<a name="line.99"></a>
<FONT color="green">100</FONT> * &lt;p&gt;<a name="line.100"></a>
<FONT color="green">101</FONT> * Tests if the identifier is a known simple version keyword.<a name="line.101"></a>
<FONT color="green">102</FONT> * &lt;/p&gt;<a name="line.102"></a>
<FONT color="green">103</FONT> * &lt;p/&gt;<a name="line.103"></a>
<FONT color="green">104</FONT> * &lt;p&gt;<a name="line.104"></a>
<FONT color="green">105</FONT> * This method is different from {@link #isVersion(String)} in that it tests the whole input string in<a name="line.105"></a>
<FONT color="green">106</FONT> * one go as a simple identifier. (eg "alpha", "1.0", "beta", "debug", "latest", "rc#", etc...)<a name="line.106"></a>
<FONT color="green">107</FONT> * &lt;/p&gt;<a name="line.107"></a>
<FONT color="green">108</FONT> *<a name="line.108"></a>
<FONT color="green">109</FONT> * @param identifier the identifier to test.<a name="line.109"></a>
<FONT color="green">110</FONT> * @return true if the unknown string is likely a version string.<a name="line.110"></a>
<FONT color="green">111</FONT> */<a name="line.111"></a>
<FONT color="green">112</FONT> public static boolean isSimpleVersionKeyword( String identifier )<a name="line.112"></a>
<FONT color="green">113</FONT> {<a name="line.113"></a>
<FONT color="green">114</FONT> Matcher mat = VERSION_MEGA_PATTERN.matcher( identifier );<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> return mat.matches();<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> public static boolean isSnapshot( String version )<a name="line.119"></a>
<FONT color="green">120</FONT> {<a name="line.120"></a>
<FONT color="green">121</FONT> Matcher m = UNIQUE_SNAPSHOT_PATTERN.matcher( version );<a name="line.121"></a>
<FONT color="green">122</FONT> if ( m.matches() )<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> return true;<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> else<a name="line.126"></a>
<FONT color="green">127</FONT> {<a name="line.127"></a>
<FONT color="green">128</FONT> return isGenericSnapshot( version );<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> public static String getBaseVersion( String version )<a name="line.132"></a>
<FONT color="green">133</FONT> {<a name="line.133"></a>
<FONT color="green">134</FONT> Matcher m = UNIQUE_SNAPSHOT_PATTERN.matcher( version );<a name="line.134"></a>
<FONT color="green">135</FONT> if ( m.matches() )<a name="line.135"></a>
<FONT color="green">136</FONT> {<a name="line.136"></a>
<FONT color="green">137</FONT> return m.group( 1 ) + "-" + SNAPSHOT;<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> else<a name="line.139"></a>
<FONT color="green">140</FONT> {<a name="line.140"></a>
<FONT color="green">141</FONT> return version;<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> <a name="line.144"></a>
<FONT color="green">145</FONT> /**<a name="line.145"></a>
<FONT color="green">146</FONT> * &lt;p&gt;<a name="line.146"></a>
<FONT color="green">147</FONT> * Get the release version of the snapshot version.<a name="line.147"></a>
<FONT color="green">148</FONT> * &lt;/p&gt;<a name="line.148"></a>
<FONT color="green">149</FONT> * &lt;p/&gt;<a name="line.149"></a>
<FONT color="green">150</FONT> * &lt;p&gt;<a name="line.150"></a>
<FONT color="green">151</FONT> * If snapshot version is 1.0-SNAPSHOT, then release version would be 1.0<a name="line.151"></a>
<FONT color="green">152</FONT> * And if snapshot version is 1.0-20070113.163208-1.jar, then release version would still be 1.0<a name="line.152"></a>
<FONT color="green">153</FONT> * &lt;/p&gt;<a name="line.153"></a>
<FONT color="green">154</FONT> *<a name="line.154"></a>
<FONT color="green">155</FONT> * @param snapshotVersion<a name="line.155"></a>
<FONT color="green">156</FONT> * @return<a name="line.156"></a>
<FONT color="green">157</FONT> */<a name="line.157"></a>
<FONT color="green">158</FONT> public static String getReleaseVersion( String snapshotVersion )<a name="line.158"></a>
<FONT color="green">159</FONT> {<a name="line.159"></a>
<FONT color="green">160</FONT> Matcher m = UNIQUE_SNAPSHOT_PATTERN.matcher( snapshotVersion );<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> if ( isGenericSnapshot( snapshotVersion ) )<a name="line.162"></a>
<FONT color="green">163</FONT> {<a name="line.163"></a>
<FONT color="green">164</FONT> m = GENERIC_SNAPSHOT_PATTERN.matcher( snapshotVersion );<a name="line.164"></a>
<FONT color="green">165</FONT> }<a name="line.165"></a>
<FONT color="green">166</FONT> <a name="line.166"></a>
<FONT color="green">167</FONT> if ( m.matches() )<a name="line.167"></a>
<FONT color="green">168</FONT> {<a name="line.168"></a>
<FONT color="green">169</FONT> return m.group( 1 );<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
<FONT color="green">171</FONT> else<a name="line.171"></a>
<FONT color="green">172</FONT> {<a name="line.172"></a>
<FONT color="green">173</FONT> return snapshotVersion;<a name="line.173"></a>
<FONT color="green">174</FONT> }<a name="line.174"></a>
<FONT color="green">175</FONT> }<a name="line.175"></a>
<FONT color="green">176</FONT> <a name="line.176"></a>
<FONT color="green">177</FONT> public static boolean isUniqueSnapshot( String version )<a name="line.177"></a>
<FONT color="green">178</FONT> {<a name="line.178"></a>
<FONT color="green">179</FONT> Matcher m = UNIQUE_SNAPSHOT_PATTERN.matcher( version );<a name="line.179"></a>
<FONT color="green">180</FONT> if ( m.matches() )<a name="line.180"></a>
<FONT color="green">181</FONT> {<a name="line.181"></a>
<FONT color="green">182</FONT> return true;<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
<FONT color="green">184</FONT> <a name="line.184"></a>
<FONT color="green">185</FONT> return false;<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> <a name="line.187"></a>
<FONT color="green">188</FONT> public static boolean isGenericSnapshot( String version )<a name="line.188"></a>
<FONT color="green">189</FONT> {<a name="line.189"></a>
<FONT color="green">190</FONT> return version.endsWith( SNAPSHOT );<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> public static String getVersionFromGenericSnapshot( String version )<a name="line.193"></a>
<FONT color="green">194</FONT> {<a name="line.194"></a>
<FONT color="green">195</FONT> Matcher m = GENERIC_SNAPSHOT_PATTERN.matcher( version );<a name="line.195"></a>
<FONT color="green">196</FONT> if ( m.matches() )<a name="line.196"></a>
<FONT color="green">197</FONT> {<a name="line.197"></a>
<FONT color="green">198</FONT> return m.group( 1 );<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> return version;<a name="line.200"></a>
<FONT color="green">201</FONT> }<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
</PRE>
</BODY>
</HTML>