AbstractProject.java 79.3 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
4
 * Copyright (c) 2004-2011, Sun Microsystems, Inc., Kohsuke Kawaguchi,
5
 * Brian Westrich, Erik Ramfelt, Ertan Deniz, Jean-Baptiste Quenot,
6
 * Luca Domenico Milanesio, R. Tyler Ballance, Stephen Connolly, Tom Huybrechts,
7 8
 * id:cactusman, Yahoo! Inc., Andrew Bayer, Manufacture Francaise des Pneumatiques
 * Michelin, Romain Seguy
K
kohsuke 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
28 29
package hudson.model;

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

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

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

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

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

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

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

158 159
    /**
     * All the builds keyed by their build number.
160 161 162
     *
     * External code should use {@link #getBuildByNumber(int)} or {@link #getLastBuild()} and traverse via
     * {@link Run#getPreviousBuild()}
163
     */
164
    @Restricted(NoExternalUse.class)
165 166
    @SuppressWarnings("deprecation") // [JENKINS-15156] builds accessed before onLoad or onCreatedFromScratch called
    protected transient RunMap<R> builds = new RunMap<R>();
167 168 169 170

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

    /**
179 180 181 182 183 184 185
     * 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.
     *
186
     * @see #canRoam
187 188 189 190 191
     */
    private String assignedNode;

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

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

204 205 206 207 208 209
    /**
     * 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;

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

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

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

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

235 236
    /**
     * {@link Action}s contributed from subsidiary objects associated with
237 238 239 240
     * {@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.
241
     */
242 243
    @CopyOnWrite
    protected transient volatile List<Action> transientActions = new Vector<Action>();
244

K
kohsuke 已提交
245 246
    private boolean concurrentBuild;

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

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

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

270 271 272
    @Override
    public void onCreatedFromScratch() {
        super.onCreatedFromScratch();
J
Johno Crawford 已提交
273
        builds = createBuildRunMap();
274 275
        // solicit initial contributions, especially from TransientProjectActionFactory
        updateTransientActions();
276 277
    }

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

J
Johno Crawford 已提交
282
        RunMap<R> builds = createBuildRunMap();
283 284 285 286 287 288 289 290
        if (this.builds!=null) {
            // if we are reloading, keep all those that are still building intact
            for (R r : this.builds.getLoadedBuilds().values()) {
                if (r.isBuilding())
                    builds.put(r);
            }
        }
        this.builds = builds;
291
        for (Trigger t : triggers())
292
            t.start(this, Items.updatingByXml.get());
293 294
        if(scm==null)
            scm = new NullSCM(); // perhaps it was pointing to a plugin that no longer exists.
295

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

J
Johno Crawford 已提交
301 302 303 304 305 306 307 308
    private RunMap<R> createBuildRunMap() {
        return new RunMap<R>(getBuildDir(), new Constructor<R>() {
            public R create(File dir) throws IOException {
                return loadBuild(dir);
            }
        });
    }

309 310 311 312 313 314 315
    private synchronized List<Trigger<?>> triggers() {
        if (triggers == null) {
            triggers = new Vector<Trigger<?>>();
        }
        return triggers;
    }

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
    @Override
    public EnvVars getEnvironment(Node node, TaskListener listener) throws IOException, InterruptedException {
        EnvVars env =  super.getEnvironment(node, listener);

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

        return env;
    }

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

K
kohsuke 已提交
345 346
    /**
     * Does this project perform concurrent builds?
K
kohsuke 已提交
347
     * @since 1.319
K
kohsuke 已提交
348
     */
K
kohsuke 已提交
349
    @Exported
K
kohsuke 已提交
350
    public boolean isConcurrentBuild() {
351
        return concurrentBuild;
K
kohsuke 已提交
352 353 354 355 356 357 358
    }

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

359
    /**
360 361
     * If this project is configured to be always built on this node,
     * return that {@link Node}. Otherwise null.
362
     */
363
    public Label getAssignedLabel() {
364
        if(canRoam)
365 366
            return null;

367
        if(assignedNode==null)
368 369
            return Jenkins.getInstance().getSelfLabel();
        return Jenkins.getInstance().getLabel(assignedNode);
370 371
    }

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
    /**
     * 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());
    }

387 388 389 390
    /**
     * Gets the textual representation of the assigned label as it was entered by the user.
     */
    public String getAssignedLabelString() {
391 392 393 394 395 396 397 398
        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);
        }
399 400
    }

K
kohsuke 已提交
401 402 403 404 405 406 407 408 409
    /**
     * Sets the assigned label.
     */
    public void setAssignedLabel(Label l) throws IOException {
        if(l==null) {
            canRoam = true;
            assignedNode = null;
        } else {
            canRoam = false;
410
            if(l== Jenkins.getInstance().getSelfLabel())  assignedNode = null;
411
            else                                        assignedNode = l.getExpression();
K
kohsuke 已提交
412 413 414 415
        }
        save();
    }

416 417 418 419 420 421 422
    /**
     * Assigns this job to the given node. A convenience method over {@link #setAssignedLabel(Label)}.
     */
    public void setAssignedNode(Node l) throws IOException {
        setAssignedLabel(l.getSelfLabel());
    }

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

432 433 434 435 436 437 438 439 440
    /**
     * Gets the human readable display name to be rendered in the "Build Now" link.
     *
     * @since 1.401
     */
    public String getBuildNowText() {
        return AlternativeUiTextProvider.get(BUILD_NOW_TEXT,this,Messages.AbstractProject_BuildNow());
    }

441
    /**
442
     * Gets the nearest ancestor {@link TopLevelItem} that's also an {@link AbstractProject}.
443
     *
444 445 446 447 448 449 450
     * <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()
451
     */
452 453
    public AbstractProject<?,?> getRootProject() {
        if (this instanceof TopLevelItem) {
454 455
            return this;
        } else {
456 457 458 459
            ItemGroup p = this.getParent();
            if (p instanceof AbstractProject)
                return ((AbstractProject) p).getRootProject();
            return this;
460 461 462
        }
    }

463 464
    /**
     * Gets the directory where the module is checked out.
465 466 467
     *
     * @return
     *      null if the workspace is on a slave that's not connected.
K
kohsuke 已提交
468
     * @deprecated as of 1.319
K
kohsuke 已提交
469 470 471 472 473
     *      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>
474
     *      If you are calling this method during a build from an executor, switch it to {@link AbstractBuild#getWorkspace()}.
K
kohsuke 已提交
475 476 477 478
     *      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() {
479 480 481 482 483 484 485 486 487 488 489 490
        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 已提交
491 492 493 494 495 496
        Executor e = Executor.currentExecutor();
        if(e!=null) {
            Executable exe = e.getCurrentExecutable();
            if (exe instanceof AbstractBuild) {
                AbstractBuild b = (AbstractBuild) exe;
                if(b.getProject()==this)
497
                    return b;
K
kohsuke 已提交
498 499 500
            }
        }
        R lb = getLastBuild();
501
        if(lb!=null)    return lb;
K
kohsuke 已提交
502 503 504 505 506 507 508 509 510 511 512 513 514
        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 已提交
515
     * @since 1.319
516
     */
