chylex/Nextcloud-News
1
0
Fork 0
mirror of https://github.com/chylex/Nextcloud-News.git synced 2024-11-24 22:42:46 +01:00
Code

Compare commits

base: chylex:3fdd21b9fd74bd53470aa4f061a479bcbc5e8710
Branches Tags
chylex:master
chylex:customized
chylex:word-count-backend
..
compare: chylex:cc861ca186b24bc94bbc1835d7f6bce96d56d3d8
Branches Tags
chylex:customized
chylex:master
chylex:word-count-backend

3 Commits
3fdd21b9fd ... cc861ca186

Author SHA1 Message Date
chylex
cc861ca186
Work around compatibility issues 2024-08-02 16:12:12 +02:00
chylex
29b643168b
Unhide favicons in feed view 2024-08-02 16:09:01 +02:00
chylex
cde02ce5e2
Add article word count & limit intro length 2024-08-02 16:09:01 +02:00
449 changed files with 30070 additions and 36771 deletions
Show Stats Expand all files Collapse all files

7
.editorconfig
View File

@ -5,16 +5,11 @@ trim_trailing_whitespace = true
end_of_line = lf end_of_line = lf
insert_final_newline = true insert_final_newline = true
[*.{php,html,css}] [*.{js,php,html}]
indent_style = space indent_style = space
indent_size = 4 indent_size = 4
charset = utf-8 charset = utf-8
[*.{js,ts,vue}]
indent_style = tab
indent_size = 4
charset = utf-8
[*.bats] [*.bats]
indent_style = space indent_style = space
indent_size = 2 indent_size = 2

1
.envrc
View File

@ -1 +0,0 @@
use nix

51
.eslintrc.js
View File

@ -1,52 +1,7 @@
// SPDX-FileCopyrightText: Carl Schwan <carl@carlschwan.eu>
// SPDX-License-Identifier: AGPL-3.0-or-later
module.exports = { module.exports = {
root: true,
parser: 'vue-eslint-parser',
parserOptions: {
parser: {
ts: '@typescript-eslint/parser',
},
ecmaVersion: 2020,
},
env: {
jest: true,
},
extends: [ extends: [
'eslint:recommended',
'plugin:vue/base',
'plugin:vue/essential',
'@vue/standard',
'@vue/typescript/recommended',
'@nextcloud', '@nextcloud',
'plugin:@typescript-eslint/recommended', ]
],
ignorePatterns: ['*.d.ts', 'l10n/*.js'],
rules: {
'no-console': 'warn',
'@typescript-eslint/no-var-requires': 'off',
// TODO: Trouble importing .ts files into .vue files for some reason?
'import/extensions': 'off',
'n/no-missing-import': 'off',
},
settings: {
'import/resolver': {
node: {
extensions: ['.ts'],
},
},
},
overrides: [
{
files: ['*spec.ts', 'tests/javascript/unit/setup.ts'],
rules: {
'@typescript-eslint/no-explicit-any': 'off',
},
},
{
files: ['src/store/*.ts'],
rules: {
'function-paren-newline': ['error', 'multiline'],
},
},
],
} }

2
.github/dependabot.yml vendored
View File

@ -7,7 +7,7 @@ version: 2
updates: updates:
# Maintain dependencies for npm # Maintain dependencies for npm
- package-ecosystem: "npm" - package-ecosystem: "npm"
directory: "/" directory: "/js"
schedule: schedule:
interval: "daily" interval: "daily"
labels: labels:

14
.github/workflows/api-integration-tests.yml vendored
View File

@ -29,7 +29,7 @@ jobs:
strategy: strategy:
matrix: matrix:
php-versions: ['8.0', '8.1'] php-versions: ['8.0', '8.1']
nextcloud: ['stable27'] nextcloud: ['stable26', 'stable27']
database: ['sqlite', 'pgsql', 'mysql'] database: ['sqlite', 'pgsql', 'mysql']
experimental: [false] experimental: [false]
include: include:
@ -41,6 +41,10 @@ jobs:
nextcloud: pre-release nextcloud: pre-release
database: sqlite database: sqlite
experimental: true experimental: true
- php-versions: 8.2
nextcloud: stable26
database: sqlite
experimental: false
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
@ -53,16 +57,14 @@ jobs:
php-version: ${{ matrix.php-versions }} php-version: ${{ matrix.php-versions }}
extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip
coverage: none coverage: none
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Setup BATS & httpie - name: Setup BATS & httpie
run: sudo apt-get install -y httpie && sudo npm install -g bats@1.11.0 run: sudo apt-get install -y httpie && npm install -g bats@1.7.0
### MySQL specific setup ### MySQL specific setup
- name: Setup mysql - name: Setup mysql
if: matrix.database == 'mysql' if: matrix.database == 'mysql'
uses: getong/mariadb-action@v1.11 uses: getong/mariadb-action@v1.1
with: with:
mariadb version: '10.5' mariadb version: '10.5'
host port: ${{ env.MYSQL_PORT }} host port: ${{ env.MYSQL_PORT }}
@ -99,7 +101,7 @@ jobs:
database-password: ${{ env.POSTGRES_PASSWORD }} database-password: ${{ env.POSTGRES_PASSWORD }}
- name: Prime app build - name: Prime app build
run: make composer run: make
- name: Configure server with app - name: Configure server with app
uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@main uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@main

4
.github/workflows/api-php-static-code-check.yml vendored
View File

@ -25,8 +25,6 @@ jobs:
php-version: ${{ matrix.php-versions }} php-version: ${{ matrix.php-versions }}
extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip
coverage: none coverage: none
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Set up server non MySQL - name: Set up server non MySQL
uses: SMillerDev/nextcloud-actions/setup-nextcloud@main uses: SMillerDev/nextcloud-actions/setup-nextcloud@main
@ -36,7 +34,7 @@ jobs:
database-type: ${{ matrix.database }} database-type: ${{ matrix.database }}
- name: Build app - name: Build app
run: make composer run: make
- name: Configure server with app - name: Configure server with app
uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@main uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@main

4
.github/workflows/api-php-tests.yml vendored
View File

@ -10,7 +10,7 @@ jobs:
strategy: strategy:
matrix: matrix:
php-versions: ['8.1'] php-versions: ['8.1']
nextcloud: ['stable27'] nextcloud: ['stable26', 'stable27']
database: ['sqlite'] database: ['sqlite']
experimental: [false] experimental: [false]
codecoverage: [false] codecoverage: [false]
@ -32,8 +32,6 @@ jobs:
php-version: ${{ matrix.php-versions }} php-version: ${{ matrix.php-versions }}
extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip
coverage: pcov coverage: pcov
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
### Back to normal setup ### Back to normal setup
- name: Set up server non MySQL - name: Set up server non MySQL

8
.github/workflows/build-release.yml vendored
View File

@ -22,14 +22,14 @@ jobs:
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup PHP - name: Setup PHP
uses: shivammathur/setup-php@7fdd3ece872ec7ec4c098ae5ab7637d5e0a96067 #2.26.0 uses: shivammathur/setup-php@afefcaf556d98dc7896cca380e181decb609ca44
with: with:
php-version: ${{ matrix.php-versions }} php-version: ${{ matrix.php-versions }}
extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip extensions: pdo_sqlite,pdo_mysql,pdo_pgsql,gd,zip
coverage: none coverage: none
- name: Set up server non MySQL - name: Set up server non MySQL
uses: SMillerDev/nextcloud-actions/setup-nextcloud@1e38cb369e2193642279c64ee140fc93ddd4fa77 uses: SMillerDev/nextcloud-actions/setup-nextcloud@main
with: with:
cron: false cron: false
version: ${{ matrix.nextcloud }} version: ${{ matrix.nextcloud }}
@ -39,7 +39,7 @@ jobs:
run: make run: make
- name: Configure server with app - name: Configure server with app
uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@1e38cb369e2193642279c64ee140fc93ddd4fa77 uses: SMillerDev/nextcloud-actions/setup-nextcloud-app@main
with: with:
app: ${{ env.APP_NAME }} app: ${{ env.APP_NAME }}
check-code: false check-code: false
@ -52,7 +52,7 @@ jobs:
app_public_crt: ${{ secrets.APP_PUBLIC_CRT }} app_public_crt: ${{ secrets.APP_PUBLIC_CRT }}
- name: Upload app tarball to release - name: Upload app tarball to release
uses: svenstaro/upload-release-action@04733e069f2d7f7f0b4aebc4fbdbce8613b03ccd uses: svenstaro/upload-release-action@1beeb572c19a9242f4361f4cee78f8e0d9aec5df
id: attach_to_release id: attach_to_release
with: with:
repo_token: ${{ secrets.GITHUB_TOKEN }} repo_token: ${{ secrets.GITHUB_TOKEN }}

2
.github/workflows/frontend-nodejs-tests.yml vendored
View File

@ -4,7 +4,7 @@ on:
jobs: jobs:
php: php:
runs-on: ubuntu-latest runs-on: ubuntu-20.04
continue-on-error: ${{ matrix.experimental }} continue-on-error: ${{ matrix.experimental }}
name: "Frontend: Nextcloud ${{ matrix.nextcloud }} - PHP ${{ matrix.php-versions }} - DB ${{ matrix.database }}" name: "Frontend: Nextcloud ${{ matrix.nextcloud }} - PHP ${{ matrix.php-versions }} - DB ${{ matrix.database }}"
strategy: strategy:

4
.github/workflows/lint-eslint.yml vendored
View File

@ -25,14 +25,14 @@ jobs:
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Read package.json node and npm engines version - name: Read package.json node and npm engines version
uses: skjnldsv/read-package-engines-version-actions@v3 uses: skjnldsv/read-package-engines-version-actions@v2.2
id: versions id: versions
with: with:
fallbackNode: '^16' fallbackNode: '^16'
fallbackNpm: '^6' fallbackNpm: '^6'
- name: Set up node ${{ steps.versions.outputs.nodeVersion }} - name: Set up node ${{ steps.versions.outputs.nodeVersion }}
uses: actions/setup-node@v4 uses: actions/setup-node@v3
with: with:
node-version: ${{ steps.versions.outputs.nodeVersion }} node-version: ${{ steps.versions.outputs.nodeVersion }}

52
.github/workflows/lint.yml vendored
View File

@ -1,52 +0,0 @@
name: Lint
on:
pull_request:
push:
branches:
- master
jobs:
eslint:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [16.x]
name: eslint node${{ matrix.node-versions }}
steps:
- uses: actions/checkout@v4
- name: Set up node ${{ matrix.node-versions }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-versions }}
- name: Install dependencies
run: npm ci
- name: Lint
run: npm run lint
stylelint:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [16.x]
name: stylelint node${{ matrix.node-versions }}
steps:
- uses: actions/checkout@v4
- name: Set up node ${{ matrix.node-versions }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-versions }}
- name: Install dependencies
run: npm ci
- name: Lint
run: npm run stylelint

2
.github/workflows/updater-test.yml vendored
View File

@ -34,7 +34,7 @@ jobs:
coverage: none coverage: none
- name: Setup BATS & httpie - name: Setup BATS & httpie
run: sudo apt-get install -y httpie && sudo npm install -g bats@1.11.0 run: sudo apt-get install -y httpie && npm install -g bats@1.7.0
- name: Set up server - name: Set up server
uses: SMillerDev/nextcloud-actions/setup-nextcloud@main uses: SMillerDev/nextcloud-actions/setup-nextcloud@main

14
.gitignore vendored
View File

