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

K
kohsuke 已提交
26
import hudson.AbortException;
27
import hudson.CopyOnWrite;
28
import hudson.FeedAdapter;
29
import hudson.FilePath;
30
import hudson.Launcher;
31
import hudson.Util;
32
import hudson.cli.declarative.CLIMethod;
33
import hudson.cli.declarative.CLIResolver;
34
import hudson.diagnosis.OldDataMonitor;
K
kohsuke 已提交
35
import hudson.slaves.WorkspaceList;
M
mdonohue 已提交
36
import hudson.model.Cause.LegacyCodeCause;
37
import hudson.model.Cause.UserCause;
38
import hudson.model.Cause.RemoteCause;
39 40 41
import hudson.model.Descriptor.FormException;
import hudson.model.Fingerprint.RangeSet;
import hudson.model.RunMap.Constructor;
42
import hudson.model.Queue.WaitingItem;
K
kohsuke 已提交
43
import hudson.model.Queue.Executable;
44
import hudson.model.queue.CauseOfBlockage;
K
kohsuke 已提交
45
import hudson.scm.ChangeLogSet;
K
kohsuke 已提交
46
import hudson.scm.ChangeLogSet.Entry;
47
import hudson.scm.NullSCM;
48
import hudson.scm.SCM;
K
kohsuke 已提交
49
import hudson.scm.SCMS;
50 51 52 53
import hudson.scm.PollingResult;
import hudson.scm.SCMRevisionState;
import static hudson.scm.PollingResult.NO_CHANGES;
import static hudson.scm.PollingResult.BUILD_NOW;
54 55
import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;

J
jbq 已提交
56
import hudson.search.SearchIndexBuilder;
K
kohsuke 已提交
57
import hudson.security.Permission;
58
import hudson.tasks.BuildStep;
J
jbq 已提交
59
import hudson.tasks.BuildTrigger;
60
import hudson.tasks.Mailer;
61
import hudson.tasks.Publisher;
62
import hudson.tasks.BuildStepDescriptor;
K
kohsuke 已提交
63
import hudson.tasks.BuildWrapperDescriptor;
K
kohsuke 已提交
64
import hudson.triggers.SCMTrigger;
65
import hudson.triggers.Trigger;
66
import hudson.triggers.TriggerDescriptor;
67
import hudson.util.DescribableList;
68
import hudson.util.EditDistance;
S
 
shinodkm 已提交
69
import hudson.util.FormValidation;
K
kohsuke 已提交
70 71 72
import hudson.widgets.BuildHistoryWidget;
import hudson.widgets.HistoryWidget;
import net.sf.json.JSONObject;
73 74
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
75
import org.kohsuke.stapler.HttpResponses;
K
kohsuke 已提交
76 77 78
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
S
 
shinodkm 已提交
79
import org.kohsuke.stapler.QueryParameter;
80 81 82
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.ForwardToView;
83

K
kohsuke 已提交
84
import javax.servlet.ServletException;
85
import javax.servlet.http.HttpServletResponse;
86
import java.io.File;
87
import java.io.IOException;
K
kohsuke 已提交
88
import java.lang.reflect.InvocationTargetException;
K
kohsuke 已提交
89
import java.util.ArrayList;
90
import java.util.Arrays;
91
import java.util.Calendar;
92
import java.util.Collection;
J
jbq 已提交
93
import java.util.Collections;
94
import java.util.Comparator;
J
jbq 已提交
95
import java.util.HashSet;
96 97
import java.util.List;
import java.util.Map;
J
jbq 已提交
98
import java.util.Set;
99 100 101
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.Vector;
K
kohsuke 已提交
102
import java.util.concurrent.Future;
103 104
import java.util.logging.Level;
import java.util.logging.Logger;
105 106 107

/**
 * Base implementation of {@link Job}s that build software.
108
 *
109
 * For now this is primarily the common part of {@link Project} and MavenModule.
110
 *
111 112 113
 * @author Kohsuke Kawaguchi
 * @see AbstractBuild
 */
114
public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>> extends Job<P,R> implements BuildableItem {
115

116
    /**
117 118 119
     * {@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()}.
120
     */
K
kohsuke 已提交
121
    private volatile SCM scm = new NullSCM();
122

123 124 125 126 127
    /**
     * State returned from {@link SCM#poll(AbstractProject, Launcher, FilePath, TaskListener, SCMRevisionState)}.
     */
    private volatile transient SCMRevisionState pollingBaseline = null;

128 129 130
    /**
     * All the builds keyed by their build number.
     */
131
    protected transient /*almost final*/ RunMap<R> builds = new RunMap<R>();
132 133 134 135

    /**
     * The quiet period. Null to delegate to the system default.
     */
K
kohsuke 已提交
136
    private volatile Integer quietPeriod = null;
S
 
shinodkm 已提交
137 138
    
    /**
139
     * The retry count. Null to delegate to the system default.
S
 
shinodkm 已提交
140
     */
141
    private volatile Integer scmCheckoutRetryCount = null;
142 143

    /**
144 145 146 147 148 149 150
     * 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.
     *
151
     * @see #canRoam
152 153 154 155 156
     */
    private String assignedNode;

    /**
     * True if this project can be built on any node.
157
     *
158
     * <p>
159 160
     * This somewhat ugly flag combination is so that we can migrate
     * existing Hudson installations nicely.
161
     */
K
kohsuke 已提交
162
    private volatile boolean canRoam;
163 164 165 166

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

169 170 171 172 173 174
    /**
     * 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;

175
    /**
176 177 178
     * Identifies {@link JDK} to be used.
     * Null if no explicit configuration is required.
     *
179
     * <p>
180 181 182
     * Can't store {@link JDK} directly because {@link Hudson} and {@link Project}
     * are saved independently.
     *
183 184
     * @see Hudson#getJDK(String)
     */
K
kohsuke 已提交
185
    private volatile String jdk;
186

187
    /**
M
mindless 已提交
188
     * @deprecated since 2007-01-29.
189 190
     */
    private transient boolean enableRemoteTrigger;
191

K
kohsuke 已提交
192
    private volatile BuildAuthorizationToken authToken = null;
193

194 195 196
    /**
     * List of all {@link Trigger}s for this project.
     */
197
    protected List<Trigger<?>> triggers = new Vector<Trigger<?>>();
198

199 200
    /**
     * {@link Action}s contributed from subsidiary objects associated with
201 202 203 204
     * {@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.
205
     */
206 207
    @CopyOnWrite
    protected transient volatile List<Action> transientActions = new Vector<Action>();
208

K
kohsuke 已提交
209 210
    private boolean concurrentBuild;

211
    protected AbstractProject(ItemGroup parent, String name) {
212
        super(parent,name);
213

K
kohsuke 已提交
214
        if(!Hudson.getInstance().getNodes().isEmpty()) {
215
            // if a new job is configured with Hudson that already has slave nodes
216 217 218 219 220
            // make it roamable by default
            canRoam = true;
        }
    }

221
    @Override
222
    public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
223
        super.onLoad(parent, name);
224 225

        this.builds = new RunMap<R>();
226
        this.builds.load(this,new Constructor<R>() {
227 228 229 230 231
            public R create(File dir) throws IOException {
                return loadBuild(dir);
            }
        });

232 233 234
        // boolean! Can't tell if xml file contained false..
        if (enableRemoteTrigger) OldDataMonitor.report(this, "1.77");
        if(triggers==null) {
235
            // it didn't exist in < 1.28
236
            triggers = new Vector<Trigger<?>>();
237 238
            OldDataMonitor.report(this, "1.28");
        }
239
        for (Trigger t : triggers)
240
            t.start(this,false);
241 242
        if(scm==null)
            scm = new NullSCM(); // perhaps it was pointing to a plugin that no longer exists.
243

244 245
        if(transientActions==null)
            transientActions = new Vector<Action>();    // happens when loaded from disk
246
        updateTransientActions();
247 248
    }

