src/Worker/ExpireAndRemoveUsers.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Worker;
  23
  24 use Friendica\Core\Logger;
  25 use Friendica\Database\DBA;
  26 use Friendica\Database\DBStructure;
  27 use Friendica\Model\Photo;
  28 use Friendica\Model\User;
  29 use Friendica\Util\DateTimeFormat;
  30
  31 /**
  32  * Expire and remove user entries
  33  */
  34 class ExpireAndRemoveUsers
  35 {
  36         public static function execute()
  37         {
  38                 // expire any expired regular accounts. Don't expire forums.
  39                 $condition = ["NOT `account_expired` AND `account_expires_on` > ? AND `account_expires_on` < ? AND `page-flags` = ? AND `uid` != ?",
  40                         DBA::NULL_DATETIME, DateTimeFormat::utcNow(), User::PAGE_FLAGS_NORMAL, 0];
  41                 DBA::update('user', ['account_expired' => true], $condition);
  42
  43                 // Ensure to never remove the user with uid=0
  44                 DBA::update('user', ['account_expired' => false, 'account_removed' => false,
  45                         'account_expires_on' => DBA::NULL_DATETIME], ['uid' => 0]);
  46
  47                 // Remove any freshly expired account
  48                 $users = DBA::select('user', ['uid'], ['account_expired' => true, 'account_removed' => false]);
  49                 while ($user = DBA::fetch($users)) {
  50                         if ($user['uid'] != 0) {
  51                                 User::remove($user['uid']);
  52                         }
  53                 }
  54                 DBA::close($users);
  55
  56                 // delete user records for recently removed accounts
  57                 $users = DBA::select('user', ['uid'], ["`account_removed` AND `account_expires_on` < ? AND `uid` != ?", DateTimeFormat::utcNow(), 0]);
  58                 while ($user = DBA::fetch($users)) {
  59                         Logger::info('Removing user - start', ['uid' => $user['uid']]);
  60                         // We have to delete photo entries by hand because otherwise the photo data won't be deleted
  61                         $result = Photo::delete(['uid' => $user['uid']]);
  62                         if ($result) {
  63                                 Logger::debug('Deleted user photos', ['result' => $result, 'rows' => DBA::affectedRows()]);
  64                         } else {
  65                                 Logger::warning('Error deleting user photos', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
  66                         }
  67
  68                         // Delete the contacts of this user
  69                         $self = DBA::selectFirst('contact', ['nurl'], ['self' => true, 'uid' => $user['uid']]);
  70                         if (DBA::isResult($self)) {
  71                                 $result = DBA::delete('contact', ['nurl' => $self['nurl'], 'self' => false]);
  72                                 if ($result) {
  73                                         Logger::debug('Deleted the user contact for other users', ['result' => $result, 'rows' => DBA::affectedRows()]);
  74                                 } else {
  75                                         Logger::warning('Error deleting the user contact for other users', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
  76                                 }
  77                         }
  78
  79                         // Delete all contacts of this user
  80                         $result = DBA::delete('contact', ['uid' => $user['uid']]);
  81                         if ($result) {
  82                                 Logger::debug('Deleted user contacts', ['result' => $result, 'rows' => DBA::affectedRows()]);
  83                         } else {
  84                                 Logger::warning('Error deleting user contacts', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
  85                         }
  86
  87                         // These tables contain the permissionset which will also be deleted when a user is deleted.
  88                         // It seems that sometimes the system wants to delete the records in the wrong order.
  89                         // So when the permissionset is deleted and these tables are still filled then an error is thrown.
  90                         // So we now delete them before all other user related entries are deleted.
  91                         if (DBStructure::existsTable('item')) {
  92                                 $result = DBA::delete('item', ['uid' => $user['uid']]);
  93                                 if ($result) {
  94                                         Logger::debug('Deleted user items', ['result' => $result, 'rows' => DBA::affectedRows()]);
  95                                 } else {
  96                                         Logger::warning('Error deleting user items', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
  97                                 }
  98                         }
  99                         $result = DBA::delete('post-user', ['uid' => $user['uid']]);
 100                         if ($result) {
 101                                 Logger::debug('Deleted post-user entries', ['result' => $result, 'rows' => DBA::affectedRows()]);
 102                         } else {
 103                                 Logger::warning('Error deleting post-user entries', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
 104                         }
 105
 106                         $result = DBA::delete('profile_field', ['uid' => $user['uid']]);
 107                         if ($result) {
 108                                 Logger::debug('Deleted profile_field entries', ['result' => $result, 'rows' => DBA::affectedRows()]);
 109                         } else {
 110                                 Logger::warning('Error deleting profile_field entries', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
 111                         }
 112
 113                         $result = DBA::delete('user', ['uid' => $user['uid']]);
 114                         if ($result) {
 115                                 Logger::debug('Deleted user record', ['result' => $result, 'rows' => DBA::affectedRows()]);
 116                         } else {
 117                                 Logger::warning('Error deleting user record', ['errno' => DBA::errorNo(), 'errmsg' => DBA::errorMessage()]);
 118                         }
 119
 120                         Logger::info('Removing user - done', ['uid' => $user['uid']]);
 121                 }
 122                 DBA::close($users);
 123         }
 124 }