class Poche
{
+ public $user;
public $store;
public $tpl;
+ public $messages;
+ public $pagination;
- function __construct($storage_type)
+ function __construct()
{
- $this->store = new $storage_type();
+ $this->initTpl();
+ if (!$this->checkBeforeInstall()) {
+ exit;
+ }
+ $this->store = new Database();
$this->init();
+ $this->messages = new Messages();
# installation
if(!$this->store->isInstalled())
{
$this->install();
}
-
- $this->saveUser();
}
- private function init()
+ /**
+ * all checks before installation.
+ * @return boolean
+ */
+ private function checkBeforeInstall()
{
- # l10n
- putenv('LC_ALL=' . LANG);
- setlocale(LC_ALL, LANG);
- bindtextdomain(LANG, LOCALE);
- textdomain(LANG);
+ $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.');
+ }
+ else if (file_exists('./install/update.php') && !DEBUG_POCHE) {
+ $msg = '<h1>setup</h1><p><strong>It\'s your first time here?</strong> Please copy /install/poche.sqlite in db folder. Then, delete install folder.<br /><strong>If you have already installed poche</strong>, an update is needed <a href="install/update.php">by clicking here</a>.</p>';
+ $allIsGood = FALSE;
+ }
+ else if (file_exists('./install') && !DEBUG_POCHE) {
+ $msg = '<h1>setup</h1><p><strong>If you want to update your poche</strong>, you just have to delete /install folder. <br /><strong>To install your poche with sqlite</strong>, copy /install/poche.sqlite in /db and delete the folder /install. you have to delete the /install folder before using poche.</p>';
+ $allIsGood = FALSE;
+ }
+ else if (STORAGE == 'sqlite' && !is_writable(STORAGE_SQLITE)) {
+ Tools::logm('you don\'t have write access on sqlite file');
+ $msg = '<h1>error</h1><p>You don\'t have write access on sqlite file.</p>';
+ $allIsGood = FALSE;
+ }
+
+ if (!$allIsGood) {
+ echo $this->tpl->render('error.twig', array(
+ 'msg' => $msg
+ ));
+ }
+
+ return $allIsGood;
+ }
+
+ private function initTpl()
+ {
# template engine
$loader = new Twig_Loader_Filesystem(TPL);
- $this->tpl = new Twig_Environment($loader, array(
- 'cache' => CACHE,
- ));
+ if (DEBUG_POCHE) {
+ $twig_params = array();
+ }
+ else {
+ $twig_params = array('cache' => CACHE);
+ }
+ $this->tpl = new Twig_Environment($loader, $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);
+ # 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');
}
private function install()
{
Tools::logm('poche still not installed');
echo $this->tpl->render('install.twig', array(
- 'token' => Session::getToken(),
+ 'token' => Session::getToken()
));
if (isset($_GET['install'])) {
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();
+ 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');
Tools::redirect();
}
}
exit();
}
- private function saveUser()
+ public function getDefaultConfig()
{
- $_SESSION['login'] = (isset ($_SESSION['login'])) ? $_SESSION['login'] : $this->store->getLogin();
- $_SESSION['pass'] = (isset ($_SESSION['pass'])) ? $_SESSION['pass'] : $this->store->getPassword();
+ return array(
+ 'pager' => PAGINATION,
+ 'language' => LANG,
+ );
}
/**
* 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)
{
case 'add':
if($parametres_url = $url->fetchContent()) {
- if ($this->store->add($url->getUrl(), $parametres_url['title'], $parametres_url['content'])) {
+ 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'));
}
- #$msg->add('s', _('the link has been added successfully'));
}
else {
- #$msg->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 {
- #$msg->add('e', _('error during url preparation : 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();
}
break;
case 'delete':
- if ($this->store->deleteById($id)) {
+ $msg = 'delete link #' . $id;
+ if ($this->store->deleteById($id, $this->user->getId())) {
if (DOWNLOAD_PICTURES) {
remove_directory(ABS_PATH . $id);
}
- #$msg->add('s', _('the link has been deleted successfully'));
- Tools::logm('delete link #' . $id);
+ $this->messages->add('s', _('the link has been deleted successfully'));
}
else {
- #$msg->add('e', _('the link wasn\'t deleted'));
- Tools::logm('error : can\'t delete link #' . $id);
+ $this->messages->add('e', _('the link wasn\'t deleted'));
+ $msg = 'error : can\'t delete link #' . $id;
}
+ Tools::logm($msg);
+ Tools::redirect('?');
break;
case 'toggle_fav' :
- $this->store->favoriteById($id);
+ $this->store->favoriteById($id, $this->user->getId());
Tools::logm('mark as favorite link #' . $id);
+ if (!$import) {
+ Tools::redirect();
+ }
break;
case 'toggle_archive' :
- $this->store->archiveById($id);
+ $this->store->archiveById($id, $this->user->getId());
Tools::logm('archive link #' . $id);
- break;
- case 'import':
+ if (!$import) {
+ Tools::redirect();
+ }
break;
default:
+ Tools::logm('action ' . $action . 'doesn\'t exist');
break;
}
}
switch ($view)
{
- case 'install':
- Tools::logm('install mode');
- break;
- case 'import';
- Tools::logm('import mode');
- break;
- case 'export':
- $entries = $this->store->retrieveAll();
- // $tpl->assign('export', Tools::renderJson($entries));
- // $tpl->draw('export');
- Tools::logm('export view');
- break;
case 'config':
+ $dev = $this->getPocheVersion('dev');
+ $prod = $this->getPocheVersion('prod');
+ $compare_dev = version_compare(POCHE_VERSION, $dev);
+ $compare_prod = version_compare(POCHE_VERSION, $prod);
+ $tpl_vars = array(
+ 'dev' => $dev,
+ 'prod' => $prod,
+ 'compare_dev' => $compare_dev,
+ 'compare_prod' => $compare_prod,
+ );
Tools::logm('config view');
break;
case 'view':
- $entry = $this->store->retrieveOneById($id);
+ $entry = $this->store->retrieveOneById($id, $this->user->getId());
if ($entry != NULL) {
Tools::logm('view link #' . $id);
$content = $entry['content'];
);
}
else {
- Tools::logm('error in view call : entry is NULL');
+ Tools::logm('error in view call : entry is null');
}
break;
default: # home view
- $entries = $this->store->getEntriesByView($view);
+ $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' => $entries,
+ 'entries' => $datas,
+ 'page_links' => $page_links,
);
+ Tools::logm('display ' . $view . ' view');
break;
}
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 (isset($_POST['password']) && isset($_POST['password_repeat'])) {
- if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
- if (!MODE_DEMO) {
- Tools::logm('password updated');
- $this->store->updatePassword(Tools::encodeString($_POST['password'] . $_SESSION['login']));
+ if (MODE_DEMO) {
+ $this->messages->add('i', _('in demo mode, you can\'t update your password'));
+ Tools::logm('in demo mode, you can\'t do this');
+ Tools::redirect('?view=config');
+ }
+ else {
+ if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
+ if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
+ $this->messages->add('s', _('your password has been updated'));
+ $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
Session::logout();
+ Tools::logm('password updated');
Tools::redirect();
}
else {
- Tools::logm('in demo mode, you can\'t do this');
+ $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
+ Tools::redirect('?view=config');
}
}
}
}
+ /**
+ * 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'])) {
- if (Session::login($_SESSION['login'], $_SESSION['pass'], $_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']))) {
- Tools::logm('login successful');
+ $user = $this->store->login($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']));
+ 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(0);
}
session_regenerate_id(true);
+ Tools::logm('login successful');
Tools::redirect($referer);
}
+ $this->messages->add('e', _('login failed: bad login or password'));
Tools::logm('login failed');
Tools::redirect();
} else {
+ $this->messages->add('e', _('login failed: you have to fill all fields'));
Tools::logm('login failed');
Tools::redirect();
}
}
+ /**
+ * log out the poche user. It cleans the session.
+ * @todo add the return value
+ * @return boolean
+ */
public function logout()
{
- Tools::logm('logout');
+ $this->user = array();
Session::logout();
+ $this->messages->add('s', _('see you soon!'));
+ Tools::logm('logout');
Tools::redirect();
}
- public function import($from)
+ /**
+ * 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($targetFile)
{
- if ($from == 'pocket') {
- $html = new simple_html_dom();
- $html->load_file('./ril_export.html');
+ # TODO gestion des articles favs
+ $html = new simple_html_dom();
+ $html->load_file($targetFile);
+ Tools::logm('starting import from instapaper');
- $read = 0;
- $errors = array();
- foreach($html->find('ul') as $ul)
+ $read = 0;
+ $errors = array();
+ foreach($html->find('ol') as $ul)
+ {
+ foreach($ul->find('li') as $li)
{
- foreach($ul->find('li') as $li)
- {
- $a = $li->find('a');
- $url = new Url($a[0]->href);
- $this->action('add', $url);
- if ($read == '1') {
- $last_id = $this->store->lastInsertId();
- $sql_update = "UPDATE entries SET is_read=~is_read WHERE id=?";
- $params_update = array($last_id);
- $query_update = $this->store->prepare($sql_update);
- $query_update->execute($params_update);
+ $a = $li->find('a');
+ $url = new Url(base64_encode($a[0]->href));
+ $this->action('add', $url, 0, TRUE);
+ if ($read == '1') {
+ $sequence = '';
+ if (STORAGE == 'postgres') {
+ $sequence = 'entries_id_seq';
}
+ $last_id = $this->store->getLastId($sequence);
+ $this->action('toggle_archive', $url, $last_id, TRUE);
}
- # Pocket génère un fichier HTML avec deux <ul>
- # Le premier concerne les éléments non lus
- # Le second concerne les éléments archivés
- $read = 1;
}
- logm('import from pocket completed');
- Tools::redirect();
+
+ # the second <ol> is for read links
+ $read = 1;
}
- else if ($from == 'readability') {
- # TODO finaliser tout ça ici
- $str_data = file_get_contents("readability");
- $data = json_decode($str_data,true);
-
- foreach ($data as $key => $value) {
- $url = '';
- foreach ($value as $key2 => $value2) {
- if ($key2 == 'article__url') {
- $url = new Url($value2);
+ $this->messages->add('s', _('import from instapaper completed'));
+ Tools::logm('import from instapaper completed');
+ Tools::redirect();
+ }
+
+ /**
+ * 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($targetFile)
+ {
+ # TODO gestion des articles favs
+ $html = new simple_html_dom();
+ $html->load_file($targetFile);
+ Tools::logm('starting import from pocket');
+
+ $read = 0;
+ $errors = array();
+ foreach($html->find('ul') as $ul)
+ {
+ foreach($ul->find('li') as $li)
+ {
+ $a = $li->find('a');
+ $url = new Url(base64_encode($a[0]->href));
+ $this->action('add', $url, 0, TRUE);
+ if ($read == '1') {
+ $sequence = '';
+ if (STORAGE == 'postgres') {
+ $sequence = 'entries_id_seq';
+ }
+ $last_id = $this->store->getLastId($sequence);
+ $this->action('toggle_archive', $url, $last_id, TRUE);
+ }
+ }
+
+ # the second <ul> is for read links
+ $read = 1;
+ }
+ $this->messages->add('s', _('import from pocket completed'));
+ Tools::logm('import from pocket completed');
+ Tools::redirect();
+ }
+
+ /**
+ * 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($targetFile)
+ {
+ # TODO gestion des articles lus / favs
+ $str_data = file_get_contents($targetFile);
+ $data = json_decode($str_data,true);
+ Tools::logm('starting import from Readability');
+ $count = 0;
+ foreach ($data as $key => $value) {
+ $url = NULL;
+ $favorite = FALSE;
+ $archive = FALSE;
+ foreach ($value as $attr => $attr_value) {
+ if ($attr == 'article__url') {
+ $url = new Url(base64_encode($attr_value));
+ }
+ $sequence = '';
+ if (STORAGE == 'postgres') {
+ $sequence = 'entries_id_seq';
+ }
+ if ($attr_value == 'true') {
+ if ($attr == 'favorite') {
+ $favorite = TRUE;
+ }
+ if ($attr == 'archive') {
+ $archive = TRUE;
}
}
- if ($url != '')
- action_to_do('add', $url);
}
- logm('import from Readability completed');
+ # 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);
+ }
+ }
+ }
+ $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)
+ {
+ $providers = array(
+ 'pocket' => 'importFromPocket',
+ 'readability' => 'importFromReadability',
+ 'instapaper' => 'importFromInstapaper'
+ );
+
+ if (! isset($providers[$from])) {
+ $this->messages->add('e', _('Unknown import provider.'));
Tools::redirect();
}
+
+ $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();
+ }
+
+ if (! file_exists($targetFile)) {
+ $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
+ Tools::redirect();
+ }
+
+ $this->$providers[$from]($targetFile);
}
+ /**
+ * export poche entries in json
+ * @return json all poche entries
+ */
public function export()
{
+ $entries = $this->store->retrieveAll($this->user->getId());
+ echo $this->tpl->render('export.twig', array(
+ 'export' => Tools::renderJson($entries),
+ ));
+ 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 {
+ $version = file_get_contents('http://static.inthepoche.com/versions/' . $which);
+ file_put_contents($cache_file, $version, LOCK_EX);
+ }
+ return $version;
}
}
\ No newline at end of file