249
    @Override
250
    protected void performDelete() throws IOException, InterruptedException {
K
kohsuke 已提交
251 252
        // prevent a new build while a delete operation is in progress
        makeDisabled(true);
253
        FilePath ws = getWorkspace();
254
        if(ws!=null) {
K
NPE fix  
kohsuke 已提交
255 256 257 258
            Node on = getLastBuiltOn();
            getScm().processWorkspaceBeforeDeletion(this, ws, on);
            if(on!=null)
                on.getFileSystemProvisioner().discardWorkspace(this,ws);
259
        }
K
kohsuke 已提交
260 261 262
        super.performDelete();
    }

K
kohsuke 已提交
263 264
    /**
     * Does this project perform concurrent builds?
K
kohsuke 已提交
265
     * @since 1.319
K
kohsuke 已提交
266
     */
K
kohsuke 已提交
267
    @Exported
K
kohsuke 已提交
268 269 270 271 272 273 274 275 276
    public boolean isConcurrentBuild() {
        return Hudson.CONCURRENT_BUILD && concurrentBuild;
    }

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

277
    /**
278 279
     * If this project is configured to be always built on this node,
     * return that {@link Node}. Otherwise null.
280
     */
281
    public Label getAssignedLabel() {
282
        if(canRoam)
283 284
            return null;

285
        if(assignedNode==null)
286 287
            return Hudson.getInstance().getSelfLabel();
        return Hudson.getInstance().getLabel(assignedNode);
288 289
    }

K
kohsuke 已提交
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
    /**
     * Sets the assigned label.
     */
    public void setAssignedLabel(Label l) throws IOException {
        if(l==null) {
            canRoam = true;
            assignedNode = null;
        } else {
            canRoam = false;
            if(l==Hudson.getInstance().getSelfLabel())  assignedNode = null;
            else                                        assignedNode = l.getName();
        }
        save();
    }

305 306 307 308 309 310 311
    /**
     * Assigns this job to the given node. A convenience method over {@link #setAssignedLabel(Label)}.
     */
    public void setAssignedNode(Node l) throws IOException {
        setAssignedLabel(l.getSelfLabel());
    }

312
    /**
313 314
     * Get the term used in the UI to represent this kind of {@link AbstractProject}.
     * Must start with a capital letter.
315 316 317
     */
    @Override
    public String getPronoun() {
318
        return Messages.AbstractProject_Pronoun();
319 320
    }

321 322 323 324 325
    /**
     * Returns the root project value.
     *
     * @return the root project value.
     */
326
    public AbstractProject getRootProject() {
327 328 329 330 331 332 333
        if (this.getParent() instanceof Hudson) {
            return this;
        } else {
            return ((AbstractProject) this.getParent()).getRootProject();
        }
    }

334 335
    /**
     * Gets the directory where the module is checked out.
336 337 338
     *
     * @return
     *      null if the workspace is on a slave that's not connected.
K
kohsuke 已提交
339
     * @deprecated as of 1.319
K
kohsuke 已提交
340 341 342 343 344
     *      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>
345
     *      If you are calling this method during a build from an executor, switch it to {@link AbstractBuild#getWorkspace()}.
K
kohsuke 已提交
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
     *      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() {
        Executor e = Executor.currentExecutor();
        if(e!=null) {
            Executable exe = e.getCurrentExecutable();
            if (exe instanceof AbstractBuild) {
                AbstractBuild b = (AbstractBuild) exe;
                if(b.getProject()==this)
                    return b.getWorkspace();
            }
        }
        R lb = getLastBuild();
        if(lb!=null)    return lb.getWorkspace();
        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 已提交
374
     * @since 1.319
375
     */
K
kohsuke 已提交
376
    public final FilePath getSomeWorkspace() {
377 378 379 380 381 382 383 384 385 386
        R b = getSomeBuildWithWorkspace();
        return b!=null ? b.getWorkspace() : null;
    }

    /**
     * Gets some build that has a live workspace.
     *
     * @return null if no such build exists.
     */
    public final R getSomeBuildWithWorkspace() {
K
kohsuke 已提交
387 388 389
        int cnt=0;
        for (R b = getLastBuild(); cnt<5 && b!=null; b=b.getPreviousBuild()) {
            FilePath ws = b.getWorkspace();
390
            if (ws!=null)   return b;
K
kohsuke 已提交
391 392 393
        }
        return null;
    }
394

395 396 397
    /**
     * Returns the root directory of the checked-out module.
     * <p>
398 399
     * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
     * and so on exists.
K
kohsuke 已提交
400
     *
K
kohsuke 已提交
401
     * @deprecated as of 1.319
K
kohsuke 已提交
402
     *      See {@link #getWorkspace()} for a migration strategy.
403 404
     */
    public FilePath getModuleRoot() {
K
kohsuke 已提交
405
        FilePath ws = getWorkspace();
406
        if(ws==null)    return null;
K
kohsuke 已提交
407
        return getScm().getModuleRoot(ws);
408 409
    }

S
stephenconnolly 已提交
410 411 412 413 414 415
    /**
     * 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 已提交
416
     *
K
kohsuke 已提交
417
     * @deprecated as of 1.319
K
kohsuke 已提交
418
     *      See {@link #getWorkspace()} for a migration strategy.
S
stephenconnolly 已提交
419 420 421 422 423
     */
    public FilePath[] getModuleRoots() {
        return getScm().getModuleRoots(getWorkspace());
    }

424
    public int getQuietPeriod() {
425
        return quietPeriod!=null ? quietPeriod : Hudson.getInstance().getQuietPeriod();
426
    }
S
 
shinodkm 已提交
427
    
428 429
    public int getScmCheckoutRetryCount() {
        return scmCheckoutRetryCount !=null ? scmCheckoutRetryCount : Hudson.getInstance().getScmCheckoutRetryCount();
S
 
shinodkm 已提交
430
    }
