Skip to content

Parse and validate URL template at manifest parse time #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 27, 2018
Merged

Parse and validate URL template at manifest parse time #34

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7cbfae
Define post-processing steps at manifest parse time to parse the URL.
mgiuca Feb 8, 2018
e65360b
Rename variable for consistency.
mgiuca Feb 8, 2018
58eb8d1
Add assertions in the launching algorithm.
mgiuca Feb 8, 2018
dd67553
Added note about validation errors.
mgiuca Feb 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 109 additions & 22 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,9 @@ <h2>
</li>
</ul>
</section>
<section>
<section data-link-for="WebAppManifest">
<h2>
Extension to the <code>WebAppManifest</code> dictionary
Extension to the Web App Manifest
</h2>
<p>
The following IDL extends the <dfn data-cite=
Expand All @@ -184,7 +184,22 @@ <h2>
ShareTarget share_target;
};
</pre>
<section data-dfn-for="WebAppManifest" data-link-for="WebAppManifest">
<p>
The following steps are added to the <a data-cite=
"!appmanifest#dfn-extension-point">extension point</a> in the steps for
<a data-cite="!appmanifest#dfn-processing-a-manifest">processing a
manifest</a>:
</p>
<ol>
<li>Set <var>manifest</var>["<a>share_target</a>"] to the result of
running <a>post-processing the <code>share_target</code> member</a>
given <var>manifest</var>["<a>share_target</a>"],
<var>manifest</var>["<a data-cite=
"!appmanifest#dom-webappmanifest-scope"><code>scope</code></a>"], and
<var>manifest URL</var>.
</li>
</ol>
<section data-dfn-for="WebAppManifest">
<h3>
<code>share_target</code> member
</h3>
Expand All @@ -202,6 +217,77 @@ <h3>
"!WebShare#dfn-share-target">share target</a>.
</p>
<div class="issue" data-number="27"></div>
<p>
The steps for <dfn>post-processing the <code>share_target</code>
member</dfn> is given by the following algorithm. The algorithm takes
a <a>ShareTarget</a> <var>share target</var>, a <a data-cite=
"!URL#concept-url">URL</a> <var>scope URL</var>, and a <a data-cite=
"!URL#concept-url">URL</a> <var>manifest URL</var>. This algorithm
returns a <a>ShareTarget</a> or <code>undefined</code>.
</p>
<ol>
<li>If <var>share target</var> is <code>undefined</code>, then return
<code>undefined</code>.
</li>
<li>Let <var>URL template string</var> be <var>share
target["<a data-link-for="ShareTarget">url_template</a>"]</var>.
</li>
<li>If <var>URL template string</var> is <code>undefined</code>,
<a data-cite="!appmanifest#dfn-issue-a-developer-warning">issue a
developer warning</a> that <a data-link-for=
"ShareTarget">url_template</a> is required, and return
<code>undefined</code>.
</li>
<li>Let <var>URL template</var> be the result of running the
<a data-cite="!URL#concept-url-parser">URL parser</a> on <var>URL
template string</var>, with <var>manifest URL</var> as the
<var>base</var>, and no <var>encoding override</var>.
(<a data-cite="!URL#validation-error">Validation errors</a> are
expected due to <code>{</code> and <code>}</code>, and should be
ignored.) If the result is failure, <a data-cite=
"!appmanifest#dfn-issue-a-developer-warning">issue a developer
warning</a> that <a data-link-for="ShareTarget">url_template</a> is
invalid, and return <code>undefined</code>.
</li>
<li>If <var>URL template</var> is not <a data-cite=
"!appmanifest#dfn-within-scope">within scope</a> of <var>scope
URL</var>, <a data-cite="!appmanifest#dfn-issue-a-developer-warning">
issue a developer warning</a> that <a data-link-for=
"ShareTarget">url_template</a> is outside of the <a data-cite=
"!appmanifest#dfn-navigation-scope">navigation scope</a>, and
return <code>undefined</code>.
</li>
<li>If <var>URL template</var>'s <a data-cite=
"!URL#concept-url-query">query</a> is not null, run the <a>replace
placeholders</a> algorithm on <var>URL template</var>'s query with
<code>{}</code> (the empty <a data-cite=
"!WebShare#dom-sharedata"><code>ShareData</code></a>). If the result
is failure, <a data-cite=
"!appmanifest#dfn-issue-a-developer-warning">issue a developer
warning</a> that <a data-link-for="ShareTarget">url_template</a> is
invalid, and return <code>undefined</code>.
</li>
<li>If <var>URL template</var>'s <a data-cite=
"!URL#concept-url-fragment">fragment</a> is not null, run the
<a>replace placeholders</a> algorithm on <var>URL template</var>'s
fragment with <code>{}</code>. If the result is failure,
<a data-cite="!appmanifest#dfn-issue-a-developer-warning">issue a
developer warning</a> that <a data-link-for=
"ShareTarget">url_template</a> is invalid, and return
<code>undefined</code>.
</li>
<li>Set <var>share target["<a data-link-for=
"ShareTarget">url_template</a>"]</var> to <var>URL template</var>.
</li>
<li>Return <var>share target</var>.
</li>
</ol>
<p class="note">
The above steps that run the <a>replace placeholders</a> algorithm
are to validate the URL template and throw away the result. If it is
invalid, the share target is ignored. The launch algorithm below
repeats these same steps using the actual share data.
</p>
</section>
<section data-dfn-for="ShareTarget" data-link-for="ShareTarget">
<h3>
Expand Down Expand Up @@ -361,33 +447,28 @@ <h3>
run the following steps:
</p>
<ol>
<li>Let <var>template URL</var> be the result of running the
<a data-cite="!URL#concept-url-parser">URL parser</a> on
<li>Let <var>URL template</var> be
<var>manifest["<a>share_target</a>"]["<a data-link-for=
"ShareTarget">url_template</a>"]</var>, with <var>manifest URL</var>
as the <var>base</var>, and no <var>encoding override</var>. If the
result is failure, abort these steps.
</li>
<li>If <var>template URL</var> is not <a data-cite=
"!appmanifest#dfn-within-scope">within scope</a> of
<var>manifest</var>'s scope URL, abort these steps.
"ShareTarget">url_template</a>"]</var>. <b><a data-cite=
"!INFRA#assert">Assert</a></b>: <var>URL template</var> is not <code>
undefined</code>.
</li>
<li>Let <var>final URL</var> be a copy of <var>template URL</var>,
<li>Let <var>final URL</var> be a copy of <var>URL template</var>,
with the following changes:
<ol>
<li>If <var>template URL</var>'s <a data-cite=
<li>If <var>URL template</var>'s <a data-cite=
"!URL#concept-url-query">query</a> is not null, <var>final
URL</var>'s query is the result of running the <a>replace
placeholders</a> algorithm on <var>template URL</var>'s query
with <var>data</var>. If the result is failure, abort these
steps.
placeholders</a> algorithm on <var>URL template</var>'s query
with <var>data</var>. <b><a data-cite=
"!INFRA#assert">Assert</a></b>: This did not return failure.
</li>
<li>If <var>template URL</var>'s <a data-cite=
<li>If <var>URL template</var>'s <a data-cite=
"!URL#concept-url-fragment">fragment</a> is not null, <var>final
URL</var>'s fragment is the result of running the <a>replace
placeholders</a> algorithm on <var>template URL</var>'s fragment
with <var>data</var>. If the result is failure, abort these
steps.
placeholders</a> algorithm on <var>URL template</var>'s fragment
with <var>data</var>. <b><a data-cite=
"!INFRA#assert">Assert</a></b>: This did not return failure.
</li>
</ol>
</li>
Expand All @@ -396,6 +477,13 @@ <h3>
empty <var>features</var>.
</li>
</ol>
<p class="note">
The assertions in this algorithm assume that <var>manifest</var> has
had the <a>post-processing the <code>share_target</code> member</a>
algorithm run on it and still has a <a>share_target</a> afterwards.
That algorithm deletes any <a>share_target</a> member that would
violate these assertions.
</p>
<div class="note">
<p>
Only the query and fragment parts of the URL have placeholders
Expand Down Expand Up @@ -476,7 +564,6 @@ <h3>
into the URL template.
</p>
</div>
<div class="issue" data-number="25"></div>
<p>
The <dfn>reserved percent-encode set</dfn> is the <a data-cite=
"!URL#userinfo-percent-encode-set">userinfo percent-encode set</a>
Expand Down