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

S
sogabe 已提交
3
import com.thoughtworks.xstream.XStream;
4
import hudson.BulkChange;
K
kohsuke 已提交
5
import hudson.FeedAdapter;
6
import hudson.FilePath;
7
import hudson.Functions;
K
kohsuke 已提交
8
import hudson.Launcher;
S
sogabe 已提交
9
import hudson.Launcher.LocalLauncher;
K
kohsuke 已提交
10 11 12
import hudson.Plugin;
import hudson.PluginManager;
import hudson.PluginWrapper;
13
import hudson.ProxyConfiguration;
14
import hudson.StructuredForm;
K
kohsuke 已提交
15
import hudson.TcpSlaveAgentListener;
16
import hudson.Util;
S
sogabe 已提交
17
import static hudson.Util.fixEmpty;
18
import hudson.WebAppMain;
19
import hudson.XmlFile;
K
kohsuke 已提交
20
import hudson.model.Descriptor.FormException;
21
import hudson.model.listeners.ItemListener;
K
kohsuke 已提交
22
import hudson.model.listeners.JobListener;
23
import hudson.model.listeners.JobListener.JobListenerAdapter;
S
sogabe 已提交
24
import hudson.model.listeners.SCMListener;
K
kohsuke 已提交
25 26
import hudson.remoting.LocalChannel;
import hudson.remoting.VirtualChannel;
K
kohsuke 已提交
27
import hudson.scm.CVSSCM;
K
kohsuke 已提交
28 29
import hudson.scm.RepositoryBrowser;
import hudson.scm.RepositoryBrowsers;
30 31 32
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
import hudson.scm.SCMS;
33
import hudson.scm.SubversionSCM;
K
kohsuke 已提交
34
import hudson.search.CollectionSearchIndex;
35
import hudson.search.SearchIndexBuilder;
36
import hudson.security.ACL;
37
import hudson.security.AccessControlled;
38
import hudson.security.AuthorizationStrategy;
K
kohsuke 已提交
39
import hudson.security.BasicAuthenticationFilter;
40 41 42 43
import hudson.security.HudsonFilter;
import hudson.security.LegacyAuthorizationStrategy;
import hudson.security.LegacySecurityRealm;
import hudson.security.Permission;
44
import hudson.security.PermissionGroup;
K
kohsuke 已提交
45
import hudson.security.SecurityMode;
46
import hudson.security.SecurityRealm;
47
import hudson.security.SecurityRealm.SecurityComponents;
S
sogabe 已提交
48
import hudson.security.TokenBasedRememberMeServices2;
49 50
import hudson.slaves.ComputerListener;
import hudson.slaves.RetentionStrategy;
51 52 53 54 55 56 57 58
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 已提交
59
import hudson.triggers.Trigger;
60
import hudson.triggers.TriggerDescriptor;
61
import hudson.triggers.Triggers;
K
kohsuke 已提交
62
import hudson.util.CaseInsensitiveComparator;
K
kohsuke 已提交
63 64 65 66 67 68 69
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 已提交
70
import hudson.util.RemotingDiagnostics;
71
import hudson.util.TextFile;
K
kohsuke 已提交
72 73
import hudson.util.XStream2;
import hudson.widgets.Widget;
S
sogabe 已提交
74 75 76 77 78 79 80 81 82
import net.sf.json.JSONObject;
import org.acegisecurity.AccessDeniedException;
import org.acegisecurity.Authentication;
import org.acegisecurity.GrantedAuthority;
import org.acegisecurity.GrantedAuthorityImpl;
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 已提交
83
import org.apache.commons.logging.LogFactory;
S
sogabe 已提交
84 85 86 87 88 89 90
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;
import org.kohsuke.stapler.export.Exported;
K
kohsuke 已提交
91

S
sogabe 已提交
92 93 94 95 96 97 98 99
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 已提交
100 101 102
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
103
import java.io.FileOutputStream;
K
kohsuke 已提交
104 105
import java.io.IOException;
import java.io.PrintWriter;
106
import java.net.URL;
107
import java.security.SecureRandom;
108
import java.text.NumberFormat;
K
kohsuke 已提交
109 110 111
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Arrays;
K
kohsuke 已提交
112
import java.util.Calendar;
K
kohsuke 已提交
113 114 115
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
K
kohsuke 已提交
116
import java.util.GregorianCalendar;
K
kohsuke 已提交
117 118
import java.util.HashMap;
import java.util.HashSet;
119
import java.util.Iterator;
K
kohsuke 已提交
120 121
import java.util.List;
import java.util.Map;
S
sogabe 已提交
122
import java.util.Map.Entry;
K
kohsuke 已提交
123
import java.util.Set;
124 125
import java.util.Stack;
import java.util.StringTokenizer;
126
import java.util.Timer;
K
kohsuke 已提交
127 128
import java.util.TreeSet;
import java.util.Vector;
129
import java.util.concurrent.Callable;
130
import java.util.concurrent.ConcurrentHashMap;
K
kohsuke 已提交
131
import java.util.concurrent.CopyOnWriteArrayList;
132 133 134 135 136
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;
137
import java.util.concurrent.LinkedBlockingQueue;
K
kohsuke 已提交
138
import java.util.logging.Level;
K
kohsuke 已提交
139
import java.util.logging.LogRecord;
140
import java.util.logging.Logger;
141
import java.util.regex.Pattern;
K
kohsuke 已提交
142 143 144 145 146 147

/**
 * Root object of the system.
 *
 * @author Kohsuke Kawaguchi
 */
148
public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node, StaplerProxy {
149
    private transient final Queue queue;
K
kohsuke 已提交
150 151 152 153

    /**
     * {@link Computer}s in this Hudson system. Read-only.
     */
K
kohsuke 已提交
154
    private transient final Map<Node,Computer> computers = new CopyOnWriteMap.Hash<Node,Computer>();
K
kohsuke 已提交
155 156 157 158 159 160

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

161 162 163 164 165
    /**
     * Job allocation strategy.
     */
    private Mode mode = Mode.NORMAL;

K
kohsuke 已提交
166 167
    /**
     * False to enable anyone to do anything.
K
kohsuke 已提交
168
     * Left as a field so that we can still read old data that uses this flag.
169 170 171
     *
     * @see #authorizationStrategy
     * @see #securityRealm
K
kohsuke 已提交
172
     */
K
kohsuke 已提交
173
    private Boolean useSecurity;
K
kohsuke 已提交
174 175

    /**
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
     * 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.
     *
193
     * See {@link HudsonFilter} for the concrete authentication protocol.
194
     *
195 196
     * Never null. Always use {@link #setSecurityRealm(SecurityRealm)} to
     * update this field.
197 198
     *
     * @see #getSecurity()
199
     * @see #setSecurityRealm(SecurityRealm)
K
kohsuke 已提交
200
     */
201
    private volatile SecurityRealm securityRealm;
K
kohsuke 已提交
202 203 204 205 206 207 208 209 210 211 212

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

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

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

K
kohsuke 已提交
218 219 220 221 222
    /**
     * The sole instance.
     */
    private static Hudson theInstance;

K
kohsuke 已提交
223 224
    private transient volatile boolean isQuietingDown;
    private transient volatile boolean terminating;
K
kohsuke 已提交
225

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

K
kohsuke 已提交
228 229 230 231 232
    /**
     * Widgets on Hudson.
     */
    private transient final List<Widget> widgets = new CopyOnWriteArrayList<Widget>();

233
    private transient volatile DependencyGraph dependencyGraph;
234

K
kohsuke 已提交
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    /**
     * Set of installed cluster nodes.
     *
     * We use this field with copy-on-write semantics.
     * This field has mutable list (to keep the serialization look clean),
     * but it shall never be modified. Only new completely populated slave
     * list can be set here.
     */
    private volatile List<Slave> slaves;

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

    /**
253
     * {@link ListView}s.
K
kohsuke 已提交
254
     */
255
    private List<ListView> views;   // can't initialize it eagerly for backward compatibility
K
kohsuke 已提交
256

257 258
    private transient MyView myView = new MyView(this);

K
kohsuke 已提交
259 260 261 262 263 264 265
    private transient final FingerprintMap fingerprintMap = new FingerprintMap();

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

266
    public transient volatile TcpSlaveAgentListener tcpSlaveAgentListener;
K
kohsuke 已提交
267

268
    /**
K
kohsuke 已提交
269
     * List of registered {@link JobListener}s.
270
     */
K
kohsuke 已提交
271
    private transient final CopyOnWriteList<ItemListener> itemListeners = new CopyOnWriteList<ItemListener>();
272 273 274 275 276

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

278 279 280 281 282
    /**
     * List of registered {@link ComputerListener}s.
     */
    private transient final CopyOnWriteList<ComputerListener> computerListeners = new CopyOnWriteList<ComputerListener>();

283 284
    /**
     * TCP slave agent port.
285
     * 0 for random, -1 to disable.
286 287 288
     */
    private int slaveAgentPort =0;

289 290 291 292 293
    /**
     * 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>();
294
    private transient Set<Label> labelSet;
295
    private transient volatile Set<Label> dynamicLabels = null;
296

297 298
    public transient final ServletContext servletContext;

K
kohsuke 已提交
299 300 301 302 303 304
    /**
     * Transient action list. Useful for adding navigation items to the navigation bar
     * on the left.
     */
    private transient final List<Action> actions = new CopyOnWriteArrayList<Action>();

K
kohsuke 已提交
305 306 307 308
    public static Hudson getInstance() {
        return theInstance;
    }

309 310 311 312 313 314
    /**
     * Secrete key generated once and used for a long time, beyond
     * container start/stop.
     */
    private final String secretKey;

315
    private transient final UpdateCenter updateCenter = new UpdateCenter();
K
kohsuke 已提交
316

317 318 319 320 321 322
    /**
     * HTTP proxy configuration.
     */
    public transient volatile ProxyConfiguration proxy;


K
kohsuke 已提交
323 324
    public Hudson(File root, ServletContext context) throws IOException {
        this.root = root;
325
        this.servletContext = context;
K
kohsuke 已提交
326 327 328
        if(theInstance!=null)
            throw new IllegalStateException("second instance");
        theInstance = this;
K
kohsuke 已提交
329
        Trigger.timer = new Timer("Hudson cron thread");
330
        queue = new Queue();
K
kohsuke 已提交
331

332 333 334 335 336 337 338 339 340
        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;
        }

341 342 343 344 345 346 347 348 349 350 351 352
        // 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);
        }

