lightcordwarez
/
BetterDiscordApp-v2
mirror of https://github.com/JsSucks/BetterDiscordApp
1
0
Fork 0
Code Issues 3 Releases Wiki Activity

Merge pull request #130 from samuelthomas2774/add-setting-events 

Add setting change events
This commit is contained in:
Alexei Stukov 2018-02-14 09:39:15 +02:00 committed by GitHub
parent 058fd2f7b5 227b2cc0d8
commit dcd69d7b29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 386 additions and 155 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
client/src/modules/contentmanager.js
View File

@ -12,7 +12,7 @@ import Globals from './globals';
import { FileUtils, ClientLogger as Logger } from 'common';
import path from 'path';
import { Events } from 'modules';
import { Error } from 'structs';
import { ErrorEvent } from 'structs';
import { Modals } from 'ui';
export default class {
@ -29,7 +29,7 @@ export default class {
return this._contentPath ? this._contentPath : (this._contentPath = Globals.getObject('paths').find(path => path.id === this.pathId).path);
}
static async loadAllContent(supressErrors) {
static async loadAllContent(suppressErrors) {
try {
await FileUtils.ensureDirectory(this.contentPath);
const directories = await FileUtils.listDirectory(this.contentPath);
@ -38,7 +38,7 @@ export default class {
try {
await this.preloadContent(dir);
} catch (err) {
this.errors.push(new Error({
this.errors.push(new ErrorEvent({
module: this.moduleName,
message: `Failed to load ${dir}`,
err
@ -48,7 +48,7 @@ export default class {
}
}
if (this.errors.length && !supressErrors) {
if (this.errors.length && !suppressErrors) {
Modals.error({
header: `${this.moduleName} - ${this.errors.length} ${this.contentType}${this.errors.length !== 1 ? 's' : ''} failed to load`,
module: this.moduleName,
@ -154,7 +154,7 @@ export default class {
mainPath
}
const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main, readConfig.type);
const content = await this.loadContent(paths, configs, readConfig.info, readConfig.main);
if (reload) this.localContent[index] = content;
else this.localContent.push(content);
return content;

25
client/src/modules/extmodule.js
View File

@ -8,6 +8,27 @@
* LICENSE file in the root directory of this source tree.
*/
import { EventEmitter } from 'events';
class ExtModuleEvents {
constructor(extmodule) {
this.extmodule = extmodule;
this.emitter = new EventEmitter();
}
on(eventname, callback) {
this.emitter.on(eventname, callback);
}
off(eventname, callback) {
this.emitter.removeListener(eventname, callback);
}
emit(...args) {
this.emitter.emit(...args);
}
}
export default class ExtModule {
constructor(pluginInternals) {
@ -31,5 +52,7 @@ export default class ExtModule {
get pluginPath() { return this.paths.contentPath }
get dirName() { return this.paths.dirName }
get enabled() { return true }
get pluginConfig() { return this.userConfig.config || [] }
get config() { return this.userConfig.config || [] }
get events() { return this.EventEmitter ? this.EventEmitter : (this.EventEmitter = new ExtModuleEvents(this)) }
}

3
client/src/modules/extmodulemanager.js
View File

@ -38,11 +38,10 @@ export default class extends ContentManager {
static get refreshModules() { return this.refreshContent }
static get loadContent() { return this.loadModule }
static async loadModule(paths, configs, info, main, type) {
static async loadModule(paths, configs, info, main) {
return new ExtModule({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName, mainPath: paths.mainPath } });
}
static get findModule() { return this.findContent }
static get getModuleIndex() { return this.getContentIndex }
static get getModuleByName() { return this.getContentByName }

58
client/src/modules/plugin.js
View File

@ -10,6 +10,27 @@
import { FileUtils } from 'common';
import { Modals } from 'ui';
import { EventEmitter } from 'events';
import { SettingUpdatedEvent, SettingsUpdatedEvent } from 'structs';
class PluginEvents {
constructor(plugin) {
this.plugin = plugin;
this.emitter = new EventEmitter();
}
on(eventname, callback) {
this.emitter.on(eventname, callback);
}
off(eventname, callback) {
this.emitter.removeListener(eventname, callback);
}
emit(...args) {
this.emitter.emit(...args);
}
}
export default class Plugin {
@ -29,15 +50,17 @@ export default class Plugin {
get main() { return this.__pluginInternals.main }
get defaultConfig() { return this.configs.defaultConfig }
get userConfig() { return this.configs.userConfig }
get id() { return this.info.id || this.info.name.replace(/[^a-zA-Z0-9-]/g, '-').replace(/--/g, '-') }
get id() { return this.info.id || this.name.replace(/[^a-zA-Z0-9-]/g, '-').replace(/--/g, '-') }
get name() { return this.info.name }
get authors() { return this.info.authors }
get version() { return this.info.version }
get pluginPath() { return this.paths.contentPath }
get dirName() { return this.paths.dirName }
get enabled() { return this.userConfig.enabled }
get pluginConfig() { return this.userConfig.config || [] }
get config() { return this.userConfig.config || [] }
get pluginConfig() { return this.config }
get exports() { return this._exports ? this._exports : (this._exports = this.getExports()) }
get events() { return this.EventEmitter ? this.EventEmitter : (this.EventEmitter = new PluginEvents(this)) }
getSetting(setting_id, category_id) {
for (let category of this.pluginConfig) {
@ -54,21 +77,34 @@ export default class Plugin {
}
async saveSettings(newSettings) {
for (let category of newSettings) {
const oldCategory = this.pluginConfig.find(c => c.category === category.category);
for (let setting of category.settings) {
const oldSetting = oldCategory.settings.find(s => s.id === setting.id);
if (oldSetting.value === setting.value) continue;
oldSetting.value = setting.value;
if (this.settingChanged) this.settingChanged(category.category, setting.id, setting.value);
const updatedSettings = [];
for (let newCategory of newSettings) {
const category = this.pluginConfig.find(c => c.category === newCategory.category);
for (let newSetting of newCategory.settings) {
const setting = category.settings.find(s => s.id === newSetting.id);
if (setting.value === newSetting.value) continue;
let old_value = setting.value;
setting.value = newSetting.value;
updatedSettings.push({ category_id: category.category, setting_id: setting.id, value: setting.value, old_value });
this.settingUpdated(category.category, setting.id, setting.value, old_value);
}
}
this.saveConfiguration();
return this.settingsUpdated(updatedSettings);
}
if (this.settingsChanged) this.settingsChanged(this.pluginConfig);
settingUpdated(category_id, setting_id, value, old_value) {
const event = new SettingUpdatedEvent({ category_id, setting_id, value, old_value });
this.events.emit('setting-updated', event);
this.events.emit(`setting-updated_{$category_id}_${setting_id}`, event);
}
return this.pluginConfig;
settingsUpdated(updatedSettings) {
const event = new SettingsUpdatedEvent({ settings: updatedSettings.map(s => new SettingUpdatedEvent(s)) });
this.events.emit('settings-updated', event);
}
async saveConfiguration() {

10
client/src/modules/pluginapi.js
View File

@ -9,6 +9,7 @@
*/
import { ClientLogger as Logger } from 'common';
import Settings from './settings';
import ExtModuleManager from './extmodulemanager';
import PluginManager from './pluginmanager';
import ThemeManager from './thememanager';
@ -67,6 +68,15 @@ export default class PluginApi {
}
}
getSetting(set, category, setting) {
return Settings.get(set, category, setting);
}
get Settings() {
return {
get: this.getSetting.bind(this)
};
}
async getPlugin(plugin_id) {
// This should require extra permissions
return await PluginManager.waitForPlugin(plugin_id);

7
client/src/modules/pluginmanager.js
View File

@ -15,7 +15,6 @@ import Vendor from './vendor';
import { ClientLogger as Logger } from 'common';
import { Events } from 'modules';
export default class extends ContentManager {
static get localPlugins() {
@ -34,8 +33,8 @@ export default class extends ContentManager {
return 'plugins';
}
static async loadAllPlugins(supressErrors) {
const loadAll = await this.loadAllContent(supressErrors);
static async loadAllPlugins(suppressErrors) {
const loadAll = await this.loadAllContent(suppressErrors);
this.localPlugins.forEach(plugin => {
if (plugin.enabled) plugin.start();
});
@ -45,7 +44,7 @@ export default class extends ContentManager {
static get refreshPlugins() { return this.refreshContent }
static get loadContent() { return this.loadPlugin }
static async loadPlugin(paths, configs, info, main, type) {
static async loadPlugin(paths, configs, info, main) {
const plugin = window.require(paths.mainPath)(Plugin, new PluginApi(info), Vendor);
const instance = new plugin({ configs, info, main, paths: { contentPath: paths.contentPath, dirName: paths.dirName, mainPath: paths.mainPath } });
return instance;

15
client/src/modules/settings.js
View File

@ -11,7 +11,9 @@
import defaultSettings from '../data/user.settings.default';
import Globals from './globals';
import CssEditor from './csseditor';
import Events from './events';
import { FileUtils, ClientLogger as Logger } from 'common';
import { SettingUpdatedEvent } from 'structs';
import path from 'path';
export default class {
@ -43,7 +45,7 @@ export default class {
}
CssEditor.updateScss(scss, true);
CssEditor.editor_bounds = css_editor_bounds;
CssEditor.editor_bounds = css_editor_bounds || {};
} catch (err) {
// There was an error loading settings
// This probably means that the user doesn't have any settings yet
@ -122,8 +124,9 @@ export default class {
if (setting.id !== setting_id) continue;
if (setting.value === value) return true;
let old_value = setting.value;
setting.value = value;
this.settingUpdated(set_id, category_id, setting_id, value);
this.settingUpdated(set_id, category_id, setting_id, value, old_value);
return true;
}
}
@ -132,8 +135,12 @@ export default class {
return false;
}
static settingUpdated(set_id, category_id, setting_id, value) {
Logger.log('Settings', `${set_id}/${category_id}/${setting_id} was set to ${value}`);
static settingUpdated(set_id, category_id, setting_id, value, old_value) {
Logger.log('Settings', `${set_id}/${category_id}/${setting_id} was changed from ${old_value} to ${value}`);
const event = new SettingUpdatedEvent({ set_id, category_id, setting_id, value, old_value });
Events.emit('setting-updated', event);
Events.emit(`setting-updated-${set_id}_{$category_id}_${setting_id}`, event);
}
static get getSettings() {

168
client/src/modules/theme.js Normal file
View File

@ -0,0 +1,168 @@
/**
* BetterDiscord Theme Module
* 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 ThemeManager from './thememanager';
import { EventEmitter } from 'events';
import { SettingUpdatedEvent, SettingsUpdatedEvent } from 'structs';
import { DOM, Modals } from 'ui';
import { FileUtils, ClientIPC } from 'common';
class ThemeEvents {
constructor(theme) {
this.theme = theme;
this.emitter = new EventEmitter();
}
on(eventname, callback) {
this.emitter.on(eventname, callback);
}
off(eventname, callback) {
this.emitter.removeListener(eventname, callback);
}
emit(...args) {
this.emitter.emit(...args);
}
}
export default class Theme {
constructor(themeInternals) {
this.__themeInternals = themeInternals;
this.hasSettings = this.themeConfig && this.themeConfig.length > 0;
this.saveSettings = this.saveSettings.bind(this);
this.enable = this.enable.bind(this);
this.disable = this.disable.bind(this);
}
get configs() { return this.__themeInternals.configs }
get info() { return this.__themeInternals.info }
get icon() { return this.info.icon }
get paths() { return this.__themeInternals.paths }
get main() { return this.__themeInternals.main }
get defaultConfig() { return this.configs.defaultConfig }
get userConfig() { return this.configs.userConfig }
get id() { return this.info.id || this.name.toLowerCase().replace(/[^a-zA-Z0-9-]/g, '-').replace(/\s+/g, '-') }
get name() { return this.info.name }
get authors() { return this.info.authors }
get version() { return this.info.version }
get themePath() { return this.paths.contentPath }
get dirName() { return this.paths.dirName }
get enabled() { return this.userConfig.enabled }
get config() { return this.userConfig.config || [] }
get themeConfig() { return this.config }
get css() { return this.userConfig.css }
get events() { return this.EventEmitter ? this.EventEmitter : (this.EventEmitter = new ThemeEvents(this)) }
showSettingsModal() {
return Modals.themeSettings(this);
}
async saveSettings(newSettings) {
const updatedSettings = [];
for (let newCategory of newSettings) {
const category = this.pluginConfig.find(c => c.category === newCategory.category);
for (let newSetting of newCategory.settings) {
const setting = category.settings.find(s => s.id === newSetting.id);
if (setting.value === newSetting.value) continue;
let old_value = setting.value;
setting.value = newSetting.value;
updatedSettings.push({ category_id: category.category, setting_id: setting.id, value: setting.value, old_value });
this.settingUpdated(category.category, setting.id, setting.value, old_value);
}
}
// As the theme's configuration has changed it needs recompiling
// When the compiled CSS has been save it will also save the configuration
await this.recompile();
return this.settingsUpdated(updatedSettings);
}
settingUpdated(category_id, setting_id, value, old_value) {
const event = new SettingUpdatedEvent({ category_id, setting_id, value, old_value });
this.events.emit('setting-updated', event);
this.events.emit(`setting-updated_{$category_id}_${setting_id}`, event);
}
settingsUpdated(updatedSettings) {
const event = new SettingsUpdatedEvent({ settings: updatedSettings.map(s => new SettingUpdatedEvent(s)) });
this.events.emit('settings-updated', event);
}
async saveConfiguration() {
try {
await FileUtils.writeFile(`${this.themePath}/user.config.json`, JSON.stringify({
enabled: this.enabled,
config: this.themeConfig.map(category => {
return {
category: category.category,
settings: category.settings.map(setting => {
return {
id: setting.id,
value: setting.value
};
})
};
}),
css: this.css
}));
} catch (err) {
throw err;
}
}
enable() {
if (!this.enabled) {
this.userConfig.enabled = true;
this.saveConfiguration();
}
DOM.injectTheme(this.css, this.id);
}
disable() {
this.userConfig.enabled = false;
this.saveConfiguration();
DOM.deleteTheme(this.id);
}
async compile() {
console.log('Compiling CSS');
let css = '';
if (this.info.type === 'sass') {
css = await ClientIPC.send('bd-compileSass', {
data: ThemeManager.getConfigAsSCSS(this.themeConfig),
path: this.paths.mainPath.replace(/\\/g, '/')
});
console.log(css);
} else {
css = await FileUtils.readFile(this.paths.mainPath);
}
return css;
}
async recompile() {
const css = await this.compile();
this.userConfig.css = css;
await this.saveConfiguration();
if (this.enabled) {
DOM.deleteTheme(this.id);
DOM.injectTheme(this.css, this.id);
}
}
}

122
client/src/modules/thememanager.js
View File

@ -9,126 +9,7 @@
*/
import ContentManager from './contentmanager';
import { DOM, Modals } from 'ui';
import { FileUtils, ClientIPC } from 'common';
class Theme {
constructor(themeInternals) {
this.__themeInternals = themeInternals;
this.hasSettings = this.themeConfig && this.themeConfig.length > 0;
this.saveSettings = this.saveSettings.bind(this);
this.enable = this.enable.bind(this);
this.disable = this.disable.bind(this);
}
get configs() { return this.__themeInternals.configs }
get info() { return this.__themeInternals.info }
get icon() { return this.info.icon }
get paths() { return this.__themeInternals.paths }
get main() { return this.__themeInternals.main }
get defaultConfig() { return this.configs.defaultConfig }
get userConfig() { return this.configs.userConfig }
get name() { return this.info.name }
get authors() { return this.info.authors }
get version() { return this.info.version }
get themePath() { return this.paths.contentPath }
get dirName() { return this.paths.dirName }
get enabled() { return this.userConfig.enabled }
get themeConfig() { return this.userConfig.config }
get css() { return this.userConfig.css }
get id() { return this.name.toLowerCase().replace(/\s+/g, '-') }
showSettingsModal() {
return Modals.themeSettings(this);
}
async saveSettings(newSettings) {
for (let category of newSettings) {
const oldCategory = this.themeConfig.find(c => c.category === category.category);
for (let setting of category.settings) {
const oldSetting = oldCategory.settings.find(s => s.id === setting.id);
if (oldSetting.value === setting.value) continue;
oldSetting.value = setting.value;
if (this.settingChanged) this.settingChanged(category.category, setting.id, setting.value);
}
}
// As the theme's configuration has changed it needs recompiling
// When the compiled CSS has been save it will also save the configuration
await this.recompile();
if (this.settingsChanged) this.settingsChanged(this.themeConfig);
return this.pluginConfig;
}
async saveConfiguration() {
try {
await FileUtils.writeFile(`${this.themePath}/user.config.json`, JSON.stringify({
enabled: this.enabled,
config: this.themeConfig.map(category => {
return {
category: category.category,
settings: category.settings.map(setting => {
return {
id: setting.id,
value: setting.value
};
})
};
}),
css: this.css
}));
} catch (err) {
throw err;
}
}
enable() {
if (!this.enabled) {
this.userConfig.enabled = true;
this.saveConfiguration();
}
DOM.injectTheme(this.css, this.id);
}
disable() {
this.userConfig.enabled = false;
this.saveConfiguration();
DOM.deleteTheme(this.id);
}
async compile() {
console.log('Compiling CSS');
let css = '';
if (this.info.type === 'sass') {
css = await ClientIPC.send('bd-compileSass', {
data: ThemeManager.getConfigAsSCSS(this.themeConfig),
path: this.paths.mainPath.replace(/\\/g, '/')
});
console.log(css);
} else {
css = await FileUtils.readFile(this.paths.mainPath);
}
return css;
}
async recompile() {
const css = await this.compile();
this.userConfig.css = css;
await this.saveConfiguration();
if (this.enabled) {
DOM.deleteTheme(this.id);
DOM.injectTheme(this.css, this.id);
}
}
}
import Theme from './theme';
export default class ThemeManager extends ContentManager {
@ -213,7 +94,6 @@ export default class ThemeManager extends ContentManager {
if (typeof value === 'string') {
return `$${name}: ${setting.scss_raw ? value : `'${setting.value.replace(/\\/g, '\\\\').replace(/'/g, '\\\'')}'`};`;
}
}
}

10
client/src/structs/error.js → client/src/structs/events/error.js
View File

@ -8,10 +8,12 @@
* LICENSE file in the root directory of this source tree.
*/
export class Error {
import Event from './event';
export default class ErrorEvent extends Event {
constructor(args) {
this.args = args;
super(args);
this.showStack = false; // For error modal
}
@ -31,8 +33,8 @@ export class Error {
return this.err.stack;
}
get _type() {
return 'err';
get __eventType() {
return 'error';
}
}

30
client/src/structs/events/event.js Normal file
View File

@ -0,0 +1,30 @@
/**
* BetterDiscord Base Event Struct
* 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.
*/
export default class Event {
constructor(args) {
this.__eventInfo = {
args: arguments,
type: this.__eventType
};
}
get event() {
return this.__eventInfo;
}
get args() {
return this.event.args[0];
}
get __eventType() { return null; }
}

3
client/src/structs/events/index.js Normal file
View File

@ -0,0 +1,3 @@
export { default as SettingUpdatedEvent } from './settingupdated';
export { default as SettingsUpdatedEvent } from './settingsupdated';
export { default as ErrorEvent } from './error';

23
client/src/structs/events/settingsupdated.js Normal file
View File

@ -0,0 +1,23 @@
/**
* BetterDiscord Settings Updated Event Struct
* 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 Event from './event';
export default class SettingsUpdatedEvent extends Event {
get updatedSettings() {
return this.args.updatedSettings;
}
get __eventType() {
return 'settings-updated';
}
}

39
client/src/structs/events/settingupdated.js Normal file
View File

@ -0,0 +1,39 @@
/**
* BetterDiscord Setting Updated Event Struct
* 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 Event from './event';
export default class SettingUpdatedEvent extends Event {
get set() {
return this.args.set_id;
}
get category() {
return this.args.category_id;
}
get setting() {
return this.args.setting_id;
}
get value() {
return this.args.value;
}
get old_value() {
return this.args.old_value;
}
get __eventType() {
return 'setting-updated';
}
}

2
client/src/structs/structs.js
View File

@ -1 +1 @@
export * from './error';
export * from './events/index';

2
client/src/ui/components/bd/modals/ErrorModal.vue
View File

@ -4,7 +4,7 @@
<MiError v-if="modal.event.type === 'err'" slot="icon" size="20"/>
<div slot="body">
<div v-for="(content, index) in modal.event.content">
<div v-if="content._type === 'err'" class="bd-modal-error" :class="{'bd-open': content.showStack}">
<div class="bd-modal-error" :class="{'bd-open': content.showStack}">
<div class="bd-modal-error-title bd-flex">
<span class="bd-modal-title-text bd-flex-grow">{{content.message}}</span>
<span class="bd-modal-titlelink" v-if="content.showStack" @click="() => { content.showStack = false; $forceUpdate(); }">Hide Stacktrace</span>

14
tests/plugins/Example/index.js
View File

@ -7,7 +7,19 @@ module.exports = (Plugin, Api, Vendor) => {
onStart() {
Events.subscribe('TEST_EVENT', this.eventTest);
Logger.log('onStart');
Logger.log(`Setting "default-0" value: ${this.getSetting('default-0')}`);
Logger.log(`Plugin setting "default-0" value: ${this.getSetting('default-0')}`);
this.events.on('setting-updated', event => {
console.log('Received plugin setting update:', event);
});
this.events.on('settings-updated', event => {
console.log('Received plugin settings update:', event);
});
Logger.log(`Internal setting "core/default/test-setting" value: ${Api.Settings.get('core', 'default', 'test-setting')}`);
Events.subscribe('setting-updated', event => {
console.log('Received internal setting update:', event);
});
const exampleModule = new (Api.import('Example Module'));
Logger.log(`2+4=${exampleModule.add(2, 4)}`);