Functions.java 27.6 KB
Newer Older
K
kohsuke 已提交
1 2
package hudson;

3
import hudson.maven.ExecutedMojo;
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
import hudson.model.AbstractProject;
import hudson.model.Action;
import hudson.model.Descriptor;
import hudson.model.Hudson;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Items;
import hudson.model.Job;
import hudson.model.JobPropertyDescriptor;
import hudson.model.ModelObject;
import hudson.model.Node;
import hudson.model.Project;
import hudson.model.Run;
import hudson.model.TopLevelItem;
import hudson.model.View;
K
kohsuke 已提交
19
import hudson.search.SearchableModelObject;
20 21 22 23 24 25
import hudson.security.AccessControlled;
import hudson.security.AuthorizationStrategy;
import hudson.security.Permission;
import hudson.security.SecurityRealm;
import hudson.slaves.ComputerLauncher;
import hudson.slaves.RetentionStrategy;
26 27
import hudson.tasks.BuildStep;
import hudson.tasks.BuildStepDescriptor;
28 29
import hudson.tasks.BuildWrapper;
import hudson.tasks.BuildWrappers;
30 31
import hudson.tasks.Builder;
import hudson.tasks.Publisher;
32
import hudson.util.Area;
33 34
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.apache.commons.jelly.JellyContext;
35
import org.apache.commons.jexl.parser.ASTSizeFunction;
K
kohsuke 已提交
36
import org.apache.commons.jexl.util.Introspector;
K
kohsuke 已提交
37
import org.kohsuke.stapler.Ancestor;
38
import org.kohsuke.stapler.Stapler;
K
kohsuke 已提交
39
import org.kohsuke.stapler.StaplerRequest;
40
import org.kohsuke.stapler.StaplerResponse;
K
kohsuke 已提交
41

42
import javax.servlet.ServletException;
K
kohsuke 已提交
43 44
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
K
kohsuke 已提交
45 46
import javax.servlet.http.HttpServletResponse;
import java.io.File;
K
kohsuke 已提交
47
import java.io.IOException;
48
import java.io.PrintWriter;
49
import java.io.StringWriter;
50 51 52 53 54
import java.lang.management.LockInfo;
import java.lang.management.ManagementFactory;
import java.lang.management.MonitorInfo;
import java.lang.management.ThreadInfo;
import java.lang.management.ThreadMXBean;
K
kohsuke 已提交
55 56
import java.net.URI;
import java.net.URISyntaxException;
K
kohsuke 已提交
57
import java.util.Calendar;
58 59
import java.util.Collection;
import java.util.Collections;
60
import java.util.HashMap;
K
kohsuke 已提交
61 62 63
import java.util.List;
import java.util.Map;
import java.util.SortedMap;
K
kohsuke 已提交
64
import java.util.TreeMap;
K
kohsuke 已提交
65 66
import java.util.logging.LogRecord;
import java.util.logging.SimpleFormatter;
67
import java.util.regex.Pattern;
K
kohsuke 已提交
68 69

/**
K
kohsuke 已提交
70 71 72
 * Utility functions used in views.
 *
 * <p>
73 74
 * An instance of this class is created for each request and made accessible
 * from view pages via the variable 'h' (h stands for Hudson.)
K
kohsuke 已提交
75
 *
K
kohsuke 已提交
76 77 78
 * @author Kohsuke Kawaguchi
 */
public class Functions {
79 80 81 82 83 84 85 86 87
    private static volatile int globalIota = 0;
    private int iota;

    public Functions() {
        iota = globalIota;
        // concurrent requests can use the same ID --- we are just trying to
        // prevent the same user from seeing the same ID repeatedly.
        globalIota+=1000;
    }
K
kohsuke 已提交
88 89 90 91 92 93 94 95

    /**
     * Generates an unique ID.
     */
    public String generateId() {
        return "id"+iota++;
    }

K
kohsuke 已提交
96 97 98 99 100 101 102 103
    public static boolean isModel(Object o) {
        return o instanceof ModelObject;
    }