K
kohsuke 已提交
517
    public final FilePath getSomeWorkspace() {
518
        R b = getSomeBuildWithWorkspace();
519 520 521 522 523 524
        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;
525 526 527 528 529 530 531 532
    }

    /**
     * Gets some build that has a live workspace.
     *
     * @return null if no such build exists.
     */
    public final R getSomeBuildWithWorkspace() {
K
kohsuke 已提交
533 534 535
        int cnt=0;
        for (R b = getLastBuild(); cnt<5 && b!=null; b=b.getPreviousBuild()) {
            FilePath ws = b.getWorkspace();
536
            if (ws!=null)   return b;
K
kohsuke 已提交
537 538 539
        }
        return null;
    }
540

541 542 543
    /**
     * Returns the root directory of the checked-out module.
     * <p>
544 545
     * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
     * and so on exists.
K
kohsuke 已提交
546
     *
K
kohsuke 已提交
547
     * @deprecated as of 1.319
K
kohsuke 已提交
548
     *      See {@link #getWorkspace()} for a migration strategy.
549 550
     */
    public FilePath getModuleRoot() {
551 552
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoot() : null;
553 554
    }

S
stephenconnolly 已提交
555 556 557 558 559 560
    /**
     * 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 已提交
561
     *
K
kohsuke 已提交
562
     * @deprecated as of 1.319
K
kohsuke 已提交
563
     *      See {@link #getWorkspace()} for a migration strategy.
S
stephenconnolly 已提交
564 565
     */
    public FilePath[] getModuleRoots() {
566 567
        AbstractBuild b = getBuildForDeprecatedMethods();
        return b != null ? b.getModuleRoots() : null;
S
stephenconnolly 已提交
568 569
    }

570
    public int getQuietPeriod() {
571
        return quietPeriod!=null ? quietPeriod : Jenkins.getInstance().getQuietPeriod();
572
    }
573

574
    public SCMCheckoutStrategy getScmCheckoutStrategy() {
575 576 577
        return scmCheckoutStrategy == null ? new DefaultSCMCheckoutStrategyImpl() : scmCheckoutStrategy;
    }

578
    public void setScmCheckoutStrategy(SCMCheckoutStrategy scmCheckoutStrategy) throws IOException {
579 580 581 582 583
        this.scmCheckoutStrategy = scmCheckoutStrategy;
        save();
    }


584
    public int getScmCheckoutRetryCount() {
585
        return scmCheckoutRetryCount !=null ? scmCheckoutRetryCount : Jenkins.getInstance().getScmCheckoutRetryCount();
S
 
shinodkm 已提交
586
    }
587 588 589

    // ugly name because of EL
    public boolean getHasCustomQuietPeriod() {
590
        return quietPeriod!=null;
591
    }
K
kohsuke 已提交
592 593 594 595

    /**
     * Sets the custom quiet period of this project, or revert to the global default if null is given. 
     */
596
    public void setQuietPeriod(Integer seconds) throws IOException {
K
kohsuke 已提交
597 598 599
        this.quietPeriod = seconds;
        save();
    }
S
 
shinodkm 已提交
600
    
601
    public boolean hasCustomScmCheckoutRetryCount(){
602
        return scmCheckoutRetryCount != null;
S
 
shinodkm 已提交
603
    }
604

605
    @Override
606
    public boolean isBuildable() {
J
jpederzolli 已提交
607
        return !isDisabled() && !isHoldOffBuildUntilSave();
608 609
    }

610
    /**
611 612
     * Used in <tt>sidepanel.jelly</tt> to decide whether to display
     * the config/delete/build links.
613 614 615 616 617
     */
    public boolean isConfigurable() {
        return true;
    }

618 619 620 621 622 623 624 625 626
    public boolean blockBuildWhenDownstreamBuilding() {
        return blockBuildWhenDownstreamBuilding;
    }

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

627
    public boolean blockBuildWhenUpstreamBuilding() {
628
        return blockBuildWhenUpstreamBuilding;
629 630
    }

631
    public void setBlockBuildWhenUpstreamBuilding(boolean b) throws IOException {
632 633
        blockBuildWhenUpstreamBuilding = b;
        save();
634 635
    }

636 637 638
    public boolean isDisabled() {
        return disabled;
    }
S
 
shinodkm 已提交
639 640 641 642 643
    
    /**
     * Validates the retry count Regex
     */
    public FormValidation doCheckRetryCount(@QueryParameter String value)throws IOException,ServletException{
644 645 646 647 648 649 650
        // 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 已提交
651
    }
652

653 654 655 656
    /**
     * Marks the build as disabled.
     */
    public void makeDisabled(boolean b) throws IOException {
657
        if(disabled==b)     return; // noop
658
        this.disabled = b;
K
bug fix  
kohsuke 已提交
659
        if(b)
660
            Jenkins.getInstance().getQueue().cancel(this);
661 662 663
        save();
    }

664 665
    /**
     * Specifies whether this project may be disabled by the user.
666 667
     * By default, it can be only if this is a {@link TopLevelItem};
     * would be false for matrix configurations, etc.
668 669 670 671
     * @return true if the GUI should allow {@link #doDisable} and the like
     * @since 1.475
     */
    public boolean supportsMakeDisabled() {
672
        return this instanceof TopLevelItem;
673 674
    }

675 676 677 678 679 680 681 682
    public void disable() throws IOException {
        makeDisabled(true);
    }

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

K
kohsuke 已提交
683 684
    @Override
    public BallColor getIconColor() {
685
        if(isDisabled())
686
            return BallColor.DISABLED;
K
kohsuke 已提交
687 688 689
        else
            return super.getIconColor();
    }
690

691 692 693 694 695 696 697
    /**
     * effectively deprecated. Since using updateTransientActions correctly
     * under concurrent environment requires a lock that can too easily cause deadlocks.
     *
     * <p>
     * Override {@link #createTransientActions()} instead.
     */
698
    protected void updateTransientActions() {
699 700 701 702
        transientActions = createTransientActions();
    }

    protected List<Action> createTransientActions() {
703
        Vector<Action> ta = new Vector<Action>();
704

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

708 709
        for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all())
            ta.addAll(Util.fixNull(tpaf.createFor(this))); // be defensive against null
710
        return ta;
711 712
    }

713
    /**
714 715
     * Returns the live list of all {@link Publisher}s configured for this project.
     *
716
     * <p>
717 718
     * This method couldn't be called <tt>getPublishers()</tt> because existing methods
     * in sub-classes return different inconsistent types.
719
     */
720
    public abstract DescribableList<Publisher,Descriptor<Publisher>> getPublishersList();
721

K
kohsuke 已提交
722 723 724 725 726 727
    @Override
    public void addProperty(JobProperty<? super P> jobProp) throws IOException {
        super.addProperty(jobProp);
        updateTransientActions();
    }

728 729 730 731
    public List<ProminentProjectAction> getProminentActions() {
        List<Action> a = getActions();
        List<ProminentProjectAction> pa = new Vector<ProminentProjectAction>();
        for (Action action : a) {
732
            if(action instanceof ProminentProjectAction)
733 734 735 736 737
                pa.add((ProminentProjectAction) action);
        }
        return pa;
    }

738
    @Override
