X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=inc%2Fpoche%2FPoche.class.php;h=806da54b64cdcbf044107f86ae20e2414d52d03a;hb=a84f77d6ba15a64ff00453f5d5190c021ce460ed;hp=e0dc0d201daa27532d7aee8c82cfdf00812874a8;hpb=7ba37bd91a43321196e6d867caf9e298e82c6d6c;p=github%2Fwallabag%2Fwallabag.git
diff --git a/inc/poche/Poche.class.php b/inc/poche/Poche.class.php
index e0dc0d20..806da54b 100644
--- a/inc/poche/Poche.class.php
+++ b/inc/poche/Poche.class.php
@@ -10,77 +10,216 @@
class Poche
{
+ public static $canRenderTemplates = true;
+ public static $configFileAvailable = true;
+
public $user;
public $store;
public $tpl;
public $messages;
public $pagination;
-
- function __construct()
+
+ private $currentTheme = '';
+ private $currentLanguage = '';
+ private $notInstalledMessage = array();
+
+ # @todo make this dynamic (actually install themes and save them in the database including author information et cetera)
+ private $installedThemes = array(
+ 'default' => array('requires' => array()),
+ 'dark' => array('requires' => array('default')),
+ 'dmagenta' => array('requires' => array('default')),
+ 'solarized' => array('requires' => array('default')),
+ 'solarized-dark' => array('requires' => array('default'))
+ );
+
+ public function __construct()
+ {
+ if ($this->configFileIsAvailable()) {
+ $this->init();
+ }
+
+ if ($this->themeIsInstalled()) {
+ $this->initTpl();
+ }
+
+ if ($this->systemIsInstalled()) {
+ $this->store = new Database();
+ $this->messages = new Messages();
+ # installation
+ if (! $this->store->isInstalled()) {
+ $this->install();
+ }
+ }
+ }
+
+ private function init()
{
- $this->initTpl();
- if (!$this->checkBeforeInstall()) {
- exit;
+ Tools::initPhp();
+ Session::$sessionName = 'poche';
+ Session::init();
+
+ 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());
}
- $this->store = new Database();
- $this->init();
- $this->messages = new Messages();
- # installation
- if(!$this->store->isInstalled())
- {
- $this->install();
+ # l10n
+ $language = $this->user->getConfigValue('language');
+ putenv('LC_ALL=' . $language);
+ setlocale(LC_ALL, $language);
+ bindtextdomain($language, LOCALE);
+ textdomain($language);
+
+ # Pagination
+ $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
+
+ # Set up theme
+ $themeDirectory = $this->user->getConfigValue('theme');
+
+ if ($themeDirectory === false) {
+ $themeDirectory = DEFAULT_THEME;
+ }
+
+ $this->currentTheme = $themeDirectory;
+
+ # Set up language
+ $languageDirectory = $this->user->getConfigValue('language');
+
+ if ($languageDirectory === false) {
+ $languageDirectory = DEFAULT_THEME;
}
+
+ $this->currentLanguage = $languageDirectory;
+ }
+
+ public function configFileIsAvailable() {
+ if (! self::$configFileAvailable) {
+ $this->notInstalledMessage[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
+
+ return false;
+ }
+
+ return true;
}
+
+ public function themeIsInstalled() {
+ $passTheme = TRUE;
+ # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
+ if (! self::$canRenderTemplates) {
+ $this->notInstalledMessage[] = 'Twig does not seem to be installed. Please initialize the Composer installation to automatically fetch dependencies. Have a look at the documentation.';
+ $passTheme = FALSE;
+ }
+
+ if (! is_writable(CACHE)) {
+ $this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
+
+ self::$canRenderTemplates = false;
+
+ $passTheme = FALSE;
+ }
+
+ # Check if the selected theme and its requirements are present
+ if ($this->getTheme() != '' && ! is_dir(THEME . '/' . $this->getTheme())) {
+ $this->notInstalledMessage[] = 'The currently selected theme (' . $this->getTheme() . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $this->getTheme() . ')';
+
+ self::$canRenderTemplates = false;
+
+ $passTheme = FALSE;
+ }
+
+ foreach ($this->installedThemes[$this->getTheme()]['requires'] as $requiredTheme) {
+ if (! is_dir(THEME . '/' . $requiredTheme)) {
+ $this->notInstalledMessage[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $this->getTheme() . ')';
+
+ self::$canRenderTemplates = false;
+
+ $passTheme = FALSE;
+ }
+ }
+
+ if (!$passTheme) {
+ return FALSE;
+ }
+
+ return true;
+ }
+
/**
* all checks before installation.
+ * @todo move HTML to template
* @return boolean
*/
- private function checkBeforeInstall()
+ public function systemIsInstalled()
{
- $msg = '';
- $allIsGood = TRUE;
-
- if (!is_writable(CACHE)) {
- Tools::logm('you don\'t have write access on cache directory');
- die('You don\'t have write access on cache directory.');
+ $msg = TRUE;
+
+ $configSalt = defined('SALT') ? constant('SALT') : '';
+
+ if (empty($configSalt)) {
+ $this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
+ $msg = FALSE;
}
- else if (file_exists('./install/update.php') && !DEBUG_POCHE) {
- $msg = 'A poche update is needed. Please execute this update by clicking here. If you have already do the update, please delete /install folder.';
- $allIsGood = FALSE;
+ if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
+ 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;
}
- else if (file_exists('./install') && !DEBUG_POCHE) {
- $msg = 'If you want to update your poche, you just have to delete /install folder.
To install your poche with sqlite, copy /install/poche.sqlite in /db and delete the folder /install. you have to delete the /install folder before using poche.';
- $allIsGood = FALSE;
+ if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
+ $this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
+ $msg = FALSE;
}
- else if (STORAGE == 'sqlite' && !is_writable(STORAGE_SQLITE)) {
+ if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
Tools::logm('you don\'t have write access on sqlite file');
- $msg = 'You don\'t have write access on sqlite file.';
- $allIsGood = FALSE;
+ $this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
+ $msg = FALSE;
}
-
- if (!$allIsGood) {
- echo $this->tpl->render('error.twig', array(
- 'msg' => $msg
- ));
+
+ if (! $msg) {
+ return false;
}
- return $allIsGood;
+ return true;
+ }
+
+ public function getNotInstalledMessage() {
+ return $this->notInstalledMessage;
}
private function initTpl()
{
- # template engine
- $loader = new Twig_Loader_Filesystem(TPL);
+ $loaderChain = new Twig_Loader_Chain();
+
+ # add the current theme as first to the loader chain so Twig will look there first for overridden template files
+ try {
+ $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $this->getTheme()));
+ } catch (Twig_Error_Loader $e) {
+ # @todo isInstalled() should catch this, inject Twig later
+ die('The currently selected theme (' . $this->getTheme() . ') does not seem to be properly installed (' . THEME . '/' . $this->getTheme() .' is missing)');
+ }
+
+ # add all required themes to the loader chain
+ foreach ($this->installedThemes[$this->getTheme()]['requires'] as $requiredTheme) {
+ try {
+ $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . DEFAULT_THEME));
+ } catch (Twig_Error_Loader $e) {
+ # @todo isInstalled() should catch this, inject Twig later
+ die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $this->getTheme() . ')');
+ }
+ }
+
if (DEBUG_POCHE) {
$twig_params = array();
- }
- else {
+ } else {
$twig_params = array('cache' => CACHE);
}
- $this->tpl = new Twig_Environment($loader, $twig_params);
+
+ $this->tpl = new Twig_Environment($loaderChain, $twig_params);
$this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
+
# filter to display domain name of an url
$filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
$this->tpl->addFilter($filter);
@@ -88,38 +227,19 @@ class Poche
# filter for reading time
$filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
$this->tpl->addFilter($filter);
- }
-
- private function init()
- {
- Tools::initPhp();
- Session::init();
-
- 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);
- bindtextdomain($language, LOCALE);
- textdomain($language);
-
- # Pagination
- $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
+
+ # filter for simple filenames in config view
+ $filter = new Twig_SimpleFilter('getPrettyFilename', function($string) { return str_replace(ROOT, '', $string); });
+ $this->tpl->addFilter($filter);
}
private function install()
{
Tools::logm('poche still not installed');
echo $this->tpl->render('install.twig', array(
- 'token' => Session::getToken()
+ 'token' => Session::getToken(),
+ 'theme' => $this->getTheme(),
+ 'poche_url' => Tools::getPocheUrl()
));
if (isset($_GET['install'])) {
if (($_POST['password'] == $_POST['password_repeat'])
@@ -139,13 +259,69 @@ class Poche
}
exit();
}
+
+ public function getTheme() {
+ return $this->currentTheme;
+ }
+
+ public function getLanguage() {
+ return $this->currentLanguage;
+ }
+
+ public function getInstalledThemes() {
+ $handle = opendir(THEME);
+ $themes = array();
+
+ while (($theme = readdir($handle)) !== false) {
+ # Themes are stored in a directory, so all directory names are themes
+ # @todo move theme installation data to database
+ if (! is_dir(THEME . '/' . $theme) || in_array($theme, array('..', '.'))) {
+ continue;
+ }
+
+ $current = false;
+
+ if ($theme === $this->getTheme()) {
+ $current = true;
+ }
+
+ $themes[] = array('name' => $theme, 'current' => $current);
+ }
+
+ sort($themes);
+ return $themes;
+ }
+
+ public function getInstalledLanguages() {
+ $handle = opendir(LOCALE);
+ $languages = array();
+
+ 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('..', '.'))) {
+ continue;
+ }
+
+ $current = false;
+
+ if ($language === $this->getLanguage()) {
+ $current = true;
+ }
+
+ $languages[] = array('name' => $language, 'current' => $current);
+ }
+
+ return $languages;
+ }
public function getDefaultConfig()
- {
+ {
return array(
'pager' => PAGINATION,
'language' => LANG,
- );
+ 'theme' => DEFAULT_THEME
+ );
}
/**
@@ -156,38 +332,33 @@ class Poche
switch ($action)
{
case 'add':
- if($parametres_url = $url->fetchContent()) {
- if ($this->store->add($url->getUrl(), $parametres_url['title'], $parametres_url['content'], $this->user->getId())) {
- Tools::logm('add link ' . $url->getUrl());
- $sequence = '';
- if (STORAGE == 'postgres') {
- $sequence = 'entries_id_seq';
- }
- $last_id = $this->store->getLastId($sequence);
- if (DOWNLOAD_PICTURES) {
- $content = filtre_picture($parametres_url['content'], $url->getUrl(), $last_id);
- Tools::logm('updating content article');
- $this->store->updateContent($last_id, $content, $this->user->getId());
- }
- if (!$import) {
- $this->messages->add('s', _('the link has been added successfully'));
- }
+ $content = $url->extract();
+
+ if ($this->store->add($url->getUrl(), $content['title'], $content['body'], $this->user->getId())) {
+ Tools::logm('add link ' . $url->getUrl());
+ $sequence = '';
+ if (STORAGE == 'postgres') {
+ $sequence = 'entries_id_seq';
}
- else {
- if (!$import) {
- $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
- Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
- }
+ $last_id = $this->store->getLastId($sequence);
+ if (DOWNLOAD_PICTURES) {
+ $content = filtre_picture($content['body'], $url->getUrl(), $last_id);
+ Tools::logm('updating content article');
+ $this->store->updateContent($last_id, $content, $this->user->getId());
+ }
+ if (!$import) {
+ $this->messages->add('s', _('the link has been added successfully'));
}
}
else {
if (!$import) {
- $this->messages->add('e', _('error during fetching content : the link wasn\'t added'));
- Tools::logm('error during content fetch ' . $url->getUrl());
+ $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
+ Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
}
}
+
if (!$import) {
- Tools::redirect();
+ Tools::redirect('?view=home');
}
break;
case 'delete':
@@ -203,7 +374,7 @@ class Poche
$msg = 'error : can\'t delete link #' . $id;
}
Tools::logm($msg);
- Tools::redirect('?');
+ Tools::redirect();
break;
case 'toggle_fav' :
$this->store->favoriteById($id, $this->user->getId());
@@ -220,7 +391,6 @@ class Poche
}
break;
default:
- Tools::logm('action ' . $action . 'doesn\'t exist');
break;
}
}
@@ -234,9 +404,13 @@ class Poche
case 'config':
$dev = $this->getPocheVersion('dev');
$prod = $this->getPocheVersion('prod');
- $compare_dev = version_compare(POCHE_VERSION, $dev);
- $compare_prod = version_compare(POCHE_VERSION, $prod);
+ $compare_dev = version_compare(POCHE, $dev);
+ $compare_prod = version_compare(POCHE, $prod);
+ $themes = $this->getInstalledThemes();
+ $languages = $this->getInstalledLanguages();
$tpl_vars = array(
+ 'themes' => $themes,
+ 'languages' => $languages,
'dev' => $dev,
'prod' => $prod,
'compare_dev' => $compare_dev,
@@ -254,24 +428,37 @@ class Poche
$tidy->cleanRepair();
$content = $tidy->value;
}
+
+ # flattr checking
+ $flattr = new FlattrItem();
+ $flattr->checkItem($entry['url'],$entry['id']);
+
$tpl_vars = array(
- 'entry' => $entry,
- 'content' => $content,
+ 'entry' => $entry,
+ 'content' => $content,
+ 'flattr' => $flattr
);
}
else {
Tools::logm('error in view call : entry is null');
}
break;
- default: # home view
+ default: # home, favorites and archive views
$entries = $this->store->getEntriesByView($view, $this->user->getId());
- $this->pagination->set_total(count($entries));
- $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
- $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
$tpl_vars = array(
- 'entries' => $datas,
- 'page_links' => $page_links,
+ 'entries' => '',
+ 'page_links' => '',
+ 'nb_results' => '',
);
+
+ if (count($entries) > 0) {
+ $this->pagination->set_total(count($entries));
+ $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
+ $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
+ $tpl_vars['entries'] = $datas;
+ $tpl_vars['page_links'] = $page_links;
+ $tpl_vars['nb_results'] = count($entries);
+ }
Tools::logm('display ' . $view . ' view');
break;
}
@@ -309,6 +496,82 @@ class Poche
}
}
}
+
+ public function updateTheme()
+ {
+ # no data
+ if (empty($_POST['theme'])) {
+ }
+
+ # 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');
+ }
+
+ $themes = $this->getInstalledThemes();
+ $actualTheme = false;
+
+ foreach ($themes as $theme) {
+ if ($theme['name'] == $_POST['theme']) {
+ $actualTheme = true;
+ break;
+ }
+ }
+
+ if (! $actualTheme) {
+ $this->messages->add('e', _('that theme does not seem to be installed'));
+ Tools::redirect('?view=config');
+ }
+
+ $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
+ $this->messages->add('s', _('you have changed your theme preferences'));
+
+ $currentConfig = $_SESSION['poche_user']->config;
+ $currentConfig['theme'] = $_POST['theme'];
+
+ $_SESSION['poche_user']->setConfig($currentConfig);
+
+ Tools::redirect('?view=config');
+ }
+
+ public function updateLanguage()
+ {
+ # no data
+ if (empty($_POST['language'])) {
+ }
+
+ # 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');
+ }
+
+ $languages = $this->getInstalledLanguages();
+ $actualLanguage = false;
+
+ foreach ($languages as $language) {
+ if ($language['name'] == $_POST['language']) {
+ $actualLanguage = true;
+ break;
+ }
+ }
+
+ if (! $actualLanguage) {
+ $this->messages->add('e', _('that language does not seem to be installed'));
+ Tools::redirect('?view=config');
+ }
+
+ $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
+ $this->messages->add('s', _('you have changed your language preferences'));
+
+ $currentConfig = $_SESSION['poche_user']->config;
+ $currentConfig['language'] = $_POST['language'];
+
+ $_SESSION['poche_user']->setConfig($currentConfig);
+
+ Tools::redirect('?view=config');
+ }
/**
* checks if login & password are correct and save the user in session.
@@ -324,16 +587,7 @@ class Poche
if ($user != array()) {
# Save login into Session
Session::login($user['username'], $user['password'], $_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']), array('poche_user' => new User($user)));
-
$this->messages->add('s', _('welcome to your poche'));
- if (!empty($_POST['longlastingsession'])) {
- $_SESSION['longlastingsession'] = 31536000;
- $_SESSION['expires_on'] = time() + $_SESSION['longlastingsession'];
- session_set_cookie_params($_SESSION['longlastingsession']);
- } else {
- session_set_cookie_params(0);
- }
- session_regenerate_id(true);
Tools::logm('login successful');
Tools::redirect($referer);
}
@@ -364,13 +618,14 @@ class Poche
/**
* import from Instapaper. poche needs a ./instapaper-export.html file
* @todo add the return value
+ * @param string $targetFile the file used for importing
* @return boolean
*/
- private function importFromInstapaper()
+ private function importFromInstapaper($targetFile)
{
# TODO gestion des articles favs
$html = new simple_html_dom();
- $html->load_file('./instapaper-export.html');
+ $html->load_file($targetFile);
Tools::logm('starting import from instapaper');
$read = 0;
@@ -403,13 +658,14 @@ class Poche
/**
* import from Pocket. poche needs a ./ril_export.html file
* @todo add the return value
+ * @param string $targetFile the file used for importing
* @return boolean
*/
- private function importFromPocket()
+ private function importFromPocket($targetFile)
{
# TODO gestion des articles favs
$html = new simple_html_dom();
- $html->load_file('./ril_export.html');
+ $html->load_file($targetFile);
Tools::logm('starting import from pocket');
$read = 0;
@@ -442,12 +698,13 @@ class Poche
/**
* import from Readability. poche needs a ./readability file
* @todo add the return value
+ * @param string $targetFile the file used for importing
* @return boolean
*/
- private function importFromReadability()
+ private function importFromReadability($targetFile)
{
# TODO gestion des articles lus / favs
- $str_data = file_get_contents("./readability");
+ $str_data = file_get_contents($targetFile);
$data = json_decode($str_data,true);
Tools::logm('starting import from Readability');
$count = 0;
@@ -499,15 +756,31 @@ class Poche
*/
public function import($from)
{
- if ($from == 'pocket') {
- return $this->importFromPocket();
+ $providers = array(
+ 'pocket' => 'importFromPocket',
+ 'readability' => 'importFromReadability',
+ 'instapaper' => 'importFromInstapaper'
+ );
+
+ if (! isset($providers[$from])) {
+ $this->messages->add('e', _('Unknown import provider.'));
+ Tools::redirect();
}
- else if ($from == 'readability') {
- return $this->importFromReadability();
+
+ $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
+ $targetFile = constant($targetDefinition);
+
+ if (! defined($targetDefinition)) {
+ $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
+ Tools::redirect();
}
- else if ($from == 'instapaper') {
- return $this->importFromInstapaper();
+
+ if (! file_exists($targetFile)) {
+ $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
+ Tools::redirect();
}
+
+ $this->$providers[$from]($targetFile);
}
/**