note about work in progress
[grauphel.git] / lib / notestorage.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\Lib;
15
16 /**
17  * Flat file storage for notes
18  *
19  * @category  Tools
20  * @package   Grauphel
21  * @author    Christian Weiske <cweiske@cweiske.de>
22  * @copyright 2014 Christian Weiske
23  * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
24  * @version   Release: @package_version@
25  * @link      http://cweiske.de/grauphel.htm
26  */
27 class NoteStorage
28 {
29     protected $urlGen;
30     protected $username;
31
32     public function __construct($urlGen)
33     {
34         $this->urlGen   = $urlGen;
35     }
36
37     public function setUsername($username)
38     {
39         $this->username = $username;
40     }
41
42     /**
43      * Create a new sync data object for fresh users.
44      * Used by loadSyncData()
45      *
46      * @return SyncData New synchronization statistics
47      */
48     protected function getNewSyncData()
49     {
50         $syncdata = new SyncData();
51         $syncdata->initNew($this->username);
52         return $syncdata;
53     }
54
55     public function getTags()
56     {
57         $result = \OC_DB::executeAudited(
58             'SELECT `note_tags` FROM `*PREFIX*grauphel_notes`'
59             . ' WHERE note_user = ?',
60             array($this->username)
61         );
62
63         $tags = array();
64         while ($row = $result->fetchRow()) {
65             $tags = array_merge($tags, json_decode($row['note_tags']));
66         }
67         return array_unique($tags);
68     }
69
70     /**
71      * Updates the given $note object with data from $noteUpdate.
72      * Sets the last-sync-revision to $syncRevision
73      *
74      * @param object  $note         Original note object
75      * @param object  $noteUpdate   Update note object from a PUT to the API
76      * @param integer $syncRevision Current sync revision number
77      *
78      * @return void
79      */
80     public function update($note, $noteUpdate, $syncRevision)
81     {
82         static $updateFields = array(
83             'create-date',
84             'last-change-date',
85             'last-metadata-change-date',
86             'note-content',
87             'note-content-version',
88             'open-on-startup',
89             'pinned',
90             'tags',
91             'title',
92         );
93
94         $changed = array();
95         foreach ($updateFields as $field) {
96             $changed[$field] = false;
97             if (isset($noteUpdate->$field)) {
98                 if ($note->$field != $noteUpdate->$field) {
99                     $note->$field = $noteUpdate->$field;
100                     $changed[$field] = true;
101                 }
102             }
103         }
104
105         if (!isset($noteUpdate->{'last-change-date'})
106             && ($changed['title'] || $changed['note-content'])
107         ) {
108             //no idea how to get the microseconds in there
109             $note->{'last-change-date'} = date('c');
110         }
111
112         if (!isset($noteUpdate->{'last-metadata-change-date'})) {
113             //no idea how to get the microseconds in there
114             $note->{'last-metadata-change-date'} = date('c');
115         }
116
117         if (isset($noteUpdate->{'node-content'})
118             && $note->{'note-content-version'} == 0
119         ) {
120             $note->{'note-content-version'} = 0.3;
121         }
122
123         $note->{'last-sync-revision'} = $syncRevision;
124     }
125
126     /**
127      * Loads synchronization data for the given user.
128      * Creates fresh sync data if there are none for the user.
129      *
130      * @return SyncData Synchronization statistics (revision, sync guid)
131      */
132     public function loadSyncData()
133     {
134         $row = \OC_DB::executeAudited(
135             'SELECT * FROM `*PREFIX*grauphel_syncdata`'
136             . ' WHERE `syncdata_user` = ?',
137             array($this->username)
138         )->fetchRow();
139
140         if ($row === false) {
141             $syncdata = $this->getNewSyncData();
142             $this->saveSyncData($syncdata);
143         } else {
144             $syncdata = new SyncData();
145             $syncdata->latestSyncRevision = (int) $row['syncdata_latest_sync_revision'];
146             $syncdata->currentSyncGuid    = $row['syncdata_current_sync_guid'];
147         }
148
149         return $syncdata;
150     }
151
152     /**
153      * Save synchronization data for the given user.
154      *
155      * @param SyncData $syncdata Synchronization data object
156      *
157      * @return void
158      */
159     public function saveSyncData(SyncData $syncdata)
160     {
161         $row = \OC_DB::executeAudited(
162             'SELECT * FROM `*PREFIX*grauphel_syncdata`'
163             . ' WHERE `syncdata_user` = ?',
164             array($this->username)
165         )->fetchRow();
166
167         if ($row === false) {
168             //INSERT
169             $sql = 'INSERT INTO `*PREFIX*grauphel_syncdata`'
170                 . '(`syncdata_user`, `syncdata_latest_sync_revision`, `syncdata_current_sync_guid`)'
171                 . ' VALUES(?, ?, ?)';
172             $params = array(
173                 $this->username,
174                 $syncdata->latestSyncRevision,
175                 $syncdata->currentSyncGuid
176             );
177         } else {
178             //UPDATE
179             $data = array(
180                 'syncdata_latest_sync_revision' => $syncdata->latestSyncRevision,
181                 'syncdata_current_sync_guid'    => $syncdata->currentSyncGuid,
182             );
183             $sql = 'UPDATE `*PREFIX*grauphel_syncdata` SET'
184                 . ' `' . implode('` = ?, `', array_keys($data)) . '` = ?'
185                 . ' WHERE `syncdata_user` = ?';
186             $params = array_values($data);
187             $params[] = $this->username;
188         }
189         \OC_DB::executeAudited($sql, $params);
190     }
191
192     /**
193      * Delete synchronization data for the given user.
194      *
195      * @param SyncData $syncdata Synchronization data object
196      *
197      * @return void
198      */
199     public function deleteSyncData()
200     {
201         \OC_DB::executeAudited(
202             'DELETE FROM `*PREFIX*grauphel_syncdata`'
203             . ' WHERE `syncdata_user` = ?',
204             array($this->username)
205         );
206     }
207
208     /**
209      * Load a note from the storage.
210      *
211      * @param string  $guid      Note identifier
212      * @param boolean $createNew Create a new note if it does not exist
213      *
214      * @return object Note object, NULL if !$createNew and note does not exist
215      */
216     public function load($guid, $createNew = true)
217     {
218         $row = \OC_DB::executeAudited(
219             'SELECT * FROM `*PREFIX*grauphel_notes`'
220             . ' WHERE `note_user` = ? AND `note_guid` = ?',
221             array($this->username, $guid)
222         )->fetchRow();
223
224         if ($row === false) {
225             if (!$createNew) {
226                 return null;
227             }
228             return (object) array(
229                 'guid' => $guid,
230
231                 'create-date'               => null,
232                 'last-change-date'          => null,
233                 'last-metadata-change-date' => null,
234
235                 'title'                => null,
236                 'note-content'         => null,
237                 'note-content-version' => 0.3,
238
239                 'open-on-startup' => false,
240                 'pinned'          => false,
241                 'tags'            => array(),
242             );
243         }
244
245         return $this->noteFromRow($row);
246     }
247
248     /**
249      * Save a note into storage.
250      *
251      * @param object $note Note to save
252      *
253      * @return void
254      */
255     public function save($note)
256     {
257         $row = \OC_DB::executeAudited(
258             'SELECT * FROM `*PREFIX*grauphel_notes`'
259             . ' WHERE `note_user` = ? AND `note_guid` = ?',
260             array($this->username, $note->guid)
261         )->fetchRow();
262
263         $data = $this->rowFromNote($note);
264         if ($row === false) {
265             //INSERT
266             $data['note_user'] = $this->username;
267             $sql = 'INSERT INTO `*PREFIX*grauphel_notes`'
268                 . ' (`' . implode('`, `', array_keys($data)) . '`)'
269                 . ' VALUES(' . implode(', ', array_fill(0, count($data), '?')) . ')';
270             $params = array_values($data);
271         } else {
272             //UPDATE
273             $sql = 'UPDATE `*PREFIX*grauphel_notes` SET '
274                 . '`' . implode('` = ?, `', array_keys($data)) . '` = ?'
275                 . ' WHERE `note_user` = ? AND `note_guid` = ?';
276             $params = array_values($data);
277             $params[] = $this->username;
278             $params[] = $note->guid;
279         }
280         \OC_DB::executeAudited($sql, $params);
281     }
282
283     /**
284      * Delete a note from storage.
285      *
286      * @param object $guid ID of the note
287      *
288      * @return void
289      */
290     public function delete($guid)
291     {
292         \OC_DB::executeAudited(
293             'DELETE FROM `*PREFIX*grauphel_notes`'
294             . ' WHERE `note_user` = ? AND `note_guid` = ?',
295             array($this->username, $guid)
296         );
297     }
298
299     /**
300      * Delete all notes from storage.
301      *
302      * @return void
303      */
304     public function deleteAll()
305     {
306         \OC_DB::executeAudited(
307             'DELETE FROM `*PREFIX*grauphel_notes`'
308             . ' WHERE `note_user` = ?',
309             array($this->username)
310         );
311     }
312
313     /**
314      * Load notes for the given user in short form.
315      * Optionally only those changed after $since revision
316      *
317      * @param integer $since  Revision number after which the notes changed
318      * @param string  $rawtag Filter by tag. Special tags:
319      *                        - grauphel:special:all
320      *                        - grauphel:special:untagged
321      *
322      * @return array Array of short note objects
323      */
324     public function loadNotesOverview($since = null, $rawtag = null)
325     {
326         $result = \OC_DB::executeAudited(
327             'SELECT `note_guid`, `note_title`, `note_last_sync_revision`, `note_tags`'
328             . ' FROM `*PREFIX*grauphel_notes`'
329             . ' WHERE note_user = ?',
330             array($this->username)
331         );
332
333         $notes = array();
334         if ($rawtag == 'grauphel:special:all') {
335             $rawtag = null;
336         } else if ($rawtag == 'grauphel:special:untagged') {
337             $jsRawtag = json_encode(array());
338         } else {
339             $jsRawtag = json_encode($rawtag);
340         }
341         while ($row = $result->fetchRow()) {
342             if ($since !== null && $row['note_last_sync_revision'] <= $since) {
343                 continue;
344             }
345             if ($rawtag !== null && strpos($row['note_tags'], $jsRawtag) === false) {
346                 continue;
347             }
348             $notes[] = array(
349                 'guid' => $row['note_guid'],
350                 'ref'  => array(
351                     'api-ref' => $this->urlGen->getAbsoluteURL(
352                         $this->urlGen->linkToRoute(
353                             'grauphel.api.note',
354                             array(
355                                 'username' => $this->username,
356                                 'guid' => $row['note_guid']
357                             )
358                         )
359                     ),
360                     'href' => null,//FIXME
361                 ),
362                 'title' => $row['note_title'],
363             );
364         }
365
366         return $notes;
367     }
368
369     /**
370      * Load notes for the given user in full form.
371      * Optionally only those changed after $since revision
372      *
373      * @param integer $since Revision number after which the notes changed
374      *
375      * @return array Array of full note objects
376      */
377     public function loadNotesFull($since = null)
378     {
379         $result = \OC_DB::executeAudited(
380             'SELECT * FROM `*PREFIX*grauphel_notes`'
381             . ' WHERE note_user = ?',
382             array($this->username)
383         );
384
385         $notes = array();
386         while ($row = $result->fetchRow()) {
387             if ($since !== null && $row['note_last_sync_revision'] <= $since) {
388                 continue;
389             }
390             $notes[] = $this->noteFromRow($row);
391         }
392
393         return $notes;
394     }
395
396     protected function fixDate($date)
397     {
398         if (strlen($date) == 32) {
399             //Bug in grauphel 0.1.1; date fields in DB had only 32 instead of 33
400             // characters. The last digit of the time zone was missing
401             $date .= '0';
402         }
403         return $date;
404     }
405
406     protected function noteFromRow($row)
407     {
408         return (object) array(
409             'guid'  => $row['note_guid'],
410
411             'create-date'               => $this->fixDate($row['note_create_date']),
412             'last-change-date'          => $this->fixDate($row['note_last_change_date']),
413             'last-metadata-change-date' => $this->fixDate($row['note_last_metadata_change_date']),
414
415             'title'                => $row['note_title'],
416             'note-content'         => $row['note_content'],
417             'note-content-version' => $row['note_content_version'],
418
419             'open-on-startup' => (bool) $row['note_open_on_startup'],
420             'pinned'          => (bool) $row['note_pinned'],
421             'tags'            => json_decode($row['note_tags']),
422
423             'last-sync-revision' => (int) $row['note_last_sync_revision'],
424         );
425     }
426
427     protected function rowFromNote($note)
428     {
429         return array(
430             'note_guid'  => $note->guid,
431             'note_title' => (string) $note->title,
432
433             'note_content'         => (string) $note->{'note-content'},
434             'note_content_version' => (string) $note->{'note-content-version'},
435
436             'note_create_date'               => $note->{'create-date'},
437             'note_last_change_date'          => $note->{'last-change-date'},
438             'note_last_metadata_change_date' => $note->{'last-metadata-change-date'},
439
440             'note_open_on_startup' => (int) $note->{'open-on-startup'},
441             'note_pinned'          => (int) $note->pinned,
442             'note_tags'            => json_encode($note->tags),
443
444             'note_last_sync_revision' => $note->{'last-sync-revision'},
445         );
446     }
447 }
448 ?>