AbstractProject.java 81.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 antlr.ANTLRException;
31
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
K
kohsuke 已提交
32
import hudson.AbortException;
33
import hudson.CopyOnWrite;
34
import hudson.EnvVars;
35
import hudson.ExtensionList;
36
import hudson.ExtensionPoint;
37
import hudson.FeedAdapter;
38
import hudson.FilePath;
39
import hudson.Functions;
40
import hudson.Launcher;
41
import hudson.Util;
42
import hudson.cli.declarative.CLIMethod;
43
import hudson.cli.declarative.CLIResolver;
M
mdonohue 已提交
44
import hudson.model.Cause.LegacyCodeCause;
45 46
import hudson.model.Descriptor.FormException;
import hudson.model.Fingerprint.RangeSet;
M
Mads Nielsen 已提交
47
import hudson.model.Node.Mode;
K
kohsuke 已提交
48
import hudson.model.Queue.Executable;
49
import hudson.model.Queue.Task;
50 51
import hudson.model.labels.LabelAtom;
import hudson.model.labels.LabelExpression;
52
import hudson.model.listeners.ItemListener;
53
import hudson.model.listeners.SCMPollListener;
54
import hudson.model.queue.CauseOfBlockage;
55 56
import hudson.model.queue.QueueTaskFuture;
import hudson.model.queue.SubTask;
57
import hudson.model.queue.SubTaskContributor;
58
import hudson.node_monitors.DiskSpaceMonitor;
K
kohsuke 已提交
59
import hudson.scm.ChangeLogSet;
K
kohsuke 已提交
60
import hudson.scm.ChangeLogSet.Entry;
61
import hudson.scm.NullSCM;
62
import hudson.scm.PollingResult;
63 64

import static hudson.scm.PollingResult.*;
65
import hudson.scm.SCM;
66
import hudson.scm.SCMRevisionState;
67
import hudson.scm.SCMS;
J
jbq 已提交
68
import hudson.search.SearchIndexBuilder;
69
import hudson.security.ACL;
K
kohsuke 已提交
70
import hudson.security.Permission;
71
import hudson.slaves.Cloud;
72
import hudson.slaves.WorkspaceList;
73
import hudson.tasks.BuildStep;
74
import hudson.tasks.BuildStepDescriptor;
J
jbq 已提交
75
import hudson.tasks.BuildTrigger;
76
import hudson.tasks.BuildWrapperDescriptor;
77
import hudson.tasks.Publisher;
K
kohsuke 已提交
78
import hudson.triggers.SCMTrigger;
79
import hudson.triggers.Trigger;
80
import hudson.triggers.TriggerDescriptor;
81 82
import hudson.util.AlternativeUiTextProvider;
import hudson.util.AlternativeUiTextProvider.Message;
83
import hudson.util.DescribableList;
S
 
shinodkm 已提交
84
import hudson.util.FormValidation;
K
Kohsuke Kawaguchi 已提交
85
import hudson.util.TimeUnit2;
K
kohsuke 已提交
86
import hudson.widgets.HistoryWidget;
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.Vector;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.servlet.ServletException;
109
import jenkins.model.Jenkins;
110
import jenkins.model.JenkinsLocationConfiguration;
111
import jenkins.model.ParameterizedJobMixIn;
K
Kohsuke Kawaguchi 已提交
112
import jenkins.model.Uptime;
J
Jesse Glick 已提交
113
import jenkins.model.lazy.LazyBuildMixIn;
114 115 116
import jenkins.scm.DefaultSCMCheckoutStrategyImpl;
import jenkins.scm.SCMCheckoutStrategy;
import jenkins.scm.SCMCheckoutStrategyDescriptor;
117
import jenkins.util.TimeDuration;
K
kohsuke 已提交
118
import net.sf.json.JSONObject;
119
import org.acegisecurity.Authentication;
K
Kohsuke Kawaguchi 已提交
120
import org.jenkinsci.bytecode.AdaptField;
121
import org.kohsuke.accmod.Restricted;
122
import org.kohsuke.accmod.restrictions.DoNotUse;
123
import org.kohsuke.accmod.restrictions.NoExternalUse;
124 125
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
126
import org.kohsuke.stapler.AncestorInPath;
127 128 129 130
import org.kohsuke.stapler.ForwardToView;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
K
kohsuke 已提交
131 132 133
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
134
import org.kohsuke.stapler.interceptor.RequirePOST;
135 136 137

/**
 * Base implementation of {@link Job}s that build software.
138
 *
139
 * For now this is primarily the common part of {@link Project} and MavenModule.
140
 *
141 142 143
 * @author Kohsuke Kawaguchi
 * @see AbstractBuild
 */
C
Christoph Kutzinski 已提交
144
@SuppressWarnings("rawtypes")
145
public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>> extends Job<P,R> implements BuildableItem, LazyBuildMixIn.LazyLoadingJob<P,R>, ParameterizedJobMixIn.ParameterizedJob {
146

147
    /**
148 149 150
     * {@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()}.
151
     */
K
kohsuke 已提交
152
    private volatile SCM scm = new NullSCM();
153

154 155 156 157 158
    /**
     * Controls how the checkout is done.
     */
    private volatile SCMCheckoutStrategy scmCheckoutStrategy;

159 160 161
    /**
     * State returned from {@link SCM#poll(AbstractProject, Launcher, FilePath, TaskListener, SCMRevisionState)}.
     */
162
    private volatile transient SCMRevisionState pollingBaseline = null;
163

J
Jesse Glick 已提交
164 165
    private transient LazyBuildMixIn<P,R> buildMixIn;

166 167
    /**
     * All the builds keyed by their build number.
J
Jesse Glick 已提交
168
     * Kept here for binary compatibility only; otherwise use {@link #buildMixIn}.
169 170
     * External code should use {@link #getBuildByNumber(int)} or {@link #getLastBuild()} and traverse via
     * {@link Run#getPreviousBuild()}
171
     */
172
    @Restricted(NoExternalUse.class)
J
Jesse Glick 已提交
173
    protected transient RunMap<R> builds;
174 175 176 177

    /**
     * The quiet period. Null to delegate to the system default.
     */
K
kohsuke 已提交
178
    private volatile Integer quietPeriod = null;
S
 
shinodkm 已提交
179 180
    
    /**
181
     * The retry count. Null to delegate to the system default.
S
 
shinodkm 已提交
182
     */
183
    private volatile Integer scmCheckoutRetryCount = null;
184 185

    /**
186 187 188 189 190 191 192
     * 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.
     *
193
     * @see #canRoam
194 195 196 197 198
     */
    private String assignedNode;

    /**
     * True if this project can be built on any node.
199
     *
200
     * <p>
201 202
     * This somewhat ugly flag combination is so that we can migrate
     * existing Hudson installations nicely.
203
     */
K
kohsuke 已提交
204
    private volatile boolean canRoam;
205 206 207 208

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

211 212 213 214 215 216
    /**
     * 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;

217 218 219 220 221 222
    /**
     * 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;

223
    /**
224 225 226
     * Identifies {@link JDK} to be used.
     * Null if no explicit configuration is required.
     *
227
     * <p>
228
     * Can't store {@link JDK} directly because {@link Jenkins} and {@link Project}
229 230
     * are saved independently.
     *
231
     * @see Jenkins#getJDK(String)
232
     */
K
kohsuke 已提交
233
    private volatile String jdk;
234

K
kohsuke 已提交
235
    private volatile BuildAuthorizationToken authToken = null;
236

237 238 239
    /**
     * List of all {@link Trigger}s for this project.
     */
K
Kohsuke Kawaguchi 已提交
240
    @AdaptField(was=List.class)
K
Kohsuke Kawaguchi 已提交
241
    protected volatile DescribableList<Trigger<?>,TriggerDescriptor> triggers = new DescribableList<Trigger<?>,TriggerDescriptor>(this);
K
Kohsuke Kawaguchi 已提交
242
    private static final AtomicReferenceFieldUpdater<AbstractProject,DescribableList> triggersUpdater
K
bug fix  
Kohsuke Kawaguchi 已提交
243
            = AtomicReferenceFieldUpdater.newUpdater(AbstractProject.class,DescribableList.class,"triggers");
244

245 246
    /**
     * {@link Action}s contributed from subsidiary objects associated with
247 248 249 250
     * {@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.
251
     */
252 253
    @CopyOnWrite
    protected transient volatile List<Action> transientActions = new Vector<Action>();
254

K
kohsuke 已提交
255 256
    private boolean concurrentBuild;

257 258 259
    /**
     * See {@link #setCustomWorkspace(String)}.
     *
260
     * @since 1.410
261 262 263
     */
    private String customWorkspace;
    
264
    protected AbstractProject(ItemGroup parent, String name) {
265
        super(parent,name);
266 267
        buildMixIn = createBuildMixIn();
        builds = buildMixIn.getRunMap();
268

269
        if(Jenkins.getInstance()!=null && !Jenkins.getInstance().getNodes().isEmpty()) {
270
            // if a new job is configured with Hudson that already has slave nodes
271 272 273
            // make it roamable by default
            canRoam = true;
        }
274 275
    }

276
    private LazyBuildMixIn<P,R> createBuildMixIn() {
J
Jesse Glick 已提交
277 278 279 280 281
        return new LazyBuildMixIn<P,R>() {
            @SuppressWarnings("unchecked") // untypable
            @Override protected P asJob() {
                return (P) AbstractProject.this;
            }
J
Jesse Glick 已提交
282 283 284 285 286 287
            @Override protected Class<R> getBuildClass() {
                return AbstractProject.this.getBuildClass();
            }
        };
    }

288 289 290 291
    @Override public LazyBuildMixIn<P,R> getLazyBuildMixIn() {
        return buildMixIn;
    }

292 293 294 295 296 297 298
    private ParameterizedJobMixIn<P,R> getParameterizedJobMixIn() {
        return new ParameterizedJobMixIn<P,R>() {
            @SuppressWarnings("unchecked") // untypable
            @Override protected P asJob() {
                return (P) AbstractProject.this;
            }
        };
299 300
    }

301 302 303 304 305 306
    @Override
    public synchronized void save() throws IOException {
        super.save();
        updateTransientActions();
    }

307 308 309
    @Override
    public void onCreatedFromScratch() {
        super.onCreatedFromScratch();
J
Jesse Glick 已提交
310 311
        buildMixIn.onCreatedFromScratch();
        builds = buildMixIn.getRunMap();
312 313
        // solicit initial contributions, especially from TransientProjectActionFactory
        updateTransientActions();
314 315
    }

316
    @Override
317
    public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
318
        super.onLoad(parent, name);
319 320 321
        if (buildMixIn == null) {
            buildMixIn = createBuildMixIn();
        }
322 323
        buildMixIn.onLoad(parent, name);
        builds = buildMixIn.getRunMap();
K
Kohsuke Kawaguchi 已提交
324
        triggers().setOwner(this);
325 326 327
        for (Trigger t : triggers()) {
            t.start(this, Items.currentlyUpdatingByXml());
        }
328 329
        if(scm==null)
            scm = new NullSCM(); // perhaps it was pointing to a plugin that no longer exists.
330

331 332
        if(transientActions==null)
            transientActions = new Vector<Action>();    // happens when loaded from disk
333
        updateTransientActions();
334 335
    }

