<?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
*/
class DocAction extends Action
{
- var $filename;
- var $title;
+ var $output = null;
+ var $filename = null;
+ var $title = null;
+
+ function prepare(array $args=array())
+ {
+ 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 true;
+ }
/**
- * Class handler.
+ * Handle a request
*
* @param array $args array of arguments
*
* @return nothing
*/
- function handle($args)
+ function handle(array $args=array())
{
parent::handle($args);
-
- $this->title = $this->trimmed('title');
- $this->output = null;
-
- if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
-
- $this->filename = INSTALLDIR.'/doc-src/'.$this->title;
- if (!file_exists($this->filename)) {
- $this->clientError(_('No such document.'));
- return;
- }
-
- $c = file_get_contents($this->filename);
- $this->output = common_markup_to_html($c);
-
- Event::handle('EndLoadDoc', array($this->title, &$this->output));
- }
-
$this->showPage();
}
- // overrrided to add entry-title class
- function showPageTitle() {
+ /**
+ * 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());
}
- // overrided to add hentry, and content-inner classes
+ /**
+ * Block for content.
+ *
+ * Overrides default from Action to wrap everything in an hAtom entry.
+ *
+ * @return void.
+ */
function showContentBlock()
- {
- $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');
- }
+ {
+ $this->elementStart('div', array('id' => 'content', 'class' => 'h-entry'));
+ $this->showPageTitle();
+ $this->showPageNoticeBlock();
+ $this->elementStart('div', array('id' => 'content_inner',
+ 'class' => 'e-content'));
+ // show the actual content (forms, lists, whatever)
+ $this->showContent();
+ $this->elementEnd('div');
+ $this->elementEnd('div');
+ }
/**
* Display content.
*
- * @return nothing
+ * Shows the content of the document.
+ *
+ * @return void
*/
function showContent()
{
/**
* Page title.
*
+ * Uses the title of the document.
+ *
* @return page title
*/
function title()
return ucfirst($this->title);
}
- function isReadOnly($args)
+ /**
+ * These pages are read-only.
+ *
+ * @param array $args unused.
+ *
+ * @return boolean read-only flag (false)
+ */
+ function isReadOnly(array $args=array())
{
return true;
}
+
+ function loadDoc()
+ {
+ if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
+
+ $paths = DocFile::defaultPaths();
+
+ $docfile = DocFile::forTitle($this->title, $paths);
+
+ 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 = $docfile->toHTML();
+
+ Event::handle('EndLoadDoc', array($this->title, &$this->output));
+ }
+ }
+
+ function showLocalNav()
+ {
+ $menu = new DocNav($this);
+ $menu->show();
+ }
+}
+
+class DocNav extends Menu
+{
+ function show()
+ {
+ $stub = new HomeStubNav($this->action);
+ $this->submenu(_m('MENU','Home'), $stub);
+
+ $docs = new DocListNav($this->action);
+ $this->submenu(_m('MENU','Docs'), $docs);
+ }
+}
+
+class DocListNav extends Menu
+{
+ function getItems()
+ {
+ $items = array();
+
+ if (Event::handle('StartDocsMenu', array(&$items))) {
+
+ $items = array(array('doc',
+ array('title' => 'help'),
+ _m('MENU', 'Help'),
+ _('Getting started'),
+ 'nav_doc_help'),
+ array('doc',
+ array('title' => 'about'),
+ _m('MENU', 'About'),
+ _('About this site'),
+ 'nav_doc_about'),
+ array('doc',
+ array('title' => 'faq'),
+ _m('MENU', 'FAQ'),
+ _('Frequently asked questions'),
+ 'nav_doc_faq'),
+ array('doc',
+ array('title' => 'contact'),
+ _m('MENU', 'Contact'),
+ _('Contact info'),
+ 'nav_doc_contact'),
+ array('doc',
+ array('title' => 'tags'),
+ _m('MENU', 'Tags'),
+ _('Using tags'),
+ 'nav_doc_tags'),
+ array('doc',
+ array('title' => 'groups'),
+ _m('MENU', 'Groups'),
+ _('Using groups'),
+ 'nav_doc_groups'),
+ array('doc',
+ array('title' => 'api'),
+ _m('MENU', 'API'),
+ _('RESTful API'),
+ 'nav_doc_api'));
+
+ Event::handle('EndDocsMenu', array(&$items));
+ }
+ return $items;
+ }
}