AbstractProject.java 79.1 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 35
import hudson.EnvVars;
import hudson.ExtensionPoint;
36
import hudson.FeedAdapter;
37
import hudson.FilePath;
38
import hudson.Functions;
39
import hudson.Launcher;
40
import hudson.Util;
41
import hudson.cli.declarative.CLIMethod;
42
import hudson.cli.declarative.CLIResolver;
M
mdonohue 已提交
43
import hudson.model.Cause.LegacyCodeCause;
44 45
import hudson.model.Descriptor.FormException;
import hudson.model.Fingerprint.RangeSet;
M
Mads Nielsen 已提交
46
import hudson.model.Node.Mode;
47
import hudson.model.PermalinkProjectAction.Permalink;
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.ModelObjectWithChildren;
112
import jenkins.model.ParameterizedJobMixIn;
K
Kohsuke Kawaguchi 已提交
113
import jenkins.model.Uptime;
J
Jesse Glick 已提交
114
import jenkins.model.lazy.LazyBuildMixIn;
115 116 117
import jenkins.scm.DefaultSCMCheckoutStrategyImpl;
import jenkins.scm.SCMCheckoutStrategy;
import jenkins.scm.SCMCheckoutStrategyDescriptor;
118
import jenkins.util.TimeDuration;
K
kohsuke 已提交
119
import net.sf.json.JSONObject;
120
import org.acegisecurity.Authentication;
K
Kohsuke Kawaguchi 已提交
121
import org.jenkinsci.bytecode.AdaptField;
122 123
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
124 125
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
126
import org.kohsuke.stapler.AncestorInPath;
127 128 129 130
import org.kohsuke.stapler.ForwardToView;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
K
kohsuke 已提交
131 132 133
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
134
import org.kohsuke.stapler.interceptor.RequirePOST;
135 136 137

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

147
    /**
148 149 150
     * {@link SCM} associated with the project.
     * To allow derived classes to link {@link SCM} config to elsewhere,
     * access to this variable should always go through {@link #getScm()}.
151
     */
K
kohsuke 已提交
152
    private volatile SCM scm = new NullSCM();
153

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

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

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

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

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

    /**
186 187 188 189 190 191 192
     * If this project is configured to be only built on a certain label,
     * this value will be set to that label.
     *
     * For historical reasons, this is called 'assignedNode'. Also for
     * a historical reason, null to indicate the affinity
     * with the master node.
     *
193
     * @see #canRoam
194 195 196 197 198
     */
    private String assignedNode;

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

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

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

217 218 219 220 221 222
    /**
     * True to keep builds of this project in queue when upstream projects are
     * building. False by default to keep from breaking existing behavior.
     */
    protected volatile boolean blockBuildWhenUpstreamBuilding = false;

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

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

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

245 246
    /**
     * {@link Action}s contributed from subsidiary objects associated with
247 248 249 250
     * {@link AbstractProject}, such as from triggers, builders, publishers, etc.
     *
     * We don't want to persist them separately, and these actions
     * come and go as configuration change, so it's kept separate.
251
     */
252 253
    @CopyOnWrite
    protected transient volatile List<Action> transientActions = new Vector<Action>();
254

K
kohsuke 已提交
255 256
    private boolean concurrentBuild;

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

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

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

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

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

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

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

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

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

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

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

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

        return env;
    }

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

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

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

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

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

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    /**
     * Set of labels relevant to this job.
     *
     * This method is used to determine what slaves are relevant to jobs, for example by {@link View}s.
     * It does not affect the scheduling. This information is informational and the best-effort basis.
     *
     * @since 1.456
     * @return
     *      Minimally it should contain {@link #getAssignedLabel()}. The set can contain null element
     *      to correspond to the null return value from {@link #getAssignedLabel()}.
     */
    public Set<Label> getRelevantLabels() {
        return Collections.singleton(getAssignedLabel());
    }

417 418 419 420
    /**
     * Gets the textual representation of the assigned label as it was entered by the user.
     */
    public String getAssignedLabelString() {
421 422 423 424 425 426 427 428
        if (canRoam || assignedNode==null)    return null;
        try {
            LabelExpression.parseExpression(assignedNode);
            return assignedNode;
        } catch (ANTLRException e) {
            // must be old label or host name that includes whitespace or other unsafe chars
            return LabelAtom.escape(assignedNode);
        }
429 430
    }

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

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

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

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