353 354 355 356 357 358
        try {
            proxy = ProxyConfiguration.load();
        } catch (IOException e) {
            LOGGER.log(Level.SEVERE, "Failed to load proxy configuration", e);
        }

359 360
        // run the init code of SubversionSCM before we load plugins so that plugins can change SubversionWorkspaceSelector.
        SubversionSCM.DescriptorImpl.DESCRIPTOR.getDisplayName();
361

K
kohsuke 已提交
362 363 364
        // load plugins.
        pluginManager = new PluginManager(context);

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

368
        // work around to have MavenModule register itself until we either move it to a plugin
369
        // or make it a part of the core.
370
        Items.LIST.hashCode();
371

K
kohsuke 已提交
372
        load();
373

374 375 376 377 378 379 380 381 382 383 384 385 386
//        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);
//        }

387 388 389 390 391
        if(slaveAgentPort!=-1)
            tcpSlaveAgentListener = new TcpSlaveAgentListener(slaveAgentPort);
        else
            tcpSlaveAgentListener = null;

K
kohsuke 已提交
392 393 394
        updateComputerList();

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

K
kohsuke 已提交
396
        for (ItemListener l : itemListeners)
397
            l.onLoaded();
398 399 400 401 402 403 404

        // create TokenBasedRememberMeServices, which depends on the availability of the secret key
        TokenBasedRememberMeServices2 rms = new TokenBasedRememberMeServices2();
        rms.setUserDetailsService(HudsonFilter.USER_DETAILS_SERVICE_PROXY);
        rms.setKey(getSecretKey());
        rms.setParameter("remember_me"); // this is the form field name in login.jelly
        HudsonFilter.REMEMBER_ME_SERVICES_PROXY.setDelegate(rms);
K
kohsuke 已提交
405 406
    }

K
kohsuke 已提交
407 408 409 410
    public TcpSlaveAgentListener getTcpSlaveAgentListener() {
        return tcpSlaveAgentListener;
    }

K
kohsuke 已提交
411
    @Exported
412 413 414 415
    public int getSlaveAgentPort() {
        return slaveAgentPort;
    }

K
kohsuke 已提交
416
    /**
J
jglick 已提交
417
     * If you are calling this on Hudson something is wrong.
K
kohsuke 已提交
418 419 420
     *
     * @deprecated
     */
J
jglick 已提交
421
    @Deprecated
K
kohsuke 已提交
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
    public String getNodeName() {
        return "";
    }

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

    public String getDescription() {
        return systemMessage;
    }

    public PluginManager getPluginManager() {
        return pluginManager;
    }
437

438 439 440
    public UpdateCenter getUpdateCenter() {
        return updateCenter;
    }
K
kohsuke 已提交
441

442 443 444
    /**
     * Returns a secret key that survives across container start/stop.
     * <p>
445
     * This value is useful for implementing some of the security features.
446 447 448 449 450
     */
    public String getSecretKey() {
        return  secretKey;
    }

K
kohsuke 已提交
451 452 453 454 455 456 457
    /**
     * 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 已提交
458 459 460 461 462 463 464
    /**
     * 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 已提交
465 466 467 468 469 470 471
    /**
     * 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 已提交
472 473 474 475 476 477 478
    /**
     * 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 已提交
479 480 481 482 483 484 485
    /**
     * 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 已提交
486 487 488
    /**
     * Gets the trigger descriptor by name. Primarily used for making them web-visible.
     */
489 490
    public TriggerDescriptor getTrigger(String shortClassName) {
        return (TriggerDescriptor)findDescriptor(shortClassName, Triggers.TRIGGERS);
K
kohsuke 已提交
491 492
    }

493 494 495 496
    /**
     * Gets the {@link JobPropertyDescriptor} by name. Primarily used for making them web-visible.
     */
    public JobPropertyDescriptor getJobProperty(String shortClassName) {
K
kohsuke 已提交
497 498 499
        // combining these two lines triggers javac bug. See issue #610.
        Descriptor d = findDescriptor(shortClassName, Jobs.PROPERTIES);
        return (JobPropertyDescriptor) d;
500 501
    }

502 503 504 505 506 507 508 509 510 511 512 513 514
    /**
     * 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;
    }

515 516 517 518 519 520 521
    /**
     * 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 已提交
522 523 524 525
    /**
     * Finds a descriptor that has the specified name.
     */
    private <T extends Describable<T>>
526
    Descriptor<T> findDescriptor(String shortClassName, Collection<? extends Descriptor<T>> descriptors) {
K
kohsuke 已提交
527 528 529 530 531 532 533 534
        String name = '.'+shortClassName;
        for (Descriptor<T> d : descriptors) {
            if(d.clazz.getName().endsWith(name))
                return d;
        }
        return null;
    }

535 536 537
    /**
     * Adds a new {@link JobListener}.
     *
538 539
     * @deprecated
     *      Use {@code getJobListners().add(l)} instead.
540 541
     */
    public void addListener(JobListener l) {
K
kohsuke 已提交
542
        itemListeners.add(new JobListenerAdapter(l));
543 544 545 546 547
    }

    /**
     * Deletes an existing {@link JobListener}.
     *
548 549
     * @deprecated
     *      Use {@code getJobListners().remove(l)} instead.
550 551
     */
    public boolean removeListener(JobListener l ) {
K
kohsuke 已提交
552
        return itemListeners.remove(new JobListenerAdapter(l));
553 554
    }

555
    /**
556
     * Gets all the installed {@link ItemListener}s.
557
     */
558
    public CopyOnWriteList<ItemListener> getJobListeners() {
K
kohsuke 已提交
559
        return itemListeners;
560 561 562 563 564 565 566 567 568
    }

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

569 570 571 572 573 574 575
    /**
     * Gets all the installed {@link ComputerListener}s.
     */
    public CopyOnWriteList<ComputerListener> getComputerListeners() {
        return computerListeners;
    }

K
kohsuke 已提交
576 577 578 579 580 581 582 583 584 585
    /**
     * 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;
586
        return p.getPlugin();
K
kohsuke 已提交
587 588
    }

589 590 591 592 593 594 595 596 597 598 599 600
    /**
     * 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 已提交
601 602
    @SuppressWarnings("unchecked")
    public <P extends Plugin> P getPlugin(Class<P> clazz) {
603 604
        PluginWrapper p = pluginManager.getPlugin(clazz);
        if(p==null)     return null;
S
stephenconnolly 已提交
605
        return (P) p.getPlugin();
606 607 608 609 610 611 612 613 614
    }

    /**
     * Gets the plugin objects from their super-class.
     *
     * @param clazz The plugin class (beware class-loader fun)
     *
     * @return The plugin instances.
     */
S
stephenconnolly 已提交
615 616
    public <P extends Plugin> List<P> getPlugins(Class<P> clazz) {
        List<P> result = new ArrayList<P>();
617
        for (PluginWrapper w: pluginManager.getPlugins(clazz)) {
S
stephenconnolly 已提交
618
            result.add((P)w.getPlugin());
619 620 621 622
        }
        return Collections.unmodifiableList(result);
    }

