page.js 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322
  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. /**
  450. * find all templates applicable to the new page
  451. */
  452. pageSchema.statics.findTemplate = function(path) {
  453. const Page = this;
  454. const templatePath = cutOffLastSlash(path);
  455. const pathList = generatePathsOnTree(templatePath, []);
  456. const regexpList = pathList.map(path => new RegExp(`^${path}/_{1,2}template$`));
  457. return Page
  458. .find({path: {$in: regexpList}})
  459. .populate({path: 'revision', model: 'Revision'})
  460. .then(templates => {
  461. return fetchTemplate(templates, templatePath);
  462. });
  463. };
  464. const cutOffLastSlash = path => {
  465. const lastSlash = path.lastIndexOf('/');
  466. return path.substr(0, lastSlash);
  467. };
  468. const generatePathsOnTree = (path, pathList) => {
  469. if (path === '') {
  470. return pathList;
  471. }
  472. pathList.push(path);
  473. const newPath = cutOffLastSlash(path);
  474. return generatePathsOnTree(newPath, pathList);
  475. };
  476. const assignTemplateByType = (templates, path, type) => {
  477. for (let i = 0; i < templates.length; i++) {
  478. if (templates[i].path === `${path}/${type}template`) {
  479. return templates[i];
  480. }
  481. }
  482. };
  483. const assignGlobalTemplate = (globalTemplates, path) => {
  484. const globalTemplate = assignTemplateByType(globalTemplates, path, '_');
  485. if (globalTemplate) {
  486. return globalTemplate;
  487. }
  488. if (path === '') {
  489. return;
  490. }
  491. const newPath = cutOffLastSlash(path);
  492. return assignGlobalTemplate(globalTemplates, newPath);
  493. };
  494. const fetchTemplate = (templates, templatePath) => {
  495. let templateBody;
  496. /**
  497. * get local template
  498. * __tempate: applicable only to immediate decendants
  499. */
  500. const localTemplate = assignTemplateByType(templates, templatePath, '__');
  501. /**
  502. * get global templates
  503. * _tempate: applicable to all pages under
  504. */
  505. const globalTemplate = assignGlobalTemplate(templates, templatePath);
  506. if (localTemplate) {
  507. templateBody = localTemplate.revision.body;
  508. }
  509. else if (globalTemplate) {
  510. templateBody = globalTemplate.revision.body;
  511. }
  512. return templateBody;
  513. };
  514. // find page by path
  515. pageSchema.statics.findPageByPath = function(path) {
  516. if (path == null) {
  517. return null;
  518. }
  519. return this.findOne({path});
  520. };
  521. pageSchema.statics.findListByPageIds = function(ids, options) {
  522. var Page = this;
  523. var User = crowi.model('User');
  524. var options = options || {}
  525. , limit = options.limit || 50
  526. , offset = options.skip || 0
  527. ;
  528. return new Promise(function(resolve, reject) {
  529. Page
  530. .find({ _id: { $in: ids }, grant: GRANT_PUBLIC })
  531. //.sort({createdAt: -1}) // TODO optionize
  532. .skip(offset)
  533. .limit(limit)
  534. .populate([
  535. {path: 'creator', model: 'User', select: User.USER_PUBLIC_FIELDS},
  536. {path: 'revision', model: 'Revision'},
  537. ])
  538. .exec(function(err, pages) {
  539. if (err) {
  540. return reject(err);
  541. }
  542. Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS}, function(err, data) {
  543. if (err) {
  544. return reject(err);
  545. }
  546. return resolve(data);
  547. });
  548. });
  549. });
  550. };
  551. pageSchema.statics.findPageByRedirectTo = function(path) {
  552. var Page = this;
  553. return new Promise(function(resolve, reject) {
  554. Page.findOne({redirectTo: path}, function(err, pageData) {
  555. if (err || pageData === null) {
  556. return reject(err);
  557. }
  558. return resolve(pageData);
  559. });
  560. });
  561. };
  562. pageSchema.statics.findListByCreator = function(user, option, currentUser) {
  563. var Page = this;
  564. var User = crowi.model('User');
  565. var limit = option.limit || 50;
  566. var offset = option.offset || 0;
  567. var conditions = {
  568. creator: user._id,
  569. redirectTo: null,
  570. $or: [
  571. {status: null},
  572. {status: STATUS_PUBLISHED},
  573. ],
  574. };
  575. if (!user.equals(currentUser._id)) {
  576. conditions.grant = GRANT_PUBLIC;
  577. }
  578. return new Promise(function(resolve, reject) {
  579. Page
  580. .find(conditions)
  581. .sort({createdAt: -1})
  582. .skip(offset)
  583. .limit(limit)
  584. .populate('revision')
  585. .exec()
  586. .then(function(pages) {
  587. return Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS}).then(resolve);
  588. });
  589. });
  590. };
  591. /**
  592. * Bulk get (for internal only)
  593. */
  594. pageSchema.statics.getStreamOfFindAll = function(options) {
  595. var Page = this
  596. , options = options || {}
  597. , publicOnly = options.publicOnly || true
  598. , criteria = {redirectTo: null, }
  599. ;
  600. if (publicOnly) {
  601. criteria.grant = GRANT_PUBLIC;
  602. }
  603. return this.find(criteria)
  604. .populate([
  605. {path: 'creator', model: 'User'},
  606. {path: 'revision', model: 'Revision'},
  607. ])
  608. .sort({updatedAt: -1})
  609. .cursor();
  610. };
  611. /**
  612. * find the page that is match with `path` and its descendants
  613. */
  614. pageSchema.statics.findListWithDescendants = function(path, userData, option) {
  615. var Page = this;
  616. // ignore other pages than descendants
  617. path = Page.addSlashOfEnd(path);
  618. // add option to escape the regex strings
  619. const combinedOption = Object.assign({isRegExpEscapedFromPath: true}, option);
  620. return Page.findListByStartWith(path, userData, combinedOption);
  621. };
  622. /**
  623. * find pages that start with `path`
  624. *
  625. * see the comment of `generateQueryToListByStartWith` function
  626. */
  627. pageSchema.statics.findListByStartWith = function(path, userData, option) {
  628. var Page = this;
  629. var User = crowi.model('User');
  630. if (!option) {
  631. option = {sort: 'updatedAt', desc: -1, offset: 0, limit: 50};
  632. }
  633. var opt = {
  634. sort: option.sort || 'updatedAt',
  635. desc: option.desc || -1,
  636. offset: option.offset || 0,
  637. limit: option.limit || 50
  638. };
  639. var sortOpt = {};
  640. sortOpt[opt.sort] = opt.desc;
  641. var isPopulateRevisionBody = option.isPopulateRevisionBody || false;
  642. return new Promise(function(resolve, reject) {
  643. var q = Page.generateQueryToListByStartWith(path, userData, option)
  644. .sort(sortOpt)
  645. .skip(opt.offset)
  646. .limit(opt.limit);
  647. // retrieve revision data
  648. if (isPopulateRevisionBody) {
  649. q = q.populate('revision');
  650. }
  651. else {
  652. q = q.populate('revision', '-body'); // exclude body
  653. }
  654. q.exec()
  655. .then(function(pages) {
  656. Page.populate(pages, {path: 'revision.author', model: 'User', select: User.USER_PUBLIC_FIELDS})
  657. .then(resolve)
  658. .catch(reject);
  659. });
  660. });
  661. };
  662. /**
  663. * generate the query to find the page that is match with `path` and its descendants
  664. */
  665. pageSchema.statics.generateQueryToListWithDescendants = function(path, userData, option) {
  666. var Page = this;
  667. // ignore other pages than descendants
  668. path = Page.addSlashOfEnd(path);
  669. // add option to escape the regex strings
  670. const combinedOption = Object.assign({isRegExpEscapedFromPath: true}, option);
  671. return Page.generateQueryToListByStartWith(path, userData, combinedOption);
  672. };
  673. /**
  674. * generate the query to find pages that start with `path`
  675. *
  676. * (GROWI) If 'isRegExpEscapedFromPath' is true, `path` should have `/` at the end
  677. * -> returns '{path}/*' and '{path}' self.
  678. * (Crowi) If 'isRegExpEscapedFromPath' is false and `path` has `/` at the end
  679. * -> returns '{path}*'
  680. * (Crowi) If 'isRegExpEscapedFromPath' is false and `path` doesn't have `/` at the end
  681. * -> returns '{path}*'
  682. *
  683. * *option*
  684. * - includeDeletedPage -- if true, search deleted pages (default: false)
  685. * - isRegExpEscapedFromPath -- if true, the regex strings included in `path` is escaped (default: false)
  686. */
  687. pageSchema.statics.generateQueryToListByStartWith = function(path, userData, option) {
  688. var Page = this;
  689. var pathCondition = [];
  690. var includeDeletedPage = option.includeDeletedPage || false;
  691. var isRegExpEscapedFromPath = option.isRegExpEscapedFromPath || false;
  692. /*
  693. * 1. add condition for finding the page completely match with `path` w/o last slash
  694. */
  695. let pathSlashOmitted = path;
  696. if (path.match(/\/$/)) {
  697. pathSlashOmitted = path.substr(0, path.length -1);
  698. pathCondition.push({path: pathSlashOmitted});
  699. }
  700. /*
  701. * 2. add decendants
  702. */
  703. var pattern = (isRegExpEscapedFromPath)
  704. ? escapeStringRegexp(path) // escape
  705. : pathSlashOmitted;
  706. var queryReg = new RegExp('^' + pattern);
  707. pathCondition.push({path: queryReg});
  708. var q = Page.find({
  709. redirectTo: null,
  710. $or: [
  711. {grant: null},
  712. {grant: GRANT_PUBLIC},
  713. {grant: GRANT_RESTRICTED, grantedUsers: userData._id},
  714. {grant: GRANT_SPECIFIED, grantedUsers: userData._id},
  715. {grant: GRANT_OWNER, grantedUsers: userData._id},
  716. {grant: GRANT_USER_GROUP},
  717. ], })
  718. .and({
  719. $or: pathCondition
  720. });
  721. if (!includeDeletedPage) {
  722. q.and({
  723. $or: [
  724. {status: null},
  725. {status: STATUS_PUBLISHED},
  726. ],
  727. });
  728. }
  729. return q;
  730. };
  731. pageSchema.statics.updatePageProperty = function(page, updateData) {
  732. var Page = this;
  733. return new Promise(function(resolve, reject) {
  734. // TODO foreach して save
  735. Page.update({_id: page._id}, {$set: updateData}, function(err, data) {
  736. if (err) {
  737. return reject(err);
  738. }
  739. return resolve(data);
  740. });
  741. });
  742. };
  743. pageSchema.statics.updateGrant = function(page, grant, userData, grantUserGroupId) {
  744. var Page = this;
  745. return new Promise(function(resolve, reject) {
  746. if (grant == GRANT_USER_GROUP && grantUserGroupId == null) {
  747. reject('grant userGroupId is not specified');
  748. }
  749. page.grant = grant;
  750. if (grant == GRANT_PUBLIC || grant == GRANT_USER_GROUP) {
  751. page.grantedUsers = [];
  752. }
  753. else {
  754. page.grantedUsers = [];
  755. page.grantedUsers.push(userData._id);
  756. }
  757. page.save(function(err, data) {
  758. debug('Page.updateGrant, saved grantedUsers.', err, data);
  759. if (err) {
  760. return reject(err);
  761. }
  762. Page.updateGrantUserGroup(page, grant, grantUserGroupId, userData)
  763. .then(() => {
  764. return resolve(data);
  765. });
  766. });
  767. });
  768. };
  769. pageSchema.statics.updateGrantUserGroup = function(page, grant, grantUserGroupId, userData) {
  770. var UserGroupRelation = crowi.model('UserGroupRelation');
  771. var PageGroupRelation = crowi.model('PageGroupRelation');
  772. // グループの場合
  773. if (grant == GRANT_USER_GROUP) {
  774. debug('grant is usergroup', grantUserGroupId);
  775. return UserGroupRelation.findByGroupIdAndUser(grantUserGroupId, userData)
  776. .then((relation) => {
  777. if (relation == null) {
  778. return new Error('no relations were exist for group and user.');
  779. }
  780. return PageGroupRelation.findOrCreateRelationForPageAndGroup(page, relation.relatedGroup);
  781. })
  782. .catch((err) => {
  783. return new Error('No UserGroup is exists. userGroupId : ', grantUserGroupId);
  784. });
  785. }
  786. else {
  787. return PageGroupRelation.removeAllByPage(page);
  788. }
  789. };
  790. // Instance method でいいのでは
  791. pageSchema.statics.pushToGrantedUsers = function(page, userData) {
  792. return new Promise(function(resolve, reject) {
  793. if (!page.grantedUsers || !Array.isArray(page.grantedUsers)) {
  794. page.grantedUsers = [];
  795. }
  796. page.grantedUsers.push(userData);
  797. page.save(function(err, data) {
  798. if (err) {
  799. return reject(err);
  800. }
  801. return resolve(data);
  802. });
  803. });
  804. };
  805. pageSchema.statics.pushRevision = function(pageData, newRevision, user) {
  806. var isCreate = false;
  807. if (pageData.revision === undefined) {
  808. debug('pushRevision on Create');
  809. isCreate = true;
  810. }
  811. return new Promise(function(resolve, reject) {
  812. newRevision.save(function(err, newRevision) {
  813. if (err) {
  814. debug('Error on saving revision', err);
  815. return reject(err);
  816. }
  817. debug('Successfully saved new revision', newRevision);
  818. pageData.revision = newRevision;
  819. pageData.lastUpdateUser = user;
  820. pageData.updatedAt = Date.now();
  821. pageData.save(function(err, data) {
  822. if (err) {
  823. // todo: remove new revision?
  824. debug('Error on save page data (after push revision)', err);
  825. return reject(err);
  826. }
  827. resolve(data);
  828. if (!isCreate) {
  829. debug('pushRevision on Update');
  830. }
  831. });
  832. });
  833. });
  834. };
  835. pageSchema.statics.create = function(path, body, user, options) {
  836. var Page = this
  837. , Revision = crowi.model('Revision')
  838. , format = options.format || 'markdown'
  839. , grant = options.grant || GRANT_PUBLIC
  840. , redirectTo = options.redirectTo || null
  841. , grantUserGroupId = options.grantUserGroupId || null;
  842. // force public
  843. if (isPortalPath(path)) {
  844. grant = GRANT_PUBLIC;
  845. }
  846. let savedPage = undefined;
  847. return Page.findOne({path: path})
  848. .then(pageData => {
  849. if (pageData) {
  850. throw new Error('Cannot create new page to existed path');
  851. }
  852. var newPage = new Page();
  853. newPage.path = path;
  854. newPage.creator = user;
  855. newPage.lastUpdateUser = user;
  856. newPage.createdAt = Date.now();
  857. newPage.updatedAt = Date.now();
  858. newPage.redirectTo = redirectTo;
  859. newPage.grant = grant;
  860. newPage.status = STATUS_PUBLISHED;
  861. newPage.grantedUsers = [];
  862. newPage.grantedUsers.push(user);
  863. return newPage.save();
  864. })
  865. .then((newPage) => {
  866. savedPage = newPage;
  867. })
  868. .then(() => {
  869. const newRevision = Revision.prepareRevision(savedPage, body, user, {format: format});
  870. return Page.pushRevision(savedPage, newRevision, user);
  871. })
  872. .then(() => {
  873. return Page.updateGrantUserGroup(savedPage, grant, grantUserGroupId, user);
  874. })
  875. .then(() => {
  876. pageEvent.emit('create', savedPage, user);
  877. return savedPage;
  878. });
  879. };
  880. pageSchema.statics.updatePage = function(pageData, body, user, options) {
  881. var Page = this
  882. , Revision = crowi.model('Revision')
  883. , grant = options.grant || null
  884. , grantUserGroupId = options.grantUserGroupId || null
  885. ;
  886. // update existing page
  887. var newRevision = Revision.prepareRevision(pageData, body, user);
  888. let savedPage = undefined;
  889. return Page.pushRevision(pageData, newRevision, user)
  890. .then((revision) => {
  891. // fetch Page
  892. return Page.findPageByPath(revision.path).populate('revision');
  893. })
  894. .then((page) => {
  895. savedPage = page;
  896. })
  897. .then(() => {
  898. return Page.updateGrant(savedPage, grant, user, grantUserGroupId);
  899. })
  900. .then((data) => {
  901. debug('Page grant update:', data);
  902. pageEvent.emit('update', savedPage, user);
  903. return savedPage;
  904. });
  905. };
  906. pageSchema.statics.deletePage = function(pageData, user, options) {
  907. var Page = this
  908. , newPath = Page.getDeletedPageName(pageData.path)
  909. ;
  910. if (Page.isDeletableName(pageData.path)) {
  911. return Page.rename(pageData, newPath, user, {createRedirectPage: true})
  912. .then((updatedPageData) => {
  913. return Page.updatePageProperty(updatedPageData, {status: STATUS_DELETED, lastUpdateUser: user});
  914. })
  915. .then(() => {
  916. return pageData;
  917. });
  918. }
  919. else {
  920. return Promise.reject('Page is not deletable.');
  921. }
  922. };
  923. pageSchema.statics.deletePageRecursively = function(pageData, user, options) {
  924. var Page = this
  925. , path = pageData.path
  926. , options = options || {}
  927. ;
  928. return Page.generateQueryToListWithDescendants(path, user, options)
  929. .then(function(pages) {
  930. return Promise.all(pages.map(function(page) {
  931. return Page.deletePage(page, user, options);
  932. }));
  933. })
  934. .then(function(data) {
  935. return pageData;
  936. });
  937. };
  938. pageSchema.statics.revertDeletedPage = function(pageData, user, options) {
  939. var Page = this
  940. , newPath = Page.getRevertDeletedPageName(pageData.path)
  941. ;
  942. // 削除時、元ページの path には必ず redirectTo 付きで、ページが作成される。
  943. // そのため、そいつは削除してOK
  944. // が、redirectTo ではないページが存在している場合それは何かがおかしい。(データ補正が必要)
  945. return new Promise(function(resolve, reject) {
  946. Page.findPageByPath(newPath)
  947. .then(function(originPageData) {
  948. if (originPageData.redirectTo !== pageData.path) {
  949. throw new Error('The new page of to revert is exists and the redirect path of the page is not the deleted page.');
  950. }
  951. return Page.completelyDeletePage(originPageData);
  952. }).then(function(done) {
  953. return Page.updatePageProperty(pageData, {status: STATUS_PUBLISHED, lastUpdateUser: user});
  954. }).then(function(done) {
  955. pageData.status = STATUS_PUBLISHED;
  956. debug('Revert deleted the page, and rename again it', pageData, newPath);
  957. return Page.rename(pageData, newPath, user, {});
  958. }).then(function(done) {
  959. pageData.path = newPath;
  960. resolve(pageData);
  961. }).catch(reject);
  962. });
  963. };
  964. pageSchema.statics.revertDeletedPageRecursively = function(pageData, user, options) {
  965. var Page = this
  966. , path = pageData.path
  967. , options = options || { includeDeletedPage: true}
  968. ;
  969. return new Promise(function(resolve, reject) {
  970. Page
  971. .generateQueryToListWithDescendants(path, user, options)
  972. .exec()
  973. .then(function(pages) {
  974. Promise.all(pages.map(function(page) {
  975. return Page.revertDeletedPage(page, user, options);
  976. }))
  977. .then(function(data) {
  978. return resolve(data[0]);
  979. });
  980. });
  981. });
  982. };
  983. /**
  984. * This is danger.
  985. */
  986. pageSchema.statics.completelyDeletePage = function(pageData, user, options) {
  987. // Delete Bookmarks, Attachments, Revisions, Pages and emit delete
  988. var Bookmark = crowi.model('Bookmark')
  989. , Attachment = crowi.model('Attachment')
  990. , Comment = crowi.model('Comment')
  991. , Revision = crowi.model('Revision')
  992. , PageGroupRelation = crowi.model('PageGroupRelation')
  993. , Page = this
  994. , pageId = pageData._id
  995. ;
  996. debug('Completely delete', pageData.path);
  997. return new Promise(function(resolve, reject) {
  998. Bookmark.removeBookmarksByPageId(pageId)
  999. .then(function(done) {
  1000. }).then(function(done) {
  1001. return Attachment.removeAttachmentsByPageId(pageId);
  1002. }).then(function(done) {
  1003. return Comment.removeCommentsByPageId(pageId);
  1004. }).then(function(done) {
  1005. return Revision.removeRevisionsByPath(pageData.path);
  1006. }).then(function(done) {
  1007. return Page.removePageById(pageId);
  1008. }).then(function(done) {
  1009. return Page.removeRedirectOriginPageByPath(pageData.path);
  1010. }).then(function(done) {
  1011. return PageGroupRelation.removeAllByPage(pageData);
  1012. }).then(function(done) {
  1013. pageEvent.emit('delete', pageData, user); // update as renamed page
  1014. resolve(pageData);
  1015. }).catch(reject);
  1016. });
  1017. };
  1018. pageSchema.statics.completelyDeletePageRecursively = function(pageData, user, options) {
  1019. // Delete Bookmarks, Attachments, Revisions, Pages and emit delete
  1020. var Page = this
  1021. , path = pageData.path
  1022. , options = options || { includeDeletedPage: true }
  1023. ;
  1024. return new Promise(function(resolve, reject) {
  1025. Page
  1026. .generateQueryToListWithDescendants(path, user, options)
  1027. .then(function(pages) {
  1028. Promise.all(pages.map(function(page) {
  1029. return Page.completelyDeletePage(page, user, options);
  1030. }))
  1031. .then(function(data) {
  1032. return resolve(data[0]);
  1033. });
  1034. });
  1035. });
  1036. };
  1037. pageSchema.statics.removePageById = function(pageId) {
  1038. var Page = this;
  1039. return new Promise(function(resolve, reject) {
  1040. Page.remove({_id: pageId}, function(err, done) {
  1041. debug('Remove phisiaclly, the page', pageId, err, done);
  1042. if (err) {
  1043. return reject(err);
  1044. }
  1045. resolve(done);
  1046. });
  1047. });
  1048. };
  1049. pageSchema.statics.removePageByPath = function(pagePath) {
  1050. var Page = this;
  1051. return Page.findPageByPath(pagePath)
  1052. .then(function(pageData) {
  1053. return Page.removePageById(pageData.id);
  1054. });
  1055. };
  1056. /**
  1057. * remove the page that is redirecting to specified `pagePath` recursively
  1058. * ex: when
  1059. * '/page1' redirects to '/page2' and
  1060. * '/page2' redirects to '/page3'
  1061. * and given '/page3',
  1062. * '/page1' and '/page2' will be removed
  1063. *
  1064. * @param {string} pagePath
  1065. */
  1066. pageSchema.statics.removeRedirectOriginPageByPath = function(pagePath) {
  1067. var Page = this;
  1068. return Page.findPageByRedirectTo(pagePath)
  1069. .then((redirectOriginPageData) => {
  1070. // remove
  1071. return Page.removePageById(redirectOriginPageData.id)
  1072. // remove recursive
  1073. .then(() => {
  1074. return Page.removeRedirectOriginPageByPath(redirectOriginPageData.path);
  1075. });
  1076. })
  1077. .catch((err) => {
  1078. // do nothing if origin page doesn't exist
  1079. return Promise.resolve();
  1080. });
  1081. };
  1082. pageSchema.statics.rename = function(pageData, newPagePath, user, options) {
  1083. var Page = this
  1084. , Revision = crowi.model('Revision')
  1085. , path = pageData.path
  1086. , createRedirectPage = options.createRedirectPage || 0
  1087. , moveUnderTrees = options.moveUnderTrees || 0;
  1088. return Page.updatePageProperty(pageData, {updatedAt: Date.now(), path: newPagePath, lastUpdateUser: user}) // pageData の path を変更
  1089. .then((data) => {
  1090. // reivisions の path を変更
  1091. return Revision.updateRevisionListByPath(path, {path: newPagePath}, {});
  1092. })
  1093. .then(function(data) {
  1094. pageData.path = newPagePath;
  1095. if (createRedirectPage) {
  1096. var body = 'redirect ' + newPagePath;
  1097. Page.create(path, body, user, {redirectTo: newPagePath});
  1098. }
  1099. pageEvent.emit('update', pageData, user); // update as renamed page
  1100. return pageData;
  1101. });
  1102. };
  1103. pageSchema.statics.renameRecursively = function(pageData, newPagePathPrefix, user, options) {
  1104. var Page = this
  1105. , path = pageData.path
  1106. , pathRegExp = new RegExp('^' + escapeStringRegexp(path), 'i');
  1107. return Page.generateQueryToListWithDescendants(path, user, options)
  1108. .then(function(pages) {
  1109. return Promise.all(pages.map(function(page) {
  1110. const newPagePath = page.path.replace(pathRegExp, newPagePathPrefix);
  1111. return Page.rename(page, newPagePath, user, options);
  1112. }));
  1113. })
  1114. .then(function() {
  1115. pageData.path = newPagePathPrefix;
  1116. return pageData;
  1117. });
  1118. };
  1119. pageSchema.statics.getHistories = function() {
  1120. // TODO
  1121. return;
  1122. };
  1123. /**
  1124. * return path that added slash to the end for specified path
  1125. */
  1126. pageSchema.statics.addSlashOfEnd = function(path) {
  1127. let returnPath = path;
  1128. if (!path.match(/\/$/)) {
  1129. returnPath += '/';
  1130. }
  1131. return returnPath;
  1132. };
  1133. pageSchema.statics.GRANT_PUBLIC = GRANT_PUBLIC;
  1134. pageSchema.statics.GRANT_RESTRICTED = GRANT_RESTRICTED;
  1135. pageSchema.statics.GRANT_SPECIFIED = GRANT_SPECIFIED;
  1136. pageSchema.statics.GRANT_OWNER = GRANT_OWNER;
  1137. pageSchema.statics.PAGE_GRANT_ERROR = PAGE_GRANT_ERROR;
  1138. return mongoose.model('Page', pageSchema);
  1139. };