Job.java 39.8 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
4
 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Martin Eigenbrodt, Matthew R. Harrah, Red Hat, Inc., Stephen Connolly, Tom Huybrechts, CloudBees, Inc.
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.
 */
K
kohsuke 已提交
24 25
package hudson.model;

26
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
27
import hudson.Extension;
K
kohsuke 已提交
28
import hudson.ExtensionPoint;
29
import hudson.PermalinkList;
30
import hudson.cli.declarative.CLIResolver;
31
import hudson.model.Descriptor.FormException;
K
kohsuke 已提交
32
import hudson.model.Fingerprint.Range;
33 34
import hudson.model.Fingerprint.RangeSet;
import hudson.model.PermalinkProjectAction.Permalink;
35
import hudson.search.QuickSilver;
K
kohsuke 已提交
36
import hudson.search.SearchIndex;
37
import hudson.search.SearchIndexBuilder;
K
kohsuke 已提交
38 39
import hudson.search.SearchItem;
import hudson.search.SearchItems;
40
import hudson.security.ACL;
K
kohsuke 已提交
41
import hudson.tasks.LogRotator;
K
Kohsuke Kawaguchi 已提交
42
import hudson.util.AlternativeUiTextProvider;
K
kohsuke 已提交
43
import hudson.util.ChartUtil;
K
kohsuke 已提交
44
import hudson.util.ColorPalette;
45
import hudson.util.CopyOnWriteList;
K
kohsuke 已提交
46
import hudson.util.DataSetBuilder;
47
import hudson.util.DescribableList;
48
import hudson.util.Graph;
K
kohsuke 已提交
49 50 51
import hudson.util.IOException2;
import hudson.util.RunList;
import hudson.util.ShiftedCategoryAxis;
K
kohsuke 已提交
52
import hudson.util.StackedAreaRenderer2;
K
kohsuke 已提交
53
import hudson.util.TextFile;
54
import hudson.widgets.HistoryWidget;
55
import hudson.widgets.HistoryWidget.Adapter;
56
import hudson.widgets.Widget;
57
import jenkins.model.Jenkins;
58
import net.sf.json.JSONException;
59
import net.sf.json.JSONObject;
K
kohsuke 已提交
60 61 62 63 64 65 66
import org.jfree.chart.ChartFactory;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.axis.CategoryLabelPositions;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.PlotOrientation;
K
kohsuke 已提交
67
import org.jfree.chart.renderer.category.StackedAreaRenderer;
K
kohsuke 已提交
68 69
import org.jfree.data.category.CategoryDataset;
import org.jfree.ui.RectangleInsets;
70
import org.jvnet.localizer.Localizable;
71 72
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
73
import org.kohsuke.stapler.StaplerOverridable;
K
kohsuke 已提交
74 75
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
K
kohsuke 已提交
76
import org.kohsuke.stapler.export.Exported;
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

import javax.servlet.ServletException;
import java.awt.*;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.SortedMap;

import static javax.servlet.http.HttpServletResponse.*;
K
kohsuke 已提交
94 95 96

/**
 * A job is an runnable entity under the monitoring of Hudson.
97
 * 
K
kohsuke 已提交
98 99
 * <p>
 * Every time it "runs", it will be recorded as a {@link Run} object.
K
kohsuke 已提交
100 101
 *
 * <p>
K
kohsuke 已提交
102
 * To create a custom job type, extend {@link TopLevelItemDescriptor} and put {@link Extension} on it.
K
kohsuke 已提交
103
 *
K
kohsuke 已提交
104 105
 * @author Kohsuke Kawaguchi
 */
