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

import com.thoughtworks.xstream.XStream;
import groovy.lang.GroovyShell;
K
kohsuke 已提交
5
import hudson.FeedAdapter;
6
import hudson.FilePath;
7
import hudson.Functions;
K
kohsuke 已提交
8
import hudson.Launcher;
K
kohsuke 已提交
9
import hudson.Launcher.LocalLauncher;
K
kohsuke 已提交
10 11 12
import hudson.Plugin;
import hudson.PluginManager;
import hudson.PluginWrapper;
13
import hudson.StructuredForm;
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
import hudson.security.ACL;
import hudson.security.AuthorizationStrategy;
K
kohsuke 已提交
35
import hudson.security.BasicAuthenticationFilter;
36 37 38 39
import hudson.security.HudsonFilter;
import hudson.security.LegacyAuthorizationStrategy;
import hudson.security.LegacySecurityRealm;
import hudson.security.Permission;
40
import hudson.security.PermissionGroup;
K
kohsuke 已提交
41
import hudson.security.SecurityMode;
42
import hudson.security.SecurityRealm;
K
kohsuke 已提交
43
import hudson.security.SecurityRealm.SecurityComponents;
44 45 46 47 48 49 50 51
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 已提交
52
import hudson.triggers.Trigger;
53
import hudson.triggers.TriggerDescriptor;
54
import hudson.triggers.Triggers;
K
kohsuke 已提交
55 56 57 58 59 60 61
import hudson.util.ClockDifference;
import hudson.util.CopyOnWriteList;
import hudson.util.CopyOnWriteMap;
import hudson.util.DaemonThreadFactory;
import hudson.util.FormFieldValidator;
import hudson.util.HudsonIsLoading;
import hudson.util.MultipartFormDataParser;
62
import hudson.util.TextFile;
K
kohsuke 已提交
63 64
import hudson.util.XStream2;
import hudson.widgets.Widget;
65
import net.sf.json.JSONObject;
66
import org.acegisecurity.Authentication;
K
kohsuke 已提交
67
import org.acegisecurity.GrantedAuthority;
K
kohsuke 已提交
68
import org.acegisecurity.GrantedAuthorityImpl;
69
import org.acegisecurity.context.SecurityContextHolder;
70
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
71
import org.acegisecurity.ui.AbstractProcessingFilter;
K
kohsuke 已提交
72 73 74
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
75
import org.kohsuke.stapler.MetaClass;
76
import org.kohsuke.stapler.QueryParameter;
77
import org.kohsuke.stapler.Stapler;
78
import org.kohsuke.stapler.StaplerProxy;
K
kohsuke 已提交
79 80
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
81
import org.kohsuke.stapler.export.Exported;
K
kohsuke 已提交
82 83 84

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
K
kohsuke 已提交
85
import javax.servlet.http.Cookie;
K
kohsuke 已提交
86
import javax.servlet.http.HttpServletRequest;
K
kohsuke 已提交
87
import javax.servlet.http.HttpServletResponse;
K
kohsuke 已提交
88
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
89
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
K
kohsuke 已提交
90
import javax.servlet.http.HttpSession;
K
kohsuke 已提交
91 92 93
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
94
import java.io.FileOutputStream;
K
kohsuke 已提交
95 96 97
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
98
import java.net.URL;
99
import java.security.SecureRandom;
K
kohsuke 已提交
100 101 102
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
K
kohsuke 已提交
103
import java.util.Calendar;
K
kohsuke 已提交
104 105 106
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
K
kohsuke 已提交
107
import java.util.GregorianCalendar;
K
kohsuke 已提交
108 109 110 111 112 113
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;
114 115
import java.util.Stack;
import java.util.StringTokenizer;
K
kohsuke 已提交
116 117
import java.util.TreeSet;
import java.util.Vector;
118
import java.util.concurrent.Callable;
119
import java.util.concurrent.ConcurrentHashMap;
K
kohsuke 已提交
120
import java.util.concurrent.CopyOnWriteArrayList;
121 122 123 124 125 126
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 已提交
127
import java.util.logging.Level;
K
kohsuke 已提交
128
import java.util.logging.LogRecord;
129
import java.util.logging.Logger;
130
import java.util.regex.Pattern;
K
kohsuke 已提交
131 132 133 134 135 136

/**
 * Root object of the system.
 *
 * @author Kohsuke Kawaguchi
 */
