gnu-social/actions/doc.php

216 lines
5.3 KiB
PHP
Raw Normal View History

<?php
2009-01-20 20:29:31 +00:00
/**
* Documentation action.
*
* PHP version 5
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
2009-01-20 20:29:31 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
2009-08-25 23:16:46 +01:00
* @link http://status.net/
2009-01-20 20:29:31 +00:00
*
2009-08-25 23:14:12 +01:00
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, 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
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
2009-01-20 20:29:31 +00:00
exit(1);
}
/**
* Documentation class.
*
* @category Action
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Robin Millette <millette@status.net>
2009-01-20 20:29:31 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
2009-08-25 23:16:46 +01:00
* @link http://status.net/
2009-01-20 20:44:03 +00:00
*/
class DocAction extends Action
{
2009-10-07 10:14:25 +01:00
var $output = null;
var $filename = null;
var $title = null;
function prepare($args)
{
parent::prepare($args);
2009-10-07 10:14:25 +01:00
$this->title = $this->trimmed('title');
if (!preg_match('/^[a-zA-Z0-9_-]*$/', $this->title)) {
$this->title = 'help';
}
2009-10-07 10:14:25 +01:00
$this->output = null;
$this->loadDoc();
return true;
}
2009-01-20 20:29:31 +00:00
/**
2009-10-06 20:29:22 +01:00
* Handle a request
*
2009-01-20 20:29:31 +00:00
* @param array $args array of arguments
*
* @return nothing
2009-01-20 20:44:03 +00:00
*/
function handle($args)
{
parent::handle($args);
2009-01-20 20:29:31 +00:00
$this->showPage();
}
2009-10-06 20:29:22 +01:00
/**
* Page title
*
* Gives the page title of the document. Override default for hAtom entry.
*
* @return void
*/
function showPageTitle()
{
$this->element('h1', array('class' => 'entry-title'), $this->title());
}
2009-10-06 20:29:22 +01:00
/**
* Block for content.
*
* Overrides default from Action to wrap everything in an hAtom entry.
*
* @return void.
*/
function showContentBlock()
2009-10-06 20:29:22 +01:00
{
$this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
$this->showPageTitle();
$this->showPageNoticeBlock();
$this->elementStart('div', array('id' => 'content_inner',
'class' => 'entry-content'));
// show the actual content (forms, lists, whatever)
$this->showContent();
$this->elementEnd('div');
$this->elementEnd('div');
}
2009-01-20 20:29:31 +00:00
/**
* Display content.
*
2009-10-06 20:29:22 +01:00
* Shows the content of the document.
*
* @return void
2009-01-20 20:44:03 +00:00
*/
2009-10-06 20:29:22 +01:00
2009-01-20 20:29:31 +00:00
function showContent()
{
$this->raw($this->output);
2009-01-20 20:29:31 +00:00
}
/**
* Page title.
*
2009-10-06 20:29:22 +01:00
* Uses the title of the document.
*
2009-01-20 20:29:31 +00:00
* @return page title
2009-01-20 20:44:03 +00:00
*/
2009-01-20 20:29:31 +00:00
function title()
{
return ucfirst($this->title);
}
2009-01-23 09:15:15 +00:00
2009-10-06 20:29:22 +01:00
/**
* These pages are read-only.
*
* @param array $args unused.
*
* @return boolean read-only flag (false)
*/
function isReadOnly($args)
2009-01-23 09:15:15 +00:00
{
return true;
}
2009-10-07 10:14:25 +01:00
function loadDoc()
{
if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
$this->filename = $this->getFilename();
if (empty($this->filename)) {
throw new ClientException(sprintf(_('No such document "%s"'), $this->title), 404);
}
$c = file_get_contents($this->filename);
$this->output = common_markup_to_html($c);
Event::handle('EndLoadDoc', array($this->title, &$this->output));
}
}
function getFilename()
{
if (file_exists(INSTALLDIR.'/local/doc-src/'.$this->title)) {
$localDef = INSTALLDIR.'/local/doc-src/'.$this->title;
}
$local = glob(INSTALLDIR.'/local/doc-src/'.$this->title.'.*');
if ($local === false) {
// Some systems return false, others array(), if dir didn't exist.
$local = array();
}
if (count($local) || isset($localDef)) {
return $this->negotiateLanguage($local, $localDef);
}
2009-10-07 10:14:25 +01:00
if (file_exists(INSTALLDIR.'/doc-src/'.$this->title)) {
$distDef = INSTALLDIR.'/doc-src/'.$this->title;
2009-10-07 10:14:25 +01:00
}
$dist = glob(INSTALLDIR.'/doc-src/'.$this->title.'.*');
if ($dist === false) {
$dist = array();
}
2009-10-07 10:14:25 +01:00
if (count($dist) || isset($distDef)) {
return $this->negotiateLanguage($dist, $distDef);
2009-10-07 10:14:25 +01:00
}
return null;
}
function negotiateLanguage($filenames, $defaultFilename=null)
2009-10-07 10:14:25 +01:00
{
// XXX: do this better
$langcode = common_language();
foreach ($filenames as $filename) {
if (preg_match('/\.'.$langcode.'$/', $filename)) {
return $filename;
}
}
return $defaultFilename;
2009-10-07 10:14:25 +01:00
}
}