Custom album covers

[evoludolab]

Draft pull request to implement setting custom cover images for albums, see #442

This pull request implements the back end for setting custom album covers. The corresponding pull request for the front end extends the context menu for photos and albums with Set/Remove Album cover to set/remove custom album covers of the parent album, see LycheeOrg/Lychee-front#239

• add a cover_id column and cover relationship to Album
• thumb is now added in the toReturnArray() function which simplifies the code at multiple places
• the cover image is greedy fetched to lower the number of SQL queries.

Future work (for another PR):

• allow the selection of the ancestor for which the photo is to be set, for now this is only for the direct parent.
• allow the ability to clear the cover photo without having to click on a picture.

IMPORTANT:

• ⚠️ this draft uses album.description to store the information of custom covers. It requires a new column cover in the album table, which is beyond my pay grade.
• SQL query in AlbumController.php should be reviewed (this is completely unfamiliar territory...)
• something seems amiss with the gulpfile because iconic.svg does not get processed (the new icon needs to be manually added to resources/views/includes/svg.blade.php and resources/views/view.blade.php)
• only English localization done
• support for 3 distinct images for albums dropped (seems overkill given that 2 are barely visible); if this is acceptable some code cleaning and streamlining would be recommended

[ildyria]

Still WIP. Incoming changes. Please wait for #873 to be merged.

[ildyria]

@evoludolab please check.

[kamil4]

Looks good overall.

I still need to look at the front end, and I'd like to try it out...

[evoludolab]

Wow this is cool! Unfortunately I have a day job and won't have time to check until later ☹️ The first impression is great and everything seems to work! The badge is nice but a tad intrusive - especially on sub albums. Maybe a tooltip would help to explain that this marks the cover image of the parent? Anyways, I'll test more thoroughly later. Thanks!

[kamil4]

The badge is nice but a tad intrusive - especially on sub albums.

That's why I tweaked it to be the rightmost one... As to it being intrusive, we use badges all over the place already, so adding one more doesn't seem like a big stretch...

Maybe a tooltip would help to explain that this marks the cover image of the parent?

We don't currently have tooltips in that area of the UI -- I think we may be using them only in the menu bar? I suppose we could add some but I'm not sure how necessary it is in this case, as the badge appears immediately after the user sets a cover, so it should be pretty obvious what it indicates. Of course, after a while one might forget...

[kamil4]

I'm wondering about the security implications here. Shouldn't we at least be checking that the new cover Photo belongs to the user? I think the upload middleware would automagically do it if the request field was called photoID, not the current cover_id...

[ildyria]

I'm wondering about the security implications here. Shouldn't we at least be checking that the new cover Photo belongs to the user? I think the upload middleware would automatically do it if the request field was called photoID, not the current cover_id...

Then we just need to update the Ajax query to send a photoId :)

[kamil4]

Done...

[evoludolab]

@kamil4 nothing against badges and I am clearly in favour of marking the cover - makes everything more transparent! What about adding a more discreet marker similar to albums that contain sub albums?

Concerning tooltips I was more thinking of visitors that wonder what the orange badge means. But that seems quite cosmetic and probably better suited for a separate discussion.

[ildyria]

Concerning tooltips I was more thinking of visitors that wonder what the orange badge means. But that seems quite cosmetic and probably better suited for a separate discussion.

Visitors do not see badges.

[evoludolab]

Visitors do not see badges.

@ildyria Oh, did not yet notice... In that case long live the orange badge!

[evoludolab]

As far as I can tell everything works like a charm. I am looking forward to studying all your changes and improvements carefully to get a better understanding of Lychee. It's been a pleasure - thanks!

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication