UpdateSite.java 29.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
 * The MIT License
 * 
 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Yahoo! Inc., Seiji Sogabe,
 *                          Andrew Bayer
 * 
 * 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.
 */

package hudson.model;

import hudson.PluginManager;
29
import hudson.PluginWrapper;
30
import hudson.Util;
31
import hudson.lifecycle.Lifecycle;
32 33 34
import hudson.model.UpdateCenter.UpdateCenterJob;
import hudson.util.FormValidation;
import hudson.util.FormValidation.Kind;
35
import hudson.util.HttpResponses;
36
import hudson.util.TextFile;
37
import static hudson.util.TimeUnit2.*;
38 39 40
import hudson.util.VersionNumber;
import java.io.File;
import java.io.IOException;
41
import java.net.URI;
42
import java.net.URL;
43
import java.net.URLEncoder;
44
import java.security.GeneralSecurityException;
45 46
import java.util.ArrayList;
import java.util.Collections;
47
import java.util.HashMap;
48 49 50
import java.util.List;
import java.util.Map;
import java.util.Set;
51
import java.util.TreeMap;
52
import java.util.concurrent.Callable;
53 54 55
import java.util.concurrent.Future;
import java.util.logging.Level;
import java.util.logging.Logger;
56 57 58
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import jenkins.model.Jenkins;
59
import jenkins.model.DownloadSettings;
60 61 62
import jenkins.util.JSONSignatureValidator;
import net.sf.json.JSONException;
import net.sf.json.JSONObject;
63
import org.apache.commons.io.IOUtils;
64 65 66 67 68 69 70 71 72
import org.apache.commons.lang.StringUtils;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.interceptor.RequirePOST;
73 74

/**
K
Kohsuke Kawaguchi 已提交
75
 * Source of the update center information, like "http://jenkins-ci.org/update-center.json"
76 77
 *
 * <p>
A
alanharder 已提交
78
 * Jenkins can have multiple {@link UpdateSite}s registered in the system, so that it can pick up plugins
79 80 81 82
 * from different locations.
 *
 * @author Andrew Bayer
 * @author Kohsuke Kawaguchi
83
 * @since 1.333
84
 */
85
@ExportedBean
86 87 88
public class UpdateSite {
    /**
     * What's the time stamp of data file?
89
     * 0 means never.
90
     */
91
    private transient volatile long dataTimestamp;
92 93 94

    /**
     * When was the last time we asked a browser to check the data for us?
95
     * 0 means never.
96 97 98 99 100 101
     *
     * <p>
     * There's normally some delay between when we send HTML that includes the check code,
     * until we get the data back, so this variable is used to avoid asking too many browseres
     * all at once.
     */
102
    private transient volatile long lastAttempt;
103

104 105 106 107 108 109
    /**
     * If the attempt to fetch data fails, we progressively use longer time out before retrying,
     * to avoid overloading the server.
     */
    private transient volatile long retryWindow;

110 111 112 113 114 115 116 117
    /**
     * lastModified time of the data file when it was last read.
     */
    private transient long dataLastReadFromFile;

    /**
     * Latest data as read from the data file.
     */
118
    private transient Data data;
119

120 121 122 123 124 125
    /**
     * ID string for this update source.
     */
    private final String id;

    /**
K
Kohsuke Kawaguchi 已提交
126
     * Path to <tt>update-center.json</tt>, like <tt>http://jenkins-ci.org/update-center.json</tt>.
127 128 129
     */
    private final String url;

130 131


132 133 134 135 136 137 138 139
    public UpdateSite(String id, String url) {
        this.id = id;
        this.url = url;
    }

    /**
     * Get ID string.
     */
140
    @Exported
141 142 143 144
    public String getId() {
        return id;
    }

145
    @Exported
146
    public long getDataTimestamp() {
147
        assert dataTimestamp >= 0;
148 149 150
        return dataTimestamp;
    }

151
    /**
152
     * Update the data file from the given URL if the file
153
     * does not exist, or is otherwise due for update.
154 155
     * Accepted formats are JSONP or HTML with {@code postMessage}, not raw JSON.
     * @param signatureCheck whether to enforce the signature (may be off only for testing!)
156
     * @return null if no updates are necessary, or the future result
157
     * @since 1.502
158
     */
159
    public @CheckForNull Future<FormValidation> updateDirectly(final boolean signatureCheck) {
160 161
        if (! getDataFile().exists() || isDue()) {
            return Jenkins.getInstance().getUpdateCenter().updateService.submit(new Callable<FormValidation>() {
162 163
                @Override public FormValidation call() throws Exception {
                    return updateDirectlyNow(signatureCheck);
164 165
                }
            });
166
        } else {
167
            return null;
168 169 170 171 172 173
        }
    }

