AbstractProject.java 79.5 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 122
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
123 124
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
125
import org.kohsuke.stapler.AncestorInPath;
126 127 128 129
import org.kohsuke.stapler.ForwardToView;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
K
kohsuke 已提交
130 131 132
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
133
import org.kohsuke.stapler.interceptor.RequirePOST;
134 135 136

/**
 * Base implementation of {@link Job}s that build software.
137
 *
138
 * For now this is primarily the common part of {@link Project} and MavenModule.
139
 *
140 141 142
 * @author Kohsuke Kawaguchi
 * @see AbstractBuild
 */
C
Christoph Kutzinski 已提交
143
@SuppressWarnings("rawtypes")
144
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 {
145

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

K
kohsuke 已提交
254 255
    private boolean concurrentBuild;

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

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

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

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

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

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

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

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

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

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

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

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

        return env;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

691 692 693 694
    /**
     * Marks the build as disabled.
     */
    public void makeDisabled(boolean b) throws IOException {
695
        if(disabled==b)     return; // noop
696
        this.disabled = b;
K
bug fix  
kohsuke 已提交
697
        if(b)
698
            Jenkins.getInstance().getQueue().cancel(this);
R
rednuht 已提交
699
        
700
        save();
R
rednuht 已提交
701
        ItemListener.fireOnUpdated(this);
702 703
    }

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

715 716 717 718 719 720 721 722
    public void disable() throws IOException {
        makeDisabled(true);
    }

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

K
kohsuke 已提交
723 724
    @Override
    public BallColor getIconColor() {
725
        if(isDisabled())
726
            return isBuilding() ? BallColor.DISABLED_ANIME : BallColor.DISABLED;
K
kohsuke 已提交
727 728 729
        else
            return super.getIconColor();
    }
730

731 732 733 734 735 736 737
    /**
     * effectively deprecated. Since using updateTransientActions correctly
     * under concurrent environment requires a lock that can too easily cause deadlocks.
     *
     * <p>
     * Override {@link #createTransientActions()} instead.
     */
738
    protected void updateTransientActions() {
739 740 741 742
        transientActions = createTransientActions();
    }

    protected List<Action> createTransientActions() {
743
        Vector<Action> ta = new Vector<Action>();
744

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

748 749
        for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all())
            ta.addAll(Util.fixNull(tpaf.createFor(this))); // be defensive against null
750
        return ta;
751 752
    }

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

K
kohsuke 已提交
762 763 764 765 766 767
    @Override
    public void addProperty(JobProperty<? super P> jobProp) throws IOException {
        super.addProperty(jobProp);
        updateTransientActions();
    }

768
    public List<ProminentProjectAction> getProminentActions() {
769
        return getActions(ProminentProjectAction.class);
770 771
    }

772
    @Override
773
    public void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, FormException {
774
        super.doConfigSubmit(req,rsp);
775

776 777
        updateTransientActions();

778
        // notify the queue as the project might be now tied to different node
779
        Jenkins.getInstance().getQueue().scheduleMaintenance();
780 781

        // this is to reflect the upstream build adjustments done above
782
        Jenkins.getInstance().rebuildDependencyGraphAsync();
783 784
    }

785
    /**
M
mdonohue 已提交
786 787 788 789
	 * @deprecated
	 *    Use {@link #scheduleBuild(Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild() {
790
    	return getParameterizedJobMixIn().scheduleBuild();
M
mdonohue 已提交
791 792 793 794 795 796 797
    }
    
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(int, Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild(int quietPeriod) {
798
    	return getParameterizedJobMixIn().scheduleBuild(quietPeriod);
M
mdonohue 已提交
799 800
    }
    
801 802
    /**
     * Schedules a build of this project.
803 804
     *
     * @return
K
Kohsuke Kawaguchi 已提交
805 806
     *      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.)
807
     */
M
mdonohue 已提交
808
    public boolean scheduleBuild(Cause c) {
809
        return getParameterizedJobMixIn().scheduleBuild(c);
K
kohsuke 已提交
810 811
    }