    public static String xsDate(Calendar cal) {
        return Util.XS_DATETIME_FORMATTER.format(cal.getTime());
    }

104 105 106 107
    public static String rfc822Date(Calendar cal) {
        return Util.RFC822_DATETIME_FORMATTER.format(cal.getTime());
    }

K
kohsuke 已提交
108 109 110 111
    /**
     * Prints the integer as a string that represents difference,
     * like "-5", "+/-0", "+3".
     */
K
kohsuke 已提交
112 113 114 115 116 117 118 119
    public static String getDiffString(int i) {
        if(i==0)    return "\u00B10";   // +/-0
        String s = Integer.toString(i);
        if(i>0)     return "+"+s;
        else        return s;
    }

    /**
120
     * {@link #getDiffString(int)} that doesn't show anything for +/-0
K
kohsuke 已提交
121 122 123 124 125 126 127 128
     */
    public static String getDiffString2(int i) {
        if(i==0)    return "";
        String s = Integer.toString(i);
        if(i>0)     return "+"+s;
        else        return s;
    }

129 130 131 132 133 134 135 136 137 138 139
    /**
     * {@link #getDiffString2(int)} that puts the result into prefix and suffix
     * if there's something to print
     */
    public static String getDiffString2(String prefix, int i, String suffix) {
        if(i==0)    return "";
        String s = Integer.toString(i);
        if(i>0)     return prefix+"+"+s+suffix;
        else        return prefix+s+suffix;
    }

K
kohsuke 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153
    /**
     * Adds the proper suffix.
     */
    public static String addSuffix(int n, String singular, String plural) {
        StringBuffer buf = new StringBuffer();
        buf.append(n).append(' ');
        if(n==1)
            buf.append(singular);
        else
            buf.append(plural);
        return buf.toString();
    }

    public static RunUrl decompose(StaplerRequest req) {
J
jglick 已提交
154
        List<Ancestor> ancestors = req.getAncestors();
155 156 157

        // find the first and last Run instances
        Ancestor f=null,l=null;
K
kohsuke 已提交
158 159
        for (Ancestor anc : ancestors) {
            if(anc.getObject() instanceof Run) {
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
                if(f==null) f=anc;
                l=anc;
            }
        }
        if(l==null) return null;    // there was no Run object

        String head = f.getPrev().getUrl()+'/';
        String base = l.getUrl();

        String reqUri = req.getOriginalRequestURI();
        // despite the spec saying this string is not decoded,
        // Tomcat apparently decodes this string. You see ' ' instead of '%20', which is what
        // the browser has sent. So do some quick scan to see if it's ASCII safe, and if not
        // re-encode it. Otherwise it won't match with ancUrl.
        if(reqUri.indexOf(' ')>=0) {
            try {
                // 3 arg version accepts illegal character. 1-arg version doesn't
                reqUri = new URI(null,reqUri,null).toASCIIString();
            } catch (URISyntaxException e) {
                // try to use reqUri as is.
K
kohsuke 已提交
180 181
            }
        }
182 183 184 185

        String rest = reqUri.substring(f.getUrl().length());

        return new RunUrl( (Run) f.getObject(), head, base, rest);
K
kohsuke 已提交
186 187
    }

188 189 190 191 192 193 194 195 196 197 198
    /**
     * If we know the user's screen resolution, return it. Otherwise null.
     * @since 1.213
     */
    public static Area getScreenResolution() {
        Cookie res = Functions.getCookie(Stapler.getCurrentRequest(),"screenResolution");
        if(res!=null)
            return Area.parse(res.getValue());
        return null;
    }

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    /**
     * URL decomposed for easier computation of relevant URLs.
     *
     * <p>
     * The decomposed URL will be of the form:
     * <pre>
     * aaaaaa/524/bbbbb/cccc
     * -head-| N |---rest---
     * ----- base -----|
     * </pre>
     *
     * <p>
     * The head portion is the part of the URL from the {@link Hudson}
     * object to the first {@link Run} subtype. When "next/prev build"
     * is chosen, this part remains intact.
     *
     * <p>
     * The <tt>524</tt> is the path from {@link Job} to {@link Run}.
     *
     * <p>
     * The <tt>bbb</tt> portion is the path after that till the last
     * {@link Run} subtype. The <tt>ccc</tt> portion is the part
     * after that.
     */
K
kohsuke 已提交
223
    public static final class RunUrl {
224
        private final String head, base, rest;
K
kohsuke 已提交
225 226
        private final Run run;

227 228