431 432 433

    // ugly name because of EL
    public boolean getHasCustomQuietPeriod() {
434
        return quietPeriod!=null;
435
    }
K
kohsuke 已提交
436 437 438 439

    /**
     * Sets the custom quiet period of this project, or revert to the global default if null is given. 
     */
440
    public void setQuietPeriod(Integer seconds) throws IOException {
K
kohsuke 已提交
441 442 443
        this.quietPeriod = seconds;
        save();
    }
S
 
shinodkm 已提交
444
    
445
    public boolean hasCustomScmCheckoutRetryCount(){
446
        return scmCheckoutRetryCount != null;
S
 
shinodkm 已提交
447
    }
448

449
    public boolean isBuildable() {
J
jpederzolli 已提交
450
        return !isDisabled() && !isHoldOffBuildUntilSave();
451 452
    }

453
    /**
454 455
     * Used in <tt>sidepanel.jelly</tt> to decide whether to display
     * the config/delete/build links.
456 457 458 459 460
     */
    public boolean isConfigurable() {
        return true;
    }

461
    public boolean blockBuildWhenUpstreamBuilding() {
462
        return blockBuildWhenUpstreamBuilding;
463 464
    }

465
    public void setBlockBuildWhenUpstreamBuilding(boolean b) throws IOException {
466 467
        blockBuildWhenUpstreamBuilding = b;
        save();
468 469
    }

470 471 472
    public boolean isDisabled() {
        return disabled;
    }
S
 
shinodkm 已提交
473 474 475 476 477
    
    /**
     * Validates the retry count Regex
     */
    public FormValidation doCheckRetryCount(@QueryParameter String value)throws IOException,ServletException{
478 479 480 481 482 483 484
        // 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 已提交
485
    }
486

487 488 489 490
    /**
     * Marks the build as disabled.
     */
    public void makeDisabled(boolean b) throws IOException {
491
        if(disabled==b)     return; // noop
492
        this.disabled = b;
K
bug fix  
kohsuke 已提交
493 494
        if(b)
            Hudson.getInstance().getQueue().cancel(this);
495 496 497
        save();
    }

498 499 500 501 502 503 504 505 506 507
    @CLIMethod(name="disable-job")
    public void disable() throws IOException {
        makeDisabled(true);
    }

    @CLIMethod(name="enable-job")
    public void enable() throws IOException {
        makeDisabled(false);
    }

K
kohsuke 已提交
508 509
    @Override
    public BallColor getIconColor() {
510
        if(isDisabled())
511
            return BallColor.DISABLED;
K
kohsuke 已提交
512 513 514
        else
            return super.getIconColor();
    }
515

516
    protected void updateTransientActions() {
517
        Vector<Action> ta = new Vector<Action>();
518

519 520
        for (JobProperty<? super P> p : properties)
            ta.addAll(p.getJobActions((P)this));
521

522 523 524 525
        for (TransientProjectActionFactory tpaf : TransientProjectActionFactory.all())
            ta.addAll(Util.fixNull(tpaf.createFor(this))); // be defensive against null

        transientActions = ta;
526 527
    }

528
    /**
529 530
     * Returns the live list of all {@link Publisher}s configured for this project.
     *
531
     * <p>
532 533
     * This method couldn't be called <tt>getPublishers()</tt> because existing methods
     * in sub-classes return different inconsistent types.
534
     */
535
    public abstract DescribableList<Publisher,Descriptor<Publisher>> getPublishersList();
536

K
kohsuke 已提交
537 538 539 540 541 542
    @Override
    public void addProperty(JobProperty<? super P> jobProp) throws IOException {
        super.addProperty(jobProp);
        updateTransientActions();
    }

543 544 545 546
    public List<ProminentProjectAction> getProminentActions() {
        List<Action> a = getActions();
        List<ProminentProjectAction> pa = new Vector<ProminentProjectAction>();
        for (Action action : a) {
547
            if(action instanceof ProminentProjectAction)
548 549 550 551 552
                pa.add((ProminentProjectAction) action);
        }
        return pa;
    }

553
    @Override
554
    public void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, FormException {
555
        super.doConfigSubmit(req,rsp);
556

557 558
        updateTransientActions();

559
        Set<AbstractProject> upstream = Collections.emptySet();
560 561
        if(req.getParameter("pseudoUpstreamTrigger")!=null) {
            upstream = new HashSet<AbstractProject>(Items.fromNameList(req.getParameter("upstreamProjects"),AbstractProject.class));
562 563 564 565 566 567 568 569 570
        }

        // dependency setting might have been changed by the user, so rebuild.
        Hudson.getInstance().rebuildDependencyGraph();

        // 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

571
        for (AbstractProject<?,?> p : Hudson.getInstance().getAllItems(AbstractProject.class)) {
572 573
            // Don't consider child projects such as MatrixConfiguration:
            if (!p.isConfigurable()) continue;
574
            boolean isUpstream = upstream.contains(p);
575 576 577
            synchronized(p) {
                // does 'p' include us in its BuildTrigger? 
                DescribableList<Publisher,Descriptor<Publisher>> pl = p.getPublishersList();
578
                BuildTrigger trigger = pl.get(BuildTrigger.class);
579 580 581
                List<AbstractProject> newChildProjects = trigger == null ? new ArrayList<AbstractProject>():trigger.getChildProjects();
                if(isUpstream) {
                    if(!newChildProjects.contains(this))
582 583 584 585 586
                        newChildProjects.add(this);
                } else {
                    newChildProjects.remove(this);
                }

587
                if(newChildProjects.isEmpty()) {
588
                    pl.remove(BuildTrigger.class);
589
                } else {
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
                    // 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)
                            combinedChildren.addAll(bt.getChildProjects());
                        existing = new BuildTrigger(new ArrayList<AbstractProject>(combinedChildren),existingList.get(0).getThreshold());
                        pl.add(existing);
                        break;
                    }

613 614
                    if(existing!=null && existing.hasSame(newChildProjects))
                        continue;   // no need to touch
615
                    pl.replace(new BuildTrigger(newChildProjects,
616
                        existing==null?Result.SUCCESS:existing.getThreshold()));
617 618 619 620 621 622 623 624 625 626 627
                }
            }
        }

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

        // this is to reflect the upstream build adjustments done above
        Hudson.getInstance().rebuildDependencyGraph();
    }

M
mdonohue 已提交
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
	/**
	 * @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());
    }
    
644 645
    /**
     * Schedules a build of this project.
646 647 648 649 650
     *
     * @return
     *      true if the project is actually added to the queue.
     *      false if the queue contained it and therefore the add()
     *      was noop
651
     */
M
mdonohue 已提交
652 653
    public boolean scheduleBuild(Cause c) {
        return scheduleBuild(getQuietPeriod(), c);
K
kohsuke 已提交
654 655
    }

