From 8378d35149f097cd25237e7d7bf9288ecd3626ea Mon Sep 17 00:00:00 2001
From: Mike Koch <mkoch227@gmail.com>
Date: Wed, 15 Mar 2017 22:07:17 -0400
Subject: [PATCH] Start working on attachments API. Fix .gitignore

---
 .gitignore                                    |  2 +-
 api/BusinessLogic/Attachments/Attachment.php  | 21 +++++++++++++
 .../Attachments/AttachmentHandler.php         | 16 ++++++++++
 .../Attachments/AttachmentType.php            |  9 ++++++
 .../CreateAttachmentForTicketModel.php        | 12 ++++++++
 .../Attachments/CreateAttachmentModel.php     | 18 +++++++++++
 .../Attachments/TicketAttachment.php          | 12 ++++++++
 .../StaffAttachmentsController.php            | 10 +++++++
 .../Attachments/AttachmentGateway.php         | 30 +++++++++++++++++++
 .../Attachments/AttachmentHandlerTest.php     | 17 +++++++++++
 10 files changed, 146 insertions(+), 1 deletion(-)
 create mode 100644 api/BusinessLogic/Attachments/Attachment.php
 create mode 100644 api/BusinessLogic/Attachments/AttachmentHandler.php
 create mode 100644 api/BusinessLogic/Attachments/AttachmentType.php
 create mode 100644 api/BusinessLogic/Attachments/CreateAttachmentForTicketModel.php
 create mode 100644 api/BusinessLogic/Attachments/CreateAttachmentModel.php
 create mode 100644 api/BusinessLogic/Attachments/TicketAttachment.php
 create mode 100644 api/Controllers/Attachments/StaffAttachmentsController.php
 create mode 100644 api/DataAccess/Attachments/AttachmentGateway.php
 create mode 100644 api/Tests/BusinessLogic/Attachments/AttachmentHandlerTest.php

diff --git a/.gitignore b/.gitignore
index 2e3f55a2..70d3d8c3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -270,7 +270,7 @@ readme.html
 robots.txt
 .idea/
 attachments/__latest.txt
-attachments
+/attachments
 img/ban.png
 img/banned.png
 img/ico_tools.png