        public RunUrl(Run run, String head, String base, String rest) {
K
kohsuke 已提交
229
            this.run = run;
230 231
            this.head = head;
            this.base = base;
K
kohsuke 已提交
232 233 234 235
            this.rest = rest;
        }

        public String getBaseUrl() {
236
            return base;
K
kohsuke 已提交
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
        }

        /**
         * Returns the same page in the next build.
         */
        public String getNextBuildUrl() {
            return getUrl(run.getNextBuild());
        }

        /**
         * Returns the same page in the previous build.
         */
        public String getPreviousBuildUrl() {
            return getUrl(run.getPreviousBuild());
        }

        private String getUrl(Run n) {
            if(n ==null)
                return null;
            else {
257
                return head+n.getNumber()+rest;
K
kohsuke 已提交
258 259 260 261 262 263
            }
        }
    }

    public static Node.Mode[] getNodeModes() {
        return Node.Mode.values();
264 265
    }

K
kohsuke 已提交
266
    public static String getProjectListString(List<Project> projects) {
267
        return Items.toNameList(projects);
K
kohsuke 已提交
268 269 270 271 272
    }

    public static Object ifThenElse(boolean cond, Object thenValue, Object elseValue) {
        return cond ? thenValue : elseValue;
    }
273

K
kohsuke 已提交
274 275 276 277 278
    public static String appendIfNotNull(String text, String suffix, String nullText) {
        return text == null ? nullText : text + suffix;
    }

    public static Map getSystemProperties() {
J
jglick 已提交
279
        return new TreeMap<Object,Object>(System.getProperties());
K
kohsuke 已提交
280 281 282
    }

    public static Map getEnvVars() {
J
jglick 已提交
283
        return new TreeMap<String,String>(EnvVars.masterEnvVars);
K
kohsuke 已提交
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    }

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

    public static List<LogRecord> getLogRecords() {
        return Hudson.logRecords;
    }

    public static String printLogRecord(LogRecord r) {
        return formatter.format(r);
    }

    public static Cookie getCookie(HttpServletRequest req,String name) {
        Cookie[] cookies = req.getCookies();
        if(cookies!=null) {
            for (Cookie cookie : cookies) {
                if(cookie.getName().equals(name)) {
                    return cookie;
                }
            }
        }
        return null;
    }

K
kohsuke 已提交
310 311 312 313 314 315
    public static String getCookie(HttpServletRequest req,String name, String defaultValue) {
        Cookie c = getCookie(req, name);
        if(c==null || c.getValue()==null) return defaultValue;
        return c.getValue();
    }

K
kohsuke 已提交
316 317 318 319 320 321 322 323 324 325
    /**
     * Gets the suffix to use for YUI JavaScript.
     */
    public static String getYuiSuffix() {
        return DEBUG_YUI ? "debug" : "min";
    }

    /**
     * Set to true if you need to use the debug version of YUI.
     */
K
kohsuke 已提交
326
    public static boolean DEBUG_YUI = System.getProperty("debug.YUI")!=null;
K
kohsuke 已提交
327

K
kohsuke 已提交
328 329 330 331 332 333 334 335 336 337 338 339 340 341
    /**
     * Creates a sub map by using the given range (both ends inclusive).
     */
    public static <V> SortedMap<Integer,V> filter(SortedMap<Integer,V> map, String from, String to) {
        if(from==null && to==null)      return map;
        if(to==null)
            return map.headMap(Integer.parseInt(from)-1);
        if(from==null)
            return map.tailMap(Integer.parseInt(to));

        return map.subMap(Integer.parseInt(to),Integer.parseInt(from)-1);
    }

