/**
* Import the given data into the destination Model.
*
* @param array $data Indexed array of records to import/merge from the external source.
* @param array $options Any options required for the import, such as merge, key, etc.
* @param boolean $output_realtime Set to true to output the log in real time as the import happens.
*
* @throws Exception
*
* @return \Core\ModelImportLogger
*/
public static function Import($data, $options, $output_realtime = false) {
$log = new \Core\ModelImportLogger('User Group Importer', $output_realtime);
$merge = isset($options['merge']) ? $options['merge'] : true;
$pk = isset($options['key']) ? $options['key'] : null;
if(!$pk) {
throw new Exception(
'Import requires a "key" field on options containing the primary key to compare against locally.'
);
}
foreach($data as $dat) {
if($pk == 'name' || $pk == 'id' || $pk == 'ldap_dn') {
// These are the only two fields on the User object itself.
$group = UserGroupModel::Find([$pk . ' = ' . $dat[ $pk ]], 1);
}
else {
$group = UserGroupModel::Find(['name = ' . $dat['name']], 1);
}
$status_type = $group ? 'Updated' : 'Created';
if($group && !$merge) {
$log->duplicate('Skipped group ' . $group->getLabel() . ', already exists and merge not requested');
// Skip to the next record.
continue;
}
if(!$group) {
// All incoming groups must have a name!
if(!isset($dat['name'])) {
$log->error('Unable to import groups without a name!');
// Skip to the next record.
continue;
}
// New user!
$group = new UserGroupModel();
}
// No else needed, else is there IS a valid $user object and it's setup ready to go.
// Handle all the properties for this user!
foreach($dat as $key => $val){
// Default Behaviour,
// save the key into whatever field it was set to go to.
$group->set($key, $val);
}
try {
$status = $group->save();
}
catch(Exception $e) {
$log->error($e->getMessage());
// Skip to the next.
continue;
}
if($status) {
$log->success($status_type . ' group ' . $group->getLabel() . ' successfully!');
}
else {
$log->skip('Skipped group ' . $group->getLabel() . ', no changes detected.');
}
}
$log->finalize();
return $log;
}
/**
* Import the given data into the destination Model.
*
* @param array $data Indexed array of records to import/merge from the external source.
* @param array $options Any options required for the import, such as merge, key, etc.
* @param boolean $output_realtime Set to true to output the log in real time as the import happens.
*
* @throws Exception
*
* @return \Core\ModelImportLogger
*/
public static function Import($data, $options, $output_realtime = false) {
$log = new \Core\ModelImportLogger('User Importer', $output_realtime);
$merge = isset($options['merge']) ? $options['merge'] : true;
$pk = isset($options['key']) ? $options['key'] : null;
if(!$pk) {
throw new Exception(
'Import requires a "key" field on options containing the primary key to compare against locally.'
);
}
// Load in members from the group
// Set the default group on new accounts, if a default is set.
$defaultgroups = \UserGroupModel::Find(["default = 1"]);
$groups = [];
$gnames = [];
foreach($defaultgroups as $g) {
/** @var \UserGroupModel $g */
$groups[] = $g->get('id');
$gnames[] = $g->get('name');
}
if(sizeof($groups)) {
$log->log('Found ' . sizeof($groups) . ' default groups for new users: ' . implode(', ', $gnames));
}
else {
$log->log('No groups set as default, new users will not belong to any groups.');
}
$log->log('Starting ' . ($merge ? '*MERGE*' : '*skipping*' ) . ' import of ' . sizeof($data) . ' users');
foreach($data as $dat) {
if(isset($dat[$pk])){
// Only check the information if the primary key is set on this record.
if($pk == 'email' || $pk == 'id') {
// These are the only two fields on the User object itself.
$user = UserModel::Find([$pk . ' = ' . $dat[ $pk ]], 1);
}
else {
$uucm = UserUserConfigModel::Find(['key = ' . $pk, 'value = ' . $dat[ $pk ]], 1);
if($uucm) {
$user = $uucm->getLink('UserModel');
}
else {
// Try the lookup from the email address instead.
// This will force accounts that exist to be synced up correctly.
// The only caveat to this is that users will not be updated with the foreign key if merge is disabled.
$user = UserModel::Find(['email = ' . $dat['email']], 1);
}
}
}
else{
$user = null;
}
$status_type = $user ? 'Updated' : 'Created';
if($user && !$merge) {
$log->duplicate('Skipped user ' . $user->getLabel() . ', already exists and merge not requested');
// Skip to the next record.
continue;
}
if(!$user) {
// All incoming users must have an email address!
if(!isset($dat['email'])) {
$log->error('Unable to import user without an email address!');
// Skip to the next record.
continue;
}
// Meta fields that may or may not be present, but should be for reporting purposes.
if(!isset($dat['registration_ip'])) {
$dat['registration_ip'] = REMOTE_IP;
}
if(!isset($dat['registration_source'])) {
$dat['registration_source'] = \Core\user()->exists() ? 'admin' : 'self';
}
if(!isset($dat['registration_invitee'])) {
$dat['registration_invitee'] = \Core\user()->get('id');
}
// New user!
$user = new UserModel();
}
// No else needed, else is there IS a valid $user object and it's setup ready to go.
// Handle all the properties for this user!
foreach($dat as $key => $val){
if($key == 'avatar' && strpos($val, '://') !== false){
// Sync the user avatar.
$log->actionStart('Downloading ' . $dat['avatar']);
$f = new \Core\Filestore\Backends\FileRemote($dat['avatar']);
$dest = \Core\Filestore\Factory::File('public/user/avatar/' . $f->getBaseFilename());
if($dest->identicalTo($f)) {
$log->actionSkipped();
}
else {
$f->copyTo($dest);
$user->set('avatar', 'public/user/avatar/' . $dest->getBaseFilename());
$log->actionSuccess();
}
}
elseif($key == 'profiles' && is_array($val)) {
$new_profiles = $val;
// Pull the current profiles from the account
$profiles = $user->get('external_profiles');
if($profiles && is_array($profiles)) {
$current_flat = [];
foreach($profiles as $current_profile) {
$current_flat[] = $current_profile['url'];
}
// Merge in any *actual* new profile
foreach($new_profiles as $new_profile) {
if(!in_array($new_profile['url'], $current_flat)) {
$profiles[] = $new_profile;
}
}
unset($new_profile, $new_profiles, $current_flat, $current_profile);
}
else {
$profiles = $new_profiles;
unset($new_profiles);
}
$user->set('external_profiles', $profiles);
}
elseif($key == 'backend'){
// Was a backend requested?
// This gets merged instead of replaced entirely.
$user->enableAuthDriver($val);
}
elseif($key == 'groups'){
$user->setGroups($val);
}
else{
// Default Behaviour,
// save the key into whatever field it was set to go to.
$user->set($key, $val);
}
}
try {
// Set the default groups loaded from the system.
if(!$user->exists()){
$user->setGroups($groups);
}
$status = $user->save();
}
catch(Exception $e) {
$log->error($e->getMessage());
// Skip to the next.
continue;
}
if($status) {
$log->success($status_type . ' user ' . $user->getLabel() . ' successfully!');
}
else {
$log->skip('Skipped user ' . $user->getLabel() . ', no changes detected.');
}
}
$log->finalize();
return $log;
}