M
mdonohue 已提交
656
    public boolean scheduleBuild(int quietPeriod, Cause c) {
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
        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) {
673 674 675 676 677 678
        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.
679 680 681
     *
     * @param actions
     *      For the convenience of the caller, this array can contain null, and those will be silently ignored.
682 683
     */
    public Future<R> scheduleBuild2(int quietPeriod, Cause c, Action... actions) {
684
        if (!isBuildable())
685
            return null;
686

K
kohsuke 已提交
687
        List<Action> queueActions = new ArrayList<Action>(Arrays.asList(actions));
688 689 690 691
        if (isParameterized() && Util.filter(queueActions, ParametersAction.class).isEmpty()) {
            queueActions.add(new ParametersAction(getDefaultParametersValues()));
        }

S
sogabe 已提交
692 693 694 695
        if (c != null) {
            queueActions.add(new CauseAction(c));
        }

696 697 698 699
        WaitingItem i = Hudson.getInstance().getQueue().schedule(this, quietPeriod, queueActions);
        if(i!=null)
            return (Future)i.getFuture();
        return null;
700 701 702 703 704 705
    }

    private List<ParameterValue> getDefaultParametersValues() {
        ParametersDefinitionProperty paramDefProp = getProperty(ParametersDefinitionProperty.class);
        ArrayList<ParameterValue> defValues = new ArrayList<ParameterValue>();
        
M
mindless 已提交
706 707 708
        /*
         * This check is made ONLY if someone will call this method even if isParametrized() is false.
         */
709 710 711 712 713 714 715 716 717 718 719 720 721
        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 已提交
722 723
    }

724
    /**
725 726 727 728
     * Schedules a build, and returns a {@link Future} object
     * to wait for the completion of the build.
     *
     * <p>
729
     * Production code shouldn't be using this, but for tests this is very convenient, so this isn't marked
730
     * as deprecated.
731
     */
M
mdonohue 已提交
732
    public Future<R> scheduleBuild2(int quietPeriod) {
733
        return scheduleBuild2(quietPeriod, new LegacyCodeCause());
M
mdonohue 已提交
734 735
    }
    
K
kohsuke 已提交
736
    /**
737 738
     * Schedules a build of this project, and returns a {@link Future} object
     * to wait for the completion of the build.
K
kohsuke 已提交
739
     */
K
kohsuke 已提交
740
    public Future<R> scheduleBuild2(int quietPeriod, Cause c) {
741 742 743
        return scheduleBuild2(quietPeriod, c, new Action[0]);
    }

744 745 746 747
    /**
     * Schedules a polling of this project.
     */
    public boolean schedulePolling() {
748
        if(isDisabled())    return false;
749
        SCMTrigger scmt = getTrigger(SCMTrigger.class);
750
        if(scmt==null)      return false;
751 752 753 754
        scmt.run();
        return true;
    }

755 756 757 758 759
    /**
     * Returns true if the build is in the queue.
     */
    @Override
    public boolean isInQueue() {
760
        return Hudson.getInstance().getQueue().contains(this);
761 762
    }

K
kohsuke 已提交
763 764 765 766 767
    @Override
    public Queue.Item getQueueItem() {
        return Hudson.getInstance().getQueue().getItem(this);
    }

K
kohsuke 已提交
768 769 770
    /**
     * Gets the JDK that this project is configured with, or null.
     */
771
    public JDK getJDK() {
772
        return Hudson.getInstance().getJDK(jdk);
773 774 775 776 777
    }

    /**
     * Overwrites the JDK setting.
     */
K
kohsuke 已提交
778
    public void setJDK(JDK jdk) throws IOException {
779 780 781 782
        this.jdk = jdk.getName();
        save();
    }

783 784
    public BuildAuthorizationToken getAuthToken() {
        return authToken;
785 786 787 788 789 790 791 792 793 794
    }

    public SortedMap<Integer, ? extends R> _getRuns() {
        return builds.getView();
    }

    public void removeRun(R run) {
        this.builds.remove(run);
    }

795 796 797 798 799
    /**
     * Determines Class&lt;R>.
     */
    protected abstract Class<R> getBuildClass();

H
huybrechts 已提交
800
    // keep track of the previous time we started a build
801
    private transient long lastBuildStartTime;
H
huybrechts 已提交
802
    
803 804 805
    /**
     * Creates a new build of this project for immediate execution.
     */
H
huybrechts 已提交
806 807 808 809 810 811 812 813 814 815 816
    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();
817
        try {
818
            R lastBuild = getBuildClass().getConstructor(getClass()).newInstance(this);
819 820 821 822 823 824 825
            builds.put(lastBuild);
            return lastBuild;
        } catch (InstantiationException e) {
            throw new Error(e);
        } catch (IllegalAccessException e) {
            throw new Error(e);
        } catch (InvocationTargetException e) {
826
            throw handleInvocationTargetException(e);
827 828 829 830
        } catch (NoSuchMethodException e) {
            throw new Error(e);
        }
    }
831

832
    private IOException handleInvocationTargetException(InvocationTargetException e) {
833
        Throwable t = e.getTargetException();
834 835 836
        if(t instanceof Error)  throw (Error)t;
        if(t instanceof RuntimeException)   throw (RuntimeException)t;
        if(t instanceof IOException)    return (IOException)t;
837 838 839
        throw new Error(t);
    }

840 841 842
    /**
     * Loads an existing build record from disk.
     */
843 844
    protected R loadBuild(File dir) throws IOException {
        try {
845
            return getBuildClass().getConstructor(getClass(),File.class).newInstance(this,dir);
846 847 848 849 850
        } catch (InstantiationException e) {
            throw new Error(e);
        } catch (IllegalAccessException e) {
            throw new Error(e);
        } catch (InvocationTargetException e) {
851
            throw handleInvocationTargetException(e);
852 853 854 855
        } catch (NoSuchMethodException e) {
            throw new Error(e);
        }
    }
856

K
kohsuke 已提交
857 858
    /**
     * {@inheritDoc}
859
     *
K
kohsuke 已提交
860 861
     * <p>
     * Note that this method returns a read-only view of {@link Action}s.
862
     * {@link BuildStep}s and others who want to add a project action
863
     * should do so by implementing {@link BuildStep#getProjectActions(AbstractProject)}.
864 865
     *
     * @see TransientProjectActionFactory
K
kohsuke 已提交
866
     */
867
    @Override
868 869 870 871
    public synchronized List<Action> getActions() {
        // add all the transient actions, too
        List<Action> actions = new Vector<Action>(super.getActions());
        actions.addAll(transientActions);
872
        // return the read only list to cause a failure on plugins who try to add an action here
K
kohsuke 已提交
873
        return Collections.unmodifiableList(actions);
874 875
    }

