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