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

import com.thoughtworks.xstream.XStream;
import groovy.lang.GroovyShell;
5
import hudson.BasicAuthenticationFilter;
K
kohsuke 已提交
6
import hudson.FeedAdapter;
7
import hudson.FilePath;
8
import hudson.Functions;
K
kohsuke 已提交
9
import hudson.Launcher;
K
kohsuke 已提交
10
import hudson.Launcher.LocalLauncher;
K
kohsuke 已提交
11 12 13
import hudson.Plugin;
import hudson.PluginManager;
import hudson.PluginWrapper;
K
kohsuke 已提交
14
import hudson.TcpSlaveAgentListener;
15
import hudson.Util;
K
kohsuke 已提交
16
import static hudson.Util.fixEmpty;
17
import hudson.XmlFile;
K
kohsuke 已提交
18
import hudson.model.Descriptor.FormException;
19
import hudson.model.listeners.ItemListener;
K
kohsuke 已提交
20
import hudson.model.listeners.JobListener;
21
import hudson.model.listeners.JobListener.JobListenerAdapter;
K
kohsuke 已提交
22
import hudson.model.listeners.SCMListener;
K
kohsuke 已提交
23 24
import hudson.remoting.LocalChannel;
import hudson.remoting.VirtualChannel;
K
kohsuke 已提交
25
import hudson.scm.CVSSCM;
K
kohsuke 已提交
26 27
import hudson.scm.RepositoryBrowser;
import hudson.scm.RepositoryBrowsers;
28 29 30
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
import hudson.scm.SCMS;
K
kohsuke 已提交
31
import hudson.search.CollectionSearchIndex;
32
import hudson.search.SearchIndexBuilder;
33 34 35 36 37 38 39 40
import hudson.tasks.BuildStep;
import hudson.tasks.BuildWrapper;
import hudson.tasks.BuildWrappers;
import hudson.tasks.Builder;
import hudson.tasks.DynamicLabeler;
import hudson.tasks.LabelFinder;
import hudson.tasks.Mailer;
import hudson.tasks.Publisher;
K
kohsuke 已提交
41
import hudson.triggers.Trigger;
42
import hudson.triggers.TriggerDescriptor;
43
import hudson.triggers.Triggers;
44
import hudson.util.ClockDifference;
45
import hudson.util.CopyOnWriteList;
K
kohsuke 已提交
46
import hudson.util.CopyOnWriteMap;
47
import hudson.util.DaemonThreadFactory;
K
kohsuke 已提交
48
import hudson.util.FormFieldValidator;
49 50
import hudson.util.MultipartFormDataParser;
import hudson.util.XStream2;
K
kohsuke 已提交
51 52 53
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
54
import org.kohsuke.stapler.Stapler;
K
kohsuke 已提交
55 56
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
57
import org.kohsuke.stapler.export.Exported;
K
kohsuke 已提交
58 59 60

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
K
kohsuke 已提交
61
import javax.servlet.http.Cookie;
K
kohsuke 已提交
62
import javax.servlet.http.HttpServletRequest;
K
kohsuke 已提交
63 64
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
K
kohsuke 已提交
65 66 67
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
68
import java.io.FileOutputStream;
K
kohsuke 已提交
69 70 71 72 73 74
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
K
kohsuke 已提交
75
import java.util.Calendar;
K
kohsuke 已提交
76 77 78
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
K
kohsuke 已提交
79
import java.util.GregorianCalendar;
K
kohsuke 已提交
80 81 82 83 84 85
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
86 87
import java.util.Stack;
import java.util.StringTokenizer;
K
kohsuke 已提交
88 89
import java.util.TreeSet;
import java.util.Vector;
90
import java.util.concurrent.Callable;
91
import java.util.concurrent.ConcurrentHashMap;
92 93 94 95 96 97
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
K
kohsuke 已提交
98
import java.util.logging.Level;
K
kohsuke 已提交
99
import java.util.logging.LogRecord;
100
import java.util.logging.Logger;
101
import java.util.regex.Pattern;
K
kohsuke 已提交
102 103 104 105 106 107

/**
 * Root object of the system.
 *
 * @author Kohsuke Kawaguchi
 */