    private static final SimpleFormatter formatter = new SimpleFormatter();
342

K
kohsuke 已提交
343 344 345 346 347
    /**
     * Used by <tt>layout.jelly</tt> to control the auto refresh behavior.
     *
     * @param noAutoRefresh
     *      On certain pages, like a page with forms, will have annoying interference
348
     *      with auto refresh. On those pages, disable auto-refresh.
K
kohsuke 已提交
349 350 351 352 353
     */
    public static void configureAutoRefresh(HttpServletRequest request, HttpServletResponse response, boolean noAutoRefresh) {
        if(noAutoRefresh)
            return;

354 355 356 357 358 359 360 361 362
        String param = request.getParameter("auto_refresh");
        boolean refresh = isAutoRefresh(request);
        if (param != null) {
            refresh = Boolean.parseBoolean(param);
            Cookie c = new Cookie("hudson_auto_refresh", Boolean.toString(refresh));
            // Need to set path or it will not stick from e.g. a project page to the dashboard.
            // Using request.getContextPath() might work but it seems simpler to just use the hudson_ prefix
            // to avoid conflicts with any other web apps that might be on the same machine.
            c.setPath("/");
K
kohsuke 已提交
363
            c.setMaxAge(60*60*24*30); // persist it roughly for a month
364 365 366 367 368 369 370 371 372 373 374 375
            response.addCookie(c);
        }
        if (refresh) {
            response.addHeader("Refresh", "10");
        }
    }

    public static boolean isAutoRefresh(HttpServletRequest request) {
        String param = request.getParameter("auto_refresh");
        if (param != null) {
            return Boolean.parseBoolean(param);
        }
K
kohsuke 已提交
376 377 378 379 380
        Cookie[] cookies = request.getCookies();
        if(cookies==null)
            return false; // when API design messes it up, we all suffer

        for (Cookie c : cookies) {
381 382 383 384 385 386
            if (c.getName().equals("hudson_auto_refresh")) {
                return Boolean.parseBoolean(c.getValue());
            }
        }
        return false;
    }
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

    /**
     * Finds the given object in the ancestor list and returns its URL.
     * This is used to determine the "current" URL assigned to the given object,
     * so that one can compute relative URLs from it.
     */
    public static String getNearestAncestorUrl(StaplerRequest req,Object it) {
        List list = req.getAncestors();
        for( int i=list.size()-1; i>=0; i-- ) {
            Ancestor anc = (Ancestor) list.get(i);
            if(anc.getObject()==it)
                return anc.getUrl();
        }
        return null;
    }
K
kohsuke 已提交
402

K
kohsuke 已提交
403 404 405 406 407 408 409 410
    /**
     * Finds the inner-most {@link SearchableModelObject} in scope.
     */
    public static String getSearchURL() {
        List list = Stapler.getCurrentRequest().getAncestors();
        for( int i=list.size()-1; i>=0; i-- ) {
            Ancestor anc = (Ancestor) list.get(i);
            if(anc.getObject() instanceof SearchableModelObject)
K
bug fix  
kohsuke 已提交
411
                return anc.getUrl()+"/search/";
K
kohsuke 已提交
412 413 414 415
        }
        return null;
    }

K
kohsuke 已提交
416 417 418 419
    public static String appendSpaceIfNotNull(String n) {
        if(n==null) return null;
        else        return n+' ';
    }
K
kohsuke 已提交
420 421 422 423

    public static String getWin32ErrorMessage(IOException e) {
        return Util.getWin32ErrorMessage(e);
    }
424 425