K
Kohsuke Kawaguchi 已提交
336 337
    @WithBridgeMethods(List.class)
    protected DescribableList<Trigger<?>,TriggerDescriptor> triggers() {
338
        if (triggers == null) {
K
Kohsuke Kawaguchi 已提交
339
            triggersUpdater.compareAndSet(this,null,new DescribableList<Trigger<?>,TriggerDescriptor>(this));
340 341 342 343
        }
        return triggers;
    }

344 345 346 347
    @Override
    public EnvVars getEnvironment(Node node, TaskListener listener) throws IOException, InterruptedException {
        EnvVars env =  super.getEnvironment(node, listener);

348 349
        JDK jdkTool = getJDK();
        if (jdkTool != null) {
350
            if (node != null) { // just in case were not in a build
351
                jdkTool = jdkTool.forNode(node, listener);
352
            }
353
            jdkTool.buildEnvVars(env);
354
        } else if (jdk != null && !jdk.equals(JDK.DEFAULT_NAME)) {
355
            listener.getLogger().println("No JDK named ‘" + jdk + "’ found");
356 357 358 359 360
        }

        return env;
    }

361
    @Override
362
    protected void performDelete() throws IOException, InterruptedException {
K
kohsuke 已提交
363 364
        // prevent a new build while a delete operation is in progress
        makeDisabled(true);
365
        FilePath ws = getWorkspace();
366
        if(ws!=null) {
K
NPE fix  
kohsuke 已提交
367 368 369 370
            Node on = getLastBuiltOn();
            getScm().processWorkspaceBeforeDeletion(this, ws, on);
            if(on!=null)
                on.getFileSystemProvisioner().discardWorkspace(this,ws);
371
        }
K
kohsuke 已提交
372 373 374
        super.performDelete();
    }

K
kohsuke 已提交
375 376
    /**
     * Does this project perform concurrent builds?
K
kohsuke 已提交
377
     * @since 1.319
K
kohsuke 已提交
378
     */
K
kohsuke 已提交
379
    @Exported
K
kohsuke 已提交
380
    public boolean isConcurrentBuild() {
381
        return concurrentBuild;
K
kohsuke 已提交
382 383 384 385 386 387 388
    }

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

389
    /**
390 391
     * If this project is configured to be always built on this node,
     * return that {@link Node}. Otherwise null.
392
     */
393
    public @CheckForNull Label getAssignedLabel() {
394
        if(canRoam)
395 396
            return null;

397
        if(assignedNode==null)
398 399
            return Jenkins.getInstance().getSelfLabel();
        return Jenkins.getInstance().getLabel(assignedNode);
400 401
    }

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    /**
     * 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());
    }

417 418 419 420
    /**
     * Gets the textual representation of the assigned label as it was entered by the user.
     */
    public String getAssignedLabelString() {
421 422 423 424 425 426 427 428
        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);
        }
429 430
    }

K
kohsuke 已提交
431 432 433 434 435 436 437 438 439
    /**
     * Sets the assigned label.
     */
    public void setAssignedLabel(Label l) throws IOException {
        if(l==null) {
            canRoam = true;
            assignedNode = null;
        } else {
            canRoam = false;
440
            if(l== Jenkins.getInstance().getSelfLabel())  assignedNode = null;
441
            else                                        assignedNode = l.getExpression();
K
kohsuke 已提交
442 443 444 445
        }
        save();
    }

446 447 448 449 450 451 452
    /**
     * Assigns this job to the given node. A convenience method over {@link #setAssignedLabel(Label)}.
     */
    public void setAssignedNode(Node l) throws IOException {
        setAssignedLabel(l.getSelfLabel());
    }

453
    /**
454 455
     * Get the term used in the UI to represent this kind of {@link AbstractProject}.
     * Must start with a capital letter.
456 457 458
     */
    @Override
    public String getPronoun() {
K
Kohsuke Kawaguchi 已提交
459
        return AlternativeUiTextProvider.get(PRONOUN, this,Messages.AbstractProject_Pronoun());
460 461
    }

462 463 464 465 466 467
    /**
     * Gets the human readable display name to be rendered in the "Build Now" link.
     *
     * @since 1.401
     */
    public String getBuildNowText() {
468
        return AlternativeUiTextProvider.get(BUILD_NOW_TEXT, this, getParameterizedJobMixIn().getBuildNowText());
469 470
    }

471
    /**
472
     * Gets the nearest ancestor {@link TopLevelItem} that's also an {@link AbstractProject}.
473
     *
474 475 476 477 478 479 480
     * <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()
481
     */
482 483
    public AbstractProject<?,?> getRootProject() {
        if (this instanceof TopLevelItem) {
484 485
            return this;
        } else {
486 487 488 489
            ItemGroup p = this.getParent();
            if (p instanceof AbstractProject)
                return ((AbstractProject) p).getRootProject();
            return this;
490 491 492
        }
    }

493 494
    /**
     * Gets the directory where the module is checked out.
495 496 497
     *
     * @return
     *      null if the workspace is on a slave that's not connected.
K
kohsuke 已提交
498
     * @deprecated as of 1.319
K
kohsuke 已提交
499 500 501 502 503
     *      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>
504
     *      If you are calling this method during a build from an executor, switch it to {@link AbstractBuild#getWorkspace()}.
K
kohsuke 已提交
505 506 507 508
     *      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() {
509 510 511 512 513 514 515 516 517 518 519 520
        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 已提交
521 522 523 524 525 526
        Executor e = Executor.currentExecutor();
        if(e!=null) {
            Executable exe = e.getCurrentExecutable();
            if (exe instanceof AbstractBuild) {
                AbstractBuild b = (AbstractBuild) exe;
                if(b.getProject()==this)
527
                    return b;
K
kohsuke 已提交
528 529 530
            }
        }
        R lb = getLastBuild();
531
        if(lb!=null)    return lb;
K
kohsuke 已提交
532 533 534 535 536 537 538 539 540 541 542 543 544
        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 已提交
545
     * @since 1.319
546
     */
J
Jesse Glick 已提交
547
    public final @CheckForNull FilePath getSomeWorkspace() {
548
        R b = getSomeBuildWithWorkspace();
549
        if (b!=null) return b.getWorkspace();
550
        for (WorkspaceBrowser browser : ExtensionList.lookup(WorkspaceBrowser.class)) {
551 552 553 554
            FilePath f = browser.getWorkspace(this);
            if (f != null) return f;
        }
        return null;
555 556 557 558 559 560 561 562
    }

    /**
     * Gets some build that has a live workspace.
     *
     * @return null if no such build exists.
     */
    public final R getSomeBuildWithWorkspace() {
K
kohsuke 已提交
563 564 565
        int cnt=0;
        for (R b = getLastBuild(); cnt<5 && b!=null; b=b.getPreviousBuild()) {
            FilePath ws = b.getWorkspace();
566
            if (ws!=null)   return b;
K
kohsuke 已提交
567 568 569
        }
        return null;
    }
