aboutsummaryrefslogtreecommitdiff
path: root/content/contactFinder.js
blob: 6868b47dcb80823908a22836cc0021eeda2f5dc9 (plain) (blame)
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
/**
* GNU LibreJS - A browser add-on to block nonfree nontrivial JavaScript.
* *
* Copyright (C) 2017 Nathan Nichols, Loic J. Duros, Nik Nyby
* Copyright (C) 2018 Giorgio Maone
* Copyright (C) 2022 Yuchen Pei
*
* This file is part of GNU LibreJS.
*
* GNU LibreJS 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 of the License, or
* (at your option) any later version.
*
* GNU LibreJS 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 LibreJS.  If not, see <http://www.gnu.org/licenses/>.
*/

// TO TEST THE CONTACT FINDER:
// - open the manifest.json
// - add a comma after the closing bracket of the key "background"
// - Copy and paste this after it:
/*
  "content_scripts": [{
      "matches": ["<all_urls>"],
      "js": ["/content/contactFinder.js"],
      "css": ["/content/contactFinder.css"]
    }]
*/
// Now, the contact finder will load on every page and you can test it where ever you want.


//*********************************************************************************************
function debug(format, ...args) {
  console.debug(`LibreJS - ${format}`, ...args);
}

debug("Injecting contact finder in %s", document.URL);

/**
 * contactSearchStrings
 * Contains arrays of strings classified by language
 * and by degree of certainty.
 */
const contactFrags = [
  // de
  {
    'certain': [
      '^[\\s]*Kontakt os[\\s]*$',
      '^[\\s]*Email Os[\\s]*$',
      '^[\\s]*Kontakt[\\s]*$'
    ],
    'probable': ['^[\\s]Kontakt', '^[\\s]*Email'],
    'uncertain': [
      '^[\\s]*Om Us',
      '^[\\s]*Om',
      'Hvem vi er'
    ]
  },
  // en
  {
    'certain': [
      '^[\\s]*Contact Us[\\s]*$',
      '^[\\s]*Email Us[\\s]*$',
      '^[\\s]*Contact[\\s]*$',
      '^[\\s]*Feedback[\\s]*$',
      '^[\\s]*Web.?site Feedback[\\s]*$'
    ],
    'probable': ['^[\\s]*Contact', '^[\\s]*Email'],
    'uncertain': [
      '^[\\s]*About Us',
      '^[\\s]*About',
      'Who we are',
      'Who I am',
      'Company Info',
      'Customer Service'
    ]
  },
  // es
  {
    'certain': [
      '^[\\s]*contáctenos[\\s]*$',
      '^[\\s]*Email[\\s]*$'
    ],
    'probable': ['^[\\s]contáctenos', '^[\\s]*Email'],
    'uncertain': [
      'Acerca de nosotros'
    ]
  },
  // fr
  {
    'certain': [
      '^[\\s]*Contactez nous[\\s]*$',
      '^[\\s]*(Nous )?contacter[\\s]*$',
      '^[\\s]*Email[\\s]*$',
      '^[\\s]*Contact[\\s]*$',
      '^[\\s]*Commentaires[\\s]*$'
    ],
    'probable': ['^[\\s]Contact', '^[\\s]*Email'],
    'uncertain': [
      '^[\\s]*(A|À) propos',
      'Qui nous sommes',
      'Qui suis(-| )?je',
      'Info',
      'Service Client(e|è)le'
    ]
  }
];

const CONTACT_LINK_LIMIT = 5;

// Taken from http://emailregex.com/
const emailRegex = new RegExp(/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/g);
//*********************************************************************************************

function findMatch(link, frag) {
  const result = (link.innerText.match(new RegExp(frag, "g")) || []).filter(x => typeof x == "string");
  if (result.length) return true;
  return false;
}

