Functions.java 62.0 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
4
 * Copyright (c) 2004-2010, Sun Microsystems, Inc., Kohsuke Kawaguchi,
5 6
 * Yahoo! Inc., Stephen Connolly, Tom Huybrechts, Alan Harder, Manufacture
 * Francaise des Pneumatiques Michelin, Romain Seguy
K
kohsuke 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
K
kohsuke 已提交
26 27
package hudson;

28
import hudson.cli.CLICommand;
K
kohsuke 已提交
29 30
import hudson.console.ConsoleAnnotationDescriptor;
import hudson.console.ConsoleAnnotatorFactory;
31
import hudson.matrix.MatrixProject;
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
import hudson.model.AbstractProject;
import hudson.model.Action;
import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.model.DescriptorVisibilityFilter;
import hudson.model.Hudson;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Items;
import hudson.model.JDK;
import hudson.model.Job;
import hudson.model.JobPropertyDescriptor;
import hudson.model.ModelObject;
import hudson.model.Node;
import hudson.model.PageDecorator;
import hudson.model.ParameterDefinition;
48
import hudson.model.ParameterDefinition.ParameterDescriptor;
49 50 51 52 53 54 55
import hudson.model.Project;
import hudson.model.Run;
import hudson.model.TopLevelItem;
import hudson.model.User;
import hudson.model.View;
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
K
kohsuke 已提交
56
import hudson.search.SearchableModelObject;
57 58
import hudson.security.AccessControlled;
import hudson.security.AuthorizationStrategy;
59
import hudson.security.GlobalSecurityConfiguration;
60 61
import hudson.security.Permission;
import hudson.security.SecurityRealm;
62
import hudson.security.captcha.CaptchaSupport;
63
import hudson.security.csrf.CrumbIssuer;
64
import hudson.slaves.Cloud;
65
import hudson.slaves.ComputerLauncher;
66 67
import hudson.slaves.NodeProperty;
import hudson.slaves.NodePropertyDescriptor;
68
import hudson.slaves.RetentionStrategy;
69
import hudson.tasks.BuildStepDescriptor;
70 71
import hudson.tasks.BuildWrapper;
import hudson.tasks.BuildWrappers;
72 73
import hudson.tasks.Builder;
import hudson.tasks.Publisher;
74
import hudson.tasks.UserAvatarResolver;
75
import hudson.util.Area;
76
import hudson.util.Iterators;
77
import hudson.util.Secret;
W
wjprakash 已提交
78 79
import hudson.views.MyViewsTabBar;
import hudson.views.ViewsTabBar;
80
import hudson.widgets.RenderOnDemandClosure;
K
kohsuke 已提交
81

K
kohsuke 已提交
82
import java.io.File;
K
kohsuke 已提交
83
import java.io.IOException;
84
import java.io.PrintWriter;
85
import java.io.StringWriter;
K
kohsuke 已提交
86
import java.io.UnsupportedEncodingException;
87 88 89 90 91
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 已提交
92
import java.lang.reflect.ParameterizedType;
93
import java.lang.reflect.Type;
94
import java.net.MalformedURLException;
95 96
import java.net.URI;
import java.net.URISyntaxException;
97
import java.net.URL;
K
kohsuke 已提交
98
import java.net.URLDecoder;
L
lvotypko 已提交
99
import java.text.DecimalFormat;
100
import java.util.ArrayList;
101
import java.util.Arrays;
K
kohsuke 已提交
102
import java.util.Calendar;
103 104
import java.util.Collection;
import java.util.Collections;
105
import java.util.Comparator;
106
import java.util.ConcurrentModificationException;
107
import java.util.Date;
108
import java.util.Enumeration;
109
import java.util.HashMap;
K
kohsuke 已提交
110
import java.util.List;
K
Kohsuke Kawaguchi 已提交
111
import java.util.Locale;
K
kohsuke 已提交
112 113
import java.util.Map;
import java.util.SortedMap;
K
kohsuke 已提交
114
import java.util.TreeMap;
115
import java.util.logging.Level;
116
import java.util.logging.LogManager;
K
kohsuke 已提交
117
import java.util.logging.LogRecord;
118
import java.util.logging.Logger;
K
kohsuke 已提交
119
import java.util.logging.SimpleFormatter;
120
import java.util.regex.Pattern;
121 122 123 124 125 126 127 128 129 130

import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import jenkins.model.GlobalConfiguration;
import jenkins.model.GlobalConfigurationCategory;
import jenkins.model.GlobalConfigurationCategory.Unclassified;
import jenkins.model.Jenkins;
131
import jenkins.model.ModelObjectWithChildren;
132 133 134 135 136 137 138 139 140
import jenkins.model.ModelObjectWithContextMenu;

import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.apache.commons.jelly.JellyContext;
import org.apache.commons.jelly.JellyTagException;
import org.apache.commons.jelly.Script;
import org.apache.commons.jelly.XMLOutput;
import org.apache.commons.jexl.parser.ASTSizeFunction;
import org.apache.commons.jexl.util.Introspector;
141
import org.apache.commons.lang.StringUtils;
142 143 144 145 146 147 148 149 150 151
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
import org.jvnet.tiger_types.Types;
import org.kohsuke.stapler.Ancestor;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.jelly.InternationalizedStringExpression.RawHtmlArgument;

import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
K
kohsuke 已提交
152 153

/**
K
kohsuke 已提交
154 155 156
 * Utility functions used in views.
 *
 * <p>
157 158
 * 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 已提交
159
 *
K
kohsuke 已提交
160 161
 * @author Kohsuke Kawaguchi
 */
162
@SuppressWarnings("rawtypes")
K
kohsuke 已提交
163
public class Functions {
164 165 166 167 168 169 170 171 172
    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 已提交
173 174 175 176 177 178 179 180

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

K
kohsuke 已提交
181 182 183 184
    public static boolean isModel(Object o) {
        return o instanceof ModelObject;
    }

185 186 187 188
    public static boolean isModelWithContextMenu(Object o) {
        return o instanceof ModelObjectWithContextMenu;
    }

189 190 191
    public static boolean isModelWithChildren(Object o) {
        return o instanceof ModelObjectWithChildren;
    }
192
    
C
Christoph Kutzinski 已提交
193 194 195
    /**
     * @since 1.524
     */
196 197 198
    public static boolean isMatrixProject(Object o) {
        return o instanceof MatrixProject;
    }
199

K
kohsuke 已提交
200 201 202 203
    public static String xsDate(Calendar cal) {
        return Util.XS_DATETIME_FORMATTER.format(cal.getTime());
    }

204 205 206
    public static String rfc822Date(Calendar cal) {
        return Util.RFC822_DATETIME_FORMATTER.format(cal.getTime());
    }
207 208 209
    