570 571 572 573 574 575 576 577 578
    
    private R getSomeBuildWithExistingWorkspace() throws IOException, InterruptedException {
        int cnt=0;
        for (R b = getLastBuild(); cnt<5 && b!=null; b=b.getPreviousBuild()) {
            FilePath ws = b.getWorkspace();
            if (ws!=null && ws.exists())   return b;
        }
        return null;
    }
579

580 581 582
    /**
     * Returns the root directory of the checked-out module.
     * <p>
583 584
     * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
     * and so on exists.
K
kohsuke 已提交
585
     *
K
kohsuke 已提交
586
     * @deprecated as of 1.319
K
kohsuke 已提交
587
     *      See {@link #getWorkspace()} for a migration strategy.
588 589
     */
    public FilePath getModuleRoot() {
590 591
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoot() : null;
592 593
    }

S
stephenconnolly 已提交
594 595 596 597 598 599
    /**
     * 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 已提交
600
     *
K
kohsuke 已提交
601
     * @deprecated as of 1.319
K
kohsuke 已提交
602
     *      See {@link #getWorkspace()} for a migration strategy.
S
stephenconnolly 已提交
603 604
     */
    public FilePath[] getModuleRoots() {
605 606
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoots() : null;
S
stephenconnolly 已提交
607 608
    }

609
    public int getQuietPeriod() {
610
        return quietPeriod!=null ? quietPeriod : Jenkins.getInstance().getQuietPeriod();
611
    }
612

613
    public SCMCheckoutStrategy getScmCheckoutStrategy() {
614 615 616
        return scmCheckoutStrategy == null ? new DefaultSCMCheckoutStrategyImpl() : scmCheckoutStrategy;
    }

617
    public void setScmCheckoutStrategy(SCMCheckoutStrategy scmCheckoutStrategy) throws IOException {
618 619 620 621 622
        this.scmCheckoutStrategy = scmCheckoutStrategy;
        save();
    }


623
    public int getScmCheckoutRetryCount() {
624
        return scmCheckoutRetryCount !=null ? scmCheckoutRetryCount : Jenkins.getInstance().getScmCheckoutRetryCount();
S
 
shinodkm 已提交
625
    }
626 627 628

    // ugly name because of EL
    public boolean getHasCustomQuietPeriod() {
629
        return quietPeriod!=null;
630
    }
K
kohsuke 已提交
631 632 633 634

    /**
     * Sets the custom quiet period of this project, or revert to the global default if null is given. 
     */
635
    public void setQuietPeriod(Integer seconds) throws IOException {
K
kohsuke 已提交
636 637 638
        this.quietPeriod = seconds;
        save();
    }
S
 
shinodkm 已提交
639
    
640
    public boolean hasCustomScmCheckoutRetryCount(){
641
        return scmCheckoutRetryCount != null;
S
 
shinodkm 已提交
642
    }
643

644
    @Override
645
    public boolean isBuildable() {
J
jpederzolli 已提交
646
        return !isDisabled() && !isHoldOffBuildUntilSave();
647 648
    }

649
    /**
650 651
     * Used in <tt>sidepanel.jelly</tt> to decide whether to display
     * the config/delete/build links.
652 653 654 655 656
     */
    public boolean isConfigurable() {
        return true;
    }

657 658 659 660 661 662 663 664 665
    public boolean blockBuildWhenDownstreamBuilding() {
        return blockBuildWhenDownstreamBuilding;
    }

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

666
    public boolean blockBuildWhenUpstreamBuilding() {
667
        return blockBuildWhenUpstreamBuilding;
668 669
    }

670
    public void setBlockBuildWhenUpstreamBuilding(boolean b) throws IOException {
671 672
        blockBuildWhenUpstreamBuilding = b;
        save();
673 674
    }

675 676 677
    public boolean isDisabled() {
        return disabled;
    }
S
 
shinodkm 已提交
678 679 680 681 682
    
    /**
     * Validates the retry count Regex
     */
    public FormValidation doCheckRetryCount(@QueryParameter String value)throws IOException,ServletException{
683 684 685 686 687 688 689
        // 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 已提交
690
    }
691

692 693
    /**
     * Marks the build as disabled.
694 695 696
     * The method will ignore the disable command if {@link #supportsMakeDisabled()}
     * returns false. The enable command will be executed in any case.
     * @param b true - disable, false - enable 
O
Oleg Nenashev 已提交
697
     * @since 1.585 Do not disable projects if {@link #supportsMakeDisabled()} returns false
698 699
     */
    public void makeDisabled(boolean b) throws IOException {
700
        if(disabled==b)     return; // noop
701
        if (b && !supportsMakeDisabled()) return; // do nothing if the disabling is unsupported
702
        this.disabled = b;
K
bug fix  
kohsuke 已提交
703
        if(b)
704
            Jenkins.getInstance().getQueue().cancel(this);
R
rednuht 已提交
705
        
706
        save();
R
rednuht 已提交
707
        ItemListener.fireOnUpdated(this);
708 709
    }

710 711
    /**
     * Specifies whether this project may be disabled by the user.
712 713
     * By default, it can be only if this is a {@link TopLevelItem};
     * would be false for matrix configurations, etc.
714 715 716 717
     * @return true if the GUI should allow {@link #doDisable} and the like
     * @since 1.475
     */
    public boolean supportsMakeDisabled() {
718
        return this instanceof TopLevelItem;
719 720
    }

721 722 723 724 725 726 727 728
    public void disable() throws IOException {
        makeDisabled(true);
    }

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

K
kohsuke 已提交
729 730
    @Override
    public BallColor getIconColor() {
731
        if(isDisabled())
732
            return isBuilding() ? BallColor.DISABLED_ANIME : BallColor.DISABLED;
K
kohsuke 已提交
733 734 735
        else
            return super.getIconColor();
    }
736

737 738 739 740 741 742 743
    /**
     * effectively deprecated. Since using updateTransientActions correctly
     * under concurrent environment requires a lock that can too easily cause deadlocks.
     *
     * <p>
     * Override {@link #createTransientActions()} instead.
     */
744
    protected void updateTransientActions() {
745 746 747 748
        transientActions = createTransientActions();
    }

    protected List<Action> createTransientActions() {
749
        Vector<Action> ta = new Vector<Action>();
750

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

754 755
        for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all())
            ta.addAll(Util.fixNull(tpaf.createFor(this))); // be defensive against null
756
        return ta;
757 758
    }

759
    /**
760 761
     * Returns the live list of all {@link Publisher}s configured for this project.
     *
762
     * <p>
763 764
     * This method couldn't be called <tt>getPublishers()</tt> because existing methods
     * in sub-classes return different inconsistent types.
765
     */
766
    public abstract DescribableList<Publisher,Descriptor<Publisher>> getPublishersList();
767

K
kohsuke 已提交
768 769 770 771 772 773
    @Override
    public void addProperty(JobProperty<? super P> jobProp) throws IOException {
        super.addProperty(jobProp);
        updateTransientActions();
    }

774
    public List<ProminentProjectAction> getProminentActions() {
775
        return getActions(ProminentProjectAction.class);
776 777
    }

778
    @Override
779
    public void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, FormException {
780
        super.doConfigSubmit(req,rsp);
781

782 783
        updateTransientActions();

784
        // notify the queue as the project might be now tied to different node
785
        Jenkins.getInstance().getQueue().scheduleMaintenance();
786 787

        // this is to reflect the upstream build adjustments done above
788
        Jenkins.getInstance().rebuildDependencyGraphAsync();
789 790
    }

791
    /**
M
mdonohue 已提交
792 793 794 795
	 * @deprecated
	 *    Use {@link #scheduleBuild(Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild() {
796
    	return getParameterizedJobMixIn().scheduleBuild();
M
mdonohue 已提交
797 798 799 800 801 802 803
    }
    
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(int, Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild(int quietPeriod) {
804
    	return getParameterizedJobMixIn().scheduleBuild(quietPeriod);
M
mdonohue 已提交
805 806
    }
    
807 808
    /**
     * Schedules a build of this project.
809 810
     *
     * @return
K
Kohsuke Kawaguchi 已提交
811 812
     *      true if the project is added to the queue.
     *      false if the task was rejected from the queue (such as when the system is being shut down.)
813
     */
M
mdonohue 已提交
814
    public boolean scheduleBuild(Cause c) {
815
        return getParameterizedJobMixIn().scheduleBuild(c);
K
kohsuke 已提交
816 817
    }

M
mdonohue 已提交
818
    public boolean scheduleBuild(int quietPeriod, Cause c) {
819
        return getParameterizedJobMixIn().scheduleBuild(quietPeriod, c);
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
    }

    /**
     * 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) {
835 836 837 838 839 840
        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.
841 842 843
     *
     * @param actions
     *      For the convenience of the caller, this array can contain null, and those will be silently ignored.
844
     */