108
public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node {
K
kohsuke 已提交
109 110 111 112 113
    private transient final Queue queue = new Queue();

    /**
     * {@link Computer}s in this Hudson system. Read-only.
     */
K
kohsuke 已提交
114
    private transient final Map<Node,Computer> computers = new CopyOnWriteMap.Hash<Node,Computer>();
K
kohsuke 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

    /**
     * Number of executors of the master node.
     */
    private int numExecutors = 2;

    /**
     * False to enable anyone to do anything.
     */
    private boolean useSecurity = false;

    /**
     * Message displayed in the top page.
     */
    private String systemMessage;

    /**
     * Root directory of the system.
     */
    public transient final File root;

136 137 138
    /**
     * All {@link Item}s keyed by their {@link Item#getName() name}s.
     */
K
kohsuke 已提交
139
    /*package*/ transient final Map<String,TopLevelItem> items = new CopyOnWriteMap.Tree<String,TopLevelItem>();
140

K
kohsuke 已提交
141 142 143 144 145 146 147 148
    /**
     * The sole instance.
     */
    private static Hudson theInstance;

    private transient boolean isQuietingDown;
    private transient boolean terminating;

149
    private List<JDK> jdks = new ArrayList<JDK>();
K
kohsuke 已提交
150

151 152
    private transient volatile DependencyGraph dependencyGraph = DependencyGraph.EMPTY;

K
kohsuke 已提交
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    /**
     * Set of installed cluster nodes.
     *
     * We use this field with copy-on-write semantics.
     * This field has mutable list (to keep the serialization look clean),
     * but it shall never be modified. Only new completely populated slave
     * list can be set here.
     */
    private volatile List<Slave> slaves;

    /**
     * Quiet period.
     *
     * This is {@link Integer} so that we can initialize it to '5' for upgrading users.
     */
    /*package*/ Integer quietPeriod;

    /**
171
     * {@link ListView}s.
K
kohsuke 已提交
172
     */
173
    private List<ListView> views;   // can't initialize it eagerly for backward compatibility
K
kohsuke 已提交
174 175 176 177 178 179 180 181

    private transient final FingerprintMap fingerprintMap = new FingerprintMap();

    /**
     * Loaded plugins.
     */
    public transient final PluginManager pluginManager;

182
    public transient volatile TcpSlaveAgentListener tcpSlaveAgentListener;
K
kohsuke 已提交
183

184
    /**
K
kohsuke 已提交
185
     * List of registered {@link JobListener}s.
186
     */
187
    private transient final CopyOnWriteList<ItemListener> viewItemListeners = new CopyOnWriteList<ItemListener>();
188 189 190 191 192

    /**
     * List of registered {@link SCMListener}s.
     */
    private transient final CopyOnWriteList<SCMListener> scmListeners = new CopyOnWriteList<SCMListener>();
193

194 195
    /**
     * TCP slave agent port.
196
     * 0 for random, -1 to disable.
197 198 199
     */
    private int slaveAgentPort =0;

200 201 202 203 204 205 206
    /**
     * Once plugin is uploaded, this flag becomes true.
     * This is used to report a message that Hudson needs to be restarted
     * for new plugins to take effect.
     */
    private transient boolean pluginUploaded =false;

207 208 209 210 211
    /**
     * All labels known to Hudson. This allows us to reuse the same label instances
     * as much as possible, even though that's not a strict requirement.
     */
    private transient final ConcurrentHashMap<String,Label> labels = new ConcurrentHashMap<String,Label>();
212 213
    private transient Set<Label> labelSet;
    private transient Set<Label> dynamicLabels = null;
214

K
kohsuke 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228
    public static Hudson getInstance() {
        return theInstance;
    }


    public Hudson(File root, ServletContext context) throws IOException {
        this.root = root;
        if(theInstance!=null)
            throw new IllegalStateException("second instance");
        theInstance = this;

        // load plugins.
        pluginManager = new PluginManager(context);

229 230 231 232
        if(slaveAgentPort!=-1)
            tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
        else
            tcpSlaveAgentListener = null;
K
kohsuke 已提交
233

234
        // work around to have MavenModule register itself until we either move it to a plugin
235
        // or make it a part of the core.
236
        Items.LIST.hashCode();
237

K
kohsuke 已提交
238 239 240 241 242
        load();
        if(slaves==null)    slaves = new ArrayList<Slave>();
        updateComputerList();

        getQueue().load();
K
kohsuke 已提交
243

244
        for (ItemListener l : viewItemListeners)
245
            l.onLoaded();
K
kohsuke 已提交
246 247
    }

K
kohsuke 已提交
248 249 250 251
    public TcpSlaveAgentListener getTcpSlaveAgentListener() {
        return tcpSlaveAgentListener;
    }

K
kohsuke 已提交
252
    @Exported
253 254 255 256
    public int getSlaveAgentPort() {
        return slaveAgentPort;
    }

K
kohsuke 已提交
257
    /**
J
jglick 已提交
258
     * If you are calling this on Hudson something is wrong.
K
kohsuke 已提交
259 260 261
     *
     * @deprecated
     */
J
jglick 已提交
262
    @Deprecated
K
kohsuke 已提交
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    public String getNodeName() {
        return "";
    }

    public String getNodeDescription() {
        return "the master Hudson node";
    }

    public String getDescription() {
        return systemMessage;
    }

    public PluginManager getPluginManager() {
        return pluginManager;
    }

    /**
     * Gets the SCM descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<SCM> getScm(String shortClassName) {
        return findDescriptor(shortClassName,SCMS.SCMS);
    }

K
kohsuke 已提交
286 287 288 289 290 291 292
    /**
     * Gets the repository browser descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<RepositoryBrowser<?>> getRepositoryBrowser(String shortClassName) {
        return findDescriptor(shortClassName,RepositoryBrowsers.LIST);
    }

K
kohsuke 已提交
293 294 295 296 297 298 299
    /**
     * Gets the builder descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<Builder> getBuilder(String shortClassName) {
        return findDescriptor(shortClassName, BuildStep.BUILDERS);
    }

K
kohsuke 已提交
300 301 302 303 304 305 306
    /**
     * Gets the build wrapper descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<BuildWrapper> getBuildWrapper(String shortClassName) {
        return findDescriptor(shortClassName, BuildWrappers.WRAPPERS);
    }

K
kohsuke 已提交
307 308 309 310 311 312 313
    /**
     * Gets the publisher descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<Publisher> getPublisher(String shortClassName) {
        return findDescriptor(shortClassName, BuildStep.PUBLISHERS);
    }

K
kohsuke 已提交
314 315 316
    /**
     * Gets the trigger descriptor by name. Primarily used for making them web-visible.
     */
317 318
    public TriggerDescriptor getTrigger(String shortClassName) {
        return (TriggerDescriptor)findDescriptor(shortClassName, Triggers.TRIGGERS);
K
kohsuke 已提交
319 320
    }

321 322 323 324 325 326 327
    /**
     * Gets the {@link JobPropertyDescriptor} by name. Primarily used for making them web-visible.
     */
    public JobPropertyDescriptor getJobProperty(String shortClassName) {
        return (JobPropertyDescriptor)findDescriptor(shortClassName, Jobs.PROPERTIES);
    }

K
kohsuke 已提交
328 329 330 331
    /**
     * Finds a descriptor that has the specified name.
     */
    private <T extends Describable<T>>
332
    Descriptor<T> findDescriptor(String shortClassName, Collection<? extends Descriptor<T>> descriptors) {
K
kohsuke 已提交
333 334 335 336 337 338 339 340
        String name = '.'+shortClassName;
        for (Descriptor<T> d : descriptors) {
            if(d.clazz.getName().endsWith(name))
                return d;
        }
        return null;
    }

341 342 343
    /**
     * Adds a new {@link JobListener}.
     *
344 345
     * @deprecated
     *      Use {@code getJobListners().add(l)} instead.
346 347
     */
    public void addListener(JobListener l) {
348
        viewItemListeners.add(new JobListenerAdapter(l));
349 350 351 352 353
    }

    /**
     * Deletes an existing {@link JobListener}.
     *
354 355
     * @deprecated
     *      Use {@code getJobListners().remove(l)} instead.
356 357
     */
    public boolean removeListener(JobListener l ) {
358
        return viewItemListeners.remove(new JobListenerAdapter(l));
359 360
    }

361
    /**
362
     * Gets all the installed {@link ItemListener}s.
363
     */
364 365
    public CopyOnWriteList<ItemListener> getJobListeners() {
        return viewItemListeners;
366 367 368 369 370 371 372 373 374
    }

    /**
     * Gets all the installed {@link SCMListener}s.
     */
    public CopyOnWriteList<SCMListener> getSCMListeners() {
        return scmListeners;
    }

K
kohsuke 已提交
375 376 377 378 379 380 381 382 383 384
    /**
     * Gets the plugin object from its short name.
     *
     * <p>
     * This allows URL <tt>hudson/plugin/ID</tt> to be served by the views
     * of the plugin class.
     */
    public Plugin getPlugin(String shortName) {
        PluginWrapper p = pluginManager.getPlugin(shortName);
        if(p==null)     return null;
385
        return p.getPlugin();
K
kohsuke 已提交
386 387 388 389 390 391 392 393 394 395
    }

    /**
     * Synonym to {@link #getNodeDescription()}.
     */
    public String getSystemMessage() {
        return systemMessage;
    }

    public Launcher createLauncher(TaskListener listener) {
K
kohsuke 已提交
396
        return new LocalLauncher(listener);
K
kohsuke 已提交
397 398 399 400 401 402 403 404 405
    }

    /**
     * Updates {@link #computers} by using {@link #getSlaves()}.
     *
     * <p>
     * This method tries to reuse existing {@link Computer} objects
     * so that we won't upset {@link Executor}s running in it.
     */
K
kohsuke 已提交
406
    private void updateComputerList() throws IOException {
407
        synchronized(computers) {// this synchronization is still necessary so that no two update happens concurrently
K
kohsuke 已提交
408
            Map<String,Computer> byName = new HashMap<String,Computer>();
K
kohsuke 已提交
409 410 411
            for (Computer c : computers.values()) {
                if(c.getNode()==null)
                    continue;   // this computer is gone
K
kohsuke 已提交
412
                byName.put(c.getNode().getNodeName(),c);
K
kohsuke 已提交
413
            }
K
kohsuke 已提交
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435

            Set<Computer> old = new HashSet<Computer>(computers.values());
            Set<Computer> used = new HashSet<Computer>();

            updateComputer(this, byName, used);
            for (Slave s : getSlaves())
                updateComputer(s, byName, used);

            // find out what computers are removed, and kill off all executors.
            // when all executors exit, it will be removed from the computers map.
            // so don't remove too quickly
            old.removeAll(used);
            for (Computer c : old) {
                c.kill();
            }
        }
        getQueue().scheduleMaintenance();
    }

    private void updateComputer(Node n, Map<String,Computer> byNameMap, Set<Computer> used) {
        Computer c;
        c = byNameMap.get(n.getNodeName());
K
kohsuke 已提交
436 437
        if (c!=null) {
            c.setNode(n); // reuse
K
kohsuke 已提交
438
        } else {
K
kohsuke 已提交
439 440
            if(n.getNumExecutors()>0)
                computers.put(n,c=n.createComputer());
K
kohsuke 已提交
441 442 443 444 445
        }
        used.add(c);
    }

    /*package*/ void removeComputer(Computer computer) {
446 447
        for (Entry<Node, Computer> e : computers.entrySet()) {
            if (e.getValue() == computer) {
K
kohsuke 已提交
448
                computers.remove(e.getKey());
449
                return;
K
kohsuke 已提交
450 451 452 453 454
            }
        }
        throw new IllegalStateException("Trying to remove unknown computer");
    }

455 456 457 458
    public String getFullName() {
        return "";
    }

459 460 461 462
    public String getFullDisplayName() {
        return "";
    }

463 464 465
    /**
     * Gets just the immediate children of {@link Hudson}.
     *
466
     * @see #getAllItems(Class)
467
     */
K
kohsuke 已提交
468
    public List<TopLevelItem> getItems() {
469
        return new ArrayList<TopLevelItem>(items.values());
470 471
    }

472 473 474 475 476 477 478 479 480 481 482 483 484 485
    /**
     * Gets all the {@link Item}s recursively in the {@link ItemGroup} tree
     * and filter them by the given type.
     */
    public <T extends Item> List<T> getAllItems(Class<T> type) {
        List<T> r = new ArrayList<T>();

        Stack<ItemGroup> q = new Stack<ItemGroup>();
        q.push(this);

        while(!q.isEmpty()) {
            ItemGroup<?> parent = q.pop();
            for (Item i : parent.getItems()) {
                if(type.isInstance(i))
K
typo.  
kohsuke 已提交
486
                    r.add(type.cast(i));
487 488 489 490 491 492 493 494
                if(i instanceof ItemGroup)
                    q.push((ItemGroup)i);
            }
        }

        return r;
    }

K
kohsuke 已提交
495
    /**
K
kohsuke 已提交
496 497 498 499 500
     * Gets the list of all the projects.
     *
     * <p>
     * Since {@link Project} can only show up under {@link Hudson},
     * no need to search recursively.
K
kohsuke 已提交
501
     */
K
kohsuke 已提交
502
    public List<Project> getProjects() {
K
kohsuke 已提交
503
        return Util.createSubList(items.values(),Project.class);
K
kohsuke 已提交
504 505 506 507 508
    }

    /**
     * Gets the names of all the {@link Job}s.
     */
K
kohsuke 已提交
509
    public Collection<String> getJobNames() {
510
        List<String> names = new ArrayList<String>();
K
kohsuke 已提交
511 512
        for (Job j : getAllItems(Job.class))
            names.add(j.getName());
513
        return names;
K
kohsuke 已提交
514 515
    }

516 517 518 519 520 521 522 523 524 525
    /**
     * Gets the names of all the {@link TopLevelItem}s.
     */
    public Collection<String> getTopLevelItemNames() {
        List<String> names = new ArrayList<String>();
        for (TopLevelItem j : items.values())
            names.add(j.getName());
        return names;
    }

K
kohsuke 已提交
526 527 528 529 530 531
    /**
     * Every job belongs to us.
     *
     * @deprecated
     *      why are you calling a method that always return true?
     */
J
jglick 已提交
532
    @Deprecated
533
    public boolean contains(TopLevelItem view) {
K
kohsuke 已提交
534 535 536
        return true;
    }

537
    public synchronized View getView(String name) {
K
kohsuke 已提交
538
        if(views!=null) {
539
            for (ListView v : views) {
K
kohsuke 已提交
540 541 542 543 544 545 546 547 548 549 550
                if(v.getViewName().equals(name))
                    return v;
            }
        }
        if(this.getViewName().equals(name))
            return this;
        else
            return null;
    }

    /**
551
     * Gets the read-only list of all {@link View}s.
K
kohsuke 已提交
552
     */
553
    @Exported
554
    public synchronized View[] getViews() {
K
kohsuke 已提交
555
        if(views==null)
556 557
            views = new ArrayList<ListView>();
        View[] r = new View[views.size()+1];
K
kohsuke 已提交
558 559 560
        views.toArray(r);
        // sort Views and put "all" at the very beginning
        r[r.length-1] = r[0];
561
        Arrays.sort(r,1,r.length, View.SORTER);
K
kohsuke 已提交
562 563 564 565
        r[0] = this;
        return r;
    }

566
    public synchronized void deleteView(ListView view) throws IOException {
K
kohsuke 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 580
        if(views!=null) {
            views.remove(view);
            save();
        }
    }

    public String getViewName() {
        return "All";
    }

    /**
     * Gets the read-only list of all {@link Computer}s.
     */
    public Computer[] getComputers() {
581 582 583 584 585
        Computer[] r = computers.values().toArray(new Computer[computers.size()]);
        Arrays.sort(r,new Comparator<Computer>() {
            public int compare(Computer lhs, Computer rhs) {
                if(lhs.getNode()==Hudson.this)  return -1;
                if(rhs.getNode()==Hudson.this)  return 1;
K
kohsuke 已提交
586
                return lhs.getDisplayName().compareTo(rhs.getDisplayName());
587 588 589
            }
        });
        return r;
K
kohsuke 已提交
590 591 592
    }

    public Computer getComputer(String name) {
K
kohsuke 已提交
593 594 595
        if(name.equals("(master)"))
            name = "";

596 597 598
        for (Computer c : computers.values()) {
            if(c.getNode().getNodeName().equals(name))
                return c;
K
kohsuke 已提交
599 600 601 602
        }
        return null;
    }

K
kohsuke 已提交
603 604 605 606 607 608 609 610
    /**
     * @deprecated
     *      UI method. Not meant to be used programatically.
     */
    public ComputerSet getComputer() {
        return new ComputerSet();
    }

611 612 613 614 615 616
    /**
     * Gets the label that exists on this system by the name.
     *
     * @return null if no such label exists.
     */
    public Label getLabel(String name) {
K
kohsuke 已提交
617
        if(name==null)  return null;
618 619 620 621 622 623 624 625 626 627 628
        while(true) {
            Label l = labels.get(name);
            if(l!=null)
                return l;

            // non-existent
            labels.putIfAbsent(name,new Label(name));
        }
    }

    /**
629
     * Gets all the active labels in the current system.
630 631 632 633 634 635 636 637 638 639
     */
    public Set<Label> getLabels() {
        Set<Label> r = new TreeSet<Label>();
        for (Label l : labels.values()) {
            if(!l.getNodes().isEmpty())
                r.add(l);
        }
        return r;
    }

K
kohsuke 已提交
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
    public Queue getQueue() {
        return queue;
    }

    public String getDisplayName() {
        return "Hudson";
    }

    public List<JDK> getJDKs() {
        if(jdks==null)
            jdks = new ArrayList<JDK>();
        return jdks;
    }

    /**
     * Gets the JDK installation of the given name, or returns null.
     */
    public JDK getJDK(String name) {
K
kohsuke 已提交
658
        if(name==null)  return null;
K
kohsuke 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
        for (JDK j : getJDKs()) {
            if(j.getName().equals(name))
                return j;
        }
        return null;
    }

    /**
     * Gets the slave node of the give name, hooked under this Hudson.
     */
    public Slave getSlave(String name) {
        for (Slave s : getSlaves()) {
            if(s.getNodeName().equals(name))
                return s;
        }
        return null;
    }

    public List<Slave> getSlaves() {
        return Collections.unmodifiableList(slaves);
    }

    /**
     * Gets the system default quiet period.
     */
    public int getQuietPeriod() {
        return quietPeriod!=null ? quietPeriod : 5;
    }

K
kohsuke 已提交
688 689 690 691 692
    /**
     * @deprecated
     *      Why are you calling a method that always returns ""?
     *      Perhaps you meant {@link #getRootUrl()}.
     */
K
kohsuke 已提交
693 694 695 696
    public String getUrl() {
        return "";
    }

697
    @Override
698 699
    public SearchIndexBuilder makeSearchIndex() {
        return super.makeSearchIndex()
700
            .add("configure", "config","configure")
K
kohsuke 已提交
701 702 703 704
            .add("log")
            .add(new CollectionSearchIndex() {// for computers
                protected Computer get(String key) { return getComputer(key); }
                protected Collection<Computer> all() { return computers.values(); }
K
kohsuke 已提交
705 706 707 708
            })
            .add(new CollectionSearchIndex() {// for views
                protected View get(String key) { return getView(key); }
                protected Collection<ListView> all() { return views; }
K
kohsuke 已提交
709
            });
710 711
    }

712 713 714 715
    public String getUrlChildPrefix() {
        return "job";
    }

K
kohsuke 已提交
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
    /**
     * Gets the absolute URL of Hudson,
     * such as "http://localhost/hudson/".
     *
     * <p>
     * Also note that when serving user requests from HTTP, you should always use
     * {@link HttpServletRequest} to determine the full URL, instead of using this
     * (this is because one host may have multiple names, and {@link HttpServletRequest}
     * accurately represents what the current user used.)
     *
     * <p>
     * This information is rather only meant to be useful for sending out messages
     * via non-HTTP channels, like SMTP or IRC, with a link back to Hudson website.
     *
     * @return
     *      This method returns null if this parameter is not configured by the user.
     *      The caller must gracefully deal with this situation.
     *      The returned URL will always have the trailing '/'.
     * @since 1.66
     */
    public String getRootUrl() {
        // for compatibility. the actual data is stored in Mailer
        return Mailer.DESCRIPTOR.getUrl();
    }

K
kohsuke 已提交
741 742 743 744
    public File getRootDir() {
        return root;
    }

745 746 747 748
    public FilePath getWorkspaceFor(TopLevelItem item) {
        return new FilePath(new File(item.getRootDir(),"workspace"));
    }

K
kohsuke 已提交
749 750 751 752
    public FilePath getRootPath() {
        return new FilePath(getRootDir());
    }

753 754
    public ClockDifference getClockDifference() {
        return ClockDifference.ZERO;
K
kohsuke 已提交
755 756
    }

K
kohsuke 已提交
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
    public boolean isUseSecurity() {
        return useSecurity;
    }

    public void setUseSecurity(boolean useSecurity) {
        this.useSecurity = useSecurity;
    }

    /**
     * Returns true if Hudson is quieting down.
     * <p>
     * No further jobs will be executed unless it
     * can be finished while other current pending builds
     * are still in progress.
     */
    public boolean isQuietingDown() {
        return isQuietingDown;
    }

    /**
     * Returns true if the container initiated the termination of the web application.
     */
    public boolean isTerminating() {
        return terminating;
    }

    /**
784 785 786
     * @deprecated
     *      Left only for the compatibility of URLs.
     *      Should not be invoked for any other purpose.
K
kohsuke 已提交
787
     */
788 789
    public TopLevelItem getJob(String name) {
        return getItem(name);
K
kohsuke 已提交
790 791
    }

792 793 794 795 796 797 798 799 800 801 802 803
    /**
     * @deprecated
     *      Used only for mapping jobs to URL in a case-insensitive fashion.
     */
    public TopLevelItem getJobCaseInsensitive(String name) {
        for (Entry<String, TopLevelItem> e : items.entrySet()) {
            if(e.getKey().equalsIgnoreCase(name))
                return e.getValue();
        }
        return null;
    }

804
    @Override
K
kohsuke 已提交
805
    public TopLevelItem getItem(String name) {
806 807 808
        return items.get(name);
    }

809
    public File getRootDirFor(TopLevelItem child) {
810 811 812 813 814
        return getRootDirFor(child.getName());
    }

    private File getRootDirFor(String name) {
        return new File(new File(getRootDir(),"jobs"), name);
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
    /**
     * Gets the {@link Item} object by its full name.
     * Full names are like path names, where each name of {@link Item} is
     * combined by '/'.
     *
     * @return
     *      null if either such {@link Item} doesn't exist under the given full name,
     *      or it exists but it's no an instance of the given type.
     */
    public <T extends Item> T getItemByFullName(String fullName, Class<T> type) {
        StringTokenizer tokens = new StringTokenizer(fullName,"/");
        ItemGroup parent = this;

        while(true) {
            Item item = parent.getItem(tokens.nextToken());
            if(!tokens.hasMoreTokens()) {
                if(type.isInstance(item))
                    return type.cast(item);
                else
                    return null;
            }

            if(!(item instanceof ItemGroup))
                return null;    // this item can't have any children

            parent = (ItemGroup) item;
        }
    }

K
kohsuke 已提交
846 847 848 849
    public Item getItemByFullName(String fullName) {
        return getItemByFullName(fullName,Item.class);
    }

K
kohsuke 已提交
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
    /**
     * Gets the user of the given name.
     *
     * @return
     *      This method returns a non-null object for any user name, without validation.
     */
    public User getUser(String name) {
        return User.get(name);
    }

    /**
     * Creates a new job.
     *
     * @throws IllegalArgumentException
     *      if the project of the given name already exists.
     */
866
    public synchronized TopLevelItem createProject( TopLevelItemDescriptor type, String name ) throws IOException {
K
kohsuke 已提交
867
        if(items.containsKey(name))
K
kohsuke 已提交
868 869
            throw new IllegalArgumentException();

K
kohsuke 已提交
870
        TopLevelItem item;
K
kohsuke 已提交
871
        try {
K
kohsuke 已提交
872
            item = type.newInstance(name);
K
kohsuke 已提交
873 874 875 876
        } catch (Exception e) {
            throw new IllegalArgumentException(e);
        }

K
kohsuke 已提交
877 878 879
        item.save();
        items.put(name,item);
        return item;
K
kohsuke 已提交
880 881 882 883 884
    }

    /**
     * Called in response to {@link Job#doDoDelete(StaplerRequest, StaplerResponse)}
     */
885
    /*package*/ void deleteJob(TopLevelItem item) throws IOException {
886
        for (ItemListener l : viewItemListeners)
887
            l.onDeleted(item);
888

889
        items.remove(item.getName());
K
kohsuke 已提交
890
        if(views!=null) {
891
            for (ListView v : views) {
K
kohsuke 已提交
892
                synchronized(v) {
893
                    v.jobNames.remove(item.getName());
K
kohsuke 已提交
894 895 896 897 898 899 900 901 902 903
                }
            }
            save();
        }
    }

    /**
     * Called by {@link Job#renameTo(String)} to update relevant data structure.
     * assumed to be synchronized on Hudson by the caller.
     */
K
kohsuke 已提交
904 905 906
    /*package*/ void onRenamed(TopLevelItem job, String oldName, String newName) throws IOException {
        items.remove(oldName);
        items.put(newName,job);
K
kohsuke 已提交
907 908

        if(views!=null) {
909
            for (ListView v : views) {
K
kohsuke 已提交
910 911 912 913 914 915 916 917 918 919 920 921 922
                synchronized(v) {
                    if(v.jobNames.remove(oldName))
                        v.jobNames.add(newName);
                }
            }
            save();
        }
    }

    public FingerprintMap getFingerprintMap() {
        return fingerprintMap;
    }

K
kohsuke 已提交
923
    // if no finger print matches, display "not found page".
K
kohsuke 已提交
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
    public Object getFingerprint( String md5sum ) throws IOException {
        Fingerprint r = fingerprintMap.get(md5sum);
        if(r==null)     return new NoFingerprintMatch(md5sum);
        else            return r;
    }

    /**
     * Gets a {@link Fingerprint} object if it exists.
     * Otherwise null.
     */
    public Fingerprint _getFingerprint( String md5sum ) throws IOException {
        return fingerprintMap.get(md5sum);
    }

    /**
     * The file we save our configuration.
     */
    private XmlFile getConfigFile() {
        return new XmlFile(XSTREAM, new File(root,"config.xml"));
    }

    public int getNumExecutors() {
        return numExecutors;
    }

    public Mode getMode() {
        return Mode.NORMAL;
    }

953
    public Set<Label> getAssignedLabels() {
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
        if (labelSet == null) {
            Set<Label> r = new HashSet<Label>();
            r.addAll(getDynamicLabels());
            r.add(getSelfLabel());
            this.labelSet = Collections.unmodifiableSet(r);
        }
        return labelSet;
    }

    /**
     * Returns the possibly empty set of labels that it has been determined as supported by this node.
     *
     * @see hudson.tasks.LabelFinder
     */
    public Set<Label> getDynamicLabels() {
        if (dynamicLabels == null) {
            synchronized (this) {
                Computer comp = getComputer("");
                if (dynamicLabels == null) {
                    dynamicLabels = new HashSet<Label>();
                    if (comp != null) {
                        VirtualChannel channel = comp.getChannel();
                        if (channel != null) {
                            for (DynamicLabeler labeler : LabelFinder.LABELERS) {
                                for (String label : labeler.findLabels(channel)) {
                                    dynamicLabels.add(getLabel(label));
                                }
                            }
                        }
                    }
                }
            }
        }
        return dynamicLabels;
988 989 990 991 992 993
    }

    public Label getSelfLabel() {
        return getLabel("master");
    }

K
kohsuke 已提交
994 995 996 997
    public Computer createComputer() {
        return new MasterComputer();
    }

K
kohsuke 已提交
998
    private synchronized void load() throws IOException {
999
        long startTime = System.currentTimeMillis();
K
kohsuke 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        XmlFile cfg = getConfigFile();
        if(cfg.exists())
            cfg.unmarshal(this);

        File projectsDir = new File(root,"jobs");
        if(!projectsDir.isDirectory() && !projectsDir.mkdirs()) {
            if(projectsDir.exists())
                throw new IOException(projectsDir+" is not a directory");
            throw new IOException("Unable to create "+projectsDir+"\nPermission issue? Please create this directory manually.");
        }
        File[] subdirs = projectsDir.listFiles(new FileFilter() {
            public boolean accept(File child) {
                return child.isDirectory();
            }
        });
1015
        items.clear();
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
        if(parallelLoad) {
            // load jobs in parallel for better performance
            List<Future<TopLevelItem>> loaders = new ArrayList<Future<TopLevelItem>>();
            for (final File subdir : subdirs) {
                loaders.add(threadPoolForLoad.submit(new Callable<TopLevelItem>() {
                    public TopLevelItem call() throws Exception {
                        return (TopLevelItem) Items.load(Hudson.this, subdir);
                    }
                }));
            }

            for (Future<TopLevelItem> loader : loaders) {
                try {
                    TopLevelItem item = loader.get();
                    items.put(item.getName(), item);
                } catch (ExecutionException e) {
                    LOGGER.log(Level.WARNING, "Failed to loa da project",e.getCause());
                } catch (InterruptedException e) {
                    e.printStackTrace(); // this is probably not the right thing to do
                }
            }
        } else {
            for (File subdir : subdirs) {
                try {
                    TopLevelItem item = (TopLevelItem)Items.load(this,subdir);
                    items.put(item.getName(), item);
                } catch (Error e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
                } catch (IOException e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
                }
K
kohsuke 已提交
1047 1048
            }
        }
1049
        rebuildDependencyGraph();
1050 1051

        // recompute label objects
1052 1053 1054 1055
        if (null != slaves) { // only if we have slaves
            for (Slave slave : slaves)
                slave.getAssignedLabels();
        }
K
kohsuke 已提交
1056

1057
        LOGGER.info(String.format("Took %s ms to load",System.currentTimeMillis()-startTime));
K
kohsuke 已提交
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    }

    /**
     * Save the settings to a file.
     */
    public synchronized void save() throws IOException {
        getConfigFile().write(this);
    }


    /**
     * Called to shut down the system.
     */
    public void cleanUp() {
        terminating = true;
1073 1074 1075
        for( Computer c : computers.values() ) {
            c.interrupt();
            c.kill();
K
kohsuke 已提交
1076 1077 1078
        }
        ExternalJob.reloadThread.interrupt();
        Trigger.timer.cancel();
1079 1080
        if(tcpSlaveAgentListener!=null)
            tcpSlaveAgentListener.shutdown();
K
kohsuke 已提交
1081 1082 1083 1084

        if(pluginManager!=null) // be defensive. there could be some ugly timing related issues
            pluginManager.stop();

1085 1086 1087 1088
        if(getRootDir().exists())
            // if we are aborting because we failed to create HUDSON_HOME,
            // don't try to save. Issue #536
            getQueue().save();
1089 1090

        threadPoolForLoad.shutdown();
K
kohsuke 已提交
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
    }



//
//
// actions
//
//
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        try {
            if(!Hudson.adminCheck(req,rsp))
                return;

            req.setCharacterEncoding("UTF-8");

            useSecurity = req.getParameter("use_security")!=null;

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
            {
                String v = req.getParameter("slaveAgentPortType");
                if(v==null || v.equals("random"))
                    slaveAgentPort = 0;
                else
                if(v.equals("disable"))
                    slaveAgentPort = -1;
                else {
                    try {
                        slaveAgentPort = Integer.parseInt(req.getParameter("slaveAgentPort"));
                    } catch (NumberFormatException e) {
                        throw new FormException("Bad port number "+req.getParameter("slaveAgentPort"),"slaveAgentPort");
                    }
                }
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138

                // relaunch the agent
                if(tcpSlaveAgentListener==null) {
                    if(slaveAgentPort!=-1)
                        tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
                } else {
                    if(tcpSlaveAgentListener.configuredPort!=slaveAgentPort) {
                        tcpSlaveAgentListener.shutdown();
                        tcpSlaveAgentListener = null;
                        if(slaveAgentPort!=-1)
                            tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
                    }
                }
1139 1140
            }

K
kohsuke 已提交
1141 1142 1143 1144 1145 1146 1147
            numExecutors = Integer.parseInt(req.getParameter("numExecutors"));
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));

            systemMessage = Util.nullify(req.getParameter("system_message"));

            {// update slave list
                List<Slave> newSlaves = new ArrayList<Slave>();
K
kohsuke 已提交
1148 1149 1150 1151
                String[] names = req.getParameterValues("slave.name");
                if(names!=null) {
                    for(int i=0;i< names.length;i++) {
                        newSlaves.add(req.bindParameters(Slave.class,"slave.",i));
K
kohsuke 已提交
1152 1153 1154 1155
                    }
                }
                this.slaves = newSlaves;
                updateComputerList();
1156 1157 1158 1159 1160 1161 1162

                // label trim off
                for (Label l : labels.values()) {
                    l.reset();
                    if(l.getNodes().isEmpty())
                        labels.remove(l);
                }
K
kohsuke 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
            }

            {// update JDK installations
                jdks.clear();
                String[] names = req.getParameterValues("jdk_name");
                String[] homes = req.getParameterValues("jdk_home");
                if(names!=null && homes!=null) {
                    int len = Math.min(names.length,homes.length);
                    for(int i=0;i<len;i++) {
                        jdks.add(new JDK(names[i],homes[i]));
                    }
                }
            }

            boolean result = true;

            for( Descriptor<Builder> d : BuildStep.BUILDERS )
                result &= d.configure(req);

            for( Descriptor<Publisher> d : BuildStep.PUBLISHERS )
                result &= d.configure(req);

K
kohsuke 已提交
1185 1186 1187
            for( Descriptor<BuildWrapper> d : BuildWrappers.WRAPPERS )
                result &= d.configure(req);

1188
            for( SCMDescriptor scmd : SCMS.SCMS )
K
kohsuke 已提交
1189 1190
                result &= scmd.configure(req);

1191
            for( TriggerDescriptor d : Triggers.TRIGGERS )
K
kohsuke 已提交
1192 1193
                result &= d.configure(req);

1194 1195 1196
            for( JobPropertyDescriptor d : Jobs.PROPERTIES )
                result &= d.configure(req);

K
kohsuke 已提交
1197 1198
            save();
            if(result)
1199
                rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
K
kohsuke 已提交
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
            else
                rsp.sendRedirect("configure"); // back to config
        } catch (FormException e) {
            sendError(e,req,rsp);
        }
    }

    /**
     * Accepts the new description.
     */
    public synchronized void doSubmitDescription( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        if(!Hudson.adminCheck(req,rsp))
            return;

        req.setCharacterEncoding("UTF-8");
        systemMessage = req.getParameter("description");
        save();
        rsp.sendRedirect(".");
    }

    public synchronized void doQuietDown( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        if(!Hudson.adminCheck(req,rsp))
            return;
        isQuietingDown = true;
        rsp.sendRedirect2(".");
    }

    public synchronized void doCancelQuietDown( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        if(!Hudson.adminCheck(req,rsp))
            return;
        isQuietingDown = false;
        getQueue().scheduleMaintenance();
        rsp.sendRedirect2(".");
    }