    public static void initPageVariables(JellyContext context) {
        String rootURL = Stapler.getCurrentRequest().getContextPath();
K
Kohsuke Kawaguchi 已提交
210

211
        Functions h = new Functions();
K
Kohsuke Kawaguchi 已提交
212 213
        context.setVariable("h", h);

214

K
Kohsuke Kawaguchi 已提交
215
        // The path starts with a "/" character but does not end with a "/" character.
216
        context.setVariable("rootURL", rootURL);
K
Kohsuke Kawaguchi 已提交
217 218 219 220 221 222 223

        /*
            load static resources from the path dedicated to a specific version.
            This "/static/VERSION/abc/def.ghi" path is interpreted by stapler to be
            the same thing as "/abc/def.ghi", but this avoids the stale cache
            problem when the user upgrades to new Jenkins. Stapler also sets a long
            future expiration dates for such static resources.
K
Kohsuke Kawaguchi 已提交
224 225

            see https://wiki.jenkins-ci.org/display/JENKINS/Hyperlinks+in+HTML
K
Kohsuke Kawaguchi 已提交
226
         */
227 228 229
        context.setVariable("resURL",rootURL+getResourcePath());
        context.setVariable("imagesURL",rootURL+getResourcePath()+"/images");
    }
230

K
kohsuke 已提交
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    /**
     * Given {@code c=MyList (extends ArrayList<Foo>), base=List}, compute the parameterization of 'base'
     * that's assignable from 'c' (in this case {@code List<Foo>}), and return its n-th type parameter
     * (n=0 would return {@code Foo}).
     *
     * <p>
     * This method is useful for doing type arithmetic.
     *
     * @throws AssertionError
     *      if c' is not parameterized.
     */
    public static <B> Class getTypeParameter(Class<? extends B> c, Class<B> base, int n) {
        Type parameterization = Types.getBaseClass(c,base);
        if (parameterization instanceof ParameterizedType) {
            ParameterizedType pt = (ParameterizedType) parameterization;
            return Types.erasure(Types.getTypeArgument(pt,n));
        } else {
            throw new AssertionError(c+" doesn't properly parameterize "+base);
        }
    }

    public JDK.DescriptorImpl getJDKDescriptor() {
253
        return Jenkins.getInstance().getDescriptorByType(JDK.DescriptorImpl.class);
K
kohsuke 已提交
254 255
    }

K
kohsuke 已提交
256 257 258 259
    /**
     * Prints the integer as a string that represents difference,
     * like "-5", "+/-0", "+3".
     */
K
kohsuke 已提交
260 261 262 263 264 265 266 267
    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;
    }

    /**
268
     * {@link #getDiffString(int)} that doesn't show anything for +/-0
K
kohsuke 已提交
269 270 271 272 273 274 275 276
     */
    public static String getDiffString2(int i) {
        if(i==0)    return "";
        String s = Integer.toString(i);
        if(i>0)     return "+"+s;
        else        return s;
    }