K
kohsuke 已提交
623 624 625 626 627 628 629 630
    /**
     * Synonym to {@link #getNodeDescription()}.
     */
    public String getSystemMessage() {
        return systemMessage;
    }

    public Launcher createLauncher(TaskListener listener) {
K
kohsuke 已提交
631
        return new LocalLauncher(listener);
K
kohsuke 已提交
632 633 634 635 636 637 638 639 640
    }

    /**
     * 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 已提交
641
    private void updateComputerList() throws IOException {
642
        synchronized(computers) {// this synchronization is still necessary so that no two update happens concurrently
K
kohsuke 已提交
643
            Map<String,Computer> byName = new HashMap<String,Computer>();
K
kohsuke 已提交
644 645 646
            for (Computer c : computers.values()) {
                if(c.getNode()==null)
                    continue;   // this computer is gone
K
kohsuke 已提交
647
                byName.put(c.getNode().getNodeName(),c);
K
kohsuke 已提交
648
            }
K
kohsuke 已提交
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

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

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

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

    private void updateComputer(Node n, Map<String,Computer> byNameMap, Set<Computer> used) {
        Computer c;
        c = byNameMap.get(n.getNodeName());
K
kohsuke 已提交
671 672
        if (c!=null) {
            c.setNode(n); // reuse
K
kohsuke 已提交
673
        } else {
K
kohsuke 已提交
674 675
            if(n.getNumExecutors()>0)
                computers.put(n,c=n.createComputer());
K
kohsuke 已提交
676 677 678 679 680
        }
        used.add(c);
    }

    /*package*/ void removeComputer(Computer computer) {
681 682
        for (Entry<Node, Computer> e : computers.entrySet()) {
            if (e.getValue() == computer) {
K
kohsuke 已提交
683
                computers.remove(e.getKey());
684
                return;
K
kohsuke 已提交
685 686 687 688 689
            }
        }
        throw new IllegalStateException("Trying to remove unknown computer");
    }

690 691 692 693
    public String getFullName() {
        return "";
    }

694 695 696 697
    public String getFullDisplayName() {
        return "";
    }

K
kohsuke 已提交
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
    /**
     * 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;
    }

718 719 720
    /**
     * Gets just the immediate children of {@link Hudson}.
     *
721
     * @see #getAllItems(Class)
722
     */
K
kohsuke 已提交
723
    public List<TopLevelItem> getItems() {
724
        return new ArrayList<TopLevelItem>(items.values());
725 726
    }

K
kohsuke 已提交
727 728 729
    /**
     * Gets just the immediate children of {@link Hudson} but of the given type.
     */
K
kohsuke 已提交
730
    public <T> List<T> getItems(Class<T> type) {
K
kohsuke 已提交
731 732 733 734 735 736 737
        List<T> r = new ArrayList<T>();
        for (TopLevelItem i : items.values())
            if (type.isInstance(i))
                 r.add(type.cast(i));
        return r;
    }

738 739 740 741 742 743 744 745 746 747 748 749 750 751
    /**
     * 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 已提交
752
                    r.add(type.cast(i));
753 754 755 756 757 758 759 760
                if(i instanceof ItemGroup)
                    q.push((ItemGroup)i);
            }
        }

        return r;
    }

K
kohsuke 已提交
761
    /**
K
kohsuke 已提交
762 763 764 765 766
     * 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 已提交
767
     */
K
kohsuke 已提交
768
    public List<Project> getProjects() {
K
kohsuke 已提交
769
        return Util.createSubList(items.values(),Project.class);
K
kohsuke 已提交
770 771 772 773 774
    }

    /**
     * Gets the names of all the {@link Job}s.
     */
K
kohsuke 已提交
775
    public Collection<String> getJobNames() {
776
        List<String> names = new ArrayList<String>();
K
kohsuke 已提交
777
        for (Job j : getAllItems(Job.class))
778
            names.add(j.getFullName());
779
        return names;
K
kohsuke 已提交
780 781
    }

782 783 784 785 786 787 788 789 790 791
    /**
     * Gets the names of all the {@link TopLevelItem}s.
     */
    public Collection<String> getTopLevelItemNames() {
        List<String> names = new ArrayList<String>();
        for (TopLevelItem j : items.values())
            names.add(j.getName());
        return names;
    }

K
kohsuke 已提交
792 793 794 795 796 797
    /**
     * Every job belongs to us.
     *
     * @deprecated
     *      why are you calling a method that always return true?
     */
J
jglick 已提交
798
    @Deprecated
799
    public boolean contains(TopLevelItem view) {
K
kohsuke 已提交
800 801 802
        return true;
    }

803
    public synchronized View getView(String name) {
K
kohsuke 已提交
804
        if(views!=null) {
805
            for (ListView v : views) {
K
kohsuke 已提交
806 807 808 809
                if(v.getViewName().equals(name))
                    return v;
            }
        }
810
        if (this.getViewName().equals(name)) {
K
kohsuke 已提交
811
            return this;
812 813 814
        } else if (myView.getViewName().equals(name)) {
            return myView;
        } else
K
kohsuke 已提交
815 816 817 818
            return null;
    }

    /**
819
     * Gets the read-only list of all {@link View}s.
K
kohsuke 已提交
820
     */
821
    @Exported
822
    public synchronized View[] getViews() {
K
kohsuke 已提交
823
        if(views==null)
824
            views = new ArrayList<ListView>();
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844

        if(Functions.isAnonymous()) {
            View[] r = new View[views.size()+1];
            views.toArray(r);
            // sort Views and put "all" at the very beginning
            r[r.length-1] = r[0];
            Arrays.sort(r,1,r.length, View.SORTER);
            r[0] = this;
            return r;
        } else {
            // this is an authenticated user, so let's have the "my projects" view
            View[] r = new View[views.size()+2];
            views.toArray(r);
            r[r.length-2] = r[0];
            r[r.length-1] = r[1];
            Arrays.sort(r,2,r.length, View.SORTER);
            r[0] = myView;
            r[1] = this;
            return r;
        }
K
kohsuke 已提交
845 846
    }

847
    public synchronized void deleteView(ListView view) throws IOException {
K
kohsuke 已提交
848 849 850 851 852 853 854
        if(views!=null) {
            views.remove(view);
            save();
        }
    }

    public String getViewName() {
K
i18n  
kohsuke 已提交
855
        return Messages.Hudson_ViewName();
K
kohsuke 已提交
856 857 858 859 860 861
    }

    /**
     * Gets the read-only list of all {@link Computer}s.
     */
    public Computer[] getComputers() {
862 863 864 865 866
        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 已提交
867
                return lhs.getDisplayName().compareTo(rhs.getDisplayName());
868 869 870
            }
        });
        return r;
K
kohsuke 已提交
871 872
    }

873 874 875 876
    /*package*/ Computer getComputer(Node n) {
        return computers.get(n);
    }

K
kohsuke 已提交
877
    public Computer getComputer(String name) {
K
kohsuke 已提交
878 879 880
        if(name.equals("(master)"))
            name = "";

881 882 883
        for (Computer c : computers.values()) {
            if(c.getNode().getNodeName().equals(name))
                return c;
K
kohsuke 已提交
884 885 886 887
        }
        return null;
    }

K
kohsuke 已提交
888 889 890 891 892 893 894 895
    /**
     * @deprecated
     *      UI method. Not meant to be used programatically.
     */
    public ComputerSet getComputer() {
        return new ComputerSet();
    }

896
    public Computer toComputer() {
897
        return getComputer(this);
898 899
    }

900 901 902 903 904 905
    /**
     * 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 已提交
906
        if(name==null)  return null;
907 908 909 910 911 912 913 914 915 916 917
        while(true) {
            Label l = labels.get(name);
            if(l!=null)
                return l;

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

    /**
918
     * Gets all the active labels in the current system.
919 920 921 922 923 924 925 926 927 928
     */
    public Set<Label> getLabels() {
        Set<Label> r = new TreeSet<Label>();
        for (Label l : labels.values()) {
            if(!l.getNodes().isEmpty())
                r.add(l);
        }
        return r;
    }

K
kohsuke 已提交
929 930 931 932 933
    public Queue getQueue() {
        return queue;
    }

    public String getDisplayName() {
K
i18n  
kohsuke 已提交
934
        return Messages.Hudson_DisplayName();
K
kohsuke 已提交
935 936 937 938 939 940 941 942 943 944 945 946
    }

    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) {
947 948 949 950 951 952
        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 已提交
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
        for (JDK j : getJDKs()) {
            if(j.getName().equals(name))
                return j;
        }
        return null;
    }

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

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

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
    /**
     * Updates the slave list.
     */
    public void setSlaves(List<Slave> slaves) throws IOException {
        this.slaves = new ArrayList<Slave>(slaves);
        updateComputerList();

        // label trim off
        for (Iterator<Label> itr = labels.values().iterator(); itr.hasNext();) {
            Label l = itr.next();
            l.reset();
            if(l.getNodes().isEmpty())
                itr.remove();
        }

        save();
    }