739
    public void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, FormException {
740
        super.doConfigSubmit(req,rsp);
741

742 743
        updateTransientActions();

744
        Set<AbstractProject> upstream = Collections.emptySet();
745
        if(req.getParameter("pseudoUpstreamTrigger")!=null) {
746
            upstream = new HashSet<AbstractProject>(Items.fromNameList(getParent(),req.getParameter("upstreamProjects"),AbstractProject.class));
747 748 749
        }

        // dependency setting might have been changed by the user, so rebuild.
750
        Jenkins.getInstance().rebuildDependencyGraph();
751 752 753 754 755

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

756
        for (AbstractProject<?,?> p : Jenkins.getInstance().getAllItems(AbstractProject.class)) {
757 758
            // Don't consider child projects such as MatrixConfiguration:
            if (!p.isConfigurable()) continue;
759
            boolean isUpstream = upstream.contains(p);
760 761 762
            synchronized(p) {
                // does 'p' include us in its BuildTrigger? 
                DescribableList<Publisher,Descriptor<Publisher>> pl = p.getPublishersList();
763
                BuildTrigger trigger = pl.get(BuildTrigger.class);
764
                List<AbstractProject> newChildProjects = trigger == null ? new ArrayList<AbstractProject>():trigger.getChildProjects(p);
765 766
                if(isUpstream) {
                    if(!newChildProjects.contains(this))
767 768 769 770 771
                        newChildProjects.add(this);
                } else {
                    newChildProjects.remove(this);
                }

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

798
                    if(existing!=null && existing.hasSame(p,newChildProjects))
799
                        continue;   // no need to touch
800
                    pl.replace(new BuildTrigger(newChildProjects,
801
                        existing==null?Result.SUCCESS:existing.getThreshold()));
802 803 804 805 806
                }
            }
        }

        // notify the queue as the project might be now tied to different node
807
        Jenkins.getInstance().getQueue().scheduleMaintenance();
808 809

        // this is to reflect the upstream build adjustments done above
810
        Jenkins.getInstance().rebuildDependencyGraph();
811 812
    }

M
mdonohue 已提交
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild() {
    	return scheduleBuild(new LegacyCodeCause());
    }
    
	/**
	 * @deprecated
	 *    Use {@link #scheduleBuild(int, Cause)}.  Since 1.283
	 */
    public boolean scheduleBuild(int quietPeriod) {
    	return scheduleBuild(quietPeriod, new LegacyCodeCause());
    }
    
829 830
    /**
     * Schedules a build of this project.
831 832 833 834 835
     *
     * @return
     *      true if the project is actually added to the queue.
     *      false if the queue contained it and therefore the add()
     *      was noop
836
     */
M
mdonohue 已提交
837 838
    public boolean scheduleBuild(Cause c) {
        return scheduleBuild(getQuietPeriod(), c);
K
kohsuke 已提交
839 840
    }

M
mdonohue 已提交
841
    public boolean scheduleBuild(int quietPeriod, Cause c) {
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
        return scheduleBuild(quietPeriod, c, new Action[0]);
    }

    /**
     * Schedules a build.
     *
     * Important: the actions should be persistable without outside references (e.g. don't store
     * references to this project). To provide parameters for a parameterized project, add a ParametersAction. If
     * no ParametersAction is provided for such a project, one will be created with the default parameter values.
     *
     * @param quietPeriod the quiet period to observer
     * @param c the cause for this build which should be recorded
     * @param actions a list of Actions that will be added to the build
     * @return whether the build was actually scheduled
     */
    public boolean scheduleBuild(int quietPeriod, Cause c, Action... actions) {
858 859 860 861 862 863
        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.
864 865 866
     *
     * @param actions
     *      For the convenience of the caller, this array can contain null, and those will be silently ignored.
867
     */
868 869
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Action... actions) {
K
kohsuke 已提交
870 871 872 873 874 875 876 877 878 879 880
        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 已提交
881
    @SuppressWarnings("unchecked")
882 883
    @WithBridgeMethods(Future.class)
    public QueueTaskFuture<R> scheduleBuild2(int quietPeriod, Cause c, Collection<? extends Action> actions) {
884
        if (!isBuildable())
885
            return null;
886

K
kohsuke 已提交
887
        List<Action> queueActions = new ArrayList<Action>(actions);
888 889 890 891
        if (isParameterized() && Util.filter(queueActions, ParametersAction.class).isEmpty()) {
            queueActions.add(new ParametersAction(getDefaultParametersValues()));
        }

S
sogabe 已提交
892 893 894 895
        if (c != null) {
            queueActions.add(new CauseAction(c));
        }

896
        WaitingItem i = Jenkins.getInstance().getQueue().schedule(this, quietPeriod, queueActions);
897
        if(i!=null)
898
            return (QueueTaskFuture)i.getFuture();
899
        return null;
900 901 902 903 904 905
    }

    private List<ParameterValue> getDefaultParametersValues() {
        ParametersDefinitionProperty paramDefProp = getProperty(ParametersDefinitionProperty.class);
        ArrayList<ParameterValue> defValues = new ArrayList<ParameterValue>();
        
M
mindless 已提交
906 907 908
        /*
         * This check is made ONLY if someone will call this method even if isParametrized() is false.
         */
909 910 911 912 913 914 915 916 917 918 919 920 921
        if(paramDefProp == null)
            return defValues;
        
        /* Scan for all parameter with an associated default values */
        for(ParameterDefinition paramDefinition : paramDefProp.getParameterDefinitions())
        {
           ParameterValue defaultValue  = paramDefinition.getDefaultParameterValue();
            
            if(defaultValue != null)
                defValues.add(defaultValue);           
        }
        
        return defValues;
K
kohsuke 已提交
922 923
    }

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

947 948 949 950
    /**
     * Schedules a polling of this project.
     */
    public boolean schedulePolling() {
951
        if(isDisabled())    return false;
952
        SCMTrigger scmt = getTrigger(SCMTrigger.class);
953
        if(scmt==null)      return false;
954 955 956 957
        scmt.run();
        return true;
    }

958 959 960 961 962
    /**
     * Returns true if the build is in the queue.
     */
    @Override
    public boolean isInQueue() {
963
        return Jenkins.getInstance().getQueue().contains(this);
964 965
    }

K
kohsuke 已提交
966 967
    @Override
    public Queue.Item getQueueItem() {
968
        return Jenkins.getInstance().getQueue().getItem(this);
K
kohsuke 已提交
969 970
    }

K
kohsuke 已提交
971 972 973
    /**
     * Gets the JDK that this project is configured with, or null.
     */
974
    public JDK getJDK() {
975
        return Jenkins.getInstance().getJDK(jdk);
976 977 978 979 980
    }

    /**
     * Overwrites the JDK setting.
     */
K
kohsuke 已提交
981
    public void setJDK(JDK jdk) throws IOException {
982 983 984 985
        this.jdk = jdk.getName();
        save();
    }

986 987
    public BuildAuthorizationToken getAuthToken() {
        return authToken;
988 989
    }

990
    @Override
991 992
    public RunMap<R> _getRuns() {
        return builds;
993 994
    }

995
    @Override
996 997 998 999
    public void removeRun(R run) {
        this.builds.remove(run);
    }

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
    /**
     * {@inheritDoc}
     *
     * More efficient implementation.
     */
    @Override
    public R getBuild(String id) {
        return builds.getById(id);
    }

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

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

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

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

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

1045 1046 1047 1048 1049
    /**
     * Determines Class&lt;R>.
     */
    protected abstract Class<R> getBuildClass();

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

1082
    private IOException handleInvocationTargetException(InvocationTargetException e) {
1083
        Throwable t = e.getTargetException();
1084 1085 1086
        if(t instanceof Error)  throw (Error)t;
        if(t instanceof RuntimeException)   throw (RuntimeException)t;
        if(t instanceof IOException)    return (IOException)t;
1087 1088 1089
        throw new Error(t);
    }

1090 1091 1092
    /**
     * Loads an existing build record from disk.
     */
1093 1094
    protected R loadBuild(File dir) throws IOException {
        try {
1095
            return getBuildClass().getConstructor(getClass(),File.class).newInstance(this,dir);
1096 1097 1098 1099 1100
        } catch (InstantiationException e) {
            throw new Error(e);
        } catch (IllegalAccessException e) {
            throw new Error(e);
        } catch (InvocationTargetException e) {
1101
            throw handleInvocationTargetException(e);
1102 1103 1104 1105
        } catch (NoSuchMethodException e) {
            throw new Error(e);
        }
    }
1106

K
kohsuke 已提交
1107 1108
    /**
     * {@inheritDoc}
1109
     *
K
kohsuke 已提交
1110 1111
     * <p>
     * Note that this method returns a read-only view of {@link Action}s.
1112
     * {@link BuildStep}s and others who want to add a project action
1113
     * should do so by implementing {@link BuildStep#getProjectActions(AbstractProject)}.
1114 1115
     *
     * @see TransientProjectActionFactory
K
kohsuke 已提交
1116
     */
1117
    @Override
1118 1119 1120 1121
    public synchronized List<Action> getActions() {
        // add all the transient actions, too
        List<Action> actions = new Vector<Action>(super.getActions());
        actions.addAll(transientActions);
1122
        // return the read only list to cause a failure on plugins who try to add an action here
K
kohsuke 已提交
1123
        return Collections.unmodifiableList(actions);
1124 1125
    }

1126 1127
    /**
     * Gets the {@link Node} where this project was last built on.
1128 1129 1130 1131
     *
     * @return
     *      null if no information is available (for example,
     *      if no build was done yet.)
1132 1133 1134 1135
     */
    public Node getLastBuiltOn() {
        // where was it built on?
        AbstractBuild b = getLastBuild();
1136
        if(b==null)
1137 1138 1139 1140 1141
            return null;
        else
            return b.getBuiltOn();
    }

1142 1143 1144 1145
    public Object getSameNodeConstraint() {
        return this; // in this way, any member that wants to run with the main guy can nominate the project itself 
    }

1146 1147 1148 1149
    public final Task getOwnerTask() {
        return this;
    }

1150
    /**
1151
     * {@inheritDoc}
1152
     *
1153
     * <p>
1154
     * A project must be blocked if its own previous build is in progress,
1155 1156
     * or if the blockBuildWhenUpstreamBuilding option is true and an upstream
     * project is building, but derived classes can also check other conditions.
1157
     */
1158
    public boolean isBuildBlocked() {
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
        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;
1175 1176
        }

1177
        @Override
1178 1179 1180 1181 1182 1183 1184 1185
        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);
        }