277 278 279 280 281 282 283 284 285 286 287
    /**
     * {@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 已提交
288 289 290 291
    /**
     * Adds the proper suffix.
     */
    public static String addSuffix(int n, String singular, String plural) {
K
kohsuke 已提交
292
        StringBuilder buf = new StringBuilder();
K
kohsuke 已提交
293 294 295 296 297 298 299 300 301
        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 已提交
302
        List<Ancestor> ancestors = req.getAncestors();
303 304 305

        // find the first and last Run instances
        Ancestor f=null,l=null;
K
kohsuke 已提交
306 307
        for (Ancestor anc : ancestors) {
            if(anc.getObject() instanceof Run) {
308 309 310 311 312 313 314 315 316 317
                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();
318 319 320 321 322 323 324 325 326 327 328 329
        // Find "rest" or URI by removing N path components.
        // Not using reqUri.substring(f.getUrl().length()) to avoid mismatches due to
        // url-encoding or extra slashes.  Former may occur in Tomcat (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), latter may occur in some
        // proxy or URL-rewriting setups where extra slashes are inadvertently added.
        String furl = f.getUrl();
        int slashCount = 0;
        // Count components in ancestor URL
        for (int i = furl.indexOf('/'); i >= 0; i = furl.indexOf('/', i + 1)) slashCount++;
        // Remove that many from request URL, ignoring extra slashes
        String rest = reqUri.replaceFirst("(?:/+[^/]*){" + slashCount + "}", "");
330 331

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

334 335 336 337 338 339 340 341 342 343 344
    /**
     * 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;
    }

345 346 347 348 349 350 351 352 353 354 355 356
    /**
     * 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>
357
     * The head portion is the part of the URL from the {@link jenkins.model.Jenkins}
358 359 360 361 362 363 364 365 366 367 368
     * 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 已提交
369
    public static final class RunUrl {
370
        private final String head, base, rest;
K
kohsuke 已提交
371 372
        private final Run run;

373 374

        public RunUrl(Run run, String head, String base, String rest) {
K
kohsuke 已提交
375
            this.run = run;
376 377
            this.head = head;
            this.base = base;
K
kohsuke 已提交
378 379 380 381
            this.rest = rest;
        }

        public String getBaseUrl() {
382
            return base;
K
kohsuke 已提交
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
        }

        /**
         * 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 {
403
                return head+n.getNumber()+rest;
K
kohsuke 已提交
404 405 406 407 408 409
            }
        }
    }

    public static Node.Mode[] getNodeModes() {
        return Node.Mode.values();
410 411
    }

K
kohsuke 已提交
412
    public static String getProjectListString(List<Project> projects) {
413
        return Items.toNameList(projects);
K
kohsuke 已提交
414 415
    }

416 417 418 419 420
    /**
     * @deprecated as of 1.294
     *      JEXL now supports the real ternary operator "x?y:z", so this work around
     *      is no longer necessary.
     */
K
kohsuke 已提交
421 422 423
    public static Object ifThenElse(boolean cond, Object thenValue, Object elseValue) {
        return cond ? thenValue : elseValue;
    }
424

K
kohsuke 已提交
425 426 427 428 429
    public static String appendIfNotNull(String text, String suffix, String nullText) {
        return text == null ? nullText : text + suffix;
    }

    public static Map getSystemProperties() {
J
jglick 已提交
430
        return new TreeMap<Object,Object>(System.getProperties());
K
kohsuke 已提交
431 432 433
    }

    public static Map getEnvVars() {
J
jglick 已提交
434
        return new TreeMap<String,String>(EnvVars.masterEnvVars);
K
kohsuke 已提交
435 436 437 438 439 440 441
    }

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

    public static List<LogRecord> getLogRecords() {
442
        return Jenkins.logRecords;
K
kohsuke 已提交
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    }

    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 已提交
461 462 463 464 465 466
    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 已提交
467 468 469 470 471 472 473 474 475 476
    /**
     * 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 已提交
477
    public static boolean DEBUG_YUI = Boolean.getBoolean("debug.YUI");
K
kohsuke 已提交
478

K
kohsuke 已提交
479 480 481 482 483 484 485 486 487 488 489 490 491 492
    /**
     * 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();
493

K
kohsuke 已提交
494 495 496 497 498
    /**
     * 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
499
     *      with auto refresh. On those pages, disable auto-refresh.
K
kohsuke 已提交
500 501 502 503 504
     */
    public static void configureAutoRefresh(HttpServletRequest request, HttpServletResponse response, boolean noAutoRefresh) {
        if(noAutoRefresh)
            return;

505 506 507 508 509 510 511 512 513
        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 已提交
514
            c.setMaxAge(60*60*24*30); // persist it roughly for a month
515 516 517
            response.addCookie(c);
        }
        if (refresh) {
518
            response.addHeader("Refresh", System.getProperty("hudson.Functions.autoRefreshSeconds", "10"));
519 520 521 522 523 524 525 526
        }
    }

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

        for (Cookie c : cookies) {
532 533 534 535 536 537
            if (c.getName().equals("hudson_auto_refresh")) {
                return Boolean.parseBoolean(c.getValue());
            }
        }
        return false;
    }
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552

    /**
     * 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 已提交
553

K
kohsuke 已提交
554 555 556 557 558 559 560 561
    /**
     * 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 已提交
562
                return anc.getUrl()+"/search/";
K
kohsuke 已提交
563 564 565 566
        }
        return null;
    }

K
kohsuke 已提交
567 568 569 570
    public static String appendSpaceIfNotNull(String n) {
        if(n==null) return null;
        else        return n+' ';
    }
K
kohsuke 已提交
571

572 573 574 575 576 577 578 579 580 581 582 583 584
    /**
     * One nbsp per 10 pixels in given size, which may be a plain number or "NxN"
     * (like an iconSize).  Useful in a sortable table heading.
     */
    public static String nbspIndent(String size) {
        int i = size.indexOf('x');
        i = Integer.parseInt(i > 0 ? size.substring(0, i) : size) / 10;
        StringBuilder buf = new StringBuilder(30);
        for (int j = 0; j < i; j++)
            buf.append("&nbsp;");
        return buf.toString();
    }

K
kohsuke 已提交
585 586 587
    public static String getWin32ErrorMessage(IOException e) {
        return Util.getWin32ErrorMessage(e);
    }
588 589

    public static boolean isMultiline(String s) {
K
kohsuke 已提交
590
        if(s==null)     return false;
591 592
        return s.indexOf('\r')>=0 || s.indexOf('\n')>=0;
    }
K
kohsuke 已提交
593 594 595 596

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

K
kohsuke 已提交
598 599 600 601
    public static String escape(String s) {
        return Util.escape(s);
    }

K
kohsuke 已提交
602 603 604 605
    public static String xmlEscape(String s) {
        return Util.xmlEscape(s);
    }

K
Kohsuke Kawaguchi 已提交
606 607 608 609
    public static String xmlUnescape(String s) {
        return s.replace("&lt;","<").replace("&gt;",">").replace("&amp;","&");
    }

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
    public static String htmlAttributeEscape(String text) {
        StringBuilder buf = new StringBuilder(text.length()+64);
        for( int i=0; i<text.length(); i++ ) {
            char ch = text.charAt(i);
            if(ch=='<')
                buf.append("&lt;");
            else
            if(ch=='>')
                buf.append("&gt;");
            else
            if(ch=='&')
                buf.append("&amp;");
            else
            if(ch=='"')
                buf.append("&quot;");
            else
            if(ch=='\'')
                buf.append("&#39;");
            else
                buf.append(ch);
        }
        return buf.toString();
    }

K
kohsuke 已提交
634
    public static void checkPermission(Permission permission) throws IOException, ServletException {
635
        checkPermission(Jenkins.getInstance(),permission);
636 637 638 639
    }

    public static void checkPermission(AccessControlled object, Permission permission) throws IOException, ServletException {
        if (permission != null) {
K
TAB->WS  
kohsuke 已提交
640
            object.checkPermission(permission);
641
        }
K
kohsuke 已提交
642 643
    }

644 645 646 647 648 649
    /**
     * This version is so that the 'checkPermission' on <tt>layout.jelly</tt>
     * degrades gracefully if "it" is not an {@link AccessControlled} object.
     * Otherwise it will perform no check and that problem is hard to notice.
     */
    public static void checkPermission(Object object, Permission permission) throws IOException, ServletException {
650 651 652
        if (permission == null)
            return;
        
653 654 655 656 657 658 659 660 661 662 663
        if (object instanceof AccessControlled)
            checkPermission((AccessControlled) object,permission);
        else {
            List<Ancestor> ancs = Stapler.getCurrentRequest().getAncestors();
            for(Ancestor anc : Iterators.reverse(ancs)) {
                Object o = anc.getObject();
                if (o instanceof AccessControlled) {
                    checkPermission((AccessControlled) o,permission);
                    return;
                }
            }
664
            checkPermission(Jenkins.getInstance(),permission);
665 666 667
        }
    }

K
kohsuke 已提交
668 669
    /**
     * Returns true if the current user has the given permission.
670 671 672
     *
     * @param permission
     *      If null, returns true. This defaulting is convenient in making the use of this method terse.
K
kohsuke 已提交
673 674
     */
    public static boolean hasPermission(Permission permission) throws IOException, ServletException {
675
        return hasPermission(Jenkins.getInstance(),permission);
K
kohsuke 已提交
676 677
    }

K
kohsuke 已提交
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
    /**
     * This version is so that the 'hasPermission' can degrade gracefully
     * if "it" is not an {@link AccessControlled} object.
     */
    public static boolean hasPermission(Object object, Permission permission) throws IOException, ServletException {
        if (permission == null)
            return true;
        if (object instanceof AccessControlled)
            return ((AccessControlled)object).hasPermission(permission);
        else {
            List<Ancestor> ancs = Stapler.getCurrentRequest().getAncestors();
            for(Ancestor anc : Iterators.reverse(ancs)) {
                Object o = anc.getObject();
                if (o instanceof AccessControlled) {
                    return ((AccessControlled)o).hasPermission(permission);
                }
            }
695
            return Jenkins.getInstance().hasPermission(permission);
K
kohsuke 已提交
696
        }
697 698
    }

699 700 701
    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.
702
        if(required!=null && !Hudson.adminCheck(req, rsp)) {
703 704 705
            // check failed. commit the FORBIDDEN response, then abort.
            rsp.setStatus(HttpServletResponse.SC_FORBIDDEN);
            rsp.getOutputStream().close();
706 707
            throw new ServletException("Unauthorized access");
        }
708 709

        // make sure the user owns the necessary permission to access this page.
710
        if(permission!=null)
K
kohsuke 已提交
711
            checkPermission(permission);
712
    }
K
kohsuke 已提交
713 714 715 716 717

    /**
     * Infers the hudson installation URL from the given request.
     */
    public static String inferHudsonURL(StaplerRequest req) {
718
        String rootUrl = Jenkins.getInstance().getRootUrl();
719 720 721
        if(rootUrl !=null)
            // prefer the one explicitly configured, to work with load-balancer, frontend, etc.
            return rootUrl;
K
kohsuke 已提交
722 723 724
        StringBuilder buf = new StringBuilder();
        buf.append(req.getScheme()).append("://");
        buf.append(req.getServerName());
725
        if(! (req.getScheme().equals("http") && req.getLocalPort()==80 || req.getScheme().equals("https") && req.getLocalPort()==443))
K
kohsuke 已提交
726
            buf.append(':').append(req.getLocalPort());
K
kohsuke 已提交
727
        buf.append(req.getContextPath()).append('/');
K
kohsuke 已提交
728 729
        return buf.toString();
    }
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744
    /**
     * Returns the link to be displayed in the footer of the UI.
     */
    public static String getFooterURL() {
        if(footerURL == null) {
            footerURL = System.getProperty("hudson.footerURL");
            if(StringUtils.isBlank(footerURL)) {
                footerURL = "http://jenkins-ci.org/";
            }
        }
        return footerURL;
    }
    private static String footerURL = null;

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