K
kohsuke 已提交
137
public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node, StaplerProxy {
K
kohsuke 已提交
138 139 140 141 142
    private transient final Queue queue = new Queue();

    /**
     * {@link Computer}s in this Hudson system. Read-only.
     */
K
kohsuke 已提交
143
    private transient final Map<Node,Computer> computers = new CopyOnWriteMap.Hash<Node,Computer>();
K
kohsuke 已提交
144 145 146 147 148 149 150 151

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

    /**
     * False to enable anyone to do anything.
K
kohsuke 已提交
152
     * Left as a field so that we can still read old data that uses this flag.
153 154 155
     *
     * @see #authorizationStrategy
     * @see #securityRealm
K
kohsuke 已提交
156
     */
K
kohsuke 已提交
157
    private Boolean useSecurity;
K
kohsuke 已提交
158 159

    /**
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
     * Controls how the
     * <a href="http://en.wikipedia.org/wiki/Authorization">authorization</a>
     * is handled in Hudson.
     * <p>
     * This ultimately controls who has access to what.
     *
     * Never null.
     */
    private volatile AuthorizationStrategy authorizationStrategy;

    /**
     * Controls a part of the
     * <a href="http://en.wikipedia.org/wiki/Authentication">authentication</a>
     * handling in Hudson.
     * <p>
     * Intuitively, this corresponds to the user database.
     *
     * See {@link HudsonFilter} for the concrete authentication protocol. 
     *
179 180
     * Never null. Always use {@link #setSecurityRealm(SecurityRealm)} to
     * update this field.
181 182
     *
     * @see #getSecurity()
183
     * @see #setSecurityRealm(SecurityRealm)
K
kohsuke 已提交
184
     */
185
    private volatile SecurityRealm securityRealm;
K
kohsuke 已提交
186 187 188 189 190 191 192 193 194 195 196

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

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

197 198 199
    /**
     * All {@link Item}s keyed by their {@link Item#getName() name}s.
     */
K
kohsuke 已提交
200
    /*package*/ transient final Map<String,TopLevelItem> items = new CopyOnWriteMap.Tree<String,TopLevelItem>();
201

K
kohsuke 已提交
202 203 204 205 206 207 208 209
    /**
     * The sole instance.
     */
    private static Hudson theInstance;

    private transient boolean isQuietingDown;
    private transient boolean terminating;

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

K
kohsuke 已提交
212 213 214 215 216
    /**
     * Widgets on Hudson.
     */
    private transient final List<Widget> widgets = new CopyOnWriteArrayList<Widget>();

217
    private transient volatile DependencyGraph dependencyGraph;
218

K
kohsuke 已提交
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
    /**
     * 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;

    /**
237
     * {@link ListView}s.
K
kohsuke 已提交
238
     */
239
    private List<ListView> views;   // can't initialize it eagerly for backward compatibility
K
kohsuke 已提交
240 241 242 243 244 245 246 247

    private transient final FingerprintMap fingerprintMap = new FingerprintMap();

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

248
    public transient volatile TcpSlaveAgentListener tcpSlaveAgentListener;
K
kohsuke 已提交
249

250
    /**
K
kohsuke 已提交
251
     * List of registered {@link JobListener}s.
252
     */
K
kohsuke 已提交
253
    private transient final CopyOnWriteList<ItemListener> itemListeners = new CopyOnWriteList<ItemListener>();
254 255 256 257 258

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

260 261
    /**
     * TCP slave agent port.
262
     * 0 for random, -1 to disable.
263 264 265
     */
    private int slaveAgentPort =0;

266 267 268 269 270 271 272
    /**
     * 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;

273 274 275 276 277
    /**
     * 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>();
278 279
    private transient Set<Label> labelSet;
    private transient Set<Label> dynamicLabels = null;
280

281 282
    public transient final ServletContext servletContext;

K
kohsuke 已提交
283 284 285 286 287 288
    /**
     * Transient action list. Useful for adding navigation items to the navigation bar
     * on the left.
     */
    private transient final List<Action> actions = new CopyOnWriteArrayList<Action>();

K
kohsuke 已提交
289 290 291 292
    public static Hudson getInstance() {
        return theInstance;
    }

293 294 295 296 297 298
    /**
     * Secrete key generated once and used for a long time, beyond
     * container start/stop.
     */
    private final String secretKey;

K
kohsuke 已提交
299 300 301

    public Hudson(File root, ServletContext context) throws IOException {
        this.root = root;
302
        this.servletContext = context;
K
kohsuke 已提交
303 304 305 306
        if(theInstance!=null)
            throw new IllegalStateException("second instance");
        theInstance = this;

307 308 309 310 311 312 313 314 315
        try {
            dependencyGraph = DependencyGraph.EMPTY;
        } catch (InternalError e) {
            if(e.getMessage().contains("window server")) {
                throw new Error("Looks like the server runs without X. Please specify -Djava.awt.headless=true as JVM option",e);
            }
            throw e;
        }

316 317 318 319 320 321 322 323 324 325 326 327
        // get or create the secret
        TextFile secretFile = new TextFile(new File(Hudson.getInstance().getRootDir(),"secret.key"));
        if(secretFile.exists()) {
            secretKey = secretFile.readTrim();
        } else {
            SecureRandom sr = new SecureRandom();
            byte[] random = new byte[32];
            sr.nextBytes(random);
            secretKey = Util.toHexString(random);
            secretFile.write(secretKey);
        }

K
kohsuke 已提交
328 329 330
        // load plugins.
        pluginManager = new PluginManager(context);

331 332 333 334
        if(slaveAgentPort!=-1)
            tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
        else
            tcpSlaveAgentListener = null;
K
kohsuke 已提交
335

K
kohsuke 已提交
336 337 338
        // if we are loading old data that doesn't have this field
        if(slaves==null)    slaves = new ArrayList<Slave>();

339
        // work around to have MavenModule register itself until we either move it to a plugin
340
        // or make it a part of the core.
341
        Items.LIST.hashCode();
342

K
kohsuke 已提交
343 344 345 346
        load();
        updateComputerList();

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

K
kohsuke 已提交
348
        for (ItemListener l : itemListeners)
349
            l.onLoaded();
K
kohsuke 已提交
350 351
    }

K
kohsuke 已提交
352 353 354 355
    public TcpSlaveAgentListener getTcpSlaveAgentListener() {
        return tcpSlaveAgentListener;
    }

K
kohsuke 已提交
356
    @Exported
357 358 359 360
    public int getSlaveAgentPort() {
        return slaveAgentPort;
    }

K
kohsuke 已提交
361
    /**
J
jglick 已提交
362
     * If you are calling this on Hudson something is wrong.
K
kohsuke 已提交
363 364 365
     *
     * @deprecated
     */
J
jglick 已提交
366
    @Deprecated
K
kohsuke 已提交
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
    public String getNodeName() {
        return "";
    }

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

    public String getDescription() {
        return systemMessage;
    }

    public PluginManager getPluginManager() {
        return pluginManager;
    }

383 384 385 386 387 388 389 390 391
    /**
     * Returns a secret key that survives across container start/stop.
     * <p>
     * This value is useful for implementing some of the security features. 
     */
    public String getSecretKey() {
        return  secretKey;
    }

K
kohsuke 已提交
392 393 394 395 396 397 398
    /**
     * 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 已提交
399 400 401 402 403 404 405
    /**
     * 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 已提交
406 407 408 409 410 411 412
    /**
     * 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 已提交
413 414 415 416 417 418 419
    /**
     * 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 已提交
420 421 422 423 424 425 426
    /**
     * 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 已提交
427 428 429
    /**
     * Gets the trigger descriptor by name. Primarily used for making them web-visible.
     */
430 431
    public TriggerDescriptor getTrigger(String shortClassName) {
        return (TriggerDescriptor)findDescriptor(shortClassName, Triggers.TRIGGERS);
K
kohsuke 已提交
432 433
    }

434 435 436 437
    /**
     * Gets the {@link JobPropertyDescriptor} by name. Primarily used for making them web-visible.
     */
    public JobPropertyDescriptor getJobProperty(String shortClassName) {
K
kohsuke 已提交
438 439 440
        // combining these two lines triggers javac bug. See issue #610.
        Descriptor d = findDescriptor(shortClassName, Jobs.PROPERTIES);
        return (JobPropertyDescriptor) d;
441 442
    }

443 444 445 446 447 448 449
    /**
     * Gets the {@link SecurityRealm} descriptors by name. Primarily used for making them web-visible.
     */
    public Descriptor<SecurityRealm> getSecurityRealms(String shortClassName) {
        return findDescriptor(shortClassName,SecurityRealm.LIST);
    }

K
kohsuke 已提交
450 451 452 453
    /**
     * Finds a descriptor that has the specified name.
     */
    private <T extends Describable<T>>
454
    Descriptor<T> findDescriptor(String shortClassName, Collection<? extends Descriptor<T>> descriptors) {
K
kohsuke 已提交
455 456 457 458 459 460 461 462
        String name = '.'+shortClassName;
        for (Descriptor<T> d : descriptors) {
            if(d.clazz.getName().endsWith(name))
                return d;
        }
        return null;
    }

463 464 465
    /**
     * Adds a new {@link JobListener}.
     *
466 467
     * @deprecated
     *      Use {@code getJobListners().add(l)} instead.
468 469
     */
    public void addListener(JobListener l) {
K
kohsuke 已提交
470
        itemListeners.add(new JobListenerAdapter(l));
471 472 473 474 475
    }

    /**
     * Deletes an existing {@link JobListener}.
     *
476 477
     * @deprecated
     *      Use {@code getJobListners().remove(l)} instead.
478 479
     */
    public boolean removeListener(JobListener l ) {
K
kohsuke 已提交
480
        return itemListeners.remove(new JobListenerAdapter(l));
481 482
    }

483
    /**
484
     * Gets all the installed {@link ItemListener}s.
485
     */
486
    public CopyOnWriteList<ItemListener> getJobListeners() {
K
kohsuke 已提交
487
        return itemListeners;
488 489 490 491 492 493 494 495 496
    }

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

K
kohsuke 已提交
497 498 499 500 501 502 503 504 505 506
    /**
     * 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;
507
        return p.getPlugin();
K
kohsuke 已提交
508 509 510 511 512 513 514 515 516 517
    }

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

    public Launcher createLauncher(TaskListener listener) {
K
kohsuke 已提交
518
        return new LocalLauncher(listener);
K
kohsuke 已提交
519 520 521 522 523 524 525 526 527
    }

    /**
     * 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 已提交
528
    private void updateComputerList() throws IOException {
529
        synchronized(computers) {// this synchronization is still necessary so that no two update happens concurrently
K
kohsuke 已提交
530
            Map<String,Computer> byName = new HashMap<String,Computer>();
K
kohsuke 已提交
531 532 533
            for (Computer c : computers.values()) {
                if(c.getNode()==null)
                    continue;   // this computer is gone
K
kohsuke 已提交
534
                byName.put(c.getNode().getNodeName(),c);
K
kohsuke 已提交
535
            }
K
kohsuke 已提交
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557

            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 已提交
558 559
        if (c!=null) {
            c.setNode(n); // reuse
K
kohsuke 已提交
560
        } else {
K
kohsuke 已提交
561 562
            if(n.getNumExecutors()>0)
                computers.put(n,c=n.createComputer());
K
kohsuke 已提交
563 564 565 566 567
        }
        used.add(c);
    }

    /*package*/ void removeComputer(Computer computer) {
568 569
        for (Entry<Node, Computer> e : computers.entrySet()) {
            if (e.getValue() == computer) {
K
kohsuke 已提交
570
                computers.remove(e.getKey());
571
                return;
K
kohsuke 已提交
572 573 574 575 576
            }
        }
        throw new IllegalStateException("Trying to remove unknown computer");
    }

577 578 579 580
    public String getFullName() {
        return "";
    }

581 582 583 584
    public String getFullDisplayName() {
        return "";
    }

K
kohsuke 已提交
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
    /**
     * Returns the transient {@link Action}s associated with the top page.
     *
     * <p>
     * Adding {@link Action} is primarily useful for plugins to contribute
     * an item to the navigation bar of the top page. See existing {@link Action}
     * implementation for it affects the GUI.
     *
     * <p>
     * To register an {@link Action}, write code like
     * {@code Hudson.getInstance().getActions().add(...)}
     *
     * @return
     *      Live list where the changes can be made. Can be empty but never null.
     * @since 1.172
     */
    public List<Action> getActions() {
        return actions;
    }

605 606 607
    /**
     * Gets just the immediate children of {@link Hudson}.
     *
608
     * @see #getAllItems(Class)
609
     */
K
kohsuke 已提交
610
    public List<TopLevelItem> getItems() {
611
        return new ArrayList<TopLevelItem>(items.values());
612 613
    }

614 615 616 617 618 619 620 621 622 623 624 625 626 627
    /**
     * 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 已提交
628
                    r.add(type.cast(i));
629 630 631 632 633 634 635 636
                if(i instanceof ItemGroup)
                    q.push((ItemGroup)i);
            }
        }

        return r;
    }

K
kohsuke 已提交
637
    /**
K
kohsuke 已提交
638 639 640 641 642
     * 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 已提交
643
     */
K
kohsuke 已提交
644
    public List<Project> getProjects() {
K
kohsuke 已提交
645
        return Util.createSubList(items.values(),Project.class);
K
kohsuke 已提交
646 647 648 649 650
    }

    /**
     * Gets the names of all the {@link Job}s.
     */
K
kohsuke 已提交
651
    public Collection<String> getJobNames() {
652
        List<String> names = new ArrayList<String>();
K
kohsuke 已提交
653 654
        for (Job j : getAllItems(Job.class))
            names.add(j.getName());
655
        return names;
K
kohsuke 已提交
656 657
    }

658 659 660 661 662 663 664 665 666 667
    /**
     * 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 已提交
668 669 670 671 672 673
    /**
     * Every job belongs to us.
     *
     * @deprecated
     *      why are you calling a method that always return true?
     */
J
jglick 已提交
674
    @Deprecated
675
    public boolean contains(TopLevelItem view) {
K
kohsuke 已提交
676 677 678
        return true;
    }

679
    public synchronized View getView(String name) {
K
kohsuke 已提交
680
        if(views!=null) {
681
            for (ListView v : views) {
K
kohsuke 已提交
682 683 684 685 686 687 688 689 690 691 692
                if(v.getViewName().equals(name))
                    return v;
            }
        }
        if(this.getViewName().equals(name))
            return this;
        else
            return null;
    }

    /**
693
     * Gets the read-only list of all {@link View}s.
K
kohsuke 已提交
694
     */
695
    @Exported
696
    public synchronized View[] getViews() {
K
kohsuke 已提交
697
        if(views==null)
698 699
            views = new ArrayList<ListView>();
        View[] r = new View[views.size()+1];
K
kohsuke 已提交
700 701 702
        views.toArray(r);
        // sort Views and put "all" at the very beginning
        r[r.length-1] = r[0];
703
        Arrays.sort(r,1,r.length, View.SORTER);
K
kohsuke 已提交
704 705 706 707
        r[0] = this;
        return r;
    }

708
    public synchronized void deleteView(ListView view) throws IOException {
K
kohsuke 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721 722
        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() {
723 724 725 726 727
        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 已提交
728
                return lhs.getDisplayName().compareTo(rhs.getDisplayName());
729 730 731
            }
        });
        return r;
