page.js 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243
  1. module.exports = function(crowi) {
  2. var debug = require('debug')('growi:models:page')
  3. , mongoose = require('mongoose')
  4. , escapeStringRegexp = require('escape-string-regexp')
  5. , ObjectId = mongoose.Schema.Types.ObjectId
  6. , GRANT_PUBLIC = 1
  7. , GRANT_RESTRICTED = 2
  8. , GRANT_SPECIFIED = 3
  9. , GRANT_OWNER = 4
  10. , GRANT_USER_GROUP = 5
  11. , PAGE_GRANT_ERROR = 1
  12. , STATUS_WIP = 'wip'
  13. , STATUS_PUBLISHED = 'published'
  14. , STATUS_DELETED = 'deleted'
  15. , STATUS_DEPRECATED = 'deprecated'
  16. , pageEvent = crowi.event('page')
  17. , pageSchema
  18. , Comment = crowi.model('Comment');
  19. function isPortalPath(path) {
  20. if (path.match(/.*\/$/)) {
  21. return true;
  22. }
  23. return false;
  24. }
  25. pageSchema = new mongoose.Schema({
  26. path: { type: String, required: true, index: true, unique: true },
  27. revision: { type: ObjectId, ref: 'Revision' },
  28. redirectTo: { type: String, index: true },
  29. status: { type: String, default: STATUS_PUBLISHED, index: true },
  30. grant: { type: Number, default: GRANT_PUBLIC, index: true },
  31. grantedUsers: [{ type: ObjectId, ref: 'User' }],
  32. creator: { type: ObjectId, ref: 'User', index: true },
  33. // lastUpdateUser: this schema is from 1.5.x (by deletion feature), and null is default.
  34. // the last update user on the screen is by revesion.author for B.C.
  35. lastUpdateUser: { type: ObjectId, ref: 'User', index: true },
  36. liker: [{ type: ObjectId, ref: 'User', index: true }],
  37. seenUsers: [{ type: ObjectId, ref: 'User', index: true }],
  38. commentCount: { type: Number, default: 0 },
  39. extended: {
  40. type: String,
  41. default: '{}',
  42. get: function(data) {
  43. try {
  44. return JSON.parse(data);
  45. }
  46. catch (e) {
  47. return data;
  48. }
  49. },
  50. set: function(data) {
  51. return JSON.stringify(data);
  52. }
  53. },
  54. createdAt: { type: Date, default: Date.now },
  55. updatedAt: Date
  56. }, {
  57. toJSON: {getters: true},
  58. toObject: {getters: true}
  59. });
  60. pageEvent.on('create', pageEvent.onCreate);
  61. pageEvent.on('update', pageEvent.onUpdate);
  62. pageSchema.methods.isWIP = function() {
  63. return this.status === STATUS_WIP;
  64. };
  65. pageSchema.methods.isPublished = function() {
  66. // null: this is for B.C.
  67. return this.status === null || this.status === STATUS_PUBLISHED;
  68. };
  69. pageSchema.methods.isDeleted = function() {
  70. return this.status === STATUS_DELETED;
  71. };
  72. pageSchema.methods.isDeprecated = function() {
  73. return this.status === STATUS_DEPRECATED;
  74. };
  75. pageSchema.methods.isPublic = function() {
  76. if (!this.grant || this.grant == GRANT_PUBLIC) {
  77. return true;
  78. }
  79. return false;
  80. };
  81. pageSchema.methods.isPortal = function() {
  82. return isPortalPath(this.path);
  83. };
  84. pageSchema.methods.isCreator = function(userData) {
  85. // ゲスト閲覧の場合は userData に false が入る
  86. if (!userData) {
  87. return false;
  88. }
  89. if (this.populated('creator') && this.creator._id.toString() === userData._id.toString()) {
  90. return true;
  91. }
  92. else if (this.creator.toString() === userData._id.toString()) {
  93. return true;
  94. }
  95. return false;
  96. };
  97. pageSchema.methods.isGrantedFor = function(userData) {
  98. if (this.isPublic() || this.isCreator(userData)) {
  99. return true;
  100. }
  101. if (this.grantedUsers.indexOf(userData._id) >= 0) {
  102. return true;
  103. }
  104. return false;
  105. };
  106. pageSchema.methods.isLatestRevision = function() {
  107. // populate されていなくて判断できない
  108. if (!this.latestRevision || !this.revision) {
  109. return true;
  110. }
  111. return (this.latestRevision == this.revision._id.toString());
  112. };
  113. pageSchema.methods.isUpdatable = function(previousRevision) {
  114. var revision = this.latestRevision || this.revision;
  115. if (revision != previousRevision) {
  116. return false;
  117. }
  118. return true;
  119. };
  120. pageSchema.methods.isLiked = function(userData) {
  121. return this.liker.some(function(likedUser) {
  122. return likedUser == userData._id.toString();
  123. });
  124. };
  125. pageSchema.methods.like = function(userData) {
  126. var self = this,
  127. Page = self;
  128. return new Promise(function(resolve, reject) {
  129. var added = self.liker.addToSet(userData._id);
  130. if (added.length > 0) {
  131. self.save(function(err, data) {
  132. if (err) {
  133. return reject(err);
  134. }
  135. debug('liker updated!', added);
  136. return resolve(data);
  137. });
  138. }
  139. else {
  140. debug('liker not updated');
  141. return reject(self);
  142. }
  143. });
  144. };
  145. pageSchema.methods.unlike = function(userData, callback) {
  146. var self = this,
  147. Page = self;
  148. return new Promise(function(resolve, reject) {
  149. var beforeCount = self.liker.length;
  150. self.liker.pull(userData._id);
  151. if (self.liker.length != beforeCount) {
  152. self.save(function(err, data) {
  153. if (err) {
  154. return reject(err);
  155. }
  156. return resolve(data);
  157. });
  158. }
  159. else {
  160. debug('liker not updated');
  161. return reject(self);
  162. }
  163. });
  164. };
  165. pageSchema.methods.isSeenUser = function(userData) {
  166. var self = this,
  167. Page = self;
  168. return this.seenUsers.some(function(seenUser) {
  169. return seenUser.equals(userData._id);
  170. });
  171. };
  172. pageSchema.methods.seen = function(userData) {
  173. var self = this,
  174. Page = self;
  175. if (this.isSeenUser(userData)) {
  176. debug('seenUsers not updated');
  177. return Promise.resolve(this);
  178. }
  179. return new Promise(function(resolve, reject) {
  180. if (!userData || !userData._id) {
  181. reject(new Error('User data is not valid'));
  182. }
  183. var added = self.seenUsers.addToSet(userData);
  184. self.save(function(err, data) {
  185. if (err) {
  186. return reject(err);
  187. }
  188. debug('seenUsers updated!', added);
  189. return resolve(self);
  190. });
  191. });
  192. };
  193. pageSchema.methods.getSlackChannel = function() {
  194. var extended = this.get('extended');
  195. if (!extended) {
  196. return '';
  197. }
  198. return extended.slack || '';
  199. };
  200. pageSchema.methods.updateSlackChannel = function(slackChannel) {
  201. var extended = this.extended;
  202. extended.slack = slackChannel;
  203. return this.updateExtended(extended);
  204. };
  205. pageSchema.methods.updateExtended = function(extended) {
  206. var page = this;
  207. page.extended = extended;
  208. return new Promise(function(resolve, reject) {
  209. return page.save(function(err, doc) {
  210. if (err) {
  211. return reject(err);
  212. }
  213. return resolve(doc);
  214. });
  215. });
  216. };
  217. pageSchema.statics.populatePageData = function(pageData, revisionId) {
  218. var Page = crowi.model('Page');
  219. var User = crowi.model('User');
  220. pageData.latestRevision = pageData.revision;
  221. if (revisionId) {
  222. pageData.revision = revisionId;
  223. }
  224. pageData.likerCount = pageData.liker.length || 0;
  225. pageData.seenUsersCount = pageData.seenUsers.length || 0;
  226. return new Promise(function(resolve, reject) {
  227. pageData.populate([
  228. {path: 'lastUpdateUser', model: 'User', select: User.USER_PUBLIC_FIELDS},
  229. {path: 'creator', model: 'User', select: User.USER_PUBLIC_FIELDS},
  230. {path: 'revision', model: 'Revision'},
  231. //{path: 'liker', options: { limit: 11 }},
  232. //{path: 'seenUsers', options: { limit: 11 }},
  233. ], function(err, pageData) {
  234. Page.populate(pageData, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS}, function(err, data) {
  235. if (err) {
  236. return reject(err);
  237. }
  238. return resolve(data);
  239. });
  240. });
  241. });
  242. };
  243. pageSchema.statics.populatePageListToAnyObjects = function(pageIdObjectArray) {
  244. var Page = this;
  245. var pageIdMappings = {};
  246. var pageIds = pageIdObjectArray.map(function(page, idx) {
  247. if (!page._id) {
  248. throw new Error('Pass the arg of populatePageListToAnyObjects() must have _id on each element.');
  249. }
  250. pageIdMappings[String(page._id)] = idx;
  251. return page._id;
  252. });
  253. return new Promise(function(resolve, reject) {
  254. Page.findListByPageIds(pageIds, {limit: 100}) // limit => if the pagIds is greater than 100, ignore
  255. .then(function(pages) {
  256. pages.forEach(function(page) {
  257. Object.assign(pageIdObjectArray[pageIdMappings[String(page._id)]], page._doc);
  258. });
  259. resolve(pageIdObjectArray);
  260. });
  261. });
  262. };
  263. pageSchema.statics.updateCommentCount = function(pageId) {
  264. var self = this;
  265. var Comment = crowi.model('Comment');
  266. return Comment.countCommentByPageId(pageId)
  267. .then(function(count) {
  268. self.update({_id: pageId}, {commentCount: count}, {}, function(err, data) {
  269. if (err) {
  270. debug('Update commentCount Error', err);
  271. throw err;
  272. }
  273. return data;
  274. });
  275. });
  276. };
  277. pageSchema.statics.hasPortalPage = function(path, user, revisionId) {
  278. var self = this;
  279. return new Promise(function(resolve, reject) {
  280. self.findPage(path, user, revisionId)
  281. .then(function(page) {
  282. resolve(page);
  283. }).catch(function(err) {
  284. resolve(null); // check only has portal page, through error
  285. });
  286. });
  287. };
  288. pageSchema.statics.getGrantLabels = function() {
  289. var grantLabels = {};
  290. grantLabels[GRANT_PUBLIC] = 'Public'; // 公開
  291. grantLabels[GRANT_RESTRICTED] = 'Anyone with the link'; // リンクを知っている人のみ
  292. //grantLabels[GRANT_SPECIFIED] = 'Specified users only'; // 特定ユーザーのみ
  293. grantLabels[GRANT_USER_GROUP] = 'Only inside the group'; // 特定グループのみ
  294. grantLabels[GRANT_OWNER] = 'Just me'; // 自分のみ
  295. return grantLabels;
  296. };
  297. pageSchema.statics.normalizePath = function(path) {
  298. if (!path.match(/^\//)) {
  299. path = '/' + path;
  300. }
  301. path = path.replace(/\/\s+?/g, '/').replace(/\s+\//g, '/');
  302. return path;
  303. };
  304. pageSchema.statics.getUserPagePath = function(user) {
  305. return '/user/' + user.username;
  306. };
  307. pageSchema.statics.getDeletedPageName = function(path) {
  308. if (path.match('\/')) {
  309. path = path.substr(1);
  310. }
  311. return '/trash/' + path;
  312. };
  313. pageSchema.statics.getRevertDeletedPageName = function(path) {
  314. return path.replace('\/trash', '');
  315. };
  316. pageSchema.statics.isDeletableName = function(path) {
  317. var notDeletable = [
  318. /^\/user\/[^\/]+$/, // user page
  319. ];
  320. for (var i = 0; i < notDeletable.length; i++) {
  321. var pattern = notDeletable[i];
  322. if (path.match(pattern)) {
  323. return false;
  324. }
  325. }
  326. return true;
  327. };
  328. pageSchema.statics.isCreatableName = function(name) {
  329. var forbiddenPages = [
  330. /\^|\$|\*|\+|\#/,
  331. /^\/_.*/, // /_api/* and so on
  332. /^\/\-\/.*/,
  333. /^\/_r\/.*/,
  334. /^\/?https?:\/\/.+$/, // avoid miss in renaming
  335. /\/{2,}/, // avoid miss in renaming
  336. /\s+\/\s+/, // avoid miss in renaming
  337. /.+\/edit$/,
  338. /.+\.md$/,
  339. /^\/(installer|register|login|logout|admin|me|files|trash|paste|comments)(\/.*|$)/,
  340. ];
  341. var isCreatable = true;
  342. forbiddenPages.forEach(function(page) {
  343. var pageNameReg = new RegExp(page);
  344. if (name.match(pageNameReg)) {
  345. isCreatable = false;
  346. return ;
  347. }
  348. });
  349. return isCreatable;
  350. };
  351. pageSchema.statics.fixToCreatableName = function(path) {
  352. return path
  353. .replace(/\/\//g, '/')
  354. ;
  355. };
  356. pageSchema.statics.updateRevision = function(pageId, revisionId, cb) {
  357. this.update({_id: pageId}, {revision: revisionId}, {}, function(err, data) {
  358. cb(err, data);
  359. });
  360. };
  361. pageSchema.statics.findUpdatedList = function(offset, limit, cb) {
  362. this
  363. .find({})
  364. .sort({updatedAt: -1})
  365. .skip(offset)
  366. .limit(limit)
  367. .exec(function(err, data) {
  368. cb(err, data);
  369. });
  370. };
  371. pageSchema.statics.findPageById = function(id) {
  372. var Page = this;
  373. return new Promise(function(resolve, reject) {
  374. Page.findOne({_id: id}, function(err, pageData) {
  375. if (err) {
  376. return reject(err);
  377. }
  378. if (pageData == null) {
  379. return reject(new Error('Page not found'));
  380. }
  381. return Page.populatePageData(pageData, null).then(resolve);
  382. });
  383. });
  384. };
  385. pageSchema.statics.findPageByIdAndGrantedUser = function(id, userData) {
  386. var Page = this;
  387. var PageGroupRelation = crowi.model('PageGroupRelation');
  388. var pageData = null;
  389. return new Promise(function(resolve, reject) {
  390. Page.findPageById(id)
  391. .then(function(result) {
  392. pageData = result;
  393. if (userData && !pageData.isGrantedFor(userData)) {
  394. return PageGroupRelation.isExistsGrantedGroupForPageAndUser(pageData, userData);
  395. }
  396. else {
  397. return true;
  398. }
  399. }).then((checkResult) => {
  400. if (checkResult) {
  401. return resolve(pageData);
  402. }
  403. else {
  404. return reject(new Error('Page is not granted for the user')); //PAGE_GRANT_ERROR, null);
  405. }
  406. }).catch(function(err) {
  407. return reject(err);
  408. });
  409. });
  410. };
  411. // find page and check if granted user
  412. pageSchema.statics.findPage = function(path, userData, revisionId, ignoreNotFound) {
  413. var self = this;
  414. var PageGroupRelation = crowi.model('PageGroupRelation');
  415. return new Promise(function(resolve, reject) {
  416. self.findOne({path: path}, function(err, pageData) {
  417. if (err) {
  418. return reject(err);
  419. }
  420. if (pageData === null) {
  421. if (ignoreNotFound) {
  422. return resolve(null);
  423. }
  424. var pageNotFoundError = new Error('Page Not Found');
  425. pageNotFoundError.name = 'Crowi:Page:NotFound';
  426. return reject(pageNotFoundError);
  427. }
  428. if (!pageData.isGrantedFor(userData)) {
  429. PageGroupRelation.isExistsGrantedGroupForPageAndUser(pageData, userData)
  430. .then(isExists => {
  431. if (!isExists) {
  432. return reject(new Error('Page is not granted for the user')); //PAGE_GRANT_ERROR, null);
  433. }
  434. else {
  435. // return resolve(pageData);
  436. self.populatePageData(pageData, revisionId || null).then(resolve).catch(reject);
  437. }
  438. })
  439. .catch(function(err) {
  440. return reject(err);
  441. });
  442. }
  443. else {
  444. self.populatePageData(pageData, revisionId || null).then(resolve).catch(reject);
  445. }
  446. });
  447. });
  448. };
  449. // find page by path
  450. pageSchema.statics.findPageByPath = function(path) {
  451. if (path == null) {
  452. return null;
  453. }
  454. return this.findOne({path});
  455. };
  456. pageSchema.statics.findListByPageIds = function(ids, options) {
  457. var Page = this;
  458. var User = crowi.model('User');
  459. var options = options || {}
  460. , limit = options.limit || 50
  461. , offset = options.skip || 0
  462. ;
  463. return new Promise(function(resolve, reject) {
  464. Page
  465. .find({ _id: { $in: ids }, grant: GRANT_PUBLIC })
  466. //.sort({createdAt: -1}) // TODO optionize
  467. .skip(offset)
  468. .limit(limit)
  469. .populate([
  470. {path: 'creator', model: 'User', select: User.USER_PUBLIC_FIELDS},
  471. {path: 'revision', model: 'Revision'},
  472. ])
  473. .exec(function(err, pages) {
  474. if (err) {
  475. return reject(err);
  476. }
  477. Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS}, function(err, data) {
  478. if (err) {
  479. return reject(err);
  480. }
  481. return resolve(data);
  482. });
  483. });
  484. });
  485. };
  486. pageSchema.statics.findPageByRedirectTo = function(path) {
  487. var Page = this;
  488. return new Promise(function(resolve, reject) {
  489. Page.findOne({redirectTo: path}, function(err, pageData) {
  490. if (err || pageData === null) {
  491. return reject(err);
  492. }
  493. return resolve(pageData);
  494. });
  495. });
  496. };
  497. pageSchema.statics.findListByCreator = function(user, option, currentUser) {
  498. var Page = this;
  499. var User = crowi.model('User');
  500. var limit = option.limit || 50;
  501. var offset = option.offset || 0;
  502. var conditions = {
  503. creator: user._id,
  504. redirectTo: null,
  505. $or: [
  506. {status: null},
  507. {status: STATUS_PUBLISHED},
  508. ],
  509. };
  510. if (!user.equals(currentUser._id)) {
  511. conditions.grant = GRANT_PUBLIC;
  512. }
  513. return new Promise(function(resolve, reject) {
  514. Page
  515. .find(conditions)
  516. .sort({createdAt: -1})
  517. .skip(offset)
  518. .limit(limit)
  519. .populate('revision')
  520. .exec()
  521. .then(function(pages) {
  522. return Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS}).then(resolve);
  523. });
  524. });
  525. };
  526. /**
  527. * Bulk get (for internal only)
  528. */
  529. pageSchema.statics.getStreamOfFindAll = function(options) {
  530. var Page = this
  531. , options = options || {}
  532. , publicOnly = options.publicOnly || true
  533. , criteria = {redirectTo: null, }
  534. ;
  535. if (publicOnly) {
  536. criteria.grant = GRANT_PUBLIC;
  537. }
  538. return this.find(criteria)
  539. .populate([
  540. {path: 'creator', model: 'User'},
  541. {path: 'revision', model: 'Revision'},
  542. ])
  543. .sort({updatedAt: -1})
  544. .cursor();
  545. };
  546. /**
  547. * find the page that is match with `path` and its descendants
  548. */
  549. pageSchema.statics.findListWithDescendants = function(path, userData, option) {
  550. var Page = this;
  551. // ignore other pages than descendants
  552. path = Page.addSlashOfEnd(path);
  553. // add option to escape the regex strings
  554. const combinedOption = Object.assign({isRegExpEscapedFromPath: true}, option);
  555. return Page.findListByStartWith(path, userData, combinedOption);
  556. };
  557. /**
  558. * find pages that start with `path`
  559. *
  560. * see the comment of `generateQueryToListByStartWith` function
  561. */
  562. pageSchema.statics.findListByStartWith = function(path, userData, option) {
  563. var Page = this;
  564. var User = crowi.model('User');
  565. if (!option) {
  566. option = {sort: 'updatedAt', desc: -1, offset: 0, limit: 50};
  567. }
  568. var opt = {
  569. sort: option.sort || 'updatedAt',
  570. desc: option.desc || -1,
  571. offset: option.offset || 0,
  572. limit: option.limit || 50
  573. };
  574. var sortOpt = {};
  575. sortOpt[opt.sort] = opt.desc;
  576. var isPopulateRevisionBody = option.isPopulateRevisionBody || false;
  577. return new Promise(function(resolve, reject) {
  578. var q = Page.generateQueryToListByStartWith(path, userData, option)
  579. .sort(sortOpt)
  580. .skip(opt.offset)
  581. .limit(opt.limit);
  582. // retrieve revision data
  583. if (isPopulateRevisionBody) {
  584. q = q.populate('revision');
  585. }
  586. else {
  587. q = q.populate('revision', '-body'); // exclude body
  588. }
  589. q.exec()
  590. .then(function(pages) {
  591. Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS})
  592. .then(resolve)
  593. .catch(reject);
  594. });
  595. });
  596. };
  597. /**
  598. * generate the query to find the page that is match with `path` and its descendants
  599. */
  600. pageSchema.statics.generateQueryToListWithDescendants = function(path, userData, option) {
  601. var Page = this;
  602. // ignore other pages than descendants
  603. path = Page.addSlashOfEnd(path);
  604. // add option to escape the regex strings
  605. const combinedOption = Object.assign({isRegExpEscapedFromPath: true}, option);
  606. return Page.generateQueryToListByStartWith(path, userData, combinedOption);
  607. };
  608. /**
  609. * generate the query to find pages that start with `path`
  610. *
  611. * (GROWI) If 'isRegExpEscapedFromPath' is true, `path` should have `/` at the end
  612. * -> returns '{path}/*' and '{path}' self.
  613. * (Crowi) If 'isRegExpEscapedFromPath' is false and `path` has `/` at the end
  614. * -> returns '{path}*'
  615. * (Crowi) If 'isRegExpEscapedFromPath' is false and `path` doesn't have `/` at the end
  616. * -> returns '{path}*'
  617. *
  618. * *option*
  619. * - includeDeletedPage -- if true, search deleted pages (default: false)
  620. * - isRegExpEscapedFromPath -- if true, the regex strings included in `path` is escaped (default: false)
  621. */
  622. pageSchema.statics.generateQueryToListByStartWith = function(path, userData, option) {
  623. var Page = this;
  624. var pathCondition = [];
  625. var includeDeletedPage = option.includeDeletedPage || false;
  626. var isRegExpEscapedFromPath = option.isRegExpEscapedFromPath || false;
  627. /*
  628. * 1. add condition for finding the page completely match with `path` w/o last slash
  629. */
  630. let pathSlashOmitted = path;
  631. if (path.match(/\/$/)) {
  632. pathSlashOmitted = path.substr(0, path.length -1);
  633. pathCondition.push({path: pathSlashOmitted});
  634. }
  635. /*
  636. * 2. add decendants
  637. */
  638. var pattern = (isRegExpEscapedFromPath)
  639. ? escapeStringRegexp(path) // escape
  640. : pathSlashOmitted;
  641. var queryReg = new RegExp('^' + pattern);
  642. pathCondition.push({path: queryReg});
  643. var q = Page.find({
  644. redirectTo: null,
  645. $or: [
  646. {grant: null},
  647. {grant: GRANT_PUBLIC},
  648. {grant: GRANT_RESTRICTED, grantedUsers: userData._id},
  649. {grant: GRANT_SPECIFIED, grantedUsers: userData._id},
  650. {grant: GRANT_OWNER, grantedUsers: userData._id},
  651. {grant: GRANT_USER_GROUP},
  652. ], })
  653. .and({
  654. $or: pathCondition
  655. });
  656. if (!includeDeletedPage) {
  657. q.and({
  658. $or: [
  659. {status: null},
  660. {status: STATUS_PUBLISHED},
  661. ],
  662. });
  663. }
  664. return q;
  665. };
  666. pageSchema.statics.updatePageProperty = function(page, updateData) {
  667. var Page = this;
  668. return new Promise(function(resolve, reject) {
  669. // TODO foreach して save
  670. Page.update({_id: page._id}, {$set: updateData}, function(err, data) {
  671. if (err) {
  672. return reject(err);
  673. }
  674. return resolve(data);
  675. });
  676. });
  677. };
  678. pageSchema.statics.updateGrant = function(page, grant, userData, grantUserGroupId) {
  679. var Page = this;
  680. return new Promise(function(resolve, reject) {
  681. if (grant == GRANT_USER_GROUP && grantUserGroupId == null) {
  682. reject('grant userGroupId is not specified');
  683. }
  684. page.grant = grant;
  685. if (grant == GRANT_PUBLIC || grant == GRANT_USER_GROUP) {
  686. page.grantedUsers = [];
  687. }
  688. else {
  689. page.grantedUsers = [];
  690. page.grantedUsers.push(userData._id);
  691. }
  692. page.save(function(err, data) {
  693. debug('Page.updateGrant, saved grantedUsers.', err, data);
  694. if (err) {
  695. return reject(err);
  696. }
  697. Page.updateGrantUserGroup(page, grant, grantUserGroupId, userData)
  698. .then(() => {
  699. return resolve(data);
  700. });
  701. });
  702. });
  703. };
  704. pageSchema.statics.updateGrantUserGroup = function(page, grant, grantUserGroupId, userData) {
  705. var UserGroupRelation = crowi.model('UserGroupRelation');
  706. var PageGroupRelation = crowi.model('PageGroupRelation');
  707. // グループの場合
  708. if (grant == GRANT_USER_GROUP) {
  709. debug('grant is usergroup', grantUserGroupId);
  710. return UserGroupRelation.findByGroupIdAndUser(grantUserGroupId, userData)
  711. .then((relation) => {
  712. if (relation == null) {
  713. return new Error('no relations were exist for group and user.');
  714. }
  715. return PageGroupRelation.findOrCreateRelationForPageAndGroup(page, relation.relatedGroup);
  716. })
  717. .catch((err) => {
  718. return new Error('No UserGroup is exists. userGroupId : ', grantUserGroupId);
  719. });
  720. }
  721. else {
  722. return PageGroupRelation.removeAllByPage(page);
  723. }
  724. };
  725. // Instance method でいいのでは
  726. pageSchema.statics.pushToGrantedUsers = function(page, userData) {
  727. return new Promise(function(resolve, reject) {
  728. if (!page.grantedUsers || !Array.isArray(page.grantedUsers)) {
  729. page.grantedUsers = [];
  730. }
  731. page.grantedUsers.push(userData);
  732. page.save(function(err, data) {
  733. if (err) {
  734. return reject(err);
  735. }
  736. return resolve(data);
  737. });
  738. });
  739. };
  740. pageSchema.statics.pushRevision = function(pageData, newRevision, user) {
  741. var isCreate = false;
  742. if (pageData.revision === undefined) {
  743. debug('pushRevision on Create');
  744. isCreate = true;
  745. }
  746. return new Promise(function(resolve, reject) {
  747. newRevision.save(function(err, newRevision) {
  748. if (err) {
  749. debug('Error on saving revision', err);
  750. return reject(err);
  751. }
  752. debug('Successfully saved new revision', newRevision);
  753. pageData.revision = newRevision;
  754. pageData.lastUpdateUser = user;
  755. pageData.updatedAt = Date.now();
  756. pageData.save(function(err, data) {
  757. if (err) {
  758. // todo: remove new revision?
  759. debug('Error on save page data (after push revision)', err);
  760. return reject(err);
  761. }
  762. resolve(data);
  763. if (!isCreate) {
  764. debug('pushRevision on Update');
  765. }
  766. });
  767. });
  768. });
  769. };
  770. pageSchema.statics.create = function(path, body, user, options) {
  771. var Page = this
  772. , Revision = crowi.model('Revision')
  773. , format = options.format || 'markdown'
  774. , grant = options.grant || GRANT_PUBLIC
  775. , redirectTo = options.redirectTo || null
  776. , grantUserGroupId = options.grantUserGroupId || null;
  777. // force public
  778. if (isPortalPath(path)) {
  779. grant = GRANT_PUBLIC;
  780. }
  781. let savedPage = undefined;
  782. return Page.findOne({path: path})
  783. .then(pageData => {
  784. if (pageData) {
  785. throw new Error('Cannot create new page to existed path');
  786. }
  787. var newPage = new Page();
  788. newPage.path = path;
  789. newPage.creator = user;
  790. newPage.lastUpdateUser = user;
  791. newPage.createdAt = Date.now();
  792. newPage.updatedAt = Date.now();
  793. newPage.redirectTo = redirectTo;
  794. newPage.grant = grant;
  795. newPage.status = STATUS_PUBLISHED;
  796. newPage.grantedUsers = [];
  797. newPage.grantedUsers.push(user);
  798. return newPage.save();
  799. })
  800. .then((newPage) => {
  801. savedPage = newPage;
  802. })
  803. .then(() => {
  804. const newRevision = Revision.prepareRevision(savedPage, body, user, {format: format});
  805. return Page.pushRevision(savedPage, newRevision, user);
  806. })
  807. .then(() => {
  808. return Page.updateGrantUserGroup(savedPage, grant, grantUserGroupId, user);
  809. })
  810. .then(() => {
  811. pageEvent.emit('create', savedPage, user);
  812. return savedPage;
  813. });
  814. };
  815. pageSchema.statics.updatePage = function(pageData, body, user, options) {
  816. var Page = this
  817. , Revision = crowi.model('Revision')
  818. , grant = options.grant || null
  819. , grantUserGroupId = options.grantUserGroupId || null
  820. ;
  821. // update existing page
  822. var newRevision = Revision.prepareRevision(pageData, body, user);
  823. let savedPage = undefined;
  824. return Page.pushRevision(pageData, newRevision, user)
  825. .then((revision) => {
  826. // fetch Page
  827. return Page.findPageByPath(revision.path).populate('revision');
  828. })
  829. .then((page) => {
  830. savedPage = page;
  831. })
  832. .then(() => {
  833. return Page.updateGrant(savedPage, grant, user, grantUserGroupId);
  834. })
  835. .then((data) => {
  836. debug('Page grant update:', data);
  837. pageEvent.emit('update', savedPage, user);
  838. return savedPage;
  839. });
  840. };
  841. pageSchema.statics.deletePage = function(pageData, user, options) {
  842. var Page = this
  843. , newPath = Page.getDeletedPageName(pageData.path)
  844. ;
  845. if (Page.isDeletableName(pageData.path)) {
  846. return Page.rename(pageData, newPath, user, {createRedirectPage: true})
  847. .then((updatedPageData) => {
  848. return Page.updatePageProperty(updatedPageData, {status: STATUS_DELETED, lastUpdateUser: user});
  849. })
  850. .then(() => {
  851. return pageData;
  852. });
  853. }
  854. else {
  855. return Promise.reject('Page is not deletable.');
  856. }
  857. };
  858. pageSchema.statics.deletePageRecursively = function(pageData, user, options) {
  859. var Page = this
  860. , path = pageData.path
  861. , options = options || {}
  862. ;
  863. return Page.generateQueryToListWithDescendants(path, user, options)
  864. .then(function(pages) {
  865. return Promise.all(pages.map(function(page) {
  866. return Page.deletePage(page, user, options);
  867. }));
  868. })
  869. .then(function(data) {
  870. return pageData;
  871. });
  872. };
  873. pageSchema.statics.revertDeletedPage = function(pageData, user, options) {
  874. var Page = this
  875. , newPath = Page.getRevertDeletedPageName(pageData.path)
  876. ;
  877. // 削除時、元ページの path には必ず redirectTo 付きで、ページが作成される。
  878. // そのため、そいつは削除してOK
  879. // が、redirectTo ではないページが存在している場合それは何かがおかしい。(データ補正が必要)
  880. return new Promise(function(resolve, reject) {
  881. Page.findPageByPath(newPath)
  882. .then(function(originPageData) {
  883. if (originPageData.redirectTo !== pageData.path) {
  884. throw new Error('The new page of to revert is exists and the redirect path of the page is not the deleted page.');
  885. }
  886. return Page.completelyDeletePage(originPageData);
  887. }).then(function(done) {
  888. return Page.updatePageProperty(pageData, {status: STATUS_PUBLISHED, lastUpdateUser: user});
  889. }).then(function(done) {
  890. pageData.status = STATUS_PUBLISHED;
  891. debug('Revert deleted the page, and rename again it', pageData, newPath);
  892. return Page.rename(pageData, newPath, user, {});
  893. }).then(function(done) {
  894. pageData.path = newPath;
  895. resolve(pageData);
  896. }).catch(reject);
  897. });
  898. };
  899. pageSchema.statics.revertDeletedPageRecursively = function(pageData, user, options) {
  900. var Page = this
  901. , path = pageData.path
  902. , options = options || { includeDeletedPage: true}
  903. ;
  904. return new Promise(function(resolve, reject) {
  905. Page
  906. .generateQueryToListWithDescendants(path, user, options)
  907. .exec()
  908. .then(function(pages) {
  909. Promise.all(pages.map(function(page) {
  910. return Page.revertDeletedPage(page, user, options);
  911. }))
  912. .then(function(data) {
  913. return resolve(data[0]);
  914. });
  915. });
  916. });
  917. };
  918. /**
  919. * This is danger.
  920. */
  921. pageSchema.statics.completelyDeletePage = function(pageData, user, options) {
  922. // Delete Bookmarks, Attachments, Revisions, Pages and emit delete
  923. var Bookmark = crowi.model('Bookmark')
  924. , Attachment = crowi.model('Attachment')
  925. , Comment = crowi.model('Comment')
  926. , Revision = crowi.model('Revision')
  927. , PageGroupRelation = crowi.model('PageGroupRelation')
  928. , Page = this
  929. , pageId = pageData._id
  930. ;
  931. debug('Completely delete', pageData.path);
  932. return new Promise(function(resolve, reject) {
  933. Bookmark.removeBookmarksByPageId(pageId)
  934. .then(function(done) {
  935. }).then(function(done) {
  936. return Attachment.removeAttachmentsByPageId(pageId);
  937. }).then(function(done) {
  938. return Comment.removeCommentsByPageId(pageId);
  939. }).then(function(done) {
  940. return Revision.removeRevisionsByPath(pageData.path);
  941. }).then(function(done) {
  942. return Page.removePageById(pageId);
  943. }).then(function(done) {
  944. return Page.removeRedirectOriginPageByPath(pageData.path);
  945. }).then(function(done) {
  946. return PageGroupRelation.removeAllByPage(pageData);
  947. }).then(function(done) {
  948. pageEvent.emit('delete', pageData, user); // update as renamed page
  949. resolve(pageData);
  950. }).catch(reject);
  951. });
  952. };
  953. pageSchema.statics.completelyDeletePageRecursively = function(pageData, user, options) {
  954. // Delete Bookmarks, Attachments, Revisions, Pages and emit delete
  955. var Page = this
  956. , path = pageData.path
  957. , options = options || { includeDeletedPage: true }
  958. ;
  959. return new Promise(function(resolve, reject) {
  960. Page
  961. .generateQueryToListWithDescendants(path, user, options)
  962. .then(function(pages) {
  963. Promise.all(pages.map(function(page) {
  964. return Page.completelyDeletePage(page, user, options);
  965. }))
  966. .then(function(data) {
  967. return resolve(data[0]);
  968. });
  969. });
  970. });
  971. };
  972. pageSchema.statics.removePageById = function(pageId) {
  973. var Page = this;
  974. return new Promise(function(resolve, reject) {
  975. Page.remove({_id: pageId}, function(err, done) {
  976. debug('Remove phisiaclly, the page', pageId, err, done);
  977. if (err) {
  978. return reject(err);
  979. }
  980. resolve(done);
  981. });
  982. });
  983. };
  984. pageSchema.statics.removePageByPath = function(pagePath) {
  985. var Page = this;
  986. return Page.findPageByPath(pagePath)
  987. .then(function(pageData) {
  988. return Page.removePageById(pageData.id);
  989. });
  990. };
  991. /**
  992. * remove the page that is redirecting to specified `pagePath` recursively
  993. * ex: when
  994. * '/page1' redirects to '/page2' and
  995. * '/page2' redirects to '/page3'
  996. * and given '/page3',
  997. * '/page1' and '/page2' will be removed
  998. *
  999. * @param {string} pagePath
  1000. */
  1001. pageSchema.statics.removeRedirectOriginPageByPath = function(pagePath) {
  1002. var Page = this;
  1003. return Page.findPageByRedirectTo(pagePath)
  1004. .then((redirectOriginPageData) => {
  1005. // remove
  1006. return Page.removePageById(redirectOriginPageData.id)
  1007. // remove recursive
  1008. .then(() => {
  1009. return Page.removeRedirectOriginPageByPath(redirectOriginPageData.path);
  1010. });
  1011. })
  1012. .catch((err) => {
  1013. // do nothing if origin page doesn't exist
  1014. return Promise.resolve();
  1015. });
  1016. };
  1017. pageSchema.statics.rename = function(pageData, newPagePath, user, options) {
  1018. var Page = this
  1019. , Revision = crowi.model('Revision')
  1020. , path = pageData.path
  1021. , createRedirectPage = options.createRedirectPage || 0
  1022. , moveUnderTrees = options.moveUnderTrees || 0;
  1023. return Page.updatePageProperty(pageData, {updatedAt: Date.now(), path: newPagePath, lastUpdateUser: user}) // pageData の path を変更
  1024. .then((data) => {
  1025. // reivisions の path を変更
  1026. return Revision.updateRevisionListByPath(path, {path: newPagePath}, {});
  1027. })
  1028. .then(function(data) {
  1029. pageData.path = newPagePath;
  1030. if (createRedirectPage) {
  1031. var body = 'redirect ' + newPagePath;
  1032. Page.create(path, body, user, {redirectTo: newPagePath});
  1033. }
  1034. pageEvent.emit('update', pageData, user); // update as renamed page
  1035. return pageData;
  1036. });
  1037. };
  1038. pageSchema.statics.renameRecursively = function(pageData, newPagePathPrefix, user, options) {
  1039. var Page = this
  1040. , path = pageData.path
  1041. , pathRegExp = new RegExp('^' + escapeStringRegexp(path), 'i');
  1042. return Page.generateQueryToListWithDescendants(path, user, options)
  1043. .then(function(pages) {
  1044. return Promise.all(pages.map(function(page) {
  1045. const newPagePath = page.path.replace(pathRegExp, newPagePathPrefix);
  1046. return Page.rename(page, newPagePath, user, options);
  1047. }));
  1048. })
  1049. .then(function() {
  1050. pageData.path = newPagePathPrefix;
  1051. return pageData;
  1052. });
  1053. };
  1054. pageSchema.statics.getHistories = function() {
  1055. // TODO
  1056. return;
  1057. };
  1058. /**
  1059. * return path that added slash to the end for specified path
  1060. */
  1061. pageSchema.statics.addSlashOfEnd = function(path) {
  1062. let returnPath = path;
  1063. if (!path.match(/\/$/)) {
  1064. returnPath += '/';
  1065. }
  1066. return returnPath;
  1067. };
  1068. pageSchema.statics.GRANT_PUBLIC = GRANT_PUBLIC;
  1069. pageSchema.statics.GRANT_RESTRICTED = GRANT_RESTRICTED;
  1070. pageSchema.statics.GRANT_SPECIFIED = GRANT_SPECIFIED;
  1071. pageSchema.statics.GRANT_OWNER = GRANT_OWNER;
  1072. pageSchema.statics.PAGE_GRANT_ERROR = PAGE_GRANT_ERROR;
  1073. return mongoose.model('Page', pageSchema);
  1074. };