    public static boolean isMultiline(String s) {
K
kohsuke 已提交
426
        if(s==null)     return false;
427 428
        return s.indexOf('\r')>=0 || s.indexOf('\n')>=0;
    }
K
kohsuke 已提交
429 430 431 432

    public static String encode(String s) {
        return Util.encode(s);
    }
433

K
kohsuke 已提交
434 435 436 437
    public static String escape(String s) {
        return Util.escape(s);
    }

K
kohsuke 已提交
438 439 440 441
    public static String xmlEscape(String s) {
        return Util.xmlEscape(s);
    }

K
kohsuke 已提交
442
    public static void checkPermission(Permission permission) throws IOException, ServletException {
443
        checkPermission(Hudson.getInstance(),permission);
444 445 446 447
    }

    public static void checkPermission(AccessControlled object, Permission permission) throws IOException, ServletException {
        if (permission != null) {
K
TAB->WS  
kohsuke 已提交
448
            object.checkPermission(permission);
449
        }
K
kohsuke 已提交
450 451 452 453
    }

    /**
     * Returns true if the current user has the given permission.
454 455 456
     *
     * @param permission
     *      If null, returns true. This defaulting is convenient in making the use of this method terse.
K
kohsuke 已提交
457 458
     */
    public static boolean hasPermission(Permission permission) throws IOException, ServletException {
459
        return hasPermission(Hudson.getInstance(),permission);
K
kohsuke 已提交
460 461
    }

462 463 464 465
    public static boolean hasPermission(AccessControlled object, Permission permission) throws IOException, ServletException {
        return permission==null || object.hasPermission(permission);
    }

466 467 468
    public static void adminCheck(StaplerRequest req, StaplerResponse rsp, Object required, Permission permission) throws IOException, ServletException {
        // this is legacy --- all views should be eventually converted to
        // the permission based model.
K
kohsuke 已提交
469
        if(required!=null && !Hudson.adminCheck(req,rsp)) {
470 471 472
            // check failed. commit the FORBIDDEN response, then abort.
            rsp.setStatus(HttpServletResponse.SC_FORBIDDEN);
            rsp.getOutputStream().close();
473 474
            throw new ServletException("Unauthorized access");
        }
475 476

        // make sure the user owns the necessary permission to access this page.
477
        if(permission!=null)
K
kohsuke 已提交
478
            checkPermission(permission);
479
    }
K
kohsuke 已提交
480 481 482 483 484

    /**
     * Infers the hudson installation URL from the given request.
     */
    public static String inferHudsonURL(StaplerRequest req) {
485 486 487 488
        String rootUrl = Hudson.getInstance().getRootUrl();
        if(rootUrl !=null)
            // prefer the one explicitly configured, to work with load-balancer, frontend, etc.
            return rootUrl;
K
kohsuke 已提交
489 490 491 492 493
        StringBuilder buf = new StringBuilder();
        buf.append(req.getScheme()).append("://");
        buf.append(req.getServerName());
        if(req.getLocalPort()!=80)
            buf.append(':').append(req.getLocalPort());
K
kohsuke 已提交
494
        buf.append(req.getContextPath()).append('/');
K
kohsuke 已提交
495 496
        return buf.toString();
    }
497 498 499 500

    public static List<JobPropertyDescriptor> getJobPropertyDescriptors(Class<? extends Job> clazz) {
        return JobPropertyDescriptor.getPropertyDescriptors(clazz);
    }
501

502 503 504 505
    public static List<Descriptor<BuildWrapper>> getBuildWrapperDescriptors(AbstractProject<?,?> project) {
        return BuildWrappers.getFor(project);
    }

506
    public static List<Descriptor<SecurityRealm>> getSecurityRealmDescriptors() {
507 508 509
        return SecurityRealm.LIST;
    }

510 511 512 513
    public static List<Descriptor<AuthorizationStrategy>> getAuthorizationStrategyDescriptors() {
        return AuthorizationStrategy.LIST;
    }

514
    public static List<Descriptor<Builder>> getBuilderDescriptors(AbstractProject<?,?> project) {
515
        return BuildStepDescriptor.filter(BuildStep.BUILDERS, project.getClass());
516 517 518
    }

