diff --git a/.gitattributes b/.gitattributes index 82f37602..dd0e573c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -33,5 +33,6 @@ doc/**/*.md export-ignore docker/ export-ignore Doxyfile export-ignore Makefile export-ignore +mkdocs.yml export-ignore phpunit.xml export-ignore tests/ export-ignore diff --git a/.gitignore b/.gitignore index 984d9d1f..d546f248 100644 --- a/.gitignore +++ b/.gitignore @@ -28,6 +28,9 @@ phpmd.html # User plugin configuration plugins/*/config.php +# HTML documentation +doc/html/ + # 3rd party themes tpl/* !tpl/default diff --git a/.travis.yml b/.travis.yml index 59b86c08..26535ad3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ sudo: false +dist: precise language: php addons: apt: diff --git a/AUTHORS b/AUTHORS index c0e35949..9c0ca3d1 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,6 @@ - 472 ArthurHoaro - 201 VirtualTam - 132 nodiscc + 506 ArthurHoaro + 204 VirtualTam + 147 nodiscc 56 Sébastien Sauvage 15 Florian Eula 13 Emilien Klein @@ -8,15 +8,18 @@ 8 Christophe HENRY 4 Alexandre Alapetite 4 David Sferruzza + 3 Lucas Cimon 3 Teromene + 3 kalvn 2 Chris Kuethe 2 Knah Tsaeb 2 Mathieu Chabanon 2 Miloš Jovanović 2 Qwerty + 2 Stephen Muth 2 Timo Van Neerden 2 julienCXX - 2 kalvn + 2 philipp-r 1 Adrien Oliva 1 Alexis J 1 BoboTiG @@ -38,4 +41,3 @@ 1 Sbgodin 1 TsT 1 dimtion - 1 philipp-r diff --git a/CHANGELOG.md b/CHANGELOG.md index 6109fa1c..2f557f6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,57 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [v0.9.1](https://github.com/shaarli/Shaarli/releases/tag/v0.9.1) - 2017-08-23 + +The documentation has been migrated to ReadTheDocs: +- https://shaarli.readthedocs.io/ +- edits are submitted as pull requests + +### Added +- Allow bulk link deletion +- Display subtags in the tag cloud +- Add an endpoint to refresh the token +- Add a token on every page +- Add a tag list view for management +- Add Note bookmarklet +- Add creation date when editing a link + +### Changed +- Documentation: + - Generate static HTML documentation with [mkdocs](http://www.mkdocs.org/) + - Host documentation on [ReadTheDocs](http://www.mkdocs.org/) + - Update documentation structure + - Update Makefile targets to: + - Build the docs locally + - Include the generated docs in the release archives +- Theme: + - Use the new theme as the default + - Rename the tag cloud template to `tag.cloud.html` + - Display visited links in grey + - Use only one search form in `linklist.html` + - Hide the "search links with these tags" option when an empty `searchtags` is passed to `tag.list.html` +- Improve HTTP header handling when hosting Shaarli with Docker behind a reverse proxy +- Searching for tags with an empty value returns untagged links only +- Set Travis environment to `precise` until the new `trusty` environment is ready + +### Removed +- Remove dead Pubsubhubbub code +- Disable the GitHub wiki (see changed/documentation) +- Remove Docker `dev` image and resources +- Theme: + - Remove the bottom "Sort by" menu in `tag.list.html` + +### Fixed +- Fix file existence check for `user.css` +- Limit selection to 2k characters when using the bookmarklet +- Fix JS error `uncaught type error` +- Fix Firefox Social button +- Use pinned PHP dependencies when generating release archives +- Make sure that the tag exists before altering/removing it + +### Security +- Add a whitelist for protocols for URLs + ## [v0.9.0](https://github.com/shaarli/Shaarli/releases/tag/v0.9.0) - 2017-05-07 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1be656a..bb82951d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,14 +17,10 @@ Check the [milestones](https://github.com/shaarli/Shaarli/milestones) to see wha * You can also join instant discussion at https://gitter.im/shaarli/Shaarli, or via IRC as described [here](https://github.com/shaarli/Shaarli/issues/44#issuecomment-77745105) ### Documentation -**the [wiki](https://github.com/shaarli/Shaarli/wiki) is world-writable** - anyone can edit or add chapters and pages. - * Large changes should preferably be discussed in [General discussion](https://github.com/shaarli/Shaarli/issues/44) beforehand (you can post a draft there and edit it). - * If you create a new page, please link it from the new page (eg from the [Other links](https://github.com/shaarli/Shaarli/wiki#other-links) section. - * The wiki is a general documentation about Shaarli: usage, development, hacks, usage tricks, related links, projects. Try to keep it organized. - * The wiki will be synced to Shaarli's `doc/` directory on each release. Keep that in mind when reviewing the quality of your edits. +The [official documentation](http://shaarli.readthedocs.io/en/rtfd/) is generated from [Markdown](https://daringfireball.net/projects/markdown/syntax) documents in the `doc/md/` directory. HTML documentation is generated using [Mkdocs](http://www.mkdocs.org/). [Read the Docs](https://readthedocs.org/) provides hosting for the online documentation. -You can make the project known by publishing blog posts/articles/videos about it and adding them to the links section in the wiki. +To edit the documentation, please edit the appropriate `doc/md/*.md` files (and optionally `make htmlpages` to preview changes to HTML files). Then submit your changes as a Pull Request. Have a look at the MkDocs documentation and configuration file `mkdocs.yml` if you need to add/remove/rename/reorder pages. ### Translations Currently Shaarli has no translation/internationalization/localization system available and is single-language. You can help by proposing an i18n system (issue https://github.com/shaarli/Shaarli/issues/121) diff --git a/Makefile b/Makefile index 1d8a73a2..6483fca7 100644 --- a/Makefile +++ b/Makefile @@ -155,19 +155,22 @@ release_archive: release_tar release_zip ### download 3rd-party PHP libraries composer_dependencies: clean - composer update --no-dev + composer install --no-dev --prefer-dist find vendor/ -name ".git" -type d -exec rm -rf {} + ### generate a release tarball and include 3rd-party dependencies -release_tar: composer_dependencies +release_tar: composer_dependencies doc_html git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/ + tar rvf $(ARCHIVE_VERSION).tar --transform "s|^doc/html|$(ARCHIVE_PREFIX)doc/html|" doc/html/ gzip $(ARCHIVE_VERSION).tar ### generate a release zip and include 3rd-party dependencies -release_zip: composer_dependencies +release_zip: composer_dependencies doc_html git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD - mkdir $(ARCHIVE_PREFIX) + mkdir -p $(ARCHIVE_PREFIX)/{doc,vendor} + rsync -a doc/html/ $(ARCHIVE_PREFIX)doc/html/ + zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)doc/ rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/ zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/ rm -rf $(ARCHIVE_PREFIX) @@ -192,44 +195,17 @@ doxygen: clean @rm -rf doxygen @( cat Doxyfile ; echo "PROJECT_NUMBER=`git describe`" ) | doxygen - -### update the local copy of the documentation -doc: clean - @rm -rf doc - @git clone https://github.com/shaarli/Shaarli.wiki.git doc - @rm -rf doc/.git - -### Generate a custom sidebar -# -# Sidebar content: -# - convert GitHub-flavoured relative links to standard Markdown -# - trim HTML, only keep the list (
    [...]
) part -htmlsidebar: - @echo '
' > doc/sidebar.html - @awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ - 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ - '!m { print $$0 }' doc/_Sidebar.md > doc/tmp.md - @pandoc -f markdown -t html5 -s doc/tmp.md | awk '/(ul>|li>)/' >> doc/sidebar.html - @echo '
' >> doc/sidebar.html - @rm doc/tmp.md - ### Convert local markdown documentation to HTML # # For all pages: -# - infer title from the file name # - convert GitHub-flavoured relative links to standard Markdown -# - insert the sidebar menu +# - generate html documentation with mkdocs htmlpages: - @for file in `find doc/ -maxdepth 1 -name "*.md"`; do \ - base=`basename $$file .md`; \ - sed -i "1i #$${base//-/ }" $$file; \ - awk 'BEGIN { FS = "[\\[\\]]{2}" }'\ - 'm = /\[/ { t=$$2; gsub(/ /, "-", $$2); print $$1"["t"]("$$2".html)"$$3 }'\ - '!m { print $$0 }' $$file > doc/tmp.md; \ - mv doc/tmp.md $$file; \ - pandoc -f markdown_github -t html5 -s \ - -c "github-markdown.css" \ - -T Shaarli -M pagetitle:"$${base//-/ }" -B doc/sidebar.html \ - -o doc/$$base.html $$file; \ - done; + python3 -m venv venv/ + bash -c 'source venv/bin/activate; \ + pip install mkdocs; \ + mkdocs build' + find doc/html/ -type f -exec chmod a-x '{}' \; + rm -r venv -htmldoc: authors doc htmlsidebar htmlpages +doc_html: authors htmlpages diff --git a/README.md b/README.md index d57f5202..5ca25720 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -![Shaarli logo](doc/images/doc-logo.png) +![Shaarli logo](doc/md/images/doc-logo.png) The personal, minimalist, super-fast, database free, bookmarking service. _Do you want to share the links you discover?_ -_Shaarli is a minimalist delicious clone that you can install on your own server._ +_Shaarli is a minimalist link sharing service that you can install on your own server._ _It is designed to be personal (single-user), fast and handy._ -[![](https://img.shields.io/badge/stable-v0.7.1-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.7.1) +[![](https://img.shields.io/badge/stable-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4) [![](https://img.shields.io/travis/shaarli/Shaarli/stable.svg?label=stable)](https://travis-ci.org/shaarli/Shaarli) • -[![](https://img.shields.io/badge/latest-v0.8.4-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4) +[![](https://img.shields.io/badge/latest-v0.9.0-blue.svg)](https://github.com/shaarli/Shaarli/releases/tag/v0.9.0) [![](https://img.shields.io/travis/shaarli/Shaarli/latest.svg?label=latest)](https://travis-ci.org/shaarli/Shaarli) • [![](https://img.shields.io/badge/master-v0.9.x-blue.svg)](https://github.com/shaarli/Shaarli) @@ -20,107 +20,18 @@ _It is designed to be personal (single-user), fast and handy._ [![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) ## Quickstart -- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki) + +- [Documentation](https://shaarli.readthedocs.io) - [Change log](CHANGELOG.md) - [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) ### Demo + You can use this [public demo instance of Shaarli](https://demo.shaarli.org). It runs the latest development version of Shaarli and is updated/reset daily. Login: `demo`; Password: `demo` -### Installation & upgrade -- [Download and installation](https://github.com/shaarli/Shaarli/wiki/Download-and-Installation) -- [Upgrade and migration](https://github.com/shaarli/Shaarli/wiki/Upgrade-and-migration) -- [Server requirements](https://github.com/shaarli/Shaarli/wiki/Server-requirements) -- [Server configuration](https://github.com/shaarli/Shaarli/wiki/Server-configuration) -- [Shaarli configuration](https://github.com/shaarli/Shaarli/wiki/Shaarli-configuration) - -## Features -### Interface -- minimalist design (simple is beautiful) -- FAST -- ATOM and RSS feeds -- views: - - paginated link list - - tag cloud - - picture wall: image and video thumbnails - - daily: newspaper-like daily digest - - daily RSS feed -- permalinks for easy reference -- links can be public or private -- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) - -### Tag, view and search your links! -- add a custom title and description to archived links -- add tags to classify and search links - - features tag autocompletion, renaming, merging and deletion -- full-text and tag search - -### Easy setup -- dead-simple installation: drop the files, open the page -- links are stored in a file - - compact storage - - no database required - - easy backup: simply copy the datastore file -- import and export links as Netscape bookmarks - -### Accessibility -- Firefox bookmarlet to share links in one click -- support for mobile browsers -- works with Javascript disabled -- easy page customization through HTML/CSS/RainTPL - -### Security -- bruteforce-proof login form -- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) -and session cookie hijacking - -### Goodies -- thumbnail generation for images and video services: -dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... - - lazy-loading with [bLazy](http://dinbror.dk/blazy/) -- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support -- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` -- discreet pop-up notification when a new release is available - -### REST API - -Easily extensible by any client using the REST API exposed by Shaarli. - -See the [API documentation](http://shaarli.github.io/api-documentation/). - -### Other usages -Though Shaarli is primarily a bookmarking application, it can serve other purposes -(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)): -- micro-blogging -- pastebin -- online notepad -- snippet archive - -## About -### Shaarli community fork -This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli - -This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). - -The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) -that he would have no time to work on Shaarli in the near future. -The Shaarli community has carried on the work to provide -[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) -for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) -in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. - -### Contributing -If you'd like to help, please: -- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) -and [pull requests](https://github.com/shaarli/Shaarli/pulls) -- feel free to report bugs (feedback is much appreciated) -- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) -- propose solutions to existing problems -- submit pull requests :-) - - ### License + Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component. diff --git a/application/FeedBuilder.php b/application/FeedBuilder.php index a1f4da48..7377bcec 100644 --- a/application/FeedBuilder.php +++ b/application/FeedBuilder.php @@ -97,6 +97,11 @@ public function __construct($linkDB, $feedType, $serverInfo, $userInput, $isLogg */ public function buildData() { + // Search for untagged links + if (isset($this->userInput['searchtags']) && empty($this->userInput['searchtags'])) { + $this->userInput['searchtags'] = false; + } + // Optionally filter the results: $linksToDisplay = $this->linkDB->filterSearch($this->userInput); diff --git a/application/HttpUtils.php b/application/HttpUtils.php index a81f9056..88a1efdb 100644 --- a/application/HttpUtils.php +++ b/application/HttpUtils.php @@ -311,7 +311,19 @@ function server_url($server) } } - return $scheme.'://'.$server['SERVER_NAME'].$port; + if (isset($server['HTTP_X_FORWARDED_HOST'])) { + // Keep forwarded host + if (strpos($server['HTTP_X_FORWARDED_HOST'], ',') !== false) { + $hosts = explode(',', $server['HTTP_X_FORWARDED_HOST']); + $host = trim($hosts[0]); + } else { + $host = $server['HTTP_X_FORWARDED_HOST']; + } + } else { + $host = $server['SERVER_NAME']; + } + + return $scheme.'://'.$host.$port; } // SSL detection diff --git a/application/LinkDB.php b/application/LinkDB.php index 0d3c85bd..9308164a 100644 --- a/application/LinkDB.php +++ b/application/LinkDB.php @@ -417,49 +417,36 @@ public function filterDay($request) { * - searchterm: term search * @param bool $casesensitive Optional: Perform case sensitive filter * @param string $visibility return only all/private/public links + * @param string $untaggedonly return only untagged links * * @return array filtered links, all links if no suitable filter was provided. */ - public function filterSearch($filterRequest = array(), $casesensitive = false, $visibility = 'all') + public function filterSearch($filterRequest = array(), $casesensitive = false, $visibility = 'all', $untaggedonly = false) { // Filter link database according to parameters. - $searchtags = !empty($filterRequest['searchtags']) ? escape($filterRequest['searchtags']) : ''; - $searchterm = !empty($filterRequest['searchterm']) ? escape($filterRequest['searchterm']) : ''; + $searchtags = isset($filterRequest['searchtags']) ? escape($filterRequest['searchtags']) : ''; + $searchterm = isset($filterRequest['searchterm']) ? escape($filterRequest['searchterm']) : ''; - // Search tags + fullsearch. - if (! empty($searchtags) && ! empty($searchterm)) { - $type = LinkFilter::$FILTER_TAG | LinkFilter::$FILTER_TEXT; - $request = array($searchtags, $searchterm); - } - // Search by tags. - elseif (! empty($searchtags)) { - $type = LinkFilter::$FILTER_TAG; - $request = $searchtags; - } - // Fulltext search. - elseif (! empty($searchterm)) { - $type = LinkFilter::$FILTER_TEXT; - $request = $searchterm; - } - // Otherwise, display without filtering. - else { - $type = ''; - $request = ''; - } + // Search tags + fullsearch - blank string parameter will return all links. + $type = LinkFilter::$FILTER_TAG | LinkFilter::$FILTER_TEXT; // == "vuotext" + $request = [$searchtags, $searchterm]; $linkFilter = new LinkFilter($this); - return $linkFilter->filter($type, $request, $casesensitive, $visibility); + return $linkFilter->filter($type, $request, $casesensitive, $visibility, $untaggedonly); } /** - * Returns the list of all tags - * Output: associative array key=tags, value=0 + * Returns the list tags appearing in the links with the given tags + * @param $filteringTags: tags selecting the links to consider + * @param $visibility: process only all/private/public links + * @return: a tag=>linksCount array */ - public function allTags() + public function linksCountPerTag($filteringTags = [], $visibility = 'all') { + $links = empty($filteringTags) ? $this->links : $this->filterSearch(['searchtags' => $filteringTags], false, $visibility); $tags = array(); $caseMapping = array(); - foreach ($this->links as $link) { + foreach ($links as $link) { foreach (preg_split('/\s+/', $link['tags'], 0, PREG_SPLIT_NO_EMPTY) as $tag) { if (empty($tag)) { continue; @@ -477,6 +464,39 @@ public function allTags() return $tags; } + /** + * Rename or delete a tag across all links. + * + * @param string $from Tag to rename + * @param string $to New tag. If none is provided, the from tag will be deleted + * + * @return array|bool List of altered links or false on error + */ + public function renameTag($from, $to) + { + if (empty($from)) { + return false; + } + $delete = empty($to); + // True for case-sensitive tag search. + $linksToAlter = $this->filterSearch(['searchtags' => $from], true); + foreach($linksToAlter as $key => &$value) + { + $tags = preg_split('/\s+/', trim($value['tags'])); + if (($pos = array_search($from, $tags)) !== false) { + if ($delete) { + unset($tags[$pos]); // Remove tag. + } else { + $tags[$pos] = trim($to); + } + $value['tags'] = trim(implode(' ', array_unique($tags))); + $this[$value['id']] = $value; + } + } + + return $linksToAlter; + } + /** * Returns the list of days containing articles (oldest first) * Output: An array containing days (in format YYYYMMDD). diff --git a/application/LinkFilter.php b/application/LinkFilter.php index 81832a4b..95519528 100644 --- a/application/LinkFilter.php +++ b/application/LinkFilter.php @@ -52,10 +52,11 @@ public function __construct($links) * @param mixed $request Filter content. * @param bool $casesensitive Optional: Perform case sensitive filter if true. * @param string $visibility Optional: return only all/private/public links + * @param string $untaggedonly Optional: return only untagged links. Applies only if $type includes FILTER_TAG * * @return array filtered link list. */ - public function filter($type, $request, $casesensitive = false, $visibility = 'all') + public function filter($type, $request, $casesensitive = false, $visibility = 'all', $untaggedonly = false) { if (! in_array($visibility, ['all', 'public', 'private'])) { $visibility = 'all'; @@ -64,23 +65,34 @@ public function filter($type, $request, $casesensitive = false, $visibility = 'a switch($type) { case self::$FILTER_HASH: return $this->filterSmallHash($request); - case self::$FILTER_TAG | self::$FILTER_TEXT: - if (!empty($request)) { - $filtered = $this->links; - if (isset($request[0])) { - $filtered = $this->filterTags($request[0], $casesensitive, $visibility); + case self::$FILTER_TAG | self::$FILTER_TEXT: // == "vuotext" + $noRequest = empty($request) || (empty($request[0]) && empty($request[1])); + if ($noRequest) { + if ($untaggedonly) { + return $this->filterUntagged($visibility); } - if (isset($request[1])) { - $lf = new LinkFilter($filtered); - $filtered = $lf->filterFulltext($request[1], $visibility); - } - return $filtered; + return $this->noFilter($visibility); } - return $this->noFilter($visibility); + if ($untaggedonly) { + $filtered = $this->filterUntagged($visibility); + } else { + $filtered = $this->links; + } + if (!empty($request[0])) { + $filtered = (new LinkFilter($filtered))->filterTags($request[0], $casesensitive, $visibility); + } + if (!empty($request[1])) { + $filtered = (new LinkFilter($filtered))->filterFulltext($request[1], $visibility); + } + return $filtered; case self::$FILTER_TEXT: return $this->filterFulltext($request, $visibility); case self::$FILTER_TAG: - return $this->filterTags($request, $casesensitive, $visibility); + if ($untaggedonly) { + return $this->filterUntagged($visibility); + } else { + return $this->filterTags($request, $casesensitive, $visibility); + } case self::$FILTER_DAY: return $this->filterDay($request); default: @@ -295,6 +307,33 @@ public function filterTags($tags, $casesensitive = false, $visibility = 'all') return $filtered; } + /** + * Return only links without any tag. + * + * @param string $visibility return only all/private/public links. + * + * @return array filtered links. + */ + public function filterUntagged($visibility) + { + $filtered = []; + foreach ($this->links as $key => $link) { + if ($visibility !== 'all') { + if (! $link['private'] && $visibility === 'private') { + continue; + } else if ($link['private'] && $visibility === 'public') { + continue; + } + } + + if (empty(trim($link['tags']))) { + $filtered[$key] = $link; + } + } + + return $filtered; + } + /** * Returns the list of articles for a given day, chronologically sorted * diff --git a/application/PageBuilder.php b/application/PageBuilder.php index 50e3f124..7a42400d 100644 --- a/application/PageBuilder.php +++ b/application/PageBuilder.php @@ -78,6 +78,7 @@ private function initialize() $this->tpl->assign('version', shaarli_version); $this->tpl->assign('scripturl', index_url($_SERVER)); $this->tpl->assign('privateonly', !empty($_SESSION['privateonly'])); // Show only private links? + $this->tpl->assign('untaggedonly', !empty($_SESSION['untaggedonly'])); $this->tpl->assign('pagetitle', $this->conf->get('general.title', 'Shaarli')); if ($this->conf->exists('general.header_link')) { $this->tpl->assign('titleLink', $this->conf->get('general.header_link')); @@ -89,7 +90,7 @@ private function initialize() $this->tpl->assign('hide_timestamps', $this->conf->get('privacy.hide_timestamps', false)); $this->tpl->assign('token', getToken($this->conf)); if ($this->linkDB !== null) { - $this->tpl->assign('tags', $this->linkDB->allTags()); + $this->tpl->assign('tags', $this->linkDB->linksCountPerTag()); } // To be removed with a proper theme configuration. $this->tpl->assign('conf', $this->conf); diff --git a/application/Router.php b/application/Router.php index c9a51912..4df0387c 100644 --- a/application/Router.php +++ b/application/Router.php @@ -13,6 +13,8 @@ class Router public static $PAGE_TAGCLOUD = 'tagcloud'; + public static $PAGE_TAGLIST = 'taglist'; + public static $PAGE_DAILY = 'daily'; public static $PAGE_FEED_ATOM = 'atom'; @@ -45,6 +47,8 @@ class Router public static $PAGE_SAVE_PLUGINSADMIN = 'save_pluginadmin'; + public static $GET_TOKEN = 'token'; + /** * Reproducing renderPage() if hell, to avoid regression. * @@ -77,6 +81,10 @@ public static function findPage($query, $get, $loggedIn) return self::$PAGE_TAGCLOUD; } + if (startsWith($query, 'do='. self::$PAGE_TAGLIST)) { + return self::$PAGE_TAGLIST; + } + if (startsWith($query, 'do='. self::$PAGE_OPENSEARCH)) { return self::$PAGE_OPENSEARCH; } @@ -142,6 +150,10 @@ public static function findPage($query, $get, $loggedIn) return self::$PAGE_SAVE_PLUGINSADMIN; } + if (startsWith($query, 'do='. self::$GET_TOKEN)) { + return self::$GET_TOKEN; + } + return self::$PAGE_LINKLIST; } } diff --git a/application/Updater.php b/application/Updater.php index 03d93a6f..40a15906 100644 --- a/application/Updater.php +++ b/application/Updater.php @@ -328,21 +328,6 @@ public function updateMethodMoveUserCss() return rename('inc/user.css', 'data/user.css'); } - /** - * While the new default theme is in an unstable state - * continue to use the vintage theme - */ - public function updateMethodDefaultThemeVintage() - { - if ($this->conf->get('resource.theme') !== 'default') { - return true; - } - $this->conf->set('resource.theme', 'vintage'); - $this->conf->write($this->isLoggedIn); - - return true; - } - /** * * `markdown_escape` is a new setting, set to true as default. * diff --git a/application/Url.php b/application/Url.php index 25a62a8a..b3759377 100644 --- a/application/Url.php +++ b/application/Url.php @@ -63,6 +63,30 @@ function add_trailing_slash($url) return $url . (!endsWith($url, '/') ? '/' : ''); } +/** + * Replace not whitelisted protocols by 'http://' from given URL. + * + * @param string $url URL to clean + * @param array $protocols List of allowed protocols (aside from http(s)). + * + * @return string URL with allowed protocol + */ +function whitelist_protocols($url, $protocols) +{ + if (startsWith($url, '?') || startsWith($url, '/')) { + return $url; + } + $protocols = array_merge(['http', 'https'], $protocols); + $protocol = preg_match('#^(\w+):/?/?#', $url, $match); + // Protocol not allowed: we remove it and replace it with http + if ($protocol === 1 && ! in_array($match[1], $protocols)) { + $url = str_replace($match[0], 'http://', $url); + } else if ($protocol !== 1) { + $url = 'http://' . $url; + } + return $url; +} + /** * URL representation and cleanup utilities * diff --git a/application/Utils.php b/application/Utils.php index ab463af9..4a2f5561 100644 --- a/application/Utils.php +++ b/application/Utils.php @@ -91,6 +91,10 @@ function endsWith($haystack, $needle, $case = true) */ function escape($input) { + if (is_bool($input)) { + return $input; + } + if (is_array($input)) { $out = array(); foreach($input as $key => $value) { @@ -435,3 +439,34 @@ function get_max_upload_size($limitPost, $limitUpload, $format = true) $maxsize = min($size1, $size2); return $format ? human_bytes($maxsize) : $maxsize; } + +/** + * Sort the given array alphabetically using php-intl if available. + * Case sensitive. + * + * Note: doesn't support multidimensional arrays + * + * @param array $data Input array, passed by reference + * @param bool $reverse Reverse sort if set to true + * @param bool $byKeys Sort the array by keys if set to true, by value otherwise. + */ +function alphabetical_sort(&$data, $reverse = false, $byKeys = false) +{ + $callback = function($a, $b) use ($reverse) { + // Collator is part of PHP intl. + if (class_exists('Collator')) { + $collator = new Collator(setlocale(LC_COLLATE, 0)); + if (!intl_is_failure(intl_get_error_code())) { + return $collator->compare($a, $b) * ($reverse ? -1 : 1); + } + } + + return strcasecmp($a, $b) * ($reverse ? -1 : 1); + }; + + if ($byKeys) { + uksort($data, $callback); + } else { + usort($data, $callback); + } +} diff --git a/application/config/ConfigManager.php b/application/config/ConfigManager.php index 86a917fb..8eab26f1 100644 --- a/application/config/ConfigManager.php +++ b/application/config/ConfigManager.php @@ -312,6 +312,7 @@ protected function setDefaultValues() $this->setEmpty('security.ban_duration', 1800); $this->setEmpty('security.session_protection_disabled', false); $this->setEmpty('security.open_shaarli', false); + $this->setEmpty('security.allowed_protocols', ['ftp', 'ftps', 'magnet']); $this->setEmpty('general.header_link', '?'); $this->setEmpty('general.links_per_page', 20); diff --git a/composer.json b/composer.json index 792c43d3..756ea588 100644 --- a/composer.json +++ b/composer.json @@ -9,6 +9,11 @@ "wiki": "https://github.com/shaarli/Shaarli/wiki" }, "keywords": ["bookmark", "link", "share", "web"], + "config": { + "platform": { + "php": "5.5.38" + } + }, "require": { "php": ">=5.5", "shaarli/netscape-bookmark-parser": "^2.0", diff --git a/composer.lock b/composer.lock index 0c1efa6b..435d6a88 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "ffcfc8e42f14183de6ef90874429e77a", + "content-hash": "68beedbfa104c788029b079800cfd6e8", "packages": [ { "name": "container-interop/container-interop", @@ -171,25 +171,29 @@ }, { "name": "pimple/pimple", - "version": "v3.0.2", + "version": "v3.2.2", "source": { "type": "git", "url": "https://github.com/silexphp/Pimple.git", - "reference": "a30f7d6e57565a2e1a316e1baf2a483f788b258a" + "reference": "4d45fb62d96418396ec58ba76e6f065bca16e10a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/silexphp/Pimple/zipball/a30f7d6e57565a2e1a316e1baf2a483f788b258a", - "reference": "a30f7d6e57565a2e1a316e1baf2a483f788b258a", + "url": "https://api.github.com/repos/silexphp/Pimple/zipball/4d45fb62d96418396ec58ba76e6f065bca16e10a", + "reference": "4d45fb62d96418396ec58ba76e6f065bca16e10a", "shasum": "" }, "require": { - "php": ">=5.3.0" + "php": ">=5.3.0", + "psr/container": "^1.0" + }, + "require-dev": { + "symfony/phpunit-bridge": "^3.2" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.0.x-dev" + "dev-master": "3.2.x-dev" } }, "autoload": { @@ -213,7 +217,7 @@ "container", "dependency injection" ], - "time": "2015-09-11T15:10:35+00:00" + "time": "2017-07-23T07:32:15+00:00" }, { "name": "psr/container", @@ -402,20 +406,20 @@ "publishers", "pubsubhubbub" ], - "time": "2016-11-15 06:24:01" + "time": "2016-11-15T06:24:01+00:00" }, { "name": "shaarli/netscape-bookmark-parser", - "version": "v2.0.1", + "version": "v2.0.4", "source": { "type": "git", "url": "https://github.com/shaarli/netscape-bookmark-parser.git", - "reference": "b65c7235d490bd933cdd5f71520dae656253adb9" + "reference": "81023979c981514f5dda5582e9c0be2ed6688a6b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/shaarli/netscape-bookmark-parser/zipball/b65c7235d490bd933cdd5f71520dae656253adb9", - "reference": "b65c7235d490bd933cdd5f71520dae656253adb9", + "url": "https://api.github.com/repos/shaarli/netscape-bookmark-parser/zipball/81023979c981514f5dda5582e9c0be2ed6688a6b", + "reference": "81023979c981514f5dda5582e9c0be2ed6688a6b", "shasum": "" }, "require": { @@ -457,7 +461,7 @@ "netscape", "parse" ], - "time": "2017-03-08T20:11:40+00:00" + "time": "2017-07-30T21:08:03+00:00" }, { "name": "slim/slim", @@ -682,22 +686,22 @@ }, { "name": "phpdocumentor/reflection-docblock", - "version": "3.1.1", + "version": "3.2.1", "source": { "type": "git", "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "8331b5efe816ae05461b7ca1e721c01b46bafb3e" + "reference": "183824db76118b9dddffc7e522b91fa175f75119" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/8331b5efe816ae05461b7ca1e721c01b46bafb3e", - "reference": "8331b5efe816ae05461b7ca1e721c01b46bafb3e", + "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/183824db76118b9dddffc7e522b91fa175f75119", + "reference": "183824db76118b9dddffc7e522b91fa175f75119", "shasum": "" }, "require": { "php": ">=5.5", "phpdocumentor/reflection-common": "^1.0@dev", - "phpdocumentor/type-resolver": "^0.2.0", + "phpdocumentor/type-resolver": "^0.3.0", "webmozart/assert": "^1.0" }, "require-dev": { @@ -723,24 +727,24 @@ } ], "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", - "time": "2016-09-30T07:12:33+00:00" + "time": "2017-08-04T20:55:59+00:00" }, { "name": "phpdocumentor/type-resolver", - "version": "0.2.1", + "version": "0.3.0", "source": { "type": "git", "url": "https://github.com/phpDocumentor/TypeResolver.git", - "reference": "e224fb2ea2fba6d3ad6fdaef91cd09a172155ccb" + "reference": "fb3933512008d8162b3cdf9e18dba9309b7c3773" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/e224fb2ea2fba6d3ad6fdaef91cd09a172155ccb", - "reference": "e224fb2ea2fba6d3ad6fdaef91cd09a172155ccb", + "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/fb3933512008d8162b3cdf9e18dba9309b7c3773", + "reference": "fb3933512008d8162b3cdf9e18dba9309b7c3773", "shasum": "" }, "require": { - "php": ">=5.5", + "php": "^5.5 || ^7.0", "phpdocumentor/reflection-common": "^1.0" }, "require-dev": { @@ -770,7 +774,7 @@ "email": "me@mikevanriel.com" } ], - "time": "2016-11-25T06:54:22+00:00" + "time": "2017-06-03T08:32:36+00:00" }, { "name": "phpmd/phpmd", @@ -1203,16 +1207,16 @@ }, { "name": "phpunit/phpunit", - "version": "4.8.35", + "version": "4.8.36", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "791b1a67c25af50e230f841ee7a9c6eba507dc87" + "reference": "46023de9a91eec7dfb06cc56cb4e260017298517" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/791b1a67c25af50e230f841ee7a9c6eba507dc87", - "reference": "791b1a67c25af50e230f841ee7a9c6eba507dc87", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/46023de9a91eec7dfb06cc56cb4e260017298517", + "reference": "46023de9a91eec7dfb06cc56cb4e260017298517", "shasum": "" }, "require": { @@ -1271,7 +1275,7 @@ "testing", "xunit" ], - "time": "2017-02-06T05:18:07+00:00" + "time": "2017-06-21T08:07:12+00:00" }, { "name": "phpunit/phpunit-mock-objects", @@ -1395,23 +1399,23 @@ }, { "name": "sebastian/diff", - "version": "1.4.1", + "version": "1.4.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "13edfd8706462032c2f52b4b862974dd46b71c9e" + "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/13edfd8706462032c2f52b4b862974dd46b71c9e", - "reference": "13edfd8706462032c2f52b4b862974dd46b71c9e", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7f066a26a962dbe58ddea9f72a4e82874a3975a4", + "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": "^5.3.3 || ^7.0" }, "require-dev": { - "phpunit/phpunit": "~4.8" + "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" }, "type": "library", "extra": { @@ -1443,7 +1447,7 @@ "keywords": [ "diff" ], - "time": "2015-12-08T07:14:41+00:00" + "time": "2017-05-22T07:24:03+00:00" }, { "name": "sebastian/environment", @@ -1793,16 +1797,16 @@ }, { "name": "squizlabs/php_codesniffer", - "version": "2.9.0", + "version": "2.9.1", "source": { "type": "git", "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", - "reference": "f7dfecbee89d68ab475a6c9e17d22bc9b69aed97" + "reference": "dcbed1074f8244661eecddfc2a675430d8d33f62" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/f7dfecbee89d68ab475a6c9e17d22bc9b69aed97", - "reference": "f7dfecbee89d68ab475a6c9e17d22bc9b69aed97", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/dcbed1074f8244661eecddfc2a675430d8d33f62", + "reference": "dcbed1074f8244661eecddfc2a675430d8d33f62", "shasum": "" }, "require": { @@ -1867,27 +1871,33 @@ "phpcs", "standards" ], - "time": "2017-05-03T23:30:39+00:00" + "time": "2017-05-22T02:43:20+00:00" }, { "name": "symfony/config", - "version": "v3.2.8", + "version": "v3.3.6", "source": { "type": "git", "url": "https://github.com/symfony/config.git", - "reference": "e5533fcc0b3dd377626153b2852707878f363728" + "reference": "54ee12b0dd60f294132cabae6f5da9573d2e5297" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/config/zipball/e5533fcc0b3dd377626153b2852707878f363728", - "reference": "e5533fcc0b3dd377626153b2852707878f363728", + "url": "https://api.github.com/repos/symfony/config/zipball/54ee12b0dd60f294132cabae6f5da9573d2e5297", + "reference": "54ee12b0dd60f294132cabae6f5da9573d2e5297", "shasum": "" }, "require": { "php": ">=5.5.9", "symfony/filesystem": "~2.8|~3.0" }, + "conflict": { + "symfony/dependency-injection": "<3.3", + "symfony/finder": "<3.3" + }, "require-dev": { + "symfony/dependency-injection": "~3.3", + "symfony/finder": "~3.3", "symfony/yaml": "~3.0" }, "suggest": { @@ -1896,7 +1906,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2-dev" + "dev-master": "3.3-dev" } }, "autoload": { @@ -1923,20 +1933,20 @@ ], "description": "Symfony Config Component", "homepage": "https://symfony.com", - "time": "2017-04-12T14:13:17+00:00" + "time": "2017-07-19T07:37:29+00:00" }, { "name": "symfony/console", - "version": "v2.8.20", + "version": "v2.8.26", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "2cfcbced8e39e2313ed4da8896fc8c59a56c0d7e" + "reference": "32a3c6b3398de5db8ed381f4ef92970c59c2fcdd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/2cfcbced8e39e2313ed4da8896fc8c59a56c0d7e", - "reference": "2cfcbced8e39e2313ed4da8896fc8c59a56c0d7e", + "url": "https://api.github.com/repos/symfony/console/zipball/32a3c6b3398de5db8ed381f4ef92970c59c2fcdd", + "reference": "32a3c6b3398de5db8ed381f4ef92970c59c2fcdd", "shasum": "" }, "require": { @@ -1984,7 +1994,7 @@ ], "description": "Symfony Console Component", "homepage": "https://symfony.com", - "time": "2017-04-26T01:38:53+00:00" + "time": "2017-07-29T21:26:04+00:00" }, { "name": "symfony/debug", @@ -2045,39 +2055,46 @@ }, { "name": "symfony/dependency-injection", - "version": "v3.2.8", + "version": "v3.3.6", "source": { "type": "git", "url": "https://github.com/symfony/dependency-injection.git", - "reference": "5e00857475b6d1fa31ff4c76f1fddf1cfa9e8d59" + "reference": "8d70987f991481e809c63681ffe8ce3f3fde68a0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/5e00857475b6d1fa31ff4c76f1fddf1cfa9e8d59", - "reference": "5e00857475b6d1fa31ff4c76f1fddf1cfa9e8d59", + "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/8d70987f991481e809c63681ffe8ce3f3fde68a0", + "reference": "8d70987f991481e809c63681ffe8ce3f3fde68a0", "shasum": "" }, "require": { - "php": ">=5.5.9" + "php": ">=5.5.9", + "psr/container": "^1.0" }, "conflict": { - "symfony/yaml": "<3.2" + "symfony/config": "<3.3.1", + "symfony/finder": "<3.3", + "symfony/yaml": "<3.3" + }, + "provide": { + "psr/container-implementation": "1.0" }, "require-dev": { - "symfony/config": "~2.8|~3.0", + "symfony/config": "~3.3", "symfony/expression-language": "~2.8|~3.0", - "symfony/yaml": "~3.2" + "symfony/yaml": "~3.3" }, "suggest": { "symfony/config": "", "symfony/expression-language": "For using expressions in service container configuration", + "symfony/finder": "For using double-star glob patterns or when GLOB_BRACE portability is required", "symfony/proxy-manager-bridge": "Generate service proxies to lazy load them", "symfony/yaml": "" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2-dev" + "dev-master": "3.3-dev" } }, "autoload": { @@ -2104,20 +2121,20 @@ ], "description": "Symfony DependencyInjection Component", "homepage": "https://symfony.com", - "time": "2017-04-26T01:39:17+00:00" + "time": "2017-07-28T15:27:31+00:00" }, { "name": "symfony/filesystem", - "version": "v3.2.8", + "version": "v3.3.6", "source": { "type": "git", "url": "https://github.com/symfony/filesystem.git", - "reference": "040651db13cf061827a460cc10f6e36a445c45b4" + "reference": "427987eb4eed764c3b6e38d52a0f87989e010676" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/filesystem/zipball/040651db13cf061827a460cc10f6e36a445c45b4", - "reference": "040651db13cf061827a460cc10f6e36a445c45b4", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/427987eb4eed764c3b6e38d52a0f87989e010676", + "reference": "427987eb4eed764c3b6e38d52a0f87989e010676", "shasum": "" }, "require": { @@ -2126,7 +2143,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2-dev" + "dev-master": "3.3-dev" } }, "autoload": { @@ -2153,20 +2170,20 @@ ], "description": "Symfony Filesystem Component", "homepage": "https://symfony.com", - "time": "2017-04-12T14:13:17+00:00" + "time": "2017-07-11T07:17:58+00:00" }, { "name": "symfony/finder", - "version": "v3.2.8", + "version": "v3.3.6", "source": { "type": "git", "url": "https://github.com/symfony/finder.git", - "reference": "9cf076f8f492f4b1ffac40aae9c2d287b4ca6930" + "reference": "baea7f66d30854ad32988c11a09d7ffd485810c4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/finder/zipball/9cf076f8f492f4b1ffac40aae9c2d287b4ca6930", - "reference": "9cf076f8f492f4b1ffac40aae9c2d287b4ca6930", + "url": "https://api.github.com/repos/symfony/finder/zipball/baea7f66d30854ad32988c11a09d7ffd485810c4", + "reference": "baea7f66d30854ad32988c11a09d7ffd485810c4", "shasum": "" }, "require": { @@ -2175,7 +2192,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2-dev" + "dev-master": "3.3-dev" } }, "autoload": { @@ -2202,20 +2219,20 @@ ], "description": "Symfony Finder Component", "homepage": "https://symfony.com", - "time": "2017-04-12T14:13:17+00:00" + "time": "2017-06-01T21:01:25+00:00" }, { "name": "symfony/polyfill-mbstring", - "version": "v1.3.0", + "version": "v1.4.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "e79d363049d1c2128f133a2667e4f4190904f7f4" + "reference": "f29dca382a6485c3cbe6379f0c61230167681937" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/e79d363049d1c2128f133a2667e4f4190904f7f4", - "reference": "e79d363049d1c2128f133a2667e4f4190904f7f4", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/f29dca382a6485c3cbe6379f0c61230167681937", + "reference": "f29dca382a6485c3cbe6379f0c61230167681937", "shasum": "" }, "require": { @@ -2227,7 +2244,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.3-dev" + "dev-master": "1.4-dev" } }, "autoload": { @@ -2261,20 +2278,20 @@ "portable", "shim" ], - "time": "2016-11-14T01:06:16+00:00" + "time": "2017-06-09T14:24:12+00:00" }, { "name": "symfony/yaml", - "version": "v3.2.8", + "version": "v3.3.6", "source": { "type": "git", "url": "https://github.com/symfony/yaml.git", - "reference": "acec26fcf7f3031e094e910b94b002fa53d4e4d6" + "reference": "ddc23324e6cfe066f3dd34a37ff494fa80b617ed" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/acec26fcf7f3031e094e910b94b002fa53d4e4d6", - "reference": "acec26fcf7f3031e094e910b94b002fa53d4e4d6", + "url": "https://api.github.com/repos/symfony/yaml/zipball/ddc23324e6cfe066f3dd34a37ff494fa80b617ed", + "reference": "ddc23324e6cfe066f3dd34a37ff494fa80b617ed", "shasum": "" }, "require": { @@ -2289,7 +2306,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2-dev" + "dev-master": "3.3-dev" } }, "autoload": { @@ -2316,20 +2333,20 @@ ], "description": "Symfony Yaml Component", "homepage": "https://symfony.com", - "time": "2017-05-01T14:55:58+00:00" + "time": "2017-07-23T12:43:26+00:00" }, { "name": "theseer/fdomdocument", - "version": "1.6.5", + "version": "1.6.6", "source": { "type": "git", "url": "https://github.com/theseer/fDOMDocument.git", - "reference": "8dcfd392135a5bd938c3c83ea71419501ad9855d" + "reference": "6e8203e40a32a9c770bcb62fe37e68b948da6dca" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/theseer/fDOMDocument/zipball/8dcfd392135a5bd938c3c83ea71419501ad9855d", - "reference": "8dcfd392135a5bd938c3c83ea71419501ad9855d", + "url": "https://api.github.com/repos/theseer/fDOMDocument/zipball/6e8203e40a32a9c770bcb62fe37e68b948da6dca", + "reference": "6e8203e40a32a9c770bcb62fe37e68b948da6dca", "shasum": "" }, "require": { @@ -2356,7 +2373,7 @@ ], "description": "The classes contained within this repository extend the standard DOM to use exceptions at all occasions of errors instead of PHP warnings or notices. They also add various custom methods and shortcuts for convenience and to simplify the usage of DOM.", "homepage": "https://github.com/theseer/fDOMDocument", - "time": "2017-04-21T14:50:31+00:00" + "time": "2017-06-30T11:53:12+00:00" }, { "name": "webmozart/assert", @@ -2420,5 +2437,8 @@ "platform": { "php": ">=5.5" }, - "platform-dev": [] + "platform-dev": [], + "platform-overrides": { + "php": "5.5.38" + } } diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html deleted file mode 100644 index 50aba6c0..00000000 --- a/doc/3rd-party-libraries.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - - Shaarli – 3rd party libraries - - - - - - -

3rd party libraries

-

CSS

-
    -
  • Yahoo UI CSS Reset -
      -
    • resets default CSS properties for all HTML elements (overriding browsers' default values)
      • -
    • ensures custom CSS stylessheets will provide the same results on all browsers
      • -
    • -
-

Javascript

- -

PHP

- - - diff --git a/doc/Backup,-restore,-import-and-export.html b/doc/Backup,-restore,-import-and-export.html deleted file mode 100644 index 3c168824..00000000 --- a/doc/Backup,-restore,-import-and-export.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - Shaarli – Backup, restore, import and export - - - - - - - -

Backup, restore, import and export

- -
-

Backup and restore the datastore file

-

Backup the file data/datastore.php (by FTP or SSH). Restore by putting the file back in place.

-

Example command:

-
rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
- -

To export links as an HTML file, under Tools > Export, choose:

-
    -
  • Export all to export both public and private links
    • -
  • Export public to export public links only
    • -
  • Export private to export private links only
    • -
-

Restore by using the Import feature.

- -

Example command:

-
./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
- -

Diigo

-

If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)

-

Mister Wong

-

See this issue for import tweaks.

-

SemanticScuttle

-

To correctly import the tags from a SemanticScuttle HTML export, edit the HTML file before importing and replace all occurences of tags= (lowercase) to TAGS= (uppercase).

-

Scuttle

-

Shaarli cannot import data directly from Scuttle. However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.

- -
    -
  • Export your Shaarli links as described above.
    • -
  • For compatibility reasons, check Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)
    • -
  • In Firefox, open the bookmark manager (not the sidebar! Bookmarks menu > Show all bookmarks or Ctrl+Shift+B)
    • -
  • Select Import and Backup > Import bookmarks in HTML format
    • -
-

Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.

-

You may be interested in these Firefox addons to manage links imported from Shaarli

- - - diff --git a/doc/Browsing-and-searching.html b/doc/Browsing-and-searching.html deleted file mode 100644 index ef5b5245..00000000 --- a/doc/Browsing-and-searching.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Shaarli – Browsing and searching - - - - - - -

Browsing and searching

-

Browsing and Searching

-

-

Plain text search

-

Use the Search text field to search in any of the fields of all links (Title, URL, Description...)

-

Exclude text/tags: Use the - operator before a word or tag (example -uninteresting) to prevent entries containing (or tagged) uninteresting from showing up in the search results.

-

Exact text search: Use double-quotes (example "exact search") to search for the exact expression.

-

Both exclude patterns and exact searches can be combined with normal searches (example "exact search" term otherterm -notthis "very exact" stuff -notagain)

- -

Use the Filter by tags field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).

-

Hidden tags: Tags starting with a dot . (example .secret) are private. They can only be seen and searched when logged in.

-

Alternatively you can use the Tag cloud to discover all tags and click on any of them to display related links.

-

To search for links that are not tagged, enter "" in the tag search field.

-

Filtering RSS feeds/Picture wall

-

RSS feeds can also be restricted to only return items matching a text/tag search: see RSS feeds.

- - diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html deleted file mode 100644 index 8df12182..00000000 --- a/doc/Coding-guidelines.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - Shaarli – Coding guidelines - - - - - - -

Coding guidelines

-

WIP

-

This topic is currently being discussed here:

- - - diff --git a/doc/Coding-guidelines.md b/doc/Coding-guidelines.md deleted file mode 100644 index 1fb28a5b..00000000 --- a/doc/Coding-guidelines.md +++ /dev/null @@ -1,5 +0,0 @@ -#Coding guidelines -## WIP -This topic is currently being discussed here: -- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95)[](.html) -- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130)[](.html) diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html deleted file mode 100644 index 28b96185..00000000 --- a/doc/Community-&-Related-software.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - Shaarli – Community & Related software - - - - - - -

Community & Related software

-

Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork.

-

TODO: contact repos owners to see if they'd like to standardize their work with the community fork.

-

Community

- -

Articles and social media discussions

- -

Third party plugins

- -

Themes

-

See Theming for the list of community-contributed themes, and an installation guide.

-

Server apps

-
    -
  • shaarchiver - Archive your Shaarli bookmarks and their content
    • -
  • shaarli-river - An aggregator for shaarlis with many features
    • -
  • Shaarlo - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: shaarli.fr)
    • -
  • Shaarlimages - An image-oriented aggregator for Shaarlis
    • -
  • mknexen/shaarli-api - A REST API for Shaarli
    • -
  • Self dead link - Detect dead links on shaarli. This version use the database of shaarli. Another version, can be used for other shaarli instances (but is more resource consuming).
    • -
-

Mobile Apps

- -

Integration with other platforms

- -

Alternatives to Shaarli

- - - diff --git a/doc/Community-&-Related-software.md b/doc/Community-&-Related-software.md deleted file mode 100644 index 52123a1e..00000000 --- a/doc/Community-&-Related-software.md +++ /dev/null @@ -1,61 +0,0 @@ -#Community & Related software -_Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork._ - -_TODO: contact repos owners to see if they'd like to standardize their work with the community fork._ - -## Community -- [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli[](.html) -- [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html)[](.html) -- [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json)[](.html) -- [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list)[](.html) -- [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_[](.html) -- [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas)[](.html) -- [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr)[](.html) -- [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history)[](.html) -- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni)[](.html) - -### Articles and social media discussions -- 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 -- 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/)[](.html) -- 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 -- 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/)[](.html) - -### Third party plugins - - - * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown.[](.html) - * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter.[](.html) - * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli.[](.html) - * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli.[](.html) - * [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support[](.html) - * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli.[](.html) - * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks.[](.html) - * [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli[](.html) - - -### Themes -See [Theming](Theming.html) for the list of community-contributed themes, and an installation guide. - -### Server apps -- [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content[](.html) -- [shaarli-river](https://github.com/mknexen/shaarli-river) - An aggregator for shaarlis with many features [](.html) -- [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/))[](.html) -- [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis[](.html) -- [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli[](.html) -- [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming).[](.html) - -### Mobile Apps -- [Shaarli💫](http://app.mro.name/Shaarli💫) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes,[](.html) -- [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider[](.html) -- [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli[](.html) - -## Integration with other platforms -- [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [TinyTiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli[](.html) -- [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar[](.html) -- [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle[](.html) - -## Alternatives to Shaarli -- [Shaarli alternatives](http://alternativeto.net/software/shaarli/) (alternativeto.net)[](.html) -- [Bookie](https://github.com/bookieio/bookie) - Another self-hostable, free bookmark sharing software, written in Python[](.html) -- [Unmark](https://github.com/plainmade/unmark) - An open source todo app for bookmarks ([Homepage](https://unmark.it/))[](.html) -- [Wordpress bookmarks](https://wordpress.org/plugins/wp-bookmarks/)[](.html) diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html deleted file mode 100644 index d6b76add..00000000 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - Shaarli – Copy an existing installation over SSH and serve it locally - - - - - - - -

Copy an existing installation over SSH and serve it locally

-

Example bash script:

-
#!/bin/bash
-#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli
-#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally.
-#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli
-#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed
-#Usage: ./local-shaarli.sh
-#Author: nodiscc (nodiscc@gmail.com)
-#License: MIT (http://opensource.org/licenses/MIT)
-set -o errexit
-set -o nounset
-
-##### CONFIG #################
-#The port used by php's local server
-php_local_port=7431
-
-#Name of the SSH server and path where Shaarli is installed
-#TODO: pass these as command-line arguments
-remotehost="my.ssh.server"
-remote_shaarli_dir="/var/www/shaarli"
-
-
-###### FUNCTIONS #############
-_main() {
-    _CBSyncShaarli
-    _CBServeShaarli
-}
-
-_CBSyncShaarli() {
-    remote_temp_dir=$(ssh $remotehost mktemp -d)
-    remote_ssh_user=$(ssh $remotehost whoami)
-    ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir"
-    ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir"
-    scp -rq "$remotehost":"$remote_temp_dir" local-shaarli
-    ssh "$remotehost" rm -r "$remote_temp_dir"
-}
-
-_CBServeShaarli() {
-    #TODO: allow serving a previously downloaded Shaarli
-    #TODO: ask before overwriting local copy, if it exists
-    cd local-shaarli/
-    php -S localhost:${php_local_port}
-    echo "Please go to http://localhost:${php_local_port}"
-}
-
-
-##### MAIN #################
-
-_main
-

This outputs:

-
$ ./local-shaarli.sh
-PHP 5.6.0RC4 Development Server started at Mon Sep  1 21:56:19 2014
-Listening on http://localhost:7431
-Document root is /home/user/local-shaarli/shaarli
-Press Ctrl-C to quit.
-
-[Mon Sep  1 21:56:27 2014] ::1:57868 [200]: /[](.html)
-[Mon Sep  1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html)
-[Mon Sep  1 21:56:37 2014] ::1:57881 [200]: /...[](.html)
- - diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md deleted file mode 100644 index 88d191da..00000000 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md +++ /dev/null @@ -1,67 +0,0 @@ -#Copy an existing installation over SSH and serve it locally -Example bash script: - -```bash -#!/bin/bash -#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli -#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally. -#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli -#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed -#Usage: ./local-shaarli.sh -#Author: nodiscc (nodiscc@gmail.com) -#License: MIT (http://opensource.org/licenses/MIT) -set -o errexit -set -o nounset - -##### CONFIG ################# -#The port used by php's local server -php_local_port=7431 - -#Name of the SSH server and path where Shaarli is installed -#TODO: pass these as command-line arguments -remotehost="my.ssh.server" -remote_shaarli_dir="/var/www/shaarli" - - -###### FUNCTIONS ############# -_main() { - _CBSyncShaarli - _CBServeShaarli -} - -_CBSyncShaarli() { - remote_temp_dir=$(ssh $remotehost mktemp -d) - remote_ssh_user=$(ssh $remotehost whoami) - ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir" - ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir" - scp -rq "$remotehost":"$remote_temp_dir" local-shaarli - ssh "$remotehost" rm -r "$remote_temp_dir" -} - -_CBServeShaarli() { - #TODO: allow serving a previously downloaded Shaarli - #TODO: ask before overwriting local copy, if it exists - cd local-shaarli/ - php -S localhost:${php_local_port} - echo "Please go to http://localhost:${php_local_port}" -} - - -##### MAIN ################# - -_main -``` - -This outputs: - -```bash -$ ./local-shaarli.sh -PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 -Listening on http://localhost:7431 -Document root is /home/user/local-shaarli/shaarli -Press Ctrl-C to quit. - -[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: /[](.html) -[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html[](.html) -[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /...[](.html) -``` diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).html b/doc/Create-and-serve-multiple-Shaarlis-(farm).html deleted file mode 100644 index 0be81d56..00000000 --- a/doc/Create-and-serve-multiple-Shaarlis-(farm).html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - Shaarli – Create and serve multiple Shaarlis (farm) - - - - - - - -

Create and serve multiple Shaarlis (farm)

-

Example bash script (creates multiple shaarli instances and generates an HTML index of them)

-
#!/bin/bash
-set -o errexit
-set -o nounset
-
-#config
-shaarli_base_dir='/var/www/shaarli'
-accounts='bob john whatever username'
-shaarli_repo_url='https://github.com/shaarli/Shaarli'
-ref="master"
-
-#clone multiple shaarli instances
-if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi[](.html)
-   
-for account in $accounts; do
-    if [ -d "$shaarli_base_dir/$account" ];[](.html)
-    then echo "[info] account $account already exists, skipping";[](.html)
-    else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi[](.html)
-done
-
-#generate html index of shaarlis
-htmlhead='<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<!-- Minimal html template thanks to http://www.sitepoint.com/a-minimal-html-document/ -->
-<html lang="en">
-    <head>
-        <meta http-equiv="content-type" content="text/html; charset=utf-8">
-        <title>My Shaarli farm</title>
-        <style>body {font-family: "Open Sans"}</style>
-    </head>
-    <body>
-    <div>
-    <h1>My Shaarli farm</h1>
-    <ul style="list-style-type: none;">'
-
-accountlinks=''
-    
-htmlfooter='
-    </ul>
-    </div>
-    </body>
-</html>'    
-    
-
-
-for account in $accounts; do accountlinks="$accountlinks\n<li><a href=\"$account\">$account</a></li>"; done
-if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi[](.html)
-echo "[info] generating new index of shaarlis"[](.html)
-echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html"
-echo '[info] done.'[](.html)
-echo "[info] list of accounts: $accounts"[](.html)
-echo "[info] contents of $shaarli_base_dir:"[](.html)
-tree -a -L 1 "$shaarli_base_dir"
-

This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like Ansible

- - diff --git a/doc/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/Create-and-serve-multiple-Shaarlis-(farm).md deleted file mode 100644 index a71f6520..00000000 --- a/doc/Create-and-serve-multiple-Shaarlis-(farm).md +++ /dev/null @@ -1,58 +0,0 @@ -#Create and serve multiple Shaarlis (farm) -Example bash script (creates multiple shaarli instances and generates an HTML index of them) - -```bash -#!/bin/bash -set -o errexit -set -o nounset - -#config -shaarli_base_dir='/var/www/shaarli' -accounts='bob john whatever username' -shaarli_repo_url='https://github.com/shaarli/Shaarli' -ref="master" - -#clone multiple shaarli instances -if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi[](.html) - -for account in $accounts; do - if [ -d "$shaarli_base_dir/$account" ];[](.html) - then echo "[info] account $account already exists, skipping";[](.html) - else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi[](.html) -done - -#generate html index of shaarlis -htmlhead=' - - - - - My Shaarli farm - - - -
-

My Shaarli farm

-
    ' - -accountlinks='' - -htmlfooter=' -
-
- -' - - - -for account in $accounts; do accountlinks="$accountlinks\n
  • $account
    • "; done -if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi[](.html) -echo "[info] generating new index of shaarlis"[](.html) -echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" -echo '[info] done.'[](.html) -echo "[info] list of accounts: $accounts"[](.html) -echo "[info] contents of $shaarli_base_dir:"[](.html) -tree -a -L 1 "$shaarli_base_dir" -``` - -This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/)[](.html) diff --git a/doc/Datastore-hacks.html b/doc/Datastore-hacks.html deleted file mode 100644 index ef3e17bb..00000000 --- a/doc/Datastore-hacks.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - Shaarli – Datastore hacks - - - - - - - -

    Datastore hacks

    -

    Decode datastore content

    -

    To display the array representing the data saved in data/datastore.php, use the following snippet:

    -
    $data = "tZNdb9MwFIb... <Commented content inside datastore.php>";
-$out = unserialize(gzinflate(base64_decode($data)));
-echo "<pre>"; // Pretty printing is love, pretty printing is life
-print_r($out);
-echo "</pre>";
-exit;
    -

    This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation).

    -

    Alternatively, you can transform to JSON format (and pretty-print if you have jq installed):

    -
    php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq .
    - -
      -
    • Look for <input type="hidden" name="lf_linkdate" value="{$link.linkdate}"> in tpl/editlink.tpl (line 14)
      • -
    • Replace type="hidden" with type="text" from this line
      • -
    • A new date/time field becomes available in the edit/new link dialog.
      • -
    • You can set the timestamp manually by entering it in the format YYYMMDD_HHMMS.
      • -
    - - diff --git a/doc/Datastore-hacks.md b/doc/Datastore-hacks.md deleted file mode 100644 index ef6f6d50..00000000 --- a/doc/Datastore-hacks.md +++ /dev/null @@ -1,24 +0,0 @@ -#Datastore hacks -### Decode datastore content -To display the array representing the data saved in `data/datastore.php`, use the following snippet: - -```php -$data = "tZNdb9MwFIb... "; -$out = unserialize(gzinflate(base64_decode($data))); -echo "
    "; // Pretty printing is love, pretty printing is life
-print_r($out);
-echo "
    "; -exit; -``` -This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). - -Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): -``` -php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . -``` - -### Changing the timestamp for a link -* Look for `` in `tpl/editlink.tpl` (line 14) -* Replace `type="hidden"` with `type="text"` from this line -* A new date/time field becomes available in the edit/new link dialog. -* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. diff --git a/doc/Development.html b/doc/Development.html deleted file mode 100644 index 8a2be413..00000000 --- a/doc/Development.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - Shaarli – Development - - - - - - -

    Development

    -

    Guidelines

    -

    Please have a look at the following pages:

    - -

    Continuous integration tools

    -

    Local development

    -

    A Makefile is available to perform project-related operations:

    -
      -
    • Documentation - generate a local HTML copy of the GitHub wiki
      • -
    • Static analysis - check that the code is compliant to PHP conventions
      • -
    • Unit tests - ensure there are no regressions introduced by new commits
      • -
    -

    Automatic builds

    -

    Travis CI is a Continuous Integration build server, that runs a build:

    -
      -
    • each time a commit is merged to the mainline (master branch)
      • -
    • each time a Pull Request is submitted or updated
      • -
    -

    A build is composed of several jobs: one for each supported PHP version (see Server requirements).

    -

    Each build job:

    -
      -
    • updates Composer
      • -
    • installs 3rd-party test dependencies with Composer
      • -
    • runs Unit tests
      • -
    -

    After all jobs have finished, Travis returns the results to GitHub:

    -
      -
    • a status icon represents the result for the master branch: (https://api.travis-ci.org/shaarli/Shaarli.svg)
      • -
    • Pull Requests are updated with the Travis result -
        -
      • Green: all tests have passed
        • -
      • Red: some tests failed
        • -
      • Orange: tests are pending
        • -
      • -
    - - diff --git a/doc/Development.md b/doc/Development.md deleted file mode 100644 index 6cfcb683..00000000 --- a/doc/Development.md +++ /dev/null @@ -1,35 +0,0 @@ -#Development -## Guidelines -Please have a look at the following pages: -- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)[](.html) -- [Static analysis](Static-analysis.html) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: - - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard[](.html) - - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide[](.html) -- [Unit tests](Unit-tests.html) -- [GnuPG signature](GnuPG-signature.html) for tags/releases - -## Continuous integration tools -### Local development -A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations:[](.html) -- Documentation - generate a local HTML copy of the GitHub wiki -- [Static analysis](Static-analysis.html) - check that the code is compliant to PHP conventions -- [Unit tests](Unit-tests.html) - ensure there are no regressions introduced by new commits - -### Automatic builds -[Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build:[](.html) -- each time a commit is merged to the mainline (`master` branch) -- each time a Pull Request is submitted or updated - -A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server-requirements.html)). - -Each build job: -- updates Composer -- installs 3rd-party test dependencies with Composer -- runs [Unit tests](Unit-tests.html) - -After all jobs have finished, Travis returns the results to GitHub: -- a status icon represents the result for the `master` branch: [![(https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli)]((https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli).html) -- Pull Requests are updated with the Travis result - - Green: all tests have passed - - Red: some tests failed - - Orange: tests are pending diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html deleted file mode 100644 index 3f75db8e..00000000 --- a/doc/Directory-structure.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Shaarli – Directory structure - - - - - - - -

    Directory structure

    -

    Here is the directory structure of Shaarli and the purpose of the different files:

    -
        index.php        # Main program
-    application/     # Shaarli classes
-        ├── LinkDB.php
-        └── Utils.php
-    tests/       # Shaarli unitary & functional tests
-        ├── LinkDBTest.php
-        ├── utils  # utilities to ease testing
-        │   └── ReferenceLinkDB.php
-        └── UtilsTest.php
-    COPYING          # Shaarli license
-    inc/             # static assets and 3rd party libraries
-        ├── awesomplete.*          # tags autocompletion library
-        ├── blazy.*                # picture wall lazy image loading library
-        ├── shaarli.css, reset.css # Shaarli stylesheet.
-        ├── qr.*                   # qr code generation library
-        └──rain.tpl.class.php      # RainTPL templating library
-    tpl/             # RainTPL templates for Shaarli. They are used to build the pages.
-    images/          # Images and icons used in Shaarli
-    data/            # data storage: bookmark database, configuration, logs, banlist…
-        ├── config.php             # Shaarli configuration (login, password, timezone, title…)
-        ├── datastore.php          # Your link database (compressed).
-        ├── ipban.php              # IP address ban system data
-        ├── lastupdatecheck.txt    # Update check timestamp file
-        └──log.txt                 # login/IPban log.
-    cache/           # thumbnails cache
-                     # This directory is automatically created. You can erase it anytime you want.
-    tmp/             # Temporary directory for compiled RainTPL templates.
-                     # This directory is automatically created. You can erase it anytime you want.
    - - diff --git a/doc/Docker.html b/doc/Docker.html deleted file mode 100644 index fd0dec4b..00000000 --- a/doc/Docker.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - Shaarli – Docker - - - - - - - -

    Docker

    - -

    Docker usage

    -

    Basics

    -

    Install Docker, by following the instructions relevant
    -to your OS / distribution, and start the service.

    -

    Search an image on DockerHub

    -
    $ docker search debian
-
-NAME            DESCRIPTION                                     STARS   OFFICIAL   AUTOMATED
-ubuntu          Ubuntu is a Debian-based Linux operating s...   2065    [OK][](.html)
-debian          Debian is a Linux distribution that's comp...   603     [OK][](.html)
-google/debian                                                   47                 [OK][](.html)
    -

    Show available tags for a repository

    -
    $ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool
-
-% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
-Dload  Upload   Total   Spent    Left  Speed
-100  1283    0  1283    0     0    433      0 --:--:--  0:00:02 --:--:--   433
    -

    Sample output:

    -
    [[](.html)
-    {
-        "layer": "85a02782",
-        "name": "stretch"
-    },
-    {
-        "layer": "59abecbc",
-        "name": "testing"
-    },
-    {
-        "layer": "bf0fd686",
-        "name": "unstable"
-    },
-    {
-        "layer": "60c52dbe",
-        "name": "wheezy"
-    },
-    {
-        "layer": "c5b806fe",
-        "name": "wheezy-backports"
-    }
-]
    -

    Pull an image from DockerHub

    -
    $ docker pull repository[:tag][](.html)
-
-$ docker pull debian:wheezy
-wheezy: Pulling from debian
-4c8cbfd2973e: Pull complete
-60c52dbe9d91: Pull complete
-Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
-Status: Downloaded newer image for debian:wheezy
    -

    Get and run a Shaarli image

    -

    DockerHub repository

    -

    The images can be found in the shaarli/shaarli
    -repository.

    -

    Available image tags

    -
      -
    • latest: master branch (tarball release)
      • -
    • stable: stable branch (tarball release)
      • -
    • dev: master branch (Git clone)
      • -
    -

    All images rely on:

    - -

    Download from DockerHub

    -
    $ docker pull shaarli/shaarli
-latest: Pulling from shaarli/shaarli
-32716d9fcddb: Pull complete
-84899d045435: Pull complete
-4b6ad7444763: Pull complete
-e0345ef7a3e0: Pull complete
-5c1dd344094f: Pull complete
-6422305a200b: Pull complete
-7d63f861dbef: Pull complete
-3eb97210645c: Pull complete
-869319d746ff: Already exists
-869319d746ff: Pulling fs layer
-902b87aaaec9: Already exists
-Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
-Status: Downloaded newer image for shaarli/shaarli:latest
    -

    Create and start a new container from the image

    -
    # map the host's :8000 port to the container's :80 port
-$ docker create -p 8000:80 shaarli/shaarli
-d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-
-# launch the container in the background
-$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-
-# list active containers
-$ docker ps
-CONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES
-d40b7af693d6  shaarli/shaarli  /usr/bin/supervisor  15 seconds ago  Up 4 seconds  0.0.0.0:8000->80/tcp  backstabbing_galileo
    -

    Stop and destroy a container

    -
    $ docker stop backstabbing_galileo  # those docker guys are really rude to physicists!
-backstabbing_galileo
-
-# check the container is stopped
-$ docker ps
-CONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES
-
-# list ALL containers
-$ docker ps -a
-CONTAINER ID        IMAGE               COMMAND                CREATED             STATUS                      PORTS               NAMES
-d40b7af693d6        shaarli/shaarli     /usr/bin/supervisor   5 minutes ago       Exited (0) 48 seconds ago                       backstabbing_galileo
-
-# destroy the container
-$ docker rm backstabbing_galileo  # let's put an end to these barbarian practices
-backstabbing_galileo
-
-$ docker ps -a
-CONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES
    -

    Resources

    -

    Docker

    - -

    DockerHub

    - -

    Service management

    - - - diff --git a/doc/Docker.md b/doc/Docker.md deleted file mode 100644 index a7d2efb5..00000000 --- a/doc/Docker.md +++ /dev/null @@ -1,158 +0,0 @@ -#Docker -- [Docker usage](#docker-usage)[](.html) -- [Get and run a Shaarli image](#get-and-run-a-shaarli-image)[](.html) -- [Resources](#resources)[](.html) - -## Docker usage -### Basics -Install [Docker](https://www.docker.com/), by following the instructions relevant[](.html) -to your OS / distribution, and start the service. - -#### Search an image on [DockerHub](https://hub.docker.com/)[](.html) - -```bash -$ docker search debian - -NAME DESCRIPTION STARS OFFICIAL AUTOMATED -ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK][](.html) -debian Debian is a Linux distribution that's comp... 603 [OK][](.html) -google/debian 47 [OK][](.html) -``` - -#### Show available tags for a repository -```bash -$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool - -% Total % Received % Xferd Average Speed Time Time Time Current -Dload Upload Total Spent Left Speed -100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 -``` - -Sample output: -```json -[[](.html) - { - "layer": "85a02782", - "name": "stretch" - }, - { - "layer": "59abecbc", - "name": "testing" - }, - { - "layer": "bf0fd686", - "name": "unstable" - }, - { - "layer": "60c52dbe", - "name": "wheezy" - }, - { - "layer": "c5b806fe", - "name": "wheezy-backports" - } -] - -``` - -#### Pull an image from DockerHub -```bash -$ docker pull repository[:tag][](.html) - -$ docker pull debian:wheezy -wheezy: Pulling from debian -4c8cbfd2973e: Pull complete -60c52dbe9d91: Pull complete -Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe -Status: Downloaded newer image for debian:wheezy -``` - -## Get and run a Shaarli image -### DockerHub repository -The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/)[](.html) -repository. - -### Available image tags -- `latest`: master branch (tarball release) -- `stable`: stable branch (tarball release) -- `dev`: master branch (Git clone) - -All images rely on: -- [Debian 8 Jessie](https://hub.docker.com/_/debian/)[](.html) -- [PHP5-FPM](http://php-fpm.org/)[](.html) -- [Nginx](http://nginx.org/)[](.html) - -### Download from DockerHub -```bash -$ docker pull shaarli/shaarli -latest: Pulling from shaarli/shaarli -32716d9fcddb: Pull complete -84899d045435: Pull complete -4b6ad7444763: Pull complete -e0345ef7a3e0: Pull complete -5c1dd344094f: Pull complete -6422305a200b: Pull complete -7d63f861dbef: Pull complete -3eb97210645c: Pull complete -869319d746ff: Already exists -869319d746ff: Pulling fs layer -902b87aaaec9: Already exists -Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 -Status: Downloaded newer image for shaarli/shaarli:latest -``` - -### Create and start a new container from the image -```bash -# map the host's :8000 port to the container's :80 port -$ docker create -p 8000:80 shaarli/shaarli -d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 - -# launch the container in the background -$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 -d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 - -# list active containers -$ docker ps -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo -``` - -### Stop and destroy a container -```bash -$ docker stop backstabbing_galileo # those docker guys are really rude to physicists! -backstabbing_galileo - -# check the container is stopped -$ docker ps -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - -# list ALL containers -$ docker ps -a -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo - -# destroy the container -$ docker rm backstabbing_galileo # let's put an end to these barbarian practices -backstabbing_galileo - -$ docker ps -a -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -``` - -## Resources -### Docker -- [Interactive Docker training portal](https://www.katacoda.com/courses/docker/) on [Katakoda](https://www.katacoda.com/)[](.html) -- [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/)[](.html) -- [Dockerfile reference](https://docs.docker.com/reference/builder/)[](.html) -- [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/)[](.html) -- [Volumes](https://docs.docker.com/userguide/dockervolumes/)[](.html) - -### DockerHub -- [Repositories](https://docs.docker.com/userguide/dockerrepos/)[](.html) -- [Teams and organizations](https://docs.docker.com/docker-hub/orgs/)[](.html) -- [GitHub automated build](https://docs.docker.com/docker-hub/github/)[](.html) - -### Service management -- [Using supervisord](https://docs.docker.com/articles/using_supervisord/)[](.html) -- [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon)[](.html) -- [supervisord](http://supervisord.org/)[](.html) diff --git a/doc/Download-CSS-styles-from-an-OPML-list.html b/doc/Download-CSS-styles-from-an-OPML-list.html deleted file mode 100644 index 18cc5d9a..00000000 --- a/doc/Download-CSS-styles-from-an-OPML-list.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - Shaarli – Download CSS styles from an OPML list - - - - - - - -

    Download CSS styles from an OPML list

    -

    Download CSS styles for shaarlis listed in an opml file

    -

    Example php script:

    -
    <!---- ?php -->
-<!---- Copyright (c) 2014 Nicolas Delsaux (https://github.com/Riduidel) -->
-<!---- License: zlib (http://www.gzip.org/zlib/zlib_license.html) -->
-
-/**
- * Source: https://github.com/Riduidel
- * Download css styles for shaarlis listed in an opml file
- */
-define("SHAARLI_RSS_OPML", "https://www.ecirtam.net/shaarlirss/custom/people.opml");
-
-define("THEMES_TEMP_FOLDER", "new_themes");
-
-if(!file_exists(THEMES_TEMP_FOLDER)) {
-    mkdir(THEMES_TEMP_FOLDER);
-}
-
-function siteUrl($pathInSite) {
-    $indexPos = strpos($pathInSite, "index.php");
-    if(!$indexPos) {
-        return $pathInSite;
-    } else {
-        return substr($pathInSite, 0, $indexPos);
-    }
-}
-
-function createShaarliHashFromOPMLL($opmlFile) {
-    $result = array();
-    $opml = file_get_contents($opmlFile);
-    $opmlXml = simplexml_load_string($opml);
-    $outlineElements = $opmlXml->xpath("body/outline");
-    foreach($outlineElements as $site) {
-        $siteUrl = siteUrl((string) $site['htmlUrl']);[](.html)
-        $result[$siteUrl]=((string) $site['text']);[](.html)
-    }
-    return $result;
-}
-
-function getSiteFolder($url) {
-    $domain = parse_url($url,  PHP_URL_HOST);
-    return THEMES_TEMP_FOLDER."/".str_replace(".", "_", $domain);
-}
-
-function get_http_response_code($theURL) {
-     $headers = get_headers($theURL);
-     return substr($headers[0], 9, 3);[](.html)
-}
-
-/**
- * This makes the code PHP-5 only (particularly the call to "get_headers")
- */
-function copyUserStyleFrom($url, $name, $knownStyles) {
-    $userStyle = $url."inc/user.css";
-    if(in_array($url, $knownStyles)) {
-        // TODO add log message
-    } else {
-        $statusCode = get_http_response_code($userStyle);
-        if(intval($statusCode)<300) {
-            $styleSheet = file_get_contents($userStyle);
-            $siteFolder = getSiteFolder($url);
-            if(!file_exists($siteFolder)) {
-                mkdir($siteFolder);
-            }
-            if(!file_exists($siteFolder.'/user.css')) {
-                // Copy stylesheet
-                file_put_contents($siteFolder.'/user.css', $styleSheet);
-            }
-            if(!file_exists($siteFolder.'/README.md')) {
-                // Then write a readme.md file
-                file_put_contents($siteFolder.'/README.md', 
-                    "User style from ".$name."\n"
-                    ."============================="
-                    ."\n\n"
-                    ."This stylesheet was downloaded from ".$userStyle." on ".date(DATE_RFC822)
-                    );
-            }
-            if(!file_exists($siteFolder.'/config.ini')) {
-                // Write a config file containing useful informations
-                file_put_contents($siteFolder.'/config.ini', 
-                    "site_url=".$url."\n"
-                    ."site_name=".$name."\n"
-                    );
-            }
-            if(!file_exists($siteFolder.'/home.png')) {
-                // And finally copy generated thumbnail
-                $homeThumb = $siteFolder.'/home.png';
-                file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url)));
-            }
-            echo 'Theme have been downloaded from  <a href="'.$url.'">'.$url.'</a> into '.$siteFolder
-                .'. It looks like <img src="'.$homeThumb.'"><br/>';
-        }
-    }
-}
-
-function getThumbnailUrl($url) {
-    return 'http://api.webthumbnail.org/?url='.$url;
-}
-
-function copyUserStylesFrom($urlToNames, $knownStyles) {
-    foreach($urlToNames as $url => $name) {
-        copyUserStyleFrom($url, $name, $knownStyles);
-    }
-}
-
-/**
- * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/
- * @param directory the directory we want to list files of
- * @return a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..")
- * are not listed here
- */
-function getDirectoryList ($directory)  {
-    $realPath = realpath($directory);
-    // create an array to hold directory list
-    $results = array();
-    // create a handler for the directory
-    $handler = opendir($directory);
-    // open directory and walk through the filenames
-    while ($file = readdir($handler)) {
-        // if file isn't this directory or its parent, add it to the results
-        if ($file != "." && $file != "..") {
-            $results[ = realpath($realPath . "/" . $file);](-=-realpath($realPath-.-"/"-.-$file);.html)
-        }
-    }
-    // tidy up: close the handler
-    closedir($handler);
-    // done!
-    return $results;
-}
-
-/**
- * Start in themes folder and look in all subfolders for config.ini files. 
- * These config.ini files allow us not to download styles again and again
- */
-function findKnownStyles() {
-    $result = array();
-    $subFolders = getDirectoryList("themes");
-    foreach($subFolders as $folder) {
-        $configFile = $folder."/config.ini";
-        if(file_exists($configFile)) {
-            $iniParameters = parse_ini_file($configFile);
-            array_push($result, $iniParameters['site_url']);[](.html)
-        }
-    }
-    return $result;
-}
-
-$knownStyles = findKnownStyles();
-copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles);
-
-<!--- ? ---->
    - - diff --git a/doc/Download-CSS-styles-from-an-OPML-list.md b/doc/Download-CSS-styles-from-an-OPML-list.md deleted file mode 100644 index eb66f955..00000000 --- a/doc/Download-CSS-styles-from-an-OPML-list.md +++ /dev/null @@ -1,155 +0,0 @@ -#Download CSS styles from an OPML list -###Download CSS styles for shaarlis listed in an opml file -Example php script: - -```php - - - - -/** - * Source: https://github.com/Riduidel - * Download css styles for shaarlis listed in an opml file - */ -define("SHAARLI_RSS_OPML", "https://www.ecirtam.net/shaarlirss/custom/people.opml"); - -define("THEMES_TEMP_FOLDER", "new_themes"); - -if(!file_exists(THEMES_TEMP_FOLDER)) { - mkdir(THEMES_TEMP_FOLDER); -} - -function siteUrl($pathInSite) { - $indexPos = strpos($pathInSite, "index.php"); - if(!$indexPos) { - return $pathInSite; - } else { - return substr($pathInSite, 0, $indexPos); - } -} - -function createShaarliHashFromOPMLL($opmlFile) { - $result = array(); - $opml = file_get_contents($opmlFile); - $opmlXml = simplexml_load_string($opml); - $outlineElements = $opmlXml->xpath("body/outline"); - foreach($outlineElements as $site) { - $siteUrl = siteUrl((string) $site['htmlUrl']);[](.html) - $result[$siteUrl]=((string) $site['text']);[](.html) - } - return $result; -} - -function getSiteFolder($url) { - $domain = parse_url($url, PHP_URL_HOST); - return THEMES_TEMP_FOLDER."/".str_replace(".", "_", $domain); -} - -function get_http_response_code($theURL) { - $headers = get_headers($theURL); - return substr($headers[0], 9, 3);[](.html) -} - -/** - * This makes the code PHP-5 only (particularly the call to "get_headers") - */ -function copyUserStyleFrom($url, $name, $knownStyles) { - $userStyle = $url."inc/user.css"; - if(in_array($url, $knownStyles)) { - // TODO add log message - } else { - $statusCode = get_http_response_code($userStyle); - if(intval($statusCode)<300) { - $styleSheet = file_get_contents($userStyle); - $siteFolder = getSiteFolder($url); - if(!file_exists($siteFolder)) { - mkdir($siteFolder); - } - if(!file_exists($siteFolder.'/user.css')) { - // Copy stylesheet - file_put_contents($siteFolder.'/user.css', $styleSheet); - } - if(!file_exists($siteFolder.'/README.md')) { - // Then write a readme.md file - file_put_contents($siteFolder.'/README.md', - "User style from ".$name."\n" - ."=============================" - ."\n\n" - ."This stylesheet was downloaded from ".$userStyle." on ".date(DATE_RFC822) - ); - } - if(!file_exists($siteFolder.'/config.ini')) { - // Write a config file containing useful informations - file_put_contents($siteFolder.'/config.ini', - "site_url=".$url."\n" - ."site_name=".$name."\n" - ); - } - if(!file_exists($siteFolder.'/home.png')) { - // And finally copy generated thumbnail - $homeThumb = $siteFolder.'/home.png'; - file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url))); - } - echo 'Theme have been downloaded from '.$url.' into '.$siteFolder - .'. It looks like
    '; - } - } -} - -function getThumbnailUrl($url) { - return 'http://api.webthumbnail.org/?url='.$url; -} - -function copyUserStylesFrom($urlToNames, $knownStyles) { - foreach($urlToNames as $url => $name) { - copyUserStyleFrom($url, $name, $knownStyles); - } -} - -/** - * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/ - * @param directory the directory we want to list files of - * @return a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..") - * are not listed here - */ -function getDirectoryList ($directory) { - $realPath = realpath($directory); - // create an array to hold directory list - $results = array(); - // create a handler for the directory - $handler = opendir($directory); - // open directory and walk through the filenames - while ($file = readdir($handler)) { - // if file isn't this directory or its parent, add it to the results - if ($file != "." && $file != "..") { - $results[ = realpath($realPath . "/" . $file);](-=-realpath($realPath-.-"/"-.-$file);.html) - } - } - // tidy up: close the handler - closedir($handler); - // done! - return $results; -} - -/** - * Start in themes folder and look in all subfolders for config.ini files. - * These config.ini files allow us not to download styles again and again - */ -function findKnownStyles() { - $result = array(); - $subFolders = getDirectoryList("themes"); - foreach($subFolders as $folder) { - $configFile = $folder."/config.ini"; - if(file_exists($configFile)) { - $iniParameters = parse_ini_file($configFile); - array_push($result, $iniParameters['site_url']);[](.html) - } - } - return $result; -} - -$knownStyles = findKnownStyles(); -copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); - - -``` diff --git a/doc/Download-and-Installation.html b/doc/Download-and-Installation.html deleted file mode 100644 index 2c5b3be2..00000000 --- a/doc/Download-and-Installation.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - Shaarli – Download and Installation - - - - - - - -

    Download and Installation

    -

    Get Shaarli!

    -

    To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your server is properly configured.

    -

    Several releases are available:

    -
    - -

    Download as an archive

    -

    Get the latest released version from the releases page.

    -

    Download our shaarli-full archive to include dependencies.

    -

    The current latest released version is v0.8.4

    -

    Or in command lines:

    -
    $ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
-$ unzip shaarli-v0.8.4-full.zip
-$ mv Shaarli /path/to/shaarli/
    - ---- - - - - - - - - -
    !In most cases, download Shaarli from the releases page. Cloning using git or downloading Github branches as zip files requires additional steps (see below).
    -

    Using git

    -
    mkdir -p /path/to/shaarli && cd /path/to/shaarli/
-git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
-composer install --no-dev
    -
    -

    Stable version

    -

    The stable version has been experienced by Shaarli users, and will receive security updates.

    -

    Download as an archive

    -

    As a .zip archive:

    -
    $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
-$ unzip stable.zip
-$ mv Shaarli-stable /path/to/shaarli/
    -

    As a .tar.gz archive :

    -
    $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
-$ tar xvf stable.tar.gz
-$ mv Shaarli-stable /path/to/shaarli/
    -

    Clone with Git

    -

    Composer is required to build a functional Shaarli installation when pulling from git.

    -
    $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
-# install/update third-party dependencies
-$ cd /path/to/shaarli/
-$ composer install --no-dev
    -
    -

    Development version (mainline)

    -

    Use at your own risk!

    -

    To get the latest changes from the master branch:

    -
    # clone the repository  
-$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
-# install/update third-party dependencies
-$ cd /path/to/shaarli
-$ composer install --no-dev
    -
    -

    Finish Installation

    -

    Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.

    -

    install screenshot

    -

    Setup your Shaarli installation, and it's ready to use!

    -
    -

    Updating Shaarli

    -

    See Upgrade and Migration

    - - diff --git a/doc/Example-patch---add-new-via-field-for-links.html b/doc/Example-patch---add-new-via-field-for-links.html deleted file mode 100644 index 49036a74..00000000 --- a/doc/Example-patch---add-new-via-field-for-links.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - - Shaarli – Example patch add new via field for links - - - - - - -

    Example patch add new via field for links

    -

    Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. Untested, use at your own risk

    -

    Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158

    -
    From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001
-From: Knah Tsaeb <knah-tsaeb@knah-tsaeb.org>
-Date: Fri, 11 Oct 2013 15:18:37 +0200
-Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog[](.html)
-Thanks to:
-* https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4
-* https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813
-* https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96
-
----
- index.php         | 43 ++++++++++++++++++++++++++++++++-----------
- tpl/editlink.html |  1 +
- tpl/linklist.html |  1 +
- 3 files changed, 34 insertions(+), 11 deletions(-)
-
-diff --git a/index.php b/index.php
-index 6fae2f8..53f798e 100644
---- a/index.php
-+++ b/index.php
-@@ -436,6 +436,12 @@ if (isset($_POST['login']))[](.html)
- // ------------------------------------------------------------------------------------------
- // Misc utility functions:
- 
-+// Try to get just domain for @via
-+function getJustDomain($url){
-+    $parts = parse_url($url);   
-+    return trim($parts['host']);[](.html)
-+    }
-+
- // Returns the server URL (including port and http/https), without path.
- // e.g. "http://myserver.com:8080"
- // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL.[](.html)
-@@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess
-             $found=   (strpos(strtolower($l['title']),$s)!==false)[](.html)
-                    || (strpos(strtolower($l['description']),$s)!==false)[](.html)
-                    || (strpos(strtolower($l['url']),$s)!==false)[](.html)
--                   || (strpos(strtolower($l['tags']),$s)!==false);[](.html)
-+                   || (strpos(strtolower($l['tags']),$s)!==false)[](.html)
-+                   || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false));[](.html)
-             if ($found) $filtered[$l['linkdate'[ = $l;](-=-$l;.html)
-         }
-         krsort($filtered);
-@@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess
-         $t = str_replace(',',' ',($casesensitive?$tags:strtolower($tags)));
-         $searchtags=explode(' ',$t);
-         $filtered=array();
--        foreach($this->links as $l)
-+        foreach($this-> links as $l)
-         {
-             $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags'])));[](.html)
-             if (count(array_intersect($linktags,$searchtags)) == count($searchtags))
-@@ -905,7 +912,7 @@ function showRSS()
-     else $linksToDisplay = $LINKSDB;
-     $nblinksToDisplay = 50;  // Number of links to display.
-     if (!empty($_GET['nb']))  // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html)
--    { 
-+    {
-         $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html)
-     }
- 
-@@ -944,7 +951,12 @@ function showRSS()
-         // If user wants permalinks first, put the final link in description
-         if ($usepermalinks===true) $descriptionlink = '(<a href="'.$absurl.'">Link</a>)';
-         if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink;[](.html)
--        echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html)
-+        if(!empty($link['via'])){[](.html)
-+          $via = '<br>Origine => <a href="'.htmlspecialchars($link['via']).'">'.htmlspecialchars(getJustDomain($link['via'])).'</a>';[](.html)
-+        } else {
-+         $via = '';
-+        }
-+        echo '<description><![CDATA['.nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description'])))).$via.$descriptionlink.'[></description>'."\n</item>\n";](></description>'."\n</item>\n";.html)
-         $i++;
-     }
-     echo '</channel></rss><!-- Cached version of '.htmlspecialchars(pageUrl()).' -->';
-@@ -980,7 +992,7 @@ function showATOM()
-     else $linksToDisplay = $LINKSDB;
-     $nblinksToDisplay = 50;  // Number of links to display.
-     if (!empty($_GET['nb']))  // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html)
--    { 
-+    {
-         $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html)
-     }
- 
-@@ -1006,11 +1018,16 @@ function showATOM()
- 
-         // Add permalink in description
-         $descriptionlink = htmlspecialchars('(<a href="'.$guid.'">Permalink</a>)');
-+        if(isset($link['via']) && !empty($link['via'])){[](.html)
-+          $via = htmlspecialchars('</br> Origine => <a href="'.$link['via'].'">'.getJustDomain($link['via']).'</a>');[](.html)
-+        } else {
-+          $via = '';
-+        }
-         // If user wants permalinks first, put the final link in description
-         if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(<a href="'.$absurl.'">Link</a>)');
-         if (strlen($link['description'])>0) $descriptionlink = '&lt;br&gt;'.$descriptionlink;[](.html)
- 
--        $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."</content>\n";[](.html)
-+        $entries.='<content type="html">'.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."</content>\n";[](.html)
-         if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html)
-         {
-             foreach(explode(' ',$link['tags']) as $tag)[](.html)
-@@ -1478,7 +1495,7 @@ function renderPage()
-         if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?'))
-             $url = 'http://'.$url;
-         $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0),[](.html)
--                      'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags));
-+                      'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via']));[](.html)
-         if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title.[](.html)
-         $LINKSDB[$linkdate] = $link;[](.html)
-         $LINKSDB->savedb(); // Save to disk.
-@@ -1556,7 +1573,8 @@ function renderPage()
-             $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet).[](.html)
-             $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that][](.html)
-             $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL[](.html)
--            $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL [](.html)
-+            $via = (empty($_GET['via']) ? '' : $_GET['via'] );[](.html)
-+            $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL[](.html)
-             if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url;
-             // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.)
-             if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http')
-@@ -1567,7 +1585,7 @@ function renderPage()
-                     {
-                         // Look for charset in html header.
-                        preg_match('#<meta .*charset=.*>#Usi', $data, $meta);
-- 
-+
-                        // If found, extract encoding.
-                        if (!empty($meta[0]))[](.html)
-                        {
-@@ -1577,7 +1595,7 @@ function renderPage()
-                            $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8';[](.html)
-                        }
-                        else { $html_charset = 'utf-8'; }
-- 
-+
-                        // Extract title
-                        $title = html_extract_title($data);
-                        if (!empty($title))
-@@ -1592,7 +1610,7 @@ function renderPage()
-                 $url='?'.smallHash($linkdate);
-                 $title='Note: ';
-             }
--            $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'private'=>$private);
-+            $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'via' => $via,'private'=>$private);
-         }
- 
-         $PAGE = new pageBuilder;
-@@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB)
-         $taglist = explode(' ',$link['tags']);[](.html)
-         uasort($taglist, 'strcasecmp');
-         $link['taglist']=$taglist;[](.html)
-+        if(!empty($link['via'])){[](.html)
-+          $link['via']=htmlspecialchars($link['via']);[](.html)
-+        }
-         $linkDisp[$keys[$i[ = $link;](-=-$link;.html)
-         $i++;
-     }
-diff --git a/tpl/editlink.html b/tpl/editlink.html
-index 4a2c30c..14d4f9c 100644
---- a/tpl/editlink.html
-+++ b/tpl/editlink.html
-@@ -16,6 +16,7 @@
-            <i>Title</i><br><input type="text" name="lf_title" value="{$link.title|htmlspecialchars}" style="width:100%"><br>
-            <i>Description</i><br><textarea name="lf_description" rows="4" cols="25" style="width:100%">{$link.description|htmlspecialchars}</textarea><br>
-            <i>Tags</i><br><input type="text" id="lf_tags" name="lf_tags" value="{$link.tags|htmlspecialchars}" style="width:100%"><br>
-+           <i>Origine</i><br><input type="text" name="lf_via" value="{$link.via|htmlspecialchars}" style="width:100%"><br>
-            {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"}[](.html)
-             <input type="checkbox" checked="checked" name="lf_private" id="lf_private">
-             &nbsp;<label for="lf_private"><i>Private</i></label><br>
-diff --git a/tpl/linklist.html b/tpl/linklist.html
-index ddc38cb..0a8475f 100644
---- a/tpl/linklist.html
-+++ b/tpl/linklist.html
-@@ -43,6 +43,7 @@
-                 <span class="linktitle"><a href="{$redirector}{$value.url|htmlspecialchars}">{$value.title|htmlspecialchars}</a></span>
-                 <br>
-                 {if="$value.description"}<div class="linkdescription"{if condition="$search_type=='permalink'"} style="max-height:none !important;"{/if}>{$value.description}</div>{/if}
-+                {if condition="isset($value.via) && !empty($value.via)"}<div><a href="{$value.via}">Origine => {$value.via|getJustDomain}</a></div>{/if}
-                 {if="!$GLOBALS['config'['HIDE_TIMESTAMPS'] || isLoggedIn()"}]('HIDE_TIMESTAMPS']-||-isLoggedIn()"}.html)
-                     <span class="linkdate" title="Permalink"><a href="?{$value.linkdate|smallHash}">{$value.localdate|htmlspecialchars} - permalink</a> - </span>
-                 {else}
--- 
-2.1.1
    - - diff --git a/doc/Example-patch---add-new-via-field-for-links.md b/doc/Example-patch---add-new-via-field-for-links.md deleted file mode 100644 index 883adf40..00000000 --- a/doc/Example-patch---add-new-via-field-for-links.md +++ /dev/null @@ -1,190 +0,0 @@ -#Example patch add new via field for links -Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. **Untested, use at your own risk** - -Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 - -``` -From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 -From: Knah Tsaeb -Date: Fri, 11 Oct 2013 15:18:37 +0200 -Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog[](.html) -Thanks to: -* https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 -* https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 -* https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96 - ---- - index.php | 43 ++++++++++++++++++++++++++++++++----------- - tpl/editlink.html | 1 + - tpl/linklist.html | 1 + - 3 files changed, 34 insertions(+), 11 deletions(-) - -diff --git a/index.php b/index.php -index 6fae2f8..53f798e 100644 ---- a/index.php -+++ b/index.php -@@ -436,6 +436,12 @@ if (isset($_POST['login']))[](.html) - // ------------------------------------------------------------------------------------------ - // Misc utility functions: - -+// Try to get just domain for @via -+function getJustDomain($url){ -+ $parts = parse_url($url); -+ return trim($parts['host']);[](.html) -+ } -+ - // Returns the server URL (including port and http/https), without path. - // e.g. "http://myserver.com:8080" - // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL.[](.html) -@@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess - $found= (strpos(strtolower($l['title']),$s)!==false)[](.html) - || (strpos(strtolower($l['description']),$s)!==false)[](.html) - || (strpos(strtolower($l['url']),$s)!==false)[](.html) -- || (strpos(strtolower($l['tags']),$s)!==false);[](.html) -+ || (strpos(strtolower($l['tags']),$s)!==false)[](.html) -+ || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false));[](.html) - if ($found) $filtered[$l['linkdate'[ = $l;](-=-$l;.html) - } - krsort($filtered); -@@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess - $t = str_replace(',',' ',($casesensitive?$tags:strtolower($tags))); - $searchtags=explode(' ',$t); - $filtered=array(); -- foreach($this->links as $l) -+ foreach($this-> links as $l) - { - $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags'])));[](.html) - if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) -@@ -905,7 +912,7 @@ function showRSS() - else $linksToDisplay = $LINKSDB; - $nblinksToDisplay = 50; // Number of links to display. - if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) -- { -+ { - $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) - } - -@@ -944,7 +951,12 @@ function showRSS() - // If user wants permalinks first, put the final link in description - if ($usepermalinks===true) $descriptionlink = '(Link)'; - if (strlen($link['description'])>0) $descriptionlink = '
    '.$descriptionlink;[](.html) -- echo ''."\n\n";](>'."\n\n";.html) -+ if(!empty($link['via'])){[](.html) -+ $via = '
    Origine => '.htmlspecialchars(getJustDomain($link['via'])).'';[](.html) -+ } else { -+ $via = ''; -+ } -+ echo ''."\n\n";](>'."\n\n";.html) - $i++; - } - echo ''; -@@ -980,7 +992,7 @@ function showATOM() - else $linksToDisplay = $LINKSDB; - $nblinksToDisplay = 50; // Number of links to display. - if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links.[](.html) -- { -+ { - $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ;[](.html) - } - -@@ -1006,11 +1018,16 @@ function showATOM() - - // Add permalink in description - $descriptionlink = htmlspecialchars('(Permalink)'); -+ if(isset($link['via']) && !empty($link['via'])){[](.html) -+ $via = htmlspecialchars('
    Origine => '.getJustDomain($link['via']).'');[](.html) -+ } else { -+ $via = ''; -+ } - // If user wants permalinks first, put the final link in description - if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(Link)'); - if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink;[](.html) - -- $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."\n";[](.html) -+ $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."\n";[](.html) - if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification)[](.html) - { - foreach(explode(' ',$link['tags']) as $tag)[](.html) -@@ -1478,7 +1495,7 @@ function renderPage() - if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) - $url = 'http://'.$url; - $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0),[](.html) -- 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); -+ 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via']));[](.html) - if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title.[](.html) - $LINKSDB[$linkdate] = $link;[](.html) - $LINKSDB->savedb(); // Save to disk. -@@ -1556,7 +1573,8 @@ function renderPage() - $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet).[](.html) - $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that][](.html) - $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL[](.html) -- $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL [](.html) -+ $via = (empty($_GET['via']) ? '' : $_GET['via'] );[](.html) -+ $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL[](.html) - if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; - // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) - if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') -@@ -1567,7 +1585,7 @@ function renderPage() - { - // Look for charset in html header. - preg_match('##Usi', $data, $meta); -- -+ - // If found, extract encoding. - if (!empty($meta[0]))[](.html) - { -@@ -1577,7 +1595,7 @@ function renderPage() - $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8';[](.html) - } - else { $html_charset = 'utf-8'; } -- -+ - // Extract title - $title = html_extract_title($data); - if (!empty($title)) -@@ -1592,7 +1610,7 @@ function renderPage() - $url='?'.smallHash($linkdate); - $title='Note: '; - } -- $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'private'=>$private); -+ $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'via' => $via,'private'=>$private); - } - - $PAGE = new pageBuilder; -@@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) - $taglist = explode(' ',$link['tags']);[](.html) - uasort($taglist, 'strcasecmp'); - $link['taglist']=$taglist;[](.html) -+ if(!empty($link['via'])){[](.html) -+ $link['via']=htmlspecialchars($link['via']);[](.html) -+ } - $linkDisp[$keys[$i[ = $link;](-=-$link;.html) - $i++; - } -diff --git a/tpl/editlink.html b/tpl/editlink.html -index 4a2c30c..14d4f9c 100644 ---- a/tpl/editlink.html -+++ b/tpl/editlink.html -@@ -16,6 +16,7 @@ - Title

    - Description

    - Tags

    -+ Origine

    - {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"}[](.html) - -  
    -diff --git a/tpl/linklist.html b/tpl/linklist.html -index ddc38cb..0a8475f 100644 ---- a/tpl/linklist.html -+++ b/tpl/linklist.html -@@ -43,6 +43,7 @@ - {$value.title|htmlspecialchars} -
    - {if="$value.description"}
    {$value.description}
    {/if} -+ {if condition="isset($value.via) && !empty($value.via)"}{/if} - {if="!$GLOBALS['config'['HIDE_TIMESTAMPS'] || isLoggedIn()"}]('HIDE_TIMESTAMPS']-||-isLoggedIn()"}.html) - {$value.localdate|htmlspecialchars} - permalink - - {else} --- -2.1.1 -``` diff --git a/doc/FAQ.html b/doc/FAQ.html deleted file mode 100644 index 25584f22..00000000 --- a/doc/FAQ.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - Shaarli – FAQ - - - - - - -

    FAQ

    -

    Why did you create Shaarli ?

    -

    I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… their Firefox addon sends to Diigo every single URL you visit (Don't believe me ? Use Tamper Data and open any page).

    -

    Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.

    -

    Why use Shaarli and not Delicious/Diigo ?

    -

    With Shaarli:

    -
      -
    • The data is yours: It's hosted on your server.
      • -
    • Never fear of having your data locked-in.
      • -
    • Never fear to have your data sold to third party.
      • -
    • Your private links are not hosted on a third party server.
      • -
    • You are not tracked by browser addons (like Diigo does)
      • -
    • You can change the look and feel of the pages if you want.
      • -
    • You can change the behaviour of the program.
      • -
    • It's magnitude faster than most bookmarking services.
      • -
    -

    What does Shaarli mean?

    -

    Shaarli is for shaaring your links.

    -

    My Shaarli is broken!

    -

    First of all, ensure that both the web server and Shaarli are correctly configured, and that your installation is supported.

    -

    If everything looks right but the issue(s) remain(s), please:

    -
      -
    • take a look at the troubleshooting section
      • -
    • come chat with us on Gitter, we'll be happy to help ;-)
      • -
    • browse active issues and Pull Requests -
        -
      • if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)
        • -
      • else, open a new issue, and provide information about the problem: -
          -
        • what happens? - display glitches, invalid data, security flaws...
          • -
        • what is your configuration? - OS, server version, activated extensions, web browser...
          • -
        • is it reproducible?
          • -
        • -
      • -
    -

    Why not use a real database? Files are slow!

    -

    Does browsing this page feel slow? Try browsing older pages, too.

    -

    It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?

    -

    The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.

    - - diff --git a/doc/Firefox-share.html b/doc/Firefox-share.html deleted file mode 100644 index 707119a6..00000000 --- a/doc/Firefox-share.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - Shaarli – Firefox share - - - - - - -

    Firefox share

    -

    Add Shaarli as a sharing service to Firefox

    -
      -
    • Open your Shaarli and Login
      • -
    • Click the Tools button in the top bar
      • -
    • Click the ✚Add to Firefox social button and accept the activation.
      • -
    - -
      -
    • Add the sharing service as described above
      • -
    • When you are visiting a webpage you would like to share with Shaarli, click the Firefox Share button images/firefoxshare.png
      • -
    • You can edit your link before and after saving, just like the bookmarklet above.
      • -
    - ---- - - - - - - - - -
    Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections.
    - - diff --git a/doc/Firefox-share.md b/doc/Firefox-share.md deleted file mode 100644 index 58adc58f..00000000 --- a/doc/Firefox-share.md +++ /dev/null @@ -1,16 +0,0 @@ -#Firefox share -### Add Shaarli as a sharing service to Firefox - - * Open your Shaarli and `Login` - * Click the `Tools` button in the top bar - * Click the `✚Add to Firefox social` button and accept the activation. - - -### Sharing links using Firefox share - - * Add the sharing service as described above - * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png.html) - * You can edit your link before and after saving, just like the bookmarklet above. - -|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | -|------|-------------------------------------------------------------------------------| diff --git a/doc/GnuPG-signature.html b/doc/GnuPG-signature.html deleted file mode 100644 index 182a71d4..00000000 --- a/doc/GnuPG-signature.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - Shaarli – GnuPG signature - - - - - - - -

    GnuPG signature

    -

    Introduction

    -

    PGP and GPG

    -

    Gnu Privacy Guard (GnuPG) is an Open Source implementation of the Pretty Good [](.html)
    -Privacy     (OpenPGP) specification. Its main purposes are digital authentication,
    -signature and encryption.

    -

    It is often used by the FLOSS community to verify:

    - -

    Trust

    -

    To quote Phil Pennock (the author of the SKS key server - http://sks.spodhuis.org/):

    -
    -

    You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated.

    -
    -

    Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during key signing parties, see:

    - -

    Generate a GPG key

    - -

    gpg - provide identity information

    -
    $ gpg --gen-key
-
-gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
-
-Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog.
-
-GnuPG needs to construct a user ID to identify your key.
-
-Real name: Marvin the Paranoid Android
-Email address: marvin@h2g2.net
-You selected this USER-ID:
-    "Marvin the Paranoid Android <marvin@h2g2.net>"
-
-Change (N)ame, (E)mail, or (O)kay/(Q)uit? o
-We need to generate a lot of random bytes. It is a good idea to perform
-some other action (type on the keyboard, move the mouse, utilize the
-disks) during the prime generation; this gives the random number
-generator a better chance to gain enough entropy.
    -

    gpg - entropy interlude

    -

    At this point, you will:

    -
      -
    • be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)
      • -
    • be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step may take some time
      • -
    -

    gpg - key creation confirmation

    -
    gpg: key A9D53A3E marked as ultimately trusted
-public and secret key created and signed.
-
-gpg: checking the trustdb
-gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
-gpg: depth: 0  valid:   2  signed:   0  trust: 0-, 0q, 0n, 0m, 0f, 2u
-pub   rsa2048/A9D53A3E 2015-07-31
-      Key fingerprint = AF2A 5381 E54B 2FD2 14C4  A9A3 0E35 ACA4 A9D5 3A3E
-uid       [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>[](.html)
-sub   rsa2048/8C0EACF1 2015-07-31
    -

    gpg - submit your public key to a PGP server (Optional)

    -
    $ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E
-gpg: sending key A9D53A3E to hkp server pgp.mit.edu
    -

    Create and push a GPG-signed tag

    -

    See Release Shaarli.

    - - diff --git a/doc/Home.html b/doc/Home.html deleted file mode 100644 index 7f51b93b..00000000 --- a/doc/Home.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - Shaarli – Home - - - - - - -

    Home

    -

    Shaarli wiki

    -

    Welcome to the Shaarli wiki

    -

    Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.

    -

    For general info, read the README.

    -

    If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion (archive) or read the current issues. If you've found a bug, please create a new issue.

    -

    If you would like a feature added to Shaarli, check the issues labeled feature, enhancement, and plugin.

    -

    Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/ directory of your Shaarli installation.

    - - diff --git a/doc/Home.md b/doc/Home.md deleted file mode 100644 index 38413f24..00000000 --- a/doc/Home.md +++ /dev/null @@ -1,14 +0,0 @@ -#Home -# Shaarli wiki - -Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki![](.html) - -Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. - -For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).[](.html) - -If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) - -If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).[](.html) - -_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ diff --git a/doc/Plugin-System.html b/doc/Plugin-System.html deleted file mode 100644 index 123bf106..00000000 --- a/doc/Plugin-System.html +++ /dev/null @@ -1,634 +0,0 @@ - - - - - - - Shaarli – Plugin System - - - - - - - -

    Plugin System

    -

    I am a developer. Developer API.

    -

    I am a template designer. Guide for template designer.

    -

    Developer API

    -

    What can I do with plugins?

    -

    The plugin system let you:

    -
      -
    • insert content into specific places across templates.
      • -
    • alter data before templates rendering.
      • -
    • alter data before saving new links.
      • -
    -

    How can I create a plugin for Shaarli?

    -

    First, chose a plugin name, such as demo_plugin.

    -

    Under plugin folder, create a folder named with your plugin name. Then create a .php file in that folder.

    -

    You should have the following tree view:

    -
    | index.php
-| plugins/
-|---| demo_plugin/
-|   |---| demo_plugin.php
    -

    Plugin initialization

    -

    At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an init() function to execute and run it if it exists. This function must be named this way, and takes the ConfigManager as parameter.

    -
    <plugin_name>_init($conf)
    -

    This function can be used to create initial data, load default settings, etc. But also to set plugin errors. If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users.

    -

    Understanding hooks

    -

    A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution.

    -

    These functions need to be named with this pattern:

    -
    hook_<plugin_name>_<hook_name>($data, $conf)
    -

    Parameters:

    - -

    For exemple, if my plugin want to add data to the header, this function is needed:

    -
    hook_demo_plugin_render_header
    -

    If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header.

    -

    Plugin's data

    -

    Parameters

    -

    Every hook function has a $data parameter. Its content differs for each hooks.

    -

    This parameter needs to be returned every time, otherwise data is lost.

    -
    return $data;
    -

    Filling templates placeholder

    -

    Template placeholders are displayed in template in specific places.

    -

    RainTPL displays every element contained in the placeholder's array. These element can be added by plugins.

    -

    For example, let's add a value in the placeholder top_placeholder which is displayed at the top of my page:

    -
    $data['top_placeholder'[] = 'My content';](]-=-'My-content';.html)
-# OR
-array_push($data['top_placeholder'], 'My', 'content');[](.html)
-
-return $data;
    -

    Data manipulation

    -

    When a page is displayed, every variable send to the template engine is passed to plugins before that in $data.

    -

    The data contained by this array can be altered before template rendering.

    -

    For exemple, in linklist, it is possible to alter every title:

    -
    // mind the reference if you want $data to be altered
-foreach ($data['links'] as &$value) {[](.html)
-    // String reverse every title.
-    $value['title'] = strrev($value['title']);[](.html)
-}
-
-return $data;
    -

    Metadata

    -

    Every plugin needs a <plugin_name>.meta file, which is in fact an .ini file (KEY="VALUE"), to be listed in plugin administration.

    -

    Each file contain two keys:

    -
      -
    • description: plugin description
      • -
    • parameters: user parameter names, separated by a ;.
      • -
    • parameter.<PARAMETER_NAME>: add a text description the specified parameter.
      • -
    -
    -

    Note: In PHP, parse_ini_file() seems to want strings to be between by quotes " in the ini file.

    -
    -

    It's not working!

    -

    Use demo_plugin as a functional example. It covers most of the plugin system features.

    -

    If it's still not working, please open an issue.

    -

    Hooks

    - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HooksDescription
    render_headerAllow plugin to add content in page headers.
    render_includesAllow plugin to include their own CSS files.
    render_footerAllow plugin to add content in page footer and include their own JS files.
    render_linklistIt allows to add content at the begining and end of the page, after every link displayed and to alter link data.
    render_editlinkAllow to add fields in the form, or display elements.
    render_toolsAllow to add content at the end of the page.
    render_picwallAllow to add content at the top and bottom of the page.
    render_tagcloudAllow to add content at the top and bottom of the page, and after all tags.
    render_taglistAllow to add content at the top and bottom of the page, and after all tags.
    render_dailyAllow to add content at the top and bottom of the page, the bottom of each link and to alter data.
    render_feedAllow to do add tags in RSS and ATOM feeds.
    save_linkAllow to alter the link being saved in the datastore.
    delete_linkAllow to do an action before a link is deleted from the datastore.
    -

    render_header

    -

    Triggered on every page.

    -

    Allow plugin to add content in page headers.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _PAGE_: current target page (eg: linklist, picwall, etc.).
      • -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • buttons_toolbar: after the list of buttons in the header.
      • -
    -

    buttons_toolbar_example

    -
      -
    • fields_toolbar: after search fields in the header.
      • -
    -
    -

    Note: This will only be called in linklist.

    -
    -

    fields_toolbar_example

    -

    render_includes

    -

    Triggered on every page.

    -

    Allow plugin to include their own CSS files.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _PAGE_: current target page (eg: linklist, picwall, etc.).
      • -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • css_files: called after loading default CSS.
      • -
    -
    -

    Note: only add the path of the CSS file. E.g: plugins/demo_plugin/custom_demo.css.

    -
    - -

    Triggered on every page.

    -

    Allow plugin to add content in page footer and include their own JS files.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _PAGE_: current target page (eg: linklist, picwall, etc.).
      • -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • text: called after the end of the footer text.
      • -
    • endofpage: called at the end of the page.
      • -
    -

    text_example

    -
      -
    • js_files: called at the end of the page, to include custom JS scripts.
      • -
    -
    -

    Note: only add the path of the JS file. E.g: plugins/demo_plugin/custom_demo.js.

    -
    - -

    Triggered when linklist is displayed (list of links, permalink, search, tag filtered, etc.).

    -

    It allows to add content at the begining and end of the page, after every link displayed and to alter link data.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • All templates data, including links.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • action_plugin: next to the button "private only" at the top and bottom of the page.
      • -
    -

    action_plugin_example

    -
      -
    • link_plugin: for every link, between permalink and link URL.
      • -
    -

    link_plugin_example

    -
      -
    • plugin_start_zone: before displaying the template content.
      • -
    -

    plugin_start_zone_example

    -
      -
    • plugin_end_zone: after displaying the template content.
      • -
    -

    plugin_end_zone_example

    - -

    Triggered when the link edition form is displayed.

    -

    Allow to add fields in the form, or display elements.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • All templates data.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • edit_link_plugin: after tags field.
      • -
    -

    edit_link_plugin_example

    -

    render_tools

    -

    Triggered when the "tools" page is displayed.

    -

    Allow to add content at the end of the page.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • All templates data.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • tools_plugin: at the end of the page.
      • -
    -

    tools_plugin_example

    -

    render_picwall

    -

    Triggered when picwall is displayed.

    -

    Allow to add content at the top and bottom of the page.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • All templates data.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -

    • plugin_start_zone: before displaying the template content.

      • -

    • plugin_end_zone: after displaying the template content.

      • -
    -

    plugin_start_end_zone_example

    -

    render_tagcloud

    -

    Triggered when tagcloud is displayed.

    -

    Allow to add content at the top and bottom of the page.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • All templates data.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -

    • plugin_start_zone: before displaying the template content.

      • -

    • plugin_end_zone: after displaying the template content.

      • -
    -

    For each tag, the following placeholder can be used:

    -
      -
    • tag_plugin: after each tag
      • -
    -

    plugin_start_end_zone_example

    -

    render_taglist

    -

    Triggered when taglist is displayed.

    -

    Allow to add content at the top and bottom of the page.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • All templates data.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -

    • plugin_start_zone: before displaying the template content.

      • -

    • plugin_end_zone: after displaying the template content.

      • -
    -

    For each tag, the following placeholder can be used:

    -
      -
    • tag_plugin: after each tag
      • -
    -

    render_daily

    -

    Triggered when tagcloud is displayed.

    -

    Allow to add content at the top and bottom of the page, the bottom of each link and to alter data.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • All templates data, including links.
      • -
    -
    Template placeholders
    -

    Items can be displayed in templates by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • link_plugin: used at bottom of each link.
      • -
    -

    link_plugin_example

    -
      -

    • plugin_start_zone: before displaying the template content.

      • -

    • plugin_end_zone: after displaying the template content.

      • -
    -

    render_feed

    -

    Triggered when the ATOM or RSS feed is displayed.

    -

    Allow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered.

    -
    Data
    -

    $data is an array containing:

    -
      -
    • _LOGGEDIN_: true if user is logged in, false otherwise.
      • -
    • _PAGE_: containing either rss or atom.
      • -
    • All templates data, including links.
      • -
    -
    Template placeholders
    -

    Tags can be added in feeds by adding an entry in $data['<placeholder>'] array.

    -

    List of placeholders:

    -
      -
    • feed_plugins_header: used as a header tag in the feed.
      • -
    -

    For each links:

    -
      -
    • feed_plugins: additional tag for every link entry.
      • -
    - -

    Triggered when a link is save (new link or edit).

    -

    Allow to alter the link being saved in the datastore.

    -
    Data
    -

    $data is an array containing the link being saved:

    -
      -
    • id
      • -
    • title
      • -
    • url
      • -
    • shorturl
      • -
    • description
      • -
    • private
      • -
    • tags
      • -
    • created
      • -
    • updated
      • -
    - -

    Triggered when a link is deleted.

    -

    Allow to execute any action before the link is actually removed from the datastore

    -
    Data
    -

    $data is an array containing the link being saved:

    -
      -
    • id
      • -
    • title
      • -
    • url
      • -
    • shorturl
      • -
    • description
      • -
    • private
      • -
    • tags
      • -
    • created
      • -
    • updated
      • -
    -

    Guide for template designer

    -

    Plugin administration

    -

    Your theme must include a plugin administration page: pluginsadmin.html.

    -
    -

    Note: repo's template link needs to be added when the PR is merged.

    -
    -

    Use the default one as an example.

    -

    Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include plugin_admin.js, only if:

    -
      -
    • you're using a table.
      • -
    • you call orderUp() and orderUp() onclick on arrows.
      • -
    • you add data-line and data-order to your rows.
      • -
    -

    Otherwise, you can use your own JS as long as this field is send by the form:

    -

    -

    Placeholder system

    -

    In order to make plugins work with every custom themes, you need to add variable placeholder in your templates.

    -

    It's a RainTPL loop like this:

    -
    {loop="$plugin_variable"}
-    {$value}
-{/loop}
    -

    You should enable demo_plugin for testing purpose, since it uses every placeholder available.

    -

    List of placeholders

    -

    page.header.html

    -

    At the end of the menu:

    -
    {loop="$plugins_header.buttons_toolbar"}
-    {$value}
-{/loop}
    -

    At the end of file, before clearing floating blocks:

    -
    {if="!empty($plugin_errors) && isLoggedIn()"}
-    <ul class="errors">
-        {loop="plugin_errors"}
-            <li>{$value}</li>
-        {/loop}
-    </ul>
-{/if}
    -

    includes.html

    -

    At the end of the file:

    -
    {loop="$plugins_includes.css_files"}
-<link type="text/css" rel="stylesheet" href="{$value}#"/>
-{/loop}
    -

    page.footer.html

    -

    At the end of your footer notes:

    -
    {loop="$plugins_footer.text"}
-     {$value}
-{/loop}
    -

    At the end of file:

    -
    {loop="$plugins_footer.js_files"}
-     <script src="{$value}#"></script>
-{/loop}
    -

    linklist.html

    -

    After search fields:

    -
    {loop="$plugins_header.fields_toolbar"}
-     {$value}
-{/loop}
    -

    Before displaying the link list (after paging):

    -
    {loop="$plugin_start_zone"}
-     {$value}
-{/loop}
    -

    For every links (icons):

    -
    {loop="$value.link_plugin"}
-    <span>{$value}</span>
-{/loop}
    -

    Before end paging:

    -
    {loop="$plugin_end_zone"}
-     {$value}
-{/loop}
    -

    linklist.paging.html

    -

    After the "private only" icon:

    -
    {loop="$action_plugin"}
-     {$value}
-{/loop}
    -

    editlink.html

    -

    After tags field:

    -
    {loop="$edit_link_plugin"}
-     {$value}
-{/loop}
    -

    tools.html

    -

    After the last tool:

    -
    {loop="$tools_plugin"}
-     {$value}
-{/loop}
    -

    picwall.html

    -

    Top:

    -
    <div id="plugin_zone_start_picwall" class="plugin_zone">
-    {loop="$plugin_start_zone"}
-        {$value}
-    {/loop}
-</div>
    -

    Bottom:

    -
    <div id="plugin_zone_end_picwall" class="plugin_zone">
-    {loop="$plugin_end_zone"}
-        {$value}
-    {/loop}
-</div>
    -

    tagcloud.html

    -

    Top:

    -
       <div id="plugin_zone_start_tagcloud" class="plugin_zone">
-        {loop="$plugin_start_zone"}
-            {$value}
-        {/loop}
-    </div>
    -

    Bottom:

    -
        <div id="plugin_zone_end_tagcloud" class="plugin_zone">
-        {loop="$plugin_end_zone"}
-            {$value}
-        {/loop}
-    </div>
    -

    daily.html

    -

    Top:

    -
    <div id="plugin_zone_start_picwall" class="plugin_zone">
-     {loop="$plugin_start_zone"}
-         {$value}
-     {/loop}
-</div>
    -

    After every link:

    -
    <div class="dailyEntryFooter">
-     {loop="$link.link_plugin"}
-          {$value}
-     {/loop}
-</div>
    -

    Bottom:

    -
    <div id="plugin_zone_end_picwall" class="plugin_zone">
-    {loop="$plugin_end_zone"}
-        {$value}
-    {/loop}
-</div>
    -

    feed.atom.xml and feed.rss.xml:

    -

    In headers tags section:

    -
    {loop="$feed_plugins_header"}
-  {$value}
-{/loop}
    -

    After each entry:

    -
    {loop="$value.feed_plugins"}
-  {$value}
-{/loop}
    - - diff --git a/doc/Plugins.html b/doc/Plugins.html deleted file mode 100644 index 08ce8a86..00000000 --- a/doc/Plugins.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - Shaarli – Plugins - - - - - - - -

    Plugins

    -

    Plugin installation

    -

    There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them.

    -

    If you want to install a third party plugin:

    -
      -
    • Download it.
      • -
    • Put it in the plugins directory in Shaarli's installation folder.
      • -
    • Make sure you put it correctly:
      • -
    -
    | index.php
-| plugins/
-|---| custom_plugin/
-|   |---| custom_plugin.php
-|   |---| ...
-
    -
      -
    • Make sure your webserver can read and write the files in your plugin folder.
      • -
    -

    Plugin configuration

    -

    In Shaarli's administration page (Tools link), go to Plugin administration.

    -

    Here you can enable and disable all plugins available, and configure them.

    -

    administration screenshot

    -

    Plugin order

    -

    In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first.

    -

    This is important in case plugins are depending on each other. Read plugins README details for more information.

    -

    Use case: The (non existent) plugin shaares_footer adds a footer to every shaare in Markdown syntax. It needs to be processed before (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML.

    -

    File mode

    -

    Enabled plugin are stored in your config.php parameters file, under the array:

    -
    $GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html)
    -

    You can edit them manually here.
    -Example:

    -
    $GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html)
-    'qrcode', 
-    'archiveorg',
-    'wallabag',
-    'markdown',
-);
    -

    Plugin usage

    -

    Official plugins

    -

    Usage of each plugin is documented in it's README file:

    -
      -
    • addlink-toolbar: Adds the addlink input on the linklist page
      • -
    • archiveorg: For each link, add an Archive.org icon
      • -
    • markdown: Render shaare description with Markdown syntax.
      • -
    • playvideos: Add a button in the toolbar allowing to watch all videos.
      • -
    • qrcode: For each link, add a QRCode icon.
      • -
    • wallabag: For each link, add a Wallabag icon to save it in your instance.
      • -
    -

    Third party plugins

    -

    See Community & related software

    - - diff --git a/doc/REST-API.html b/doc/REST-API.html deleted file mode 100644 index d14c98c9..00000000 --- a/doc/REST-API.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - Shaarli – REST API - - - - - - - -

    REST API

    -

    Usage

    -

    See the REST API documentation.

    -

    Authentication

    -

    All requests to Shaarli's API must include a JWT token to verify their authenticity.

    -

    This token has to be included as an HTTP header called Authentication: Bearer <jwt token>.

    -

    JWT resources :

    - -

    Shaarli JWT Token

    -

    JWT tokens are composed by three parts, separated by a dot . and encoded in base64:

    -
    [header].[payload].[signature][](.html)
    - -

    Shaarli only allow one hash algorithm, so the header will always be the same:

    -
    {
-    "typ": "JWT",
-    "alg": "HS512"
-}
    -

    Encoded in base64, it gives:

    -
    ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==
    -

    Payload

    -

    Validity duration

    -

    To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key iat (issued at). This token will be accepted during 9 minutes.

    -
    {
-    "iat": 1468663519
-}
    -

    See RFC reference.

    -

    Signature

    -

    The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot ., hashed in SHA512 with the API secret available in Shaarli administration page.

    -

    Signature example with PHP:

    -
    $content = base64_encode($header) . '.' . base64_encode($payload);
-$signature = hash_hmac('sha512', $content, $secret);
    -

    Complete example

    -

    PHP

    -
    function generateToken($secret) {
-    $header = base64_encode('{
-        "typ": "JWT",
-        "alg": "HS512"
-    }');
-    $payload = base64_encode('{
-        "iat": '. time() .'
-    }');
-    $signature = hash_hmac('sha512', $header .'.'. $payload , $secret);
-    return $header .'.'. $payload .'.'. $signature;
-}
-
-$secret = 'mysecret';
-$token = generateToken($secret);
-echo $token;
    -
    -

    ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68

    -
    -
    $options = [[](.html)
-    'http' => [[](.html)
-        'method' => 'GET',
-        'jwt' => $token,
-    ],
-];
-$context = stream_context_create($options);
-file_get_contents($apiEndpoint, false, $context);
    - - diff --git a/doc/REST-API.md b/doc/REST-API.md deleted file mode 100644 index d7909978..00000000 --- a/doc/REST-API.md +++ /dev/null @@ -1,105 +0,0 @@ -#REST API -## Usage - -See the [REST API documentation](http://shaarli.github.io/api-documentation/).[](.html) - -## Authentication - -All requests to Shaarli's API must include a JWT token to verify their authenticity. - -This token has to be included as an HTTP header called `Authentication: Bearer `. - -JWT resources : - - * [jwt.io](https://jwt.io) (including a list of client per language).[](.html) - * RFC : https://tools.ietf.org/html/rfc7519 - * https://float-middle.com/json-web-tokens-jwt-vs-sessions/ - * HackerNews thread: https://news.ycombinator.com/item?id=11929267 - - -### Shaarli JWT Token - -JWT tokens are composed by three parts, separated by a dot `.` and encoded in base64: - -``` -[header].[payload].[signature][](.html) -``` - -#### Header - -Shaarli only allow one hash algorithm, so the header will always be the same: - -```json -{ - "typ": "JWT", - "alg": "HS512" -} -``` - -Encoded in base64, it gives: - -``` -ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ== -``` - -#### Payload - -**Validity duration** - -To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes. - -```json -{ - "iat": 1468663519 -} -``` - -See [RFC reference](https://tools.ietf.org/html/rfc7519#section-4.1.6).[](.html) - - -#### Signature - -The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot `.`, hashed in SHA512 with the API secret available in Shaarli administration page. - -Signature example with PHP: - -```php -$content = base64_encode($header) . '.' . base64_encode($payload); -$signature = hash_hmac('sha512', $content, $secret); -``` - - -### Complete example - -#### PHP - -```php -function generateToken($secret) { - $header = base64_encode('{ - "typ": "JWT", - "alg": "HS512" - }'); - $payload = base64_encode('{ - "iat": '. time() .' - }'); - $signature = hash_hmac('sha512', $header .'.'. $payload , $secret); - return $header .'.'. $payload .'.'. $signature; -} - -$secret = 'mysecret'; -$token = generateToken($secret); -echo $token; -``` - -> `ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68` - -```php -$options = [[](.html) - 'http' => [[](.html) - 'method' => 'GET', - 'jwt' => $token, - ], -]; -$context = stream_context_create($options); -file_get_contents($apiEndpoint, false, $context); -``` diff --git a/doc/RSS-feeds.html b/doc/RSS-feeds.html deleted file mode 100644 index 0ebfecc6..00000000 --- a/doc/RSS-feeds.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Shaarli – RSS feeds - - - - - - -

    RSS feeds

    -

    Feeds options

    -

    Feeds are available in ATOM with ?do=atom and RSS with do=RSS.

    -

    Options:

    -
      -
    • You can use permalinks in the feed URL to get permalink to Shaares instead of direct link to shaared URL. -
        -
      • E.G. https://my.shaarli.domain/?do=atom&permalinks.
        • -
      • -
    • You can use nb parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: 50). The keyword all is available if you want everything. -
        -
      • https://my.shaarli.domain/?do=atom&permalinks&nb=42
        • -
      • https://my.shaarli.domain/?do=atom&permalinks&nb=all
        • -
      • -
    -

    RSS Feeds or Picture Wall for a specific search/tag

    -

    It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to only display results of a specific search, or for a specific tag.

    -

    For example, if you want to subscribe only to links tagged photography:

    -
      -
    • Go to the desired Shaarli instance.
      • -
    • Search for the photography tag in the Filter by tag box. Links tagged photography are displayed.
      • -
    • Click on the RSS Feed button.
      • -
    • You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag.
      • -
    • The same method also works for a full-text search (Search box) and for the Picture Wall (want to only see pictures about nature?)
      • -
    • You can also build the URLs manually: -
        -
      • https://my.shaarli.domain/?do=rss&searchtags=nature
        • -
      • https://my.shaarli.domain/links/?do=picwall&searchterm=poney
        • -
      • -
    -

    (images/rss-filter-2.png)

    - - diff --git a/doc/Release-Shaarli.html b/doc/Release-Shaarli.html deleted file mode 100644 index fa690c7c..00000000 --- a/doc/Release-Shaarli.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - Shaarli – Release Shaarli - - - - - - - -

    Release Shaarli

    -

    See Git - Maintaining a project - Tagging your [](.html)
    -releases    .

    -

    Prerequisites

    -

    This guide assumes that you have:

    -
      -
    • a GPG key matching your GitHub authentication credentials -
        -
      • i.e., the email address identified by the GPG key is the same as the one in your ~/.gitconfig
        • -
      • -
    • a GitHub fork of Shaarli
      • -
    • a local clone of your Shaarli fork, with the following remotes: -
        -
      • origin pointing to your GitHub fork
        • -
      • upstream pointing to the main Shaarli repository
        • -
      • -
    • maintainer permissions on the main Shaarli repository, to: -
        -
      • push the signed tag
        • -
      • create a new release
        • -
      • -
    • Composer and Pandoc need to be installed
      • -
    -

    GitHub release draft and CHANGELOG.md

    -

    See http://keepachangelog.com/en/0.3.0/ for changelog formatting.

    -

    GitHub release draft

    -

    GitHub allows drafting the release note for the upcoming release, from the Releases page. This way, the release note can be drafted while contributions are merged to master.

    -

    CHANGELOG.md

    -

    This file should contain the same information as the release note draft for the upcoming version.

    -

    Update it to:

    -
      -
    • add new entries (additions, fixes, etc.)
      • -
    • mark the current version as released by setting its date and link
      • -
    • add a new section for the future unreleased version
      • -
    -
    $ cd /path/to/shaarli
-
-$ nano CHANGELOG.md
-
-[...][](.html)
-## vA.B.C - UNRELEASED
-TBA
-
-## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)
-[...][](.html)
    -

    Increment the version code, create and push a signed tag

    -

    Bump Shaarli's version

    -
    $ cd /path/to/shaarli
-
-# create a new branch
-$ git fetch upstream
-$ git checkout upstream/master -b v0.5.0
-
-# bump the version number
-$ vim index.php shaarli_version.php
-
-# rebuild the documentation from the wiki
-$ make htmldoc
-
-# commit the changes
-$ git add index.php shaarli_version.php doc
-$ git commit -s -m "Bump version to v0.5.0"
-
-# push the commit on your GitHub fork
-$ git push origin v0.5.0
    -

    Create and merge a Pull Request

    -

    This one is pretty straightforward ;-)

    -

    Create and push a signed tag

    -
    # update your local copy
-$ git checkout master
-$ git fetch upstream
-$ git pull upstream master
-
-# create a signed tag
-$ git tag -s -m "Release v0.5.0" v0.5.0
-
-# push it to "upstream"
-$ git push --tags upstream
    -

    Verify a signed tag

    -

    v0.5.0 is the first GPG-signed tag pushed on the Community Shaarli.

    -

    Let's have a look at its signature!

    -
    $ cd /path/to/shaarli
-$ git fetch upstream
-
-# get the SHA1 reference of the tag
-$ git show-ref tags/v0.5.0
-f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0
-
-# verify the tag signature information
-$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
-gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
-gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
    -

    Publish the GitHub release

    -

    Update release badges

    -

    Update README.md so version badges display and point to the newly released Shaarli version(s).

    -

    Create a GitHub release from a Git tag

    -

    From the previously drafted release:

    -
      -
    • edit the release notes (if needed)
      • -
    • specify the appropriate Git tag
      • -
    • publish the release
      • -
    • profit!
      • -
    -

    Generate and upload all-in-one release archives

    -

    Users with a shared hosting may have:

    -
      -
    • no SSH access
      • -
    • no possibility to install PHP packages or server extensions
      • -
    • no possibility to run scripts
      • -
    -

    To ease Shaarli installations, it is possible to generate and upload additional release archives,
    -that will contain Shaarli code plus all required third-party libraries:

    -
    $ make release_archive
    -

    This will create the following archives:

    -
      -
    • shaarli-vX.Y.Z-full.tar
      • -
    • shaarli-vX.Y.Z-full.zip
      • -
    -

    The archives need to be manually uploaded on the previously created GitHub release.

    - - diff --git a/doc/Security.html b/doc/Security.html deleted file mode 100644 index 12b46fa9..00000000 --- a/doc/Security.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Shaarli – Security - - - - - - - -

    Security

    -

    Client browser

    -
      -
    • Shaarli relies on HTTP_REFERER for some functions (like redirects and clicking on tags). If you have disabled or masqueraded HTTP_REFERER in your browser, some features of Shaarli may not work
      • -
    -

    PHP

    -
      -
    • magic_quotes is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with magic_quotes on, so you should not be bothered even on crappy hosts.
      • -
    -

    Server and sessions

    -
      -
    • Directories are protected using .htaccess files
      • -
    • Forms are protected against XSRF (Cross-site requests forgery):
      • -
    • Forms which act on data (save,delete…) contain a token generated by the server.
      • -
    • Any posted form which does not contain a valid token is rejected.
      • -
    • Any token can only be used once.
      • -
    • Tokens are attached to the session and cannot be reused in another session.
      • -
    • Sessions automatically expire after 60 minutes.
      • -
    • Sessions are protected against hijacking: the session ID cannot be used from a different IP address.
      • -
    -

    Shaarli datastore and configuration

    -
      -
    • The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks.
      • -
    • Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a .php file.
      • -
    • Even if the server does not support .htaccess files, the data file will still not be readable by URL.
      • -

    • The database looks like this:

      -
      <?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...
-...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?>
      • -

    • Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. 20110923_150523) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only A-Z a-z 0-9 - _ and @.

      • -
    - - diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html deleted file mode 100644 index 0e6b220a..00000000 --- a/doc/Server-configuration.html +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - - Shaarli – Server configuration - - - - - - - -

    Server configuration

    -

    Example virtual host configurations for popular web servers

    - -

    Prerequisites

    -

    Shaarli

    -
      -
    • Shaarli is installed in a directory readable/writeable by the user
      • -
    • the correct read/write permissions have been granted to the web server user and/or group
      • -
    • for HTTPS / SSL:
      • -
    • a key pair (public, private) and a certificate have been generated
      • -
    • the appropriate server SSL extension is installed and active
      • -
    -

    HTTPS, TLS and self-signed certificates

    -

    Related guides:

    - -

    Proxies

    -

    If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:

    -
      -
    • X-Forwarded-Proto;
      • -
    • X-Forwarded-Host;
      • -
    • X-Forwarded-For.
      • -
    -

    See also proxy-related issues.

    -

    Apache

    -

    Minimal

    -
    <VirtualHost *:80>
-    ServerName   shaarli.my-domain.org
-    DocumentRoot /absolute/path/to/shaarli/
-</VirtualHost>
    -

    Debug - Log all the things!

    -

    This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.

    -

    See:

    - -
    <VirtualHost *:80>
-    ServerName   shaarli.my-domain.org
-    DocumentRoot /absolute/path/to/shaarli/
-
-    LogLevel  warn
-    ErrorLog  /var/log/apache2/shaarli-error.log
-    CustomLog /var/log/apache2/shaarli-access.log combined
-
-    php_flag  log_errors on
-    php_flag  display_errors on
-    php_value error_reporting 2147483647
-    php_value error_log /var/log/apache2/shaarli-php-error.log
-</VirtualHost>
    -

    Standard - Keep access and error logs

    -
    <VirtualHost *:80>
-    ServerName   shaarli.my-domain.org
-    DocumentRoot /absolute/path/to/shaarli/
-
-    LogLevel  warn
-    ErrorLog  /var/log/apache2/shaarli-error.log
-    CustomLog /var/log/apache2/shaarli-access.log combined
-</VirtualHost>
    -

    Paranoid - Redirect HTTP (:80) to HTTPS (:443)

    -

    See Server-side TLS (Mozilla).

    -
    <VirtualHost *:443>
-    ServerName   shaarli.my-domain.org
-    DocumentRoot /absolute/path/to/shaarli/
-
-    SSLEngine             on
-    SSLCertificateFile    /absolute/path/to/the/website/certificate.pem
-    SSLCertificateKeyFile /absolute/path/to/the/website/key.key
-
-    <Directory /absolute/path/to/shaarli/>
-        AllowOverride All
-        Options Indexes FollowSymLinks MultiViews
-        Order allow,deny
-        allow from all
-    </Directory>
-
-    LogLevel  warn
-    ErrorLog  /var/log/apache2/shaarli-error.log
-    CustomLog /var/log/apache2/shaarli-access.log combined
-</VirtualHost>
-<VirtualHost *:80>
-    ServerName   shaarli.my-domain.org
-    Redirect 301 / https://shaarli.my-domain.org
-
-    LogLevel  warn
-    ErrorLog  /var/log/apache2/shaarli-error.log
-    CustomLog /var/log/apache2/shaarli-access.log combined
-</VirtualHost>
    -

    .htaccess

    -

    Shaarli use .htaccess Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive AllowOverride All in your virtual host configuration for them to work.

    -

    Warning: If you use Apache 2.2 or lower, you need mod_version to be installed and enabled.

    -

    Apache module mod_rewrite must be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root .htaccess file.

    -

    LightHttpd

    -

    Nginx

    -

    Foreword

    -

    Nginx does not natively interpret PHP scripts; to this effect, we will run a FastCGI service, to which Nginx's FastCGI module will proxy all requests to PHP resources.

    -

    Required packages:

    - -

    Official documentation:

    - -

    Community resources:

    - -

    Common setup

    -

    Once Nginx and PHP-FPM are installed, we need to ensure:

    -
      -
    • Nginx and PHP-FPM are running using the same user and group
      • -
    • both these user and group have -
        -
      • read permissions for Shaarli resources
        • -
      • execute permissions for Shaarli directories AND their parent directories
        • -
      • -
    -

    On a production server:

    -
      -
    • user:group will likely be http:http, www:www or www-data:www-data
      • -
    • files will be located under /var/www, /var/http or /usr/share/nginx
      • -
    -

    On a development server:

    -
      -
    • files may be located in a user's home directory
      • -
    • in this case, make sure both Nginx and PHP-FPM are running as the local user/group!
      • -
    -

    For all following configuration examples, this user/group pair will be used:

    -
      -
    • user:group = john:users,
      • -
    -

    which corresponds to the following service configuration:

    -
    ; /etc/php/php-fpm.conf
-user = john
-group = users
-
-[...][](.html)
-listen.owner = john
-listen.group = users
    -
    # /etc/nginx/nginx.conf
-user john users;
-
-http {
-    [...][](.html)
-}
    -

    (Optional) Increase the maximum file upload size

    -

    Some bookmark dumps generated by web browsers can be huge due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.

    -

    To increase upload size, you will need to modify both nginx and PHP configuration:

    -
    # /etc/nginx/nginx.conf
-
-http {
-    [...][](.html)
-
-    client_max_body_size 10m;
-
-    [...][](.html)
-}
    -
    # /etc/php5/fpm/php.ini
-
-[...][](.html)
-post_max_size = 10M
-[...][](.html)
-upload_max_filesize = 10M
    -

    Minimal

    -

    WARNING: Use for development only!

    -
    user john users;
-worker_processes  1;
-events {
-    worker_connections  1024;
-}
-
-http {
-    include            mime.types;
-    default_type       application/octet-stream;
-    keepalive_timeout  20;
-
-    index index.html index.php;
-
-    server {
-        listen       80;
-        server_name  localhost;
-        root         /home/john/web;
-
-        access_log  /var/log/nginx/access.log;
-        error_log   /var/log/nginx/error.log;
-
-        location /shaarli/ {
-            try_files $uri /shaarli/index.php$is_args$args;
-            access_log  /var/log/nginx/shaarli.access.log;
-            error_log   /var/log/nginx/shaarli.error.log;
-        }
-
-        location ~ (index)\.php$ {
-            try_files $uri =404;
-            fastcgi_split_path_info ^(.+\.php)(/.+)$;
-            fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
-            fastcgi_index  index.php;
-            include        fastcgi.conf;
-        }
-    }
-}
    -

    Modular

    -

    The previous setup is sufficient for development purposes, but has several major caveats:

    -
      -
    • every content that does not match the PHP rule will be sent to client browsers: -
        -
      • dotfiles - in our case, .htaccess
        • -
      • temporary files, e.g. Vim or Emacs files: index.php~
        • -
      • -
    • asset / static resource caching is not optimized
      • -
    • if serving several PHP sites, there will be a lot of duplication: location /shaarli/, location /mysite/, etc.
      • -
    -

    To solve this, we will split Nginx configuration in several parts, that will be included when needed:

    -
    # /etc/nginx/deny.conf
-location ~ /\. {
-    # deny access to dotfiles
-    access_log off;
-    log_not_found off;
-    deny all;
-}
-
-location ~ ~$ {
-    # deny access to temp editor files, e.g. "script.php~"
-    access_log off;
-    log_not_found off;
-    deny all;
-}
    -
    # /etc/nginx/php.conf
-location ~ (index)\.php$ {
-    # Slim - split URL path into (script_filename, path_info)
-    try_files $uri =404;
-    fastcgi_split_path_info ^(.+\.php)(/.+)$;
-
-    # filter and proxy PHP requests to PHP-FPM
-    fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
-    fastcgi_index  index.php;
-    include        fastcgi.conf;
-}
-
-location ~ \.php$ {
-    # deny access to all other PHP scripts
-    deny all;
-}
    -
    # /etc/nginx/static_assets.conf
-location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
-    expires    max;
-    add_header Pragma public;
-    add_header Cache-Control "public, must-revalidate, proxy-revalidate";
-}
    -
    # /etc/nginx/nginx.conf
-[...][](.html)
-
-http {
-    [...][](.html)
-
-    root        /home/john/web;
-    access_log  /var/log/nginx/access.log;
-    error_log   /var/log/nginx/error.log;
-
-    server {
-        # virtual host for a first domain
-        listen       80;
-        server_name  my.first.domain.org;
-
-        location /shaarli/ {
-            # Slim - rewrite URLs
-            try_files $uri /shaarli/index.php$is_args$args;
-
-            access_log  /var/log/nginx/shaarli.access.log;
-            error_log   /var/log/nginx/shaarli.error.log;
-        }
-
-        location = /shaarli/favicon.ico {
-            # serve the Shaarli favicon from its custom location
-            alias /var/www/shaarli/images/favicon.ico;
-        }
-
-        include deny.conf;
-        include static_assets.conf;
-        include php.conf;
-    }
-
-    server {
-        # virtual host for a second domain
-        listen       80;
-        server_name  second.domain.com;
-
-        location /minigal/ {
-            access_log  /var/log/nginx/minigal.access.log;
-            error_log   /var/log/nginx/minigal.error.log;
-        }
-
-        include deny.conf;
-        include static_assets.conf;
-        include php.conf;
-    }
-}
    -

    Redirect HTTP to HTTPS

    -

    Assuming you have generated a (self-signed) key and certificate, and they are located under /home/john/ssl/localhost.{key,crt}, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.

    -
    # /etc/nginx/nginx.conf
-[...][](.html)
-
-http {
-    [...][](.html)
-
-    index index.html index.php;
-
-    root        /home/john/web;
-    access_log  /var/log/nginx/access.log;
-    error_log   /var/log/nginx/error.log;
-
-    server {
-        listen       80;
-        server_name  localhost;
-
-        return 301 https://localhost$request_uri;
-    }
-
-    server {
-        listen       443 ssl;
-        server_name  localhost;
-
-        ssl_certificate      /home/john/ssl/localhost.crt;
-        ssl_certificate_key  /home/john/ssl/localhost.key;
-
-        location /shaarli/ {
-            # Slim - rewrite URLs
-            try_files $uri /index.php$is_args$args;
-
-            access_log  /var/log/nginx/shaarli.access.log;
-            error_log   /var/log/nginx/shaarli.error.log;
-        }
-
-        location = /shaarli/favicon.ico {
-            # serve the Shaarli favicon from its custom location
-            alias /var/www/shaarli/images/favicon.ico;
-        }
-
-        include deny.conf;
-        include static_assets.conf;
-        include php.conf;
-    }
-}
    - - diff --git a/doc/Server-requirements.html b/doc/Server-requirements.html deleted file mode 100644 index 79d74118..00000000 --- a/doc/Server-requirements.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - - Shaarli – Server requirements - - - - - - -

    Server requirements

    -

    PHP

    -

    Release information

    - -

    Supported versions

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    VersionStatusShaarli compatibility
    7.1Supported (v0.9.x)✅
    7.0Supported✅
    5.6Supported✅
    5.5EOL: 2016-07-10✅
    5.4EOL: 2015-09-14✅ (up to Shaarli 0.8.x)
    5.3EOL: 2014-08-14✅ (up to Shaarli 0.8.x)
    -

    See also:

    - -

    Dependency management

    -

    Starting with Shaarli v0.8.x, Composer is used to resolve,
    -download and install third-party PHP dependencies.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    LibraryRequired?Usage
    shaarli/netscape-bookmark-parserAllImport bookmarks from Netscape files
    erusev/parsedownAllParse MarkDown syntax for the MarkDown plugin
    slim/slimAllHandle routes and middleware for the REST API
    -

    Extensions

    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ExtensionRequired?Usage
    opensslAllOpenSSL, HTTPS
    php-mbstringCentOS, Fedora, RHEL, Windowsmultibyte (Unicode) string support
    php-gdoptionalthumbnail resizing
    php-intloptionallocalized text sorting (e.g. e->è->f)
    php-curloptionalusing cURL for fetching webpages and thumbnails in a more robust way
    - - diff --git a/doc/Server-security.html b/doc/Server-security.html deleted file mode 100644 index 4f7ff468..00000000 --- a/doc/Server-security.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - Shaarli – Server security - - - - - - - -

    Server security

    -

    php.ini

    -

    PHP settings are defined in:

    -
      -
    • a main configuration file, usually found under /etc/php5/php.ini; some distributions provide different configuration environments, e.g. -
        -
      • /etc/php5/php.ini - used when running console scripts
        • -
      • /etc/php5/apache2/php.ini - used when a client requests PHP resources from Apache
        • -
      • /etc/php5/php-fpm.conf - used when PHP requests are proxied to PHP-FPM
        • -
      • -
    • additional configuration files/entries, depending on the installed/enabled extensions: -
        -
      • /etc/php/conf.d/xdebug.ini
        • -
      • -
    -

    Locate .ini files

    -

    Console environment

    -
    $ php --ini
-Configuration File (php.ini) Path: /etc/php
-Loaded Configuration File:         /etc/php/php.ini
-Scan for additional .ini files in: /etc/php/conf.d
-Additional .ini files parsed:      /etc/php/conf.d/xdebug.ini
    -

    Server environment

    -
      -
    • create a phpinfo.php script located in a path supported by the web server, e.g. -
        -
      • Apache (with user dirs enabled): /home/myself/public_html/phpinfo.php
        • -
      • /var/www/test/phpinfo.php
        • -
      • -
    • make sure the script is readable by the web server user/group (usually, www, www-data or httpd)
      • -
    • access the script from a web browser
      • -

    • look at the Loaded Configuration File and Scan this dir for additional .ini files entries

      -
      <?php phpinfo(); ?>
      • -
    -

    fail2ban

    -

    fail2ban is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses iptables profiles to block brute-force attempts:

    - -

    Read Shaarli logs to ban IPs

    -

    Example configuration:

    -
      -
    • allow 3 login attempts per IP address
      • -
    • after 3 failures, permanently ban the corresponding IP adddress
      • -
    -

    /etc/fail2ban/jail.local

    -
    [shaarli-auth][](.html)
-enabled  = true
-port     = https,http
-filter   = shaarli-auth
-logpath  = /var/www/path/to/shaarli/data/log.txt
-maxretry = 3
-bantime = -1
    -

    /etc/fail2ban/filter.d/shaarli-auth.conf

    -
    [INCLUDES][](.html)
-before = common.conf
-[Definition][](.html)
-failregex = \s-\s<HOST>\s-\sLogin failed for user.*$
-ignoreregex =
    -

    Robots - Restricting search engines and web crawler traffic

    -

    Creating a robots.txt with the following contents at the root of your Shaarli installation will prevent honest web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.

    -
    User-agent: *
-Disallow: /
    -

    See:

    - - - diff --git a/doc/Shaarli-configuration.html b/doc/Shaarli-configuration.html deleted file mode 100644 index c696c97c..00000000 --- a/doc/Shaarli-configuration.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - Shaarli – Shaarli configuration - - - - - - - -

    Shaarli configuration

    -

    Shaarli configuration

    -

    Foreword

    -

    Do not edit configuration options in index.php! Your changes would be lost.

    -

    Once your Shaarli instance is installed, the file data/config.json.php is generated:

    -
      -
    • it contains all settings in JSON format, and can be edited to customize values
      • -
    • it defines which plugins are enabled(.html)
      • -
    • its values override those defined in index.php
      • -
    • it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration
      • -
    -

    File and directory permissions

    -

    The server process running Shaarli must have:

    -
      -
    • read access to the following resources: -
        -
      • PHP scripts: index.php, application/*.php, plugins/*.php
        • -
      • 3rd party PHP and Javascript libraries: inc/*.php, inc/*.js
        • -
      • static assets: -
          -
        • CSS stylesheets: inc/*.css
          • -
        • images/*
          • -
        • -
      • RainTPL templates: tpl/*.html
        • -
      • -
    • read, write and execution access to the following directories: -
        -
      • cache - thumbnail cache
        • -
      • data - link data store, configuration options
        • -
      • pagecache - Atom/RSS feed cache
        • -
      • tmp - RainTPL page cache
        • -
      • -
    -

    On a Linux distribution:

    -
      -
    • the web server user will likely be www or http (for Apache2)
      • -
    • it will be a member of a group of the same name: www:www, http:http
      • -
    • to give it access to Shaarli, either: -
        -
      • unzip Shaarli in the default web server location (usually /var/www/) and set the web server user as the owner
        • -
      • put users in the same group as the web server, and set the appropriate access rights
        • -
      • -
    • if you have a domain / subdomain to serve Shaarli, configure the server accordingly(.html)
      • -
    -

    Configuration

    -

    In data/config.json.php.

    -

    See also Plugin System.

    -

    Credentials

    -
    -

    You shouldn't edit those.

    -
    -

    login: Login username.
    -hash: Generated password hash.
    -salt: Password salt.

    -

    General

    -

    title: Shaarli's instance title.
    -header_link: Link to the homepage.
    -links_per_page: Number of shaares displayed per page.
    -timezone: See the list of supported timezones.
    -enabled_plugins: List of enabled plugins.

    -

    Security

    -

    session_protection_disabled: Disable session cookie hijacking protection (not recommended).
    -It might be useful if your IP adress often changes.
    -ban_after: Failed login attempts before being IP banned.
    -ban_duration: IP ban duration in seconds.
    -open_shaarli: Anyone can add a new link while logged out if enabled.
    -trusted_proxies: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.

    -

    Resources

    -

    data_dir: Data directory.
    -datastore: Shaarli's links database file path.
    -history: Shaarli's operation history file path.
    -updates: File path for the ran updates file.
    -log: Log file path.
    -update_check: Last update check file path.
    -raintpl_tpl: Templates directory.
    -raintpl_tmp: Template engine cache directory.
    -thumbnails_cache: Thumbnails cache directory.
    -page_cache: Shaarli's internal cache directory.
    -ban_file: Banned IP file path.

    -

    Updates

    -

    check_updates: Enable or disable update check to the git repository.
    -check_updates_branch: Git branch used to check updates (e.g. stable or master).
    -check_updates_interval: Look for new version every N seconds (default: every day).

    -

    Privacy

    -

    default_private_links: Check the private checkbox by default for every new link.
    -hide_public_links: All links are hidden while logged out.
    -hide_timestamps: Timestamps are hidden.

    -

    Feed

    -

    rss_permalinks: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.
    -show_atom: Display ATOM feed button.

    -

    Thumbnail

    -

    enable_thumbnails: Enable or disable thumbnail display.
    -enable_localcache: Enable or disable local cache.

    -

    Redirector

    -

    url: Redirector URL, such as anonym.to.
    -encode_url: Enable this if the redirector needs encoded URL to work properly.

    -

    Configuration file example

    -
    <?php /*
-{
-    "credentials": {
-        "login": "<login>",
-        "hash": "<password hash>",
-        "salt": "<password salt>"
-    },
-    "security": {
-        "ban_after": 4,
-        "session_protection_disabled": false,
-        "ban_duration": 1800,
-        "trusted_proxies": [[](.html)
-            "1.2.3.4",
-            "5.6.7.8"
-        ]
-    },
-    "resources": {
-        "data_dir": "data",
-        "config": "data\/config.php",
-        "datastore": "data\/datastore.php",
-        "ban_file": "data\/ipbans.php",
-        "updates": "data\/updates.txt",
-        "log": "data\/log.txt",
-        "update_check": "data\/lastupdatecheck.txt",
-        "raintpl_tmp": "tmp\/",
-        "raintpl_tpl": "tpl\/",
-        "thumbnails_cache": "cache",
-        "page_cache": "pagecache"
-    },
-    "general": {
-        "check_updates": true,
-        "rss_permalinks": true,
-        "links_per_page": 20,
-        "default_private_links": true,
-        "enable_thumbnails": true,
-        "enable_localcache": true,
-        "check_updates_branch": "stable",
-        "check_updates_interval": 86400,
-        "enabled_plugins": [[](.html)
-            "markdown",
-            "wallabag",
-            "archiveorg"
-        ],
-        "timezone": "Europe\/Paris",
-        "title": "My Shaarli",
-        "header_link": "?"
-    },
-    "extras": {
-        "show_atom": false,
-        "hide_public_links": false,
-        "hide_timestamps": false,
-        "open_shaarli": false,
-        "redirector": "http://anonym.to/?",
-        "redirector_encode_url": false
-    },
-    "general": {
-        "header_link": "?",
-        "links_per_page": 20,
-        "enabled_plugins": [[](.html)
-            "markdown",
-            "wallabag"
-        ],
-        "timezone": "Europe\/Paris",
-        "title": "My Shaarli"
-    },
-    "updates": {
-        "check_updates": true,
-        "check_updates_branch": "stable",
-        "check_updates_interval": 86400
-    },
-    "feed": {
-        "rss_permalinks": true,
-        "show_atom": false
-    },
-    "privacy": {
-        "default_private_links": true,
-        "hide_public_links": false,
-        "hide_timestamps": false
-    },
-    "thumbnail": {
-        "enable_thumbnails": true,
-        "enable_localcache": true
-    },
-    "redirector": {
-        "url": "http://anonym.to/?",
-        "encode_url": false
-    },
-    "plugins": {
-        "WALLABAG_URL": "http://demo.wallabag.org",
-        "WALLABAG_VERSION": "1"
-    }
-} ?>
    -

    Additional configuration

    -

    The playvideos plugin may require that you adapt your server's
    -Content Security Policy
    -configuration to work properly.(.html)

    - - diff --git a/doc/Sharing-button.html b/doc/Sharing-button.html deleted file mode 100644 index f3682f8c..00000000 --- a/doc/Sharing-button.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - Shaarli – Sharing button - - - - - - -

    Sharing button

    -

    Add the sharing button (bookmarklet) to your browser

    -
      -
    • Open your Shaarli and Login
      • -
    • Click the Tools button in the top bar
      • -
    • Drag the ✚Shaare link button, and drop it to your browser's bookmarks bar.
      • -
    -

    This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.

    -

    - -
      -
    • When you are visiting a webpage you would like to share with Shaarli, click the bookmarklet you just added.
      • -
    • A window opens.
      • -
    • You can freely edit title, description, tags... to find it later using the text search or tag filtering.
      • -
    • You will be able to edit this link later using the
      • -
    • You can also check the “Private” box so that the link is saved but only visible to you.
      • -
    • Click Save.Voilà! Your link is now shared.
      • -
    -

    Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)

    -

    Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.

    -

    See #196.

    -

    There is an open bug for both Firefox and Chromium:

    - - - diff --git a/doc/Sharing-button.md b/doc/Sharing-button.md deleted file mode 100644 index e4388863..00000000 --- a/doc/Sharing-button.md +++ /dev/null @@ -1,31 +0,0 @@ -#Sharing button -### Add the sharing button (_bookmarklet_) to your browser - - * Open your Shaarli and `Login` - * Click the `Tools` button in the top bar - * Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. - -_This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ - -![(images/bookmarklet.png)]((images/bookmarklet.png).html) - -### Share links using the _bookmarklet_ - - * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. - * A window opens. - * You can freely edit title, description, tags... to find it later using the text search or tag filtering. - * You will be able to edit this link later using the ![(https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button.]((https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png)-edit-button..html) - * You can also check the “Private” box so that the link is saved but only visible to you. - * Click `Save`.**Voilà! Your link is now shared.** - -### Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com) - -Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. - -See [#196](https://github.com/shaarli/Shaarli#196).[](.html) - -There is an open bug for both Firefox and Chromium: - - * https://bugzilla.mozilla.org/show_bug.cgi?id=866522 - * https://code.google.com/p/chromium/issues/detail?id=233903 - diff --git a/doc/Static-analysis.html b/doc/Static-analysis.html deleted file mode 100644 index a95d195e..00000000 --- a/doc/Static-analysis.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Shaarli – Static analysis - - - - - - -

    Static analysis

    -

    WIP

    -

    This topic is currently being discussed here:

    - -

    Usage

    -

    Static analysis tools can be installed with Composer, and used through Shaarli's Makefile.

    -

    For an overview of the available features, see:

    - - - diff --git a/doc/Theming.html b/doc/Theming.html deleted file mode 100644 index 6b5dac35..00000000 --- a/doc/Theming.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - Shaarli – Theming - - - - - - - -

    Theming

    -

    Foreword

    -

    There are two ways of customizing how Shaarli looks:

    -
      -
    1. by using a custom CSS to override Shaarli's CSS
      2. -
    2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources
      3. -
    -

    Custom CSS

    -

    Shaarli's appearance can be modified by adding CSS rules to:

    -
      -
    • Shaarli < v0.9.0: inc/user.css
      • -
    • Shaarli >= v0.9.0: data/user.css
      • -
    -

    This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme.

    -

    Note: Do not edit tpl/default/css/shaarli.css! Your changes would be overridden when updating Shaarli.

    -

    See also Download CSS styles from an OPML list

    -

    Themes

    -

    WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental.

    -

    Installation:

    -
      -
    • find a theme you'd like to install
      • -
    • copy or clone the theme folder under tpl/<a_sweet_theme>
      • -
    • enable the theme: -
        -
      • Shaarli < v0.9.0: edit data/config.json.php and set the value of raintpl_tpl to the new theme name:
        -"raintpl_tpl": "tpl\/my-template\/"
        • -
      • Shaarli >= v0.9.0: select the theme through the Tools page
        • -
      • -
    -

    Community CSS & themes

    -

    Custom CSS

    - -

    Themes

    - -

    Shaarli forks

    - -

    Example installation: AlbinoMouse theme

    -

    With the following configuration:

    -
      -
    • Apache 2 / PHP 5.6
      • -
    • user sites are enabled, e.g. /home/user/public_html/somedir is served as http://localhost/~user/somedir
      • -
    • http is the name of the Apache user
      • -
    -
    $ cd ~/public_html
-
-# clone repositories
-$ git clone https://github.com/shaarli/Shaarli.git shaarli
-$ pushd shaarli/tpl
-$ git clone https://github.com/alexisju/albinomouse-template.git
-$ popd
-
-# set access rights for Apache
-$ chgrp -R http shaarli
-$ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp
    -

    Get config written:

    -
      -
    • go to the freshly installed site
      • -
    • fill the install form
      • -
    • log in to Shaarli
      • -
    -

    Edit Shaarli's configuration|Shaarli configuration:

    -
    # the file should be owned by Apache, thus not writeable => sudo
-$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php
    - - diff --git a/doc/Troubleshooting.html b/doc/Troubleshooting.html deleted file mode 100644 index f43e6ed3..00000000 --- a/doc/Troubleshooting.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - Shaarli – Troubleshooting - - - - - - - -

    Troubleshooting

    -

    Browser

    -

    Redirection issues (HTTP Referer)

    -

    Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages.

    -

    See:

    - -

    Firefox HTTP Referer options

    -

    HTTP settings are available by browsing about:config, here are the available settings and their values.

    -

    network.http.sendRefererHeader - determines when to send the Referer HTTP header

    -
      -
    • 0: Never send the referring URL -
        -
      • not recommended, may break some sites
        • -
      • -
    • 1: Send only on clicked links
      • -
    • 2 (default): Send for links and images
      • -
    -

    network.http.referer.XOriginPolicy - Cross-domain origin policy

    -
      -
    • 0 (default): Always send
      • -
    • 1: Send if base domains match
      • -
    • 2: Send if hosts match
      • -
    -

    network.http.referer.spoofSource - Referer spoofing (~faking)

    -
      -
    • false (default): real referer
      • -
    • true: spoof referer (use target URI as referer)
      • -
    • known to break some functionality in Shaarli
      • -
    -

    network.http.referer.trimmingPolicy - trim the URI not to send a full Referer

    -
      -
    • 0 (default): send full URI
      • -
    • 1: scheme+host+port+path
      • -
    • 2: scheme+host+port
      • -
    -

    Firefox, localhost and redirections

    -

    localhost is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly.

    -

    To solve this, assign a local domain to your host, e.g.

    -
    127.0.0.1 localhost desktop localhost.lan
-::1       localhost desktop localhost.lan
    -

    and browse Shaarli at http://localhost.lan/.

    -

    Related threads:

    - -

    Login

    -

    I forgot my password!

    -

    Delete the file data/config.php and display the page again. You will be asked for a new login/password.

    -

    I'm locked out - Login bruteforce protection

    -

    Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links.

    -

    To remove the current IP bans, delete the file data/ipbans.php

    -

    List of all login attempts

    -

    The file data/log.txt shows all logins (successful or failed) and bans/lifted bans.
    -Search for failed in this file to look for unauthorized login attempts.

    -

    Hosting problems

    -

    Old PHP versions

    -
      -
    • On free.fr : free.fr now support php 5.6.x(link)and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a sessions directory and a .htaccess file containing:
      • -
    -
    <IfDefine Free>
-php56 1
-</IfDefine>
    -
      -
    • If you have an error such as: Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to .php5
      • -
    • On 1and1 : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).
      • -
    • If you have the error Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:
      • -
    -
    //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.
-// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html 
-//if (strpos($status,'200 OK')) $title=html_extract_title($data);
    -
      -
    • On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.
      • -
    • On lost-oasis, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?>. To fix this, remove this message from php-include/prepend.php
      • -
    -

    Dates are not properly formatted

    -

    Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )

    -

    Problems on CentOS servers

    -

    On CentOS/RedHat derivatives, you may need to install the php-mbstring package.

    -

    My session expires! I can't stay logged in

    -

    This can be caused by several things:

    -
      -
    • Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a session directory on the root of your website.) You may need to create the session directory of set it up.
      • -
    • Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the sessions subdirectory and add ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');. Make sure this directory is not browsable !)
      • -
    • If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses).
      • -
    • Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those.
      • -
    • You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time.
      • -
    • If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.
      • -
    -

    Sessions do not seem to work correctly on your server

    -

    Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have no dots in the hostname (e.g. localhost or http://my-webserver/shaarli/), some browsers will not store cookies at all (this respects the HTTP cookie specification).

    -

    pubsubhubbub support

    -

    Download publisher.php at the root of your Shaarli installation and set $GLOBALS['config'['PUBSUBHUB_URL'] in your config.php]('PUBSUBHUB_URL']-in-your-config.php`.html)

    - - diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html deleted file mode 100644 index 09611463..00000000 --- a/doc/Unit-tests.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - Shaarli – Unit tests - - - - - - - -

    Unit tests

    -

    Setup your environment for tests

    -

    The framework used is PHPUnit; it can be installed with Composer, which is a dependency management tool.

    -

    Regarding Composer, you can either use:

    -
      -
    • a system-wide version, e.g. installed through your distro's package manager
      • -
    • a local version, downloadable here
      • -
    -

    Sample usage

    -
    # system-wide version
-$ composer install
-$ composer update
-
-# local version
-$ php composer.phar self-update
-$ php composer.phar install
-$ php composer.phar update
    -

    Install Shaarli dev dependencies

    -
    $ cd /path/to/shaarli
-$ composer update
    -

    Install and enable Xdebug to generate PHPUnit coverage reports

    -

    For Debian-based distros:

    -
    $ aptitude install php5-xdebug
    -

    For ArchLinux:

    -
    $ pacman -S xdebug
    -

    Then add the following line to /etc/php/php.ini:

    -
    zend_extension=xdebug.so
    -

    Run unit tests

    -

    Successful test suite:

    -
    $ make test
-
--------
-PHPUNIT
--------
-PHPUnit 4.6.9 by Sebastian Bergmann and contributors.
-
-Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml
-
-....................................
-
-Time: 759 ms, Memory: 8.25Mb
-
-OK (36 tests, 65 assertions)
    -

    Test suite with failures and errors:

    -
    $ make test
--------
-PHPUNIT
--------
-PHPUnit 4.6.9 by Sebastian Bergmann and contributors.
-
-Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml
-
-E..FF...............................
-
-Time: 802 ms, Memory: 8.25Mb
-
-There was 1 error:
-
-1) LinkDBTest::testConstructLoggedIn
-Missing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\
-DBTest.php on line 79 and defined
-
-/home/virtualtam/public_html/shaarli/application/LinkDB.php:58
-/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79
-
---
-
-There were 2 failures:
-
-1) LinkDBTest::testCheckDBNew
-Failed asserting that two strings are equal.
---- Expected
-+++ Actual
-@@ @@
--'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'
-+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'
-
-/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121
-
-2) LinkDBTest::testCheckDBLoad
-Failed asserting that two strings are equal.
---- Expected
-+++ Actual
-@@ @@
--'e3edea8ea7bb50be4bcb404df53fbb4546a7156e'
-+'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834'
-
-/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133
-
-FAILURES!
-Tests: 36, Assertions: 63, Errors: 1, Failures: 2.
    -

    Test results and coverage

    -

    By default, PHPUnit will run all suitable tests found under the tests directory.

    -

    Each test has 3 possible outcomes:

    -
      -
    • . - success
      • -
    • F - failure: the test was run but its results are invalid
      • -
    • the code does not behave as expected
      • -
    • dependencies to external elements: globals, session, cache...
      • -
    • E - error: something went wrong and the tested code has crashed
      • -
    • typos in the code, or in the test code
      • -
    • dependencies to missing external elements
      • -
    -

    If Xdebug has been installed and activated, two coverage reports will be generated:

    -
      -
    • a summary in the console
      • -
    • a detailed HTML report with metrics for tested code
      • -
    • to open it in a web browser: firefox coverage/index.html &
      • -
    -

    Executing specific tests

    -

    Add a @group annotation in a test class or method comment:

    -
    /**
- * Netscape bookmark import
- * @group WIP
- */
-class BookmarkImportTest extends PHPUnit_Framework_TestCase
-{
-   [...][](.html)
-}
    -

    To run all tests annotated with @group WIP:

    -
    $ vendor/bin/phpunit --group WIP tests/
    - - diff --git a/doc/Upgrade-and-migration.html b/doc/Upgrade-and-migration.html deleted file mode 100644 index 667215ab..00000000 --- a/doc/Upgrade-and-migration.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - - Shaarli – Upgrade and migration - - - - - - - -

    Upgrade and migration

    -

    Preparation

    -

    Note your current version

    -

    If anything goes wrong, it's important for us to know which version you're upgrading from.
    -The current version is present in the version.php file.

    -

    Backup your data

    -

    Shaarli stores all user data under the data directory:

    -
      -
    • data/config.php - main configuration file
      • -
    • data/datastore.php - bookmarked links
      • -
    • data/ipbans.php - banned IP addresses
      • -
    • data/updates.txt - contains all automatic update to the configuration and datastore files already run
      • -
    -

    See Shaarli configuration for more information about Shaarli resources.

    -

    It is recommended to backup this repository before starting updating/upgrading Shaarli:

    -
      -
    • users with SSH access: copy or archive the directory to a temporary location
      • -
    • users with FTP access: download a local copy of your Shaarli installation using your favourite client
      • -
    -

    Migrating data from a previous installation

    -

    As all user data is kept under data, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps:

    -
      -
    • backup the data directory
      • -
    • install or update Shaarli: -
      • -
    • check or restore the data directory
      • -
    - -

    All tagged revisions can be downloaded as tarballs or ZIP archives from the releases page.

    -

    We recommend that you use the latest release tarball with the -full suffix. It contains the dependencies, please read Download and installation for git complete instructions.

    -

    Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the data directory!

    -

    After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to data/config.json.php (see Shaarli configuration for more details).

    -

    Upgrading with Git

    -

    Updating a community Shaarli

    -

    If you have installed Shaarli from the community Git repository, simply pull new changes from your local clone:

    -
    $ cd /path/to/shaarli
-$ git pull
-
-From github.com:shaarli/Shaarli
- * branch            master     -> FETCH_HEAD
-Updating ebd67c6..521f0e6
-Fast-forward
- application/Url.php   | 1 +
- shaarli_version.php   | 2 +-
- tests/Url/UrlTest.php | 1 +
- 3 files changed, 3 insertions(+), 1 deletion(-)
    -

    Shaarli >= v0.8.x: install/update third-party PHP dependencies using Composer:

    -
    $ composer install --no-dev
-
-Loading composer repositories with package information
-Updating dependencies
-  - Installing shaarli/netscape-bookmark-parser (v1.0.1)
-    Downloading: 100%
    -

    Migrating and upgrading from Sebsauvage's repository

    -

    If you have installed Shaarli from Sebsauvage's original Git repository, you can use Git remotes to update your working copy.

    -

    The following guide assumes that:

    -
      -
    • you have a basic knowledge of Git branching and remote repositories
      • -
    • the default remote is named origin and points to Sebsauvage's repository
      • -
    • the current branch is master -
        -
      • if you have personal branches containing customizations, you will need to rebase them after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break
        • -
      • -
    • the working copy is clean: -
        -
      • no versioned file has been locally modified
        • -
      • no untracked files are present
        • -
      • -
    -

    Step 0: show repository information

    -
    $ cd /path/to/shaarli
-
-$ git remote -v
-origin  https://github.com/sebsauvage/Shaarli (fetch)
-origin  https://github.com/sebsauvage/Shaarli (push)
-
-$ git branch -vv
-* master 029f75f [origin/master] Update README.md[](.html)
-
-$ git status
-On branch master
-Your branch is up-to-date with 'origin/master'.
-nothing to commit, working directory clean
    -

    Step 1: update Git remotes

    -
    $ git remote rename origin sebsauvage
-$ git remote -v
-sebsauvage  https://github.com/sebsauvage/Shaarli (fetch)
-sebsauvage  https://github.com/sebsauvage/Shaarli (push)
-
-$ git remote add origin https://github.com/shaarli/Shaarli
-$ git fetch origin
-
-remote: Counting objects: 3015, done.
-remote: Compressing objects: 100% (19/19), done.
-remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550
-Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done.
-Resolving deltas: 100% (1899/1899), completed with 48 local objects.
-From https://github.com/shaarli/Shaarli
- * [new branch]      master     -> origin/master[](.html)
- * [new branch]      stable     -> origin/stable[](.html)
-[...][](.html)
- * [new tag]         v0.6.4     -> v0.6.4[](.html)
- * [new tag]         v0.7.0     -> v0.7.0[](.html)
    -

    Step 2: use the stable community branch

    -
    $ git checkout origin/stable -b stable
-Branch stable set up to track remote branch stable from origin.
-Switched to a new branch 'stable'
-
-$ git branch -vv
-  master 029f75f [sebsauvage/master] Update README.md[](.html)
-* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5[](.html)
    -

    Shaarli >= v0.8.x: install/update third-party PHP dependencies using Composer:

    -
    $ composer install --no-dev
-
-Loading composer repositories with package information
-Updating dependencies
-  - Installing shaarli/netscape-bookmark-parser (v1.0.1)
-    Downloading: 100%
    -

    Optionally, you can delete information related to the legacy version:

    -
    $ git branch -D master
-Deleted branch master (was 029f75f).
-
-$ git remote remove sebsauvage
-
-$ git remote -v
-origin  https://github.com/shaarli/Shaarli (fetch)
-origin  https://github.com/shaarli/Shaarli (push)
-
-$ git gc
-Counting objects: 3317, done.
-Delta compression using up to 8 threads.
-Compressing objects: 100% (1237/1237), done.
-Writing objects: 100% (3317/3317), done.
-Total 3317 (delta 2050), reused 3301 (delta 2034)to
    -

    Step 3: configuration

    -

    After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to data/config.php (see Shaarli configuration for more details).

    -

    Troubleshooting

    -

    If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to.

    -

    You must specify an integer as a key

    -

    In v0.8.1 we changed how link keys are handled (from timestamps to incremental integers).
    -Take a look at data/updates.txt content.

    -

    updates.txt contains updateMethodDatastoreIds

    -

    Try to delete it and refresh your page while being logged in.

    -

    updates.txt doesn't exists or doesn't contain updateMethodDatastoreIds

    -
      -
    1. Create data/updates.txt if it doesn't exist.
      2. -
    2. Paste this string in the update file ;updateMethodRenameDashTags;
      3. -
    3. Login to Shaarli.
      4. -
    4. Delete the update file.
      5. -
    5. Refresh.
      6. -
    - - diff --git a/doc/Usage.html b/doc/Usage.html deleted file mode 100644 index b5855881..00000000 --- a/doc/Usage.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - Shaarli – Usage - - - - - - -

    Usage

    -

    Main features

    -

    Shaarli is intended:

    -
      -
    • to share, comment and save interesting links and news
      • -
    • to bookmark useful/frequent personal links (as private links) and share them between computers
      • -
    • as a minimal blog/microblog/writing platform (no character limit)
      • -
    • as a read-it-later list (for example items tagged readlater)
      • -
    • to draft and save articles/ideas
      • -
    • to keep code snippets
      • -
    • to keep notes and documentation
      • -
    • as a shared clipboard between machines
      • -
    • as a todo list
      • -
    • to store playlists (e.g. with the music or video tags)
      • -
    • to keep extracts/comments from webpages that may disappear
      • -
    • to keep track of ongoing discussions (for example items tagged discussion)
      • -
    • to feed RSS aggregators (planets) with specific tags
      • -
    • to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)
      • -
    -

    Using Shaarli as a blog, notepad, pastebin...

    -
      -
    • Go to your Shaarli setup and log in
      • -
    • Click the Add Link button
      • -
    • To share text only, do not enter any URL in the corresponding input field and click Add Link
      • -
    • Pick a title and enter your article, or note, in the description field; add a few tags; optionally check Private then click Save
      • -
    • Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.
      • -
    - - diff --git a/doc/Usage.md b/doc/Usage.md deleted file mode 100644 index 30ad1466..00000000 --- a/doc/Usage.md +++ /dev/null @@ -1,25 +0,0 @@ -#Usage -### Main features -Shaarli is intended: - * to share, comment and save interesting links and news - * to bookmark useful/frequent personal links (as private links) and share them between computers - * as a minimal blog/microblog/writing platform (no character limit) - * as a read-it-later list (for example items tagged `readlater`) - * to draft and save articles/ideas - * to keep code snippets - * to keep notes and documentation - * as a shared clipboard between machines - * as a todo list - * to store playlists (e.g. with the `music` or `video` tags) - * to keep extracts/comments from webpages that may disappear - * to keep track of ongoing discussions (for example items tagged `discussion`) - * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags[](.html) - * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) - -### Using Shaarli as a blog, notepad, pastebin... - - * Go to your Shaarli setup and log in - * Click the `Add Link` button - * To share text only, do not enter any URL in the corresponding input field and click `Add Link` - * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` - * Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. diff --git a/doc/Versioning-and-Branches.html b/doc/Versioning-and-Branches.html deleted file mode 100644 index 4dfe4a91..00000000 --- a/doc/Versioning-and-Branches.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - Shaarli – Versioning and Branches - - - - - - - -

    Versioning and Branches

    -

    [WORK IN PROGRESS][](.html)

    -

    It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.

    -

    master branch

    -

    The master branch is the development branch. Any new change MUST go through this branch using Pull Requests.

    -

    Remarks:

    -
      -
    • This branch shouldn't be used for production as it isn't necessary stable.
      • -
    • 3rd party aren't required to be compatible with the latest changes.
      • -
    • Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.
      • -
    • The version in this branch is always dev.
      • -
    -

    v0.x branch

    -

    This v0.x branch, points to the latest v0.x.y release.

    -

    Explanation:

    -

    When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.

    -

    In this case, the issue is fixed in the master branch, and the fix is backported the to the v0.x branch. Then a new release is made from the v0.x branch.

    -

    This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.

    -

    latest branch

    -

    This branch point the latest release. It recommended to use it to get the latest tested changes.

    -

    stable branch

    -

    The stable branch doesn't contain any major bug, and is one major digit version behind the latest release.

    -

    For example, the current latest release is v0.8.3, the stable branch is an alias to the latest v0.7.x release. When the v0.9.0 version will be released, the stable will move to the latest v0.8.x release.

    -

    Remarks:

    -
      -
    • Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.
      • -
    -

    Releases

    -

    Releases are always made from the latest v0.x branch.

    -

    Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.

    -

    Advices on 3rd party git repos workflow

    -

    Versioning

    -

    Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the changelog (Draft means not released yet) and the commit log (like tpl folder for themes)). You can either:

    -
      -
    • use the Shaarli version number, with your repo version. For example, if Shaarli v0.8.3 is released, publish a v0.8.3-1 release, where v0.8.3 states Shaarli compatibility and -1 is your own version digit for the current Shaarli version.
      • -
    • use your own versioning scheme, and state Shaarli compatibility in the release description.
      • -
    -

    Using this, any user will be able to pick the release matching his own Shaarli version.

    -

    Major bugfix backport releases

    -

    To be able to support backported fixes, it recommended to use our workflow:

    -
    # In master, fix the major bug
-git commit -m "Katastrophe"
-git push origin master
-# Get your commit hash
-git log --format="%H" -n 1
-# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)
-git checkout -b katastrophe v0.8.2-1
-# Backport the fix commit to your brand new branch
-git cherry-pick <fix commit hash>
-git push origin katastrophe
-# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`
    - - diff --git a/doc/_Footer.html b/doc/_Footer.html deleted file mode 100644 index 09473a38..00000000 --- a/doc/_Footer.html +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - Shaarli – _Footer - - - - - - -

    _Footer
    -Shaarli, the personal, minimalist, super-fast, database-free bookmarking service

    - - diff --git a/doc/_Footer.md b/doc/_Footer.md deleted file mode 100644 index 50fa4f56..00000000 --- a/doc/_Footer.md +++ /dev/null @@ -1,2 +0,0 @@ -#_Footer -_Shaarli, the personal, minimalist, super-fast, database-free bookmarking service_ diff --git a/doc/_Sidebar.html b/doc/_Sidebar.html deleted file mode 100644 index d3f94560..00000000 --- a/doc/_Sidebar.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - - Shaarli – _Sidebar - - - - - - -

    _Sidebar

    - - - diff --git a/doc/_Sidebar.md b/doc/_Sidebar.md deleted file mode 100644 index 8df2e565..00000000 --- a/doc/_Sidebar.md +++ /dev/null @@ -1,39 +0,0 @@ -#_Sidebar -- [Home](Home.html) -- Setup - - [Download and Installation](Download-and-Installation.html) - - [Upgrade and migration](Upgrade-and-migration.html) - - [Server requirements](Server-requirements.html) - - [Server configuration](Server-configuration.html) - - [Server security](Server-security.html) - - [Shaarli configuration](Shaarli-configuration.html) - - [Plugins](Plugins.html) -- [Docker](Docker.html) -- [Usage](Usage.html) - - [Sharing button](Sharing-button.html) (bookmarklet) - - [Browsing and Searching](Browsing-and-Searching.html) - - [Firefox share](Firefox-share.html) - - [RSS feeds](RSS-feeds.html) - - [REST API](REST-API.html) -- How To - - [Backup, restore, import and export](Backup,-restore,-import-and-export.html) - - [Copy an existing installation over SSH and serve it locally](Copy-an-existing-installation-over-SSH-and-serve-it-locally.html) - - [Create and serve multiple Shaarlis (farm)](Create-and-serve-multiple-Shaarlis-(farm).html) - - [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) - - [Datastore hacks](Datastore-hacks.html) -- [Troubleshooting](Troubleshooting.html) -- [Development](Development.html) - - [GnuPG signature](GnuPG-signature.html) - - [Coding guidelines](Coding-guidelines.html) - - [Directory structure](Directory-structure.html) - - [3rd party libraries](3rd-party-libraries.html) - - [Plugin System](Plugin-System.html) - - [Release Shaarli](Release-Shaarli.html) - - [Versioning and Branches](Versioning-and-Branches.html) - - [Security](Security.html) - - [Static analysis](Static-analysis.html) - - [Theming](Theming.html) - - [Unit tests](Unit-tests.html) -- About - - [FAQ](FAQ.html) - - [Community & Related software](Community-&-Related-software.html) diff --git a/doc/config.json b/doc/config.json deleted file mode 100644 index cc4de307..00000000 --- a/doc/config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "useSideMenu": true, - "lineBreaks": "gfm", - "additionalFooterText": "", - "title": "Shaarli documentation" -} \ No newline at end of file diff --git a/doc/github-markdown.css b/doc/github-markdown.css deleted file mode 100644 index 581350ae..00000000 --- a/doc/github-markdown.css +++ /dev/null @@ -1,287 +0,0 @@ -#local-sidebar { - width: 230px; - float: right; - position: relative; - z-index: 4; - background-color: #fff; - border: 1px solid #e2e2e2; - border-radius: 3px; -} - -body { - font-family: Helvetica, arial, sans-serif; - font-size: 14px; - line-height: 1.6; - padding-top: 10px; - padding-bottom: 10px; - background-color: white; - padding: 10px 20%; } - -body > *:first-child { - margin-top: 0 !important; } -body > *:last-child { - margin-bottom: 0 !important; } - -a { - color: #4183C4; } -a.absent { - color: #cc0000; } -a.anchor { - display: block; - padding-left: 30px; - margin-left: -30px; - cursor: pointer; - position: absolute; - top: 0; - left: 0; - bottom: 0; } - -h1, h2, h3, h4, h5, h6 { - margin: 20px 0 10px; - padding: 0; - font-weight: bold; - -webkit-font-smoothing: antialiased; - cursor: text; - position: relative; } - -h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { - background: url("../../images/modules/styleguide/para.png") no-repeat 10px center; - text-decoration: none; } - -h1 tt, h1 code { - font-size: inherit; } - -h2 tt, h2 code { - font-size: inherit; } - -h3 tt, h3 code { - font-size: inherit; } - -h4 tt, h4 code { - font-size: inherit; } - -h5 tt, h5 code { - font-size: inherit; } - -h6 tt, h6 code { - font-size: inherit; } - -h1 { - font-size: 28px; - color: black; } - -h2 { - font-size: 24px; - border-bottom: 1px solid #cccccc; - color: black; } - -h3 { - font-size: 18px; } - -h4 { - font-size: 16px; } - -h5 { - font-size: 14px; } - -h6 { - color: #777777; - font-size: 14px; } - -p, blockquote, ol, dl, table, pre { - margin: 15px 0; } - -hr { - background: transparent url("../../images/modules/pulls/dirty-shade.png") repeat-x 0 0; - border: 0 none; - color: #cccccc; - height: 4px; - padding: 0; } - -body > h2:first-child { - margin-top: 0; - padding-top: 0; } -body > h1:first-child { - margin-top: 0; - padding-top: 0; } - body > h1:first-child + h2 { - margin-top: 0; - padding-top: 0; } -body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { - margin-top: 0; - padding-top: 0; } - -a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { - margin-top: 0; - padding-top: 0; } - -h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { - margin-top: 0; } - -li p.first { - display: inline-block; } - -ul, ol { - padding-left: 30px; } - -ul :first-child, ol :first-child { - margin-top: 0; } - -ul :last-child, ol :last-child { - margin-bottom: 0; } - -dl { - padding: 0; } - dl dt { - font-size: 14px; - font-weight: bold; - font-style: italic; - padding: 0; - margin: 15px 0 5px; } - dl dt:first-child { - padding: 0; } - dl dt > :first-child { - margin-top: 0; } - dl dt > :last-child { - margin-bottom: 0; } - dl dd { - margin: 0 0 15px; - padding: 0 15px; } - dl dd > :first-child { - margin-top: 0; } - dl dd > :last-child { - margin-bottom: 0; } - -blockquote { - border-left: 4px solid #dddddd; - padding: 0 15px; - color: #777777; } - blockquote > :first-child { - margin-top: 0; } - blockquote > :last-child { - margin-bottom: 0; } - -table { - padding: 0; } - table tr { - border-top: 1px solid #cccccc; - background-color: white; - margin: 0; - padding: 0; } - table tr:nth-child(2n) { - background-color: #f8f8f8; } - table tr th { - font-weight: bold; - border: 1px solid #cccccc; - text-align: left; - margin: 0; - padding: 6px 13px; } - table tr td { - border: 1px solid #cccccc; - text-align: left; - margin: 0; - padding: 6px 13px; } - table tr th :first-child, table tr td :first-child { - margin-top: 0; } - table tr th :last-child, table tr td :last-child { - margin-bottom: 0; } - -img { - max-width: 100%; } - -span.frame { - display: block; - overflow: hidden; } - span.frame > span { - border: 1px solid #dddddd; - display: block; - float: left; - overflow: hidden; - margin: 13px 0 0; - padding: 7px; - width: auto; } - span.frame span img { - display: block; - float: left; } - span.frame span span { - clear: both; - color: #333333; - display: block; - padding: 5px 0 0; } -span.align-center { - display: block; - overflow: hidden; - clear: both; } - span.align-center > span { - display: block; - overflow: hidden; - margin: 13px auto 0; - text-align: center; } - span.align-center span img { - margin: 0 auto; - text-align: center; } -span.align-right { - display: block; - overflow: hidden; - clear: both; } - span.align-right > span { - display: block; - overflow: hidden; - margin: 13px 0 0; - text-align: right; } - span.align-right span img { - margin: 0; - text-align: right; } -span.float-left { - display: block; - margin-right: 13px; - overflow: hidden; - float: left; } - span.float-left span { - margin: 13px 0 0; } -span.float-right { - display: block; - margin-left: 13px; - overflow: hidden; - float: right; } - span.float-right > span { - display: block; - overflow: hidden; - margin: 13px auto 0; - text-align: right; } - -code, tt { - margin: 0 2px; - padding: 0 5px; - white-space: nowrap; - border: 1px solid #eaeaea; - background-color: #f8f8f8; - border-radius: 3px; } - -pre code { - margin: 0; - padding: 0; - white-space: pre; - border: none; - background: transparent; } - -.highlight pre { - background-color: #f8f8f8; - border: 1px solid #cccccc; - font-size: 13px; - line-height: 19px; - overflow: auto; - padding: 6px 10px; - border-radius: 3px; } - -pre { - background-color: #f8f8f8; - border: 1px solid #cccccc; - font-size: 13px; - line-height: 19px; - overflow: auto; - padding: 6px 10px; - border-radius: 3px; } - pre code, pre tt { - background-color: transparent; - border: none; } diff --git a/doc/3rd-party-libraries.md b/doc/md/3rd-party-libraries.md similarity index 73% rename from doc/3rd-party-libraries.md rename to doc/md/3rd-party-libraries.md index e6370549..ebab7a46 100644 --- a/doc/3rd-party-libraries.md +++ b/doc/md/3rd-party-libraries.md @@ -1,14 +1,13 @@ -#3rd party libraries ## CSS -- Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/)[](.html) +- Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/) - resets default CSS properties for all HTML elements (overriding browsers' default values) - ensures custom CSS stylessheets will provide the same results on all browsers ## Javascript -- [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms[](.html) -- [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails[](.html) -- [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation[](.html) +- [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms +- [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails +- [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation ## PHP -- [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser[](.html) -- [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP[](.html) +- [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser +- [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP diff --git a/doc/Backup,-restore,-import-and-export.md b/doc/md/Backup,-restore,-import-and-export.md similarity index 56% rename from doc/Backup,-restore,-import-and-export.md rename to doc/md/Backup,-restore,-import-and-export.md index 9f5598ef..89724857 100644 --- a/doc/Backup,-restore,-import-and-export.md +++ b/doc/md/Backup,-restore,-import-and-export.md @@ -1,12 +1,3 @@ -#Backup, restore, import and export - * [Backup and restore the datastore file](#backup-and-restore-the-datastore-file)[](.html) - * [Export links as...](#export-links-as)[](.html) - * [Import links from...](#import-links-from)[](.html) - * [Import Shaarli links to Firefox](#import-shaarli-links-to-firefox)[](.html) - - ----------------------- - ## Backup and restore the datastore file Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place. @@ -19,12 +10,14 @@ rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date + ## Export links as... To export links as an HTML file, under _Tools > Export_, choose: + - _Export all_ to export both public and private links - _Export public_ to export public links only - _Export private_ to export private links only Restore by using the `Import` feature. -* This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool.[](.html) + +- This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. Example command: ```bash @@ -33,34 +26,35 @@ Example command: ## Import links from... - ### Diigo If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) - ### Mister Wong -See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks.[](.html) +See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks. ### SemanticScuttle -To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase).[](.html) +To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase). ### Scuttle -Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.[](.html) +Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). + +However, you can use the third-party [scuttle-to-shaarli](https://github.com/q2apro/scuttle-to-shaarli) +tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer. ## Import Shaarli links to Firefox - * Export your Shaarli links as described above. - * For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)` - * In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`) - * Select `Import and Backup > Import bookmarks in HTML format` +- Export your Shaarli links as described above. + - For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)` +- In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`) +- Select `Import and Backup > Import bookmarks in HTML format` Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time. You may be interested in these Firefox addons to manage links imported from Shaarli - * [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks[](.html) - * [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags[](.html) +- [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks +- [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags diff --git a/doc/md/Bookmarklet.md b/doc/md/Bookmarklet.md new file mode 100644 index 00000000..e53e3261 --- /dev/null +++ b/doc/md/Bookmarklet.md @@ -0,0 +1,29 @@ +## Add the sharing button (_bookmarklet_) to your browser + +- Open your Shaarli and `Login` +- Click the `Tools` button in the top bar +- Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. + +_This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ + +![](images/bookmarklet.png) + +## Share links using the _bookmarklet_ + +- When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. +- A window opens. + - You can freely edit title, description, tags... to find it later using the text search or tag filtering. + - You will be able to edit this link later using the ![](https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button. + - You can also check the “Private” box so that the link is saved but only visible to you. +- Click `Save`.**Voilà! Your link is now shared.** + +## Troubleshooting: The bookmarklet doesn't work with a few websites (e.g. Github.com) + +Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. + +See [#196](https://github.com/shaarli/Shaarli#196). + +There is an open bug for both Firefox and Chromium: + +- https://bugzilla.mozilla.org/show_bug.cgi?id=866522 +- https://code.google.com/p/chromium/issues/detail?id=233903 diff --git a/doc/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md similarity index 83% rename from doc/Browsing-and-searching.md rename to doc/md/Browsing-and-searching.md index 854b6b60..35707482 100644 --- a/doc/Browsing-and-searching.md +++ b/doc/md/Browsing-and-searching.md @@ -1,8 +1,3 @@ -#Browsing and searching -# Browsing and Searching - -![(http://pix.toile-libre.org/upload/original/1455571378.png)]((http://pix.toile-libre.org/upload/original/1455571378.png).html) - ## Plain text search Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) @@ -25,4 +20,4 @@ To search for links that are not tagged, enter `""` in the tag search field. ## Filtering RSS feeds/Picture wall -RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds.html). +RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS feeds). diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md new file mode 100644 index 00000000..8edbeefa --- /dev/null +++ b/doc/md/Community-&-Related-software.md @@ -0,0 +1,67 @@ +_Unofficial but related work on Shaarli. If you maintain one of these, +please get in touch with us to help us find a way to adapt your work to our fork._ + +## Community +- [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli +- [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html) +- [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) +- [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) +- [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ +- [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) +- [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) +- [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) +- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni) + + +### Articles and social media discussions +- 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 +- 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/) +- 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 +- 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/) + + +### REST API clients +See [REST API](REST-API) for a list of official and community clients. + + +### Third party plugins +- [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown. +- [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter. +- [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli. +- [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli. +- [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support +- [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli. +- [related](https://github.com/ilesinge/shaarli-related) by [@ilesinge](https://github.com/ilesinge) - Show related links based on the number of identical tags. +- [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks. +- [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli + + +### Third-party themes +See [Theming](Theming) for a list of community-contributed themes, and an installation guide. + + +## Integration with other platforms +- [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [Tiny-Tiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli +- [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar +- [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle + + +### Mobile Apps +- [ShaarliOS](https://github.com/mro/ShaarliOS) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes, +- [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider +- [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli + + +### Server apps +- [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content +- [shaarli-river](https://github.com/mknexen/shaarli-river) - An aggregator for shaarlis with many features +- [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among French shaarliers: [shaarli.fr](http://shaarli.fr/)) +- [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis +- [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli +- [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming). +- [Bookmark Archiver](https://github.com/pirate/bookmark-archiver) - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. + + +## Alternatives to Shaarli +See the [bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing) +section on [awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted/). diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md new file mode 100644 index 00000000..4bd7a0ba --- /dev/null +++ b/doc/md/Continuous-integration-tools.md @@ -0,0 +1,28 @@ +## Local development +A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: + +- Documentation - generate a local HTML copy of the GitHub wiki +- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions +- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits + +## Automatic builds +[Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: + +- each time a commit is merged to the mainline (`master` branch) +- each time a Pull Request is submitted or updated + +A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). + +Each build job: + +- updates Composer +- installs 3rd-party test dependencies with Composer +- runs [Unit tests](Unit tests) + +After all jobs have finished, Travis returns the results to GitHub: + +- a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) +- Pull Requests are updated with the Travis result + - Green: all tests have passed + - Red: some tests failed + - Orange: tests are pending diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md new file mode 100644 index 00000000..532ec2e4 --- /dev/null +++ b/doc/md/Development-guidelines.md @@ -0,0 +1,10 @@ +## Development guidelines + +Please have a look at the following pages: + +- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) +- [Static analysis](Static analysis) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: + - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard + - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide +- [Unit tests](Unit tests) +- [GnuPG signature](GnuPG signature) for tags/releases diff --git a/doc/Directory-structure.md b/doc/md/Directory-structure.md similarity index 98% rename from doc/Directory-structure.md rename to doc/md/Directory-structure.md index 3a1c4309..eb50965b 100644 --- a/doc/Directory-structure.md +++ b/doc/md/Directory-structure.md @@ -1,4 +1,5 @@ -#Directory structure +TODO: This page is out of date + Here is the directory structure of Shaarli and the purpose of the different files: ```bash diff --git a/doc/Download-and-Installation.md b/doc/md/Download-and-Installation.md similarity index 54% rename from doc/Download-and-Installation.md rename to doc/md/Download-and-Installation.md index 970144a5..135f0633 100644 --- a/doc/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -1,41 +1,43 @@ -#Download and Installation -# Get Shaarli! +To install Shaarli, simply place the files in a directory under your webserver's +Document Root (or directly at the document root). -To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration).[](.html) +Also, please make sure your server meets the [requirements](Server-requirements) +and is properly [configured](Server-configuration). Several releases are available: --------------------------------------------------------- +- by downloading full release archives including all dependencies +- by downloading Github archives +- by cloning the Git repository + +--- ## Latest release (recommended) ### Download as an archive -Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) +Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. **Download our *shaarli-full* archive** to include dependencies. -The current latest released version is `v0.8.4` +The current latest released version is `v0.9.0` Or in command lines: ```bash -$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip -$ unzip shaarli-v0.8.4-full.zip +$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.0/shaarli-v0.9.0-full.zip +$ unzip shaarli-v0.9.0-full.zip $ mv Shaarli /path/to/shaarli/ ``` -| ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|[](.html) -|-----|--------------------------| +In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| ### Using git ``` -mkdir -p /path/to/shaarli && cd /path/to/shaarli/ -git clone -b v0.8 https://github.com/shaarli/Shaarli.git . -composer install --no-dev +$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ +$ git clone -b v0.9 https://github.com/shaarli/Shaarli.git . +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Stable version The stable version has been experienced by Shaarli users, and will receive security updates. @@ -60,17 +62,15 @@ $ mv Shaarli-stable /path/to/shaarli/ ### Clone with Git -[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.[](.html) +[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. ```bash $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli/ -$ composer install --no-dev +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Development version (mainline) _Use at your own risk!_ @@ -82,21 +82,17 @@ To get the latest changes from the `master` branch: $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli -$ composer install --no-dev +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Finish Installation Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. -![install screenshot](http://i.imgur.com/wuMpDSN.png)[](.html) +![install screenshot](http://i.imgur.com/wuMpDSN.png) Setup your Shaarli installation, and it's ready to use! --------------------------------------------------------- - ## Updating Shaarli -See [Upgrade and Migration](Upgrade-and-migration)[](.html) +See [Upgrade and Migration](Upgrade-and-migration) diff --git a/doc/FAQ.md b/doc/md/FAQ.md similarity index 73% rename from doc/FAQ.md rename to doc/md/FAQ.md index 4c69763f..77faf117 100644 --- a/doc/FAQ.md +++ b/doc/md/FAQ.md @@ -1,7 +1,6 @@ -#FAQ ### Why did you create Shaarli ? -I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page).[](.html) +I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page). Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server. @@ -9,35 +8,36 @@ Enough is enough. Saving simple links should not be a complicated heavy thing. I With Shaarli: -* The data is yours: It's hosted on your server. -* Never fear of having your data locked-in. -* Never fear to have your data sold to third party. -* Your private links are not hosted on a third party server. -* You are not tracked by browser addons (like Diigo does) -* You can change the look and feel of the pages if you want. -* You can change the behaviour of the program. -* It's magnitude faster than most bookmarking services. +- The data is yours: It's hosted on your server. +- Never fear of having your data locked-in. +- Never fear to have your data sold to third party. +- Your private links are not hosted on a third party server. +- You are not tracked by browser addons (like Diigo does) +- You can change the look and feel of the pages if you want. +- You can change the behaviour of the program. +- It's magnitude faster than most bookmarking services. ### What does Shaarli mean? -Shaarli is for shaaring your links. +Shaarli stands for _shaaring_ your _links_. ### My Shaarli is broken! -First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements).[](.html) +First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements). If everything looks right but the issue(s) remain(s), please: -- take a look at the [troubleshooting](Troubleshooting) section[](.html) -- come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-)[](.html) -- browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls)[](.html) + +- take a look at the [troubleshooting](Troubleshooting) section +- come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-) +- browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls) - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) - - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem:[](.html) + - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem: - _what happens?_ - display glitches, invalid data, security flaws... - _what is your configuration?_ - OS, server version, activated extensions, web browser... - _is it reproducible?_ ### Why not use a real database? Files are slow! -Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too.[](.html) +Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too. It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why? diff --git a/doc/md/Features.md b/doc/md/Features.md new file mode 100644 index 00000000..eef88d03 --- /dev/null +++ b/doc/md/Features.md @@ -0,0 +1,25 @@ +### Main features +Shaarli is intended: + +- to share, comment and save interesting links and news +- to bookmark useful/frequent personal links (as private links) and share them between computers +- as a minimal blog/microblog/writing platform (no character limit) +- as a read-it-later list (for example items tagged `readlater`) +- to draft and save articles/ideas +- to keep code snippets +- to keep notes and documentation +- as a shared clipboard between machines +- as a todo list +- to store playlists (e.g. with the `music` or `video` tags) +- to keep extracts/comments from webpages that may disappear +- to keep track of ongoing discussions (for example items tagged `discussion`) +- [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags +- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) + +### Using Shaarli as a blog, notepad, pastebin... + +- Go to your Shaarli setup and log in +- Click the `Add Link` button +- To share text only, do not enter any URL in the corresponding input field and click `Add Link` +- Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` +- Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md new file mode 100644 index 00000000..878884a4 --- /dev/null +++ b/doc/md/Firefox-share.md @@ -0,0 +1,17 @@ +### Add Shaarli as a sharing service to Firefox + +- Open your Shaarli and `Login` +- Click the `Tools` button in the top bar +- Click the `✚Add to Firefox social` button and accept the activation. + + +### Sharing links using Firefox share + +- Add the sharing service as described above +- When you are visiting a webpage you would like to share with Shaarli, + click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) +- You can edit your link before and after saving, just like the bookmarklet above. + +_Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) +enabled server for Firefox Share to work. Firefox Share will not work over +plain HTTP connections._ diff --git a/doc/GnuPG-signature.md b/doc/md/GnuPG-signature.md similarity index 83% rename from doc/GnuPG-signature.md rename to doc/md/GnuPG-signature.md index b0028d55..d1fc10a5 100644 --- a/doc/GnuPG-signature.md +++ b/doc/md/GnuPG-signature.md @@ -1,27 +1,28 @@ -#GnuPG signature ## Introduction ### PGP and GPG -[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good [](.html) -Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication, -signature and encryption. +[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the +[Pretty Good Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) +(OpenPGP) specification. Its main purposes are digital authentication, signature and encryption. -It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify:[](.html) -- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master [](.html) +It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify: + +- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master Keys](https://www.archlinux.org/master-keys/) -- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity[](.html) +- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity ### Trust -To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/):[](.html) +To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/): > You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated. -Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see:[](.html) -- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html)[](.html) -- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html) +Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see: + +- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html) +- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust) ## Generate a GPG key -- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)[](.html) -- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)[](.html) +- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow) +- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub) ### gpg - provide identity information ```bash @@ -62,7 +63,7 @@ gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u pub rsa2048/A9D53A3E 2015-07-31 Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E -uid [ultimate] Marvin the Paranoid Android [](.html) +uid [ultimate] Marvin the Paranoid Android sub rsa2048/8C0EACF1 2015-07-31 ``` @@ -74,4 +75,4 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu ## Create and push a GPG-signed tag -See [Release Shaarli](Release-Shaarli.html). +See [Release Shaarli](Release Shaarli). diff --git a/doc/Plugin-System.md b/doc/md/Plugin-System.md similarity index 68% rename from doc/Plugin-System.md rename to doc/md/Plugin-System.md index addd792d..30f0ae74 100644 --- a/doc/Plugin-System.md +++ b/doc/md/Plugin-System.md @@ -1,7 +1,8 @@ -#Plugin System -[**I am a developer.** Developer API.](#developer-api)[](.html) +[**I am a developer: ** Developer API](#developer-api) -[**I am a template designer.** Guide for template designer.](#guide-for-template-designer)[](.html) +[**I am a template designer: ** Guide for template designers](#guide-for-template-designer) + +--- ## Developer API @@ -9,9 +10,9 @@ The plugin system let you: - * insert content into specific places across templates. - * alter data before templates rendering. - * alter data before saving new links. +- insert content into specific places across templates. +- alter data before templates rendering. +- alter data before saving new links. ### How can I create a plugin for Shaarli? @@ -48,8 +49,8 @@ hook__($data, $conf) Parameters: - - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data)[](.html) - - conf: the `ConfigManager` instance. +- data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data) +- conf: the `ConfigManager` instance. For exemple, if my plugin want to add data to the header, this function is needed: @@ -76,9 +77,9 @@ RainTPL displays every element contained in the placeholder's array. These eleme For example, let's add a value in the placeholder `top_placeholder` which is displayed at the top of my page: ```php -$data['top_placeholder'[] = 'My content';](]-=-'My-content';.html) +$data['top_placeholder'][] = 'My content'; # OR -array_push($data['top_placeholder'], 'My', 'content');[](.html) +array_push($data['top_placeholder'], 'My', 'content'); return $data; ``` @@ -93,9 +94,9 @@ For exemple, in linklist, it is possible to alter every title: ```php // mind the reference if you want $data to be altered -foreach ($data['links'] as &$value) {[](.html) +foreach ($data['links'] as &$value) { // String reverse every title. - $value['title'] = strrev($value['title']);[](.html) + $value['title'] = strrev($value['title']); } return $data; @@ -107,9 +108,9 @@ Every plugin needs a `.meta` file, which is in fact an `.ini` file Each file contain two keys: - * `description`: plugin description - * `parameters`: user parameter names, separated by a `;`. - * `parameter.`: add a text description the specified parameter. +- `description`: plugin description +- `parameters`: user parameter names, separated by a `;`. +- `parameter.`: add a text description the specified parameter. > Note: In PHP, `parse_ini_file()` seems to want strings to be between by quotes `"` in the ini file. @@ -117,25 +118,25 @@ Each file contain two keys: Use `demo_plugin` as a functional example. It covers most of the plugin system features. -If it's still not working, please [open an issue](https://github.com/shaarli/Shaarli/issues/new).[](.html) +If it's still not working, please [open an issue](https://github.com/shaarli/Shaarli/issues/new). ### Hooks | Hooks | Description | | ------------- |:-------------:| -| [render_header](#render_header) | Allow plugin to add content in page headers. |[](.html) -| [render_includes](#render_includes) | Allow plugin to include their own CSS files. |[](.html) -| [render_footer](#render_footer) | Allow plugin to add content in page footer and include their own JS files. | [](.html) -| [render_linklist](#render_linklist) | It allows to add content at the begining and end of the page, after every link displayed and to alter link data. |[](.html) -| [render_editlink](#render_editlink) | Allow to add fields in the form, or display elements. |[](.html) -| [render_tools](#render_tools) | Allow to add content at the end of the page. |[](.html) -| [render_picwall](#render_picwall) | Allow to add content at the top and bottom of the page. |[](.html) -| [render_tagcloud](#render_tagcloud) | Allow to add content at the top and bottom of the page, and after all tags. |[](.html) -| [render_taglist](#render_taglist) | Allow to add content at the top and bottom of the page, and after all tags. |[](.html) -| [render_daily](#render_daily) | Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. |[](.html) -| [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. |[](.html) -| [save_link](#save_link) | Allow to alter the link being saved in the datastore. |[](.html) -| [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. |[](.html) +| [render_header](#render_header) | Allow plugin to add content in page headers. | +| [render_includes](#render_includes) | Allow plugin to include their own CSS files. | +| [render_footer](#render_footer) | Allow plugin to add content in page footer and include their own JS files. | +| [render_linklist](#render_linklist) | It allows to add content at the begining and end of the page, after every link displayed and to alter link data. | +| [render_editlink](#render_editlink) | Allow to add fields in the form, or display elements. | +| [render_tools](#render_tools) | Allow to add content at the end of the page. | +| [render_picwall](#render_picwall) | Allow to add content at the top and bottom of the page. | +| [render_tagcloud](#render_tagcloud) | Allow to add content at the top and bottom of the page, and after all tags. | +| [render_taglist](#render_taglist) | Allow to add content at the top and bottom of the page, and after all tags. | +| [render_daily](#render_daily) | Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. | +| [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | +| [save_link](#save_link) | Allow to alter the link being saved in the datastore. | +| [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | @@ -149,24 +150,24 @@ Allow plugin to add content in page headers. `$data` is an array containing: - * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). - * `_LOGGEDIN_`: true if user is logged in, false otherwise. +- `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). +- `_LOGGEDIN_`: true if user is logged in, false otherwise. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `buttons_toolbar`: after the list of buttons in the header. +- `buttons_toolbar`: after the list of buttons in the header. -![buttons_toolbar_example](http://i.imgur.com/ssJUOrt.png)[](.html) +![buttons_toolbar_example](http://i.imgur.com/ssJUOrt.png) - * `fields_toolbar`: after search fields in the header. +- `fields_toolbar`: after search fields in the header. > Note: This will only be called in linklist. -![fields_toolbar_example](http://i.imgur.com/3GMifI2.png)[](.html) +![fields_toolbar_example](http://i.imgur.com/3GMifI2.png) #### render_includes @@ -178,16 +179,16 @@ Allow plugin to include their own CSS files. `$data` is an array containing: - * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). - * `_LOGGEDIN_`: true if user is logged in, false otherwise. +- `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). +- `_LOGGEDIN_`: true if user is logged in, false otherwise. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `css_files`: called after loading default CSS. +- `css_files`: called after loading default CSS. > Note: only add the path of the CSS file. E.g: `plugins/demo_plugin/custom_demo.css`. @@ -201,21 +202,21 @@ Allow plugin to add content in page footer and include their own JS files. `$data` is an array containing: - * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). - * `_LOGGEDIN_`: true if user is logged in, false otherwise. +- `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). +- `_LOGGEDIN_`: true if user is logged in, false otherwise. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `text`: called after the end of the footer text. - * `endofpage`: called at the end of the page. +- `text`: called after the end of the footer text. +- `endofpage`: called at the end of the page. -![text_example](http://i.imgur.com/L5S2YEH.png)[](.html) +![text_example](http://i.imgur.com/L5S2YEH.png) - * `js_files`: called at the end of the page, to include custom JS scripts. +- `js_files`: called at the end of the page, to include custom JS scripts. > Note: only add the path of the JS file. E.g: `plugins/demo_plugin/custom_demo.js`. @@ -229,30 +230,30 @@ It allows to add content at the begining and end of the page, after every link d `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * All templates data, including links. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- All templates data, including links. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `action_plugin`: next to the button "private only" at the top and bottom of the page. +- `action_plugin`: next to the button "private only" at the top and bottom of the page. -![action_plugin_example](http://i.imgur.com/Q12PWg0.png)[](.html) +![action_plugin_example](http://i.imgur.com/Q12PWg0.png) - * `link_plugin`: for every link, between permalink and link URL. +- `link_plugin`: for every link, between permalink and link URL. -![link_plugin_example](http://i.imgur.com/3oDPhWx.png)[](.html) +![link_plugin_example](http://i.imgur.com/3oDPhWx.png) - * `plugin_start_zone`: before displaying the template content. +- `plugin_start_zone`: before displaying the template content. -![plugin_start_zone_example](http://i.imgur.com/OVBkGy3.png)[](.html) +![plugin_start_zone_example](http://i.imgur.com/OVBkGy3.png) - * `plugin_end_zone`: after displaying the template content. +- `plugin_end_zone`: after displaying the template content. -![plugin_end_zone_example](http://i.imgur.com/6IoRuop.png)[](.html) +![plugin_end_zone_example](http://i.imgur.com/6IoRuop.png) #### render_editlink @@ -264,17 +265,17 @@ Allow to add fields in the form, or display elements. `$data` is an array containing: - * All templates data. +- All templates data. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `edit_link_plugin`: after tags field. +- `edit_link_plugin`: after tags field. -![edit_link_plugin_example](http://i.imgur.com/5u17Ens.png)[](.html) +![edit_link_plugin_example](http://i.imgur.com/5u17Ens.png) #### render_tools @@ -286,17 +287,17 @@ Allow to add content at the end of the page. `$data` is an array containing: - * All templates data. +- All templates data. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `tools_plugin`: at the end of the page. +- `tools_plugin`: at the end of the page. -![tools_plugin_example](http://i.imgur.com/Bqhu9oQ.png)[](.html) +![tools_plugin_example](http://i.imgur.com/Bqhu9oQ.png) #### render_picwall @@ -308,20 +309,19 @@ Allow to add content at the top and bottom of the page. `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * All templates data. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- All templates data. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `plugin_start_zone`: before displaying the template content. +- `plugin_start_zone`: before displaying the template content. +- `plugin_end_zone`: after displaying the template content. - * `plugin_end_zone`: after displaying the template content. - -![plugin_start_end_zone_example](http://i.imgur.com/tVTQFER.png)[](.html) +![plugin_start_end_zone_example](http://i.imgur.com/tVTQFER.png) #### render_tagcloud @@ -333,24 +333,23 @@ Allow to add content at the top and bottom of the page. `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * All templates data. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- All templates data. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `plugin_start_zone`: before displaying the template content. - - * `plugin_end_zone`: after displaying the template content. +- `plugin_start_zone`: before displaying the template content. +- `plugin_end_zone`: after displaying the template content. For each tag, the following placeholder can be used: - * `tag_plugin`: after each tag +- `tag_plugin`: after each tag -![plugin_start_end_zone_example](http://i.imgur.com/vHmyT3a.png)[](.html) +![plugin_start_end_zone_example](http://i.imgur.com/vHmyT3a.png) #### render_taglist @@ -363,22 +362,21 @@ Allow to add content at the top and bottom of the page. `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * All templates data. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- All templates data. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `plugin_start_zone`: before displaying the template content. - - * `plugin_end_zone`: after displaying the template content. +- `plugin_start_zone`: before displaying the template content. +- `plugin_end_zone`: after displaying the template content. For each tag, the following placeholder can be used: - * `tag_plugin`: after each tag +- `tag_plugin`: after each tag #### render_daily @@ -390,22 +388,21 @@ Allow to add content at the top and bottom of the page, the bottom of each link `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * All templates data, including links. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- All templates data, including links. ##### Template placeholders -Items can be displayed in templates by adding an entry in `$data['']` array.[](.html) +Items can be displayed in templates by adding an entry in `$data['']` array. List of placeholders: - * `link_plugin`: used at bottom of each link. +- `link_plugin`: used at bottom of each link. -![link_plugin_example](http://i.imgur.com/hzhMfSZ.png)[](.html) +![link_plugin_example](http://i.imgur.com/hzhMfSZ.png) - * `plugin_start_zone`: before displaying the template content. - - * `plugin_end_zone`: after displaying the template content. +- `plugin_start_zone`: before displaying the template content. +- `plugin_end_zone`: after displaying the template content. #### render_feed @@ -417,21 +414,21 @@ Allow to add tags in the feed, either in the header or for each items. Items (li `$data` is an array containing: - * `_LOGGEDIN_`: true if user is logged in, false otherwise. - * `_PAGE_`: containing either `rss` or `atom`. - * All templates data, including links. +- `_LOGGEDIN_`: true if user is logged in, false otherwise. +- `_PAGE_`: containing either `rss` or `atom`. +- All templates data, including links. ##### Template placeholders -Tags can be added in feeds by adding an entry in `$data['']` array.[](.html) +Tags can be added in feeds by adding an entry in `$data['']` array. List of placeholders: - * `feed_plugins_header`: used as a header tag in the feed. +- `feed_plugins_header`: used as a header tag in the feed. For each links: - * `feed_plugins`: additional tag for every link entry. +- `feed_plugins`: additional tag for every link entry. #### save_link @@ -443,15 +440,15 @@ Allow to alter the link being saved in the datastore. `$data` is an array containing the link being saved: - * id - * title - * url - * shorturl - * description - * private - * tags - * created - * updated +- id +- title +- url +- shorturl +- description +- private +- tags +- created +- updated #### delete_link @@ -464,15 +461,15 @@ Allow to execute any action before the link is actually removed from the datasto `$data` is an array containing the link being saved: - * id - * title - * url - * shorturl - * description - * private - * tags - * created - * updated +- id +- title +- url +- shorturl +- description +- private +- tags +- created +- updated ## Guide for template designer @@ -486,9 +483,9 @@ Use the default one as an example. Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include `plugin_admin.js`, only if: - * you're using a table. - * you call orderUp() and orderUp() onclick on arrows. - * you add data-line and data-order to your rows. +- you're using a table. +- you call orderUp() and orderUp() onclick on arrows. +- you add data-line and data-order to your rows. Otherwise, you can use your own JS as long as this field is send by the form: diff --git a/doc/Plugins.md b/doc/md/Plugins.md similarity index 81% rename from doc/Plugins.md rename to doc/md/Plugins.md index e3192a60..7d40637f 100644 --- a/doc/Plugins.md +++ b/doc/md/Plugins.md @@ -1,13 +1,12 @@ -#Plugins ## Plugin installation There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. If you want to install a third party plugin: - * Download it. - * Put it in the `plugins` directory in Shaarli's installation folder. - * Make sure you put it correctly: +- Download it. +- Put it in the `plugins` directory in Shaarli's installation folder. +- Make sure you put it correctly: ``` | index.php @@ -26,7 +25,7 @@ In Shaarli's administration page (`Tools` link), go to `Plugin administration`. Here you can enable and disable all plugins available, and configure them. -![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67)[](.html) +![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67) ## Plugin order @@ -41,14 +40,14 @@ This is important in case plugins are depending on each other. Read plugins READ Enabled plugin are stored in your `config.php` parameters file, under the `array`: ```php -$GLOBALS['config'['ENABLED_PLUGINS']]('ENABLED_PLUGINS'].html) +$GLOBALS['config']['ENABLED_PLUGINS'] ``` You can edit them manually here. Example: ```php -$GLOBALS['config'['ENABLED_PLUGINS'] = array(]('ENABLED_PLUGINS']-=-array(.html) +$GLOBALS['config']['ENABLED_PLUGINS'] = array( 'qrcode', 'archiveorg', 'wallabag', @@ -64,13 +63,13 @@ Usage of each plugin is documented in it's README file: * `addlink-toolbar`: Adds the addlink input on the linklist page * `archiveorg`: For each link, add an Archive.org icon - * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax.[](.html) - * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos.[](.html) + * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. + * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. * `qrcode`: For each link, add a QRCode icon. - * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance.[](.html) + * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. #### Third party plugins -See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins)[](.html) +See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins) diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md new file mode 100644 index 00000000..68a83c00 --- /dev/null +++ b/doc/md/REST-API.md @@ -0,0 +1,153 @@ +## Usage and Prerequisites + +See the [REST API documentation](http://shaarli.github.io/api-documentation/) +for a list of available endpoints and parameters. + +Please ensure that your server meets the [requirements](Server-requirements) +and is properly [configured](Server-configuration): + +- URL rewriting is enabled (see specific Apache and Nginx sections) +- the server's timezone is properly defined +- the server's clock is synchronized with + [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol) + +The host where the API client is invoked should also be synchronized with NTP, +see [token expiration](#payload). + +## Authentication + +All requests to Shaarli's API must include a JWT token to verify their authenticity. + +This token has to be included as an HTTP header called `Authentication: Bearer `. + +JWT resources : + +- [jwt.io](https://jwt.io) (including a list of client per language). +- RFC : https://tools.ietf.org/html/rfc7519 +- https://float-middle.com/json-web-tokens-jwt-vs-sessions/ +- HackerNews thread: https://news.ycombinator.com/item?id=11929267 + + +### Shaarli JWT Token + +JWT tokens are composed by three parts, separated by a dot `.` and encoded in base64: + +``` +[header].[payload].[signature] +``` + +#### Header + +Shaarli only allow one hash algorithm, so the header will always be the same: + +```json +{ + "typ": "JWT", + "alg": "HS512" +} +``` + +Encoded in base64, it gives: + +``` +ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ== +``` + +#### Payload + +**Token expiration** + +To avoid infinite token validity, JWT tokens must include their creation date +in UNIX timestamp format (timezone independent - UTC) under the key `iat` (issued at). +This token will be valid during **9 minutes**. + +```json +{ + "iat": 1468663519 +} +``` + +See [RFC reference](https://tools.ietf.org/html/rfc7519#section-4.1.6). + + +#### Signature + +The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot `.`, hashed in SHA512 with the API secret available in Shaarli administration page. + +Signature example with PHP: + +```php +$content = base64_encode($header) . '.' . base64_encode($payload); +$signature = hash_hmac('sha512', $content, $secret); +``` + + +## Clients and examples +### Android, Java, Kotlin + +- [Android client example with Kotlin](https://gitlab.com/snippets/1665808) + by [Braincoke](https://github.com/Braincoke) + +### Javascript, NodeJS + +- [shaarli-client](https://www.npmjs.com/package/shaarli-client) + ([source code](https://github.com/laBecasse/shaarli-client)) + by [laBecasse](https://github.com/laBecasse) + +### PHP + +This example uses the [PHP cURL](http://php.net/manual/en/book.curl.php) library. + +```php +" [ultimate][](.html) +gpg: Good signature from "VirtualTam " [ultimate] ``` ## Publish the GitHub release ### Update release badges -Update `README.md` so version badges display and point to the newly released Shaarli version(s). +Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch. ### Create a GitHub release from a Git tag From the previously drafted release: + - edit the release notes (if needed) - specify the appropriate Git tag - publish the release @@ -115,19 +116,40 @@ From the previously drafted release: ### Generate and upload all-in-one release archives Users with a shared hosting may have: + - no SSH access - no possibility to install PHP packages or server extensions - no possibility to run scripts To ease Shaarli installations, it is possible to generate and upload additional release archives, -that will contain Shaarli code plus all required third-party libraries: +that will contain Shaarli code plus all required third-party libraries. + +**From the `v0.5` branch:** ```bash $ make release_archive ``` This will create the following archives: + - `shaarli-vX.Y.Z-full.tar` - `shaarli-vX.Y.Z-full.zip` The archives need to be manually uploaded on the previously created GitHub release. + +### Update `stable` and `latest` branches + +``` +$ git checkout latest +# latest release +$ git merge v0.5.0 +# fix eventual conflicts +$ make test +$ git push upstream latest +$ git checkout stable +# latest previous major +$ git merge v0.4.5 +# fix eventual conflicts +$ make test +$ git push upstream stable +``` diff --git a/doc/Security.md b/doc/md/Security.md similarity index 57% rename from doc/Security.md rename to doc/md/Security.md index 7947460c..36f629af 100644 --- a/doc/Security.md +++ b/doc/md/Security.md @@ -1,28 +1,28 @@ -#Security ## Client browser -* Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work +- Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work ## PHP -* `magic_quotes` is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with `magic_quotes` on, so you should not be bothered even on crappy hosts. +- `magic_quotes` is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with `magic_quotes` on, so you should not be bothered even on crappy hosts. ## Server and sessions -* Directories are protected using `.htaccess` files -* Forms are protected against XSRF (Cross-site requests forgery): - * Forms which act on data (save,delete…) contain a token generated by the server. - * Any posted form which does not contain a valid token is rejected. - * Any token can only be used once. - * Tokens are attached to the session and cannot be reused in another session. -* Sessions automatically expire after 60 minutes. -* Sessions are protected against hijacking: the session ID cannot be used from a different IP address. +- Directories are protected using `.htaccess` files +- Forms are protected against XSRF (Cross-site requests forgery): + - Forms which act on data (save,delete…) contain a token generated by the server. + - Any posted form which does not contain a valid token is rejected. + - Any token can only be used once. + - Tokens are attached to the session and cannot be reused in another session. +- Sessions automatically expire after 60 minutes. +- Sessions are protected against hijacking: the session ID cannot be used from a different IP address. ## Shaarli datastore and configuration -* The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks. -* Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a `.php` file. -* Even if the server does not support `.htaccess` files, the data file will still not be readable by URL. -* The database looks like this: +- The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks. +- Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a `.php` file. +- Even if the server does not support `.htaccess` files, the data file will still not be readable by URL. +- The database looks like this: + ```php ``` -* Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. `20110923_150523`) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only `A-Z a-z 0-9 - _` and `@`. +- Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. `20110923_150523`) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only `A-Z a-z 0-9 - _` and `@`. diff --git a/doc/Server-configuration.md b/doc/md/Server-configuration.md similarity index 84% rename from doc/Server-configuration.md rename to doc/md/Server-configuration.md index 81cc1a72..25dd49fe 100644 --- a/doc/Server-configuration.md +++ b/doc/md/Server-configuration.md @@ -1,30 +1,32 @@ -#Server configuration *Example virtual host configurations for popular web servers* -- [Apache](#apache)[](.html) -- [Nginx](#nginx)[](.html) +- [Apache](#apache) +- [Nginx](#nginx) ## Prerequisites ### Shaarli -* Shaarli is installed in a directory readable/writeable by the user -* the correct read/write permissions have been granted to the web server _user and/or group_ -* for HTTPS / SSL: - * a key pair (public, private) and a certificate have been generated - * the appropriate server SSL extension is installed and active +- Shaarli is installed in a directory readable/writeable by the user +- the correct read/write permissions have been granted to the web server _user and/or group_ +- for HTTPS / SSL: + - a key pair (public, private) and a certificate have been generated + - the appropriate server SSL extension is installed and active ### HTTPS, TLS and self-signed certificates Related guides: -* [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php)[](.html) -* [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority)[](.html) -* Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key` + +- [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php) +- [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority) +- Generate a self-signed certificate (will trigger browser warnings) with apache2: + `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key` ### Proxies If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set: -- `X-Forwarded-Proto`; -- `X-Forwarded-Host`; -- `X-Forwarded-For`. -See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.[](.html) +- `X-Forwarded-Proto` +- `X-Forwarded-Host` +- `X-Forwarded-For` + +See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. ## Apache ### Minimal @@ -38,8 +40,9 @@ See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%9 This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors. See: -* [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow)[](.html) -* [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/)[](.html) + +- [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow) +- [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/) ```apache @@ -70,7 +73,7 @@ See: ``` ### Paranoid - Redirect HTTP (:80) to HTTPS (:443) -See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla).[](.html) +See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla). ```apache @@ -106,7 +109,7 @@ See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work. -**Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled.[](.html) +**Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled. Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root `.htaccess` file. @@ -114,37 +117,44 @@ Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriti ## Nginx ### Foreword -Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources.[](.html) +Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources. Required packages: -- [nginx](http://nginx.org)[](.html) -- [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager[](.html) + +- [nginx](http://nginx.org) +- [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager Official documentation: -- [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html)[](.html) -- [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html)[](.html) -- [Pitfalls](http://wiki.nginx.org/Pitfalls)[](.html) + +- [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html) +- [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html) +- [Pitfalls](http://wiki.nginx.org/Pitfalls) Community resources: -- [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla)[](.html) -- [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing)[](.html) + +- [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla) +- [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing) ### Common setup Once Nginx and PHP-FPM are installed, we need to ensure: + - Nginx and PHP-FPM are running using the _same user and group_ - both these user and group have - `read` permissions for Shaarli resources - `execute` permissions for Shaarli directories _AND_ their parent directories On a production server: + - `user:group` will likely be `http:http`, `www:www` or `www-data:www-data` - files will be located under `/var/www`, `/var/http` or `/usr/share/nginx` On a development server: + - files may be located in a user's home directory - in this case, make sure both Nginx and PHP-FPM are running as the local user/group! For all following configuration examples, this user/group pair will be used: + - `user:group = john:users`, which corresponds to the following service configuration: @@ -154,7 +164,7 @@ which corresponds to the following service configuration: user = john group = users -[...][](.html) +[...] listen.owner = john listen.group = users ``` @@ -164,7 +174,7 @@ listen.group = users user john users; http { - [...][](.html) + [...] } ``` @@ -177,20 +187,20 @@ To increase upload size, you will need to modify both nginx and PHP configuratio # /etc/nginx/nginx.conf http { - [...][](.html) + [...] client_max_body_size 10m; - [...][](.html) + [...] } ``` ```ini # /etc/php5/fpm/php.ini -[...][](.html) +[...] post_max_size = 10M -[...][](.html) +[...] upload_max_filesize = 10M ``` @@ -238,6 +248,7 @@ http { ### Modular The previous setup is sufficient for development purposes, but has several major caveats: + - every content that does not match the PHP rule will be sent to client browsers: - dotfiles - in our case, `.htaccess` - temporary files, e.g. Vim or Emacs files: `index.php~` @@ -293,10 +304,10 @@ location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { ```nginx # /etc/nginx/nginx.conf -[...][](.html) +[...] http { - [...][](.html) + [...] root /home/john/web; access_log /var/log/nginx/access.log; @@ -343,14 +354,16 @@ http { ``` ### Redirect HTTP to HTTPS -Assuming you have generated a (self-signed) key and certificate, and they are located under `/home/john/ssl/localhost.{key,crt}`, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage. +Assuming you have generated a (self-signed) key and certificate, and they are +located under `/home/john/ssl/localhost.{key,crt}`, it is pretty straightforward +to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage. ```nginx # /etc/nginx/nginx.conf -[...][](.html) +[...] http { - [...][](.html) + [...] index index.html index.php; diff --git a/doc/Server-requirements.md b/doc/md/Server-requirements.md similarity index 59% rename from doc/Server-requirements.md rename to doc/md/Server-requirements.md index 07e70ab3..707af762 100644 --- a/doc/Server-requirements.md +++ b/doc/md/Server-requirements.md @@ -1,40 +1,41 @@ -#Server requirements ## PHP + ### Release information -- [PHP: Supported versions](http://php.net/supported-versions.php)[](.html) -- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_[](.html) -- [PHP 7 Changelog](http://php.net/ChangeLog-7.php)[](.html) -- [PHP 5 Changelog](http://php.net/ChangeLog-5.php)[](.html) -- [PHP: Bugs](https://bugs.php.net/)[](.html) +- [PHP: Supported versions](http://php.net/supported-versions.php) +- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_ +- [PHP 7 Changelog](http://php.net/ChangeLog-7.php) +- [PHP 5 Changelog](http://php.net/ChangeLog-5.php) +- [PHP: Bugs](https://bugs.php.net/) ### Supported versions Version | Status | Shaarli compatibility :---:|:---:|:---: -7.1 | Supported (v0.9.x) | :white_check_mark: -7.0 | Supported | :white_check_mark: -5.6 | Supported | :white_check_mark: -5.5 | EOL: 2016-07-10 | :white_check_mark: -5.4 | EOL: 2015-09-14 | :white_check_mark: (up to Shaarli 0.8.x) -5.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x) +7.1 | Supported (v0.9.x) | Yes +7.0 | Supported | Yes +5.6 | Supported | Yes +5.5 | EOL: 2016-07-10 | Yes +5.4 | EOL: 2015-09-14 | Yes (up to Shaarli 0.8.x) +5.3 | EOL: 2014-08-14 | Yes (up to Shaarli 0.8.x) See also: -- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)[](.html) + +- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml) ### Dependency management -Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve,[](.html) +Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve, download and install third-party PHP dependencies. Library | Required? | Usage ---|:---:|--- -[`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files[](.html) -[`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin[](.html) -[`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API[](.html) +[`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files +[`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin +[`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API ### Extensions Extension | Required? | Usage ---|:---:|--- -[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS[](.html) -[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support[](.html) -[`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing[](.html) -[`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->è->f`)[](.html) -[`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way[](.html) +[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS +[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support +[`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing +[`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->è->f`) +[`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way diff --git a/doc/Server-security.md b/doc/md/Server-security.md similarity index 92% rename from doc/Server-security.md rename to doc/md/Server-security.md index 50549a21..700084e2 100644 --- a/doc/Server-security.md +++ b/doc/md/Server-security.md @@ -1,6 +1,6 @@ -#Server security ## php.ini PHP settings are defined in: + - a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g. - `/etc/php5/php.ini` - used when running console scripts - `/etc/php5/apache2/php.ini` - used when a client requests PHP resources from Apache @@ -31,8 +31,9 @@ Additional .ini files parsed: /etc/php/conf.d/xdebug.ini ## fail2ban `fail2ban` is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses `iptables` profiles to block brute-force attempts: -- [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page)[](.html) -- [Source code](https://github.com/fail2ban/fail2ban)[](.html) + +- [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page) +- [Source code](https://github.com/fail2ban/fail2ban) ### Read Shaarli logs to ban IPs Example configuration: @@ -41,7 +42,7 @@ Example configuration: `/etc/fail2ban/jail.local` ```ini -[shaarli-auth][](.html) +[shaarli-auth] enabled = true port = https,http filter = shaarli-auth @@ -52,9 +53,9 @@ bantime = -1 `/etc/fail2ban/filter.d/shaarli-auth.conf` ```ini -[INCLUDES][](.html) +[INCLUDES] before = common.conf -[Definition][](.html) +[Definition] failregex = \s-\s\s-\sLogin failed for user.*$ ignoreregex = ``` @@ -69,6 +70,7 @@ Disallow: / ``` See: -- http://www.robotstxt.org/ + +- http://www.robotstxt.org - http://www.robotstxt.org/robotstxt.html - http://www.robotstxt.org/meta.html diff --git a/doc/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md similarity index 57% rename from doc/Shaarli-configuration.md rename to doc/md/Shaarli-configuration.md index 25647cb7..188a3c09 100644 --- a/doc/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md @@ -1,19 +1,17 @@ -#Shaarli configuration -# Shaarli configuration - ## Foreword **Do not edit configuration options in index.php! Your changes would be lost.** Once your Shaarli instance is installed, the file `data/config.json.php` is generated: * it contains all settings in JSON format, and can be edited to customize values -* it defines which [plugins](Plugin-System) are enabled[(.html)]((.html).html) +* it defines which [plugins](Plugin-System) are enabled[](.html) * its values override those defined in `index.php` * it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration ## File and directory permissions The server process running Shaarli must have: + - `read` access to the following resources: - PHP scripts: `index.php`, `application/*.php`, `plugins/*.php` - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc/*.js` @@ -28,84 +26,86 @@ The server process running Shaarli must have: - `tmp` - RainTPL page cache On a Linux distribution: + - the web server user will likely be `www` or `http` (for Apache2) - it will be a member of a group of the same name: `www:www`, `http:http` - to give it access to Shaarli, either: - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner - put users in the same group as the web server, and set the appropriate access rights -- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[(.html)]((.html).html) +- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) ## Configuration In `data/config.json.php`. -See also [Plugin System](Plugin-System.html).[](.html) +See also [Plugin System](Plugin-System.html). ### Credentials -> You shouldn't edit those. +_These settings should not be edited_ -**login**: Login username. -**hash**: Generated password hash. -**salt**: Password salt. +- **login**: Login username. +- **hash**: Generated password hash. +- **salt**: Password salt. ### General -**title**: Shaarli's instance title. -**header_link**: Link to the homepage. -**links_per_page**: Number of shaares displayed per page. -**timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). [](.html) -**enabled_plugins**: List of enabled plugins. +- **title**: Shaarli's instance title. +- **header_link**: Link to the homepage. +- **links_per_page**: Number of shaares displayed per page. +- **timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). +- **enabled_plugins**: List of enabled plugins. ### Security -**session_protection_disabled**: Disable session cookie hijacking protection (not recommended). -It might be useful if your IP adress often changes. -**ban_after**: Failed login attempts before being IP banned. -**ban_duration**: IP ban duration in seconds. -**open_shaarli**: Anyone can add a new link while logged out if enabled. -**trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. +- **session_protection_disabled**: Disable session cookie hijacking protection (not recommended). + It might be useful if your IP adress often changes. +- **ban_after**: Failed login attempts before being IP banned. +- **ban_duration**: IP ban duration in seconds. +- **open_shaarli**: Anyone can add a new link while logged out if enabled. +- **trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. +- **allowed_protocols**: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store `javascript:` links (bookmarklets) in Shaarli (default: `["ftp", "ftps", "magnet"]`). ### Resources -**data_dir**: Data directory. -**datastore**: Shaarli's links database file path. -**history**: Shaarli's operation history file path. -**updates**: File path for the ran updates file. -**log**: Log file path. -**update_check**: Last update check file path. -**raintpl_tpl**: Templates directory. -**raintpl_tmp**: Template engine cache directory. -**thumbnails_cache**: Thumbnails cache directory. -**page_cache**: Shaarli's internal cache directory. -**ban_file**: Banned IP file path. +- **data_dir**: Data directory. +- **datastore**: Shaarli's links database file path. +- **history**: Shaarli's operation history file path. +- **updates**: File path for the ran updates file. +- **log**: Log file path. +- **update_check**: Last update check file path. +- **raintpl_tpl**: Templates directory. +- **raintpl_tmp**: Template engine cache directory. +- **thumbnails_cache**: Thumbnails cache directory. +- **page_cache**: Shaarli's internal cache directory. +- **ban_file**: Banned IP file path. ### Updates -**check_updates**: Enable or disable update check to the git repository. -**check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). -**check_updates_interval**: Look for new version every N seconds (default: every day). +- **check_updates**: Enable or disable update check to the git repository. +- **check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). +- **check_updates_interval**: Look for new version every N seconds (default: every day). ### Privacy -**default_private_links**: Check the private checkbox by default for every new link. -**hide_public_links**: All links are hidden while logged out. -**hide_timestamps**: Timestamps are hidden. +- **default_private_links**: Check the private checkbox by default for every new link. +- **hide_public_links**: All links are hidden while logged out. +- **hide_timestamps**: Timestamps are hidden. ### Feed -**rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. -**show_atom**: Display ATOM feed button. +- **rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. +- **show_atom**: Display ATOM feed button. ### Thumbnail -**enable_thumbnails**: Enable or disable thumbnail display. -**enable_localcache**: Enable or disable local cache. +- **enable_thumbnails**: Enable or disable thumbnail display. +- **enable_localcache**: Enable or disable local cache. ### Redirector -**url**: Redirector URL, such as `anonym.to`. -**encode_url**: Enable this if the redirector needs encoded URL to work properly. +- **url**: Redirector URL, such as `anonym.to`. +- **encode_url**: Enable this if the redirector needs encoded URL to work properly. ## Configuration file example @@ -121,9 +121,14 @@ It might be useful if your IP adress often changes. "ban_after": 4, "session_protection_disabled": false, "ban_duration": 1800, - "trusted_proxies": [[](.html) + "trusted_proxies": [ "1.2.3.4", "5.6.7.8" + ], + "allowed_protocols": [ + "ftp", + "ftps", + "magnet" ] }, "resources": { @@ -148,7 +153,7 @@ It might be useful if your IP adress often changes. "enable_localcache": true, "check_updates_branch": "stable", "check_updates_interval": 86400, - "enabled_plugins": [[](.html) + "enabled_plugins": [ "markdown", "wallabag", "archiveorg" @@ -168,7 +173,7 @@ It might be useful if your IP adress often changes. "general": { "header_link": "?", "links_per_page": 20, - "enabled_plugins": [[](.html) + "enabled_plugins": [ "markdown", "wallabag" ], @@ -206,7 +211,7 @@ It might be useful if your IP adress often changes. ## Additional configuration -The playvideos plugin may require that you adapt your server's -[Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) [](.html) -configuration to work properly.[(.html)]((.html).html) +The `playvideos` plugin may require that you adapt your server's +[Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) +configuration to work properly. diff --git a/doc/Static-analysis.md b/doc/md/Static-analysis.md similarity index 68% rename from doc/Static-analysis.md rename to doc/md/Static-analysis.md index 5781e055..29d98362 100644 --- a/doc/Static-analysis.md +++ b/doc/md/Static-analysis.md @@ -1,12 +1,13 @@ -#Static analysis ## WIP This topic is currently being discussed here: -- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95)[](.html) -- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130)[](.html) + +- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) +- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) ### Usage -Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile).[](.html) +Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile). For an overview of the available features, see: -- [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124)[](.html) -- [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276)[](.html) + +- [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124) +- [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276) diff --git a/doc/Theming.md b/doc/md/Theming.md similarity index 76% rename from doc/Theming.md rename to doc/md/Theming.md index 23877e5d..bd400776 100644 --- a/doc/Theming.md +++ b/doc/md/Theming.md @@ -1,12 +1,14 @@ -#Theming ## Foreword + There are two ways of customizing how Shaarli looks: 1. by using a custom CSS to override Shaarli's CSS 2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources ## Custom CSS + Shaarli's appearance can be modified by adding CSS rules to: + - Shaarli < `v0.9.0`: `inc/user.css` - Shaarli >= `v0.9.0`: `data/user.css` @@ -14,12 +16,12 @@ This file allows overriding rules defined in the template CSS files (only add ch **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. -See also [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) +See also [Download CSS styles from an OPML list](Download CSS styles from an OPML list) ## Themes -_WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ Installation: + - find a theme you'd like to install - copy or clone the theme folder under `tpl/` - enable the theme: @@ -28,25 +30,31 @@ Installation: - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page ## Community CSS & themes + ### Custom CSS -- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli[](.html) -- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes)[](.html) + +- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli +- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes) ### Themes -- [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html) -- [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html) -- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme[](.html) -- [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html) -- [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html) -- [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone[](.html) -- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site[](.html) + +- [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli +- [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli +- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme +- [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli +- [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli +- [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone +- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site ### Shaarli forks -- [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html) -- [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html) + +- [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template +- [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance ## Example installation: AlbinoMouse theme + With the following configuration: + - Apache 2 / PHP 5.6 - user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` - `http` is the name of the Apache user @@ -70,7 +78,7 @@ Get config written: - fill the install form - log in to Shaarli -Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli-configuration.html): +Edit Shaarli's [configuration](Shaarli-configuration): ```bash # the file should be owned by Apache, thus not writeable => sudo $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php diff --git a/doc/Troubleshooting.md b/doc/md/Troubleshooting.md similarity index 61% rename from doc/Troubleshooting.md rename to doc/md/Troubleshooting.md index 8e30fce5..b2d86d40 100644 --- a/doc/Troubleshooting.md +++ b/doc/md/Troubleshooting.md @@ -1,39 +1,51 @@ -#Troubleshooting +# Troubleshooting + ## Browser + ### Redirection issues (HTTP Referer) + Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. See: -- [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia)[](.html) -- [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/)[](.html) -- [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/)[](.html) + +- [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia) +- [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/) +- [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/) ### Firefox HTTP Referer options + HTTP settings are available by browsing `about:config`, here are the available settings and their values. `network.http.sendRefererHeader` - determines when to send the Referer HTTP header -- 0: Never send the referring URL + +- `0`: Never send the referring URL - not recommended, may break some sites -- 1: Send only on clicked links -- 2 (default): Send for links and images +- `1`: Send only on clicked links +- `2` (default): Send for links and images `network.http.referer.XOriginPolicy` - Cross-domain origin policy -- 0 (default): Always send -- 1: Send if base domains match -- 2: Send if hosts match + +- `0` (default): Always send +- `1`: Send if base domains match +- `2`: Send if hosts match `network.http.referer.spoofSource` - Referer spoofing (~faking) -- false (default): real referer -- true: spoof referer (use target URI as referer) - - known to break some functionality in Shaarli + +- `false` (default): real referer +- `true`: spoof referer (use target URI as referer) + - known to break some functionality in Shaarli `network.http.referer.trimmingPolicy` - trim the URI not to send a full Referer -- 0 (default): send full URI -- 1: scheme+host+port+path -- 2: scheme+host+port + +- `0`: (default): send full URI +- `1`: scheme+host+port+path +- `2`: scheme+host+port ### Firefox, localhost and redirections -`localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. + +`localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has +been set up to spoof referers, or only accept requests from the same base domain/host, +Shaarli redirections will not work properly. To solve this, assign a local domain to your host, e.g. ``` @@ -44,35 +56,44 @@ To solve this, assign a local domain to your host, e.g. and browse Shaarli at http://localhost.lan/. Related threads: -- [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064)[](.html) -- [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311)[](.html) +- [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064) +- [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311) ## Login + ### I forgot my password! + Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. ### I'm locked out - Login bruteforce protection + Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links. To remove the current IP bans, delete the file `data/ipbans.php` ### List of all login attempts + The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. Search for `failed` in this file to look for unauthorized login attempts. ## Hosting problems -### Old PHP versions - * On **free.fr** : free.fr now support php 5.6.x([link](http://les.pages.perso.chez.free.fr/migrations/php5v6.io))and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a `sessions` directory and a `.htaccess` file containing:[](.html) -```ini +### Old PHP versions + +On **free.fr**: free.fr now supports php 5.6.x([link](http://les.pages.perso.chez.free.fr/migrations/php5v6.io)) +and so support now the tag autocompletion but you have to do the following. + +At the root of your webspace create a `sessions` directory and a `.htaccess` file containing: + +```xml php56 1 ``` - * If you have an error such as: `Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx`, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to `.php5` - * On **1and1** : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). - * If you have the error `Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx`, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:[](.html) +- If you have an error such as: `Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx`, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to `.php5` +- On **1and1** : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). +- If you have the error `Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx`, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines: ```php //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. @@ -80,28 +101,32 @@ php56 1 //if (strpos($status,'200 OK')) $title=html_extract_title($data); ``` - * On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work. - * On **lost-oasis**, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : ``. To fix this, remove this message from `php-include/prepend.php` +- On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work. +- On **lost-oasis**, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : ``. To fix this, remove this message from `php-include/prepend.php` ### Dates are not properly formatted + Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( ) ### Problems on CentOS servers + On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. - ### My session expires! I can't stay logged in + This can be caused by several things: -* Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a `session` directory on the root of your website.) You may need to create the session directory of set it up. -* Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the `sessions` subdirectory and add `ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');`. Make sure this directory is not browsable !)[](.html) -* If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). -* Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those. -* You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. -* If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions. +- Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a `session` directory on the root of your website.) You may need to create the session directory of set it up. +- Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the `sessions` subdirectory and add `ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');`. Make sure this directory is not browsable !) +- If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). +- Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those. +- You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. +- If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions. ## Sessions do not seem to work correctly on your server -Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have **no dots** in the hostname (e.g. `localhost` or `http://my-webserver/shaarli/`), some browsers will not store cookies at all (this respects the [HTTP cookie specification](http://curl.haxx.se/rfc/cookie_spec.html)).[](.html) + +Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have **no dots** in the hostname (e.g. `localhost` or `http://my-webserver/shaarli/`), some browsers will not store cookies at all (this respects the [HTTP cookie specification](http://curl.haxx.se/rfc/cookie_spec.html)). ### pubsubhubbub support -Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config'['PUBSUBHUB_URL']` in your `config.php`]('PUBSUBHUB_URL']`-in-your-`config.php`.html) + +Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config']['PUBSUBHUB_URL']` in your `config.php` diff --git a/doc/Unit-tests.md b/doc/md/Unit-tests.md similarity index 80% rename from doc/Unit-tests.md rename to doc/md/Unit-tests.md index 0942ad38..d200634f 100644 --- a/doc/Unit-tests.md +++ b/doc/md/Unit-tests.md @@ -1,13 +1,14 @@ -#Unit tests - ### Setup your environment for tests -The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.[](.html) + +The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. Regarding Composer, you can either use: -* a system-wide version, e.g. installed through your distro's package manager -* a local version, downloadable [here](https://getcomposer.org/download/)[](.html) + +- a system-wide version, e.g. installed through your distro's package manager +- a local version, downloadable [here](https://getcomposer.org/download/) #### Sample usage + ```bash # system-wide version $ composer install @@ -20,12 +21,14 @@ $ php composer.phar update ``` #### Install Shaarli dev dependencies + ```bash $ cd /path/to/shaarli $ composer update ``` #### Install and enable Xdebug to generate PHPUnit coverage reports + For Debian-based distros: ```bash $ aptitude install php5-xdebug @@ -41,6 +44,7 @@ zend_extension=xdebug.so ``` #### Run unit tests + Successful test suite: ```bash $ make test @@ -111,24 +115,28 @@ Tests: 36, Assertions: 63, Errors: 1, Failures: 2. ``` #### Test results and coverage + By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes: -* `.` - success -* `F` - failure: the test was run but its results are invalid - * the code does not behave as expected - * dependencies to external elements: globals, session, cache... -* `E` - error: something went wrong and the tested code has crashed - * typos in the code, or in the test code - * dependencies to missing external elements + +- `.` - success +- `F` - failure: the test was run but its results are invalid + - the code does not behave as expected + - dependencies to external elements: globals, session, cache... +- `E` - error: something went wrong and the tested code has crashed + - typos in the code, or in the test code + - dependencies to missing external elements If Xdebug has been installed and activated, two coverage reports will be generated: -* a summary in the console -* a detailed HTML report with metrics for tested code - * to open it in a web browser: `firefox coverage/index.html &` + +- a summary in the console +- a detailed HTML report with metrics for tested code + - to open it in a web browser: `firefox coverage/index.html &` ### Executing specific tests -Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:[](.html) + +Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment: ```php /** @@ -137,7 +145,7 @@ Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.htm */ class BookmarkImportTest extends PHPUnit_Framework_TestCase { - [...][](.html) + [...] } ``` diff --git a/doc/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md similarity index 80% rename from doc/Upgrade-and-migration.md rename to doc/md/Upgrade-and-migration.md index d36eb862..b3a08764 100644 --- a/doc/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md @@ -1,5 +1,5 @@ -#Upgrade and migration ## Preparation + ### Note your current version If anything goes wrong, it's important for us to know which version you're upgrading from. @@ -8,38 +8,44 @@ The current version is present in the `version.php` file. ### Backup your data Shaarli stores all user data under the `data` directory: + - `data/config.php` - main configuration file - `data/datastore.php` - bookmarked links - `data/ipbans.php` - banned IP addresses - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run -See [Shaarli configuration](Shaarli-configuration.html) for more information about Shaarli resources. +See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: + - users with SSH access: copy or archive the directory to a temporary location - users with FTP access: download a local copy of your Shaarli installation using your favourite client ### Migrating data from a previous installation + As all user data is kept under `data`, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps: - backup the `data` directory - install or update Shaarli: - - fresh installation - see [Download and installation](Download-and-installation.html) + - fresh installation - see [Download and installation](Download and installation) - update - see the following sections - check or restore the `data` directory ## Recommended : Upgrading from release archives -All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page.[](.html) -We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download-and-installation.html) for `git` complete instructions. +All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. + +We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download and installation) for `git` complete instructions. Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! -After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [Shaarli configuration](Shaarli-configuration.html) for more details). +After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [Shaarli configuration](Shaarli configuration) for more details). ## Upgrading with Git + ### Updating a community Shaarli -If you have installed Shaarli from the [community Git repository](Download#clone-with-git-recommended), simply [pull new changes](https://www.git-scm.com/docs/git-pull) from your local clone:[](.html) + +If you have installed Shaarli from the [community Git repository](Download#clone-with-git-recommended), simply [pull new changes](https://www.git-scm.com/docs/git-pull) from your local clone: ```bash $ cd /path/to/shaarli @@ -55,7 +61,7 @@ Fast-forward 3 files changed, 3 insertions(+), 1 deletion(-) ``` -Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) +Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): ```bash $ composer install --no-dev @@ -67,18 +73,21 @@ Updating dependencies ``` ### Migrating and upgrading from Sebsauvage's repository -If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy.[](.html) + +If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. The following guide assumes that: -- you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes)[](.html) + +- you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) - the default remote is named `origin` and points to Sebsauvage's repository - the current branch is `master` - - if you have personal branches containing customizations, you will need to [rebase them](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break![](.html) + - if you have personal branches containing customizations, you will need to [rebase them](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break! - the working copy is clean: - no versioned file has been locally modified - no untracked files are present #### Step 0: show repository information + ```bash $ cd /path/to/shaarli @@ -87,7 +96,7 @@ origin https://github.com/sebsauvage/Shaarli (fetch) origin https://github.com/sebsauvage/Shaarli (push) $ git branch -vv -* master 029f75f [origin/master] Update README.md[](.html) +* master 029f75f [origin/master] Update README.md $ git status On branch master @@ -96,6 +105,7 @@ nothing to commit, working directory clean ``` #### Step 1: update Git remotes + ``` $ git remote rename origin sebsauvage $ git remote -v @@ -111,11 +121,11 @@ remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550 Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. Resolving deltas: 100% (1899/1899), completed with 48 local objects. From https://github.com/shaarli/Shaarli - * [new branch] master -> origin/master[](.html) - * [new branch] stable -> origin/stable[](.html) -[...][](.html) - * [new tag] v0.6.4 -> v0.6.4[](.html) - * [new tag] v0.7.0 -> v0.7.0[](.html) + * [new branch] master -> origin/master + * [new branch] stable -> origin/stable +[...] + * [new tag] v0.6.4 -> v0.6.4 + * [new tag] v0.7.0 -> v0.7.0 ``` #### Step 2: use the stable community branch @@ -126,11 +136,11 @@ Branch stable set up to track remote branch stable from origin. Switched to a new branch 'stable' $ git branch -vv - master 029f75f [sebsauvage/master] Update README.md[](.html) -* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5[](.html) + master 029f75f [sebsauvage/master] Update README.md +* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5 ``` -Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/):[](.html) +Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): ```bash $ composer install --no-dev @@ -162,11 +172,12 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to ``` #### Step 3: configuration -After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [Shaarli configuration](Shaarli-configuration.html) for more details). + +After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [Shaarli configuration](Shaarli configuration) for more details). ## Troubleshooting -If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to. +If the solutions provided here don't work, please open an issue specifying which version you're upgrading from and to. ### You must specify an integer as a key @@ -177,10 +188,10 @@ Take a look at `data/updates.txt` content. Try to delete it and refresh your page while being logged in. -#### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds` +#### `updates.txt` doesn't exist or doesn't contain `updateMethodDatastoreIds` - 1. Create `data/updates.txt` if it doesn't exist. - 2. Paste this string in the update file `;updateMethodRenameDashTags;` - 3. Login to Shaarli. - 4. Delete the update file. - 5. Refresh. +1. Create `data/updates.txt` if it doesn't exist +2. Paste this string in the update file `;updateMethodRenameDashTags;` +3. Login to Shaarli +4. Delete the update file +5. Refresh diff --git a/doc/md/Various-hacks.md b/doc/md/Various-hacks.md new file mode 100644 index 00000000..0074ae9f --- /dev/null +++ b/doc/md/Various-hacks.md @@ -0,0 +1,33 @@ +### Decode datastore content + +To display the array representing the data saved in `data/datastore.php`, use the following snippet: + +```php +$data = "tZNdb9MwFIb... "; +$out = unserialize(gzinflate(base64_decode($data))); +echo "
    "; // Pretty printing is love, pretty printing is life
+print_r($out);
+echo "
    "; +exit; +``` +This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). + +Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): +``` +php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . +``` + +### Changing the timestamp for a shaare + +- Look for `` in `tpl/editlink.tpl` (line 14) +- Replace `type="hidden"` with `type="text"` from this line +- A new date/time field becomes available in the edit/new link dialog. +- You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. + + +### See also + +- [Add a new custom field to shaares (example patch)](https://gist.github.com/nodiscc/8b0194921f059d7b9ad89a581ecd482c) +- [Download CSS styles for shaarlis listed in an opml file](https://gist.github.com/nodiscc/dede231c92cab22c3ad2cc24d5035012) +- [Copy an existing Shaarli installation over SSH, and serve it locally](https://gist.github.com/nodiscc/ed161c66e5b028b5299b0a3733d01c77) +- [Create multiple Shaarli instances, generate an HTML index of them](https://gist.github.com/nodiscc/52e711cda3bc47717c16065231cf6b20) diff --git a/doc/Versioning-and-Branches.md b/doc/md/Versioning-and-Branches.md similarity index 85% rename from doc/Versioning-and-Branches.md rename to doc/md/Versioning-and-Branches.md index bbc7719e..7097ca0a 100644 --- a/doc/Versioning-and-Branches.md +++ b/doc/md/Versioning-and-Branches.md @@ -1,5 +1,4 @@ -#Versioning and Branches -[**WORK IN PROGRESS**][](.html) +**WORK IN PROGRESS** It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible. @@ -9,10 +8,10 @@ The `master` branch is the development branch. Any new change MUST go through th Remarks: - * This branch shouldn't be used for production as it isn't necessary stable. - * 3rd party aren't required to be compatible with the latest changes. - * Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch. - * The version in this branch is always `dev`. +- This branch shouldn't be used for production as it isn't necessary stable. +- 3rd party aren't required to be compatible with the latest changes. +- Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch. +- The version in this branch is always `dev`. ## `v0.x` branch @@ -38,7 +37,7 @@ For example, the current latest release is `v0.8.3`, the stable branch is an ali Remarks: - * Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release. +- Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release. ## Releases @@ -50,7 +49,7 @@ Note that for every release, we manually generate a tarball which contains all S ### Versioning -Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either:[](.html) +Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either: - use the Shaarli version number, with your repo version. For example, if Shaarli `v0.8.3` is released, publish a `v0.8.3-1` release, where `v0.8.3` states Shaarli compatibility and `-1` is your own version digit for the current Shaarli version. - use your own versioning scheme, and state Shaarli compatibility in the release description. diff --git a/doc/md/docker/docker-101.md b/doc/md/docker/docker-101.md new file mode 100644 index 00000000..b02dd149 --- /dev/null +++ b/doc/md/docker/docker-101.md @@ -0,0 +1,62 @@ +## Basics +Install [Docker](https://www.docker.com/), by following the instructions relevant +to your OS / distribution, and start the service. + +### Search an image on [DockerHub](https://hub.docker.com/) + +```bash +$ docker search debian + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK] +debian Debian is a Linux distribution that's comp... 603 [OK] +google/debian 47 [OK] +``` + +### Show available tags for a repository +```bash +$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool + +% Total % Received % Xferd Average Speed Time Time Time Current +Dload Upload Total Spent Left Speed +100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 +``` + +Sample output: +```json +[ + { + "layer": "85a02782", + "name": "stretch" + }, + { + "layer": "59abecbc", + "name": "testing" + }, + { + "layer": "bf0fd686", + "name": "unstable" + }, + { + "layer": "60c52dbe", + "name": "wheezy" + }, + { + "layer": "c5b806fe", + "name": "wheezy-backports" + } +] + +``` + +### Pull an image from DockerHub +```bash +$ docker pull repository[:tag] + +$ docker pull debian:wheezy +wheezy: Pulling from debian +4c8cbfd2973e: Pull complete +60c52dbe9d91: Pull complete +Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe +Status: Downloaded newer image for debian:wheezy +``` diff --git a/doc/md/docker/resources.md b/doc/md/docker/resources.md new file mode 100644 index 00000000..082d4a46 --- /dev/null +++ b/doc/md/docker/resources.md @@ -0,0 +1,19 @@ +### Docker + +- [Interactive Docker training portal](https://www.katacoda.com/courses/docker/) on [Katakoda](https://www.katacoda.com/) +- [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/) +- [Dockerfile reference](https://docs.docker.com/reference/builder/) +- [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/) +- [Volumes](https://docs.docker.com/userguide/dockervolumes/) + +### DockerHub + +- [Repositories](https://docs.docker.com/userguide/dockerrepos/) +- [Teams and organizations](https://docs.docker.com/docker-hub/orgs/) +- [GitHub automated build](https://docs.docker.com/docker-hub/github/) + +### Service management + +- [Using supervisord](https://docs.docker.com/articles/using_supervisord/) +- [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon) +- [supervisord](http://supervisord.org/) diff --git a/doc/md/docker/reverse-proxy-configuration.md b/doc/md/docker/reverse-proxy-configuration.md new file mode 100644 index 00000000..91ffecff --- /dev/null +++ b/doc/md/docker/reverse-proxy-configuration.md @@ -0,0 +1,6 @@ + +TODO, see https://github.com/shaarli/Shaarli/issues/888 + +## HAProxy + +## Nginx diff --git a/doc/md/docker/shaarli-images.md b/doc/md/docker/shaarli-images.md new file mode 100644 index 00000000..6d108d21 --- /dev/null +++ b/doc/md/docker/shaarli-images.md @@ -0,0 +1,71 @@ +## Get and run a Shaarli image + +### DockerHub repository +The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/) +repository. + +### Available image tags +- `latest`: master branch (tarball release) +- `stable`: stable branch (tarball release) + +All images rely on: +- [Debian 8 Jessie](https://hub.docker.com/_/debian/) +- [PHP5-FPM](http://php-fpm.org/) +- [Nginx](http://nginx.org/) + +### Download from DockerHub +```bash +$ docker pull shaarli/shaarli +latest: Pulling from shaarli/shaarli +32716d9fcddb: Pull complete +84899d045435: Pull complete +4b6ad7444763: Pull complete +e0345ef7a3e0: Pull complete +5c1dd344094f: Pull complete +6422305a200b: Pull complete +7d63f861dbef: Pull complete +3eb97210645c: Pull complete +869319d746ff: Already exists +869319d746ff: Pulling fs layer +902b87aaaec9: Already exists +Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 +Status: Downloaded newer image for shaarli/shaarli:latest +``` + +### Create and start a new container from the image +```bash +# map the host's :8000 port to the container's :80 port +$ docker create -p 8000:80 shaarli/shaarli +d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 + +# launch the container in the background +$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 +d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 + +# list active containers +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo +``` + +### Stop and destroy a container +```bash +$ docker stop backstabbing_galileo # those docker guys are really rude to physicists! +backstabbing_galileo + +# check the container is stopped +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + +# list ALL containers +$ docker ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo + +# destroy the container +$ docker rm backstabbing_galileo # let's put an end to these barbarian practices +backstabbing_galileo + +$ docker ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +``` diff --git a/doc/images/bookmarklet.png b/doc/md/images/bookmarklet.png similarity index 100% rename from doc/images/bookmarklet.png rename to doc/md/images/bookmarklet.png diff --git a/doc/images/doc-logo.png b/doc/md/images/doc-logo.png similarity index 100% rename from doc/images/doc-logo.png rename to doc/md/images/doc-logo.png diff --git a/doc/images/doc-logo.svg b/doc/md/images/doc-logo.svg similarity index 100% rename from doc/images/doc-logo.svg rename to doc/md/images/doc-logo.svg diff --git a/doc/images/firefoxshare.png b/doc/md/images/firefoxshare.png similarity index 100% rename from doc/images/firefoxshare.png rename to doc/md/images/firefoxshare.png diff --git a/doc/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png similarity index 100% rename from doc/images/rss-filter-1.png rename to doc/md/images/rss-filter-1.png diff --git a/doc/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png similarity index 100% rename from doc/images/rss-filter-2.png rename to doc/md/images/rss-filter-2.png diff --git a/doc/md/index.md b/doc/md/index.md new file mode 100644 index 00000000..b10e3cf4 --- /dev/null +++ b/doc/md/index.md @@ -0,0 +1,115 @@ +# [Shaarli](https://github.com/shaarli/Shaarli/) documentation + +Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. + +For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). + +If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues). +If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). + +If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). + +_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ + +[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) +[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) +[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) + +### Demo + +You can use this [public demo instance of Shaarli](https://demo.shaarli.org). +It runs the latest development version of Shaarli and is updated/reset daily. + +Login: `demo`; Password: `demo` + + +## Features + +### Interface +- minimalist design (simple is beautiful) +- FAST +- ATOM and RSS feeds +- views: + - paginated link list + - tag cloud + - picture wall: image and video thumbnails + - daily: newspaper-like daily digest + - daily RSS feed +- permalinks for easy reference +- links can be public or private +- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) + +### Tag, view and search your links! +- add a custom title and description to archived links +- add tags to classify and search links + - features tag autocompletion, renaming, merging and deletion +- full-text and tag search + +### Easy setup +- dead-simple installation: drop the files, open the page +- links are stored in a file + - compact storage + - no database required + - easy backup: simply copy the datastore file +- import and export links as Netscape bookmarks + +### Accessibility +- Firefox bookmarlet to share links in one click +- support for mobile browsers +- works with Javascript disabled +- easy page customization through HTML/CSS/RainTPL + +### Security +- bruteforce-proof login form +- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) +and session cookie hijacking + +### Goodies +- thumbnail generation for images and video services: +dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... + - lazy-loading with [bLazy](http://dinbror.dk/blazy/) +- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support +- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` +- discreet pop-up notification when a new release is available + +### REST API + +Easily extensible by any client using the REST API exposed by Shaarli. + +See the [API documentation](http://shaarli.github.io/api-documentation/). + +### Other usages +Though Shaarli is primarily a bookmarking application, it can serve other purposes +(see [Features](Features)): + +- micro-blogging +- pastebin +- online notepad +- snippet archive + +## About +### Shaarli community fork +This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli + +This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). + +The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) +that he would have no time to work on Shaarli in the near future. +The Shaarli community has carried on the work to provide +[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) +for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) +in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. + +### Contributing +If you'd like to help, please: +- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) +and [pull requests](https://github.com/shaarli/Shaarli/pulls) +- feel free to report bugs (feedback is much appreciated) +- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) +- propose solutions to existing problems +- submit pull requests :-) + + +### License +Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component. + diff --git a/doc/sidebar.html b/doc/sidebar.html deleted file mode 100644 index 478840d1..00000000 --- a/doc/sidebar.html +++ /dev/null @@ -1,52 +0,0 @@ - diff --git a/docker/development/Dockerfile b/docker/development/Dockerfile deleted file mode 100644 index d9ef8da7..00000000 --- a/docker/development/Dockerfile +++ /dev/null @@ -1,38 +0,0 @@ -FROM debian:jessie -MAINTAINER Shaarli Community - -ENV TERM dumb -RUN apt-get update \ - && apt-get install --no-install-recommends -y \ - ca-certificates \ - nginx-light \ - php5-curl \ - php5-fpm \ - php5-gd \ - php5-intl \ - supervisor \ - git \ - nano \ - && apt-get clean - -RUN sed -i 's/post_max_size.*/post_max_size = 10M/' /etc/php5/fpm/php.ini -RUN sed -i 's/upload_max_filesize.*/upload_max_filesize = 10M/' /etc/php5/fpm/php.ini -COPY nginx.conf /etc/nginx/nginx.conf -COPY supervised.conf /etc/supervisor/conf.d/supervised.conf - -ADD https://getcomposer.org/composer.phar /usr/local/bin/composer -RUN chmod 755 /usr/local/bin/composer - -WORKDIR /var/www -RUN git clone https://github.com/shaarli/Shaarli.git shaarli \ - && cd shaarli \ - && composer --prefer-dist install -RUN rm -rf html \ - && echo "" > index.php \ - && chown -R www-data:www-data . - -VOLUME /var/www/shaarli/data - -EXPOSE 80 - -CMD ["/usr/bin/supervisord", "-n", "-c", "/etc/supervisor/supervisord.conf"] diff --git a/docker/development/IMAGE.md b/docker/development/IMAGE.md deleted file mode 100644 index e2ff0f0e..00000000 --- a/docker/development/IMAGE.md +++ /dev/null @@ -1,10 +0,0 @@ -## shaarli:dev -- [Debian 8 Jessie](https://hub.docker.com/_/debian/) -- [PHP5-FPM](http://php-fpm.org/) -- [Nginx](http://nginx.org/) -- [Shaarli](https://github.com/shaarli/Shaarli) - -### Development tools -- [composer](https://getcomposer.org/) -- [git](http://git-scm.com/) -- [nano](http://www.nano-editor.org/) diff --git a/docker/development/nginx.conf b/docker/development/nginx.conf deleted file mode 100644 index 79c45bfe..00000000 --- a/docker/development/nginx.conf +++ /dev/null @@ -1,80 +0,0 @@ -user www-data www-data; -daemon off; -worker_processes 4; - -events { - worker_connections 768; -} - -http { - include mime.types; - default_type application/octet-stream; - keepalive_timeout 20; - - client_max_body_size 10m; - - index index.html index.php; - - server { - listen 80; - root /var/www/shaarli; - - access_log /var/log/nginx/shaarli.access.log; - error_log /var/log/nginx/shaarli.error.log; - - location /phpinfo/ { - # add a PHP info page for convenience - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - fastcgi_param SCRIPT_FILENAME /var/www/index.php; - include fastcgi_params; - } - - location ~ /\. { - # deny access to dotfiles - access_log off; - log_not_found off; - deny all; - } - - location ~ ~$ { - # deny access to temp editor files, e.g. "script.php~" - access_log off; - log_not_found off; - deny all; - } - - location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { - # cache static assets - expires max; - add_header Pragma public; - add_header Cache-Control "public, must-revalidate, proxy-revalidate"; - } - - location = /favicon.ico { - # serve the Shaarli favicon from its custom location - alias /var/www/shaarli/images/favicon.ico; - } - - location / { - # Slim - rewrite URLs - try_files $uri /index.php$is_args$args; - } - - location ~ (index)\.php$ { - # Slim - split URL path into (script_filename, path_info) - try_files $uri =404; - fastcgi_split_path_info ^(.+\.php)(/.+)$; - - # filter and proxy PHP requests to PHP-FPM - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - include fastcgi.conf; - } - - location ~ \.php$ { - # deny access to all other PHP scripts - deny all; - } - } -} diff --git a/docker/development/supervised.conf b/docker/development/supervised.conf deleted file mode 100644 index 5acd9795..00000000 --- a/docker/development/supervised.conf +++ /dev/null @@ -1,13 +0,0 @@ -[program:php5-fpm] -command=/usr/sbin/php5-fpm -F -priority=5 -autostart=true -autorestart=true - -[program:nginx] -command=/usr/sbin/nginx -priority=10 -autostart=true -autorestart=true -stdout_events_enabled=true -stderr_events_enabled=true diff --git a/index.php b/index.php index ab1e30da..b4c4347a 100644 --- a/index.php +++ b/index.php @@ -225,27 +225,6 @@ function setup_login_state($conf) } $userIsLoggedIn = setup_login_state($conf); -/** - * PubSubHubbub protocol support (if enabled) [UNTESTED] - * (Source: http://aldarone.fr/les-flux-rss-shaarli-et-pubsubhubbub/ ) - * - * @param ConfigManager $conf Configuration Manager instance. - */ -function pubsubhub($conf) -{ - $pshUrl = $conf->get('config.PUBSUBHUB_URL'); - if (!empty($pshUrl)) - { - include_once './publisher.php'; - $p = new Publisher($pshUrl); - $topic_url = array ( - index_url($_SERVER).'?do=atom', - index_url($_SERVER).'?do=rss' - ); - $p->publish_update($topic_url); - } -} - // ------------------------------------------------------------------------------------------ // Session management @@ -308,6 +287,7 @@ function logout() { unset($_SESSION['ip']); unset($_SESSION['username']); unset($_SESSION['privateonly']); + unset($_SESSION['untaggedonly']); } setcookie('shaarli_staySignedIn', FALSE, 0, WEB_PATH); } @@ -706,6 +686,7 @@ function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager) { * @param ConfigManager $conf Configuration Manager instance. * @param PluginManager $pluginManager Plugin Manager instance, * @param LinkDB $LINKSDB + * @param History $history instance */ function renderPage($conf, $pluginManager, $LINKSDB, $history) { @@ -811,7 +792,9 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) // -------- Tag cloud if ($targetPage == Router::$PAGE_TAGCLOUD) { - $tags= $LINKSDB->allTags(); + $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all'; + $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : []; + $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility); // We sort tags alphabetically, then choose a font size according to count. // First, find max value. @@ -820,20 +803,13 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) $maxcount = max($maxcount, $value); } - // Sort tags alphabetically: case insensitive, support locale if available. - uksort($tags, function($a, $b) { - // Collator is part of PHP intl. - if (class_exists('Collator')) { - $c = new Collator(setlocale(LC_COLLATE, 0)); - if (!intl_is_failure(intl_get_error_code())) { - return $c->compare($a, $b); - } - } - return strcasecmp($a, $b); - }); + alphabetical_sort($tags, true, true); $tagList = array(); foreach($tags as $key => $value) { + if (in_array($key, $filteringTags)) { + continue; + } // Tag font size scaling: // default 15 and 30 logarithm bases affect scaling, // 22 and 6 are arbitrary font sizes for max and min sizes. @@ -845,6 +821,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) } $data = array( + 'search_tags' => implode(' ', $filteringTags), 'tags' => $tagList, ); $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => isLoggedIn())); @@ -853,7 +830,37 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) $PAGE->assign($key, $value); } - $PAGE->renderPage('tagcloud'); + $PAGE->renderPage('tag.cloud'); + exit; + } + + // -------- Tag list + if ($targetPage == Router::$PAGE_TAGLIST) + { + $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all'; + $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : []; + $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility); + foreach ($filteringTags as $tag) { + if (array_key_exists($tag, $tags)) { + unset($tags[$tag]); + } + } + + if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') { + alphabetical_sort($tags, false, true); + } + + $data = [ + 'search_tags' => implode(' ', $filteringTags), + 'tags' => $tags, + ]; + $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => isLoggedIn()]); + + foreach ($data as $key => $value) { + $PAGE->assign($key, $value); + } + + $PAGE->renderPage('tag.list'); exit; } @@ -1012,6 +1019,19 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) exit; } + // -------- User wants to see only untagged links (toggle) + if (isset($_GET['untaggedonly'])) { + $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']); + + if (! empty($_SERVER['HTTP_REFERER'])) { + $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly')); + } else { + $location = '?'; + } + header('Location: '. $location); + exit; + } + // -------- Handle other actions allowed for non-logged in users: if (!isLoggedIn()) { @@ -1170,6 +1190,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) if ($targetPage == Router::$PAGE_CHANGETAG) { if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) { + $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : ''); $PAGE->renderPage('changetag'); exit; } @@ -1178,41 +1199,18 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) die('Wrong token.'); } - // Delete a tag: - if (isset($_POST['deletetag']) && !empty($_POST['fromtag'])) { - $needle = trim($_POST['fromtag']); - // True for case-sensitive tag search. - $linksToAlter = $LINKSDB->filterSearch(array('searchtags' => $needle), true); - foreach($linksToAlter as $key=>$value) - { - $tags = explode(' ',trim($value['tags'])); - unset($tags[array_search($needle,$tags)]); // Remove tag. - $value['tags']=trim(implode(' ',$tags)); - $LINKSDB[$key]=$value; - $history->updateLink($LINKSDB[$key]); - } - $LINKSDB->save($conf->get('resource.page_cache')); - echo ''; - exit; - } - - // Rename a tag: - if (isset($_POST['renametag']) && !empty($_POST['fromtag']) && !empty($_POST['totag'])) { - $needle = trim($_POST['fromtag']); - // True for case-sensitive tag search. - $linksToAlter = $LINKSDB->filterSearch(array('searchtags' => $needle), true); - foreach($linksToAlter as $key=>$value) { - $tags = preg_split('/\s+/', trim($value['tags'])); - // Replace tags value. - $tags[array_search($needle, $tags)] = trim($_POST['totag']); - $value['tags'] = implode(' ', array_unique($tags)); - $LINKSDB[$key] = $value; - $history->updateLink($LINKSDB[$key]); - } - $LINKSDB->save($conf->get('resource.page_cache')); // Save to disk. - echo ''; - exit; + $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), escape($_POST['totag'])); + $LINKSDB->save($conf->get('resource.page_cache')); + foreach ($alteredLinks as $link) { + $history->updateLink($link); } + $delete = empty($_POST['totag']); + $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag'])); + $alert = $delete + ? sprintf(t('The tag was removed from %d links.'), count($alteredLinks)) + : sprintf(t('The tag was renamed in %d links.'), count($alteredLinks)); + echo ''; + exit; } // -------- User wants to add a link without using the bookmarklet: Show form. @@ -1258,13 +1256,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) // Remove duplicates. $tags = implode(' ', array_unique(explode(' ', $tags))); - $url = trim($_POST['lf_url']); - if (! startsWith($url, 'http:') && ! startsWith($url, 'https:') - && ! startsWith($url, 'ftp:') && ! startsWith($url, 'magnet:') - && ! startsWith($url, '?') && ! startsWith($url, 'javascript:') - ) { - $url = 'http://' . $url; - } + $url = whitelist_protocols(trim($_POST['lf_url']), $conf->get('security.allowed_protocols')); $link = array( 'id' => $id, @@ -1329,18 +1321,21 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) // -------- User clicked the "Delete" button when editing a link: Delete link from database. if ($targetPage == Router::$PAGE_DELETELINK) { - // We do not need to ask for confirmation: - // - confirmation is handled by JavaScript - // - we are protected from XSRF by the token. - if (! tokenOk($_GET['token'])) { die('Wrong token.'); } - $id = intval(escape($_GET['lf_linkdate'])); - $link = $LINKSDB[$id]; - $pluginManager->executeHooks('delete_link', $link); - unset($LINKSDB[$id]); + if (strpos($_GET['lf_linkdate'], ' ') !== false) { + $ids = array_values(array_filter(preg_split('/\s+/', escape($_GET['lf_linkdate'])))); + } else { + $ids = [$_GET['lf_linkdate']]; + } + foreach ($ids as $id) { + $id = (int) escape($id); + $link = $LINKSDB[$id]; + $pluginManager->executeHooks('delete_link', $link); + unset($LINKSDB[$id]); + } $LINKSDB->save($conf->get('resource.page_cache')); // save to disk $history->deleteLink($link); @@ -1372,7 +1367,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) 'link' => $link, 'link_is_new' => false, 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''), - 'tags' => $LINKSDB->allTags(), + 'tags' => $LINKSDB->linksCountPerTag(), ); $pluginManager->executeHooks('render_editlink', $data); @@ -1430,7 +1425,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) 'url' => $url, 'description' => $description, 'tags' => $tags, - 'private' => $private + 'private' => $private, ); } else { $link['linkdate'] = $link['created']->format(LinkDB::LINK_DATE_FORMAT); @@ -1441,7 +1436,7 @@ function renderPage($conf, $pluginManager, $LINKSDB, $history) 'link_is_new' => $link_is_new, 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''), 'source' => (isset($_GET['source']) ? $_GET['source'] : ''), - 'tags' => $LINKSDB->allTags(), + 'tags' => $LINKSDB->linksCountPerTag(), 'default_private_links' => $conf->get('privacy.default_private_links', false), ); $pluginManager->executeHooks('render_editlink', $data); @@ -1597,6 +1592,13 @@ function($a, $b) { return $a['order'] - $b['order']; } exit; } + // Get a fresh token + if ($targetPage == Router::$GET_TOKEN) { + header('Content-Type:text/plain'); + echo getToken($conf); + exit; + } + // -------- Otherwise, simply display search form and links: showLinkList($PAGE, $LINKSDB, $conf, $pluginManager); exit; @@ -1614,7 +1616,15 @@ function($a, $b) { return $a['order'] - $b['order']; } function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager) { // Used in templates - $searchtags = !empty($_GET['searchtags']) ? escape(normalize_spaces($_GET['searchtags'])) : ''; + if (isset($_GET['searchtags'])) { + if (! empty($_GET['searchtags'])) { + $searchtags = escape(normalize_spaces($_GET['searchtags'])); + } else { + $searchtags = false; + } + } else { + $searchtags = ''; + } $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : ''; // Smallhash filter @@ -1629,7 +1639,11 @@ function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager) } else { // Filter links according search parameters. $visibility = ! empty($_SESSION['privateonly']) ? 'private' : 'all'; - $linksToDisplay = $LINKSDB->filterSearch($_GET, false, $visibility); + $request = [ + 'searchtags' => $searchtags, + 'searchterm' => $searchterm, + ]; + $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly'])); } // ---- Handle paging. @@ -1676,7 +1690,7 @@ function buildLinkList($PAGE,$LINKSDB, $conf, $pluginManager) } // Compute paging navigation - $searchtagsUrl = empty($searchtags) ? '' : '&searchtags=' . urlencode($searchtags); + $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags); $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm); $previous_page_url = ''; if ($i != count($keys)) { @@ -2223,6 +2237,12 @@ function resizeImage($filepath) $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20); } +try { + $history = new History($conf->get('resource.history')); +} catch(Exception $e) { + die($e->getMessage()); +} + $linkDb = new LinkDB( $conf->get('resource.datastore'), isLoggedIn(), @@ -2231,12 +2251,6 @@ function resizeImage($filepath) $conf->get('redirector.encode_url') ); -try { - $history = new History($conf->get('resource.history')); -} catch(Exception $e) { - die($e->getMessage()); -} - $container = new \Slim\Container(); $container['conf'] = $conf; $container['plugins'] = $pluginManager; diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..648d8f67 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: Shaarli Documentation +repo_url: https://github.com/shaarli/Shaarli +edit_uri: edit/master/doc/md +site_description: The personal, minimalist, super-fast, database free, bookmarking service +theme: readthedocs +docs_dir: doc/md +site_dir: doc/html + +pages: +- Home: index.md +- Setup: + - Download and Installation: Download-and-Installation.md + - Upgrade and migration: Upgrade-and-migration.md + - Server requirements: Server-requirements.md + - Server configuration: Server-configuration.md + - Server security: Server-security.md + - Shaarli configuration: Shaarli-configuration.md + - Plugins: Plugins.md +- Docker: + - Docker 101: docker/docker-101.md + - Shaarli images: docker/shaarli-images.md + - Reverse proxy configuration: docker/reverse-proxy-configuration.md + - Docker resources: docker/resources.md +- Usage: + - Features: Features.md + - Bookmarklet: Bookmarklet.md + - Browsing and searching: Browsing-and-searching.md + - Firefox share: Firefox-share.md + - RSS feeds: RSS-feeds.md + - REST API: REST-API.md +- How To: + - Backup, restore, import and export: Backup,-restore,-import-and-export.md + - Various hacks: Various-hacks.md +- Troubleshooting: Troubleshooting.md +- Development: + - Development guidelines: Development-guidelines.md + - Continuous integration tools: Continuous-integration-tools.md + - GnuPG signature: GnuPG-signature.md + - Directory structure: Directory-structure.md + - 3rd party libraries: 3rd-party-libraries.md + - Plugin System: Plugin-System.md + - Release Shaarli: Release-Shaarli.md + - Versioning and Branches: Versioning-and-Branches.md + - Security: Security.md + - Static analysis: Static-analysis.md + - Theming: Theming.md + - Unit tests: Unit-tests.md +- About: + - FAQ: FAQ.md + - Community & Related software: Community-&-Related-software.md diff --git a/plugins/markdown/markdown.php b/plugins/markdown/markdown.php index de7c823d..772c56e8 100644 --- a/plugins/markdown/markdown.php +++ b/plugins/markdown/markdown.php @@ -26,7 +26,11 @@ function hook_markdown_render_linklist($data, $conf) $value = stripNoMarkdownTag($value); continue; } - $value['description'] = process_markdown($value['description'], $conf->get('security.markdown_escape', true)); + $value['description'] = process_markdown( + $value['description'], + $conf->get('security.markdown_escape', true), + $conf->get('security.allowed_protocols') + ); } return $data; } @@ -46,7 +50,11 @@ function hook_markdown_render_feed($data, $conf) $value = stripNoMarkdownTag($value); continue; } - $value['description'] = process_markdown($value['description'], $conf->get('security.markdown_escape', true)); + $value['description'] = process_markdown( + $value['description'], + $conf->get('security.markdown_escape', true), + $conf->get('security.allowed_protocols') + ); } return $data; @@ -71,7 +79,8 @@ function hook_markdown_render_daily($data, $conf) } $value2['formatedDescription'] = process_markdown( $value2['formatedDescription'], - $conf->get('security.markdown_escape', true) + $conf->get('security.markdown_escape', true), + $conf->get('security.allowed_protocols') ); } } @@ -231,6 +240,25 @@ function reverse_space2nbsp($description) return preg_replace('/(^| ) /m', '$1 ', $description); } +/** + * Replace not whitelisted protocols with http:// in given description. + * + * @param string $description input description text. + * @param array $allowedProtocols list of allowed protocols. + * + * @return string $description without malicious link. + */ +function filter_protocols($description, $allowedProtocols) +{ + return preg_replace_callback( + '#]\((.*?)\)#is', + function ($match) use ($allowedProtocols) { + return ']('. whitelist_protocols($match[1], $allowedProtocols) .')'; + }, + $description + ); +} + /** * Remove dangerous HTML tags (tags, iframe, etc.). * Doesn't affect content (already escaped by Parsedown). @@ -275,7 +303,7 @@ function ($match) { return escape($match[0]); }, * * @return string HTML processed $description. */ -function process_markdown($description, $escape = true) +function process_markdown($description, $escape = true, $allowedProtocols = []) { $parsedown = new Parsedown(); @@ -283,6 +311,7 @@ function process_markdown($description, $escape = true) $processedDescription = reverse_nl2br($processedDescription); $processedDescription = reverse_space2nbsp($processedDescription); $processedDescription = reverse_text2clickable($processedDescription); + $processedDescription = filter_protocols($processedDescription, $allowedProtocols); $processedDescription = unescape($processedDescription); $processedDescription = $parsedown ->setMarkupEscaped($escape) diff --git a/shaarli_version.php b/shaarli_version.php index 148bc431..102289f4 100644 --- a/shaarli_version.php +++ b/shaarli_version.php @@ -1 +1 @@ - + diff --git a/tests/HttpUtils/ServerUrlTest.php b/tests/HttpUtils/ServerUrlTest.php index 7fdad659..dac02b3e 100644 --- a/tests/HttpUtils/ServerUrlTest.php +++ b/tests/HttpUtils/ServerUrlTest.php @@ -38,6 +38,34 @@ public function testHttpsScheme() ); } + /** + * Detect a Proxy that sets Forwarded-Host + */ + public function testHttpsProxyForwardedHost() + { + $this->assertEquals( + 'https://host.tld:8080', + server_url( + array( + 'HTTP_X_FORWARDED_PROTO' => 'https', + 'HTTP_X_FORWARDED_PORT' => '8080', + 'HTTP_X_FORWARDED_HOST' => 'host.tld' + ) + ) + ); + + $this->assertEquals( + 'https://host.tld:4974', + server_url( + array( + 'HTTP_X_FORWARDED_PROTO' => 'https, https', + 'HTTP_X_FORWARDED_PORT' => '4974, 80', + 'HTTP_X_FORWARDED_HOST' => 'host.tld, example.com' + ) + ) + ); + } + /** * Detect a Proxy with SSL enabled */ diff --git a/tests/LinkDBTest.php b/tests/LinkDBTest.php index 7bf98f92..5b2f3667 100644 --- a/tests/LinkDBTest.php +++ b/tests/LinkDBTest.php @@ -297,7 +297,7 @@ public function testAllTags() 'sTuff' => 2, 'ut' => 1, ), - self::$publicLinkDB->allTags() + self::$publicLinkDB->linksCountPerTag() ); $this->assertEquals( @@ -325,7 +325,34 @@ public function testAllTags() 'tag4' => 1, 'ut' => 1, ), - self::$privateLinkDB->allTags() + self::$privateLinkDB->linksCountPerTag() + ); + $this->assertEquals( + array( + 'web' => 4, + 'cartoon' => 2, + 'gnu' => 1, + 'dev' => 1, + 'samba' => 1, + 'media' => 1, + 'html' => 1, + 'w3c' => 1, + 'css' => 1, + 'Mercurial' => 1, + '.hidden' => 1, + 'hashtag' => 1, + ), + self::$privateLinkDB->linksCountPerTag(['web']) + ); + $this->assertEquals( + array( + 'web' => 1, + 'html' => 1, + 'w3c' => 1, + 'css' => 1, + 'Mercurial' => 1, + ), + self::$privateLinkDB->linksCountPerTag(['web'], 'private') ); } @@ -448,7 +475,7 @@ public function testFilterHashInValid() public function testReorderLinksDesc() { self::$privateLinkDB->reorder('ASC'); - $linkIds = array(42, 4, 1, 0, 7, 6, 8, 41); + $linkIds = array(42, 4, 9, 1, 0, 7, 6, 8, 41); $cpt = 0; foreach (self::$privateLinkDB as $key => $value) { $this->assertEquals($linkIds[$cpt++], $key); @@ -460,4 +487,59 @@ public function testReorderLinksDesc() $this->assertEquals($linkIds[$cpt++], $key); } } + + /** + * Test rename tag with a valid value present in multiple links + */ + public function testRenameTagMultiple() + { + self::$refDB->write(self::$testDatastore); + $linkDB = new LinkDB(self::$testDatastore, true, false); + + $res = $linkDB->renameTag('cartoon', 'Taz'); + $this->assertEquals(3, count($res)); + $this->assertContains(' Taz ', $linkDB[4]['tags']); + $this->assertContains(' Taz ', $linkDB[1]['tags']); + $this->assertContains(' Taz ', $linkDB[0]['tags']); + } + + /** + * Test rename tag with a valid value + */ + public function testRenameTagCaseSensitive() + { + self::$refDB->write(self::$testDatastore); + $linkDB = new LinkDB(self::$testDatastore, true, false, ''); + + $res = $linkDB->renameTag('sTuff', 'Taz'); + $this->assertEquals(1, count($res)); + $this->assertEquals('Taz', $linkDB[41]['tags']); + } + + /** + * Test rename tag with invalid values + */ + public function testRenameTagInvalid() + { + $linkDB = new LinkDB(self::$testDatastore, false, false); + + $this->assertFalse($linkDB->renameTag('', 'test')); + $this->assertFalse($linkDB->renameTag('', '')); + // tag non existent + $this->assertEquals([], $linkDB->renameTag('test', '')); + $this->assertEquals([], $linkDB->renameTag('test', 'retest')); + } + + /** + * Test delete tag with a valid value + */ + public function testDeleteTag() + { + self::$refDB->write(self::$testDatastore); + $linkDB = new LinkDB(self::$testDatastore, true, false); + + $res = $linkDB->renameTag('cartoon', null); + $this->assertEquals(3, count($res)); + $this->assertNotContains('cartoon', $linkDB[4]['tags']); + } } diff --git a/tests/LinkFilterTest.php b/tests/LinkFilterTest.php index 37d5ca30..d796d3a3 100644 --- a/tests/LinkFilterTest.php +++ b/tests/LinkFilterTest.php @@ -63,6 +63,11 @@ public function testFilter() count(self::$linkFilter->filter(LinkFilter::$FILTER_TAG, '')) ); + $this->assertEquals( + self::$refDB->countUntaggedLinks(), + count(self::$linkFilter->filter(LinkFilter::$FILTER_TAG, /*$request=*/'', /*$casesensitive=*/false, /*$visibility=*/'all', /*$untaggedonly=*/true)) + ); + $this->assertEquals( ReferenceLinkDB::$NB_LINKS_TOTAL, count(self::$linkFilter->filter(LinkFilter::$FILTER_TEXT, '')) @@ -146,7 +151,7 @@ public function testFilterUnknownTag() public function testFilterDay() { $this->assertEquals( - 3, + 4, count(self::$linkFilter->filter(LinkFilter::$FILTER_DAY, '20121206')) ); } @@ -339,7 +344,7 @@ public function testExcludeSearch() ); $this->assertEquals( - 7, + ReferenceLinkDB::$NB_LINKS_TOTAL - 1, count(self::$linkFilter->filter(LinkFilter::$FILTER_TEXT, '-revolution')) ); } @@ -399,7 +404,7 @@ public function testTagFilterWithExclusion() ); $this->assertEquals( - 7, + ReferenceLinkDB::$NB_LINKS_TOTAL - 1, count(self::$linkFilter->filter(LinkFilter::$FILTER_TAG, '-free')) ); } @@ -425,6 +430,13 @@ public function testFilterCrossedSearch() array('', $terms) )) ); + $this->assertEquals( + 1, + count(self::$linkFilter->filter( + LinkFilter::$FILTER_TAG | LinkFilter::$FILTER_TEXT, + array(false, 'PSR-2') + )) + ); $this->assertEquals( 1, count(self::$linkFilter->filter( diff --git a/tests/Updater/UpdaterTest.php b/tests/Updater/UpdaterTest.php index 11b6444a..fed175df 100644 --- a/tests/Updater/UpdaterTest.php +++ b/tests/Updater/UpdaterTest.php @@ -469,46 +469,6 @@ public function testDefaultThemeWithCustomTheme() rmdir('sandbox/'. $theme); } - /** - * Test updateMethodDefaultThemeVintage with the default theme enabled. - */ - public function testSetDefaultThemeToVintage() - { - $sandboxConf = 'sandbox/config'; - copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); - $this->conf = new ConfigManager($sandboxConf); - - $this->conf->set('resource.theme', 'default'); - $updater = new Updater([], [], $this->conf, true); - $this->assertTrue($updater->updateMethodDefaultThemeVintage()); - $this->assertEquals('vintage', $this->conf->get('resource.theme')); - - // reload from file - $this->conf = new ConfigManager($sandboxConf); - $this->assertEquals('vintage', $this->conf->get('resource.theme')); - } - - /** - * Test updateMethodDefaultThemeVintage with custom theme enabled => nothing to do. - */ - public function testSetDefaultThemeNothingToDo() - { - $sandboxConf = 'sandbox/config'; - copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); - $this->conf = new ConfigManager($sandboxConf); - - $theme = 'myawesometheme'; - $this->conf->set('resource.theme', $theme); - $this->conf->write(true); - $updater = new Updater([], [], $this->conf, true); - $this->assertTrue($updater->updateMethodDefaultThemeVintage()); - $this->assertEquals($theme, $this->conf->get('resource.theme')); - - // reload from file - $this->conf = new ConfigManager($sandboxConf); - $this->assertEquals($theme, $this->conf->get('resource.theme')); - } - /** * Test updateMethodEscapeMarkdown with markdown plugin enabled * => setting markdown_escape set to false. diff --git a/tests/Url/WhitelistProtocolsTest.php b/tests/Url/WhitelistProtocolsTest.php new file mode 100644 index 00000000..a3156804 --- /dev/null +++ b/tests/Url/WhitelistProtocolsTest.php @@ -0,0 +1,63 @@ +assertEquals($url, whitelist_protocols($url, $whitelist)); + $url = '/path.jpg'; + $this->assertEquals($url, whitelist_protocols($url, $whitelist)); + } + + /** + * Test whitelist_protocols() on a note (relative URL). + */ + public function testWhitelistProtocolMissing() + { + $whitelist = ['ftp', 'magnet']; + $url = 'test.tld/path/?query=value#hash'; + $this->assertEquals('http://'. $url, whitelist_protocols($url, $whitelist)); + } + + /** + * Test whitelist_protocols() with allowed protocols. + */ + public function testWhitelistAllowedProtocol() + { + $whitelist = ['ftp', 'magnet']; + $url = 'http://test.tld/path/?query=value#hash'; + $this->assertEquals($url, whitelist_protocols($url, $whitelist)); + $url = 'https://test.tld/path/?query=value#hash'; + $this->assertEquals($url, whitelist_protocols($url, $whitelist)); + $url = 'ftp://test.tld/path/?query=value#hash'; + $this->assertEquals($url, whitelist_protocols($url, $whitelist)); + $url = 'magnet:test.tld/path/?query=value#hash'; + $this->assertEquals($url, whitelist_protocols($url, $whitelist)); + } + + /** + * Test whitelist_protocols() with allowed protocols. + */ + public function testWhitelistDisallowedProtocol() + { + $whitelist = ['ftp', 'magnet']; + $url = 'javascript:alert("xss");'; + $this->assertEquals('http://alert("xss");', whitelist_protocols($url, $whitelist)); + $url = 'other://test.tld/path/?query=value#hash'; + $this->assertEquals('http://test.tld/path/?query=value#hash', whitelist_protocols($url, $whitelist)); + } +} diff --git a/tests/UtilsTest.php b/tests/UtilsTest.php index d6a0aad5..3d1aa653 100644 --- a/tests/UtilsTest.php +++ b/tests/UtilsTest.php @@ -417,4 +417,116 @@ public function testGetMaxUploadSizeRaw() $this->assertEquals('1048576', get_max_upload_size('1m', '2m', false)); $this->assertEquals('100', get_max_upload_size(100, 100, false)); } + + /** + * Test alphabetical_sort by value, not reversed, with php-intl. + */ + public function testAlphabeticalSortByValue() + { + $arr = [ + 'zZz', + 'éee', + 'éae', + 'eee', + 'A', + 'a', + 'zzz', + ]; + $expected = [ + 'a', + 'A', + 'éae', + 'eee', + 'éee', + 'zzz', + 'zZz', + ]; + + alphabetical_sort($arr); + $this->assertEquals($expected, $arr); + } + + /** + * Test alphabetical_sort by value, reversed, with php-intl. + */ + public function testAlphabeticalSortByValueReversed() + { + $arr = [ + 'zZz', + 'éee', + 'éae', + 'eee', + 'A', + 'a', + 'zzz', + ]; + $expected = [ + 'zZz', + 'zzz', + 'éee', + 'eee', + 'éae', + 'A', + 'a', + ]; + + alphabetical_sort($arr, true); + $this->assertEquals($expected, $arr); + } + + /** + * Test alphabetical_sort by keys, not reversed, with php-intl. + */ + public function testAlphabeticalSortByKeys() + { + $arr = [ + 'zZz' => true, + 'éee' => true, + 'éae' => true, + 'eee' => true, + 'A' => true, + 'a' => true, + 'zzz' => true, + ]; + $expected = [ + 'a' => true, + 'A' => true, + 'éae' => true, + 'eee' => true, + 'éee' => true, + 'zzz' => true, + 'zZz' => true, + ]; + + alphabetical_sort($arr, true, true); + $this->assertEquals($expected, $arr); + } + + /** + * Test alphabetical_sort by keys, reversed, with php-intl. + */ + public function testAlphabeticalSortByKeysReversed() + { + $arr = [ + 'zZz' => true, + 'éee' => true, + 'éae' => true, + 'eee' => true, + 'A' => true, + 'a' => true, + 'zzz' => true, + ]; + $expected = [ + 'zZz' => true, + 'zzz' => true, + 'éee' => true, + 'eee' => true, + 'éae' => true, + 'A' => true, + 'a' => true, + ]; + + alphabetical_sort($arr, true, true); + $this->assertEquals($expected, $arr); + } } diff --git a/tests/api/controllers/GetLinksTest.php b/tests/api/controllers/GetLinksTest.php index 84ae7f7a..4cb70224 100644 --- a/tests/api/controllers/GetLinksTest.php +++ b/tests/api/controllers/GetLinksTest.php @@ -95,7 +95,7 @@ public function testGetLinks() $this->assertEquals($this->refDB->countLinks(), count($data)); // Check order - $order = [41, 8, 6, 7, 0, 1, 4, 42]; + $order = [41, 8, 6, 7, 0, 1, 9, 4, 42]; $cpt = 0; foreach ($data as $link) { $this->assertEquals(self::NB_FIELDS_LINK, count($link)); @@ -164,7 +164,7 @@ public function testGetLinksLimitAll() $data = json_decode((string) $response->getBody(), true); $this->assertEquals($this->refDB->countLinks(), count($data)); // Check order - $order = [41, 8, 6, 7, 0, 1, 4, 42]; + $order = [41, 8, 6, 7, 0, 1, 9, 4, 42]; $cpt = 0; foreach ($data as $link) { $this->assertEquals(self::NB_FIELDS_LINK, count($link)); diff --git a/tests/api/controllers/InfoTest.php b/tests/api/controllers/InfoTest.php index e85eb281..f7e63bfa 100644 --- a/tests/api/controllers/InfoTest.php +++ b/tests/api/controllers/InfoTest.php @@ -81,7 +81,7 @@ public function testGetInfo() $this->assertEquals(200, $response->getStatusCode()); $data = json_decode((string) $response->getBody(), true); - $this->assertEquals(8, $data['global_counter']); + $this->assertEquals(\ReferenceLinkDB::$NB_LINKS_TOTAL, $data['global_counter']); $this->assertEquals(2, $data['private_counter']); $this->assertEquals('Shaarli', $data['settings']['title']); $this->assertEquals('?', $data['settings']['header_link']); @@ -104,7 +104,7 @@ public function testGetInfo() $this->assertEquals(200, $response->getStatusCode()); $data = json_decode((string) $response->getBody(), true); - $this->assertEquals(8, $data['global_counter']); + $this->assertEquals(\ReferenceLinkDB::$NB_LINKS_TOTAL, $data['global_counter']); $this->assertEquals(2, $data['private_counter']); $this->assertEquals($title, $data['settings']['title']); $this->assertEquals($headerLink, $data['settings']['header_link']); diff --git a/tests/plugins/PluginMarkdownTest.php b/tests/plugins/PluginMarkdownTest.php index d8180ad6..96891f1f 100644 --- a/tests/plugins/PluginMarkdownTest.php +++ b/tests/plugins/PluginMarkdownTest.php @@ -26,6 +26,7 @@ public function setUp() { PluginManager::$PLUGINS_PATH = 'plugins'; $this->conf = new ConfigManager('tests/utils/config/configJson'); + $this->conf->set('security.allowed_protocols', ['ftp', 'magnet']); } /** @@ -183,15 +184,19 @@ public function testNoMarkdownNotExcactlyMatching() } /** - * Test hashtag links processed with markdown. + * Make sure that the generated HTML match the reference HTML file. */ - public function testMarkdownHashtagLinks() + public function testMarkdownGlobalProcessDescription() { $md = file_get_contents('tests/plugins/resources/markdown.md'); $md = format_description($md); $html = file_get_contents('tests/plugins/resources/markdown.html'); - $data = process_markdown($md); + $data = process_markdown( + $md, + $this->conf->get('security.markdown_escape', true), + $this->conf->get('security.allowed_protocols') + ); $this->assertEquals($html, $data); } diff --git a/tests/plugins/resources/markdown.html b/tests/plugins/resources/markdown.html index 07a5a32e..844a6f31 100644 --- a/tests/plugins/resources/markdown.html +++ b/tests/plugins/resources/markdown.html @@ -21,4 +21,13 @@ next #foo

    Block:

    lorem ipsum #foobar http://link.tld
-#foobar http://link.tld
    \ No newline at end of file +#foobar http://link.tld +

    link
    +link
    +link
    +link
    +link
    +link
    +link
    +link
    +link

    \ No newline at end of file diff --git a/tests/plugins/resources/markdown.md b/tests/plugins/resources/markdown.md index 0b8be7c5..b8ebd934 100644 --- a/tests/plugins/resources/markdown.md +++ b/tests/plugins/resources/markdown.md @@ -21,4 +21,14 @@ Block: ``` lorem ipsum #foobar http://link.tld #foobar http://link.tld -``` \ No newline at end of file +``` + +[link](?123456) +![link](/img/train.png) +[link](test.tld/path/?query=value#hash) +[link](http://test.tld/path/?query=value#hash) +[link](https://test.tld/path/?query=value#hash) +[link](ftp://test.tld/path/?query=value#hash) +[link](magnet:test.tld/path/?query=value#hash) +[link](javascript:alert('xss')) +[link](other://test.tld/path/?query=value#hash) \ No newline at end of file diff --git a/tests/utils/ReferenceLinkDB.php b/tests/utils/ReferenceLinkDB.php index 1f4b3063..f09eebc1 100644 --- a/tests/utils/ReferenceLinkDB.php +++ b/tests/utils/ReferenceLinkDB.php @@ -4,7 +4,7 @@ */ class ReferenceLinkDB { - public static $NB_LINKS_TOTAL = 8; + public static $NB_LINKS_TOTAL = 9; private $_links = array(); private $_publicCount = 0; @@ -37,6 +37,16 @@ public function __construct() 'ut' ); + $this->addLink( + 9, + 'PSR-2: Coding Style Guide', + 'http://www.php-fig.org/psr/psr-2/', + 'This guide extends and expands on PSR-1, the basic coding standard.', + 0, + DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20121206_152312'), + '' + ); + $this->addLink( 8, 'Free as in Freedom 2.0 @website', @@ -161,6 +171,20 @@ public function countPrivateLinks() return $this->_privateCount; } + /** + * Returns the number of links without tag + */ + public function countUntaggedLinks() + { + $cpt = 0; + foreach ($this->_links as $link) { + if (empty($link['tags'])) { + ++$cpt; + } + } + return $cpt; + } + public function getLinks() { return $this->_links; diff --git a/tpl/default/changetag.html b/tpl/default/changetag.html index 8d263a16..49dd20d9 100644 --- a/tpl/default/changetag.html +++ b/tpl/default/changetag.html @@ -11,7 +11,7 @@

    {"Manage tags"|t}

    - {loop="$tags"}{/loop} @@ -31,6 +31,8 @@

    {"Manage tags"|t}

    + +

    You can also edit tags in the tag list.

    {include="page.footer"} diff --git a/tpl/default/css/shaarli.css b/tpl/default/css/shaarli.css index 73fade5f..e1868c59 100644 --- a/tpl/default/css/shaarli.css +++ b/tpl/default/css/shaarli.css @@ -211,7 +211,7 @@ body, .pure-g [class*="pure-u"] { } } -#search, #search-linklist { +#search, #search-linklist, #search-tagcloud { text-align: center; width: 100%; } @@ -226,6 +226,12 @@ body, .pure-g [class*="pure-u"] { border-radius: 2px; color: #252525; } +@media screen and (max-width: 64em) { + .searchform { + max-width: 260px; + margin: 0 auto; + } +} /* because chrome */ #search input[type="text"]::-webkit-input-placeholder, @@ -234,47 +240,58 @@ body, .pure-g [class*="pure-u"] { } #search button, +#search-tagcloud button, #search-linklist button { - background: transparent; - border: none; -} - -#search button { + padding: 4px 8px 6px 8px; + background-color: #1B926C; color: #f5f5f5; + border: none; + border-radius: 2px; } -#search-linklist button { - color: #252525; +#search-tagcloud button { + width: 90%; +} + +@media screen and (max-width: 64em) { + #search-linklist button { + width: 100%; + } + #search-linklist .awesomplete { + margin: 5px 0; + } } #search button:hover, -#search-linklist button:hover { - color: #fff; +#search-linklist button:hover, +#search-tagcloud button:hover { + color: #d0d0d0; } +#search, #search-linklist { - padding: 5px 0; + padding: 6px 0; } -@media screen and (min-width: 64em) { - #search .searchform, - #search-linklist .searchform { - margin-right: 25px; - text-align: right; - } - - #search .tagfilter, - #search-linklist .tagfilter { - margin-left: 25px; - text-align: left; - } -} @media screen and (max-width: 64em) { #search, #search * { visibility: hidden; } } +.subheader-form a.button { + color: #f5f5f5; + font-weight: bold; + text-decoration: none; + border: 2px solid #f5f5f5; + border-radius: 5px; + padding: 3px 10px; +} + +.linklist-item-editbuttons .delete-checkbox { + display: none; +} + #header-login-form input[type="text"], #header-login-form input[type="password"] { width: 200px; } @@ -304,7 +321,6 @@ body, .pure-g [class*="pure-u"] { } .subheader-form input[type="text"], .subheader-form input[type="password"], .subheader-form .remember-me { - margin: 0 0 5px 0; padding: 5px 5px 3px 15px; height: 20px; width: 20%; @@ -522,8 +538,8 @@ body, .pure-g [class*="pure-u"] { color: #1b926c; } -.linklist-item-title .linklist-link:visited { - color: #1b926c; +.linklist-item-title a:visited .linklist-link { + color: #555555; } .linklist-item-title a:hover, .linklist-item-title .linklist-link:hover{ @@ -734,10 +750,11 @@ body, .pure-g [class*="pure-u"] { .page-form a { color: #1b926c; font-weight: bold; + text-decoration: none; } .page-form p { - padding: 0 10px; + padding: 5px 10px; margin: 0; } @@ -974,6 +991,14 @@ form[name="linkform"].page-form { color: #3f3f3f; } +/** + * EDIT LINK + */ +#editlinkform .created-date { + color: #767676; + margin-bottom: 10px; +} + /** * LOGIN */ @@ -1053,7 +1078,7 @@ form[name="linkform"].page-form { } #cloudtag, #cloudtag a { - color: #000; + color: #252525; text-decoration: none; } @@ -1061,6 +1086,42 @@ form[name="linkform"].page-form { color: #7f7f7f; } +/** + * TAG LIST + */ +#taglist { + padding: 0 10px; +} + +#taglist a { + color: #252525; + text-decoration: none; +} + +#taglist .count { + display: inline-block; + width: 35px; + text-align: right; + color: #7f7f7f; +} + +#taglist .rename-tag-form { + display: none; +} + +#taglist .delete-tag { + color: #ac2925; + display: none; +} + +#taglist .rename-tag { + color: #0b5ea6; +} + +#taglist .validate-rename-tag { + color: #1b926c; +} + /** * Picture wall CSS */ @@ -1210,3 +1271,16 @@ form[name="linkform"].page-form { .pure-button { -moz-user-select: auto; } + +.tag-sort { + margin-top: 30px; + text-align: center; +} + +.tag-sort a { + display: inline-block; + margin: 0 15px; + color: white; + text-decoration: none; + font-weight: bold; +} diff --git a/tpl/default/editlink.html b/tpl/default/editlink.html index 354499a4..d03fd72f 100644 --- a/tpl/default/editlink.html +++ b/tpl/default/editlink.html @@ -8,11 +8,15 @@
    -

    {'Shaare'|t}

    +

    + {if="!$link_is_new"}{'Edit'|t}{/if} + {'Shaare'|t} +

    {if="isset($link.id)"} {/if} + {if="!$link_is_new"}
    {'Created:'|t} {$link.created|format_date}
    {/if}
    @@ -55,7 +59,8 @@

    {'Shaare'|t}

    - + {if="!$link_is_new"} diff --git a/tpl/default/includes.html b/tpl/default/includes.html index 91c6ca3b..0350ef66 100644 --- a/tpl/default/includes.html +++ b/tpl/default/includes.html @@ -11,7 +11,7 @@ -{if="is_file('inc/user.css')"} +{if="is_file('data/user.css')"} {/if} {loop="$plugins_includes.css_files"} diff --git a/tpl/default/js/shaarli.js b/tpl/default/js/shaarli.js index 4d47fcd0..4f49affa 100644 --- a/tpl/default/js/shaarli.js +++ b/tpl/default/js/shaarli.js @@ -216,14 +216,14 @@ window.onload = function () { /** * Autofocus text fields */ - // ES6 syntax - let autofocusElements = document.querySelectorAll('.autofocus'); - for (let autofocusElement of autofocusElements) { - if (autofocusElement.value == '') { + var autofocusElements = document.querySelectorAll('.autofocus'); + var breakLoop = false; + [].forEach.call(autofocusElements, function(autofocusElement) { + if (autofocusElement.value == '' && ! breakLoop) { autofocusElement.focus(); - break; + breakLoop = true; } - } + }); /** * Handle sub menus/forms @@ -357,16 +357,256 @@ window.onload = function () { var continent = document.getElementById('continent'); var city = document.getElementById('city'); if (continent != null && city != null) { - continent.addEventListener('change', function(event) { + continent.addEventListener('change', function (event) { hideTimezoneCities(city, continent.options[continent.selectedIndex].value, true); }); hideTimezoneCities(city, continent.options[continent.selectedIndex].value, false); } + + /** + * Bulk actions + */ + var linkCheckboxes = document.querySelectorAll('.delete-checkbox'); + var bar = document.getElementById('actions'); + [].forEach.call(linkCheckboxes, function(checkbox) { + checkbox.style.display = 'block'; + checkbox.addEventListener('click', function(event) { + var count = 0; + var linkCheckedCheckboxes = document.querySelectorAll('.delete-checkbox:checked'); + [].forEach.call(linkCheckedCheckboxes, function(checkbox) { + count++; + }); + if (count == 0 && bar.classList.contains('open')) { + bar.classList.toggle('open'); + } else if (count > 0 && ! bar.classList.contains('open')) { + bar.classList.toggle('open'); + } + }); + }); + + var deleteButton = document.getElementById('actions-delete'); + var token = document.querySelector('input[type="hidden"][name="token"]'); + if (deleteButton != null && token != null) { + deleteButton.addEventListener('click', function(event) { + event.preventDefault(); + + var links = []; + var linkCheckedCheckboxes = document.querySelectorAll('.delete-checkbox:checked'); + [].forEach.call(linkCheckedCheckboxes, function(checkbox) { + links.push({ + 'id': checkbox.value, + 'title': document.querySelector('.linklist-item[data-id="'+ checkbox.value +'"] .linklist-link').innerHTML + }); + }); + + var message = 'Are you sure you want to delete '+ links.length +' links?\n'; + message += 'This action is IRREVERSIBLE!\n\nTitles:\n'; + var ids = ''; + links.forEach(function(item) { + message += ' - '+ item['title'] +'\n'; + ids += item['id'] +'+'; + }); + + if (window.confirm(message)) { + window.location = '?delete_link&lf_linkdate='+ ids +'&token='+ token.value; + } + }); + } + + /** + * Tag list operations + * + * TODO: support error code in the backend for AJAX requests + */ + var tagList = document.querySelector('input[name="taglist"]'); + var existingTags = tagList ? tagList.value.split(' ') : []; + var awesomepletes = []; + + // Display/Hide rename form + var renameTagButtons = document.querySelectorAll('.rename-tag'); + [].forEach.call(renameTagButtons, function(rename) { + rename.addEventListener('click', function(event) { + event.preventDefault(); + var block = findParent(event.target, 'div', {'class': 'tag-list-item'}); + var form = block.querySelector('.rename-tag-form'); + if (form.style.display == 'none' || form.style.display == '') { + form.style.display = 'block'; + } else { + form.style.display = 'none'; + } + block.querySelector('input').focus(); + }); + }); + + // Rename a tag with an AJAX request + var renameTagSubmits = document.querySelectorAll('.validate-rename-tag'); + [].forEach.call(renameTagSubmits, function(rename) { + rename.addEventListener('click', function(event) { + event.preventDefault(); + var block = findParent(event.target, 'div', {'class': 'tag-list-item'}); + var input = block.querySelector('.rename-tag-input'); + var totag = input.value.replace('/"/g', '\\"'); + if (totag.trim() == '') { + return; + } + var fromtag = block.getAttribute('data-tag'); + var token = document.getElementById('token').value; + + xhr = new XMLHttpRequest(); + xhr.open('POST', '?do=changetag'); + xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); + xhr.onload = function() { + if (xhr.status !== 200) { + alert('An error occurred. Return code: '+ xhr.status); + location.reload(); + } else { + block.setAttribute('data-tag', totag); + input.setAttribute('name', totag); + input.setAttribute('value', totag); + findParent(input, 'div', {'class': 'rename-tag-form'}).style.display = 'none'; + block.querySelector('a.tag-link').innerHTML = htmlEntities(totag); + block.querySelector('a.tag-link').setAttribute('href', '?searchtags='+ encodeURIComponent(totag)); + block.querySelector('a.rename-tag').setAttribute('href', '?do=changetag&fromtag='+ encodeURIComponent(totag)); + + // Refresh awesomplete values + for (var key in existingTags) { + if (existingTags[key] == fromtag) { + existingTags[key] = totag; + } + } + awesomepletes = updateAwesompleteList('.rename-tag-input', existingTags, awesomepletes); + } + }; + xhr.send('renametag=1&fromtag='+ encodeURIComponent(fromtag) +'&totag='+ encodeURIComponent(totag) +'&token='+ token); + refreshToken(); + }); + }); + + // Validate input with enter key + var renameTagInputs = document.querySelectorAll('.rename-tag-input'); + [].forEach.call(renameTagInputs, function(rename) { + + rename.addEventListener('keypress', function(event) { + if (event.keyCode === 13) { // enter + findParent(event.target, 'div', {'class': 'tag-list-item'}).querySelector('.validate-rename-tag').click(); + } + }); + }); + + // Delete a tag with an AJAX query (alert popup confirmation) + var deleteTagButtons = document.querySelectorAll('.delete-tag'); + [].forEach.call(deleteTagButtons, function(rename) { + rename.style.display = 'inline'; + rename.addEventListener('click', function(event) { + event.preventDefault(); + var block = findParent(event.target, 'div', {'class': 'tag-list-item'}); + var tag = block.getAttribute('data-tag'); + var token = document.getElementById('token').value; + + if (confirm('Are you sure you want to delete the tag "'+ tag +'"?')) { + xhr = new XMLHttpRequest(); + xhr.open('POST', '?do=changetag'); + xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); + xhr.onload = function() { + block.remove(); + }; + xhr.send(encodeURI('deletetag=1&fromtag='+ tag +'&token='+ token)); + refreshToken(); + } + }); + }); + + updateAwesompleteList('.rename-tag-input', existingTags, awesomepletes); }; +/** + * Find a parent element according to its tag and its attributes + * + * @param element Element where to start the search + * @param tagName Expected parent tag name + * @param attributes Associative array of expected attributes (name=>value). + * + * @returns Found element or null. + */ +function findParent(element, tagName, attributes) +{ + while (element) { + if (element.tagName.toLowerCase() == tagName) { + var match = true; + for (var key in attributes) { + if (! element.hasAttribute(key) + || (attributes[key] != '' && element.getAttribute(key).indexOf(attributes[key]) == -1) + ) { + match = false; + break; + } + } + + if (match) { + return element; + } + } + element = element.parentElement; + } + return null; +} + +/** + * Ajax request to refresh the CSRF token. + */ +function refreshToken() +{ + var xhr = new XMLHttpRequest(); + xhr.open('GET', '?do=token'); + xhr.onload = function() { + var token = document.getElementById('token'); + token.setAttribute('value', xhr.responseText); + }; + xhr.send(); +} + +/** + * Update awesomplete list of tag for all elements matching the given selector + * + * @param selector CSS selector + * @param tags Array of tags + * @param instances List of existing awesomplete instances + */ +function updateAwesompleteList(selector, tags, instances) +{ + // First load: create Awesomplete instances + if (instances.length == 0) { + var elements = document.querySelectorAll(selector); + [].forEach.call(elements, function (element) { + instances.push(new Awesomplete( + element, + {'list': tags} + )); + }); + } else { + // Update awesomplete tag list + for (var key in instances) { + instances[key].list = tags; + } + } + return instances; +} + +/** + * html_entities in JS + * + * @see http://stackoverflow.com/questions/18749591/encode-html-entities-in-javascript + */ +function htmlEntities(str) +{ + return str.replace(/[\u00A0-\u9999<>\&]/gim, function(i) { + return '&#'+i.charCodeAt(0)+';'; + }); +} + function activateFirefoxSocial(node) { var loc = location.href; - var baseURL = loc.substring(0, loc.lastIndexOf("/")); + var baseURL = loc.substring(0, loc.lastIndexOf("/") + 1); // Keeping the data separated (ie. not in the DOM) so that it's maintainable and diffable. var data = { @@ -379,7 +619,7 @@ function activateFirefoxSocial(node) { icon32URL: baseURL + "/images/favicon.ico", icon64URL: baseURL + "/images/favicon.ico", - shareURL: baseURL + "{noparse}?post=%{url}&title=%{title}&description=%{text}&source=firefoxsocialapi{/noparse}", + shareURL: baseURL + "?post=%{url}&title=%{title}&description=%{text}&source=firefoxsocialapi", homepageURL: baseURL }; node.setAttribute("data-service", JSON.stringify(data)); @@ -395,9 +635,12 @@ function activateFirefoxSocial(node) { * @param currentContinent Current selected continent * @param reset Set to true to reset the selected value */ -function hideTimezoneCities(cities, currentContinent, reset = false) { +function hideTimezoneCities(cities, currentContinent) { var first = true; - [].forEach.call(cities, function(option) { + if (reset == null) { + reset = false; + } + [].forEach.call(cities, function (option) { if (option.getAttribute('data-continent') != currentContinent) { option.className = 'hidden'; } else { diff --git a/tpl/default/linklist.html b/tpl/default/linklist.html index 57ef4567..685821e3 100644 --- a/tpl/default/linklist.html +++ b/tpl/default/linklist.html @@ -15,32 +15,25 @@ {/if}
    + + {loop="$plugins_header.fields_toolbar"} @@ -89,7 +82,7 @@
    {'Nothing found.'|t}
    - {elseif="!empty($search_term) or !empty($search_tags) or !empty($visibility)"} + {elseif="!empty($search_term) or $search_tags !== '' or !empty($visibility) or $untaggedonly"}
    @@ -112,6 +105,11 @@ {$visibility|t} {/if} + {if="$untaggedonly"} + + {'without any tag'|t} + + {/if}
    {/if} @@ -121,7 +119,7 @@
    {loop="links"}
    -
    +
    {if="isLoggedIn()"} @@ -129,6 +127,7 @@ {if="$value.private"} {'Private'|t} {/if} + diff --git a/tpl/default/linklist.paging.html b/tpl/default/linklist.paging.html index d8c1e76e..41e9fa34 100644 --- a/tpl/default/linklist.paging.html +++ b/tpl/default/linklist.paging.html @@ -6,10 +6,13 @@ {'Filters'|t} {if="isLoggedIn()"} - + {/if} + @@ -55,4 +58,4 @@
    -
    \ No newline at end of file +
    diff --git a/tpl/default/page.footer.html b/tpl/default/page.footer.html index 77fc65dd..94f771a2 100644 --- a/tpl/default/page.footer.html +++ b/tpl/default/page.footer.html @@ -9,13 +9,16 @@ {/if} · The personal, minimalist, super-fast, database free, bookmarking service by the Shaarli community · - Documentation + Documentation {loop="$plugins_footer.text"} {$value} {/loop}
    + + + {loop="$plugins_footer.endofpage"} {$value} {/loop} diff --git a/tpl/default/page.header.html b/tpl/default/page.header.html index 9388ef79..2411703c 100644 --- a/tpl/default/page.header.html +++ b/tpl/default/page.header.html @@ -97,28 +97,26 @@
    +
    -
    -
    - - -
    -
    -
    -
    - - -
    +
    + Delete
    diff --git a/tpl/default/tag.cloud.html b/tpl/default/tag.cloud.html new file mode 100644 index 00000000..96b357a3 --- /dev/null +++ b/tpl/default/tag.cloud.html @@ -0,0 +1,69 @@ + + + + {include="includes"} + + +{include="page.header"} + +{include="tag.sort"} + +
    +
    +
    + {$countTags=count($tags)} +

    {'Tag cloud'|t} - {$countTags} {'tags'|t}

    + {if="!empty($search_tags)"} +

    + {'List all links with those tags'|t} +

    + {/if} + +
    +
    +
    +
    + + + +
    +
    +
    +
    + +
    + {loop="$plugin_start_zone"} + {$value} + {/loop} +
    + +
    + {loop="tags"} + {$key}{$value.count} + {loop="$value.tag_plugin"} + {$value} + {/loop} + {/loop} +
    + +
    + {loop="$plugin_end_zone"} + {$value} + {/loop} +
    +
    +
    + +{include="tag.sort"} + +{include="page.footer"} + + + diff --git a/tpl/default/tag.list.html b/tpl/default/tag.list.html new file mode 100644 index 00000000..a3e741d3 --- /dev/null +++ b/tpl/default/tag.list.html @@ -0,0 +1,89 @@ + + + + {include="includes"} + + +{include="page.header"} + +{include="tag.sort"} + +
    +
    +
    + {$countTags=count($tags)} +

    {'Tag list'|t} - {$countTags} {'tags'|t}

    + {if="!empty($search_tags)"} +

    + {'List all links with those tags'|t} +

    + {/if} + +
    +
    +
    +
    + + + +
    +
    +
    +
    + +
    + {loop="$plugin_start_zone"} + {$value} + {/loop} +
    + +
    + {loop="tags"} +
    +
    + {if="isLoggedIn()===true"} +    + + + + {/if} + + {$value} + {$key} + + {loop="$value.tag_plugin"} + {$value} + {/loop} +
    + {if="isLoggedIn()===true"} +
    + + +
    + {/if} +
    + {/loop} +
    + +
    + {loop="$plugin_end_zone"} + {$value} + {/loop} +
    +
    +
    + +{if="isLoggedIn()===true"} + + + diff --git a/tpl/default/tag.sort.html b/tpl/default/tag.sort.html new file mode 100644 index 00000000..89acda0d --- /dev/null +++ b/tpl/default/tag.sort.html @@ -0,0 +1,8 @@ +
    +
    + {'Sort by:'|t} + {'Cloud'|t} · + {'Most used'|t} · + {'Alphabetical'|t} +
    +
    \ No newline at end of file diff --git a/tpl/default/tagcloud.html b/tpl/default/tagcloud.html deleted file mode 100644 index 53c31748..00000000 --- a/tpl/default/tagcloud.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - {include="includes"} - - -{include="page.header"} - -
    -
    -
    - {$countTags=count($tags)} -

    {'Tag cloud'|t} - {$countTags} {'tags'|t}

    - -
    - {loop="$plugin_start_zone"} - {$value} - {/loop} -
    - -
    - {loop="tags"} - {$key}{$value.count} - {loop="$value.tag_plugin"} - {$value} - {/loop} - {/loop} -
    - -
    - {loop="$plugin_end_zone"} - {$value} - {/loop} -
    -
    -
    - -{include="page.footer"} - - - diff --git a/tpl/default/tools.html b/tpl/default/tools.html index baa033af..35173d17 100644 --- a/tpl/default/tools.html +++ b/tpl/default/tools.html @@ -72,10 +72,15 @@

    Bookmarklets

    function(){ var%20url%20=%20location.href; var%20title%20=%20document.title%20||%20url; + var%20desc=document.getSelection().toString(); + if(desc.length>4000){ + desc=desc.substr(0,4000)+'...'; + alert('{function="str_replace(' ', '%20', t('The selected text is too long, it will be truncated.'))"}'); + } window.open( '{$pageabsaddr}?post='%20+%20encodeURIComponent(url)+ '&title='%20+%20encodeURIComponent(title)+ - '&description='%20+%20encodeURIComponent(document.getSelection())+ + '&description='%20+%20encodeURIComponent(desc)+ '&source=bookmarklet','_blank','menubar=no,height=800,width=600,toolbar=no,scrollbars=yes,status=no,dialog=1' ); } @@ -86,8 +91,21 @@

    Bookmarklets

    + class="bookmarklet-link" + href="javascript:( + function(){ + var%20desc=document.getSelection().toString(); + if(desc.length>4000){ + desc=desc.substr(0,4000)+'...'; + alert("{function="str_replace(' ', '%20', t('The selected text is too long, it will be truncated.'))"}"); + } + window.open( + '{$pageabsaddr}?private=1&post='+ + '&description='%20+%20encodeURIComponent(desc)+ + '&source=bookmarklet','_blank','menubar=no,height=800,width=600,toolbar=no,scrollbars=yes,status=no,dialog=1' + ); + } + )();"> ✚ {'Add Note'|t}
    @@ -146,4 +164,3 @@

    {'3rd party'|t}

    value="{'Drag this link to your bookmarks toolbar, or right-click it and choose Bookmark This Link'|t}"> - diff --git a/tpl/vintage/linklist.html b/tpl/vintage/linklist.html index fc116667..8458caa1 100644 --- a/tpl/vintage/linklist.html +++ b/tpl/vintage/linklist.html @@ -55,7 +55,7 @@ {if="count($links)==0"}
    Nothing found.
    - {elseif="!empty($search_term) or !empty($search_tags)"} + {elseif="!empty($search_term) or $search_tags !== ''"}
    {$result_count} results {if="!empty($search_term)"} @@ -69,6 +69,10 @@ {$value} x {/loop} + {elseif="$search_tags === false"} + + untagged x + {/if}
    {/if} diff --git a/tpl/vintage/tagcloud.html b/tpl/vintage/tag.cloud.html similarity index 89% rename from tpl/vintage/tagcloud.html rename to tpl/vintage/tag.cloud.html index 05e45273..d93bf4f9 100644 --- a/tpl/vintage/tagcloud.html +++ b/tpl/vintage/tag.cloud.html @@ -12,7 +12,7 @@
    {loop="$tags"} - {$value.count}{$value.count}{$key} {loop="$value.tag_plugin"} {$value} diff --git a/tpl/vintage/tools.html b/tpl/vintage/tools.html index c36aa5b5..69689807 100644 --- a/tpl/vintage/tools.html +++ b/tpl/vintage/tools.html @@ -39,7 +39,15 @@

    ✚Add Note + href="javascript:( + function(){ + window.open( + '{$pageabsaddr}?private=1&post='+ + '&description='%20+%20encodeURIComponent(document.getSelection())+ + '&source=bookmarklet','_blank','menubar=no,height=800,width=600,toolbar=no,scrollbars=yes,status=no,dialog=1' + ); + } + )();">✚Add Note ⇐ Drag this link to your bookmarks toolbar (or right-click it and choose Bookmark This Link....).