wallabag/inc/poche/Poche.class.php

1081 lines
40 KiB
PHP
Raw Normal View History

2013-08-04 18:58:31 +00:00
<?php
/**
2014-01-28 09:36:04 +00:00
* wallabag, self hostable application allowing you to not miss any content anymore
2013-08-04 18:58:31 +00:00
*
2014-01-28 09:36:04 +00:00
* @category wallabag
* @author Nicolas Lœuillet <nicolas@loeuillet.org>
2013-08-04 18:58:31 +00:00
* @copyright 2013
* @license http://www.wtfpl.net/ see COPYING file
*/
class Poche
{
2013-09-20 08:21:39 +00:00
public static $canRenderTemplates = true;
public static $configFileAvailable = true;
2013-08-06 12:18:03 +00:00
public $user;
2013-08-04 18:58:31 +00:00
public $store;
public $tpl;
2013-08-05 13:54:37 +00:00
public $messages;
2013-08-05 19:56:32 +00:00
public $pagination;
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
private $currentTheme = '';
private $currentLanguage = '';
private $notInstalledMessage = array();
2013-08-04 18:58:31 +00:00
private $language_names = array(
'cs_CZ.utf8' => 'čeština',
'de_DE.utf8' => 'German',
'en_EN.utf8' => 'English',
'es_ES.utf8' => 'Español',
'fa_IR.utf8' => 'فارسی',
'fr_FR.utf8' => 'Français',
'it_IT.utf8' => 'Italiano',
'pl_PL.utf8' => 'Polski',
'pt_BR.utf8' => 'Português (Brasil)',
'ru_RU.utf8' => 'Pусский',
'sl_SI.utf8' => 'Slovenščina',
'uk_UA.utf8' => 'Українська',
);
2013-09-20 08:21:39 +00:00
public function __construct()
2013-08-04 18:58:31 +00:00
{
if ($this->configFileIsAvailable()) {
$this->init();
2013-09-20 08:21:39 +00:00
}
2014-04-02 17:55:19 +00:00
if ($this->themeIsInstalled()) {
$this->initTpl();
2013-09-20 08:21:39 +00:00
}
2014-04-02 17:55:19 +00:00
if ($this->systemIsInstalled()) {
$this->store = new Database();
$this->messages = new Messages();
# installation
if (! $this->store->isInstalled()) {
$this->install();
}
2013-12-23 09:35:09 +00:00
$this->store->checkTags();
2013-08-04 18:58:31 +00:00
}
}
2014-04-02 17:55:19 +00:00
private function init()
2013-09-20 08:21:39 +00:00
{
Tools::initPhp();
2013-08-04 18:58:31 +00:00
2013-09-20 08:21:39 +00:00
if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
$this->user = $_SESSION['poche_user'];
} else {
# fake user, just for install & login screens
$this->user = new User();
$this->user->setConfig($this->getDefaultConfig());
}
# l10n
$language = $this->user->getConfigValue('language');
putenv('LC_ALL=' . $language);
setlocale(LC_ALL, $language);
2014-04-02 17:55:19 +00:00
bindtextdomain($language, LOCALE);
textdomain($language);
2013-09-20 08:21:39 +00:00
# Pagination
$this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
# Set up theme
$themeDirectory = $this->user->getConfigValue('theme');
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
if ($themeDirectory === false) {
$themeDirectory = DEFAULT_THEME;
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$this->currentTheme = $themeDirectory;
# Set up language
$languageDirectory = $this->user->getConfigValue('language');
2014-04-02 17:55:19 +00:00
if ($languageDirectory === false) {
$languageDirectory = DEFAULT_THEME;
}
2014-04-02 17:55:19 +00:00
$this->currentLanguage = $languageDirectory;
2013-09-20 08:21:39 +00:00
}
public function configFileIsAvailable() {
if (! self::$configFileAvailable) {
$this->notInstalledMessage[] = 'You have to copy (don\'t just rename!) inc/poche/config.inc.default.php to inc/poche/config.inc.php.';
2013-09-20 08:21:39 +00:00
return false;
}
return true;
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
public function themeIsInstalled() {
$passTheme = TRUE;
2013-09-20 08:21:39 +00:00
# Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
if (! self::$canRenderTemplates) {
2014-02-13 17:57:57 +00:00
$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.';
$passTheme = FALSE;
2013-09-20 08:21:39 +00:00
}
2013-10-03 12:23:03 +00:00
if (! is_writable(CACHE)) {
$this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
2013-10-03 12:23:03 +00:00
self::$canRenderTemplates = false;
$passTheme = FALSE;
2014-04-02 17:55:19 +00:00
}
2013-09-20 08:21:39 +00:00
# Check if the selected theme and its requirements are present
2014-01-28 10:19:06 +00:00
$theme = $this->getTheme();
if ($theme != '' && ! is_dir(THEME . '/' . $theme)) {
$this->notInstalledMessage[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $theme . ')';
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
self::$canRenderTemplates = false;
2014-04-02 17:55:19 +00:00
$passTheme = FALSE;
2013-09-20 08:21:39 +00:00
}
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
$themeInfo = $this->getThemeInfo($theme);
if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
foreach ($themeInfo['requirements'] as $requiredTheme) {
if (! is_dir(THEME . '/' . $requiredTheme)) {
$this->notInstalledMessage[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
self::$canRenderTemplates = false;
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
$passTheme = FALSE;
}
2013-09-20 08:21:39 +00:00
}
}
if (!$passTheme) {
return FALSE;
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
return true;
}
2014-04-02 17:55:19 +00:00
2013-08-15 08:54:14 +00:00
/**
* all checks before installation.
2013-09-20 08:21:39 +00:00
* @todo move HTML to template
2014-04-02 17:55:19 +00:00
* @return boolean
2013-08-15 08:54:14 +00:00
*/
2013-09-20 08:21:39 +00:00
public function systemIsInstalled()
2013-08-04 18:58:31 +00:00
{
$msg = TRUE;
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$configSalt = defined('SALT') ? constant('SALT') : '';
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
if (empty($configSalt)) {
$this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
$msg = FALSE;
}
if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
2013-09-20 08:21:39 +00:00
Tools::logm('sqlite file doesn\'t exist');
$this->notInstalledMessage[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
$msg = FALSE;
}
if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
$this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
$msg = FALSE;
}
if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
2013-08-16 18:19:31 +00:00
Tools::logm('you don\'t have write access on sqlite file');
$this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
$msg = FALSE;
2013-08-16 18:19:31 +00:00
}
2013-09-20 08:21:39 +00:00
if (! $msg) {
2013-09-20 08:21:39 +00:00
return false;
2013-08-06 13:51:48 +00:00
}
2013-08-06 12:18:03 +00:00
2013-09-20 08:21:39 +00:00
return true;
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
public function getNotInstalledMessage() {
return $this->notInstalledMessage;
2013-08-15 08:54:14 +00:00
}
2013-08-04 18:58:31 +00:00
2013-08-15 08:54:14 +00:00
private function initTpl()
{
2013-09-20 08:21:39 +00:00
$loaderChain = new Twig_Loader_Chain();
2014-01-28 10:19:06 +00:00
$theme = $this->getTheme();
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
# add the current theme as first to the loader chain so Twig will look there first for overridden template files
try {
2014-01-28 10:19:06 +00:00
$loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $theme));
2013-09-20 08:21:39 +00:00
} catch (Twig_Error_Loader $e) {
# @todo isInstalled() should catch this, inject Twig later
2014-01-28 10:19:06 +00:00
die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME . '/' . $theme .' is missing)');
2013-09-20 08:21:39 +00:00
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
# add all required themes to the loader chain
2014-01-28 10:19:06 +00:00
$themeInfo = $this->getThemeInfo($theme);
if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
foreach ($themeInfo['requirements'] as $requiredTheme) {
try {
$loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $requiredTheme));
} catch (Twig_Error_Loader $e) {
# @todo isInstalled() should catch this, inject Twig later
die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
}
2013-09-20 08:21:39 +00:00
}
}
2014-04-02 17:55:19 +00:00
2013-08-07 12:24:07 +00:00
if (DEBUG_POCHE) {
2014-01-28 10:19:06 +00:00
$twigParams = array();
2013-09-20 08:21:39 +00:00
} else {
2014-01-28 10:19:06 +00:00
$twigParams = array('cache' => CACHE);
2013-08-07 12:24:07 +00:00
}
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
$this->tpl = new Twig_Environment($loaderChain, $twigParams);
2013-08-04 18:58:31 +00:00
$this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
2014-04-02 17:55:19 +00:00
2013-08-05 13:54:37 +00:00
# filter to display domain name of an url
$filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
$this->tpl->addFilter($filter);
2013-08-04 18:58:31 +00:00
2013-08-09 06:25:16 +00:00
# filter for reading time
$filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
$this->tpl->addFilter($filter);
2013-08-04 18:58:31 +00:00
}
2014-01-28 10:19:06 +00:00
private function install()
2013-08-04 18:58:31 +00:00
{
Tools::logm('poche still not installed');
echo $this->tpl->render('install.twig', array(
2013-09-20 08:21:39 +00:00
'token' => Session::getToken(),
'theme' => $this->getTheme(),
'poche_url' => Tools::getPocheUrl()
2013-08-04 18:58:31 +00:00
));
if (isset($_GET['install'])) {
2014-04-02 17:55:19 +00:00
if (($_POST['password'] == $_POST['password_repeat'])
2013-08-04 18:58:31 +00:00
&& $_POST['password'] != "" && $_POST['login'] != "") {
# let's rock, install poche baby !
2013-08-16 18:19:31 +00:00
if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
{
Session::logout();
Tools::logm('poche is now installed');
Tools::redirect();
}
2013-08-05 19:56:32 +00:00
}
else {
Tools::logm('error during installation');
2013-08-04 18:58:31 +00:00
Tools::redirect();
}
}
exit();
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
public function getTheme() {
return $this->currentTheme;
}
2014-01-28 10:19:06 +00:00
/**
* Provides theme information by parsing theme.ini file if present in the theme's root directory.
* In all cases, the following data will be returned:
* - name: theme's name, or key if the theme is unnamed,
* - current: boolean informing if the theme is the current user theme.
*
* @param string $theme Theme key (directory name)
* @return array|boolean Theme information, or false if the theme doesn't exist.
*/
public function getThemeInfo($theme) {
if (!is_dir(THEME . '/' . $theme)) {
return false;
}
$themeIniFile = THEME . '/' . $theme . '/theme.ini';
$themeInfo = array();
if (is_file($themeIniFile) && is_readable($themeIniFile)) {
$themeInfo = parse_ini_file($themeIniFile);
}
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
if ($themeInfo === false) {
$themeInfo = array();
}
if (!isset($themeInfo['name'])) {
$themeInfo['name'] = $theme;
}
$themeInfo['current'] = ($theme === $this->getTheme());
return $themeInfo;
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
public function getInstalledThemes() {
$handle = opendir(THEME);
$themes = array();
2014-01-28 10:19:06 +00:00
2013-09-20 08:21:39 +00:00
while (($theme = readdir($handle)) !== false) {
# Themes are stored in a directory, so all directory names are themes
# @todo move theme installation data to database
2014-01-28 10:19:06 +00:00
if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
2013-09-20 08:21:39 +00:00
continue;
}
2014-01-28 10:19:06 +00:00
$themes[$theme] = $this->getThemeInfo($theme);
2013-09-20 08:21:39 +00:00
}
2014-01-28 10:19:06 +00:00
2014-02-20 12:29:53 +00:00
ksort($themes);
2013-09-20 08:21:39 +00:00
return $themes;
}
2013-08-04 18:58:31 +00:00
2014-01-28 10:19:06 +00:00
public function getLanguage() {
return $this->currentLanguage;
}
public function getInstalledLanguages() {
$handle = opendir(LOCALE);
$languages = array();
2014-04-02 17:55:19 +00:00
while (($language = readdir($handle)) !== false) {
# Languages are stored in a directory, so all directory names are languages
# @todo move language installation data to database
if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.', 'tools'))) {
continue;
}
2014-04-02 17:55:19 +00:00
$current = false;
2014-04-02 17:55:19 +00:00
if ($language === $this->getLanguage()) {
$current = true;
}
2014-04-02 17:55:19 +00:00
$languages[] = array('name' => (isset($this->language_names[$language]) ? $this->language_names[$language] : $language), 'value' => $language, 'current' => $current);
}
2014-04-02 17:55:19 +00:00
return $languages;
}
2013-08-06 13:51:48 +00:00
public function getDefaultConfig()
2014-04-02 17:55:19 +00:00
{
2013-08-06 13:51:48 +00:00
return array(
'pager' => PAGINATION,
'language' => LANG,
2013-09-20 08:21:39 +00:00
'theme' => DEFAULT_THEME
);
2013-08-06 13:51:48 +00:00
}
2013-08-04 18:58:31 +00:00
/**
* Call action (mark as fav, archive, delete, etc.)
*/
public function action($action, Url $url, $id = 0, $import = FALSE, $autoclose = FALSE, $tags = null)
2013-08-04 18:58:31 +00:00
{
switch ($action)
{
case 'add':
2014-04-03 09:18:49 +00:00
$content = Tools::getPageContent($url);
$title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
$body = $content['rss']['channel']['item']['description'];
// clean content from prevent xss attack
$purifier = $this->getPurifier();
2014-04-03 09:18:49 +00:00
$title = $purifier->purify($title);
$body = $purifier->purify($body);
2014-04-02 17:55:19 +00:00
//search for possible duplicate
$duplicate = NULL;
2014-04-03 09:18:49 +00:00
$duplicate = $this->store->retrieveOneByURL($url->getUrl(), $this->user->getId());
2014-04-02 17:55:19 +00:00
$last_id = $this->store->add($url->getUrl(), $title, $body, $this->user->getId());
2014-04-03 09:18:49 +00:00
if ( $last_id ) {
Tools::logm('add link ' . $url->getUrl());
if (DOWNLOAD_PICTURES) {
$content = filtre_picture($body, $url->getUrl(), $last_id);
Tools::logm('updating content article');
$this->store->updateContent($last_id, $content, $this->user->getId());
}
if ($duplicate != NULL) {
// 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
Tools::logm('link ' . $url->getUrl() . ' is a duplicate');
// 1) - preserve tags and favorite, then drop old entry
$this->store->reassignTags($duplicate['id'], $last_id);
if ($duplicate['is_fav']) {
$this->store->favoriteById($last_id, $this->user->getId());
}
if ($this->store->deleteById($duplicate['id'], $this->user->getId())) {
Tools::logm('previous link ' . $url->getUrl() .' entry deleted');
}
}
2014-04-02 17:55:19 +00:00
$this->messages->add('s', _('the link has been added successfully'));
2013-08-04 18:58:31 +00:00
}
else {
2014-04-03 09:18:49 +00:00
$this->messages->add('e', _('error during insertion : the link wasn\'t added'));
Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
2013-08-07 17:14:28 +00:00
}
2014-04-03 09:18:49 +00:00
if ($autoclose == TRUE) {
Tools::redirect('?view=home');
} else {
Tools::redirect('?view=home&closewin=true');
2013-08-04 18:58:31 +00:00
}
break;
case 'delete':
2013-08-07 12:24:07 +00:00
$msg = 'delete link #' . $id;
2013-08-06 13:51:48 +00:00
if ($this->store->deleteById($id, $this->user->getId())) {
2013-08-04 18:58:31 +00:00
if (DOWNLOAD_PICTURES) {
remove_directory(ABS_PATH . $id);
}
2013-08-05 19:56:32 +00:00
$this->messages->add('s', _('the link has been deleted successfully'));
2013-08-04 18:58:31 +00:00
}
else {
2013-08-05 19:56:32 +00:00
$this->messages->add('e', _('the link wasn\'t deleted'));
2013-08-07 12:24:07 +00:00
$msg = 'error : can\'t delete link #' . $id;
2013-08-04 18:58:31 +00:00
}
2013-08-07 12:24:07 +00:00
Tools::logm($msg);
Tools::redirect('?');
2013-08-04 18:58:31 +00:00
break;
case 'toggle_fav' :
2013-08-06 13:51:48 +00:00
$this->store->favoriteById($id, $this->user->getId());
2013-08-04 18:58:31 +00:00
Tools::logm('mark as favorite link #' . $id);
if ( Tools::isAjaxRequest() ) {
echo 1;
exit;
}
else {
Tools::redirect();
}
2013-08-04 18:58:31 +00:00
break;
case 'toggle_archive' :
2013-08-06 13:51:48 +00:00
$this->store->archiveById($id, $this->user->getId());
2013-08-04 18:58:31 +00:00
Tools::logm('archive link #' . $id);
if ( Tools::isAjaxRequest() ) {
echo 1;
exit;
}
else {
Tools::redirect();
}
2013-08-04 18:58:31 +00:00
break;
2014-02-12 20:52:01 +00:00
case 'archive_all' :
$this->store->archiveAll($this->user->getId());
Tools::logm('archive all links');
2014-04-03 09:18:49 +00:00
Tools::redirect();
2014-02-12 20:52:01 +00:00
break;
case 'add_tag' :
2014-04-03 09:18:49 +00:00
$tags = explode(',', $_POST['value']);
$entry_id = $_POST['entry_id'];
2014-02-19 12:25:28 +00:00
$entry = $this->store->retrieveOneById($entry_id, $this->user->getId());
if (!$entry) {
$this->messages->add('e', _('Article not found!'));
Tools::logm('error : article not found');
Tools::redirect();
}
//get all already set tags to preven duplicates
$already_set_tags = array();
$entry_tags = $this->store->retrieveTagsByEntry($entry_id);
foreach ($entry_tags as $tag) {
$already_set_tags[] = $tag['value'];
}
foreach($tags as $key => $tag_value) {
$value = trim($tag_value);
if ($value && !in_array($value, $already_set_tags)) {
$tag = $this->store->retrieveTagByValue($value);
if (is_null($tag)) {
# we create the tag
$tag = $this->store->createTag($value);
$sequence = '';
if (STORAGE == 'postgres') {
$sequence = 'tags_id_seq';
}
$tag_id = $this->store->getLastId($sequence);
}
else {
$tag_id = $tag['id'];
}
# we assign the tag to the article
$this->store->setTagToEntry($tag_id, $entry_id);
}
}
2014-04-03 09:18:49 +00:00
Tools::redirect();
break;
case 'remove_tag' :
$tag_id = $_GET['tag_id'];
2014-02-19 12:25:28 +00:00
$entry = $this->store->retrieveOneById($id, $this->user->getId());
if (!$entry) {
$this->messages->add('e', _('Article not found!'));
Tools::logm('error : article not found');
Tools::redirect();
}
$this->store->removeTagForEntry($id, $tag_id);
Tools::redirect();
break;
2013-08-04 18:58:31 +00:00
default:
break;
}
}
function displayView($view, $id = 0)
{
$tpl_vars = array();
switch ($view)
{
case 'config':
$dev_infos = $this->getPocheVersion('dev');
$dev = trim($dev_infos[0]);
$check_time_dev = date('d-M-Y H:i', $dev_infos[1]);
$prod_infos = $this->getPocheVersion('prod');
$prod = trim($prod_infos[0]);
$check_time_prod = date('d-M-Y H:i', $prod_infos[1]);
$compare_dev = version_compare(POCHE, $dev);
$compare_prod = version_compare(POCHE, $prod);
2013-09-20 08:21:39 +00:00
$themes = $this->getInstalledThemes();
$languages = $this->getInstalledLanguages();
$token = $this->user->getConfigValue('token');
$http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
$tpl_vars = array(
2013-09-20 08:21:39 +00:00
'themes' => $themes,
'languages' => $languages,
'dev' => $dev,
'prod' => $prod,
'check_time_dev' => $check_time_dev,
'check_time_prod' => $check_time_prod,
'compare_dev' => $compare_dev,
'compare_prod' => $compare_prod,
'token' => $token,
'user_id' => $this->user->getId(),
2013-10-20 14:53:54 +00:00
'http_auth' => $http_auth,
);
2013-08-04 18:58:31 +00:00
Tools::logm('config view');
break;
2013-12-06 13:03:14 +00:00
case 'edit-tags':
# tags
2014-02-19 12:25:28 +00:00
$entry = $this->store->retrieveOneById($id, $this->user->getId());
if (!$entry) {
$this->messages->add('e', _('Article not found!'));
Tools::logm('error : article not found');
Tools::redirect();
}
2013-12-06 13:03:14 +00:00
$tags = $this->store->retrieveTagsByEntry($id);
$tpl_vars = array(
'entry_id' => $id,
2013-12-06 13:03:14 +00:00
'tags' => $tags,
'entry' => $entry,
);
break;
2013-12-06 12:15:06 +00:00
case 'tags':
2013-12-06 13:37:42 +00:00
$token = $this->user->getConfigValue('token');
//if term is set - search tags for this term
$term = Tools::checkVar('term');
$tags = $this->store->retrieveAllTags($this->user->getId(), $term);
if (Tools::isAjaxRequest()) {
$result = array();
foreach ($tags as $tag) {
$result[] = $tag['value'];
}
echo json_encode($result);
exit;
}
2013-12-06 12:15:06 +00:00
$tpl_vars = array(
2013-12-06 13:37:42 +00:00
'token' => $token,
'user_id' => $this->user->getId(),
2013-12-06 12:15:06 +00:00
'tags' => $tags,
);
break;
2014-04-02 19:33:06 +00:00
case 'search':
if (isset($_GET['search'])) {
$search = filter_var($_GET['search'], FILTER_SANITIZE_STRING);
$tpl_vars['entries'] = $this->store->search($search, $this->user->getId());
$count = count($tpl_vars['entries']);
$this->pagination->set_total($count);
$page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
$this->pagination->page_links('?view=' . $view . '?search=' . $search . '&sort=' . $_SESSION['sort'] . '&' ));
$tpl_vars['page_links'] = $page_links;
$tpl_vars['nb_results'] = $count;
$tpl_vars['search_term'] = $search;
}
break;
2013-08-04 18:58:31 +00:00
case 'view':
2013-08-06 13:51:48 +00:00
$entry = $this->store->retrieveOneById($id, $this->user->getId());
2013-08-04 18:58:31 +00:00
if ($entry != NULL) {
Tools::logm('view link #' . $id);
$content = $entry['content'];
if (function_exists('tidy_parse_string')) {
$tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
$tidy->cleanRepair();
$content = $tidy->value;
}
# flattr checking
$flattr = new FlattrItem();
2013-12-06 12:02:38 +00:00
$flattr->checkItem($entry['url'], $entry['id']);
# tags
$tags = $this->store->retrieveTagsByEntry($entry['id']);
$tpl_vars = array(
2013-12-06 12:02:38 +00:00
'entry' => $entry,
'content' => $content,
'flattr' => $flattr,
'tags' => $tags
);
2013-08-04 18:58:31 +00:00
}
else {
2013-08-09 20:15:40 +00:00
Tools::logm('error in view call : entry is null');
2013-08-04 18:58:31 +00:00
}
break;
default: # home, favorites, archive and tag views
2013-08-04 18:58:31 +00:00
$tpl_vars = array(
'entries' => '',
'page_links' => '',
2013-08-28 17:12:11 +00:00
'nb_results' => '',
'listmode' => (isset($_COOKIE['listmode']) ? true : false),
2013-08-04 18:58:31 +00:00
);
2014-04-02 17:55:19 +00:00
//if id is given - we retrive entries by tag: id is tag id
if ($id) {
$tpl_vars['tag'] = $this->store->retrieveTag($id, $this->user->getId());
$tpl_vars['id'] = intval($id);
}
$count = $this->store->getEntriesByViewCount($view, $this->user->getId(), $id);
if ($count > 0) {
$this->pagination->set_total($count);
$page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
$this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . (($id)?'&id='.$id:'') . '&' ));
$tpl_vars['entries'] = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit(), $id);
$tpl_vars['page_links'] = $page_links;
$tpl_vars['nb_results'] = $count;
}
2013-08-05 19:56:32 +00:00
Tools::logm('display ' . $view . ' view');
2013-08-04 18:58:31 +00:00
break;
}
return $tpl_vars;
}
2013-08-08 10:33:02 +00:00
/**
2014-04-02 17:55:19 +00:00
* update the password of the current user.
* if MODE_DEMO is TRUE, the password can't be updated.
2013-08-08 10:33:02 +00:00
* @todo add the return value
* @todo set the new password in function header like this updatePassword($newPassword)
* @return boolean
*/
public function updatePassword()
{
2013-08-05 13:54:37 +00:00
if (MODE_DEMO) {
2013-08-06 13:51:48 +00:00
$this->messages->add('i', _('in demo mode, you can\'t update your password'));
2013-08-05 13:54:37 +00:00
Tools::logm('in demo mode, you can\'t do this');
2013-08-05 19:56:32 +00:00
Tools::redirect('?view=config');
2013-08-05 13:54:37 +00:00
}
else {
if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
2013-08-06 13:51:48 +00:00
$this->messages->add('s', _('your password has been updated'));
$this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
Session::logout();
2013-08-06 13:51:48 +00:00
Tools::logm('password updated');
Tools::redirect();
}
else {
2013-08-06 13:51:48 +00:00
$this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
2013-08-05 19:56:32 +00:00
Tools::redirect('?view=config');
}
}
}
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
public function updateTheme()
{
# no data
if (empty($_POST['theme'])) {
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
# we are not going to change it to the current theme...
if ($_POST['theme'] == $this->getTheme()) {
$this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
Tools::redirect('?view=config');
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$themes = $this->getInstalledThemes();
$actualTheme = false;
2014-04-02 17:55:19 +00:00
2014-01-28 10:19:06 +00:00
foreach (array_keys($themes) as $theme) {
if ($theme == $_POST['theme']) {
2013-09-20 08:21:39 +00:00
$actualTheme = true;
break;
}
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
if (! $actualTheme) {
$this->messages->add('e', _('that theme does not seem to be installed'));
Tools::redirect('?view=config');
}
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
$this->messages->add('s', _('you have changed your theme preferences'));
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$currentConfig = $_SESSION['poche_user']->config;
$currentConfig['theme'] = $_POST['theme'];
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
$_SESSION['poche_user']->setConfig($currentConfig);
$this->emptyCache();
2014-04-02 17:55:19 +00:00
2013-09-20 08:21:39 +00:00
Tools::redirect('?view=config');
}
public function updateLanguage()
{
# no data
if (empty($_POST['language'])) {
}
2014-04-02 17:55:19 +00:00
# we are not going to change it to the current language...
if ($_POST['language'] == $this->getLanguage()) {
$this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
Tools::redirect('?view=config');
}
2014-04-02 17:55:19 +00:00
$languages = $this->getInstalledLanguages();
$actualLanguage = false;
2014-04-02 17:55:19 +00:00
foreach ($languages as $language) {
if ($language['value'] == $_POST['language']) {
$actualLanguage = true;
break;
}
}
2014-04-02 17:55:19 +00:00
if (! $actualLanguage) {
$this->messages->add('e', _('that language does not seem to be installed'));
Tools::redirect('?view=config');
}
2014-04-02 17:55:19 +00:00
$this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
$this->messages->add('s', _('you have changed your language preferences'));
2014-04-02 17:55:19 +00:00
$currentConfig = $_SESSION['poche_user']->config;
$currentConfig['language'] = $_POST['language'];
2014-04-02 17:55:19 +00:00
$_SESSION['poche_user']->setConfig($currentConfig);
$this->emptyCache();
2014-04-02 17:55:19 +00:00
Tools::redirect('?view=config');
2014-04-02 17:55:19 +00:00
}
2013-10-20 14:53:54 +00:00
/**
* get credentials from differents sources
* it redirects the user to the $referer link
* @return array
*/
private function credentials() {
if(isset($_SERVER['PHP_AUTH_USER'])) {
return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
}
if(!empty($_POST['login']) && !empty($_POST['password'])) {
return array($_POST['login'],$_POST['password'],false);
}
if(isset($_SERVER['REMOTE_USER'])) {
return array($_SERVER['REMOTE_USER'],'http_auth',true);
}
2013-12-23 09:35:09 +00:00
return array(false,false,false);
}
2013-10-20 14:53:54 +00:00
2013-08-08 10:33:02 +00:00
/**
* checks if login & password are correct and save the user in session.
* it redirects the user to the $referer link
* @param string $referer the url to redirect after login
* @todo add the return value
* @return boolean
*/
public function login($referer)
{
list($login,$password,$isauthenticated)=$this->credentials();
2013-10-20 14:53:54 +00:00
if($login === false || $password === false) {
$this->messages->add('e', _('login failed: you have to fill all fields'));
Tools::logm('login failed');
Tools::redirect();
}
if (!empty($login) && !empty($password)) {
$user = $this->store->login($login, Tools::encodeString($password . $login), $isauthenticated);
2013-08-06 12:18:03 +00:00
if ($user != array()) {
# Save login into Session
$longlastingsession = isset($_POST['longlastingsession']);
$passwordTest = ($isauthenticated) ? $user['password'] : Tools::encodeString($password . $login);
Session::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
$this->messages->add('s', _('welcome to your wallabag'));
2013-08-06 13:51:48 +00:00
Tools::logm('login successful');
Tools::redirect($referer);
}
2013-08-06 13:51:48 +00:00
$this->messages->add('e', _('login failed: bad login or password'));
Tools::logm('login failed');
Tools::redirect();
}
}
2013-08-08 10:33:02 +00:00
/**
* log out the poche user. It cleans the session.
* @todo add the return value
2014-04-02 17:55:19 +00:00
* @return boolean
2013-08-08 10:33:02 +00:00
*/
public function logout()
{
2013-08-06 12:18:03 +00:00
$this->user = array();
Session::logout();
2013-08-07 17:14:28 +00:00
Tools::logm('logout');
Tools::redirect();
}
2013-08-08 10:33:02 +00:00
/**
* import datas into your poche
2014-04-02 17:55:19 +00:00
* @return boolean
2013-08-08 10:33:02 +00:00
*/
2014-04-02 17:55:19 +00:00
public function import() {
if ( isset($_FILES['file']) ) {
Tools::logm('Import stated: parsing file');
2014-04-02 17:55:19 +00:00
// assume, that file is in json format
$str_data = file_get_contents($_FILES['file']['tmp_name']);
$data = json_decode($str_data, true);
if ( $data === null ) {
//not json - assume html
$html = new simple_html_dom();
$html->load_file($_FILES['file']['tmp_name']);
$data = array();
$read = 0;
foreach (array('ol','ul') as $list) {
foreach ($html->find($list) as $ul) {
foreach ($ul->find('li') as $li) {
$tmpEntry = array();
$a = $li->find('a');
$tmpEntry['url'] = $a[0]->href;
$tmpEntry['tags'] = $a[0]->tags;
$tmpEntry['is_read'] = $read;
if ($tmpEntry['url']) {
$data[] = $tmpEntry;
}
}
# the second <ol/ul> is for read links
$read = ((sizeof($data) && $read)?0:1);
2014-04-02 17:55:19 +00:00
}
}
2013-08-04 20:35:08 +00:00
}
2014-04-02 17:55:19 +00:00
2014-04-03 09:18:49 +00:00
//for readability structure
foreach ($data as $record) {
if (is_array($record)) {
$data[] = $record;
foreach ($record as $record2) {
if (is_array($record2)) {
$data[] = $record2;
2014-04-03 09:18:49 +00:00
}
}
}
}
$urlsInserted = array(); //urls of articles inserted
2014-04-02 17:55:19 +00:00
foreach ($data as $record) {
2014-04-03 09:18:49 +00:00
$url = trim( isset($record['article__url']) ? $record['article__url'] : (isset($record['url']) ? $record['url'] : '') );
if ( $url and !in_array($url, $urlsInserted) ) {
2014-04-02 17:55:19 +00:00
$title = (isset($record['title']) ? $record['title'] : _('Untitled - Import - ').'</a> <a href="./?import">'._('click to finish import').'</a><a>');
$body = (isset($record['content']) ? $record['content'] : '');
2014-04-03 09:18:49 +00:00
$isRead = (isset($record['is_read']) ? intval($record['is_read']) : (isset($record['archive'])?intval($record['archive']):0));
$isFavorite = (isset($record['is_fav']) ? intval($record['is_fav']) : (isset($record['favorite'])?intval($record['favorite']):0) );
2014-04-02 17:55:19 +00:00
//insert new record
$id = $this->store->add($url, $title, $body, $this->user->getId(), $isFavorite, $isRead);
if ( $id ) {
$urlsInserted[] = $url; //add
2014-04-02 17:55:19 +00:00
if ( isset($record['tags']) && trim($record['tags']) ) {
//@TODO: set tags
2014-04-02 17:55:19 +00:00
}
}
}
}
$i = sizeof($urlsInserted);
2014-04-02 17:55:19 +00:00
if ( $i > 0 ) {
$this->messages->add('s', _('Articles inserted: ').$i._('. Please note, that some may be marked as "read".'));
}
Tools::logm('Import of articles finished: '.$i.' articles added (w/o content if not provided).');
2014-04-02 17:55:19 +00:00
}
//file parsing finished here
//now download article contents if any
//check if we need to download any content
$recordsDownloadRequired = $this->store->retrieveUnfetchedEntriesCount($this->user->getId());
if ( $recordsDownloadRequired == 0 ) {
//nothing to download
$this->messages->add('s', _('Import finished.'));
Tools::logm('Import finished completely');
2014-04-02 17:55:19 +00:00
Tools::redirect();
}
else {
//if just inserted - don't download anything, download will start in next reload
if ( !isset($_FILES['file']) ) {
//download next batch
Tools::logm('Fetching next batch of articles...');
2014-04-02 17:55:19 +00:00
$items = $this->store->retrieveUnfetchedEntries($this->user->getId(), IMPORT_LIMIT);
$purifier = $this->getPurifier();
2014-04-02 17:55:19 +00:00
foreach ($items as $item) {
$url = new Url(base64_encode($item['url']));
Tools::logm('Fetching article '.$item['id']);
$content = Tools::getPageContent($url);
2014-04-02 17:55:19 +00:00
$title = (($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled'));
$body = (($content['rss']['channel']['item']['description'] != '') ? $content['rss']['channel']['item']['description'] : _('Undefined'));
2014-04-02 17:55:19 +00:00
//clean content to prevent xss attack
$title = $purifier->purify($title);
$body = $purifier->purify($body);
2014-04-02 17:55:19 +00:00
$this->store->updateContentAndTitle($item['id'], $title, $body, $this->user->getId());
Tools::logm('Article '.$item['id'].' updated.');
2014-04-02 17:55:19 +00:00
}
2013-08-04 20:35:08 +00:00
}
2014-04-02 17:55:19 +00:00
}
return array('includeImport'=>true, 'import'=>array('recordsDownloadRequired'=>$recordsDownloadRequired, 'recordsUnderDownload'=> IMPORT_LIMIT, 'delay'=> IMPORT_DELAY * 1000) );
2013-08-04 20:35:08 +00:00
}
2013-08-08 10:33:02 +00:00
/**
* export poche entries in json
* @return json all poche entries
*/
public function export() {
$filename = "wallabag-export-".$this->user->getId()."-".date("Y-m-d").".json";
header('Content-Disposition: attachment; filename='.$filename);
$entries = $this->store->retrieveAll($this->user->getId());
echo $this->tpl->render('export.twig', array(
'export' => Tools::renderJson($entries),
));
Tools::logm('export view');
}
2013-08-08 10:33:02 +00:00
/**
2013-08-08 11:49:57 +00:00
* Checks online the latest version of poche and cache it
2013-08-08 10:33:02 +00:00
* @param string $which 'prod' or 'dev'
* @return string latest $which version
*/
private function getPocheVersion($which = 'prod') {
$cache_file = CACHE . '/' . $which;
$check_time = time();
# checks if the cached version file exists
if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
$version = file_get_contents($cache_file);
$check_time = filemtime($cache_file);
} else {
$version = file_get_contents('http://static.wallabag.org/versions/' . $which);
file_put_contents($cache_file, $version, LOCK_EX);
}
return array($version, $check_time);
}
public function generateToken()
{
if (ini_get('open_basedir') === '') {
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
echo 'This is a server using Windows!';
// alternative to /dev/urandom for Windows
$token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
} else {
$token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
}
}
else {
$token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
}
$token = str_replace('+', '', $token);
$this->store->updateUserConfig($this->user->getId(), 'token', $token);
$currentConfig = $_SESSION['poche_user']->config;
$currentConfig['token'] = $token;
$_SESSION['poche_user']->setConfig($currentConfig);
Tools::redirect();
}
2013-12-06 13:37:42 +00:00
public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
{
2013-12-06 13:37:42 +00:00
$allowed_types = array('home', 'fav', 'archive', 'tag');
$config = $this->store->getConfigUser($user_id);
if ($config == null) {
die(_('User with this id (' . $user_id . ') does not exist.'));
}
if (!in_array($type, $allowed_types) ||
$token != $config['token']) {
die(_('Uh, there is a problem while generating feeds.'));
}
// Check the token
$feed = new FeedWriter(RSS2);
2014-02-13 07:57:44 +00:00
$feed->setTitle('wallabag — ' . $type . ' feed');
$feed->setLink(Tools::getPocheUrl());
$feed->setChannelElement('pubDate', date(DATE_RSS , time()));
$feed->setChannelElement('generator', 'wallabag');
$feed->setDescription('wallabag ' . $type . ' elements');
2013-12-06 13:37:42 +00:00
if ($type == 'tag') {
2014-02-19 12:25:28 +00:00
$entries = $this->store->retrieveEntriesByTag($tag_id, $user_id);
2013-12-06 13:37:42 +00:00
}
else {
$entries = $this->store->getEntriesByView($type, $user_id);
}
if (count($entries) > 0) {
foreach ($entries as $entry) {
$newItem = $feed->createNewItem();
$newItem->setTitle($entry['title']);
$newItem->setSource(Tools::getPocheUrl() . '?view=view&amp;id=' . $entry['id']);
2014-03-14 08:35:48 +00:00
$newItem->setLink($entry['url']);
$newItem->setDate(time());
$newItem->setDescription($entry['content']);
$feed->addItem($newItem);
}
}
$feed->genarateFeed();
exit;
}
public function emptyCache() {
$files = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator(CACHE, RecursiveDirectoryIterator::SKIP_DOTS),
RecursiveIteratorIterator::CHILD_FIRST
);
foreach ($files as $fileinfo) {
$todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
$todo($fileinfo->getRealPath());
}
Tools::logm('empty cache');
$this->messages->add('s', _('Cache deleted.'));
Tools::redirect();
}
/**
* return new purifier object with actual config
*/
protected function getPurifier() {
$config = HTMLPurifier_Config::createDefault();
$config->set('Cache.SerializerPath', CACHE);
$config->set('HTML.SafeIframe', true);
$config->set('URI.SafeIframeRegexp', '%^(https?:)?//(www\.youtube(?:-nocookie)?\.com/embed/|player\.vimeo\.com/video/)%'); //allow YouTube and Vimeo$purifier = new HTMLPurifier($config);
return new HTMLPurifier($config);
}
2013-10-20 14:53:54 +00:00
}