<?php

namespace App\Models;

use Awobaz\Compoships\Compoships;
use Illuminate\Container\Container;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Str;
use Leenooks\Traits\ScopeActive;

use App\Http\Controllers\AccountingController;
use App\Interfaces\{IDs,ProductItem};
use App\Traits\{ProductDetails,ProviderRef,SiteID};

/**
 * Class Product
 * Products that are available to sale, and appear on invoices.
 *
 * Products have one Type (Product/*), made of an Offering (Supplier/*) from a Supplier.
 * Conversely, Suppliers provide Offerings (Supplier/*) which belong to a Type (Product/*) of a Product.
 *
 * So each product attribute has:
 * + supplied				: Supplier product provided for this offering (Supplier/*)
 * + type					: Returns the underlying product object, representing the type of product (Product/*)
 *
 * Attributes for products:
 * + lid                    : Local ID for product (part number)
 * + sid                    : System ID for product (part number)
 * + base_charge			: Default billing amount
 * + billing_interval		: Default Billing Interval
 * + billing_interval_string: Default Billing Interval in human-readable form
 * + category				: Type of product supplied
 * + category_name			: Type of product supplied (Friendly Name for display, not for internal logic)
 * + description			: Product description (description.description_full => description_full)
 * + min_charge				: Minimum charge taking into account billing interval and setup charges
 * + name					: Details of our product (description.description_short => name_detail)
 * + pid					: Product ID for our Product (description.name => name_short)
 * + setup_charge			: Charge to setup this product
 * + supplier				: Supplier for this offering
 *
 * Attributes for product types (type - Product/*)
 * + name					: Short Name for our Product
 * + name_long				: Long Name for our Product
 * + description			: Description of offering (Broadband=speed)
 *
 * Attributes for supplier's offerings (type->supplied - Supplier/*)
 * + name					: Short Name for suppliers offering
 * + name_long				: Long Name for suppliers offering
 * + description			: Description of offering (Broadband=speed)
 *
 * Product Pricing self::pricing is an array of:
 * [
 *   timeperiod => [
 *                    show => true|false (show this time period to the user for ordering)
 *                    group => [ pricing/setup ]
 *                 ]
 * ]
 *
 * @package App\Models
 */
class Product extends Model implements IDs
{
	use Compoships,HasFactory,SiteID,ProductDetails,ScopeActive,ProviderRef;

	protected $casts = [
		'pricing'=>'collection',
	];

	/* STATIC */

	/**
	 * Return a list of available product types
	 *
	 * @return Collection
	 */
	public static function availableTypes(): Collection
	{
		$models = collect(File::allFiles(app_path()))
			->map(function ($item) {
				$path = $item->getRelativePathName();
				$class = sprintf('%s%s',
					Container::getInstance()->getNamespace(),
					strtr(substr($path, 0, strrpos($path, '.')), '/', '\\'));

				return $class;
			})
			->filter(function ($class) {
				$valid = FALSE;

				if (class_exists($class)) {
					$reflection = new \ReflectionClass($class);
					$valid = $reflection->isSubclassOf(ProductItem::class) && (! $reflection->isAbstract());
				}

				return $valid;
			});

		return $models->values();
	}

	/* RELATIONS */

	public function providers()
	{
		return $this->belongsToMany(ProviderOauth::class,'product__provider')
			->where('product__provider.site_id',$this->site_id)
			->withPivot('ref');
	}

	/**
	 * Which services are configured with this product
	 *
	 * @return \Illuminate\Database\Eloquent\Relations\HasMany
	 */
	public function services()
	{
		return $this->hasMany(Service::class);
	}

	/**
	 * Get the product name in the users language, and if the user isnt logged in, the sites language
	 *
	 * @return \Illuminate\Database\Eloquent\Relations\HasOne
	 */
	public function translate()
	{
		return $this->hasOne(ProductTranslate::class)
			->where('language_id',(Auth::user() && Auth::user()->language_id)
					? Auth::user()->language_id
					: config('site')->language_id);
	}

	/**
	 * Return a child model with details of the service
	 * This will return a product/* model.
	 *
	 * @return \Illuminate\Database\Eloquent\Relations\MorphTo
	 */
	public function type()
	{
		return $this->morphTo(null,'model','model_id');
	}

	/* INTERFACES */

	public function getLIDAttribute(): string
	{
		return sprintf('%04s',$this->id);
	}

	public function getSIDAttribute(): string
	{
		return sprintf('%02s-%s',$this->site_id,$this->getLIDattribute());
	}

	/* ATTRIBUTES */

	/**
	 * The amount we invoice each time period for this service
	 *
	 * @param int|NULL $timeperiod
	 * @param Group|NULL $go
	 * @return float
	 */
	public function getBaseChargeAttribute(int $timeperiod=NULL,Group $go=NULL): float
	{
		return $this->_charge('base',$timeperiod,$go);
	}

	/**
	 * The base cost of this product at the appropriate billing interval
	 *
	 * @return float
	 */
	public function getBaseCostAttribute(): float
	{
		return round($this->supplied->base_cost,2)*Invoice::billing_change($this->type->billing_interval,$this->billing_interval) ?: 0;
	}

	/**
	 * Our default billing interval
	 * Its the max of what we define, or what the supplier bills us at
	 *
	 * @return int
	 */
	public function getBillingIntervalAttribute(): int
	{
		return max($this->price_recur_default,$this->type->billing_interval);
	}

	/**
	 * This will return the category of the product (eg: domain, webhosting, etc) which is the basis for all
	 * other logic of these types.
	 *
	 * @return string
	 */
	public function getCategoryAttribute(): string
	{
		return strtolower(Str::studly($this->category_name));
	}

