Add CLI Commands

[mwinkens]

This PR adds CLI commands for announcing, deleting and viewing announcements:

announcementcenter:announce [--activities] [--notifications] [--emails] [--comments] [-s|--schedule-time [SCHEDULE-TIME]] [-d|--delete-time [DELETE-TIME]] [-g|--group [GROUP]] [--] <user> <subject> <message>

announcementcenter:delete <id>

announcementcenter:list [<limit>]

Help:

CLICK ME

Announce:

$php occ announcementcenter:announce --help
Description:
  Create an announcement

Usage:
  announcementcenter:announce [options] [--] <user> <subject> <message>

Arguments:
  user                                 User who creates the announcement
  subject                              User for whom the addressbook will be created
  message                              message of the announcement (supports markdown)

Options:
      --activities                     Get notified over activities
      --notifications                  Get notified over nextclouds notifications
      --emails                         Notify users over email
      --comments                       Allow comments
  -s, --schedule-time[=SCHEDULE-TIME]  Publishing time of the announcement (see php strtotime)
  -d, --delete-time[=DELETE-TIME]      Deletion time of the announcement (see php strtotime)
  -g, --group[=GROUP]                  group to set send announcement to (default "everyone", multiple allowed) [default: ["everyone"]] (multiple values allowed)
  -h, --help                           Display help for the given command. When no command is given display help for the list command
  -q, --quiet                          Do not output any message
  -V, --version                        Display this application version
      --ansi|--no-ansi                 Force (or disable --no-ansi) ANSI output
  -n, --no-interaction                 Do not ask any interactive question
      --no-warnings                    Skip global warnings, show command output only
  -v|vv|vvv, --verbose                 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

List

$php occ announcementcenter:list --help
Description:
  List all announcements

Usage:
  announcementcenter:list [<limit>]

Arguments:
  limit                 Maximal number of announcements listed [default: 10]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --no-warnings     Skip global warnings, show command output only
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Delete

php occ announcementcenter:delete --help
Description:
  Delete an announcement by id

Usage:
  announcementcenter:delete <id>

Arguments:
  id                    Id of announcement to delete

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --no-warnings     Skip global warnings, show command output only
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Examples:

CLICK ME

Announce:

Minimal

Minimal, you need at least one announcement option:

php occ announcementcenter:announce nextcloud27 'a test' 'a test message'

Announces as user nextcloud27 a message ('a test message') with a subject ('a test').
Default group is everyone, so this announcement reaches everyone. However this didn't use any notification type, like --emails and is just visible in the announcement app

Groups

You can specify multiple groups with --group or -g:

php occ announcementcenter:announce nextcloud27 'a test' 'a test message' --emails --group group1 --group group2

This example only announces to users with group group1 and group2 and sends each user in the group an email

Scheduling/Deletion

You can set the scheduled announcement time with --schedule-time <time>, while the time can be a unix timestamp or any string that can be interpreted by strtotime

Unix-timestamp:

php occ announcementcenter:announce nextcloud27 'a test' 'a test message' --emails --schedule-time 1711443260

String:
Tomorrow:

php occ announcementcenter:announce nextcloud27 'a test' 'a test message' --emails --schedule-time tomorrow

Friday:

php occ announcementcenter:announce nextcloud27 'a test' 'a test message' --emails --schedule-time friday

16:45

php occ announcementcenter:announce nextcloud27 'a test' 'a test message' --emails --schedule-time 16:45

delete-time is similar

List

$php occ announcementcenter:list
ID  |Subject                 |Message                                           
----|------------------------|--------------------------------------------------
33  |testin a bigger subje...|test                                              
25  |test9                   |test9                                             
24  |Your Subject            |Your Plain Body                                   
23  |test8                   |test8                                             
21  |test6                   |test6                                             
20  |test5                   |test5                                             
19  |test4                   |test4                                             
18  |test3                   |lorem ipsum I don't speak latin                   
17  |test2                   |testm    

You can specify the output limit, default is 10:

$php occ announcementcenter:list 3
ID  |Subject                 |Message                                           
----|------------------------|--------------------------------------------------
33  |testin a bigger subje...|test                                              
25  |test9                   |test9                                             
24  |Your Subject            |Your Plain Body                                   
And more ...

Delete

Delete announcement with ID 33:

$php occ announcementcenter:delete 33
Successfully deleted #33

Roadmap

• tests!

---

based on #767 (merged)
closes #147

[mwinkens]

@nickvergessen this is also ready for review and if you want we can integrate this into the next update! ~400 lines of this ~800 lines PR are just unit tests, so this shouldn't take too much effort. Also this PR doesn't have a frontend 🎉

[nickvergessen]

Not a fan of this thirdparty access. Symfony version is not the same across all supported versions.
Also by ignoring it in psalm, CI will not detect if there is an issue. But yeah we don't have a better option atm.

[mwinkens]

@nickvergessen ready for review again 🎉

[pierreozoux]

Really nice!

Thanks @nickvergessen and @mwinkens \o/