@ -19,53 +19,47 @@ import kotlinx.coroutines.flow.mapNotNull
import kotlinx.coroutines.launch import kotlinx.coroutines.launch
/ * * / * *
* SubnetRoutingViewModel is responsible for managing the content of the subnet router management view .
* SubnetRoutingViewModel is responsible for managing the content of the subnet router management
* class watches the backend preferences and updates the UI accordingly whenever the advertised routes
* view. This class watches the backend preferences and updates the UI accordingly whenever the
* . It also handles the state of the editing dialog , and updates the preferences stored in
* advertised routes change. It also handles the state of the editing dialog , and updates the
* backend when the routes are edited in the UI .
* preferences stored in the backend when the routes are edited in the UI .
* /
* /
class SubnetRoutingViewModel : ViewModel ( ) { class SubnetRoutingViewModel : ViewModel ( ) {
private val TAG = " SubnetRoutingViewModel "
private val TAG = " SubnetRoutingViewModel "
/ * *
/** Matches the value of the "RouteAll" backend preference. */
* Matches the value of the " RouteAll " backend preference .
* /
val routeAll : StateFlow < Boolean > = MutableStateFlow ( true )
val routeAll : StateFlow < Boolean > = MutableStateFlow ( true )
/ * *
/ * *
* The advertised routes displayed at any point in time in the UI . The class observes
* The advertised routes displayed at any point in time in the UI . The class observes this value
* this value for changes , and updates the backend preferences accordingly .
* for changes , and updates the backend preferences accordingly .
* /
* /
val advertisedRoutes : StateFlow < List < String > > = MutableStateFlow ( listOf ( ) )
val advertisedRoutes : StateFlow < List < String > > = MutableStateFlow ( listOf ( ) )
/ * *
/** Whether we are presenting the add/edit dialog to set/change the value of a route. */
* Whether we are presenting the add / edit dialog to set / change the value of a route .
* /
val isPresentingDialog : StateFlow < Boolean > = MutableStateFlow ( false )
val isPresentingDialog : StateFlow < Boolean > = MutableStateFlow ( false )
/ * *
/ * *
* When editing a route , this stores the initial value . It is used to determine which
* When editing a route , this stores the initial value . It is used to determine which of the
* of the previously existing routes needs to be updated . This starts as empty , and dismissing
* previously existing routes needs to be updated . This starts as empty , and dismissing the edit
* the edit dialog should reset it to empty as well .
* dialog should reset it to empty as well . If the user is adding a new route , this will be empty
* If the user is adding a new route , this will be empty despite isPresentingDialog being true .
* despite isPresentingDialog being true .
* /
* /
private val editingRoute : StateFlow < String > = MutableStateFlow ( " " )
private val editingRoute : StateFlow < String > = MutableStateFlow ( " " )
/ * *
/** The value currently entered in the add/edit dialog text field. */
* The value currently entered in the add / edit dialog text field .
* /
val dialogTextFieldValue : MutableStateFlow < String > = MutableStateFlow ( " " )
val dialogTextFieldValue : MutableStateFlow < String > = MutableStateFlow ( " " )
/ * *
/ * *
* True if the value currently entered in the dialog text field is valid , false otherwise .
* True if the value currently entered in the dialog text field is valid , false otherwise . If the
* If the text field is empty , this returns true as we don ' t want to display an error state
* text field is empty , this returns true as we don ' t want to display an error state when the user
* when the user hasn ' t entered anything .
* hasn ' t entered anything .
* /
* /
val isTextFieldValueValid : StateFlow < Boolean > = MutableStateFlow ( true )
val isTextFieldValueValid : StateFlow < Boolean > = MutableStateFlow ( true )
/ * *
/ * *
* If an error occurred while saving the ipn . Prefs to the backend this value is
* If an error occurred while saving the ipn . Prefs to the backend this value is non - null .
* non - null . Subsequent successful attempts to save will clear it .
* Subsequent successful attempts to save will clear it .
* /
* /
val currentError : MutableStateFlow < String ? > = MutableStateFlow ( null )
val currentError : MutableStateFlow < String ? > = MutableStateFlow ( null )
@ -73,8 +67,7 @@ class SubnetRoutingViewModel : ViewModel() {
viewModelScope . launch {
viewModelScope . launch {
// Any time the value entered by the user in the add/edit dialog changes, we determine
// Any time the value entered by the user in the add/edit dialog changes, we determine
// whether it is valid or invalid, and set isTextFieldValueValid accordingly.
// whether it is valid or invalid, and set isTextFieldValueValid accordingly.
dialogTextFieldValue
dialogTextFieldValue . collect { newValue ->
. collect { newValue ->
if ( newValue . isEmpty ( ) ) {
if ( newValue . isEmpty ( ) ) {
isTextFieldValueValid . set ( true )
isTextFieldValueValid . set ( true )
return @collect
return @collect
@ -96,16 +89,18 @@ class SubnetRoutingViewModel : ViewModel() {
. distinctUntilChanged ( )
. distinctUntilChanged ( )
// Ignore any value that matches the current value in UI,
// Ignore any value that matches the current value in UI,
// to prevent an unnecessary UI update
// to prevent an unnecessary UI update
. filter { it != advertisedRoutes } . collect { newRoutesFromBackend ->
. filter { it != advertisedRoutes }
Log . d (
. collect { newRoutesFromBackend ->
TAG , " AdvertiseRoutes changed in the backend: $newRoutesFromBackend "
Log . d ( TAG , " AdvertiseRoutes changed in the backend: $newRoutesFromBackend " )
)
advertisedRoutes . set ( newRoutesFromBackend )
advertisedRoutes . set ( newRoutesFromBackend )
}
}
}
}
viewModelScope . launch {
viewModelScope . launch {
Notifier . prefs . map { it ?. RouteAll } . distinctUntilChanged ( ) . collect {
Notifier . prefs
. map { it ?. RouteAll }
. distinctUntilChanged ( )
. collect {
Log . d ( TAG , " RouteAll changed in the backend: $it " )
Log . d ( TAG , " RouteAll changed in the backend: $it " )
routeAll . set ( it )
routeAll . set ( it )
}
}
@ -116,16 +111,17 @@ class SubnetRoutingViewModel : ViewModel() {
val prefsOut = Ipn . MaskedPrefs ( )
val prefsOut = Ipn . MaskedPrefs ( )
prefsOut . RouteAll = it
prefsOut . RouteAll = it
Log . d ( TAG , " Will save RouteAll in the backend: $it " )
Log . d ( TAG , " Will save RouteAll in the backend: $it " )
Client ( viewModelScope ) . editPrefs ( prefsOut , responseHandler = { result ->
Client ( viewModelScope )
. editPrefs (
prefsOut ,
responseHandler = { result ->
if ( result . isFailure ) {
if ( result . isFailure ) {
Log . e ( TAG , " Error saving RouteAll: ${result.exceptionOrNull()} " )
Log . e ( TAG , " Error saving RouteAll: ${result.exceptionOrNull()} " )
currentError . set ( result . exceptionOrNull ( ) ?. localizedMessage )
currentError . set ( result . exceptionOrNull ( ) ?. localizedMessage )
return @editPrefs
return @editPrefs
} else {
} else {
Log . d (
Log . d (
TAG ,
TAG , " RouteAll set in backend. New value: ${result.getOrNull()?.RouteAll} " )
" RouteAll set in backend. New value: ${result.getOrNull()?.RouteAll} "
)
currentError . set ( null )
currentError . set ( null )
}
}
} )
} )
@ -141,11 +137,11 @@ class SubnetRoutingViewModel : ViewModel() {
}
}
/ * *
/ * *
* Deletes the given subnet route from the list of advertised routes .
* Deletes the given subnet route from the list of advertised routes . Calling this function will
* Calling this function will cause the backend preferences to be updated in the background .
* cause the backend preferences to be updated in the background .
*
*
* @param route The route string to be deleted from the list of advertised routes .
* @param route The route string to be deleted from the list of advertised routes . If the route
* If the route does not exist in the list , no changes are made .
* does not exist in the list , no changes are made .
* /
* /
fun deleteRoute ( route : String ) {
fun deleteRoute ( route : String ) {
val currentRoutes = advertisedRoutes . value . toMutableList ( )
val currentRoutes = advertisedRoutes . value . toMutableList ( )
@ -159,8 +155,8 @@ class SubnetRoutingViewModel : ViewModel() {
}
}
/ * *
/ * *
* Starts editing the given subnet route . Called when the user taps the ' pencil ' button
* Starts editing the given subnet route . Called when the user taps the ' pencil ' button on a route
* on a route in the list .
* in the list .
* /
* /
fun startEditingRoute ( route : String ) {
fun startEditingRoute ( route : String ) {
Log . d ( TAG , " startEditingRoute: $route " )
Log . d ( TAG , " startEditingRoute: $route " )
@ -169,18 +165,14 @@ class SubnetRoutingViewModel : ViewModel() {
isPresentingDialog . set ( true )
isPresentingDialog . set ( true )
}
}
/ * *
/** Commits the changes made so far in the editing dialog. */
* Commits the changes made so far in the editing dialog .
* /
fun doneEditingRoute ( newValue : String ) {
fun doneEditingRoute ( newValue : String ) {
Log . d ( TAG , " doneEditingRoute: $newValue " )
Log . d ( TAG , " doneEditingRoute: $newValue " )
editRoute ( editingRoute . value , newValue )
editRoute ( editingRoute . value , newValue )
stopEditingRoute ( )
stopEditingRoute ( )
}
}
/ * *
/** Cancels any current editing session and closes the dialog. */
* Cancels any current editing session and closes the dialog .
* /
fun stopEditingRoute ( ) {
fun stopEditingRoute ( ) {
Log . d ( TAG , " stopEditingRoute " )
Log . d ( TAG , " stopEditingRoute " )
isPresentingDialog . set ( false )
isPresentingDialog . set ( false )
@ -189,10 +181,9 @@ class SubnetRoutingViewModel : ViewModel() {
}
}
/ * *
/ * *
* This makes the actual changes whenever adding or editing a route .
* This makes the actual changes whenever adding or editing a route . If adding a new route ,
* If adding a new route , oldRoute will be empty .
* oldRoute will be empty . This function validates the input before making any changes . If
* This function validates the input before making any changes . If newRoute
* newRoute is not a valid CIDR IPv4 / IPv6 range , this function does nothing .
* is not a valid CIDR IPv4 / IPv6 range , this function does nothing .
* /
* /
private fun editRoute ( oldRoute : String , newRoute : String ) {
private fun editRoute ( oldRoute : String , newRoute : String ) {
val currentRoutes = advertisedRoutes . value . toMutableList ( )
val currentRoutes = advertisedRoutes . value . toMutableList ( )
@ -226,7 +217,10 @@ class SubnetRoutingViewModel : ViewModel() {
val prefsOut = Ipn . MaskedPrefs ( )
val prefsOut = Ipn . MaskedPrefs ( )
prefsOut . AdvertiseRoutes = advertisedRoutes . value
prefsOut . AdvertiseRoutes = advertisedRoutes . value
Log . d ( TAG , " Will save AdvertiseRoutes in the backend: $ (advertisedRoutes.value) " )
Log . d ( TAG , " Will save AdvertiseRoutes in the backend: $ (advertisedRoutes.value) " )
Client ( viewModelScope ) . editPrefs ( prefsOut , responseHandler = { result ->
Client ( viewModelScope )
. editPrefs (
prefsOut ,
responseHandler = { result ->
if ( result . isFailure ) {
if ( result . isFailure ) {
Log . e ( TAG , " Error saving AdvertiseRoutes: ${result.exceptionOrNull()} " )
Log . e ( TAG , " Error saving AdvertiseRoutes: ${result.exceptionOrNull()} " )
currentError . set ( result . exceptionOrNull ( ) ?. localizedMessage )
currentError . set ( result . exceptionOrNull ( ) ?. localizedMessage )
@ -234,16 +228,15 @@ class SubnetRoutingViewModel : ViewModel() {
} else {
} else {
Log . d (
Log . d (
TAG ,
TAG ,
" AdvertiseRoutes set in backend. New value: ${result.getOrNull()?.AdvertiseRoutes} "
" AdvertiseRoutes set in backend. New value: ${result.getOrNull()?.AdvertiseRoutes} " )
)
currentError . set ( null )
currentError . set ( null )
}
}
} )
} )
}
}
/ * *
/ * *
* Clears the current error message and reloads the routes currently saved in the backend
* Clears the current error message and reloads the routes currently saved in the backend to the
* to the UI . We call this when dismissing an error upon saving the routes .
* UI . We call this when dismissing an error upon saving the routes .
* /
* /
fun onErrorDismissed ( ) {
fun onErrorDismissed ( ) {
currentError . set ( null )
currentError . set ( null )
@ -254,16 +247,15 @@ class SubnetRoutingViewModel : ViewModel() {
}
}
companion object RouteValidation {
companion object RouteValidation {
/ * *
/** Returns true if the given String is a valid IPv4 or IPv6 CIDR range, false otherwise. */
* Returns true if the given String is a valid IPv4 or IPv6 CIDR range , false otherwise .
* /
fun isValidCIDR ( newRoute : String ) : Boolean {
fun isValidCIDR ( newRoute : String ) : Boolean {
val cidrPattern =
val cidrPattern =
Regex ( " (([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]) \\ .){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/( \\ d+) " ) // IPv4 CIDR
Regex (
" (([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]) \\ .){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/( \\ d+) " ) // IPv4 CIDR
val ipv6CidrPattern =
val ipv6CidrPattern =
Regex ( " (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]) \\ .){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]) \\ .){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/( \\ d+) " ) // IPv6 CIDR
Regex (
" (([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]) \\ .){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]) \\ .){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/( \\ d+) " ) // IPv6 CIDR
return cidrPattern . matches ( newRoute ) || ipv6CidrPattern . matches ( newRoute )
return cidrPattern . matches ( newRoute ) || ipv6CidrPattern . matches ( newRoute )
}
}
}
}
} }
Jakub Meysner
7 months ago
committed by