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

S
sogabe 已提交
3
import com.thoughtworks.xstream.XStream;
4
import hudson.BulkChange;
5
import hudson.FilePath;
6
import hudson.Functions;
K
kohsuke 已提交
7
import hudson.Launcher;
S
sogabe 已提交
8
import hudson.Launcher.LocalLauncher;
K
kohsuke 已提交
9 10 11
import hudson.Plugin;
import hudson.PluginManager;
import hudson.PluginWrapper;
12
import hudson.ProxyConfiguration;
13
import hudson.StructuredForm;
K
kohsuke 已提交
14
import hudson.TcpSlaveAgentListener;
15
import hudson.Util;
S
sogabe 已提交
16
import static hudson.Util.fixEmpty;
17
import hudson.WebAppMain;
18
import hudson.XmlFile;
19
import hudson.logging.LogRecorderManager;
20
import hudson.lifecycle.WindowsInstallerLink;
K
kohsuke 已提交
21
import hudson.lifecycle.Lifecycle;
K
kohsuke 已提交
22
import hudson.model.Descriptor.FormException;
23
import hudson.model.listeners.ItemListener;
K
kohsuke 已提交
24
import hudson.model.listeners.JobListener;
25
import hudson.model.listeners.JobListener.JobListenerAdapter;
S
sogabe 已提交
26
import hudson.model.listeners.SCMListener;
K
kohsuke 已提交
27 28
import hudson.remoting.LocalChannel;
import hudson.remoting.VirtualChannel;
K
kohsuke 已提交
29
import hudson.scm.CVSSCM;
K
kohsuke 已提交
30 31
import hudson.scm.RepositoryBrowser;
import hudson.scm.RepositoryBrowsers;
32 33 34
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
import hudson.scm.SCMS;
35
import hudson.scm.SubversionSCM;
K
kohsuke 已提交
36
import hudson.search.CollectionSearchIndex;
37
import hudson.search.SearchIndexBuilder;
38
import hudson.security.ACL;
39
import hudson.security.AccessControlled;
40
import hudson.security.AuthorizationStrategy;
K
kohsuke 已提交
41
import hudson.security.BasicAuthenticationFilter;
42 43 44 45
import hudson.security.HudsonFilter;
import hudson.security.LegacyAuthorizationStrategy;
import hudson.security.LegacySecurityRealm;
import hudson.security.Permission;
46
import hudson.security.PermissionGroup;
K
kohsuke 已提交
47
import hudson.security.SecurityMode;
48
import hudson.security.SecurityRealm;
49 50
import hudson.slaves.ComputerListener;
import hudson.slaves.RetentionStrategy;
K
kohsuke 已提交
51 52 53 54 55
import hudson.slaves.NodeList;
import hudson.slaves.Cloud;
import hudson.slaves.DumbSlave;
import hudson.slaves.NodeDescriptor;
import hudson.slaves.NodeProvisioner;
56 57 58 59 60 61 62 63
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 已提交
64
import hudson.triggers.Trigger;
65
import hudson.triggers.TriggerDescriptor;
66
import hudson.triggers.Triggers;
K
kohsuke 已提交
67
import hudson.util.CaseInsensitiveComparator;
K
kohsuke 已提交
68 69 70 71 72 73 74
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;
K
kohsuke 已提交
75
import hudson.util.RemotingDiagnostics;
76
import hudson.util.TextFile;
K
kohsuke 已提交
77
import hudson.util.XStream2;
K
kohsuke 已提交
78
import hudson.util.HudsonIsRestarting;
K
kohsuke 已提交
79 80
import hudson.util.DescribableList;
import hudson.util.Futures;
K
kohsuke 已提交
81
import hudson.widgets.Widget;
S
sogabe 已提交
82
import net.sf.json.JSONObject;
83
import org.acegisecurity.*;
S
sogabe 已提交
84 85 86 87
import org.acegisecurity.context.SecurityContextHolder;
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.acegisecurity.ui.AbstractProcessingFilter;
import static org.acegisecurity.ui.rememberme.TokenBasedRememberMeServices.ACEGI_SECURITY_HASHED_REMEMBER_ME_COOKIE_KEY;
K
kohsuke 已提交
88
import org.apache.commons.logging.LogFactory;
89 90
import org.apache.commons.jelly.Script;
import org.apache.commons.jelly.JellyException;
S
sogabe 已提交
91 92 93 94 95 96
import org.kohsuke.stapler.MetaClass;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
97
import org.kohsuke.stapler.StaplerFallback;
98 99 100
import org.kohsuke.stapler.WebApp;
import org.kohsuke.stapler.jelly.JellyClassLoaderTearOff;
import org.kohsuke.stapler.jelly.JellyRequestDispatcher;
K
kohsuke 已提交
101
import org.kohsuke.stapler.framework.adjunct.AdjunctManager;
S
sogabe 已提交
102
import org.kohsuke.stapler.export.Exported;
103
import org.kohsuke.stapler.export.ExportedBean;
104
import org.xml.sax.InputSource;
K
kohsuke 已提交
105

S
sogabe 已提交
106 107 108 109 110 111 112 113
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
import javax.servlet.http.HttpSession;
K
kohsuke 已提交
114 115 116
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
117
import java.io.FileOutputStream;
K
kohsuke 已提交
118 119
import java.io.IOException;
import java.io.PrintWriter;
K
kohsuke 已提交
120
import java.io.InputStream;
121
import java.net.URL;
122
import java.security.SecureRandom;
123
import java.text.NumberFormat;
K
kohsuke 已提交
124 125 126 127 128 129 130 131
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
132
import java.util.Iterator;
K
kohsuke 已提交
133 134
import java.util.List;
import java.util.Map;
S
sogabe 已提交
135
import java.util.Map.Entry;
K
kohsuke 已提交
136
import java.util.Set;
137 138
import java.util.Stack;
import java.util.StringTokenizer;
139
import java.util.Timer;
K
kohsuke 已提交
140
import java.util.TreeSet;
K
kohsuke 已提交
141
import java.util.Properties;
142
import java.util.concurrent.Callable;
143
import java.util.concurrent.ConcurrentHashMap;
K
kohsuke 已提交
144
import java.util.concurrent.CopyOnWriteArrayList;
145 146 147 148 149
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
150
import java.util.concurrent.LinkedBlockingQueue;
K
kohsuke 已提交
151
import java.util.concurrent.TimeoutException;
K
kohsuke 已提交
152
import java.util.logging.Level;
K
kohsuke 已提交
153
import java.util.logging.LogRecord;
154
import java.util.logging.Logger;
155
import java.util.regex.Pattern;
156
import java.nio.charset.Charset;
157
import javax.servlet.RequestDispatcher;
K
kohsuke 已提交
158 159 160 161 162 163

/**
 * Root object of the system.
 *
 * @author Kohsuke Kawaguchi
 */
164
@ExportedBean
165
public final class Hudson extends AbstractModelObject implements ItemGroup<TopLevelItem>, Node, StaplerProxy, StaplerFallback, ViewGroup, AccessControlled {
166
    private transient final Queue queue;
K
kohsuke 已提交
167 168 169 170

    /**
     * {@link Computer}s in this Hudson system. Read-only.
     */
K
kohsuke 已提交
171
    private transient final Map<Node,Computer> computers = new CopyOnWriteMap.Hash<Node,Computer>();
K
kohsuke 已提交
172 173 174 175 176 177

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

178 179 180 181 182
    /**
     * Job allocation strategy.
     */
    private Mode mode = Mode.NORMAL;

K
kohsuke 已提交
183 184
    /**
     * False to enable anyone to do anything.
K
kohsuke 已提交
185
     * Left as a field so that we can still read old data that uses this flag.
186 187 188
     *
     * @see #authorizationStrategy
     * @see #securityRealm
K
kohsuke 已提交
189
     */
K
kohsuke 已提交
190
    private Boolean useSecurity;
K
kohsuke 已提交
191 192

    /**
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
     * 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.
     *
210
     * See {@link HudsonFilter} for the concrete authentication protocol.
211
     *
212 213
     * Never null. Always use {@link #setSecurityRealm(SecurityRealm)} to
     * update this field.
214 215
     *
     * @see #getSecurity()
216
     * @see #setSecurityRealm(SecurityRealm)
K
kohsuke 已提交
217
     */
218
    private volatile SecurityRealm securityRealm;
K
kohsuke 已提交
219 220 221 222 223 224 225 226 227 228 229

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

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

230 231 232
    /**
     * All {@link Item}s keyed by their {@link Item#getName() name}s.
     */
K
kohsuke 已提交
233
    /*package*/ transient final Map<String,TopLevelItem> items = new CopyOnWriteMap.Tree<String,TopLevelItem>(CaseInsensitiveComparator.INSTANCE);
234

K
kohsuke 已提交
235 236 237 238 239
    /**
     * The sole instance.
     */
    private static Hudson theInstance;

K
kohsuke 已提交
240 241
    private transient volatile boolean isQuietingDown;
    private transient volatile boolean terminating;
K
kohsuke 已提交
242

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

K
kohsuke 已提交
245 246 247 248 249
    /**
     * Widgets on Hudson.
     */
    private transient final List<Widget> widgets = new CopyOnWriteArrayList<Widget>();

250
    private transient volatile DependencyGraph dependencyGraph;
251

K
kohsuke 已提交
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
    /**
     * Active {@link Cloud}s.
     */
    public final CloudList clouds = new CloudList(this);

    public static class CloudList extends DescribableList<Cloud,Descriptor<Cloud>> {
        public CloudList(Hudson h) {
            super(h);
        }

        protected void onModified() throws IOException {
            super.onModified();
            Hudson.getInstance().trimLabels();
        }
    }

K
kohsuke 已提交
268 269
    /**
     * Set of installed cluster nodes.
K
kohsuke 已提交
270
     * <p>
K
kohsuke 已提交
271 272 273 274
     * 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.
K
kohsuke 已提交
275 276 277
     * <p>
     * The field name should be really {@code nodes}, but again the backward compatibility
     * prevents us from renaming.
K
kohsuke 已提交
278
     */
K
kohsuke 已提交
279
    private volatile NodeList slaves;
K
kohsuke 已提交
280 281 282 283 284 285 286 287 288

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

    /**
289
     * {@link View}s.
K
kohsuke 已提交
290
     */
291 292 293 294
    private final CopyOnWriteArrayList<View> views = new CopyOnWriteArrayList<View>();

    /**
     * Name of the primary view.
295 296 297
     * <p>
     * Start with null, so that we can upgrade pre-1.269 data well.
     * @since 1.269
298 299
     */
    private volatile String primaryView;
300

K
kohsuke 已提交
301 302 303 304 305 306 307
    private transient final FingerprintMap fingerprintMap = new FingerprintMap();

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

308
    public transient volatile TcpSlaveAgentListener tcpSlaveAgentListener;
K
kohsuke 已提交
309

310
    /**
K
kohsuke 已提交
311
     * List of registered {@link JobListener}s.
312
     */
K
kohsuke 已提交
313
    private transient final CopyOnWriteList<ItemListener> itemListeners = new CopyOnWriteList<ItemListener>();
314 315 316 317 318

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

320 321 322 323 324
    /**
     * List of registered {@link ComputerListener}s.
     */
    private transient final CopyOnWriteList<ComputerListener> computerListeners = new CopyOnWriteList<ComputerListener>();

325 326
    /**
     * TCP slave agent port.
327
     * 0 for random, -1 to disable.
328 329 330
     */
    private int slaveAgentPort =0;

331 332 333 334 335
    /**
     * Whitespace-separated labels assigned to the master as a {@link Node}.
     */
    private String label="";

336 337 338 339 340
    /**
     * 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>();
341
    private transient volatile Set<Label> labelSet;
342
    private transient volatile Set<Label> dynamicLabels = null;
343

K
kohsuke 已提交
344 345 346 347 348 349 350 351 352 353
    /**
     * Load statistics of the entire system.
     */
    public transient final OverallLoadStatistics overallLoad = new OverallLoadStatistics();

