231 Commits

Author SHA1 Message Date
J. King 114dcc568f Update dependencies 1 month ago
Dustin Wilson 1331b14a04 Reverting for now 1 month ago
Dustin Wilson 035feae0ce Removed postcss in favor of sass for building manual theme 1 month ago
J. King 8e063bea2f Appease GitHub again 1 month ago
J. King 4a9e66d872 Fix inconsistent grammar 2 months ago
J. King fa4ab3218a Version bump 2 months ago
J. King c4260323bc Answer 201 to PUTs like Miniflux 2 months ago
J. King abc291460c Update Web server configuration in manual 2 months ago
J. King bff3e21cd2 Date release 2 months ago
J. King 764b604edd Note Fiery Feeds' support for HTTP auth with Fever 2 months ago
J. King 4b0571299a Add results of client testing 2 months ago
J. King 2e4c57b75b Work around Microflux for Miniflux 2 months ago
J. King dcb81ea043 Only provide icon ID when there is data 2 months ago
J. King 77a9bb801d Defer testing of Maxiflux 2 months ago
J. King f90b78a976 Fix compatibility issues 2 months ago
J. King e6b4edd160 Supress deprecation messages during runtime 2 months ago
J. King 8aca42c882 Minor fixes for correctness 2 months ago
J. King 458126416c Fix PostgreSQL coverage annotations 2 months ago
J. King 6b7257a6c4 Work around more MySQL stupidity 2 months ago
J. King 5cfa01f4d5 Work around MySQL stupidity 2 months ago
J. King 64ca5f1be0 Fix strict comparison failures 2 months ago
J. King ed285ee28b Shut Robo up 2 months ago
J. King 4642b9fd1c PRovide upgrade path for assertRegExp 2 months ago
J. King 3a1fcaac39 Remove last uses of Phake 2 months ago
J. King 75148bfbc6 Convert NCNv1 tests to PHony 2 months ago
J. King 95812b8ba3 Convert last TT-RSS test 2 months ago
J. King a322d034f3 More TT-RSS test conversions to Phony 2 months ago
J. King 2d951fb071 More TT-RSS test conversions 3 months ago
J. King c7350c6d57 Convert Miniflux tests to using Phony 3 months ago
J. King 9dfe3919cf Progress on TT-RSS tests 3 months ago
J. King e90aa585b2 PArtial rewrite of TT-RSS tests 3 months ago
J. King 2348786a92 Start on replacing Phake with Phony 3 months ago
J. King 9b369d902f Update tooling for PHP 8 3 months ago
J. King dab4cb21e6 Geekttrss seems to work 3 months ago
J. King d836d6a243 Add more clients to the untested list 3 months ago
J. King 50b2ca4500 Document tokens and metadata in the manual 3 months ago
J. King 9c0a3b7a57 Fix typo 3 months ago
J. King 3ba82b7c6d Fix CLI bootstrap problem 3 months ago
J. King fa6d641634 Implement CLI for tokens 3 months ago
J. King 3795b1ccd8 Simplify CLI command processing 3 months ago
J. King e8ed716ae6 Fix errors in CLI documentation 3 months ago
J. King 97d1de46f8 Fill in upgrade notes 3 months ago
J. King 68422390da Implement CLI for user metadata 3 months ago
J. King b7c7915a65 Enforce admin rquirements in NCNv1 3 months ago
J. King a760bf2ded Implement "t" and "f" booleans in TT-RSS 3 months ago
J. King 9ad4a37ddf Tests and fixes for Miniflux with PDO 3 months ago
J. King 687995c497 More potential Miniflux Web clints 3 months ago
J. King 29761d767a Update documentation 3 months ago
J. King dad74c2616 Implement Fever icons 3 months ago
J. King 90034ac1f8 Style fixes 3 months ago
J. King 211cea648e Implement TT-RSS API level 15 3 months ago
J. King f2e5d567ec Update sample Web server configuration 3 months ago
J. King eae0ba4b68 Tests fortoken operations 3 months ago
J. King 9cc779a717 Import/export tests 3 months ago
J. King 37fd2ad4e9 Tests for new exception features 3 months ago
J. King 6c2de89f3e Revert copy-paste corruption 3 months ago
J. King 54a6fcc0d6 Consolidate object factoriesinto one place 3 months ago
J. King a0d563e468 Update dependencies 3 months ago
J. King b4ae988b79 Prototype OPML handling 3 months ago
J. King 681654f249 Documentation update 3 months ago
J. King dd29ef6c1b Add feed refreshing stubs 3 months ago
J. King ab1cf7447b Implement article marking 3 months ago
J. King 334a585cb8 Implement single-entry querying 3 months ago
J. King a7d05a7717 Feed- and category-specific entry list routes 3 months ago
J. King 00ad1cc5b9 Last tests for article querying 3 months ago
J. King d4a6909cf6 Positional article queries tests 3 months ago
J. King e42e25d333 More article query tests 3 months ago
J. King f7b3a473a9 Clarify ordering syntax rationale 3 months ago
J. King af51377fe9 First set of article query tests 3 months ago
J. King 23ca6bb77b Count articles without offset or limit 3 months ago
J. King 0e7abfa8f9 Largely complete article querying 3 months ago
J. King a43f8797c5 Add ability to sort by folder ID or name 3 months ago
J. King ed27e0aaaa Sort nulls consistently 3 months ago
J. King 9d7ada7f59 Partial implementation of article sorting 3 months ago
J. King 007183450a Context and column list for article queries 3 months ago
J. King 197cbba77d Document article column definitions 3 months ago
J. King ddbcb598e8 Match more closely Miniflux query string behaviour 3 months ago
J. King bb89083444 Perform strict validation of query parameters 3 months ago
J. King 1e924bed83 Partial query string normalization 3 months ago
J. King 3b2190ca10 Include folder names directly in subscription list 4 months ago
J. King ad094f5217 Don't return icons without types at all 4 months ago
J. King cd5f13f4b9 Tests for icon querying 4 months ago
J. King 76f1cc8e91 Adjust users of subscriptionIcon 4 months ago
J. King cc2672fb0a Improve icon fetching interface 4 months ago
J. King 1eea3b3a4c Fix feed update test 4 months ago
J. King 8e749bb73c Report 404 on icons for absence of data 4 months ago
J. King bdf9c0e9d2 Prototype feed icon querying 4 months ago
J. King 9197a8d08b Implement feed deletion 4 months ago
J. King 8eebb75b18 Implement feed editing 4 months ago
J. King 5a8a044a92 Implement single-feed querying 4 months ago
J. King a646ad77b7 Use a read transaction when computing filter rules 4 months ago
J. King cca4b205e4 Correct error output of getCategoryFeeds 4 months ago
J. King a34edcb0d1 Last tests for feed creation 4 months ago
J. King 7893b5f59d More feed adding tests 4 months ago
J. King 36cc4928b9 Test feed fetching errors for Miniflux 4 months ago
J. King 727864f401 Implement feed listing by category 4 months ago
J. King 4972c79e32 Allow simpler feed exception creation 4 months ago
J. King 6936f365e4 Add calls coming in next version of Miniflux 4 months ago
J. King fd25be5c27 Basic tests for feed creation 4 months ago
J. King e7b2f54183 Prototype feed creation 4 months ago
J. King 14d2d19ae1 Tests for Miniflux feed listing 4 months ago
J. King 2cf4bf0d4d Prototype Miniflux feed listing 4 months ago
J. King 86897af0b3 Add ability to enable scraper 4 months ago
J. King 7897585d98 Test scraping 4 months ago
J. King 76f70119fd More work on scraping 4 months ago
J. King 4cb23dd198 Partial implementation of proper content scraping 4 months ago
J. King e74b44cc39 Change favicon to icon_url and add icon_id 4 months ago
J. King 2536c9fe03 Last tests for article filters 4 months ago
J. King 9f2b8d4f83 Imprement setting of filter rules 4 months ago
J. King 618fd67f80 Set marks for filtered articles on feed refresh 4 months ago
J. King 7a6186f2d7 Update Miniflux documentation 4 months ago
J. King 097362881b Tests for filtering during feed parsing 4 months ago
J. King a4146ec129 Start on test for filtering during feed parsing 4 months ago
J. King 9e29235d87 Don't fetch from example.com during tests 4 months ago
J. King 549c7bdc72 Style fixes 4 months ago
J. King 4f34b4ff29 Rule refactoring 4 months ago
J. King c1eff8479c Simplify configuration property caching 4 months ago
J. King 6dba8aa66b Fixes for rules 4 months ago
J. King 461e256052 Work around MySQL syntax weirdness 4 months ago
J. King 47ae65b9d3 Function to apply filter rules 4 months ago
J. King b12f87e231 Support Xdebug 3.x for coverage 4 months ago
J. King ffc5579a7a Partial implementation of filter rule handling 4 months ago
J. King 7e17332714 Implement marking all as read for Miniflux 4 months ago
J. King 31f0539dc0 Implement Miniflux user deletion 4 months ago
J. King bf95b134bd Fix up error codes for category changes 4 months ago
J. King 197922f92f Implement Miniflux user creation 4 months ago
J. King ee0c3c9449 Tests and fixes for user modification 4 months ago
J. King cc648e1c3a Update tooling 5 months ago
J. King 67f577d573 Bump emulated Miniflux version 5 months ago
J. King f58005640a Prototype user modification 5 months ago
J. King 2946d950f2 Forbid more user names 5 months ago
J. King 405f3af257 Invalidate sessions and Fever passwords when renaming users 5 months ago
J. King 5ec04d33c6 Add backend functionality to rename users 5 months ago
J. King 88cf3c6dae Test filter rule retrieval 5 months ago
J. King d66cf32c1f Style fixes 5 months ago
J. King a81760e39d Aggressivly clean up hidden articles 5 months ago
J. King ade0402210 Adjust TT-RSS to ignore hidden items 5 months ago
J. King f33359f3e3 Move some Miniflux features to abstract handler 5 months ago
J. King b7ce6f5c79 Adjust Fever to ignore hidden items 5 months ago
J. King b2fae336e8 Adjust Nextcloud News to ignore hidden items 5 months ago
J. King f0bfe1fdff Simplify editionLatest Database method 5 months ago
J. King 8527c83976 Exclude hiddens from subscription unread count 5 months ago
J. King 97010d8822 Tests for marking articles hidden 5 months ago
J. King 86c4a30744 Adjust articleStarred function to discount hidden 5 months ago
J. King ffc98daff3 Adjust article marking tests to account for new hidden mark 5 months ago
J. King 8ae3740d5f Implement querying articles by hidden mark 5 months ago
J. King d5cd5b6a17 Implement hidden marks 5 months ago
J. King c43d0dcae3 Groundwork for filtering rules 5 months ago
J. King 95a2018e75 Implement caategory marking as read 5 months ago
J. King 5124f76b70 Implementcategory deletion 5 months ago
J. King eb079166de Tests for category renaming 5 months ago
J. King 3ebb46f48e Some work on categories 5 months ago
J. King 2e6c5d2ad2 Query Miniflux categories 5 months ago
J. King 4b73698381 More user query tests 5 months ago
J. King ebdfad535c More Miniflux user tests 5 months ago
J. King 7c841b5fc2 Test for listing users 5 months ago
J. King 5c83655541 Add modification timestamp to user metadata 5 months ago
J. King d85988f09d Prototype Miniflux user querying 5 months ago
J. King 2eedf7d38c Finally fix MySQL 5 months ago
J. King e9d449a8ba Fix user manager and tests 5 months ago
J. King ce68566fcb Hopefully fix MySQL 5 months ago
J. King a431243421 Fixes for MySQL and PostgreSQL 5 months ago
J. King fcf1260dab Adjust database portion of user property manager 5 months ago
J. King 978929aabd WIP redesign of user properties 5 months ago
J. King 0f3e0411f0 Document some differences frrom Miniflux 5 months ago
J. King 94154d4354 Implement Miniflux feed discovery 5 months ago
J. King 669e17a1f6 Add ability to discover multiple feeds 5 months ago
J. King 2a0d6e6599 OPTIONS tests 5 months ago
J. King 7fa5523a7d Simplify handling of invalid paths and methods 5 months ago
J. King def07bb1ad Tests for Miniflux authentication 6 months ago
J. King 8c059773bb Update tooling 6 months ago
J. King 90117b5cd7 Fix Miniflux strip value 6 months ago
J. King 06dee77bac First tests for Miniflux 6 months ago
J. King f6cd2b87ce Port token data from Microsub branch 6 months ago
J. King d4bcdcdadd Fix TTRSS coverage 6 months ago
J. King d3ebb1bd56 Last set of tests for user management. Fixes #180 6 months ago
J. King e16df90bae Style fixes 6 months ago
J. King 180b4ecc9b More user tests 6 months ago
J. King 27d9c046d5 More work on user management 6 months ago
J. King 7f2117adaa Differentiate between duplicate/missing users and other failure modes 6 months ago
J. King 351f972512 Tests for internal user driver 6 months ago
J. King 4baf5fa2f9 Tests for new user functionality in Database 6 months ago
J. King dde9d7a28a Refinements to user manager 6 months ago
J. King eb2fe522bf Last bits of the new user metadata handling 6 months ago
J. King 5a17efc7b5 Clean up user driver API 6 months ago
J. King 771f79323c Strip out remnants of the authorizer 6 months ago
J. King 576d7e16a8 Fix handling of bytea-typed nulls 6 months ago
J. King 1b1789988a More client compatibility updates 6 months ago
J. King 532ce4a502 Prototype changes to user management 6 months ago
J. King ee050e505c Add more Android clients to manual 6 months ago
J. King 9fb185a8e2 Add TT-RSS Web client to manual 6 months ago
J. King b62c11a43e Lasts tests for icon cache; fixes #177 6 months ago
J. King 1d3725341a Fix detection of Xdebug for coverage 6 months ago
J. King 311910795a More tests for icon cache 6 months ago
J. King 3d3c20de5c Don't anticipate API features 6 months ago
J. King 4d532cba3f Initial Miniflux documentation 6 months ago
J. King e861cca53d Integrate schema change necessary for microsub 6 months ago
J. King b24c469dca Update changelog 6 months ago
J. King 8f739cec85 Excluse empty-string URLs from icons table 6 months ago
J. King 424b14d2b4 Clean up use of subscriptionFavicon 6 months ago
J. King dd1a80f279 Consolidate subscription icon querying 6 months ago
J. King 4fc208d940 More consistent icon API 6 months ago
J. King c3a57ca68b Tests for icon cache population 6 months ago
J. King bd650765e1 Generalize icon fetching tests 6 months ago
J. King 50fd127ac4 Test for icon fetching 6 months ago
J. King 7c40c81fb3 Add icons to the database upon feed update 6 months ago
J. King c25782f98c Partial icon handling skeleton 6 months ago
J. King af675479b8 Remove excess whitespace 6 months ago
J. King 2438f35f3d Add icon cache to database 6 months ago
J. King 5e60da00a9 Merge branch 'master' into miniflux 6 months ago
J. King b5f959aabf Fix blob tests 6 months ago
J. King 41bcffd6fb Correctly query PostgreSQL byte arrays 6 months ago
J. King c21ae3eca9 Correctly send binary data to PostgreSQL 6 months ago
J. King c92bb12a11 Prototype Miniflux dispatcher 6 months ago
J. King 905f8938e2 Typo 6 months ago
J. King 8ad7fc81a8 Initially mapping out of Miniflux API 6 months ago
J. King 16d2e01668 New schema for PostgreSQL and MySQL 7 months ago
J. King 4db1b95cf4 Add numeric IDs and other Miniflux data to SQLite schema 7 months ago
J. King 3ac010d5b6 Fix tests in absence of database extensions 7 months ago
J. King b58a326461 Prepare for schema changes 7 months ago
J. King e9682bc601 Correct typos 7 months ago
J. King 5a09dcb3ed Update changelog 7 months ago
J. King e3ebd89aa8 Add NewsFlash to supported clients 7 months ago
J. King 0117e7f9bf Relax Fever's HTTP correctness for client compat 7 months ago
J. King 7ef02e1d65 Revert wishful thinking 7 months ago
J. King 3d909da1e5 Update iOS/macOS client URLs 7 months ago
J. King 6520ed38fb Update dependencies 7 months ago
J. King 9b11001402 Fix sample Nginx configuration 7 months ago
J. King 2e0ed5e923 Add reference to MariaDB missing features 8 months ago
J. King afbf3be031 Use 'union all' instead of 'union' in queries 8 months ago
J. King 6ee7ca4aa4 Update PicoFeed to latest release version 8 months ago
  1. 1
      .gitignore
  2. 41
      CHANGELOG
  3. 7
      RoboFile.php
  4. 27
      UPGRADING
  5. 5
      arsse.php
  6. 4
      composer.json
  7. 316
      composer.lock
  8. 8
      dist/apache.conf
  9. 18
      dist/nginx.conf
  10. 1
      docs/en/010_About.md
  11. 26
      docs/en/020_Getting_Started/030_Web_Server_Configuration.md
  12. 2
      docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md
  13. 37
      docs/en/025_Using_The_Arsse/010_Managing_Users.md
  14. 60
      docs/en/030_Supported_Protocols/005_Miniflux.md
  15. 1
      docs/en/030_Supported_Protocols/010_Nextcloud_News.md
  16. 3
      docs/en/030_Supported_Protocols/030_Fever.md
  17. 1
      docs/en/030_Supported_Protocols/index.md
  18. 230
      docs/en/040_Compatible_Clients.md
  19. 2
      docs/theme/arsse/arsse.css
  20. 4
      docs/theme/src/arsse.scss
  21. 25
      lib/AbstractException.php
  22. 5
      lib/Arsse.php
  23. 263
      lib/CLI.php
  24. 26
      lib/Conf.php
  25. 5
      lib/Context/Context.php
  26. 1091
      lib/Database.php
  27. 3
      lib/Db/Driver.php
  28. 6
      lib/Db/MySQL/Driver.php
  29. 4
      lib/Db/PDOError.php
  30. 4
      lib/Db/PostgreSQL/Driver.php
  31. 26
      lib/Db/PostgreSQL/PDOResult.php
  32. 14
      lib/Db/PostgreSQL/PDOStatement.php
  33. 16
      lib/Db/PostgreSQL/Result.php
  34. 3
      lib/Db/PostgreSQL/Statement.php
  35. 2
      lib/Db/SQLite3/Driver.php
  36. 7
      lib/Factory.php
  37. 84
      lib/Feed.php
  38. 45
      lib/Feed/Exception.php
  39. 4
      lib/ImportExport/AbstractImportExport.php
  40. 4
      lib/ImportExport/OPML.php
  41. 2
      lib/Misc/Date.php
  42. 11
      lib/Misc/ValueInfo.php
  43. 23
      lib/REST.php
  44. 22
      lib/REST/AbstractHandler.php
  45. 62
      lib/REST/Fever/API.php
  46. 19
      lib/REST/Miniflux/ErrorResponse.php
  47. 37
      lib/REST/Miniflux/Status.php
  48. 31
      lib/REST/Miniflux/Token.php
  49. 1206
      lib/REST/Miniflux/V1.php
  50. 73
      lib/REST/NextcloudNews/V1_2.php
  51. 188
      lib/REST/TinyTinyRSS/API.php
  52. 11
      lib/REST/TinyTinyRSS/Icon.php
  53. 4
      lib/Rule/Exception.php
  54. 85
      lib/Rule/Rule.php
  55. 2
      lib/Service.php
  56. 167
      lib/User.php
  57. 89
      lib/User/Driver.php
  58. 2
      lib/User/ExceptionConflict.php
  59. 2
      lib/User/ExceptionInput.php
  60. 55
      lib/User/Internal/Driver.php
  61. 55
      locale/en.php
  62. 56
      sql/MySQL/6.sql
  63. 55
      sql/PostgreSQL/6.sql
  64. 116
      sql/SQLite3/6.sql
  65. 9
      tests/bootstrap.php
  66. 260
      tests/cases/CLI/TestCLI.php
  67. 4
      tests/cases/Conf/TestConf.php
  68. 5
      tests/cases/Database/AbstractTest.php
  69. 392
      tests/cases/Database/SeriesArticle.php
  70. 68
      tests/cases/Database/SeriesCleanup.php
  71. 137
      tests/cases/Database/SeriesFeed.php
  72. 47
      tests/cases/Database/SeriesFolder.php
  73. 97
      tests/cases/Database/SeriesIcon.php
  74. 85
      tests/cases/Database/SeriesLabel.php
  75. 20
      tests/cases/Database/SeriesSession.php
  76. 348
      tests/cases/Database/SeriesSubscription.php
  77. 64
      tests/cases/Database/SeriesTag.php
  78. 39
      tests/cases/Database/SeriesToken.php
  79. 159
      tests/cases/Database/SeriesUser.php
  80. 16
      tests/cases/Database/TestDatabase.php
  81. 31
      tests/cases/Db/BaseDriver.php
  82. 33
      tests/cases/Db/BaseResult.php
  83. 15
      tests/cases/Db/BaseStatement.php
  84. 60
      tests/cases/Db/BaseUpdate.php
  85. 2
      tests/cases/Db/PostgreSQL/TestDriver.php
  86. 2
      tests/cases/Db/PostgreSQL/TestResult.php
  87. 7
      tests/cases/Db/PostgreSQL/TestStatement.php
  88. 4
      tests/cases/Db/PostgreSQLPDO/TestResult.php
  89. 5
      tests/cases/Db/PostgreSQLPDO/TestStatement.php
  90. 6
      tests/cases/Db/SQLite3/TestCreation.php
  91. 6
      tests/cases/Db/SQLite3/TestDriver.php
  92. 6
      tests/cases/Db/SQLite3/TestResult.php
  93. 6
      tests/cases/Db/SQLite3/TestStatement.php
  94. 6
      tests/cases/Db/SQLite3/TestUpdate.php
  95. 6
      tests/cases/Db/SQLite3PDO/TestCreation.php
  96. 41
      tests/cases/Db/TestTransaction.php
  97. 23
      tests/cases/Exception/TestException.php
  98. 12
      tests/cases/Feed/TestException.php
  99. 71
      tests/cases/Feed/TestFeed.php
  100. 2
      tests/cases/Feed/TestFetching.php

