Update API documentation

README.md

@@ -56,6 +56,7 @@ Just as there is a `gulp dev` task for development, there is also a `gulp prod`
 - `make db` access to mysql database console
 - `make sh` access to backend docker container bash
 - `make test` run phpunit tests
+- `make doc` to build the documentation (requires `apidoc`)
 
 Server api runs on `http://localhost:8080/`
 Also, there's a *phpmyadmin* instance running on `http://localhost:6060/`,

server/API_STANDARD.md

@@ -38,3 +38,30 @@ This request will return you the session data with an `userId` and a `token`. Yo
 If you don't pass the userId and token, a `NO_PERMISSION` error will be returned.
 
 Additionally, if there are no users (only staff members), you can check a ticket you created by providing your email and the ticketNumber to the `/ticket/check` path. This path will return you a `token` and `ticketNumber` you will use to comment, retrieve, or do any other operations to the ticket.
+
+## File Attachments
+We have two settings for file attachment:
+* *allow-attachments* setting flag indicates if users can attach files.
+* *max-size* setting indicates what is the file size limit in MB.
+
+When you want to attach images to a ticket, comment or article; you can place the string `IMAGE_PATH_i` inside the parameter `content`.
+`IMAGE_PATH_i` indicates that it should be replaced with the path of the image of index `i` (zero-indexed).
+
+You may also include the `images` parameter indicating the number of images; and `image_i` parameters, which contain the image file object of index `i`.
+
+For example
+
+```
+/article/add
+title = 'article title'
+content = 'this is an article <img src="IMAGE_PATH_0"/> with two images <img src="IMAGE_PATH_1"/>'
+position = 1
+topicId = 1
+images = 2
+image_0 = <File>
+image_1 = <File>
+```
+
+This request will upload `image_0` and `image_1`. After that, it will replace `IMAGE_PATH_0` and `IMAGE_PATH_1` with the corresponding urls for each image. The rest of the request will operate normal.
+
+**Please remember that `max-size` setting applies also to images.**

server/Makefile

@@ -37,3 +37,6 @@ db:
 
 sh:
 	@docker exec -it opensupports-srv bash
+
+doc:
+	@apidoc -i models/ -i data/ -i libs/ -i controllers/ -o apidoc/

server/_apidoc.js

@@ -1,82 +0,0 @@
-
-/**
- * @api {post} /staff/get Get staff
- * @apiVersion 4.0.0
- *
- * @apiName Get staff
- *
- * @apiGroup Staff
- *
- * @apiDescription This path retrieves information about a staff member.
- *
- * @apiPermission staff1
- *
- * @apiParam {Number} staffId The id of the staff member to be searched.
- *
- * @apiUse NO_PERMISSION
- *
- * @apiSuccess {Object} data Information about a staff member
- * @apiSuccess {String} data.name Staff id
- * @apiSuccess {String} data.email Staff id
- * @apiSuccess {String} data.profilePic Staff id
- * @apiSuccess {Number} data.level Staff id
- * @apiSuccess {Boolean} data.staff Staff id
- * @apiSuccess {[Department](#api-Data_Structures-ObjectDepartment)[]} data.departments Array of departments that has assigned.
- * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets that has assigned.
- *
- */
-
-/**
- * @api {get} /system/download Download file
- * @apiVersion 4.0.0
- *
- * @apiName Download file
- *
- * @apiGroup System
- *
- * @apiDescription This path downloads a file.
- *
- * @apiPermission any
- *
- * @apiParam {String} file The filename to be downloaded.
- *
- *
- * @apiSuccess {Object} file File content
- *
- */
-
-/**
- * @api {post} /system/init-settings Init settings
- * @apiVersion 4.0.0
- *
- * @apiName Init settings
- *
- * @apiGroup System
- *
- * @apiDescription This path sets the initial settings. It can only be used once during installation.
- *
- * @apiPermission any
- *
- * @apiParam {String} language Indicates the default language of the system.
- * @apiParam {String} user-system-enabled Indicates if the user system should be enabled.
- * @apiParam {String} registration Indicates if the registration should be enabled.
- *
- * @apiUse INVALID_LANGUAGE
- * @apiUse INIT_SETTINGS_DONE
- *
- * @apiSuccess {Object} data Empty object
- *
- */
-
-/**
- * @api {OBJECT} Staff Staff
- * @apiVersion 4.0.0
- * @apiGroup Data Structures
- * @apiParam {String} name Name of the staff member.
- * @apiParam {String} email Email of the staff member.
- * @apiParam {String} profilePic profilePic url of the staff member.
- * @apiParam {Number} level Level of the staff member.
- * @apiParam {Object[]} departments The departments the staff member has assigned.
- * @apiParam {[Ticket](#api-Data_Structures-ObjectTicket)[]} tickets The tickets the staff member has assigned.
- * @apiParam {Number} lastLogin The last login of the staff member.
- */