749 750 751 752
    public static List<Descriptor<BuildWrapper>> getBuildWrapperDescriptors(AbstractProject<?,?> project) {
        return BuildWrappers.getFor(project);
    }

753
    public static List<Descriptor<SecurityRealm>> getSecurityRealmDescriptors() {
754
        return SecurityRealm.all();
755 756
    }

757
    public static List<Descriptor<AuthorizationStrategy>> getAuthorizationStrategyDescriptors() {
758
        return AuthorizationStrategy.all();
759 760
    }

761
    public static List<Descriptor<Builder>> getBuilderDescriptors(AbstractProject<?,?> project) {
762
        return BuildStepDescriptor.filter(Builder.all(), project.getClass());
763 764 765
    }

    public static List<Descriptor<Publisher>> getPublisherDescriptors(AbstractProject<?,?> project) {
766
        return BuildStepDescriptor.filter(Publisher.all(), project.getClass());
767 768
    }

K
kohsuke 已提交
769 770 771 772
    public static List<SCMDescriptor<?>> getSCMDescriptors(AbstractProject<?,?> project) {
        return SCM._for(project);
    }

773
    public static List<Descriptor<ComputerLauncher>> getComputerLauncherDescriptors() {
774
        return Jenkins.getInstance().<ComputerLauncher,Descriptor<ComputerLauncher>>getDescriptorList(ComputerLauncher.class);
775 776
    }

777
    public static List<Descriptor<RetentionStrategy<?>>> getRetentionStrategyDescriptors() {
778
        return RetentionStrategy.all();
779 780
    }

781
    public static List<ParameterDescriptor> getParameterDescriptors() {
782
        return ParameterDefinition.all();
K
kohsuke 已提交
783 784
    }

785 786 787 788
    public static List<Descriptor<CaptchaSupport>> getCaptchaSupportDescriptors() {
        return CaptchaSupport.all();
    }

W
wjprakash 已提交
789 790 791 792 793 794 795 796
    public static List<Descriptor<ViewsTabBar>> getViewsTabBarDescriptors() {
        return ViewsTabBar.all();
    }

    public static List<Descriptor<MyViewsTabBar>> getMyViewsTabBarDescriptors() {
        return MyViewsTabBar.all();
    }

797 798
    public static List<NodePropertyDescriptor> getNodePropertyDescriptors(Class<? extends Node> clazz) {
        List<NodePropertyDescriptor> result = new ArrayList<NodePropertyDescriptor>();
799
        Collection<NodePropertyDescriptor> list = (Collection) Jenkins.getInstance().getDescriptorList(NodeProperty.class);
800 801 802 803 804 805 806 807
        for (NodePropertyDescriptor npd : list) {
            if (npd.isApplicable(clazz)) {
                result.add(npd);
            }
        }
        return result;
    }

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
    /**
     * Returns those node properties which can be configured as global node properties.
     *
     * @since 1.520
     */
    public static List<NodePropertyDescriptor> getGlobalNodePropertyDescriptors() {
        List<NodePropertyDescriptor> result = new ArrayList<NodePropertyDescriptor>();
        Collection<NodePropertyDescriptor> list = (Collection) Jenkins.getInstance().getDescriptorList(NodeProperty.class);
        for (NodePropertyDescriptor npd : list) {
            if (npd.isApplicableAsGlobal()) {
                result.add(npd);
            }
        }
        return result;
    }

824 825 826
    /**
     * Gets all the descriptors sorted by their inheritance tree of {@link Describable}
     * so that descriptors of similar types come nearby.
827 828 829 830 831 832 833 834 835
     *
     * <p>
     * We sort them by {@link Extension#ordinal()} but only for {@link GlobalConfiguration}s,
     * as the value is normally used to compare similar kinds of extensions, and we needed
     * {@link GlobalConfiguration}s to be able to position themselves in a layer above.
     * This however creates some asymmetry between regular {@link Descriptor}s and {@link GlobalConfiguration}s.
     * Perhaps it is better to introduce another annotation element? But then,
     * extensions shouldn't normally concern themselves about ordering too much, and the only reason
     * we needed this for {@link GlobalConfiguration}s are for backward compatibility.
836 837 838
     *
     * @param predicate
     *      Filter the descriptors based on {@link GlobalConfigurationCategory}
839
     * @since 1.494
840
     */
841
    public static Collection<Descriptor> getSortedDescriptorsForGlobalConfig(Predicate<GlobalConfigurationCategory> predicate) {
842 843 844 845 846
        ExtensionList<Descriptor> exts = Jenkins.getInstance().getExtensionList(Descriptor.class);
        List<Tag> r = new ArrayList<Tag>(exts.size());

        for (ExtensionComponent<Descriptor> c : exts.getComponents()) {
            Descriptor d = c.getInstance();
847
            if (d.getGlobalConfigPage()==null)  continue;
848

849 850 851 852 853 854 855
            if (d instanceof GlobalConfiguration) {
                if (predicate.apply(((GlobalConfiguration)d).getCategory()))
                    r.add(new Tag(c.ordinal(), d));
            } else {
                if (predicate.apply(GlobalConfigurationCategory.get(Unclassified.class)))
                    r.add(new Tag(0, d));
            }
856
        }
857 858 859 860
        Collections.sort(r);

        List<Descriptor> answer = new ArrayList<Descriptor>(r.size());
        for (Tag d : r) answer.add(d.d);
861

862
        return DescriptorVisibilityFilter.apply(Jenkins.getInstance(),answer);
863 864
    }

865 866 867
    /**
     * Like {@link #getSortedDescriptorsForGlobalConfig(Predicate)} but with a constant truth predicate, to include all descriptors.
     */
868 869 870
    public static Collection<Descriptor> getSortedDescriptorsForGlobalConfig() {
        return getSortedDescriptorsForGlobalConfig(Predicates.<GlobalConfigurationCategory>alwaysTrue());
    }
871

872 873 874 875
    /**
     * @deprecated This is rather meaningless.
     */
    @Deprecated
876 877
    public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigNoSecurity() {
        return getSortedDescriptorsForGlobalConfig(Predicates.not(GlobalSecurityConfiguration.FILTER));
878
    }