    @Restricted(NoExternalUse.class)
    public @Nonnull FormValidation updateDirectlyNow(boolean signatureCheck) throws IOException {
        return updateData(DownloadService.loadJSON(new URL(getUrl() + "?id=" + URLEncoder.encode(getId(), "UTF-8") + "&version=" + URLEncoder.encode(Jenkins.VERSION, "UTF-8"))), signatureCheck);
174 175
    }
    
176 177 178
    /**
     * This is the endpoint that receives the update center data file from the browser.
     */
179
    public FormValidation doPostBack(StaplerRequest req) throws IOException, GeneralSecurityException {
180
        DownloadSettings.checkPostBackAccess();
181
        return updateData(IOUtils.toString(req.getInputStream(),"UTF-8"), true);
182 183
    }

184
    private FormValidation updateData(String json, boolean signatureCheck)
185 186 187 188
            throws IOException {

        dataTimestamp = System.currentTimeMillis();

189 190
        JSONObject o = JSONObject.fromObject(json);

191 192 193 194 195 196 197 198
        try {
            int v = o.getInt("updateCenterVersion");
            if (v != 1) {
                throw new IllegalArgumentException("Unrecognized update center version: " + v);
            }
        } catch (JSONException x) {
            throw new IllegalArgumentException("Could not find (numeric) updateCenterVersion in " + json, x);
        }
199 200 201

        if (signatureCheck) {
            FormValidation e = verifySignature(o);
202
            if (e.kind!=Kind.OK) {
203
                LOGGER.severe(e.toString());
204 205
                return e;
            }
206 207
        }

K
bug fix  
Kohsuke Kawaguchi 已提交
208
        LOGGER.info("Obtained the latest update center data file for UpdateSource " + id);
209
        retryWindow = 0;
210
        getDataFile().write(json);
211 212 213 214 215
        return FormValidation.ok();
    }

    public FormValidation doVerifySignature() throws IOException {
        return verifySignature(getJSONObject());
216 217 218 219 220
    }

    /**
     * Verifies the signature in the update center data file.
     */
221
    private FormValidation verifySignature(JSONObject o) throws IOException {
222 223 224 225 226 227 228 229 230 231
        return getJsonSignatureValidator().verifySignature(o);
    }

    /**
     * Let sub-classes of UpdateSite provide their own signature validator.
     * @return the signature validator.
     */
    @Nonnull
    protected JSONSignatureValidator getJsonSignatureValidator() {
        return new JSONSignatureValidator("update site '"+id+"'");
232 233 234 235 236 237 238
    }

    /**
     * Returns true if it's time for us to check for new version.
     */
    public boolean isDue() {
        if(neverUpdate)     return false;
239
        if(dataTimestamp == 0)
240 241
            dataTimestamp = getDataFile().file.lastModified();
        long now = System.currentTimeMillis();
242 243 244 245 246 247 248 249
        
        retryWindow = Math.max(retryWindow,SECONDS.toMillis(15));
        
        boolean due = now - dataTimestamp > DAY && now - lastAttempt > retryWindow;
        if(due) {
            lastAttempt = now;
            retryWindow = Math.min(retryWindow*2, HOURS.toMillis(1)); // exponential back off but at most 1 hour
        }
250 251 252
        return due;
    }

253 254 255 256 257
    /**
     * Invalidates the cached data and force retrieval.
     *
     * @since 1.432
     */
258
    @RequirePOST
259 260 261 262 263 264
    public HttpResponse doInvalidateData() {
        Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
        dataTimestamp = 0;
        return HttpResponses.ok();
    }

265
    /**
266
     * Loads the update center data, if any and if modified since last read.
267 268 269 270
     *
     * @return  null if no data is available.
     */
    public Data getData() {
271 272 273 274 275 276 277 278 279 280 281
        TextFile df = getDataFile();
        if (df.exists() && dataLastReadFromFile != df.file.lastModified()) {
            JSONObject o = getJSONObject();
            if (o!=null) {
                data = new Data(o);
                dataLastReadFromFile = df.file.lastModified();
            } else {
                data = null;
            }
        }
        return data;
282 283 284 285 286 287
    }

