Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions plugins/baser-core/src/BaserCorePlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
use BaserCore\Event\BcViewEventDispatcher;
use BaserCore\Middleware\BcAdminMiddleware;
use BaserCore\Middleware\BcFrontMiddleware;
use BaserCore\Middleware\BcRedirectMainSiteMiddleware;
use BaserCore\Middleware\BcRedirectSubSiteMiddleware;
use BaserCore\Middleware\BcRequestFilterMiddleware;
use BaserCore\ServiceProvider\BcServiceProvider;
Expand Down Expand Up @@ -386,6 +387,7 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
{
$middlewareQueue
->insertBefore(RoutingMiddleware::class, new BcRequestFilterMiddleware())
->insertBefore(RoutingMiddleware::class, new BcRedirectMainSiteMiddleware())
->insertBefore(CsrfProtectionMiddleware::class, new AuthenticationMiddleware($this))
->add(new BcAdminMiddleware())
->add(new BcFrontMiddleware())
Expand Down
93 changes: 76 additions & 17 deletions plugins/baser-core/src/Middleware/BcRedirectMainSiteMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,22 @@
namespace BaserCore\Middleware;

use BaserCore\Utility\BcUtil;
use Cake\Core\App;
use Cake\Http\Exception\MissingControllerException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
use Cake\ORM\TableRegistry;
use Cake\Routing\Exception\MissingRouteException;
use Cake\Routing\Router;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use BaserCore\Annotation\NoTodo;
use BaserCore\Annotation\Checked;
use BaserCore\Annotation\UnitTest;
use Throwable;

/**
* Class BcRedirectMainSiteMiddleware
Expand All @@ -31,6 +38,8 @@
* (例)
* /s/service → /service
*
* コンテンツが存在しないことは、後続の処理で発生する 404 の例外で判定するため、
* RoutingMiddleware より前に配置する
*/
class BcRedirectMainSiteMiddleware implements MiddlewareInterface
{
Expand All @@ -49,32 +58,82 @@ public function process(
RequestHandlerInterface $handler
): ResponseInterface
{
if ($request->is('admin')
try {
return $handler->handle($request);
} catch (NotFoundException|MissingRouteException|MissingControllerException $e) {
$response = $this->getRedirectResponse($request);
if ($response) return $response;
throw $e;
}
}

/**
* メインサイトへのリダイレクトのレスポンスを取得する
*
* @param ServerRequestInterface $request
* @return ResponseInterface|null
* @checked
* @noTodo
* @unitTest
*/
public function getRedirectResponse(ServerRequestInterface $request): ?ResponseInterface
{
if (!$request instanceof ServerRequest
|| !in_array($request->getMethod(), ['GET', 'HEAD'], true)
|| $request->is('admin')
|| !BcUtil::isInstalled()
|| !$request->is('requestview')
) {
return $handler->handle($request);
return null;
}
// サブサイトの URL がコンテンツやコントローラーに該当する場合(記事が存在しないなどの 404)はリダイレクトしない
if ($this->isRoutable($request)) return null;

$path = $request->getUri()->getPath();
$sites = TableRegistry::getTableLocator()->get('BaserCore.Sites');
$site = $sites->findByUrl($request->getPath());
if (!$site || !$site->status || $site->id === 1) {
return $handler->handle($request);
}
$site = $sites->findByUrl($path);
if (!$site || !$site->status || !$site->main_site_id || !$site->alias) return null;
$mainSite = $site->getMain();
if (!$mainSite) {
return $handler->handle($request);
}
$mainSiteUrl = '/' . preg_replace('/^\/' . $site->alias . '\//', '', $request->getPath());
if (!$mainSite) return null;
$mainSiteUrl = '/' . preg_replace('/^\/' . preg_quote($site->alias, '/') . '\//', '', $path);
if ($mainSiteUrl === $path) return null;
// 別のホストへのリダイレクトにならないようにする(//example.com など)
if (preg_match('#^/[/\\\\]#', $mainSiteUrl)) return null;
if ($mainSite->alias) {
$mainSiteUrl = '/' . $mainSite->alias . $mainSiteUrl;
}
if ($mainSiteUrl) {
$response = new Response([
'status' => 302
]);
return $response->withLocation($request->getAttribute('base') . $mainSiteUrl);
if (!$this->isRoutable($request->withUri($request->getUri()->withPath($mainSiteUrl)))) return null;
// クエリ文字列はそのまま引き継ぐ(ページ番号など)
$query = $request->getUri()->getQuery();
return (new Response(['status' => 302]))
->withLocation($request->getAttribute('base') . $mainSiteUrl . ($query !== ''? '?' . $query : ''));
}

/**
* URL がコンテンツ、またはコントローラーに該当するか判定する
*
* @param ServerRequest $request
* @return bool
* @checked
* @noTodo
* @unitTest
*/
public function isRoutable(ServerRequest $request): bool
{
$request = $request->withAttribute('params', []);
$previous = Router::getRequest();
try {
Router::setRequest($request);
$params = Router::parseRequest($request);
} catch (Throwable) {
return false;
} finally {
if ($previous) Router::setRequest($previous);
}
return $handler->handle($request);
if (!empty($params['Content'])) return true;
if (empty($params['controller'])) return false;
$name = (!empty($params['plugin'])? $params['plugin'] . '.' : '') . $params['controller'];
$type = 'Controller' . (!empty($params['prefix'])? '/' . $params['prefix'] : '');
return App::className($name, $type, 'Controller') !== null;
}

}
6 changes: 5 additions & 1 deletion plugins/baser-core/tests/TestCase/BaserCorePluginTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,11 @@ public function testMiddleware(): void
$middleware->add(RoutingMiddleware::class);
$middlewareQueue = $this->Plugin->middleware($middleware);
$this->assertInstanceOf(AuthenticationMiddleware::class, $middlewareQueue->current());
$this->assertEquals(7, $middlewareQueue->count());
$this->assertEquals(8, $middlewareQueue->count());
$queue = (new \ReflectionProperty($middlewareQueue, 'queue'))->getValue($middlewareQueue);
// RoutingMiddleware の直前に BcRedirectMainSiteMiddleware を配置する
$this->assertInstanceOf(\BaserCore\Middleware\BcRedirectMainSiteMiddleware::class, $queue[3]);
$this->assertSame(RoutingMiddleware::class, $queue[4]);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,15 @@
use BaserCore\Test\Factory\ContentFactory;
use BaserCore\Test\Factory\PageFactory;
use BaserCore\Test\Factory\SiteFactory;
use BaserCore\Test\Scenario\MultiSiteScenario;
use BaserCore\TestSuite\BcTestCase;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\ORM\TableRegistry;
use CakephpFixtureFactories\Scenario\ScenarioAwareTrait;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;

/**
* Class BcRedirectMainSiteMiddlewareTest
Expand Down Expand Up @@ -53,33 +60,110 @@ public function tearDown(): void

/**
* test Process
* リダイレクトを確認
* サブサイトにコンテンツが無く、メインサイトの同じ URL にコンテンツがある場合はメインサイトへリダイレクトする
*/
public function test_process(): void
{
SiteFactory::make(['id' => 1, 'status' => true])->persist();
SiteFactory::make(['id' => 2, 'alias' => 's', 'auto_redirect' => true])->persist();
$this->loadFixtureScenario(MultiSiteScenario::class);
$this->createMainSitePage();
$handler = $this->createNotFoundHandler();
$m = $this->BcRedirectMainSiteMiddleware; $r = $this->getRequest('/en/about');

$response = $this->BcRedirectMainSiteMiddleware->process($this->getRequest('/en/about'), $handler);
$this->assertEquals(302, $response->getStatusCode());
$this->assertEquals('/about', $response->getHeaderLine('Location'));
}

/**
* test Process
* リダイレクトの際、クエリ文字列を引き継ぐ
*/
public function test_process_withQuery(): void
{
$this->loadFixtureScenario(MultiSiteScenario::class);
$this->createMainSitePage();

$response = $this->BcRedirectMainSiteMiddleware->process(
$this->getRequest('/en/about?page=2&sort=desc'),
$this->createNotFoundHandler()
);
$this->assertEquals(302, $response->getStatusCode());
$this->assertEquals('/about?page=2&sort=desc', $response->getHeaderLine('Location'));
}

/**
* test Process
* メインサイトにもコンテンツが無い場合はリダイレクトしない
*/
public function test_process_notExistsMainSite(): void
{
$this->loadFixtureScenario(MultiSiteScenario::class);
$this->createMainSitePage();
$this->expectException(NotFoundException::class);
$this->BcRedirectMainSiteMiddleware->process($this->getRequest('/en/not_exists'), $this->createNotFoundHandler());
}

/**
* test Process
* サブサイトにコンテンツがある場合(記事が無いなどの 404)はリダイレクトしない
*/
public function test_process_existsSubSite(): void
{
$this->loadFixtureScenario(MultiSiteScenario::class);
$this->createMainSitePage();
$this->expectException(NotFoundException::class);
$this->BcRedirectMainSiteMiddleware->process($this->getRequest('/en/'), $this->createNotFoundHandler());
}

/**
* test Process
* 404 にならない場合はそのままレスポンスを返す
*/
public function test_process_found(): void
{
$this->loadFixtureScenario(MultiSiteScenario::class);
$this->createMainSitePage();
$handler = new class implements RequestHandlerInterface {
public function handle(ServerRequestInterface $request): ResponseInterface
{
return new Response();
}
};
$response = $this->BcRedirectMainSiteMiddleware->process($this->getRequest('/en/about'), $handler);
$this->assertEquals(200, $response->getStatusCode());
}

/**
* メインサイトに /about の固定ページを作成する
*/
private function createMainSitePage(): void
{
PageFactory::make(['id' => 1])->persist();
ContentFactory::make([
'id' => 10,
'url' => '/about',
'name' => 'about',
'plugin' => 'BaserCore',
'type' => 'Page',
'site_id' => 1,
'parent_id' => null,
'lft' => 1,
'rght' => 2,
'parent_id' => 1,
'entity_id' => 1,
'site_root' => 2,
'site_root' => false,
'status' => true
])->persist();
TableRegistry::getTableLocator()->get('BaserCore.Contents')->recover();
}

$request = $this->getRequest('/s/about')->withParam('plugin', 'BaserCore')->withParam('controller', 'Pages')->withParam('action', 'view');
$this->_response = $this->BcRedirectMainSiteMiddleware->process($request, $this->Application);
$this->assertResponseCode(302);

$request = $this->getRequest('/about')->withParam('plugin', 'BaserCore')->withParam('controller', 'Pages')->withParam('action', 'view');
$this->_response = $this->BcRedirectMainSiteMiddleware->process($request, $this->Application);
$this->assertResponseCode(200);
/**
* NotFoundException を発生させるハンドラーを作成する
*/
private function createNotFoundHandler(): RequestHandlerInterface
{
return new class implements RequestHandlerInterface {
public function handle(ServerRequestInterface $request): ResponseInterface
{
throw new NotFoundException();
}
};
}
}
Loading