BetterDiscordApp-v2/client/src/modules/content.js

/**
 * BetterDiscord Content Base
 * Copyright (c) 2015-present Jiiks/JsSucks - https://github.com/Jiiks / https://github.com/JsSucks
 * All rights reserved.
 * https://betterdiscord.net
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
*/

import { Utils, FileUtils, ClientLogger as Logger, AsyncEventEmitter } from 'common';
import { Modals } from 'ui';

export default class Content {

    constructor(internals) {
        this.__internals = internals;

        this.settings.on('setting-updated', event => this.events.emit('setting-updated', event));
        this.settings.on('settings-updated', event => this.events.emit('settings-updated', event));
        this.settings.on('settings-updated', event => this.__settingsUpdated(event));

        // Add hooks
        if (this.onstart) this.on('start', event => this.onstart(event));
        if (this.onStart) this.on('start', event => this.onStart(event));
        if (this.onstop) this.on('stop', event => this.onstop(event));
        if (this.onStop) this.on('stop', event => this.onStop(event));
        if (this.onunload) this.on('unload', event => this.onunload(event));
        if (this.onUnload) this.on('unload', event => this.onUnload(event));
        if (this.settingUpdated) this.on('setting-updated', event => this.settingUpdated(event));
        if (this.settingsUpdated) this.on('settings-updated', event => this.settingsUpdated(event));
    }

    get type() { return undefined }
    get configs() { return this.__internals.configs }
    get info() { return this.__internals.info }
    get paths() { return this.__internals.paths }
    get main() { return this.__internals.main }
    get defaultConfig() { return this.configs.defaultConfig }
    get userConfig() { return this.configs.userConfig }
    get configSchemes() { return this.configs.schemes }
    get id() { return this.info.id || this.name.toLowerCase().replace(/[^a-zA-Z0-9-]/g, '-').replace(/--/g, '-') }
    get name() { return this.info.name }
    get icon() { return this.info.icon }
    get description() { return this.info.description }
    get authors() { return this.info.authors }
    get version() { return this.info.version }
    get contentPath() { return this.paths.contentPath }
    get dirName() { return this.paths.dirName }
    get enabled() { return this.userConfig.enabled }
    get settings() { return this.userConfig.config }
    get config() { return this.settings.categories }
    get data() { return this.userConfig.data || (this.userConfig.data = {}) }
    get events() { return this.EventEmitter || (this.EventEmitter = new AsyncEventEmitter()) }

    /**
     * Opens a settings modal for this content.
     */
    showSettingsModal() {
        return Modals.contentSettings(this);
    }

    /**
     * Whether this content has any settings.
     */
    get hasSettings() {
        return !!this.settings.findSetting(() => true);
    }

    /**
     * Saves the content's current configuration.
     */
    async saveConfiguration() {
        try {
            await FileUtils.writeFile(`${this.contentPath}/user.config.json`, JSON.stringify({
                enabled: this.enabled,
                config: this.settings.strip().settings,
                data: this.data
            }));

			this.settings.setSaved();
        } catch (err) {
			Logger.err(this.name, ['Failed to save configuration', err]);
            throw err;
        }
    }

    /**
     * Called when settings are updated.
     * This can be overridden by other content types.
     */
    __settingsUpdated(event) {
        return this.saveConfiguration();
    }

    /**
     * Enables the content.
     * @param {Boolean} save Whether to save the new enabled state
     * @return {Promise}
     */
    async enable(save = true) {
        if (this.enabled) return;
        await this.emit('enable');
        await this.emit('start');

        this.userConfig.enabled = true;
        if (save) await this.saveConfiguration();
    }

    /**
     * Disables the content.
     * @param {Boolean} save Whether to save the new enabled state
     * @return {Promise}
     */
    async disable(save = true) {
        if (!this.enabled) return;
        await this.emit('stop');
        await this.emit('disable');

        this.userConfig.enabled = false;
        if (save) await this.saveConfiguration();
    }

    /**
     * Adds an event listener.
     * @param {String} event The event to add the listener to
     * @param {Function} callback The function to call when the event is emitted
     */
    on(...args) {
        return this.events.on(...args);
    }

    /**
     * Removes an event listener.
     * @param {String} event The event to remove the listener from
     * @param {Function} callback The bound callback (optional)
     */
    off(...args) {
        return this.events.removeListener(...args);
    }

    /**
     * Adds an event listener that removes itself when called, therefore only being called once.
     * @param {String} event The event to add the listener to
     * @param {Function} callback The function to call when the event is emitted
     * @return {Promise|undefined}
     */
    once(...args) {
        return this.events.once(...args);
    }

    /**
     * Emits an event.
     * @param {String} event The event to emit
     * @param {Any} data Data to be passed to listeners
     * @return {Promise|undefined}
     */
    emit(...args) {
        return this.events.emit(...args);
    }

}