PluginProbe
Packeta / 2.3.2
Packeta v2.3.2
2.3.2 2.3.1 trunk 1.2.2 1.2.3 1.2.4 1.2.5 1.2.6 1.3.0 1.3.1 1.3.2 1.4 1.4.1 1.4.2 1.4.3 1.5.0 1.5.1 1.5.2 1.5.3 1.5.4 1.6.0 1.6.1 1.6.2 1.6.3 1.6.4 All 56 releases
← All changes | src/Packetery/Module/Upgrade.php +232 -91 1.2.42.3.2 View file →
@@ -11,8 +11,12 @@
11 11
12 12 use Packetery\Core;
13 13 use Packetery\Core\Log\ILogger;
14 14 use Packetery\Core\Log\Record;
15 +use Packetery\Module\Carrier\EntityRepository;
16 +use Packetery\Module\Options\OptionNames;
17 +use Packetery\Module\Options\OptionsProvider;
18 +use Packetery\Module\Upgrade\Version_1_4_2;
15 19
16 20 /**
17 21 * Class Upgrade.
18 22 */
@@ -65,25 +69,60 @@
65 69 */
66 70 private $logRepository;
67 71
68 72 /**
69 - * Constructor.
73 + * Carrier repository.
70 74 *
71 - * @param Order\Repository $orderRepository Order repository.
72 - * @param MessageManager $messageManager Message manager.
73 - * @param ILogger $logger Logger.
74 - * @param Log\Repository $logRepository Log repository.
75 + * @var Carrier\Repository
75 76 */
77 + private $carrierRepository;
78 +
79 + /**
80 + * Customs declaration repository.
81 + *
82 + * @var CustomsDeclaration\Repository
83 + */
84 + private $customsDeclarationRepository;
85 +
86 + /**
87 + * WpdbAdapter.
88 + *
89 + * @var WpdbAdapter
90 + */
91 + private $wpdbAdapter;
92 +
93 + /**
94 + * Options provider.
95 + *
96 + * @var OptionsProvider
97 + */
98 + private $optionsProvider;
99 +
100 + /**
101 + * @var EntityRepository
102 + */
103 + private $carrierEntityRepository;
104 +
76 105 public function __construct(
77 106 Order\Repository $orderRepository,
78 107 MessageManager $messageManager,
79 108 ILogger $logger,
80 - Log\Repository $logRepository
109 + Log\Repository $logRepository,
110 + WpdbAdapter $wpdbAdapter,
111 + Carrier\Repository $carrierRepository,
112 + CustomsDeclaration\Repository $customsDeclarationRepository,
113 + OptionsProvider $optionsProvider,
114 + EntityRepository $carrierEntityRepository
81 115 ) {
82 - $this->orderRepository = $orderRepository;
83 - $this->messageManager = $messageManager;
84 - $this->logger = $logger;
85 - $this->logRepository = $logRepository;
116 + $this->orderRepository = $orderRepository;
117 + $this->messageManager = $messageManager;
118 + $this->logger = $logger;
119 + $this->logRepository = $logRepository;
120 + $this->wpdbAdapter = $wpdbAdapter;
121 + $this->carrierRepository = $carrierRepository;
122 + $this->customsDeclarationRepository = $customsDeclarationRepository;
123 + $this->optionsProvider = $optionsProvider;
124 + $this->carrierEntityRepository = $carrierEntityRepository;
86 125 }
87 126
88 127 /**
89 128 * Checks previous plugin version and runs upgrade if needed.
@@ -91,49 +130,122 @@
91 130 *
92 131 * @return void
93 132 */
94 133 public function check(): void {
95 - $oldVersion = get_option( 'packetery_version' );
96 - if ( Plugin::VERSION === $oldVersion ) {
134 + $oldVersion = get_option( OptionNames::VERSION );
135 + if ( $oldVersion === Plugin::VERSION ) {
97 136 return;
98 137 }
99 138
139 + $this->runCreateTables();
140 +
100 141 // If no previous version detected, no upgrade will be run.
101 - if ( $oldVersion && version_compare( $oldVersion, '1.2.0', '<' ) ) {
102 - $this->logRepository->createTable();
103 - $logEntries = get_posts(
104 - [
105 - 'post_type' => 'packetery_log',
106 - 'post_status' => 'any',
107 - 'nopaging' => true,
108 - 'fields' => 'ids',
109 - ]
110 - );
111 - foreach ( $logEntries as $logEntryId ) {
112 - wp_delete_post( $logEntryId, true );
142 + if ( $oldVersion !== null && $oldVersion !== false ) {
143 + if ( version_compare( $oldVersion, '1.2.0', '<' ) ) {
144 + $logEntries = get_posts(
145 + [
146 + 'post_type' => 'packetery_log',
147 + 'post_status' => 'any',
148 + 'nopaging' => true,
149 + 'fields' => 'ids',
150 + ]
151 + );
152 + foreach ( $logEntries as $logEntryId ) {
153 + wp_delete_post( $logEntryId, true );
154 + }
155 +
156 + unregister_post_type( 'packetery_log' );
157 +
158 + $this->migrateWpOrderMetadata();
159 + $addressEntries = get_posts(
160 + [
161 + 'post_type' => self::POST_TYPE_VALIDATED_ADDRESS,
162 + 'post_status' => 'any',
163 + 'nopaging' => true,
164 + 'fields' => 'ids',
165 + ]
166 + );
167 + foreach ( $addressEntries as $addressEntryId ) {
168 + wp_delete_post( $addressEntryId, true );
169 + }
170 +
171 + unregister_post_type( self::POST_TYPE_VALIDATED_ADDRESS );
113 172 }
114 173
115 - unregister_post_type( 'packetery_log' );
174 + if ( version_compare( $oldVersion, '1.2.6', '<' ) ) {
175 + $this->orderRepository->deleteOrphans();
176 + }
116 177
117 - $this->migrateWpOrderMetadata();
118 - $addressEntries = get_posts(
119 - [
120 - 'post_type' => self::POST_TYPE_VALIDATED_ADDRESS,
121 - 'post_status' => 'any',
122 - 'nopaging' => true,
123 - 'fields' => 'ids',
124 - ]
125 - );
126 - foreach ( $addressEntries as $addressEntryId ) {
127 - wp_delete_post( $addressEntryId, true );
178 + if ( version_compare( $oldVersion, '1.4.2', '<' ) ) {
179 + $migration = new Version_1_4_2( $this->wpdbAdapter );
180 + $migration->run();
128 181 }
129 182
130 - unregister_post_type( self::POST_TYPE_VALIDATED_ADDRESS );
183 + if ( version_compare( $oldVersion, '1.5', '<' ) ) {
184 + wp_clear_scheduled_hook( CronService::CRON_CARRIERS_HOOK );
185 + }
186 +
187 + if ( version_compare( $oldVersion, '1.6.0', '<' ) ) {
188 + wp_clear_scheduled_hook( CronService::CRON_LOG_AUTO_DELETION_HOOK );
189 + wp_clear_scheduled_hook( CronService::CRON_PACKET_STATUS_SYNC_HOOK );
190 + }
191 +
192 + if ( version_compare( $oldVersion, '1.7.0', '<' ) ) {
193 + $orderStatusAutoChange = $this->optionsProvider->isOrderStatusAutoChangeEnabled();
194 + $autoOrderStatus = $this->optionsProvider->getAutoOrderStatus();
195 + $syncSettings = $this->optionsProvider->getOptionsByName( OptionNames::PACKETERY_SYNC );
196 + if ( $orderStatusAutoChange ) {
197 + $syncSettings['allow_order_status_change'] = true;
198 + }
199 + if ( $autoOrderStatus !== null ) {
200 + $syncSettings['order_status_change_packet_statuses'] = [
201 + Core\Entity\PacketStatus::RECEIVED_DATA => $autoOrderStatus,
202 + ];
203 + }
204 +
205 + update_option( OptionNames::PACKETERY_SYNC, $syncSettings );
206 + }
207 +
208 + if ( version_compare( $oldVersion, '1.7.1', '<' ) ) {
209 + $syncSettings = $this->optionsProvider->getOptionsByName( OptionNames::PACKETERY_SYNC );
210 + if (
211 + isset( $syncSettings['order_status_change_packet_statuses'][ Core\Entity\PacketStatus::RECEIVED_DATA ] ) &&
212 + $syncSettings['order_status_change_packet_statuses'][ Core\Entity\PacketStatus::RECEIVED_DATA ] === ''
213 + ) {
214 + unset( $syncSettings['order_status_change_packet_statuses'][ Core\Entity\PacketStatus::RECEIVED_DATA ] );
215 + update_option( OptionNames::PACKETERY_SYNC, $syncSettings );
216 + }
217 + }
218 +
219 + if ( version_compare( $oldVersion, '1.8.0', '<' ) ) {
220 + $generalSettings = $this->optionsProvider->getOptionsByName( OptionNames::PACKETERY );
221 + if ( isset( $generalSettings['cod_payment_method'] ) ) {
222 + $generalSettings['cod_payment_methods'] = [ $generalSettings['cod_payment_method'] ];
223 + unset( $generalSettings['cod_payment_method'] );
224 + }
225 +
226 + update_option( OptionNames::PACKETERY, $generalSettings );
227 + }
228 +
229 + if ( version_compare( $oldVersion, '2.1.0', '<' ) ) {
230 + add_option( OptionNames::PACKETERY_TUTORIAL_ORDER_DETAIL_EDIT_PACKET, 0 );
231 + add_option( OptionNames::PACKETERY_TUTORIAL_ORDER_GRID_EDIT_PACKET, 0 );
232 + }
233 + } else {
234 + add_option( OptionNames::PACKETERY_TUTORIAL_ORDER_DETAIL_EDIT_PACKET, 1 );
235 + add_option( OptionNames::PACKETERY_TUTORIAL_ORDER_GRID_EDIT_PACKET, 1 );
131 236 }
132 237
133 - update_option( 'packetery_version', Plugin::VERSION );
238 + update_option( OptionNames::VERSION, Plugin::VERSION );
134 239 }
135 240
241 + public function runCreateTables(): void {
242 + $this->createLogTable();
243 + $this->createCarrierTable();
244 + $this->createOrderTable();
245 + $this->createCustomsDeclarationTables();
246 + }
247 +
136 248 /**
137 249 * Migrates WP order metadata.
138 250 *
139 251 * @return void
@@ -138,30 +250,26 @@
138 250 *
139 251 * @return void
140 252 */
141 253 private function migrateWpOrderMetadata(): void {
142 - global $wpdb;
254 + $this->createOrderTable();
143 255
144 - $createResult = $this->orderRepository->createTable();
145 - if ( false === $createResult ) {
146 - $lastError = $wpdb->last_error;
147 - $this->messageManager->flash_message( __( 'orderTableNotCreatedMoreInformationInPacketaLog', 'packetery' ), MessageManager::TYPE_ERROR );
148 -
149 - $record = new Record();
150 - $record->action = Record::ACTION_ORDER_TABLE_NOT_CREATED;
151 - $record->status = Record::STATUS_ERROR;
152 - $record->title = __( 'orderTableNotCreated', 'packetery' );
153 - $record->params = [
154 - 'errorMessage' => $lastError,
155 - ];
156 - $this->logger->add( $record );
157 - }
158 -
159 256 // Did not work when called from plugins_loaded hook.
160 257 $orders = wc_get_orders(
161 258 [
162 - 'packetery_all' => '1',
163 - 'nopaging' => true,
259 + 'nopaging' => true,
260 + // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
261 + 'meta_query' => [
262 + [
263 + 'key' => self::META_CARRIER_ID,
264 + 'compare' => 'EXISTS',
265 + ],
266 + [
267 + 'key' => self::META_CARRIER_ID,
268 + 'compare' => '!=',
269 + 'value' => '',
270 + ],
271 + ],
164 272 ]
165 273 );
166 274
167 275 foreach ( $orders as $order ) {
@@ -166,13 +274,13 @@
166 274
167 275 foreach ( $orders as $order ) {
168 276 $orderEntity = new Core\Entity\Order(
169 277 (string) $order->get_id(),
170 - $this->getMetaAsNullableString( $order, self::META_CARRIER_ID )
278 + $this->carrierEntityRepository->getAnyById( $this->getMetaAsNullableString( $order, self::META_CARRIER_ID ) )
171 279 );
172 280 $order->delete_meta_data( self::META_CARRIER_ID );
173 281
174 - $orderEntity->setWeight( Core\Helper::simplifyWeight( $this->getMetaAsNullableFloat( $order, self::META_WEIGHT ) ) );
282 + $orderEntity->setWeight( $this->getMetaAsNullableFloat( $order, self::META_WEIGHT ) );
175 283 $order->delete_meta_data( self::META_WEIGHT );
176 284
177 285 $orderEntity->setPacketStatus( $this->getMetaAsNullableString( $order, self::META_PACKET_STATUS ) );
178 286 $order->delete_meta_data( self::META_PACKET_STATUS );
@@ -199,12 +307,13 @@
199 307 $order->delete_meta_data( self::META_LENGTH );
200 308 $order->delete_meta_data( self::META_WIDTH );
201 309 $order->delete_meta_data( self::META_HEIGHT );
202 310
203 - if ( null !== $this->getMetaAsNullableString( $order, self::META_POINT_ID ) ) {
311 + if ( $this->getMetaAsNullableString( $order, self::META_POINT_ID ) !== null ) {
204 312 $orderEntity->setPickupPoint(
205 313 new Core\Entity\PickupPoint(
206 314 $this->getMetaAsNullableString( $order, self::META_POINT_ID ),
315 + null,
207 316 $this->getMetaAsNullableString( $order, self::META_POINT_NAME ),
208 317 $this->getMetaAsNullableString( $order, self::META_POINT_CITY ),
209 318 $this->getMetaAsNullableString( $order, self::META_POINT_ZIP ),
210 319 $this->getMetaAsNullableString( $order, self::META_POINT_STREET ),
@@ -219,9 +328,9 @@
219 328 $order->delete_meta_data( self::META_POINT_STREET );
220 329 $order->delete_meta_data( self::META_POINT_URL );
221 330
222 331 $validatedAddressId = $this->getValidatedAddressIdByOrderId( (int) $order->get_id() );
223 - if ( $validatedAddressId ) {
332 + if ( $validatedAddressId !== null ) {
224 333 $validatedAddress = $this->createAddressFromPostId( $validatedAddressId );
225 334 $orderEntity->setAddressValidated( true );
226 335 $orderEntity->setDeliveryAddress( $validatedAddress );
227 336 }
@@ -226,8 +335,9 @@
226 335 $orderEntity->setDeliveryAddress( $validatedAddress );
227 336 }
228 337
229 338 $this->orderRepository->save( $orderEntity );
339 + // Ignore errors. Save the metadata even if the previous call fails.
230 340 $order->save_meta_data();
231 341 }
232 342 }
233 343
@@ -270,9 +380,9 @@
270 380 'post_parent' => $orderId,
271 381 ]
272 382 );
273 383
274 - if ( empty( $postIds ) ) {
384 + if ( count( $postIds ) === 0 ) {
275 385 return null;
276 386 }
277 387
278 388 return (int) array_shift( $postIds );
@@ -287,9 +397,10 @@
287 397 * @return string|null
288 398 */
289 399 private function getMetaAsNullableString( \WC_Order $order, string $key ): ?string {
290 400 $value = $order->get_meta( $key, true );
291 - return ( ( null !== $value && '' !== $value ) ? (string) $value : null );
401 +
402 + return ( ( $value !== null && $value !== '' ) ? (string) $value : null );
292 403 }
293 404
294 405 /**
295 406 * Gets meta property of order as float.
@@ -300,51 +411,81 @@
300 411 * @return float|null
301 412 */
302 413 private function getMetaAsNullableFloat( \WC_Order $order, string $key ): ?float {
303 414 $value = $order->get_meta( $key, true );
304 - return ( ( null !== $value && '' !== $value ) ? (float) $value : null );
415 +
416 + return ( ( $value !== null && $value !== '' ) ? (float) $value : null );
305 417 }
306 418
307 419 /**
308 - * Transforms custom query variable to meta query.
420 + * Creates log table.
309 421 *
310 - * @param array $queryVars Query vars.
311 - * @param array $get Input values.
422 + * @return void
423 + */
424 + private function createLogTable(): void {
425 + if ( $this->logRepository->createOrAlterTable() === false ) {
426 + $this->messageManager->flash_message(
427 + // translators: %s: Short table name.
428 + sprintf( __( 'Database %s table could not be created or altered, more information might be found in WooCommerce logs.', 'packeta' ), 'log' ),
429 + MessageManager::TYPE_ERROR
430 + );
431 + }
432 + }
433 +
434 + /**
435 + * Creates carrier table.
312 436 *
313 - * @return array
437 + * @return void
314 438 */
315 - public function handleCustomQueryVar( array $queryVars, array $get ): array {
316 - $metaQuery = $this->addQueryVars( ( $queryVars['meta_query'] ?? [] ), $get );
317 - if ( $metaQuery ) {
318 - // @codingStandardsIgnoreStart
319 - $queryVars['meta_query'] = $metaQuery;
320 - // @codingStandardsIgnoreEnd
439 + private function createCarrierTable(): void {
440 + if ( $this->carrierRepository->createOrAlterTable() === false ) {
441 + $this->flashAndLog( 'carrier', Record::ACTION_CARRIER_TABLE_NOT_CREATED );
321 442 }
443 + }
322 444
323 - return $queryVars;
445 + /**
446 + * Creates order table.
447 + *
448 + * @return void
449 + */
450 + private function createOrderTable(): void {
451 + if ( $this->orderRepository->createOrAlterTable() === false ) {
452 + $this->flashAndLog( 'order', Record::ACTION_ORDER_TABLE_NOT_CREATED );
453 + }
324 454 }
325 455
326 456 /**
327 - * Adds query vars to fetch order list.
457 + * Creates order table.
328 458 *
329 - * @param array $queryVars Query vars.
330 - * @param array $get Get parameters.
331 - *
332 - * @return array
459 + * @return void
333 460 */
334 - private function addQueryVars( array $queryVars, array $get ): array {
335 - if ( ! empty( $get['packetery_all'] ) ) {
336 - $queryVars[] = [
337 - 'key' => self::META_CARRIER_ID,
338 - 'compare' => 'EXISTS',
339 - ];
340 - $queryVars[] = [
341 - 'key' => self::META_CARRIER_ID,
342 - 'value' => '',
343 - 'compare' => '!=',
344 - ];
461 + private function createCustomsDeclarationTables(): void {
462 + if ( $this->customsDeclarationRepository->createOrAlterTable() === false ) {
463 + $this->flashAndLog( 'customs_declaration', Record::ACTION_CUSTOMS_DECLARATION_TABLE_NOT_CREATED );
345 464 }
346 465
347 - return $queryVars;
466 + if ( $this->customsDeclarationRepository->createOrAlterItemTable() === false ) {
467 + $this->flashAndLog( 'customs_declaration_item', Record::ACTION_CUSTOMS_DECLARATION_ITEM_TABLE_NOT_CREATED );
468 + }
348 469 }
349 470
471 + /**
472 + * Flashes error and logs to Packeta log.
473 + *
474 + * @param string $table Short table name.
475 + * @param string $action Log action.
476 + *
477 + * @return void
478 + */
479 + private function flashAndLog( string $table, string $action ): void {
480 + // translators: %s: Short table name.
481 + $flashMessage = sprintf( __( 'Database %s table of Packeta plugin could not be created or altered, you can find more information in Packeta log.', 'packeta' ), $table );
482 + $this->messageManager->flash_message( $flashMessage, MessageManager::TYPE_ERROR );
483 +
484 + $record = new Record();
485 + $record->action = $action;
486 + $record->status = Record::STATUS_ERROR;
487 + // translators: %s: Short table name.
488 + $record->title = sprintf( __( 'Database %s table could not be created or altered, more information might be found in WooCommerce logs.', 'packeta' ), $table );
489 + $this->logger->add( $record );
490 + }
350 491 }