879 880 881 882 883 884 885 886 887 888 889 890

    /**
     * Like {@link #getSortedDescriptorsForGlobalConfig(Predicate)} but for unclassified descriptors only.
     * @since 1.506
     */
    public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigUnclassified() {
        return getSortedDescriptorsForGlobalConfig(new Predicate<GlobalConfigurationCategory>() {
            public boolean apply(GlobalConfigurationCategory cat) {
                return cat instanceof GlobalConfigurationCategory.Unclassified;
            }
        });
    }
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    
    private static class Tag implements Comparable<Tag> {
        double ordinal;
        String hierarchy;
        Descriptor d;

        Tag(double ordinal, Descriptor d) {
            this.ordinal = ordinal;
            this.d = d;
            this.hierarchy = buildSuperclassHierarchy(d.clazz, new StringBuilder()).toString();
        }

        private StringBuilder buildSuperclassHierarchy(Class c, StringBuilder buf) {
            Class sc = c.getSuperclass();
            if (sc!=null)   buildSuperclassHierarchy(sc,buf).append(':');
            return buf.append(c.getName());
        }
908

909 910 911 912 913 914
        public int compareTo(Tag that) {
            int r = Double.compare(this.ordinal, that.ordinal);
            if (r!=0)   return -r; // descending for ordinal
            return this.hierarchy.compareTo(that.hierarchy);
        }
    }
915 916 917 918 919 920
    /**
     * Computes the path to the icon of the given action
     * from the context path.
     */
    public static String getIconFilePath(Action a) {
        String name = a.getIconFileName();
921 922
        if (name==null)     return null;
        if (name.startsWith("/"))
923 924 925 926
            return name.substring(1);
        else
            return "images/24x24/"+name;
    }
K
kohsuke 已提交
927 928 929 930 931

    /**
     * Works like JSTL build-in size(x) function,
     * but handle null gracefully.
     */
K
kohsuke 已提交
932
    public static int size2(Object o) throws Exception {
K
kohsuke 已提交
933
        if(o==null) return 0;
K
kohsuke 已提交
934
        return ASTSizeFunction.sizeOf(o,Introspector.getUberspect());
K
kohsuke 已提交
935
    }
K
kohsuke 已提交
936

937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
    /**
     * 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);
952 953 954
        if(path!=null) {
            return normalizeURI(path + '/');
        }
955 956 957

        Item i=p;
        String url = "";
958 959 960 961 962 963
        Collection<TopLevelItem> viewItems;
        if (view != null) {
            viewItems = view.getItems();
        } else {
            viewItems = Collections.emptyList();
        }
964 965 966 967
        while(true) {
            ItemGroup ig = i.getParent();
            url = i.getShortUrl()+url;

968
            if(ig== Jenkins.getInstance() || (view != null && ig == view.getOwnerItemGroup())) {
969
                assert i instanceof TopLevelItem;
970
                if(viewItems.contains((TopLevelItem)i)) {
971
                    // if p and the current page belongs to the same view, then return a relative path
972
                    return normalizeURI(ancestors.get(view)+'/'+url);
973 974
                } else {
                    // otherwise return a path from the root Hudson
975
                    return normalizeURI(request.getContextPath()+'/'+p.getUrl());
976 977 978 979
                }
            }

            path = ancestors.get(ig);
980 981 982
            if(path!=null) {
                return normalizeURI(path+'/'+url);
            }
983 984 985 986 987

            assert ig instanceof Item; // if not, ig must have been the Hudson instance
            i = (Item) ig;
        }
    }
988
    
989 990 991 992 993 994 995
    private static String normalizeURI(String uri) {
        return URI.create(uri).normalize().toString();
    }
    
    /**
     * Gets all the {@link TopLevelItem}s recursively in the {@link ItemGroup} tree.
     * 
J
Jesse Glick 已提交
996
     * @since 1.512
997
     */
998 999 1000 1001
    public static List<TopLevelItem> getAllTopLevelItems(ItemGroup root) {
      return Items.getAllItems(root, TopLevelItem.class);
    }
    
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
    /**
     * Gets the relative name or display name to the given item from the specified group.
     *
     * @since 1.515
     * @param p the Item we want the relative display name
     * @param g the ItemGroup used as point of reference for the item
     * @param useDisplayName if true, returns a display name, otherwise returns a name
     * @return
     *      String like "foo » bar"
     */
    public static String getRelativeNameFrom(Item p, ItemGroup g, boolean useDisplayName) {
        if (p == null) return null;
        if (g == null) return useDisplayName ? p.getFullDisplayName() : p.getFullName();
        String separationString = useDisplayName ? " » " : "/";
        
        // first list up all the parents
        Map<ItemGroup,Integer> parents = new HashMap<ItemGroup,Integer>();
        int depth=0;
        while (g!=null) {
            parents.put(g, depth++);
            if (g instanceof Item)
                g = ((Item)g).getParent();
            else
                g = null;
        }

        StringBuilder buf = new StringBuilder();
        Item i=p;
        while (true) {
            if (buf.length()>0) buf.insert(0,separationString);
            buf.insert(0,useDisplayName ? i.getDisplayName() : i.getName());
            ItemGroup gr = i.getParent();

            Integer d = parents.get(gr);
            if (d!=null) {
                String s="";
                for (int j=d; j>0; j--)
                    s+=".." + separationString;
                return s+buf;
            }

            if (gr instanceof Item)
                i = (Item)gr;
            else
                return null;
        }
    }
    
    /**
     * Gets the name to the given item relative to given group.
     *
     * @since 1.515
     * @param p the Item we want the relative display name
     * @param g the ItemGroup used as point of reference for the item
     * @return
     *      String like "foo » bar"
     */
    public static String getRelativeNameFrom(Item p, ItemGroup g) {
        return getRelativeNameFrom(p, g, false);
    }    
    
1063 1064 1065 1066
    
    /**
     * Gets the relative display name to the given item from the specified group.
     *
J
Jesse Glick 已提交
1067
     * @since 1.512
1068 1069 1070 1071 1072
     * @param p the Item we want the relative display name
     * @param g the ItemGroup used as point of reference for the item
     * @return
     *      String like "foo » bar"
     */
1073
    public static String getRelativeDisplayNameFrom(Item p, ItemGroup g) {
1074
        return getRelativeNameFrom(p, g, true);
1075
    }
1076

K
kohsuke 已提交
1077
    public static Map<Thread,StackTraceElement[]> dumpAllThreads() {
1078 1079 1080
        Map<Thread,StackTraceElement[]> sorted = new TreeMap<Thread,StackTraceElement[]>(new ThreadSorter());
        sorted.putAll(Thread.getAllStackTraces());
        return sorted;
1081
    }
1082

K
kohsuke 已提交
1083
    @IgnoreJRERequirement
