osu-web / app / Models / Store / Order.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace App\Models\Store;

use App\Exceptions\InvariantException;
use App\Exceptions\ModelNotSavedException;
use App\Exceptions\OrderNotModifiableException;
use App\Models\Country;
use App\Models\User;
use Carbon\Carbon;
use DB;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * Represents a Store Order.
 *
 * Order states:
 * - cancelled -> Order is cancelled.
 * - incart -> Order is a cart and items can be modified. This is the only state which should allow items to be modified.
 * - processing -> The checkout process for this Order has started.
 * - checkout -> User-side of the payment approval process is complete; awaiting confirmation from payment processor.
 * - paid -> Payment confirmed by payment processor.
 * - shipped -> Physical order dispatched; not available in all cases.
 * - delivered -> If we receive confirmation that the order was delivered; not available in all cases.
 *
 * @property Address $address
 * @property int|null $address_id
 * @property Carbon $created_at
 * @property Carbon|null $deleted_at
 * @property Collection<OrderItem> $items
 * @property string|null $last_tracking_state
 * @property int $order_id
 * @property string|null $provider
 * @property Carbon|null $paid_at
 * @property Collection<Payment> $payments
 * @property string|null $reference For paypal transactions, this is the resource Id of the paypal order; otherwise, it is the same as the transaction_id without the prefix.
 * @property Carbon|null $shipped_at
 * @property float|null $shipping
 * @property mixed $status
 * @property string|null $tracking_code
 * @property string|null $transaction_id For paypal transactions, this value is based on the IPN or captured payment Id, not the order resource id.
 * @property Carbon|null $updated_at
 * @property User $user
 * @property int $user_id
 */
class Order extends Model
{
    use SoftDeletes;

    const ECHECK_CLEARED = 'ECHECK CLEARED';
    const ECHECK_DENIED = 'ECHECK DENIED';
    const ORDER_NUMBER_REGEX = '/^(?<prefix>[A-Za-z]+)-(?<userId>\d+)-(?<orderId>\d+)$/';
    const PENDING_ECHECK = 'PENDING ECHECK';

    const PROVIDER_FREE = 'free';
    const PROVIDER_PAYPAL = 'paypal';
    const PROVIDER_SHOPIFY = 'shopify';
    const PROVIDER_XSOLLA = 'xsolla';

    const STATUS_CANCELLED = 'cancelled';
    const STATUS_DELIVERED = 'delivered';
    const STATUS_INCART = 'incart';
    const STATUS_PAID = 'paid';
    const STATUS_PAYMENT_APPROVED = 'checkout';
    const STATUS_PAYMENT_REQUESTED = 'processing';
    const STATUS_SHIPPED = 'shipped';

    const STATUS_CAN_CHECKOUT = [self::STATUS_INCART, self::STATUS_PAYMENT_REQUESTED];

    const STATUS_HAS_INVOICE = [
        self::STATUS_CANCELLED,
        self::STATUS_DELIVERED,
        self::STATUS_PAID,
        self::STATUS_PAYMENT_APPROVED,
        self::STATUS_PAYMENT_REQUESTED,
        self::STATUS_SHIPPED,
    ];

    protected $primaryKey = 'order_id';

    protected $casts = [
        'deleted_at' => 'datetime',
        'paid_at' => 'datetime',
        'shipped_at' => 'datetime',
        'shipping' => 'float',
    ];

    protected array $macros = ['itemsQuantities'];

    protected static function splitTransactionId($value)
    {
        return explode('-', $value, 2);
    }

    public static function pendingForUser(?User $user): ?Builder
    {
        if ($user === null) {
            return null;
        }

        return static::where('user_id', $user->getKey())->paymentRequested();
    }

    public function items()
    {
        return $this->hasMany(OrderItem::class);
    }

    public function address()
    {
        return $this->belongsTo(Address::class, 'address_id');
    }

    public function payments()
    {
        return $this->hasMany(Payment::class);
    }

    public function user()
    {
        return $this->belongsTo(User::class, 'user_id');
    }

    public function scopeWhereCanCheckout($query)
    {
        return $query->whereIn('status', [static::STATUS_INCART, static::STATUS_PAYMENT_REQUESTED]);
    }

