MergeUsersTool.inc.php

<?php
 
import('lib.pkp.classes.cliTool.CliTool');
 
class MergeUsersTool extends CommandLineTool {
 
   var $targetSpecifier;
 
   var $mergeSpecifiers;
 
   function __construct($argv = array()) {
      parent::__construct($argv);
 
      if (!isset($this->argv[0]) || !isset($this->argv[1]) ) {
         $this->usage();
         exit(1);
      }
 
      $this->targetSpecifier = $this->argv[0];
      $this->mergeSpecifiers = array_slice($this->argv, 1);
   }
 
   function usage() {
      echo "Merge users tool\n"
         . "Use this tool to merge two or more user accounts.\n\n"
         . "Usage: {$this->scriptName} targetUsername mergeUsername1 [mergeUsername2] [...]\n"
         . "targetUsername: The target username for assets to be transferred to.\n"
         . "mergeUsername1: The username for the account to be merged. All assets (e.g.\n"
         . "                submissions) associated with this user account will be\n"
         . "                transferred to the user account that corresponds to\n"
         . "                targetUsernameusername1. The user account that corresponds\n"
         . "                to username2 will be deleted.\n\n"
         . "Multiple users to merge can be specified in the same command, e.g.:\n\n"
         . "{$this->scriptName} myUsername spamUser1 spamUser2 spamUser3\n\n"
         . "This will merge users with username \"spamUser1\", \"spamUser2\", and\n"
         . "\"spamUser3\" into the account with username \"myUsername\".\n\n"
         . "Users can be specified by ID by entering usernames of the form \"id=x\"\n"
         . "with the username in place of \"x\", e.g.:\n\n"
         . "{$this->scriptName} myUsername id=234 id=456\n\n"
         . "Usernames and IDs may be mixed as desired.\n";
   }
 
   function execute() {
 
      $targetUser = $this->_getUserBySpecifier($this->targetSpecifier);
      if (!$targetUser) {
         echo "Error: \"$this->targetSpecifier\" does not specify a valid user.\n";
         exit(1);
      }
 
      // Build a list of usernames and IDs, checking for missing users before doing anything.
      $mergeArray = array();
      foreach ($this->mergeSpecifiers as $specifier) {
         $mergeUser = $this->_getUserBySpecifier($specifier);
         if (!$mergeUser) {
            echo "Error: \"$specifier\" does not specify a valid user.\n";
            exit(2);
         }
         if ($mergeUser->getId() == $targetUser->getId()) {
            echo "Error: Cannot merge an account into itself.\n";
            exit(3);
         }
         $mergeArray[$mergeUser->getId()] = $mergeUser->getUsername();
      }
 
      // Merge the accounts.
      import('classes.user.UserAction');
      $userAction = new UserAction();
      foreach ($mergeArray as $userId => $username) {
         $userAction->mergeUsers($userId, $targetUser->getId());
      }
 
      if (count($mergeArray) == 1) {
         echo "Merge completed: \"$username\" merged into \"" . $targetUser->getUsername() . "\".\n";
      } else {
         echo 'Merge completed: ' . count($mergeArray) . " users merged into \"" . $targetUser->getUsername() . "\".\n";
      }
   }
 
   protected function _getUserBySpecifier($specifier) {
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      if (substr($specifier, 0, 3) == 'id=') {
         return $userDao->getById(substr($specifier, 3));
      }
      return $userDao->getByUsername($specifier);
   }
}