espocrm-extensions/espocrm-base
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api runner

Browse Source
This commit is contained in:
Yuri Kuznetsov
2020-07-13 12:29:11 +03:00
parent ea31174cc4
commit 1d35922155
6 changed files with 190 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/v1/index.php
+1 -2
View File
@@ -29,5 +29,4 @@
require_once('../../bootstrap.php');
$app = new \Espo\Core\Application();
$app->runApi();
(new \Espo\Core\Application())->run('api');
api/v1/portal-access/index.php
+1 -2
View File
@@ -35,5 +35,4 @@ if (!empty($_GET['portalId'])) {
$portalId = explode('/', $_SERVER['REQUEST_URI'])[count(explode('/', $_SERVER['SCRIPT_NAME'])) - 1];
}
$app = new \Espo\Core\Portal\Application($portalId);
$app->runApi();
(new \Espo\Core\Portal\Application($portalId))->run('api');
application/Espo/Core/Application.php
-102
View File
@@ -29,22 +29,11 @@
namespace Espo\Core;
use Espo\Core\Exceptions\{
Error,
};
use Espo\Core\{
ContainerConfiguration,
InjectableFactory,
Container,
ApplicationUser,
Authentication\Authentication,
Api\Auth as ApiAuth,
Api\ErrorOutput as ApiErrorOutput,
Api\RequestWrapper,
Api\ResponseWrapper,
Api\RouteProcessor,
Utils\Route,
Utils\Autoload,
Utils\Config,
Utils\Metadata,
@@ -57,17 +46,6 @@ use Espo\Core\{
Loaders\Metadata as MetadataLoader,
};
use Psr\Http\{
Message\ResponseInterface as Response,
Message\ServerRequestInterface as Request,
Server\RequestHandlerInterface as RequestHandler,
};
use Slim\{
App as SlimApp,
Factory\AppFactory as SlimAppFactory,
};
use ReflectionClass;
/**
@@ -77,10 +55,6 @@ class Application
{
protected $container;
protected $slim = null;
protected $log;
protected $loaderClassNames = [
'config' => ConfigLoader::class,
'log' => LogLoader::class,
@@ -103,63 +77,6 @@ class Application
$this->container = new Container(ContainerConfiguration::class, $this->loaderClassNames);
}
/**
* Run REST API.
*/
public function runApi()
{
$slim = $this->createSlimApp();
$slim->addRoutingMiddleware();
$crudList = array_keys($this->getConfig()->get('crud'));
$routeList = $this->getRouteList();
foreach ($routeList as $item) {
$method = strtolower($item['method']);
$route = $item['route'];
if (!in_array($method, $crudList) && $method !== 'options') {
$this->getLog()->error("Route: Method '{$method}' does not exist. Check the route '{$route}'.");
continue;
}
$slim->$method(
$route,
function (Request $request, Response $response, array $args) use ($item, $slim) {
$requestWrapped = new RequestWrapper($request, $slim->getBasePath());
$responseWrapped = new ResponseWrapper($response);
try {
$authRequired = !($item['noAuth'] ?? false);
$apiAuth = new ApiAuth($this->createAuthentication(), $authRequired);
$apiAuth->process($requestWrapped, $responseWrapped);
if (!$apiAuth->isResolved()) {
return $responseWrapped->getResponse();
}
if ($apiAuth->isResolvedUseNoAuth()) {
$this->setupSystemUser();
}
$routeProcessor = $this->getInjectableFactory()->create(RouteProcessor::class);
$routeProcessor->process($item['route'], $item['params'], $requestWrapped, $responseWrapped, $args);
} catch (\Exception $exception) {
(new ApiErrorOutput($requestWrapped))->process(
$responseWrapped, $exception, false, $item, $args
);
}
return $responseWrapped->getResponse();
}
);
}
$slim->addErrorMiddleware(false, true, true);
$slim->run();
}
/**
* Run an application through a specific runner.
* You can find runner classes in `Espo\Core\ApplicationRunners`.
@@ -255,20 +172,6 @@ class Application
return $this->container->get('config');
}
protected function createSlimApp() : SlimApp
{
$slim = SlimAppFactory::create();
$slim->setBasePath(Route::detectBasePath());
return $slim;
}
protected function createAuthentication(bool $allowAnyAccess = false) : Authentication
{
return $this->getInjectableFactory()->createWith(Authentication::class, [
'allowAnyAccess' => $allowAnyAccess,
]);
}
protected function initAutoloads()
{
$autoload = $this->getInjectableFactory()->create(Autoload::class);
@@ -287,11 +190,6 @@ class Application
}
}
protected function getRouteList() : array
{
return $this->getInjectableFactory()->create(Route::class)->getFullList();
}
/**
* Set a base path of an index file related to the application directory. Used for a portal.
*/
application/Espo/Core/ApplicationRunners/Api.php
+135
View File
@@ -0,0 +1,135 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\ApplicationRunners;
use Espo\Core\Exceptions\Error;
use Espo\Core\{
InjectableFactory,
ApplicationUser,
Authentication\Authentication,
Api\Auth as ApiAuth,
Api\ErrorOutput as ApiErrorOutput,
Api\RequestWrapper,
Api\ResponseWrapper,
Api\RouteProcessor,
Utils\Config,
Utils\Route,
};
use Slim\{
App as SlimApp,
Factory\AppFactory as SlimAppFactory,
};
use Psr\Http\{
Message\ResponseInterface as Psr7Response,
Message\ServerRequestInterface as Psr7Request,
Server\RequestHandlerInterface as Psr7RequestHandler,
};
use Exception;
/**
* Runs API.
*/
class Api implements ApplicationRunner
{
protected $injectableFactory;
protected $applicationUser;
public function __construct(InjectableFactory $injectableFactory, ApplicationUser $applicationUser, Config $config) {
$this->injectableFactory = $injectableFactory;
$this->applicationUser = $applicationUser;
$this->config = $config;
}
public function run()
{
$slim = SlimAppFactory::create();
$slim->setBasePath(Route::detectBasePath());
$slim->addRoutingMiddleware();
$crudList = array_keys($this->config->get('crud'));
$routeList = $this->getRouteList();
foreach ($routeList as $item) {
$method = strtolower($item['method']);
$route = $item['route'];
if (!in_array($method, $crudList) && $method !== 'options') {
$GLOBALS['log']->error("Route: Method '{$method}' does not exist. Check the route '{$route}'.");
continue;
}
$slim->$method(
$route,
function (Psr7Request $request, Psr7Response $response, array $args) use ($item, $slim) {
$requestWrapped = new RequestWrapper($request, $slim->getBasePath());
$responseWrapped = new ResponseWrapper($response);
try {
$authRequired = !($item['noAuth'] ?? false);
$authentication = $this->injectableFactory->create(Authentication::class);
$apiAuth = new ApiAuth($authentication, $authRequired);
$apiAuth->process($requestWrapped, $responseWrapped);
if (!$apiAuth->isResolved()) {
return $responseWrapped->getResponse();
}
if ($apiAuth->isResolvedUseNoAuth()) {
$this->applicationUser->setupSystemUser();
}
$routeProcessor = $this->injectableFactory->create(RouteProcessor::class);
$routeProcessor->process($item['route'], $item['params'], $requestWrapped, $responseWrapped, $args);
} catch (Exception $exception) {
(new ApiErrorOutput($requestWrapped))->process(
$responseWrapped, $exception, false, $item, $args
);
}
return $responseWrapped->getResponse();
}
);
}
$slim->addErrorMiddleware(false, true, true);
$slim->run();
}
protected function getRouteList() : array
{
return $this->injectableFactory->create(Route::class)->getFullList();
}
}
application/Espo/Core/Portal/Application.php
-16
View File
@@ -94,22 +94,6 @@ class Application extends BaseApplication
return $this->portal;
}
protected function getRouteList() : array
{
$routeList = parent::getRouteList();
foreach ($routeList as $i => $route) {
if (isset($route['route'])) {
if ($route['route']{0} !== '/') {
$route['route'] = '/' . $route['route'];
}
$route['route'] = '/{portalId}' . $route['route'];
}
$routeList[$i] = $route;
}
return $routeList;
}
protected function getRunnerClassName(string $runnerName) : ?string
{
$className = 'Espo\\Core\\Portal\\ApplicationRunners\\' . ucfirst($runnerName);
application/Espo/Core/Portal/ApplicationRunners/Api.php
+53
View File
@@ -0,0 +1,53 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Portal\ApplicationRunners;
use Espo\Core\{
ApplicationRunners\Api as ApiBase,
};
class Api extends ApiBase
{
protected function getRouteList() : array
{
$routeList = parent::getRouteList();
foreach ($routeList as $i => $route) {
if (isset($route['route'])) {
if ($route['route']{0} !== '/') {
$route['route'] = '/' . $route['route'];
}
$route['route'] = '/{portalId}' . $route['route'];
}
$routeList[$i] = $route;
}
return $routeList;
}
}