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
14 namespace OCA\Grauphel\Lib;
17 * Flat file storage for notes
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
32 public function __construct($urlGen)
34 $this->urlGen = $urlGen;
37 public function setUsername($username)
39 $this->username = $username;
43 * Create a new sync data object for fresh users.
44 * Used by loadSyncData()
46 * @return SyncData New synchronization statistics
48 protected function getNewSyncData()
50 $syncdata = new SyncData();
51 $syncdata->initNew($this->username);
55 public function getTags()
57 $result = \OC_DB::executeAudited(
58 'SELECT `note_tags` FROM `*PREFIX*grauphel_notes`'
59 . ' WHERE note_user = ?',
60 array($this->username)
64 while ($row = $result->fetchRow()) {
65 $tags = array_merge($tags, json_decode($row['note_tags']));
67 return array_unique($tags);
71 * Updates the given $note object with data from $noteUpdate.
72 * Sets the last-sync-revision to $syncRevision
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
80 public function update($note, $noteUpdate, $syncRevision)
82 static $updateFields = array(
85 'last-metadata-change-date',
87 'note-content-version',
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;
105 if (!isset($noteUpdate->{'last-change-date'})
106 && ($changed['title'] || $changed['note-content'])
108 //no idea how to get the microseconds in there
109 $note->{'last-change-date'} = date('c');
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');
117 if (isset($noteUpdate->{'node-content'})
118 && $note->{'note-content-version'} == 0
120 $note->{'note-content-version'} = 0.3;
123 $note->{'last-sync-revision'} = $syncRevision;
127 * Loads synchronization data for the given user.
128 * Creates fresh sync data if there are none for the user.
130 * @return SyncData Synchronization statistics (revision, sync guid)
132 public function loadSyncData()
134 $row = \OC_DB::executeAudited(
135 'SELECT * FROM `*PREFIX*grauphel_syncdata`'
136 . ' WHERE `syncdata_user` = ?',
137 array($this->username)
140 if ($row === false) {
141 $syncdata = $this->getNewSyncData();
142 $this->saveSyncData($syncdata);
144 $syncdata = new SyncData();
145 $syncdata->latestSyncRevision = (int) $row['syncdata_latest_sync_revision'];
146 $syncdata->currentSyncGuid = $row['syncdata_current_sync_guid'];
153 * Save synchronization data for the given user.
155 * @param SyncData $syncdata Synchronization data object
159 public function saveSyncData(SyncData $syncdata)
161 $row = \OC_DB::executeAudited(
162 'SELECT * FROM `*PREFIX*grauphel_syncdata`'
163 . ' WHERE `syncdata_user` = ?',
164 array($this->username)
167 if ($row === false) {
169 $sql = 'INSERT INTO `*PREFIX*grauphel_syncdata`'
170 . '(`syncdata_user`, `syncdata_latest_sync_revision`, `syncdata_current_sync_guid`)'
171 . ' VALUES(?, ?, ?)';
174 $syncdata->latestSyncRevision,
175 $syncdata->currentSyncGuid
180 'syncdata_latest_sync_revision' => $syncdata->latestSyncRevision,
181 'syncdata_current_sync_guid' => $syncdata->currentSyncGuid,
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;
189 \OC_DB::executeAudited($sql, $params);
193 * Delete synchronization data for the given user.
195 * @param SyncData $syncdata Synchronization data object
199 public function deleteSyncData()
201 \OC_DB::executeAudited(
202 'DELETE FROM `*PREFIX*grauphel_syncdata`'
203 . ' WHERE `syncdata_user` = ?',
204 array($this->username)
209 * Load a note from the storage.
211 * @param string $guid Note identifier
212 * @param boolean $createNew Create a new note if it does not exist
214 * @return object Note object, NULL if !$createNew and note does not exist
216 public function load($guid, $createNew = true)
218 $row = \OC_DB::executeAudited(
219 'SELECT * FROM `*PREFIX*grauphel_notes`'
220 . ' WHERE `note_user` = ? AND `note_guid` = ?',
221 array($this->username, $guid)
224 if ($row === false) {
228 return (object) array(
231 'create-date' => null,
232 'last-change-date' => null,
233 'last-metadata-change-date' => null,
236 'note-content' => null,
237 'note-content-version' => 0.3,
239 'open-on-startup' => false,
245 return $this->noteFromRow($row);
249 * Load a GUID of a note by the note title.
251 * The note title is stored html-escaped in the database because we
252 * get it that way from tomboy. Thus we have to escape the search
255 * @param string $title Note title.
257 * @return string GUID, NULL if note could not be found
259 public function loadGuidByTitle($title)
261 $row = \OC_DB::executeAudited(
262 'SELECT note_guid FROM `*PREFIX*grauphel_notes`'
263 . ' WHERE `note_user` = ? AND `note_title` = ?',
264 array($this->username, htmlspecialchars($title))
267 if ($row === false) {
271 return $row['note_guid'];
275 * Save a note into storage.
277 * @param object $note Note to save
281 public function save($note)
283 $row = \OC_DB::executeAudited(
284 'SELECT * FROM `*PREFIX*grauphel_notes`'
285 . ' WHERE `note_user` = ? AND `note_guid` = ?',
286 array($this->username, $note->guid)
289 $data = $this->rowFromNote($note);
290 if ($row === false) {
292 $data['note_user'] = $this->username;
293 $sql = 'INSERT INTO `*PREFIX*grauphel_notes`'
294 . ' (`' . implode('`, `', array_keys($data)) . '`)'
295 . ' VALUES(' . implode(', ', array_fill(0, count($data), '?')) . ')';
296 $params = array_values($data);
299 $sql = 'UPDATE `*PREFIX*grauphel_notes` SET '
300 . '`' . implode('` = ?, `', array_keys($data)) . '` = ?'
301 . ' WHERE `note_user` = ? AND `note_guid` = ?';
302 $params = array_values($data);
303 $params[] = $this->username;
304 $params[] = $note->guid;
306 \OC_DB::executeAudited($sql, $params);
310 * Delete a note from storage.
312 * @param object $guid ID of the note
316 public function delete($guid)
318 \OC_DB::executeAudited(
319 'DELETE FROM `*PREFIX*grauphel_notes`'
320 . ' WHERE `note_user` = ? AND `note_guid` = ?',
321 array($this->username, $guid)
326 * Delete all notes from storage.
330 public function deleteAll()
332 \OC_DB::executeAudited(
333 'DELETE FROM `*PREFIX*grauphel_notes`'
334 . ' WHERE `note_user` = ?',
335 array($this->username)
340 * Load notes for the given user in short form.
341 * Optionally only those changed after $since revision
343 * @param integer $since Revision number after which the notes changed
344 * @param string $rawtag Filter by tag. Special tags:
345 * - grauphel:special:all
346 * - grauphel:special:untagged
348 * @return array Array of short note objects
350 public function loadNotesOverview($since = null, $rawtag = null)
352 $result = \OC_DB::executeAudited(
353 'SELECT `note_guid`, `note_title`, `note_last_sync_revision`, `note_tags`'
354 . ' FROM `*PREFIX*grauphel_notes`'
355 . ' WHERE note_user = ?',
356 array($this->username)
360 if ($rawtag == 'grauphel:special:all') {
362 } else if ($rawtag == 'grauphel:special:untagged') {
363 $jsRawtag = json_encode(array());
365 $jsRawtag = json_encode($rawtag);
367 while ($row = $result->fetchRow()) {
368 if ($since !== null && $row['note_last_sync_revision'] <= $since) {
371 if ($rawtag !== null && strpos($row['note_tags'], $jsRawtag) === false) {
375 'guid' => $row['note_guid'],
377 'api-ref' => $this->urlGen->getAbsoluteURL(
378 $this->urlGen->linkToRoute(
381 'username' => $this->username,
382 'guid' => $row['note_guid']
386 'href' => null,//FIXME
388 'title' => $row['note_title'],
396 * Load notes for the given user in full form.
397 * Optionally only those changed after $since revision
399 * @param integer $since Revision number after which the notes changed
401 * @return array Array of full note objects
403 public function loadNotesFull($since = null)
405 $result = \OC_DB::executeAudited(
406 'SELECT * FROM `*PREFIX*grauphel_notes`'
407 . ' WHERE note_user = ?',
408 array($this->username)
412 while ($row = $result->fetchRow()) {
413 if ($since !== null && $row['note_last_sync_revision'] <= $since) {
416 $notes[] = $this->noteFromRow($row);
422 protected function fixDate($date)
424 if (strlen($date) == 32) {
425 //Bug in grauphel 0.1.1; date fields in DB had only 32 instead of 33
426 // characters. The last digit of the time zone was missing
432 protected function noteFromRow($row)
434 return (object) array(
435 'guid' => $row['note_guid'],
437 'create-date' => $this->fixDate($row['note_create_date']),
438 'last-change-date' => $this->fixDate($row['note_last_change_date']),
439 'last-metadata-change-date' => $this->fixDate($row['note_last_metadata_change_date']),
441 'title' => $row['note_title'],
442 'note-content' => $row['note_content'],
443 'note-content-version' => $row['note_content_version'],
445 'open-on-startup' => (bool) $row['note_open_on_startup'],
446 'pinned' => (bool) $row['note_pinned'],
447 'tags' => json_decode($row['note_tags']),
449 'last-sync-revision' => (int) $row['note_last_sync_revision'],
453 protected function rowFromNote($note)
456 'note_guid' => $note->guid,
457 'note_title' => (string) $note->title,
459 'note_content' => (string) $note->{'note-content'},
460 'note_content_version' => (string) $note->{'note-content-version'},
462 'note_create_date' => $note->{'create-date'},
463 'note_last_change_date' => $note->{'last-change-date'},
464 'note_last_metadata_change_date' => $note->{'last-metadata-change-date'},
466 'note_open_on_startup' => (int) $note->{'open-on-startup'},
467 'note_pinned' => (int) $note->pinned,
468 'note_tags' => json_encode($note->tags),
470 'note_last_sync_revision' => $note->{'last-sync-revision'},