config.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. module.exports = function(crowi) {
  2. var mongoose = require('mongoose')
  3. , debug = require('debug')('crowi:models:config')
  4. , uglifycss = require('uglifycss')
  5. , ObjectId = mongoose.Schema.Types.ObjectId
  6. , configSchema
  7. , Config
  8. , SECURITY_RESTRICT_GUEST_MODE_DENY = 'Deny'
  9. , SECURITY_RESTRICT_GUEST_MODE_READONLY = 'Readonly'
  10. , SECURITY_REGISTRATION_MODE_OPEN = 'Open'
  11. , SECURITY_REGISTRATION_MODE_RESTRICTED = 'Resricted'
  12. , SECURITY_REGISTRATION_MODE_CLOSED = 'Closed'
  13. ;
  14. configSchema = new mongoose.Schema({
  15. ns: { type: String, required: true, index: true },
  16. key: { type: String, required: true, index: true },
  17. value: { type: String, required: true }
  18. });
  19. /**
  20. * default values when crowi-plus installed
  21. */
  22. function getArrayForInstalling() {
  23. let config = getDefaultCrowiConfigs();
  24. // overwrite
  25. config['customize:behavior'] = 'crowi-plus';
  26. config['customize:layout'] = 'crowi-plus';
  27. return config;
  28. }
  29. /**
  30. * default values when migrated from Official Crowi
  31. */
  32. function getDefaultCrowiConfigs()
  33. {
  34. return {
  35. //'app:installed' : "0.0.0",
  36. 'app:title' : 'Crowi',
  37. 'app:confidential' : '',
  38. 'app:fileUpload' : false,
  39. 'security:restrictGuestMode' : 'Deny',
  40. 'security:registrationMode' : 'Open',
  41. 'security:registrationWhiteList' : [],
  42. 'aws:bucket' : 'crowi',
  43. 'aws:region' : 'ap-northeast-1',
  44. 'aws:accessKeyId' : '',
  45. 'aws:secretAccessKey' : '',
  46. 'mail:from' : '',
  47. 'mail:smtpHost' : '',
  48. 'mail:smtpPort' : '',
  49. 'mail:smtpUser' : '',
  50. 'mail:smtpPassword' : '',
  51. 'google:clientId' : '',
  52. 'google:clientSecret' : '',
  53. 'plugin:isEnabledPlugins' : true,
  54. 'customize:css' : '',
  55. 'customize:behavior' : 'crowi',
  56. 'customize:layout' : 'crowi',
  57. 'customize:isEnabledTimeline' : true,
  58. };
  59. }
  60. function getDefaultMarkdownConfigs() {
  61. return {
  62. 'markdown:isEnabledLinebreaks': true,
  63. 'markdown:isEnabledLinebreaksInComments': true,
  64. }
  65. }
  66. configSchema.statics.getRestrictGuestModeLabels = function()
  67. {
  68. var labels = {};
  69. labels[SECURITY_RESTRICT_GUEST_MODE_DENY] = 'アカウントを持たないユーザーはアクセス不可';
  70. labels[SECURITY_RESTRICT_GUEST_MODE_READONLY] = '閲覧のみ許可';
  71. return labels;
  72. };
  73. configSchema.statics.getRegistrationModeLabels = function()
  74. {
  75. var labels = {};
  76. labels[SECURITY_REGISTRATION_MODE_OPEN] = '公開 (だれでも登録可能)';
  77. labels[SECURITY_REGISTRATION_MODE_RESTRICTED] = '制限 (登録完了には管理者の承認が必要)';
  78. labels[SECURITY_REGISTRATION_MODE_CLOSED] = '非公開 (登録には管理者による招待が必要)';
  79. return labels;
  80. };
  81. configSchema.statics.updateConfigCache = function(ns, config)
  82. {
  83. var originalConfig = crowi.getConfig();
  84. var newNSConfig = originalConfig[ns] || {};
  85. Object.keys(config).forEach(function (key) {
  86. if (config[key] || config[key] === '' || config[key] === false) {
  87. newNSConfig[key] = config[key];
  88. }
  89. });
  90. originalConfig[ns] = newNSConfig;
  91. crowi.setConfig(originalConfig);
  92. // uglify and store
  93. Config.generateUglifiedCustomCss(originalConfig);
  94. };
  95. // Execute only once for installing application
  96. configSchema.statics.applicationInstall = function(callback)
  97. {
  98. var Config = this;
  99. Config.count({ ns: 'crowi' }, function (err, count) {
  100. if (count > 0) {
  101. return callback(new Error('Application already installed'), null);
  102. }
  103. Config.updateNamespaceByArray('crowi', getArrayForInstalling(), function(err, configs) {
  104. Config.updateConfigCache('crowi', configs);
  105. return callback(err, configs);
  106. });
  107. });
  108. };
  109. configSchema.statics.setupCofigFormData = function(ns, config)
  110. {
  111. var defaultConfig = {};
  112. // set Default Settings
  113. if (ns === 'crowi') {
  114. defaultConfig = getDefaultCrowiConfigs();
  115. }
  116. else if (ns === 'markdown') {
  117. defaultConfig = getDefaultMarkdownConfigs();
  118. }
  119. if (!defaultConfig[ns]) {
  120. defaultConfig[ns] = {};
  121. }
  122. Object.keys(config[ns] || {}).forEach(function (key) {
  123. if (config[ns][key] !== undefined) {
  124. defaultConfig[key] = config[ns][key];
  125. }
  126. });
  127. return defaultConfig;
  128. };
  129. configSchema.statics.updateNamespaceByArray = function(ns, configs, callback)
  130. {
  131. var Config = this;
  132. if (configs.length < 0) {
  133. return callback(new Error('Argument #1 is not array.'), null);
  134. }
  135. Object.keys(configs).forEach(function (key) {
  136. var value = configs[key];
  137. Config.findOneAndUpdate(
  138. { ns: ns, key: key },
  139. { ns: ns, key: key, value: JSON.stringify(value) },
  140. { upsert: true, },
  141. function (err, config) {
  142. debug('Config.findAndUpdate', err, config);
  143. });
  144. });
  145. return callback(null, configs);
  146. };
  147. configSchema.statics.findAndUpdate = function(ns, key, value, callback)
  148. {
  149. var Config = this;
  150. Config.findOneAndUpdate(
  151. { ns: ns, key: key },
  152. { ns: ns, key: key, value: JSON.stringify(value) },
  153. { upsert: true, },
  154. function (err, config) {
  155. debug('Config.findAndUpdate', err, config);
  156. callback(err, config);
  157. });
  158. };
  159. configSchema.statics.getConfig = function(callback)
  160. {
  161. };
  162. configSchema.statics.loadAllConfig = function(callback)
  163. {
  164. var Config = this
  165. , config = {};
  166. config.crowi = {}; // crowi namespace
  167. Config.find()
  168. .sort({ns: 1, key: 1})
  169. .exec(function(err, doc) {
  170. doc.forEach(function(el) {
  171. if (!config[el.ns]) {
  172. config[el.ns] = {};
  173. }
  174. config[el.ns][el.key] = JSON.parse(el.value);
  175. });
  176. debug('Config loaded', config);
  177. // uglify and store
  178. Config.generateUglifiedCustomCss(config);
  179. return callback(null, config);
  180. });
  181. };
  182. configSchema.statics.isUploadable = function(config)
  183. {
  184. var method = crowi.env.FILE_UPLOAD || 'aws';
  185. if (method == 'aws' && (
  186. !config.crowi['aws:accessKeyId'] ||
  187. !config.crowi['aws:secretAccessKey'] ||
  188. !config.crowi['aws:region'] ||
  189. !config.crowi['aws:bucket'])) {
  190. return false;
  191. }
  192. return method != 'none';
  193. };
  194. configSchema.statics.isGuesstAllowedToRead = function(config)
  195. {
  196. // return false if undefined
  197. if (undefined === config.crowi || undefined === config.crowi['security:restrictGuestMode']) {
  198. return false;
  199. }
  200. return SECURITY_RESTRICT_GUEST_MODE_READONLY === config.crowi['security:restrictGuestMode'];
  201. };
  202. configSchema.statics.isEnabledPlugins = function(config)
  203. {
  204. var defaultValue = getDefaultCrowiConfigs()['plugin:isEnabledPlugins'];
  205. // return defaultValue if undefined
  206. if (undefined === config.crowi || undefined === config.crowi['plugin:isEnabledPlugins']) {
  207. return defaultValue;
  208. }
  209. return config.crowi['plugin:isEnabledPlugins'];
  210. };
  211. configSchema.statics.isEnabledLinebreaks = function(config)
  212. {
  213. var defaultValue = getDefaultMarkdownConfigs()['markdown:isEnabledLinebreaks'];
  214. // return defaultValue if undefined
  215. if (undefined === config.markdown || undefined === config.markdown['markdown:isEnabledLinebreaks']) {
  216. return defaultValue;
  217. }
  218. return config.markdown['markdown:isEnabledLinebreaks'];
  219. };
  220. configSchema.statics.isEnabledLinebreaksInComments = function(config)
  221. {
  222. var defaultValue = getDefaultMarkdownConfigs()['markdown:isEnabledLinebreaksInComments'];
  223. // return defaultValue if undefined
  224. if (undefined === config.markdown || undefined === config.markdown['markdown:isEnabledLinebreaksInComments']) {
  225. return defaultValue;
  226. }
  227. return config.markdown['markdown:isEnabledLinebreaksInComments'];
  228. };
  229. /**
  230. * uglify store custom css strings
  231. */
  232. configSchema.statics.generateUglifiedCustomCss = function(config)
  233. {
  234. var rawCss = config.crowi['customize:css'] || getDefaultCrowiConfigs()['customize:css'];
  235. this.uglifiedCustomCss = uglifycss.processString(rawCss);
  236. }
  237. configSchema.statics.customCss = function(config)
  238. {
  239. return this.uglifiedCustomCss;
  240. }
  241. configSchema.statics.behaviorType = function(config)
  242. {
  243. return config.crowi['customize:behavior'] || 'crowi';
  244. }
  245. configSchema.statics.layoutType = function(config)
  246. {
  247. return config.crowi['customize:layout'] || 'crowi';
  248. }
  249. configSchema.statics.isEnabledTimeline = function(config)
  250. {
  251. var defaultValue = getDefaultCrowiConfigs()['customize:isEnabledTimeline'];
  252. // return defaultValue if undefined
  253. if (undefined === config.crowi || undefined === config.crowi['customize:isEnabledTimeline']) {
  254. return defaultValue;
  255. }
  256. return config.crowi['customize:isEnabledTimeline'];
  257. };
  258. configSchema.statics.fileUploadEnabled = function(config)
  259. {
  260. const Config = this;
  261. if (!Config.isUploadable(config)) {
  262. return false;
  263. }
  264. return config.crowi['app:fileUpload'] || false;
  265. };
  266. configSchema.statics.hasSlackConfig = function(config)
  267. {
  268. if (!config.notification) {
  269. return false;
  270. }
  271. if (!config.notification['slack:clientId'] ||
  272. !config.notification['slack:clientSecret']) {
  273. return false;
  274. }
  275. return true;
  276. };
  277. configSchema.statics.hasSlackToken = function(config)
  278. {
  279. if (!this.hasSlackConfig(config)) {
  280. return false;
  281. }
  282. if (!config.notification['slack:token']) {
  283. return false;
  284. }
  285. return true;
  286. };
  287. configSchema.statics.getLocalconfig = function(config)
  288. {
  289. const Config = this;
  290. const env = crowi.getEnv();
  291. const local_config = {
  292. crowi: {
  293. title: config.crowi['app:title'],
  294. url: config.crowi['app:url'] || '',
  295. },
  296. upload: {
  297. image: Config.isUploadable(config),
  298. file: Config.fileUploadEnabled(config),
  299. },
  300. behaviorType: Config.behaviorType(config),
  301. layoutType: Config.layoutType(config),
  302. env: {
  303. PLANTUML_URI: env.PLANTUML_URI || null,
  304. MATHJAX: env.MATHJAX || null,
  305. },
  306. };
  307. return local_config;
  308. }
  309. /*
  310. configSchema.statics.isInstalled = function(config)
  311. {
  312. if (!config.crowi) {
  313. return false;
  314. }
  315. if (config.crowi['app:installed']
  316. && config.crowi['app:installed'] !== '0.0.0') {
  317. return true;
  318. }
  319. return false;
  320. }
  321. */
  322. Config = mongoose.model('Config', configSchema);
  323. Config.SECURITY_REGISTRATION_MODE_OPEN = SECURITY_REGISTRATION_MODE_OPEN;
  324. Config.SECURITY_REGISTRATION_MODE_RESTRICTED = SECURITY_REGISTRATION_MODE_RESTRICTED;
  325. Config.SECURITY_REGISTRATION_MODE_CLOSED = SECURITY_REGISTRATION_MODE_CLOSED;
  326. return Config;
  327. };