summaryrefslogtreecommitdiffstats
path: root/browser/extensions/webcompat/lib/about_compat_broker.js
blob: faaa56a38e8e598a26fab10634ead16eba53150e (plain)
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
/* 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";

/* global browser, module, onMessageFromTab */

class AboutCompatBroker {
  constructor(bindings) {
    this._injections = bindings.injections;
    this._uaOverrides = bindings.uaOverrides;
    this._shims = bindings.shims;

    if (!this._injections && !this._uaOverrides && !this._shims) {
      throw new Error("No interventions; about:compat broker is not needed");
    }

    this.portsToAboutCompatTabs = this.buildPorts();
    this._injections?.bindAboutCompatBroker(this);
    this._uaOverrides?.bindAboutCompatBroker(this);
    this._shims?.bindAboutCompatBroker(this);
  }

  buildPorts() {
    const ports = new Set();

    browser.runtime.onConnect.addListener(port => {
      ports.add(port);
      port.onDisconnect.addListener(function () {
        ports.delete(port);
      });
    });

    async function broadcast(message) {
      for (const port of ports) {
        port.postMessage(message);
      }
    }

    return { broadcast };
  }

  filterOverrides(overrides) {
    return overrides
      .filter(override => override.availableOnPlatform)
      .map(override => {
        const { id, active, bug, domain, hidden } = override;
        return { id, active, bug, domain, hidden };
      });
  }

  getInterventionById(id) {
    for (const [type, things] of Object.entries({
      overrides: this._uaOverrides?.getAvailableOverrides() || [],
      interventions: this._injections?.getAvailableInjections() || [],
      shims: this._shims?.getAvailableShims() || [],
    })) {
      for (const what of things) {
        if (what.id === id) {
          return { type, what };
        }
      }
    }
    return {};
  }

  bootup() {
    onMessageFromTab(msg => {
      switch (msg.command || msg) {
        case "toggle": {
          const id = msg.id;
          const { type, what } = this.getInterventionById(id);
          if (!what) {
            return Promise.reject(
              `No such override or intervention to toggle: ${id}`
            );
          }
          const active = type === "shims" ? !what.disabledReason : what.active;
          this.portsToAboutCompatTabs
            .broadcast({ toggling: id, active })
            .then(async () => {
              switch (type) {
                case "interventions": {
                  if (active) {
                    await this._injections?.disableInjection(what);
                  } else {
                    await this._injections?.enableInjection(what);
                  }
                  break;
                }
                case "overrides": {
                  if (active) {
                    await this._uaOverrides?.disableOverride(what);
                  } else {
                    await this._uaOverrides?.enableOverride(what);
                  }
                  break;
                }
                case "shims": {
                  if (active) {
                    await this._shims?.disableShimForSession(id);
                  } else {
                    await this._shims?.enableShimForSession(id);
                  }
                  // no need to broadcast the "toggled" signal for shims, as
                  // they send a shimsUpdated message themselves instead
                  return;
                }
              }
              this.portsToAboutCompatTabs.broadcast({
                toggled: id,
                active: !active,
              });
            });
          break;
        }
        case "getAllInterventions": {
          return Promise.resolve({
            overrides:
              (this._uaOverrides?.isEnabled() &&
                this.filterOverrides(
                  this._uaOverrides?.getAvailableOverrides()
                )) ||
              false,
            interventions:
              (this._injections?.isEnabled() &&
                this.filterOverrides(
                  this._injections?.getAvailableInjections()
                )) ||
              false,
            shims: this._shims?.getAvailableShims() || false,
          });
        }
      }
      return undefined;
    });
  }
}

module.exports = AboutCompatBroker;