@xenon-device-management/xenon 2.14.0 → 2.16.0

package/lib/src/services/logcat/deviceLogBook.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceLogBook = exports.DEVICE_CLOCK_COMMAND = exports.UNKNOWN_CLOCK = exports.WINDOW_SLACK_MS = exports.DEVICE_LOG_ERROR_LIMIT = exports.DEVICE_LOG_LINE_LIMIT = void 0;
+exports.parseDeviceClock = parseDeviceClock;
+exports.formatThreadtime = formatThreadtime;
+const logcatParse_1 = require("./logcatParse");
+/**
+ * Which of a phone's log records a session keeps, and as what. Pure: the
+ * service (SessionDeviceLogs) feeds it the records of the phone's shared log
+ * stream and writes what it returns.
+ *
+ * - **The session's lines only.** The stream starts with up to 2000 lines of
+ *   history (`-T`, or the multiplexer's replay to a late joiner), so a line
+ *   counts from shortly before the phone was given to the session.
+ * - **Its own time, on this server's clock.** A line is stamped with the
+ *   moment the phone logged it, moved by the phone's clock offset, so it
+ *   lines up with the session's commands; its text keeps the time the phone
+ *   printed. A phone's clock is often seconds off, and one with no network
+ *   time can be minutes off.
+ * - **Each line once.** A stream delivers a record once. When the stream
+ *   ends mid-session and is started again, its history overlaps what was
+ *   kept, so a resumed stream counts only lines after the newest one seen,
+ *   compared by time and, at that same millisecond, by content.
+ * - **Bounded.** DEVICE_LOG_LINE_LIMIT lines of any level, then errors only
+ *   (a crash's "FATAL EXCEPTION" is an error) up to DEVICE_LOG_ERROR_LIMIT
+ *   more, each step said in the log itself.
+ */
+/** Lines of any level a session keeps. */
+exports.DEVICE_LOG_LINE_LIMIT = 10000;
+/** Errors (E and F) kept after DEVICE_LOG_LINE_LIMIT; nothing more after them. */
+exports.DEVICE_LOG_ERROR_LIMIT = 2000;
+/**
+ * How long before the phone was given to the session a line may be and still
+ * count: the phone's clock offset, read once, is only about that good.
+ */
+exports.WINDOW_SLACK_MS = 2000;
+/** A phone whose clock couldn't be read: taken to be this server's. */
+exports.UNKNOWN_CLOCK = { zoneShiftMs: 0, skewMs: 0 };
+const QUARTER_HOUR_MS = 15 * 60000;
+/**
+ * The phone's `date` command for {@link parseDeviceClock}: seconds since the
+ * epoch, nanoseconds, and the local time logcat prints, at one instant, with
+ * no spaces (it goes through the phone's shell as one word). An older
+ * toybox prints no nanoseconds.
+ */
+exports.DEVICE_CLOCK_COMMAND = 'date +%s.%N.%m-%d.%H:%M:%S';
+/**
+ * The phone's clock from {@link DEVICE_CLOCK_COMMAND}'s output, or null if it
+ * isn't that. `hostNowMs` is this server's time when the phone answered.
+ *
+ * The local time is read the way parseThreadtimeLine reads a log line, so the
+ * difference to the phone's epoch is exactly the shift its lines need,
+ * whatever either time zone is. Rounded to a quarter hour: time zones differ
+ * by whole quarters.
+ */
+function parseDeviceClock(output, hostNowMs) {
+    const m = /(\d{9,})\.(\S*?)\.(\d{2})-(\d{2})\.(\d{2}):(\d{2}):(\d{2})/.exec(output);
+    if (!m)
+        return null;
+    const [, secs, nanos, mo, d, h, mi, s] = m;
+    const asLogged = (0, logcatParse_1.parseThreadtimeLine)(`${mo}-${d} ${h}:${mi}:${s}.000     0     0 I clock: now`, new Date(hostNowMs));
+    if (!asLogged)
+        return null;
+    // Without nanoseconds, the phone's instant was within the second after `%s`.
+    const fraction = /^\d{9}$/.test(nanos) ? Math.floor(Number(nanos) / 1e6) : 500;
+    const phoneNow = Number(secs) * 1000 + fraction;
+    return {
+        zoneShiftMs: Math.round((phoneNow - asLogged.ts) / QUARTER_HOUR_MS) * QUARTER_HOUR_MS,
+        skewMs: hostNowMs - phoneNow,
+    };
+}
+const pad = (n, width = 2) => String(n).padStart(width, '0');
+/**
+ * A record as logcat's threadtime format prints it (logprint.cpp,
+ * `"%s %5d %5d %c %-8s: "`): the time as the phone printed it, then the pid,
+ * the tid, the level, the tag and the message. The dashboard reads the level
+ * from this text (log-derive.ts), and it is what Android developers know.
+ */
+function formatThreadtime(rec) {
+    // `ts` was built from the printed fields as this server's local time, so
+    // its local fields are the printed ones.
+    const t = new Date(rec.ts);
+    const time = `${pad(t.getMonth() + 1)}-${pad(t.getDate())} ` +
+        `${pad(t.getHours())}:${pad(t.getMinutes())}:${pad(t.getSeconds())}.${pad(t.getMilliseconds(), 3)}`;
+    const pid = String(rec.pid).padStart(5);
+    const tid = String(rec.tid).padStart(5);
+    return `${time} ${pid} ${tid} ${rec.level} ${rec.tag.padEnd(8)}: ${rec.message}`;
+}
+const count = (n) => n.toLocaleString('en-US');
+const keyOf = (r) => `${r.pid} ${r.tid} ${r.level} ${r.tag} ${r.message}`;
+const isError = (r) => r.level === 'E' || r.level === 'F';
+class DeviceLogBook {
+    constructor(opts) {
+        var _a, _b, _c;
+        this.kept = 0;
+        this.leftOut = 0;
+        this.limitNoted = false;
+        this.clock = opts.clock;
+        this.format = (_a = opts.format) !== null && _a !== void 0 ? _a : formatThreadtime;
+        this.lineLimit = (_b = opts.lineLimit) !== null && _b !== void 0 ? _b : exports.DEVICE_LOG_LINE_LIMIT;
+        this.errorLimit = (_c = opts.errorLimit) !== null && _c !== void 0 ? _c : exports.DEVICE_LOG_ERROR_LIMIT;
+        // A record at `ts` was logged at ts + zoneShift + skew by this server's
+        // clock (timeOf); it counts from WINDOW_SLACK_MS before `since`.
+        const first = opts.since - exports.WINDOW_SLACK_MS - this.clock.zoneShiftMs - this.clock.skewMs;
+        this.floor = { ts: Math.ceil(first), keys: new Set() };
+    }
+    /** The rows a record adds: none, its own, or a note before it. */
+    add(rec) {
+        // The stream's own notes (a slow viewer's dropped lines, its end) aren't
+        // the phone's; the service notes an interruption itself.
+        if (rec.synthetic)
+            return [];
+        const key = keyOf(rec);
+        if (rec.ts < this.floor.ts || (rec.ts === this.floor.ts && this.floor.keys.has(key))) {
+            return [];
+        }
+        if (!this.newest || rec.ts > this.newest.ts)
+            this.newest = { ts: rec.ts, keys: new Set([key]) };
+        else if (rec.ts === this.newest.ts)
+            this.newest.keys.add(key);
+        const out = [];
+        if (this.kept >= this.lineLimit && !this.limitNoted) {
+            this.limitNoted = true;
+            out.push(this.note(`This session reached ${count(this.lineLimit)} device log lines. ` +
+                'From here on, only errors are kept.', this.timeOf(rec)));
+        }
+        const room = this.kept < this.lineLimit || (isError(rec) && this.kept < this.lineLimit + this.errorLimit);
+        if (room) {
+            this.kept += 1;
+            out.push({ message: this.format(rec), timestamp: this.timeOf(rec) });
+        }
+        else {
+            this.leftOut += 1;
+        }
+        return out;
+    }
+    /**
+     * The stream ended while the session runs. The next one starts with
+     * history, so it may deliver only what is newer than what was seen.
+     */
+    interrupted(at) {
+        if (this.newest)
+            this.floor = { ts: this.newest.ts, keys: new Set(this.newest.keys) };
+        return [this.note("The phone's log was interrupted. Lines may be missing from here.", at)];
+    }
+    /** The session ended: what was left out, if anything. */
+    finish(at) {
+        if (this.leftOut === 0)
+            return [];
+        const lines = this.leftOut === 1 ? '1 device log line was' : `${count(this.leftOut)} device log lines were`;
+        return [this.note(`${lines} left out to keep this session's log within its limit.`, at)];
+    }
+    /** Lines kept so far. */
+    get keptLines() {
+        return this.kept;
+    }
+    timeOf(rec) {
+        return new Date(rec.ts + this.clock.zoneShiftMs + this.clock.skewMs);
+    }
+    note(text, at) {
+        return { message: `Xenon: ${text}`, timestamp: at };
+    }
+}
+exports.DeviceLogBook = DeviceLogBook;