diff --git a/api/BusinessLogic/Attachments/Attachment.php b/api/BusinessLogic/Attachments/Attachment.php
new file mode 100644
index 00000000..380d00b3
--- /dev/null
+++ b/api/BusinessLogic/Attachments/Attachment.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class Attachment {
+    /* @var $id int */
+    public $id;
+
+    /* @var $savedName string */
+    public $savedName;
+
+    /* @var $displayName string */
+    public $displayName;
+
+    /* @var $id int */
+    public $fileSize;
+
+    /* @var $downloadCount int */
+    public $downloadCount;
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Attachments/AttachmentHandler.php b/api/BusinessLogic/Attachments/AttachmentHandler.php
new file mode 100644
index 00000000..c61a109d
--- /dev/null
+++ b/api/BusinessLogic/Attachments/AttachmentHandler.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class AttachmentHandler {
+
+
+    function createAttachmentForTicket($createAttachmentModel) {
+
+    }
+
+    private function validate($createAttachmentModel) {
+
+    }
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Attachments/AttachmentType.php b/api/BusinessLogic/Attachments/AttachmentType.php
new file mode 100644
index 00000000..e353d84a
--- /dev/null
+++ b/api/BusinessLogic/Attachments/AttachmentType.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class AttachmentType {
+    const MESSAGE = 0;
+    const REPLY = 1;
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Attachments/CreateAttachmentForTicketModel.php b/api/BusinessLogic/Attachments/CreateAttachmentForTicketModel.php
new file mode 100644
index 00000000..04336133
--- /dev/null
+++ b/api/BusinessLogic/Attachments/CreateAttachmentForTicketModel.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class CreateAttachmentForTicketModel extends CreateAttachmentModel {
+    /* @var $ticketId int */
+    public $ticketId;
+
+    /* @var $type int [use <code>AttachmentType</code] */
+    public $type;
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Attachments/CreateAttachmentModel.php b/api/BusinessLogic/Attachments/CreateAttachmentModel.php
new file mode 100644
index 00000000..209450d2
--- /dev/null
+++ b/api/BusinessLogic/Attachments/CreateAttachmentModel.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class CreateAttachmentModel {
+    /* @var $savedName string */
+    public $savedName;
+
+    /* @var $displayName string */
+    public $displayName;
+
+    /* @var $id int */
+    public $fileSize;
+
+    /* @var $attachmentContents string [base64-encoded] */
+    public $attachmentContents;
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Attachments/TicketAttachment.php b/api/BusinessLogic/Attachments/TicketAttachment.php
new file mode 100644
index 00000000..fdecd978
--- /dev/null
+++ b/api/BusinessLogic/Attachments/TicketAttachment.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace BusinessLogic\Attachments;
+
+
+class TicketAttachment extends Attachment {
+    /* @var $ticketTrackingId string */
+    public $ticketTrackingId;
+
+    /* @var $type int [use <code>AttachmentType</code>] */
+    public $type;
+}
\ No newline at end of file
diff --git a/api/Controllers/Attachments/StaffAttachmentsController.php b/api/Controllers/Attachments/StaffAttachmentsController.php
new file mode 100644
index 00000000..6bfbbd81
--- /dev/null
+++ b/api/Controllers/Attachments/StaffAttachmentsController.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Controllers\Attachments;
+
+
+class StaffAttachmentsController {
+    function post() {
+
+    }
+}
\ No newline at end of file
diff --git a/api/DataAccess/Attachments/AttachmentGateway.php b/api/DataAccess/Attachments/AttachmentGateway.php
new file mode 100644
index 00000000..70931e3e
--- /dev/null
+++ b/api/DataAccess/Attachments/AttachmentGateway.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace DataAccess\Attachments;
+
+
+use BusinessLogic\Attachments\TicketAttachment;
+use DataAccess\CommonDao;
+
+class AttachmentGateway extends CommonDao {
+
+    /**
+     * @param $attachment TicketAttachment
+     * @param $heskSettings array
+     * @return int The inserted attachment ID
+     */
+    function createAttachmentForTicket($attachment, $heskSettings) {
+        $this->init();
+
+        hesk_dbQuery("INSERT INTO `" . hesk_dbEscape($heskSettings['db_pfix']) . "attachments` 
+            (`ticket_id`, `note_id`, `saved_name`, `real_name`, `size`, `type`, `download_count`)
+            VALUES ('" . hesk_dbEscape($attachment->ticketTrackingId) . "', NULL, '" . hesk_dbEscape($attachment->savedName) . "',
+                '" . hesk_dbEscape($attachment->displayName) . "', " . intval($attachment->fileSize) . ", '" . intval($attachment->type) . "', 0)");
+
+        $attachmentId = hesk_dbInsertID();
+
+        $this->close();
+
+        return $attachmentId;
+    }
+}
\ No newline at end of file
diff --git a/api/Tests/BusinessLogic/Attachments/AttachmentHandlerTest.php b/api/Tests/BusinessLogic/Attachments/AttachmentHandlerTest.php
new file mode 100644
index 00000000..335b3b88
--- /dev/null
+++ b/api/Tests/BusinessLogic/Attachments/AttachmentHandlerTest.php
@@ -0,0 +1,17 @@
+<?php
+
+
+namespace BusinessLogic\Attachments;
+
+
+use PHPUnit\Framework\TestCase;
+
+class AttachmentHandlerTest extends TestCase {
+
+    /* @var $attachmentHandler AttachmentHandler */
+    private $attachmentHandler;
+
+    protected function setUp() {
+        $this->attachmentHandler = new AttachmentHandler();
+    }
+}