Add json support to WMS GetLegendGraphic #31747

elemoine · 2019-09-13T15:54:43Z

Description

This PR adds support for GetLegendGraphic responses encoded as JSON. It builds on previous work by @pblottiere, who added QgsLegendRenderer::exportLegendToJson for that exact purpose.

For example a GetLegendGraphic request with FORMAT=image/png producing the image

will produce the following with FORMAT=application/json

{
  "nodes": [
    {
      "icon": "iVBORw0KGgoAAAANSUhEUgAAABoAAABuCAYAAAA5+QMZAAAACXBIWXMAAA9hAAAPYQGoP6dpAAAHaUlEQVRoge2YW4xdVRmAv3XZt3OdmdMZplPaDp1eCBUIoVwCxoxGLopTE5MmPBnEhJiqCbyYiIm+4ANvRjAxaEwTH4TURGIUY0SYqlGwlIvYaTsUpu1QOtdzzsy57XP23mv5QGeYdjqll9MXc76nk73X+r+91vrXv89egstk9+7d2SjKiiSRSWtAJRXXTQ4991z0af3EpzV4+OFvbMz15m8JUunPSiG3Bb7XC2QAnVgbxyYpEZmploneWKiUXznVaIyP7tsXXrLoW48/fq/npfYWugqfx1HrpfaIhcPJWpPFWpPEWLSW5H2HwZyHjJskrVZSrVVfCyu1/Tau//yZZ55pril68sknr6sl4meFnsJXg3RGn6wZ3jp+isb0GUR5BpJk1UNZ18cZuIG+6we47fo86SSiWJp7sxHWv/vTp5/+5yrRd773g135TPqF7p7Clsm65fXD79F6fwxhLSbI0CoMEBfWk6TzWKkRURNVX8SdOoE79yFYi01lGdx1N/dsyLBYWSgt1hYf/clTT724LPrm3ie2DmzoP5DPdw28PRcyduBVMAn1rbdR23kPUWHgomup6hW8yWNk/zOKLs1QuPNz3D9UYKFUmisWS8MKYGRkJLVxy7ZfFAqFXacbljdefpnWdZuY3f1tGkO3YlLZi0oArOMRrRugfuMdYA3J2//A27iV9Tk/1YzqPRogW+jfns/l7gM4OD5JfccuynePgPjUpFwtVA6Ld36ZuGcDh98fY+ttg9hEfkED5HLBDULiGwQNHVC+68okK6lvvZXY1hFAGNZzEqA4X7mjUW8A4N10+1VLlli36QasMYSNRkMCKJWcmZ2bLkss29wm2KsXaWO5OZomakUkURJLAISqho2wXK1UuCmaYSguXZVEGcEXmxP0JFVOTUwsaEdHcumm63iDp05OfNCq1fhKeIybo1nEZY5MWMjaFiPhET4TT/PB+8eLQsi0tRi9sqHrBFtOfDAx3r+hf/CBHuPuUPO86fZzQndhAbuWAOhOQnZGc9wST9Gcn2bsw9NF1/OzCDSAPr+T47rbp05PlednZ518d7d4MPcRSdDFpOpiXvlU8EikQBpL2kZ02QYbTAW/XsI2G5w6M4OyBtfze1Y8iV0lOivrskC5WKZYLBJZRTqTYUgrXC2wQiKFIk5iytWQ02GINDG+EEitQMhVMS8oWpoOhEQhkVha1UVa9uz0WbBYpBAIKcgoCWrNUJgkWdQACYQXW3ghBEqoNe9fDGstxpiTEsDWq3+LTVS/okiXIEqS1osSYP/+/adbcfQHa9fKqysnbNT/dfTdd/Ytr1ps9BNhK5xoqyRszEQmfPTQoUOfbNjnf/XsR2Gj+VAjrJ3gKkdmjMUkEdjk2d/s23cU4Jw8fOHXvzySJNGPPFdikgRjzWVL4jgmm/bYOrgBz9PB0vVVOZnx/c2bNw4QRTHzxTKVep0ksh/vDWEBcTb1BRaLMQZrLJ6rSQc+vb39pIOAxBi01JvWFAkphxyt8VyXTDqFMYZ6o0mtUSduJURJzFLSuI4m8D1SQYDrOkj5yQQpKdFK9Q0PD+vR0dH4HNHtjz3mOFqvX9lBSkkmHZBJB1wufuB1eb29OaB4zhoNnKnk/WBFjbpKXM9bF0QqB+clQ6xMPvC9vnaJPMfpF57NrxKlfNHtue76dom0VkHaz1y/SpRN57Zr7TjtE2lSKX/bKpHnezscvXYVvlwcrdGOM7hKpITcovSVVekLoZRCYDedI9qzZ4+rHd2v5OqX1pUihMB13e6RkZHUctQq5IM2pvYSvud1C5HJLouUMV2B5113DUR9xmnllkVC64Lruf3tFjmu06el170s6s12bXfamQln0VKpfD41tCzSrrNdO+1L7SWUVviOt0Kk1Bat2j4gHO0gtdosAYYfecT3HLdPtjG1l1BKIoUakAC5YjPvB16h7ZazBJ6Tl/Bx1dZab7lWIi8IChKg2gy/FgR+7lqJHKXWyZ179rhK6++7um1FezVCZiUzCw80olau2WpdM8/U/JyQFjO42Aj5cGr6mkjCZpPJqdlYCggBjk2eplheaKskSRLePXacE9MzB6VQ5hXATpXKvP7uYcoLi22RhM0mb40d5dD4cSw8r2YmJkq9g0PrgV2lao25UonA0WTSKa5kA0dxzPTMLAcPH+G/JyYx1h4c6+3aqwA2Fbr/HLnBXUIwVG2ETJ6ZobSwQBLHOFqhlF5Taq2l1YqoNxpMzc3xztFxDh57j5nyIhaOCKIHZ196qbL89bXj3t1Z5TReAL60dE1JSVc6RW8+Ry6dwvc8AtfFCgHW0oxiqrUq9VbEdLHMYr1ObJb/r/+2lei9x//+p1lYfV4ndg7f/3Vr7Q8RnFMpBB+/mpd/IzBYzPlfHpZ/C8mPD7/6l9+f338Vw8PDeto6I1LwkLXch2DThdqtCD4mpP1jYuzvjh7462tc4KTgUk4sxI3DD27W0gwkhj4p6MMYa4SsIMW4NM3xw6Oj1UuI06FDhw4dOnTo0KFDhw4dOnTo0KFDhw4dOvzf8D+CIQQwLMX+dAAAAABJRU5ErkJggg==",
      "title": "dwa_reservoir",
      "type": "layer"
    }
  ],
  "title": ""
}