1186
    }
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
    
    /**
     * 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());
        }
    }
1203

1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
    /**
     * 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;
        }

1214
        @Override
1215 1216 1217
        public String getShortDescription() {
            return Messages.AbstractProject_UpstreamBuildInProgress(up.getName());
        }
1218 1219
    }

1220
    public CauseOfBlockage getCauseOfBlockage() {
1221 1222
        // Block builds until they are done with post-production
        if (isLogUpdated() && !isConcurrentBuild())
1223
            return new BecauseOfBuildInProgress(getLastBuild());
1224 1225 1226 1227
        if (blockBuildWhenDownstreamBuilding()) {
            AbstractProject<?,?> bup = getBuildingDownstream();
            if (bup!=null)
                return new BecauseOfDownstreamBuildInProgress(bup);
1228 1229
        }
        if (blockBuildWhenUpstreamBuilding()) {
1230 1231 1232 1233 1234 1235
            AbstractProject<?,?> bup = getBuildingUpstream();
            if (bup!=null)
                return new BecauseOfUpstreamBuildInProgress(bup);
        }
        return null;
    }
1236

1237
    /**
1238 1239
     * Returns the project if any of the downstream project is either
     * building, waiting, pending or buildable.
1240 1241 1242 1243
     * <p>
     * This means eventually there will be an automatic triggering of
     * the given project (provided that all builds went smoothly.)
     */
1244
    public AbstractProject getBuildingDownstream() {
1245
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1246

1247
        for (AbstractProject tup : getTransitiveDownstreamProjects()) {
1248
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1249 1250 1251 1252 1253
                return tup;
        }
        return null;
    }

1254
    /**
1255
     * Returns the project if any of the upstream project is either
1256 1257 1258 1259 1260
     * 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.)
     */
1261
    public AbstractProject getBuildingUpstream() {
1262
        Set<Task> unblockedTasks = Jenkins.getInstance().getQueue().getUnblockedTasks();
1263

1264
        for (AbstractProject tup : getTransitiveUpstreamProjects()) {
1265
			if (tup!=this && (tup.isBuilding() || unblockedTasks.contains(tup)))
1266 1267 1268
                return tup;
        }
        return null;
1269 1270
    }

1271 1272
    public List<SubTask> getSubTasks() {
        List<SubTask> r = new ArrayList<SubTask>();
1273
        r.add(this);
1274 1275 1276
        for (SubTaskContributor euc : SubTaskContributor.all())
            r.addAll(euc.forProject(this));
        for (JobProperty<? super P> p : properties)
1277
            r.addAll(p.getSubTasks());
1278
        return r;
1279 1280
    }

1281
    public R createExecutable() throws IOException {
1282
        if(isDisabled())    return null;
1283
        return newBuild();
1284 1285
    }

1286 1287 1288 1289
    public void checkAbortPermission() {
        checkPermission(AbstractProject.ABORT);
    }

K
kohsuke 已提交
1290 1291 1292 1293
    public boolean hasAbortPermission() {
        return hasPermission(AbstractProject.ABORT);
    }

1294 1295
    /**
     * Gets the {@link Resource} that represents the workspace of this project.
1296
     * Useful for locking and mutual exclusion control.
K
kohsuke 已提交
1297
     *
K
kohsuke 已提交
1298
     * @deprecated as of 1.319
K
kohsuke 已提交
1299 1300 1301 1302 1303 1304 1305
     *      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}.
1306 1307
     */
    public Resource getWorkspaceResource() {
1308
        return new Resource(getFullDisplayName()+" workspace");
1309 1310 1311 1312 1313 1314
    }

    /**
     * List of necessary resources to perform the build of this project.
     */
    public ResourceList getResourceList() {
1315
        final Set<ResourceActivity> resourceActivities = getResourceActivities();
1316
        final List<ResourceList> resourceLists = new ArrayList<ResourceList>(1 + resourceActivities.size());
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
        for (ResourceActivity activity : resourceActivities) {
            if (activity != this && activity != null) {
                // defensive infinite recursion and null check
                resourceLists.add(activity.getResourceList());
            }
        }
        return ResourceList.union(resourceLists);
    }

    /**
1327 1328
     * 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.
1329 1330
     */
    protected Set<ResourceActivity> getResourceActivities() {
K
kohsuke 已提交
1331
        return Collections.emptySet();
1332 1333
    }

1334
    public boolean checkout(AbstractBuild build, Launcher launcher, BuildListener listener, File changelogFile) throws IOException, InterruptedException {
1335
        SCM scm = getScm();
1336 1337
        if(scm==null)
            return true;    // no SCM
1338

1339 1340
        FilePath workspace = build.getWorkspace();
        workspace.mkdirs();
1341 1342
        
        boolean r = scm.checkout(build, launcher, workspace, listener, changelogFile);
C
Christoph Kutzinski 已提交
1343 1344 1345
        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.
1346 1347
            calcPollingBaseline(build, launcher, listener);
        }
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
        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 {
1358
                baseline = getScm()._calcRevisionsFromBuild(build, launcher, listener);
1359 1360 1361 1362 1363 1364 1365 1366 1367
            } 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;
    }

