Merge branch 'nightly' of git.gnu.io:gnu/gnu-social into nightly

[quix0rs-gnu-social.git] / actions / doc.php

diff --git a/actions/doc.php b/actions/doc.php
index 5df18a859f932d4d2f3544b1d3e28c5d9bf8a249..85d35d8fcf5cf8596e3700444f7115878ba3b576 100644 (file)
--- a/actions/doc.php
+++ b/actions/doc.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Documentation action.
  *
@@ -13,7 +12,7 @@
  * @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
@@ -45,8 +44,23 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
  */
 class DocAction extends Action
 {
-    var $filename;
-    var $title;
+    var $output   = null;
+    var $filename = null;
+    var $title    = null;
+
+    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 true;
+    }
 
     /**
      * Handle a request
@@ -58,25 +72,6 @@ class DocAction extends Action
     function handle($args)
     {
         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();
     }
 
@@ -87,7 +82,6 @@ class DocAction extends Action
      *
      * @return void
      */
-
     function showPageTitle()
     {
         $this->element('h1', array('class' => 'entry-title'), $this->title());
@@ -100,14 +94,13 @@ class DocAction extends Action
      *
      * @return void.
      */
-
     function showContentBlock()
     {
-        $this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
+        $this->elementStart('div', array('id' => 'content', 'class' => 'h-entry'));
         $this->showPageTitle();
         $this->showPageNoticeBlock();
         $this->elementStart('div', array('id' => 'content_inner',
-                                         'class' => 'entry-content'));
+                                         'class' => 'e-content'));
         // show the actual content (forms, lists, whatever)
         $this->showContent();
         $this->elementEnd('div');
@@ -121,7 +114,6 @@ class DocAction extends Action
      *
      * @return void
      */
-
     function showContent()
     {
         $this->raw($this->output);
@@ -146,9 +138,100 @@ class DocAction extends Action
      *
      * @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);
+            }
+
+            $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);
+
+            $docs = new DocListNav($this->action);
+            $this->submenu(_m('MENU','Docs'), $docs);
+            
+            Event::handle('EndDocNav', array($this));
+        }
+    }
+}
+
+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;
+    }
 }