845 846
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Action... actions) {
K
kohsuke 已提交
847 848 849 850 851 852 853 854 855 856 857
        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 已提交
858
    @SuppressWarnings("unchecked")
859 860
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Collection<? extends Action> actions) {
K
kohsuke 已提交
861
        List<Action> queueActions = new ArrayList<Action>(actions);
S
sogabe 已提交
862 863 864
        if (c != null) {
            queueActions.add(new CauseAction(c));
        }
865
        return getParameterizedJobMixIn().scheduleBuild2(quietPeriod, queueActions.toArray(new Action[queueActions.size()]));
K
kohsuke 已提交
866 867
    }

868
    /**
869 870 871 872
     * Schedules a build, and returns a {@link Future} object
     * to wait for the completion of the build.
     *
     * <p>
873
     * Production code shouldn't be using this, but for tests this is very convenient, so this isn't marked
874
     * as deprecated.
875
     */
C
Christoph Kutzinski 已提交
876
    @SuppressWarnings("deprecation")
877 878
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod) {
879
        return scheduleBuild2(quietPeriod, new LegacyCodeCause());
M
mdonohue 已提交
880 881
    }
    
K
kohsuke 已提交
882
    /**
883 884
     * Schedules a build of this project, and returns a {@link Future} object
     * to wait for the completion of the build.
K
kohsuke 已提交
885
     */
886 887
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c) {
888 889 890
        return scheduleBuild2(quietPeriod, c, new Action[0]);
    }

891 892 893 894
    /**
     * Schedules a polling of this project.
     */
    public boolean schedulePolling() {
895
        if(isDisabled())    return false;
896
        SCMTrigger scmt = getTrigger(SCMTrigger.class);
897
        if(scmt==null)      return false;
898 899 900 901
        scmt.run();
        return true;
    }

902 903 904 905 906
    /**
     * Returns true if the build is in the queue.
     */
    @Override
    public boolean isInQueue() {
907
        return Jenkins.getInstance().getQueue().contains(this);
908 909
    }

K
kohsuke 已提交
910 911
    @Override
    public Queue.Item getQueueItem() {
912
        return Jenkins.getInstance().getQueue().getItem(this);
K
kohsuke 已提交
913 914
    }

K
kohsuke 已提交
915 916 917
    /**
     * Gets the JDK that this project is configured with, or null.
     */
918
    public JDK getJDK() {
919
        return Jenkins.getInstance().getJDK(jdk);
920 921 922 923 924
    }

    /**
     * Overwrites the JDK setting.
     */
K
kohsuke 已提交
925
    public void setJDK(JDK jdk) throws IOException {
926 927 928 929
        this.jdk = jdk.getName();
        save();
    }

930 931
    public BuildAuthorizationToken getAuthToken() {
        return authToken;
932 933
    }

934
    @Override
935
    public RunMap<R> _getRuns() {
J
Jesse Glick 已提交
936
        return buildMixIn._getRuns();
937 938
    }

939
    @Override
940
    public void removeRun(R run) {
J
Jesse Glick 已提交
941
        buildMixIn.removeRun(run);
942 943
    }

944 945 946 947 948 949 950
    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuild(String id) {
J
Jesse Glick 已提交
951
        return buildMixIn.getBuild(id);
952 953 954 955 956 957 958 959 960
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuildByNumber(int n) {
J
Jesse Glick 已提交
961
        return buildMixIn.getBuildByNumber(n);
962 963 964 965 966 967 968 969 970
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getFirstBuild() {
J
Jesse Glick 已提交
971
        return buildMixIn.getFirstBuild();
972 973 974
    }

    @Override
975
    public @CheckForNull R getLastBuild() {
J
Jesse Glick 已提交
976
        return buildMixIn.getLastBuild();
977 978 979 980
    }

    @Override
    public R getNearestBuild(int n) {
J
Jesse Glick 已提交
981
        return buildMixIn.getNearestBuild(n);
982 983 984 985
    }

    @Override
    public R getNearestOldBuild(int n) {
J
Jesse Glick 已提交
986
        return buildMixIn.getNearestOldBuild(n);
987 988
    }

989
    /**
J
Jesse Glick 已提交
990 991 992 993
     * Type token for the corresponding build type.
     * The build class must have two constructors:
     * one taking this project type;
     * and one taking this project type, then {@link File}.
994 995 996
     */
    protected abstract Class<R> getBuildClass();

997 998 999
    /**
     * Creates a new build of this project for immediate execution.
     */
H
huybrechts 已提交
1000
    protected synchronized R newBuild() throws IOException {
J
Jesse Glick 已提交
1001
        return buildMixIn.newBuild();
1002 1003
    }

1004 1005 1006
    /**
     * Loads an existing build record from disk.
     */
1007
    protected R loadBuild(File dir) throws IOException {
J
Jesse Glick 已提交
1008
        return buildMixIn.loadBuild(dir);
1009
    }
1010

K
kohsuke 已提交
1011 1012
    /**
     * {@inheritDoc}
1013
     *
K
kohsuke 已提交
1014 1015
     * <p>
     * Note that this method returns a read-only view of {@link Action}s.
1016
     * {@link BuildStep}s and others who want to add a project action
1017
     * should do so by implementing {@link BuildStep#getProjectActions(AbstractProject)}.
1018 1019
     *
     * @see TransientProjectActionFactory
K
kohsuke 已提交
1020
     */
1021
    @SuppressWarnings("deprecation")
1022
    @Override
1023
    public List<Action> getActions() {
1024 1025 1026
        // add all the transient actions, too
        List<Action> actions = new Vector<Action>(super.getActions());
        actions.addAll(transientActions);
1027
        // return the read only list to cause a failure on plugins who try to add an action here
K
kohsuke 已提交
1028
        return Collections.unmodifiableList(actions);
1029 1030
    }

1031 1032
    /**
     * Gets the {@link Node} where this project was last built on.
1033 1034 1035 1036
     *
     * @return
     *      null if no information is available (for example,
     *      if no build was done yet.)
1037 1038 1039 1040
     */
    public Node getLastBuiltOn() {
        // where was it built on?
        AbstractBuild b = getLastBuild();
1041
        if(b==null)
1042 1043 1044 1045 1046
            return null;
        else
            return b.getBuiltOn();
    }

1047 1048 1049 1050
    public Object getSameNodeConstraint() {
        return this; // in this way, any member that wants to run with the main guy can nominate the project itself 
    }

1051 1052 1053 1054
    public final Task getOwnerTask() {
        return this;
    }

1055 1056 1057 1058
    @Nonnull
    public Authentication getDefaultAuthentication() {
        // backward compatible behaviour.
        return ACL.SYSTEM;
1059 1060
    }

1061
    /**
1062
     * {@inheritDoc}
1063
     *
1064
     * <p>
1065
     * A project must be blocked if its own previous build is in progress,
1066 1067
     * or if the blockBuildWhenUpstreamBuilding option is true and an upstream
     * project is building, but derived classes can also check other conditions.
1068
     */
1069
    public boolean isBuildBlocked() {
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
        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;
1086 1087
        }

1088
        @Override
1089 1090 1091 1092 1093 1094 1095 1096
        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);
        }
1097
    }
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
    
    /**
     * 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());
        }
    }
1114

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
    /**
     * 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;
        }

1125
        @Override
1126 1127 1128
        public String getShortDescription() {
            return Messages.AbstractProject_UpstreamBuildInProgress(up.getName());
        }
1129 1130
    }

1131
    public CauseOfBlockage getCauseOfBlockage() {
1132 1133
        // Block builds until they are done with post-production
        if (isLogUpdated() && !isConcurrentBuild())
1134
            return new BecauseOfBuildInProgress(getLastBuild());
1135 1136 1137 1138
        if (blockBuildWhenDownstreamBuilding()) {
            AbstractProject<?,?> bup = getBuildingDownstream();
            if (bup!=null)
                return new BecauseOfDownstreamBuildInProgress(bup);
1139 1140
        }
        if (blockBuildWhenUpstreamBuilding()) {
1141 1142 1143 1144 1145 1146
            AbstractProject<?,?> bup = getBuildingUpstream();
            if (bup!=null)
                return new BecauseOfUpstreamBuildInProgress(bup);
        }
        return null;
    }
1147

1148
    /**
1149 1150
     * Returns the project if any of the downstream project is either
     * building, waiting, pending or buildable.
1151 1152 1153 1154
     * <p>
     * This means eventually there will be an automatic triggering of
     * the given project (provided that all builds went smoothly.)
     */
1155
    public AbstractProject getBuildingDownstream() {
1156
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1157

1158
        for (AbstractProject tup : getTransitiveDownstreamProjects()) {
1159
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1160 1161 1162 1163 1164
                return tup;
        }
        return null;
    }

1165
    /**
1166
     * Returns the project if any of the upstream project is either
1167 1168 1169 1170 1171
     * 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.)
     */
