new_user

plantimager.webui.new_user Link

User Registration Components for Plant Imager Web UI.

This module provides the user interface components and functionality for creating new user accounts in the Plant Imager system.

Key Features

User registration form with validation
Real-time username availability checking
Password confirmation validation
Secure account creation via REST API
Comprehensive error handling and user feedback

register_user Link

register_user(n_clicks, username, fullname, password, confirm_password, host, port, prefix)

Process user registration by validating inputs and creating a new account.

This callback handles the complete user registration process, including input validation, password matching, and account creation through the backend API.

Parameters:

Name	Type	Description	Default
`n_clicks`	`int or None`	Number of times the register button has been clicked. `None` before the first click.	required
`username`	`str`	The desired username for the new account.	required
`fullname`	`str`	The full name of the user.	required
`password`	`str`	The desired password for the new account.	required
`confirm_password`	`str`	Password confirmation entry.	required
`host`	`str`	The hostname or IP address of the PlantDB REST API server.	required
`port`	`int`	The port number of the PlantDB REST API server.	required
`prefix`	`str`	The prefix of the PlantDB REST API server.	required

Returns:

Type	Description
`Union[str, Alert]`	Either an empty string (if no clicks) or a Bootstrap alert component containing: - Success message if registration is successful - Error message if validation fails or API request fails

Notes

The function performs the following validations: - Username must not yet exist in the Backend API - All fields must be non-empty - Passwords must match - Backend API must successfully create the account

Raises:

Type	Description
`RequestException`	If there are network connectivity issues or API errors.
`JSONDecodeError`	If the API response contains invalid JSON data.

Source code in plantimager/webui/new_user.py

@callback(
    Output("registration-message", "children"),
    [Input("register-button", "n_clicks")],
    [State("new-username-input", "value"),
     State("new-fullname-input", "value"),
     State("new-password-input", "value"),
     State("confirm-password-input", "value"),
     State("rest-api-host", "data"),
     State("rest-api-port", "data"),
     State("rest-api-prefix", "data")],
    prevent_initial_call=True
)
def register_user(n_clicks: int | None, username: str, fullname: str, password: str, 
               confirm_password: str, host: str, port: str, prefix:str) -> str | dbc.Alert:
    """Process user registration by validating inputs and creating a new account.

    This callback handles the complete user registration process, including input
    validation, password matching, and account creation through the backend API.

    Parameters
    ----------
    n_clicks : int or None
        Number of times the register button has been clicked. ``None`` before the first click.
    username : str
        The desired username for the new account.
    fullname : str
        The full name of the user.
    password : str
        The desired password for the new account.
    confirm_password : str
        Password confirmation entry.
    host : str
       The hostname or IP address of the PlantDB REST API server.
    port : int
        The port number of the PlantDB REST API server.
    prefix : str
        The prefix of the PlantDB REST API server.

    Returns
    -------
    Union[str, dbc.Alert]
        Either an empty string (if no clicks) or a Bootstrap alert component containing:
        - Success message if registration is successful
        - Error message if validation fails or API request fails

    Notes
    -----
    The function performs the following validations:
    - Username must not yet exist in the Backend API
    - All fields must be non-empty
    - Passwords must match
    - Backend API must successfully create the account

    Raises
    ------
    requests.exceptions.RequestException
        If there are network connectivity issues or API errors.
    json.JSONDecodeError
        If the API response contains invalid JSON data.
    """
    if not n_clicks:
        return ""

    if not _validate_new_username(username, host, port, prefix):
        return dbc.Alert(f"Username '{username}' is unavailable!", color="danger", class_name="mb-0")

    if not all([username, fullname, password, confirm_password]):
        return dbc.Alert("All fields are required!", color="danger", class_name="mb-0")

    if password != confirm_password:
        return dbc.Alert("Passwords do not match!", color="danger", class_name="mb-0")

    try:
        response = requests.post(
            urljoin(base_url(host, port, prefix), 'register'),
            data=json.dumps({
                'username': username,
                'fullname': fullname,
                'password': password
            }),
            headers={'Content-Type': 'application/json'}
        )

        if response.ok:
            return dbc.Alert("Registration successful! You can now login.", color="success", class_name="mb-0")
        else:
            error_msg = "Registration failed"
            try:
                error_data = response.json()
                if 'message' in error_data:
                    error_msg = error_data['message']
            except json.JSONDecodeError:
                error_msg = response.text
            return dbc.Alert(error_msg, color="danger", class_name="mb-0")

    except requests.exceptions.RequestException as e:
        return dbc.Alert(f"Connection error: {str(e)}", color="danger", class_name="mb-0")

toggle_register_modal Link

toggle_register_modal(new_user_clicks, is_open)

Toggle the visibility state of the new user registration modal.

This callback controls the opening and closing of the registration modal dialog when the new user button is clicked.

Parameters:

Name	Type	Description	Default
`new_user_clicks`	`int or None`	Number of times the new user button has been clicked. `None` before first click.	required
`is_open`	`bool`	Current state of the modal dialog (True if open, False if closed).	required

Returns:

Type	Description
`bool`	The new state of the modal dialog - toggled from current state if button was clicked.

Source code in plantimager/webui/new_user.py

