Accept a string as request method in QHttpServer::route()

Allow writing simpler source code.

For example:

httpserver.route("/", "GET|POST", [] () { return ""; })

Instead of:

httpserver.route("/", QHttpServerRequest::Method::Post | QHttpServerRequest::Method::Get, [] () { return ""; })

Change-Id: Id0a754eccaba6b5f9f3be6a3b975383eb94840a0
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>

4 files changed, 76 insertions, 4 deletions

diff --git a/src/httpserver/qhttpserverrequest.h b/src/httpserver/qhttpserverrequest.h
index 0aeb1d8..c0afbce 100644
--- a/src/httpserver/qhttpserverrequest.h
+++ b/src/httpserver/qhttpserverrequest.h
@@ -63,7 +63,18 @@ public:
         Post    = 0x0008,
         Head    = 0x0010,
         Options = 0x0020,
-        Patch   = 0x0040
+        Patch   = 0x0040,
+
+        All = Get | Put | Delete | Post | Head | Options | Patch,
+
+        // Include upper-case aliases for the sake of parsing from strings:
+        GET     = Get,
+        PUT     = Put,
+        DELETE  = Delete,
+        POST    = Post,
+        HEAD    = Head,
+        OPTIONS = Options,
+        PATCH   = Patch
     };
     Q_ENUM(Method)
     Q_DECLARE_FLAGS(Methods, Method)
diff --git a/src/httpserver/qhttpserverrouter.cpp b/src/httpserver/qhttpserverrouter.cpp
index 1dc924c..e28d5cf 100644
--- a/src/httpserver/qhttpserverrouter.cpp
+++ b/src/httpserver/qhttpserverrouter.cpp
@@ -281,7 +281,7 @@ bool QHttpServerRouter::addRuleImpl(QHttpServerRouterRule *rule,
 {
     Q_D(QHttpServerRouter);
 
-    if (!rule->createPathRegexp(types, d->converters)) {
+    if (!rule->hasValidMethods() || !rule->createPathRegexp(types, d->converters)) {
         delete rule;
         return false;
     }
diff --git a/src/httpserver/qhttpserverrouterrule.cpp b/src/httpserver/qhttpserverrouterrule.cpp
index d486218..151e411 100644
--- a/src/httpserver/qhttpserverrouterrule.cpp
+++ b/src/httpserver/qhttpserverrouterrule.cpp
@@ -30,7 +30,9 @@
 #include <QtHttpServer/qhttpserverrouterrule.h>
 
 #include <private/qhttpserverrouterrule_p.h>
+#include <private/qhttpserverrequest_p.h>
 
+#include <QtCore/qmetaobject.h>
 #include <QtCore/qloggingcategory.h>
 #include <QtCore/qregularexpression.h>
 #include <QtCore/qdebug.h>
@@ -39,6 +41,27 @@ QT_BEGIN_NAMESPACE
 
 Q_LOGGING_CATEGORY(lcRouterRule, "qt.httpserver.router.rule")
 
+static QHttpServerRequest::Methods strToMethods(const char *strMethods)
+{
+    QHttpServerRequest::Methods methods;
+
+    static const auto index = QHttpServerRequest::staticMetaObject.indexOfEnumerator("Method");
+    if (index == -1) {
+        qCWarning(lcRouterRule, "Can not find QMetaEnum for enum Method");
+        return methods;
+    }
+
+    static const QMetaEnum en = QHttpServerRequest::staticMetaObject.enumerator(index);
+    bool ok = false;
+    const int val = en.keysToValue(strMethods, &ok);
+    if (ok)
+        methods = static_cast<decltype(methods)>(val);
+    else
+        qCWarning(lcRouterRule, "Can not convert %s to QHttpServerRequest::Method", strMethods);
+
+    return methods;
+}
+
 /*!
     \class QHttpServerRouterRule
     \brief The QHttpServerRouterRule is the base class for QHttpServerRouter rules.
@@ -94,12 +117,14 @@ Q_LOGGING_CATEGORY(lcRouterRule, "qt.httpserver.router.rule")
 /*!
     Constructs a rule with pathPattern \a pathPattern, and routerHandler \a routerHandler.
 
-    The rule accepts any HTTP method.
+    The rule accepts all HTTP methods by default.
+
+    \sq QHttpServerRequest::Method
 */
 QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern,
                                              RouterHandler &&routerHandler)
     : QHttpServerRouterRule(pathPattern,
-                            QHttpServerRequest::Methods(),
+                            QHttpServerRequest::Method::All,
                             std::forward<RouterHandler>(routerHandler))
 {
 }
@@ -107,6 +132,10 @@ QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern,
 /*!
     Constructs a rule with pathPattern \a pathPattern, methods \a methods
     and routerHandler \a routerHandler.
+
+    The rule accepts any combinations of available HTTP methods.
+
+    \sa QHttpServerRequest::Method
 */
 QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern,
                                              const QHttpServerRequest::Methods methods,
@@ -119,6 +148,24 @@ QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern,
 }
 
 /*!
+    Constructs a rule with pathPattern \a pathPattern, methods \a methods
+    and routerHandler \a routerHandler.
+
+    \note \a methods shall be joined with | as separator (not spaces or commas)
+    and that either the upper-case or the capitalised form may be used.
+
+    \sa QMetaEnum::keysToValue
+*/
+QHttpServerRouterRule::QHttpServerRouterRule(const QString &pathPattern,
+                                             const char *methods,
+                                             RouterHandler &&routerHandler)
+    : QHttpServerRouterRule(pathPattern,
+                            strToMethods(methods),
+                            std::forward<RouterHandler>(routerHandler))
+{
+}
+
+/*!
     \internal
  */
 QHttpServerRouterRule::QHttpServerRouterRule(QHttpServerRouterRulePrivate *d)
@@ -134,6 +181,15 @@ QHttpServerRouterRule::~QHttpServerRouterRule()
 }
 
 /*!
+    Returns true if the methods is valid
+*/
+bool QHttpServerRouterRule::hasValidMethods() const
+{
+    Q_D(const QHttpServerRouterRule);
+    return d->methods & QHttpServerRequest::Method::All;
+}
+
+/*!
     This function is called by QHttpServerRouter when a new request is received.
 */
 bool QHttpServerRouterRule::exec(const QHttpServerRequest &request,
diff --git a/src/httpserver/qhttpserverrouterrule.h b/src/httpserver/qhttpserverrouterrule.h
index 235e982..2b168b4 100644
--- a/src/httpserver/qhttpserverrouterrule.h
+++ b/src/httpserver/qhttpserverrouterrule.h
@@ -56,6 +56,9 @@ public:
     explicit QHttpServerRouterRule(const QString &pathPattern,
                                    const QHttpServerRequest::Methods methods,
                                    RouterHandler &&routerHandler);
+    explicit QHttpServerRouterRule(const QString &pathPattern,
+                                   const char * methods,
+                                   RouterHandler &&routerHandler);
 
     QHttpServerRouterRule(QHttpServerRouterRule &&other) = delete;
     QHttpServerRouterRule &operator=(QHttpServerRouterRule &&other) = delete;
@@ -65,6 +68,8 @@ public:
 protected:
     bool exec(const QHttpServerRequest &request, QTcpSocket *socket) const;
 
+    bool hasValidMethods() const;
+
     bool createPathRegexp(const std::initializer_list<int> &metaTypes,
                           const QMap<int, QLatin1String> &converters);