server/apidoc.json

@@ -1,10 +1,10 @@
 {
   "name": "OpenSupports API Documentation",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "title": "OpenSupports API Documentation",
   "description": "Backend API documentation for developers.",
   "header": {
     "title": "API Standards",
     "filename": "API_STANDARD.md"
   }
-}
+}

server/controllers/article/add-topic.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/add-topic Add topic
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add topic
  *

server/controllers/article/add.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/add Add article
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add article
  *
@@ -18,11 +18,14 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {String} content Content of the new article.
  * @apiParam {Number} position Position of the new article.
  * @apiParam {Number} topicId Id of the articles's topic.
+ * @apiParam {Number} images The number of images in the content
+ * @apiParam image_i The image file of index `i` (mutiple params accepted)
  *
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_NAME
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_TOPIC
+ * @apiUse INVALID_FILE
  *
  * @apiSuccess {Object} data Article info
  * @apiSuccess {Number} data.articleId Article id
@@ -57,7 +60,7 @@ class AddArticleController extends Controller {
 
         $fileUploader = FileUploader::getInstance();
         $fileUploader->setPermission(FileManager::PERMISSION_ARTICLE);
-        $imagePaths = $this->uploadImages();
+        $imagePaths = $this->uploadImages(true);
 
         $article = new Article();
         $article->setProperties([

server/controllers/article/delete-topic.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/delete-topic Delete topic
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete topic
  *

server/controllers/article/delete.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/delete Delete article
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete article
  *

server/controllers/article/edit-topic.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/edit-topic Edit topic
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit topic
  *

server/controllers/article/edit.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/edit Edit article
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit a article
  *
@@ -19,9 +19,12 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {String} content The new content of the article. Optional.
  * @apiParam {String} title The new title of the article. Optional.
  * @apiParam {Number} position The new position of the article. Optional.
+ * @apiParam {Number} images The number of images in the content
+ * @apiParam image_i The image file of index `i` (mutiple params accepted)
  *
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_TOPIC
+ * @apiUse INVALID_FILE
  *
  * @apiSuccess {Object} data Empty object
  *
@@ -62,7 +65,7 @@ class EditArticleController extends Controller {
             $fileUploader->setPermission(FileManager::PERMISSION_ARTICLE);
 
             $content = Controller::request('content', true);
-            $imagePaths = $this->uploadImages();
+            $imagePaths = $this->uploadImages(true);
 
             $article->content = $this->replaceWithImagePaths($imagePaths, $content);
         }

server/controllers/article/get-all.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /article/get-all Get all articles
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get all articles
  *

server/controllers/staff/add.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /staff/add Add staff
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add staff
  *

server/controllers/staff/assign-ticket.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /staff/assign-ticket Assign ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Assign ticket
  *

server/controllers/staff/delete.php

@@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /staff/delete Delete staff
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete staff
  *

server/controllers/staff/edit.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/edit Edit staff
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit staff
  *

server/controllers/staff/get-all-tickets.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/get-all-tickets Get all tickets
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get all tickets
  *

server/controllers/staff/get-all.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/get-all  Get all staffs
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get all staffs
  *

server/controllers/staff/get-new-tickets.php

@@ -4,7 +4,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/get-new-tickets Get new tickets
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get new tickets
  *

server/controllers/staff/get-tickets.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/get-tickets Get tickets
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get tickets
  *

server/controllers/staff/get.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /staff/get Get staff
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get staff
  *

server/controllers/staff/last-events.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/last-events Get last events
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get last events
  *

server/controllers/staff/search-tickets.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /staff/search-tickets Search tickets
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Search tickets
  *

server/controllers/staff/un-assign-ticket.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /staff/un-assign-ticket Un-assign ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Un-assign ticket
  *

server/controllers/system/add-api-key.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/add-api-key Add APIKey
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add APIKey
  *

server/controllers/system/add-department.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/add-department Add department
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add department
  *

server/controllers/system/backup-database.php

@@ -3,7 +3,7 @@ use Ifsnop\Mysqldump as IMysqldump;
 
 /**
  * @api {post} /system/backup-database Backup database
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Backup database
  *

server/controllers/system/check-requirements.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/check-requirements Checks requirements
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Check requirements
  *

server/controllers/system/csv-import.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/csv-import CSV import
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName CSV import
  *

server/controllers/system/delete-all-users.php

@@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /system/delete-all-users Delete all users
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete all users
  *

server/controllers/system/delete-api-key.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/delete-api-key Delete APIKey
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete APIKey
  *

server/controllers/system/delete-department.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /system/delete-department Delete department
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete department
  *

server/controllers/system/disable-registration.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/disable-registration Disable registration
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Disable registration
  *

server/controllers/system/disable-user-system.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/disable-user-system Disable user system
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Disable user system
  *

server/controllers/system/download.php

@@ -4,7 +4,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {get} /system/download Download file
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Download file
  *

server/controllers/system/edit-department.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /system/edit-department Edit department
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit department
  *

server/controllers/system/edit-mail-template.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/edit-mail-template Edit mail template
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit mail template
  *

server/controllers/system/edit-settings.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/edit-settings Edit settings
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit settings
  *

server/controllers/system/enable-registration.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/enable-registration Enable registration
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Enable registration 
  *

server/controllers/system/enable-user-system.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/enable-user-system Enable user system
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Enable user system
  *

server/controllers/system/get-api-keys.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/get-api-keys Get APIKeys
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get APIKeys
  *

server/controllers/system/get-logs.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/get-logs Get logs
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get logs
  *

server/controllers/system/get-mail-templates.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/get-mail-templates Get mail templates
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get mail templates
  *

server/controllers/system/get-settings.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /system/get-settings Get settings
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get settings
  *

server/controllers/system/get-stats.php

@@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /system/get-stats Get stats
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get stats
  *

server/controllers/system/init-admin.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /system/init-admin Init admin
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Init admin
  *

server/controllers/system/init-database.php

@@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /system/init-database Init database
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Init database
  *

server/controllers/system/init-settings.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /system/init-settings Init settings
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Init settings
  *

server/controllers/system/installation-done.php

@@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /system/installation-done Installation done
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Installation done
  *

server/controllers/system/recover-mail-template.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/recover-mail-template Recover mail template
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Recover mail template
  *

server/controllers/system/test-smtp.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /system/test-smtp Test SMTP Connection
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Test SMTP Connection
  *

server/controllers/ticket/add-custom-response.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/add-custom-response Add custom responses
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Add a custom response
  *

server/controllers/ticket/change-department.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/change-department Change department
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Change department
  *

server/controllers/ticket/change-priority.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /ticket/change-priority Change priority
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Change priority
  *

server/controllers/ticket/check.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/check Check ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Check ticket
  *

server/controllers/ticket/close.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/close Close ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Close
  *

server/controllers/ticket/comment.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/comment Comment ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Comment ticket
  *
@@ -16,11 +16,15 @@ DataValidator::with('CustomValidations', true);
  *
  * @apiParam {String} content Content of the comment.
  * @apiParam {Number} ticketNumber The number of the ticket to comment.
+ * @apiParam {Number} images The number of images in the content
+ * @apiParam image_i The image file of index `i` (mutiple params accepted)
+ * @apiParam file The file you with to upload.
  *
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_TICKET
  * @apiUse INVALID_TOKEN
+ * @apiUse INVALID_FILE
  *
  * @apiSuccess {Object} data Empty object
  *
@@ -107,8 +111,8 @@ class CommentController extends Controller {
     private function storeComment() {
         $fileUploader = FileUploader::getInstance();
         $fileUploader->setPermission(FileManager::PERMISSION_TICKET, $this->ticket->ticketNumber);
-        $imagePaths = $this->uploadImages();
-        $fileUploader = $this->uploadFile();
+        $imagePaths = $this->uploadImages(Controller::isStaffLogged());
+        $fileUploader = $this->uploadFile(Controller::isStaffLogged());
 
         $comment = Ticketevent::getEvent(Ticketevent::COMMENT);
         $comment->setProperties(array(

server/controllers/ticket/create.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/create Create ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Create ticket
  *
@@ -19,15 +19,18 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {Number} departmentId The id of the department of the current ticket.
  * @apiParam {String} language The language of the ticket.
  * @apiParam {String} email The email of the user who created the ticket.
- * @apiParam {String} name The Name of the author of the ticket.
+ * @apiParam {Number} images The number of images in the content
+ * @apiParam image_i The image file of index `i` (mutiple params accepted)
+ * @apiParam file The file you with to upload.
  *
- * @apiUse NO_PERMISSION$ticketNumber
+ * @apiUse NO_PERMISSION
  * @apiUse INVALID_TITLE
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_DEPARTMENT
  * @apiUse INVALID_LANGUAGE
  * @apiUse INVALID_CAPTCHA
  * @apiUse INVALID_EMAIL
+ * @apiUse INVALID_FILE
  *
  * @apiSuccess {Object} data Information of the new ticket
  * @apiSuccess {Number} data.ticketNumber Number of the new ticket
@@ -123,8 +126,8 @@ class CreateController extends Controller {
         $fileUploader = FileUploader::getInstance();
         $fileUploader->setPermission(FileManager::PERMISSION_TICKET, $ticket->generateUniqueTicketNumber());
 
-        $imagePaths = $this->uploadImages();
-        $fileUploader = $this->uploadFile();
+        $imagePaths = $this->uploadImages(Controller::isStaffLogged());
+        $fileUploader = $this->uploadFile(Controller::isStaffLogged());
 
         $ticket->setProperties(array(
             'title' => $this->title,

server/controllers/ticket/delete-custom-response.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/delete-custom-response Delete custom response
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete custom response
  *

server/controllers/ticket/edit-custom-response.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/edit-custom-response Edit custom response
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit custom response
  *

server/controllers/ticket/get-custom-responses.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /ticket/get-custom-responses Get custom responses
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get custom responses
  *

server/controllers/ticket/get.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 DataValidator::with('CustomValidations', true);
 /**
  * @api {post} /ticket/get Get ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get ticket
  *

server/controllers/ticket/re-open.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /ticket/re-open Reopen ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Reopen ticket
  *

server/controllers/ticket/seen.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /ticket/seen See ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName See ticket
  *

server/controllers/user/ban.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/ban Ban email
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Ban email
  *

server/controllers/user/check-session.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /user/check-session Check session
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Check session
  *

server/controllers/user/delete.php

@@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {post} /user/delete Delete user
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Delete user
  *

server/controllers/user/edit-email.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/edit-email Edit email
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit email
  *

server/controllers/user/edit-password.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/edit-password Edit password
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Edit password
  *

server/controllers/user/get-user.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /user/get-user Get user information
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get user information
  *

server/controllers/user/get-users.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/get-users Get users list
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get users list
  *

server/controllers/user/get.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /user/get Get my information
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get my Information
  *

server/controllers/user/list-ban.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/list-ban Get ban list
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Get ban list
  *

server/controllers/user/login.php

@@ -2,7 +2,7 @@
 
 /**
  * @api {post} /user/login Login
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Login
  *

server/controllers/user/logout.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {post} /user/logout Log out
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Log out 
  *

server/controllers/user/recover-password.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /user/recover-password Recover password
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Recover password
  *

server/controllers/user/send-recover-password.php

@@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /user/send-recover-password Send password recovery
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Send password recovery
  *

server/controllers/user/signup.php

@@ -5,7 +5,7 @@ DataValidator::with('CustomValidations', true);
 
 /**
  * @api {post} /user/signup Sign up
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Sign up
  *

server/controllers/user/un-ban.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/un-ban Un ban
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Un ban
  *

server/controllers/user/verify.php

@@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
 
 /**
  * @api {post} /user/verify Verify email
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  *
  * @apiName Verify email
  *

server/data/ERRORS.php

@@ -161,7 +161,7 @@
  */
 /**
  * @apiDefine INVALID_FILE
- * @apiError {String} INVALID_FILE The file is invalid.
+ * @apiError {String} INVALID_FILE The file is invalid or max size exceeded.
  */
 /**
  * @apiDefine DATABASE_CONNECTION

server/libs/Controller.php

@@ -95,11 +95,12 @@ abstract class Controller {
         return \Slim\Slim::getInstance();
     }
 
-    public function uploadImages() {
+    public function uploadImages($forceUpload = false) {
         $allowAttachments = Setting::getSetting('allow-attachments')->getValue();
         $totalImages = Controller::request('images') * 1;
 
-        if(!$totalImages || (!$allowAttachments && !$forceUpload)) return '';
+        if(!$allowAttachments && !$forceUpload) return [];
+        if(!$totalImages) return [];
 
         $maxSize = Setting::getSetting('max-size')->getValue();
         $fileGap = Setting::getSetting('file-gap')->getValue();
@@ -133,7 +134,8 @@ abstract class Controller {
     public function uploadFile($forceUpload = false) {
         $allowAttachments = Setting::getSetting('allow-attachments')->getValue();
 
-        if(!isset($_FILES['file']) || (!$allowAttachments && !$forceUpload)) return '';
+        if(!$allowAttachments && !$forceUpload) return '';
+        if(!isset($_FILES['file'])) return '';
 
         $maxSize = Setting::getSetting('max-size')->getValue();
         $fileGap = Setting::getSetting('file-gap')->getValue();

server/models/APIKey.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} APIKey APIKey
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String} name Name of the APIKey.
  * @apiParam {String} token Token of the APIKey.

server/models/Article.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Article Article
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number} id Id of the article.
  * @apiParam {String} title Title of the article.

server/models/Ban.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Ban Ban
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Email} email The email address that is banned.
  */

server/models/CustomResponse.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} CustomResponse CustomResponse
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number} id Id of the custom response.
  * @apiParam {String} content Content of the custom response.

server/models/Department.php

@@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {OBJECT} Department Department
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number} id Id of the department.
  * @apiParam {String} name Name of the department.

