xNightR00T File Manager

<?php

namespace ZendServer\Filter\Controller;

use WebAPI\Exception;
use ZendServer\Mvc\Controller\WebAPIActionController;
use ZendServer\Filter\Filter;
use ZendServer\Filter\Factory;
use ZendServer\Filter\Mapper;
use WebAPI;
use ZendServer\Log\Log;
use Zend\Json\Json;
use Zend\View\Model\ViewModel;

class WebAPIController extends WebAPIActionController
{
    protected $mapper = null;

    /**
     * Save a filter.
     * 
     * @api
     * @method POST
     * @version 1.3
     * @section Configuration and Management
     * @name filterSave
     * @url https://docs.roguewave.com/en/zend/Zend-Server/content/the_filtersave_method.htm
     * @permissions Read-Only
     * @editions Zend Server
     * @param Integer id Optional. ID of a filter.
     * @param String type Required. Type of a filter (issue,job)
     * @param String name Required. Name of filter. Name must be unique for a specific type of filter.
     * @param Array data Optional. Array of parameters to be saved.
     * @response {
            "filter": {
                "id": "7",
                "name": "audit_test",
                "type": "audit",
                "custom": "1",
                "data": {
                    "timeRange": {
                        "predefined": "All"
                    },
                    "outcome": "0"
                }
            }
        }
     *
     * @return \WebAPI\View\WebApiResponseContainer|\Zend\View\Model\ViewModel|array
     */
    public function filterSaveAction()
    {
        $this->isMethodPost();

        $params = $this->getParameters(array('data' => array(), 'id' => 0));
        $this->validateMandatoryParameters($params, array('type', 'name'));
        $id     = $this->validateInteger($params['id'], 'id');

        if ($this->isNameExists($params['name'], $id, $params['type'])) {
            throw new WebAPI\Exception(_t("Parameter Name '%s' must be unique for type '%s'",
                array($params['name'], $params['type'])), WebAPI\Exception::INVALID_PARAMETER);
        }

        $filterMapper = $this->getMapper();
        $filterParams = array(
            'id' => $id,
            'name' => $params['name'],
            'filter_type' => $params['type'],
            'data' => Json::encode($params['data']),
        );
        $filter       = new Filter($filterParams);
        $id           = $filterMapper->upsert($filter);
        $filterList   = $filterMapper->getById($id);

        $viewModel = new ViewModel(array('filter' => $filterList->current()));
        $viewModel->setTemplate('zend-server/web-api/filter');
        return $viewModel;
    }

    /**
     * Delete the predefined filter from the system. The filters list can be retrieved
     * using filterGetByType web API method
     * 
     * @api
     * @method GET
     * @version 1.3
     * @section Configuration and Management
     * @param string name - the name of the filter
     * @see filterGetByType
     * @response {
      "filter": {
      "id": "7",
      "name": "audit_test",
      "type": "audit",
      "custom": "1",
      "data": {
      "timeRange": {
      "predefined": "All"
      },
      "outcome": "0"
      }
      }
      }
     * 
     * @return \Zend\Stdlib\ResponseInterface
     */
    public function filterDeleteAction()
    {
        $this->isMethodPost();

        $params = $this->getParameters();
        $this->validateMandatoryParameters($params, array('name'));
        $name   = $this->validateString($params['name'], 'name');

        $filterMapper = $this->getMapper();
        $filterList   = $filterMapper->getByName($name);
        if (0 == $filterList->count()) {
            throw new Exception(_t('Requested filter was not found'), Exception::NO_SUCH_FILTER);
        }
        $filterMapper->deleteFilterByName($name);

        $viewModel = new ViewModel(array('filter' => $filterList->current()));
        $viewModel->setTemplate('zend-server/web-api/filter');
        return $viewModel;
    }

    /**
     * Retrieve and display a list of filters.
     * 
     * @api
     * @method GET
     * @version 1.3
     * @section Configuration and Management
     * @name filterGetByType
     * @url https://docs.roguewave.com/en/zend/Zend-Server/content/the_filtergetbytype_method.htm
     * @permissions Read-Only
     * @editions Zend Server
     * @param String type Required. Type of a filter (issue,job)
     * @response {
            "filters": [
                {
                    "id": "2",
                    "name": "Errors Issues",
                    "type": "issue",
                    "custom": "0",
                    "data": {
                        "eventTypes": [
                            "function-error",
                            "zend-error",
                            "java-exception",
                            "jq-job-exec-error",
                            "tracer-write-file-fail",
                            "jq-job-logical-failure",
                            "custom"
                        ]
                    }
                },
                {
                    "id": "1",
                    "name": "Performance Issues",
                    "type": "issue",
                    "custom": "0",
                    "data": {
                        "eventTypes": [
                            "function-slow-exec",
                            "request-slow-exec"
                        ]
                    }
                },
                {
                    "id": "3",
                    "name": "Resources Issues",
                    "type": "issue",
                    "custom": "0",
                    "data": {
                        "eventTypes": [
                            "request-large-mem-usage",
                            "request-relative-large-out-size",
                            "jq-job-exec-delay"
                        ]
                    }
                }
            ]
        }
     *
     * @return \WebAPI\View\WebApiResponseContainer|\Zend\View\Model\ViewModel|array
     */
    public function filterGetByTypeAction()
    {
        $this->isMethodGet();

        $params = $this->getParameters();
        $this->validateMandatoryParameters($params, array('type'));

        $this->validateType($params['type']);
        $filterList = $this->getMapper()->getByType($params['type']);
        $viewModel  = new ViewModel(array('filters' => $filterList));
        $viewModel->setTemplate('zend-server/web-api/filter-list');
        return $viewModel;
    }

    /**
     * 
     * @return \ZendServer\Filter\Mapper
     */
    private function getMapper()
    {
        if (!$this->mapper) {
            $this->mapper = $this->getLocator('ZendServer\Filter\Mapper');
        }
        return $this->mapper;
    }

    private function isNameExists($name, $id, $type)
    {
        $mapper = $this->getMapper();
        $filter = $mapper->getByTypeAndName($type, $name);
        if (count($filter) > 0 && $id != $filter->current()->getId()) {
            return true;
        }
        return false;
    }

    private function validateType($type)
    {
        if (!in_array($type, Filter::$types)) {
            throw new WebAPI\Exception(_t("Parameter '%s' should contain one of the following values (%s) ",
                array('Type', implode(',', Filter::$types))), WebAPI\Exception::INVALID_PARAMETER);
        }
    }
}