Job.java 30.1 KB
Newer Older
K
kohsuke 已提交
1 2 3 4
package hudson.model;

import hudson.ExtensionPoint;
import hudson.Util;
5
import hudson.search.QuickSilver;
K
kohsuke 已提交
6 7 8 9
import hudson.search.SearchIndexBuilder;
import hudson.search.SearchIndex;
import hudson.search.SearchItem;
import hudson.search.SearchItems;
10
import hudson.model.Descriptor.FormException;
K
kohsuke 已提交
11 12 13
import hudson.tasks.BuildTrigger;
import hudson.tasks.LogRotator;
import hudson.util.ChartUtil;
K
kohsuke 已提交
14
import hudson.util.ColorPalette;
15
import hudson.util.CopyOnWriteList;
K
kohsuke 已提交
16 17 18 19
import hudson.util.DataSetBuilder;
import hudson.util.IOException2;
import hudson.util.RunList;
import hudson.util.ShiftedCategoryAxis;
K
kohsuke 已提交
20
import hudson.util.StackedAreaRenderer2;
K
kohsuke 已提交
21 22 23 24 25 26 27 28 29 30
import hudson.util.TextFile;
import org.apache.tools.ant.taskdefs.Copy;
import org.apache.tools.ant.types.FileSet;
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 已提交
31
import org.jfree.chart.renderer.category.StackedAreaRenderer;
K
kohsuke 已提交
32 33
import org.jfree.data.category.CategoryDataset;
import org.jfree.ui.RectangleInsets;
K
kohsuke 已提交
34
import org.kohsuke.stapler.Header;
K
kohsuke 已提交
35 36
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
K
kohsuke 已提交
37
import org.kohsuke.stapler.export.Exported;
K
kohsuke 已提交
38 39

import javax.servlet.ServletException;
K
kohsuke 已提交
40
import javax.servlet.http.HttpServletResponse;
K
kohsuke 已提交
41
import java.awt.Color;
K
kohsuke 已提交
42
import java.awt.Paint;
K
kohsuke 已提交
43 44
import java.io.File;
import java.io.IOException;
K
kohsuke 已提交
45
import java.text.ParseException;
K
kohsuke 已提交
46
import java.util.ArrayList;
47
import java.util.Collection;
K
kohsuke 已提交
48
import java.util.Collections;
K
kohsuke 已提交
49
import java.util.List;
50
import java.util.Map;
51
import java.util.SortedMap;
K
kohsuke 已提交
52 53 54 55 56 57 58 59 60 61

/**
 * A job is an runnable entity under the monitoring of Hudson.
 *
 * <p>
 * Every time it "runs", it will be recorded as a {@link Run} object.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class Job<JobT extends Job<JobT,RunT>, RunT extends Run<JobT,RunT>>
62
        extends AbstractItem implements ExtensionPoint {
K
kohsuke 已提交
63 64

    /**
K
kohsuke 已提交
65
     * Next build number.
K
kohsuke 已提交
66 67 68 69 70 71 72 73 74 75
     * 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 int nextBuildNumber = 1;

    private LogRotator logRotator;
76 77 78 79 80 81 82
    
    /**
     * 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;
K
kohsuke 已提交
83 84 85

    private boolean keepDependencies;

86 87 88
    /**
     * List of {@link UserProperty}s configured for this project.
     */
K
kohsuke 已提交
89
    protected CopyOnWriteList<JobProperty<? super JobT>> properties = new CopyOnWriteList<JobProperty<? super JobT>>();
90

91 92
    protected Job(ItemGroup parent,String name) {
        super(parent,name);
K
kohsuke 已提交
93 94
    }

95 96
    public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException {
        super.onLoad(parent, name);
K
kohsuke 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

        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 {
                this.nextBuildNumber = Integer.parseInt(f.readTrim());
            } catch (NumberFormatException e) {
                throw new IOException2(f+" doesn't contain a number",e);
            }
        } else {
            // this must be the old Hudson. create this file now.
            saveNextBuildNumber();
            save(); // and delete it from the config.xml
        }
113 114 115

        if(properties==null) // didn't exist < 1.72
            properties = new CopyOnWriteList<JobProperty<? super JobT>>();
K
kohsuke 已提交
116 117 118

        for (JobProperty p : properties)
            p.setOwner(this);
K
kohsuke 已提交
119 120
    }

