const _ = require('lodash') const { db, ObjectId } = require('../../infrastructure/mongodb') const { callbackify } = require('util') const { Project } = require('../../models/Project') const { DeletedProject } = require('../../models/DeletedProject') const Errors = require('../Errors/Errors') const logger = require('logger-sharelatex') const DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler') const TagsHandler = require('../Tags/TagsHandler') const ProjectHelper = require('./ProjectHelper') const ProjectDetailsHandler = require('./ProjectDetailsHandler') const CollaboratorsHandler = require('../Collaborators/CollaboratorsHandler') const CollaboratorsGetter = require('../Collaborators/CollaboratorsGetter') const DocstoreManager = require('../Docstore/DocstoreManager') const EditorRealTimeController = require('../Editor/EditorRealTimeController') const HistoryManager = require('../History/HistoryManager') const FilestoreHandler = require('../FileStore/FileStoreHandler') const moment = require('moment') const { promiseMapWithLimit } = require('../../util/promises') const EXPIRE_PROJECTS_AFTER_DAYS = 90 const PROJECT_EXPIRATION_BATCH_SIZE = 10000 module.exports = { markAsDeletedByExternalSource: callbackify(markAsDeletedByExternalSource), unmarkAsDeletedByExternalSource: callbackify(unmarkAsDeletedByExternalSource), deleteUsersProjects: callbackify(deleteUsersProjects), expireDeletedProjectsAfterDuration: callbackify( expireDeletedProjectsAfterDuration ), restoreProject: callbackify(restoreProject), archiveProject: callbackify(archiveProject), unarchiveProject: callbackify(unarchiveProject), trashProject: callbackify(trashProject), untrashProject: callbackify(untrashProject), deleteProject: callbackify(deleteProject), undeleteProject: callbackify(undeleteProject), expireDeletedProject: callbackify(expireDeletedProject), promises: { archiveProject, unarchiveProject, trashProject, untrashProject, deleteProject, undeleteProject, expireDeletedProject, markAsDeletedByExternalSource, unmarkAsDeletedByExternalSource, deleteUsersProjects, expireDeletedProjectsAfterDuration, restoreProject } } async function markAsDeletedByExternalSource(projectId) { logger.log( { project_id: projectId }, 'marking project as deleted by external data source' ) await Project.updateOne( { _id: projectId }, { deletedByExternalDataSource: true } ).exec() EditorRealTimeController.emitToRoom( projectId, 'projectRenamedOrDeletedByExternalSource' ) } async function unmarkAsDeletedByExternalSource(projectId) { await Project.updateOne( { _id: projectId }, { deletedByExternalDataSource: false } ).exec() } async function deleteUsersProjects(userId) { const projects = await Project.find({ owner_ref: userId }).exec() await promiseMapWithLimit(5, projects, project => deleteProject(project._id)) await CollaboratorsHandler.promises.removeUserFromAllProjects(userId) } async function expireDeletedProjectsAfterDuration() { const deletedProjects = await DeletedProject.find( { 'deleterData.deletedAt': { $lt: new Date(moment().subtract(EXPIRE_PROJECTS_AFTER_DAYS, 'days')) }, project: { $ne: null } }, { 'deleterData.deletedProjectId': 1 } ).limit(PROJECT_EXPIRATION_BATCH_SIZE) const projectIds = _.shuffle( deletedProjects.map( deletedProject => deletedProject.deleterData.deletedProjectId ) ) for (const projectId of projectIds) { await expireDeletedProject(projectId) } } async function restoreProject(projectId) { await Project.updateOne( { _id: projectId }, { $unset: { archived: true } } ).exec() } async function archiveProject(projectId, userId) { try { let project = await Project.findOne({ _id: projectId }).exec() if (!project) { throw new Errors.NotFoundError('project not found') } const archived = ProjectHelper.calculateArchivedArray( project, userId, 'ARCHIVE' ) await Project.updateOne( { _id: projectId }, { $set: { archived: archived }, $pull: { trashed: ObjectId(userId) } } ) } catch (err) { logger.warn({ err }, 'problem archiving project') throw err } } async function unarchiveProject(projectId, userId) { try { let project = await Project.findOne({ _id: projectId }).exec() if (!project) { throw new Errors.NotFoundError('project not found') } const archived = ProjectHelper.calculateArchivedArray( project, userId, 'UNARCHIVE' ) await Project.updateOne( { _id: projectId }, { $set: { archived: archived } } ) } catch (err) { logger.warn({ err }, 'problem unarchiving project') throw err } } async function trashProject(projectId, userId) { try { let project = await Project.findOne({ _id: projectId }).exec() if (!project) { throw new Errors.NotFoundError('project not found') } const archived = ProjectHelper.calculateArchivedArray( project, userId, 'UNARCHIVE' ) await Project.updateOne( { _id: projectId }, { $addToSet: { trashed: ObjectId(userId) }, $set: { archived: archived } } ) } catch (err) { logger.warn({ err }, 'problem trashing project') throw err } } async function untrashProject(projectId, userId) { try { let project = await Project.findOne({ _id: projectId }).exec() if (!project) { throw new Errors.NotFoundError('project not found') } await Project.updateOne( { _id: projectId }, { $pull: { trashed: ObjectId(userId) } } ) } catch (err) { logger.warn({ err }, 'problem untrashing project') throw err } } async function deleteProject(projectId, options = {}) { try { const project = await Project.findOne({ _id: projectId }).exec() if (!project) { throw new Errors.NotFoundError('project not found') } const deleterData = { deletedAt: new Date(), deleterId: options.deleterUser != null ? options.deleterUser._id : undefined, deleterIpAddress: options.ipAddress, deletedProjectId: project._id, deletedProjectOwnerId: project.owner_ref, deletedProjectCollaboratorIds: project.collaberator_refs, deletedProjectReadOnlyIds: project.readOnly_refs, deletedProjectReadWriteTokenAccessIds: project.tokenAccessReadAndWrite_refs, deletedProjectOverleafId: project.overleaf ? project.overleaf.id : undefined, deletedProjectOverleafHistoryId: project.overleaf && project.overleaf.history ? project.overleaf.history.id : undefined, deletedProjectReadOnlyTokenAccessIds: project.tokenAccessReadOnly_refs, deletedProjectReadWriteToken: project.tokens.readAndWrite, deletedProjectReadOnlyToken: project.tokens.readOnly, deletedProjectLastUpdatedAt: project.lastUpdated } Object.keys(deleterData).forEach( key => (deleterData[key] === undefined ? delete deleterData[key] : '') ) await DeletedProject.updateOne( { 'deleterData.deletedProjectId': projectId }, { project, deleterData }, { upsert: true } ) await DocumentUpdaterHandler.promises.flushProjectToMongoAndDelete( projectId ) const memberIds = await CollaboratorsGetter.promises.getMemberIds(projectId) // fire these jobs in the background for (const memberId of memberIds) { TagsHandler.promises .removeProjectFromAllTags(memberId, projectId) .catch(err => { logger.err( { err, memberId, projectId }, 'failed to remove project from tags' ) }) } await Project.deleteOne({ _id: projectId }).exec() } catch (err) { logger.warn({ err }, 'problem deleting project') throw err } logger.log({ project_id: projectId }, 'successfully deleted project') } async function undeleteProject(projectId, options = {}) { let deletedProject = await DeletedProject.findOne({ 'deleterData.deletedProjectId': projectId }).exec() if (!deletedProject) { throw new Errors.NotFoundError('project_not_found') } if (!deletedProject.project) { throw new Errors.NotFoundError('project_too_old_to_restore') } let restored = new Project(deletedProject.project) if (options.userId) { restored.owner_ref = options.userId } // if we're undeleting, we want the document to show up restored.name = await ProjectDetailsHandler.promises.generateUniqueName( deletedProject.deleterData.deletedProjectOwnerId, restored.name + ' (Restored)' ) restored.archived = undefined // we can't use Mongoose to re-insert the project, as it won't // create a new document with an _id already specified. We need to // insert it directly into the collection await db.projects.insertOne(restored) await DeletedProject.deleteOne({ _id: deletedProject._id }).exec() } async function expireDeletedProject(projectId) { try { const deletedProject = await DeletedProject.findOne({ 'deleterData.deletedProjectId': projectId }).exec() if (!deletedProject) { throw new Errors.NotFoundError( `No deleted project found for project id ${projectId}` ) } if (!deletedProject.project) { logger.warn( { projectId }, `Attempted to expire already-expired deletedProject` ) return } await DocstoreManager.promises.destroyProject(deletedProject.project._id) await HistoryManager.promises.deleteProject(deletedProject.project._id) await FilestoreHandler.promises.deleteProject(deletedProject.project._id) await DeletedProject.updateOne( { _id: deletedProject._id }, { $set: { 'deleterData.deleterIpAddress': null, project: null } } ).exec() } catch (error) { logger.warn({ projectId, error }, 'error expiring deleted project') throw error } }