876 877
    /**
     * Gets the {@link Node} where this project was last built on.
878 879 880 881
     *
     * @return
     *      null if no information is available (for example,
     *      if no build was done yet.)
882 883 884 885
     */
    public Node getLastBuiltOn() {
        // where was it built on?
        AbstractBuild b = getLastBuild();
886
        if(b==null)
887 888 889 890 891
            return null;
        else
            return b.getBuiltOn();
    }

892
    /**
893
     * {@inheritDoc}
894
     *
895
     * <p>
896
     * A project must be blocked if its own previous build is in progress,
897 898
     * or if the blockBuildWhenUpstreamBuilding option is true and an upstream
     * project is building, but derived classes can also check other conditions.
899
     */
900
    public boolean isBuildBlocked() {
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
        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;
917 918
        }

919 920 921 922 923 924 925 926
        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);
        }
927 928
    }

929 930 931 932 933 934 935 936 937 938 939 940 941
    /**
     * 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;
        }

        public String getShortDescription() {
            return Messages.AbstractProject_UpstreamBuildInProgress(up.getName());
        }
942 943
    }

944 945 946 947 948 949 950 951 952 953
    public CauseOfBlockage getCauseOfBlockage() {
        if (isBuilding() && !isConcurrentBuild())
            return new BecauseOfBuildInProgress(getLastBuild());
        if (blockBuildWhenUpstreamBuilding()) {
            AbstractProject<?,?> bup = getBuildingUpstream();
            if (bup!=null)
                return new BecauseOfUpstreamBuildInProgress(bup);
        }
        return null;
    }
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970

    /**
     * Returns the project if any of the upstream project (or itself) is either
     * 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.)
     */
    protected AbstractProject getBuildingUpstream() {
    	DependencyGraph graph = Hudson.getInstance().getDependencyGraph();
        Set<AbstractProject> tups = graph.getTransitiveUpstream(this);
        tups.add(this);
        for (AbstractProject tup : tups) {
            if(tup!=this && (tup.isBuilding() || tup.isInQueue()))
                return tup;
        }
        return null;
971 972 973 974
    }

    public final long getEstimatedDuration() {
        AbstractBuild b = getLastSuccessfulBuild();
975
        if(b==null)     return -1;
976 977

        long duration = b.getDuration();
978
        if(duration==0) return -1;
979 980 981 982

        return duration;
    }

983
    public R createExecutable() throws IOException {
984
        if(isDisabled())    return null;
985
        return newBuild();
986 987
    }

988 989 990 991
    public void checkAbortPermission() {
        checkPermission(AbstractProject.ABORT);
    }

K
kohsuke 已提交
992 993 994 995
    public boolean hasAbortPermission() {
        return hasPermission(AbstractProject.ABORT);
    }

996 997
    /**
     * Gets the {@link Resource} that represents the workspace of this project.
998
     * Useful for locking and mutual exclusion control.
K
kohsuke 已提交
999
     *
K
kohsuke 已提交
1000
     * @deprecated as of 1.319
K
kohsuke 已提交
1001 1002 1003 1004 1005 1006 1007
     *      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}.
1008 1009
     */
    public Resource getWorkspaceResource() {
1010
        return new Resource(getFullDisplayName()+" workspace");
1011 1012 1013 1014 1015 1016
    }

    /**
     * List of necessary resources to perform the build of this project.
     */
    public ResourceList getResourceList() {
1017
        final Set<ResourceActivity> resourceActivities = getResourceActivities();
1018
        final List<ResourceList> resourceLists = new ArrayList<ResourceList>(1 + resourceActivities.size());
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
        for (ResourceActivity activity : resourceActivities) {
            if (activity != this && activity != null) {
                // defensive infinite recursion and null check
                resourceLists.add(activity.getResourceList());
            }
        }
        return ResourceList.union(resourceLists);
    }

    /**
1029 1030
     * 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.
1031 1032
     */
    protected Set<ResourceActivity> getResourceActivities() {
K
kohsuke 已提交
1033
        return Collections.emptySet();
1034 1035
    }

1036
    public boolean checkout(AbstractBuild build, Launcher launcher, BuildListener listener, File changelogFile) throws IOException, InterruptedException {
1037
        SCM scm = getScm();
1038 1039
        if(scm==null)
            return true;    // no SCM
1040

1041 1042
        FilePath workspace = build.getWorkspace();
        workspace.mkdirs();
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
        
        boolean r = scm.checkout(build, launcher, workspace, listener, changelogFile);
        calcPollingBaseline(build, launcher, listener);
        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 {
1056
                baseline = getScm()._calcRevisionsFromBuild(build, launcher, listener);
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
            } 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;
    }

    /**
     * For reasons I don't understand, if I inline this method, AbstractMethodError escapes try/catch block.
     */
    private SCMRevisionState safeCalcRevisionsFromBuild(AbstractBuild build, Launcher launcher, TaskListener listener) throws IOException, InterruptedException {
1070
        return getScm()._calcRevisionsFromBuild(build, launcher, listener);
1071 1072 1073 1074
    }

    /**
     * Checks if there's any update in SCM, and returns true if any is found.
1075
     *
1076 1077
     * @deprecated as of 1.346
     *      Use {@link #poll(TaskListener)} instead.
1078
     */