    public function scopeInCart($query)
    {
        return $query->where('status', static::STATUS_INCART);
    }

    public function scopePaymentRequested($query)
    {
        return $query->where('status', static::STATUS_PAYMENT_REQUESTED);
    }

    public function scopeStale($query)
    {
        return $query->where('updated_at', '<', Carbon::now()->subDays($GLOBALS['cfg']['store']['order']['stale_days']));
    }

    public function scopeWhereHasInvoice($query)
    {
        return $query->whereIn('status', static::STATUS_HAS_INVOICE);
    }

    public function scopeWhereOrderNumber($query, ?string $orderNumber)
    {
        if (
            $orderNumber === null
            || !preg_match(static::ORDER_NUMBER_REGEX, $orderNumber, $matches)
            || $GLOBALS['cfg']['store']['order']['prefix'] !== $matches['prefix']
        ) {
            return $query->none();
        }

        $userId = (int) $matches['userId'];
        $orderId = (int) $matches['orderId'];

        return $query->where([
            'order_id' => $orderId,
            'user_id' => $userId,
        ]);
    }

    public function scopeWherePaymentTransactionId($query, $transactionId, $provider)
    {
        return $query
            ->whereIn('order_id', Payment::select('order_id')
                ->where('provider', $provider)
                ->where('transaction_id', $transactionId)
                ->where('cancelled', false));
    }

    public function scopeWithPayments($query)
    {
        return $query->with('payments');
    }

    public function trackingCodes()
    {
        $codes = [];
        preg_match_all('/([A-Z]{2}[A-Z0-9]{9,11})/', $this->tracking_code, $codes);

        return $codes[0];
    }

    public function getItemCount()
    {
        $total = 0;
        foreach ($this->items as $i) {
            $total += $i->quantity;
        }

        return $total;
    }

    public function getOrderName()
    {
        return "osu!store order #{$this->order_id}";
    }

    public function getOrderNumber()
    {
        return $GLOBALS['cfg']['store']['order']['prefix']."-{$this->user_id}-{$this->order_id}";
    }

    public function getPaymentProvider()
    {
        if (!present($this->transaction_id)) {
            return;
        }

        return static::splitTransactionId($this->transaction_id)[0];
    }

    /**
     * Payment status that appears on the invoice.
     *
     * @return string
     */
    public function getPaymentStatusText()
    {
        switch ($this->status) {
            case static::STATUS_CANCELLED:
                return 'Cancelled';
            case static::STATUS_PAYMENT_REQUESTED:
            case static::STATUS_PAYMENT_APPROVED:
                return 'Confirmation Pending';
            case static::STATUS_INCART:
                return '';
            case static::STATUS_PAID:
            case static::STATUS_SHIPPED:
            case static::STATUS_DELIVERED:
                return 'Paid';
            default:
                return 'Unknown';
        }
    }

    /**
     * Returns the reference id for the provider associated with this Order.
     *
     * For Paypal transactions, this is "paypal-{$capturedId}" where $capturedId is the IPN txn_id
     * or captured Id of the payment item in the payment transaction (not the payment itself).
     *
     * For other payment providers, this value should be "{$provider}-{$reference}".
     *
     * In the case of failed or user-aborted payments, this should be "{$provider}-failed".
     *
     * @return string|null
     */
    public function getProviderReference(): ?string
    {
        if (!present($this->transaction_id)) {
            return null;
        }

        return static::splitTransactionId($this->transaction_id)[1] ?? null;
    }

    public function getSubtotal()
    {
        $total = 0;
        foreach ($this->items as $i) {
            $total += $i->subtotal();
        }

        return (float) $total;
    }

    public function setTransactionIdAttribute($value)
    {
        // TODO: migrate to always using provider and reference instead of transaction_id.
        $this->attributes['transaction_id'] = $value;

        $split = static::splitTransactionId($value);
        $this->provider = $split[0] ?? null;

        $reference = $split[1] ?? null;
        // For Paypal we're going to use the PAYID number for reference instead of the IPN txn_id
        if ($this->provider !== static::PROVIDER_PAYPAL && $reference !== 'failed') {
            $this->reference = $reference;
        }
    }

