Functions.java 54.3 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.model.*;
32
import hudson.model.ParameterDefinition.ParameterDescriptor;
K
kohsuke 已提交
33
import hudson.search.SearchableModelObject;
34 35 36 37
import hudson.security.AccessControlled;
import hudson.security.AuthorizationStrategy;
import hudson.security.Permission;
import hudson.security.SecurityRealm;
38
import hudson.security.captcha.CaptchaSupport;
39
import hudson.security.csrf.CrumbIssuer;
40
import hudson.slaves.Cloud;
41
import hudson.slaves.ComputerLauncher;
42 43
import hudson.slaves.NodeProperty;
import hudson.slaves.NodePropertyDescriptor;
44
import hudson.slaves.RetentionStrategy;
45
import hudson.tasks.BuildStepDescriptor;
46 47
import hudson.tasks.BuildWrapper;
import hudson.tasks.BuildWrappers;
48 49
import hudson.tasks.Builder;
import hudson.tasks.Publisher;
50
import hudson.tasks.UserAvatarResolver;
51
import hudson.util.Area;
52
import hudson.util.Iterators;
K
kohsuke 已提交
53 54
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
55
import hudson.util.Secret;
W
wjprakash 已提交
56 57
import hudson.views.MyViewsTabBar;
import hudson.views.ViewsTabBar;
58
import hudson.widgets.RenderOnDemandClosure;
59
import jenkins.model.GlobalConfiguration;
60
import jenkins.model.GlobalSecurityConfigurationPart;
61
import jenkins.model.Jenkins;
62
import jenkins.model.ModelObjectWithContextMenu;
63 64
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.apache.commons.jelly.JellyContext;
65 66
import org.apache.commons.jelly.JellyTagException;
import org.apache.commons.jelly.Script;
67
import org.apache.commons.jelly.XMLOutput;
68
import org.apache.commons.jexl.parser.ASTSizeFunction;
K
kohsuke 已提交
69
import org.apache.commons.jexl.util.Introspector;
70
import org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement;
K
kohsuke 已提交
71
import org.jvnet.tiger_types.Types;
K
kohsuke 已提交
72
import org.kohsuke.stapler.Ancestor;
73
import org.kohsuke.stapler.Stapler;
K
kohsuke 已提交
74
import org.kohsuke.stapler.StaplerRequest;
75
import org.kohsuke.stapler.StaplerResponse;
76
import org.kohsuke.stapler.jelly.InternationalizedStringExpression.RawHtmlArgument;
K
kohsuke 已提交
77

78
import javax.servlet.ServletException;
K
kohsuke 已提交
79 80
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
K
kohsuke 已提交
81 82
import javax.servlet.http.HttpServletResponse;
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 93
import java.lang.reflect.Type;
import java.lang.reflect.ParameterizedType;
94
import java.net.MalformedURLException;
95
import java.net.URL;
K
kohsuke 已提交
96
import java.net.URLDecoder;
L
lvotypko 已提交
97
import java.text.DecimalFormat;
98
import java.util.ArrayList;
99
import java.util.Arrays;
K
kohsuke 已提交
100
import java.util.Calendar;
101 102
import java.util.Collection;
import java.util.Collections;
103
import java.util.Comparator;
104 105
import java.util.ConcurrentModificationException;
import java.util.Enumeration;
106
import java.util.HashMap;
K
kohsuke 已提交
107
import java.util.List;
K
Kohsuke Kawaguchi 已提交
108
import java.util.Locale;
K
kohsuke 已提交
109 110
import java.util.Map;
import java.util.SortedMap;
K
kohsuke 已提交
111
import java.util.TreeMap;
K
kohsuke 已提交
112
import java.util.Date;
113
import java.util.logging.LogManager;
K
kohsuke 已提交
114 115
import java.util.logging.LogRecord;
import java.util.logging.SimpleFormatter;
116
import java.util.regex.Pattern;
117
import org.apache.commons.lang.StringUtils;
K
kohsuke 已提交
118 119