K
kohsuke 已提交
993 994 995 996 997 998 999
    /**
     * Gets the system default quiet period.
     */
    public int getQuietPeriod() {
        return quietPeriod!=null ? quietPeriod : 5;
    }

K
kohsuke 已提交
1000 1001 1002 1003 1004
    /**
     * @deprecated
     *      Why are you calling a method that always returns ""?
     *      Perhaps you meant {@link #getRootUrl()}.
     */
K
kohsuke 已提交
1005 1006 1007 1008
    public String getUrl() {
        return "";
    }

1009
    @Override
1010 1011
    public SearchIndexBuilder makeSearchIndex() {
        return super.makeSearchIndex()
1012
            .add("configure", "config","configure")
K
kohsuke 已提交
1013
            .add("manage")
K
kohsuke 已提交
1014 1015 1016 1017
            .add("log")
            .add(new CollectionSearchIndex() {// for computers
                protected Computer get(String key) { return getComputer(key); }
                protected Collection<Computer> all() { return computers.values(); }
K
kohsuke 已提交
1018
            })
K
kohsuke 已提交
1019
            .add(new CollectionSearchIndex() {// for users
K
kohsuke 已提交
1020
                protected User get(String key) { return User.get(key,false); }
K
kohsuke 已提交
1021
                protected Collection<User> all() { return User.getAll(); }
K
kohsuke 已提交
1022
            })
K
kohsuke 已提交
1023 1024 1025
            .add(new CollectionSearchIndex() {// for views
                protected View get(String key) { return getView(key); }
                protected Collection<ListView> all() { return views; }
K
kohsuke 已提交
1026
            });
1027 1028
    }

1029 1030 1031 1032
    public String getUrlChildPrefix() {
        return "job";
    }

K
kohsuke 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
    /**
     * 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
1052
     * @see Descriptor#getCheckUrl(String) 
K
kohsuke 已提交
1053 1054 1055
     */
    public String getRootUrl() {
        // for compatibility. the actual data is stored in Mailer
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
        String url = Mailer.DESCRIPTOR.getUrl();
        if(url!=null)   return url;

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

K
kohsuke 已提交
1072 1073 1074 1075
    public File getRootDir() {
        return root;
    }

1076 1077 1078 1079
    public FilePath getWorkspaceFor(TopLevelItem item) {
        return new FilePath(new File(item.getRootDir(),"workspace"));
    }

K
kohsuke 已提交
1080 1081 1082 1083
    public FilePath getRootPath() {
        return new FilePath(getRootDir());
    }

1084 1085 1086 1087
    public FilePath createPath(String absolutePath) {
        return new FilePath((VirtualChannel)null,absolutePath);
    }

1088 1089
    public ClockDifference getClockDifference() {
        return ClockDifference.ZERO;
K
kohsuke 已提交
1090 1091
    }

K
kohsuke 已提交
1092
    /**
1093 1094
     * A convenience method to check if there's some security
     * restrictions in place.
K
kohsuke 已提交
1095
     */
K
kohsuke 已提交
1096
    public boolean isUseSecurity() {
1097
        return securityRealm!=SecurityRealm.NO_AUTHENTICATION || authorizationStrategy!=AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1098 1099
    }

K
kohsuke 已提交
1100
    /**
1101 1102
     * Returns the constant that captures the three basic security modes
     * in Hudson.
K
kohsuke 已提交
1103
     */
1104 1105 1106 1107 1108 1109 1110 1111 1112
    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 已提交
1113 1114
    }

K
kohsuke 已提交
1115 1116 1117 1118 1119 1120 1121 1122
    /**
     * @return
     *      never null.
     */
    public SecurityRealm getSecurityRealm() {
        return securityRealm;
    }

1123
    public void setSecurityRealm(SecurityRealm securityRealm) {
1124 1125
        if(securityRealm==null)
            securityRealm= SecurityRealm.NO_AUTHENTICATION;
1126
        this.securityRealm = securityRealm;
K
kohsuke 已提交
1127 1128 1129
        SecurityComponents sc = securityRealm.createSecurityComponents();
        HudsonFilter.AUTHENTICATION_MANAGER.setDelegate(sc.manager);
        HudsonFilter.USER_DETAILS_SERVICE_PROXY.setDelegate(sc.userDetails);
1130 1131
    }

1132 1133 1134 1135 1136 1137 1138
    /**
     * Returns the root {@link ACL}.
     *
     * @see AuthorizationStrategy#getRootACL()
     */
    public ACL getACL() {
        return authorizationStrategy.getRootACL();
K
kohsuke 已提交
1139 1140
    }

1141 1142 1143 1144 1145 1146
    /**
     * @return
     *      never null.
     */
    public AuthorizationStrategy getAuthorizationStrategy() {
        return authorizationStrategy;
K
kohsuke 已提交
1147 1148
    }

K
kohsuke 已提交
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
    /**
     * 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;
    }

1167 1168 1169 1170 1171
    public void setNumExecutors(int n) throws IOException {
        this.numExecutors = n;
        save();
    }

K
kohsuke 已提交
1172
    /**
1173 1174 1175
     * @deprecated
     *      Left only for the compatibility of URLs.
     *      Should not be invoked for any other purpose.
K
kohsuke 已提交
1176
     */
1177 1178
    public TopLevelItem getJob(String name) {
        return getItem(name);
K
kohsuke 已提交
1179 1180
    }

1181 1182 1183 1184 1185 1186
    /**
     * @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 已提交
1187
            if(Functions.toEmailSafeString(e.getKey()).equalsIgnoreCase(Functions.toEmailSafeString(name)))
1188 1189 1190 1191 1192
                return e.getValue();
        }
        return null;
    }

K
kohsuke 已提交
1193 1194 1195 1196 1197
    /**
     * {@inheritDoc}.
     *
     * Note that the look up is case-insensitive.
     */
1198
    @Override
K
kohsuke 已提交
1199
    public TopLevelItem getItem(String name) {
1200 1201 1202
        return items.get(name);
    }

1203
    public File getRootDirFor(TopLevelItem child) {
1204 1205 1206 1207 1208
        return getRootDirFor(child.getName());
    }

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

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
    /**
     * 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 已提交
1240 1241 1242 1243
    public Item getItemByFullName(String fullName) {
        return getItemByFullName(fullName,Item.class);
    }

K
kohsuke 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
    /**
     * 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.
     */
1260
    public synchronized TopLevelItem createProject( TopLevelItemDescriptor type, String name ) throws IOException {
K
kohsuke 已提交
1261
        if(items.containsKey(name))
K
kohsuke 已提交
1262 1263
            throw new IllegalArgumentException();

K
kohsuke 已提交
1264
        TopLevelItem item;
K
kohsuke 已提交
1265
        try {
K
kohsuke 已提交
1266
            item = type.newInstance(name);
K
kohsuke 已提交
1267 1268 1269 1270
        } catch (Exception e) {
            throw new IllegalArgumentException(e);
        }

K
kohsuke 已提交
1271 1272 1273
        item.save();
        items.put(name,item);
        return item;
K
kohsuke 已提交
1274 1275 1276 1277 1278
    }

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

1283
        items.remove(item.getName());
K
kohsuke 已提交
1284
        if(views!=null) {
1285
            for (ListView v : views) {
K
kohsuke 已提交
1286
                synchronized(v) {
1287
                    v.jobNames.remove(item.getName());
K
kohsuke 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
                }
            }
            save();
        }
    }

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

        if(views!=null) {
1303
            for (ListView v : views) {
K
kohsuke 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
                synchronized(v) {
                    if(v.jobNames.remove(oldName))
                        v.jobNames.add(newName);
                }
            }
            save();
        }
    }

    public FingerprintMap getFingerprintMap() {
        return fingerprintMap;
    }

K
kohsuke 已提交
1317
    // if no finger print matches, display "not found page".
K
kohsuke 已提交
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
    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() {
1344
        return mode;
K
kohsuke 已提交
1345 1346
    }

1347
    public Set<Label> getAssignedLabels() {
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
        if (labelSet == null) {
            Set<Label> r = new HashSet<Label>();
            r.addAll(getDynamicLabels());
            r.add(getSelfLabel());
            this.labelSet = Collections.unmodifiableSet(r);
        }
        return labelSet;
    }

    /**
     * Returns the possibly empty set of labels that it has been determined as supported by this node.
     *
     * @see hudson.tasks.LabelFinder
     */
    public Set<Label> getDynamicLabels() {
        if (dynamicLabels == null) {
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
            // 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));
1375 1376 1377 1378
                        }
                    }
                }
            }
1379
            dynamicLabels = r;
1380 1381
        }
        return dynamicLabels;
