Compare commits

...

229 Commits

Author SHA1 Message Date
J. King 0a8d19d37d Require PHP 7.3 6 days ago
J. King fe06ffc176 Avoid dynamic property creation with PicoFeed 6 days ago
J. King 0d6f8d2921 Avoid most deprecation warnings 1 week ago
J. King 92b1a840a1 Support PHP 8.2 properly 1 week ago
J. King a25e777ec6 Version bump 5 months ago
J. King 44e2c9c13e Update documentation 5 months ago
J. King 866800dcc5 Finish last Guzzle-related tests 5 months ago
J. King 136d3782e3 Update changelog 6 months ago
J. King 3be3f43bab Start on tests for response wrappers 6 months ago
J. King d2f3f19128 Fix failures 6 months ago
J. King 459e44e041 Address remaining errors 6 months ago
J. King 56f015bfb9 More Guzzle conversion 6 months ago
J. King 64ec3f6ae4 Use unused variable 6 months ago
J. King 4d18bf27e2 Adjust most uses of Diactoros to Guzzle PSR-7 6 months ago
J. King e588a52e88 Replace ServerRequestFactory 6 months ago
J. King 6c0183faea Replace instances of Diactoros' EmptyResponse 6 months ago
J. King 560d4db139 Remove Diactoros in favour of Guzzle PSR-7 6 months ago
J. King 2557c22410 Update dependencies 8 months ago
J. King 4ca7b65a65 Update dependencies 8 months ago
J. King 4d37ae30ae Update dependencies 8 months ago
J. King d1da6fbe5e Use cases rather than casting bools to int in SQL 8 months ago
J. King d54733ad98 Update link to Nextcloud News documentation again 9 months ago
J. King a0c31fac5d Merge branch 'reader' 9 months ago
J. King 59358ec35b More PHP 7 fixes 9 months ago
J. King 90b66241b3 Fixes for PHP 7 9 months ago
J. King 761b3d5333 Return removed articles correctly in Miniflux 9 months ago
J. King d64dc751f9 Tests for query filters 9 months ago
J. King f51acb4264 Build exceptions correctly in Miniflux for clarity 9 months ago
J. King 300225439c Fix trivial error in Miniflux 9 months ago
J. King c6cc2a1a42 Restore coverage for Query class 9 months ago
J. King a44fe103d8 Prototype for nesting query filters 9 months ago
J. King 630536d789 Tests for union context 9 months ago
J. King 206c5c0012 Fill in union context 9 months ago
J. King 0c8f33c37c Remove setCTE and pushCTE from query builder 9 months ago
J. King 26e431b1a5 Simplify more queries 9 months ago
J. King 336207741d Add missing API documentation 9 months ago
J. King 6863c182d7 Update reference to the "Reeder" client 9 months ago
J. King f2aad7188c Update links to TT-RSS documentation 9 months ago
J. King 65b1bb4fcd Allow multiple dates in TT-RSS searches 9 months ago
J. King 2c5b9a6768 Fix missing TTRSS coverage 9 months ago
J. King 17832ac63e Allow timezone in TT-RSS search queries 9 months ago
J. King e65069885b Clean up obsolete FIXMEs 9 months ago
J. King 7e5d8494c4 Tests for selecting arrays of ranges 9 months ago
J. King e6505a5fda Work around possible MySQL bug 9 months ago
J. King 2acacd2647 Implement handling for arrays of ranges 9 months ago
J. King f6799e2ab1 Tests for date ranges in contexts 10 months ago
J. King 33a3478a58 Avoid use of PHP 7.4 feature 10 months ago
J. King 2489743d0f Further simplifications 10 months ago
J. King 0bd01849bb Remove unnecessary in() clause 10 months ago
J. King 895c045c9b Simplify folder selection in article queries 10 months ago
J. King fe02613214 Fix coverage 10 months ago
J. King 427bddd3b7 Allow multiple date ranges 10 months ago
J. King 53ba591720 Finish up article selection refactor 10 months ago
J. King 97dfef3267 Fix typos 10 months ago
J. King 396ca86482 Start on removal of conditional CTEs 10 months ago
J. King 4a87926dd5 Fix up context tests 10 months ago
J. King 6f1332c559 Start to shore up testing 10 months ago
J. King 308b592b18 Clean up coontext classes 10 months ago
J. King 983fa58ec8 Convert article and edition ranges to atomic 10 months ago
J. King 2c2bb4a856 Retrofits dates to use ranges 10 months ago
J. King c993168002 Update URL of Nextcloud News documentation 10 months ago
J. King 73497688fc Break contexts up into traits 10 months ago
J. King 1b0256d6ce Abandon automation of binary packaging for now 10 months ago
J. King 144a41e061 Prepare new version 10 months ago
J. King 60b4002329 Revert "Document that we actually emulate Miniflux 2.0.29" 10 months ago
J. King f24ec8b00b Address security vulnerability in Guzzle's PSR-7 10 months ago
J. King d379aa2253 Document that we actually emulate Miniflux 2.0.29 11 months ago
J. King b707ecc942 Tag new version 1 year ago
J. King afe26fb8e1 Style fixes 1 year ago
J. King 3a219a591d Update dependencies 1 year ago
J. King b5579d6e43 Support PHP 8.1 1 year ago
J. King b660508009 Improve MySQL test performance 1 year ago
J. King 3c884f521b Update dependencies 1 year ago
J. King 70b063e028 Make parts of generic packaging conditional 2 years ago
J. King cf3d270077 Merge branch 'deb' 2 years ago
J. King 1fa75aba4a Generate Debian source package without deb tooling 2 years ago
J. King 317d23c1bb Fix copy-paste error in manual 2 years ago
J. King 75dbe380ba Add Pandoc to AUR arsse-git build dependencies 2 years ago
J. King 08250841a0 Don't sign packages 2 years ago
J. King 2452264893 Date release 2 years ago
J. King c1e57eb01f Add manual installation instructions 2 years ago
J. King e75e0dfd2f Clarify exactly what "older Debians" is 2 years ago
J. King 6c11c9e485 Fix Debian bugs 2 years ago
J. King 40a2856ae8 Use correct PHP_FPM socket paths for Debian 2 years ago
J. King c7dcc36ba1 Update version 2 years ago
J. King a31fb896d9 Update changelog 2 years ago
J. King def4a3bc77 Move Debian adaptations to Debian packaging rules 2 years ago
J. King cd89472575 Fix up Debian documentation 2 years ago
J. King beea98040c Initial documentation for Debian packages 2 years ago
J. King 59ff88f3b6 Add all-in-one packaging task 2 years ago
J. King 4070870421 Enforce external tooling requirements 2 years ago
J. King 5ab9dc3840 Add missing pbuilder script 2 years ago
J. King 20ffb2484a Simply Robo input for Arch and Deb packaging 2 years ago
J. King f91b3c0120 Output packages to a "release" directory 2 years ago
J. King 4121fc3e21 Database server ports must be integers 2 years ago
J. King 7ad3611a84 Set up configuration file for Debian properly 2 years ago
J. King 5412eb348f Clean up maintainer scripts 2 years ago
J. King c936ecc1af Fix another typo 2 years ago
J. King 99c923b1b1 Fix typos 2 years ago
J. King c2237532eb Add glue for dbconfig-common configuration 2 years ago
J. King 9687ce026e Add MySQL back to Debian depeendencies 2 years ago
J. King 30bed8a9d5 Typo 2 years ago
J. King cf9059c2b0 Update tooling 2 years ago
J. King 93bcf93685 Prototype Debian maintainer scripts 2 years ago
J. King 46e20be983 Test for service reloading 2 years ago
J. King ad32bf3340 Style fixes 2 years ago
J. King b8ac646d22 Fix up hangup signal handling 2 years ago
J. King 37c58e186a Handle hangup signal 2 years ago
J. King 88fe3e76cb Fix up missing-extension message 2 years ago
J. King 3c8ee42666 Basic tests for exception checking 2 years ago
J. King 04adc3b997 Document forking in the manpage 2 years ago
J. King c49cb72528 Fail gracefully when extensions are missing 2 years ago
J. King c9a2393a4e Note requirement for filter extension 2 years ago
J. King 75e87f31a0 Prototype code to check for missing extensions 2 years ago
J. King 3b51d4daea Fix license for Debian package 2 years ago
J. King ce9dfc3f30 Add init script to Debian files 2 years ago
J. King cbc7cd8ea7 Add an explicit path to init script 2 years ago
J. King 2e29f3f76e Correct typo 2 years ago
J. King 8a1a1eee42 Prototype init script 2 years ago
J. King e160189224 Handle exceptions from child processes 2 years ago
J. King e9394e8599 More forking tweaks 2 years ago
J. King 577356cd3d Fork error test 2 years ago
J. King 514cb0a351 Ow 2 years ago
J. King 0bb5e916d2 Test PID writing 2 years ago
J. King 2767ab755e Use D modifier in pattern 2 years ago
J. King a4036afbf8 Partial tests for PID file reading 2 years ago
J. King 32c9d761c3 Clean up more exceptions 2 years ago
J. King 5b3e8fbef0 Refine some exceptions 2 years ago
J. King b9fd9ac32e Tweaks 2 years ago
J. King 23749b51aa Tests for path resolution 2 years ago
J. King dfaf44ac68 Basic path resolution tests 2 years ago
J. King bab64add9b Separate PID conflict checking from PID claiming 2 years ago
J. King 822158d1bd Update dependencies 2 years ago
J. King f1c29c99c7 Finish testing PID file path checking 2 years ago
J. King 59cf27089a More daemon cleanup 2 years ago
J. King 4e1193bab2 Move forking daemon support code to own class 2 years ago
J. King 32e04e3938 Move forking and related to Service class 2 years ago
J. King 55acb87577 Start on PI(D file resolution tests 2 years ago
J. King e8cab78bd6 Handle last possible PID failures 2 years ago
J. King 9595c4f019 Start filling out PID file exceptions 2 years ago
J. King 372bf9f630 Exclude code from coverage 2 years ago
J. King 4ffc29781d Remove references to oldpass param 2 years ago
J. King 47af739e47 Catch more PID path failures 2 years ago
J. King 2c7b16ed27 Respond to termination signals and delete PID file 2 years ago
J. King 410310282f Load configuration after forking 2 years ago
J. King 29b83b4453 Prototype forking daemon 2 years ago
J. King fc2abc1203 Use D modifier for all patterns with $ anchors 2 years ago
J. King 59c5c2eb14 Oops 2 years ago
J. King 3cd3ac4a51 Correct filename conflict 2 years ago
J. King 837895fd6a Adapt dist files for Debian 2 years ago
J. King b4c9413130 Update README 2 years ago
J. King bafb788b02 Correct errors in manual 2 years ago
J. King 68e3cd82ca Don't include section number in title 2 years ago
J. King c3fa4788d6 Use proper metadata block for manpage 2 years ago
J. King 3567f294a6 Merge branch 'manpage' 2 years ago
J. King 8c0f047747 Update HTML manual to mention man page 2 years ago
J. King fd76b1b611 Add examples to manual page 2 years ago
J. King 4317a96db1 Work around double spacing 2 years ago
J. King 62d49e0d3c Fill out most of the manual page 2 years ago
J. King 88487d27a2 Expand manual page 2 years ago
J. King 46c88f584f Fix copying of man page in PKGBUILDs 2 years ago
J. King 92823d5bc2 Create directories before executing Pandoc 2 years ago
J. King 3e55ab3849 Move man pages to their own directory 2 years ago
J. King 2ec7acc50b Turn off "smart" character substitution in Pandoc 2 years ago
J. King d3a983e7f0 Move the markdown manpage 2 years ago
J. King 176aac0ad7 Fix stupid typo properly 2 years ago
J. King e439dd8277 Fix manpage in Arch PKGBUILD 2 years ago
J. King 6cc9f96728 Prototype manual page 2 years ago
J. King d4569c77a9 Add database location to tmpfiles 2 years ago
J. King add1acc87a Fix more lintian complaints 2 years ago
J. King 14d3cdfe58 Hopefully fix some Debian problems 2 years ago
J. King 281760be71 Address some lintian complaints 2 years ago
J. King 758a02d667 Move generic configuration file 2 years ago
J. King 18846c19cb Add install list for Debian package 2 years ago
J. King b5bbdc2bc6 Date release 2 years ago
J. King 3be6c9984d Update Apache documentation in manual 2 years ago
J. King 6c84b2199e More Apache fixes 2 years ago
J. King f9cbac2c31 Hopefully fix Apache configuration 2 years ago
J. King 32ca0c3fe4 Appease GitHub once and for all 2 years ago
J. King a81bd0e45c Add whitespace 2 years ago
J. King 86d82a2586 Use global flag when replacing with sed 2 years ago
J. King f0bf55f9cf Add ExecStart to parent systemd unit 2 years ago
J. King 1055611940 Add version constraints to Arch dependencies 2 years ago
J. King 2ccfb1fd33 Fix packaging process 2 years ago
J. King 9eabfd0f27 Fix up sed usage in PKGBUILD 2 years ago
J. King 0236b42052 Use tmpfiles to create link to config file 2 years ago
J. King 8aa9d81fd1 Update changelog 2 years ago
J. King 11fc83da60 Significant edits to the manual 2 years ago
J. King de55290746 Fix build dependencies for Deb package 2 years ago
J. King f844c17a94 More Debian fixes 2 years ago
J. King 0de9647809 Add compat file 2 years ago
J. King e653fb3f73 Enhancements to Debian files 2 years ago
J. King b7909d7cd3 Downgrade tool dependencies for Ubuntu 2 years ago
J. King 3c9f4dd66f Prototype Debian rules file 2 years ago
J. King 3537e74d49 Update dependencies 2 years ago
J. King d031d931a5 Tidy up the Robo file further 2 years ago
J. King 38cb1059b2 Shorten output of packaging task 2 years ago
J. King 16174f11b6 Add changelog parsing to packaging task 2 years ago
J. King 073f6b3c39 Prototype Debian control file and other changes 2 years ago
J. King 3f3f449da1 Re-organize manual 2 years ago
J. King 2260b7cc50 Back up all Web server configuration 2 years ago
J. King 61eb4a252e Fix doc URLs 2 years ago
J. King 3f401f1cfa Fix typo 2 years ago
J. King 6c750d2dc0 Documentation for installing on Arch 2 years ago
J. King 6d790c5efd Add prototype for new Apache configuration 2 years ago
J. King 3a3b9231df Use generic configuration where possible 2 years ago
J. King fbe03a2534 Use chmod instead of touch 2 years ago
J. King e75f8cebfb Add Arch packaging to Robo file 2 years ago
J. King 79391446cd Start moving Arch build responsibility to Robo 2 years ago
J. King 19ab9df063 Fix more bugs 2 years ago
J. King 568b12600b Drop privileges when executing CLI 2 years ago
J. King 488af80a85 Update changelog 2 years ago
J. King 44612cfe8f Add tmpfiles 2 years ago
J. King d1fd6e9653 Correct permissions 2 years ago
J. King a97ca23631 Don't try to enable extensions 2 years ago
J. King e2b182ebe6 Fix errors in Arch config file 2 years ago
J. King 3eab5aad5d Fix adding users to a blank database 2 years ago
J. King 805a508ea6 Use correct state path 2 years ago
J. King 3ebc23ab13 Tweaks 2 years ago
J. King 7abdf05b7f Make package from local files for now 2 years ago
J. King 971c12ff9f Rename sample to example 2 years ago
J. King febc7c7ca4 Add configuration for Nginx 2 years ago
J. King edb146b826 Use PHP-FPM instead of uWSGI 2 years ago
J. King 7ba4cabdde Prototype Arch PKGBUILD and supporting files 2 years ago
J. King 114dcc568f Update dependencies 2 years ago
Dustin Wilson 1331b14a04 Reverting for now 2 years ago
Dustin Wilson 035feae0ce Removed postcss in favor of sass for building manual theme 2 years ago
J. King 8e063bea2f Appease GitHub again 2 years ago
J. King 4a9e66d872 Fix inconsistent grammar 2 years ago
  1. 21
      .gitignore
  2. 64
      CHANGELOG
  3. 27
      README.md
  4. 551
      RoboFile.php
  5. 13
      UPGRADING
  6. 5
      arsse.php
  7. 27
      composer.json
  8. 699
      composer.lock
  9. 23
      dist/apache.conf
  10. 34
      dist/apache/arsse-loc.conf
  11. 11
      dist/apache/arsse.conf
  12. 9
      dist/apache/example.conf
  13. 57
      dist/arch/PKGBUILD
  14. 74
      dist/arch/PKGBUILD-git
  15. 10
      dist/arsse
  16. 15
      dist/arsse.service
  17. 8
      dist/config.php
  18. 16
      dist/debian/arsse.config
  19. 1
      dist/debian/arsse.dirs
  20. 18
      dist/debian/arsse.install
  21. 1
      dist/debian/arsse.links
  22. 29
      dist/debian/arsse.postinst
  23. 20
      dist/debian/arsse.postrm
  24. 16
      dist/debian/arsse.prerm
  25. 1
      dist/debian/compat
  26. 15
      dist/debian/config.php
  27. 32
      dist/debian/control
  28. 34
      dist/debian/copyright
  29. 44
      dist/debian/dbconfig-common.php
  30. 6
      dist/debian/lintian-overrides
  31. 40
      dist/debian/pbuilder.sh
  32. 26
      dist/debian/rules
  33. 1
      dist/debian/source/format
  34. 2
      dist/debian/source/lintian-overrides
  35. 78
      dist/init.sh
  36. 75
      dist/nginx.conf
  37. 12
      dist/nginx/arsse-fcgi.conf
  38. 49
      dist/nginx/arsse-loc.conf
  39. 17
      dist/nginx/arsse.conf
  40. 13
      dist/nginx/example.conf
  41. 11
      dist/php-fpm.conf
  42. 36
      dist/systemd/arsse-fetch.service
  43. 14
      dist/systemd/arsse.service
  44. 1
      dist/sysuser.conf
  45. 4
      dist/tmpfiles.conf
  46. 16
      docs/en/020_Getting_Started/010_Requirements.md
  47. 41
      docs/en/020_Getting_Started/020_Download_and_Installation.md
  48. 54
      docs/en/020_Getting_Started/020_Download_and_Installation/010_On_Arch_Linux.md
  49. 72
      docs/en/020_Getting_Started/020_Download_and_Installation/020_On_Debian_and_Derivatives.md
  50. 53
      docs/en/020_Getting_Started/020_Download_and_Installation/999_ On_Other_Systems.md
  51. 16
      docs/en/020_Getting_Started/020_Download_and_Installation/index.md
  52. 124
      docs/en/020_Getting_Started/030_Web_Server_Configuration.md
  53. 14
      docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md
  54. 2
      docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md
  55. 2
      docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md
  56. 16
      docs/en/020_Getting_Started/050_Configuration.md
  57. 3
      docs/en/020_Getting_Started/index.md
  58. 22
      docs/en/025_Using_The_Arsse/010_Managing_Users.md
  59. 8
      docs/en/025_Using_The_Arsse/020_Importing_and_Exporting.md
  60. 49
      docs/en/025_Using_The_Arsse/030_Keeping_Newsfeeds_Up_to_Date.md
  61. 34
      docs/en/025_Using_The_Arsse/030_Other_Topics.md
  62. 12
      docs/en/025_Using_The_Arsse/040_Upgrading_to_a_New_Version.md
  63. 15
      docs/en/025_Using_The_Arsse/index.md
  64. 1
      docs/en/030_Supported_Protocols/005_Miniflux.md
  65. 2
      docs/en/030_Supported_Protocols/010_Nextcloud_News.md
  66. 4
      docs/en/030_Supported_Protocols/020_Tiny_Tiny_RSS.md
  67. 4
      docs/en/040_Compatible_Clients.md
  68. 13
      lib/AbstractException.php
  69. 32
      lib/Arsse.php
  70. 251
      lib/CLI.php
  71. 6
      lib/Conf.php
  72. 27
      lib/Context/AbstractContext.php
  73. 35
      lib/Context/BooleanMembers.php
  74. 40
      lib/Context/Context.php
  75. 250
      lib/Context/ExclusionContext.php
  76. 262
      lib/Context/ExclusionMembers.php
  77. 20
      lib/Context/RootContext.php
  78. 50
      lib/Context/UnionContext.php
  79. 620
      lib/Database.php
  80. 8
      lib/Db/MySQL/Driver.php
  81. 3
      lib/Db/MySQL/PDODriver.php
  82. 2
      lib/Db/MySQL/Statement.php
  83. 2
      lib/Db/PDOStatement.php
  84. 2
      lib/Db/PostgreSQL/Driver.php
  85. 4
      lib/Db/PostgreSQL/Statement.php
  86. 5
      lib/Db/Result.php
  87. 9
      lib/Db/SQLite3/Driver.php
  88. 3
      lib/Db/SQLite3/PDODriver.php
  89. 2
      lib/Db/SQLite3/Statement.php
  90. 107
      lib/Feed.php
  91. 24
      lib/Feed/Item.php
  92. 27
      lib/Misc/HTTP.php
  93. 75
      lib/Misc/Query.php
  94. 75
      lib/Misc/QueryFilter.php
  95. 2
      lib/Misc/URL.php
  96. 10
      lib/Misc/ValueInfo.php
  97. 24
      lib/REST.php
  98. 25
      lib/REST/Fever/API.php
  99. 19
      lib/REST/Miniflux/ErrorResponse.php
  100. 11
      lib/REST/Miniflux/Status.php

21
.gitignore

@ -1,17 +1,27 @@
# Temporary files and dependencies
# Temporary files
/vendor/
/vendor-bin/*/vendor
/node_modules
/release/
/documentation/
/manual/
/tests/coverage/
/dist/arch/arsse/
/dist/arch/src/
/dist/arch/pkg/
/dist/man/
/arsse.db*
/config.php
/.php_cs.cache
/yarn-error.log
/.php-cs-fixer.cache
/tests/.phpunit.result.cache
# Dependencies
/vendor/
/vendor-bin/*/vendor
/node_modules
/yarn.lock
/yarn-error.log
# Windows files
@ -36,6 +46,7 @@ $RECYCLE.BIN/
*.zip
*.7z
*.tar.gz
*.tar.xz
*.tgz
*.deb
*.rpm

64
CHANGELOG

@ -1,3 +1,60 @@
Version 0.??.? (????-??-??)
===========================
Changes:
- Require PHP 7.3
Version 0.10.4 (2023-01-24)
===========================
Changes:
- Support PHP 8.2
Version 0.10.3 (2022-09-14)
===========================
Bug fixes:
- Return all removed articles when multiple statuses are requested in Miniflux
- Allow multiple date ranges in search strings in Tiny Tiny RSS
- Honour user time zone when interpreting search strings in Tiny Tiny RSS
- Perform MySQL table maintenance more reliably
- Address CVE-2022-31090, CVE-2022-31091, CVE-2022-29248, and CVE-2022-31109
Version 0.10.2 (2022-04-04)
===========================
Changes:
- Update Guzzle PSR-7 due to CVE-2022-24775
Version 0.10.1 (2022-01-17)
===========================
Changes:
- Support PHP 8.1
Version 0.10.0 (2021-07-11)
===========================
New features:
- Complete Unix manual page
- Support for running service as a forking daemon
- Respond to TERM and HUP signals when possible
Changes:
- Packages for Debian and related are now available (see manual for details)
Version 0.9.2 (2021-05-25)
==========================
Bug fixes:
- Do not fail adding users to an empty database (regression since 0.9.0)
- Cleanly ignore unknown configuration properties
- Set access mode to rw-r---- when creating SQLite databases
Changes:
- Packages for Arch Linux are now available (see manual for details)
- Numerous improvements to the manual
Version 0.9.1 (2021-03-18)
==========================
@ -5,7 +62,7 @@ Bug fixes:
- Respond to PUT requests with 201 rather than 200 in Miniflux
Changes:
- Corrected Web server configuration in manual
- Correct Web server configuration in manual
Version 0.9.0 (2021-03-06)
==========================
@ -118,7 +175,7 @@ Bug fixes:
Version 0.6.1 (2019-01-23)
==========================
Bug Fixes:
Bug fixes:
- Unify SQL timeout settings
- Correctly escape shell command in subprocess service driver
- Correctly allow null time intervals in configuration when appropriate
@ -238,4 +295,5 @@ Bug fixes:
Version 0.1.0 (2017-08-29)
==========================
Initial release
New features:
- Initial release

27
README.md

@ -8,7 +8,7 @@ Information on how to install and use the software can be found in [the manual](
The main repository for The Arsse can be found at [code.mensbeam.com](https://code.mensbeam.com/MensBeam/arsse/), with a mirror also available [at GitHub](https://github.com/mensbeam/arsse/). The GitHub mirror does not accept bug reports, but the two should otherwise be equivalent.
[Composer](https://getcomposer.org/) is required to manage PHP dependencies. After cloning the repository or downloading a source code tarball, running `composer install` will download all the required dependencies, and will advise if any PHP extensions need to be installed. If not installing as a programming environment, running `composer install --no-dev` is recommended.
[Composer](https://getcomposer.org/) is required to manage PHP dependencies. After cloning the repository or downloading a source code tarball, running `composer install` will download all the required dependencies, and will advise if any PHP extensions need to be installed. If not installing as a programming environment, running `composer install -o --no-dev --no-scripts` is recommended.
# Repository structure
@ -34,13 +34,15 @@ Also necessary to the functioning of the application is the `/vendor/` directory
The `/locale/` and `/sql/` directories contain human-language files and database schemata, both of which are occasionally used by the application in the course of execution. The `/www/` directory serves as a document root for a few static files to be made available to users by a Web server.
The `/dist/` directory, on the other hand, contains samples of configuration for Web servers and init systems. These are not used by The Arsse itself, but are merely distributed with it for reference.
The `/dist/` directory, on the other hand, contains general and system-specific build files, and samples of configuration for Web servers and other system integration. These are not used by The Arsse itself, but are used during the process of preparing new releases for supported operating systems.
## Documentation
The source text for The Arsse's manual can be found in `/docs/`, with pages written in [Markdown](https://spec.commonmark.org/current/) and converted to HTML [with Daux](#building-the-manual). If a static manual is generated its files will appear under `/manual/`.
In addition to the manual the files `/README.md` (this file), `/CHANGELOG`, `/UPGRADING`, `/LICENSE`, and `/AUTHORS` also document various things about the software, rather than the software itself.
The Arsse also has a UNIX manual page, also written in Markdown, which can be found under `/manpages/`. [Pandoc](https://pandoc.org/) is needed to convert it to the appropriate format, with the results stored under `/dist/man/`.
In addition to the manuals the files `/README.md` (this file), `/CHANGELOG`, `/UPGRADING`, `/LICENSE`, and `/AUTHORS` also document various things about the software, rather than the software itself.
## Tests
@ -50,7 +52,7 @@ The `/tests/` directory contains everything related to automated testing. It is
|--------------------|------------------------------------------------------------------------------------|
| `cases/` | The test cases themselves, organized in roughly the same structure as the code |
| `coverage/` | (optional) Generated code coverage reports |
| `docroot/` | Sample documents used in some tests, to be returned by the PHP's basic HTTP server |
| `docroot/` | Sample documents used in some tests, to be returned by PHP's basic HTTP server |
| `lib/` | Supporting classes which do not contain test cases |
| `bootstrap.php` | Bootstrap script, equivalent to `/arsse.php`, but for tests |
| `phpunit.dist.xml` | PHPUnit configuration file |
@ -74,7 +76,7 @@ The `/vendor-bin/` directory houses the files needed for the tools used in The A
| `/robo` | Simple wrapper for executing Robo on POSIX systems |
| `/robo.bat` | Simple wrapper for executing Robo on Windows |
In addition the files `/package.json`, `/yarn.lock`, and `/postcss.config.js` as well as the `/node_modules/` directory are used by [Yarn](https://yarnpkg.com/) and [PostCSS](https://postcss.org/) when modifying the stylesheet for The Arsse's manual.
In addition the files `/package.json` and `/postcss.config.js` as well as the `/node_modules/` directory are used by [Yarn](https://yarnpkg.com/) and [PostCSS](https://postcss.org/) when modifying the stylesheet for The Arsse's manual.
# Common tasks
@ -105,15 +107,20 @@ The Arsse's user manual, made using [Daux](https://daux.io/), can be compiled by
The manual employs a custom theme derived from the standard Daux theme. If the standard Daux theme receives improvements, the custom theme can be rebuilt by running `./robo manual:theme`. This requires that [NodeJS](https://nodejs.org) and [Yarn](https://yarnpkg.com/) be installed, but JavaScript tools are not required to modify The Arsse itself, nor the content of the manual.
## Building the man page
The Arsse's UNIX manual page is authored in Markdown, and must be converted to the native roff format using [Pandoc](https://pandoc.org/). This can be done by running `./robo manpage`, which will output appropriate files to `/dist/man/`. The conversion should not be done manually as there is post-processing required for optimal output.
## Packaging a release
Producing a release package is done by running `./robo package`. This performs the following operations:
Producing release packages is done by running `./robo package`. This performs the following operations:
- Duplicates a working tree with the commit (usually a release tag) to package
- Generates the manual
- Duplicates a [Git](https://git-scm.com/) working tree with the commit (usually a release tag) to package
- Generates UNIX manual pages with [Pandoc](https://pandoc.org/)
- Generates the HTML manual
- Installs runtime Composer dependencies with an optimized autoloader
- Deletes numerous unneeded files
- Exports the default configuration of The Arsse to a file
- Compresses the remaining files into a tarball
Due to the first step, [Git](https://git-scm.com/) is required to package a release.
- Produces a binary package for Arch Linux, if possible
- Produces source and binary packages for Debian using [pbuilder](https://pbuilder-team.pages.debian.net/pbuilder/), if possible

551
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");
define("IS_LINUX", !IS_WIN && !IS_MAC);
error_reporting(0);
function norm(string $path): string {
@ -145,63 +146,258 @@ class RoboFile extends \Robo\Tasks {
return $this->taskExec($executor)->option("-d", "zend.assertions=1")->arg($execpath)->option("-c", $confpath)->args(array_merge($set, $args))->run();
}
protected function commitVersion(?string $commit): array {
$target = $commit ?? $this->askDefault("Reference commit:", "HEAD");
$base = escapeshellarg(BASE);
$blackhole = $this->blackhole();
// get useable version strings from Git
$version = trim(`git -C $base describe --tags $target $blackhole`);
if (!$version) {
throw new \Exception("Commit reference invalid");
}
return [$target, $version];
}
protected function toolExists(string ...$binary): bool {
$blackhole = $this->blackhole(IS_WIN);
foreach ($binary as $bin) {
if (
(IS_WIN && (!exec(escapeshellarg($bin)." --help $blackhole", $junk, $status) || $status))
|| (!IS_WIN && (!exec("which ".escapeshellarg($bin)." $blackhole", $junk, $status) || $status))
) {
return false;
}
}
return true;
}
/** Packages a given commit of the software into a release tarball
*
* The version to package may be any Git tree-ish identifier: a tag, a branch,
* The commit to package may be any Git tree-ish identifier: a tag, a branch,
* or any commit hash. If none is provided on the command line, Robo will prompt
* for a commit to package; the default is "head".
* for a commit to package; the default is "HEAD".
*
* Note that while it is possible to re-package old versions, the resultant tarball
* may not be equivalent due to subsequent changes in the exclude list, or because
* of new tooling.
*/
public function package(string $version = null): Result {
public function packageGeneric(string $commit = null): Result {
if (!$this->toolExists("git", "pandoc")) {
throw new \Exception("Git and Pandoc are required in PATH to produce generic release tarballs");
}
// establish which commit to package
$version = $version ?? $this->askDefault("Commit to package:", "HEAD");
$archive = BASE."arsse-$version.tar.gz";
[$commit, $version] = $this->commitVersion($commit);
preg_match('/^([^-]+)(?:-(\d+)-(\w+))?$/', $version, $m);
$archVersion = $m[1].($m[2] ? ".r$m[2].$m[3]" : "");
$baseVersion = $m[1];
$release = $m[2];
// name the generic release tarball
$tarball = BASE."release/$version/arsse-$version.tar.gz";
// start a collection
$t = $this->collectionBuilder();
// create a temporary directory
$dir = $t->tmpDir().\DIRECTORY_SEPARATOR;
// create a Git worktree for the selected commit in the temp location
$t->taskExec("git worktree add ".escapeshellarg($dir)." ".escapeshellarg($version));
// perform Composer installation in the temp location with dev dependencies
$t->taskComposerInstall()->dir($dir);
// generate the manual
$t->taskExec(escapeshellarg($dir."robo")." manual")->dir($dir);
// perform Composer installation in the temp location for final output
$t->taskComposerInstall()->dir($dir)->noDev()->optimizeAutoloader()->arg("--no-scripts");
// delete unwanted files
$t->taskFilesystemStack()->remove([
$dir.".git",
$dir.".gitignore",
$dir.".gitattributes",
$dir."composer.json",
$dir."composer.lock",
$dir.".php_cs.dist",
$dir."phpdoc.dist.xml",
$dir."build.xml",
$dir."RoboFile.php",
$dir."CONTRIBUTING.md",
$dir."docs",
$dir."tests",
$dir."vendor-bin",
$dir."vendor/bin",
$dir."robo",
$dir."robo.bat",
$dir."package.json",
$dir."yarn.lock",
$dir."postcss.config.js",
]);
// generate a sample configuration file
$t->taskExec(escapeshellarg(\PHP_BINARY)." arsse.php conf save-defaults config.defaults.php")->dir($dir);
// package it all up
$t->taskPack($archive)->addDir("arsse", $dir);
// execute the collection
$out = $t->run();
// clean the Git worktree list
$this->_exec("git worktree prune");
return $out;
$result = $this->taskExec("git worktree add ".escapeshellarg($dir)." ".escapeshellarg($version))->dir(BASE)->run();
if ($result->getExitCode() > 0) {
return $result;
}
try {
// Perform Arch-specific tasks
if (file_exists($dir."dist/arch")) {
// patch the Arch PKGBUILD file with the correct version string
$t->addTask($this->taskReplaceInFile($dir."dist/arch/PKGBUILD")->regex('/^pkgver=.*$/m')->to("pkgver=$archVersion"));
// patch the Arch PKGBUILD file with the correct source file
$t->addTask($this->taskReplaceInFile($dir."dist/arch/PKGBUILD")->regex('/^source=\("arsse-[^"]+"\)$/m')->to('source=("'.basename($tarball).'")'));
}
// perform Debian-specific tasks
if (file_exists($dir."dist/debian")) {
// generate the Debian changelog; this also validates our original changelog
$changelog = $this->changelogParse(file_get_contents($dir."CHANGELOG"), $version);
$debianChangelog = $this->changelogDebian($changelog, $version);
// save the Debian-format changelog
$t->addTask($this->taskWriteToFile($dir."dist/debian/changelog")->text($debianChangelog));
}
// perform RPM-specific tasks
if (file_exists($dir."dist/rpm")) {
// patch the spec file with the correct version and release
$t->addTask($this->taskReplaceInFile($dir."dist/rpm/arsse.spec")->regex('/^Version: .*$/m')->to("Version: $baseVersion"));
$t->addTask($this->taskReplaceInFile($dir."dist/rpm/arsse.spec")->regex('/^Release: .*$/m')->to("Release: $release"));
// patch the spec file with the correct tarball name
$t->addTask($this->taskReplaceInFile($dir."dist/rpm/arsse.spec")->regex('/^Source0: .*$/m')->to("Source0: arsse-$version.tar.gz"));
// append the RPM changelog to the spec file
$t->addTask($this->taskWriteToFile($dir."dist/rpm/arsse.spec")->append(true)->text("\n\n%changelog\n".$this->changelogRPM($changelog, $version)));
}
// save commit description to VERSION file for reference
$t->addTask($this->taskWriteToFile($dir."VERSION")->text($version));
if (file_exists($dir."docs") || file_exists($dir."manpages")) {
// perform Composer installation in the temp location with dev dependencies to include Robo and Daux
$t->addTask($this->taskExec("composer install")->arg("-q")->dir($dir));
}
if (file_exists($dir."manpages")) {
// generate manpages
$t->addTask($this->taskExec("./robo manpage")->dir($dir));
}
if (file_exists($dir."docs")) {
// generate the HTML manual
$t->addTask($this->taskExec("./robo manual -q")->dir($dir));
}
// perform Composer installation in the temp location for final output
$t->addTask($this->taskExec("composer install")->dir($dir)->arg("--no-dev")->arg("-o")->arg("--no-scripts")->arg("-q"));
// delete unwanted files
$t->addTask($this->taskFilesystemStack()->remove([
$dir.".git",
$dir.".gitignore",
$dir.".gitattributes",
$dir."dist/debian/.gitignore",
$dir."composer.json",
$dir."composer.lock",
$dir.".php_cs.dist",
$dir."phpdoc.dist.xml",
$dir."build.xml",
$dir."RoboFile.php",
$dir."CONTRIBUTING.md",
$dir."docs",
$dir."manpages",
$dir."tests",
$dir."vendor-bin",
$dir."vendor/bin",
$dir."robo",
$dir."robo.bat",
$dir."package.json",
$dir."yarn.lock",
$dir."postcss.config.js",
]));
$t->addCode(function() use ($dir) {
// Remove files which lintian complains about; they're otherwise harmless
$files = [];
foreach (new \CallbackFilterIterator(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir."vendor", \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS)), function($v, $k, $i) {
return preg_match('/\/\.git(?:ignore|attributes|modules)$/D', $v);
}) as $f) {
$files[] = $f;
}
return $this->taskFilesystemStack()->remove($files)->run();
});
// generate a sample configuration file
$t->addTask($this->taskExec(escapeshellarg(\PHP_BINARY)." arsse.php conf save-defaults config.defaults.php")->dir($dir));
// remove any existing archive
$t->addTask($this->taskFilesystemStack()->remove($tarball));
// package it all up
$t->addTask($this->taskFilesystemStack()->mkdir(dirname($tarball)));
$t->addTask($this->taskPack($tarball)->addDir("arsse", $dir));
// execute the collection
$result = $t->run();
} finally {
// remove the Git worktree
$this->taskFilesystemStack()->remove($dir)->run();
$this->taskExec("git worktree prune")->dir(BASE)->run();
}
return $result;
}
/** Packages a release tarball into a Debian source package
*
* The commit to package may be any Git tree-ish identifier: a tag, a branch,
* or any commit hash. If none is provided on the command line, Robo will prompt
* for a commit to package; the default is "HEAD".
*/
public function packageDebsrc(string $commit = null): Result {
// establish which commit to package
[$commit, $version] = $this->commitVersion($commit);
$tarball = BASE."release/$version/arsse-$version.tar.gz";
// determine the base version (i.e. x.y.z) and the Debian version (i.e. x.y.z-a)
preg_match('/^(\d+(?:\.\d+)+)(?:-(\d+))?/', $version, $m);
$baseVersion = $m[1];
$debVersion = $m[1]."-".($version === $baseVersion ? "1" : $m[2]);
// start a task collection and create a temporary directory
$t = $this->collectionBuilder();
$dir = $t->tmpDir().\DIRECTORY_SEPARATOR;
// build the generic release tarball if it doesn't exist
if (!file_exists($tarball)) {
$t->addTask($this->taskExec(BASE."robo package:generic $commit"));
}
$base = $dir."arsse-$version".\DIRECTORY_SEPARATOR;
// start by extracting the tarball
$t->addCode(function() use ($tarball, $dir, $base) {
// Robo's extract task is broken, so we do it manually
(new \Archive_Tar($tarball))->extract($dir, false);
return $this->taskFilesystemStack()->rename($dir."arsse", $base)->run();
});
// re-pack the tarball using a specific name special to Debian
$t->addTask($this->taskPack($dir."arsse_$baseVersion.orig.tar.gz")->addDir("arsse-$baseVersion", $base));
// pack the debian tarball
$t->addTask($this->taskPack($dir."arsse_$debVersion.debian.tar.gz")->addDir("debian", $base."dist/debian"));
// generate the DSC file
$t->addCode(function() use ($t, $debVersion, $baseVersion, $dir, $base) {
try {
$dsc = $this->generateDebianSourceControl($base."dist/debian/", $debVersion, [$dir."arsse_$baseVersion.orig.tar.gz", $dir."arsse_$debVersion.debian.tar.gz"]);
} catch (\Exception $e) {
return new Result($t, 1, $e->getMessage());
}
// write the DSC file
return $this->taskWriteToFile($dir."arsse_$debVersion.dsc")->text($dsc)->run();
});
// delete any existing files
$t->AddTask($this->taskFilesystemStack()->remove([BASE."release/$version/arsse_$baseVersion.orig.tar.gz", BASE."release/$version/arsse_$debVersion.debian.tar.gz", BASE."release/$version/arsse_$debVersion.dsc"]));
// copy the new files over
$t->addTask($this->taskFilesystemStack()->copy($dir."arsse_$baseVersion.orig.tar.gz", BASE."release/$version/arsse_$baseVersion.orig.tar.gz")->copy($dir."arsse_$debVersion.debian.tar.gz", BASE."release/$version/arsse_$debVersion.debian.tar.gz")->copy($dir."arsse_$debVersion.dsc", BASE."release/$version/arsse_$debVersion.dsc"));
return $t->run();
}
/** Packages a given commit of the software and produces all relevant release files
*
* The commit to package may be any Git tree-ish identifier: a tag, a branch,
* or any commit hash. If none is provided on the command line, Robo will prompt
* for a commit to package; the default is "HEAD".
*
* In addition to the release tarball, a Debian source package, Arch PKGBUILD,
* and RPM spec file are output as well. These are suitable for use with Open
* Build Service instances and with slight modification the Arch User Repository.
* Use for Launchpad PPAs has not been tested.
*/
public function package(string $commit = null): Result {
if (!$this->toolExists("git")) {
throw new \Exception("Git is required in PATH to produce packages");
}
[$commit, $version] = $this->commitVersion($commit);
$tarball = BASE."release/$version/arsse-$version.tar.gz";
// build the generic release tarball
$result = $this->taskExec(BASE."robo package:generic $commit")->run();
if (!$result->wasSuccessful()) {
return $result;
}
// if the generic tarball could be built, try to produce Arch, Debian, and RPM files; these might legitimately not exist in old releases
// start by getting the list of files from the tarball
$archive = new \Archive_Tar($tarball);
$filelist = array_flip(array_column($archive->listContent(), "filename"));
// start a collection
$t = $this->collectionBuilder();
// Produce an Arch PKGBUILD if appropriate
if (isset($filelist['arsse/dist/arch/PKGBUILD'])) {
$t->addCode(function() use ($tarball, $archive) {
$dir = dirname($tarball).\DIRECTORY_SEPARATOR;
$archive->extractList("arsse/dist/arch/PKGBUILD", $dir, "arsse/dist/arch/", false);
// update the tarball's checksum
$sums = [
'md5' => hash_file("md5", $tarball),
];
return $this->taskReplaceInFile($dir."PKGBUILD")->regex('/^md5sums=\("SKIP"\)$/m')->to('md5sums=("'.$sums['md5'].'")')->run();
});
}
// Produce a Debian source package if appropriate
if (isset($filelist['arsse/dist/debian/control']) && isset($filelist['arsse/dist/debian/source/format'])) {
$t->addTask($this->taskExec(BASE."robo package:debsrc $commit"));
}
// Produce an RPM spec file if appropriate
if (isset($filelist['arsse/dist/rpm/arsse.spec'])) {
$t->addCode(function() use ($tarball, $archive) {
$dir = dirname($tarball).\DIRECTORY_SEPARATOR;
$archive->extractList("arsse/dist/rpm/arsse.spec", $dir, "arsse/dist/rpm/", false);
// perform a do-nothing filesystem operation since we need a Robo task result
return $this->taskFilesystemStack()->chmod($dir."arsse.spec", 0644)->run();
});
}
return $t->run();
}
/** Generates static manual pages in the "manual" directory
@ -230,6 +426,9 @@ class RoboFile extends \Robo\Tasks {
* Daux's theme changes
*/
public function manualTheme(array $args): Result {
if (!$this->toolExists("yarn")) {
throw new \Exception("Yarn is required in PATH to update the Daux theme");
}
$postcss = escapeshellarg(norm(BASE."node_modules/.bin/postcss"));
$themesrc = norm(BASE."docs/theme/src/").\DIRECTORY_SEPARATOR;
$themeout = norm(BASE."docs/theme/arsse/").\DIRECTORY_SEPARATOR;
@ -247,4 +446,270 @@ class RoboFile extends \Robo\Tasks {
// execute the collection
return $t->run();
}
/** Generates the "arsse" command's manual page (UNIX man page)
*
* This requires that the Pandoc document converter be installed and
* available in $PATH.
*/
public function manpage(): Result {
if (!$this->toolExists("pandoc")) {
throw new \Exception("Pandoc is required in PATH to generate manual pages");
}
$t = $this->collectionBuilder();
$man = [
'en' => "man1/arsse.1",
];
foreach ($man as $src => $out) {
$src = BASE."manpages/$src.md";
$out = BASE."dist/man/$out";
$t->addTask($this->taskFilesystemStack()->mkdir(dirname($out), 0755));
$t->addTask($this->taskExec("pandoc -s -f markdown-smart -t man -o ".escapeshellarg($out)." ".escapeshellarg($src)));
$t->addTask($this->taskReplaceInFile($out)->regex('/\.\n(?!\.)/s')->to(". "));
}
return $t->run();
}
protected function changelogParse(string $text, string $targetVersion): array {
$lines = preg_split('/\r?\n/', $text);
$version = "";
$section = "";
$out = [];
$entry = [];
$expected = ["version"];
for ($a = 0; $a < sizeof($lines);) {
$l = rtrim($lines[$a++]);
if (in_array("version", $expected) && preg_match('/^Version (\d+(?:\.\d+)*) \(([\d\?]{4}-[\d\?]{2}-[\d\?]{2})\)\s*$/D', $l, $m)) {
$version = $m[1];
if (!preg_match('/^\d{4}-\d{2}-\d{2}$/D', $m[2])) {
// uncertain dates are allowed only for the top version, and only if it does not match the target version (otherwise we have forgotten to set the correct date before tagging)
if (!$out && $targetVersion !== $version) {
// use today's date; local time is fine
$date = date("Y-m-d");
} else {
throw new \Exception("CHANGELOG: Date at line $a is incomplete");
}
} else {
$date = $m[2];
}
if ($entry) {
$out[] = $entry;
}
$entry = ['version' => $version, 'date' => $date, 'features' => [], 'fixes' => [], 'changes' => []];
$expected = ["separator"];
} elseif (in_array("separator", $expected) && preg_match('/^=+/', $l)) {
$length = strlen($lines[$a - 2]);
if (strlen($l) !== $length) {
throw new \Exception("CHANGELOG: Separator at line $a is of incorrect length");
}
$expected = ["blank line"];
$section = "";
} elseif (in_array("blank line", $expected) && $l === "") {
$expected = [
'' => ["features section", "fixes section", "changes section"],
'features' => ["fixes section", "changes section", "version"],
'fixes' => ["changes section", "version"],
'changes' => ["version"],
][$section];
$expected[] = "end-of-file";
} elseif (in_array("features section", $expected) && $l === "New features:") {
$section = "features";
$expected = ["item"];
} elseif (in_array("fixes section", $expected) && $l === "Bug fixes:") {
$section = "fixes";
$expected = ["item"];
} elseif (in_array("changes section", $expected) && $l === "Changes:") {
$section = "changes";
$expected = ["item"];
} elseif (in_array("item", $expected) && preg_match('/^- (\w.*)$/D', $l, $m)) {
$entry[$section][] = $m[1];
$expected = ["item", "continuation", "blank line"];
} elseif (in_array("continuation", $expected) && preg_match('/^ (\w.*)$/D', $l, $m)) {
$last = sizeof($entry[$section]) - 1;
$entry[$section][$last] .= "\n".$m[1];
} else {
if (sizeof($expected) > 1) {
throw new \Exception("CHANGELOG: Expected one of [".implode(", ", $expected)."] at line $a");
} else {
throw new \Exception("CHANGELOG: Expected ".$expected[0]." at line $a");
}
}
}
if (!in_array("end-of-file", $expected)) {
if (sizeof($expected) > 1) {
throw new \Exception("CHANGELOG: Expected one of [".implode(", ", $expected)."] at end of file");
} else {
throw new \Exception("CHANGELOG: Expected ".$expected[0]." at end of file");
}
}
$out[] = $entry;
return $out;
}
protected function changelogDebian(array $log, string $targetVersion): string {
$latest = $log[0]['version'];
$baseVersion = preg_replace('/^(\d+(?:\.\d+)*).*/', "$1", $targetVersion);
if ($baseVersion !== $targetVersion && version_compare($latest, $baseVersion, ">")) {
// if the changelog contains an entry for a future version, change its version number to match the target version instead of using the future version
$log[0]['version'] = $targetVersion;
$log[0]['distribution'] = "UNRELEASED";
} elseif ($baseVersion !== $targetVersion) {
// otherwise synthesize a changelog entry for the changes since the last tag
array_unshift($log, ['version' => $targetVersion, 'date' => date("Y-m-d"), 'features' => [], 'fixes' => [], 'changes' => ["Unspecified changes"], 'distribution' => "UNRELEASED"]);
}
$out = "";
foreach ($log as $entry) {
// normalize the version string
preg_match('/^(\d+(?:\.\d+)*)(?:-(\d+)-.+)?$/D', $entry['version'], $m);
$version = $m[1]."-".($m[2] ?: "1");
// output the entry
$out .= "arsse ($version) ".($entry['distribution'] ?? "unstable")."; urgency=low\n";
if ($entry['features']) {
$out .= "\n";
foreach ($entry['features'] as $item) {
$out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n";
}
}
if ($entry['fixes']) {
$out .= "\n";
foreach ($entry['fixes'] as $item) {
$out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n";
}
}
if ($entry['changes']) {
$out .= "\n";
foreach ($entry['changes'] as $item) {
$out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n";
}
}
$out .= "\n -- J. King <jking@jkingweb.ca> ".\DateTimeImmutable::createFromFormat("Y-m-d", $entry['date'], new \DateTimeZone("UTC"))->format("D, d M Y")." 00:00:00 +0000\n\n";
}
return $out;
}
protected function generateDebianSourceControl(string $dir, string $version, array $tarballs): string {
// read in control file
if (!$control = @file_get_contents($dir."control")) {
throw new \Exception("Unable to read Debian control file");
}
// read the format
if (!$format = @file_get_contents($dir."source/format")) {
throw new \Exception("Unable to read source format in Debian files");
}
// read the binary packages from the control file
if (preg_match_all('/^Package:\s*(\S+)/m', $control, $m)) {
$binary = [];
foreach ($m[1] as $pkg) {
$binary[] = $pkg;
}
} else {
throw new \Exception("No packages defined in Debian control file");
}
// read the package architectures from the control file
if (preg_match_all('/^Architecture:\s*(\S+)/m', $control, $m) || sizeof($m[1]) != sizeof($binary)) {
$architecture = [];
foreach ($m[1] as $pkg) {
$architecture[] = preg_replace('/\s/', "", $pkg);
}
} else {
throw new \Exception("Number of architectures defined in Debian control file does not match number of packages");
}
// read the package sections from the control file
if (preg_match_all('/^Section:\s*(\S+)/m', $control, $m) || sizeof($m[1]) != sizeof($binary)) {
$section = [];
foreach ($m[1] as $pkg) {
$section[] = $pkg;
}
} else {
throw new \Exception("Number of sections defined in Debian control file does not match number of packages");
}
// read the package priorities from the control file
if (preg_match_all('/^Priority:\s*(\S+)/m', $control, $m) || sizeof($m[1]) != sizeof($binary)) {
$priority = [];
foreach ($m[1] as $pkg) {
$priority[] = $pkg;
}
} else {
throw new \Exception("Number of priorities defined in Debian control file does not match number of packages");
}
// read simple metadata from the control file
$metadata = [];
foreach (["Source", "Maintainer", "Homepage", "Standards-Version", "Vcs-Browser", "Vcs-Git"] as $meta) {
if (preg_match('/^'.$meta.':\s*(.+)/m', $control, $m)) {
$metadata[$meta] = $m[1];
} else {
throw new \Exception("$meta is not defined in Debian control file");
}
}
// read build dependencies from control file
if (preg_match('/(?:^|\n)Build-Depends:\s*((?:[^\n]|\n(?= ))+)/s', $control, $m)) {
$buildDepends = preg_replace('/\s/', "", $m[1]);
} else {
$buildDepends = "";
}
// trim format
$format = trim($format);
// consolidate binaries and package list
$packageList = [];
for ($a = 0; $a < sizeof($binary); $a++) {
$packageList[] = "$binary[$a] deb $section[$a] $priority[$a] arch=$architecture[$a]";
}
$packageList = implode("\n ", $packageList);
// consolidate package names
$binary = implode(",", $binary);
// consolidate architectures
$architecture = implode(",", array_unique($architecture));
// calculate checksums for files
$fMeta = [];
foreach ($tarballs as $f) {
$fMeta[$f] = [
'name' => basename($f),
'size' => filesize($f),
'sha1' => hash_file("sha1", $f),
'sha256' => hash_file("sha256", $f),
'md5' => hash_file("md5", $f),
];
}
// consolidate SHA-1 checksums
$sums = [];
foreach ($fMeta as $data) {
$sums[] = $data['sha1']." ".$data['size']." ".$data['name'];
}
$sumsSha1 = implode("\n ", $sums);
// consolidate SHA-256 checksums
$sums = [];
foreach ($fMeta as $data) {
$sums[] = $data['sha256']." ".$data['size']." ".$data['name'];
}
$sumsSha256 = implode("\n ", $sums);
// consolidate MD5 checksums
$sums = [];
foreach ($fMeta as $data) {
$sums[] = $data['md5']." ".$data['size']." ".$data['name'];
}
$sumsMd5 = implode("\n ", $sums);
// return complete file
return <<< DSC_FILE
Format: $format
Source: {$metadata['Source']}
Binary: $binary
Architecture: $architecture
Version: $version
Maintainer: {$metadata['Maintainer']}
Homepage: {$metadata['Homepage']}
Standards-Version: {$metadata['Standards-Version']}
Vcs-Browser: {$metadata['Vcs-Browser']}
Vcs-Git: {$metadata['Vcs-Git']}
Build-Depends: $buildDepends
Package-List:
$packageList
Checksums-Sha1:
$sumsSha1
Checksums-Sha256:
$sumsSha256
Files:
$sumsMd5
DSC_FILE;
}
}

13
UPGRADING

@ -9,6 +9,19 @@ usually prudent:
- Check for any changes to sample systemd unit or other init files
- If installing from source, update dependencies with:
`composer install -o --no-dev`
Upgrading from 0.10.2 to 0.10.3
=============================
- PHP 7.3 is now required
Upgrading from 0.10.2 to 0.10.3
=============================
- The following Composer dependencies have been removed:
- laminas/laminas-diactoros
Upgrading from 0.8.5 to 0.9.0

5
arsse.php

@ -13,7 +13,7 @@ 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
// NOTE: While running in the wild we don't want to spew deprecation warnings if users are ahead of us in PHP versions
error_reporting(\E_ALL & ~\E_DEPRECATED);
if (\PHP_SAPI === "cli") {
@ -25,8 +25,7 @@ if (\PHP_SAPI === "cli") {
exit($exitStatus);
} else {
// load configuration
$conf = file_exists(BASE."config.php") ? new Conf(BASE."config.php") : new Conf;
Arsse::load($conf);
Arsse::bootstrap();
// handle Web requests
$emitter = new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
$response = (new REST)->dispatch();

27
composer.json

@ -22,20 +22,27 @@
"ext-intl": "*",
"ext-json": "*",
"ext-hash": "*",
"ext-filter": "*",
"ext-dom": "*",
"nicolus/picofeed": "^0.1.43",
"nicolus/picofeed": "dev-bugfix",
"hosteurope/password-generator": "1.*",
"docopt/docopt": "1.*",
"docopt/docopt": "dev-master",
"jkingweb/druuid": "3.*",
"laminas/laminas-diactoros": "2.*",
"guzzlehttp/psr7": "1.*",
"laminas/laminas-httphandlerrunner": "1.*"
},
"require-dev": {
"bamarni/composer-bin-plugin": "*"
},
"suggest": {
"ext-pcntl": "To respond to signals, particular to reload configuration via SIGHUP"
},
"config": {
"platform": {
"php": "7.1.33"
"php": "7.3.33"
},
"allow-plugins": {
"bamarni/composer-bin-plugin": true
}
},
"scripts": {
@ -52,5 +59,15 @@
"JKingWeb\\Arsse\\Test\\": "tests/lib/",
"JKingWeb\\Arsse\\TestCase\\": "tests/cases/"
}
}
},
"repositories": [
{
"type": "vcs",
"url": "https://github.com/rhukster/picoFeed"
},
{
"type": "vcs",
"url": "https://github.com/docopt/docopt.php"
}
]
}

699
composer.lock

File diff suppressed because it is too large

23
dist/apache.conf

@ -1,23 +0,0 @@
# N.B. the unix:/var/run/php/php7.2-fpm.sock path used repeatedly below will
# vary from system to system and will be probably need to be changed
<VirtualHost *:80>
ServerName localhost
# adjust according to your installation path
DocumentRoot /usr/share/arsse/www
# adjust according to your installation path
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php"
ProxyPreserveHost On
# 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, 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>
</VirtualHost>

34
dist/apache/arsse-loc.conf

@ -0,0 +1,34 @@
# Nextcloud News protocol
<Location "/index.php/apps/news/api">
ProxyPass ${ARSSE_PROXY}
</Location>
# Tiny Tiny RSS protocol
<Location "/tt-rss/api">
ProxyPass ${ARSSE_PROXY}
</Location>
# Tiny Tiny RSS feed icons
<Location "/tt-rss/feed-icons">
ProxyPass ${ARSSE_PROXY}
</Location>
# Fever protocol
<Location "/fever">
ProxyPass ${ARSSE_PROXY}
</Location>
# Miniflux protocol
<Location "/v1">
ProxyPass ${ARSSE_PROXY}
</Location>
# Miniflux version number
<Location "/version">
ProxyPass ${ARSSE_PROXY}
</Location>
# Miniflux "health check"
<Location "/healthcheck">
ProxyPass ${ARSSE_PROXY}
</Location>

11
dist/apache/arsse.conf

@ -0,0 +1,11 @@
DocumentRoot "/usr/share/arsse/www"
<Directory "/usr/share/arsse/www">
Require all granted
</Directory>
Define ARSSE_PROXY "unix:/var/run/php/arsse.sock|fcgi://localhost/usr/share/arsse/"
ProxyPreserveHost On
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php"
ProxyFCGISetEnvIf "-n req('Authorization')" HTTP_AUTHORIZATION "%{req:Authorization}"
Include "/etc/arsse/apache/arsse-loc.conf"

9
dist/apache/example.conf

@ -0,0 +1,9 @@
<VirtualHost *:443>
ServerName "news.example.com"
SSLEngine On
SSLCertificateFile "/etc/letsencrypt/live/news.example.com/fullchain.pem"
SSLCertificateKeyFile "/etc/letsencrypt/live/news.example.com/privkey.pem"
Include "/etc/arsse/apache/arsse.conf"
</VirtualHost>

57
dist/arch/PKGBUILD

@ -0,0 +1,57 @@
# Maintainer: J. King <jking@jkingweb.ca>
pkgname="arsse"
pkgver=0.10.4
pkgrel=1
epoch=
pkgdesc="Multi-protocol RSS/Atom newsfeed synchronization server"
arch=("any")
url="https://thearsse.com/"
license=("MIT")
depends=()
makedepends=()
checkdepends=()
optdepends=("nginx: HTTP server"
"apache>=2.4: HTTP server"
"percona-server: Alternate database"
"postgresql>=10: Alternate database"
"php-pgsql>=7.3: PostgreSQL database support")
backup=("etc/webapps/arsse/config.php"
"etc/php/php-fpm.d/arsse.conf"
"etc/webapps/arsse/nginx/example.conf"
"etc/webapps/arsse/nginx/arsse.conf"
"etc/webapps/arsse/nginx/arsse-loc.conf"
"etc/webapps/arsse/nginx/arsse-fcgi.conf"
"etc/webapps/arsse/apache/example.conf"
"etc/webapps/arsse/apache/arsse.conf"
"etc/webapps/arsse/apache/arsse-loc.conf")
source=("arsse-0.10.4.tar.gz")
md5sums=("SKIP")
package() {
# define runtime dependencies
depends=("php>=7.3" "php-intl>=7.3" "php-sqlite>=7.3" "php-fpm>=7.3")
# create most directories necessary for the final package
cd "$pkgdir"
mkdir -p "usr/share/webapps/arsse" "usr/share/doc/arsse" "usr/share/licenses/arsse" "usr/lib/systemd/system" "usr/lib/sysusers.d" "usr/lib/tmpfiles.d" "etc/php/php-fpm.d" "etc/webapps/arsse"
# copy requisite files
cd "$srcdir/arsse"
cp -r lib locale sql vendor www CHANGELOG UPGRADING README.md arsse.php "$pkgdir/usr/share/webapps/arsse"
cp -r manual/* "$pkgdir/usr/share/doc/arsse"
cp LICENSE AUTHORS "$pkgdir/usr/share/licenses/arsse"
cp dist/systemd/* "$pkgdir/usr/lib/systemd/system"
cp dist/sysuser.conf "$pkgdir/usr/lib/sysusers.d/arsse.conf"
cp dist/tmpfiles.conf "$pkgdir/usr/lib/tmpfiles.d/arsse.conf"
cp dist/php-fpm.conf "$pkgdir/etc/php/php-fpm.d/arsse.conf"
cp -r dist/man "$pkgdir/usr/share"
cp -r dist/nginx dist/apache config.defaults.php "$pkgdir/etc/webapps/arsse"
cd "$pkgdir"
# copy files requiring special permissions
cd "$srcdir/arsse"
install -Dm755 dist/arsse "$pkgdir/usr/bin/arsse"
install -Dm640 dist/config.php "$pkgdir/etc/webapps/arsse"
# patch generic configuration files to use Arch-specific paths and identifiers
sed -i -se 's/\/\(etc\|usr\/share\)\/arsse\//\/\1\/webapps\/arsse\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" "$pkgdir/usr/lib/systemd/system/"* "$pkgdir/usr/bin/"*
sed -i -se 's/\/var\/run\/php\//\/run\/php-fpm\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/etc/php/php-fpm.d/arsse.conf"
sed -i -se 's/www-data/http/g' "$pkgdir/etc/php/php-fpm.d/arsse.conf"
sed -i -e 's/^WorkingDirectory=.*$/WorkingDirectory=\/usr\/share\/webapps\/arsse/g' -e 's/^ConfigurationDirectory=.*$/ConfigurationDirectory=webapps\/arsse/g' "$pkgdir/usr/lib/systemd/system/arsse-fetch.service"
}

74
dist/arch/PKGBUILD-git

@ -0,0 +1,74 @@
# Maintainer: J. King <jking@jkingweb.ca>
pkgname="arsse-git"
pkgver=0.10.4
pkgrel=1
epoch=
pkgdesc="Multi-protocol RSS/Atom newsfeed synchronization server, bugfix-testing version"
arch=("any")
url="https://thearsse.com/"
license=("MIT")
provides=("arsse")
conflicts=("arsse")
depends=("php>=7.3" "php-intl>=7.3" "php-sqlite>=7.3")
makedepends=("composer" "pandoc")
checkdepends=()
optdepends=("nginx: HTTP server"
"apache>=2.4: HTTP server"
"percona-server: Alternate database"
"postgresql>=10: Alternate database"
"php-pgsql>=7.3: PostgreSQL database support")
backup=("etc/webapps/arsse/config.php"
"etc/php/php-fpm.d/arsse.conf"
"etc/webapps/arsse/nginx/example.conf"
"etc/webapps/arsse/nginx/arsse.conf"
"etc/webapps/arsse/nginx/arsse-loc.conf"
"etc/webapps/arsse/nginx/arsse-fcgi.conf"
"etc/webapps/arsse/apache/example.conf"
"etc/webapps/arsse/apache/arsse.conf"
"etc/webapps/arsse/apache/arsse-loc.conf")
source=("git+https://code.mensbeam.com/MensBeam/arsse/")
md5sums=("SKIP")
pkgver() {
cd "arsse"
git describe --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
}
build() {
cd "$srcdir/arsse"
composer install
./robo manpage
./robo manual
composer install --no-dev -o --no-scripts
php arsse.php conf save-defaults config.defaults.php
rm -r vendor/bin
}
package() {
# define runtime dependencies
depends=("php>=7.3" "php-intl>=7.3" "php-sqlite>=7.3" "php-fpm>=7.3")
# create most directories necessary for the final package
cd "$pkgdir"
mkdir -p "usr/share/webapps/arsse" "usr/share/doc/arsse" "usr/share/licenses/arsse" "usr/lib/systemd/system" "usr/lib/sysusers.d" "usr/lib/tmpfiles.d" "etc/php/php-fpm.d" "etc/webapps/arsse"
# copy requisite files
cd "$srcdir/arsse"
cp -r lib locale sql vendor www CHANGELOG UPGRADING README.md arsse.php "$pkgdir/usr/share/webapps/arsse"
cp -r manual/* "$pkgdir/usr/share/doc/arsse"
cp LICENSE AUTHORS "$pkgdir/usr/share/licenses/arsse"
cp dist/systemd/* "$pkgdir/usr/lib/systemd/system"
cp dist/sysuser.conf "$pkgdir/usr/lib/sysusers.d/arsse.conf"
cp dist/tmpfiles.conf "$pkgdir/usr/lib/tmpfiles.d/arsse.conf"
cp dist/php-fpm.conf "$pkgdir/etc/php/php-fpm.d/arsse.conf"
cp -r dist/man "$pkgdir/usr/share"
cp -r dist/nginx dist/apache config.defaults.php "$pkgdir/etc/webapps/arsse"
cd "$pkgdir"
# copy files requiring special permissions
cd "$srcdir/arsse"
install -Dm755 dist/arsse "$pkgdir/usr/bin/arsse"
install -Dm640 dist/config.php "$pkgdir/etc/webapps/arsse"
# patch generic configuration files to use Arch-specific paths and identifiers
sed -i -se 's/\/\(etc\|usr\/share\)\/arsse\//\/\1\/webapps\/arsse\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" "$pkgdir/usr/lib/systemd/system/"* "$pkgdir/usr/bin/"*
sed -i -se 's/\/var\/run\/php\//\/run\/php-fpm\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/etc/php/php-fpm.d/arsse.conf"
sed -i -se 's/www-data/http/g' "$pkgdir/etc/php/php-fpm.d/arsse.conf"
sed -i -e 's/^WorkingDirectory=.*$/WorkingDirectory=\/usr\/share\/webapps\/arsse/g' -e 's/^ConfigurationDirectory=.*$/ConfigurationDirectory=webapps\/arsse/g' "$pkgdir/usr/lib/systemd/system/arsse-fetch.service"
}

10
dist/arsse

@ -0,0 +1,10 @@
#! /usr/bin/env php
<?php
if (posix_geteuid() == 0) {
$info = posix_getpwnam("arsse");
if ($info) {
posix_setgid($info['gid']);
posix_setuid($info['uid']);
}
}
require "/usr/share/arsse/arsse.php";

15
dist/arsse.service

@ -1,15 +0,0 @@
[Unit]
Description=The Arsse feed fetching service
After=network.target mysql.service postgresql.service
[Service]
User=www-data
Group=www-data
WorkingDirectory=/usr/share/arsse
Type=simple
StandardOutput=null
StandardError=syslog
ExecStart=/usr/bin/env php /usr/share/arsse/arsse.php daemon
[Install]
WantedBy=multi-user.target

8
dist/config.php

@ -0,0 +1,8 @@
<?php
# Please refer to config.defaults.php or the manual at /usr/share/doc/arsse/
# for possible configuration parameters
return [
'dbSQLite3File' => "/var/lib/arsse/arsse.db",
];

16
dist/debian/arsse.config

@ -0,0 +1,16 @@
#!/bin/sh
set -e
. /usr/share/debconf/confmodule
# Set up dbconfig-common
if test -f /usr/share/dbconfig-common/dpkg/config; then
. /usr/share/dbconfig-common/dpkg/config
dbc_dbtypes="sqlite3, pgsql, mysql"
dbc_authmethod_user="password"
dbc_go arsse "$@"
fi
# Prompt for dbconfig-common configuration
db_go || true