1235 1236 1237 1238 1239 1240 1241
    /**
     * Backward compatibility. Redirect to the thread dump.
     */
    public void doClassicThreadDump( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rsp.sendRedirect2("threadDump");
    }

K
kohsuke 已提交
1242
    public synchronized Item doCreateItem( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
K
kohsuke 已提交
1243 1244 1245
        if(!Hudson.adminCheck(req,rsp))
            return null;

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
        TopLevelItem result;

        boolean isXmlSubmission = req.getContentType().startsWith("application/xml") || req.getContentType().startsWith("text/xml");
        if(!isXmlSubmission) {
            // containers often implement RFCs incorrectly in that it doesn't interpret query parameter
            // decoding with UTF-8. This will ensure we get it right.
            // but doing this for config.xml submission could potentiall overwrite valid
            // "text/xml;charset=xxx"
            req.setCharacterEncoding("UTF-8");
        }
        
K
kohsuke 已提交
1257 1258 1259 1260 1261 1262
        String name = req.getParameter("name").trim();
        String mode = req.getParameter("mode");

        try {
            checkGoodName(name);
        } catch (ParseException e) {
1263
            rsp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
K
kohsuke 已提交
1264 1265 1266 1267
            sendError(e,req,rsp);
            return null;
        }

1268
        if(getItem(name)!=null) {
1269
            rsp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
K
kohsuke 已提交
1270 1271 1272 1273
            sendError("A job already exists with the name '"+name+"'",req,rsp);
            return null;
        }

1274
        if(mode!=null && mode.equals("copyJob")) {
1275
            TopLevelItem src = getItem(req.getParameter("from"));
K
kohsuke 已提交
1276 1277 1278 1279 1280
            if(src==null) {
                rsp.sendError(HttpServletResponse.SC_BAD_REQUEST);
                return null;
            }

1281
            result = createProject(src.getDescriptor(),name);
K
kohsuke 已提交
1282 1283

            // copy config
1284
            Util.copyFile(Items.getConfigFile(src).getFile(),Items.getConfigFile(result).getFile());
K
kohsuke 已提交
1285 1286

            // reload from the new config
1287
            result = (TopLevelItem)Items.load(this,result.getRootDir());
1288 1289
            result.onCopiedFrom(src);
            items.put(name,result);
1290
        } else {
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
            if(isXmlSubmission) {
                // config.xml submission

                // first copy it as config.xml
                File configXml = Items.getConfigFile(getRootDirFor(name)).getFile();
                configXml.getParentFile().mkdirs();
                try {
                    FileOutputStream fos = new FileOutputStream(configXml);
                    try {
                        Util.copyStream(req.getInputStream(),fos);
                    } finally {
                        fos.close();
                    }

                    // load it
                    result = (TopLevelItem)Items.load(this,configXml.getParentFile());
                    items.put(name,result);
                } catch (IOException e) {
                    // if anything fails, delete the config file to avoid further confusion
                    Util.deleteRecursive(configXml.getParentFile());
                    throw e;
                }
            } else {
                // create empty job and redirect to the project config screen
                if(mode==null) {
                    rsp.sendError(HttpServletResponse.SC_BAD_REQUEST);
                    return null;
                }
                result = createProject(Items.getDescriptor(mode), name);
            }
K
kohsuke 已提交
1321 1322
        }

1323
        for (ItemListener l : viewItemListeners)
1324
            l.onCreated(result);
1325

1326 1327 1328 1329 1330 1331 1332 1333
        if(isXmlSubmission) {
            // it worked
            rsp.setStatus(HttpServletResponse.SC_OK);
        } else {
            // send the browser to the config page
            rsp.sendRedirect2(req.getContextPath()+'/'+result.getUrl()+"configure");
        }

K
kohsuke 已提交
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
        return result;
    }

    public synchronized void doCreateView( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        if(!Hudson.adminCheck(req,rsp))
            return;

        req.setCharacterEncoding("UTF-8");

        String name = req.getParameter("name");

        try {
            checkGoodName(name);
        } catch (ParseException e) {
            sendError(e, req, rsp);
            return;
        }

1352
        ListView v = new ListView(this, name);
K
kohsuke 已提交
1353
        if(views==null)
1354
            views = new Vector<ListView>();
K
kohsuke 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
        views.add(v);
        save();

        // redirect to the config screen
        rsp.sendRedirect2("./"+v.getUrl()+"configure");
    }

    /**
     * Check if the given name is suitable as a name
     * for job, view, etc.
     *
     * @throws ParseException
     *      if the given name is not good
     */
    public static void checkGoodName(String name) throws ParseException {
        if(name==null || name.length()==0)
            throw new ParseException("No name is specified",0);

        for( int i=0; i<name.length(); i++ ) {
            char ch = name.charAt(i);
            if(Character.isISOControl(ch))
                throw new ParseException("No control code is allowed",i);
1377
            if("?*()/\\%!@#$^&|<>[]".indexOf(ch)!=-1)
K
kohsuke 已提交
1378 1379 1380 1381 1382 1383
                throw new ParseException("'"+ch+"' is an unsafe character",i);
        }

        // looks good
    }