1172
    public AbstractProject getBuildingUpstream() {
1173
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1174

1175
        for (AbstractProject tup : getTransitiveUpstreamProjects()) {
1176
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1177 1178 1179
                return tup;
        }
        return null;
1180 1181
    }

1182 1183
    public List<SubTask> getSubTasks() {
        List<SubTask> r = new ArrayList<SubTask>();
1184
        r.add(this);
1185 1186 1187
        for (SubTaskContributor euc : SubTaskContributor.all())
            r.addAll(euc.forProject(this));
        for (JobProperty<? super P> p : properties)
1188
            r.addAll(p.getSubTasks());
1189
        return r;
1190 1191
    }

1192
    public @CheckForNull R createExecutable() throws IOException {
1193
        if(isDisabled())    return null;
1194
        return newBuild();
1195 1196
    }

1197
    public void checkAbortPermission() {
1198
        checkPermission(CANCEL);
1199 1200
    }

K
kohsuke 已提交
1201
    public boolean hasAbortPermission() {
1202
        return hasPermission(CANCEL);
K
kohsuke 已提交
1203 1204
    }

1205 1206
    /**
     * Gets the {@link Resource} that represents the workspace of this project.
1207
     * Useful for locking and mutual exclusion control.
K
kohsuke 已提交
1208
     *
K
kohsuke 已提交
1209
     * @deprecated as of 1.319
K
kohsuke 已提交
1210 1211 1212 1213 1214 1215 1216
     *      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}.
1217 1218
     */
    public Resource getWorkspaceResource() {
1219
        return new Resource(getFullDisplayName()+" workspace");
1220 1221 1222 1223 1224 1225
    }

    /**
     * List of necessary resources to perform the build of this project.
     */
    public ResourceList getResourceList() {
1226
        final Set<ResourceActivity> resourceActivities = getResourceActivities();
1227
        final List<ResourceList> resourceLists = new ArrayList<ResourceList>(1 + resourceActivities.size());
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
        for (ResourceActivity activity : resourceActivities) {
            if (activity != this && activity != null) {
                // defensive infinite recursion and null check
                resourceLists.add(activity.getResourceList());
            }
        }
        return ResourceList.union(resourceLists);
    }

    /**
1238 1239
     * 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.
1240 1241
     */
    protected Set<ResourceActivity> getResourceActivities() {
K
kohsuke 已提交
1242
        return Collections.emptySet();
1243 1244
    }

1245
    public boolean checkout(AbstractBuild build, Launcher launcher, BuildListener listener, File changelogFile) throws IOException, InterruptedException {
1246
        SCM scm = getScm();
1247 1248
        if(scm==null)
            return true;    // no SCM
1249

1250
        FilePath workspace = build.getWorkspace();
1251 1252 1253 1254
        try {
            workspace.mkdirs();
        } catch (IOException e) {
            // Can't create workspace dir - Is slave disk full ?
1255
            new DiskSpaceMonitor().markNodeOfflineIfDiskspaceIsTooLow(build.getBuiltOn().toComputer());
1256 1257
            throw e;
        }
1258 1259
        
        boolean r = scm.checkout(build, launcher, workspace, listener, changelogFile);
C
Christoph Kutzinski 已提交
1260 1261 1262
        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.
1263 1264
            calcPollingBaseline(build, launcher, listener);
        }
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
        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 {
1275
                baseline = getScm().calcRevisionsFromBuild(build, launcher, listener);
1276 1277 1278 1279 1280 1281 1282 1283 1284
            } 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;
    }

1285 1286
    /**
     * Checks if there's any update in SCM, and returns true if any is found.
1287
     *
1288 1289
     * @deprecated as of 1.346
     *      Use {@link #poll(TaskListener)} instead.
1290
     */
1291
    public boolean pollSCMChanges( TaskListener listener ) {
1292 1293 1294 1295 1296 1297 1298
        return poll(listener).hasChanges();
    }

    /**
     * Checks if there's any update in SCM, and returns true if any is found.
     *
     * <p>
1299 1300
     * The implementation is responsible for ensuring mutual exclusion between polling and builds
     * if necessary.
1301 1302 1303 1304
     *
     * @since 1.345
     */
    public PollingResult poll( TaskListener listener ) {
1305
        SCM scm = getScm();
1306
        if (scm==null) {
K
i18n  
kohsuke 已提交
1307
            listener.getLogger().println(Messages.AbstractProject_NoSCM());
1308
            return NO_CHANGES;
1309
        }
1310
        if (!isBuildable()) {
K
i18n  
kohsuke 已提交
1311
            listener.getLogger().println(Messages.AbstractProject_Disabled());
1312 1313 1314 1315 1316
            return NO_CHANGES;
        }

        R lb = getLastBuild();
        if (lb==null) {
1317
            listener.getLogger().println(Messages.AbstractProject_NoBuilds());
1318
            return isInQueue() ? NO_CHANGES : BUILD_NOW;
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
        }

        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.
1334 1335 1336
        }

        try {
K
Kohsuke Kawaguchi 已提交
1337
            SCMPollListener.fireBeforePolling(this, listener);
1338
            PollingResult r = _poll(listener, scm);
K
Kohsuke Kawaguchi 已提交
1339 1340
            SCMPollListener.firePollingSuccess(this,listener, r);
            return r;
1341
        } catch (AbortException e) {
1342
            listener.getLogger().println(e.getMessage());
K
i18n  
kohsuke 已提交
1343
            listener.fatalError(Messages.AbstractProject_Aborted());
1344
            LOGGER.log(Level.FINE, "Polling "+this+" aborted",e);
K
Kohsuke Kawaguchi 已提交
1345
            SCMPollListener.firePollingFailed(this, listener,e);
1346
            return NO_CHANGES;
1347 1348
        } catch (IOException e) {
            e.printStackTrace(listener.fatalError(e.getMessage()));
K
Kohsuke Kawaguchi 已提交
1349
            SCMPollListener.firePollingFailed(this, listener,e);
1350
            return NO_CHANGES;
1351
        } catch (InterruptedException e) {
1352
            e.printStackTrace(listener.fatalError(Messages.AbstractProject_PollingABorted()));
K
Kohsuke Kawaguchi 已提交
1353
            SCMPollListener.firePollingFailed(this, listener,e);
1354
            return NO_CHANGES;
K
Kohsuke Kawaguchi 已提交
1355 1356 1357 1358 1359 1360
        } catch (RuntimeException e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
        } catch (Error e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
1361 1362
        }
    }
K
Kohsuke Kawaguchi 已提交
1363 1364 1365 1366

    /**
     * {@link #poll(TaskListener)} method without the try/catch block that does listener notification and .
     */
1367
    private PollingResult _poll(TaskListener listener, SCM scm) throws IOException, InterruptedException {
K
Kohsuke Kawaguchi 已提交
1368
        if (scm.requiresWorkspaceForPolling()) {
1369 1370 1371 1372
            R b = getSomeBuildWithExistingWorkspace();
            if (b == null) b = getLastBuild();
            // lock the workspace for the given build
            FilePath ws=b.getWorkspace();
K
Kohsuke Kawaguchi 已提交
1373

1374
            WorkspaceOfflineReason workspaceOfflineReason = workspaceOffline( b );
1375
            if ( workspaceOfflineReason != null ) {
1376
                // workspace offline
1377
                for (WorkspaceBrowser browser : ExtensionList.lookup(WorkspaceBrowser.class)) {
1378 1379
                    ws = browser.getWorkspace(this);
                    if (ws != null) {
1380
                        return pollWithWorkspace(listener, scm, b, ws, browser.getWorkspaceList());
1381 1382 1383
                    }
                }

K
Kohsuke Kawaguchi 已提交
1384 1385 1386 1387 1388 1389
                // At this point we start thinking about triggering a build just to get a workspace,
                // because otherwise there's no way we can detect changes.
                // However, first there are some conditions in which we do not want to do so.
                // give time for slaves to come online if we are right after reconnection (JENKINS-8408)
                long running = Jenkins.getInstance().getInjector().getInstance(Uptime.class).getUptime();
                long remaining = TimeUnit2.MINUTES.toMillis(10)-running;
1390
                if (remaining>0 && /* this logic breaks tests of polling */!Functions.getIsUnitTest()) {
K
Kohsuke Kawaguchi 已提交
1391 1392 1393 1394 1395
                    listener.getLogger().print(Messages.AbstractProject_AwaitingWorkspaceToComeOnline(remaining/1000));
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
                    return NO_CHANGES;
                }

1396 1397 1398 1399 1400 1401 1402 1403
                // Do not trigger build, if no suitable slave is online
                if (workspaceOfflineReason.equals(WorkspaceOfflineReason.all_suitable_nodes_are_offline)) {
                    // No suitable executor is online
                    listener.getLogger().print(Messages.AbstractProject_AwaitingWorkspaceToComeOnline(running/1000));
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
                    return NO_CHANGES;
                }

K
Kohsuke Kawaguchi 已提交
1404 1405 1406 1407
                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.
1408 1409
                    listener.getLogger().print(Messages.AbstractProject_NoWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1410 1411
                    return NO_CHANGES;
                }
K
Kohsuke Kawaguchi 已提交
1412

K
Kohsuke Kawaguchi 已提交
1413 1414 1415 1416 1417 1418 1419
                listener.getLogger().println( ws==null
                    ? Messages.AbstractProject_WorkspaceOffline()
                    : Messages.AbstractProject_NoWorkspace());
                if (isInQueue()) {
                    listener.getLogger().println(Messages.AbstractProject_AwaitingBuildForWorkspace());
                    return NO_CHANGES;
                }
K
Kohsuke Kawaguchi 已提交
1420 1421 1422 1423 1424

                // build now, or nothing will ever be built
                listener.getLogger().print(Messages.AbstractProject_NewBuildForWorkspace());
                listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
                return BUILD_NOW;
K
Kohsuke Kawaguchi 已提交
1425
            } else {
1426 1427
                WorkspaceList l = b.getBuiltOn().toComputer().getWorkspaceList();
                return pollWithWorkspace(listener, scm, b, ws, l);
K
Kohsuke Kawaguchi 已提交
1428
            }
J
Jens Brejner 已提交
1429
			
K
Kohsuke Kawaguchi 已提交
1430 1431 1432 1433
        } else {
            // polling without workspace
            LOGGER.fine("Polling SCM changes of " + getName());
            if (pollingBaseline==null) // see NOTE-NO-BASELINE above
1434
                calcPollingBaseline(getLastBuild(),null,listener);
K
Kohsuke Kawaguchi 已提交
1435 1436 1437 1438 1439 1440
            PollingResult r = scm.poll(this, null, null, listener, pollingBaseline);
            pollingBaseline = r.remote;
            return r;
        }
    }

