Minor enhancements to LinkedIn. Mostly just hotkeys.
Pada tanggal
// ==UserScript== // @name LinkedIn Tool // @namespace [email protected] // @match https://www.linkedin.com/* // @noframes // @version 2.8.1 // @author Mike Castle // @description Minor enhancements to LinkedIn. Mostly just hotkeys. // @license GPL-3.0-or-later; https://www.gnu.org/licenses/gpl-3.0.txt // @supportURL https://github.com/nexushoratio/userscripts/blob/main/linkedin-tool.md // @require https://cdn.jsdelivr.net/npm/@violentmonkey/shortcut@1 // @require https://cdn.jsdelivr.net/npm/@violentmonkey/dom@2 // @grant window.onurlchange // ==/UserScript== /* global VM */ (function () { 'use strict'; let navBarHeightPixels = 0; let navBarHeightCss = '0'; /** * Dump a bunch of information about an element. Currently this * goes to the console and then alerts the user to file a bug. * Eventually this should go into an area that can be brought up in * the help window instead. TODO(#39). * @param {Element} element - Element to get information about. * @param {string} name - What area this information came from. */ function dumpInfoAboutElement(element, name) { /* eslint-disable no-console */ console.clear(); console.debug(element); console.debug(element.innerText); for (const el of element.querySelectorAll('*')) { console.debug(el); } const msg = [ `An unsupported unsupported ${name} element was`, 'discovered. Please file a bug. If you are comfortable', 'with using the browser\'s Developer Tools (often the', 'F12 key), consider sharing the information just logged', 'in the console / debug view.', ]; alert(msg.join(' ')); /* eslint-enable */ } /** * Java's hashCode: s[0]*31(n-1) + s[1]*31(n-2) + ... + s[n-1] * @param {string} s - String to hash. * @returns {string} - Hash value. */ function strHash(s) { let hash = 0; for (let i = 0; i < s.length; i++) { hash = ((hash << 5) - hash) + s.charCodeAt(i) | 0; } return `${hash}`; } /** * Run querySelector to get an element, then click it. * @param {Element} base - Where to start looking. * @param {string[]} selectorArray - CSS selectors to use to find an * element. * @returns {boolean} - Whether an element could be found. */ function clickElement(base, selectorArray) { if (base) { for (const selector of selectorArray) { const el = base.querySelector(selector); if (el) { el.click(); return true; } } } return false; } /** * Determines if the element accepts keyboard input. * @param {Element} element - HTML Element to examine. * @returns {boolean} - Indicating whether the element accepts keyboard input. */ function isInput(element) { let tagName = ''; if ('tagName' in element) { tagName = element.tagName.toLowerCase(); } return (element.isContentEditable || ['input', 'textarea'].includes(tagName)); } /** * Bring the Brower's focus onto element. * @param {Element} element - HTML Element to focus on. */ function focusOnElement(element) { if (element) { const tabIndex = element.getAttribute('tabindex'); element.setAttribute('tabindex', 0); element.focus(); if (tabIndex) { element.setAttribute('tabindex', tabIndex); } else { element.removeAttribute('tabindex'); } } } /** * Scroll LinkedIn's common sidebar into view and moves focus to it. */ function focusOnSidebar() { const sidebar = document.querySelector('div.scaffold-layout__sidebar'); if (sidebar) { sidebar.style.scrollMarginTop = navBarHeightCss; sidebar.scrollIntoView(); focusOnElement(sidebar); } } /** * Scroll LinkedIn's common aside (right-hand sidebar) into view. */ function focusOnAside() { const aside = document.querySelector('aside.scaffold-layout__aside'); if (aside) { aside.style.scrollMarginTop = navBarHeightCss; aside.scrollIntoView(); focusOnElement(aside); } } /** * One time resize observer with timeout. * Will resolve automatically upon resize change. * @param {Element} base - Element to observe. * @param {?function()} trigger - Function to call that triggers observable events. * @param {number} timeout - Time to wait for completion in milliseconds, 0 disables. * @returns {Promise} - Will resolve with the base element. */ function otrot(base, trigger, timeout) { const prom = new Promise((resolve, reject) => { let timeoutID = null; const initialHeight = base.clientHeight; const initialWidth = base.clientWidth; trigger = trigger || function () {}; const observer = new ResizeObserver(() => { if (base.clientHeight !== initialHeight || base.clientWidth !== initialWidth) { observer.disconnect(); clearTimeout(timeoutID); resolve(base); } }); if (timeout) { timeoutID = setTimeout(() => { observer.disconnect(); reject('otrot timed out'); }, timeout); } observer.observe(base); trigger(); }); return prom; } /** * @typedef {object} Continuation * @property {boolean} done - Indicate whether the monitor is done processing. * @property {?object} results - Optional results object. */ /** * @callback Monitor * @param {MutationRecord[]} records - Standard mutation records. * @returns {Continuation} - Indicate whether done monitoring. */ /** * One time mutation observer with timeout. * @param {Element} base - Element to observe. * @param {object} options - MutationObserver().observe() options. * @param {Monitor} monitor - Callback used to process * MutationObserver records. * @param {?function()} trigger - Function to call that triggers * observable resultsl * @param {number} timeout - Time to wait for completion in * milliseconds, 0 disables. * @returns {Promise<Continuation.results>} - Will resolve with the * results from monitor when done is true. */ function otmot(base, options, monitor, trigger, timeout) { const prom = new Promise((resolve, reject) => { let timeoutID = null; trigger = trigger || function () {}; const observer = new MutationObserver((records) => { const {done, results} = monitor(records); if (done) { observer.disconnect(); clearTimeout(timeoutID); resolve(results); } }); if (timeout) { timeoutID = setTimeout(() => { observer.disconnect(); reject('otmot timed out'); }, timeout); } observer.observe(base, options); trigger(); }); return prom; } // I'm lazy. The version of emacs I'm using does not support // #private variables out of the box, so using underscores until I // get a working configuration. /** * Simple dispatcher. It takes a fixed list of event types upon * construction and attempts to use an unknown event will throw an * error. */ class Dispatcher { _handlers = new Map(); /** * @param{...string} eventTypes - Event types this instance can handle. */ constructor(...eventTypes) { for (const eventType of eventTypes) { this._handlers.set(eventType, []); } } /** * Look up array of handlers by event type. * @param {string} eventType - Event type to look up. * @throws {Error} - When eventType was not registered during instantiation. * @returns {function[]} - Handlers currently registered for this eventType. */ _getHandlers(eventType) { const handlers = this._handlers.get(eventType); if (!handlers) { throw new Error(`Unknown event type: ${eventType}`); } return handlers; } /** * Attach a function to an eventType. * @param {string} eventType - Event type to connect with. * @param {function} func - Single argument function to call. */ on(eventType, func) { const handlers = this._getHandlers(eventType); handlers.push(func); } /** * Remove all instances of a function registered to an eventType. * @param {string} eventType - Event type to disconnect from. * @param {function} func - Function to remove. */ off(eventType, func) { const handlers = this._getHandlers(eventType) let index = 0; while ((index = handlers.indexOf(func)) !== -1) { handlers.splice(index, 1); } } /** * Calls all registered functions for the given eventType. * @param {string} eventType - Event type to use. * @param {object} data - Data to pass to each function. */ fire(eventType, data) { const handlers = this._getHandlers(eventType); for (const handler of handlers) { handler(data); } } } /** * An ordered collection of HTMLElements for a user to scroll through. * * The dispatcher can be used the handle the following events: * - 'out-of-range' - Scrolling went past one end of the collection. * - 'change' - The value of item has changed. * This is NOT an error condition, but rather a design feature. */ class Scroller { _dispatcher = new Dispatcher('change', 'out-of-range'); _currentItemId = null; _historicalIdToIndex = new Map(); /** * Function that generates a, preferably, reproducible unique * identifier for an Element. * @callback uidCallback * @param {Element} element - Element to examine. * @returns {string} - A value unique to this element. */ /** * @param {Element} base - The container element. * @param {string[]} selectors - Array of CSS selectors to find * elements to collect, calling base.querySelectorAll(). * @param {uidCallback} uidCallback - Callback to generate a uid. * @param {string[]} classes - Array of CSS classes to add/remove * from an element as it becomes current. * @param {boolean} snapToTop - Whether items should snap to the * top of the window when coming into view. * @param {object} [debug={}] - Debug options * @param {boolean} [debug.enabled=false] - Enable messages. * @param {boolean} [debug.stackTrace=false] - Include stack traces. */ constructor(base, selectors, uidCallback, classes, snapToTop, debug) { if (!(base instanceof Element)) { throw new TypeError(`Invalid base: ${base}`); } this._destroyed = false; this._base = base; this._selectors = selectors; this._uidCallback = uidCallback; this._classes = classes; this._snapToTop = snapToTop; this._debug = debug ?? {}; this._debug.enabled ??= false; this._debug.stackTrace ??= false; this._msg('Scroller constructed', this); } /** * Fancy-ish debug messages. * console message groups can be started and ended using magic * keywords in messages. * - 'Entered' - Starts new group named with the rest of the string. * - 'Starting' - Starts a new collapsed group (useful for loops). * - 'Leaving' and 'Finished' - Both end the most recent group, * with Leaving for the function, and Finished for the loop * (though not enforced). * @example * foo(x) { * this._msg('Entered foo', x); * ... do stuff ... * this._msg('Leaving foo with', y); * return y; * } * @param {string} msg - Debug message to send to the console. */ _msg(msg, ...rest) { /* eslint-disable no-console */ if (this._debug.enabled) { if (this._debug.stackTrace) { console.groupCollapsed('call stack'); console.trace(); console.groupEnd(); } if (typeof msg === 'string' && msg.startsWith('Entered')) { console.group(msg.substr(msg.indexOf(' ') + 1)); } else if (typeof msg === 'string' && msg.startsWith('Starting')) { console.groupCollapsed(`${msg.substr(msg.indexOf(' ') + 1)} (collapsed)`); } console.debug(msg, ...rest); if (typeof msg === 'string' && (/^(Leaving|Finished)/).test(msg)) { console.groupEnd(); } } /* eslint-enable */ } /** @type {Dispatcher} */ get dispatcher() { return this._dispatcher; } /** * Represents the current item. * @type {Element} */ get item() { this._msg('Entered get item'); if (this._destroyed) { const msg = `Tried to work with destroyed ${this.constructor.name} on ${this._base}`; this._msg(msg); throw new Error(msg); } const items = this._getItems(); let item = items.find(this._matchItem.bind(this)); if (!item) { // We couldn't find the old id, so maybe it was rebuilt. Make // a guess by trying the old index. const idx = this._historicalIdToIndex.get(this._currentItemId); if (typeof idx === 'number' && 0 <= idx && idx < items.length) { item = items[idx]; this._bottomHalf(item); } } this._msg('Leaving get item with', item); return item; } /** * @param {Element} val - Update the current item with val. */ set item(val) { this._msg('Entered set item with', val); if (this.item) { this.dull(); } this._bottomHalf(val); this._msg('Leaving set item'); } /** * Since the getter will try to validate the current item (since * it could have changed out from under us), it too can update * information. * @param {Element} val - Element to make current. */ _bottomHalf(val) { this._msg('Entered bottomHalf with', val); this._currentItemId = this._uid(val); const idx = this._getItems().indexOf(val); this._historicalIdToIndex.set(this._currentItemId, idx); if (val) { this.shine(); this._scrollToCurrentItem(); } this.dispatcher.fire('change', {}); this._msg('Leaving bottomHalf'); } /** * Builds the list of using the registered CSS selectors. * @returns {Elements[]} - Items to scroll through. */ _getItems() { this._msg('Entered getItems'); const items = []; for (const selector of this._selectors) { this._msg(`considering ${selector}`); items.push(...this._base.querySelectorAll(selector)); } if (this._debug) { this._msg('Starting items'); for (const item of items) { this._msg(item); } this._msg('Finished items'); } this._msg(`Leaving getItems with ${items.length} items`); return items; } /** * Returns the uid for the current element. Will use the * registered uidCallback function for this. * @param {Element} element - Element to identify. * @returns {string} - Computed uid for element. */ _uid(element) { this._msg('Entered uid with', element); let uid = null; if (element) { if (!element.dataset.litId) { element.dataset.litId = this._uidCallback(element); } uid = element.dataset.litId; } this._msg('Leaving uid with', uid); return uid; } /** * Checks if the element is the current one. Useful as a callback * to Array.find. * @param {Element} element - Element to check. * @returns {boolean} - Whether or not element is the current one. */ _matchItem(element) { this._msg('Entered matchItem'); const res = this._currentItemId === this._uid(element); this._msg('Leaving matchItem with', res); return res; } /** * Scroll the current item into the view port. Depending on the * instance configuration, this could snap to the top, snap to the * bottom, or be a no-op. */ _scrollToCurrentItem() { this._msg('Entered scrollToCurrentItem with', this._snapToTop); const item = this.item; if (item) { item.style.scrollMarginTop = navBarHeightCss; if (this._snapToTop) { this._msg('snapping to top'); item.scrollIntoView(true); } else { item.style.scrollMarginBottom = '3em'; const rect = item.getBoundingClientRect(); // If both scrolling happens, it means the item is too tall to // fit on the page, so the top is preferred. if (rect.bottom > document.documentElement.clientHeight) { this._msg('scrolling up onto page'); item.scrollIntoView(false); } if (rect.top < navBarHeightPixels) { this._msg('scrolling down onto page'); item.scrollIntoView(true); } } } this._msg('Leaving scrollToCurrentItem'); } /** * Jump an item on the end of the collection. * @param {boolean} first - If true, the first item in the * collection, else, the last. */ _jumpToEndItem(first) { // Reset in case item was heavily modified this.item; const items = this._getItems(); if (items.length) { let idx = first ? 0 : (items.length - 1); let item = items[idx]; // Content of items is sometimes loaded lazily and can be // detected by having no innerText yet. So start at the end // and work our way up to the last one loaded. if (!first) { while (!item.innerText.length) { idx--; item = items[idx]; } } this.item = item; } } /** * Move forward or backwards in the collection by at least n. * @param {number} n - How many items to move and the intended direction. * @fires 'out-of-range' */ _scrollBy(n) { this._msg('Entered scrollBy', n); // Reset in case item was heavily modified this.item; const items = this._getItems(); if (items.length) { let idx = items.findIndex(this._matchItem.bind(this)); this._msg('starting idx', idx); idx += n; if (idx < -1) { idx = items.length - 1; } if (idx === -1 || idx >= items.length) { this._msg('left the container'); this.item = null; this.dispatcher.fire('out-of-range', null); } else { // Skip over empty items let item = items[idx]; while (!item.clientHeight) { this._msg('skipping empty item', item); idx += n; item = items[idx]; } this._msg('final idx', idx); this.item = item; } } this._msg('Leaving scrollBy'); } /** * Move to the next item in the collection. */ next() { this._scrollBy(1); } /** * Move to the previous item in the collection. */ prev() { this._scrollBy(-1); } /** * Jump to the first item in the collection. */ first() { this._jumpToEndItem(true); } /** * Jump to last item in the collection. */ last() { this._jumpToEndItem(false); } /** * Adds the registered CSS classes to the current element. */ shine() { if (this.item) { this.item.classList.add(...this._classes); } } /** * Removes the registered CSS classes from the current element. */ dull() { if (this.item) { this.item.classList.remove(...this._classes); } } /** * Bring current item back into view. */ show() { this._scrollToCurrentItem(); } /** * Mark instance as inactive and do any internal cleanup. */ destroy() { this._msg('Entered destroy'); this.item = null; this._destroyed = true; this._msg('Leaving destroy'); } } /** * Base class for handling various views of the LinkedIn SPA. * * Generally, new classes should subclass this, override a few * properties and methods, and then register themselves with an * instances of the {@link Pages} class. */ class Page { // The immediate following can be set in subclasses. /** * What pathname part of the URL this page should handle. The * special case of null is used by the {@link Pages} class to * represent global keys. * @type {string} */ _pathname; /** * CSS selector for capturing clicks on this page. If overridden, * then the class should also provide a _onClick() method. * @type {string} */ _onClickSelector = null; /** * Definition for keyboard shortcuts. * @typedef {object} Shortcut * @property {string} seq - Key sequence to activate. * @property {string} desc - Description that goes into the online help. * @property {function()} func - Function to call, usually in the * form of `this.methodName`. */ /** * List of {@link Shortcut}s to register automatically. The * function is bound to `this` before registering it with * VM.shortcut. * @type {Shortcut[]} */ _autoRegisteredKeys = []; // Private members. /** * @type {KeyboardService} */ _keyboard = new VM.shortcut.KeyboardService(); /** * Tracks which HTMLElement holds the `onclick` function. * @type {Element} */ _onClickElement = null; /** * Magic for VM.shortcut. This disables keys when focus is on an * input type field. * @type {IShortcutOptions} */ static _navOption = { caseSensitive: true, condition: '!inputFocus', }; /** Create a Page. */ constructor() { this._boundOnClick = this._onClick.bind(this); } /** * Called when registered via {@link Pages}. */ start() { for (const {seq, func} of this._autoRegisteredKeys) { this._addKey(seq, func.bind(this)); } } /** @type {string} */ get pathname() { return this._pathname; } /** @type {KeyboardService} */ get keyboard() { return this._keyboard; } /** * Turns on this Page's features. Called by {@link Pages} when * this becomes the current view. */ activate() { this._keyboard.enable(); this._enableOnClick(); } /** * Turns off this Page's features. Called by {@link Pages} when * this is no longer the current view. */ deactivate() { this._keyboard.disable(); this._disableOnClick(); } /** * Describes what the header should be. * @type {string} */ get helpHeader() { return this.constructor.name; } /** * The `key` and `desc` properties are important here. * @type {Shortcut[]} */ get helpContent() { return this._autoRegisteredKeys; } /** * Registers a specific key sequence with a function with VM.shortcut. * @param {string} seq - Key sequence. * @param {function()} func - Function to call. */ _addKey(seq, func) { this._keyboard.register(seq, func, Page._navOption); } /** * Enables the 'click' handler for this view. */ _enableOnClick() { if (this._onClickSelector) { // Page is dynamically building, so keep watching it until the // element shows up. VM.observe(document.body, () => { const element = document.querySelector(this._onClickSelector); if (element) { this._onClickElement = element; this._onClickElement.addEventListener('click', this._boundOnClick); // TODO(#46): Find a better place for this. this._refresh(); // Turns off VM.observe once selector found. return true; } return false; }); } } /** * Disables the 'click' handler for this view. */ _disableOnClick() { if (this._onClickElement) { this._onClickElement.removeEventListener('click', this._boundOnClick); this._onClickElement = null; } } /** * Override this function in subclasses that want to react to * random clicks on a page, say to update current element in * focus. * https://github.com/eslint/eslint/issues/17467 * @abstract * @param {Event} evt - Standard 'click' event. */ _onClick(evt) { // eslint-disable-line no-unused-vars alert(`Found a bug! ${this.constructor.name} wants to handle clicks, but forgot to create a handler.`); } /** * Override this function in subclasses to take action upon * becoming the current view again. */ _refresh() { this; } } /** * Class for handling aspects common across LinkedIn. * This includs things like the global nav bar, help screen, etc. */ class Global extends Page { _pathname = null; _autoRegisteredKeys = [ {seq: '?', desc: 'Show keyboard help', func: this._help}, {seq: '/', desc: 'Go to Search box', func: Global._gotoSearch}, {seq: 'g h', desc: 'Go Home (aka, Feed)', func: Global._goHome}, {seq: 'g m', desc: 'Go to My Network', func: Global._gotoMyNetwork}, {seq: 'g j', desc: 'Go to Jobs', func: Global._gotoJobs}, {seq: 'g g', desc: 'Go to Messaging', func: Global._gotoMessaging}, {seq: 'g n', desc: 'Go to Notifications', func: Global._gotoNotifications}, {seq: 'g p', desc: 'Go to Profile (aka, Me)', func: Global._gotoProfile}, {seq: 'g b', desc: 'Go to Business', func: Global._gotoBusiness}, {seq: 'g l', desc: 'Go to Learning', func: Global._gotoLearning}, {seq: ',', desc: 'Focus on the left/top sidebar (not always present)', func: focusOnSidebar}, {seq: '.', desc: 'Focus on the right/bottom sidebar (not always present)', func: focusOnAside}, ]; /** * The element.id used to identify the help pop-up. * @type {string} */ get helpId() { return this._helpId; } /** * @param {string} val - Set the value of the help element.id. */ set helpId(val) { this._helpId = val; } /** * Click on the requested link in the global nav bar. * @param {string} item - Portion of the link to match. */ static _gotoNavLink(item) { clickElement(document, [`#global-nav a[href*="/${item}"`]); } /** * Click on the requested button in the global nav bar. * @param {string} item - Text on the button to look for. */ static _gotoNavButton(item) { const buttons = Array.from(document.querySelectorAll('#global-nav button')); const button = buttons.find(el => el.textContent.includes(item)); if (button) { button.click(); } } /** * Open the help pop-up. */ _help() { const help = document.querySelector(`#${this.helpId}`); help.showModal(); help.focus(); } /** * Navigate to the search bar. */ static _gotoSearch() { clickElement(document, ['#global-nav-search button']); } /** * Activate the Home (feed) link. */ static _goHome() { Global._gotoNavLink('feed'); } /** * Activate the My Network link. */ static _gotoMyNetwork() { Global._gotoNavLink('mynetwork'); } /** * Activate the Jobs link. */ static _gotoJobs() { Global._gotoNavLink('jobs'); } /** * Activate the Messaging link. */ static _gotoMessaging() { Global._gotoNavLink('messaging'); } /** * Activate the Notifications link. */ static _gotoNotifications() { Global._gotoNavLink('notifications'); } /** * Click on the Me button, opening that menu. */ static _gotoProfile() { Global._gotoNavButton('Me'); } /** * Click on the For Business button, opening that menu. */ static _gotoBusiness() { Global._gotoNavButton('Business'); } /** * Activate the Learning link. */ static _gotoLearning() { Global._gotoNavLink('learning'); } } /** Class for handling the Posts feed. */ class Feed extends Page { _pathname = '/feed/'; _onClickSelector = 'main'; _autoRegisteredKeys = [ {seq: 'X', desc: 'Toggle hiding current post', func: this._togglePost}, {seq: 'j', desc: 'Next post', func: this._nextPost}, {seq: 'J', desc: 'Toggle hiding then next post', func: this._nextPostPlus}, {seq: 'k', desc: 'Previous post', func: this._prevPost}, {seq: 'K', desc: 'Toggle hiding then previous post', func: this._prevPostPlus}, {seq: 'm', desc: 'Show more of the post or comment', func: this._seeMore}, {seq: 'c', desc: 'Show comments', func: this._showComments}, {seq: 'n', desc: 'Next comment', func: this._nextComment}, {seq: 'p', desc: 'Previous comment', func: this._prevComment}, {seq: 'l', desc: 'Load more posts (if the <button>New Posts</button> button is available, load those)', func: Feed._loadMorePosts}, {seq: 'L', desc: 'Like post or comment', func: this._likePostOrComment}, {seq: '<', desc: 'Go to first post or comment', func: this._firstPostOrComment}, {seq: '>', desc: 'Go to last post or comment currently loaded', func: this._lastPostOrComment}, {seq: 'f', desc: 'Change browser focus to current post or comment', func: this._focusBrowser}, {seq: 'v p', desc: 'View the post directly', func: this._viewPost}, {seq: 'v r', desc: 'View reactions on current post or comment', func: this._viewReactions}, {seq: 'P', desc: 'Go to the share box to start a post or <kbd>TAB</kbd> to the other creator options', func: Feed._gotoShare}, {seq: '=', desc: 'Open the (⋯) menu', func: this._openMeatballMenu}, ]; _postScroller = null; _commentScroller = null; /** * Create the Feed; includes instantiating the posts {@link Scroller}. */ constructor() { super(); this._postScroller = new Scroller(document.body, ['main div[data-id]'], Feed._uniqueIdentifier, ['tom'], true, {enabled: false, stackTrace: true}); this._postScroller.dispatcher.on('out-of-range', focusOnSidebar); this._postScroller.dispatcher.on('change', this._changedPost.bind(this)); } /** @inheritdoc */ _onClick(evt) { const post = evt.target.closest('div[data-id]'); if (post && post !== this._posts.item) { this._posts.item = post; } } /** @inheritdoc */ _refresh() { /** * Wait for the post to be reloaded. * @implements {Monitor} * @param {MutationRecord[]} records - Standard mutation records. * @returns {Continuation} - Indicate whether done monitoring. */ function monitor(records) { for (const record of records) { if (record.oldValue.includes('has-occluded-height')) { return {done: true}; } } return {done: false}; } if (this._posts.item) { otmot(this._posts.item, {attributeFilter: ['class'], attributes: true, attributeOldValue: true}, monitor, null, 5000).finally(() => { this._posts.shine(); this._posts.show(); }); } } /** @type {Scroller} */ get _posts() { return this._postScroller; } /** @type {Scroller} */ get _comments() { if (!this._commentScroller && this._posts.item) { this._commentScroller = new Scroller(this._posts.item, ['article.comments-comment-item'], Feed._uniqueIdentifier, ['dick'], false); this._commentScroller.dispatcher.on('out-of-range', this._returnToPost.bind(this)); } return this._commentScroller; } /** * @param {null} val - Hack; should only be used to reset the * {@link Scroller}. */ set _comments(val) { if (this._commentScroller) { this._commentScroller.destroy(); this._commentScroller = null; } } /** @type {boolean} */ get _hasActiveComment() { return this._comments && this._comments.item; } /** * @implements {Scroller~uidCallback} * @param {Element} element - Element to examine. * @returns {string} - A value unique to this element. */ static _uniqueIdentifier(element) { if (element) { return element.dataset.id; } else { return null; } } /** * Reselects current post, triggering same actions as initial * selection. */ _returnToPost() { this._posts.item = this._posts.item; } /** * Removes the comments {@link Scroller}. */ _changedPost() { this._comments = null; } /** * Select the next post. */ _nextPost() { this._posts.next(); } /** * Toggle hiding current post then select the next. */ _nextPostPlus() { /** * Trigger function for {@link otrot}. */ function trigger() { this._togglePost(); this._nextPost(); } // XXX Need to remove the highlight before otrot sees it because // it affects the .clientHeight. this._posts.dull(); otrot(this._posts.item, trigger.bind(this), 3000).then(() => { this._posts.show(); }).catch(e => console.error(e)); // eslint-disable-line no-console } /** * Select the previous post. */ _prevPost() { this._posts.prev(); } /** * Toggle hiding the current post then select the previous. */ _prevPostPlus() { this._togglePost(); this._prevPost(); } /** * Select the next comment. */ _nextComment() { this._comments.next(); } /** * Select the previous comment. */ _prevComment() { this._comments.prev(); } /** * Toggles hiding the current post. */ _togglePost() { clickElement(this._posts.item, ['button[aria-label^="Dismiss post"]', 'button[aria-label^="Undo and show"]']); } /** * Show more comments on the current post. */ _showComments() { if (!clickElement(this._comments.item, ['button.show-prev-replies'])) { clickElement(this._posts.item, ['button[aria-label*="comment"]']); } } /** * Show more content of the current post or comment. */ _seeMore() { const el = this._comments.item ?? this._posts.item; clickElement(el, ['button[aria-label^="see more"]']); } /** * Like the current post or comment via reactions menu. */ _likePostOrComment() { const el = this._comments.item ?? this._posts.item; clickElement(el, ['button[aria-label^="Open reactions menu"]']); } /** * Select the first post or comment. */ _firstPostOrComment() { if (this._hasActiveComment) { this._comments.first(); } else { this._posts.first(); } } /** * Select the last post or comment. */ _lastPostOrComment() { if (this._hasActiveComment) { this._comments.last(); } else { this._posts.last(); } } /** * Load more posts. */ static _loadMorePosts() { const container = document.querySelector('div.scaffold-finite-scroll__content'); const savedScrollTop = document.documentElement.scrollTop; /** * Trigger function for {@link otrot}. */ function trigger() { if (clickElement(document, ['main div.feed-new-update-pill button'])) { // eslint-disable-next-line no-console console.debug('We need to do more when clicking the top load more button because it takes longer to recover. Just not sure what. Maybe otmot instead of otrot.'); } else { clickElement(document, ['main button.scaffold-finite-scroll__load-button']); } } otrot(container, trigger, 3000).then(() => { document.documentElement.scrollTop = savedScrollTop; }); } /** * Move browser focus to the share box. */ static _gotoShare() { const share = document.querySelector('div.share-box-feed-entry__top-bar').parentElement; share.style.scrollMarginTop = navBarHeightCss; share.scrollIntoView(); share.querySelector('button').focus(); } /** * Open the (⋯) menu for the current item. */ _openMeatballMenu() { // XXX In this case, the identifier is on an svg element, not // the button, so use the parentElement. When Firefox [fully // supports](https://bugzilla.mozilla.org/show_bug.cgi?id=418039) // the `:has()` pseudo-selector, we can probably use that and // use `clickElement()`. if (this._comments.item) { const button = this._comments.item.querySelector('[aria-label^="Open options"]').parentElement; button.click(); } else if (this._posts.item) { const button = this._posts.item.querySelector('[a11y-text^="Open control menu"],[aria-label^="Open control menu"]').parentElement; button.click(); } } /** * Change browser focus to the current post or comment. */ _focusBrowser() { const el = this._comments.item ?? this._posts.item; this._posts.show(); this._comments?.show(); focusOnElement(el); } /** * Navigate the the standalone page for the current post. */ _viewPost() { const post = this._posts.item; if (post) { const urn = post.dataset.id; const id = `lt-${urn.replaceAll(':', '-')}`; let a = post.querySelector(`#${id}`); if (!a) { a = document.createElement('a'); a.href = `/feed/update/${urn}/`; a.id = id; post.append(a); } a.click(); } } /** * Open the Reactions summary pop-up. */ _viewReactions() { // Bah! The queries are annoyingly different. if (this._comments.item) { clickElement(this._comments.item, ['button.comments-comment-social-bar__reactions-count']); } else if (this._posts.item) { clickElement(this._posts.item, ['button.feed-shared-social-action-bar-counts']); } } } /** * Class for handling the base Jobs page. * * This particular page requires a lot of careful monitoring. * Unlike other pages, this one will destroy and recreate HTML * elements, often with the exact same content, every time something * interesting happens. Like loading more sections or jobs, or * toggling state of a job. */ class Jobs extends Page { _pathname = '/jobs/'; _onClickSelector = 'main'; _autoRegisteredKeys = [ {seq: 'j', desc: 'Next section', func: this._nextSection}, {seq: 'k', desc: 'Previous section', func: this._prevSection}, {seq: 'n', desc: 'Next job', func: this._nextJob}, {seq: 'p', desc: 'Previous job', func: this._prevJob}, {seq: '<', desc: 'Go to to first section or job', func: this._firstSectionOrJob}, {seq: '>', desc: 'Go to last section or job currently loaded', func: this._lastSectionOrJob}, {seq: 'f', desc: 'Change browser focus to current section or job', func: this._focusBrowser}, {seq: 'l', desc: 'Load more sections (or More jobs for you items)', func: this._loadMoreSections}, {seq: 'Enter', desc: 'Activate the current job (click on it)', func: this._activateJob}, {seq: 'S', desc: 'Toggle saving job', func: this._toggleSaveJob}, {seq: 'X', desc: 'Toggle dismissing job', func: this._toggleDismissJob}, ]; _sectionScroller = null; _sectionsMO = null; _sectionWatchText = ''; _jobScroller = null; /** * Create the Jobs; includes instantiating the sections {@link Scroller}. */ constructor() { super(); this._sectionScroller = new Scroller(document.body, ['main section'], Jobs._uniqueIdentifier, ['tom'], true, {enabled: false, stackTrace: true}); this._sectionScroller.dispatcher.on('out-of-range', focusOnSidebar); this._sectionScroller.dispatcher.on('change', this._onChange.bind(this)); this._sectionsMO = new MutationObserver(this._mutationHandler.bind(this)); } /** @inheritdoc */ _onClick(evt) { const section = evt.target.closest('section'); if (section) { this._sections.item = section; } } /** @inheritdoc */ _refresh() { this._sections.show(); // The div does get recreated, so setting the observer again is // appropriate. const el = document.querySelector('div.scaffold-finite-scroll__content'); this._sectionsMO.observe(el, {childList: true}); } /** @type {Scroller} */ get _sections() { return this._sectionScroller; } /** @type {Scroller} */ get _jobs() { if (!this._jobScroller && this._sections.item) { this._jobScroller = new Scroller(this._sections.item, [':scope > ul > li', 'div.jobs-home-recent-searches__list-toggle', 'div.discovery-templates-vertical-list__footer'], Jobs._uniqueJobIdentifier, ['dick'], false, {enabled: false}); this._jobScroller.dispatcher.on('out-of-range', this._returnToSection.bind(this)); } return this._jobScroller; } /** * @param {null} val - Hack; should only be used to reset the * {@link Scroller}. */ set _jobs(val) { if (this._jobScroller) { this._jobScroller.destroy(); this._jobScroller = null; } } /** @type {boolean} */ get _hasActiveJob() { return this._jobs && this._jobs.item; } /** * @implements {Scroller~uidCallback} * @param {Element} element - Element to examine. * @returns {string} - A value unique to this element. */ static _uniqueIdentifier(element) { const h2 = element.querySelector('h2'); let content = element.innerText; if (h2) { content = h2.innerText; } return strHash(content); } /** * Complicated because there are so many variations. * @implements {Scroller~uidCallback} * @param {Element} element - Element to examine. * @returns {string} - A value unique to this element. */ static _uniqueJobIdentifier(element) { let content = element.innerText; let options = element.querySelectorAll('a[data-control-id]'); if (options.length === 1) { content = options[0].dataset.controlId; } else { options = element.querySelectorAll('a[id]'); if (options.length === 1) { content = options[0].id; } else { let s = ''; for (const img of element.querySelectorAll('img[alt]')) { s += img.alt; } if (s) { content = s; } else { options = element.querySelectorAll('.jobs-home-upsell-card__container'); if (options.length === 1) { content = options[0].className; } } } } return strHash(content); } /** * Reselects current section, triggering same actions as initial * selection. */ _returnToSection() { this._sections.item = this._sections.item; } /** * Updates {@link Jobs} specific watcher text and removes the jobs * {@link Scroller}. */ _onChange() { this._sectionWatchText = this._sections.item?.innerText.trim().split('\n')[0]; this._jobs = null; } /** * Recover scroll position after elements were recreated. * @param {number} topScroll - Where to scroll to. */ _resetScroll(topScroll) { // Explicitly setting jobs.item below will cause it to // scroll to that item. We do not want to do that if // the user is manually scrolling. const job = this._jobs.item; this._sections.shine(); // Section was probably rebuilt, assume jobs scroller is invalid. this._jobs = null; this._jobs.item = job; document.documentElement.scrollTop = topScroll; } /** * Overly complicated. The job sections get recreated in toto * every time new sections are loaded, whether manually or * automatically triggered while scrolling. When this happens, we * lose track of it. So we track the likely text from the current * section, and if we see that show up again, we put the shine * back on. We could simplify {@link _loadMoreSections} by * calling {@link show} here as well, but if the user is scrolling * for a reason, it seems rude to pop them back to the section * again. * @param {MutationRecord[]} records - Standard mutation records. */ _mutationHandler(records) { for (const record of records) { if (record.type === 'childList') { for (const node of record.addedNodes) { const newText = node.innerText?.trim().split('\n')[0]; if (newText && newText === this._sectionWatchText) { this._resetScroll(document.documentElement.scrollTop); } } } } } /** * Select the next section. */ _nextSection() { this._sections.next(); } /** * Select the previous section. */ _prevSection() { this._sections.prev(); } /** * Select the next job. */ _nextJob() { this._jobs.next(); } /** * Select the previous job. */ _prevJob() { this._jobs.prev(); } /** * Select the first section or job. */ _firstSectionOrJob() { if (this._hasActiveJob) { this._jobs.first(); } else { this._sections.first(); } } /** * Select the last section or job. */ _lastSectionOrJob() { if (this._hasActiveJob) { this._jobs.last(); } else { this._sections.last(); } } /** * Change browser focus to the current section or job. */ _focusBrowser() { const el = this._jobs.item ?? this._sections.item; this._sections.show(); this._jobs?.show(); focusOnElement(el); } /** * Load more sections (or jobs in some cases). */ _loadMoreSections() { const container = document.querySelector('div.scaffold-finite-scroll__content'); const savedScrollTop = document.documentElement.scrollTop; /** * Trigger function for {@link otrot}. */ function trigger() { clickElement(document, ['main button.scaffold-finite-scroll__load-button']); } otrot(container, trigger, 3000).then(() => { this._resetScroll(savedScrollTop); }); } /** * Activate the current job. */ _activateJob() { const job = this._jobs?.item; if (job) { if (!clickElement(job, ['div[data-view-name]', 'a', 'button'])) { dumpInfoAboutElement(job, 'job') } } else { // Again, because we use Enter as the hotkey for this action. document.activeElement.click(); } } /** * Toggles saving the current job. */ _toggleSaveJob() { const savedJob = this._jobs?.item; /** * Trigger function for {@link otrot}. Because, of course jobs * needs it. */ function trigger() { clickElement(this._jobs.item, ['button[aria-label^="Save job"]', 'button[aria-label^="Unsave job"]']); } if (savedJob) { otrot(this._sections.item, trigger.bind(this), 3000).then(() => { this._jobs.item = savedJob; }); } } /** * Toggles dismissing the current job. */ _toggleDismissJob() { const savedJob = this._jobs.item; /** * Trigger function for {@link otrot}. Because, of course jobs * needs it. */ function trigger() { clickElement(this._jobs.item, ['button[aria-label^="Dismiss job"]:not([disabled])', 'button[aria-label$=" Undo"]']); } if (savedJob) { otrot(this._sections.item, trigger.bind(this), 3000).then(() => { this._jobs.item = savedJob; }); } } } /** Class for handling Job collections. */ class JobsCollections extends Page { _pathname = '/jobs/collections/'; } /** Class for handling the Notifications page. */ class Notifications extends Page { _pathname = '/notifications/'; _onClickSelector = 'main'; _autoRegisteredKeys = [ {seq: 'j', desc: 'Next notification', func: this._nextNotification}, {seq: 'k', desc: 'Previous notification', func: this._prevNotification}, {seq: 'Enter', desc: 'Activate the current notification (click on it)', func: this._activateNotification}, {seq: 'X', desc: 'Toggle current notification deletion', func: this._deleteNotification}, {seq: 'l', desc: 'Load more notifications', func: Notifications._loadMoreNotifications}, {seq: 'f', desc: 'Change browser focus to current notification', func: this._focusBrowser}, {seq: '<', desc: 'Go to first notification', func: this._firstNotification}, {seq: '>', desc: 'Go to last notification', func: this._lastNotification}, {seq: '=', desc: 'Open the (⋯) menu', func: this._openMeatballMenu}, ]; _notificationScroller = null; /** * Create the Notifications view; includes instantiating the posts * {@link Scroller}. */ constructor() { super(); this._notificationScroller = new Scroller(document.body, ['main section div.nt-card-list article'], Notifications._uniqueIdentifier, ['tom'], false, {enabled: false, strackTrace: true}); this._notificationScroller.dispatcher.on('out-of-range', focusOnSidebar); } /** @inheritdoc */ _onClick(evt) { const notification = evt.target.closest('div.nt-card-list article'); if (notification) { this._notifications.item = notification; } } /** @inheritdoc */ _refresh() { this._notifications.shine(); this._notifications.show(); } /** @type {Scroller} */ get _notifications() { return this._notificationScroller; } /** * Complicated because there are so many variations in * notification cards. We do not want to use reaction counts * because they can change too quickly. * @implements {Scroller~uidCallback} * @param {Element} element - Element to examine. * @returns {string} - A value unique to this element. */ static _uniqueIdentifier(element) { let content = element.innerText; if (element.childElementCount === 3) { let content = element.children[1].innerText; if (content.includes('Reactions')) { for (const el of element.children[1].querySelectorAll('*')) { if (el.innerText) { content = el.innerText; break; } } } } if (content.startsWith('Notification deleted.')) { // Mix in something unique from the parent. content += element.parentElement.dataset.finiteScrollHotkeyItem; } return strHash(content); } /** * Select the next notification. */ _nextNotification() { this._notifications.next(); } /** * Select the previous notification. */ _prevNotification() { this._notifications.prev(); } /** * Change browser focus to the current notification. */ _focusBrowser() { this._notifications.show(); focusOnElement(this._notifications.item); } /** * Select the first notification. */ _firstNotification() { this._notifications.first(); } /** * Select the last notification. */ _lastNotification() { this._notifications.last(); } /** * Open the (⋯) menu for the current notification. */ _openMeatballMenu() { clickElement(this._notifications.item, ['button[aria-label^="Settings menu"]']); } /** * Activate the current notification. */ _activateNotification() { const notification = this._notifications.item; if (notification) { // Because we are using Enter as the hotkey here, if the // active element is inside the current card, we want that to // take precedence. if (document.activeElement.closest('article') === notification) { return; } /** * Every notification is different. * It may be that notifications are settling on 'a.nt-card__headline'. * @param {Element} el - Element to inspect. * @returns {boolean} - Whether this element is recognized. */ function matchesKnownText(el) { // eslint-disable-line no-inner-declarations if (el.innerText === 'Apply early') { return true; } else if (el.innerText === 'Undo') { return true; } return false; } const buttons = Array.from(notification.querySelectorAll('button')); const button = buttons.find(matchesKnownText); if (button) { button.click(); } else { const elements = notification.querySelectorAll('.nt-card__headline'); if (elements.length === 1) { elements[0].click(); } else { dumpInfoAboutElement(notification, 'notification'); } } } else { // Again, because we use Enter as the hotkey for this action. document.activeElement.click(); } } /** * Toggles deletion of the current notification. */ _deleteNotification() { const notification = this._notifications.item; const container = document.querySelector('div.scaffold-finite-scroll__content'); /** * Trigger function for {@link otrot}. */ function trigger() { // Hah. Unlike in other places, these buttons already exist, // just hidden under the menu. const buttons = Array.from(notification.querySelectorAll('button')); const button = buttons.find(el => el.textContent.includes('Delete this notification')); if (button) { button.click(); } else { clickElement(notification, ['button[aria-label^="Undo notification deletion"]']); } } if (notification) { otrot(container, trigger, 3000).then(() => { this._notifications.shine(); }); } } /** * Load more notifications. */ static _loadMoreNotifications() { const container = document.querySelector('div.scaffold-finite-scroll__content'); const savedScrollTop = document.documentElement.scrollTop; /** * Trigger function for {@link otrot}. */ function trigger() { clickElement(document, ['main button.scaffold-finite-scroll__load-button']); } otrot(container, trigger, 3000).then(() => { document.documentElement.scrollTop = savedScrollTop; }); } } class Pages { _global = null; _page = null; _pages = new Map(); _lastInputElement = null; constructor() { this._id = crypto.randomUUID(); Pages._installNavStyle(); this._initializeHelpMenu(); document.addEventListener('focus', this._onFocus.bind(this), true); document.addEventListener('urlchange', this._onUrlChange.bind(this), true); } _setInputFocus(state) { const pages = Array.from(this._pages.values()); pages.push(this._global); for (const page of pages) { if (page) { page.keyboard.setContext('inputFocus', state); } } } _onFocus(evt) { if (this._lastInputElement && evt.target !== this._lastInputElement) { this._lastInputElement = null this._setInputFocus(false); } if (isInput(evt.target)) { this._setInputFocus(true); this._lastInputElement = evt.target; } } _onUrlChange(evt) { this.activate(evt.detail.url.pathname); } static _installNavStyle() { const style = document.createElement('style'); style.textContent += '.tom { border-color: orange !important; border-style: solid !important; border-width: medium !important; }'; style.textContent += '.dick { border-color: red !important; border-style: solid !important; border-width: thin !important; }'; document.head.append(style); } _initializeHelpMenu() { this._helpId = `help-${this._id}`; const style = document.createElement('style'); style.textContent += `#${this._helpId} kbd {font-size: 0.85em; padding: 0.07em; border-width: 1px; border-style: solid; }`; style.textContent += `#${this._helpId} th { padding-top: 1em; text-align: left; }`; style.textContent += `#${this._helpId} td:first-child { white-space: nowrap; text-align: right; padding-right: 0.5em; }`; style.textContent += `#${this._helpId} button { border-width: 1px; border-style: solid; border-radius: 0.25em; }`; document.head.prepend(style); const dialog = document.createElement('dialog'); dialog.id = this._helpId dialog.innerHTML = '<table><caption>' + '<span style="float: left">Keyboard shortcuts</span>' + '<span style="float: right">Hit <kbd>ESC</kbd> to close</span>' + '</caption><tbody></tbody></table>'; document.body.prepend(dialog); } // ThisPage -> This Page static _parseHeader(text) { return text.replace(/([A-Z])/g, ' $1').trim(); } // 'a b' -> '<kbd>a</kbd> then <kbd>b</kbd>' static _parseSeq(seq) { const letters = seq.split(' ').map(w => `<kbd>${w}</kbd>`); const s = letters.join(' then '); return s; } _addHelp(page) { const help = document.querySelector(`#${this._helpId} tbody`); const section = Pages._parseHeader(page.helpHeader); let s = `<tr><th></th><th>${section}</th></tr>`; for (const {seq, desc} of page.helpContent) { const keys = Pages._parseSeq(seq); s += `<tr><td>${keys}:</td><td>${desc}</td></tr>`; } // Don't include works in progress that have no keys yet. if (page.helpContent.length) { help.innerHTML += s; } } register(page) { page.start(); this._addHelp(page); if (page.pathname === null) { page.helpId = this._helpId this._global = page; this._global.activate(); } else { this._pages.set(page.pathname, page); } } _findPage(pathname) { const pathnames = Array.from(this._pages.keys()); const candidates = pathnames.filter(p => pathname.startsWith(p)); const candidate = candidates.reduce((a, b) => (a.length > b.length ? a : b), ''); return this._pages.get(candidate) || null; } activate(pathname) { if (this._page) { this._page.deactivate(); } const page = this._findPage(pathname); this._page = page; if (page) { page.activate(); } } } const pages = new Pages(); pages.register(new Global()); pages.register(new Feed()); pages.register(new Jobs()); pages.register(new JobsCollections()); pages.register(new Notifications()); pages.activate(window.location.pathname); function navBarMonitor() { const navbar = document.querySelector('#global-nav'); if (navbar) { return {done: true, results: navbar}; } return {done: false, results: null}; } // In this case, the trigger was the page load. It already happened // by the time we got here. otmot(document.body, {childList: true, subtree: true}, navBarMonitor, null, 0) .then((el) => { navBarHeightPixels = el.clientHeight + 4; navBarHeightCss = `${navBarHeightPixels}px`; }); if (window.onurlchange === null) { // We are likely running on Tampermonkey, so use native support. console.debug('Using window.onurlchange for monitoring URL updates.'); // eslint-disable-line no-console window.addEventListener('urlchange', (info) => { // The info that TM gives is not really an event. So we turn it // into one and throw it again, this time onto `document` where // `pages` is listening for it. const newUrl = new URL(info.url); const evt = new CustomEvent('urlchange', {detail: {url: newUrl}}); document.dispatchEvent(evt); }); } else { console.debug('Using MutationObserver for monitoring URL updates.'); // eslint-disable-line no-console let oldUrl = new URL(window.location); function registerUrlMonitor(element) { // eslint-disable-line no-inner-declarations const observer = new MutationObserver(() => { const newUrl = new URL(window.location); if (oldUrl.href !== newUrl.href) { const evt = new CustomEvent('urlchange', {detail: {url: newUrl}}); oldUrl = newUrl; document.dispatchEvent(evt); } }); observer.observe(element, {childList: true, subtree: true}); } function authenticationOutletMonitor() { // eslint-disable-line no-inner-declarations const div = document.body.querySelector('div.authentication-outlet'); if (div) { return {done: true, results: div}; } return {done: false, results: null}; } otmot(document.body, {childList: true, subtree: true}, authenticationOutletMonitor, null, 0) .then((el) => registerUrlMonitor(el)); } console.debug('Initialization successful.'); // eslint-disable-line no-console })();
