/*
* The MIT License
*
* Copyright (c) 2013-2014, CloudBees, 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 org.jenkinsci.plugins.workflow.cps;
import hudson.Extension;
import hudson.Functions;
import hudson.model.Action;
import hudson.model.Item;
import hudson.util.FormValidation;
import org.jenkinsci.plugins.workflow.cps.persistence.PersistIn;
import org.jenkinsci.plugins.workflow.flow.FlowDefinition;
import org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor;
import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner;
import org.kohsuke.stapler.DataBoundConstructor;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;
import org.codehaus.groovy.control.CompilationFailedException;
import org.jenkinsci.plugins.scriptsecurity.scripts.ApprovalContext;
import org.jenkinsci.plugins.scriptsecurity.scripts.ScriptApproval;
import org.jenkinsci.plugins.scriptsecurity.scripts.languages.GroovyLanguage;
import static org.jenkinsci.plugins.workflow.cps.persistence.PersistenceContext.*;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest;
/**
* @author Kohsuke Kawaguchi
*/
@PersistIn(JOB)
public class CpsFlowDefinition extends FlowDefinition {
private final String script;
private final boolean sandbox;
public CpsFlowDefinition(String script) {
this(script, false);
}
@DataBoundConstructor
public CpsFlowDefinition(String script, boolean sandbox) {
StaplerRequest req = Stapler.getCurrentRequest();
this.script = sandbox ? script : ScriptApproval.get().configuring(script, GroovyLanguage.get(), ApprovalContext.create().withCurrentUser().withItemAsKey(req != null ? req.findAncestorObject(Item.class) : null));
this.sandbox = sandbox;
}
private Object readResolve() {
if (!sandbox) {
ScriptApproval.get().configuring(script, GroovyLanguage.get(), ApprovalContext.create());
}
return this;
}
public String getScript() {
return script;
}
public boolean isSandbox() {
return sandbox;
}
// Used only from Groovy tests.
public CpsFlowExecution create(FlowExecutionOwner handle, Action... actions) throws IOException {
return create(handle, Arrays.asList(actions));
}
@Override
public CpsFlowExecution create(FlowExecutionOwner owner, List<? extends Action> actions) throws IOException {
for (Action a : actions) {
if (a instanceof CpsFlowFactoryAction) {
CpsFlowFactoryAction fa = (CpsFlowFactoryAction) a;
return fa.create(this,owner,actions);
}
}
return new CpsFlowExecution(sandbox ? script : ScriptApproval.get().using(script, GroovyLanguage.get()), sandbox, owner);
}
@Extension
public static class DescriptorImpl extends FlowDefinitionDescriptor {
@Override
public String getDisplayName() {
return "Groovy CPS DSL";
}
public FormValidation doCheckScript(@QueryParameter String value, @QueryParameter boolean sandbox) {
Jenkins j = Jenkins.getInstance();
if (j == null) {
return FormValidation.ok();
}
try {
new CpsGroovyShell(null).getClassLoader().parseClass(value);
} catch (CompilationFailedException x) {
return FormValidation.error(x.getLocalizedMessage());
}
return sandbox ? FormValidation.ok() : ScriptApproval.get().checking(value, GroovyLanguage.get());
}
@Restricted(DoNotUse.class) // j:invokeStatic does not consistently work on plugin classes
public Collection<? extends StepDescriptor> getStepDescriptors() {
return StepDescriptor.all();
}
@Restricted(DoNotUse.class) // from config.jelly
public HttpResponse doGenerateSnippet(StaplerRequest req, @QueryParameter String json) throws Exception {
// TODO is there not an easier way to do this?
JSONObject jsonO = JSONObject.fromObject(json);
Jenkins j = Jenkins.getInstance();
if (j == null) {
throw new IllegalStateException("Jenkins is not running");
}
Class<?> c = j.getPluginManager().uberClassLoader.loadClass(jsonO.getString("stapler-class"));
Object o;
try {
o = req.bindJSON(c, jsonO);
} catch (RuntimeException x) { // e.g. IllegalArgumentException
return HttpResponses.plainText(Functions.printThrowable(x));
}
try {
return HttpResponses.plainText(Snippetizer.object2Groovy(o));
} catch (UnsupportedOperationException x) {
Logger.getLogger(CpsFlowExecution.class.getName()).log(Level.WARNING, "failed to render " + json, x);
return HttpResponses.plainText(x.getMessage());
}
}
}
}