Standard::backup() - Code Metrics - Inspection of "Improved customer group XML importer" - aimeos/ai-controller-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3dda3e...b89f32 )

by Aimeos

created 2022-12-15 11:52 UTC

Standard::backup() A

↳ Parent: Standard

Complexity

Conditions	1
Paths	1

Size

Total Lines	30
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	30
rs	10

<?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();
		$location = $this->location();

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

			if( !file_exists( $location ) )
			{
				$msg = sprintf( 'File or directory "%1$s" doesn\'t exist', $location );
				throw new \Aimeos\Controller\Jobs\Exception( $msg );
			}

			$files = [];

			if( is_dir( $location ) )
			{
				foreach( new \DirectoryIterator( $location ) as $entry )
				{
					if( strncmp( $entry->getFilename(), 'customergroup', 8 ) === 0 && $entry->getExtension() === 'xml' ) {
						$files[] = $entry->getPathname();
					}
				}
			}
			else
			{
				$files[] = $location;
			}

			sort( $files );
			$context->__sleep();

			$fcn = function( $filepath ) {
				$this->import( $filepath );
			};

			foreach( $files as $filepath ) {
				$context->process()->start( $fcn, [$filepath] );
			}

			$context->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 string $filename Absolute or relative path to the XML file
	 */
	protected function import( string $filename )
	{
		$slice = 0;
		$nodes = [];

		$xml = new \XMLReader();
		$maxquery = $this->max();
		$logger = $this->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();
		}

		$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			$location = $this->location();
