LoginController.php

This handles user registration and login functionality, supporting both traditional username/password and social login with Google and Facebook.

loginUser

public function loginUser(Request $request)
{
    // Retrieve username and password from the request
    $username = $request->input('username');
    $password = $request->input('password');
    // Query the UserAccount model for a user with matching username and password
    $userAccount = UserAccount::where('username', $username)
        ->where('password', $password)
        ->first();
    // Check if a user account was found
    if (isset($userAccount)) {
        // Check if the user account is verified
        if ($userAccount->verified == false) {
            // User account is not verified, return a response indicating verification failure
            $response = [
                'SUCCESS' => 2, // 2 indicates verification failure
            ];
            return $response;
        } else {
            // User account is verified, return a success response with user details
            $response = [
                'SUCCESS' => 1, // 1 indicates successful login
                'ID' => $userAccount->id,
                'USERNAME' => $userAccount->username
            ];
            return $response;
        }
    } else {
        // No user account found, return a response indicating login failure
        $response = [
            'SUCCESS' => 0, // 0 indicates login failure
        ];
        return $response;
    }
}

To explain what this loginUser method does:

1. Request Handling:

   • The function takes a Request object as a parameter, which contains data from the client (presumably, a username and password).

2. Retrieve Username and Password:

   • It retrieves the username and password from the request.

3. Query Database:

   • It queries the UserAccount model to find a user with the provided username and password.

4. Check User Account Existence:

   • It checks if a user account was found.

5. Verification Check:

   • If a user account is found, it checks if the account is verified (verified column is false).

6. Generate and Return Response:

   • Based on the results, it generates a response array:

     • If the account is not found, it returns a response with SUCCESS set to 0 (login failure).

     • If the account is found but not verified, it returns a response with SUCCESS set to 2 (verification failure).

     • If the account is found and verified, it returns a success response with user details, including user ID and username.

authenticateGoogleAccountForLogin

public function authenticateGoogleAccountForLogin()
{
    // Create a new instance of Google_Client
    $client = new Google_Client();
    // Set application name for identification
    $client->setApplicationName('Google Login');
    // Set requested Google API scopes for the authentication
    $client->setScopes(['profile', 'email']);
    // Set access type to 'offline' for obtaining refresh tokens
    $client->setAccessType('offline');
    // Check if the application is running on a live server
    $LIVE_SERVER = getenv('LIVE_SERVER');
    // Set Google authentication configuration based on the server type
    if ($LIVE_SERVER == 1) {
        $client->setAuthConfig(storage_path('google-login-credentials-LIVE.json'));
    } else if ($LIVE_SERVER == 0) {
        $client->setAuthConfig(storage_path('google-login-credentials-LOCAL.json'));
    }
    // Create Google authentication URL
    $authUrl = $client->createAuthUrl();
    // Sanitize the URL
    $authUrl = filter_var($authUrl, FILTER_SANITIZE_URL);
    // Return a JSON response with the success status and Google authentication URL
    $response = [
        'SUCCESS' => 1,       // 1 indicates success
        'AUTH_URL' => $authUrl,
    ];
    return $response;
}

To explain what this authenticateGoogleAccountForLogin method does:

1. Google_Client Initialization:

   • It creates a new instance of Google_Client.

2. Set Application Information:

   • It sets the application name for identification during Google authentication.

3. Set Scopes:

   • It defines the requested Google API scopes for authentication, including 'profile' and 'email'.

4. Set Access Type:

   • It sets the access type to 'offline' to obtain refresh tokens.

5. Check Server Type:

   • It checks if the application is running on a live server.

6. Set Authentication Configuration:

   • Based on the server type, it sets the Google authentication configuration using the appropriate credentials file.

7. Create Google Authentication URL:

   • It creates the Google authentication URL.

8. Sanitize URL:

   • It sanitizes the URL to ensure it is safe.

9. Generate and Return Response:

   • It generates a response array:

     • SUCCESS is set to 1, indicating success.

     • AUTH_URL contains the Google authentication URL.

loginGoogleUser