/**
K
kohsuke 已提交
120 121 122
 * Utility functions used in views.
 *
 * <p>
123 124
 * 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 已提交
125
 *
K
kohsuke 已提交
126 127 128
 * @author Kohsuke Kawaguchi
 */
public class Functions {
129 130 131 132 133 134 135 136 137
    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 已提交
138 139 140 141 142 143 144 145

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

K
kohsuke 已提交
146 147 148 149
    public static boolean isModel(Object o) {
        return o instanceof ModelObject;
    }

150 151 152 153
    public static boolean isModelWithContextMenu(Object o) {
        return o instanceof ModelObjectWithContextMenu;
    }

K
kohsuke 已提交
154 155 156 157
    public static String xsDate(Calendar cal) {
        return Util.XS_DATETIME_FORMATTER.format(cal.getTime());
    }

158 159 160
    public static String rfc822Date(Calendar cal) {
        return Util.RFC822_DATETIME_FORMATTER.format(cal.getTime());
    }
161 162 163
    
    public static void initPageVariables(JellyContext context) {
        String rootURL = Stapler.getCurrentRequest().getContextPath();
K
Kohsuke Kawaguchi 已提交
164

165
        Functions h = new Functions();
K
Kohsuke Kawaguchi 已提交
166 167
        context.setVariable("h", h);

168

K
Kohsuke Kawaguchi 已提交
169
        // The path starts with a "/" character but does not end with a "/" character.
170
        context.setVariable("rootURL", rootURL);
K
Kohsuke Kawaguchi 已提交
171 172 173 174 175 176 177 178

        /*
            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.
         */
179 180 181
        context.setVariable("resURL",rootURL+getResourcePath());
        context.setVariable("imagesURL",rootURL+getResourcePath()+"/images");
    }
182

K
kohsuke 已提交
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    /**
     * 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() {
205
        return Jenkins.getInstance().getDescriptorByType(JDK.DescriptorImpl.class);
K
kohsuke 已提交
206 207
    }

K
kohsuke 已提交
208 209 210 211
    /**
     * Prints the integer as a string that represents difference,
     * like "-5", "+/-0", "+3".
     */
K
kohsuke 已提交
212 213 214 215 216 217 218 219
    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;
    }

    /**
220
     * {@link #getDiffString(int)} that doesn't show anything for +/-0
K
kohsuke 已提交
221 222 223 224 225 226 227 228
     */
    public static String getDiffString2(int i) {
        if(i==0)    return "";
        String s = Integer.toString(i);
        if(i>0)     return "+"+s;
        else        return s;
    }

