Google Git
Sign in
apache / archiva-web-content / 6a36684a51c4a4c05fee92caa796b08d200b28d8 / . / ref / 2.2.4 / apidocs / src-html / org / apache / archiva / consumers / core / repository / AbstractRepositoryPurge.html
blob: 43f3b217336e390961ab6822ee74b252865f1d1a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.apache.archiva.consumers.core.repository;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>/*<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a>
<span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a>
<span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a>
<span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.archiva.metadata.model.facets.AuditEvent;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.archiva.common.utils.VersionUtil;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.archiva.metadata.model.ArtifactMetadata;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.archiva.metadata.model.maven2.MavenArtifactFacet;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.archiva.metadata.repository.MetadataRepository;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.archiva.metadata.repository.MetadataRepositoryException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.archiva.metadata.repository.MetadataResolutionException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.archiva.metadata.repository.RepositorySession;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.archiva.model.ArtifactReference;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.archiva.repository.ContentNotFoundException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.archiva.repository.ManagedRepositoryContent;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.archiva.repository.events.RepositoryListener;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.commons.lang.StringUtils;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.io.File;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import java.io.FilenameFilter;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import java.util.Collection;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import java.util.List;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import java.util.Set;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Base class for all repository purge tasks.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>public abstract class AbstractRepositoryPurge<a name="line.47"></a>
<span class="sourceLineNo">048</span> implements RepositoryPurge<a name="line.48"></a>
<span class="sourceLineNo">049</span>{<a name="line.49"></a>
<span class="sourceLineNo">050</span> protected Logger log = LoggerFactory.getLogger( getClass() );<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> protected final ManagedRepositoryContent repository;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> protected final RepositorySession repositorySession;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> protected final List&lt;RepositoryListener&gt; listeners;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private Logger logger = LoggerFactory.getLogger( "org.apache.archiva.AuditLog" );<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private static final char DELIM = ' ';<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> public AbstractRepositoryPurge( ManagedRepositoryContent repository, RepositorySession repositorySession,<a name="line.62"></a>
<span class="sourceLineNo">063</span> List&lt;RepositoryListener&gt; listeners )<a name="line.63"></a>
<span class="sourceLineNo">064</span> {<a name="line.64"></a>
<span class="sourceLineNo">065</span> this.repository = repository;<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.repositorySession = repositorySession;<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.listeners = listeners;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Purge the repo. Update db and index of removed artifacts.<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param references<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> protected void purge( Set&lt;ArtifactReference&gt; references )<a name="line.75"></a>
<span class="sourceLineNo">076</span> {<a name="line.76"></a>
<span class="sourceLineNo">077</span> if ( references != null &amp;&amp; !references.isEmpty() )<a name="line.77"></a>
<span class="sourceLineNo">078</span> {<a name="line.78"></a>
<span class="sourceLineNo">079</span> MetadataRepository metadataRepository = repositorySession.getRepository();<a name="line.79"></a>
<span class="sourceLineNo">080</span> for ( ArtifactReference reference : references )<a name="line.80"></a>
<span class="sourceLineNo">081</span> {<a name="line.81"></a>
<span class="sourceLineNo">082</span> File artifactFile = repository.toFile( reference );<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> for ( RepositoryListener listener : listeners )<a name="line.84"></a>
<span class="sourceLineNo">085</span> {<a name="line.85"></a>
<span class="sourceLineNo">086</span> listener.deleteArtifact( metadataRepository, repository.getId(), reference.getGroupId(),<a name="line.86"></a>
<span class="sourceLineNo">087</span> reference.getArtifactId(), reference.getVersion(),<a name="line.87"></a>
<span class="sourceLineNo">088</span> artifactFile.getName() );<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> // TODO: this needs to be logged<a name="line.91"></a>
<span class="sourceLineNo">092</span> artifactFile.delete();<a name="line.92"></a>
<span class="sourceLineNo">093</span> try<a name="line.93"></a>
<span class="sourceLineNo">094</span> {<a name="line.94"></a>
<span class="sourceLineNo">095</span> repository.deleteArtifact( reference );<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> catch ( ContentNotFoundException e )<a name="line.97"></a>
<span class="sourceLineNo">098</span> {<a name="line.98"></a>
<span class="sourceLineNo">099</span> log.warn( "skip error deleting artifact {}: {}", reference, e.getMessage() );<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> try<a name="line.102"></a>
<span class="sourceLineNo">103</span> {<a name="line.103"></a>
<span class="sourceLineNo">104</span> metadataRepository.removeProjectVersion( repository.getId(), reference.getGroupId(),<a name="line.104"></a>
<span class="sourceLineNo">105</span> reference.getArtifactId(), reference.getVersion() );<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> catch ( MetadataRepositoryException e )<a name="line.107"></a>
<span class="sourceLineNo">108</span> {<a name="line.108"></a>
<span class="sourceLineNo">109</span> log.warn( "skip error removeProjectVersion artifact {}: {}", reference, e.getMessage() );<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> boolean snapshotVersion = VersionUtil.isSnapshot( reference.getVersion() );<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> try<a name="line.114"></a>
<span class="sourceLineNo">115</span> {<a name="line.115"></a>
<span class="sourceLineNo">116</span> if ( snapshotVersion )<a name="line.116"></a>
<span class="sourceLineNo">117</span> {<a name="line.117"></a>
<span class="sourceLineNo">118</span> String baseVersion = VersionUtil.getBaseVersion( reference.getVersion() );<a name="line.118"></a>
<span class="sourceLineNo">119</span> Collection&lt;ArtifactMetadata&gt; artifacts =<a name="line.119"></a>
<span class="sourceLineNo">120</span> metadataRepository.getArtifacts( repository.getId(), reference.getGroupId(),<a name="line.120"></a>
<span class="sourceLineNo">121</span> reference.getArtifactId(), baseVersion );<a name="line.121"></a>
<span class="sourceLineNo">122</span> if ( artifacts != null )<a name="line.122"></a>
<span class="sourceLineNo">123</span> {<a name="line.123"></a>
<span class="sourceLineNo">124</span> // cleanup snapshots metadata<a name="line.124"></a>
<span class="sourceLineNo">125</span> for ( ArtifactMetadata artifactMetadata : artifacts )<a name="line.125"></a>
<span class="sourceLineNo">126</span> {<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> // TODO: mismatch between artifact (snapshot) version and project (base) version here<a name="line.128"></a>
<span class="sourceLineNo">129</span> if ( artifactMetadata.getVersion().equals( reference.getVersion() ) )<a name="line.129"></a>
<span class="sourceLineNo">130</span> {<a name="line.130"></a>
<span class="sourceLineNo">131</span> if ( StringUtils.isNotBlank( reference.getClassifier() ) )<a name="line.131"></a>
<span class="sourceLineNo">132</span> {<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> // cleanup facet which contains classifier information<a name="line.134"></a>
<span class="sourceLineNo">135</span> MavenArtifactFacet mavenArtifactFacet =<a name="line.135"></a>
<span class="sourceLineNo">136</span> (MavenArtifactFacet) artifactMetadata.getFacet(<a name="line.136"></a>
<span class="sourceLineNo">137</span> MavenArtifactFacet.FACET_ID );<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> if ( StringUtils.equals( reference.getClassifier(),<a name="line.139"></a>
<span class="sourceLineNo">140</span> mavenArtifactFacet.getClassifier() ) )<a name="line.140"></a>
<span class="sourceLineNo">141</span> {<a name="line.141"></a>
<span class="sourceLineNo">142</span> artifactMetadata.removeFacet( MavenArtifactFacet.FACET_ID );<a name="line.142"></a>
<span class="sourceLineNo">143</span> String groupId = reference.getGroupId(), artifactId =<a name="line.143"></a>
<span class="sourceLineNo">144</span> reference.getArtifactId(),<a name="line.144"></a>
<span class="sourceLineNo">145</span> version = reference.getVersion();<a name="line.145"></a>
<span class="sourceLineNo">146</span> MavenArtifactFacet mavenArtifactFacetToCompare = new MavenArtifactFacet();<a name="line.146"></a>
<span class="sourceLineNo">147</span> mavenArtifactFacetToCompare.setClassifier( reference.getClassifier() );<a name="line.147"></a>
<span class="sourceLineNo">148</span> metadataRepository.removeArtifact( repository.getId(), groupId, artifactId,<a name="line.148"></a>
<span class="sourceLineNo">149</span> version, mavenArtifactFacetToCompare );<a name="line.149"></a>
<span class="sourceLineNo">150</span> metadataRepository.save();<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> else<a name="line.154"></a>
<span class="sourceLineNo">155</span> {<a name="line.155"></a>
<span class="sourceLineNo">156</span> metadataRepository.removeArtifact( artifactMetadata, VersionUtil.getBaseVersion(<a name="line.156"></a>
<span class="sourceLineNo">157</span> reference.getVersion() ) );<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> catch ( MetadataResolutionException e )<a name="line.165"></a>
<span class="sourceLineNo">166</span> {<a name="line.166"></a>
<span class="sourceLineNo">167</span> log.warn( "skip error deleting metadata {}: {}", reference, e.getMessage() );<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> catch ( MetadataRepositoryException e )<a name="line.169"></a>
<span class="sourceLineNo">170</span> {<a name="line.170"></a>
<span class="sourceLineNo">171</span> log.warn( "skip error deleting metadata {}: {}", reference, e.getMessage() );<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> repositorySession.save();<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> triggerAuditEvent( repository.getRepository().getId(), ArtifactReference.toKey( reference ),<a name="line.176"></a>
<span class="sourceLineNo">177</span> AuditEvent.PURGE_ARTIFACT );<a name="line.177"></a>
<span class="sourceLineNo">178</span> purgeSupportFiles( artifactFile );<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
<span class="sourceLineNo">184</span> * &lt;p&gt;<a name="line.184"></a>
<span class="sourceLineNo">185</span> * This find support files for the artifactFile and deletes them.<a name="line.185"></a>
<span class="sourceLineNo">186</span> * &lt;/p&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span> * &lt;p&gt;<a name="line.187"></a>
<span class="sourceLineNo">188</span> * Support Files are things like ".sha1", ".md5", ".asc", etc.<a name="line.188"></a>
<span class="sourceLineNo">189</span> * &lt;/p&gt;<a name="line.189"></a>
<span class="sourceLineNo">190</span> *<a name="line.190"></a>
<span class="sourceLineNo">191</span> * @param artifactFile the file to base off of.<a name="line.191"></a>
<span class="sourceLineNo">192</span> */<a name="line.192"></a>
<span class="sourceLineNo">193</span> private void purgeSupportFiles( File artifactFile )<a name="line.193"></a>
<span class="sourceLineNo">194</span> {<a name="line.194"></a>
<span class="sourceLineNo">195</span> File parentDir = artifactFile.getParentFile();<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> if ( !parentDir.exists() )<a name="line.197"></a>
<span class="sourceLineNo">198</span> {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return;<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> FilenameFilter filter = new ArtifactFilenameFilter( artifactFile.getName() );<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> File[] files = parentDir.listFiles( filter );<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> for ( File file : files )<a name="line.206"></a>
<span class="sourceLineNo">207</span> {<a name="line.207"></a>
<span class="sourceLineNo">208</span> if ( file.exists() &amp;&amp; file.isFile() )<a name="line.208"></a>
<span class="sourceLineNo">209</span> {<a name="line.209"></a>
<span class="sourceLineNo">210</span> String fileName = file.getName();<a name="line.210"></a>
<span class="sourceLineNo">211</span> file.delete();<a name="line.211"></a>
<span class="sourceLineNo">212</span> // TODO: log that it was deleted<a name="line.212"></a>
<span class="sourceLineNo">213</span> triggerAuditEvent( repository.getRepository().getId(), fileName, AuditEvent.PURGE_FILE );<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> private void triggerAuditEvent( String repoId, String resource, String action )<a name="line.218"></a>
<span class="sourceLineNo">219</span> {<a name="line.219"></a>
<span class="sourceLineNo">220</span> String msg =<a name="line.220"></a>
<span class="sourceLineNo">221</span> repoId + DELIM + "&lt;system-purge&gt;" + DELIM + "&lt;system&gt;" + DELIM + '\"' + resource + '\"' + DELIM + '\"' +<a name="line.221"></a>
<span class="sourceLineNo">222</span> action + '\"';<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> logger.info( msg );<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span>}<a name="line.226"></a>
</pre>
</div>
</body>
</html>