    /**
     * {@link NodeProvisioner} that reacts to {@link OverallLoadStatistics}.
     */
    public transient final NodeProvisioner overallNodeProvisioner = new NodeProvisioner(null,overallLoad);

354 355
    public transient final ServletContext servletContext;

K
kohsuke 已提交
356 357 358 359 360 361
    /**
     * Transient action list. Useful for adding navigation items to the navigation bar
     * on the left.
     */
    private transient final List<Action> actions = new CopyOnWriteArrayList<Action>();

362 363 364 365 366 367 368
    /**
     * {@link AdministrativeMonitor}s installed on this system.
     *
     * @see AdministrativeMonitor
     */
    public transient final List<AdministrativeMonitor> administrativeMonitors = new CopyOnWriteArrayList<AdministrativeMonitor>();

K
kohsuke 已提交
369 370 371 372 373
    /**
     * {@link AdjunctManager}
     */
    private transient final AdjunctManager adjuncts;

K
kohsuke 已提交
374 375 376 377
    public static Hudson getInstance() {
        return theInstance;
    }

378 379
    /**
     * Secrete key generated once and used for a long time, beyond
K
kohsuke 已提交
380 381
     * container start/stop. Persisted outside <tt>config.xml</tt> to avoid
     * accidental exposure.
382
     */
K
kohsuke 已提交
383
    private transient final String secretKey;
384

385
    private transient final UpdateCenter updateCenter = new UpdateCenter(this);
K
kohsuke 已提交
386

387 388 389 390 391
    /**
     * True if the user opted out from the statistics tracking. We'll never send anything if this is true.
     */
    private Boolean noUsageStatistics;

392 393 394 395 396
    /**
     * HTTP proxy configuration.
     */
    public transient volatile ProxyConfiguration proxy;

K
kohsuke 已提交
397
    /**
398
     * Bound to "/log".
K
kohsuke 已提交
399
     */
400
    private transient final LogRecorderManager log = new LogRecorderManager();
401

K
kohsuke 已提交
402 403
    public Hudson(File root, ServletContext context) throws IOException {
        this.root = root;
404
        this.servletContext = context;
K
kohsuke 已提交
405
        computeVersion(context);
K
kohsuke 已提交
406 407 408
        if(theInstance!=null)
            throw new IllegalStateException("second instance");
        theInstance = this;
409 410

        log.load();
411

K
kohsuke 已提交
412
        Trigger.timer = new Timer("Hudson cron thread");
413
        queue = new Queue();
K
kohsuke 已提交
414

415 416 417 418 419 420 421 422 423
        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;
        }

424 425 426 427 428 429 430 431 432 433 434 435
        // 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);
        }

436 437 438 439 440 441
        try {
            proxy = ProxyConfiguration.load();
        } catch (IOException e) {
            LOGGER.log(Level.SEVERE, "Failed to load proxy configuration", e);
        }

442 443
        // run the init code of SubversionSCM before we load plugins so that plugins can change SubversionWorkspaceSelector.
        SubversionSCM.DescriptorImpl.DESCRIPTOR.getDisplayName();
444

K
kohsuke 已提交
445 446 447
        // load plugins.
        pluginManager = new PluginManager(context);

K
kohsuke 已提交
448
        // if we are loading old data that doesn't have this field
K
kohsuke 已提交
449
        if(slaves==null)    slaves = new NodeList();
K
kohsuke 已提交
450

451
        // work around to have MavenModule register itself until we either move it to a plugin
452
        // or make it a part of the core.
453
        Items.LIST.hashCode();
454

K
kohsuke 已提交
455
        adjuncts = new AdjunctManager(servletContext, pluginManager.uberClassLoader,"adjuncts/"+VERSION_HASH);
456

K
kohsuke 已提交
457
        load();
458

459 460 461 462 463 464 465 466 467 468 469 470 471
//        try {
//            // fill up the cache
//            load();
//
//            Controller c = new Controller();
//            c.startCPUProfiling(ProfilingModes.CPU_TRACING,""); // "java.*");
//            load();
//            c.stopCPUProfiling();
//            c.captureSnapshot(ProfilingModes.SNAPSHOT_WITHOUT_HEAP);
//        } catch (Exception e) {
//            throw new Error(e);
//        }

472 473 474 475 476
        if(slaveAgentPort!=-1)
            tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
        else
            tcpSlaveAgentListener = null;

K
kohsuke 已提交
477 478 479
        updateComputerList();

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

K
kohsuke 已提交
481
        for (ItemListener l : itemListeners)
482
            l.onLoaded();
483

484
        WindowsInstallerLink.registerIfApplicable();
485
        UsageStatistics.register();
K
kohsuke 已提交
486 487
        LoadStatistics.register();
        NodeProvisioner.launch();
K
kohsuke 已提交
488 489
    }

K
kohsuke 已提交
490 491 492 493
    public TcpSlaveAgentListener getTcpSlaveAgentListener() {
        return tcpSlaveAgentListener;
    }

K
kohsuke 已提交
494 495 496 497 498 499 500 501 502
    /**
     * Makes {@link AdjunctManager} URL-bound.
     * The dummy parameter allows us to use different URLs for the same adjunct,
     * for proper cache handling.
     */
    public AdjunctManager getAdjuncts(String dummy) {
        return adjuncts;
    }

K
kohsuke 已提交
503
    @Exported
504 505 506 507
    public int getSlaveAgentPort() {
        return slaveAgentPort;
    }

K
kohsuke 已提交
508
    /**
J
jglick 已提交
509
     * If you are calling this on Hudson something is wrong.
K
kohsuke 已提交
510 511 512
     *
     * @deprecated
     */
J
jglick 已提交
513
    @Deprecated
K
kohsuke 已提交
514 515 516 517
    public String getNodeName() {
        return "";
    }

K
kohsuke 已提交
518 519 520 521
    public void setNodeName(String name) {
        throw new UnsupportedOperationException(); // not allowed
    }

K
kohsuke 已提交
522 523 524 525
    public String getNodeDescription() {
        return "the master Hudson node";
    }

526
    @Exported
K
kohsuke 已提交
527 528 529 530 531 532 533
    public String getDescription() {
        return systemMessage;
    }

    public PluginManager getPluginManager() {
        return pluginManager;
    }
534

535 536 537
    public UpdateCenter getUpdateCenter() {
        return updateCenter;
    }
K
kohsuke 已提交
538

539 540 541 542
    public boolean isUsageStatisticsCollected() {
        return noUsageStatistics==null || !noUsageStatistics;
    }

543 544 545 546 547
    public void setNoUsageStatistics(Boolean noUsageStatistics) throws IOException {
        this.noUsageStatistics = noUsageStatistics;
        save();
    }

548 549 550 551 552 553 554 555 556 557 558 559
    public View.People getPeople() {
        return new View.People(this);
    }

    /**
     * Does this {@link View} has any associated user information recorded?
     */
    public final boolean hasPeople() {
        return View.People.isApplicable(items.values());
    }

    public Api getApi() {
560
        return new Api(this);
561 562
    }

563 564 565
    /**
     * Returns a secret key that survives across container start/stop.
     * <p>
566
     * This value is useful for implementing some of the security features.
567 568
     */
    public String getSecretKey() {
K
kohsuke 已提交
569
        return secretKey;
570 571
    }

K
kohsuke 已提交
572 573 574 575 576 577 578
    /**
     * 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 已提交
579 580 581 582 583 584 585
    /**
     * 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 已提交
586 587 588 589 590 591 592
    /**
     * 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 已提交
593 594 595 596 597 598 599
    /**
     * 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 已提交
600 601 602 603 604 605 606
    /**
     * 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 已提交
607 608 609
    /**
     * Gets the trigger descriptor by name. Primarily used for making them web-visible.
     */
610
    public TriggerDescriptor getTrigger(String shortClassName) {
611 612 613 614 615 616 617 618
        return (TriggerDescriptor) findDescriptor(shortClassName, Triggers.TRIGGERS);
    }

    /**
     * Gets the retention strategy descriptor by name. Primarily used for making them web-visible.
     */
    public Descriptor<RetentionStrategy<?>> getRetentionStrategy(String shortClassName) {
        return findDescriptor(shortClassName, RetentionStrategy.LIST);
K
kohsuke 已提交
619 620
    }

621 622 623 624
    /**
     * Gets the {@link JobPropertyDescriptor} by name. Primarily used for making them web-visible.
     */
    public JobPropertyDescriptor getJobProperty(String shortClassName) {
K
kohsuke 已提交
625 626 627
        // combining these two lines triggers javac bug. See issue #610.
        Descriptor d = findDescriptor(shortClassName, Jobs.PROPERTIES);
        return (JobPropertyDescriptor) d;
628 629
    }

630 631 632 633 634 635 636 637 638 639 640 641 642
    /**
     * Exposes {@link Descriptor} by its name to URL.
     *
     * After doing all the {@code getXXX(shortClassName)} methods, I finally realized that
     * this just doesn't scale.
     */
    public Descriptor getDescriptor(String fullyQualifiedClassName) {
        for( Descriptor d : Descriptor.ALL )
            if(d.clazz.getName().equals(fullyQualifiedClassName))
                return d;
        return null;
    }

643 644 645 646 647 648 649
    /**
     * 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 已提交
650 651 652 653
    /**
     * Finds a descriptor that has the specified name.
     */
    private <T extends Describable<T>>
654
    Descriptor<T> findDescriptor(String shortClassName, Collection<? extends Descriptor<T>> descriptors) {
K
kohsuke 已提交
655 656 657 658 659 660 661 662
        String name = '.'+shortClassName;
        for (Descriptor<T> d : descriptors) {
            if(d.clazz.getName().endsWith(name))
                return d;
        }
        return null;
    }

663 664 665
    /**
     * Adds a new {@link JobListener}.
     *
666 667
     * @deprecated
     *      Use {@code getJobListners().add(l)} instead.
668 669
     */
    public void addListener(JobListener l) {
K
kohsuke 已提交
670
        itemListeners.add(new JobListenerAdapter(l));
671 672 673 674 675
    }

    /**
     * Deletes an existing {@link JobListener}.
     *
676 677
     * @deprecated
     *      Use {@code getJobListners().remove(l)} instead.
678 679
     */
    public boolean removeListener(JobListener l ) {
K
kohsuke 已提交
680
        return itemListeners.remove(new JobListenerAdapter(l));
681 682
    }

683
    /**
684
     * Gets all the installed {@link ItemListener}s.
685
     */
686
    public CopyOnWriteList<ItemListener> getJobListeners() {
K
kohsuke 已提交
687
        return itemListeners;
688 689 690 691 692 693 694 695 696
    }

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

697 698 699 700 701 702 703
    /**
     * Gets all the installed {@link ComputerListener}s.
     */
    public CopyOnWriteList<ComputerListener> getComputerListeners() {
        return computerListeners;
    }

K
kohsuke 已提交
704 705 706 707 708 709 710 711 712 713
    /**
     * 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;
714
        return p.getPlugin();
K
kohsuke 已提交
715 716
    }

717 718 719 720 721 722 723 724 725 726 727 728
    /**
     * Gets the plugin object from its class.
     *
     * <p>
     * This allows easy storage of plugin information in the plugin singleton without
     * every plugin reimplementing the singleton pattern.
     *
     * @param clazz The plugin class (beware class-loader fun, this will probably only work
     * from within the hpi that defines the plugin class, it may or may not work in other cases)
     *
     * @return The plugin instance.
     */
