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     public function __construct()
  27     {
  28         if ($this->configFileIsAvailable()) {
  29             $this->init();
  30         }
  31
  32         if ($this->themeIsInstalled()) {
  33             $this->initTpl();
  34         }
  35
  36         if ($this->systemIsInstalled()) {
  37             $this->store = new Database();
  38             $this->messages = new Messages();
  39             # installation
  40             if (! $this->store->isInstalled()) {
  41                 $this->install();
  42             }
  43             $this->store->checkTags();
  44         }
  45     }
  46
  47     private function init()
  48     {
  49         Tools::initPhp();
  50         Session::$sessionName = 'poche';
  51         Session::init();
  52
  53         if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
  54             $this->user = $_SESSION['poche_user'];
  55         } else {
  56             # fake user, just for install & login screens
  57             $this->user = new User();
  58             $this->user->setConfig($this->getDefaultConfig());
  59         }
  60
  61         # l10n
  62         $language = $this->user->getConfigValue('language');
  63         putenv('LC_ALL=' . $language);
  64         setlocale(LC_ALL, $language);
  65         bindtextdomain($language, LOCALE);
  66         textdomain($language);
  67
  68         # Pagination
  69         $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
  70
  71         # Set up theme
  72         $themeDirectory = $this->user->getConfigValue('theme');
  73
  74         if ($themeDirectory === false) {
  75             $themeDirectory = DEFAULT_THEME;
  76         }
  77
  78         $this->currentTheme = $themeDirectory;
  79
  80         # Set up language
  81         $languageDirectory = $this->user->getConfigValue('language');
  82
  83         if ($languageDirectory === false) {
  84             $languageDirectory = DEFAULT_THEME;
  85         }
  86
  87         $this->currentLanguage = $languageDirectory;
  88     }
  89
  90     public function configFileIsAvailable() {
  91         if (! self::$configFileAvailable) {
  92             $this->notInstalledMessage[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
  93
  94             return false;
  95         }
  96
  97         return true;
  98     }
  99
 100     public function themeIsInstalled() {
 101         $passTheme = TRUE;
 102         # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
 103         if (! self::$canRenderTemplates) {
 104             $this->notInstalledMessage[] = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. Have a look at <a href="http://doc.wallabag.org/doku.php?id=users:begin:install">the documentation.</a>';
 105             $passTheme = FALSE;
 106         }
 107
 108         if (! is_writable(CACHE)) {
 109             $this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
 110
 111             self::$canRenderTemplates = false;
 112
 113             $passTheme = FALSE;
 114         }
 115
 116         # Check if the selected theme and its requirements are present
 117         $theme = $this->getTheme();
 118
 119         if ($theme != '' && ! is_dir(THEME . '/' . $theme)) {
 120             $this->notInstalledMessage[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $theme . ')';
 121
 122             self::$canRenderTemplates = false;
 123
 124             $passTheme = FALSE;
 125         }
 126
 127         $themeInfo = $this->getThemeInfo($theme);
 128         if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
 129             foreach ($themeInfo['requirements'] as $requiredTheme) {
 130                 if (! is_dir(THEME . '/' . $requiredTheme)) {
 131                     $this->notInstalledMessage[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
 132
 133                     self::$canRenderTemplates = false;
 134
 135                     $passTheme = FALSE;
 136                 }
 137             }
 138         }
 139
 140         if (!$passTheme) {
 141             return FALSE;
 142         }
 143
 144
 145         return true;
 146     }
 147
 148     /**
 149      * all checks before installation.
 150      * @todo move HTML to template
 151      * @return boolean
 152      */
 153     public function systemIsInstalled()
 154     {
 155         $msg = TRUE;
 156
 157         $configSalt = defined('SALT') ? constant('SALT') : '';
 158
 159         if (empty($configSalt)) {
 160             $this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
 161             $msg = FALSE;
 162         }
 163         if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
 164             Tools::logm('sqlite file doesn\'t exist');
 165             $this->notInstalledMessage[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
 166             $msg = FALSE;
 167         }
 168         if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
 169             $this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
 170             $msg = FALSE;
 171         }
 172         if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
 173             Tools::logm('you don\'t have write access on sqlite file');
 174             $this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
 175             $msg = FALSE;
 176         }
 177
 178         if (! $msg) {
 179             return false;
 180         }
 181
 182         return true;
 183     }
 184
 185     public function getNotInstalledMessage() {
 186         return $this->notInstalledMessage;
 187     }
 188
 189     private function initTpl()
 190     {
 191         $loaderChain = new Twig_Loader_Chain();
 192         $theme = $this->getTheme();
 193
 194         # add the current theme as first to the loader chain so Twig will look there first for overridden template files
 195         try {
 196             $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $theme));
 197         } catch (Twig_Error_Loader $e) {
 198             # @todo isInstalled() should catch this, inject Twig later
 199             die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME . '/' . $theme .' is missing)');
 200         }
 201
 202         # add all required themes to the loader chain
 203         $themeInfo = $this->getThemeInfo($theme);
 204         if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
 205             foreach ($themeInfo['requirements'] as $requiredTheme) {
 206                 try {
 207                     $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $requiredTheme));
 208                 } catch (Twig_Error_Loader $e) {
 209                     # @todo isInstalled() should catch this, inject Twig later
 210                     die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
 211                 }
 212             }
 213         }
 214
 215         if (DEBUG_POCHE) {
 216             $twigParams = array();
 217         } else {
 218             $twigParams = array('cache' => CACHE);
 219         }
 220
 221         $this->tpl = new Twig_Environment($loaderChain, $twigParams);
 222         $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
 223
 224         # filter to display domain name of an url
 225         $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
 226         $this->tpl->addFilter($filter);
 227
 228         # filter for reading time
 229         $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
 230         $this->tpl->addFilter($filter);
 231
 232         # filter for simple filenames in config view
 233         $filter = new Twig_SimpleFilter('getPrettyFilename', function($string) { return str_replace(ROOT, '', $string); });
 234         $this->tpl->addFilter($filter);
 235     }
 236
 237     private function install()
 238     {
 239         Tools::logm('poche still not installed');
 240         echo $this->tpl->render('install.twig', array(
 241             'token' => Session::getToken(),
 242             'theme' => $this->getTheme(),
 243             'poche_url' => Tools::getPocheUrl()
 244         ));
 245         if (isset($_GET['install'])) {
 246             if (($_POST['password'] == $_POST['password_repeat'])
 247                 && $_POST['password'] != "" && $_POST['login'] != "") {
 248                 # let's rock, install poche baby !
 249                 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
 250                 {
 251                     Session::logout();
 252                     Tools::logm('poche is now installed');
 253                     Tools::redirect();
 254                 }
 255             }
 256             else {
 257                 Tools::logm('error during installation');
 258                 Tools::redirect();
 259             }
 260         }
 261         exit();
 262     }
 263
 264     public function getTheme() {
 265         return $this->currentTheme;
 266     }
 267
 268     /**
 269      * Provides theme information by parsing theme.ini file if present in the theme's root directory.
 270      * In all cases, the following data will be returned:
 271      * - name: theme's name, or key if the theme is unnamed,
 272      * - current: boolean informing if the theme is the current user theme.
 273      *
 274      * @param string $theme Theme key (directory name)
 275      * @return array|boolean Theme information, or false if the theme doesn't exist.
 276      */
 277     public function getThemeInfo($theme) {
 278         if (!is_dir(THEME . '/' . $theme)) {
 279             return false;
 280         }
 281
 282         $themeIniFile = THEME . '/' . $theme . '/theme.ini';
 283         $themeInfo = array();
 284
 285         if (is_file($themeIniFile) && is_readable($themeIniFile)) {
 286             $themeInfo = parse_ini_file($themeIniFile);
 287         }
 288
 289         if ($themeInfo === false) {
 290             $themeInfo = array();
 291         }
 292         if (!isset($themeInfo['name'])) {
 293             $themeInfo['name'] = $theme;
 294         }
 295         $themeInfo['current'] = ($theme === $this->getTheme());
 296
 297         return $themeInfo;
 298     }
 299
 300     public function getInstalledThemes() {
 301         $handle = opendir(THEME);
 302         $themes = array();
 303
 304         while (($theme = readdir($handle)) !== false) {
 305             # Themes are stored in a directory, so all directory names are themes
 306             # @todo move theme installation data to database
 307             if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
 308                 continue;
 309             }
 310
 311             $themes[$theme] = $this->getThemeInfo($theme);
 312         }
 313
 314         return $themes;
 315     }
 316
 317     public function getLanguage() {
 318         return $this->currentLanguage;
 319     }
 320
 321     public function getInstalledLanguages() {
 322         $handle = opendir(LOCALE);
 323         $languages = array();
 324
 325         while (($language = readdir($handle)) !== false) {
 326             # Languages are stored in a directory, so all directory names are languages
 327             # @todo move language installation data to database
 328             if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.'))) {
 329                 continue;
 330             }
 331
 332             $current = false;
 333
 334             if ($language === $this->getLanguage()) {
 335                 $current = true;
 336             }
 337
 338             $languages[] = array('name' => $language, 'current' => $current);
 339         }
 340
 341         return $languages;
 342     }
 343
 344     public function getDefaultConfig()
 345     {
 346         return array(
 347             'pager' => PAGINATION,
 348             'language' => LANG,
 349             'theme' => DEFAULT_THEME
 350         );
 351     }
 352
 353     protected function getPageContent(Url $url)
 354     {
 355         $options = array('http' => array('user_agent' => 'poche'));
 356         if (isset($_SERVER['AUTH_TYPE']) && "basic" === strtolower($_SERVER['AUTH_TYPE'])) {
 357             $options['http']['header'] = sprintf(
 358                 "Authorization: Basic %s",
 359                 base64_encode(
 360                     sprintf('%s:%s', $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'])
 361                 )
 362             );
 363         }
 364         $context = stream_context_create($options);
 365         $json = file_get_contents(Tools::getPocheUrl() . '/inc/3rdparty/makefulltextfeed.php?url='.urlencode($url->getUrl()).'&max=5&links=preserve&exc=&format=json&submit=Create+Feed', false, $context);
 366         return json_decode($json, true);
 367     }
 368
 369     /**
 370      * Call action (mark as fav, archive, delete, etc.)
 371      */
 372     public function action($action, Url $url, $id = 0, $import = FALSE, $autoclose = FALSE)
 373     {
 374         switch ($action)
 375         {
 376             case 'add':
 377                 $content = $this->getPageContent($url);
 378                 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
 379                 $body = $content['rss']['channel']['item']['description'];
 380
 381                 if ($this->store->add($url->getUrl(), $title, $body, $this->user->getId())) {
 382                     Tools::logm('add link ' . $url->getUrl());
 383                     $sequence = '';
 384                     if (STORAGE == 'postgres') {
 385                         $sequence = 'entries_id_seq';
 386                     }
 387                     $last_id = $this->store->getLastId($sequence);
 388                     if (DOWNLOAD_PICTURES) {
 389                         $content = filtre_picture($body, $url->getUrl(), $last_id);
 390                         Tools::logm('updating content article');
 391                         $this->store->updateContent($last_id, $content, $this->user->getId());
 392                     }
 393                     if (!$import) {
 394                         $this->messages->add('s', _('the link has been added successfully'));
 395                     }
 396                 }
 397                 else {
 398                     if (!$import) {
 399                         $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
 400                         Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
 401                     }
 402                 }
 403
 404                 if (!$import) {
 405                     if ($autoclose == TRUE) {
 406                       Tools::redirect('?view=home');
 407                     } else {
 408                       Tools::redirect('?view=home&closewin=true');
 409                     }
 410                 }
 411                 break;
 412             case 'delete':
 413                 $msg = 'delete link #' . $id;
 414                 if ($this->store->deleteById($id, $this->user->getId())) {
 415                     if (DOWNLOAD_PICTURES) {
 416                         remove_directory(ABS_PATH . $id);
 417                     }
 418                     $this->messages->add('s', _('the link has been deleted successfully'));
 419                 }
 420                 else {
 421                     $this->messages->add('e', _('the link wasn\'t deleted'));
 422                     $msg = 'error : can\'t delete link #' . $id;
 423                 }
 424                 Tools::logm($msg);
 425                 Tools::redirect('?');
 426                 break;
 427             case 'toggle_fav' :
 428                 $this->store->favoriteById($id, $this->user->getId());
 429                 Tools::logm('mark as favorite link #' . $id);
 430                 if (!$import) {
 431                     Tools::redirect();
 432                 }
 433                 break;
 434             case 'toggle_archive' :
 435                 $this->store->archiveById($id, $this->user->getId());
 436                 Tools::logm('archive link #' . $id);
 437                 if (!$import) {
 438                     Tools::redirect();
 439                 }
 440                 break;
 441             case 'add_tag' :
 442                 $tags = explode(',', $_POST['value']);
 443                 $entry_id = $_POST['entry_id'];
 444                 foreach($tags as $key => $tag_value) {
 445                     $value = trim($tag_value);
 446                     $tag = $this->store->retrieveTagByValue($value);
 447
 448                     if (is_null($tag)) {
 449                         # we create the tag
 450                         $tag = $this->store->createTag($value);
 451                         $sequence = '';
 452                         if (STORAGE == 'postgres') {
 453                             $sequence = 'tags_id_seq';
 454                         }
 455                         $tag_id = $this->store->getLastId($sequence);
 456                     }
 457                     else {
 458                         $tag_id = $tag['id'];
 459                     }
 460
 461                     # we assign the tag to the article
 462                     $this->store->setTagToEntry($tag_id, $entry_id);
 463                 }
 464                 Tools::redirect();
 465                 break;
 466             case 'remove_tag' :
 467                 $tag_id = $_GET['tag_id'];
 468                 $this->store->removeTagForEntry($id, $tag_id);
 469                 Tools::redirect();
 470                 break;
 471             default:
 472                 break;
 473         }
 474     }
 475
 476     function displayView($view, $id = 0)
 477     {
 478         $tpl_vars = array();
 479
 480         switch ($view)
 481         {
 482             case 'config':
 483                 $dev = $this->getPocheVersion('dev');
 484                 $prod = $this->getPocheVersion('prod');
 485                 $compare_dev = version_compare(POCHE, $dev);
 486                 $compare_prod = version_compare(POCHE, $prod);
 487                 $themes = $this->getInstalledThemes();
 488                 $languages = $this->getInstalledLanguages();
 489                 $token = $this->user->getConfigValue('token');
 490                 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
 491                 $tpl_vars = array(
 492                     'themes' => $themes,
 493                     'languages' => $languages,
 494                     'dev' => $dev,
 495                     'prod' => $prod,
 496                     'compare_dev' => $compare_dev,
 497                     'compare_prod' => $compare_prod,
 498                     'token' => $token,
 499                     'user_id' => $this->user->getId(),
 500                     'http_auth' => $http_auth,
 501                 );
 502                 Tools::logm('config view');
 503                 break;
 504             case 'edit-tags':
 505                 # tags
 506                 $tags = $this->store->retrieveTagsByEntry($id);
 507                 $tpl_vars = array(
 508                     'entry_id' => $id,
 509                     'tags' => $tags,
 510                 );
 511                 break;
 512             case 'tag':
 513                 $entries = $this->store->retrieveEntriesByTag($id);
 514                 $tag = $this->store->retrieveTag($id);
 515                 $tpl_vars = array(
 516                     'tag' => $tag,
 517                     'entries' => $entries,
 518                 );
 519                 break;
 520             case 'tags':
 521                 $token = $this->user->getConfigValue('token');
 522                 $tags = $this->store->retrieveAllTags();
 523                 $tpl_vars = array(
 524                     'token' => $token,
 525                     'user_id' => $this->user->getId(),
 526                     'tags' => $tags,
 527                 );
 528                 break;
 529             case 'view':
 530                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 531                 if ($entry != NULL) {
 532                     Tools::logm('view link #' . $id);
 533                     $content = $entry['content'];
 534                     if (function_exists('tidy_parse_string')) {
 535                         $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
 536                         $tidy->cleanRepair();
 537                         $content = $tidy->value;
 538                     }
 539
 540                     # flattr checking
 541                     $flattr = new FlattrItem();
 542                     $flattr->checkItem($entry['url'], $entry['id']);
 543
 544                     # tags
 545                     $tags = $this->store->retrieveTagsByEntry($entry['id']);
 546
 547                     $tpl_vars = array(
 548                         'entry' => $entry,
 549                         'content' => $content,
 550                         'flattr' => $flattr,
 551                         'tags' => $tags
 552                     );
 553                 }
 554                 else {
 555                     Tools::logm('error in view call : entry is null');
 556                 }
 557                 break;
 558             default: # home, favorites and archive views
 559                 $entries = $this->store->getEntriesByView($view, $this->user->getId());
 560                 $tpl_vars = array(
 561                     'entries' => '',
 562                     'page_links' => '',
 563                     'nb_results' => '',
 564                 );
 565
 566                 if (count($entries) > 0) {
 567                     $this->pagination->set_total(count($entries));
 568                     $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
 569                         $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&'));
 570                     $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
 571                     $tpl_vars['entries'] = $datas;
 572                     $tpl_vars['page_links'] = $page_links;
 573                     $tpl_vars['nb_results'] = count($entries);
 574                 }
 575                 Tools::logm('display ' . $view . ' view');
 576                 break;
 577         }
 578
 579         return $tpl_vars;
 580     }
 581
 582     /**
 583      * update the password of the current user.
 584      * if MODE_DEMO is TRUE, the password can't be updated.
 585      * @todo add the return value
 586      * @todo set the new password in function header like this updatePassword($newPassword)
 587      * @return boolean
 588      */
 589     public function updatePassword()
 590     {
 591         if (MODE_DEMO) {
 592             $this->messages->add('i', _('in demo mode, you can\'t update your password'));
 593             Tools::logm('in demo mode, you can\'t do this');
 594             Tools::redirect('?view=config');
 595         }
 596         else {
 597             if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
 598                 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
 599                     $this->messages->add('s', _('your password has been updated'));
 600                     $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
 601                     Session::logout();
 602                     Tools::logm('password updated');
 603                     Tools::redirect();
 604                 }
 605                 else {
 606                     $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
 607                     Tools::redirect('?view=config');
 608                 }
 609             }
 610         }
 611     }
 612
 613     public function updateTheme()
 614     {
 615         # no data
 616         if (empty($_POST['theme'])) {
 617         }
 618
 619         # we are not going to change it to the current theme...
 620         if ($_POST['theme'] == $this->getTheme()) {
 621             $this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
 622             Tools::redirect('?view=config');
 623         }
 624
 625         $themes = $this->getInstalledThemes();
 626         $actualTheme = false;
 627
 628         foreach (array_keys($themes) as $theme) {
 629             if ($theme == $_POST['theme']) {
 630                 $actualTheme = true;
 631                 break;
 632             }
 633         }
 634
 635         if (! $actualTheme) {
 636             $this->messages->add('e', _('that theme does not seem to be installed'));
 637             Tools::redirect('?view=config');
 638         }
 639
 640         $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
 641         $this->messages->add('s', _('you have changed your theme preferences'));
 642
 643         $currentConfig = $_SESSION['poche_user']->config;
 644         $currentConfig['theme'] = $_POST['theme'];
 645
 646         $_SESSION['poche_user']->setConfig($currentConfig);
 647
 648         Tools::redirect('?view=config');
 649     }
 650
 651     public function updateLanguage()
 652     {
 653         # no data
 654         if (empty($_POST['language'])) {
 655         }
 656
 657         # we are not going to change it to the current language...
 658         if ($_POST['language'] == $this->getLanguage()) {
 659             $this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
 660             Tools::redirect('?view=config');
 661         }
 662
 663         $languages = $this->getInstalledLanguages();
 664         $actualLanguage = false;
 665
 666         foreach ($languages as $language) {
 667             if ($language['name'] == $_POST['language']) {
 668                 $actualLanguage = true;
 669                 break;
 670             }
 671         }
 672
 673         if (! $actualLanguage) {
 674             $this->messages->add('e', _('that language does not seem to be installed'));
 675             Tools::redirect('?view=config');
 676         }
 677
 678         $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
 679         $this->messages->add('s', _('you have changed your language preferences'));
 680
 681         $currentConfig = $_SESSION['poche_user']->config;
 682         $currentConfig['language'] = $_POST['language'];
 683
 684         $_SESSION['poche_user']->setConfig($currentConfig);
 685
 686         Tools::redirect('?view=config');
 687     }
 688
 689     /**
 690      * get credentials from differents sources
 691      * it redirects the user to the $referer link
 692      * @return array
 693      */
 694     private function credentials() {
 695         if(isset($_SERVER['PHP_AUTH_USER'])) {
 696             return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
 697         }
 698         if(!empty($_POST['login']) && !empty($_POST['password'])) {
 699             return array($_POST['login'],$_POST['password'],false);
 700         }
 701         if(isset($_SERVER['REMOTE_USER'])) {
 702             return array($_SERVER['REMOTE_USER'],'http_auth',true);
 703         }
 704
 705         return array(false,false,false);
 706     }
 707
 708     /**
 709      * checks if login & password are correct and save the user in session.
 710      * it redirects the user to the $referer link
 711      * @param  string $referer the url to redirect after login
 712      * @todo add the return value
 713      * @return boolean
 714      */
 715     public function login($referer)
 716     {
 717         list($login,$password,$isauthenticated)=$this->credentials();
 718         if($login === false || $password === false) {
 719             $this->messages->add('e', _('login failed: you have to fill all fields'));
 720             Tools::logm('login failed');
 721             Tools::redirect();
 722         }
 723         if (!empty($login) && !empty($password)) {
 724             $user = $this->store->login($login, Tools::encodeString($password . $login), $isauthenticated);
 725             if ($user != array()) {
 726                 # Save login into Session
 727                 $longlastingsession = isset($_POST['longlastingsession']);
 728                 $passwordTest = ($isauthenticated) ? $user['password'] : Tools::encodeString($password . $login);
 729                 Session::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
 730                 $this->messages->add('s', _('welcome to your poche'));
 731                 Tools::logm('login successful');
 732                 Tools::redirect($referer);
 733             }
 734             $this->messages->add('e', _('login failed: bad login or password'));
 735             Tools::logm('login failed');
 736             Tools::redirect();
 737         }
 738     }
 739
 740     /**
 741      * log out the poche user. It cleans the session.
 742      * @todo add the return value
 743      * @return boolean
 744      */
 745     public function logout()
 746     {
 747         $this->user = array();
 748         Session::logout();
 749         $this->messages->add('s', _('see you soon!'));
 750         Tools::logm('logout');
 751         Tools::redirect();
 752     }
 753
 754     /**
 755      * import from Instapaper. poche needs a ./instapaper-export.html file
 756      * @todo add the return value
 757      * @param string $targetFile the file used for importing
 758      * @return boolean
 759      */
 760     private function importFromInstapaper($targetFile)
 761     {
 762         # TODO gestion des articles favs
 763         $html = new simple_html_dom();
 764         $html->load_file($targetFile);
 765         Tools::logm('starting import from instapaper');
 766
 767         $read = 0;
 768         $errors = array();
 769         foreach($html->find('ol') as $ul)
 770         {
 771             foreach($ul->find('li') as $li)
 772             {
 773                 $a = $li->find('a');
 774                 $url = new Url(base64_encode($a[0]->href));
 775                 $this->action('add', $url, 0, TRUE);
 776                 if ($read == '1') {
 777                     $sequence = '';
 778                     if (STORAGE == 'postgres') {
 779                         $sequence = 'entries_id_seq';
 780                     }
 781                     $last_id = $this->store->getLastId($sequence);
 782                     $this->action('toggle_archive', $url, $last_id, TRUE);
 783                 }
 784             }
 785
 786             # the second <ol> is for read links
 787             $read = 1;
 788         }
 789         $this->messages->add('s', _('import from instapaper completed'));
 790         Tools::logm('import from instapaper completed');
 791         Tools::redirect();
 792     }
 793
 794     /**
 795      * import from Pocket. poche needs a ./ril_export.html file
 796      * @todo add the return value
 797      * @param string $targetFile the file used for importing
 798      * @return boolean
 799      */
 800     private function importFromPocket($targetFile)
 801     {
 802         # TODO gestion des articles favs
 803         $html = new simple_html_dom();
 804         $html->load_file($targetFile);
 805         Tools::logm('starting import from pocket');
 806
 807         $read = 0;
 808         $errors = array();
 809         foreach($html->find('ul') as $ul)
 810         {
 811             foreach($ul->find('li') as $li)
 812             {
 813                 $a = $li->find('a');
 814                 $url = new Url(base64_encode($a[0]->href));
 815                 $this->action('add', $url, 0, TRUE);
 816                 if ($read == '1') {
 817                         $sequence = '';
 818                         if (STORAGE == 'postgres') {
 819                             $sequence = 'entries_id_seq';
 820                         }
 821                     $last_id = $this->store->getLastId($sequence);
 822                     $this->action('toggle_archive', $url, $last_id, TRUE);
 823                 }
 824             }
 825
 826             # the second <ul> is for read links
 827             $read = 1;
 828         }
 829         $this->messages->add('s', _('import from pocket completed'));
 830         Tools::logm('import from pocket completed');
 831         Tools::redirect();
 832     }
 833
 834     /**
 835      * import from Readability. poche needs a ./readability file
 836      * @todo add the return value
 837      * @param string $targetFile the file used for importing
 838      * @return boolean
 839      */
 840     private function importFromReadability($targetFile)
 841     {
 842         # TODO gestion des articles lus / favs
 843         $str_data = file_get_contents($targetFile);
 844         $data = json_decode($str_data,true);
 845         Tools::logm('starting import from Readability');
 846         $count = 0;
 847         foreach ($data as $key => $value) {
 848             $url = NULL;
 849             $favorite = FALSE;
 850             $archive = FALSE;
 851             foreach ($value as $item) {
 852                 foreach ($item as $attr => $value) {
 853                     if ($attr == 'article__url') {
 854                         $url = new Url(base64_encode($value));
 855                     }
 856                     $sequence = '';
 857                     if (STORAGE == 'postgres') {
 858                         $sequence = 'entries_id_seq';
 859                     }
 860                     if ($value == 'true') {
 861                         if ($attr == 'favorite') {
 862                             $favorite = TRUE;
 863                         }
 864                         if ($attr == 'archive') {
 865                             $archive = TRUE;
 866                         }
 867                     }
 868                 }
 869
 870                 # we can add the url
 871                 if (!is_null($url) && $url->isCorrect()) {
 872                     $this->action('add', $url, 0, TRUE);
 873                     $count++;
 874                     if ($favorite) {
 875                         $last_id = $this->store->getLastId($sequence);
 876                         $this->action('toggle_fav', $url, $last_id, TRUE);
 877                     }
 878                     if ($archive) {
 879                         $last_id = $this->store->getLastId($sequence);
 880                         $this->action('toggle_archive', $url, $last_id, TRUE);
 881                     }
 882                 }
 883             }
 884         }
 885         $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.'));
 886         Tools::logm('import from Readability completed');
 887         Tools::redirect();
 888     }
 889
 890     /**
 891      * import from Poche exported file
 892      * @param string $targetFile the file used for importing
 893      * @return boolean
 894      */
 895     private function importFromPoche($targetFile)
 896     {
 897         $str_data = file_get_contents($targetFile);
 898         $data = json_decode($str_data,true);
 899         Tools::logm('starting import from Poche');
 900
 901
 902         $sequence = '';
 903         if (STORAGE == 'postgres') {
 904             $sequence = 'entries_id_seq';
 905         }
 906
 907         $count = 0;
 908         foreach ($data as $value) {
 909
 910             $url = new Url(base64_encode($value['url']));
 911             $favorite = ($value['is_fav'] == -1);
 912             $archive = ($value['is_read'] == -1);
 913
 914             # we can add the url
 915             if (!is_null($url) && $url->isCorrect()) {
 916
 917                 $this->action('add', $url, 0, TRUE);
 918
 919                 $count++;
 920                 if ($favorite) {
 921                     $last_id = $this->store->getLastId($sequence);
 922                     $this->action('toggle_fav', $url, $last_id, TRUE);
 923                 }
 924                 if ($archive) {
 925                     $last_id = $this->store->getLastId($sequence);
 926                     $this->action('toggle_archive', $url, $last_id, TRUE);
 927                 }
 928             }
 929
 930         }
 931         $this->messages->add('s', _('import from Poche completed. ' . $count . ' new links.'));
 932         Tools::logm('import from Poche completed');
 933         Tools::redirect();
 934     }
 935
 936     /**
 937      * import datas into your poche
 938      * @param  string $from name of the service to import : pocket, instapaper or readability
 939      * @todo add the return value
 940      * @return boolean
 941      */
 942     public function import($from)
 943     {
 944         $providers = array(
 945             'pocket' => 'importFromPocket',
 946             'readability' => 'importFromReadability',
 947             'instapaper' => 'importFromInstapaper',
 948             'poche' => 'importFromPoche',
 949         );
 950
 951         if (! isset($providers[$from])) {
 952             $this->messages->add('e', _('Unknown import provider.'));
 953             Tools::redirect();
 954         }
 955
 956         $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
 957         $targetFile = constant($targetDefinition);
 958
 959         if (! defined($targetDefinition)) {
 960             $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
 961             Tools::redirect();
 962         }
 963
 964         if (! file_exists($targetFile)) {
 965             $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
 966             Tools::redirect();
 967         }
 968
 969         $this->$providers[$from]($targetFile);
 970     }
 971
 972     /**
 973      * export poche entries in json
 974      * @return json all poche entries
 975      */
 976     public function export()
 977     {
 978         $entries = $this->store->retrieveAll($this->user->getId());
 979         echo $this->tpl->render('export.twig', array(
 980             'export' => Tools::renderJson($entries),
 981         ));
 982         Tools::logm('export view');
 983     }
 984
 985     /**
 986      * Checks online the latest version of poche and cache it
 987      * @param  string $which 'prod' or 'dev'
 988      * @return string        latest $which version
 989      */
 990     private function getPocheVersion($which = 'prod')
 991     {
 992         $cache_file = CACHE . '/' . $which;
 993
 994         # checks if the cached version file exists
 995         if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
 996            $version = file_get_contents($cache_file);
 997         } else {
 998            $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
 999            file_put_contents($cache_file, $version, LOCK_EX);
1000         }
1001         return $version;
1002     }
1003
1004     public function generateToken()
1005     {
1006         if (ini_get('open_basedir') === '') {
1007             $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1008         }
1009         else {
1010             $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1011         }
1012
1013         $this->store->updateUserConfig($this->user->getId(), 'token', $token);
1014         $currentConfig = $_SESSION['poche_user']->config;
1015         $currentConfig['token'] = $token;
1016         $_SESSION['poche_user']->setConfig($currentConfig);
1017     }
1018
1019     public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1020     {
1021         $allowed_types = array('home', 'fav', 'archive', 'tag');
1022         $config = $this->store->getConfigUser($user_id);
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('poche - ' . $type . ' feed');
1032         $feed->setLink(Tools::getPocheUrl());
1033         $feed->setChannelElement('updated', date(DATE_RSS , time()));
1034         $feed->setChannelElement('author', 'poche');
1035
1036         if ($type == 'tag') {
1037             $entries = $this->store->retrieveEntriesByTag($tag_id);
1038         }
1039         else {
1040             $entries = $this->store->getEntriesByView($type, $user_id);
1041         }
1042
1043         if (count($entries) > 0) {
1044             foreach ($entries as $entry) {
1045                 $newItem = $feed->createNewItem();
1046                 $newItem->setTitle($entry['title']);
1047                 $newItem->setLink(Tools::getPocheUrl() . '?view=view&amp;id=' . $entry['id']);
1048                 $newItem->setDate(time());
1049                 $newItem->setDescription($entry['content']);
1050                 $feed->addItem($newItem);
1051             }
1052         }
1053
1054         $feed->genarateFeed();
1055         exit;
1056     }
1057 }