UpdateSite.java 29.1 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.lifecycle.Lifecycle;
31 32 33
import hudson.model.UpdateCenter.UpdateCenterJob;
import hudson.util.FormValidation;
import hudson.util.FormValidation.Kind;
34
import hudson.util.HttpResponses;
35
import hudson.util.TextFile;
36
import static hudson.util.TimeUnit2.*;
37 38 39
import hudson.util.VersionNumber;
import java.io.File;
import java.io.IOException;
40
import java.net.URI;
41
import java.net.URL;
42
import java.net.URLEncoder;
43
import java.security.GeneralSecurityException;
44 45
import java.util.ArrayList;
import java.util.Collections;
46
import java.util.HashMap;
47 48 49
import java.util.List;
import java.util.Map;
import java.util.Set;
50
import java.util.TreeMap;
51
import java.util.concurrent.Callable;
52 53 54
import java.util.concurrent.Future;
import java.util.logging.Level;
import java.util.logging.Logger;
55 56 57
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import jenkins.model.Jenkins;
58
import jenkins.model.DownloadSettings;
59 60 61
import jenkins.util.JSONSignatureValidator;
import net.sf.json.JSONException;
import net.sf.json.JSONObject;
62
import org.apache.commons.io.IOUtils;
63 64 65 66 67 68 69 70 71
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;
72 73

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

    /**
     * When was the last time we asked a browser to check the data for us?
94
     * 0 means never.
95 96 97 98 99 100
     *
     * <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.
     */
101
    private transient volatile long lastAttempt;
102

103 104 105 106 107 108
    /**
     * 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;

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

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

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

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

    public UpdateSite(String id, String url) {
        this.id = id;
        this.url = url;
    }

    /**
     * Get ID string.
     */
137
    @Exported
138 139 140 141
    public String getId() {
        return id;
    }

142
    @Exported
143
    public long getDataTimestamp() {
144
        assert dataTimestamp >= 0;
145 146 147
        return dataTimestamp;
    }

148
    /**
149
     * Update the data file from the given URL if the file
150
     * does not exist, or is otherwise due for update.
151 152
     * 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!)
153
     * @return null if no updates are necessary, or the future result
154
     * @since 1.502
155
     */
156
    public @CheckForNull Future<FormValidation> updateDirectly(final boolean signatureCheck) {
157 158
        if (! getDataFile().exists() || isDue()) {
            return Jenkins.getInstance().getUpdateCenter().updateService.submit(new Callable<FormValidation>() {
159 160
                @Override public FormValidation call() throws Exception {
                    return updateDirectlyNow(signatureCheck);
161 162
                }
            });
163
        } else {
164
            return null;
165 166 167 168 169 170
        }
    }

    @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);
171 172
    }
    
173 174 175
    /**
     * This is the endpoint that receives the update center data file from the browser.
     */
176
    public FormValidation doPostBack(StaplerRequest req) throws IOException, GeneralSecurityException {
177
        DownloadSettings.checkPostBackAccess();
178
        return updateData(IOUtils.toString(req.getInputStream(),"UTF-8"), true);
179 180
    }

181
    private FormValidation updateData(String json, boolean signatureCheck)
182 183 184 185
            throws IOException {

        dataTimestamp = System.currentTimeMillis();

186 187
        JSONObject o = JSONObject.fromObject(json);

188 189 190 191 192 193 194 195
        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);
        }
196 197 198

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

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

    public FormValidation doVerifySignature() throws IOException {
        return verifySignature(getJSONObject());
213 214 215 216 217
    }

    /**
     * Verifies the signature in the update center data file.
     */
218
    private FormValidation verifySignature(JSONObject o) throws IOException {
219 220 221 222 223 224 225 226 227 228
        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+"'");
229 230 231 232 233 234 235
    }

    /**
     * Returns true if it's time for us to check for new version.
     */
    public boolean isDue() {
        if(neverUpdate)     return false;
236
        if(dataTimestamp == 0)
237 238
            dataTimestamp = getDataFile().file.lastModified();
        long now = System.currentTimeMillis();
239 240 241 242 243 244 245 246
        
        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
        }
247 248 249
        return due;
    }

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

262
    /**
263
     * Loads the update center data, if any and if modified since last read.
264 265 266 267
     *
     * @return  null if no data is available.
     */
    public Data getData() {
268 269 270 271 272 273 274 275 276 277 278
        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;
279 280 281 282 283 284
    }

    /**
     * Gets the raw update center JSON data.
     */
    public JSONObject getJSONObject() {
285 286 287
        TextFile df = getDataFile();
        if(df.exists()) {
            try {
288
                return JSONObject.fromObject(df.read());
289 290 291 292
            } 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;
293 294 295 296 297 298 299 300 301
            } 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;
        }
    }
