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 public function __construct()
28 if ($this->configFileIsAvailable()) {
32 if ($this->themeIsInstalled()) {
36 if ($this->systemIsInstalled()) {
37 $this->store
= new Database();
38 $this->messages
= new Messages();
40 if (! $this->store
->isInstalled()) {
43 $this->store
->checkTags();
47 private function init()
50 Session
::$sessionName = 'poche';
53 if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
54 $this->user
= $_SESSION['poche_user'];
56 # fake user, just for install & login screens
57 $this->user
= new User();
58 $this->user
->setConfig($this->getDefaultConfig());
62 $language = $this->user
->getConfigValue('language');
63 putenv('LC_ALL=' . $language);
64 setlocale(LC_ALL
, $language);
65 bindtextdomain($language, LOCALE
);
66 textdomain($language);
69 $this->pagination
= new Paginator($this->user
->getConfigValue('pager'), 'p');
72 $themeDirectory = $this->user
->getConfigValue('theme');
74 if ($themeDirectory === false) {
75 $themeDirectory = DEFAULT_THEME
;
78 $this->currentTheme
= $themeDirectory;
81 $languageDirectory = $this->user
->getConfigValue('language');
83 if ($languageDirectory === false) {
84 $languageDirectory = DEFAULT_THEME
;
87 $this->currentLanguage
= $languageDirectory;
90 public function configFileIsAvailable() {
91 if (! self
::$configFileAvailable) {
92 $this->notInstalledMessage
[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
100 public function themeIsInstalled() {
102 # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
103 if (! self
::$canRenderTemplates) {
104 $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.';
108 if (! is_writable(CACHE
)) {
109 $this->notInstalledMessage
[] = 'You don\'t have write access on cache directory.';
111 self
::$canRenderTemplates = false;
116 # Check if the selected theme and its requirements are present
117 $theme = $this->getTheme();
119 if ($theme != '' && ! is_dir(THEME
. '/' . $theme)) {
120 $this->notInstalledMessage
[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME
. '/' . $theme . ')';
122 self
::$canRenderTemplates = false;
127 $themeInfo = $this->getThemeInfo($theme);
128 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
129 foreach ($themeInfo['requirements'] as $requiredTheme) {
130 if (! is_dir(THEME
. '/' . $requiredTheme)) {
131 $this->notInstalledMessage
[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
133 self
::$canRenderTemplates = false;
149 * all checks before installation.
150 * @todo move HTML to template
153 public function systemIsInstalled()
157 $configSalt = defined('SALT') ? constant('SALT') : '';
159 if (empty($configSalt)) {
160 $this->notInstalledMessage
[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
163 if (STORAGE
== 'sqlite' && ! file_exists(STORAGE_SQLITE
)) {
164 Tools
::logm('sqlite file doesn\'t exist');
165 $this->notInstalledMessage
[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
168 if (is_dir(ROOT
. '/install') && ! DEBUG_POCHE
) {
169 $this->notInstalledMessage
[] = 'you have to delete the /install folder before using poche.';
172 if (STORAGE
== 'sqlite' && ! is_writable(STORAGE_SQLITE
)) {
173 Tools
::logm('you don\'t have write access on sqlite file');
174 $this->notInstalledMessage
[] = 'You don\'t have write access on sqlite file.';
185 public function getNotInstalledMessage() {
186 return $this->notInstalledMessage
;
189 private function initTpl()
191 $loaderChain = new Twig_Loader_Chain();
192 $theme = $this->getTheme();
194 # add the current theme as first to the loader chain so Twig will look there first for overridden template files
196 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $theme));
197 } catch (Twig_Error_Loader
$e) {
198 # @todo isInstalled() should catch this, inject Twig later
199 die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME
. '/' . $theme .' is missing)');
202 # add all required themes to the loader chain
203 $themeInfo = $this->getThemeInfo($theme);
204 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
205 foreach ($themeInfo['requirements'] as $requiredTheme) {
207 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $requiredTheme));
208 } catch (Twig_Error_Loader
$e) {
209 # @todo isInstalled() should catch this, inject Twig later
210 die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
216 $twigParams = array();
218 $twigParams = array('cache' => CACHE
);
221 $this->tpl
= new Twig_Environment($loaderChain, $twigParams);
222 $this->tpl
->addExtension(new Twig_Extensions_Extension_I18n());
224 # filter to display domain name of an url
225 $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
226 $this->tpl
->addFilter($filter);
228 # filter for reading time
229 $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
230 $this->tpl
->addFilter($filter);
233 private function install()
235 Tools
::logm('poche still not installed');
236 echo $this->tpl
->render('install.twig', array(
237 'token' => Session
::getToken(),
238 'theme' => $this->getTheme(),
239 'poche_url' => Tools
::getPocheUrl()
241 if (isset($_GET['install'])) {
242 if (($_POST['password'] == $_POST['password_repeat'])
243 && $_POST['password'] != "" && $_POST['login'] != "") {
244 # let's rock, install poche baby !
245 if ($this->store
->install($_POST['login'], Tools
::encodeString($_POST['password'] . $_POST['login'])))
248 Tools
::logm('poche is now installed');
253 Tools
::logm('error during installation');
260 public function getTheme() {
261 return $this->currentTheme
;
265 * Provides theme information by parsing theme.ini file if present in the theme's root directory.
266 * In all cases, the following data will be returned:
267 * - name: theme's name, or key if the theme is unnamed,
268 * - current: boolean informing if the theme is the current user theme.
270 * @param string $theme Theme key (directory name)
271 * @return array|boolean Theme information, or false if the theme doesn't exist.
273 public function getThemeInfo($theme) {
274 if (!is_dir(THEME
. '/' . $theme)) {
278 $themeIniFile = THEME
. '/' . $theme . '/theme.ini';
279 $themeInfo = array();
281 if (is_file($themeIniFile) && is_readable($themeIniFile)) {
282 $themeInfo = parse_ini_file($themeIniFile);
285 if ($themeInfo === false) {
286 $themeInfo = array();
288 if (!isset($themeInfo['name'])) {
289 $themeInfo['name'] = $theme;
291 $themeInfo['current'] = ($theme === $this->getTheme());
296 public function getInstalledThemes() {
297 $handle = opendir(THEME
);
300 while (($theme = readdir($handle)) !== false) {
301 # Themes are stored in a directory, so all directory names are themes
302 # @todo move theme installation data to database
303 if (!is_dir(THEME
. '/' . $theme) || in_array($theme, array('.', '..'))) {
307 $themes[$theme] = $this->getThemeInfo($theme);
313 public function getLanguage() {
314 return $this->currentLanguage
;
317 public function getInstalledLanguages() {
318 $handle = opendir(LOCALE
);
319 $languages = array();
321 while (($language = readdir($handle)) !== false) {
322 # Languages are stored in a directory, so all directory names are languages
323 # @todo move language installation data to database
324 if (! is_dir(LOCALE
. '/' . $language) || in_array($language, array('..', '.'))) {
330 if ($language === $this->getLanguage()) {
334 $languages[] = array('name' => $language, 'current' => $current);
340 public function getDefaultConfig()
343 'pager' => PAGINATION
,
345 'theme' => DEFAULT_THEME
349 protected function getPageContent(Url
$url)
351 // Saving and clearing context
353 foreach( $GLOBALS as $key => $value ) {
354 if( $key != "GLOBALS" && $key != "_SESSION" ) {
355 $GLOBALS[$key] = array();
356 $REAL[$key] = $value;
359 // Saving and clearing session
360 $REAL_SESSION = array();
361 foreach( $_SESSION as $key => $value ) {
362 $REAL_SESSION[$key] = $value;
363 unset($_SESSION[$key]);
366 // Running code in different context
367 $scope = function() {
368 extract( func_get_arg(1) );
369 $_GET = $_REQUEST = array(
370 "url" => $url->getUrl(),
372 "links" => "preserve",
375 "submit" => "Create Feed"
378 require func_get_arg(0);
379 $json = ob_get_flush();
382 $json = $scope( "inc/3rdparty/makefulltextfeed.php", array("url" => $url) );
384 // Clearing and restoring context
385 foreach( $GLOBALS as $key => $value ) {
386 if( $key != "GLOBALS" && $key != "_SESSION" ) {
387 unset($GLOBALS[$key]);
390 foreach( $REAL as $key => $value ) {
391 $GLOBALS[$key] = $value;
393 // Clearing and restoring session
394 foreach( $_SESSION as $key => $value ) {
395 unset($_SESSION[$key]);
397 foreach( $REAL_SESSION as $key => $value ) {
398 $_SESSION[$key] = $value;
400 return json_decode($json, true);
404 * Call action (mark as fav, archive, delete, etc.)
406 public function action($action, Url
$url, $id = 0, $import = FALSE, $autoclose = FALSE)
411 $content = $this->getPageContent($url);
412 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
413 $body = $content['rss']['channel']['item']['description'];
415 //search for possible duplicate if not in import mode
417 $duplicate = $this->store
->retrieveOneByURL($url->getUrl(), $this->user
->getId());
420 if ($this->store
->add($url->getUrl(), $title, $body, $this->user
->getId())) {
421 Tools
::logm('add link ' . $url->getUrl());
423 if (STORAGE
== 'postgres') {
424 $sequence = 'entries_id_seq';
426 $last_id = $this->store
->getLastId($sequence);
427 if (DOWNLOAD_PICTURES
) {
428 $content = filtre_picture($body, $url->getUrl(), $last_id);
429 Tools
::logm('updating content article');
430 $this->store
->updateContent($last_id, $content, $this->user
->getId());
433 if ($duplicate != NULL) {
434 // 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
435 Tools
::logm('link ' . $url->getUrl() . ' is a duplicate');
436 // 1) - preserve tags and favorite, then drop old entry
437 $this->store
->reassignTags($duplicate['id'], $last_id);
438 if ($duplicate['is_fav']) {
439 $this->store
->favoriteById($last_id, $this->user
->getId());
441 if ($this->store
->deleteById($duplicate['id'], $this->user
->getId())) {
442 Tools
::logm('previous link ' . $url->getUrl() .' entry deleted');
447 $this->messages
->add('s', _('the link has been added successfully'));
452 $this->messages
->add('e', _('error during insertion : the link wasn\'t added'));
453 Tools
::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
458 if ($autoclose == TRUE) {
459 Tools
::redirect('?view=home');
461 Tools
::redirect('?view=home&closewin=true');
466 $msg = 'delete link #' . $id;
467 if ($this->store
->deleteById($id, $this->user
->getId())) {
468 if (DOWNLOAD_PICTURES
) {
469 remove_directory(ABS_PATH
. $id);
471 $this->messages
->add('s', _('the link has been deleted successfully'));
474 $this->messages
->add('e', _('the link wasn\'t deleted'));
475 $msg = 'error : can\'t delete link #' . $id;
478 Tools
::redirect('?');
481 $this->store
->favoriteById($id, $this->user
->getId());
482 Tools
::logm('mark as favorite link #' . $id);
487 case 'toggle_archive' :
488 $this->store
->archiveById($id, $this->user
->getId());
489 Tools
::logm('archive link #' . $id);
495 $this->store
->archiveAll($this->user
->getId());
496 Tools
::logm('archive all links');
502 $tags = explode(',', $_POST['value']);
503 $entry_id = $_POST['entry_id'];
504 $entry = $this->store
->retrieveOneById($entry_id, $this->user
->getId());
506 $this->messages
->add('e', _('Article not found!'));
507 Tools
::logm('error : article not found');
510 foreach($tags as $key => $tag_value) {
511 $value = trim($tag_value);
512 $tag = $this->store
->retrieveTagByValue($value);
516 $tag = $this->store
->createTag($value);
518 if (STORAGE
== 'postgres') {
519 $sequence = 'tags_id_seq';
521 $tag_id = $this->store
->getLastId($sequence);
524 $tag_id = $tag['id'];
527 # we assign the tag to the article
528 $this->store
->setTagToEntry($tag_id, $entry_id);
533 $tag_id = $_GET['tag_id'];
534 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
536 $this->messages
->add('e', _('Article not found!'));
537 Tools
::logm('error : article not found');
540 $this->store
->removeTagForEntry($id, $tag_id);
548 function displayView($view, $id = 0)
555 $dev = trim($this->getPocheVersion('dev'));
556 $prod = trim($this->getPocheVersion('prod'));
557 $compare_dev = version_compare(POCHE
, $dev);
558 $compare_prod = version_compare(POCHE
, $prod);
559 $themes = $this->getInstalledThemes();
560 $languages = $this->getInstalledLanguages();
561 $token = $this->user
->getConfigValue('token');
562 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
565 'languages' => $languages,
568 'compare_dev' => $compare_dev,
569 'compare_prod' => $compare_prod,
571 'user_id' => $this->user
->getId(),
572 'http_auth' => $http_auth,
574 Tools
::logm('config view');
578 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
580 $this->messages
->add('e', _('Article not found!'));
581 Tools
::logm('error : article not found');
584 $tags = $this->store
->retrieveTagsByEntry($id);
591 $entries = $this->store
->retrieveEntriesByTag($id, $this->user
->getId());
592 $tag = $this->store
->retrieveTag($id, $this->user
->getId());
595 'entries' => $entries,
599 $token = $this->user
->getConfigValue('token');
600 $tags = $this->store
->retrieveAllTags($this->user
->getId());
603 'user_id' => $this->user
->getId(),
608 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
609 if ($entry != NULL) {
610 Tools
::logm('view link #' . $id);
611 $content = $entry['content'];
612 if (function_exists('tidy_parse_string')) {
613 $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
614 $tidy->cleanRepair();
615 $content = $tidy->value
;
619 $flattr = new FlattrItem();
620 $flattr->checkItem($entry['url'], $entry['id']);
623 $tags = $this->store
->retrieveTagsByEntry($entry['id']);
627 'content' => $content,
633 Tools
::logm('error in view call : entry is null');
636 default: # home, favorites and archive views
637 $entries = $this->store
->getEntriesByView($view, $this->user
->getId());
644 if (count($entries) > 0) {
645 $this->pagination
->set_total(count($entries));
646 $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
647 $this->pagination
->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&'));
648 $datas = $this->store
->getEntriesByView($view, $this->user
->getId(), $this->pagination
->get_limit());
649 $tpl_vars['entries'] = $datas;
650 $tpl_vars['page_links'] = $page_links;
651 $tpl_vars['nb_results'] = count($entries);
653 Tools
::logm('display ' . $view . ' view');
661 * update the password of the current user.
662 * if MODE_DEMO is TRUE, the password can't be updated.
663 * @todo add the return value
664 * @todo set the new password in function header like this updatePassword($newPassword)
667 public function updatePassword()
670 $this->messages
->add('i', _('in demo mode, you can\'t update your password'));
671 Tools
::logm('in demo mode, you can\'t do this');
672 Tools
::redirect('?view=config');
675 if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
676 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
677 $this->messages
->add('s', _('your password has been updated'));
678 $this->store
->updatePassword($this->user
->getId(), Tools
::encodeString($_POST['password'] . $this->user
->getUsername()));
680 Tools
::logm('password updated');
684 $this->messages
->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
685 Tools
::redirect('?view=config');
691 public function updateTheme()
694 if (empty($_POST['theme'])) {
697 # we are not going to change it to the current theme...
698 if ($_POST['theme'] == $this->getTheme()) {
699 $this->messages
->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
700 Tools
::redirect('?view=config');
703 $themes = $this->getInstalledThemes();
704 $actualTheme = false;
706 foreach (array_keys($themes) as $theme) {
707 if ($theme == $_POST['theme']) {
713 if (! $actualTheme) {
714 $this->messages
->add('e', _('that theme does not seem to be installed'));
715 Tools
::redirect('?view=config');
718 $this->store
->updateUserConfig($this->user
->getId(), 'theme', $_POST['theme']);
719 $this->messages
->add('s', _('you have changed your theme preferences'));
721 $currentConfig = $_SESSION['poche_user']->config
;
722 $currentConfig['theme'] = $_POST['theme'];
724 $_SESSION['poche_user']->setConfig($currentConfig);
726 Tools
::redirect('?view=config');
729 public function updateLanguage()
732 if (empty($_POST['language'])) {
735 # we are not going to change it to the current language...
736 if ($_POST['language'] == $this->getLanguage()) {
737 $this->messages
->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
738 Tools
::redirect('?view=config');
741 $languages = $this->getInstalledLanguages();
742 $actualLanguage = false;
744 foreach ($languages as $language) {
745 if ($language['name'] == $_POST['language']) {
746 $actualLanguage = true;
751 if (! $actualLanguage) {
752 $this->messages
->add('e', _('that language does not seem to be installed'));
753 Tools
::redirect('?view=config');
756 $this->store
->updateUserConfig($this->user
->getId(), 'language', $_POST['language']);
757 $this->messages
->add('s', _('you have changed your language preferences'));
759 $currentConfig = $_SESSION['poche_user']->config
;
760 $currentConfig['language'] = $_POST['language'];
762 $_SESSION['poche_user']->setConfig($currentConfig);
764 Tools
::redirect('?view=config');
768 * get credentials from differents sources
769 * it redirects the user to the $referer link
772 private function credentials() {
773 if(isset($_SERVER['PHP_AUTH_USER'])) {
774 return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
776 if(!empty($_POST['login']) && !empty($_POST['password'])) {
777 return array($_POST['login'],$_POST['password'],false);
779 if(isset($_SERVER['REMOTE_USER'])) {
780 return array($_SERVER['REMOTE_USER'],'http_auth',true);
783 return array(false,false,false);
787 * checks if login & password are correct and save the user in session.
788 * it redirects the user to the $referer link
789 * @param string $referer the url to redirect after login
790 * @todo add the return value
793 public function login($referer)
795 list($login,$password,$isauthenticated)=$this->credentials();
796 if($login === false || $password === false) {
797 $this->messages
->add('e', _('login failed: you have to fill all fields'));
798 Tools
::logm('login failed');
801 if (!empty($login) && !empty($password)) {
802 $user = $this->store
->login($login, Tools
::encodeString($password . $login), $isauthenticated);
803 if ($user != array()) {
804 # Save login into Session
805 $longlastingsession = isset($_POST['longlastingsession']);
806 $passwordTest = ($isauthenticated) ? $user['password'] : Tools
::encodeString($password . $login);
807 Session
::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
808 $this->messages
->add('s', _('welcome to your wallabag'));
809 Tools
::logm('login successful');
810 Tools
::redirect($referer);
812 $this->messages
->add('e', _('login failed: bad login or password'));
813 Tools
::logm('login failed');
819 * log out the poche user. It cleans the session.
820 * @todo add the return value
823 public function logout()
825 $this->user
= array();
827 Tools
::logm('logout');
832 * import from Instapaper. poche needs a ./instapaper-export.html file
833 * @todo add the return value
834 * @param string $targetFile the file used for importing
837 private function importFromInstapaper($targetFile)
839 # TODO gestion des articles favs
840 $html = new simple_html_dom();
841 $html->load_file($targetFile);
842 Tools
::logm('starting import from instapaper');
846 foreach($html->find('ol') as $ul)
848 foreach($ul->find('li') as $li)
851 $url = new Url(base64_encode($a[0]->href
));
852 $this->action('add', $url, 0, TRUE);
855 if (STORAGE
== 'postgres') {
856 $sequence = 'entries_id_seq';
858 $last_id = $this->store
->getLastId($sequence);
859 $this->action('toggle_archive', $url, $last_id, TRUE);
863 # the second <ol> is for read links
866 $this->messages
->add('s', _('import from instapaper completed'));
867 Tools
::logm('import from instapaper completed');
872 * import from Pocket. poche needs a ./ril_export.html file
873 * @todo add the return value
874 * @param string $targetFile the file used for importing
877 private function importFromPocket($targetFile)
879 # TODO gestion des articles favs
880 $html = new simple_html_dom();
881 $html->load_file($targetFile);
882 Tools
::logm('starting import from pocket');
886 foreach($html->find('ul') as $ul)
888 foreach($ul->find('li') as $li)
891 $url = new Url(base64_encode($a[0]->href
));
892 $this->action('add', $url, 0, TRUE);
895 if (STORAGE
== 'postgres') {
896 $sequence = 'entries_id_seq';
898 $last_id = $this->store
->getLastId($sequence);
899 $this->action('toggle_archive', $url, $last_id, TRUE);
903 # the second <ul> is for read links
906 $this->messages
->add('s', _('import from pocket completed'));
907 Tools
::logm('import from pocket completed');
912 * import from Readability. poche needs a ./readability file
913 * @todo add the return value
914 * @param string $targetFile the file used for importing
917 private function importFromReadability($targetFile)
919 # TODO gestion des articles lus / favs
920 $str_data = file_get_contents($targetFile);
921 $data = json_decode($str_data,true);
922 Tools
::logm('starting import from Readability');
924 foreach ($data as $key => $value) {
928 foreach ($value as $item) {
929 foreach ($item as $attr => $value) {
930 if ($attr == 'article__url') {
931 $url = new Url(base64_encode($value));
934 if (STORAGE
== 'postgres') {
935 $sequence = 'entries_id_seq';
937 if ($value == 'true') {
938 if ($attr == 'favorite') {
941 if ($attr == 'archive') {
948 if (!is_null($url) && $url->isCorrect()) {
949 $this->action('add', $url, 0, TRUE);
952 $last_id = $this->store
->getLastId($sequence);
953 $this->action('toggle_fav', $url, $last_id, TRUE);
956 $last_id = $this->store
->getLastId($sequence);
957 $this->action('toggle_archive', $url, $last_id, TRUE);
962 $this->messages
->add('s', _('import from Readability completed. ' . $count . ' new links.'));
963 Tools
::logm('import from Readability completed');
968 * import from Poche exported file
969 * @param string $targetFile the file used for importing
972 private function importFromPoche($targetFile)
974 $str_data = file_get_contents($targetFile);
975 $data = json_decode($str_data,true);
976 Tools
::logm('starting import from Poche');
980 if (STORAGE
== 'postgres') {
981 $sequence = 'entries_id_seq';
985 foreach ($data as $value) {
987 $url = new Url(base64_encode($value['url']));
988 $favorite = ($value['is_fav'] == -1);
989 $archive = ($value['is_read'] == -1);
992 if (!is_null($url) && $url->isCorrect()) {
994 $this->action('add', $url, 0, TRUE);
998 $last_id = $this->store
->getLastId($sequence);
999 $this->action('toggle_fav', $url, $last_id, TRUE);
1002 $last_id = $this->store
->getLastId($sequence);
1003 $this->action('toggle_archive', $url, $last_id, TRUE);
1008 $this->messages
->add('s', _('import from Poche completed. ' . $count . ' new links.'));
1009 Tools
::logm('import from Poche completed');
1014 * import datas into your poche
1015 * @param string $from name of the service to import : pocket, instapaper or readability
1016 * @todo add the return value
1019 public function import($from)
1022 'pocket' => 'importFromPocket',
1023 'readability' => 'importFromReadability',
1024 'instapaper' => 'importFromInstapaper',
1025 'poche' => 'importFromPoche',
1028 if (! isset($providers[$from])) {
1029 $this->messages
->add('e', _('Unknown import provider.'));
1033 $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
1034 $targetFile = constant($targetDefinition);
1036 if (! defined($targetDefinition)) {
1037 $this->messages
->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
1041 if (! file_exists($targetFile)) {
1042 $this->messages
->add('e', _('Could not find required "' . $targetFile . '" import file.'));
1046 $this->$providers[$from]($targetFile);
1050 * export poche entries in json
1051 * @return json all poche entries
1053 public function export()
1055 $entries = $this->store
->retrieveAll($this->user
->getId());
1056 echo $this->tpl
->render('export.twig', array(
1057 'export' => Tools
::renderJson($entries),
1059 Tools
::logm('export view');
1063 * Checks online the latest version of poche and cache it
1064 * @param string $which 'prod' or 'dev'
1065 * @return string latest $which version
1067 private function getPocheVersion($which = 'prod')
1069 $cache_file = CACHE
. '/' . $which;
1071 # checks if the cached version file exists
1072 if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
1073 $version = file_get_contents($cache_file);
1075 $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
1076 file_put_contents($cache_file, $version, LOCK_EX
);
1081 public function generateToken()
1083 if (ini_get('open_basedir') === '') {
1084 $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1087 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1090 $token = str_replace('+', '', $token);
1091 $this->store
->updateUserConfig($this->user
->getId(), 'token', $token);
1092 $currentConfig = $_SESSION['poche_user']->config
;
1093 $currentConfig['token'] = $token;
1094 $_SESSION['poche_user']->setConfig($currentConfig);
1097 public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1099 $allowed_types = array('home', 'fav', 'archive', 'tag');
1100 $config = $this->store
->getConfigUser($user_id);
1102 if (!in_array($type, $allowed_types) ||
1103 $token != $config['token']) {
1104 die(_('Uh, there is a problem while generating feeds.'));
1108 $feed = new FeedWriter(RSS2
);
1109 $feed->setTitle('wallabag — ' . $type . ' feed');
1110 $feed->setLink(Tools
::getPocheUrl());
1111 $feed->setChannelElement('updated', date(DATE_RSS
, time()));
1112 $feed->setChannelElement('author', 'wallabag');
1114 if ($type == 'tag') {
1115 $entries = $this->store
->retrieveEntriesByTag($tag_id, $user_id);
1118 $entries = $this->store
->getEntriesByView($type, $user_id);
1121 if (count($entries) > 0) {
1122 foreach ($entries as $entry) {
1123 $newItem = $feed->createNewItem();
1124 $newItem->setTitle($entry['title']);
1125 $newItem->setLink(Tools
::getPocheUrl() . '?view=view&id=' . $entry['id']);
1126 $newItem->setDate(time());
1127 $newItem->setDescription($entry['content']);
1128 $feed->addItem($newItem);
1132 $feed->genarateFeed();
1136 public function emptyCache() {
1137 $files = new RecursiveIteratorIterator(
1138 new RecursiveDirectoryIterator(CACHE
, RecursiveDirectoryIterator
::SKIP_DOTS
),
1139 RecursiveIteratorIterator
::CHILD_FIRST
1142 foreach ($files as $fileinfo) {
1143 $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
1144 $todo($fileinfo->getRealPath());
1147 Tools
::logm('empty cache');
1148 $this->messages
->add('s', _('Cache deleted.'));