ImportManager::buildActionQuery() - Code Metrics - Inspection of "Merge pull request #98 from Spuds/check" - OpenImporter/openimporter - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — development ( 2bb3b4...48f606 )

by Emanuele
created 2017-09-04 21:15 UTC
ImportManager::buildActionQuery() B

↳ Parent: ImportManager
Complexity

Conditions	4
Paths	8
Size

Total Lines	22
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
c	2
b	0
f	0
dl	0
loc	22
rs	8.9197
cc	4
eloc	9
nc	8
nop	0
<?php
/**
 * @name      OpenImporter
 * @copyright OpenImporter contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * @version 2.0 Alpha
 */

namespace OpenImporter\Core;

/**
 * Class ImportManager
 * Loads the main importer.
 * It handles all steps to completion.
 */
class ImportManager
{
	/**
	 * The importer that will act as interface between the manager and the
	 * files that will do the actual import
	 * @var object
	 */
	public $importer;

	/**
	 * The configurator that holds all the settings
	 * @var object
	 */
	public $config;

	/**
	 * Data used by the script and stored in session between a reload and the
	 * following one.
	 * @var mixed[]
	 */
	public $data = array();

	/**
	 * The response object.
	 * @var object
	 */
	protected $response;

	/**
	 * The language object.
	 * @var object
	 */
	protected $lng;

	/**
	 * ImportManager constructor.
	 * Initialize the main Importer object
	 *
	 * @param Configurator $config
	 * @param Importer $importer
	 * @param HttpResponse $response
	 */
	public function __construct(Configurator $config, Importer $importer, HttpResponse $response)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
	{
		$this->config = $config;
		$this->importer = $importer;
		$this->response = $response;

		$this->loadFromSession();

		if (!empty($_POST['do_steps']))
		{
			$this->data['do_steps'] = $_POST['do_steps'];
		}
		else
		{
			$this->data['do_steps'] = array();
		}

		if ($this->config->action == 'reset')
		{
			$this->resetImporter();
			$this->data = array('import_script' => '');

		}
	}

	protected function loadFromSession()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
	{
		if (isset($_REQUEST['start']))
		{
			$this->config->progress->start = (int) $_REQUEST['start'];
		}
		else
		{
			$this->config->progress->start = 0;
		}

		if (!empty($_SESSION['importer_data']))
		{
			$this->data = $_SESSION['importer_data'];
		}

		if (!empty($_SESSION['importer_progress_status']))
		{
			$this->config->store = new ValuesBag($_SESSION['importer_progress_status']);
		}
	}

	protected function resetImporter()
	{
		unset($this->config->store['importer_data']);
		unset($this->config->store['importer_progress_status']);
		unset($this->config->store['import_progress']);
	}

	public function setupScripts($data)
	{
		$this->findScript($data);

		$this->loadPass($data);

		$this->loadPaths($data);

		if (!empty($this->config->script))
		{
			$this->importer->reloadImporter();
		}
	}

	/**
	 * Finds the script either in the session or in request
	 */
	protected function findScript($data)
	{
		// Save here so it doesn't get overwritten when sessions are restarted.
		if (isset($data['destination']) && isset($data['source']))
		{
			$this->data['import_script'] = $this->config->script = array(
				'destination' => str_replace('..', '', preg_replace('~[^a-zA-Z0-9\-_\.]~', '', $data['destination'])),
				'source' => str_replace('..', '', preg_replace('~[^a-zA-Z0-9\-_\.]~', '', $data['source'])),
			);
		}
		elseif (isset($this->data['import_script']))
		{
			$this->config->script = $this->data['import_script'] = $this->validateScript($this->data['import_script']);
		}
		else
		{
			$this->config->script = array();
			$this->data['import_script'] = null;
		}
	}

	/**
	 * Verifies the scripts exist.
	 *
	 * @param string[] $scripts Destination and source script in an associative
	 *   array:
	 *   	array(
	 *      	'destination' => 'destination_name.php',
	 *          'source' => 'source_name.xml',
	 *       )
	 *
	 * @return bool|mixed[]
	 */
	protected function validateScript($scripts)
	{
		$return = array();

		foreach ((array) $scripts as $key => $script)
		{
			$script = preg_replace('~[\.]+~', '.', $script);
			$key = preg_replace('~[\.]+~', '.', $key);

			if ($key === 'source')
			{
				if (!file_exists($this->config->importers_dir . DS . $key . 's' . DS . $script) || preg_match('~_Importer\.(xml|php)$~', $script) == 0)
				{
					return false;
				}
			}
			else
			{
				if (!file_exists($this->config->importers_dir . DS . $key . 's' . DS . $script . DS . 'Importer.php'))
				{
					return false;
				}
			}

			$return[$key] = $script;
		}

		return $return;
	}

	protected function loadPass($data)
	{
		// Check for the password...
		if (isset($data['db_pass']))
		{
			$this->data['db_pass'] = $data['db_pass'];
		}
	}

