config.js 10 KB

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