1079
    public boolean pollSCMChanges( TaskListener listener ) {
1080 1081 1082 1083 1084 1085 1086
        return poll(listener).hasChanges();
    }

    /**
     * Checks if there's any update in SCM, and returns true if any is found.
     *
     * <p>
1087 1088
     * The implementation is responsible for ensuring mutual exclusion between polling and builds
     * if necessary.
1089 1090 1091 1092
     *
     * @since 1.345
     */
    public PollingResult poll( TaskListener listener ) {
1093
        SCM scm = getScm();
1094
        if(scm==null) {
K
i18n  
kohsuke 已提交
1095
            listener.getLogger().println(Messages.AbstractProject_NoSCM());
1096
            return NO_CHANGES;
1097
        }
1098
        if(isDisabled()) {
K
i18n  
kohsuke 已提交
1099
            listener.getLogger().println(Messages.AbstractProject_Disabled());
1100 1101 1102 1103 1104
            return NO_CHANGES;
        }

        R lb = getLastBuild();
        if (lb==null) {
1105
            listener.getLogger().println(Messages.AbstractProject_NoBuilds());
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
            return BUILD_NOW;
        }

        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.
1122 1123 1124
        }

        try {
K
kohsuke 已提交
1125 1126
            if(scm.requiresWorkspaceForPolling()) {
                // lock the workspace of the last build
1127
                FilePath ws=lb.getWorkspace();
K
kohsuke 已提交
1128 1129 1130 1131 1132 1133 1134 1135

                if (ws==null || !ws.exists()) {
                    // workspace offline. build now, or nothing will ever be built
                    Label label = getAssignedLabel();
                    if (label != null && label.isSelfLabel()) {
                        // if the build is fixed on a node, then attempting a build will do us
                        // no good. We should just wait for the slave to come back.
                        listener.getLogger().println(Messages.AbstractProject_NoWorkspace());
1136
                        return NO_CHANGES;
K
kohsuke 已提交
1137
                    }
1138 1139 1140
                    listener.getLogger().println( ws==null
                        ? Messages.AbstractProject_WorkspaceOffline()
                        : Messages.AbstractProject_NoWorkspace());
K
kohsuke 已提交
1141
                    listener.getLogger().println(Messages.AbstractProject_NewBuildForWorkspace());
1142
                    return BUILD_NOW;
K
kohsuke 已提交
1143 1144
                } else {
                    WorkspaceList l = lb.getBuiltOn().toComputer().getWorkspaceList();
1145
                    // if doing non-concurrent build, acquire a workspace in a way that causes builds to block for this workspace.
1146 1147 1148 1149 1150
                    // 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
1151
                    WorkspaceList.Lease lease = l.acquire(ws, !concurrentBuild);
1152
                    Launcher launcher = ws.createLauncher(listener);
K
kohsuke 已提交
1153 1154
                    try {
                        LOGGER.fine("Polling SCM changes of " + getName());
1155 1156 1157 1158 1159
                        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;
K
kohsuke 已提交
1160
                    } finally {
1161
                        lease.release();
K
kohsuke 已提交
1162
                    }
K
kohsuke 已提交
1163
                }
K
kohsuke 已提交
1164 1165 1166
            } else {
                // polling without workspace
                LOGGER.fine("Polling SCM changes of " + getName());
1167 1168 1169 1170 1171 1172

                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;
K
kohsuke 已提交
1173
            }
1174
        } catch (AbortException e) {
K
i18n  
kohsuke 已提交
1175
            listener.fatalError(Messages.AbstractProject_Aborted());
1176
            LOGGER.log(Level.FINE, "Polling "+this+" aborted",e);
1177
            return NO_CHANGES;
1178 1179
        } catch (IOException e) {
            e.printStackTrace(listener.fatalError(e.getMessage()));
1180
            return NO_CHANGES;
1181
        } catch (InterruptedException e) {
1182
            e.printStackTrace(listener.fatalError(Messages.AbstractProject_PollingABorted()));
1183
            return NO_CHANGES;
1184 1185 1186
        }
    }

1187 1188
    /**
     * Returns true if this user has made a commit to this project.
1189
     *
1190 1191 1192
     * @since 1.191
     */
    public boolean hasParticipant(User user) {
1193 1194
        for( R build = getLastBuild(); build!=null; build=build.getPreviousBuild())
            if(build.hasParticipant(user))
1195 1196 1197 1198
                return true;
        return false;
    }

1199
    @Exported
1200 1201 1202 1203
    public SCM getScm() {
        return scm;
    }

1204
    public void setScm(SCM scm) throws IOException {
1205
        this.scm = scm;
1206
        save();
1207 1208
    }

1209 1210 1211
    /**
     * Adds a new {@link Trigger} to this {@link Project} if not active yet.
     */
1212
    public void addTrigger(Trigger<?> trigger) throws IOException {
1213
        addToList(trigger,triggers);
1214 1215
    }

1216
    public void removeTrigger(TriggerDescriptor trigger) throws IOException {
1217
        removeFromList(trigger,triggers);
1218 1219
    }

1220 1221 1222 1223
    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()) {
1224
                // replace
1225
                collection.set(i,item);
1226 1227 1228 1229 1230 1231 1232
                save();
                return;
            }
        }
        // add
        collection.add(item);
        save();
1233
        updateTransientActions();
1234 1235
    }

1236 1237 1238 1239
    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) {
1240 1241 1242
                // found it
                collection.remove(i);
                save();
1243
                updateTransientActions();
1244 1245 1246 1247 1248
                return;
            }
        }
    }

1249 1250
    public synchronized Map<TriggerDescriptor,Trigger> getTriggers() {
        return (Map)Descriptor.toMap(triggers);
1251 1252
    }

1253
    /**
1254
     * Gets the specific trigger, or null if the propert is not configured for this job.
1255 1256 1257
     */
    public <T extends Trigger> T getTrigger(Class<T> clazz) {
        for (Trigger p : triggers) {
1258
            if(clazz.isInstance(p))
1259 1260 1261 1262 1263
                return clazz.cast(p);
        }
        return null;
    }

1264 1265 1266 1267 1268
//
//
// fingerprint related
//
//
1269 1270 1271 1272 1273 1274
    /**
     * True if the builds of this project produces {@link Fingerprint} records.
     */
    public abstract boolean isFingerprintConfigured();

    /**
1275 1276
     * Gets the other {@link AbstractProject}s that should be built
     * when a build of this project is completed.
1277
     */
K
kohsuke 已提交
1278
    @Exported
1279 1280 1281
    public final List<AbstractProject> getDownstreamProjects() {
        return Hudson.getInstance().getDependencyGraph().getDownstream(this);
    }
1282

K
kohsuke 已提交
1283
    @Exported
1284 1285
    public final List<AbstractProject> getUpstreamProjects() {
        return Hudson.getInstance().getDependencyGraph().getUpstream(this);
K
kohsuke 已提交
1286 1287
    }

K
kohsuke 已提交
1288
    /**
1289 1290 1291 1292
     * 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 已提交
1293 1294 1295
     */
    public final List<AbstractProject> getBuildTriggerUpstreamProjects() {
        ArrayList<AbstractProject> result = new ArrayList<AbstractProject>();
1296 1297
        for (AbstractProject<?,?> ap : getUpstreamProjects()) {
            BuildTrigger buildTrigger = ap.getPublishersList().get(BuildTrigger.class);
1298 1299 1300
            if (buildTrigger != null)
                if (buildTrigger.getChildProjects().contains(this))
                    result.add(ap);
1301
        }        
K
kohsuke 已提交
1302
        return result;
1303 1304
    }    
    
K
kohsuke 已提交
1305 1306
    /**
     * Gets all the upstream projects including transitive upstream projects.
1307
     *
K
kohsuke 已提交
1308 1309 1310
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveUpstreamProjects() {
1311
        return Hudson.getInstance().getDependencyGraph().getTransitiveUpstream(this);
K
kohsuke 已提交
1312 1313 1314
    }

    /**
1315 1316
     * Gets all the downstream projects including transitive downstream projects.
     *
K
kohsuke 已提交
1317 1318 1319
     * @since 1.138
     */
    public final Set<AbstractProject> getTransitiveDownstreamProjects() {
1320
        return Hudson.getInstance().getDependencyGraph().getTransitiveDownstream(this);
1321 1322 1323 1324 1325
    }

    /**
     * Gets the dependency relationship map between this project (as the source)
     * and that project (as the sink.)
1326 1327 1328 1329
     *
     * @return
     *      can be empty but not null. build number of this project to the build
     *      numbers of that project.
1330 1331
     */
    public SortedMap<Integer, RangeSet> getRelationship(AbstractProject that) {
1332
        TreeMap<Integer,RangeSet> r = new TreeMap<Integer,RangeSet>(REVERSE_INTEGER_COMPARATOR);
1333 1334 1335 1336 1337 1338 1339 1340 1341

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

        return r;
    }

    /**
     * Helper method for getDownstreamRelationship.
1342 1343
     *
     * For each given build, find the build number range of the given project and put that into the map.
1344
     */