	protected function loadPaths($data)
	{
		if (isset($data['path_from']) || isset($data['path_to']))
		{
			if (isset($data['path_from']))
			{
				$this->config->path_from = rtrim($data['path_from'], '\\/');
			}

			if (isset($data['path_to']))
			{
				$this->config->path_to = rtrim($data['path_to'], '\\/');
			}

			$this->data['import_paths'] = array($this->config->path_from, $this->config->path_to);
		}
		elseif (isset($this->data['import_paths']))
		{
			list ($this->config->path_from, $this->config->path_to) = $this->data['import_paths'];
		}

		if (!empty($this->data))
		{
			$this->importer->setData($this->data);
		}
	}

	public function __destruct()
	{
		$this->saveInSession();
	}

	protected function saveInSession()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
	{
		$_SESSION['importer_data'] = $this->data;
		$_SESSION['importer_progress_status'] = $this->config->store;
	}

	/**
	 * Prepares the response to send to the template system
	 *
	 * @param $data
	 *
	 * @return object|HttpResponse
	 */
	public function process($data)
	{
		$this->populateResponseDetails();

		// This is really quite simple; if ?delete is on the URL, delete the importer...
		switch ($this->config->action)
		{
			case 'delete':
				$this->response->is_xml = true;
				$this->response->addHeader('Content-Type', 'text/xml');
				$this->response->addTemplate('validate');
				$this->response->valid = $this->uninstall();
				break;

			case 'validate':
				$this->validateFields($data);
				$this->response->addHeader('Content-Type', 'text/xml');
				$this->response->is_xml = true;
				$this->response->addTemplate('validate');
				break;

			default:
				$this->response->is_page = true;
				if (method_exists($this, 'doStep' . $this->config->progress->step))
				{
					call_user_func(array($this, 'doStep' . $this->config->progress->step));
				}
				else
				{
					$this->doStep0();
				}
		}

		$this->populateResponseDetails();

		return $this->response;
	}

	public function populateResponseDetails()
	{
		if (isset($this->importer->xml->general->name) && isset($this->importer->config->destination->scriptname))
		{
			$this->response->page_title = $this->importer->xml->general->name . ' ' . $this->response->lng->to . ' ' . $this->importer->config->destination->scriptname;
		}
		else
		{
			$this->response->page_title = 'OpenImporter';
		}

		$this->response->source = !empty($this->response->script['source']) ? addslashes($this->response->script['source']) : '';
		$this->response->destination = !empty($this->response->script['destination']) ? addslashes($this->response->script['destination']) : '';
// 		$this->response->from = $this->importer->settings : null

		$this->response->script = $this->config->script;
// 		$this->response->

// 		$this->response->
// 		$this->response->
	}

	/**
	 * Deletes the importer files from the server
	 * @todo doesn't know yet about the new structure.
	 */
	protected function uninstall()
	{
		// Just in case
		$this->resetImporter();

		@unlink(__FILE__);
		if (preg_match('~_importer\.xml$~', $this->data['import_script']) != 0)
		{
			@unlink(BASEDIR . DS . $this->data['import_script']);
		}
		$this->data['import_script'] = null;
	}

	protected function validateFields($data)
	{
		$this->detectScripts();

		$this->importer->reloadImporter();

		if (isset($data['path_to']))
		{
			$this->response->valid = $this->config->destination->testPath($data['path_to']);
		}
		elseif (isset($data['path_from']))
		{
			$this->response->valid = $this->config->source->loadSettings($data['path_from'], true);
		}
		else
		{
			$this->response->valid = false;
		}
	}

	/**
	 * - checks,  if we have already specified an importer script
	 * - checks the file system for importer definition files
	 * @return boolean
	 */
	protected function detectScripts()
	{
		if ($this->config->script !== null)
		{
			$this->config->script = $this->data['import_script'] = $this->validateScript($this->data['import_script']);
		}
		$destination_names = $this->findDestinations();

		$scripts = $this->findSources();
		$count_scripts = count($scripts);

		if (!empty($this->data['import_script']))
		{
			return false;
		}

		if ($count_scripts == 1)
		{
			$this->data['import_script'] = basename($scripts[0]['path']);
			if (substr($this->data['import_script'], -4) == '.xml')
			{
				$this->importer->reloadImporter();
			}

			return false;
		}

		$this->response->addTemplate('selectScript', array('scripts' => $scripts, 'destination_names' => $destination_names));

		return true;
	}

	/**
	 * Simply scans the Importers/destinations directory looking for destination
	 * files.
	 *
	 * @return string[]
	 */
	protected function findDestinations()
	{
		$destinations = array();

		$iterator = new \GlobIterator($this->config->importers_dir . DS . 'destinations' . DS . '*', GLOB_ONLYDIR);
		foreach ($iterator as $possible_dir)
		{
			$namespace = $possible_dir->getBasename();
			$class_name = '\\OpenImporter\\Importers\\destinations\\' . $namespace . '\\Importer';

			if (class_exists($class_name))
			{
				$obj = new $class_name();
				$destinations[$namespace] = $obj->getName();
			}
		}

		asort($destinations);

		return $destinations;
	}

