X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=inc%2Fpoche%2FPoche.class.php;h=0766cd51e2d1bc26057e966b274422fe90e92c18;hb=33fe6a46a42ca1c13f2585b42d9da54aa2e45899;hp=b0efe69a673f9e8f4f241a7964a0bb5e78fbdb5e;hpb=964481d023676bee964141a1d14f638995ac8d30;p=github%2Fwallabag%2Fwallabag.git

diff --git a/inc/poche/Poche.class.php b/inc/poche/Poche.class.php
index b0efe69a..0766cd51 100644
--- a/inc/poche/Poche.class.php
+++ b/inc/poche/Poche.class.php
@@ -10,77 +10,216 @@
 
 class Poche
 {
+    public static $canRenderTemplates = true;
+    public static $configFileAvailable = true;
+
     public $user;
     public $store;
     public $tpl;
     public $messages;
     public $pagination;
-
-    function __construct()
+    
+    private $currentTheme = '';
+    private $currentLanguage = '';
+    private $notInstalledMessage = array();
+    
+    # @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'))
+    );
+
+    public function __construct()
     {
-        $this->initTpl();
-        if (!$this->checkBeforeInstall()) {
-            exit;
+        if ($this->configFileIsAvailable()) {
+            $this->init();
+        }
+        
+        if ($this->themeIsInstalled()) {
+            $this->initTpl();
+        }
+        
+        if ($this->systemIsInstalled()) {
+            $this->store = new Database();
+            $this->messages = new Messages();
+            # installation
+            if (! $this->store->isInstalled()) {
+                $this->install();
+            }
         }
-        $this->store = new Database();
-        $this->init();
-        $this->messages = new Messages();
+    }
+    
+    private function init() 
+    {
+        Tools::initPhp();
+        Session::$sessionName = 'poche'; 
+        Session::init();
 
-        # installation
-        if(!$this->store->isInstalled())
-        {
-            $this->install();
+        if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
+            $this->user = $_SESSION['poche_user'];
+        } else {
+            # fake user, just for install & login screens
+            $this->user = new User();
+            $this->user->setConfig($this->getDefaultConfig());
         }
+
+        # l10n
+        $language = $this->user->getConfigValue('language');
+        putenv('LC_ALL=' . $language);
+        setlocale(LC_ALL, $language);
+        bindtextdomain($language, LOCALE); 
+        textdomain($language); 
+
+        # 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;
+
+        # Set up language
+        $languageDirectory = $this->user->getConfigValue('language');
+        
+        if ($languageDirectory === false) {
+            $languageDirectory = DEFAULT_THEME;
+        }
+        
+        $this->currentLanguage = $languageDirectory;
     }
 
+    public function configFileIsAvailable() {
+        if (! self::$configFileAvailable) {
+            $this->notInstalledMessage[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
+
+            return false;
+        }
+
+        return true;
+    }
+    
+    public function themeIsInstalled() {
+        $passTheme = TRUE;
+        # 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://doc.inthepoche.com/doku.php?id=users:begin:install">the documentation.</a>';
+            $passTheme = FALSE;
+        }
+
+        if (! is_writable(CACHE)) {
+            $this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
+
+            self::$canRenderTemplates = false;
+
+            $passTheme = FALSE;
+        } 
+        
+        # Check if the selected theme and its requirements are present
+        if ($this->getTheme() != '' && ! 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;
+            
+            $passTheme = 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;
+                
+                $passTheme = FALSE;
+            }
+        }
+
+        if (!$passTheme) {
+            return FALSE;
+        }
+
+        
+        return true;
+    }
+    
     /**
      * all checks before installation.
+     * @todo move HTML to template
      * @return boolean 
      */