121 122 123 124 125 126
    @Override
    public void onCopiedFrom(Item src) {
        super.onCopiedFrom(src);
        this.nextBuildNumber = 1;     // reset the next build number
    }

K
kohsuke 已提交
127
    private TextFile getNextBuildNumberFile() {
128
        return new TextFile(new File(this.getRootDir(),"nextBuildNumber"));
K
kohsuke 已提交
129 130
    }

131
    protected void saveNextBuildNumber() throws IOException {
K
kohsuke 已提交
132 133 134
        getNextBuildNumberFile().write(String.valueOf(nextBuildNumber)+'\n');
    }

K
kohsuke 已提交
135
    @Exported
K
kohsuke 已提交
136 137 138 139
    public boolean isInQueue() {
        return false;
    }

K
kohsuke 已提交
140 141 142
    /**
     * If this job is in the build queue, return its item.
     */
K
kohsuke 已提交
143
    @Exported
K
kohsuke 已提交
144 145 146 147
    public Queue.Item getQueueItem() {
        return null;
    }

148 149 150 151 152 153 154 155
    /**
     * Get the term used in the UI to represent this kind of {@link AbstractProject}.
     * Must start with a capital letter.
     */
    public String getPronoun() {
        return "Project";
    }

156 157 158 159 160 161 162
    /**
     * Returns whether the name of this job can be changed by user.
     */
    public boolean isNameEditable() {
        return true;
    }

K
kohsuke 已提交
163 164 165
    /**
     * If true, it will keep all the build logs of dependency components.
     */
K
kohsuke 已提交
166
    @Exported
K
kohsuke 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179
    public boolean isKeepDependencies() {
        return keepDependencies;
    }

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

180 181 182
    /**
     * Peeks the next build number.
     */
K
kohsuke 已提交
183
    @Exported
K
kohsuke 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    public int getNextBuildNumber() {
        return nextBuildNumber;
    }

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

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

199 200 201 202 203 204 205 206 207
    /**
     * Perform log rotation.
     */
    public void logRotate() throws IOException {
        LogRotator lr = getLogRotator();
        if(lr!=null)
            lr.perform(this);
    }

K
kohsuke 已提交
208 209 210 211 212 213 214
    /**
     * True if this instance supports log rotation configuration.
     */
    public boolean supportsLogRotator() {
        return true;
    }

K
kohsuke 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    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);
                }
K
kohsuke 已提交
233
            }).add("configure","config","configure");
K
kohsuke 已提交
234 235
    }

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

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    /**
     * Gets all the job properties configured for this job.
     */
    @SuppressWarnings("unchecked")
    public Map<JobPropertyDescriptor,JobProperty<? super JobT>> getProperties() {
        return Descriptor.toMap((Iterable)properties);
    }

    /**
     * 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;
    }

K
kohsuke 已提交
259 260
    /**
     * Renames a job.
K
kohsuke 已提交
261 262 263 264
     *
     * <p>
     * This method is defined on {@link Job} but really only applicable
     * for {@link Job}s that are top-level items.
K
kohsuke 已提交
265 266 267
     */
    public void renameTo(String newName) throws IOException {
        // always synchronize from bigger objects first
268
        final Hudson parent = Hudson.getInstance();
K
kohsuke 已提交
269
        assert this instanceof TopLevelItem;
K
kohsuke 已提交
270 271 272 273 274
        synchronized(parent) {
            synchronized(this) {
                // sanity check
                if(newName==null)
                    throw new IllegalArgumentException("New name is not given");
275
                if(parent.getItem(newName)!=null)
K
kohsuke 已提交
276 277 278 279 280 281 282 283
                    throw new IllegalArgumentException("Job "+newName+" already exists");

                // noop?
                if(this.name.equals(newName))
                    return;


                String oldName = this.name;
284
                File oldRoot = this.getRootDir();
K
kohsuke 已提交
285 286

                doSetName(newName);
287
                File newRoot = this.getRootDir();
K
kohsuke 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337

                {// rename data files
                    boolean interrupted=false;
                    boolean renamed = false;

                    // try to rename the job directory.
                    // this may fail on Windows due to some other processes accessing a file.
                    // so retry few times before we fall back to copy.
                    for( int retry=0; retry<5; retry++ ) {
                        if(oldRoot.renameTo(newRoot)) {
                            renamed = true;
                            break; // succeeded
                        }
                        try {
                            Thread.sleep(500);
                        } catch (InterruptedException e) {
                            // process the interruption later
                            interrupted = true;
                        }
                    }

                    if(interrupted)
                        Thread.currentThread().interrupt();

                    if(!renamed) {
                        // failed to rename. it must be that some lengthy process is going on
                        // to prevent a rename operation. So do a copy. Ideally we'd like to
                        // later delete the old copy, but we can't reliably do so, as before the VM
                        // shuts down there might be a new job created under the old name.
                        Copy cp = new Copy();
                        cp.setProject(new org.apache.tools.ant.Project());
                        cp.setTodir(newRoot);
                        FileSet src = new FileSet();
                        src.setDir(getRootDir());
                        cp.addFileset(src);
                        cp.setOverwrite(true);
                        cp.setPreserveLastModified(true);
                        cp.setFailOnError(false);   // keep going even if there's an error
                        cp.execute();

                        // try to delete as much as possible
                        try {
                            Util.deleteRecursive(oldRoot);
                        } catch (IOException e) {
                            // but ignore the error, since we expect that
                            e.printStackTrace();
                        }
                    }
                }

K
kohsuke 已提交
338
                parent.onRenamed((TopLevelItem)this,oldName,newName);
K
kohsuke 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

                // update BuildTrigger of other projects that point to this object.
                // can't we generalize this?
                for( Project p : parent.getProjects() ) {
                    BuildTrigger t = (BuildTrigger) p.getPublishers().get(BuildTrigger.DESCRIPTOR);
                    if(t!=null) {
                        if(t.onJobRenamed(oldName,newName))
                            p.save();
                    }
                }
            }
        }
    }

    /**
     * Returns true if we should display "build now" icon
     */
