X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=inc%2Fpoche%2FPoche.class.php;h=e0dc0d201daa27532d7aee8c82cfdf00812874a8;hb=fd99a8c02d7c625771656a5c5081560027d8e6e9;hp=0a43df71ff3e7986da61143e6a93c3940744730e;hpb=bc1ee8524e0769ad37e3c4c02cfe96d2f60e52f6;p=github%2Fwallabag%2Fwallabag.git diff --git a/inc/poche/Poche.class.php b/inc/poche/Poche.class.php index 0a43df71..e0dc0d20 100644 --- a/inc/poche/Poche.class.php +++ b/inc/poche/Poche.class.php @@ -18,6 +18,10 @@ class Poche function __construct() { + $this->initTpl(); + if (!$this->checkBeforeInstall()) { + exit; + } $this->store = new Database(); $this->init(); $this->messages = new Messages(); @@ -29,27 +33,44 @@ class Poche } } - private function init() + /** + * all checks before installation. + * @return boolean + */ + private function checkBeforeInstall() { - Tools::initPhp(); - Session::init(); + $msg = ''; + $allIsGood = TRUE; - if (isset($_SESSION['poche_user'])) { - $this->user = $_SESSION['poche_user']; + 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.'); } - else { - # fake user, just for install & login screens - $this->user = new User(); - $this->user->setConfig($this->getDefaultConfig()); + 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; + } + 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; + } + else 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; + } + + if (!$allIsGood) { + echo $this->tpl->render('error.twig', array( + 'msg' => $msg + )); } - # l10n - $language = $this->user->getConfigValue('language'); - putenv('LC_ALL=' . $language); - setlocale(LC_ALL, $language); - bindtextdomain($language, LOCALE); - textdomain($language); + return $allIsGood; + } + private function initTpl() + { # template engine $loader = new Twig_Loader_Filesystem(TPL); if (DEBUG_POCHE) { @@ -64,6 +85,32 @@ class Poche $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain'); $this->tpl->addFilter($filter); + # 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'); } @@ -78,10 +125,12 @@ class Poche if (($_POST['password'] == $_POST['password_repeat']) && $_POST['password'] != "" && $_POST['login'] != "") { # let's rock, install poche baby ! - $this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])); - Session::logout(); - Tools::logm('poche is now installed'); - Tools::redirect(); + if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']))) + { + Session::logout(); + Tools::logm('poche is now installed'); + Tools::redirect(); + } } else { Tools::logm('error during installation'); @@ -102,7 +151,7 @@ class Poche /** * Call action (mark as fav, archive, delete, etc.) */ - public function action($action, Url $url, $id = 0) + public function action($action, Url $url, $id = 0, $import = FALSE) { switch ($action) { @@ -110,22 +159,36 @@ class Poche 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()); - $last_id = $this->store->getLastId(); + $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')); } - $this->messages->add('s', _('the link has been added successfully')); } else { - $this->messages->add('e', _('error during insertion : the link wasn\'t added')); - Tools::logm('error during insertion : the link wasn\'t added'); + 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()); + } } } else { - $this->messages->add('e', _('error during fetching content : the link wasn\'t added')); - Tools::logm('error during content fetch'); + if (!$import) { + $this->messages->add('e', _('error during fetching content : the link wasn\'t added')); + Tools::logm('error during content fetch ' . $url->getUrl()); + } + } + if (!$import) { + Tools::redirect(); } - Tools::redirect(); break; case 'delete': $msg = 'delete link #' . $id; @@ -145,14 +208,19 @@ class Poche case 'toggle_fav' : $this->store->favoriteById($id, $this->user->getId()); Tools::logm('mark as favorite link #' . $id); - Tools::redirect(); + if (!$import) { + Tools::redirect(); + } break; case 'toggle_archive' : $this->store->archiveById($id, $this->user->getId()); Tools::logm('archive link #' . $id); - Tools::redirect(); + if (!$import) { + Tools::redirect(); + } break; default: + Tools::logm('action ' . $action . 'doesn\'t exist'); break; } } @@ -192,7 +260,7 @@ class Poche ); } else { - Tools::logm('error in view call : entry is NULL'); + Tools::logm('error in view call : entry is null'); } break; default: # home view @@ -211,6 +279,13 @@ class Poche return $tpl_vars; } + /** + * update the password of the current user. + * if MODE_DEMO is TRUE, the password can't be updated. + * @todo add the return value + * @todo set the new password in function header like this updatePassword($newPassword) + * @return boolean + */ public function updatePassword() { if (MODE_DEMO) { @@ -235,6 +310,13 @@ class Poche } } + /** + * 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) { if (!empty($_POST['login']) && !empty($_POST['password'])) { @@ -265,20 +347,31 @@ class Poche } } + /** + * log out the poche user. It cleans the session. + * @todo add the return value + * @return boolean + */ public function logout() { - $this->messages->add('s', _('see you soon!')); - Tools::logm('logout'); $this->user = array(); Session::logout(); + $this->messages->add('s', _('see you soon!')); + Tools::logm('logout'); Tools::redirect(); } + /** + * import from Instapaper. poche needs a ./instapaper-export.html file + * @todo add the return value + * @return boolean + */ private function importFromInstapaper() { # TODO gestion des articles favs $html = new simple_html_dom(); $html->load_file('./instapaper-export.html'); + Tools::logm('starting import from instapaper'); $read = 0; $errors = array(); @@ -288,10 +381,14 @@ class Poche { $a = $li->find('a'); $url = new Url(base64_encode($a[0]->href)); - $this->action('add', $url); + $this->action('add', $url, 0, TRUE); if ($read == '1') { - $last_id = $this->store->getLastId(); - $this->action('toggle_archive', $url, $last_id); + $sequence = ''; + if (STORAGE == 'postgres') { + $sequence = 'entries_id_seq'; + } + $last_id = $this->store->getLastId($sequence); + $this->action('toggle_archive', $url, $last_id, TRUE); } } @@ -303,11 +400,17 @@ class Poche Tools::redirect(); } + /** + * import from Pocket. poche needs a ./ril_export.html file + * @todo add the return value + * @return boolean + */ private function importFromPocket() { # TODO gestion des articles favs $html = new simple_html_dom(); $html->load_file('./ril_export.html'); + Tools::logm('starting import from pocket'); $read = 0; $errors = array(); @@ -317,10 +420,14 @@ class Poche { $a = $li->find('a'); $url = new Url(base64_encode($a[0]->href)); - $this->action('add', $url); + $this->action('add', $url, 0, TRUE); if ($read == '1') { - $last_id = $this->store->getLastId(); - $this->action('toggle_archive', $url, $last_id); + $sequence = ''; + if (STORAGE == 'postgres') { + $sequence = 'entries_id_seq'; + } + $last_id = $this->store->getLastId($sequence); + $this->action('toggle_archive', $url, $last_id, TRUE); } } @@ -332,49 +439,81 @@ class Poche Tools::redirect(); } + /** + * import from Readability. poche needs a ./readability file + * @todo add the return value + * @return boolean + */ private function importFromReadability() { # TODO gestion des articles lus / favs $str_data = file_get_contents("./readability"); $data = json_decode($str_data,true); - + Tools::logm('starting import from Readability'); + $count = 0; foreach ($data as $key => $value) { - $url = ''; + $url = NULL; + $favorite = FALSE; + $archive = FALSE; foreach ($value as $attr => $attr_value) { if ($attr == 'article__url') { $url = new Url(base64_encode($attr_value)); } - // if ($attr_value == 'favorite' && $attr_value == 'true') { - // $last_id = $this->store->getLastId(); - // $this->store->favoriteById($last_id); - // $this->action('toogle_fav', $url, $last_id); - // } - // if ($attr_value == 'archive' && $attr_value == 'true') { - // $last_id = $this->store->getLastId(); - // $this->action('toggle_archive', $url, $last_id); - // } + $sequence = ''; + if (STORAGE == 'postgres') { + $sequence = 'entries_id_seq'; + } + if ($attr_value == 'true') { + if ($attr == 'favorite') { + $favorite = TRUE; + } + if ($attr == 'archive') { + $archive = TRUE; + } + } + } + # we can add the url + if (!is_null($url) && $url->isCorrect()) { + $this->action('add', $url, 0, TRUE); + $count++; + if ($favorite) { + $last_id = $this->store->getLastId($sequence); + $this->action('toggle_fav', $url, $last_id, TRUE); + } + if ($archive) { + $last_id = $this->store->getLastId($sequence); + $this->action('toggle_archive', $url, $last_id, TRUE); + } } - if ($url->isCorrect()) - $this->action('add', $url); } - $this->messages->add('s', _('import from Readability completed')); + $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.')); Tools::logm('import from Readability completed'); Tools::redirect(); } + /** + * import datas into your poche + * @param string $from name of the service to import : pocket, instapaper or readability + * @todo add the return value + * @return boolean + */ public function import($from) { if ($from == 'pocket') { - $this->importFromPocket(); + return $this->importFromPocket(); } else if ($from == 'readability') { - $this->importFromReadability(); + return $this->importFromReadability(); } else if ($from == 'instapaper') { - $this->importFromInstapaper(); + return $this->importFromInstapaper(); } } + /** + * export poche entries in json + * @return json all poche entries + */ public function export() { $entries = $this->store->retrieveAll($this->user->getId()); @@ -384,9 +523,16 @@ class Poche Tools::logm('export view'); } + /** + * Checks online the latest version of poche and cache it + * @param string $which 'prod' or 'dev' + * @return string latest $which version + */ private function getPocheVersion($which = 'prod') { $cache_file = CACHE . '/' . $which; + + # checks if the cached version file exists if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) { $version = file_get_contents($cache_file); } else {