1441
    private PollingResult pollWithWorkspace(TaskListener listener, SCM scm, R lb, @Nonnull FilePath ws, WorkspaceList l) throws InterruptedException, IOException {
1442 1443 1444 1445 1446 1447 1448
        // 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);
1449 1450
        Node node = lb.getBuiltOn();
        Launcher launcher = ws.createLauncher(listener).decorateByEnv(getEnvironment(node,listener));
1451
        try {
1452
            listener.getLogger().println("Polling SCM changes on " + node.getSelfLabel().getName());
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
            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();
        }
    }

1464 1465 1466
    enum WorkspaceOfflineReason {
        nonexisting_workspace,
        builton_node_gone,
1467
        builton_node_no_executors,
1468 1469
        all_suitable_nodes_are_offline,
        use_ondemand_slave
1470 1471 1472 1473 1474 1475 1476
    }

    /**
     * Returns true if all suitable nodes for the job are offline.
     *
     */
    private boolean isAllSuitableNodesOffline(R build) {
1477
        Label label = getAssignedLabel();        
1478 1479 1480
        List<Node> allNodes = Jenkins.getInstance().getNodes();

        if (label != null) {
1481 1482 1483 1484 1485
            //Invalid label. Put in queue to make administrator fix
            if(label.getNodes().isEmpty()) {
                return false;
            }
            //Returns true, if all suitable nodes are offline
1486
            return label.isOffline();
1487
        } else {
M
Mads Nielsen 已提交
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
            if(canRoam) {                 
                for (Node n : Jenkins.getInstance().getNodes()) {                
                    Computer c = n.toComputer();
                    if (c != null && c.isOnline() && c.isAcceptingTasks() && n.getMode() == Mode.NORMAL) {
                        // Some executor is online that  is ready and this job can run anywhere
                        return false;
                    }
                }                
                //We can roam, check that the master is set to be used as much as possible, and not tied jobs only.
                if(Jenkins.getInstance().getMode() == Mode.EXCLUSIVE) {
                    return true;
                } else {
1500
                    return false;
1501 1502 1503 1504
                }
            }
        }
        return true;
1505 1506 1507
    }

    private WorkspaceOfflineReason workspaceOffline(R build) throws IOException, InterruptedException {
1508
        FilePath ws = build.getWorkspace();
1509 1510
        Label label = getAssignedLabel();

1511 1512 1513
        if (isAllSuitableNodesOffline(build)) {            
            Collection<Cloud> applicableClouds = label == null ? Jenkins.getInstance().clouds : label.getClouds();
            return applicableClouds.isEmpty() ? WorkspaceOfflineReason.all_suitable_nodes_are_offline : WorkspaceOfflineReason.use_ondemand_slave;            
1514 1515
        }

1516
        if (ws==null || !ws.exists()) {
1517
            return WorkspaceOfflineReason.nonexisting_workspace;
1518 1519 1520 1521
        }
        
        Node builtOn = build.getBuiltOn();
        if (builtOn == null) { // node built-on doesn't exist anymore
1522
            return WorkspaceOfflineReason.builton_node_gone;
1523 1524 1525
        }
        
        if (builtOn.toComputer() == null) { // node still exists, but has 0 executors - o.s.l.t.
1526
            return WorkspaceOfflineReason.builton_node_no_executors;
1527
        }
1528 1529

        return null;
1530
    }
1531

1532 1533
    /**
     * Returns true if this user has made a commit to this project.
1534
     *
1535 1536 1537
     * @since 1.191
     */
    public boolean hasParticipant(User user) {
1538 1539
        for( R build = getLastBuild(); build!=null; build=build.getPreviousBuild())
            if(build.hasParticipant(user))
1540 1541 1542 1543
                return true;
        return false;
    }

1544
    @Exported
1545 1546 1547 1548
    public SCM getScm() {
        return scm;
    }

1549
    public void setScm(SCM scm) throws IOException {
1550
        this.scm = scm;
1551
        save();
1552 1553
    }

1554 1555 1556
    /**
     * Adds a new {@link Trigger} to this {@link Project} if not active yet.
     */
1557
    public void addTrigger(Trigger<?> trigger) throws IOException {
1558
        addToList(trigger,triggers());
1559 1560
    }

1561
    public void removeTrigger(TriggerDescriptor trigger) throws IOException {
1562
        removeFromList(trigger,triggers());
1563 1564
    }

1565 1566
    protected final synchronized <T extends Describable<T>>
    void addToList( T item, List<T> collection ) throws IOException {
1567 1568
        //No support to replace item in position, remove then add
        removeFromList(item.getDescriptor(), collection);
1569 1570
        collection.add(item);
        save();
1571
        updateTransientActions();
1572 1573
    }

1574 1575
    protected final synchronized <T extends Describable<T>>
    void removeFromList(Descriptor<T> item, List<T> collection) throws IOException {
1576 1577 1578 1579
        final Iterator<T> iCollection = collection.iterator();
        while(iCollection.hasNext()) {
            final T next = iCollection.next();
            if(next.getDescriptor()==item) {
1580
                // found it
1581
                iCollection.remove();
1582
                save();
1583
                updateTransientActions();
1584 1585 1586 1587 1588
                return;
            }
        }
    }

C
Christoph Kutzinski 已提交
1589
    @SuppressWarnings("unchecked")
1590
    @Override public Map<TriggerDescriptor,Trigger<?>> getTriggers() {
K
Kohsuke Kawaguchi 已提交
1591
        return triggers().toMap();
1592 1593
    }

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

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

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

K
kohsuke 已提交
1624
    @Exported
1625
    public final List<AbstractProject> getUpstreamProjects() {
1626
        return Jenkins.getInstance().getDependencyGraph().getUpstream(this);
K
kohsuke 已提交
1627 1628
    }

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

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

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

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

        return r;
    }

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

            int n = build.getNumber();

            RangeSet value = r.get(n);
1695 1696
            if(value==null)
                r.put(n,rs);
1697 1698 1699 1700 1701
            else
                value.add(rs);
        }
    }

1702 1703
    /**
     * Builds the dependency graph.
1704
     * Since 1.558, not abstract and by default includes dependencies contributed by {@link #triggers()}.
1705
     */
1706 1707 1708
    protected void buildDependencyGraph(DependencyGraph graph) {
        triggers().buildDependencyGraph(this, graph);
    }
1709

1710
    @Override
K
kohsuke 已提交
1711
    protected SearchIndexBuilder makeSearchIndex() {
1712
        return getParameterizedJobMixIn().extendSearchIndex(super.makeSearchIndex());
K
kohsuke 已提交
1713 1714
    }

1715 1716
    @Override
    protected HistoryWidget createHistoryWidget() {
J
Jesse Glick 已提交
1717
        return buildMixIn.createHistoryWidget();
1718
    }
1719
    
K
kohsuke 已提交
1720
    public boolean isParameterized() {
1721
        return getParameterizedJobMixIn().isParameterized();
K
kohsuke 已提交
1722
    }
1723

1724 1725 1726 1727 1728
//
//
// actions
//
//
1729 1730 1731
    /**
     * Schedules a new build command.
     */
1732
    public void doBuild( StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay ) throws IOException, ServletException {
1733
        getParameterizedJobMixIn().doBuild(req, rsp, delay);
1734 1735
    }

