Standard::run() - Code Metrics - Inspection of "Ignore directories in XML importers" - aimeos/ai-controller-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b27fbc...b83806 )

by Aimeos

created 2022-12-20 13:17 UTC

Standard::run() B

↳ Parent: Standard

Complexity

Conditions	6
Paths	12

Size

Total Lines	41
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	22
c	1
b	0
f	0
nc	12
nop	0
dl	0
loc	41
rs	8.9457

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2019-2022
 * @package Controller
 * @subpackage Jobs
 */


namespace Aimeos\Controller\Jobs\Customer\Group\Import\Xml;


/**
 * Job controller for XML customer imports
 *
 * @package Controller
 * @subpackage Jobs
 */
class Standard
	extends \Aimeos\Controller\Jobs\Base
	implements \Aimeos\Controller\Jobs\Iface
{
	/** controller/jobs/customer/import/xml/name
	 * Class name of the used customer suggestions scheduler controller implementation
	 *
	 * Each default job controller can be replace by an alternative imlementation.
	 * To use this implementation, you have to set the last part of the class
	 * name as configuration value so the controller factory knows which class it
	 * has to instantiate.
	 *
	 * For example, if the name of the default class is
	 *
	 *  \Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Standard
	 *
	 * and you want to replace it with your own version named
	 *
	 *  \Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Myxml
	 *
	 * then you have to set the this configuration option:
	 *
	 *  controller/jobs/customer/import/xml/name = Myxml
	 *
	 * The value is the last part of your own class name and it's case sensitive,
	 * so take care that the configuration value is exactly named like the last
	 * part of the class name.
	 *
	 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
	 * characters are possible! You should always start the last part of the class
	 * name with an upper case character and continue only with lower case characters
	 * or numbers. Avoid chamel case names like "MyXml"!
	 *
	 * @param string Last part of the class name
	 * @since 2019.04
	 */

	/** controller/jobs/customer/import/xml/decorators/excludes
	 * Excludes decorators added by the "common" option from the customer import CSV job controller
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to remove a decorator added via
	 * "controller/jobs/common/decorators/default" before they are wrapped
	 * around the job controller.
	 *
	 *  controller/jobs/customer/import/xml/decorators/excludes = array( 'decorator1' )
	 *
	 * This would remove the decorator named "decorator1" from the list of
	 * common decorators ("\Aimeos\Controller\Jobs\Common\Decorator\*") added via
	 * "controller/jobs/common/decorators/default" to the job controller.
	 *
	 * @param array List of decorator names
	 * @since 2019.04
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/customer/import/xml/decorators/global
	 * @see controller/jobs/customer/import/xml/decorators/local
	 */

	/** controller/jobs/customer/import/xml/decorators/global
	 * Adds a list of globally available decorators only to the customer import CSV job controller
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap global decorators
	 * ("\Aimeos\Controller\Jobs\Common\Decorator\*") around the job controller.
	 *
	 *  controller/jobs/customer/import/xml/decorators/global = array( 'decorator1' )
	 *
	 * This would add the decorator named "decorator1" defined by
	 * "\Aimeos\Controller\Jobs\Common\Decorator\Decorator1" only to the job controller.
	 *
	 * @param array List of decorator names
	 * @since 2019.04
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/customer/import/xml/decorators/excludes
	 * @see controller/jobs/customer/import/xml/decorators/local
	 */

	/** controller/jobs/customer/import/xml/decorators/local
	 * Adds a list of local decorators only to the customer import CSV job controller
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap local decorators
	 * ("\Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Decorator\*") around the job
	 * controller.
	 *
	 *  controller/jobs/customer/import/xml/decorators/local = array( 'decorator2' )
	 *
	 * This would add the decorator named "decorator2" defined by
	 * "\Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Decorator\Decorator2"
	 * only to the job controller.
	 *
	 * @param array List of decorator names
	 * @since 2019.04
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/customer/import/xml/decorators/excludes
	 * @see controller/jobs/customer/import/xml/decorators/global
	 */


	use \Aimeos\Controller\Common\Common\Import\Xml\Traits;


	/**
	 * Returns the localized name of the job.
	 *
	 * @return string Name of the job
	 */
	public function getName() : string
	{
		return $this->context()->translate( 'controller/jobs', 'Customer group import XML' );
	}


	/**
	 * Returns the localized description of the job.
	 *
	 * @return string Description of the job
	 */
	public function getDescription() : string
	{
		return $this->context()->translate( 'controller/jobs', 'Imports new and updates existing customer groups from XML files' );
	}


	/**
	 * Executes the job.
	 *
	 * @throws \Aimeos\Controller\Jobs\Exception If an error occurs
	 */
	public function run()
	{
		$context = $this->context();
		$logger = $context->logger();
		$process = $context->process();

		$location = $this->location();
		$fs = $context->fs( 'fs-import' );

		if( $fs->isDir( $location ) === false ) {
			return;
		}

		try
		{
			$logger->info( sprintf( 'Started customer group import from "%1$s"', $location ), 'import/xml/customer/group' );

			$fcn = function( \Aimeos\MShop\ContextIface $context, string $path ) {
				$this->import( $context, $path );
			};

			foreach( map( $fs->scan( $location ) )->sort() as $filename )
			{
				$path = $location . '/' . $filename;

				if( $fs instanceof \Aimeos\Base\Filesystem\DirIface && $fs->isDir( $path ) ) {
					continue;
				}

				$process->start( $fcn, [$context, $fs->readf( $path )] );
			}

			$process->wait();

			$logger->info( sprintf( 'Finished customer group import from "%1$s"', $location ), 'import/xml/customer/group' );
		}
		catch( \Exception $e )
		{
			$logger->error( 'Customer group import error: ' . $e->getMessage() . "\n" . $e->getTraceAsString(), 'import/xml/customer/group' );
			$this->mail( 'Customer group XML import error', $e->getMessage() . "\n" . $e->getTraceAsString() );
			throw $e;
		}
	}


	/**
	 * Returns the directory for storing imported files
	 *
	 * @return string Directory for storing imported files
	 */
	protected function backup() : string
	{
		/** controller/jobs/customer/group/import/xml/backup
		 * Name of the backup for sucessfully imported files
		 *
		 * After a XML file was imported successfully, you can move it to another
		 * location, so it won't be imported again and isn't overwritten by the
		 * next file that is stored at the same location in the file system.
		 *
		 * You should use an absolute path to be sure but can be relative path
		 * if you absolutely know from where the job will be executed from. The
		 * name of the new backup location can contain placeholders understood
		 * by the PHP DateTime::format() method (with percent signs prefix) to
		 * create dynamic paths, e.g. "backup/%Y-%m-%d" which would create
		 * "backup/2000-01-01". For more information about the date() placeholders,
		 * please have a look  into the PHP documentation of the
		 * {@link https://www.php.net/manual/en/datetime.format.php format() method}.
		 *
		 * **Note:** If no backup name is configured, the file or directory
		 * won't be moved away. Please make also sure that the parent directory
		 * and the new directory are writable so the file or directory could be
		 * moved.
		 *
		 * @param integer Name of the backup file, optionally with date/time placeholders
		 * @since 2019.04
		 * @see controller/jobs/customer/group/import/xml/domains
		 * @see controller/jobs/customer/group/import/xml/location
		 * @see controller/jobs/customer/group/import/xml/max-query
		 */
		return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/backup' );
	}


	/**
	 * Imports the XML file given by its path
	 *
	 * @param \Aimeos\MShop\ContextIface $context Context object
	 * @param string $filename Absolute or relative path to the XML file
	 */
	protected function import( \Aimeos\MShop\ContextIface $context, string $filename )
	{
		$slice = 0;
		$nodes = [];

		$xml = new \XMLReader();
		$maxquery = $this->max();
		$logger = $context->logger();

		if( $xml->open( $filename, LIBXML_COMPACT | LIBXML_PARSEHUGE ) === false ) {
			throw new \Aimeos\Controller\Jobs\Exception( sprintf( 'No XML file "%1$s" found', $filename ) );
		}

		$logger->info( sprintf( 'Started customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );

		while( $xml->read() === true )
		{
			if( $xml->depth === 1 && $xml->nodeType === \XMLReader::ELEMENT && $xml->name === 'customergroupitem' )
			{
				if( ( $dom = $xml->expand() ) === false )
				{
					$msg = sprintf( 'Expanding "%1$s" node failed', 'customergroupitem' );
					throw new \Aimeos\Controller\Jobs\Exception( $msg );
				}

				$nodes[] = $dom;

				if( $slice++ >= $maxquery )
				{
					$this->importNodes( $nodes );
					unset( $nodes );
					$nodes = [];
					$slice = 0;
				}
			}
		}

		$this->importNodes( $nodes );
		unset( $nodes );

		foreach( $this->getProcessors() as $proc ) {
			$proc->finish();
		}

		unlink( $filename );

		$logger->info( sprintf( 'Finished customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );

		if( !empty( $backup = $this->backup() ) && @rename( $filename, $backup = \Aimeos\Base\Str::strtime( $backup ) ) === false )
		{
			$msg = sprintf( 'Unable to move imported file "%1$s" to "%2$s"', $filename, $backup );
			throw new \Aimeos\Controller\Jobs\Exception( $msg );
		}
	}


	/**
	 * Imports the given DOM nodes
	 *
	 * @param string[] $ref List of domain names whose referenced items will be updated in the customer group items
	 */
	protected function importNodes( array $nodes )
	{
		$codes = $map = [];

		foreach( $nodes as $node )
		{
			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null ) {
				$codes[$attr->nodeValue] = null;
			}
		}

		$manager = \Aimeos\MShop::create( $this->context(), 'customer/group' );
		$search = $manager->filter()->slice( 0, count( $codes ) );
		$search->setConditions( $search->compare( '==', 'customer.group.code', array_keys( $codes ) ) );

		foreach( $manager->search( $search ) as $item ) {
			$map[$item->getCode()] = $item;
		}

		foreach( $nodes as $node )
		{
			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null && isset( $map[$attr->nodeValue] ) ) {
				$item = $this->process( $map[$attr->nodeValue], $node );
			} else {
				$item = $this->process( $manager->create(), $node );
			}

			$manager->save( $item );
		}
	}


	/**
	 * Returns the path to the directory with the XML file
	 *
	 * @return string Path to the directory with the XML file
	 */
	protected function location() : string
	{
		/** controller/jobs/customer/group/import/xml/location
		 * File or directory where the content is stored which should be imported
		 *
		 * You need to configure the XML file or directory with the XML files that
		 * should be imported. It should be an absolute path to be sure but can be
		 * relative path if you absolutely know from where the job will be executed
		 * from.
		 *
		 * @param string Relative path to the XML files
		 * @since 2019.04
		 * @see controller/jobs/customer/group/import/xml/backup
		 * @see controller/jobs/customer/group/import/xml/domains
		 * @see controller/jobs/customer/group/import/xml/max-query
		 */
		return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/location', 'customergroup' );
	}


	/**
	 * Returns the maximum number of XML nodes processed at once
	 *
	 * @return int Maximum number of XML nodes
	 */
	protected function max() : int
	{
		/** controller/jobs/customer/group/import/xml/max-query
		 * Maximum number of XML nodes processed at once
		 *
		 * Processing and fetching several attribute items at once speeds up importing
		 * the XML files. The more items can be processed at once, the faster the
		 * import. More items also increases the memory usage of the importer and
		 * thus, this parameter should be low enough to avoid reaching the memory
		 * limit of the PHP process.
		 *
		 * @param integer Number of XML nodes
		 * @since 2019.04
		 * @see controller/jobs/customer/group/import/xml/domains
		 * @see controller/jobs/customer/group/import/xml/location
		 * @see controller/jobs/customer/group/import/xml/backup
		 */
		return $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/max-query', 100 );
	}


	/**
	 * Updates the customer group item and its referenced items using the given DOM node
	 *
	 * @param \Aimeos\MShop\Customer\Item\Group\Iface $item Customer group item object to update
	 * @param \DomElement $node DOM node used for updating the customer group item
	 * @return \Aimeos\MShop\Customer\Item\Group\Iface $item Updated customer group item object
	 */
	protected function process( \Aimeos\MShop\Customer\Item\Group\Iface $item, \DomElement $node ) : \Aimeos\MShop\Customer\Item\Group\Iface
	{
		$list = [];

		foreach( $node->attributes as $attr ) {
			$list[$attr->nodeName] = $attr->nodeValue;
		}

		foreach( $node->childNodes as $tag ) {
			$list[$tag->nodeName] = $tag->nodeValue;
		}

		return $item->fromArray( $list, true );
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2019-2022
6			* @package Controller
7			* @subpackage Jobs
8			*/
9
10
11			namespace Aimeos\Controller\Jobs\Customer\Group\Import\Xml;
12
13
14			/**
15			* Job controller for XML customer imports
16			*
17			* @package Controller
18			* @subpackage Jobs
19			*/
20			class Standard
21			extends \Aimeos\Controller\Jobs\Base
22			implements \Aimeos\Controller\Jobs\Iface
23			{
24			/** controller/jobs/customer/import/xml/name
25			* Class name of the used customer suggestions scheduler controller implementation
26			*
27			* Each default job controller can be replace by an alternative imlementation.
28			* To use this implementation, you have to set the last part of the class
29			* name as configuration value so the controller factory knows which class it
30			* has to instantiate.
31			*
32			* For example, if the name of the default class is
33			*
34			* \Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Standard
35			*
36			* and you want to replace it with your own version named
37			*
38			* \Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Myxml
39			*
40			* then you have to set the this configuration option:
41			*
42			* controller/jobs/customer/import/xml/name = Myxml
43			*
44			* The value is the last part of your own class name and it's case sensitive,
45			* so take care that the configuration value is exactly named like the last
46			* part of the class name.
47			*
48			* The allowed characters of the class name are A-Z, a-z and 0-9. No other
49			* characters are possible! You should always start the last part of the class
50			* name with an upper case character and continue only with lower case characters
51			* or numbers. Avoid chamel case names like "MyXml"!
52			*
53			* @param string Last part of the class name
54			* @since 2019.04
55			*/
56
57			/** controller/jobs/customer/import/xml/decorators/excludes
58			* Excludes decorators added by the "common" option from the customer import CSV job controller
59			*
60			* Decorators extend the functionality of a class by adding new aspects
61			* (e.g. log what is currently done), executing the methods of the underlying
62			* class only in certain conditions (e.g. only for logged in users) or
63			* modify what is returned to the caller.
64			*
65			* This option allows you to remove a decorator added via
66			* "controller/jobs/common/decorators/default" before they are wrapped
67			* around the job controller.
68			*
69			* controller/jobs/customer/import/xml/decorators/excludes = array( 'decorator1' )
70			*
71			* This would remove the decorator named "decorator1" from the list of
72			* common decorators ("\Aimeos\Controller\Jobs\Common\Decorator\*") added via
73			* "controller/jobs/common/decorators/default" to the job controller.
74			*
75			* @param array List of decorator names
76			* @since 2019.04
77			* @see controller/jobs/common/decorators/default
78			* @see controller/jobs/customer/import/xml/decorators/global
79			* @see controller/jobs/customer/import/xml/decorators/local
80			*/
81
82			/** controller/jobs/customer/import/xml/decorators/global
83			* Adds a list of globally available decorators only to the customer import CSV job controller
84			*
85			* Decorators extend the functionality of a class by adding new aspects
86			* (e.g. log what is currently done), executing the methods of the underlying
87			* class only in certain conditions (e.g. only for logged in users) or
88			* modify what is returned to the caller.
89			*
90			* This option allows you to wrap global decorators
91			* ("\Aimeos\Controller\Jobs\Common\Decorator\*") around the job controller.
92			*
93			* controller/jobs/customer/import/xml/decorators/global = array( 'decorator1' )
94			*
95			* This would add the decorator named "decorator1" defined by
96			* "\Aimeos\Controller\Jobs\Common\Decorator\Decorator1" only to the job controller.
97			*
98			* @param array List of decorator names
99			* @since 2019.04
100			* @see controller/jobs/common/decorators/default
101			* @see controller/jobs/customer/import/xml/decorators/excludes
102			* @see controller/jobs/customer/import/xml/decorators/local
103			*/
104
105			/** controller/jobs/customer/import/xml/decorators/local
106			* Adds a list of local decorators only to the customer import CSV job controller
107			*
108			* Decorators extend the functionality of a class by adding new aspects
109			* (e.g. log what is currently done), executing the methods of the underlying
110			* class only in certain conditions (e.g. only for logged in users) or
111			* modify what is returned to the caller.
112			*
113			* This option allows you to wrap local decorators
114			* ("\Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Decorator\*") around the job
115			* controller.
116			*
117			* controller/jobs/customer/import/xml/decorators/local = array( 'decorator2' )
118			*
119			* This would add the decorator named "decorator2" defined by
120			* "\Aimeos\Controller\Jobs\Customer\Group\Import\Xml\Decorator\Decorator2"
121			* only to the job controller.
122			*
123			* @param array List of decorator names
124			* @since 2019.04
125			* @see controller/jobs/common/decorators/default
126			* @see controller/jobs/customer/import/xml/decorators/excludes
127			* @see controller/jobs/customer/import/xml/decorators/global
128			*/
129
130
131			use \Aimeos\Controller\Common\Common\Import\Xml\Traits;
132
133
134			/**
135			* Returns the localized name of the job.
136			*
137			* @return string Name of the job
138			*/
139			public function getName() : string
140			{
141			return $this->context()->translate( 'controller/jobs', 'Customer group import XML' );
142			}
143
144
145			/**
146			* Returns the localized description of the job.
147			*
148			* @return string Description of the job
149			*/
150			public function getDescription() : string
151			{
152			return $this->context()->translate( 'controller/jobs', 'Imports new and updates existing customer groups from XML files' );
153			}
154
155
156			/**
157			* Executes the job.
158			*
159			* @throws \Aimeos\Controller\Jobs\Exception If an error occurs
160			*/
161			public function run()
162			{
163			$context = $this->context();
164			$logger = $context->logger();
165			$process = $context->process();
166
167			$location = $this->location();
168			$fs = $context->fs( 'fs-import' );
169
170			if( $fs->isDir( $location ) === false ) {
171			return;
172			}
173
174			try
175			{
176			$logger->info( sprintf( 'Started customer group import from "%1$s"', $location ), 'import/xml/customer/group' );
177
178			$fcn = function( \Aimeos\MShop\ContextIface $context, string $path ) {
179			$this->import( $context, $path );
180			};
181
182			foreach( map( $fs->scan( $location ) )->sort() as $filename )
183			{
184			$path = $location . '/' . $filename;
185
186			if( $fs instanceof \Aimeos\Base\Filesystem\DirIface && $fs->isDir( $path ) ) {
187			continue;
188			}
189
190			$process->start( $fcn, [$context, $fs->readf( $path )] );
191			}
192
193			$process->wait();
194
195			$logger->info( sprintf( 'Finished customer group import from "%1$s"', $location ), 'import/xml/customer/group' );
196			}
197			catch( \Exception $e )
198			{
199			$logger->error( 'Customer group import error: ' . $e->getMessage() . "\n" . $e->getTraceAsString(), 'import/xml/customer/group' );
200			$this->mail( 'Customer group XML import error', $e->getMessage() . "\n" . $e->getTraceAsString() );
201			throw $e;
202			}
203			}
204
205
206			/**
207			* Returns the directory for storing imported files
208			*
209			* @return string Directory for storing imported files
210			*/
211			protected function backup() : string
212			{
213			/** controller/jobs/customer/group/import/xml/backup
214			* Name of the backup for sucessfully imported files
215			*
216			* After a XML file was imported successfully, you can move it to another
217			* location, so it won't be imported again and isn't overwritten by the
218			* next file that is stored at the same location in the file system.
219			*
220			* You should use an absolute path to be sure but can be relative path
221			* if you absolutely know from where the job will be executed from. The
222			* name of the new backup location can contain placeholders understood
223			* by the PHP DateTime::format() method (with percent signs prefix) to
224			* create dynamic paths, e.g. "backup/%Y-%m-%d" which would create
225			* "backup/2000-01-01". For more information about the date() placeholders,
226			* please have a look into the PHP documentation of the
227			* {@link https://www.php.net/manual/en/datetime.format.php format() method}.
228			*
229			* Note: If no backup name is configured, the file or directory
230			* won't be moved away. Please make also sure that the parent directory
231			* and the new directory are writable so the file or directory could be
232			* moved.
233			*
234			* @param integer Name of the backup file, optionally with date/time placeholders
235			* @since 2019.04
236			* @see controller/jobs/customer/group/import/xml/domains
237			* @see controller/jobs/customer/group/import/xml/location
238			* @see controller/jobs/customer/group/import/xml/max-query
239			*/
240			return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/backup' );
241			}
242
243
244			/**
245			* Imports the XML file given by its path
246			*
247			* @param \Aimeos\MShop\ContextIface $context Context object
248			* @param string $filename Absolute or relative path to the XML file
249			*/
250			protected function import( \Aimeos\MShop\ContextIface $context, string $filename )
251			{
252			$slice = 0;
253			$nodes = [];
254
255			$xml = new \XMLReader();
256			$maxquery = $this->max();
257			$logger = $context->logger();
258
259			if( $xml->open( $filename, LIBXML_COMPACT \| LIBXML_PARSEHUGE ) === false ) {
260			throw new \Aimeos\Controller\Jobs\Exception( sprintf( 'No XML file "%1$s" found', $filename ) );
261			}
262
263			$logger->info( sprintf( 'Started customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );
264
265			while( $xml->read() === true )
266			{
267			if( $xml->depth === 1 && $xml->nodeType === \XMLReader::ELEMENT && $xml->name === 'customergroupitem' )
268			{
269			if( ( $dom = $xml->expand() ) === false )
270			{
271			$msg = sprintf( 'Expanding "%1$s" node failed', 'customergroupitem' );
272			throw new \Aimeos\Controller\Jobs\Exception( $msg );
273			}
274
275			$nodes[] = $dom;
276
277			if( $slice++ >= $maxquery )
278			{
279			$this->importNodes( $nodes );
280			unset( $nodes );
281			$nodes = [];
282			$slice = 0;
283			}
284			}
285			}
286
287			$this->importNodes( $nodes );
288			unset( $nodes );
289
290			foreach( $this->getProcessors() as $proc ) {
291			$proc->finish();
292			}
293
294			unlink( $filename );
295
296			$logger->info( sprintf( 'Finished customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );
297
298			if( !empty( $backup = $this->backup() ) && @rename( $filename, $backup = \Aimeos\Base\Str::strtime( $backup ) ) === false )
299			{
300			$msg = sprintf( 'Unable to move imported file "%1$s" to "%2$s"', $filename, $backup );
301			throw new \Aimeos\Controller\Jobs\Exception( $msg );
302			}
303			}
304
305
306			/**
307			* Imports the given DOM nodes
308			*
309			* @param string[] $ref List of domain names whose referenced items will be updated in the customer group items
310			*/
311			protected function importNodes( array $nodes )
312			{
313			$codes = $map = [];
314
315			foreach( $nodes as $node )
316			{
317			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null ) {
318			$codes[$attr->nodeValue] = null;
319			}
320			}
321
322			$manager = \Aimeos\MShop::create( $this->context(), 'customer/group' );
323			$search = $manager->filter()->slice( 0, count( $codes ) );
324			$search->setConditions( $search->compare( '==', 'customer.group.code', array_keys( $codes ) ) );
325
326			foreach( $manager->search( $search ) as $item ) {
327			$map[$item->getCode()] = $item;
328			}
329
330			foreach( $nodes as $node )
331			{
332			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null && isset( $map[$attr->nodeValue] ) ) {
333			$item = $this->process( $map[$attr->nodeValue], $node );
334			} else {
335			$item = $this->process( $manager->create(), $node );
336			}
337
338			$manager->save( $item );
339			}
340			}
341
342
343			/**
344			* Returns the path to the directory with the XML file
345			*
346			* @return string Path to the directory with the XML file
347			*/
348			protected function location() : string
349			{
350			/** controller/jobs/customer/group/import/xml/location
351			* File or directory where the content is stored which should be imported
352			*
353			* You need to configure the XML file or directory with the XML files that
354			* should be imported. It should be an absolute path to be sure but can be
355			* relative path if you absolutely know from where the job will be executed
356			* from.
357			*
358			* @param string Relative path to the XML files
359			* @since 2019.04
360			* @see controller/jobs/customer/group/import/xml/backup
361			* @see controller/jobs/customer/group/import/xml/domains
362			* @see controller/jobs/customer/group/import/xml/max-query
363			*/
364			return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/location', 'customergroup' );
365			}
366
367
368			/**
369			* Returns the maximum number of XML nodes processed at once
370			*
371			* @return int Maximum number of XML nodes
372			*/
373			protected function max() : int
374			{
375			/** controller/jobs/customer/group/import/xml/max-query
376			* Maximum number of XML nodes processed at once
377			*
378			* Processing and fetching several attribute items at once speeds up importing
379			* the XML files. The more items can be processed at once, the faster the
380			* import. More items also increases the memory usage of the importer and
381			* thus, this parameter should be low enough to avoid reaching the memory
382			* limit of the PHP process.
383			*
384			* @param integer Number of XML nodes
385			* @since 2019.04
386			* @see controller/jobs/customer/group/import/xml/domains
387			* @see controller/jobs/customer/group/import/xml/location
388			* @see controller/jobs/customer/group/import/xml/backup
389			*/
390			return $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/max-query', 100 );
391			}
392
393
394			/**
395			* Updates the customer group item and its referenced items using the given DOM node
396			*
397			* @param \Aimeos\MShop\Customer\Item\Group\Iface $item Customer group item object to update
398			* @param \DomElement $node DOM node used for updating the customer group item
399			* @return \Aimeos\MShop\Customer\Item\Group\Iface $item Updated customer group item object
400			*/
401			protected function process( \Aimeos\MShop\Customer\Item\Group\Iface $item, \DomElement $node ) : \Aimeos\MShop\Customer\Item\Group\Iface
402			{
403			$list = [];
404
405			foreach( $node->attributes as $attr ) {
406			$list[$attr->nodeName] = $attr->nodeValue;
407			}
408
409			foreach( $node->childNodes as $tag ) {
410			$list[$tag->nodeName] = $tag->nodeValue;
411			}
412
413			return $item->fromArray( $list, true );
414			}
415			}
416

aimeos / ai-controller-jobs

Push — master ( b27fbc...b83806 )

Standard::run() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like