settings.js

// This file contains the Settings class.
// -----------------------------------------------------------------------------

/**
 * Settings in browser storage that determine the circumstances under which a
 * video should be hidden.
 */
class Settings {
    /**
     * Constructs a new Settings object and, for convenience, loads its state.
     */
    constructor() {
        this.state = SETTINGS_DEFAULT_STATE;
        this.load();
    }

    /**
     * Reports whether watched videos on the current page should be ignored,
     * taking into account the YouTube page filters.
     *
     * @returns {boolean} - True iff watched videos should be ignored.
     */
    ignored() {
        const page = Path.parse(window.location.toString());

        const filters = {
            [HIDE_CHANNELS_CHECKBOX_STORAGE_KEY]: isChannelPage,
            [HIDE_HOME_CHECKBOX_STORAGE_KEY]: isHomePage,
            [HIDE_EXPLORE_CHECKBOX_STORAGE_KEY]: isExplorePage,
            [HIDE_LIBRARY_CHECKBOX_STORAGE_KEY]: isLibraryPage,
            [HIDE_HISTORY_CHECKBOX_STORAGE_KEY]: isHistoryPage,
            [HIDE_SUBSCRIPTIONS_CHECKBOX_STORAGE_KEY]: isSubscriptionsPage,
        };

        for (const [key, isFilterPage] of Object.entries(filters)) {
            if (this.state[key] === false && isFilterPage(document, page)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Reports whether watched videos on the current page should be hidden,
     * taking into account the state of the universal Hide Videos toggle and
     * bookmarks.
     *
     * @returns {boolean} - True iff watched videos should be hidden.
     */
    hidden() {
        const page = Path.parse(window.location.toString());
        const bookmark = this.state[HIDE_VIDEOS_BOOKMARKS_STORAGE_KEY][page];
        const universal = this.state[HIDE_VIDEOS_CHECKBOX_STORAGE_KEY];
        return bookmark !== undefined ? bookmark : universal;
    }

    /**
     * Returns the current view threshold.
     *
     * @returns {number} - Minimum watch progress of a viewed video inside the
     * inclusive range [1, 100].
     */
    threshold() {
        const enabled = this.state[VIEW_THRESHOLD_CHECKBOX_STORAGE_KEY] === true;
        const percent = this.state[VIEW_THRESHOLD_SLIDER_STORAGE_KEY];
        return enabled ? percent : 100;
    }

    /**
     * Loads the state from browser storage and then invokes the given callback
     * if one is provided.
     *
     * @param {*} continuation - Function to be called after the state is loaded.
     */
    load(continuation) {
        const callback = (values) => {
            Logger.debug("Settings.load(): loaded", values, ".");
            this.state = values;
            if (continuation !== undefined) {
                continuation();
            }
        }
        Storage.get(SETTINGS_DEFAULT_STATE, callback);
    }
}