The icon image is encoded in base64, and directly displayable in a web page.

Still WIP for the moment. I want to do more testing, and add unit tests. But preliminary comments are welcome.

Checklist

Commit messages are descriptive and explain the rationale for changes
Commits which fix bugs include Fixes #11111 at the bottom of the commit message
I have read the QGIS Coding Standards and this PR complies with them
New unit tests have been added for core changes
I have run the scripts/prepare-commit.sh script before each commit
I have evaluated whether it is appropriate for this PR to be backported, backport requests are left as label or comment

src/server/services/wms/qgswmsrenderer.cpp

elpaso · 2019-09-13T16:12:53Z

Did you consider using nlohmann::json instead of QJsonDocument ?
It's generally faster and has a nicer API.

elemoine · 2019-09-13T16:13:46Z

Did you consider using nlohmann::json instead of QJsonDocument ?
It's generally faster and has a nicer API.

You mean in my code? Or in the existing code written by @pblottiere?

elpaso · 2019-09-13T16:32:56Z

nlohmann::json was probably introduced after original work by Paul, I was suggesting that from now on we should use it unless there is a good reason not to.
All new API and WFS3 which are both json-based use the nlohmann, and QgsJsonUtils does too.

elemoine · 2019-09-13T16:43:08Z

nlohmann::json was probably introduced after original work by Paul, I was suggesting that from now on we should use it unless there is a good reason not to.
All new API and WFS3 which are both json-based use the nlohmann, and QgsJsonUtils does too.

Ok agree. But I do think this should be done with a separate PR.

elpaso · 2019-09-13T16:45:41Z

nlohmann::json was probably introduced after original work by Paul, I was suggesting that from now on we should use it unless there is a good reason not to.
All new API and WFS3 which are both json-based use the nlohmann, and QgsJsonUtils does too.

Ok agree. But I do think this should be done with a separate PR.

No problems with that, as you prefer.

elemoine · 2019-09-16T08:42:28Z

88093f438b703861efadee3556c15f83866857e3 adds unit tests.

I guess this is ready for more reviews. Thanks!

src/server/services/wms/qgswmsgetlegendgraphics.cpp

src/server/services/wms/qgswmsrenderer.h

pblottiere · 2019-09-16T20:19:49Z

Just some minor comments but it looks good to me, thanks @elemoine 👍!

This PR adds support for GetLegendGraphic responses encoded as JSON. It builds on previous work by @pblottiere, who added QgsLegendRenderer::exportLegendToJson for that exact purpose.

You made my day ;)

elemoine · 2019-09-17T08:19:47Z

Just some minor comments but it looks good to me, thanks @elemoine +1!

I just took your comments into account. Thanks a lot for your review Paul!

elemoine · 2019-09-17T13:58:19Z

No problems with that, as you prefer.

@elpaso happy to look at converting the code to using nlohmann::json when this is merged.

elpaso · 2019-09-17T14:03:07Z

@elemoine perfect, thanks!

elemoine · 2019-09-25T06:36:45Z

@elpaso @pblottiere @rldhont any news with this? @rldhont added a Frozen label. What's the reason for this label? When will this be unfrozen? Thank you.

nyalldawson · 2019-09-25T06:50:25Z

What's the reason for this label? When will this be unfrozen? Thank you.

It's a feature which wasn't merged before freeze, so it needs to wait till 3.10 final release occurs and master branch is unfrozen

