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 'pt_BR.utf8' => 'Português (Brasil)',
36 'ru_RU.utf8' => 'Pусский',
37 'sl_SI.utf8' => 'Slovenščina',
38 'uk_UA.utf8' => 'Українська',
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()
65 if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
66 $this->user
= $_SESSION['poche_user'];
68 # fake user, just for install & login screens
69 $this->user
= new User();
70 $this->user
->setConfig($this->getDefaultConfig());
74 $language = $this->user
->getConfigValue('language');
75 @putenv('LC_ALL=' . $language);
76 setlocale(LC_ALL
, $language);
77 bindtextdomain($language, LOCALE
);
78 textdomain($language);
81 $this->pagination
= new Paginator($this->user
->getConfigValue('pager'), 'p');
84 $themeDirectory = $this->user
->getConfigValue('theme');
86 if ($themeDirectory === false) {
87 $themeDirectory = DEFAULT_THEME
;
90 $this->currentTheme
= $themeDirectory;
93 $languageDirectory = $this->user
->getConfigValue('language');
95 if ($languageDirectory === false) {
96 $languageDirectory = DEFAULT_THEME
;
99 $this->currentLanguage
= $languageDirectory;
102 public function configFileIsAvailable() {
103 if (! self
::$configFileAvailable) {
104 $this->notInstalledMessage
[] = 'You have to copy (don\'t just rename!) inc/poche/config.inc.default.php to inc/poche/config.inc.php.';
112 public function themeIsInstalled() {
114 # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
115 if (! self
::$canRenderTemplates) {
116 $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.';
120 if (! is_writable(CACHE
)) {
121 $this->notInstalledMessage
[] = 'You don\'t have write access on cache directory.';
123 self
::$canRenderTemplates = false;
128 # Check if the selected theme and its requirements are present
129 $theme = $this->getTheme();
131 if ($theme != '' && ! is_dir(THEME
. '/' . $theme)) {
132 $this->notInstalledMessage
[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME
. '/' . $theme . ')';
134 self
::$canRenderTemplates = false;
139 $themeInfo = $this->getThemeInfo($theme);
140 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
141 foreach ($themeInfo['requirements'] as $requiredTheme) {
142 if (! is_dir(THEME
. '/' . $requiredTheme)) {
143 $this->notInstalledMessage
[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
145 self
::$canRenderTemplates = false;
161 * all checks before installation.
162 * @todo move HTML to template
165 public function systemIsInstalled()
169 $configSalt = defined('SALT') ? constant('SALT') : '';
171 if (empty($configSalt)) {
172 $this->notInstalledMessage
[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
175 if (STORAGE
== 'sqlite' && ! file_exists(STORAGE_SQLITE
)) {
176 Tools
::logm('sqlite file doesn\'t exist');
177 $this->notInstalledMessage
[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
180 if (is_dir(ROOT
. '/install') && ! DEBUG_POCHE
) {
181 $this->notInstalledMessage
[] = 'you have to delete the /install folder before using poche.';
184 if (STORAGE
== 'sqlite' && ! is_writable(STORAGE_SQLITE
)) {
185 Tools
::logm('you don\'t have write access on sqlite file');
186 $this->notInstalledMessage
[] = 'You don\'t have write access on sqlite file.';
197 public function getNotInstalledMessage() {
198 return $this->notInstalledMessage
;
201 private function initTpl()
203 $loaderChain = new Twig_Loader_Chain();
204 $theme = $this->getTheme();
206 # add the current theme as first to the loader chain so Twig will look there first for overridden template files
208 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $theme));
209 } catch (Twig_Error_Loader
$e) {
210 # @todo isInstalled() should catch this, inject Twig later
211 die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME
. '/' . $theme .' is missing)');
214 # add all required themes to the loader chain
215 $themeInfo = $this->getThemeInfo($theme);
216 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
217 foreach ($themeInfo['requirements'] as $requiredTheme) {
219 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME
. '/' . $requiredTheme));
220 } catch (Twig_Error_Loader
$e) {
221 # @todo isInstalled() should catch this, inject Twig later
222 die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
228 $twigParams = array();
230 $twigParams = array('cache' => CACHE
);
233 $this->tpl
= new Twig_Environment($loaderChain, $twigParams);
234 $this->tpl
->addExtension(new Twig_Extensions_Extension_I18n());
236 # filter to display domain name of an url
237 $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
238 $this->tpl
->addFilter($filter);
240 # filter for reading time
241 $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
242 $this->tpl
->addFilter($filter);
245 public function createNewUser() {
246 if (isset($_GET['newuser'])){
247 if ($_POST['newusername'] != "" && $_POST['password4newuser'] != ""){
248 $newusername = filter_var($_POST['newusername'], FILTER_SANITIZE_STRING
);
249 if (!$this->store
->userExists($newusername)){
250 if ($this->store
->install($newusername, Tools
::encodeString($_POST['password4newuser'] . $newusername))) {
251 Tools
::logm('The new user '.$newusername.' has been installed');
252 $this->messages
->add('s', sprintf(_('The new user %s has been installed. Do you want to <a href="?logout">logout ?</a>'),$newusername));
256 Tools
::logm('error during adding new user');
261 $this->messages
->add('e', sprintf(_('Error : An user with the name %s already exists !'),$newusername));
262 Tools
::logm('An user with the name '.$newusername.' already exists !');
269 public function deleteUser(){
270 if (isset($_GET['deluser'])){
271 if ($this->store
->listUsers() > 1) {
272 if (Tools
::encodeString($_POST['password4deletinguser'].$this->user
->getUsername()) == $this->store
->getUserPassword($this->user
->getId())) {
273 $username = $this->user
->getUsername();
274 $this->store
->deleteUserConfig($this->user
->getId());
275 Tools
::logm('The configuration for user '. $username .' has been deleted !');
276 $this->store
->deleteTagsEntriesAndEntries($this->user
->getId());
277 Tools
::logm('The entries for user '. $username .' has been deleted !');
278 $this->store
->deleteUser($this->user
->getId());
279 Tools
::logm('User '. $username .' has been completely deleted !');
281 Tools
::logm('logout');
283 $this->messages
->add('s', sprintf(_('User %s has been successfully deleted !'),$newusername));
286 Tools
::logm('Bad password !');
287 $this->messages
->add('e', _('Error : The password is wrong !'));
291 Tools
::logm('Only user !');
292 $this->messages
->add('e', _('Error : You are the only user, you cannot delete your account !'));
297 private function install()
299 Tools
::logm('poche still not installed');
300 echo $this->tpl
->render('install.twig', array(
301 'token' => Session
::getToken(),
302 'theme' => $this->getTheme(),
303 'poche_url' => Tools
::getPocheUrl()
305 if (isset($_GET['install'])) {
306 if (($_POST['password'] == $_POST['password_repeat'])
307 && $_POST['password'] != "" && $_POST['login'] != "") {
308 # let's rock, install poche baby !
309 if ($this->store
->install($_POST['login'], Tools
::encodeString($_POST['password'] . $_POST['login'])))
312 Tools
::logm('poche is now installed');
317 Tools
::logm('error during installation');
324 public function getTheme() {
325 return $this->currentTheme
;
329 * Provides theme information by parsing theme.ini file if present in the theme's root directory.
330 * In all cases, the following data will be returned:
331 * - name: theme's name, or key if the theme is unnamed,
332 * - current: boolean informing if the theme is the current user theme.
334 * @param string $theme Theme key (directory name)
335 * @return array|boolean Theme information, or false if the theme doesn't exist.
337 public function getThemeInfo($theme) {
338 if (!is_dir(THEME
. '/' . $theme)) {
342 $themeIniFile = THEME
. '/' . $theme . '/theme.ini';
343 $themeInfo = array();
345 if (is_file($themeIniFile) && is_readable($themeIniFile)) {
346 $themeInfo = parse_ini_file($themeIniFile);
349 if ($themeInfo === false) {
350 $themeInfo = array();
352 if (!isset($themeInfo['name'])) {
353 $themeInfo['name'] = $theme;
355 $themeInfo['current'] = ($theme === $this->getTheme());
360 public function getInstalledThemes() {
361 $handle = opendir(THEME
);
364 while (($theme = readdir($handle)) !== false) {
365 # Themes are stored in a directory, so all directory names are themes
366 # @todo move theme installation data to database
367 if (!is_dir(THEME
. '/' . $theme) || in_array($theme, array('.', '..'))) {
371 $themes[$theme] = $this->getThemeInfo($theme);
379 public function getLanguage() {
380 return $this->currentLanguage
;
383 public function getInstalledLanguages() {
384 $handle = opendir(LOCALE
);
385 $languages = array();
387 while (($language = readdir($handle)) !== false) {
388 # Languages are stored in a directory, so all directory names are languages
389 # @todo move language installation data to database
390 if (! is_dir(LOCALE
. '/' . $language) || in_array($language, array('..', '.', 'tools'))) {
396 if ($language === $this->getLanguage()) {
400 $languages[] = array('name' => (isset($this->language_names
[$language]) ? $this->language_names
[$language] : $language), 'value' => $language, 'current' => $current);
406 public function getDefaultConfig()
409 'pager' => PAGINATION
,
411 'theme' => DEFAULT_THEME
416 * Call action (mark as fav, archive, delete, etc.)
418 public function action($action, Url
$url, $id = 0, $import = FALSE, $autoclose = FALSE, $tags = null)
423 $content = Tools
::getPageContent($url);
424 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
425 $body = $content['rss']['channel']['item']['description'];
427 // clean content from prevent xss attack
428 $purifier = $this->getPurifier();
429 $title = $purifier->purify($title);
430 $body = $purifier->purify($body);
432 //search for possible duplicate
434 $duplicate = $this->store
->retrieveOneByURL($url->getUrl(), $this->user
->getId());
436 $last_id = $this->store
->add($url->getUrl(), $title, $body, $this->user
->getId());
438 Tools
::logm('add link ' . $url->getUrl());
439 if (DOWNLOAD_PICTURES
) {
440 $content = filtre_picture($body, $url->getUrl(), $last_id);
441 Tools
::logm('updating content article');
442 $this->store
->updateContent($last_id, $content, $this->user
->getId());
445 if ($duplicate != NULL) {
446 // 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
447 Tools
::logm('link ' . $url->getUrl() . ' is a duplicate');
448 // 1) - preserve tags and favorite, then drop old entry
449 $this->store
->reassignTags($duplicate['id'], $last_id);
450 if ($duplicate['is_fav']) {
451 $this->store
->favoriteById($last_id, $this->user
->getId());
453 if ($this->store
->deleteById($duplicate['id'], $this->user
->getId())) {
454 Tools
::logm('previous link ' . $url->getUrl() .' entry deleted');
458 $this->messages
->add('s', _('the link has been added successfully'));
461 $this->messages
->add('e', _('error during insertion : the link wasn\'t added'));
462 Tools
::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
465 if ($autoclose == TRUE) {
466 Tools
::redirect('?view=home');
468 Tools
::redirect('?view=home&closewin=true');
472 $msg = 'delete link #' . $id;
473 if ($this->store
->deleteById($id, $this->user
->getId())) {
474 if (DOWNLOAD_PICTURES
) {
475 remove_directory(ABS_PATH
. $id);
477 $this->messages
->add('s', _('the link has been deleted successfully'));
480 $this->messages
->add('e', _('the link wasn\'t deleted'));
481 $msg = 'error : can\'t delete link #' . $id;
484 Tools
::redirect('?');
487 $this->store
->favoriteById($id, $this->user
->getId());
488 Tools
::logm('mark as favorite link #' . $id);
489 if ( Tools
::isAjaxRequest() ) {
497 case 'toggle_archive' :
498 $this->store
->archiveById($id, $this->user
->getId());
499 Tools
::logm('archive link #' . $id);
500 if ( Tools
::isAjaxRequest() ) {
509 $this->store
->archiveAll($this->user
->getId());
510 Tools
::logm('archive all links');
514 if (isset($_GET['search'])) {
515 //when we want to apply a tag to a search
516 $tags = array($_GET['search']);
517 $allentry_ids = $this->store
->search($tags[0], $this->user
->getId());
518 $entry_ids = array();
519 foreach ($allentry_ids as $eachentry) {
520 $entry_ids[] = $eachentry[0];
522 } else { //add a tag to a single article
523 $tags = explode(',', $_POST['value']);
524 $entry_ids = array($_POST['entry_id']);
526 foreach($entry_ids as $entry_id) {
527 $entry = $this->store
->retrieveOneById($entry_id, $this->user
->getId());
529 $this->messages
->add('e', _('Article not found!'));
530 Tools
::logm('error : article not found');
533 //get all already set tags to preven duplicates
534 $already_set_tags = array();
535 $entry_tags = $this->store
->retrieveTagsByEntry($entry_id);
536 foreach ($entry_tags as $tag) {
537 $already_set_tags[] = $tag['value'];
539 foreach($tags as $key => $tag_value) {
540 $value = trim($tag_value);
541 if ($value && !in_array($value, $already_set_tags)) {
542 $tag = $this->store
->retrieveTagByValue($value);
545 $tag = $this->store
->createTag($value);
547 if (STORAGE
== 'postgres') {
548 $sequence = 'tags_id_seq';
550 $tag_id = $this->store
->getLastId($sequence);
553 $tag_id = $tag['id'];
556 # we assign the tag to the article
557 $this->store
->setTagToEntry($tag_id, $entry_id);
561 $this->messages
->add('s', _('the tag has been applied successfully'));
565 $tag_id = $_GET['tag_id'];
566 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
568 $this->messages
->add('e', _('Article not found!'));
569 Tools
::logm('error : article not found');
572 $this->store
->removeTagForEntry($id, $tag_id);
580 function displayView($view, $id = 0)
587 $dev_infos = $this->getPocheVersion('dev');
588 $dev = trim($dev_infos[0]);
589 $check_time_dev = date('d-M-Y H:i', $dev_infos[1]);
590 $prod_infos = $this->getPocheVersion('prod');
591 $prod = trim($prod_infos[0]);
592 $check_time_prod = date('d-M-Y H:i', $prod_infos[1]);
593 $compare_dev = version_compare(POCHE
, $dev);
594 $compare_prod = version_compare(POCHE
, $prod);
595 $themes = $this->getInstalledThemes();
596 $languages = $this->getInstalledLanguages();
597 $token = $this->user
->getConfigValue('token');
598 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
599 $only_user = ($this->store
->listUsers() > 1) ? false : true;
602 'languages' => $languages,
605 'check_time_dev' => $check_time_dev,
606 'check_time_prod' => $check_time_prod,
607 'compare_dev' => $compare_dev,
608 'compare_prod' => $compare_prod,
610 'user_id' => $this->user
->getId(),
611 'http_auth' => $http_auth,
612 'only_user' => $only_user
614 Tools
::logm('config view');
618 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
620 $this->messages
->add('e', _('Article not found!'));
621 Tools
::logm('error : article not found');
624 $tags = $this->store
->retrieveTagsByEntry($id);
632 $token = $this->user
->getConfigValue('token');
633 //if term is set - search tags for this term
634 $term = Tools
::checkVar('term');
635 $tags = $this->store
->retrieveAllTags($this->user
->getId(), $term);
636 if (Tools
::isAjaxRequest()) {
638 foreach ($tags as $tag) {
639 $result[] = $tag['value'];
641 echo json_encode($result);
646 'user_id' => $this->user
->getId(),
651 if (isset($_GET['search'])) {
652 $search = filter_var($_GET['search'], FILTER_SANITIZE_STRING
);
653 $tpl_vars['entries'] = $this->store
->search($search, $this->user
->getId());
654 $count = count($tpl_vars['entries']);
655 $this->pagination
->set_total($count);
656 $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
657 $this->pagination
->page_links('?view=' . $view . '?search=' . $search . '&sort=' . $_SESSION['sort'] . '&' ));
658 $tpl_vars['page_links'] = $page_links;
659 $tpl_vars['nb_results'] = $count;
660 $tpl_vars['search_term'] = $search;
664 $entry = $this->store
->retrieveOneById($id, $this->user
->getId());
665 if ($entry != NULL) {
666 Tools
::logm('view link #' . $id);
667 $content = $entry['content'];
668 if (function_exists('tidy_parse_string')) {
669 $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
670 $tidy->cleanRepair();
671 $content = $tidy->value
;
675 $flattr = new FlattrItem();
676 $flattr->checkItem($entry['url'], $entry['id']);
679 $tags = $this->store
->retrieveTagsByEntry($entry['id']);
683 'content' => $content,
689 Tools
::logm('error in view call : entry is null');
692 default: # home, favorites, archive and tag views
697 'listmode' => (isset($_COOKIE['listmode']) ? true : false),
700 //if id is given - we retrive entries by tag: id is tag id
702 $tpl_vars['tag'] = $this->store
->retrieveTag($id, $this->user
->getId());
703 $tpl_vars['id'] = intval($id);
706 $count = $this->store
->getEntriesByViewCount($view, $this->user
->getId(), $id);
709 $this->pagination
->set_total($count);
710 $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
711 $this->pagination
->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . (($id)?'&id='.$id:'') . '&' ));
712 $tpl_vars['entries'] = $this->store
->getEntriesByView($view, $this->user
->getId(), $this->pagination
->get_limit(), $id);
713 $tpl_vars['page_links'] = $page_links;
714 $tpl_vars['nb_results'] = $count;
716 Tools
::logm('display ' . $view . ' view');
724 * update the password of the current user.
725 * if MODE_DEMO is TRUE, the password can't be updated.
726 * @todo add the return value
727 * @todo set the new password in function header like this updatePassword($newPassword)
730 public function updatePassword()
733 $this->messages
->add('i', _('in demo mode, you can\'t update your password'));
734 Tools
::logm('in demo mode, you can\'t do this');
735 Tools
::redirect('?view=config');
738 if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
739 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
740 $this->messages
->add('s', _('your password has been updated'));
741 $this->store
->updatePassword($this->user
->getId(), Tools
::encodeString($_POST['password'] . $this->user
->getUsername()));
743 Tools
::logm('password updated');
747 $this->messages
->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
748 Tools
::redirect('?view=config');
754 public function updateTheme()
757 if (empty($_POST['theme'])) {
760 # we are not going to change it to the current theme...
761 if ($_POST['theme'] == $this->getTheme()) {
762 $this->messages
->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
763 Tools
::redirect('?view=config');
766 $themes = $this->getInstalledThemes();
767 $actualTheme = false;
769 foreach (array_keys($themes) as $theme) {
770 if ($theme == $_POST['theme']) {
776 if (! $actualTheme) {
777 $this->messages
->add('e', _('that theme does not seem to be installed'));
778 Tools
::redirect('?view=config');
781 $this->store
->updateUserConfig($this->user
->getId(), 'theme', $_POST['theme']);
782 $this->messages
->add('s', _('you have changed your theme preferences'));
784 $currentConfig = $_SESSION['poche_user']->config
;
785 $currentConfig['theme'] = $_POST['theme'];
787 $_SESSION['poche_user']->setConfig($currentConfig);
791 Tools
::redirect('?view=config');
794 public function updateLanguage()
797 if (empty($_POST['language'])) {
800 # we are not going to change it to the current language...
801 if ($_POST['language'] == $this->getLanguage()) {
802 $this->messages
->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
803 Tools
::redirect('?view=config');
806 $languages = $this->getInstalledLanguages();
807 $actualLanguage = false;
809 foreach ($languages as $language) {
810 if ($language['value'] == $_POST['language']) {
811 $actualLanguage = true;
816 if (! $actualLanguage) {
817 $this->messages
->add('e', _('that language does not seem to be installed'));
818 Tools
::redirect('?view=config');
821 $this->store
->updateUserConfig($this->user
->getId(), 'language', $_POST['language']);
822 $this->messages
->add('s', _('you have changed your language preferences'));
824 $currentConfig = $_SESSION['poche_user']->config
;
825 $currentConfig['language'] = $_POST['language'];
827 $_SESSION['poche_user']->setConfig($currentConfig);
831 Tools
::redirect('?view=config');
834 * get credentials from differents sources
835 * it redirects the user to the $referer link
838 private function credentials() {
839 if(isset($_SERVER['PHP_AUTH_USER'])) {
840 return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
842 if(!empty($_POST['login']) && !empty($_POST['password'])) {
843 return array($_POST['login'],$_POST['password'],false);
845 if(isset($_SERVER['REMOTE_USER'])) {
846 return array($_SERVER['REMOTE_USER'],'http_auth',true);
849 return array(false,false,false);
853 * checks if login & password are correct and save the user in session.
854 * it redirects the user to the $referer link
855 * @param string $referer the url to redirect after login
856 * @todo add the return value
859 public function login($referer)
861 list($login,$password,$isauthenticated)=$this->credentials();
862 if($login === false || $password === false) {
863 $this->messages
->add('e', _('login failed: you have to fill all fields'));
864 Tools
::logm('login failed');
867 if (!empty($login) && !empty($password)) {
868 $user = $this->store
->login($login, Tools
::encodeString($password . $login), $isauthenticated);
869 if ($user != array()) {
870 # Save login into Session
871 $longlastingsession = isset($_POST['longlastingsession']);
872 $passwordTest = ($isauthenticated) ? $user['password'] : Tools
::encodeString($password . $login);
873 Session
::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
874 $this->messages
->add('s', _('welcome to your wallabag'));
875 Tools
::logm('login successful');
876 Tools
::redirect($referer);
878 $this->messages
->add('e', _('login failed: bad login or password'));
879 Tools
::logm('login failed');
885 * log out the poche user. It cleans the session.
886 * @todo add the return value
889 public function logout()
891 $this->user
= array();
893 Tools
::logm('logout');
898 * import datas into your poche
901 public function import() {
903 if ( isset($_FILES['file']) ) {
904 Tools
::logm('Import stated: parsing file');
906 // assume, that file is in json format
907 $str_data = file_get_contents($_FILES['file']['tmp_name']);
908 $data = json_decode($str_data, true);
910 if ( $data === null ) {
911 //not json - assume html
912 $html = new simple_html_dom();
913 $html->load_file($_FILES['file']['tmp_name']);
916 foreach (array('ol','ul') as $list) {
917 foreach ($html->find($list) as $ul) {
918 foreach ($ul->find('li') as $li) {
921 $tmpEntry['url'] = $a[0]->href
;
922 $tmpEntry['tags'] = $a[0]->tags
;
923 $tmpEntry['is_read'] = $read;
924 if ($tmpEntry['url']) {
928 # the second <ol/ul> is for read links
929 $read = ((sizeof($data) && $read)?0:1);
934 //for readability structure
935 foreach ($data as $record) {
936 if (is_array($record)) {
938 foreach ($record as $record2) {
939 if (is_array($record2)) {
946 $urlsInserted = array(); //urls of articles inserted
947 foreach ($data as $record) {
948 $url = trim( isset($record['article__url']) ? $record['article__url'] : (isset($record['url']) ? $record['url'] : '') );
949 if ( $url and !in_array($url, $urlsInserted) ) {
950 $title = (isset($record['title']) ? $record['title'] : _('Untitled - Import - ').'</a> <a href="./?import">'._('click to finish import').'</a><a>');
951 $body = (isset($record['content']) ? $record['content'] : '');
952 $isRead = (isset($record['is_read']) ? intval($record['is_read']) : (isset($record['archive'])?intval($record['archive']):0));
953 $isFavorite = (isset($record['is_fav']) ? intval($record['is_fav']) : (isset($record['favorite'])?intval($record['favorite']):0) );
955 $id = $this->store
->add($url, $title, $body, $this->user
->getId(), $isFavorite, $isRead);
957 $urlsInserted[] = $url; //add
959 if ( isset($record['tags']) && trim($record['tags']) ) {
967 $i = sizeof($urlsInserted);
969 $this->messages
->add('s', _('Articles inserted: ').$i._('. Please note, that some may be marked as "read".'));
971 Tools
::logm('Import of articles finished: '.$i.' articles added (w/o content if not provided).');
973 //file parsing finished here
975 //now download article contents if any
977 //check if we need to download any content
978 $recordsDownloadRequired = $this->store
->retrieveUnfetchedEntriesCount($this->user
->getId());
979 if ( $recordsDownloadRequired == 0 ) {
980 //nothing to download
981 $this->messages
->add('s', _('Import finished.'));
982 Tools
::logm('Import finished completely');
986 //if just inserted - don't download anything, download will start in next reload
987 if ( !isset($_FILES['file']) ) {
988 //download next batch
989 Tools
::logm('Fetching next batch of articles...');
990 $items = $this->store
->retrieveUnfetchedEntries($this->user
->getId(), IMPORT_LIMIT
);
992 $purifier = $this->getPurifier();
994 foreach ($items as $item) {
995 $url = new Url(base64_encode($item['url']));
996 Tools
::logm('Fetching article '.$item['id']);
997 $content = Tools
::getPageContent($url);
999 $title = (($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled'));
1000 $body = (($content['rss']['channel']['item']['description'] != '') ? $content['rss']['channel']['item']['description'] : _('Undefined'));
1002 //clean content to prevent xss attack
1003 $title = $purifier->purify($title);
1004 $body = $purifier->purify($body);
1006 $this->store
->updateContentAndTitle($item['id'], $title, $body, $this->user
->getId());
1007 Tools
::logm('Article '.$item['id'].' updated.');
1013 return array('includeImport'=>true, 'import'=>array('recordsDownloadRequired'=>$recordsDownloadRequired, 'recordsUnderDownload'=> IMPORT_LIMIT
, 'delay'=> IMPORT_DELAY
* 1000) );
1017 * export poche entries in json
1018 * @return json all poche entries
1020 public function export() {
1021 $filename = "wallabag-export-".$this->user
->getId()."-".date("Y-m-d").".json";
1022 header('Content-Disposition: attachment; filename='.$filename);
1024 $entries = $this->store
->retrieveAll($this->user
->getId());
1025 echo $this->tpl
->render('export.twig', array(
1026 'export' => Tools
::renderJson($entries),
1028 Tools
::logm('export view');
1032 * Checks online the latest version of poche and cache it
1033 * @param string $which 'prod' or 'dev'
1034 * @return string latest $which version
1036 private function getPocheVersion($which = 'prod') {
1037 $cache_file = CACHE
. '/' . $which;
1038 $check_time = time();
1040 # checks if the cached version file exists
1041 if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
1042 $version = file_get_contents($cache_file);
1043 $check_time = filemtime($cache_file);
1045 $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
1046 file_put_contents($cache_file, $version, LOCK_EX
);
1048 return array($version, $check_time);
1051 public function generateToken()
1053 if (ini_get('open_basedir') === '') {
1054 if (strtoupper(substr(PHP_OS
, 0, 3)) === 'WIN') {
1055 echo 'This is a server using Windows!';
1056 // alternative to /dev/urandom for Windows
1057 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1059 $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1063 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1066 $token = str_replace('+', '', $token);
1067 $this->store
->updateUserConfig($this->user
->getId(), 'token', $token);
1068 $currentConfig = $_SESSION['poche_user']->config
;
1069 $currentConfig['token'] = $token;
1070 $_SESSION['poche_user']->setConfig($currentConfig);
1074 public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
1076 $allowed_types = array('home', 'fav', 'archive', 'tag');
1077 $config = $this->store
->getConfigUser($user_id);
1079 if ($config == null) {
1080 die(_('User with this id (' . $user_id . ') does not exist.'));
1083 if (!in_array($type, $allowed_types) ||
1084 $token != $config['token']) {
1085 die(_('Uh, there is a problem while generating feeds.'));
1089 $feed = new FeedWriter(RSS2
);
1090 $feed->setTitle('wallabag — ' . $type . ' feed');
1091 $feed->setLink(Tools
::getPocheUrl());
1092 $feed->setChannelElement('pubDate', date(DATE_RSS
, time()));
1093 $feed->setChannelElement('generator', 'wallabag');
1094 $feed->setDescription('wallabag ' . $type . ' elements');
1096 if ($type == 'tag') {
1097 $entries = $this->store
->retrieveEntriesByTag($tag_id, $user_id);
1100 $entries = $this->store
->getEntriesByView($type, $user_id);
1103 if (count($entries) > 0) {
1104 foreach ($entries as $entry) {
1105 $newItem = $feed->createNewItem();
1106 $newItem->setTitle($entry['title']);
1107 $newItem->setSource(Tools
::getPocheUrl() . '?view=view&id=' . $entry['id']);
1108 $newItem->setLink($entry['url']);
1109 $newItem->setDate(time());
1110 $newItem->setDescription($entry['content']);
1111 $feed->addItem($newItem);
1115 $feed->genarateFeed();
1119 public function emptyCache() {
1120 $files = new RecursiveIteratorIterator(
1121 new RecursiveDirectoryIterator(CACHE
, RecursiveDirectoryIterator
::SKIP_DOTS
),
1122 RecursiveIteratorIterator
::CHILD_FIRST
1125 foreach ($files as $fileinfo) {
1126 $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
1127 $todo($fileinfo->getRealPath());
1130 Tools
::logm('empty cache');
1131 $this->messages
->add('s', _('Cache deleted.'));
1136 * return new purifier object with actual config
1138 protected function getPurifier() {
1139 $config = HTMLPurifier_Config
::createDefault();
1140 $config->set('Cache.SerializerPath', CACHE
);
1141 $config->set('HTML.SafeIframe', true);
1142 $config->set('URI.SafeIframeRegexp', '%^(https?:)?//(www\.youtube(?:-nocookie)?\.com/embed/|player\.vimeo\.com/video/)%'); //allow YouTube and Vimeo$purifier = new HTMLPurifier($config);
1144 return new HTMLPurifier($config);