using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Firebase;
using Firebase.Auth;
using Firebase.Database;
using Firebase.Extensions;
using UnityEngine;
///
/// the general managing class for handling communication with the firebase backend
/// (to be initialised by GameManager)
///
public class Backend
{
///
/// enum for the result of the authentication process
///
public enum AuthenticationResult
{
Ok,
AlreadyAuthenticated,
NonExistentUser,
AlreadyExistingUser,
InvalidEmail,
InvalidCredentials,
GenericError
}
///
/// generic enum for the result of a database transaction
///
public enum DatabaseTransactionResult
{
Ok,
Unauthenticated,
Error
}
///
/// enum for the connection status of the firebase backend
///
public enum FirebaseConnectionStatus
{
NotConnected,
Connected,
UpdateRequired, // "a required system component is out of date"
Updating, // "a required system component is updating, retrying in a bit..."
ExternalError, // "a system component is disabled, invalid, missing, or permissions are insufficient"
InternalError // "an unknown error occurred"
}
public enum UserAccountDetailTargetEnum
{
Username,
Email,
Password
}
///
/// callback functions to be invoked when the connection status changes
///
///
private readonly List> _onConnectionStatusChangedCallbacks = new();
///
/// callback functions to be invoked when the user signs in
///
private readonly List> _onSignInCallbacks = new();
///
/// callback functions to be invoked when the user signs out
///
private readonly List _onSignOutCallbacks = new();
///
/// the firebase authentication object
///
private FirebaseAuth _auth;
///
/// the firebase database reference
///
private DatabaseReference _db;
///
/// the current user object, if authenticated
///
private FirebaseUser _user;
///
/// the current user's username, if authenticated
///
private string _username;
///
/// whether the user is signed in
///
public bool IsSignedIn;
///
/// whether the backend is connected to the firebase backend
///
public FirebaseConnectionStatus Status = FirebaseConnectionStatus.NotConnected;
///
/// variable initialisation function
///
public void Initialise(Action callback)
{
FirebaseApp.CheckAndFixDependenciesAsync().ContinueWithOnMainThread(task =>
{
// cher is this robust enough
switch (task.Result)
{
case DependencyStatus.Available:
_auth = FirebaseAuth.GetAuth(FirebaseApp.DefaultInstance);
_auth.StateChanged += AuthStateChanged;
_db = FirebaseDatabase.DefaultInstance.RootReference;
Status = FirebaseConnectionStatus.Connected;
callback(Status);
FireOnConnectionStatusChangedCallbacks();
break;
case DependencyStatus.UnavailableDisabled:
case DependencyStatus.UnavailableInvalid:
case DependencyStatus.UnavilableMissing:
case DependencyStatus.UnavailablePermission:
Status = FirebaseConnectionStatus.ExternalError;
callback(Status);
FireOnConnectionStatusChangedCallbacks();
break;
case DependencyStatus.UnavailableUpdating:
Status = FirebaseConnectionStatus.Updating;
callback(Status);
FireOnConnectionStatusChangedCallbacks();
RetryInitialiseAfterDelay(callback);
break;
case DependencyStatus.UnavailableUpdaterequired:
Status = FirebaseConnectionStatus.UpdateRequired;
FireOnConnectionStatusChangedCallbacks();
callback(Status);
break;
case DependencyStatus.UnavailableOther:
default:
Status = FirebaseConnectionStatus.InternalError;
Debug.LogError("firebase ??? blew up or something," + task.Result);
FireOnConnectionStatusChangedCallbacks();
callback(Status);
break;
}
Debug.Log("firebase status is" + Status);
});
}
///
/// async function to retry initialisation after a delay
///
private async void RetryInitialiseAfterDelay(Action callback)
{
await Task.Delay(TimeSpan.FromSeconds(10));
Initialise(callback);
}
///
/// cleanup function
///
public void Cleanup()
{
SignOutUser();
_auth.StateChanged -= AuthStateChanged;
_auth = null;
}
///
/// function to register a callback for when the user signs in
///
/// callback function that takes in a FirebaseUser object
public void RegisterOnSignInCallback(Action callback)
{
_onSignInCallbacks.Add(callback);
Debug.Log($"registering OnSignInCallback ({_onSignInCallbacks.Count})");
}
///
/// function to register a callback for when the user signs out
///
/// callback function
public void RegisterOnSignOutCallback(Action callback)
{
_onSignOutCallbacks.Add(callback);
Debug.Log($"registering OnSignOutCallback ({_onSignOutCallbacks.Count})");
}
///
/// function to register a callback for when the connection status changes
///
/// callback function that takes in a FirebaseConnectionStatus enum
public void RegisterOnConnectionStatusChangedCallback(Action callback)
{
_onConnectionStatusChangedCallbacks.Add(callback);
Debug.Log($"registering ConnectionStatusChangedCallback ({_onConnectionStatusChangedCallbacks.Count})");
}
///
/// function to fire all on sign in callbacks
///
private void FireOnSignInCallbacks()
{
Debug.Log($"firing OnSignInCallbacks ({_onSignInCallbacks.Count})");
foreach (var callback in _onSignInCallbacks)
try
{
callback.Invoke(_user);
}
catch (Exception e)
{
Debug.LogError($"error invoking OnSignInCallback: {e.Message}");
}
}
///
/// function to fire all on sign-out callbacks
///
private void FireOnSignOutCallbacks()
{
Debug.Log($"firing OnSignOutCallbacks ({_onSignOutCallbacks.Count})");
foreach (var callback in _onSignOutCallbacks)
try
{
callback.Invoke();
}
catch (Exception e)
{
Debug.LogError($"error invoking OnSignOutCallback: {e.Message}");
}
}
///
/// function to fire all on connection status changed callbacks
///
private void FireOnConnectionStatusChangedCallbacks()
{
Debug.Log($"firing OnConnectionStatusChangedCallbacks ({_onConnectionStatusChangedCallbacks.Count})");
foreach (var callback in _onConnectionStatusChangedCallbacks)
try
{
callback.Invoke(Status);
}
catch (Exception e)
{
Debug.LogError($"error invoking OnConnectionStatusChangedCallback: {e.Message}");
}
}
///
/// function to handle the authentication state change event
///
/// the object that triggered the event
/// the event arguments
private void AuthStateChanged(object sender, EventArgs eventArgs)
{
// if the user hasn't changed, do nothing
if (_auth.CurrentUser == _user) return;
// if the user has changed, check if they've signed in or out
IsSignedIn = _user != _auth.CurrentUser && _auth.CurrentUser != null;
// if we're not signed in, but we still hold _user locally, we've signed out
if (!IsSignedIn && _user != null)
{
Debug.Log("moi-moi");
FireOnSignOutCallbacks();
}
// they have signed in, update _user
_user = _auth.CurrentUser;
if (!IsSignedIn) return;
Debug.Log($"signed in successfully as {_user?.UserId}");
RetrieveUsernameWithCallback((_, _) => { FireOnSignInCallbacks(); });
}
///
/// abstraction function to authenticate the user
///
/// email string
/// user raw password string
/// callback function that takes in an AuthenticationResult enum
/// whether to treat authentication as registration
/// username string if registering
public void AuthenticateUser(
string email,
string password,
Action callback,
bool registerUser = false,
string registeringUsername = "")
{
if (GameManager.Instance.Backend.GetUser() != null)
{
callback(AuthenticationResult.AlreadyAuthenticated);
return;
}
if (registerUser)
{
// register user
_auth.CreateUserWithEmailAndPasswordAsync(email, password)
.ContinueWithOnMainThread(createTask =>
{
if (createTask.IsCompletedSuccessfully)
{
// store username
_db.Child("users")
.Child(_user.UserId)
.Child("username")
.SetValueAsync(registeringUsername)
.ContinueWithOnMainThread(setUsernameTask =>
{
if (setUsernameTask.IsCompletedSuccessfully)
{
_username = registeringUsername;
callback(AuthenticationResult.Ok);
}
else
{
Debug.LogError(setUsernameTask.Exception);
callback(AuthenticationResult.GenericError);
}
});
return;
}
if (createTask.Exception?.InnerException == null)
{
callback(AuthenticationResult.GenericError);
return;
}
var error = (AuthError)((FirebaseException)createTask.Exception.InnerException).ErrorCode;
// ReSharper disable once SwitchStatementHandlesSomeKnownEnumValuesWithDefault
switch (error)
{
case AuthError.UserNotFound:
callback(AuthenticationResult.NonExistentUser);
return;
case AuthError.InvalidEmail:
callback(AuthenticationResult.InvalidEmail);
return;
case AuthError.WeakPassword:
case AuthError.InvalidCredential:
callback(AuthenticationResult.InvalidCredentials);
return;
case AuthError.AccountExistsWithDifferentCredentials:
case AuthError.EmailAlreadyInUse:
callback(AuthenticationResult.AlreadyExistingUser);
return;
case AuthError.Failure:
default:
Debug.LogError(error);
Debug.LogError(createTask.Exception);
callback(AuthenticationResult.GenericError);
break;
}
});
return;
}
// logging in
_auth.SignInWithEmailAndPasswordAsync(email, password)
.ContinueWithOnMainThread(signInTask =>
{
if (signInTask.IsCompletedSuccessfully)
{
RetrieveUsername();
callback(AuthenticationResult.Ok);
return;
}
if (signInTask.Exception?.InnerException == null)
{
callback(AuthenticationResult.GenericError);
return;
}
var error = (AuthError)((FirebaseException)signInTask.Exception.InnerException).ErrorCode;
// ReSharper disable once SwitchStatementHandlesSomeKnownEnumValuesWithDefault
switch (error)
{
case AuthError.UserNotFound:
callback(AuthenticationResult.NonExistentUser);
return;
case AuthError.InvalidEmail:
callback(AuthenticationResult.InvalidEmail);
return;
case AuthError.WeakPassword:
case AuthError.InvalidCredential:
callback(AuthenticationResult.InvalidCredentials);
return;
case AuthError.AccountExistsWithDifferentCredentials:
case AuthError.EmailAlreadyInUse:
callback(AuthenticationResult.AlreadyExistingUser);
return;
case AuthError.Failure:
default:
Debug.LogError(error);
Debug.LogError(signInTask.Exception);
callback(AuthenticationResult.GenericError);
break;
}
});
}
///
/// helper function to run RetrieveUsername with no callback
///
private void RetrieveUsername()
{
RetrieveUsernameWithCallback((_, _) => { });
}
///
/// function to retrieve the user's username from the database
///
private void RetrieveUsernameWithCallback(Action callback)
{
if (!Status.Equals(FirebaseConnectionStatus.Connected)) return;
if (_user == null)
{
Debug.LogError("receiving username post-authentication but user is null (should be unreachable)");
callback(DatabaseTransactionResult.Unauthenticated, "Unknown");
return;
}
_db.Child("users").Child(_user.UserId).Child("username").GetValueAsync().ContinueWithOnMainThread(task =>
{
DatabaseTransactionResult result;
if (task.IsCompletedSuccessfully)
{
result = DatabaseTransactionResult.Ok;
_username = task.Result.Value.ToString();
Debug.Log($"our username is {_username}");
}
else
{
result = DatabaseTransactionResult.Error;
_username = "Unknown";
Debug.LogError("failed to get username");
}
callback(result, _username);
});
}
///
/// abstraction function to retrieve the user
///
/// the firebase user object
public FirebaseUser GetUser()
{
return _user;
}
public string GetUsername()
{
return _username;
}
///
/// abstraction function to sign out the user
///
public void SignOutUser()
{
_auth.SignOut();
}
///
/// abstraction function for the user to reset their password
///
/// the forgetful user's email lol
/// callback function to be invoked after the password reset email is sent
public void ForgotPassword(string email, Action callback)
{
_auth.SendPasswordResetEmailAsync(email).ContinueWithOnMainThread(resetTask =>
{
if (resetTask.IsCompletedSuccessfully)
{
callback(true);
}
else
{
Debug.LogError(resetTask.Exception);
callback(false);
}
});
}
///
/// abstraction function to get the user's recent scores from the database
///
///
/// callback function that takes in a DatabaseTransactionResult enum and a
/// List<LocalPlayerData.Score>
///
public void GetRecentScores(Action> callback)
{
// TODO: implement this
callback(DatabaseTransactionResult.Error, new List(0));
}
///
/// abstraction function to submit a score to the database
///
/// score
/// callback function that takes in a DatabaseTransactionResult enum
public void SubmitScore(
LocalPlayerData.Score score,
Action callback)
{
throw new NotImplementedException();
}
///
/// abstraction function to get and calculate the user's rating from the database
/// calculation is done locally, call UpdateUserRating to update the user's rating in the database
///
///
/// callback function that takes in a DatabaseTransactionResult enum and a user rating
/// float
///
public void CalculateUserRating(
Action callback)
{
throw new NotImplementedException();
}
///
/// abstraction function to update the user's rating in the database
///
/// new user rating value as a float
/// callback function that takes in a DatabaseTransactionResult enum
public void UpdateUserRating(
float newRating,
Action callback)
{
throw new NotImplementedException();
}
///
/// abstraction function to get the leaderboard from the database
///
///
/// callback function that takes in a DatabaseTransactionResult enum and a List<LeaderboardEntry>
///
public void GetLeaderboard(
Action callback)
{
throw new NotImplementedException();
}
///
/// abstraction function to update the user's account details in the database
///
/// the target account detail to update
/// the new value for the target account detail
/// callback function that takes in a DatabaseTransactionResult enum
/// thrown when the target is not a valid UserAccountDetailTargetEnum
public void UpdateUserAccountDetail(
UserAccountDetailTargetEnum target,
string newValue,
Action callback)
{
if (!Status.Equals(FirebaseConnectionStatus.Connected)) callback(DatabaseTransactionResult.Unauthenticated);
if (_user == null)
{
callback(DatabaseTransactionResult.Unauthenticated);
return;
}
switch (target)
{
case UserAccountDetailTargetEnum.Email:
_user.SendEmailVerificationBeforeUpdatingEmailAsync(newValue).ContinueWithOnMainThread(task =>
{
if (task.IsCompletedSuccessfully)
{
callback(DatabaseTransactionResult.Ok);
}
else
{
Debug.LogError(task.Exception);
callback(DatabaseTransactionResult.Error);
}
});
break;
case UserAccountDetailTargetEnum.Username:
_db.Child("users").Child(_user.UserId).Child("username").SetValueAsync(newValue)
.ContinueWithOnMainThread(task =>
{
if (task.IsCompletedSuccessfully)
{
_username = newValue;
callback(DatabaseTransactionResult.Ok);
}
else
{
Debug.LogError(task.Exception);
callback(DatabaseTransactionResult.Error);
}
});
break;
case UserAccountDetailTargetEnum.Password:
_user.UpdatePasswordAsync(newValue).ContinueWithOnMainThread(task =>
{
if (task.IsCompletedSuccessfully)
{
callback(DatabaseTransactionResult.Ok);
}
else
{
Debug.LogError(task.Exception);
callback(DatabaseTransactionResult.Error);
}
});
break;
default:
throw new ArgumentOutOfRangeException(nameof(target), target, null);
}
}
///
/// struct for a leaderboard entry
///
public struct LeaderboardEntry
{
public string Username;
public float Rating;
public int PlayCount;
public LeaderboardEntry(string username, float rating, int playCount)
{
Username = username;
Rating = rating;
PlayCount = playCount;
}
}
}