TabFern/vendor/common.js at main · cxw42/TabFern · GitHub

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
// common.js: Only constants and stateless helper functions should be
// in this file.
// ** Not currently a require.js module so that it can be used in contexts
// ** where require.js is not available (e.g., background.js).
// ** TODO split this into UMD modules so the pieces can be loaded with or
//    without require.js.

console.log("TabFern common.js loading");

// Messages between parts of TabFern // {{{1

// The format of a message is
// { msg: <one of the below constants> [, anything else] }
// For responses, response:true is also included.

const MSG_EDIT_TAB_NOTE = "editTabNote";
const MSG_REPORT_POPUP_SETTING = "reportPopupSetting";

////////////////////////////////////////////////////////////////////////// }}}1
// Cross-browser error handling, and browser tests // {{{1
// Not sure if I need this, but I'm playing it safe for now.  Firefox puts
// null rather than undefined in chrome.runtime.lastError when there is
// no error.  This is to test for null in Firefox without changing my
// Chrome code.  Hopefully in the future I can test for null/undefined
// in either browser, and get rid of this block.

function _isLastError_chrome() {
    return typeof chrome.runtime.lastError !== "undefined";
}
function _isLastError_firefox() {
    return chrome.runtime.lastError !== null;
}

// Assume Chrome
let isLastError = _isLastError_chrome;

let browser_type = (function () {
    _BROWSER_TYPE = "chrome";

    if (
        typeof browser !== "undefined" &&
        browser.runtime &&
        browser.runtime.getBrowserInfo
    ) {
        browser.runtime.getBrowserInfo().then(
            // fullfillment
            (info) => {
                if (info.name === "Firefox") {
                    isLastError = _isLastError_firefox;
                    _BROWSER_TYPE = "ff";
                }
            },
            // rejection --- nothing to do
            () => {}
        );
    }

    // return from the IIFE
    return function browser_type_impl() {
        return _BROWSER_TYPE;
    };
})();

/// Return a string representation of an error message.
/// @param err {Any}: The error object/message to process.
function ErrorMessageString(err) {
    if (!err) {
        return "<no error>";
    }

    try {
        if (typeof err !== "object") {
            return `${err}`;
        }
        return err.message || err.description || err.toString();
    } catch (e) {
        return `Error that I could not stringify (meta-error = ${e})`;
    }
} // ErrorMessageString()

/// Return a string representation of chrome.runtime.lastError.
///
/// Somewhere around Chrome 75, chrome.runtime.lastError lost toString(),
/// as far as I can tell.
/// See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
///     https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/lastError
///     https://developer.chrome.com/extensions/runtime#property-lastError
function lastBrowserErrorMessageString() {
    return ErrorMessageString(chrome.runtime.lastError);
}

////////////////////////////////////////////////////////////////////////// }}}1
// DOM-related functions // {{{1

/// Append a <script> to the <head> of #document.
/// @param {Document} document
/// @param {String} url URL of script to load
/// @param {String} [type] Type of Script tag. Default: text/javascript
/// @param {Function} callback Set as callback for BOTH onreadystatechange and onload
function asyncAppendScriptToHead(
    document,
    url,
    callback,
    type = "text/javascript"
) {
    // Adding the script tag to the head as suggested before
    var head = document.getElementsByTagName("head")[0];
    var script = document.createElement("script");
    script.type = type;
    script.src = url;

    // Then bind the event to the callback function.
    // There are several events for cross browser compatibility.
    script.onreadystatechange = callback;
    script.onload = callback;
    script.onerror = callback;

    // Fire the loading
    head.appendChild(script);
} //asyncAppendScriptToHead()

/// Invoke a callback only when the document is loaded.  Does not pass any
/// parameters to the callback.
function callbackOnLoad(callback) {
    if (document.readyState !== "complete") {
        // Thanks to https://stackoverflow.com/a/28093606/2877364 by
        // https://stackoverflow.com/users/4483389/matthias-samsel
        window.addEventListener(
            "load",
            () => {
                callback();
            },
            { once: true }
        );
    } else {
        window.setTimeout(callback, 0); //always async
    }
} //callbackOnLoad

/// Add a CSS file to the specified document.
/// Modified from http://requirejs.org/docs/faq-advanced.html#css
/// @param doc {DOM Document}
/// @param url {String}
/// @param before {DOM Node} Optional --- if provided, the new sheet
/// will be inserted before #before.
function loadCSS(doc, url, before) {
    let link = doc.createElement("link");
    link.type = "text/css";
    link.rel = "stylesheet";
    link.href = url;
    let head = document.getElementsByTagName("head")[0];
    if (before) {
        head.insertBefore(link, before);
    } else {
        head.appendChild(link);
    }
} //loadCSS

////////////////////////////////////////////////////////////////////////// }}}1
// Miscellaneous functions // {{{1

/// Shortcut for i18n.  Call _T("name") to pull the localized "name".
var _T;
if (chrome && chrome.i18n && chrome.i18n.getMessage) {
    _T = chrome.i18n.getMessage;
} else {
    // #171 HACK

    // Warn unless calling code told us to expect this.
    console.log({ window });
    const expect_no_i18n =
        typeof "window" !== undefined && window && window._TF_NO_I18N;
    if (!expect_no_i18n) {
        console.warn("Using #171 hack");
    }

    // The following line is substituted at build time with the messages
    // from _locales/en/messages.json.  See details in brunch-config.js.
    // The "0;" is so it will not confuse the autoindent.
    let _messages = 0; ///I18N_MESSAGES/// ;

    _T = function _T_hack(messageName, substitutions_IGNORED) {
        if (_messages && _messages[messageName]) {
            return _messages[messageName];
        } else {
            return "Unknown message (issue 171): " + messageName;
        }
    }; //_T()
} //endif !chrome.i18n.getMessage

/// Ignore a Chrome callback error, and suppress Chrome's
/// `runtime.lastError` diagnostic.  Use this as a Chrome callback.
function ignore_chrome_error() {
    void chrome.runtime.lastError;
}

/// Deep-compare two objects for memberwise equality.  However, if either
/// object contains a pointer to the other, this will return false rather
/// than getting stuck in a loop.  Non-`object` types are compared by ===.
/// All member comparisons are ===.
/// @param obj1 An object to compare
/// @param obj2 The other object to compare
/// @return True if the objects are equal; false otherwise.
/// Modified from https://gist.github.com/nicbell/6081098 by
/// https://gist.github.com/nicbell
function ObjectCompare(obj1, obj2) {
    if (typeof obj1 !== "object" || typeof obj2 !== "object") {
        return obj1 === obj2;
    }

    //Loop through properties in object 1
    for (var p in obj1) {
        //Check property exists on both objects
        if (obj1.hasOwnProperty(p) !== obj2.hasOwnProperty(p)) return false;

        switch (typeof obj1[p]) {
            //Deep compare objects
            case "object":
                //Check for circularity
                if (obj1[p] === obj2 || obj2[p] === obj1) return false;

                if (!ObjectCompare(obj1[p], obj2[p])) return false;
                break;

            //Compare function code
            case "function":
                if (
                    typeof obj2[p] == "undefined" ||
                    obj1[p].toString() !== obj2[p].toString()
                ) {
                    return false;
                }
                break;

            //Compare values
            default:
                if (obj1[p] !== obj2[p]) return false;
        }
    }

    //Check object 2 for any extra properties
    for (var p in obj2) {
        if (typeof obj1[p] === "undefined") return false;
    }
    return true;
} //ObjectCompare

/// }}}1
// vi: set ts=4 sts=4 sw=4 et ai fo-=o fdm=marker fdl=0: //