File Controller/Front/FrontController.php | Alpha Framework 3.0.0 API Documentation

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

<?php

namespace Alpha\Controller\Front;

use Alpha\Util\Logging\Logger;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Security\SecurityUtils;
use Alpha\Util\Http\Filter\FilterInterface;
use Alpha\Util\Http\Response;
use Alpha\Util\Http\Request;
use Alpha\Exception\BadRequestException;
use Alpha\Exception\ResourceNotFoundException;
use Alpha\Exception\IllegalArguementException;
use Alpha\Exception\AlphaException;
use Alpha\Controller\Controller;
use Alpha\Controller\ArticleController;
use Alpha\Controller\AttachmentController;
use Alpha\Controller\CacheController;
use Alpha\Controller\DEnumController;
use Alpha\Controller\ExcelController;
use Alpha\Controller\FeedController;
use Alpha\Controller\GenSecureQueryStringController;
use Alpha\Controller\ImageController;
use Alpha\Controller\ListActiveRecordsController;
use Alpha\Controller\LogController;
use Alpha\Controller\LoginController;
use Alpha\Controller\LogoutController;
use Alpha\Controller\MetricController;
use Alpha\Controller\RecordSelectorController;
use Alpha\Controller\SearchController;
use Alpha\Controller\SequenceController;
use Alpha\Controller\TagController;
use Alpha\Controller\IndexController;
use Alpha\Controller\InstallController;
use Alpha\Controller\ActiveRecordController;
use Alpha\Controller\PhpinfoController;

/**
 * The front controller designed to optionally handle all requests.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * * Neither the name of the Alpha Framework nor the names
 *   of its contributors may be used to endorse or promote
 *   products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * </pre>
 */
class FrontController
{
    /**
     * The GET query string.
     *
     * @var string
     *
     * @since 1.0
     */
    private $queryString;

    /**
     * The name of the page controller we want to invoke.
     *
     * @var string
     *
     * @since 1.0
     */
    private $pageController;

    /**
     * Boolean to flag if the GET query string is encrypted or not.
     *
     * @var bool
     *
     * @since 1.0
     */
    private $encryptedQuery = false;

    /**
     * An array of HTTP filters applied to each request to the front controller.  Each
     * member must implement FilterInterface!
     *
     * @var array
     *
     * @since 1.0
     */
    private $filters = array();

    /**
     * An associative array of URIs to callable methods to service matching requests.
     *
     * @var array
     *
     * @since 2.0
     */
    private $routes;

    /**
     * The route for the current request.
     *
     * @var string
     *
     * @since 2.0
     */
    private $currentRoute;

    /**
     * An optional 2D hash array of default request parameter values to use when those params are left off the request.
     *
     * @var array
     *
     * @since 2.0
     */
    private $defaultParamValues;

    /**
     * Trace logger.
     *
     * @var \Alpha\Util\Logging\Logger
     *
     * @since 1.0
     */
    private static $logger = null;