public function loginGoogleUser(Request $request)
{
    // Create a new instance of Google_Client
    $client = new Google_Client();
    // Set application name for identification
    $client->setApplicationName('Google Login');
    // Set requested Google API scopes for the authentication
    $client->setScopes(['profile', 'email']);
    // Set access type to 'offline' for obtaining refresh tokens
    $client->setAccessType('offline');
    // Check if the application is running on a live server
    $LIVE_SERVER = getenv('LIVE_SERVER');
    // Set Google authentication configuration based on the server type
    if ($LIVE_SERVER == 1) {
        $client->setAuthConfig(storage_path('google-login-credentials-LIVE.json'));
    } else if ($LIVE_SERVER == 0) {
        $client->setAuthConfig(storage_path('google-login-credentials-LOCAL.json'));
    }
    // Exchange the authorization code for an access token
    $token = $client->fetchAccessTokenWithAuthCode($request->input('code'));
    // Set the obtained access token
    $client->setAccessToken($token);
    // Create an instance of Google_Service_Oauth2 to get user information
    $service = new \Google\Service\Oauth2($client);
    $user = $service->userinfo->get();
    // Extract user details from the Google user information
    $userGoogleId = $user->id;
    $username = "";
    $password = password_hash($userGoogleId, PASSWORD_DEFAULT);
    $email = $user->email;
    $emailParts = explode('@', $email);
    // Extract username from the email address (if possible)
    if (count($emailParts) > 1) {
        $username = $emailParts[0];
    }
    // Check if a user with the same email exists in the database
    $userWithMatchingEmail = UserAccount::where('email', $email)->first();
    // If a user with the same email exists, return success response with user details
    if (isset($userWithMatchingEmail)) {
        $response = [
            'SUCCESS' => 1,
            'ID' => $userWithMatchingEmail->id,
            'USERNAME' => $username,
        ];
        return $response;
    } else {
        // If no user with the same email exists, create a new user account
        $userAccount = new UserAccount([
            'username' => $username,
            'email' => $email,
            'password' => $password,
            'verified' => 1,
        ]);
        $userAccount->save();
        // Create a new user profile for the user account
        $userProfile = new UserProfile([
            'user_id' => $userAccount->id,
        ]);
        $userProfile->save();
        // Create directories and files for user bookmarks and maps
        // Bookmark
        $directory = 'Bookmark';
        $fileBookmark = $directory . '/' . $userAccount->id . '.json';
        if (!file_exists($directory)) {
            mkdir($directory, 0777, true);
        }
        $jsonData = [
            'USER_ID' => $userAccount->id,
            'DATA' => [],
        ];
        $prettyPrintedJson = json_encode($jsonData, JSON_PRETTY_PRINT);
        $file = fopen($fileBookmark, 'w');
        if ($file) {
            fwrite($file, $prettyPrintedJson);
            fclose($file);
        }
        // Bookmark
        // Map
        $directory = 'Map';
        $fileMap = $directory . '/' . $userAccount->id . '.json';
        if (!file_exists($directory)) {
            mkdir($directory, 0777, true);
        }
        $jsonData = [
            'USER_ID' => $userAccount->id,
            'DATA' => [],
        ];
        $prettyPrintedJson = json_encode($jsonData, JSON_PRETTY_PRINT);
        $file = fopen($fileMap, 'w');
        if ($file) {
            fwrite($file, $prettyPrintedJson);
            fclose($file);
        }
        // Map
        // Return success response with user details
        $response = [
            'SUCCESS' => 1,
            'ID' => $userAccount->id,
            'USERNAME' => $username,
        ];
        return $response;
    }
}

To explain what this loginGoogleUser method does:

1. Google_Client Initialization:

   • It creates a new instance of Google_Client.

2. Set Application Information:

   • It sets the application name for identification during Google authentication.

3. Set Scopes:

   • It defines the requested Google API scopes for authentication, including 'profile' and 'email'.

4. Set Access Type:

   • It sets the access type to 'offline' to obtain refresh tokens.

5. Check Server Type:

   • It checks if the application is running on a live server.

6. Set Authentication Configuration:

   • Based on the server type, it sets the Google authentication configuration using the appropriate credentials file.

7. Exchange Authorization Code for Access Token:

   • It exchanges the authorization code (received from the frontend) for an access token.

8. Set Access Token:

   • It sets the obtained access token.

9. Get User Information:

   • It creates an instance of Google_Service_Oauth2 to get user information using the access token.

10. Extract User Details:

    • It extracts relevant user details, including Google ID, username, email, and password.

11. Check Existing User:

    • It checks if a user with the same email exists in the database.

12. Generate and Return Response:

    • If a user with the same email exists, it returns a success response with existing user details.

    • If no user with the same email exists, it creates a new user account, user profile, and associated directories and files.

    • It then returns a success response with the newly created user details.

authenticateFacebookAccountForLogin

public function authenticateFacebookAccountForLogin()
{
    // Retrieve the frontend URL from the environment
    $FRONTEND_URL = getenv('FRONTEND_URL');
    // Set the redirect URI for Facebook authentication
    $redirectUri = $FRONTEND_URL . "/facebook-login";
    // Create a new instance of the Facebook authentication provider
    $provider = new \League\OAuth2\Client\Provider\Facebook([
        'clientId'          => '931800841633712',
        'clientSecret'      => 'f9275c19bc9baff40cd943c7d86b4c52',
        'redirectUri'       => $redirectUri,
        'graphApiVersion'   => 'v18.10',
    ]);
    // Get the authorization URL for Facebook login with requested scopes
    $authUrl = $provider->getAuthorizationUrl(['scope' => ['email']]);
    // Return a JSON response with the success status and Facebook authentication URL
    $response = [
        'SUCCESS' => 1,       // 1 indicates success
        'AUTH_URL' => $authUrl,
    ];
    return $response;
}

To explain what this authenticateFacebookAccountForLogin method does:

