ugen.php

<?php
/**
 * UCOZ to Joomla data converter
 *
 * @copyright  Copyright (C) 2019 Libra.ms. All rights reserved.
 * @license    GNU General Public License version 2 or later
 * @url        http://киноархив.com
 */

/**
 * This is a script to convert users parameters from Ucoz to Joomla which should be called from the command-line, not the web.
 * Example: /path/to/php /path/to/site/ucoz_converter/ugen.php
 *
 * NOTE! Run this file only after users.php except you're want to get banned users.
 *
 * Optional parameter:
 * --banned - get banned users and store into json file(users_blocked.json).
 *
 * Example: /path/to/php /path/to/site/ucoz_converter/ugen.php --banned
 */

const _JEXEC = 1;

error_reporting(E_ALL | E_NOTICE);
ini_set('display_errors', 1);

if (PHP_SAPI !== 'cli')
{
	die('This script can run only in CLI mode!');
}

// Load system defines
if (file_exists(dirname(__DIR__) . '/defines.php'))
{
	require_once dirname(__DIR__) . '/defines.php';
}

if (!defined('_JDEFINES'))
{
	define('JPATH_BASE', dirname(__DIR__));
	require_once JPATH_BASE . '/includes/defines.php';
}

require_once JPATH_BASE . '/includes/framework.php';
require_once __DIR__ . '/application/helper.php';

use Joomla\CMS\Factory;
use Joomla\Filesystem\Path;
use Joomla\Filter\InputFilter;
use Joomla\Utilities\ArrayHelper;

// This will prevent 'Failed to start application' error.
try
{
	$app = Factory::getApplication('site');
}
catch (Exception $e)
{
	jexit($e->getMessage());
}

/**
 * Class for users.
 *
 * @since  0.1
 * @noinspection PhpUnused
 */