302

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

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
    /**
     * 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);
    }

334 335 336 337
    public Api getApi() {
        return new Api(this);
    }

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

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    /**
     * 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 已提交
425 426 427 428
    /**
     * Is this the legacy default update center site?
     */
    public boolean isLegacyDefault() {
429
        return id.equals(UpdateCenter.ID_DEFAULT) && url.startsWith("http://hudson-ci.org/") || url.startsWith("http://updates.hudson-labs.org/");
K
kohsuke 已提交
430 431
    }

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

        /**
A
alanharder 已提交
442
         * The latest jenkins.war.
443 444 445 446 447 448 449 450
         */
        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 已提交
451
         * If this is non-null, Jenkins is going to check the connectivity to this URL to make sure
452 453 454 455 456 457
         * the network connection is up. Null to skip the check.
         */
        public final String connectionCheckUrl;

        Data(JSONObject o) {
            this.sourceId = (String)o.get("id");
458 459 460 461
            JSONObject c = o.optJSONObject("core");
            if (c!=null) {
                core = new Entry(sourceId, c, url);
            } else {
462 463 464 465 466 467 468 469 470 471 472 473 474
                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() {
475
            return core != null && core.isNewerThan(Jenkins.VERSION);
476 477 478 479 480 481 482 483 484 485
        }

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

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

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

        public Entry(String sourceId, JSONObject o) {
511 512 513 514
            this(sourceId, o, null);
        }

        Entry(String sourceId, JSONObject o, String baseURL) {
515 516 517
            this.sourceId = sourceId;
            this.name = o.getString("name");
            this.version = o.getString("version");
518 519 520 521 522 523 524 525
            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;
526 527 528 529 530 531 532 533 534 535 536 537 538
        }

        /**
         * 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 {
539
                return new VersionNumber(currentVersion).compareTo(new VersionNumber(version)) < 0;
540 541 542 543 544
            } catch (IllegalArgumentException e) {
                // couldn't parse as the version number.
                return false;
            }
        }
545

546 547 548 549
        public Api getApi() {
            return new Api(this);
        }

550 551 552 553 554 555
    }

    public final class Plugin extends Entry {
        /**
         * Optional URL to the Wiki page that discusses this plugin.
         */
556
        @Exported
557 558 559 560 561 562 563 564
        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
         */
565
        @Exported
566 567 568 569
        public final String title;
        /**
         * Optional excerpt string.
         */
570
        @Exported
571 572 573 574
        public final String excerpt;
        /**
         * Optional version # from which this plugin release is configuration-compatible.
         */
575
        @Exported
576
        public final String compatibleSinceVersion;
577
        /**
A
alanharder 已提交
578
         * Version of Jenkins core this plugin was compiled against.
579
         */
580
        @Exported
581
        public final String requiredCore;
582 583 584 585
        /**
         * Categories for grouping plugins, taken from labels assigned to wiki page.
         * Can be null.
         */
586
        @Exported
587
        public final String[] categories;
588

589 590 591
        /**
         * Dependencies of this plugin.
         */
592
        @Exported
593 594
        public final Map<String,String> dependencies = new HashMap<String,String>();
        
595 596 597 598 599 600
        /**
         * Optional dependencies of this plugin.
         */
        @Exported
        public final Map<String,String> optionalDependencies = new HashMap<String,String>();

601 602
        @DataBoundConstructor
        public Plugin(String sourceId, JSONObject o) {
603
            super(sourceId, o, UpdateSite.this.url);
604 605 606 607
            this.wiki = get(o,"wiki");
            this.title = get(o,"title");
            this.excerpt = get(o,"excerpt");
            this.compatibleSinceVersion = get(o,"compatibleSinceVersion");
608
            this.requiredCore = get(o,"requiredCore");
609
            this.categories = o.has("labels") ? (String[])o.getJSONArray("labels").toArray(new String[0]) : null;
610 611 612 613 614
            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
615 616 617 618 619 620
                    && !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"));
                    }
621 622 623 624
                }
                
            }

625 626 627 628 629 630 631 632 633 634
        }

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

        public String getDisplayName() {
635 636 637 638 639 640
            String displayName;
            if(title!=null)
                displayName = title;
            else
                displayName = name;
            return StringUtils.removeStart(displayName, "Jenkins ");
641 642 643 644 645 646
        }

        /**
         * If some version of this plugin is currently installed, return {@link PluginWrapper}.
         * Otherwise null.
         */
