]> git.immae.eu Git - github/wallabag/wallabag.git/blob - inc/poche/Poche.class.php
Implemented Add Button
[github/wallabag/wallabag.git] / inc / poche / Poche.class.php
1 <?php
2 /**
3 * poche, a read it later open source system
4 *
5 * @category poche
6 * @author Nicolas LÅ“uillet <support@inthepoche.com>
7 * @copyright 2013
8 * @license http://www.wtfpl.net/ see COPYING file
9 */
10
11 class Poche
12 {
13 public $user;
14 public $store;
15 public $tpl;
16 public $messages;
17 public $pagination;
18
19 function __construct()
20 {
21 $this->initTpl();
22 if (!$this->checkBeforeInstall()) {
23 exit;
24 }
25 $this->store = new Database();
26 $this->init();
27 $this->messages = new Messages();
28
29 # installation
30 if(!$this->store->isInstalled())
31 {
32 $this->install();
33 }
34 }
35
36 /**
37 * all checks before installation.
38 * @return boolean
39 */
40 private function checkBeforeInstall()
41 {
42 $msg = '';
43 $allIsGood = TRUE;
44
45 if (!is_writable(CACHE)) {
46 Tools::logm('you don\'t have write access on cache directory');
47 die('You don\'t have write access on cache directory.');
48 }
49 else if (file_exists('./install/update.php') && !DEBUG_POCHE) {
50 $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>';
51 $allIsGood = FALSE;
52 }
53 else if (file_exists('./install') && !DEBUG_POCHE) {
54 $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>';
55 $allIsGood = FALSE;
56 }
57 else if (STORAGE == 'sqlite' && !is_writable(STORAGE_SQLITE)) {
58 Tools::logm('you don\'t have write access on sqlite file');
59 $msg = '<h1>error</h1><p>You don\'t have write access on sqlite file.</p>';
60 $allIsGood = FALSE;
61 }
62
63 if (!$allIsGood) {
64 echo $this->tpl->render('error.twig', array(
65 'msg' => $msg
66 ));
67 }
68
69 return $allIsGood;
70 }
71
72 private function initTpl()
73 {
74 # template engine
75 $loader = new Twig_Loader_Filesystem(TPL);
76 if (DEBUG_POCHE) {
77 $twig_params = array();
78 }
79 else {
80 $twig_params = array('cache' => CACHE);
81 }
82 $this->tpl = new Twig_Environment($loader, $twig_params);
83 $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
84 # filter to display domain name of an url
85 $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
86 $this->tpl->addFilter($filter);
87
88 # filter for reading time
89 $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
90 $this->tpl->addFilter($filter);
91 }
92
93 private function init()
94 {
95 Tools::initPhp();
96 Session::init();
97
98 if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
99 $this->user = $_SESSION['poche_user'];
100 }
101 else {
102 # fake user, just for install & login screens
103 $this->user = new User();
104 $this->user->setConfig($this->getDefaultConfig());
105 }
106
107 # l10n
108 $language = $this->user->getConfigValue('language');
109 putenv('LC_ALL=' . $language);
110 setlocale(LC_ALL, $language);
111 bindtextdomain($language, LOCALE);
112 textdomain($language);
113
114 # Pagination
115 $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
116 }
117
118 private function install()
119 {
120 Tools::logm('poche still not installed');
121 echo $this->tpl->render('install.twig', array(
122 'token' => Session::getToken()
123 ));
124 if (isset($_GET['install'])) {
125 if (($_POST['password'] == $_POST['password_repeat'])
126 && $_POST['password'] != "" && $_POST['login'] != "") {
127 # let's rock, install poche baby !
128 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
129 {
130 Session::logout();
131 Tools::logm('poche is now installed');
132 Tools::redirect();
133 }
134 }
135 else {
136 Tools::logm('error during installation');
137 Tools::redirect();
138 }
139 }
140 exit();
141 }
142
143 public function getDefaultConfig()
144 {
145 return array(
146 'pager' => PAGINATION,
147 'language' => LANG,
148 );
149 }
150
151 /**
152 * Call action (mark as fav, archive, delete, etc.)
153 */
154 public function action($action, Url $url, $id = 0, $import = FALSE)
155 {
156 switch ($action)
157 {
158 case 'add':
159 $content = $url->extract();
160
161 if ($this->store->add($url->getUrl(), $content['title'], $content['body'], $this->user->getId())) {
162 Tools::logm('add link ' . $url->getUrl());
163 $sequence = '';
164 if (STORAGE == 'postgres') {
165 $sequence = 'entries_id_seq';
166 }
167 $last_id = $this->store->getLastId($sequence);
168 if (DOWNLOAD_PICTURES) {
169 $content = filtre_picture($content['body'], $url->getUrl(), $last_id);
170 Tools::logm('updating content article');
171 $this->store->updateContent($last_id, $content, $this->user->getId());
172 }
173 if (!$import) {
174 $this->messages->add('s', _('the link has been added successfully'));
175 }
176 }
177 else {
178 if (!$import) {
179 $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
180 Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
181 }
182 }
183
184 if (!$import) {
185 Tools::redirect();
186 }
187 break;
188 case 'delete':
189 $msg = 'delete link #' . $id;
190 if ($this->store->deleteById($id, $this->user->getId())) {
191 if (DOWNLOAD_PICTURES) {
192 remove_directory(ABS_PATH . $id);
193 }
194 $this->messages->add('s', _('the link has been deleted successfully'));
195 }
196 else {
197 $this->messages->add('e', _('the link wasn\'t deleted'));
198 $msg = 'error : can\'t delete link #' . $id;
199 }
200 Tools::logm($msg);
201 Tools::redirect('?');
202 break;
203 case 'toggle_fav' :
204 $this->store->favoriteById($id, $this->user->getId());
205 Tools::logm('mark as favorite link #' . $id);
206 if (!$import) {
207 Tools::redirect();
208 }
209 break;
210 case 'toggle_archive' :
211 $this->store->archiveById($id, $this->user->getId());
212 Tools::logm('archive link #' . $id);
213 if (!$import) {
214 Tools::redirect();
215 }
216 break;
217 default:
218 break;
219 }
220 }
221
222 function displayView($view, $id = 0)
223 {
224 $tpl_vars = array();
225
226 switch ($view)
227 {
228 case 'config':
229 $dev = $this->getPocheVersion('dev');
230 $prod = $this->getPocheVersion('prod');
231 $compare_dev = version_compare(POCHE_VERSION, $dev);
232 $compare_prod = version_compare(POCHE_VERSION, $prod);
233 $tpl_vars = array(
234 'dev' => $dev,
235 'prod' => $prod,
236 'compare_dev' => $compare_dev,
237 'compare_prod' => $compare_prod,
238 );
239 Tools::logm('config view');
240 break;
241 case 'view':
242 $entry = $this->store->retrieveOneById($id, $this->user->getId());
243 if ($entry != NULL) {
244 Tools::logm('view link #' . $id);
245 $content = $entry['content'];
246 if (function_exists('tidy_parse_string')) {
247 $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
248 $tidy->cleanRepair();
249 $content = $tidy->value;
250 }
251 $tpl_vars = array(
252 'entry' => $entry,
253 'content' => $content,
254 );
255 }
256 else {
257 Tools::logm('error in view call : entry is null');
258 }
259 break;
260 default: # home, favorites and archive views
261 $entries = $this->store->getEntriesByView($view, $this->user->getId());
262 $tpl_vars = array(
263 'entries' => '',
264 'page_links' => '',
265 );
266 if (count($entries) > 0) {
267 $this->pagination->set_total(count($entries));
268 $page_links = $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&');
269 $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
270 $tpl_vars['entries'] = $datas;
271 $tpl_vars['page_links'] = $page_links;
272 }
273 Tools::logm('display ' . $view . ' view');
274 break;
275 }
276
277 return $tpl_vars;
278 }
279
280 /**
281 * update the password of the current user.
282 * if MODE_DEMO is TRUE, the password can't be updated.
283 * @todo add the return value
284 * @todo set the new password in function header like this updatePassword($newPassword)
285 * @return boolean
286 */
287 public function updatePassword()
288 {
289 if (MODE_DEMO) {
290 $this->messages->add('i', _('in demo mode, you can\'t update your password'));
291 Tools::logm('in demo mode, you can\'t do this');
292 Tools::redirect('?view=config');
293 }
294 else {
295 if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
296 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
297 $this->messages->add('s', _('your password has been updated'));
298 $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
299 Session::logout();
300 Tools::logm('password updated');
301 Tools::redirect();
302 }
303 else {
304 $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
305 Tools::redirect('?view=config');
306 }
307 }
308 }
309 }
310
311 /**
312 * checks if login & password are correct and save the user in session.
313 * it redirects the user to the $referer link
314 * @param string $referer the url to redirect after login
315 * @todo add the return value
316 * @return boolean
317 */
318 public function login($referer)
319 {
320 if (!empty($_POST['login']) && !empty($_POST['password'])) {
321 $user = $this->store->login($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']));
322 if ($user != array()) {
323 # Save login into Session
324 Session::login($user['username'], $user['password'], $_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login']), array('poche_user' => new User($user)));
325
326 $this->messages->add('s', _('welcome to your poche'));
327 if (!empty($_POST['longlastingsession'])) {
328 $_SESSION['longlastingsession'] = 31536000;
329 $_SESSION['expires_on'] = time() + $_SESSION['longlastingsession'];
330 session_set_cookie_params($_SESSION['longlastingsession']);
331 } else {
332 session_set_cookie_params(0);
333 }
334 session_regenerate_id(true);
335 Tools::logm('login successful');
336 Tools::redirect($referer);
337 }
338 $this->messages->add('e', _('login failed: bad login or password'));
339 Tools::logm('login failed');
340 Tools::redirect();
341 } else {
342 $this->messages->add('e', _('login failed: you have to fill all fields'));
343 Tools::logm('login failed');
344 Tools::redirect();
345 }
346 }
347
348 /**
349 * log out the poche user. It cleans the session.
350 * @todo add the return value
351 * @return boolean
352 */
353 public function logout()
354 {
355 $this->user = array();
356 Session::logout();
357 $this->messages->add('s', _('see you soon!'));
358 Tools::logm('logout');
359 Tools::redirect();
360 }
361
362 /**
363 * import from Instapaper. poche needs a ./instapaper-export.html file
364 * @todo add the return value
365 * @param string $targetFile the file used for importing
366 * @return boolean
367 */
368 private function importFromInstapaper($targetFile)
369 {
370 # TODO gestion des articles favs
371 $html = new simple_html_dom();
372 $html->load_file($targetFile);
373 Tools::logm('starting import from instapaper');
374
375 $read = 0;
376 $errors = array();
377 foreach($html->find('ol') as $ul)
378 {
379 foreach($ul->find('li') as $li)
380 {
381 $a = $li->find('a');
382 $url = new Url(base64_encode($a[0]->href));
383 $this->action('add', $url, 0, TRUE);
384 if ($read == '1') {
385 $sequence = '';
386 if (STORAGE == 'postgres') {
387 $sequence = 'entries_id_seq';
388 }
389 $last_id = $this->store->getLastId($sequence);
390 $this->action('toggle_archive', $url, $last_id, TRUE);
391 }
392 }
393
394 # the second <ol> is for read links
395 $read = 1;
396 }
397 $this->messages->add('s', _('import from instapaper completed'));
398 Tools::logm('import from instapaper completed');
399 Tools::redirect();
400 }
401
402 /**
403 * import from Pocket. poche needs a ./ril_export.html file
404 * @todo add the return value
405 * @param string $targetFile the file used for importing
406 * @return boolean
407 */
408 private function importFromPocket($targetFile)
409 {
410 # TODO gestion des articles favs
411 $html = new simple_html_dom();
412 $html->load_file($targetFile);
413 Tools::logm('starting import from pocket');
414
415 $read = 0;
416 $errors = array();
417 foreach($html->find('ul') as $ul)
418 {
419 foreach($ul->find('li') as $li)
420 {
421 $a = $li->find('a');
422 $url = new Url(base64_encode($a[0]->href));
423 $this->action('add', $url, 0, TRUE);
424 if ($read == '1') {
425 $sequence = '';
426 if (STORAGE == 'postgres') {
427 $sequence = 'entries_id_seq';
428 }
429 $last_id = $this->store->getLastId($sequence);
430 $this->action('toggle_archive', $url, $last_id, TRUE);
431 }
432 }
433
434 # the second <ul> is for read links
435 $read = 1;
436 }
437 $this->messages->add('s', _('import from pocket completed'));
438 Tools::logm('import from pocket completed');
439 Tools::redirect();
440 }
441
442 /**
443 * import from Readability. poche needs a ./readability file
444 * @todo add the return value
445 * @param string $targetFile the file used for importing
446 * @return boolean
447 */
448 private function importFromReadability($targetFile)
449 {
450 # TODO gestion des articles lus / favs
451 $str_data = file_get_contents($targetFile);
452 $data = json_decode($str_data,true);
453 Tools::logm('starting import from Readability');
454 $count = 0;
455 foreach ($data as $key => $value) {
456 $url = NULL;
457 $favorite = FALSE;
458 $archive = FALSE;
459 foreach ($value as $attr => $attr_value) {
460 if ($attr == 'article__url') {
461 $url = new Url(base64_encode($attr_value));
462 }
463 $sequence = '';
464 if (STORAGE == 'postgres') {
465 $sequence = 'entries_id_seq';
466 }
467 if ($attr_value == 'true') {
468 if ($attr == 'favorite') {
469 $favorite = TRUE;
470 }
471 if ($attr == 'archive') {
472 $archive = TRUE;
473 }
474 }
475 }
476 # we can add the url
477 if (!is_null($url) && $url->isCorrect()) {
478 $this->action('add', $url, 0, TRUE);
479 $count++;
480 if ($favorite) {
481 $last_id = $this->store->getLastId($sequence);
482 $this->action('toggle_fav', $url, $last_id, TRUE);
483 }
484 if ($archive) {
485 $last_id = $this->store->getLastId($sequence);
486 $this->action('toggle_archive', $url, $last_id, TRUE);
487 }
488 }
489 }
490 $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.'));
491 Tools::logm('import from Readability completed');
492 Tools::redirect();
493 }
494
495 /**
496 * import datas into your poche
497 * @param string $from name of the service to import : pocket, instapaper or readability
498 * @todo add the return value
499 * @return boolean
500 */
501 public function import($from)
502 {
503 $providers = array(
504 'pocket' => 'importFromPocket',
505 'readability' => 'importFromReadability',
506 'instapaper' => 'importFromInstapaper'
507 );
508
509 if (! isset($providers[$from])) {
510 $this->messages->add('e', _('Unknown import provider.'));
511 Tools::redirect();
512 }
513
514 $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
515 $targetFile = constant($targetDefinition);
516
517 if (! defined($targetDefinition)) {
518 $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
519 Tools::redirect();
520 }
521
522 if (! file_exists($targetFile)) {
523 $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
524 Tools::redirect();
525 }
526
527 $this->$providers[$from]($targetFile);
528 }
529
530 /**
531 * export poche entries in json
532 * @return json all poche entries
533 */
534 public function export()
535 {
536 $entries = $this->store->retrieveAll($this->user->getId());
537 echo $this->tpl->render('export.twig', array(
538 'export' => Tools::renderJson($entries),
539 ));
540 Tools::logm('export view');
541 }
542
543 /**
544 * Checks online the latest version of poche and cache it
545 * @param string $which 'prod' or 'dev'
546 * @return string latest $which version
547 */
548 private function getPocheVersion($which = 'prod')
549 {
550 $cache_file = CACHE . '/' . $which;
551
552 # checks if the cached version file exists
553 if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
554 $version = file_get_contents($cache_file);
555 } else {
556 $version = file_get_contents('http://static.inthepoche.com/versions/' . $which);
557 file_put_contents($cache_file, $version, LOCK_EX);
558 }
559 return $version;
560 }
561
562 function convertURLToBase64($plainurl){
563 $convertedURL = base64_encode($plainurl);
564 $this->action('add', new Url($convertedURL))
565 }
566 }