229 230 231 232 233 234 235 236 237 238 239
    /**
     * {@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 已提交
240 241 242 243
    /**
     * Adds the proper suffix.
     */
    public static String addSuffix(int n, String singular, String plural) {
K
kohsuke 已提交
244
        StringBuilder buf = new StringBuilder();
K
kohsuke 已提交
245 246 247 248 249 250 251 252 253
        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 已提交
254
        List<Ancestor> ancestors = req.getAncestors();
255 256 257

        // find the first and last Run instances
        Ancestor f=null,l=null;
K
kohsuke 已提交
258 259
        for (Ancestor anc : ancestors) {
            if(anc.getObject() instanceof Run) {
260 261 262 263 264 265 266 267 268 269
                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();
270 271 272 273 274 275 276 277 278 279 280 281
        // 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 + "}", "");
282 283

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

286 287 288 289 290 291 292 293 294 295 296
    /**
     * 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;
    }

297 298 299 300 301 302 303 304 305 306 307 308
    /**
     * 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>
309
     * The head portion is the part of the URL from the {@link jenkins.model.Jenkins}
310 311 312 313 314 315 316 317 318 319 320
     * 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 已提交
321
    public static final class RunUrl {
322
        private final String head, base, rest;
K
kohsuke 已提交
323 324
        private final Run run;

325 326

        public RunUrl(Run run, String head, String base, String rest) {
K
kohsuke 已提交
327
            this.run = run;
328 329
            this.head = head;
            this.base = base;
K
kohsuke 已提交
330 331 332 333
            this.rest = rest;
        }

        public String getBaseUrl() {
334
            return base;
K
kohsuke 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
        }

        /**
         * 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 {
355
                return head+n.getNumber()+rest;
K
kohsuke 已提交
356 357 358 359 360 361
            }
        }
    }

    public static Node.Mode[] getNodeModes() {
        return Node.Mode.values();
362 363
    }

K
kohsuke 已提交
364
    public static String getProjectListString(List<Project> projects) {
365
        return Items.toNameList(projects);
K
kohsuke 已提交
366 367
    }

368 369 370 371 372
    /**
     * @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 已提交
373 374 375
    public static Object ifThenElse(boolean cond, Object thenValue, Object elseValue) {
        return cond ? thenValue : elseValue;
    }
376

K
kohsuke 已提交
377 378 379 380 381
    public static String appendIfNotNull(String text, String suffix, String nullText) {
        return text == null ? nullText : text + suffix;
    }

    public static Map getSystemProperties() {
J
jglick 已提交
382
        return new TreeMap<Object,Object>(System.getProperties());
K
kohsuke 已提交
383 384 385
    }

    public static Map getEnvVars() {
J
jglick 已提交
386
        return new TreeMap<String,String>(EnvVars.masterEnvVars);
K
kohsuke 已提交
387 388 389 390 391 392 393
    }

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

    public static List<LogRecord> getLogRecords() {
394
        return Jenkins.logRecords;
K
kohsuke 已提交
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
    }

    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 已提交
413 414 415 416 417 418
    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 已提交
419 420 421 422 423 424 425 426 427 428
    /**
     * 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 已提交
429
    public static boolean DEBUG_YUI = Boolean.getBoolean("debug.YUI");
K
kohsuke 已提交
430

K
kohsuke 已提交
431 432 433 434 435 436 437 438 439 440 441 442 443 444
    /**
     * 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();
445

K
kohsuke 已提交
446 447 448 449 450
    /**
     * 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
451
     *      with auto refresh. On those pages, disable auto-refresh.
K
kohsuke 已提交
452 453 454 455 456
     */
    public static void configureAutoRefresh(HttpServletRequest request, HttpServletResponse response, boolean noAutoRefresh) {
        if(noAutoRefresh)
            return;

457 458 459 460 461 462 463 464 465
        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 已提交
466
            c.setMaxAge(60*60*24*30); // persist it roughly for a month
467 468 469
            response.addCookie(c);
        }
        if (refresh) {
470
            response.addHeader("Refresh", System.getProperty("hudson.Functions.autoRefreshSeconds", "10"));
471 472 473 474 475 476 477 478
        }
    }

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

        for (Cookie c : cookies) {
484 485 486 487 488 489
            if (c.getName().equals("hudson_auto_refresh")) {
                return Boolean.parseBoolean(c.getValue());
            }
        }
        return false;
    }
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504

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

K
kohsuke 已提交
506 507 508 509 510 511 512 513
    /**
     * 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 已提交
514
                return anc.getUrl()+"/search/";
K
kohsuke 已提交
515 516 517 518
        }
        return null;
    }

K
kohsuke 已提交
519 520 521 522
    public static String appendSpaceIfNotNull(String n) {
        if(n==null) return null;
        else        return n+' ';
    }
K
kohsuke 已提交
523

524 525 526 527 528 529 530 531 532 533 534 535 536
    /**
     * 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 已提交
537 538 539
    public static String getWin32ErrorMessage(IOException e) {
        return Util.getWin32ErrorMessage(e);
    }
540 541

    public static boolean isMultiline(String s) {
K
kohsuke 已提交
542
        if(s==null)     return false;
543 544
        return s.indexOf('\r')>=0 || s.indexOf('\n')>=0;
    }
K
kohsuke 已提交
545 546 547 548

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

K
kohsuke 已提交
550 551 552 553
    public static String escape(String s) {
        return Util.escape(s);
    }

K
kohsuke 已提交
554 555 556 557
    public static String xmlEscape(String s) {
        return Util.xmlEscape(s);
    }

K
Kohsuke Kawaguchi 已提交
558 559 560 561
    public static String xmlUnescape(String s) {
        return s.replace("&lt;","<").replace("&gt;",">").replace("&amp;","&");
    }

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
    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 已提交
586
    public static void checkPermission(Permission permission) throws IOException, ServletException {
587
        checkPermission(Jenkins.getInstance(),permission);
588 589 590 591
    }

    public static void checkPermission(AccessControlled object, Permission permission) throws IOException, ServletException {
        if (permission != null) {
K
TAB->WS  
kohsuke 已提交
592
            object.checkPermission(permission);
593
        }
K
kohsuke 已提交
594 595
    }

596 597 598 599 600 601
    /**
     * 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 {
602 603 604
        if (permission == null)
            return;
        
605 606 607 608 609 610 611 612 613 614 615
        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;
                }
            }
616
            checkPermission(Jenkins.getInstance(),permission);
617 618 619
        }
    }

K
kohsuke 已提交
620 621
    /**
     * Returns true if the current user has the given permission.
622 623 624
     *
     * @param permission
     *      If null, returns true. This defaulting is convenient in making the use of this method terse.
K
kohsuke 已提交
625 626
     */
    public static boolean hasPermission(Permission permission) throws IOException, ServletException {
627
        return hasPermission(Jenkins.getInstance(),permission);
K
kohsuke 已提交
628 629
    }

K
kohsuke 已提交
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
    /**
     * 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);
                }
            }
647
            return Jenkins.getInstance().hasPermission(permission);
K
kohsuke 已提交
648
        }
649 650
    }

651 652 653
    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.
654
        if(required!=null && !Hudson.adminCheck(req, rsp)) {
655 656 657
            // check failed. commit the FORBIDDEN response, then abort.
            rsp.setStatus(HttpServletResponse.SC_FORBIDDEN);
            rsp.getOutputStream().close();
658 659
            throw new ServletException("Unauthorized access");
        }
660 661

        // make sure the user owns the necessary permission to access this page.
662
        if(permission!=null)
K
kohsuke 已提交
663
            checkPermission(permission);
664
    }
K
kohsuke 已提交
665 666 667 668 669

    /**
     * Infers the hudson installation URL from the given request.
     */
    public static String inferHudsonURL(StaplerRequest req) {
670
        String rootUrl = Jenkins.getInstance().getRootUrl();
671 672 673
        if(rootUrl !=null)
            // prefer the one explicitly configured, to work with load-balancer, frontend, etc.
            return rootUrl;
K
kohsuke 已提交
674 675 676
        StringBuilder buf = new StringBuilder();
        buf.append(req.getScheme()).append("://");
        buf.append(req.getServerName());
677
        if(! (req.getScheme().equals("http") && req.getLocalPort()==80 || req.getScheme().equals("https") && req.getLocalPort()==443))
K
kohsuke 已提交
678
            buf.append(':').append(req.getLocalPort());
K
kohsuke 已提交
679
        buf.append(req.getContextPath()).append('/');
K
kohsuke 已提交
680 681
        return buf.toString();
    }
682

683 684 685 686 687 688 689 690 691 692 693 694 695 696
    /**
     * 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;

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

701 702 703 704
    public static List<Descriptor<BuildWrapper>> getBuildWrapperDescriptors(AbstractProject<?,?> project) {
        return BuildWrappers.getFor(project);
    }

705
    public static List<Descriptor<SecurityRealm>> getSecurityRealmDescriptors() {
706
        return SecurityRealm.all();
707 708
    }

709
    public static List<Descriptor<AuthorizationStrategy>> getAuthorizationStrategyDescriptors() {
710
        return AuthorizationStrategy.all();
711 712
    }

713
    public static List<Descriptor<Builder>> getBuilderDescriptors(AbstractProject<?,?> project) {
714
        return BuildStepDescriptor.filter(Builder.all(), project.getClass());
715 716 717
    }

    public static List<Descriptor<Publisher>> getPublisherDescriptors(AbstractProject<?,?> project) {
718
        return BuildStepDescriptor.filter(Publisher.all(), project.getClass());
719 720
    }

K
kohsuke 已提交
721 722 723 724
    public static List<SCMDescriptor<?>> getSCMDescriptors(AbstractProject<?,?> project) {
        return SCM._for(project);
    }

725
    public static List<Descriptor<ComputerLauncher>> getComputerLauncherDescriptors() {
726
        return Jenkins.getInstance().<ComputerLauncher,Descriptor<ComputerLauncher>>getDescriptorList(ComputerLauncher.class);
727 728
    }

729
    public static List<Descriptor<RetentionStrategy<?>>> getRetentionStrategyDescriptors() {
730
        return RetentionStrategy.all();
731 732
    }

733
    public static List<ParameterDescriptor> getParameterDescriptors() {
734
        return ParameterDefinition.all();
K
kohsuke 已提交
735 736
    }

737 738 739 740
    public static List<Descriptor<CaptchaSupport>> getCaptchaSupportDescriptors() {
        return CaptchaSupport.all();
    }

W
wjprakash 已提交
741 742 743 744 745 746 747 748
    public static List<Descriptor<ViewsTabBar>> getViewsTabBarDescriptors() {
        return ViewsTabBar.all();
    }

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

749 750
    public static List<NodePropertyDescriptor> getNodePropertyDescriptors(Class<? extends Node> clazz) {
        List<NodePropertyDescriptor> result = new ArrayList<NodePropertyDescriptor>();
751
        Collection<NodePropertyDescriptor> list = (Collection) Jenkins.getInstance().getDescriptorList(NodeProperty.class);
752 753 754 755 756 757 758 759
        for (NodePropertyDescriptor npd : list) {
            if (npd.isApplicable(clazz)) {
                result.add(npd);
            }
        }
        return result;
    }

760 761 762
    /**
     * Gets all the descriptors sorted by their inheritance tree of {@link Describable}
     * so that descriptors of similar types come nearby.
763 764 765 766 767 768 769 770 771
     *
     * <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.
772 773
     */
    public static Collection<Descriptor> getSortedDescriptorsForGlobalConfig() {
774 775 776 777 778
        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();
779
            if (d.getGlobalConfigPage()==null)  continue;
780 781

            r.add(new Tag(d instanceof GlobalConfiguration ? c.ordinal() : 0, d));
782
        }
783 784 785 786
        Collections.sort(r);

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

788
        return DescriptorVisibilityFilter.apply(Jenkins.getInstance(),answer);
789 790
    }

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
    public static Collection<Descriptor> getSortedDescriptorsForGlobalSecurityConfig() {
        ExtensionList<GlobalSecurityConfigurationPart> exts = Jenkins.getInstance().getExtensionList(GlobalSecurityConfigurationPart.class);
        
        List<Tag> r = new ArrayList<Tag>(exts.size());
        for (ExtensionComponent<GlobalSecurityConfigurationPart> c : exts.getComponents()) {
            Descriptor d = c.getInstance();
            if (d.getGlobalConfigPage()==null)  continue;
            r.add(new Tag(c.ordinal(), d));
        }
        Collections.sort(r);

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

        return DescriptorVisibilityFilter.apply(Jenkins.getInstance(),answer);
        
    }
    
    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());
        }
