| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473 |
- import pathlib from 'path';
- import { Readable, Writable } from 'stream';
- import { pagePathUtils, pathUtils } from '@growi/core';
- import escapeStringRegexp from 'escape-string-regexp';
- import mongoose, { ObjectId, QueryCursor } from 'mongoose';
- import streamToPromise from 'stream-to-promise';
- import { SUPPORTED_TARGET_MODEL_TYPE, SUPPORTED_ACTION_TYPE } from '~/interfaces/activity';
- import { Ref } from '~/interfaces/common';
- import { V5ConversionErrCode } from '~/interfaces/errors/v5-conversion-error';
- import { HasObjectId } from '~/interfaces/has-object-id';
- import {
- IPage, IPageInfo, IPageInfoForEntity, IPageWithMeta,
- } from '~/interfaces/page';
- import {
- PageDeleteConfigValue, IPageDeleteConfigValueToProcessValidation,
- } from '~/interfaces/page-delete-config';
- import { IUserHasId } from '~/interfaces/user';
- import { PageMigrationErrorData, SocketEventName, UpdateDescCountRawData } from '~/interfaces/websocket';
- import { stringifySnapshot } from '~/models/serializers/in-app-notification-snapshot/page';
- import {
- CreateMethod, PageCreateOptions, PageModel, PageDocument, pushRevision,
- } from '~/server/models/page';
- import { createBatchStream } from '~/server/util/batch-stream';
- import loggerFactory from '~/utils/logger';
- import { prepareDeleteConfigValuesForCalc } from '~/utils/page-delete-config';
- import { ObjectIdLike } from '../interfaces/mongoose-utils';
- import { PathAlreadyExistsError } from '../models/errors';
- import PageOperation, { PageActionStage, PageActionType } from '../models/page-operation';
- import { PageRedirectModel } from '../models/page-redirect';
- import { serializePageSecurely } from '../models/serializers/page-serializer';
- import Subscription from '../models/subscription';
- import { V5ConversionError } from '../models/vo/v5-conversion-error';
- const debug = require('debug')('growi:services:page');
- const logger = loggerFactory('growi:services:page');
- const {
- isTrashPage, isTopPage, omitDuplicateAreaPageFromPages,
- collectAncestorPaths, isMovablePage, canMoveByPath,
- } = pagePathUtils;
- const { addTrailingSlash } = pathUtils;
- const BULK_REINDEX_SIZE = 100;
- const LIMIT_FOR_MULTIPLE_PAGE_OP = 20;
- // TODO: improve type
- class PageCursorsForDescendantsFactory {
- private user: any; // TODO: Typescriptize model
- private rootPage: any; // TODO: wait for mongoose update
- private shouldIncludeEmpty: boolean;
- private initialCursor: QueryCursor<any> | never[]; // TODO: wait for mongoose update
- private Page: PageModel;
- constructor(user: any, rootPage: any, shouldIncludeEmpty: boolean) {
- this.user = user;
- this.rootPage = rootPage;
- this.shouldIncludeEmpty = shouldIncludeEmpty;
- this.Page = mongoose.model('Page') as unknown as PageModel;
- }
- // prepare initial cursor
- private async init() {
- const initialCursor = await this.generateCursorToFindChildren(this.rootPage);
- this.initialCursor = initialCursor;
- }
- /**
- * Returns Iterable that yields only descendant pages unorderedly
- * @returns Promise<AsyncGenerator>
- */
- async generateIterable(): Promise<AsyncGenerator | never[]> {
- // initialize cursor
- await this.init();
- return this.isNeverArray(this.initialCursor) ? [] : this.generateOnlyDescendants(this.initialCursor);
- }
- /**
- * Returns Readable that produces only descendant pages unorderedly
- * @returns Promise<Readable>
- */
- async generateReadable(): Promise<Readable> {
- return Readable.from(await this.generateIterable());
- }
- /**
- * Generator that unorderedly yields descendant pages
- */
- private async* generateOnlyDescendants(cursor: QueryCursor<any>) {
- for await (const page of cursor) {
- const nextCursor = await this.generateCursorToFindChildren(page);
- if (!this.isNeverArray(nextCursor)) {
- yield* this.generateOnlyDescendants(nextCursor); // recursively yield
- }
- yield page;
- }
- }
- private async generateCursorToFindChildren(page: any): Promise<QueryCursor<any> | never[]> {
- if (page == null) {
- return [];
- }
- const { PageQueryBuilder } = this.Page;
- const builder = new PageQueryBuilder(this.Page.find(), this.shouldIncludeEmpty);
- builder.addConditionToFilteringByParentId(page._id);
- const cursor = builder.query.lean().cursor({ batchSize: BULK_REINDEX_SIZE }) as QueryCursor<any>;
- return cursor;
- }
- private isNeverArray(val: QueryCursor<any> | never[]): val is never[] {
- return 'length' in val && val.length === 0;
- }
- }
- class PageService {
- crowi: any;
- pageEvent: any;
- tagEvent: any;
- constructor(crowi) {
- this.crowi = crowi;
- this.pageEvent = crowi.event('page');
- this.tagEvent = crowi.event('tag');
- // init
- this.initPageEvent();
- }
- private initPageEvent() {
- // create
- this.pageEvent.on('create', this.pageEvent.onCreate);
- // createMany
- this.pageEvent.on('createMany', this.pageEvent.onCreateMany);
- this.pageEvent.on('addSeenUsers', this.pageEvent.onAddSeenUsers);
- // update
- this.pageEvent.on('update', async(page, user) => {
- this.pageEvent.onUpdate();
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_UPDATE);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // Change the parameter of the function into the pages
- // rename
- this.pageEvent.on('rename', async(page, descendantPages, user) => {
- const isRecursively = descendantPages != null;
- const action = isRecursively ? SUPPORTED_ACTION_TYPE.ACTION_PAGE_RECURSIVELY_RENAME : SUPPORTED_ACTION_TYPE.ACTION_PAGE_RENAME;
- try {
- await this.createAndSendNotifications(page, descendantPages, user, action);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // duplicate
- this.pageEvent.on('duplicate', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_DUPLICATE);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // delete
- this.pageEvent.on('delete', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_DELETE);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // delete completely
- this.pageEvent.on('deleteCompletely', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_DELETE_COMPLETELY);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // revert
- this.pageEvent.on('revert', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_REVERT);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // likes
- this.pageEvent.on('like', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_LIKE);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // bookmark
- this.pageEvent.on('bookmark', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, null, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_BOOKMARK);
- }
- catch (err) {
- logger.error(err);
- }
- });
- }
- canDeleteCompletely(creatorId: ObjectIdLike, operator, isRecursively: boolean): boolean {
- const pageCompleteDeletionAuthority = this.crowi.configManager.getConfig('crowi', 'security:pageCompleteDeletionAuthority');
- const pageRecursiveCompleteDeletionAuthority = this.crowi.configManager.getConfig('crowi', 'security:pageRecursiveCompleteDeletionAuthority');
- const [singleAuthority, recursiveAuthority] = prepareDeleteConfigValuesForCalc(pageCompleteDeletionAuthority, pageRecursiveCompleteDeletionAuthority);
- return this.canDeleteLogic(creatorId, operator, isRecursively, singleAuthority, recursiveAuthority);
- }
- canDelete(creatorId: ObjectIdLike, operator, isRecursively: boolean): boolean {
- const pageDeletionAuthority = this.crowi.configManager.getConfig('crowi', 'security:pageDeletionAuthority');
- const pageRecursiveDeletionAuthority = this.crowi.configManager.getConfig('crowi', 'security:pageRecursiveDeletionAuthority');
- const [singleAuthority, recursiveAuthority] = prepareDeleteConfigValuesForCalc(pageDeletionAuthority, pageRecursiveDeletionAuthority);
- return this.canDeleteLogic(creatorId, operator, isRecursively, singleAuthority, recursiveAuthority);
- }
- private canDeleteLogic(
- creatorId: ObjectIdLike,
- operator,
- isRecursively: boolean,
- authority: IPageDeleteConfigValueToProcessValidation | null,
- recursiveAuthority: IPageDeleteConfigValueToProcessValidation | null,
- ): boolean {
- const isAdmin = operator?.admin ?? false;
- const isOperator = operator?._id == null ? false : operator._id.equals(creatorId);
- if (isRecursively) {
- return this.compareDeleteConfig(isAdmin, isOperator, recursiveAuthority);
- }
- return this.compareDeleteConfig(isAdmin, isOperator, authority);
- }
- private compareDeleteConfig(isAdmin: boolean, isOperator: boolean, authority: IPageDeleteConfigValueToProcessValidation | null): boolean {
- if (isAdmin) {
- return true;
- }
- if (authority === PageDeleteConfigValue.Anyone || authority == null) {
- return true;
- }
- if (authority === PageDeleteConfigValue.AdminAndAuthor && isOperator) {
- return true;
- }
- return false;
- }
- filterPagesByCanDeleteCompletely(pages, user, isRecursively: boolean) {
- return pages.filter(p => p.isEmpty || this.canDeleteCompletely(p.creator, user, isRecursively));
- }
- filterPagesByCanDelete(pages, user, isRecursively: boolean) {
- return pages.filter(p => p.isEmpty || this.canDelete(p.creator, user, isRecursively));
- }
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
- async findPageAndMetaDataByViewer(pageId: string, path: string, user: IUserHasId, includeEmpty = false, isSharedPage = false): Promise<IPageWithMeta|null> {
- const Page = this.crowi.model('Page');
- let page: PageModel & PageDocument & HasObjectId;
- if (pageId != null) { // prioritized
- page = await Page.findByIdAndViewer(pageId, user, null, includeEmpty);
- }
- else {
- page = await Page.findByPathAndViewer(path, user, null, includeEmpty);
- }
- if (page == null) {
- return null;
- }
- if (isSharedPage) {
- return {
- data: page,
- meta: {
- isV5Compatible: isTopPage(page.path) || page.parent != null,
- isEmpty: page.isEmpty,
- isMovable: false,
- isDeletable: false,
- isAbleToDeleteCompletely: false,
- isRevertible: false,
- },
- };
- }
- const isGuestUser = user == null;
- const pageInfo = this.constructBasicPageInfo(page, isGuestUser);
- const Bookmark = this.crowi.model('Bookmark');
- const bookmarkCount = await Bookmark.countByPageId(pageId);
- const metadataForGuest = {
- ...pageInfo,
- bookmarkCount,
- };
- if (isGuestUser) {
- return {
- data: page,
- meta: metadataForGuest,
- };
- }
- const isBookmarked: boolean = (await Bookmark.findByPageIdAndUserId(pageId, user._id)) != null;
- const isLiked: boolean = page.isLiked(user);
- const isAbleToDeleteCompletely: boolean = this.canDeleteCompletely((page.creator as IUserHasId)?._id, user, false); // use normal delete config
- const subscription = await Subscription.findByUserIdAndTargetId(user._id, pageId);
- return {
- data: page,
- meta: {
- ...metadataForGuest,
- isAbleToDeleteCompletely,
- isBookmarked,
- isLiked,
- subscriptionStatus: subscription?.status,
- },
- };
- }
- private shouldUseV4Process(page): boolean {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const isTrashPage = page.status === Page.STATUS_DELETED;
- const isPageMigrated = page.parent != null;
- const isV5Compatible = this.crowi.configManager.getConfig('crowi', 'app:isV5Compatible');
- const isRoot = isTopPage(page.path);
- const isPageRestricted = page.grant === Page.GRANT_RESTRICTED;
- const shouldUseV4Process = !isRoot && (!isV5Compatible || !isPageMigrated || isTrashPage || isPageRestricted);
- return shouldUseV4Process;
- }
- private shouldUseV4ProcessForRevert(page): boolean {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const isV5Compatible = this.crowi.configManager.getConfig('crowi', 'app:isV5Compatible');
- const isPageRestricted = page.grant === Page.GRANT_RESTRICTED;
- const shouldUseV4Process = !isV5Compatible || isPageRestricted;
- return shouldUseV4Process;
- }
- private shouldNormalizeParent(page): boolean {
- const Page = mongoose.model('Page') as unknown as PageModel;
- return page.grant !== Page.GRANT_RESTRICTED && page.grant !== Page.GRANT_SPECIFIED;
- }
- /**
- * Generate read stream to operate descendants of the specified page path
- * @param {string} targetPagePath
- * @param {User} viewer
- */
- private async generateReadStreamToOperateOnlyDescendants(targetPagePath, userToOperate) {
- const Page = this.crowi.model('Page');
- const { PageQueryBuilder } = Page;
- const builder = new PageQueryBuilder(Page.find(), true)
- .addConditionAsNotMigrated() // to avoid affecting v5 pages
- .addConditionToListOnlyDescendants(targetPagePath);
- await Page.addConditionToFilteringByViewerToEdit(builder, userToOperate);
- return builder
- .query
- .lean()
- .cursor({ batchSize: BULK_REINDEX_SIZE });
- }
- async renamePage(page, newPagePath, user, options) {
- /*
- * Common Operation
- */
- const Page = mongoose.model('Page') as unknown as PageModel;
- const isExist = await Page.exists({ path: newPagePath });
- if (isExist) {
- throw Error(`Page already exists at ${newPagePath}`);
- }
- if (isTopPage(page.path)) {
- throw Error('It is forbidden to rename the top page');
- }
- // Separate v4 & v5 process
- const shouldUseV4Process = this.shouldUseV4Process(page);
- if (shouldUseV4Process) {
- return this.renamePageV4(page, newPagePath, user, options);
- }
- if (options.isMoveMode) {
- const fromPath = page.path;
- const toPath = newPagePath;
- const canMove = canMoveByPath(fromPath, toPath) && await Page.exists({ path: newPagePath });
- if (!canMove) {
- throw Error('Cannot move to this path.');
- }
- }
- const canOperate = await this.crowi.pageOperationService.canOperate(true, page.path, newPagePath);
- if (!canOperate) {
- throw Error(`Cannot operate rename to path "${newPagePath}" right now.`);
- }
- /*
- * Resumable Operation
- */
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.Rename,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- toPath: newPagePath,
- options,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- const renamedPage = await this.renameMainOperation(page, newPagePath, user, options, pageOp._id);
- return renamedPage;
- }
- async renameMainOperation(page, newPagePath: string, user, options, pageOpId: ObjectIdLike) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const updateMetadata = options.updateMetadata || false;
- // sanitize path
- newPagePath = this.crowi.xss.process(newPagePath); // eslint-disable-line no-param-reassign
- // UserGroup & Owner validation
- // use the parent's grant when target page is an empty page
- let grant;
- let grantedUserIds;
- let grantedGroupId;
- if (page.isEmpty) {
- const parent = await Page.findOne({ _id: page.parent });
- if (parent == null) {
- throw Error('parent not found');
- }
- grant = parent.grant;
- grantedUserIds = parent.grantedUsers;
- grantedGroupId = parent.grantedGroup;
- }
- else {
- grant = page.grant;
- grantedUserIds = page.grantedUsers;
- grantedGroupId = page.grantedGroup;
- }
- if (grant !== Page.GRANT_RESTRICTED) {
- let isGrantNormalized = false;
- try {
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, newPagePath, grant, grantedUserIds, grantedGroupId, false);
- }
- catch (err) {
- logger.error(`Failed to validate grant of page at "${newPagePath}" when renaming`, err);
- throw err;
- }
- if (!isGrantNormalized) {
- throw Error(`This page cannot be renamed to "${newPagePath}" since the selected grant or grantedGroup is not assignable to this page.`);
- }
- }
- // 1. Take target off from tree
- await Page.takeOffFromTree(page._id);
- // 2. Find new parent
- let newParent;
- // If renaming to under target, run getParentAndforceCreateEmptyTree to fill new ancestors
- if (this.isRenamingToUnderTarget(page.path, newPagePath)) {
- newParent = await this.getParentAndforceCreateEmptyTree(page, newPagePath);
- }
- else {
- newParent = await this.getParentAndFillAncestorsByUser(user, newPagePath);
- }
- // 3. Put back target page to tree (also update the other attrs)
- const update: Partial<IPage> = {};
- update.path = newPagePath;
- update.parent = newParent._id;
- if (updateMetadata) {
- update.lastUpdateUser = user;
- update.updatedAt = new Date();
- }
- const renamedPage = await Page.findByIdAndUpdate(page._id, { $set: update }, { new: true });
- this.pageEvent.emit('rename', page, null, user);
- // create page redirect
- if (options.createRedirectPage) {
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- await PageRedirect.create({ fromPath: page.path, toPath: newPagePath });
- }
- // Set to Sub
- const pageOp = await PageOperation.findByIdAndUpdatePageActionStage(pageOpId, PageActionStage.Sub);
- if (pageOp == null) {
- throw Error('PageOperation document not found');
- }
- /*
- * Sub Operation
- */
- this.renameSubOperation(page, newPagePath, user, options, renamedPage, pageOp._id);
- return renamedPage;
- }
- async renameSubOperation(page, newPagePath: string, user, options, renamedPage, pageOpId: ObjectIdLike): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const exParentId = page.parent;
- // update descendants first
- await this.renameDescendantsWithStream(page, newPagePath, user, options, false);
- // reduce ancestore's descendantCount
- const nToReduce = -1 * ((page.isEmpty ? 0 : 1) + page.descendantCount);
- await this.updateDescendantCountOfAncestors(exParentId, nToReduce, true);
- // increase ancestore's descendantCount
- const nToIncrease = (renamedPage.isEmpty ? 0 : 1) + page.descendantCount;
- await this.updateDescendantCountOfAncestors(renamedPage._id, nToIncrease, false);
- // Remove leaf empty pages if not moving to under the ex-target position
- if (!this.isRenamingToUnderTarget(page.path, newPagePath)) {
- // remove empty pages at leaf position
- await Page.removeLeafEmptyPagesRecursively(page.parent);
- }
- await PageOperation.findByIdAndDelete(pageOpId);
- }
- private isRenamingToUnderTarget(fromPath: string, toPath: string): boolean {
- const pathToTest = escapeStringRegexp(addTrailingSlash(fromPath));
- const pathToBeTested = toPath;
- return (new RegExp(`^${pathToTest}`, 'i')).test(pathToBeTested);
- }
- private async getParentAndforceCreateEmptyTree(originalPage, toPath: string) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const fromPath = originalPage.path;
- const newParentPath = pathlib.dirname(toPath);
- // local util
- const collectAncestorPathsUntilFromPath = (path: string, paths: string[] = []): string[] => {
- if (path === fromPath) return paths;
- const parentPath = pathlib.dirname(path);
- paths.push(parentPath);
- return collectAncestorPathsUntilFromPath(parentPath, paths);
- };
- const pathsToInsert = collectAncestorPathsUntilFromPath(toPath);
- const originalParent = await Page.findById(originalPage.parent);
- if (originalParent == null) {
- throw Error('Original parent not found');
- }
- const insertedPages = await Page.insertMany(pathsToInsert.map((path) => {
- return {
- path,
- isEmpty: true,
- };
- }));
- const pages = [...insertedPages, originalParent];
- const ancestorsMap = new Map<string, PageDocument & {_id: any}>(pages.map(p => [p.path, p]));
- // bulkWrite to update ancestors
- const operations = insertedPages.map((page) => {
- const parentPath = pathlib.dirname(page.path);
- const op = {
- updateOne: {
- filter: {
- _id: page._id,
- },
- update: {
- $set: {
- parent: ancestorsMap.get(parentPath)?._id,
- descedantCount: originalParent.descendantCount,
- },
- },
- },
- };
- return op;
- });
- await Page.bulkWrite(operations);
- const newParent = ancestorsMap.get(newParentPath);
- return newParent;
- }
- private async renamePageV4(page, newPagePath, user, options) {
- const Page = this.crowi.model('Page');
- const Revision = this.crowi.model('Revision');
- const {
- isRecursively = false,
- createRedirectPage = false,
- updateMetadata = false,
- } = options;
- // sanitize path
- newPagePath = this.crowi.xss.process(newPagePath); // eslint-disable-line no-param-reassign
- // create descendants first
- if (isRecursively) {
- await this.renameDescendantsWithStream(page, newPagePath, user, options);
- }
- const update: any = {};
- // update Page
- update.path = newPagePath;
- if (updateMetadata) {
- update.lastUpdateUser = user;
- update.updatedAt = Date.now();
- }
- const renamedPage = await Page.findByIdAndUpdate(page._id, { $set: update }, { new: true });
- // update Rivisions
- await Revision.updateRevisionListByPageId(renamedPage._id, { pageId: renamedPage._id });
- if (createRedirectPage) {
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- await PageRedirect.create({ fromPath: page.path, toPath: newPagePath });
- }
- this.pageEvent.emit('rename', page, null, user);
- return renamedPage;
- }
- private async renameDescendants(pages, user, options, oldPagePathPrefix, newPagePathPrefix, shouldUseV4Process = true) {
- // v4 compatible process
- if (shouldUseV4Process) {
- return this.renameDescendantsV4(pages, user, options, oldPagePathPrefix, newPagePathPrefix);
- }
- const Page = mongoose.model('Page') as unknown as PageModel;
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const { updateMetadata, createRedirectPage } = options;
- const updatePathOperations: any[] = [];
- const insertPageRedirectOperations: any[] = [];
- pages.forEach((page) => {
- const newPagePath = page.path.replace(oldPagePathPrefix, newPagePathPrefix);
- // increment updatePathOperations
- let update;
- if (!page.isEmpty && updateMetadata) {
- update = {
- $set: { path: newPagePath, lastUpdateUser: user._id, updatedAt: new Date() },
- };
- }
- else {
- update = {
- $set: { path: newPagePath },
- };
- }
- if (!page.isEmpty && createRedirectPage) {
- // insert PageRedirect
- insertPageRedirectOperations.push({
- insertOne: {
- document: {
- fromPath: page.path,
- toPath: newPagePath,
- },
- },
- });
- }
- updatePathOperations.push({
- updateOne: {
- filter: {
- _id: page._id,
- },
- update,
- },
- });
- });
- try {
- await Page.bulkWrite(updatePathOperations);
- }
- catch (err) {
- if (err.code !== 11000) {
- throw new Error(`Failed to rename pages: ${err}`);
- }
- }
- try {
- await PageRedirect.bulkWrite(insertPageRedirectOperations);
- }
- catch (err) {
- if (err.code !== 11000) {
- throw Error(`Failed to create PageRedirect documents: ${err}`);
- }
- }
- this.pageEvent.emit('updateMany', pages, user);
- }
- private async renameDescendantsV4(pages, user, options, oldPagePathPrefix, newPagePathPrefix) {
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const pageCollection = mongoose.connection.collection('pages');
- const { updateMetadata, createRedirectPage } = options;
- const unorderedBulkOp = pageCollection.initializeUnorderedBulkOp();
- const insertPageRedirectOperations: any[] = [];
- pages.forEach((page) => {
- const newPagePath = page.path.replace(oldPagePathPrefix, newPagePathPrefix);
- if (updateMetadata) {
- unorderedBulkOp
- .find({ _id: page._id })
- .update({ $set: { path: newPagePath, lastUpdateUser: user._id, updatedAt: new Date() } });
- }
- else {
- unorderedBulkOp.find({ _id: page._id }).update({ $set: { path: newPagePath } });
- }
- // insert PageRedirect
- if (!page.isEmpty && createRedirectPage) {
- insertPageRedirectOperations.push({
- insertOne: {
- document: {
- fromPath: page.path,
- toPath: newPagePath,
- },
- },
- });
- }
- });
- try {
- await unorderedBulkOp.execute();
- }
- catch (err) {
- if (err.code !== 11000) {
- throw new Error(`Failed to rename pages: ${err}`);
- }
- }
- try {
- await PageRedirect.bulkWrite(insertPageRedirectOperations);
- }
- catch (err) {
- if (err.code !== 11000) {
- throw Error(`Failed to create PageRedirect documents: ${err}`);
- }
- }
- this.pageEvent.emit('updateMany', pages, user);
- }
- private async renameDescendantsWithStream(targetPage, newPagePath, user, options = {}, shouldUseV4Process = true) {
- // v4 compatible process
- if (shouldUseV4Process) {
- return this.renameDescendantsWithStreamV4(targetPage, newPagePath, user, options);
- }
- const factory = new PageCursorsForDescendantsFactory(user, targetPage, true);
- const readStream = await factory.generateReadable();
- const newPagePathPrefix = newPagePath;
- const pathRegExp = new RegExp(`^${escapeStringRegexp(targetPage.path)}`, 'i');
- const renameDescendants = this.renameDescendants.bind(this);
- const pageEvent = this.pageEvent;
- let count = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- await renameDescendants(
- batch, user, options, pathRegExp, newPagePathPrefix, shouldUseV4Process,
- );
- pageEvent.emit('rename', targetPage, batch, user);
- logger.debug(`Renaming pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('Renaming error on add anyway: ', err);
- }
- callback();
- },
- async final(callback) {
- logger.debug(`Renaming pages has completed: (totalCount=${count})`);
- // update path
- targetPage.path = newPagePath;
- pageEvent.emit('syncDescendantsUpdate', targetPage, user);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- }
- private async renameDescendantsWithStreamV4(targetPage, newPagePath, user, options = {}) {
- const readStream = await this.generateReadStreamToOperateOnlyDescendants(targetPage.path, user);
- const newPagePathPrefix = newPagePath;
- const pathRegExp = new RegExp(`^${escapeStringRegexp(targetPage.path)}`, 'i');
- const renameDescendants = this.renameDescendants.bind(this);
- const pageEvent = this.pageEvent;
- let count = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- await renameDescendants(batch, user, options, pathRegExp, newPagePathPrefix);
- logger.debug(`Renaming pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('renameDescendants error on add anyway: ', err);
- }
- callback();
- },
- final(callback) {
- logger.debug(`Renaming pages has completed: (totalCount=${count})`);
- // update path
- targetPage.path = newPagePath;
- pageEvent.emit('syncDescendantsUpdate', targetPage, user);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- }
- /*
- * Duplicate
- */
- async duplicate(page, newPagePath, user, isRecursively) {
- /*
- * Common Operation
- */
- const isEmptyAndNotRecursively = page?.isEmpty && !isRecursively;
- if (page == null || isEmptyAndNotRecursively) {
- throw new Error('Cannot find or duplicate the empty page');
- }
- const Page = mongoose.model('Page') as unknown as PageModel;
- const PageTagRelation = mongoose.model('PageTagRelation') as any; // TODO: Typescriptize model
- if (!isRecursively && page.isEmpty) {
- throw Error('Page not found.');
- }
- newPagePath = this.crowi.xss.process(newPagePath); // eslint-disable-line no-param-reassign
- // 1. Separate v4 & v5 process
- const shouldUseV4Process = this.shouldUseV4Process(page);
- if (shouldUseV4Process) {
- return this.duplicateV4(page, newPagePath, user, isRecursively);
- }
- const canOperate = await this.crowi.pageOperationService.canOperate(isRecursively, page.path, newPagePath);
- if (!canOperate) {
- throw Error(`Cannot operate duplicate to path "${newPagePath}" right now.`);
- }
- // 2. UserGroup & Owner validation
- // use the parent's grant when target page is an empty page
- let grant;
- let grantedUserIds;
- let grantedGroupId;
- if (page.isEmpty) {
- const parent = await Page.findOne({ _id: page.parent });
- if (parent == null) {
- throw Error('parent not found');
- }
- grant = parent.grant;
- grantedUserIds = parent.grantedUsers;
- grantedGroupId = parent.grantedGroup;
- }
- else {
- grant = page.grant;
- grantedUserIds = page.grantedUsers;
- grantedGroupId = page.grantedGroup;
- }
- if (grant !== Page.GRANT_RESTRICTED) {
- let isGrantNormalized = false;
- try {
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, newPagePath, grant, grantedUserIds, grantedGroupId, false);
- }
- catch (err) {
- logger.error(`Failed to validate grant of page at "${newPagePath}" when duplicating`, err);
- throw err;
- }
- if (!isGrantNormalized) {
- throw Error(`This page cannot be duplicated to "${newPagePath}" since the selected grant or grantedGroup is not assignable to this page.`);
- }
- }
- // copy & populate (reason why copy: SubOperation only allows non-populated page document)
- const copyPage = { ...page };
- // 3. Duplicate target
- const options: PageCreateOptions = {
- grant: page.grant,
- grantUserGroupId: page.grantedGroup,
- };
- let duplicatedTarget;
- if (page.isEmpty) {
- const parent = await this.getParentAndFillAncestorsByUser(user, newPagePath);
- duplicatedTarget = await Page.createEmptyPage(newPagePath, parent);
- }
- else {
- await page.populate({ path: 'revision', model: 'Revision', select: 'body' });
- duplicatedTarget = await (this.create as CreateMethod)(
- newPagePath, page.revision.body, user, options,
- );
- }
- this.pageEvent.emit('duplicate', page, user);
- // 4. Take over tags
- const originTags = await page.findRelatedTagsById();
- let savedTags = [];
- if (originTags.length !== 0) {
- await PageTagRelation.updatePageTags(duplicatedTarget._id, originTags);
- savedTags = await PageTagRelation.listTagNamesByPage(duplicatedTarget._id);
- this.tagEvent.emit('update', duplicatedTarget, savedTags);
- }
- if (isRecursively) {
- /*
- * Resumable Operation
- */
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.Duplicate,
- actionStage: PageActionStage.Main,
- page: copyPage,
- user,
- fromPath: page.path,
- toPath: newPagePath,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- this.duplicateRecursivelyMainOperation(page, newPagePath, user, pageOp._id);
- }
- const result = serializePageSecurely(duplicatedTarget);
- result.tags = savedTags;
- return result;
- }
- async duplicateRecursivelyMainOperation(page, newPagePath: string, user, pageOpId: ObjectIdLike): Promise<void> {
- const nDuplicatedPages = await this.duplicateDescendantsWithStream(page, newPagePath, user, false);
- // normalize parent of descendant pages
- const shouldNormalize = this.shouldNormalizeParent(page);
- if (shouldNormalize) {
- try {
- await this.normalizeParentAndDescendantCountOfDescendants(newPagePath, user);
- logger.info(`Successfully normalized duplicated descendant pages under "${newPagePath}"`);
- }
- catch (err) {
- logger.error('Failed to normalize descendants afrer duplicate:', err);
- throw err;
- }
- }
- // Set to Sub
- const pageOp = await PageOperation.findByIdAndUpdatePageActionStage(pageOpId, PageActionStage.Sub);
- if (pageOp == null) {
- throw Error('PageOperation document not found');
- }
- /*
- * Sub Operation
- */
- await this.duplicateRecursivelySubOperation(newPagePath, nDuplicatedPages, pageOp._id);
- }
- async duplicateRecursivelySubOperation(newPagePath: string, nDuplicatedPages: number, pageOpId: ObjectIdLike): Promise<void> {
- const Page = mongoose.model('Page');
- const newTarget = await Page.findOne({ path: newPagePath }); // only one page will be found since duplicating to existing path is forbidden
- if (newTarget == null) {
- throw Error('No duplicated page found. Something might have gone wrong in duplicateRecursivelyMainOperation.');
- }
- await this.updateDescendantCountOfAncestors(newTarget._id, nDuplicatedPages, false);
- await PageOperation.findByIdAndDelete(pageOpId);
- }
- async duplicateV4(page, newPagePath, user, isRecursively) {
- const PageTagRelation = mongoose.model('PageTagRelation') as any; // TODO: Typescriptize model
- // populate
- await page.populate({ path: 'revision', model: 'Revision', select: 'body' });
- // create option
- const options: any = { page };
- options.grant = page.grant;
- options.grantUserGroupId = page.grantedGroup;
- options.grantedUserIds = page.grantedUsers;
- newPagePath = this.crowi.xss.process(newPagePath); // eslint-disable-line no-param-reassign
- const createdPage = await this.crowi.pageService.create(
- newPagePath, page.revision.body, user, options,
- );
- this.pageEvent.emit('duplicate', page, user);
- if (isRecursively) {
- this.duplicateDescendantsWithStream(page, newPagePath, user);
- }
- // take over tags
- const originTags = await page.findRelatedTagsById();
- let savedTags = [];
- if (originTags != null) {
- await PageTagRelation.updatePageTags(createdPage.id, originTags);
- savedTags = await PageTagRelation.listTagNamesByPage(createdPage.id);
- this.tagEvent.emit('update', createdPage, savedTags);
- }
- const result = serializePageSecurely(createdPage);
- result.tags = savedTags;
- return result;
- }
- /**
- * Receive the object with oldPageId and newPageId and duplicate the tags from oldPage to newPage
- * @param {Object} pageIdMapping e.g. key: oldPageId, value: newPageId
- */
- private async duplicateTags(pageIdMapping) {
- const PageTagRelation = mongoose.model('PageTagRelation');
- // convert pageId from string to ObjectId
- const pageIds = Object.keys(pageIdMapping);
- const stage = { $or: pageIds.map((pageId) => { return { relatedPage: new mongoose.Types.ObjectId(pageId) } }) };
- const pagesAssociatedWithTag = await PageTagRelation.aggregate([
- {
- $match: stage,
- },
- {
- $group: {
- _id: '$relatedTag',
- relatedPages: { $push: '$relatedPage' },
- },
- },
- ]);
- const newPageTagRelation: any[] = [];
- pagesAssociatedWithTag.forEach(({ _id, relatedPages }) => {
- // relatedPages
- relatedPages.forEach((pageId) => {
- newPageTagRelation.push({
- relatedPage: pageIdMapping[pageId], // newPageId
- relatedTag: _id,
- });
- });
- });
- return PageTagRelation.insertMany(newPageTagRelation, { ordered: false });
- }
- private async duplicateDescendants(pages, user, oldPagePathPrefix, newPagePathPrefix, shouldUseV4Process = true) {
- if (shouldUseV4Process) {
- return this.duplicateDescendantsV4(pages, user, oldPagePathPrefix, newPagePathPrefix);
- }
- const Page = this.crowi.model('Page');
- const Revision = this.crowi.model('Revision');
- const pageIds = pages.map(page => page._id);
- const revisions = await Revision.find({ pageId: { $in: pageIds } });
- // Mapping to set to the body of the new revision
- const pageIdRevisionMapping = {};
- revisions.forEach((revision) => {
- pageIdRevisionMapping[revision.pageId] = revision;
- });
- // key: oldPageId, value: newPageId
- const pageIdMapping = {};
- const newPages: any[] = [];
- const newRevisions: any[] = [];
- // no need to save parent here
- pages.forEach((page) => {
- const newPageId = new mongoose.Types.ObjectId();
- const newPagePath = page.path.replace(oldPagePathPrefix, newPagePathPrefix);
- const revisionId = new mongoose.Types.ObjectId();
- pageIdMapping[page._id] = newPageId;
- let newPage;
- if (!page.isEmpty) {
- newPage = {
- _id: newPageId,
- path: newPagePath,
- creator: user._id,
- grant: page.grant,
- grantedGroup: page.grantedGroup,
- grantedUsers: page.grantedUsers,
- lastUpdateUser: user._id,
- revision: revisionId,
- };
- newRevisions.push({
- _id: revisionId, pageId: newPageId, body: pageIdRevisionMapping[page._id].body, author: user._id, format: 'markdown',
- });
- }
- newPages.push(newPage);
- });
- await Page.insertMany(newPages, { ordered: false });
- await Revision.insertMany(newRevisions, { ordered: false });
- await this.duplicateTags(pageIdMapping);
- }
- private async duplicateDescendantsV4(pages, user, oldPagePathPrefix, newPagePathPrefix) {
- const Page = this.crowi.model('Page');
- const Revision = this.crowi.model('Revision');
- const pageIds = pages.map(page => page._id);
- const revisions = await Revision.find({ pageId: { $in: pageIds } });
- // Mapping to set to the body of the new revision
- const pageIdRevisionMapping = {};
- revisions.forEach((revision) => {
- pageIdRevisionMapping[revision.pageId] = revision;
- });
- // key: oldPageId, value: newPageId
- const pageIdMapping = {};
- const newPages: any[] = [];
- const newRevisions: any[] = [];
- pages.forEach((page) => {
- const newPageId = new mongoose.Types.ObjectId();
- const newPagePath = page.path.replace(oldPagePathPrefix, newPagePathPrefix);
- const revisionId = new mongoose.Types.ObjectId();
- pageIdMapping[page._id] = newPageId;
- newPages.push({
- _id: newPageId,
- path: newPagePath,
- creator: user._id,
- grant: page.grant,
- grantedGroup: page.grantedGroup,
- grantedUsers: page.grantedUsers,
- lastUpdateUser: user._id,
- revision: revisionId,
- });
- newRevisions.push({
- _id: revisionId, pageId: newPageId, body: pageIdRevisionMapping[page._id].body, author: user._id, format: 'markdown',
- });
- });
- await Page.insertMany(newPages, { ordered: false });
- await Revision.insertMany(newRevisions, { ordered: false });
- await this.duplicateTags(pageIdMapping);
- }
- private async duplicateDescendantsWithStream(page, newPagePath, user, shouldUseV4Process = true) {
- if (shouldUseV4Process) {
- return this.duplicateDescendantsWithStreamV4(page, newPagePath, user);
- }
- const iterableFactory = new PageCursorsForDescendantsFactory(user, page, true);
- const readStream = await iterableFactory.generateReadable();
- const newPagePathPrefix = newPagePath;
- const pathRegExp = new RegExp(`^${escapeStringRegexp(page.path)}`, 'i');
- const duplicateDescendants = this.duplicateDescendants.bind(this);
- const pageEvent = this.pageEvent;
- let count = 0;
- let nNonEmptyDuplicatedPages = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- nNonEmptyDuplicatedPages += batch.filter(page => !page.isEmpty).length;
- await duplicateDescendants(batch, user, pathRegExp, newPagePathPrefix, shouldUseV4Process);
- logger.debug(`Adding pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('addAllPages error on add anyway: ', err);
- }
- callback();
- },
- async final(callback) {
- logger.debug(`Adding pages has completed: (totalCount=${count})`);
- // update path
- page.path = newPagePath;
- pageEvent.emit('syncDescendantsUpdate', page, user);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- return nNonEmptyDuplicatedPages;
- }
- private async duplicateDescendantsWithStreamV4(page, newPagePath, user) {
- const readStream = await this.generateReadStreamToOperateOnlyDescendants(page.path, user);
- const newPagePathPrefix = newPagePath;
- const pathRegExp = new RegExp(`^${escapeStringRegexp(page.path)}`, 'i');
- const duplicateDescendants = this.duplicateDescendants.bind(this);
- const pageEvent = this.pageEvent;
- let count = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- await duplicateDescendants(batch, user, pathRegExp, newPagePathPrefix);
- logger.debug(`Adding pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('addAllPages error on add anyway: ', err);
- }
- callback();
- },
- final(callback) {
- logger.debug(`Adding pages has completed: (totalCount=${count})`);
- // update path
- page.path = newPagePath;
- pageEvent.emit('syncDescendantsUpdate', page, user);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- return count;
- }
- /*
- * Delete
- */
- async deletePage(page, user, options = {}, isRecursively = false) {
- /*
- * Common Operation
- */
- const Page = mongoose.model('Page') as PageModel;
- // Separate v4 & v5 process
- const shouldUseV4Process = this.shouldUseV4Process(page);
- if (shouldUseV4Process) {
- return this.deletePageV4(page, user, options, isRecursively);
- }
- // Validate
- if (page.isEmpty && !isRecursively) {
- throw Error('Page not found.');
- }
- const isTrashed = isTrashPage(page.path);
- if (isTrashed) {
- throw new Error('This method does NOT support deleting trashed pages.');
- }
- if (!isMovablePage(page.path)) {
- throw new Error('Page is not deletable.');
- }
- const newPath = Page.getDeletedPageName(page.path);
- const canOperate = await this.crowi.pageOperationService.canOperate(isRecursively, page.path, newPath);
- if (!canOperate) {
- throw Error(`Cannot operate delete to path "${newPath}" right now.`);
- }
- // Replace with an empty page
- const isChildrenExist = await Page.exists({ parent: page._id });
- const shouldReplace = !isRecursively && isChildrenExist;
- if (shouldReplace) {
- await Page.replaceTargetWithPage(page, null, true);
- }
- // Delete target
- let deletedPage;
- if (!page.isEmpty) {
- deletedPage = await this.deleteNonEmptyTarget(page, user);
- }
- else { // always recursive
- deletedPage = page;
- await this.deleteEmptyTarget(page);
- }
- // 1. Update descendantCount
- if (isRecursively) {
- const inc = page.isEmpty ? -page.descendantCount : -(page.descendantCount + 1);
- await this.updateDescendantCountOfAncestors(page.parent, inc, true);
- }
- else {
- // update descendantCount of ancestors'
- await this.updateDescendantCountOfAncestors(page.parent, -1, true);
- }
- // 2. Delete leaf empty pages
- await Page.removeLeafEmptyPagesRecursively(page.parent);
- if (isRecursively) {
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.Delete,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- toPath: newPath,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- /*
- * Resumable Operation
- */
- this.deleteRecursivelyMainOperation(page, user, pageOp._id);
- }
- return deletedPage;
- }
- private async deleteNonEmptyTarget(page, user) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const PageTagRelation = mongoose.model('PageTagRelation') as any; // TODO: Typescriptize model
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const newPath = Page.getDeletedPageName(page.path);
- const deletedPage = await Page.findByIdAndUpdate(page._id, {
- $set: {
- path: newPath, status: Page.STATUS_DELETED, deleteUser: user._id, deletedAt: Date.now(), parent: null, descendantCount: 0, // set parent as null
- },
- }, { new: true });
- await PageTagRelation.updateMany({ relatedPage: page._id }, { $set: { isPageTrashed: true } });
- try {
- await PageRedirect.create({ fromPath: page.path, toPath: newPath });
- }
- catch (err) {
- if (err.code !== 11000) {
- throw err;
- }
- }
- this.pageEvent.emit('delete', page, user);
- this.pageEvent.emit('create', deletedPage, user);
- return deletedPage;
- }
- private async deleteEmptyTarget(page): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- await Page.deleteOne({ _id: page._id, isEmpty: true });
- // update descendantCount of ancestors' before removeLeafEmptyPages
- await this.updateDescendantCountOfAncestors(page._id, -page.descendantCount, false);
- }
- async deleteRecursivelyMainOperation(page, user, pageOpId: ObjectIdLike): Promise<void> {
- await this.deleteDescendantsWithStream(page, user, false);
- await PageOperation.findByIdAndDelete(pageOpId);
- // no sub operation available
- }
- private async deletePageV4(page, user, options = {}, isRecursively = false) {
- const Page = mongoose.model('Page') as PageModel;
- const PageTagRelation = mongoose.model('PageTagRelation') as any; // TODO: Typescriptize model
- const Revision = mongoose.model('Revision') as any; // TODO: Typescriptize model
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const newPath = Page.getDeletedPageName(page.path);
- const isTrashed = isTrashPage(page.path);
- if (isTrashed) {
- throw new Error('This method does NOT support deleting trashed pages.');
- }
- if (!isMovablePage(page.path)) {
- throw new Error('Page is not deletable.');
- }
- if (isRecursively) {
- this.deleteDescendantsWithStream(page, user);
- }
- // update Revisions
- await Revision.updateRevisionListByPageId(page._id, { pageId: page._id });
- const deletedPage = await Page.findByIdAndUpdate(page._id, {
- $set: {
- path: newPath, status: Page.STATUS_DELETED, deleteUser: user._id, deletedAt: Date.now(),
- },
- }, { new: true });
- await PageTagRelation.updateMany({ relatedPage: page._id }, { $set: { isPageTrashed: true } });
- try {
- await PageRedirect.create({ fromPath: page.path, toPath: newPath });
- }
- catch (err) {
- if (err.code !== 11000) {
- throw err;
- }
- }
- this.pageEvent.emit('delete', page, user);
- this.pageEvent.emit('create', deletedPage, user);
- return deletedPage;
- }
- private async deleteDescendants(pages, user) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const deletePageOperations: any[] = [];
- const insertPageRedirectOperations: any[] = [];
- pages.forEach((page) => {
- const newPath = Page.getDeletedPageName(page.path);
- let operation;
- // if empty, delete completely
- if (page.isEmpty) {
- operation = {
- deleteOne: {
- filter: { _id: page._id },
- },
- };
- }
- // if not empty, set parent to null and update to trash
- else {
- operation = {
- updateOne: {
- filter: { _id: page._id },
- update: {
- $set: {
- path: newPath, status: Page.STATUS_DELETED, deleteUser: user._id, deletedAt: Date.now(), parent: null, descendantCount: 0, // set parent as null
- },
- },
- },
- };
- insertPageRedirectOperations.push({
- insertOne: {
- document: {
- fromPath: page.path,
- toPath: newPath,
- },
- },
- });
- }
- deletePageOperations.push(operation);
- });
- try {
- await Page.bulkWrite(deletePageOperations);
- }
- catch (err) {
- if (err.code !== 11000) {
- throw new Error(`Failed to delete pages: ${err}`);
- }
- }
- finally {
- this.pageEvent.emit('syncDescendantsDelete', pages, user);
- }
- try {
- await PageRedirect.bulkWrite(insertPageRedirectOperations);
- }
- catch (err) {
- if (err.code !== 11000) {
- throw Error(`Failed to create PageRedirect documents: ${err}`);
- }
- }
- }
- /**
- * Create delete stream and return deleted document count
- */
- private async deleteDescendantsWithStream(targetPage, user, shouldUseV4Process = true): Promise<number> {
- let readStream;
- if (shouldUseV4Process) {
- readStream = await this.generateReadStreamToOperateOnlyDescendants(targetPage.path, user);
- }
- else {
- const factory = new PageCursorsForDescendantsFactory(user, targetPage, true);
- readStream = await factory.generateReadable();
- }
- const deleteDescendants = this.deleteDescendants.bind(this);
- let count = 0;
- let nDeletedNonEmptyPages = 0; // used for updating descendantCount
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- nDeletedNonEmptyPages += batch.filter(d => !d.isEmpty).length;
- try {
- count += batch.length;
- await deleteDescendants(batch, user);
- logger.debug(`Deleting pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('deleteDescendants error on add anyway: ', err);
- }
- callback();
- },
- final(callback) {
- logger.debug(`Deleting pages has completed: (totalCount=${count})`);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- return nDeletedNonEmptyPages;
- }
- private async deleteCompletelyOperation(pageIds, pagePaths) {
- // Delete Bookmarks, Attachments, Revisions, Pages and emit delete
- const Bookmark = this.crowi.model('Bookmark');
- const Comment = this.crowi.model('Comment');
- const Page = this.crowi.model('Page');
- const PageTagRelation = this.crowi.model('PageTagRelation');
- const ShareLink = this.crowi.model('ShareLink');
- const Revision = this.crowi.model('Revision');
- const Attachment = this.crowi.model('Attachment');
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const { attachmentService } = this.crowi;
- const attachments = await Attachment.find({ page: { $in: pageIds } });
- return Promise.all([
- Bookmark.deleteMany({ page: { $in: pageIds } }),
- Comment.deleteMany({ page: { $in: pageIds } }),
- PageTagRelation.deleteMany({ relatedPage: { $in: pageIds } }),
- ShareLink.deleteMany({ relatedPage: { $in: pageIds } }),
- Revision.deleteMany({ pageId: { $in: pageIds } }),
- Page.deleteMany({ _id: { $in: pageIds } }),
- PageRedirect.deleteMany({ $or: [{ fromPath: { $in: pagePaths } }, { toPath: { $in: pagePaths } }] }),
- attachmentService.removeAllAttachments(attachments),
- ]);
- }
- // delete multiple pages
- private async deleteMultipleCompletely(pages, user, options = {}) {
- const ids = pages.map(page => (page._id));
- const paths = pages.map(page => (page.path));
- logger.debug('Deleting completely', paths);
- await this.deleteCompletelyOperation(ids, paths);
- this.pageEvent.emit('syncDescendantsDelete', pages, user); // update as renamed page
- return;
- }
- async deleteCompletely(page, user, options = {}, isRecursively = false, preventEmitting = false) {
- /*
- * Common Operation
- */
- const Page = mongoose.model('Page') as PageModel;
- if (isTopPage(page.path)) {
- throw Error('It is forbidden to delete the top page');
- }
- if (page.isEmpty && !isRecursively) {
- throw Error('Page not found.');
- }
- // v4 compatible process
- const shouldUseV4Process = this.shouldUseV4Process(page);
- if (shouldUseV4Process) {
- return this.deleteCompletelyV4(page, user, options, isRecursively, preventEmitting);
- }
- const canOperate = await this.crowi.pageOperationService.canOperate(isRecursively, page.path, null);
- if (!canOperate) {
- throw Error(`Cannot operate deleteCompletely from path "${page.path}" right now.`);
- }
- const ids = [page._id];
- const paths = [page.path];
- logger.debug('Deleting completely', paths);
- // 1. update descendantCount
- if (isRecursively) {
- const inc = page.isEmpty ? -page.descendantCount : -(page.descendantCount + 1);
- await this.updateDescendantCountOfAncestors(page.parent, inc, true);
- }
- else {
- // replace with an empty page
- const shouldReplace = await Page.exists({ parent: page._id });
- let pageToUpdateDescendantCount = page;
- if (shouldReplace) {
- pageToUpdateDescendantCount = await Page.replaceTargetWithPage(page);
- }
- await this.updateDescendantCountOfAncestors(pageToUpdateDescendantCount.parent, -1, true);
- }
- // 2. then delete target completely
- await this.deleteCompletelyOperation(ids, paths);
- // delete leaf empty pages
- await Page.removeLeafEmptyPagesRecursively(page.parent);
- if (!page.isEmpty && !preventEmitting) {
- this.pageEvent.emit('deleteCompletely', page, user);
- }
- if (isRecursively) {
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.DeleteCompletely,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- options,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- /*
- * Main Operation
- */
- this.deleteCompletelyRecursivelyMainOperation(page, user, options, pageOp._id);
- }
- return;
- }
- async deleteCompletelyRecursivelyMainOperation(page, user, options, pageOpId: ObjectIdLike): Promise<void> {
- await this.deleteCompletelyDescendantsWithStream(page, user, options, false);
- await PageOperation.findByIdAndDelete(pageOpId);
- // no sub operation available
- }
- private async deleteCompletelyV4(page, user, options = {}, isRecursively = false, preventEmitting = false) {
- const ids = [page._id];
- const paths = [page.path];
- logger.debug('Deleting completely', paths);
- await this.deleteCompletelyOperation(ids, paths);
- if (isRecursively) {
- this.deleteCompletelyDescendantsWithStream(page, user, options);
- }
- if (!page.isEmpty && !preventEmitting) {
- this.pageEvent.emit('deleteCompletely', page, user);
- }
- return;
- }
- async emptyTrashPage(user, options = {}) {
- return this.deleteCompletelyDescendantsWithStream({ path: '/trash' }, user, options);
- }
- /**
- * Create delete completely stream
- */
- private async deleteCompletelyDescendantsWithStream(targetPage, user, options = {}, shouldUseV4Process = true): Promise<number> {
- let readStream;
- if (shouldUseV4Process) { // pages don't have parents
- readStream = await this.generateReadStreamToOperateOnlyDescendants(targetPage.path, user);
- }
- else {
- const factory = new PageCursorsForDescendantsFactory(user, targetPage, true);
- readStream = await factory.generateReadable();
- }
- let count = 0;
- let nDeletedNonEmptyPages = 0; // used for updating descendantCount
- const deleteMultipleCompletely = this.deleteMultipleCompletely.bind(this);
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- nDeletedNonEmptyPages += batch.filter(d => !d.isEmpty).length;
- try {
- count += batch.length;
- await deleteMultipleCompletely(batch, user, options);
- logger.debug(`Adding pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('addAllPages error on add anyway: ', err);
- }
- callback();
- },
- final(callback) {
- logger.debug(`Adding pages has completed: (totalCount=${count})`);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- return nDeletedNonEmptyPages;
- }
- // no need to separate Main Sub since it is devided into single page operations
- async deleteMultiplePages(pagesToDelete, user, options): Promise<void> {
- const { isRecursively, isCompletely } = options;
- if (pagesToDelete.length > LIMIT_FOR_MULTIPLE_PAGE_OP) {
- throw Error(`The maximum number of pages is ${LIMIT_FOR_MULTIPLE_PAGE_OP}.`);
- }
- // omit duplicate paths if isRecursively true, omit empty pages if isRecursively false
- const pages = isRecursively ? omitDuplicateAreaPageFromPages(pagesToDelete) : pagesToDelete.filter(p => !p.isEmpty);
- if (isCompletely) {
- for await (const page of pages) {
- await this.deleteCompletely(page, user, {}, isRecursively);
- }
- }
- else {
- for await (const page of pages) {
- await this.deletePage(page, user, {}, isRecursively);
- }
- }
- }
- // use the same process in both v4 and v5
- private async revertDeletedDescendants(pages, user) {
- const Page = this.crowi.model('Page');
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- const revertPageOperations: any[] = [];
- const fromPathsToDelete: string[] = [];
- pages.forEach((page) => {
- // e.g. page.path = /trash/test, toPath = /test
- const toPath = Page.getRevertDeletedPageName(page.path);
- revertPageOperations.push({
- updateOne: {
- filter: { _id: page._id },
- update: {
- $set: {
- path: toPath, status: Page.STATUS_PUBLISHED, lastUpdateUser: user._id, deleteUser: null, deletedAt: null,
- },
- },
- },
- });
- fromPathsToDelete.push(page.path);
- });
- try {
- await Page.bulkWrite(revertPageOperations);
- await PageRedirect.deleteMany({ fromPath: { $in: fromPathsToDelete } });
- }
- catch (err) {
- if (err.code !== 11000) {
- throw new Error(`Failed to revert pages: ${err}`);
- }
- }
- }
- async revertDeletedPage(page, user, options = {}, isRecursively = false) {
- /*
- * Common Operation
- */
- const Page = this.crowi.model('Page');
- const PageTagRelation = this.crowi.model('PageTagRelation');
- // 1. Separate v4 & v5 process
- const shouldUseV4Process = this.shouldUseV4ProcessForRevert(page);
- if (shouldUseV4Process) {
- return this.revertDeletedPageV4(page, user, options, isRecursively);
- }
- const newPath = Page.getRevertDeletedPageName(page.path);
- const canOperate = await this.crowi.pageOperationService.canOperate(isRecursively, page.path, newPath);
- if (!canOperate) {
- throw Error(`Cannot operate revert from path "${page.path}" right now.`);
- }
- const includeEmpty = true;
- const originPage = await Page.findByPath(newPath, includeEmpty);
- // throw if any page already exists
- if (originPage != null) {
- throw new PathAlreadyExistsError('already_exists', originPage.path);
- }
- // 2. Revert target
- const parent = await this.getParentAndFillAncestorsByUser(user, newPath);
- const updatedPage = await Page.findByIdAndUpdate(page._id, {
- $set: {
- path: newPath, status: Page.STATUS_PUBLISHED, lastUpdateUser: user._id, deleteUser: null, deletedAt: null, parent: parent._id, descendantCount: 0,
- },
- }, { new: true });
- await PageTagRelation.updateMany({ relatedPage: page._id }, { $set: { isPageTrashed: false } });
- this.pageEvent.emit('revert', page, user);
- if (!isRecursively) {
- await this.updateDescendantCountOfAncestors(parent._id, 1, true);
- }
- else {
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.Revert,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- toPath: newPath,
- options,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- /*
- * Resumable Operation
- */
- this.revertRecursivelyMainOperation(page, user, options, pageOp._id);
- }
- return updatedPage;
- }
- async revertRecursivelyMainOperation(page, user, options, pageOpId: ObjectIdLike): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- await this.revertDeletedDescendantsWithStream(page, user, options, false);
- const newPath = Page.getRevertDeletedPageName(page.path);
- // normalize parent of descendant pages
- const shouldNormalize = this.shouldNormalizeParent(page);
- if (shouldNormalize) {
- try {
- await this.normalizeParentAndDescendantCountOfDescendants(newPath, user);
- logger.info(`Successfully normalized reverted descendant pages under "${newPath}"`);
- }
- catch (err) {
- logger.error('Failed to normalize descendants afrer revert:', err);
- throw err;
- }
- }
- // Set to Sub
- const pageOp = await PageOperation.findByIdAndUpdatePageActionStage(pageOpId, PageActionStage.Sub);
- if (pageOp == null) {
- throw Error('PageOperation document not found');
- }
- /*
- * Sub Operation
- */
- await this.revertRecursivelySubOperation(newPath, pageOp._id);
- }
- async revertRecursivelySubOperation(newPath: string, pageOpId: ObjectIdLike): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const newTarget = await Page.findOne({ path: newPath }); // only one page will be found since duplicating to existing path is forbidden
- if (newTarget == null) {
- throw Error('No reverted page found. Something might have gone wrong in revertRecursivelyMainOperation.');
- }
- // update descendantCount of ancestors'
- await this.updateDescendantCountOfAncestors(newTarget.parent as ObjectIdLike, newTarget.descendantCount + 1, true);
- await PageOperation.findByIdAndDelete(pageOpId);
- }
- private async revertDeletedPageV4(page, user, options = {}, isRecursively = false) {
- const Page = this.crowi.model('Page');
- const PageTagRelation = this.crowi.model('PageTagRelation');
- const newPath = Page.getRevertDeletedPageName(page.path);
- const originPage = await Page.findByPath(newPath);
- if (originPage != null) {
- throw new PathAlreadyExistsError('already_exists', originPage.path);
- }
- if (isRecursively) {
- this.revertDeletedDescendantsWithStream(page, user, options);
- }
- page.status = Page.STATUS_PUBLISHED;
- page.lastUpdateUser = user;
- debug('Revert deleted the page', page, newPath);
- const updatedPage = await Page.findByIdAndUpdate(page._id, {
- $set: {
- path: newPath, status: Page.STATUS_PUBLISHED, lastUpdateUser: user._id, deleteUser: null, deletedAt: null,
- },
- }, { new: true });
- await PageTagRelation.updateMany({ relatedPage: page._id }, { $set: { isPageTrashed: false } });
- this.pageEvent.emit('revert', page, user);
- return updatedPage;
- }
- /**
- * Create revert stream
- */
- private async revertDeletedDescendantsWithStream(targetPage, user, options = {}, shouldUseV4Process = true): Promise<number> {
- if (shouldUseV4Process) {
- return this.revertDeletedDescendantsWithStreamV4(targetPage, user, options);
- }
- const readStream = await this.generateReadStreamToOperateOnlyDescendants(targetPage.path, user);
- const revertDeletedDescendants = this.revertDeletedDescendants.bind(this);
- let count = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- await revertDeletedDescendants(batch, user);
- logger.debug(`Reverting pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('revertPages error on add anyway: ', err);
- }
- callback();
- },
- async final(callback) {
- logger.debug(`Reverting pages has completed: (totalCount=${count})`);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(writeStream);
- return count;
- }
- private async revertDeletedDescendantsWithStreamV4(targetPage, user, options = {}) {
- const readStream = await this.generateReadStreamToOperateOnlyDescendants(targetPage.path, user);
- const revertDeletedDescendants = this.revertDeletedDescendants.bind(this);
- let count = 0;
- const writeStream = new Writable({
- objectMode: true,
- async write(batch, encoding, callback) {
- try {
- count += batch.length;
- await revertDeletedDescendants(batch, user);
- logger.debug(`Reverting pages progressing: (count=${count})`);
- }
- catch (err) {
- logger.error('revertPages error on add anyway: ', err);
- }
- callback();
- },
- final(callback) {
- logger.debug(`Reverting pages has completed: (totalCount=${count})`);
- callback();
- },
- });
- readStream
- .pipe(createBatchStream(BULK_REINDEX_SIZE))
- .pipe(writeStream);
- await streamToPromise(readStream);
- return count;
- }
- async handlePrivatePagesForGroupsToDelete(groupsToDelete, action, transferToUserGroupId, user) {
- const Page = this.crowi.model('Page');
- const pages = await Page.find({ grantedGroup: { $in: groupsToDelete } });
- switch (action) {
- case 'public':
- await Page.publicizePages(pages);
- break;
- case 'delete':
- return this.deleteMultipleCompletely(pages, user);
- case 'transfer':
- await Page.transferPagesToGroup(pages, transferToUserGroupId);
- break;
- default:
- throw new Error('Unknown action for private pages');
- }
- }
- private extractStringIds(refs: Ref<HasObjectId>[]) {
- return refs.map((ref: Ref<HasObjectId>) => {
- return (typeof ref === 'string') ? ref : ref._id.toString();
- });
- }
- constructBasicPageInfo(page: IPage, isGuestUser?: boolean): IPageInfo | IPageInfoForEntity {
- const isMovable = isGuestUser ? false : isMovablePage(page.path);
- if (page.isEmpty) {
- return {
- isV5Compatible: true,
- isEmpty: true,
- isMovable,
- isDeletable: false,
- isAbleToDeleteCompletely: false,
- isRevertible: false,
- };
- }
- const likers = page.liker.slice(0, 15) as Ref<IUserHasId>[];
- const seenUsers = page.seenUsers.slice(0, 15) as Ref<IUserHasId>[];
- return {
- isV5Compatible: isTopPage(page.path) || page.parent != null,
- isEmpty: false,
- sumOfLikers: page.liker.length,
- likerIds: this.extractStringIds(likers),
- seenUserIds: this.extractStringIds(seenUsers),
- sumOfSeenUsers: page.seenUsers.length,
- isMovable,
- isDeletable: isMovable,
- isAbleToDeleteCompletely: false,
- isRevertible: isTrashPage(page.path),
- };
- }
- async shortBodiesMapByPageIds(pageIds: ObjectId[] = [], user): Promise<Record<string, string | null>> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const MAX_LENGTH = 350;
- // aggregation options
- let userGroups;
- if (user != null && userGroups == null) {
- const UserGroupRelation = mongoose.model('UserGroupRelation') as any; // Typescriptize model
- userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user);
- }
- const viewerCondition = Page.generateGrantCondition(user, userGroups);
- const filterByIds = {
- _id: { $in: pageIds },
- };
- let pages;
- try {
- pages = await Page
- .aggregate([
- // filter by pageIds
- {
- $match: filterByIds,
- },
- // filter by viewer
- {
- $match: viewerCondition,
- },
- // lookup: https://docs.mongodb.com/v4.4/reference/operator/aggregation/lookup/
- {
- $lookup: {
- from: 'revisions',
- let: { localRevision: '$revision' },
- pipeline: [
- {
- $match: {
- $expr: {
- $eq: ['$_id', '$$localRevision'],
- },
- },
- },
- {
- $project: {
- // What is $substrCP?
- // see: https://stackoverflow.com/questions/43556024/mongodb-error-substrbytes-invalid-range-ending-index-is-in-the-middle-of-a-ut/43556249
- revision: { $substrCP: ['$body', 0, MAX_LENGTH] },
- },
- },
- ],
- as: 'revisionData',
- },
- },
- // projection
- {
- $project: {
- _id: 1,
- revisionData: 1,
- },
- },
- ]).exec();
- }
- catch (err) {
- logger.error('Error occurred while generating shortBodiesMap');
- throw err;
- }
- const shortBodiesMap = {};
- pages.forEach((page) => {
- shortBodiesMap[page._id] = page.revisionData?.[0]?.revision;
- });
- return shortBodiesMap;
- }
- private async createAndSendNotifications(page, descendantPages, user, action) {
- const { activityService, inAppNotificationService } = this.crowi;
- const snapshot = stringifySnapshot(page);
- // Create activity
- const parameters = {
- user: user._id,
- targetModel: SUPPORTED_TARGET_MODEL_TYPE.MODEL_PAGE,
- target: page,
- action,
- };
- const activity = await activityService.createByParameters(parameters);
- // Get user to be notified
- let targetUsers = await activity.getNotificationTargetUsers();
- if (descendantPages != null) {
- const targetDescendantsUsers = await Subscription.getSubscriptions(descendantPages);
- targetUsers = targetUsers.concat(targetDescendantsUsers.filter(item => (item.toString() !== user._id.toString())));
- }
- // Create and send notifications
- await inAppNotificationService.upsertByActivity(targetUsers, activity, snapshot);
- await inAppNotificationService.emitSocketIo(targetUsers);
- }
- async normalizeParentByPath(path: string, user): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- // This validation is not 100% correct since it ignores user to count
- const builder = new PageQueryBuilder(Page.find());
- builder.addConditionAsNotMigrated();
- builder.addConditionToListWithDescendants(path);
- const nEstimatedNormalizationTarget: number = await builder.query.exec('count');
- if (nEstimatedNormalizationTarget === 0) {
- throw Error('No page is available for conversion');
- }
- const pages = await Page.findByPathAndViewer(path, user, null, false);
- if (pages == null || !Array.isArray(pages)) {
- throw Error('Something went wrong while converting pages.');
- }
- if (pages.length === 0) {
- const isForbidden = await Page.count({ path, isEmpty: false }) > 0;
- if (isForbidden) {
- throw new V5ConversionError('It is not allowed to convert this page.', V5ConversionErrCode.FORBIDDEN);
- }
- }
- if (pages.length > 1) {
- throw new V5ConversionError(
- `There are more than two pages at the path "${path}". Please rename or delete the page first.`,
- V5ConversionErrCode.DUPLICATE_PAGES_FOUND,
- );
- }
- let page;
- let systematicallyCreatedPage;
- const shouldCreateNewPage = pages[0] == null;
- if (shouldCreateNewPage) {
- const notEmptyParent = await Page.findNotEmptyParentByPathRecursively(path);
- const options: PageCreateOptions & { grantedUsers?: ObjectIdLike[] | undefined } = {
- grant: notEmptyParent.grant,
- grantUserGroupId: notEmptyParent.grantedGroup,
- grantedUsers: notEmptyParent.grantedUsers,
- };
- systematicallyCreatedPage = await this.forceCreateBySystem(
- path,
- '',
- options,
- );
- page = systematicallyCreatedPage;
- }
- else {
- page = pages[0];
- }
- const grant = page.grant;
- const grantedUserIds = page.grantedUsers;
- const grantedGroupId = page.grantedGroup;
- /*
- * UserGroup & Owner validation
- */
- let isGrantNormalized = false;
- try {
- const shouldCheckDescendants = true;
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, path, grant, grantedUserIds, grantedGroupId, shouldCheckDescendants);
- }
- catch (err) {
- logger.error(`Failed to validate grant of page at "${path}"`, err);
- throw err;
- }
- if (!isGrantNormalized) {
- throw new V5ConversionError(
- 'This page cannot be migrated since the selected grant or grantedGroup is not assignable to this page.',
- V5ConversionErrCode.GRANT_INVALID,
- );
- }
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.NormalizeParent,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- toPath: page.path,
- });
- }
- catch (err) {
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- this.normalizeParentRecursivelyMainOperation(page, user, pageOp._id);
- }
- async normalizeParentByPageIdsRecursively(pageIds: ObjectIdLike[], user): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const pages = await Page.findByIdsAndViewer(pageIds, user, null);
- if (pages == null || pages.length === 0) {
- throw Error('pageIds is null or 0 length.');
- }
- if (pages.length > LIMIT_FOR_MULTIPLE_PAGE_OP) {
- throw Error(`The maximum number of pageIds allowed is ${LIMIT_FOR_MULTIPLE_PAGE_OP}.`);
- }
- this.normalizeParentRecursivelyByPages(pages, user);
- return;
- }
- async normalizeParentByPageIds(pageIds: ObjectIdLike[], user): Promise<void> {
- const Page = await mongoose.model('Page') as unknown as PageModel;
- const socket = this.crowi.socketIoService.getDefaultSocket();
- for await (const pageId of pageIds) {
- const page = await Page.findById(pageId);
- if (page == null) {
- continue;
- }
- const errorData: PageMigrationErrorData = { paths: [page.path] };
- try {
- const canOperate = await this.crowi.pageOperationService.canOperate(false, page.path, page.path);
- if (!canOperate) {
- throw Error(`Cannot operate normalizeParent to path "${page.path}" right now.`);
- }
- const normalizedPage = await this.normalizeParentByPage(page, user);
- if (normalizedPage == null) {
- socket.emit(SocketEventName.PageMigrationError, errorData);
- logger.error(`Failed to update descendantCount of page of id: "${pageId}"`);
- }
- }
- catch (err) {
- socket.emit(SocketEventName.PageMigrationError, errorData);
- logger.error('Something went wrong while normalizing parent.', err);
- }
- }
- socket.emit(SocketEventName.PageMigrationSuccess);
- }
- private async normalizeParentByPage(page, user) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const {
- path, grant, grantedUsers: grantedUserIds, grantedGroup: grantedGroupId,
- } = page;
- // check if any page exists at target path already
- const existingPage = await Page.findOne({ path, parent: { $ne: null } });
- if (existingPage != null && !existingPage.isEmpty) {
- throw Error('Page already exists. Please rename the page to continue.');
- }
- /*
- * UserGroup & Owner validation
- */
- if (grant !== Page.GRANT_RESTRICTED) {
- let isGrantNormalized = false;
- try {
- const shouldCheckDescendants = true;
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, path, grant, grantedUserIds, grantedGroupId, shouldCheckDescendants);
- }
- catch (err) {
- logger.error(`Failed to validate grant of page at "${path}"`, err);
- throw err;
- }
- if (!isGrantNormalized) {
- throw Error('This page cannot be migrated since the selected grant or grantedGroup is not assignable to this page.');
- }
- }
- else {
- throw Error('Restricted pages can not be migrated');
- }
- let normalizedPage;
- // replace if empty page exists
- if (existingPage != null && existingPage.isEmpty) {
- // Inherit descendantCount from the empty page
- const updatedPage = await Page.findOneAndUpdate({ _id: page._id }, { descendantCount: existingPage.descendantCount }, { new: true });
- await Page.replaceTargetWithPage(existingPage, updatedPage, true);
- normalizedPage = await Page.findById(page._id);
- }
- else {
- const parent = await this.getParentAndFillAncestorsByUser(user, page.path);
- normalizedPage = await Page.findOneAndUpdate({ _id: page._id }, { parent: parent._id }, { new: true });
- }
- // Update descendantCount
- const inc = 1;
- await this.updateDescendantCountOfAncestors(normalizedPage.parent, inc, true);
- return normalizedPage;
- }
- async normalizeParentRecursivelyByPages(pages, user): Promise<void> {
- /*
- * Main Operation
- */
- const socket = this.crowi.socketIoService.getDefaultSocket();
- const pagesToNormalize = omitDuplicateAreaPageFromPages(pages);
- let normalizablePages;
- let nonNormalizablePages;
- try {
- [normalizablePages, nonNormalizablePages] = await this.crowi.pageGrantService.separateNormalizableAndNotNormalizablePages(user, pagesToNormalize);
- }
- catch (err) {
- socket.emit(SocketEventName.PageMigrationError);
- throw err;
- }
- if (normalizablePages.length === 0) {
- socket.emit(SocketEventName.PageMigrationError);
- return;
- }
- if (nonNormalizablePages.length !== 0) {
- const nonNormalizablePagePaths: string[] = nonNormalizablePages.map(p => p.path);
- socket.emit(SocketEventName.PageMigrationError, { paths: nonNormalizablePagePaths });
- logger.debug('Some pages could not be converted.', nonNormalizablePagePaths);
- }
- /*
- * Main Operation (s)
- */
- const errorPagePaths: string[] = [];
- for await (const page of normalizablePages) {
- const canOperate = await this.crowi.pageOperationService.canOperate(true, page.path, page.path);
- if (!canOperate) {
- errorPagePaths.push(page.path);
- throw Error(`Cannot operate normalizeParentRecursiively to path "${page.path}" right now.`);
- }
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- const builder = new PageQueryBuilder(Page.findOne());
- builder.addConditionAsOnTree();
- builder.addConditionToListByPathsArray([page.path]);
- const existingPage = await builder.query.exec();
- if (existingPage?.parent != null) {
- errorPagePaths.push(page.path);
- throw Error('This page has already converted.');
- }
- let pageOp;
- try {
- pageOp = await PageOperation.create({
- actionType: PageActionType.NormalizeParent,
- actionStage: PageActionStage.Main,
- page,
- user,
- fromPath: page.path,
- toPath: page.path,
- });
- }
- catch (err) {
- errorPagePaths.push(page.path);
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- try {
- await this.normalizeParentRecursivelyMainOperation(page, user, pageOp._id);
- }
- catch (err) {
- errorPagePaths.push(page.path);
- logger.err('Failed to run normalizeParentRecursivelyMainOperation.', err);
- throw err;
- }
- }
- if (errorPagePaths.length === 0) {
- socket.emit(SocketEventName.PageMigrationSuccess);
- }
- else {
- socket.emit(SocketEventName.PageMigrationError, { paths: errorPagePaths });
- }
- }
- async normalizeParentRecursivelyMainOperation(page, user, pageOpId: ObjectIdLike): Promise<number> {
- // Save prevDescendantCount for sub-operation
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- const builder = new PageQueryBuilder(Page.findOne(), true);
- builder.addConditionAsOnTree();
- builder.addConditionToListByPathsArray([page.path]);
- const exPage = await builder.query.exec();
- const options = { prevDescendantCount: exPage?.descendantCount ?? 0 };
- let count: number;
- try {
- count = await this.normalizeParentRecursively([page.path], user);
- }
- catch (err) {
- logger.error('V5 initial miration failed.', err);
- // socket.emit('normalizeParentRecursivelyByPageIds', { error: err.message }); TODO: use socket to tell user
- throw err;
- }
- // Set to Sub
- const pageOp = await PageOperation.findByIdAndUpdatePageActionStage(pageOpId, PageActionStage.Sub);
- if (pageOp == null) {
- throw Error('PageOperation document not found');
- }
- await this.normalizeParentRecursivelySubOperation(page, user, pageOp._id, options);
- return count;
- }
- async normalizeParentRecursivelySubOperation(page, user, pageOpId: ObjectIdLike, options: {prevDescendantCount: number}): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- try {
- // update descendantCount of self and descendant pages first
- await this.updateDescendantCountOfSelfAndDescendants(page.path);
- // find pages again to get updated descendantCount
- // then calculate inc
- const pageAfterUpdatingDescendantCount = await Page.findByIdAndViewer(page._id, user);
- if (pageAfterUpdatingDescendantCount == null) {
- throw Error('Page not found after updating descendantCount');
- }
- const { prevDescendantCount } = options;
- const newDescendantCount = pageAfterUpdatingDescendantCount.descendantCount;
- let inc = newDescendantCount - prevDescendantCount;
- const isAlreadyConverted = page.parent != null;
- if (!isAlreadyConverted) {
- inc += 1;
- }
- await this.updateDescendantCountOfAncestors(page._id, inc, false);
- }
- catch (err) {
- logger.error('Failed to update descendantCount after normalizing parent:', err);
- throw Error(`Failed to update descendantCount after normalizing parent: ${err}`);
- }
- await PageOperation.findByIdAndDelete(pageOpId);
- }
- async _isPagePathIndexUnique() {
- const Page = this.crowi.model('Page');
- const now = (new Date()).toString();
- const path = `growi_check_is_path_index_unique_${now}`;
- let isUnique = false;
- try {
- await Page.insertMany([
- { path },
- { path },
- ]);
- }
- catch (err) {
- if (err?.code === 11000) { // Error code 11000 indicates the index is unique
- isUnique = true;
- logger.info('Page path index is unique.');
- }
- else {
- throw err;
- }
- }
- finally {
- await Page.deleteMany({ path: { $regex: new RegExp('growi_check_is_path_index_unique', 'g') } });
- }
- return isUnique;
- }
- // TODO: use socket to send status to the client
- async normalizeAllPublicPages() {
- // const socket = this.crowi.socketIoService.getAdminSocket();
- let isUnique;
- try {
- isUnique = await this._isPagePathIndexUnique();
- }
- catch (err) {
- logger.error('Failed to check path index status', err);
- throw err;
- }
- // drop unique index first
- if (isUnique) {
- try {
- await this._v5NormalizeIndex();
- }
- catch (err) {
- logger.error('V5 index normalization failed.', err);
- // socket.emit('v5IndexNormalizationFailed', { error: err.message });
- throw err;
- }
- }
- // then migrate
- try {
- await this.normalizeParentRecursively(['/'], null);
- }
- catch (err) {
- logger.error('V5 initial miration failed.', err);
- // socket.emit('v5InitialMirationFailed', { error: err.message });
- throw err;
- }
- // update descendantCount of all public pages
- try {
- await this.updateDescendantCountOfSelfAndDescendants('/');
- logger.info('Successfully updated all descendantCount of public pages.');
- }
- catch (err) {
- logger.error('Failed updating descendantCount of public pages.', err);
- throw err;
- }
- await this._setIsV5CompatibleTrue();
- }
- private async _setIsV5CompatibleTrue() {
- try {
- await this.crowi.configManager.updateConfigsInTheSameNamespace('crowi', {
- 'app:isV5Compatible': true,
- });
- logger.info('Successfully migrated all public pages.');
- }
- catch (err) {
- logger.warn('Failed to update app:isV5Compatible to true.');
- throw err;
- }
- }
- private async normalizeParentAndDescendantCountOfDescendants(path: string, user): Promise<void> {
- await this.normalizeParentRecursively([path], user);
- // update descendantCount of descendant pages
- await this.updateDescendantCountOfSelfAndDescendants(path);
- }
- /**
- * Normalize parent attribute by passing paths and user.
- * @param paths Pages under this paths value will be updated.
- * @param user To be used to filter pages to update. If null, only public pages will be updated.
- * @returns Promise<void>
- */
- async normalizeParentRecursively(paths: string[], user: any | null): Promise<number> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const ancestorPaths = paths.flatMap(p => collectAncestorPaths(p, []));
- // targets' descendants
- const pathAndRegExpsToNormalize: (RegExp | string)[] = paths
- .map(p => new RegExp(`^${escapeStringRegexp(addTrailingSlash(p))}`, 'i'));
- // include targets' path
- pathAndRegExpsToNormalize.push(...paths);
- // determine UserGroup condition
- let userGroups = null;
- if (user != null) {
- const UserGroupRelation = mongoose.model('UserGroupRelation') as any; // TODO: Typescriptize model
- userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user);
- }
- const grantFiltersByUser: { $or: any[] } = Page.generateGrantCondition(user, userGroups);
- return this._normalizeParentRecursively(pathAndRegExpsToNormalize, ancestorPaths, grantFiltersByUser, user);
- }
- private buildFilterForNormalizeParentRecursively(pathOrRegExps: (RegExp | string)[], publicPathsToNormalize: string[], grantFiltersByUser: { $or: any[] }) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const andFilter: any = {
- $and: [
- {
- parent: null,
- status: Page.STATUS_PUBLISHED,
- path: { $ne: '/' },
- },
- ],
- };
- const orFilter: any = { $or: [] };
- // specified pathOrRegExps
- if (pathOrRegExps.length > 0) {
- orFilter.$or.push(
- {
- path: { $in: pathOrRegExps },
- },
- );
- }
- // not specified but ancestors of specified pathOrRegExps
- if (publicPathsToNormalize.length > 0) {
- orFilter.$or.push(
- {
- path: { $in: publicPathsToNormalize },
- grant: Page.GRANT_PUBLIC, // use only public pages to complete the tree
- },
- );
- }
- // Merge filters
- const mergedFilter = {
- $and: [
- { $and: [grantFiltersByUser, ...andFilter.$and] },
- { $or: orFilter.$or },
- ],
- };
- return mergedFilter;
- }
- private async _normalizeParentRecursively(
- pathOrRegExps: (RegExp | string)[], publicPathsToNormalize: string[], grantFiltersByUser: { $or: any[] }, user, count = 0, skiped = 0, isFirst = true,
- ): Promise<number> {
- const BATCH_SIZE = 100;
- const PAGES_LIMIT = 1000;
- const socket = this.crowi.socketIoService.getAdminSocket();
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- // Build filter
- const matchFilter = this.buildFilterForNormalizeParentRecursively(pathOrRegExps, publicPathsToNormalize, grantFiltersByUser);
- let baseAggregation = Page
- .aggregate([
- { $match: matchFilter },
- {
- $project: { // minimize data to fetch
- _id: 1,
- path: 1,
- },
- },
- ]);
- // Limit pages to get
- const total = await Page.countDocuments(matchFilter);
- if (isFirst) {
- socket.emit(SocketEventName.PMStarted, { total });
- }
- if (total > PAGES_LIMIT) {
- baseAggregation = baseAggregation.limit(Math.floor(total * 0.3));
- }
- const pagesStream = await baseAggregation.cursor({ batchSize: BATCH_SIZE });
- const batchStream = createBatchStream(BATCH_SIZE);
- let shouldContinue = true;
- let nextCount = count;
- let nextSkiped = skiped;
- // eslint-disable-next-line max-len
- const buildPipelineToCreateEmptyPagesByUser = this.buildPipelineToCreateEmptyPagesByUser.bind(this);
- const migratePagesStream = new Writable({
- objectMode: true,
- async write(pages, encoding, callback) {
- const parentPaths = Array.from(new Set<string>(pages.map(p => pathlib.dirname(p.path))));
- // 1. Remove unnecessary empty pages & reset parent for pages which had had those empty pages
- const pageIdsToNotDelete = pages.map(p => p._id);
- const emptyPagePathsToDelete = pages.map(p => p.path);
- const builder1 = new PageQueryBuilder(Page.find({ isEmpty: true }, { _id: 1 }), true);
- builder1.addConditionToListByPathsArray(emptyPagePathsToDelete);
- builder1.addConditionToExcludeByPageIdsArray(pageIdsToNotDelete);
- const emptyPagesToDelete = await builder1.query.lean().exec();
- const resetParentOperations = emptyPagesToDelete.map((p) => {
- return {
- updateOne: {
- filter: {
- parent: p._id,
- },
- update: {
- parent: null,
- },
- },
- };
- });
- await Page.bulkWrite(resetParentOperations);
- await Page.removeEmptyPages(pageIdsToNotDelete, emptyPagePathsToDelete);
- // 2. Create lacking parents as empty pages
- const orFilters = [
- { path: '/' },
- { path: { $in: publicPathsToNormalize }, grant: Page.GRANT_PUBLIC, status: Page.STATUS_PUBLISHED },
- { path: { $in: publicPathsToNormalize }, parent: { $ne: null }, status: Page.STATUS_PUBLISHED },
- { path: { $nin: publicPathsToNormalize }, status: Page.STATUS_PUBLISHED },
- ];
- const filterForApplicableAncestors = { $or: orFilters };
- const aggregationPipeline = await buildPipelineToCreateEmptyPagesByUser(user, parentPaths, false, filterForApplicableAncestors);
- await Page.createEmptyPagesByPaths(parentPaths, aggregationPipeline);
- // 3. Find parents
- const addGrantCondition = (builder) => {
- builder.query = builder.query.and(grantFiltersByUser);
- return builder;
- };
- const builder2 = new PageQueryBuilder(Page.find(), true);
- addGrantCondition(builder2);
- const parents = await builder2
- .addConditionToListByPathsArray(parentPaths)
- .addConditionToFilterByApplicableAncestors(publicPathsToNormalize)
- .query
- .lean()
- .exec();
- // Normalize all siblings for each page
- const updateManyOperations = parents.map((parent) => {
- const parentId = parent._id;
- // Build filter
- const parentPathEscaped = escapeStringRegexp(parent.path === '/' ? '' : parent.path); // adjust the path for RegExp
- const filter: any = {
- $and: [
- {
- path: { $regex: new RegExp(`^${parentPathEscaped}(\\/[^/]+)\\/?$`, 'i') }, // see: regexr.com/6889f (e.g. /parent/any_child or /any_level1)
- },
- {
- path: { $in: pathOrRegExps.concat(publicPathsToNormalize) },
- },
- filterForApplicableAncestors,
- grantFiltersByUser,
- ],
- };
- return {
- updateMany: {
- filter,
- update: {
- parent: parentId,
- },
- },
- };
- });
- try {
- const res = await Page.bulkWrite(updateManyOperations);
- nextCount += res.result.nModified;
- nextSkiped += res.result.writeErrors.length;
- logger.info(`Page migration processing: (migratedPages=${res.result.nModified})`);
- socket.emit(SocketEventName.PMMigrating, { count: nextCount });
- socket.emit(SocketEventName.PMErrorCount, { skip: nextSkiped });
- // Throw if any error is found
- if (res.result.writeErrors.length > 0) {
- logger.error('Failed to migrate some pages', res.result.writeErrors);
- socket.emit(SocketEventName.PMEnded, { isSucceeded: false });
- throw Error('Failed to migrate some pages');
- }
- // Finish migration if no modification occurred
- if (res.result.nModified === 0 && res.result.nMatched === 0) {
- shouldContinue = false;
- logger.error('Migration is unable to continue', 'parentPaths:', parentPaths, 'bulkWriteResult:', res);
- socket.emit(SocketEventName.PMEnded, { isSucceeded: false });
- }
- }
- catch (err) {
- logger.error('Failed to update page.parent.', err);
- throw err;
- }
- callback();
- },
- final(callback) {
- callback();
- },
- });
- pagesStream
- .pipe(batchStream)
- .pipe(migratePagesStream);
- await streamToPromise(migratePagesStream);
- if (await Page.exists(matchFilter) && shouldContinue) {
- return this._normalizeParentRecursively(pathOrRegExps, publicPathsToNormalize, grantFiltersByUser, user, nextCount, nextSkiped, false);
- }
- // End
- socket.emit(SocketEventName.PMEnded, { isSucceeded: true });
- return nextCount;
- }
- private async _v5NormalizeIndex() {
- const collection = mongoose.connection.collection('pages');
- try {
- // drop pages.path_1 indexes
- await collection.dropIndex('path_1');
- logger.info('Succeeded to drop unique indexes from pages.path.');
- }
- catch (err) {
- logger.warn('Failed to drop unique indexes from pages.path.', err);
- throw err;
- }
- try {
- // create indexes without
- await collection.createIndex({ path: 1 }, { unique: false });
- logger.info('Succeeded to create non-unique indexes on pages.path.');
- }
- catch (err) {
- logger.warn('Failed to create non-unique indexes on pages.path.', err);
- throw err;
- }
- }
- async countPagesCanNormalizeParentByUser(user): Promise<number> {
- if (user == null) {
- throw Error('user is required');
- }
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- const builder = new PageQueryBuilder(Page.count(), false);
- await builder.addConditionAsMigratablePages(user);
- const nMigratablePages = await builder.query.exec();
- return nMigratablePages;
- }
- /**
- * update descendantCount of the following pages
- * - page that has the same path as the provided path
- * - pages that are descendants of the above page
- */
- async updateDescendantCountOfSelfAndDescendants(path: string): Promise<void> {
- const BATCH_SIZE = 200;
- const Page = this.crowi.model('Page');
- const { PageQueryBuilder } = Page;
- const builder = new PageQueryBuilder(Page.find(), true);
- builder.addConditionAsOnTree();
- builder.addConditionToListWithDescendants(path);
- builder.addConditionToSortPagesByDescPath();
- const aggregatedPages = await builder.query.lean().cursor({ batchSize: BATCH_SIZE });
- const recountWriteStream = new Writable({
- objectMode: true,
- async write(pageDocuments, encoding, callback) {
- for await (const document of pageDocuments) {
- const descendantCount = await Page.recountDescendantCount(document._id);
- await Page.findByIdAndUpdate(document._id, { descendantCount });
- }
- callback();
- },
- final(callback) {
- callback();
- },
- });
- aggregatedPages
- .pipe(createBatchStream(BATCH_SIZE))
- .pipe(recountWriteStream);
- await streamToPromise(recountWriteStream);
- }
- // update descendantCount of all pages that are ancestors of a provided pageId by count
- async updateDescendantCountOfAncestors(pageId: ObjectIdLike, inc: number, shouldIncludeTarget: boolean): Promise<void> {
- const Page = this.crowi.model('Page');
- const ancestors = await Page.findAncestorsUsingParentRecursively(pageId, shouldIncludeTarget);
- const ancestorPageIds = ancestors.map(p => p._id);
- await Page.incrementDescendantCountOfPageIds(ancestorPageIds, inc);
- const updateDescCountData: UpdateDescCountRawData = Object.fromEntries(ancestors.map(p => [p._id.toString(), p.descendantCount + inc]));
- this.emitUpdateDescCount(updateDescCountData);
- }
- private emitUpdateDescCount(data: UpdateDescCountRawData): void {
- const socket = this.crowi.socketIoService.getDefaultSocket();
- socket.emit(SocketEventName.UpdateDescCount, data);
- }
- /**
- * Build the base aggregation pipeline for fillAncestors--- methods
- * @param onlyMigratedAsExistingPages Determine whether to include non-migrated pages as existing pages. If a page exists,
- * an empty page will not be created at that page's path.
- */
- private buildBasePipelineToCreateEmptyPages(paths: string[], onlyMigratedAsExistingPages = true, andFilter?): any[] {
- const aggregationPipeline: any[] = [];
- const Page = mongoose.model('Page') as unknown as PageModel;
- // -- Filter by paths
- aggregationPipeline.push({ $match: { path: { $in: paths } } });
- // -- Normalized condition
- if (onlyMigratedAsExistingPages) {
- aggregationPipeline.push({
- $match: {
- $or: [
- { grant: Page.GRANT_PUBLIC },
- { parent: { $ne: null } },
- { path: '/' },
- ],
- },
- });
- }
- // -- Add custom pipeline
- if (andFilter != null) {
- aggregationPipeline.push({ $match: andFilter });
- }
- return aggregationPipeline;
- }
- private async buildPipelineToCreateEmptyPagesByUser(user, paths: string[], onlyMigratedAsExistingPages = true, andFilter?): Promise<any[]> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const pipeline = this.buildBasePipelineToCreateEmptyPages(paths, onlyMigratedAsExistingPages, andFilter);
- let userGroups = null;
- if (user != null) {
- const UserGroupRelation = mongoose.model('UserGroupRelation') as any;
- userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user);
- }
- const grantCondition = Page.generateGrantCondition(user, userGroups);
- pipeline.push({ $match: grantCondition });
- return pipeline;
- }
- private buildPipelineToCreateEmptyPagesBySystem(paths: string[]): any[] {
- return this.buildBasePipelineToCreateEmptyPages(paths);
- }
- private async connectPageTree(path: string): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- const ancestorPaths = collectAncestorPaths(path);
- // Find ancestors
- const builder = new PageQueryBuilder(Page.find(), true);
- builder.addConditionToFilterByApplicableAncestors(ancestorPaths); // avoid including not normalized pages
- const ancestors = await builder
- .addConditionToListByPathsArray(ancestorPaths)
- .addConditionToSortPagesByDescPath()
- .query
- .exec();
- // Update parent attrs
- const ancestorsMap = new Map(); // Map<path, page>
- ancestors.forEach(page => !ancestorsMap.has(page.path) && ancestorsMap.set(page.path, page)); // the earlier element should be the true ancestor
- const nonRootAncestors = ancestors.filter(page => !isTopPage(page.path));
- const operations = nonRootAncestors.map((page) => {
- const parentPath = pathlib.dirname(page.path);
- return {
- updateOne: {
- filter: {
- _id: page._id,
- },
- update: {
- parent: ancestorsMap.get(parentPath)._id,
- },
- },
- };
- });
- await Page.bulkWrite(operations);
- }
- /**
- * Find parent or create parent if not exists.
- * It also updates parent of ancestors
- * @param path string
- * @returns Promise<PageDocument>
- */
- async getParentAndFillAncestorsByUser(user, path: string): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- // Find parent
- const parent = await Page.findParentByPath(path);
- if (parent != null) {
- return parent;
- }
- const ancestorPaths = collectAncestorPaths(path);
- // Fill ancestors
- const aggregationPipeline: any[] = await this.buildPipelineToCreateEmptyPagesByUser(user, ancestorPaths);
- await Page.createEmptyPagesByPaths(ancestorPaths, aggregationPipeline);
- // Connect ancestors
- await this.connectPageTree(path);
- // Return the created parent
- const createdParent = await Page.findParentByPath(path);
- if (createdParent == null) {
- throw Error('Failed to find the created parent by getParentAndFillAncestorsByUser');
- }
- return createdParent;
- }
- async getParentAndFillAncestorsBySystem(path: string): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- // Find parent
- const parent = await Page.findParentByPath(path);
- if (parent != null) {
- return parent;
- }
- // Fill ancestors
- const ancestorPaths = collectAncestorPaths(path);
- const aggregationPipeline: any[] = this.buildPipelineToCreateEmptyPagesBySystem(ancestorPaths);
- await Page.createEmptyPagesByPaths(ancestorPaths, aggregationPipeline);
- // Connect ancestors
- await this.connectPageTree(path);
- // Return the created parent
- const createdParent = await Page.findParentByPath(path);
- if (createdParent == null) {
- throw Error('Failed to find the created parent by getParentAndFillAncestorsByUser');
- }
- return createdParent;
- }
- // --------- Create ---------
- private async preparePageDocumentToCreate(path: string, shouldNew: boolean): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const emptyPage = await Page.findOne({ path, isEmpty: true });
- // Use empty page if exists, if not, create a new page
- let page;
- if (shouldNew) {
- page = new Page();
- }
- else if (emptyPage != null) {
- page = emptyPage;
- const descendantCount = await Page.recountDescendantCount(page._id);
- page.descendantCount = descendantCount;
- page.isEmpty = false;
- }
- else {
- page = new Page();
- }
- return page;
- }
- private setFieldExceptForGrantRevisionParent(
- pageDocument: PageDocument,
- path: string,
- user?,
- ): void {
- const Page = mongoose.model('Page') as unknown as PageModel;
- pageDocument.path = path;
- pageDocument.creator = user;
- pageDocument.lastUpdateUser = user;
- pageDocument.status = Page.STATUS_PUBLISHED;
- }
- private async canProcessCreate(
- path: string,
- grantData: {
- grant: number,
- grantedUserIds?: ObjectIdLike[],
- grantUserGroupId?: ObjectIdLike,
- },
- shouldValidateGrant: boolean,
- user?,
- ): Promise<boolean> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- // Operatability validation
- const canOperate = await this.crowi.pageOperationService.canOperate(false, null, path);
- if (!canOperate) {
- logger.error(`Cannot operate create to path "${path}" right now.`);
- return false;
- }
- // Existance validation
- const isExist = (await Page.count({ path, isEmpty: false })) > 0; // not validate empty page
- if (isExist) {
- logger.error('Cannot create new page to existed path');
- return false;
- }
- // UserGroup & Owner validation
- const { grant, grantedUserIds, grantUserGroupId } = grantData;
- if (shouldValidateGrant) {
- if (user == null) {
- throw Error('user is required to validate grant');
- }
- let isGrantNormalized = false;
- try {
- // It must check descendants as well if emptyTarget is not null
- const isEmptyPageAlreadyExist = await Page.count({ path, isEmpty: true }) > 0;
- const shouldCheckDescendants = isEmptyPageAlreadyExist;
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, path, grant, grantedUserIds, grantUserGroupId, shouldCheckDescendants);
- }
- catch (err) {
- logger.error(`Failed to validate grant of page at "${path}" of grant ${grant}:`, err);
- throw err;
- }
- if (!isGrantNormalized) {
- throw Error('The selected grant or grantedGroup is not assignable to this page.');
- }
- }
- return true;
- }
- async create(path: string, body: string, user, options: PageCreateOptions = {}): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- // Switch method
- const isV5Compatible = this.crowi.configManager.getConfig('crowi', 'app:isV5Compatible');
- if (!isV5Compatible) {
- return Page.createV4(path, body, user, options);
- }
- // Values
- // eslint-disable-next-line no-param-reassign
- path = this.crowi.xss.process(path); // sanitize path
- const {
- format = 'markdown', grantUserGroupId,
- } = options;
- const grant = isTopPage(path) ? Page.GRANT_PUBLIC : options.grant;
- const grantData = {
- grant,
- grantedUserIds: grant === Page.GRANT_OWNER ? [user._id] : undefined,
- grantUserGroupId,
- };
- const isGrantRestricted = grant === Page.GRANT_RESTRICTED;
- // Validate
- const shouldValidateGrant = !isGrantRestricted;
- const canProcessCreate = await this.canProcessCreate(path, grantData, shouldValidateGrant, user);
- if (!canProcessCreate) {
- throw Error('Cannnot process create');
- }
- // Prepare a page document
- const shouldNew = isGrantRestricted;
- const page = await this.preparePageDocumentToCreate(path, shouldNew);
- // Set field
- this.setFieldExceptForGrantRevisionParent(page, path, user);
- // Apply scope
- page.applyScope(user, grant, grantUserGroupId);
- // Set parent
- if (isTopPage(path) || isGrantRestricted) { // set parent to null when GRANT_RESTRICTED
- page.parent = null;
- }
- else {
- const parent = await this.getParentAndFillAncestorsByUser(user, path);
- page.parent = parent._id;
- }
- // Save
- let savedPage = await page.save();
- // Create revision
- const Revision = mongoose.model('Revision') as any; // TODO: Typescriptize model
- const newRevision = Revision.prepareRevision(savedPage, body, null, user, { format });
- savedPage = await pushRevision(savedPage, newRevision, user);
- await savedPage.populateDataToShowRevision();
- // Update descendantCount
- await this.updateDescendantCountOfAncestors(savedPage._id, 1, false);
- // Emit create event
- this.pageEvent.emit('create', savedPage, user);
- // Delete PageRedirect if exists
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- try {
- await PageRedirect.deleteOne({ fromPath: path });
- logger.warn(`Deleted page redirect after creating a new page at path "${path}".`);
- }
- catch (err) {
- // no throw
- logger.error('Failed to delete PageRedirect');
- }
- return savedPage;
- }
- private async canProcessForceCreateBySystem(
- path: string,
- grantData: {
- grant: number,
- grantedUserIds?: ObjectIdLike[],
- grantUserGroupId?: ObjectIdLike,
- },
- ): Promise<boolean> {
- return this.canProcessCreate(path, grantData, false);
- }
- /**
- * @private
- * This method receives the same arguments as the PageService.create method does except for the added type '{ grantedUsers?: ObjectIdLike[] }'.
- * This additional value is used to determine the grantedUser of the page to be created by system.
- * This method must not run isGrantNormalized method to validate grant. **If necessary, run it before use this method.**
- * -- Reason 1: This is because it is not expected to use this method when the grant validation is required.
- * -- Reason 2: This is because it is not expected to use this method when the program cannot determine the operator.
- */
- private async forceCreateBySystem(path: string, body: string, options: PageCreateOptions & { grantedUsers?: ObjectIdLike[] }): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const isV5Compatible = this.crowi.configManager.getConfig('crowi', 'app:isV5Compatible');
- if (!isV5Compatible) {
- throw Error('This method is available only when v5 compatible');
- }
- // Values
- // eslint-disable-next-line no-param-reassign
- path = this.crowi.xss.process(path); // sanitize path
- const {
- format = 'markdown', grantUserGroupId, grantedUsers,
- } = options;
- const grant = isTopPage(path) ? Page.GRANT_PUBLIC : options.grant;
- const isGrantRestricted = grant === Page.GRANT_RESTRICTED;
- const isGrantOwner = grant === Page.GRANT_OWNER;
- const grantData = {
- grant,
- grantedUserIds: isGrantOwner ? grantedUsers : undefined,
- grantUserGroupId,
- };
- // Validate
- if (isGrantOwner && grantedUsers?.length !== 1) {
- throw Error('grantedUser must exist when grant is GRANT_OWNER');
- }
- const canProcessForceCreateBySystem = await this.canProcessForceCreateBySystem(path, grantData);
- if (!canProcessForceCreateBySystem) {
- throw Error('Cannnot process forceCreateBySystem');
- }
- // Prepare a page document
- const shouldNew = isGrantRestricted;
- const page = await this.preparePageDocumentToCreate(path, shouldNew);
- // Set field
- this.setFieldExceptForGrantRevisionParent(page, path);
- // Apply scope
- page.applyScope({ _id: grantedUsers?.[0] }, grant, grantUserGroupId);
- // Set parent
- if (isTopPage(path) || isGrantRestricted) { // set parent to null when GRANT_RESTRICTED
- page.parent = null;
- }
- else {
- const parent = await this.getParentAndFillAncestorsBySystem(path);
- page.parent = parent._id;
- }
- // Save
- let savedPage = await page.save();
- // Create revision
- const Revision = mongoose.model('Revision') as any; // TODO: Typescriptize model
- const dummyUser = { _id: new mongoose.Types.ObjectId() };
- const newRevision = Revision.prepareRevision(savedPage, body, null, dummyUser, { format });
- savedPage = await pushRevision(savedPage, newRevision, dummyUser);
- // Update descendantCount
- await this.updateDescendantCountOfAncestors(savedPage._id, 1, false);
- // Emit create event
- this.pageEvent.emit('create', savedPage, dummyUser);
- return savedPage;
- }
- }
- export default PageService;
|