K
kohsuke 已提交
356
    @Exported
K
kohsuke 已提交
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    public abstract boolean isBuildable();

    /**
     * Gets all the builds.
     *
     * @return
     *      never null. The first entry is the latest buildCommand.
     */
    public List<RunT> getBuilds() {
        return new ArrayList<RunT>(_getRuns().values());
    }

    /**
     * Gets all the builds in a map.
     */
    public SortedMap<Integer,RunT> getBuildsAsMap() {
        return Collections.unmodifiableSortedMap(_getRuns());
    }

    /**
     * @deprecated
     *      This is only used to support backward compatibility with
     *      old URLs.
     */
J
jglick 已提交
381
    @Deprecated
K
kohsuke 已提交
382 383 384 385 386 387 388 389 390 391 392
    public RunT getBuild(String id) {
        for (RunT r : _getRuns().values()) {
            if(r.getId().equals(id))
                return r;
        }
        return null;
    }

    /**
     * @param n
     *      The build number.
K
kohsuke 已提交
393 394
     * @return
     *      null if no such build exists.
K
kohsuke 已提交
395 396 397 398 399 400
     * @see Run#getNumber()
     */
    public RunT getBuildByNumber(int n) {
        return _getRuns().get(n);
    }

K
kohsuke 已提交
401
    /**
K
kohsuke 已提交
402
     * Gets the youngest build #m that satisfies <tt>n&lt;=m</tt>.
K
kohsuke 已提交
403 404 405 406
     *
     * This is useful when you'd like to fetch a build but the exact build might be already
     * gone (deleted, rotated, etc.)
     */
K
kohsuke 已提交
407
    public final RunT getNearestBuild(int n) {
K
kohsuke 已提交
408
        SortedMap<Integer, ? extends RunT> m = _getRuns().headMap(n-1); // the map should include n, so n-1
K
kohsuke 已提交
409
        if(m.isEmpty()) return null;
410
        return m.get(m.lastKey());
K
kohsuke 已提交
411 412
    }

K
kohsuke 已提交
413 414 415 416 417 418 419 420 421 422 423 424
    /**
     * 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());
    }

K
kohsuke 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    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) {
            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() {
444
        return new File(getRootDir(),"builds");
K
kohsuke 已提交
445 446 447 448 449 450
    }

    /**
     * Gets all the runs.
     *
     * The resulting map must be immutable (by employing copy-on-write semantics.)
451
     * The map is descending order, with newest builds at the top.
K
kohsuke 已提交
452 453 454 455 456 457 458 459 460 461 462 463 464 465
     */
    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.
     */
466
    @Exported @QuickSilver
K
kohsuke 已提交
467 468 469 470 471 472 473 474 475 476
    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.
     */
477
    @Exported @QuickSilver
