aboutsummaryrefslogtreecommitdiffstats
path: root/server/managers/imports-manager.js
blob: d8b2144ff6bd5974d30111a58920f03888cb6976 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
  * Import managment base, used to load commands/protocol and configuration objects
  *
  * Version: v2.0.0
  * Developer: Marzavec ( https://github.com/marzavec )
  * License: WTFPL ( http://www.wtfpl.net/txt/copying/ )
  *
  */

const read = require('readdir-recursive');
const path = require('path');

class ImportsManager {
  /**
    * Create a `ImportsManager` instance for (re)loading classes and config
    *
    * @param {Object} core reference to the global core object
    * @param {String} base executing directory name; __dirname
    */
  constructor (core, base) {
    this._core = core;
    this._base = base;

    this._imports = {};
    this._optionalConfigs = {};
  }

  /**
    * Pull core reference
    *
    * @type {Object} readonly
    */
  get core () {
    return this._core;
  }

  /**
    * Pull base path that all imports are required in from
    *
    * @type {String} readonly
    */
  get base () {
    return this._base;
  }

  /**
    * Pull optional (none-core) config options
    *
    * @type {Object}
    */
  get optionalConfigs () {
    return Object.assign({}, this._optionalConfigs);
  }

  /**
    * Initialize this class and start loading target directories
    *
    */
  init () {
    let errorText = '';
    ImportsManager.load_dirs.forEach(dir => {
      errorText += this.loadDir(dir);
    });

    return errorText;
  }

  /**
    * Gather all js files from target directory, then verify and load
    *
    * @param {String} dirName The name of the dir to load, relative to the _base path.
    */
  loadDir (dirName) {
    const dir = path.resolve(this._base, dirName);

    let errorText = '';
    try {
      read.fileSync(dir).forEach(file => {
        const basename = path.basename(file);
        if (basename.startsWith('_') || !basename.endsWith('.js')) return;

        let imported;
        try {
          imported = require(file);
        } catch (e) {
          let err = `Unable to load modules from ${dirName} (${path.relative(dir, file)})\n${e}`;
          errorText += err;
          console.error(err);
          return errorText;
        }

        if (imported.configs) {
          imported.configs.forEach(config => {
            this._optionalConfigs[config.name] = config;
          });
        }

        if (!this._imports[dirName]) {
          this._imports[dirName] = {};
        }

        this._imports[dirName][file] = imported;
      });
    } catch (e) {
      let err = `Unable to load modules from ${dirName}\n${e}`;
      errorText += err;
      console.error(err);
      return errorText;
    }

    return errorText;
  }

  /**
    * Unlink references to each loaded module, pray to google that gc knows it's job,
    * then reinitialize this class to start the reload
    *
    * @param {String} dirName The name of the dir to load, relative to the _base path.
    */
  reloadDirCache (dirName) {
    Object.keys(this._imports[dirName]).forEach((mod) => {
      delete require.cache[require.resolve(mod)];
    });

    return this.init();
  }

  /**
    * Pull reference to imported modules that were imported from dirName, or
    * load required directory if not found
    *
    * @param {String} dirName The name of the dir to load, relative to the _base path.
    */
  getImport (dirName) {
    let imported = this._imports[dirName];

    if (!imported) {
      this.loadDir(dirName);
    }

    return Object.assign({}, this._imports[dirName]);
  }
}

// automagically loaded directorys on instantiation
ImportsManager.load_dirs = ['src/commands'];

module.exports = ImportsManager;