1384
    /**
1385 1386 1387
     * Checks if the user was successfully authenticated.
     *
     * @see BasicAuthenticationFilter
1388 1389
     */
    public void doSecured( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1390 1391
        if(req.getUserPrincipal()==null) {
            // authentication must have failed
1392 1393 1394 1395
            rsp.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

1396
        // the user is now authenticated, so send him back to the target
1397 1398 1399
        String path = req.getContextPath()+req.getRestOfPath();
        String q = req.getQueryString();
        if(q!=null)
1400
            path += '?'+q;
1401

1402
        rsp.sendRedirect2(path);
1403 1404
    }

K
kohsuke 已提交
1405 1406 1407
    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1408
    public void doLoginEntry( StaplerRequest req, StaplerResponse rsp ) throws IOException {
1409 1410
        if(req.getUserPrincipal()==null)
            rsp.sendRedirect2("noPrincipal");
1411 1412

        String from = req.getParameter("from");
1413
        if(from!=null && from.startsWith("/") && !from.equals("/loginError"))
1414
            rsp.sendRedirect2(from);    // I'm bit uncomfortable letting users redircted to other sites, make sure the URL falls into this domain
1415 1416
        else
            rsp.sendRedirect2(".");
K
kohsuke 已提交
1417 1418 1419 1420 1421
    }

    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1422
    public void doLogout( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
1423 1424 1425 1426 1427 1428
        HttpSession session = req.getSession(false);
        if(session!=null)
            session.invalidate();
        rsp.sendRedirect2(req.getContextPath()+"/");
    }

K
kohsuke 已提交
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
    /**
     * RSS feed for log entries.
     */
    public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        List<LogRecord> logs = logRecords;

        // filter log records based on the log level
        String level = req.getParameter("level");
        if(level!=null) {
            Level threshold = Level.parse(level);
            List<LogRecord> filtered = new ArrayList<LogRecord>();
            for (LogRecord r : logs) {
                if(r.getLevel().intValue() >= threshold.intValue())
                    filtered.add(r);
            }
            logs = filtered;
        }

        RSS.forwardToRss("Hudson log","", logs, new FeedAdapter<LogRecord>() {
            public String getEntryTitle(LogRecord entry) {
                return entry.getMessage();
            }

            public String getEntryUrl(LogRecord entry) {
                return "log";   // TODO: one URL for one log entry?
            }

            public String getEntryID(LogRecord entry) {
                return String.valueOf(entry.getSequenceNumber());
            }

1460 1461 1462 1463
            public String getEntryDescription(LogRecord entry) {
                return Functions.printLogRecord(entry);
            }

K
kohsuke 已提交
1464 1465 1466 1467 1468 1469 1470 1471
            public Calendar getEntryTimestamp(LogRecord entry) {
                GregorianCalendar cal = new GregorianCalendar();
                cal.setTimeInMillis(entry.getMillis());
                return cal;
            }
        },req,rsp);
    }