-    private function checkBeforeInstall()
+    public function systemIsInstalled()
     {
-        $msg = '';
-        $allIsGood = TRUE;
-
-        if (!is_writable(CACHE)) {
-            Tools::logm('you don\'t have write access on cache directory');
-            die('You don\'t have write access on cache directory.');
+        $msg = TRUE;
+        
+        $configSalt = defined('SALT') ? constant('SALT') : '';
+        
+        if (empty($configSalt)) {
+            $this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
+            $msg = FALSE;
         }
-        else if (file_exists('./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>';
-            $allIsGood = FALSE;
+        if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
+            Tools::logm('sqlite file doesn\'t exist');
+            $this->notInstalledMessage[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
+            $msg = FALSE;
         }
-        else if (file_exists('./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>';
-            $allIsGood = FALSE;
+        if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
+            $this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
+            $msg = FALSE;
         }
-        else if (STORAGE == 'sqlite' && !is_writable(STORAGE_SQLITE)) {
+        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>';
-            $allIsGood = FALSE;
+            $this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
+            $msg = FALSE;
         }
-        
-        if (!$allIsGood) {
-            echo $this->tpl->render('error.twig', array(
-                'msg' => $msg
-            ));
+
+        if (! $msg) {
+            return false;
         }
 
-        return $allIsGood;
+        return true;
+    }
+    
+    public function getNotInstalledMessage() {
+        return $this->notInstalledMessage;
     }
 
     private function initTpl()
     {
-        # template engine
-        $loader = new Twig_Loader_Filesystem(TPL);
+        $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);
@@ -88,38 +227,19 @@ class Poche
         # filter for reading time
         $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
         $this->tpl->addFilter($filter);
-    }
-
-    private function init() 
-    {
-        Tools::initPhp();
-        Session::init();
-
-        if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
-            $this->user = $_SESSION['poche_user'];
-        }
-        else {
-            # fake user, just for install & login screens
-            $this->user = new User();
-            $this->user->setConfig($this->getDefaultConfig());
-        }
-
-        # l10n
-        $language = $this->user->getConfigValue('language');
-        putenv('LC_ALL=' . $language);
-        setlocale(LC_ALL, $language);
-        bindtextdomain($language, LOCALE); 
-        textdomain($language); 
-
-        # Pagination
-        $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
+        
+        # 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']) 
@@ -139,13 +259,69 @@ class Poche
         }
         exit();
     }
+    
+    public function getTheme() {
+        return $this->currentTheme;
+    }
+
+    public function getLanguage() {
+        return $this->currentLanguage;
+    }
+    
+    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);
+        }
+        
+        sort($themes);
+        return $themes;
+    }
+
+    public function getInstalledLanguages() {
+        $handle = opendir(LOCALE);
+        $languages = array();
+        
+        while (($language = readdir($handle)) !== false) {
+            # Languages are stored in a directory, so all directory names are languages
+            # @todo move language installation data to database
+            if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.'))) {
+                continue;
+            }
+            
+            $current = false;
+            
+            if ($language === $this->getLanguage()) {
+                $current = true;
+            }
+            
+            $languages[] = array('name' => $language, 'current' => $current);
+        }
+        
+        return $languages;
+    }
 
     public function getDefaultConfig()