825

826 827 828 829 830 831
        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);
        }
    }
832 833 834 835 836 837
    /**
     * Computes the path to the icon of the given action
     * from the context path.
     */
    public static String getIconFilePath(Action a) {
        String name = a.getIconFileName();
838 839
        if (name==null)     return null;
        if (name.startsWith("/"))
840 841 842 843
            return name.substring(1);
        else
            return "images/24x24/"+name;
    }
K
kohsuke 已提交
844 845 846 847 848

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

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
    /**
     * 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;

877
            if(ig== Jenkins.getInstance()) {
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
                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;
        }
    }
895

K
kohsuke 已提交
896
    public static Map<Thread,StackTraceElement[]> dumpAllThreads() {
897 898 899
        Map<Thread,StackTraceElement[]> sorted = new TreeMap<Thread,StackTraceElement[]>(new ThreadSorter());
        sorted.putAll(Thread.getAllStackTraces());
        return sorted;
900
    }
901

K
kohsuke 已提交
902
    @IgnoreJRERequirement
K
kohsuke 已提交
903
    public static ThreadInfo[] getThreadInfos() {
904
        ThreadMXBean mbean = ManagementFactory.getThreadMXBean();
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
        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;
        }
961 962
    }

963 964 965
    /**
     * Are we running on JRE6 or above?
     */