106
public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, RunT>>
107
        extends AbstractItem implements ExtensionPoint, StaplerOverridable {
K
TAB->WS  
kohsuke 已提交
108 109 110 111 112 113 114 115 116 117 118

    /**
     * Next build number. Kept in a separate file because this is the only
     * information that gets updated often. This allows the rest of the
     * configuration to be in the VCS.
     * <p>
     * In 1.28 and earlier, this field was stored in the project configuration
     * file, so even though this is marked as transient, don't move it around.
     */
    protected transient volatile int nextBuildNumber = 1;

J
jpederzolli 已提交
119 120 121 122 123 124
    /**
     * Newly copied jobs get this flag set, so that Hudson doesn't try to run the job until its configuration
     * is saved once.
     */
    private transient volatile boolean holdOffBuildUntilSave;

K
TAB->WS  
kohsuke 已提交
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    private volatile LogRotator logRotator;

    /**
     * Not all plugins are good at calculating their health report quickly.
     * These fields are used to cache the health reports to speed up rendering
     * the main page.
     */
    private transient Integer cachedBuildHealthReportsBuildNumber = null;
    private transient List<HealthReport> cachedBuildHealthReports = null;

    private boolean keepDependencies;

    /**
     * List of {@link UserProperty}s configured for this project.
     */
K
Kohsuke Kawaguchi 已提交
140
    // this should have been DescribableList but now it's too late
K
TAB->WS  
kohsuke 已提交
141 142 143 144 145 146
    protected CopyOnWriteList<JobProperty<? super JobT>> properties = new CopyOnWriteList<JobProperty<? super JobT>>();

    protected Job(ItemGroup parent, String name) {
        super(parent, name);
    }

J
jpederzolli 已提交
147 148 149 150 151 152
    @Override
    public synchronized void save() throws IOException {
        super.save();
        holdOffBuildUntilSave = false;
    }

153
    @Override
K
TAB->WS  
kohsuke 已提交
154 155 156 157 158 159 160 161 162 163
    public void onLoad(ItemGroup<? extends Item> parent, String name)
            throws IOException {
        super.onLoad(parent, name);

        TextFile f = getNextBuildNumberFile();
        if (f.exists()) {
            // starting 1.28, we store nextBuildNumber in a separate file.
            // but old Hudson didn't do it, so if the file doesn't exist,
            // assume that nextBuildNumber was read from config.xml
            try {
D
dty 已提交
164 165 166
                synchronized (this) {
                    this.nextBuildNumber = Integer.parseInt(f.readTrim());
                }
K
TAB->WS  
kohsuke 已提交
167 168 169 170
            } catch (NumberFormatException e) {
                throw new IOException2(f + " doesn't contain a number", e);
            }
        } else {
171
            // From the old Hudson, or doCreateItem. Create this file now.
K
TAB->WS  
kohsuke 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185
            saveNextBuildNumber();
            save(); // and delete it from the config.xml
        }

        if (properties == null) // didn't exist < 1.72
            properties = new CopyOnWriteList<JobProperty<? super JobT>>();

        for (JobProperty p : properties)
            p.setOwner(this);
    }

    @Override
    public void onCopiedFrom(Item src) {
        super.onCopiedFrom(src);
D
dty 已提交
186 187
        synchronized (this) {
            this.nextBuildNumber = 1; // reset the next build number
J
jpederzolli 已提交
188
            this.holdOffBuildUntilSave = true;
D
dty 已提交
189
        }
K
TAB->WS  
kohsuke 已提交
190 191
    }

192
    @Override
193
    protected void performDelete() throws IOException, InterruptedException {
K
TAB->WS  
kohsuke 已提交
194 195 196 197 198 199 200 201 202 203 204 205
        // if a build is in progress. Cancel it.
        RunT lb = getLastBuild();
        if (lb != null) {
            Executor e = lb.getExecutor();
            if (e != null) {
                e.interrupt();
                // should we block until the build is cancelled?
            }
        }
        super.performDelete();
    }

D
dty 已提交
206
    /*package*/ TextFile getNextBuildNumberFile() {
K
TAB->WS  
kohsuke 已提交
207 208 209
        return new TextFile(new File(this.getRootDir(), "nextBuildNumber"));
    }

J
jpederzolli 已提交
210 211 212 213
    protected boolean isHoldOffBuildUntilSave() {
        return holdOffBuildUntilSave;
    }

D
dty 已提交
214
    protected synchronized void saveNextBuildNumber() throws IOException {
215 216 217
        if (nextBuildNumber == 0) { // #3361
            nextBuildNumber = 1;
        }
K
TAB->WS  
kohsuke 已提交
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
        getNextBuildNumberFile().write(String.valueOf(nextBuildNumber) + '\n');
    }

    @Exported
    public boolean isInQueue() {
        return false;
    }

    /**
     * If this job is in the build queue, return its item.
     */
    @Exported
    public Queue.Item getQueueItem() {
        return null;
    }

234 235 236 237 238 239 240 241
    /**
     * Returns true if a build of this project is in progress.
     */
    public boolean isBuilding() {
        RunT b = getLastBuild();
        return b!=null && b.isBuilding();
    }

242
    @Override
K
TAB->WS  
kohsuke 已提交
243
    public String getPronoun() {
K
Kohsuke Kawaguchi 已提交
244
        return AlternativeUiTextProvider.get(PRONOUN, this, Messages.Job_Pronoun());
K
TAB->WS  
kohsuke 已提交
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
    }

    /**
     * Returns whether the name of this job can be changed by user.
     */
    public boolean isNameEditable() {
        return true;
    }

    /**
     * If true, it will keep all the build logs of dependency components.
     */
    @Exported
    public boolean isKeepDependencies() {
        return keepDependencies;
    }

    /**
     * Allocates a new buildCommand number.
     */
    public synchronized int assignBuildNumber() throws IOException {
        int r = nextBuildNumber++;
        saveNextBuildNumber();
        return r;
    }

    /**
     * Peeks the next build number.
     */
    @Exported
    public int getNextBuildNumber() {
        return nextBuildNumber;
    }

    /**
     * Programatically updates the next build number.
     * 
     * <p>
     * Much of Hudson assumes that the build number is unique and monotonic, so
     * this method can only accept a new value that's bigger than
285
     * {@link #getLastBuild()} returns. Otherwise it'll be no-op.
K
TAB->WS  
kohsuke 已提交
286 287 288
     * 
     * @since 1.199 (before that, this method was package private.)
     */
D
dty 已提交
289
    public synchronized void updateNextBuildNumber(int next) throws IOException {
290 291
        RunT lb = getLastBuild();
        if (lb!=null ?  next>lb.getNumber() : next>0) {
K
TAB->WS  
kohsuke 已提交
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
            this.nextBuildNumber = next;
            saveNextBuildNumber();
        }
    }

    /**
     * Returns the log rotator for this job, or null if none.
     */
    public LogRotator getLogRotator() {
        return logRotator;
    }

    public void setLogRotator(LogRotator logRotator) {
        this.logRotator = logRotator;
    }

    /**
     * Perform log rotation.
     */
311
    public void logRotate() throws IOException, InterruptedException {
K
TAB->WS  
kohsuke 已提交
312 313 314 315 316 317 318 319 320 321 322 323
        LogRotator lr = getLogRotator();
        if (lr != null)
            lr.perform(this);
    }

    /**
     * True if this instance supports log rotation configuration.
     */
    public boolean supportsLogRotator() {
        return true;
    }

324
    @Override
K
TAB->WS  
kohsuke 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    protected SearchIndexBuilder makeSearchIndex() {
        return super.makeSearchIndex().add(new SearchIndex() {
            public void find(String token, List<SearchItem> result) {
                try {
                    if (token.startsWith("#"))
                        token = token.substring(1); // ignore leading '#'
                    int n = Integer.parseInt(token);
                    Run b = getBuildByNumber(n);
                    if (b == null)
                        return; // no such build
                    result.add(SearchItems.create("#" + n, "" + n, b));
                } catch (NumberFormatException e) {
                    // not a number.
                }
            }

            public void suggest(String token, List<SearchItem> result) {
                find(token, result);
            }
        }).add("configure", "config", "configure");
    }

    public Collection<? extends Job> getAllJobs() {
        return Collections.<Job> singleton(this);
    }

    /**
     * Adds {@link JobProperty}.
     * 
     * @since 1.188
     */
K
kohsuke 已提交
356
    public void addProperty(JobProperty<? super JobT> jobProp) throws IOException {
357
        ((JobProperty)jobProp).setOwner(this);
K
TAB->WS  
kohsuke 已提交
358 359 360 361
        properties.add(jobProp);
        save();
    }

K
kohsuke 已提交
362 363 364 365 366 367 368 369 370 371
    /**
     * Removes {@link JobProperty}
     *
     * @since 1.279
     */
    public void removeProperty(JobProperty<? super JobT> jobProp) throws IOException {
        properties.remove(jobProp);
        save();
    }

K
kohsuke 已提交
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    /**
     * Removes the property of the given type.
     *
     * @return
     *      The property that was just removed.
     * @since 1.279
     */
    public <T extends JobProperty> T removeProperty(Class<T> clazz) throws IOException {
        for (JobProperty<? super JobT> p : properties) {
            if (clazz.isInstance(p)) {
                removeProperty(p);
                return clazz.cast(p);
            }
        }
        return null;
    }

K
TAB->WS  
kohsuke 已提交
389 390 391 392 393 394 395 396
    /**
     * Gets all the job properties configured for this job.
     */
    @SuppressWarnings("unchecked")
    public Map<JobPropertyDescriptor, JobProperty<? super JobT>> getProperties() {
        return Descriptor.toMap((Iterable) properties);
    }

397 398 399 400 401 402 403 404 405
    /**
     * List of all {@link JobProperty} exposed primarily for the remoting API.
     * @since 1.282
     */
    @Exported(name="property",inline=true)
    public List<JobProperty<? super JobT>> getAllProperties() {
        return properties.getView();
    }

K
TAB->WS  
kohsuke 已提交
406 407 408 409 410 411 412 413 414 415 416 417
    /**
     * Gets the specific property, or null if the propert is not configured for
     * this job.
     */
    public <T extends JobProperty> T getProperty(Class<T> clazz) {
        for (JobProperty p : properties) {
            if (clazz.isInstance(p))
                return clazz.cast(p);
        }
        return null;
    }

418 419 420 421 422 423 424 425 426 427 428 429
    /**
     * Bind {@link JobProperty}s to URL spaces.
     *
     * @since 1.403
     */
    public JobProperty getProperty(String className) {
        for (JobProperty p : properties)
            if (p.getClass().getName().equals(className))
                return p;
        return null;
    }

430 431 432 433 434 435 436 437 438 439
    /**
     * Overrides from job properties.
     */
    public Collection<?> getOverrides() {
        List<Object> r = new ArrayList<Object>();
        for (JobProperty<? super JobT> p : properties)
            r.addAll(p.getJobOverrides());
        return r;
    }

K
TAB->WS  
kohsuke 已提交
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    public List<Widget> getWidgets() {
        ArrayList<Widget> r = new ArrayList<Widget>();
        r.add(createHistoryWidget());
        return r;
    }

    protected HistoryWidget createHistoryWidget() {
        return new HistoryWidget<Job, RunT>(this, getBuilds(), HISTORY_ADAPTER);
    }

    protected static final HistoryWidget.Adapter<Run> HISTORY_ADAPTER = new Adapter<Run>() {
        public int compare(Run record, String key) {
            try {
                int k = Integer.parseInt(key);
                return record.getNumber() - k;
            } catch (NumberFormatException nfe) {
                return String.valueOf(record.getNumber()).compareTo(key);
            }
        }

        public String getKey(Run record) {
            return String.valueOf(record.getNumber());
        }

        public boolean isBuilding(Run record) {
            return record.isBuilding();
        }

        public String getNextKey(String key) {
            try {
                int k = Integer.parseInt(key);
                return String.valueOf(k + 1);
            } catch (NumberFormatException nfe) {
                return "-unable to determine next key-";
            }
        }
    };

    /**
     * Renames a job.
     */
K
Kohsuke Kawaguchi 已提交
481
    @Override
K
TAB->WS  
kohsuke 已提交
482
    public void renameTo(String newName) throws IOException {
483
        super.renameTo(newName);
K
TAB->WS  
kohsuke 已提交
484 485 486 487 488 489 490 491 492
    }

    /**
     * Returns true if we should display "build now" icon
     */
    @Exported
    public abstract boolean isBuildable();

    /**
493
     * Gets the read-only view of all the builds.
K
TAB->WS  
kohsuke 已提交
494 495 496
     * 
     * @return never null. The first entry is the latest build.
     */
497
    @Exported
498
    @WithBridgeMethods(List.class)
499
    public RunList<RunT> getBuilds() {
500
        return RunList.fromRuns(_getRuns().values());
K
TAB->WS  
kohsuke 已提交
501 502
    }

K
kohsuke 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
    /**
     * Obtains all the {@link Run}s whose build numbers matches the given {@link RangeSet}.
     */
    public synchronized List<RunT> getBuilds(RangeSet rs) {
        List<RunT> builds = new LinkedList<RunT>();

        for (Range r : rs.getRanges()) {
            for (RunT b = getNearestBuild(r.start); b!=null && b.getNumber()<r.end; b=b.getNextBuild()) {
                builds.add(b);
            }
        }

        return builds;
    }

K
TAB->WS  
kohsuke 已提交
518 519 520 521 522 523 524 525
    /**
     * Gets all the builds in a map.
     */
    public SortedMap<Integer, RunT> getBuildsAsMap() {
        return Collections.unmodifiableSortedMap(_getRuns());
    }

    /**
M
mindless 已提交
526 527
     * @deprecated since 2008-06-15.
     *     This is only used to support backward compatibility with old URLs.
K
TAB->WS  
kohsuke 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
     */
    @Deprecated
    public RunT getBuild(String id) {
        for (RunT r : _getRuns().values()) {
            if (r.getId().equals(id))
                return r;
        }
        return null;
    }

    /**
     * @param n
     *            The build number.
     * @return null if no such build exists.
     * @see Run#getNumber()
     */
    public RunT getBuildByNumber(int n) {
        return _getRuns().get(n);
    }

K
kohsuke 已提交
548 549 550 551
    /**
     * Obtains a list of builds, in the descending order, that are within the specified time range [start,end).
     *
     * @return can be empty but never null.
552 553
     * @deprecated
     *      as of 1.372. Should just do {@code getBuilds().byTimestamp(s,e)} to avoid code bloat in {@link Job}.
K
kohsuke 已提交
554
     */
555
    @WithBridgeMethods(List.class)
556
    public RunList<RunT> getBuildsByTimestamp(long start, long end) {
557
        return getBuilds().byTimestamp(start,end);
K
kohsuke 已提交
558 559
    }

560 561 562 563 564 565
    @CLIResolver
    public RunT getBuildForCLI(@Argument(required=true,metaVar="BUILD#",usage="Build number") String id) throws CmdLineException {
        try {
            int n = Integer.parseInt(id);
            RunT r = getBuildByNumber(n);
            if (r==null)
M
mindless 已提交
566
                throw new CmdLineException(null, "No such build '#"+n+"' exists");
567 568
            return r;
        } catch (NumberFormatException e) {
M
mindless 已提交
569
            throw new CmdLineException(null, id+ "is not a number");
570 571 572
        }
    }

K
TAB->WS  
kohsuke 已提交
573 574 575 576 577 578 579
    /**
     * Gets the youngest build #m that satisfies <tt>n&lt;=m</tt>.
     * 
     * This is useful when you'd like to fetch a build but the exact build might
     * be already gone (deleted, rotated, etc.)
     */
    public final RunT getNearestBuild(int n) {
580 581
        SortedMap<Integer, ? extends RunT> m = _getRuns().headMap(n - 1); // the map should
                                                                          // include n, so n-1
K
TAB->WS  
kohsuke 已提交
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
        if (m.isEmpty())
            return null;
        return m.get(m.lastKey());
    }

    /**
     * Gets the latest build #m that satisfies <tt>m&lt;=n</tt>.
     * 
     * This is useful when you'd like to fetch a build but the exact build might
     * be already gone (deleted, rotated, etc.)
     */
    public final RunT getNearestOldBuild(int n) {
        SortedMap<Integer, ? extends RunT> m = _getRuns().tailMap(n);
        if (m.isEmpty())
            return null;
        return m.get(m.firstKey());
    }

600
    @Override
K
TAB->WS  
kohsuke 已提交
601 602 603 604 605 606 607 608 609 610 611 612
    public Object getDynamic(String token, StaplerRequest req,
            StaplerResponse rsp) {
        try {
            // try to interpret the token as build number
            return _getRuns().get(Integer.valueOf(token));
        } catch (NumberFormatException e) {
            // try to map that to widgets
            for (Widget w : getWidgets()) {
                if (w.getUrlName().equals(token))
                    return w;
            }

613 614
            // is this a permalink?
            for (Permalink p : getPermalinks()) {
615
                if(p.getId().equals(token))
616 617 618
                    return p.resolve(this);
            }

K
TAB->WS  
kohsuke 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632
            return super.getDynamic(token, req, rsp);
        }
    }

    /**
     * Directory for storing {@link Run} records.
     * <p>
     * Some {@link Job}s may not have backing data store for {@link Run}s, but
     * those {@link Job}s that use file system for storing data should use this
     * directory for consistency.
     * 
     * @see RunMap
     */
    protected File getBuildDir() {
633
        return Jenkins.getInstance().getBuildDirFor(this);
K
TAB->WS  
kohsuke 已提交
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    }

    /**
     * Gets all the runs.
     * 
     * The resulting map must be immutable (by employing copy-on-write
     * semantics.) The map is descending order, with newest builds at the top.
     */
    protected abstract SortedMap<Integer, ? extends RunT> _getRuns();

    /**
     * Called from {@link Run} to remove it from this job.
     * 
     * The files are deleted already. So all the callee needs to do is to remove
     * a reference from this {@link Job}.
     */
    protected abstract void removeRun(RunT run);

    /**
     * Returns the last build.
     */
    @Exported
    @QuickSilver
    public RunT getLastBuild() {
        SortedMap<Integer, ? extends RunT> runs = _getRuns();

        if (runs.isEmpty())
            return null;
        return runs.get(runs.firstKey());
    }

    /**
     * Returns the oldest build in the record.
     */
    @Exported
    @QuickSilver
    public RunT getFirstBuild() {
        SortedMap<Integer, ? extends RunT> runs = _getRuns();

        if (runs.isEmpty())
            return null;
        return runs.get(runs.lastKey());
    }

    /**
J
jglick 已提交
679
     * Returns the last successful build, if any. Otherwise null. A successful build
K
TAB->WS  
kohsuke 已提交
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
     * would include either {@link Result#SUCCESS} or {@link Result#UNSTABLE}.
     * 
     * @see #getLastStableBuild()
     */
    @Exported
    @QuickSilver
    public RunT getLastSuccessfulBuild() {
        RunT r = getLastBuild();
        // temporary hack till we figure out what's causing this bug
        while (r != null
                && (r.isBuilding() || r.getResult() == null || r.getResult()
                        .isWorseThan(Result.UNSTABLE)))
            r = r.getPreviousBuild();
        return r;
    }

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
    /**
     * Returns the last build that was anything but stable, if any. Otherwise null.
     * @see #getLastSuccessfulBuild
     */
    @Exported
    @QuickSilver
    public RunT getLastUnsuccessfulBuild() {
        RunT r = getLastBuild();
        while (r != null
                && (r.isBuilding() || r.getResult() == Result.SUCCESS))
            r = r.getPreviousBuild();
        return r;
    }

    /**
     * Returns the last unstable build, if any. Otherwise null.
     * @see #getLastSuccessfulBuild
     */
    @Exported
    @QuickSilver
    public RunT getLastUnstableBuild() {
        RunT r = getLastBuild();
        while (r != null
                && (r.isBuilding() || r.getResult() != Result.UNSTABLE))
            r = r.getPreviousBuild();
        return r;
    }

K
TAB->WS  
kohsuke 已提交
724 725
    /**
     * Returns the last stable build, if any. Otherwise null.
J
jglick 已提交
726
     * @see #getLastSuccessfulBuild
K
TAB->WS  
kohsuke 已提交
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
     */
    @Exported
    @QuickSilver
    public RunT getLastStableBuild() {
        RunT r = getLastBuild();
        while (r != null
                && (r.isBuilding() || r.getResult().isWorseThan(Result.SUCCESS)))
            r = r.getPreviousBuild();
        return r;
    }

    /**
     * Returns the last failed build, if any. Otherwise null.
     */
    @Exported
    @QuickSilver
    public RunT getLastFailedBuild() {
        RunT r = getLastBuild();
        while (r != null && (r.isBuilding() || r.getResult() != Result.FAILURE))
            r = r.getPreviousBuild();
        return r;
    }

    /**
     * Returns the last completed build, if any. Otherwise null.
     */
    @Exported
    @QuickSilver
    public RunT getLastCompletedBuild() {
        RunT r = getLastBuild();
        while (r != null && r.isBuilding())
            r = r.getPreviousBuild();
        return r;
    }
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
    
    /**
     * Returns the last 'numberOfBuilds' builds with a build result >= 'threshold'
     * 
     * @return a list with the builds. May be smaller than 'numberOfBuilds' or even empty
     *   if not enough builds satisfying the threshold have been found. Never null.
     */
    public List<RunT> getLastBuildsOverThreshold(int numberOfBuilds, Result threshold) {
        
        List<RunT> result = new ArrayList<RunT>(numberOfBuilds);
        
        RunT r = getLastBuild();
        while (r != null && result.size() < numberOfBuilds) {
            if (!r.isBuilding() && 
                 (r.getResult() != null && r.getResult().isBetterOrEqualTo(threshold))) {
                result.add(r);
            }
            r = r.getPreviousBuild();
        }
        
        return result;
    }
    
    public final long getEstimatedDuration() {
        List<RunT> builds = getLastBuildsOverThreshold(3, Result.UNSTABLE);
        
        if(builds.isEmpty())     return -1;

        long totalDuration = 0;
        for (RunT b : builds) {
            totalDuration += b.getDuration();
        }
        if(totalDuration==0) return -1;

        return Math.round((double)totalDuration / builds.size());
    }
K
TAB->WS  
kohsuke 已提交
797

798 799
    /**
     * Gets all the {@link Permalink}s defined for this job.
800 801
     *
     * @return never null
802
     */
803
    public PermalinkList getPermalinks() {
804
        // TODO: shall we cache this?
805
        PermalinkList permalinks = new PermalinkList(Permalink.BUILTIN);
806 807 808 809 810 811 812 813 814
        for (Action a : getActions()) {
            if (a instanceof PermalinkProjectAction) {
                PermalinkProjectAction ppa = (PermalinkProjectAction) a;
                permalinks.addAll(ppa.getPermalinks());
            }
        }
        return permalinks;
    }

K
TAB->WS  
kohsuke 已提交
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
    /**
     * Used as the color of the status ball for the project.
     */
    @Exported(visibility = 2, name = "color")
    public BallColor getIconColor() {
        RunT lastBuild = getLastBuild();
        while (lastBuild != null && lastBuild.hasntStartedYet())
            lastBuild = lastBuild.getPreviousBuild();

        if (lastBuild != null)
            return lastBuild.getIconColor();
        else
            return BallColor.GREY;
    }

    /**
     * Get the current health report for a job.
     * 
     * @return the health report. Never returns null
     */
    public HealthReport getBuildHealth() {
        List<HealthReport> reports = getBuildHealthReports();
        return reports.isEmpty() ? new HealthReport() : reports.get(0);
    }

    @Exported(name = "healthReport")
    public List<HealthReport> getBuildHealthReports() {
        List<HealthReport> reports = new ArrayList<HealthReport>();
        RunT lastBuild = getLastBuild();

        if (lastBuild != null && lastBuild.isBuilding()) {
            // show the previous build's report until the current one is
            // finished building.
            lastBuild = lastBuild.getPreviousBuild();
        }

        // check the cache
        if (cachedBuildHealthReportsBuildNumber != null
                && cachedBuildHealthReports != null
                && lastBuild != null
                && cachedBuildHealthReportsBuildNumber.intValue() == lastBuild
                        .getNumber()) {
            reports.addAll(cachedBuildHealthReports);
        } else if (lastBuild != null) {
            for (HealthReportingAction healthReportingAction : lastBuild
                    .getActions(HealthReportingAction.class)) {
                final HealthReport report = healthReportingAction
                        .getBuildHealth();
                if (report != null) {
                    if (report.isAggregateReport()) {
                        reports.addAll(report.getAggregatedReports());
                    } else {
                        reports.add(report);
                    }
                }
            }
            final HealthReport report = getBuildStabilityHealthReport();
            if (report != null) {
                if (report.isAggregateReport()) {
                    reports.addAll(report.getAggregatedReports());
                } else {
                    reports.add(report);
                }
            }

            Collections.sort(reports);

            // store the cache
            cachedBuildHealthReportsBuildNumber = lastBuild.getNumber();
            cachedBuildHealthReports = new ArrayList<HealthReport>(reports);
        }

        return reports;
    }

    private HealthReport getBuildStabilityHealthReport() {
        // we can give a simple view of build health from the last five builds
        int failCount = 0;
        int totalCount = 0;
        RunT i = getLastBuild();
        while (totalCount < 5 && i != null) {
            switch (i.getIconColor()) {
            case BLUE:
            case YELLOW:
                // failCount stays the same
                totalCount++;
                break;
            case RED:
                failCount++;
                totalCount++;
                break;

            default:
                // do nothing as these are inconclusive statuses
                break;
            }
            i = i.getPreviousBuild();
        }
        if (totalCount > 0) {
            int score = (int) ((100.0 * (totalCount - failCount)) / totalCount);

916
            Localizable description;
K
TAB->WS  
kohsuke 已提交
917
            if (failCount == 0) {
918
                description = Messages._Job_NoRecentBuildFailed();
K
TAB->WS  
kohsuke 已提交
919 920 921 922
            } else if (totalCount == failCount) {
                // this should catch the case where totalCount == 1
                // as failCount must be between 0 and totalCount
                // and we can't get here if failCount == 0
923
                description = Messages._Job_AllRecentBuildFailed();
K
TAB->WS  
kohsuke 已提交
924
            } else {
925
                description = Messages._Job_NOfMFailed(failCount, totalCount);
K
TAB->WS  
kohsuke 已提交
926
            }
927
            return new HealthReport(score, Messages._Job_BuildStability(description));
K
TAB->WS  
kohsuke 已提交
928 929 930 931 932 933 934 935 936 937 938 939 940
        }
        return null;
    }

    //
    //
    // actions
    //
    //
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigSubmit(StaplerRequest req,
941
            StaplerResponse rsp) throws IOException, ServletException, FormException {
K
TAB->WS  
kohsuke 已提交
942 943 944 945 946 947 948
        checkPermission(CONFIGURE);

        description = req.getParameter("description");

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

        try {
949
            JSONObject json = req.getSubmittedForm();
K
TAB->WS  
kohsuke 已提交
950 951 952 953 954

            if (req.getParameter("logrotate") != null)
                logRotator = LogRotator.DESCRIPTOR.newInstance(req,json.getJSONObject("logrotate"));
            else
                logRotator = null;
955 956 957 958 959 960 961

            DescribableList<JobProperty<?>, JobPropertyDescriptor> t = new DescribableList<JobProperty<?>, JobPropertyDescriptor>(NOOP,getAllProperties());
            t.rebuild(req,json.optJSONObject("properties"),JobPropertyDescriptor.getPropertyDescriptors(Job.this.getClass()));
            properties.clear();
            for (JobProperty p : t) {
                p.setOwner(this);
                properties.add(p);
K
TAB->WS  
kohsuke 已提交
962 963 964 965 966 967 968 969 970
            }

            submit(req, rsp);

            save();

            String newName = req.getParameter("name");
            if (newName != null && !newName.equals(name)) {
                // check this error early to avoid HTTP response splitting.
971
                Jenkins.checkGoodName(newName);
972
                rsp.sendRedirect("rename?newName=" + URLEncoder.encode(newName, "UTF-8"));
K
TAB->WS  
kohsuke 已提交
973 974 975 976 977 978
            } else {
                rsp.sendRedirect(".");
            }
        } catch (JSONException e) {
            StringWriter sw = new StringWriter();
            PrintWriter pw = new PrintWriter(sw);
979
            pw.println("Failed to parse form data. Please report this problem as a bug");
980
            pw.println("JSON=" + req.getSubmittedForm());
K
TAB->WS  
kohsuke 已提交
981 982 983 984
            pw.println();
            e.printStackTrace(pw);

            rsp.setStatus(SC_BAD_REQUEST);
985
            sendError(sw.toString(), req, rsp, true);
K
TAB->WS  
kohsuke 已提交
986 987 988 989 990 991 992 993 994 995 996
        }
    }

    /**
     * Derived class can override this to perform additional config submission
     * work.
     */
    protected void submit(StaplerRequest req, StaplerResponse rsp)
            throws IOException, ServletException, FormException {
    }

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    /**
     * Accepts and serves the job description
     */
    public void doDescription(StaplerRequest req, StaplerResponse rsp)
            throws IOException {
        if (req.getMethod().equals("GET")) {
            //read
            rsp.setContentType("text/plain;charset=UTF-8");
            rsp.getWriter().write(this.getDescription());
            return;
        }
        if (req.getMethod().equals("POST")) {
            checkPermission(CONFIGURE);

            // submission
            if (req.getParameter("description") != null) {
                this.setDescription(req.getParameter("description"));
                rsp.sendError(SC_NO_CONTENT);
                return;
            }
        }

        // huh?
        rsp.sendError(SC_BAD_REQUEST);
    }

K
TAB->WS  
kohsuke 已提交
1023 1024 1025 1026 1027
    /**
     * Returns the image that shows the current buildCommand status.
     */
    public void doBuildStatus(StaplerRequest req, StaplerResponse rsp)
            throws IOException {
1028
        rsp.sendRedirect2(req.getContextPath() + "/images/48x48/" + getBuildStatusUrl());
K
TAB->WS  
kohsuke 已提交
1029 1030 1031 1032 1033 1034
    }

    public String getBuildStatusUrl() {
        return getIconColor().getImage();
    }

1035 1036 1037 1038 1039 1040
    public Graph getBuildTimeGraph() {
        return new Graph(getLastBuild().getTimestamp(),500,400) {
            @Override
            protected JFreeChart createGraph() {
                class ChartLabel implements Comparable<ChartLabel> {
                    final Run run;
K
TAB->WS  
kohsuke 已提交
1041

1042 1043 1044
                    public ChartLabel(Run r) {
                        this.run = r;
                    }
K
TAB->WS  
kohsuke 已提交
1045

1046 1047 1048
                    public int compareTo(ChartLabel that) {
                        return this.run.number - that.run.number;
                    }
K
TAB->WS  
kohsuke 已提交
1049

1050
                    @Override
1051 1052 1053 1054 1055 1056 1057 1058 1059
                    public boolean equals(Object o) {
                        // HUDSON-2682 workaround for Eclipse compilation bug
                        // on (c instanceof ChartLabel)
                        if (o == null || !ChartLabel.class.isAssignableFrom( o.getClass() ))  {
                            return false;
                        }
                        ChartLabel that = (ChartLabel) o;
                        return run == that.run;
                    }
K
TAB->WS  
kohsuke 已提交
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
                    public Color getColor() {
                        // TODO: consider gradation. See
                        // http://www.javadrive.jp/java2d/shape/index9.html
                        Result r = run.getResult();
                        if (r == Result.FAILURE)
                            return ColorPalette.RED;
                        else if (r == Result.UNSTABLE)
                            return ColorPalette.YELLOW;
                        else if (r == Result.ABORTED || r == Result.NOT_BUILT)
                            return ColorPalette.GREY;
                        else
                            return ColorPalette.BLUE;
                    }
K
TAB->WS  
kohsuke 已提交
1074

1075
                    @Override
1076 1077 1078
                    public int hashCode() {
                        return run.hashCode();
                    }
K
TAB->WS  
kohsuke 已提交
1079

1080
                    @Override
1081 1082 1083 1084 1085 1086 1087 1088 1089
                    public String toString() {
                        String l = run.getDisplayName();
                        if (run instanceof Build) {
                            String s = ((Build) run).getBuiltOnStr();
                            if (s != null)
                                l += ' ' + s;
                        }
                        return l;
                    }
K
TAB->WS  
kohsuke 已提交
1090

1091
                }
K
TAB->WS  
kohsuke 已提交
1092

1093 1094 1095 1096 1097 1098
                DataSetBuilder<String, ChartLabel> data = new DataSetBuilder<String, ChartLabel>();
                for (Run r : getBuilds()) {
                    if (r.isBuilding())
                        continue;
                    data.add(((double) r.getDuration()) / (1000 * 60), "min",
                            new ChartLabel(r));
K
TAB->WS  
kohsuke 已提交
1099 1100
                }

1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
                final CategoryDataset dataset = data.build();

                final JFreeChart chart = ChartFactory.createStackedAreaChart(null, // chart
                                                                                    // title
                        null, // unused
                        Messages.Job_minutes(), // range axis label
                        dataset, // data
                        PlotOrientation.VERTICAL, // orientation
                        false, // include legend
                        true, // tooltips
                        false // urls
                        );

                chart.setBackgroundPaint(Color.white);

                final CategoryPlot plot = chart.getCategoryPlot();

                // plot.setAxisOffset(new Spacer(Spacer.ABSOLUTE, 5.0, 5.0, 5.0, 5.0));
                plot.setBackgroundPaint(Color.WHITE);
                plot.setOutlinePaint(null);
                plot.setForegroundAlpha(0.8f);
                // plot.setDomainGridlinesVisible(true);
                // plot.setDomainGridlinePaint(Color.white);
                plot.setRangeGridlinesVisible(true);
                plot.setRangeGridlinePaint(Color.black);

                CategoryAxis domainAxis = new ShiftedCategoryAxis(null);
                plot.setDomainAxis(domainAxis);
                domainAxis.setCategoryLabelPositions(CategoryLabelPositions.UP_90);
                domainAxis.setLowerMargin(0.0);
                domainAxis.setUpperMargin(0.0);
                domainAxis.setCategoryMargin(0.0);

                final NumberAxis rangeAxis = (NumberAxis) plot.getRangeAxis();
                ChartUtil.adjustChebyshev(dataset, rangeAxis);
                rangeAxis.setStandardTickUnits(NumberAxis.createIntegerTickUnits());

                StackedAreaRenderer ar = new StackedAreaRenderer2() {
                    @Override
                    public Paint getItemPaint(int row, int column) {
                        ChartLabel key = (ChartLabel) dataset.getColumnKey(column);
                        return key.getColor();
                    }
K
TAB->WS  
kohsuke 已提交
1144

1145 1146 1147 1148 1149 1150
                    @Override
                    public String generateURL(CategoryDataset dataset, int row,
                            int column) {
                        ChartLabel label = (ChartLabel) dataset.getColumnKey(column);
                        return String.valueOf(label.run.number);
                    }
K
TAB->WS  
kohsuke 已提交
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160
                    @Override
                    public String generateToolTip(CategoryDataset dataset, int row,
                            int column) {
                        ChartLabel label = (ChartLabel) dataset.getColumnKey(column);
                        return label.run.getDisplayName() + " : "
                                + label.run.getDurationString();
                    }
                };
                plot.setRenderer(ar);
K
TAB->WS  
kohsuke 已提交
1161

1162 1163
                // crop extra space around the graph
                plot.setInsets(new RectangleInsets(0, 0, 0, 5.0));
K
TAB->WS  
kohsuke 已提交
1164

1165
                return chart;
K
TAB->WS  
kohsuke 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
            }
        };
    }

    /**
     * Renames this job.
     */
    public/* not synchronized. see renameTo() */void doDoRename(
            StaplerRequest req, StaplerResponse rsp) throws IOException,
            ServletException {
1176
        requirePOST();
K
TAB->WS  
kohsuke 已提交
1177 1178 1179 1180 1181
        // rename is essentially delete followed by a create
        checkPermission(CREATE);
        checkPermission(DELETE);

        String newName = req.getParameter("newName");
1182
        Jenkins.checkGoodName(newName);
K
TAB->WS  
kohsuke 已提交
1183

1184 1185
        if (isBuilding()) {
            // redirect to page explaining that we can't rename now
1186
            rsp.sendRedirect("rename?newName=" + URLEncoder.encode(newName, "UTF-8"));
1187 1188 1189
            return;
        }

K
TAB->WS  
kohsuke 已提交
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
        renameTo(newName);
        // send to the new job page
        // note we can't use getUrl() because that would pick up old name in the
        // Ancestor.getUrl()
        rsp.sendRedirect2(req.getContextPath() + '/' + getParent().getUrl()
                + getShortUrl());
    }

    public void doRssAll(StaplerRequest req, StaplerResponse rsp)
            throws IOException, ServletException {
1200
        rss(req, rsp, " all builds", getBuilds());
K
TAB->WS  
kohsuke 已提交
1201 1202 1203 1204
    }

    public void doRssFailed(StaplerRequest req, StaplerResponse rsp)
            throws IOException, ServletException {
1205
        rss(req, rsp, " failed builds", getBuilds().failureOnly());
K
TAB->WS  
kohsuke 已提交
1206 1207 1208 1209 1210 1211 1212
    }

    private void rss(StaplerRequest req, StaplerResponse rsp, String suffix,
            RunList runs) throws IOException, ServletException {
        RSS.forwardToRss(getDisplayName() + suffix, getUrl(), runs.newBuilds(),
                Run.FEED_ADAPTER, req, rsp);
    }
1213 1214 1215 1216 1217 1218

    /**
     * Returns the {@link ACL} for this object.
     * We need to override the identical method in AbstractItem because we won't
     * call getACL(Job) otherwise (single dispatch)
     */
1219
    @Override
1220
    public ACL getACL() {
1221
        return Jenkins.getInstance().getAuthorizationStrategy().getACL(this);
1222
    }
1223

1224 1225
    public BuildTimelineWidget getTimeline() {
        return new BuildTimelineWidget(getBuilds());
1226
    }
K
kohsuke 已提交
1227
}