    /**
     * Gets the raw update center JSON data.
     */
    public JSONObject getJSONObject() {
288 289 290
        TextFile df = getDataFile();
        if(df.exists()) {
            try {
291
                return JSONObject.fromObject(df.read());
292 293 294 295
            } catch (JSONException e) {
                LOGGER.log(Level.SEVERE,"Failed to parse "+df,e);
                df.delete(); // if we keep this file, it will cause repeated failures
                return null;
296 297 298 299 300 301 302 303 304
            } catch (IOException e) {
                LOGGER.log(Level.SEVERE,"Failed to parse "+df,e);
                df.delete(); // if we keep this file, it will cause repeated failures
                return null;
            }
        } else {
            return null;
        }
    }
305

306 307 308 309
    /**
     * Returns a list of plugins that should be shown in the "available" tab.
     * These are "all plugins - installed plugins".
     */
310
    @Exported
311 312 313
    public List<Plugin> getAvailables() {
        List<Plugin> r = new ArrayList<Plugin>();
        Data data = getData();
314
        if(data==null)     return Collections.emptyList();
315 316 317 318 319 320
        for (Plugin p : data.plugins.values()) {
            if(p.getInstalled()==null)
                r.add(p);
        }
        return r;
    }
321

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    /**
     * Gets the information about a specific plugin.
     *
     * @param artifactId
     *      The short name of the plugin. Corresponds to {@link PluginWrapper#getShortName()}.
     *
     * @return
     *      null if no such information is found.
     */
    public Plugin getPlugin(String artifactId) {
        Data dt = getData();
        if(dt==null)    return null;
        return dt.plugins.get(artifactId);
    }

337 338 339 340
    public Api getApi() {
        return new Api(this);
    }

341 342 343
    /**
     * Returns an "always up" server for Internet connectivity testing, or null if we are going to skip the test.
     */
344
    @Exported
345 346 347 348 349 350 351 352 353 354
    public String getConnectionCheckUrl() {
        Data dt = getData();
        if(dt==null)    return "http://www.google.com/";
        return dt.connectionCheckUrl;
    }

    /**
     * This is where we store the update center data.
     */
    private TextFile getDataFile() {
355
        return new TextFile(new File(Jenkins.getInstance().getRootDir(),
356 357 358 359 360 361 362 363 364
                                     "updates/" + getId()+".json"));
    }
    
    /**
     * Returns the list of plugins that are updates to currently installed ones.
     *
     * @return
     *      can be empty but never null.
     */
365
    @Exported
366 367 368 369 370
    public List<Plugin> getUpdates() {
        Data data = getData();
        if(data==null)      return Collections.emptyList(); // fail to determine
        
        List<Plugin> r = new ArrayList<Plugin>();
371
        for (PluginWrapper pw : Jenkins.getInstance().getPluginManager().getPlugins()) {
372 373 374 375 376 377 378 379 380 381
            Plugin p = pw.getUpdateInfo();
            if(p!=null) r.add(p);
        }
        
        return r;
    }
    
