diff --git a/app/Abstracts/Import.php b/app/Abstracts/Import.php index 26cfc0949..c02e7ed84 100644 --- a/app/Abstracts/Import.php +++ b/app/Abstracts/Import.php @@ -2,6 +2,7 @@ namespace App\Abstracts; +use App\Abstracts\Http\FormRequest; use App\Traits\Import as ImportHelper; use App\Traits\Sources; use App\Utilities\Date; @@ -11,6 +12,7 @@ use Illuminate\Contracts\Translation\HasLocalePreference; use Illuminate\Support\Arr; use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Validator; +use Illuminate\Validation\ValidationException; use Maatwebsite\Excel\Concerns\Importable; use Maatwebsite\Excel\Concerns\SkipsEmptyRows; use Maatwebsite\Excel\Concerns\ToModel; @@ -27,6 +29,8 @@ abstract class Import implements HasLocalePreference, ShouldQueue, SkipsEmptyRow public $user; + public $request_class = null; + public function __construct() { $this->user = user(); @@ -70,6 +74,49 @@ abstract class Import implements HasLocalePreference, ShouldQueue, SkipsEmptyRow return []; } + /** + * You can override this method to add custom rules for each row. + */ + public function prepareRules(array $rules): array + { + return $rules; + } + + /** + * Validate each row data. + * + * @param \Illuminate\Validation\Validator $validator + * @throws ValidationException + */ + public function withValidator($validator) + { + $condition = class_exists($this->request_class) + ? ! ($request = new $this->request_class) instanceof FormRequest + : true; + + if ($condition) { + return; + } + + foreach ($validator->getData() as $row => $data) { + $request->initialize(request: $data); + + $rules = $this->prepareRules($request->rules()); + + try { + Validator::make($data, $rules)->validate(); + } catch (ValidationException $e) { + foreach ($e->validator->failed() as $attribute => $value) { + foreach ($value as $rule => $params) { + $validator->addFailure($row . '.' . $attribute, $rule, $params); + } + } + + throw new ValidationException($validator); + } + } + } + public function chunkSize(): int { return config('excel.imports.chunk_size'); diff --git a/app/Http/Requests/Banking/Transaction.php b/app/Http/Requests/Banking/Transaction.php index 5415521c2..10d9c4848 100644 --- a/app/Http/Requests/Banking/Transaction.php +++ b/app/Http/Requests/Banking/Transaction.php @@ -29,7 +29,7 @@ class Transaction extends FormRequest } // Get company id - $company_id = (int) $this->request->get('company_id'); + $company_id = (int) $this->request->get('company_id', company_id()); $attachment = 'nullable'; diff --git a/app/Http/Requests/Common/Item.php b/app/Http/Requests/Common/Item.php index 56daa3c42..1ae7b7af1 100644 --- a/app/Http/Requests/Common/Item.php +++ b/app/Http/Requests/Common/Item.php @@ -31,7 +31,7 @@ class Item extends FormRequest } return [ - 'type' => 'required|string', + 'type' => 'required|string|in:product,service', 'name' => 'required|string', 'sale_price' => $sale_price . '|regex:/^(?=.*?[0-9])[0-9.,]+$/', 'purchase_price' => $purchase_price . '|regex:/^(?=.*?[0-9])[0-9.,]+$/', diff --git a/app/Http/Requests/Document/Document.php b/app/Http/Requests/Document/Document.php index bc39ca761..33bc2666a 100644 --- a/app/Http/Requests/Document/Document.php +++ b/app/Http/Requests/Document/Document.php @@ -48,7 +48,7 @@ class Document extends FormRequest $rules = [ 'type' => 'required|string', 'document_number' => 'required|string|unique:documents,NULL,' . $id . ',id,type,' . $type . ',company_id,' . $company_id . ',deleted_at,NULL', - 'status' => 'required|string', + 'status' => 'required|string|in:draft,paid,partial,sent,received,viewed,cancelled', 'issued_at' => 'required|date_format:Y-m-d H:i:s|before_or_equal:due_at', 'due_at' => 'required|date_format:Y-m-d H:i:s|after_or_equal:issued_at', 'amount' => 'required', diff --git a/app/Http/Requests/Setting/Tax.php b/app/Http/Requests/Setting/Tax.php index 84ecfac7a..b0afe079a 100644 --- a/app/Http/Requests/Setting/Tax.php +++ b/app/Http/Requests/Setting/Tax.php @@ -22,9 +22,9 @@ class Tax extends FormRequest $enabled = 'nullable'; } - $company_id = (int) $this->request->get('company_id'); + $company_id = (int) $this->request->get('company_id', company_id()); - $type = 'required|string'; + $type = 'required|string|in:fixed,normal,inclusive,withholding,compound'; if (!empty($this->request->get('type')) && $this->request->get('type') == 'compound') { $type .= '|unique:taxes,NULL,' . $id . ',id,company_id,' . $company_id . ',type,compound,deleted_at,NULL'; diff --git a/app/Imports/Banking/Transactions.php b/app/Imports/Banking/Transactions.php index b710a8e03..eae60c77c 100644 --- a/app/Imports/Banking/Transactions.php +++ b/app/Imports/Banking/Transactions.php @@ -8,6 +8,8 @@ use App\Models\Banking\Transaction as Model; class Transactions extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -25,9 +27,4 @@ class Transactions extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Banking/Transfers.php b/app/Imports/Banking/Transfers.php index 2770a8100..9c0023df8 100644 --- a/app/Imports/Banking/Transfers.php +++ b/app/Imports/Banking/Transfers.php @@ -26,10 +26,10 @@ class Transfers extends Import $row = parent::map($row); $row['transferred_at'] = Date::parse($row['transferred_at'])->format('Y-m-d'); - $row['from_account_id'] = $this->getFromAccountId($row); - $row['to_account_id'] = $this->getToAccountId($row); $row['from_currency_code'] = $this->getFromCurrencyCode($row); $row['to_currency_code'] = $this->getToCurrencyCode($row); + $row['from_account_id'] = $this->getFromAccountId($row); + $row['to_account_id'] = $this->getToAccountId($row); $row['expense_transaction_id'] = $this->getExpenseTransactionId($row); $row['income_transaction_id'] = $this->getIncomeTransactionId($row); diff --git a/app/Imports/Common/Sheets/ItemTaxes.php b/app/Imports/Common/Sheets/ItemTaxes.php index 3ea4f2efb..a25c3e3fa 100644 --- a/app/Imports/Common/Sheets/ItemTaxes.php +++ b/app/Imports/Common/Sheets/ItemTaxes.php @@ -8,6 +8,8 @@ use App\Models\Common\ItemTax as Model; class ItemTaxes extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -27,9 +29,4 @@ class ItemTaxes extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Common/Sheets/Items.php b/app/Imports/Common/Sheets/Items.php index 61880ce03..413d78873 100644 --- a/app/Imports/Common/Sheets/Items.php +++ b/app/Imports/Common/Sheets/Items.php @@ -8,6 +8,8 @@ use App\Models\Common\Item as Model; class Items extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -25,9 +27,4 @@ class Items extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Purchases/Sheets/BillHistories.php b/app/Imports/Purchases/Sheets/BillHistories.php index 75eb5aa08..f6901b7c6 100644 --- a/app/Imports/Purchases/Sheets/BillHistories.php +++ b/app/Imports/Purchases/Sheets/BillHistories.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentHistory as Model; class BillHistories extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -33,10 +35,8 @@ class BillHistories extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = 'required|string'; unset($rules['bill_id']); diff --git a/app/Imports/Purchases/Sheets/BillItemTaxes.php b/app/Imports/Purchases/Sheets/BillItemTaxes.php index 62c1bbb8c..97273ad93 100644 --- a/app/Imports/Purchases/Sheets/BillItemTaxes.php +++ b/app/Imports/Purchases/Sheets/BillItemTaxes.php @@ -11,6 +11,8 @@ use App\Models\Document\DocumentItemTax as Model; class BillItemTaxes extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -46,10 +48,8 @@ class BillItemTaxes extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = 'required|string'; unset($rules['bill_id']); diff --git a/app/Imports/Purchases/Sheets/BillItems.php b/app/Imports/Purchases/Sheets/BillItems.php index 8f0f83617..ebf5ded9f 100644 --- a/app/Imports/Purchases/Sheets/BillItems.php +++ b/app/Imports/Purchases/Sheets/BillItems.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentItem as Model; class BillItems extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -39,10 +41,8 @@ class BillItems extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = 'required|string'; unset($rules['bill_id']); diff --git a/app/Imports/Purchases/Sheets/BillTotals.php b/app/Imports/Purchases/Sheets/BillTotals.php index a3dc6ccea..e20a41cc1 100644 --- a/app/Imports/Purchases/Sheets/BillTotals.php +++ b/app/Imports/Purchases/Sheets/BillTotals.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentTotal as Model; class BillTotals extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -30,10 +32,8 @@ class BillTotals extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = 'required|string'; unset($rules['bill_id']); diff --git a/app/Imports/Purchases/Sheets/BillTransactions.php b/app/Imports/Purchases/Sheets/BillTransactions.php index 604d64df5..775a64710 100644 --- a/app/Imports/Purchases/Sheets/BillTransactions.php +++ b/app/Imports/Purchases/Sheets/BillTransactions.php @@ -8,6 +8,8 @@ use App\Models\Banking\Transaction as Model; class BillTransactions extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -34,10 +36,8 @@ class BillTransactions extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = 'required|string'; return $rules; diff --git a/app/Imports/Purchases/Sheets/Bills.php b/app/Imports/Purchases/Sheets/Bills.php index 5dce7b836..a1b3cac99 100644 --- a/app/Imports/Purchases/Sheets/Bills.php +++ b/app/Imports/Purchases/Sheets/Bills.php @@ -9,6 +9,8 @@ use Illuminate\Support\Str; class Bills extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -37,16 +39,14 @@ class Bills extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['bill_number'] = Str::replaceFirst('unique:documents,NULL', 'unique:documents,document_number', $rules['document_number']); $rules['billed_at'] = $rules['issued_at']; $rules['currency_rate'] = 'required'; unset($rules['document_number'], $rules['issued_at'], $rules['type']); - return $this->replaceForBatchRules($rules); + return $rules; } } diff --git a/app/Imports/Purchases/Vendors.php b/app/Imports/Purchases/Vendors.php index 2e4c6c5c1..c5d0aba90 100644 --- a/app/Imports/Purchases/Vendors.php +++ b/app/Imports/Purchases/Vendors.php @@ -8,6 +8,8 @@ use App\Models\Common\Contact as Model; class Vendors extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -26,9 +28,4 @@ class Vendors extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Sales/Customers.php b/app/Imports/Sales/Customers.php index 0803f6c1c..414a982a2 100644 --- a/app/Imports/Sales/Customers.php +++ b/app/Imports/Sales/Customers.php @@ -8,6 +8,8 @@ use App\Models\Common\Contact as Model; class Customers extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -26,9 +28,4 @@ class Customers extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Sales/Sheets/InvoiceHistories.php b/app/Imports/Sales/Sheets/InvoiceHistories.php index 2d05e15db..4a93e1153 100644 --- a/app/Imports/Sales/Sheets/InvoiceHistories.php +++ b/app/Imports/Sales/Sheets/InvoiceHistories.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentHistory as Model; class InvoiceHistories extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -33,10 +35,8 @@ class InvoiceHistories extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = 'required|string'; unset($rules['invoice_id']); diff --git a/app/Imports/Sales/Sheets/InvoiceItemTaxes.php b/app/Imports/Sales/Sheets/InvoiceItemTaxes.php index 470f333c7..9f4fe26b0 100644 --- a/app/Imports/Sales/Sheets/InvoiceItemTaxes.php +++ b/app/Imports/Sales/Sheets/InvoiceItemTaxes.php @@ -11,6 +11,8 @@ use App\Models\Document\DocumentItemTax as Model; class InvoiceItemTaxes extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -46,10 +48,8 @@ class InvoiceItemTaxes extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = 'required|string'; unset($rules['invoice_id']); diff --git a/app/Imports/Sales/Sheets/InvoiceItems.php b/app/Imports/Sales/Sheets/InvoiceItems.php index ad3836aad..10a9411ce 100644 --- a/app/Imports/Sales/Sheets/InvoiceItems.php +++ b/app/Imports/Sales/Sheets/InvoiceItems.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentItem as Model; class InvoiceItems extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -39,10 +41,8 @@ class InvoiceItems extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = 'required|string'; unset($rules['invoice_id']); diff --git a/app/Imports/Sales/Sheets/InvoiceTotals.php b/app/Imports/Sales/Sheets/InvoiceTotals.php index 1cb7dc34d..bd6fd9413 100644 --- a/app/Imports/Sales/Sheets/InvoiceTotals.php +++ b/app/Imports/Sales/Sheets/InvoiceTotals.php @@ -9,6 +9,8 @@ use App\Models\Document\DocumentTotal as Model; class InvoiceTotals extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -30,10 +32,8 @@ class InvoiceTotals extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = 'required|string'; unset($rules['invoice_id']); diff --git a/app/Imports/Sales/Sheets/InvoiceTransactions.php b/app/Imports/Sales/Sheets/InvoiceTransactions.php index 1b9a1796a..c153bcd7a 100644 --- a/app/Imports/Sales/Sheets/InvoiceTransactions.php +++ b/app/Imports/Sales/Sheets/InvoiceTransactions.php @@ -8,6 +8,8 @@ use App\Models\Banking\Transaction as Model; class InvoiceTransactions extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -24,20 +26,18 @@ class InvoiceTransactions extends Import $row = parent::map($row); $row['type'] = 'income'; + $row['currency_code'] = $this->getCurrencyCode($row); $row['account_id'] = $this->getAccountId($row); $row['category_id'] = $this->getCategoryId($row, 'income'); $row['contact_id'] = $this->getContactId($row, 'customer'); - $row['currency_code'] = $this->getCurrencyCode($row); $row['document_id'] = $this->getDocumentId($row); $row['number'] = $row['transaction_number']; return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = 'required|string'; return $rules; diff --git a/app/Imports/Sales/Sheets/Invoices.php b/app/Imports/Sales/Sheets/Invoices.php index fa3bc22b9..440d84d48 100644 --- a/app/Imports/Sales/Sheets/Invoices.php +++ b/app/Imports/Sales/Sheets/Invoices.php @@ -9,6 +9,8 @@ use Illuminate\Support\Str; class Invoices extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -37,16 +39,14 @@ class Invoices extends Import return $row; } - public function rules(): array + public function prepareRules(array $rules): array { - $rules = (new Request())->rules(); - $rules['invoice_number'] = Str::replaceFirst('unique:documents,NULL', 'unique:documents,document_number', $rules['document_number']); $rules['invoiced_at'] = $rules['issued_at']; $rules['currency_rate'] = 'required'; unset($rules['document_number'], $rules['issued_at'], $rules['type']); - return $this->replaceForBatchRules($rules); + return $rules; } } diff --git a/app/Imports/Settings/Categories.php b/app/Imports/Settings/Categories.php index b9ae957c9..49931f583 100644 --- a/app/Imports/Settings/Categories.php +++ b/app/Imports/Settings/Categories.php @@ -8,6 +8,8 @@ use App\Models\Setting\Category as Model; class Categories extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); @@ -21,9 +23,4 @@ class Categories extends Import return $row; } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Imports/Settings/Taxes.php b/app/Imports/Settings/Taxes.php index d0d1eb6b2..f7ffb8738 100644 --- a/app/Imports/Settings/Taxes.php +++ b/app/Imports/Settings/Taxes.php @@ -8,13 +8,10 @@ use App\Models\Setting\Tax as Model; class Taxes extends Import { + public $request_class = Request::class; + public function model(array $row) { return new Model($row); } - - public function rules(): array - { - return (new Request())->rules(); - } } diff --git a/app/Traits/Import.php b/app/Traits/Import.php index ffdb40d5a..5aa5baf30 100644 --- a/app/Traits/Import.php +++ b/app/Traits/Import.php @@ -172,6 +172,7 @@ trait Import $data = [ 'company_id' => company_id(), + 'type' => $row['account_type'] ? $row['account_type'] : 'bank', 'currency_code' => $row['currency_code'], 'name' => !empty($row['account_name']) ? $row['account_name'] : $row['currency_code'], 'number' => !empty($row['account_number']) ? $row['account_number'] : (string) rand(1, 10000), @@ -198,6 +199,7 @@ trait Import $data = [ 'company_id' => company_id(), + 'type' => $row['account_type'] ? $row['account_type'] : 'bank', 'name' => $row['account_name'], 'number' => !empty($row['account_number']) ? $row['account_number'] : (string) rand(1, 10000), 'currency_code' => !empty($row['currency_code']) ? $row['currency_code'] : default_currency(), @@ -224,6 +226,7 @@ trait Import $data = [ 'company_id' => company_id(), + 'type' => $row['account_type'] ? $row['account_type'] : 'bank', 'number' => $row['account_number'], 'name' => !empty($row['account_name']) ? $row['account_name'] : $row['account_number'], 'currency_code' => !empty($row['currency_code']) ? $row['currency_code'] : default_currency(), diff --git a/app/Utilities/Import.php b/app/Utilities/Import.php index 266eefc8b..14934593e 100644 --- a/app/Utilities/Import.php +++ b/app/Utilities/Import.php @@ -2,8 +2,11 @@ namespace App\Utilities; +use App\Abstracts\Import as AbstractsImport; +use App\Abstracts\ImportMultipleSheets; use App\Jobs\Auth\NotifyUser; use App\Notifications\Common\ImportCompleted; +use Illuminate\Http\Request; use Maatwebsite\Excel\Validators\ValidationException; use Throwable; @@ -12,69 +15,81 @@ class Import /** * Import the excel file or catch errors * - * @param $class - * @param $request - * @param $translation + * @param AbstractsImport|ImportMultipleSheets $class * * @return array */ - public static function fromExcel($class, $request, $translation) + public static function fromExcel($class, Request $request, string $translation): array { + $success = true; + try { + $should_queue = should_queue(); + $file = $request->file('import'); - if (should_queue()) { - $rows = $class->toArray($file); - - $total_rows = 0; - if (!empty($rows[0])) { - $total_rows = count($rows[0]); - } else if (!empty($sheets = $class->sheets())) { - $total_rows = count($rows[array_keys($sheets)[0]]); - } - - $class->queue($file)->onQueue('imports')->chain([ - new NotifyUser(user(), new ImportCompleted($translation, $total_rows)), - ]); - - $message = trans('messages.success.import_queued', ['type' => $translation]); + if ($should_queue) { + self::importQueue($class, $file, $translation); } else { $class->import($file); - - $message = trans('messages.success.imported', ['type' => $translation]); } - $response = [ - 'success' => true, - 'error' => false, - 'data' => null, - 'message' => $message, - ]; + $message = trans( + 'messages.success.' . ($should_queue ? 'import_queued' : 'imported'), + ['type' => $translation] + ); } catch (Throwable $e) { - if ($e instanceof ValidationException) { - foreach ($e->failures() as $failure) { - $message = trans('messages.error.import_column', [ - 'message' => collect($failure->errors())->first(), - 'column' => $failure->attribute(), - 'line' => $failure->row(), - ]); + $message = self::flashFailures($e); - flash($message)->error()->important(); - } - - $message = ''; - } else { - $message = $e->getMessage(); - } - - $response = [ - 'success' => false, - 'error' => true, - 'data' => null, - 'message' => $message, - ]; + $success = false; } - return $response; + return [ + 'success' => $success, + 'error' => ! $success, + 'data' => null, + 'message' => $message, + ]; + } + + /** + * Import the excel file + * + * @param AbstractsImport|ImportMultipleSheets $class + */ + protected static function importQueue($class, $file, string $translation): void + { + $rows = $class->toArray($file); + + $total_rows = 0; + + if (! empty($rows[0])) { + $total_rows = count($rows[0]); + } else if (! empty($sheets = $class->sheets())) { + $total_rows = count($rows[array_keys($sheets)[0]]); + } + + $class->queue($file)->onQueue('imports')->chain([ + new NotifyUser(user(), new ImportCompleted($translation, $total_rows)) + ]); + } + + protected static function flashFailures(Throwable $e): string + { + if (! $e instanceof ValidationException) { + return $e->getMessage(); + } + + foreach ($e->failures() as $failure) { + $message = trans('messages.error.import_column', [ + 'message' => collect($failure->errors())->first(), + 'column' => $failure->attribute(), + 'line' => $failure->row(), + ]); + + flash($message)->error()->important(); + } + + return ''; } }