1345
    private void checkAndRecord(AbstractProject that, TreeMap<Integer, RangeSet> r, Collection<R> builds) {
1346 1347
        for (R build : builds) {
            RangeSet rs = build.getDownstreamRelationship(that);
1348
            if(rs==null || rs.isEmpty())
1349 1350 1351 1352 1353
                continue;

            int n = build.getNumber();

            RangeSet value = r.get(n);
1354 1355
            if(value==null)
                r.put(n,rs);
1356 1357 1358 1359 1360
            else
                value.add(rs);
        }
    }

1361 1362 1363 1364 1365 1366
    /**
     * Builds the dependency graph.
     * @see DependencyGraph
     */
    protected abstract void buildDependencyGraph(DependencyGraph graph);

1367
    @Override
K
kohsuke 已提交
1368 1369
    protected SearchIndexBuilder makeSearchIndex() {
        SearchIndexBuilder sib = super.makeSearchIndex();
1370
        if(isBuildable() && hasPermission(Hudson.ADMINISTER))
1371
            sib.add("build","build");
K
kohsuke 已提交
1372 1373 1374
        return sib;
    }

1375 1376
    @Override
    protected HistoryWidget createHistoryWidget() {
1377
        return new BuildHistoryWidget<R>(this,getBuilds(),HISTORY_ADAPTER);
1378
    }
1379
    
K
kohsuke 已提交
1380
    public boolean isParameterized() {
1381
        return getProperty(ParametersDefinitionProperty.class) != null;
K
kohsuke 已提交
1382
    }
1383

1384 1385 1386 1387 1388
//
//
// actions
//
//
1389 1390 1391
    /**
     * Schedules a new build command.
     */
1392
    public void doBuild( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1393
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);
1394

K
kohsuke 已提交
1395 1396 1397
        // if a build is parameterized, let that take over
        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
        if (pp != null) {
1398
            pp._doBuild(req,rsp);
K
kohsuke 已提交
1399 1400 1401
            return;
        }

1402 1403
        Cause cause;
        if (authToken != null && authToken.getToken() != null && req.getParameter("token") != null) {
1404 1405
            // Optional additional cause text when starting via token
            String causeText = req.getParameter("cause");
1406
            cause = new RemoteCause(req.getRemoteAddr(), causeText);
1407 1408 1409 1410
        } else {
            cause = new UserCause();
        }

1411 1412 1413
        if (!isBuildable())
            throw HttpResponses.error(SC_INTERNAL_SERVER_ERROR,new IOException(getFullName()+" is not buildable"));

1414 1415 1416 1417 1418 1419 1420 1421
        Hudson.getInstance().getQueue().schedule(this, getDelay(req), new CauseAction(cause));
        rsp.forwardToPreviousPage(req);
    }

    /**
     * Computes the delay by taking the default value and the override in the request parameter into the account.
     */
    public int getDelay(StaplerRequest req) throws ServletException {
1422
        String delay = req.getParameter("delay");
1423 1424 1425 1426 1427 1428 1429 1430 1431
        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);
1432
        }
1433
    }
1434

1435 1436 1437 1438
    /**
     * Supports build trigger with parameters via an HTTP GET or POST.
     * Currently only String parameters are supported.
     */
1439
    public void doBuildWithParameters(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);

        ParametersDefinitionProperty pp = getProperty(ParametersDefinitionProperty.class);
        if (pp != null) {
            pp.buildWithParameters(req,rsp);
        } else {
        	throw new IllegalStateException("This build is not parameterized!");
        }
    	
    }
1450 1451 1452 1453

    /**
     * Schedules a new SCM polling command.
     */
1454
    public void doPolling( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1455 1456 1457
        BuildAuthorizationToken.checkPermission(this, authToken, req, rsp);
        schedulePolling();
        rsp.forwardToPreviousPage(req);
1458 1459 1460 1461 1462
    }

    /**
     * Cancels a scheduled build.
     */
1463
    public void doCancelQueue( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1464
        checkPermission(BUILD);
1465

1466
        Hudson.getInstance().getQueue().cancel(this);
1467 1468 1469
        rsp.forwardToPreviousPage(req);
    }

1470
    @Override
1471 1472
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
        super.submit(req,rsp);
1473

1474
        makeDisabled(req.getParameter("disable")!=null);
1475 1476

        jdk = req.getParameter("jdk");
1477
        if(req.getParameter("hasCustomQuietPeriod")!=null) {
1478 1479 1480 1481
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));
        } else {
            quietPeriod = null;
        }
1482 1483
        if(req.getParameter("hasCustomScmCheckoutRetryCount")!=null) {
            scmCheckoutRetryCount = Integer.parseInt(req.getParameter("scmCheckoutRetryCount"));
S
 
shinodkm 已提交
1484
        } else {
1485
            scmCheckoutRetryCount = null;
S
 
shinodkm 已提交
1486
        }
1487 1488
        blockBuildWhenUpstreamBuilding = req.getParameter("blockBuildWhenUpstreamBuilding")!=null;

1489
        if(req.getParameter("hasSlaveAffinity")!=null) {
1490 1491
            canRoam = false;
            assignedNode = req.getParameter("slave");
1492 1493 1494
            if(assignedNode !=null) {
                if(Hudson.getInstance().getLabel(assignedNode).isEmpty())
                    assignedNode = null;   // no such label
1495 1496 1497 1498 1499 1500
            }
        } else {
            canRoam = true;
            assignedNode = null;
        }

1501
        concurrentBuild = req.getSubmittedForm().has("concurrentBuild");
K
kohsuke 已提交
1502

1503
        authToken = BuildAuthorizationToken.create(req);
1504

K
kohsuke 已提交
1505
        setScm(SCMS.parseSCM(req,this));
1506 1507 1508

        for (Trigger t : triggers)
            t.stop();
1509
        triggers = buildDescribable(req, Trigger.for_(this));
1510
        for (Trigger t : triggers)
1511
            t.start(this,true);
1512 1513
    }

