page.js 36 KB

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