K
kohsuke 已提交
732 733 734
    }

    public Computer getComputer(String name) {
K
kohsuke 已提交
735 736 737
        if(name.equals("(master)"))
            name = "";

738 739 740
        for (Computer c : computers.values()) {
            if(c.getNode().getNodeName().equals(name))
                return c;
K
kohsuke 已提交
741 742 743 744
        }
        return null;
    }

K
kohsuke 已提交
745 746 747 748 749 750 751 752
    /**
     * @deprecated
     *      UI method. Not meant to be used programatically.
     */
    public ComputerSet getComputer() {
        return new ComputerSet();
    }

753 754 755 756 757 758
    /**
     * 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 已提交
759
        if(name==null)  return null;
760 761 762 763 764 765 766 767 768 769 770
        while(true) {
            Label l = labels.get(name);
            if(l!=null)
                return l;

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

    /**
771
     * Gets all the active labels in the current system.
772 773 774 775 776 777 778 779 780 781
     */
    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 已提交
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
    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) {
800 801 802 803 804 805
        if(name==null) {
            // if only one JDK is configured, "default JDK" should mean that JDK.
            List<JDK> jdks = getJDKs();
            if(jdks.size()==1)  return jdks.get(0);
            return null;
        }
K
kohsuke 已提交
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
        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 已提交
835 836 837 838 839
    /**
     * @deprecated
     *      Why are you calling a method that always returns ""?
     *      Perhaps you meant {@link #getRootUrl()}.
     */
K
kohsuke 已提交
840 841 842 843
    public String getUrl() {
        return "";
    }

844
    @Override
845 846
    public SearchIndexBuilder makeSearchIndex() {
        return super.makeSearchIndex()
847
            .add("configure", "config","configure")
K
kohsuke 已提交
848
            .add("manage")
K
kohsuke 已提交
849 850 851 852
            .add("log")
            .add(new CollectionSearchIndex() {// for computers
                protected Computer get(String key) { return getComputer(key); }
                protected Collection<Computer> all() { return computers.values(); }
K
kohsuke 已提交
853
            })
K
kohsuke 已提交
854
            .add(new CollectionSearchIndex() {// for users
K
kohsuke 已提交
855
                protected User get(String key) { return User.get(key,false); }
K
kohsuke 已提交
856
                protected Collection<User> all() { return User.getAll(); }
K
kohsuke 已提交
857
            })
K
kohsuke 已提交
858 859 860
            .add(new CollectionSearchIndex() {// for views
                protected View get(String key) { return getView(key); }
                protected Collection<ListView> all() { return views; }
K
kohsuke 已提交
861
            });
862 863
    }

864 865 866 867
    public String getUrlChildPrefix() {
        return "job";
    }

K
kohsuke 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
    /**
     * 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
890 891 892 893 894 895 896 897 898 899 900 901 902 903
        String url = Mailer.DESCRIPTOR.getUrl();
        if(url!=null)   return url;

        StaplerRequest req = Stapler.getCurrentRequest();
        if(req!=null) {
            StringBuilder buf = new StringBuilder();
            buf.append("http://");
            buf.append(req.getServerName());
            if(req.getServerPort()!=80)
                buf.append(':').append(req.getServerPort());
            buf.append(req.getContextPath()).append('/');
            return buf.toString();
        }
        return null;
K
kohsuke 已提交
904 905
    }

K
kohsuke 已提交
906 907 908 909
    public File getRootDir() {
        return root;
    }

910 911 912 913
    public FilePath getWorkspaceFor(TopLevelItem item) {
        return new FilePath(new File(item.getRootDir(),"workspace"));
    }

K
kohsuke 已提交
914 915 916 917
    public FilePath getRootPath() {
        return new FilePath(getRootDir());
    }

918 919
    public ClockDifference getClockDifference() {
        return ClockDifference.ZERO;
K
kohsuke 已提交
920 921
    }

K
kohsuke 已提交
922
    /**
923 924
     * A convenience method to check if there's some security
     * restrictions in place.
K
kohsuke 已提交
925
     */
K
kohsuke 已提交
926
    public boolean isUseSecurity() {
927
        return securityRealm!=SecurityRealm.NO_AUTHENTICATION;
K
kohsuke 已提交
928 929
    }

K
kohsuke 已提交
930
    /**
931 932
     * Returns the constant that captures the three basic security modes
     * in Hudson.
K
kohsuke 已提交
933
     */
934 935 936 937 938 939 940 941 942
    public SecurityMode getSecurity() {
        // fix the variable so that this code works under concurrent modification to securityRealm.
        SecurityRealm realm = securityRealm;

        if(realm==SecurityRealm.NO_AUTHENTICATION)
            return SecurityMode.UNSECURED;
        if(realm instanceof LegacySecurityRealm)
            return SecurityMode.LEGACY;
        return SecurityMode.SECURED;
K
kohsuke 已提交
943 944
    }

K
kohsuke 已提交
945 946 947 948 949 950 951 952
    /**
     * @return
     *      never null.
     */
    public SecurityRealm getSecurityRealm() {
        return securityRealm;
    }

953 954
    public void setSecurityRealm(SecurityRealm securityRealm) {
        this.securityRealm = securityRealm;
K
kohsuke 已提交
955 956 957
        SecurityComponents sc = securityRealm.createSecurityComponents();
        HudsonFilter.AUTHENTICATION_MANAGER.setDelegate(sc.manager);
        HudsonFilter.USER_DETAILS_SERVICE_PROXY.setDelegate(sc.userDetails);
958 959
    }

960 961 962 963 964 965 966
    /**
     * Returns the root {@link ACL}.
     *
     * @see AuthorizationStrategy#getRootACL()
     */
    public ACL getACL() {
        return authorizationStrategy.getRootACL();
K
kohsuke 已提交
967 968
    }

969 970 971 972 973 974
    /**
     * @return
     *      never null.
     */
    public AuthorizationStrategy getAuthorizationStrategy() {
        return authorizationStrategy;
K
kohsuke 已提交
975 976
    }

K
kohsuke 已提交
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
    /**
     * 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;
    }

    /**
996 997 998
     * @deprecated
     *      Left only for the compatibility of URLs.
     *      Should not be invoked for any other purpose.
K
kohsuke 已提交
999
     */
1000 1001
    public TopLevelItem getJob(String name) {
        return getItem(name);
K
kohsuke 已提交
1002 1003
    }

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
    /**
     * @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;
    }

1016
    @Override
K
kohsuke 已提交
1017
    public TopLevelItem getItem(String name) {
1018 1019 1020
        return items.get(name);
    }

1021
    public File getRootDirFor(TopLevelItem child) {
1022 1023 1024 1025 1026
        return getRootDirFor(child.getName());
    }

    private File getRootDirFor(String name) {
        return new File(new File(getRootDir(),"jobs"), name);
1027 1028
    }

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
    /**
     * 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 已提交
1058 1059 1060 1061
    public Item getItemByFullName(String fullName) {
        return getItemByFullName(fullName,Item.class);
    }

K
kohsuke 已提交
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
    /**
     * 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.
     */
1078
    public synchronized TopLevelItem createProject( TopLevelItemDescriptor type, String name ) throws IOException {
K
kohsuke 已提交
1079
        if(items.containsKey(name))
K
kohsuke 已提交
1080 1081
            throw new IllegalArgumentException();

K
kohsuke 已提交
1082
        TopLevelItem item;
K
kohsuke 已提交
1083
        try {
K
kohsuke 已提交
1084
            item = type.newInstance(name);
K
kohsuke 已提交
1085 1086 1087 1088
        } catch (Exception e) {
            throw new IllegalArgumentException(e);
        }

K
kohsuke 已提交
1089 1090 1091
        item.save();
        items.put(name,item);
        return item;
K
kohsuke 已提交
1092 1093 1094 1095 1096
    }

    /**
     * Called in response to {@link Job#doDoDelete(StaplerRequest, StaplerResponse)}
     */
1097
    /*package*/ void deleteJob(TopLevelItem item) throws IOException {
K
kohsuke 已提交
1098
        for (ItemListener l : itemListeners)
1099
            l.onDeleted(item);
1100

1101
        items.remove(item.getName());
K
kohsuke 已提交
1102
        if(views!=null) {
1103
            for (ListView v : views) {
K
kohsuke 已提交
1104
                synchronized(v) {
1105
                    v.jobNames.remove(item.getName());
K
kohsuke 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
                }
            }
            save();
        }
    }

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

        if(views!=null) {
1121
            for (ListView v : views) {
K
kohsuke 已提交
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
                synchronized(v) {
                    if(v.jobNames.remove(oldName))
                        v.jobNames.add(newName);
                }
            }
            save();
        }
    }

    public FingerprintMap getFingerprintMap() {
        return fingerprintMap;
    }