K
kohsuke 已提交
966
    @IgnoreJRERequirement
967 968 969 970 971 972 973 974 975
    public static boolean isMustangOrAbove() {
        try {
            System.console();
            return true;
        } catch(LinkageError e) {
            return false;
        }
    }

976
    // ThreadInfo.toString() truncates the stack trace by first 8, so needed my own version
K
kohsuke 已提交
977
    @IgnoreJRERequirement
978 979
    public static String dumpThreadInfo(ThreadInfo ti, ThreadGroupMap map) {
        String grp = map.getThreadGroup(ti);
980
        StringBuilder sb = new StringBuilder("\"" + ti.getThreadName() + "\"" +
981 982
                                             " Id=" + ti.getThreadId() + " Group=" +
                                             (grp != null ? grp : "?") + " " +
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 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
                                             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();
    }
1042 1043 1044 1045

    public static <T> Collection<T> emptyList() {
        return Collections.emptyList();
    }
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

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

K
kohsuke 已提交
1068 1069 1070 1071 1072 1073 1074 1075
    /**
     * 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 已提交
1076
    public static String getVersion() {
1077
        return Jenkins.VERSION;
K
kohsuke 已提交
1078 1079
    }

1080 1081 1082 1083
    /**
     * Resoruce path prefix.
     */
    public static String getResourcePath() {
1084
        return Jenkins.RESOURCE_PATH;
1085
    }
1086

1087 1088 1089 1090 1091 1092 1093 1094
    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;

1095
        StringBuilder buf = new StringBuilder(Stapler.getCurrentRequest().getContextPath());
1096
        buf.append(Jenkins.VIEW_RESOURCE_PATH).append('/');
1097 1098 1099 1100 1101 1102
        buf.append(clazz.getName().replace('.','/').replace('$','/'));
        buf.append('/').append(path);

        return buf.toString();
    }

