DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (375f9429ba87)

VCS Links

Line Code
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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

/* exported logger */

var EXPORTED_SYMBOLS = [];

const { AddonManager, AddonManagerPrivate } = ChromeUtils.import(
  "resource://gre/modules/AddonManager.jsm"
);
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");

ChromeUtils.defineModuleGetter(
  this,
  "Blocklist",
  "resource://gre/modules/Blocklist.jsm"
);

const URI_EXTENSION_STRINGS =
  "chrome://mozapps/locale/extensions/extensions.properties";
const LIST_UPDATED_TOPIC = "plugins-list-updated";

const { Log } = ChromeUtils.import("resource://gre/modules/Log.jsm");
const LOGGER_ID = "addons.plugins";

// Create a new logger for use by the Addons Plugin Provider
// (Requires AddonManager.jsm)
var logger = Log.repository.getLogger(LOGGER_ID);

var PluginProvider = {
  get name() {
    return "PluginProvider";
  },

  // A dictionary mapping IDs to names and descriptions
  plugins: null,

  startup() {
    Services.obs.addObserver(this, LIST_UPDATED_TOPIC);
  },

  /**
   * Called when the application is shutting down. Only necessary for tests
   * to be able to simulate a shutdown.
   */
  shutdown() {
    this.plugins = null;
    Services.obs.removeObserver(this, LIST_UPDATED_TOPIC);
  },

  async observe(aSubject, aTopic, aData) {
    switch (aTopic) {
      case LIST_UPDATED_TOPIC:
        if (this.plugins) {
          this.updatePluginList();
        }
        break;
    }
  },

  /**
   * Creates a PluginWrapper for a plugin object.
   */
  buildWrapper(aPlugin) {
    return new PluginWrapper(
      aPlugin.id,
      aPlugin.name,
      aPlugin.description,
      aPlugin.tags
    );
  },

  /**
   * Called to get an Addon with a particular ID.
   *
   * @param  aId
   *         The ID of the add-on to retrieve
   */
  async getAddonByID(aId) {
    if (!this.plugins) {
      this.buildPluginList();
    }

    if (aId in this.plugins) {
      return this.buildWrapper(this.plugins[aId]);
    }
    return null;
  },

  /**
   * Called to get Addons of a particular type.
   *
   * @param  aTypes
   *         An array of types to fetch. Can be null to get all types.
   */
  async getAddonsByTypes(aTypes) {
    if (aTypes && !aTypes.includes("plugin")) {
      return [];
    }

    if (!this.plugins) {
      this.buildPluginList();
    }

    return Promise.all(
      Object.keys(this.plugins).map(id => this.getAddonByID(id))
    );
  },

  /**
   * Called to get the current AddonInstalls, optionally restricting by type.
   *
   * @param  aTypes
   *         An array of types or null to get all types
   */
  getInstallsByTypes(aTypes) {
    return [];
  },

  /**
   * Builds a list of the current plugins reported by the plugin host
   *
   * @return a dictionary of plugins indexed by our generated ID
   */
  getPluginList() {
    let tags = Cc["@mozilla.org/plugin/host;1"]
      .getService(Ci.nsIPluginHost)
      .getPluginTags();

    let list = {};
    let seenPlugins = {};
    for (let tag of tags) {
      if (!(tag.name in seenPlugins)) {
        seenPlugins[tag.name] = {};
      }
      if (!(tag.description in seenPlugins[tag.name])) {
        let plugin = {
          id: tag.name + tag.description,
          name: tag.name,
          description: tag.description,
          tags: [tag],
        };

        seenPlugins[tag.name][tag.description] = plugin;
        list[plugin.id] = plugin;
      } else {
        seenPlugins[tag.name][tag.description].tags.push(tag);
      }
    }

    return list;
  },

  /**
   * Builds the list of known plugins from the plugin host
   */
  buildPluginList() {
    this.plugins = this.getPluginList();
  },

  /**
   * Updates the plugins from the plugin host by comparing the current plugins
   * to the last known list sending out any necessary API notifications for
   * changes.
   */
  updatePluginList() {
    let newList = this.getPluginList();

    let lostPlugins = Object.keys(this.plugins)
      .filter(id => !(id in newList))
      .map(id => this.buildWrapper(this.plugins[id]));
    let newPlugins = Object.keys(newList)
      .filter(id => !(id in this.plugins))
      .map(id => this.buildWrapper(newList[id]));
    let matchedIDs = Object.keys(newList).filter(id => id in this.plugins);

    // The plugin host generates new tags for every plugin after a scan and
    // if the plugin's filename has changed then the disabled state won't have
    // been carried across, send out notifications for anything that has
    // changed (see bug 830267).
    let changedWrappers = [];
    for (let id of matchedIDs) {
      let oldWrapper = this.buildWrapper(this.plugins[id]);
      let newWrapper = this.buildWrapper(newList[id]);

      if (newWrapper.isActive != oldWrapper.isActive) {
        AddonManagerPrivate.callAddonListeners(
          newWrapper.isActive ? "onEnabling" : "onDisabling",
          newWrapper,
          false
        );
        changedWrappers.push(newWrapper);
      }
    }

    // Notify about new installs
    for (let plugin of newPlugins) {
      AddonManagerPrivate.callInstallListeners(
        "onExternalInstall",
        null,
        plugin,
        null,
        false
      );
      AddonManagerPrivate.callAddonListeners("onInstalling", plugin, false);
    }

    // Notify for any plugins that have vanished.
    for (let plugin of lostPlugins) {
      AddonManagerPrivate.callAddonListeners("onUninstalling", plugin, false);
    }

    this.plugins = newList;

    // Signal that new installs are complete
    for (let plugin of newPlugins) {
      AddonManagerPrivate.callAddonListeners("onInstalled", plugin);
    }

    // Signal that enables/disables are complete
    for (let wrapper of changedWrappers) {
      AddonManagerPrivate.callAddonListeners(
        wrapper.isActive ? "onEnabled" : "onDisabled",
        wrapper
      );
    }

    // Signal that uninstalls are complete
    for (let plugin of lostPlugins) {
      AddonManagerPrivate.callAddonListeners("onUninstalled", plugin);
    }
  },
};