M
mdonohue 已提交
812
    public boolean scheduleBuild(int quietPeriod, Cause c) {
813
        return getParameterizedJobMixIn().scheduleBuild(quietPeriod, c);
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
    }

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

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

885 886 887 888
    /**
     * Schedules a polling of this project.
     */
    public boolean schedulePolling() {
889
        if(isDisabled())    return false;
890
        SCMTrigger scmt = getTrigger(SCMTrigger.class);
891
        if(scmt==null)      return false;
892 893 894 895
        scmt.run();
        return true;
    }

896 897 898 899 900
    /**
     * Returns true if the build is in the queue.
     */
    @Override
    public boolean isInQueue() {
901
        return Jenkins.getInstance().getQueue().contains(this);
902 903
    }

K
kohsuke 已提交
904 905
    @Override
    public Queue.Item getQueueItem() {
906
        return Jenkins.getInstance().getQueue().getItem(this);
K
kohsuke 已提交
907 908
    }

K
kohsuke 已提交
909 910 911
    /**
     * Gets the JDK that this project is configured with, or null.
     */
912
    public JDK getJDK() {
913
        return Jenkins.getInstance().getJDK(jdk);
914 915 916 917 918
    }

    /**
     * Overwrites the JDK setting.
     */
K
kohsuke 已提交
919
    public void setJDK(JDK jdk) throws IOException {
920 921 922 923
        this.jdk = jdk.getName();
        save();
    }

924 925
    public BuildAuthorizationToken getAuthToken() {
        return authToken;
926 927
    }

928
    @Override
929
    public RunMap<R> _getRuns() {
J
Jesse Glick 已提交
930
        return buildMixIn._getRuns();
931 932
    }

933
    @Override
934
    public void removeRun(R run) {
J
Jesse Glick 已提交
935
        buildMixIn.removeRun(run);
936 937
    }

938 939 940 941 942 943 944
    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuild(String id) {
J
Jesse Glick 已提交
945
        return buildMixIn.getBuild(id);
946 947 948 949 950 951 952 953 954
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuildByNumber(int n) {
J
Jesse Glick 已提交
955
        return buildMixIn.getBuildByNumber(n);
956 957 958 959 960 961 962 963 964
    }

    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getFirstBuild() {
J
Jesse Glick 已提交
965
        return buildMixIn.getFirstBuild();
966 967 968
    }

    @Override
969
    public @CheckForNull R getLastBuild() {
J
Jesse Glick 已提交
970
        return buildMixIn.getLastBuild();
971 972 973 974
    }

    @Override
    public R getNearestBuild(int n) {
J
Jesse Glick 已提交
975
        return buildMixIn.getNearestBuild(n);
976 977 978 979
    }

    @Override
    public R getNearestOldBuild(int n) {
J
Jesse Glick 已提交
980
        return buildMixIn.getNearestOldBuild(n);
981 982
    }

983
    /**
J
Jesse Glick 已提交
984 985 986 987
     * 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}.
988 989 990
     */
    protected abstract Class<R> getBuildClass();

991 992 993
    /**
     * Creates a new build of this project for immediate execution.
     */
H
huybrechts 已提交
994
    protected synchronized R newBuild() throws IOException {
J
Jesse Glick 已提交
995
        return buildMixIn.newBuild();
996 997
    }

998 999 1000
    /**
     * Loads an existing build record from disk.
     */
1001
    protected R loadBuild(File dir) throws IOException {
J
Jesse Glick 已提交
1002
        return buildMixIn.loadBuild(dir);
1003
    }
1004

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

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

1041 1042 1043 1044
    public Object getSameNodeConstraint() {
        return this; // in this way, any member that wants to run with the main guy can nominate the project itself 
    }

1045 1046 1047 1048
    public final Task getOwnerTask() {
        return this;
    }

1049 1050 1051 1052
    @Nonnull
    public Authentication getDefaultAuthentication() {
        // backward compatible behaviour.
        return ACL.SYSTEM;
1053 1054
    }

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

1082
        @Override
1083 1084 1085 1086 1087 1088 1089 1090
        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);
        }
