controller/guicontroller.php

   1 <?php
   2 /**
   3  * Part of grauphel
   4  *
   5  * PHP version 5
   6  *
   7  * @category  Tools
   8  * @package   Grauphel
   9  * @author    Christian Weiske <cweiske@cweiske.de>
  10  * @copyright 2014 Christian Weiske
  11  * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
  12  * @link      http://cweiske.de/grauphel.htm
  13  */
  14 namespace OCA\Grauphel\Controller;
  15
  16 use \OCP\AppFramework\Controller;
  17 use \OCP\AppFramework\Http\TemplateResponse;
  18 use \OCA\Grauphel\Lib\Client;
  19 use \OCA\Grauphel\Lib\TokenStorage;
  20 use \OCA\Grauphel\Lib\Response\ErrorResponse;
  21
  22 /**
  23  * Owncloud frontend
  24  *
  25  * @category  Tools
  26  * @package   Grauphel
  27  * @author    Christian Weiske <cweiske@cweiske.de>
  28  * @copyright 2014 Christian Weiske
  29  * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
  30  * @version   Release: @package_version@
  31  * @link      http://cweiske.de/grauphel.htm
  32  */
  33 class GuiController extends Controller
  34 {
  35     /**
  36      * constructor of the controller
  37      *
  38      * @param string   $appName Name of the app
  39      * @param IRequest $request Instance of the request
  40      */
  41     public function __construct($appName, \OCP\IRequest $request, $user, $urlGen)
  42     {
  43         parent::__construct($appName, $request);
  44         $this->user   = $user;
  45         $this->urlGen = $urlGen;
  46
  47         //default http header: we assume something is broken
  48         header('HTTP/1.0 500 Internal Server Error');
  49     }
  50
  51     /**
  52      * Main page /
  53      *
  54      * Tomdroid wants this to be a public page. Sync fails otherwise.
  55      *
  56      * @NoAdminRequired
  57      * @NoCSRFRequired
  58      * @PublicPage
  59      */
  60     public function index()
  61     {
  62         try {
  63             $this->checkDeps();
  64         } catch (\Exception $e) {
  65             $res = new TemplateResponse('grauphel', 'error');
  66             $res->setParams(
  67                 array(
  68                     'message' => $e->getMessage(),
  69                     'code' => $e->getCode(),
  70                 )
  71             );
  72             return $res;
  73         }
  74
  75         $res = new TemplateResponse('grauphel', 'index');
  76         $res->setParams(
  77             array(
  78                 'apiroot' => $this->getApiRootUrl(),
  79                 'apiurl'  => $this->urlGen->linkToRoute('grauphel.api.index')
  80             )
  81         );
  82         $this->addNavigation($res);
  83         $this->addStats($res);
  84         return $res;
  85     }
  86
  87     /**
  88      * Show contents of a note
  89      *
  90      * @NoAdminRequired
  91      * @NoCSRFRequired
  92      */
  93     public function note($guid)
  94     {
  95         $res = new TemplateResponse('grauphel', 'gui-note');
  96
  97         $note = $this->getNotes()->load($guid, false);
  98         if ($note === null) {
  99             $res = new ErrorResponse('Note does not exist');
 100             $res->setStatus(\OCP\AppFramework\Http::STATUS_NOT_FOUND);
 101             return $res;
 102         }
 103
 104         $converter = new \OCA\Grauphel\Converter\Html();
 105         $converter->internalLinkHandler = array($this, 'noteLinkHandler');
 106
 107         try {
 108             $contentHtml = $converter->convert($note->{'note-content'});
 109         } catch (\OCA\Grauphel\Converter\Exception $e) {
 110             $contentHtml = '<div class="error">'
 111                 . '<p>There was an error converting the note to HTML:</p>'
 112                 . '<blockquote><tt>' . htmlspecialchars($e->getMessage()) . '</tt></blockquote>'
 113                 . '<p>Please open a bug report at'
 114                 . ' <a class="lined" href="http://github.com/cweiske/grauphel/issues">'
 115                 . 'github.com/cweiske/grauphel/issues</a>'
 116                 . ' and attach the XML version of the note.'
 117                 . '</div>';
 118         }
 119
 120         $res->setParams(
 121             array(
 122                 'note' => $note,
 123                 'note-content' => $contentHtml,
 124                 'links' => array(
 125                     'html' => $this->urlGen->linkToRoute(
 126                         'grauphel.notes.html', array('guid' => $guid)
 127                     ),
 128                     'json' => $this->urlGen->linkToRoute(
 129                         'grauphel.api.note', array(
 130                             'guid' => $guid, 'username' => $this->user->getUid()
 131                         )
 132                     ),
 133                     'text' => $this->urlGen->linkToRoute(
 134                         'grauphel.notes.text', array('guid' => $guid)
 135                     ),
 136                     'xml' => $this->urlGen->linkToRoute(
 137                         'grauphel.notes.xml', array('guid' => $guid)
 138                     ),
 139                 )
 140             )
 141         );
 142
 143         $selectedRawtag = 'grauphel:special:untagged';
 144         if (count($note->tags) > 0) {
 145             $selectedRawtag = $note->tags[0];
 146         }
 147
 148         $this->addNavigation($res, $selectedRawtag);
 149         return $res;
 150     }
 151
 152     public function noteLinkHandler($noteTitle)
 153     {
 154         $guid = $this->getNotes()->loadGuidByTitle($noteTitle);
 155         if ($guid === null) {
 156             return '#';
 157         }
 158         return $this->urlGen->linkToRoute(
 159             'grauphel.gui.note', array('guid' => $guid)
 160         );
 161     }
 162
 163     /**
 164      * Show all notes of a tag
 165      *
 166      * @NoAdminRequired
 167      * @NoCSRFRequired
 168      */
 169     public function tag($rawtag)
 170     {
 171         $notes = $this->getNotes()->loadNotesOverview(null, $rawtag, true);
 172         usort(
 173             $notes,
 174             function($noteA, $noteB) {
 175                 return strcmp($noteA['title'], $noteB['title']);
 176             }
 177         );
 178
 179         foreach ($notes as &$note) {
 180             $diffInDays = intval(
 181                 (time() - strtotime($note['last-change-date'])) / 86400
 182             );
 183             $value = 0 + $diffInDays;
 184             if ($value > 160) {
 185                 $value = 160;
 186             }
 187             $note['dateColor'] = '#' . str_repeat(sprintf('%02X', $value), 3);
 188         }
 189
 190         $res = new TemplateResponse('grauphel', 'tag');
 191         $res->setParams(
 192             array(
 193                 'tag'    => $this->getPrettyTagName($rawtag),
 194                 'rawtag' => $rawtag,
 195                 'notes'  => $notes,
 196             )
 197         );
 198         $this->addNavigation($res, $rawtag);
 199
 200         return $res;
 201     }
 202
 203     /**
 204      * Show access tokens
 205      *
 206      * @NoAdminRequired
 207      * @NoCSRFRequired
 208      */
 209     public function tokens()
 210     {
 211         $tokens = new TokenStorage();
 212         $res = new TemplateResponse('grauphel', 'tokens');
 213         $res->setParams(
 214             array(
 215                 'tokens' => $tokens->loadForUser(
 216                     $this->user->getUid(), 'access'
 217                 ),
 218                 'client' => new Client(),
 219                 'username' => $this->user->getUid(),
 220             )
 221         );
 222         $this->addNavigation($res, null);
 223
 224         return $res;
 225     }
 226
 227     /**
 228      * Allow the user to clear his database
 229      *
 230      * @NoAdminRequired
 231      * @NoCSRFRequired
 232      */
 233     public function database($reset = null)
 234     {
 235         $res = new TemplateResponse('grauphel', 'gui-database');
 236         $res->setParams(array('reset' => $reset));
 237         $this->addNavigation($res, null);
 238         $this->addStats($res);
 239
 240         return $res;
 241     }
 242
 243     /**
 244      * Resets the database by deleting all notes and deleting the user's
 245      * sync data.
 246      *
 247      * @NoAdminRequired
 248      */
 249     public function databaseReset()
 250     {
 251         $reset = false;
 252         if ($_POST['username'] != '' && $_POST['username'] == $this->user->getUid()) {
 253             $notes = $this->getNotes();
 254             $notes->deleteAll();
 255             $notes->deleteSyncData();
 256             $reset = true;
 257         }
 258
 259         return $this->database($reset);
 260     }
 261
 262     protected function addNavigation(TemplateResponse $res, $selectedRawtag = null)
 263     {
 264         $nav = new \OCP\Template('grauphel', 'appnavigation', '');
 265         $nav->assign('apiroot', $this->getApiRootUrl());
 266         $nav->assign('tags', array());
 267
 268         $params = $res->getParams();
 269         $params['appNavigation'] = $nav;
 270         $res->setParams($params);
 271
 272         if ($this->user === null) {
 273             return;
 274         }
 275
 276         $rawtags = $this->getNotes()->getTags();
 277         sort($rawtags);
 278         array_unshift(
 279             $rawtags,
 280             'grauphel:special:all', 'grauphel:special:untagged'
 281         );
 282
 283         $tags = array();
 284         foreach ($rawtags as $rawtag) {
 285             $name = $this->getPrettyTagName($rawtag);
 286             if ($name !== false) {
 287                 $tags[] = array(
 288                     'name' => $name,
 289                     'id'   => $rawtag,
 290                     'href' => $this->urlGen->linkToRoute(
 291                         'grauphel.gui.tag', array('rawtag' => $rawtag)
 292                     ),
 293                     'selected' => $rawtag == $selectedRawtag,
 294                 );
 295             }
 296         }
 297         $nav->assign('tags', $tags);
 298     }
 299
 300     protected function addStats(TemplateResponse $res)
 301     {
 302         if ($this->user === null) {
 303             return;
 304         }
 305
 306         $username = $this->user->getUid();
 307         $notes  = $this->getNotes();
 308         $tokens = new \OCA\Grauphel\Lib\TokenStorage();
 309
 310         $nav = new \OCP\Template('grauphel', 'indexStats', '');
 311         $nav->assign('notes', count($notes->loadNotesOverview()));
 312         $nav->assign('syncrev', $notes->loadSyncData()->latestSyncRevision);
 313         $nav->assign('tokens', count($tokens->loadForUser($username, 'access')));
 314
 315         $params = $res->getParams();
 316         $params['stats'] = $nav;
 317         $res->setParams($params);
 318     }
 319
 320     protected function checkDeps()
 321     {
 322         if (!class_exists('OAuthProvider')) {
 323             throw new \Exception('PHP extension "oauth" is required', 1001);
 324         }
 325     }
 326
 327     protected function getApiRootUrl()
 328     {
 329         //we need to remove the trailing / for tomdroid and conboy
 330         return rtrim(
 331             $this->urlGen->getAbsoluteURL(
 332                 $this->urlGen->linkToRoute('grauphel.gui.index')
 333             ),
 334             '/'
 335         );
 336     }
 337
 338     protected function getNotes()
 339     {
 340         $username = $this->user->getUid();
 341         $notes  = new \OCA\Grauphel\Lib\NoteStorage($this->urlGen);
 342         $notes->setUsername($username);
 343         return $notes;
 344     }
 345
 346     protected function getPrettyTagName($rawtag)
 347     {
 348         if (substr($rawtag, 0, 16) == 'system:notebook:') {
 349             return substr($rawtag, 16);
 350         } else if (substr($rawtag, 0, 17) == 'grauphel:special:') {
 351             return '*' . substr($rawtag, 17) . '*';
 352         }
 353         return false;
 354     }
 355 }
 356 ?>