supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Only use helpers and not shared variables around path helpers

Browse Source 
This refactor has a few benefits, for example there cannot be a rogue update of `Helper.CONFIG_PATH` or something.
This commit is contained in:
Jérémie Astori 2017-12-06 22:54:54 -05:00
parent f9be519c2f
commit 0482747781
No known key found for this signature in database
GPG Key ID: B9A4F245CD67BDE8
12 changed files with 72 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/clientManager.js
View File

@ -43,7 +43,7 @@ ClientManager.prototype.autoloadUsers = function() {
users.forEach((name) => this.loadUser(name));
fs.watch(Helper.USERS_PATH, _.debounce(() => {
fs.watch(Helper.getUsersPath(), _.debounce(() => {
const loaded = this.clients.map((c) => c.name);
const updatedUsers = this.getUsers();
@ -96,7 +96,7 @@ ClientManager.prototype.loadUser = function(name) {
ClientManager.prototype.getUsers = function() {
return fs
.readdirSync(Helper.USERS_PATH)
.readdirSync(Helper.getUsersPath())
.filter((file) => file.endsWith(".json"))
.map((file) => file.slice(0, -5));
};

4
src/command-line/add.js
View File

@ -11,8 +11,8 @@ program
.description("Add a new user")
.on("--help", Utils.extraHelp)
.action(function(name) {
if (!fs.existsSync(Helper.USERS_PATH)) {
log.error(`${Helper.USERS_PATH} does not exist.`);
if (!fs.existsSync(Helper.getUsersPath())) {
log.error(`${Helper.getUsersPath()} does not exist.`);
return;
}

10
src/command-line/config.js
View File

@ -9,20 +9,20 @@ const Utils = require("./utils");
program
.command("config")
.description(`Edit configuration file located at ${colors.green(Helper.CONFIG_PATH)}.`)
.description(`Edit configuration file located at ${colors.green(Helper.getConfigPath())}.`)
.on("--help", Utils.extraHelp)
.action(function() {
if (!fs.existsSync(Helper.CONFIG_PATH)) {
log.error(`${Helper.CONFIG_PATH} does not exist.`);
if (!fs.existsSync(Helper.getConfigPath())) {
log.error(`${Helper.getConfigPath()} does not exist.`);
return;
}
var child_spawn = child.spawn(
process.env.EDITOR || "vi",
[Helper.CONFIG_PATH],
[Helper.getConfigPath()],
{stdio: "inherit"}
);
child_spawn.on("error", function() {
log.error(`Unable to open ${colors.green(Helper.CONFIG_PATH)}. ${colors.bold("$EDITOR")} is not set, and ${colors.bold("vi")} was not found.`);
log.error(`Unable to open ${colors.green(Helper.getConfigPath())}. ${colors.bold("$EDITOR")} is not set, and ${colors.bold("vi")} was not found.`);
});
});

4
src/command-line/edit.js
View File

@ -12,8 +12,8 @@ program
.description(`Edit user file located at ${colors.green(Helper.getUserConfigPath("<name>"))}.`)
.on("--help", Utils.extraHelp)
.action(function(name) {
if (!fs.existsSync(Helper.USERS_PATH)) {
log.error(`${Helper.USERS_PATH} does not exist.`);
if (!fs.existsSync(Helper.getUsersPath())) {
log.error(`${Helper.getUsersPath()} does not exist.`);
return;
}

4
src/command-line/install.js
View File

@ -16,8 +16,8 @@ program
const child = require("child_process");
const packageJson = require("package-json");
if (!fs.existsSync(Helper.CONFIG_PATH)) {
log.error(`${Helper.CONFIG_PATH} does not exist.`);
if (!fs.existsSync(Helper.getConfigPath())) {
log.error(`${Helper.getConfigPath()} does not exist.`);
return;
}

4
src/command-line/list.js
View File

@ -11,8 +11,8 @@ program
.description("List all users")
.on("--help", Utils.extraHelp)
.action(function() {
if (!fs.existsSync(Helper.USERS_PATH)) {
log.error(`${Helper.USERS_PATH} does not exist.`);
if (!fs.existsSync(Helper.getUsersPath())) {
log.error(`${Helper.getUsersPath()} does not exist.`);
return;
}

4
src/command-line/remove.js
View File

@ -11,8 +11,8 @@ program
.description("Remove an existing user")
.on("--help", Utils.extraHelp)
.action(function(name) {
if (!fs.existsSync(Helper.USERS_PATH)) {
log.error(`${Helper.USERS_PATH} does not exist.`);
if (!fs.existsSync(Helper.getUsersPath())) {
log.error(`${Helper.getUsersPath()} does not exist.`);
return;
}

4
src/command-line/reset.js
View File

@ -11,8 +11,8 @@ program
.description("Reset user password")
.on("--help", Utils.extraHelp)
.action(function(name) {
if (!fs.existsSync(Helper.USERS_PATH)) {
log.error(`${Helper.USERS_PATH} does not exist.`);
if (!fs.existsSync(Helper.getUsersPath())) {
log.error(`${Helper.getUsersPath()} does not exist.`);
return;
}

12
src/command-line/start.js
View File

@ -38,18 +38,18 @@ program
});
function initalizeConfig() {
if (!fs.existsSync(Helper.CONFIG_PATH)) {
fsextra.ensureDirSync(Helper.HOME);
fs.chmodSync(Helper.HOME, "0700");
if (!fs.existsSync(Helper.getConfigPath())) {
fsextra.ensureDirSync(Helper.getHomePath());
fs.chmodSync(Helper.getHomePath(), "0700");
fsextra.copySync(path.resolve(path.join(
__dirname,
"..",
"..",
"defaults",
"config.js"
)), Helper.CONFIG_PATH);
log.info(`Configuration file created at ${colors.green(Helper.CONFIG_PATH)}.`);
)), Helper.getConfigPath());
log.info(`Configuration file created at ${colors.green(Helper.getConfigPath())}.`);
}
fsextra.ensureDirSync(Helper.USERS_PATH);
fsextra.ensureDirSync(Helper.getUsersPath());
}

67
src/helper.js
View File

@ -9,18 +9,27 @@ var net = require("net");
var bcrypt = require("bcryptjs");
const colors = require("colors/safe");
var Helper = {
let homePath;
let configPath;
let usersPath;
let storagePath;
let packagesPath;
const Helper = {
config: null,
expandHome: expandHome,
getPackagesPath: getPackagesPath,
getPackageModulePath: getPackageModulePath,
getStoragePath: getStoragePath,
getUserConfigPath: getUserConfigPath,
getUserLogsPath: getUserLogsPath,
setHome: setHome,
getVersion: getVersion,
getGitCommit: getGitCommit,
ip2hex: ip2hex,
expandHome,
getHomePath,
getPackagesPath,
getPackageModulePath,
getStoragePath,
getConfigPath,
getUsersPath,
getUserConfigPath,
getUserLogsPath,
setHome,
getVersion,
getGitCommit,
ip2hex,
password: {
hash: passwordHash,
@ -61,14 +70,16 @@ function getGitCommit() {
}
}
function setHome(homePath) {
this.HOME = expandHome(homePath);
this.CONFIG_PATH = path.join(this.HOME, "config.js");
this.USERS_PATH = path.join(this.HOME, "users");
function setHome(newPath) {
homePath = expandHome(newPath);
configPath = path.join(homePath, "config.js");
usersPath = path.join(homePath, "users");
storagePath = path.join(homePath, "storage");
packagesPath = path.join(homePath, "packages", "node_modules");
// Reload config from new home location
if (fs.existsSync(this.CONFIG_PATH)) {
var userConfig = require(this.CONFIG_PATH);
if (fs.existsSync(configPath)) {
var userConfig = require(configPath);
this.config = _.merge(this.config, userConfig);
}
@ -91,26 +102,38 @@ function setHome(homePath) {
// TODO: Remove in future release
// Backwards compatibility for old way of specifying themes in settings
if (this.config.theme.includes(".css")) {
log.warn(`Referring to CSS files in the ${colors.green("theme")} setting of ${colors.green(Helper.CONFIG_PATH)} is ${colors.bold("deprecated")} and will be removed in a future version.`);
log.warn(`Referring to CSS files in the ${colors.green("theme")} setting of ${colors.green(configPath)} is ${colors.bold("deprecated")} and will be removed in a future version.`);
} else {
this.config.theme = `themes/${this.config.theme}.css`;
}
}
function getHomePath() {
return homePath;
}
function getConfigPath() {
return configPath;
}
function getUsersPath() {
return usersPath;
}
function getUserConfigPath(name) {
return path.join(this.USERS_PATH, name + ".json");
return path.join(usersPath, name + ".json");
}
function getUserLogsPath(name, network) {
return path.join(this.HOME, "logs", name, network);
return path.join(homePath, "logs", name, network);
}
function getStoragePath() {
return path.join(this.HOME, "storage");
return storagePath;
}
function getPackagesPath() {
return path.join(this.HOME, "packages", "node_modules");
return packagesPath;
}
function getPackageModulePath(packageName) {

2
src/plugins/webpush.js
View File

@ -8,7 +8,7 @@ const Helper = require("../helper");
class WebPush {
constructor() {
const vapidPath = path.join(Helper.HOME, "vapid.json");
const vapidPath = path.join(Helper.getHomePath(), "vapid.json");
if (fs.existsSync(vapidPath)) {
const data = fs.readFileSync(vapidPath, "utf-8");

2
src/server.js
View File

@ -30,7 +30,7 @@ var manager = null;
module.exports = function() {
log.info(`The Lounge ${colors.green(Helper.getVersion())} \
(Node.js ${colors.green(process.versions.node)} on ${colors.green(process.platform)} ${process.arch})`);
log.info(`Configuration file: ${colors.green(Helper.CONFIG_PATH)}`);
log.info(`Configuration file: ${colors.green(Helper.getConfigPath())}`);
var app = express()
.disable("x-powered-by")