<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Documentation action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Robin Millette <millette@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('GNUSOCIAL')) { exit(1); }
+
+/**
+ * Documentation class.
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Robin Millette <millette@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://status.net/
+ */
+class DocAction extends ManagedAction
+{
+ var $output = null;
+ var $filename = null;
+ var $title = null;
+
+ protected function doPreparation()
+ {
+ $this->title = $this->trimmed('title');
+ if (!preg_match('/^[a-zA-Z0-9_-]*$/', $this->title)) {
+ $this->title = 'help';
+ }
+ $this->output = null;
+
+ $this->loadDoc();
+ }
+
+ public function title()
+ {
+ return ucfirst($this->title);
+ }
+
+ /**
+ * Display content.
+ *
+ * Shows the content of the document.
+ *
+ * @return void
+ */
+ function showContent()
+ {
+ $this->raw($this->output);
+ }
+
+ function showNoticeForm()
+ {
+ // no notice form
+ }
+
+ /**
+ * These pages are read-only.
+ *
+ * @param array $args unused.
+ *
+ * @return boolean read-only flag (false)
+ */
+ function isReadOnly($args)
+ {
+ 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);
+ }
-class DocAction extends Action
+ $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()
+ {
+ if (Event::handle('StartDocNav', array($this))) {
+ $stub = new HomeStubNav($this->action);
+ $this->submenu(_m('MENU','Home'), $stub);
- function handle($args)
+ $docs = new DocListNav($this->action);
+ $this->submenu(_m('MENU','Docs'), $docs);
+
+ Event::handle('EndDocNav', array($this));
+ }
+ }
+}
+
+class DocListNav extends Menu
+{
+ function getItems()
{
- parent::handle($args);
- $title = $this->trimmed('title');
- $filename = INSTALLDIR.'/doc/'.$title;
- if (!file_exists($filename)) {
- $this->clientError(_('No such document.'));
- return;
+ $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));
}
- $c = file_get_contents($filename);
- $output = common_markup_to_html($c);
- common_show_header(_(ucfirst($title)));
- $this->raw($output);
- common_show_footer();
+ return $items;
}
}