]> git.immae.eu Git - github/shaarli/Shaarli.git/blob - index.php
Pin bookmarks through Slim controller
[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 // Export bookmarks as a Netscape Bookmarks file
577
578 if (empty($_GET['selection'])) {
579 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
580 $PAGE->renderPage('export');
581 exit;
582 }
583
584 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
585 $selection = $_GET['selection'];
586 if (isset($_GET['prepend_note_url'])) {
587 $prependNoteUrl = $_GET['prepend_note_url'];
588 } else {
589 $prependNoteUrl = false;
590 }
591
592 try {
593 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
594 $formatter = $factory->getFormatter('raw');
595 $PAGE->assign(
596 'links',
597 NetscapeBookmarkUtils::filterAndFormat(
598 $bookmarkService,
599 $formatter,
600 $selection,
601 $prependNoteUrl,
602 index_url($_SERVER)
603 )
604 );
605 } catch (Exception $exc) {
606 header('Content-Type: text/plain; charset=utf-8');
607 echo $exc->getMessage();
608 exit;
609 }
610 $now = new DateTime();
611 header('Content-Type: text/html; charset=utf-8');
612 header(
613 'Content-disposition: attachment; filename=bookmarks_'
614 .$selection.'_'.$now->format(Bookmark::LINK_DATE_FORMAT).'.html'
615 );
616 $PAGE->assign('date', $now->format(DateTime::RFC822));
617 $PAGE->assign('eol', PHP_EOL);
618 $PAGE->assign('selection', $selection);
619 $PAGE->renderPage('export.bookmarks');
620 exit;
621 }
622
623 if ($targetPage == Router::$PAGE_IMPORT) {
624 // Upload a Netscape bookmark dump to import its contents
625
626 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
627 // Show import dialog
628 $PAGE->assign(
629 'maxfilesize',
630 get_max_upload_size(
631 ini_get('post_max_size'),
632 ini_get('upload_max_filesize'),
633 false
634 )
635 );
636 $PAGE->assign(
637 'maxfilesizeHuman',
638 get_max_upload_size(
639 ini_get('post_max_size'),
640 ini_get('upload_max_filesize'),
641 true
642 )
643 );
644 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
645 $PAGE->renderPage('import');
646 exit;
647 }
648
649 // Import bookmarks from an uploaded file
650 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
651 // The file is too big or some form field may be missing.
652 $msg = sprintf(
653 t(
654 'The file you are trying to upload is probably bigger than what this webserver can accept'
655 .' (%s). Please upload in smaller chunks.'
656 ),
657 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
658 );
659 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router::$PAGE_IMPORT .'\';</script>';
660 exit;
661 }
662 if (! $sessionManager->checkToken($_POST['token'])) {
663 die('Wrong token.');
664 }
665 $status = NetscapeBookmarkUtils::import(
666 $_POST,
667 $_FILES,
668 $bookmarkService,
669 $conf,
670 $history
671 );
672 echo '<script>alert("'.$status.'");document.location=\'./?do='
673 .Router::$PAGE_IMPORT .'\';</script>';
674 exit;
675 }
676
677 // Plugin administration page
678 if ($targetPage == Router::$PAGE_PLUGINSADMIN) {
679 $pluginMeta = $pluginManager->getPluginsMeta();
680
681 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
682 $enabledPlugins = array_filter($pluginMeta, function ($v) {
683 return $v['order'] !== false;
684 });
685 // Load parameters.
686 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
687 uasort(
688 $enabledPlugins,
689 function ($a, $b) {
690 return $a['order'] - $b['order'];
691 }
692 );
693 $disabledPlugins = array_filter($pluginMeta, function ($v) {
694 return $v['order'] === false;
695 });
696
697 $PAGE->assign('enabledPlugins', $enabledPlugins);
698 $PAGE->assign('disabledPlugins', $disabledPlugins);
699 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
700 $PAGE->renderPage('pluginsadmin');
701 exit;
702 }
703
704 // Plugin administration form action
705 if ($targetPage == Router::$PAGE_SAVE_PLUGINSADMIN) {
706 try {
707 if (isset($_POST['parameters_form'])) {
708 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
709 unset($_POST['parameters_form']);
710 foreach ($_POST as $param => $value) {
711 $conf->set('plugins.'. $param, escape($value));
712 }
713 } else {
714 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
715 }
716 $conf->write($loginManager->isLoggedIn());
717 $history->updateSettings();
718 } catch (Exception $e) {
719 error_log(
720 'ERROR while saving plugin configuration:.' . PHP_EOL .
721 $e->getMessage()
722 );
723
724 // TODO: do not handle exceptions/errors in JS.
725 echo '<script>alert("'
726 . $e->getMessage()
727 .'");document.location=\'./?do='
728 . Router::$PAGE_PLUGINSADMIN
729 .'\';</script>';
730 exit;
731 }
732 header('Location: ./?do='. Router::$PAGE_PLUGINSADMIN);
733 exit;
734 }
735
736 // Get a fresh token
737 if ($targetPage == Router::$GET_TOKEN) {
738 header('Content-Type:text/plain');
739 echo $sessionManager->generateToken();
740 exit;
741 }
742
743 // -------- Thumbnails Update
744 if ($targetPage == Router::$PAGE_THUMBS_UPDATE) {
745 $ids = [];
746 foreach ($bookmarkService->search() as $bookmark) {
747 // A note or not HTTP(S)
748 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
749 continue;
750 }
751 $ids[] = $bookmark->getId();
752 }
753 $PAGE->assign('ids', $ids);
754 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
755 $PAGE->renderPage('thumbnails');
756 exit;
757 }
758
759 // -------- Single Thumbnail Update
760 if ($targetPage == Router::$AJAX_THUMB_UPDATE) {
761 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
762 http_response_code(400);
763 exit;
764 }
765 $id = (int) $_POST['id'];
766 if (! $bookmarkService->exists($id)) {
767 http_response_code(404);
768 exit;
769 }
770 $thumbnailer = new Thumbnailer($conf);
771 $bookmark = $bookmarkService->get($id);
772 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
773 $bookmarkService->set($bookmark);
774
775 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
776 echo json_encode($factory->getFormatter('raw')->format($bookmark));
777 exit;
778 }
779
780 // -------- Otherwise, simply display search form and bookmarks:
781 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
782 exit;
783 }
784
785 /**
786 * Template for the list of bookmarks (<div id="linklist">)
787 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
788 *
789 * @param pageBuilder $PAGE pageBuilder instance.
790 * @param BookmarkServiceInterface $linkDb LinkDB instance.
791 * @param ConfigManager $conf Configuration Manager instance.
792 * @param PluginManager $pluginManager Plugin Manager instance.
793 * @param LoginManager $loginManager LoginManager instance
794 */
795 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
796 {
797 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
798 $formatter = $factory->getFormatter();
799
800 // Used in templates
801 if (isset($_GET['searchtags'])) {
802 if (! empty($_GET['searchtags'])) {
803 $searchtags = escape(normalize_spaces($_GET['searchtags']));
804 } else {
805 $searchtags = false;
806 }
807 } else {
808 $searchtags = '';
809 }
810 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
811
812 // Smallhash filter
813 if (! empty($_SERVER['QUERY_STRING'])
814 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
815 try {
816 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
817 } catch (BookmarkNotFoundException $e) {
818 $PAGE->render404($e->getMessage());
819 exit;
820 }
821 } else {
822 // Filter bookmarks according search parameters.
823 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
824 $request = [
825 'searchtags' => $searchtags,
826 'searchterm' => $searchterm,
827 ];
828 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
829 }
830
831 // ---- Handle paging.
832 $keys = array();
833 foreach ($linksToDisplay as $key => $value) {
834 $keys[] = $key;
835 }
836
837 // Select articles according to paging.
838 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
839 $pagecount = $pagecount == 0 ? 1 : $pagecount;
840 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
841 $page = $page < 1 ? 1 : $page;
842 $page = $page > $pagecount ? $pagecount : $page;
843 // Start index.
844 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
845 $end = $i + $_SESSION['LINKS_PER_PAGE'];
846
847 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE;
848 if ($thumbnailsEnabled) {
849 $thumbnailer = new Thumbnailer($conf);
850 }
851
852 $linkDisp = array();
853 while ($i<$end && $i<count($keys)) {
854 $link = $formatter->format($linksToDisplay[$keys[$i]]);
855
856 // Logged in, thumbnails enabled, not a note,
857 // and (never retrieved yet or no valid cache file)
858 if ($loginManager->isLoggedIn()
859 && $thumbnailsEnabled
860 && !$linksToDisplay[$keys[$i]]->isNote()
861 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
862 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
863 ) {
864 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
865 $linkDb->set($linksToDisplay[$keys[$i]], false);
866 $updateDB = true;
867 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
868 }
869
870 // Check for both signs of a note: starting with ? and 7 chars long.
871 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
872 // $link['url'] = index_url($_SERVER) . $link['url'];
873 // }
874
875 $linkDisp[$keys[$i]] = $link;
876 $i++;
877 }
878
879 // If we retrieved new thumbnails, we update the database.
880 if (!empty($updateDB)) {
881 $linkDb->save();
882 }
883
884 // Compute paging navigation
885 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
886 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
887 $previous_page_url = '';
888 if ($i != count($keys)) {
889 $previous_page_url = '?page=' . ($page+1) . $searchtermUrl . $searchtagsUrl;
890 }
891 $next_page_url='';
892 if ($page>1) {
893 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
894 }
895
896 // Fill all template fields.
897 $data = array(
898 'previous_page_url' => $previous_page_url,
899 'next_page_url' => $next_page_url,
900 'page_current' => $page,
901 'page_max' => $pagecount,
902 'result_count' => count($linksToDisplay),
903 'search_term' => $searchterm,
904 'search_tags' => $searchtags,
905 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
906 'links' => $linkDisp,
907 );
908
909 // If there is only a single link, we change on-the-fly the title of the page.
910 if (count($linksToDisplay) == 1) {
911 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
912 } elseif (! empty($searchterm) || ! empty($searchtags)) {
913 $data['pagetitle'] = t('Search: ');
914 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
915 $bracketWrap = function ($tag) {
916 return '['. $tag .']';
917 };
918 $data['pagetitle'] .= ! empty($searchtags)
919 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
920 : '';
921 $data['pagetitle'] .= '- '. $conf->get('general.title');
922 }
923
924 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
925
926 foreach ($data as $key => $value) {
927 $PAGE->assign($key, $value);
928 }
929
930 return;
931 }
932
933 /**
934 * Installation
935 * This function should NEVER be called if the file data/config.php exists.
936 *
937 * @param ConfigManager $conf Configuration Manager instance.
938 * @param SessionManager $sessionManager SessionManager instance
939 * @param LoginManager $loginManager LoginManager instance
940 */
941 function install($conf, $sessionManager, $loginManager)
942 {
943 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
944 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
945 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
946 }
947
948
949 // This part makes sure sessions works correctly.
950 // (Because on some hosts, session.save_path may not be set correctly,
951 // or we may not have write access to it.)
952 if (isset($_GET['test_session'])
953 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
954 // Step 2: Check if data in session is correct.
955 $msg = t(
956 '<pre>Sessions do not seem to work correctly on your server.<br>'.
957 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
958 'and that you have write access to it.<br>'.
959 'It currently points to %s.<br>'.
960 'On some browsers, accessing your server via a hostname like \'localhost\' '.
961 'or any custom hostname without a dot causes cookie storage to fail. '.
962 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
963 );
964 $msg = sprintf($msg, session_save_path());
965 echo $msg;
966 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
967 die;
968 }
969 if (!isset($_SESSION['session_tested'])) {
970 // Step 1 : Try to store data in session and reload page.
971 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
972 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
973 }
974 if (isset($_GET['test_session'])) {
975 // Step 3: Sessions are OK. Remove test parameter from URL.
976 header('Location: '.index_url($_SERVER));
977 }
978
979
980 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
981 $tz = 'UTC';
982 if (!empty($_POST['continent']) && !empty($_POST['city'])
983 && isTimeZoneValid($_POST['continent'], $_POST['city'])
984 ) {
985 $tz = $_POST['continent'].'/'.$_POST['city'];
986 }
987 $conf->set('general.timezone', $tz);
988 $login = $_POST['setlogin'];
989 $conf->set('credentials.login', $login);
990 $salt = sha1(uniqid('', true) .'_'. mt_rand());
991 $conf->set('credentials.salt', $salt);
992 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
993 if (!empty($_POST['title'])) {
994 $conf->set('general.title', escape($_POST['title']));
995 } else {
996 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
997 }
998 $conf->set('translation.language', escape($_POST['language']));
999 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1000 $conf->set('api.enabled', !empty($_POST['enableApi']));
1001 $conf->set(
1002 'api.secret',
1003 generate_api_secret(
1004 $conf->get('credentials.login'),
1005 $conf->get('credentials.salt')
1006 )
1007 );
1008 try {
1009 // Everything is ok, let's create config file.
1010 $conf->write($loginManager->isLoggedIn());
1011 } catch (Exception $e) {
1012 error_log(
1013 'ERROR while writing config file after installation.' . PHP_EOL .
1014 $e->getMessage()
1015 );
1016
1017 // TODO: do not handle exceptions/errors in JS.
1018 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1019 exit;
1020 }
1021
1022 $history = new History($conf->get('resource.history'));
1023 $bookmarkService = new BookmarkFileService($conf, $history, true);
1024 if ($bookmarkService->count() === 0) {
1025 $bookmarkService->initialize();
1026 }
1027
1028 echo '<script>alert('
1029 .'"Shaarli is now configured. '
1030 .'Please enter your login/password and start shaaring your bookmarks!"'
1031 .');document.location=\'./login\';</script>';
1032 exit;
1033 }
1034
1035 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1036 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1037 $PAGE->assign('continents', $continents);
1038 $PAGE->assign('cities', $cities);
1039 $PAGE->assign('languages', Languages::getAvailableLanguages());
1040 $PAGE->renderPage('install');
1041 exit;
1042 }
1043
1044 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1045 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1046 }
1047
1048 try {
1049 $history = new History($conf->get('resource.history'));
1050 } catch (Exception $e) {
1051 die($e->getMessage());
1052 }
1053
1054 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1055
1056 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1057 header('Location: ./daily-rss');
1058 exit;
1059 }
1060
1061 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
1062 $container = $containerBuilder->build();
1063 $app = new App($container);
1064
1065 // REST API routes
1066 $app->group('/api/v1', function () {
1067 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1068 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1069 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1070 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1071 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1072 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1073
1074 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1075 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1076 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1077 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1078
1079 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1080 })->add('\Shaarli\Api\ApiMiddleware');
1081
1082 $app->group('', function () {
1083 /* -- PUBLIC --*/
1084 $this->get('/login', '\Shaarli\Front\Controller\Visitor\LoginController:index');
1085 $this->get('/picture-wall', '\Shaarli\Front\Controller\Visitor\PictureWallController:index');
1086 $this->get('/tags/cloud', '\Shaarli\Front\Controller\Visitor\TagCloudController:cloud');
1087 $this->get('/tags/list', '\Shaarli\Front\Controller\Visitor\TagCloudController:list');
1088 $this->get('/daily', '\Shaarli\Front\Controller\Visitor\DailyController:index');
1089 $this->get('/daily-rss', '\Shaarli\Front\Controller\Visitor\DailyController:rss');
1090 $this->get('/feed/atom', '\Shaarli\Front\Controller\Visitor\FeedController:atom');
1091 $this->get('/feed/rss', '\Shaarli\Front\Controller\Visitor\FeedController:rss');
1092 $this->get('/open-search', '\Shaarli\Front\Controller\Visitor\OpenSearchController:index');
1093
1094 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\Visitor\TagController:addTag');
1095 $this->get('/remove-tag/{tag}', '\Shaarli\Front\Controller\Visitor\TagController:removeTag');
1096
1097 /* -- LOGGED IN -- */
1098 $this->get('/logout', '\Shaarli\Front\Controller\Admin\LogoutController:index');
1099 $this->get('/admin/tools', '\Shaarli\Front\Controller\Admin\ToolsController:index');
1100 $this->get('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:index');
1101 $this->post('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:change');
1102 $this->get('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:index');
1103 $this->post('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:save');
1104 $this->get('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:index');
1105 $this->post('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:save');
1106 $this->get('/admin/add-shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:addShaare');
1107 $this->get('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayCreateForm');
1108 $this->get('/admin/shaare/{id:[0-9]+}', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayEditForm');
1109 $this->post('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:save');
1110 $this->get('/admin/shaare/delete', '\Shaarli\Front\Controller\Admin\ManageShaareController:deleteBookmark');
1111 $this->get('/admin/shaare/visibility', '\Shaarli\Front\Controller\Admin\ManageShaareController:changeVisibility');
1112 $this->get('/admin/shaare/{id:[0-9]+}/pin', '\Shaarli\Front\Controller\Admin\ManageShaareController:pinBookmark');
1113
1114 $this->get('/links-per-page', '\Shaarli\Front\Controller\Admin\SessionFilterController:linksPerPage');
1115 $this->get('/visibility/{visibility}', '\Shaarli\Front\Controller\Admin\SessionFilterController:visibility');
1116 $this->get('/untagged-only', '\Shaarli\Front\Controller\Admin\SessionFilterController:untaggedOnly');
1117 })->add('\Shaarli\Front\ShaarliMiddleware');
1118
1119 $response = $app->run(true);
1120
1121 // Hack to make Slim and Shaarli router work together:
1122 // If a Slim route isn't found and NOT API call, we call renderPage().
1123 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1124 // We use UTF-8 for proper international characters handling.
1125 header('Content-Type: text/html; charset=utf-8');
1126 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1127 } else {
1128 $response = $response
1129 ->withHeader('Access-Control-Allow-Origin', '*')
1130 ->withHeader(
1131 'Access-Control-Allow-Headers',
1132 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1133 )
1134 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1135 $app->respond($response);
1136 }