1382 1383 1384 1385 1386 1387
    }

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

K
kohsuke 已提交
1388 1389 1390 1391
    public Computer createComputer() {
        return new MasterComputer();
    }

K
kohsuke 已提交
1392
    private synchronized void load() throws IOException {
1393
        long startTime = System.currentTimeMillis();
K
kohsuke 已提交
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
        XmlFile cfg = getConfigFile();
        if(cfg.exists())
            cfg.unmarshal(this);

        File projectsDir = new File(root,"jobs");
        if(!projectsDir.isDirectory() && !projectsDir.mkdirs()) {
            if(projectsDir.exists())
                throw new IOException(projectsDir+" is not a directory");
            throw new IOException("Unable to create "+projectsDir+"\nPermission issue? Please create this directory manually.");
        }
        File[] subdirs = projectsDir.listFiles(new FileFilter() {
            public boolean accept(File child) {
1406
                return child.isDirectory() && Items.getConfigFile(child).exists();
K
kohsuke 已提交
1407 1408
            }
        });
1409
        items.clear();
1410 1411
        if(parallelLoad) {
            // load jobs in parallel for better performance
1412
            LOGGER.info("Loading in "+TWICE_CPU_NUM+" parallel threads");
1413 1414 1415 1416
            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 {
1417 1418 1419 1420
                        long start = System.currentTimeMillis();
                        TopLevelItem item = (TopLevelItem) Items.load(Hudson.this, subdir);
                        PERFORMANCE_LOGGER.info("Loaded "+item.getName()+" in "+(System.currentTimeMillis()-start)+"ms by "+Thread.currentThread().getName());
                        return item;
1421 1422 1423 1424 1425 1426 1427 1428 1429
                    }
                }));
            }

            for (Future<TopLevelItem> loader : loaders) {
                try {
                    TopLevelItem item = loader.get();
                    items.put(item.getName(), item);
                } catch (ExecutionException e) {
K
typo  
kohsuke 已提交
1430
                    LOGGER.log(Level.WARNING, "Failed to load a project",e.getCause());
1431 1432 1433 1434 1435 1436 1437
                } catch (InterruptedException e) {
                    e.printStackTrace(); // this is probably not the right thing to do
                }
            }
        } else {
            for (File subdir : subdirs) {
                try {
1438
                    long start = System.currentTimeMillis();
1439
                    TopLevelItem item = (TopLevelItem)Items.load(this,subdir);
1440
                    PERFORMANCE_LOGGER.info("Loaded "+item.getName()+" in "+(System.currentTimeMillis()-start)+"ms");
1441 1442 1443
                    items.put(item.getName(), item);
                } catch (Error e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
1444 1445
                } catch (RuntimeException e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
1446 1447 1448
                } catch (IOException e) {
                    LOGGER.log(Level.WARNING, "Failed to load "+subdir,e);
                }
K
kohsuke 已提交
1449 1450
            }
        }
1451
        rebuildDependencyGraph();
1452 1453

        // recompute label objects
1454 1455 1456 1457
        if (null != slaves) { // only if we have slaves
            for (Slave slave : slaves)
                slave.getAssignedLabels();
        }
K
kohsuke 已提交
1458

K
typo.  
kohsuke 已提交
1459
        // read in old data that doesn't have the security field set
1460 1461 1462 1463 1464 1465 1466 1467
        if(authorizationStrategy==null) {
            if(useSecurity==null || !useSecurity)
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
            else
                authorizationStrategy = new LegacyAuthorizationStrategy();
        }
        if(securityRealm==null) {
            if(useSecurity==null || !useSecurity)
1468
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1469
            else
1470 1471 1472 1473
                setSecurityRealm(new LegacySecurityRealm());
        } else {
            // force the set to proxy
            setSecurityRealm(securityRealm);
1474
        }
1475

K
kohsuke 已提交
1476 1477 1478 1479
        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;
1480
            setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
K
kohsuke 已提交
1481
        }
1482

K
kohsuke 已提交
1483

1484
        LOGGER.info(String.format("Took %s ms to load",System.currentTimeMillis()-startTime));
1485 1486
        if(KILL_AFTER_LOAD)
            System.exit(0);
K
kohsuke 已提交
1487 1488 1489 1490 1491 1492
    }

    /**
     * Save the settings to a file.
     */
    public synchronized void save() throws IOException {
1493
        if(BulkChange.contains(this))   return;
K
kohsuke 已提交
1494 1495 1496 1497 1498 1499 1500 1501 1502
        getConfigFile().write(this);
    }


    /**
     * Called to shut down the system.
     */
    public void cleanUp() {
        terminating = true;
1503 1504 1505
        for( Computer c : computers.values() ) {
            c.interrupt();
            c.kill();
1506
            c.disconnect();
K
kohsuke 已提交
1507 1508 1509
        }
        ExternalJob.reloadThread.interrupt();
        Trigger.timer.cancel();
K
kohsuke 已提交
1510
        Trigger.timer = null;
1511 1512
        if(tcpSlaveAgentListener!=null)
            tcpSlaveAgentListener.shutdown();
K
kohsuke 已提交
1513 1514 1515 1516

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

1517 1518 1519 1520
        if(getRootDir().exists())
            // if we are aborting because we failed to create HUDSON_HOME,
            // don't try to save. Issue #536
            getQueue().save();
1521 1522

        threadPoolForLoad.shutdown();
K
kohsuke 已提交
1523 1524
        
        LogFactory.releaseAll();
1525 1526

        theInstance = null;
K
kohsuke 已提交
1527 1528
    }

K
kohsuke 已提交
1529 1530 1531 1532 1533 1534
    public Object getDynamic(String token, StaplerRequest req, StaplerResponse rsp) {
        for (Action a : getActions())
            if(a.getUrlName().equals(token))
                return a;
        return null;
    }
K
kohsuke 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546


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

            req.setCharacterEncoding("UTF-8");

1551
            JSONObject json = req.getSubmittedForm();
1552

1553 1554 1555
            // keep using 'useSecurity' field as the main configuration setting
            // until we get the new security implementation working
            // useSecurity = null;
1556
            if (json.has("use_security")) {
K
kohsuke 已提交
1557
                useSecurity = true;
K
kohsuke 已提交
1558 1559 1560
                JSONObject security = json.getJSONObject("use_security");
                setSecurityRealm(SecurityRealm.LIST.newInstanceFromRadioList(security,"realm"));
                authorizationStrategy = AuthorizationStrategy.LIST.newInstanceFromRadioList(security,"authorization");
1561 1562
                if(authorizationStrategy==null)
                    authorizationStrategy = AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1563
            } else {
1564
                useSecurity = null;
1565
                setSecurityRealm(SecurityRealm.NO_AUTHENTICATION);
1566
                authorizationStrategy = AuthorizationStrategy.UNSECURED;
K
kohsuke 已提交
1567
            }
K
kohsuke 已提交
1568

1569 1570
            {
                String v = req.getParameter("slaveAgentPortType");
1571
                if(!isUseSecurity() || v==null || v.equals("random"))
1572 1573 1574 1575 1576 1577 1578 1579
                    slaveAgentPort = 0;
                else
                if(v.equals("disable"))
                    slaveAgentPort = -1;
                else {
                    try {
                        slaveAgentPort = Integer.parseInt(req.getParameter("slaveAgentPort"));
                    } catch (NumberFormatException e) {
K
i18n  
kohsuke 已提交
1580
                        throw new FormException(Messages.Hudson_BadPortNumber(req.getParameter("slaveAgentPort")),"slaveAgentPort");
1581 1582
                    }
                }
1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595

                // 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);
                    }
                }
1596 1597
            }

K
kohsuke 已提交
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
            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 )
1617
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1618 1619

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

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

1625
            for( SCMDescriptor scmd : SCMS.SCMS )
K
kohsuke 已提交
1626
                result &= configureDescriptor(req,json,scmd);
K
kohsuke 已提交
1627

1628
            for( TriggerDescriptor d : Triggers.TRIGGERS )
K
kohsuke 已提交
1629
                result &= configureDescriptor(req,json,d);
K
kohsuke 已提交
1630

1631
            for( JobPropertyDescriptor d : Jobs.PROPERTIES )
K
kohsuke 已提交
1632
                result &= configureDescriptor(req,json,d);
1633

1634 1635 1636
            for( JSONObject o : StructuredForm.toList(json,"plugin"))
                pluginManager.getPlugin(o.getString("name")).getPlugin().configure(o);

K
kohsuke 已提交
1637 1638
            save();
            if(result)
1639
                rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
K
kohsuke 已提交
1640 1641 1642 1643 1644 1645 1646
            else
                rsp.sendRedirect("configure"); // back to config
        } catch (FormException e) {
            sendError(e,req,rsp);
        }
    }