    public static List<Descriptor<Publisher>> getPublisherDescriptors(AbstractProject<?,?> project) {
519
        return BuildStepDescriptor.filter(BuildStep.PUBLISHERS, project.getClass());
520 521
    }

522
    public static List<Descriptor<ComputerLauncher>> getComputerLauncherDescriptors() {
523
        return ComputerLauncher.LIST;
524 525
    }

526
    public static List<Descriptor<RetentionStrategy<?>>> getRetentionStrategyDescriptors() {
527
        return RetentionStrategy.LIST;
528 529
    }

530 531 532 533 534 535 536 537 538 539 540
    /**
     * Computes the path to the icon of the given action
     * from the context path.
     */
    public static String getIconFilePath(Action a) {
        String name = a.getIconFileName();
        if(name.startsWith("/"))
            return name.substring(1);
        else
            return "images/24x24/"+name;
    }
K
kohsuke 已提交
541 542 543 544 545

    /**
     * Works like JSTL build-in size(x) function,
     * but handle null gracefully.
     */
K
kohsuke 已提交
546
    public static int size2(Object o) throws Exception {
K
kohsuke 已提交
547
        if(o==null) return 0;
K
kohsuke 已提交
548
        return ASTSizeFunction.sizeOf(o,Introspector.getUberspect());
K
kohsuke 已提交
549
    }
K
kohsuke 已提交
550 551 552 553

    public static ExecutedMojo.Cache createExecutedMojoCache() {
        return new ExecutedMojo.Cache();
    }
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595

    /**
     * Computes the relative path from the current page to the given item.
     */
    public static String getRelativeLinkTo(Item p) {
        Map<Object,String> ancestors = new HashMap<Object,String>();
        View view=null;

        StaplerRequest request = Stapler.getCurrentRequest();
        for( Ancestor a : request.getAncestors() ) {
            ancestors.put(a.getObject(),a.getRelativePath());
            if(a.getObject() instanceof View)
                view = (View) a.getObject();
        }

        String path = ancestors.get(p);
        if(path!=null)  return path;

        Item i=p;
        String url = "";
        while(true) {
            ItemGroup ig = i.getParent();
            url = i.getShortUrl()+url;

            if(ig==Hudson.getInstance()) {
                assert i instanceof TopLevelItem;
                if(view!=null && view.contains((TopLevelItem)i)) {
                    // if p and the current page belongs to the same view, then return a relative path
                    return ancestors.get(view)+'/'+url;
                } else {
                    // otherwise return a path from the root Hudson
                    return request.getContextPath()+'/'+p.getUrl();
                }
            }

            path = ancestors.get(ig);
            if(path!=null)  return path+'/'+url;

            assert ig instanceof Item; // if not, ig must have been the Hudson instance
            i = (Item) ig;
        }
    }
596

K
kohsuke 已提交
597
    public static Map<Thread,StackTraceElement[]> dumpAllThreads() {
598 599
        return Thread.getAllStackTraces();
    }
600

K
kohsuke 已提交
601
    public static ThreadInfo[] getThreadInfos() {
602 603 604 605
        ThreadMXBean mbean = ManagementFactory.getThreadMXBean();
        return mbean.getThreadInfo(mbean.getAllThreadIds(),mbean.isObjectMonitorUsageSupported(),mbean.isSynchronizerUsageSupported());
    }

606 607 608 609 610 611 612 613 614 615 616 617
    /**
     * Are we running on JRE6 or above?
     */
    public static boolean isMustangOrAbove() {
        try {
            System.console();
            return true;
        } catch(LinkageError e) {
            return false;
        }
    }

618
    // ThreadInfo.toString() truncates the stack trace by first 8, so needed my own version
K
kohsuke 已提交
619
    public static String dumpThreadInfo(ThreadInfo ti) {
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
        StringBuilder sb = new StringBuilder("\"" + ti.getThreadName() + "\"" +
                                             " Id=" + ti.getThreadId() + " " +
                                             ti.getThreadState());
        if (ti.getLockName() != null) {
            sb.append(" on " + ti.getLockName());
        }
        if (ti.getLockOwnerName() != null) {
            sb.append(" owned by \"" + ti.getLockOwnerName() +
                      "\" Id=" + ti.getLockOwnerId());
        }
        if (ti.isSuspended()) {
            sb.append(" (suspended)");
        }
        if (ti.isInNative()) {
            sb.append(" (in native)");
        }
        sb.append('\n');
        StackTraceElement[] stackTrace = ti.getStackTrace();
        for (int i=0; i < stackTrace.length; i++) {
            StackTraceElement ste = stackTrace[i];
            sb.append("\tat " + ste.toString());
            sb.append('\n');
            if (i == 0 && ti.getLockInfo() != null) {
                Thread.State ts = ti.getThreadState();
                switch (ts) {
                    case BLOCKED:
                        sb.append("\t-  blocked on " + ti.getLockInfo());
                        sb.append('\n');
                        break;
                    case WAITING:
                        sb.append("\t-  waiting on " + ti.getLockInfo());
                        sb.append('\n');
                        break;
                    case TIMED_WAITING:
                        sb.append("\t-  waiting on " + ti.getLockInfo());
                        sb.append('\n');
                        break;
                    default:
                }
            }

            for (MonitorInfo mi : ti.getLockedMonitors()) {
                if (mi.getLockedStackDepth() == i) {
                    sb.append("\t-  locked " + mi);
                    sb.append('\n');
                }
            }
       }

       LockInfo[] locks = ti.getLockedSynchronizers();
       if (locks.length > 0) {
           sb.append("\n\tNumber of locked synchronizers = " + locks.length);
           sb.append('\n');
           for (LockInfo li : locks) {
               sb.append("\t- " + li);
               sb.append('\n');
           }
       }
       sb.append('\n');
       return sb.toString();
    }
681 682 683 684

