Add pristine core/src/main/java/hudson/tasks/Shell.java 821a3b25699ff30a0

Fork Shell builder class from Jenkins main tree, to be patches. Have to
be forked and not subclasses because otherwise there are some Descriptor
issues when trying to load resulting plugin (apparently, something is final
somewhere and that blocks reuse in plugin).

1 files changed, 208 insertions, 0 deletions

diff --git a/src/main/java/hudson/plugins/shell/Shell.java b/src/main/java/hudson/plugins/shell/Shell.java
new file mode 100644
index 0000000..346a124
--- /dev/null
+++ b/src/main/java/hudson/plugins/shell/Shell.java
@@ -0,0 +1,208 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2004-2011, Sun Microsystems, Inc., Kohsuke Kawaguchi, Jene Jasper, Yahoo! Inc., Seiji Sogabe
+ * 
+ * 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.tasks;
+
+import hudson.FilePath;
+import hudson.Functions;
+import hudson.Util;
+import hudson.Extension;
+import hudson.model.AbstractProject;
+import hudson.remoting.Callable;
+import hudson.remoting.VirtualChannel;
+import hudson.util.FormValidation;
+import java.io.IOException;
+import net.sf.json.JSONObject;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.QueryParameter;
+
+import java.util.List;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.logging.Logger;
+
+/**
+ * Executes a series of commands by using a shell.
+ *
+ * @author Kohsuke Kawaguchi
+ */
+public class Shell extends CommandInterpreter {
+    @DataBoundConstructor
+    public Shell(String command) {
+        super(fixCrLf(command));
+    }
+
+    /**
+     * Fix CR/LF and always make it Unix style.
+     */
+    private static String fixCrLf(String s) {
+        // eliminate CR
+        int idx;
+        while((idx=s.indexOf("\r\n"))!=-1)
+            s = s.substring(0,idx)+s.substring(idx+1);
+
+        //// add CR back if this is for Windows
+        //if(isWindows()) {
+        //    idx=0;
+        //    while(true) {
+        //        idx = s.indexOf('\n',idx);
+        //        if(idx==-1) break;
+        //        s = s.substring(0,idx)+'\r'+s.substring(idx);
+        //        idx+=2;
+        //    }
+        //}
+        return s;
+    }
+
+    /**
+     * Older versions of bash have a bug where non-ASCII on the first line
+     * makes the shell think the file is a binary file and not a script. Adding
+     * a leading line feed works around this problem.
+     */
+    private static String addCrForNonASCII(String s) {
+        if(!s.startsWith("#!")) {
+            if (s.indexOf('\n')!=0) {
+                return "\n" + s;
+            }
+        }
+
+        return s;
+    }
+
+    public String[] buildCommandLine(FilePath script) {
+        if(command.startsWith("#!")) {
+            // interpreter override
+            int end = command.indexOf('\n');
+            if(end<0)   end=command.length();
+            List<String> args = new ArrayList<String>();
+            args.addAll(Arrays.asList(Util.tokenize(command.substring(0,end).trim())));
+            args.add(script.getRemote());
+            args.set(0,args.get(0).substring(2));   // trim off "#!"
+            return args.toArray(new String[args.size()]);
+        } else 
+            return new String[] { getDescriptor().getShellOrDefault(script.getChannel()), "-xe", script.getRemote()};
+    }
+
+    protected String getContents() {
+        return addCrForNonASCII(fixCrLf(command));
+    }
+
+    protected String getFileExtension() {
+        return ".sh";
+    }
+
+    @Override
+    public DescriptorImpl getDescriptor() {
+        return (DescriptorImpl)super.getDescriptor();
+    }
+
+    @Extension
+    public static class DescriptorImpl extends BuildStepDescriptor<Builder> {
+        /**
+         * Shell executable, or null to default.
+         */
+        private String shell;
+
+        public DescriptorImpl() {
+            load();
+        }
+
+        public boolean isApplicable(Class<? extends AbstractProject> jobType) {
+            return true;
+        }
+
+        public String getShell() {
+            return shell;
+        }
+
+        /**
+         *  @deprecated 1.403
+         *      Use {@link #getShellOrDefault(hudson.remoting.VirtualChannel) }.
+         */
+        public String getShellOrDefault() {
+            if(shell==null)
+                return Functions.isWindows() ?"sh":"/bin/sh";
+            return shell;
+        }
+
+        public String getShellOrDefault(VirtualChannel channel) {
+            if (shell != null) 
+                return shell;
+
+            String interpreter = null;
+            try {
+                interpreter = channel.call(new Shellinterpreter());
+            } catch (IOException e) {
+                LOGGER.warning(e.getMessage());
+            } catch (InterruptedException e) {
+                LOGGER.warning(e.getMessage());
+            }
+            if (interpreter == null) {
+                interpreter = getShellOrDefault();
+            }
+
+            return interpreter;
+        }
+        
+        public void setShell(String shell) {
+            this.shell = Util.fixEmptyAndTrim(shell);
+            save();
+        }
+
+        public String getDisplayName() {
+            return Messages.Shell_DisplayName();
+        }
+
+        @Override
+        public Builder newInstance(StaplerRequest req, JSONObject data) {
+            return new Shell(data.getString("command"));
+        }
+
+        @Override
+        public boolean configure(StaplerRequest req, JSONObject data) {
+            setShell(req.getParameter("shell"));
+            return true;
+        }
+
+        /**
+         * Check the existence of sh in the given location.
+         */
+        public FormValidation doCheck(@QueryParameter String value) {
+            // Executable requires admin permission
+            return FormValidation.validateExecutable(value); 
+        }
+        
+        private static final class Shellinterpreter implements Callable<String, IOException> {
+
+            private static final long serialVersionUID = 1L;
+
+            public String call() throws IOException {
+                return Functions.isWindows() ? "sh" : "/bin/sh";
+            }
+        }
+        
+    }
+    
+    private static final Logger LOGGER = Logger.getLogger(Shell.class.getName());
+}