K
kohsuke 已提交
1472 1473 1474 1475 1476 1477 1478 1479
    /**
     * Reloads the configuration.
     */
    public synchronized void doReload( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        if(!Hudson.adminCheck(req,rsp))
            return;

        load();
1480
        User.reload();
K
kohsuke 已提交
1481 1482 1483
        rsp.sendRedirect2(req.getContextPath()+"/");
    }

1484 1485 1486 1487
    public boolean isPluginUploaded() {
        return pluginUploaded;
    }

K
kohsuke 已提交
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
    /**
     * Uploads a plugin.
     */
    public void doUploadPlugin( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        try {
            if(!Hudson.adminCheck(req,rsp))
                return;

            ServletFileUpload upload = new ServletFileUpload(new DiskFileItemFactory());

            // Parse the request
            FileItem fileItem = (FileItem) upload.parseRequest(req).get(0);
            String fileName = Util.getFileName(fileItem.getName());
            if(!fileName.endsWith(".hpi")) {
                sendError(fileName+" is not a Hudson plugin",req,rsp);
                return;
            }
            fileItem.write(new File(getPluginManager().rootDir, fileName));
            fileItem.delete();

1508 1509
            pluginUploaded=true;

K
kohsuke 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
            rsp.sendRedirect2("managePlugins");
        } catch (IOException e) {
            throw e;
        } catch (Exception e) {// grrr. fileItem.write throws this
            throw new ServletException(e);
        }
    }

    /**
     * Do a finger-print check.
     */
    public void doDoFingerprintCheck( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1522 1523
        // Parse the request
        MultipartFormDataParser p = new MultipartFormDataParser(req);
K
kohsuke 已提交
1524 1525
        try {
            rsp.sendRedirect2(req.getContextPath()+"/fingerprint/"+
1526 1527 1528
                Util.getDigestOf(p.getFileItem("name").getInputStream())+'/');
        } finally {
            p.cleanUp();
K
kohsuke 已提交
1529 1530 1531 1532 1533 1534 1535
        }
    }

    /**
     * Serves static resources without the "Last-Modified" header to work around
     * a bug in Firefox.
     *
K
kohsuke 已提交
1536 1537
     * <p>
     * See https://bugzilla.mozilla.org/show_bug.cgi?id=89419
K
kohsuke 已提交
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
     */
    public void doNocacheImages( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        String path = req.getRestOfPath();

        if(path.length()==0)
            path = "/";

        if(path.indexOf("..")!=-1 || path.length()<1) {
            // don't serve anything other than files in the artifacts dir
            rsp.sendError(HttpServletResponse.SC_BAD_REQUEST);
            return;
        }

        File f = new File(req.getServletContext().getRealPath("/images"),path.substring(1));
        if(!f.exists()) {
            rsp.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        if(f.isDirectory()) {
            // listing not allowed
            rsp.sendError(HttpServletResponse.SC_FORBIDDEN);
            return;
        }

        FileInputStream in = new FileInputStream(f);
        // serve the file
        String contentType = req.getServletContext().getMimeType(f.getPath());
        rsp.setContentType(contentType);
        rsp.setContentLength((int)f.length());
        byte[] buf = new byte[1024];
        int len;
        while((len=in.read(buf))>0)
            rsp.getOutputStream().write(buf,0,len);
        in.close();
    }

    /**
K
kohsuke 已提交
1576
     * For debugging. Expose URL to perform GC.
K
kohsuke 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
     */
    public void doGc( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        System.gc();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("GCed");
    }

    /**
     * For system diagnostics.
K
kohsuke 已提交
1587
     * Run arbitrary Groovy script.
K
kohsuke 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
     */
    public void doScript( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        if(!adminCheck(req,rsp))
            return; // ability to run arbitrary script is dangerous

        String text = req.getParameter("script");
        if(text!=null) {
            GroovyShell shell = new GroovyShell();

            StringWriter out = new StringWriter();
            PrintWriter pw = new PrintWriter(out);
            shell.setVariable("out", pw);
            try {
                Object output = shell.evaluate(text);
                if(output!=null)
                pw.println("Result: "+output);
            } catch (Throwable t) {
                t.printStackTrace(pw);
            }
            req.setAttribute("output",out);
        }

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

K
kohsuke 已提交
1613 1614 1615
    /**
     * Changes the icon size by changing the cookie
     */
K
kohsuke 已提交
1616 1617 1618 1619
    public void doIconSize( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        String qs = req.getQueryString();
        if(!ICON_SIZE.matcher(qs).matches())
            throw new ServletException();
1620 1621 1622
        Cookie cookie = new Cookie("iconSize", qs);
        cookie.setMaxAge(/* ~4 mo. */9999999); // #762
        rsp.addCookie(cookie);
K
kohsuke 已提交
1623 1624 1625
        String ref = req.getHeader("Referer");
        if(ref==null)   ref=".";
        rsp.sendRedirect2(ref);
K
kohsuke 已提交
1626 1627
    }

K
kohsuke 已提交
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
    public void doFingerprintCleanup( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        FingerprintCleanupThread.invoke();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("Invoked");
    }

    public void doWorkspaceCleanup( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        WorkspaceCleanupThread.invoke();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("Invoked");
    }

    /**
     * Checks if the path is a valid path.
     */
    public void doCheckLocalFSRoot( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        // this can be used to check the existence of a file on the server, so needs to be protected
        new FormFieldValidator(req,rsp,true) {
            public void check() throws IOException, ServletException {
                File f = getFileParameter("value");
                if(f.isDirectory()) {// OK
                    ok();
                } else {// nope
                    if(f.exists()) {
                        error(f+" is not a directory");
                    } else {
                        error("No such directory: "+f);
                    }
                }
            }
        }.process();
    }

1663 1664 1665 1666 1667 1668 1669
    /**
     * Check the clock difference between slave and this node.
     */
    public void doCheckClock( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        new FormFieldValidator(req,rsp,false) {
            public void check() throws IOException, ServletException {
                response.setContentType("text/html");
1670 1671
                response.getWriter().print(
                    ClockDifference.toHtml(getSlave(request.getParameter("node"))));
1672 1673 1674 1675
            }
        }.process();
    }

K
kohsuke 已提交
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
    /**
     * Checks if the JAVA_HOME is a valid JAVA_HOME path.
     */
    public void doJavaHomeCheck( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        // this can be used to check the existence of a file on the server, so needs to be protected
        new FormFieldValidator(req,rsp,true) {
            public void check() throws IOException, ServletException {
                File f = getFileParameter("value");
                if(!f.isDirectory()) {
                    error(f+" is not a directory");
                    return;
                }

                File toolsJar = new File(f,"lib/tools.jar");
1690
                File mac = new File(f,"lib/dt.jar");
K
kohsuke 已提交
1691
                if(!toolsJar.exists() && !mac.exists()) {
K
kohsuke 已提交
1692 1693 1694 1695 1696 1697 1698 1699 1700
                    error(f+" doesn't look like a JDK directory");
                    return;
                }

                ok();
            }
        }.process();
    }

K
kohsuke 已提交
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
    /**
     * If the user chose the default JDK, make sure we got 'java' in PATH.
     */
    public void doDefaultJDKCheck( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        new FormFieldValidator(req,rsp,true) {
            public void check() throws IOException, ServletException {
                String v = request.getParameter("value");
                if(!v.equals("(Default)"))
                    // assume the user configured named ones properly in system config ---
                    // or else system config should have reported form field validation errors.
                    ok();
                else {
                    // default JDK selected. Does such java really exist?
                    if(JDK.isDefaultJDKValid(Hudson.this))
                        ok();
                    else
                        errorWithMarkup(
                            "java is not in your PATH. Maybe you need to" +
                            "<a href='"+request.getContextPath()+"/configure'>configure JDKs</a>?");
                }
            }
        }.process();
    }

K
kohsuke 已提交
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
    /**
     * Checks if the top-level item with the given name exists.
     */
    public void doItemExistsCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        // this method can be used to check if a file exists anywhere in the file system,
        // so it should be protected.
        new FormFieldValidator(req,rsp,true) {
            protected void check() throws IOException, ServletException {
                String job = fixEmpty(request.getParameter("value"));
                if(job==null) {
                    ok(); // nothing is entered yet
                    return;
                }

                if(getItem(job)==null)
                    ok();
                else
                    error("Job named "+job+" already exists");
            }
        }.process();
    }

K
kohsuke 已提交
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762

    public static boolean isWindows() {
        return File.pathSeparatorChar==';';
    }


    /**
     * Returns all {@code CVSROOT} strings used in the current Hudson installation.
     *
     * <p>
     * Ideally this shouldn't be defined in here
     * but EL doesn't provide a convenient way of invoking a static function,
     * so I'm putting it here for now.
     */
    public Set<String> getAllCvsRoots() {
        Set<String> r = new TreeSet<String>();
K
kohsuke 已提交
1763
        for( AbstractProject p : getAllItems(AbstractProject.class) ) {
K
kohsuke 已提交
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
            SCM scm = p.getScm();
            if (scm instanceof CVSSCM) {
                CVSSCM cvsscm = (CVSSCM) scm;
                r.add(cvsscm.getCvsRoot());
            }
        }

        return r;
    }

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
    /**
     * Rebuilds the dependency map.
     */
    public void rebuildDependencyGraph() {
        dependencyGraph = new DependencyGraph();
    }

    public DependencyGraph getDependencyGraph() {
        return dependencyGraph;
    }

K
kohsuke 已提交
1785 1786 1787 1788 1789
    public static final class MasterComputer extends Computer {
        private MasterComputer() {
            super(Hudson.getInstance());
        }

K
kohsuke 已提交
1790 1791 1792 1793 1794 1795 1796
        @Override
        public String getDisplayName() {
            return "master";
        }

        @Override
        public String getCaption() {
1797
            return "Master";
K
kohsuke 已提交
1798 1799
        }

K
kohsuke 已提交
1800 1801 1802 1803
        public String getUrl() {
            return "computer/(master)/";
        }

K
kohsuke 已提交
1804 1805 1806 1807 1808
        @Override
        public VirtualChannel getChannel() {
            return localChannel;
        }

K
kohsuke 已提交
1809 1810 1811 1812
        public List<LogRecord> getLogRecords() throws IOException, InterruptedException {
            return logRecords;
        }

K
kohsuke 已提交
1813 1814 1815 1816 1817 1818
        public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            // this computer never returns null from channel, so
            // this method shall never be invoked.
            rsp.sendError(HttpServletResponse.SC_NOT_FOUND);
        }

1819 1820 1821 1822
        public void launch() {
            // noop
        }

K
kohsuke 已提交
1823 1824 1825 1826 1827 1828
        /**
         * {@link LocalChannel} instance that can be used to execute programs locally.
         */
        public static final LocalChannel localChannel = new LocalChannel(threadPoolForRemoting);
    }

