New function: sqlpage.path

fixes #114

Author: lovasoa

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 0.15.0
 
+ - New function: [`sqlpage.path`](https://sql.ophir.dev/functions.sql?function=path#function) to get the path of the current page.
  - Add a new `align_right` attribute to the [table](https://sql.ophir.dev/documentation.sql?component=table#component) component to align a column to the right.
  - Fix display of long titles in the shell component.
  - New [`sqlpage.variables`](https://sql.ophir.dev/functions.sql?function=variables#function) function for easy handling of complex forms

examples/official-site/sqlpage/migrations/21_path.sql

@@ -0,0 +1,26 @@
+INSERT INTO sqlpage_functions (
+        "name",
+        "introduced_in_version",
+        "icon",
+        "description_md"
+    )
+VALUES (
+        'path',
+        '0.15.0',
+        'slashes',
+        'Returns the request path of the current page.
+This is useful to generate links to the current page, and when you have a proxy in front of your SQLPage server that rewrites the URL.
+
+### Example
+
+If we have a page in a file named `my page.sql` at the root of your SQLPage installation
+then the following SQL query:
+
+```sql
+select ''text'' as component, sqlpage.path() as contents;
+```
+
+will return `/my%20page.sql`.
+
+> Note that the path is URL-encoded.
+');

src/webserver/database/sql_pseudofunctions.rs

@@ -35,6 +35,7 @@ pub(super) enum StmtParam {
     EnvironmentVariable(String),
     SqlPageVersion,
     Literal(String),
+    Path,
 }
 
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
@@ -87,6 +88,7 @@ pub(super) fn func_call_to_param(func_name: &str, arguments: &mut [FunctionArg])
         }
         "version" => StmtParam::SqlPageVersion,
         "variables" => parse_get_or_post(extract_single_quoted_string_optional(arguments)),
+        "path" => StmtParam::Path,
         unknown_name => StmtParam::Error(format!(
             "Unknown function {unknown_name}({})",
             FormatArguments(arguments)
@@ -207,6 +209,7 @@ pub(super) fn extract_req_param_non_nested<'a>(
         StmtParam::SqlPageVersion => Some(Cow::Borrowed(env!("CARGO_PKG_VERSION"))),
         StmtParam::Literal(x) => Some(Cow::Owned(x.to_string())),
         StmtParam::AllVariables(get_or_post) => extract_get_or_post(*get_or_post, request),
+        StmtParam::Path => Some(Cow::Borrowed(&request.path)),
     })
 }
 

src/webserver/http.rs

@@ -324,6 +324,7 @@ impl SingleOrVec {
 
 #[derive(Debug)]
 pub struct RequestInfo {
+    pub path: String,
     pub get_variables: ParamMap,
     pub post_variables: ParamMap,
     pub headers: ParamMap,
@@ -384,6 +385,7 @@ async fn extract_request_info(req: &mut ServiceRequest, app_state: Arc<AppState>
         .map(Authorization::into_scheme);
 
     RequestInfo {
+        path: req.path().to_string(),
         headers: param_map(headers),
         get_variables: param_map(get_variables),
         post_variables: param_map(post_variables),

tests/sql_test_files/it_works_path.sql

@@ -0,0 +1,6 @@
+select 'text' as component, 
+    CASE sqlpage.path()
+        WHEN '/tests/sql_test_files/it_works_path.sql' THEN 'It works !'
+        ELSE 'It failed ! Expected %2F, got ' || sqlpage.path() || '.'
+    END
+    AS contents;