Skip to content
This repository was archived by the owner on Dec 14, 2018. It is now read-only.

Commit 3e2c256

Browse files
author
N. Taylor Mullen
committed
Add FormTagHelper.
- Added the FormTagHelper. - Utilized the IHtmlGenerator to share base functionality with the HTMLHelper counterparts. - Added tests to validate FormTagHelper functionality. #1246
1 parent b7a38c3 commit 3e2c256

File tree

4 files changed

+680
-0
lines changed

4 files changed

+680
-0
lines changed

‎src/Microsoft.AspNet.Mvc.TagHelpers/FormTagHelper.cs

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using Microsoft.AspNet.Mvc.Rendering;
8+
using Microsoft.AspNet.Razor.Runtime.TagHelpers;
9+
using Microsoft.AspNet.Razor.TagHelpers;
10+
11+
namespace Microsoft.AspNet.Mvc.TagHelpers
12+
{
13+
/// <summary>
14+
/// <see cref="ITagHelper"/> implementation targeting &lt;form&gt; elements.
15+
/// </summary>
16+
[ContentBehavior(ContentBehavior.Append)]
17+
public class FormTagHelper : TagHelper
18+
{
19+
private const string RouteAttributePrefix = "route-";
20+
21+
[Activate]
22+
private ViewContext ViewContext { get; set; }
23+
24+
[Activate]
25+
private IHtmlGenerator Generator { get; set; }
26+
27+
/// <summary>
28+
/// The name of the action method.
29+
/// </summary>
30+
/// <remarks>
31+
/// If value contains a '/' this <see cref="ITagHelper"/> will do nothing.
32+
/// </remarks>
33+
public string Action { get; set; }
34+
35+
/// <summary>
36+
/// The name of the controller.
37+
/// </summary>
38+
public string Controller { get; set; }
39+
40+
/// <summary>
41+
/// The HTTP method for processing the form, either GET or POST.
42+
/// </summary>
43+
public string Method { get; set; }
44+
45+
/// <summary>
46+
/// Whether the anti-forgery token should be generated. Defaults to <c>true</c> if <see cref="Action"/> is not
47+
/// a URL, <c>false</c> otherwise.
48+
/// </summary>
49+
[HtmlAttributeName("anti-forgery")]
50+
public bool? AntiForgery { get; set; }
51+
52+
/// <inheritdoc />
53+
/// <remarks>Does nothing if <see cref="Action"/> contains a '/'.</remarks>
54+
public override void Process(TagHelperContext context, TagHelperOutput output)
55+
{
56+
bool antiForgeryDefault = true;
57+
58+
var routePrefixedAttributes = output.FindPrefixedAttributes(RouteAttributePrefix);
59+
60+
// If Action contains a '/' it means the user is attempting to use the FormTagHelper as a normal form.
61+
if (Action != null && Action.Contains('/'))
62+
{
63+
if (Controller != null || routePrefixedAttributes.Any())
64+
{
65+
// We don't know how to generate a form action since a Controller attribute was also provided.
66+
throw new InvalidOperationException(
67+
Resources.FormatFormTagHelper_CannotDetermineAction(
68+
"<form>",
69+
nameof(Action).ToLowerInvariant(),
70+
nameof(Controller).ToLowerInvariant(),
71+
RouteAttributePrefix));
72+
}
73+
74+
// User is using the FormTagHelper like a normal <form> tag, anti-forgery default should be false to
75+
// not force the anti-forgery token onto the user.
76+
antiForgeryDefault = false;
77+
78+
// Restore Action, Method and Route HTML attributes if they were provided, user wants non-TagHelper <form>.
79+
output.CopyHtmlAttribute(nameof(Action), context);
80+
81+
if (Method != null)
82+
{
83+
output.CopyHtmlAttribute(nameof(Method), context);
84+
}
85+
}
86+
else
87+
{
88+
var routeValues = GetRouteValues(output, routePrefixedAttributes);
89+
var tagBuilder = Generator.GenerateForm(ViewContext,
90+
Action,
91+
Controller,
92+
routeValues,
93+
Method,
94+
htmlAttributes: null);
95+
96+
if (tagBuilder != null)
97+
{
98+
// We don't want to do a full merge because we want the TagHelper content to take precedence.
99+
output.Merge(tagBuilder);
100+
}
101+
}
102+
103+
if (AntiForgery ?? antiForgeryDefault)
104+
{
105+
var antiForgeryTagBuilder = Generator.GenerateAntiForgery(ViewContext);
106+
if (antiForgeryTagBuilder != null)
107+
{
108+
output.Content += antiForgeryTagBuilder.ToString(TagRenderMode.SelfClosing);
109+
}
110+
}
111+
}
112+
113+
// TODO: We will not need this method once https://github.com/aspnet/Razor/issues/89 is completed.
114+
private static Dictionary<string, object> GetRouteValues(
115+
TagHelperOutput output, IEnumerable<KeyValuePair<string, string>> routePrefixedAttributes)
116+
{
117+
Dictionary<string, object> routeValues = null;
118+
if (routePrefixedAttributes.Any())
119+
{
120+
// Prefixed values should be treated as bound attributes, remove them from the output.
121+
output.RemoveRange(routePrefixedAttributes);
122+
123+
// Generator.GenerateForm does not accept a Dictionary<string, string> for route values.
124+
routeValues = routePrefixedAttributes.ToDictionary(
125+
attribute => attribute.Key.Substring(RouteAttributePrefix.Length),
126+
attribute => (object)attribute.Value);
127+
}
128+
129+
return routeValues;
130+
}
131+
}
132+
}

‎src/Microsoft.AspNet.Mvc.TagHelpers/Properties/Resources.Designer.cs

Lines changed: 46 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Microsoft.AspNet.Mvc.TagHelpers/Resources.resx

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="FormTagHelper_CannotDetermineAction" xml:space="preserve">
121+
<value>Cannot determine an {1} for {0}. A {0} with a URL-based {1} must not have attributes starting with {3} or a {2} attribute.</value>
122+
</data>
123+
</root>

0 commit comments

Comments
 (0)