K
kohsuke 已提交
1084
    public static ThreadInfo[] getThreadInfos() {
1085
        ThreadMXBean mbean = ManagementFactory.getThreadMXBean();
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
        return mbean.dumpAllThreads(mbean.isObjectMonitorUsageSupported(),mbean.isSynchronizerUsageSupported());
    }

    public static ThreadGroupMap sortThreadsAndGetGroupMap(ThreadInfo[] list) {
        ThreadGroupMap sorter = new ThreadGroupMap();
        Arrays.sort(list, sorter);
        return sorter;
    }

    // Common code for sorting Threads/ThreadInfos by ThreadGroup
    private static class ThreadSorterBase {
        protected Map<Long,String> map = new HashMap<Long,String>();

        private ThreadSorterBase() {
            ThreadGroup tg = Thread.currentThread().getThreadGroup();
            while (tg.getParent() != null) tg = tg.getParent();
            Thread[] threads = new Thread[tg.activeCount()*2];
            int threadsLen = tg.enumerate(threads, true);
            for (int i = 0; i < threadsLen; i++)
                map.put(threads[i].getId(), threads[i].getThreadGroup().getName());
        }

        protected int compare(long idA, long idB) {
            String tga = map.get(idA), tgb = map.get(idB);
            int result = (tga!=null?-1:0) + (tgb!=null?1:0);  // Will be non-zero if only one is null
            if (result==0 && tga!=null)
                result = tga.compareToIgnoreCase(tgb);
            return result;
        }
    }

    public static class ThreadGroupMap extends ThreadSorterBase implements Comparator<ThreadInfo> {

        /**
         * @return ThreadGroup name or null if unknown
         */
        public String getThreadGroup(ThreadInfo ti) {
            return map.get(ti.getThreadId());
        }

        public int compare(ThreadInfo a, ThreadInfo b) {
            int result = compare(a.getThreadId(), b.getThreadId());
            if (result == 0)
                result = a.getThreadName().compareToIgnoreCase(b.getThreadName());
            return result;
        }
    }

    private static class ThreadSorter extends ThreadSorterBase implements Comparator<Thread> {

        public int compare(Thread a, Thread b) {
            int result = compare(a.getId(), b.getId());
            if (result == 0)
                result = a.getName().compareToIgnoreCase(b.getName());
            return result;
        }
1142 1143
    }

1144 1145 1146
    /**
     * Are we running on JRE6 or above?
     */
K
kohsuke 已提交
1147
    @IgnoreJRERequirement
1148 1149 1150 1151 1152 1153 1154 1155 1156
    public static boolean isMustangOrAbove() {
        try {
            System.console();
            return true;
        } catch(LinkageError e) {
            return false;
        }
    }

1157
    // ThreadInfo.toString() truncates the stack trace by first 8, so needed my own version
K
kohsuke 已提交
1158
    @IgnoreJRERequirement
1159 1160
    public static String dumpThreadInfo(ThreadInfo ti, ThreadGroupMap map) {
        String grp = map.getThreadGroup(ti);
1161
        StringBuilder sb = new StringBuilder("\"" + ti.getThreadName() + "\"" +
1162 1163
                                             " Id=" + ti.getThreadId() + " Group=" +
                                             (grp != null ? grp : "?") + " " +
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
                                             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();
    }
1223 1224 1225 1226

    public static <T> Collection<T> emptyList() {
        return Collections.emptyList();
    }
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

    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 已提交
1248

K
kohsuke 已提交
1249 1250 1251 1252 1253 1254 1255 1256
    /**
     * Converts "abc" to "Abc".
     */
    public static String capitalize(String s) {
        if(s==null || s.length()==0) return s;
        return Character.toUpperCase(s.charAt(0))+s.substring(1);
    }

K
kohsuke 已提交
1257
    public static String getVersion() {
1258
        return Jenkins.VERSION;
K
kohsuke 已提交
1259 1260
    }

1261 1262 1263 1264
    /**
     * Resoruce path prefix.
     */
    public static String getResourcePath() {
1265
        return Jenkins.RESOURCE_PATH;
1266
    }
1267

1268 1269 1270 1271 1272 1273 1274 1275
    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;

1276
        StringBuilder buf = new StringBuilder(Stapler.getCurrentRequest().getContextPath());
1277
        buf.append(Jenkins.VIEW_RESOURCE_PATH).append('/');
1278 1279 1280 1281 1282 1283
        buf.append(clazz.getName().replace('.','/').replace('$','/'));
        buf.append('/').append(path);

        return buf.toString();
    }

1284
    public static boolean hasView(Object it, String path) throws IOException {
1285
        if(it==null)    return false;
1286
        return Stapler.getCurrentRequest().getView(it,path)!=null;
1287 1288
    }

1289 1290 1291 1292 1293 1294 1295 1296 1297
    /**
     * 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;
    }
1298

K
kohsuke 已提交
1299 1300 1301
    /**
     * If the value exists, return that value. Otherwise return the default value.
     * <p>
1302
     * Starting 1.294, JEXL supports the elvis operator "x?:y" that supercedes this.
K
kohsuke 已提交
1303 1304 1305
     *
     * @since 1.150
     */
K
kohsuke 已提交
1306
    public static <T> T defaulted(T value, T defaultValue) {
K
kohsuke 已提交
1307 1308 1309
        return value!=null ? value : defaultValue;
    }

1310 1311 1312 1313 1314
    public static String printThrowable(Throwable t) {
        StringWriter sw = new StringWriter();
        t.printStackTrace(new PrintWriter(sw));
        return sw.toString();
    }
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

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

1325 1326 1327 1328 1329 1330 1331
    /**
     * 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;
1332
            switch (j.getIconColor()) {
1333
            case ABORTED:
1334
            case ABORTED_ANIME:
1335
            case RED:
1336
            case RED_ANIME:
1337
            case YELLOW:
1338
            case YELLOW_ANIME:
1339 1340
                return "Failure";
            case BLUE:
1341
            case BLUE_ANIME:
1342 1343
                return "Success";
            case DISABLED:
1344
            case DISABLED_ANIME:
1345
            case GREY:
1346 1347 1348
            case GREY_ANIME:
            case NOTBUILT:
            case NOTBUILT_ANIME:
1349 1350 1351 1352 1353 1354
                return "Unknown";
            }
        }
        return "Unknown";
    }

1355
    private static final Pattern LINE_END = Pattern.compile("\r?\n");
K
kohsuke 已提交
1356 1357 1358 1359 1360

    /**
     * Checks if the current user is anonymous.
     */
    public static boolean isAnonymous() {
1361
        return Jenkins.getAuthentication() instanceof AnonymousAuthenticationToken;
K
kohsuke 已提交
1362
    }
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375

    /**
     * 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;
    }
1376

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
    /**
     * Evaluate a Jelly script and return output as a String.
     *
     * @since 1.267
     */
    public static String runScript(Script script) throws JellyTagException {
        StringWriter out = new StringWriter();
        script.run(getCurrentJellyContext(), XMLOutput.createXMLOutput(out));
        return out.toString();
    }

1388 1389 1390 1391 1392 1393 1394 1395 1396
    /**
     * 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;
    }
1397

1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
    /**
     * Combine path components via '/' while handling leading/trailing '/' to avoid duplicates.
     */
    public static String joinPath(String... components) {
        StringBuilder buf = new StringBuilder();
        for (String s : components) {
            if (s.length()==0)  continue;

            if (buf.length()>0) {
                if (buf.charAt(buf.length()-1)!='/')
                    buf.append('/');
                if (s.charAt(0)=='/')   s=s.substring(1);
            }
            buf.append(s);
        }
        return buf.toString();
    }