K
kohsuke 已提交
1829 1830 1831 1832
    public static boolean adminCheck() throws IOException {
        return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse());
    }

K
kohsuke 已提交
1833
    public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
1834 1835 1836 1837 1838 1839
        if (isAdmin(req)) return true;

        rsp.sendError(StaplerResponse.SC_FORBIDDEN);
        return false;
    }

K
kohsuke 已提交
1840 1841 1842 1843
    /**
     * Checks if the current user (for which we are processing the current request)
     * has the admin access.
     */
K
kohsuke 已提交
1844 1845 1846 1847 1848
    public static boolean isAdmin() {
        return isAdmin(Stapler.getCurrentRequest());
    }

    public static boolean isAdmin(StaplerRequest req) {
K
kohsuke 已提交
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
        if(!getInstance().isUseSecurity())
            return true;

        if(req.isUserInRole("admin"))
            return true;
        return false;
    }

    /**
     * Live view of recent {@link LogRecord}s produced by Hudson.
     */
J
jglick 已提交
1860
    public static List<LogRecord> logRecords = Collections.emptyList(); // initialized to dummy value to avoid NPE
K
kohsuke 已提交
1861 1862 1863 1864 1865 1866

    /**
     * Thread-safe reusable {@link XStream}.
     */
    private static final XStream XSTREAM = new XStream2();