    public function requiresShipping()
    {
        foreach ($this->items as $i) {
            if ($i->product->requiresShipping()) {
                return true;
            }
        }

        return false;
    }

    /**
     * Gets the cost of shipping ignoring whether shipping is required or not.
     * Returns 0 if shipping is not required.
     *
     * @return float Shipping cost.
     */
    private function getShipping()
    {
        if (!$this->address) {
            return 0.0;
        }

        $rate = $this->address->shippingRate();

        $total = 0;

        $primaryShipping = 0;
        $nextShipping = 0;

        //first find the highest shipping cost, and use that as a base
        foreach ($this->items as $i) {
            if ($i->product->base_shipping > $primaryShipping) {
                $primaryShipping = $i->product->base_shipping;
            }
        }

        //then add up the total
        foreach ($this->items as $i) {
            if ($primaryShipping === $i->product->base_shipping) {
                $total += $i->product->base_shipping * 1 + ($i->quantity - 1) * $i->product->next_shipping;
            } else {
                $total += $i->quantity * $i->product->next_shipping;
            }
        }

        return (float) $total * $rate;
    }

    public function getTotal()
    {
        return $this->getSubtotal() + $this->shipping;
    }

    public function guardNotModifiable(callable $callable)
    {
        return $this->getConnection()->transaction(function () use ($callable) {
            $locked = $this->exists ? $this->lockSelf() : $this;
            if ($locked->isModifiable() === false) {
                throw new OrderNotModifiableException($locked);
            }

            return $callable();
        });
    }

    public function canCheckout(): bool
    {
        return in_array($this->status, static::STATUS_CAN_CHECKOUT, true);
    }

    public function canUserCancel(): bool
    {
        return $this->status === static::STATUS_PAYMENT_REQUESTED;
    }

    public function containsSupporterTag(): bool
    {
        return $this->items->contains(fn (OrderItem $item) => $item->product->custom_class === Product::SUPPORTER_TAG_NAME);
    }

    public function hasInvoice(): bool
    {
        return in_array($this->status, static::STATUS_HAS_INVOICE, true);
    }

    public function isCancelled(): bool
    {
        return $this->status === static::STATUS_CANCELLED;
    }

    public function isCart(): bool
    {
        return $this->status === static::STATUS_INCART;
    }

    public function isDelivered(): bool
    {
        return $this->status === static::STATUS_DELIVERED;
    }

    public function isEmpty(): bool
    {
        return !$this->items()->exists();
    }

    public function isHideSupporterFromActivity(): bool
    {
        // Consider all supporter tags should be hidden from activity if any one of them is marked to be hidden.
        // This also skips needing to perform a product lookup.
        foreach ($this->items as $item) {
            $extraData = $item->extra_data;
            if ($extraData instanceof ExtraDataSupporterTag && $extraData->hidden) {
                return true;
            }
        }

        return false;
    }

    public function isModifiable(): bool
    {
        // new cart is status = null
        return in_array($this->status, [static::STATUS_INCART, null], true);
    }

    public function isPendingPaymentCapture(): bool
    {
        return in_array($this->status, [static::STATUS_PAYMENT_REQUESTED, static::STATUS_PAYMENT_APPROVED], true);
    }

    public function isPaymentRequested(): bool
    {
        return $this->status === static::STATUS_PAYMENT_REQUESTED;
    }

    public function isPaid(): bool
    {
        return $this->status === static::STATUS_PAID;
    }

    public function isPaidOrDelivered(): bool
    {
        return in_array($this->status, [static::STATUS_PAID, static::STATUS_DELIVERED], true);
    }

    public function isShipped(): bool
    {
        return $this->status === static::STATUS_SHIPPED;
    }

    public function isShopify(): bool
    {
        return $this->getPaymentProvider() === static::PROVIDER_SHOPIFY;
    }

    public function isShouldShopify(): bool
    {
        foreach ($this->items as $item) {
            if ($item->product->shopify_id !== null) {
                return true;
            }
        }

        return false;
    }

    /**
     * Updates the cost of the order for checkout.
     * Don't call this anywhere except beginning checkout.
     * Do not call it once the payment process has stated.
     *
     * @return void
     */
    public function refreshCost()
    {
        foreach ($this->items as $i) {
            $i->refreshCost();
            $i->saveOrExplode(['skipValidations' => true]);
        }

        if ($this->requiresShipping()) {
            $this->shipping = $this->getShipping();
        } else {
            $this->shipping = null;
        }

        $this->saveOrExplode();
    }

