inc/poche/Poche.class.php

   1 <?php
   2 /**
   3  * wallabag, self hostable application allowing you to not miss any content anymore
   4  *
   5  * @category   wallabag
   6  * @author     Nicolas Lœuillet <nicolas@loeuillet.org>
   7  * @copyright  2013
   8  * @license    http://www.wtfpl.net/ see COPYING file
   9  */
  10
  11 class Poche
  12 {
  13     public static $canRenderTemplates = true;
  14     public static $configFileAvailable = true;
  15
  16     public $user;
  17     public $store;
  18     public $tpl;
  19     public $messages;
  20     public $pagination;
  21
  22     private $currentTheme = '';
  23     private $currentLanguage = '';
  24     private $notInstalledMessage = array();
  25
  26     private $language_names = array(
  27       'cs_CZ.utf8' => 'čeština',
  28       'de_DE.utf8' => 'German',
  29       'en_EN.utf8' => 'English',
  30       'es_ES.utf8' => 'Español',
  31       'fa_IR.utf8' => 'فارسی',
  32       'fr_FR.utf8' => 'Français',
  33       'it_IT.utf8' => 'Italiano',
  34       'pl_PL.utf8' => 'Polski',
  35       'pt_BR.utf8' => 'Português (Brasil)',
  36       'ru_RU.utf8' => 'Pусский',
  37       'sl_SI.utf8' => 'Slovenščina',
  38       'uk_UA.utf8' => 'Українська',
  39     );
  40     public function __construct()
  41     {
  42         if ($this->configFileIsAvailable()) {
  43             $this->init();
  44         }
  45
  46         if ($this->themeIsInstalled()) {
  47             $this->initTpl();
  48         }
  49
  50         if ($this->systemIsInstalled()) {
  51             $this->store = new Database();
  52             $this->messages = new Messages();
  53             # installation
  54             if (! $this->store->isInstalled()) {
  55                 $this->install();
  56             }
  57             $this->store->checkTags();
  58         }
  59     }
  60
  61     private function init()
  62     {
  63         Tools::initPhp();
  64
  65         if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
  66             $this->user = $_SESSION['poche_user'];
  67         } else {
  68             # fake user, just for install & login screens
  69             $this->user = new User();
  70             $this->user->setConfig($this->getDefaultConfig());
  71         }
  72
  73         # l10n
  74         $language = $this->user->getConfigValue('language');
  75         @putenv('LC_ALL=' . $language);
  76         setlocale(LC_ALL, $language);
  77         bindtextdomain($language, LOCALE);
  78         textdomain($language);
  79
  80         # Pagination
  81         $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
  82
  83         # Set up theme
  84         $themeDirectory = $this->user->getConfigValue('theme');
  85
  86         if ($themeDirectory === false) {
  87             $themeDirectory = DEFAULT_THEME;
  88         }
  89
  90         $this->currentTheme = $themeDirectory;
  91
  92         # Set up language
  93         $languageDirectory = $this->user->getConfigValue('language');
  94
  95         if ($languageDirectory === false) {
  96             $languageDirectory = DEFAULT_THEME;
  97         }
  98
  99         $this->currentLanguage = $languageDirectory;
 100     }
 101
 102     public function configFileIsAvailable() {
 103         if (! self::$configFileAvailable) {
 104             $this->notInstalledMessage[] = 'You have to copy (don\'t just rename!) inc/poche/config.inc.default.php to inc/poche/config.inc.php.';
 105
 106             return false;
 107         }
 108
 109         return true;
 110     }
 111
 112     public function themeIsInstalled() {
 113         $passTheme = TRUE;
 114         # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
 115         if (! self::$canRenderTemplates) {
 116             $this->notInstalledMessage[] = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. You can also download <a href="http://wllbg.org/vendor">vendor.zip</a> and extract it in your wallabag folder.';
 117             $passTheme = FALSE;
 118         }
 119
 120         if (! is_writable(CACHE)) {
 121             $this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
 122
 123             self::$canRenderTemplates = false;
 124
 125             $passTheme = FALSE;
 126         }
 127
 128         # Check if the selected theme and its requirements are present
 129         $theme = $this->getTheme();
 130
 131         if ($theme != '' && ! is_dir(THEME . '/' . $theme)) {
 132             $this->notInstalledMessage[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $theme . ')';
 133
 134             self::$canRenderTemplates = false;
 135
 136             $passTheme = FALSE;
 137         }
 138
 139         $themeInfo = $this->getThemeInfo($theme);
 140         if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
 141             foreach ($themeInfo['requirements'] as $requiredTheme) {
 142                 if (! is_dir(THEME . '/' . $requiredTheme)) {
 143                     $this->notInstalledMessage[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
 144
 145                     self::$canRenderTemplates = false;
 146
 147                     $passTheme = FALSE;
 148                 }
 149             }
 150         }
 151
 152         if (!$passTheme) {
 153             return FALSE;
 154         }
 155
 156
 157         return true;
 158     }
 159
 160     /**
 161      * all checks before installation.
 162      * @todo move HTML to template
 163      * @return boolean
 164      */
 165     public function systemIsInstalled()
 166     {
 167         $msg = TRUE;
 168
 169         $configSalt = defined('SALT') ? constant('SALT') : '';
 170
 171         if (empty($configSalt)) {
 172             $this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
 173             $msg = FALSE;
 174         }
 175         if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
 176             Tools::logm('sqlite file doesn\'t exist');
 177             $this->notInstalledMessage[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
 178             $msg = FALSE;
 179         }
 180         if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
 181             $this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
 182             $msg = FALSE;
 183         }
 184         if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
 185             Tools::logm('you don\'t have write access on sqlite file');
 186             $this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
 187             $msg = FALSE;
 188         }
 189
 190         if (! $msg) {
 191             return false;
 192         }
 193
 194         return true;
 195     }
 196
 197     public function getNotInstalledMessage() {
 198         return $this->notInstalledMessage;
 199     }
 200
 201     private function initTpl()
 202     {
 203         $loaderChain = new Twig_Loader_Chain();
 204         $theme = $this->getTheme();
 205
 206         # add the current theme as first to the loader chain so Twig will look there first for overridden template files
 207         try {
 208             $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $theme));
 209         } catch (Twig_Error_Loader $e) {
 210             # @todo isInstalled() should catch this, inject Twig later
 211             die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME . '/' . $theme .' is missing)');
 212         }
 213
 214         # add all required themes to the loader chain
 215         $themeInfo = $this->getThemeInfo($theme);
 216         if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
 217             foreach ($themeInfo['requirements'] as $requiredTheme) {
 218                 try {
 219                     $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $requiredTheme));
 220                 } catch (Twig_Error_Loader $e) {
 221                     # @todo isInstalled() should catch this, inject Twig later
 222                     die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
 223                 }
 224             }
 225         }
 226
 227         if (DEBUG_POCHE) {
 228             $twigParams = array();
 229         } else {
 230             $twigParams = array('cache' => CACHE);
 231         }
 232
 233         $this->tpl = new Twig_Environment($loaderChain, $twigParams);
 234         $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
 235
 236         # filter to display domain name of an url
 237         $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
 238         $this->tpl->addFilter($filter);
 239
 240         # filter for reading time
 241         $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
 242         $this->tpl->addFilter($filter);
 243     }
 244
 245     public function createNewUser() {
 246         if (isset($_GET['newuser'])){
 247             if ($_POST['newusername'] != "" && $_POST['password4newuser'] != ""){
 248                 $newusername = filter_var($_POST['newusername'], FILTER_SANITIZE_STRING);
 249                 if (!$this->store->userExists($newusername)){
 250                     if ($this->store->install($newusername, Tools::encodeString($_POST['password4newuser'] . $newusername))) {
 251                         Tools::logm('The new user '.$newusername.' has been installed');
 252                         $this->messages->add('s', sprintf(_('The new user %s has been installed. Do you want to <a href="?logout">logout ?</a>'),$newusername));
 253                         Tools::redirect();
 254                     }
 255                     else {
 256                         Tools::logm('error during adding new user');
 257                         Tools::redirect();
 258                     }
 259                 }
 260                 else {
 261                     $this->messages->add('e', sprintf(_('Error : An user with the name %s already exists !'),$newusername));
 262                     Tools::logm('An user with the name '.$newusername.' already exists !');
 263                     Tools::redirect();
 264                 }
 265             }
 266         }
 267     }
 268
 269     public function deleteUser(){
 270         if (isset($_GET['deluser'])){
 271             if ($this->store->listUsers() > 1) {
 272                 if (Tools::encodeString($_POST['password4deletinguser'].$this->user->getUsername()) == $this->store->getUserPassword($this->user->getId())) {
 273                     $username = $this->user->getUsername();
 274                     $this->store->deleteUserConfig($this->user->getId());
 275                     Tools::logm('The configuration for user '. $username .' has been deleted !');
 276                     $this->store->deleteTagsEntriesAndEntries($this->user->getId());
 277                     Tools::logm('The entries for user '. $username .' has been deleted !');
 278                     $this->store->deleteUser($this->user->getId());
 279                     Tools::logm('User '. $username .' has been completely deleted !');
 280                     Session::logout();
 281                     Tools::logm('logout');
 282                     Tools::redirect();
 283                     $this->messages->add('s', sprintf(_('User %s has been successfully deleted !'),$newusername));
 284                 }
 285                 else {
 286                     Tools::logm('Bad password !');
 287                     $this->messages->add('e', _('Error : The password is wrong !'));
 288                 }
 289             }
 290             else {
 291                 Tools::logm('Only user !');
 292                 $this->messages->add('e', _('Error : You are the only user, you cannot delete your account !'));
 293             }
 294         }
 295     }
 296
 297     private function install()
 298     {
 299         Tools::logm('poche still not installed');
 300         echo $this->tpl->render('install.twig', array(
 301             'token' => Session::getToken(),
 302             'theme' => $this->getTheme(),
 303             'poche_url' => Tools::getPocheUrl()
 304         ));
 305         if (isset($_GET['install'])) {
 306             if (($_POST['password'] == $_POST['password_repeat'])
 307                 && $_POST['password'] != "" && $_POST['login'] != "") {
 308                 # let's rock, install poche baby !
 309                 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
 310                 {
 311                     Session::logout();
 312                     Tools::logm('poche is now installed');
 313                     Tools::redirect();
 314                 }
 315             }
 316             else {
 317                 Tools::logm('error during installation');
 318                 Tools::redirect();
 319             }
 320         }
 321         exit();
 322     }
 323
 324     public function getTheme() {
 325         return $this->currentTheme;
 326     }
 327
 328     /**
 329      * Provides theme information by parsing theme.ini file if present in the theme's root directory.
 330      * In all cases, the following data will be returned:
 331      * - name: theme's name, or key if the theme is unnamed,
 332      * - current: boolean informing if the theme is the current user theme.
 333      *
 334      * @param string $theme Theme key (directory name)
 335      * @return array|boolean Theme information, or false if the theme doesn't exist.
 336      */
 337     public function getThemeInfo($theme) {
 338         if (!is_dir(THEME . '/' . $theme)) {
 339             return false;
 340         }
 341
 342         $themeIniFile = THEME . '/' . $theme . '/theme.ini';
 343         $themeInfo = array();
 344
 345         if (is_file($themeIniFile) && is_readable($themeIniFile)) {
 346             $themeInfo = parse_ini_file($themeIniFile);
 347         }
 348
 349         if ($themeInfo === false) {
 350             $themeInfo = array();
 351         }
 352         if (!isset($themeInfo['name'])) {
 353             $themeInfo['name'] = $theme;
 354         }
 355         $themeInfo['current'] = ($theme === $this->getTheme());
 356
 357         return $themeInfo;
 358     }
 359
 360     public function getInstalledThemes() {
 361         $handle = opendir(THEME);
 362         $themes = array();
 363
 364         while (($theme = readdir($handle)) !== false) {
 365             # Themes are stored in a directory, so all directory names are themes
 366             # @todo move theme installation data to database
 367             if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
 368                 continue;
 369             }
 370
 371             $themes[$theme] = $this->getThemeInfo($theme);
 372         }
 373
 374         ksort($themes);
 375
 376         return $themes;
 377     }
 378
 379     public function getLanguage() {
 380         return $this->currentLanguage;
 381     }
 382
 383     public function getInstalledLanguages() {
 384         $handle = opendir(LOCALE);
 385         $languages = array();
 386
 387         while (($language = readdir($handle)) !== false) {
 388             # Languages are stored in a directory, so all directory names are languages
 389             # @todo move language installation data to database
 390             if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.', 'tools'))) {
 391                 continue;
 392             }
 393
 394             $current = false;
 395
 396             if ($language === $this->getLanguage()) {
 397                 $current = true;
 398             }
 399
 400             $languages[] = array('name' => (isset($this->language_names[$language]) ? $this->language_names[$language] : $language), 'value' => $language, 'current' => $current);
 401         }
 402
 403         return $languages;
 404     }
 405
 406     public function getDefaultConfig()
 407     {
 408         return array(
 409             'pager' => PAGINATION,
 410             'language' => LANG,
 411             'theme' => DEFAULT_THEME
 412         );
 413     }
 414
 415     /**
 416      * Call action (mark as fav, archive, delete, etc.)
 417      */
 418     public function action($action, Url $url, $id = 0, $import = FALSE, $autoclose = FALSE, $tags = null)
 419     {
 420         switch ($action)
 421         {
 422             case 'add':
 423                 $content = Tools::getPageContent($url);
 424                 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
 425                 $body = $content['rss']['channel']['item']['description'];
 426
 427                 // clean content from prevent xss attack
 428                 $purifier = $this->getPurifier();
 429                 $title = $purifier->purify($title);
 430                 $body = $purifier->purify($body);
 431
 432                 //search for possible duplicate
 433                 $duplicate = NULL;
 434                 $duplicate = $this->store->retrieveOneByURL($url->getUrl(), $this->user->getId());
 435
 436                 $last_id = $this->store->add($url->getUrl(), $title, $body, $this->user->getId());
 437                 if ( $last_id ) {
 438                     Tools::logm('add link ' . $url->getUrl());
 439                     if (DOWNLOAD_PICTURES) {
 440                         $content = filtre_picture($body, $url->getUrl(), $last_id);
 441                         Tools::logm('updating content article');
 442                         $this->store->updateContent($last_id, $content, $this->user->getId());
 443                     }
 444
 445                     if ($duplicate != NULL) {
 446                         // duplicate exists, so, older entry needs to be deleted (as new entry should go to the top of list), BUT favorite mark and tags should be preserved
 447                         Tools::logm('link ' . $url->getUrl() . ' is a duplicate');
 448                         // 1) - preserve tags and favorite, then drop old entry
 449                         $this->store->reassignTags($duplicate['id'], $last_id);
 450                         if ($duplicate['is_fav']) {
 451                           $this->store->favoriteById($last_id, $this->user->getId());
 452                         }
 453                         if ($this->store->deleteById($duplicate['id'], $this->user->getId())) {
 454                           Tools::logm('previous link ' . $url->getUrl() .' entry deleted');
 455                         }
 456                     }
 457
 458                     $this->messages->add('s', _('the link has been added successfully'));
 459                 }
 460                 else {
 461                     $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
 462                     Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
 463                 }
 464
 465                 if ($autoclose == TRUE) {
 466                   Tools::redirect('?view=home');
 467                 } else {
 468                   Tools::redirect('?view=home&closewin=true');
 469                 }
 470                 break;
 471             case 'delete':
 472                 $msg = 'delete link #' . $id;
 473                 if ($this->store->deleteById($id, $this->user->getId())) {
 474                     if (DOWNLOAD_PICTURES) {
 475                         remove_directory(ABS_PATH . $id);
 476                     }
 477                     $this->messages->add('s', _('the link has been deleted successfully'));
 478                 }
 479                 else {
 480                     $this->messages->add('e', _('the link wasn\'t deleted'));
 481                     $msg = 'error : can\'t delete link #' . $id;
 482                 }
 483                 Tools::logm($msg);
 484                 Tools::redirect('?');
 485                 break;
 486             case 'toggle_fav' :
 487                 $this->store->favoriteById($id, $this->user->getId());
 488                 Tools::logm('mark as favorite link #' . $id);
 489                 if ( Tools::isAjaxRequest() ) {
 490                   echo 1;
 491                   exit;
 492                 }
 493                 else {
 494                   Tools::redirect();
 495                 }
 496                 break;
 497             case 'toggle_archive' :
 498                 $this->store->archiveById($id, $this->user->getId());
 499                 Tools::logm('archive link #' . $id);
 500                 if ( Tools::isAjaxRequest() ) {
 501                   echo 1;
 502                   exit;
 503                 }
 504                 else {
 505                   Tools::redirect();
 506                 }
 507                 break;
 508             case 'archive_all' :
 509                 $this->store->archiveAll($this->user->getId());
 510                 Tools::logm('archive all links');
 511                 Tools::redirect();
 512                 break;
 513             case 'add_tag' :
 514                 if (isset($_GET['search'])) {
 515                     //when we want to apply a tag to a search
 516                     $search = true;
 517                     $tags = array($_GET['search']);
 518                     $allentry_ids = $this->store->search($tags[0], $this->user->getId());
 519                     $entry_ids = array();
 520                     foreach ($allentry_ids as $eachentry) {
 521                         $entry_ids[] = $eachentry[0];
 522                     }
 523                 } else { //add a tag to a single article
 524                     $tags = explode(',', $_POST['value']);
 525                     $entry_ids = array($_POST['entry_id']);
 526                 }
 527                 foreach($entry_ids as $entry_id) {
 528                     $entry = $this->store->retrieveOneById($entry_id, $this->user->getId());
 529                     if (!$entry) {
 530                         $this->messages->add('e', _('Article not found!'));
 531                         Tools::logm('error : article not found');
 532                         Tools::redirect();
 533                     }
 534                     //get all already set tags to preven duplicates
 535                     $already_set_tags = array();
 536                     $entry_tags = $this->store->retrieveTagsByEntry($entry_id);
 537                     foreach ($entry_tags as $tag) {
 538                       $already_set_tags[] = $tag['value'];
 539                     }
 540                     foreach($tags as $key => $tag_value) {
 541                         $value = trim($tag_value);
 542                         if ($value && !in_array($value, $already_set_tags)) {
 543                           $tag = $this->store->retrieveTagByValue($value);
 544                           if (is_null($tag)) {
 545                               # we create the tag
 546                               $tag = $this->store->createTag($value);
 547                               $sequence = '';
 548                               if (STORAGE == 'postgres') {
 549                                   $sequence = 'tags_id_seq';
 550                               }
 551                               $tag_id = $this->store->getLastId($sequence);
 552                           }
 553                           else {
 554                               $tag_id = $tag['id'];
 555                           }
 556
 557                           # we assign the tag to the article
 558                           $this->store->setTagToEntry($tag_id, $entry_id);
 559                         }
 560                     }
 561                 }
 562                 $this->messages->add('s', _('the tag has been applied successfully'));
 563                 Tools::redirect();
 564                 break;
 565             case 'remove_tag' :
 566                 $tag_id = $_GET['tag_id'];
 567                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 568                 if (!$entry) {
 569                     $this->messages->add('e', _('Article not found!'));
 570                     Tools::logm('error : article not found');
 571                     Tools::redirect();
 572                 }
 573                 $this->store->removeTagForEntry($id, $tag_id);
 574                 Tools::redirect();
 575                 break;
 576             default:
 577                 break;
 578         }
 579     }
 580
 581     function displayView($view, $id = 0)
 582     {
 583         $tpl_vars = array();
 584
 585         switch ($view)
 586         {
 587             case 'config':
 588                 $dev_infos = $this->getPocheVersion('dev');
 589                 $dev = trim($dev_infos[0]);
 590                 $check_time_dev = date('d-M-Y H:i', $dev_infos[1]);
 591                 $prod_infos = $this->getPocheVersion('prod');
 592                 $prod = trim($prod_infos[0]);
 593                 $check_time_prod = date('d-M-Y H:i', $prod_infos[1]);
 594                 $compare_dev = version_compare(POCHE, $dev);
 595                 $compare_prod = version_compare(POCHE, $prod);
 596                 $themes = $this->getInstalledThemes();
 597                 $languages = $this->getInstalledLanguages();
 598                 $token = $this->user->getConfigValue('token');
 599                 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
 600                 $only_user = ($this->store->listUsers() > 1) ? false : true;
 601                 $tpl_vars = array(
 602                     'themes' => $themes,
 603                     'languages' => $languages,
 604                     'dev' => $dev,
 605                     'prod' => $prod,
 606                     'check_time_dev' => $check_time_dev,
 607                     'check_time_prod' => $check_time_prod,
 608                     'compare_dev' => $compare_dev,
 609                     'compare_prod' => $compare_prod,
 610                     'token' => $token,
 611                     'user_id' => $this->user->getId(),
 612                     'http_auth' => $http_auth,
 613                     'only_user' => $only_user
 614                 );
 615                 Tools::logm('config view');
 616                 break;
 617             case 'edit-tags':
 618                 # tags
 619                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 620                 if (!$entry) {
 621                     $this->messages->add('e', _('Article not found!'));
 622                     Tools::logm('error : article not found');
 623                     Tools::redirect();
 624                 }
 625                 $tags = $this->store->retrieveTagsByEntry($id);
 626                 $tpl_vars = array(
 627                     'entry_id' => $id,
 628                     'tags' => $tags,
 629                     'entry' => $entry,
 630                 );
 631                 break;
 632             case 'tags':
 633                 $token = $this->user->getConfigValue('token');
 634                 //if term is set - search tags for this term
 635                 $term = Tools::checkVar('term');
 636                 $tags = $this->store->retrieveAllTags($this->user->getId(), $term);
 637                 if (Tools::isAjaxRequest()) {
 638                   $result = array();
 639                   foreach ($tags as $tag) {
 640                     $result[] = $tag['value'];
 641                   }
 642                   echo json_encode($result);
 643                   exit;
 644                 }
 645                 $tpl_vars = array(
 646                     'token' => $token,
 647                     'user_id' => $this->user->getId(),
 648                     'tags' => $tags,
 649                 );
 650                 break;
 651             case 'search':
 652                 if (isset($_GET['search'])) {
 653                    $search = filter_var($_GET['search'], FILTER_SANITIZE_STRING);
 654                    $tpl_vars['entries'] = $this->store->search($search, $this->user->getId());
 655                    $count = count($tpl_vars['entries']);
 656                    $this->pagination->set_total($count);
 657                    $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
 658                             $this->pagination->page_links('?view=' . $view . '?search=' . $search . '&sort=' . $_SESSION['sort'] . '&' ));
 659                    $tpl_vars['page_links'] = $page_links;
 660                    $tpl_vars['nb_results'] = $count;
 661                    $tpl_vars['search_term'] = $search;
 662                 }
 663                 break;
 664             case 'view':
 665                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 666                 if ($entry != NULL) {
 667                     Tools::logm('view link #' . $id);
 668                     $content = $entry['content'];
 669                     if (function_exists('tidy_parse_string')) {
 670                         $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
 671                         $tidy->cleanRepair();
 672                         $content = $tidy->value;
 673                     }
 674
 675                     # flattr checking
 676                     $flattr = new FlattrItem();
 677                     $flattr->checkItem($entry['url'], $entry['id']);
 678
 679                     # tags
 680                     $tags = $this->store->retrieveTagsByEntry($entry['id']);
 681
 682                     $tpl_vars = array(
 683                         'entry' => $entry,
 684                         'content' => $content,
 685                         'flattr' => $flattr,
 686                         'tags' => $tags
 687                     );
 688                 }
 689                 else {
 690                     Tools::logm('error in view call : entry is null');
 691                 }
 692                 break;
 693             default: # home, favorites, archive and tag views
 694                 $tpl_vars = array(
 695                     'entries' => '',
 696                     'page_links' => '',
 697                     'nb_results' => '',
 698                     'listmode' => (isset($_COOKIE['listmode']) ? true : false),
 699                 );
 700
 701                 //if id is given - we retrive entries by tag: id is tag id
 702                 if ($id) {
 703                   $tpl_vars['tag'] = $this->store->retrieveTag($id, $this->user->getId());
 704                   $tpl_vars['id'] = intval($id);
 705                 }
 706
 707                 $count = $this->store->getEntriesByViewCount($view, $this->user->getId(), $id);
 708
 709                 if ($count > 0) {
 710                     $this->pagination->set_total($count);
 711                     $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
 712                         $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . (($id)?'&id='.$id:'') . '&' ));
 713                     $tpl_vars['entries'] = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit(), $id);
 714                     $tpl_vars['page_links'] = $page_links;
 715                     $tpl_vars['nb_results'] = $count;
 716                 }
 717                 Tools::logm('display ' . $view . ' view');
 718                 break;
 719         }
 720
 721         return $tpl_vars;
 722     }
 723
 724     /**
 725      * update the password of the current user.
 726      * if MODE_DEMO is TRUE, the password can't be updated.
 727      * @todo add the return value
 728      * @todo set the new password in function header like this updatePassword($newPassword)
 729      * @return boolean
 730      */
 731     public function updatePassword()
 732     {
 733         if (MODE_DEMO) {
 734             $this->messages->add('i', _('in demo mode, you can\'t update your password'));
 735             Tools::logm('in demo mode, you can\'t do this');
 736             Tools::redirect('?view=config');
 737         }
 738         else {
 739             if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
 740                 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
 741                     $this->messages->add('s', _('your password has been updated'));
 742                     $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
 743                     Session::logout();
 744                     Tools::logm('password updated');
 745                     Tools::redirect();
 746                 }
 747                 else {
 748                     $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
 749                     Tools::redirect('?view=config');
 750                 }
 751             }
 752         }
 753     }
 754
 755     public function updateTheme()
 756     {
 757         # no data
 758         if (empty($_POST['theme'])) {
 759         }
 760
 761         # we are not going to change it to the current theme...
 762         if ($_POST['theme'] == $this->getTheme()) {
 763             $this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
 764             Tools::redirect('?view=config');
 765         }
 766
 767         $themes = $this->getInstalledThemes();
 768         $actualTheme = false;
 769
 770         foreach (array_keys($themes) as $theme) {
 771             if ($theme == $_POST['theme']) {
 772                 $actualTheme = true;
 773                 break;
 774             }
 775         }
 776
 777         if (! $actualTheme) {
 778             $this->messages->add('e', _('that theme does not seem to be installed'));
 779             Tools::redirect('?view=config');
 780         }
 781
 782         $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
 783         $this->messages->add('s', _('you have changed your theme preferences'));
 784
 785         $currentConfig = $_SESSION['poche_user']->config;
 786         $currentConfig['theme'] = $_POST['theme'];
 787
 788         $_SESSION['poche_user']->setConfig($currentConfig);
 789
 790         $this->emptyCache();
 791
 792         Tools::redirect('?view=config');
 793     }
 794
 795     public function updateLanguage()
 796     {
 797         # no data
 798         if (empty($_POST['language'])) {
 799         }
 800
 801         # we are not going to change it to the current language...
 802         if ($_POST['language'] == $this->getLanguage()) {
 803             $this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
 804             Tools::redirect('?view=config');
 805         }
 806
 807         $languages = $this->getInstalledLanguages();
 808         $actualLanguage = false;
 809
 810         foreach ($languages as $language) {
 811             if ($language['value'] == $_POST['language']) {
 812                 $actualLanguage = true;
 813                 break;
 814             }
 815         }
 816
 817         if (! $actualLanguage) {
 818             $this->messages->add('e', _('that language does not seem to be installed'));
 819             Tools::redirect('?view=config');
 820         }
 821
 822         $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
 823         $this->messages->add('s', _('you have changed your language preferences'));
 824
 825         $currentConfig = $_SESSION['poche_user']->config;
 826         $currentConfig['language'] = $_POST['language'];
 827
 828         $_SESSION['poche_user']->setConfig($currentConfig);
 829
 830         $this->emptyCache();
 831
 832         Tools::redirect('?view=config');
 833     }
 834     /**
 835      * get credentials from differents sources
 836      * it redirects the user to the $referer link
 837      * @return array
 838      */
 839     private function credentials() {
 840         if(isset($_SERVER['PHP_AUTH_USER'])) {
 841             return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
 842         }
 843         if(!empty($_POST['login']) && !empty($_POST['password'])) {
 844             return array($_POST['login'],$_POST['password'],false);
 845         }
 846         if(isset($_SERVER['REMOTE_USER'])) {
 847             return array($_SERVER['REMOTE_USER'],'http_auth',true);
 848         }
 849
 850         return array(false,false,false);
 851     }
 852
 853     /**
 854      * checks if login & password are correct and save the user in session.
 855      * it redirects the user to the $referer link
 856      * @param  string $referer the url to redirect after login
 857      * @todo add the return value
 858      * @return boolean
 859      */
 860     public function login($referer)
 861     {
 862         list($login,$password,$isauthenticated)=$this->credentials();
 863         if($login === false || $password === false) {
 864             $this->messages->add('e', _('login failed: you have to fill all fields'));
 865             Tools::logm('login failed');
 866             Tools::redirect();
 867         }
 868         if (!empty($login) && !empty($password)) {
 869             $user = $this->store->login($login, Tools::encodeString($password . $login), $isauthenticated);
 870             if ($user != array()) {
 871                 # Save login into Session
 872                 $longlastingsession = isset($_POST['longlastingsession']);
 873                 $passwordTest = ($isauthenticated) ? $user['password'] : Tools::encodeString($password . $login);
 874                 Session::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
 875                 $this->messages->add('s', _('welcome to your wallabag'));
 876                 Tools::logm('login successful');
 877                 Tools::redirect($referer);
 878             }
 879             $this->messages->add('e', _('login failed: bad login or password'));
 880             Tools::logm('login failed');
 881             Tools::redirect();
 882         }
 883     }
 884
 885     /**
 886      * log out the poche user. It cleans the session.
 887      * @todo add the return value
 888      * @return boolean
 889      */
 890     public function logout()
 891     {
 892         $this->user = array();
 893         Session::logout();
 894         Tools::logm('logout');
 895         Tools::redirect();
 896     }
 897
 898     /**
 899      * import datas into your poche
 900      * @return boolean
 901      */
 902     public function import() {
 903
 904       if ( isset($_FILES['file']) ) {
 905         Tools::logm('Import stated: parsing file');
 906
 907         // assume, that file is in json format
 908         $str_data = file_get_contents($_FILES['file']['tmp_name']);
 909         $data = json_decode($str_data, true);
 910
 911         if ( $data === null ) {
 912           //not json - assume html
 913           $html = new simple_html_dom();
 914           $html->load_file($_FILES['file']['tmp_name']);
 915           $data = array();
 916           $read = 0;
 917           foreach (array('ol','ul') as $list) {
 918             foreach ($html->find($list) as $ul) {
 919               foreach ($ul->find('li') as $li) {
 920                 $tmpEntry = array();
 921                   $a = $li->find('a');
 922                   $tmpEntry['url'] = $a[0]->href;
 923                   $tmpEntry['tags'] = $a[0]->tags;
 924                   $tmpEntry['is_read'] = $read;
 925                   if ($tmpEntry['url']) {
 926                     $data[] = $tmpEntry;
 927                   }
 928               }
 929               # the second <ol/ul> is for read links
 930               $read = ((sizeof($data) && $read)?0:1);
 931             }
 932           }
 933         }
 934
 935         //for readability structure
 936         foreach ($data as $record) {
 937           if (is_array($record)) {
 938             $data[] = $record;
 939             foreach ($record as $record2) {
 940               if (is_array($record2)) {
 941                 $data[] = $record2;
 942               }
 943             }
 944           }
 945         }
 946
 947         $urlsInserted = array(); //urls of articles inserted
 948         foreach ($data as $record) {
 949           $url = trim( isset($record['article__url']) ? $record['article__url'] : (isset($record['url']) ? $record['url'] : '') );
 950           if ( $url and !in_array($url, $urlsInserted) ) {
 951             $title = (isset($record['title']) ? $record['title'] :  _('Untitled - Import - ').'</a> <a href="./?import">'._('click to finish import').'</a><a>');
 952             $body = (isset($record['content']) ? $record['content'] : '');
 953             $isRead = (isset($record['is_read']) ? intval($record['is_read']) : (isset($record['archive'])?intval($record['archive']):0));
 954             $isFavorite = (isset($record['is_fav']) ? intval($record['is_fav']) : (isset($record['favorite'])?intval($record['favorite']):0) );
 955             //insert new record
 956             $id = $this->store->add($url, $title, $body, $this->user->getId(), $isFavorite, $isRead);
 957             if ( $id ) {
 958               $urlsInserted[] = $url; //add
 959
 960               if ( isset($record['tags']) && trim($record['tags']) ) {
 961                 //@TODO: set tags
 962
 963               }
 964             }
 965           }
 966         }
 967
 968         $i = sizeof($urlsInserted);
 969         if ( $i > 0 ) {
 970           $this->messages->add('s', _('Articles inserted: ').$i._('. Please note, that some may be marked as "read".'));
 971         }
 972         Tools::logm('Import of articles finished: '.$i.' articles added (w/o content if not provided).');
 973       }
 974       //file parsing finished here
 975
 976       //now download article contents if any
 977
 978       //check if we need to download any content
 979       $recordsDownloadRequired = $this->store->retrieveUnfetchedEntriesCount($this->user->getId());
 980       if ( $recordsDownloadRequired == 0 ) {
 981         //nothing to download
 982         $this->messages->add('s', _('Import finished.'));
 983         Tools::logm('Import finished completely');
 984         Tools::redirect();
 985       }
 986       else {
 987         //if just inserted - don't download anything, download will start in next reload
 988         if ( !isset($_FILES['file']) ) {
 989           //download next batch
 990           Tools::logm('Fetching next batch of articles...');
 991           $items = $this->store->retrieveUnfetchedEntries($this->user->getId(), IMPORT_LIMIT);
 992
 993           $purifier = $this->getPurifier();
 994
 995           foreach ($items as $item) {
 996             $url = new Url(base64_encode($item['url']));
 997             Tools::logm('Fetching article '.$item['id']);
 998             $content = Tools::getPageContent($url);
 999
1000             $title = (($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled'));
1001             $body = (($content['rss']['channel']['item']['description'] != '') ? $content['rss']['channel']['item']['description'] : _('Undefined'));
1002
1003             //clean content to prevent xss attack
1004             $title = $purifier->purify($title);
1005             $body = $purifier->purify($body);
1006
1007             $this->store->updateContentAndTitle($item['id'], $title, $body, $this->user->getId());
1008             Tools::logm('Article '.$item['id'].' updated.');
1009           }
1010
1011         }
1012       }
1013
1014       return array('includeImport'=>true, 'import'=>array('recordsDownloadRequired'=>$recordsDownloadRequired, 'recordsUnderDownload'=> IMPORT_LIMIT, 'delay'=> IMPORT_DELAY * 1000) );
1015     }
1016
1017     /**
1018      * export poche entries in json
1019      * @return json all poche entries
1020      */
1021     public function export() {
1022       $filename = "wallabag-export-".$this->user->getId()."-".date("Y-m-d").".json";
1023       header('Content-Disposition: attachment; filename='.$filename);
1024
1025       $entries = $this->store->retrieveAll($this->user->getId());
1026       echo $this->tpl->render('export.twig', array(
1027           'export' => Tools::renderJson($entries),
1028       ));
1029       Tools::logm('export view');
1030     }
1031
1032     /**
1033      * Checks online the latest version of poche and cache it
1034      * @param  string $which 'prod' or 'dev'
1035      * @return string        latest $which version
1036      */
1037     private function getPocheVersion($which = 'prod') {
1038       $cache_file = CACHE . '/' . $which;
1039       $check_time = time();
1040
1041       # checks if the cached version file exists
1042       if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
1043          $version = file_get_contents($cache_file);
1044          $check_time = filemtime($cache_file);
1045       } else {
1046          $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
1047          file_put_contents($cache_file, $version, LOCK_EX);
1048       }
1049       return array($version, $check_time);
1050     }
1051
1052     public function generateToken()
1053     {
1054       if (ini_get('open_basedir') === '') {
1055         if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
1056           echo 'This is a server using Windows!';
1057           // alternative to /dev/urandom for Windows
1058           $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1059         } else {
1060           $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1061         }
1062       }
1063       else {
1064         $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1065       }
1066
1067       $token = str_replace('+', '', $token);
1068       $this->store->updateUserConfig($this->user->getId(), 'token', $token);
1069       $currentConfig = $_SESSION['poche_user']->config;
1070       $currentConfig['token'] = $token;
1071       $_SESSION['poche_user']->setConfig($currentConfig);
1072       Tools::redirect();
1073     }
1074
1075     public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1076     {
1077         $allowed_types = array('home', 'fav', 'archive', 'tag');
1078         $config = $this->store->getConfigUser($user_id);
1079
1080         if ($config == null) {
1081             die(_('User with this id (' . $user_id . ') does not exist.'));
1082         }
1083
1084         if (!in_array($type, $allowed_types) ||
1085             $token != $config['token']) {
1086             die(_('Uh, there is a problem while generating feeds.'));
1087         }
1088         // Check the token
1089
1090         $feed = new FeedWriter(RSS2);
1091         $feed->setTitle('wallabag — ' . $type . ' feed');
1092         $feed->setLink(Tools::getPocheUrl());
1093         $feed->setChannelElement('pubDate', date(DATE_RSS , time()));
1094         $feed->setChannelElement('generator', 'wallabag');
1095         $feed->setDescription('wallabag ' . $type . ' elements');
1096
1097         if ($type == 'tag') {
1098             $entries = $this->store->retrieveEntriesByTag($tag_id, $user_id);
1099         }
1100         else {
1101             $entries = $this->store->getEntriesByView($type, $user_id);
1102         }
1103
1104         if (count($entries) > 0) {
1105             foreach ($entries as $entry) {
1106                 $newItem = $feed->createNewItem();
1107                 $newItem->setTitle($entry['title']);
1108                 $newItem->setSource(Tools::getPocheUrl() . '?view=view&amp;id=' . $entry['id']);
1109                 $newItem->setLink($entry['url']);
1110                 $newItem->setDate(time());
1111                 $newItem->setDescription($entry['content']);
1112                 $feed->addItem($newItem);
1113             }
1114         }
1115
1116         $feed->genarateFeed();
1117         exit;
1118     }
1119
1120     public function emptyCache() {
1121         $files = new RecursiveIteratorIterator(
1122             new RecursiveDirectoryIterator(CACHE, RecursiveDirectoryIterator::SKIP_DOTS),
1123             RecursiveIteratorIterator::CHILD_FIRST
1124         );
1125
1126         foreach ($files as $fileinfo) {
1127             $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
1128             $todo($fileinfo->getRealPath());
1129         }
1130
1131         Tools::logm('empty cache');
1132         $this->messages->add('s', _('Cache deleted.'));
1133         Tools::redirect();
1134     }
1135
1136     /**
1137      * return new purifier object with actual config
1138      */
1139     protected function getPurifier() {
1140       $config = HTMLPurifier_Config::createDefault();
1141       $config->set('Cache.SerializerPath', CACHE);
1142       $config->set('HTML.SafeIframe', true);
1143       $config->set('URI.SafeIframeRegexp', '%^(https?:)?//(www\.youtube(?:-nocookie)?\.com/embed/|player\.vimeo\.com/video/)%'); //allow YouTube and Vimeo$purifier = new HTMLPurifier($config);
1144
1145       return new HTMLPurifier($config);
1146     }
1147 }