    public static <T> Collection<T> emptyList() {
        return Collections.emptyList();
    }
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

    public static String jsStringEscape(String s) {
        StringBuilder buf = new StringBuilder();
        for( int i=0; i<s.length(); i++ ) {
            char ch = s.charAt(i);
            switch(ch) {
            case '\'':
                buf.append("\\'");
                break;
            case '\\':
                buf.append("\\\\");
                break;
            case '"':
                buf.append("\\\"");
                break;
            default:
                buf.append(ch);
            }
        }
        return buf.toString();
    }
K
kohsuke 已提交
706

K
kohsuke 已提交
707 708 709 710
    public static String getVersion() {
        return Hudson.VERSION;
    }

711 712 713 714 715 716
    /**
     * Resoruce path prefix.
     */
    public static String getResourcePath() {
        return Hudson.RESOURCE_PATH;
    }
717

718 719 720 721 722 723 724 725
    public static String getViewResource(Object it, String path) {
        Class clazz = it.getClass();

        if(it instanceof Class)
            clazz = (Class)it;
        if(it instanceof Descriptor)
            clazz = ((Descriptor)it).clazz;

726
        StringBuilder buf = new StringBuilder(Stapler.getCurrentRequest().getContextPath());
727 728 729 730 731 732 733
        buf.append(Hudson.VIEW_RESOURCE_PATH).append('/');
        buf.append(clazz.getName().replace('.','/').replace('$','/'));
        buf.append('/').append(path);

        return buf.toString();
    }

734 735 736 737 738 739 740 741 742
    /**
     * Can be used to check a checkbox by default.
     * Used from views like {@code h.defaultToTrue(scm.useUpdate)}.
     * The expression will evaluate to true if scm is null.
     */
    public static boolean defaultToTrue(Boolean b) {
        if(b==null) return true;
        return b;
    }
743

K
kohsuke 已提交
744 745 746 747 748 749 750
    /**
     * If the value exists, return that value. Otherwise return the default value.
     * <p>
     * This method is useful for supplying a default value to a form field.
     *
     * @since 1.150
     */
K
kohsuke 已提交
751
    public static <T> T defaulted(T value, T defaultValue) {
K
kohsuke 已提交
752 753 754
        return value!=null ? value : defaultValue;
    }

755 756 757 758 759
    public static String printThrowable(Throwable t) {
        StringWriter sw = new StringWriter();
        t.printStackTrace(new PrintWriter(sw));
        return sw.toString();
    }
760 761 762 763 764 765 766 767 768 769