471
    /**
472
     * Gets the nearest ancestor {@link TopLevelItem} that's also an {@link AbstractProject}.
473
     *
474 475 476 477 478 479 480
     * <p>
     * Some projects (such as matrix projects, Maven projects, or promotion processes) form a tree of jobs
     * that acts as a single unit. This method can be used to find the top most dominating job that
     * covers such a tree.
     *
     * @return never null.
     * @see AbstractBuild#getRootBuild()
481
     */
482 483
    public AbstractProject<?,?> getRootProject() {
        if (this instanceof TopLevelItem) {
484 485
            return this;
        } else {
486 487 488 489
            ItemGroup p = this.getParent();
            if (p instanceof AbstractProject)
                return ((AbstractProject) p).getRootProject();
            return this;
490 491 492
        }
    }

493 494
    /**
     * Gets the directory where the module is checked out.
495 496 497
     *
     * @return
     *      null if the workspace is on a slave that's not connected.
K
kohsuke 已提交
498
     * @deprecated as of 1.319
K
kohsuke 已提交
499 500 501 502 503
     *      To support concurrent builds of the same project, this method is moved to {@link AbstractBuild}.
     *      For backward compatibility, this method returns the right {@link AbstractBuild#getWorkspace()} if called
     *      from {@link Executor}, and otherwise the workspace of the last build.
     *
     *      <p>
504
     *      If you are calling this method during a build from an executor, switch it to {@link AbstractBuild#getWorkspace()}.
K
kohsuke 已提交
505 506 507 508
     *      If you are calling this method to serve a file from the workspace, doing a form validation, etc., then
     *      use {@link #getSomeWorkspace()}
     */
    public final FilePath getWorkspace() {
509 510 511 512 513 514 515 516 517 518 519 520
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getWorkspace() : null;

    }
    
    /**
     * Various deprecated methods in this class all need the 'current' build.  This method returns
     * the build suitable for that purpose.
     * 
     * @return An AbstractBuild for deprecated methods to use.
     */
    private AbstractBuild getBuildForDeprecatedMethods() {
K
kohsuke 已提交
521 522 523 524 525 526
        Executor e = Executor.currentExecutor();
        if(e!=null) {
            Executable exe = e.getCurrentExecutable();
            if (exe instanceof AbstractBuild) {
                AbstractBuild b = (AbstractBuild) exe;
                if(b.getProject()==this)
527
                    return b;
K
kohsuke 已提交
528 529 530
            }
        }
        R lb = getLastBuild();
531
        if(lb!=null)    return lb;
K
kohsuke 已提交
532 533 534 535 536 537 538 539 540 541 542 543 544
        return null;
    }

    /**
     * Gets a workspace for some build of this project.
     *
     * <p>
     * This is useful for obtaining a workspace for the purpose of form field validation, where exactly
     * which build the workspace belonged is less important. The implementation makes a cursory effort
     * to find some workspace.
     *
     * @return
     *      null if there's no available workspace.
K
kohsuke 已提交
545
     * @since 1.319
546
     */
J
Jesse Glick 已提交
547
    public final @CheckForNull FilePath getSomeWorkspace() {
548
        R b = getSomeBuildWithWorkspace();
549 550 551 552 553 554
        if (b!=null) return b.getWorkspace();
        for (WorkspaceBrowser browser : Jenkins.getInstance().getExtensionList(WorkspaceBrowser.class)) {
            FilePath f = browser.getWorkspace(this);
            if (f != null) return f;
        }
        return null;
555 556 557 558 559 560 561 562
    }

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

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

S
stephenconnolly 已提交
594 595 596 597 598 599
    /**
     * Returns the root directories of all checked-out modules.
     * <p>
     * Some SCMs support checking out multiple modules into the same workspace.
     * In these cases, the returned array will have a length greater than one.
     * @return The roots of all modules checked out from the SCM.
K
kohsuke 已提交
600
     *
K
kohsuke 已提交
601
     * @deprecated as of 1.319
K
kohsuke 已提交
602
     *      See {@link #getWorkspace()} for a migration strategy.
S
stephenconnolly 已提交
603 604
     */
    public FilePath[] getModuleRoots() {
605 606
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoots() : null;
S
stephenconnolly 已提交
607 608
    }

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

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

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


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

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

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

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

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

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

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

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

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

675 676 677
    public boolean isDisabled() {
        return disabled;
    }
S
 