	/**
	 * Simply scans the Importers/sources directory looking for source files.
	 *
	 * @return string[]
	 */
	protected function findSources()
	{
		$scripts = array();

		// Silence simplexml errors
		libxml_use_internal_errors(true);
		$iterator = new \GlobIterator($this->config->importers_dir . DS . 'sources' . DS . '*_Importer.xml');
		foreach ($iterator as $entry)
		{
			// If a script is broken simply skip it.
			if (!$xmlObj = simplexml_load_file($entry->getPathname(), 'SimpleXMLElement', LIBXML_NOCDATA))
			{
				continue;
			}

			$file_name = $entry->getBasename();

			$scripts[$file_name] = array(
				'path' => $file_name,
				'name' => (string) $xmlObj->general->name
			);
		}

		usort($scripts, function ($v1, $v2)
		{
			return strcasecmp($v1['name'], $v2['name']);
		});

		return $scripts;
	}

	/**
	 * Collects all the important things, the importer can't do anything
	 * without this information.
	 *
	 * @return boolean|null
	 */
	public function doStep0()
	{
		//previously imported? we need to clean some variables ..
		$this->resetImporter();

		if ($this->detectScripts())
		{
			return true;
		}

		try
		{
			$this->importer->reloadImporter();
		}
		catch (Exception $e)
		{
			$this->response->template_error = true;
			$this->response->addErrorParam($e->getMessage());
		}

		$this->response->source_name = (string) $this->importer->xml->general->name;
		$this->response->destination_name = (string) $this->config->destination->scriptname;
		if (($this->response->template_error && $this->response->noTemplates()) || empty($this->response->template_error))
		{
			$this->response->addTemplate('step0', array('form' => $this->getFormStructure()));
		}

		return;
	}

	protected function getFormStructure()
	{
		$form = new Form($this->response->lng);
		$this->prepareStep0Form($form);

		return $form;
	}

	protected function prepareStep0Form($form)
	{
		$form->action_url = $this->response->scripturl . '?step=1';

		$this->importer->populateFormFields($form);

		return $form;
	}

	/**
	 * The important one, transfer the content from the source forum to our
	 * destination system
	 *
	 * @throws \Exception
	 * @return boolean
	 */
	public function doStep1()
	{
		$this->response->step = 1;

		try
		{
			$this->importer->doStep1();
		}
		catch (DatabaseException $e)
		{
			$trace = $e->getTrace();
			$this->response->addErrorParam('', isset($trace[0]['args'][1]) ? $trace[0]['args'][1] : null, $e->getLine(), $e->getFile(), array(
				'query' => $e->getQuery(),
				'error' => $e->getErrorString(),
				'action_url' => $this->response->scripturl . $this->buildActionQuery(),
			));
			$this->response->is_page = true;
			$this->response->template_error = true;

			// Forward back to the original caller to terminate the script
			throw new StepException($e->getMessage());
		}

		$this->config->progress->start = 0;

		return $this->doStep2();
	}

	/**
	 * Puts together the url used in the DatabaseException of sendError to go
	 * back to the last step.
	 *
	 * @return string
	 */
	protected function buildActionQuery()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
	{
		// @todo $_GET and $_REQUEST

		// Get the query string so we pass everything.
		if (isset($_REQUEST['start']))
		{
			$_GET['start'] = $_REQUEST['start'];
		}

		$query_string = '';
		foreach ($_GET as $k => $v)
		{
			$query_string .= '&' . $k . '=' . $v;
		}

		if (strlen($query_string) != 0)
		{
			$query_string = '?' . strtr(substr($query_string, 1), array('&' => '&amp;'));
		}

		return $query_string;
	}

	/**
	 * We have imported the old database, let's recalculate the forum statistics.
	 *
	 * @throws \Exception
	 * @return boolean
	 */
	public function doStep2()
	{
		$this->response->step = '2';
		$this->config->progress->resetStep();

		try
		{
			$this->importer->doStep2($this->config->progress->substep);
		}
		catch (DatabaseException $e)
		{
			$trace = $e->getTrace();
			$this->response->addErrorParam($e->getMessage(), isset($trace[0]['args'][1]) ? $trace[0]['args'][1] : null, $e->getLine(), $e->getFile());
			$this->response->is_page = true;
			$this->response->template_error = true;

			// Forward back to the original caller to terminate the script
			throw new StepException($e->getMessage());
		}

		$this->response->status(1, $this->response->lng->get('recalculate'));

		return $this->doStep3();
	}

	/**
	 * we are done :)
	 *
	 * @return boolean
	 */
	public function doStep3()
	{
		$this->importer->doStep3();

		$writable = (is_writable(BASEDIR) && is_writable(__FILE__));

		$this->response->addTemplate('step3', array('name' => $this->importer->xml->general->name, 'writable' => $writable));

		$this->resetImporter();
		$this->data = array();
		$this->config->store = new ValuesBag();

		return true;
	}
}
OpenImporter / openimporter

Push — development ( 2bb3b4...48f606 )

ImportManager::buildActionQuery() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