package/lib/src/services/logcat/iosDriverLog.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IosAppLines = exports.iosLineText = void 0;
+exports.iosLineLevel = iosLineLevel;
+exports.recordFromDriverLog = recordFromDriverLog;
+exports.bufferedDriverLog = bufferedDriverLog;
+exports.isDriverLog = isDriverLog;
+// A real iPhone's syslog line: "Oct  5 20:31:40 iPhone SpringBoard(FrontBoard)[57] <Notice>: …".
+const SYSLOG_LEVEL = /<(Fault|Error|Warning|Notice|Default|Info|Debug)>:/;
+// A simulator's compact line: "2026-10-05 20:31:40.123 E  SpringBoard[1234:5678] …".
+const COMPACT_LEVEL = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+\s+(Df|Db|E|F|I|A)\s/;
+const SYSLOG_LETTERS = {
+    Fault: 'F',
+    Error: 'E',
+    Warning: 'W',
+    Notice: 'I',
+    Default: 'I',
+    Info: 'I',
+    Debug: 'D',
+};
+const COMPACT_LETTERS = {
+    F: 'F',
+    E: 'E',
+    Df: 'I',
+    I: 'I',
+    A: 'I',
+    Db: 'D',
+};
+/** The level an iOS log line carries, as a logcat letter; `I` when it carries none. */
+function iosLineLevel(message) {
+    var _a, _b;
+    const syslog = (_a = SYSLOG_LEVEL.exec(message)) === null || _a === void 0 ? void 0 : _a[1];
+    if (syslog)
+        return SYSLOG_LETTERS[syslog];
+    const compact = (_b = COMPACT_LEVEL.exec(message)) === null || _b === void 0 ? void 0 : _b[1];
+    if (compact)
+        return COMPACT_LETTERS[compact];
+    return 'I';
+}
+// What `log stream` prints before its first line: not the device's.
+const STREAM_BANNER = /^(Filtering the log data using |Timestamp\s+Ty\s+Process)/;
+/**
+ * A driver entry as a record for the session's book, or null for what isn't
+ * a device line. A line without a level of its own (a message's continuation)
+ * is kept, as `I`.
+ */
+function recordFromDriverLog(entry) {
+    if (!entry || typeof entry.message !== 'string')
+        return null;
+    const message = entry.message.replace(/\s+$/, '');
+    if (!message || STREAM_BANNER.test(message))
+        return null;
+    const ts = Number(entry.timestamp);
+    return {
+        ts: Number.isFinite(ts) ? ts : Date.now(),
+        pid: 0,
+        tid: 0,
+        level: iosLineLevel(message),
+        tag: '',
+        message,
+    };
+}
+/** An iOS record's row text: the line as the phone or simulator printed it. */
+const iosLineText = (rec) => rec.message;
+exports.iosLineText = iosLineText;
+/**
+ * The lines the driver's log already holds, oldest first, without taking
+ * them: the ones from the create, before Xenon could listen. Reads the
+ * driver's internals (`logs`, an LRU cache keyed by arrival, and
+ * `_deserializeEntry`, as its own `getLogs()` does), so any other shape gives
+ * nothing rather than an error.
+ */
+function bufferedDriverLog(driverLog) {
+    var _a;
+    const log = driverLog;
+    if (typeof ((_a = log === null || log === void 0 ? void 0 : log.logs) === null || _a === void 0 ? void 0 : _a.rvalues) !== 'function' || typeof log._deserializeEntry !== 'function') {
+        return [];
+    }
+    try {
+        const out = [];
+        for (const value of log.logs.rvalues())
+            out.push(log._deserializeEntry(value));
+        return out;
+    }
+    catch (_b) {
+        return [];
+    }
+}
+/** Whether `value` can be listened to as a driver log. */
+function isDriverLog(value) {
+    const v = value;
+    return typeof (v === null || v === void 0 ? void 0 : v.on) === 'function' && typeof (v === null || v === void 0 ? void 0 : v.removeListener) === 'function';
+}
+// A line's process, the library that logged it and its pid: an iPhone's
+// "… Rabindras-iPhone Edge(UIKitCore)[8788] <Notice>: …" or a simulator's
+// "2026-10-05 20:31:40.123 Df Shop[4127:8812] (UIKitCore) …".
+const SYSLOG_HEADER = /^\w{3}\s+\d+ \d\d:\d\d:\d\d \S+ ([^\s[(]+)(?:\(([^)]*)\))?\[(\d+)\]/;
+const COMPACT_HEADER = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+\s+\S+\s+([^\s[]+)\[(\d+)(?::\d+)?\](?:\s+\(([^)]*)\))?/;
+function headerOf(message) {
+    const syslog = SYSLOG_HEADER.exec(message);
+    if (syslog)
+        return { name: syslog[1], sender: syslog[2] || undefined, pid: syslog[3] };
+    const compact = COMPACT_HEADER.exec(message);
+    if (compact)
+        return { name: compact[1], sender: compact[3] || undefined, pid: compact[2] };
+    return null;
+}
+const escapeRegExp = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+/**
+ * Which of an iPhone's or simulator's lines a session keeps: what the app
+ * under test's own code logs, every error and fault inside its process, what
+ * the phone's app manager says about it (its launch, its state, how it
+ * ended), the crash reports and memory kills that name it, and every fault.
+ *
+ * A phone logs hundreds of lines a second. Measured on an iPhone 14 Plus
+ * (iOS 26.5): about 53,000 in a one-minute session, which filled the
+ * 10,000-line limit during the create. Keeping the app's whole process wasn't
+ * enough either: Edge's process logged about 110 lines a second, of which
+ * its own code wrote 5 in 8,839. The rest was Apple's frameworks inside it
+ * (UIKit, Network, CFNetwork, WebKit), so their ordinary lines are left out
+ * and their errors kept. Only `runningboardd` and `SpringBoard` are kept for
+ * naming the app: about twenty other daemons each log every change of its
+ * state ("Received state update for 8723 (app<…"), 3,000 lines in 78 s.
+ *
+ * The app's process is learnt from the lines: the phone announces it by
+ * bundle id and pid (`app<com.example.shop(…)>:4127`, `pid: 4127 bundleID:
+ * com.example.shop`), and the lines of that pid give its executable's name,
+ * so a crash report or a memory kill that names it (`Shop[4127]`, `[Shop]`,
+ * `corpse[4127]`) is kept too. A line with no header of its own continues
+ * the one before.
+ */
+// The processes whose lines about the app say how it lives and ends: its
+// launch, assertions and exit with its reason (RunningBoard), its scenes and
+// windows (SpringBoard).
+const APP_MANAGERS = new Set(['runningboardd', 'SpringBoard']);
+class IosAppLines {
+    constructor(bundleId) {
+        this.bundleId = bundleId;
+        this.pids = new Set();
+        this.names = new Set();
+        this.lastKept = false;
+        const id = escapeRegExp(bundleId);
+        this.pidAnnounced = [
+            new RegExp(`app<${id}[^>]*>:(\\d+)`, 'g'),
+            new RegExp(`pid:? (\\d+),? bundleID:? ${id}\\b`, 'g'),
+        ];
+    }
+    /** Learns the app's pid and executable from a line, without deciding on it. */
+    learn(message) {
+        if (message.includes(this.bundleId)) {
+            for (const re of this.pidAnnounced) {
+                for (const m of message.matchAll(re))
+                    this.pids.add(m[1]);
+            }
+        }
+        const header = headerOf(message);
+        if (header && this.pids.has(header.pid))
+            this.names.add(header.name);
+    }
+    /** Whether the session keeps the line. */
+    keeps(message, level) {
+        this.learn(message);
+        const header = headerOf(message);
+        if (!header)
+            return this.lastKept;
+        const { name, sender, pid } = header;
+        const inApp = this.pids.has(pid) || this.names.has(name);
+        const keep = level === 'F' ||
+            (inApp && (level === 'E' || !sender || this.names.has(sender))) ||
+            (APP_MANAGERS.has(name) && message.includes(this.bundleId)) ||
+            (!inApp &&
+                ([...this.names].some((n) => message.includes(`${n}[`) || message.includes(`[${n}]`)) ||
+                    [...this.pids].some((p) => message.includes(`[${p}]`))));
+        this.lastKept = keep;
+        return keep;
+    }
+}
+exports.IosAppLines = IosAppLines;

package/lib/src/services/ocr/ocrData.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OCR_START_RETRY_MS = exports.OCR_DATA_SHA256 = exports.OCR_DATA_FILE = exports.OCR_DATA_DIR = exports.OCR_LANGUAGE = void 0;
+exports.ocrWorkerOptions = ocrWorkerOptions;
+exports.createOcrWorker = createOcrWorker;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const tesseract_js_1 = __importDefault(require("tesseract.js"));
+const logger_1 = __importDefault(require("../../logger"));
+/**
+ * The language data every OCR worker reads, shipped with the plugin
+ * (vendor/README.md says where it comes from).
+ *
+ * Left to its defaults, tesseract.js downloads eng.traineddata from
+ * cdn.jsdelivr.net when a worker starts, and caches it in the process's working
+ * directory. So a server with no internet couldn't run OCR at all, and one with
+ * internet left a 5 MB eng.traineddata wherever it was started (the home
+ * directory, ~/.appium). Through 2.14 that was every Xenon server.
+ */
+exports.OCR_LANGUAGE = 'eng';
+exports.OCR_DATA_DIR = path_1.default.join(__dirname, 'vendor');
+exports.OCR_DATA_FILE = path_1.default.join(exports.OCR_DATA_DIR, `${exports.OCR_LANGUAGE}.traineddata.gz`);
+/** The shipped file's SHA-256, as vendor/README.md gives it. */
+exports.OCR_DATA_SHA256 = '45b4cb346724ac1774f1c36f42f182b887bcdb28ebe63e6fff90ac41f3fcff91';
+/**
+ * What a worker is given: read the data from `dataDir` (a directory, never a
+ * URL, so nothing is fetched), and cache it nowhere. A job's own failure
+ * rejects its promise; without an errorHandler tesseract.js also throws it from
+ * the worker's message handler, where nothing can catch it.
+ */
+function ocrWorkerOptions(dataDir = exports.OCR_DATA_DIR) {
+    return {
+        langPath: dataDir,
+        cacheMethod: 'none',
+        gzip: true,
+        errorHandler: (err) => logger_1.default.warn(`OCR: ${err}`),
+    };
+}
+/**
+ * How long a worker that wouldn't start is remembered. tesseract.js hands back
+ * no worker when its start fails, so its thread can't be ended; starting one
+ * per OCR call would leave one more each time.
+ */
+exports.OCR_START_RETRY_MS = 60000;
+const startFailures = new Map();
+/** Files whose data checked out, so each is read and hashed once per process. */
+const checked = new Set();
+/**
+ * The data is the file the plugin ships, whole. tesseract.js 7, given data it
+ * can't load, answers a job it has already refused and throws a TypeError from
+ * its message handler, which ends the server (src/index.ts exits on an
+ * uncaught exception). So a damaged install is refused here, before a worker
+ * sees it.
+ */
+function checkData(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (checked.has(file))
+            return;
+        let data;
+        try {
+            data = yield fs_1.default.promises.readFile(file);
+        }
+        catch (_a) {
+            throw new Error(`OCR can't start: its language data is missing (${file})`);
+        }
+        if (crypto_1.default.createHash('sha256').update(data).digest('hex') !== exports.OCR_DATA_SHA256) {
+            throw new Error(`OCR can't start: its language data is damaged (${file})`);
+        }
+        checked.add(file);
+    });
+}
+/**
+ * An OCR worker for English, from the data that ships with the plugin. Fails
+ * with the reason when it can't start: a worker whose data won't load never
+ * settles otherwise, and OmniVisionService's lock would wait on it for ever.
+ */
+function createOcrWorker() {
+    return __awaiter(this, arguments, void 0, function* (dataDir = exports.OCR_DATA_DIR) {
+        const recent = startFailures.get(dataDir);
+        if (recent && Date.now() - recent.at < exports.OCR_START_RETRY_MS)
+            throw recent.error;
+        yield checkData(path_1.default.join(dataDir, `${exports.OCR_LANGUAGE}.traineddata.gz`));
+        let failed;
+        const failure = new Promise((_, reject) => {
+            failed = reject;
+        });
+        const options = ocrWorkerOptions(dataDir);
+        const logError = options.errorHandler;
+        const worker = tesseract_js_1.default.createWorker(exports.OCR_LANGUAGE, tesseract_js_1.default.OEM.LSTM_ONLY, Object.assign(Object.assign({}, options), { errorHandler: (err) => {
+                logError(err);
+                failed(new Error(`OCR can't start: ${err}`));
+            } }));
+        try {
+            // Once the worker has started, a later job's failure is only logged.
+            const started = yield Promise.race([worker, failure]);
+            startFailures.delete(dataDir);
+            return started;
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(`OCR can't start: ${err}`);
+            startFailures.set(dataDir, { at: Date.now(), error });
+            throw error;
+        }
+    });
+}

package/lib/src/services/ocr/vendor/LICENSE-tessdata.txt

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+