3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Worker;
24 use Friendica\Core\Logger;
25 use Friendica\Core\Worker;
26 use Friendica\Database\DBA;
30 * The script is called from time to time to clean the database entries and remove orphaned data.
33 public static function execute($stage = 0) {
35 if (!DI::config()->get('system', 'dbclean', false)) {
40 self::forkCleanProcess();
42 self::removeOrphans($stage);
47 * Fork the different DBClean processes
49 private static function forkCleanProcess() {
50 // Get the expire days for step 8 and 9
51 $days = DI::config()->get('system', 'dbclean-expire-days', 0);
53 for ($i = 1; $i <= 10; $i++) {
54 // Execute the background script for a step when it isn't finished.
55 // Execute step 8 and 9 only when $days is defined.
56 if (!DI::config()->get('system', 'finished-dbclean-'.$i, false) && (($i < 8) || ($i > 9) || ($days > 0))) {
57 Worker::add(PRIORITY_LOW, 'DBClean', $i);
63 * Remove orphaned database entries
65 * @param integer $stage What should be deleted?
69 * 1: Old global item entries from item table without user copy.
70 * 2: Items without parents.
71 * 3: Orphaned data from thread table.
72 * 4: Orphaned data from notify table.
73 * 5: Orphaned data from notify-threads table.
74 * 6: Orphaned data from sign table.
75 * 7: Orphaned data from term table.
77 * 9: Old global item entries from expired threads.
78 * 10: Old conversations.
79 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
81 private static function removeOrphans($stage) {
82 // We split the deletion in many small tasks
83 $limit = DI::config()->get('system', 'dbclean-expire-limit', 1000);
85 // Get the expire days for step 8 and 9
86 $days = DI::config()->get('system', 'dbclean-expire-days', 0);
87 $days_unclaimed = DI::config()->get('system', 'dbclean-expire-unclaimed', 90);
89 if ($days_unclaimed == 0) {
90 $days_unclaimed = $days;
94 if ($days_unclaimed <= 0) {
98 $last_id = DI::config()->get('system', 'dbclean-last-id-1', 0);
100 Logger::log("Deleting old global item entries from item table without user copy. Last ID: ".$last_id);
101 $r = DBA::p("SELECT `id` FROM `item` WHERE `uid` = 0 AND
102 NOT EXISTS (SELECT `guid` FROM `item` AS `i` WHERE `item`.`guid` = `i`.`guid` AND `i`.`uid` != 0) AND
103 `received` < UTC_TIMESTAMP() - INTERVAL ? DAY AND `id` >= ?
104 ORDER BY `id` LIMIT ?", $days_unclaimed, $last_id, $limit);
105 $count = DBA::numRows($r);
107 Logger::log("found global item orphans: ".$count);
108 while ($orphan = DBA::fetch($r)) {
109 $last_id = $orphan["id"];
110 DBA::delete('item', ['id' => $orphan["id"]]);
112 Worker::add(PRIORITY_MEDIUM, 'DBClean', 1, $last_id);
114 Logger::log("No global item orphans found");
117 Logger::log("Done deleting ".$count." old global item entries from item table without user copy. Last ID: ".$last_id);
119 DI::config()->set('system', 'dbclean-last-id-1', $last_id);
120 } elseif ($stage == 2) {
121 $last_id = DI::config()->get('system', 'dbclean-last-id-2', 0);
123 Logger::log("Deleting items without parents. Last ID: ".$last_id);
124 $r = DBA::p("SELECT `id` FROM `item`
125 WHERE NOT EXISTS (SELECT `id` FROM `item` AS `i` WHERE `item`.`parent` = `i`.`id`)
126 AND `id` >= ? ORDER BY `id` LIMIT ?", $last_id, $limit);
127 $count = DBA::numRows($r);
129 Logger::log("found item orphans without parents: ".$count);
130 while ($orphan = DBA::fetch($r)) {
131 $last_id = $orphan["id"];
132 DBA::delete('item', ['id' => $orphan["id"]]);
134 Worker::add(PRIORITY_MEDIUM, 'DBClean', 2, $last_id);
136 Logger::log("No item orphans without parents found");
139 Logger::log("Done deleting ".$count." items without parents. Last ID: ".$last_id);
141 DI::config()->set('system', 'dbclean-last-id-2', $last_id);
143 if ($count < $limit) {
144 DI::config()->set('system', 'finished-dbclean-2', true);
146 } elseif ($stage == 3) {
147 $last_id = DI::config()->get('system', 'dbclean-last-id-3', 0);
149 Logger::log("Deleting orphaned data from thread table. Last ID: ".$last_id);
150 $r = DBA::p("SELECT `iid` FROM `thread`
151 WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`parent` = `thread`.`iid`) AND `iid` >= ?
152 ORDER BY `iid` LIMIT ?", $last_id, $limit);
153 $count = DBA::numRows($r);
155 Logger::log("found thread orphans: ".$count);
156 while ($orphan = DBA::fetch($r)) {
157 $last_id = $orphan["iid"];
158 DBA::delete('thread', ['iid' => $orphan["iid"]]);
160 Worker::add(PRIORITY_MEDIUM, 'DBClean', 3, $last_id);
162 Logger::log("No thread orphans found");
165 Logger::log("Done deleting ".$count." orphaned data from thread table. Last ID: ".$last_id);
167 DI::config()->set('system', 'dbclean-last-id-3', $last_id);
169 if ($count < $limit) {
170 DI::config()->set('system', 'finished-dbclean-3', true);
172 } elseif ($stage == 4) {
173 $last_id = DI::config()->get('system', 'dbclean-last-id-4', 0);
175 Logger::log("Deleting orphaned data from notify table. Last ID: ".$last_id);
176 $r = DBA::p("SELECT `iid`, `id` FROM `notify`
177 WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `notify`.`iid`) AND `id` >= ?
178 ORDER BY `id` LIMIT ?", $last_id, $limit);
179 $count = DBA::numRows($r);
181 Logger::log("found notify orphans: ".$count);
182 while ($orphan = DBA::fetch($r)) {
183 $last_id = $orphan["id"];
184 DBA::delete('notify', ['iid' => $orphan["iid"]]);
186 Worker::add(PRIORITY_MEDIUM, 'DBClean', 4, $last_id);
188 Logger::log("No notify orphans found");
191 Logger::log("Done deleting ".$count." orphaned data from notify table. Last ID: ".$last_id);
193 DI::config()->set('system', 'dbclean-last-id-4', $last_id);
195 if ($count < $limit) {
196 DI::config()->set('system', 'finished-dbclean-4', true);
198 } elseif ($stage == 5) {
199 $last_id = DI::config()->get('system', 'dbclean-last-id-5', 0);
201 Logger::log("Deleting orphaned data from notify-threads table. Last ID: ".$last_id);
202 $r = DBA::p("SELECT `id` FROM `notify-threads`
203 WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`parent` = `notify-threads`.`master-parent-item`) AND `id` >= ?
204 ORDER BY `id` LIMIT ?", $last_id, $limit);
205 $count = DBA::numRows($r);
207 Logger::log("found notify-threads orphans: ".$count);
208 while ($orphan = DBA::fetch($r)) {
209 $last_id = $orphan["id"];
210 DBA::delete('notify-threads', ['id' => $orphan["id"]]);
212 Worker::add(PRIORITY_MEDIUM, 'DBClean', 5, $last_id);
214 Logger::log("No notify-threads orphans found");
217 Logger::log("Done deleting ".$count." orphaned data from notify-threads table. Last ID: ".$last_id);
219 DI::config()->set('system', 'dbclean-last-id-5', $last_id);
221 if ($count < $limit) {
222 DI::config()->set('system', 'finished-dbclean-5', true);
224 } elseif ($stage == 6) {
225 $last_id = DI::config()->get('system', 'dbclean-last-id-6', 0);
227 Logger::log("Deleting orphaned data from sign table. Last ID: ".$last_id);
228 $r = DBA::p("SELECT `iid`, `id` FROM `sign`
229 WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `sign`.`iid`) AND `id` >= ?
230 ORDER BY `id` LIMIT ?", $last_id, $limit);
231 $count = DBA::numRows($r);
233 Logger::log("found sign orphans: ".$count);
234 while ($orphan = DBA::fetch($r)) {
235 $last_id = $orphan["id"];
236 DBA::delete('sign', ['iid' => $orphan["iid"]]);
238 Worker::add(PRIORITY_MEDIUM, 'DBClean', 6, $last_id);
240 Logger::log("No sign orphans found");
243 Logger::log("Done deleting ".$count." orphaned data from sign table. Last ID: ".$last_id);
245 DI::config()->set('system', 'dbclean-last-id-6', $last_id);
247 if ($count < $limit) {
248 DI::config()->set('system', 'finished-dbclean-6', true);
250 } elseif ($stage == 7) {
251 $last_id = DI::config()->get('system', 'dbclean-last-id-7', 0);
253 Logger::log("Deleting orphaned data from term table. Last ID: ".$last_id);
254 $r = DBA::p("SELECT `oid`, `tid` FROM `term`
255 WHERE NOT EXISTS (SELECT `id` FROM `item` WHERE `item`.`id` = `term`.`oid`) AND `tid` >= ?
256 ORDER BY `tid` LIMIT ?", $last_id, $limit);
257 $count = DBA::numRows($r);
259 Logger::log("found term orphans: ".$count);
260 while ($orphan = DBA::fetch($r)) {
261 $last_id = $orphan["tid"];
262 DBA::delete('term', ['oid' => $orphan["oid"]]);
264 Worker::add(PRIORITY_MEDIUM, 'DBClean', 7, $last_id);
266 Logger::log("No term orphans found");
269 Logger::log("Done deleting ".$count." orphaned data from term table. Last ID: ".$last_id);
271 DI::config()->set('system', 'dbclean-last-id-7', $last_id);
273 if ($count < $limit) {
274 DI::config()->set('system', 'finished-dbclean-7', true);
276 } elseif ($stage == 8) {
281 $last_id = DI::config()->get('system', 'dbclean-last-id-8', 0);
283 Logger::log("Deleting expired threads. Last ID: ".$last_id);
284 $r = DBA::p("SELECT `thread`.`iid` FROM `thread`
285 INNER JOIN `contact` ON `thread`.`contact-id` = `contact`.`id` AND NOT `notify_new_posts`
286 WHERE `thread`.`received` < UTC_TIMESTAMP() - INTERVAL ? DAY
287 AND NOT `thread`.`mention` AND NOT `thread`.`starred`
288 AND NOT `thread`.`wall` AND NOT `thread`.`origin`
289 AND `thread`.`uid` != 0 AND `thread`.`iid` >= ?
290 AND NOT `thread`.`iid` IN (SELECT `parent` FROM `item`
291 WHERE (`item`.`starred` OR (`item`.`resource-id` != '')
292 OR (`item`.`file` != '') OR (`item`.`event-id` != '')
293 OR (`item`.`attach` != '') OR `item`.`wall` OR `item`.`origin`)
294 AND `item`.`parent` = `thread`.`iid`)
295 ORDER BY `thread`.`iid` LIMIT ?", $days, $last_id, $limit);
296 $count = DBA::numRows($r);
298 Logger::log("found expired threads: ".$count);
299 while ($thread = DBA::fetch($r)) {
300 $last_id = $thread["iid"];
301 DBA::delete('thread', ['iid' => $thread["iid"]]);
303 Worker::add(PRIORITY_MEDIUM, 'DBClean', 8, $last_id);
305 Logger::log("No expired threads found");
308 Logger::log("Done deleting ".$count." expired threads. Last ID: ".$last_id);
310 DI::config()->set('system', 'dbclean-last-id-8', $last_id);
311 } elseif ($stage == 9) {
316 $last_id = DI::config()->get('system', 'dbclean-last-id-9', 0);
317 $till_id = DI::config()->get('system', 'dbclean-last-id-8', 0);
319 Logger::log("Deleting old global item entries from expired threads from ID ".$last_id." to ID ".$till_id);
320 $r = DBA::p("SELECT `id` FROM `item` WHERE `uid` = 0 AND
321 NOT EXISTS (SELECT `guid` FROM `item` AS `i` WHERE `item`.`guid` = `i`.`guid` AND `i`.`uid` != 0) AND
322 `received` < UTC_TIMESTAMP() - INTERVAL 90 DAY AND `id` >= ? AND `id` <= ?
323 ORDER BY `id` LIMIT ?", $last_id, $till_id, $limit);
324 $count = DBA::numRows($r);
326 Logger::log("found global item entries from expired threads: ".$count);
327 while ($orphan = DBA::fetch($r)) {
328 $last_id = $orphan["id"];
329 DBA::delete('item', ['id' => $orphan["id"]]);
331 Worker::add(PRIORITY_MEDIUM, 'DBClean', 9, $last_id);
333 Logger::log("No global item entries from expired threads");
336 Logger::log("Done deleting ".$count." old global item entries from expired threads. Last ID: ".$last_id);
338 DI::config()->set('system', 'dbclean-last-id-9', $last_id);
339 } elseif ($stage == 10) {
340 $last_id = DI::config()->get('system', 'dbclean-last-id-10', 0);
341 $days = intval(DI::config()->get('system', 'dbclean_expire_conversation', 90));
343 Logger::log("Deleting old conversations. Last created: ".$last_id);
344 $r = DBA::p("SELECT `received`, `item-uri` FROM `conversation`
345 WHERE `received` < UTC_TIMESTAMP() - INTERVAL ? DAY
346 ORDER BY `received` LIMIT ?", $days, $limit);
347 $count = DBA::numRows($r);
349 Logger::log("found old conversations: ".$count);
350 while ($orphan = DBA::fetch($r)) {
351 $last_id = $orphan["received"];
352 DBA::delete('conversation', ['item-uri' => $orphan["item-uri"]]);
354 Worker::add(PRIORITY_MEDIUM, 'DBClean', 10, $last_id);
356 Logger::log("No old conversations found");
359 Logger::log("Done deleting ".$count." conversations. Last created: ".$last_id);
361 DI::config()->set('system', 'dbclean-last-id-10', $last_id);