Merge pull request #4225 from zeroadam/UserImport-#3878
authorHypolite Petovan <mrpetovan@gmail.com>
Sun, 14 Jan 2018 22:21:26 +0000 (17:21 -0500)
committerGitHub <noreply@github.com>
Sun, 14 Jan 2018 22:21:26 +0000 (17:21 -0500)
Move include/uimport to src

include/uimport.php [deleted file]
mod/uimport.php
src/Core/UserImport.php [new file with mode: 0644]

diff --git a/include/uimport.php b/include/uimport.php
deleted file mode 100644 (file)
index d9b0405..0000000
+++ /dev/null
@@ -1,288 +0,0 @@
-<?php
-/**
- * @file include/uimport.php
- */
-use Friendica\App;
-use Friendica\Core\System;
-use Friendica\Core\PConfig;
-use Friendica\Core\Worker;
-use Friendica\Database\DBM;
-use Friendica\Model\Photo;
-use Friendica\Object\Image;
-
-define("IMPORT_DEBUG", False);
-
-function last_insert_id() {
-       if (IMPORT_DEBUG) {
-               return 1;
-       }
-
-       return dba::lastInsertId();
-}
-
-/**
- * Remove columns from array $arr that aren't in table $table
- *
- * @param string $table Table name
- * @param array &$arr Column=>Value array from json (by ref)
- */
-function check_cols($table, &$arr) {
-       $query = sprintf("SHOW COLUMNS IN `%s`", dbesc($table));
-       logger("uimport: $query", LOGGER_DEBUG);
-       $r = q($query);
-       $tcols = array();
-       // get a plain array of column names
-       foreach ($r as $tcol) {
-               $tcols[] = $tcol['Field'];
-       }
-       // remove inexistent columns
-       foreach ($arr as $icol => $ival) {
-               if (!in_array($icol, $tcols)) {
-                       unset($arr[$icol]);
-               }
-       }
-}
-
-/**
- * Import data into table $table
- *
- * @param string $table Table name
- * @param array $arr Column=>Value array from json
- */
-function db_import_assoc($table, $arr) {
-       if (isset($arr['id']))
-               unset($arr['id']);
-       check_cols($table, $arr);
-       $cols = implode("`,`", array_map('dbesc', array_keys($arr)));
-       $vals = implode("','", array_map('dbesc', array_values($arr)));
-       $query = "INSERT INTO `$table` (`$cols`) VALUES ('$vals')";
-       logger("uimport: $query", LOGGER_TRACE);
-       if (IMPORT_DEBUG) {
-               return true;
-       }
-       return q($query);
-}
-
-/**
- * @brief Import account file exported from mod/uexport
- *
- * @param App $a Friendica App Class
- * @param array $file array from $_FILES
- */
-function import_account(App $a, $file) {
-       logger("Start user import from " . $file['tmp_name']);
-       /*
-         STEPS
-         1. checks
-         2. replace old baseurl with new baseurl
-         3. import data (look at user id and contacts id)
-         4. archive non-dfrn contacts
-         5. send message to dfrn contacts
-        */
-
-       $account = json_decode(file_get_contents($file['tmp_name']), true);
-       if ($account === null) {
-               notice(t("Error decoding account file"));
-               return;
-       }
-
-
-       if (!x($account, 'version')) {
-               notice(t("Error! No version data in file! This is not a Friendica account file?"));
-               return;
-       }
-
-       /*
-        * @TODO Old-lost code?
-       // this is not required as we remove columns in json not in current db schema
-       if ($account['schema'] != DB_UPDATE_VERSION) {
-               notice(t("Error! I can't import this file: DB schema version is not compatible."));
-               return;
-       }
-       */
-
-       // check for username
-       $r = q("SELECT uid FROM user WHERE nickname='%s'", $account['user']['nickname']);
-       if ($r === false) {
-               logger("uimport:check nickname : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               notice(t('Error! Cannot check nickname'));
-               return;
-       }
-       if (DBM::is_result($r) > 0) {
-               notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
-               return;
-       }
-       // check if username matches deleted account
-       $r = q("SELECT id FROM userd WHERE username='%s'", $account['user']['nickname']);
-       if ($r === false) {
-               logger("uimport:check nickname : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               notice(t('Error! Cannot check nickname'));
-               return;
-       }
-       if (DBM::is_result($r) > 0) {
-               notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
-               return;
-       }
-
-       $oldbaseurl = $account['baseurl'];
-       $newbaseurl = System::baseUrl();
-
-       $oldaddr = str_replace('http://', '@', normalise_link($oldbaseurl));
-       $newaddr = str_replace('http://', '@', normalise_link($newbaseurl));
-
-       if (!empty($account['profile']['addr'])) {
-               $old_handle = $account['profile']['addr'];
-       } else {
-               $old_handle = $account['user']['nickname'].$oldaddr;
-       }
-
-       $olduid = $account['user']['uid'];
-
-       unset($account['user']['uid']);
-       unset($account['user']['account_expired']);
-       unset($account['user']['account_expires_on']);
-       unset($account['user']['expire_notification_sent']);
-
-       foreach ($account['user'] as $k => &$v) {
-               $v = str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $v);
-       }
-
-       // import user
-       $r = db_import_assoc('user', $account['user']);
-       if ($r === false) {
-               logger("uimport:insert user : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               notice(t("User creation error"));
-               return;
-       }
-       $newuid = last_insert_id();
-       //~ $newuid = 1;
-
-       PConfig::set($newuid, 'system', 'previous_addr', $old_handle);
-
-       // Generate a new guid for the account. Otherwise there will be problems with diaspora
-       q("UPDATE `user` SET `guid` = '%s' WHERE `uid` = %d",
-               dbesc(generate_user_guid()), intval($newuid));
-
-       foreach ($account['profile'] as &$profile) {
-               foreach ($profile as $k => &$v) {
-                       $v = str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $v);
-                       foreach (array("profile", "avatar") as $k) {
-                               $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
-                       }
-               }
-               $profile['uid'] = $newuid;
-               $r = db_import_assoc('profile', $profile);
-               if ($r === false) {
-                       logger("uimport:insert profile " . $profile['profile-name'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-                       info(t("User profile creation error"));
-                       dba::delete('user', array('uid' => $newuid));
-                       return;
-               }
-       }
-
-       $errorcount = 0;
-       foreach ($account['contact'] as &$contact) {
-               if ($contact['uid'] == $olduid && $contact['self'] == '1') {
-                       foreach ($contact as $k => &$v) {
-                               $v = str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $v);
-                               foreach (array("profile", "avatar", "micro") as $k) {
-                                       $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
-                               }
-                       }
-               }
-               if ($contact['uid'] == $olduid && $contact['self'] == '0') {
-                       // set contacts 'avatar-date' to NULL_DATE to let worker to update urls
-                       $contact["avatar-date"] = NULL_DATE;
-
-                       switch ($contact['network']) {
-                               case NETWORK_DFRN:
-                               case NETWORK_DIASPORA:
-                                       //  send relocate message (below)
-                                       break;
-                               case NETWORK_FEED:
-                               case NETWORK_MAIL:
-                                       // Nothing to do
-                                       break;
-                               default:
-                                       // archive other contacts
-                                       $contact['archive'] = "1";
-                       }
-               }
-               $contact['uid'] = $newuid;
-               $r = db_import_assoc('contact', $contact);
-               if ($r === false) {
-                       logger("uimport:insert contact " . $contact['nick'] . "," . $contact['network'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-                       $errorcount++;
-               } else {
-                       $contact['newid'] = last_insert_id();
-               }
-       }
-       if ($errorcount > 0) {
-               notice(sprintf(tt("%d contact not imported", "%d contacts not imported", $errorcount), $errorcount));
-       }
-
-       foreach ($account['group'] as &$group) {
-               $group['uid'] = $newuid;
-               $r = db_import_assoc('group', $group);
-               if ($r === false) {
-                       logger("uimport:insert group " . $group['name'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               } else {
-                       $group['newid'] = last_insert_id();
-               }
-       }
-
-       foreach ($account['group_member'] as &$group_member) {
-               $import = 0;
-               foreach ($account['group'] as $group) {
-                       if ($group['id'] == $group_member['gid'] && isset($group['newid'])) {
-                               $group_member['gid'] = $group['newid'];
-                               $import++;
-                               break;
-                       }
-               }
-               foreach ($account['contact'] as $contact) {
-                       if ($contact['id'] == $group_member['contact-id'] && isset($contact['newid'])) {
-                               $group_member['contact-id'] = $contact['newid'];
-                               $import++;
-                               break;
-                       }
-               }
-               if ($import == 2) {
-                       $r = db_import_assoc('group_member', $group_member);
-                       if ($r === false) {
-                               logger("uimport:insert group member " . $group_member['id'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-                       }
-               }
-       }
-
-       foreach ($account['photo'] as &$photo) {
-               $photo['uid'] = $newuid;
-               $photo['data'] = hex2bin($photo['data']);
-
-               $Image = new Image($photo['data'], $photo['type']);
-               $r = Photo::store(
-                               $Image,
-                               $photo['uid'], $photo['contact-id'], //0
-                               $photo['resource-id'], $photo['filename'], $photo['album'], $photo['scale'], $photo['profile'], //1
-                               $photo['allow_cid'], $photo['allow_gid'], $photo['deny_cid'], $photo['deny_gid']
-               );
-
-               if ($r === false) {
-                       logger("uimport:insert photo " . $photo['resource-id'] . "," . $photo['scale'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               }
-       }
-
-       foreach ($account['pconfig'] as &$pconfig) {
-               $pconfig['uid'] = $newuid;
-               $r = db_import_assoc('pconfig', $pconfig);
-               if ($r === false) {
-                       logger("uimport:insert pconfig " . $pconfig['id'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
-               }
-       }
-
-       // send relocate messages
-       Worker::add(PRIORITY_HIGH, 'Notifier', 'relocate', $newuid);
-
-       info(t("Done. You can now login with your username and password"));
-       goaway(System::baseUrl() . "/login");
-}
index cbfe9a7..114e4d0 100644 (file)
@@ -1,13 +1,12 @@
 <?php
-
 /**
- * View for user import
+ * @file mod/uimport.php
+ * @brief View for user import
  */
 
 use Friendica\App;
 use Friendica\Core\Config;
-
-require_once("include/uimport.php");
+use Friendica\Core\UserImport;
 
 function uimport_post(App $a) {
        switch ($a->config['register_policy']) {
@@ -34,7 +33,7 @@ function uimport_post(App $a) {
 
        if (x($_FILES, 'accountfile')) {
                /// @TODO Pass $blocked / $verified, send email to admin on REGISTER_APPROVE
-               import_account($a, $_FILES['accountfile']);
+               UserImport::importAccount($a, $_FILES['accountfile']);
                return;
        }
 }
diff --git a/src/Core/UserImport.php b/src/Core/UserImport.php
new file mode 100644 (file)
index 0000000..5ad4f57
--- /dev/null
@@ -0,0 +1,301 @@
+<?php
+/**
+ * @file src/Core/UserImport.php
+ */
+namespace Friendica\Core;
+
+use Friendica\App;
+use Friendica\Core\System;
+use Friendica\Core\PConfig;
+use Friendica\Core\Worker;
+use Friendica\Database\DBM;
+use Friendica\Model\Photo;
+use Friendica\Object\Image;
+use dba;
+
+require_once "include/dba.php";
+
+/**
+ * @brief UserImport class
+ */
+class UserImport
+{
+       const IMPORT_DEBUG = false;
+
+       private static function lastInsertId()
+       {
+               if (self::IMPORT_DEBUG) {
+                       return 1;
+               }
+       
+               return dba::lastInsertId();
+       }
+
+       /**
+        * Remove columns from array $arr that aren't in table $table
+        *
+        * @param string $table Table name
+        * @param array &$arr Column=>Value array from json (by ref)
+        */
+       private static function checkCols($table, &$arr)
+       {
+               $query = sprintf("SHOW COLUMNS IN `%s`", dbesc($table));
+               logger("uimport: $query", LOGGER_DEBUG);
+               $r = q($query);
+               $tcols = array();
+               // get a plain array of column names
+               foreach ($r as $tcol) {
+                       $tcols[] = $tcol['Field'];
+               }
+               // remove inexistent columns
+               foreach ($arr as $icol => $ival) {
+                       if (!in_array($icol, $tcols)) {
+                               unset($arr[$icol]);
+                       }
+               }
+       }
+
+       /**
+        * Import data into table $table
+        *
+        * @param string $table Table name
+        * @param array $arr Column=>Value array from json
+        */
+       private static function dbImportAssoc($table, $arr)
+       {
+               if (isset($arr['id'])) {
+                       unset($arr['id']);
+               }
+
+               self::check_cols($table, $arr);
+               $cols = implode("`,`", array_map('dbesc', array_keys($arr)));
+               $vals = implode("','", array_map('dbesc', array_values($arr)));
+               $query = "INSERT INTO `$table` (`$cols`) VALUES ('$vals')";
+               logger("uimport: $query", LOGGER_TRACE);
+
+               if (self::IMPORT_DEBUG) {
+                       return true;
+               }
+
+               return q($query);
+       }
+
+       /**
+        * @brief Import account file exported from mod/uexport
+        *
+        * @param App $a Friendica App Class
+        * @param array $file array from $_FILES
+        */
+       public static function importAccount(App $a, $file)
+       {
+               logger("Start user import from " . $file['tmp_name']);
+               /*
+               STEPS
+               1. checks
+               2. replace old baseurl with new baseurl
+               3. import data (look at user id and contacts id)
+               4. archive non-dfrn contacts
+               5. send message to dfrn contacts
+               */
+
+               $account = json_decode(file_get_contents($file['tmp_name']), true);
+               if ($account === null) {
+                       notice(t("Error decoding account file"));
+                       return;
+               }
+
+
+               if (!x($account, 'version')) {
+                       notice(t("Error! No version data in file! This is not a Friendica account file?"));
+                       return;
+               }
+
+               // check for username
+               $r = dba::selectFirst('user', ['uid'], ['nickname' => $account['user']['nickname']]);
+               if ($r === false) {
+                       logger("uimport:check nickname : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       notice(t('Error! Cannot check nickname'));
+                       return;
+               }
+
+               if (DBM::is_result($r) > 0) {
+                       notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
+                       return;
+               }
+
+               // check if username matches deleted account
+               $r = dba::selectFirst('userd', ['id'], ['username' => $account['user']['nickname']]);
+               if ($r === false) {
+                       logger("uimport:check nickname : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       notice(t('Error! Cannot check nickname'));
+                       return;
+               }
+
+               if (DBM::is_result($r) > 0) {
+                       notice(sprintf(t("User '%s' already exists on this server!"), $account['user']['nickname']));
+                       return;
+               }
+
+               $oldbaseurl = $account['baseurl'];
+               $newbaseurl = System::baseUrl();
+
+               $oldaddr = str_replace('http://', '@', normalise_link($oldbaseurl));
+               $newaddr = str_replace('http://', '@', normalise_link($newbaseurl));
+
+               if (!empty($account['profile']['addr'])) {
+                       $old_handle = $account['profile']['addr'];
+               } else {
+                       $old_handle = $account['user']['nickname'].$oldaddr;
+               }
+
+               $olduid = $account['user']['uid'];
+
+               unset($account['user']['uid']);
+               unset($account['user']['account_expired']);
+               unset($account['user']['account_expires_on']);
+               unset($account['user']['expire_notification_sent']);
+
+               $callback = function (&$value) use ($oldbaseurl, $oldaddr, $newbaseurl, $newaddr) {
+                       $value =  str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $value);
+               };
+
+               array_walk($account['user'], $callback);
+
+               // import user
+               $r = self::dbImportAssoc('user', $account['user']);
+               if ($r === false) {
+                       logger("uimport:insert user : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       notice(t("User creation error"));
+                       return;
+               }
+               $newuid = self::lastInsertId();
+
+               PConfig::set($newuid, 'system', 'previous_addr', $old_handle);
+
+               // Generate a new guid for the account. Otherwise there will be problems with diaspora
+               dba::update('user', ['guid' => generate_user_guid()], ['uid' => $newuid]);
+
+               foreach ($account['profile'] as &$profile) {
+                       foreach ($profile as $k => &$v) {
+                               $v = str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $v);
+                               foreach (array("profile", "avatar") as $k) {
+                                       $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
+                               }
+                       }
+                       $profile['uid'] = $newuid;
+                       $r = self::dbImportAssoc('profile', $profile);
+                       if ($r === false) {
+                               logger("uimport:insert profile " . $profile['profile-name'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                               info(t("User profile creation error"));
+                               dba::delete('user', array('uid' => $newuid));
+                               return;
+                       }
+               }
+
+               $errorcount = 0;
+               foreach ($account['contact'] as &$contact) {
+                       if ($contact['uid'] == $olduid && $contact['self'] == '1') {
+                               foreach ($contact as $k => &$v) {
+                                       $v = str_replace(array($oldbaseurl, $oldaddr), array($newbaseurl, $newaddr), $v);
+                                       foreach (array("profile", "avatar", "micro") as $k) {
+                                               $v = str_replace($oldbaseurl . "/photo/" . $k . "/" . $olduid . ".jpg", $newbaseurl . "/photo/" . $k . "/" . $newuid . ".jpg", $v);
+                                       }
+                               }
+                       }
+                       if ($contact['uid'] == $olduid && $contact['self'] == '0') {
+                               // set contacts 'avatar-date' to NULL_DATE to let worker to update urls
+                               $contact["avatar-date"] = NULL_DATE;
+
+                               switch ($contact['network']) {
+                                       case NETWORK_DFRN:
+                                       case NETWORK_DIASPORA:
+                                               //  send relocate message (below)
+                                               break;
+                                       case NETWORK_FEED:
+                                       case NETWORK_MAIL:
+                                               // Nothing to do
+                                               break;
+                                       default:
+                                               // archive other contacts
+                                               $contact['archive'] = "1";
+                               }
+                       }
+                       $contact['uid'] = $newuid;
+                       $r = self::dbImportAssoc('contact', $contact);
+                       if ($r === false) {
+                               logger("uimport:insert contact " . $contact['nick'] . "," . $contact['network'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                               $errorcount++;
+                       } else {
+                               $contact['newid'] = self::lastInsertId();
+                       }
+               }
+               if ($errorcount > 0) {
+                       notice(sprintf(tt("%d contact not imported", "%d contacts not imported", $errorcount), $errorcount));
+               }
+
+               foreach ($account['group'] as &$group) {
+                       $group['uid'] = $newuid;
+                       $r = self::dbImportAssoc('group', $group);
+                       if ($r === false) {
+                               logger("uimport:insert group " . $group['name'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       } else {
+                               $group['newid'] = self::lastInsertId();
+                       }
+               }
+
+               foreach ($account['group_member'] as &$group_member) {
+                       $import = 0;
+                       foreach ($account['group'] as $group) {
+                               if ($group['id'] == $group_member['gid'] && isset($group['newid'])) {
+                                       $group_member['gid'] = $group['newid'];
+                                       $import++;
+                                       break;
+                               }
+                       }
+                       foreach ($account['contact'] as $contact) {
+                               if ($contact['id'] == $group_member['contact-id'] && isset($contact['newid'])) {
+                                       $group_member['contact-id'] = $contact['newid'];
+                                       $import++;
+                                       break;
+                               }
+                       }
+                       if ($import == 2) {
+                               $r = self::dbImportAssoc('group_member', $group_member);
+                               if ($r === false) {
+                                       logger("uimport:insert group member " . $group_member['id'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                               }
+                       }
+               }
+
+               foreach ($account['photo'] as &$photo) {
+                       $photo['uid'] = $newuid;
+                       $photo['data'] = hex2bin($photo['data']);
+
+                       $Image = new Image($photo['data'], $photo['type']);
+                       $r = Photo::store(
+                               $Image,
+                               $photo['uid'], $photo['contact-id'], //0
+                               $photo['resource-id'], $photo['filename'], $photo['album'], $photo['scale'], $photo['profile'], //1
+                               $photo['allow_cid'], $photo['allow_gid'], $photo['deny_cid'], $photo['deny_gid']
+                       );
+
+                       if ($r === false) {
+                               logger("uimport:insert photo " . $photo['resource-id'] . "," . $photo['scale'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       }
+               }
+
+               foreach ($account['pconfig'] as &$pconfig) {
+                       $pconfig['uid'] = $newuid;
+                       $r = self::dbImportAssoc('pconfig', $pconfig);
+                       if ($r === false) {
+                               logger("uimport:insert pconfig " . $pconfig['id'] . " : ERROR : " . dba::errorMessage(), LOGGER_NORMAL);
+                       }
+               }
+
+               // send relocate messages
+               Worker::add(PRIORITY_HIGH, 'Notifier', 'relocate', $newuid);
+
+               info(t("Done. You can now login with your username and password"));
+               goaway(System::baseUrl() . "/login");
+       }
+}