Abilities
4 weeks ago
AbilitiesApi
7 months ago
AddressProvider
7 months ago
Admin
2 weeks ago
Agentic
7 months ago
Api
4 weeks ago
BatchProcessing
4 weeks ago
CLI
5 months ago
Caches
4 months ago
ComingSoon
9 months ago
CostOfGoodsSold
9 months ago
Customers
9 months ago
DataStores
4 weeks ago
DependencyManagement
5 months ago
Email
4 weeks ago
EmailEditor
4 weeks ago
Features
4 weeks ago
Integrations
7 months ago
Jetpack
5 months ago
Logging
2 months ago
MCP
4 weeks ago
OrderReviews
4 weeks ago
Orders
4 weeks ago
ProductAttributes
4 weeks ago
ProductAttributesLookup
4 weeks ago
ProductDownloads
5 months ago
ProductFeed
2 weeks ago
ProductFilters
4 weeks ago
ProductImage
1 year ago
PushNotifications
4 weeks ago
ReceiptRendering
2 months ago
RestApi
4 weeks ago
Settings
1 year ago
ShopperLists
2 weeks ago
StockNotifications
4 weeks ago
Traits
4 months ago
TransientFiles
4 weeks ago
Utilities
4 weeks ago
VariationGallery
4 weeks ago
WCCom
2 years ago
AssignDefaultCategory.php
1 year ago
Brands.php
11 months ago
DownloadPermissionsAdjuster.php
2 months ago
McStats.php
1 year ago
OrderCouponDataMigrator.php
1 year ago
RegisterHooksInterface.php
1 year ago
RestApiControllerBase.php
1 year ago
RestApiParameterUtil.php
2 years ago
RestockRefundedItemsAdjuster.php
2 months ago
DownloadPermissionsAdjuster.php
196 lines
| 1 | <?php |
| 2 | /** |
| 3 | * DownloadPermissionsAdjuster class file. |
| 4 | */ |
| 5 | |
| 6 | namespace Automattic\WooCommerce\Internal; |
| 7 | |
| 8 | use Automattic\WooCommerce\Proxies\LegacyProxy; |
| 9 | use WC_Product; |
| 10 | |
| 11 | defined( 'ABSPATH' ) || exit; |
| 12 | |
| 13 | /** |
| 14 | * Class to adjust download permissions on product save. |
| 15 | */ |
| 16 | class DownloadPermissionsAdjuster { |
| 17 | |
| 18 | /** |
| 19 | * The downloads data store to use. |
| 20 | * |
| 21 | * @var WC_Data_Store |
| 22 | */ |
| 23 | private $downloads_data_store; |
| 24 | |
| 25 | /** |
| 26 | * Class initialization, to be executed when the class is resolved by the container. |
| 27 | * |
| 28 | * @internal |
| 29 | */ |
| 30 | final public function init() { |
| 31 | $this->downloads_data_store = wc_get_container()->get( LegacyProxy::class )->get_instance_of( \WC_Data_Store::class, 'customer-download' ); |
| 32 | add_action( 'adjust_download_permissions', array( $this, 'adjust_download_permissions' ), 10, 1 ); |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Schedule a download permissions adjustment for a product if necessary. |
| 37 | * This should be executed whenever a product is saved. |
| 38 | * |
| 39 | * @param \WC_Product $product The product to schedule a download permission adjustments for. |
| 40 | */ |
| 41 | public function maybe_schedule_adjust_download_permissions( \WC_Product $product ) { |
| 42 | $children_ids = $product->get_children(); |
| 43 | if ( ! $children_ids ) { |
| 44 | return; |
| 45 | } |
| 46 | |
| 47 | _prime_post_caches( $children_ids ); |
| 48 | |
| 49 | $are_any_children_downloadable = false; |
| 50 | foreach ( $children_ids as $child_id ) { |
| 51 | $child = wc_get_product( $child_id ); |
| 52 | if ( $child && $child->is_downloadable() ) { |
| 53 | $are_any_children_downloadable = true; |
| 54 | break; |
| 55 | } |
| 56 | } |
| 57 | |
| 58 | if ( ! $product->is_downloadable() && ! $are_any_children_downloadable ) { |
| 59 | return; |
| 60 | } |
| 61 | |
| 62 | $scheduled_action_args = array( $product->get_id() ); |
| 63 | |
| 64 | $already_scheduled_actions = |
| 65 | WC()->call_function( |
| 66 | 'as_get_scheduled_actions', |
| 67 | array( |
| 68 | 'hook' => 'adjust_download_permissions', |
| 69 | 'args' => $scheduled_action_args, |
| 70 | 'status' => \ActionScheduler_Store::STATUS_PENDING, |
| 71 | ), |
| 72 | 'ids' |
| 73 | ); |
| 74 | |
| 75 | if ( empty( $already_scheduled_actions ) ) { |
| 76 | WC()->call_function( |
| 77 | 'as_schedule_single_action', |
| 78 | WC()->call_function( 'time' ) + 1, |
| 79 | 'adjust_download_permissions', |
| 80 | $scheduled_action_args |
| 81 | ); |
| 82 | } |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Create additional download permissions for variations if necessary. |
| 87 | * |
| 88 | * When a simple downloadable product is converted to a variable product, |
| 89 | * existing download permissions are still present in the database but they don't apply anymore. |
| 90 | * This method creates additional download permissions for the variations based on |
| 91 | * the old existing ones for the main product. |
| 92 | * |
| 93 | * The procedure is as follows. For each existing download permission for the parent product, |
| 94 | * check if there's any variation offering the same file for download (the file URL, not name, is checked). |
| 95 | * If that is found, check if an equivalent permission exists (equivalent means for the same file and with |
| 96 | * the same order id and customer id). If no equivalent permission exists, create it. |
| 97 | * |
| 98 | * @param int $product_id The id of the product to check permissions for. |
| 99 | */ |
| 100 | public function adjust_download_permissions( int $product_id ) { |
| 101 | $product = wc_get_product( $product_id ); |
| 102 | if ( ! $product ) { |
| 103 | return; |
| 104 | } |
| 105 | |
| 106 | $children_ids = $product->get_children(); |
| 107 | if ( ! $children_ids ) { |
| 108 | return; |
| 109 | } |
| 110 | |
| 111 | $parent_downloads = $this->get_download_files_and_permissions( $product ); |
| 112 | if ( ! $parent_downloads ) { |
| 113 | return; |
| 114 | } |
| 115 | |
| 116 | _prime_post_caches( $children_ids ); |
| 117 | |
| 118 | $children_with_downloads = array(); |
| 119 | foreach ( $children_ids as $child_id ) { |
| 120 | $child = wc_get_product( $child_id ); |
| 121 | |
| 122 | // Ensure we have a valid child product. |
| 123 | if ( ! $child instanceof WC_Product ) { |
| 124 | wc_get_logger()->warning( |
| 125 | sprintf( |
| 126 | /* translators: 1: child product ID 2: parent product ID. */ |
| 127 | __( 'Unable to load child product %1$d while adjusting download permissions for product %2$d.', 'woocommerce' ), |
| 128 | $child_id, |
| 129 | $product_id |
| 130 | ) |
| 131 | ); |
| 132 | continue; |
| 133 | } |
| 134 | |
| 135 | $children_with_downloads[ $child_id ] = $this->get_download_files_and_permissions( $child ); |
| 136 | } |
| 137 | |
| 138 | foreach ( $parent_downloads['permission_data_by_file_order_user'] as $parent_file_order_and_user => $parent_download_data ) { |
| 139 | foreach ( $children_with_downloads as $child_id => $child_download_data ) { |
| 140 | $file_url = $parent_download_data['file']; |
| 141 | |
| 142 | $must_create_permission = |
| 143 | // The variation offers the same file as the parent for download... |
| 144 | in_array( $file_url, array_keys( $child_download_data['download_ids_by_file_url'] ), true ) && |
| 145 | // ...but no equivalent download permission (same file URL, order id and user id) exists. |
| 146 | ! array_key_exists( $parent_file_order_and_user, $child_download_data['permission_data_by_file_order_user'] ); |
| 147 | |
| 148 | if ( $must_create_permission ) { |
| 149 | // The new child download permission is a copy of the parent's, |
| 150 | // but with the product and download ids changed to match those of the variation. |
| 151 | $new_download_data = $parent_download_data['data']; |
| 152 | $new_download_data['product_id'] = $child_id; |
| 153 | $new_download_data['download_id'] = $child_download_data['download_ids_by_file_url'][ $file_url ]; |
| 154 | $this->downloads_data_store->create_from_data( $new_download_data ); |
| 155 | } |
| 156 | } |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Get the existing downloadable files and download permissions for a given product. |
| 162 | * The returned value is an array with two keys: |
| 163 | * |
| 164 | * - download_ids_by_file_url: an associative array of file url => download_id. |
| 165 | * - permission_data_by_file_order_user: an associative array where key is "file_url:customer_id:order_id" and value is the full permission data set. |
| 166 | * |
| 167 | * @param \WC_Product $product The product to get the downloadable files and permissions for. |
| 168 | * @return array[] Information about the downloadable files and permissions for the product. |
| 169 | */ |
| 170 | private function get_download_files_and_permissions( \WC_Product $product ) { |
| 171 | $result = array( |
| 172 | 'permission_data_by_file_order_user' => array(), |
| 173 | 'download_ids_by_file_url' => array(), |
| 174 | ); |
| 175 | $downloads = $product->get_downloads(); |
| 176 | foreach ( $downloads as $download ) { |
| 177 | $result['download_ids_by_file_url'][ $download->get_file() ] = $download->get_id(); |
| 178 | } |
| 179 | |
| 180 | $permissions = $this->downloads_data_store->get_downloads( array( 'product_id' => $product->get_id() ) ); |
| 181 | foreach ( $permissions as $permission ) { |
| 182 | $permission_data = (array) $permission->data; |
| 183 | if ( array_key_exists( $permission_data['download_id'], $downloads ) ) { |
| 184 | $file = $downloads[ $permission_data['download_id'] ]->get_file(); |
| 185 | $data = array( |
| 186 | 'file' => $file, |
| 187 | 'data' => (array) $permission->data, |
| 188 | ); |
| 189 | $result['permission_data_by_file_order_user'][ "{$file}:{$permission_data['user_id']}:{$permission_data['order_id']}" ] = $data; |
| 190 | } |
| 191 | } |
| 192 | |
| 193 | return $result; |
| 194 | } |
| 195 | } |
| 196 |