AbstractProject.java 78.2 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
4
 * Copyright (c) 2004-2011, Sun Microsystems, Inc., Kohsuke Kawaguchi,
5
 * Brian Westrich, Erik Ramfelt, Ertan Deniz, Jean-Baptiste Quenot,
6
 * Luca Domenico Milanesio, R. Tyler Ballance, Stephen Connolly, Tom Huybrechts,
7 8
 * id:cactusman, Yahoo! Inc., Andrew Bayer, Manufacture Francaise des Pneumatiques
 * Michelin, Romain Seguy
K
kohsuke 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * 
 * 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.
 */
28 29
package hudson.model;

30
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
31
import hudson.EnvVars;
32
import hudson.Functions;
33
import antlr.ANTLRException;
K
kohsuke 已提交
34
import hudson.AbortException;
35
import hudson.CopyOnWrite;
36
import hudson.FeedAdapter;
37
import hudson.FilePath;
38
import hudson.Launcher;
39
import hudson.Util;
40
import hudson.cli.declarative.CLIMethod;
41
import hudson.cli.declarative.CLIResolver;
M
mdonohue 已提交
42
import hudson.model.Cause.LegacyCodeCause;
43
import hudson.model.Cause.RemoteCause;
44
import hudson.model.Cause.UserIdCause;
45 46
import hudson.model.Descriptor.FormException;
import hudson.model.Fingerprint.RangeSet;
K
kohsuke 已提交
47
import hudson.model.Queue.Executable;
48
import hudson.model.Queue.Task;
49
import hudson.model.queue.QueueTaskFuture;
50
import hudson.model.queue.SubTask;
51 52
import hudson.model.Queue.WaitingItem;
import hudson.model.RunMap.Constructor;
53 54
import hudson.model.labels.LabelAtom;
import hudson.model.labels.LabelExpression;
55
import hudson.model.listeners.SCMPollListener;
56
import hudson.model.queue.CauseOfBlockage;
57
import hudson.model.queue.SubTaskContributor;
K
kohsuke 已提交
58
import hudson.scm.ChangeLogSet;
K
kohsuke 已提交
59
import hudson.scm.ChangeLogSet.Entry;
60
import hudson.scm.NullSCM;
61
import hudson.scm.PollingResult;
62
import hudson.scm.SCM;
63
import hudson.scm.SCMRevisionState;
64
import hudson.scm.SCMS;
J
jbq 已提交
65
import hudson.search.SearchIndexBuilder;
K
kohsuke 已提交
66
import hudson.security.Permission;
67
import hudson.slaves.WorkspaceList;
68
import hudson.tasks.BuildStep;
69
import hudson.tasks.BuildStepDescriptor;
J
jbq 已提交
70
import hudson.tasks.BuildTrigger;
71
import hudson.tasks.BuildWrapperDescriptor;
72
import hudson.tasks.Publisher;
K
kohsuke 已提交
73
import hudson.triggers.SCMTrigger;
74
import hudson.triggers.Trigger;
75
import hudson.triggers.TriggerDescriptor;
76 77
import hudson.util.AlternativeUiTextProvider;
import hudson.util.AlternativeUiTextProvider.Message;
78
import hudson.util.DescribableList;
79
import hudson.util.EditDistance;
S
 
shinodkm 已提交
80
import hudson.util.FormValidation;
K
kohsuke 已提交
81 82
import hudson.widgets.BuildHistoryWidget;
import hudson.widgets.HistoryWidget;
83
import jenkins.model.Jenkins;
84
import jenkins.model.JenkinsLocationConfiguration;
85
import jenkins.model.lazy.AbstractLazyLoadRunMap.Direction;
86 87 88
import jenkins.scm.DefaultSCMCheckoutStrategyImpl;
import jenkins.scm.SCMCheckoutStrategy;
import jenkins.scm.SCMCheckoutStrategyDescriptor;
89
import jenkins.util.TimeDuration;
K
kohsuke 已提交
90
import net.sf.json.JSONObject;
91
import org.apache.tools.ant.taskdefs.email.Mailer;
92 93
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
94 95
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
96 97 98
import org.kohsuke.stapler.ForwardToView;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
99
import org.kohsuke.stapler.HttpResponses;
100
import org.kohsuke.stapler.QueryParameter;
K
kohsuke 已提交
101 102 103
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
104
import org.kohsuke.stapler.interceptor.RequirePOST;
105

K
kohsuke 已提交
106
import javax.servlet.ServletException;
107
import java.io.File;
108
import java.io.IOException;
K
kohsuke 已提交
109
import java.lang.reflect.InvocationTargetException;
K
kohsuke 已提交
110
import java.util.ArrayList;
111
import java.util.Arrays;
112
import java.util.Calendar;
113
import java.util.Collection;
J
jbq 已提交
114
import java.util.Collections;
115
import java.util.Comparator;
J
jbq 已提交
116
import java.util.HashSet;
117 118
import java.util.List;
import java.util.Map;
J
jbq 已提交
119
import java.util.Set;
120 121 122
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.Vector;
K
kohsuke 已提交
123
import java.util.concurrent.Future;
124 125
import java.util.logging.Level;
import java.util.logging.Logger;
126

127 128 129
import static hudson.scm.PollingResult.*;
import static javax.servlet.http.HttpServletResponse.*;

130 131
/**
 * Base implementation of {@link Job}s that build software.
132
 *
133
 * For now this is primarily the common part of {@link Project} and MavenModule.
134
 *
135 136 137
 * @author Kohsuke Kawaguchi
 * @see AbstractBuild
 */
C
Christoph Kutzinski 已提交
138
@SuppressWarnings("rawtypes")
139
public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>> extends Job<P,R> implements BuildableItem {
140

141
    /**
142 143 144
     * {@link SCM} associated with the project.
     * To allow derived classes to link {@link SCM} config to elsewhere,
     * access to this variable should always go through {@link #getScm()}.
145
     */
K
kohsuke 已提交
146
    private volatile SCM scm = new NullSCM();
147

148 149 150 151 152
    /**
     * Controls how the checkout is done.
     */
    private volatile SCMCheckoutStrategy scmCheckoutStrategy;

153 154 155 156 157
    /**
     * State returned from {@link SCM#poll(AbstractProject, Launcher, FilePath, TaskListener, SCMRevisionState)}.
     */
    private volatile transient SCMRevisionState pollingBaseline = null;

158 159
    /**
     * All the builds keyed by their build number.
160 161 162
     *
     * External code should use {@link #getBuildByNumber(int)} or {@link #getLastBuild()} and traverse via
     * {@link Run#getPreviousBuild()}
163
     */
164
    @Restricted(NoExternalUse.class)
165
    protected transient RunMap<R> builds = new RunMap<R>();
166 167 168 169

    /**
     * The quiet period. Null to delegate to the system default.
     */
K
kohsuke 已提交
170
    private volatile Integer quietPeriod = null;
S
 
shinodkm 已提交
171 172
    
    /**
173
     * The retry count. Null to delegate to the system default.
S
 
shinodkm 已提交
174
     */
175
    private volatile Integer scmCheckoutRetryCount = null;
176 177

    /**
178 179 180 181 182 183 184
     * If this project is configured to be only built on a certain label,
     * this value will be set to that label.
     *
     * For historical reasons, this is called 'assignedNode'. Also for
     * a historical reason, null to indicate the affinity
     * with the master node.
     *
185
     * @see #canRoam
186 187 188 189 190
     */
    private String assignedNode;

    /**
     * True if this project can be built on any node.
191
     *
192
     * <p>
193 194
     * This somewhat ugly flag combination is so that we can migrate
     * existing Hudson installations nicely.
195
     */
K
kohsuke 已提交
196
    private volatile boolean canRoam;
197 198 199 200

    /**
     * True to suspend new builds.
     */
K
kohsuke 已提交
201
    protected volatile boolean disabled;
202

203 204 205 206 207 208
    /**
     * True to keep builds of this project in queue when downstream projects are
     * building. False by default to keep from breaking existing behavior.
     */
    protected volatile boolean blockBuildWhenDownstreamBuilding = false;

209 210 211 212 213 214
    /**
     * True to keep builds of this project in queue when upstream projects are
     * building. False by default to keep from breaking existing behavior.
     */
    protected volatile boolean blockBuildWhenUpstreamBuilding = false;

215
    /**
216 217 218
     * Identifies {@link JDK} to be used.
     * Null if no explicit configuration is required.
     *
219
     * <p>
220
     * Can't store {@link JDK} directly because {@link Jenkins} and {@link Project}
221 222
     * are saved independently.
     *
223
     * @see Jenkins#getJDK(String)
224
     */
K
kohsuke 已提交
225
    private volatile String jdk;
226

K
kohsuke 已提交
227
    private volatile BuildAuthorizationToken authToken = null;
228

229 230 231
    /**
     * List of all {@link Trigger}s for this project.
     */
232
    protected List<Trigger<?>> triggers = new Vector<Trigger<?>>();
233

234 235
    /**
     * {@link Action}s contributed from subsidiary objects associated with
236 237 238 239
     * {@link AbstractProject}, such as from triggers, builders, publishers, etc.
     *
     * We don't want to persist them separately, and these actions
     * come and go as configuration change, so it's kept separate.
240
     */
241 242
    @CopyOnWrite
    protected transient volatile List<Action> transientActions = new Vector<Action>();
243

K
kohsuke 已提交
244 245
    private boolean concurrentBuild;

246 247 248
    /**
     * See {@link #setCustomWorkspace(String)}.
     *
249
     * @since 1.410
250 251 252
     */
    private String customWorkspace;
    
253
    protected AbstractProject(ItemGroup parent, String name) {
254
        super(parent,name);
255

256
        if(!Jenkins.getInstance().getNodes().isEmpty()) {
257
            // if a new job is configured with Hudson that already has slave nodes
258 259 260
            // make it roamable by default
            canRoam = true;
        }
261 262
    }

263 264 265 266 267 268
    @Override
    public synchronized void save() throws IOException {
        super.save();
        updateTransientActions();
    }

269 270 271 272 273
    @Override
    public void onCreatedFromScratch() {
        super.onCreatedFromScratch();
        // solicit initial contributions, especially from TransientProjectActionFactory
        updateTransientActions();
274 275
    }

276
    @Override
277
    public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
278
        super.onLoad(parent, name);
279

280
        RunMap<R> builds = new RunMap<R>(getBuildDir(), new Constructor<R>() {
281 282 283 284
            public R create(File dir) throws IOException {
                return loadBuild(dir);
            }
        });
285 286 287 288 289 290 291 292
        if (this.builds!=null) {
            // if we are reloading, keep all those that are still building intact
            for (R r : this.builds.getLoadedBuilds().values()) {
                if (r.isBuilding())
                    builds.put(r);
            }
        }
        this.builds = builds;
293
        for (Trigger t : triggers())
294
            t.start(this, Items.updatingByXml.get());
295 296
        if(scm==null)
            scm = new NullSCM(); // perhaps it was pointing to a plugin that no longer exists.
297

298 299
        if(transientActions==null)
            transientActions = new Vector<Action>();    // happens when loaded from disk
300
        updateTransientActions();
301 302
    }