    /**
     * Does any of the plugin has updates?
     */
382
    @Exported
383 384 385 386
    public boolean hasUpdates() {
        Data data = getData();
        if(data==null)      return false;
        
387
        for (PluginWrapper pw : Jenkins.getInstance().getPluginManager().getPlugins()) {
388 389
            if(!pw.isBundled() && pw.getUpdateInfo()!=null)
                // do not advertize updates to bundled plugins, since we generally want users to get them
A
alanharder 已提交
390
                // as a part of jenkins.war updates. This also avoids unnecessary pinning of plugins. 
391 392 393 394 395 396 397 398 399 400
                return true;
        }
        return false;
    }
    
    
    /**
     * Exposed to get rid of hardcoding of the URL that serves up update-center.json
     * in Javascript.
     */
401
    @Exported
402 403 404 405
    public String getUrl() {
        return url;
    }

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    /**
     * Where to actually download the update center?
     *
     * @deprecated
     *      Exposed only for UI.
     */
    public String getDownloadUrl() {
        /*
            HACKISH:

            Loading scripts in HTTP from HTTPS pages cause browsers to issue a warning dialog.
            The elegant way to solve the problem is to always load update center from HTTPS,
            but our backend mirroring scheme isn't ready for that. So this hack serves regular
            traffic in HTTP server, and only use HTTPS update center for Jenkins in HTTPS.

            We'll monitor the traffic to see if we can sustain this added traffic.
         */
        if (url.equals("http://updates.jenkins-ci.org/update-center.json") && Jenkins.getInstance().isRootUrlSecure())
            return "https"+url.substring(4);
        return url;
    }

K
kohsuke 已提交
428 429 430 431
    /**
     * Is this the legacy default update center site?
     */
    public boolean isLegacyDefault() {
432
        return id.equals(UpdateCenter.ID_DEFAULT) && url.startsWith("http://hudson-ci.org/") || url.startsWith("http://updates.hudson-labs.org/");
K
kohsuke 已提交
433 434
    }

435 436 437 438 439 440 441 442 443 444
    /**
     * In-memory representation of the update center data.
     */
    public final class Data {
        /**
         * The {@link UpdateSite} ID.
         */
        public final String sourceId;

        /**
A
alanharder 已提交
445
         * The latest jenkins.war.
446 447 448 449 450 451 452 453
         */
        public final Entry core;
        /**
         * Plugins in the repository, keyed by their artifact IDs.
         */
        public final Map<String,Plugin> plugins = new TreeMap<String,Plugin>(String.CASE_INSENSITIVE_ORDER);

        /**
A
alanharder 已提交
454
         * If this is non-null, Jenkins is going to check the connectivity to this URL to make sure
455 456 457 458 459 460
         * the network connection is up. Null to skip the check.
         */
        public final String connectionCheckUrl;

        Data(JSONObject o) {
            this.sourceId = (String)o.get("id");
461 462 463 464
            JSONObject c = o.optJSONObject("core");
            if (c!=null) {
                core = new Entry(sourceId, c, url);
            } else {
465 466 467 468 469 470 471 472 473 474 475 476 477
                core = null;
            }
            for(Map.Entry<String,JSONObject> e : (Set<Map.Entry<String,JSONObject>>)o.getJSONObject("plugins").entrySet()) {
                plugins.put(e.getKey(),new Plugin(sourceId, e.getValue()));
            }

            connectionCheckUrl = (String)o.get("connectionCheckUrl");
        }

        /**
         * Is there a new version of the core?
         */
        public boolean hasCoreUpdates() {
478
            return core != null && core.isNewerThan(Jenkins.VERSION);
479 480 481 482 483 484 485 486 487 488
        }

        /**
         * Do we support upgrade?
         */
        public boolean canUpgrade() {
            return Lifecycle.get().canRewriteHudsonWar();
        }
    }

489
    @ExportedBean
490 491 492 493
    public static class Entry {
        /**
         * {@link UpdateSite} ID.
         */
494
        @Exported
495 496 497 498 499
        public final String sourceId;

        /**
         * Artifact ID.
         */
500
        @Exported
501 502 503 504
        public final String name;
        /**
         * The version.
         */
505
        @Exported
506 507 508 509
        public final String version;
        /**
         * Download URL.
         */
510
        @Exported
511 512
        public final String url;

513
        private final String sha1;
514

515
        public Entry(String sourceId, JSONObject o) {
516 517 518 519
            this(sourceId, o, null);
        }