1091
    }
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    
    /**
     * 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());
        }
    }
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
    /**
     * 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;
        }

1119
        @Override
1120 1121 1122
        public String getShortDescription() {
            return Messages.AbstractProject_UpstreamBuildInProgress(up.getName());
        }
1123 1124
    }

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

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

1152
        for (AbstractProject tup : getTransitiveDownstreamProjects()) {
1153
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1154 1155 1156 1157 1158
                return tup;
        }
        return null;
    }

1159
    /**
1160
     * Returns the project if any of the upstream project is either
1161 1162 1163 1164 1165
     * 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.)
     */
1166
    public AbstractProject getBuildingUpstream() {
1167
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1168

1169
        for (AbstractProject tup : getTransitiveUpstreamProjects()) {
1170
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1171 1172 1173
                return tup;
        }
        return null;
1174 1175
    }

1176 1177
    public List<SubTask> getSubTasks() {
        List<SubTask> r = new ArrayList<SubTask>();
1178
        r.add(this);
1179 1180 1181
        for (SubTaskContributor euc : SubTaskContributor.all())
            r.addAll(euc.forProject(this));
        for (JobProperty<? super P> p : properties)
1182
            r.addAll(p.getSubTasks());
1183
        return r;
1184 1185
    }

1186
    public @CheckForNull R createExecutable() throws IOException {
1187
        if(isDisabled())    return null;
1188
        return newBuild();
1189 1190
    }

1191
    public void checkAbortPermission() {
1192
        checkPermission(CANCEL);
1193 1194
    }

K
kohsuke 已提交
1195
    public boolean hasAbortPermission() {
1196
        return hasPermission(CANCEL);
K
kohsuke 已提交
1197 1198
    }

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

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

    /**
1232 1233
     * 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.
1234 1235
     */
    protected Set<ResourceActivity> getResourceActivities() {
K
kohsuke 已提交
1236
        return Collections.emptySet();
1237 1238
    }

1239
    public boolean checkout(AbstractBuild build, Launcher launcher, BuildListener listener, File changelogFile) throws IOException, InterruptedException {
1240
        SCM scm = getScm();
1241 1242
        if(scm==null)
            return true;    // no SCM
1243

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

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

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

        R lb = getLastBuild();
        if (lb==null) {
1311
            listener.getLogger().println(Messages.AbstractProject_NoBuilds());
1312
            return isInQueue() ? NO_CHANGES : BUILD_NOW;
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
        }

        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.
1328 1329 1330
        }

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

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

1368
            WorkspaceOfflineReason workspaceOfflineReason = workspaceOffline( b );
1369
            if ( workspaceOfflineReason != null ) {
1370
                // workspace offline
1371
                for (WorkspaceBrowser browser : ExtensionList.lookup(WorkspaceBrowser.class)) {
1372 1373
                    ws = browser.getWorkspace(this);
                    if (ws != null) {
1374
                        return pollWithWorkspace(listener, scm, b, ws, browser.getWorkspaceList());
1375 1376 1377
                    }
                }

K
Kohsuke Kawaguchi 已提交
1378 1379 1380 1381 1382 1383
                // 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;
1384
                if (remaining>0 && /* this logic breaks tests of polling */!Functions.getIsUnitTest()) {
K
Kohsuke Kawaguchi 已提交
1385 1386 1387 1388 1389
                    listener.getLogger().print(Messages.AbstractProject_AwaitingWorkspaceToComeOnline(remaining/1000));
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
                    return NO_CHANGES;
                }

1390 1391 1392 1393 1394 1395 1396 1397
                // 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 已提交
1398 1399 1400 1401
                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.
1402 1403
                    listener.getLogger().print(Messages.AbstractProject_NoWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1404 1405
                    return NO_CHANGES;
                }
K
Kohsuke Kawaguchi 已提交
1406

K
Kohsuke Kawaguchi 已提交
1407 1408 1409 1410 1411 1412 1413
                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 已提交
1414 1415 1416 1417 1418

                // 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 已提交
1419
            } else {
1420 1421
                WorkspaceList l = b.getBuiltOn().toComputer().getWorkspaceList();
                return pollWithWorkspace(listener, scm, b, ws, l);
K
Kohsuke Kawaguchi 已提交
1422
            }