1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
    /**
     * Thread pool used to load configuration in parallel, to improve the start up time.
     * <p>
     * The idea here is to overlap the CPU and I/O, so we want more threads than CPU numbers.
     */
    /*package*/ static final ExecutorService threadPoolForLoad = new ThreadPoolExecutor(
        0, Runtime.getRuntime().availableProcessors() * 2,
        5L, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>(), new DaemonThreadFactory());



1878 1879 1880 1881 1882
    /**
     * Version number of this Hudson.
     */
    public static String VERSION;

1883 1884 1885 1886 1887 1888 1889
    /**
     * Prefix to static resources like images and javascripts in the war file.
     * Either "" or strings like "/static/VERSION", which avoids Hudson to pick up
     * stale cache when the user upgrades to a different version. 
     */
    public static String RESOURCE_PATH;

1890 1891
    public static boolean parallelLoad = Boolean.getBoolean(Hudson.class.getName()+".parallelLoad");

K
kohsuke 已提交
1892 1893
    private static final Logger LOGGER = Logger.getLogger(Hudson.class.getName());

K
kohsuke 已提交
1894 1895
    private static final Pattern ICON_SIZE = Pattern.compile("\\d+x\\d+");

K
kohsuke 已提交
1896 1897 1898 1899
    static {
        XSTREAM.alias("hudson",Hudson.class);
        XSTREAM.alias("slave",Slave.class);
        XSTREAM.alias("jdk",JDK.class);
1900 1901 1902
        // for backward compatibility with <1.75, recognize the tag name "view" as well.
        XSTREAM.alias("view", ListView.class);
        XSTREAM.alias("listView", ListView.class);
K
kohsuke 已提交
1903 1904
    }
}