src/Core/UserImport.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\Core;
  23
  24 use Friendica\Database\DBA;
  25 use Friendica\Database\DBStructure;
  26 use Friendica\DI;
  27 use Friendica\Model\Photo;
  28 use Friendica\Model\Profile;
  29 use Friendica\Object\Image;
  30 use Friendica\Security\PermissionSet\Repository\PermissionSet;
  31 use Friendica\Util\Strings;
  32 use Friendica\Worker\Delivery;
  33
  34 /**
  35  * UserImport class
  36  */
  37 class UserImport
  38 {
  39         const IMPORT_DEBUG = false;
  40
  41         private static function lastInsertId()
  42         {
  43                 if (self::IMPORT_DEBUG) {
  44                         return 1;
  45                 }
  46
  47                 return DBA::lastInsertId();
  48         }
  49
  50         /**
  51          * Remove columns from array $arr that aren't in table $table
  52          *
  53          * @param string $table Table name
  54          * @param array &$arr   Column=>Value array from json (by ref)
  55          * @throws \Exception
  56          */
  57         private static function checkCols($table, &$arr)
  58         {
  59                 $tableColumns = DBStructure::getColumns($table);
  60
  61                 $tcols = [];
  62                 $ttype = [];
  63                 // get a plain array of column names
  64                 foreach ($tableColumns as $tcol) {
  65                         $tcols[] = $tcol['Field'];
  66                         $ttype[$tcol['Field']] = $tcol['Type'];
  67                 }
  68                 // remove inexistent columns
  69                 foreach ($arr as $icol => $ival) {
  70                         if (!in_array($icol, $tcols)) {
  71                                 unset($arr[$icol]);
  72                                 continue;
  73                         }
  74
  75                         if ($ttype[$icol] === 'datetime') {
  76                                 $arr[$icol] = $ival ?? DBA::NULL_DATETIME;
  77                         }
  78                 }
  79         }
  80
  81         /**
  82          * Import data into table $table
  83          *
  84          * @param string $table Table name
  85          * @param array  $arr   Column=>Value array from json
  86          * @return array|bool
  87          * @throws \Exception
  88          */
  89         private static function dbImportAssoc(string $table, array $arr)
  90         {
  91                 if (isset($arr['id'])) {
  92                         unset($arr['id']);
  93                 }
  94
  95                 self::checkCols($table, $arr);
  96
  97                 if (self::IMPORT_DEBUG) {
  98                         return true;
  99                 }
 100
 101                 return DBA::insert($table, $arr);
 102         }
 103
 104         /**
 105          * Import account file exported from mod/uexport
 106          *
 107          * @param array $file array from $_FILES
 108          * @return void
 109          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 110          * @throws \ImagickException
 111          */
 112         public static function importAccount(array $file)
 113         {
 114                 Logger::notice("Start user import from " . $file['tmp_name']);
 115                 /*
 116                 STEPS
 117                 1. checks
 118                 2. replace old baseurl with new baseurl
 119                 3. import data (look at user id and contacts id)
 120                 4. archive non-dfrn contacts
 121                 5. send message to dfrn contacts
 122                 */
 123
 124                 $account = json_decode(file_get_contents($file['tmp_name']), true);
 125                 if ($account === null) {
 126                         DI::sysmsg()->addNotice(DI::l10n()->t("Error decoding account file"));
 127                         return;
 128                 }
 129
 130
 131                 if (empty($account['version'])) {
 132                         DI::sysmsg()->addNotice(DI::l10n()->t("Error! No version data in file! This is not a Friendica account file?"));
 133                         return;
 134                 }
 135
 136                 // check for username
 137                 // check if username matches deleted account
 138                 if (DBA::exists('user', ['nickname' => $account['user']['nickname']])
 139                         || DBA::exists('userd', ['username' => $account['user']['nickname']])) {
 140                         DI::sysmsg()->addNotice(DI::l10n()->t("User '%s' already exists on this server!", $account['user']['nickname']));
 141                         return;
 142                 }
 143
 144                 $oldbaseurl = $account['baseurl'];
 145                 $newbaseurl = DI::baseUrl();
 146
 147                 $oldaddr = str_replace('http://', '@', Strings::normaliseLink($oldbaseurl));
 148                 $newaddr = str_replace('http://', '@', Strings::normaliseLink($newbaseurl));
 149
 150                 if (!empty($account['profile']['addr'])) {
 151                         $old_handle = $account['profile']['addr'];
 152                 } else {
 153                         $old_handle = $account['user']['nickname'].$oldaddr;
 154                 }
 155
 156                 // Creating a new guid to avoid problems with Diaspora
 157                 $account['user']['guid'] = System::createUUID();
 158
 159                 $olduid = $account['user']['uid'];
 160
 161                 unset($account['user']['uid']);
 162                 unset($account['user']['account_expired']);
 163                 unset($account['user']['account_expires_on']);
 164                 unset($account['user']['expire_notification_sent']);
 165
 166                 $callback = function (&$value) use ($oldbaseurl, $oldaddr, $newbaseurl, $newaddr) {
 167                         $value =  str_replace([$oldbaseurl, $oldaddr], [$newbaseurl, $newaddr], $value);
 168                 };
 169
 170                 array_walk($account['user'], $callback);
 171
 172                 // import user
 173                 $r = self::dbImportAssoc('user', $account['user']);
 174                 if ($r === false) {
 175                         Logger::warning("uimport:insert user : ERROR : " . DBA::errorMessage());
 176                         DI::sysmsg()->addNotice(DI::l10n()->t("User creation error"));
 177                         return;
 178                 }
 179                 $newuid = self::lastInsertId();
 180
 181                 DI::pConfig()->set($newuid, 'system', 'previous_addr', $old_handle);
 182
 183                 $errorcount = 0;
 184                 foreach ($account['contact'] as &$contact) {
 185                         if ($contact['uid'] == $olduid && $contact['self'] == '1') {
 186                                 foreach ($contact as $k => &$v) {
 187                                         $v = str_replace([$oldbaseurl, $oldaddr], [$newbaseurl, $newaddr], $v);
 188                                         foreach (["profile", "avatar", "micro"] as $k) {
 189                                                 $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
 190                                         }
 191                                 }
 192                         }
 193                         if ($contact['uid'] == $olduid && $contact['self'] == '0') {
 194                                 // set contacts 'avatar-date' to NULL_DATE to let worker to update urls
 195                                 $contact["avatar-date"] = DBA::NULL_DATETIME;
 196
 197                                 switch ($contact['network']) {
 198                                         case Protocol::DFRN:
 199                                         case Protocol::DIASPORA:
 200                                                 //  send relocate message (below)
 201                                                 break;
 202                                         case Protocol::FEED:
 203                                         case Protocol::MAIL:
 204                                                 // Nothing to do
 205                                                 break;
 206                                         default:
 207                                                 // archive other contacts
 208                                                 $contact['archive'] = "1";
 209                                 }
 210                         }
 211                         $contact['uid'] = $newuid;
 212                         $r = self::dbImportAssoc('contact', $contact);
 213                         if ($r === false) {
 214                                 Logger::warning("uimport:insert contact " . $contact['nick'] . "," . $contact['network'] . " : ERROR : " . DBA::errorMessage());
 215                                 $errorcount++;
 216                         } else {
 217                                 $contact['newid'] = self::lastInsertId();
 218                         }
 219                 }
 220                 if ($errorcount > 0) {
 221                         DI::sysmsg()->addNotice(DI::l10n()->tt("%d contact not imported", "%d contacts not imported", $errorcount));
 222                 }
 223
 224                 foreach ($account['group'] as &$group) {
 225                         $group['uid'] = $newuid;
 226                         $r = self::dbImportAssoc('group', $group);
 227                         if ($r === false) {
 228                                 Logger::warning("uimport:insert group " . $group['name'] . " : ERROR : " . DBA::errorMessage());
 229                         } else {
 230                                 $group['newid'] = self::lastInsertId();
 231                         }
 232                 }
 233
 234                 foreach ($account['group_member'] as &$group_member) {
 235                         $import = 0;
 236                         foreach ($account['group'] as $group) {
 237                                 if ($group['id'] == $group_member['gid'] && isset($group['newid'])) {
 238                                         $group_member['gid'] = $group['newid'];
 239                                         $import++;
 240                                         break;
 241                                 }
 242                         }
 243                         foreach ($account['contact'] as $contact) {
 244                                 if ($contact['id'] == $group_member['contact-id'] && isset($contact['newid'])) {
 245                                         $group_member['contact-id'] = $contact['newid'];
 246                                         $import++;
 247                                         break;
 248                                 }
 249                         }
 250                         if ($import == 2) {
 251                                 $r = self::dbImportAssoc('group_member', $group_member);
 252                                 if ($r === false) {
 253                                         Logger::warning("uimport:insert group member " . $group_member['id'] . " : ERROR : " . DBA::errorMessage());
 254                                 }
 255                         }
 256                 }
 257
 258                 foreach ($account['profile'] as &$profile) {
 259                         unset($profile['id']);
 260                         $profile['uid'] = $newuid;
 261
 262                         foreach ($profile as $k => &$v) {
 263                                 $v = str_replace([$oldbaseurl, $oldaddr], [$newbaseurl, $newaddr], $v);
 264                                 foreach (["profile", "avatar"] as $k) {
 265                                         $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
 266                                 }
 267                         }
 268
 269                         if (count($account['profile']) === 1 || $profile['is-default']) {
 270                                 $r = self::dbImportAssoc('profile', $profile);
 271
 272                                 if ($r === false) {
 273                                         Logger::warning("uimport:insert profile: ERROR : " . DBA::errorMessage());
 274                                         DI::sysmsg()->addNotice(DI::l10n()->t("User profile creation error"));
 275                                         DBA::delete('user', ['uid' => $newuid]);
 276                                         DBA::delete('profile_field', ['uid' => $newuid]);
 277                                         return;
 278                                 }
 279
 280                                 $profile['id'] = DBA::lastInsertId();
 281                         }
 282
 283                         Profile::migrate($profile);
 284                 }
 285
 286                 $permissionSet = DI::permissionSet()->selectDefaultForUser($newuid);
 287
 288                 foreach ($account['profile_fields'] ?? [] as $profile_field) {
 289                         $profile_field['uid'] = $newuid;
 290
 291                         ///@TODO Replace with permissionset import
 292                         $profile_field['psid'] = $profile_field['psid'] ? $permissionSet->uid : PermissionSet::PUBLIC;
 293
 294                         if (self::dbImportAssoc('profile_field', $profile_field) === false) {
 295                                 Logger::info("uimport:insert profile field " . $profile_field['id'] . " : ERROR : " . DBA::errorMessage());
 296                         }
 297                 }
 298
 299                 foreach ($account['photo'] as &$photo) {
 300                         $photo['uid'] = $newuid;
 301                         $photo['data'] = hex2bin($photo['data']);
 302
 303                         $Image = new Image($photo['data'], $photo['type']);
 304                         $r = Photo::store(
 305                                 $Image,
 306                                 $photo['uid'], $photo['contact-id'], //0
 307                                 $photo['resource-id'], $photo['filename'], $photo['album'], $photo['scale'], $photo['profile'], //1
 308                                 $photo['allow_cid'], $photo['allow_gid'], $photo['deny_cid'], $photo['deny_gid']
 309                         );
 310
 311                         if ($r === false) {
 312                                 Logger::warning("uimport:insert photo " . $photo['resource-id'] . "," . $photo['scale'] . " : ERROR : " . DBA::errorMessage());
 313                         }
 314                 }
 315
 316                 foreach ($account['pconfig'] as &$pconfig) {
 317                         $pconfig['uid'] = $newuid;
 318                         $r = self::dbImportAssoc('pconfig', $pconfig);
 319                         if ($r === false) {
 320                                 Logger::warning("uimport:insert pconfig " . $pconfig['id'] . " : ERROR : " . DBA::errorMessage());
 321                         }
 322                 }
 323
 324                 // send relocate messages
 325                 Worker::add(Worker::PRIORITY_HIGH, 'Notifier', Delivery::RELOCATION, $newuid);
 326
 327                 DI::sysmsg()->addInfo(DI::l10n()->t("Done. You can now login with your username and password"));
 328                 DI::baseUrl()->redirect('login');
 329         }
 330 }