1368 1369
    /**
     * Checks if there's any update in SCM, and returns true if any is found.
1370
     *
1371 1372
     * @deprecated as of 1.346
     *      Use {@link #poll(TaskListener)} instead.
1373
     */
1374
    public boolean pollSCMChanges( TaskListener listener ) {
1375 1376 1377 1378 1379 1380 1381
        return poll(listener).hasChanges();
    }

    /**
     * Checks if there's any update in SCM, and returns true if any is found.
     *
     * <p>
1382 1383
     * The implementation is responsible for ensuring mutual exclusion between polling and builds
     * if necessary.
1384 1385 1386 1387
     *
     * @since 1.345
     */
    public PollingResult poll( TaskListener listener ) {
1388
        SCM scm = getScm();
1389
        if (scm==null) {
K
i18n  
kohsuke 已提交
1390
            listener.getLogger().println(Messages.AbstractProject_NoSCM());
1391
            return NO_CHANGES;
1392
        }
1393
        if (!isBuildable()) {
K
i18n  
kohsuke 已提交
1394
            listener.getLogger().println(Messages.AbstractProject_Disabled());
1395 1396 1397 1398 1399
            return NO_CHANGES;
        }

        R lb = getLastBuild();
        if (lb==null) {
1400
            listener.getLogger().println(Messages.AbstractProject_NoBuilds());
1401
            return isInQueue() ? NO_CHANGES : BUILD_NOW;
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
        }

        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.
1417 1418 1419
        }

        try {
K
Kohsuke Kawaguchi 已提交
1420 1421 1422 1423
            SCMPollListener.fireBeforePolling(this, listener);
            PollingResult r = _poll(listener, scm, lb);
            SCMPollListener.firePollingSuccess(this,listener, r);
            return r;
1424
        } catch (AbortException e) {
1425
            listener.getLogger().println(e.getMessage());
K
i18n  
kohsuke 已提交
1426
            listener.fatalError(Messages.AbstractProject_Aborted());
1427
            LOGGER.log(Level.FINE, "Polling "+this+" aborted",e);
K
Kohsuke Kawaguchi 已提交
1428
            SCMPollListener.firePollingFailed(this, listener,e);
1429
            return NO_CHANGES;
1430 1431
        } catch (IOException e) {
            e.printStackTrace(listener.fatalError(e.getMessage()));
K
Kohsuke Kawaguchi 已提交
1432
            SCMPollListener.firePollingFailed(this, listener,e);
1433
            return NO_CHANGES;
1434
        } catch (InterruptedException e) {
1435
            e.printStackTrace(listener.fatalError(Messages.AbstractProject_PollingABorted()));
K
Kohsuke Kawaguchi 已提交
1436
            SCMPollListener.firePollingFailed(this, listener,e);
1437
            return NO_CHANGES;
K
Kohsuke Kawaguchi 已提交
1438 1439 1440 1441 1442 1443
        } catch (RuntimeException e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
        } catch (Error e) {
            SCMPollListener.firePollingFailed(this, listener,e);
            throw e;
1444 1445
        }
    }
K
Kohsuke Kawaguchi 已提交
1446 1447 1448 1449 1450 1451 1452 1453 1454

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

1455 1456
            WorkspaceOfflineReason workspaceOfflineReason = workspaceOffline( lb );
            if ( workspaceOfflineReason != null ) {
1457 1458 1459 1460 1461 1462 1463 1464 1465
                // workspace offline
                for (WorkspaceBrowser browser : Jenkins.getInstance().getExtensionList(WorkspaceBrowser.class)) {
                    ws = browser.getWorkspace(this);
                    if (ws != null) {
                        return pollWithWorkspace(listener, scm, lb, ws, browser.getWorkspaceList());
                    }
                }

                // build now, or nothing will ever be built
K
Kohsuke Kawaguchi 已提交
1466 1467 1468 1469
                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.
1470 1471
                    listener.getLogger().print(Messages.AbstractProject_NoWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480
                    return NO_CHANGES;
                }
                listener.getLogger().println( ws==null
                    ? Messages.AbstractProject_WorkspaceOffline()
                    : Messages.AbstractProject_NoWorkspace());
                if (isInQueue()) {
                    listener.getLogger().println(Messages.AbstractProject_AwaitingBuildForWorkspace());
                    return NO_CHANGES;
                } else {
1481 1482
                    listener.getLogger().print(Messages.AbstractProject_NewBuildForWorkspace());
                    listener.getLogger().println( " (" + workspaceOfflineReason.name() + ")");
K
Kohsuke Kawaguchi 已提交
1483 1484 1485 1486
                    return BUILD_NOW;
                }
            } else {
                WorkspaceList l = lb.getBuiltOn().toComputer().getWorkspaceList();
1487 1488
                return pollWithWorkspace(listener, scm, lb, ws, l);

K
Kohsuke Kawaguchi 已提交
1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
            }
        } else {
            // polling without workspace
            LOGGER.fine("Polling SCM changes of " + getName());

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

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    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);
        Launcher launcher = ws.createLauncher(listener).decorateByEnv(getEnvironment(lb.getBuiltOn(),listener));
        try {
            LOGGER.fine("Polling SCM changes of " + getName());
            if (pollingBaseline==null) // see NOTE-NO-BASELINE above
                calcPollingBaseline(lb,launcher,listener);
            PollingResult r = scm.poll(this, launcher, ws, listener, pollingBaseline);
            pollingBaseline = r.remote;
            return r;
        } finally {
            lease.release();
        }
    }

1523 1524 1525 1526 1527 1528 1529
    enum WorkspaceOfflineReason {
        nonexisting_workspace,
        builton_node_gone,
        builton_node_no_executors
    }

    private WorkspaceOfflineReason workspaceOffline(R build) throws IOException, InterruptedException {
1530 1531
        FilePath ws = build.getWorkspace();
        if (ws==null || !ws.exists()) {
1532
            return WorkspaceOfflineReason.nonexisting_workspace;
1533 1534 1535 1536
        }
        
        Node builtOn = build.getBuiltOn();
        if (builtOn == null) { // node built-on doesn't exist anymore
1537
            return WorkspaceOfflineReason.builton_node_gone;
1538 1539 1540
        }
        
        if (builtOn.toComputer() == null) { // node still exists, but has 0 executors - o.s.l.t.
1541
            return WorkspaceOfflineReason.builton_node_no_executors;
1542
        }
1543 1544

        return null;
1545
    }
1546

1547 1548
    /**
     * Returns true if this user has made a commit to this project.
1549
     *
1550 1551 1552
     * @since 1.191
     */
    public boolean hasParticipant(User user) {
1553 1554
        for( R build = getLastBuild(); build!=null; build=build.getPreviousBuild())
            if(build.hasParticipant(user))
1555 1556 1557 1558
                return true;
        return false;
    }

1559
    @Exported
1560 1561 1562 1563
    public SCM getScm() {
        return scm;
    }

1564
    public void setScm(SCM scm) throws IOException {
1565
        this.scm = scm;
1566
        save();
1567 1568
    }

1569 1570 1571
    /**
     * Adds a new {@link Trigger} to this {@link Project} if not active yet.
     */
1572
    public void addTrigger(Trigger<?> trigger) throws IOException {
1573
        addToList(trigger,triggers());
1574 1575
    }