J
Jens Brejner 已提交
1423
			
K
Kohsuke Kawaguchi 已提交
1424 1425 1426 1427
        } else {
            // polling without workspace
            LOGGER.fine("Polling SCM changes of " + getName());
            if (pollingBaseline==null) // see NOTE-NO-BASELINE above
1428
                calcPollingBaseline(getLastBuild(),null,listener);
K
Kohsuke Kawaguchi 已提交
1429 1430 1431 1432 1433 1434
            PollingResult r = scm.poll(this, null, null, listener, pollingBaseline);
            pollingBaseline = r.remote;
            return r;
        }
    }

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

1458 1459 1460
    enum WorkspaceOfflineReason {
        nonexisting_workspace,
        builton_node_gone,
1461
        builton_node_no_executors,
1462 1463
        all_suitable_nodes_are_offline,
        use_ondemand_slave
1464 1465 1466 1467 1468 1469 1470
    }

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

        if (label != null) {
1475 1476 1477 1478 1479
            //Invalid label. Put in queue to make administrator fix
            if(label.getNodes().isEmpty()) {
                return false;
            }
            //Returns true, if all suitable nodes are offline
1480
            return label.isOffline();
1481
        } else {
M
Mads Nielsen 已提交
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
            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 {
1494
                    return false;
1495 1496 1497 1498
                }
            }
        }
        return true;
1499 1500 1501
    }

    private WorkspaceOfflineReason workspaceOffline(R build) throws IOException, InterruptedException {
1502
        FilePath ws = build.getWorkspace();
1503 1504
        Label label = getAssignedLabel();

1505 1506 1507
        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;            
1508 1509
        }

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

        return null;
1524
    }
1525

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

1538
    @Exported
1539 1540 1541 1542
    public SCM getScm() {
        return scm;
    }

1543
    public void setScm(SCM scm) throws IOException {
1544
        this.scm = scm;
1545
        save();
1546 1547
    }

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

1555
    public void removeTrigger(TriggerDescriptor trigger) throws IOException {
1556
        removeFromList(trigger,triggers());
1557 1558
    }

1559 1560
    protected final synchronized <T extends Describable<T>>
    void addToList( T item, List<T> collection ) throws IOException {
1561 1562
        //No support to replace item in position, remove then add
        removeFromList(item.getDescriptor(), collection);
1563 1564
        collection.add(item);
        save();
1565
        updateTransientActions();
1566 1567
    }

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

C
Christoph Kutzinski 已提交
1583
    @SuppressWarnings("unchecked")
1584
    @Override public Map<TriggerDescriptor,Trigger<?>> getTriggers() {
K
Kohsuke Kawaguchi 已提交
1585
        return triggers().toMap();
1586 1587
    }

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

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

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

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

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

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

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

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

        return r;
    }

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

            int n = build.getNumber();

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

1696 1697
    /**
     * Builds the dependency graph.
1698
     * Since 1.558, not abstract and by default includes dependencies contributed by {@link #triggers()}.
1699
     */
1700 1701 1702
    protected void buildDependencyGraph(DependencyGraph graph) {
        triggers().buildDependencyGraph(this, graph);
    }
1703

1704
    @Override
K
kohsuke 已提交
1705
    protected SearchIndexBuilder makeSearchIndex() {
1706
        return getParameterizedJobMixIn().extendSearchIndex(super.makeSearchIndex());
K
kohsuke 已提交
1707 1708
    }

1709 1710
    @Override
    protected HistoryWidget createHistoryWidget() {
J
Jesse Glick 已提交
1711
        return buildMixIn.createHistoryWidget();
1712
    }
1713
    
K
kohsuke 已提交
1714
    public boolean isParameterized() {
1715
        return getParameterizedJobMixIn().isParameterized();
K
kohsuke 已提交
1716
    }
1717