shinodkm 已提交
678 679 680 681 682
    
    /**
     * Validates the retry count Regex
     */
    public FormValidation doCheckRetryCount(@QueryParameter String value)throws IOException,ServletException{
683 684 685 686 687 688 689
        // retry count is optional so this is ok
        if(value == null || value.trim().equals(""))
            return FormValidation.ok();
        if (!value.matches("[0-9]*")) {
            return FormValidation.error("Invalid retry count");
        } 
        return FormValidation.ok();
S
 
shinodkm 已提交
690
    }
691

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

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

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

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

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

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

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

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

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

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

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

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

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

777 778
        updateTransientActions();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1192 1193 1194 1195
    public void checkAbortPermission() {
        checkPermission(AbstractProject.ABORT);
    }

K
kohsuke 已提交
1196 1197 1198 1199
    public boolean hasAbortPermission() {
        return hasPermission(AbstractProject.ABORT);
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        return null;
1525
    }
1526

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        return r;
    }

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

            int n = build.getNumber();

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

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

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

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

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

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

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

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

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

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

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

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

1793
        makeDisabled(req.getParameter("disable")!=null);
1794 1795

        jdk = req.getParameter("jdk");
1796
        if(req.getParameter("hasCustomQuietPeriod")!=null) {
1797 1798 1799 1800
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));
        } else {
            quietPeriod = null;
        }
1801 1802
        if(req.getParameter("hasCustomScmCheckoutRetryCount")!=null) {
            scmCheckoutRetryCount = Integer.parseInt(req.getParameter("scmCheckoutRetryCount"));
S
 
shinodkm 已提交
1803
        } else {
1804
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1805
        }
1806
        blockBuildWhenDownstreamBuilding = req.getParameter("blockBuildWhenDownstreamBuilding")!=null;
1807 1808
        blockBuildWhenUpstreamBuilding = req.getParameter("blockBuildWhenUpstreamBuilding")!=null;

1809
        if(req.hasParameter("customWorkspace")) {
1810
            customWorkspace = Util.fixEmptyAndTrim(req.getParameter("customWorkspace.directory"));
1811 1812 1813
        } else {
            customWorkspace = null;
        }
1814 1815 1816 1817 1818 1819 1820

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

1821
        
1822
        if(req.getParameter("hasSlaveAffinity")!=null) {
1823
            assignedNode = Util.fixEmptyAndTrim(req.getParameter("_.assignedLabelString"));
1824 1825 1826
        } else {
            assignedNode = null;
        }
1827
        canRoam = assignedNode==null;
1828

1829 1830
        keepDependencies = req.getParameter("keepDependencies") != null;

1831
        concurrentBuild = req.getSubmittedForm().has("concurrentBuild");
K
kohsuke 已提交
1832

1833
        authToken = BuildAuthorizationToken.create(req);
1834

K
kohsuke 已提交
1835
        setScm(SCMS.parseSCM(req,this));
1836

1837
        for (Trigger t : triggers())
1838
            t.stop();
K
Kohsuke Kawaguchi 已提交
1839 1840
        triggers.replaceBy(buildDescribable(req, Trigger.for_(this)));
        for (Trigger t : triggers())
1841
            t.start(this,true);
1842 1843
    }

K
kohsuke 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852
    /**
     * @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)
1853
        throws FormException, ServletException {
1854

1855
        JSONObject data = req.getSubmittedForm();
1856
        List<T> r = new Vector<T>();
1857
        for (Descriptor<T> d : descriptors) {
1858 1859 1860
            String safeName = d.getJsonSafeClassName();
            if (req.getParameter(safeName) != null) {
                T instance = d.newInstance(req, data.getJSONObject(safeName));
1861
                r.add(instance);
1862 1863
            }
        }
1864
        return r;
1865 1866
    }

1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
    public ContextMenu doChildrenContextMenu(StaplerRequest request, StaplerResponse response) throws Exception {
        // not sure what would be really useful here. This needs more thoughts.
        // for the time being, I'm starting with permalinks
        ContextMenu menu = new ContextMenu();
        for (Permalink p : getPermalinks()) {
            if (p.resolve(this)!=null)
                menu.add(p.getId(),p.getDisplayName());
        }
        return menu;
    }

1878 1879 1880
    /**
     * Serves the workspace files.
     */