1
.gitignore

@ -26,7 +26,6 @@ $RECYCLE.BIN/
.DS_Store
.AppleDouble
.LSOverride
Icon
._*
.Spotlight-V100
.Trashes

41
CHANGELOG

@ -1,3 +1,44 @@
Version 0.9.1 (2021-03-18)
==========================
Bug fixes:
- Respond to PUT requests with 201 rather than 200 in Miniflux
Changes:
- Correct Web server configuration in manual
Version 0.9.0 (2021-03-06)
==========================
New features:
- Support for the Miniflux protocol (see manual for details)
- Support for API level 15 of Tiny Tiny RSS
- Support for feed icons in Fever
- Command-line functionality for managing user metadata
- Command-line functionality for managing Miniflux login tokens
Bug fixes:
- Further relax Fever HTTP correctness, to fix more clients
- Use icons specified in Atom feeds when available
- Do not return null as subscription unread count
- Explicitly forbid U+003A COLON and control characters in usernames, for
compatibility with RFC 7617
- Never return 401 in response to an OPTIONS request
- Accept "t" and "f" as booleans in Tiny Tiny RSS
Changes:
- Administrator account requirements for Nextcloud News functionality are
now enforced
- E_DEPRECATED is now suppressed for compatibility with PHP 8 until affected
dependencies can be replaced
Version 0.8.5 (2020-10-27)
==========================
Bug fixes:
- Relax Fever HTTP correctness, to fix some clients
- Add the QUERY_STRING FastCGI parameter to the sample Nginx configuration
Version 0.8.4 (2020-09-09)
==========================