K
kohsuke 已提交
478 479 480 481 482 483 484 485 486
    public RunT getFirstBuild() {
        SortedMap<Integer,? extends RunT> runs = _getRuns();

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

    /**
     * Returns the last successful build, if any. Otherwise null.
K
kohsuke 已提交
487
     * A stable build would include either {@link Result#SUCCESS} or {@link Result#UNSTABLE}.
488
     * @see #getLastStableBuild()
K
kohsuke 已提交
489
     */
490
    @Exported @QuickSilver
K
kohsuke 已提交
491 492 493 494 495 496 497 498 499 500 501
    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;
    }

    /**
     * Returns the last stable build, if any. Otherwise null.
     */
502
    @Exported @QuickSilver
K
kohsuke 已提交
503 504 505 506 507 508 509 510 511 512
    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.
     */
513
    @Exported @QuickSilver
K
kohsuke 已提交
514 515 516 517 518 519 520 521 522 523
    public RunT getLastFailedBuild() {
        RunT r = getLastBuild();
        while(r!=null && (r.isBuilding() || r.getResult()!=Result.FAILURE))
            r=r.getPreviousBuild();
        return r;
    }

    /**
     * Used as the color of the status ball for the project.
     */
K
kohsuke 已提交
524
    @Exported(visibility=2,name="color")
525
    public BallColor getIconColor() {
K
kohsuke 已提交
526 527 528 529 530 531 532
        RunT lastBuild = getLastBuild();
        while(lastBuild!=null && lastBuild.hasntStartedYet())
            lastBuild = lastBuild.getPreviousBuild();

        if(lastBuild!=null)
            return lastBuild.getIconColor();
        else
533
            return BallColor.GREY;
K
kohsuke 已提交
534 535
    }

S
stephenconnolly 已提交
536 537 538 539 540
    /**
     * Get the current health report for a job.
     * @return
     *     the health report.  Never returns null
     */
541
    public HealthReport getBuildHealth() {
542 543 544
        List<HealthReport> reports = getBuildHealthReports();
        return reports.isEmpty() ? new HealthReport() : reports.get(0);
    }
S
stephenconnolly 已提交
545

546 547
    public List<HealthReport> getBuildHealthReports() {
        List<HealthReport> reports = new ArrayList<HealthReport>();
S
stephenconnolly 已提交
548
        RunT lastBuild = getLastBuild();
549 550

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

555 556 557 558 559 560 561
        // check the cache
        if (cachedBuildHealthReportsBuildNumber != null && 
                cachedBuildHealthReports != null &&
                lastBuild != null &&
                cachedBuildHealthReportsBuildNumber.intValue() == lastBuild.getNumber()) {
            reports.addAll(cachedBuildHealthReports);
        } else if (lastBuild != null) {
S
stephenconnolly 已提交
562
            for (HealthReportingAction healthReportingAction : lastBuild.getActions(HealthReportingAction.class)) {
563 564
                final HealthReport report = healthReportingAction.getBuildHealth();
                if (report != null) {
565 566 567 568 569
                    if (report.isAggregateReport()) {
                        reports.addAll(report.getAggregatedReports());
                    } else {
                        reports.add(report);
                    }
570 571 572 573
                }
            }
            final HealthReport report = getBuildStabilityHealthReport();
            if (report != null) {
574 575 576 577 578
                if (report.isAggregateReport()) {
                    reports.addAll(report.getAggregatedReports());
                } else {
                    reports.add(report);
                }
579
            }
580 581 582 583 584 585

            Collections.sort(reports);
    
            // store the cache
            cachedBuildHealthReportsBuildNumber = lastBuild.getNumber();
            cachedBuildHealthReports = new ArrayList<HealthReport>(reports);
586
        }
S
stephenconnolly 已提交
587

588
        return reports;
S
stephenconnolly 已提交
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
    }

    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);
            if (score < 100 && score > 0) {
                // HACK
                // force e.g. 4/5 to be in the 60-79 range
                score--;
            }

            StringBuilder description = new StringBuilder("Build stability: ");
            if (failCount == 0) {
                description.append("No recent builds failed.");
            } 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
                description.append("All recent builds failed.");
            } else {
                description.append(failCount);
                description.append(" out of the last ");
                description.append(totalCount);
                description.append(" builds failed.");
            }
            return new HealthReport(score,  description.toString());
        }
        return null;
639
    }
K
kohsuke 已提交
640 641 642 643 644 645 646 647 648

//
//
// actions
//
//
    /**
     * Accepts submission from the configuration page.
     */