        Entry(String sourceId, JSONObject o, String baseURL) {
520 521 522
            this.sourceId = sourceId;
            this.name = o.getString("name");
            this.version = o.getString("version");
523 524 525 526 527 528

            String sha = Util.fixEmpty(o.optString("sha1"));
            // Trim this to prevent issues when the other end used Base64.encodeBase64String that added newlines
            // to the end in old commons-codec. Not the case on updates.jenkins-ci.org, but let's be safe.
            this.sha1 = (sha == null) ? null : sha.trim();

529 530 531 532 533 534 535 536
            String url = o.getString("url");
            if (!URI.create(url).isAbsolute()) {
                if (baseURL == null) {
                    throw new IllegalArgumentException("Cannot resolve " + url + " without a base URL");
                }
                url = URI.create(baseURL).resolve(url).toString();
            }
            this.url = url;
537 538
        }

539 540 541 542 543 544
        /**
         * The base64 encoded binary SHA-1 checksum of the file.
         * Can be null if not provided by the update site.
         * @since TODO
         */
        // TODO @Exported assuming we want this in the API
545 546
        // TODO No new API in LTS, remove for mainline
        @Restricted(NoExternalUse.class)
547 548 549 550
        public String getSha1() {
            return sha1;
        }

551 552 553 554 555 556 557 558 559 560 561
        /**
         * Checks if the specified "current version" is older than the version of this entry.
         *
         * @param currentVersion
         *      The string that represents the version number to be compared.
         * @return
         *      true if the version listed in this entry is newer.
         *      false otherwise, including the situation where the strings couldn't be parsed as version numbers.
         */
        public boolean isNewerThan(String currentVersion) {
            try {
562
                return new VersionNumber(currentVersion).compareTo(new VersionNumber(version)) < 0;
563 564 565 566 567
            } catch (IllegalArgumentException e) {
                // couldn't parse as the version number.
                return false;
            }
        }
568

569 570 571 572
        public Api getApi() {
            return new Api(this);
        }

573 574 575 576 577 578
    }

    public final class Plugin extends Entry {
        /**
         * Optional URL to the Wiki page that discusses this plugin.
         */
579
        @Exported
580 581 582 583 584 585 586 587
        public final String wiki;
        /**
         * Human readable title of the plugin, taken from Wiki page.
         * Can be null.
         *
         * <p>
         * beware of XSS vulnerability since this data comes from Wiki
         */
588
        @Exported
589 590 591 592
        public final String title;
        /**
         * Optional excerpt string.
         */
593
        @Exported
594 595 596 597
        public final String excerpt;
        /**
         * Optional version # from which this plugin release is configuration-compatible.
         */
598
        @Exported
599
        public final String compatibleSinceVersion;
600
        /**
A
alanharder 已提交
601
         * Version of Jenkins core this plugin was compiled against.
602
         */
603
        @Exported
604
        public final String requiredCore;
605 606 607 608
        /**
         * Categories for grouping plugins, taken from labels assigned to wiki page.
         * Can be null.
         */
609
        @Exported
610
        public final String[] categories;
611

612 613 614
        /**
         * Dependencies of this plugin.
         */
615
        @Exported
616 617
        public final Map<String,String> dependencies = new HashMap<String,String>();
        
618 619 620 621 622 623
        /**
         * Optional dependencies of this plugin.
         */
        @Exported
        public final Map<String,String> optionalDependencies = new HashMap<String,String>();

624 625
        @DataBoundConstructor
        public Plugin(String sourceId, JSONObject o) {
626
            super(sourceId, o, UpdateSite.this.url);
627 628 629 630
            this.wiki = get(o,"wiki");
            this.title = get(o,"title");
            this.excerpt = get(o,"excerpt");
            this.compatibleSinceVersion = get(o,"compatibleSinceVersion");
631
            this.requiredCore = get(o,"requiredCore");
632
            this.categories = o.has("labels") ? (String[])o.getJSONArray("labels").toArray(new String[0]) : null;
633 634 635 636 637
            for(Object jo : o.getJSONArray("dependencies")) {
                JSONObject depObj = (JSONObject) jo;
                // Make sure there's a name attribute, that that name isn't maven-plugin - we ignore that one -
                // and that the optional value isn't true.
                if (get(depObj,"name")!=null
638 639 640 641 642 643
                    && !get(depObj,"name").equals("maven-plugin")) {
                    if (get(depObj, "optional").equals("false")) {
                        dependencies.put(get(depObj, "name"), get(depObj, "version"));
                    } else {
                        optionalDependencies.put(get(depObj, "name"), get(depObj, "version"));
                    }
644 645 646 647
                }
                
            }

648 649 650 651 652 653 654 655 656 657
        }

