new function: sqlpage.request_method

Author: lovasoa

CHANGELOG.md

@@ -1,6 +1,6 @@
 # CHANGELOG.md
 
-## unreleased 
+## 0.20.6 (unreleased) 
 
  - `sqlpage.hash_password(NULL)` now returns `NULL` instead of throwing an error. This behavior was changed unintentionally in 0.20.5 and could have broken existing SQLPage websites.
  - The [dynamic](https://sql.ophir.dev/documentation.sql?component=dynamic#component) component now supports multiple `properties` attributes. The following is now possible:
@@ -12,6 +12,7 @@
  - Casting values from one type to another using the `::` operator is only supported by PostgreSQL. SQLPage versions before 0.20.5 would silently convert all casts to the `CAST(... AS ...)` syntax, which is supported by all databases. Since 0.20.5, SQLPage started to respect the original `::` syntax, and pass it as-is to the database. This broke existing SQLPage websites that used the `::` syntax with databases other than PostgreSQL. For backward compatibility, this version of SQLPage re-establishes the previous behavior, converts `::` casts on non-PostgreSQL databases to the `CAST(... AS ...)` syntax, but will display a warning in the logs. 
     - In short, if you saw an error like `Error: unrecognized token ":"` after upgrading to 0.20.5, this version should fix it.
  - The `dynamic` component now properly displays error messages when its properties are invalid. There used to be a bug where errors would be silently ignored, making it hard to debug invalid dynamic components.
+ - New [`sqlpage.request_method`](https://sql.ophir.dev/functions.sql?function=request_method#function) function to get the HTTP method used to access the current page. This is useful to create pages that behave differently depending on whether they are accessed with a GET request (to display a form, for instance) or a POST request (to process the form).
 
 ## 0.20.5 (2024-05-07)
 

examples/official-site/sqlpage/migrations/43_request_method.sql

@@ -0,0 +1,34 @@
+INSERT INTO
+    sqlpage_functions (
+        "name",
+        "introduced_in_version",
+        "icon",
+        "description_md"
+    )
+VALUES
+    (
+        'request_method',
+        '0.20.6',
+        'http-get',
+        'Returns the HTTP request method (GET, POST, etc.) used to access the page.
+
+# HTTP request methods
+
+HTTP request methods (also known as verbs) are used to indicate the desired action to be performed on the identified resource. The most common methods are:
+ - **GET**: retrieve information from the server. This is the default method used by browsers when you click on a link.
+ - **POST**: submit data to be processed by the server. This is the default method used by browsers when you submit a form.
+ - **PUT**: replace the current representation of the target resource with the request payload. Most commonly used in REST APIs.
+ - **DELETE**: remove the target resource.
+ - **PATCH**, **HEAD**, **OPTIONS**, **CONNECT**, **TRACE**: less common methods that are used in specific situations.
+
+# Example
+
+```sql
+select ''redirect'' as component,
+    ''/error?msg=expected+a+PUT+request'' as link,
+where sqlpage.request_method() != ''PUT'';
+
+insert into my_table (column1, column2) values (:value1, :value2);
+```
+'
+    );

src/webserver/database/sqlpage_functions/functions.rs

@@ -26,6 +26,7 @@ super::function_definition_macro::sqlpage_functions! {
     random_string(string_length: SqlPageFunctionParam<usize>);
     read_file_as_data_url((&RequestInfo), file_path: Option<Cow<str>>);
     read_file_as_text((&RequestInfo), file_path: Option<Cow<str>>);
+    request_method((&RequestInfo));
     run_sql((&RequestInfo), sql_file_path: Option<Cow<str>>);
 
     uploaded_file_mime_type((&RequestInfo), upload_name: Cow<str>);
@@ -340,6 +341,10 @@ fn mime_guess_from_filename(filename: &str) -> mime_guess::Mime {
     maybe_mime.unwrap_or(mime_guess::mime::APPLICATION_OCTET_STREAM)
 }
 
+async fn request_method(request: &RequestInfo) -> String {
+    request.method.to_string()
+}
+
 async fn run_sql<'a>(
     request: &'a RequestInfo,
     sql_file_path: Option<Cow<'a, str>>,

src/webserver/http_request_info.rs

@@ -24,6 +24,7 @@ use tokio_stream::StreamExt;
 
 #[derive(Debug)]
 pub struct RequestInfo {
+    pub method: actix_web::http::Method,
     pub path: String,
     pub protocol: String,
     pub get_variables: ParamMap,
@@ -40,6 +41,7 @@ pub struct RequestInfo {
 impl Clone for RequestInfo {
     fn clone(&self) -> Self {
         Self {
+            method: self.method.clone(),
             path: self.path.clone(),
             protocol: self.protocol.clone(),
             get_variables: self.get_variables.clone(),
@@ -61,6 +63,7 @@ pub(crate) async fn extract_request_info(
     app_state: Arc<AppState>,
 ) -> anyhow::Result<RequestInfo> {
     let (http_req, payload) = req.parts_mut();
+    let method = http_req.method().clone();
     let protocol = http_req.connection_info().scheme().to_string();
     let config = &app_state.config;
     let (post_variables, uploaded_files) = extract_post_data(http_req, payload, config).await?;
@@ -86,6 +89,7 @@ pub(crate) async fn extract_request_info(
         .map(Authorization::into_scheme);
 
     Ok(RequestInfo {
+        method,
         path: req.path().to_string(),
         headers: param_map(headers),
         get_variables: param_map(get_variables),

tests/sql_test_files/it_works_request_method.sql

@@ -0,0 +1,12 @@
+set actual = sqlpage.request_method()
+set expected = 'GET';
+
+select 'text' as component, 
+    case $actual
+        when $expected
+          then 'It works !'
+        else 
+            'Failed.
+            Expected: ' || $expected ||
+            'Got: ' || $actual
+        end as contents;