1416 1417 1418 1419 1420 1421
    /**
     * 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();
1422
        if(urlName==null)   return null;    // to avoid NPE and fail to render the whole page
1423 1424 1425 1426 1427 1428 1429 1430
        try {
            if (new URI(urlName).isAbsolute()) {
                return urlName;
            }
        } catch (URISyntaxException x) {
            Logger.getLogger(Functions.class.getName()).log(Level.WARNING, "Failed to parse URL for {0}: {1}", new Object[] {action, x});
            return null;
        }
1431
        if(urlName.startsWith("/"))
1432
            return joinPath(Stapler.getCurrentRequest().getContextPath(),urlName);
1433 1434
        else
            // relative URL name
1435
            return joinPath(Stapler.getCurrentRequest().getContextPath()+'/'+itUrl,urlName);
1436 1437
    }

K
kohsuke 已提交
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
    /**
     * 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;
    }

1459 1460 1461 1462
    public String getSystemProperty(String key) {
        return System.getProperty(key);
    }

1463 1464 1465 1466 1467 1468 1469
    /**
     * Obtains the host name of the Hudson server that clients can use to talk back to.
     * <p>
     * This is primarily used in <tt>slave-agent.jnlp.jelly</tt> to specify the destination
     * that the slaves talk to.
     */
    public String getServerName() {
K
kohsuke 已提交
1470 1471
        // Try to infer this from the configured root URL.
        // This makes it work correctly when Hudson runs behind a reverse proxy.
1472
        String url = Jenkins.getInstance().getRootUrl();
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
        try {
            if(url!=null) {
                String host = new URL(url).getHost();
                if(host!=null)
                    return host;
            }
        } catch (MalformedURLException e) {
            // fall back to HTTP request
        }
        return Stapler.getCurrentRequest().getServerName();
    }

1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
    /**
     * Determines the form validation check URL. See textbox.jelly
     */
    public String getCheckUrl(String userDefined, Object descriptor, String field) {
        if(userDefined!=null || field==null)   return userDefined;
        if (descriptor instanceof Descriptor) {
            Descriptor d = (Descriptor) descriptor;
            return d.getCheckUrl(field);
        }
        return null;
    }

K
kohsuke 已提交
1497 1498 1499 1500 1501 1502 1503
    /**
     * If the given href link is matching the current page, return true.
     *
     * Used in <tt>task.jelly</tt> to decide if the page should be highlighted.
     */
    public boolean hyperlinkMatchesCurrentPage(String href) throws UnsupportedEncodingException {
        String url = Stapler.getCurrentRequest().getRequestURL().toString();
1504
        if (href == null || href.length() <= 1) return ".".equals(href) && url.endsWith("/");
K
kohsuke 已提交
1505 1506
        url = URLDecoder.decode(url,"UTF-8");
        href = URLDecoder.decode(href,"UTF-8");
1507 1508
        if (url.endsWith("/")) url = url.substring(0, url.length() - 1);
        if (href.endsWith("/")) href = href.substring(0, href.length() - 1);
K
kohsuke 已提交
1509

M
mindless 已提交
1510
        return url.endsWith(href);
K
kohsuke 已提交
1511 1512
    }

1513 1514 1515 1516
    public <T> List<T> singletonList(T t) {
        return Collections.singletonList(t);
    }

1517 1518 1519 1520
    /**
     * Gets all the {@link PageDecorator}s.
     */
    public static List<PageDecorator> getPageDecorators() {
K
kohsuke 已提交
1521
        // this method may be called to render start up errors, at which point Hudson doesn't exist yet. see HUDSON-3608 
1522
        if(Jenkins.getInstance()==null)  return Collections.emptyList();
1523
        return PageDecorator.all();
1524
    }
K
kohsuke 已提交
1525
    
K
kohsuke 已提交
1526
    public static List<Descriptor<Cloud>> getCloudDescriptors() {
1527
        return Cloud.all();
K
kohsuke 已提交
1528
    }
1529

K
kohsuke 已提交
1530 1531 1532 1533 1534 1535 1536 1537 1538
    /**
     * Prepend a prefix only when there's the specified body.
     */
    public String prepend(String prefix, String body) {
        if(body!=null && body.length()>0)
            return prefix+body;
        return body;
    }

1539 1540 1541
    public static List<Descriptor<CrumbIssuer>> getCrumbIssuerDescriptors() {
        return CrumbIssuer.all();
    }
1542

1543
    public static String getCrumb(StaplerRequest req) {
1544
        Jenkins h = Jenkins.getInstance();
1545 1546
        CrumbIssuer issuer = h != null ? h.getCrumbIssuer() : null;
        return issuer != null ? issuer.getCrumb(req) : "";
1547
    }
1548

1549
    public static String getCrumbRequestField() {
1550
        Jenkins h = Jenkins.getInstance();
1551 1552
        CrumbIssuer issuer = h != null ? h.getCrumbIssuer() : null;
        return issuer != null ? issuer.getDescriptor().getCrumbRequestField() : "";
1553
    }
K
kohsuke 已提交
1554 1555 1556 1557

    public static Date getCurrentTime() {
        return new Date();
    }
K
kohsuke 已提交
1558

K
Kohsuke Kawaguchi 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
    public static Locale getCurrentLocale() {
        Locale locale=null;
        StaplerRequest req = Stapler.getCurrentRequest();
        if(req!=null)
            locale = req.getLocale();
        if(locale==null)
            locale = Locale.getDefault();
        return locale;
    }

K
kohsuke 已提交
1569 1570 1571 1572
    /**
     * Generate a series of &lt;script> tags to include <tt>script.js</tt>
     * from {@link ConsoleAnnotatorFactory}s and {@link ConsoleAnnotationDescriptor}s.
     */
1573
    public static String generateConsoleAnnotationScriptAndStylesheet() {
K
kohsuke 已提交
1574 1575 1576
        String cp = Stapler.getCurrentRequest().getContextPath();
        StringBuilder buf = new StringBuilder();
        for (ConsoleAnnotatorFactory f : ConsoleAnnotatorFactory.all()) {
1577
            String path = cp + "/extensionList/" + ConsoleAnnotatorFactory.class.getName() + "/" + f.getClass().getName();
K
kohsuke 已提交
1578
            if (f.hasScript())
1579 1580 1581
                buf.append("<script src='"+path+"/script.js'></script>");
            if (f.hasStylesheet())
                buf.append("<link rel='stylesheet' type='text/css' href='"+path+"/style.css' />");
K
kohsuke 已提交
1582 1583
        }
        for (ConsoleAnnotationDescriptor d : ConsoleAnnotationDescriptor.all()) {
1584
            String path = cp+"/descriptor/"+d.clazz.getName();
K
kohsuke 已提交
1585
            if (d.hasScript())
1586 1587 1588
                buf.append("<script src='"+path+"/script.js'></script>");
            if (d.hasStylesheet())
                buf.append("<link rel='stylesheet' type='text/css' href='"+path+"/style.css' />");
K
kohsuke 已提交
1589 1590 1591
        }
        return buf.toString();
    }
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608

    /**
     * Work around for bug 6935026.
     */
    public List<String> getLoggerNames() {
        while (true) {
            try {
                List<String> r = new ArrayList<String>();
                Enumeration<String> e = LogManager.getLogManager().getLoggerNames();
                while (e.hasMoreElements())
                    r.add(e.nextElement());
                return r;
            } catch (ConcurrentModificationException e) {
                // retry
            }
        }
    }