K
kohsuke 已提交
1135
    // if no finger print matches, display "not found page".
K
kohsuke 已提交
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    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;
    }

1165
    public Set<Label> getAssignedLabels() {
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
        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;
1200 1201 1202 1203 1204 1205
    }

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

K
kohsuke 已提交
1206 1207 1208 1209
    public Computer createComputer() {
        return new MasterComputer();
    }

K
kohsuke 已提交
1210
    private synchronized void load() throws IOException {
1211
        long startTime = System.currentTimeMillis();
K
kohsuke 已提交
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
        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();
            }
        });
1227
        items.clear();
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
        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 已提交
1259 1260
            }
        }
1261
        rebuildDependencyGraph();
1262 1263

        // recompute label objects
1264 1265 1266 1267
        if (null != slaves) { // only if we have slaves
            for (Slave slave : slaves)
                slave.getAssignedLabels();
        }
K
kohsuke 已提交
1268

K
typo.  
kohsuke 已提交
1269
        // read in old data that doesn't have the security field set
1270 1271 1272 1273 1274 1275 1276 1277
        if(authorizationStrategy==null) {
            if(useSecurity==null || !useSecurity)
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
            else
                authorizationStrategy = new LegacyAuthorizationStrategy();
        }
        if(securityRealm==null) {
            if(useSecurity==null || !useSecurity)
1278
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1279
            else
1280 1281 1282 1283
                setSecurityRealm(new LegacySecurityRealm());
        } else {
            // force the set to proxy
            setSecurityRealm(securityRealm);
1284
        }
