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         $this->addGlobalVars($res);
 150         return $res;
 151     }
 152
 153     public function noteLinkHandler($noteTitle)
 154     {
 155         $guid = $this->getNotes()->loadGuidByTitle($noteTitle);
 156         if ($guid === null) {
 157             return '#';
 158         }
 159         return $this->urlGen->linkToRoute(
 160             'grauphel.gui.note', array('guid' => $guid)
 161         );
 162     }
 163
 164     /**
 165      * Show all notes of a tag
 166      *
 167      * @NoAdminRequired
 168      * @NoCSRFRequired
 169      */
 170     public function tag($rawtag)
 171     {
 172         $rawtag = $this->unescapeTagFromUrl($rawtag);
 173         $notes = $this->getNotes()->loadNotesOverview(null, $rawtag, true);
 174         usort(
 175             $notes,
 176             function($noteA, $noteB) {
 177                 return strcmp($noteA['title'], $noteB['title']);
 178             }
 179         );
 180
 181         foreach ($notes as &$note) {
 182             $diffInDays = intval(
 183                 (time() - strtotime($note['last-change-date'])) / 86400
 184             );
 185             $value = 0 + $diffInDays;
 186             if ($value > 160) {
 187                 $value = 160;
 188             }
 189             $note['dateColor'] = '#' . str_repeat(sprintf('%02X', $value), 3);
 190         }
 191
 192         $res = new TemplateResponse('grauphel', 'tag');
 193         $res->setParams(
 194             array(
 195                 'tag'    => $this->getPrettyTagName($rawtag),
 196                 'rawtag' => $rawtag,
 197                 'notes'  => $notes,
 198             )
 199         );
 200         $this->addGlobalVars($res);
 201         $this->addNavigation($res, $rawtag);
 202
 203         return $res;
 204     }
 205
 206     /**
 207      * Show access tokens
 208      *
 209      * @NoAdminRequired
 210      * @NoCSRFRequired
 211      */
 212     public function tokens()
 213     {
 214         $tokens = new TokenStorage();
 215         $res = new TemplateResponse('grauphel', 'tokens');
 216         $res->setParams(
 217             array(
 218                 'tokens' => $tokens->loadForUser(
 219                     $this->user->getUid(), 'access'
 220                 ),
 221                 'client' => new Client(),
 222                 'username' => $this->user->getUid(),
 223             )
 224         );
 225         $this->addGlobalVars($res);
 226         $this->addNavigation($res, null);
 227
 228         return $res;
 229     }
 230
 231     /**
 232      * Allow the user to clear his database
 233      *
 234      * @NoAdminRequired
 235      * @NoCSRFRequired
 236      */
 237     public function database($reset = null)
 238     {
 239         $res = new TemplateResponse('grauphel', 'gui-database');
 240         $res->setParams(array('reset' => $reset));
 241         $this->addNavigation($res, null);
 242         $this->addStats($res);
 243
 244         return $res;
 245     }
 246
 247     /**
 248      * Resets the database by deleting all notes and deleting the user's
 249      * sync data.
 250      *
 251      * @NoAdminRequired
 252      */
 253     public function databaseReset()
 254     {
 255         $reset = false;
 256         if ($_POST['username'] != '' && $_POST['username'] == $this->user->getUid()) {
 257             $notes = $this->getNotes();
 258             $notes->deleteAll();
 259             $notes->deleteSyncData();
 260             $reset = true;
 261         }
 262
 263         return $this->database($reset);
 264     }
 265
 266     /**
 267      * Register some variables that templates will probably need.
 268      *
 269      * @return void
 270      */
 271     protected function addGlobalVars(TemplateResponse $res)
 272     {
 273         $params = $res->getParams();
 274         $params['date']   = \OC::$server->getDateTimeFormatter();
 275         $params['urlGen'] = \OC::$server->getURLGenerator();
 276         $res->setParams($params);
 277     }
 278
 279     protected function addNavigation(TemplateResponse $res, $selectedRawtag = null)
 280     {
 281         $nav = new \OCP\Template('grauphel', 'appnavigation', '');
 282         $nav->assign('apiroot', $this->getApiRootUrl());
 283         $nav->assign('tags', array());
 284
 285         $params = $res->getParams();
 286         $params['appNavigation'] = $nav;
 287         $res->setParams($params);
 288
 289         if ($this->user === null) {
 290             return;
 291         }
 292
 293         $rawtags = $this->getNotes()->getTags();
 294         sort($rawtags);
 295         array_unshift(
 296             $rawtags,
 297             'grauphel:special:all', 'grauphel:special:untagged'
 298         );
 299
 300         $tags = array();
 301         foreach ($rawtags as $rawtag) {
 302             $name = $this->getPrettyTagName($rawtag);
 303             if ($name !== false) {
 304                 $tags[] = array(
 305                     'name' => $name,
 306                     'id'   => $rawtag,
 307                     'href' => $this->urlGen->linkToRoute(
 308                         'grauphel.gui.tag',
 309                         array('rawtag' => $this->escapeTagForUrl($rawtag))
 310                     ),
 311                     'selected' => $rawtag == $selectedRawtag,
 312                 );
 313             }
 314         }
 315         $nav->assign('tags', $tags);
 316     }
 317
 318     protected function addStats(TemplateResponse $res)
 319     {
 320         if ($this->user === null) {
 321             return;
 322         }
 323
 324         $username = $this->user->getUid();
 325         $notes  = $this->getNotes();
 326         $tokens = new \OCA\Grauphel\Lib\TokenStorage();
 327
 328         $nav = new \OCP\Template('grauphel', 'indexStats', '');
 329         $nav->assign('notes', count($notes->loadNotesOverview()));
 330         $nav->assign('syncrev', $notes->loadSyncData()->latestSyncRevision);
 331         $nav->assign('tokens', count($tokens->loadForUser($username, 'access')));
 332
 333         $params = $res->getParams();
 334         $params['stats'] = $nav;
 335         $res->setParams($params);
 336     }
 337
 338     protected function checkDeps()
 339     {
 340         if (!class_exists('OAuthProvider')) {
 341             throw new \Exception('PHP extension "oauth" is required', 1001);
 342         }
 343     }
 344
 345     protected function getApiRootUrl()
 346     {
 347         //we need to remove the trailing / for tomdroid and conboy
 348         return rtrim(
 349             $this->urlGen->getAbsoluteURL(
 350                 $this->urlGen->linkToRoute('grauphel.gui.index')
 351             ),
 352             '/'
 353         );
 354     }
 355
 356     protected function getNotes()
 357     {
 358         $username = $this->user->getUid();
 359         $notes  = new \OCA\Grauphel\Lib\NoteStorage($this->urlGen);
 360         $notes->setUsername($username);
 361         return $notes;
 362     }
 363
 364     protected function getPrettyTagName($rawtag)
 365     {
 366         if (substr($rawtag, 0, 16) == 'system:notebook:') {
 367             return substr($rawtag, 16);
 368         } else if (substr($rawtag, 0, 17) == 'grauphel:special:') {
 369             return '*' . substr($rawtag, 17) . '*';
 370         }
 371         return false;
 372     }
 373
 374     protected function escapeTagForUrl($rawtag)
 375     {
 376         return str_replace('/', '%2F', $rawtag);
 377     }
 378
 379     protected function unescapeTagFromUrl($rawtag)
 380     {
 381         return str_replace('%2F', '/', $rawtag);
 382     }
 383 }
 384 ?>