303 304 305 306 307 308 309
    private synchronized List<Trigger<?>> triggers() {
        if (triggers == null) {
            triggers = new Vector<Trigger<?>>();
        }
        return triggers;
    }

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
    @Override
    public EnvVars getEnvironment(Node node, TaskListener listener) throws IOException, InterruptedException {
        EnvVars env =  super.getEnvironment(node, listener);

        JDK jdk = getJDK();
        if (jdk != null) {
            if (node != null) { // just in case were not in a build
                jdk = jdk.forNode(node, listener);
            }
            jdk.buildEnvVars(env);
        }

        return env;
    }

325
    @Override
326
    protected void performDelete() throws IOException, InterruptedException {
K
kohsuke 已提交
327 328
        // prevent a new build while a delete operation is in progress
        makeDisabled(true);
329
        FilePath ws = getWorkspace();
330
        if(ws!=null) {
K
NPE fix  
kohsuke 已提交
331 332 333 334
            Node on = getLastBuiltOn();
            getScm().processWorkspaceBeforeDeletion(this, ws, on);
            if(on!=null)
                on.getFileSystemProvisioner().discardWorkspace(this,ws);
335
        }
K
kohsuke 已提交
336 337 338
        super.performDelete();
    }

K
kohsuke 已提交
339 340
    /**
     * Does this project perform concurrent builds?
K
kohsuke 已提交
341
     * @since 1.319
K
kohsuke 已提交
342
     */
K
kohsuke 已提交
343
    @Exported
K
kohsuke 已提交
344
    public boolean isConcurrentBuild() {
345
        return concurrentBuild;
K
kohsuke 已提交
346 347 348 349 350 351 352
    }

    public void setConcurrentBuild(boolean b) throws IOException {
        concurrentBuild = b;
        save();
    }

353
    /**
354 355
     * If this project is configured to be always built on this node,
     * return that {@link Node}. Otherwise null.
356
     */
357
    public Label getAssignedLabel() {
358
        if(canRoam)
359 360
            return null;

361
        if(assignedNode==null)
362 363
            return Jenkins.getInstance().getSelfLabel();
        return Jenkins.getInstance().getLabel(assignedNode);
364 365
    }

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    /**
     * Set of labels relevant to this job.
     *
     * This method is used to determine what slaves are relevant to jobs, for example by {@link View}s.
     * It does not affect the scheduling. This information is informational and the best-effort basis.
     *
     * @since 1.456
     * @return
     *      Minimally it should contain {@link #getAssignedLabel()}. The set can contain null element
     *      to correspond to the null return value from {@link #getAssignedLabel()}.
     */
    public Set<Label> getRelevantLabels() {
        return Collections.singleton(getAssignedLabel());
    }

381 382 383 384
    /**
     * Gets the textual representation of the assigned label as it was entered by the user.
     */
    public String getAssignedLabelString() {
385 386 387 388 389 390 391 392
        if (canRoam || assignedNode==null)    return null;
        try {
            LabelExpression.parseExpression(assignedNode);
            return assignedNode;
        } catch (ANTLRException e) {
            // must be old label or host name that includes whitespace or other unsafe chars
            return LabelAtom.escape(assignedNode);
        }
393 394
    }

K
kohsuke 已提交
395 396 397 398 399 400 401 402 403
    /**
     * Sets the assigned label.
     */
    public void setAssignedLabel(Label l) throws IOException {
        if(l==null) {
            canRoam = true;
            assignedNode = null;
        } else {
            canRoam = false;
404
            if(l== Jenkins.getInstance().getSelfLabel())  assignedNode = null;
405
            else                                        assignedNode = l.getExpression();
K
kohsuke 已提交
406 407 408 409
        }
        save();
    }

410 411 412 413 414 415 416
    /**
     * Assigns this job to the given node. A convenience method over {@link #setAssignedLabel(Label)}.
     */
    public void setAssignedNode(Node l) throws IOException {
        setAssignedLabel(l.getSelfLabel());
    }

417
    /**
418 419
     * Get the term used in the UI to represent this kind of {@link AbstractProject}.
     * Must start with a capital letter.
420 421 422
     */
    @Override
    public String getPronoun() {
K
Kohsuke Kawaguchi 已提交
423
        return AlternativeUiTextProvider.get(PRONOUN, this,Messages.AbstractProject_Pronoun());
424 425
    }

426 427 428 429 430 431 432 433 434
    /**
     * Gets the human readable display name to be rendered in the "Build Now" link.
     *
     * @since 1.401
     */
    public String getBuildNowText() {
        return AlternativeUiTextProvider.get(BUILD_NOW_TEXT,this,Messages.AbstractProject_BuildNow());
    }

435
    /**
436
     * Gets the nearest ancestor {@link TopLevelItem} that's also an {@link AbstractProject}.
437
     *
438 439 440 441 442 443 444
     * <p>
     * Some projects (such as matrix projects, Maven projects, or promotion processes) form a tree of jobs
     * that acts as a single unit. This method can be used to find the top most dominating job that
     * covers such a tree.
     *
     * @return never null.
     * @see AbstractBuild#getRootBuild()
445
     */
446 447
    public AbstractProject<?,?> getRootProject() {
        if (this instanceof TopLevelItem) {
448 449
            return this;
        } else {
450 451 452 453
            ItemGroup p = this.getParent();
            if (p instanceof AbstractProject)
                return ((AbstractProject) p).getRootProject();
            return this;
454 455 456
        }
    }

457 458
    /**
     * Gets the directory where the module is checked out.
459 460 461
     *
     * @return
     *      null if the workspace is on a slave that's not connected.
K
kohsuke 已提交
462
     * @deprecated as of 1.319
K
kohsuke 已提交
463 464 465 466 467
     *      To support concurrent builds of the same project, this method is moved to {@link AbstractBuild}.
     *      For backward compatibility, this method returns the right {@link AbstractBuild#getWorkspace()} if called
     *      from {@link Executor}, and otherwise the workspace of the last build.
     *
     *      <p>
468
     *      If you are calling this method during a build from an executor, switch it to {@link AbstractBuild#getWorkspace()}.
K
kohsuke 已提交
469 470 471 472
     *      If you are calling this method to serve a file from the workspace, doing a form validation, etc., then
     *      use {@link #getSomeWorkspace()}
     */
    public final FilePath getWorkspace() {
473 474 475 476 477 478 479 480 481 482 483 484
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getWorkspace() : null;

    }
    
    /**
     * Various deprecated methods in this class all need the 'current' build.  This method returns
     * the build suitable for that purpose.
     * 
     * @return An AbstractBuild for deprecated methods to use.
     */
    private AbstractBuild getBuildForDeprecatedMethods() {
K
kohsuke 已提交
485 486 487 488 489 490
        Executor e = Executor.currentExecutor();
        if(e!=null) {
            Executable exe = e.getCurrentExecutable();
            if (exe instanceof AbstractBuild) {
                AbstractBuild b = (AbstractBuild) exe;
                if(b.getProject()==this)
491
                    return b;
K
kohsuke 已提交
492 493 494
            }
        }
        R lb = getLastBuild();
495
        if(lb!=null)    return lb;
K
kohsuke 已提交
496 497 498 499 500 501 502 503 504 505 506 507 508
        return null;
    }

    /**
     * Gets a workspace for some build of this project.
     *
     * <p>
     * This is useful for obtaining a workspace for the purpose of form field validation, where exactly
     * which build the workspace belonged is less important. The implementation makes a cursory effort
     * to find some workspace.
     *
     * @return
     *      null if there's no available workspace.
K
kohsuke 已提交
509
     * @since 1.319
510
     */
K
kohsuke 已提交
511
    public final FilePath getSomeWorkspace() {
512 513 514 515 516 517 518 519 520 521
        R b = getSomeBuildWithWorkspace();
        return b!=null ? b.getWorkspace() : null;
    }

    /**
     * Gets some build that has a live workspace.
     *
     * @return null if no such build exists.
     */
    public final R getSomeBuildWithWorkspace() {
K
kohsuke 已提交
522 523 524
        int cnt=0;
        for (R b = getLastBuild(); cnt<5 && b!=null; b=b.getPreviousBuild()) {
            FilePath ws = b.getWorkspace();
525
            if (ws!=null)   return b;
K
kohsuke 已提交
526 527 528
        }
        return null;
    }
529

530 531 532
    /**
     * Returns the root directory of the checked-out module.
     * <p>
533 534
     * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
     * and so on exists.
K
kohsuke 已提交
535
     *
K
kohsuke 已提交
536
     * @deprecated as of 1.319
K
kohsuke 已提交
537
     *      See {@link #getWorkspace()} for a migration strategy.
538 539
     */
    public FilePath getModuleRoot() {
540 541
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoot() : null;
542 543
    }

S
stephenconnolly 已提交
544 545 546 547 548 549
    /**
     * Returns the root directories of all checked-out modules.
     * <p>
     * Some SCMs support checking out multiple modules into the same workspace.
     * In these cases, the returned array will have a length greater than one.
     * @return The roots of all modules checked out from the SCM.
K
kohsuke 已提交
550
     *
K
kohsuke 已提交
551
     * @deprecated as of 1.319
K
kohsuke 已提交
552
     *      See {@link #getWorkspace()} for a migration strategy.
S
stephenconnolly 已提交
553 554
     */
    public FilePath[] getModuleRoots() {
555 556
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoots() : null;
S
stephenconnolly 已提交
557 558
    }

559
    public int getQuietPeriod() {
560
        return quietPeriod!=null ? quietPeriod : Jenkins.getInstance().getQuietPeriod();
561
    }
562

563
    public SCMCheckoutStrategy getScmCheckoutStrategy() {
564 565 566
        return scmCheckoutStrategy == null ? new DefaultSCMCheckoutStrategyImpl() : scmCheckoutStrategy;
    }