1285

K
kohsuke 已提交
1286 1287 1288 1289
        if(useSecurity!=null && !useSecurity) {
            // forced reset to the unsecure mode.
            // this works as an escape hatch for people who locked themselves out.
            authorizationStrategy = AuthorizationStrategy.UNSECURED;
1290
            setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
K
kohsuke 已提交
1291
        }
1292
        
K
kohsuke 已提交
1293

1294
        LOGGER.info(String.format("Took %s ms to load",System.currentTimeMillis()-startTime));
K
kohsuke 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
    }

    /**
     * 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;
1310 1311 1312
        for( Computer c : computers.values() ) {
            c.interrupt();
            c.kill();
K
kohsuke 已提交
1313 1314 1315
        }
        ExternalJob.reloadThread.interrupt();
        Trigger.timer.cancel();
1316 1317
        if(tcpSlaveAgentListener!=null)
            tcpSlaveAgentListener.shutdown();
K
kohsuke 已提交
1318 1319 1320 1321

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

1322 1323 1324 1325
        if(getRootDir().exists())
            // if we are aborting because we failed to create HUDSON_HOME,
            // don't try to save. Issue #536
            getQueue().save();
1326 1327

        threadPoolForLoad.shutdown();
K
kohsuke 已提交
1328 1329
    }

K
kohsuke 已提交
1330 1331 1332 1333 1334 1335
    public Object getDynamic(String token, StaplerRequest req, StaplerResponse rsp) {
        for (Action a : getActions())
            if(a.getUrlName().equals(token))
                return a;
        return null;
    }
K
kohsuke 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347


//
//
// actions
//
//
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        try {
K
kohsuke 已提交
1348
            checkPermission(ADMINISTER);
K
kohsuke 已提交
1349 1350 1351

            req.setCharacterEncoding("UTF-8");

1352 1353
            JSONObject json = StructuredForm.get(req);

1354 1355 1356
            // keep using 'useSecurity' field as the main configuration setting
            // until we get the new security implementation working
            // useSecurity = null;
1357
            if (json.has("use_security")) {
K
kohsuke 已提交
1358
                useSecurity = true;
K
kohsuke 已提交
1359 1360 1361
                JSONObject security = json.getJSONObject("use_security");
                setSecurityRealm(SecurityRealm.LIST.newInstanceFromRadioList(security,"realm"));
                authorizationStrategy = AuthorizationStrategy.LIST.newInstanceFromRadioList(security,"authorization");
K
kohsuke 已提交
1362
            } else {
1363
                useSecurity = null;
1364
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1365
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1366
            }
K
kohsuke 已提交
1367

1368 1369
            {
                String v = req.getParameter("slaveAgentPortType");
1370
                if(!isUseSecurity() || v==null || v.equals("random"))
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
                    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");
                    }
                }
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394

                // 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);
                    }
                }
1395 1396
            }

K
kohsuke 已提交
1397 1398 1399 1400 1401 1402 1403
            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 已提交
1404 1405 1406 1407
                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 已提交
1408 1409 1410 1411
                    }
                }
                this.slaves = newSlaves;
                updateComputerList();
1412 1413 1414 1415 1416 1417 1418

                // label trim off
                for (Label l : labels.values()) {
                    l.reset();
                    if(l.getNodes().isEmpty())
                        labels.remove(l);
                }
K
kohsuke 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
            }

            {// 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 已提交
1441 1442 1443
            for( Descriptor<BuildWrapper> d : BuildWrappers.WRAPPERS )
                result &= d.configure(req);

1444
            for( SCMDescriptor scmd : SCMS.SCMS )
K
kohsuke 已提交
1445 1446
                result &= scmd.configure(req);

1447
            for( TriggerDescriptor d : Triggers.TRIGGERS )
K
kohsuke 已提交
1448 1449
                result &= d.configure(req);

1450 1451 1452
            for( JobPropertyDescriptor d : Jobs.PROPERTIES )
                result &= d.configure(req);

K
kohsuke 已提交
1453 1454
            save();
            if(result)
1455
                rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
K
kohsuke 已提交
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
            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 {
1467
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1468 1469 1470 1471 1472 1473 1474 1475

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

    public synchronized void doQuietDown( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
K
kohsuke 已提交
1476
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1477 1478 1479 1480 1481
        isQuietingDown = true;
        rsp.sendRedirect2(".");
    }

    public synchronized void doCancelQuietDown( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
K
kohsuke 已提交
1482
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1483 1484 1485 1486 1487
        isQuietingDown = false;
        getQueue().scheduleMaintenance();
        rsp.sendRedirect2(".");
    }

1488 1489 1490 1491 1492 1493 1494
    /**
     * Backward compatibility. Redirect to the thread dump.
     */
    public void doClassicThreadDump( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        rsp.sendRedirect2("threadDump");
    }

