]>
git.immae.eu Git - github/wallabag/wallabag.git/blob - src/Wallabag/Wallabag/Database.php
fa13291019bc15b4709281b0e807fb5a621e3675
3 * wallabag, self hostable application allowing you to not miss any content anymore
6 * @author Nicolas LÅ“uillet <nicolas@loeuillet.org>
8 * @license http://opensource.org/licenses/MIT see COPYING file
11 namespace Wallabag\Wallabag
;
18 private $order = array (
19 'ia' => 'ORDER BY entries.id',
20 'id' => 'ORDER BY entries.id DESC',
21 'ta' => 'ORDER BY lower(entries.title)',
22 'td' => 'ORDER BY lower(entries.title) DESC',
23 'default' => 'ORDER BY entries.id'
26 function __construct()
30 // Check if /db is writeable
31 if ( !is_writable(STORAGE_SQLITE
) || !is_writable(dirname(STORAGE_SQLITE
))) {
32 die('An error occured: ' . STORAGE_SQLITE
. ' directory must be writeable for your web server user!');
34 $db_path = 'sqlite:' . STORAGE_SQLITE
;
35 $this->handle
= new PDO($db_path);
38 $db_path = 'mysql:host=' . STORAGE_SERVER
. ';dbname=' . STORAGE_DB
. ';charset=utf8mb4';
39 $this->handle
= new PDO($db_path, STORAGE_USER
, STORAGE_PASSWORD
, array(
40 PDO
::MYSQL_ATTR_INIT_COMMAND
=> 'SET NAMES utf8mb4',
44 $db_path = 'pgsql:host=' . STORAGE_SERVER
. ';dbname=' . STORAGE_DB
;
45 $this->handle
= new PDO($db_path, STORAGE_USER
, STORAGE_PASSWORD
);
48 die(STORAGE
. ' is not a recognised database system !');
51 $this->handle
->setAttribute(PDO
::ATTR_ERRMODE
, PDO
::ERRMODE_EXCEPTION
);
53 Tools
::logm('storage type ' . STORAGE
);
56 private function getHandle()
61 private function _checkTags()
64 if (STORAGE
== 'sqlite') {
66 CREATE TABLE IF NOT EXISTS tags (
67 id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL UNIQUE,
71 elseif(STORAGE
== 'mysql') {
73 CREATE TABLE IF NOT EXISTS `tags` (
74 `id` int(11) NOT NULL AUTO_INCREMENT,
75 `value` varchar(255) NOT NULL,
77 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
82 CREATE TABLE IF NOT EXISTS tags (
83 id bigserial primary key,
84 value varchar(255) NOT NULL
89 $query = $this->executeQuery($sql, array());
91 if (STORAGE
== 'sqlite') {
93 CREATE TABLE IF NOT EXISTS tags_entries (
94 id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL UNIQUE,
97 FOREIGN KEY(entry_id) REFERENCES entries(id) ON DELETE CASCADE,
98 FOREIGN KEY(tag_id) REFERENCES tags(id) ON DELETE CASCADE
101 elseif(STORAGE
== 'mysql') {
103 CREATE TABLE IF NOT EXISTS `tags_entries` (
104 `id` int(11) NOT NULL AUTO_INCREMENT,
105 `entry_id` int(11) NOT NULL,
106 `tag_id` int(11) NOT NULL,
107 FOREIGN KEY(entry_id) REFERENCES entries(id) ON DELETE CASCADE,
108 FOREIGN KEY(tag_id) REFERENCES tags(id) ON DELETE CASCADE,
110 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
115 CREATE TABLE IF NOT EXISTS tags_entries (
116 id bigserial primary key,
117 entry_id integer NOT NULL,
118 tag_id integer NOT NULL
123 $query = $this->executeQuery($sql, array());
126 public function install($login, $password, $email = '')
128 $sql = 'INSERT INTO users ( username, password, name, email) VALUES (?, ?, ?, ?)';
129 $params = array($login, $password, $login, $email);
130 $query = $this->executeQuery($sql, $params);
133 if (STORAGE
== 'postgres') {
134 $sequence = 'users_id_seq';
137 $id_user = intval($this->getLastId($sequence));
139 $sql = 'INSERT INTO users_config ( user_id, name, value ) VALUES (?, ?, ?)';
140 $params = array($id_user, 'pager', PAGINATION
);
141 $query = $this->executeQuery($sql, $params);
143 $sql = 'INSERT INTO users_config ( user_id, name, value ) VALUES (?, ?, ?)';
144 $params = array($id_user, 'language', LANG
);
145 $query = $this->executeQuery($sql, $params);
147 $sql = 'INSERT INTO users_config ( user_id, name, value ) VALUES (?, ?, ?)';
148 $params = array($id_user, 'theme', DEFAULT_THEME
);
149 $query = $this->executeQuery($sql, $params);
154 public function getConfigUser($id)
156 $sql = "SELECT * FROM users_config WHERE user_id = ?";
157 $query = $this->executeQuery($sql, array($id));
158 $result = $query->fetchAll();
159 $user_config = array();
161 foreach ($result as $key => $value) {
162 $user_config[$value['name']] = $value['value'];
168 public function userExists($username)
170 $sql = "SELECT * FROM users WHERE username=?";
171 $query = $this->executeQuery($sql, array($username));
172 $login = $query->fetchAll();
173 if (isset($login[0])) {
180 public function login($username, $password, $isauthenticated = FALSE)
182 if ($isauthenticated) {
183 $sql = "SELECT * FROM users WHERE username=?";
184 $query = $this->executeQuery($sql, array($username));
186 $sql = "SELECT * FROM users WHERE username=? AND password=?";
187 $query = $this->executeQuery($sql, array($username, $password));
189 $login = $query->fetchAll();
192 if (isset($login[0])) {
193 $user['id'] = $login[0]['id'];
194 $user['username'] = $login[0]['username'];
195 $user['password'] = $login[0]['password'];
196 $user['name'] = $login[0]['name'];
197 $user['email'] = $login[0]['email'];
198 $user['config'] = $this->getConfigUser($login[0]['id']);
204 public function updatePassword($userId, $password)
206 $sql_update = "UPDATE users SET password=? WHERE id=?";
207 $params_update = array($password, $userId);
208 $query = $this->executeQuery($sql_update, $params_update);
211 public function updateUserConfig($userId, $key, $value)
213 $config = $this->getConfigUser($userId);
215 if (! isset($config[$key])) {
216 $sql = "INSERT INTO users_config (value, user_id, name) VALUES (?, ?, ?)";
219 $sql = "UPDATE users_config SET value=? WHERE user_id=? AND name=?";
222 $params = array($value, $userId, $key);
223 $query = $this->executeQuery($sql, $params);
226 private function executeQuery($sql, $params)
230 $query = $this->getHandle()->prepare($sql);
231 $query->execute($params);
236 Tools
::logm('execute query error : '.$e->getMessage());
241 public function listUsers($username = NULL)
243 $sql = 'SELECT count(*) FROM users'.( $username ? ' WHERE username=?' : '');
244 $query = $this->executeQuery($sql, ( $username ? array($username) : array()));
245 list($count) = $query->fetch();
249 public function getUserPassword($userID)
251 $sql = "SELECT * FROM users WHERE id=?";
252 $query = $this->executeQuery($sql, array($userID));
253 $password = $query->fetchAll();
254 return isset($password[0]['password']) ? $password[0]['password'] : null;
257 public function deleteUserConfig($userID)
259 $sql_action = 'DELETE from users_config WHERE user_id=?';
260 $params_action = array($userID);
261 $query = $this->executeQuery($sql_action, $params_action);
265 public function deleteTagsEntriesAndEntries($userID)
267 $entries = $this->retrieveAll($userID);
268 foreach($entries as $entryid) {
269 $tags = $this->retrieveTagsByEntry($entryid);
270 foreach($tags as $tag) {
271 $this->removeTagForEntry($entryid,$tags);
273 $this->deleteById($entryid,$userID);
277 public function deleteUser($userID)
279 $sql_action = 'DELETE from users WHERE id=?';
280 $params_action = array($userID);
281 $query = $this->executeQuery($sql_action, $params_action);
284 public function updateContentAndTitle($id, $title, $body, $user_id)
286 $sql_action = 'UPDATE entries SET content = ?, title = ? WHERE id=? AND user_id=?';
287 $params_action = array($body, $title, $id, $user_id);
288 $query = $this->executeQuery($sql_action, $params_action);
292 public function retrieveUnfetchedEntries($user_id, $limit)
295 $sql_limit = "LIMIT 0,".$limit;
296 if (STORAGE
== 'postgres') {
297 $sql_limit = "LIMIT ".$limit." OFFSET 0";
300 $sql = "SELECT * FROM entries WHERE (content = '' OR content IS NULL) AND title LIKE 'Untitled - Import%' AND user_id=? ORDER BY id " . $sql_limit;
301 $query = $this->executeQuery($sql, array($user_id));
302 $entries = $query->fetchAll();
307 public function retrieveUnfetchedEntriesCount($user_id)
309 $sql = "SELECT count(*) FROM entries WHERE (content = '' OR content IS NULL) AND title LIKE 'Untitled - Import%' AND user_id=?";
310 $query = $this->executeQuery($sql, array($user_id));
311 list($count) = $query->fetch();
316 public function retrieveAll($user_id)
318 $sql = "SELECT * FROM entries WHERE user_id=? ORDER BY id";
319 $query = $this->executeQuery($sql, array($user_id));
320 $entries = $query->fetchAll();
325 public function retrieveOneById($id, $user_id)
328 $sql = "SELECT * FROM entries WHERE id=? AND user_id=?";
329 $params = array(intval($id), $user_id);
330 $query = $this->executeQuery($sql, $params);
331 $entry = $query->fetchAll();
333 return isset($entry[0]) ? $entry[0] : null;
336 public function retrieveOneByURL($url, $user_id)
339 $sql = "SELECT * FROM entries WHERE url=? AND user_id=?";
340 $params = array($url, $user_id);
341 $query = $this->executeQuery($sql, $params);
342 $entry = $query->fetchAll();
344 return isset($entry[0]) ? $entry[0] : null;
347 public function reassignTags($old_entry_id, $new_entry_id)
349 $sql = "UPDATE tags_entries SET entry_id=? WHERE entry_id=?";
350 $params = array($new_entry_id, $old_entry_id);
351 $query = $this->executeQuery($sql, $params);
354 public function getEntriesByView($view, $user_id, $limit = '', $tag_id = 0)
358 $sql = "SELECT * FROM entries WHERE user_id=? AND is_read=? ";
359 $params = array($user_id, 1);
362 $sql = "SELECT * FROM entries WHERE user_id=? AND is_fav=? ";
363 $params = array($user_id, 1);
366 $sql = "SELECT entries.* FROM entries
367 LEFT JOIN tags_entries ON tags_entries.entry_id=entries.id
368 WHERE entries.user_id=? AND tags_entries.tag_id = ? ";
369 $params = array($user_id, $tag_id);
372 $sql = "SELECT * FROM entries WHERE user_id=? AND is_read=? ";
373 $params = array($user_id, 0);
377 $sql .= $this->getEntriesOrder().' ' . $limit;
379 $query = $this->executeQuery($sql, $params);
380 $entries = $query->fetchAll();
385 public function getEntriesByViewCount($view, $user_id, $tag_id = 0)
389 $sql = "SELECT count(*) FROM entries WHERE user_id=? AND is_read=? ";
390 $params = array($user_id, 1);
393 $sql = "SELECT count(*) FROM entries WHERE user_id=? AND is_fav=? ";
394 $params = array($user_id, 1);
397 $sql = "SELECT count(*) FROM entries
398 LEFT JOIN tags_entries ON tags_entries.entry_id=entries.id
399 WHERE entries.user_id=? AND tags_entries.tag_id = ? ";
400 $params = array($user_id, $tag_id);
403 $sql = "SELECT count(*) FROM entries WHERE user_id=? AND is_read=? ";
404 $params = array($user_id, 0);
408 $query = $this->executeQuery($sql, $params);
409 list($count) = $query->fetch();
414 public function updateContent($id, $content, $user_id)
416 $sql_action = 'UPDATE entries SET content = ? WHERE id=? AND user_id=?';
417 $params_action = array($content, $id, $user_id);
418 $query = $this->executeQuery($sql_action, $params_action);
425 * @param string $title
426 * @param string $content
427 * @param integer $user_id
428 * @return integer $id of inserted record
430 public function add($url, $title, $content, $user_id, $isFavorite=0, $isRead=0)
432 $sql_action = 'INSERT INTO entries ( url, title, content, user_id, is_fav, is_read ) VALUES (?, ?, ?, ?, ?, ?)';
433 $params_action = array($url, $title, $content, $user_id, $isFavorite, $isRead);
435 if ( !$this->executeQuery($sql_action, $params_action) ) {
439 $id = intval($this->getLastId( (STORAGE
== 'postgres') ? 'entries_id_seq' : '') );
444 public function deleteById($id, $user_id)
446 $sql_action = "DELETE FROM entries WHERE id=? AND user_id=?";
447 $params_action = array($id, $user_id);
448 $query = $this->executeQuery($sql_action, $params_action);
452 public function favoriteById($id, $user_id)
454 $sql_action = "UPDATE entries SET is_fav=NOT is_fav WHERE id=? AND user_id=?";
455 $params_action = array($id, $user_id);
456 $query = $this->executeQuery($sql_action, $params_action);
459 public function archiveById($id, $user_id)
461 $sql_action = "UPDATE entries SET is_read=NOT is_read WHERE id=? AND user_id=?";
462 $params_action = array($id, $user_id);
463 $query = $this->executeQuery($sql_action, $params_action);
466 public function archiveAll($user_id)
468 $sql_action = "UPDATE entries SET is_read=? WHERE user_id=? AND is_read=?";
469 $params_action = array($user_id, 1, 0);
470 $query = $this->executeQuery($sql_action, $params_action);
473 public function getLastId($column = '')
475 return $this->getHandle()->lastInsertId($column);
478 public function search($term, $user_id, $limit = '')
480 $search = '%'.$term.'%';
481 $sql_action = "SELECT * FROM entries WHERE user_id=? AND (content LIKE ? OR title LIKE ? OR url LIKE ?) "; //searches in content, title and URL
482 $sql_action .= $this->getEntriesOrder().' ' . $limit;
483 $params_action = array($user_id, $search, $search, $search);
484 $query = $this->executeQuery($sql_action, $params_action);
485 return $query->fetchAll();
488 public function retrieveAllTags($user_id, $term = NULL)
490 $sql = "SELECT DISTINCT tags.*, count(entries.id) AS entriescount FROM tags
491 LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
492 LEFT JOIN entries ON tags_entries.entry_id=entries.id
493 WHERE entries.user_id=?
494 ". (($term) ? "AND lower(tags.value) LIKE ?" : '') ."
495 GROUP BY tags.id, tags.value
496 ORDER BY tags.value";
497 $query = $this->executeQuery($sql, (($term)? array($user_id, strtolower('%'.$term.'%')) : array($user_id) ));
498 $tags = $query->fetchAll();
503 public function retrieveTag($id, $user_id)
506 $sql = "SELECT DISTINCT tags.* FROM tags
507 LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
508 LEFT JOIN entries ON tags_entries.entry_id=entries.id
509 WHERE tags.id=? AND entries.user_id=?";
510 $params = array(intval($id), $user_id);
511 $query = $this->executeQuery($sql, $params);
512 $tag = $query->fetchAll();
514 return isset($tag[0]) ? $tag[0] : NULL;
517 public function retrieveEntriesByTag($tag_id, $user_id)
520 "SELECT entries.* FROM entries
521 LEFT JOIN tags_entries ON tags_entries.entry_id=entries.id
522 WHERE tags_entries.tag_id = ? AND entries.user_id=? ORDER by entries.id DESC";
523 $query = $this->executeQuery($sql, array($tag_id, $user_id));
524 $entries = $query->fetchAll();
529 public function retrieveTagsByEntry($entry_id)
532 "SELECT tags.* FROM tags
533 LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
534 WHERE tags_entries.entry_id = ?";
535 $query = $this->executeQuery($sql, array($entry_id));
536 $tags = $query->fetchAll();
541 public function removeTagForEntry($entry_id, $tag_id)
543 $sql_action = "DELETE FROM tags_entries WHERE tag_id=? AND entry_id=?";
544 $params_action = array($tag_id, $entry_id);
545 $query = $this->executeQuery($sql_action, $params_action);
549 public function cleanUnusedTag($tag_id)
551 $sql_action = "SELECT tags.* FROM tags JOIN tags_entries ON tags_entries.tag_id=tags.id WHERE tags.id=?";
552 $query = $this->executeQuery($sql_action,array($tag_id));
553 $tagstokeep = $query->fetchAll();
554 $sql_action = "SELECT tags.* FROM tags LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id WHERE tags.id=?";
555 $query = $this->executeQuery($sql_action,array($tag_id));
556 $alltags = $query->fetchAll();
558 foreach ($alltags as $tag) {
559 if ($tag && !in_array($tag,$tagstokeep)) {
560 $sql_action = "DELETE FROM tags WHERE id=?";
561 $params_action = array($tag[0]);
562 $this->executeQuery($sql_action, $params_action);
569 public function retrieveTagByValue($value)
572 $sql = "SELECT * FROM tags WHERE value=?";
573 $params = array($value);
574 $query = $this->executeQuery($sql, $params);
575 $tag = $query->fetchAll();
577 return isset($tag[0]) ? $tag[0] : null;
580 public function createTag($value)
582 $sql_action = 'INSERT INTO tags ( value ) VALUES (?)';
583 $params_action = array($value);
584 $query = $this->executeQuery($sql_action, $params_action);
588 public function setTagToEntry($tag_id, $entry_id)
590 $sql_action = 'INSERT INTO tags_entries ( tag_id, entry_id ) VALUES (?, ?)';
591 $params_action = array($tag_id, $entry_id);
592 $query = $this->executeQuery($sql_action, $params_action);
596 private function getEntriesOrder()
598 if (isset($_SESSION['sort']) and array_key_exists($_SESSION['sort'], $this->order
)) {
599 return $this->order
[$_SESSION['sort']];
602 return $this->order
['default'];