567
    public void setScmCheckoutStrategy(SCMCheckoutStrategy scmCheckoutStrategy) throws IOException {
568 569 570 571 572
        this.scmCheckoutStrategy = scmCheckoutStrategy;
        save();
    }


573
    public int getScmCheckoutRetryCount() {
574
        return scmCheckoutRetryCount !=null ? scmCheckoutRetryCount : Jenkins.getInstance().getScmCheckoutRetryCount();
S
 
shinodkm 已提交
575
    }
576 577 578

    // ugly name because of EL
    public boolean getHasCustomQuietPeriod() {
579
        return quietPeriod!=null;
580
    }
K
kohsuke 已提交
581 582 583 584

    /**
     * Sets the custom quiet period of this project, or revert to the global default if null is given. 
     */
585
    public void setQuietPeriod(Integer seconds) throws IOException {
K
kohsuke 已提交
586 587 588
        this.quietPeriod = seconds;
        save();
    }
S
 
shinodkm 已提交
589
    
590
    public boolean hasCustomScmCheckoutRetryCount(){
591
        return scmCheckoutRetryCount != null;
S
 
shinodkm 已提交
592
    }
593

594
    @Override
595
    public boolean isBuildable() {
J
jpederzolli 已提交
596
        return !isDisabled() && !isHoldOffBuildUntilSave();
597 598
    }

599
    /**
600 601
     * Used in <tt>sidepanel.jelly</tt> to decide whether to display
     * the config/delete/build links.
602 603 604 605 606
     */
    public boolean isConfigurable() {
        return true;
    }

607 608 609 610 611 612 613 614 615
    public boolean blockBuildWhenDownstreamBuilding() {
        return blockBuildWhenDownstreamBuilding;
    }

    public void setBlockBuildWhenDownstreamBuilding(boolean b) throws IOException {
        blockBuildWhenDownstreamBuilding = b;
        save();
    }

616
    public boolean blockBuildWhenUpstreamBuilding() {
617
        return blockBuildWhenUpstreamBuilding;
618 619
    }

620
    public void setBlockBuildWhenUpstreamBuilding(boolean b) throws IOException {
621 622
        blockBuildWhenUpstreamBuilding = b;
        save();
623 624
    }

625 626 627
    public boolean isDisabled() {
        return disabled;
    }
S
 
shinodkm 已提交
628 629 630 631 632
    
    /**
     * Validates the retry count Regex
     */
    public FormValidation doCheckRetryCount(@QueryParameter String value)throws IOException,ServletException{
633 634 635 636 637 638 639
        // retry count is optional so this is ok
        if(value == null || value.trim().equals(""))
            return FormValidation.ok();
        if (!value.matches("[0-9]*")) {
            return FormValidation.error("Invalid retry count");
        } 
        return FormValidation.ok();
S
 
shinodkm 已提交
640
    }
641

642 643 644 645
    /**
     * Marks the build as disabled.
     */
    public void makeDisabled(boolean b) throws IOException {
646
        if(disabled==b)     return; // noop
647
        this.disabled = b;
K
bug fix  
kohsuke 已提交
648
        if(b)
649
            Jenkins.getInstance().getQueue().cancel(this);
650 651 652
        save();
    }

653 654
    /**
     * Specifies whether this project may be disabled by the user.
655 656
     * By default, it can be only if this is a {@link TopLevelItem};
     * would be false for matrix configurations, etc.
657 658 659 660
     * @return true if the GUI should allow {@link #doDisable} and the like
     * @since 1.475
     */
    public boolean supportsMakeDisabled() {
661
        return this instanceof TopLevelItem;
662 663
    }

664 665 666 667 668 669 670 671
    public void disable() throws IOException {
        makeDisabled(true);
    }

    public void enable() throws IOException {
        makeDisabled(false);
    }

K
kohsuke 已提交
672 673
    @Override
    public BallColor getIconColor() {
674
        if(isDisabled())
675
            return BallColor.DISABLED;
K
kohsuke 已提交
676 677 678
        else
            return super.getIconColor();
    }
679

680 681 682 683 684 685 686
    /**
     * effectively deprecated. Since using updateTransientActions correctly
     * under concurrent environment requires a lock that can too easily cause deadlocks.
     *
     * <p>
     * Override {@link #createTransientActions()} instead.
     */
687
    protected void updateTransientActions() {
688 689 690 691
        transientActions = createTransientActions();
    }

    protected List<Action> createTransientActions() {
692
        Vector<Action> ta = new Vector<Action>();
693

K
Kohsuke Kawaguchi 已提交
694
        for (JobProperty<? super P> p : Util.fixNull(properties))
695
            ta.addAll(p.getJobActions((P)this));
696

697 698
        for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all())
            ta.addAll(Util.fixNull(tpaf.createFor(this))); // be defensive against null
699
        return ta;
700 701
    }

702
    /**
703 704
     * Returns the live list of all {@link Publisher}s configured for this project.
     *
705
     * <p>
706 707
     * This method couldn't be called <tt>getPublishers()</tt> because existing methods
     * in sub-classes return different inconsistent types.
708
     */
709
    public abstract DescribableList<Publisher,Descriptor<Publisher>> getPublishersList();
710

K
kohsuke 已提交
711 712 713 714 715 716
    @Override
    public void addProperty(JobProperty<? super P> jobProp) throws IOException {
        super.addProperty(jobProp);
        updateTransientActions();
    }

717 718 719 720
    public List<ProminentProjectAction> getProminentActions() {
        List<Action> a = getActions();
        List<ProminentProjectAction> pa = new Vector<ProminentProjectAction>();
        for (Action action : a) {
721
            if(action instanceof ProminentProjectAction)
722 723 724 725 726
                pa.add((ProminentProjectAction) action);
        }
        return pa;
    }

727
    @Override
728
    public void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, FormException {
729
        super.doConfigSubmit(req,rsp);
730

731 732
        updateTransientActions();

733
        Set<AbstractProject> upstream = Collections.emptySet();
734
        if(req.getParameter("pseudoUpstreamTrigger")!=null) {
735
            upstream = new HashSet<AbstractProject>(Items.fromNameList(getParent(),req.getParameter("upstreamProjects"),AbstractProject.class));
736 737 738
        }

        // dependency setting might have been changed by the user, so rebuild.
739
        Jenkins.getInstance().rebuildDependencyGraph();
740 741 742 743 744

        // reflect the submission of the pseudo 'upstream build trriger'.
        // this needs to be done after we release the lock on 'this',
        // or otherwise we could dead-lock

745
        for (AbstractProject<?,?> p : Jenkins.getInstance().getAllItems(AbstractProject.class)) {
746 747
            // Don't consider child projects such as MatrixConfiguration:
            if (!p.isConfigurable()) continue;
748
            boolean isUpstream = upstream.contains(p);
749 750 751
            synchronized(p) {
                // does 'p' include us in its BuildTrigger? 
                DescribableList<Publisher,Descriptor<Publisher>> pl = p.getPublishersList();
752
                BuildTrigger trigger = pl.get(BuildTrigger.class);
753
                List<AbstractProject> newChildProjects = trigger == null ? new ArrayList<AbstractProject>():trigger.getChildProjects(p);
754 755
                if(isUpstream) {
                    if(!newChildProjects.contains(this))
756 757 758 759 760
                        newChildProjects.add(this);
                } else {
                    newChildProjects.remove(this);
                }

761
                if(newChildProjects.isEmpty()) {
762
                    pl.remove(BuildTrigger.class);
763
                } else {
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
                    // here, we just need to replace the old one with the new one,
                    // but there was a regression (we don't know when it started) that put multiple BuildTriggers
                    // into the list.
                    // for us not to lose the data, we need to merge them all.
                    List<BuildTrigger> existingList = pl.getAll(BuildTrigger.class);
                    BuildTrigger existing;
                    switch (existingList.size()) {
                    case 0:
                        existing = null;
                        break;
                    case 1:
                        existing = existingList.get(0);
                        break;
                    default:
                        pl.removeAll(BuildTrigger.class);
                        Set<AbstractProject> combinedChildren = new HashSet<AbstractProject>();
                        for (BuildTrigger bt : existingList)
781
                            combinedChildren.addAll(bt.getChildProjects(p));
782 783 784 785 786
                        existing = new BuildTrigger(new ArrayList<AbstractProject>(combinedChildren),existingList.get(0).getThreshold());
                        pl.add(existing);
                        break;
                    }

787
                    if(existing!=null && existing.hasSame(p,newChildProjects))
788
                        continue;   // no need to touch
789
                    pl.replace(new BuildTrigger(newChildProjects,
790
                        existing==null?Result.SUCCESS:existing.getThreshold()));
791 792 793 794 795
                }
            }
        }

        // notify the queue as the project might be now tied to different node
796
        Jenkins.getInstance().getQueue().scheduleMaintenance();
797 798

        // this is to reflect the upstream build adjustments done above
799
        Jenkins.getInstance().rebuildDependencyGraph();
800 801
    }

M
mdonohue 已提交
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild() {
    	return scheduleBuild(new LegacyCodeCause());
    }
    
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(int, Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild(int quietPeriod) {
    	return scheduleBuild(quietPeriod, new LegacyCodeCause());
    }
    
818 819
    /**
     * Schedules a build of this project.
820 821 822 823 824
     *
     * @return
     *      true if the project is actually added to the queue.
     *      false if the queue contained it and therefore the add()
     *      was noop
825
     */
M
mdonohue 已提交
826 827
    public boolean scheduleBuild(Cause c) {
        return scheduleBuild(getQuietPeriod(), c);
K
kohsuke 已提交
828 829
    }

M
mdonohue 已提交
830
    public boolean scheduleBuild(int quietPeriod, Cause c) {
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
        return scheduleBuild(quietPeriod, c, new Action[0]);
    }

    /**
     * Schedules a build.
     *
     * Important: the actions should be persistable without outside references (e.g. don't store
     * references to this project). To provide parameters for a parameterized project, add a ParametersAction. If
     * no ParametersAction is provided for such a project, one will be created with the default parameter values.
     *
     * @param quietPeriod the quiet period to observer
     * @param c the cause for this build which should be recorded
     * @param actions a list of Actions that will be added to the build
     * @return whether the build was actually scheduled
     */
    public boolean scheduleBuild(int quietPeriod, Cause c, Action... actions) {
847 848 849 850 851 852
        return scheduleBuild2(quietPeriod,c,actions)!=null;
    }

    /**
     * Schedules a build of this project, and returns a {@link Future} object
     * to wait for the completion of the build.
853 854 855
     *
     * @param actions
     *      For the convenience of the caller, this array can contain null, and those will be silently ignored.
856
     */
857 858
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Action... actions) {
K
kohsuke 已提交
859 860 861 862 863 864 865 866 867 868 869
        return scheduleBuild2(quietPeriod,c,Arrays.asList(actions));
    }

    /**
     * Schedules a build of this project, and returns a {@link Future} object
     * to wait for the completion of the build.
     *
     * @param actions
     *      For the convenience of the caller, this collection can contain null, and those will be silently ignored.
     * @since 1.383
     */