server/models/Log.php

@@ -2,7 +2,7 @@
 use RedBeanPHP\Facade as RedBean;
 /**
  * @api {OBJECT} Log Log
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String} type The type of the log.
  * @apiParam {String} to Object where the action was performed.

server/models/MailTemplate.php

@@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {OBJECT} MailTemplate MailTemplate
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String} type The type of the mail template.
  * @apiParam {String} subject The subject of the mail template.

server/models/Staff.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Staff Staff
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String} name Name of the staff member.
  * @apiParam {String} email Email of the staff member.

server/models/Stat.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Stat Stat
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number} date The date of the stat as a number in format YYYYMMDD.
  * @apiParam {String} type The type of the stat. It can be CREATE_TICKET, CLOSE, SIGNUP, COMMENT, ASSIGN or UNASSIGN

server/models/Ticket.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Ticket Ticket
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number}  ticketNumber The number of the ticket.
  * @apiParam {String}  title The title of the ticket.

server/models/Ticketevent.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} TicketEvent TicketEvent
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String}  type The type of the ticket event. It can be COMMENT, ASSIGN, UN_ASSIGN, CLOSE, RE_OPEN, DEPARTMENT_CHANGED or PRIORITY_CHANGED
  * @apiParam {String}  content The content of the ticket event.

server/models/Topic.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @api {OBJECT} Topic Topic
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {Number} id Id of the topic.
  * @apiParam {String} name Name of the topic.

server/models/User.php

@@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
 
 /**
  * @api {OBJECT} User User
- * @apiVersion 4.2.0
+ * @apiVersion 4.3.0
  * @apiGroup Data Structures
  * @apiParam {String} email The email of the user.
  * @apiParam {Number} id The id of the user.