1647 1648 1649 1650 1651
    public synchronized void doTestPost( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        JSONObject form = req.getSubmittedForm();
        rsp.sendRedirect("foo");
    }

1652
    private boolean configureDescriptor(StaplerRequest req, JSONObject json, Descriptor<?> d) throws FormException {
1653 1654 1655
        // 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.
1656 1657 1658 1659
        json.putAll(js);
        return d.configure(req, js);
    }

1660 1661 1662 1663
    /**
     * Accepts submission from the configuration page.
     */
    public synchronized void doConfigExecutorsSubmit( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1664
        checkPermission(ADMINISTER);
1665

1666 1667 1668
        BulkChange bc = new BulkChange(this);
        try {
            JSONObject json = req.getSubmittedForm();
1669

1670
            setNumExecutors(Integer.parseInt(req.getParameter("numExecutors")));
1671 1672 1673 1674
            if(req.hasParameter("master.mode"))
                mode = Mode.valueOf(req.getParameter("master.mode"));
            else
                mode = Mode.NORMAL;
S
stephenconnolly 已提交
1675

1676 1677 1678 1679
            setSlaves(req.bindJSONToList(Slave.class,json.get("slaves")));
        } finally {
            bc.commit();
        }
S
stephenconnolly 已提交
1680

1681
        rsp.sendRedirect(req.getContextPath()+'/');  // go to the top page
1682 1683
    }

K
kohsuke 已提交
1684 1685 1686 1687
    /**
     * Accepts the new description.
     */
    public synchronized void doSubmitDescription( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1688
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1689 1690 1691 1692 1693 1694 1695

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

1696
    public synchronized void doQuietDown(StaplerResponse rsp) throws IOException, ServletException {
K
kohsuke 已提交
1697
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1698 1699 1700 1701
        isQuietingDown = true;
        rsp.sendRedirect2(".");
    }

1702
    public synchronized void doCancelQuietDown(StaplerResponse rsp) throws IOException, ServletException {
K
kohsuke 已提交
1703
        checkPermission(ADMINISTER);
K
kohsuke 已提交
1704 1705 1706 1707 1708
        isQuietingDown = false;
        getQueue().scheduleMaintenance();
        rsp.sendRedirect2(".");
    }

1709 1710 1711
    /**
     * Backward compatibility. Redirect to the thread dump.
     */
1712
    public void doClassicThreadDump(StaplerResponse rsp) throws IOException, ServletException {
1713 1714 1715
        rsp.sendRedirect2("threadDump");
    }

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

1719 1720
        TopLevelItem result;

K
kohsuke 已提交
1721 1722 1723 1724 1725 1726
        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");
1727 1728 1729 1730 1731 1732 1733
        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");
        }
1734 1735

        String name = req.getParameter("name");
K
typo.  
kohsuke 已提交
1736
        if(name==null) {
1737 1738 1739 1740
            rsp.sendError(HttpServletResponse.SC_BAD_REQUEST,"Query parameter 'name' is required");
            return null;
        }
        name = name.trim();
K
kohsuke 已提交
1741 1742 1743 1744 1745
        String mode = req.getParameter("mode");

        try {
            checkGoodName(name);
        } catch (ParseException e) {
K
kohsuke 已提交
1746
            rsp.setStatus(SC_BAD_REQUEST);
K
kohsuke 已提交
1747 1748 1749 1750
            sendError(e,req,rsp);
            return null;
        }

1751
        if(getItem(name)!=null) {
K
kohsuke 已提交
1752
            rsp.setStatus(SC_BAD_REQUEST);
K
i18n  
kohsuke 已提交
1753
            sendError(Messages.Hudson_JobAlreadyExists(name),req,rsp);
K
kohsuke 已提交
1754 1755 1756
            return null;
        }

1757
        if(mode!=null && mode.equals("copyJob")) {
1758 1759
            String from = req.getParameter("from");
            TopLevelItem src = getItem(from);
K
kohsuke 已提交
1760
            if(src==null) {
1761 1762 1763 1764 1765
                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 已提交
1766 1767 1768
                return null;
            }

1769
            result = createProject(src.getDescriptor(),name);
K
kohsuke 已提交
1770 1771

            // copy config
1772
            Util.copyFile(Items.getConfigFile(src).getFile(),Items.getConfigFile(result).getFile());
K
kohsuke 已提交
1773 1774

            // reload from the new config
1775
            result = (TopLevelItem)Items.load(this,result.getRootDir());
1776 1777
            result.onCopiedFrom(src);
            items.put(name,result);
1778
        } else {
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
            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 已提交
1804
                    rsp.sendError(SC_BAD_REQUEST);
1805 1806 1807 1808
                    return null;
                }
                result = createProject(Items.getDescriptor(mode), name);
            }
K
kohsuke 已提交
1809 1810
        }

K
kohsuke 已提交
1811
        for (ItemListener l : itemListeners)
1812
            l.onCreated(result);
1813

1814 1815 1816 1817 1818
        if(isXmlSubmission) {
            // it worked
            rsp.setStatus(HttpServletResponse.SC_OK);
        } else {
            // send the browser to the config page
1819
            rsp.sendRedirect2(result.getUrl()+"configure");
1820 1821
        }

K
kohsuke 已提交
1822 1823 1824 1825
        return result;
    }

    public synchronized void doCreateView( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1826
        checkPermission(View.CREATE);
K
kohsuke 已提交
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838

        req.setCharacterEncoding("UTF-8");

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

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

1839
        ListView v = new ListView(this, name);
K
kohsuke 已提交
1840
        if(views==null)
1841
            views = new Vector<ListView>();
K
kohsuke 已提交
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
        views.add(v);
        save();

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

    /**
     * Check if the given name is suitable as a name
     * for job, view, etc.
     *
     * @throws ParseException
     *      if the given name is not good
     */
    public static void checkGoodName(String name) throws ParseException {
        if(name==null || name.length()==0)
K
i18n  
kohsuke 已提交
1858
            throw new ParseException(Messages.Hudson_NoName(),0);
K
kohsuke 已提交
1859 1860 1861

        for( int i=0; i<name.length(); i++ ) {
            char ch = name.charAt(i);
1862 1863 1864
            if(Character.isISOControl(ch)) {
                throw new ParseException(Messages.Hudson_ControlCodeNotAllowed(toPrintableName(name)),i);
            }
K
kohsuke 已提交
1865
            if("?*/\\%!@#$^&|<>[]:;".indexOf(ch)!=-1)
K
i18n  
kohsuke 已提交
1866
                throw new ParseException(Messages.Hudson_UnsafeChar(ch),i);
K
kohsuke 已提交
1867 1868 1869 1870 1871
        }

        // looks good
    }

1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883
    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();
    }

1884
    /**
1885 1886 1887
     * Checks if the user was successfully authenticated.
     *
     * @see BasicAuthenticationFilter
1888 1889
     */
    public void doSecured( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1890 1891
        if(req.getUserPrincipal()==null) {
            // authentication must have failed
1892 1893 1894 1895
            rsp.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

1896
        // the user is now authenticated, so send him back to the target
1897 1898 1899
        String path = req.getContextPath()+req.getRestOfPath();
        String q = req.getQueryString();
        if(q!=null)
1900
            path += '?'+q;
1901

1902
        rsp.sendRedirect2(path);
1903 1904
    }

K
kohsuke 已提交
1905 1906 1907
    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1908
    public void doLoginEntry( StaplerRequest req, StaplerResponse rsp ) throws IOException {
1909 1910
        if(req.getUserPrincipal()==null)
            rsp.sendRedirect2("noPrincipal");
1911 1912

        String from = req.getParameter("from");
1913
        if(from!=null && from.startsWith("/") && !from.equals("/loginError")) {
1914
            rsp.sendRedirect2(from);    // I'm bit uncomfortable letting users redircted to other sites, make sure the URL falls into this domain
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926
            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 已提交
1927 1928 1929 1930 1931
    }

    /**
     * Called once the user logs in. Just forward to the top page.
     */
K
kohsuke 已提交
1932
    public void doLogout( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
1933 1934 1935
        HttpSession session = req.getSession(false);
        if(session!=null)
            session.invalidate();
1936
        SecurityContextHolder.clearContext();
1937 1938 1939 1940 1941 1942

        // 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 已提交
1943 1944 1945
        rsp.sendRedirect2(req.getContextPath()+"/");
    }

1946 1947 1948 1949 1950 1951 1952
    /**
     * Serves jar files for JNLP slave agents.
     */
    public Slave.JnlpJar getJnlpJars(String fileName) {
        return new Slave.JnlpJar(fileName);
    }

K
kohsuke 已提交
1953 1954 1955 1956
    /**
     * RSS feed for log entries.
     */
    public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
1957
        checkPermission(ADMINISTER);
1958

K
kohsuke 已提交
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
        List<LogRecord> logs = logRecords;

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

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

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

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

1986 1987 1988 1989
            public String getEntryDescription(LogRecord entry) {
                return Functions.printLogRecord(entry);
            }

K
kohsuke 已提交
1990 1991 1992 1993 1994
            public Calendar getEntryTimestamp(LogRecord entry) {
                GregorianCalendar cal = new GregorianCalendar();
                cal.setTimeInMillis(entry.getMillis());
                return cal;
            }
1995 1996 1997 1998

            public String getEntryAuthor(LogRecord entry) {
                return Mailer.DESCRIPTOR.getAdminAddress();
            }
K
kohsuke 已提交
1999 2000 2001
        },req,rsp);
    }

