Copy digital products code into core

Author: duncanmcclean

docs/addons/digital-products.md

@@ -38,7 +38,7 @@ As of v3.1.0, the Digital Products addon supports adding different 'downloadable
 
 By default, we create a serial license key which you can give to your customers. However, you may want to customise where the code comes from or maybe you want to send it away to a third party service.
 
-To do this, you can create your own license key repository which [implements the one provided by this addon](https://github.com/doublethreedigital/sc-digital-products/blob/master/src/Contracts/LicenseKeyRepository.php).
+To do this, you can create your own license key repository which [implements the one provided by this addon](https://github.com/doublethreedigital/simple-commerce/blob/main/src/Contracts/LicenseKeyRepository.php).
 
 To register your repository, you'll need to bind it to our `LicenseKey` facade. You can do this in your `AppServiceProvider`.
 
@@ -53,7 +53,7 @@ If you'd like the Digital Products addon to send your customers an email notific
 ```php
 'notifications' => [
     'digital_download_ready' => [
-        \DoubleThreeDigital\DigitalProducts\Notifications\DigitalDownloadsNotification::class => [
+        \DoubleThreeDigital\SimpleCommerce\Notifications\DigitalDownloadsNotification::class => [
             'to' => 'customer',
         ],
     ],

resources/views/emails/customer_download.blade.php

@@ -0,0 +1,18 @@
+@component('mail::message')
+# Digital Downloads Ready
+
+Your order, **#{{ $order->orderNumber() }}** has some downloadable items. We've provided links to each of the items below.
+
+## Downloads
+
+@component('mail::table')
+| Items       | Download      |
+| :--------- | :------------- |
+@foreach ($order->lineItems() as $lineItem)
+| [{{ $lineItem->product()->get('title') }}]({{ optional($lineItem->product()->resource())->absoluteUrl() }}) | [Download]({{ $lineItem->metadata->get('download_url') }}) |
+@endforeach
+@endcomponent
+
+Thanks,<br>
+{{ config('app.name') }}
+@endcomponent

routes/actions.php

@@ -8,10 +8,12 @@
 use DoubleThreeDigital\SimpleCommerce\Http\Controllers\GatewayCallbackController;
 use DoubleThreeDigital\SimpleCommerce\Http\Controllers\GatewayWebhookController;
 use DoubleThreeDigital\SimpleCommerce\Http\Middleware\EnsureFormParametersArriveIntact;
+use DoubleThreeDigital\SimpleCommerce\Http\Controllers\DigitalProducts\DownloadController;
+use DoubleThreeDigital\SimpleCommerce\Http\Controllers\DigitalProducts\VerificationController;
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken;
 use Illuminate\Support\Facades\Route;
 
-Route::namespace('\DoubleThreeDigital\SimpleCommerce\Http\Controllers\Actions')->name('simple-commerce.')->group(function () {
+Route::name('simple-commerce.')->group(function () {
     Route::get('/cart', [CartController::class, 'index'])->name('cart.index');
     Route::get('/customer/{customer}', [CustomerController::class, 'index'])->name('customer.index');
 
@@ -36,4 +38,9 @@
     Route::post('/gateways/{gateway}/webhook', [GatewayWebhookController::class, 'index'])
         ->name('gateways.webhook')
         ->withoutMiddleware([VerifyCsrfToken::class]);
+
+    Route::prefix('digital-products')->name('digital-products.')->group(function () {
+        Route::get('download/{orderId}/{lineItemId}', DownloadController::class)->name('download');
+        Route::post('verification', VerificationController::class)->name('verification');
+    });
 });

src/Events/GatewayWebhookReceived.php src/Contracts/GatewayWebhookReceived.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Contracts;
+
+/**
+ * @mixin \DoubleThreeDigital\SimpleCommerce\Products\DigitalProducts\LicenseKeyRepository
+ */
+interface LicenseKeyRepository
+{
+    public function generate(): string;
+
+    public static function bindings(): array;
+}

src/Contracts/LicenseKeyRepository.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Events;
+
+use DoubleThreeDigital\SimpleCommerce\Contracts\Order;
+
+class DigitalDownloadReady
+{
+    public function __construct(public Order $order)
+    {
+    }
+}

src/Events/DigitalDownloadReady.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Notifications;
+
+use DoubleThreeDigital\SimpleCommerce\Contracts\Order;
+use Illuminate\Bus\Queueable;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class DigitalDownloadsNotification extends Notification
+{
+    use Queueable;
+
+    protected $order;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order)
+    {
+        $this->order = $order;
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return [
+            'mail',
+        ];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage)
+            ->subject(__(':siteName: Downloads Ready', ['siteName' => config('app.name')]))
+            ->markdown('simple-commerce::emails.customer_download', [
+                'order' => $this->order,
+            ]);
+    }
+}

src/Facades/DigitalDownloadsNotification.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Facades;
+
+use DoubleThreeDigital\SimpleCommerce\Contracts\LicenseKeyRepository;
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @see \DoubleThreeDigital\SimpleCommerce\Products\DigitalProducts\LicenseKeyRepository
+ */
+class LicenseKey extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return LicenseKeyRepository::class;
+    }
+}

src/Facades/LicenseKey.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Http\Controllers\DigitalProducts;
+
+use DoubleThreeDigital\SimpleCommerce\Facades\Order;
+use DoubleThreeDigital\SimpleCommerce\Products\ProductType;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+use Statamic\Assets\Asset;
+use Statamic\Facades\AssetContainer;
+use ZipArchive;
+
+class DownloadController extends Controller
+{
+    public function __invoke(Request $request)
+    {
+        $order = Order::find($request->order_id);
+        $item = $order->lineItems()->firstWhere('id', $request->item_id);
+
+        if (! $item->metadata()->has('license_key') || $item->metadata()->get('license_key') !== $request->get('license_key')) {
+            abort(401);
+        }
+
+        $product = $item->product();
+
+        $zip = new ZipArchive;
+        $zip->open(storage_path("{$order->id()}__{$item->id()}__{$product->id()}.zip"), ZipArchive::CREATE | ZipArchive::OVERWRITE);
+
+        if ($product->purchasableType() === ProductType::Product) {
+            if (! $product->has('downloadable_asset')) {
+                throw new \Exception("Product [{$product->id()}] does not have any digital downloadable assets.");
+            }
+
+            $product->toAugmentedArray()['downloadable_asset']->value()->get()
+                ->each(function (Asset $asset) use ($request, $order, $item, $product, &$zip) {
+                    if ($item->metadata()->has('download_history') && $product->has('download_limit')) {
+                        if (collect($item->metadata()->get('download_history'))->count() >= $product->get('download_limit')) {
+                            abort(405, "You've reached the download limit for this product.");
+                        }
+                    }
+
+                    $order->updateLineItem($item->id(), [
+                        'metadata' => array_merge($item->metadata()->toArray(), [
+                            'download_history' => array_merge([
+                                [
+                                    'timestamp' => now()->timestamp,
+                                    'ip_address' => $request->ip(),
+                                ],
+                            ], $item->metadata()->get('download_history', [])),
+                        ]),
+                    ]);
+
+                    $zip->addFile($asset->resolvedPath(), "{$product->get('slug')}/{$asset->basename()}");
+                });
+        }
+
+        if ($product->purchasableType() === ProductType::Variant) {
+            $productVariant = $product->variant($item->variant()['variant']);
+
+            if (! $productVariant->has('downloadable_asset')) {
+                throw new \Exception("Product [{$product->id()}] does not have any digital downloadable assets.");
+            }
+
+            $productVariantsField = $product->resource()->blueprint()->field('product_variants');
+
+            $downloadableAssetField = collect($productVariantsField->get('option_fields'))
+                ->where('handle', 'downloadable_asset')
+                ->first();
+
+            collect($productVariant->get('downloadable_asset'))
+                ->map(function ($assetPath) use ($downloadableAssetField) {
+                    $assetContainer = isset($downloadableAssetField['field']['container'])
+                        ? AssetContainer::findByHandle($downloadableAssetField['field']['container'])
+                        : AssetContainer::all()->first();
+
+                    return $assetContainer->asset($assetPath);
+                })
+                ->each(function (Asset $asset) use ($request, $order, $item, $product, $productVariant, &$zip) {
+                    if (config('sc-digital-products.download_history')) {
+                        if ($item->metadata()->has('download_history') && $productVariant->has('download_limit') && $product->get('download_limit') !== null) {
+                            if (collect($item->metadata()->get('download_history'))->count() >= $productVariant->get('download_limit')) {
+                                abort(405, "You've reached the download limit for this product.");
+                            }
+                        }
+
+                        $order->updateLineItem($item->id(), [
+                            'metadata' => array_merge($item->metadata()->toArray(), [
+                                'download_history' => array_merge([
+                                    [
+                                        'timestamp' => now()->timestamp,
+                                        'ip_address' => $request->ip(),
+                                    ],
+                                ], $item->metadata()->get('download_history', [])),
+                            ]),
+                        ]);
+                    }
+
+                    $zip->addFile($asset->resolvedPath(), "{$productVariant->key()}/{$asset->basename()}");
+                });
+        }
+
+        $zip->close();
+
+        return response()->download(storage_path("{$order->id()}__{$item->id()}__{$product->id()}.zip"), "{$product->get('slug')}.zip");
+    }
+}

src/Http/Controllers/DigitalProducts/DownloadController.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Http\Controllers\DigitalProducts;
+
+use DoubleThreeDigital\SimpleCommerce\Orders\EloquentOrderRepository;
+use DoubleThreeDigital\SimpleCommerce\Orders\EntryOrderRepository;
+use DoubleThreeDigital\SimpleCommerce\Orders\OrderStatus;
+use DoubleThreeDigital\SimpleCommerce\SimpleCommerce;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+use Statamic\Facades\Entry;
+
+class VerificationController extends Controller
+{
+    public function __invoke(Request $request)
+    {
+        // TODO: refactor controller to use $validated['license_key']
+        $validated = $request->validate([
+            'license_key' => ['required', 'string'],
+        ]);
+
+        // TODO: refactor query
+        if ($this->isOrExtendsClass(SimpleCommerce::orderDriver()['repository'], EntryOrderRepository::class)) {
+            $orderQuery = Entry::query()
+                ->where('collection', SimpleCommerce::orderDriver()['collection'])
+                ->whereIn('order_status', [
+                    OrderStatus::Placed->value,
+                    OrderStatus::Dispatched->value,
+                ])
+                ->where('items->0->metadata->license_key', $request->license_key)
+                ->orWhere('items->1->metadata->license_key', $request->license_key)
+                ->orWhere('items->2->metadata->license_key', $request->license_key)
+                ->orWhere('items->3->metadata->license_key', $request->license_key)
+                ->orWhere('items->4->metadata->license_key', $request->license_key)
+                ->orWhere('items->5->metadata->license_key', $request->license_key)
+                ->orWhere('items->6->metadata->license_key', $request->license_key)
+                ->orWhere('items->7->metadata->license_key', $request->license_key)
+                ->orWhere('items->8->metadata->license_key', $request->license_key)
+                ->orWhere('items->9->metadata->license_key', $request->license_key)
+                ->limit(1)
+                ->get();
+        }
+
+        // TODO: refactor query
+        if ($this->isOrExtendsClass(SimpleCommerce::orderDriver()['repository'], EloquentOrderRepository::class)) {
+            $orderModel = new (SimpleCommerce::orderDriver()['model']);
+
+            $orderQuery = $orderModel::query()
+                ->whereIn('order_status', [
+                    OrderStatus::Placed->value,
+                    OrderStatus::Dispatched->value,
+                ])
+                ->whereRaw("JSON_EXTRACT(items, '$[0].metadata.license_key') = ?", [$request->license_key])
+                ->limit(1)
+                ->get();
+        }
+
+        return $orderQuery->count() > 0
+            ? $this->validResponse($request)
+            : $this->invalidResponse($request);
+    }
+
+    protected function validResponse($request): array
+    {
+        return [
+            'license_key' => $request->license_key,
+            'valid' => true,
+        ];
+    }
+
+    protected function invalidResponse($request): array
+    {
+        return [
+            'license_key' => $request->license_key,
+            'valid' => false,
+        ];
+    }
+
+    protected function isOrExtendsClass(string $class, string $classToCheckAgainst): bool
+    {
+        return is_subclass_of($class, $classToCheckAgainst)
+            || $class === $classToCheckAgainst;
+    }
+}