1718 1719 1720 1721 1722
//
//
// actions
//
//
1723 1724 1725
    /**
     * Schedules a new build command.
     */
1726
    public void doBuild( StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay ) throws IOException, ServletException {
1727
        getParameterizedJobMixIn().doBuild(req, rsp, delay);
1728 1729
    }

1730 1731 1732 1733 1734 1735
    /** @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")));
    }

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

1756 1757 1758 1759
    /**
     * Supports build trigger with parameters via an HTTP GET or POST.
     * Currently only String parameters are supported.
     */
1760
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException {
1761
        getParameterizedJobMixIn().doBuildWithParameters(req, rsp, delay);
1762
    }
1763

1764 1765 1766 1767 1768 1769
    /** @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")));
    }

1770 1771 1772
    /**
     * Schedules a new SCM polling command.
     */
1773
    public void doPolling( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1774
        BuildAuthorizationToken.checkPermission((Job) this, authToken, req, rsp);
1775
        schedulePolling();
J
Jesse Glick 已提交
1776
        rsp.sendRedirect(".");
1777 1778 1779 1780 1781
    }

    /**
     * Cancels a scheduled build.
     */
J
Jesse Glick 已提交
1782
    @RequirePOST
1783
    public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1784
        getParameterizedJobMixIn().doCancelQueue(req, rsp);
1785 1786
    }

1787
    @Override
1788 1789
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
        super.submit(req,rsp);
1790
        JSONObject json = req.getSubmittedForm();
1791

1792 1793
        // "disable": {}
        makeDisabled(json.has("disable"));
1794

1795 1796 1797 1798 1799 1800
        jdk = json.optString("jdk", null);

        // "hasCustomQuietPeriod": {"quiet_period": "3"}
        JSONObject customQuietPeriodJson = json.optJSONObject("hasCustomQuietPeriod");
        if(customQuietPeriodJson!=null && !customQuietPeriodJson.isNullObject()) {
            quietPeriod = customQuietPeriodJson.optInt("quiet_period");
1801 1802 1803
        } else {
            quietPeriod = null;
        }
1804 1805 1806 1807 1808

        // "hasCustomScmCheckoutRetryCount": {"scmCheckoutRetryCount": "12"}
        JSONObject customRetryJson = json.optJSONObject("hasCustomScmCheckoutRetryCount");
        if(customRetryJson!=null && !customRetryJson.isNullObject()) {
            scmCheckoutRetryCount = customRetryJson.optInt("scmCheckoutRetryCount");
S
 
shinodkm 已提交
1809
        } else {
1810
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1811
        }
1812

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
        // "blockBuildWhenDownstreamBuilding": {}
        blockBuildWhenDownstreamBuilding = json.has("blockBuildWhenDownstreamBuilding");

        // "blockBuildWhenUpstreamBuilding": {}
        blockBuildWhenUpstreamBuilding = json.has("blockBuildWhenUpstreamBuilding");

        // "customWorkspace": {"directory": "aaa"}
        JSONObject customWorkspaceJson = json.optJSONObject("customWorkspace");
        if(customWorkspace!=null && !customWorkspaceJson.isNullObject()) {
            customWorkspace = Util.fixEmptyAndTrim(
                customWorkspaceJson.optString("directory"));
1824 1825 1826
        } else {
            customWorkspace = null;
        }
1827 1828 1829 1830 1831 1832 1833

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

1834 1835 1836 1837 1838

        JSONObject slaveAffinity = json.getJSONObject("hasSlaveAffinity");
        if(slaveAffinity!=null && !slaveAffinity.isNullObject()) {
            assignedNode = Util.fixEmptyAndTrim(
                slaveAffinity.optString("assignedLabelString"));
1839 1840 1841
        } else {
            assignedNode = null;
        }
1842
        canRoam = assignedNode==null;
1843

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