@ -2,20 +2,15 @@
composer.phar composer.phar
node_modules/ node_modules/
vendor/ vendor/
js/build
*.log *.log
/build/ /build/
js/ /js/coverage/
js/*.xml
.rvm .rvm
*.clover *.clover
.phpunit.result.cache .phpunit.result.cache
site/ site/
coverage
#bats
tests/api/helpers/settings-override.bash
tests/test_helper/feeds/test.xml
tests/test_helper/feeds/feed1.xml
tests/test_helper/feeds/feed2.xml
#bats #bats
tests/api/helpers/settings-override.bash tests/api/helpers/settings-override.bash
@ -60,9 +55,6 @@ RCS/*
# netbeans # netbeans
nbproject nbproject
# vscode
.vscode
# phpStorm # phpStorm
.idea .idea

2
.stylelintignore
View File

@ -1,2 +0,0 @@
vendor/
coverage/

18
AUTHORS.md
View File

@ -3,14 +3,13 @@
* [Benjamin Brahmer](mailto:info@b-brahmer.de) * [Benjamin Brahmer](mailto:info@b-brahmer.de)
* [Alessandro Cosentino](mailto:cosenal@gmail.com) * [Alessandro Cosentino](mailto:cosenal@gmail.com)
* [Marco Nassabain](mailto:marco.nassabain@hotmail.com) * [Marco Nassabain](mailto:marco.nassabain@hotmail.com)
* [Devlin Junker](mailto:devlin.junker@gmail.com)
* [Robin Appelman](mailto:icewind@owncloud.com) * [Robin Appelman](mailto:icewind@owncloud.com)
* [Sean Molenaar](mailto:sean@seanmolenaar.eu) * [Sean Molenaar](mailto:sean@seanmolenaar.eu)
* [Paul Tirk](mailto:paultirk@paultirk.com)
* [Gregor Tätzner](mailto:gregor@freenet.de) * [Gregor Tätzner](mailto:gregor@freenet.de)
* [Sean Molenaar](mailto:SMillerDev@users.noreply.github.com) * [Sean Molenaar](mailto:SMillerDev@users.noreply.github.com)
* [anoy](mailto:anoymouserver+github@mailbox.org) * [anoy](mailto:anoymouserver+github@mailbox.org)
* [Morris Jobke](mailto:hey@morrisjobke.de) * [Morris Jobke](mailto:hey@morrisjobke.de)
* [Paul Tirk](mailto:paultirk@paultirk.com)
* [Jimmy Huynh](mailto:jimmy.huynh@etu.unistra.fr) * [Jimmy Huynh](mailto:jimmy.huynh@etu.unistra.fr)
* [Aurélien](mailto:dav.aurelien@gmail.com) * [Aurélien](mailto:dav.aurelien@gmail.com)
* [Jan-Christoph Borchardt](mailto:hey@jancborchardt.net) * [Jan-Christoph Borchardt](mailto:hey@jancborchardt.net)
@ -22,7 +21,6 @@
* [Bernhard Posselt](mailto:bep@foryouandyourcustomers.com) * [Bernhard Posselt](mailto:bep@foryouandyourcustomers.com)
* [Thomas Müller](mailto:thomas.mueller@tmit.eu) * [Thomas Müller](mailto:thomas.mueller@tmit.eu)
* [Hoàng Đức Hiếu](mailto:hdhoang@zahe.me) * [Hoàng Đức Hiếu](mailto:hdhoang@zahe.me)
* [IgorA100](mailto:igora100@gmail.com)
* [Marco Nassabain](mailto:marco.nassabain@etu.unistra.fr) * [Marco Nassabain](mailto:marco.nassabain@etu.unistra.fr)
* [rakekniven](mailto:mark.ziegler@rakekniven.de) * [rakekniven](mailto:mark.ziegler@rakekniven.de)
* [Daniel Opitz](mailto:git@copynpaste.de) * [Daniel Opitz](mailto:git@copynpaste.de)
@ -39,9 +37,6 @@
* [Thomas Tanghus](mailto:thomas@tanghus.net) * [Thomas Tanghus](mailto:thomas@tanghus.net)
* [Volkan Gezer](mailto:volkangezer@gmail.com) * [Volkan Gezer](mailto:volkangezer@gmail.com)
* [Xéfir Destiny](mailto:xefir@crystalyx.net) * [Xéfir Destiny](mailto:xefir@crystalyx.net)
* [devlinjunker](mailto:devlin.junker@gmail.com)
* [hydrian](mailto:ben.tyger@tygerclan.net)
* [mortee](mailto:mortee@kavemalna.hu)
* [Daniel Opitz](mailto:danopz@users.noreply.github.com) * [Daniel Opitz](mailto:danopz@users.noreply.github.com)
* [Daniel Rheinbay](mailto:danielrheinbay@gmail.com) * [Daniel Rheinbay](mailto:danielrheinbay@gmail.com)
* [Lars Bensmann](mailto:lars@almosthappy.de) * [Lars Bensmann](mailto:lars@almosthappy.de)
@ -69,18 +64,15 @@
* [Igor Bubelov](mailto:igor@bubelov.com) * [Igor Bubelov](mailto:igor@bubelov.com)
* [Jan C. Borchardt](mailto:hey@jancborchardt.net) * [Jan C. Borchardt](mailto:hey@jancborchardt.net)
* [Jimmy Huynh](mailto:linkatox@gmail.com) * [Jimmy Huynh](mailto:linkatox@gmail.com)
* [Joas Schilling](mailto:213943+nickvergessen@users.noreply.github.com)
* [John Kristensen](mailto:john@jerrykan.com) * [John Kristensen](mailto:john@jerrykan.com)
* [Keunes](mailto:11229646+keunes@users.noreply.github.com) * [Keunes](mailto:11229646+keunes@users.noreply.github.com)
* [Konrad Graefe](mailto:konradgraefe@aol.com) * [Konrad Graefe](mailto:konradgraefe@aol.com)
* [Loki3000](mailto:github@labcms.ru) * [Loki3000](mailto:github@labcms.ru)
* [Maik Kulbe](mailto:info@linux-web-development.de) * [Maik Kulbe](mailto:info@linux-web-development.de)
* [Manuel Sailer](mailto:github.com@manuel-sailer.de) * [Manuel Sailer](mailto:github.com@manuel-sailer.de)
* [Martin Vuille](mailto:jpmv27@yahoo.com)
* [Michael Gapczynski](mailto:mtgap@owncloud.com) * [Michael Gapczynski](mailto:mtgap@owncloud.com)
* [Nikita Chernyi](mailto:rakshazi@users.noreply.github.com) * [Nikita Chernyi](mailto:rakshazi@users.noreply.github.com)
* [Peter Hedlund](mailto:peter@peterandlinda.com) * [Peter Hedlund](mailto:peter@peterandlinda.com)
* [Petra Mirelli](mailto:80395360+iNtEgraIR2021@users.noreply.github.com)
* [Simon Spannagel](mailto:simonspa@kth.se) * [Simon Spannagel](mailto:simonspa@kth.se)
* [bbBowser](mailto:carspi@mail.de) * [bbBowser](mailto:carspi@mail.de)
* [benediktb](mailto:benedikt@blablub.de) * [benediktb](mailto:benedikt@blablub.de)
@ -88,7 +80,6 @@
* [davidak](mailto:git@davidak.de) * [davidak](mailto:git@davidak.de)
* [hooger](mailto:horvathg.1988@gmail.com) * [hooger](mailto:horvathg.1988@gmail.com)
* [lsmooth](mailto:ls@lsmooth.de) * [lsmooth](mailto:ls@lsmooth.de)
* [mortee](mailto:mortee.github@kavemalna.hu)
* [s17t.net](mailto:mail+github@s17t.net) * [s17t.net](mailto:mail+github@s17t.net)
* [Accalia](mailto:Accalia@Elementia.me) * [Accalia](mailto:Accalia@Elementia.me)
* [Accalia Elementia](mailto:accalia@elementia.me) * [Accalia Elementia](mailto:accalia@elementia.me)
@ -113,7 +104,6 @@
* [Chris Aumann](mailto:me@chr4.org) * [Chris Aumann](mailto:me@chr4.org)
* [Chris Danser](mailto:skiingwiz@gmail.com) * [Chris Danser](mailto:skiingwiz@gmail.com)
* [Chris Noxz](mailto:chris@noxz.tech) * [Chris Noxz](mailto:chris@noxz.tech)
* [Christof Dorner](mailto:christof@chdorner.com)
* [Christoph Wurst](mailto:ChristophWurst@users.noreply.github.com) * [Christoph Wurst](mailto:ChristophWurst@users.noreply.github.com)
* [Clemens](mailto:clemens@clemensknost.de) * [Clemens](mailto:clemens@clemensknost.de)
* [Colin W](mailto:cwmke@users.noreply.github.com) * [Colin W](mailto:cwmke@users.noreply.github.com)
@ -137,18 +127,14 @@
* [Freddo](mailto:f.falk@protonmail.com) * [Freddo](mailto:f.falk@protonmail.com)
* [Freddo3000](mailto:f.falk@protonmail.com) * [Freddo3000](mailto:f.falk@protonmail.com)
* [Greg](mailto:greg@toolstack.com) * [Greg](mailto:greg@toolstack.com)
* [HK2FB](mailto:tom.schmidt@helsana.ch)
* [Hagen](mailto:derhagen@users.noreply.github.com) * [Hagen](mailto:derhagen@users.noreply.github.com)
* [Hanzei](mailto:Hanzei@users.noreply.github.com) * [Hanzei](mailto:Hanzei@users.noreply.github.com)
* [Hendrik Leppelsack](mailto:hendrik@leppelsack.de) * [Hendrik Leppelsack](mailto:hendrik@leppelsack.de)
* [Jasper Knockaert](mailto:jasper@knockaert.nl) * [Jasper Knockaert](mailto:jasper@knockaert.nl)
* [Jimmy Boucher](mailto:75694650+jboucher614@users.noreply.github.com)
* [Josh](mailto:josh.t.richards@gmail.com)
* [Kevin Decherf](mailto:kevin@kdecherf.com) * [Kevin Decherf](mailto:kevin@kdecherf.com)
* [Kuba Orlik](mailto:kontakt@kuba-orlik.name) * [Kuba Orlik](mailto:kontakt@kuba-orlik.name)
* [Maceček Richard](mailto:46937538+macecekrichard@users.noreply.github.com) * [Maceček Richard](mailto:46937538+macecekrichard@users.noreply.github.com)
* [Marc Cousin](mailto:marc.cousin@people-doc.com) * [Marc Cousin](mailto:marc.cousin@people-doc.com)
* [Marcus Nitzschke](mailto:mail@kendix.org)
* [Martin Ferretti](mailto:ferrettimartin@protonmail.com) * [Martin Ferretti](mailto:ferrettimartin@protonmail.com)
* [Matthias](mailto:matthias.baier@mabaart.de) * [Matthias](mailto:matthias.baier@mabaart.de)
* [Matthias Blümel](mailto:user@inanna.local) * [Matthias Blümel](mailto:user@inanna.local)
@ -156,7 +142,6 @@
* [Michael Grosser](mailto:github@stp-ip.net) * [Michael Grosser](mailto:github@stp-ip.net)
* [Michael Hamann](mailto:michael@content-space.de) * [Michael Hamann](mailto:michael@content-space.de)
* [Michael Holley](mailto:michaelwholley@gmail.com) * [Michael Holley](mailto:michaelwholley@gmail.com)
* [Mynacol](mailto:Mynacol@users.noreply.github.com)
* [NanoSector](mailto:rick@nanosector.nl) * [NanoSector](mailto:rick@nanosector.nl)
* [Nick Frey](mailto:nickfrey123@gmail.com) * [Nick Frey](mailto:nickfrey123@gmail.com)
* [Oliver Herst](mailto:oliver.herst@googlemail.com) * [Oliver Herst](mailto:oliver.herst@googlemail.com)
@ -203,7 +188,6 @@
* [markusj](mailto:markusj@users.noreply.github.com) * [markusj](mailto:markusj@users.noreply.github.com)
* [mnassabain](mailto:34754819+mnassabain@users.noreply.github.com) * [mnassabain](mailto:34754819+mnassabain@users.noreply.github.com)
* [mormegil](mailto:mormegil@centrum.cz) * [mormegil](mailto:mormegil@centrum.cz)
* [nextcloud-command](mailto:nextcloud-command@users.noreply.github.com)
* [nextcloud486153](mailto:78801830+nextcloud486153@users.noreply.github.com) * [nextcloud486153](mailto:78801830+nextcloud486153@users.noreply.github.com)
* [nexus-uw](mailto:you@example.com) * [nexus-uw](mailto:you@example.com)
* [repat](mailto:repat@repat.de) * [repat](mailto:repat@repat.de)

69
CHANGELOG.md
View File

@ -2,80 +2,13 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is mostly based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), older entries don't fully match. The format is mostly based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), older entries don't fully match.
You can also check [on GitHub](https://github.com/nextcloud/news/releases), the release notes there are generated automatically and include every pull request.
# Unreleased # Unreleased
## [25.x.x] ## [24.x.x]
### Changed ### Changed
### Fixed ### Fixed
# Releases # Releases
## [25.0.0-alpha8] - 2024-07-07
### Changed
- Add support for moving feeds to another folder from the sidebar feed menu (#2707)
- Persist the filter state and show unread items by default (#2704)
### Fixed
- Fix undefined item when using `j` and `k` keyboards shortcuts in an empty feed (#2689)
## [25.0.0-alpha7] - 2024-06-10
### Changed
- added alternative development environment (#2670)
- Implement `j` and `k` keyboards shortcuts for navigating through feed items (#2671)
- Implement `s`, `i` and `l` keyboards shortcuts for staring current feed item (#2677)
- Implement `o` keyboards shortcut for opening the URL of current feed item (#2677)
- Implement `u` keyboards shortcut for marking current feed item read/unread (#2677)
- Implement highlighting of active feed item (#2677)
# Releases
## [25.0.0-alpha6] - 2024-05-07
### Changed
- Improve layout of feed item row (#2569)
### Fixed
- Reset content scroll position when feed item is changed (#2569)
- Fix link to feed in article header (#2569)
## [25.0.0-alpha5] - 2024-04-01
### Changed
- make occ news:updater:job exit with code 2 if last update was too long ago (#2590)
- Fix deprecated variable reference in ExportController.php (#2602)
- Add support for Nextcloud 29 (#2611)
## [25.0.0-alpha4] - 2023-01-25
### Changed
- Add DB index for news_feeds.deleted_at (#2526)
### Fixed
- PostgreSQL implement fix for marking over 65535 unread items as "read" (#2557)
## [25.0.0-alpha3] - 2023-12-24
### Changed
- Changed default page when starting app (#2515)
- Downgrade feed-io to 5.3.1 (#2497)
### Fixed
- Fix search support for Nextcloud 28 (#2432)
## [25.0.0-alpha2] - 2023-11-08
### Changed
- Add support for Nextcloud 28
- Use Nextcloud vue components for item list and article view (#2401)
- Fix aspect ratio of article images (#2401)
### Fixed
- Adjust search urls to match changed Vue routes (#2408)
## [25.0.0-alpha1] - 2023-10-24
### Changed
- Major Rewrite of the Frontend with Vue JS (#748)
For comments and suggestions for the new UI, please use this: https://github.com/nextcloud/news/discussions/2388
- Set User Agent for curl in Scraper (#2380)
- Drop support for Nextcloud 26, Supported 27
## [24.0.0] - 2023-09-26 ## [24.0.0] - 2023-09-26
No major changes compared to 24.0.0-beta1. No major changes compared to 24.0.0-beta1.

84
Makefile
View File

@ -52,7 +52,7 @@ cert_dir=$(HOME)/.nextcloud/certificates
npm:=$(shell which npm 2> /dev/null) npm:=$(shell which npm 2> /dev/null)
composer:=$(shell which composer 2> /dev/null) composer:=$(shell which composer 2> /dev/null)
ifeq (,$(composer)) ifeq (,$(composer))
composer:=php "$(build_tools_directory)/composer.phar" composer:=php $(build_tools_directory)/composer.phar
endif endif
#Support xDebug 3.0+ #Support xDebug 3.0+
@ -74,26 +74,28 @@ build:
composer: composer:
ifeq (, $(shell which composer 2> /dev/null)) ifeq (, $(shell which composer 2> /dev/null))
@echo "No composer command available, downloading a copy from the web" @echo "No composer command available, downloading a copy from the web"
mkdir -p "$(build_tools_directory)" mkdir -p $(build_tools_directory)
curl -sS https://getcomposer.org/installer | php curl -sS https://getcomposer.org/installer | php
mv composer.phar "$(build_tools_directory)" mv composer.phar $(build_tools_directory)
endif endif
$(composer) install --prefer-dist --no-dev $(composer) install --prefer-dist --no-dev
# Installs npm dependencies # Installs npm dependencies
.PHONY: npm .PHONY: npm
npm: npm:
ifneq (, $(npm)) $(npm) ci
$(npm) run build $(npm) run build
ifneq (, $(npm))
cd js && $(npm) run build
else else
@echo "npm command not available, please install nodejs first" @echo "npm command not available, please install nodejs first"
@exit 1 @exit 1
endif endif
# Removes the appstore build and compiled js files # Removes the appstore build
.PHONY: clean .PHONY: clean
clean: clean:
rm -rf ./build ./js/* rm -rf ./build
# Reports PHP codestyle violations # Reports PHP codestyle violations
.PHONY: phpcs .PHONY: phpcs
@ -124,9 +126,9 @@ dist:
# Builds the source package # Builds the source package
.PHONY: source .PHONY: source
source: source:
rm -rf "$(source_build_directory)" "$(source_artifact_directory)" rm -rf $(source_build_directory) $(source_artifact_directory)
mkdir -p "$(source_build_directory)" "$(source_artifact_directory)" mkdir -p $(source_build_directory) $(source_artifact_directory)
rsync -rv . "$(source_build_directory)" \ rsync -rv . $(source_build_directory) \
--exclude=/.git/ \ --exclude=/.git/ \
--exclude=/.idea/ \ --exclude=/.idea/ \
--exclude=/build/ \ --exclude=/build/ \
@ -137,13 +139,13 @@ ifdef CAN_SIGN
else else
@echo $(sign_skip_msg) @echo $(sign_skip_msg)
endif endif
tar -cvzf "$(source_package_name).tar.gz" -C "$(source_build_directory)/../" $(app_name) tar -cvzf $(source_package_name).tar.gz -C $(source_build_directory)/../ $(app_name)
# Builds the source package for the app store, ignores php and js tests # Builds the source package for the app store, ignores php and js tests
.PHONY: appstore .PHONY: appstore
appstore: appstore:
rm -rf "$(appstore_build_directory)" "$(appstore_sign_dir)" "$(appstore_artifact_directory)" rm -rf $(appstore_build_directory) $(appstore_sign_dir) $(appstore_artifact_directory)
install -d "$(appstore_sign_dir)/$(app_name)" install -d $(appstore_sign_dir)/$(app_name)
cp -r \ cp -r \
"appinfo" \ "appinfo" \
"css" \ "css" \
@ -152,49 +154,50 @@ appstore:
"lib" \ "lib" \
"templates" \ "templates" \
"vendor" \ "vendor" \
"$(appstore_sign_dir)/$(app_name)" $(appstore_sign_dir)/$(app_name)
# remove composer binaries, those aren't needed # remove composer binaries, those aren't needed
rm -rf "$(appstore_sign_dir)/$(app_name)/vendor/bin" rm -rf $(appstore_sign_dir)/$(app_name)/vendor/bin
# the App Store doesn't like .git # the App Store doesn't like .git
rm -rf "$(appstore_sign_dir)/$(app_name)/vendor/arthurhoaro/favicon/.git" rm -rf $(appstore_sign_dir)/$(app_name)/vendor/arthurhoaro/favicon/.git
# remove large test files # remove large test files
rm -rf "$(appstore_sign_dir)/$(app_name)/vendor/fivefilters/readability.php/test" rm -rf $(appstore_sign_dir)/$(app_name)/vendor/fivefilters/readability.php/test
install "COPYING" "$(appstore_sign_dir)/$(app_name)" install "COPYING" $(appstore_sign_dir)/$(app_name)
install "AUTHORS.md" "$(appstore_sign_dir)/$(app_name)" install "AUTHORS.md" $(appstore_sign_dir)/$(app_name)
install "CHANGELOG.md" "$(appstore_sign_dir)/$(app_name)" install "CHANGELOG.md" $(appstore_sign_dir)/$(app_name)
#remove stray .htaccess files since they are filtered by nextcloud #remove stray .htaccess files since they are filtered by nextcloud
find "$(appstore_sign_dir)" -name .htaccess -exec rm {} \; find $(appstore_sign_dir) -name .htaccess -exec rm {} \;
# on macOS there is no option "--parents" for the "cp" command # on macOS there is no option "--parents" for the "cp" command
mkdir -p "$(appstore_sign_dir)/$(app_name)/js" mkdir -p $(appstore_sign_dir)/$(app_name)/js/build $(appstore_sign_dir)/$(app_name)/js/admin
cp js/* "$(appstore_sign_dir)/$(app_name)/js/" cp js/build/app.min.js $(appstore_sign_dir)/$(app_name)/js/build
cp js/build/news-admin-settings.js* $(appstore_sign_dir)/$(app_name)/js/build
# export the key and cert to a file # export the key and cert to a file
@if [ ! -f "$(cert_dir)/$(app_name).key" ] || [ ! -f "$(cert_dir)/$(app_name).crt" ]; then \ @if [ ! -f $(cert_dir)/$(app_name).key ] || [ ! -f $(cert_dir)/$(app_name).crt ]; then \
echo "Key and cert do not exist"; \ echo "Key and cert do not exist"; \
mkdir -p "$(cert_dir)"; \ mkdir -p $(cert_dir); \
php ./bin/tools/file_from_env.php "app_private_key" "$(cert_dir)/$(app_name).key"; \ php ./bin/tools/file_from_env.php "app_private_key" "$(cert_dir)/$(app_name).key"; \
php ./bin/tools/file_from_env.php "app_public_crt" "$(cert_dir)/$(app_name).crt"; \ php ./bin/tools/file_from_env.php "app_public_crt" "$(cert_dir)/$(app_name).crt"; \
fi fi
@if [ -f "$(cert_dir)/$(app_name).key" ]; then \ @if [ -f $(cert_dir)/$(app_name).key ]; then \
echo "Signing app files…"; \ echo "Signing app files…"; \
php ../../occ integrity:sign-app \ php ../../occ integrity:sign-app \
--privateKey="$(cert_dir)/$(app_name).key"\ --privateKey=$(cert_dir)/$(app_name).key\
--certificate="$(cert_dir)/$(app_name).crt"\ --certificate=$(cert_dir)/$(app_name).crt\
--path="$(appstore_sign_dir)/$(app_name)"; \ --path=$(appstore_sign_dir)/$(app_name); \
echo "Signing app files ... done"; \ echo "Signing app files ... done"; \
fi fi
mkdir -p "$(appstore_artifact_directory)" mkdir -p $(appstore_artifact_directory)
tar -czf "$(appstore_package_name).tar.gz" -C "$(appstore_sign_dir)" $(app_name) tar -czf $(appstore_package_name).tar.gz -C $(appstore_sign_dir) $(app_name)
.PHONY: js-test .PHONY: js-test
js-test: js-test:
$(npm) run test cd js && $(npm) run test
.PHONY: php-test-dependencies .PHONY: php-test-dependencies
php-test-dependencies: php-test-dependencies:
@ -202,7 +205,12 @@ php-test-dependencies:
.PHONY: unit-test .PHONY: unit-test
unit-test: unit-test:
./vendor/phpunit/phpunit/phpunit -c phpunit.xml --coverage-clover build/php-unit.clover @if [ "$(CODECOVERAGE)" = "true" ]; then \
./vendor/phpunit/phpunit/phpunit -c phpunit.xml --coverage-clover build/php-unit.clover; \
else \
./vendor/phpunit/phpunit/phpunit -c phpunit.xml --no-coverage; \
fi
# Command for running JS and PHP tests. Works for package.json files in the js/ # Command for running JS and PHP tests. Works for package.json files in the js/
# and root directory. If phpunit is not installed systemwide, a copy is fetched # and root directory. If phpunit is not installed systemwide, a copy is fetched
@ -221,16 +229,8 @@ feed-test:
.PHONY: feed-server .PHONY: feed-server
feed-server: feed-server:
php -S 127.0.0.1:8090 -t "$(CURDIR)/tests/test_helper/feeds" php -S 127.0.0.1:8090 -t $(CURDIR)/tests/test_helper/feeds
.PHONY: nextcloud-server .PHONY: nextcloud-server
nextcloud-server: nextcloud-server:
php -S 127.0.0.1:8080 -t "$(CURDIR)/../../." php -S 127.0.0.1:8080 -t $(CURDIR)/../../.
.PHONY: term
term:
zellij --layout term.kdl attach nextcloud-news -cf
.PHONY: term-kill
term-kill:
zellij delete-session nextcloud-news -f

3
README.md
View File

@ -1,4 +1,7 @@
# Nextcloud News app # Nextcloud News app
**We need help with the frontend, check the issue tracker if you are interested!**
![Release status](https://github.com/nextcloud/news/workflows/Build%20and%20publish%20app%20release/badge.svg) ![Integration Tests](https://github.com/nextcloud/news/workflows/Integration%20Tests/badge.svg) ![Frontend tests](https://github.com/nextcloud/news/workflows/Frontend%20tests/badge.svg) [![Code coverage](https://img.shields.io/codecov/c/github/nextcloud/news.svg?style=flat)](https://codecov.io/gh/nextcloud/news/) ![Release status](https://github.com/nextcloud/news/workflows/Build%20and%20publish%20app%20release/badge.svg) ![Integration Tests](https://github.com/nextcloud/news/workflows/Integration%20Tests/badge.svg) ![Frontend tests](https://github.com/nextcloud/news/workflows/Frontend%20tests/badge.svg) [![Code coverage](https://img.shields.io/codecov/c/github/nextcloud/news.svg?style=flat)](https://codecov.io/gh/nextcloud/news/)
The News app is an RSS/Atom feed aggregator. It offers a [RESTful API](https://nextcloud.github.io/news/developer/#apis) for app developers. The source code is [available on GitHub](https://github.com/nextcloud/news) The News app is an RSS/Atom feed aggregator. It offers a [RESTful API](https://nextcloud.github.io/news/developer/#apis) for app developers. The source code is [available on GitHub](https://github.com/nextcloud/news)

4
appinfo/info.xml
View File

@ -21,7 +21,7 @@ Create a [feature request](https://github.com/nextcloud/news/discussions/new)
Report a [feed issue](https://github.com/nextcloud/news/discussions/new) Report a [feed issue](https://github.com/nextcloud/news/discussions/new)
]]></description> ]]></description>
<version>25.0.0-alpha8</version> <version>24.0.0</version>
<licence>agpl</licence> <licence>agpl</licence>
<author>Benjamin Brahmer</author> <author>Benjamin Brahmer</author>
<author>Sean Molenaar</author> <author>Sean Molenaar</author>
@ -55,7 +55,7 @@ Report a [feed issue](https://github.com/nextcloud/news/discussions/new)
<lib>json</lib> <lib>json</lib>
<owncloud max-version="0" min-version="0"/> <owncloud max-version="0" min-version="0"/>
<nextcloud min-version="27" max-version="29"/> <nextcloud min-version="26" max-version="27"/>
</dependencies> </dependencies>
<background-jobs> <background-jobs>

11
babel.config.js
View File

@ -1,6 +1,5 @@
module.exports = { // SPDX-FileCopyrightText: Carl Schwan <carl@carlschwan.eu>
plugins: [ // SPDX-License-Identifier: AGPL-3.0-or-later
'@babel/plugin-syntax-dynamic-import', const babelConfig = require('@nextcloud/babel-config')
],
presets: ['@babel/preset-env', '@babel/preset-typescript'], module.exports = babelConfig
}

18
composer.json
View File

@ -41,11 +41,11 @@
}, },
"require": { "require": {
"php": "~8.0", "php": "~8.0",
"ezyang/htmlpurifier": "^4.17.0", "ezyang/htmlpurifier": "^4.16.0",
"pear/net_url2": "^2.2.2", "pear/net_url2": "^2.2.2",
"riimu/kit-pathjoin": "^1.2.0", "riimu/kit-pathjoin": "^1.2.0",
"debril/feed-io": "v5.3.1", "debril/feed-io": "^v5.3.1",
"arthurhoaro/favicon": "^2.0.0", "arthurhoaro/favicon": "^1.3.3",
"fivefilters/readability.php": "^3.1", "fivefilters/readability.php": "^3.1",
"ext-json": "*", "ext-json": "*",
"ext-simplexml": "*", "ext-simplexml": "*",
@ -55,15 +55,15 @@
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "9.6.*", "phpunit/phpunit": "9.6.*",
"squizlabs/php_codesniffer": "^3.9.2", "squizlabs/php_codesniffer": "^3.7.2",
"phpstan/phpstan": "^1.10.60", "phpstan/phpstan": "^1.10.35",
"phpstan/phpstan-doctrine": "^1.4.3", "phpstan/phpstan-doctrine": "^1.3.43",
"phpstan/phpstan-strict-rules": "^1.5.2", "phpstan/phpstan-strict-rules": "^1.5.1",
"phpstan/phpstan-phpunit": "^1.3.16", "phpstan/phpstan-phpunit": "^1.3.14",
"phpstan/extension-installer": "^1.3.1", "phpstan/extension-installer": "^1.3.1",
"phpstan/phpstan-deprecation-rules": "^1.1", "phpstan/phpstan-deprecation-rules": "^1.1",
"guzzlehttp/guzzle": "^7.3.0", "guzzlehttp/guzzle": "^7.3.0",
"doctrine/dbal": "^3.8.0", "doctrine/dbal": "^3.7.0",
"symfony/console": "^4.4.19", "symfony/console": "^4.4.19",
"psr/log": "^1.1.0" "psr/log": "^1.1.0"
}, },

279
composer.lock generated
View File

@ -4,29 +4,29 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "7597b35ceb19b17645835c69257ed60e", "content-hash": "b6d4c8e072b483a0ed1e02f7bf9c7719",
"packages": [ "packages": [
{ {
"name": "arthurhoaro/favicon", "name": "arthurhoaro/favicon",
"version": "v2.0.0", "version": "v1.3.3",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/ArthurHoaro/favicon.git", "url": "https://github.com/ArthurHoaro/favicon.git",
"reference": "44f1e0d0d22e71472f2ecd2b8bec33ebae582c4c" "reference": "b1acd8b87d6b37e5251fe0559ed488a95078f5b9"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/ArthurHoaro/favicon/zipball/44f1e0d0d22e71472f2ecd2b8bec33ebae582c4c", "url": "https://api.github.com/repos/ArthurHoaro/favicon/zipball/b1acd8b87d6b37e5251fe0559ed488a95078f5b9",
"reference": "44f1e0d0d22e71472f2ecd2b8bec33ebae582c4c", "reference": "b1acd8b87d6b37e5251fe0559ed488a95078f5b9",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"ext-dom": "*", "ext-dom": "*",
"ext-fileinfo": "*", "ext-fileinfo": "*",
"php": "^8.0" "php": ">=5.6"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^10.0", "phpunit/phpunit": "~4.8",
"squizlabs/php_codesniffer": "^3.5", "squizlabs/php_codesniffer": "^3.5",
"weew/helpers-filesystem": "~1.0" "weew/helpers-filesystem": "~1.0"
}, },
@ -59,10 +59,10 @@
], ],
"support": { "support": {
"issues": "https://github.com/ArthurHoaro/favicon/issues", "issues": "https://github.com/ArthurHoaro/favicon/issues",
"source": "https://github.com/ArthurHoaro/favicon/tree/v2.0.0", "source": "https://github.com/ArthurHoaro/favicon/tree/v1.3.3",
"sources": "https://github.com/ArthurHoaro/favicon" "sources": "https://github.com/ArthurHoaro/favicon"
}, },
"time": "2023-10-22T00:43:56+00:00" "time": "2021-08-06T05:41:25+00:00"
}, },
{ {
"name": "debril/feed-io", "name": "debril/feed-io",
@ -133,20 +133,20 @@
}, },
{ {
"name": "ezyang/htmlpurifier", "name": "ezyang/htmlpurifier",
"version": "v4.17.0", "version": "v4.16.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/ezyang/htmlpurifier.git", "url": "https://github.com/ezyang/htmlpurifier.git",
"reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c" "reference": "523407fb06eb9e5f3d59889b3978d5bfe94299c8"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/ezyang/htmlpurifier/zipball/bbc513d79acf6691fa9cf10f192c90dd2957f18c", "url": "https://api.github.com/repos/ezyang/htmlpurifier/zipball/523407fb06eb9e5f3d59889b3978d5bfe94299c8",
"reference": "bbc513d79acf6691fa9cf10f192c90dd2957f18c", "reference": "523407fb06eb9e5f3d59889b3978d5bfe94299c8",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"php": "~5.6.0 || ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0" "php": "~5.6.0 || ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0 || ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0"
}, },
"require-dev": { "require-dev": {
"cerdic/css-tidy": "^1.7 || ^2.0", "cerdic/css-tidy": "^1.7 || ^2.0",
@ -188,9 +188,9 @@
], ],
"support": { "support": {
"issues": "https://github.com/ezyang/htmlpurifier/issues", "issues": "https://github.com/ezyang/htmlpurifier/issues",
"source": "https://github.com/ezyang/htmlpurifier/tree/v4.17.0" "source": "https://github.com/ezyang/htmlpurifier/tree/v4.16.0"
}, },
"time": "2023-11-17T15:01:25+00:00" "time": "2022-09-18T07:06:19+00:00"
}, },
{ {
"name": "fivefilters/readability.php", "name": "fivefilters/readability.php",
@ -766,16 +766,16 @@
}, },
{ {
"name": "doctrine/dbal", "name": "doctrine/dbal",
"version": "3.8.0", "version": "3.7.0",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/doctrine/dbal.git", "url": "https://github.com/doctrine/dbal.git",
"reference": "d244f2e6e6bf32bff5174e6729b57214923ecec9" "reference": "00d03067f07482f025d41ab55e4ba0db5eca2cdf"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/doctrine/dbal/zipball/d244f2e6e6bf32bff5174e6729b57214923ecec9", "url": "https://api.github.com/repos/doctrine/dbal/zipball/00d03067f07482f025d41ab55e4ba0db5eca2cdf",
"reference": "d244f2e6e6bf32bff5174e6729b57214923ecec9", "reference": "00d03067f07482f025d41ab55e4ba0db5eca2cdf",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -791,14 +791,14 @@
"doctrine/coding-standard": "12.0.0", "doctrine/coding-standard": "12.0.0",
"fig/log-test": "^1", "fig/log-test": "^1",
"jetbrains/phpstorm-stubs": "2023.1", "jetbrains/phpstorm-stubs": "2023.1",
"phpstan/phpstan": "1.10.56", "phpstan/phpstan": "1.10.35",
"phpstan/phpstan-strict-rules": "^1.5", "phpstan/phpstan-strict-rules": "^1.5",
"phpunit/phpunit": "9.6.15", "phpunit/phpunit": "9.6.13",
"psalm/plugin-phpunit": "0.18.4", "psalm/plugin-phpunit": "0.18.4",
"slevomat/coding-standard": "8.13.1", "slevomat/coding-standard": "8.13.1",
"squizlabs/php_codesniffer": "3.8.1", "squizlabs/php_codesniffer": "3.7.2",
"symfony/cache": "^5.4|^6.0|^7.0", "symfony/cache": "^5.4|^6.0",
"symfony/console": "^4.4|^5.4|^6.0|^7.0", "symfony/console": "^4.4|^5.4|^6.0",
"vimeo/psalm": "4.30.0" "vimeo/psalm": "4.30.0"
}, },
"suggest": { "suggest": {
@ -859,7 +859,7 @@
], ],
"support": { "support": {
"issues": "https://github.com/doctrine/dbal/issues", "issues": "https://github.com/doctrine/dbal/issues",
"source": "https://github.com/doctrine/dbal/tree/3.8.0" "source": "https://github.com/doctrine/dbal/tree/3.7.0"
}, },
"funding": [ "funding": [
{ {
@ -875,20 +875,20 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2024-01-25T21:44:02+00:00" "time": "2023-09-26T20:56:55+00:00"
}, },
{ {
"name": "doctrine/deprecations", "name": "doctrine/deprecations",
"version": "1.1.2", "version": "v1.1.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/doctrine/deprecations.git", "url": "https://github.com/doctrine/deprecations.git",
"reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931" "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/doctrine/deprecations/zipball/4f2d4f2836e7ec4e7a8625e75c6aa916004db931", "url": "https://api.github.com/repos/doctrine/deprecations/zipball/612a3ee5ab0d5dd97b7cf3874a6efe24325efac3",
"reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931", "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -920,9 +920,9 @@
"homepage": "https://www.doctrine-project.org/", "homepage": "https://www.doctrine-project.org/",
"support": { "support": {
"issues": "https://github.com/doctrine/deprecations/issues", "issues": "https://github.com/doctrine/deprecations/issues",
"source": "https://github.com/doctrine/deprecations/tree/1.1.2" "source": "https://github.com/doctrine/deprecations/tree/v1.1.1"
}, },
"time": "2023-09-27T20:04:15+00:00" "time": "2023-06-03T09:27:29+00:00"
}, },
{ {
"name": "doctrine/event-manager", "name": "doctrine/event-manager",
@ -1146,27 +1146,25 @@
}, },
{ {
"name": "nikic/php-parser", "name": "nikic/php-parser",
"version": "v5.0.0", "version": "v4.17.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/nikic/PHP-Parser.git", "url": "https://github.com/nikic/PHP-Parser.git",
"reference": "4a21235f7e56e713259a6f76bf4b5ea08502b9dc" "reference": "a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/4a21235f7e56e713259a6f76bf4b5ea08502b9dc", "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d",
"reference": "4a21235f7e56e713259a6f76bf4b5ea08502b9dc", "reference": "a6303e50c90c355c7eeee2c4a8b27fe8dc8fef1d",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"ext-ctype": "*",
"ext-json": "*",
"ext-tokenizer": "*", "ext-tokenizer": "*",
"php": ">=7.4" "php": ">=7.0"
}, },
"require-dev": { "require-dev": {
"ircmaxell/php-yacc": "^0.0.7", "ircmaxell/php-yacc": "^0.0.7",
"phpunit/phpunit": "^7.0 || ^8.0 || ^9.0" "phpunit/phpunit": "^6.5 || ^7.0 || ^8.0 || ^9.0"
}, },
"bin": [ "bin": [
"bin/php-parse" "bin/php-parse"
@ -1174,7 +1172,7 @@
"type": "library", "type": "library",
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "5.0-dev" "dev-master": "4.9-dev"
} }
}, },
"autoload": { "autoload": {
@ -1198,9 +1196,9 @@
], ],
"support": { "support": {
"issues": "https://github.com/nikic/PHP-Parser/issues", "issues": "https://github.com/nikic/PHP-Parser/issues",
"source": "https://github.com/nikic/PHP-Parser/tree/v5.0.0" "source": "https://github.com/nikic/PHP-Parser/tree/v4.17.1"
}, },
"time": "2024-01-07T17:17:35+00:00" "time": "2023-08-13T19:53:39+00:00"
}, },
{ {
"name": "phar-io/manifest", "name": "phar-io/manifest",
@ -1359,16 +1357,16 @@
}, },
{ {
"name": "phpstan/phpstan", "name": "phpstan/phpstan",
"version": "1.11.4", "version": "1.10.35",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/phpstan/phpstan.git", "url": "https://github.com/phpstan/phpstan.git",
"reference": "9100a76ce8015b9aa7125b9171ae3a76887b6c82" "reference": "e730e5facb75ffe09dfb229795e8c01a459f26c3"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan/zipball/9100a76ce8015b9aa7125b9171ae3a76887b6c82", "url": "https://api.github.com/repos/phpstan/phpstan/zipball/e730e5facb75ffe09dfb229795e8c01a459f26c3",
"reference": "9100a76ce8015b9aa7125b9171ae3a76887b6c82", "reference": "e730e5facb75ffe09dfb229795e8c01a459f26c3",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -1411,9 +1409,13 @@
{ {
"url": "https://github.com/phpstan", "url": "https://github.com/phpstan",
"type": "github" "type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/phpstan/phpstan",
"type": "tidelift"
} }
], ],
"time": "2024-06-06T12:19:22+00:00" "time": "2023-09-19T15:27:56+00:00"
}, },
{ {
"name": "phpstan/phpstan-deprecation-rules", "name": "phpstan/phpstan-deprecation-rules",
@ -1465,21 +1467,21 @@
}, },
{ {
"name": "phpstan/phpstan-doctrine", "name": "phpstan/phpstan-doctrine",
"version": "1.4.3", "version": "1.3.43",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/phpstan/phpstan-doctrine.git", "url": "https://github.com/phpstan/phpstan-doctrine.git",
"reference": "dd27a3e83777ba0d9e9cedfaf4ebf95ff67b271f" "reference": "c5015035755ad2d5013bd6bf98ff423ca6150822"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan-doctrine/zipball/dd27a3e83777ba0d9e9cedfaf4ebf95ff67b271f", "url": "https://api.github.com/repos/phpstan/phpstan-doctrine/zipball/c5015035755ad2d5013bd6bf98ff423ca6150822",
"reference": "dd27a3e83777ba0d9e9cedfaf4ebf95ff67b271f", "reference": "c5015035755ad2d5013bd6bf98ff423ca6150822",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"php": "^7.2 || ^8.0", "php": "^7.2 || ^8.0",
"phpstan/phpstan": "^1.11" "phpstan/phpstan": "^1.10.12"
}, },
"conflict": { "conflict": {
"doctrine/collections": "<1.0", "doctrine/collections": "<1.0",
@ -1489,26 +1491,24 @@
"doctrine/persistence": "<1.3" "doctrine/persistence": "<1.3"
}, },
"require-dev": { "require-dev": {
"cache/array-adapter": "^1.1",
"composer/semver": "^3.3.2", "composer/semver": "^3.3.2",
"cweagans/composer-patches": "^1.7.3", "doctrine/annotations": "^1.11.0",
"doctrine/annotations": "^1.11 || ^2.0", "doctrine/collections": "^1.6",
"doctrine/collections": "^1.6 || ^2.1",
"doctrine/common": "^2.7 || ^3.0", "doctrine/common": "^2.7 || ^3.0",
"doctrine/dbal": "^2.13.8 || ^3.3.3", "doctrine/dbal": "^2.13.8 || ^3.3.3",
"doctrine/lexer": "^2.0 || ^3.0", "doctrine/lexer": "^1.2.1",
"doctrine/mongodb-odm": "^1.3 || ^2.4.3", "doctrine/mongodb-odm": "^1.3 || ^2.1",
"doctrine/orm": "^2.16.0", "doctrine/orm": "^2.11.0",
"doctrine/persistence": "^2.2.1 || ^3.2", "doctrine/persistence": "^1.3.8 || ^2.2.1",
"gedmo/doctrine-extensions": "^3.8", "gedmo/doctrine-extensions": "^3.8",
"nesbot/carbon": "^2.49", "nesbot/carbon": "^2.49",
"nikic/php-parser": "^4.13.2", "nikic/php-parser": "^4.13.2",
"php-parallel-lint/php-parallel-lint": "^1.2", "php-parallel-lint/php-parallel-lint": "^1.2",
"phpstan/phpstan-phpunit": "^1.3.13", "phpstan/phpstan-phpunit": "^1.3.13",
"phpstan/phpstan-strict-rules": "^1.5.1", "phpstan/phpstan-strict-rules": "^1.5.1",
"phpunit/phpunit": "^9.6.16", "phpunit/phpunit": "^9.5.10",
"ramsey/uuid": "^4.2", "ramsey/uuid-doctrine": "^1.5.0",
"symfony/cache": "^5.4" "symfony/cache": "^4.4.35"
}, },
"type": "phpstan-extension", "type": "phpstan-extension",
"extra": { "extra": {
@ -1531,22 +1531,22 @@
"description": "Doctrine extensions for PHPStan", "description": "Doctrine extensions for PHPStan",
"support": { "support": {
"issues": "https://github.com/phpstan/phpstan-doctrine/issues", "issues": "https://github.com/phpstan/phpstan-doctrine/issues",
"source": "https://github.com/phpstan/phpstan-doctrine/tree/1.4.3" "source": "https://github.com/phpstan/phpstan-doctrine/tree/1.3.43"
}, },
"time": "2024-06-08T05:48:50+00:00" "time": "2023-09-01T15:01:13+00:00"
}, },
{ {
"name": "phpstan/phpstan-phpunit", "name": "phpstan/phpstan-phpunit",
"version": "1.3.16", "version": "1.3.14",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/phpstan/phpstan-phpunit.git", "url": "https://github.com/phpstan/phpstan-phpunit.git",
"reference": "d5242a59d035e46774f2e634b374bc39ff62cb95" "reference": "614acc10c522e319639bf38b0698a4a566665f04"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan-phpunit/zipball/d5242a59d035e46774f2e634b374bc39ff62cb95", "url": "https://api.github.com/repos/phpstan/phpstan-phpunit/zipball/614acc10c522e319639bf38b0698a4a566665f04",
"reference": "d5242a59d035e46774f2e634b374bc39ff62cb95", "reference": "614acc10c522e319639bf38b0698a4a566665f04",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -1583,27 +1583,27 @@
"description": "PHPUnit extensions and rules for PHPStan", "description": "PHPUnit extensions and rules for PHPStan",
"support": { "support": {
"issues": "https://github.com/phpstan/phpstan-phpunit/issues", "issues": "https://github.com/phpstan/phpstan-phpunit/issues",
"source": "https://github.com/phpstan/phpstan-phpunit/tree/1.3.16" "source": "https://github.com/phpstan/phpstan-phpunit/tree/1.3.14"
}, },
"time": "2024-02-23T09:51:20+00:00" "time": "2023-08-25T09:46:39+00:00"
}, },
{ {
"name": "phpstan/phpstan-strict-rules", "name": "phpstan/phpstan-strict-rules",
"version": "1.5.2", "version": "1.5.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/phpstan/phpstan-strict-rules.git", "url": "https://github.com/phpstan/phpstan-strict-rules.git",
"reference": "7a50e9662ee9f3942e4aaaf3d603653f60282542" "reference": "b21c03d4f6f3a446e4311155f4be9d65048218e6"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan-strict-rules/zipball/7a50e9662ee9f3942e4aaaf3d603653f60282542", "url": "https://api.github.com/repos/phpstan/phpstan-strict-rules/zipball/b21c03d4f6f3a446e4311155f4be9d65048218e6",
"reference": "7a50e9662ee9f3942e4aaaf3d603653f60282542", "reference": "b21c03d4f6f3a446e4311155f4be9d65048218e6",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"php": "^7.2 || ^8.0", "php": "^7.2 || ^8.0",
"phpstan/phpstan": "^1.10.34" "phpstan/phpstan": "^1.10"
}, },
"require-dev": { "require-dev": {
"nikic/php-parser": "^4.13.0", "nikic/php-parser": "^4.13.0",
@ -1632,29 +1632,29 @@
"description": "Extra strict and opinionated rules for PHPStan", "description": "Extra strict and opinionated rules for PHPStan",
"support": { "support": {
"issues": "https://github.com/phpstan/phpstan-strict-rules/issues", "issues": "https://github.com/phpstan/phpstan-strict-rules/issues",
"source": "https://github.com/phpstan/phpstan-strict-rules/tree/1.5.2" "source": "https://github.com/phpstan/phpstan-strict-rules/tree/1.5.1"
}, },
"time": "2023-10-30T14:35:06+00:00" "time": "2023-03-29T14:47:40+00:00"
}, },
{ {
"name": "phpunit/php-code-coverage", "name": "phpunit/php-code-coverage",
"version": "9.2.30", "version": "9.2.29",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/php-code-coverage.git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git",
"reference": "ca2bd87d2f9215904682a9cb9bb37dda98e76089" "reference": "6a3a87ac2bbe33b25042753df8195ba4aa534c76"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/ca2bd87d2f9215904682a9cb9bb37dda98e76089", "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/6a3a87ac2bbe33b25042753df8195ba4aa534c76",
"reference": "ca2bd87d2f9215904682a9cb9bb37dda98e76089", "reference": "6a3a87ac2bbe33b25042753df8195ba4aa534c76",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"ext-dom": "*", "ext-dom": "*",
"ext-libxml": "*", "ext-libxml": "*",
"ext-xmlwriter": "*", "ext-xmlwriter": "*",
"nikic/php-parser": "^4.18 || ^5.0", "nikic/php-parser": "^4.15",
"php": ">=7.3", "php": ">=7.3",
"phpunit/php-file-iterator": "^3.0.3", "phpunit/php-file-iterator": "^3.0.3",
"phpunit/php-text-template": "^2.0.2", "phpunit/php-text-template": "^2.0.2",
@ -1704,7 +1704,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
"security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy",
"source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.30" "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/9.2.29"
}, },
"funding": [ "funding": [
{ {
@ -1712,7 +1712,7 @@
"type": "github" "type": "github"
} }
], ],
"time": "2023-12-22T06:47:57+00:00" "time": "2023-09-19T04:57:46+00:00"
}, },
{ {
"name": "phpunit/php-file-iterator", "name": "phpunit/php-file-iterator",
@ -1957,16 +1957,16 @@
}, },
{ {
"name": "phpunit/phpunit", "name": "phpunit/phpunit",
"version": "9.6.16", "version": "9.6.13",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git", "url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "3767b2c56ce02d01e3491046f33466a1ae60a37f" "reference": "f3d767f7f9e191eab4189abe41ab37797e30b1be"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/3767b2c56ce02d01e3491046f33466a1ae60a37f", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/f3d767f7f9e191eab4189abe41ab37797e30b1be",
"reference": "3767b2c56ce02d01e3491046f33466a1ae60a37f", "reference": "f3d767f7f9e191eab4189abe41ab37797e30b1be",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -2040,7 +2040,7 @@
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/phpunit/issues", "issues": "https://github.com/sebastianbergmann/phpunit/issues",
"security": "https://github.com/sebastianbergmann/phpunit/security/policy", "security": "https://github.com/sebastianbergmann/phpunit/security/policy",
"source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.16" "source": "https://github.com/sebastianbergmann/phpunit/tree/9.6.13"
}, },
"funding": [ "funding": [
{ {
@ -2056,7 +2056,7 @@
"type": "tidelift" "type": "tidelift"
} }
], ],
"time": "2024-01-19T07:03:14+00:00" "time": "2023-09-19T05:39:22+00:00"
}, },
{ {
"name": "psr/cache", "name": "psr/cache",
@ -2350,20 +2350,20 @@
}, },
{ {
"name": "sebastian/complexity", "name": "sebastian/complexity",
"version": "2.0.3", "version": "2.0.2",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/complexity.git", "url": "https://github.com/sebastianbergmann/complexity.git",
"reference": "25f207c40d62b8b7aa32f5ab026c53561964053a" "reference": "739b35e53379900cc9ac327b2147867b8b6efd88"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/25f207c40d62b8b7aa32f5ab026c53561964053a", "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/739b35e53379900cc9ac327b2147867b8b6efd88",
"reference": "25f207c40d62b8b7aa32f5ab026c53561964053a", "reference": "739b35e53379900cc9ac327b2147867b8b6efd88",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"nikic/php-parser": "^4.18 || ^5.0", "nikic/php-parser": "^4.7",
"php": ">=7.3" "php": ">=7.3"
}, },
"require-dev": { "require-dev": {
@ -2395,7 +2395,7 @@
"homepage": "https://github.com/sebastianbergmann/complexity", "homepage": "https://github.com/sebastianbergmann/complexity",
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/complexity/issues", "issues": "https://github.com/sebastianbergmann/complexity/issues",
"source": "https://github.com/sebastianbergmann/complexity/tree/2.0.3" "source": "https://github.com/sebastianbergmann/complexity/tree/2.0.2"
}, },
"funding": [ "funding": [
{ {
@ -2403,7 +2403,7 @@
"type": "github" "type": "github"
} }
], ],
"time": "2023-12-22T06:19:30+00:00" "time": "2020-10-26T15:52:27+00:00"
}, },
{ {
"name": "sebastian/diff", "name": "sebastian/diff",
@ -2677,20 +2677,20 @@
}, },
{ {
"name": "sebastian/lines-of-code", "name": "sebastian/lines-of-code",
"version": "1.0.4", "version": "1.0.3",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/sebastianbergmann/lines-of-code.git", "url": "https://github.com/sebastianbergmann/lines-of-code.git",
"reference": "e1e4a170560925c26d424b6a03aed157e7dcc5c5" "reference": "c1c2e997aa3146983ed888ad08b15470a2e22ecc"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/e1e4a170560925c26d424b6a03aed157e7dcc5c5", "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/c1c2e997aa3146983ed888ad08b15470a2e22ecc",
"reference": "e1e4a170560925c26d424b6a03aed157e7dcc5c5", "reference": "c1c2e997aa3146983ed888ad08b15470a2e22ecc",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
"nikic/php-parser": "^4.18 || ^5.0", "nikic/php-parser": "^4.6",
"php": ">=7.3" "php": ">=7.3"
}, },
"require-dev": { "require-dev": {
@ -2722,7 +2722,7 @@
"homepage": "https://github.com/sebastianbergmann/lines-of-code", "homepage": "https://github.com/sebastianbergmann/lines-of-code",
"support": { "support": {
"issues": "https://github.com/sebastianbergmann/lines-of-code/issues", "issues": "https://github.com/sebastianbergmann/lines-of-code/issues",
"source": "https://github.com/sebastianbergmann/lines-of-code/tree/1.0.4" "source": "https://github.com/sebastianbergmann/lines-of-code/tree/1.0.3"
}, },
"funding": [ "funding": [
{ {
@ -2730,7 +2730,7 @@
"type": "github" "type": "github"
} }
], ],
"time": "2023-12-22T06:20:34+00:00" "time": "2020-11-28T06:42:11+00:00"
}, },
{ {
"name": "sebastian/object-enumerator", "name": "sebastian/object-enumerator",
@ -3073,16 +3073,16 @@
}, },
{ {
"name": "squizlabs/php_codesniffer", "name": "squizlabs/php_codesniffer",
"version": "3.9.2", "version": "3.7.2",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git", "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
"reference": "aac1f6f347a5c5ac6bc98ad395007df00990f480" "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/aac1f6f347a5c5ac6bc98ad395007df00990f480", "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/ed8e00df0a83aa96acf703f8c2979ff33341f879",
"reference": "aac1f6f347a5c5ac6bc98ad395007df00990f480", "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -3092,11 +3092,11 @@
"php": ">=5.4.0" "php": ">=5.4.0"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.3.4" "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
}, },
"bin": [ "bin": [
"bin/phpcbf", "bin/phpcs",
"bin/phpcs" "bin/phpcbf"
], ],
"type": "library", "type": "library",
"extra": { "extra": {
@ -3111,58 +3111,35 @@
"authors": [ "authors": [
{ {
"name": "Greg Sherwood", "name": "Greg Sherwood",
"role": "Former lead" "role": "lead"
},
{
"name": "Juliette Reinders Folmer",
"role": "Current lead"
},
{
"name": "Contributors",
"homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors"
} }
], ],
"description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
"homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer", "homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
"keywords": [ "keywords": [
"phpcs", "phpcs",
"standards", "standards",
"static analysis" "static analysis"
], ],
"support": { "support": {
"issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues", "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues",
"security": "https://github.com/PHPCSStandards/PHP_CodeSniffer/security/policy", "source": "https://github.com/squizlabs/PHP_CodeSniffer",
"source": "https://github.com/PHPCSStandards/PHP_CodeSniffer", "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki"
"wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki"
}, },
"funding": [ "time": "2023-02-22T23:07:41+00:00"
{
"url": "https://github.com/PHPCSStandards",
"type": "github"
},
{
"url": "https://github.com/jrfnl",
"type": "github"
},
{
"url": "https://opencollective.com/php_codesniffer",
"type": "open_collective"
}
],
"time": "2024-04-23T20:25:34+00:00"
}, },
{ {
"name": "theseer/tokenizer", "name": "theseer/tokenizer",
"version": "1.2.2", "version": "1.2.1",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/theseer/tokenizer.git", "url": "https://github.com/theseer/tokenizer.git",
"reference": "b2ad5003ca10d4ee50a12da31de12a5774ba6b96" "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/theseer/tokenizer/zipball/b2ad5003ca10d4ee50a12da31de12a5774ba6b96", "url": "https://api.github.com/repos/theseer/tokenizer/zipball/34a41e998c2183e22995f158c581e7b5e755ab9e",
"reference": "b2ad5003ca10d4ee50a12da31de12a5774ba6b96", "reference": "34a41e998c2183e22995f158c581e7b5e755ab9e",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -3191,7 +3168,7 @@
"description": "A small library for converting tokenized PHP source code into XML and potentially other formats", "description": "A small library for converting tokenized PHP source code into XML and potentially other formats",
"support": { "support": {
"issues": "https://github.com/theseer/tokenizer/issues", "issues": "https://github.com/theseer/tokenizer/issues",
"source": "https://github.com/theseer/tokenizer/tree/1.2.2" "source": "https://github.com/theseer/tokenizer/tree/1.2.1"
}, },
"funding": [ "funding": [
{ {
@ -3199,7 +3176,7 @@
"type": "github" "type": "github"
} }
], ],
"time": "2023-11-20T00:12:19+00:00" "time": "2021-07-28T10:34:58+00:00"
} }
], ],
"aliases": [], "aliases": [],
@ -3216,5 +3193,5 @@
"ext-curl": "*" "ext-curl": "*"
}, },
"platform-dev": [], "platform-dev": [],
"plugin-api-version": "2.6.0" "plugin-api-version": "2.3.0"
} }

0
css/admin.scss → css/admin.css
View File

0
css/app.scss → css/app.css
View File

773
css/content.css Normal file
View File

@ -0,0 +1,773 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @copyright Bernhard Posselt 2014
*/
#app-content {
width: 100%;
flex-basis: auto;
}
#app-navigation:not(.hidden) + #app-content {
width: calc(100% - 300px);
}
#app-content #searchresults {
display: none;
}
#app-content #text-content {
padding: 20px;
}
#app-content #text-content h1 {
font-size: 18pt;
margin-bottom: 15px;
}
#app-content #text-content p {
font-size: 11pt;
}
#app-content .no-feeds-available {
text-align: center;
color: var(--color-text-lighter);
font-size: 16pt;
min-height: 100%;
height: 100%;
width: 100%;
display: table;
}
#app-content .no-feeds-available p {
vertical-align: middle;
display: table-cell;
}
#articles {
width: 100%;
}
/**
* Podcast settings
*/
#app-content .podcast {
height: 50px;
z-index: 10000;
background-color: #111;
display: flex;
position: sticky;
top: 50px;
align-items: center;
}
#app-content.nc-major-version-gte-25 .podcast {
top: 0;
}
#app-content .podcast audio {
display: block;
width: calc(100% - 60px);
border-radius: 0;
height: inherit;
}
#app-content .podcast button,
#app-content .podcast a {
display: block;
float: left;
height: 30px;
width: 30px;
border: 0;
border-radius: 0;
margin: 0;
background-color: transparent;
background-repeat: no-repeat;
background-position: center;
}
#app-content .podcast-close {
background-size: 25px;
background-image: url('../img/close.svg');
}
#app-content .podcast-download {
transform: rotate(270deg);
background-size: 20px;
background-image: url('../img/arrow-white.svg');
}
#app-content .podcast audio::-webkit-media-controls-enclosure {
max-width: inherit;
}
#app-content .podcast.fixed {
position: absolute;
right: 0;
left: 0;
}
#app-content.nc-major-version-gte-25 .podcast {
position: sticky;
}
@media only screen and (width < 1024px) {
#app-content.nc-major-version-gte-25 .podcast {
left: 35px;
width: calc(100% - 35px);
}
}
#notification a {
text-decoration: underline;
color: blue;
}
#notification li {
display: block;
}
/**
* Content styles
*/
#app-content.loading-content {
background: url('../img/loading.gif') no-repeat;
background-color: var(--color-main-background);
background-position: calc(50% - 16px) calc(50% - 16px);
/* Overrides the snap.js animation making the loading icon to fly in app-content. */
transition: none !important;
-webkit-transition: none !important;
-moz-webkit-transition: none !important;
}
#app-content.loading-content #app-content-wrapper {
display: none;
}
#app-content:not(.explore) #articles:after {
content: '';
display: block;
/* Subtract the height of the Nextcloud header. */
height: calc(100vh - 50px);
background-repeat: no-repeat;
}
#app-content .autopaging: #articles:after {
content: '';
background-image: url('../img/loading.gif');
background-position: calc(50% - 16px) calc(50% - 16px);
/* Overrides the snap.js animation making the loading icon to fly in app-content. */
transition: none !important;
-webkit-transition: none !important;
-moz-webkit-transition: none !important;
}
#app-content .finished-auto-paging #articles:after {
background: var(--color-main-background);
}
/**
*
*/
.pull-to-refresh {
height: 0;
overflow: hidden;
text-align: center;
background-image: -moz-linear-gradient(top, #eee 0%, #fefefe 100%);
background-image: -webkit-linear-gradient(top, #eee 0%, #fefefe 100%);
background-image: -ms-linear-gradient(top, #eee 0%, #fefefe 100%);
background-image: linear-gradient(top, #eee 0%, #fefefe 100%);
}
.pull-to-refresh.show-pull-to-refresh {
transition: all 0.5s ease;
padding-top: 10px;
height: 44px;
}
/**
* Rules for a single feed item
*/
#app-content .only-in-expanded {
display: block;
}
#app-content .compact .only-in-expanded {
display: none;
}
#app-content .only-in-compact {
display: none;
}
#app-content .compact .only-in-compact {
display: block;
}
#app-content .item {
cursor: default;
border-bottom: 1px solid var(--color-border);
}
#app-content .item.active {
background-image: linear-gradient(to right, orange 0, orange 2px, transparent 2px);
}
#app-content .compact li.item div.utils:hover {
background-color: var(--color-background-hover);
}
#app-content :not(.compact) .item {
}
#app-content .item:last-child {
border-bottom: 0;
}
/**
* Utils panel
*/
#app-content .utils {
width: 100%;
line-height: 52px;
box-sizing: border-box;
padding: 15px 50px 0 15px;
position: relative;
}
#app-content .compact .utils {
cursor: pointer;
padding: 0 15px 0 0;
-webkit-position: sticky;
position: sticky;
top: 50px;
background-color: var(--color-main-background);
min-height: 43px;
}
#app-content.nc-major-version-gte-25 .compact .utils {
top: 0px;
}
/* Only apply opacity to the util bar, not the dropdown */
#app-content .compact .utils ul {
opacity: 0.9;
}
#app-content .utils ul {
height: 43px;
list-style-type: none;
display: flex;
margin: 0;
padding: 0;
}
#app-content .compact .util-spacer,
#app-content .compact .util,
#app-content .compact .only-in-compact {
flex: 1 0 auto;
}
#app-content .compact .title {
flex: 1 1 auto;
}
#app-content .open .utils ul {
height: auto;
}
#app-content .utils ul > li {
min-width: 0;
}
#app-content .util-spacer {
width: 25px;
}
#app-content .compact .util-spacer {
width: 5px;
}
@media screen and (max-width: 1024px) {
#app-content .compact .util-spacer {
width: 0;
flex: 0 0 auto;
}
#app-content .item:first-of-type .util-spacer {
width: 28px;
}
}
#app-content .utils li {
line-height: 43px;
vertical-align: middle;
}
#app-content .utils > ul > li:last-child {
padding-right: 0;
}
#app-content .utils > ul > li:first-child {
padding-left: 0;
}
#app-content .utils .util {
padding: 0;
}
#app-content .utils .article-action-plugins {
}
#app-content .utils button,
#app-content .utils .external {
padding: 0;
margin: 0;
height: 43px;
width: 40px;
border: 0;
float: left;
background-color: transparent;
background-size: 100%;
background-repeat: no-repeat;
background-size: 25px;
background-position: center;
}
#app-content .utils .external,
#app-content .utils .menu button,
#app-content .utils .icon-toggle {
display: inline-block;
opacity: 0.3;
}
#app-content .utils .external:hover,
#app-content .utils .menu button:hover,
#app-content .utils .icon-toggle:hover,
#app-content .utils .icon-toggle.keep-unread {
opacity: 1;
}
#app-content .utils .star {
background-image: url('../img/inactive_star.svg');
}
#app-content .utils .starred {
background-image: url('../img/active_star.svg');
}
#app-content .utils .star:hover {
background-image: url('../img/hover_star.svg');
}
#app-content .utils .share {
opacity: .3;
}
#app-content .utils .share:hover {
opacity: 1;
}
#app-content .utils .more button {
opacity: .3;
}
#app-content .utils .more button:hover {
opacity: 1;
}
#app-content .utils .more {
position: relative;
}
#app-content .article-actions {
display: none;
filter: drop-shadow(0 0 5px rgba(150, 150, 150, 0.75));
-webkit-filter: drop-shadow(0 0 5px rgba(150, 150, 150, 0.75));
-moz-filter: drop-shadow(0 0 5px rgba(150, 150, 150, 0.75));
position: absolute;
top: 40px;
border-radius: 3px;
z-index: 1000;
border: 1px solid transparent;
margin: 0;
padding: 0;
}
#app-content .article-actions ul {
display: flex;
float: left;
}
#app-content .article-actions li {
float: left;
width: 40px !important;
}
#app-content #articles:not(.compact) .article-actions {
left: 6px;
}
#app-content #articles:not(.compact) .article-actions:after,
#app-content #articles:not(.compact) .article-actions:before {
left: 20px;
}
#app-content #articles.compact .article-actions {
right: -10px;
}
#app-content #articles.compact .article-actions:after,
#app-content #articles.compact .article-actions:before {
right: 9px;
}
#app-content .article-actions:after,
#app-content .article-actions:before {
bottom: 100%;
border: solid transparent;
content: " ";
height: 0;
width: 0;
position: absolute;
pointer-events: none;
}
#app-content .article-actions:after {
border-color: rgba(255, 255, 255, 0);
border-bottom-color: var(--color-border);
border-width: 5px;
margin-left: -5px;
}
#app-content .article-actions:before {
border-color: rgba(255, 255, 255, 0);
border-bottom-color: var(--color-border);
border-width: 9px;
margin-left: -9px;
}
/**
* Article title
*/
#app-content .utils .title {
width: 100%;
padding-left: 35px;
background-position: 6px 10px;
background-size: 20px 20px;
background-repeat: no-repeat;
}
#app-content .compact .utils .title h1 {
line-height: 1;
}
#app-content .utils .title h1 a {
/*text-overflow: ellipsis;*/
white-space: nowrap;
overflow: hidden;
width: 100%;
display: inline-block;
color: var(--color-main-text);
font-weight: bold;
font-size: 16px;
line-height: 1.5;
padding-top: 8px;
min-height: 40px;
}
#app-content .open .title .intro {
display: none;
}
#app-content .title .intro {
color: var(--color-text-lighter);
font-size: 10pt;
font-weight: normal;
margin-left: 20px;
}
#app-content .open .utils .title h1 a {
overflow: auto;
white-space: normal;
}
#app-content .read .utils .title h1 a {
font-weight: normal;
color: var(--color-text-lighter);
}
#app-content .utils .date {
padding: 0 15px;
}
/**
* Expanded content
*/
#app-content .heading {
padding: 25px 0 10px 0;
}
#app-content .heading h1 {
font-size: 19px;
max-width: 770px;
word-wrap: break-word;
}
#app-content .heading a {
font-weight: bold;
color: var(--color-main-text);
text-decoration: none;
margin:0;
}
#app-content .heading a:hover {
text-decoration: underline;
}
#app-content .heading .date {
float: right;
display: inline-block;
font-size: 15px;
padding: 0 10px;
}
#app-content .read .heading a {
font-weight: normal !important;
color: var(--color-text-lighter);
}
#app-content .feed-view .source {
display: none;
}
#app-content .source img {
height: 16px;
display: inline-block;
margin: 0 0 -2px 2px;
}
/**
* Actual content
*/
#app-content .article {
min-height: 69px;
padding: 0 50px 50px 50px;
}
#app-content .compact .article {
display: none;
}
#app-content .open .article {
display: block;
}
/**
* Timestamp
*/
#app-content .subtitle {
color: var(--color-text-lighter);
font-size: 15px;
max-width: 770px;
padding: 25px 0;
}
#app-content .subtitle a {
color: var(--color-text-lighter);
}
#app-content .subtitle a:hover {
text-decoration: underline;
}
#app-content .date {
color: var(--color-text-lighter);
white-space: nowrap;
}
/**
* Author
*/
#app-content .author {
color: var(--color-text-lighter);
font-size: 15px;
}
#app-content .author a {
color: inherit;
}
#app-content .author a:hover {
text-decoration: underline;
}
/**
* Enclosure
*/
#app-content .enclosure {
padding: 20px 0;
max-width: 770px;
margin-bottom: 15px;
}
#app-content .enclosure audio,
#app-content .enclosure video {
width: 100%;
}
#app-content .enclosure video {
background-color: #000;
margin-bottom: 20px;
}
#app-content .enclosure-error {
line-height: 1.5;
height: 40px;
}
/**
* Article body
*/
#app-content .body {
max-width: 770px;
font-size: 14px;
clear: both;
overflow-x: auto;
}
#app-content .body p {
line-height: 1.5;
margin: 7px 0 14px 0;
}
#app-content .body img,
#app-content .body table {
max-width: 100%;
height: auto;
overflow: auto;
word-wrap: break-word;
white-space: normal;
}
#app-content .body table {
border-collapse: collapse;
}
#app-content .body table th {
font-weight: bold;
}
#app-content .body table th,
#app-content .body table td {
border: 1px solid var(--color-text-lighter);
padding: 2px 6px;
}
#app-content .body iframe {
max-width: 100%;
}
#app-content .body > div > img:first-child,
#app-content .body > div > :first-child > img:first-child {
padding: 0 14px 0 0;
float: left;
}
#app-content .body h1,
#app-content .body h2 {
font-size: 17px;
font-weight: bold;
color: var(--color-main-text);
margin: 21px 0 5px 0;
}
#app-content .body h3 {
font-size: 15px;
font-weight: bold;
color: var(--color-main-text);
margin: 21px 0 0 0;
text-decoration: underline;
}
#app-content .body h4,
#app-content .body h5,
#app-content .body h6 {
font-weight: bold;
}
#app-content .body > div {
margin: 7px 0;
}
#app-content .body a {
color: #0c76ff;
text-decoration: underline;
}
body.theme--dark #app-content .body a, /* NC 24 */
[data-theme-dark] #app-content .body a { /* NC 25 */
color: #9cc7ff;
}
#app-content .body ul {
margin: 7px 0;
padding-left: 14px;
list-style-type: disc;
}
#app-content .body ol {
margin: 7px 0;
padding-left: 21px;
}
#app-content .body ul li {
cursor: default;
line-height: 21px;
}
#app-content .body pre {
padding: 7px 7px 7px 14px;
background-color: var(--color-background-darker);
border: 1px solid var(--color-border-dark);
margin: 7px 0 14px 0;
overflow-y: auto;
}
#app-content .body pre::-webkit-scrollbar {
height: 10px;
}
#app-content .body pre::-webkit-scrollbar-thumb {
background: #333;
}
#app-content .body pre::-webkit-scrollbar-track-piece {
background: #ddd;
}
#app-content .body code,
#app-content .body pre {
font-family: monospace;
font-size: 16px;
}
#app-content .body blockquote {
border-left: 1px solid rgb(210, 210, 210);
margin: 25px 0;
padding: 0 0 0 15px;
font-style: italic;
}
#app-content .body em {
font-style: italic;
opacity: 1;
}
#app-content *[dir=rtl] {
text-align: right;
}