@callback(
    Output("new-user-modal", "is_open"),
    Input("new-user-button", "n_clicks"),
    State("new-user-modal", "is_open"),
    prevent_initial_call=True
)
def toggle_register_modal(new_user_clicks: int | None, is_open: bool) -> bool:
    """Toggle the visibility state of the new user registration modal.

    This callback controls the opening and closing of the registration modal dialog
    when the new user button is clicked.

    Parameters
    ----------
    new_user_clicks : int or None
        Number of times the new user button has been clicked. ``None`` before first click.
    is_open : bool
        Current state of the modal dialog (True if open, False if closed).

    Returns
    -------
    bool
        The new state of the modal dialog - toggled from current state if button
        was clicked.
    """
    if new_user_clicks:
        return not is_open
    return is_open

validate_new_username Link

validate_new_username(new_username, is_modal_open, host, port, prefix)

Validate if the entered username is available for registration.

Makes an API request to check if the username already exists in the system. Updates the validation state of the username input field accordingly.

Parameters:

Name	Type	Description	Default
`new_username`	`str or None`	The username entered by the user to validate.	required
`is_modal_open`	`bool`	Current state of the registration modal.	required
`host`	`str`	The hostname or IP address of the PlantDB REST API server.	required
`port`	`int`	The port number of the PlantDB REST API server.	required
`prefix`	`str`	The prefix of the PlantDB REST API server.	required

Returns:

Type	Description
`Tuple[bool, bool]`	A tuple containing: - bool: `True` if username is available (valid new username), `False` otherwise. - bool: `True` if username exists or there's an error (invalid new username), `False` otherwise.

Raises:

Type	Description
`RequestException`	If there are network connectivity issues or API errors.

Source code in plantimager/webui/new_user.py

@callback(
    Output('new-username-input', 'valid'),
    Output('new-username-input', 'invalid'),
    Input('new-username-input', 'value'),
    State('new-user-modal', 'is_open'),
    State('rest-api-host', 'data'),
    State('rest-api-port', 'data'),
    State('rest-api-prefix', 'data'),
)
def validate_new_username(new_username: str | None, is_modal_open: bool, host: str, port: str, prefix:str) -> tuple[bool, bool]:
    """Validate if the entered username is available for registration.

    Makes an API request to check if the username already exists in the system.
    Updates the validation state of the username input field accordingly.

    Parameters
    ----------
    new_username : str or None
        The username entered by the user to validate.
    is_modal_open : bool
        Current state of the registration modal.
    host : str
       The hostname or IP address of the PlantDB REST API server.
    port : int
        The port number of the PlantDB REST API server.
    prefix : str
        The prefix of the PlantDB REST API server.

    Returns
    -------
    Tuple[bool, bool]
        A tuple containing:
        - bool: ``True`` if username is available (valid new username), ``False`` otherwise.
        - bool: ``True`` if username exists or there's an error (invalid new username), ``False`` otherwise.

    Raises
    ------
    requests.exceptions.RequestException
        If there are network connectivity issues or API errors.
    """
    if not is_modal_open or not new_username:
        return False, False
    valid_username = _validate_new_username(new_username, host, port, prefix)
    return valid_username, ~valid_username

validate_password_match Link

validate_password_match(password, confirm_password)

Validate that the password and confirmation password match.

Provides real-time validation feedback for both password input fields, ensuring they contain identical values.

Parameters:

Name	Type	Description	Default
`password`	`str or None`	The value entered in the new password field.	required
`confirm_password`	`str or None`	The value entered in the password confirmation field.	required

Returns:

Type	Description
`Tuple[bool, bool, bool, bool]`	A tuple of four boolean values in the order: - bool: `True` if passwords match and not empty, `False` otherwise. - bool: `True` if passwords don't match, `False` otherwise. - bool: `True` if passwords match and not empty, `False` otherwise. - bool: `True` if passwords don't match, `False` otherwise.

Notes

Returns all False values if either password field is empty.

Source code in plantimager/webui/new_user.py

@callback(
    [
        Output("new-password-input", "valid"),
        Output("new-password-input", "invalid"),
        Output("confirm-password-input", "valid"),
        Output("confirm-password-input", "invalid")
    ],
    [
        Input("new-password-input", "value"),
        Input("confirm-password-input", "value")
    ]
)
def validate_password_match(password: str | None, confirm_password: str | None) -> tuple[bool, bool, bool, bool]:
    """Validate that the password and confirmation password match.

    Provides real-time validation feedback for both password input fields,
    ensuring they contain identical values.

    Parameters
    ----------
    password : str or None
        The value entered in the new password field.
    confirm_password : str or None
        The value entered in the password confirmation field.

    Returns
    -------
    Tuple[bool, bool, bool, bool]
        A tuple of four boolean values in the order:
        - bool: ``True`` if passwords match and not empty, ``False`` otherwise.
        - bool: ``True`` if passwords don't match, ``False`` otherwise.
        - bool: ``True`` if passwords match and not empty, ``False`` otherwise.
        - bool: ``True`` if passwords don't match, ``False`` otherwise.

    Notes
    -----
    Returns all ``False`` values if either password field is empty.
    """
    if not password or not confirm_password:
        return (
            False,  # new password not valid
            False,  # new password not invalid
            False,  # confirm password not valid
            False  # confirm password not invalid
        )
    passwords_match = password == confirm_password
    return (
        passwords_match,  # new password valid state
        not passwords_match,  # new password invalid state
        passwords_match,  # confirm password valid state
        not passwords_match  # confirm password invalid state
    )