K
kohsuke 已提交
1514 1515 1516 1517 1518 1519 1520 1521 1522
    /**
     * @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)
1523
        throws FormException, ServletException {
1524

1525
        JSONObject data = req.getSubmittedForm();
1526
        List<T> r = new Vector<T>();
1527
        for (Descriptor<T> d : descriptors) {
1528 1529 1530
            String safeName = d.getJsonSafeClassName();
            if (req.getParameter(safeName) != null) {
                T instance = d.newInstance(req, data.getJSONObject(safeName));
1531
                r.add(instance);
1532 1533
            }
        }
1534
        return r;
1535 1536 1537 1538 1539
    }

    /**
     * Serves the workspace files.
     */
1540
    public DirectoryBrowserSupport doWs( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException, InterruptedException {
1541
        checkPermission(AbstractProject.WORKSPACE);
K
kohsuke 已提交
1542
        FilePath ws = getSomeWorkspace();
1543
        if ((ws == null) || (!ws.exists())) {
1544
            // if there's no workspace, report a nice error message
1545 1546 1547 1548
            // 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.
1549
            req.getView(this,"noWorkspace.jelly").forward(req,rsp);
1550
            return null;
1551
        } else {
1552
            return new DirectoryBrowserSupport(this, ws, getDisplayName()+" workspace", "folder.gif", true);
1553 1554
        }
    }
1555

1556 1557 1558
    /**
     * Wipes out the workspace.
     */
1559
    public HttpResponse doDoWipeOutWorkspace() throws IOException, ServletException, InterruptedException {
1560
        checkPermission(BUILD);
1561 1562 1563 1564
        R b = getSomeBuildWithWorkspace();
        FilePath ws = b!=null ? b.getWorkspace() : null;
        if (ws!=null && getScm().processWorkspaceBeforeDeletion(this, ws, b.getBuiltOn())) {
            ws.deleteRecursive();
1565 1566 1567 1568
            return new HttpRedirect(".");
        } else {
            // If we get here, that means the SCM blocked the workspace deletion.
            return new ForwardToView(this,"wipeOutWorkspaceBlocked.jelly");
1569
        }
1570 1571
    }

1572
    public HttpResponse doDisable() throws IOException, ServletException {
1573 1574 1575
        requirePOST();
        checkPermission(CONFIGURE);
        makeDisabled(true);
1576
        return new HttpRedirect(".");
1577 1578
    }

1579
    public HttpResponse doEnable() throws IOException, ServletException {
1580
        requirePOST();
1581 1582
        checkPermission(CONFIGURE);
        makeDisabled(false);
1583
        return new HttpRedirect(".");
1584 1585
    }

K
kohsuke 已提交
1586 1587 1588
    /**
     * RSS feed for changes in this project.
     */
1589
    public void doRssChangelog(  StaplerRequest req, StaplerResponse rsp  ) throws IOException, ServletException {
K
kohsuke 已提交
1590 1591 1592 1593 1594 1595 1596 1597 1598
        class FeedItem {
            ChangeLogSet.Entry e;
            int idx;

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

1599
            AbstractBuild<?,?> getBuild() {
K
kohsuke 已提交
1600 1601 1602 1603 1604 1605
                return e.getParent().build;
            }
        }

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

1606 1607 1608 1609
        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 已提交
1610 1611
        }

1612 1613 1614 1615 1616 1617 1618
        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 已提交
1619

1620 1621 1622
                public String getEntryUrl(FeedItem item) {
                    return item.getBuild().getUrl()+"changes#detail"+item.idx;
                }
K
kohsuke 已提交
1623

1624 1625 1626
                public String getEntryID(FeedItem item) {
                    return getEntryUrl(item);
                }
K
kohsuke 已提交
1627

1628 1629 1630 1631 1632 1633
                public String getEntryDescription(FeedItem item) {
                    StringBuilder buf = new StringBuilder();
                    for(String path : item.e.getAffectedPaths())
                        buf.append(path).append('\n');
                    return buf.toString();
                }
1634

1635 1636 1637
                public Calendar getEntryTimestamp(FeedItem item) {
                    return item.getBuild().getTimestamp();
                }
1638

1639
                public String getEntryAuthor(FeedItem entry) {
1640
                    return Mailer.descriptor().getAdminAddress();
1641 1642 1643
                }
            },
            req, rsp );
K
kohsuke 已提交
1644 1645
    }

1646 1647 1648 1649 1650 1651 1652
    /**
     * {@link AbstractProject} subtypes should implement this base class as a descriptor.
     *
     * @since 1.294
     */
    public static abstract class AbstractProjectDescriptor extends TopLevelItemDescriptor {
        /**
1653
         * {@link AbstractProject} subtypes can override this method to veto some {@link Descriptor}s
1654
         * from showing up on their configuration screen. This is often useful when you are building
1655 1656
         * a workflow/company specific project type, where you want to limit the number of choices
         * given to the users.
1657 1658
         *
         * <p>
1659 1660 1661 1662
         * 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}
1663 1664 1665 1666
         * to show up for the given {@link Project}.
         *
         * <p>
         * The default implementation returns true for everything.
1667 1668
         *
         * @see BuildStepDescriptor#isApplicable(Class) 
K
kohsuke 已提交
1669 1670
         * @see BuildWrapperDescriptor#isApplicable(AbstractProject) 
         * @see TriggerDescriptor#isApplicable(Item)
1671
         */
K
kohsuke 已提交
1672
        @Override
1673
        public boolean isApplicable(Descriptor descriptor) {
1674 1675 1676 1677
            return true;
        }
    }

1678
    /**
1679
     * Finds a {@link AbstractProject} that has the name closest to the given name.
1680 1681
     */
    public static AbstractProject findNearest(String name) {
1682
        List<AbstractProject> projects = Hudson.getInstance().getItems(AbstractProject.class);
1683
        String[] names = new String[projects.size()];
1684
        for( int i=0; i<projects.size(); i++ )
1685 1686 1687
            names[i] = projects.get(i).getName();

        String nearest = EditDistance.findNearest(name, names);
1688
        return (AbstractProject)Hudson.getInstance().getItem(nearest);
1689
    }
1690 1691 1692

    private static final Comparator<Integer> REVERSE_INTEGER_COMPARATOR = new Comparator<Integer>() {
        public int compare(Integer o1, Integer o2) {
1693
            return o2-o1;
1694 1695
        }
    };
1696

1697
    private static final Logger LOGGER = Logger.getLogger(AbstractProject.class.getName());
1698

1699
    /**
1700
     * Permission to abort a build. For now, let's make it the same as {@link #BUILD}
1701 1702
     */
    public static final Permission ABORT = BUILD;
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714

    /**
     * Used for CLI binding.
     */
    @CLIResolver
    public static AbstractProject resolveForCLI(
            @Argument(required=true,metaVar="NAME",usage="Job name") String name) throws CmdLineException {
        AbstractProject item = Hudson.getInstance().getItemByFullName(name, AbstractProject.class);
        if (item==null)
            throw new CmdLineException(null,Messages.AbstractItem_NoSuchJobExists(name,AbstractProject.findNearest(name).getFullName()));
        return item;
    }
1715
}