Skip to content

A free open source IT asset/license management system

Override the getEula() method at the SnipeModel level

snipe74b98083e2ed
diff --git a/app/Http/Controllers/Account/AcceptanceController.php b/app/Http/Controllers/Account/AcceptanceController.php
index 6e66339565..71333aef6f 100644
--- a/app/Http/Controllers/Account/AcceptanceController.php
+++ b/app/Http/Controllers/Account/AcceptanceController.php
@@ -8,8 +8,6 @@ use App\Events\ItemAccepted;
use App\Events\ItemDeclined;
use App\Http\Controllers\Controller;
use App\Mail\CheckoutAcceptanceResponseMail;
-use App\Models\Actionlog;
-use App\Models\Asset;
use App\Models\CheckoutAcceptance;
use App\Models\Company;
use App\Models\Contracts\Acceptable;
@@ -25,7 +23,6 @@ use App\Notifications\AcceptanceAssetAcceptedToUserNotification;
use App\Notifications\AcceptanceAssetDeclinedNotification;
use Exception;
use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
@@ -108,12 +105,18 @@ class AcceptanceController extends Controller
}
/**
- * Get the signature and save it
+ * Check for the signature directory
*/
if (! Storage::exists('private_uploads/signatures')) {
Storage::makeDirectory('private_uploads/signatures', 775);
}
+ /**
+ * Check for the eula-pdfs directory
+ */
+ if (! Storage::exists('private_uploads/eula-pdfs')) {
+ Storage::makeDirectory('private_uploads/eula-pdfs', 775);
+ }
$item = $acceptance->checkoutable_type::find($acceptance->checkoutable_id);
@@ -124,19 +127,7 @@ class AcceptanceController extends Controller
if ($request->input('asset_acceptance') == 'accepted') {
- /**
- * Check for the eula-pdfs directory
- */
- if (! Storage::exists('private_uploads/eula-pdfs')) {
- Storage::makeDirectory('private_uploads/eula-pdfs', 775);
- }
-
if (Setting::getSettings()->require_accept_signature == '1') {
-
- // Check if the signature directory exists, if not create it
- if (!Storage::exists('private_uploads/signatures')) {
- Storage::makeDirectory('private_uploads/signatures', 775);
- }
// The item was accepted, check for a signature
if ($request->filled('signature_output')) {
@@ -153,56 +144,8 @@ class AcceptanceController extends Controller
}
}
-
$assigned_user = User::find($acceptance->assigned_to_id);
- // this is horrible
- switch($acceptance->checkoutable_type){
- case 'App\Models\Asset':
- $pdf_view_route ='account.accept.accept-asset-eula';
- $asset_model = AssetModel::find($item->model_id);
- if (!$asset_model) {
- return redirect()->back()->with('error', trans('admin/models/message.does_not_exist'));
- }
- $display_model = $asset_model->name;
- break;
-
- case 'App\Models\Accessory':
- $pdf_view_route ='account.accept.accept-accessory-eula';
- $accessory = Accessory::find($item->id);
- $display_model = $accessory->name;
- break;
-
- case 'App\Models\LicenseSeat':
- $pdf_view_route ='account.accept.accept-license-eula';
- $license = License::find($item->license_id);
- $display_model = $license->name;
- break;
-
- case 'App\Models\Component':
- $pdf_view_route ='account.accept.accept-component-eula';
- $component = Component::find($item->id);
- $display_model = $component->name;
- break;
-
- case 'App\Models\Consumable':
- $pdf_view_route ='account.accept.accept-consumable-eula';
- $consumable = Consumable::find($item->id);
- $display_model = $consumable->name;
- break;
- }
-// if ($acceptance->checkoutable_type == 'App\Models\Asset') {
-// $pdf_view_route ='account.accept.accept-asset-eula';
-// $asset_model = AssetModel::find($item->model_id);
-// $display_model = $asset_model->name;
-// $assigned_to = User::find($item->assigned_to)->present()->fullName;
-//
-// } elseif ($acceptance->checkoutable_type== 'App\Models\Accessory') {
-// $pdf_view_route ='account.accept.accept-accessory-eula';
-// $accessory = Accessory::find($item->id);
-// $display_model = $accessory->name;
-// $assigned_to = User::find($item->assignedTo);
-//
-// }
+
/**
* Gather the data for the PDF. We fire this whether there is a signature required or not,
@@ -237,82 +180,83 @@ class AcceptanceController extends Controller
'qty' => $acceptance->qty ?? 1,
];
- if ($pdf_view_route!='') {
- // set some language dependent data:
- $lg = Array();
- $lg['a_meta_charset'] = 'UTF-8';
- $lg['w_page'] = 'page';
-
- $pdf = new TCPDF('P', 'mm', 'A4', true, 'UTF-8', false);
- $pdf->setRTL(false);
- $pdf->setLanguageArray($lg);
- $pdf->SetFontSubsetting(true);
- $pdf->SetCreator('Snipe-IT');
- $pdf->SetAuthor($data['assigned_to']);
- $pdf->SetTitle('Asset Acceptance: '.$data['item_tag']);
- $pdf->SetSubject('Asset Acceptance: '.$data['item_tag']);
- $pdf->SetKeywords('Snipe-IT, assets, acceptance, eula', 'tos');
- $pdf->SetFont('dejavusans', '', 8, '', true);
- $pdf->SetPrintHeader(false);
- $pdf->SetPrintFooter(false);
- $pdf->setHeaderFont(Array(PDF_FONT_NAME_MAIN, '', PDF_FONT_SIZE_MAIN));
- $pdf->setFooterFont(Array(PDF_FONT_NAME_DATA, '', PDF_FONT_SIZE_DATA));
-
- $pdf->AddPage();
- $pdf->writeHTML('<img src="'.$path_logo.'" height="30">', true, 0, true, 0, '');
-
- $pdf->writeHTML("<strong>".trans('general.asset_tag').'</strong>: '.$data['item_tag'], true, 0, true, 0, '');
- $pdf->writeHTML("<strong>".trans('general.asset_model').'</strong>: '.$data['item_model'], true, 0, true, 0, '');
+ // set some language dependent data:
+ $lg = Array();
+ $lg['a_meta_charset'] = 'UTF-8';
+ $lg['w_page'] = 'page';
+
+ $pdf = new TCPDF('P', 'mm', 'A4', true, 'UTF-8', false);
+ $pdf->setRTL(false);
+ $pdf->setLanguageArray($lg);
+ $pdf->SetFontSubsetting(true);
+ $pdf->SetCreator('Snipe-IT');
+ $pdf->SetAuthor($data['assigned_to']);
+ $pdf->SetTitle('Asset Acceptance: '.$data['item_tag']);
+ $pdf->SetSubject('Asset Acceptance: '.$data['item_tag']);
+ $pdf->SetKeywords('Snipe-IT, assets, acceptance, eula', 'tos');
+ $pdf->SetFont('dejavusans', '', 8, '', true);
+ $pdf->SetPrintHeader(false);
+ $pdf->SetPrintFooter(false);
+ $pdf->setHeaderFont(Array(PDF_FONT_NAME_MAIN, '', PDF_FONT_SIZE_MAIN));
+ $pdf->setFooterFont(Array(PDF_FONT_NAME_DATA, '', PDF_FONT_SIZE_DATA));
+
+ $pdf->AddPage();
+ $pdf->writeHTML('<img src="'.$path_logo.'" height="30">', true, 0, true, 0, '');
+
+ if ($data['item_serial']) {
+ $pdf->writeHTML("<strong>" . trans('general.asset_tag') . '</strong>: ' . $data['item_tag'], true, 0, true, 0, '');
+ }
+ $pdf->writeHTML("<strong>".trans('general.asset_model').'</strong>: '.$data['item_model'], true, 0, true, 0, '');
+ if ($data['item_serial']) {
$pdf->writeHTML("<strong>".trans('admin/hardware/form.serial').'</strong>: '.$data['item_serial'], true, 0, true, 0, '');
- $pdf->writeHTML("<strong>".trans('general.assigned_date').'</strong>: '.$data['check_out_date'], true, 0, true, 0, '');
- $pdf->writeHTML("<strong>".trans('general.assignee').'</strong>: '.$data['assigned_to'], true, 0, true, 0, '');
- $pdf->Ln();
-
- // Break the EULA into lines based on newlines, and check each line for RTL or CJK characters
- $eula_lines = preg_split("/\r\n|\n|\r/", $item->getEula());
+ }
+ $pdf->writeHTML("<strong>".trans('general.assigned_date').'</strong>: '.$data['check_out_date'], true, 0, true, 0, '');
+ $pdf->writeHTML("<strong>".trans('general.assignee').'</strong>: '.$data['assigned_to'], true, 0, true, 0, '');
+ $pdf->Ln();
- foreach ($eula_lines as $eula_line) {
- Helper::hasRtl($eula_line) ? $pdf->setRTL(true) : $pdf->setRTL(false);
- Helper::isCjk($eula_line) ? $pdf->SetFont('cid0cs', '', 9) : $pdf->SetFont('dejavusans', '', 8, '', true);
+ // Break the EULA into lines based on newlines, and check each line for RTL or CJK characters
+ $eula_lines = preg_split("/\r\n|\n|\r/", $item->getEula());
+ foreach ($eula_lines as $eula_line) {
+ Helper::hasRtl($eula_line) ? $pdf->setRTL(true) : $pdf->setRTL(false);
+ Helper::isCjk($eula_line) ? $pdf->SetFont('cid0cs', '', 9) : $pdf->SetFont('dejavusans', '', 8, '', true);
- $pdf->writeHTML(Helper::parseEscapedMarkedown($eula_line), true, 0, true, 0, '');
- }
- $pdf->Ln();
+ $pdf->writeHTML(Helper::parseEscapedMarkedown($eula_line), true, 0, true, 0, '');
+ }
+ $pdf->Ln();
+ $pdf->Ln();
+ $pdf->setRTL(false);
+ $pdf->writeHTML('<br><br>', true, 0, true, 0, '');
+
+ if ($data['note'] != null) {
+ Helper::isCjk($data['note']) ? $pdf->SetFont('cid0cs', '', 9) : $pdf->SetFont('dejavusans', '', 8, '', true);
+ $pdf->writeHTML("<strong>".trans('general.notes') . '</strong>: ' . $data['note'], true, 0, true, 0, '');
$pdf->Ln();
- $pdf->setRTL(false);
- $pdf->writeHTML('<br><br>', true, 0, true, 0, '');
+ }
- if ($data['note'] != null) {
- Helper::isCjk($data['note']) ? $pdf->SetFont('cid0cs', '', 9) : $pdf->SetFont('dejavusans', '', 8, '', true);
- $pdf->writeHTML("<strong>".trans('general.notes') . '</strong>: ' . $data['note'], true, 0, true, 0, '');
- $pdf->Ln();
- }
+ if ($data['signature'] != null) {
- if ($data['signature'] != null) {
+ $pdf->writeHTML('<img src="'.$data['signature'].'" style="max-width: 600px;">', true, 0, true, 0, '');
+ $pdf->writeHTML('<hr>', true, 0, true, 0, '');
+ }
- $pdf->writeHTML('<img src="'.$data['signature'].'" style="max-width: 600px;">', true, 0, true, 0, '');
- $pdf->writeHTML('<hr>', true, 0, true, 0, '');
- }
+ $pdf->writeHTML("<strong>".trans('general.accepted_date').'</strong>: '.$data['accepted_date'], true, 0, true, 0, '');
- $pdf->writeHTML("<strong>".trans('general.accepted_date').'</strong>: '.$data['accepted_date'], true, 0, true, 0, '');
+ $pdf_content = $pdf->Output($pdf_filename, 'S');
- $pdf_content = $pdf->Output($pdf_filename, 'S');
+ Storage::put('private_uploads/eula-pdfs/' .$pdf_filename, $pdf_content);
- Storage::put('private_uploads/eula-pdfs/' .$pdf_filename, $pdf_content);
- }
- $acceptance->accept($sig_filename, $item->getEula(), $pdf_filename, $request->input('note'));
+ $acceptance->accept($sig_filename, $item->getEula(), $pdf_filename, $request->input('note'));
// Send the PDF to the signing user
if (($request->input('send_copy') == '1') && ($assigned_user->email !='')) {
// Add the attachment for the signing user into the $data array
$data['file'] = $pdf_filename;
- $locale = $assigned_user->locale;
try {
- $assigned_user->notify((new AcceptanceAssetAcceptedToUserNotification($data))->locale($locale));
+ $assigned_user->notify((new AcceptanceAssetAcceptedToUserNotification($data))->locale($assigned_user->locale));
} catch (\Exception $e) {
Log::warning($e);
}
@@ -328,21 +272,9 @@ class AcceptanceController extends Controller
} else {
- /**
- * Check for the eula-pdfs directory
- */
- if (! Storage::exists('private_uploads/eula-pdfs')) {
- Storage::makeDirectory('private_uploads/eula-pdfs', 775);
- }
-
if (Setting::getSettings()->require_accept_signature == '1') {
-
- // Check if the signature directory exists, if not create it
- if (!Storage::exists('private_uploads/signatures')) {
- Storage::makeDirectory('private_uploads/signatures', 775);
- }
- // The item was accepted, check for a signature
+ // The item was declined, check for a signature
if ($request->filled('signature_output')) {
$sig_filename = 'siglog-' . Str::uuid() . '-' . date('Y-m-d-his') . '.png';
$data_uri = $request->input('signature_output');
@@ -359,39 +291,11 @@ class AcceptanceController extends Controller
// Format the data to send the declined notification
$branding_settings = SettingsController::getPDFBranding();
-
- // This is the most horriblest
- switch($acceptance->checkoutable_type){
- case 'App\Models\Asset':
- $asset_model = AssetModel::find($item->model_id);
- $display_model = $asset_model->name;
- $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
- break;
-
- case 'App\Models\Accessory':
- $accessory = Accessory::find($item->id);
- $display_model = $accessory->name;
- $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
- break;
-
- case 'App\Models\LicenseSeat':
- $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
- break;
-
- case 'App\Models\Component':
- $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
- break;
-
- case 'App\Models\Consumable':
- $consumable = Consumable::find($item->id);
- $display_model = $consumable->name;
- $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
- break;
- }
+ $assigned_to = User::find($acceptance->assigned_to_id)->present()->fullName;
$data = [
'item_tag' => $item->asset_tag,
- 'item_model' => $display_model,
+ 'item_model' => $item->model ?? '',
'item_serial' => $item->serial,
'item_status' => $item->assetstatus?->name,
'note' => $request->input('note'),
@@ -403,11 +307,6 @@ class AcceptanceController extends Controller
'qty' => $acceptance->qty ?? 1,
];
- if ($pdf_view_route!='') {
- Log::debug($pdf_filename.' is the filename, and the route was specified.');
- $pdf = Pdf::loadView($pdf_view_route, $data);
- Storage::put('private_uploads/eula-pdfs/' .$pdf_filename, $pdf->output());
- }
for ($i = 0; $i < ($acceptance->qty ?? 1); $i++) {
$acceptance->decline($sig_filename, $request->input('note'));
diff --git a/app/Models/Accessory.php b/app/Models/Accessory.php
index 33a1c6a570..29984a1c2b 100755
--- a/app/Models/Accessory.php
+++ b/app/Models/Accessory.php
@@ -309,27 +309,6 @@ class Accessory extends SnipeModel
return $this->category->require_acceptance ?? false;
}
- /**
- * Checks for a category-specific EULA, and if that doesn't exist,
- * checks for a settings level EULA
- *
- * @author [A. Gianotto] [<[email protected]>]
- * @since [v3.0]
- * @return string
- */
- public function getEula()
- {
-
- if ($this->category->eula_text) {
- return Helper::parseEscapedMarkedown($this->category->eula_text);
- } elseif ((Setting::getSettings()->default_eula_text) && ($this->category->use_default_eula == '1')) {
- return Helper::parseEscapedMarkedown(Setting::getSettings()->default_eula_text);
- }
-
- return null;
- }
-
-
/**
* Check how many items within an accessory are checked out
*
diff --git a/app/Models/Asset.php b/app/Models/Asset.php
index b97b0d8f82..02b865ea80 100644
--- a/app/Models/Asset.php
+++ b/app/Models/Asset.php
@@ -1023,31 +1023,6 @@ class Asset extends Depreciable
return false;
}
-
- /**
- * Checks for a category-specific EULA, and if that doesn't exist,
- * checks for a settings level EULA
- *
- * @author [A. Gianotto] [<[email protected]>]
- * @since [v4.0]
- * @return string | false
- */
- public function getEula()
- {
-
- if (($this->model) && ($this->model->category)) {
- if (($this->model->category->eula_text) && ($this->model->category->use_default_eula == 0)) {
- return $this->model->category->eula_text;
- } elseif ($this->model->category->use_default_eula == 1) {
- return Setting::getSettings()->default_eula_text;
- } else {
-
- return false;
- }
- }
-
- return false;
- }
public function getComponentCost()
{
$cost = 0;
diff --git a/app/Models/Component.php b/app/Models/Component.php
index 09ca41830e..ddcb3ad575 100644
--- a/app/Models/Component.php
+++ b/app/Models/Component.php
@@ -217,24 +217,6 @@ class Component extends SnipeModel
return $this->category->require_acceptance;
}
- /**
- * Checks for a category-specific EULA, and if that doesn't exist,
- * checks for a settings level EULA
- *
- * @author [A. Gianotto] [<[email protected]>]
- * @since [v4.0]
- * @return string | false
- */
- public function getEula()
- {
- if ($this->category->eula_text) {
- return Helper::parseEscapedMarkedown($this->category->eula_text);
- } elseif ((Setting::getSettings()->default_eula_text) && ($this->category->use_default_eula == '1')) {
- return Helper::parseEscapedMarkedown(Setting::getSettings()->default_eula_text);
- } else {
- return null;
- }
- }
/**
* Establishes the component -> action logs relationship
diff --git a/app/Models/Consumable.php b/app/Models/Consumable.php
index c7cdff0fe3..8c6e43c490 100644
--- a/app/Models/Consumable.php
+++ b/app/Models/Consumable.php
@@ -285,25 +285,6 @@ class Consumable extends SnipeModel
return $this->category->require_acceptance;
}
- /**
- * Checks for a category-specific EULA, and if that doesn't exist,
- * checks for a settings level EULA
- *
- * @author [A. Gianotto] [<[email protected]>]
- * @since [v4.0]
- * @return string | false
- */
- public function getEula()
- {
- if ($this->category->eula_text) {
- return Helper::parseEscapedMarkedown($this->category->eula_text);
- } elseif ((Setting::getSettings()->default_eula_text) && ($this->category->use_default_eula == '1')) {
- return Helper::parseEscapedMarkedown(Setting::getSettings()->default_eula_text);
- } else {
- return null;
- }
- }
-
/**
* Check how many items within a consumable are checked out
*
diff --git a/app/Models/License.php b/app/Models/License.php
index 855995b43c..d84f42f0a1 100755
--- a/app/Models/License.php
+++ b/app/Models/License.php
@@ -299,16 +299,16 @@ class License extends Depreciable
}
public function isInactive(): bool
- {
- $day = now()->startOfDay();
+{
+ $day = now()->startOfDay();
- $expired = $this->expiration_date && $this->asDateTime($this->expiration_date)->startofDay()->lessThanOrEqualTo($day);
+ $expired = $this->expiration_date && $this->asDateTime($this->expiration_date)->startofDay()->lessThanOrEqualTo($day);
- $terminated = $this->termination_date && $this->asDateTime($this->termination_date)->startofDay()->lessThanOrEqualTo($day);
+ $terminated = $this->termination_date && $this->asDateTime($this->termination_date)->startofDay()->lessThanOrEqualTo($day);
return $this->isExpired() || $this->isTerminated();
- }
+}
public function isExpired(): bool
{
@@ -408,27 +408,6 @@ class License extends Depreciable
return false;
}
- /**
- * Checks for a category-specific EULA, and if that doesn't exist,
- * checks for a settings level EULA
- *
- * @author [A. Gianotto] [<[email protected]>]
- * @since [v4.0]
- * @return string | false
- */
- public function getEula()
- {
- if ($this->category) {
- if ($this->category->eula_text) {
- return Helper::parseEscapedMarkedown($this->category->eula_text);
- } elseif ($this->category->use_default_eula == '1') {
- return Helper::parseEscapedMarkedown(Setting::getSettings()->default_eula_text);
- }
- }
-
- return false;
-
- }
/**
* Establishes the license -> assigned user relationship
diff --git a/app/Models/SnipeModel.php b/app/Models/SnipeModel.php
index 6a4bdfee2c..ae65664474 100644
--- a/app/Models/SnipeModel.php
+++ b/app/Models/SnipeModel.php
@@ -180,5 +180,27 @@ class SnipeModel extends Model
);
}
+ public function getEula()
+ {
+
+ // This is - for now - only for assets, where the asset model is the thing tied to the category
+ if (($this->model) && ($this->model->category)) {
+ if (($this->model->category->eula_text) && ($this->model->category->use_default_eula == 0)) {
+ return $this->model->category->eula_text;
+ } elseif ($this->model->category->use_default_eula == 1) {
+ return Setting::getSettings()->default_eula_text;
+ } else {
+ return false;
+ }
+ // For everything else, just check the category for EULA info
+ } elseif (($this->category) && ($this->category->eula_text)) {
+ return $this->category->eula_text;
+ } elseif ((Setting::getSettings()->default_eula_text) && (($this->category) && ($this->category->use_default_eula == '1'))) {
+ return Setting::getSettings()->default_eula_text;
+ }
+
+ return null;
+ }
+
}