C
Christoph Kutzinski 已提交
870
    @SuppressWarnings("unchecked")
871 872
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Collection<? extends Action> actions) {
873
        if (!isBuildable())
874
            return null;
875

K
kohsuke 已提交
876
        List<Action> queueActions = new ArrayList<Action>(actions);
877 878 879 880
        if (isParameterized() && Util.filter(queueActions, ParametersAction.class).isEmpty()) {
            queueActions.add(new ParametersAction(getDefaultParametersValues()));
        }

S
sogabe 已提交
881 882 883 884
        if (c != null) {
            queueActions.add(new CauseAction(c));
        }

885
        WaitingItem i = Jenkins.getInstance().getQueue().schedule(this, quietPeriod, queueActions);
886
        if(i!=null)
887
            return (QueueTaskFuture)i.getFuture();
888
        return null;
889 890 891 892 893 894
    }

    private List<ParameterValue> getDefaultParametersValues() {
        ParametersDefinitionProperty paramDefProp = getProperty(ParametersDefinitionProperty.class);
        ArrayList<ParameterValue> defValues = new ArrayList<ParameterValue>();
        
M
mindless 已提交
895 896 897
        /*
         * This check is made ONLY if someone will call this method even if isParametrized() is false.
         */
898 899 900 901 902 903 904 905 906 907 908 909 910
        if(paramDefProp == null)
            return defValues;
        
        /* Scan for all parameter with an associated default values */
        for(ParameterDefinition paramDefinition : paramDefProp.getParameterDefinitions())
        {
           ParameterValue defaultValue  = paramDefinition.getDefaultParameterValue();
            
            if(defaultValue != null)
                defValues.add(defaultValue);           
        }
        
        return defValues;
K
kohsuke 已提交
911 912
    }

913
    /**
914 915 916 917
     * Schedules a build, and returns a {@link Future} object
     * to wait for the completion of the build.
     *
     * <p>
918
     * Production code shouldn't be using this, but for tests this is very convenient, so this isn't marked
919
     * as deprecated.
920
     */
C
Christoph Kutzinski 已提交
921
    @SuppressWarnings("deprecation")
922 923
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod) {
924
        return scheduleBuild2(quietPeriod, new LegacyCodeCause());
M
mdonohue 已提交
925 926
    }
    
K
kohsuke 已提交
927
    /**
928 929
     * Schedules a build of this project, and returns a {@link Future} object
     * to wait for the completion of the build.
K
kohsuke 已提交
930
     */
931 932
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c) {
933 934 935
        return scheduleBuild2(quietPeriod, c, new Action[0]);
    }

936 937 938 939
    /**
     * Schedules a polling of this project.
     */
    public boolean schedulePolling() {
940
        if(isDisabled())    return false;
941
        SCMTrigger scmt = getTrigger(SCMTrigger.class);
942
        if(scmt==null)      return false;
943 944 945 946
        scmt.run();
        return true;
    }

947 948 949 950 951
    /**
     * Returns true if the build is in the queue.
     */
    @Override
    public boolean isInQueue() {
952
        return Jenkins.getInstance().getQueue().contains(this);
953 954
    }

K
kohsuke 已提交
955 956
    @Override
    public Queue.Item getQueueItem() {
957
        return Jenkins.getInstance().getQueue().getItem(this);
K
kohsuke 已提交
958 959
    }

K
kohsuke 已提交
960 961 962
    /**
     * Gets the JDK that this project is configured with, or null.
     */
963
    public JDK getJDK() {
964
        return Jenkins.getInstance().getJDK(jdk);
965 966 967 968 969
    }

    /**
     * Overwrites the JDK setting.
     */
K
kohsuke 已提交
970
    public void setJDK(JDK jdk) throws IOException {
971 972 973 974
        this.jdk = jdk.getName();
        save();
    }

975 976
    public BuildAuthorizationToken getAuthToken() {
        return authToken;
977 978
    }

979
    @Override
980 981
    public RunMap<R> _getRuns() {
        return builds;
982 983
    }

984
    @Override