1576
    public void removeTrigger(TriggerDescriptor trigger) throws IOException {
1577
        removeFromList(trigger,triggers());
1578 1579
    }

1580 1581 1582 1583
    protected final synchronized <T extends Describable<T>>
    void addToList( T item, List<T> collection ) throws IOException {
        for( int i=0; i<collection.size(); i++ ) {
            if(collection.get(i).getDescriptor()==item.getDescriptor()) {
1584
                // replace
1585
                collection.set(i,item);
1586 1587 1588 1589 1590 1591 1592
                save();
                return;
            }
        }
        // add
        collection.add(item);
        save();
1593
        updateTransientActions();
1594 1595
    }

1596 1597 1598 1599
    protected final synchronized <T extends Describable<T>>
    void removeFromList(Descriptor<T> item, List<T> collection) throws IOException {
        for( int i=0; i< collection.size(); i++ ) {
            if(collection.get(i).getDescriptor()==item) {
1600 1601 1602
                // found it
                collection.remove(i);
                save();
1603
                updateTransientActions();
1604 1605 1606 1607 1608
                return;
            }
        }
    }

C
Christoph Kutzinski 已提交
1609
    @SuppressWarnings("unchecked")
1610
    public synchronized Map<TriggerDescriptor,Trigger> getTriggers() {
1611
        return (Map)Descriptor.toMap(triggers());
1612 1613
    }

1614
    /**
1615
     * Gets the specific trigger, or null if the propert is not configured for this job.
1616 1617
     */
    public <T extends Trigger> T getTrigger(Class<T> clazz) {
1618
        for (Trigger p : triggers()) {
1619
            if(clazz.isInstance(p))
1620 1621 1622 1623 1624
                return clazz.cast(p);
        }
        return null;
    }

1625 1626 1627 1628 1629
//
//
// fingerprint related
//
//
1630 1631 1632 1633 1634 1635
    /**
     * True if the builds of this project produces {@link Fingerprint} records.
     */
    public abstract boolean isFingerprintConfigured();

    /**
1636 1637
     * Gets the other {@link AbstractProject}s that should be built
     * when a build of this project is completed.
1638
     */
K
kohsuke 已提交
1639
    @Exported
1640
    public final List<AbstractProject> getDownstreamProjects() {
1641
        return Jenkins.getInstance().getDependencyGraph().getDownstream(this);
1642
    }
1643

K
kohsuke 已提交
1644
    @Exported
1645
    public final List<AbstractProject> getUpstreamProjects() {
1646
        return Jenkins.getInstance().getDependencyGraph().getUpstream(this);
K
kohsuke 已提交
1647 1648
    }

K
kohsuke 已提交
1649
    /**
1650 1651 1652 1653
     * Returns only those upstream projects that defines {@link BuildTrigger} to this project.
     * This is a subset of {@link #getUpstreamProjects()}
     *
     * @return A List of upstream projects that has a {@link BuildTrigger} to this project.
K
kohsuke 已提交
1654 1655 1656
     */
    public final List<AbstractProject> getBuildTriggerUpstreamProjects() {
        ArrayList<AbstractProject> result = new ArrayList<AbstractProject>();
1657 1658
        for (AbstractProject<?,?> ap : getUpstreamProjects()) {
            BuildTrigger buildTrigger = ap.getPublishersList().get(BuildTrigger.class);
1659
            if (buildTrigger != null)
1660
                if (buildTrigger.getChildProjects(ap).contains(this))
1661
                    result.add(ap);
1662
        }        
K
kohsuke 已提交
1663
        return result;
1664 1665
    }    
    
K
kohsuke 已提交
1666 1667
    /**
     * Gets all the upstream projects including transitive upstream projects.
1668
     *
K
kohsuke 已提交
1669 1670 1671
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveUpstreamProjects() {
1672
        return Jenkins.getInstance().getDependencyGraph().getTransitiveUpstream(this);
K
kohsuke 已提交
1673 1674 1675
    }

    /**
1676 1677
     * Gets all the downstream projects including transitive downstream projects.
     *
K
kohsuke 已提交
1678 1679 1680
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveDownstreamProjects() {
1681
        return Jenkins.getInstance().getDependencyGraph().getTransitiveDownstream(this);
1682 1683 1684 1685 1686
    }

    /**
     * Gets the dependency relationship map between this project (as the source)
     * and that project (as the sink.)
1687 1688 1689 1690
     *
     * @return
     *      can be empty but not null. build number of this project to the build
     *      numbers of that project.
1691 1692
     */
    public SortedMap<Integer, RangeSet> getRelationship(AbstractProject that) {
1693
        TreeMap<Integer,RangeSet> r = new TreeMap<Integer,RangeSet>(REVERSE_INTEGER_COMPARATOR);
1694 1695 1696 1697 1698 1699 1700 1701 1702

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

        return r;
    }

    /**
     * Helper method for getDownstreamRelationship.
1703 1704
     *
     * For each given build, find the build number range of the given project and put that into the map.
1705
     */
1706
    private void checkAndRecord(AbstractProject that, TreeMap<Integer, RangeSet> r, Collection<R> builds) {
1707 1708
        for (R build : builds) {
            RangeSet rs = build.getDownstreamRelationship(that);
1709
            if(rs==null || rs.isEmpty())
1710 1711 1712 1713 1714
                continue;

            int n = build.getNumber();

            RangeSet value = r.get(n);
1715 1716
            if(value==null)
                r.put(n,rs);
1717 1718 1719 1720 1721
            else
                value.add(rs);
        }
    }

1722 1723 1724 1725 1726 1727
    /**
     * Builds the dependency graph.
     * @see DependencyGraph
     */
    protected abstract void buildDependencyGraph(DependencyGraph graph);

1728
    @Override
K
kohsuke 已提交
1729 1730
    protected SearchIndexBuilder makeSearchIndex() {
        SearchIndexBuilder sib = super.makeSearchIndex();
1731
        if(isBuildable() && hasPermission(Jenkins.ADMINISTER))
1732
            sib.add("build","build");
K
kohsuke 已提交
1733 1734 1735
        return sib;
    }

1736 1737
    @Override
    protected HistoryWidget createHistoryWidget() {
1738
        return new BuildHistoryWidget<R>(this,builds,HISTORY_ADAPTER);
1739
    }
1740
    
K
kohsuke 已提交
1741
    public boolean isParameterized() {
1742
        return getProperty(ParametersDefinitionProperty.class) != null;
K
kohsuke 已提交
1743
    }
1744

1745 1746 1747 1748 1749
//
//
// actions
//
//
1750 1751 1752
    /**
     * Schedules a new build command.
     */
1753 1754
    public void doBuild( StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay ) throws IOException, ServletException {
        if (delay==null)    delay=new TimeDuration(getQuietPeriod());
1755

K
kohsuke 已提交
1756 1757
        // if a build is parameterized, let that take over
        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
J
Jesse Glick 已提交
1758 1759 1760 1761 1762 1763 1764 1765
        if (pp != null && !req.getMethod().equals("POST")) {
            // show the parameter entry form.
            req.getView(pp, "index.jelly").forward(req, rsp);
            return;
        }

        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);

K
kohsuke 已提交
1766
        if (pp != null) {
1767
            pp._doBuild(req,rsp,delay);
K
kohsuke 已提交
1768 1769 1770
            return;
        }

1771 1772 1773
        if (!isBuildable())
            throw HttpResponses.error(SC_INTERNAL_SERVER_ERROR,new IOException(getFullName()+" is not buildable"));

