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 rename inc/poche/config.inc.php.new 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     private function install()
 246     {
 247         Tools::logm('poche still not installed');
 248         echo $this->tpl->render('install.twig', array(
 249             'token' => Session::getToken(),
 250             'theme' => $this->getTheme(),
 251             'poche_url' => Tools::getPocheUrl()
 252         ));
 253         if (isset($_GET['install'])) {
 254             if (($_POST['password'] == $_POST['password_repeat'])
 255                 && $_POST['password'] != "" && $_POST['login'] != "") {
 256                 # let's rock, install poche baby !
 257                 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
 258                 {
 259                     Session::logout();
 260                     Tools::logm('poche is now installed');
 261                     Tools::redirect();
 262                 }
 263             }
 264             else {
 265                 Tools::logm('error during installation');
 266                 Tools::redirect();
 267             }
 268         }
 269         exit();
 270     }
 271
 272     public function getTheme() {
 273         return $this->currentTheme;
 274     }
 275
 276     /**
 277      * Provides theme information by parsing theme.ini file if present in the theme's root directory.
 278      * In all cases, the following data will be returned:
 279      * - name: theme's name, or key if the theme is unnamed,
 280      * - current: boolean informing if the theme is the current user theme.
 281      *
 282      * @param string $theme Theme key (directory name)
 283      * @return array|boolean Theme information, or false if the theme doesn't exist.
 284      */
 285     public function getThemeInfo($theme) {
 286         if (!is_dir(THEME . '/' . $theme)) {
 287             return false;
 288         }
 289
 290         $themeIniFile = THEME . '/' . $theme . '/theme.ini';
 291         $themeInfo = array();
 292
 293         if (is_file($themeIniFile) && is_readable($themeIniFile)) {
 294             $themeInfo = parse_ini_file($themeIniFile);
 295         }
 296
 297         if ($themeInfo === false) {
 298             $themeInfo = array();
 299         }
 300         if (!isset($themeInfo['name'])) {
 301             $themeInfo['name'] = $theme;
 302         }
 303         $themeInfo['current'] = ($theme === $this->getTheme());
 304
 305         return $themeInfo;
 306     }
 307
 308     public function getInstalledThemes() {
 309         $handle = opendir(THEME);
 310         $themes = array();
 311
 312         while (($theme = readdir($handle)) !== false) {
 313             # Themes are stored in a directory, so all directory names are themes
 314             # @todo move theme installation data to database
 315             if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
 316                 continue;
 317             }
 318
 319             $themes[$theme] = $this->getThemeInfo($theme);
 320         }
 321
 322         ksort($themes);
 323
 324         return $themes;
 325     }
 326
 327     public function getLanguage() {
 328         return $this->currentLanguage;
 329     }
 330
 331     public function getInstalledLanguages() {
 332         $handle = opendir(LOCALE);
 333         $languages = array();
 334
 335         while (($language = readdir($handle)) !== false) {
 336             # Languages are stored in a directory, so all directory names are languages
 337             # @todo move language installation data to database
 338             if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.', 'tools'))) {
 339                 continue;
 340             }
 341
 342             $current = false;
 343
 344             if ($language === $this->getLanguage()) {
 345                 $current = true;
 346             }
 347
 348             $languages[] = array('name' => (isset($this->language_names[$language]) ? $this->language_names[$language] : $language), 'value' => $language, 'current' => $current);
 349         }
 350
 351         return $languages;
 352     }
 353
 354     public function getDefaultConfig()
 355     {
 356         return array(
 357             'pager' => PAGINATION,
 358             'language' => LANG,
 359             'theme' => DEFAULT_THEME
 360         );
 361     }
 362
 363     /**
 364      * Call action (mark as fav, archive, delete, etc.)
 365      */
 366     public function action($action, Url $url, $id = 0, $import = FALSE, $autoclose = FALSE, $tags = null)
 367     {
 368         switch ($action)
 369         {
 370             case 'add':
 371                 $content = Tools::getPageContent($url);
 372                 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
 373                 $body = $content['rss']['channel']['item']['description'];
 374
 375                 // clean content from prevent xss attack
 376                 $purifier = $this->getPurifier();
 377                 $title = $purifier->purify($title);
 378                 $body = $purifier->purify($body);
 379
 380                 //search for possible duplicate
 381                 $duplicate = NULL;
 382                 $duplicate = $this->store->retrieveOneByURL($url->getUrl(), $this->user->getId());
 383
 384                 $last_id = $this->store->add($url->getUrl(), $title, $body, $this->user->getId());
 385                 if ( $last_id ) {
 386                     Tools::logm('add link ' . $url->getUrl());
 387                     if (DOWNLOAD_PICTURES) {
 388                         $content = filtre_picture($body, $url->getUrl(), $last_id);
 389                         Tools::logm('updating content article');
 390                         $this->store->updateContent($last_id, $content, $this->user->getId());
 391                     }
 392
 393                     if ($duplicate != NULL) {
 394                         // 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
 395                         Tools::logm('link ' . $url->getUrl() . ' is a duplicate');
 396                         // 1) - preserve tags and favorite, then drop old entry
 397                         $this->store->reassignTags($duplicate['id'], $last_id);
 398                         if ($duplicate['is_fav']) {
 399                           $this->store->favoriteById($last_id, $this->user->getId());
 400                         }
 401                         if ($this->store->deleteById($duplicate['id'], $this->user->getId())) {
 402                           Tools::logm('previous link ' . $url->getUrl() .' entry deleted');
 403                         }
 404                     }
 405
 406                     $this->messages->add('s', _('the link has been added successfully'));
 407                 }
 408                 else {
 409                     $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
 410                     Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
 411                 }
 412
 413                 if ($autoclose == TRUE) {
 414                   Tools::redirect('?view=home');
 415                 } else {
 416                   Tools::redirect('?view=home&closewin=true');
 417                 }
 418                 break;
 419             case 'delete':
 420                 $msg = 'delete link #' . $id;
 421                 if ($this->store->deleteById($id, $this->user->getId())) {
 422                     if (DOWNLOAD_PICTURES) {
 423                         remove_directory(ABS_PATH . $id);
 424                     }
 425                     $this->messages->add('s', _('the link has been deleted successfully'));
 426                 }
 427                 else {
 428                     $this->messages->add('e', _('the link wasn\'t deleted'));
 429                     $msg = 'error : can\'t delete link #' . $id;
 430                 }
 431                 Tools::logm($msg);
 432                 Tools::redirect('?');
 433                 break;
 434             case 'toggle_fav' :
 435                 $this->store->favoriteById($id, $this->user->getId());
 436                 Tools::logm('mark as favorite link #' . $id);
 437                 if ( Tools::isAjaxRequest() ) {
 438                   echo 1;
 439                   exit;
 440                 }
 441                 else {
 442                   Tools::redirect();
 443                 }
 444                 break;
 445             case 'toggle_archive' :
 446                 $this->store->archiveById($id, $this->user->getId());
 447                 Tools::logm('archive link #' . $id);
 448                 if ( Tools::isAjaxRequest() ) {
 449                   echo 1;
 450                   exit;
 451                 }
 452                 else {
 453                   Tools::redirect();
 454                 }
 455                 break;
 456             case 'archive_all' :
 457                 $this->store->archiveAll($this->user->getId());
 458                 Tools::logm('archive all links');
 459                 Tools::redirect();
 460                 break;
 461             case 'add_tag' :
 462                 $tags = explode(',', $_POST['value']);
 463                 $entry_id = $_POST['entry_id'];
 464                 $entry = $this->store->retrieveOneById($entry_id, $this->user->getId());
 465                 if (!$entry) {
 466                     $this->messages->add('e', _('Article not found!'));
 467                     Tools::logm('error : article not found');
 468                     Tools::redirect();
 469                 }
 470                 //get all already set tags to preven duplicates
 471                 $already_set_tags = array();
 472                 $entry_tags = $this->store->retrieveTagsByEntry($entry_id);
 473                 foreach ($entry_tags as $tag) {
 474                   $already_set_tags[] = $tag['value'];
 475                 }
 476                 foreach($tags as $key => $tag_value) {
 477                     $value = trim($tag_value);
 478                     if ($value && !in_array($value, $already_set_tags)) {
 479                       $tag = $this->store->retrieveTagByValue($value);
 480
 481                       if (is_null($tag)) {
 482                           # we create the tag
 483                           $tag = $this->store->createTag($value);
 484                           $sequence = '';
 485                           if (STORAGE == 'postgres') {
 486                               $sequence = 'tags_id_seq';
 487                           }
 488                           $tag_id = $this->store->getLastId($sequence);
 489                       }
 490                       else {
 491                           $tag_id = $tag['id'];
 492                       }
 493
 494                       # we assign the tag to the article
 495                       $this->store->setTagToEntry($tag_id, $entry_id);
 496                     }
 497                 }
 498                 Tools::redirect();
 499                 break;
 500             case 'remove_tag' :
 501                 $tag_id = $_GET['tag_id'];
 502                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 503                 if (!$entry) {
 504                     $this->messages->add('e', _('Article not found!'));
 505                     Tools::logm('error : article not found');
 506                     Tools::redirect();
 507                 }
 508                 $this->store->removeTagForEntry($id, $tag_id);
 509                 Tools::redirect();
 510                 break;
 511             default:
 512                 break;
 513         }
 514     }
 515
 516     function displayView($view, $id = 0)
 517     {
 518         $tpl_vars = array();
 519
 520         switch ($view)
 521         {
 522             case 'config':
 523                 $dev_infos = $this->getPocheVersion('dev');
 524                 $dev = trim($dev_infos[0]);
 525                 $check_time_dev = date('d-M-Y H:i', $dev_infos[1]);
 526                 $prod_infos = $this->getPocheVersion('prod');
 527                 $prod = trim($prod_infos[0]);
 528                 $check_time_prod = date('d-M-Y H:i', $prod_infos[1]);
 529                 $compare_dev = version_compare(POCHE, $dev);
 530                 $compare_prod = version_compare(POCHE, $prod);
 531                 $themes = $this->getInstalledThemes();
 532                 $languages = $this->getInstalledLanguages();
 533                 $token = $this->user->getConfigValue('token');
 534                 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
 535                 $tpl_vars = array(
 536                     'themes' => $themes,
 537                     'languages' => $languages,
 538                     'dev' => $dev,
 539                     'prod' => $prod,
 540                     'check_time_dev' => $check_time_dev,
 541                     'check_time_prod' => $check_time_prod,
 542                     'compare_dev' => $compare_dev,
 543                     'compare_prod' => $compare_prod,
 544                     'token' => $token,
 545                     'user_id' => $this->user->getId(),
 546                     'http_auth' => $http_auth,
 547                 );
 548                 Tools::logm('config view');
 549                 break;
 550             case 'edit-tags':
 551                 # tags
 552                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 553                 if (!$entry) {
 554                     $this->messages->add('e', _('Article not found!'));
 555                     Tools::logm('error : article not found');
 556                     Tools::redirect();
 557                 }
 558                 $tags = $this->store->retrieveTagsByEntry($id);
 559                 $tpl_vars = array(
 560                     'entry_id' => $id,
 561                     'tags' => $tags,
 562                     'entry' => $entry,
 563                 );
 564                 break;
 565             case 'tags':
 566                 $token = $this->user->getConfigValue('token');
 567                 //if term is set - search tags for this term
 568                 $term = Tools::checkVar('term');
 569                 $tags = $this->store->retrieveAllTags($this->user->getId(), $term);
 570                 if (Tools::isAjaxRequest()) {
 571                   $result = array();
 572                   foreach ($tags as $tag) {
 573                     $result[] = $tag['value'];
 574                   }
 575                   echo json_encode($result);
 576                   exit;
 577                 }
 578                 $tpl_vars = array(
 579                     'token' => $token,
 580                     'user_id' => $this->user->getId(),
 581                     'tags' => $tags,
 582                 );
 583                 break;
 584             case 'search':
 585                 if (isset($_GET['search'])) {
 586                    $search = filter_var($_GET['search'], FILTER_SANITIZE_STRING);
 587                    $tpl_vars['entries'] = $this->store->search($search, $this->user->getId());
 588                    $count = count($tpl_vars['entries']);
 589                    $this->pagination->set_total($count);
 590                    $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
 591                             $this->pagination->page_links('?view=' . $view . '?search=' . $search . '&sort=' . $_SESSION['sort'] . '&' ));
 592                    $tpl_vars['page_links'] = $page_links;
 593                    $tpl_vars['nb_results'] = $count;
 594                    $tpl_vars['search_term'] = $search;
 595                 }
 596                 break;
 597             case 'view':
 598                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 599                 if ($entry != NULL) {
 600                     Tools::logm('view link #' . $id);
 601                     $content = $entry['content'];
 602                     if (function_exists('tidy_parse_string')) {
 603                         $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
 604                         $tidy->cleanRepair();
 605                         $content = $tidy->value;
 606                     }
 607
 608                     # flattr checking
 609                     $flattr = new FlattrItem();
 610                     $flattr->checkItem($entry['url'], $entry['id']);
 611
 612                     # tags
 613                     $tags = $this->store->retrieveTagsByEntry($entry['id']);
 614
 615                     $tpl_vars = array(
 616                         'entry' => $entry,
 617                         'content' => $content,
 618                         'flattr' => $flattr,
 619                         'tags' => $tags
 620                     );
 621                 }
 622                 else {
 623                     Tools::logm('error in view call : entry is null');
 624                 }
 625                 break;
 626             default: # home, favorites, archive and tag views
 627                 $tpl_vars = array(
 628                     'entries' => '',
 629                     'page_links' => '',
 630                     'nb_results' => '',
 631                     'listmode' => (isset($_COOKIE['listmode']) ? true : false),
 632                 );
 633
 634                 //if id is given - we retrive entries by tag: id is tag id
 635                 if ($id) {
 636                   $tpl_vars['tag'] = $this->store->retrieveTag($id, $this->user->getId());
 637                   $tpl_vars['id'] = intval($id);
 638                 }
 639
 640                 $count = $this->store->getEntriesByViewCount($view, $this->user->getId(), $id);
 641
 642                 if ($count > 0) {
 643                     $this->pagination->set_total($count);
 644                     $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
 645                         $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . (($id)?'&id='.$id:'') . '&' ));
 646                     $tpl_vars['entries'] = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit(), $id);
 647                     $tpl_vars['page_links'] = $page_links;
 648                     $tpl_vars['nb_results'] = $count;
 649                 }
 650                 Tools::logm('display ' . $view . ' view');
 651                 break;
 652         }
 653
 654         return $tpl_vars;
 655     }
 656
 657     /**
 658      * update the password of the current user.
 659      * if MODE_DEMO is TRUE, the password can't be updated.
 660      * @todo add the return value
 661      * @todo set the new password in function header like this updatePassword($newPassword)
 662      * @return boolean
 663      */
 664     public function updatePassword()
 665     {
 666         if (MODE_DEMO) {
 667             $this->messages->add('i', _('in demo mode, you can\'t update your password'));
 668             Tools::logm('in demo mode, you can\'t do this');
 669             Tools::redirect('?view=config');
 670         }
 671         else {
 672             if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
 673                 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
 674                     $this->messages->add('s', _('your password has been updated'));
 675                     $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
 676                     Session::logout();
 677                     Tools::logm('password updated');
 678                     Tools::redirect();
 679                 }
 680                 else {
 681                     $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
 682                     Tools::redirect('?view=config');
 683                 }
 684             }
 685         }
 686     }
 687
 688     public function updateTheme()
 689     {
 690         # no data
 691         if (empty($_POST['theme'])) {
 692         }
 693
 694         # we are not going to change it to the current theme...
 695         if ($_POST['theme'] == $this->getTheme()) {
 696             $this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
 697             Tools::redirect('?view=config');
 698         }
 699
 700         $themes = $this->getInstalledThemes();
 701         $actualTheme = false;
 702
 703         foreach (array_keys($themes) as $theme) {
 704             if ($theme == $_POST['theme']) {
 705                 $actualTheme = true;
 706                 break;
 707             }
 708         }
 709
 710         if (! $actualTheme) {
 711             $this->messages->add('e', _('that theme does not seem to be installed'));
 712             Tools::redirect('?view=config');
 713         }
 714
 715         $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
 716         $this->messages->add('s', _('you have changed your theme preferences'));
 717
 718         $currentConfig = $_SESSION['poche_user']->config;
 719         $currentConfig['theme'] = $_POST['theme'];
 720
 721         $_SESSION['poche_user']->setConfig($currentConfig);
 722
 723         $this->emptyCache();
 724
 725         Tools::redirect('?view=config');
 726     }
 727
 728     public function updateLanguage()
 729     {
 730         # no data
 731         if (empty($_POST['language'])) {
 732         }
 733
 734         # we are not going to change it to the current language...
 735         if ($_POST['language'] == $this->getLanguage()) {
 736             $this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
 737             Tools::redirect('?view=config');
 738         }
 739
 740         $languages = $this->getInstalledLanguages();
 741         $actualLanguage = false;
 742
 743         foreach ($languages as $language) {
 744             if ($language['value'] == $_POST['language']) {
 745                 $actualLanguage = true;
 746                 break;
 747             }
 748         }
 749
 750         if (! $actualLanguage) {
 751             $this->messages->add('e', _('that language does not seem to be installed'));
 752             Tools::redirect('?view=config');
 753         }
 754
 755         $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
 756         $this->messages->add('s', _('you have changed your language preferences'));
 757
 758         $currentConfig = $_SESSION['poche_user']->config;
 759         $currentConfig['language'] = $_POST['language'];
 760
 761         $_SESSION['poche_user']->setConfig($currentConfig);
 762
 763         $this->emptyCache();
 764
 765         Tools::redirect('?view=config');
 766     }
 767     /**
 768      * get credentials from differents sources
 769      * it redirects the user to the $referer link
 770      * @return array
 771      */
 772     private function credentials() {
 773         if(isset($_SERVER['PHP_AUTH_USER'])) {
 774             return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
 775         }
 776         if(!empty($_POST['login']) && !empty($_POST['password'])) {
 777             return array($_POST['login'],$_POST['password'],false);
 778         }
 779         if(isset($_SERVER['REMOTE_USER'])) {
 780             return array($_SERVER['REMOTE_USER'],'http_auth',true);
 781         }
 782
 783         return array(false,false,false);
 784     }
 785
 786     /**
 787      * checks if login & password are correct and save the user in session.
 788      * it redirects the user to the $referer link
 789      * @param  string $referer the url to redirect after login
 790      * @todo add the return value
 791      * @return boolean
 792      */
 793     public function login($referer)
 794     {
 795         list($login,$password,$isauthenticated)=$this->credentials();
 796         if($login === false || $password === false) {
 797             $this->messages->add('e', _('login failed: you have to fill all fields'));
 798             Tools::logm('login failed');
 799             Tools::redirect();
 800         }
 801         if (!empty($login) && !empty($password)) {
 802             $user = $this->store->login($login, Tools::encodeString($password . $login), $isauthenticated);
 803             if ($user != array()) {
 804                 # Save login into Session
 805                 $longlastingsession = isset($_POST['longlastingsession']);
 806                 $passwordTest = ($isauthenticated) ? $user['password'] : Tools::encodeString($password . $login);
 807                 Session::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
 808                 $this->messages->add('s', _('welcome to your wallabag'));
 809                 Tools::logm('login successful');
 810                 Tools::redirect($referer);
 811             }
 812             $this->messages->add('e', _('login failed: bad login or password'));
 813             Tools::logm('login failed');
 814             Tools::redirect();
 815         }
 816     }
 817
 818     /**
 819      * log out the poche user. It cleans the session.
 820      * @todo add the return value
 821      * @return boolean
 822      */
 823     public function logout()
 824     {
 825         $this->user = array();
 826         Session::logout();
 827         Tools::logm('logout');
 828         Tools::redirect();
 829     }
 830
 831     /**
 832      * import datas into your poche
 833      * @return boolean
 834      */
 835     public function import() {
 836
 837       if (!defined('IMPORT_LIMIT')) {
 838         define('IMPORT_LIMIT', 5);
 839       }
 840       if (!defined('IMPORT_DELAY')) {
 841         define('IMPORT_DELAY', 5);
 842       }
 843
 844       if ( isset($_FILES['file']) ) {
 845         Tools::logm('Import stated: parsing file');
 846
 847         // assume, that file is in json format
 848         $str_data = file_get_contents($_FILES['file']['tmp_name']);
 849         $data = json_decode($str_data, true);
 850
 851         if ( $data === null ) {
 852           //not json - assume html
 853           $html = new simple_html_dom();
 854           $html->load_file($_FILES['file']['tmp_name']);
 855           $data = array();
 856           $read = 0;
 857           foreach (array('ol','ul') as $list) {
 858             foreach ($html->find($list) as $ul) {
 859               foreach ($ul->find('li') as $li) {
 860                 $tmpEntry = array();
 861                   $a = $li->find('a');
 862                   $tmpEntry['url'] = $a[0]->href;
 863                   $tmpEntry['tags'] = $a[0]->tags;
 864                   $tmpEntry['is_read'] = $read;
 865                   if ($tmpEntry['url']) {
 866                     $data[] = $tmpEntry;
 867                   }
 868               }
 869               # the second <ol/ul> is for read links
 870               $read = ((sizeof($data) && $read)?0:1);
 871             }
 872           }
 873         }
 874
 875         //for readability structure
 876         foreach ($data as $record) {
 877           if (is_array($record)) {
 878             $data[] = $record;
 879             foreach ($record as $record2) {
 880               if (is_array($record2)) {
 881                 $data[] = $record2;
 882               }
 883             }
 884           }
 885         }
 886
 887         $urlsInserted = array(); //urls of articles inserted
 888         foreach ($data as $record) {
 889           $url = trim( isset($record['article__url']) ? $record['article__url'] : (isset($record['url']) ? $record['url'] : '') );
 890           if ( $url and !in_array($url, $urlsInserted) ) {
 891             $title = (isset($record['title']) ? $record['title'] :  _('Untitled - Import - ').'</a> <a href="./?import">'._('click to finish import').'</a><a>');
 892             $body = (isset($record['content']) ? $record['content'] : '');
 893             $isRead = (isset($record['is_read']) ? intval($record['is_read']) : (isset($record['archive'])?intval($record['archive']):0));
 894             $isFavorite = (isset($record['is_fav']) ? intval($record['is_fav']) : (isset($record['favorite'])?intval($record['favorite']):0) );
 895             //insert new record
 896             $id = $this->store->add($url, $title, $body, $this->user->getId(), $isFavorite, $isRead);
 897             if ( $id ) {
 898               $urlsInserted[] = $url; //add
 899
 900               if ( isset($record['tags']) && trim($record['tags']) ) {
 901                 //@TODO: set tags
 902
 903               }
 904             }
 905           }
 906         }
 907
 908         $i = sizeof($urlsInserted);
 909         if ( $i > 0 ) {
 910           $this->messages->add('s', _('Articles inserted: ').$i._('. Please note, that some may be marked as "read".'));
 911         }
 912         Tools::logm('Import of articles finished: '.$i.' articles added (w/o content if not provided).');
 913       }
 914       //file parsing finished here
 915
 916       //now download article contents if any
 917
 918       //check if we need to download any content
 919       $recordsDownloadRequired = $this->store->retrieveUnfetchedEntriesCount($this->user->getId());
 920       if ( $recordsDownloadRequired == 0 ) {
 921         //nothing to download
 922         $this->messages->add('s', _('Import finished.'));
 923         Tools::logm('Import finished completely');
 924         Tools::redirect();
 925       }
 926       else {
 927         //if just inserted - don't download anything, download will start in next reload
 928         if ( !isset($_FILES['file']) ) {
 929           //download next batch
 930           Tools::logm('Fetching next batch of articles...');
 931           $items = $this->store->retrieveUnfetchedEntries($this->user->getId(), IMPORT_LIMIT);
 932
 933           $purifier = $this->getPurifier();
 934
 935           foreach ($items as $item) {
 936             $url = new Url(base64_encode($item['url']));
 937             Tools::logm('Fetching article '.$item['id']);
 938             $content = Tools::getPageContent($url);
 939
 940             $title = (($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled'));
 941             $body = (($content['rss']['channel']['item']['description'] != '') ? $content['rss']['channel']['item']['description'] : _('Undefined'));
 942
 943             //clean content to prevent xss attack
 944             $title = $purifier->purify($title);
 945             $body = $purifier->purify($body);
 946
 947             $this->store->updateContentAndTitle($item['id'], $title, $body, $this->user->getId());
 948             Tools::logm('Article '.$item['id'].' updated.');
 949           }
 950
 951         }
 952       }
 953
 954       return array('includeImport'=>true, 'import'=>array('recordsDownloadRequired'=>$recordsDownloadRequired, 'recordsUnderDownload'=> IMPORT_LIMIT, 'delay'=> IMPORT_DELAY * 1000) );
 955     }
 956
 957     /**
 958      * export poche entries in json
 959      * @return json all poche entries
 960      */
 961     public function export() {
 962       $filename = "wallabag-export-".$this->user->getId()."-".date("Y-m-d").".json";
 963       header('Content-Disposition: attachment; filename='.$filename);
 964
 965       $entries = $this->store->retrieveAll($this->user->getId());
 966       echo $this->tpl->render('export.twig', array(
 967           'export' => Tools::renderJson($entries),
 968       ));
 969       Tools::logm('export view');
 970     }
 971
 972     /**
 973      * Checks online the latest version of poche and cache it
 974      * @param  string $which 'prod' or 'dev'
 975      * @return string        latest $which version
 976      */
 977     private function getPocheVersion($which = 'prod') {
 978       $cache_file = CACHE . '/' . $which;
 979       $check_time = time();
 980
 981       # checks if the cached version file exists
 982       if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
 983          $version = file_get_contents($cache_file);
 984          $check_time = filemtime($cache_file);
 985       } else {
 986          $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
 987          file_put_contents($cache_file, $version, LOCK_EX);
 988       }
 989       return array($version, $check_time);
 990     }
 991
 992     public function generateToken()
 993     {
 994       if (ini_get('open_basedir') === '') {
 995         if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
 996           echo 'This is a server using Windows!';
 997           // alternative to /dev/urandom for Windows
 998           $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
 999         } else {
1000           $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1001         }
1002       }
1003       else {
1004         $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1005       }
1006
1007       $token = str_replace('+', '', $token);
1008       $this->store->updateUserConfig($this->user->getId(), 'token', $token);
1009       $currentConfig = $_SESSION['poche_user']->config;
1010       $currentConfig['token'] = $token;
1011       $_SESSION['poche_user']->setConfig($currentConfig);
1012       Tools::redirect();
1013     }
1014
1015     public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1016     {
1017         $allowed_types = array('home', 'fav', 'archive', 'tag');
1018         $config = $this->store->getConfigUser($user_id);
1019
1020         if ($config == null) {
1021             die(_('User with this id (' . $user_id . ') does not exist.'));
1022         }
1023
1024         if (!in_array($type, $allowed_types) ||
1025             $token != $config['token']) {
1026             die(_('Uh, there is a problem while generating feeds.'));
1027         }
1028         // Check the token
1029
1030         $feed = new FeedWriter(RSS2);
1031         $feed->setTitle('wallabag — ' . $type . ' feed');
1032         $feed->setLink(Tools::getPocheUrl());
1033         $feed->setChannelElement('pubDate', date(DATE_RSS , time()));
1034         $feed->setChannelElement('generator', 'wallabag');
1035         $feed->setDescription('wallabag ' . $type . ' elements');
1036
1037         if ($type == 'tag') {
1038             $entries = $this->store->retrieveEntriesByTag($tag_id, $user_id);
1039         }
1040         else {
1041             $entries = $this->store->getEntriesByView($type, $user_id);
1042         }
1043
1044         if (count($entries) > 0) {
1045             foreach ($entries as $entry) {
1046                 $newItem = $feed->createNewItem();
1047                 $newItem->setTitle($entry['title']);
1048                 $newItem->setSource(Tools::getPocheUrl() . '?view=view&amp;id=' . $entry['id']);
1049                 $newItem->setLink($entry['url']);
1050                 $newItem->setDate(time());
1051                 $newItem->setDescription($entry['content']);
1052                 $feed->addItem($newItem);
1053             }
1054         }
1055
1056         $feed->genarateFeed();
1057         exit;
1058     }
1059
1060     public function emptyCache() {
1061         $files = new RecursiveIteratorIterator(
1062             new RecursiveDirectoryIterator(CACHE, RecursiveDirectoryIterator::SKIP_DOTS),
1063             RecursiveIteratorIterator::CHILD_FIRST
1064         );
1065
1066         foreach ($files as $fileinfo) {
1067             $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
1068             $todo($fileinfo->getRealPath());
1069         }
1070
1071         Tools::logm('empty cache');
1072         $this->messages->add('s', _('Cache deleted.'));
1073         Tools::redirect();
1074     }
1075
1076     /**
1077      * return new purifier object with actual config
1078      */
1079     protected function getPurifier() {
1080       $config = HTMLPurifier_Config::createDefault();
1081       $config->set('Cache.SerializerPath', CACHE);
1082       $config->set('HTML.SafeIframe', true);
1083       $config->set('URI.SafeIframeRegexp', '%^(https?:)?//(www\.youtube(?:-nocookie)?\.com/embed/|player\.vimeo\.com/video/)%'); //allow YouTube and Vimeo$purifier = new HTMLPurifier($config);
1084
1085       return new HTMLPurifier($config);
1086     }
1087 }