1103
    public static boolean hasView(Object it, String path) throws IOException {
1104
        if(it==null)    return false;
1105
        return Stapler.getCurrentRequest().getView(it,path)!=null;
1106 1107
    }

1108 1109 1110 1111 1112 1113 1114 1115 1116
    /**
     * 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;
    }
1117

K
kohsuke 已提交
1118 1119 1120
    /**
     * If the value exists, return that value. Otherwise return the default value.
     * <p>
1121
     * Starting 1.294, JEXL supports the elvis operator "x?:y" that supercedes this.
K
kohsuke 已提交
1122 1123 1124
     *
     * @since 1.150
     */
K
kohsuke 已提交
1125
    public static <T> T defaulted(T value, T defaultValue) {
K
kohsuke 已提交
1126 1127 1128
        return value!=null ? value : defaultValue;
    }

1129 1130 1131 1132 1133
    public static String printThrowable(Throwable t) {
        StringWriter sw = new StringWriter();
        t.printStackTrace(new PrintWriter(sw));
        return sw.toString();
    }
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143

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

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
    /**
     * 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";
    }

1166
    private static final Pattern LINE_END = Pattern.compile("\r?\n");
K
kohsuke 已提交
1167 1168 1169 1170 1171

    /**
     * Checks if the current user is anonymous.
     */
    public static boolean isAnonymous() {
1172
        return Jenkins.getAuthentication() instanceof AnonymousAuthenticationToken;
K
kohsuke 已提交
1173
    }
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

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