985 986 987 988
    public void removeRun(R run) {
        this.builds.remove(run);
    }

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuild(String id) {
        return builds.getById(id);
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuildByNumber(int n) {
        return builds.getByNumber(n);
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getFirstBuild() {
        return builds.oldestBuild();
    }

    @Override
    public R getLastBuild() {
        return builds.newestBuild();
    }

    @Override
    public R getNearestBuild(int n) {
        return builds.search(n, Direction.ASC);
    }

    @Override
    public R getNearestOldBuild(int n) {
        return builds.search(n, Direction.DESC);
    }

1034 1035 1036 1037 1038
    /**
     * Determines Class&lt;R>.
     */
    protected abstract Class<R> getBuildClass();

H
huybrechts 已提交
1039
    // keep track of the previous time we started a build
1040
    private transient long lastBuildStartTime;
H
huybrechts 已提交
1041
    
1042 1043 1044
    /**
     * Creates a new build of this project for immediate execution.
     */
H
huybrechts 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    protected synchronized R newBuild() throws IOException {
    	// make sure we don't start two builds in the same second
    	// so the build directories will be different too
    	long timeSinceLast = System.currentTimeMillis() - lastBuildStartTime;
    	if (timeSinceLast < 1000) {
    		try {
				Thread.sleep(1000 - timeSinceLast);
			} catch (InterruptedException e) {
			}
    	}
    	lastBuildStartTime = System.currentTimeMillis();
1056
        try {
1057
            R lastBuild = getBuildClass().getConstructor(getClass()).newInstance(this);
1058 1059 1060 1061 1062 1063 1064
            builds.put(lastBuild);
            return lastBuild;
        } catch (InstantiationException e) {
            throw new Error(e);
        } catch (IllegalAccessException e) {
            throw new Error(e);
        } catch (InvocationTargetException e) {
1065
            throw handleInvocationTargetException(e);
1066 1067 1068 1069
        } catch (NoSuchMethodException e) {
            throw new Error(e);
        }
    }
1070

1071
    private IOException handleInvocationTargetException(InvocationTargetException e) {
1072
        Throwable t = e.getTargetException();
1073 1074 1075
        if(t instanceof Error)  throw (Error)t;
        if(t instanceof RuntimeException)   throw (RuntimeException)t;
        if(t instanceof IOException)    return (IOException)t;
1076 1077 1078
        throw new Error(t);
    }

1079 1080 1081
    /**
     * Loads an existing build record from disk.
     */
1082 1083
    protected R loadBuild(File dir) throws IOException {
        try {
1084
            return getBuildClass().getConstructor(getClass(),File.class).newInstance(this,dir);
1085 1086 1087 1088 1089
        } catch (InstantiationException e) {
            throw new Error(e);
        } catch (IllegalAccessException e) {
            throw new Error(e);
        } catch (InvocationTargetException e) {
1090
            throw handleInvocationTargetException(e);
1091 1092 1093 1094
        } catch (NoSuchMethodException e) {
            throw new Error(e);
        }
    }
1095

K
kohsuke 已提交
1096 1097
    /**
     * {@inheritDoc}
1098
     *
K
kohsuke 已提交
1099 1100
     * <p>
     * Note that this method returns a read-only view of {@link Action}s.
1101
     * {@link BuildStep}s and others who want to add a project action
1102
     * should do so by implementing {@link BuildStep#getProjectActions(AbstractProject)}.
1103 1104
     *
     * @see TransientProjectActionFactory
K
kohsuke 已提交
1105
     */
1106
    @Override
1107 1108 1109 1110
    public synchronized List<Action> getActions() {
        // add all the transient actions, too
        List<Action> actions = new Vector<Action>(super.getActions());
        actions.addAll(transientActions);
1111
        // return the read only list to cause a failure on plugins who try to add an action here
K
kohsuke 已提交
1112
        return Collections.unmodifiableList(actions);
1113 1114
    }

1115 1116
    /**
     * Gets the {@link Node} where this project was last built on.
1117 1118 1119 1120
     *
     * @return
     *      null if no information is available (for example,
     *      if no build was done yet.)
1121 1122 1123 1124
     */
    public Node getLastBuiltOn() {
        // where was it built on?
        AbstractBuild b = getLastBuild();
1125
        if(b==null)
1126 1127 1128 1129 1130
            return null;
        else
            return b.getBuiltOn();
    }

1131 1132 1133 1134
    public Object getSameNodeConstraint() {
        return this; // in this way, any member that wants to run with the main guy can nominate the project itself 
    }

1135 1136 1137 1138
    public final Task getOwnerTask() {
        return this;
    }

1139
    /**
1140
     * {@inheritDoc}
1141
     *
1142
     * <p>
1143
     * A project must be blocked if its own previous build is in progress,
1144 1145
     * or if the blockBuildWhenUpstreamBuilding option is true and an upstream
     * project is building, but derived classes can also check other conditions.
1146
     */
1147
    public boolean isBuildBlocked() {
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
        return getCauseOfBlockage()!=null;
    }

    public String getWhyBlocked() {
        CauseOfBlockage cb = getCauseOfBlockage();
        return cb!=null ? cb.getShortDescription() : null;
    }

    /**
     * Blocked because the previous build is already in progress.
     */
    public static class BecauseOfBuildInProgress extends CauseOfBlockage {
        private final AbstractBuild<?,?> build;

        public BecauseOfBuildInProgress(AbstractBuild<?, ?> build) {
            this.build = build;
1164 1165
        }

1166
        @Override
1167 1168 1169 1170 1171 1172 1173 1174
        public String getShortDescription() {
            Executor e = build.getExecutor();
            String eta = "";
            if (e != null)
                eta = Messages.AbstractProject_ETA(e.getEstimatedRemainingTime());
            int lbn = build.getNumber();
            return Messages.AbstractProject_BuildInProgress(lbn, eta);
        }
1175
    }
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    
    /**
     * Because the downstream build is in progress, and we are configured to wait for that.
     */
    public static class BecauseOfDownstreamBuildInProgress extends CauseOfBlockage {
        public final AbstractProject<?,?> up;

        public BecauseOfDownstreamBuildInProgress(AbstractProject<?,?> up) {
            this.up = up;
        }

        @Override
        public String getShortDescription() {
            return Messages.AbstractProject_DownstreamBuildInProgress(up.getName());
        }
    }
1192

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
    /**
     * Because the upstream build is in progress, and we are configured to wait for that.
     */
    public static class BecauseOfUpstreamBuildInProgress extends CauseOfBlockage {
        public final AbstractProject<?,?> up;

        public BecauseOfUpstreamBuildInProgress(AbstractProject<?,?> up) {
            this.up = up;
        }

1203
        @Override
1204 1205 1206
        public String getShortDescription() {
            return Messages.AbstractProject_UpstreamBuildInProgress(up.getName());
        }
1207 1208
    }

1209
    public CauseOfBlockage getCauseOfBlockage() {
1210 1211
        // Block builds until they are done with post-production
        if (isLogUpdated() && !isConcurrentBuild())
1212
            return new BecauseOfBuildInProgress(getLastBuild());
1213 1214 1215 1216
        if (blockBuildWhenDownstreamBuilding()) {
            AbstractProject<?,?> bup = getBuildingDownstream();
            if (bup!=null)
                return new BecauseOfDownstreamBuildInProgress(bup);
1217 1218
        }
        if (blockBuildWhenUpstreamBuilding()) {
1219 1220 1221 1222 1223 1224
            AbstractProject<?,?> bup = getBuildingUpstream();
            if (bup!=null)
                return new BecauseOfUpstreamBuildInProgress(bup);
        }
        return null;
    }
1225

1226
    /**
1227 1228
     * Returns the project if any of the downstream project is either
     * building, waiting, pending or buildable.
1229 1230 1231 1232
     * <p>
     * This means eventually there will be an automatic triggering of
     * the given project (provided that all builds went smoothly.)
     */
1233
    public AbstractProject getBuildingDownstream() {
1234
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1235

1236
        for (AbstractProject tup : getTransitiveDownstreamProjects()) {
1237
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1238 1239 1240 1241 1242
                return tup;
        }
        return null;
    }

1243
    /**
1244
     * Returns the project if any of the upstream project is either
1245 1246 1247 1248 1249
     * building or is in the queue.
     * <p>
     * This means eventually there will be an automatic triggering of
     * the given project (provided that all builds went smoothly.)
     */
1250
    public AbstractProject getBuildingUpstream() {
1251
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1252

1253
        for (AbstractProject tup : getTransitiveUpstreamProjects()) {
1254
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1255 1256 1257
                return tup;
        }
        return null;
1258 1259
    }

1260 1261
    public List<SubTask> getSubTasks() {
        List<SubTask> r = new ArrayList<SubTask>();
1262
        r.add(this);
1263 1264 1265
        for (SubTaskContributor euc : SubTaskContributor.all())
            r.addAll(euc.forProject(this));
        for (JobProperty<? super P> p : properties)
1266
            r.addAll(p.getSubTasks());
1267
        return r;
1268 1269
    }

1270
    public R createExecutable() throws IOException {
1271
        if(isDisabled())    return null;
1272
        return newBuild();
1273 1274
    }

1275 1276 1277 1278
    public void checkAbortPermission() {
        checkPermission(AbstractProject.ABORT);
    }

K
kohsuke 已提交
1279 1280 1281 1282
    public boolean hasAbortPermission() {
        return hasPermission(AbstractProject.ABORT);
    }

1283 1284
    /**
     * Gets the {@link Resource} that represents the workspace of this project.
1285
     * Useful for locking and mutual exclusion control.
K
kohsuke 已提交
1286
     *
K
kohsuke 已提交
1287
     * @deprecated as of 1.319
K
kohsuke 已提交
1288 1289 1290 1291 1292 1293 1294
     *      Projects no longer have a fixed workspace, ands builds will find an available workspace via
     *      {@link WorkspaceList} for each build (furthermore, that happens after a build is started.)
     *      So a {@link Resource} representation for a workspace at the project level no longer makes sense.
     *
     *      <p>
     *      If you need to lock a workspace while you do some computation, see the source code of
     *      {@link #pollSCMChanges(TaskListener)} for how to obtain a lock of a workspace through {@link WorkspaceList}.
1295 1296
     */
    public Resource getWorkspaceResource() {
1297
        return new Resource(getFullDisplayName()+" workspace");
1298 1299 1300 1301 1302 1303
    }

    /**
     * List of necessary resources to perform the build of this project.
     */
    public ResourceList getResourceList() {
1304
        final Set<ResourceActivity> resourceActivities = getResourceActivities();
1305
        final List<ResourceList> resourceLists = new ArrayList<ResourceList>(1 + resourceActivities.size());
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
        for (ResourceActivity activity : resourceActivities) {
            if (activity != this && activity != null) {
                // defensive infinite recursion and null check
                resourceLists.add(activity.getResourceList());
            }
        }
        return ResourceList.union(resourceLists);
    }

    /**
1316 1317
     * Set of child resource activities of the build of this project (override in child projects).
     * @return The set of child resource activities of the build of this project.
1318 1319
     */
    protected Set<ResourceActivity> getResourceActivities() {
K
kohsuke 已提交
1320
        return Collections.emptySet();
1321 1322
    }

1323
    public boolean checkout(AbstractBuild build, Launcher launcher, BuildListener listener, File changelogFile) throws IOException, InterruptedException {
1324
        SCM scm = getScm();
1325 1326
        if(scm==null)
            return true;    // no SCM
1327

1328 1329
        FilePath workspace = build.getWorkspace();
        workspace.mkdirs();
1330 1331
        
        boolean r = scm.checkout(build, launcher, workspace, listener, changelogFile);
C
Christoph Kutzinski 已提交
1332 1333 1334
        if (r) {
            // Only calcRevisionsFromBuild if checkout was successful. Note that modern SCM implementations
            // won't reach this line anyway, as they throw AbortExceptions on checkout failure.
1335 1336
            calcPollingBaseline(build, launcher, listener);
        }
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
        return r;
    }

    /**
     * Pushes the baseline up to the newly checked out revision.
     */
    private void calcPollingBaseline(AbstractBuild build, Launcher launcher, TaskListener listener) throws IOException, InterruptedException {
        SCMRevisionState baseline = build.getAction(SCMRevisionState.class);
        if (baseline==null) {
            try {
1347
                baseline = getScm()._calcRevisionsFromBuild(build, launcher, listener);
1348 1349 1350 1351 1352 1353 1354 1355 1356
            } catch (AbstractMethodError e) {
                baseline = SCMRevisionState.NONE; // pre-1.345 SCM implementations, which doesn't use the baseline in polling
            }
            if (baseline!=null)
                build.addAction(baseline);
        }
        pollingBaseline = baseline;
    }

1357 1358
    /**
     * Checks if there's any update in SCM, and returns true if any is found.
1359
     *
1360 1361
     * @deprecated as of 1.346
     *      Use {@link #poll(TaskListener)} instead.
1362
     */
1363
    public boolean pollSCMChanges( TaskListener listener ) {
1364 1365 1366 1367 1368 1369 1370
        return poll(listener).hasChanges();
    }

    /**
     * Checks if there's any update in SCM, and returns true if any is found.
     *
     * <p>
1371 1372
     * The implementation is responsible for ensuring mutual exclusion between polling and builds
     * if necessary.
1373 1374 1375 1376
     *
     * @since 1.345
     */
    public PollingResult poll( TaskListener listener ) {
1377
        SCM scm = getScm();
1378
        if (scm==null) {
K
i18n  
kohsuke 已提交
1379
            listener.getLogger().println(Messages.AbstractProject_NoSCM());
1380
            return NO_CHANGES;
1381
        }
1382
        if (isDisabled()) {
K
i18n  
kohsuke 已提交
1383
            listener.getLogger().println(Messages.AbstractProject_Disabled());
1384 1385 1386 1387 1388
            return NO_CHANGES;
        }

        R lb = getLastBuild();
        if (lb==null) {
1389
            listener.getLogger().println(Messages.AbstractProject_NoBuilds());
1390
            return isInQueue() ? NO_CHANGES : BUILD_NOW;
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
        }

        if (pollingBaseline==null) {
            R success = getLastSuccessfulBuild(); // if we have a persisted baseline, we'll find it by this
            for (R r=lb; r!=null; r=r.getPreviousBuild()) {
                SCMRevisionState s = r.getAction(SCMRevisionState.class);
                if (s!=null) {
                    pollingBaseline = s;
                    break;
                }
                if (r==success) break;  // searched far enough
            }
            // NOTE-NO-BASELINE:
            // if we don't have baseline yet, it means the data is built by old Hudson that doesn't set the baseline
            // as action, so we need to compute it. This happens later.
1406 1407 1408
        }

        try {
K
Kohsuke Kawaguchi 已提交
1409 1410 1411 1412
            SCMPollListener.fireBeforePolling(this, listener);
            PollingResult r = _poll(listener, scm, lb);
            SCMPollListener.firePollingSuccess(this,listener, r);
            return r;
1413
        } catch (AbortException e) {
1414
            listener.getLogger().println(e.getMessage());
K
i18n  
kohsuke 已提交
1415
            listener.fatalError(Messages.AbstractProject_Aborted());
1416
            LOGGER.log(Level.FINE, "Polling "+this+" aborted",e);
K
Kohsuke Kawaguchi 已提交
1417
            SCMPollListener.firePollingFailed(this, listener,e);
1418
            return NO_CHANGES;
1419 1420
        } catch (IOException e) {
            e.printStackTrace(listener.fatalError(e.getMessage()));
K
Kohsuke Kawaguchi 已提交
1421
            SCMPollListener.firePollingFailed(this, listener,e);
1422
            return NO_CHANGES;
1423
        } catch (InterruptedException e) {
1424
            e.printStackTrace(listener.fatalError(Messages.AbstractProject_PollingABorted()));
K
Kohsuke Kawaguchi 已提交
1425
            SCMPollListener.firePollingFailed(this, listener,e);
1426
            return NO_CHANGES;
K
Kohsuke Kawaguchi 已提交
1427 1428 1429 1430 1431 1432
        } catch (RuntimeException e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
        } catch (Error e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
1433 1434
        }
    }
K
Kohsuke Kawaguchi 已提交
1435 1436 1437 1438 1439 1440 1441 1442 1443

    /**
     * {@link #poll(TaskListener)} method without the try/catch block that does listener notification and .
     */
    private PollingResult _poll(TaskListener listener, SCM scm, R lb) throws IOException, InterruptedException {
        if (scm.requiresWorkspaceForPolling()) {
            // lock the workspace of the last build
            FilePath ws=lb.getWorkspace();

1444 1445
            WorkspaceOfflineReason workspaceOfflineReason = workspaceOffline( lb );
            if ( workspaceOfflineReason != null ) {
K
Kohsuke Kawaguchi 已提交
1446 1447 1448 1449 1450
                // workspace offline. build now, or nothing will ever be built
                Label label = getAssignedLabel();
                if (label != null && label.isSelfLabel()) {
                    // if the build is fixed on a node, then attempting a build will do us
                    // no good. We should just wait for the slave to come back.
1451 1452
                    listener.getLogger().print(Messages.AbstractProject_NoWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1453 1454 1455 1456 1457 1458 1459 1460 1461
                    return NO_CHANGES;
                }
                listener.getLogger().println( ws==null
                    ? Messages.AbstractProject_WorkspaceOffline()
                    : Messages.AbstractProject_NoWorkspace());
                if (isInQueue()) {
                    listener.getLogger().println(Messages.AbstractProject_AwaitingBuildForWorkspace());
                    return NO_CHANGES;
                } else {
1462 1463
                    listener.getLogger().print(Messages.AbstractProject_NewBuildForWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
                    return BUILD_NOW;
                }
            } else {
                WorkspaceList l = lb.getBuiltOn().toComputer().getWorkspaceList();
                // if doing non-concurrent build, acquire a workspace in a way that causes builds to block for this workspace.
                // this prevents multiple workspaces of the same job --- the behavior of Hudson < 1.319.
                //
                // OTOH, if a concurrent build is chosen, the user is willing to create a multiple workspace,
                // so better throughput is achieved over time (modulo the initial cost of creating that many workspaces)
                // by having multiple workspaces
                WorkspaceList.Lease lease = l.acquire(ws, !concurrentBuild);
1475
                Launcher launcher = ws.createLauncher(listener).decorateByEnv(getEnvironment(lb.getBuiltOn(),listener));
K
Kohsuke Kawaguchi 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
                try {
                    LOGGER.fine("Polling SCM changes of " + getName());
                    if (pollingBaseline==null) // see NOTE-NO-BASELINE above
                        calcPollingBaseline(lb,launcher,listener);
                    PollingResult r = scm.poll(this, launcher, ws, listener, pollingBaseline);
                    pollingBaseline = r.remote;
                    return r;
                } finally {
                    lease.release();
                }
            }
        } else {
            // polling without workspace
            LOGGER.fine("Polling SCM changes of " + getName());

            if (pollingBaseline==null) // see NOTE-NO-BASELINE above
                calcPollingBaseline(lb,null,listener);
            PollingResult r = scm.poll(this, null, null, listener, pollingBaseline);
            pollingBaseline = r.remote;
            return r;
        }
    }

1499 1500 1501 1502 1503 1504 1505
    enum WorkspaceOfflineReason {
        nonexisting_workspace,
        builton_node_gone,
        builton_node_no_executors
    }

    private WorkspaceOfflineReason workspaceOffline(R build) throws IOException, InterruptedException {
1506 1507
        FilePath ws = build.getWorkspace();
        if (ws==null || !ws.exists()) {
1508
            return WorkspaceOfflineReason.nonexisting_workspace;
1509 1510 1511 1512
        }
        
        Node builtOn = build.getBuiltOn();
        if (builtOn == null) { // node built-on doesn't exist anymore
1513
            return WorkspaceOfflineReason.builton_node_gone;
1514 1515 1516
        }
        
        if (builtOn.toComputer() == null) { // node still exists, but has 0 executors - o.s.l.t.
1517
            return WorkspaceOfflineReason.builton_node_no_executors;
1518
        }
1519 1520

        return null;
1521
    }
1522

1523 1524
    /**
     * Returns true if this user has made a commit to this project.
1525
     *
1526 1527 1528
     * @since 1.191
     */
    public boolean hasParticipant(User user) {
1529 1530
        for( R build = getLastBuild(); build!=null; build=build.getPreviousBuild())
            if(build.hasParticipant(user))
1531 1532 1533 1534
                return true;
        return false;
    }

1535
    @Exported
1536 1537 1538 1539
    public SCM getScm() {
        return scm;
    }

1540
    public void setScm(SCM scm) throws IOException {
1541
        this.scm = scm;
1542
        save();
1543 1544
    }

1545 1546 1547
    /**
     * Adds a new {@link Trigger} to this {@link Project} if not active yet.
     */
1548
    public void addTrigger(Trigger<?> trigger) throws IOException {
1549
        addToList(trigger,triggers());
1550 1551
    }

1552
    public void removeTrigger(TriggerDescriptor trigger) throws IOException {
1553
        removeFromList(trigger,triggers());
1554 1555
    }

1556 1557 1558 1559
    protected final synchronized <T extends Describable<T>>
    void addToList( T item, List<T> collection ) throws IOException {
        for( int i=0; i<collection.size(); i++ ) {
            if(collection.get(i).getDescriptor()==item.getDescriptor()) {
1560
                // replace
1561
                collection.set(i,item);
1562 1563 1564 1565 1566 1567 1568
                save();
                return;
            }
        }
        // add
        collection.add(item);
        save();
1569
        updateTransientActions();
1570 1571
    }

1572 1573 1574 1575
    protected final synchronized <T extends Describable<T>>
    void removeFromList(Descriptor<T> item, List<T> collection) throws IOException {
        for( int i=0; i< collection.size(); i++ ) {
            if(collection.get(i).getDescriptor()==item) {
1576 1577 1578
                // found it
                collection.remove(i);
                save();
1579
                updateTransientActions();
1580 1581 1582 1583 1584
                return;
            }
        }
    }

C
Christoph Kutzinski 已提交
1585
    @SuppressWarnings("unchecked")
1586
    public synchronized Map<TriggerDescriptor,Trigger> getTriggers() {
1587
        return (Map)Descriptor.toMap(triggers());
1588 1589
    }

1590
    /**
1591
     * Gets the specific trigger, or null if the propert is not configured for this job.
1592 1593
     */
    public <T extends Trigger> T getTrigger(Class<T> clazz) {
1594
        for (Trigger p : triggers()) {
1595
            if(clazz.isInstance(p))
1596 1597 1598 1599 1600
                return clazz.cast(p);
        }
        return null;
    }

1601 1602 1603 1604 1605
//
//
// fingerprint related
//
//
1606 1607 1608 1609 1610 1611
    /**
     * True if the builds of this project produces {@link Fingerprint} records.
     */
    public abstract boolean isFingerprintConfigured();

    /**
1612 1613
     * Gets the other {@link AbstractProject}s that should be built
     * when a build of this project is completed.
1614
     */
K
kohsuke 已提交
1615
    @Exported
1616
    public final List<AbstractProject> getDownstreamProjects() {
1617
        return Jenkins.getInstance().getDependencyGraph().getDownstream(this);
1618
    }
1619

K
kohsuke 已提交
1620
    @Exported
1621
    public final List<AbstractProject> getUpstreamProjects() {
1622
        return Jenkins.getInstance().getDependencyGraph().getUpstream(this);
K
kohsuke 已提交
1623 1624
    }

K
kohsuke 已提交
1625
    /**
1626 1627 1628 1629
     * Returns only those upstream projects that defines {@link BuildTrigger} to this project.
     * This is a subset of {@link #getUpstreamProjects()}
     *
     * @return A List of upstream projects that has a {@link BuildTrigger} to this project.
K
kohsuke 已提交
1630 1631 1632
     */
    public final List<AbstractProject> getBuildTriggerUpstreamProjects() {
        ArrayList<AbstractProject> result = new ArrayList<AbstractProject>();
1633 1634
        for (AbstractProject<?,?> ap : getUpstreamProjects()) {
            BuildTrigger buildTrigger = ap.getPublishersList().get(BuildTrigger.class);
1635
            if (buildTrigger != null)
1636
                if (buildTrigger.getChildProjects(ap).contains(this))
1637
                    result.add(ap);
1638
        }        
K
kohsuke 已提交
1639
        return result;
1640 1641
    }    
    
K
kohsuke 已提交
1642 1643
    /**
     * Gets all the upstream projects including transitive upstream projects.
1644
     *
K
kohsuke 已提交
1645 1646 1647
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveUpstreamProjects() {
1648
        return Jenkins.getInstance().getDependencyGraph().getTransitiveUpstream(this);
K
kohsuke 已提交
1649 1650 1651
    }

    /**
1652 1653
     * Gets all the downstream projects including transitive downstream projects.
     *
K
kohsuke 已提交
1654 1655 1656
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveDownstreamProjects() {
1657
        return Jenkins.getInstance().getDependencyGraph().getTransitiveDownstream(this);
1658 1659 1660 1661 1662
    }

    /**
     * Gets the dependency relationship map between this project (as the source)
     * and that project (as the sink.)
1663 1664 1665 1666
     *
     * @return
     *      can be empty but not null. build number of this project to the build
     *      numbers of that project.
1667 1668
     */
    public SortedMap<Integer, RangeSet> getRelationship(AbstractProject that) {
1669
        TreeMap<Integer,RangeSet> r = new TreeMap<Integer,RangeSet>(REVERSE_INTEGER_COMPARATOR);
1670 1671 1672 1673 1674 1675 1676 1677 1678

        checkAndRecord(that, r, this.getBuilds());
        // checkAndRecord(that, r, that.getBuilds());

        return r;
    }

    /**
     * Helper method for getDownstreamRelationship.
1679 1680
     *
     * For each given build, find the build number range of the given project and put that into the map.
1681
     */
1682
    private void checkAndRecord(AbstractProject that, TreeMap<Integer, RangeSet> r, Collection<R> builds) {
1683 1684
        for (R build : builds) {
            RangeSet rs = build.getDownstreamRelationship(that);
1685
            if(rs==null || rs.isEmpty())
1686 1687 1688 1689 1690
                continue;

            int n = build.getNumber();

            RangeSet value = r.get(n);
1691 1692
            if(value==null)
                r.put(n,rs);
1693 1694 1695 1696 1697
            else
                value.add(rs);
        }
    }

1698 1699 1700 1701 1702 1703
    /**
     * Builds the dependency graph.
     * @see DependencyGraph
     */
    protected abstract void buildDependencyGraph(DependencyGraph graph);

1704
    @Override
K
kohsuke 已提交
1705 1706
    protected SearchIndexBuilder makeSearchIndex() {
        SearchIndexBuilder sib = super.makeSearchIndex();
1707
        if(isBuildable() && hasPermission(Jenkins.ADMINISTER))
1708
            sib.add("build","build");
K
kohsuke 已提交
1709 1710 1711
        return sib;
    }

1712 1713
    @Override
    protected HistoryWidget createHistoryWidget() {
1714
        return new BuildHistoryWidget<R>(this,builds,HISTORY_ADAPTER);
1715
    }
1716
    
K
kohsuke 已提交
1717
    public boolean isParameterized() {
1718
        return getProperty(ParametersDefinitionProperty.class) != null;
K
kohsuke 已提交
1719
    }
1720

1721 1722 1723 1724 1725
//
//
// actions
//
//
1726 1727 1728
    /**
     * Schedules a new build command.
     */
1729 1730
    public void doBuild( StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay ) throws IOException, ServletException {
        if (delay==null)    delay=new TimeDuration(getQuietPeriod());
1731
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);
1732

K
kohsuke 已提交
1733 1734 1735
        // if a build is parameterized, let that take over
        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
        if (pp != null) {
1736
            pp._doBuild(req,rsp,delay);
K
kohsuke 已提交
1737 1738 1739
            return;
        }

1740 1741 1742
        if (!isBuildable())
            throw HttpResponses.error(SC_INTERNAL_SERVER_ERROR,new IOException(getFullName()+" is not buildable"));

1743
        Jenkins.getInstance().getQueue().schedule(this, (int)delay.getTime(), getBuildCause(req));
1744 1745 1746 1747 1748 1749 1750
        rsp.forwardToPreviousPage(req);
    }

    /**
     * Computes the build cause, using RemoteCause or UserCause as appropriate.
     */
    /*package*/ CauseAction getBuildCause(StaplerRequest req) {
1751 1752
        Cause cause;
        if (authToken != null && authToken.getToken() != null && req.getParameter("token") != null) {
1753 1754
            // Optional additional cause text when starting via token
            String causeText = req.getParameter("cause");
1755
            cause = new RemoteCause(req.getRemoteAddr(), causeText);
1756
        } else {
1757
            cause = new UserIdCause();
1758
        }
1759
        return new CauseAction(cause);
1760 1761 1762 1763
    }

    /**
     * Computes the delay by taking the default value and the override in the request parameter into the account.
1764 1765 1766
     *
     * @deprecated as of 1.488
     *      Inject {@link TimeDuration}.
1767 1768
     */
    public int getDelay(StaplerRequest req) throws ServletException {
1769
        String delay = req.getParameter("delay");
1770 1771 1772 1773 1774 1775 1776 1777 1778
        if (delay==null)    return getQuietPeriod();

        try {
            // TODO: more unit handling
            if(delay.endsWith("sec"))   delay=delay.substring(0,delay.length()-3);
            if(delay.endsWith("secs"))  delay=delay.substring(0,delay.length()-4);
            return Integer.parseInt(delay);
        } catch (NumberFormatException e) {
            throw new ServletException("Invalid delay parameter value: "+delay);
1779
        }
1780
    }
1781

1782 1783 1784 1785
    /**
     * Supports build trigger with parameters via an HTTP GET or POST.
     * Currently only String parameters are supported.
     */
1786
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException {
1787 1788 1789 1790
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);

        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
        if (pp != null) {
1791
            pp.buildWithParameters(req,rsp,delay);
1792 1793 1794 1795 1796
        } else {
        	throw new IllegalStateException("This build is not parameterized!");
        }
    	
    }
1797 1798 1799 1800

    /**
     * Schedules a new SCM polling command.
     */
1801
    public void doPolling( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1802 1803 1804
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);
        schedulePolling();
        rsp.forwardToPreviousPage(req);
1805 1806 1807 1808 1809
    }

    /**
     * Cancels a scheduled build.
     */
1810
    public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1811
        checkPermission(ABORT);
1812

1813
        Jenkins.getInstance().getQueue().cancel(this);
1814 1815 1816
        rsp.forwardToPreviousPage(req);
    }

