summaryrefslogtreecommitdiff
path: root/packages/taler-wallet-webextension/src/taler-wallet-interaction-support.ts
blob: 8b15380f9a576a1ba3d263c11a6c3002880b755e (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
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
/*
 This file is part of GNU Taler
 (C) 2022 Taler Systems S.A.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 * WARNING
 *
 * This script will be loaded and run in every page while the
 * user us navigating. It must be short, simple and safe.
 */
(() => {
  const logger = {
    debug: (...msg: any[]) => { },
    info: (...msg: any[]) =>
      console.log(`${new Date().toISOString()} TALER`, ...msg),
    error: (...msg: any[]) =>
      console.error(`${new Date().toISOString()} TALER`, ...msg),
  };

  const documentDocTypeIsHTML =
    window.document.doctype && window.document.doctype.name === "html";
  const suffixIsNotXMLorPDF =
    !window.location.pathname.endsWith(".xml") &&
    !window.location.pathname.endsWith(".pdf");
  const rootElementIsHTML =
    document.documentElement.nodeName &&
    document.documentElement.nodeName.toLowerCase() === "html";
  const pageAcceptsTalerSupport = document.head.querySelector(
    "meta[name=taler-support]",
  );

  // this is also checked by the loader
  // but a double check will prevent running and breaking user navigation
  // if loaded from other location
  const shouldNotRun =
    !documentDocTypeIsHTML ||
    !suffixIsNotXMLorPDF ||
    !pageAcceptsTalerSupport ||
    !rootElementIsHTML;

  interface Info {
    extensionId: string;
    protocol: string;
    hostname: string;
  }
  interface API {
    convertURIToWebExtensionPath: (uri: string) => string | undefined;
    anchorOnClick: (ev: MouseEvent) => void;
    registerProtocolHandler: () => void;
  }
  interface TalerSupport {
    info: Readonly<Info>;
    __internal: API;
  }

  function buildApi(config: Readonly<Info>): API {
    /**
     * Takes an anchor href that starts with taler:// and
     * returns the path to the web-extension page
     */
    function convertURIToWebExtensionPath(uri: string): string | undefined {
      if (!validateTalerUri(uri)) {
        logger.error(`taler:// URI is invalid: ${uri}`);
        return undefined;
      }
      const host = `${config.protocol}//${config.hostname}`;
      const path = `static/wallet.html#/taler-uri/${encodeURIComponent(uri)}`;
      return `${host}/${path}`;
    }

    function anchorOnClick(ev: MouseEvent) {
      if (!(ev.currentTarget instanceof Element)) {
        logger.debug(`onclick: registered in a link that is not an HTML element`);
        return;
      }
      const hrefAttr = ev.currentTarget.attributes.getNamedItem("href");
      if (!hrefAttr) {
        logger.debug(`onclick: link didn't have href with taler:// uri`);
        return;
      }
      const targetAttr = ev.currentTarget.attributes.getNamedItem("target");
      const windowTarget =
        targetAttr && targetAttr.value ? targetAttr.value : "_self";
      const page = convertURIToWebExtensionPath(hrefAttr.value);
      if (!page) {
        logger.debug(`onclick: could not convert "${hrefAttr.value}" into path`);
        return;
      }
      // we can use window.open, but maybe some browser will block it?
      window.open(page, windowTarget);
      ev.preventDefault();
      ev.stopPropagation();
      ev.stopImmediatePropagation();
      return false;
    }

    function overrideAllAnchor(root: HTMLElement) {
      const allAnchors = root.querySelectorAll("a[href^=taler]");
      logger.debug(`registering taler protocol in ${allAnchors.length} links`);
      allAnchors.forEach((link) => {
        if (link instanceof HTMLElement) {
          link.addEventListener("click", anchorOnClick);
        }
      });
    }

    function checkForNewAnchors(
      mutations: MutationRecord[],
      observer: MutationObserver,
    ) {
      mutations.forEach((mut) => {
        if (mut.type === "childList") {
          mut.addedNodes.forEach((added) => {
            if (added instanceof HTMLElement) {
              logger.debug(`new element`, added);
              overrideAllAnchor(added);
            }
          });
        }
      });
    }

    /**
     * Check of every anchor and observes for new one.
     * Register the anchor handler when found
     */
    function registerProtocolHandler() {
      if (document.body) overrideAllAnchor(document.body)
      new MutationObserver(checkForNewAnchors).observe(document, {
        childList: true,
        subtree: true,
        attributes: false,
      });
    }

    return {
      convertURIToWebExtensionPath,
      anchorOnClick,
      registerProtocolHandler,
    };
  }

  function start() {
    if (shouldNotRun) return;
    if (!(document.currentScript instanceof HTMLScriptElement)) return;

    const url = new URL(document.currentScript.src);
    const { protocol, searchParams, hostname } = url;
    const extensionId = searchParams.get("id") ?? "";
    const debugEnabled = searchParams.get("debug") === "true";
    const apiEnabled = searchParams.get("api") === "true";
    const hijackEnabled = searchParams.get("hijack") === "true";

    const info: Info = Object.freeze({
      extensionId,
      protocol,
      hostname,
    });

    if (debugEnabled) {
      logger.debug = logger.info;
    }

    const taler: TalerSupport = {
      info,
      __internal: buildApi(info),
    };

    if (apiEnabled) {
      //@ts-ignore
      window.taler = taler;
    }

    if (hijackEnabled) {
      taler.__internal.registerProtocolHandler();
    }
  }

  // utils functions
  function validateTalerUri(uri: string): boolean {
    return (
      !!uri && (uri.startsWith("taler://") || uri.startsWith("taler+http://"))
    );
  }

  start();
})()