Skip to content

Comments

implement dashboard api for recommended files#543

Merged
PVince81 merged 2 commits intomasterfrom
dashboard-api
Sep 22, 2022
Merged

implement dashboard api for recommended files#543
PVince81 merged 2 commits intomasterfrom
dashboard-api

Conversation

@icewind1991
Copy link
Member

@icewind1991 icewind1991 commented Aug 23, 2022 •
edited by PVince81
Loading

@icewind1991 icewind1991 mentioned this pull request Aug 23, 2022
Merged
@tobiasKaminsky
Copy link
Member

tobiasKaminsky commented Sep 7, 2022

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.

@AndyScherzinger AndyScherzinger changed the title implement dashboard api implement dashboard api for recommended files Sep 7, 2022
@PVince81
Copy link
Member

PVince81 commented Sep 16, 2022

linter is also not happy here

PVince81
PVince81 reviewed Sep 19, 2022
View reviewed changes
lib/Dashboard/RecommendationWidget.php Outdated

return array_map(function(IRecommendation $recommendation) {
$url = $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $recommendation->getNode()->getId()]);
$icon = $this->urlGenerator->linkToRouteAbsolute('core.Preview.getPreviewByFileId', [
Copy link
Member

@PVince81 PVince81 Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 ?

Copy link
Member

@tobiasKaminsky tobiasKaminsky Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@CarlSchwan CarlSchwan Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@tobiasKaminsky tobiasKaminsky Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

PVince81 commented Sep 19, 2022

@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
Copy link
Member

tobiasKaminsky commented Sep 19, 2022

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
Copy link
Member

ArtificialOwl commented Sep 21, 2022

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
PVince81 approved these changes Sep 22, 2022
View reviewed changes
Copy link
Member

@PVince81 PVince81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 awesome

@PVince81
Copy link
Member

PVince81 commented Sep 22, 2022

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

@tobiasKaminsky
Copy link
Member

tobiasKaminsky commented Sep 22, 2022

This works @ArtificialOwl 👏

@PVince81 PVince81 merged commit 8b4f188 into master Sep 22, 2022
@PVince81 PVince81 deleted the dashboard-api branch September 22, 2022 10:30
@PVince81
Copy link
Member

PVince81 commented Sep 22, 2022

/backport to stable25

@ChristophWurst ChristophWurst mentioned this pull request Oct 21, 2022
Closed
@ChristophWurst
Copy link
Member

ChristophWurst commented Oct 21, 2022

There was no backport @PVince81

@ChristophWurst
Copy link
Member

ChristophWurst commented Oct 21, 2022

/backport to stable25

@backportbot-nextcloud backportbot-nextcloud bot mentioned this pull request Oct 21, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tobiasKaminsky tobiasKaminsky tobiasKaminsky left review comments

@CarlSchwan CarlSchwan CarlSchwan left review comments

@PVince81 PVince81 PVince81 approved these changes

Assignees

@ArtificialOwl ArtificialOwl

Labels

2. developing

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@icewind1991 @tobiasKaminsky @PVince81 @ArtificialOwl @ChristophWurst @CarlSchwan