K
kohsuke 已提交
1495
    public synchronized Item doCreateItem( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1496
        checkPermission(Job.CREATE);
K
kohsuke 已提交
1497

1498 1499
        TopLevelItem result;

K
kohsuke 已提交
1500 1501 1502 1503 1504 1505
        String requestContentType = req.getContentType();
        if(requestContentType==null) {
            rsp.sendError(HttpServletResponse.SC_BAD_REQUEST,"No Content-Type header set");
            return null;
        }
        boolean isXmlSubmission = requestContentType.startsWith("application/xml") || requestContentType.startsWith("text/xml");
1506 1507 1508 1509 1510 1511 1512 1513
        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 已提交
1514 1515 1516 1517 1518 1519
        String name = req.getParameter("name").trim();
        String mode = req.getParameter("mode");

        try {
            checkGoodName(name);
        } catch (ParseException e) {
K
kohsuke 已提交
1520
            rsp.setStatus(SC_BAD_REQUEST);
K
kohsuke 已提交
1521 1522 1523 1524
            sendError(e,req,rsp);
            return null;
        }

1525
        if(getItem(name)!=null) {
K
kohsuke 已提交
1526
            rsp.setStatus(SC_BAD_REQUEST);
K
kohsuke 已提交
1527 1528 1529 1530
            sendError("A job already exists with the name '"+name+"'",req,rsp);
            return null;
        }

1531
        if(mode!=null && mode.equals("copyJob")) {
1532
            TopLevelItem src = getItem(req.getParameter("from"));
K
kohsuke 已提交
1533
            if(src==null) {
K
kohsuke 已提交
1534
                rsp.sendError(SC_BAD_REQUEST);
K
kohsuke 已提交
1535 1536 1537
                return null;
            }

1538
            result = createProject(src.getDescriptor(),name);
K
kohsuke 已提交
1539 1540

            // copy config
1541
            Util.copyFile(Items.getConfigFile(src).getFile(),Items.getConfigFile(result).getFile());
K
kohsuke 已提交
1542 1543

            // reload from the new config
1544
            result = (TopLevelItem)Items.load(this,result.getRootDir());
1545 1546
            result.onCopiedFrom(src);
            items.put(name,result);
1547
        } else {
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
            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) {
K
kohsuke 已提交
1573
                    rsp.sendError(SC_BAD_REQUEST);
1574 1575 1576 1577
                    return null;
                }
                result = createProject(Items.getDescriptor(mode), name);
            }
K
kohsuke 已提交
1578 1579
        }

K
kohsuke 已提交
1580
        for (ItemListener l : itemListeners)
1581
            l.onCreated(result);
1582

1583 1584 1585 1586 1587 1588 1589 1590
        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 已提交
1591 1592 1593 1594
        return result;
    }

    public synchronized void doCreateView( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1595
        checkPermission(View.CREATE);
K
kohsuke 已提交
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607

        req.setCharacterEncoding("UTF-8");

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

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

1608
        ListView v = new ListView(this, name);
K
kohsuke 已提交
1609
        if(views==null)
1610
            views = new Vector<ListView>();
K
kohsuke 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
        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);
K
kohsuke 已提交
1633
            if("?*()/\\%!@#$^&|<>[]:;".indexOf(ch)!=-1)
K
kohsuke 已提交
1634 1635 1636 1637 1638 1639
                throw new ParseException("'"+ch+"' is an unsafe character",i);
        }

        // looks good
    }

1640
    /**
1641 1642 1643
     * Checks if the user was successfully authenticated.
     *
     * @see BasicAuthenticationFilter
1644 1645
     */
    public void doSecured( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1646 1647
        if(req.getUserPrincipal()==null) {
            // authentication must have failed
1648 1649 1650 1651
            rsp.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

1652
        // the user is now authenticated, so send him back to the target
1653 1654 1655
        String path = req.getContextPath()+req.getRestOfPath();
        String q = req.getQueryString();
        if(q!=null)
1656
            path += '?'+q;
1657

1658
        rsp.sendRedirect2(path);
1659 1660
    }

K
kohsuke 已提交
1661 1662 1663
    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1664
    public void doLoginEntry( StaplerRequest req, StaplerResponse rsp ) throws IOException {
1665 1666
        if(req.getUserPrincipal()==null)
            rsp.sendRedirect2("noPrincipal");
1667 1668

        String from = req.getParameter("from");
1669
        if(from!=null && from.startsWith("/") && !from.equals("/loginError")) {
1670
            rsp.sendRedirect2(from);    // I'm bit uncomfortable letting users redircted to other sites, make sure the URL falls into this domain
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
            return;
        }

        String url = AbstractProcessingFilter.obtainFullRequestUrl(req);
        if(url!=null) {
            // if the login redirect is initiated by Acegi
            // this should send the user back to where s/he was from.
            rsp.sendRedirect2(url);
            return;
        }

        rsp.sendRedirect2(".");
K
kohsuke 已提交
1683 1684 1685 1686 1687
    }

    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1688
    public void doLogout( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
1689 1690 1691
        HttpSession session = req.getSession(false);
        if(session!=null)
            session.invalidate();
1692
        SecurityContextHolder.clearContext();
K
kohsuke 已提交
1693 1694 1695
        rsp.sendRedirect2(req.getContextPath()+"/");
    }

K
kohsuke 已提交
1696 1697 1698 1699
    /**
     * RSS feed for log entries.
     */
    public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1700
        checkPermission(ADMINISTER);
1701

K
kohsuke 已提交
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
        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());
            }

1729 1730 1731 1732
            public String getEntryDescription(LogRecord entry) {
                return Functions.printLogRecord(entry);
            }

K
kohsuke 已提交
1733 1734 1735 1736 1737 1738 1739 1740
            public Calendar getEntryTimestamp(LogRecord entry) {
                GregorianCalendar cal = new GregorianCalendar();
                cal.setTimeInMillis(entry.getMillis());
                return cal;
            }
        },req,rsp);
    }