7
RoboFile.php

@ -6,6 +6,7 @@ const BASE = __DIR__.\DIRECTORY_SEPARATOR;
const BASE_TEST = BASE."tests".\DIRECTORY_SEPARATOR;
define("IS_WIN", defined("PHP_WINDOWS_VERSION_MAJOR"));
define("IS_MAC", php_uname("s") === "Darwin");
error_reporting(0);
function norm(string $path): string {
$out = realpath($path);
@ -96,11 +97,11 @@ class RoboFile extends \Robo\Tasks {
if (extension_loaded("pcov")) {
return "$php -d pcov.enabled=1 -d pcov.directory=$code";
} elseif (extension_loaded("xdebug")) {
return $php;
return "$php -d xdebug.mode=coverage";
} elseif (file_exists($dir."pcov.$ext")) {
return "$php -d extension=pcov.$ext -d pcov.enabled=1 -d pcov.directory=$code";
} elseif (file_exists($dir."pcov.$ext")) {
return "$php -d zend_extension=xdebug.$ext";
} elseif (file_exists($dir."xdebug.$ext")) {
return "$php -d zend_extension=xdebug.$ext -d xdebug.mode=coverage";
} else {
if (IS_WIN) {
$dbg = dirname(\PHP_BINARY)."\\phpdbg.exe";

27
UPGRADING

@ -11,6 +11,33 @@ usually prudent:
`composer install -o --no-dev`
Upgrading from 0.8.5 to 0.9.0
=============================
- The database schema has changed from rev6 to rev7; if upgrading the database
manually, apply the 6.sql file
- Web server configuration has changed to accommodate Miniflux; the following
URL paths are affected:
- /v1/
- /version
- /healthcheck
- Icons for existing feeds in Miniflux and Fever will only appear once the
feeds in question have been fetched and parsed after upgrade. This may take
some time to occur depending on how often the feed is updated
- An administrator account is now required to refresh feeds via the
Nextcloud News protocol
Upgrading from 0.8.4 to 0.8.5
=============================
- The sample configuration for Nginx has changed, to correct the omission of
the QUERY_STRING FastCGI parameter in those passed to PHP. The omission
affects the Fever protocol in particular (the parameter is required for
Fever to function at all), though it could potentially affect some
Nextcloud News clients as well
Upgrading from 0.8.2 to 0.8.3
=============================

5
arsse.php

@ -13,9 +13,12 @@ require_once BASE."vendor".DIRECTORY_SEPARATOR."autoload.php";
ignore_user_abort(true);
ini_set("memory_limit", "-1");
ini_set("max_execution_time", "0");
// FIXME: This is required by a dependency of Picofeed
error_reporting(\E_ALL & ~\E_DEPRECATED);
if (\PHP_SAPI === "cli") {
// initialize the CLI; this automatically handles --help and --version
// initialize the CLI; this automatically handles --help and --version else
Arsse::$obj = new Factory;
$cli = new CLI;
// handle other CLI requests; some do not require configuration
$exitStatus = $cli->dispatch();

4
composer.json

@ -18,12 +18,12 @@
],
"require": {
"php": "^7.1",
"php": "^7.1 || ^8.0",
"ext-intl": "*",
"ext-json": "*",
"ext-hash": "*",
"ext-dom": "*",
"nicolus/picofeed": "dev-master#0ebdf92852a4725f4807c200dd49bf9fff3905b7",
"nicolus/picofeed": "^0.1.43",
"hosteurope/password-generator": "1.*",
"docopt/docopt": "1.*",
"jkingweb/druuid": "3.*",

316
composer.lock

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "1d03b34d159fbf69097aa783994f9cfa",
"content-hash": "2a87797422ae569bafcbb6476461ac38",
"packages": [
{
"name": "docopt/docopt",
@ -50,6 +50,10 @@
"cli",
"docs"
],
"support": {
"issues": "https://github.com/docopt/docopt.php/issues",
"source": "https://github.com/docopt/docopt.php/tree/1.0.4"
},
"time": "2019-12-03T02:48:46+00:00"
},
{
@ -117,27 +121,31 @@
"rest",
"web service"
],
"support": {
"issues": "https://github.com/guzzle/guzzle/issues",
"source": "https://github.com/guzzle/guzzle/tree/6.5"
},
"time": "2020-06-16T21:01:06+00:00"
},
{
"name": "guzzlehttp/promises",
"version": "v1.3.1",
"version": "1.4.1",
"source": {
"type": "git",
"url": "https://github.com/guzzle/promises.git",
"reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646"
"reference": "8e7d04f1f6450fef59366c399cfad4b9383aa30d"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/guzzle/promises/zipball/a59da6cf61d80060647ff4d3eb2c03a2bc694646",
"reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646",
"url": "https://api.github.com/repos/guzzle/promises/zipball/8e7d04f1f6450fef59366c399cfad4b9383aa30d",
"reference": "8e7d04f1f6450fef59366c399cfad4b9383aa30d",
"shasum": ""
},
"require": {
"php": ">=5.5.0"
"php": ">=5.5"
},
"require-dev": {
"phpunit/phpunit": "^4.0"
"symfony/phpunit-bridge": "^4.4 || ^5.1"
},
"type": "library",
"extra": {
@ -168,20 +176,24 @@
"keywords": [
"promise"
],
"time": "2016-12-20T10:07:11+00:00"
"support": {
"issues": "https://github.com/guzzle/promises/issues",
"source": "https://github.com/guzzle/promises/tree/1.4.1"
},
"time": "2021-03-07T09:25:29+00:00"
},
{
"name": "guzzlehttp/psr7",
"version": "1.6.1",
"version": "1.8.1",
"source": {
"type": "git",
"url": "https://github.com/guzzle/psr7.git",
"reference": "239400de7a173fe9901b9ac7c06497751f00727a"
"reference": "35ea11d335fd638b5882ff1725228b3d35496ab1"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/guzzle/psr7/zipball/239400de7a173fe9901b9ac7c06497751f00727a",
"reference": "239400de7a173fe9901b9ac7c06497751f00727a",
"url": "https://api.github.com/repos/guzzle/psr7/zipball/35ea11d335fd638b5882ff1725228b3d35496ab1",
"reference": "35ea11d335fd638b5882ff1725228b3d35496ab1",
"shasum": ""
},
"require": {
@ -194,15 +206,15 @@
},
"require-dev": {
"ext-zlib": "*",
"phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.8"
"phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.14 || ^7.5.20 || ^8.5.8 || ^9.3.10"
},
"suggest": {
"zendframework/zend-httphandlerrunner": "Emit PSR-7 responses"
"laminas/laminas-httphandlerrunner": "Emit PSR-7 responses"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.6-dev"
"dev-master": "1.7-dev"
}
},
"autoload": {
@ -239,7 +251,11 @@
"uri",
"url"
],
"time": "2019-07-01T23:21:34+00:00"
"support": {
"issues": "https://github.com/guzzle/psr7/issues",
"source": "https://github.com/guzzle/psr7/tree/1.8.1"
},
"time": "2021-03-21T16:25:00+00:00"
},
{
"name": "hosteurope/password-generator",
@ -279,6 +295,10 @@
}
],
"description": "Password generator for generating policy-compliant passwords.",
"support": {
"issues": "https://github.com/hosteurope/password-generator/issues",
"source": "https://github.com/hosteurope/password-generator/tree/master"
},
"time": "2016-12-08T09:32:12+00:00"
},
{
@ -324,6 +344,10 @@
"keywords": [
"uuid"
],
"support": {
"issues": "https://github.com/JKingweb/DrUUID/issues",
"source": "https://github.com/JKingweb/DrUUID/tree/3.0.0"
},
"time": "2017-02-09T14:17:01+00:00"
},
{
@ -399,6 +423,10 @@
"rfc7234",
"validation"
],
"support": {
"issues": "https://github.com/Kevinrob/guzzle-cache-middleware/issues",
"source": "https://github.com/Kevinrob/guzzle-cache-middleware/tree/master"
},
"time": "2017-08-17T12:23:43+00:00"
},
{
@ -484,6 +512,14 @@
"psr-17",
"psr-7"
],
"support": {
"chat": "https://laminas.dev/chat",
"docs": "https://docs.laminas.dev/laminas-diactoros/",
"forum": "https://discourse.laminas.dev",
"issues": "https://github.com/laminas/laminas-diactoros/issues",
"rss": "https://github.com/laminas/laminas-diactoros/releases.atom",
"source": "https://github.com/laminas/laminas-diactoros"
},
"funding": [
{
"url": "https://funding.communitybridge.org/projects/laminas-project",
@ -549,6 +585,14 @@
"psr-15",
"psr-7"
],
"support": {
"chat": "https://laminas.dev/chat",
"docs": "https://docs.laminas.dev/laminas-httphandlerrunner/",
"forum": "https://discourse.laminas.dev",
"issues": "https://github.com/laminas/laminas-httphandlerrunner/issues",
"rss": "https://github.com/laminas/laminas-httphandlerrunner/releases.atom",
"source": "https://github.com/laminas/laminas-httphandlerrunner"
},
"funding": [
{
"url": "https://funding.communitybridge.org/projects/laminas-project",
@ -605,20 +649,28 @@
"security",
"xml"
],
"support": {
"chat": "https://laminas.dev/chat",
"docs": "https://docs.laminas.dev/laminas-xml/",
"forum": "https://discourse.laminas.dev",
"issues": "https://github.com/laminas/laminas-xml/issues",
"rss": "https://github.com/laminas/laminas-xml/releases.atom",
"source": "https://github.com/laminas/laminas-xml"
},
"time": "2019-12-31T18:05:42+00:00"
},
{
"name": "laminas/laminas-zendframework-bridge",
"version": "1.1.0",
"version": "1.1.1",
"source": {
"type": "git",
"url": "https://github.com/laminas/laminas-zendframework-bridge.git",
"reference": "4939c81f63a8a4968c108c440275c94955753b19"
"reference": "6ede70583e101030bcace4dcddd648f760ddf642"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/laminas/laminas-zendframework-bridge/zipball/4939c81f63a8a4968c108c440275c94955753b19",
"reference": "4939c81f63a8a4968c108c440275c94955753b19",
"url": "https://api.github.com/repos/laminas/laminas-zendframework-bridge/zipball/6ede70583e101030bcace4dcddd648f760ddf642",
"reference": "6ede70583e101030bcace4dcddd648f760ddf642",
"shasum": ""
},
"require": {
@ -630,10 +682,6 @@
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev",
"dev-develop": "1.1.x-dev"
},
"laminas": {
"module": "Laminas\\ZendFrameworkBridge"
}
@ -657,26 +705,32 @@
"laminas",
"zf"
],
"support": {
"forum": "https://discourse.laminas.dev/",
"issues": "https://github.com/laminas/laminas-zendframework-bridge/issues",
"rss": "https://github.com/laminas/laminas-zendframework-bridge/releases.atom",
"source": "https://github.com/laminas/laminas-zendframework-bridge"
},
"funding": [
{
"url": "https://funding.communitybridge.org/projects/laminas-project",
"type": "community_bridge"
}
],
"time": "2020-08-18T16:34:51+00:00"
"time": "2020-09-14T14:23:00+00:00"
},
{
"name": "nicolus/picofeed",
"version": "dev-master",
"version": "0.1.43",
"source": {
"type": "git",
"url": "https://github.com/nicolus/picoFeed.git",
"reference": "0ebdf92852a4725f4807c200dd49bf9fff3905b7"
"reference": "e6bfe8d30009603702d1bff46a7abf8bfb25f8a8"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/nicolus/picoFeed/zipball/0ebdf92852a4725f4807c200dd49bf9fff3905b7",
"reference": "0ebdf92852a4725f4807c200dd49bf9fff3905b7",
"url": "https://api.github.com/repos/nicolus/picoFeed/zipball/e6bfe8d30009603702d1bff46a7abf8bfb25f8a8",
"reference": "e6bfe8d30009603702d1bff46a7abf8bfb25f8a8",
"shasum": ""
},
"require": {
@ -725,52 +779,10 @@
],
"description": "RSS/Atom parsing library",
"homepage": "https://github.com/nicolus/picoFeed",
"time": "2020-02-13T06:43:47+00:00"
},
{
"name": "paragonie/random_compat",
"version": "v9.99.99",
"source": {
"type": "git",
"url": "https://github.com/paragonie/random_compat.git",
"reference": "84b4dfb120c6f9b4ff7b3685f9b8f1aa365a0c95"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/paragonie/random_compat/zipball/84b4dfb120c6f9b4ff7b3685f9b8f1aa365a0c95",
"reference": "84b4dfb120c6f9b4ff7b3685f9b8f1aa365a0c95",
"shasum": ""
},
"require": {
"php": "^7"
},
"require-dev": {
"phpunit/phpunit": "4.*|5.*",
"vimeo/psalm": "^1"
},
"suggest": {
"ext-libsodium": "Provides a modern crypto API that can be used to generate random bytes."
"support": {
"source": "https://github.com/nicolus/picoFeed/tree/0.1.43"
},
"type": "library",
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Paragon Initiative Enterprises",
"email": "security@paragonie.com",
"homepage": "https://paragonie.com"
}
],
"description": "PHP 5.x polyfill for random_bytes() and random_int() from PHP 7",
"keywords": [
"csprng",
"polyfill",
"pseudorandom",
"random"
],
"time": "2018-07-02T15:55:56+00:00"
"time": "2020-09-15T07:28:23+00:00"
},
{
"name": "psr/http-factory",
@ -822,6 +834,9 @@
"request",
"response"
],
"support": {
"source": "https://github.com/php-fig/http-factory/tree/master"
},
"time": "2019-04-30T12:38:16+00:00"
},
{
@ -872,6 +887,9 @@
"request",
"response"
],
"support": {
"source": "https://github.com/php-fig/http-message/tree/master"
},
"time": "2016-08-06T14:39:51+00:00"
},
{
@ -925,6 +943,10 @@
"response",
"server"
],
"support": {
"issues": "https://github.com/php-fig/http-server-handler/issues",
"source": "https://github.com/php-fig/http-server-handler/tree/master"
},
"time": "2018-10-30T16:46:14+00:00"
},
{
@ -972,6 +994,9 @@
"psr",
"psr-3"
],
"support": {
"source": "https://github.com/php-fig/log/tree/1.1.3"
},
"time": "2020-03-23T09:12:05+00:00"
},
{
@ -1012,26 +1037,29 @@
}
],
"description": "A polyfill for getallheaders.",
"support": {
"issues": "https://github.com/ralouphie/getallheaders/issues",
"source": "https://github.com/ralouphie/getallheaders/tree/develop"
},
"time": "2019-03-08T08:55:37+00:00"
},
{
"name": "symfony/polyfill-intl-idn",
"version": "v1.18.1",
"version": "v1.22.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-intl-idn.git",
"reference": "5dcab1bc7146cf8c1beaa4502a3d9be344334251"
"reference": "2d63434d922daf7da8dd863e7907e67ee3031483"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/5dcab1bc7146cf8c1beaa4502a3d9be344334251",
"reference": "5dcab1bc7146cf8c1beaa4502a3d9be344334251",
"url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/2d63434d922daf7da8dd863e7907e67ee3031483",
"reference": "2d63434d922daf7da8dd863e7907e67ee3031483",
"shasum": ""
},
"require": {
"php": ">=5.3.3",
"php": ">=7.1",
"symfony/polyfill-intl-normalizer": "^1.10",
"symfony/polyfill-php70": "^1.10",
"symfony/polyfill-php72": "^1.10"
},
"suggest": {
@ -1040,7 +1068,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.18-dev"
"dev-main": "1.22-dev"
},
"thanks": {
"name": "symfony/polyfill",
@ -1083,6 +1111,9 @@
"portable",
"shim"
],
"support": {
"source": "https://github.com/symfony/polyfill-intl-idn/tree/v1.22.1"
},
"funding": [
{
"url": "https://symfony.com/sponsor",
@ -1097,24 +1128,24 @@
"type": "tidelift"
}
],
"time": "2020-08-04T06:02:08+00:00"
"time": "2021-01-22T09:19:47+00:00"
},
{
"name": "symfony/polyfill-intl-normalizer",
"version": "v1.18.1",
"version": "v1.22.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-intl-normalizer.git",
"reference": "37078a8dd4a2a1e9ab0231af7c6cb671b2ed5a7e"
"reference": "43a0283138253ed1d48d352ab6d0bdb3f809f248"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/37078a8dd4a2a1e9ab0231af7c6cb671b2ed5a7e",
"reference": "37078a8dd4a2a1e9ab0231af7c6cb671b2ed5a7e",
"url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/43a0283138253ed1d48d352ab6d0bdb3f809f248",
"reference": "43a0283138253ed1d48d352ab6d0bdb3f809f248",
"shasum": ""
},
"require": {
"php": ">=5.3.3"
"php": ">=7.1"
},
"suggest": {
"ext-intl": "For best performance"
@ -1122,7 +1153,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.18-dev"
"dev-main": "1.22-dev"
},
"thanks": {
"name": "symfony/polyfill",
@ -1164,83 +1195,9 @@
"portable",
"shim"
],
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2020-07-14T12:35:20+00:00"
},
{
"name": "symfony/polyfill-php70",
"version": "v1.18.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-php70.git",
"reference": "0dd93f2c578bdc9c72697eaa5f1dd25644e618d3"
"support": {
"source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.22.1"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-php70/zipball/0dd93f2c578bdc9c72697eaa5f1dd25644e618d3",
"reference": "0dd93f2c578bdc9c72697eaa5f1dd25644e618d3",
"shasum": ""
},
"require": {
"paragonie/random_compat": "~1.0|~2.0|~9.99",
"php": ">=5.3.3"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.18-dev"
},
"thanks": {
"name": "symfony/polyfill",
"url": "https://github.com/symfony/polyfill"
}
},
"autoload": {
"psr-4": {
"Symfony\\Polyfill\\Php70\\": ""
},
"files": [
"bootstrap.php"
],
"classmap": [
"Resources/stubs"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Nicolas Grekas",
"email": "p@tchwork.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Symfony polyfill backporting some PHP 7.0+ features to lower PHP versions",
"homepage": "https://symfony.com",
"keywords": [
"compatibility",
"polyfill",
"portable",
"shim"
],
"funding": [
{
"url": "https://symfony.com/sponsor",
@ -1255,29 +1212,29 @@
"type": "tidelift"
}
],
"time": "2020-07-14T12:35:20+00:00"
"time": "2021-01-22T09:19:47+00:00"
},
{
"name": "symfony/polyfill-php72",
"version": "v1.18.1",
"version": "v1.22.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-php72.git",
"reference": "639447d008615574653fb3bc60d1986d7172eaae"
"reference": "cc6e6f9b39fe8075b3dabfbaf5b5f645ae1340c9"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-php72/zipball/639447d008615574653fb3bc60d1986d7172eaae",
"reference": "639447d008615574653fb3bc60d1986d7172eaae",
"url": "https://api.github.com/repos/symfony/polyfill-php72/zipball/cc6e6f9b39fe8075b3dabfbaf5b5f645ae1340c9",
"reference": "cc6e6f9b39fe8075b3dabfbaf5b5f645ae1340c9",
"shasum": ""
},
"require": {
"php": ">=5.3.3"
"php": ">=7.1"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.18-dev"
"dev-main": "1.22-dev"
},
"thanks": {
"name": "symfony/polyfill",
@ -1314,6 +1271,9 @@
"portable",
"shim"
],
"support": {
"source": "https://github.com/symfony/polyfill-php72/tree/v1.22.1"
},
"funding": [
{
"url": "https://symfony.com/sponsor",
@ -1328,7 +1288,7 @@
"type": "tidelift"
}
],
"time": "2020-07-14T12:35:20+00:00"
"time": "2021-01-07T16:49:33+00:00"
}
],
"packages-dev": [
@ -1376,18 +1336,20 @@
"isolation",
"tool"
],
"support": {
"issues": "https://github.com/bamarni/composer-bin-plugin/issues",
"source": "https://github.com/bamarni/composer-bin-plugin/tree/master"
},
"time": "2020-05-03T08:27:20+00:00"
}
],
"aliases": [],
"minimum-stability": "stable",
"stability-flags": {
"nicolus/picofeed": 20
},
"stability-flags": [],
"prefer-stable": false,
"prefer-lowest": false,
"platform": {
"php": "^7.1",
"php": "^7.1 || ^8.0",
"ext-intl": "*",
"ext-json": "*",
"ext-hash": "*",
@ -1397,5 +1359,5 @@
"platform-overrides": {
"php": "7.1.33"
},
"plugin-api-version": "1.1.0"
"plugin-api-version": "2.0.0"
}

