index.js 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  1. 'use strict';
  2. var debug = require('debug')('crowi:crowi')
  3. , pkg = require('../../package.json')
  4. , path = require('path')
  5. , fs = require('fs')
  6. , sep = path.sep
  7. , mongoose = require('mongoose')
  8. , helpers = require('./helpers')
  9. , models = require('../models')
  10. ;
  11. function Crowi (rootdir, env)
  12. {
  13. var self = this;
  14. this.version = pkg.version;
  15. this.runtimeVersions = undefined; // initialized by scanRuntimeVersions()
  16. this.rootDir = rootdir;
  17. this.pluginDir = path.join(this.rootDir, 'node_modules') + sep;
  18. this.publicDir = path.join(this.rootDir, 'public') + sep;
  19. this.libDir = path.join(this.rootDir, 'lib') + sep;
  20. this.eventsDir = path.join(this.libDir, 'events') + sep;
  21. this.localeDir = path.join(this.rootDir, 'locales') + sep;
  22. this.resourceDir = path.join(this.rootDir, 'resource') + sep;
  23. this.viewsDir = path.join(this.libDir, 'views') + sep;
  24. this.mailDir = path.join(this.viewsDir, 'mail') + sep;
  25. this.tmpDir = path.join(this.rootDir, 'tmp') + sep;
  26. this.cacheDir = path.join(this.tmpDir, 'cache');
  27. this.config = {};
  28. this.searcher = null;
  29. this.mailer = {};
  30. this.interceptorManager = {};
  31. this.tokens = null;
  32. this.models = {};
  33. this.env = env;
  34. this.node_env = this.env.NODE_ENV || 'development';
  35. if (helpers.hasProcessFlag('prod') || helpers.hasProcessFlag('production')) {
  36. this.node_env = process.env.NODE_ENV = 'production';
  37. }
  38. this.port = this.env.PORT || 3000;
  39. this.events = {
  40. user: new (require(self.eventsDir + 'user'))(this),
  41. page: new (require(self.eventsDir + 'page'))(this),
  42. };
  43. if (this.node_env == 'development') {
  44. }
  45. };
  46. Crowi.prototype.init = function() {
  47. var self = this;
  48. return Promise.resolve()
  49. .then(function() {
  50. // setup database server and load all modesl
  51. return self.setupDatabase();
  52. }).then(function() {
  53. return self.setupModels();
  54. }).then(function() {
  55. return self.setupSessionConfig();
  56. }).then(function() {
  57. return new Promise(function(resolve, reject) {
  58. self.model('Config', require('../models/config')(self));
  59. var Config = self.model('Config');
  60. Config.loadAllConfig(function(err, doc) {
  61. if (err) {
  62. return reject();
  63. }
  64. self.setConfig(doc);
  65. return resolve();
  66. });
  67. });
  68. }).then(function() {
  69. return self.scanRuntimeVersions();
  70. }).then(function() {
  71. return self.setupSearcher();
  72. }).then(function() {
  73. return self.setupMailer();
  74. }).then(function() {
  75. return self.setupInterceptorManager();
  76. }).then(function() {
  77. return self.setupSlack();
  78. }).then(function() {
  79. return self.setupCsrf();
  80. });
  81. }
  82. Crowi.prototype.isPageId = function(pageId) {
  83. if (!pageId) {
  84. return false;
  85. }
  86. if (typeof pageId === 'string' && pageId.match(/^[\da-f]{24}$/)) {
  87. return true;
  88. }
  89. return false;
  90. };
  91. Crowi.prototype.setConfig = function(config) {
  92. this.config = config;
  93. };
  94. Crowi.prototype.getConfig = function() {
  95. return this.config;
  96. };
  97. // getter/setter of model instance
  98. //
  99. Crowi.prototype.model = function(name, model) {
  100. if (model) {
  101. return this.models[name] = model;
  102. }
  103. return this.models[name];
  104. };
  105. // getter/setter of event instance
  106. Crowi.prototype.event = function(name, event) {
  107. if (event) {
  108. return this.events[name] = event;
  109. }
  110. return this.events[name];
  111. };
  112. Crowi.prototype.setupDatabase = function() {
  113. // mongoUri = mongodb://user:password@host/dbname
  114. mongoose.Promise = global.Promise;
  115. var mongoUri = this.env.MONGOLAB_URI || // for B.C.
  116. this.env.MONGODB_URI || // MONGOLAB changes their env name
  117. this.env.MONGOHQ_URL ||
  118. this.env.MONGO_URI ||
  119. ((process.env.NODE_ENV === 'test') ? 'mongodb://localhost/crowi_test' : 'mongodb://localhost/crowi')
  120. ;
  121. return new Promise(function(resolve, reject) {
  122. mongoose.connect(mongoUri, function(e) {
  123. if (e) {
  124. debug('DB Connect Error: ', e);
  125. debug('DB Connect Error: ', mongoUri);
  126. return reject(new Error('Cann\'t connect to Database Server.'));
  127. }
  128. return resolve();
  129. });
  130. });
  131. };
  132. Crowi.prototype.setupSessionConfig = function() {
  133. var self = this
  134. , session = require('express-session')
  135. , sessionConfig
  136. , sessionAge = (1000*3600*24*30)
  137. , redisUrl = this.env.REDISTOGO_URL || this.env.REDIS_URL || null
  138. , RedisStore
  139. ;
  140. return new Promise(function(resolve, reject) {
  141. sessionConfig = {
  142. rolling: true,
  143. secret: self.env.SECRET_TOKEN || 'this is default session secret',
  144. resave: false,
  145. saveUninitialized: true,
  146. cookie: {
  147. maxAge: sessionAge,
  148. },
  149. };
  150. if (redisUrl) {
  151. var ru = require('url').parse(redisUrl);
  152. var redis = require('redis');
  153. var redisClient = redis.createClient(ru.port, ru.hostname);
  154. if (ru.auth) {
  155. redisClient.auth(ru.auth.split(':')[1]);
  156. }
  157. RedisStore = require('connect-redis')(session);
  158. sessionConfig.store = new RedisStore({
  159. prefix: 'crowi:sess:',
  160. client: redisClient,
  161. });
  162. }
  163. self.sessionConfig = sessionConfig;
  164. resolve();
  165. });
  166. };
  167. Crowi.prototype.setupModels = function() {
  168. var self = this
  169. ;
  170. return new Promise(function(resolve, reject) {
  171. Object.keys(models).forEach(function(key) {
  172. self.model(key, models[key](self));
  173. });
  174. resolve();
  175. });
  176. };
  177. Crowi.prototype.getIo = function() {
  178. return this.io;
  179. };
  180. Crowi.prototype.scanRuntimeVersions = function() {
  181. var self = this
  182. , check = require('check-node-version')
  183. ;
  184. return new Promise((resolve, reject) => {
  185. check((err, result) => {
  186. if (err) {
  187. reject();
  188. }
  189. self.runtimeVersions = result;
  190. resolve();
  191. })
  192. });
  193. }
  194. Crowi.prototype.getSearcher = function() {
  195. return this.searcher;
  196. };
  197. Crowi.prototype.getMailer = function() {
  198. return this.mailer;
  199. };
  200. Crowi.prototype.getInterceptorManager = function() {
  201. return this.interceptorManager;
  202. }
  203. Crowi.prototype.setupSearcher = function() {
  204. var self = this;
  205. var searcherUri = this.env.ELASTICSEARCH_URI
  206. || this.env.BONSAI_URL
  207. || null
  208. ;
  209. return new Promise(function(resolve, reject) {
  210. if (searcherUri) {
  211. try {
  212. self.searcher = new (require(path.join(self.libDir, 'util', 'search')))(self, searcherUri);
  213. } catch (e) {
  214. debug('Error on setup searcher', e);
  215. self.searcher = null;
  216. }
  217. }
  218. resolve();
  219. });
  220. };
  221. Crowi.prototype.setupMailer = function() {
  222. var self = this;
  223. return new Promise(function(resolve, reject) {
  224. self.mailer = require('../util/mailer')(self);
  225. resolve();
  226. });
  227. };
  228. Crowi.prototype.setupInterceptorManager = function() {
  229. var self = this;
  230. return new Promise(function(resolve, reject) {
  231. const InterceptorManager = require('../util/interceptor-manager');
  232. self.interceptorManager = new InterceptorManager();
  233. resolve();
  234. });
  235. };
  236. Crowi.prototype.setupSlack = function() {
  237. var self = this;
  238. var config = this.getConfig();
  239. var Config = this.model('Config');
  240. return new Promise(function(resolve, reject) {
  241. if (!Config.hasSlackConfig(config)) {
  242. self.slack = {};
  243. } else {
  244. self.slack = require('../util/slack')(self);
  245. }
  246. resolve();
  247. });
  248. };
  249. Crowi.prototype.setupCsrf = function() {
  250. var Tokens = require('csrf');
  251. var tokens = this.tokens = new Tokens();
  252. return Promise.resolve();
  253. };
  254. Crowi.prototype.getTokens = function() {
  255. return this.tokens;
  256. };
  257. Crowi.prototype.start = function() {
  258. var self = this
  259. , http = require('http')
  260. , server
  261. , io;
  262. // init CrowiDev
  263. if (self.node_env === 'development') {
  264. const CrowiDev = require('./dev');
  265. this.crowiDev = new CrowiDev(self);
  266. this.crowiDev.init();
  267. }
  268. return Promise.resolve()
  269. .then(function() {
  270. return self.init()
  271. })
  272. .then(function() {
  273. return self.buildServer();
  274. })
  275. .then(function(app) {
  276. server = http.createServer(app).listen(self.port, function() {
  277. console.log(`[${self.node_env}] Express server listening on port ${self.port}`);
  278. });
  279. // setup
  280. if (self.node_env === 'development') {
  281. self.crowiDev.setup(server, app);
  282. }
  283. io = require('socket.io')(server);
  284. io.sockets.on('connection', function (socket) {
  285. });
  286. self.io = io;
  287. // setup Express Routes
  288. self.setupRoutesAtLast(app);
  289. return app;
  290. });
  291. };
  292. Crowi.prototype.buildServer = function() {
  293. var express = require('express')
  294. , errorHandler = require('errorhandler')
  295. , morgan = require('morgan')
  296. , app = express()
  297. , env = this.node_env
  298. ;
  299. require('./express-init')(this, app);
  300. // import plugins
  301. var Config = this.model('Config');
  302. var isEnabledPlugins = Config.isEnabledPlugins(this.config);
  303. if (isEnabledPlugins) {
  304. debug('plugins enabled');
  305. var PluginService = require('../plugins/plugin.service');
  306. var pluginService = new PluginService(this, app);
  307. pluginService.autoDetectAndLoadPlugins();
  308. if (env == 'development') {
  309. this.crowiDev.loadPlugins(app);
  310. }
  311. }
  312. if (env == 'development') {
  313. //swig.setDefaults({ cache: false });
  314. app.use(errorHandler({ dumpExceptions: true, showStack: true }));
  315. app.use(morgan('dev'));
  316. }
  317. if (env == 'production') {
  318. var oneYear = 31557600000;
  319. app.use(morgan('combined'));
  320. app.use(function (err, req, res, next) {
  321. res.status(500);
  322. res.render('500', { error: err });
  323. });
  324. }
  325. return Promise.resolve(app);
  326. };
  327. /**
  328. * setup Express Routes
  329. * !! this must be at last because it includes '/*' route !!
  330. */
  331. Crowi.prototype.setupRoutesAtLast = function(app) {
  332. require('../routes')(this, app);
  333. }
  334. /**
  335. * require API for plugins
  336. *
  337. * @param {string} modulePath relative path from /lib/crowi/index.js
  338. * @return {module}
  339. *
  340. * @memberof Crowi
  341. */
  342. Crowi.prototype.require = function(modulePath) {
  343. return require(modulePath);
  344. }
  345. Crowi.prototype.exitOnError = function(err) {
  346. debug('Critical error occured.');
  347. console.error(err);
  348. console.error(err.stack);
  349. process.exit(1);
  350. };
  351. module.exports = Crowi;