]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - inc/poche/Poche.class.php
travis
[github/wallabag/wallabag.git] / inc / poche / Poche.class.php
index 0a43df71ff3e7986da61143e6a93c3940744730e..56910bc03deb94f238a2f8f2a3fb3dfeb861dc97 100644 (file)
@@ -31,10 +31,15 @@ class Poche
 
     private function init() 
     {
+        if (file_exists('./install') && !DEBUG_POCHE) {
+            Tools::logm('folder /install exists');
+            die('the folder /install exists, you have to delete it before using poche.');
+        }
+
         Tools::initPhp();
         Session::init();
 
-        if (isset($_SESSION['poche_user'])) {
+        if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
             $this->user = $_SESSION['poche_user'];
         }
         else {
@@ -102,7 +107,7 @@ class Poche
     /**
      * Call action (mark as fav, archive, delete, etc.)
      */
-    public function action($action, Url $url, $id = 0)
+    public function action($action, Url $url, $id = 0, $import = FALSE)
     {
         switch ($action)
         {
@@ -110,22 +115,34 @@ class Poche
                 if($parametres_url = $url->fetchContent()) {
                     if ($this->store->add($url->getUrl(), $parametres_url['title'], $parametres_url['content'], $this->user->getId())) {
                         Tools::logm('add link ' . $url->getUrl());
-                        $last_id = $this->store->getLastId();
+                        $sequence = '';
+                        if (STORAGE == 'postgres') {
+                            $sequence = 'entries_id_seq';
+                        }
+                        $last_id = $this->store->getLastId($sequence);
                         if (DOWNLOAD_PICTURES) {
                             $content = filtre_picture($parametres_url['content'], $url->getUrl(), $last_id);
                         }
-                        $this->messages->add('s', _('the link has been added successfully'));
+                        if (!$import) {
+                            $this->messages->add('s', _('the link has been added successfully'));
+                        }
                     }
                     else {
-                        $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
-                        Tools::logm('error during insertion : the link wasn\'t added');
+                        if (!$import) {
+                            $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
+                            Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
+                        }
                     }
                 }
                 else {
-                    $this->messages->add('e', _('error during fetching content : the link wasn\'t added'));
-                    Tools::logm('error during content fetch');
+                    if (!$import) {
+                        $this->messages->add('e', _('error during fetching content : the link wasn\'t added'));
+                        Tools::logm('error during content fetch ' . $url->getUrl());
+                    }
+                }
+                if (!$import) {
+                    Tools::redirect();
                 }
-                Tools::redirect();
                 break;
             case 'delete':
                 $msg = 'delete link #' . $id;
@@ -145,12 +162,16 @@ class Poche
             case 'toggle_fav' :
                 $this->store->favoriteById($id, $this->user->getId());
                 Tools::logm('mark as favorite link #' . $id);
-                Tools::redirect();
+                if (!$import) {
+                    Tools::redirect();
+                }
                 break;
             case 'toggle_archive' :
                 $this->store->archiveById($id, $this->user->getId());
                 Tools::logm('archive link #' . $id);
-                Tools::redirect();
+                if (!$import) {
+                    Tools::redirect();
+                }
                 break;
             default:
                 break;
@@ -211,6 +232,13 @@ class Poche
         return $tpl_vars;
     }
 
+    /**
+     * update the password of the current user. 
+     * if MODE_DEMO is TRUE, the password can't be updated. 
+     * @todo add the return value
+     * @todo set the new password in function header like this updatePassword($newPassword)
+     * @return boolean
+     */
     public function updatePassword()
     {
         if (MODE_DEMO) {
@@ -235,6 +263,13 @@ class Poche
         }
     }
 
+    /**
+     * checks if login & password are correct and save the user in session.
+     * it redirects the user to the $referer link
+     * @param  string $referer the url to redirect after login
+     * @todo add the return value
+     * @return boolean
+     */
     public function login($referer)
     {
         if (!empty($_POST['login']) && !empty($_POST['password'])) {
@@ -265,20 +300,31 @@ class Poche
         }
     }
 
+    /**
+     * log out the poche user. It cleans the session.
+     * @todo add the return value
+     * @return boolean 
+     */
     public function logout()
     {
-        $this->messages->add('s', _('see you soon!'));
-        Tools::logm('logout');
         $this->user = array();
         Session::logout();
+        $this->messages->add('s', _('see you soon!'));
+        Tools::logm('logout');
         Tools::redirect();
     }
 
+    /**
+     * import from Instapaper. poche needs a ./instapaper-export.html file
+     * @todo add the return value
+     * @return boolean
+     */
     private function importFromInstapaper()
     {
         # TODO gestion des articles favs
         $html = new simple_html_dom();
         $html->load_file('./instapaper-export.html');
+        Tools::logm('starting import from instapaper');
 
         $read = 0;
         $errors = array();
@@ -288,10 +334,14 @@ class Poche
             {
                 $a = $li->find('a');
                 $url = new Url(base64_encode($a[0]->href));
-                $this->action('add', $url);
+                $this->action('add', $url, 0, TRUE);
                 if ($read == '1') {
-                    $last_id = $this->store->getLastId();
-                    $this->action('toggle_archive', $url, $last_id);
+                    $sequence = '';
+                    if (STORAGE == 'postgres') {
+                        $sequence = 'entries_id_seq';
+                    }
+                    $last_id = $this->store->getLastId($sequence);
+                    $this->action('toggle_archive', $url, $last_id, TRUE);
                 }
             }
 
@@ -303,11 +353,17 @@ class Poche
         Tools::redirect();
     }
 
+    /**
+     * import from Pocket. poche needs a ./ril_export.html file
+     * @todo add the return value
+     * @return boolean 
+     */
     private function importFromPocket()
     {
         # TODO gestion des articles favs
         $html = new simple_html_dom();
         $html->load_file('./ril_export.html');
+        Tools::logm('starting import from pocket');
 
         $read = 0;
         $errors = array();
@@ -317,10 +373,14 @@ class Poche
             {
                 $a = $li->find('a');
                 $url = new Url(base64_encode($a[0]->href));
-                $this->action('add', $url);
+                $this->action('add', $url, 0, TRUE);
                 if ($read == '1') {
-                    $last_id = $this->store->getLastId();
-                    $this->action('toggle_archive', $url, $last_id);
+                        $sequence = '';
+                        if (STORAGE == 'postgres') {
+                            $sequence = 'entries_id_seq';
+                        }
+                    $last_id = $this->store->getLastId($sequence);
+                    $this->action('toggle_archive', $url, $last_id, TRUE);
                 }
             }
             
@@ -332,11 +392,17 @@ class Poche
         Tools::redirect();
     }
 
+    /**
+     * import from Readability. poche needs a ./readability file
+     * @todo add the return value
+     * @return boolean 
+     */
     private function importFromReadability()
     {
         # TODO gestion des articles lus / favs
         $str_data = file_get_contents("./readability");
         $data = json_decode($str_data,true);
+        Tools::logm('starting import from Readability');
 
         foreach ($data as $key => $value) {
             $url = '';
@@ -344,37 +410,51 @@ class Poche
                 if ($attr == 'article__url') {
                     $url = new Url(base64_encode($attr_value));
                 }
+                $sequence = '';
+                if (STORAGE == 'postgres') {
+                    $sequence = 'entries_id_seq';
+                }
                 // if ($attr_value == 'favorite' && $attr_value == 'true') {
-                //     $last_id = $this->store->getLastId();
+                //     $last_id = $this->store->getLastId($sequence);
                 //     $this->store->favoriteById($last_id);
-                //     $this->action('toogle_fav', $url, $last_id);
-                // }
-                // if ($attr_value == 'archive' && $attr_value == 'true') {
-                //     $last_id = $this->store->getLastId();
-                //     $this->action('toggle_archive', $url, $last_id);
+                //     $this->action('toogle_fav', $url, $last_id, TRUE);
                 // }
+                if ($attr_value == 'archive' && $attr_value == 'true') {
+                    $last_id = $this->store->getLastId($sequence);
+                    $this->action('toggle_archive', $url, $last_id, TRUE);
+                }
             }
             if ($url->isCorrect())
-                $this->action('add', $url);
+                $this->action('add', $url, 0, TRUE);
         }
         $this->messages->add('s', _('import from Readability completed'));
         Tools::logm('import from Readability completed');
         Tools::redirect();
     }
 
+    /**
+     * import datas into your poche
+     * @param  string $from name of the service to import : pocket, instapaper or readability
+     * @todo add the return value
+     * @return boolean       
+     */
     public function import($from)
     {
         if ($from == 'pocket') {
-            $this->importFromPocket();
+            return $this->importFromPocket();
         }
         else if ($from == 'readability') {
-            $this->importFromReadability();
+            return $this->importFromReadability();
         }
         else if ($from == 'instapaper') {
-            $this->importFromInstapaper();
+            return $this->importFromInstapaper();
         }
     }
 
+    /**
+     * export poche entries in json
+     * @return json all poche entries
+     */
     public function export()
     {
         $entries = $this->store->retrieveAll($this->user->getId());
@@ -384,9 +464,16 @@ class Poche
         Tools::logm('export view');
     }
 
+    /**
+     * Checks online the latest version of poche and cache it
+     * @param  string $which 'prod' or 'dev'
+     * @return string        latest $which version
+     */
     private function getPocheVersion($which = 'prod')
     {
         $cache_file = CACHE . '/' . $which;
+
+        # checks if the cached version file exists
         if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
            $version = file_get_contents($cache_file);
         } else {