> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Deleted Projects 集合

`deletedProjects` 在项目被删除后保留该项目：每个被删除的项目一个文档，包含整个项目文档的副本以及删除者。Web 在 `services/web/app/src/Features/Project/ProjectDeleter.mjs` 中写入它；schema 是 `services/web/app/src/models/DeletedProject.mjs`。硬删除延迟过后，过期处理会销毁项目数据并清空 `project`，但带有 `deleterData` 的记录会保留下来。

回收站中的项目不在这里：移入回收站只会把用户加入项目的 `trashed`，参见 [Projects 集合](https://ayakaleaf-pro.mintlify.site/zh-CN/dev/data-model/projects-collection.md)。

#### 字段

| 字段 | 类型 | 含义 | 来源 |
| - | - | - | - |
| `_id` | ObjectId | 记录 id，不是项目 id。 | `DeletedProject.mjs:26` |
| `project` | Object | 删除时 `projects` 文档的副本，使用项目 schema。记录过期后为 `null`。 | `DeletedProject.mjs:29`, `ProjectDeleter.mjs:277-281,400-410` |
| `deleterData` | Object | 谁删除了项目，以及过期后仍保留的摘要。值为 `undefined` 的键会被省略。 | `DeletedProject.mjs:7-24,28`, `ProjectDeleter.mjs:247-275` |
| `deleterData.deletedAt` | Date | 删除时间。过期在其后 `projectHardDeletionDelay` 执行：90 天，或 `OVERLEAF_PROJECT_HARD_DELETION_DELAY` 毫秒（`services/web/config/settings.defaults.js:742-744`）。 | `DeletedProject.mjs:10`, `ProjectDeleter.mjs:248` |
| `deleterData.deleterId` | ObjectId | 删除项目的用户。不是由用户直接删除时缺失，参见 `deletedReason`。 | `DeletedProject.mjs:8`, `ProjectDeleter.mjs:249-250` |
| `deleterData.deleterIpAddress` | String | 该请求的 IP 地址。过期时设为 `null`。 | `DeletedProject.mjs:9`, `ProjectDeleter.mjs:251,406` |
| `deleterData.deletedReason` | String | 项目被删除的原因，见下表。较旧的记录没有此字段。 | `DeletedProject.mjs:23`, `ProjectDeleter.mjs:252` |
| `deleterData.deletedProjectId` | ObjectId | 被删除项目的 `_id`。查找单条记录时使用它。 | `DeletedProject.mjs:11`, `ProjectDeleter.mjs:253` |
| `deleterData.deletedProjectOwnerId` | ObjectId | 项目的 `owner_ref`。 | `DeletedProject.mjs:12`, `ProjectDeleter.mjs:254` |
| `deleterData.deletedProjectCollaboratorIds` | Array of ObjectId | 项目的 `collaberator_refs`。 | `DeletedProject.mjs:13`, `ProjectDeleter.mjs:255` |
| `deleterData.deletedProjectReadOnlyIds` | Array of ObjectId | 项目的 `readOnly_refs`。 | `DeletedProject.mjs:14`, `ProjectDeleter.mjs:256` |
| `deleterData.deletedProjectReviewerIds` | Array of ObjectId | 项目的 `reviewer_refs`。 | `DeletedProject.mjs:15`, `ProjectDeleter.mjs:257` |
| `deleterData.deletedProjectReadWriteTokenAccessIds` | Array of ObjectId | 项目的 `tokenAccessReadAndWrite_refs`。 | `DeletedProject.mjs:16`, `ProjectDeleter.mjs:258-259` |
| `deleterData.deletedProjectReadOnlyTokenAccessIds` | Array of ObjectId | 项目的 `tokenAccessReadOnly_refs`。 | `DeletedProject.mjs:17`, `ProjectDeleter.mjs:267` |
| `deleterData.deletedProjectReadWriteToken` | String | 项目的 `tokens.readAndWrite`（如果有）。 | `DeletedProject.mjs:18`, `ProjectDeleter.mjs:268` |
| `deleterData.deletedProjectReadOnlyToken` | String | 项目的 `tokens.readOnly`（如果有）。 | `DeletedProject.mjs:19`, `ProjectDeleter.mjs:269` |
| `deleterData.deletedProjectLastUpdatedAt` | Date | 项目的 `lastUpdated`。 | `DeletedProject.mjs:20`, `ProjectDeleter.mjs:270` |
| `deleterData.deletedProjectOverleafId` | Number | 项目的 `overleaf.id`（如已设置）。 | `DeletedProject.mjs:21`, `ProjectDeleter.mjs:260-262` |
| `deleterData.deletedProjectOverleafHistoryId` | Mixed | 项目的 `overleaf.history.id`（如已设置）。 | `DeletedProject.mjs:22`, `ProjectDeleter.mjs:263-266` |

`deletedReason` 的取值（`services/web/app/src/Features/Project/DeletedProjectReasons.mjs:1-8`）：

| 值 | 何时设置 | `deleterId` |
| - | - | - |
| `user` | 用户在项目列表中删除项目（`services/web/app/src/Features/Project/ProjectController.mjs:281-291`），或管理员在管理面板中删除它（`services/web/modules/admin-tools/app/src/AdminProjectManager.mjs:486-491`） | 有 |
| `account-deletion` | 所有者的账户被删除（`ProjectDeleter.mjs:82-95`，由 `services/web/app/src/Features/User/UserDeleter.mjs:66` 调用） | 缺失 |
| `zip-import-failure` | 从上传的 zip 创建项目失败（`services/web/app/src/Features/Uploads/ProjectUploadManager.mjs:58-61,103-104`） | 缺失 |
| `clone-failure` | 复制项目失败；损坏的副本被删除（`services/web/app/src/Features/Project/ProjectDuplicator.mjs:202-207`） | 缺失 |
| `script` | `services/web/scripts/soft_delete_project.mjs:15-17` | 缺失 |
| `github-import-failure` | 已定义，但本仓库中没有任何代码使用 | |

#### 写入方

| 代码 | 作用 |
| - | - |
| `ProjectDeleter.mjs:189-293`（`deleteProject`） | 刷写项目，把其 docs 从 Mongo 归档出去，将其从标签中移除，upsert 记录并删除 `projects` 文档。 |
| `ProjectDeleter.mjs:295-342`（`undeleteProject`） | 以 `<name> (Restored)` 的名称（对所有者唯一）重新插入项目并取消归档，然后删除记录。一旦 `project` 为 `null`，就以 `project_too_old_to_restore` 失败。由管理面板调用：恢复一个项目（`AdminProjectManager.mjs:497-515`），或恢复已删除用户及随账户一起删除的项目（`services/web/modules/admin-tools/app/src/AdminUserManager.mjs:678-689`）。 |
| `ProjectDeleter.mjs:344-416`（`expireDeletedProject`） | 销毁项目的 docs、历史、聊天和项目审计日志并触发 `projectExpired` hook，然后将 `project` 和 `deleterData.deleterIpAddress` 设为 `null`。如果项目又存在了，则只删除过时的记录。 |
| `ProjectDeleter.mjs:97-146`（`expireDeletedProjectsAfterDuration`） | 让一批早于延迟时间的记录过期。路由 `POST /internal/expire-deleted-projects-after-duration`（`services/web/app/src/router.mjs:842-846`），当 `ENABLE_CRON_RESOURCE_DELETION` 为 `true` 时，Community Edition 的 cron 每小时第 20 分钟调用它（`server-ce/cron/delete-projects.sh:10-23`, `server-ce/config/crontab-deletion:3`）。单个项目：`POST /internal/project/:projectId/expire-deleted-project`（`router.mjs:852-856`），或管理面板中的 Purge（`AdminProjectManager.mjs:517-529`）。 |

#### 读取方

| 代码 | 作用 |
| - | - |
| `AdminProjectManager.mjs:129-140,204-272`（模块 `admin-tools`） | 列出尚未过期的已删除项目。 |
| `AdminProjectManager.mjs:418-454` | 显示一个已删除项目及其所有者和删除者。 |
| `AdminProjectManager.mjs:178-191` | 通过链接共享 token 查找项目，包括已删除的项目（`project.tokens.*`）。 |
| `AdminUserManager.mjs:678-684` | 查找随恢复的用户一起找回的项目：属于该用户，且删除原因为 `account-deletion` 或没有原因。 |

#### 索引

| 名称 | 键 | 选项 | 迁移 |
| - | - | - | - |
| `deleterData.deletedProjectId_1` | `{ "deleterData.deletedProjectId": 1 }` | unique | `20190912145002_create_deletedProjects_indexes.mjs`，由 `20200210121103_uniqueify-deletedthings-indexes.mjs` 改为唯一 |
| `deleterdata_deletedProjectOwnerId_1` | `{ "deleterData.deletedProjectOwnerId": 1 }` | | `20200120163346_atlas_recommended_indexes.mjs` |
| `deleterData.deletedAt_1` | `{ "deleterData.deletedAt": 1 }` | 部分索引：`project` 是对象 | `20250126195914_update_deleterData.deletedAt_index.mjs`（替换 `20190912145002_create_deletedProjects_indexes.mjs` 中的普通索引） |

迁移位于 `tools/migrations/`。

#### 说明

* 监听 `projectExpired` 的模块会删除它们自己保存的该项目数据：`git-bridge`（`services/web/modules/git-bridge/index.mjs:37`）、`github-sync`（`services/web/modules/github-sync/index.mjs:56`）、`gitlab-sync`（`services/web/modules/gitlab-sync/index.mjs:46`）、`gitea-sync`（`services/web/modules/gitea-sync/index.mjs:46`）和 `dropbox`（`services/web/modules/dropbox/index.mjs:54`）。
* 过期的记录永远不会被删除：`deleterData` 会永久保留，只有 `project` 和 IP 地址会被清空。
* Mongoose 还会给 `deleterData` 分配它自己的 `_id`，没有任何代码读取它。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.