/* eslint-disable @typescript-eslint/no-explicit-any */ import mongoose, { Schema, Model, Document, AnyObject, } from 'mongoose'; import mongoosePaginate from 'mongoose-paginate-v2'; import uniqueValidator from 'mongoose-unique-validator'; import nodePath from 'path'; import { getOrCreateModel, pagePathUtils } from '@growi/core'; import loggerFactory from '../../utils/logger'; import Crowi from '../crowi'; import { IPage } from '../../interfaces/page'; import { getPageSchema, PageQueryBuilder } from './obsolete-page'; const { isTopPage } = pagePathUtils; const logger = loggerFactory('growi:models:page'); /* * define schema */ const GRANT_PUBLIC = 1; const GRANT_RESTRICTED = 2; const GRANT_SPECIFIED = 3; const GRANT_OWNER = 4; const GRANT_USER_GROUP = 5; const PAGE_GRANT_ERROR = 1; const STATUS_PUBLISHED = 'published'; const STATUS_DELETED = 'deleted'; export interface PageDocument extends IPage, Document {} type TargetAndAncestorsResult = { targetAndAncestors: PageDocument[] rootPage: PageDocument } export interface PageModel extends Model { [x: string]: any; // for obsolete methods createEmptyPagesByPaths(paths: string[], publicOnly?: boolean): Promise getParentIdAndFillAncestors(path: string): Promise findByPathAndViewer(path: string | null, user, userGroups?, useFindOne?: boolean, includeEmpty?: boolean): Promise findTargetAndAncestorsByPathOrId(pathOrId: string): Promise findChildrenByParentPathOrIdAndViewer(parentPathOrId: string, user, userGroups?): Promise findAncestorsChildrenByPathAndViewer(path: string, user, userGroups?): Promise> PageQueryBuilder: typeof PageQueryBuilder GRANT_PUBLIC GRANT_RESTRICTED GRANT_SPECIFIED GRANT_OWNER GRANT_USER_GROUP PAGE_GRANT_ERROR STATUS_PUBLISHED STATUS_DELETED } const ObjectId = mongoose.Schema.Types.ObjectId; const schema = new Schema({ parent: { type: ObjectId, ref: 'Page', index: true, default: null, }, descendantCount: { type: Number, default: 0 }, isEmpty: { type: Boolean, default: false }, path: { type: String, required: true, index: true, }, revision: { type: ObjectId, ref: 'Revision' }, redirectTo: { type: String, index: true }, status: { type: String, default: STATUS_PUBLISHED, index: true }, grant: { type: Number, default: GRANT_PUBLIC, index: true }, grantedUsers: [{ type: ObjectId, ref: 'User' }], grantedGroup: { type: ObjectId, ref: 'UserGroup', index: true }, creator: { type: ObjectId, ref: 'User', index: true }, lastUpdateUser: { type: ObjectId, ref: 'User' }, liker: [{ type: ObjectId, ref: 'User' }], seenUsers: [{ type: ObjectId, ref: 'User' }], commentCount: { type: Number, default: 0 }, slackChannels: { type: String }, pageIdOnHackmd: { type: String }, revisionHackmdSynced: { type: ObjectId, ref: 'Revision' }, // the revision that is synced to HackMD hasDraftOnHackmd: { type: Boolean }, // set true if revision and revisionHackmdSynced are same but HackMD document has modified createdAt: { type: Date, default: new Date() }, updatedAt: { type: Date, default: new Date() }, deleteUser: { type: ObjectId, ref: 'User' }, deletedAt: { type: Date }, }, { toJSON: { getters: true }, toObject: { getters: true }, }); // apply plugins schema.plugin(mongoosePaginate); schema.plugin(uniqueValidator); /* * Methods */ const collectAncestorPaths = (path: string, ancestorPaths: string[] = []): string[] => { if (isTopPage(path)) return ancestorPaths; const parentPath = nodePath.dirname(path); ancestorPaths.push(parentPath); return collectAncestorPaths(parentPath, ancestorPaths); }; const hasSlash = (str: string): boolean => { return str.includes('/'); }; /* * Generate RegExp instance for one level lower path */ const generateChildrenRegExp = (path: string): RegExp => { // https://regex101.com/r/laJGzj/1 // ex. /any_level1 if (isTopPage(path)) return new RegExp(/^\/[^/]+$/); // https://regex101.com/r/mrDJrx/1 // ex. /parent/any_child OR /any_level1 return new RegExp(`^${path}(\\/[^/]+)\\/?$`); }; /* * Create empty pages if the page in paths didn't exist */ schema.statics.createEmptyPagesByPaths = async function(paths: string[], publicOnly = false): Promise { // find existing parents const builder = new PageQueryBuilder(this.find(publicOnly ? { grant: GRANT_PUBLIC } : {}, { _id: 0, path: 1 }), true); const existingPages = await builder .addConditionToListByPathsArray(paths) .query .lean() .exec(); 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 this.insertMany(notExistingPagePaths.map(path => ({ path, isEmpty: true }))); } catch (err) { logger.error('Failed to insert empty pages.', err); throw err; } }; /* * Find the parent and update if the parent exists. * If not, * - first run createEmptyPagesByPaths with ancestor's paths to ensure all the ancestors exist * - second update ancestor pages' parent * - finally return the target's parent page id */ schema.statics.getParentIdAndFillAncestors = async function(path: string): Promise { const parentPath = nodePath.dirname(path); const parent = await this.findOne({ path: parentPath }); // find the oldest parent which must always be the true parent if (parent != null) { return parent._id; } /* * Fill parents if parent is null */ const ancestorPaths = collectAncestorPaths(path); // paths of parents need to be created // just create ancestors with empty pages await this.createEmptyPagesByPaths(ancestorPaths); // find ancestors const builder = new PageQueryBuilder(this.find({}, { _id: 1, path: 1 }), true); const ancestors = await builder .addConditionToListByPathsArray(ancestorPaths) .addConditionToSortPagesByDescPath() .query .lean() .exec(); const ancestorsMap = new Map(); // Map ancestors.forEach(page => ancestorsMap.set(page.path, page._id)); // bulkWrite to update ancestors const nonRootAncestors = ancestors.filter(page => !isTopPage(page.path)); const operations = nonRootAncestors.map((page) => { const { path } = page; const parentPath = nodePath.dirname(path); return { updateOne: { filter: { path, }, update: { parent: ancestorsMap.get(parentPath), }, }, }; }); await this.bulkWrite(operations); const parentId = ancestorsMap.get(parentPath); return parentId; }; // Utility function to add viewer condition to PageQueryBuilder instance const addViewerCondition = async(queryBuilder: PageQueryBuilder, user, userGroups = null): Promise => { let relatedUserGroups = userGroups; if (user != null && relatedUserGroups == null) { const UserGroupRelation: any = mongoose.model('UserGroupRelation'); relatedUserGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user); } queryBuilder.addConditionToFilteringByViewer(user, relatedUserGroups, false); }; /* * Find a page by path and viewer. Pass false to useFindOne to use findOne method. */ schema.statics.findByPathAndViewer = async function( path: string | null, user, userGroups = null, useFindOne = true, includeEmpty = false, ): Promise { if (path == null) { throw new Error('path is required.'); } const baseQuery = useFindOne ? this.findOne({ path }) : this.find({ path }); const queryBuilder = new PageQueryBuilder(baseQuery, includeEmpty); await addViewerCondition(queryBuilder, user, userGroups); return queryBuilder.query.exec(); }; /* * Find all ancestor pages by path. When duplicate pages found, it uses the oldest page as a result * The result will include the target as well */ schema.statics.findTargetAndAncestorsByPathOrId = async function(pathOrId: string, user, userGroups): Promise { let path; if (!hasSlash(pathOrId)) { const _id = pathOrId; const page = await this.findOne({ _id }); if (page == null) throw new Error('Page not found.'); path = page.path; } else { path = pathOrId; } const ancestorPaths = collectAncestorPaths(path); ancestorPaths.push(path); // include target // Do not populate const queryBuilder = new PageQueryBuilder(this.find(), true); await addViewerCondition(queryBuilder, user, userGroups); const _targetAndAncestors: PageDocument[] = await queryBuilder .addConditionAsMigrated() .addConditionToListByPathsArray(ancestorPaths) .addConditionToMinimizeDataForRendering() .addConditionToSortPagesByDescPath() .query .lean() .exec(); // no same path pages const ancestorsMap = new Map(); _targetAndAncestors.forEach(page => ancestorsMap.set(page.path, page)); const targetAndAncestors = Array.from(ancestorsMap.values()); const rootPage = targetAndAncestors[targetAndAncestors.length - 1]; return { targetAndAncestors, rootPage }; }; /* * Find all children by parent's path or id. Using id should be prioritized */ schema.statics.findChildrenByParentPathOrIdAndViewer = async function(parentPathOrId: string, user, userGroups = null): Promise { let queryBuilder: PageQueryBuilder; if (hasSlash(parentPathOrId)) { const path = parentPathOrId; const regexp = generateChildrenRegExp(path); queryBuilder = new PageQueryBuilder(this.find({ path: { $regex: regexp } }), true); } else { const parentId = parentPathOrId; queryBuilder = new PageQueryBuilder(this.find({ parent: parentId }), true); } await addViewerCondition(queryBuilder, user, userGroups); return queryBuilder .addConditionToSortPagesByAscPath() .query .lean() .exec(); }; schema.statics.findAncestorsChildrenByPathAndViewer = async function(path: string, user, userGroups = null): Promise> { const ancestorPaths = isTopPage(path) ? ['/'] : collectAncestorPaths(path); // root path is necessary for rendering const regexps = ancestorPaths.map(path => new RegExp(generateChildrenRegExp(path))); // cannot use re2 // get pages at once const queryBuilder = new PageQueryBuilder(this.find({ path: { $in: regexps } }), true); await addViewerCondition(queryBuilder, user, userGroups); const _pages = await queryBuilder .addConditionAsMigrated() .addConditionToMinimizeDataForRendering() .addConditionToSortPagesByAscPath() .query .lean() .exec(); // mark target const pages = _pages.map((page: PageDocument & {isTarget?: boolean}) => { if (page.path === path) { page.isTarget = true; } return page; }); /* * If any non-migrated page is found during creating the pathToChildren map, it will stop incrementing at that moment */ const pathToChildren: Record = {}; const sortedPaths = ancestorPaths.sort((a, b) => a.length - b.length); // sort paths by path.length sortedPaths.every((path) => { const children = pages.filter(page => nodePath.dirname(page.path) === path); if (children.length === 0) { return false; // break when children do not exist } pathToChildren[path] = children; return true; }); return pathToChildren; }; /** * return aggregate condition to get following pages * - page that has the same path as the provided path * - pages that are descendants of the above page * pages without parent will be ignored */ schema.statics.getAggrConditionForPageWithProvidedPathAndDescendants = function(path:string) { let match; if (isTopPage(path)) { match = { // https://regex101.com/r/Kip2rV/1 $match: { $or: [{ path: { $regex: '^/.*' }, parent: { $ne: null } }, { path: '/' }] }, }; } else { match = { // https://regex101.com/r/mJvGrG/1 $match: { path: { $regex: `^${path}(/.*|$)` }, parent: { $ne: null } }, }; } return [ match, { $project: { path: 1, parent: 1, field_length: { $strLenCP: '$path' }, }, }, { $sort: { field_length: -1 } }, { $project: { field_length: 0 } }, ]; }; // update descendantCount of ancestors of path by count schema.statics.recountDescendantCountOfAncestors = async function(path:string, count: number):Promise { const paths = collectAncestorPaths(path); const pages = await this.aggregate([{ $match: { path: { $in: paths } } }]); const operations = pages.map((page) => { return { updateOne: { filter: { path: page.path }, update: { descendantCount: page.descendantCount + count }, }, }; }); await this.bulkWrite(operations); }; schema.statics.recountPage = async function(id:mongoose.Types.ObjectId):Promise { const res = await this.aggregate( [ { $match: { parent: id, }, }, { $project: { path: 1, parent: 1, descendantCount: 1, }, }, { $group: { _id: '$parent', sumOfDescendantCount: { $sum: '$descendantCount', }, sumOfDocsCount: { $sum: 1, }, }, }, { $set: { descendantCount: { $sum: ['$sumOfDescendantCount', '$sumOfDocsCount'], }, }, }, ], ); const query = { descendantCount: res.length === 0 ? 0 : res[0].descendantCount }; await this.findByIdAndUpdate(id, query); }; /* * Merge obsolete page model methods and define new methods which depend on crowi instance */ export default (crowi: Crowi): any => { // add old page schema methods const pageSchema = getPageSchema(crowi); schema.methods = { ...pageSchema.methods, ...schema.methods }; schema.statics = { ...pageSchema.statics, ...schema.statics }; return getOrCreateModel('Page', schema); }; /* * Aggregation utilities */ // TODO: use the original type when upgraded https://github.com/Automattic/mongoose/blob/master/index.d.ts#L3090 type PipelineStageMatch = { $match: AnyObject }; export const generateGrantCondition = async( user, _userGroups, showAnyoneKnowsLink = false, showPagesRestrictedByOwner = false, showPagesRestrictedByGroup = false, ): Promise => { let userGroups = _userGroups; if (user != null && userGroups == null) { const UserGroupRelation: any = mongoose.model('UserGroupRelation'); userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user); } const grantConditions: AnyObject[] = [ { grant: null }, { grant: GRANT_PUBLIC }, ]; if (showAnyoneKnowsLink) { grantConditions.push({ grant: GRANT_RESTRICTED }); } if (showPagesRestrictedByOwner) { grantConditions.push( { grant: GRANT_SPECIFIED }, { grant: GRANT_OWNER }, ); } else if (user != null) { grantConditions.push( { grant: GRANT_SPECIFIED, grantedUsers: user._id }, { grant: GRANT_OWNER, grantedUsers: user._id }, ); } if (showPagesRestrictedByGroup) { grantConditions.push( { grant: GRANT_USER_GROUP }, ); } else if (userGroups != null && userGroups.length > 0) { grantConditions.push( { grant: GRANT_USER_GROUP, grantedGroup: { $in: userGroups } }, ); } return { $match: { $or: grantConditions, }, }; };