1774
        Jenkins.getInstance().getQueue().schedule(this, (int)delay.getTime(), getBuildCause(req));
J
Jesse Glick 已提交
1775
        rsp.sendRedirect(".");
1776 1777 1778 1779 1780 1781
    }

    /**
     * Computes the build cause, using RemoteCause or UserCause as appropriate.
     */
    /*package*/ CauseAction getBuildCause(StaplerRequest req) {
1782 1783
        Cause cause;
        if (authToken != null && authToken.getToken() != null && req.getParameter("token") != null) {
1784 1785
            // Optional additional cause text when starting via token
            String causeText = req.getParameter("cause");
1786
            cause = new RemoteCause(req.getRemoteAddr(), causeText);
1787
        } else {
1788
            cause = new UserIdCause();
1789
        }
1790
        return new CauseAction(cause);
1791 1792 1793 1794
    }

    /**
     * Computes the delay by taking the default value and the override in the request parameter into the account.
1795 1796 1797
     *
     * @deprecated as of 1.488
     *      Inject {@link TimeDuration}.
1798 1799
     */
    public int getDelay(StaplerRequest req) throws ServletException {
1800
        String delay = req.getParameter("delay");
1801 1802 1803 1804 1805 1806 1807 1808 1809
        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);
1810
        }
1811
    }
1812

1813 1814 1815 1816
    /**
     * Supports build trigger with parameters via an HTTP GET or POST.
     * Currently only String parameters are supported.
     */
1817
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException {
1818 1819 1820 1821
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);

        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
        if (pp != null) {
1822
            pp.buildWithParameters(req,rsp,delay);
1823 1824 1825 1826 1827
        } else {
        	throw new IllegalStateException("This build is not parameterized!");
        }
    	
    }
1828 1829 1830 1831

    /**
     * Schedules a new SCM polling command.
     */
1832
    public void doPolling( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1833 1834
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);
        schedulePolling();
J
Jesse Glick 已提交
1835
        rsp.sendRedirect(".");
1836 1837 1838 1839 1840
    }

    /**
     * Cancels a scheduled build.
     */
J
Jesse Glick 已提交
1841
    @RequirePOST
1842
    public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1843
        checkPermission(ABORT);
1844

1845
        Jenkins.getInstance().getQueue().cancel(this);
1846 1847 1848
        rsp.forwardToPreviousPage(req);
    }

1849 1850 1851 1852
    /**
     * Deletes this project.
     */
    @Override
1853
    @RequirePOST
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
    public void doDoDelete(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, InterruptedException {
        delete();
        if (req == null || rsp == null)
            return;
        View view = req.findAncestorObject(View.class);
        if (view == null)
            rsp.sendRedirect2(req.getContextPath() + '/' + getParent().getUrl());
        else 
            rsp.sendRedirect2(req.getContextPath() + '/' + view.getUrl());
    }
    
1865
    @Override
1866 1867
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
        super.submit(req,rsp);
1868
        JSONObject json = req.getSubmittedForm();
1869

1870
        makeDisabled(req.getParameter("disable")!=null);
1871 1872

        jdk = req.getParameter("jdk");
1873
        if(req.getParameter("hasCustomQuietPeriod")!=null) {
1874 1875 1876 1877
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));
        } else {
            quietPeriod = null;
        }
1878 1879
        if(req.getParameter("hasCustomScmCheckoutRetryCount")!=null) {
            scmCheckoutRetryCount = Integer.parseInt(req.getParameter("scmCheckoutRetryCount"));
S
 
shinodkm 已提交
1880
        } else {
1881
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1882
        }
1883
        blockBuildWhenDownstreamBuilding = req.getParameter("blockBuildWhenDownstreamBuilding")!=null;
1884 1885
        blockBuildWhenUpstreamBuilding = req.getParameter("blockBuildWhenUpstreamBuilding")!=null;

1886
        if(req.hasParameter("customWorkspace")) {
1887
            customWorkspace = Util.fixEmptyAndTrim(req.getParameter("customWorkspace.directory"));
1888 1889 1890
        } else {
            customWorkspace = null;
        }
1891 1892 1893 1894 1895 1896 1897

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

1898
        
1899
        if(req.getParameter("hasSlaveAffinity")!=null) {
1900
            assignedNode = Util.fixEmptyAndTrim(req.getParameter("_.assignedLabelString"));
1901 1902 1903
        } else {
            assignedNode = null;
        }
1904
        canRoam = assignedNode==null;
1905

1906
        concurrentBuild = req.getSubmittedForm().has("concurrentBuild");
K
kohsuke 已提交
1907

1908
        authToken = BuildAuthorizationToken.create(req);
1909

K
kohsuke 已提交
1910
        setScm(SCMS.parseSCM(req,this));
1911

1912
        for (Trigger t : triggers())
1913
            t.stop();
1914
        triggers = buildDescribable(req, Trigger.for_(this));
1915
        for (Trigger t : triggers)
1916
            t.start(this,true);
1917 1918
    }

K
kohsuke 已提交
1919 1920 1921 1922 1923 1924 1925 1926 1927
    /**
     * @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)
1928
        throws FormException, ServletException {
1929

1930
        JSONObject data = req.getSubmittedForm();
1931
        List<T> r = new Vector<T>();
1932
        for (Descriptor<T> d : descriptors) {
1933 1934 1935
            String safeName = d.getJsonSafeClassName();
            if (req.getParameter(safeName) != null) {
                T instance = d.newInstance(req, data.getJSONObject(safeName));
1936
                r.add(instance);
1937 1938
            }
        }
1939
        return r;
1940 1941 1942 1943 1944
    }

    /**
     * Serves the workspace files.
     */