166
167			try
168			{
169			$logger->info( sprintf( 'Started customer group import from "%1$s"', $location ), 'import/xml/customer/group' );
170
171			if( !file_exists( $location ) )
172			{
173			$msg = sprintf( 'File or directory "%1$s" doesn\'t exist', $location );
174			throw new \Aimeos\Controller\Jobs\Exception( $msg );
175			}
176
177			$files = [];
178
179			if( is_dir( $location ) )
180			{
181			foreach( new \DirectoryIterator( $location ) as $entry )
182			{
183			if( strncmp( $entry->getFilename(), 'customergroup', 8 ) === 0 && $entry->getExtension() === 'xml' ) {
184			$files[] = $entry->getPathname();
185			}
186			}
187			}
188			else
189			{
190			$files[] = $location;
191			}
192
193			sort( $files );
194			$context->__sleep();
195
196			$fcn = function( $filepath ) {
197			$this->import( $filepath );
198			};
199
200			foreach( $files as $filepath ) {
201			$context->process()->start( $fcn, [$filepath] );
202			}
203
204			$context->process()->wait();
205
206			$logger->info( sprintf( 'Finished customer group import from "%1$s"', $location ), 'import/xml/customer/group' );
207			}
208			catch( \Exception $e )
209			{
210			$logger->error( 'Customer group import error: ' . $e->getMessage() . "\n" . $e->getTraceAsString(), 'import/xml/customer/group' );
211			$this->mail( 'Customer group XML import error', $e->getMessage() . "\n" . $e->getTraceAsString() );
212			throw $e;
213			}
214			}
215
216
217			/**
218			* Returns the directory for storing imported files
219			*
220			* @return string Directory for storing imported files
221			*/
222			protected function backup() : string
223			{
224			/** controller/jobs/customer/group/import/xml/backup
225			* Name of the backup for sucessfully imported files
226			*
227			* After a XML file was imported successfully, you can move it to another
228			* location, so it won't be imported again and isn't overwritten by the
229			* next file that is stored at the same location in the file system.
230			*
231			* You should use an absolute path to be sure but can be relative path
232			* if you absolutely know from where the job will be executed from. The
233			* name of the new backup location can contain placeholders understood
234			* by the PHP DateTime::format() method (with percent signs prefix) to
235			* create dynamic paths, e.g. "backup/%Y-%m-%d" which would create
236			* "backup/2000-01-01". For more information about the date() placeholders,
237			* please have a look into the PHP documentation of the
238			* {@link https://www.php.net/manual/en/datetime.format.php format() method}.
239			*
240			* Note: If no backup name is configured, the file or directory
241			* won't be moved away. Please make also sure that the parent directory
242			* and the new directory are writable so the file or directory could be
243			* moved.
244			*
245			* @param integer Name of the backup file, optionally with date/time placeholders
246			* @since 2019.04
247			* @see controller/jobs/customer/group/import/xml/domains
248			* @see controller/jobs/customer/group/import/xml/location
249			* @see controller/jobs/customer/group/import/xml/max-query
250			*/
251			return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/backup' );
252			}
253
254
255			/**
256			* Imports the XML file given by its path
257			*
258			* @param string $filename Absolute or relative path to the XML file
259			*/
260			protected function import( string $filename )
261			{
262			$slice = 0;
263			$nodes = [];
264
265			$xml = new \XMLReader();
266			$maxquery = $this->max();
267			$logger = $this->context()->logger();
268
269			if( $xml->open( $filename, LIBXML_COMPACT \| LIBXML_PARSEHUGE ) === false ) {
270			throw new \Aimeos\Controller\Jobs\Exception( sprintf( 'No XML file "%1$s" found', $filename ) );
271			}
272
273			$logger->info( sprintf( 'Started customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );
274
275			while( $xml->read() === true )
276			{
277			if( $xml->depth === 1 && $xml->nodeType === \XMLReader::ELEMENT && $xml->name === 'customergroupitem' )
278			{
279			if( ( $dom = $xml->expand() ) === false )
280			{
281			$msg = sprintf( 'Expanding "%1$s" node failed', 'customergroupitem' );
282			throw new \Aimeos\Controller\Jobs\Exception( $msg );
283			}
284
285			$nodes[] = $dom;
286
287			if( $slice++ >= $maxquery )
288			{
289			$this->importNodes( $nodes );
290			unset( $nodes );
291			$nodes = [];
292			$slice = 0;
293			}
294			}
295			}
296
297			$this->importNodes( $nodes );
298			unset( $nodes );
299
300			foreach( $this->getProcessors() as $proc ) {
301			$proc->finish();
302			}
303
304			$logger->info( sprintf( 'Finished customer group import from file "%1$s"', $filename ), 'import/xml/customer/group' );
305
306			if( !empty( $backup = $this->backup() ) && @rename( $filename, $backup = \Aimeos\Base\Str::strtime( $backup ) ) === false )
307			{
308			$msg = sprintf( 'Unable to move imported file "%1$s" to "%2$s"', $filename, $backup );
309			throw new \Aimeos\Controller\Jobs\Exception( $msg );
310			}
311			}
312
313
314			/**
315			* Imports the given DOM nodes
316			*
317			* @param string[] $ref List of domain names whose referenced items will be updated in the customer group items
318			*/
319			protected function importNodes( array $nodes )
320			{
321			$codes = $map = [];
322
323			foreach( $nodes as $node )
324			{
325			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null ) {
326			$codes[$attr->nodeValue] = null;
327			}
328			}
329
330			$manager = \Aimeos\MShop::create( $this->context(), 'customer/group' );
331			$search = $manager->filter()->slice( 0, count( $codes ) );
332			$search->setConditions( $search->compare( '==', 'customer.group.code', array_keys( $codes ) ) );
333
334			foreach( $manager->search( $search ) as $item ) {
335			$map[$item->getCode()] = $item;
336			}
337
338			foreach( $nodes as $node )
339			{
340			if( ( $attr = $node->attributes->getNamedItem( 'ref' ) ) !== null && isset( $map[$attr->nodeValue] ) ) {
341			$item = $this->process( $map[$attr->nodeValue], $node );
342			} else {
343			$item = $this->process( $manager->create(), $node );
344			}
345
346			$manager->save( $item );
347			}
348			}
349
350
351			/**
352			* Returns the path to the directory with the XML file
353			*
354			* @return string Path to the directory with the XML file
355			*/
356			protected function location() : string
357			{
358			/** controller/jobs/customer/group/import/xml/location
359			* File or directory where the content is stored which should be imported
360			*
361			* You need to configure the XML file or directory with the XML files that
362			* should be imported. It should be an absolute path to be sure but can be
363			* relative path if you absolutely know from where the job will be executed
364			* from.
365			*
366			* @param string Relative path to the XML files
367			* @since 2019.04
368			* @see controller/jobs/customer/group/import/xml/backup
369			* @see controller/jobs/customer/group/import/xml/domains
370			* @see controller/jobs/customer/group/import/xml/max-query
371			*/
372			return (string) $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/location', 'customergroup' );
373			}
374
375
376			/**
377			* Returns the maximum number of XML nodes processed at once
378			*
379			* @return int Maximum number of XML nodes
380			*/
381			protected function max() : int
382			{
383			/** controller/jobs/customer/group/import/xml/max-query
384			* Maximum number of XML nodes processed at once
385			*
386			* Processing and fetching several attribute items at once speeds up importing
387			* the XML files. The more items can be processed at once, the faster the
388			* import. More items also increases the memory usage of the importer and
389			* thus, this parameter should be low enough to avoid reaching the memory
390			* limit of the PHP process.
391			*
392			* @param integer Number of XML nodes
393			* @since 2019.04
394			* @see controller/jobs/customer/group/import/xml/domains
395			* @see controller/jobs/customer/group/import/xml/location
396			* @see controller/jobs/customer/group/import/xml/backup
397			*/
398			return $this->context()->config()->get( 'controller/jobs/customer/group/import/xml/max-query', 100 );
399			}
400
401
402			/**
403			* Updates the customer group item and its referenced items using the given DOM node
404			*
405			* @param \Aimeos\MShop\Customer\Item\Group\Iface $item Customer group item object to update
406			* @param \DomElement $node DOM node used for updating the customer group item
407			* @return \Aimeos\MShop\Customer\Item\Group\Iface $item Updated customer group item object
408			*/
409			protected function process( \Aimeos\MShop\Customer\Item\Group\Iface $item, \DomElement $node ) : \Aimeos\MShop\Customer\Item\Group\Iface
410			{
411			$list = [];
412
413			foreach( $node->attributes as $attr ) {
414			$list[$attr->nodeName] = $attr->nodeValue;
415			}
416
417			foreach( $node->childNodes as $tag ) {
418			$list[$tag->nodeName] = $tag->nodeValue;
419			}
420
421			return $item->fromArray( $list, true );
422			}
423			}
424

aimeos / ai-controller-jobs

Push — master ( 3dda3e...b89f32 )

Standard::backup() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like