    public function setGiftsHidden(bool $hide = true)
    {
        // batch update query not used as it will override extra_data contents.
        $this->getConnection()->transaction(function () use ($hide) {
            foreach ($this->items as $item) {
                $extraData = $item->extra_data;
                if ($extraData instanceof ExtraDataSupporterTag) {
                    $extraData->hidden = $hide;
                    $item->saveOrExplode();
                }
            }
        });
    }

    #region public functions for updating cart state

    /**
     * Marks the Order as cancelled. Does not do anything if already cancelled.
     *
     * @param User|null $user The User requesting to cancel the order, null for system.
     * @return void
     */
    public function cancel(?User $user = null)
    {
        if ($this->isCancelled()) {
            return;
        }

        // TODO: Payment processors should set a context variable flagging the user check to be skipped.
        // This is currently only fine because the Orders controller requires auth.
        if ($user !== null && $this->user_id === $user->getKey() && !$this->canUserCancel()) {
            throw new InvariantException(osu_trans('store.order.cancel_not_allowed'));
        }

        $this->status = Order::STATUS_CANCELLED;
        $this->saveOrExplode();
    }

    public function delete()
    {
        $this->guardNotModifiable(function () {
            parent::delete();
        });
    }

    public function paid(?Payment $payment)
    {
        if ($this->tracking_code === Order::PENDING_ECHECK) {
            $this->tracking_code = Order::ECHECK_CLEARED;
        }

        // TODO: use a no payment object instead?
        if ($payment !== null) {
            if (!$this->payments()->save($payment)) {
                throw new ModelNotSavedException('failed saving model');
            }

            // Duplicate to existing fields.
            // Useful for checking store-related issues with a single table.
            $this->transaction_id = $payment->getOrderTransactionId();
            $this->paid_at = $payment->paid_at;
        } else {
            $this->paid_at = Carbon::now();
        }

        $this->status = $this->requiresShipping() ? static::STATUS_PAID : static::STATUS_DELIVERED;
        $this->saveOrExplode();
    }

    #endregion

    #region public functions for updating cart quantities

    /**
     * Updates the Order with form parameters.
     *
     * Updates the Order with with an item extracted from submitted form parameters.
     * The function returns null on success; an error message, otherwise.
     *
     * @param array $itemForm form parameters.
     * @param bool $addToExisting whether the quantity should be added or replaced.
     * @return string|null null on success; error message, otherwise.
     **/
    public function updateItem(array $itemForm, $addToExisting = false)
    {
        return $this->guardNotModifiable(function () use ($itemForm, $addToExisting) {
            [$params, $product] = static::orderItemParams($itemForm);

            // done first to allow removing of disabled products from cart.
            if ($params['quantity'] <= 0) {
                return $this->removeOrderItem($params);
            }

            // TODO: better validation handling.
            if ($product === null) {
                return osu_trans('model_validation/store/product.not_available');
            }

            $this->saveOrExplode();

            if ($product->allow_multiple) {
                $item = $this->newOrderItem($params, $product);
            } else {
                $item = $this->updateOrderItem($params, $product, $addToExisting);
            }

            $item->saveOrExplode();
        });
    }

    public function releaseItems()
    {
        // locking bottleneck
        $this->getConnection()->transaction(function () {
            $items = $this->lockForReserve();

            $items->each->releaseProduct();
        });
    }

    public function reserveItems()
    {
        // locking bottleneck
        $this->getConnection()->transaction(function () {
            $items = $this->lockForReserve();
            $items->each->reserveProduct();
        });
    }

    public function switchItems($orderItem, $newProduct)
    {
        $this->getConnection()->transaction(function () use ($orderItem, $newProduct) {
            $this->lockForReserve([$orderItem->product_id, $newProduct->product_id]);

            $quantity = $orderItem->quantity;
            $orderItem->releaseProduct();
            $orderItem->product()->associate($newProduct);
            $orderItem->reserveProduct();

            $orderItem->saveOrExplode();
        });
    }

    #endregion

