inc/poche/Poche.class.php

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