Merge pull request #148 from devondragon/merge-fix-1

Refreshing issue-134 branch with latest from main

Author: devondragon

CHANGELOG.md

@@ -1,3 +1,12 @@
+## [3.0.1] - 2025-02-01
+### Features
+- The controller path mappings are now configurable.
+
+### Fixes
+- Fixed the bug where the schema.sql file was in a location that caused it to be automatically executed, it has now been migrated from the resources to the db-scripts directory.
+
+
+
 ## [3.0.0] - 2025-01-12
 ### Features
 - Converted project from a simple framework to a Maven library with a separate demo app (#136).

README.md

@@ -54,7 +54,7 @@ The framework provides support for the following features:
 This Framework is now available as a library on Maven Central.  You can add it to your Gradle project by adding the following dependency to your `build.gradle` file:
 
 ```groovy
-implementation 'com.digitalsanctuary:ds-spring-user-framework:3.0.0'
+implementation 'com.digitalsanctuary:ds-spring-user-framework:3.0.1'
 ```
 
 Or to your Maven project by adding it to your `pom.xml` file:
@@ -63,7 +63,7 @@ Or to your Maven project by adding it to your `pom.xml` file:
 <dependency>
     <groupId>com.digitalsanctuary</groupId>
     <artifactId>ds-spring-user-framework</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
 </dependency>
 ```
 
@@ -91,7 +91,7 @@ If you set your JPA Hibernate ddl-auto property to "create" it will create the t
 If you are not using automatic schema updates or Flyway, you can set up your database manually using the provided `schema.sql` file:
 
 ```bash
-mysql -u username -p database_name < src/main/resources/schema.sql
+mysql -u username -p database_name < db-scripts/mariadb-schema.sql
 ```
 
 Flyway support will be coming soon. This will allow you to automatically update your database schema as you deploy new versions of your application.

gradle.properties

@@ -1 +1 @@
-version=3.1.0-SNAPSHOT
+version=3.1.0-SNAPSHOT

src/main/java/com/digitalsanctuary/spring/user/controller/UserActionController.java

@@ -21,7 +21,8 @@
 import lombok.extern.slf4j.Slf4j;
 
 /**
- * The UserActionController handles non-API, non-Page requests like token validation links from emails.
+ * The UserActionController handles non-API, non-Page requests like token
+ * validation links from emails.
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -56,20 +57,23 @@ public class UserActionController {
 	private String forgotPasswordChangeURI;
 
 	/**
-	 * Validate a forgot password token link from an email, and if valid, show the change password page.
+	 * Validate a forgot password token link from an email, and if valid, show the
+	 * change password page.
 	 *
 	 * @param request the request
-	 * @param model the model
-	 * @param token the token
+	 * @param model   the model
+	 * @param token   the token
 	 * @return the model and view
 	 */
-	@GetMapping("/user/changePassword")
-	public ModelAndView showChangePasswordPage(final HttpServletRequest request, final ModelMap model, @RequestParam("token") final String token) {
+	@GetMapping("${user.security.changePasswordURI:/user/changePassword}")
+	public ModelAndView showChangePasswordPage(final HttpServletRequest request, final ModelMap model,
+			@RequestParam("token") final String token) {
 		log.debug("UserAPI.showChangePasswordPage: called with token: {}", token);
 		final TokenValidationResult result = userService.validatePasswordResetToken(token);
 		log.debug("UserAPI.showChangePasswordPage:" + "result: {}", result);
 		AuditEvent changePasswordAuditEvent = AuditEvent.builder().source(this).sessionId(request.getSession().getId())
-				.ipAddress(UserUtils.getClientIP(request)).userAgent(request.getHeader("User-Agent")).action("showChangePasswordPage")
+				.ipAddress(UserUtils.getClientIP(request)).userAgent(request.getHeader("User-Agent"))
+				.action("showChangePasswordPage")
 				.actionStatus("Success").message("Requested. Result:" + result).build();
 
 		eventPublisher.publishEvent(changePasswordAuditEvent);
@@ -85,15 +89,16 @@ public ModelAndView showChangePasswordPage(final HttpServletRequest request, fin
 	}
 
 	/**
-	 * Validate a forgot password token link from an email, and if valid, show the registration success page.
+	 * Validate a forgot password token link from an email, and if valid, show the
+	 * registration success page.
 	 *
 	 * @param request the request
-	 * @param model the model
-	 * @param token the token
+	 * @param model   the model
+	 * @param token   the token
 	 * @return the model and view
 	 * @throws UnsupportedEncodingException the unsupported encoding exception
 	 */
-	@GetMapping("/user/registrationConfirm")
+	@GetMapping("${user.security.registrationConfirmURI:/user/registrationConfirm}")
 	public ModelAndView confirmRegistration(final HttpServletRequest request, final ModelMap model,
 			@RequestParam("token") final String token) throws UnsupportedEncodingException {
 		log.debug("UserAPI.confirmRegistration: called with token: {}", token);
@@ -107,8 +112,10 @@ public ModelAndView confirmRegistration(final HttpServletRequest request, final
 				userService.authWithoutPassword(user);
 				userVerificationService.deleteVerificationToken(token);
 
-				AuditEvent registrationAuditEvent = AuditEvent.builder().source(this).user(user).sessionId(request.getSession().getId())
-						.ipAddress(UserUtils.getClientIP(request)).userAgent(request.getHeader("User-Agent")).action("Registration Confirmation")
+				AuditEvent registrationAuditEvent = AuditEvent.builder().source(this).user(user)
+						.sessionId(request.getSession().getId())
+						.ipAddress(UserUtils.getClientIP(request)).userAgent(request.getHeader("User-Agent"))
+						.action("Registration Confirmation")
 						.actionStatus("Success").message("Registration Confirmed. User logged in.").build();
 
 				eventPublisher.publishEvent(registrationAuditEvent);

src/main/java/com/digitalsanctuary/spring/user/controller/UserPageController.java

@@ -31,12 +31,12 @@ public class UserPageController {
 	 * Login Page.
 	 *
 	 * @param userDetails the user details
-	 * @param session the session
-	 * @param model the model
+	 * @param session     the session
+	 * @param model       the model
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/login.html")
+	@GetMapping("${user.security.loginPageURI:/user/login.html}")
 	public String login(@AuthenticationPrincipal DSUserDetails userDetails, HttpSession session, ModelMap model) {
 		log.debug("UserPageController.login:" + "userDetails: {}", userDetails);
 		if (session != null && session.getAttribute("error.message") != null) {
@@ -52,11 +52,11 @@ public String login(@AuthenticationPrincipal DSUserDetails userDetails, HttpSess
 	 * Register Page.
 	 *
 	 * @param userDetails the user details
-	 * @param session the session
-	 * @param model the model
+	 * @param session     the session
+	 * @param model       the model
 	 * @return the string
 	 */
-	@GetMapping("/user/register.html")
+	@GetMapping("${user.security.registrationURI:/user/register.html}")
 	public String register(@AuthenticationPrincipal DSUserDetails userDetails, HttpSession session, ModelMap model) {
 		log.debug("UserPageController.register:" + "userDetails: {}", userDetails);
 		if (session != null && session.getAttribute("error.message") != null) {
@@ -73,7 +73,7 @@ public String register(@AuthenticationPrincipal DSUserDetails userDetails, HttpS
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/registration-pending-verification.html")
+	@GetMapping("${user.security.registrationPendingURI:/user/registration-pending-verification.html}")
 	public String registrationPending() {
 		return "user/registration-pending-verification";
 	}
@@ -82,13 +82,14 @@ public String registrationPending() {
 	 * Registration complete.
 	 *
 	 * @param userDetails the user details
-	 * @param session the session
-	 * @param model the model
+	 * @param session     the session
+	 * @param model       the model
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/registration-complete.html")
-	public String registrationComplete(@AuthenticationPrincipal DSUserDetails userDetails, HttpSession session, ModelMap model) {
+	@GetMapping("${user.security.registrationSuccessURI:/user/registration-complete.html}")
+	public String registrationComplete(@AuthenticationPrincipal DSUserDetails userDetails, HttpSession session,
+			ModelMap model) {
 		log.debug("UserPageController.registrationComplete:" + "userDetails: {}", userDetails);
 		return "user/registration-complete";
 	}
@@ -98,7 +99,7 @@ public String registrationComplete(@AuthenticationPrincipal DSUserDetails userDe
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/request-new-verification-email.html")
+	@GetMapping("${user.security.registrationNewVerificationURI:/user/request-new-verification-email.html}")
 	public String requestNewVerificationEMail() {
 		return "user/request-new-verification-email";
 	}
@@ -108,7 +109,7 @@ public String requestNewVerificationEMail() {
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/forgot-password.html")
+	@GetMapping("${user.security.forgotPasswordURI:/user/forgot-password.html}")
 	public String forgotPassword() {
 		return "user/forgot-password";
 	}
@@ -118,7 +119,7 @@ public String forgotPassword() {
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/forgot-password-pending-verification.html")
+	@GetMapping("${user.security.forgotPasswordPendingURI:/user/forgot-password-pending-verification.html}")
 	public String forgotPasswordPendingVerification() {
 		return "user/forgot-password-pending-verification";
 	}
@@ -128,20 +129,20 @@ public String forgotPasswordPendingVerification() {
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/forgot-password-change.html")
+	@GetMapping("${user.security.forgotPasswordChangeURI:/user/forgot-password-change.html}")
 	public String forgotPasswordChange() {
 		return "user/forgot-password-change";
 	}
 
-
 	/**
 	 * @param userDetails the user details
-	 * @param request the request
-	 * @param model the model
+	 * @param request     the request
+	 * @param model       the model
 	 * @return String
 	 */
-	@GetMapping("/user/update-user.html")
-	public String updateUser(@AuthenticationPrincipal DSUserDetails userDetails, final HttpServletRequest request, final ModelMap model) {
+	@GetMapping("${user.security.updateUserURI:/user/update-user.html}")
+	public String updateUser(@AuthenticationPrincipal DSUserDetails userDetails, final HttpServletRequest request,
+			final ModelMap model) {
 		if (userDetails != null) {
 			User user = userDetails.getUser();
 			UserDto userDto = new UserDto();
@@ -157,7 +158,7 @@ public String updateUser(@AuthenticationPrincipal DSUserDetails userDetails, fin
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/update-password.html")
+	@GetMapping("${user.security.updatePasswordURI:/user/update-password.html}")
 	public String updatePassword() {
 		return "user/update-password";
 	}
@@ -167,7 +168,7 @@ public String updatePassword() {
 	 *
 	 * @return the string
 	 */
-	@GetMapping("/user/delete-account.html")
+	@GetMapping("${user.security.deleteAccountURI:/user/delete-account.html}")
 	public String deleteAccount() {
 		return "user/delete-account";
 	}

src/main/resources/config/dsspringuserconfig.properties

@@ -83,6 +83,14 @@ user.security.registrationSuccessURI=/user/registration-complete.html
 user.security.registrationNewVerificationURI=/user/request-new-verification-email.html
 # The URI for the update user page.
 user.security.updateUserURI=/user/update-user.html
+# The URI for the update password page.
+user.security.updatePasswordURI=/user/update-password.html
+# The URI for the delete account page.
+user.security.deleteAccountURI=/user/delete-account.html
+# The URI for the change password page.
+user.security.changePasswordURI=/user/changePassword
+# The URI for the registration confirm page.
+user.security.registrationConfirmURI=/user/registrationConfirm
 
 # The from address for all emails sent by the application.
 user.mail.fromAddress=test@test.com