1. Retrieve Frontend URL:

   • Retrieve the frontend URL from the environment.

2. Set Redirect URI:

   • Set the redirect URI for Facebook authentication by appending "/facebook-login" to the frontend URL.

3. Create Facebook Authentication Provider:

   • Create a new instance of the Facebook authentication provider (\League\OAuth2\Client\Provider\Facebook).

   • Provide the necessary client ID, client secret, redirect URI, and specify the Graph API version.

4. Generate Authorization URL:

   • Get the authorization URL for Facebook login with requested scopes, including 'email'.

5. Construct Response:

   • Create a JSON response with the success status (1 for success) and the generated Facebook authentication URL.

6. Return Response:

   • Return the constructed JSON response containing the success status and Facebook authentication URL.

loginFacebookUser

public function loginFacebookUser(Request $request)
{
    // Retrieve the frontend URL from the environment
    $FRONTEND_URL = getenv('FRONTEND_URL');
    // Set the redirect URI for Facebook authentication
    $redirectUri = $FRONTEND_URL . "/facebook-login";
    // Create a new instance of the Facebook authentication provider
    $provider = new \League\OAuth2\Client\Provider\Facebook([
        'clientId'          => '931800841633712',
        'clientSecret'      => 'f9275c19bc9baff40cd943c7d86b4c52',
        'redirectUri'       => $redirectUri,
        'graphApiVersion'   => 'v18.0',
    ]);
    // Get the access token from Facebook using the authorization code
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $request->input('code')
    ]);
    // Get the user details from Facebook using the obtained access token
    $user = $provider->getResourceOwner($token);
    // Extract relevant information from the Facebook user
    $userFacebookId = $user->getId();
    $email = $user->getEmail();
    $password = password_hash($userFacebookId, PASSWORD_DEFAULT);
    $username = "";
    $emailParts = explode('@', $email);
    // Extract username from the email address (if possible)
    if (count($emailParts) > 1) {
        $username = $emailParts[0];
    }
    // Check if a user with the same email exists in the database
    $userWithMatchingEmail = UserAccount::where('email', $email)->first();
    // If a user with the same email exists, return success response with user details
    if (isset($userWithMatchingEmail)) {
        $response = [
            'SUCCESS' => 1,
            'ID' => $userWithMatchingEmail->id,
            'USERNAME' => $username,
        ];
        return $response;
    } else {
        // If no user with the same email exists, create a new user account
        $userAccount = new UserAccount([
            'username' => $username,
            'email' => $email,
            'password' => $password,
            'verified' => 1,
        ]);
        $userAccount->save();
        // Create a new user profile for the user account
        $userProfile = new UserProfile([
            'user_id' => $userAccount->id,
        ]);
        $userProfile->save();
        // Create directories and files for user bookmarks and maps
        // Bookmark
        $directory = 'Bookmark';
        $fileBookmark = $directory . '/' . $userAccount->id . '.json';
        if (!file_exists($directory)) {
            mkdir($directory, 0777, true);
        }
        $jsonData = [
            'USER_ID' => $userAccount->id,
            'DATA' => [],
        ];
        $prettyPrintedJson = json_encode($jsonData, JSON_PRETTY_PRINT);
        $file = fopen($fileBookmark, 'w');
        if ($file) {
            fwrite($file, $prettyPrintedJson);
            fclose($file);
        }
        // Bookmark
        // Map
        $directory = 'Map';
        $fileMap = $directory . '/' . $userAccount->id . '.json';
        if (!file_exists($directory)) {
            mkdir($directory, 0777, true);
        }
        $jsonData = [
            'USER_ID' => $userAccount->id,
            'DATA' => [],
        ];
        $prettyPrintedJson = json_encode($jsonData, JSON_PRETTY_PRINT);
        $file = fopen($fileMap, 'w');
        if ($file) {
            fwrite($file, $prettyPrintedJson);
            fclose($file);
        }
        // Map
        // Return success response with user details
        $response = [
            'SUCCESS' => 1,
            'ID' => $userAccount->id,
            'USERNAME' => $username,
        ];
        return $response;
    }
}

To explain what this loginFacebookUser method does:

1. Retrieve Frontend URL:

   • It retrieves the frontend URL from the environment.

2. Set Redirect URI:

   • It sets the redirect URI for Facebook authentication.

3. Create Facebook Authentication Provider:

   • It creates a new instance of the Facebook authentication provider.

4. Get Access Token:

   • It gets the access token from Facebook using the authorization code received from the frontend.

5. Get User Details:

   • It gets the user details from Facebook using the obtained access token.

6. Extract User Details:

   • It extracts relevant user details, including Facebook ID, username, email, and password.

7. Check Existing User:

   • It checks if a user with the same email exists in the database.

8. Generate and Return Response:

   • If a user with the same email exists, it returns a success response with existing user details.

   • If no user with the same email exists, it creates a new user account, user profile, and associated directories and files.

   • It then returns a success response with the newly created user details.