S
stephenconnolly 已提交
729 730
    @SuppressWarnings("unchecked")
    public <P extends Plugin> P getPlugin(Class<P> clazz) {
731 732
        PluginWrapper p = pluginManager.getPlugin(clazz);
        if(p==null)     return null;
S
stephenconnolly 已提交
733
        return (P) p.getPlugin();
734 735 736 737 738 739 740 741 742
    }

    /**
     * Gets the plugin objects from their super-class.
     *
     * @param clazz The plugin class (beware class-loader fun)
     *
     * @return The plugin instances.
     */
S
stephenconnolly 已提交
743 744
    public <P extends Plugin> List<P> getPlugins(Class<P> clazz) {
        List<P> result = new ArrayList<P>();
745
        for (PluginWrapper w: pluginManager.getPlugins(clazz)) {
S
stephenconnolly 已提交
746
            result.add((P)w.getPlugin());
747 748 749 750
        }
        return Collections.unmodifiableList(result);
    }

K
kohsuke 已提交
751 752 753 754 755 756 757
    /**
     * Synonym to {@link #getNodeDescription()}.
     */
    public String getSystemMessage() {
        return systemMessage;
    }

758 759 760 761 762 763 764 765
    /**
     * Sets the system message.
     */
    public void setSystemMessage(String message) throws IOException {
        this.systemMessage = message;
        save();
    }

K
kohsuke 已提交
766
    public Launcher createLauncher(TaskListener listener) {
K
kohsuke 已提交
767
        return new LocalLauncher(listener);
K
kohsuke 已提交
768 769
    }

K
kohsuke 已提交
770 771
    private final transient Object updateComputerLock = new Object();

K
kohsuke 已提交
772 773 774 775 776 777 778
    /**
     * 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 已提交
779
    private void updateComputerList() throws IOException {
K
kohsuke 已提交
780
        synchronized(updateComputerLock) {// just so that we don't have two code updating computer list at the same time
K
kohsuke 已提交
781
            Map<String,Computer> byName = new HashMap<String,Computer>();
K
kohsuke 已提交
782 783 784
            for (Computer c : computers.values()) {
                if(c.getNode()==null)
                    continue;   // this computer is gone
K
kohsuke 已提交
785
                byName.put(c.getNode().getNodeName(),c);
K
kohsuke 已提交
786
            }
K
kohsuke 已提交
787 788 789 790 791

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

            updateComputer(this, byName, used);
K
kohsuke 已提交
792
            for (Node s : getNodes())
K
kohsuke 已提交
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
                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 已提交
809 810
        if (c!=null) {
            c.setNode(n); // reuse
K
kohsuke 已提交
811
        } else {
K
kohsuke 已提交
812
            if(n.getNumExecutors()>0) {
K
kohsuke 已提交
813
                computers.put(n,c=n.createComputer());
814 815 816
                RetentionStrategy retentionStrategy = c.getRetentionStrategy();
                if (retentionStrategy != null) {
                    // if there is a retention strategy, it is responsible for deciding to start the computer
817
                    retentionStrategy.start(c);
818 819 820 821
                } else {
                    // we should never get here, but just in case, we'll fall back to the legacy behaviour
                    c.connect(true);
                }
K
kohsuke 已提交
822
            }
K
kohsuke 已提交
823 824 825 826 827
        }
        used.add(c);
    }

    /*package*/ void removeComputer(Computer computer) {
828 829
        for (Entry<Node, Computer> e : computers.entrySet()) {
            if (e.getValue() == computer) {
K
kohsuke 已提交
830
                computers.remove(e.getKey());
831
                return;
K
kohsuke 已提交
832 833 834 835 836
            }
        }
        throw new IllegalStateException("Trying to remove unknown computer");
    }

837 838 839 840
    public String getFullName() {
        return "";
    }

841 842 843 844
    public String getFullDisplayName() {
        return "";
    }

K
kohsuke 已提交
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
    /**
     * 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;
    }

865 866 867
    /**
     * Gets just the immediate children of {@link Hudson}.
     *
868
     * @see #getAllItems(Class)
869
     */
870
    @Exported(name="jobs")
K
kohsuke 已提交
871
    public List<TopLevelItem> getItems() {
872
        return new ArrayList<TopLevelItem>(items.values());
873 874
    }

K
kohsuke 已提交
875 876 877
    /**
     * Gets just the immediate children of {@link Hudson} but of the given type.
     */
K
kohsuke 已提交
878
    public <T> List<T> getItems(Class<T> type) {
K
kohsuke 已提交
879 880 881 882 883 884 885
        List<T> r = new ArrayList<T>();
        for (TopLevelItem i : items.values())
            if (type.isInstance(i))
                 r.add(type.cast(i));
        return r;
    }

886 887 888 889 890 891 892 893 894 895 896 897 898 899
    /**
     * 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 已提交
900
                    r.add(type.cast(i));
901 902 903 904 905 906 907 908
                if(i instanceof ItemGroup)
                    q.push((ItemGroup)i);
            }
        }

        return r;
    }

K
kohsuke 已提交
909
    /**
K
kohsuke 已提交
910 911 912 913 914
     * 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 已提交
915
     */
K
kohsuke 已提交
916
    public List<Project> getProjects() {
K
kohsuke 已提交
917
        return Util.createSubList(items.values(),Project.class);
K
kohsuke 已提交
918 919 920 921 922
    }

    /**
     * Gets the names of all the {@link Job}s.
     */
K
kohsuke 已提交
923
    public Collection<String> getJobNames() {
924
        List<String> names = new ArrayList<String>();
K
kohsuke 已提交
925
        for (Job j : getAllItems(Job.class))
926
            names.add(j.getFullName());
927
        return names;
K
kohsuke 已提交
928 929
    }

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

940
    public synchronized View getView(String name) {
941 942 943
        for (View v : views) {
            if(v.getViewName().equals(name))
                return v;
K
kohsuke 已提交
944
        }
945
        return null;
K
kohsuke 已提交
946 947 948
    }

    /**
949
     * Gets the read-only list of all {@link View}s.
K
kohsuke 已提交
950
     */
951
    @Exported
952
    public synchronized Collection<View> getViews() {
953
        List<View> copy = new ArrayList<View>(views);
954 955
        Collections.sort(copy, View.SORTER);
        return copy;
K
kohsuke 已提交
956 957
    }

958
    public synchronized void deleteView(View view) throws IOException {
959 960 961 962
        if(views.size()<=1)
            throw new IllegalStateException();
        views.remove(view);
        save();
K
kohsuke 已提交
963 964 965 966 967 968
    }

    /**
     * Gets the read-only list of all {@link Computer}s.
     */
    public Computer[] getComputers() {
969 970 971 972 973
        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 已提交
974
                return lhs.getDisplayName().compareTo(rhs.getDisplayName());
975 976 977
            }
        });
        return r;
K
kohsuke 已提交
978 979
    }

980 981 982 983
    /*package*/ Computer getComputer(Node n) {
        return computers.get(n);
    }

K
kohsuke 已提交
984
    public Computer getComputer(String name) {
K
kohsuke 已提交
985 986 987
        if(name.equals("(master)"))
            name = "";

988 989 990
        for (Computer c : computers.values()) {
            if(c.getNode().getNodeName().equals(name))
                return c;
K
kohsuke 已提交
991 992 993 994
        }
        return null;
    }

K
kohsuke 已提交
995 996 997 998 999 1000 1001 1002
    /**
     * @deprecated
     *      UI method. Not meant to be used programatically.
     */
    public ComputerSet getComputer() {
        return new ComputerSet();
    }

1003
    public Computer toComputer() {
1004
        return getComputer(this);
1005 1006
    }

1007 1008 1009 1010 1011 1012
    /**
     * 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 已提交
1013
        if(name==null)  return null;
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        while(true) {
            Label l = labels.get(name);
            if(l!=null)
                return l;

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

    /**
1025
     * Gets all the active labels in the current system.
1026 1027 1028 1029
     */
    public Set<Label> getLabels() {
        Set<Label> r = new TreeSet<Label>();
        for (Label l : labels.values()) {
K
kohsuke 已提交
1030
            if(!l.isEmpty())
1031 1032 1033 1034 1035
                r.add(l);
        }
        return r;
    }

K
kohsuke 已提交
1036 1037 1038 1039 1040
    public Queue getQueue() {
        return queue;
    }

    public String getDisplayName() {
K
i18n  
kohsuke 已提交
1041
        return Messages.Hudson_DisplayName();
K
kohsuke 已提交
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
    }

    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) {
1054 1055 1056 1057 1058 1059
        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 已提交
1060 1061 1062 1063 1064 1065 1066 1067 1068
        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.
K
kohsuke 已提交
1069 1070 1071
     *
     * @deprecated
     *      Use {@link #getNode(String)}. Since 1.252.
K
kohsuke 已提交
1072 1073
     */
    public Slave getSlave(String name) {
K
kohsuke 已提交
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
        Node n = getNode(name);
        if (n instanceof Slave)
            return (Slave)n;
        return null;
    }

    /**
     * Gets the slave node of the give name, hooked under this Hudson.
     */
    public Node getNode(String name) {
        for (Node s : getSlaves()) {
K
kohsuke 已提交
1085 1086 1087 1088 1089 1090
            if(s.getNodeName().equals(name))
                return s;
        }
        return null;
    }

K
kohsuke 已提交
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
    /**
     * Gets a {@link Cloud} by {@link Cloud#name its name}, or null.
     */
    public Cloud getCloud(String name) {
        for (Cloud nf : clouds)
            if(nf.name.equals(name))
                return nf;
        return null;
    }

    /**
     * @deprecated
     *      Use {@link #getNodes()}. Since 1.252.
     */
K
kohsuke 已提交
1105
    public List<Slave> getSlaves() {
K
kohsuke 已提交
1106 1107 1108 1109 1110 1111 1112 1113
        return (List)Collections.unmodifiableList(slaves);
    }

    /**
     * Returns all {@link Node}s in the system, excluding {@link Hudson} instance itself which
     * represents the master.
     */
    public List<Node> getNodes() {
K
kohsuke 已提交
1114 1115 1116
        return Collections.unmodifiableList(slaves);
    }

1117 1118
    /**
     * Updates the slave list.
K
kohsuke 已提交
1119 1120 1121
     *
     * @deprecated
     *      Use {@link #setNodes(List)}. Since 1.252.
1122 1123
     */
    public void setSlaves(List<Slave> slaves) throws IOException {
K
kohsuke 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
        setNodes(slaves);
    }

    /**
     * Adds one more {@link Node} to Hudson.
     */
    public synchronized void addNode(Node n) throws IOException {
        ArrayList<Node> nl = new ArrayList<Node>(this.slaves);
        nl.add(n);
        setNodes(nl);
    }

    /**
     * Removes a {@link Node} from Hudson.
     */
    public synchronized void removeNode(Node n) throws IOException {
        n.toComputer().disconnect();

        ArrayList<Node> nl = new ArrayList<Node>(this.slaves);
        nl.remove(n);
        setNodes(nl);
    }

    public void setNodes(List<? extends Node> nodes) throws IOException {
        // make sure that all names are unique
        Set<String> names = new HashSet<String>();
        for (Node n : nodes)
            if(!names.add(n.getNodeName()))
                throw new IllegalArgumentException(n.getNodeName()+" is defined more than once");
        this.slaves = new NodeList(nodes);
1154
        updateComputerList();
K
kohsuke 已提交
1155 1156 1157
        trimLabels();
        save();
    }
1158

K
kohsuke 已提交
1159 1160 1161 1162
    /**
     * Resets all labels and remove invalid ones.
     */
    private void trimLabels() {
1163 1164 1165
        for (Iterator<Label> itr = labels.values().iterator(); itr.hasNext();) {
            Label l = itr.next();
            l.reset();
K
kohsuke 已提交
1166
            if(l.isEmpty())
1167 1168
                itr.remove();
        }
K
kohsuke 已提交
1169
    }
1170

K
kohsuke 已提交
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
    public NodeDescriptor getDescriptor() {
        return DescriptorImpl.INSTANCE;
    }

    public static final class DescriptorImpl extends NodeDescriptor {
        public static final DescriptorImpl INSTANCE = new DescriptorImpl();

        public String getDisplayName() {
            throw new UnsupportedOperationException();
        }

        // to route /descriptor/FQCN/xxx to getDescriptor(FQCN).xxx
        public Object getDynamic(String token, StaplerRequest req, StaplerResponse rsp) {
            return Hudson.getInstance().getDescriptor(token);
        }
1186 1187
    }

K
kohsuke 已提交
1188 1189 1190 1191 1192 1193 1194
    /**
     * Gets the system default quiet period.
     */
    public int getQuietPeriod() {
        return quietPeriod!=null ? quietPeriod : 5;
    }

K
kohsuke 已提交
1195 1196 1197 1198 1199
    /**
     * @deprecated
     *      Why are you calling a method that always returns ""?
     *      Perhaps you meant {@link #getRootUrl()}.
     */
K
kohsuke 已提交
1200 1201 1202 1203
    public String getUrl() {
        return "";
    }

1204 1205 1206 1207
    public String getSearchUrl() {
        return "";
    }

K
kohsuke 已提交
1208 1209 1210 1211
    public void onViewRenamed(View view, String oldName, String newName) {
        // implementation of Hudson is immune to view name change.
    }

1212
    @Override
1213 1214
    public SearchIndexBuilder makeSearchIndex() {
        return super.makeSearchIndex()
1215
            .add("configure", "config","configure")
K
kohsuke 已提交
1216
            .add("manage")
K
kohsuke 已提交
1217
            .add("log")
1218
            .add(getPrimaryView().makeSearchIndex())
K
kohsuke 已提交
1219 1220 1221
            .add(new CollectionSearchIndex() {// for computers
                protected Computer get(String key) { return getComputer(key); }
                protected Collection<Computer> all() { return computers.values(); }
K
kohsuke 已提交
1222
            })
K
kohsuke 已提交
1223
            .add(new CollectionSearchIndex() {// for users
K
kohsuke 已提交
1224
                protected User get(String key) { return User.get(key,false); }
K
kohsuke 已提交
1225
                protected Collection<User> all() { return User.getAll(); }
K
kohsuke 已提交
1226
            })
K
kohsuke 已提交
1227 1228
            .add(new CollectionSearchIndex() {// for views
                protected View get(String key) { return getView(key); }
1229
                protected Collection<View> all() { return views; }
K
kohsuke 已提交
1230
            });
1231 1232
    }

1233 1234 1235
    /**
     * Returns the primary {@link View} that renders the top-page of Hudson.
     */
1236
    @Exported
1237 1238 1239 1240 1241 1242 1243
    public View getPrimaryView() {
        View v = getView(primaryView);
        if(v==null) // fallback
            v = views.get(0);
        return v;
    }

1244 1245 1246 1247
    public String getUrlChildPrefix() {
        return "job";
    }

K
kohsuke 已提交
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
    /**
     * 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
K
kohsuke 已提交
1267
     * @see Descriptor#getCheckUrl(String)
K
renamed  
kohsuke 已提交
1268
     * @see #getRootUrlFromRequest()
K
kohsuke 已提交
1269 1270 1271
     */
    public String getRootUrl() {
        // for compatibility. the actual data is stored in Mailer
1272 1273 1274 1275
        String url = Mailer.DESCRIPTOR.getUrl();
        if(url!=null)   return url;

        StaplerRequest req = Stapler.getCurrentRequest();
K
kohsuke 已提交
1276
        if(req!=null)
K
renamed  
kohsuke 已提交
1277
            return getRootUrlFromRequest();
1278
        return null;
K
kohsuke 已提交
1279 1280
    }

K
kohsuke 已提交
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
    /**
     * Gets the absolute URL of Hudson top page, such as "http://localhost/hudson/".
     *
     * <p>
     * Unlike {@link #getRootUrl()}, which uses the manually configured value,
     * this one uses the current request to reconstruct the URL. The benefit is
     * that this is immune to the configuration mistake (users often fail to set the root URL
     * correctly, especially when a migration is involved), but the downside
     * is that unless you are processing a request, this method doesn't work.
     *
     * @since 1.263
     */
K
renamed  
kohsuke 已提交
1293
    public String getRootUrlFromRequest() {
K
kohsuke 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
        StaplerRequest req = Stapler.getCurrentRequest();
        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();
    }

K
kohsuke 已提交
1304 1305 1306 1307
    public File getRootDir() {
        return root;
    }

1308 1309 1310 1311
    public FilePath getWorkspaceFor(TopLevelItem item) {
        return new FilePath(new File(item.getRootDir(),"workspace"));
    }

K
kohsuke 已提交
1312 1313 1314 1315
    public FilePath getRootPath() {
        return new FilePath(getRootDir());
    }

1316 1317 1318 1319
    public FilePath createPath(String absolutePath) {
        return new FilePath((VirtualChannel)null,absolutePath);
    }

1320 1321
    public ClockDifference getClockDifference() {
        return ClockDifference.ZERO;
K
kohsuke 已提交
1322 1323
    }

1324 1325 1326 1327 1328 1329 1330 1331 1332
    /**
     * For binding {@link LogRecorderManager} to "/log".
     * Everything below here is admin-only, so do the check here.
     */
    public LogRecorderManager getLog() {
        checkPermission(ADMINISTER);
        return log;
    }

K
kohsuke 已提交
1333
    /**
1334 1335
     * A convenience method to check if there's some security
     * restrictions in place.
K
kohsuke 已提交
1336
     */
K
kohsuke 已提交
1337
    public boolean isUseSecurity() {
1338
        return securityRealm!=SecurityRealm.NO_AUTHENTICATION || authorizationStrategy!=AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1339 1340
    }

K
kohsuke 已提交
1341
    /**
1342 1343
     * Returns the constant that captures the three basic security modes
     * in Hudson.
K
kohsuke 已提交
1344
     */
1345 1346 1347 1348 1349 1350 1351 1352 1353
    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 已提交
1354 1355
    }

K
kohsuke 已提交
1356 1357 1358 1359 1360 1361 1362 1363
    /**
     * @return
     *      never null.
     */
    public SecurityRealm getSecurityRealm() {
        return securityRealm;
    }

1364
    public void setSecurityRealm(SecurityRealm securityRealm) {
1365 1366
        if(securityRealm==null)
            securityRealm= SecurityRealm.NO_AUTHENTICATION;
1367
        this.securityRealm = securityRealm;
1368 1369 1370 1371 1372 1373 1374
        // reset the filters and proxies for the new SecurityRealm
        try {
            HudsonFilter.get(servletContext).reset(securityRealm);
        } catch (ServletException e) {
            // for binary compatibility, this method cannot throw a checked exception
            throw new AcegiSecurityException("Failed to configure filter",e) {};
        }
1375
    }
1376

1377 1378 1379
    public Lifecycle getLifecycle() {
        return Lifecycle.get();
    }
1380

1381 1382 1383 1384 1385 1386 1387
    /**
     * Returns the root {@link ACL}.
     *
     * @see AuthorizationStrategy#getRootACL()
     */
    public ACL getACL() {
        return authorizationStrategy.getRootACL();
K
kohsuke 已提交
1388 1389
    }

1390 1391 1392 1393 1394 1395
    public void checkPermission(Permission p) {
        getACL().checkPermission(p);
    }

    public boolean hasPermission(Permission p) {
        return getACL().hasPermission(p);
1396 1397
    }

1398 1399 1400 1401 1402 1403
    /**
     * @return
     *      never null.
     */
    public AuthorizationStrategy getAuthorizationStrategy() {
        return authorizationStrategy;
K
kohsuke 已提交
1404 1405
    }

K
kohsuke 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
    /**
     * 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;
    }

1424 1425 1426 1427 1428
    public void setNumExecutors(int n) throws IOException {
        this.numExecutors = n;
        save();
    }

K
kohsuke 已提交
1429
    /**
1430 1431 1432
     * @deprecated
     *      Left only for the compatibility of URLs.
     *      Should not be invoked for any other purpose.
K
kohsuke 已提交
1433
     */
1434 1435
    public TopLevelItem getJob(String name) {
        return getItem(name);
K
kohsuke 已提交
1436 1437
    }

1438 1439 1440 1441 1442 1443
    /**
     * @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()) {
K
kohsuke 已提交
1444
            if(Functions.toEmailSafeString(e.getKey()).equalsIgnoreCase(Functions.toEmailSafeString(name)))
1445 1446 1447 1448 1449
                return e.getValue();
        }
        return null;
    }

K
kohsuke 已提交
1450 1451 1452 1453 1454
    /**
     * {@inheritDoc}.
     *
     * Note that the look up is case-insensitive.
     */
K
kohsuke 已提交
1455
    public TopLevelItem getItem(String name) {
1456 1457 1458
        return items.get(name);
    }

1459
    public File getRootDirFor(TopLevelItem child) {
1460 1461 1462 1463 1464
        return getRootDirFor(child.getName());
    }

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

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
    /**
     * 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 已提交
1496 1497 1498 1499
    public Item getItemByFullName(String fullName) {
        return getItemByFullName(fullName,Item.class);
    }

K
kohsuke 已提交
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
    /**
     * 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.
     */
1516
    public synchronized TopLevelItem createProject( TopLevelItemDescriptor type, String name ) throws IOException {
K
kohsuke 已提交
1517
        if(items.containsKey(name))
K
kohsuke 已提交
1518 1519
            throw new IllegalArgumentException();

K
kohsuke 已提交
1520
        TopLevelItem item;
K
kohsuke 已提交
1521
        try {
K
kohsuke 已提交
1522
            item = type.newInstance(name);
K
kohsuke 已提交
1523 1524 1525 1526
        } catch (Exception e) {
            throw new IllegalArgumentException(e);
        }

K
kohsuke 已提交
1527 1528 1529
        item.save();
        items.put(name,item);
        return item;
K
kohsuke 已提交
1530 1531 1532 1533 1534
    }

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

1539
        items.remove(item.getName());
1540 1541 1542
        for (View v : views)
            v.onJobRenamed(item, item.getName(), null);
        save();
K
kohsuke 已提交
1543 1544 1545 1546 1547 1548
    }

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

1553 1554 1555
        for (View v : views)
            v.onJobRenamed(job, oldName, newName);
        save();
K
kohsuke 已提交
1556 1557 1558 1559 1560 1561
    }

    public FingerprintMap getFingerprintMap() {
        return fingerprintMap;
    }

K
kohsuke 已提交
1562
    // if no finger print matches, display "not found page".
K
kohsuke 已提交
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
    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() {
1589
        return mode;
K
kohsuke 已提交
1590 1591
    }

1592 1593 1594 1595
    public String getLabelString() {
        return Util.fixNull(label).trim();
    }

1596
    public Set<Label> getAssignedLabels() {
1597 1598
        Set<Label> lset = labelSet; // labelSet may be set by another thread while we are in this method, so capture it.
        if (lset == null) {
1599
            Set<Label> r = new HashSet<Label>();
1600 1601 1602 1603
            String ls = getLabelString();
            if(ls.length()>0)
                for( String l : ls.split(" +"))
                    r.add(Hudson.getInstance().getLabel(l));
1604 1605
            r.addAll(getDynamicLabels());
            r.add(getSelfLabel());
1606
            this.labelSet = lset = Collections.unmodifiableSet(r);
1607
        }
1608
        return lset;
1609 1610 1611 1612 1613 1614 1615 1616 1617
    }

    /**
     * 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) {
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
            // in the worst cast, two threads end up doing the same computation twice,
            // but that won't break the semantics.
            // OTOH, not locking prevents dead-lock. See #1390
            Set<Label> r = new HashSet<Label>();
            Computer comp = getComputer("");
            if (comp != null) {
                VirtualChannel channel = comp.getChannel();
                if (channel != null) {
                    for (DynamicLabeler labeler : LabelFinder.LABELERS) {
                        for (String label : labeler.findLabels(channel)) {
                            r.add(getLabel(label));
1629 1630 1631 1632
                        }
                    }
                }
            }
1633
            dynamicLabels = r;
1634 1635
        }
        return dynamicLabels;
1636 1637 1638 1639 1640 1641
    }

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

K
kohsuke 已提交
1642 1643 1644 1645
    public Computer createComputer() {
        return new MasterComputer();
    }

K
kohsuke 已提交
1646
    private synchronized void load() throws IOException {
1647
        long startTime = System.currentTimeMillis();
K
kohsuke 已提交
1648
        XmlFile cfg = getConfigFile();
1649 1650 1651 1652
        if(cfg.exists()) {
            // reset some data that may not exit in the disk file
            // so that we can take a proper compensation action later.
            primaryView = null;
1653
            views.clear();
K
kohsuke 已提交
1654
            cfg.unmarshal(this);
1655
        }
K
kohsuke 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664

        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) {
1665
                return child.isDirectory() && Items.getConfigFile(child).exists();
K
kohsuke 已提交
1666 1667
            }
        });
1668
        items.clear();
1669
        if(PARALLEL_LOAD) {
1670
            // load jobs in parallel for better performance
1671
            LOGGER.info("Loading in "+TWICE_CPU_NUM+" parallel threads");
1672 1673 1674 1675
            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 {
1676 1677
                        long start = System.currentTimeMillis();
                        TopLevelItem item = (TopLevelItem) Items.load(Hudson.this, subdir);
1678 1679
                        if(LOG_STARTUP_PERFORMANCE)
                            LOGGER.info("Loaded "+item.getName()+" in "+(System.currentTimeMillis()-start)+"ms by "+Thread.currentThread().getName());
1680
                        return item;
1681 1682 1683 1684 1685 1686 1687 1688 1689
                    }
                }));
            }

            for (Future<TopLevelItem> loader : loaders) {
                try {
                    TopLevelItem item = loader.get();
                    items.put(item.getName(), item);
                } catch (ExecutionException e) {
K
typo  
kohsuke 已提交
1690
                    LOGGER.log(Level.WARNING, "Failed to load a project",e.getCause());
1691 1692 1693 1694 1695 1696 1697
                } catch (InterruptedException e) {
                    e.printStackTrace(); // this is probably not the right thing to do
                }
            }
        } else {
            for (File subdir : subdirs) {
                try {
1698
                    long start = System.currentTimeMillis();
1699
                    TopLevelItem item = (TopLevelItem)Items.load(this,subdir);
1700 1701
                    if(LOG_STARTUP_PERFORMANCE)
                        LOGGER.info("Loaded "+item.getName()+" in "+(System.currentTimeMillis()-start)+"ms");
1702 1703 1704
                    items.put(item.getName(), item);
                } catch (Error e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
1705 1706
                } catch (RuntimeException e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
1707 1708 1709
                } catch (IOException e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
                }
K
kohsuke 已提交
1710 1711
            }
        }
1712
        rebuildDependencyGraph();
1713 1714

        // recompute label objects
1715
        if (null != slaves) { // only if we have slaves
K
kohsuke 已提交
1716
            for (Node slave : slaves)
1717 1718
                slave.getAssignedLabels();
        }
K
kohsuke 已提交
1719

1720 1721 1722 1723 1724 1725 1726 1727 1728
        // initialize views by inserting the default view if necessary
        // this is both for clean Hudson and for backward compatibility.
        if(views.size()==0 || primaryView==null) {
            View v = new AllView(Messages.Hudson_ViewName());
            v.owner = this;
            views.add(0,v);
            primaryView = v.getViewName();
        }

K
typo.  
kohsuke 已提交
1729
        // read in old data that doesn't have the security field set
1730 1731 1732 1733 1734 1735 1736 1737
        if(authorizationStrategy==null) {
            if(useSecurity==null || !useSecurity)
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
            else
                authorizationStrategy = new LegacyAuthorizationStrategy();
        }
        if(securityRealm==null) {
            if(useSecurity==null || !useSecurity)
1738
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1739
            else
1740 1741 1742 1743
                setSecurityRealm(new LegacySecurityRealm());
        } else {
            // force the set to proxy
            setSecurityRealm(securityRealm);
1744
        }
1745

K
kohsuke 已提交
1746 1747 1748 1749
        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;
1750
            setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
K
kohsuke 已提交
1751
        }
1752

1753
        LOGGER.info(String.format("Took %s ms to load",System.currentTimeMillis()-startTime));
1754 1755
        if(KILL_AFTER_LOAD)
            System.exit(0);
K
kohsuke 已提交
1756 1757 1758 1759 1760 1761
    }

    /**
     * Save the settings to a file.
     */
    public synchronized void save() throws IOException {
1762
        if(BulkChange.contains(this))   return;
K
kohsuke 已提交
1763 1764 1765 1766 1767 1768 1769 1770
        getConfigFile().write(this);
    }


    /**
     * Called to shut down the system.
     */
    public void cleanUp() {
K
kohsuke 已提交
1771
        Set<Future<?>> pending = new HashSet<Future<?>>();
K
kohsuke 已提交
1772
        terminating = true;
1773 1774 1775
        for( Computer c : computers.values() ) {
            c.interrupt();
            c.kill();
K
kohsuke 已提交
1776
            pending.add(c.disconnect());
K
kohsuke 已提交
1777 1778 1779
        }
        ExternalJob.reloadThread.interrupt();
        Trigger.timer.cancel();
K
kohsuke 已提交
1780
        // TODO: how to wait for the completion of the last job?
K
kohsuke 已提交
1781
        Trigger.timer = null;
1782 1783
        if(tcpSlaveAgentListener!=null)
            tcpSlaveAgentListener.shutdown();
K
kohsuke 已提交
1784 1785 1786 1787

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

1788 1789 1790 1791
        if(getRootDir().exists())
            // if we are aborting because we failed to create HUDSON_HOME,
            // don't try to save. Issue #536
            getQueue().save();
1792 1793

        threadPoolForLoad.shutdown();
K
kohsuke 已提交
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
        for (Future<?> f : pending)
            try {
                f.get(10, TimeUnit.SECONDS);    // if clean up operation didn't complete in time, we fail the test
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
                break;  // someone wants us to die now. quick!
            } catch (ExecutionException e) {
                LOGGER.log(Level.WARNING, "Failed to shut down properly",e);
            } catch (TimeoutException e) {
                LOGGER.log(Level.WARNING, "Failed to shut down properly",e);
            }

K
kohsuke 已提交
1806
        LogFactory.releaseAll();
1807 1808

        theInstance = null;
K
kohsuke 已提交
1809 1810
    }

K
kohsuke 已提交
1811 1812 1813 1814
    public Object getDynamic(String token, StaplerRequest req, StaplerResponse rsp) {
        for (Action a : getActions())
            if(a.getUrlName().equals(token))
                return a;
1815 1816 1817
        for (Action a : getManagementLinks())
            if(a.getUrlName().equals(token))
                return a;
K
kohsuke 已提交
1818 1819
        return null;
    }
K
kohsuke 已提交
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830


//
//
// actions
//
//
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
K
kohsuke 已提交
1831
        BulkChange bc = new BulkChange(this);
K
kohsuke 已提交
1832
        try {
K
kohsuke 已提交
1833
            checkPermission(ADMINISTER);
K
kohsuke 已提交
1834 1835 1836

            req.setCharacterEncoding("UTF-8");

1837
            JSONObject json = req.getSubmittedForm();
1838

1839 1840 1841
            // keep using 'useSecurity' field as the main configuration setting
            // until we get the new security implementation working
            // useSecurity = null;
1842
            if (json.has("use_security")) {
K
kohsuke 已提交
1843
                useSecurity = true;
K
kohsuke 已提交
1844 1845 1846
                JSONObject security = json.getJSONObject("use_security");
                setSecurityRealm(SecurityRealm.LIST.newInstanceFromRadioList(security,"realm"));
                authorizationStrategy = AuthorizationStrategy.LIST.newInstanceFromRadioList(security,"authorization");
1847 1848
                if(authorizationStrategy==null)
                    authorizationStrategy = AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1849
            } else {
1850
                useSecurity = null;
1851
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1852
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1853
            }
K
kohsuke 已提交
1854

1855 1856
            noUsageStatistics = json.has("usageStatisticsCollected") ? null : true;

1857 1858
            {
                String v = req.getParameter("slaveAgentPortType");
1859
                if(!isUseSecurity() || v==null || v.equals("random"))
1860 1861 1862 1863 1864 1865 1866 1867
                    slaveAgentPort = 0;
                else
                if(v.equals("disable"))
                    slaveAgentPort = -1;
                else {
                    try {
                        slaveAgentPort = Integer.parseInt(req.getParameter("slaveAgentPort"));
                    } catch (NumberFormatException e) {
K
i18n  
kohsuke 已提交
1868
                        throw new FormException(Messages.Hudson_BadPortNumber(req.getParameter("slaveAgentPort")),"slaveAgentPort");
1869 1870
                    }
                }
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883

                // 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);
                    }
                }
1884 1885
            }

K
kohsuke 已提交
1886 1887 1888 1889 1890 1891
            numExecutors = Integer.parseInt(req.getParameter("numExecutors"));
            if(req.hasParameter("master.mode"))
                mode = Mode.valueOf(req.getParameter("master.mode"));
            else
                mode = Mode.NORMAL;

1892 1893 1894
            label = Util.fixNull(req.getParameter("label"));
            labelSet=null;

K
kohsuke 已提交
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
            quietPeriod = Integer.parseInt(req.getParameter("quiet_period"));

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

            {// 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 )
1914
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1915 1916

            for( Descriptor<Publisher> d : BuildStep.PUBLISHERS )
1917
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1918

K
kohsuke 已提交
1919
            for( Descriptor<BuildWrapper> d : BuildWrappers.WRAPPERS )
K
kohsuke 已提交
1920
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1921

1922
            for( SCMDescriptor scmd : SCMS.SCMS )
K
kohsuke 已提交
1923
                result &= configureDescriptor(req,json,scmd);
K
kohsuke 已提交
1924

1925
            for( TriggerDescriptor d : Triggers.TRIGGERS )
K
kohsuke 已提交
1926
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1927

1928
            for( JobPropertyDescriptor d : Jobs.PROPERTIES )
K
kohsuke 已提交
1929
                result &= configureDescriptor(req,json,d);
1930

1931 1932 1933
            for( PageDecorator d : PageDecorator.ALL )
                result &= configureDescriptor(req,json,d);

1934 1935 1936
            for( JSONObject o : StructuredForm.toList(json,"plugin"))
                pluginManager.getPlugin(o.getString("name")).getPlugin().configure(o);

K
kohsuke 已提交
1937 1938
            clouds.rebuildHetero(req,json, Cloud.ALL, "cloud");

K
kohsuke 已提交
1939 1940
            save();
            if(result)
1941
                rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
K
kohsuke 已提交
1942 1943 1944 1945
            else
                rsp.sendRedirect("configure"); // back to config
        } catch (FormException e) {
            sendError(e,req,rsp);
K
kohsuke 已提交
1946 1947
        } finally {
            bc.commit();
K
kohsuke 已提交
1948 1949 1950
        }
    }