K
kohsuke 已提交
2002 2003 2004 2005
    /**
     * Reloads the configuration.
     */
    public synchronized void doReload( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
2006
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2007

2008 2009 2010 2011
        // 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 已提交
2012
        rsp.sendRedirect2(req.getContextPath()+"/");
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024

        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 已提交
2025 2026 2027 2028 2029 2030
    }

    /**
     * Do a finger-print check.
     */
    public void doDoFingerprintCheck( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2031 2032
        // Parse the request
        MultipartFormDataParser p = new MultipartFormDataParser(req);
K
kohsuke 已提交
2033 2034
        try {
            rsp.sendRedirect2(req.getContextPath()+"/fingerprint/"+
2035 2036 2037
                Util.getDigestOf(p.getFileItem("name").getInputStream())+'/');
        } finally {
            p.cleanUp();
K
kohsuke 已提交
2038 2039 2040 2041 2042 2043 2044
        }
    }

    /**
     * Serves static resources without the "Last-Modified" header to work around
     * a bug in Firefox.
     *
K
kohsuke 已提交
2045 2046
     * <p>
     * See https://bugzilla.mozilla.org/show_bug.cgi?id=89419
K
kohsuke 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055
     */
    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 已提交
2056
            rsp.sendError(SC_BAD_REQUEST);
K
kohsuke 已提交
2057 2058 2059 2060 2061
            return;
        }

        File f = new File(req.getServletContext().getRealPath("/images"),path.substring(1));
        if(!f.exists()) {
2062
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076
            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 已提交
2077
        Util.copyStream(in,rsp.getOutputStream());
K
kohsuke 已提交
2078 2079 2080 2081
        in.close();
    }

    /**
K
kohsuke 已提交
2082
     * For debugging. Expose URL to perform GC.
K
kohsuke 已提交
2083
     */
2084
    public void doGc(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2085 2086 2087 2088 2089 2090
        System.gc();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("GCed");
    }

K
kohsuke 已提交
2091 2092 2093 2094 2095
    /**
     * Shutdown the system.
     * @since 1.161
     */
    public void doExit( StaplerRequest req, StaplerResponse rsp ) throws IOException {
K
kohsuke 已提交
2096
        checkPermission(ADMINISTER);
2097
        LOGGER.severe(String.format("Shutting down VM as requested by %s from %s",
K
kohsuke 已提交
2098
                getAuthentication(), req.getRemoteAddr()));
K
kohsuke 已提交
2099 2100 2101 2102 2103
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        PrintWriter w = rsp.getWriter();
        w.println("Shutting down");
        w.close();
2104

K
kohsuke 已提交
2105 2106 2107
        System.exit(0);
    }

K
kohsuke 已提交
2108 2109 2110 2111 2112
    /**
     * Gets the {@link Authentication} object that represents the user
     * associated with the current request.
     */
    public static Authentication getAuthentication() {
K
kohsuke 已提交
2113 2114 2115 2116 2117
        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 已提交
2118 2119
        if(a==null)
            a = new AnonymousAuthenticationToken("anonymous","anonymous",new GrantedAuthority[]{new GrantedAuthorityImpl("anonymous")});
K
kohsuke 已提交
2120
        return a;
K
kohsuke 已提交
2121 2122
    }

2123 2124 2125
    /**
     * Configure the logging level.
     */
2126
    public void doConfigLogger(StaplerResponse rsp, @QueryParameter("name")String name, @QueryParameter("level")String level) throws IOException {
K
kohsuke 已提交
2127
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2128 2129 2130 2131 2132 2133
        Level lv;
        if(level.equals("inherit"))
            lv = null;
        else
            lv = Level.parse(level.toUpperCase());
        Logger.getLogger(name).setLevel(lv);
2134 2135 2136
        rsp.sendRedirect2("log");
    }

K
kohsuke 已提交
2137 2138
    /**
     * For system diagnostics.
K
kohsuke 已提交
2139
     * Run arbitrary Groovy script.
K
kohsuke 已提交
2140 2141
     */
    public void doScript( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
2142 2143
        // ability to run arbitrary script is dangerous
        checkPermission(ADMINISTER);
K
kohsuke 已提交
2144 2145 2146 2147

        String text = req.getParameter("script");
        if(text!=null) {
            try {
2148 2149 2150 2151
                req.setAttribute("output",
                RemotingDiagnostics.executeGroovy(text, MasterComputer.localChannel));
            } catch (InterruptedException e) {
                throw new ServletException(e);
K
kohsuke 已提交
2152 2153 2154 2155 2156 2157
            }
        }

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

K
kohsuke 已提交
2158 2159 2160 2161 2162 2163 2164
    /**
     * 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 已提交
2165 2166 2167
    /**
     * Changes the icon size by changing the cookie
     */
K
kohsuke 已提交
2168 2169
    public void doIconSize( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException {
        String qs = req.getQueryString();
J
jglick 已提交
2170
        if(qs==null || !ICON_SIZE.matcher(qs).matches())
K
kohsuke 已提交
2171
            throw new ServletException();
2172 2173 2174
        Cookie cookie = new Cookie("iconSize", qs);
        cookie.setMaxAge(/* ~4 mo. */9999999); // #762
        rsp.addCookie(cookie);
K
kohsuke 已提交
2175 2176 2177
        String ref = req.getHeader("Referer");
        if(ref==null)   ref=".";
        rsp.sendRedirect2(ref);
K
kohsuke 已提交
2178 2179
    }

2180
    public void doFingerprintCleanup(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2181 2182 2183 2184 2185 2186
        FingerprintCleanupThread.invoke();
        rsp.setStatus(HttpServletResponse.SC_OK);
        rsp.setContentType("text/plain");
        rsp.getWriter().println("Invoked");
    }

2187
    public void doWorkspaceCleanup(StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
        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 已提交
2199
        new FormFieldValidator.WorkspaceDirectory(req,rsp,true).process();
K
kohsuke 已提交
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
    }

    /**
     * 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 已提交
2211
                    error(Messages.Hudson_NotADirectory(f));
K
kohsuke 已提交
2212 2213 2214 2215
                    return;
                }

                File toolsJar = new File(f,"lib/tools.jar");
2216
                File mac = new File(f,"lib/dt.jar");
K
kohsuke 已提交
2217
                if(!toolsJar.exists() && !mac.exists()) {
K
i18n  
kohsuke 已提交
2218
                    error(Messages.Hudson_NotJDKDir(f));
K
kohsuke 已提交
2219 2220 2221 2222 2223 2224 2225 2226
                    return;
                }

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

K
kohsuke 已提交
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242
    /**
     * 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 已提交
2243
                        errorWithMarkup(Messages.Hudson_NoJavaInPath(request.getContextPath()));
K
kohsuke 已提交
2244 2245 2246 2247 2248
                }
            }
        }.process();
    }

K
kohsuke 已提交
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
    /**
     * Checks if the top-level item with the given name exists.
     */
    public void doItemExistsCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        // this method can be used to check if a file exists anywhere in the file system,
        // so it should be protected.
        new FormFieldValidator(req,rsp,true) {
            protected void check() throws IOException, ServletException {
                String job = fixEmpty(request.getParameter("value"));
                if(job==null) {
                    ok(); // nothing is entered yet
                    return;
                }

                if(getItem(job)==null)
                    ok();
                else
K
i18n  
kohsuke 已提交
2266
                    error(Messages.Hudson_JobAlreadyExists(job));
K
kohsuke 已提交
2267 2268 2269
            }
        }.process();
    }
2270 2271 2272 2273 2274
    /**
     * 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.
2275
     * <p/>
2276 2277 2278 2279 2280 2281 2282 2283 2284
     * 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) {
2285

2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
            /**
             * 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().");
2301
                return;
2302
            }
2303

2304 2305 2306 2307 2308 2309 2310 2311 2312
            /**
             * 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")) {
2313
                        NumberFormat.getInstance().parse(value);
2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
                    } 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;
            }
2331

2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
            @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 已提交
2349

K
kohsuke 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373
    /**
     * Performs syntactical check on the remote FS for slaves.
     *
     * TODO: find a better home for this method.
     */
    public void doRemoteFSCheck(StaplerRequest req, StaplerResponse rsp, @QueryParameter("value") final String value) throws IOException, ServletException {
        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();
    }

2374 2375 2376 2377 2378 2379 2380 2381
    /**
     * 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.
     */
2382
    public void doResources(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
2383
        String path = req.getRestOfPath();
2384 2385 2386 2387 2388 2389
        // 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);

2390 2391 2392
        int idx = path.lastIndexOf('.');
        String extension = path.substring(idx+1);
        if(ALLOWED_RESOURCE_EXTENSIONS.contains(extension)) {
2393 2394 2395 2396
            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);
2397 2398 2399 2400 2401 2402
                return;
            }
        }
        rsp.sendError(HttpServletResponse.SC_NOT_FOUND);
    }

