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