K
kohsuke 已提交
1741 1742 1743 1744
    /**
     * Reloads the configuration.
     */
    public synchronized void doReload( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
1745
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1746

1747 1748 1749 1750
        // engage "loading ..." UI and then run the actual task in a separate thread
        final ServletContext context = req.getServletContext();
        context.setAttribute("app",new HudsonIsLoading());

K
kohsuke 已提交
1751
        rsp.sendRedirect2(req.getContextPath()+"/");
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763

        new Thread("Hudson config reload thread") {
            public void run() {
                try {
                    load();
                    User.reload();
                    context.setAttribute("app",Hudson.this);
                } catch (IOException e) {
                    LOGGER.log(Level.SEVERE,"Failed to reload Hudson config",e);
                }
            }
        }.start();
K
kohsuke 已提交
1764 1765
    }

1766 1767 1768 1769
    public boolean isPluginUploaded() {
        return pluginUploaded;
    }

K
kohsuke 已提交
1770 1771 1772 1773 1774
    /**
     * Uploads a plugin.
     */
    public void doUploadPlugin( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        try {
K
kohsuke 已提交
1775
            checkPermission(ADMINISTER);
K
kohsuke 已提交
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788

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

1789 1790
            pluginUploaded=true;

K
kohsuke 已提交
1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
            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 {
1803 1804
        // Parse the request
        MultipartFormDataParser p = new MultipartFormDataParser(req);
K
kohsuke 已提交
1805 1806
        try {
            rsp.sendRedirect2(req.getContextPath()+"/fingerprint/"+
1807 1808 1809
                Util.getDigestOf(p.getFileItem("name").getInputStream())+'/');
        } finally {
            p.cleanUp();
K
kohsuke 已提交
1810 1811 1812 1813 1814 1815 1816
        }
    }

    /**
     * Serves static resources without the "Last-Modified" header to work around
     * a bug in Firefox.
     *
K
kohsuke 已提交
1817 1818
     * <p>
     * See https://bugzilla.mozilla.org/show_bug.cgi?id=89419
K
kohsuke 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827
     */
    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
K
kohsuke 已提交
1828
            rsp.sendError(SC_BAD_REQUEST);
K
kohsuke 已提交
1829 1830 1831 1832 1833
            return;
        }

        File f = new File(req.getServletContext().getRealPath("/images"),path.substring(1));
        if(!f.exists()) {
1834
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848
            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());
K
kohsuke 已提交
1849
        Util.copyStream(in,rsp.getOutputStream());
K
kohsuke 已提交
1850 1851 1852 1853
        in.close();
    }

    /**
K
kohsuke 已提交
1854
     * For debugging. Expose URL to perform GC.
K
kohsuke 已提交
1855 1856 1857 1858 1859 1860 1861 1862
     */
    public void doGc( StaplerRequest req, StaplerResponse rsp ) throws IOException {
        System.gc();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("GCed");
    }

K
kohsuke 已提交
1863 1864 1865 1866 1867
    /**
     * Shutdown the system.
     * @since 1.161
     */
    public void doExit( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
1868
        checkPermission(ADMINISTER);
1869
        LOGGER.severe(String.format("Shutting down VM as requested by %s from %s",
K
kohsuke 已提交
1870
                getAuthentication(), req.getRemoteAddr()));
K
kohsuke 已提交
1871 1872 1873 1874 1875 1876 1877 1878 1879
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        PrintWriter w = rsp.getWriter();
        w.println("Shutting down");
        w.close();
        
        System.exit(0);
    }

K
kohsuke 已提交
1880 1881 1882 1883 1884
    /**
     * Gets the {@link Authentication} object that represents the user
     * associated with the current request.
     */
    public static Authentication getAuthentication() {
K
kohsuke 已提交
1885 1886 1887 1888 1889
        Authentication a = SecurityContextHolder.getContext().getAuthentication();
        // on Tomcat while serving the login page, this is null despite the fact
        // that we have filters. Looking at the stack trace, Tomcat doesn't seem to
        // run the request through filters when this is the login request.
        // see http://www.nabble.com/Matrix-authorization-problem-tp14602081p14886312.html
K
kohsuke 已提交
1890 1891
        if(a==null)
            a = new AnonymousAuthenticationToken("anonymous","anonymous",new GrantedAuthority[]{new GrantedAuthorityImpl("anonymous")});
K
kohsuke 已提交
1892
        return a;
K
kohsuke 已提交
1893 1894
    }

1895 1896 1897 1898
    /**
     * Configure the logging level.
     */
    public void doConfigLogger( StaplerRequest req, StaplerResponse rsp, @QueryParameter("name") String name, @QueryParameter("level") String level) throws IOException {
K
kohsuke 已提交
1899
        checkPermission(ADMINISTER);
1900 1901 1902 1903
        Logger.getLogger(name).setLevel(Level.parse(level.toUpperCase()));
        rsp.sendRedirect2("log");
    }

K
kohsuke 已提交
1904 1905
    /**
     * For system diagnostics.
K
kohsuke 已提交
1906
     * Run arbitrary Groovy script.
K
kohsuke 已提交
1907 1908
     */
    public void doScript( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1909 1910
        // ability to run arbitrary script is dangerous
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931

        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 已提交
1932 1933 1934 1935 1936 1937 1938
    /**
     * Sign up for the user account.
     */
    public void doSignup( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        req.getView(getSecurityRealm(),"signup.jelly").forward(req,rsp);
    }

K
kohsuke 已提交
1939 1940 1941
    /**
     * Changes the icon size by changing the cookie
     */
K
kohsuke 已提交
1942 1943 1944 1945
    public void doIconSize( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        String qs = req.getQueryString();
        if(!ICON_SIZE.matcher(qs).matches())
            throw new ServletException();
1946 1947 1948
        Cookie cookie = new Cookie("iconSize", qs);
        cookie.setMaxAge(/* ~4 mo. */9999999); // #762
        rsp.addCookie(cookie);
K
kohsuke 已提交
1949 1950 1951
        String ref = req.getHeader("Referer");
        if(ref==null)   ref=".";
        rsp.sendRedirect2(ref);
K
kohsuke 已提交
1952 1953
    }

K
kohsuke 已提交
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
    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();
    }

    /**
     * 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");
2003
                File mac = new File(f,"lib/dt.jar");
K
kohsuke 已提交
2004
                if(!toolsJar.exists() && !mac.exists()) {
K
kohsuke 已提交
2005 2006 2007 2008 2009 2010 2011 2012 2013
                    error(f+" doesn't look like a JDK directory");
                    return;
                }

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

K
kohsuke 已提交
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
    /**
     * 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 已提交
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
    /**
     * 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();
    }

2060 2061 2062 2063 2064 2065 2066 2067
    /**
     * Serves static resources placed along with Jelly view files.
     * <p>
     * This method can serve a lot of files, so care needs to be taken
     * to make this method secure. It's not clear to me what's the best
     * strategy here, though the current implementation is based on
     * file extensions.
     */