-    {
+    {   
         return array(
             'pager' => PAGINATION,
             'language' => LANG,
-            );
+            'theme' => DEFAULT_THEME
+        );
     }
 
     /**
@@ -182,7 +358,7 @@ class Poche
                 }
 
                 if (!$import) {
-                    Tools::redirect();
+                    Tools::redirect('?view=home');
                 }
                 break;
             case 'delete':
@@ -198,7 +374,7 @@ class Poche
                     $msg = 'error : can\'t delete link #' . $id;
                 }
                 Tools::logm($msg);
-                Tools::redirect('?');
+                Tools::redirect();
                 break;
             case 'toggle_fav' :
                 $this->store->favoriteById($id, $this->user->getId());
@@ -228,13 +404,19 @@ class Poche
             case 'config':
                 $dev = $this->getPocheVersion('dev');
                 $prod = $this->getPocheVersion('prod');
-                $compare_dev = version_compare(POCHE_VERSION, $dev);
-                $compare_prod = version_compare(POCHE_VERSION, $prod);
+                $compare_dev = version_compare(POCHE, $dev);
+                $compare_prod = version_compare(POCHE, $prod);
+                $themes = $this->getInstalledThemes();
+                $languages = $this->getInstalledLanguages();
+                $http_auth = (isset($_SERVER['PHP_AUTH_USER']))?true:false;
                 $tpl_vars = array(
+                    'themes' => $themes,
+                    'languages' => $languages,
                     'dev' => $dev,
                     'prod' => $prod,
                     'compare_dev' => $compare_dev,
                     'compare_prod' => $compare_prod,
+                    'http_auth' => $http_auth,
                 );
                 Tools::logm('config view');
                 break;
@@ -247,34 +429,37 @@ class Poche
                         $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
                         $tidy->cleanRepair();
                         $content = $tidy->value;
+                    }
 
-                        // flattr checking
-                        $flattr = new FlattrItem();
-                        $flattr->checkitem($entry['url']);
+                    # flattr checking
+                    $flattr = new FlattrItem();
+                    $flattr->checkItem($entry['url'],$entry['id']);
 
-                        $tpl_vars = array(
-                        'entry' => $entry,
-                        'content' => $content,
-                        'flattr' => $flattr
-                        );
-                    }
+                    $tpl_vars = array(
+                    'entry' => $entry,
+                    'content' => $content,
+                    'flattr' => $flattr
+                    );
                 }
                 else {
                     Tools::logm('error in view call : entry is null');
                 }
                 break;
-            default : // home, favorites and archive views
+            default: # home, favorites and archive views 
                 $entries = $this->store->getEntriesByView($view, $this->user->getId());
                 $tpl_vars = array(
                     '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;
@@ -313,6 +498,97 @@ 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');
+    }
+
+    public function updateLanguage()
+    {
+        # no data
+        if (empty($_POST['language'])) {
+        }
+        
+        # we are not going to change it to the current language...
+        if ($_POST['language'] == $this->getLanguage()) {
+            $this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
+            Tools::redirect('?view=config');
+        }
+        
+        $languages = $this->getInstalledLanguages();
+        $actualLanguage = false;
+        
+        foreach ($languages as $language) {
+            if ($language['name'] == $_POST['language']) {
+                $actualLanguage = true;
+                break;
+            }
+        }
+        
+        if (! $actualLanguage) {
+            $this->messages->add('e', _('that language does not seem to be installed'));
+            Tools::redirect('?view=config');
+        }
+        
+        $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
+        $this->messages->add('s', _('you have changed your language preferences'));
+        
+        $currentConfig = $_SESSION['poche_user']->config;
+        $currentConfig['language'] = $_POST['language'];
+        
+        $_SESSION['poche_user']->setConfig($currentConfig);
+        
+        Tools::redirect('?view=config');
+    }
+
+    /**
+     * get credentials from differents sources
+     * it redirects the user to the $referer link
+     * @return array
+     */
+     private function credentials() {
+         if(isset($_SERVER['PHP_AUTH_USER'])) {
+             return array($_SERVER['PHP_AUTH_USER'],'php_auth');
+         }
+         if(!empty($_POST['login']) && !empty($_POST['password'])) {
+             return array($_POST['login'],$_POST['password']);
+         }
+         return array(false,false);
+     }
 
     /**
      * checks if login & password are correct and save the user in session.
@@ -323,31 +599,24 @@ class Poche
      */
     public function login($referer)
     {
-        if (!empty($_POST['login']) && !empty($_POST['password'])) {
-            $user = $this->store->login($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']));
+        list($login,$password)=$this->credentials();
+        if($login === false || $password === false) {
+            $this->messages->add('e', _('login failed: you have to fill all fields'));
+            Tools::logm('login failed');
+            Tools::redirect();
+        }
+        if (!empty($login) && !empty($password)) {
+            $user = $this->store->login($login, Tools::encodeString($password . $login));
             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)));
-
+                Session::login($user['username'], $user['password'], $login, Tools::encodeString($password . $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);
             }
             $this->messages->add('e', _('login failed: bad login or password'));
             Tools::logm('login failed');
             Tools::redirect();
-        } else {
-            $this->messages->add('e', _('login failed: you have to fill all fields'));
-            Tools::logm('login failed');
-            Tools::redirect();
         }
     }
 
@@ -565,52 +834,3 @@ class Poche
         return $version;
     }
 }
-
-/* class for Flattr querying. Should be put in a separate file
-*   Or maybe just create an array instead of a complete class... My mistake. :-°
-*/
-class FlattrItem{
-    public $status;
-    public $urltoflattr;
-    public $flattrItemURL;
-    public $numflattrs;
-
-    public function checkitem($urltoflattr){
-        $this->cacheflattrfile($urltoflattr);
-        $flattrResponse = file_get_contents("cache/flattr/".base64_encode($urltoflattr).".cache");
-        if($flattrResponse != FALSE){
-            $result = json_decode($flattrResponse);
-            if (isset($result->message)){
-                if ($result->message == "flattrable"){
-                $this->status = "flattrable";
-                        }
-                    } 
-            elseif ($result->link) {
-                            $this->status = "flattred";
-                            $this->flattrItemURL = $result->link;
-                            $this->numflattrs = $result->flattrs;
-                        }
-            else{
-                $this->status = "not flattrable";
-            }
-        }
-        else
-        {
-            $this->status = "FLATTR_ERR_CONNECTION";
-        }
-    }
-
-    private function cacheflattrfile($urltoflattr){
-        if (!is_dir('cache/flattr')){
-            mkdir('./cache/flattr', 0777);
-        }
-        // if a cache flattr file for this url already exists and it's been less than one day than it have been updated, see in /cache
-        if ((!file_exists("cache/flattr/".base64_encode($urltoflattr).".cache")) || (time() - filemtime("cache/flattr/".base64_encode($urltoflattr).".cache") > 86400))
-        {
-            $askForFlattr = Tools::getFile("https://api.flattr.com/rest/v2/things/lookup/?url=".$urltoflattr);
-             $flattrCacheFile = fopen("cache/flattr/".base64_encode($urltoflattr).".cache", 'w+');
-             fwrite($flattrCacheFile, $askForFlattr);
-             fclose($flattrCacheFile);
-        }
-    }
-}