| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316 |
- 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, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_UPDATE);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // rename
- this.pageEvent.on('rename', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, user, SUPPORTED_ACTION_TYPE.ACTION_PAGE_RENAME);
- }
- catch (err) {
- logger.error(err);
- }
- });
- // duplicate
- this.pageEvent.on('duplicate', async(page, user) => {
- try {
- await this.createAndSendNotifications(page, 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, 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, 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, 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, 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, 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;
- 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.getParentAndFillAncestors(newPagePath, user);
- }
- // 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 });
- // create page redirect
- if (options.createRedirectPage) {
- const PageRedirect = mongoose.model('PageRedirect') as unknown as PageRedirectModel;
- await PageRedirect.create({ fromPath: page.path, toPath: newPagePath });
- }
- this.pageEvent.emit('rename', page, user);
- // 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, 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,
- );
- 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.getParentAndFillAncestors(newPagePath, user);
- 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;
- }
- // TODO: implement this method
- async deleteCompletelySystematically() {
- 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.getParentAndFillAncestors(newPath, user);
- 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, 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
- const targetUsers = await activity.getNotificationTargetUsers();
- // 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 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);
- systematicallyCreatedPage = await Page.createSystematically(
- path,
- 'This page was created by GROWI.',
- {
- grant: notEmptyParent.grant,
- grantedUserIds: notEmptyParent.grantedUsers,
- grantUserGroupId: notEmptyParent.grantedGroup,
- },
- );
- page = systematicallyCreatedPage;
- }
- else {
- page = page[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) {
- // TODO: delete systematicallyCreatedPage
- 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) {
- // TODO: delete systematicallyCreatedPage
- logger.error('Failed to create PageOperation document.', err);
- throw err;
- }
- // no await
- (async() => {
- // Remove the created page if no page has converted
- const count = await this.normalizeParentRecursivelyMainOperation(page, user, pageOp._id);
- if (count === 0) {
- // TODO: delete systematicallyCreatedPage
- // await this.deleteCompletelySystematically(systematicallyCreatedPage, user, {}, false);
- }
- })();
- }
- 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.getParentAndFillAncestors(page.path, user);
- 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.addConditionAsMigrated();
- 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.addConditionAsMigrated();
- 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;
- const createEmptyPagesByPaths = this.createEmptyPagesByPaths.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 };
- await createEmptyPagesByPaths(parentPaths, user, false, true, filterForApplicableAncestors);
- // 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.addConditionAsMigrated();
- 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);
- }
- /**
- * Find parent or create parent if not exists.
- * It also updates parent of ancestors
- * @param path string
- * @returns Promise<PageDocument>
- */
- async getParentAndFillAncestors(path: string, user, options?: { isSystematically?: boolean }): Promise<PageDocument> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const { PageQueryBuilder } = Page;
- const parentPath = pathlib.dirname(path);
- const builder1 = new PageQueryBuilder(Page.find({ path: parentPath }), true);
- const pagesCanBeParent = await builder1
- .addConditionAsMigrated()
- .query
- .exec();
- if (pagesCanBeParent.length >= 1) {
- return pagesCanBeParent[0]; // the earliest page will be the result
- }
- /*
- * Fill parents if parent is null
- */
- const ancestorPaths = collectAncestorPaths(path); // paths of parents need to be created
- // just create ancestors with empty pages
- // TODO: separate process
- await this.createEmptyPagesByPaths(ancestorPaths, user, true);
- // find ancestors
- const builder2 = new PageQueryBuilder(Page.find(), true);
- // avoid including not normalized pages
- builder2.addConditionToFilterByApplicableAncestors(ancestorPaths);
- const ancestors = await builder2
- .addConditionToListByPathsArray(ancestorPaths)
- .addConditionToSortPagesByDescPath()
- .query
- .exec();
- 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
- // bulkWrite to update ancestors
- 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);
- const parentId = ancestorsMap.get(parentPath)._id; // get parent page id to fetch updated parent parent
- const createdParent = await Page.findOne({ _id: parentId });
- if (createdParent == null) {
- throw Error('updated parent not Found');
- }
- return createdParent;
- }
- // TODO: separate processes for systematical and manual operations
- /**
- * Create empty pages if the page in paths didn't exist
- * @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.
- */
- async createEmptyPagesByPaths(
- paths: string[],
- user: any | null,
- onlyMigratedAsExistingPages = true,
- andFilter?,
- ): Promise<void> {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const aggregationPipeline: any[] = [];
- // 1. Filter by paths
- aggregationPipeline.push({ $match: { path: { $in: paths } } });
- // 2. Normalized condition
- if (onlyMigratedAsExistingPages) {
- aggregationPipeline.push({
- $match: {
- $or: [
- { grant: Page.GRANT_PUBLIC },
- { parent: { $ne: null } },
- { path: '/' },
- ],
- },
- });
- }
- // 3. Add custom pipeline
- if (andFilter != null) {
- aggregationPipeline.push({ $match: andFilter });
- }
- // 4. Add grant conditions
- // TODO: need to separate here
- let userGroups = null;
- if (user != null) {
- const UserGroupRelation = mongoose.model('UserGroupRelation') as any;
- userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user);
- }
- const grantCondition = Page.generateGrantCondition(user, userGroups);
- aggregationPipeline.push({ $match: grantCondition });
- // Run aggregation
- const existingPages = await Page.aggregate(aggregationPipeline);
- const existingPagePaths = existingPages.map(page => page.path);
- // paths to create empty pages
- const notExistingPagePaths = paths.filter(path => !existingPagePaths.includes(path));
- // insertMany empty pages
- try {
- await Page.insertMany(notExistingPagePaths.map(path => ({ path, isEmpty: true })));
- }
- catch (err) {
- logger.error('Failed to insert empty pages.', err);
- throw err;
- }
- }
- async create(path: string, body: string, user, options: PageCreateOptions = {}) {
- const Page = mongoose.model('Page') as unknown as PageModel;
- const Revision = mongoose.model('Revision') as any; // TODO: Typescriptize model
- const { isSystematically } = options;
- if (user == null && !isSystematically) {
- throw Error('Cannot call create() without a parameter "user" when shouldSkipUserValidation is false.');
- }
- const isV5Compatible = this.crowi.configManager.getConfig('crowi', 'app:isV5Compatible');
- // v4 compatible process
- if (!isV5Compatible) {
- return Page.createV4(path, body, user, options);
- }
- const canOperate = await this.crowi.pageOperationService.canOperate(false, null, path);
- if (!canOperate) {
- throw Error(`Cannot operate create to path "${path}" right now.`);
- }
- const {
- format = 'markdown', grantUserGroupId, grantedUserIds,
- } = options;
- let grant = options.grant;
- // sanitize path
- path = this.crowi.xss.process(path); // eslint-disable-line no-param-reassign
- // throw if exists
- const isExist = (await Page.count({ path, isEmpty: false })) > 0; // not validate empty page
- if (isExist) {
- throw Error('Cannot create new page to existed path');
- }
- // force public
- if (isTopPage(path)) {
- grant = Page.GRANT_PUBLIC;
- }
- // find an existing empty page
- const emptyPage = await Page.findOne({ path, isEmpty: true });
- /*
- * UserGroup & Owner validation
- */
- if (!isSystematically && grant !== Page.GRANT_RESTRICTED) {
- let isGrantNormalized = false;
- try {
- // It must check descendants as well if emptyTarget is not null
- const shouldCheckDescendants = emptyPage != null;
- const newGrantedUserIds = grant === Page.GRANT_OWNER ? [user._id] : undefined;
- isGrantNormalized = await this.crowi.pageGrantService.isGrantNormalized(user, path, grant, newGrantedUserIds, 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.');
- }
- }
- /*
- * update empty page if exists, if not, create a new page
- */
- let page;
- if (emptyPage != null && grant !== Page.GRANT_RESTRICTED) {
- page = emptyPage;
- const descendantCount = await Page.recountDescendantCount(page._id);
- page.descendantCount = descendantCount;
- page.isEmpty = false;
- }
- else {
- page = new Page();
- }
- page.path = path;
- page.creator = user;
- page.lastUpdateUser = user;
- page.status = Page.STATUS_PUBLISHED;
- // set parent to null when GRANT_RESTRICTED
- const isGrantRestricted = grant === Page.GRANT_RESTRICTED;
- if (isTopPage(path) || isGrantRestricted) {
- page.parent = null;
- }
- else {
- const options = { isSystematically };
- const parent = await this.getParentAndFillAncestors(path, user, options);
- page.parent = parent._id;
- }
- const userForApplyScope = grantedUserIds?.[0] != null ? { _id: grantedUserIds[0] } : user;
- page.applyScope(userForApplyScope, grant, grantUserGroupId);
- let savedPage = await page.save();
- /*
- * After save
- */
- // 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');
- }
- const newRevision = Revision.prepareRevision(savedPage, body, null, user, { format });
- savedPage = await pushRevision(savedPage, newRevision, user);
- await savedPage.populateDataToShowRevision();
- this.pageEvent.emit('create', savedPage, user);
- // update descendantCount asynchronously
- await this.crowi.pageService.updateDescendantCountOfAncestors(savedPage._id, 1, false);
- return savedPage;
- }
- }
- export default PageService;
|