]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - inc/poche/Poche.class.php
fix bug #225: blank page on article page
[github/wallabag/wallabag.git] / inc / poche / Poche.class.php
index 56910bc03deb94f238a2f8f2a3fb3dfeb861dc97..561de808d562b4938f9516770984203410adfbc7 100644 (file)
 
 class Poche
 {
+    public static $canRenderTemplates = true;
+    public static $configFileAvailable = true;
+
     public $user;
     public $store;
     public $tpl;
     public $messages;
     public $pagination;
+    
+    private $currentTheme = '';
+    private $notInstalledMessage = '';
+    
+    # @todo make this dynamic (actually install themes and save them in the database including author information et cetera)
+    private $installedThemes = array(
+        'default' => array('requires' => array()),
+        'dark' => array('requires' => array('default')),
+        'dmagenta' => array('requires' => array('default')),
+        'solarized' => array('requires' => array('default')),
+        'solarized-dark' => array('requires' => array('default'))
+    );
 
-    function __construct()
+    public function __construct()
     {
-        $this->store = new Database();
+        if (! $this->configFileIsAvailable()) {
+            return;
+        }
+        
         $this->init();
+        
+        if (! $this->themeIsInstalled()) {
+            return;
+        }
+        
+        $this->initTpl();
+        
+        if (! $this->systemIsInstalled()) {
+            return;
+        }
+           
+        $this->store = new Database();
         $this->messages = new Messages();
 
         # installation
-        if(!$this->store->isInstalled())
-        {
+        if (! $this->store->isInstalled()) {
             $this->install();
         }
     }
-
+    
     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::$sessionName = 'poche'; 
         Session::init();
 
         if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
             $this->user = $_SESSION['poche_user'];
-        }
-        else {
+        } else {
             # fake user, just for install & login screens
             $this->user = new User();
             $this->user->setConfig($this->getDefaultConfig());
@@ -55,38 +79,162 @@ class Poche
         bindtextdomain($language, LOCALE); 
         textdomain($language); 
 
-        # template engine
-        $loader = new Twig_Loader_Filesystem(TPL);
+        # Pagination
+        $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
+        
+        # Set up theme
+        $themeDirectory = $this->user->getConfigValue('theme');
+        
+        if ($themeDirectory === false) {
+            $themeDirectory = DEFAULT_THEME;
+        }
+        
+        $this->currentTheme = $themeDirectory;
+    }
+
+    public function configFileIsAvailable() {
+        if (! self::$configFileAvailable) {
+            $this->notInstalledMessage = 'You have to rename <strong>inc/poche/config.inc.php.new</strong> to <strong>inc/poche/config.inc.php</strong>.';
+
+            return false;
+        }
+
+        return true;
+    }
+    
+    public function themeIsInstalled() {
+        # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
+        if (! self::$canRenderTemplates) {
+            $this->notInstalledMessage = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. Have a look at <a href="http://inthepoche.com/?pages/Documentation">the documentation.</a>';
+            
+            return false;
+        }
+        
+        # Check if the selected theme and its requirements are present
+        if (! is_dir(THEME . '/' . $this->getTheme())) {
+            $this->notInstalledMessage = 'The currently selected theme (' . $this->getTheme() . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $this->getTheme() . ')';
+            
+            self::$canRenderTemplates = false;
+            
+            return false;
+        }
+        
+        foreach ($this->installedThemes[$this->getTheme()]['requires'] as $requiredTheme) {
+            if (! is_dir(THEME . '/' . $requiredTheme)) {
+                $this->notInstalledMessage = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $this->getTheme() . ')';
+                
+                self::$canRenderTemplates = false;
+                
+                return false;
+            }
+        }
+        
+        return true;
+    }
+    
+    /**
+     * all checks before installation.
+     * @todo move HTML to template
+     * @return boolean 
+     */
+    public function systemIsInstalled()
+    {
+        $msg = '';
+        
+        $configSalt = defined('SALT') ? constant('SALT') : '';
+        
+        if (empty($configSalt)) {
+            $msg = '<h1>error</h1><p>You have not yet filled in the SALT value in the config.inc.php file.</p>';
+        } else if (! is_writable(CACHE)) {
+            Tools::logm('you don\'t have write access on cache directory');
+            $msg = '<h1>error</h1><p>You don\'t have write access on cache directory.</p>';
+        } else if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
+            Tools::logm('sqlite file doesn\'t exist');
+            $msg = '<h1>error</h1><p>sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.</p>';
+        } else if (file_exists(ROOT . '/install/update.php') && ! DEBUG_POCHE) {
+            $msg = '<h1>setup</h1><p><strong>It\'s your first time here?</strong> Please copy /install/poche.sqlite in db folder. Then, delete install folder.<br /><strong>If you have already installed poche</strong>, an update is needed <a href="install/update.php">by clicking here</a>.</p>';
+        } else if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
+            $msg = '<h1>setup</h1><p><strong>If you want to update your poche</strong>, you just have to delete /install folder. <br /><strong>To install your poche with sqlite</strong>, copy /install/poche.sqlite in /db and delete the folder /install. you have to delete the /install folder before using poche.</p>';
+        } else if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
+            Tools::logm('you don\'t have write access on sqlite file');
+            $msg = '<h1>error</h1><p>You don\'t have write access on sqlite file.</p>';
+        }
+
+        if (! empty($msg)) {
+            $this->notInstalledMessage = $msg;
+
+            return false;
+        }
+
+        return true;
+    }
+    
+    public function getNotInstalledMessage() {
+        return $this->notInstalledMessage;
+    }
+
+    private function initTpl()
+    {
+        $loaderChain = new Twig_Loader_Chain();
+       
+        # add the current theme as first to the loader chain so Twig will look there first for overridden template files
+        try {
+            $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $this->getTheme()));
+        } catch (Twig_Error_Loader $e) {
+            # @todo isInstalled() should catch this, inject Twig later
+            die('The currently selected theme (' . $this->getTheme() . ') does not seem to be properly installed (' . THEME . '/' . $this->getTheme() .' is missing)');
+        }
+        
+        # add all required themes to the loader chain
+        foreach ($this->installedThemes[$this->getTheme()]['requires'] as $requiredTheme) {
+            try {
+                $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . DEFAULT_THEME));
+            } catch (Twig_Error_Loader $e) {
+                # @todo isInstalled() should catch this, inject Twig later
+                die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $this->getTheme() . ')');
+            }
+        }
+        
         if (DEBUG_POCHE) {
             $twig_params = array();
-        }
-        else {
+        } else {
             $twig_params = array('cache' => CACHE);
         }