2068
    public void doResources(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
2069
        String path = req.getRestOfPath();
2070 2071 2072 2073 2074 2075
        // cut off the "..." portion of /resources/.../path/to/file
        // as this is only used to make path unique (which in turn
        // allows us to set a long expiration date
        path = path.substring(1);
        path = path.substring(path.indexOf('/')+1);

2076 2077 2078
        int idx = path.lastIndexOf('.');
        String extension = path.substring(idx+1);
        if(ALLOWED_RESOURCE_EXTENSIONS.contains(extension)) {
2079 2080 2081 2082
            URL url = pluginManager.uberClassLoader.getResource(path);
            if(url!=null) {
                long expires = MetaClass.NO_CACHE ? 0 : 365L * 24 * 60 * 60 * 1000; /*1 year*/
                rsp.serveFile(req,url,expires);
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
                return;
            }
        }
        rsp.sendError(HttpServletResponse.SC_NOT_FOUND);
    }

    /**
     * Extension list that {@link #doResources(StaplerRequest, StaplerResponse)} can serve.
     * This set is mutable to allow plugins to add additional extensions.
     */
    public static final Set<String> ALLOWED_RESOURCE_EXTENSIONS = new HashSet<String>(Arrays.asList(
2094
        "js|css|jpeg|jpg|png|gif|html|htm".split("\\|")
2095 2096
    ));

K
kohsuke 已提交
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112

    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 已提交
2113
        for( AbstractProject p : getAllItems(AbstractProject.class) ) {
K
kohsuke 已提交
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
            SCM scm = p.getScm();
            if (scm instanceof CVSSCM) {
                CVSSCM cvsscm = (CVSSCM) scm;
                r.add(cvsscm.getCvsRoot());
            }
        }

        return r;
    }

2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134
    /**
     * Rebuilds the dependency map.
     */
    public void rebuildDependencyGraph() {
        dependencyGraph = new DependencyGraph();
    }

    public DependencyGraph getDependencyGraph() {
        return dependencyGraph;
    }

K
kohsuke 已提交
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
    /**
     * Gets the {@link Widget}s registered on this object.
     *
     * <p>
     * Plugins who wish to contribute boxes on the side panel can add widgets
     * by {@code getWidgets().add(new MyWidget())} from {@link Plugin#start()}.
     */
    public List<Widget> getWidgets() {
        return widgets;
    }

K
kohsuke 已提交
2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
    public Object getTarget() {
        String rest = Stapler.getCurrentRequest().getRestOfPath();
        if(rest.startsWith("/login")
        || rest.startsWith("/logout")
        || rest.startsWith("/securityRealm"))
            return this;    // URLs that are always visible without READ permission
        
        checkPermission(READ);
        return this;
    }

K
kohsuke 已提交
2157 2158 2159 2160 2161
    public static final class MasterComputer extends Computer {
        private MasterComputer() {
            super(Hudson.getInstance());
        }

K
kohsuke 已提交
2162 2163 2164 2165 2166 2167 2168
        @Override
        public String getDisplayName() {
            return "master";
        }

        @Override
        public String getCaption() {
2169
            return "Master";
K
kohsuke 已提交
2170 2171
        }

K
kohsuke 已提交
2172 2173 2174 2175
        public String getUrl() {
            return "computer/(master)/";
        }

K
kohsuke 已提交
2176 2177 2178 2179 2180
        @Override
        public VirtualChannel getChannel() {
            return localChannel;
        }

K
kohsuke 已提交
2181 2182 2183 2184
        public List<LogRecord> getLogRecords() throws IOException, InterruptedException {
            return logRecords;
        }

K
kohsuke 已提交
2185 2186 2187
        public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            // this computer never returns null from channel, so
            // this method shall never be invoked.
2188
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
2189 2190
        }

2191 2192 2193 2194
        public void launch() {
            // noop
        }

K
kohsuke 已提交
2195 2196 2197 2198 2199 2200
        /**
         * {@link LocalChannel} instance that can be used to execute programs locally.
         */
        public static final LocalChannel localChannel = new LocalChannel(threadPoolForRemoting);
    }

2201 2202 2203 2204
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2205 2206 2207 2208
    public static boolean adminCheck() throws IOException {
        return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse());
    }

2209 2210 2211 2212
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2213
    public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2214 2215 2216 2217 2218 2219
        if (isAdmin(req)) return true;

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

K
kohsuke 已提交
2220 2221 2222
    /**
     * Checks if the current user (for which we are processing the current request)
     * has the admin access.
2223 2224 2225
     *
     * @deprecated
     *      Define a custom {@link Permission} and check against ACL.
K
kohsuke 已提交
2226
     */
K
kohsuke 已提交
2227
    public static boolean isAdmin() {
2228
        return Hudson.getInstance().getACL().hasPermission(ADMINISTER);
K
kohsuke 已提交
2229 2230
    }

2231 2232 2233 2234
    /**
     * @deprecated
     *      Define a custom {@link Permission} and check against ACL.
     */
K
kohsuke 已提交
2235
    public static boolean isAdmin(StaplerRequest req) {
2236
        return isAdmin();
K
kohsuke 已提交
2237 2238 2239 2240 2241
    }

    /**
     * Live view of recent {@link LogRecord}s produced by Hudson.
     */
J
jglick 已提交
2242
    public static List<LogRecord> logRecords = Collections.emptyList(); // initialized to dummy value to avoid NPE
K
kohsuke 已提交
2243 2244 2245 2246

    /**
     * Thread-safe reusable {@link XStream}.
     */
2247
    public static final XStream XSTREAM = new XStream2();
K
kohsuke 已提交
2248

2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
    /**
     * 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());



2260 2261 2262 2263 2264
    /**
     * Version number of this Hudson.
     */
    public static String VERSION;

2265 2266 2267 2268 2269 2270 2271
    /**
     * 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;

2272 2273 2274 2275 2276 2277 2278
    /**
     * Prefix to resources alongside view scripts.
     * Strings like "/resources/VERSION", which avoids Hudson to pick up
     * stale cache when the user upgrades to a different version.
     */
    public static String VIEW_RESOURCE_PATH;

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

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

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

2285
    public static final PermissionGroup PERMISSIONS = new PermissionGroup(Hudson.class,Messages._Hudson_Permissions_Title());
K
kohsuke 已提交
2286 2287
    public static final Permission ADMINISTER = new Permission(PERMISSIONS,"Administer", Permission.FULL_CONTROL);
    public static final Permission READ = new Permission(PERMISSIONS,"Read", Permission.READ);
K
kohsuke 已提交
2288

K
kohsuke 已提交
2289 2290 2291 2292
    static {
        XSTREAM.alias("hudson",Hudson.class);
        XSTREAM.alias("slave",Slave.class);
        XSTREAM.alias("jdk",JDK.class);
2293 2294 2295
        // for backward compatibility with <1.75, recognize the tag name "view" as well.
        XSTREAM.alias("view", ListView.class);
        XSTREAM.alias("listView", ListView.class);
2296 2297
        // this seems to be necessary to force registration of converter early enough
        Mode.class.getEnumConstants();
K
kohsuke 已提交
2298 2299
    }
}