        private String get(JSONObject o, String prop) {
            if(o.has(prop))
                return o.getString(prop);
            else
                return null;
        }

        public String getDisplayName() {
658 659 660 661 662 663
            String displayName;
            if(title!=null)
                displayName = title;
            else
                displayName = name;
            return StringUtils.removeStart(displayName, "Jenkins ");
664 665 666 667 668 669
        }

        /**
         * If some version of this plugin is currently installed, return {@link PluginWrapper}.
         * Otherwise null.
         */
670
        @Exported
671
        public PluginWrapper getInstalled() {
672
            PluginManager pm = Jenkins.getInstance().getPluginManager();
673 674 675 676 677 678 679 680 681 682
            return pm.getPlugin(name);
        }

        /**
         * If the plugin is already installed, and the new version of the plugin has a "compatibleSinceVersion"
         * value (i.e., it's only directly compatible with that version or later), this will check to
         * see if the installed version is older than the compatible-since version. If it is older, it'll return false.
         * If it's not older, or it's not installed, or it's installed but there's no compatibleSinceVersion
         * specified, it'll return true.
         */
683
        @Exported
684 685 686 687 688 689 690 691 692 693 694 695 696
        public boolean isCompatibleWithInstalledVersion() {
            PluginWrapper installedVersion = getInstalled();
            if (installedVersion != null) {
                if (compatibleSinceVersion != null) {
                    if (new VersionNumber(installedVersion.getVersion())
                            .isOlderThan(new VersionNumber(compatibleSinceVersion))) {
                        return false;
                    }
                }
            }
            return true;
        }

697 698 699
        /**
         * Returns a list of dependent plugins which need to be installed or upgraded for this plugin to work.
         */
700
        @Exported
701 702 703
        public List<Plugin> getNeededDependencies() {
            List<Plugin> deps = new ArrayList<Plugin>();

704
            for(Map.Entry<String,String> e : dependencies.entrySet()) {
705
                Plugin depPlugin = Jenkins.getInstance().getUpdateCenter().getPlugin(e.getKey());
706 707 708 709
                if (depPlugin == null) {
                    LOGGER.log(Level.WARNING, "Could not find dependency {0} of {1}", new Object[] {e.getKey(), name});
                    continue;
                }
710
                VersionNumber requiredVersion = new VersionNumber(e.getValue());
711 712
                
                // Is the plugin installed already? If not, add it.
713 714 715
                PluginWrapper current = depPlugin.getInstalled();

                if (current ==null) {
716 717 718 719
                    deps.add(depPlugin);
                }
                // If the dependency plugin is installed, is the version we depend on newer than
                // what's installed? If so, upgrade.
720
                else if (current.isOlderThan(requiredVersion)) {
721 722 723 724
                    deps.add(depPlugin);
                }
            }

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
            for(Map.Entry<String,String> e : optionalDependencies.entrySet()) {
                Plugin depPlugin = Jenkins.getInstance().getUpdateCenter().getPlugin(e.getKey());
                if (depPlugin == null) {
                    continue;
                }
                VersionNumber requiredVersion = new VersionNumber(e.getValue());

                PluginWrapper current = depPlugin.getInstalled();

                // If the optional dependency plugin is installed, is the version we depend on newer than
                // what's installed? If so, upgrade.
                if (current != null && current.isOlderThan(requiredVersion)) {
                    deps.add(depPlugin);
                }
            }

741 742 743
            return deps;
        }
        
744
        public boolean isForNewerHudson() {
745 746
            try {
                return requiredCore!=null && new VersionNumber(requiredCore).isNewerThan(
747
                  new VersionNumber(Jenkins.VERSION.replaceFirst("SHOT *\\(private.*\\)", "SHOT")));
748 749 750
            } catch (NumberFormatException nfe) {
                return true;  // If unable to parse version
            }
751
        }
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788

        public VersionNumber getNeededDependenciesRequiredCore() {
            VersionNumber versionNumber = null;
            try {
                versionNumber = requiredCore == null ? null : new VersionNumber(requiredCore);
            } catch (NumberFormatException nfe) {
                // unable to parse version
            }
            for (Plugin p: getNeededDependencies()) {
                VersionNumber v = p.getNeededDependenciesRequiredCore();
                if (versionNumber == null || v.isNewerThan(versionNumber)) versionNumber = v;
            }
            return versionNumber;
        }