1951 1952 1953 1954 1955
    public synchronized void doTestPost( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        JSONObject form = req.getSubmittedForm();
        rsp.sendRedirect("foo");
    }

1956
    private boolean configureDescriptor(StaplerRequest req, JSONObject json, Descriptor<?> d) throws FormException {
1957 1958 1959
        // collapse the structure to remain backward compatible with the JSON structure before 1.
        String name = d.getJsonSafeClassName();
        JSONObject js = json.has(name) ? json.getJSONObject(name) : new JSONObject(); // if it doesn't have the property, the method returns invalid null object.
1960 1961 1962 1963
        json.putAll(js);
        return d.configure(req, js);
    }

1964 1965 1966 1967
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigExecutorsSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1968
        checkPermission(ADMINISTER);
1969

1970 1971 1972
        BulkChange bc = new BulkChange(this);
        try {
            JSONObject json = req.getSubmittedForm();
1973

1974
            setNumExecutors(Integer.parseInt(req.getParameter("numExecutors")));
1975 1976 1977 1978
            if(req.hasParameter("master.mode"))
                mode = Mode.valueOf(req.getParameter("master.mode"));
            else
                mode = Mode.NORMAL;
S
stephenconnolly 已提交
1979

1980 1981 1982 1983
            setSlaves(req.bindJSONToList(Slave.class,json.get("slaves")));
        } finally {
            bc.commit();
        }
S
stephenconnolly 已提交
1984

1985
        rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
1986 1987
    }

K
kohsuke 已提交
1988 1989 1990 1991
    /**
     * Accepts the new description.
     */
    public synchronized void doSubmitDescription( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1992
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1993 1994 1995 1996 1997 1998 1999

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

2000
    public synchronized void doQuietDown(StaplerResponse rsp) throws IOException, ServletException {
K
kohsuke 已提交
2001
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2002 2003 2004 2005
        isQuietingDown = true;
        rsp.sendRedirect2(".");
    }

2006
    public synchronized void doCancelQuietDown(StaplerResponse rsp) throws IOException, ServletException {
K
kohsuke 已提交
2007
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2008 2009 2010 2011 2012
        isQuietingDown = false;
        getQueue().scheduleMaintenance();
        rsp.sendRedirect2(".");
    }

2013 2014 2015
    /**
     * Backward compatibility. Redirect to the thread dump.
     */
2016
    public void doClassicThreadDump(StaplerResponse rsp) throws IOException, ServletException {
2017 2018 2019
        rsp.sendRedirect2("threadDump");
    }

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

2023 2024
        TopLevelItem result;

K
kohsuke 已提交
2025 2026 2027 2028 2029 2030
        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");
2031 2032 2033 2034 2035 2036 2037
        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");
        }
2038 2039

        String name = req.getParameter("name");
K
typo.  
kohsuke 已提交
2040
        if(name==null) {
2041 2042 2043 2044
            rsp.sendError(HttpServletResponse.SC_BAD_REQUEST,"Query parameter 'name' is required");
            return null;
        }
        name = name.trim();
K
kohsuke 已提交
2045 2046 2047 2048 2049
        String mode = req.getParameter("mode");

        try {
            checkGoodName(name);
        } catch (ParseException e) {
K
kohsuke 已提交
2050
            rsp.setStatus(SC_BAD_REQUEST);
K
kohsuke 已提交
2051 2052 2053 2054
            sendError(e,req,rsp);
            return null;
        }

2055
        if(getItem(name)!=null) {
K
kohsuke 已提交
2056
            rsp.setStatus(SC_BAD_REQUEST);
K
i18n  
kohsuke 已提交
2057
            sendError(Messages.Hudson_JobAlreadyExists(name),req,rsp);
K
kohsuke 已提交
2058 2059 2060
            return null;
        }

K
kohsuke 已提交
2061
        if(mode!=null && mode.equals("copy")) {
2062 2063
            String from = req.getParameter("from");
            TopLevelItem src = getItem(from);
K
kohsuke 已提交
2064
            if(src==null) {
2065 2066 2067 2068 2069
                rsp.setStatus(SC_BAD_REQUEST);
                if(Util.fixEmpty(from)==null)
                    sendError("Specify which job to copy",req,rsp);
                else
                    sendError("No such job: "+from,req,rsp);
K
kohsuke 已提交
2070 2071 2072
                return null;
            }

K
kohsuke 已提交
2073
            result = copy(src,name);
2074
        } else {
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
            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 已提交
2100
                    rsp.sendError(SC_BAD_REQUEST);
2101 2102 2103 2104
                    return null;
                }
                result = createProject(Items.getDescriptor(mode), name);
            }
K
kohsuke 已提交
2105

K
kohsuke 已提交
2106 2107 2108
            for (ItemListener l : itemListeners)
                l.onCreated(result);
        }
2109

2110 2111 2112 2113 2114
        if(isXmlSubmission) {
            // it worked
            rsp.setStatus(HttpServletResponse.SC_OK);
        } else {
            // send the browser to the config page
2115
            rsp.sendRedirect2(result.getUrl()+"configure");
2116 2117
        }

K
kohsuke 已提交
2118 2119 2120
        return result;
    }

K
kohsuke 已提交
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
    /**
     * Copys a job.
     *
     * @param src
     *      A {@link TopLevelItem} to be copied.
     * @param name
     *      Name of the newly created project.
     * @return
     *      Newly created {@link TopLevelItem}.
     */
    @SuppressWarnings({"unchecked"})
    public <T extends TopLevelItem> T copy(T src, String name) throws IOException {
        T result = (T)createProject(src.getDescriptor(),name);

        // copy config
        Util.copyFile(Items.getConfigFile(src).getFile(),Items.getConfigFile(result).getFile());

        // reload from the new config
        result = (T)Items.load(this,result.getRootDir());
        result.onCopiedFrom(src);
        items.put(name,result);

        for (ItemListener l : itemListeners)
            l.onCreated(result);

        return result;
    }

    // a little more convenient overloading that assumes the caller gives us the right type
    // (or else it will fail with ClassCastException)
    public <T extends AbstractProject<?,?>> T copy(T src, String name) throws IOException {
        return (T)copy((TopLevelItem)src,name);
    }

K
kohsuke 已提交
2155
    public synchronized void doCreateView( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2156 2157
        try {
            checkPermission(View.CREATE);
K
kohsuke 已提交
2158
            views.add(View.create(req,rsp, this));
2159
            save();
K
kohsuke 已提交
2160 2161
        } catch (ParseException e) {
            sendError(e,req,rsp);
2162 2163 2164
        } catch (FormException e) {
            sendError(e,req,rsp);
        }
K
kohsuke 已提交
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175
    }

    /**
     * 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)
K
i18n  
kohsuke 已提交
2176
            throw new ParseException(Messages.Hudson_NoName(),0);
K
kohsuke 已提交
2177 2178 2179

        for( int i=0; i<name.length(); i++ ) {
            char ch = name.charAt(i);
2180 2181 2182
            if(Character.isISOControl(ch)) {
                throw new ParseException(Messages.Hudson_ControlCodeNotAllowed(toPrintableName(name)),i);
            }
K
kohsuke 已提交
2183
            if("?*/\\%!@#$^&|<>[]:;".indexOf(ch)!=-1)
K
i18n  
kohsuke 已提交
2184
                throw new ParseException(Messages.Hudson_UnsafeChar(ch),i);
K
kohsuke 已提交
2185 2186 2187 2188 2189
        }

        // looks good
    }

2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
    private static String toPrintableName(String name) {
        StringBuffer printableName = new StringBuffer();
        for( int i=0; i<name.length(); i++ ) {
            char ch = name.charAt(i);
            if(Character.isISOControl(ch))
                printableName.append("\\u").append((int)ch).append(';');
            else
                printableName.append(ch);
        }
        return printableName.toString();
    }

2202
    /**
2203 2204 2205
     * Checks if the user was successfully authenticated.
     *
     * @see BasicAuthenticationFilter
2206 2207
     */
    public void doSecured( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2208 2209
        if(req.getUserPrincipal()==null) {
            // authentication must have failed
2210 2211 2212 2213
            rsp.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

2214
        // the user is now authenticated, so send him back to the target
2215 2216 2217
        String path = req.getContextPath()+req.getRestOfPath();
        String q = req.getQueryString();
        if(q!=null)
2218
            path += '?'+q;
2219

2220
        rsp.sendRedirect2(path);
2221 2222
    }

K
kohsuke 已提交
2223 2224 2225
    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
2226
    public void doLoginEntry( StaplerRequest req, StaplerResponse rsp ) throws IOException {
2227 2228
        if(req.getUserPrincipal()==null)
            rsp.sendRedirect2("noPrincipal");
2229 2230

        String from = req.getParameter("from");
2231
        if(from!=null && from.startsWith("/") && !from.equals("/loginError")) {
2232
            rsp.sendRedirect2(from);    // I'm bit uncomfortable letting users redircted to other sites, make sure the URL falls into this domain
2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
            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 已提交
2245 2246 2247 2248 2249
    }

    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
2250
    public void doLogout( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
2251 2252 2253
        HttpSession session = req.getSession(false);
        if(session!=null)
            session.invalidate();
2254
        SecurityContextHolder.clearContext();
2255 2256 2257 2258 2259 2260

        // reset remember-me cookie
        Cookie cookie = new Cookie(ACEGI_SECURITY_HASHED_REMEMBER_ME_COOKIE_KEY,"");
        cookie.setPath(req.getContextPath().length()>0 ? req.getContextPath() : "/");
        rsp.addCookie(cookie);

K
kohsuke 已提交
2261 2262 2263
        rsp.sendRedirect2(req.getContextPath()+"/");
    }

2264 2265 2266 2267 2268 2269 2270
    /**
     * Serves jar files for JNLP slave agents.
     */
    public Slave.JnlpJar getJnlpJars(String fileName) {
        return new Slave.JnlpJar(fileName);
    }

K
kohsuke 已提交
2271 2272
    /**
     * RSS feed for log entries.
2273 2274 2275
     *
     * @deprecated
     *   As on 1.267, moved to "/log/rss..."
K
kohsuke 已提交
2276 2277
     */
    public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2278 2279
        String qs = req.getQueryString();
        rsp.sendRedirect2("./log/rss"+(qs==null?"":'?'+qs));
K
kohsuke 已提交
2280 2281
    }

K
kohsuke 已提交
2282 2283 2284 2285
    /**
     * Reloads the configuration.
     */
    public synchronized void doReload( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
2286
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2287

2288 2289 2290 2291
        // 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 已提交
2292
        rsp.sendRedirect2(req.getContextPath()+"/");
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304

        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 已提交
2305 2306 2307 2308 2309 2310
    }

    /**
     * Do a finger-print check.
     */
    public void doDoFingerprintCheck( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2311 2312
        // Parse the request
        MultipartFormDataParser p = new MultipartFormDataParser(req);
K
kohsuke 已提交
2313 2314
        try {
            rsp.sendRedirect2(req.getContextPath()+"/fingerprint/"+
2315 2316 2317
                Util.getDigestOf(p.getFileItem("name").getInputStream())+'/');
        } finally {
            p.cleanUp();
K
kohsuke 已提交
2318 2319 2320 2321 2322 2323 2324
        }
    }

    /**
     * Serves static resources without the "Last-Modified" header to work around
     * a bug in Firefox.
     *
K
kohsuke 已提交
2325 2326
     * <p>
     * See https://bugzilla.mozilla.org/show_bug.cgi?id=89419
K
kohsuke 已提交
2327 2328 2329 2330 2331 2332 2333 2334 2335
     */
    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 已提交
2336
            rsp.sendError(SC_BAD_REQUEST);
K
kohsuke 已提交
2337 2338 2339 2340 2341
            return;
        }

        File f = new File(req.getServletContext().getRealPath("/images"),path.substring(1));
        if(!f.exists()) {
2342
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
            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 已提交
2357
        Util.copyStream(in,rsp.getOutputStream());
K
kohsuke 已提交
2358 2359 2360 2361
        in.close();
    }

    /**
K
kohsuke 已提交
2362
     * For debugging. Expose URL to perform GC.
K
kohsuke 已提交
2363
     */
