page.js 39 KB

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