1881
    public DirectoryBrowserSupport doWs( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, InterruptedException {
1882
        checkPermission(Item.WORKSPACE);
K
kohsuke 已提交
1883
        FilePath ws = getSomeWorkspace();
1884
        if ((ws == null) || (!ws.exists())) {
1885
            // if there's no workspace, report a nice error message
1886 1887 1888 1889
            // 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.
1890
            req.getView(this,"noWorkspace.jelly").forward(req,rsp);
1891
            return null;
1892
        } else {
1893
            return new DirectoryBrowserSupport(this, ws, getDisplayName()+" workspace", "folder.png", true);
1894 1895
        }
    }
1896

1897 1898 1899
    /**
     * Wipes out the workspace.
     */
1900
    public HttpResponse doDoWipeOutWorkspace() throws IOException, ServletException, InterruptedException {
1901
        checkPermission(Functions.isWipeOutPermissionEnabled() ? WIPEOUT : BUILD);
1902 1903 1904 1905
        R b = getSomeBuildWithWorkspace();
        FilePath ws = b!=null ? b.getWorkspace() : null;
        if (ws!=null && getScm().processWorkspaceBeforeDeletion(this, ws, b.getBuiltOn())) {
            ws.deleteRecursive();
1906 1907 1908
            for (WorkspaceListener wl : WorkspaceListener.all()) {
                wl.afterDelete(this);
            }
1909 1910 1911 1912
            return new HttpRedirect(".");
        } else {
            // If we get here, that means the SCM blocked the workspace deletion.
            return new ForwardToView(this,"wipeOutWorkspaceBlocked.jelly");
1913
        }
1914 1915
    }

1916
    @CLIMethod(name="disable-job")
1917
    @RequirePOST
1918
    public HttpResponse doDisable() throws IOException, ServletException {
1919 1920
        checkPermission(CONFIGURE);
        makeDisabled(true);
1921
        return new HttpRedirect(".");
1922 1923
    }

1924
    @CLIMethod(name="enable-job")
1925
    @RequirePOST
1926
    public HttpResponse doEnable() throws IOException, ServletException {
1927 1928
        checkPermission(CONFIGURE);
        makeDisabled(false);
1929
        return new HttpRedirect(".");
1930
    }
1931
    
1932

K
kohsuke 已提交
1933 1934 1935
    /**
     * RSS feed for changes in this project.
     */
1936
    public void doRssChangelog(  StaplerRequest req, StaplerResponse rsp  ) throws IOException, ServletException {
K
kohsuke 已提交
1937 1938 1939 1940 1941 1942 1943 1944 1945
        class FeedItem {
            ChangeLogSet.Entry e;
            int idx;

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

1946
            AbstractBuild<?,?> getBuild() {
1947
                return e.getParent().build;
K
kohsuke 已提交
1948 1949 1950 1951 1952
            }
        }

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

1953 1954 1955 1956
        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 已提交
1957 1958
        }

1959 1960 1961 1962 1963 1964 1965
        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 已提交
1966

1967 1968 1969
                public String getEntryUrl(FeedItem item) {
                    return item.getBuild().getUrl()+"changes#detail"+item.idx;
                }
K
kohsuke 已提交
1970

1971 1972 1973
                public String getEntryID(FeedItem item) {
                    return getEntryUrl(item);
                }
K
kohsuke 已提交
1974

1975 1976 1977 1978 1979 1980
                public String getEntryDescription(FeedItem item) {
                    StringBuilder buf = new StringBuilder();
                    for(String path : item.e.getAffectedPaths())
                        buf.append(path).append('\n');
                    return buf.toString();
                }
1981

1982 1983 1984
                public Calendar getEntryTimestamp(FeedItem item) {
                    return item.getBuild().getTimestamp();
                }
1985

1986
                public String getEntryAuthor(FeedItem entry) {
1987
                    return JenkinsLocationConfiguration.get().getAdminAddress();
1988 1989 1990
                }
            },
            req, rsp );
K
kohsuke 已提交
1991 1992
    }

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

2024 2025
        public FormValidation doCheckAssignedLabelString(@AncestorInPath AbstractProject<?,?> project,
                                                         @QueryParameter String value) {
2026 2027
            if (Util.fixEmpty(value)==null)
                return FormValidation.ok(); // nothing typed yet
2028 2029 2030
            try {
                Label.parseExpression(value);
            } catch (ANTLRException e) {
S
Seiji Sogabe 已提交
2031 2032
                return FormValidation.error(e,
                        Messages.AbstractProject_AssignedLabelString_InvalidBooleanExpression(e.getMessage()));
2033
            }
2034 2035
            Jenkins j = Jenkins.getInstance();
            Label l = j.getLabel(value);
2036 2037 2038 2039 2040 2041 2042
            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 已提交
2043
                return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch());
2044
            }