1817 1818 1819 1820
    /**
     * Deletes this project.
     */
    @Override
1821
    @RequirePOST
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
    public void doDoDelete(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, InterruptedException {
        delete();
        if (req == null || rsp == null)
            return;
        View view = req.findAncestorObject(View.class);
        if (view == null)
            rsp.sendRedirect2(req.getContextPath() + '/' + getParent().getUrl());
        else 
            rsp.sendRedirect2(req.getContextPath() + '/' + view.getUrl());
    }
    
1833
    @Override
1834 1835
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
        super.submit(req,rsp);
1836
        JSONObject json = req.getSubmittedForm();
1837

1838
        makeDisabled(req.getParameter("disable")!=null);
1839 1840

        jdk = req.getParameter("jdk");
1841
        if(req.getParameter("hasCustomQuietPeriod")!=null) {
1842 1843 1844 1845
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));
        } else {
            quietPeriod = null;
        }
1846 1847
        if(req.getParameter("hasCustomScmCheckoutRetryCount")!=null) {
            scmCheckoutRetryCount = Integer.parseInt(req.getParameter("scmCheckoutRetryCount"));
S
 
shinodkm 已提交
1848
        } else {
1849
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1850
        }
1851
        blockBuildWhenDownstreamBuilding = req.getParameter("blockBuildWhenDownstreamBuilding")!=null;