1736 1737 1738 1739 1740 1741
    /** @deprecated use {@link #doBuild(StaplerRequest, StaplerResponse, TimeDuration)} */
    @Deprecated
    public void doBuild(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        doBuild(req, rsp, TimeDuration.fromString(req.getParameter("delay")));
    }

1742 1743
    /**
     * Computes the delay by taking the default value and the override in the request parameter into the account.
1744
     *
1745
     * @deprecated as of 1.489
1746
     *      Inject {@link TimeDuration}.
1747 1748
     */
    public int getDelay(StaplerRequest req) throws ServletException {
1749
        String delay = req.getParameter("delay");
1750 1751 1752 1753 1754 1755 1756 1757 1758
        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);
1759
        }
1760
    }
1761

1762 1763 1764 1765
    /**
     * Supports build trigger with parameters via an HTTP GET or POST.
     * Currently only String parameters are supported.
     */
1766
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException {
1767
        getParameterizedJobMixIn().doBuildWithParameters(req, rsp, delay);
1768
    }
1769

1770 1771 1772 1773 1774 1775
    /** @deprecated use {@link #doBuildWithParameters(StaplerRequest, StaplerResponse, TimeDuration)} */
    @Deprecated
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        doBuildWithParameters(req, rsp, TimeDuration.fromString(req.getParameter("delay")));
    }

1776 1777 1778
    /**
     * Schedules a new SCM polling command.
     */
1779
    public void doPolling( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1780
        BuildAuthorizationToken.checkPermission((Job) this, authToken, req, rsp);
1781
        schedulePolling();
J
Jesse Glick 已提交
1782
        rsp.sendRedirect(".");
1783 1784 1785 1786 1787
    }

    /**
     * Cancels a scheduled build.
     */
J
Jesse Glick 已提交
1788
    @RequirePOST
1789
    public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1790
        getParameterizedJobMixIn().doCancelQueue(req, rsp);
1791 1792
    }

1793
    @Override
1794 1795
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
        super.submit(req,rsp);
1796
        JSONObject json = req.getSubmittedForm();
1797

1798
        makeDisabled(json.optBoolean("disable"));
1799

1800 1801
        jdk = json.optString("jdk", null);

1802 1803
        if(json.optBoolean("hasCustomQuietPeriod", json.has("quiet_period"))) {
            quietPeriod = json.optInt("quiet_period");
1804 1805 1806
        } else {
            quietPeriod = null;
        }
1807

1808 1809
        if(json.optBoolean("hasCustomScmCheckoutRetryCount", json.has("scmCheckoutRetryCount"))) {
            scmCheckoutRetryCount = json.optInt("scmCheckoutRetryCount");
S
 
shinodkm 已提交
1810
        } else {
1811
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1812
        }
1813

1814 1815
        blockBuildWhenDownstreamBuilding = json.optBoolean("blockBuildWhenDownstreamBuilding");
        blockBuildWhenUpstreamBuilding = json.optBoolean("blockBuildWhenUpstreamBuilding");
1816

1817 1818
        if(req.hasParameter("customWorkspace.directory")) {
            // Workaround for JENKINS-25221 while plugins are being updated.
1819
            LOGGER.log(Level.WARNING, "label assignment is using legacy 'customWorkspace.directory'");
1820 1821
            customWorkspace = Util.fixEmptyAndTrim(req.getParameter("customWorkspace.directory"));
        } else if(json.optBoolean("hasCustomWorkspace", json.has("customWorkspace"))) {
1822
            customWorkspace = Util.fixEmptyAndTrim(json.optString("customWorkspace"));
1823 1824 1825
        } else {
            customWorkspace = null;
        }
1826 1827 1828 1829 1830 1831 1832

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

1833 1834 1835 1836 1837
        if(req.hasParameter("_.assignedLabelString")) {
            // Workaround for JENKINS-25372 while plugin is being updated.
            LOGGER.log(Level.WARNING, "label assignment is using legacy '_.assignedLabelString'");
            assignedNode = Util.fixEmptyAndTrim(req.getParameter("_.assignedLabelString"));
        } else if(json.optBoolean("hasSlaveAffinity", json.has("label"))) {
1838
            assignedNode = Util.fixEmptyAndTrim(json.optString("label"));
1839 1840 1841
        } else {
            assignedNode = null;
        }
1842
        canRoam = assignedNode==null;
1843

1844
        keepDependencies = json.has("keepDependencies");
1845

1846
        concurrentBuild = json.optBoolean("concurrentBuild");
K
kohsuke 已提交
1847

1848
        authToken = BuildAuthorizationToken.create(req);
1849

K
kohsuke 已提交
1850
        setScm(SCMS.parseSCM(req,this));
1851

1852
        for (Trigger t : triggers())
1853
            t.stop();
K
Kohsuke Kawaguchi 已提交
1854 1855
        triggers.replaceBy(buildDescribable(req, Trigger.for_(this)));
        for (Trigger t : triggers())
1856
            t.start(this,true);
1857 1858
    }

K
kohsuke 已提交
1859 1860 1861 1862 1863 1864 1865 1866 1867
    /**
     * @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)
1868
        throws FormException, ServletException {
1869

1870
        JSONObject data = req.getSubmittedForm();
1871
        List<T> r = new Vector<T>();
1872
        for (Descriptor<T> d : descriptors) {
1873 1874 1875
            String safeName = d.getJsonSafeClassName();
            if (req.getParameter(safeName) != null) {
                T instance = d.newInstance(req, data.getJSONObject(safeName));
1876
                r.add(instance);
1877 1878
            }
        }
1879
        return r;
1880 1881 1882 1883 1884
    }

    /**
     * Serves the workspace files.
     */
1885
    public DirectoryBrowserSupport doWs( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, InterruptedException {
1886
        checkPermission(Item.WORKSPACE);
K
kohsuke 已提交
1887
        FilePath ws = getSomeWorkspace();
1888
        if ((ws == null) || (!ws.exists())) {
1889
            // if there's no workspace, report a nice error message
1890 1891 1892 1893
            // 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.
1894
            req.getView(this,"noWorkspace.jelly").forward(req,rsp);
1895
            return null;
1896
        } else {
1897 1898 1899 1900 1901 1902 1903 1904
            Computer c = ws.toComputer();
            String title;
            if (c == null) {
                title = Messages.AbstractProject_WorkspaceTitle(getDisplayName());
            } else {
                title = Messages.AbstractProject_WorkspaceTitleOnComputer(getDisplayName(), c.getDisplayName());
            }
            return new DirectoryBrowserSupport(this, ws, title, "folder.png", true);
1905 1906
        }
    }
1907

1908 1909 1910
    /**
     * Wipes out the workspace.
     */
1911
    public HttpResponse doDoWipeOutWorkspace() throws IOException, ServletException, InterruptedException {
1912
        checkPermission(Functions.isWipeOutPermissionEnabled() ? WIPEOUT : BUILD);
1913 1914 1915 1916
        R b = getSomeBuildWithWorkspace();
        FilePath ws = b!=null ? b.getWorkspace() : null;
        if (ws!=null && getScm().processWorkspaceBeforeDeletion(this, ws, b.getBuiltOn())) {
            ws.deleteRecursive();
1917 1918 1919
            for (WorkspaceListener wl : WorkspaceListener.all()) {
                wl.afterDelete(this);
            }
1920 1921 1922 1923
            return new HttpRedirect(".");
        } else {
            // If we get here, that means the SCM blocked the workspace deletion.
            return new ForwardToView(this,"wipeOutWorkspaceBlocked.jelly");
1924
        }
1925 1926
    }

1927
    @CLIMethod(name="disable-job")
1928
    @RequirePOST
1929
    public HttpResponse doDisable() throws IOException, ServletException {
1930 1931
        checkPermission(CONFIGURE);
        makeDisabled(true);
1932
        return new HttpRedirect(".");
1933 1934
    }

1935
    @CLIMethod(name="enable-job")
1936
    @RequirePOST
1937
    public HttpResponse doEnable() throws IOException, ServletException {
1938 1939
        checkPermission(CONFIGURE);
        makeDisabled(false);
1940
        return new HttpRedirect(".");
1941
    }
1942
    
1943

K
kohsuke 已提交
1944 1945 1946
    /**
     * RSS feed for changes in this project.
     */
1947
    public void doRssChangelog(  StaplerRequest req, StaplerResponse rsp  ) throws IOException, ServletException {
K
kohsuke 已提交
1948 1949 1950 1951 1952 1953 1954 1955 1956
        class FeedItem {
            ChangeLogSet.Entry e;
            int idx;

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

1957
            AbstractBuild<?,?> getBuild() {
1958
                return e.getParent().build;
K
kohsuke 已提交
1959 1960 1961 1962 1963
            }
        }

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

1964 1965 1966 1967
        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 已提交
1968 1969
        }

1970 1971 1972 1973 1974 1975 1976
        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 已提交
1977

1978 1979 1980
                public String getEntryUrl(FeedItem item) {
                    return item.getBuild().getUrl()+"changes#detail"+item.idx;
                }
K
kohsuke 已提交
1981

1982 1983 1984
                public String getEntryID(FeedItem item) {
                    return getEntryUrl(item);
                }
K
kohsuke 已提交
1985

1986 1987 1988 1989 1990 1991
                public String getEntryDescription(FeedItem item) {
                    StringBuilder buf = new StringBuilder();
                    for(String path : item.e.getAffectedPaths())
                        buf.append(path).append('\n');
                    return buf.toString();
                }
1992

1993 1994 1995
                public Calendar getEntryTimestamp(FeedItem item) {
                    return item.getBuild().getTimestamp();
                }
1996

1997
                public String getEntryAuthor(FeedItem entry) {
1998
                    return JenkinsLocationConfiguration.get().getAdminAddress();
1999 2000 2001
                }
            },
            req, rsp );