Class ConverterUgen extends JApplicationCli
{
	/**
	 * @var    object   Configuration.
	 * @since  0.1
	 */
	protected $config;

	/**
	 * @var    array   Group IDs from Joomla.
	 * @since  0.1
	 */
	protected $groups = null;

	/**
	 * Update user information such as user group and ban.
	 *
	 * @return  void
	 * @throws  Exception
	 * @since   0.1
	 */
	public function doExecute()
	{
		$db   = Factory::getDbo();
		$lang = Factory::getLanguage();
		$lang->load('lib_joomla');

		// Get cmd options
		$opts = getopt("", array('banned' => 'banned::'));

		$this->config = ConverterHelper::loadConfig();
		$backupPath   = Path::clean($this->config->get('backupPath') . '/_s1/ugen.txt');
		$usersParams  = ConverterHelper::loadBackupFile($backupPath);

		if ($usersParams === false)
		{
			jexit("Could not load backup file at $backupPath\n");
		}

		// Load user groups association.
		$this->groups = ArrayHelper::fromObject($this->config->get('usergroups'));

		$filter            = new InputFilter;
		$totalUsers        = count($usersParams);
		$totalUsersError   = 0;
		$totalUsersBlocked = 0;
		$ids               = ConverterHelper::getAssocData(__DIR__ . '/imports/users_import.json');
		$blocked           = array();

		if (array_key_exists('banned', $opts))
		{
			$this->getBannedUsers($usersParams);

			return;
		}

		if (empty($ids) || is_object($ids))
		{
			$msg = 'Something went wrong with file ' . Path::clean(__DIR__ . '/imports/users_import.json') . '.' . "\n"
				. 'Try to run \'users.php\' again.';
			jexit($msg . "\n");
		}

		$outputLog = "======= " . date('Y-m-d H:i:s', time()) . " =======\n";
		echo $outputLog;

		// Process users
		foreach ($usersParams as $i => $line)
		{
			// Replace \| by <separator> to avoid wrong column count. E.g. for ban reason.
			$line = str_replace('\|', '<separator>', $line);

			$column   = explode('|', $line);
			$username = $filter->clean($column[1], 'username');
			$ucozGID  = $filter->clean($column[2], 'int');
			$msgLine  = ($i + 1) . ' of ' . $totalUsers . '. User: ';
			$msg      = '';
			$uid      = array_search($username, $ids);

			if ($uid === false)
			{
				jexit('Error! User not registered!');
			}

			// Set user to blocked.
			if ((int) $column[3] > 0)
			{
				$block     = 1;
				$blocked[] = $username;
				$totalUsersBlocked++;

				$query = $db->getQuery(true)
					->update($db->quoteName('#__users'))
					->set($db->quoteName('block') . " = '" . $block . "'")
					->where($db->quoteName('id') . ' = ' . (int) $uid);

				$db->setQuery($query);

				try
				{
					$db->execute();
					$msg .= $msgLine . $username . ' - User blocked.' . "\n";
				}
				catch (RuntimeException $e)
				{
					$totalUsersError++;
					$msg .= $e->getMessage() . "\n";
				}

				// Set user as banned in Community Builder user table.
				if ($this->config->get('isComprofiler') == 1)
				{
					$banData   = explode('<separator>', $column[5]);
					$bannedBy  = array_search($banData[1], $ids);
					$banReason = $filter->clean($banData[3], 'string');

					$query = $db->getQuery(true)
						->update($db->quoteName('#__comprofiler'))
						->set($db->quoteName('banned') . " = '" . (int) $block . "', "
							. $db->quoteName('bannedby') . " = '" . (int) $bannedBy . "', "
							. $db->quoteName('bannedreason') . " = '" . $db->escape($banReason) . "'"
						)
						->where($db->quoteName('user_id') . ' = ' . (int) $uid);

					$db->setQuery($query);

					try
					{
						$db->execute();
					}
					catch (RuntimeException $e)
					{
						$totalUsersError++;
						$msg .= $e->getMessage() . "\n";
					}
				}
			}

			// Get and set user group.
			$joomlaGID = $this->getJoomlaGroupID($ucozGID);
			$query     = $db->getQuery(true)
				->select($db->quoteName('group_id'))
				->from($db->quoteName('#__user_usergroup_map'))
				->where($db->quoteName('user_id') . ' = ' . (int) $uid);

			$db->setQuery($query);
			$result = $db->loadColumn();

			if ($result > 0)
			{
				// Add new group to user only if user not in this group.
				if (!in_array($joomlaGID, $result))
				{
					$query->insert($db->quoteName('#__user_usergroup_map'))
						->columns($db->quoteName(array('user_id', 'group_id')))
						->values("'" . implode("', '", array((int) $uid, $joomlaGID)) . "'");

					$db->setQuery($query);

					try
					{
						$db->execute();
						$msg .= $msgLine . $username . ' - Added to a new group.' . "\n";
					}
					catch (RuntimeException $e)
					{
						$totalUsersError++;
						$msg .= $e->getMessage() . "\n";
					}
				}
			}

			$outputLog .= $msg;

			echo $msg;
		}

		ConverterHelper::saveAssocData(__DIR__ . '/imports/users_blocked.json', $blocked);

		$succMsg = "\n" . 'Total users: ' . $totalUsers . '.' .
			"\n" . 'Banned users: ' . $totalUsersBlocked . '.' .
			"\n" . 'Errors found: ' . $totalUsersError . "\n";
		$outputLog .= $succMsg;

		file_put_contents(__DIR__ . '/imports/ugen_import.log', $outputLog . "\n\n", FILE_APPEND);

		echo $succMsg;
	}

	/**
	 * Get Joomla group ID by Ucoz group ID.
	 *
	 * @param   integer   $gid  Ucoz group ID.
	 *
	 * @return  integer
	 * @since   0.1
	 */
	protected function getJoomlaGroupID($gid)
	{
		if (!empty($this->groups) && array_key_exists($gid, $this->groups))
		{
			$gid = $this->groups[$gid];
		}
		else
		{
			$gid = $this->config->get('defaultUserGroupId');

			if (empty($gid))
			{
				$params = JComponentHelper::getParams('com_users');
				$gid    = $params->get('new_usertype', $params->get('guest_usergroup', 1));
			}
		}

		return (int) $gid;
	}

	/**
	 * Get banned users and save into json.
	 *
	 * @param   array  $usersParams  Array of user params.
	 *
	 * @return  void
	 * @since   0.1
	 */
	protected function getBannedUsers(&$usersParams)
	{
		$filter  = new InputFilter;
		$blocked = array();

		foreach ($usersParams as $i => $line)
		{
			// Replace \| by <separator> to avoid wrong column count. E.g. for ban reason.
			$line = str_replace('\|', '<separator>', $line);

			$column = explode('|', $line);

			if ((int) $column[3] > 0)
			{
				$blocked[] = $filter->clean($column[1], 'username');
			}
		}

		ConverterHelper::saveAssocData(__DIR__ . '/imports/users_blocked.json', $blocked);
	}
}

JApplicationCli::getInstance('ConverterUgen')->execute();