        public boolean isNeededDependenciesForNewerJenkins() {
            for (Plugin p: getNeededDependencies()) {
                if (p.isForNewerHudson() || p.isNeededDependenciesForNewerJenkins()) return true;
            }
            return false;
        }

        /**
         * If at least some of the plugin's needed dependencies are already installed, and the new version of the
         * needed dependencies plugin have a "compatibleSinceVersion"
         * value (i.e., it's only directly compatible with that version or later), this will check to
         * see if the installed version is older than the compatible-since version. If it is older, it'll return false.
         * If it's not older, or it's not installed, or it's installed but there's no compatibleSinceVersion
         * specified, it'll return true.
         */
        public boolean isNeededDependenciesCompatibleWithInstalledVersion() {
            for (Plugin p: getNeededDependencies()) {
                if (!p.isCompatibleWithInstalledVersion() || !p.isNeededDependenciesCompatibleWithInstalledVersion())
                    return false;
            }
            return true;
        }
789

790 791 792 793 794 795 796 797
        /**
         * @deprecated as of 1.326
         *      Use {@link #deploy()}.
         */
        public void install() {
            deploy();
        }

798 799 800 801
        public Future<UpdateCenterJob> deploy() {
            return deploy(false);
        }

802 803 804 805 806 807
        /**
         * Schedules the installation of this plugin.
         *
         * <p>
         * This is mainly intended to be called from the UI. The actual installation work happens
         * asynchronously in another thread.
808 809 810 811
         *
         * @param dynamicLoad
         *      If true, the plugin will be dynamically loaded into this Jenkins. If false,
         *      the plugin will only take effect after the reboot.
812
         *      See {@link UpdateCenter#isRestartRequiredForCompletion()}
813
         */
814
        public Future<UpdateCenterJob> deploy(boolean dynamicLoad) {
815 816
            Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
            UpdateCenter uc = Jenkins.getInstance().getUpdateCenter();
817
            for (Plugin dep : getNeededDependencies()) {
818 819 820 821 822 823 824
                UpdateCenter.InstallationJob job = uc.getJob(dep);
                if (job == null || job.status instanceof UpdateCenter.DownloadJob.Failure) {
                    LOGGER.log(Level.WARNING, "Adding dependent install of " + dep.name + " for plugin " + name);
                    dep.deploy(dynamicLoad);
                } else {
                    LOGGER.log(Level.WARNING, "Dependent install of " + dep.name + " for plugin " + name + " already added, skipping");
                }
825
            }
826
            return uc.addJob(uc.new InstallationJob(this, UpdateSite.this, Jenkins.getAuthentication(), dynamicLoad));
827 828
        }

829 830 831 832
        /**
         * Schedules the downgrade of this plugin.
         */
        public Future<UpdateCenterJob> deployBackup() {
833 834 835
            Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
            UpdateCenter uc = Jenkins.getInstance().getUpdateCenter();
            return uc.addJob(uc.new PluginDowngradeJob(this, UpdateSite.this, Jenkins.getAuthentication()));
836
        }
837 838 839
        /**
         * Making the installation web bound.
         */
840
        @RequirePOST
841 842 843 844 845
        public HttpResponse doInstall() throws IOException {
            deploy(false);
            return HttpResponses.redirectTo("../..");
        }

846
        @RequirePOST
847 848 849
        public HttpResponse doInstallNow() throws IOException {
            deploy(true);
            return HttpResponses.redirectTo("../..");
850
        }
851 852 853 854

        /**
         * Performs the downgrade of the plugin.
         */
855
        @RequirePOST
856
        public HttpResponse doDowngrade() throws IOException {
857
            deployBackup();
858
            return HttpResponses.redirectTo("../..");
859
        }
860 861 862 863 864 865
    }

    private static final long DAY = DAYS.toMillis(1);

    private static final Logger LOGGER = Logger.getLogger(UpdateSite.class.getName());

866
    // The name uses UpdateCenter for compatibility reason.
867
    public static boolean neverUpdate = Boolean.getBoolean(UpdateCenter.class.getName()+".never");
868 869

}