Add database management page
[grauphel.git] / 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
21 /**
22  * Owncloud frontend
23  *
24  * @category  Tools
25  * @package   Grauphel
26  * @author    Christian Weiske <cweiske@cweiske.de>
27  * @copyright 2014 Christian Weiske
28  * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
29  * @version   Release: @package_version@
30  * @link      http://cweiske.de/grauphel.htm
31  */
32 class GuiController extends Controller
33 {
34     /**
35      * constructor of the controller
36      *
37      * @param string   $appName Name of the app
38      * @param IRequest $request Instance of the request
39      */
40     public function __construct($appName, \OCP\IRequest $request, $user, $urlGen)
41     {
42         parent::__construct($appName, $request);
43         $this->user   = $user;
44         $this->urlGen = $urlGen;
45
46         //default http header: we assume something is broken
47         header('HTTP/1.0 500 Internal Server Error');
48     }
49
50     /**
51      * Main page /
52      *
53      * Tomdroid wants this to be a public page. Sync fails otherwise.
54      *
55      * @NoAdminRequired
56      * @NoCSRFRequired
57      * @PublicPage
58      */
59     public function index()
60     {
61         $this->checkDeps();
62
63         $res = new TemplateResponse('grauphel', 'index');
64         $res->setParams(
65             array(
66                 'apiroot' => $this->getApiRootUrl(),
67                 'apiurl'  => $this->urlGen->linkToRoute('grauphel.api.index')
68             )
69         );
70         $this->addNavigation($res);
71         $this->addStats($res);
72         return $res;
73     }
74
75     /**
76      * Show all notes of a tag
77      *
78      * @NoAdminRequired
79      * @NoCSRFRequired
80      */
81     public function tag($rawtag)
82     {
83         $notes = $this->getNotes()->loadNotesOverview(null, $rawtag);
84
85         $res = new TemplateResponse('grauphel', 'tag');
86         $res->setParams(
87             array(
88                 'tag'    => $this->getPrettyTagName($rawtag),
89                 'rawtag' => $rawtag,
90                 'notes'  => $notes,
91             )
92         );
93         $this->addNavigation($res, $rawtag);
94
95         return $res;
96     }
97
98     /**
99      * Show access tokens
100      *
101      * @NoAdminRequired
102      * @NoCSRFRequired
103      */
104     public function tokens()
105     {
106         $tokens = new TokenStorage();
107         $res = new TemplateResponse('grauphel', 'tokens');
108         $res->setParams(
109             array(
110                 'tokens' => $tokens->loadForUser(
111                     $this->user->getUid(), 'access'
112                 ),
113                 'client' => new Client(),
114                 'username' => $this->user->getUid(),
115             )
116         );
117         $this->addNavigation($res, null);
118
119         return $res;
120     }
121
122     /**
123      * Allow the user to clear his database
124      *
125      * @NoAdminRequired
126      * @NoCSRFRequired
127      */
128     public function database($reset = null)
129     {
130         $res = new TemplateResponse('grauphel', 'gui-database');
131         $res->setParams(array('reset' => $reset));
132         $this->addNavigation($res, null);
133         $this->addStats($res);
134
135         return $res;
136     }
137
138     /**
139      * Resets the database by deleting all notes and deleting the user's
140      * sync data.
141      *
142      * @NoAdminRequired
143      */
144     public function databaseReset()
145     {
146         $reset = false;
147         if ($_POST['username'] != '' && $_POST['username'] == $this->user->getUid()) {
148             $notes = $this->getNotes();
149             $notes->deleteAll();
150             $notes->deleteSyncData();
151             $reset = true;
152         }
153
154         return $this->database($reset);
155     }
156
157     protected function addNavigation(TemplateResponse $res, $selectedRawtag = null)
158     {
159         $nav = new \OCP\Template('grauphel', 'appnavigation', '');
160         $nav->assign('apiroot', $this->getApiRootUrl());
161         $nav->assign('tags', array());
162
163         $params = $res->getParams();
164         $params['appNavigation'] = $nav;
165         $res->setParams($params);
166
167         if ($this->user === null) {
168             return;
169         }
170
171         $rawtags = $this->getNotes()->getTags();
172         sort($rawtags);
173         array_unshift(
174             $rawtags,
175             'grauphel:special:all', 'grauphel:special:untagged'
176         );
177
178         $tags = array();
179         foreach ($rawtags as $rawtag) {
180             $name = $this->getPrettyTagName($rawtag);
181             if ($name !== false) {
182                 $tags[] = array(
183                     'name' => $name,
184                     'id'   => $rawtag,
185                     'href' => $this->urlGen->linkToRoute(
186                         'grauphel.gui.tag', array('rawtag' => $rawtag)
187                     ),
188                 );
189             }
190         }
191         $nav->assign('tags', $tags);
192     }
193
194     protected function addStats(TemplateResponse $res)
195     {
196         if ($this->user === null) {
197             return;
198         }
199
200         $username = $this->user->getUid();
201         $notes  = $this->getNotes();
202         $tokens = new \OCA\Grauphel\Lib\TokenStorage();
203
204         $nav = new \OCP\Template('grauphel', 'indexStats', '');
205         $nav->assign('notes', count($notes->loadNotesOverview()));
206         $nav->assign('syncrev', $notes->loadSyncData()->latestSyncRevision);
207         $nav->assign('tokens', count($tokens->loadForUser($username, 'access')));
208
209         $params = $res->getParams();
210         $params['stats'] = $nav;
211         $res->setParams($params);
212     }
213
214     protected function checkDeps()
215     {
216         if (!class_exists('OAuthProvider')) {
217             throw new \Exception('PHP extension "oauth" is required');
218         }
219     }
220
221     protected function getApiRootUrl()
222     {
223         //we need to remove the trailing / for tomdroid and conboy
224         return rtrim(
225             $this->urlGen->getAbsoluteURL(
226                 $this->urlGen->linkToRoute('grauphel.gui.index')
227             ),
228             '/'
229         );
230     }
231
232     protected function getNotes()
233     {
234         $username = $this->user->getUid();
235         $notes  = new \OCA\Grauphel\Lib\NoteStorage($this->urlGen);
236         $notes->setUsername($username);
237         return $notes;
238     }
239
240     protected function getPrettyTagName($rawtag)
241     {
242         if (substr($rawtag, 0, 16) == 'system:notebook:') {
243             return substr($rawtag, 16);
244         } else if (substr($rawtag, 0, 17) == 'grauphel:special:') {
245             return '*' . substr($rawtag, 17) . '*';
246         }
247         return false;
248     }
249 }
250 ?>