spring-macros 0.4.11

spring-rs Procedural Macros implementation
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
//! Sa-Token authentication macros for spring-rs
//!
//! These macros provide annotation-style authentication similar to Java's Sa-Token.
//! They generate code that converts SaTokenError to spring-web's WebError.
//!
//! # Available Macros
//!
//! - `#[sa_check_login]` - Check if user is logged in
//! - `#[sa_check_role("role")]` - Check if user has specific role
//! - `#[sa_check_permission("permission")]` - Check if user has specific permission
//! - `#[sa_check_roles_and("role1", "role2")]` - Check if user has all specified roles
//! - `#[sa_check_roles_or("role1", "role2")]` - Check if user has any of specified roles
//! - `#[sa_check_permissions_and("perm1", "perm2")]` - Check if user has all specified permissions
//! - `#[sa_check_permissions_or("perm1", "perm2")]` - Check if user has any of specified permissions

use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::{parse_macro_input, punctuated::Punctuated, ItemFn, LitStr, Token};

/// Check login status macro
///
/// # Example
/// ```rust,ignore
/// #[sa_check_login]
/// async fn user_info() -> impl IntoResponse {
///     "User info"
/// }
/// ```
pub fn sa_check_login_impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(fn_name, "sa_check_login requires async function")
            .to_compile_error()
            .into();
    }

    let check_code = quote! {
        if !spring_sa_token::StpUtil::is_login_current() {
            return Err(spring_web::error::KnownWebError::unauthorized("Not logged in").into());
        }
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check role macro
///
/// # Example
/// ```rust,ignore
/// #[sa_check_role("admin")]
/// async fn admin_panel() -> impl IntoResponse {
///     "Admin panel"
/// }
/// ```
pub fn sa_check_role_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let role = parse_macro_input!(attr as LitStr);
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;
    let role_value = role.value();

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(fn_name, "sa_check_role requires async function")
            .to_compile_error()
            .into();
    }

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        if !spring_sa_token::StpUtil::has_role(&__login_id, #role_value).await {
            return Err(spring_web::error::KnownWebError::forbidden(
                format!("Missing required role: {}", #role_value)
            ).into());
        }
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check permission macro
///
/// # Example
/// ```rust,ignore
/// #[sa_check_permission("user:delete")]
/// async fn delete_user() -> impl IntoResponse {
///     "User deleted"
/// }
/// ```
pub fn sa_check_permission_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let permission = parse_macro_input!(attr as LitStr);
    let perm_value = permission.value();

    if perm_value.trim().is_empty() {
        return syn::Error::new_spanned(&permission, "Permission identifier cannot be empty")
            .to_compile_error()
            .into();
    }

    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(fn_name, "sa_check_permission requires async function")
            .to_compile_error()
            .into();
    }

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        if !spring_sa_token::StpUtil::has_permission(&__login_id, #perm_value).await {
            return Err(spring_web::error::KnownWebError::forbidden(
                format!("Missing required permission: {}", #perm_value)
            ).into());
        }
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check multiple roles with AND logic
///
/// # Example
/// ```rust,ignore
/// #[sa_check_roles_and("admin", "super")]
/// async fn super_admin() -> impl IntoResponse {
///     "Super admin"
/// }
/// ```
pub fn sa_check_roles_and_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let roles = parse_macro_input!(attr with Punctuated::<LitStr, Token![,]>::parse_terminated);
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(fn_name, "sa_check_roles_and requires async function")
            .to_compile_error()
            .into();
    }

    let role_values: Vec<String> = roles.iter().map(|r| r.value()).collect();
    let role_checks = role_values.iter().map(|role| {
        quote! {
            if !spring_sa_token::StpUtil::has_role(&__login_id, #role).await {
                return Err(spring_web::error::KnownWebError::forbidden(
                    format!("Missing required role: {}", #role)
                ).into());
            }
        }
    });

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        #(#role_checks)*
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check multiple roles with OR logic
///
/// # Example
/// ```rust,ignore
/// #[sa_check_roles_or("admin", "manager")]
/// async fn management() -> impl IntoResponse {
///     "Management area"
/// }
/// ```
pub fn sa_check_roles_or_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let roles = parse_macro_input!(attr with Punctuated::<LitStr, Token![,]>::parse_terminated);
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(fn_name, "sa_check_roles_or requires async function")
            .to_compile_error()
            .into();
    }

    let role_values: Vec<String> = roles.iter().map(|r| r.value()).collect();
    let role_checks = role_values.iter().map(|role| {
        quote! {
            if spring_sa_token::StpUtil::has_role(&__login_id, #role).await {
                __has_any_role = true;
            }
        }
    });

    let roles_str = role_values.join(", ");

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        let mut __has_any_role = false;
        #(#role_checks)*
        if !__has_any_role {
            return Err(spring_web::error::KnownWebError::forbidden(
                format!("Missing any of required roles: {}", #roles_str)
            ).into());
        }
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check multiple permissions with AND logic
///
/// # Example
/// ```rust,ignore
/// #[sa_check_permissions_and("user:read", "user:write")]
/// async fn user_rw() -> impl IntoResponse {
///     "User read/write"
/// }
/// ```
pub fn sa_check_permissions_and_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let permissions =
        parse_macro_input!(attr with Punctuated::<LitStr, Token![,]>::parse_terminated);
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(
            fn_name,
            "sa_check_permissions_and requires async function",
        )
        .to_compile_error()
        .into();
    }

    let perm_values: Vec<String> = permissions.iter().map(|p| p.value()).collect();
    let perm_checks = perm_values.iter().map(|perm| {
        quote! {
            if !spring_sa_token::StpUtil::has_permission(&__login_id, #perm).await {
                return Err(spring_web::error::KnownWebError::forbidden(
                    format!("Missing required permission: {}", #perm)
                ).into());
            }
        }
    });

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        #(#perm_checks)*
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Check multiple permissions with OR logic
///
/// # Example
/// ```rust,ignore
/// #[sa_check_permissions_or("admin:*", "user:delete")]
/// async fn delete() -> impl IntoResponse {
///     "Delete operation"
/// }
/// ```
pub fn sa_check_permissions_or_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
    let permissions =
        parse_macro_input!(attr with Punctuated::<LitStr, Token![,]>::parse_terminated);
    let input = parse_macro_input!(item as ItemFn);

    let fn_name = &input.sig.ident;
    let fn_inputs = &input.sig.inputs;
    let fn_output = &input.sig.output;
    let fn_body = &input.block;
    let fn_attrs = &input.attrs;
    let fn_vis = &input.vis;
    let fn_asyncness = &input.sig.asyncness;
    let fn_generics = &input.sig.generics;
    let fn_where_clause = &input.sig.generics.where_clause;

    if fn_asyncness.is_none() {
        return syn::Error::new_spanned(
            fn_name,
            "sa_check_permissions_or requires async function",
        )
        .to_compile_error()
        .into();
    }

    let perm_values: Vec<String> = permissions.iter().map(|p| p.value()).collect();
    let perm_checks = perm_values.iter().map(|perm| {
        quote! {
            if spring_sa_token::StpUtil::has_permission(&__login_id, #perm).await {
                __has_any_perm = true;
            }
        }
    });

    let perms_str = perm_values.join(", ");

    let check_code = quote! {
        let __login_id = spring_sa_token::StpUtil::get_login_id_as_string()
            .await
            .map_err(|_| spring_web::error::KnownWebError::unauthorized("Not logged in"))?;
        let mut __has_any_perm = false;
        #(#perm_checks)*
        if !__has_any_perm {
            return Err(spring_web::error::KnownWebError::forbidden(
                format!("Missing any of required permissions: {}", #perms_str)
            ).into());
        }
    };

    let expanded: TokenStream2 = quote! {
        #(#fn_attrs)*
        #fn_vis #fn_asyncness fn #fn_name #fn_generics(#fn_inputs) #fn_output #fn_where_clause {
            #check_code
            #fn_body
        }
    };

    expanded.into()
}

/// Ignore authentication for this endpoint
///
/// This macro marks an endpoint to skip authentication checks,
/// even if it's under a path that normally requires authentication.
///
/// # Example
/// ```rust,ignore
/// #[sa_ignore]
/// async fn public_endpoint() -> impl IntoResponse {
///     "This endpoint is public"
/// }
/// ```
pub fn sa_ignore_impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
    // sa_ignore is a marker - just pass through the function unchanged
    // The actual ignore logic is handled by the middleware checking for this attribute
    item
}