implement dashboard api for recommended files

[icewind1991]

Implement the dashboard api from nextcloud/server#26430 and nextcloud/server#33658

requires:

• Extend dashboard api to allow listing of widgets server#33658

[tobiasKaminsky]

Bug: iconUrl must always be set, as clients cannot know via API which type it is, they cannot fall back to their placeholder.
This means that also for a folder / empty text file correctly tinted placeholder must be returned.

[PVince81]

linter is also not happy here

[PVince81]

@tobiasKaminsky do you mean we should pre-check if a preview exists, and if yes, return the preview URL and if not return the mime type icon URL instead ?

[tobiasKaminsky]

Yes, clients always need a real icon, may it be svg or png.

[CarlSchwan]

At least in Qt/QML, this is not required as you can easily detect if the image loaded and add a fallback (e.g. mimetype icon). See e.g. https://invent.kde.org/frameworks/kirigami/-/blob/master/src/controls/Avatar.qml#L235

[tobiasKaminsky]

But we do not have any info about the mimetype.
And sending mimetype along side, and then have clients deteminate it and show correct placeholder is way more work than directly sending the correct image.
(widgets on Android / iOS are limited in opposite to our full apps, so we cannot do too much calculation/work there)

[PVince81]

@tobiasKaminsky do you happen to have a curl call handy to call this API ? (so that someone else can take over and continue without needing the full setup)

[tobiasKaminsky]

CURL:

curl --request GET \
  --url 'https://server.com/ocs/v2.php/apps/dashboard/api/v1/widget-items?format=json&limit=14&widgets%5B%5D=recommendations' \
  --header 'Authorization: Basic 123123' \
  --header 'OCS-APIRequest: true' \
  --header 'format: json'

[ArtificialOwl]

It seems the IRecommendation already have a value regarding the availability of a preview

@PVince81 Need to clarify if this is enough

Example of result of the ocs request:

{
  "ocs": {
    "meta": {
      "status": "ok",
      "statuscode": 200,
      "message": "OK"
    },
    "data": {
      "recommendations": [
        {
          "subtitle": "",
          "title": "Talk",
          "link": "http://nc25.local/index.php/f/411",
          "iconUrl": "http://nc25.local/index.php/apps/theming/img/core/filetypes/folder.svg?v=0",
          "sinceId": "1663763213"
        },
        {
          "subtitle": "",
          "title": "Library.jpg",
          "link": "http://nc25.local/index.php/f/406",
          "iconUrl": "http://nc25.local/index.php/core/preview?x=256&y=256&fileId=406&c=e6abee908319368e8bbdf39ea20f770e",
          "sinceId": "1663763212"
        },
[...]

[PVince81]

👍 awesome

[PVince81]

@tobiasKaminsky can you review if this solution is now suitable for clients ? thanks

[tobiasKaminsky]

This works @ArtificialOwl 👏

[PVince81]

/backport to stable25

[ChristophWurst]

There was no backport @PVince81

[ChristophWurst]

/backport to stable25