649 650
    public synchronized void doConfigSubmit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        if (!Hudson.adminCheck(req, rsp))
K
kohsuke 已提交
651 652 653 654 655 656
            return;

        req.setCharacterEncoding("UTF-8");

        description = req.getParameter("description");

657
        if (req.getParameter("logrotate") != null)
K
kohsuke 已提交
658 659 660 661
            logRotator = LogRotator.DESCRIPTOR.newInstance(req);
        else
            logRotator = null;

662
        keepDependencies = req.getParameter("keepDependencies") != null;
K
kohsuke 已提交
663

664 665
        try {
            properties.clear();
K
kohsuke 已提交
666
            for (JobPropertyDescriptor d : JobPropertyDescriptor.getPropertyDescriptors(Job.this.getClass())) {
667
                JobProperty prop = d.newInstance(req,null);
K
kohsuke 已提交
668 669
                if (prop != null) {
                    prop.setOwner(this);
670
                    properties.add(prop);
K
kohsuke 已提交
671
                }
672
            }
673 674 675 676 677 678 679

            submit(req,rsp);

            save();

            String newName = req.getParameter("name");
            if(newName!=null && !newName.equals(name)) {
K
kohsuke 已提交
680 681 682 683 684 685 686
                // check this error early to avoid HTTP response splitting.
                try {
                    Hudson.checkGoodName(newName);
                } catch (ParseException e) {
                    sendError(e,req,rsp);
                    return;
                }
687 688 689 690
                rsp.sendRedirect("rename?newName="+newName);
            } else {
                rsp.sendRedirect(".");
            }
691
        } catch (FormException e) {
692
            sendError(e,req,rsp);
693
        }
694
    }
K
kohsuke 已提交
695

