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 $user;
  14     public $store;
  15     public $tpl;
  16     public $messages;
  17     public $pagination;
  18
  19     function __construct()
  20     {
  21         $this->initTpl();
  22         if (!$this->checkBeforeInstall()) {
  23             exit;
  24         }
  25         $this->store = new Database();
  26         $this->init();
  27         $this->messages = new Messages();
  28
  29         # installation
  30         if(!$this->store->isInstalled())
  31         {
  32             $this->install();
  33         }
  34     }
  35
  36     /**
  37      * all checks before installation.
  38      * @return boolean
  39      */
  40     private function checkBeforeInstall()
  41     {
  42         $msg = '';
  43         $allIsGood = TRUE;
  44
  45         if (!is_writable(CACHE)) {
  46             Tools::logm('you don\'t have write access on cache directory');
  47             die('You don\'t have write access on cache directory.');
  48         }
  49         else if (file_exists('./install/update.php') && !DEBUG_POCHE) {
  50             $msg = '<h1>setup</h1><p><strong>It\'s your first time here?</strong> Please copy /install/poche.sqlite in db folder. Then, delete install folder.<br /><strong>If you have already installed poche</strong>, an update is needed <a href="install/update.php">by clicking here</a>.</p>';
  51             $allIsGood = FALSE;
  52         }
  53         else if (file_exists('./install') && !DEBUG_POCHE) {
  54             $msg = '<h1>setup</h1><p><strong>If you want to update your poche</strong>, you just have to delete /install folder. <br /><strong>To install your poche with sqlite</strong>, copy /install/poche.sqlite in /db and delete the folder /install. you have to delete the /install folder before using poche.</p>';
  55             $allIsGood = FALSE;
  56         }
  57         else if (STORAGE == 'sqlite' && !is_writable(STORAGE_SQLITE)) {
  58             Tools::logm('you don\'t have write access on sqlite file');
  59             $msg = '<h1>error</h1><p>You don\'t have write access on sqlite file.</p>';
  60             $allIsGood = FALSE;
  61         }
  62
  63         if (!$allIsGood) {
  64             echo $this->tpl->render('error.twig', array(
  65                 'msg' => $msg
  66             ));
  67         }
  68
  69         return $allIsGood;
  70     }
  71
  72     private function initTpl()
  73     {
  74         # template engine
  75         $loader = new Twig_Loader_Filesystem(TPL);
  76         if (DEBUG_POCHE) {
  77             $twig_params = array();
  78         }
  79         else {
  80             $twig_params = array('cache' => CACHE);
  81         }
  82         $this->tpl = new Twig_Environment($loader, $twig_params);
  83         $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
  84         # filter to display domain name of an url
  85         $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
  86         $this->tpl->addFilter($filter);
  87
  88         # filter for reading time
  89         $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
  90         $this->tpl->addFilter($filter);
  91     }
  92
  93     private function init()
  94     {
  95         Tools::initPhp();
  96         Session::$sessionName = 'poche';
  97         Session::init();
  98
  99         if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
 100             $this->user = $_SESSION['poche_user'];
 101         }
 102         else {
 103             # fake user, just for install & login screens
 104             $this->user = new User();
 105             $this->user->setConfig($this->getDefaultConfig());
 106         }
 107
 108         # l10n
 109         $language = $this->user->getConfigValue('language');
 110         putenv('LC_ALL=' . $language);
 111         setlocale(LC_ALL, $language);
 112         bindtextdomain($language, LOCALE);
 113         textdomain($language);
 114
 115         # Pagination
 116         $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
 117     }
 118
 119     private function install()
 120     {
 121         Tools::logm('poche still not installed');
 122         echo $this->tpl->render('install.twig', array(
 123             'token' => Session::getToken()
 124         ));
 125         if (isset($_GET['install'])) {
 126             if (($_POST['password'] == $_POST['password_repeat'])
 127                 && $_POST['password'] != "" && $_POST['login'] != "") {
 128                 # let's rock, install poche baby !
 129                 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
 130                 {
 131                     Session::logout();
 132                     Tools::logm('poche is now installed');
 133                     Tools::redirect();
 134                 }
 135             }
 136             else {
 137                 Tools::logm('error during installation');
 138                 Tools::redirect();
 139             }
 140         }
 141         exit();
 142     }
 143
 144     public function getDefaultConfig()
 145     {
 146         return array(
 147             'pager' => PAGINATION,
 148             'language' => LANG,
 149             );
 150     }
 151
 152     /**
 153      * Call action (mark as fav, archive, delete, etc.)
 154      */
 155     public function action($action, Url $url, $id = 0, $import = FALSE)
 156     {
 157         switch ($action)
 158         {
 159             case 'add':
 160                 $content = $url->extract();
 161
 162                 if ($this->store->add($url->getUrl(), $content['title'], $content['body'], $this->user->getId())) {
 163                     Tools::logm('add link ' . $url->getUrl());
 164                     $sequence = '';
 165                     if (STORAGE == 'postgres') {
 166                         $sequence = 'entries_id_seq';
 167                     }
 168                     $last_id = $this->store->getLastId($sequence);
 169                     if (DOWNLOAD_PICTURES) {
 170                         $content = filtre_picture($content['body'], $url->getUrl(), $last_id);
 171                         Tools::logm('updating content article');
 172                         $this->store->updateContent($last_id, $content, $this->user->getId());
 173                     }
 174                     if (!$import) {
 175                         $this->messages->add('s', _('the link has been added successfully'));
 176                     }
 177                 }
 178                 else {
 179                     if (!$import) {
 180                         $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
 181                         Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
 182                     }
 183                 }
 184
 185                 if (!$import) {
 186                     Tools::redirect('?view=home');
 187                 }
 188                 break;
 189             case 'delete':
 190                 $msg = 'delete link #' . $id;
 191                 if ($this->store->deleteById($id, $this->user->getId())) {
 192                     if (DOWNLOAD_PICTURES) {
 193                         remove_directory(ABS_PATH . $id);
 194                     }
 195                     $this->messages->add('s', _('the link has been deleted successfully'));
 196                 }
 197                 else {
 198                     $this->messages->add('e', _('the link wasn\'t deleted'));
 199                     $msg = 'error : can\'t delete link #' . $id;
 200                 }
 201                 Tools::logm($msg);
 202                 Tools::redirect('?');
 203                 break;
 204             case 'toggle_fav' :
 205                 $this->store->favoriteById($id, $this->user->getId());
 206                 Tools::logm('mark as favorite link #' . $id);
 207                 if (!$import) {
 208                     Tools::redirect();
 209                 }
 210                 break;
 211             case 'toggle_archive' :
 212                 $this->store->archiveById($id, $this->user->getId());
 213                 Tools::logm('archive link #' . $id);
 214                 if (!$import) {
 215                     Tools::redirect();
 216                 }
 217                 break;
 218             default:
 219                 break;
 220         }
 221     }
 222
 223     function displayView($view, $id = 0)
 224     {
 225         $tpl_vars = array();
 226
 227         switch ($view)
 228         {
 229             case 'config':
 230                 $dev = $this->getPocheVersion('dev');
 231                 $prod = $this->getPocheVersion('prod');
 232                 $compare_dev = version_compare(POCHE_VERSION, $dev);
 233                 $compare_prod = version_compare(POCHE_VERSION, $prod);
 234                 $tpl_vars = array(
 235                     'dev' => $dev,
 236                     'prod' => $prod,
 237                     'compare_dev' => $compare_dev,
 238                     'compare_prod' => $compare_prod,
 239                 );
 240                 Tools::logm('config view');
 241                 break;
 242             case 'view':
 243                 $entry = $this->store->retrieveOneById($id, $this->user->getId());
 244                 if ($entry != NULL) {
 245                     Tools::logm('view link #' . $id);
 246                     $content = $entry['content'];
 247                     if (function_exists('tidy_parse_string')) {
 248                         $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
 249                         $tidy->cleanRepair();
 250                         $content = $tidy->value;
 251
 252                         # flattr checking
 253                         $flattr = new FlattrItem();
 254                         $flattr->checkItem($entry['url']);
 255
 256                         $tpl_vars = array(
 257                         'entry' => $entry,
 258                         'content' => $content,
 259                         'flattr' => $flattr
 260                         );
 261                     }
 262                 }
 263                 else {
 264                     Tools::logm('error in view call : entry is null');
 265                 }
 266                 break;
 267             default: # home, favorites and archive views
 268                 $entries = $this->store->getEntriesByView($view, $this->user->getId());
 269                 $tpl_vars = array(
 270                     'entries' => '',
 271                     'page_links' => '',
 272                     'nb_results' => '',
 273                 );
 274                 if (count($entries) > 0) {
 275                     $this->pagination->set_total(count($entries));
 276                     $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
 277                     $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
 278                     $tpl_vars['entries'] = $datas;
 279                     $tpl_vars['page_links'] = $page_links;
 280                     $tpl_vars['nb_results'] = count($entries);
 281                 }
 282                 Tools::logm('display ' . $view . ' view');
 283                 break;
 284         }
 285
 286         return $tpl_vars;
 287     }
 288
 289     /**
 290      * update the password of the current user.
 291      * if MODE_DEMO is TRUE, the password can't be updated.
 292      * @todo add the return value
 293      * @todo set the new password in function header like this updatePassword($newPassword)
 294      * @return boolean
 295      */
 296     public function updatePassword()
 297     {
 298         if (MODE_DEMO) {
 299             $this->messages->add('i', _('in demo mode, you can\'t update your password'));
 300             Tools::logm('in demo mode, you can\'t do this');
 301             Tools::redirect('?view=config');
 302         }
 303         else {
 304             if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
 305                 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
 306                     $this->messages->add('s', _('your password has been updated'));
 307                     $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
 308                     Session::logout();
 309                     Tools::logm('password updated');
 310                     Tools::redirect();
 311                 }
 312                 else {
 313                     $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
 314                     Tools::redirect('?view=config');
 315                 }
 316             }
 317         }
 318     }
 319
 320     /**
 321      * checks if login & password are correct and save the user in session.
 322      * it redirects the user to the $referer link
 323      * @param  string $referer the url to redirect after login
 324      * @todo add the return value
 325      * @return boolean
 326      */
 327     public function login($referer)
 328     {
 329         if (!empty($_POST['login']) && !empty($_POST['password'])) {
 330             $user = $this->store->login($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']));
 331             if ($user != array()) {
 332                 # Save login into Session
 333                 Session::login($user['username'], $user['password'], $_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']), array('poche_user' => new User($user)));
 334
 335                 $this->messages->add('s', _('welcome to your poche'));
 336                 if (!empty($_POST['longlastingsession'])) {
 337                     $_SESSION['longlastingsession'] = 31536000;
 338                     $_SESSION['expires_on'] = time() + $_SESSION['longlastingsession'];
 339                     session_set_cookie_params($_SESSION['longlastingsession']);
 340                 } else {
 341                     session_set_cookie_params(0);
 342                 }
 343                 session_regenerate_id(true);
 344                 Tools::logm('login successful');
 345                 Tools::redirect($referer);
 346             }
 347             $this->messages->add('e', _('login failed: bad login or password'));
 348             Tools::logm('login failed');
 349             Tools::redirect();
 350         } else {
 351             $this->messages->add('e', _('login failed: you have to fill all fields'));
 352             Tools::logm('login failed');
 353             Tools::redirect();
 354         }
 355     }
 356
 357     /**
 358      * log out the poche user. It cleans the session.
 359      * @todo add the return value
 360      * @return boolean
 361      */
 362     public function logout()
 363     {
 364         $this->user = array();
 365         Session::logout();
 366         $this->messages->add('s', _('see you soon!'));
 367         Tools::logm('logout');
 368         Tools::redirect();
 369     }
 370
 371     /**
 372      * import from Instapaper. poche needs a ./instapaper-export.html file
 373      * @todo add the return value
 374      * @param string $targetFile the file used for importing
 375      * @return boolean
 376      */
 377     private function importFromInstapaper($targetFile)
 378     {
 379         # TODO gestion des articles favs
 380         $html = new simple_html_dom();
 381         $html->load_file($targetFile);
 382         Tools::logm('starting import from instapaper');
 383
 384         $read = 0;
 385         $errors = array();
 386         foreach($html->find('ol') as $ul)
 387         {
 388             foreach($ul->find('li') as $li)
 389             {
 390                 $a = $li->find('a');
 391                 $url = new Url(base64_encode($a[0]->href));
 392                 $this->action('add', $url, 0, TRUE);
 393                 if ($read == '1') {
 394                     $sequence = '';
 395                     if (STORAGE == 'postgres') {
 396                         $sequence = 'entries_id_seq';
 397                     }
 398                     $last_id = $this->store->getLastId($sequence);
 399                     $this->action('toggle_archive', $url, $last_id, TRUE);
 400                 }
 401             }
 402
 403             # the second <ol> is for read links
 404             $read = 1;
 405         }
 406         $this->messages->add('s', _('import from instapaper completed'));
 407         Tools::logm('import from instapaper completed');
 408         Tools::redirect();
 409     }
 410
 411     /**
 412      * import from Pocket. poche needs a ./ril_export.html file
 413      * @todo add the return value
 414      * @param string $targetFile the file used for importing
 415      * @return boolean
 416      */
 417     private function importFromPocket($targetFile)
 418     {
 419         # TODO gestion des articles favs
 420         $html = new simple_html_dom();
 421         $html->load_file($targetFile);
 422         Tools::logm('starting import from pocket');
 423
 424         $read = 0;
 425         $errors = array();
 426         foreach($html->find('ul') as $ul)
 427         {
 428             foreach($ul->find('li') as $li)
 429             {
 430                 $a = $li->find('a');
 431                 $url = new Url(base64_encode($a[0]->href));
 432                 $this->action('add', $url, 0, TRUE);
 433                 if ($read == '1') {
 434                         $sequence = '';
 435                         if (STORAGE == 'postgres') {
 436                             $sequence = 'entries_id_seq';
 437                         }
 438                     $last_id = $this->store->getLastId($sequence);
 439                     $this->action('toggle_archive', $url, $last_id, TRUE);
 440                 }
 441             }
 442
 443             # the second <ul> is for read links
 444             $read = 1;
 445         }
 446         $this->messages->add('s', _('import from pocket completed'));
 447         Tools::logm('import from pocket completed');
 448         Tools::redirect();
 449     }
 450
 451     /**
 452      * import from Readability. poche needs a ./readability file
 453      * @todo add the return value
 454      * @param string $targetFile the file used for importing
 455      * @return boolean
 456      */
 457     private function importFromReadability($targetFile)
 458     {
 459         # TODO gestion des articles lus / favs
 460         $str_data = file_get_contents($targetFile);
 461         $data = json_decode($str_data,true);
 462         Tools::logm('starting import from Readability');
 463         $count = 0;
 464         foreach ($data as $key => $value) {
 465             $url = NULL;
 466             $favorite = FALSE;
 467             $archive = FALSE;
 468             foreach ($value as $attr => $attr_value) {
 469                 if ($attr == 'article__url') {
 470                     $url = new Url(base64_encode($attr_value));
 471                 }
 472                 $sequence = '';
 473                 if (STORAGE == 'postgres') {
 474                     $sequence = 'entries_id_seq';
 475                 }
 476                 if ($attr_value == 'true') {
 477                     if ($attr == 'favorite') {
 478                         $favorite = TRUE;
 479                     }
 480                     if ($attr == 'archive') {
 481                         $archive = TRUE;
 482                     }
 483                 }
 484             }
 485             # we can add the url
 486             if (!is_null($url) && $url->isCorrect()) {
 487                 $this->action('add', $url, 0, TRUE);
 488                 $count++;
 489                 if ($favorite) {
 490                     $last_id = $this->store->getLastId($sequence);
 491                     $this->action('toggle_fav', $url, $last_id, TRUE);
 492                 }
 493                 if ($archive) {
 494                     $last_id = $this->store->getLastId($sequence);
 495                     $this->action('toggle_archive', $url, $last_id, TRUE);
 496                 }
 497             }
 498         }
 499         $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.'));
 500         Tools::logm('import from Readability completed');
 501         Tools::redirect();
 502     }
 503
 504     /**
 505      * import datas into your poche
 506      * @param  string $from name of the service to import : pocket, instapaper or readability
 507      * @todo add the return value
 508      * @return boolean
 509      */
 510     public function import($from)
 511     {
 512         $providers = array(
 513             'pocket' => 'importFromPocket',
 514             'readability' => 'importFromReadability',
 515             'instapaper' => 'importFromInstapaper'
 516         );
 517
 518         if (! isset($providers[$from])) {
 519             $this->messages->add('e', _('Unknown import provider.'));
 520             Tools::redirect();
 521         }
 522
 523         $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
 524         $targetFile = constant($targetDefinition);
 525
 526         if (! defined($targetDefinition)) {
 527             $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
 528             Tools::redirect();
 529         }
 530
 531         if (! file_exists($targetFile)) {
 532             $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
 533             Tools::redirect();
 534         }
 535
 536         $this->$providers[$from]($targetFile);
 537     }
 538
 539     /**
 540      * export poche entries in json
 541      * @return json all poche entries
 542      */
 543     public function export()
 544     {
 545         $entries = $this->store->retrieveAll($this->user->getId());
 546         echo $this->tpl->render('export.twig', array(
 547             'export' => Tools::renderJson($entries),
 548         ));
 549         Tools::logm('export view');
 550     }
 551
 552     /**
 553      * Checks online the latest version of poche and cache it
 554      * @param  string $which 'prod' or 'dev'
 555      * @return string        latest $which version
 556      */
 557     private function getPocheVersion($which = 'prod')
 558     {
 559         $cache_file = CACHE . '/' . $which;
 560
 561         # checks if the cached version file exists
 562         if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
 563            $version = file_get_contents($cache_file);
 564         } else {
 565            $version = file_get_contents('http://static.inthepoche.com/versions/' . $which);
 566            file_put_contents($cache_file, $version, LOCK_EX);
 567         }
 568         return $version;
 569     }
 570 }