1852 1853
        blockBuildWhenUpstreamBuilding = req.getParameter("blockBuildWhenUpstreamBuilding")!=null;

1854
        if(req.hasParameter("customWorkspace")) {
1855
            customWorkspace = Util.fixEmptyAndTrim(req.getParameter("customWorkspace.directory"));
1856 1857 1858
        } else {
            customWorkspace = null;
        }
1859 1860 1861 1862 1863 1864 1865

        if (json.has("scmCheckoutStrategy"))
            scmCheckoutStrategy = req.bindJSON(SCMCheckoutStrategy.class,
                json.getJSONObject("scmCheckoutStrategy"));
        else
            scmCheckoutStrategy = null;

1866
        
1867
        if(req.getParameter("hasSlaveAffinity")!=null) {
1868
            assignedNode = Util.fixEmptyAndTrim(req.getParameter("_.assignedLabelString"));
1869 1870 1871
        } else {
            assignedNode = null;
        }
1872
        canRoam = assignedNode==null;
1873

1874
        concurrentBuild = req.getSubmittedForm().has("concurrentBuild");
K
kohsuke 已提交
1875

1876
        authToken = BuildAuthorizationToken.create(req);
1877

K
kohsuke 已提交
1878
        setScm(SCMS.parseSCM(req,this));
1879

1880
        for (Trigger t : triggers())
1881
            t.stop();
1882
        triggers = buildDescribable(req, Trigger.for_(this));
1883
        for (Trigger t : triggers)
1884
            t.start(this,true);
1885 1886
    }

K
kohsuke 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895
    /**
     * @deprecated
     *      As of 1.261. Use {@link #buildDescribable(StaplerRequest, List)} instead.
     */
    protected final <T extends Describable<T>> List<T> buildDescribable(StaplerRequest req, List<? extends Descriptor<T>> descriptors, String prefix) throws FormException, ServletException {
        return buildDescribable(req,descriptors);
    }

    protected final <T extends Describable<T>> List<T> buildDescribable(StaplerRequest req, List<? extends Descriptor<T>> descriptors)
1896
        throws FormException, ServletException {
1897

1898
        JSONObject data = req.getSubmittedForm();
1899
        List<T> r = new Vector<T>();
1900
        for (Descriptor<T> d : descriptors) {
1901 1902 1903
            String safeName = d.getJsonSafeClassName();
            if (req.getParameter(safeName) != null) {
                T instance = d.newInstance(req, data.getJSONObject(safeName));
1904
                r.add(instance);
1905 1906
            }
        }
1907
        return r;
1908 1909 1910 1911 1912
    }

    /**
     * Serves the workspace files.
     */