2364
    public void doGc(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2365 2366 2367 2368 2369 2370
        System.gc();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("GCed");
    }

K
kohsuke 已提交
2371 2372 2373 2374
    /**
     * Perform a restart of Hudson, if we can.
     */
    public void doRestart(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
2375
        requirePOST();
K
kohsuke 已提交
2376 2377 2378 2379 2380 2381 2382
        checkPermission(ADMINISTER);
        try {
            Lifecycle.get().restart();
            servletContext.setAttribute("app",new HudsonIsRestarting());
            rsp.sendRedirect2(".");
        } catch (UnsupportedOperationException e) {
            sendError("Restart is not supported in this running mode.",req,rsp);
2383 2384 2385 2386
        } catch (IOException e) {
            sendError(e,req,rsp);
        } catch (InterruptedException e) {
            sendError(e,req,rsp);
K
kohsuke 已提交
2387 2388 2389
        }
    }

K
kohsuke 已提交
2390 2391 2392 2393 2394
    /**
     * Shutdown the system.
     * @since 1.161
     */
    public void doExit( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
2395
        checkPermission(ADMINISTER);
2396
        LOGGER.severe(String.format("Shutting down VM as requested by %s from %s",
K
kohsuke 已提交
2397
                getAuthentication(), req.getRemoteAddr()));
K
kohsuke 已提交
2398 2399 2400 2401 2402
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        PrintWriter w = rsp.getWriter();
        w.println("Shutting down");
        w.close();
2403

K
kohsuke 已提交
2404 2405 2406
        System.exit(0);
    }

K
kohsuke 已提交
2407 2408 2409 2410 2411
    /**
     * Gets the {@link Authentication} object that represents the user
     * associated with the current request.
     */
    public static Authentication getAuthentication() {
K
kohsuke 已提交
2412 2413 2414 2415 2416
        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 已提交
2417 2418
        if(a==null)
            a = new AnonymousAuthenticationToken("anonymous","anonymous",new GrantedAuthority[]{new GrantedAuthorityImpl("anonymous")});
K
kohsuke 已提交
2419
        return a;
K
kohsuke 已提交
2420 2421
    }

K
kohsuke 已提交
2422 2423
    /**
     * For system diagnostics.
K
kohsuke 已提交
2424
     * Run arbitrary Groovy script.
K
kohsuke 已提交
2425
     */
2426 2427 2428
    public void doScript(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        doScript(req, rsp, req.getView(this, "_script.jelly"));
    }
2429

2430 2431 2432 2433 2434 2435 2436 2437
    /**
     * Run arbitrary Groovy script and return result as plain text.
     */
    public void doScriptText(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        doScript(req, rsp, req.getView(this, "_scriptText.jelly"));
    }

    private void doScript(StaplerRequest req, StaplerResponse rsp, RequestDispatcher view) throws IOException, ServletException {
2438 2439
        // ability to run arbitrary script is dangerous
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2440 2441

        String text = req.getParameter("script");
2442
        if (text != null) {
K
kohsuke 已提交
2443
            try {
2444
                req.setAttribute("output",
2445
                        RemotingDiagnostics.executeGroovy(text, MasterComputer.localChannel));
2446 2447
            } catch (InterruptedException e) {
                throw new ServletException(e);
K
kohsuke 已提交
2448 2449 2450
            }
        }

2451
        view.forward(req, rsp);
K
kohsuke 已提交
2452 2453
    }

2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
    /**
     * Evaluates the Jelly script submitted by the client.
     *
     * This is useful for system administration as well as unit testing.
     */
    public void doEval(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        checkPermission(ADMINISTER);
        requirePOST();

        try {
            MetaClass mc = WebApp.getCurrent().getMetaClass(getClass());
            Script script = mc.classLoader.loadTearOff(JellyClassLoaderTearOff.class).createContext().compileScript(new InputSource(req.getReader()));
            new JellyRequestDispatcher(this,script).forward(req,rsp);
        } catch (JellyException e) {
            throw new ServletException(e);
        }
    }

K
kohsuke 已提交
2472 2473 2474 2475 2476 2477 2478
    /**
     * 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 已提交
2479 2480 2481
    /**
     * Changes the icon size by changing the cookie
     */
K
kohsuke 已提交
2482 2483
    public void doIconSize( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        String qs = req.getQueryString();
J
jglick 已提交
2484
        if(qs==null || !ICON_SIZE.matcher(qs).matches())
K
kohsuke 已提交
2485
            throw new ServletException();
2486 2487 2488
        Cookie cookie = new Cookie("iconSize", qs);
        cookie.setMaxAge(/* ~4 mo. */9999999); // #762
        rsp.addCookie(cookie);
K
kohsuke 已提交
2489 2490 2491
        String ref = req.getHeader("Referer");
        if(ref==null)   ref=".";
        rsp.sendRedirect2(ref);
K
kohsuke 已提交
2492 2493
    }

2494
    public void doFingerprintCleanup(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2495 2496 2497 2498 2499 2500
        FingerprintCleanupThread.invoke();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("Invoked");
    }

2501
    public void doWorkspaceCleanup(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
        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
K
i18n  
kohsuke 已提交
2513
        new FormFieldValidator.WorkspaceDirectory(req,rsp,true).process();
K
kohsuke 已提交
2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
    }

    /**
     * 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()) {
K
i18n  
kohsuke 已提交
2525
                    error(Messages.Hudson_NotADirectory(f));
K
kohsuke 已提交
2526 2527 2528 2529
                    return;
                }

                File toolsJar = new File(f,"lib/tools.jar");
2530
                File mac = new File(f,"lib/dt.jar");
K
kohsuke 已提交
2531
                if(!toolsJar.exists() && !mac.exists()) {
K
i18n  
kohsuke 已提交
2532
                    error(Messages.Hudson_NotJDKDir(f));
K
kohsuke 已提交
2533 2534 2535 2536 2537 2538 2539 2540
                    return;
                }

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

K
kohsuke 已提交
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
    /**
     * 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
K
i18n  
kohsuke 已提交
2557
                        errorWithMarkup(Messages.Hudson_NoJavaInPath(request.getContextPath()));
K
kohsuke 已提交
2558 2559 2560 2561 2562
                }
            }
        }.process();
    }

K
kohsuke 已提交
2563 2564 2565 2566 2567 2568
    /**
     * 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.
2569
        new FormFieldValidator(req,rsp,Item.CREATE) {
K
kohsuke 已提交
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
            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
K
i18n  
kohsuke 已提交
2580
                    error(Messages.Hudson_JobAlreadyExists(job));
K
kohsuke 已提交
2581 2582 2583
            }
        }.process();
    }
2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605

    /**
     * Checks if a top-level view with the given name exists.
     */
    public void doViewExistsCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        new FormFieldValidator(req,rsp,View.CREATE) {
            protected void check() throws IOException, ServletException {
                String view = fixEmpty(request.getParameter("value"));
                if(view==null) {
                    ok(); // nothing is entered yet
                    return;
                }

                if(getView(view)==null)
                    ok();
                else
                    error(Messages.Hudson_ViewAlreadyExists(view));
            }
        }.process();
    }


2606 2607 2608 2609 2610
    /**
     * Checks if the value for a field is set; if not an error or warning text is displayed.
     * If the parameter "value" is not set then the parameter "errorText" is displayed
     * as an error text. If the parameter "errorText" is not set, then the parameter "warningText" is
     * displayed as a warning text.
2611
     * <p/>
2612 2613 2614 2615 2616 2617 2618 2619 2620
     * If the text is set and the parameter "type" is set, it will validate that the value is of the
     * correct type. Supported types are "number, "number-positive" and "number-negative".
     * @param req containing the parameter value and the errorText to display if the value isnt set
     * @param rsp used by FormFieldValidator
     * @throws IOException thrown by FormFieldValidator.check()
     * @throws ServletException thrown by FormFieldValidator.check()
     */
    public void doFieldCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        new FormFieldValidator(req, rsp, false) {
2621

2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
            /**
             * Display the error text or warning text.
             */
            private void fieldCheckFailed() throws IOException, ServletException {
                String v = fixEmpty(request.getParameter("errorText"));
                if (v != null) {
                    error(v);
                    return;
                }
                v = fixEmpty(request.getParameter("warningText"));
                if (v != null) {
                    warning(v);
                    return;
                }
                error("No error or warning text was set for fieldCheck().");
            }
2638

2639 2640 2641 2642 2643 2644 2645 2646 2647
            /**
             * Checks if the value is of the correct type.
             * @param type the type of string
             * @param value the actual value to check
             * @return true, if the type was valid; false otherwise
             */
            private boolean checkType(String type, String value) throws IOException, ServletException {
                try {
                    if (type.equalsIgnoreCase("number")) {
2648
                        NumberFormat.getInstance().parse(value);
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665
                    } else if (type.equalsIgnoreCase("number-positive")) {
                        if (NumberFormat.getInstance().parse(value).floatValue() <= 0) {
                            error(Messages.Hudson_NotAPositiveNumber());
                            return false;
                        }
                    } else if (type.equalsIgnoreCase("number-negative")) {
                        if (NumberFormat.getInstance().parse(value).floatValue() >= 0) {
                            error(Messages.Hudson_NotANegativeNumber());
                            return false;
                        }
                    }
                } catch (ParseException e) {
                    error(Messages.Hudson_NotANumber());
                    return false;
                }
                return true;
            }
2666

2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683
            @Override
            protected void check() throws IOException, ServletException {
                String value = fixEmpty(request.getParameter("value"));
                if (value == null) {
                    fieldCheckFailed();
                    return;
                }
                String type = fixEmpty(request.getParameter("type"));
                if (type != null) {
                    if (!checkType(type, value)) {
                        return;
                    }
                }
                ok();
            }
        }.process();
    }
K
kohsuke 已提交
2684

K
kohsuke 已提交
2685 2686 2687 2688 2689
    /**
     * Performs syntactical check on the remote FS for slaves.
     *
     * TODO: find a better home for this method.
     */
