/**
* Get the title of this module.
*
* @return string
*/
public function getTitle()
{
if (!$this->title) {
$this->title = DocumentationHelper::clean_page_name($this->key);
}
return $this->title;
}
public function testGetExtension()
{
$this->assertEquals('md', DocumentationHelper::get_extension('file.md'));
$this->assertEquals('md', DocumentationHelper::get_extension('dev/tasks/file.md'));
$this->assertEquals('txt', DocumentationHelper::get_extension('dev/tasks/file.txt'));
$this->assertNull(DocumentationHelper::get_extension('doc_test/2.3'));
$this->assertNull(DocumentationHelper::get_extension('dev/docs/en/doc_test/2.3/subfolder'));
}
/**
* This should return the link from the entity root to the page. The link
* value has the cleaned version of the folder names. See
* {@link getRelativePath()} for the actual file path.
*
* @return string
*/
public function getRelativeLink()
{
$path = $this->getRelativePath();
$url = explode('/', $path);
$url = implode('/', array_map(function ($a) {
return DocumentationHelper::clean_page_url($a);
}, $url));
$url = trim($url, '/') . '/';
return $url;
}
/**
* Generate an {@link ArrayList} of the pages to the given page.
*
* @param DocumentationPage
* @param DocumentationEntityLanguage
*
* @return ArrayList
*/
public function generateBreadcrumbs($record, $base)
{
$output = new ArrayList();
$parts = explode('/', trim($record->getRelativeLink(), '/'));
// Add the base link.
$output->push(new ArrayData(array('Link' => $base->Link(), 'Title' => $base->Title)));
$progress = $base->Link();
foreach ($parts as $part) {
if ($part) {
$progress = Controller::join_links($progress, $part, '/');
$output->push(new ArrayData(array('Link' => $progress, 'Title' => DocumentationHelper::clean_page_name($part))));
}
}
return $output;
}
/**
* Overloaded to avoid "action doesn't exist" errors - all URL parts in
* this controller are virtual and handled through handleRequest(), not
* controller methods.
*
* @param $request
* @param $action
*
* @return SS_HTTPResponse
*/
public function handleAction($request, $action)
{
// if we submitted a form, let that pass
if (!$request->isGET()) {
return parent::handleAction($request, $action);
}
$url = $request->getURL();
//
// If the current request has an extension attached to it, strip that
// off and redirect the user to the page without an extension.
//
if (DocumentationHelper::get_extension($url)) {
$this->response = new SS_HTTPResponse();
$this->response->redirect(DocumentationHelper::trim_extension_off($url) . '/', 301);
$request->shift();
$request->shift();
return $this->response;
}
//
// Strip off the base url
//
$base = ltrim(Config::inst()->get('DocumentationViewer', 'link_base'), '/');
if ($base && strpos($url, $base) !== false) {
$url = substr(ltrim($url, '/'), strlen($base));
} else {
}
//
// Handle any permanent redirections that the developer has defined.
//
if ($link = DocumentationPermalinks::map($url)) {
// the first param is a shortcode for a page so redirect the user to
// the short code.
$this->response = new SS_HTTPResponse();
$this->response->redirect($link, 301);
$request->shift();
$request->shift();
return $this->response;
}
//
// Validate the language provided. Language is a required URL parameter.
// as we use it for generic interfaces and language selection. If
// language is not set, redirects to 'en'
//
$languages = i18n::get_common_languages();
if (!($lang = $request->param('Lang'))) {
$lang = $request->param('Action');
$action = $request->param('ID');
} else {
$action = $request->param('Action');
}
if (!$lang) {
return $this->redirect($this->Link('en'));
} else {
if (!isset($languages[$lang])) {
return $this->httpError(404);
}
}
$request->shift(10);
$allowed = $this->config()->allowed_actions;
if (in_array($action, $allowed)) {
//
// if it's one of the allowed actions such as search or all then the
// URL must be prefixed with one of the allowed languages.
//
return parent::handleAction($request, $action);
} else {
//
// look up the manifest to see find the nearest match against the
// list of the URL. If the URL exists then set that as the current
// page to match against.
// strip off any extensions.
// if($cleaned !== $url) {
// $redirect = new SS_HTTPResponse();
// return $redirect->redirect($cleaned, 302);
// }
if ($record = $this->getManifest()->getPage($url)) {
$this->record = $record;
$this->init();
$type = get_class($this->record);
$body = $this->renderWith(array("DocumentationViewer_{$type}", "DocumentationViewer"));
return new SS_HTTPResponse($body, 200);
} else {
if ($redirect = $this->getManifest()->getRedirect($url)) {
$response = new SS_HTTPResponse();
$to = Controller::join_links(Director::baseURL(), $base, $redirect);
return $response->redirect($to, 301);
} else {
if (!$url || $url == $lang) {
$body = $this->renderWith(array("DocumentationViewer_DocumentationFolder", "DocumentationViewer"));
return new SS_HTTPResponse($body, 200);
}
}
}
}
return $this->httpError(404);
}
/**
* Overloaded to avoid "action doesn't exist" errors - all URL parts in this controller are virtual and handled through handleRequest(), not controller methods.
* @param {SS_HTTPRequest} $request
* @param {string} $action
* @return {SS_HTTPResponse}
*/
public function handleAction($request, $action)
{
// if we submitted a form, let that pass
if (!$request->isGET()) {
return parent::handleAction($request, $action);
}
$url = $request->getURL();
//If the current request has an extension attached to it, strip that off and redirect the user to the page without an extension.
if (DocumentationHelper::get_extension($url)) {
$request->shift();
$request->shift();
return $this->redirect(Director::absoluteURL(DocumentationHelper::trim_extension_off($url)) . '/', 301);
}
//Strip off the base url
$base = ltrim(Config::inst()->get('DocumentationViewer', 'link_base'), '/');
if ($base && strpos($url, $base) !== false) {
$url = substr(ltrim($url, '/'), strlen($base));
}
//Handle any permanent redirections that the developer has defined.
if ($link = DocumentationPermalinks::map($url)) {
$request->shift();
$request->shift();
//the first param is a shortcode for a page so redirect the user to the short code.
return $this->redirect($link, 301);
}
//Validate the language provided. Language is a required URL parameter. as we use it for generic interfaces and language selection.
//If language is not set, redirects to 'en'
$languages = i18n::get_common_languages();
if (!($lang = $request->param('Lang'))) {
$lang = $request->param('Action');
$action = $request->param('ID');
} else {
$action = $request->param('Action');
}
if (!$lang) {
return $this->redirect($this->Link('en'));
} else {
if (!isset($languages[$lang])) {
return $this->httpError(404);
}
}
$request->shift(10);
$allowed = $this->config()->allowed_actions;
if (in_array($action, $allowed)) {
//if it's one of the allowed actions such as search or all then the URL must be prefixed with one of the allowed languages.
return parent::handleAction($request, $action);
} else {
//look up the manifest to see find the nearest match against the list of the URL. If the URL exists then set that as the current page to match against. strip off any extensions.
if ($record = $this->getManifest()->getPage($url)) {
$this->record = $record;
return $this->getResponseNegotiator()->respond($request);
} else {
if ($redirect = $this->getManifest()->getRedirect($url)) {
$to = Controller::join_links(Director::baseURL(), $base, $redirect);
return $this->redirect($to, 301);
} else {
if (!$url || $url == $lang) {
return $this->getResponseNegotiator()->respond($request);
} else {
$url = explode('/', $url);
$url = implode('/', array_map(function ($a) {
return DocumentationHelper::clean_page_url($a);
}, $url));
if ($record = $this->getManifest()->getPage($url)) {
return $this->redirect($record->Link(), 301);
}
}
}
}
}
return $this->httpError(404);
}
