]> git.immae.eu Git - github/wallabag/wallabag.git/blame - inc/poche/Poche.class.php
add help about vendor.zip
[github/wallabag/wallabag.git] / inc / poche / Poche.class.php
CommitLineData
eb1af592
NL
1<?php
2/**
c95b78a8 3 * wallabag, self hostable application allowing you to not miss any content anymore
eb1af592 4 *
c95b78a8
NL
5 * @category wallabag
6 * @author Nicolas Lœuillet <nicolas@loeuillet.org>
eb1af592
NL
7 * @copyright 2013
8 * @license http://www.wtfpl.net/ see COPYING file
9 */
10
11class Poche
12{
00dbaf90
NL
13 public static $canRenderTemplates = true;
14 public static $configFileAvailable = true;
15
7ce7ec4c 16 public $user;
eb1af592
NL
17 public $store;
18 public $tpl;
55821e04 19 public $messages;
6a361945 20 public $pagination;
00dbaf90
NL
21
22 private $currentTheme = '';
5011388f 23 private $currentLanguage = '';
9d3b88b3 24 private $notInstalledMessage = array();
eb1af592 25
00dbaf90 26 public function __construct()
eb1af592 27 {
9d3b88b3
NL
28 if ($this->configFileIsAvailable()) {
29 $this->init();
00dbaf90
NL
30 }
31
9d3b88b3
NL
32 if ($this->themeIsInstalled()) {
33 $this->initTpl();
00dbaf90
NL
34 }
35
9d3b88b3
NL
36 if ($this->systemIsInstalled()) {
37 $this->store = new Database();
38 $this->messages = new Messages();
39 # installation
40 if (! $this->store->isInstalled()) {
41 $this->install();
42 }
5cfafc61 43 $this->store->checkTags();
eb1af592 44 }
eb1af592 45 }
00dbaf90
NL
46
47 private function init()
48 {
49 Tools::initPhp();
50 Session::$sessionName = 'poche';
51 Session::init();
eb1af592 52
00dbaf90
NL
53 if (isset($_SESSION['poche_user']) && $_SESSION['poche_user'] != array()) {
54 $this->user = $_SESSION['poche_user'];
55 } else {
56 # fake user, just for install & login screens
57 $this->user = new User();
58 $this->user->setConfig($this->getDefaultConfig());
59 }
60
61 # l10n
62 $language = $this->user->getConfigValue('language');
63 putenv('LC_ALL=' . $language);
64 setlocale(LC_ALL, $language);
65 bindtextdomain($language, LOCALE);
66 textdomain($language);
67
68 # Pagination
69 $this->pagination = new Paginator($this->user->getConfigValue('pager'), 'p');
70
71 # Set up theme
72 $themeDirectory = $this->user->getConfigValue('theme');
73
74 if ($themeDirectory === false) {
75 $themeDirectory = DEFAULT_THEME;
76 }
77
78 $this->currentTheme = $themeDirectory;
5011388f
NL
79
80 # Set up language
81 $languageDirectory = $this->user->getConfigValue('language');
82
83 if ($languageDirectory === false) {
84 $languageDirectory = DEFAULT_THEME;
85 }
86
87 $this->currentLanguage = $languageDirectory;
00dbaf90
NL
88 }
89
90 public function configFileIsAvailable() {
91 if (! self::$configFileAvailable) {
9d3b88b3 92 $this->notInstalledMessage[] = 'You have to rename inc/poche/config.inc.php.new to inc/poche/config.inc.php.';
00dbaf90
NL
93
94 return false;
95 }
96
97 return true;
98 }
99
100 public function themeIsInstalled() {
9d3b88b3 101 $passTheme = TRUE;
00dbaf90
NL
102 # Twig is an absolute requirement for Poche to function. Abort immediately if the Composer installer hasn't been run yet
103 if (! self::$canRenderTemplates) {
41265e07 104 $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.';
9d3b88b3 105 $passTheme = FALSE;
00dbaf90 106 }
7f17a38d
NL
107
108 if (! is_writable(CACHE)) {
9d3b88b3 109 $this->notInstalledMessage[] = 'You don\'t have write access on cache directory.';
7f17a38d
NL
110
111 self::$canRenderTemplates = false;
112
9d3b88b3 113 $passTheme = FALSE;
7f17a38d 114 }
00dbaf90
NL
115
116 # Check if the selected theme and its requirements are present
f4fbfaa7
NL
117 $theme = $this->getTheme();
118
119 if ($theme != '' && ! is_dir(THEME . '/' . $theme)) {
120 $this->notInstalledMessage[] = 'The currently selected theme (' . $theme . ') does not seem to be properly installed (Missing directory: ' . THEME . '/' . $theme . ')';
00dbaf90
NL
121
122 self::$canRenderTemplates = false;
123
9d3b88b3 124 $passTheme = FALSE;
00dbaf90
NL
125 }
126
f4fbfaa7
NL
127 $themeInfo = $this->getThemeInfo($theme);
128 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
129 foreach ($themeInfo['requirements'] as $requiredTheme) {
130 if (! is_dir(THEME . '/' . $requiredTheme)) {
131 $this->notInstalledMessage[] = 'The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')';
00dbaf90 132
f4fbfaa7 133 self::$canRenderTemplates = false;
00dbaf90 134
f4fbfaa7
NL
135 $passTheme = FALSE;
136 }
00dbaf90
NL
137 }
138 }
9d3b88b3
NL
139
140 if (!$passTheme) {
141 return FALSE;
142 }
143
00dbaf90
NL
144
145 return true;
146 }
147
4a291288
NL
148 /**
149 * all checks before installation.
00dbaf90 150 * @todo move HTML to template
4a291288
NL
151 * @return boolean
152 */
00dbaf90 153 public function systemIsInstalled()
eb1af592 154 {
9d3b88b3 155 $msg = TRUE;
00dbaf90
NL
156
157 $configSalt = defined('SALT') ? constant('SALT') : '';
158
159 if (empty($configSalt)) {
9d3b88b3
NL
160 $this->notInstalledMessage[] = 'You have not yet filled in the SALT value in the config.inc.php file.';
161 $msg = FALSE;
162 }
163 if (STORAGE == 'sqlite' && ! file_exists(STORAGE_SQLITE)) {
00dbaf90 164 Tools::logm('sqlite file doesn\'t exist');
9d3b88b3
NL
165 $this->notInstalledMessage[] = 'sqlite file doesn\'t exist, you can find it in install folder. Copy it in /db folder.';
166 $msg = FALSE;
167 }
168 if (is_dir(ROOT . '/install') && ! DEBUG_POCHE) {
169 $this->notInstalledMessage[] = 'you have to delete the /install folder before using poche.';
170 $msg = FALSE;
171 }
172 if (STORAGE == 'sqlite' && ! is_writable(STORAGE_SQLITE)) {
bb5a7d9e 173 Tools::logm('you don\'t have write access on sqlite file');
9d3b88b3
NL
174 $this->notInstalledMessage[] = 'You don\'t have write access on sqlite file.';
175 $msg = FALSE;
bb5a7d9e 176 }
00dbaf90 177
9d3b88b3 178 if (! $msg) {
00dbaf90 179 return false;
8d3275be 180 }
7ce7ec4c 181
00dbaf90
NL
182 return true;
183 }
184
185 public function getNotInstalledMessage() {
186 return $this->notInstalledMessage;
4a291288 187 }
eb1af592 188
4a291288
NL
189 private function initTpl()
190 {
00dbaf90 191 $loaderChain = new Twig_Loader_Chain();
f4fbfaa7 192 $theme = $this->getTheme();
00dbaf90
NL
193
194 # add the current theme as first to the loader chain so Twig will look there first for overridden template files
195 try {
f4fbfaa7 196 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $theme));
00dbaf90
NL
197 } catch (Twig_Error_Loader $e) {
198 # @todo isInstalled() should catch this, inject Twig later
f4fbfaa7 199 die('The currently selected theme (' . $theme . ') does not seem to be properly installed (' . THEME . '/' . $theme .' is missing)');
00dbaf90
NL
200 }
201
202 # add all required themes to the loader chain
f4fbfaa7
NL
203 $themeInfo = $this->getThemeInfo($theme);
204 if (isset($themeInfo['requirements']) && is_array($themeInfo['requirements'])) {
205 foreach ($themeInfo['requirements'] as $requiredTheme) {
206 try {
207 $loaderChain->addLoader(new Twig_Loader_Filesystem(THEME . '/' . $requiredTheme));
208 } catch (Twig_Error_Loader $e) {
209 # @todo isInstalled() should catch this, inject Twig later
210 die('The required "' . $requiredTheme . '" theme is missing for the current theme (' . $theme . ')');
211 }
00dbaf90
NL
212 }
213 }
214
bc1ee852 215 if (DEBUG_POCHE) {
f4fbfaa7 216 $twigParams = array();
00dbaf90 217 } else {
f4fbfaa7 218 $twigParams = array('cache' => CACHE);
bc1ee852 219 }
00dbaf90 220
f4fbfaa7 221 $this->tpl = new Twig_Environment($loaderChain, $twigParams);
eb1af592 222 $this->tpl->addExtension(new Twig_Extensions_Extension_I18n());
00dbaf90 223
55821e04
NL
224 # filter to display domain name of an url
225 $filter = new Twig_SimpleFilter('getDomain', 'Tools::getDomain');
226 $this->tpl->addFilter($filter);
eb1af592 227
d9178758
NL
228 # filter for reading time
229 $filter = new Twig_SimpleFilter('getReadingTime', 'Tools::getReadingTime');
230 $this->tpl->addFilter($filter);
eb1af592
NL
231 }
232
f4fbfaa7 233 private function install()
eb1af592
NL
234 {
235 Tools::logm('poche still not installed');
236 echo $this->tpl->render('install.twig', array(
00dbaf90
NL
237 'token' => Session::getToken(),
238 'theme' => $this->getTheme(),
239 'poche_url' => Tools::getPocheUrl()
eb1af592
NL
240 ));
241 if (isset($_GET['install'])) {
242 if (($_POST['password'] == $_POST['password_repeat'])
243 && $_POST['password'] != "" && $_POST['login'] != "") {
244 # let's rock, install poche baby !
bb5a7d9e
NL
245 if ($this->store->install($_POST['login'], Tools::encodeString($_POST['password'] . $_POST['login'])))
246 {
247 Session::logout();
248 Tools::logm('poche is now installed');
249 Tools::redirect();
250 }
6a361945
NL
251 }
252 else {
253 Tools::logm('error during installation');
eb1af592
NL
254 Tools::redirect();
255 }
256 }
257 exit();
258 }
00dbaf90
NL
259
260 public function getTheme() {
261 return $this->currentTheme;
262 }
5011388f 263
f4fbfaa7
NL
264 /**
265 * Provides theme information by parsing theme.ini file if present in the theme's root directory.
266 * In all cases, the following data will be returned:
267 * - name: theme's name, or key if the theme is unnamed,
268 * - current: boolean informing if the theme is the current user theme.
269 *
270 * @param string $theme Theme key (directory name)
271 * @return array|boolean Theme information, or false if the theme doesn't exist.
272 */
273 public function getThemeInfo($theme) {
274 if (!is_dir(THEME . '/' . $theme)) {
275 return false;
276 }
277
278 $themeIniFile = THEME . '/' . $theme . '/theme.ini';
279 $themeInfo = array();
280
281 if (is_file($themeIniFile) && is_readable($themeIniFile)) {
282 $themeInfo = parse_ini_file($themeIniFile);
283 }
284
285 if ($themeInfo === false) {
286 $themeInfo = array();
287 }
288 if (!isset($themeInfo['name'])) {
289 $themeInfo['name'] = $theme;
290 }
291 $themeInfo['current'] = ($theme === $this->getTheme());
292
293 return $themeInfo;
5011388f 294 }
00dbaf90
NL
295
296 public function getInstalledThemes() {
297 $handle = opendir(THEME);
298 $themes = array();
f4fbfaa7 299
00dbaf90
NL
300 while (($theme = readdir($handle)) !== false) {
301 # Themes are stored in a directory, so all directory names are themes
302 # @todo move theme installation data to database
f4fbfaa7 303 if (!is_dir(THEME . '/' . $theme) || in_array($theme, array('.', '..'))) {
00dbaf90
NL
304 continue;
305 }
f4fbfaa7
NL
306
307 $themes[$theme] = $this->getThemeInfo($theme);
00dbaf90 308 }
f4fbfaa7 309
00dbaf90
NL
310 return $themes;
311 }
eb1af592 312
f4fbfaa7
NL
313 public function getLanguage() {
314 return $this->currentLanguage;
315 }
316
5011388f
NL
317 public function getInstalledLanguages() {
318 $handle = opendir(LOCALE);
319 $languages = array();
320
321 while (($language = readdir($handle)) !== false) {
322 # Languages are stored in a directory, so all directory names are languages
323 # @todo move language installation data to database
324 if (! is_dir(LOCALE . '/' . $language) || in_array($language, array('..', '.'))) {
325 continue;
326 }
327
328 $current = false;
329
330 if ($language === $this->getLanguage()) {
331 $current = true;
332 }
333
334 $languages[] = array('name' => $language, 'current' => $current);
335 }
336
337 return $languages;
338 }
339
8d3275be 340 public function getDefaultConfig()
00dbaf90 341 {
8d3275be
NL
342 return array(
343 'pager' => PAGINATION,
344 'language' => LANG,
00dbaf90
NL
345 'theme' => DEFAULT_THEME
346 );
8d3275be
NL
347 }
348
f878daeb 349 protected function getPageContent(Url $url)
350 {
351 $options = array('http' => array('user_agent' => 'poche'));
352 if (isset($_SERVER['AUTH_TYPE']) && "basic" === strtolower($_SERVER['AUTH_TYPE'])) {
353 $options['http']['header'] = sprintf(
354 "Authorization: Basic %s",
355 base64_encode(
356 sprintf('%s:%s', $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'])
357 )
358 );
359 }
360 $context = stream_context_create($options);
361 $json = file_get_contents(Tools::getPocheUrl() . '/inc/3rdparty/makefulltextfeed.php?url='.urlencode($url->getUrl()).'&max=5&links=preserve&exc=&format=json&submit=Create+Feed', false, $context);
362 return json_decode($json, true);
363 }
364
eb1af592
NL
365 /**
366 * Call action (mark as fav, archive, delete, etc.)
367 */
363bc4eb 368 public function action($action, Url $url, $id = 0, $import = FALSE, $autoclose = FALSE)
eb1af592
NL
369 {
370 switch ($action)
371 {
372 case 'add':
f878daeb 373 $content = $this->getPageContent($url);
fa0bfb77 374 $title = ($content['rss']['channel']['item']['title'] != '') ? $content['rss']['channel']['item']['title'] : _('Untitled');
42c80841 375 $body = $content['rss']['channel']['item']['description'];
ec397236 376
42c80841 377 if ($this->store->add($url->getUrl(), $title, $body, $this->user->getId())) {
ec397236
NL
378 Tools::logm('add link ' . $url->getUrl());
379 $sequence = '';
380 if (STORAGE == 'postgres') {
381 $sequence = 'entries_id_seq';
eb1af592 382 }
ec397236
NL
383 $last_id = $this->store->getLastId($sequence);
384 if (DOWNLOAD_PICTURES) {
42c80841 385 $content = filtre_picture($body, $url->getUrl(), $last_id);
ec397236
NL
386 Tools::logm('updating content article');
387 $this->store->updateContent($last_id, $content, $this->user->getId());
388 }
389 if (!$import) {
390 $this->messages->add('s', _('the link has been added successfully'));
eb1af592
NL
391 }
392 }
393 else {
b916bcfc 394 if (!$import) {
ec397236
NL
395 $this->messages->add('e', _('error during insertion : the link wasn\'t added'));
396 Tools::logm('error during insertion : the link wasn\'t added ' . $url->getUrl());
b916bcfc
NL
397 }
398 }
ec397236 399
b916bcfc 400 if (!$import) {
363bc4eb 401 if ($autoclose == TRUE) {
402 Tools::redirect('?view=home');
403 } else {
f616ab60 404 Tools::redirect('?view=home&closewin=true');
363bc4eb 405 }
eb1af592
NL
406 }
407 break;
408 case 'delete':
bc1ee852 409 $msg = 'delete link #' . $id;
8d3275be 410 if ($this->store->deleteById($id, $this->user->getId())) {
eb1af592
NL
411 if (DOWNLOAD_PICTURES) {
412 remove_directory(ABS_PATH . $id);
413 }
6a361945 414 $this->messages->add('s', _('the link has been deleted successfully'));
eb1af592
NL
415 }
416 else {
6a361945 417 $this->messages->add('e', _('the link wasn\'t deleted'));
bc1ee852 418 $msg = 'error : can\'t delete link #' . $id;
eb1af592 419 }
bc1ee852 420 Tools::logm($msg);
985ce3ec 421 Tools::redirect('?');
eb1af592
NL
422 break;
423 case 'toggle_fav' :
8d3275be 424 $this->store->favoriteById($id, $this->user->getId());
eb1af592 425 Tools::logm('mark as favorite link #' . $id);
b916bcfc
NL
426 if (!$import) {
427 Tools::redirect();
428 }
eb1af592
NL
429 break;
430 case 'toggle_archive' :
8d3275be 431 $this->store->archiveById($id, $this->user->getId());
eb1af592 432 Tools::logm('archive link #' . $id);
b916bcfc
NL
433 if (!$import) {
434 Tools::redirect();
435 }
eb1af592 436 break;
f14807de
NL
437 case 'archive_all' :
438 $this->store->archiveAll($this->user->getId());
439 Tools::logm('archive all links');
440 if (!$import) {
441 Tools::redirect();
442 }
443 break;
c432fa16
NL
444 case 'add_tag' :
445 $tags = explode(',', $_POST['value']);
446 $entry_id = $_POST['entry_id'];
447 foreach($tags as $key => $tag_value) {
448 $value = trim($tag_value);
449 $tag = $this->store->retrieveTagByValue($value);
450
451 if (is_null($tag)) {
452 # we create the tag
453 $tag = $this->store->createTag($value);
454 $sequence = '';
455 if (STORAGE == 'postgres') {
456 $sequence = 'tags_id_seq';
457 }
458 $tag_id = $this->store->getLastId($sequence);
459 }
460 else {
461 $tag_id = $tag['id'];
462 }
463
464 # we assign the tag to the article
465 $this->store->setTagToEntry($tag_id, $entry_id);
466 }
467 Tools::redirect();
468 break;
469 case 'remove_tag' :
470 $tag_id = $_GET['tag_id'];
471 $this->store->removeTagForEntry($id, $tag_id);
472 Tools::redirect();
473 break;
eb1af592
NL
474 default:
475 break;
476 }
477 }
478
479 function displayView($view, $id = 0)
480 {
481 $tpl_vars = array();
482
483 switch ($view)
484 {
eb1af592 485 case 'config':
044bf638
NL
486 $dev = trim($this->getPocheVersion('dev'));
487 $prod = trim($this->getPocheVersion('prod'));
031df528
NL
488 $compare_dev = version_compare(POCHE, $dev);
489 $compare_prod = version_compare(POCHE, $prod);
00dbaf90 490 $themes = $this->getInstalledThemes();
5011388f 491 $languages = $this->getInstalledLanguages();
72c20a52 492 $token = $this->user->getConfigValue('token');
1810c13b 493 $http_auth = (isset($_SERVER['PHP_AUTH_USER']) || isset($_SERVER['REMOTE_USER'])) ? true : false;
32520785 494 $tpl_vars = array(
00dbaf90 495 'themes' => $themes,
5011388f 496 'languages' => $languages,
32520785
NL
497 'dev' => $dev,
498 'prod' => $prod,
499 'compare_dev' => $compare_dev,
500 'compare_prod' => $compare_prod,
72c20a52
NL
501 'token' => $token,
502 'user_id' => $this->user->getId(),
df6afaf0 503 'http_auth' => $http_auth,
32520785 504 );
eb1af592
NL
505 Tools::logm('config view');
506 break;
6cab59c3
NL
507 case 'edit-tags':
508 # tags
509 $tags = $this->store->retrieveTagsByEntry($id);
510 $tpl_vars = array(
c432fa16 511 'entry_id' => $id,
6cab59c3
NL
512 'tags' => $tags,
513 );
514 break;
4886ed6d
NL
515 case 'tag':
516 $entries = $this->store->retrieveEntriesByTag($id);
517 $tag = $this->store->retrieveTag($id);
518 $tpl_vars = array(
519 'tag' => $tag,
520 'entries' => $entries,
521 );
522 break;
2e2ebe5e 523 case 'tags':
f778e472 524 $token = $this->user->getConfigValue('token');
2e2ebe5e
NL
525 $tags = $this->store->retrieveAllTags();
526 $tpl_vars = array(
f778e472
NL
527 'token' => $token,
528 'user_id' => $this->user->getId(),
2e2ebe5e
NL
529 'tags' => $tags,
530 );
531 break;
eb1af592 532 case 'view':
8d3275be 533 $entry = $this->store->retrieveOneById($id, $this->user->getId());
eb1af592
NL
534 if ($entry != NULL) {
535 Tools::logm('view link #' . $id);
536 $content = $entry['content'];
537 if (function_exists('tidy_parse_string')) {
538 $tidy = tidy_parse_string($content, array('indent'=>true, 'show-body-only' => true), 'UTF8');
539 $tidy->cleanRepair();
540 $content = $tidy->value;
3408ed48 541 }
a3223127 542
3408ed48
NL
543 # flattr checking
544 $flattr = new FlattrItem();
7b171c73
NL
545 $flattr->checkItem($entry['url'], $entry['id']);
546
547 # tags
548 $tags = $this->store->retrieveTagsByEntry($entry['id']);
a3223127 549
3408ed48 550 $tpl_vars = array(
7b171c73
NL
551 'entry' => $entry,
552 'content' => $content,
553 'flattr' => $flattr,
554 'tags' => $tags
3408ed48 555 );
eb1af592
NL
556 }
557 else {
d8d1542e 558 Tools::logm('error in view call : entry is null');
eb1af592
NL
559 }
560 break;
12d9cfbc 561 default: # home, favorites and archive views
8d3275be 562 $entries = $this->store->getEntriesByView($view, $this->user->getId());
eb1af592 563 $tpl_vars = array(
3eb04903
N
564 'entries' => '',
565 'page_links' => '',
7f9f5281 566 'nb_results' => '',
eb1af592 567 );
34d67c83 568
3eb04903
N
569 if (count($entries) > 0) {
570 $this->pagination->set_total(count($entries));
c515ffec
MR
571 $page_links = str_replace(array('previous', 'next'), array(_('previous'), _('next')),
572 $this->pagination->page_links('?view=' . $view . '&sort=' . $_SESSION['sort'] . '&'));
3eb04903
N
573 $datas = $this->store->getEntriesByView($view, $this->user->getId(), $this->pagination->get_limit());
574 $tpl_vars['entries'] = $datas;
575 $tpl_vars['page_links'] = $page_links;
7f9f5281 576 $tpl_vars['nb_results'] = count($entries);
3eb04903 577 }
6a361945 578 Tools::logm('display ' . $view . ' view');
eb1af592
NL
579 break;
580 }
581
582 return $tpl_vars;
583 }
c765c367 584
07ee09f4
NL
585 /**
586 * update the password of the current user.
587 * if MODE_DEMO is TRUE, the password can't be updated.
588 * @todo add the return value
589 * @todo set the new password in function header like this updatePassword($newPassword)
590 * @return boolean
591 */
c765c367
NL
592 public function updatePassword()
593 {
55821e04 594 if (MODE_DEMO) {
8d3275be 595 $this->messages->add('i', _('in demo mode, you can\'t update your password'));
55821e04 596 Tools::logm('in demo mode, you can\'t do this');
6a361945 597 Tools::redirect('?view=config');
55821e04
NL
598 }
599 else {
600 if (isset($_POST['password']) && isset($_POST['password_repeat'])) {
601 if ($_POST['password'] == $_POST['password_repeat'] && $_POST['password'] != "") {
8d3275be
NL
602 $this->messages->add('s', _('your password has been updated'));
603 $this->store->updatePassword($this->user->getId(), Tools::encodeString($_POST['password'] . $this->user->getUsername()));
c765c367 604 Session::logout();
8d3275be 605 Tools::logm('password updated');
c765c367
NL
606 Tools::redirect();
607 }
608 else {
8d3275be 609 $this->messages->add('e', _('the two fields have to be filled & the password must be the same in the two fields'));
6a361945 610 Tools::redirect('?view=config');
c765c367
NL
611 }
612 }
613 }
614 }
00dbaf90
NL
615
616 public function updateTheme()
617 {
618 # no data
619 if (empty($_POST['theme'])) {
620 }
621
622 # we are not going to change it to the current theme...
623 if ($_POST['theme'] == $this->getTheme()) {
624 $this->messages->add('w', _('still using the "' . $this->getTheme() . '" theme!'));
625 Tools::redirect('?view=config');
626 }
627
628 $themes = $this->getInstalledThemes();
629 $actualTheme = false;
630
f4fbfaa7
NL
631 foreach (array_keys($themes) as $theme) {
632 if ($theme == $_POST['theme']) {
00dbaf90
NL
633 $actualTheme = true;
634 break;
635 }
636 }
637
638 if (! $actualTheme) {
639 $this->messages->add('e', _('that theme does not seem to be installed'));
640 Tools::redirect('?view=config');
641 }
642
643 $this->store->updateUserConfig($this->user->getId(), 'theme', $_POST['theme']);
644 $this->messages->add('s', _('you have changed your theme preferences'));
645
646 $currentConfig = $_SESSION['poche_user']->config;
647 $currentConfig['theme'] = $_POST['theme'];
648
649 $_SESSION['poche_user']->setConfig($currentConfig);
650
651 Tools::redirect('?view=config');
652 }
c765c367 653
5011388f
NL
654 public function updateLanguage()
655 {
656 # no data
657 if (empty($_POST['language'])) {
658 }
659
660 # we are not going to change it to the current language...
661 if ($_POST['language'] == $this->getLanguage()) {
662 $this->messages->add('w', _('still using the "' . $this->getLanguage() . '" language!'));
663 Tools::redirect('?view=config');
664 }
665
666 $languages = $this->getInstalledLanguages();
667 $actualLanguage = false;
668
669 foreach ($languages as $language) {
670 if ($language['name'] == $_POST['language']) {
671 $actualLanguage = true;
672 break;
673 }
674 }
675
676 if (! $actualLanguage) {
677 $this->messages->add('e', _('that language does not seem to be installed'));
678 Tools::redirect('?view=config');
679 }
680
681 $this->store->updateUserConfig($this->user->getId(), 'language', $_POST['language']);
682 $this->messages->add('s', _('you have changed your language preferences'));
683
684 $currentConfig = $_SESSION['poche_user']->config;
685 $currentConfig['language'] = $_POST['language'];
686
687 $_SESSION['poche_user']->setConfig($currentConfig);
688
689 Tools::redirect('?view=config');
690 }
691
df6afaf0
DS
692 /**
693 * get credentials from differents sources
694 * it redirects the user to the $referer link
695 * @return array
696 */
1810c13b
NL
697 private function credentials() {
698 if(isset($_SERVER['PHP_AUTH_USER'])) {
6af66b11 699 return array($_SERVER['PHP_AUTH_USER'],'php_auth',true);
1810c13b
NL
700 }
701 if(!empty($_POST['login']) && !empty($_POST['password'])) {
6af66b11 702 return array($_POST['login'],$_POST['password'],false);
1810c13b
NL
703 }
704 if(isset($_SERVER['REMOTE_USER'])) {
6af66b11 705 return array($_SERVER['REMOTE_USER'],'http_auth',true);
1810c13b 706 }
5cfafc61 707
6af66b11
MR
708 return array(false,false,false);
709 }
df6afaf0 710
07ee09f4
NL
711 /**
712 * checks if login & password are correct and save the user in session.
713 * it redirects the user to the $referer link
714 * @param string $referer the url to redirect after login
715 * @todo add the return value
716 * @return boolean
717 */
c765c367
NL
718 public function login($referer)
719 {
6af66b11 720 list($login,$password,$isauthenticated)=$this->credentials();
df6afaf0
DS
721 if($login === false || $password === false) {
722 $this->messages->add('e', _('login failed: you have to fill all fields'));
723 Tools::logm('login failed');
724 Tools::redirect();
725 }
726 if (!empty($login) && !empty($password)) {
6af66b11 727 $user = $this->store->login($login, Tools::encodeString($password . $login), $isauthenticated);
7ce7ec4c
NL
728 if ($user != array()) {
729 # Save login into Session
6af66b11
MR
730 $longlastingsession = isset($_POST['longlastingsession']);
731 $passwordTest = ($isauthenticated) ? $user['password'] : Tools::encodeString($password . $login);
732 Session::login($user['username'], $user['password'], $login, $passwordTest, $longlastingsession, array('poche_user' => new User($user)));
26929c08 733 $this->messages->add('s', _('welcome to your wallabag'));
8d3275be 734 Tools::logm('login successful');
c765c367
NL
735 Tools::redirect($referer);
736 }
8d3275be 737 $this->messages->add('e', _('login failed: bad login or password'));
c765c367
NL
738 Tools::logm('login failed');
739 Tools::redirect();
c765c367
NL
740 }
741 }
742
07ee09f4
NL
743 /**
744 * log out the poche user. It cleans the session.
745 * @todo add the return value
746 * @return boolean
747 */
c765c367
NL
748 public function logout()
749 {
7ce7ec4c 750 $this->user = array();
c765c367 751 Session::logout();
b916bcfc 752 Tools::logm('logout');
c765c367
NL
753 Tools::redirect();
754 }
755
07ee09f4
NL
756 /**
757 * import from Instapaper. poche needs a ./instapaper-export.html file
758 * @todo add the return value
66b6a3b5 759 * @param string $targetFile the file used for importing
07ee09f4
NL
760 * @return boolean
761 */
66b6a3b5 762 private function importFromInstapaper($targetFile)
c765c367 763 {
7f959169 764 # TODO gestion des articles favs
a62788c6 765 $html = new simple_html_dom();
66b6a3b5 766 $html->load_file($targetFile);
b916bcfc 767 Tools::logm('starting import from instapaper');
a62788c6
NL
768
769 $read = 0;
770 $errors = array();
771 foreach($html->find('ol') as $ul)
772 {
773 foreach($ul->find('li') as $li)
774 {
775 $a = $li->find('a');
776 $url = new Url(base64_encode($a[0]->href));
b916bcfc 777 $this->action('add', $url, 0, TRUE);
a62788c6 778 if ($read == '1') {
b916bcfc
NL
779 $sequence = '';
780 if (STORAGE == 'postgres') {
781 $sequence = 'entries_id_seq';
782 }
783 $last_id = $this->store->getLastId($sequence);
784 $this->action('toggle_archive', $url, $last_id, TRUE);
a62788c6
NL
785 }
786 }
7f959169
NL
787
788 # the second <ol> is for read links
a62788c6
NL
789 $read = 1;
790 }
8d3275be 791 $this->messages->add('s', _('import from instapaper completed'));
63c35580
NL
792 Tools::logm('import from instapaper completed');
793 Tools::redirect();
794 }
c765c367 795
07ee09f4
NL
796 /**
797 * import from Pocket. poche needs a ./ril_export.html file
798 * @todo add the return value
66b6a3b5 799 * @param string $targetFile the file used for importing
07ee09f4
NL
800 * @return boolean
801 */
66b6a3b5 802 private function importFromPocket($targetFile)
63c35580 803 {
7f959169 804 # TODO gestion des articles favs
63c35580 805 $html = new simple_html_dom();
66b6a3b5 806 $html->load_file($targetFile);
b916bcfc 807 Tools::logm('starting import from pocket');
63c35580
NL
808
809 $read = 0;
810 $errors = array();
811 foreach($html->find('ul') as $ul)
812 {
813 foreach($ul->find('li') as $li)
c765c367 814 {
63c35580
NL
815 $a = $li->find('a');
816 $url = new Url(base64_encode($a[0]->href));
b916bcfc 817 $this->action('add', $url, 0, TRUE);
63c35580 818 if ($read == '1') {
b916bcfc
NL
819 $sequence = '';
820 if (STORAGE == 'postgres') {
821 $sequence = 'entries_id_seq';
822 }
823 $last_id = $this->store->getLastId($sequence);
824 $this->action('toggle_archive', $url, $last_id, TRUE);
c765c367 825 }
c765c367 826 }
7f959169
NL
827
828 # the second <ul> is for read links
63c35580 829 $read = 1;
c765c367 830 }
8d3275be 831 $this->messages->add('s', _('import from pocket completed'));
63c35580
NL
832 Tools::logm('import from pocket completed');
833 Tools::redirect();
834 }
c765c367 835
07ee09f4
NL
836 /**
837 * import from Readability. poche needs a ./readability file
838 * @todo add the return value
66b6a3b5 839 * @param string $targetFile the file used for importing
07ee09f4
NL
840 * @return boolean
841 */
66b6a3b5 842 private function importFromReadability($targetFile)
63c35580 843 {
7f959169 844 # TODO gestion des articles lus / favs
66b6a3b5 845 $str_data = file_get_contents($targetFile);
63c35580 846 $data = json_decode($str_data,true);
b916bcfc 847 Tools::logm('starting import from Readability');
c0d321c1 848 $count = 0;
63c35580 849 foreach ($data as $key => $value) {
c0d321c1
NL
850 $url = NULL;
851 $favorite = FALSE;
852 $archive = FALSE;
9bc32632
NL
853 foreach ($value as $item) {
854 foreach ($item as $attr => $value) {
855 if ($attr == 'article__url') {
856 $url = new Url(base64_encode($value));
c0d321c1 857 }
9bc32632
NL
858 $sequence = '';
859 if (STORAGE == 'postgres') {
860 $sequence = 'entries_id_seq';
861 }
862 if ($value == 'true') {
863 if ($attr == 'favorite') {
864 $favorite = TRUE;
865 }
866 if ($attr == 'archive') {
867 $archive = TRUE;
868 }
c0d321c1
NL
869 }
870 }
9bc32632
NL
871
872 # we can add the url
873 if (!is_null($url) && $url->isCorrect()) {
874 $this->action('add', $url, 0, TRUE);
875 $count++;
876 if ($favorite) {
877 $last_id = $this->store->getLastId($sequence);
878 $this->action('toggle_fav', $url, $last_id, TRUE);
879 }
880 if ($archive) {
881 $last_id = $this->store->getLastId($sequence);
882 $this->action('toggle_archive', $url, $last_id, TRUE);
883 }
b916bcfc 884 }
c765c367 885 }
c765c367 886 }
c0d321c1 887 $this->messages->add('s', _('import from Readability completed. ' . $count . ' new links.'));
63c35580
NL
888 Tools::logm('import from Readability completed');
889 Tools::redirect();
c765c367
NL
890 }
891
89051914
NL
892 /**
893 * import from Poche exported file
894 * @param string $targetFile the file used for importing
895 * @return boolean
896 */
897 private function importFromPoche($targetFile)
898 {
899 $str_data = file_get_contents($targetFile);
900 $data = json_decode($str_data,true);
901 Tools::logm('starting import from Poche');
902
903
904 $sequence = '';
905 if (STORAGE == 'postgres') {
906 $sequence = 'entries_id_seq';
907 }
908
909 $count = 0;
910 foreach ($data as $value) {
911
912 $url = new Url(base64_encode($value['url']));
913 $favorite = ($value['is_fav'] == -1);
914 $archive = ($value['is_read'] == -1);
915
916 # we can add the url
917 if (!is_null($url) && $url->isCorrect()) {
918
919 $this->action('add', $url, 0, TRUE);
920
921 $count++;
922 if ($favorite) {
923 $last_id = $this->store->getLastId($sequence);
924 $this->action('toggle_fav', $url, $last_id, TRUE);
925 }
926 if ($archive) {
927 $last_id = $this->store->getLastId($sequence);
928 $this->action('toggle_archive', $url, $last_id, TRUE);
929 }
930 }
931
932 }
933 $this->messages->add('s', _('import from Poche completed. ' . $count . ' new links.'));
934 Tools::logm('import from Poche completed');
935 Tools::redirect();
936 }
937
07ee09f4
NL
938 /**
939 * import datas into your poche
940 * @param string $from name of the service to import : pocket, instapaper or readability
941 * @todo add the return value
942 * @return boolean
943 */
63c35580 944 public function import($from)
c765c367 945 {
66b6a3b5
E
946 $providers = array(
947 'pocket' => 'importFromPocket',
948 'readability' => 'importFromReadability',
89051914
NL
949 'instapaper' => 'importFromInstapaper',
950 'poche' => 'importFromPoche',
66b6a3b5
E
951 );
952
953 if (! isset($providers[$from])) {
954 $this->messages->add('e', _('Unknown import provider.'));
955 Tools::redirect();
63c35580 956 }
66b6a3b5
E
957
958 $targetDefinition = 'IMPORT_' . strtoupper($from) . '_FILE';
959 $targetFile = constant($targetDefinition);
960
961 if (! defined($targetDefinition)) {
962 $this->messages->add('e', _('Incomplete inc/poche/define.inc.php file, please define "' . $targetDefinition . '".'));
963 Tools::redirect();
63c35580 964 }
66b6a3b5
E
965
966 if (! file_exists($targetFile)) {
967 $this->messages->add('e', _('Could not find required "' . $targetFile . '" import file.'));
968 Tools::redirect();
63c35580 969 }
66b6a3b5
E
970
971 $this->$providers[$from]($targetFile);
63c35580 972 }
c765c367 973
07ee09f4
NL
974 /**
975 * export poche entries in json
976 * @return json all poche entries
977 */
63c35580
NL
978 public function export()
979 {
8d3275be 980 $entries = $this->store->retrieveAll($this->user->getId());
63c35580
NL
981 echo $this->tpl->render('export.twig', array(
982 'export' => Tools::renderJson($entries),
983 ));
984 Tools::logm('export view');
c765c367 985 }
32520785 986
07ee09f4 987 /**
a3436d4c 988 * Checks online the latest version of poche and cache it
07ee09f4
NL
989 * @param string $which 'prod' or 'dev'
990 * @return string latest $which version
991 */
32520785
NL
992 private function getPocheVersion($which = 'prod')
993 {
994 $cache_file = CACHE . '/' . $which;
a3436d4c
NL
995
996 # checks if the cached version file exists
32520785
NL
997 if (file_exists($cache_file) && (filemtime($cache_file) > (time() - 86400 ))) {
998 $version = file_get_contents($cache_file);
999 } else {
3e0e7e12 1000 $version = file_get_contents('http://static.wallabag.org/versions/' . $which);
32520785
NL
1001 file_put_contents($cache_file, $version, LOCK_EX);
1002 }
1003 return $version;
1004 }
72c20a52
NL
1005
1006 public function generateToken()
1007 {
1008 if (ini_get('open_basedir') === '') {
1009 $token = substr(base64_encode(file_get_contents('/dev/urandom', false, null, 0, 20)), 0, 15);
1010 }
1011 else {
1012 $token = substr(base64_encode(uniqid(mt_rand(), true)), 0, 20);
1013 }
1014
044bf638 1015 $token = str_replace('+', '', $token);
72c20a52
NL
1016 $this->store->updateUserConfig($this->user->getId(), 'token', $token);
1017 $currentConfig = $_SESSION['poche_user']->config;
1018 $currentConfig['token'] = $token;
1019 $_SESSION['poche_user']->setConfig($currentConfig);
1020 }
1021
f778e472 1022 public function generateFeeds($token, $user_id, $tag_id, $type = 'home')
72c20a52 1023 {
f778e472 1024 $allowed_types = array('home', 'fav', 'archive', 'tag');
72c20a52
NL
1025 $config = $this->store->getConfigUser($user_id);
1026
1027 if (!in_array($type, $allowed_types) ||
1028 $token != $config['token']) {
1029 die(_('Uh, there is a problem while generating feeds.'));
1030 }
1031 // Check the token
1032
9e7c840b 1033 $feed = new FeedWriter(RSS2);
2e4440c3 1034 $feed->setTitle('wallabag — ' . $type . ' feed');
72c20a52 1035 $feed->setLink(Tools::getPocheUrl());
9e7c840b 1036 $feed->setChannelElement('updated', date(DATE_RSS , time()));
2e4440c3 1037 $feed->setChannelElement('author', 'wallabag');
72c20a52 1038
f778e472
NL
1039 if ($type == 'tag') {
1040 $entries = $this->store->retrieveEntriesByTag($tag_id);
1041 }
1042 else {
1043 $entries = $this->store->getEntriesByView($type, $user_id);
1044 }
1045
72c20a52
NL
1046 if (count($entries) > 0) {
1047 foreach ($entries as $entry) {
1048 $newItem = $feed->createNewItem();
0b57c682 1049 $newItem->setTitle($entry['title']);
72c20a52
NL
1050 $newItem->setLink(Tools::getPocheUrl() . '?view=view&amp;id=' . $entry['id']);
1051 $newItem->setDate(time());
1052 $newItem->setDescription($entry['content']);
1053 $feed->addItem($newItem);
1054 }
1055 }
1056
1057 $feed->genarateFeed();
1058 exit;
1059 }
df6afaf0 1060}