]> git.immae.eu Git - github/shaarli/Shaarli.git/blob - index.php
030fdfa3132512694773831e5af19f1475c60683
[github/shaarli/Shaarli.git] / index.php
1 <?php
2 /**
3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
4 *
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
7 *
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
11 *
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
13 */
14
15 // Set 'UTC' as the default timezone if it is not defined in php.ini
16 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
17 if (date_default_timezone_get() == '') {
18 date_default_timezone_set('UTC');
19 }
20
21 /*
22 * PHP configuration
23 */
24
25 // http://server.com/x/shaarli --> /shaarli/
26 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+strrpos($_SERVER['REQUEST_URI'], '/', 0)));
27
28 // High execution time in case of problematic imports/exports.
29 ini_set('max_input_time', '60');
30
31 // Try to set max upload file size and read
32 ini_set('memory_limit', '128M');
33 ini_set('post_max_size', '16M');
34 ini_set('upload_max_filesize', '16M');
35
36 // See all error except warnings
37 error_reporting(E_ALL^E_WARNING);
38
39 // 3rd-party libraries
40 if (! file_exists(__DIR__ . '/vendor/autoload.php')) {
41 header('Content-Type: text/plain; charset=utf-8');
42 echo "Error: missing Composer configuration\n\n"
43 ."If you installed Shaarli through Git or using the development branch,\n"
44 ."please refer to the installation documentation to install PHP"
45 ." dependencies using Composer:\n"
46 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
47 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
48 exit;
49 }
50 require_once 'inc/rain.tpl.class.php';
51 require_once __DIR__ . '/vendor/autoload.php';
52
53 // Shaarli library
54 require_once 'application/bookmark/LinkUtils.php';
55 require_once 'application/config/ConfigPlugin.php';
56 require_once 'application/http/HttpUtils.php';
57 require_once 'application/http/UrlUtils.php';
58 require_once 'application/updater/UpdaterUtils.php';
59 require_once 'application/FileUtils.php';
60 require_once 'application/TimeZone.php';
61 require_once 'application/Utils.php';
62
63 use Shaarli\ApplicationUtils;
64 use Shaarli\Bookmark\Bookmark;
65 use Shaarli\Bookmark\BookmarkFileService;
66 use Shaarli\Bookmark\BookmarkFilter;
67 use Shaarli\Bookmark\BookmarkServiceInterface;
68 use Shaarli\Bookmark\Exception\BookmarkNotFoundException;
69 use Shaarli\Config\ConfigManager;
70 use Shaarli\Container\ContainerBuilder;
71 use Shaarli\Feed\CachedPage;
72 use Shaarli\Feed\FeedBuilder;
73 use Shaarli\Formatter\BookmarkMarkdownFormatter;
74 use Shaarli\Formatter\FormatterFactory;
75 use Shaarli\History;
76 use Shaarli\Languages;
77 use Shaarli\Netscape\NetscapeBookmarkUtils;
78 use Shaarli\Plugin\PluginManager;
79 use Shaarli\Render\PageBuilder;
80 use Shaarli\Render\PageCacheManager;
81 use Shaarli\Render\ThemeUtils;
82 use Shaarli\Router;
83 use Shaarli\Security\LoginManager;
84 use Shaarli\Security\SessionManager;
85 use Shaarli\Thumbnailer;
86 use Shaarli\Updater\Updater;
87 use Shaarli\Updater\UpdaterUtils;
88 use Slim\App;
89
90 // Ensure the PHP version is supported
91 try {
92 ApplicationUtils::checkPHPVersion('7.1', PHP_VERSION);
93 } catch (Exception $exc) {
94 header('Content-Type: text/plain; charset=utf-8');
95 echo $exc->getMessage();
96 exit;
97 }
98
99 define('SHAARLI_VERSION', ApplicationUtils::getVersion(__DIR__ .'/'. ApplicationUtils::$VERSION_FILE));
100
101 // Force cookie path (but do not change lifetime)
102 $cookie = session_get_cookie_params();
103 $cookiedir = '';
104 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
105 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
106 }
107 // Set default cookie expiration and path.
108 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
109 // Set session parameters on server side.
110 // Use cookies to store session.
111 ini_set('session.use_cookies', 1);
112 // Force cookies for session (phpsessionID forbidden in URL).
113 ini_set('session.use_only_cookies', 1);
114 // Prevent PHP form using sessionID in URL if cookies are disabled.
115 ini_set('session.use_trans_sid', false);
116
117 session_name('shaarli');
118 // Start session if needed (Some server auto-start sessions).
119 if (session_status() == PHP_SESSION_NONE) {
120 session_start();
121 }
122
123 // Regenerate session ID if invalid or not defined in cookie.
124 if (isset($_COOKIE['shaarli']) && !SessionManager::checkId($_COOKIE['shaarli'])) {
125 session_regenerate_id(true);
126 $_COOKIE['shaarli'] = session_id();
127 }
128
129 $conf = new ConfigManager();
130
131 // In dev mode, throw exception on any warning
132 if ($conf->get('dev.debug', false)) {
133 // See all errors (for debugging only)
134 error_reporting(-1);
135
136 set_error_handler(function($errno, $errstr, $errfile, $errline, array $errcontext) {
137 throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
138 });
139 }
140
141 $sessionManager = new SessionManager($_SESSION, $conf);
142 $loginManager = new LoginManager($conf, $sessionManager);
143 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
144 $clientIpId = client_ip_id($_SERVER);
145
146 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
147 if (! defined('LC_MESSAGES')) {
148 define('LC_MESSAGES', LC_COLLATE);
149 }
150
151 // Sniff browser language and set date format accordingly.
152 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
153 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
154 }
155
156 new Languages(setlocale(LC_MESSAGES, 0), $conf);
157
158 $conf->setEmpty('general.timezone', date_default_timezone_get());
159 $conf->setEmpty('general.title', t('Shared bookmarks on '). escape(index_url($_SERVER)));
160 RainTPL::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
161 RainTPL::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
162
163 $pluginManager = new PluginManager($conf);
164 $pluginManager->load($conf->get('general.enabled_plugins'));
165
166 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
167
168 ob_start(); // Output buffering for the page cache.
169
170 // Prevent caching on client side or proxy: (yes, it's ugly)
171 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
172 header("Cache-Control: no-store, no-cache, must-revalidate");
173 header("Cache-Control: post-check=0, pre-check=0", false);
174 header("Pragma: no-cache");
175
176 if (! is_file($conf->getConfigFileExt())) {
177 // Ensure Shaarli has proper access to its resources
178 $errors = ApplicationUtils::checkResourcePermissions($conf);
179
180 if ($errors != array()) {
181 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
182
183 foreach ($errors as $error) {
184 $message .= '<li>'.$error.'</li>';
185 }
186 $message .= '</ul>';
187
188 header('Content-Type: text/html; charset=utf-8');
189 echo $message;
190 exit;
191 }
192
193 // Display the installation form if no existing config is found
194 install($conf, $sessionManager, $loginManager);
195 }
196
197 $loginManager->checkLoginState($_COOKIE, $clientIpId);
198
199 /**
200 * Adapter function to ensure compatibility with third-party templates
201 *
202 * @see https://github.com/shaarli/Shaarli/pull/1086
203 *
204 * @return bool true when the user is logged in, false otherwise
205 */
206 function isLoggedIn()
207 {
208 global $loginManager;
209 return $loginManager->isLoggedIn();
210 }
211
212
213 // ------------------------------------------------------------------------------------------
214 // Process login form: Check if login/password is correct.
215 if (isset($_POST['login'])) {
216 if (! $loginManager->canLogin($_SERVER)) {
217 die(t('I said: NO. You are banned for the moment. Go away.'));
218 }
219 if (isset($_POST['password'])
220 && $sessionManager->checkToken($_POST['token'])
221 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
222 ) {
223 $loginManager->handleSuccessfulLogin($_SERVER);
224
225 $cookiedir = '';
226 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
227 // Note: Never forget the trailing slash on the cookie path!
228 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
229 }
230
231 if (!empty($_POST['longlastingsession'])) {
232 // Keep the session cookie even after the browser closes
233 $sessionManager->setStaySignedIn(true);
234 $expirationTime = $sessionManager->extendSession();
235
236 setcookie(
237 $loginManager::$STAY_SIGNED_IN_COOKIE,
238 $loginManager->getStaySignedInToken(),
239 $expirationTime,
240 WEB_PATH
241 );
242 } else {
243 // Standard session expiration (=when browser closes)
244 $expirationTime = 0;
245 }
246
247 // Send cookie with the new expiration date to the browser
248 session_destroy();
249 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
250 session_start();
251 session_regenerate_id(true);
252
253 // Optional redirect after login:
254 if (isset($_GET['post'])) {
255 $uri = './?post='. urlencode($_GET['post']);
256 foreach (array('description', 'source', 'title', 'tags') as $param) {
257 if (!empty($_GET[$param])) {
258 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
259 }
260 }
261 header('Location: '. $uri);
262 exit;
263 }
264
265 if (isset($_GET['edit_link'])) {
266 header('Location: ./?edit_link='. escape($_GET['edit_link']));
267 exit;
268 }
269
270 if (isset($_POST['returnurl'])) {
271 // Prevent loops over login screen.
272 if (strpos($_POST['returnurl'], '/login') === false) {
273 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
274 exit;
275 }
276 }
277 header('Location: ./?');
278 exit;
279 } else {
280 $loginManager->handleFailedLogin($_SERVER);
281 $redir = '?username='. urlencode($_POST['login']);
282 if (isset($_GET['post'])) {
283 $redir .= '&post=' . urlencode($_GET['post']);
284 foreach (array('description', 'source', 'title', 'tags') as $param) {
285 if (!empty($_GET[$param])) {
286 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
287 }
288 }
289 }
290 // Redirect to login screen.
291 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'./login'.$redir.'\';</script>';
292 exit;
293 }
294 }
295
296 // ------------------------------------------------------------------------------------------
297 // Token management for XSRF protection
298 // Token should be used in any form which acts on data (create,update,delete,import...).
299 if (!isset($_SESSION['tokens'])) {
300 $_SESSION['tokens']=array(); // Token are attached to the session.
301 }
302
303 /**
304 * Renders the linklist
305 *
306 * @param pageBuilder $PAGE pageBuilder instance.
307 * @param BookmarkServiceInterface $linkDb instance.
308 * @param ConfigManager $conf Configuration Manager instance.
309 * @param PluginManager $pluginManager Plugin Manager instance.
310 */
311 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
312 {
313 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
314 $PAGE->renderPage('linklist');
315 }
316
317 /**
318 * Render HTML page (according to URL parameters and user rights)
319 *
320 * @param ConfigManager $conf Configuration Manager instance.
321 * @param PluginManager $pluginManager Plugin Manager instance,
322 * @param BookmarkServiceInterface $bookmarkService
323 * @param History $history instance
324 * @param SessionManager $sessionManager SessionManager instance
325 * @param LoginManager $loginManager LoginManager instance
326 */
327 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
328 {
329 $pageCacheManager = new PageCacheManager($conf->get('resource.page_cache'), $loginManager->isLoggedIn());
330 $updater = new Updater(
331 UpdaterUtils::read_updates_file($conf->get('resource.updates')),
332 $bookmarkService,
333 $conf,
334 $loginManager->isLoggedIn()
335 );
336 try {
337 $newUpdates = $updater->update();
338 if (! empty($newUpdates)) {
339 UpdaterUtils::write_updates_file(
340 $conf->get('resource.updates'),
341 $updater->getDoneUpdates()
342 );
343
344 $pageCacheManager->invalidateCaches();
345 }
346 } catch (Exception $e) {
347 die($e->getMessage());
348 }
349
350 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
351 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter::$ALL));
352 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter::$PRIVATE));
353 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
354
355 // Determine which page will be rendered.
356 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
357 $targetPage = Router::findPage($query, $_GET, $loginManager->isLoggedIn());
358
359 if (// if the user isn't logged in
360 !$loginManager->isLoggedIn() &&
361 // and Shaarli doesn't have public content...
362 $conf->get('privacy.hide_public_links') &&
363 // and is configured to enforce the login
364 $conf->get('privacy.force_login') &&
365 // and the current page isn't already the login page
366 $targetPage !== Router::$PAGE_LOGIN &&
367 // and the user is not requesting a feed (which would lead to a different content-type as expected)
368 $targetPage !== Router::$PAGE_FEED_ATOM &&
369 $targetPage !== Router::$PAGE_FEED_RSS
370 ) {
371 // force current page to be the login page
372 $targetPage = Router::$PAGE_LOGIN;
373 }
374
375 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
376 // Then assign generated data to RainTPL.
377 $common_hooks = array(
378 'includes',
379 'header',
380 'footer',
381 );
382
383 foreach ($common_hooks as $name) {
384 $plugin_data = array();
385 $pluginManager->executeHooks(
386 'render_' . $name,
387 $plugin_data,
388 array(
389 'target' => $targetPage,
390 'loggedin' => $loginManager->isLoggedIn()
391 )
392 );
393 $PAGE->assign('plugins_' . $name, $plugin_data);
394 }
395
396 // -------- Display login form.
397 if ($targetPage == Router::$PAGE_LOGIN) {
398 header('Location: ./login');
399 exit;
400 }
401 // -------- User wants to logout.
402 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
403 header('Location: ./logout');
404 exit;
405 }
406
407 // -------- Picture wall
408 if ($targetPage == Router::$PAGE_PICWALL) {
409 header('Location: ./picture-wall');
410 exit;
411 }
412
413 // -------- Tag cloud
414 if ($targetPage == Router::$PAGE_TAGCLOUD) {
415 header('Location: ./tags/cloud');
416 exit;
417 }
418
419 // -------- Tag list
420 if ($targetPage == Router::$PAGE_TAGLIST) {
421 header('Location: ./tags/list');
422 exit;
423 }
424
425 // Daily page.
426 if ($targetPage == Router::$PAGE_DAILY) {
427 $dayParam = !empty($_GET['day']) ? '?day=' . escape($_GET['day']) : '';
428 header('Location: ./daily'. $dayParam);
429 exit;
430 }
431
432 // ATOM and RSS feed.
433 if ($targetPage == Router::$PAGE_FEED_ATOM || $targetPage == Router::$PAGE_FEED_RSS) {
434 $feedType = $targetPage == Router::$PAGE_FEED_RSS ? FeedBuilder::$FEED_RSS : FeedBuilder::$FEED_ATOM;
435
436 header('Location: ./feed/'. $feedType .'?'. http_build_query($_GET));
437 exit;
438 }
439
440 // Display opensearch plugin (XML)
441 if ($targetPage == Router::$PAGE_OPENSEARCH) {
442 header('Location: ./open-search');
443 exit;
444 }
445
446 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
447 if (isset($_GET['addtag'])) {
448 header('Location: ./add-tag/'. $_GET['addtag']);
449 exit;
450 }
451
452 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
453 if (isset($_GET['removetag'])) {
454 header('Location: ./remove-tag/'. $_GET['removetag']);
455 exit;
456 }
457
458 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
459 if (isset($_GET['linksperpage'])) {
460 header('Location: ./links-per-page?nb='. $_GET['linksperpage']);
461 exit;
462 }
463
464 // -------- User wants to see only private bookmarks (toggle)
465 if (isset($_GET['visibility'])) {
466 header('Location: ./visibility/'. $_GET['visibility']);
467 exit;
468 }
469
470 // -------- User wants to see only untagged bookmarks (toggle)
471 if (isset($_GET['untaggedonly'])) {
472 header('Location: ./untagged-only');
473 exit;
474 }
475
476 // -------- Handle other actions allowed for non-logged in users:
477 if (!$loginManager->isLoggedIn()) {
478 // User tries to post new link but is not logged in:
479 // Show login screen, then redirect to ?post=...
480 if (isset($_GET['post'])) {
481 header( // Redirect to login page, then back to post link.
482 'Location: ./login?post='.urlencode($_GET['post']).
483 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
484 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
485 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
486 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
487 );
488 exit;
489 }
490
491 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
492 if (isset($_GET['edit_link'])) {
493 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
494 exit;
495 }
496
497 exit; // Never remove this one! All operations below are reserved for logged in user.
498 }
499
500 // -------- All other functions are reserved for the registered user:
501
502 // TODO: Remove legacy admin route redirections. We'll only keep public URL.
503
504 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
505 if ($targetPage == Router::$PAGE_TOOLS) {
506 header('Location: ./admin/tools');
507 exit;
508 }
509
510 // -------- User wants to change his/her password.
511 if ($targetPage == Router::$PAGE_CHANGEPASSWORD) {
512 header('Location: ./admin/password');
513 exit;
514 }
515
516 // -------- User wants to change configuration
517 if ($targetPage == Router::$PAGE_CONFIGURE) {
518 header('Location: ./admin/configure');
519 exit;
520 }
521
522 // -------- User wants to rename a tag or delete it
523 if ($targetPage == Router::$PAGE_CHANGETAG) {
524 header('Location: ./admin/tags');
525 exit;
526 }
527
528 // -------- User wants to add a link without using the bookmarklet: Show form.
529 if ($targetPage == Router::$PAGE_ADDLINK) {
530 header('Location: ./admin/shaare');
531 exit;
532 }
533
534 // -------- User clicked the "Save" button when editing a link: Save link to database.
535 if (isset($_POST['save_edit'])) {
536 // This route is no longer supported in legacy mode
537 header('Location: ./');
538 exit;
539 }
540
541 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
542 if ($targetPage == Router::$PAGE_DELETELINK) {
543 $ids = $_GET['lf_linkdate'] ?? '';
544 $token = $_GET['token'] ?? '';
545
546 header('Location: ./admin/shaare/delete?id=' . $ids . '&token=' . $token);
547 exit;
548 }
549
550 // -------- User clicked either "Set public" or "Set private" bulk operation
551 if ($targetPage == Router::$PAGE_CHANGE_VISIBILITY) {
552 header('Location: ./admin/shaare/visibility?id=' . $_GET['token']);
553 exit;
554 }
555
556 // -------- User clicked the "EDIT" button on a link: Display link edit form.
557 if (isset($_GET['edit_link'])) {
558 $id = (int) escape($_GET['edit_link']);
559 header('Location: ./admin/shaare/' . $id);
560 exit;
561 }
562
563 // -------- User want to post a new link: Display link edit form.
564 if (isset($_GET['post'])) {
565 header('Location: ./admin/shaare?' . http_build_query($_GET));
566 exit;
567 }
568
569 if ($targetPage == Router::$PAGE_PINLINK) {
570 // This route is no longer supported in legacy mode
571 header('Location: ./');
572 exit;
573 }
574
575 if ($targetPage == Router::$PAGE_EXPORT) {
576 header('Location: ./admin/export');
577 exit;
578 }
579
580 if ($targetPage == Router::$PAGE_IMPORT) {
581 // Upload a Netscape bookmark dump to import its contents
582
583 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
584 // Show import dialog
585 $PAGE->assign(
586 'maxfilesize',
587 get_max_upload_size(
588 ini_get('post_max_size'),
589 ini_get('upload_max_filesize'),
590 false
591 )
592 );
593 $PAGE->assign(
594 'maxfilesizeHuman',
595 get_max_upload_size(
596 ini_get('post_max_size'),
597 ini_get('upload_max_filesize'),
598 true
599 )
600 );
601 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
602 $PAGE->renderPage('import');
603 exit;
604 }
605
606 // Import bookmarks from an uploaded file
607 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
608 // The file is too big or some form field may be missing.
609 $msg = sprintf(
610 t(
611 'The file you are trying to upload is probably bigger than what this webserver can accept'
612 .' (%s). Please upload in smaller chunks.'
613 ),
614 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
615 );
616 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router::$PAGE_IMPORT .'\';</script>';
617 exit;
618 }
619 if (! $sessionManager->checkToken($_POST['token'])) {
620 die('Wrong token.');
621 }
622 $netscapeBookmarkUtils = new NetscapeBookmarkUtils($bookmarkService, $conf, $history);
623 $status = $netscapeBookmarkUtils->import($_POST, $_FILES);
624 echo '<script>alert("'.$status.'");document.location=\'./?do='
625 .Router::$PAGE_IMPORT .'\';</script>';
626 exit;
627 }
628
629 // Plugin administration page
630 if ($targetPage == Router::$PAGE_PLUGINSADMIN) {
631 $pluginMeta = $pluginManager->getPluginsMeta();
632
633 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
634 $enabledPlugins = array_filter($pluginMeta, function ($v) {
635 return $v['order'] !== false;
636 });
637 // Load parameters.
638 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
639 uasort(
640 $enabledPlugins,
641 function ($a, $b) {
642 return $a['order'] - $b['order'];
643 }
644 );
645 $disabledPlugins = array_filter($pluginMeta, function ($v) {
646 return $v['order'] === false;
647 });
648
649 $PAGE->assign('enabledPlugins', $enabledPlugins);
650 $PAGE->assign('disabledPlugins', $disabledPlugins);
651 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
652 $PAGE->renderPage('pluginsadmin');
653 exit;
654 }
655
656 // Plugin administration form action
657 if ($targetPage == Router::$PAGE_SAVE_PLUGINSADMIN) {
658 try {
659 if (isset($_POST['parameters_form'])) {
660 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
661 unset($_POST['parameters_form']);
662 foreach ($_POST as $param => $value) {
663 $conf->set('plugins.'. $param, escape($value));
664 }
665 } else {
666 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
667 }
668 $conf->write($loginManager->isLoggedIn());
669 $history->updateSettings();
670 } catch (Exception $e) {
671 error_log(
672 'ERROR while saving plugin configuration:.' . PHP_EOL .
673 $e->getMessage()
674 );
675
676 // TODO: do not handle exceptions/errors in JS.
677 echo '<script>alert("'
678 . $e->getMessage()
679 .'");document.location=\'./?do='
680 . Router::$PAGE_PLUGINSADMIN
681 .'\';</script>';
682 exit;
683 }
684 header('Location: ./?do='. Router::$PAGE_PLUGINSADMIN);
685 exit;
686 }
687
688 // Get a fresh token
689 if ($targetPage == Router::$GET_TOKEN) {
690 header('Content-Type:text/plain');
691 echo $sessionManager->generateToken();
692 exit;
693 }
694
695 // -------- Thumbnails Update
696 if ($targetPage == Router::$PAGE_THUMBS_UPDATE) {
697 $ids = [];
698 foreach ($bookmarkService->search() as $bookmark) {
699 // A note or not HTTP(S)
700 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
701 continue;
702 }
703 $ids[] = $bookmark->getId();
704 }
705 $PAGE->assign('ids', $ids);
706 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
707 $PAGE->renderPage('thumbnails');
708 exit;
709 }
710
711 // -------- Single Thumbnail Update
712 if ($targetPage == Router::$AJAX_THUMB_UPDATE) {
713 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
714 http_response_code(400);
715 exit;
716 }
717 $id = (int) $_POST['id'];
718 if (! $bookmarkService->exists($id)) {
719 http_response_code(404);
720 exit;
721 }
722 $thumbnailer = new Thumbnailer($conf);
723 $bookmark = $bookmarkService->get($id);
724 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
725 $bookmarkService->set($bookmark);
726
727 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
728 echo json_encode($factory->getFormatter('raw')->format($bookmark));
729 exit;
730 }
731
732 // -------- Otherwise, simply display search form and bookmarks:
733 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
734 exit;
735 }
736
737 /**
738 * Template for the list of bookmarks (<div id="linklist">)
739 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
740 *
741 * @param pageBuilder $PAGE pageBuilder instance.
742 * @param BookmarkServiceInterface $linkDb LinkDB instance.
743 * @param ConfigManager $conf Configuration Manager instance.
744 * @param PluginManager $pluginManager Plugin Manager instance.
745 * @param LoginManager $loginManager LoginManager instance
746 */
747 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
748 {
749 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
750 $formatter = $factory->getFormatter();
751
752 // Used in templates
753 if (isset($_GET['searchtags'])) {
754 if (! empty($_GET['searchtags'])) {
755 $searchtags = escape(normalize_spaces($_GET['searchtags']));
756 } else {
757 $searchtags = false;
758 }
759 } else {
760 $searchtags = '';
761 }
762 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
763
764 // Smallhash filter
765 if (! empty($_SERVER['QUERY_STRING'])
766 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
767 try {
768 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
769 } catch (BookmarkNotFoundException $e) {
770 $PAGE->render404($e->getMessage());
771 exit;
772 }
773 } else {
774 // Filter bookmarks according search parameters.
775 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
776 $request = [
777 'searchtags' => $searchtags,
778 'searchterm' => $searchterm,
779 ];
780 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
781 }
782
783 // ---- Handle paging.
784 $keys = array();
785 foreach ($linksToDisplay as $key => $value) {
786 $keys[] = $key;
787 }
788
789 // Select articles according to paging.
790 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
791 $pagecount = $pagecount == 0 ? 1 : $pagecount;
792 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
793 $page = $page < 1 ? 1 : $page;
794 $page = $page > $pagecount ? $pagecount : $page;
795 // Start index.
796 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
797 $end = $i + $_SESSION['LINKS_PER_PAGE'];
798
799 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE;
800 if ($thumbnailsEnabled) {
801 $thumbnailer = new Thumbnailer($conf);
802 }
803
804 $linkDisp = array();
805 while ($i<$end && $i<count($keys)) {
806 $link = $formatter->format($linksToDisplay[$keys[$i]]);
807
808 // Logged in, thumbnails enabled, not a note,
809 // and (never retrieved yet or no valid cache file)
810 if ($loginManager->isLoggedIn()
811 && $thumbnailsEnabled
812 && !$linksToDisplay[$keys[$i]]->isNote()
813 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
814 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
815 ) {
816 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
817 $linkDb->set($linksToDisplay[$keys[$i]], false);
818 $updateDB = true;
819 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
820 }
821
822 // Check for both signs of a note: starting with ? and 7 chars long.
823 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
824 // $link['url'] = index_url($_SERVER) . $link['url'];
825 // }
826
827 $linkDisp[$keys[$i]] = $link;
828 $i++;
829 }
830
831 // If we retrieved new thumbnails, we update the database.
832 if (!empty($updateDB)) {
833 $linkDb->save();
834 }
835
836 // Compute paging navigation
837 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
838 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
839 $previous_page_url = '';
840 if ($i != count($keys)) {
841 $previous_page_url = '?page=' . ($page+1) . $searchtermUrl . $searchtagsUrl;
842 }
843 $next_page_url='';
844 if ($page>1) {
845 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
846 }
847
848 // Fill all template fields.
849 $data = array(
850 'previous_page_url' => $previous_page_url,
851 'next_page_url' => $next_page_url,
852 'page_current' => $page,
853 'page_max' => $pagecount,
854 'result_count' => count($linksToDisplay),
855 'search_term' => $searchterm,
856 'search_tags' => $searchtags,
857 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
858 'links' => $linkDisp,
859 );
860
861 // If there is only a single link, we change on-the-fly the title of the page.
862 if (count($linksToDisplay) == 1) {
863 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
864 } elseif (! empty($searchterm) || ! empty($searchtags)) {
865 $data['pagetitle'] = t('Search: ');
866 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
867 $bracketWrap = function ($tag) {
868 return '['. $tag .']';
869 };
870 $data['pagetitle'] .= ! empty($searchtags)
871 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
872 : '';
873 $data['pagetitle'] .= '- '. $conf->get('general.title');
874 }
875
876 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
877
878 foreach ($data as $key => $value) {
879 $PAGE->assign($key, $value);
880 }
881
882 return;
883 }
884
885 /**
886 * Installation
887 * This function should NEVER be called if the file data/config.php exists.
888 *
889 * @param ConfigManager $conf Configuration Manager instance.
890 * @param SessionManager $sessionManager SessionManager instance
891 * @param LoginManager $loginManager LoginManager instance
892 */
893 function install($conf, $sessionManager, $loginManager)
894 {
895 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
896 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
897 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
898 }
899
900
901 // This part makes sure sessions works correctly.
902 // (Because on some hosts, session.save_path may not be set correctly,
903 // or we may not have write access to it.)
904 if (isset($_GET['test_session'])
905 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
906 // Step 2: Check if data in session is correct.
907 $msg = t(
908 '<pre>Sessions do not seem to work correctly on your server.<br>'.
909 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
910 'and that you have write access to it.<br>'.
911 'It currently points to %s.<br>'.
912 'On some browsers, accessing your server via a hostname like \'localhost\' '.
913 'or any custom hostname without a dot causes cookie storage to fail. '.
914 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
915 );
916 $msg = sprintf($msg, session_save_path());
917 echo $msg;
918 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
919 die;
920 }
921 if (!isset($_SESSION['session_tested'])) {
922 // Step 1 : Try to store data in session and reload page.
923 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
924 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
925 }
926 if (isset($_GET['test_session'])) {
927 // Step 3: Sessions are OK. Remove test parameter from URL.
928 header('Location: '.index_url($_SERVER));
929 }
930
931
932 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
933 $tz = 'UTC';
934 if (!empty($_POST['continent']) && !empty($_POST['city'])
935 && isTimeZoneValid($_POST['continent'], $_POST['city'])
936 ) {
937 $tz = $_POST['continent'].'/'.$_POST['city'];
938 }
939 $conf->set('general.timezone', $tz);
940 $login = $_POST['setlogin'];
941 $conf->set('credentials.login', $login);
942 $salt = sha1(uniqid('', true) .'_'. mt_rand());
943 $conf->set('credentials.salt', $salt);
944 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
945 if (!empty($_POST['title'])) {
946 $conf->set('general.title', escape($_POST['title']));
947 } else {
948 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
949 }
950 $conf->set('translation.language', escape($_POST['language']));
951 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
952 $conf->set('api.enabled', !empty($_POST['enableApi']));
953 $conf->set(
954 'api.secret',
955 generate_api_secret(
956 $conf->get('credentials.login'),
957 $conf->get('credentials.salt')
958 )
959 );
960 try {
961 // Everything is ok, let's create config file.
962 $conf->write($loginManager->isLoggedIn());
963 } catch (Exception $e) {
964 error_log(
965 'ERROR while writing config file after installation.' . PHP_EOL .
966 $e->getMessage()
967 );
968
969 // TODO: do not handle exceptions/errors in JS.
970 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
971 exit;
972 }
973
974 $history = new History($conf->get('resource.history'));
975 $bookmarkService = new BookmarkFileService($conf, $history, true);
976 if ($bookmarkService->count() === 0) {
977 $bookmarkService->initialize();
978 }
979
980 echo '<script>alert('
981 .'"Shaarli is now configured. '
982 .'Please enter your login/password and start shaaring your bookmarks!"'
983 .');document.location=\'./login\';</script>';
984 exit;
985 }
986
987 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
988 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
989 $PAGE->assign('continents', $continents);
990 $PAGE->assign('cities', $cities);
991 $PAGE->assign('languages', Languages::getAvailableLanguages());
992 $PAGE->renderPage('install');
993 exit;
994 }
995
996 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
997 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
998 }
999
1000 try {
1001 $history = new History($conf->get('resource.history'));
1002 } catch (Exception $e) {
1003 die($e->getMessage());
1004 }
1005
1006 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1007
1008 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1009 header('Location: ./daily-rss');
1010 exit;
1011 }
1012
1013 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
1014 $container = $containerBuilder->build();
1015 $app = new App($container);
1016
1017 // REST API routes
1018 $app->group('/api/v1', function () {
1019 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1020 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1021 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1022 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1023 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1024 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1025
1026 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1027 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1028 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1029 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1030
1031 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1032 })->add('\Shaarli\Api\ApiMiddleware');
1033
1034 $app->group('', function () {
1035 /* -- PUBLIC --*/
1036 $this->get('/login', '\Shaarli\Front\Controller\Visitor\LoginController:index');
1037 $this->get('/picture-wall', '\Shaarli\Front\Controller\Visitor\PictureWallController:index');
1038 $this->get('/tags/cloud', '\Shaarli\Front\Controller\Visitor\TagCloudController:cloud');
1039 $this->get('/tags/list', '\Shaarli\Front\Controller\Visitor\TagCloudController:list');
1040 $this->get('/daily', '\Shaarli\Front\Controller\Visitor\DailyController:index');
1041 $this->get('/daily-rss', '\Shaarli\Front\Controller\Visitor\DailyController:rss');
1042 $this->get('/feed/atom', '\Shaarli\Front\Controller\Visitor\FeedController:atom');
1043 $this->get('/feed/rss', '\Shaarli\Front\Controller\Visitor\FeedController:rss');
1044 $this->get('/open-search', '\Shaarli\Front\Controller\Visitor\OpenSearchController:index');
1045
1046 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\Visitor\TagController:addTag');
1047 $this->get('/remove-tag/{tag}', '\Shaarli\Front\Controller\Visitor\TagController:removeTag');
1048
1049 /* -- LOGGED IN -- */
1050 $this->get('/logout', '\Shaarli\Front\Controller\Admin\LogoutController:index');
1051 $this->get('/admin/tools', '\Shaarli\Front\Controller\Admin\ToolsController:index');
1052 $this->get('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:index');
1053 $this->post('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:change');
1054 $this->get('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:index');
1055 $this->post('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:save');
1056 $this->get('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:index');
1057 $this->post('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:save');
1058 $this->get('/admin/add-shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:addShaare');
1059 $this->get('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayCreateForm');
1060 $this->get('/admin/shaare/{id:[0-9]+}', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayEditForm');
1061 $this->post('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:save');
1062 $this->get('/admin/shaare/delete', '\Shaarli\Front\Controller\Admin\ManageShaareController:deleteBookmark');
1063 $this->get('/admin/shaare/visibility', '\Shaarli\Front\Controller\Admin\ManageShaareController:changeVisibility');
1064 $this->get('/admin/shaare/{id:[0-9]+}/pin', '\Shaarli\Front\Controller\Admin\ManageShaareController:pinBookmark');
1065 $this->get('/admin/export', '\Shaarli\Front\Controller\Admin\ExportController:index');
1066 $this->post('/admin/export', '\Shaarli\Front\Controller\Admin\ExportController:export');
1067
1068 $this->get('/links-per-page', '\Shaarli\Front\Controller\Admin\SessionFilterController:linksPerPage');
1069 $this->get('/visibility/{visibility}', '\Shaarli\Front\Controller\Admin\SessionFilterController:visibility');
1070 $this->get('/untagged-only', '\Shaarli\Front\Controller\Admin\SessionFilterController:untaggedOnly');
1071 })->add('\Shaarli\Front\ShaarliMiddleware');
1072
1073 $response = $app->run(true);
1074
1075 // Hack to make Slim and Shaarli router work together:
1076 // If a Slim route isn't found and NOT API call, we call renderPage().
1077 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1078 // We use UTF-8 for proper international characters handling.
1079 header('Content-Type: text/html; charset=utf-8');
1080 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1081 } else {
1082 $response = $response
1083 ->withHeader('Access-Control-Allow-Origin', '*')
1084 ->withHeader(
1085 'Access-Control-Allow-Headers',
1086 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1087 )
1088 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1089 $app->respond($response);
1090 }