1945
    public DirectoryBrowserSupport doWs( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, InterruptedException {
1946
        checkPermission(AbstractProject.WORKSPACE);
K
kohsuke 已提交
1947
        FilePath ws = getSomeWorkspace();
1948
        if ((ws == null) || (!ws.exists())) {
1949
            // if there's no workspace, report a nice error message
1950 1951 1952 1953
            // 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.
1954
            req.getView(this,"noWorkspace.jelly").forward(req,rsp);
1955
            return null;
1956
        } else {
1957
            return new DirectoryBrowserSupport(this, ws, getDisplayName()+" workspace", "folder.png", true);
1958 1959
        }
    }
1960

1961 1962 1963
    /**
     * Wipes out the workspace.
     */
1964
    public HttpResponse doDoWipeOutWorkspace() throws IOException, ServletException, InterruptedException {
1965
        checkPermission(Functions.isWipeOutPermissionEnabled() ? WIPEOUT : BUILD);
1966 1967 1968 1969
        R b = getSomeBuildWithWorkspace();
        FilePath ws = b!=null ? b.getWorkspace() : null;
        if (ws!=null && getScm().processWorkspaceBeforeDeletion(this, ws, b.getBuiltOn())) {
            ws.deleteRecursive();
1970 1971 1972
            for (WorkspaceListener wl : WorkspaceListener.all()) {
                wl.afterDelete(this);
            }
1973 1974 1975 1976
            return new HttpRedirect(".");
        } else {
            // If we get here, that means the SCM blocked the workspace deletion.
            return new ForwardToView(this,"wipeOutWorkspaceBlocked.jelly");
1977
        }
1978 1979
    }

1980
    @CLIMethod(name="disable-job")
1981
    @RequirePOST
1982
    public HttpResponse doDisable() throws IOException, ServletException {
1983 1984
        checkPermission(CONFIGURE);
        makeDisabled(true);
1985
        return new HttpRedirect(".");
1986 1987
    }

1988
    @CLIMethod(name="enable-job")
1989
    @RequirePOST
1990
    public HttpResponse doEnable() throws IOException, ServletException {
1991 1992
        checkPermission(CONFIGURE);
        makeDisabled(false);
1993
        return new HttpRedirect(".");
1994 1995
    }

K
kohsuke 已提交
1996 1997 1998
    /**
     * RSS feed for changes in this project.
     */
1999
    public void doRssChangelog(  StaplerRequest req, StaplerResponse rsp  ) throws IOException, ServletException {
K
kohsuke 已提交
2000 2001 2002 2003 2004 2005 2006 2007 2008
        class FeedItem {
            ChangeLogSet.Entry e;
            int idx;

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

2009
            AbstractBuild<?,?> getBuild() {
K
kohsuke 已提交
2010 2011 2012 2013 2014 2015
                return e.getParent().build;
            }
        }

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

2016 2017 2018 2019
        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 已提交
2020 2021
        }

2022 2023 2024 2025 2026 2027 2028
        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 已提交
2029

2030 2031 2032
                public String getEntryUrl(FeedItem item) {
                    return item.getBuild().getUrl()+"changes#detail"+item.idx;
                }
K
kohsuke 已提交
2033

2034 2035 2036
                public String getEntryID(FeedItem item) {
                    return getEntryUrl(item);
                }
K
kohsuke 已提交
2037

2038 2039 2040 2041 2042 2043
                public String getEntryDescription(FeedItem item) {
                    StringBuilder buf = new StringBuilder();
                    for(String path : item.e.getAffectedPaths())
                        buf.append(path).append('\n');
                    return buf.toString();
                }
2044

2045 2046 2047
                public Calendar getEntryTimestamp(FeedItem item) {
                    return item.getBuild().getTimestamp();
                }
2048

2049
                public String getEntryAuthor(FeedItem entry) {
2050
                    return JenkinsLocationConfiguration.get().getAdminAddress();
2051 2052 2053
                }
            },
            req, rsp );
K
kohsuke 已提交
2054 2055
    }

2056 2057 2058 2059 2060 2061 2062
    /**
     * {@link AbstractProject} subtypes should implement this base class as a descriptor.
     *
     * @since 1.294
     */
    public static abstract class AbstractProjectDescriptor extends TopLevelItemDescriptor {
        /**
2063
         * {@link AbstractProject} subtypes can override this method to veto some {@link Descriptor}s
2064
         * from showing up on their configuration screen. This is often useful when you are building
2065 2066
         * a workflow/company specific project type, where you want to limit the number of choices
         * given to the users.
2067 2068
         *
         * <p>
2069 2070 2071 2072
         * 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}
2073 2074 2075 2076
         * to show up for the given {@link Project}.
         *
         * <p>
         * The default implementation returns true for everything.
2077 2078
         *
         * @see BuildStepDescriptor#isApplicable(Class) 
K
kohsuke 已提交
2079 2080
         * @see BuildWrapperDescriptor#isApplicable(AbstractProject) 
         * @see TriggerDescriptor#isApplicable(Item)
2081
         */
K
kohsuke 已提交
2082
        @Override
2083
        public boolean isApplicable(Descriptor descriptor) {
2084 2085
            return true;
        }
2086 2087

        public FormValidation doCheckAssignedLabelString(@QueryParameter String value) {
2088 2089
            if (Util.fixEmpty(value)==null)
                return FormValidation.ok(); // nothing typed yet
2090 2091 2092
            try {
                Label.parseExpression(value);
            } catch (ANTLRException e) {
S
Seiji Sogabe 已提交
2093 2094
                return FormValidation.error(e,
                        Messages.AbstractProject_AssignedLabelString_InvalidBooleanExpression(e.getMessage()));
2095
            }
2096 2097 2098 2099 2100 2101 2102 2103
            Label l = Jenkins.getInstance().getLabel(value);
            if (l.isEmpty()) {
                for (LabelAtom a : l.listAtoms()) {
                    if (a.isEmpty()) {
                        LabelAtom nearest = LabelAtom.findNearest(a.getName());
                        return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch_DidYouMean(a.getName(),nearest.getDisplayName()));
                    }
                }
S
Seiji Sogabe 已提交
2104
                return FormValidation.warning(Messages.AbstractProject_AssignedLabelString_NoMatch());
2105
            }
2106 2107
            return FormValidation.ok();
        }
2108

2109
        public FormValidation doCheckCustomWorkspace(@QueryParameter(value="customWorkspace.directory") String customWorkspace){
2110
        	if(Util.fixEmptyAndTrim(customWorkspace)==null)
S
Seiji Sogabe 已提交
2111
        		return FormValidation.error(Messages.AbstractProject_CustomWorkspaceEmpty());
2112 2113 2114 2115
        	else
        		return FormValidation.ok();
        }
        
2116 2117
        public AutoCompletionCandidates doAutoCompleteUpstreamProjects(@QueryParameter String value) {
            AutoCompletionCandidates candidates = new AutoCompletionCandidates();
2118
            List<Job> jobs = Jenkins.getInstance().getItems(Job.class);
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129
            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) {
2130
            AutoCompletionCandidates c = new AutoCompletionCandidates();
2131
            Set<Label> labels = Jenkins.getInstance().getLabels();
2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
            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;
        }

2144
        public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p) {
2145 2146 2147
            return SCMCheckoutStrategyDescriptor._for(p);
        }

2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
        /**
        * 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 已提交
2160
                ArrayList<String> terms = new ArrayList<String>();
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
                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;
            }
        }
2188 2189
    }

2190
    /**
2191
     * Finds a {@link AbstractProject} that has the name closest to the given name.
2192 2193
     */
    public static AbstractProject findNearest(String name) {
2194 2195 2196 2197 2198 2199 2200 2201 2202 2203
        return findNearest(name,Hudson.getInstance());
    }

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

        String nearest = EditDistance.findNearest(name, names);
2209
        return (AbstractProject)Jenkins.getInstance().getItem(nearest,context);
2210
    }
2211 2212 2213

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
2214
            return o2-o1;
2215 2216
        }
    };
2217

2218
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
2219

2220
    /**
2221
     * Permission to abort a build
2222
     */
2223
    public static final Permission ABORT = CANCEL;
2224

K
Kohsuke Kawaguchi 已提交
2225 2226 2227
    /**
     * Replaceable "Build Now" text.
     */
2228 2229
    public static final Message<AbstractProject> BUILD_NOW_TEXT = new Message<AbstractProject>();

2230 2231 2232 2233 2234 2235
    /**
     * Used for CLI binding.
     */
    @CLIResolver
    public static AbstractProject resolveForCLI(
            @Argument(required=true,metaVar="NAME",usage="Job name") String name) throws CmdLineException {
2236
        AbstractProject item = Jenkins.getInstance().getItemByFullName(name, AbstractProject.class);
2237 2238 2239 2240
        if (item==null)
            throw new CmdLineException(null,Messages.AbstractItem_NoSuchJobExists(name,AbstractProject.findNearest(name).getFullName()));
        return item;
    }
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259

    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. 
     *
2260
     * @since 1.410
2261 2262
     */
    public void setCustomWorkspace(String customWorkspace) throws IOException {
2263
        this.customWorkspace= Util.fixEmptyAndTrim(customWorkspace);
2264 2265
        save();
    }
2266
    
2267
}