696 697 698 699
    /**
     * Derived class can override this to perform additional config submission work.
     */
    protected void submit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException, FormException {
K
kohsuke 已提交
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
    }

    /**
     * Returns the image that shows the current buildCommand status.
     */
    public void doBuildStatus( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        rsp.sendRedirect2(req.getContextPath()+"/nocacheImages/48x48/"+getBuildStatusUrl());
    }

    public String getBuildStatusUrl() {
        return getIconColor()+".gif";
    }

    /**
     * Returns the graph that shows how long each build took.
     */
    public void doBuildTimeGraph( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
717 718 719 720
        if(getLastBuild()==null) {
            rsp.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
K
kohsuke 已提交
721 722
        if(req.checkIfModified(getLastBuild().getTimestamp(),rsp))
            return;
K
kohsuke 已提交
723 724 725
        ChartUtil.generateGraph(req,rsp, createBuildTimeTrendChart(),500,400);
    }

K
kohsuke 已提交
726 727 728 729
    /**
     * Returns the clickable map for the build time graph.
     * Loaded lazily by AJAX.
     */
K
kohsuke 已提交
730
    public void doBuildTimeGraphMap( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
731 732 733 734
        if(getLastBuild()==null) {
            rsp.setStatus(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
K
kohsuke 已提交
735 736
        if(req.checkIfModified(getLastBuild().getTimestamp(),rsp))
            return;
K
kohsuke 已提交
737 738 739 740
        ChartUtil.generateClickableMap(req,rsp, createBuildTimeTrendChart(),500,400);
    }

    private JFreeChart createBuildTimeTrendChart() {
741
        class ChartLabel implements Comparable<ChartLabel> {
K
kohsuke 已提交
742
            final Run run;
K
kohsuke 已提交
743

744
            public ChartLabel(Run r) {
K
kohsuke 已提交
745 746 747
                this.run = r;
            }

748
            public int compareTo(ChartLabel that) {
K
kohsuke 已提交
749 750 751 752
                return this.run.number-that.run.number;
            }

            public boolean equals(Object o) {
753
                ChartLabel that = (ChartLabel) o;
K
kohsuke 已提交
754 755 756
                return run ==that.run;
            }

K
kohsuke 已提交
757
            public Color getColor() {
K
kohsuke 已提交
758
                // TODO: consider gradation. See http://www.javadrive.jp/java2d/shape/index9.html
K
kohsuke 已提交
759 760 761 762 763 764 765
                Result r = run.getResult();
                if(r ==Result.FAILURE || r== Result.ABORTED)
                    return ColorPalette.RED;
                else
                    return ColorPalette.BLUE;
            }

K
kohsuke 已提交
766 767 768 769 770 771 772 773 774 775 776 777 778
            public int hashCode() {
                return run.hashCode();
            }

            public String toString() {
                String l = run.getDisplayName();
                if(run instanceof Build) {
                    String s = ((Build)run).getBuiltOnStr();
                    if(s!=null)
                        l += ' '+s;
                }
                return l;
            }
K
kohsuke 已提交
779

K
kohsuke 已提交
780 781
        }

782
        DataSetBuilder<String,ChartLabel> data = new DataSetBuilder<String, ChartLabel>();
K
kohsuke 已提交
783 784
        for( Run r : getBuilds() ) {
            if(r.isBuilding())  continue;
785
            data.add( ((double)r.getDuration())/(1000*60), "mins", new ChartLabel(r));
K
kohsuke 已提交
786
        }
K
kohsuke 已提交
787

K
kohsuke 已提交
788
        final CategoryDataset dataset = data.build();
K
kohsuke 已提交
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

        final JFreeChart chart = ChartFactory.createStackedAreaChart(
            null,                   // chart title
            null,                   // unused
            "min",                  // 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();
        rangeAxis.setStandardTickUnits(NumberAxis.createIntegerTickUnits());

K
kohsuke 已提交
824 825
        StackedAreaRenderer ar = new StackedAreaRenderer2() {
            @Override
K
kohsuke 已提交
826
            public Paint getItemPaint(int row, int column) {
827
                ChartLabel key = (ChartLabel) dataset.getColumnKey(column);
K
kohsuke 已提交
828 829
                return key.getColor();
            }
K
kohsuke 已提交
830 831 832

            @Override
            public String generateURL(CategoryDataset dataset, int row, int column) {
833
                ChartLabel label = (ChartLabel) dataset.getColumnKey(column);
K
kohsuke 已提交
834
                return String.valueOf(label.run.number);
K
kohsuke 已提交
835
            }
K
kohsuke 已提交
836 837

            @Override
K
kohsuke 已提交
838
            public String generateToolTip(CategoryDataset dataset, int row, int column) {
839
                ChartLabel label = (ChartLabel) dataset.getColumnKey(column);
K
kohsuke 已提交
840
                return label.run.getDisplayName() + " : " + label.run.getDurationString();
K
kohsuke 已提交
841
            }
K
kohsuke 已提交
842
        };
K
kohsuke 已提交
843
        plot.setRenderer(ar);
K
kohsuke 已提交
844 845 846 847

        // crop extra space around the graph
        plot.setInsets(new RectangleInsets(0,0,0,5.0));

K
kohsuke 已提交
848
        return chart;
K
kohsuke 已提交
849 850 851 852 853
    }

    /**
     * Renames this job.
     */
854
    public /*not synchronized. see renameTo()*/ void doDoRename( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
K
kohsuke 已提交
855 856 857 858
        if(!Hudson.adminCheck(req,rsp))
            return;

        String newName = req.getParameter("newName");
859 860 861 862 863 864
        try {
            Hudson.checkGoodName(newName);
        } catch (ParseException e) {
            sendError(e,req,rsp);
            return;
        }
K
kohsuke 已提交
865 866

        renameTo(newName);
K
kohsuke 已提交
867 868 869
        // 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());
K
kohsuke 已提交
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
    /**
     * Handles AJAX requests from browsers to update build history.
     *
     * @param n
     *      The build number to fetch
     */
    public void doAjaxBuildHistoryUpdate( StaplerRequest req, StaplerResponse rsp,
                  @Header("n") int n ) throws IOException, ServletException {

        rsp.setContentType("text/html;charset=UTF-8");

        // pick up builds to send back
        Collection<? extends RunT> builds = _getRuns().headMap(n-1).values();

        req.setAttribute("builds",builds);

        int next = getNextBuildNumber();
        if(!builds.isEmpty()) {
            RunT b = builds.iterator().next();
            next = b.getNumber();
            if(!b.isBuilding())  next++;
        }
        rsp.setHeader("n",String.valueOf(next));

        req.getView(this,"ajaxBuildHistory.jelly").forward(req,rsp);
    }

K
kohsuke 已提交
899 900 901 902 903 904 905 906 907 908 909 910
    public void doRssAll( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rss(req, rsp, " all builds", new RunList(this));
    }
    public void doRssFailed( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rss(req, rsp, " failed builds", new RunList(this).failureOnly());
    }

    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 );
    }
}