const wrapperMap = new WeakMap();
let pluginFor = wrapper => wrapperMap.get(wrapper);

/**
 * The PluginWrapper wraps a set of nsIPluginTags to provide the data visible to
 * public callers through the API.
 */
function PluginWrapper(id, name, description, tags) {
  wrapperMap.set(this, { id, name, description, tags });
}

PluginWrapper.prototype = {
  get id() {
    return pluginFor(this).id;
  },

  get type() {
    return "plugin";
  },

  get name() {
    return pluginFor(this).name;
  },

  get creator() {
    return null;
  },

  get description() {
    return pluginFor(this).description.replace(/<\/?[a-z][^>]*>/gi, " ");
  },

  get version() {
    let {
      tags: [tag],
    } = pluginFor(this);
    return tag.version;
  },

  get homepageURL() {
    let { description } = pluginFor(this);
    if (/<A\s+HREF=[^>]*>/i.test(description)) {
      return /<A\s+HREF=["']?([^>"'\s]*)/i.exec(description)[1];
    }
    return null;
  },

  get isActive() {
    let {
      tags: [tag],
    } = pluginFor(this);
    return !tag.blocklisted && !tag.disabled;
  },

  get appDisabled() {
    let {
      tags: [tag],
    } = pluginFor(this);
    return tag.blocklisted;
  },

  get userDisabled() {
    let {
      tags: [tag],
    } = pluginFor(this);
    if (tag.disabled) {
      return true;
    }

    if (
      tag.clicktoplay ||
      this.blocklistState ==
        Ci.nsIBlocklistService.STATE_VULNERABLE_UPDATE_AVAILABLE ||
      this.blocklistState == Ci.nsIBlocklistService.STATE_VULNERABLE_NO_UPDATE
    ) {
      return AddonManager.STATE_ASK_TO_ACTIVATE;
    }

    return false;
  },

  set userDisabled(val) {
    let previousVal = this.userDisabled;
    if (val === false && this.isFlashPlugin) {
      val = AddonManager.STATE_ASK_TO_ACTIVATE;
    }

    if (val === previousVal) {
      return val;
    }

    let { tags } = pluginFor(this);

    for (let tag of tags) {
      if (val === true) {
        tag.enabledState = Ci.nsIPluginTag.STATE_DISABLED;
      } else if (val === false) {
        tag.enabledState = Ci.nsIPluginTag.STATE_ENABLED;
      } else if (val == AddonManager.STATE_ASK_TO_ACTIVATE) {
        tag.enabledState = Ci.nsIPluginTag.STATE_CLICKTOPLAY;
      }
    }

    // If 'userDisabled' was 'true' and we're going to a state that's not
    // that, we're enabling, so call those listeners.
    if (previousVal === true && val !== true) {
      AddonManagerPrivate.callAddonListeners("onEnabling", this, false);
      AddonManagerPrivate.callAddonListeners("onEnabled", this);
    }

    // If 'userDisabled' was not 'true' and we're going to a state where
    // it is, we're disabling, so call those listeners.
    if (previousVal !== true && val === true) {
      AddonManagerPrivate.callAddonListeners("onDisabling", this, false);
      AddonManagerPrivate.callAddonListeners("onDisabled", this);
    }

    // If the 'userDisabled' value involved AddonManager.STATE_ASK_TO_ACTIVATE,
    // call the onPropertyChanged listeners.
    if (
      previousVal == AddonManager.STATE_ASK_TO_ACTIVATE ||
      val == AddonManager.STATE_ASK_TO_ACTIVATE
    ) {
      AddonManagerPrivate.callAddonListeners("onPropertyChanged", this, [
        "userDisabled",
      ]);
    }

    return val;
  },

  async enable() {
    this.userDisabled = false;
  },
  async disable() {
    this.userDisabled = true;
  },

  get blocklistState() {
    let {
      tags: [tag],
    } = pluginFor(this);
    return tag.blocklistState;
  },

  async getBlocklistURL() {
    let {
      tags: [tag],
    } = pluginFor(this);
    return Blocklist.getPluginBlockURL(tag);
  },

  get pluginLibraries() {
    let libs = [];
    for (let tag of pluginFor(this).tags) {
      libs.push(tag.filename);
    }
    return libs;
  },

  get pluginFullpath() {
    let paths = [];
    for (let tag of pluginFor(this).tags) {
      paths.push(tag.fullpath);
    }
    return paths;
  },

  get pluginMimeTypes() {
    let types = [];
    for (let tag of pluginFor(this).tags) {
      let mimeTypes = tag.getMimeTypes();
      let mimeDescriptions = tag.getMimeDescriptions();
      let extensions = tag.getExtensions();
      for (let i = 0; i < mimeTypes.length; i++) {
        let type = {};
        type.type = mimeTypes[i];
        type.description = mimeDescriptions[i];
        type.suffixes = extensions[i];

        types.push(type);
      }
    }
    return types;
  },

  get installDate() {
    let date = 0;
    for (let tag of pluginFor(this).tags) {
      date = Math.max(date, tag.lastModifiedTime);
    }
    return new Date(date);
  },

  get scope() {
    let {
      tags: [tag],
    } = pluginFor(this);
    let path = tag.fullpath;
    // Plugins inside the profile directory are in the profile scope
    let dir = Services.dirsvc.get("ProfD", Ci.nsIFile);
    if (path.startsWith(dir.path)) {
      return AddonManager.SCOPE_PROFILE;
    }

    // Plugins anywhere else in the user's home are in the user scope,
    // but not all platforms have a home directory.
    try {
      dir = Services.dirsvc.get("Home", Ci.nsIFile);
      if (path.startsWith(dir.path)) {
        return AddonManager.SCOPE_USER;
      }
    } catch (e) {
      if (!e.result || e.result != Cr.NS_ERROR_FAILURE) {
        throw e;
      }
      // Do nothing: missing "Home".
    }

    // Any other locations are system scope
    return AddonManager.SCOPE_SYSTEM;
  },

  get pendingOperations() {
    return AddonManager.PENDING_NONE;
  },

  get operationsRequiringRestart() {
    return AddonManager.OP_NEEDS_RESTART_NONE;
  },

  get permissions() {
    let {
      tags: [tag],
    } = pluginFor(this);
    let permissions = 0;
    if (tag.isEnabledStateLocked) {
      return permissions;
    }
    if (!this.appDisabled) {
      if (this.userDisabled !== true) {
        permissions |= AddonManager.PERM_CAN_DISABLE;
      }

      if (this.userDisabled !== AddonManager.STATE_ASK_TO_ACTIVATE) {
        permissions |= AddonManager.PERM_CAN_ASK_TO_ACTIVATE;
      }

      let blocklistState = this.blocklistState;
      let isCTPBlocklisted =
        blocklistState == Ci.nsIBlocklistService.STATE_VULNERABLE_NO_UPDATE ||
        blocklistState ==
          Ci.nsIBlocklistService.STATE_VULNERABLE_UPDATE_AVAILABLE;
      if (
        this.userDisabled !== false &&
        !isCTPBlocklisted &&
        !this.isFlashPlugin
      ) {
        permissions |= AddonManager.PERM_CAN_ENABLE;
      }
    }
    return permissions;
  },

  get optionsType() {
    return AddonManager.OPTIONS_TYPE_INLINE_BROWSER;
  },

  get optionsURL() {
    return (
      "chrome://mozapps/content/extensions/pluginPrefs.xul#id=" +
      encodeURIComponent(this.id)
    );
  },

  get updateDate() {
    return this.installDate;
  },

  get isCompatible() {
    return true;
  },

  get isPlatformCompatible() {
    return true;
  },

  get providesUpdatesSecurely() {
    return true;
  },

  get foreignInstall() {
    return true;
  },

  get installTelemetryInfo() {
    return { source: "plugin" };
  },

  isCompatibleWith(aAppVersion, aPlatformVersion) {
    return true;
  },

  findUpdates(aListener, aReason, aAppVersion, aPlatformVersion) {
    if ("onNoCompatibilityUpdateAvailable" in aListener) {
      aListener.onNoCompatibilityUpdateAvailable(this);
    }
    if ("onNoUpdateAvailable" in aListener) {
      aListener.onNoUpdateAvailable(this);
    }
    if ("onUpdateFinished" in aListener) {
      aListener.onUpdateFinished(this);
    }
  },

  get isFlashPlugin() {
    return pluginFor(this).tags.some(t => t.isFlashPlugin);
  },
};

AddonManagerPrivate.registerProvider(PluginProvider, [
  new AddonManagerPrivate.AddonType(
    "plugin",
    URI_EXTENSION_STRINGS,
    "type.plugin.name",
    AddonManager.VIEW_TYPE_LIST,
    6000,
    AddonManager.TYPE_SUPPORTS_ASK_TO_ACTIVATE
  ),
]);