3 * wallabag, self hostable application allowing you to not miss any content anymore
6 * @author Nicolas Lœuillet <nicolas@loeuillet.org>
8 * @license http://www.wtfpl.net/ see COPYING file
13 public static $canRenderTemplates = true;
14 public static $configFileAvailable = true;
22 private $currentTheme = '';
23 private $currentLanguage = '';
24 private $notInstalledMessage = array();
26 private $language_names = array(
27 'cs_CZ.utf8' => 'čeština',
28 'de_DE.utf8' => 'German',
29 'en_EN.utf8' => 'English',
30 'es_ES.utf8' => 'Español',
31 'fa_IR.utf8' => 'فارسی',
32 'fr_FR.utf8' => 'Français',
33 'it_IT.utf8' => 'Italiano',
34 'pl_PL.utf8' => 'Polski',
35 'ru_RU.utf8' => 'Pусский',
36 'sl_SI.utf8' => 'Slovenščina',
37 'uk_UA.utf8' => 'Українська',
38 'pt_BR.utf8' => 'Brasileiro',
40 public function __construct()
42 if ($this->configFileIsAvailable()) {
46 if ($this->themeIsInstalled()) {
50 if ($this->systemIsInstalled()) {
51 $this->store
= new Database();
52 $this->messages
= new Messages();
54 if (! $this->store
->isInstalled()) {
57 $this->store
->checkTags();
61 private function init()
64 Session
::$sessionName = 'poche';
67 if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
68 $this->user
= $_SESSION['poche_user'];
70 # fake user, just for install & login screens
71 $this->user
= new User();
72 $this->user
->setConfig($this->getDefaultConfig());
76 $language = $this->user
->getConfigValue('language');
77 putenv('LC_ALL=' . $language);
78 setlocale(LC_ALL
, $language);
79 bindtextdomain($language, LOCALE
);
80 textdomain($language);
83 $this->pagination
= new Paginator($this->user
->getConfigValue('pager'), 'p');
86 $themeDirectory = $this->user
->getConfigValue('theme');
88 if ($themeDirectory === false) {
89 $themeDirectory = DEFAULT_THEME
;
92 $this->currentTheme
= $themeDirectory;
95 $languageDirectory = $this->user
->getConfigValue('language');
97 if ($languageDirectory === false) {
98 $languageDirectory = DEFAULT_THEME
;
101 $this->currentLanguage
= $languageDirectory;
104 public function configFileIsAvailable() {
105 if (! self
::$configFileAvailable) {
106 $this->notInstalledMessage
[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
114 public function themeIsInstalled() {
116 # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
117 if (! self
::$canRenderTemplates) {
118 $this->notInstalledMessage
[] = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. You can also download <a href="http://wllbg.org/vendor">vendor.zip</a> and extract it in your wallabag folder.';
122 if (! is_writable(CACHE
)) {
123 $this->notInstalledMessage
[] = 'You don\'t have write access on cache directory.';
125 self
::$canRenderTemplates = false;
130 # Check if the selected theme and its requirements are present
131 $theme = $this->getTheme();
133 if ($theme != '' && ! is_dir(THEME
. '/' . $theme)) {
134 $this->notInstalledMessage
[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME
. '/' . $theme . ')';
136 self
::$canRenderTemplates = false;
141 $themeInfo = $this->getThemeInfo($theme);
142 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
143 foreach ($themeInfo['requirements'] as $requiredTheme) {
144 if (! is_dir(THEME
. '/' . $requiredTheme)) {
145 $this->notInstalledMessage
[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
147 self
::$canRenderTemplates = false;
163 * all checks before installation.
164 * @todo move HTML to template
167 public function systemIsInstalled()
171 $configSalt = defined('SALT') ? constant('SALT') : '';
173 if (empty($configSalt)) {
174 $this->notInstalledMessage
[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
177 if (STORAGE
== 'sqlite' && ! file_exists(STORAGE_SQLITE
)) {
178 Tools
::logm('sqlite file doesn\'t exist');
179 $this->notInstalledMessage
[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
182 if (is_dir(ROOT
. '/install') && ! DEBUG_POCHE
) {
183 $this->notInstalledMessage
[] = 'you have to delete the /install folder before using poche.';
186 if (STORAGE
== 'sqlite' && ! is_writable(STORAGE_SQLITE
)) {
187 Tools
::logm('you don\'t have write access on sqlite file');
188 $this->notInstalledMessage
[] = 'You don\'t have write access on sqlite file.';
199 public function getNotInstalledMessage() {
200 return $this->notInstalledMessage
;
203 private function initTpl()
205 $loaderChain = new Twig_Loader_Chain();
206 $theme = $this->getTheme();
208 # add the current theme as first to the loader chain so Twig will look there first for overridden template files
210 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $theme));
211 } catch (Twig_Error_Loader
$e) {
212 # @todo isInstalled() should catch this, inject Twig later
213 die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME
. '/' . $theme .' is missing)');
216 # add all required themes to the loader chain
217 $themeInfo = $this->getThemeInfo($theme);
218 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
219 foreach ($themeInfo['requirements'] as $requiredTheme) {
221 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $requiredTheme));
222 } catch (Twig_Error_Loader
$e) {
223 # @todo isInstalled() should catch this, inject Twig later
224 die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
230 $twigParams = array();
232 $twigParams = array('cache' => CACHE
);
235 $this->tpl
= new Twig_Environment($loaderChain, $twigParams);
236 $this->tpl
->addExtension(new Twig_Extensions_Extension_I18n());
238 # filter to display domain name of an url
239 $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
240 $this->tpl
->addFilter($filter);
242 # filter for reading time
243 $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
244 $this->tpl
->addFilter($filter);
247 private function install()
249 Tools
::logm('poche still not installed');
250 echo $this->tpl
->render('install.twig', array(
251 'token' => Session
::getToken(),
252 'theme' => $this->getTheme(),
253 'poche_url' => Tools
::getPocheUrl()
255 if (isset($_GET['install'])) {
256 if (($_POST['password'] == $_POST['password_repeat'])
257 && $_POST['password'] != "" && $_POST['login'] != "") {
258 # let's rock, install poche baby !
259 if ($this->store
->install($_POST['login'], Tools
::encodeString($_POST['password'] . $_POST['login'])))
262 Tools
::logm('poche is now installed');
267 Tools
::logm('error during installation');
274 public function getTheme() {
275 return $this->currentTheme
;
279 * Provides theme information by parsing theme.ini file if present in the theme's root directory.
280 * In all cases, the following data will be returned:
281 * - name: theme's name, or key if the theme is unnamed,
282 * - current: boolean informing if the theme is the current user theme.
284 * @param string $theme Theme key (directory name)
285 * @return array|boolean Theme information, or false if the theme doesn't exist.
287 public function getThemeInfo($theme) {
288 if (!is_dir(THEME
. '/' . $theme)) {
292 $themeIniFile = THEME
. '/' . $theme . '/theme.ini';
293 $themeInfo = array();
295 if (is_file($themeIniFile) && is_readable($themeIniFile)) {
296 $themeInfo = parse_ini_file($themeIniFile);
299 if ($themeInfo === false) {
300 $themeInfo = array();
302 if (!isset($themeInfo['name'])) {
303 $themeInfo['name'] = $theme;
305 $themeInfo['current'] = ($theme === $this->getTheme());
310 public function getInstalledThemes() {
311 $handle = opendir(THEME
);
314 while (($theme = readdir($handle)) !== false) {
315 # Themes are stored in a directory, so all directory names are themes
316 # @todo move theme installation data to database
317 if (!is_dir(THEME
. '/' . $theme) || in_array($theme, array('.', '..'))) {
321 $themes[$theme] = $this->getThemeInfo($theme);
329 public function getLanguage() {
330 return $this->currentLanguage
;
333 public function getInstalledLanguages() {
334 $handle = opendir(LOCALE
);
335 $languages = array();
337 while (($language = readdir($handle)) !== false) {
338 # Languages are stored in a directory, so all directory names are languages
339 # @todo move language installation data to database
340 if (! is_dir(LOCALE
. '/' . $language) || in_array($language, array('..', '.', 'tools'))) {
346 if ($language === $this->getLanguage()) {
350 $languages[] = array('name' => (isset($this->language_names
[$language]) ? $this->language_names
[$language] : $language), 'value' => $language, 'current' => $current);
356 public function getDefaultConfig()
359 'pager' => PAGINATION
,
361 'theme' => DEFAULT_THEME
365 protected function getPageContent(Url
$url)
367 // Saving and clearing context
369 foreach( $GLOBALS as $key => $value ) {
370 if( $key != 'GLOBALS' && $key != '_SESSION' && $key != 'HTTP_SESSION_VARS' ) {
371 $GLOBALS[$key] = array();
372 $REAL[$key] = $value;
375 // Saving and clearing session
376 $REAL_SESSION = array();
377 foreach( $_SESSION as $key => $value ) {
378 $REAL_SESSION[$key] = $value;
379 unset($_SESSION[$key]);
382 // Running code in different context
383 $scope = function() {
384 extract( func_get_arg(1) );
385 $_GET = $_REQUEST = array(
386 "url" => $url->getUrl(),
388 "links" => "preserve",
391 "submit" => "Create Feed"
394 require func_get_arg(0);
395 $json = ob_get_flush();
398 $json = $scope( "inc/3rdparty/makefulltextfeed.php", array("url" => $url) );
400 // Clearing and restoring context
401 foreach( $GLOBALS as $key => $value ) {
402 if( $key != "GLOBALS" && $key != "_SESSION" ) {
403 unset($GLOBALS[$key]);
406 foreach( $REAL as $key => $value ) {
407 $GLOBALS[$key] = $value;
409 // Clearing and restoring session
410 foreach( $_SESSION as $key => $value ) {
411 unset($_SESSION[$key]);
413 foreach( $REAL_SESSION as $key => $value ) {
414 $_SESSION[$key] = $value;
416 return json_decode($json, true);
420 * Call action (mark as fav, archive, delete, etc.)
422 public function action($action, Url
$url, $id = 0, $import = FALSE, $autoclose = FALSE, $tags = null)
427 $content = $this->getPageContent($url);
428 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
429 $body = $content['rss']['channel']['item']['description'];
431 // clean content from prevent xss attack
432 $config = HTMLPurifier_Config
::createDefault();
433 $purifier = new HTMLPurifier($config);
434 $title = $purifier->purify($title);
435 $body = $purifier->purify($body);
437 //search for possible duplicate if not in import mode
439 $duplicate = $this->store
->retrieveOneByURL($url->getUrl(), $this->user
->getId());
442 if ($this->store
->add($url->getUrl(), $title, $body, $this->user
->getId())) {
443 Tools
::logm('add link ' . $url->getUrl());
445 if (STORAGE
== 'postgres') {
446 $sequence = 'entries_id_seq';
448 $last_id = $this->store
->getLastId($sequence);
449 if (DOWNLOAD_PICTURES
) {
450 $content = filtre_picture($body, $url->getUrl(), $last_id);
451 Tools
::logm('updating content article');
452 $this->store
->updateContent($last_id, $content, $this->user
->getId());
455 if ($duplicate != NULL) {
456 // duplicate exists, so, older entry needs to be deleted (as new entry should go to the top of list), BUT favorite mark and tags should be preserved
457 Tools
::logm('link ' . $url->getUrl() . ' is a duplicate');
458 // 1) - preserve tags and favorite, then drop old entry
459 $this->store
->reassignTags($duplicate['id'], $last_id);
460 if ($duplicate['is_fav']) {
461 $this->store
->favoriteById($last_id, $this->user
->getId());
463 if ($this->store
->deleteById($duplicate['id'], $this->user
->getId())) {
464 Tools
::logm('previous link ' . $url->getUrl() .' entry deleted');
469 $this->messages
->add('s', _('the link has been added successfully'));
474 $this->messages
->add('e', _('error during insertion : the link wasn\'t added'));
475 Tools
::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
480 if ($autoclose == TRUE) {
481 Tools
::redirect('?view=home');
483 Tools
::redirect('?view=home&closewin=true');
488 $msg = 'delete link #' . $id;
489 if ($this->store
->deleteById($id, $this->user
->getId())) {
490 if (DOWNLOAD_PICTURES
) {
491 remove_directory(ABS_PATH
. $id);
493 $this->messages
->add('s', _('the link has been deleted successfully'));
496 $this->messages
->add('e', _('the link wasn\'t deleted'));
497 $msg = 'error : can\'t delete link #' . $id;
500 Tools
::redirect('?');
503 $this->store
->favoriteById($id, $this->user
->getId());
504 Tools
::logm('mark as favorite link #' . $id);
509 case 'toggle_archive' :
510 $this->store
->archiveById($id, $this->user
->getId());
511 Tools
::logm('archive link #' . $id);
517 $this->store
->archiveAll($this->user
->getId());
518 Tools
::logm('archive all links');
526 $tags = explode(',', $tags);
529 $tags = explode(',', $_POST['value']);
530 $entry_id = $_POST['entry_id'];
532 $entry = $this->store
->retrieveOneById($entry_id, $this->user
->getId());
534 $this->messages
->add('e', _('Article not found!'));
535 Tools
::logm('error : article not found');
538 foreach($tags as $key => $tag_value) {
539 $value = trim($tag_value);
540 $tag = $this->store
->retrieveTagByValue($value);
544 $tag = $this->store
->createTag($value);
546 if (STORAGE
== 'postgres') {
547 $sequence = 'tags_id_seq';
549 $tag_id = $this->store
->getLastId($sequence);
552 $tag_id = $tag['id'];
555 # we assign the tag to the article
556 $this->store
->setTagToEntry($tag_id, $entry_id);
563 $tag_id = $_GET['tag_id'];
564 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
566 $this->messages
->add('e', _('Article not found!'));
567 Tools
::logm('error : article not found');
570 $this->store
->removeTagForEntry($id, $tag_id);
578 function displayView($view, $id = 0)
585 $dev = trim($this->getPocheVersion('dev'));
586 $prod = trim($this->getPocheVersion('prod'));
587 $compare_dev = version_compare(POCHE
, $dev);
588 $compare_prod = version_compare(POCHE
, $prod);
589 $themes = $this->getInstalledThemes();
590 $languages = $this->getInstalledLanguages();
591 $token = $this->user
->getConfigValue('token');
592 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
595 'languages' => $languages,
598 'compare_dev' => $compare_dev,
599 'compare_prod' => $compare_prod,
601 'user_id' => $this->user
->getId(),
602 'http_auth' => $http_auth,
604 Tools
::logm('config view');
608 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
610 $this->messages
->add('e', _('Article not found!'));
611 Tools
::logm('error : article not found');
614 $tags = $this->store
->retrieveTagsByEntry($id);
622 $token = $this->user
->getConfigValue('token');
623 $tags = $this->store
->retrieveAllTags($this->user
->getId());
626 'user_id' => $this->user
->getId(),
631 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
632 if ($entry != NULL) {
633 Tools
::logm('view link #' . $id);
634 $content = $entry['content'];
635 if (function_exists('tidy_parse_string')) {
636 $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
637 $tidy->cleanRepair();
638 $content = $tidy->value
;
642 $flattr = new FlattrItem();
643 $flattr->checkItem($entry['url'], $entry['id']);
646 $tags = $this->store
->retrieveTagsByEntry($entry['id']);
650 'content' => $content,
656 Tools
::logm('error in view call : entry is null');
659 default: # home, favorites, archive and tag views
664 'listmode' => (isset($_COOKIE['listmode']) ? true : false),
667 //if id is given - we retrive entries by tag: id is tag id
669 $tpl_vars['tag'] = $this->store
->retrieveTag($id, $this->user
->getId());
670 $tpl_vars['id'] = intval($id);
673 $count = $this->store
->getEntriesByViewCount($view, $this->user
->getId(), $id);
676 $this->pagination
->set_total($count);
677 $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
678 $this->pagination
->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . (($id)?'&id='.$id:'') . '&' ));
679 $tpl_vars['entries'] = $this->store
->getEntriesByView($view, $this->user
->getId(), $this->pagination
->get_limit(), $id);
680 $tpl_vars['page_links'] = $page_links;
681 $tpl_vars['nb_results'] = $count;
683 Tools
::logm('display ' . $view . ' view');
691 * update the password of the current user.
692 * if MODE_DEMO is TRUE, the password can't be updated.
693 * @todo add the return value
694 * @todo set the new password in function header like this updatePassword($newPassword)
697 public function updatePassword()
700 $this->messages
->add('i', _('in demo mode, you can\'t update your password'));
701 Tools
::logm('in demo mode, you can\'t do this');
702 Tools
::redirect('?view=config');
705 if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
706 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
707 $this->messages
->add('s', _('your password has been updated'));
708 $this->store
->updatePassword($this->user
->getId(), Tools
::encodeString($_POST['password'] . $this->user
->getUsername()));
710 Tools
::logm('password updated');
714 $this->messages
->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
715 Tools
::redirect('?view=config');
721 public function updateTheme()
724 if (empty($_POST['theme'])) {
727 # we are not going to change it to the current theme...
728 if ($_POST['theme'] == $this->getTheme()) {
729 $this->messages
->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
730 Tools
::redirect('?view=config');
733 $themes = $this->getInstalledThemes();
734 $actualTheme = false;
736 foreach (array_keys($themes) as $theme) {
737 if ($theme == $_POST['theme']) {
743 if (! $actualTheme) {
744 $this->messages
->add('e', _('that theme does not seem to be installed'));
745 Tools
::redirect('?view=config');
748 $this->store
->updateUserConfig($this->user
->getId(), 'theme', $_POST['theme']);
749 $this->messages
->add('s', _('you have changed your theme preferences'));
751 $currentConfig = $_SESSION['poche_user']->config
;
752 $currentConfig['theme'] = $_POST['theme'];
754 $_SESSION['poche_user']->setConfig($currentConfig);
758 Tools
::redirect('?view=config');
761 public function updateLanguage()
764 if (empty($_POST['language'])) {
767 # we are not going to change it to the current language...
768 if ($_POST['language'] == $this->getLanguage()) {
769 $this->messages
->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
770 Tools
::redirect('?view=config');
773 $languages = $this->getInstalledLanguages();
774 $actualLanguage = false;
776 foreach ($languages as $language) {
777 if ($language['value'] == $_POST['language']) {
778 $actualLanguage = true;
783 if (! $actualLanguage) {
784 $this->messages
->add('e', _('that language does not seem to be installed'));
785 Tools
::redirect('?view=config');
788 $this->store
->updateUserConfig($this->user
->getId(), 'language', $_POST['language']);
789 $this->messages
->add('s', _('you have changed your language preferences'));
791 $currentConfig = $_SESSION['poche_user']->config
;
792 $currentConfig['language'] = $_POST['language'];
794 $_SESSION['poche_user']->setConfig($currentConfig);
798 Tools
::redirect('?view=config');
802 * get credentials from differents sources
803 * it redirects the user to the $referer link
806 private function credentials() {
807 if(isset($_SERVER['PHP_AUTH_USER'])) {
808 return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
810 if(!empty($_POST['login']) && !empty($_POST['password'])) {
811 return array($_POST['login'],$_POST['password'],false);
813 if(isset($_SERVER['REMOTE_USER'])) {
814 return array($_SERVER['REMOTE_USER'],'http_auth',true);
817 return array(false,false,false);
821 * checks if login & password are correct and save the user in session.
822 * it redirects the user to the $referer link
823 * @param string $referer the url to redirect after login
824 * @todo add the return value
827 public function login($referer)
829 list($login,$password,$isauthenticated)=$this->credentials();
830 if($login === false || $password === false) {
831 $this->messages
->add('e', _('login failed: you have to fill all fields'));
832 Tools
::logm('login failed');
835 if (!empty($login) && !empty($password)) {
836 $user = $this->store
->login($login, Tools
::encodeString($password . $login), $isauthenticated);
837 if ($user != array()) {
838 # Save login into Session
839 $longlastingsession = isset($_POST['longlastingsession']);
840 $passwordTest = ($isauthenticated) ? $user['password'] : Tools
::encodeString($password . $login);
841 Session
::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
842 $this->messages
->add('s', _('welcome to your wallabag'));
843 Tools
::logm('login successful');
844 Tools
::redirect($referer);
846 $this->messages
->add('e', _('login failed: bad login or password'));
847 Tools
::logm('login failed');
853 * log out the poche user. It cleans the session.
854 * @todo add the return value
857 public function logout()
859 $this->user
= array();
861 Tools
::logm('logout');
866 * import from Instapaper. poche needs a ./instapaper-export.html file
867 * @todo add the return value
868 * @param string $targetFile the file used for importing
871 private function importFromInstapaper($targetFile)
873 # TODO gestion des articles favs
874 $html = new simple_html_dom();
875 $html->load_file($targetFile);
876 Tools
::logm('starting import from instapaper');
880 foreach($html->find('ol') as $ul)
882 foreach($ul->find('li') as $li)
885 $url = new Url(base64_encode($a[0]->href
));
886 $this->action('add', $url, 0, TRUE);
889 if (STORAGE
== 'postgres') {
890 $sequence = 'entries_id_seq';
892 $last_id = $this->store
->getLastId($sequence);
893 $this->action('toggle_archive', $url, $last_id, TRUE);
897 # the second <ol> is for read links
900 $this->messages
->add('s', _('import from instapaper completed'));
901 Tools
::logm('import from instapaper completed');
906 * import from Pocket. poche needs a ./ril_export.html file
907 * @todo add the return value
908 * @param string $targetFile the file used for importing
911 private function importFromPocket($targetFile)
913 # TODO gestion des articles favs
914 $html = new simple_html_dom();
915 $html->load_file($targetFile);
916 Tools
::logm('starting import from pocket');
920 foreach($html->find('ul') as $ul)
922 foreach($ul->find('li') as $li)
925 $url = new Url(base64_encode($a[0]->href
));
926 $this->action('add', $url, 0, TRUE);
928 if (STORAGE
== 'postgres') {
929 $sequence = 'entries_id_seq';
931 $last_id = $this->store
->getLastId($sequence);
933 $this->action('toggle_archive', $url, $last_id, TRUE);
937 $this->action('add_tag',$url,$last_id,true,false,$tags);
941 # the second <ul> is for read links
944 $this->messages
->add('s', _('import from pocket completed'));
945 Tools
::logm('import from pocket completed');
950 * import from Readability. poche needs a ./readability file
951 * @todo add the return value
952 * @param string $targetFile the file used for importing
955 private function importFromReadability($targetFile)
957 # TODO gestion des articles lus / favs
958 $str_data = file_get_contents($targetFile);
959 $data = json_decode($str_data,true);
960 Tools
::logm('starting import from Readability');
962 foreach ($data as $key => $value) {
966 foreach ($value as $item) {
967 foreach ($item as $attr => $value) {
968 if ($attr == 'article__url') {
969 $url = new Url(base64_encode($value));
972 if (STORAGE
== 'postgres') {
973 $sequence = 'entries_id_seq';
975 if ($value == 'true') {
976 if ($attr == 'favorite') {
979 if ($attr == 'archive') {
986 if (!is_null($url) && $url->isCorrect()) {
987 $this->action('add', $url, 0, TRUE);
990 $last_id = $this->store
->getLastId($sequence);
991 $this->action('toggle_fav', $url, $last_id, TRUE);
994 $last_id = $this->store
->getLastId($sequence);
995 $this->action('toggle_archive', $url, $last_id, TRUE);
1000 $this->messages
->add('s', _('import from Readability completed. ' . $count . ' new links.'));
1001 Tools
::logm('import from Readability completed');
1006 * import from Poche exported file
1007 * @param string $targetFile the file used for importing
1010 private function importFromPoche($targetFile)
1012 $str_data = file_get_contents($targetFile);
1013 $data = json_decode($str_data,true);
1014 Tools
::logm('starting import from Poche');
1018 if (STORAGE
== 'postgres') {
1019 $sequence = 'entries_id_seq';
1023 foreach ($data as $value) {
1025 $url = new Url(base64_encode($value['url']));
1026 $favorite = ($value['is_fav'] == -1);
1027 $archive = ($value['is_read'] == -1);
1029 # we can add the url
1030 if (!is_null($url) && $url->isCorrect()) {
1032 $this->action('add', $url, 0, TRUE);
1036 $last_id = $this->store
->getLastId($sequence);
1037 $this->action('toggle_fav', $url, $last_id, TRUE);
1040 $last_id = $this->store
->getLastId($sequence);
1041 $this->action('toggle_archive', $url, $last_id, TRUE);
1046 $this->messages
->add('s', _('import from Poche completed. ' . $count . ' new links.'));
1047 Tools
::logm('import from Poche completed');
1052 * import datas into your poche
1053 * @param string $from name of the service to import : pocket, instapaper or readability
1054 * @todo add the return value
1057 public function import($from)
1060 'pocket' => 'importFromPocket',
1061 'readability' => 'importFromReadability',
1062 'instapaper' => 'importFromInstapaper',
1063 'poche' => 'importFromPoche',
1066 if (! isset($providers[$from])) {
1067 $this->messages
->add('e', _('Unknown import provider.'));
1071 $targetFile = CACHE
. '/' . constant(strtoupper($from) . '_FILE');
1073 if (! file_exists($targetFile)) {
1074 $this->messages
->add('e', _('Could not find required "' . $targetFile . '" import file.'));
1078 $this->$providers[$from]($targetFile);
1081 public function uploadFile() {
1082 if(isset($_FILES['file']))
1085 $file = basename($_FILES['file']['name']);
1086 if(move_uploaded_file($_FILES['file']['tmp_name'], $dir . $file)) {
1087 $this->messages
->add('s', _('File uploaded. You can now execute import.'));
1090 $this->messages
->add('e', _('Error while importing file. Do you have access to upload it?'));
1094 Tools
::redirect('?view=config');
1098 * export poche entries in json
1099 * @return json all poche entries
1101 public function export()
1103 $entries = $this->store
->retrieveAll($this->user
->getId());
1104 echo $this->tpl
->render('export.twig', array(
1105 'export' => Tools
::renderJson($entries),
1107 Tools
::logm('export view');
1111 * Checks online the latest version of poche and cache it
1112 * @param string $which 'prod' or 'dev'
1113 * @return string latest $which version
1115 private function getPocheVersion($which = 'prod')
1117 $cache_file = CACHE
. '/' . $which;
1119 # checks if the cached version file exists
1120 if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
1121 $version = file_get_contents($cache_file);
1123 $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
1124 file_put_contents($cache_file, $version, LOCK_EX
);
1129 public function generateToken()
1131 if (ini_get('open_basedir') === '') {
1132 $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1135 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1138 $token = str_replace('+', '', $token);
1139 $this->store
->updateUserConfig($this->user
->getId(), 'token', $token);
1140 $currentConfig = $_SESSION['poche_user']->config
;
1141 $currentConfig['token'] = $token;
1142 $_SESSION['poche_user']->setConfig($currentConfig);
1146 public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1148 $allowed_types = array('home', 'fav', 'archive', 'tag');
1149 $config = $this->store
->getConfigUser($user_id);
1151 if (!in_array($type, $allowed_types) ||
1152 $token != $config['token']) {
1153 die(_('Uh, there is a problem while generating feeds.'));
1157 $feed = new FeedWriter(RSS2
);
1158 $feed->setTitle('wallabag — ' . $type . ' feed');
1159 $feed->setLink(Tools
::getPocheUrl());
1160 $feed->setChannelElement('updated', date(DATE_RSS
, time()));
1161 $feed->setChannelElement('author', 'wallabag');
1163 if ($type == 'tag') {
1164 $entries = $this->store
->retrieveEntriesByTag($tag_id, $user_id);
1167 $entries = $this->store
->getEntriesByView($type, $user_id);
1170 if (count($entries) > 0) {
1171 foreach ($entries as $entry) {
1172 $newItem = $feed->createNewItem();
1173 $newItem->setTitle($entry['title']);
1174 $newItem->setLink(Tools
::getPocheUrl() . '?view=view&id=' . $entry['id']);
1175 $newItem->setDate(time());
1176 $newItem->setDescription($entry['content']);
1177 $feed->addItem($newItem);
1181 $feed->genarateFeed();
1185 public function emptyCache() {
1186 $files = new RecursiveIteratorIterator(
1187 new RecursiveDirectoryIterator(CACHE
, RecursiveDirectoryIterator
::SKIP_DOTS
),
1188 RecursiveIteratorIterator
::CHILD_FIRST
1191 foreach ($files as $fileinfo) {
1192 $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
1193 $todo($fileinfo->getRealPath());
1196 Tools
::logm('empty cache');
1197 $this->messages
->add('s', _('Cache deleted.'));