<?php
-
/**
* Documentation action.
*
* @link http://status.net/
*
* StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
+ * Copyright (C) 2008-2010, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
function prepare($args)
{
+ parent::prepare($args);
+
$this->title = $this->trimmed('title');
+ if (!preg_match('/^[a-zA-Z0-9_-]*$/', $this->title)) {
+ $this->title = 'help';
+ }
$this->output = null;
$this->loadDoc();
*
* @return void
*/
-
function showPageTitle()
{
$this->element('h1', array('class' => 'entry-title'), $this->title());
*
* @return void.
*/
-
function showContentBlock()
{
$this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
*
* @return void
*/
-
function showContent()
{
$this->raw($this->output);
*
* @return boolean read-only flag (false)
*/
-
function isReadOnly($args)
{
return true;
{
if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
- $this->filename = $this->getFilename();
+ $paths = DocFile::defaultPaths();
- if (empty($this->filename)) {
- throw new ClientException(sprintf(_('No such document "%s"'), $this->title), 404);
- }
+ $docfile = DocFile::forTitle($this->title, $paths);
- $c = file_get_contents($this->filename);
+ if (empty($docfile)) {
+ // TRANS: Client exception thrown when requesting a document from the documentation that does not exist.
+ // TRANS: %s is the non-existing document.
+ throw new ClientException(sprintf(_('No such document "%s".'), $this->title), 404);
+ }
- $this->output = common_markup_to_html($c);
+ $this->output = $docfile->toHTML();
Event::handle('EndLoadDoc', array($this->title, &$this->output));
}
}
-
- function getFilename()
- {
- $local = array_merge(glob(INSTALLDIR.'/local/doc-src/'.$this->title),
- glob(INSTALLDIR.'/local/doc-src/'.$this->title.'.*'));
-
- if (count($local)) {
- return $this->negotiateLanguage($local);
- }
-
- $dist = array_merge(glob(INSTALLDIR.'/doc-src/'.$this->title),
- glob(INSTALLDIR.'/doc-src/'.$this->title.'.*'));
-
- if (count($dist)) {
- return $this->negotiateLanguage($dist);
- }
-
- return null;
- }
-
- function negotiateLanguage($files)
- {
- // FIXME: write this
- }
}