SWHID: deal with escaping in origin qualifiers
ClosedPublic
Actions

Authored by zack on Apr 24 2020, 4:59 PM.

Details

Reviewers

rdicosmo
anlambert
vlorentz

Group Reviewers

Reviewers

Commits

rDMOD56cf99aeaf38: SWHID: deal with escaping in origin qualifiers

Summary

The current spec is incorrect on this point, as (at least) ";" can appear in
origin URLs, and hence SWHID origin qualifiers, breaking SWHID parsing. This is
a minimal proposal that only requires to URL-escape the "%" and ";" characters,
as we do for paths.

... but to be honest the more I look into this the more it worries me. It would
be much better to fully percent-escape origin URLs, but that has the drawback
of making SWHID much less nicer to read.

I hope only escaping these two characters is enough, but I'm not entirely sure
it is...

Diff Detail

Repository

rDMOD Data model

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

Event Timeline

zack created this revision.Apr 24 2020, 4:59 PM

Build is green

Patch application report for D3065 (id=10899)

Rebasing onto 3f388086cb...

Current branch diff-target is up to date.

Changes applied before test

commit 56cf99aeaf385a1928f7e16bf9fd85e7c6bfcf9e
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Fri Apr 24 16:56:47 2020 +0200

    SWHID: deal with escaping in origin qualifiers

See https://jenkins.softwareheritage.org/job/DMOD/job/tests-on-diff/47/ for more details.

Harbormaster completed remote builds in B12051: Diff 10899.Apr 24 2020, 5:01 PM

For the record, there is currently no origin with a ';' character in its URL but better anticipate that case indeed.

softwareheritage=> select * from origin where url like '%;%';
 id | url 
----+-----
(0 ligne)

Looks good to me and I also think only percent encoding ;'; and '%' is better for SWHID readability.

This revision is now accepted and ready to land.Apr 24 2020, 5:13 PM

vlorentz accepted this revision.Apr 24 2020, 5:16 PM

Closed by commit rDMOD56cf99aeaf38: SWHID: deal with escaping in origin qualifiers (authored by zack). · Explain WhyApr 25 2020, 8:41 AM

This revision was automatically updated to reflect the committed changes.

zack added a commit: rDMOD56cf99aeaf38: SWHID: deal with escaping in origin qualifiers.

Revision Contents
Changeset List

Path

Size

docs/

persistent-identifiers.rst

16 lines

Diff 10905

View Options

docs/persistent-identifiers.rst

SWHID: deal with escaping in origin qualifiersClosedPublicActions