* add shortcut in config
* open my labels menu with shortcut
* the first 9 items are selectable + input field
* i18n
* Update app/i18n/nl/conf.php
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
* index.menu.mylabels
* order fixed
---------
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Add option to sort results by received date (existing, default), publication date, title, URL (link), random.
fix https://github.com/FreshRSS/FreshRSS/issues/1771
fix https://github.com/FreshRSS/FreshRSS/issues/2083
fix https://github.com/FreshRSS/FreshRSS/issues/2119
fix https://github.com/FreshRSS/FreshRSS/issues/2596
fix https://github.com/FreshRSS/FreshRSS/issues/3204
fix https://github.com/FreshRSS/FreshRSS/issues/4405
fix https://github.com/FreshRSS/FreshRSS/issues/5529
fix https://github.com/FreshRSS/FreshRSS/issues/5864
fix https://github.com/FreshRSS/Extensions/issues/161
URL parameters:
* `&sort=id` (current behaviour, sorting according to newest received articles)
* `&sort=date` (publication date, which is not indicative of how new an article is)
* `&sort=title`
* `&sort=link`
* `&sort=rand` (random order - which disables infinite scrolling, at least for now)
combined with `&order=ASC` or `&order=DESC`
## Implementation notes
The sorting criteria by *received date* (id), which is the default, and which was the only one before this PR, is the one that has the best sorting characteristics:
* *uniqueness*: no entries have the exact same received date
* *monotonicity*: new entries always have a higher received date
* *performance*: this field is efficiently indexed in database for fast usage, including for paging (indexing could also be done to other fields, but with lower effective performance)
In contrary, sorting criteria such as by *publication date*, by *title*, or by *link* are neither unique nor monotonic. In particular, multiple articles may share the same *publication date*, and we may receive articles with a *publication date* far in the future, and then later some new articles with a *publication date* far in the past.
To understand why sorting by *publication date* is problematic, it helps to think about sorting by *title* or by *link*, as sorting by *title* and by *publication date* share more or less the same characteristics.
### Problem 1: new articles
New articles may be received in the background after what is shown on screen, and before the next user action such as *mark all as read*. Due to the lack of *monotonicity* when sorting by e.g. *publication date* or *title*, users risk marking as read a batch of articles containing some fresh articles without seeing them.
Mitigation: A parameter `idMax` tracks the maximum ID related to a batch of actions such as *mark all as read* to exclude articles received after those that are displayed.
### Problem 2: paging / pagination
When navigating articles, only a few articles are displayed, and a new "page" of articles needs to be received from the database when scrolling down or when clicking the button to show more articles. When sorting by e.g. *publication date* or *title*, it is not trivial to show the next page without re-showing some of the same articles, and without skipping any. Indeed, views are often with additional criteria such as showing only unread articles, and users may mark some articles as read while viewing them, hereby removing some articles from the previous pages. And like for *Problem 1*, new articles may have been received in the background. Consequently, it is not possible to use `OFFSET` to implement pagination (so the patches suggested by a few users were wrong due to that, in particular).
Mitigation: `idMax` is also used (just like for *Problem 1*) and a *Keyset Pagination* approach is used, combining an unstable sorting criterion such as *publication date* or *title*, together with *id* to ensure stable sorting. (So, 2 sorting criteria + 1 filter criteria)
See e.g. https://www.alwaysdeveloping.net/dailydrop/2022/07/01-keyset-pagination/
### Problem 3: performance
Sorting by anything else than *received date* (id) is doomed to be slow(er) due to the combination of 3 criteria (see *Problem 2*). An `OFFSET` approach (which is not possible anyway as explained) would be even slower. Furthermore, we have no SQL index at the moment, but they would not necessarily help much due to the multiple sorting criteria needed and involving some `OR` logic which is difficult to optimise for databases.
The nicest syntax would be using tuples and corresponding indexes, but that is poorly supported by MySQL https://bugs.mysql.com/bug.php?id=104128
Mitigation: a compatibility SQL syntax is used to implement *Keyset Pagination*
### Problem 4: user confusion
Several users have shown that they do not fully understand the difference between *received date* and *publication date*, and particularly not the pitfalls of *publication date*.
Mitigation: the menus to mark-as-read *before 1 day* and *before 1 week* are disabled when sorting by anything else than *received date*. Likewise, the separation headers *Today* and *Yesterday* and *Before yesterday* are only shown when sorting by *received date*.
Again here, to better understand why, it helps to think about sorting by *title* or by *link*, as sorting by *title* and by *publication date* share more or less the same characteristics.
* [ ] We should write a Q&A and/or documentation about the problems associated to *sorting by publication date*: risks of not noticing new publication, of inadvertently marking them as read, of having some articles with a date in the future hanging at the top of the views (vice versa when sorting in ascending order), performance, etc.
### Problem 5: APIs
Sorting by anything else than *received date* breaks the guarantees needed for a successful synchronisation via API.
Mitigation: sorting by *received date* is ensured for all API calls.
For some browsers (I tested desktop Edge and mobile Safari), setting document.scrollingElement.scrollTop to zero does not seem to be enough to reset the scroll position at start. Setting history.scrollRestoration = 'manual' seems to fix it for these browsers.
Firefox seems to work without this fix but works also with it.
* configs
* add the icon in the entry header line
* rename comment
* Update main.js
* CSS
* comment typo fix
* fix gloabl view my labels menu
* improved: my labels dropdown with triangle now. yay!
* fix dropdown triangle in mobile view
* Nord theme
* mobile view: width improved. Each theme can decide about border-radius
* Ansum/Mapco theme
* fix pink dark theme: label icon in pink now too
* my labels: line breaks improved
* article tags: headline added
* New feed mode: HTML + XPath + JSON dot notation (JSON in HTML)
Same as `JSON+DotNotation` but first extracting the JSON string from an HTML document thanks to an XPath expression.
Example: `//script[@type='application/json']`
fix https://github.com/FreshRSS/FreshRSS/discussions/6876
* JavaScript UI to show/hide new field
* Casing xPathToJson
* Slight renaming
* i18n: Add an RSS feed -> Add a feed
* manage mouse title for category
* no white space between manage icon and favicon and title
* add feed link: use icon instead of plus character
* better CSS class for empty category and its alert text box
* show muted icon and warning icon
* the CSS magic incl. the themes improvements
* fix
* mute icon is more important than warning
* feed mouse hover title
* fix feed navigation sidebar: show error
* fix btn with icon and text
* fix aside feed: muted icon over warning icon
* delete theme BlueLagoon
* delete theme Screwdriver
* phpstan level 7 for feedController.php (#5373)
* phpstan level 7 for feedController.php
* phpstan level 7 for feedController.php
* phpstan level 7 for feedController.php
* phpstan level 7 for feedController.php
* A few fixes
---------
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* phpstan level 7 for updateController.php (#5376)
* phpstan level 7 for updateController.php
* phpstan level 7 for updateController.php
* Minor array syntax
---------
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* docs: language table added (#5375)
* docs: language table added
* Update 05_Configuration.md
* Update 05_Configuration.md
* french docs
* Unicode quote and a few fixes
(Same search&replace aslo applied to a few other files)
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Share in anonymous mode (#5261)
#fix https://github.com/FreshRSS/FreshRSS/issues/5248
Co-authored-by: maTh <math-home@web.de>
* Minor development config fixes (#5379)
* Add compatibility with MacOS for `paste` command
* Addition to .editorconfig
* Fix markAsReadUponGone (#5382)
Fix regression from https://github.com/FreshRSS/FreshRSS/pull/5315
which indroduced a bug for cached feeds.
We now update the `lastSeen` property of entries to account for the fact that they are unchanged but still existing.
* phpstan level 7 for indexController.php (#5384)
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
* Improved: "Mark an article as read…" text area. Added a link to the documentation (#5349)
* i18n
* Update sub.php
* Update app/i18n/fr/sub.php
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* fix target="_blank"
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Update Docker image Alpine 3.18 (#5383)
https://alpinelinux.org/posts/Alpine-3.18.0-released.html
Minor updates with Apache 2.4.57 and PHP 8.1.19
* Docs: delete 04_Changing_source_code.md (#5391)
* delete 04_Changing_source_code.md
* make pot
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Typed view model classes (#5380)
* Typed view model classes
* Add ability to provide a typed view model class to a controller
* Use `::class` instead of string for referring to classes
* Examplified with `stats` and `javascript` controllers / views (more to do)
* Also useful for extensions (my usecase today), which did not have the ability to define own view model attributes before.
* Typo
* A few additional PHPStan rules (#5388)
A subset of
https://github.com/phpstan/phpstan-strict-rules
* Improved: Install process: give more infos (#5350)
* comments added for each step
* infos about FreshRSS added in first step
* Remove reference to Kriss and Leed from install page
I do not find that informative, and quite confusing. Moved to readme instead.
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* PHPMailer 6.8.0 (#5389)
* PHPMailer 6.8.0
https://github.com/PHPMailer/PHPMailer/releases/tag/v6.8.0https://github.com/PHPMailer/PHPMailer/releases
* Exclude unused DSNConfigurator
* fix: docs: array syntax (#5392)
* Link configuration to proper parameter (#5394)
Before, the system configuration was linked to the user parameter while the
user configuration was linked to the system parameter. This was an issue when
trying to retrieve some kind of configuration value in an extension.
Now, the configurations are properly linked to their parameters.
* PHPStan Level 7 for Share userController logs_pagination (#5393)
* fix: "for" attribute in config display (#5398)
* move darkMode_auto from body to html root (#5397)
* CSS: refactor of a.btn (#5401)
* Fix logs pagination (#5403)
* Fix logs pagination
Regression from https://github.com/FreshRSS/FreshRSS/pull/5269
* Add better default
* PHPStan Level 7 for Minz_Request, FreshRSS_Feed, Minz_Error (#5400)
* PHPStan Level 7 for Minz_Request
* PHPStan Level 7 for FreshRSS_Feed
* PHPStan Level 7 for Minz_Error
* Fix again updateLastSeenUnchanged (#5404)
* Fix again updateLastSeenUnchanged
https://github.com/FreshRSS/FreshRSS/pull/5382 was not good enough to fix markAsReadUponGone and introduced a regression in `entry.lastSeen`.
New approach.
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5315
* Minor change of mind
* Fix handling of lastSeen
entry.lastSeen was not always correctly initialised, and sometimes overriden
* Remove debug line
Forgotten from https://github.com/FreshRSS/FreshRSS/pull/5404
* Avoid falsy guid (#5412)
Whitespace strings, empty strings, 0 are all problematic when working with GUIDs. so avoid them.
* PHPStan Level 7 complete (#5406)
* PHPStan Level 7 complete
* Start PHPStan Level 8
* Forgot exclude .phtml
* Fix favicon fetching while using proxies (#5421)
* Fix favicon fetching while using proxies
This ensures that if curl_options are defined in config.php, those
settings are respected while fetching favicons.
Fixes FreshRSS#4951
* Change options priority
* Credits keep alphabticorder
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Fixed: i18n extensions: 'en' as fallback (#5426)
* Update Translate.php
* Small improvements
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Improve Dev Container (#5423)
* Improve Dev Container
PHPStan was failing in Dev Container
* Update Docker to Alpine Linux 3.18
* New DATA_PATH environment variable
* README
* Update of Spanish translation (#5408)
* Update admin.php
Update Spanish
* Update conf.php
Spanish update
* Fix
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Linkding share now passes title #5432 (#5433)
* phpstan-8 typehinting (#5429)
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
* Forgotten debug line
https://github.com/FreshRSS/FreshRSS/pull/5404
* phpstan-9 for Share.php (#5431)
* phpstan 9 for Search.php
phpstan 9 for Share.php
* phpstan-9 for Search.php
* Better consistency for search results
---------
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Pull request of spanish translation (#5436)
* Update sub.php
Update spanish translation
* Update conf.php
Update Spanish translation
* Update gen.php
Update spanish translation
* Update index.php
Update spanish translation
* Update admin.php
update spanish translation
* Fix ignore
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* improved background colors (#5437)
* phpstan-8 for category class (#5434)
* phpstan-8 for category class
* Another approach to nullable
https://github.com/FreshRSS/FreshRSS/pull/5434#discussion_r1210776699
---------
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Docker example of PostgreSQL tuning (#5446)
Provide example of how to easily tune selected PostgreSQL settings
https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server
* Update SECURITY.md (#5448)
Link to GitHub security advisory process + PGP key
* fix: new article banner in Ansum/mapco theme (#5453)
* fix
* rtl
* Update dark theme css to lower brightness to all icons (#5439)
* Update dark.css to lower brightness to all icons
* Update dark.rtl.css to lower brightness to all icons
* re-add p.help .icon
* re-add p.help .icon
* Remove core extensions Google Groups and Tumblr (#5457)
* Remove core extensions Google Groups and Tumblr
* Google Groups seems to have remove support for RSS/ATOM https://github.com/FreshRSS/FreshRSS/pull/2838 (see e.g. https://www.theregister.com/2021/08/16/google_groups_rss/ )
* Tumblr seems to have fixed their RSS/ATOM post-GDPR https://github.com/FreshRSS/FreshRSS/pull/1924
So for both of thems, the extensions have become irrelevant.
* Cleaning
* Clarify that maximum number to keep is per feed (#5458)
* Clarify that maximum number to keep is per feed
Signed-off-by: Christian König <ckoenig@posteo.de>
* Append //DIRTY
Signed-off-by: Christian König <ckoenig@posteo.de>
* make fix-all
* Revert wrong whitespace
* Amend Credits.md
Signed-off-by: Christian König <ckoenig@posteo.de>
---------
Signed-off-by: Christian König <ckoenig@posteo.de>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Add OpenID Connect (#5351)
* Add OIDC
* Update documentation.
* Update apache conf adding IfModule
* Use IfDefine for OIDC in apache conf
* Fix non-oidc support
* Fix typing
* Use IfDefine to enable OIDC
* Add OIDC support to all dockerfiles
* Re add apache Require option
* Fixes and documentation
* A few more fixes
* A bit more doc
* Change type of environment variable
* Update readme
* Correct apache config for OIDC support.
* Fix README formatting
* Update oidc control path
* Fix oidc endpoint being cached
* A bit more review
* Simplify ExpiresActive
* Add session refresh and improve caching
* Allow more different setups
* A bit more documentation
* A bit more readme
---------
Co-authored-by: Aaron Schif <aschif@netdevgroup.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Co-authored-by: maTh <math-home@web.de>
* Fix OpenID Connect crash on ARM (#5463)
Only enable the Apache auth_openidc module when actually used
Fix https://github.com/FreshRSS/FreshRSS/issues/5460
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5351
* Readme minor typo
* Fix: conf.php (German i18n) (#5468)
* Improved: update page (#5420)
* prependTitle()
* do not need the "damn" in the alert
* update page layout improved
* release channel
* i18n labels
* add log messages while updating
* Delete updatee.php
* Update updateController.php
* Update updateController.php
* Update updateController.php
* Update updateController.php
* add getCurrentGitBranch()
* Update updateController.php
* state2 buttons
* i18n
* loading
* Update feedback.php
* Update feedback.php
* Update feedback.php
* Update extra.js
* Apply suggestions from code review
Co-authored-by: Luc SANCHEZ <4697568+ColonelMoutarde@users.noreply.github.com>
* Update updateController.php
* Update terminology
* update button is now armed
---------
Co-authored-by: Luc SANCHEZ <4697568+ColonelMoutarde@users.noreply.github.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* Allow deep link to extension configuration (#5449)
* Allow deep link to extension configuration
Full screen
* Support slider
* Add aside_configure
Fix https://github.com/FreshRSS/FreshRSS/pull/5449#issuecomment-1588089769
* category title improved
* Feed title: better HTML structure + have a correct semantic <a>
* feed title: CSS
* feed title special cases
* improved feed mouseover titles
* cog icon half transparent. Shining while hovering
* i18n labels
* improve hover of more menu
* Update gen.php
* fix
* i18n: fr
---------
Signed-off-by: Christian König <ckoenig@posteo.de>
Co-authored-by: Luc SANCHEZ <4697568+ColonelMoutarde@users.noreply.github.com>
Co-authored-by: Luc <sanchezluc+freshrss@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Co-authored-by: Alexis Degrugillier <aledeg@users.noreply.github.com>
Co-authored-by: vrachnis <vrachnis@users.noreply.github.com>
Co-authored-by: LleanaRuv <133794633+LleanaRuv@users.noreply.github.com>
Co-authored-by: acbgbca <60839662+acbgbca@users.noreply.github.com>
Co-authored-by: Alwaysin <adrien@demma.fr>
Co-authored-by: yubiuser <ckoenig@posteo.de>
Co-authored-by: Aaron Schif <aaronschif@gmail.com>
Co-authored-by: Aaron Schif <aschif@netdevgroup.com>
Co-authored-by: math-gh <>
* New feature: shareable user query
Share the output of a user query by RSS / HTML / OPML with other people through unique URLs.
Replaces the global admin token, which was the only option (but unsafe) to share RSS outputs with other people.
Also add a new HTML output for people without an RSS reader.
fix https://github.com/FreshRSS/FreshRSS/issues/3066#issuecomment-648977890
fix https://github.com/FreshRSS/FreshRSS/issues/3178#issuecomment-769435504
* Remove unused method
* Fix token saving
* Implement HTML view
* Update i18n for master token
* Revert i18n get_favorite
* Fix missing i18n for user queries from before this PR
* Remove irrelevant tests
* Add link to RSS version
* Fix getGet
* Fix getState
* Fix getSearch
* Alternative getSearch
* Default getOrder
* Explicit default state
* Fix test
* Add OPML sharing
* Remove many redundant SQL queries from original implementation of user queries
* Fix article tags
* Use default user settings
* Prepare public search
* Fixes
* Allow user search on article tags
* Implement user search
* Revert filter bug
* Revert wrong SQL left outer join change
* Implement checkboxes
* Safe check of OPML
* Fix label
* Remove RSS button to favour new sharing method
That sharing button was using a global admin token
* First version of HTTP 304
* Disallow some recusrivity
fix https://github.com/FreshRSS/FreshRSS/issues/6086
* Draft of nav
* Minor httpConditional
* Add support for offset for pagination
* Fix offset pagination
* Fix explicit order ASC
* Add documentation
* Help links i18n
* Note about deprecated master token
* Typo
* Doc about format
* Added ability to mark entries as read on focus.
Feature proposed in issue #5723.
* make-fix-all + i18n fr
* Use batch to save resources and increase performance
* Use "keep_unread"
* typo
---------
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
* New feature important feeds
* Fix PHPStan
* Initial style for important feeds + keep unread
* Change UI order
* Count important unread
* Never mark as read important feeds during scroll
* Fix i18n conf.iew.normal regression
* Fix reader view
* More fix reader view
* Create important.svg
* Fix title
* Fix counter
* Account for important during mark-all-as-read
* Fix underline colour
* 📌
* Changelog
---------
Co-authored-by: math-gh <>
Co-authored-by: maTh <1645099+math-GH@users.noreply.github.com>
* init_posts(): load more posts on window resize
Fixes:
1. Open FreshRSS in a shorter window
2. Resize to be much longer
3. Half the window remains empty
This is most obviously a problem on vertical monitors.
* Address comments
* blah blah
* typo