1846
        concurrentBuild = json.has("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 2036
        public FormValidation doCheckAssignedLabelString(@AncestorInPath AbstractProject<?,?> project,
                                                         @QueryParameter String value) {
2037 2038
            if (Util.fixEmpty(value)==null)
                return FormValidation.ok(); // nothing typed yet
2039 2040 2041
            try {
                Label.parseExpression(value);
            } catch (ANTLRException e) {
S
Seiji Sogabe 已提交
2042 2043
                return FormValidation.error(e,
                        Messages.AbstractProject_AssignedLabelString_InvalidBooleanExpression(e.getMessage()));
2044
            }
2045
            Jenkins j = Jenkins.getInstance();
2046 2047 2048
            if (j == null) {
                return FormValidation.ok(); // ?
            }
2049
            Label l = j.getLabel(value);
2050 2051 2052 2053 2054 2055 2056
            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 已提交
2057
                return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch());
2058
            }
S
Javadoc  
Stephen Connolly 已提交
2059
            if (project != null) {
2060
                for (AbstractProject.LabelValidator v : j
S
Javadoc  
Stephen Connolly 已提交
2061 2062 2063 2064 2065
                        .getExtensionList(AbstractProject.LabelValidator.class)) {
                    FormValidation result = v.check(project, l);
                    if (!FormValidation.Kind.OK.equals(result.kind)) {
                        return result;
                    }
2066 2067
                }
            }
2068 2069 2070
            return FormValidation.okWithMarkup(Messages.AbstractProject_LabelLink(
                    j.getRootUrl(), l.getUrl(), l.getNodes().size() + l.getClouds().size()
            ));
2071
        }
2072

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

        public AutoCompletionCandidates doAutoCompleteAssignedLabelString(@QueryParameter String value) {
2094
            AutoCompletionCandidates c = new AutoCompletionCandidates();
2095
            Set<Label> labels = Jenkins.getInstance().getLabels();
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
            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;
        }

2108
        public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p) {
2109 2110 2111
            return SCMCheckoutStrategyDescriptor._for(p);
        }

2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
        /**
        * 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 已提交
2124
                ArrayList<String> terms = new ArrayList<String>();
2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
                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;
            }
        }
2152 2153
    }

2154
    /**
2155
     * Finds a {@link AbstractProject} that has the name closest to the given name.
2156
     * @see Items#findNearest
2157
     */
2158
    public static @CheckForNull AbstractProject findNearest(String name) {
J
Jesse Glick 已提交
2159
        return findNearest(name,Jenkins.getInstance());
2160 2161 2162 2163 2164 2165
    }

    /**
     * Finds a {@link AbstractProject} whose name (when referenced from the specified context) is closest to the given name.
     *
     * @since 1.419
2166
     * @see Items#findNearest
2167
     */
2168
    public static @CheckForNull AbstractProject findNearest(String name, ItemGroup context) {
2169
        return Items.findNearest(AbstractProject.class, name, context);
2170
    }
2171 2172 2173

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
2174
            return o2-o1;
2175 2176
        }
    };
2177

2178
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
2179

2180
    /**
2181
     * @deprecated Just use {@link #CANCEL}.
2182
     */
2183
    public static final Permission ABORT = CANCEL;
2184

K
Kohsuke Kawaguchi 已提交
2185 2186 2187
    /**
     * Replaceable "Build Now" text.
     */
2188 2189
    public static final Message<AbstractProject> BUILD_NOW_TEXT = new Message<AbstractProject>();

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

    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. 
     *
2220
     * @since 1.410
2221 2222
     */
    public void setCustomWorkspace(String customWorkspace) throws IOException {
2223
        this.customWorkspace= Util.fixEmptyAndTrim(customWorkspace);
2224 2225
        save();
    }
2226 2227 2228

    /**
     * Plugins may want to contribute additional restrictions on the use of specific labels for specific projects.
S
Javadoc  
Stephen Connolly 已提交
2229 2230 2231
     * This extension point allows such restrictions.
     *
     * @since 1.540
2232 2233
     */
    public static abstract class LabelValidator implements ExtensionPoint {
S
Javadoc  
Stephen Connolly 已提交
2234 2235 2236 2237 2238 2239 2240 2241 2242
        /**
         * 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);
2243
    }
S
Javadoc  
Stephen Connolly 已提交
2244

2245
}