2690
    public void doRemoteFSCheck(StaplerRequest req, StaplerResponse rsp, @QueryParameter final String value) throws IOException, ServletException {
K
kohsuke 已提交
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708
        new FormFieldValidator(req,rsp,false) {
            protected void check() throws IOException, ServletException {
                if(Util.fixEmptyAndTrim(value)==null) {
                    error("Remote directory is mandatory");
                    return;
                }

                if(value.startsWith("\\\\") || value.startsWith("/net/")) {
                    warning("Are you sure you want to use network mounted file system for FS root? " +
                            "Note that this directory needs not be visible to the master.");
                    return;
                }

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

2709 2710 2711 2712 2713 2714 2715 2716
    /**
     * 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.
     */
2717
    public void doResources(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
2718
        String path = req.getRestOfPath();
2719 2720 2721 2722 2723 2724
        // 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);

2725 2726 2727
        int idx = path.lastIndexOf('.');
        String extension = path.substring(idx+1);
        if(ALLOWED_RESOURCE_EXTENSIONS.contains(extension)) {
2728 2729 2730 2731
            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);
2732 2733 2734 2735 2736 2737
                return;
            }
        }
        rsp.sendError(HttpServletResponse.SC_NOT_FOUND);
    }

S
sogabe 已提交
2738 2739 2740 2741 2742 2743 2744 2745
    /**
     * 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(
        "js|css|jpeg|jpg|png|gif|html|htm".split("\\|")
    ));

2746 2747 2748
    /**
     * Checks if container uses UTF-8 to decode URLs. See
     * http://hudson.gotdns.com/wiki/display/HUDSON/Tomcat#Tomcat-i18n
S
sogabe 已提交
2749
     *
2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770
     * @param req containing the parameter value
     * @param rsp used by FormFieldValidator
     * @throws IOException thrown by FormFieldValidator.check()
     * @throws ServletException thrown by FormFieldValidator.check()
     */
    public void doCheckURIEncoding(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        new FormFieldValidator(req, rsp, true) {
            @Override
            protected void check() throws IOException, ServletException {
                request.setCharacterEncoding("UTF-8");
                // expected is non-ASCII String
                final String expected = "\u57f7\u4e8b";
                final String value = fixEmpty(request.getParameter("value"));
                if (!expected.equals(value)) {
                    warningWithMarkup(Messages.Hudson_NotUsesUTF8ToDecodeURL());
                    return;
                }
                ok();
            }
        }.process();
    }
S
sogabe 已提交
2771

2772 2773 2774 2775 2776 2777
    /**
     * Does not check when system default encoding is "ISO-8859-1".
     */
    public static boolean isCheckURIEncodingEnabled() {
        return !"ISO-8859-1".equalsIgnoreCase(System.getProperty("file.encoding"));
    }
K
kohsuke 已提交
2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792

    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 已提交
2793
        for( AbstractProject p : getAllItems(AbstractProject.class) ) {
K
kohsuke 已提交
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803
            SCM scm = p.getScm();
            if (scm instanceof CVSSCM) {
                CVSSCM cvsscm = (CVSSCM) scm;
                r.add(cvsscm.getCvsRoot());
            }
        }

        return r;
    }

2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814
    /**
     * Rebuilds the dependency map.
     */
    public void rebuildDependencyGraph() {
        dependencyGraph = new DependencyGraph();
    }

    public DependencyGraph getDependencyGraph() {
        return dependencyGraph;
    }

2815 2816 2817 2818 2819
    // for Jelly
    public List<ManagementLink> getManagementLinks() {
        return ManagementLink.LIST;
    }

K
kohsuke 已提交
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
    /**
     * 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 已提交
2831
    public Object getTarget() {
K
kohsuke 已提交
2832 2833 2834 2835 2836 2837 2838
        try {
            checkPermission(READ);
        } catch (AccessDeniedException e) {
            String rest = Stapler.getCurrentRequest().getRestOfPath();
            if(rest.startsWith("/login")
            || rest.startsWith("/logout")
            || rest.startsWith("/accessDenied")
2839
            || rest.startsWith("/signup")
2840
            || rest.startsWith("/jnlpJars/")
K
kohsuke 已提交
2841 2842 2843 2844
            || rest.startsWith("/securityRealm"))
                return this;    // URLs that are always visible without READ permission
            throw e;
        }
K
kohsuke 已提交
2845 2846 2847
        return this;
    }

2848 2849 2850 2851 2852 2853 2854
    /**
     * Fallback to the primary view.
     */
    public View getStaplerFallback() {
        return getPrimaryView();
    }

K
kohsuke 已提交
2855 2856 2857 2858 2859
    public static final class MasterComputer extends Computer {
        private MasterComputer() {
            super(Hudson.getInstance());
        }

2860 2861 2862 2863 2864 2865 2866
        /**
         * Returns "" to match with {@link Hudson#getNodeName()}.
         */
        public String getName() {
            return "";
        }

K
kohsuke 已提交
2867 2868 2869 2870 2871
        @Override
        public boolean isConnecting() {
            return false;
        }

K
kohsuke 已提交
2872 2873
        @Override
        public String getDisplayName() {
K
i18n  
kohsuke 已提交
2874
            return Messages.Hudson_Computer_DisplayName();
K
kohsuke 已提交
2875 2876 2877 2878
        }

        @Override
        public String getCaption() {
K
i18n  
kohsuke 已提交
2879
            return Messages.Hudson_Computer_Caption();
K
kohsuke 已提交
2880 2881
        }

K
kohsuke 已提交
2882 2883 2884 2885
        public String getUrl() {
            return "computer/(master)/";
        }

2886
        public RetentionStrategy getRetentionStrategy() {
K
kohsuke 已提交
2887
            return RetentionStrategy.NOOP;
2888 2889
        }

2890 2891 2892 2893 2894 2895 2896 2897
        /**
         * Report an error.
         */
        @Override
        public void doDoDelete(StaplerResponse rsp) throws IOException {
            rsp.sendError(SC_BAD_REQUEST);
        }

K
kohsuke 已提交
2898 2899 2900 2901 2902
        public void doConfigSubmit(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            // the master node isn't in the Hudson.getNodes(), so this method makes no sense.
            throw new UnsupportedOperationException();
        }

2903 2904 2905 2906 2907 2908 2909 2910 2911
        @Override
        public boolean hasPermission(Permission permission) {
            // no one should be allowed to delete the master.
            // this hides the "delete" link from the /computer/(master) page.
            if(permission==Computer.DELETE)
                return false;
            return super.hasPermission(permission);
        }

K
kohsuke 已提交
2912 2913 2914 2915 2916
        @Override
        public VirtualChannel getChannel() {
            return localChannel;
        }

2917 2918 2919 2920 2921
        @Override
        public Charset getDefaultCharset() {
            return Charset.defaultCharset();
        }

K
kohsuke 已提交
2922 2923 2924 2925
        public List<LogRecord> getLogRecords() throws IOException, InterruptedException {
            return logRecords;
        }

K
kohsuke 已提交
2926 2927 2928
        public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            // this computer never returns null from channel, so
            // this method shall never be invoked.
2929
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
2930 2931
        }

2932 2933 2934 2935 2936 2937 2938
        /**
         * Redirect the master configuration to /configure.
         */
        public void doConfigure(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            rsp.sendRedirect2(req.getContextPath()+"/configure");
        }

K
kohsuke 已提交
2939 2940
        public Future<?> connect(boolean forceReconnect) {
            return Futures.precomputed(null);
2941 2942
        }

K
kohsuke 已提交
2943 2944 2945 2946 2947 2948
        /**
         * {@link LocalChannel} instance that can be used to execute programs locally.
         */
        public static final LocalChannel localChannel = new LocalChannel(threadPoolForRemoting);
    }

2949 2950 2951 2952
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2953 2954 2955 2956
    public static boolean adminCheck() throws IOException {
        return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse());
    }

2957 2958 2959 2960
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2961
    public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2962 2963 2964 2965 2966 2967
        if (isAdmin(req)) return true;

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

K
kohsuke 已提交
2968 2969 2970
    /**
     * Checks if the current user (for which we are processing the current request)
     * has the admin access.
2971 2972
     *
     * @deprecated
K
kohsuke 已提交
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983
     *      This method is deprecated when Hudson moved from simple Unix root-like model
     *      of "admin gets to do everything, and others don't have any privilege" to more
     *      complex {@link ACL} and {@link Permission} based scheme.
     *
     *      <p>
     *      For a quick migration, use {@code Hudson.getInstance().getACL().hasPermission(Hudson.ADMINISTER)}
     *      To check if the user has the 'administer' role in Hudson.
     *
     *      <p>
     *      But ideally, your plugin should first identify a suitable {@link Permission} (or create one,
     *      if appropriate), then identify a suitable {@link AccessControlled} object to check its permission
2984
     *      against.
K
kohsuke 已提交
2985
     */
K
kohsuke 已提交
2986
    public static boolean isAdmin() {
2987
        return Hudson.getInstance().getACL().hasPermission(ADMINISTER);
K
kohsuke 已提交
2988 2989
    }

2990 2991 2992
    /**
     * @deprecated
     *      Define a custom {@link Permission} and check against ACL.
K
kohsuke 已提交
2993
     *      See {@link #isAdmin()} for more instructions.
2994
     */
K
kohsuke 已提交
2995
    public static boolean isAdmin(StaplerRequest req) {
2996
        return isAdmin();
K
kohsuke 已提交
2997 2998 2999 3000 3001
    }

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

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

3009 3010
    private static final int TWICE_CPU_NUM = Runtime.getRuntime().availableProcessors() * 2;

3011 3012 3013 3014 3015 3016
    /**
     * 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(
3017 3018
        TWICE_CPU_NUM, TWICE_CPU_NUM,
        5L, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>(), new DaemonThreadFactory());
3019 3020


K
kohsuke 已提交
3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043
    private static void computeVersion(ServletContext context) {
        // set the version
        Properties props = new Properties();
        try {
            InputStream is = Hudson.class.getResourceAsStream("hudson-version.properties");
            if(is!=null)
                props.load(is);
        } catch (IOException e) {
            e.printStackTrace(); // if the version properties is missing, that's OK.
        }
        String ver = props.getProperty("version");
        if(ver==null)   ver="?";
        VERSION = ver;
        context.setAttribute("version",ver);
        VERSION_HASH = Util.getDigestOf(ver).substring(0, 8);

        if(ver.equals("?"))
            RESOURCE_PATH = "";
        else
            RESOURCE_PATH = "/static/"+VERSION_HASH;

        VIEW_RESOURCE_PATH = "/resources/"+ VERSION_HASH;
    }
3044

3045 3046 3047
    /**
     * Version number of this Hudson.
     */
3048
    public static String VERSION="?";
3049

K
kohsuke 已提交
3050 3051 3052 3053 3054
    /**
     * Hash of {@link #VERSION}.
     */
    public static String VERSION_HASH;

3055 3056 3057
    /**
     * Prefix to static resources like images and javascripts in the war file.
     * Either "" or strings like "/static/VERSION", which avoids Hudson to pick up
3058
     * stale cache when the user upgrades to a different version.
3059 3060
     * <p>
     * Value computed in {@link WebAppMain}.
3061
     */
3062
    public static String RESOURCE_PATH = "";
3063

3064 3065 3066 3067
    /**
     * 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.
3068 3069
     * <p>
     * Value computed in {@link WebAppMain}.
3070
     */
3071
    public static String VIEW_RESOURCE_PATH = "/resources/TBD";
3072

3073
    public static boolean PARALLEL_LOAD = Boolean.getBoolean(Hudson.class.getName()+".parallelLoad");
3074
    public static boolean KILL_AFTER_LOAD = Boolean.getBoolean(Hudson.class.getName()+".killAfterLoad");
3075
    public static boolean LOG_STARTUP_PERFORMANCE = Boolean.getBoolean(Hudson.class.getName()+".logStartupPerformance");
3076

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

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

3081 3082
    public static final PermissionGroup PERMISSIONS = Permission.HUDSON_PERMISSIONS;
    public static final Permission ADMINISTER = Permission.HUDSON_ADMINISTER;
3083
    public static final Permission READ = new Permission(PERMISSIONS,"Read",Messages._Hudson_ReadPermission_Description(),Permission.READ);
K
kohsuke 已提交
3084

K
kohsuke 已提交
3085 3086
    static {
        XSTREAM.alias("hudson",Hudson.class);
K
kohsuke 已提交
3087
        XSTREAM.alias("slave", DumbSlave.class);
K
kohsuke 已提交
3088
        XSTREAM.alias("jdk",JDK.class);
3089 3090 3091
        // for backward compatibility with <1.75, recognize the tag name "view" as well.
        XSTREAM.alias("view", ListView.class);
        XSTREAM.alias("listView", ListView.class);
3092 3093
        // this seems to be necessary to force registration of converter early enough
        Mode.class.getEnumConstants();
3094 3095 3096 3097

        // doule check that initialization order didn't do any harm
        assert PERMISSIONS!=null;
        assert ADMINISTER!=null;
K
kohsuke 已提交
3098 3099
    }
}