1609 1610 1611 1612 1613 1614 1615 1616 1617

    /**
     * Used by &lt;f:password/> so that we send an encrypted value to the client.
     */
    public String getPasswordValue(Object o) {
        if (o==null)    return null;
        if (o instanceof Secret)    return ((Secret)o).getEncryptedValue();
        return o.toString();
    }
1618 1619 1620 1621

    public List filterDescriptors(Object context, Iterable descriptors) {
        return DescriptorVisibilityFilter.apply(context,descriptors);
    }
1622
    
1623
    /**
1624
     * Returns true if we are running unit tests.
1625
     */
1626 1627 1628
    public static boolean getIsUnitTest() {
        return Main.isUnitTest;
    }
R
rseguy 已提交
1629 1630 1631 1632 1633 1634

    /**
     * Returns {@code true} if the {@link Run#ARTIFACTS} permission is enabled,
     * {@code false} otherwise.
     *
     * <p>When the {@link Run#ARTIFACTS} permission is not turned on using the
1635 1636 1637 1638 1639
     * {@code hudson.security.ArtifactsPermission} system property, this
     * permission must not be considered to be set to {@code false} for every
     * user. It must rather be like if the permission doesn't exist at all
     * (which means that every user has to have an access to the artifacts but
     * the permission can't be configured in the security screen). Got it?</p>
R
rseguy 已提交
1640 1641 1642 1643 1644
     */
    public static boolean isArtifactsPermissionEnabled() {
        return Boolean.getBoolean("hudson.security.ArtifactsPermission");
    }

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
    /**
     * Returns {@code true} if the {@link Item#WIPEOUT} permission is enabled,
     * {@code false} otherwise.
     *
     * <p>The "Wipe Out Workspace" action available on jobs is controlled by the
     * {@link Item#BUILD} permission. For some specific projects, however, it is
     * not acceptable to let users have this possibility, even it they can
     * trigger builds. As such, when enabling the {@code hudson.security.WipeOutPermission}
     * system property, a new "WipeOut" permission will allow to have greater
     * control on the "Wipe Out Workspace" action.</p>
     */
    public static boolean isWipeOutPermissionEnabled() {
        return Boolean.getBoolean("hudson.security.WipeOutPermission");
    }

1660 1661
    public static String createRenderOnDemandProxy(JellyContext context, String attributesToCapture) {
        return Stapler.getCurrentRequest().createJavaScriptProxy(new RenderOnDemandClosure(context,attributesToCapture));
1662
    }
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677

    public static String getCurrentDescriptorByNameUrl() {
        return Descriptor.getCurrentDescriptorByNameUrl();
    }
    
    public static String setCurrentDescriptorByNameUrl(String value) {
        String o = getCurrentDescriptorByNameUrl();
        Stapler.getCurrentRequest().setAttribute("currentDescriptorByNameUrl", value);

        return o;
    }

    public static void restoreCurrentDescriptorByNameUrl(String old) {
        Stapler.getCurrentRequest().setAttribute("currentDescriptorByNameUrl", old);
    }
K
Kohsuke Kawaguchi 已提交
1678 1679 1680 1681 1682 1683 1684 1685 1686

    public static List<String> getRequestHeaders(String name) {
        List<String> r = new ArrayList<String>();
        Enumeration e = Stapler.getCurrentRequest().getHeaders(name);
        while (e.hasMoreElements()) {
            r.add(e.nextElement().toString());
        }
        return r;
    }
1687 1688 1689 1690 1691 1692 1693

    /**
     * Used for arguments to internationalized expressions to avoid escape
     */
    public static Object rawHtml(Object o) {
        return o==null ? null : new RawHtmlArgument(o);
    }
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704

    public static ArrayList<CLICommand> getCLICommands() {
        ArrayList<CLICommand> all = new ArrayList<CLICommand>(CLICommand.all());
        Collections.sort(all, new Comparator<CLICommand>() {
            public int compare(CLICommand cliCommand, CLICommand cliCommand1) {
                return cliCommand.getName().compareTo(cliCommand1.getName());
            }
        });
        return all;
    }

1705 1706 1707 1708 1709 1710 1711
    /**
     * Returns an avatar image URL for the specified user and preferred image size
     * @param user the user
     * @param avatarSize the preferred size of the avatar image
     * @return a URL string
     * @since 1.433
     */
1712
    public static String getAvatar(User user, String avatarSize) {
1713 1714
        return UserAvatarResolver.resolve(user, avatarSize);
    }
1715 1716 1717 1718 1719 1720 1721 1722

    /**
     * @deprecated as of 1.451
     *      Use {@link #getAvatar}
     */
    public String getUserAvatar(User user, String avatarSize) {
        return getAvatar(user,avatarSize);
    }
L
lvotypko 已提交
1723 1724 1725 1726 1727
    
    
    /**
     * Returns human readable information about file size
     * 
1728
     * @param size file size in bytes
L
lvotypko 已提交
1729 1730 1731 1732
     * @return file size in appropriate unit
     */
    public static String humanReadableByteSize(long size){
        String measure = "B";
1733 1734 1735
        if(size < 1024){
            return size + " " + measure;
        }
L
lvotypko 已提交
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
        Double number = new Double(size);
        if(number>=1024){
            number = number/1024;
            measure = "KB";
            if(number>=1024){
                number = number/1024;
                measure = "MB";
                if(number>=1024){
                    number=number/1024;
                    measure = "GB";
                }
            }
        }
1749
        DecimalFormat format = new DecimalFormat("#0.00");
L
lvotypko 已提交
1750 1751
        return format.format(number) + " " + measure;
    }
1752 1753 1754 1755 1756 1757 1758 1759

    /**
     * Get a string that can be safely broken to several lines when necessary.
     *
     * This implementation inserts &lt;wbr> tags into string. It allows browsers
     * to wrap line before any sequence of punctuation characters or anywhere
     * in the middle of prolonged sequences of word characters.
     *
1760
     * @since 1.517
1761 1762 1763 1764 1765 1766 1767
     */
    public static String breakableString(final String plain) {

        return plain.replaceAll("(\\p{Punct}+\\w)", "<wbr>$1")
                .replaceAll("(\\w{10})(?=\\w{3})", "$1<wbr>")
        ;
    }
K
Kohsuke Kawaguchi 已提交
1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787

    /**
     * Advertises the minimum set of HTTP headers that assist programmatic
     * discovery of Jenkins.
     */
    public static void advertiseHeaders(HttpServletResponse rsp) {
        Jenkins j = Jenkins.getInstance();

        rsp.setHeader("X-Hudson","1.395");
        rsp.setHeader("X-Jenkins", Jenkins.VERSION);
        rsp.setHeader("X-Jenkins-Session", Jenkins.SESSION_HASH);

        TcpSlaveAgentListener tal = j.tcpSlaveAgentListener;
        if (tal !=null) {
            rsp.setIntHeader("X-Hudson-CLI-Port", tal.getPort());
            rsp.setIntHeader("X-Jenkins-CLI-Port", tal.getPort());
            rsp.setIntHeader("X-Jenkins-CLI2-Port", tal.getPort());
            rsp.setHeader("X-Jenkins-CLI-Host", TcpSlaveAgentListener.CLI_HOST_NAME);
        }
    }
K
kohsuke 已提交
1788
}