-        $this->tpl = new Twig_Environment($loader, $twig_params);
+        
+        $this->tpl = new Twig_Environment($loaderChain, $twig_params);
         $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
+        
         # filter to display domain name of an url
         $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
         $this->tpl->addFilter($filter);
 
-        # Pagination
-        $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
+        # filter for reading time
+        $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
+        $this->tpl->addFilter($filter);
+        
+        # filter for simple filenames in config view
+        $filter = new Twig_SimpleFilter('getPrettyFilename', function($string) { return str_replace(ROOT, '', $string); });
+        $this->tpl->addFilter($filter);
     }
 
     private function install() 
     {
         Tools::logm('poche still not installed');
         echo $this->tpl->render('install.twig', array(
-            'token' => Session::getToken()
+            'token' => Session::getToken(),
+            'theme' => $this->getTheme(),
+            'poche_url' => Tools::getPocheUrl()
         ));
         if (isset($_GET['install'])) {
             if (($_POST['password'] == $_POST['password_repeat']) 
                 && $_POST['password'] != "" && $_POST['login'] != "") {
                 # let's rock, install poche baby !
-                $this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']));
-                Session::logout();
-                Tools::logm('poche is now installed');
-                Tools::redirect();
+                if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
+                {
+                    Session::logout();
+                    Tools::logm('poche is now installed');
+                    Tools::redirect();
+                }
             }
             else {
                 Tools::logm('error during installation');
@@ -95,13 +243,41 @@ class Poche
         }
         exit();
     }
+    
+    public function getTheme() {
+        return $this->currentTheme;
+    }
+    
+    public function getInstalledThemes() {
+        $handle = opendir(THEME);
+        $themes = array();
+        
+        while (($theme = readdir($handle)) !== false) {
+            # Themes are stored in a directory, so all directory names are themes
+            # @todo move theme installation data to database
+            if (! is_dir(THEME . '/' . $theme) || in_array($theme, array('..', '.'))) {
+                continue;
+            }
+            
+            $current = false;
+            
+            if ($theme === $this->getTheme()) {
+                $current = true;
+            }
+            
+            $themes[] = array('name' => $theme, 'current' => $current);
+        }
+        
+        return $themes;
+    }
 
     public function getDefaultConfig()
-    {
+    {   
         return array(
             'pager' => PAGINATION,
             'language' => LANG,
-            );
+            'theme' => DEFAULT_THEME
+        );
     }
 
     /**
@@ -112,36 +288,33 @@ class Poche
         switch ($action)
         {
             case 'add':
-                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());
-                        $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);
-                        }
-                        if (!$import) {
-                            $this->messages->add('s', _('the link has been added successfully'));
-                        }
+                $content = $url->extract();
+
+                if ($this->store->add($url->getUrl(), $content['title'], $content['body'], $this->user->getId())) {
+                    Tools::logm('add link ' . $url->getUrl());
+                    $sequence = '';
+                    if (STORAGE == 'postgres') {
+                        $sequence = 'entries_id_seq';
                     }
-                    else {
-                        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());
-                        }
+                    $last_id = $this->store->getLastId($sequence);
+                    if (DOWNLOAD_PICTURES) {
+                        $content = filtre_picture($content['body'], $url->getUrl(), $last_id);
+                        Tools::logm('updating content article');
+                        $this->store->updateContent($last_id, $content, $this->user->getId());
+                    }
+                    if (!$import) {
+                        $this->messages->add('s', _('the link has been added successfully'));
                     }
                 }
                 else {
                     if (!$import) {
-                        $this->messages->add('e', _('error during fetching content : the link wasn\'t added'));
-                        Tools::logm('error during content fetch ' . $url->getUrl());
+                        $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
+                        Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
                     }
                 }
+
                 if (!$import) {
-                    Tools::redirect();
+                    Tools::redirect('?view=home');
                 }
                 break;
             case 'delete':
@@ -189,7 +362,9 @@ class Poche
                 $prod = $this->getPocheVersion('prod');
                 $compare_dev = version_compare(POCHE_VERSION, $dev);
                 $compare_prod = version_compare(POCHE_VERSION, $prod);
+                $themes = $this->getInstalledThemes();
                 $tpl_vars = array(
+                    'themes' => $themes,
                     'dev' => $dev,
                     'prod' => $prod,
                     'compare_dev' => $compare_dev,
@@ -207,24 +382,36 @@ class Poche
                         $tidy->cleanRepair();
                         $content = $tidy->value;
                     }
+
+                    # flattr checking
+                    $flattr = new FlattrItem();
+                    $flattr->checkItem($entry['url']);
+
                     $tpl_vars = array(
-                        'entry' => $entry,
-                        'content' => $content,
+                    'entry' => $entry,
+                    'content' => $content,
+                    'flattr' => $flattr
                     );
                 }
                 else {
-                    Tools::logm('error in view call : entry is NULL');
+                    Tools::logm('error in view call : entry is null');
                 }
                 break;
-            default: # home view
+            default: # home, favorites and archive views 
                 $entries = $this->store->getEntriesByView($view, $this->user->getId());
-                $this->pagination->set_total(count($entries));
-                $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
-                $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
                 $tpl_vars = array(
-                    'entries' => $datas,
-                    'page_links' => $page_links,
+                    'entries' => '',
+                    'page_links' => '',
+                    'nb_results' => '',
                 );
+                if (count($entries) > 0) {
+                    $this->pagination->set_total(count($entries));
+                    $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
+                    $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
+                    $tpl_vars['entries'] = $datas;
+                    $tpl_vars['page_links'] = $page_links;
+                    $tpl_vars['nb_results'] = count($entries);
+                }
                 Tools::logm('display ' . $view . ' view');
                 break;
         }
@@ -262,6 +449,44 @@ class Poche
             }
         }
     }
+    
+    public function updateTheme()
+    {
+        # no data
+        if (empty($_POST['theme'])) {
+        }
+        
+        # we are not going to change it to the current theme...
+        if ($_POST['theme'] == $this->getTheme()) {
+            $this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
+            Tools::redirect('?view=config');
+        }
+        
+        $themes = $this->getInstalledThemes();
+        $actualTheme = false;
+        
+        foreach ($themes as $theme) {
+            if ($theme['name'] == $_POST['theme']) {
+                $actualTheme = true;
+                break;
+            }
+        }
+        
+        if (! $actualTheme) {
+            $this->messages->add('e', _('that theme does not seem to be installed'));
+            Tools::redirect('?view=config');
+        }
+        
+        $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
+        $this->messages->add('s', _('you have changed your theme preferences'));
+        
+        $currentConfig = $_SESSION['poche_user']->config;
+        $currentConfig['theme'] = $_POST['theme'];
+        
+        $_SESSION['poche_user']->setConfig($currentConfig);
+        
+        Tools::redirect('?view=config');
+    }
 
     /**
      * checks if login & password are correct and save the user in session.
@@ -277,16 +502,7 @@ class Poche
             if ($user != array()) {
                 # Save login into Session
                 Session::login($user['username'], $user['password'], $_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']), array('poche_user' => new User($user)));
-
                 $this->messages->add('s', _('welcome to your poche'));
-                if (!empty($_POST['longlastingsession'])) {
-                    $_SESSION['longlastingsession'] = 31536000;
-                    $_SESSION['expires_on'] = time() + $_SESSION['longlastingsession'];
-                    session_set_cookie_params($_SESSION['longlastingsession']);
-                } else {
-                    session_set_cookie_params(0);
-                }
-                session_regenerate_id(true);
                 Tools::logm('login successful');
                 Tools::redirect($referer);
             }
@@ -317,13 +533,14 @@ class Poche
     /**
      * import from Instapaper. poche needs a ./instapaper-export.html file
      * @todo add the return value
+     * @param string $targetFile the file used for importing
      * @return boolean
      */
-    private function importFromInstapaper()
+    private function importFromInstapaper($targetFile)
     {
         # TODO gestion des articles favs
         $html = new simple_html_dom();
-        $html->load_file('./instapaper-export.html');
+        $html->load_file($targetFile);
         Tools::logm('starting import from instapaper');
 
         $read = 0;
@@ -356,13 +573,14 @@ class Poche
     /**
      * import from Pocket. poche needs a ./ril_export.html file
      * @todo add the return value
+     * @param string $targetFile the file used for importing
      * @return boolean 
      */
-    private function importFromPocket()
+    private function importFromPocket($targetFile)
     {
         # TODO gestion des articles favs
         $html = new simple_html_dom();
-        $html->load_file('./ril_export.html');
+        $html->load_file($targetFile);
         Tools::logm('starting import from pocket');
 
         $read = 0;
@@ -395,17 +613,20 @@ class Poche
     /**
      * import from Readability. poche needs a ./readability file
      * @todo add the return value
+     * @param string $targetFile the file used for importing
      * @return boolean 
      */
-    private function importFromReadability()
+    private function importFromReadability($targetFile)
     {
         # TODO gestion des articles lus / favs
-        $str_data = file_get_contents("./readability");
+        $str_data = file_get_contents($targetFile);
         $data = json_decode($str_data,true);
         Tools::logm('starting import from Readability');
-
+        $count = 0;
         foreach ($data as $key => $value) {
-            $url = '';
+            $url = NULL;
+            $favorite = FALSE;
+            $archive = FALSE;
             foreach ($value as $attr => $attr_value) {
                 if ($attr == 'article__url') {
                     $url = new Url(base64_encode($attr_value));
@@ -414,20 +635,30 @@ class Poche
                 if (STORAGE == 'postgres') {
                     $sequence = 'entries_id_seq';
                 }
-                // if ($attr_value == 'favorite' && $attr_value == 'true') {
-                //     $last_id = $this->store->getLastId($sequence);
-                //     $this->store->favoriteById($last_id);
-                //     $this->action('toogle_fav', $url, $last_id, TRUE);
-                // }
-                if ($attr_value == 'archive' && $attr_value == 'true') {
+                if ($attr_value == 'true') {
+                    if ($attr == 'favorite') {
+                        $favorite = TRUE;
+                    }
+                    if ($attr == 'archive') {
+                        $archive = TRUE;
+                    }
+                }
+            }
+            # we can add the url
+            if (!is_null($url) && $url->isCorrect()) {
+                $this->action('add', $url, 0, TRUE);
+                $count++;
+                if ($favorite) {
+                    $last_id = $this->store->getLastId($sequence);
+                    $this->action('toggle_fav', $url, $last_id, TRUE);
+                }
+                if ($archive) {
                     $last_id = $this->store->getLastId($sequence);
                     $this->action('toggle_archive', $url, $last_id, TRUE);
                 }
             }
-            if ($url->isCorrect())
-                $this->action('add', $url, 0, TRUE);
         }
-        $this->messages->add('s', _('import from Readability completed'));
+        $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.'));
         Tools::logm('import from Readability completed');
         Tools::redirect();
     }
@@ -440,15 +671,31 @@ class Poche
      */
     public function import($from)
     {
-        if ($from == 'pocket') {
-            return $this->importFromPocket();
+        $providers = array(
+            'pocket' => 'importFromPocket',
+            'readability' => 'importFromReadability',
+            'instapaper' => 'importFromInstapaper'
+        );
+        
+        if (! isset($providers[$from])) {
+            $this->messages->add('e', _('Unknown import provider.'));
+            Tools::redirect();
         }
-        else if ($from == 'readability') {
-            return $this->importFromReadability();
+        
+        $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
+        $targetFile = constant($targetDefinition);
+        
+        if (! defined($targetDefinition)) {
+            $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
+            Tools::redirect();
         }
-        else if ($from == 'instapaper') {
-            return $this->importFromInstapaper();
+        
+        if (! file_exists($targetFile)) {
+            $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
+            Tools::redirect();
         }
+        
+        $this->$providers[$from]($targetFile);
     }
 
     /**