/**
*	Tests all links on the page for regexes under a certain certainty level.
*
*	Will return either all regex matches from the selected certainty level,
* up to a limit.
*
*	certainty can be "certain" > "probable" > "uncertain"
*/
function attempt(certainty, limit) {
  // There needs to be some kind of max so that people can't troll by for example leaving a comment with a bunch of emails
  // to cause LibreJS users to slow down.
  const matches = [];
  const links = Array.from(document.links).filter(link => (typeof (link.innerText) === "string" || typeof (link.href) === "string"));
  for (const link of links) {
    for (const byLevel of contactFrags) {
      for (const frag of byLevel[certainty]) {
        findMatch(link, frag) && matches.push(link);
        if (matches.length >= limit) return { 'fail': false, 'result': [link] };
      }
    }
  }
  return { "fail": matches.length === 0, "result": matches };
}

/**
*	"LibreJS detects contact pages and email addresses that are likely to be owned by the
*	maintainer of the site."
*/
function findContacts() {
  for (const type of ["certain", "probable", "uncertain"]) {
    const attempted = attempt(type, CONTACT_LINK_LIMIT);
    if (!attempted["fail"]) {
      return [type, attempted["result"]];
    }
  }
  return null;
}


function createWidget(id, tag, parent = document.body) {
  const oldWidget = document.getElementById(id);
  if (oldWidget) oldWidget.remove();
  const widget = parent.appendChild(document.createElement(tag));
  widget.id = id;
  return widget;
}

/**
*
*	Creates the contact finder / complain UI as a semi-transparent overlay
*
*/

function main() {
  const overlay = createWidget("_LibreJS_overlay", "div");
  const frame = createWidget("_LibreJS_frame", "iframe");

  const close = () => {
    frame.remove();
    overlay.remove();
  };

  const closeListener = e => {
    const t = e.currentTarget;
    if (t.href && t.href !== document.URL) { // link navigation
      if (t.href.includes("#")) {
        window.addEventListener("hashchange", close);
      }
      return;
    }
    close();
  };
  const makeCloser = clickable => clickable.addEventListener("click", closeListener);

  // Clicking the "outer area" closes the dialog.
  makeCloser(overlay);

  const initFrame = prefs => {
    debug("initFrame");
    const contentDoc = frame.contentWindow.document;

    const addText = (text, tag, wherein) => {
      el = wherein.appendChild(contentDoc.createElement(tag));
      el.textContent = text;
    }

    // Header of the dialog
    const { body } = contentDoc;
    body.id = "_LibreJS_dialog";
    addText('LibreJS Complaint', 'h1', body);
    const closeButton = body.appendChild(contentDoc.createElement('button'));
    closeButton.classList.toggle('close', true);
    closeButton.textContent = 'x';

    const content = body.appendChild(contentDoc.createElement("div"));
    content.id = "content";

    // Add list of contact links
    const res = findContacts();
    if (!res) {
      content.classList.toggle("_LibreJS_fail", true);
      addText('Could not guess any contact page for this site.', 'div', content);
    } else {
      addText('Contact info guessed for this site', 'h3', content);
      addText(res[0] + ':', 'span', content);
      const list = content.appendChild(contentDoc.createElement("ul"));
      for (const link of res[1]) {
        const a = contentDoc.createElement("a");
        a.href = link.href;
        a.textContent = link.textContent;
        list.appendChild(contentDoc.createElement("li")).appendChild(a);
      }
    }

    // Add list of emails
    const emails = (document.documentElement.textContent.match(emailRegex) || []).filter(e => !!e);
    if (emails.length) {
      addText("Possible email addresses:", 'h5', content);
      const list = content.appendChild(contentDoc.createElement("ul"));
      for (const recipient of emails.slice(0, 10)) {
        const a = contentDoc.createElement("a");
        a.href = `mailto:${recipient}?subject=${encodeURIComponent(prefs["pref_subject"])
          }&body=${encodeURIComponent(prefs["pref_body"])
          }`;
        a.textContent = recipient;
        list.appendChild(contentDoc.createElement("li")).appendChild(a);
      }
    }

    contentDoc.querySelectorAll(".close, a").forEach(makeCloser);
    debug("frame initialized");
  }

  frame.addEventListener("load", _ => {
    debug("frame loaded");
    browser.runtime.connect({ name: "contact_finder" }).onMessage.addListener(initFrame);
  });
}

main();