1327
css/custom.css
View File

File diff suppressed because it is too large Load Diff

40
css/explore.css
View File

@ -8,7 +8,6 @@
* @copyright 2020, Jan C. Borchardt, https://jancborchardt.net * @copyright 2020, Jan C. Borchardt, https://jancborchardt.net
* @copyright Bernhard Posselt 2014 * @copyright Bernhard Posselt 2014
*/ */
/** /**
* Explore styles * Explore styles
*/ */
@ -16,4 +15,43 @@
height: 100%; height: 100%;
} }
#explore {
height: 100%;
width: 100%;
padding: 45px 0 45px 45px;
}
#explore .grid-item {
width: 300px;
border: 2px solid var(--color-border);
border-radius: var(--border-radius-large);
margin: 0 24px 24px 0;
padding: 24px;
}
#explore .grid-item .explore-title {
background-repeat: no-repeat;
background-position: 0 center;
background-size: 24px;
padding-left: 32px;
}
#explore .grid-item .explore-title a {
word-wrap: break-word;
}
#explore .grid-item .explore-title a:hover, #explore .grid-item .explore-title a:focus {
text-decoration: underline;
}
#explore .grid-item .explore-logo {
text-align: center;
margin-top: 25px;
}
#explore .grid-item .explore-logo img {
width: 100%;
}
#explore .grid-item .explore-subscribe {
margin-top: 16px;
max-width: 100%;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
/*# sourceMappingURL=explore.css.map */ /*# sourceMappingURL=explore.css.map */

