]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - inc/poche/Database.class.php
get up to date for merge
[github/wallabag/wallabag.git] / inc / poche / Database.class.php
index 02e8be8ba042fd71d3ed78baebb5d56441d8b656..b5dd21203a9a667872303bc71a0b97498f862769 100755 (executable)
@@ -5,23 +5,28 @@
  * @category   wallabag
  * @author     Nicolas LÅ“uillet <nicolas@loeuillet.org>
  * @copyright  2013
- * @license    http://www.wtfpl.net/ see COPYING file
+ * @license    http://opensource.org/licenses/MIT see COPYING file
  */
 
 class Database {
+
     var $handle;
-    private $order = array(
-      'ia' => 'ORDER BY entries.id',
-      'id' => 'ORDER BY entries.id DESC',
-      'ta' => 'ORDER BY lower(entries.title)',
-      'td' => 'ORDER BY lower(entries.title) DESC',
-      'default' => 'ORDER BY entries.id'
+    private $order = array (
+        'ia' => 'ORDER BY entries.id',
+        'id' => 'ORDER BY entries.id DESC',
+        'ta' => 'ORDER BY lower(entries.title)',
+        'td' => 'ORDER BY lower(entries.title) DESC',
+        'default' => 'ORDER BY entries.id'
     );
 
     function __construct()
     {
         switch (STORAGE) {
             case 'sqlite':
+                // Check if /db is writeable
+                if ( !is_writable(STORAGE_SQLITE) || !is_writable(dirname(STORAGE_SQLITE))) {\r
+                       die('An error occured: "db" directory must be writeable for your web server user!');
+                }
                 $db_path = 'sqlite:' . STORAGE_SQLITE;
                 $this->handle = new PDO($db_path);
                 break;
@@ -38,28 +43,17 @@ class Database {
         }
 
         $this->handle->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+        $this->_checkTags();
         Tools::logm('storage type ' . STORAGE);
     }
 
-    private function getHandle() {
+    private function getHandle()
+    {
         return $this->handle;
     }
 
-    public function isInstalled() {
-        $sql = "SELECT username FROM users";
-        $query = $this->executeQuery($sql, array());
-        if ($query == false) {
-            die(STORAGE . ' database looks empty. You have to create it (you can find database structure in install folder).');
-        }
-        $hasAdmin = count($query->fetchAll());
-
-        if ($hasAdmin == 0)
-            return false;
-
-        return true;
-    }
-
-    public function checkTags() {
+    private function _checkTags()
+    {
 
         if (STORAGE == 'sqlite') {
             $sql = '
@@ -123,9 +117,10 @@ class Database {
         $query = $this->executeQuery($sql, array());
     }
 
-    public function install($login, $password) {
+    public function install($login, $password, $email = '')
+    {
         $sql = 'INSERT INTO users ( username, password, name, email) VALUES (?, ?, ?, ?)';
-        $params = array($login, $password, $login, ' ');
+        $params = array($login, $password, $login, $email);
         $query = $this->executeQuery($sql, $params);
 
         $sequence = '';
@@ -150,7 +145,8 @@ class Database {
         return TRUE;
     }
 
-    public function getConfigUser($id) {
+    public function getConfigUser($id)
+    {
         $sql = "SELECT * FROM users_config WHERE user_id = ?";
         $query = $this->executeQuery($sql, array($id));
         $result = $query->fetchAll();
@@ -163,7 +159,8 @@ class Database {
         return $user_config;
     }
 
-    public function userExists($username) {
+    public function userExists($username)
+    {
         $sql = "SELECT * FROM users WHERE username=?";
         $query = $this->executeQuery($sql, array($username));
         $login = $query->fetchAll();
@@ -174,13 +171,14 @@ class Database {
         }
     }
 
-    public function login($username, $password, $isauthenticated=false) {
+    public function login($username, $password, $isauthenticated = FALSE)
+    {
         if ($isauthenticated) {
-          $sql = "SELECT * FROM users WHERE username=?";
-          $query = $this->executeQuery($sql, array($username));
+            $sql = "SELECT * FROM users WHERE username=?";
+            $query = $this->executeQuery($sql, array($username));
         } else {
-          $sql = "SELECT * FROM users WHERE username=? AND password=?";
-          $query = $this->executeQuery($sql, array($username, $password));
+            $sql = "SELECT * FROM users WHERE username=? AND password=?";
+            $query = $this->executeQuery($sql, array($username, $password));
         }
         $login = $query->fetchAll();
 
@@ -204,7 +202,8 @@ class Database {
         $query = $this->executeQuery($sql_update, $params_update);
     }
 
-    public function updateUserConfig($userId, $key, $value) {
+    public function updateUserConfig($userId, $key, $value)
+    {
         $config = $this->getConfigUser($userId);
 
         if (! isset($config[$key])) {
@@ -218,7 +217,8 @@ class Database {
         $query = $this->executeQuery($sql, $params);
     }
 
-    private function executeQuery($sql, $params) {
+    private function executeQuery($sql, $params)
+    {
         try
         {
             $query = $this->getHandle()->prepare($sql);
@@ -232,28 +232,32 @@ class Database {
         }
     }
     
-    public function listUsers($username=null) {
+    public function listUsers($username = NULL)
+    {
         $sql = 'SELECT count(*) FROM users'.( $username ? ' WHERE username=?' : '');
         $query = $this->executeQuery($sql, ( $username ? array($username) : array()));
         list($count) = $query->fetch();
         return $count;
     }
     
-    public function getUserPassword($userID) {
+    public function getUserPassword($userID)
+    {
         $sql = "SELECT * FROM users WHERE id=?";
         $query = $this->executeQuery($sql, array($userID));
         $password = $query->fetchAll();
         return isset($password[0]['password']) ? $password[0]['password'] : null;
     }
     
-    public function deleteUserConfig($userID) {
+    public function deleteUserConfig($userID)
+    {
         $sql_action = 'DELETE from users_config WHERE user_id=?';
         $params_action = array($userID);
         $query = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
     
-    public function deleteTagsEntriesAndEntries($userID) {
+    public function deleteTagsEntriesAndEntries($userID)
+    {
         $entries = $this->retrieveAll($userID);
         foreach($entries as $entryid) {
             $tags = $this->retrieveTagsByEntry($entryid);
@@ -264,20 +268,23 @@ class Database {
         }
     }
     
-    public function deleteUser($userID) {
+    public function deleteUser($userID)
+    {
         $sql_action = 'DELETE from users WHERE id=?';
         $params_action = array($userID);
         $query = $this->executeQuery($sql_action, $params_action);
     }
 
-    public function updateContentAndTitle($id, $title, $body, $user_id) {
+    public function updateContentAndTitle($id, $title, $body, $user_id)
+    {
         $sql_action = 'UPDATE entries SET content = ?, title = ? WHERE id=? AND user_id=?';
         $params_action = array($body, $title, $id, $user_id);
         $query = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
 
-    public function retrieveUnfetchedEntries($user_id, $limit) {
+    public function retrieveUnfetchedEntries($user_id, $limit)
+    {
 
         $sql_limit = "LIMIT 0,".$limit;
         if (STORAGE == 'postgres') {
@@ -291,7 +298,8 @@ class Database {
         return $entries;
     }
 
-    public function retrieveUnfetchedEntriesCount($user_id) {
+    public function retrieveUnfetchedEntriesCount($user_id)
+    {
       $sql        = "SELECT count(*) FROM entries WHERE (content = '' OR content IS NULL) AND title LIKE 'Untitled - Import%' AND user_id=?";
       $query      = $this->executeQuery($sql, array($user_id));
       list($count) = $query->fetch();
@@ -299,7 +307,8 @@ class Database {
       return $count;
     }
 
-    public function retrieveAll($user_id) {
+    public function retrieveAll($user_id)
+    {
         $sql        = "SELECT * FROM entries WHERE user_id=? ORDER BY id";
         $query      = $this->executeQuery($sql, array($user_id));
         $entries    = $query->fetchAll();
@@ -307,7 +316,8 @@ class Database {
         return $entries;
     }
 
-    public function retrieveOneById($id, $user_id) {
+    public function retrieveOneById($id, $user_id)
+    {
         $entry  = NULL;
         $sql    = "SELECT * FROM entries WHERE id=? AND user_id=?";
         $params = array(intval($id), $user_id);
@@ -317,7 +327,8 @@ class Database {
         return isset($entry[0]) ? $entry[0] : null;
     }
 
-    public function retrieveOneByURL($url, $user_id) {
+    public function retrieveOneByURL($url, $user_id)
+    {
         $entry  = NULL;
         $sql    = "SELECT * FROM entries WHERE url=? AND user_id=?";
         $params = array($url, $user_id);
@@ -327,13 +338,15 @@ class Database {
         return isset($entry[0]) ? $entry[0] : null;
     }
 
-    public function reassignTags($old_entry_id, $new_entry_id) {
+    public function reassignTags($old_entry_id, $new_entry_id)
+    {
         $sql    = "UPDATE tags_entries SET entry_id=? WHERE entry_id=?";
         $params = array($new_entry_id, $old_entry_id);
         $query  = $this->executeQuery($sql, $params);
     }
 
-    public function getEntriesByView($view, $user_id, $limit = '', $tag_id = 0) {
+    public function getEntriesByView($view, $user_id, $limit = '', $tag_id = 0)
+    {
         switch ($view) {
             case 'archive':
                 $sql    = "SELECT * FROM entries WHERE user_id=? AND is_read=? ";
@@ -361,9 +374,10 @@ class Database {
                 $entries = $query->fetchAll();
 
                 return $entries;
-        }
+    }
 
-    public function getEntriesByViewCount($view, $user_id, $tag_id = 0) {
+    public function getEntriesByViewCount($view, $user_id, $tag_id = 0)
+    {
         switch ($view) {
             case 'archive':
                     $sql    = "SELECT count(*) FROM entries WHERE user_id=? AND is_read=? ";
@@ -391,7 +405,8 @@ class Database {
         return $count;
     }
 
-    public function updateContent($id, $content, $user_id) {
+    public function updateContent($id, $content, $user_id)
+    {
         $sql_action = 'UPDATE entries SET content = ? WHERE id=? AND user_id=?';
         $params_action = array($content, $id, $user_id);
         $query = $this->executeQuery($sql_action, $params_action);
@@ -406,9 +421,11 @@ class Database {
      * @param integer $user_id
      * @return integer $id of inserted record
      */
-    public function add($url, $title, $content, $user_id, $isFavorite=0, $isRead=0) {
+    public function add($url, $title, $content, $user_id, $isFavorite=0, $isRead=0)
+    {
         $sql_action = 'INSERT INTO entries ( url, title, content, user_id, is_fav, is_read ) VALUES (?, ?, ?, ?, ?, ?)';
         $params_action = array($url, $title, $content, $user_id, $isFavorite, $isRead);
+
         if ( !$this->executeQuery($sql_action, $params_action) ) {
           $id = null;
         }
@@ -418,36 +435,42 @@ class Database {
         return $id;
     }
 
-    public function deleteById($id, $user_id) {
+    public function deleteById($id, $user_id)
+    {
         $sql_action     = "DELETE FROM entries WHERE id=? AND user_id=?";
         $params_action  = array($id, $user_id);
         $query          = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
 
-    public function favoriteById($id, $user_id) {
+    public function favoriteById($id, $user_id)
+    {
         $sql_action     = "UPDATE entries SET is_fav=NOT is_fav WHERE id=? AND user_id=?";
         $params_action  = array($id, $user_id);
         $query          = $this->executeQuery($sql_action, $params_action);
     }
 
-    public function archiveById($id, $user_id) {
+    public function archiveById($id, $user_id)
+    {
         $sql_action     = "UPDATE entries SET is_read=NOT is_read WHERE id=? AND user_id=?";
         $params_action  = array($id, $user_id);
         $query          = $this->executeQuery($sql_action, $params_action);
     }
 
-    public function archiveAll($user_id) {
+    public function archiveAll($user_id)
+    {
         $sql_action     = "UPDATE entries SET is_read=? WHERE user_id=? AND is_read=?";
         $params_action  = array($user_id, 1, 0);
         $query          = $this->executeQuery($sql_action, $params_action);
     }
 
-    public function getLastId($column = '') {
+    public function getLastId($column = '')
+    {
         return $this->getHandle()->lastInsertId($column);
     }
 
-    public function search($term, $user_id, $limit = '') {
+    public function search($term, $user_id, $limit = '')
+    {
         $search = '%'.$term.'%';
         $sql_action = "SELECT * FROM entries WHERE user_id=? AND (content LIKE ? OR title LIKE ? OR url LIKE ?) "; //searches in content, title and URL
         $sql_action .= $this->getEntriesOrder().' ' . $limit;
@@ -456,7 +479,8 @@ class Database {
         return $query->fetchAll();
        }
 
-    public function retrieveAllTags($user_id, $term = null) {
+    public function retrieveAllTags($user_id, $term = NULL)
+    {
         $sql = "SELECT DISTINCT tags.*, count(entries.id) AS entriescount FROM tags
           LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
           LEFT JOIN entries ON tags_entries.entry_id=entries.id
@@ -470,7 +494,8 @@ class Database {
         return $tags;
     }
 
-    public function retrieveTag($id, $user_id) {
+    public function retrieveTag($id, $user_id)
+    {
         $tag  = NULL;
         $sql    = "SELECT DISTINCT tags.* FROM tags
           LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
@@ -480,21 +505,23 @@ class Database {
         $query  = $this->executeQuery($sql, $params);
         $tag  = $query->fetchAll();
 
-        return isset($tag[0]) ? $tag[0] : null;
+        return isset($tag[0]) ? $tag[0] : NULL;
     }
 
-    public function retrieveEntriesByTag($tag_id, $user_id) {
+    public function retrieveEntriesByTag($tag_id, $user_id)
+    {
         $sql =
             "SELECT entries.* FROM entries
             LEFT JOIN tags_entries ON tags_entries.entry_id=entries.id
-            WHERE tags_entries.tag_id = ? AND entries.user_id=?";
+            WHERE tags_entries.tag_id = ? AND entries.user_id=? ORDER by entries.id DESC";
         $query = $this->executeQuery($sql, array($tag_id, $user_id));
         $entries = $query->fetchAll();
 
         return $entries;
     }
 
-    public function retrieveTagsByEntry($entry_id) {
+    public function retrieveTagsByEntry($entry_id)
+    {
         $sql =
             "SELECT tags.* FROM tags
             LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id
@@ -505,32 +532,36 @@ class Database {
         return $tags;
     }
 
-    public function removeTagForEntry($entry_id, $tag_id) {
+    public function removeTagForEntry($entry_id, $tag_id)
+    {
         $sql_action     = "DELETE FROM tags_entries WHERE tag_id=? AND entry_id=?";
         $params_action  = array($tag_id, $entry_id);
         $query          = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
     
-    public function cleanUnusedTags() {
-        $sql_action = "SELECT tags.* FROM tags JOIN tags_entries ON tags_entries.tag_id=tags.id";
-        $query = $this->executeQuery($sql_action,array());
+    public function cleanUnusedTag($tag_id)
+    {
+        $sql_action = "SELECT tags.* FROM tags JOIN tags_entries ON tags_entries.tag_id=tags.id WHERE tags.id=?";
+        $query = $this->executeQuery($sql_action,array($tag_id));
         $tagstokeep = $query->fetchAll();
-        $sql_action = "SELECT tags.* FROM tags LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id";
-        $query = $this->executeQuery($sql_action,array());
+        $sql_action = "SELECT tags.* FROM tags LEFT JOIN tags_entries ON tags_entries.tag_id=tags.id WHERE tags.id=?";
+        $query = $this->executeQuery($sql_action,array($tag_id));
         $alltags = $query->fetchAll();
+        
         foreach ($alltags as $tag) {
             if ($tag && !in_array($tag,$tagstokeep)) {
-                //delete tag
                 $sql_action = "DELETE FROM tags WHERE id=?";
                 $params_action = array($tag[0]);
-                $query = $this->executeQuery($sql_action, $params_action);
-                return $query;
+                $this->executeQuery($sql_action, $params_action);
+                return true;
             }
         }
+        
     }
 
-    public function retrieveTagByValue($value) {
+    public function retrieveTagByValue($value)
+    {
         $tag  = NULL;
         $sql    = "SELECT * FROM tags WHERE value=?";
         $params = array($value);
@@ -540,27 +571,29 @@ class Database {
         return isset($tag[0]) ? $tag[0] : null;
     }
 
-    public function createTag($value) {
+    public function createTag($value)
+    {
         $sql_action = 'INSERT INTO tags ( value ) VALUES (?)';
         $params_action = array($value);
         $query = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
 
-    public function setTagToEntry($tag_id, $entry_id) {
+    public function setTagToEntry($tag_id, $entry_id)
+    {
         $sql_action = 'INSERT INTO tags_entries ( tag_id, entry_id ) VALUES (?, ?)';
         $params_action = array($tag_id, $entry_id);
         $query = $this->executeQuery($sql_action, $params_action);
         return $query;
     }
 
-        private function getEntriesOrder() {
-            if (isset($_SESSION['sort']) and array_key_exists($_SESSION['sort'], $this->order)) {
-                return $this->order[$_SESSION['sort']];
-            }
-            else {
-                return $this->order['default'];
-            }
+    private function getEntriesOrder()
+    {
+        if (isset($_SESSION['sort']) and array_key_exists($_SESSION['sort'], $this->order)) {
+            return $this->order[$_SESSION['sort']];
         }
-
+        else {
+            return $this->order['default'];
+        }
+    }
 }