S
sogabe 已提交
2403 2404 2405 2406 2407 2408 2409 2410
    /**
     * 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("\\|")
    ));

2411 2412 2413
    /**
     * Checks if container uses UTF-8 to decode URLs. See
     * http://hudson.gotdns.com/wiki/display/HUDSON/Tomcat#Tomcat-i18n
S
sogabe 已提交
2414
     *
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435
     * @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 已提交
2436

2437 2438 2439 2440 2441 2442
    /**
     * 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 已提交
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457

    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 已提交
2458
        for( AbstractProject p : getAllItems(AbstractProject.class) ) {
K
kohsuke 已提交
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
            SCM scm = p.getScm();
            if (scm instanceof CVSSCM) {
                CVSSCM cvsscm = (CVSSCM) scm;
                r.add(cvsscm.getCvsRoot());
            }
        }

        return r;
    }

2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
    /**
     * Rebuilds the dependency map.
     */
    public void rebuildDependencyGraph() {
        dependencyGraph = new DependencyGraph();
    }

    public DependencyGraph getDependencyGraph() {
        return dependencyGraph;
    }

2480 2481 2482 2483 2484
    // for Jelly
    public List<ManagementLink> getManagementLinks() {
        return ManagementLink.LIST;
    }

K
kohsuke 已提交
2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
    /**
     * 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 已提交
2496
    public Object getTarget() {
K
kohsuke 已提交
2497 2498 2499 2500 2501 2502 2503
        try {
            checkPermission(READ);
        } catch (AccessDeniedException e) {
            String rest = Stapler.getCurrentRequest().getRestOfPath();
            if(rest.startsWith("/login")
            || rest.startsWith("/logout")
            || rest.startsWith("/accessDenied")
2504
            || rest.startsWith("/signup")
2505
            || rest.startsWith("/jnlpJars/")
K
kohsuke 已提交
2506 2507 2508 2509
            || rest.startsWith("/securityRealm"))
                return this;    // URLs that are always visible without READ permission
            throw e;
        }
K
kohsuke 已提交
2510 2511 2512
        return this;
    }

K
kohsuke 已提交
2513 2514 2515 2516 2517
    public static final class MasterComputer extends Computer {
        private MasterComputer() {
            super(Hudson.getInstance());
        }

2518 2519 2520 2521 2522 2523 2524
        /**
         * Returns "" to match with {@link Hudson#getNodeName()}.
         */
        public String getName() {
            return "";
        }

K
kohsuke 已提交
2525 2526
        @Override
        public String getDisplayName() {
K
i18n  
kohsuke 已提交
2527
            return Messages.Hudson_Computer_DisplayName();
K
kohsuke 已提交
2528 2529 2530 2531
        }

        @Override
        public String getCaption() {
K
i18n  
kohsuke 已提交
2532
            return Messages.Hudson_Computer_Caption();
K
kohsuke 已提交
2533 2534
        }

K
kohsuke 已提交
2535 2536 2537 2538
        public String getUrl() {
            return "computer/(master)/";
        }

2539
        public RetentionStrategy getRetentionStrategy() {
K
kohsuke 已提交
2540
            return RetentionStrategy.NOOP;
2541 2542
        }

K
kohsuke 已提交
2543 2544 2545 2546 2547
        @Override
        public VirtualChannel getChannel() {
            return localChannel;
        }

K
kohsuke 已提交
2548 2549 2550 2551
        public List<LogRecord> getLogRecords() throws IOException, InterruptedException {
            return logRecords;
        }

K
kohsuke 已提交
2552 2553 2554
        public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
            // this computer never returns null from channel, so
            // this method shall never be invoked.
2555
            rsp.sendError(SC_NOT_FOUND);
K
kohsuke 已提交
2556 2557
        }

2558 2559 2560 2561
        public void launch() {
            // noop
        }

K
kohsuke 已提交
2562 2563 2564 2565 2566 2567
        /**
         * {@link LocalChannel} instance that can be used to execute programs locally.
         */
        public static final LocalChannel localChannel = new LocalChannel(threadPoolForRemoting);
    }

2568 2569 2570 2571
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2572 2573 2574 2575
    public static boolean adminCheck() throws IOException {
        return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse());
    }

2576 2577 2578 2579
    /**
     * @deprecated
     *      Use {@link #checkPermission(Permission)}
     */
K
kohsuke 已提交
2580
    public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException {
K
kohsuke 已提交
2581 2582 2583 2584 2585 2586
        if (isAdmin(req)) return true;

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

K
kohsuke 已提交
2587 2588 2589
    /**
     * Checks if the current user (for which we are processing the current request)
     * has the admin access.
2590 2591
     *
     * @deprecated
K
kohsuke 已提交
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603
     *      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
     *      against. 
K
kohsuke 已提交
2604
     */
K
kohsuke 已提交
2605
    public static boolean isAdmin() {
2606
        return Hudson.getInstance().getACL().hasPermission(ADMINISTER);
K
kohsuke 已提交
2607 2608
    }

2609 2610 2611
    /**
     * @deprecated
     *      Define a custom {@link Permission} and check against ACL.
K
kohsuke 已提交
2612
     *      See {@link #isAdmin()} for more instructions.
2613
     */
K
kohsuke 已提交
2614
    public static boolean isAdmin(StaplerRequest req) {
2615
        return isAdmin();
K
kohsuke 已提交
2616 2617 2618 2619 2620
    }

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

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

2628 2629
    private static final int TWICE_CPU_NUM = Runtime.getRuntime().availableProcessors() * 2;

2630 2631 2632 2633 2634 2635
    /**
     * 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(
2636 2637
        TWICE_CPU_NUM, TWICE_CPU_NUM,
        5L, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>(), new DaemonThreadFactory());
2638 2639 2640



2641 2642 2643
    /**
     * Version number of this Hudson.
     */
2644
    public static String VERSION="?";
2645

2646 2647 2648
    /**
     * Prefix to static resources like images and javascripts in the war file.
     * Either "" or strings like "/static/VERSION", which avoids Hudson to pick up
2649
     * stale cache when the user upgrades to a different version.
2650 2651
     * <p>
     * Value computed in {@link WebAppMain}.
2652
     */
2653
    public static String RESOURCE_PATH = "";
2654

2655 2656 2657 2658
    /**
     * 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.
2659 2660
     * <p>
     * Value computed in {@link WebAppMain}.
2661
     */
2662
    public static String VIEW_RESOURCE_PATH = "/resources/TBD";
2663

2664
    public static boolean parallelLoad = Boolean.getBoolean(Hudson.class.getName()+".parallelLoad");
2665
    public static boolean KILL_AFTER_LOAD = Boolean.getBoolean(Hudson.class.getName()+".killAfterLoad");
2666

K
kohsuke 已提交
2667
    private static final Logger LOGGER = Logger.getLogger(Hudson.class.getName());
2668
    private static final Logger PERFORMANCE_LOGGER = Logger.getLogger(Hudson.class.getName()+".performance");
K
kohsuke 已提交
2669

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

2672
    public static final PermissionGroup PERMISSIONS = new PermissionGroup(Hudson.class,Messages._Hudson_Permissions_Title());
K
kohsuke 已提交
2673 2674
    public static final Permission ADMINISTER = new Permission(PERMISSIONS,"Administer", Permission.FULL_CONTROL);
    public static final Permission READ = new Permission(PERMISSIONS,"Read", Permission.READ);
K
kohsuke 已提交
2675

K
kohsuke 已提交
2676 2677 2678 2679
    static {
        XSTREAM.alias("hudson",Hudson.class);
        XSTREAM.alias("slave",Slave.class);
        XSTREAM.alias("jdk",JDK.class);
2680 2681 2682
        // for backward compatibility with <1.75, recognize the tag name "view" as well.
        XSTREAM.alias("view", ListView.class);
        XSTREAM.alias("listView", ListView.class);
2683 2684
        // this seems to be necessary to force registration of converter early enough
        Mode.class.getEnumConstants();
K
kohsuke 已提交
2685 2686
    }
}