elemoine · 2019-09-25T07:23:53Z

Thank you @nyalldawson

rldhont · 2019-09-27T10:33:40Z

@elpaso, @pblottiere or others, do you think this PR could be exempt of freeze ?

stale · 2019-10-11T10:39:46Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

rldhont · 2019-10-11T13:19:18Z

not stale, waiting for unfrozen master.

rldhont · 2019-10-11T13:19:49Z

@elemoine there is a conflict with test file.

elemoine · 2019-10-11T15:51:22Z

@rldhont thanks for letting me know. I just rebased my branch onto master, and pushed the result.

elpaso reviewed Sep 13, 2019

View reviewed changes

src/server/services/wms/qgswmsrenderer.cpp Outdated Show resolved Hide resolved

rldhont added the Server Related to QGIS server label Sep 14, 2019

rldhont added this to the 3.12 milestone Sep 14, 2019

rldhont added Frozen Feature freeze - Do not merge! Requires Tests! Waiting on the submitter to add unit tests before eligible for merging labels Sep 14, 2019

elemoine force-pushed the ele_glg branch from 3796ba5 to afeadb5 Compare September 16, 2019 06:47

elemoine changed the title ~~[WIP] Add json support to WMS GetLegendGraphic~~ Add json support to WMS GetLegendGraphic Sep 16, 2019

elemoine force-pushed the ele_glg branch from 88093f4 to 9ec13e4 Compare September 16, 2019 10:56

rldhont added Feature and removed Requires Tests! Waiting on the submitter to add unit tests before eligible for merging labels Sep 16, 2019

pblottiere reviewed Sep 16, 2019

View reviewed changes

src/server/services/wms/qgswmsgetlegendgraphics.cpp Outdated Show resolved Hide resolved

pblottiere reviewed Sep 16, 2019

View reviewed changes

src/server/services/wms/qgswmsrenderer.h Outdated Show resolved Hide resolved

elemoine force-pushed the ele_glg branch from 9ec13e4 to d7780cd Compare September 17, 2019 08:17

elemoine force-pushed the ele_glg branch 2 times, most recently from e756b49 to 64ef4cb Compare September 23, 2019 13:50

stale bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 11, 2019

stale bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 11, 2019

Éric Lemoine added 3 commits October 11, 2019 17:46

Add json support to WMS GetLegendGraphic

eb92ee1

Add tests for WMS GetLegendGraphic JSON

319cbd0

Use QgsServiceException::OGC_InvalidFormat when appropriate

38b7351

elemoine force-pushed the ele_glg branch from 64ef4cb to 38b7351 Compare October 11, 2019 15:50

pblottiere approved these changes Oct 16, 2019

View reviewed changes

rldhont added the Merge After Thaw For approved PRs which are ready to be merged as soon as master is thawed label Oct 18, 2019

nyalldawson removed the Frozen Feature freeze - Do not merge! label Oct 25, 2019

nyalldawson merged commit f3df32d into qgis:master Oct 26, 2019

elemoine deleted the ele_glg branch October 29, 2019 10:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add json support to WMS GetLegendGraphic #31747

Add json support to WMS GetLegendGraphic #31747

elemoine commented Sep 13, 2019 •

edited

Loading

elpaso commented Sep 13, 2019

elemoine commented Sep 13, 2019

elpaso commented Sep 13, 2019

elemoine commented Sep 13, 2019

elpaso commented Sep 13, 2019

elemoine commented Sep 16, 2019

pblottiere commented Sep 16, 2019

elemoine commented Sep 17, 2019

elemoine commented Sep 17, 2019

elpaso commented Sep 17, 2019 •

edited

Loading

elemoine commented Sep 25, 2019

nyalldawson commented Sep 25, 2019

elemoine commented Sep 25, 2019

rldhont commented Sep 27, 2019

stale bot commented Oct 11, 2019

rldhont commented Oct 11, 2019

rldhont commented Oct 11, 2019

elemoine commented Oct 11, 2019

Add json support to WMS GetLegendGraphic #31747

Add json support to WMS GetLegendGraphic #31747

Conversation

elemoine commented Sep 13, 2019 • edited Loading

Description

Checklist

elpaso commented Sep 13, 2019

elemoine commented Sep 13, 2019

elpaso commented Sep 13, 2019

elemoine commented Sep 13, 2019

elpaso commented Sep 13, 2019

elemoine commented Sep 16, 2019

pblottiere commented Sep 16, 2019

elemoine commented Sep 17, 2019

elemoine commented Sep 17, 2019

elpaso commented Sep 17, 2019 • edited Loading

elemoine commented Sep 25, 2019

nyalldawson commented Sep 25, 2019

elemoine commented Sep 25, 2019

rldhont commented Sep 27, 2019

stale bot commented Oct 11, 2019

rldhont commented Oct 11, 2019

rldhont commented Oct 11, 2019

elemoine commented Oct 11, 2019

elemoine commented Sep 13, 2019 •

edited

Loading

elpaso commented Sep 17, 2019 •

edited

Loading