    /**
     * Counts the number of rows needed for textarea to fit the content.
     * Minimum 5 rows.
     */
    public static int determineRows(String s) {
        if(s==null)     return 5;
        return Math.max(5,LINE_END.split(s).length);
    }

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    /**
     * Converts the Hudson build status to CruiseControl build status,
     * which is either Success, Failure, Exception, or Unknown.
     */
    public static String toCCStatus(Item i) {
        if (i instanceof Job) {
            Job j = (Job) i;
            switch (j.getIconColor().noAnime()) {
            case ABORTED:
            case RED:
            case YELLOW:
                return "Failure";
            case BLUE:
                return "Success";
            case DISABLED:
            case GREY:
                return "Unknown";
            }
        }
        return "Unknown";
    }

792
    private static final Pattern LINE_END = Pattern.compile("\r?\n");
K
kohsuke 已提交
793 794 795 796 797 798 799

    /**
     * Checks if the current user is anonymous.
     */
    public static boolean isAnonymous() {
        return Hudson.getAuthentication() instanceof AnonymousAuthenticationToken;
    }
800 801 802 803 804 805 806 807 808 809 810 811 812

    /**
     * When called from within JEXL expression evaluation,
     * this method returns the current {@link JellyContext} used
     * to evaluate the script.
     *
     * @since 1.164
     */
    public static JellyContext getCurrentJellyContext() {
        JellyContext context = ExpressionFactory2.CURRENT_CONTEXT.get();
        assert context!=null;
        return context;
    }
813 814 815 816 817 818 819 820 821 822

    /**
     * Returns a sub-list if the given list is bigger than the specified 'maxSize'
     */
    public static <T> List<T> subList(List<T> base, int maxSize) {
        if(maxSize<base.size())
            return base.subList(0,maxSize);
        else
            return base;
    }
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837

    /**
     * Computes the hyperlink to actions, to handle the situation when the {@link Action#getUrlName()}
     * returns absolute URL.
     */
    public static String getActionUrl(String itUrl,Action action) {
        String urlName = action.getUrlName();

        if(SCHEME.matcher(urlName).matches())
            return urlName; // absolute URL
        else
            // relative URL name
            return Stapler.getCurrentRequest().getContextPath()+'/'+itUrl+urlName;
    }

K
kohsuke 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
    /**
     * Escapes the character unsafe for e-mail address.
     * See http://en.wikipedia.org/wiki/E-mail_address for the details,
     * but here the vocabulary is even more restricted.
     */
    public static String toEmailSafeString(String projectName) {
        // TODO: escape non-ASCII characters
        StringBuilder buf = new StringBuilder(projectName.length());
        for( int i=0; i<projectName.length(); i++ ) {
            char ch = projectName.charAt(i);
            if(('a'<=ch && ch<='z')
            || ('z'<=ch && ch<='Z')
            || ('0'<=ch && ch<='9')
            || "-_.".indexOf(ch)>=0)
                buf.append(ch);
            else
                buf.append('_');    // escape
        }
        return projectName;
    }

859 860 861 862
    public String getSystemProperty(String key) {
        return System.getProperty(key);
    }

863
    private static final Pattern SCHEME = Pattern.compile("[a-z]+://.+");
K
kohsuke 已提交
864
}