647
        @Exported
648
        public PluginWrapper getInstalled() {
649
            PluginManager pm = Jenkins.getInstance().getPluginManager();
650 651 652 653 654 655 656 657 658 659
            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.
         */
660
        @Exported
661 662 663 664 665 666 667 668 669 670 671 672 673
        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;
        }

674 675 676
        /**
         * Returns a list of dependent plugins which need to be installed or upgraded for this plugin to work.
         */
677
        @Exported
678 679 680
        public List<Plugin> getNeededDependencies() {
            List<Plugin> deps = new ArrayList<Plugin>();

681
            for(Map.Entry<String,String> e : dependencies.entrySet()) {
682
                Plugin depPlugin = Jenkins.getInstance().getUpdateCenter().getPlugin(e.getKey());
683 684 685 686
                if (depPlugin == null) {
                    LOGGER.log(Level.WARNING, "Could not find dependency {0} of {1}", new Object[] {e.getKey(), name});
                    continue;
                }
687
                VersionNumber requiredVersion = new VersionNumber(e.getValue());
688 689
                
                // Is the plugin installed already? If not, add it.
690 691 692
                PluginWrapper current = depPlugin.getInstalled();

                if (current ==null) {
693 694 695 696
                    deps.add(depPlugin);
                }
                // If the dependency plugin is installed, is the version we depend on newer than
                // what's installed? If so, upgrade.
697
                else if (current.isOlderThan(requiredVersion)) {
698 699 700 701
                    deps.add(depPlugin);
                }
            }

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
            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);
                }
            }

718 719 720
            return deps;
        }
        
721
        public boolean isForNewerHudson() {
722 723
            try {
                return requiredCore!=null && new VersionNumber(requiredCore).isNewerThan(
724
                  new VersionNumber(Jenkins.VERSION.replaceFirst("SHOT *\\(private.*\\)", "SHOT")));
725 726 727
            } catch (NumberFormatException nfe) {
                return true;  // If unable to parse version
            }
728
        }
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765

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

767 768 769 770 771 772 773 774
        /**
         * @deprecated as of 1.326
         *      Use {@link #deploy()}.
         */
        public void install() {
            deploy();
        }

775 776 777 778
        public Future<UpdateCenterJob> deploy() {
            return deploy(false);
        }

779 780 781 782 783 784
        /**
         * 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.
785 786 787 788
         *
         * @param dynamicLoad
         *      If true, the plugin will be dynamically loaded into this Jenkins. If false,
         *      the plugin will only take effect after the reboot.
789
         *      See {@link UpdateCenter#isRestartRequiredForCompletion()}
790
         */
791
        public Future<UpdateCenterJob> deploy(boolean dynamicLoad) {
792 793
            Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
            UpdateCenter uc = Jenkins.getInstance().getUpdateCenter();
794
            for (Plugin dep : getNeededDependencies()) {
795 796 797 798 799 800 801
                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");
                }
802
            }
803
            return uc.addJob(uc.new InstallationJob(this, UpdateSite.this, Jenkins.getAuthentication(), dynamicLoad));
804 805
        }

806 807 808 809
        /**
         * Schedules the downgrade of this plugin.
         */
        public Future<UpdateCenterJob> deployBackup() {
810 811 812
            Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
            UpdateCenter uc = Jenkins.getInstance().getUpdateCenter();
            return uc.addJob(uc.new PluginDowngradeJob(this, UpdateSite.this, Jenkins.getAuthentication()));
813
        }
814 815 816
        /**
         * Making the installation web bound.
         */
817
        @RequirePOST
818 819 820 821 822
        public HttpResponse doInstall() throws IOException {
            deploy(false);
            return HttpResponses.redirectTo("../..");
        }

823
        @RequirePOST
824 825 826
        public HttpResponse doInstallNow() throws IOException {
            deploy(true);
            return HttpResponses.redirectTo("../..");
827
        }
828 829 830 831

        /**
         * Performs the downgrade of the plugin.
         */
832
        @RequirePOST
833
        public HttpResponse doDowngrade() throws IOException {
834
            deployBackup();
835
            return HttpResponses.redirectTo("../..");
836
        }
837 838 839 840 841 842
    }

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

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

843
    // The name uses UpdateCenter for compatibility reason.
844
    public static boolean neverUpdate = Boolean.getBoolean(UpdateCenter.class.getName()+".never");
845 846

}