/*
* The MIT License
*
* Copyright (c) 2009, Sun Microsystems, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.tools;
import hudson.Extension;
import hudson.FilePath;
import hudson.FilePath.FileCallable;
import hudson.ProxyConfiguration;
import hudson.Util;
import hudson.Functions;
import hudson.os.PosixAPI;
import hudson.model.Node;
import hudson.model.TaskListener;
import hudson.remoting.VirtualChannel;
import hudson.util.FormValidation;
import hudson.util.jna.GNUCLibrary;
import java.io.File;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
/**
* Installs a tool into the Hudson working area by downloading and unpacking a ZIP file.
* @since 1.305
*/
public class ZipExtractionInstaller extends ToolInstaller {
/**
* URL of a ZIP file which should be downloaded in case the tool is missing.
*/
private final String url;
/**
* Optional subdir to extract.
*/
private final String subdir;
@DataBoundConstructor
public ZipExtractionInstaller(String label, String url, String subdir) {
super(label);
this.url = url;
this.subdir = Util.fixEmptyAndTrim(subdir);
}
public String getUrl() {
return url;
}
public String getSubdir() {
return subdir;
}
public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedException {
FilePath dir = preferredLocation(tool, node);
if (dir.installIfNecessaryFrom(new URL(url), log, "Unpacking " + url + " to " + dir + " on " + node.getDisplayName())) {
dir.act(new ChmodRecAPlusX());
}
if (subdir == null) {
return dir;
} else {
return dir.child(subdir);
}
}
@Extension
public static class DescriptorImpl extends ToolInstallerDescriptor<ZipExtractionInstaller> {
public String getDisplayName() {
return Messages.ZipExtractionInstaller_DescriptorImpl_displayName();
}
public FormValidation doCheckUrl(@QueryParameter String value) {
try {
URLConnection conn = ProxyConfiguration.open(new URL(value));
conn.connect();
if (conn instanceof HttpURLConnection) {
if (((HttpURLConnection) conn).getResponseCode() != HttpURLConnection.HTTP_OK) {
return FormValidation.error(Messages.ZipExtractionInstaller_bad_connection());
}
}
return FormValidation.ok();
} catch (MalformedURLException x) {
return FormValidation.error(Messages.ZipExtractionInstaller_malformed_url());
} catch (IOException x) {
return FormValidation.error(x,Messages.ZipExtractionInstaller_could_not_connect());
}
}
}
/**
* Sets execute permission on all files, since unzip etc. might not do this.
* Hackish, is there a better way?
*/
static class ChmodRecAPlusX implements FileCallable<Void> {
private static final long serialVersionUID = 1L;
public Void invoke(File d, VirtualChannel channel) throws IOException {
if(!Functions.isWindows())
process(d);
return null;
}
@IgnoreJRERequirement
private void process(File f) {
if (f.isFile()) {
if(Functions.isMustangOrAbove())
f.setExecutable(true, false);
else {
try {
GNUCLibrary.LIBC.chmod(f.getAbsolutePath(),0755);
} catch (LinkageError e) {
// if JNA is unavailable, fall back.
// we still prefer to try JNA first as PosixAPI supports even smaller platforms.
PosixAPI.get().chmod(f.getAbsolutePath(),0755);
}
}
} else {
File[] kids = f.listFiles();
if (kids != null) {
for (File kid : kids) {
process(kid);
}
}
}
}
}
}