S
Javadoc  
Stephen Connolly 已提交
2045
            if (project != null) {
2046
                for (AbstractProject.LabelValidator v : j
S
Javadoc  
Stephen Connolly 已提交
2047 2048 2049 2050 2051
                        .getExtensionList(AbstractProject.LabelValidator.class)) {
                    FormValidation result = v.check(project, l);
                    if (!FormValidation.Kind.OK.equals(result.kind)) {
                        return result;
                    }
2052 2053
                }
            }
2054 2055 2056
            return FormValidation.okWithMarkup(Messages.AbstractProject_LabelLink(
                    j.getRootUrl(), l.getUrl(), l.getNodes().size() + l.getClouds().size()
            ));
2057
        }
2058

2059
        public FormValidation doCheckCustomWorkspace(@QueryParameter(value="customWorkspace.directory") String customWorkspace){
2060
        	if(Util.fixEmptyAndTrim(customWorkspace)==null)
S
Seiji Sogabe 已提交
2061
        		return FormValidation.error(Messages.AbstractProject_CustomWorkspaceEmpty());
2062 2063 2064 2065
        	else
        		return FormValidation.ok();
        }
        
2066 2067
        public AutoCompletionCandidates doAutoCompleteUpstreamProjects(@QueryParameter String value) {
            AutoCompletionCandidates candidates = new AutoCompletionCandidates();
2068
            List<Job> jobs = Jenkins.getInstance().getItems(Job.class);
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
            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) {
2080
            AutoCompletionCandidates c = new AutoCompletionCandidates();
2081
            Set<Label> labels = Jenkins.getInstance().getLabels();
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
            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;
        }

2094
        public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p) {
2095 2096 2097
            return SCMCheckoutStrategyDescriptor._for(p);
        }

2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
        /**
        * 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 已提交
2110
                ArrayList<String> terms = new ArrayList<String>();
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137
                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;
            }
        }
2138 2139
    }

2140
    /**
2141
     * Finds a {@link AbstractProject} that has the name closest to the given name.
2142
     * @see Items#findNearest
2143
     */
2144
    public static @CheckForNull AbstractProject findNearest(String name) {
J
Jesse Glick 已提交
2145
        return findNearest(name,Jenkins.getInstance());
2146 2147 2148 2149 2150 2151
    }

    /**
     * Finds a {@link AbstractProject} whose name (when referenced from the specified context) is closest to the given name.
     *
     * @since 1.419
2152
     * @see Items#findNearest
2153
     */
2154
    public static @CheckForNull AbstractProject findNearest(String name, ItemGroup context) {
2155
        return Items.findNearest(AbstractProject.class, name, context);
2156
    }
2157 2158 2159

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
2160
            return o2-o1;
2161 2162
        }
    };
2163

2164
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
2165

2166
    /**
2167
     * Permission to abort a build
2168
     */
2169
    public static final Permission ABORT = CANCEL;
2170

K
Kohsuke Kawaguchi 已提交
2171 2172 2173
    /**
     * Replaceable "Build Now" text.
     */
2174 2175
    public static final Message<AbstractProject> BUILD_NOW_TEXT = new Message<AbstractProject>();

2176 2177 2178 2179 2180 2181
    /**
     * Used for CLI binding.
     */
    @CLIResolver
    public static AbstractProject resolveForCLI(
            @Argument(required=true,metaVar="NAME",usage="Job name") String name) throws CmdLineException {
2182
        AbstractProject item = Jenkins.getInstance().getItemByFullName(name, AbstractProject.class);
2183 2184 2185 2186
        if (item==null)
            throw new CmdLineException(null,Messages.AbstractItem_NoSuchJobExists(name,AbstractProject.findNearest(name).getFullName()));
        return item;
    }
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205

    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. 
     *
2206
     * @since 1.410
2207 2208
     */
    public void setCustomWorkspace(String customWorkspace) throws IOException {
2209
        this.customWorkspace= Util.fixEmptyAndTrim(customWorkspace);
2210 2211
        save();
    }
2212 2213 2214

    /**
     * Plugins may want to contribute additional restrictions on the use of specific labels for specific projects.
S
Javadoc  
Stephen Connolly 已提交
2215 2216 2217
     * This extension point allows such restrictions.
     *
     * @since 1.540
2218 2219
     */
    public static abstract class LabelValidator implements ExtensionPoint {
S
Javadoc  
Stephen Connolly 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228
        /**
         * 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);
2229
    }
S
Javadoc  
Stephen Connolly 已提交
2230

2231
}