Some progress toward better structure through refactoring
This commit is contained in:
parent
8904054212
commit
cee211621c
20
.editorconfig
Normal file
20
.editorconfig
Normal file
@ -0,0 +1,20 @@
|
||||
# EditorConfig is awesome: http://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style newlines with a newline ending every file
|
||||
[*]
|
||||
end_of_line = lf
|
||||
insert_final_newline = false
|
||||
charset = utf-8
|
||||
indent_style = tab
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.{cpp,c,h,hpp,cxx}]
|
||||
insert_final_newline = true
|
||||
|
||||
# Yaml files
|
||||
[*.{yml,yaml}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
@ -2,7 +2,7 @@
|
||||
/**
|
||||
* Base API Model
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
use \GuzzleHttp\Client;
|
||||
use \GuzzleHttp\Cookie\CookieJar;
|
||||
@ -10,7 +10,7 @@ use \GuzzleHttp\Cookie\CookieJar;
|
||||
/**
|
||||
* Base model for api interaction
|
||||
*/
|
||||
class BaseApiModel extends BaseModel {
|
||||
class ApiModel extends Model {
|
||||
|
||||
/**
|
||||
* Base url for making api requests
|
||||
@ -1,6 +1,9 @@
|
||||
<?php
|
||||
/**
|
||||
* Base Configuration class
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
/**
|
||||
* Wrapper for configuration values
|
||||
@ -58,7 +61,7 @@ class Config {
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function asset_url(/*...*/)
|
||||
public function asset_url(/*...*/)
|
||||
{
|
||||
$args = func_get_args();
|
||||
$base_url = rtrim($this->__get('asset_path'), '/');
|
||||
@ -74,7 +77,7 @@ class Config {
|
||||
* @param string $type - (optional) The controller
|
||||
* @return string
|
||||
*/
|
||||
function base_url($type="anime")
|
||||
public function base_url($type="anime")
|
||||
{
|
||||
$config_path = trim($this->__get("{$type}_path"), "/");
|
||||
$config_host = $this->__get("{$type}_host");
|
||||
@ -93,7 +96,7 @@ class Config {
|
||||
* @param string $type - (optional) The controller (anime or manga), defaults to anime
|
||||
* @return string
|
||||
*/
|
||||
function full_url($path="", $type="anime")
|
||||
public function full_url($path="", $type="anime")
|
||||
{
|
||||
$config_path = trim($this->__get("{$type}_path"), "/");
|
||||
$config_host = $this->__get("{$type}_host");
|
||||
@ -2,14 +2,14 @@
|
||||
/**
|
||||
* Base Controller
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
use Aura\Web\WebFactory;
|
||||
|
||||
/**
|
||||
* Base class for controllers, defines output methods
|
||||
*/
|
||||
class BaseController {
|
||||
class Controller {
|
||||
|
||||
/**
|
||||
* The global configuration object
|
||||
@ -2,12 +2,12 @@
|
||||
/**
|
||||
* Base DB model
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
/**
|
||||
* Base model for database interaction
|
||||
*/
|
||||
class BaseDBModel extends BaseModel {
|
||||
class DBModel extends Model {
|
||||
/**
|
||||
* The query builder object
|
||||
* @var object $db
|
||||
@ -2,14 +2,14 @@
|
||||
/**
|
||||
* Base for base models
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
use abeautifulsite\SimpleImage;
|
||||
|
||||
/**
|
||||
* Common base for all Models
|
||||
*/
|
||||
class BaseModel {
|
||||
class Model {
|
||||
|
||||
/**
|
||||
* The global configuration object
|
||||
@ -3,7 +3,7 @@
|
||||
* Routing logic
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
/**
|
||||
* Basic routing/ dispatch
|
||||
@ -68,9 +68,9 @@ class Router {
|
||||
$route_path = str_replace([$this->config->anime_path, $this->config->manga_path], '', $raw_route);
|
||||
$route_path = "/" . trim($route_path, '/');
|
||||
|
||||
$defaultHandler->addDataTable('Route Info', [
|
||||
/*$defaultHandler->addDataTable('Route Info', [
|
||||
'route_path' => $route_path
|
||||
]);
|
||||
]);*/
|
||||
|
||||
$route = $this->router->match($route_path, $_SERVER);
|
||||
|
||||
@ -107,15 +107,6 @@ class Router {
|
||||
{
|
||||
$failure = $this->router->getFailedRoute();
|
||||
$defaultHandler->addDataTable('failed_route', (array)$failure);
|
||||
|
||||
/*$controller_name = '\\AnimeClient\\BaseController';
|
||||
$action_method = 'outputHTML';
|
||||
$params = [
|
||||
'template' => '404',
|
||||
'data' => [
|
||||
'title' => 'Page Not Found'
|
||||
]
|
||||
];*/
|
||||
}
|
||||
else
|
||||
{
|
||||
@ -194,8 +185,8 @@ class Router {
|
||||
public function _setup_routes()
|
||||
{
|
||||
$route_map = [
|
||||
'anime' => '\\AnimeClient\\AnimeController',
|
||||
'manga' => '\\AnimeClient\\MangaController',
|
||||
'anime' => '\\AnimeClient\\Controller\\Anime',
|
||||
'manga' => '\\AnimeClient\\Controller\\Manga',
|
||||
];
|
||||
|
||||
$output_routes = [];
|
||||
@ -26,18 +26,13 @@ function _setup_autoloaders()
|
||||
require _dir(ROOT_DIR, '/vendor/autoload.php');
|
||||
spl_autoload_register(function ($class) {
|
||||
$class_parts = explode('\\', $class);
|
||||
$class = end($class_parts);
|
||||
array_shift($class_parts);
|
||||
$ns_path = APP_DIR . '/' . implode('/', $class_parts) . ".php";
|
||||
|
||||
$dirs = ["base", "controllers", "models"];
|
||||
|
||||
foreach($dirs as $dir)
|
||||
if (file_exists($ns_path))
|
||||
{
|
||||
$file = _dir(APP_DIR, $dir, "{$class}.php");
|
||||
if (file_exists($file))
|
||||
{
|
||||
require_once $file;
|
||||
return;
|
||||
}
|
||||
require_once($ns_path);
|
||||
return;
|
||||
}
|
||||
});
|
||||
}
|
||||
@ -3,12 +3,17 @@
|
||||
* Anime Controller
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Controller;
|
||||
|
||||
use AnimeClient\Base\Controller as BaseController;
|
||||
use AnimeClient\Base\Config;
|
||||
use AnimeClient\Model\Anime as AnimeModel;
|
||||
use AnimeClient\Model\AnimeCollection as AnimeCollectionModel;
|
||||
|
||||
/**
|
||||
* Controller for Anime-related pages
|
||||
*/
|
||||
class AnimeController extends BaseController {
|
||||
class Anime extends BaseController {
|
||||
|
||||
/**
|
||||
* The anime list model
|
||||
@ -2,12 +2,16 @@
|
||||
/**
|
||||
* Manga Controller
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Controller;
|
||||
|
||||
use AnimeClient\Base\Controller;
|
||||
use AnimeClient\Base\Config;
|
||||
use AnimeClient\Model\Manga as MangaModel;
|
||||
|
||||
/**
|
||||
* Controller for manga list
|
||||
*/
|
||||
class MangaController extends BaseController {
|
||||
class Manga extends Controller {
|
||||
|
||||
/**
|
||||
* The manga model
|
||||
@ -3,12 +3,15 @@
|
||||
* Anime API Model
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Model;
|
||||
|
||||
use AnimeClient\Base\ApiModel;
|
||||
use AnimeClient\Base\Config;
|
||||
|
||||
/**
|
||||
* Model for handling requests dealing with the anime list
|
||||
*/
|
||||
class AnimeModel extends BaseApiModel {
|
||||
class Anime extends ApiModel {
|
||||
/**
|
||||
* The base url for api requests
|
||||
* @var string $base_url
|
||||
@ -3,12 +3,16 @@
|
||||
* Anime Collection DB Model
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Model;
|
||||
|
||||
use AnimeClient\Base\DBModel;
|
||||
use AnimeClient\Base\Config;
|
||||
use AnimeClient\Model\Anime as AnimeModel;
|
||||
|
||||
/**
|
||||
* Model for getting anime collection data
|
||||
*/
|
||||
class AnimeCollectionModel extends BaseDBModel {
|
||||
class AnimeCollection extends DBModel {
|
||||
|
||||
/**
|
||||
* Anime API Model
|
||||
@ -2,12 +2,15 @@
|
||||
/**
|
||||
* Manga API Model
|
||||
*/
|
||||
namespace AnimeClient;
|
||||
namespace AnimeClient\Model;
|
||||
|
||||
use AnimeClient\Base\ApiModel;
|
||||
use AnimeClient\Base\Config;
|
||||
|
||||
/**
|
||||
* Model for handling requests dealing with the manga list
|
||||
*/
|
||||
class MangaModel extends BaseApiModel {
|
||||
class Manga extends ApiModel {
|
||||
|
||||
/**
|
||||
* The base url for api requests
|
||||
@ -1,4 +1,7 @@
|
||||
<?php
|
||||
/**
|
||||
* Bootstrap / Dependency Injection
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
|
||||
@ -6,6 +9,15 @@ use \Whoops\Handler\PrettyPageHandler;
|
||||
use \Whoops\Handler\JsonResponseHandler;
|
||||
use \Aura\Web\WebFactory;
|
||||
use \Aura\Router\RouterFactory;
|
||||
use \Aura\Di\Container as DiContainer;
|
||||
use \Aura\Di\Factory as DiFactory;
|
||||
|
||||
require _dir(SRC_DIR, '/functions.php');
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Setup DI container
|
||||
// -----------------------------------------------------------------------------
|
||||
$container = new Base\Container();
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Setup error handling
|
||||
@ -23,17 +35,20 @@ $whoops->pushHandler($jsonHandler);
|
||||
|
||||
$whoops->register();
|
||||
|
||||
$container->set('error-handler', $defaultHandler);
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Injected Objects
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Create Config Object
|
||||
$config = new Config();
|
||||
require _dir(BASE_DIR, '/functions.php');
|
||||
$config = new Base\Config();
|
||||
$container->set('config', $config);
|
||||
|
||||
// Create Aura Router Object
|
||||
$router_factory = new RouterFactory();
|
||||
$aura_router = $router_factory->newInstance();
|
||||
$container->set('aura-router', $aura_router);
|
||||
|
||||
// Create Request/Response Objects
|
||||
$web_factory = new WebFactory([
|
||||
@ -43,13 +58,13 @@ $web_factory = new WebFactory([
|
||||
'_SERVER' => $_SERVER,
|
||||
'_FILES' => $_FILES
|
||||
]);
|
||||
$request = $web_factory->newRequest();
|
||||
$response = $web_factory->newResponse();
|
||||
$container->set('request', $web_factory->newRequest());
|
||||
$container->set('response', $web_factory->newResponse());
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// Router
|
||||
// -----------------------------------------------------------------------------
|
||||
$router = new Router($config, $aura_router, $request, $response);
|
||||
$router = new Base\Router($container);
|
||||
$router->dispatch();
|
||||
|
||||
// End of bootstrap.php
|
||||
@ -1,4 +1,4 @@
|
||||
<?php
|
||||
<?php
|
||||
$config = [
|
||||
// ----------------------------------------------------------------------------
|
||||
// Username for anime and manga lists
|
||||
@ -12,32 +12,50 @@ $config = [
|
||||
// do you wish to show the anime collection tab?
|
||||
'show_anime_collection' => TRUE,
|
||||
|
||||
// path to public directory
|
||||
'asset_path' => '//' . $_SERVER['HTTP_HOST'] . '/public',
|
||||
|
||||
// path to public directory on the server
|
||||
'asset_dir' => __DIR__ . '/../../public',
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// Routing
|
||||
//
|
||||
// Route by path, or route by domain. To route by path, set the _host suffixed
|
||||
// options to an empty string, and set 'route_by' to 'path'. To route by host, set
|
||||
// the _path suffixed options to an empty string, and set 'route_by' to 'host'.
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
'route_by' => 'path', // host or path
|
||||
'anime_host' => '',
|
||||
'manga_host' => '',
|
||||
'routing' => [
|
||||
// Subfolder prefix for url
|
||||
'subfolder_prefix' => '',
|
||||
|
||||
// Path to public directory, where images/css/javascript are located,
|
||||
// appended to the url
|
||||
'asset_path' => '/public',
|
||||
|
||||
// Url paths to each content type
|
||||
'anime_path' => 'anime',
|
||||
'manga_path' => 'manga',
|
||||
'collection_path' => 'collection',
|
||||
'stats_path' => 'stats',
|
||||
|
||||
// Which list should be the default?
|
||||
'default_list' => 'anime', // anime or manga
|
||||
|
||||
// Default pages for anime/manga
|
||||
'default_anime_path' => "/anime/watching",
|
||||
'default_manga_path' => '/manga/all',
|
||||
|
||||
// Default to list view?
|
||||
'default_to_list_view' => FALSE,
|
||||
],
|
||||
|
||||
// Url paths to each
|
||||
'anime_path' => 'anime',
|
||||
'manga_path' => 'manga',
|
||||
'collection_path' => 'collection',
|
||||
'stats_path' => 'stats',
|
||||
|
||||
// Which list should be the default?
|
||||
'default_list' => 'anime', // anime or manga
|
||||
|
||||
// Default pages for anime/manga
|
||||
'default_anime_path' => '/watching',
|
||||
'default_manga_path' => '/all',
|
||||
'default_anime_path' => "/anime/watching",
|
||||
'default_manga_path' => '/manga/all',
|
||||
|
||||
// Default to list view?
|
||||
'default_to_list_view' => FALSE,
|
||||
|
||||
@ -22,6 +22,43 @@ return [
|
||||
'path' => '/logout',
|
||||
'action' => ['logout']
|
||||
],
|
||||
],
|
||||
// Routes on collection controller
|
||||
'collection' => [
|
||||
'collection_add_form' => [
|
||||
'path' => '/collection/add',
|
||||
'action' => ['form'],
|
||||
'params' => [],
|
||||
],
|
||||
'collection_edit_form' => [
|
||||
'path' => '/collection/edit/{id}',
|
||||
'action' => ['form'],
|
||||
'tokens' => [
|
||||
'id' => '[0-9]+'
|
||||
]
|
||||
],
|
||||
'collection_add' => [
|
||||
'path' => '/collection/add',
|
||||
'action' => ['add'],
|
||||
'verb' => 'post'
|
||||
],
|
||||
'collection_edit' => [
|
||||
'path' => '/collection/edit',
|
||||
'action' => ['edit'],
|
||||
'verb' => 'post'
|
||||
],
|
||||
'collection' => [
|
||||
'path' => '/collection/view{/view}',
|
||||
'action' => ['index'],
|
||||
'params' => [],
|
||||
'tokens' => [
|
||||
'view' => '[a-z_]+'
|
||||
]
|
||||
],
|
||||
],
|
||||
// Routes on stats controller
|
||||
'stats' => [
|
||||
|
||||
],
|
||||
// Routes on anime controller
|
||||
'anime' => [
|
||||
@ -34,11 +71,11 @@ return [
|
||||
]
|
||||
],
|
||||
'search' => [
|
||||
'path' => '/search',
|
||||
'path' => '/anime/search',
|
||||
'action' => ['search'],
|
||||
],
|
||||
'all' => [
|
||||
'path' => '/all{/view}',
|
||||
'path' => '/anime/all{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'all',
|
||||
@ -49,7 +86,7 @@ return [
|
||||
]
|
||||
],
|
||||
'watching' => [
|
||||
'path' => '/watching{/view}',
|
||||
'path' => '/anime/watching{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'currently-watching',
|
||||
@ -60,7 +97,7 @@ return [
|
||||
]
|
||||
],
|
||||
'plan_to_watch' => [
|
||||
'path' => '/plan_to_watch{/view}',
|
||||
'path' => '/anime/plan_to_watch{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'plan-to-watch',
|
||||
@ -71,7 +108,7 @@ return [
|
||||
]
|
||||
],
|
||||
'on_hold' => [
|
||||
'path' => '/on_hold{/view}',
|
||||
'path' => '/anime/on_hold{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'on-hold',
|
||||
@ -82,7 +119,7 @@ return [
|
||||
]
|
||||
],
|
||||
'dropped' => [
|
||||
'path' => '/dropped{/view}',
|
||||
'path' => '/anime/dropped{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'dropped',
|
||||
@ -93,7 +130,7 @@ return [
|
||||
]
|
||||
],
|
||||
'completed' => [
|
||||
'path' => '/completed{/view}',
|
||||
'path' => '/anime/completed{/view}',
|
||||
'action' => ['anime_list'],
|
||||
'params' => [
|
||||
'type' => 'completed',
|
||||
@ -103,36 +140,6 @@ return [
|
||||
'view' => '[a-z_]+'
|
||||
]
|
||||
],
|
||||
'collection_add_form' => [
|
||||
'path' => '/collection/add',
|
||||
'action' => ['collection_form'],
|
||||
'params' => [],
|
||||
],
|
||||
'collection_edit_form' => [
|
||||
'path' => '/collection/edit/{id}',
|
||||
'action' => ['collection_form'],
|
||||
'tokens' => [
|
||||
'id' => '[0-9]+'
|
||||
]
|
||||
],
|
||||
'collection_add' => [
|
||||
'path' => '/collection/add',
|
||||
'action' => ['collection_add'],
|
||||
'verb' => 'post'
|
||||
],
|
||||
'collection_edit' => [
|
||||
'path' => '/collection/edit',
|
||||
'action' => ['collection_edit'],
|
||||
'verb' => 'post'
|
||||
],
|
||||
'collection' => [
|
||||
'path' => '/collection/view{/view}',
|
||||
'action' => ['collection'],
|
||||
'params' => [],
|
||||
'tokens' => [
|
||||
'view' => '[a-z_]+'
|
||||
]
|
||||
],
|
||||
],
|
||||
'manga' => [
|
||||
'index' => [
|
||||
@ -145,7 +152,7 @@ return [
|
||||
]
|
||||
],
|
||||
'all' => [
|
||||
'path' => '/all{/view}',
|
||||
'path' => '/manga/all{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'all',
|
||||
@ -156,7 +163,7 @@ return [
|
||||
]
|
||||
],
|
||||
'reading' => [
|
||||
'path' => '/reading{/view}',
|
||||
'path' => '/manga/reading{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'Reading',
|
||||
@ -167,7 +174,7 @@ return [
|
||||
]
|
||||
],
|
||||
'plan_to_read' => [
|
||||
'path' => '/plan_to_read{/view}',
|
||||
'path' => '/manga/plan_to_read{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'Plan to Read',
|
||||
@ -178,7 +185,7 @@ return [
|
||||
]
|
||||
],
|
||||
'on_hold' => [
|
||||
'path' => '/on_hold{/view}',
|
||||
'path' => '/manga/on_hold{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'On Hold',
|
||||
@ -189,7 +196,7 @@ return [
|
||||
]
|
||||
],
|
||||
'dropped' => [
|
||||
'path' => '/dropped{/view}',
|
||||
'path' => '/manga/dropped{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'Dropped',
|
||||
@ -200,7 +207,7 @@ return [
|
||||
]
|
||||
],
|
||||
'completed' => [
|
||||
'path' => '/completed{/view}',
|
||||
'path' => '/manga/completed{/view}',
|
||||
'action' => ['manga_list'],
|
||||
'params' => [
|
||||
'type' => 'Completed',
|
||||
|
||||
@ -1,11 +1,17 @@
|
||||
{
|
||||
"name": "timw4mail/hummingbird-anime-client",
|
||||
"description": "A self-hosted anime/manga client for hummingbird.",
|
||||
"license":"MIT",
|
||||
"require": {
|
||||
"guzzlehttp/guzzle": "5.3.*",
|
||||
"filp/whoops": "1.1.*",
|
||||
"filp/whoops": "dev-php7#fe32a402b086b21360e82013e8a0355575c7c6f4",
|
||||
"aura/router": "2.2.*",
|
||||
"aura/web": "2.0.*",
|
||||
"aviat4ion/query": "2.0.*",
|
||||
"robmorgan/phinx": "*",
|
||||
"abeautifulsite/simpleimage": "*"
|
||||
"aura/html": "2.*",
|
||||
"aura/session": "2.*",
|
||||
"aviat4ion/query": "2.5.*",
|
||||
"robmorgan/phinx": "0.4.*",
|
||||
"abeautifulsite/simpleimage": "2.5.*",
|
||||
"szymach/c-pchart": "1.*"
|
||||
}
|
||||
}
|
||||
39
index.php
39
index.php
@ -3,8 +3,6 @@
|
||||
* Here begins everything!
|
||||
*/
|
||||
|
||||
namespace AnimeClient;
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// ! Start config
|
||||
// -----------------------------------------------------------------------------
|
||||
@ -30,9 +28,42 @@ if ($timezone === '' || $timezone === FALSE)
|
||||
// Define base directories
|
||||
define('ROOT_DIR', __DIR__);
|
||||
define('APP_DIR', ROOT_DIR . DIRECTORY_SEPARATOR . 'app');
|
||||
define('SRC_DIR', ROOT_DIR . DIRECTORY_SEPARATOR . 'src');
|
||||
define('CONF_DIR', APP_DIR . DIRECTORY_SEPARATOR . 'config');
|
||||
define('BASE_DIR', APP_DIR . DIRECTORY_SEPARATOR . 'base');
|
||||
require BASE_DIR . DIRECTORY_SEPARATOR . 'pre_conf_functions.php';
|
||||
define('BASE_DIR', SRC_DIR . DIRECTORY_SEPARATOR . 'Base');
|
||||
|
||||
/**
|
||||
* Joins paths together. Variadic to take an
|
||||
* arbitrary number of arguments
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
function _dir()
|
||||
{
|
||||
return implode(DIRECTORY_SEPARATOR, func_get_args());
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up autoloaders
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @return void
|
||||
*/
|
||||
function _setup_autoloaders()
|
||||
{
|
||||
require _dir(ROOT_DIR, '/vendor/autoload.php');
|
||||
spl_autoload_register(function ($class) {
|
||||
$class_parts = explode('\\', $class);
|
||||
array_shift($class_parts);
|
||||
$ns_path = SRC_DIR . '/' . implode('/', $class_parts) . ".php";
|
||||
|
||||
if (file_exists($ns_path))
|
||||
{
|
||||
require_once($ns_path);
|
||||
return;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup autoloaders
|
||||
_setup_autoloaders();
|
||||
|
||||
@ -11,13 +11,7 @@
|
||||
<template name="clean" />
|
||||
</transformations>
|
||||
<files>
|
||||
<directory>.</directory>
|
||||
<directory>app</directory>
|
||||
<ignore>public/*</ignore>
|
||||
<ignore>app/views/*</ignore>
|
||||
<ignore>app/config/*</ignore>
|
||||
<ignore>migrations/*</ignore>
|
||||
<ignore>tests/*</ignore>
|
||||
<ignore>vendor/*</ignore>
|
||||
<directory>src</directory>
|
||||
<ignore>src/views/*</ignore>
|
||||
</files>
|
||||
</phpdoc>
|
||||
11
phpunit.xml
11
phpunit.xml
@ -5,15 +5,18 @@
|
||||
bootstrap="tests/bootstrap.php">
|
||||
<filter>
|
||||
<whitelist>
|
||||
<directory suffix=".php">app/base</directory>
|
||||
<directory suffix=".php">app/controllers</directory>
|
||||
<directory suffix=".php">app/models</directory>
|
||||
<directory suffix=".php">src/Base</directory>
|
||||
<directory suffix=".php">src/Controller</directory>
|
||||
<directory suffix=".php">src/Model</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
<testsuites>
|
||||
<testsuite name="BaseTests">
|
||||
<directory>tests/base</directory>
|
||||
<directory>tests</directory>
|
||||
<directory>tests/Base</directory>
|
||||
</testsuite>
|
||||
<testsuite name="ModelTests"><directory>tests/Model</directory></testsuite>
|
||||
<testsuite name="ControllerTests"><directory>tests/Controller</directory></testsuite>
|
||||
</testsuites>
|
||||
<php>
|
||||
<server name="HTTP_USER_AGENT" value="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0" />
|
||||
|
||||
164
src/Base/Config.php
Normal file
164
src/Base/Config.php
Normal file
@ -0,0 +1,164 @@
|
||||
<?php
|
||||
/**
|
||||
* Base Configuration class
|
||||
*/
|
||||
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
/**
|
||||
* Wrapper for configuration values
|
||||
*/
|
||||
class Config {
|
||||
|
||||
/**
|
||||
* Config object
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $config = [];
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param array $config_files
|
||||
*/
|
||||
public function __construct(Array $config_files=[])
|
||||
{
|
||||
// @codeCoverageIgnoreStart
|
||||
if (empty($config_files))
|
||||
{
|
||||
require_once \_dir(CONF_DIR, 'config.php'); // $config
|
||||
require_once \_dir(CONF_DIR, 'base_config.php'); // $base_config
|
||||
|
||||
$this->config = array_merge($config, $base_config);
|
||||
}
|
||||
else // @codeCoverageIgnoreEnd
|
||||
{
|
||||
$this->config = $config_files;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Getter for config values
|
||||
*
|
||||
* @param string $key
|
||||
* @return mixed
|
||||
*/
|
||||
public function __get($key)
|
||||
{
|
||||
if (isset($this->config[$key]))
|
||||
{
|
||||
return $this->config[$key];
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the base url for css/js/images
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function asset_url(/*...*/)
|
||||
{
|
||||
$args = func_get_args();
|
||||
$base_url = rtrim($this->url(""), '/');
|
||||
|
||||
$routing_config = $this->__get("routing");
|
||||
|
||||
|
||||
$base_url = "{$base_url}" . $routing_config['asset_path'];
|
||||
|
||||
array_unshift($args, $base_url);
|
||||
|
||||
return implode("/", $args);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the base url from the config
|
||||
*
|
||||
* @param string $type - (optional) The controller
|
||||
* @return string
|
||||
*/
|
||||
public function base_url($type="anime")
|
||||
{
|
||||
$config_path = trim($this->__get("{$type}_path"), "/");
|
||||
|
||||
// Set the appropriate HTTP host
|
||||
$host = $_SERVER['HTTP_HOST'];
|
||||
$path = ($config_path !== '') ? $config_path : "";
|
||||
|
||||
return implode("/", ['/', $host, $path]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a proper url from the path
|
||||
*
|
||||
* @param string $path
|
||||
* @return string
|
||||
*/
|
||||
public function url($path)
|
||||
{
|
||||
$path = trim($path, '/');
|
||||
|
||||
// Remove any optional parameters from the route
|
||||
$path = preg_replace('`{/.*?}`i', '', $path);
|
||||
|
||||
// Set the appropriate HTTP host
|
||||
$host = $_SERVER['HTTP_HOST'];
|
||||
|
||||
return "//{$host}/{$path}";
|
||||
}
|
||||
|
||||
public function default_url($type)
|
||||
{
|
||||
$type = trim($type);
|
||||
$default_path = $this->__get("default_{$type}_path");
|
||||
|
||||
if ( ! is_null($default_path))
|
||||
{
|
||||
return $this->url($default_path);
|
||||
}
|
||||
|
||||
return "";
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate full url path from the route path based on config
|
||||
*
|
||||
* @param string $path - (optional) The route path
|
||||
* @param string $type - (optional) The controller (anime or manga), defaults to anime
|
||||
* @return string
|
||||
*/
|
||||
public function full_url($path="", $type="anime")
|
||||
{
|
||||
$config_path = trim($this->__get("{$type}_path"), "/");
|
||||
$config_default_route = $this->__get("default_{$type}_path");
|
||||
|
||||
// Remove beginning/trailing slashes
|
||||
$config_path = trim($config_path, '/');
|
||||
$path = trim($path, '/');
|
||||
|
||||
// Remove any optional parameters from the route
|
||||
$path = preg_replace('`{/.*?}`i', '', $path);
|
||||
|
||||
// Set the appropriate HTTP host
|
||||
$host = $_SERVER['HTTP_HOST'];
|
||||
|
||||
// Set the default view
|
||||
if ($path === '')
|
||||
{
|
||||
$path .= trim($config_default_route, '/');
|
||||
if ($this->__get('default_to_list_view')) $path .= '/list';
|
||||
}
|
||||
|
||||
// Set an leading folder
|
||||
/*if ($config_path !== '')
|
||||
{
|
||||
$path = "{$config_path}/{$path}";
|
||||
}*/
|
||||
|
||||
return "//{$host}/{$path}";
|
||||
}
|
||||
}
|
||||
// End of config.php
|
||||
50
src/Base/Container.php
Normal file
50
src/Base/Container.php
Normal file
@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
namespace Animeclient\Base;
|
||||
|
||||
/**
|
||||
* Wrapper of Aura container to be in the anime client namespace
|
||||
*/
|
||||
class Container {
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $container = [];
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct(array $values = [])
|
||||
{
|
||||
$this->container = $values;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a value
|
||||
*
|
||||
* @param string $key
|
||||
* @retun mixed
|
||||
*/
|
||||
public function get($key)
|
||||
{
|
||||
if (array_key_exists($key, $this->container))
|
||||
{
|
||||
return $this->container[$key];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a value to the container
|
||||
*
|
||||
* @param string $key
|
||||
* @param mixed $value
|
||||
* @return Container
|
||||
*/
|
||||
public function set($key, $value)
|
||||
{
|
||||
$this->container[$key] = $value;
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
// End of Container.php
|
||||
283
src/Base/Controller.php
Normal file
283
src/Base/Controller.php
Normal file
@ -0,0 +1,283 @@
|
||||
<?php
|
||||
/**
|
||||
* Base Controller
|
||||
*/
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
/**
|
||||
* Base class for controllers, defines output methods
|
||||
*/
|
||||
class Controller {
|
||||
|
||||
/**
|
||||
* The global configuration object
|
||||
* @var object $config
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* Request object
|
||||
* @var object $request
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* Response object
|
||||
* @var object $response
|
||||
*/
|
||||
protected $response;
|
||||
|
||||
/**
|
||||
* The api model for the current controller
|
||||
* @var object
|
||||
*/
|
||||
protected $model;
|
||||
|
||||
/**
|
||||
* Common data to be sent to views
|
||||
* @var array
|
||||
*/
|
||||
protected $base_data = [
|
||||
'url_type' => 'anime',
|
||||
'other_type' => 'manga',
|
||||
'nav_routes' => []
|
||||
];
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param Config $config
|
||||
* @param array $web
|
||||
*/
|
||||
public function __construct(Container $container)
|
||||
{
|
||||
$this->config = $container->get('config');
|
||||
$this->base_data['config'] = $this->config;
|
||||
|
||||
$this->request = $container->get('request');
|
||||
$this->response = $container->get('response');
|
||||
}
|
||||
|
||||
/**
|
||||
* Destructor
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function __destruct()
|
||||
{
|
||||
$this->output();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a class member
|
||||
*
|
||||
* @param string $key
|
||||
* @return object
|
||||
*/
|
||||
public function __get($key)
|
||||
{
|
||||
$allowed = ['request', 'response', 'config'];
|
||||
|
||||
if (in_array($key, $allowed))
|
||||
{
|
||||
return $this->$key;
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the string output of a partial template
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $template
|
||||
* @param array|object $data
|
||||
* @return string
|
||||
*/
|
||||
public function load_partial($template, $data=[])
|
||||
{
|
||||
if (isset($this->base_data))
|
||||
{
|
||||
$data = array_merge($this->base_data, $data);
|
||||
}
|
||||
|
||||
global $router, $defaultHandler;
|
||||
$route = $router->get_route();
|
||||
$data['route_path'] = ($route) ? $router->get_route()->path : "";
|
||||
|
||||
$defaultHandler->addDataTable('Template Data', $data);
|
||||
|
||||
$template_path = _dir(SRC_DIR, 'views', "{$template}.php");
|
||||
|
||||
if ( ! is_file($template_path))
|
||||
{
|
||||
throw new \InvalidArgumentException("Invalid template : {$path}");
|
||||
}
|
||||
|
||||
ob_start();
|
||||
extract($data);
|
||||
include _dir(SRC_DIR, 'views', 'header.php');
|
||||
include $template_path;
|
||||
include _dir(SRC_DIR, 'views', 'footer.php');
|
||||
$buffer = ob_get_contents();
|
||||
ob_end_clean();
|
||||
|
||||
return $buffer;
|
||||
}
|
||||
|
||||
/**
|
||||
* Output a template to HTML, using the provided data
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $template
|
||||
* @param array|object $data
|
||||
* @return void
|
||||
*/
|
||||
public function outputHTML($template, $data=[])
|
||||
{
|
||||
$buffer = $this->load_partial($template, $data);
|
||||
|
||||
$this->response->content->setType('text/html');
|
||||
$this->response->content->set($buffer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Output json with the proper content type
|
||||
*
|
||||
* @param mixed $data
|
||||
* @return void
|
||||
*/
|
||||
public function outputJSON($data)
|
||||
{
|
||||
if ( ! is_string($data))
|
||||
{
|
||||
$data = json_encode($data);
|
||||
}
|
||||
|
||||
$this->response->content->setType('application/json');
|
||||
$this->response->content->set($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Redirect to the selected page
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $url
|
||||
* @param int $code
|
||||
* @param string $type
|
||||
* @return void
|
||||
*/
|
||||
public function redirect($url, $code, $type="anime")
|
||||
{
|
||||
$url = $this->config->full_url($url, $type);
|
||||
|
||||
$this->response->redirect->to($url, $code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a message box to the page
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $type
|
||||
* @param string $message
|
||||
* @return string
|
||||
*/
|
||||
public function show_message($type, $message)
|
||||
{
|
||||
return $this->load_partial('message', [
|
||||
'stat_class' => $type,
|
||||
'message' => $message
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear the api session
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @return void
|
||||
*/
|
||||
public function logout()
|
||||
{
|
||||
session_destroy();
|
||||
$this->response->redirect->seeOther($this->config->full_url(''));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the login form
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $status
|
||||
* @return void
|
||||
*/
|
||||
public function login($status="")
|
||||
{
|
||||
$message = "";
|
||||
|
||||
if ($status != "")
|
||||
{
|
||||
$message = $this->show_message('error', $status);
|
||||
}
|
||||
|
||||
$this->outputHTML('login', [
|
||||
'title' => 'Api login',
|
||||
'message' => $message
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempt to log in with the api
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function login_action()
|
||||
{
|
||||
if (
|
||||
$this->model->authenticate(
|
||||
$this->config->hummingbird_username,
|
||||
$this->request->post->get('password')
|
||||
)
|
||||
)
|
||||
{
|
||||
$this->response->redirect->afterPost($this->config->full_url('', $this->base_data['url_type']));
|
||||
return;
|
||||
}
|
||||
|
||||
$this->login("Invalid username or password.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Send the appropriate response
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @return void
|
||||
*/
|
||||
private function output()
|
||||
{
|
||||
// send status
|
||||
@header($this->response->status->get(), true, $this->response->status->getCode());
|
||||
|
||||
// headers
|
||||
foreach($this->response->headers->get() as $label => $value)
|
||||
{
|
||||
@header("{$label}: {$value}");
|
||||
}
|
||||
|
||||
// cookies
|
||||
foreach($this->response->cookies->get() as $name => $cookie)
|
||||
{
|
||||
@setcookie(
|
||||
$name,
|
||||
$cookie['value'],
|
||||
$cookie['expire'],
|
||||
$cookie['path'],
|
||||
$cookie['domain'],
|
||||
$cookie['secure'],
|
||||
$cookie['httponly']
|
||||
);
|
||||
}
|
||||
|
||||
// send the actual response
|
||||
echo $this->response->content->get();
|
||||
}
|
||||
}
|
||||
// End of BaseController.php
|
||||
112
src/Base/Model.php
Normal file
112
src/Base/Model.php
Normal file
@ -0,0 +1,112 @@
|
||||
<?php
|
||||
/**
|
||||
* Base for base models
|
||||
*/
|
||||
namespace AnimeClient\Base;
|
||||
|
||||
use abeautifulsite\SimpleImage;
|
||||
|
||||
/**
|
||||
* Common base for all Models
|
||||
*/
|
||||
class Model {
|
||||
|
||||
/**
|
||||
* The global configuration object
|
||||
* @var Config
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* The container object
|
||||
* @var Container
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct(Container $container)
|
||||
{
|
||||
$this->container = $container;
|
||||
$this->config = $container->get('config');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the path of the cached version of the image. Create the cached image
|
||||
* if the file does not already exist
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $api_path - The original image url
|
||||
* @param string $series_slug - The part of the url with the series name, becomes the image name
|
||||
* @param string $type - Anime or Manga, controls cache path
|
||||
* @return string - the frontend path for the cached image
|
||||
*/
|
||||
public function get_cached_image($api_path, $series_slug, $type="anime")
|
||||
{
|
||||
$api_path = str_replace("jjpg", "jpg", $api_path);
|
||||
$path_parts = explode('?', basename($api_path));
|
||||
$path = current($path_parts);
|
||||
$ext_parts = explode('.', $path);
|
||||
$ext = end($ext_parts);
|
||||
|
||||
// Workaround for some broken extensions
|
||||
if ($ext == "jjpg") $ext = "jpg";
|
||||
|
||||
// Failsafe for weird urls
|
||||
if (strlen($ext) > 3) return $api_path;
|
||||
|
||||
$cached_image = "{$series_slug}.{$ext}";
|
||||
$cached_path = "{$this->config->img_cache_path}/{$type}/{$cached_image}";
|
||||
|
||||
// Cache the file if it doesn't already exist
|
||||
if ( ! file_exists($cached_path))
|
||||
{
|
||||
if (ini_get('allow_url_fopen'))
|
||||
{
|
||||
copy($api_path, $cached_path);
|
||||
}
|
||||
elseif (function_exists('curl_init'))
|
||||
{
|
||||
$ch = curl_init($api_path);
|
||||
$fp = fopen($cached_path, 'wb');
|
||||
curl_setopt_array($ch, [
|
||||
CURLOPT_FILE => $fp,
|
||||
CURLOPT_HEADER => 0
|
||||
]);
|
||||
curl_exec($ch);
|
||||
curl_close($ch);
|
||||
fclose($ch);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new DomainException("Couldn't cache images because they couldn't be downloaded.");
|
||||
}
|
||||
|
||||
// Resize the image
|
||||
if ($type == 'anime')
|
||||
{
|
||||
$resize_width = 220;
|
||||
$resize_height = 319;
|
||||
$this->_resize($cached_path, $resize_width, $resize_height);
|
||||
}
|
||||
}
|
||||
|
||||
return "/public/images/{$type}/{$cached_image}";
|
||||
}
|
||||
|
||||
/**
|
||||
* Resize an image
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $path
|
||||
* @param string $width
|
||||
* @param string $height
|
||||
*/
|
||||
private function _resize($path, $width, $height)
|
||||
{
|
||||
$img = new SimpleImage($path);
|
||||
$img->resize($width,$height)->save();
|
||||
}
|
||||
}
|
||||
// End of BaseModel.php
|
||||
81
src/Base/Model/API.php
Normal file
81
src/Base/Model/API.php
Normal file
@ -0,0 +1,81 @@
|
||||
<?php
|
||||
/**
|
||||
* Base API Model
|
||||
*/
|
||||
namespace AnimeClient\Base\Model;
|
||||
|
||||
use \GuzzleHttp\Client;
|
||||
use \GuzzleHttp\Cookie\CookieJar;
|
||||
use \AnimeClient\Base\Container;
|
||||
|
||||
/**
|
||||
* Base model for api interaction
|
||||
*/
|
||||
class API extends \AnimeClient\Base\Model {
|
||||
|
||||
/**
|
||||
* Base url for making api requests
|
||||
* @var string
|
||||
*/
|
||||
protected $base_url = '';
|
||||
|
||||
/**
|
||||
* The Guzzle http client object
|
||||
* @var object
|
||||
*/
|
||||
protected $client;
|
||||
|
||||
/**
|
||||
* Cookie jar object for api requests
|
||||
* @var object
|
||||
*/
|
||||
protected $cookieJar;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct(Container $container)
|
||||
{
|
||||
parent::__construct($container);
|
||||
$this->cookieJar = new CookieJar();
|
||||
$this->client = new Client([
|
||||
'base_url' => $this->base_url,
|
||||
'defaults' => [
|
||||
'cookies' => $this->cookieJar,
|
||||
'headers' => [
|
||||
'User-Agent' => $_SERVER['HTTP_USER_AGENT'],
|
||||
'Accept-Encoding' => 'application/json'
|
||||
],
|
||||
'timeout' => 5,
|
||||
'connect_timeout' => 5
|
||||
]
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempt login via the api
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @param string $username
|
||||
* @param string $password
|
||||
* @return bool
|
||||
*/
|
||||
public function authenticate($username, $password)
|
||||
{
|
||||
$result = $this->client->post('https://hummingbird.me/api/v1/users/authenticate', [
|
||||
'body' => [
|
||||
'username' => $username,
|
||||
'password' => $password
|
||||
]
|
||||
]);
|
||||
|
||||