1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    /**
     * 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();
    }

1199 1200 1201 1202 1203 1204 1205 1206 1207
    /**
     * 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;
    }
1208

1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
    /**
     * 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();
    }

1227 1228 1229 1230 1231 1232
    /**
     * 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();
1233
        if(urlName==null)   return null;    // to avoid NPE and fail to render the whole page
1234
        if(SCHEME.matcher(urlName).find())
1235
            return urlName; // absolute URL
1236
        if(urlName.startsWith("/"))
1237
            return joinPath(Stapler.getCurrentRequest().getContextPath(),urlName);
1238 1239
        else
            // relative URL name
1240
            return joinPath(Stapler.getCurrentRequest().getContextPath()+'/'+itUrl,urlName);
1241 1242
    }

K
kohsuke 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    /**
     * 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;
    }

1264 1265 1266 1267
    public String getSystemProperty(String key) {
        return System.getProperty(key);
    }

1268 1269 1270 1271 1272 1273 1274
    /**
     * 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 已提交
1275 1276
        // Try to infer this from the configured root URL.
        // This makes it work correctly when Hudson runs behind a reverse proxy.
1277
        String url = Jenkins.getInstance().getRootUrl();
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
        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();
    }

1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
    /**
     * 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 已提交
1302 1303 1304 1305 1306 1307 1308
    /**
     * 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();
1309
        if (href == null || href.length() <= 1) return ".".equals(href) && url.endsWith("/");
K
kohsuke 已提交
1310 1311
        url = URLDecoder.decode(url,"UTF-8");
        href = URLDecoder.decode(href,"UTF-8");
1312 1313
        if (url.endsWith("/")) url = url.substring(0, url.length() - 1);
        if (href.endsWith("/")) href = href.substring(0, href.length() - 1);
K
kohsuke 已提交
1314

M
mindless 已提交
1315
        return url.endsWith(href);
K
kohsuke 已提交
1316 1317
    }

1318 1319 1320 1321
    public <T> List<T> singletonList(T t) {
        return Collections.singletonList(t);
    }

1322 1323 1324 1325
    /**
     * Gets all the {@link PageDecorator}s.
     */
    public static List<PageDecorator> getPageDecorators() {
K
kohsuke 已提交
1326
        // this method may be called to render start up errors, at which point Hudson doesn't exist yet. see HUDSON-3608 
1327
        if(Jenkins.getInstance()==null)  return Collections.emptyList();
1328
        return PageDecorator.all();
1329
    }
K
kohsuke 已提交
1330
    
K
kohsuke 已提交
1331
    public static List<Descriptor<Cloud>> getCloudDescriptors() {
1332
        return Cloud.all();
K
kohsuke 已提交
1333
    }
1334

K
kohsuke 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343
    /**
     * 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;
    }

1344 1345 1346
    public static List<Descriptor<CrumbIssuer>> getCrumbIssuerDescriptors() {
        return CrumbIssuer.all();
    }
1347

1348
    public static String getCrumb(StaplerRequest req) {
1349
        Jenkins h = Jenkins.getInstance();
1350 1351
        CrumbIssuer issuer = h != null ? h.getCrumbIssuer() : null;
        return issuer != null ? issuer.getCrumb(req) : "";
1352
    }
1353

1354
    public static String getCrumbRequestField() {
1355
        Jenkins h = Jenkins.getInstance();
1356 1357
        CrumbIssuer issuer = h != null ? h.getCrumbIssuer() : null;
        return issuer != null ? issuer.getDescriptor().getCrumbRequestField() : "";
1358
    }
K
kohsuke 已提交
1359 1360 1361 1362

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

K
Kohsuke Kawaguchi 已提交
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    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 已提交
1374 1375 1376 1377
    /**
     * Generate a series of &lt;script> tags to include <tt>script.js</tt>
     * from {@link ConsoleAnnotatorFactory}s and {@link ConsoleAnnotationDescriptor}s.
     */
1378
    public static String generateConsoleAnnotationScriptAndStylesheet() {
K
kohsuke 已提交
1379 1380 1381
        String cp = Stapler.getCurrentRequest().getContextPath();
        StringBuilder buf = new StringBuilder();
        for (ConsoleAnnotatorFactory f : ConsoleAnnotatorFactory.all()) {
1382
            String path = cp + "/extensionList/" + ConsoleAnnotatorFactory.class.getName() + "/" + f.getClass().getName();
K
kohsuke 已提交
1383
            if (f.hasScript())
1384 1385 1386
                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 已提交
1387 1388
        }
        for (ConsoleAnnotationDescriptor d : ConsoleAnnotationDescriptor.all()) {
1389
            String path = cp+"/descriptor/"+d.clazz.getName();
K
kohsuke 已提交
1390
            if (d.hasScript())
1391 1392 1393
                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 已提交
1394 1395 1396
        }
        return buf.toString();
    }
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413

    /**
     * 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
            }
        }
    }
1414 1415 1416 1417 1418 1419 1420 1421 1422

    /**
     * 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();
    }
1423 1424 1425 1426

    public List filterDescriptors(Object context, Iterable descriptors) {
        return DescriptorVisibilityFilter.apply(context,descriptors);
    }
1427
    
1428
    private static final Pattern SCHEME = Pattern.compile("^([a-zA-Z][a-zA-Z0-9+.-]*):");
1429 1430

    /**
1431
     * Returns true if we are running unit tests.
1432
     */
1433 1434 1435
    public static boolean getIsUnitTest() {
        return Main.isUnitTest;
    }
R
rseguy 已提交
1436 1437 1438 1439 1440 1441

    /**
     * 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
1442 1443 1444 1445 1446
     * {@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 已提交
1447 1448 1449 1450 1451
     */
    public static boolean isArtifactsPermissionEnabled() {
        return Boolean.getBoolean("hudson.security.ArtifactsPermission");
    }

1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
    /**
     * 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");
    }

1467 1468
    public static String createRenderOnDemandProxy(JellyContext context, String attributesToCapture) {
        return Stapler.getCurrentRequest().createJavaScriptProxy(new RenderOnDemandClosure(context,attributesToCapture));
1469
    }
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484

    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 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493

    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;
    }
1494 1495 1496 1497 1498 1499 1500

    /**
     * Used for arguments to internationalized expressions to avoid escape
     */
    public static Object rawHtml(Object o) {
        return o==null ? null : new RawHtmlArgument(o);
    }
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511

    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;
    }

1512 1513 1514 1515 1516 1517 1518
    /**
     * 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
     */
1519
    public static String getAvatar(User user, String avatarSize) {
1520 1521
        return UserAvatarResolver.resolve(user, avatarSize);
    }
1522 1523 1524 1525 1526 1527 1528 1529

    /**
     * @deprecated as of 1.451
     *      Use {@link #getAvatar}
     */
    public String getUserAvatar(User user, String avatarSize) {
        return getAvatar(user,avatarSize);
    }
L
lvotypko 已提交
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
    
    
    /**
     * Returns human readable information about file size
     * 
     * @param file size in bytes
     * @return file size in appropriate unit
     */
    public static String humanReadableByteSize(long size){
        String measure = "B";
        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";
                }
            }
        }
        DecimalFormat format = new DecimalFormat("##.00");
        return format.format(number) + " " + measure;
    }
K
kohsuke 已提交
1556
}