Skip to content
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

Jump to bottom

registerFormInterface improvements #156

Merged
merged 1 commit into from
Jan 10, 2013
Merged

registerFormInterface improvements #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 15 additions & 11 deletions source/vibe/http/form.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import std.string;
import std.traits;
import std.conv;
import std.typecons;
public import std.typecons : Yes, No;

struct FilePart {
InetHeaderMap headers;
Expand Down Expand Up @@ -203,6 +204,8 @@ private bool parseMultipartFormPart(InputStream stream, ref string[string] form,
"/mywebapp/welcomePage/getWelcomePage" if MethodStyle is Unaltered.

style = How the url part representing the method name should be altered.
strict = Yes.strict if you want missing parameters in the form to be an error. No.strict if you are happy with the types' default value in this case.
(If you have overloads this might cause not the best matching overload to be chosen.)

Examples:

Expand Down Expand Up @@ -245,7 +248,7 @@ private bool parseMultipartFormPart(InputStream stream, ref string[string] form,

*/
void registerFormInterface(I)(UrlRouter router, I instance, string url_prefix,
MethodStyle style = MethodStyle.Unaltered)
MethodStyle style = MethodStyle.Unaltered, Flag!"strict" strict=Yes.strict)
{
foreach( method; __traits(allMembers, I) ){
//pragma(msg, "What: "~"&instance."~method);
Expand All @@ -254,7 +257,7 @@ void registerFormInterface(I)(UrlRouter router, I instance, string url_prefix,
//pragma(msg, "Is delegate: "~to!string(is(typeof(mixin("I."~method)) == delegate )));
static if( is(typeof(mixin("I."~method)) == function) && !__traits(isStaticFunction, mixin("I."~method)) && (method.startsWith("get") || method.startsWith("query") || method.startsWith("add")
|| method.startsWith("create") || method.startsWith("post") || method == "index" )) {
registerFormMethod!method(router, instance, url_prefix, style);
registerFormMethod!method(router, instance, url_prefix, style, strict);
}
}
}
Expand Down Expand Up @@ -292,13 +295,13 @@ unittest {
method = The name of the method to register. It might be
overloaded, one overload has to match any given form data, otherwise an error is triggered.
*/
void registerFormMethod(string method, I)(UrlRouter router, I instance, string url_prefix, MethodStyle style = MethodStyle.Unaltered)
void registerFormMethod(string method, I)(UrlRouter router, I instance, string url_prefix, MethodStyle style = MethodStyle.Unaltered, Flag!"strict" strict=Yes.strict)
{
string url(string name) {
return url_prefix ~ adjustMethodStyle(name, style);
}

auto handler=formMethodHandler!(I, method)(instance);
auto handler=formMethodHandler!(I, method)(instance, strict);
string url_method= method=="index" ? "" : method;
router.get(url(url_method), handler);
router.post(url(url_method), handler);
Expand All @@ -316,12 +319,12 @@ void registerFormMethod(string method, I)(UrlRouter router, I instance, string u
Returns: A HttpServerRequestDelegate which passes over any form data to the given function.
*/
/// private
HttpServerRequestDelegate formMethodHandler(DelegateType)(DelegateType func) if(isCallable!DelegateType)
HttpServerRequestDelegate formMethodHandler(DelegateType)(DelegateType func, Flag!"strict" strict=Yes.strict) if(isCallable!DelegateType)
{
void handler(HttpServerRequest req, HttpServerResponse res)
{
string error;
enforce(applyParametersFromAssociativeArray(req, res, func, error), error);
enforce(applyParametersFromAssociativeArray(req, res, func, error, strict), error);
}
return &handler;
}
Expand All @@ -333,7 +336,7 @@ HttpServerRequestDelegate formMethodHandler(DelegateType)(DelegateType func) if(
of the passed method and will only raise an error if no conforming overload is found.
*/
/// private
HttpServerRequestDelegate formMethodHandler(T, string method)(T inst)
HttpServerRequestDelegate formMethodHandler(T, string method)(T inst, Flag!"strict" strict)
{
import std.stdio;
void handler(HttpServerRequest req, HttpServerResponse res)
Expand All @@ -345,7 +348,7 @@ HttpServerRequestDelegate formMethodHandler(T, string method)(T inst)
foreach(func; __traits(getOverloads, T, method)) {
string error;
ReturnType!func delegate(ParameterTypeTuple!func) myoverload=&__traits(getMember, inst, method);
if(applyParametersFromAssociativeArray!func(req, res, myoverload, error)) {
if(applyParametersFromAssociativeArray!func(req, res, myoverload, error, strict)) {
return;
}
errors~="Overload "~method~typeid(ParameterTypeTuple!func).toString()~" failed: "~error~"\n\n";
Expand Down Expand Up @@ -396,17 +399,18 @@ HttpServerRequestDelegate formMethodHandler(T, string method)(T inst)
has a parameter of matching type.

error = This string will be set to a descriptive message if not all parameters could be matched.
strict = Yes.strict if you want missing parameters in the form to be an error. No.strict if you are happy with the types default value in this case.

Returns: true if successful, false otherwise.
*/
/// private
private bool applyParametersFromAssociativeArray(Func)(HttpServerRequest req, HttpServerResponse res, Func func, out string error) {
private bool applyParametersFromAssociativeArray(Func)(HttpServerRequest req, HttpServerResponse res, Func func, out string error, Flag!"strict" strict) {
return applyParametersFromAssociativeArray!(Func, Func)(req, res, func, error);
}

// Overload which takes additional parameter for handling overloads of func.
/// private
private bool applyParametersFromAssociativeArray(alias Overload, Func)(HttpServerRequest req, HttpServerResponse res, Func func, out string error) {
private bool applyParametersFromAssociativeArray(alias Overload, Func)(HttpServerRequest req, HttpServerResponse res, Func func, out string error, Flag!"strict" strict) {
alias ParameterTypeTuple!Overload ParameterTypes;
ParameterTypes args;
string[string] form = req.method == HttpMethod.GET ? req.query : req.form;
Expand All @@ -420,7 +424,7 @@ private bool applyParametersFromAssociativeArray(alias Overload, Func)(HttpServe
args[i] = res;
}
else {
count+=loadFormDataRecursiveSingle(form, args[i], item, e, Yes.strict);
count+=loadFormDataRecursiveSingle(form, args[i], item, e, strict);
}
}
error=e.message;
Expand Down