JiraIssueParameterDefinition.java

/*
 * Copyright 2011-2012 Insider Guides, Inc., MeetMe, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hudson.plugins.jira.listissuesparameter;

import static hudson.Util.fixNull;

import com.atlassian.jira.rest.client.api.RestClientException;
import com.atlassian.jira.rest.client.api.domain.Issue;
import com.atlassian.jira.rest.client.api.domain.IssueField;
import hudson.Extension;
import hudson.cli.CLICommand;
import hudson.model.Item;
import hudson.model.Job;
import hudson.model.ParameterDefinition;
import hudson.model.ParameterValue;
import hudson.model.ParametersDefinitionProperty;
import hudson.plugins.jira.JiraSession;
import hudson.plugins.jira.JiraSite;
import hudson.util.ListBoxModel;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeoutException;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.AncestorInPath;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest2;
import org.kohsuke.stapler.interceptor.RequirePOST;

public class JiraIssueParameterDefinition extends ParameterDefinition {
    private static final long serialVersionUID = 3927562542249244416L;

    private String jiraIssueFilter;
    private String altSummaryFields;

    @DataBoundConstructor
    public JiraIssueParameterDefinition(String name, String description, String jiraIssueFilter) {
        super(name, description);
        this.jiraIssueFilter = jiraIssueFilter;
    }

    @Override
    public ParameterValue createValue(StaplerRequest2 req) {
        String[] values = req.getParameterValues(getName());
        if (values == null || values.length != 1) {
            return null;
        }

        return new JiraIssueParameterValue(getName(), values[0]);
    }

    @Override
    public ParameterValue createValue(StaplerRequest2 req, JSONObject formData) {
        JiraIssueParameterValue value = req.bindJSON(JiraIssueParameterValue.class, formData);
        return value;
    }

    @Override
    public ParameterValue createValue(CLICommand command, String value) throws IOException, InterruptedException {
        return new JiraIssueParameterValue(getName(), value);
    }

    public List<JiraIssueParameterDefinition.Result> getIssues()
            throws IOException, TimeoutException, RestClientException {
        Job<?, ?> job = Stapler.getCurrentRequest2().findAncestorObject(Job.class);
        return getIssues(job);
    }

    public List<JiraIssueParameterDefinition.Result> getIssues(Job<?, ?> job) {
        JiraSite site = JiraSite.get(job);
        if (site == null) {
            throw new IllegalStateException(
                    "Jira site needs to be configured in the project " + job.getFullDisplayName());
        }

        JiraSession session = site.getSession(job);
        if (session == null) {
            throw new IllegalStateException("Remote access for Jira isn't configured in Jenkins");
        }

        List<Issue> issues = session.getIssuesFromJqlSearch(jiraIssueFilter);

        List<Result> issueValues = new ArrayList<>();

        for (Issue issue : fixNull(issues)) {
            issueValues.add(new Result(issue, this.altSummaryFields));
        }

        return issueValues;
    }

    public String getJiraIssueFilter() {
        return jiraIssueFilter;
    }

    public void setJiraIssueFilter(String jiraIssueFilter) {
        this.jiraIssueFilter = jiraIssueFilter;
    }

    public String getAltSummaryFields() {
        return altSummaryFields;
    }

    @DataBoundSetter
    public void setAltSummaryFields(String altSummaryFields) {
        this.altSummaryFields = altSummaryFields;
    }

    @Extension
    @Symbol("jiraIssue")
    public static class DescriptorImpl extends ParameterDescriptor {
        @Override
        public String getDisplayName() {
            return "Jira Issue Parameter";
        }

        @RequirePOST
        public ListBoxModel doFillValueItems(@AncestorInPath Job<?, ?> job, @QueryParameter String name) {
            ListBoxModel items = new ListBoxModel();
            if (job.hasPermission(Item.BUILD)) {
                ParametersDefinitionProperty prop = job.getProperty(ParametersDefinitionProperty.class);
                if (prop != null) {
                    ParameterDefinition def = prop.getParameterDefinition(name);
                    if (def instanceof JiraIssueParameterDefinition jiraIssueDef) {
                        List<Result> issueValues = jiraIssueDef.getIssues(job);
                        issueValues.forEach(it -> items.add(it.summary, it.key));
                    }
                }
            }
            return items;
        }
    }

    public static class Result {
        public final String key;
        public final String summary;

        public Result(final Issue issue) {
            this(issue, null);
        }

        public Result(final Issue issue, String altSummaryFields) {
            this.key = issue.getKey();
            if (StringUtils.isEmpty(altSummaryFields)) {
                this.summary = issue.getSummary();
            } else {
                String[] fields = altSummaryFields.split(",");
                StringBuilder sb = new StringBuilder();
                for (String f : fields) {
                    String fn = f.trim();
                    if (StringUtils.isNotEmpty(fn)) {
                        IssueField field = issue.getFieldByName(fn);
                        if (field != null && field.getValue() != null) {
                            String fv = field.getValue().toString();
                            if (StringUtils.isNotEmpty(fv)) {
                                sb.append(fv);
                                sb.append(' ');
                            }
                        }
                    }
                }
                this.summary = sb.toString().trim();
            }
        }
    }
}