K
kohsuke 已提交
2002 2003
    }

2004 2005 2006 2007 2008 2009 2010
    /**
     * {@link AbstractProject} subtypes should implement this base class as a descriptor.
     *
     * @since 1.294
     */
    public static abstract class AbstractProjectDescriptor extends TopLevelItemDescriptor {
        /**
2011
         * {@link AbstractProject} subtypes can override this method to veto some {@link Descriptor}s
2012
         * from showing up on their configuration screen. This is often useful when you are building
2013 2014
         * a workflow/company specific project type, where you want to limit the number of choices
         * given to the users.
2015 2016
         *
         * <p>
2017 2018 2019 2020
         * 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}
2021 2022 2023 2024
         * to show up for the given {@link Project}.
         *
         * <p>
         * The default implementation returns true for everything.
2025 2026
         *
         * @see BuildStepDescriptor#isApplicable(Class) 
K
kohsuke 已提交
2027 2028
         * @see BuildWrapperDescriptor#isApplicable(AbstractProject) 
         * @see TriggerDescriptor#isApplicable(Item)
2029
         */
K
kohsuke 已提交
2030
        @Override
2031
        public boolean isApplicable(Descriptor descriptor) {
2032 2033
            return true;
        }
2034

2035
        @Restricted(DoNotUse.class)
2036 2037 2038 2039 2040 2041 2042 2043
        public FormValidation doCheckAssignedLabelString(@AncestorInPath AbstractProject<?,?> project,
                                                         @QueryParameter String value) {
          // Provide a legacy interface in case plugins are not going through p:config-assignedLabel
          // see: JENKINS-25372
          LOGGER.log(Level.WARNING, "checking label via legacy '_.assignedLabelString'");
          return doCheckLabel(project, value);
        }

2044 2045
        public FormValidation doCheckLabel(@AncestorInPath AbstractProject<?,?> project,
                                           @QueryParameter String value) {
2046 2047 2048 2049 2050 2051 2052
            return validateLabelExpression(value, project);
        }

        /**
         * Validate label expression string.
         *
         * @param project May be specified to perform project specific validation.
2053
         * @since 1.590
2054 2055
         */
        public static @Nonnull FormValidation validateLabelExpression(String value, @CheckForNull AbstractProject<?, ?> project) {
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
            Jenkins j = Jenkins.getInstance();
2065 2066 2067
            if (j == null) {
                return FormValidation.ok(); // ?
            }
2068
            Label l = j.getLabel(value);
2069 2070 2071 2072 2073 2074 2075
            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 已提交
2076
                return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch());
2077
            }
S
Javadoc  
Stephen Connolly 已提交
2078
            if (project != null) {
2079
                for (AbstractProject.LabelValidator v : j
S
Javadoc  
Stephen Connolly 已提交
2080 2081 2082 2083 2084
                        .getExtensionList(AbstractProject.LabelValidator.class)) {
                    FormValidation result = v.check(project, l);
                    if (!FormValidation.Kind.OK.equals(result.kind)) {
                        return result;
                    }
2085 2086
                }
            }
2087 2088 2089
            return FormValidation.okWithMarkup(Messages.AbstractProject_LabelLink(
                    j.getRootUrl(), l.getUrl(), l.getNodes().size() + l.getClouds().size()
            ));
2090
        }
2091

2092
        public FormValidation doCheckCustomWorkspace(@QueryParameter String customWorkspace){
2093
        	if(Util.fixEmptyAndTrim(customWorkspace)==null)
S
Seiji Sogabe 已提交
2094
        		return FormValidation.error(Messages.AbstractProject_CustomWorkspaceEmpty());
2095 2096 2097 2098
        	else
        		return FormValidation.ok();
        }
        
2099 2100
        public AutoCompletionCandidates doAutoCompleteUpstreamProjects(@QueryParameter String value) {
            AutoCompletionCandidates candidates = new AutoCompletionCandidates();
2101
            List<Job> jobs = Jenkins.getInstance().getItems(Job.class);
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
            for (Job job: jobs) {
                if (job.getFullName().startsWith(value)) {
                    if (job.hasPermission(Item.READ)) {
                        candidates.add(job.getFullName());
                    }
                }
            }
            return candidates;
        }

2112
        @Restricted(DoNotUse.class)
2113 2114 2115 2116 2117 2118 2119
        public AutoCompletionCandidates doAutoCompleteAssignedLabelString(@QueryParameter String value) {
          // Provide a legacy interface in case plugins are not going through p:config-assignedLabel
          // see: JENKINS-25372
          LOGGER.log(Level.WARNING, "autocompleting label via legacy '_.assignedLabelString'");
          return doAutoCompleteLabel(value);
        }

2120
        public AutoCompletionCandidates doAutoCompleteLabel(@QueryParameter String value) {
2121
            AutoCompletionCandidates c = new AutoCompletionCandidates();
2122
            Set<Label> labels = Jenkins.getInstance().getLabels();
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
            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;
        }

2135
        public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p) {
2136 2137 2138
            return SCMCheckoutStrategyDescriptor._for(p);
        }

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
        /**
        * 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 已提交
2151
                ArrayList<String> terms = new ArrayList<String>();
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
                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;
            }
        }
2179 2180
    }

2181
    /**
2182
     * Finds a {@link AbstractProject} that has the name closest to the given name.
2183
     * @see Items#findNearest
2184
     */
2185
    public static @CheckForNull AbstractProject findNearest(String name) {
J
Jesse Glick 已提交
2186
        return findNearest(name,Jenkins.getInstance());
2187 2188 2189 2190 2191 2192
    }

    /**
     * Finds a {@link AbstractProject} whose name (when referenced from the specified context) is closest to the given name.
     *
     * @since 1.419
2193
     * @see Items#findNearest
2194
     */
2195
    public static @CheckForNull AbstractProject findNearest(String name, ItemGroup context) {
2196
        return Items.findNearest(AbstractProject.class, name, context);
2197
    }
2198 2199 2200

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
2201
            return o2-o1;
2202 2203
        }
    };
2204

2205
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
2206

2207
    /**
2208
     * @deprecated Just use {@link #CANCEL}.
2209
     */
2210
    public static final Permission ABORT = CANCEL;
2211

K
Kohsuke Kawaguchi 已提交
2212 2213 2214
    /**
     * Replaceable "Build Now" text.
     */
2215 2216
    public static final Message<AbstractProject> BUILD_NOW_TEXT = new Message<AbstractProject>();

2217 2218 2219 2220 2221 2222
    /**
     * Used for CLI binding.
     */
    @CLIResolver
    public static AbstractProject resolveForCLI(
            @Argument(required=true,metaVar="NAME",usage="Job name") String name) throws CmdLineException {
2223
        AbstractProject item = Jenkins.getInstance().getItemByFullName(name, AbstractProject.class);
2224 2225 2226 2227
        if (item==null)
            throw new CmdLineException(null,Messages.AbstractItem_NoSuchJobExists(name,AbstractProject.findNearest(name).getFullName()));
        return item;
    }
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246

    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. 
     *
2247
     * @since 1.410
2248 2249
     */
    public void setCustomWorkspace(String customWorkspace) throws IOException {
2250
        this.customWorkspace= Util.fixEmptyAndTrim(customWorkspace);
2251 2252
        save();
    }
2253 2254 2255

    /**
     * Plugins may want to contribute additional restrictions on the use of specific labels for specific projects.
S
Javadoc  
Stephen Connolly 已提交
2256 2257 2258
     * This extension point allows such restrictions.
     *
     * @since 1.540
2259 2260
     */
    public static abstract class LabelValidator implements ExtensionPoint {
S
Javadoc  
Stephen Connolly 已提交
2261 2262 2263 2264 2265 2266 2267 2268 2269
        /**
         * Check the use of the label within the specified context.
         *
         * @param project the project that wants to restrict itself to the specified label.
         * @param label   the label that the project wants to restrict itself to.
         * @return the {@link FormValidation} result.
         */
        @Nonnull
        public abstract FormValidation check(@Nonnull AbstractProject<?, ?> project, @Nonnull Label label);
2270
    }
S
Javadoc  
Stephen Connolly 已提交
2271

2272
}