	/**
	 * Return the type of service is provided. eg: Broadband, Phone.
	 * This will return the category of the product (eg: domain, hosting, etc) which is the basis for all
	 * other logic of these types.
	 *
	 * @return string
	 */
	public function getCategoryNameAttribute(): string
	{
		return $this->supplied->category_name;
	}

	/**
	 * How long must this product be purchased for as a service.
	 *
	 * @return int
	 */
	public function getContractTermAttribute(): int
	{
		return $this->type->contract_term;
	}

	/**
	 * This product full description
	 *
	 * @return string
	 */
	public function getDescriptionAttribute(): string
	{
		return $this->translate->description;
	}

	/**
	 * Get the minimum charge for this product
	 *
	 * @param int|null $timeperiod
	 * @param Group|null $go
	 * @return float
	 */
	public function getMinChargeAttribute(int $timeperiod=NULL,Group $go=NULL): float
	{
		return $this->getSetupChargeAttribute($timeperiod,$go)
			+ $this->getBaseChargeAttribute($timeperiod,$go)*Invoice::billing_change($this->billing_interval,$this->type->billing_interval)*$this->type->contract_term;
	}

	/**
	 * Get the minimum cost for this product
	 *
	 * @return float
	 */
	public function getMinCostAttribute(): float
	{
		return $this->supplied->min_cost;
	}

	/**
	 * Our products short descriptive name
	 *
	 * @return string
	 */
	public function getNameAttribute(): string
	{
		return $this->translate->name_detail;
	}

	/**
	 * Our products PID
	 *
	 * @return string
	 */
	public function getPIDAttribute(): string
	{
		return $this->translate->name_short;
	}

	/**
	 * Suppliers product
	 *
	 * @return Model
	 */
	public function getSuppliedAttribute(): Model
	{
		return $this->type->supplied;
	}

	/**
	 * Suppliers of this product
	 *
	 * @return Model|null
	 */
	public function getSupplierAttribute(): ?Model
	{
		return $this->supplied->supplier;
	}

	/**
	 * The charge to setup this service
	 *
	 * @param int|null $timeperiod
	 * @param Group|null $go
	 * @return float
	 */
	public function getSetupChargeAttribute(int $timeperiod=NULL,Group $go=NULL): float
	{
		return $this->_charge('setup',$timeperiod,$go);
	}

	/**
	 * The cost to setup this service
	 *
	 * @return float
	 */
	public function getSetupCostAttribute(): float
	{
		return $this->supplied->setup_cost ?: 0;
	}

	/* METHODS */

	/**
	 * Get a charge value from the pricing array
	 *
	 * This will traverse the groups to the parent group to find an appropriate charge, if one is not found,
	 * it will extrapolate a charge from the parent group, from another time period.
	 *
	 * @param string $type
	 * @param int|NULL $timeperiod
	 * @param Group|NULL $go
	 * @return float
	 */
	private function _charge(string $type,int $timeperiod=NULL,Group $go=NULL): float
	{
		// We'll cache this for performance
		static $default = NULL;

		// All public users
		if (is_null($default))
			$default = Group::whereNull('parent_id')->firstOrFail();

		if (! $go)
			$go = $default;

		if (is_null($timeperiod))
			$timeperiod = $this->billing_interval;

		// If the price doesnt exist for $go->id, use $go->id = 0 which is all users.
		if (! $price=$this->charge($timeperiod,$go,$type)) {
			$alt_tp = $timeperiod;

			// Traverse up our timeperiods if the default group to see if there is another time period that has the value
			while (is_null($price=$this->charge($alt_tp,$default,$type)) && ($alt_tp >= 0))
				$alt_tp--;

			// If we havent got a price, we'll extrapolate one, except for setup charges
			if (! is_null($price) && ($alt_tp !== $timeperiod) && ($type !== 'setup'))
				$price = $price*Invoice::billing_change($alt_tp,$timeperiod);
		}

		return round($price,2);
	}

	public function accounting(string $provider): Collection
	{
		return AccountingController::list($provider);
	}

	/**
	 * Return the charge from the pricing table for the specific time period and group
	 *
	 * @param int $timeperiod
	 * @param Group $go
	 * @param string $type
	 * @return float|null
	 */
	public function charge(int $timeperiod,Group $go,string $type): ?float
	{
		return Arr::get($this->pricing,sprintf('%d.%d.%s',$timeperiod,$go->id,$type));
	}

	/**
	 * Do we have a charge for specific group/period
	 *
	 * @param int $timeperiod
	 * @return bool
	 */
	public function charge_available(int $timeperiod): bool
	{
		return Arr::get($this->pricing,sprintf('%d.show',$timeperiod),FALSE);
	}

	/**
	 * Return a normalize price dependent on the product, ie: Broadband = Monthly, Domain = Yearly, etc
	 *
	 * @note: By definition products are normalised, as their cost price is based on the default billing interval
	 * @return float
	 */
	public function cost_normalized(): float
	{
		return number_format(config('site')->taxed($this->supplied->base_cost),2);
	}

	/**
	 * Return if this product captures usage data
	 *
	 * @return bool
	 */
	public function hasUsage(): bool
	{
		return $this->type->hasUsage();
	}

	/**
	 * When receiving an order, validate that we have all the required information for the product type
	 *
	 * @param Request $request
	 * @return Model|null
	 */
	public function orderValidation(Request $request): ?Model
	{
		return $this->type->orderValidation($request);
	}
}