57
css/explore.scss
View File

@ -1,57 +0,0 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @copyright 2020, Jan C. Borchardt, https://jancborchardt.net
* @copyright Bernhard Posselt 2014
*/
/**
* Explore styles
*/
.explore #app-content-wrapper {
height: 100%;
}
#explore {
height: 100%;
width: 100%;
padding: 45px 0 45px 45px;
.grid-item {
width: 300px;
border: 2px solid var(--color-border);
border-radius: var(--border-radius-large);
margin: 0 24px 24px 0;
padding: 24px;
.explore-title {
background-repeat: no-repeat;
background-position: 0 center;
background-size: 24px;
padding-left: 32px;
a {
word-wrap: break-word;
&:hover,
&:focus {
text-decoration: underline;
}
}
}
.explore-logo {
text-align: center;
margin-top: 25px;
img {
width: 100%;
}
}
}
}

9
css/merged.scss
View File

@ -1,9 +0,0 @@
@import 'explore';
@import 'admin';
@import 'app';
@import 'content';
@import 'custom';
@import 'mobile';
@import 'navigation';
@import 'settings';
@import 'shortcuts';

80
css/navigation.scss → css/navigation.css
View File

@ -34,6 +34,60 @@
background-position: 14px center; background-position: 14px center;
} }
/* actual form content */
#app-navigation .add-new-popup {
display: none;
padding: 10px;
width: 100%;
border-top: 1px solid var(--color-border-dark);
border-bottom: 1px solid var(--color-border-dark);
}
#app-navigation input.ng-invalid {
border: 1px solid var(--color-error);
}
#app-navigation .add-new-popup input,
#app-navigation .add-new-popup select {
width: 100%;
height: 36px;
padding: 5px;
margin-right: 0;
}
#app-navigation .add-new-popup select,
#app-navigation #new-feed [name="folderName"] {
width: calc(100% - 36px);
border-right: 0;
border-top-right-radius: 0;
border-bottom-right-radius: 0;
float: left;
}
#app-navigation .add-new-popup .add-new-folder-primary {
border-bottom-left-radius: 0;
border-top-left-radius: 0;
width: 36px;
height: 36px;
margin-left: 0;
margin-right: 0;
}
#app-navigation .add-new-popup .add-new-basicauth-toggle {
padding: 5px 0;
}
#app-navigation .add-new-popup .add-feed-basicauth {
width: 100%;
padding: 0 0 10px;
}
#app-navigation .add-new-popup .error {
padding: 0 0 10px 0;
}
/* navigation */ /* navigation */
#app-navigation ul.with-icon > li > a, #app-navigation ul.with-icon > li > a,
#app-navigation ul.with-icon > li > ul > li > a { #app-navigation ul.with-icon > li > ul > li > a {
@ -64,6 +118,7 @@
background-image: url('../img/twitter.svg') !important; background-image: url('../img/twitter.svg') !important;
} }
.col-4 { .col-4 {
-ms-flex: 0 0 33.333333%; -ms-flex: 0 0 33.333333%;
flex: 0 0 33.333333%; flex: 0 0 33.333333%;
@ -79,7 +134,7 @@
flex-wrap: wrap; flex-wrap: wrap;
} }
.icon-dropdown { .icon-dropdown{
background-position: center !important; background-position: center !important;
background-size: 24px; background-size: 24px;
padding: 2em !important; padding: 2em !important;
@ -90,13 +145,14 @@
.icon-full-text-enabled { .icon-full-text-enabled {
background-image: url('../img/fulltext.svg'); background-image: url('../img/fulltext.svg');
background-size: 50%; background-size: 50%;
opacity: 0.5; opacity: .5;
} }
.icon-full-text-disabled { .icon-full-text-disabled {
background-image: url('../img/nonfulltext.svg'); background-image: url('../img/nonfulltext.svg');
background-size: 50%; background-size: 50%;
opacity: 0.5; opacity: .5;
} }
#app-navigation .unread > a { #app-navigation .unread > a {
@ -134,10 +190,10 @@
white-space: nowrap; white-space: nowrap;
} }
// #app-navigation .error-message:hover .title #app-navigation .error-message:hover .title
// #app-navigation .error-message:hover .message { #app-navigation .error-message:hover .message {
// } }
#app-navigation .error-message button { #app-navigation .error-message button {
top: 0; top: 0;
@ -153,7 +209,7 @@
background-image: url('../img/close.svg'); background-image: url('../img/close.svg');
background-repeat: no-repeat; background-repeat: no-repeat;
background-position: right 5px top 5px; background-position: right 5px top 5px;
opacity: 0.9; opacity: .9;
} }
#app-navigation .error-message button:hover { #app-navigation .error-message button:hover {
@ -169,7 +225,7 @@
#app-navigation .animate-show.ng-hide-add-active, #app-navigation .animate-show.ng-hide-add-active,
#app-navigation .animate-show.ng-hide-remove-active { #app-navigation .animate-show.ng-hide-remove-active {
transition: 0.2s linear opacity; transition: .2s linear opacity;
} }
#app-navigation .animate-show { #app-navigation .animate-show {
@ -188,8 +244,8 @@
transform: rotate(180deg); transform: rotate(180deg);
} }
// #app-navigation .feed-normal-ordering { #app-navigation .feed-normal-ordering {
// } }
#app-navigation .icon-pinned { #app-navigation .icon-pinned {
background-image: url('../img/pinned.svg'); background-image: url('../img/pinned.svg');
@ -207,10 +263,6 @@
background-image: url('../img/updatemodeunread.svg'); background-image: url('../img/updatemodeunread.svg');
} }
#app-navigation .icon-arrow {
background-image: url('../img/arrow.svg');
}
#app-navigation .updateerror a { #app-navigation .updateerror a {
background-color: var(--color-warning) !important; background-color: var(--color-warning) !important;
} }

2
css/settings.css
View File

@ -36,7 +36,7 @@
padding-left: 18px; padding-left: 18px;
} }
#app-settings-content label input[type='checkbox'] { #app-settings-content label input[type="checkbox"] {
margin-left: -18px; margin-left: -18px;
max-width: 16px; max-width: 16px;
} }

4
css/shortcuts.css
View File

@ -1,5 +1,5 @@
// #app-shortcuts { #app-shortcuts {
// } }
#app-shortcuts table { #app-shortcuts table {
border-collapse: collapse; border-collapse: collapse;

11
docker/Dockerfile
View File

@ -1,11 +0,0 @@
# https://hub.docker.com/_/nextcloud/
FROM nextcloud:29-apache
#FROM ghcr.io/pbek/nextcloud-docker-pre-apache:latest
#FROM ghcr.io/digital-blueprint/nextcloud-docker-pre-apache:latest
COPY entrypoint.sh /
RUN deluser www-data
RUN useradd -u 1000 -ms /bin/bash www-data
RUN usermod -a -G www-data www-data
RUN mkdir /var/www/deploy

28
docker/Makefile
View File

@ -1,28 +0,0 @@
.PHONY: bash check-code show-log test build
# Try to use "docker compose" and fall back to "docker-compose" if not available
DOCKER_COMPOSE := $(shell docker compose > /dev/null && echo docker compose || echo docker-compose)
build:
$(DOCKER_COMPOSE) build
ls-db:
$(DOCKER_COMPOSE) run --rm app su -c "ls -hal data/mydb.db*" www-data
fetch-db:
$(DOCKER_COMPOSE) run --rm app su -c "cp data/mydb.db apps/news" www-data
push-db:
$(DOCKER_COMPOSE) run --rm app su -c "cp apps/news/mydb.db* data" www-data
bash:
$(DOCKER_COMPOSE) run --rm app su -c "bash" www-data
check-code:
$(DOCKER_COMPOSE) run --rm app su -c "./occ app:check-code news" www-data
show-log:
$(DOCKER_COMPOSE) run --rm app tail -f /var/www/html/data/nextcloud.log
#test:
# $(DOCKER_COMPOSE) run --rm app su -c "cd custom_apps/news && make test" www-data

29
docker/README.md
View File