    public static function cart($user)
    {
        return static::query()
            ->where('user_id', $user->user_id)
            ->inCart()
            ->with('items.product')
            ->first();
    }

    public function macroItemsQuantities(): \Closure
    {
        return function ($query) {
            $query = clone $query;

            $order = new self();
            $orderItem = new OrderItem();
            $product = new Product();

            $query
                ->join(
                    $orderItem->getTable(),
                    $order->qualifyColumn('order_id'),
                    '=',
                    $orderItem->qualifyColumn('order_id')
                )
                ->join(
                    $product->getTable(),
                    $orderItem->qualifyColumn('product_id'),
                    '=',
                    $product->qualifyColumn('product_id')
                )
                ->whereNotNull($product->qualifyColumn('weight'))
                ->groupBy($orderItem->qualifyColumn('product_id'))
                ->groupBy($product->qualifyColumn('name'))
                ->select(
                    DB::raw("SUM({$orderItem->qualifyColumn('quantity')}) AS quantity"),
                    $product->qualifyColumn('name'),
                    $orderItem->qualifyColumn('product_id')
                );

            return $query->get();
        };
    }

    private function lockForReserve(array $productIds = null)
    {
        $query = $this->items()->with('product')->lockForUpdate();
        if ($productIds) {
            $query->whereIn('product_id', $productIds);
        }

        $items = $query->get();
        $productIds = array_pluck($items, 'product_id');
        Product::lockForUpdate()->whereIn('product_id', $productIds)->get();

        return $items;
    }

    private function removeOrderItem(array $params)
    {
        optional($this->items()->find($params['id']))->delete();
    }

    private function newOrderItem(array $params, Product $product)
    {
        // FIXME: custom class stuff should probably not go in Order...
        switch ($product->custom_class) {
            case Product::SUPPORTER_TAG_NAME:
                $params['cost'] ??= 0;
                $params['extra_data'] = ExtraDataSupporterTag::fromOrderItemParams($params, $this->user);
                break;
            // TODO: look at migrating to extra_data
            case Product::USERNAME_CHANGE:
                // ignore received cost
                $params['cost'] = $this->user->usernameChangeCost();
                break;
            case 'cwc-supporter':
            case 'mwc4-supporter':
            case 'mwc7-supporter':
            case 'owc-supporter':
            case 'twc-supporter':
                $params['extra_data'] = $this->extraDataTournamentBanner($params, $product);
                $params['cost'] = $product->cost ?? 0;
                break;
            case Product::REDIRECT_PLACEHOLDER:
                throw new InvariantException("Product can't be ordered");
            default:
                $params['cost'] = $product->cost ?? 0;
        }

        $item = $this->items()->make([
            'quantity' => $params['quantity'],
            'extra_info' => $params['extra_info'],
            'extra_data' => $params['extra_data'],
            'cost' => $params['cost'],
            'product_id' => $product->getKey(),
        ]);

        $item->setRelation('product', $product);

        return $item;
    }

    private function updateOrderItem(array $params, Product $product, $addToExisting = false)
    {
        $item = $this->items()->where('product_id', $product->product_id)->get()->first();
        if ($item === null) {
            return $this->newOrderItem($params, $product);
        }

        if ($addToExisting) {
            $item->quantity += $params['quantity'];
        } else {
            $item->quantity = $params['quantity'];
        }

        return $item;
    }

    // TODO: maybe move to class later?
    private function extraDataTournamentBanner(array $orderItemParams, Product $product)
    {
        $params = get_params($orderItemParams, 'extra_data', [
            'tournament_id:int',
        ]);

        // much dodgy. wow.
        $matches = [];
        preg_match('/.+\((?<country>.+)\)$/', $product->name, $matches);
        $params['cc'] = Country::where('name', $matches['country'])->first()->acronym;

        return new ExtraDataTournamentBanner($params);
    }

    private static function orderItemParams(array $form)
    {
        $params = get_params($form, null, [
            'id:int',
            'cost:int',
            'extra_data:array',
            'extra_info',
            'product_id:int',
            'quantity:int',
        ], ['null_missing' => true]);

        $product = Product::enabled()->find($params['product_id']);

        unset($params['product_id']);

        return [$params, $product];
    }
}