8
dist/apache.conf

@ -10,13 +10,13 @@
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php"
ProxyPreserveHost On
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons))">
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons, Miniflux API
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons)|/v1/)">
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse"
</LocationMatch>
# Nextcloud News API detection, Fever API
<LocationMatch "(/index\.php/apps/news/api/?$|/fever)">
# Nextcloud News API detection, Fever API, Miniflux miscellanies
<LocationMatch "(/index\.php/apps/news/api/?$|/fever|/version$|/healthcheck$)">
# these locations should not be behind HTTP authentication
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse"
</LocationMatch>

18
dist/nginx.conf

@ -19,6 +19,7 @@ server {
fastcgi_param CONTENT_TYPE $content_type;
fastcgi_param CONTENT_LENGTH $content_length;
fastcgi_param REQUEST_URI $uri;
fastcgi_param QUERY_STRING $query_string;
fastcgi_param HTTPS $https if_not_empty;
fastcgi_param REMOTE_USER $remote_user;
}
@ -54,4 +55,21 @@ server {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
# Miniflux protocol
location /v1/ {
try_files $uri @arsse;
}
# Miniflux version number
location /version {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
# Miniflux "health check"
location /healthcheck {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
}

1
docs/en/010_About.md

@ -1,5 +1,6 @@
The Advanced RSS Environment (affectionately called "The Arsse") is a news aggregator server which implements multiple synchronization protocols. Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on [existing protocols](Supported_Protocols) to maximize compatibility with [existing clients](Compatible_Clients). Supported protocols are:
- Miniflux
- Nextcloud News
- Tiny Tiny RSS
- Fever

26
docs/en/020_Getting_Started/030_Web_Server_Configuration.md

@ -30,6 +30,7 @@ server {
fastcgi_param CONTENT_TYPE $content_type;
fastcgi_param CONTENT_LENGTH $content_length;
fastcgi_param REQUEST_URI $uri;
fastcgi_param QUERY_STRING $query_string;
fastcgi_param HTTPS $https if_not_empty;
fastcgi_param REMOTE_USER $remote_user;
}
@ -65,6 +66,23 @@ server {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
# Miniflux protocol
location /v1/ {
try_files $uri @arsse;
}
# Miniflux version number
location /version {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
# Miniflux "health check"
location /healthcheck {
# this path should not be behind HTTP authentication
try_files $uri @arsse;
}
}
```
@ -92,13 +110,13 @@ Afterward the follow virtual host configuration should work, after modifying pat
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php"
ProxyPreserveHost On
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons))">
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons, Miniflux API
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons)|/v1/)">
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse"
</LocationMatch>
# Nextcloud News API detection, Fever API
<LocationMatch "(/index\.php/apps/news/api/?$|/fever)">
# Nextcloud News API detection, Fever API, Miniflux miscellanies
<LocationMatch "(/index\.php/apps/news/api/?$|/fever|/version$|/healthcheck$)">
# these locations should not be behind HTTP authentication
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse"
</LocationMatch>

2
docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md

@ -15,7 +15,7 @@ While MySQL can be used as a database for The Arsse, this is **not recommended**
You are therefore strongly advised not to use MySQL. Though our MySQL test suite ensures functionally identical behaviour to SQLite and PostgreSQL for the supplied test data in a default MySQL configuration, there are [many other subtle ways in which it can fail](https://web.archive.org/web/20190929090114/https://grimoire.ca/mysql/choose-something-else), and we do not have the manpower to account for most of these with certainty.
Also please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires. The awkwardly-named [_Percona Server for MySQL_](https://www.percona.com/software/mysql-database/percona-server), on the other hand, will work.
Also please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires (see the [relevant MariaDB issue](https://jira.mariadb.org/browse/MDEV-18511) for details). The awkwardly-named [_Percona Server for MySQL_](https://www.percona.com/software/mysql-database/percona-server), on the other hand, will work.
# Set-up

37
docs/en/025_Using_The_Arsse/010_Managing_Users.md

@ -21,7 +21,7 @@ Ji0ivMYqi6gKxQK1MHuE
# Setting and changing passwords
Setting's a user's password is practically identical to adding a password:
Setting a user's password is nearly identical to adding a user:
```sh
sudo -u www-data php arsse.php user set-pass "user@example.com" "new password"
@ -49,7 +49,40 @@ $ sudo -u www-data php arsse.php user set-pass --fever "jane.doe"
YfZJHq4fNTRUKDYhzQdR
```
## Managing login tokens for Miniflux
[Miniflux](/en/Supported_Protocols/Miniflux) clients may optionally log in using tokens: randomly-generated strings which act as persistent passwords. For now these must be generated using the command-line interface:
```console
$ sudo -u www-data php arsse.php token create "jane.doe"
xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0=
```
Multiple tokens may be generated for use with different clients, and descriptive labels can be assigned for later identification:
```console
$ sudo -u www-data php arsse.php token create "jane.doe" Newsflash
xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0=
$ sudo -u www-data php arsse.php token create "jane.doe" Reminiflux
L7asI2X_d-krinGJd1GsiRdFm2o06ZUlgD22H913hK4=
```
There are also commands for listing and revoking tokens. Please consult the integrated help for more details.
# Setting and changing user metadata
Users may also have various metadata properties set. These largely exist for compatibility with [the Miniflux protocol](/en/Supported_Protocols/Miniflux) and have no significant effect. One exception to this, however, is the `admin` flag, which signals whether the user may perform privileged operations where they exist in the supported protocols.
The flag may be changed using the following command:
```sh
sudo -u www-data php arsse.php user set "jane.doe" admin true
```
As a shortcut it is also possible to create administrators directly:
```sh
sudo -u www-data php arsse.php user add "user@example.com" "example password" --admin
```
Please consult the integrated help for more details on metadata and their effects.

60
docs/en/030_Supported_Protocols/005_Miniflux.md

@ -0,0 +1,60 @@
[TOC]
# About
<dl>
<dt>Supported since</dt>
<dd>0.9.0</dd>
<dt>Base URL</dt>
<dd>/</dd>
<dt>API endpoint</dt>
<dd>/v1/</dd>
<dt>Specifications</dt>
<dd><a href="https://miniflux.app/docs/api.html">API Reference</a>, <a href="https://miniflux.app/docs/rules.html#filtering-rules">Filtering Rules</a></dd>
</dl>
The Miniflux protocol is a fairly well-designed protocol supporting a wide variety of operations on newsfeeds, folders (termed "categories"), and articles; it also allows for user administration, and native OPML importing and exporting. Architecturally it is similar to the Nextcloud News protocol, but has more capabilities.
Miniflux version 2.0.28 is emulated, though not all features are implemented
# Missing features
- JSON Feed format is not suported
- Various feed-related features are not supported; attempting to use them has no effect
- Rewrite rules and scraper rules
- Custom User-Agent strings
- The `disabled`, `ignore_http_cache`, and `fetch_via_proxy` flags
- Changing the URL, username, or password of a feed
- Manually refreshing feeds
- Titles and types are not available during feed discovery and are filled with generic data
- Reading time is not calculated and will always be zero
- Only the first enclosure of an article is retained
- Comment URLs of articles are not exposed
# Differences
- Various error codes and messages differ due to significant implementation differences
- The "All" category is treated specially (see below for details)
- Feed and category titles consisting only of whitespace are rejected along with the empty string
- Filtering rules may not function identically (see below for details)
- The `checked_at` field of feeds indicates when the feed was last updated rather than when it was last checked
- Creating a feed with the `scrape` property set to `true` might not return scraped content for the initial synchronization
- Querying articles for both read/unread and removed statuses will not return all removed articles
- Search strings will match partial words
- OPML import either succeeds or fails atomically: if one feed fails, no feeds are imported
# Behaviour of filtering (block and keep) rules
The Miniflux documentation gives only a brief example of a pattern for its filtering rules; the allowed syntax is described in full [in Google's documentation for RE2](https://github.com/google/re2/wiki/Syntax). Being a PHP application, The Arsse instead accepts [PCRE syntax](http://www.pcre.org/original/doc/html/pcresyntax.html) (or since PHP 7.3 [PCRE2 syntax](https://www.pcre.org/current/doc/html/pcre2syntax.html)), specifically in UTF-8 mode. Delimiters should not be included, and slashes should not be escaped; anchors may be used if desired. For example `^(?i)RE/MAX$` is a valid pattern.
For convenience the patterns are tested after collapsing whitespace. Unlike Miniflux, The Arsse tests the patterns against an article's author-supplied categories if they do not match its title. Also unlike Miniflux, when filter rules are modified they are re-evaluated against all applicable articles immediately.
# Special handling of the "All" category
Nextcloud News' root folder and Tiny Tiny RSS' "Uncategorized" catgory are mapped to Miniflux's initial "All" category. This Miniflux category can be renamed, but it cannot be deleted. Attempting to do so will delete the child feeds it contains, but not the category itself.
Because the root folder does not existing in the database as a separate entity, it will always sort first when ordering by `category_id` or `category_title`.
# Interaction with nested categories
Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into categories nested to arbitrary depth. When newsfeeds are placed into nested categories, they simply appear in the top-level category when accessed via the Miniflux protocol. This does not affect OPML exports, where full nesting is preserved.

1
docs/en/030_Supported_Protocols/010_Nextcloud_News.md

@ -24,7 +24,6 @@ It allows organizing newsfeeds into single-level folders, and supports a wide ra
- When marking articles as starred the feed ID is ignored, as they are not needed to establish uniqueness
- The feed updater ignores the `userId` parameter: feeds in The Arsse are deduplicated, and have no owner
- The `/feeds/all` route lists only feeds which should be checked for updates, and it also returns all `userId` attributes as empty strings: feeds in The Arsse are deduplicated, and have no owner
- The API's "updater" routes do not require administrator priviledges as The Arsse has no concept of user classes
- The "updater" console commands mentioned in the protocol specification are not implemented, as The Arsse does not implement the required Nextcloud subsystems
- The `lastLoginTimestamp` attribute of the user metadata is always the current time: The Arsse's implementation of the protocol is fully stateless
- Syntactically invalid JSON input will yield a `400 Bad Request` response instead of falling back to GET parameters

3
docs/en/030_Supported_Protocols/030_Fever.md

@ -23,7 +23,6 @@ The Fever protocol is incomplete, unusual, _and_ a product of proprietary softwa
- All feeds are considered "Kindling"
- The "Hot Links" feature is not implemented; when requested, an empty array will be returned. As there is no way to classify a feed as a "Spark" in the protocol itself and no documentation exists on how link temperature was calculated, an implementation is unlikely to appear in the future
- Favicons are not currently supported; all feeds have a simple blank image as their favicon unless the client finds the icons itself
# Special considerations
@ -38,7 +37,7 @@ The Fever protocol is incomplete, unusual, _and_ a product of proprietary softwa
# Interaction with HTTP Authentication
We are not aware of any Fever clients which respond to HTTP authentication challenges. If the Web server or The Arsse is configured to require successful HTTP authentication, Fever clients are not likely to be able to connect properly.
Fever was not designed with HTTP authentication in mind, and few clients respond to challenges. If the Web server or The Arsse is configured to require successful HTTP authentication, most Fever clients are not likely to be able to connect properly.
# Interaction with Folders

1
docs/en/030_Supported_Protocols/index.md

@ -1,5 +1,6 @@
The Arsse was designed from the start as a server for multiple synchronization protocols which clients can make use of. Currently the following protocols are supported:
- [Miniflux](Miniflux)
- [Nextcloud News](Nextcloud_News)
- [Tiny Tiny RSS](Tiny_Tiny_RSS)
- [Fever](Fever)

230
docs/en/040_Compatible_Clients.md