standlone HTML output
authorChristian Weiske <cweiske@cweiske.de>
Tue, 17 Mar 2015 18:53:49 +0000 (19:53 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Tue, 17 Mar 2015 18:53:49 +0000 (19:53 +0100)
appinfo/routes.php
controller/guicontroller.php
controller/notescontroller.php
lib/converter/cleanhtml.php [new file with mode: 0644]
templates/gui-note.php

index 1c7e50b..c96ec30 100644 (file)
@@ -69,6 +69,11 @@ $application->registerRoutes(
                 'verb' => 'GET',
             ),
             array(
                 'verb' => 'GET',
             ),
             array(
+                'url'  => '/note/{guid}.html',
+                'name' => 'notes#html',
+                'verb' => 'GET',
+            ),
+            array(
                 'url'  => '/note/{guid}.xml',
                 'name' => 'notes#xml',
                 'verb' => 'GET',
                 'url'  => '/note/{guid}.xml',
                 'name' => 'notes#xml',
                 'verb' => 'GET',
index 8ebea8c..15380c7 100644 (file)
@@ -122,6 +122,9 @@ class GuiController extends Controller
                 'note' => $note,
                 'note-content' => $contentHtml,
                 'links' => array(
                 'note' => $note,
                 'note-content' => $contentHtml,
                 'links' => array(
+                    'html' => $this->urlGen->linkToRoute(
+                        'grauphel.notes.html', array('guid' => $guid)
+                    ),
                     'json' => $this->urlGen->linkToRoute(
                         'grauphel.api.note', array(
                             'guid' => $guid, 'username' => $this->user->getUid()
                     'json' => $this->urlGen->linkToRoute(
                         'grauphel.api.note', array(
                             'guid' => $guid, 'username' => $this->user->getUid()
index 5618bcb..893a100 100644 (file)
@@ -48,6 +48,100 @@ class NotesController extends Controller
     }
 
     /**
     }
 
     /**
+     * Output a note as a standalone HTML file
+     *
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function html($guid)
+    {
+        $note = $this->getNotes()->load($guid, false);
+        if ($note === null) {
+            $res = new ErrorResponse('Note does not exist');
+            $res->setStatus(\OCP\AppFramework\Http::STATUS_NOT_FOUND);
+            return $res;
+        }
+
+        $xw = new \XMLWriter();
+        $xw->openMemory();
+        $xw->setIndent(true);
+        $xw->setIndentString(' ');
+        $xw->startDocument('1.0', 'utf-8');
+        $xw->writeRaw(
+            '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"'
+            . ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+            . "\n"
+        );
+
+        $xw->startElementNS(null, 'html', 'http://www.w3.org/1999/xhtml');
+
+        //head
+        $xw->startElement('head');
+        $xw->writeElement('title', $note->title);
+
+        $xw->startElement('meta');
+        $xw->writeAttribute('name', 'author');
+        $xw->writeAttribute('content', $this->user->getDisplayName());
+        $xw->endElement();
+
+        $xw->startElement('meta');
+        $xw->writeAttribute('http-equiv', 'Content-Type');
+        $xw->writeAttribute('content', 'text/html; charset=utf-8');
+        $xw->endElement();
+
+        $xw->startElement('link');
+        $xw->writeAttribute('rel', 'schema.DC');
+        $xw->writeAttribute('href', 'http://purl.org/dc/elements/1.1/');
+        $xw->endElement();
+
+        $xw->startElement('meta');
+        $xw->writeAttribute('name', 'DC.date.created');
+        $xw->writeAttribute(
+            'content', date('c', strtotime($note->{'create-date'}))
+        );
+        $xw->endElement();
+
+        $xw->startElement('meta');
+        $xw->writeAttribute('name', 'DC.date.modified');
+        $xw->writeAttribute(
+            'content', date('c', strtotime($note->{'last-change-date'}))
+        );
+        $xw->endElement();
+
+        $xw->endElement();//head
+
+        //body
+        $xw->startElement('body');
+
+        $xw->writeElement('h1', $note->title);
+
+        $converter = new \OCA\Grauphel\Converter\CleanHtml();
+        $converter->internalLinkHandler = array($this, 'htmlNoteLinkHandler');
+        try {
+            $xw->writeRaw(
+                $converter->convert($note->{'note-content'})
+            );
+        } catch (\OCA\Grauphel\Converter\Exception $e) {
+            $res = new ErrorResponse(
+                'Error converting note to HTML.'
+                . ' Please repport a bug to the grauphel developers.'
+            );
+            $res->setStatus(\OCP\AppFramework\Http::STATUS_NOT_FOUND);
+            return $res;
+        }
+
+        $xw->endElement();//body
+
+        $xw->endElement();//html
+        return new \OCA\Grauphel\Response\XmlResponse($xw->outputMemory());
+    }
+
+    public function htmlNoteLinkHandler($noteTitle)
+    {
+        return urlencode($noteTitle) . '.html';
+    }
+
+    /**
      * Output a note in tomboy XML format
      *
      * @link https://wiki.gnome.org/Apps/Tomboy/NoteXmlFormat
      * Output a note in tomboy XML format
      *
      * @link https://wiki.gnome.org/Apps/Tomboy/NoteXmlFormat
diff --git a/lib/converter/cleanhtml.php b/lib/converter/cleanhtml.php
new file mode 100644 (file)
index 0000000..6c5dabf
--- /dev/null
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Part of grauphel
+ *
+ * PHP version 5
+ *
+ * @category  Tools
+ * @package   Grauphel
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @copyright 2014 Christian Weiske
+ * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @link      http://cweiske.de/grauphel.htm
+ */
+namespace OCA\Grauphel\Converter;
+use \XMLReader;
+
+/**
+ * Convert Tomboy note XML to HTML that can be used (nearly) standalone.
+ * This means it tries to use as many native tags as possible and
+ * does not rely on classes so much.
+ *
+ * @category  Tools
+ * @package   Grauphel
+ * @author    Christian Weiske <cweiske@cweiske.de>
+ * @copyright 2014 Christian Weiske
+ * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @version   Release: @package_version@
+ * @link      http://cweiske.de/grauphel.htm
+ */
+class CleanHtml extends Html
+{
+    protected static $tagMap = array(
+        'list'      => 'ul',
+        'list-item' => 'li',
+        'bold'      => 'b',
+        'italic'    => 'i',
+        'monospace' => 'tt',
+
+        'size:large' => 'h3',
+        'size:huge'  => 'h2',
+
+        'strikethrough' => 'del',
+        'highlight'     => 'ins',
+    );
+
+    protected static $styleClassMap = array(
+        'size:small' => 'small',
+    );
+
+    /**
+     * Converts the tomboy note XML into HTML.
+     * Cleans HTML a bit up after it has been generated with the clean tags.
+     *
+     * @param string $xmlContent Tomboy note content
+     *
+     * @return string HTML
+     */
+    public function convert($xmlContent)
+    {
+        $html = parent::convert($xmlContent);
+        $html = str_replace('</h2><br />', '</h2>', $html);
+        $html = str_replace('</h3><br />', '</h3>', $html);
+        $html = str_replace("<br />\n</h2>", "</h2>\n", $html);
+        $html = str_replace("<br />\n</h3>", "</h3>\n", $html);
+        $html = str_replace("<br />\n</li>", "</li>\n", $html);
+        $html = str_replace("<br />\n<ul>", "<ul>\n", $html);
+        return $html;
+    }
+}
+?>
index fb2d741..86336bc 100644 (file)
@@ -7,6 +7,7 @@
 
 <div id="app-content" class="content">
  <div class="actions">
 
 <div id="app-content" class="content">
  <div class="actions">
+  <a class="button" href="<?php echo p($_['links']['html']); ?>">HTML</a>
   <a class="button" href="<?php echo p($_['links']['json']); ?>">JSON</a>
   <a class="button" href="<?php echo p($_['links']['xml']); ?>">XML</a>
  </div>
   <a class="button" href="<?php echo p($_['links']['json']); ?>">JSON</a>
   <a class="button" href="<?php echo p($_['links']['xml']); ?>">XML</a>
  </div>