@ -1,29 +0,0 @@
# Nextcloud Development Environment
## Installation / Running
```bash
make build
docker compose up
```
Afterward you should be able to open <http://localhost:8081/index.php/apps/news> (admin/admin) to
log in to your Nextcloud instance.
## Check nextcloud.log
For debugging, you can show the `nextcloud.log`:
```bash
make show-log
```
There also is a [logging web interface](http://localhost:8081/index.php/settings/admin/logging).
## Tip
In case something is broken try to reset the container:
```bash
docker compose build; docker compose down; docker volume rm nextcloud-news_nextcloud
```

19
docker/docker-compose.yml
View File

@ -1,19 +0,0 @@
name: nextcloud-news
services:
app:
build: .
ports:
- 8081:80
environment:
- NEXTCLOUD_ADMIN_USER=admin
- NEXTCLOUD_ADMIN_PASSWORD=admin
- SQLITE_DATABASE=mydb
- NEXTCLOUD_TRUSTED_DOMAINS=localhost 127.0.0.1
volumes:
- nextcloud:/var/www/html
- ..:/var/www/html/custom_apps/news
- ./news.config.php:/var/www/html/config/news.config.php
volumes:
nextcloud:

198
docker/entrypoint.sh
View File

@ -1,198 +0,0 @@
#!/bin/sh
set -eu
chown www-data:root /var/www/deploy
chown www-data:root /var/www/html/custom_apps
chown www-data:root /var/www/html/config
# version_greater A B returns whether A > B
version_greater() {
[ "$(printf '%s\n' "$@" | sort -t '.' -n -k1,1 -k2,2 -k3,3 -k4,4 | head -n 1)" != "$1" ]
}
# return true if specified directory is empty
directory_empty() {
[ -z "$(ls -A "$1/")" ]
}
run_as() {
if [ "$(id -u)" = 0 ]; then
su -p www-data -s /bin/sh -c "$1"
else
sh -c "$1"
fi
}
# usage: file_env VAR [DEFAULT]
# ie: file_env 'XYZ_DB_PASSWORD' 'example'
# (will allow for "$XYZ_DB_PASSWORD_FILE" to fill in the value of
# "$XYZ_DB_PASSWORD" from a file, especially for Docker's secrets feature)
file_env() {
local var="$1"
local fileVar="${var}_FILE"
local def="${2:-}"
local varValue=$(env | grep -E "^${var}=" | sed -E -e "s/^${var}=//")
local fileVarValue=$(env | grep -E "^${fileVar}=" | sed -E -e "s/^${fileVar}=//")
if [ -n "${varValue}" ] && [ -n "${fileVarValue}" ]; then
echo >&2 "error: both $var and $fileVar are set (but are exclusive)"
exit 1
fi
if [ -n "${varValue}" ]; then
export "$var"="${varValue}"
elif [ -n "${fileVarValue}" ]; then
export "$var"="$(cat "${fileVarValue}")"
elif [ -n "${def}" ]; then
export "$var"="$def"
fi
unset "$fileVar"
}
if expr "$1" : "apache" 1>/dev/null; then
if [ -n "${APACHE_DISABLE_REWRITE_IP+x}" ]; then
a2disconf remoteip
fi
fi
if expr "$1" : "apache" 1>/dev/null || [ "$1" = "php-fpm" ] || [ "${NEXTCLOUD_UPDATE:-0}" -eq 1 ]; then
if [ -n "${REDIS_HOST+x}" ]; then
echo "Configuring Redis as session handler"
{
echo 'session.save_handler = redis'
# check if redis host is an unix socket path
if [ "$(echo "$REDIS_HOST" | cut -c1-1)" = "/" ]; then
if [ -n "${REDIS_HOST_PASSWORD+x}" ]; then
echo "session.save_path = \"unix://${REDIS_HOST}?auth=${REDIS_HOST_PASSWORD}\""
else
echo "session.save_path = \"unix://${REDIS_HOST}\""
fi
# check if redis password has been set
elif [ -n "${REDIS_HOST_PASSWORD+x}" ]; then
echo "session.save_path = \"tcp://${REDIS_HOST}:${REDIS_HOST_PORT:=6379}?auth=${REDIS_HOST_PASSWORD}\""
else
echo "session.save_path = \"tcp://${REDIS_HOST}:${REDIS_HOST_PORT:=6379}\""
fi
} > /usr/local/etc/php/conf.d/redis-session.ini
fi
installed_version="0.0.0.0"
if [ -f /var/www/html/version.php ]; then
# shellcheck disable=SC2016
installed_version="$(php -r 'require "/var/www/html/version.php"; echo implode(".", $OC_Version);')"
fi
# shellcheck disable=SC2016
image_version="$(php -r 'require "/usr/src/nextcloud/version.php"; echo implode(".", $OC_Version);')"
if version_greater "$installed_version" "$image_version"; then
echo "Can't start Nextcloud because the version of the data ($installed_version) is higher than the docker image version ($image_version) and downgrading is not supported. Are you sure you have pulled the newest image version?"
exit 1
fi
if version_greater "$image_version" "$installed_version"; then
echo "Initializing nextcloud $image_version ..."
if [ "$installed_version" != "0.0.0.0" ]; then
echo "Upgrading nextcloud from $installed_version ..."
run_as 'php /var/www/html/occ app:list' | sed -n "/Enabled:/,/Disabled:/p" > /tmp/list_before
fi
if [ "$(id -u)" = 0 ]; then
rsync_options="-rlDog --chown www-data:root"
else
rsync_options="-rlD"
fi
rsync $rsync_options --delete --exclude-from=/upgrade.exclude /usr/src/nextcloud/ /var/www/html/
for dir in config data custom_apps themes; do
if [ ! -d "/var/www/html/$dir" ] || directory_empty "/var/www/html/$dir"; then
rsync $rsync_options --include "/$dir/" --exclude '/*' /usr/src/nextcloud/ /var/www/html/
fi
done
rsync $rsync_options --include '/version.php' --exclude '/*' /usr/src/nextcloud/ /var/www/html/
echo "Initializing finished"
#install
if [ "$installed_version" = "0.0.0.0" ]; then
echo "New nextcloud instance"
file_env NEXTCLOUD_ADMIN_PASSWORD
file_env NEXTCLOUD_ADMIN_USER
if [ -n "${NEXTCLOUD_ADMIN_USER+x}" ] && [ -n "${NEXTCLOUD_ADMIN_PASSWORD+x}" ]; then
# shellcheck disable=SC2016
install_options='-n --admin-user "$NEXTCLOUD_ADMIN_USER" --admin-pass "$NEXTCLOUD_ADMIN_PASSWORD"'
if [ -n "${NEXTCLOUD_DATA_DIR+x}" ]; then
# shellcheck disable=SC2016
install_options=$install_options' --data-dir "$NEXTCLOUD_DATA_DIR"'
fi
file_env MYSQL_DATABASE
file_env MYSQL_PASSWORD
file_env MYSQL_USER
file_env POSTGRES_DB
file_env POSTGRES_PASSWORD
file_env POSTGRES_USER
install=false
if [ -n "${SQLITE_DATABASE+x}" ]; then
echo "Installing with SQLite database"
# shellcheck disable=SC2016
install_options=$install_options' --database-name "$SQLITE_DATABASE"'
install=true
elif [ -n "${MYSQL_DATABASE+x}" ] && [ -n "${MYSQL_USER+x}" ] && [ -n "${MYSQL_PASSWORD+x}" ] && [ -n "${MYSQL_HOST+x}" ]; then
echo "Installing with MySQL database"
# shellcheck disable=SC2016
install_options=$install_options' --database mysql --database-name "$MYSQL_DATABASE" --database-user "$MYSQL_USER" --database-pass "$MYSQL_PASSWORD" --database-host "$MYSQL_HOST"'
install=true
elif [ -n "${POSTGRES_DB+x}" ] && [ -n "${POSTGRES_USER+x}" ] && [ -n "${POSTGRES_PASSWORD+x}" ] && [ -n "${POSTGRES_HOST+x}" ]; then
echo "Installing with PostgreSQL database"
# shellcheck disable=SC2016
install_options=$install_options' --database pgsql --database-name "$POSTGRES_DB" --database-user "$POSTGRES_USER" --database-pass "$POSTGRES_PASSWORD" --database-host "$POSTGRES_HOST"'
install=true
fi
if [ "$install" = true ]; then
echo "starting nextcloud installation"
max_retries=10
try=0
until run_as "php /var/www/html/occ maintenance:install $install_options" || [ "$try" -gt "$max_retries" ]
do
echo "retrying install..."
try=$((try+1))
sleep 10s
done
if [ "$try" -gt "$max_retries" ]; then
echo "installing of nextcloud failed!"
exit 1
fi
if [ -n "${NEXTCLOUD_TRUSTED_DOMAINS+x}" ]; then
echo "setting trusted domains…"
NC_TRUSTED_DOMAIN_IDX=1
for DOMAIN in $NEXTCLOUD_TRUSTED_DOMAINS ; do
DOMAIN=$(echo "$DOMAIN" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
run_as "php /var/www/html/occ config:system:set trusted_domains $NC_TRUSTED_DOMAIN_IDX --value=$DOMAIN"
NC_TRUSTED_DOMAIN_IDX=$(($NC_TRUSTED_DOMAIN_IDX+1))
done
fi
else
echo "running web-based installer on first connect!"
fi
fi
#upgrade
else
run_as 'php /var/www/html/occ upgrade'
run_as 'php /var/www/html/occ app:list' | sed -n "/Enabled:/,/Disabled:/p" > /tmp/list_after
echo "The following apps have been disabled:"
diff /tmp/list_before /tmp/list_after | grep '<' | cut -d- -f2 | cut -d: -f1
rm -f /tmp/list_before /tmp/list_after
fi
fi
# if we get an error "ln: /var/www/html/apps/news: cannot overwrite directory" we need to remove that directory in the container
run_as 'rm -Rf /var/www/html/apps/news'
run_as 'ln -sfT /var/www/html/custom_apps/news /var/www/html/apps/news'
run_as "php /var/www/html/occ app:enable news"
fi
exec "$@"

1
docker/news.config.php
View File

@ -1 +0,0 @@
<?php declare(strict_types=1);

45
docs/admin.md
View File

@ -1,32 +1,10 @@
# Admin # Admin
Welcome to the Admin documentation this page explains some of the configuration options for news.
Welcome to the Admin documentation. ## System Cron
## Administration via OCC
News integrates with Nextclouds command line tool occ.
To get an overview over the available commands simply execute `./occ list news`
In most environments you will have to call occ like this:
```bash
sudo -u www-data php ./occ list news
```
More information about occ here: [Nextcloud Admin Manual](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html)
## Settings
The following sections explain some of the more complicated settings on the admin page.
### System Cron
Nextcloud uses cron to run regular jobs, News relies on the Job system to execute the feed updates. Nextcloud uses cron to run regular jobs, News relies on the Job system to execute the feed updates.
Alternatively you may use an [external updater](https://nextcloud.github.io/news/clients/#update-clients), in this case you need to disable the system cron in the settings. Alternatively you may use an [external updater](https://nextcloud.github.io/news/clients/#update-clients), in this case you need to disable the system cron in the settings.
### Auto purge count ## Auto purge count
- The default value is 200. - The default value is 200.
- To disable this feature, use -1. - To disable this feature, use -1.
- Unread and starred items are not deleted. - Unread and starred items are not deleted.
@ -39,35 +17,30 @@ In this case the limit will be 210 instead of 200, for that feed.
This is needed to prevent items from reappearing in the feed. This is needed to prevent items from reappearing in the feed.
### Purge unread items ## Purge unread items
This changes the behavior of the auto purging to also purge unread items. This is useful if you have users with a lot of unread items. This changes the behavior of the auto purging to also purge unread items. This is useful if you have users with a lot of unread items.
**Starred items are always kept.** **Starred items are always kept.**
### Explore Service ## Explore Service
If you are using the News app in your company/community, it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and up-vote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker). If you are using the News app in your company/community, it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and up-vote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker).
The URL should be a path to a directory which contains a JSON file in the format of **feeds.LANG_CODE.json** where LANG_CODE is a two character language code (e.g. **en** or **de**). The URL should be a path to a directory which contains a JSON file in the format of **feeds.LANG_CODE.json** where LANG_CODE is a two character language code (e.g. **en** or **de**).
For example, entering the URL **<https://domain.com/directory>** as explore URL will produce the following request for German users: For example, entering the URL **https://domain.com/directory** as explore URL will produce the following request for German users:
GET https://domain.com/directory/feeds.de.json GET https://domain.com/directory/feeds.de.json
**Do not forget to implement [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) in your API, otherwise the request will fail!** **Do not forget to implement [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) in your API, otherwise the request will fail!**
### Update Interval ## Update Interval
The update interval is used to determine when the next update of all feeds should be done. The update interval is used to determine when the next update of all feeds should be done.
By default, the value is set to 3600 seconds (1 hour) You can configure this interval as an administrator. By default, the value is set to 3600 seconds (1 hour) You can configure this interval as an administrator.
The new value is only applied after the next run of the updater. The new value is only applied after the next run of the updater.
#### What is a good update interval? ### What is a good update interval?
That depends on your individual needs. That depends on your individual needs.
Please keep in mind that the lower you set your update interval, the more traffic is generated. Please keep in mind that the lower you set your update interval, the more traffic is generated.
#### Can I set individual update intervals per feed/user? ### Can I set individual update intervals per feed/user?
No, that is not possible. No, that is not possible.

193
docs/api/api-v1-2.md
View File

@ -23,7 +23,6 @@ You have to design your app with these things in mind!:
* **Use a library to compare versions, ideally one that uses semantic versioning** * **Use a library to compare versions, ideally one that uses semantic versioning**
## Authentication & Basics ## Authentication & Basics
Because REST is stateless you have to send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**. Because REST is stateless you have to send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**.
The base URL for all calls is: The base URL for all calls is:
@ -43,13 +42,11 @@ where $CREDENTIALS is:
base64(USER:PASSWORD) base64(USER:PASSWORD)
## How To Sync ## How To Sync
This is a small overview over how you should sync your articles with the Nextcloud News app. For more fine-grained details about the API see further down. This is a small overview over how you should sync your articles with the Nextcloud News app. For more fine-grained details about the API see further down.
All routes are given relative to the base API url (e.g.: <https://yournextcloud.com/index.php/apps/news/api/v1-2>) All routes are given relative to the base API url (e.g.: https://yournextcloud.com/index.php/apps/news/api/v1-2)
### Initial Sync ### Initial Sync
The intial sync happens, when a user adds a Nextcloud account in your app. In that case you should fetch all feeds, folders and unread or starred articles from the News app. Do not fetch all articles, not only because it syncs faster, but also because the user is primarily interested in unread articles. To fetch all unread and starred articles, you must call 4 routes: The intial sync happens, when a user adds a Nextcloud account in your app. In that case you should fetch all feeds, folders and unread or starred articles from the News app. Do not fetch all articles, not only because it syncs faster, but also because the user is primarily interested in unread articles. To fetch all unread and starred articles, you must call 4 routes:
* **unread articles**: GET /items?type=3&getRead=false&batchSize=-1 * **unread articles**: GET /items?type=3&getRead=false&batchSize=-1
@ -60,7 +57,6 @@ The intial sync happens, when a user adds a Nextcloud account in your app. In th
The JSON response structures can be viewed further down. The JSON response structures can be viewed further down.
### Syncing ### Syncing
When syncing, you want to push read/unread and starred/unstarred items to the server and receive new and updated items, feeds and folders. To do that, call the following routes: When syncing, you want to push read/unread and starred/unstarred items to the server and receive new and updated items, feeds and folders. To do that, call the following routes:
* **Notify the News app of unread articles**: PUT /items/unread/multiple {"items": [1, 3, 5] } * **Notify the News app of unread articles**: PUT /items/unread/multiple {"items": [1, 3, 5] }
@ -71,6 +67,7 @@ When syncing, you want to push read/unread and starred/unstarred items to the se
* **Get new feeds**: GET /feeds * **Get new feeds**: GET /feeds
* **Get new items and modified items**: GET /items/updated?lastModified=12123123123&type=3 * **Get new items and modified items**: GET /items/updated?lastModified=12123123123&type=3
## Accessing API from a web application ## Accessing API from a web application
**News 1.401** implements CORS which allows web applications to access the API. **To access the API in a webapp you need to send the correct authorization header instead of simply putting auth data into the URL!**. An example request in jQuery would look like this: **News 1.401** implements CORS which allows web applications to access the API. **To access the API in a webapp you need to send the correct authorization header instead of simply putting auth data into the URL!**. An example request in jQuery would look like this:
@ -94,9 +91,7 @@ $.ajax({
} }
}); });
``` ```
An example with AngularJS would look like this: An example with AngularJS would look like this:
```js ```js
angular.module('YourApp', []) angular.module('YourApp', [])
.config(['$httpProvider', '$provide', function ($httpProvider, $provide) { .config(['$httpProvider', '$provide', function ($httpProvider, $provide) {
@ -134,17 +129,14 @@ angular.module('YourApp', [])
``` ```
## Input ## Input
In general the input parameters can be in the URL or request body, the App Framework doesnt differentiate between them. In general the input parameters can be in the URL or request body, the App Framework doesnt differentiate between them.
So JSON in the request body like: So JSON in the request body like:
```jsonc
```json
{ {
"id": 3 "id": 3
} }
``` ```
will be treated the same as will be treated the same as
/?id=3 /?id=3
@ -157,13 +149,11 @@ It is recommended though that you use the following convention:
* **DELETE**: parameters as JSON in the request body * **DELETE**: parameters as JSON in the request body
## Output ## Output
The output is JSON. The output is JSON.
## API Endpoints ## API Endpoints
### Folders ### Folders
#### Get all folders #### Get all folders
* **Status**: Implemented * **Status**: Implemented
@ -171,8 +161,7 @@ The output is JSON.
* **Route**: /folders * **Route**: /folders
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"folders": [ "folders": [
{ {
@ -184,26 +173,22 @@ The output is JSON.
``` ```
#### Create a folder #### Create a folder
Creates a new folder and returns a new folder object Creates a new folder and returns a new folder object
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /folders * **Route**: /folders
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"name": "folder name" "name": "folder name"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the folder exists already * **HTTP 409**: If the folder exists already
* **HTTP 422**: If the folder name is invalid (for instance empty) * **HTTP 422**: If the folder name is invalid (for instance empty)
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"folders": [ "folders": [
{ {
@ -215,7 +200,6 @@ Creates a new folder and returns a new folder object
``` ```
#### Delete a folder #### Delete a folder
Deletes a folder with the id folderId and all the feeds it contains Deletes a folder with the id folderId and all the feeds it contains
* **Status**: Implemented * **Status**: Implemented
@ -223,28 +207,25 @@ Deletes a folder with the id folderId and all the feeds it contains
* **Route**: /folders/{folderId} * **Route**: /folders/{folderId}
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the folder does not exist * **HTTP 404**: If the folder does not exist
* **Returns**: nothing * **Returns**: nothing
#### Rename a folder #### Rename a folder
Only the name can be updated Only the name can be updated
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /folders/{folderId} * **Route**: /folders/{folderId}
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"name": "folder name" "name": "folder name"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the folder name does already exist * **HTTP 409**: If the folder name does already exist
* **HTTP 404**: If the folder does not exist * **HTTP 404**: If the folder does not exist
* **HTTP 422**: If the folder name is invalid (for instance empty) * **HTTP 422**: If the folder name is invalid (for instance empty)
* **Returns**: nothing * **Returns**: nothing
#### Mark items of a folder as read #### Mark items of a folder as read
@ -253,17 +234,15 @@ Only the name can be updated
* **Method**: PUT * **Method**: PUT
* **Route**: /folders/{folderId}/read * **Route**: /folders/{folderId}/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Feeds ### Feeds
@ -282,8 +261,7 @@ The following attributes are **not sanitized** meaning: including them in your w
* **Route**: /feeds * **Route**: /feeds
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -312,27 +290,23 @@ The following attributes are **not sanitized** meaning: including them in your w
``` ```
#### Create a feed #### Create a feed
Creates a new feed and returns the feed Creates a new feed and returns the feed
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /feeds * **Route**: /feeds
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"url": "http:\/\/www.cyanogenmod.org\/wp-content\/themes\/cyanogenmod\/images\/favicon.ico", "url": "http:\/\/www.cyanogenmod.org\/wp-content\/themes\/cyanogenmod\/images\/favicon.ico",
"folderId": 81 // id of the parent folder, null for root "folderId": 81 // id of the parent folder, null for root
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the feed exists already * **HTTP 409**: If the feed exists already
* **HTTP 422**: If the feed cant be read (most likely contains errors) * **HTTP 422**: If the feed cant be read (most likely contains errors)
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -353,7 +327,6 @@ Creates a new feed and returns the feed
``` ```
#### Delete a feed #### Delete a feed
Deletes a feed with the id feedId and all of its items Deletes a feed with the id feedId and all of its items
* **Status**: Implemented * **Status**: Implemented
@ -361,7 +334,7 @@ Deletes a feed with the id feedId and all of its items
* **Route**: /feeds/{feedId} * **Route**: /feeds/{feedId}
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Move a feed to a different folder #### Move a feed to a different folder
@ -370,15 +343,13 @@ Deletes a feed with the id feedId and all of its items
* **Method**: PUT * **Method**: PUT
* **Route**: /feeds/{feedId}/move * **Route**: /feeds/{feedId}/move
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"folderId": null // id of the parent folder, null for root "folderId": null // id of the parent folder, null for root
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Rename a feed #### Rename a feed
@ -387,15 +358,13 @@ Deletes a feed with the id feedId and all of its items
* **Method**: PUT * **Method**: PUT
* **Route**: /feeds/{feedId}/rename * **Route**: /feeds/{feedId}/rename
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"feedTitle": "New Title" "feedTitle": "New Title"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark items of a feed as read #### Mark items of a feed as read
@ -404,19 +373,18 @@ Deletes a feed with the id feedId and all of its items
* **Method**: PUT * **Method**: PUT
* **Route**: /feeds/{feedId}/read * **Route**: /feeds/{feedId}/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Items ### Items
#### Sanitation #### Sanitation
@ -432,7 +400,6 @@ The following attributes are **not sanitized** meaning: including them in your w
* **mediaDescription** * **mediaDescription**
#### Types #### Types
| Name | Default | Types | | Name | Default | Types |
|------------------|---------|--------------| |------------------|---------|--------------|
| author | null | string\|null | | author | null | string\|null |
@ -457,13 +424,11 @@ The following attributes are **not sanitized** meaning: including them in your w
| url | | string\|null | | url | | string\|null |
#### Get items #### Get items
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
* **Route**: /items * **Route**: /items
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"batchSize": 10, // the number of items that should be returned, defaults to -1, new in 5.2.3: -1 returns all items "batchSize": 10, // the number of items that should be returned, defaults to -1, new in 5.2.3: -1 returns all items
"offset": 30, // only return older (lower than equal that id) items than the one with id 30 "offset": 30, // only return older (lower than equal that id) items than the one with id 30
@ -473,10 +438,8 @@ The following attributes are **not sanitized** meaning: including them in your w
"oldestFirst": false // implemented in 3.002, if true it reverse the sort order "oldestFirst": false // implemented in 3.002, if true it reverse the sort order
} }
``` ```
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -504,14 +467,12 @@ The following attributes are **not sanitized** meaning: including them in your w
``` ```
##### Example ##### Example
Autopaging would work like this: Autopaging would work like this:
* Get the **first 20** items from a feed with **id 12** * Get the **first 20** items from a feed with **id 12**
**GET /items**: **GET /items**:
```jsonc
```json
{ {
"batchSize": 20, "batchSize": 20,
"offset": 0, "offset": 0,
@ -525,7 +486,7 @@ The item with the lowest item id is 43.
* Get the next **20** items: **GET /items**: * Get the next **20** items: **GET /items**:
```json ```jsonc
{ {
"batchSize": 20, "batchSize": 20,
"offset": 43, "offset": 43,
@ -535,16 +496,15 @@ The item with the lowest item id is 43.
} }
``` ```
#### Get updated items
#### Get updated items
This is used to stay up to date. This is used to stay up to date.
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
* **Route**: /items/updated * **Route**: /items/updated
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"lastModified": 123231, // returns only items with a lastModified timestamp >= than this one "lastModified": 123231, // returns only items with a lastModified timestamp >= than this one
// this may also return already existing items whose read or starred status // this may also return already existing items whose read or starred status
@ -553,10 +513,8 @@ This is used to stay up to date.
"id": 12 // the id of the folder or feed, Use 0 for Starred and All "id": 12 // the id of the folder or feed, Use 0 for Starred and All
} }
``` ```
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -581,73 +539,62 @@ This is used to stay up to date.
``` ```
#### Mark an item as read #### Mark an item as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{itemId}/read * **Route**: /items/{itemId}/read
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as read #### Mark multiple items as read
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/read/multiple * **Route**: /items/read/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"items": [2, 3] // ids of the items "items": [2, 3] // ids of the items
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as unread #### Mark an item as unread
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{itemId}/unread * **Route**: /items/{itemId}/unread
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as unread #### Mark multiple items as unread
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/unread/multiple * **Route**: /items/unread/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"items": [2, 3] // ids of the items "items": [2, 3] // ids of the items
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as starred #### Mark an item as starred
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{feedId}/{guidHash}/star * **Route**: /items/{feedId}/{guidHash}/star
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as starred #### Mark multiple items as starred
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/star/multiple * **Route**: /items/star/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -657,27 +604,23 @@ This is used to stay up to date.
] ]
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as unstarred #### Mark an item as unstarred
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /items/{feedId}/{guidHash}/unstar * **Route**: /items/{feedId}/{guidHash}/unstar
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as unstarred #### Mark multiple items as unstarred
* **Status**: Implemented in 1.2 * **Status**: Implemented in 1.2
* **Method**: PUT * **Method**: PUT
* **Route**: /items/unstar/multiple * **Route**: /items/unstar/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -687,7 +630,6 @@ This is used to stay up to date.
] ]
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark all items as read #### Mark all items as read
@ -696,19 +638,18 @@ This is used to stay up to date.
* **Method**: PUT * **Method**: PUT
* **Route**: /items/read * **Route**: /items/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Updater ### Updater
To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created. To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created.
@ -723,7 +664,6 @@ Updating should be done in the following fashion:
This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it. This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it.
#### Trigger cleanup before update #### Trigger cleanup before update
This is used to clean up the database. It deletes folders and feeds that are marked for deletion This is used to clean up the database. It deletes folders and feeds that are marked for deletion
* **Status**: Implemented in 1.601 * **Status**: Implemented in 1.601
@ -734,9 +674,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:before-update
php -f nextcloud/occ news:updater:before-update
```
#### Get feed ids and usernames for all feeds #### Get feed ids and usernames for all feeds
@ -746,8 +684,7 @@ php -f nextcloud/occ news:updater:before-update
* **Route**: /feeds/all * **Route**: /feeds/all
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -760,9 +697,8 @@ php -f nextcloud/occ news:updater:before-update
**New in 8.1.0, Removed in 16.0.0**: The console command for achieving the same result is: **New in 8.1.0, Removed in 16.0.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:all-feeds
php -f nextcloud/occ news:updater:all-feeds
```
#### Trigger a feed update #### Trigger a feed update
@ -771,26 +707,21 @@ php -f nextcloud/occ news:updater:all-feeds
* **Method**: GET * **Method**: GET
* **Route**: /feeds/update * **Route**: /feeds/update
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"userId": "john", "userId": "john",
"feedId": 3 "feedId": 3
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: Nothing * **Returns**: Nothing
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:update-feed 3 john
php -f nextcloud/occ news:updater:update-feed 3 john
```
#### Trigger cleanup after update #### Trigger cleanup after update
This is used to clean up the database. It removes old read articles which are not starred This is used to clean up the database. It removes old read articles which are not starred
* **Status**: Implemented in 1.601 * **Status**: Implemented in 1.601
@ -801,9 +732,7 @@ This is used to clean up the database. It removes old read articles which are no
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:after-update
php -f nextcloud/occ news:updater:after-update
```
### Version ### Version
@ -814,8 +743,7 @@ php -f nextcloud/occ news:updater:after-update
* **Route**: /version * **Route**: /version
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"version": "5.2.3" "version": "5.2.3"
} }
@ -832,8 +760,7 @@ This API can be used to display warnings and errors in your client if the web ap
* **Route**: /status * **Route**: /status
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"version": "5.2.4", "version": "5.2.4",
"warnings": { "warnings": {
@ -859,9 +786,8 @@ If **incorrectDbCharset** is true you should display a warning that database cha
This API can be used to retrieve metadata about the current user. This API can be used to retrieve metadata about the current user.
DEPRECATED: This API is deprecated, use the Nextcloud APIs instead. DEPRECATED: This API is deprecated, use the Nextcloud APIs instead.
- https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata for user data
* <https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata> for user data - `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar
* `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar
#### Get the status #### Get the status
@ -870,8 +796,7 @@ DEPRECATED: This API is deprecated, use the Nextcloud APIs instead.
* **Route**: /user * **Route**: /user
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"userId": "john", "userId": "john",
"displayName": "John Doe", "displayName": "John Doe",

193
docs/api/api-v1-3.md
View File

@ -23,7 +23,6 @@ You have to design your app with these things in mind!:
* **Use a library to compare versions, ideally one that uses semantic versioning** * **Use a library to compare versions, ideally one that uses semantic versioning**
## Authentication & Basics ## Authentication & Basics
Because REST is stateless you have to send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**. Because REST is stateless you have to send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**.
The base URL for all calls is: The base URL for all calls is:
@ -43,13 +42,11 @@ where $CREDENTIALS is:
base64(USER:PASSWORD) base64(USER:PASSWORD)
## How To Sync ## How To Sync
This is a small overview over how you should sync your articles with the Nextcloud News app. For more fine-grained details about the API see further down. This is a small overview over how you should sync your articles with the Nextcloud News app. For more fine-grained details about the API see further down.
All routes are given relative to the base API url (e.g.: <https://yournextcloud.com/index.php/apps/news/api/v1-3>) All routes are given relative to the base API url (e.g.: https://yournextcloud.com/index.php/apps/news/api/v1-3)
### Initial Sync ### Initial Sync
The intial sync happens, when a user adds a Nextcloud account in your app. In that case you should fetch all feeds, folders and unread or starred articles from the News app. Do not fetch all articles, not only because it syncs faster, but also because the user is primarily interested in unread articles. To fetch all unread and starred articles, you must call 4 routes: The intial sync happens, when a user adds a Nextcloud account in your app. In that case you should fetch all feeds, folders and unread or starred articles from the News app. Do not fetch all articles, not only because it syncs faster, but also because the user is primarily interested in unread articles. To fetch all unread and starred articles, you must call 4 routes:
* **unread articles**: GET /items?type=3&getRead=false&batchSize=-1 * **unread articles**: GET /items?type=3&getRead=false&batchSize=-1
@ -60,7 +57,6 @@ The intial sync happens, when a user adds a Nextcloud account in your app. In th
The JSON response structures can be viewed further down. The JSON response structures can be viewed further down.
### Syncing ### Syncing
When syncing, you want to push read/unread and starred/unstarred items to the server and receive new and updated items, feeds and folders. To do that, call the following routes: When syncing, you want to push read/unread and starred/unstarred items to the server and receive new and updated items, feeds and folders. To do that, call the following routes:
* **Notify the News app of unread articles**: PUT /items/unread/multiple {"items": [1, 3, 5]} * **Notify the News app of unread articles**: PUT /items/unread/multiple {"items": [1, 3, 5]}
@ -71,6 +67,7 @@ When syncing, you want to push read/unread and starred/unstarred items to the se
* **Get new feeds**: GET /feeds * **Get new feeds**: GET /feeds
* **Get new items and modified items**: GET /items/updated?lastModified=12123123123&type=3 * **Get new items and modified items**: GET /items/updated?lastModified=12123123123&type=3
## Accessing API from a web application ## Accessing API from a web application
**News 1.401** implements CORS which allows web applications to access the API. **To access the API in a webapp you need to send the correct authorization header instead of simply putting auth data into the URL!**. An example request in jQuery would look like this: **News 1.401** implements CORS which allows web applications to access the API. **To access the API in a webapp you need to send the correct authorization header instead of simply putting auth data into the URL!**. An example request in jQuery would look like this:
@ -94,9 +91,7 @@ $.ajax({
} }
}); });
``` ```
An example with AngularJS would look like this: An example with AngularJS would look like this:
```js ```js
angular.module('YourApp', []) angular.module('YourApp', [])
.config(['$httpProvider', '$provide', function ($httpProvider, $provide) { .config(['$httpProvider', '$provide', function ($httpProvider, $provide) {
@ -134,17 +129,14 @@ angular.module('YourApp', [])
``` ```
## Input ## Input
In general the input parameters can be in the URL or request body, the App Framework doesnt differentiate between them. In general the input parameters can be in the URL or request body, the App Framework doesnt differentiate between them.
So JSON in the request body like: So JSON in the request body like:
```jsonc
```json
{ {
"id": 3 "id": 3
} }
``` ```
will be treated the same as will be treated the same as
/?id=3 /?id=3
@ -157,13 +149,11 @@ It is recommended though that you use the following convention:
* **DELETE**: parameters as JSON in the request body * **DELETE**: parameters as JSON in the request body
## Output ## Output
The output is JSON. The output is JSON.
## API Endpoints ## API Endpoints
### Folders ### Folders
#### Get all folders #### Get all folders
* **Status**: Implemented * **Status**: Implemented
@ -171,8 +161,7 @@ The output is JSON.
* **Route**: /folders * **Route**: /folders
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"folders": [ "folders": [
{ {
@ -184,26 +173,22 @@ The output is JSON.
``` ```
#### Create a folder #### Create a folder
Creates a new folder and returns a new folder object Creates a new folder and returns a new folder object
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /folders * **Route**: /folders
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"name": "folder name" "name": "folder name"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the folder exists already * **HTTP 409**: If the folder exists already
* **HTTP 422**: If the folder name is invalid (for instance empty) * **HTTP 422**: If the folder name is invalid (for instance empty)
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"folders": [ "folders": [
{ {
@ -215,7 +200,6 @@ Creates a new folder and returns a new folder object
``` ```
#### Delete a folder #### Delete a folder
Deletes a folder with the id folderId and all the feeds it contains Deletes a folder with the id folderId and all the feeds it contains
* **Status**: Implemented * **Status**: Implemented
@ -223,28 +207,25 @@ Deletes a folder with the id folderId and all the feeds it contains
* **Route**: /folders/{folderId} * **Route**: /folders/{folderId}
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the folder does not exist * **HTTP 404**: If the folder does not exist
* **Returns**: nothing * **Returns**: nothing
#### Rename a folder #### Rename a folder
Only the name can be updated Only the name can be updated
* **Status**: Implemented * **Status**: Implemented
* **Method**: PUT * **Method**: PUT
* **Route**: /folders/{folderId} * **Route**: /folders/{folderId}
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"name": "folder name" "name": "folder name"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the folder name does already exist * **HTTP 409**: If the folder name does already exist
* **HTTP 404**: If the folder does not exist * **HTTP 404**: If the folder does not exist
* **HTTP 422**: If the folder name is invalid (for instance empty) * **HTTP 422**: If the folder name is invalid (for instance empty)
* **Returns**: nothing * **Returns**: nothing
#### Mark items of a folder as read #### Mark items of a folder as read
@ -253,17 +234,15 @@ Only the name can be updated
* **Method**: POST * **Method**: POST
* **Route**: /folders/{folderId}/read * **Route**: /folders/{folderId}/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Feeds ### Feeds
@ -282,8 +261,7 @@ The following attributes are **not sanitized** meaning: including them in your w
* **Route**: /feeds * **Route**: /feeds
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -312,27 +290,23 @@ The following attributes are **not sanitized** meaning: including them in your w
``` ```
#### Create a feed #### Create a feed
Creates a new feed and returns the feed Creates a new feed and returns the feed
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /feeds * **Route**: /feeds
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"url": "http:\/\/www.cyanogenmod.org\/wp-content\/themes\/cyanogenmod\/images\/favicon.ico", "url": "http:\/\/www.cyanogenmod.org\/wp-content\/themes\/cyanogenmod\/images\/favicon.ico",
"folderId": 81 // id of the parent folder, null for root "folderId": 81 // id of the parent folder, null for root
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 409**: If the feed exists already * **HTTP 409**: If the feed exists already
* **HTTP 422**: If the feed cant be read (most likely contains errors) * **HTTP 422**: If the feed cant be read (most likely contains errors)
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -353,7 +327,6 @@ Creates a new feed and returns the feed
``` ```
#### Delete a feed #### Delete a feed
Deletes a feed with the id feedId and all of its items Deletes a feed with the id feedId and all of its items
* **Status**: Implemented * **Status**: Implemented
@ -361,7 +334,7 @@ Deletes a feed with the id feedId and all of its items
* **Route**: /feeds/{feedId} * **Route**: /feeds/{feedId}
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Move a feed to a different folder #### Move a feed to a different folder
@ -370,15 +343,13 @@ Deletes a feed with the id feedId and all of its items
* **Method**: POST * **Method**: POST
* **Route**: /feeds/{feedId}/move * **Route**: /feeds/{feedId}/move
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"folderId": null // id of the parent folder, null for root "folderId": null // id of the parent folder, null for root
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Rename a feed #### Rename a feed
@ -387,15 +358,13 @@ Deletes a feed with the id feedId and all of its items
* **Method**: POST * **Method**: POST
* **Route**: /feeds/{feedId}/rename * **Route**: /feeds/{feedId}/rename
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"feedTitle": "New Title" "feedTitle": "New Title"
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark items of a feed as read #### Mark items of a feed as read
@ -404,19 +373,18 @@ Deletes a feed with the id feedId and all of its items
* **Method**: POST * **Method**: POST
* **Route**: /feeds/{feedId}/read * **Route**: /feeds/{feedId}/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Items ### Items
#### Sanitation #### Sanitation
@ -432,7 +400,6 @@ The following attributes are **not sanitized** meaning: including them in your w
* **mediaDescription** * **mediaDescription**
#### Types #### Types
| Name | Default | Types | | Name | Default | Types |
|------------------|---------|--------------| |------------------|---------|--------------|
| author | null | string\|null | | author | null | string\|null |
@ -457,13 +424,11 @@ The following attributes are **not sanitized** meaning: including them in your w
| url | | string\|null | | url | | string\|null |
#### Get items #### Get items
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
* **Route**: /items * **Route**: /items
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"batchSize": 10, // the number of items that should be returned, defaults to -1, new in 5.2.3: -1 returns all items "batchSize": 10, // the number of items that should be returned, defaults to -1, new in 5.2.3: -1 returns all items
"offset": 30, // only return older (lower than equal that id) items than the one with id 30 "offset": 30, // only return older (lower than equal that id) items than the one with id 30
@ -473,10 +438,8 @@ The following attributes are **not sanitized** meaning: including them in your w
"oldestFirst": false // implemented in 3.002, if true it reverse the sort order "oldestFirst": false // implemented in 3.002, if true it reverse the sort order
} }
``` ```
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -504,14 +467,12 @@ The following attributes are **not sanitized** meaning: including them in your w
``` ```
##### Example ##### Example
Autopaging would work like this: Autopaging would work like this:
* Get the **first 20** items from a feed with **id 12** * Get the **first 20** items from a feed with **id 12**
**GET /items**: **GET /items**:
```jsonc
```json
{ {
"batchSize": 20, "batchSize": 20,
"offset": 0, "offset": 0,
@ -525,7 +486,7 @@ The item with the lowest item id is 43.
* Get the next **20** items: **GET /items**: * Get the next **20** items: **GET /items**:
```json ```jsonc
{ {
"batchSize": 20, "batchSize": 20,
"offset": 43, "offset": 43,
@ -535,16 +496,15 @@ The item with the lowest item id is 43.
} }
``` ```
#### Get updated items
#### Get updated items
This is used to stay up to date. This is used to stay up to date.
* **Status**: Implemented * **Status**: Implemented
* **Method**: GET * **Method**: GET
* **Route**: /items/updated * **Route**: /items/updated
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"lastModified": 123231, // returns only items with a lastModified timestamp >= than this one "lastModified": 123231, // returns only items with a lastModified timestamp >= than this one
// this may also return already existing items whose read or starred status // this may also return already existing items whose read or starred status
@ -553,10 +513,8 @@ This is used to stay up to date.
"id": 12 // the id of the folder or feed, Use 0 for Starred and All "id": 12 // the id of the folder or feed, Use 0 for Starred and All
} }
``` ```
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"items": [ "items": [
{ {
@ -581,103 +539,87 @@ This is used to stay up to date.
``` ```
#### Mark an item as read #### Mark an item as read
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /items/{itemId}/read * **Route**: /items/{itemId}/read
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as read #### Mark multiple items as read
* **Status**: Implemented in API 1.2 * **Status**: Implemented in API 1.2
* **Method**: POST * **Method**: POST
* **Route**: /items/read/multiple * **Route**: /items/read/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"itemIds": [2, 3] // ids of the items "itemIds": [2, 3] // ids of the items
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as unread #### Mark an item as unread
* **Status**: Implemented * **Status**: Implemented
* **Method**: POST * **Method**: POST
* **Route**: /items/{itemId}/unread * **Route**: /items/{itemId}/unread
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as unread #### Mark multiple items as unread
* **Status**: Implemented in API 1.2 * **Status**: Implemented in API 1.2
* **Method**: POST * **Method**: POST
* **Route**: /items/unread/multiple * **Route**: /items/unread/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"itemIds": [2, 3] // ids of the items "itemIds": [2, 3] // ids of the items
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as starred #### Mark an item as starred
* **Status**: Implemented in API 1.3 * **Status**: Implemented in API 1.3
* **Method**: POST * **Method**: POST
* **Route**: /items/{itemId}/star * **Route**: /items/{itemId}/star
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as starred #### Mark multiple items as starred
* **Status**: Implemented in API 1.3 * **Status**: Implemented in API 1.3
* **Method**: POST * **Method**: POST
* **Route**: /items/star/multiple * **Route**: /items/star/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"itemIds": [1, ...] "itemIds": [1, ...]
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark an item as unstarred #### Mark an item as unstarred
* **Status**: Implemented in API 1.3 * **Status**: Implemented in API 1.3
* **Method**: POST * **Method**: POST
* **Route**: /items/{itemId}/unstar * **Route**: /items/{itemId}/unstar
* **Parameters**: none * **Parameters**: none
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the item does not exist * **HTTP 404**: If the item does not exist
* **Returns**: nothing * **Returns**: nothing
#### Mark multiple items as unstarred #### Mark multiple items as unstarred
* **Status**: Implemented in API 1.3 * **Status**: Implemented in API 1.3
* **Method**: POST * **Method**: POST
* **Route**: /items/unstar/multiple * **Route**: /items/unstar/multiple
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"itemIds": [1, ...] "itemIds": [1, ...]
} }
``` ```
* **Returns**: nothing * **Returns**: nothing
#### Mark all items as read #### Mark all items as read
@ -686,19 +628,18 @@ This is used to stay up to date.
* **Method**: POST * **Method**: POST
* **Route**: /items/read * **Route**: /items/read
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
// mark all items read lower than equal that id // mark all items read lower than equal that id
// this is mean to prevent marking items as read which the client/user does not yet know of // this is mean to prevent marking items as read which the client/user does not yet know of
"newestItemId": 10 "newestItemId": 10
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: nothing * **Returns**: nothing
### Updater ### Updater
To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created. To enable people to write their own update scripts instead of relying on the sequential built in web and system cron, API routes and console commands have been created.
@ -713,7 +654,6 @@ Updating should be done in the following fashion:
This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it. This [implementation in Python](https://github.com/nextcloud/news-updater) should give you a good idea how to design and run it.
#### Trigger cleanup before update #### Trigger cleanup before update
This is used to clean up the database. It deletes folders and feeds that are marked for deletion This is used to clean up the database. It deletes folders and feeds that are marked for deletion
* **Status**: Implemented in News 1.601 * **Status**: Implemented in News 1.601
@ -724,9 +664,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:before-update
php -f nextcloud/occ news:updater:before-update
```
#### Get feed ids and usernames for all feeds #### Get feed ids and usernames for all feeds
@ -736,8 +674,7 @@ php -f nextcloud/occ news:updater:before-update
* **Route**: /feeds/all * **Route**: /feeds/all
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"feeds": [ "feeds": [
{ {
@ -750,9 +687,8 @@ php -f nextcloud/occ news:updater:before-update
**New in 8.1.0, Removed in 16.0.0**: The console command for achieving the same result is: **New in 8.1.0, Removed in 16.0.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:all-feeds
php -f nextcloud/occ news:updater:all-feeds
```
#### Trigger a feed update #### Trigger a feed update
@ -761,26 +697,21 @@ php -f nextcloud/occ news:updater:all-feeds
* **Method**: GET * **Method**: GET
* **Route**: /feeds/update * **Route**: /feeds/update
* **Parameters**: * **Parameters**:
```jsonc
```json
{ {
"userId": "john", "userId": "john",
"feedId": 3 "feedId": 3
} }
``` ```
* **Return codes**: * **Return codes**:
* **HTTP 404**: If the feed does not exist * **HTTP 404**: If the feed does not exist
* **Returns**: Nothing * **Returns**: Nothing
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:update-feed 3 john
php -f nextcloud/occ news:updater:update-feed 3 john
```
#### Trigger cleanup after update #### Trigger cleanup after update
This is used to clean up the database. It removes old read articles which are not starred This is used to clean up the database. It removes old read articles which are not starred
* **Status**: Implemented in News 1.601 * **Status**: Implemented in News 1.601
@ -791,9 +722,7 @@ This is used to clean up the database. It removes old read articles which are no
**New in 8.1.0**: The console command for achieving the same result is: **New in 8.1.0**: The console command for achieving the same result is:
```bash php -f nextcloud/occ news:updater:after-update
php -f nextcloud/occ news:updater:after-update
```
### Version ### Version
@ -804,8 +733,7 @@ php -f nextcloud/occ news:updater:after-update
* **Route**: /version * **Route**: /version
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"version": "5.2.3" "version": "5.2.3"
} }
@ -822,8 +750,7 @@ This API can be used to display warnings and errors in your client if the web ap
* **Route**: /status * **Route**: /status
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"version": "5.2.4", "version": "5.2.4",
"warnings": { "warnings": {
@ -849,9 +776,8 @@ If **incorrectDbCharset** is true you should display a warning that database cha
This API can be used to retrieve metadata about the current user. This API can be used to retrieve metadata about the current user.
DEPRECATED: This API is deprecated, use the Nextcloud APIs instead. DEPRECATED: This API is deprecated, use the Nextcloud APIs instead.
- https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata for user data
* <https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata> for user data - `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar
* `https://nc.url/avatar/{userid}/{size}?v={1|2}` for the avatar
#### Get the status #### Get the status
@ -860,8 +786,7 @@ DEPRECATED: This API is deprecated, use the Nextcloud APIs instead.
* **Route**: /user * **Route**: /user
* **Parameters**: none * **Parameters**: none
* **Returns**: * **Returns**:
```jsonc
```json
{ {
"userId": "john", "userId": "john",
"displayName": "John Doe", "displayName": "John Doe",

81
docs/api/api-v2.md
View File

@ -7,7 +7,6 @@ The **News app** offers a RESTful API which can be used to sync folders, feeds a
In addition, an updater API is exposed which enables API users to run feed updates in parallel using a REST API or Nextcloud console API. In addition, an updater API is exposed which enables API users to run feed updates in parallel using a REST API or Nextcloud console API.
## Conventions ## Conventions
This document uses the following conventions: This document uses the following conventions:
* Object aliases as comments * Object aliases as comments
@ -23,7 +22,6 @@ There are two types of aliases:
* Object arrays * Object arrays
**Objects**: **Objects**:
```js ```js
{ {
"folder": { /* folder object */ }, "folder": { /* folder object */ },
@ -33,7 +31,6 @@ There are two types of aliases:
means that the folder attributes will be listed inside the **folder** object means that the folder attributes will be listed inside the **folder** object
**Object arrays**: **Object arrays**:
```js ```js
{ {
"folders": [ /* array of folder objects */ ], "folders": [ /* array of folder objects */ ],
@ -81,7 +78,6 @@ You have to design your app with these things in mind!:
* **Use a library to compare versions**, ideally one that uses semantic versioning * **Use a library to compare versions**, ideally one that uses semantic versioning
## Request Format ## Request Format
The base URL for all calls is: The base URL for all calls is:
https://yournextcloud.com/index.php/apps/news/api/v2 https://yournextcloud.com/index.php/apps/news/api/v2
@ -114,11 +110,9 @@ The request body is either passed in the URL in case of a **GET** request (e.g.:
**Note**: The current Etag implementation contains a unix timestamp in milliseconds. This is an implementation detail and you should not rely on it. **Note**: The current Etag implementation contains a unix timestamp in milliseconds. This is an implementation detail and you should not rely on it.
### API Level Detection ### API Level Detection
Check the [API level route](#api-level) Check the [API level route](#api-level)
### Authentication ### Authentication
Because REST is stateless you have to re-send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**. Because REST is stateless you have to re-send user and password each time you access the API. Therefore running Nextcloud **with SSL is highly recommended** otherwise **everyone in your network can log your credentials**.
Credentials are passed as an HTTP header using [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side): Credentials are passed as an HTTP header using [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side):
@ -134,7 +128,6 @@ This authentication/authorization method will be the recommended default until c
**Note**: Even if login cookies are sent back to your client, they will not be considered for authentication. **Note**: Even if login cookies are sent back to your client, they will not be considered for authentication.
## Response Format ## Response Format
The status codes are not always provided by the News app itself, but might also be returned because of Nextcloud internal errors. The status codes are not always provided by the News app itself, but might also be returned because of Nextcloud internal errors.
The following status codes can always be returned by Nextcloud: The following status codes can always be returned by Nextcloud:
@ -174,7 +167,6 @@ The response body is a JSON structure that looks like this, which contains the a
In case of an **4xx** or **5xx** error the request was not successful and has to be retried. For instance marking items as read locally and syncing should send the same request again the next time the user syncs in case an error occurred. In case of an **4xx** or **5xx** error the request was not successful and has to be retried. For instance marking items as read locally and syncing should send the same request again the next time the user syncs in case an error occurred.
## Security Guidelines ## Security Guidelines
Read the following notes carefully to prevent being subject to security exploits: Read the following notes carefully to prevent being subject to security exploits:
* You should always enforce SSL certificate verification and never offer a way to turn it off. Certificate verification is important to prevent MITM attacks which is especially important in the mobile world where users are almost always connected to untrusted networks. In case a user runs a self-signed certificate on his server ask him to either install his certificate on his device or direct him to one of the many ways to sign his certificate for free (most notably letsencrypt.com) * You should always enforce SSL certificate verification and never offer a way to turn it off. Certificate verification is important to prevent MITM attacks which is especially important in the mobile world where users are almost always connected to untrusted networks. In case a user runs a self-signed certificate on his server ask him to either install his certificate on his device or direct him to one of the many ways to sign his certificate for free (most notably letsencrypt.com)
@ -184,8 +176,7 @@ Read the following notes carefully to prevent being subject to security exploits
* If you are building a client in JavaScript or are using a link with **target="blank"**, remember to set the **window.opener** property to **null** and/or add a **rel="noreferrer"** to your link to prevent your app from being [target by an XSS attack](https://medium.com/@jitbit/target-blank-the-most-underestimated-vulnerability-ever-96e328301f4c#.wf2ddytbh) * If you are building a client in JavaScript or are using a link with **target="blank"**, remember to set the **window.opener** property to **null** and/or add a **rel="noreferrer"** to your link to prevent your app from being [target by an XSS attack](https://medium.com/@jitbit/target-blank-the-most-underestimated-vulnerability-ever-96e328301f4c#.wf2ddytbh)
## Syncing ## Syncing
All routes are given relative to the base API url, e.g.: **/sync** becomes **https://yourNextcloud.com/index.php/apps/news/api/v2/sync**
All routes are given relative to the base API url, e.g.: **/sync** becomes **<https://yourNextcloud.com/index.php/apps/news/api/v2/sync>**
There are two usecases for syncing: There are two usecases for syncing:
@ -193,7 +184,6 @@ There are two usecases for syncing:
* **Syncing local and remote changes**: the user has synced at least once and wants to submit and receive changes * **Syncing local and remote changes**: the user has synced at least once and wants to submit and receive changes
### Initial Sync ### Initial Sync
The intial sync happens when a user adds an Nextcloud account in your app. In that case you want to download all folders, feeds and unread/starred items. To do this, make the following request: The intial sync happens when a user adds an Nextcloud account in your app. In that case you want to download all folders, feeds and unread/starred items. To do this, make the following request:
* **Method**: GET * **Method**: GET
@ -212,7 +202,6 @@ and the following HTTP headers:
* **Etag**: A string containing a cache header, maximum size 64 ASCII characters, e.g. 6d82cbb050ddc7fa9cbb659014546e59 * **Etag**: A string containing a cache header, maximum size 64 ASCII characters, e.g. 6d82cbb050ddc7fa9cbb659014546e59
and the following request body: and the following request body:
```js ```js
{ {
"folders": [ /* array of folder objects */ ], "folders": [ /* array of folder objects */ ],
@ -227,8 +216,8 @@ and the following request body:
* [Feeds](#feeds) * [Feeds](#feeds)
* [Items](#items) * [Items](#items)
### Sync Local And Remote Changes
### Sync Local And Remote Changes
After the initial sync the app has all folders, feeds and items. Now you want to push changes and retrieve updates from the server. To do this, make the following request: After the initial sync the app has all folders, feeds and items. Now you want to push changes and retrieve updates from the server. To do this, make the following request:
* **Method**: POST * **Method**: POST
@ -285,7 +274,6 @@ This also applies to folders and feeds, however the reduced folder and feed obje
If you push a list of items to be marked read/starred, there can also be less items in the response than the ones which were initially sent. This means that the item was deleted by the cleanup job and should be removed from the client device. If you push a list of items to be marked read/starred, there can also be less items in the response than the ones which were initially sent. This means that the item was deleted by the cleanup job and should be removed from the client device.
For instance let's take a look at the following example. You are **POST**ing the following JSON: For instance let's take a look at the following example. You are **POST**ing the following JSON:
```json ```json
{ {
"items": [{ "items": [{
@ -326,9 +314,7 @@ The item with the **id** **7** is missing from the response. This means that it
For folders and feeds all ids will be returned so you can compare the existing ids with your locally available feeds and folders and remove the difference. For folders and feeds all ids will be returned so you can compare the existing ids with your locally available feeds and folders and remove the difference.
## Folders ## Folders
Folders are represented using the following data structure: Folders are represented using the following data structure:
```json ```json
{ {
"id": 3, "id": 3,
@ -342,7 +328,6 @@ The attributes mean the following:
* **name**: Abitrary long text, folder's name * **name**: Abitrary long text, folder's name
### Deleting A Folder ### Deleting A Folder
To delete a folder, use the following request: To delete a folder, use the following request:
* **Method**: DELETE * **Method**: DELETE
@ -371,7 +356,6 @@ In case of an HTTP 200, the deleted folder is returned in full in the response,
**Note**: If you delete a folder locally, you should also delete all feeds whose **folderId** attribute matches the folder's **id** attribute and also delete all items whose **feedId** attribute matches the feeds' **id** attribute. This is done automatically on the server and will also be missing on the next request. **Note**: If you delete a folder locally, you should also delete all feeds whose **folderId** attribute matches the folder's **id** attribute and also delete all items whose **feedId** attribute matches the feeds' **id** attribute. This is done automatically on the server and will also be missing on the next request.
### Creating A Folder ### Creating A Folder
To create a folder, use the following request: To create a folder, use the following request:
* **Method**: POST * **Method**: POST
@ -379,7 +363,6 @@ To create a folder, use the following request:
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
with the following request body: with the following request body:
```json ```json
{ {
"name": "Folder name" "name": "Folder name"
@ -403,7 +386,6 @@ In case of an HTTP 200, the created or already existing folder is returned in fu
``` ```
### Changing A Folder ### Changing A Folder
The following attributes can be changed on the folder: The following attributes can be changed on the folder:
* **name** * **name**
@ -417,7 +399,6 @@ To change any number of attributes on a folder, use the following request and pr
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
with the following request body: with the following request body:
```json ```json
{ {
"name": "New folder name" "name": "New folder name"
@ -443,8 +424,8 @@ In case of an HTTP 200, the changed or already existing folder is returned in fu
} }
``` ```
## Feeds
## Feeds
Feeds are represented using the following data structure: Feeds are represented using the following data structure:
```json ```json
@ -483,8 +464,8 @@ The attributes mean the following:
* **1**: Error occured during feed update * **1**: Error occured during feed update
* **message**: Translated error message depending on the user's configured server locale * **message**: Translated error message depending on the user's configured server locale
### Deleting A Feed
### Deleting A Feed
To delete a feed, use the following request: To delete a feed, use the following request:
* **Method**: DELETE * **Method**: DELETE
@ -493,6 +474,7 @@ To delete a feed, use the following request:
* **{id}**: feed's id * **{id}**: feed's id
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
The following response is being returned: The following response is being returned:
Status codes: Status codes:
@ -501,6 +483,7 @@ Status codes:
* **404**: Feed with given id was not found, no error object * **404**: Feed with given id was not found, no error object
* Other Nextcloud errors, see [Response Format](#response-format) * Other Nextcloud errors, see [Response Format](#response-format)
In case of an HTTP 200, the deleted feed is returned in full in the response, e.g.: In case of an HTTP 200, the deleted feed is returned in full in the response, e.g.:
```js ```js
@ -514,15 +497,14 @@ In case of an HTTP 200, the deleted feed is returned in full in the response, e.
**Note**: If you delete a feed locally, you should also delete all items whose **feedId** attribute matches the feeds' **id** attribute. This is done automatically on the server and will also be missing on the next request. **Note**: If you delete a feed locally, you should also delete all items whose **feedId** attribute matches the feeds' **id** attribute. This is done automatically on the server and will also be missing on the next request.
### Creating A feed ### Creating A feed
To create a feed, use the following request: To create a feed, use the following request:
* **Method**: POST * **Method**: POST
* **Route**: /feeds * **Route**: /feeds
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
with the following request body:
with the following request body:
```json ```json
{ {
"url": "https://feed.url.com", "url": "https://feed.url.com",
@ -536,7 +518,7 @@ with the following request body:
} }
``` ```
* **url**: Abitrary long text, the url needs to have the full schema e.g. <https://the-url.com>. In case the user omits the schema, prepending **https** is recommended * **url**: Abitrary long text, the url needs to have the full schema e.g. https://the-url.com. In case the user omits the schema, prepending **https** is recommended
* **folderId**: 64bit Integer, the feed's folder or **0** in case no folder is specified * **folderId**: 64bit Integer, the feed's folder or **0** in case no folder is specified
* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed * **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed * **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
@ -545,6 +527,7 @@ with the following request body:
* **isPinned (optional)**: See [Feeds](#feeds) * **isPinned (optional)**: See [Feeds](#feeds)
* **fullTextEnabled (optional)**: See [Feeds](#feeds) * **fullTextEnabled (optional)**: See [Feeds](#feeds)
The following response is being returned: The following response is being returned:
Status codes: Status codes:
@ -574,7 +557,6 @@ In case of an HTTP 200, the created feed is returned in full in the response, e.
**Note**: Because the next sync would also pull in the added feed and items again, the added items will be omitted for saving bandwidth. This also means that after successfully creating a feed you will need to query the [sync route](#sync-local-and-remote-changes) again. **Note**: Because the next sync would also pull in the added feed and items again, the added items will be omitted for saving bandwidth. This also means that after successfully creating a feed you will need to query the [sync route](#sync-local-and-remote-changes) again.
### Changing A Feed ### Changing A Feed
To change a feed, use the following request: To change a feed, use the following request:
* **Method**: PATCH * **Method**: PATCH
@ -583,8 +565,8 @@ To change a feed, use the following request:
* **{id}**: feed's id * **{id}**: feed's id
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
with the following request body:
with the following request body:
```json ```json
{ {
"url": "https://feed.url.com", "url": "https://feed.url.com",
@ -604,9 +586,9 @@ All parameters are optional
* **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed * **name (optional)**: Abitrary long text, the feeds name or if not given taken from the RSS/Atom feed
* **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed * **basicAuthUser (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
* **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed * **basicAuthPassword (optional)**: Abitrary long text, if given basic auth headers are sent for the feed
* **ordering (optional)**: See [feeds](#feeds) * **ordering (optional)**: See [feeds](#Feeds)
* **isPinned (optional)**: See [feeds](#feeds) * **isPinned (optional)**: See [feeds](#Feeds)
* **fullTextEnabled (optional)**: See [feeds](#feeds) * **fullTextEnabled (optional)**: See [feeds](#Feeds)
* **folderId (optional)**: 64bit Integer, the feed's folder or **0** in case no folder is specified * **folderId (optional)**: 64bit Integer, the feed's folder or **0** in case no folder is specified
The following response is being returned: The following response is being returned:
@ -666,9 +648,7 @@ The attributes mean the following:
* **contentHash**: 64 ASCII characters, used to determine if the item on the client is up to or out of date. The difference between the contentHash and the fingerprint attribute is that contentHash is always calculated from a stable set of attributes (title, author, url, enclosure, body) whereas the fingerprint is calculated from a set of attributes depending on the feed. The reason for this is that some feeds use different URLs for the same article so you would not want to include the URL as uniqueness criteria in that case. If the fingerprint was used for syncing however, an URL update would never reach the client. * **contentHash**: 64 ASCII characters, used to determine if the item on the client is up to or out of date. The difference between the contentHash and the fingerprint attribute is that contentHash is always calculated from a stable set of attributes (title, author, url, enclosure, body) whereas the fingerprint is calculated from a set of attributes depending on the feed. The reason for this is that some feeds use different URLs for the same article so you would not want to include the URL as uniqueness criteria in that case. If the fingerprint was used for syncing however, an URL update would never reach the client.
### Full ### Full
A full item contains the full content: A full item contains the full content:
```json ```json
{ {
"id": 5, "id": 5,
@ -691,9 +671,7 @@ A full item contains the full content:
``` ```
### Reduced ### Reduced
A reduced item only contains the item status: A reduced item only contains the item status:
```json ```json
{ {
"id": 5, "id": 5,
@ -703,7 +681,6 @@ A reduced item only contains the item status:
``` ```
## Updater ## Updater
Instead of using the built in, slow cron updater you can use the parallel update API to update feeds. The API can be accessed through REST or Nextcloud console API. Instead of using the built in, slow cron updater you can use the parallel update API to update feeds. The API can be accessed through REST or Nextcloud console API.
The API should be used in the following way: The API should be used in the following way:
@ -719,14 +696,11 @@ If the REST API is used, Authorization is required via Basic Auth and the user n
If the Nextcloud console API is used, no authorization is required. If the Nextcloud console API is used, no authorization is required.
### Clean Up Before Update ### Clean Up Before Update
This is used to clean up the database. It deletes folders and feeds that are marked for deletion. This is used to clean up the database. It deletes folders and feeds that are marked for deletion.
**Console API**: **Console API**:
```bash php -f /path/to/nextcloud/occ news:updater:before-update
php -f /path/to/nextcloud/occ news:updater:before-update
```
**REST API**: **REST API**:
@ -735,14 +709,11 @@ php -f /path/to/nextcloud/occ news:updater:before-update
* **Authentication**: [admin](#authentication) * **Authentication**: [admin](#authentication)
### Get All Feeds And User Ids ### Get All Feeds And User Ids
This call returns pairs of feed ids and user ids. This call returns pairs of feed ids and user ids.
**Console API**: **Console API**:
```bash php -f /path/to/nextcloud/occ news:updater:all-feeds
php -f /path/to/nextcloud/occ news:updater:all-feeds
```
**REST API**: **REST API**:
@ -750,6 +721,7 @@ php -f /path/to/nextcloud/occ news:updater:all-feeds
* **Route**: /updater/all-feeds * **Route**: /updater/all-feeds
* **Authentication**: [admin](#authentication) * **Authentication**: [admin](#authentication)
Both APIs will return the following response body or terminal output: Both APIs will return the following response body or terminal output:
```js ```js
@ -762,7 +734,6 @@ Both APIs will return the following response body or terminal output:
``` ```
### Update A User's Feed ### Update A User's Feed
After all feed ids and user ids are known, feeds can be updated in parallel. After all feed ids and user ids are known, feeds can be updated in parallel.
**Console API**: **Console API**:
@ -771,9 +742,8 @@ After all feed ids and user ids are known, feeds can be updated in parallel.
* **{feedId}**: the feed's id * **{feedId}**: the feed's id
* **{userId}**: the user's id * **{userId}**: the user's id
```bash
php -f /path/to/nextcloud/occ news:updater:update-feed {feedId} {userId} php -f /path/to/nextcloud/occ news:updater:update-feed {feedId} {userId}
```
**REST API**: **REST API**:
@ -784,15 +754,13 @@ php -f /path/to/nextcloud/occ news:updater:update-feed {feedId} {userId}
* **{userId}**: the user's id * **{userId}**: the user's id
* **Authentication**: [admin](#authentication) * **Authentication**: [admin](#authentication)
### Clean Up After Update
### Clean Up After Update
This is used to clean up the database. It removes old read articles which are not starred. This is used to clean up the database. It removes old read articles which are not starred.
**Console API**: **Console API**:
```bash php -f /path/to/nextcloud/occ news:updater:after-update
php -f /path/to/nextcloud/occ news:updater:after-update
```
**REST API**: **REST API**:
@ -801,13 +769,13 @@ php -f /path/to/nextcloud/occ news:updater:after-update
* **Authentication**: [admin](#authentication) * **Authentication**: [admin](#authentication)
## Meta Data ## Meta Data
The retrieve meta data about the app, use the following request: The retrieve meta data about the app, use the following request:
* **Method**: GET * **Method**: GET
* **Route**: / * **Route**: /
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
The following response is being returned: The following response is being returned:
Status codes: Status codes:
@ -845,12 +813,12 @@ The attributes mean the following:
* **data**: Abitrary long text, the user's image encoded as base64 * **data**: Abitrary long text, the user's image encoded as base64
* **mime**: Abitrary long text, avatar mimetype * **mime**: Abitrary long text, avatar mimetype
## API Level
## API Level
To find out which API levels are supported, make a request to the following route: To find out which API levels are supported, make a request to the following route:
* **Method**: GET * **Method**: GET
* **Route**: <https://yournextcloud.com/index.php/apps/news/api> * **Route**: https://yournextcloud.com/index.php/apps/news/api
* **Authentication**: none * **Authentication**: none
The following response is being returned: The following response is being returned:
@ -861,7 +829,6 @@ Status codes:
* **404**: The user is either running a version prior to **8.8.0** or the News app is disabled or not installed. * **404**: The user is either running a version prior to **8.8.0** or the News app is disabled or not installed.
In case of an HTTP 200, the supported API levels are returned as JSON, e.g.: In case of an HTTP 200, the supported API levels are returned as JSON, e.g.:
```json ```json
{ {
"apiLevels": ["v1-2", "v2"] "apiLevels": ["v1-2", "v2"]
@ -873,7 +840,7 @@ In case of an HTTP 200, the supported API levels are returned as JSON, e.g.:
To find out if a user is running an older News version than **8.8.0**, make a request to the following route: To find out if a user is running an older News version than **8.8.0**, make a request to the following route:
* **Method**: GET * **Method**: GET
* **Route**: <https://yournextcloud.com/index.php/apps/news/api/v1-2/version> * **Route**: https://yournextcloud.com/index.php/apps/news/api/v1-2/version
* **Authentication**: [required](#authentication) * **Authentication**: [required](#authentication)
Status codes: Status codes:

38
docs/developer.md
View File

@ -1,5 +1,4 @@
# Developer # Developer
Welcome to the Nextcloud News App developer documentation. Welcome to the Nextcloud News App developer documentation.
News is open for contributions, if you plan to implement a new feature make sure to open a [discussion](https://github.com/nextcloud/news/discussions/new?category=Features). Describe the feature that you are planing and your first idea how to implement it. News is open for contributions, if you plan to implement a new feature make sure to open a [discussion](https://github.com/nextcloud/news/discussions/new?category=Features). Describe the feature that you are planing and your first idea how to implement it.
@ -8,7 +7,6 @@ This ensures that you don't start working on something which collides with the t
For small fixes and improvements feel free to directly create a PR, the maintainers are happy to review your code. For small fixes and improvements feel free to directly create a PR, the maintainers are happy to review your code.
## APIs ## APIs
News offers an API that can be used by clients to synchronize with the server. News offers an API that can be used by clients to synchronize with the server.
There are two API declarations, so far only V1 has been fully implemented. There are two API declarations, so far only V1 has been fully implemented.
Work on V2 has started with low priority. Work on V2 has started with low priority.
@ -18,55 +16,27 @@ Work on V2 has started with low priority.
- [API-V2](api/api-v2.md) - [API-V2](api/api-v2.md)
## Coding Style Guidelines ## Coding Style Guidelines
The PHP code should all adhere to [PSR-2](https://www.php-fig.org/psr/psr-2/). The PHP code should all adhere to [PSR-2](https://www.php-fig.org/psr/psr-2/).
*Note that this is a different codestyle than Nextcloud itself uses.* *Note that this is a different codestyle than Nextcloud itself uses.*
To test the codestyle you can run `make phpcs`. To test the codestyle you can run `make phpcs`.
The application Front End uses Vue 2.7 and the Nextcloud Libraries [Vue Components](https://github.com/nextcloud-libraries/nextcloud-vue) for building the Application running inside your Nextcloud instance. For linting these files, we are using eslint, see the [config file](https://github.com/nextcloud/news/blob/master/.eslintrc.js). We also have Unit Tests for the components that run with Jest, please ensure these pass when adding new features/fixing bugs. For linting JavaScript, a [jshint file](https://github.com/nextcloud/news/blob/master/js/.jshintrc) is used that is run before compiling the JavaScript.
## General Developer setup ## General Developer setup
Check the Nextcloud [documentation](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html) to learn how to setup a developer environment, alternatively to a proper web server you can also use the [builtin php server](https://www.php.net/manual/en/features.commandline.webserver.php) on demand, it is enough for development purposes. Check the Nextcloud [documentation](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html) to learn how to setup a developer environment, alternatively to a proper web server you can also use the [builtin php server](https://www.php.net/manual/en/features.commandline.webserver.php) on demand, it is enough for development purposes.
When your setup is running, clone the news repository in the `apps/` directory inside the server. When your setup is running, clone the news repository in the `apps/` directory inside the server.
Change into the news directory and run `make` to build the app, you will need php, composer, node, npm and maybe more. Change into the news directory and run make to build the app, you will need php, composer, node, npm and maybe more.
Now you can basically use the news app and test any changes you make on your local development environment. Check out the `appinfo/routes.php` file and `lib/controller/` directory for details on API controllers. Or check out `package.json` for npm scripts and the `src/` directory for the front end Vue Application. Now you can basically use the news app and test your changes.
## Alternative Developer setup
With [PR 2670](https://github.com/nextcloud/news/pull/2670) new options to create a development environment were added.
See the README in the docker directory.
There is also a nix-shell config and zellij layout prepared.
If you have issues with the setup create a [new discussion](https://github.com/nextcloud/news/discussions).
### Frontend Tips/Organization
- We use the Nextcloud Vue component library for most of the form controls and navigation
- Vuex is used for state management, this is similar to Redux and has Actions/Mutations and Getters
- We are using the Nextcloud Webpack Vue configuration and have enabled Typescript support and importing in the Vue components
- We use ESLint and StyleLint for ensuring correct formatting of the Scripts and HTML
## Testing
Please make sure to run all tests before submitting any pull requests.
### Frontend Unit Tests
Frontend unit tests are written with Jest and can be run with `npm run test`.
### API and CLI Integration Tests
## Running Integration tests locally
We use [bats](https://bats-core.readthedocs.io/en/stable/) to run integration tests against the API and the cli. We use [bats](https://bats-core.readthedocs.io/en/stable/) to run integration tests against the API and the cli.
Check how to install bats on your system in the [official documentation](https://bats-core.readthedocs.io/en/stable/installation.html). Check how to install bats on your system in the [official documentation](https://bats-core.readthedocs.io/en/stable/installation.html).
You also need to pull the submodules of the news repo. You also need to pull the submodules of the news repo.
```bash ```bash
git submodules update --init git submodules update --init
``` ```

5
docs/features/customCSS.md
View File

@ -1,9 +1,8 @@
# Custom CSS # Custom CSS
Sometimes you want to add additional CSS for a feed to improve the rendering. This can very easily be done by adding a CSS class to **css/custom.css** following the following naming convention: Sometimes you want to add additional CSS for a feed to improve the rendering. This can very easily be done by adding a CSS class to **css/custom.css** following the following naming convention:
* Take the URL from the \<link> attribute (e.g.: \<link><https://www.google.de/path?my=query> \</link>) * Take the URL from the \<link> attribute (e.g.: \<link>https://www.google.de/path?my=query \</link>)
* Extract the Domain from the URL (e.g.: <www.google.de>) * Extract the Domain from the URL (e.g.: www.google.de)
* Strip the leading **www.** (e.g.: google.de) * Strip the leading **www.** (e.g.: google.de)
* Replace all . with - (e.g.: google-de) * Replace all . with - (e.g.: google-de)
* Prepend **custom-** (e.g.: custom-google-de) * Prepend **custom-** (e.g.: custom-google-de)

12
docs/features/integration.md
View File

@ -17,14 +17,14 @@ Ex.
1. Click `Add..` 1. Click `Add..`
1. In the *Description* field, enter a description for the RSS reader entry. 'NextCloud News' is a reasonable name. 1. In the *Description* field, enter a description for the RSS reader entry. 'NextCloud News' is a reasonable name.
1. Enter `https://<NEXTCLOUD_BASE_PATH>/index.php/apps/news?subscribe_to=%s` replacing &lt;NEXTCLOUD_BASE_PATH&gt; with the base URL path to your NextCloud instance. 1. Enter `https://<NEXTCLOUD_BASE_PATH>/index.php/apps/news?subscribe_to=%s` replacing &lt;NEXTCLOUD_BASE_PATH&gt; with the base URL path to your NextCloud instance.
* Domain based example: <https://cloud.mydomain.com/index.php/apps/news?subscribe_to=%s> * Domain based example: https://cloud.mydomain.com/index.php/apps/news?subscribe_to=%s
* Domain+subpath based example: <https://cloud.mydomain.com/nextcloud/index.php/apps/news?subscribe_to=%s> * Domain+subpath based example: https://cloud.mydomain.com/nextcloud/index.php/apps/news?subscribe_to=%s
#### Firefox #### Firefox
1. Install Firefox Add-on Extension [Awesome RSS](https://addons.mozilla.org/en-US/firefox/addon/awesome-rss/) 1. Install Firefox Add-on Extension [Awesome RSS](https://addons.mozilla.org/en-US/firefox/addon/awesome-rss/)
1. Open the `Preferences` for the extension 1. Open the `Preferences` for the extension
1. In the 'Subscribe using' section, select the `NextCloud` radio button 2. In the 'Subscribe using' section, select the `NextCloud` radio button
1. In the field link field, enter the base NextCloud URL. 3. In the field link field, enter the base NextCloud URL.
* Domain based example: <https://cloud.mydomain.com/> * Domain based example: https://cloud.mydomain.com/
* Domain+subpath based example: <https://cloud.mydomain.com/nextcloud/> * Domain+subpath based example: https://cloud.mydomain.com/nextcloud/

130
docs/features/plugins.md
View File

@ -9,91 +9,52 @@ There are essentially three different use cases for plugins:
* Dropping in additional CSS or JavaScript * Dropping in additional CSS or JavaScript
## The Basics ## The Basics
Whatever plugin you want to create, you first need to create a basic structure. A plugin is basically just an app, so you can take advantage of the full [Nextcloud app API](https://docs.nextcloud.org/server/latest/developer_manual/app/index.html). If you want you can [take a look at the developer docs](https://docs.nextcloud.org/server/latest/developer_manual/app/index.html) or [dig into the tutorial](https://docs.nextcloud.org/server/latest/developer_manual/app/tutorial.html).
Whatever plugin you want to create, you first need to create a basic structure. A plugin is basically just an app, so you can take advantage of the full [Nextcloud app API](https://docs.nextcloud.org/server/latest/developer_manual/app/index.html). [Take a look at the developer docs](https://docs.nextcloud.com/server/latest/developer_manual/app_development/index.html) or [dig into the tutorial](https://docs.nextcloud.com/server/latest/developer_manual/app_development/tutorial.html).
However, if you just want to start slow, the full process is described below. However, if you just want to start slow, the full process is described below.
First create a skeleton app using the [web interface](https://apps.nextcloud.com/developer/apps/generate) First create the following directories and files:
The application name affects the name and namespace of your plugin and only one app can exist using the same name. Choose wisely. This will become the directory name in the Nextcloud `apps/` directory
* **newsplugin/** * **newsplugin/**
* **appinfo/** * **appinfo/**
* **app.php** * **app.php**
* **info.xml** * **info.xml**
**Note**: You must license your app under the [AGPL 3 or later](https://www.gnu.org/licenses/agpl-3.0.en.html) to comply with the News app's license. Don't forget to add the license as plain text file if you want to distribute your app! The first folder name affects the name and namespace of your plugin and only one app can exist using the same name. Choose wisely.
Then we want to make sure that our code is only run if the News app is enabled. To do that put the following PHP code into the **newsplugin/lib/AppInfo/Application.php** file: First let's add some meta ata about our app. Open the **newsplugin/appinfo/info.xml** and add the following contents:
```php
<?php
declare(strict_types=1);
namespace OCA\NewsBookmarkPlugin\AppInfo;
use OCP\AppFramework\App;
use OCP\Util;
use OCP\App as Test;
class Application extends App {
public const APP_ID = 'newsbookmarkplugin';
public function __construct() {
parent::__construct(self::APP_ID);
// your code here
}
}
```xml
<?xml version="1.0"?>
<info>
<id>newsplugin</id>
<name>Example News Plugin</name>
<description>This plugin allows you to share articles via Twitter</description>
<licence>AGPL</licence>
<author>Your Name Here</author>
<version>0.0.1</version>
<dependencies>
<nextcloud min-version="10"/>
<owncloud min-version="9.1"/>
<php min-version="5.6"/>
</dependencies>
</info>
``` ```
## Server-Side Plugin **Note**: You must license your app under the [AGPL 3 or later](https://www.gnu.org/licenses/agpl-3.0.en.html) to comply with the News app's license. Don't forget to add the license as plain text file if you want to distribute your app!
A Server-Side plugin is a plugin that uses the same infrastructure as the News app for its own purposes. An example would be a plugin that makes the starred entries of a user available via an interface or a bookmark app that also shows starred articles as bookmarks. Then we want to make sure that our code is only run if the News app is enabled. To do that put the following PHP code into the **newsplugin/appinfo/app.php** file:
It's very easy to interface with the News app. Because all Classes are registered in the **news/app/application.php** it takes almost no effort to use the same infrastructure.
**Note**: Keep in mind that these classes are essentially private which means they might break if the News app changes. There is no real public API so use at your own risk ;)
Since you don't want to extend the app but use its resources, its advised that you don't inherit from the **Application** class but rather include it in your own container in **newsplugin/appinfo/application.php**:
```php ```php
<?php <?php
namespace OCA\NewsPlugin\AppInfo; namespace OCA\NewsPlugin\AppInfo;
use OCP\App;
use OCP\AppFramework\App; if (App::isEnabled('news')) {
use OCA\News\AppInfo\Application as News; // your code here
class Application extends App {
public function __construct (array $urlParams=[]) {
parent::__construct('newsplugin', $urlParams);
$container = $this->getContainer();
$container->registerService('NewsContainer', function($c) {
$app = new News();
return $app->getContainer();
});
$container->registerService(OCA\News\Service\FeedService::class, function($c) {
// use the feed service from the news app, you can use all
// defined classes but its recommended that you stick to the
// mapper and service classes since they are less likely to change
return $c->query('NewsContainer')->query(OCA\News\Service\FeedService::class);
});
}
} }
``` ```
Using automatic container assembly you can then use it from your code by simply adding the type to your constructors.
# TODO: Update the following
If your plugin integrates with another Nextcloud app, make sure to also require it be installed. If you depend on the Bookmarks app for instance use: If your plugin integrates with another Nextcloud app, make sure to also require it be installed. If you depend on the Bookmarks app for instance use:
```php ```php
@ -131,7 +92,6 @@ This will tell the News app to load the following files after its own JavaScript
* **newspluing/css/style.css** * **newspluing/css/style.css**
### Adding Basic JavaScript Functionality ### Adding Basic JavaScript Functionality
You can basically add any JavaScript you want. If you want to add a new article action, this is a bit more complicated because it's hard to hook into Angular from the outside. Therefore, the News app provides an API which makes creating additional article actions a breeze. You can basically add any JavaScript you want. If you want to add a new article action, this is a bit more complicated because it's hard to hook into Angular from the outside. Therefore, the News app provides an API which makes creating additional article actions a breeze.
A basic article action looks like this: A basic article action looks like this:
@ -198,3 +158,45 @@ Then open the **newspluing/css/style.css** file and add the following CSS:
``` ```
Reload the News app and click the three dots menu, sit back and enjoy :) Reload the News app and click the three dots menu, sit back and enjoy :)
## Server-Side Plugin
A Server-Side plugin is a plugin that uses the same infrastructure as the News app for its own purposes. An example would be a plugin that makes the starred entries of a user available via an interface or a bookmark app that also shows starred articles as bookmarks.
It's very easy to interface with the News app. Because all Classes are registered in the **news/app/application.php** it takes almost no effort to use the same infrastructure.
**Note**: Keep in mind that these classes are essentially private which means they might break if the News app changes. There is no real public API so use at your own risk ;)
Since you don't want to extend the app but use its resources, its advised that you don't inherit from the **Application** class but rather include it in your own container in **newsplugin/appinfo/application.php**:
```php
<?php
namespace OCA\NewsPlugin\AppInfo;
use OCP\AppFramework\App;
use OCA\News\AppInfo\Application as News;
class Application extends App {
public function __construct (array $urlParams=[]) {
parent::__construct('newsplugin', $urlParams);
$container = $this->getContainer();
$container->registerService('NewsContainer', function($c) {
$app = new News();
return $app->getContainer();
});
$container->registerService(OCA\News\Service\FeedService::class, function($c) {
// use the feed service from the news app, you can use all
// defined classes but its recommended that you stick to the
// mapper and service classes since they are less likely to change
return $c->query('NewsContainer')->query(OCA\News\Service\FeedService::class);
});
}
}
```
Using automatic container assembly you can then use it from your code by simply adding the type to your constructors.

3
docs/features/themes.md
View File

@ -1,5 +1,4 @@
# Themes # Themes
Nextcloud News can look different with the following themes: Nextcloud News can look different with the following themes:
* [Nextcloud News Themes](https://github.com/cwmke/nextcloud-news-themes) * [Nextcloud News Themes](https://github.com/cwmke/nextcloud-news-themes)

6
docs/install.md
View File

@ -123,9 +123,9 @@ Connect to your DB and execute the commands. Don't forget to switch to the right
For example in mysql: `use nextcloud;` For example in mysql: `use nextcloud;`
```sql ```sql
DROP TABLE oc_news_items;
DROP TABLE oc_news_feeds;
DROP TABLE oc_news_folders; DROP TABLE oc_news_folders;
DROP TABLE oc_news_feeds;
DROP TABLE oc_news_items;
``` ```
Then we remove the traces in the migrations table. Then we remove the traces in the migrations table.
@ -149,4 +149,4 @@ DELETE FROM oc_jobs WHERE class='OCA\\News\\Cron\\Updater';
DELETE FROM oc_jobs WHERE argument='["OCA\\\\News\\\\Cron\\\\Updater","run"]'; DELETE FROM oc_jobs WHERE argument='["OCA\\\\News\\\\Cron\\\\Updater","run"]';
``` ```
Now nothing is left from News in your Nextcloud installation. Now nothing is left from News in your nextcloud installation.

43
docs/troubleshooting.md
View File

@ -6,13 +6,13 @@ This is a brief list of common issues that come up with NextCloud News.
If you are serving your Nextcloud over HTTPS your browser will very likely warn you with a yellow warnings sign about your connection not being secure. If you are serving your Nextcloud over HTTPS your browser will very likely warn you with a yellow warnings sign about your connection not being secure.
* Chrome will show no green HTTPS lock sign. * Chrome will show no green HTTPS lock sign.
* Firefox will show you the following image Mixed Passive Content ![Mixed Content Type](https://ffp4g1ylyit3jdyti1hqcvtb-wpengine.netdna-ssl.com/security/files/2015/10/mixed-passive-click1-600x221.png) * Firefox will show you the following image Mixed Passive Content ![Mixed Content Type](https://ffp4g1ylyit3jdyti1hqcvtb-wpengine.netdna-ssl.com/security/files/2015/10/mixed-passive-click1-600x221.png)
Note that this warning **is not red and won't block the page like the following images** which signal a serious issue: Note that this warning **is not red and won't block the page like the following images** which signal a serious issue:
* Chrome ![Chrome error](https://www.inmotionhosting.com/support/images/stories/website/errors/ssl/chrome-self-signed-ssl-warning.png) * Chrome ![Chrome error](https://www.inmotionhosting.com/support/images/stories/website/errors/ssl/chrome-self-signed-ssl-warning.png)
* Firefox ![Firefox error](https://www.howtogeek.com/wp-content/uploads/2014/02/650x367xchrome-mixed-content-https-problem.png.pagespeed.gp+jp+jw+pj+js+rj+rp+rw+ri+cp+md.ic.r_lQiZiq38.png) * Firefox ![Firefox error](https://www.howtogeek.com/wp-content/uploads/2014/02/650x367xchrome-mixed-content-https-problem.png.pagespeed.gp+jp+jw+pj+js+rj+rp+rw+ri+cp+md.ic.r_lQiZiq38.png)
### What is the cause of the (yellow) error message? ### What is the cause of the (yellow) error message?
@ -49,45 +49,30 @@ This is very often caused by missing or old files, e.g. by failing to upload all
Feeds can be updated using Nextcloud's system cron or an external updater via the API. **The feed update is not run in Webcron and AJAX cron mode!** Feeds can be updated using Nextcloud's system cron or an external updater via the API. **The feed update is not run in Webcron and AJAX cron mode!**
### Validating Using System Cron ### Validating Using System Cron
!!! info !!! info
This requires Nextcloud 26 or newer and News 24.0.0 or newer. This requires Nextcloud 26 or newer and News 24.0.0 or newer.
Follow this checklist: Follow this checklist:
* Check admin settings of Nextcloud, was the last cron execution ok. - Check admin settings of Nextcloud, was the last cron execution ok.
* Check the logs for errors. - Check the logs for errors.
* Does your [cache configuration](install.md#cache) work? - Does your [cache configuration](install.md#cache) work?
* Check the News admin settings, system cron is used to update news. - Check the News admin settings, system cron is used to update news.
* You should see a info card at the top, which will tell you when the last job execution was. - You should see a info card at the top, which will tell you when the last job execution was.
* If the card is red it is very likely that the update job is stuck. - If the card is red it is very likely that the update job is stuck.
* If it is green then maybe only some feeds are failing to update, check the Nextcloud logs. - If it is green then maybe only some feeds are failing to update, check the Nextcloud logs.
If you believe the job is stuck you can reset it. For further steps you need to use occ. If you believe the job is stuck you can reset it. For further steps you need to use occ.
You can check again the status of the job. You can check again the status of the job.
(replace `www-data` with your httpd user) (replace www-data with your httpd user)
```bash ```bash
sudo -u www-data php ./occ news:updater:job sudo -u www-data php ./occ news:updater:job
Checking update Status Checking update Status
Last Execution was 2023-03-20 12:20:03 UTC Last Execution was 2023-03-20 12:20:03 UTC
``` ```
The same check that is done in the News admin settings can be done using occ too.
Adding the `--check-elapsed` option displays the time elapsed since the last execution,
and if it's considered too long ago, a message will be displayed, and the command returns
with exit code 2. This can be used in scripts to send an alert for example.
```console
$ sudo -u www-data php ./occ news:updater:job --check-elapsed
Checking update Status
Last Execution was 2023-03-20 12:20:03 UTC
8 hours, 21 minutes, 20 seconds ago
Something is wrong with the news cronjob, execution delay exceeded the configured interval.
```
If you think the job is stuck you can reset it, this may lead to issues if the job is currently running! If you think the job is stuck you can reset it, this may lead to issues if the job is currently running!
```bash ```bash
@ -97,9 +82,7 @@ Last Execution was 2023-03-20 12:20:03 UTC
Attempting to reset the job. Attempting to reset the job.
Done, job should execute on next schedule. Done, job should execute on next schedule.
``` ```
The output of the command should have changed. The output of the command should have changed.
```bash ```bash
sudo -u www-data php ./occ news:updater:job sudo -u www-data php ./occ news:updater:job
Checking update Status Checking update Status
@ -157,7 +140,7 @@ The command `occ news:updater:after-update [--purge-unread] [<purge-count>]` can
The purge count only applies to the items that are purged. For example, when purging a feed that has 100 unread items, 100 starred read items and 100 unstarred read items, using a purge-count of 50 would keep all unread and starred items and the latest 50 read items. Using a `purge-count` of 50 along with `--purge-unread` would keep the all starred items plus the latest 50 from the set of unread and read items. The purge count only applies to the items that are purged. For example, when purging a feed that has 100 unread items, 100 starred read items and 100 unstarred read items, using a purge-count of 50 would keep all unread and starred items and the latest 50 read items. Using a `purge-count` of 50 along with `--purge-unread` would keep the all starred items plus the latest 50 from the set of unread and read items.
## Missing 4-byte support SQLSTATE[22007]: Invalid datetime format: 1366 Incorrect string value: ## Missing 4-byte support SQLSTATE[22007]: Invalid datetime format: 1366 Incorrect string value: ...
This is likely caused by your feed using emojis in the feed title or text. This is likely caused by your feed using emojis in the feed title or text.

0
js-old/.jshintignore → js/.jshintignore
View File

0
js-old/.jshintrc → js/.jshintrc
View File

18
src/README.md → js/README.md
View File

@ -1,7 +1,9 @@
# JavaScript Development # JavaScript Development
JavaScript is built and minified using webpack. JavaScript is built and minified using gulp.
Therefore you need to install **Node.js 6+ and npm**. Therefore you need to install **Node.js 6+ and npm**. Then use npm to install **gulp-cli**:
sudo npm -g install gulp-cli
Then install the local dependencies by running: Then install the local dependencies by running:
@ -12,20 +14,16 @@ The following tasks are available:
* **Build the JavaScript**: * **Build the JavaScript**:
npm run build gulp
* **Build the JavaScript in Dev Mode**:
npm run build
* **Watch for changes and build JavaScript**: * **Watch for changes and build JavaScript**:
npm run watch gulp watch
* **Run JavaScript unit tests**: * **Run JavaScript unit tests**:
npm run karma gulp karma
* **Watch for changes and run JavaScript unit tests**: * **Watch for changes and run JavaScript unit tests**:
npm run watch-karma gulp watch-karma

0
js-old/admin/Admin.js → js/admin/Admin.js
View File

0
js-old/app/App.js → js/app/App.js
View File

0
js-old/app/Config.js → js/app/Config.js
View File

0
js-old/app/Run.js → js/app/Run.js
View File

0
js-old/controller/AppController.js → js/controller/AppController.js
View File

0
js-old/controller/ContentController.js → js/controller/ContentController.js
View File

0
js-old/controller/ExploreController.js → js/controller/ExploreController.js
View File

0
js-old/controller/NavigationController.js → js/controller/NavigationController.js
View File

0
js-old/controller/SettingsController.js → js/controller/SettingsController.js
View File

187
js/controller/ShareController.js Normal file
View File

@ -0,0 +1,187 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Marco Nassabain <marco.nassabain@hotmail.com>
* @author Nicolas Wendling <nicolas.wendling1011@gmail.com>
* @author Jimmy Huynh <natorisaki@gmail.com>
* @author Aurélien David <dav.aurelien@gmail.com>
*/
app.controller('ShareController', function (ShareResource, Loading) {
'use strict';
/** Array containing users to share an item with */
this.userList = [];
/** Value used to check if the received response is the most recent one */
this.searchQuery = '';
/** True if the most recent request failed */
this.searchUsersFailed = false;
/**
* @param search Username search query
*
* Retrieve users matching search query using OC
*/
this.searchUsers = function(search) {
this.searchUsersFailed = false;
if (!search || search === '') {
this.userList = [];
return;
}
Loading.setLoading('user', true);
this.searchQuery = search;
ShareResource.getUsers(search)
.then((response) => {
if (this.searchQuery === search) {
this.userList = response.ocs.data.exact.users;
this.userList = this.userList.concat(response.ocs.data.users);
Loading.setLoading('user', false);
}
})
.catch(() => {
if (this.searchQuery === search) {
this.userList = [];
this.searchUsersFailed = true;
Loading.setLoading('user', false);
}
});
};
/** Dictionary mapping articles to users they're shared with */
this.usersSharedArticles = [];
/**
* Test whether an item is shared with a user
*
* @param itemId ID of the item being shared
* @param userId User ID of the recipient
* @returns boolean
*/
this.itemIsSharedWithUser = function(itemId, userId) {
let item = this.usersSharedArticles.find(i => i.id === itemId);
if (!item) {
return false;
}
let user = item.users.find(u => u.id === userId);
if (!user || !user.status) {
return false;
}
return true;
};
/**
* Inserts an item share action into the dictionary
*
* @param itemId ID of the item being shared
* @param userId User ID of the recipient
* @param status boolean indicating if the share was successful
*/
this.addItemShareWithUser = function(itemId, userId, status) {
let item = this.usersSharedArticles.find(i => i.id === itemId);
if (!item) {
item = {
id: itemId,
users: []
};
this.usersSharedArticles.push(item);
}
let user = item.users.find(u => u.id === userId);
if (!user) {
user = {
id: userId,
status: status
};
item.users.push(user);
}
user.status = status;
};
/**
* @param itemId ID of the item to be shared
* @param userId ID of the recipient
*
* Call the /share route with the appropriate params to share an item.
* Fills this.usersSharedArticles to avoid re-sharing the same article
* with the same user multiple times.
*/
this.shareItem = function(itemId, userId) {
if (this.itemIsSharedWithUser(itemId, userId)) {
return;
}
Loading.setLoading(userId, true);
ShareResource.shareItem(itemId, userId)
.then(() => {
this.addItemShareWithUser(itemId, userId, true);
Loading.setLoading(userId, false);
})
.catch(() => {
this.addItemShareWithUser(itemId, userId, false);
Loading.setLoading(userId, false);
});
};
/**
* Indicates whether the share action is in progress
*
* @param userId User ID of the recipient
* @returns boolean
*/
this.isLoading = function(userId) {
return Loading.isLoading(userId);
};
/**
* Indicates whether the share actions matches the given status
*
* @param itemId ID of the item being shared
* @param userId User ID of the recipient
* @param status true (successful) / false (failed)
* @returns boolean
*/
this.isStatus = function(itemId, userId, status) {
let item = this.usersSharedArticles.find(i => i.id === itemId);
if (!item) {
return false;
}
let user = item.users.find(u => u.id === userId);
if (!user) {
return false;
}
return user.status === status;
};
/**
* Checks if the social sharing app for the given media is active
*
* @param media
* @returns boolean
*/
this.isSocialAppEnabled = function(media) {
let app = 'socialsharing_' + media;
return app in OC.appswebroots;
};
this.isAnySocialAppEnabled = function() {
let media = ['facebook', 'twitter', 'email'];
return media.some(m => this.isSocialAppEnabled(m));
};
this.getFacebookUrl = function(url){
return 'https://www.facebook.com/sharer/sharer.php?u='+url;
};
this.getTwitterUrl = function(url){
return 'https://twitter.com/intent/tweet?url='+url;
};
this.getEmailUrl = function(url, object, body){
return encodeURI('mailto:?subject=' + object + '&body=' + body + ' ' + url);
};
});

0
js-old/directive/AppNavigationEntryUtils.js → js/directive/AppNavigationEntryUtils.js
View File

31
js/directive/ClickOutside.js Normal file
View File

@ -0,0 +1,31 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Marco Nassabain <marco.nassabain@hotmail.com>
* @author Nicolas Wendling <nicolas.wendling1011@gmail.com>
* @author Jimmy Huynh <natorisaki@gmail.com>
* @author Aurélien David <dav.aurelien@gmail.com>
*/
app.directive('clickOutside', function ($document) {
'use strict';
return {
restrict: 'A',
scope: {
clickOutside: '&'
},
link: function (scope, el) {
$document.on('click', function (e) {
if (el !== e.target && !el[0].contains(e.target)) {
scope.$apply(function () {
scope.$eval(scope.clickOutside);
});
}
});
}
};
});

0
js-old/directive/NewsAddFeed.js → js/directive/NewsAddFeed.js
View File

0
js-old/directive/NewsArticleActions.js → js/directive/NewsArticleActions.js
View File

0
js-old/directive/NewsAutoFocus.js → js/directive/NewsAutoFocus.js
View File

0
js-old/directive/NewsBindUnsafeHtml.js → js/directive/NewsBindUnsafeHtml.js
View File

0
js-old/directive/NewsDraggable.js → js/directive/NewsDraggable.js
View File

0
js-old/directive/NewsDroppable.js → js/directive/NewsDroppable.js
View File

0
js-old/directive/NewsFinishedTransition.js → js/directive/NewsFinishedTransition.js
View File

0
js-old/directive/NewsFocus.js → js/directive/NewsFocus.js
View File

0
js-old/directive/NewsInstantNotification.js → js/directive/NewsInstantNotification.js
View File

0
js-old/directive/NewsOnActive.js → js/directive/NewsOnActive.js
View File

0
js-old/directive/NewsPlayOne.js → js/directive/NewsPlayOne.js
View File

0
js-old/directive/NewsReadFile.js → js/directive/NewsReadFile.js
View File

0
js-old/directive/NewsRefreshMasonry.js → js/directive/NewsRefreshMasonry.js
View File

0
js-old/directive/NewsScroll.js → js/directive/NewsScroll.js
View File

0
js-old/directive/NewsSearch.js → js/directive/NewsSearch.js
View File

0
js-old/directive/NewsStickyMenu.js → js/directive/NewsStickyMenu.js
View File

0
js-old/directive/NewsStopPropagation.js → js/directive/NewsStopPropagation.js
View File

0
js-old/directive/NewsTimeout.js → js/directive/NewsTimeout.js
View File

0
js-old/directive/NewsTitleUnreadCount.js → js/directive/NewsTitleUnreadCount.js
View File

0
js-old/directive/NewsToggleShow.js → js/directive/NewsToggleShow.js
View File

0
js-old/directive/NewsTriggerClick.js → js/directive/NewsTriggerClick.js
View File

58
js/filter/RelativeTimestamp.js Normal file
View File

@ -0,0 +1,58 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Alec Kojaev <alec@kojaev.name>
* @copyright Alec Kojaev 2021
*/
app.filter('relativeTimestamp', ['SettingsResource', function (SettingsResource) {
'use strict';
const languageCode = SettingsResource.get('language');
const relFormat = Intl.RelativeTimeFormat ?
new Intl.RelativeTimeFormat(languageCode, { numeric: 'auto' }) : null;
const maxRelDistance = 90*86400*1000;
const relLimits = [
[ 7*86400*1000, 'week' ],
[ 86400*1000, 'day' ],
[ 3600*1000, 'hour' ],
[ 60*1000, 'minute' ],
[ 1*1000, 'second' ]
];
const absLimits = [
[ 7*86400*1000, { hour: '2-digit', minute: '2-digit', dayPeriod: 'narrow',
year: 'numeric', month: 'short', day: 'numeric' } ],
[ 43200*1000, { hour: '2-digit', minute: '2-digit', dayPeriod: 'narrow',
weekday: 'long' } ],
[ 0, { hour: '2-digit', minute: '2-digit', dayPeriod: 'narrow' } ]
];
return function (timestamp) {
if (!Number.isFinite(timestamp)) {
return timestamp;
}
const ts = new Date(timestamp);
const dist = ts.getTime() - Date.now();
const absDist = Math.abs(dist);
if (relFormat && absDist < maxRelDistance) {
for (const [ scale, unit ] of relLimits) {
const value = Math.trunc(dist / scale);
if (value !== 0) {
return relFormat.format(value, unit);
}
}
// We arrive here only if distance from now is less than 1 second
return relFormat.format(0, 'second');
} else {
for (const [ limit, options ] of absLimits) {
if (absDist >= limit) {
return ts.toLocaleString(languageCode, options);
}
}
// We shouldn't be here
return ts.toLocaleString(languageCode, absLimits[absLimits.length - 1][1]);
}
};
}]);

0
js-old/filter/TrustUrl.js → js/filter/TrustUrl.js
View File

0
js-old/filter/UnreadCountFormatter.js → js/filter/UnreadCountFormatter.js
View File

0
js-old/gui/ExternSubscription.js → js/gui/ExternSubscription.js
View File

0
js-old/gui/Fixes.js → js/gui/Fixes.js
View File

0
js-old/gui/KeyboardShortcuts.js → js/gui/KeyboardShortcuts.js
View File

79
js/gulpfile.js Normal file
View File

@ -0,0 +1,79 @@
/**
* Nextcloud - News
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @copyright Bernhard Posselt 2012, 2014
*/
/*jslint node: true */
'use strict';
const gulp = require('gulp'),
ngAnnotate = require('gulp-ng-annotate'),
terser = require('gulp-terser'),
jshint = require('gulp-jshint'),
KarmaServer = require('karma').Server,
concat = require('gulp-concat'),
sourcemaps = require('gulp-sourcemaps');
// Configuration
const buildTarget = 'app.min.js';
const karmaConfig = __dirname + '/karma.conf.js';
const destinationFolder = __dirname + '/build/';
const sources = [
'node_modules/angular/angular.min.js',
'node_modules/angular-animate/angular-animate.min.js',
'node_modules/angular-route/angular-route.min.js',
'node_modules/angular-sanitize/angular-sanitize.min.js',
'node_modules/masonry-layout/dist/masonry.pkgd.min.js',
'app/App.js', 'app/Config.js', 'app/Run.js',
'controller/**/*.js',
'filter/**/*.js',
'service/**/*.js',
'gui/**/*.js',
'plugin/**/*.js',
'utility/**/*.js',
'directive/**/*.js'
];
const testSources = ['tests/**/*.js'];
const watchSources = sources.concat(testSources).concat(['*.js', '!news-admin-settings.js']);
const lintSources = watchSources;
// tasks
gulp.task('lint', () => {
return gulp.src(lintSources)
.pipe(jshint())
.pipe(jshint.reporter('default'))
.pipe(jshint.reporter('fail'));
});
gulp.task('default', gulp.series('lint', () => {
return gulp.src(sources)
.pipe(ngAnnotate())
.pipe(sourcemaps.init())
.pipe(concat(buildTarget))
.pipe(terser())
.pipe(sourcemaps.write())
.pipe(gulp.dest(destinationFolder));
}));
gulp.task('watch', () => {
gulp.watch(watchSources, ['default']);
});
gulp.task('karma', (done) => {
new KarmaServer({
configFile: karmaConfig,
singleRun: true
}, done).start();
});
gulp.task('watch-karma', (done) => {
new KarmaServer({
configFile: karmaConfig,
autoWatch: true
}, done).start();
});

0
js-old/karma.conf.js → js/karma.conf.js
View File

12966
js/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

63
js/package.json Normal file
View File

@ -0,0 +1,63 @@
{
"name": "nextcloud-news",
"description": "An RSS/Atom feed reader",
"main": "build/app.min.js",
"scripts": {
"test": "node node_modules/gulp-cli/bin/gulp.js karma",
"prebuild": "npm ci",
"build": "node node_modules/gulp-cli/bin/gulp.js"
},
"repository": {
"type": "git",
"url": "https://github.com/nextcloud/news"
},
"keywords": [
"rss",
"atom",
"feed",
"reader",
"nextcloud",
"app"
],
"author": "Benjamin Brahmer",
"license": "AGPL-3.0",
"bugs": {
"url": "https://github.com/nextcloud/news/issues"
},
"engines": {
"node": ">=6"
},
"resolutions": {
"natives": "1.1.3"
},
"private": true,
"homepage": "https://github.com/nextcloud/news",
"devDependencies": {
"gulp": "^4.0.2",
"gulp-cli": "^2.3.0",
"gulp-concat": "^2.6.1",
"gulp-jshint": "^2.1.0",
"gulp-ng-annotate": "^2.1.0",
"gulp-sourcemaps": "^3.0.0",
"gulp-terser": "^2.1.0",
"jasmine-core": "^5.1.1",
"jquery": "^3.7.1",
"jshint": "^2.13.6",
"karma": "^6.4.2",
"karma-chrome-launcher": "^3.2.0",
"karma-coverage": "^2.2.1",
"karma-firefox-launcher": "^2.1.2",
"karma-jasmine": "^5.1.0",
"minimatch": "^9.0.3",
"natives": "^1.1.6"
},
"dependencies": {
"angular": "^1.8.3",
"angular-animate": "^1.8.3",
"angular-mocks": "^1.8.3",
"angular-route": "^1.8.3",
"angular-sanitize": "^1.8.3",
"debug": "^4.3.4",
"masonry-layout": "^4.2.2"
}
}

0
js-old/plugin/ArticleActionPlugin.js → js/plugin/ArticleActionPlugin.js
View File

0
js-old/protractor.conf.js → js/protractor.conf.js
View File

0
js-old/service/FeedResource.js → js/service/FeedResource.js
View File

0
js-old/service/FolderResource.js → js/service/FolderResource.js
View File

0
js-old/service/ItemResource.js → js/service/ItemResource.js
View File

Some files were not shown because too many files have changed in this diff Show More