1913
    public DirectoryBrowserSupport doWs( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, InterruptedException {
1914
        checkPermission(AbstractProject.WORKSPACE);
K
kohsuke 已提交
1915
        FilePath ws = getSomeWorkspace();
1916
        if ((ws == null) || (!ws.exists())) {
1917
            // if there's no workspace, report a nice error message
1918 1919 1920 1921
            // Would be good if when asked for *plain*, do something else!
            // (E.g. return 404, or send empty doc.)
            // Not critical; client can just check if content type is not text/plain,
            // which also serves to detect old versions of Hudson.
1922
            req.getView(this,"noWorkspace.jelly").forward(req,rsp);
1923
            return null;
1924
        } else {
1925
            return new DirectoryBrowserSupport(this, ws, getDisplayName()+" workspace", "folder.png", true);
1926 1927
        }
    }
1928

1929 1930 1931
    /**
     * Wipes out the workspace.
     */
1932
    public HttpResponse doDoWipeOutWorkspace() throws IOException, ServletException, InterruptedException {
1933
        checkPermission(Functions.isWipeOutPermissionEnabled() ? WIPEOUT : BUILD);
1934 1935 1936 1937
        R b = getSomeBuildWithWorkspace();
        FilePath ws = b!=null ? b.getWorkspace() : null;
        if (ws!=null && getScm().processWorkspaceBeforeDeletion(this, ws, b.getBuiltOn())) {
            ws.deleteRecursive();
1938 1939 1940
            for (WorkspaceListener wl : WorkspaceListener.all()) {
                wl.afterDelete(this);
            }
1941 1942 1943 1944
            return new HttpRedirect(".");
        } else {
            // If we get here, that means the SCM blocked the workspace deletion.
            return new ForwardToView(this,"wipeOutWorkspaceBlocked.jelly");
1945
        }
1946 1947
    }

1948
    @CLIMethod(name="disable-job")
1949
    @RequirePOST
1950
    public HttpResponse doDisable() throws IOException, ServletException {
1951 1952
        checkPermission(CONFIGURE);
        makeDisabled(true);
1953
        return new HttpRedirect(".");
1954 1955
    }

1956
    @CLIMethod(name="enable-job")
1957
    @RequirePOST
1958
    public HttpResponse doEnable() throws IOException, ServletException {
1959 1960
        checkPermission(CONFIGURE);
        makeDisabled(false);
1961
        return new HttpRedirect(".");
1962 1963
    }

K
kohsuke 已提交
1964 1965 1966
    /**
     * RSS feed for changes in this project.
     */
1967
    public void doRssChangelog(  StaplerRequest req, StaplerResponse rsp  ) throws IOException, ServletException {
K
kohsuke 已提交
1968 1969 1970 1971 1972 1973 1974 1975 1976
        class FeedItem {
            ChangeLogSet.Entry e;
            int idx;

            public FeedItem(Entry e, int idx) {
                this.e = e;
                this.idx = idx;
            }

1977
            AbstractBuild<?,?> getBuild() {
K
kohsuke 已提交
1978 1979 1980 1981 1982 1983
                return e.getParent().build;
            }
        }

        List<FeedItem> entries = new ArrayList<FeedItem>();

1984 1985 1986 1987
        for(R r=getLastBuild(); r!=null; r=r.getPreviousBuild()) {
            int idx=0;
            for( ChangeLogSet.Entry e : r.getChangeSet())
                entries.add(new FeedItem(e,idx++));
K
kohsuke 已提交
1988 1989
        }

1990 1991 1992 1993 1994 1995 1996
        RSS.forwardToRss(
            getDisplayName()+' '+getScm().getDescriptor().getDisplayName()+" changes",
            getUrl()+"changes",
            entries, new FeedAdapter<FeedItem>() {
                public String getEntryTitle(FeedItem item) {
                    return "#"+item.getBuild().number+' '+item.e.getMsg()+" ("+item.e.getAuthor()+")";
                }
K
kohsuke 已提交
1997

1998 1999 2000
                public String getEntryUrl(FeedItem item) {
                    return item.getBuild().getUrl()+"changes#detail"+item.idx;
                }
K
kohsuke 已提交
2001

2002 2003 2004
                public String getEntryID(FeedItem item) {
                    return getEntryUrl(item);
                }
K
kohsuke 已提交
2005

2006 2007 2008 2009 2010 2011
                public String getEntryDescription(FeedItem item) {
                    StringBuilder buf = new StringBuilder();
                    for(String path : item.e.getAffectedPaths())
                        buf.append(path).append('\n');
                    return buf.toString();
                }
2012

2013 2014 2015
                public Calendar getEntryTimestamp(FeedItem item) {
                    return item.getBuild().getTimestamp();
                }
2016

2017
                public String getEntryAuthor(FeedItem entry) {
2018
                    return JenkinsLocationConfiguration.get().getAdminAddress();
2019 2020 2021
                }
            },
            req, rsp );
K
kohsuke 已提交
2022 2023
    }

2024 2025 2026 2027 2028 2029 2030
    /**
     * {@link AbstractProject} subtypes should implement this base class as a descriptor.
     *
     * @since 1.294
     */
    public static abstract class AbstractProjectDescriptor extends TopLevelItemDescriptor {
        /**
2031
         * {@link AbstractProject} subtypes can override this method to veto some {@link Descriptor}s
2032
         * from showing up on their configuration screen. This is often useful when you are building
2033 2034
         * a workflow/company specific project type, where you want to limit the number of choices
         * given to the users.
2035 2036
         *
         * <p>
2037 2038 2039 2040
         * Some {@link Descriptor}s define their own schemes for controlling applicability
         * (such as {@link BuildStepDescriptor#isApplicable(Class)}),
         * This method works like AND in conjunction with them;
         * Both this method and that method need to return true in order for a given {@link Descriptor}
2041 2042 2043 2044
         * to show up for the given {@link Project}.
         *
         * <p>
         * The default implementation returns true for everything.
2045 2046
         *
         * @see BuildStepDescriptor#isApplicable(Class) 
K
kohsuke 已提交
2047 2048
         * @see BuildWrapperDescriptor#isApplicable(AbstractProject) 
         * @see TriggerDescriptor#isApplicable(Item)
2049
         */
K
kohsuke 已提交
2050
        @Override
2051
        public boolean isApplicable(Descriptor descriptor) {
2052 2053
            return true;
        }
2054 2055

        public FormValidation doCheckAssignedLabelString(@QueryParameter String value) {
2056 2057
            if (Util.fixEmpty(value)==null)
                return FormValidation.ok(); // nothing typed yet
2058 2059 2060
            try {
                Label.parseExpression(value);
            } catch (ANTLRException e) {
S
Seiji Sogabe 已提交
2061 2062
                return FormValidation.error(e,
                        Messages.AbstractProject_AssignedLabelString_InvalidBooleanExpression(e.getMessage()));
2063
            }
2064 2065 2066 2067 2068 2069 2070 2071
            Label l = Jenkins.getInstance().getLabel(value);
            if (l.isEmpty()) {
                for (LabelAtom a : l.listAtoms()) {
                    if (a.isEmpty()) {
                        LabelAtom nearest = LabelAtom.findNearest(a.getName());
                        return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch_DidYouMean(a.getName(),nearest.getDisplayName()));
                    }
                }
S
Seiji Sogabe 已提交
2072
                return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch());
2073
            }
2074 2075
            return FormValidation.ok();
        }
2076

2077
        public FormValidation doCheckCustomWorkspace(@QueryParameter(value="customWorkspace.directory") String customWorkspace){
2078
        	if(Util.fixEmptyAndTrim(customWorkspace)==null)
S
Seiji Sogabe 已提交
2079
        		return FormValidation.error(Messages.AbstractProject_CustomWorkspaceEmpty());
2080 2081 2082 2083
        	else
        		return FormValidation.ok();
        }
        
2084 2085
        public AutoCompletionCandidates doAutoCompleteUpstreamProjects(@QueryParameter String value) {
            AutoCompletionCandidates candidates = new AutoCompletionCandidates();
2086
            List<Job> jobs = Jenkins.getInstance().getItems(Job.class);
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
            for (Job job: jobs) {
                if (job.getFullName().startsWith(value)) {
                    if (job.hasPermission(Item.READ)) {
                        candidates.add(job.getFullName());
                    }
                }
            }
            return candidates;
        }

        public AutoCompletionCandidates doAutoCompleteAssignedLabelString(@QueryParameter String value) {
2098
            AutoCompletionCandidates c = new AutoCompletionCandidates();
2099
            Set<Label> labels = Jenkins.getInstance().getLabels();
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
            List<String> queries = new AutoCompleteSeeder(value).getSeeds();

            for (String term : queries) {
                for (Label l : labels) {
                    if (l.getName().startsWith(term)) {
                        c.add(l.getName());
                    }
                }
            }
            return c;
        }

2112
        public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p) {
2113 2114 2115
            return SCMCheckoutStrategyDescriptor._for(p);
        }

2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127
        /**
        * Utility class for taking the current input value and computing a list
        * of potential terms to match against the list of defined labels.
         */
        static class AutoCompleteSeeder {
            private String source;

            AutoCompleteSeeder(String source) {
                this.source = source;
            }

            List<String> getSeeds() {
C
Christoph Kutzinski 已提交
2128
                ArrayList<String> terms = new ArrayList<String>();
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155
                boolean trailingQuote = source.endsWith("\"");
                boolean leadingQuote = source.startsWith("\"");
                boolean trailingSpace = source.endsWith(" ");

                if (trailingQuote || (trailingSpace && !leadingQuote)) {
                    terms.add("");
                } else {
                    if (leadingQuote) {
                        int quote = source.lastIndexOf('"');
                        if (quote == 0) {
                            terms.add(source.substring(1));
                        } else {
                            terms.add("");
                        }
                    } else {
                        int space = source.lastIndexOf(' ');
                        if (space > -1) {
                            terms.add(source.substring(space+1));
                        } else {
                            terms.add(source);
                        }
                    }
                }

                return terms;
            }
        }
2156 2157
    }

2158
    /**
2159
     * Finds a {@link AbstractProject} that has the name closest to the given name.
2160 2161
     */
    public static AbstractProject findNearest(String name) {
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
        return findNearest(name,Hudson.getInstance());
    }

    /**
     * Finds a {@link AbstractProject} whose name (when referenced from the specified context) is closest to the given name.
     *
     * @since 1.419
     */
    public static AbstractProject findNearest(String name, ItemGroup context) {
        List<AbstractProject> projects = Hudson.getInstance().getAllItems(AbstractProject.class);
2172
        String[] names = new String[projects.size()];
2173
        for( int i=0; i<projects.size(); i++ )
2174
            names[i] = projects.get(i).getRelativeNameFrom(context);
2175 2176

        String nearest = EditDistance.findNearest(name, names);
2177
        return (AbstractProject)Jenkins.getInstance().getItem(nearest,context);
2178
    }
2179 2180 2181

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
2182
            return o2-o1;
2183 2184
        }
    };
2185

2186
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
2187

2188
    /**
2189
     * Permission to abort a build
2190
     */
2191
    public static final Permission ABORT = CANCEL;
2192

K
Kohsuke Kawaguchi 已提交
2193 2194 2195
    /**
     * Replaceable "Build Now" text.
     */
2196 2197
    public static final Message<AbstractProject> BUILD_NOW_TEXT = new Message<AbstractProject>();

2198 2199 2200 2201 2202 2203
    /**
     * Used for CLI binding.
     */
    @CLIResolver
    public static AbstractProject resolveForCLI(
            @Argument(required=true,metaVar="NAME",usage="Job name") String name) throws CmdLineException {
2204
        AbstractProject item = Jenkins.getInstance().getItemByFullName(name, AbstractProject.class);
2205 2206 2207 2208
        if (item==null)
            throw new CmdLineException(null,Messages.AbstractItem_NoSuchJobExists(name,AbstractProject.findNearest(name).getFullName()));
        return item;
    }
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227

    public String getCustomWorkspace() {
        return customWorkspace;
    }

    /**
     * User-specified workspace directory, or null if it's up to Jenkins.
     *
     * <p>
     * Normally a project uses the workspace location assigned by its parent container,
     * but sometimes people have builds that have hard-coded paths.
     *
     * <p>
     * This is not {@link File} because it may have to hold a path representation on another OS.
     *
     * <p>
     * If this path is relative, it's resolved against {@link Node#getRootPath()} on the node where this workspace
     * is prepared. 
     *
2228
     * @since 1.410
2229 2230
     */
    public void setCustomWorkspace(String customWorkspace) throws IOException {
2231
        this.customWorkspace= Util.fixEmptyAndTrim(customWorkspace);
2232 2233
        save();
    }
2234
    
2235
}