    /**
     * The constructor method.
     *
     * @throws \Alpha\Exception\BadRequestException
     *
     * @since 1.0
     */
    public function __construct()
    {
        self::$logger = new Logger('FrontController');

        self::$logger->debug('>>__construct()');

        $config = ConfigProvider::getInstance();

        mb_internal_encoding('UTF-8');
        mb_http_output('UTF-8');
        mb_http_input('UTF-8');
        if (!mb_check_encoding()) {
            throw new BadRequestException('Request character encoding does not match expected UTF-8');
        }

        $this->addRoute('/', function ($request) {
            $controller = new IndexController();

            return $controller->process($request);
        });

        $this->addRoute('/a/{title}/{view}', function ($request) {
            $controller = new ArticleController();

            return $controller->process($request);
        })->value('title', null)->value('view', 'detailed');

        $this->addRoute('/articles/{start}/{limit}', function ($request) {
            $controller = new ArticleController();

            return $controller->process($request);
        })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));

        $this->addRoute('/attach/{articleID}/{filename}', function ($request) {
            $controller = new AttachmentController();

            return $controller->process($request);
        })->value('filename', null);

        $this->addRoute('/cache', function ($request) {
            $controller = new CacheController();

            return $controller->process($request);
        });

        $this->addRoute('/denum/{denumID}', function ($request) {
            $controller = new DEnumController();

            return $controller->process($request);
        })->value('denumID', null);

        $this->addRoute('/excel/{ActiveRecordType}/{ActiveRecordID}', function ($request) {
            $controller = new ExcelController();

            return $controller->process($request);
        })->value('ActiveRecordID', null);

        $this->addRoute('/feed/{ActiveRecordType}/{type}', function ($request) {
            $controller = new FeedController();

            return $controller->process($request);
        })->value('type', 'Atom');

        $this->addRoute('/gensecure', function ($request) {
            $controller = new GenSecureQueryStringController();

            return $controller->process($request);
        });

        $this->addRoute('/image/{source}/{width}/{height}/{type}/{quality}/{scale}/{secure}/{var1}/{var2}', function ($request) {
            $controller = new ImageController();

            return $controller->process($request);
        })->value('var1', null)->value('var2', null);

        $this->addRoute('/listactiverecords', function ($request) {
            $controller = new ListActiveRecordsController();

            return $controller->process($request);
        });

        $this->addRoute('/log/{logPath}', function ($request) {
            $controller = new LogController();

            return $controller->process($request);
        });

        $this->addRoute('/login', function ($request) {
            $controller = new LoginController();

            return $controller->process($request);
        });

        $this->addRoute('/logout', function ($request) {
            $controller = new LogoutController();

            return $controller->process($request);
        });

        $this->addRoute('/metric', function ($request) {
            $controller = new MetricController();

            return $controller->process($request);
        });

        $this->addRoute('/recordselector/12m/{ActiveRecordID}/{field}/{relatedClass}/{relatedClassField}/{relatedClassDisplayField}/{relationType}', function ($request) {
            $controller = new RecordSelectorController();

            return $controller->process($request);
        })->value('relationType', 'ONE-TO-MANY');

        $this->addRoute('/recordselector/m2m/{ActiveRecordID}/{field}/{relatedClassLeft}/{relatedClassLeftDisplayField}/{relatedClassRight}/{relatedClassRightDisplayField}/{accessingClassName}/{lookupIDs}/{relationType}', function ($request) {
            $controller = new RecordSelectorController();

            return $controller->process($request);
        })->value('relationType', 'MANY-TO-MANY');

        $this->addRoute('/search/{query}/{start}/{limit}', function ($request) {
            $controller = new SearchController();

            return $controller->process($request);
        })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));

        $this->addRoute('/sequence/{start}/{limit}', function ($request) {
            $controller = new SequenceController();

            return $controller->process($request);
        })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));

        $this->addRoute('/tag/{ActiveRecordType}/{ActiveRecordID}', function ($request) {
            $controller = new TagController();

            return $controller->process($request);
        });

        $this->addRoute('/install', function ($request) {
            $controller = new InstallController();

            return $controller->process($request);
        });

        $this->addRoute('/record/{ActiveRecordType}/{ActiveRecordID}/{view}', function ($request) {
            $controller = new ActiveRecordController();

            return $controller->process($request);
        })->value('ActiveRecordID', null)->value('view', 'detailed');

        $this->addRoute('/records/{ActiveRecordType}/{start}/{limit}', function ($request) {
            $controller = new ActiveRecordController();

            return $controller->process($request);
        })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));

        $this->addRoute('/tk/{token}', function ($request) {
            $params = self::getDecodeQueryParams($request->getParam('token'));

            if (isset($params['act'])) {
                $className = $params['act'];

                if (class_exists($className)) {
                    $controller = new $className();

                    if (isset($params['ActiveRecordType']) && $params['act'] == 'Alpha\Controller\ActiveRecordController') {
                        $customController = $controller->getCustomControllerName($params['ActiveRecordType']);
                        if ($customController != null) {
                            $controller = new $customController();
                        }
                    }

                    $request->setParams(array_merge($params, $request->getParams()));

                    return $controller->process($request);
                }
            }

            self::$logger->warn('Bad params ['.print_r($params, true).'] provided on a /tk/ request');

            return new Response(404, 'Resource not found');
        });

        $this->addRoute('/alpha/service', function ($request) {
            $controller = new LoginController();
            $controller->setUnitOfWork(array('Alpha\Controller\LoginController', 'Alpha\Controller\ListActiveRecordsController'));

            return $controller->process($request);
        });

        $this->addRoute('/phpinfo', function ($request) {
            $controller = new PhpinfoController();

            return $controller->process($request);
        });

        self::$logger->debug('<<__construct');
    }

    /**
     * Sets the encryption flag.
     *
     * @param bool $encryptedQuery
     *
     * @since 1.0
     */
    public function setEncrypt($encryptedQuery)
    {
        $this->encryptedQuery = $encryptedQuery;
    }

    /**
     * Static method for generating an absolute, secure URL for a page controller.
     *
     * @param string $params
     *
     * @return string
     *
     * @since 1.0
     */
    public static function generateSecureURL($params)
    {
        $config = ConfigProvider::getInstance();

        if ($config->get('app.use.pretty.urls')) {
            return $config->get('app.url').'/tk/'.self::encodeQuery($params);
        } else {
            return $config->get('app.url').'?tk='.self::encodeQuery($params);
        }
    }

    /**
     * Static method for encoding a query string.
     *
     * @param string $queryString
     *
     * @return string
     *
     * @since 1.0
     */
    public static function encodeQuery($queryString)
    {
        $return = base64_encode(SecurityUtils::encrypt($queryString));
        // remove any characters that are likely to cause trouble on a URL
        $return = strtr($return, '+/', '-_');

        return $return;
    }

    /**
     * Static method to return the decoded GET paramters from an encrytpted tk value.
     *
     * @return string
     *
     * @since 1.0
     */
    public static function decodeQueryParams($tk)
    {
        // replace any troublesome characters from the URL with the original values
        $token = strtr($tk, '-_', '+/');
        $token = base64_decode($token);
        $params = SecurityUtils::decrypt($token);

        return $params;
    }

    /**
     * Static method to return the decoded GET paramters from an encrytpted tk value as an array of key/value pairs.
     *
     * @return array
     *
     * @since 1.0
     */
    public static function getDecodeQueryParams($tk)
    {
        // replace any troublesome characters from the URL with the original values
        $token = strtr($tk, '-_', '+/');
        $token = base64_decode($token);
        $params = SecurityUtils::decrypt($token);

        $pairs = explode('&', $params);

        $parameters = array();

        foreach ($pairs as $pair) {
            $split = explode('=', $pair);
            $parameters[$split[0]] = $split[1];
        }

        return $parameters;
    }

    /**
     * Getter for the page controller.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getPageController()
    {
        return $this->pageController;
    }

    /**
     * Add the supplied filter object to the list of filters ran on each request to the front controller.
     *
     * @param \Alpha\Util\Http\Filter\FilterInterface $filterObject
     *
     * @throws \Alpha\Exception\IllegalArguementException
     *
     * @since 1.0
     */
    public function registerFilter($filterObject)
    {
        if ($filterObject instanceof FilterInterface) {
            array_push($this->filters, $filterObject);
        } else {
            throw new IllegalArguementException('Supplied filter object is not a valid FilterInterface instance!');
        }
    }

    /**
     * Returns the array of filters currently attached to this FrontController.
     *
     * @return array
     *
     * @since 1.0
     */
    public function getFilters()
    {
        return $this->filters;
    }

    /**
     * Add a new route to map a URI to the callback that will service its requests,
     * normally by invoking a controller class.
     *
     * @param string   $URI      The URL to match, can include params within curly {} braces.
     * @param callable $callback The method to service the matched requests (should return a Response!).
     *
     * @throws \Alpha\Exception\IllegalArguementException
     *
     * @return \Alpha\Controller\Front\FrontController
     *
     * @since 2.0
     */
    public function addRoute($URI, $callback)
    {
        if (is_callable($callback)) {
            $this->routes[$URI] = $callback;
            $this->currentRoute = $URI;

            return $this;
        } else {
            throw new IllegalArguementException('Callback provided for route ['.$URI.'] is not callable');
        }
    }

    /**
     * Method to allow the setting of default request param values to be used when they are left off the request URI.
     *
     * @param string $param        The param name (as defined on the route between {} braces)
     * @param mixed  $defaultValue The value to use
     *
     * @return \Alpha\Controller\Front\FrontController
     *
     * @since 2.0
     */
    public function value($param, $defaultValue)
    {
        $this->defaultParamValues[$this->currentRoute][$param] = $defaultValue;

        return $this;
    }

    /**
     * Get the defined callback in the routes array for the URI provided.
     *
     * @param string $URI The URI to search for.
     *
     * @return callable
     *
     * @throws \Alpha\Exception\IllegalArguementException
     *
     * @since 2.0
     */
    public function getRouteCallback($URI)
    {
        if (array_key_exists($URI, $this->routes)) { // direct hit due to URL containing no params
            $this->currentRoute = $URI;

            return $this->routes[$URI];
        } else { // we need to use a regex to match URIs with params

            // route URIs with params provided to callback
            foreach ($this->routes as $route => $callback) {
                $pattern = '#^'.$route.'$#s';
                $pattern = preg_replace('#\{\S+\}#', '\S+', $pattern);

                if (preg_match($pattern, $URI)) {
                    $this->currentRoute = $route;

                    return $callback;
                }
            }

                // route URIs with params missing (will attempt to layer on defaults later on in Request class)
            foreach ($this->routes as $route => $callback) {
                $pattern = '#^'.$route.'$#s';
                $pattern = preg_replace('#\/\{\S+\}#', '\/?', $pattern);

                if (preg_match($pattern, $URI)) {
                    $this->currentRoute = $route;

                    return $callback;
                }
            }
        }

        // if we made it this far then no match was found
        throw new IllegalArguementException('No callback defined for URI ['.$URI.']');
    }

    /**
     * Processes the supplied request by invoking the callable defined matching the request's URI.
     *
     * @param \Alpha\Util\Http\Request $request The request to process
     *
     * @return \Alpha\Util\Http\Response
     *
     * @throws \Alpha\Exception\ResourceNotFoundException
     * @throws \Alpha\Exception\ResourceNotAllowedException
     * @throws \Alpha\Exception\AlphaException
     *
     * @since 2.0
     */
    public function process($request)
    {
        foreach ($this->filters as $filter) {
            $filter->process($request);
        }

        try {
            $callback = $this->getRouteCallback($request->getURI());
        } catch (IllegalArguementException $e) {
            self::$logger->info($e->getMessage());
            throw new ResourceNotFoundException('Resource not found');
        }

        if ($request->getURI() != $this->currentRoute) {
            if (isset($this->defaultParamValues[$this->currentRoute])) {
                $request->parseParamsFromRoute($this->currentRoute, $this->defaultParamValues[$this->currentRoute]);
            } else {
                $request->parseParamsFromRoute($this->currentRoute);
            }
        }

        try {
            $response = call_user_func($callback, $request);
        } catch (ResourceNotFoundException $rnfe) {
            self::$logger->info('ResourceNotFoundException throw, source message ['.$rnfe->getMessage().']');

            return new Response(404, $rnfe->getMessage());
        }

        if ($response instanceof Response) {
            return $response;
        } else {
            self::$logger->error('The callable defined for route ['.$request->getURI().'] does not return a Response object');
            throw new AlphaException('Unable to process request');
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions