graph LR
FacebookBackend["FacebookBackend"]
FacebookMiddleware["FacebookMiddleware"]
connect_user["connect_user"]
FacebookUser["FacebookUser"]
facebook_required["facebook_required"]
FacebookRegistrationBackend["FacebookRegistrationBackend"]
OpenFacebook["OpenFacebook"]
FacebookBackend -- "delegates user linking and token management to" --> connect_user
FacebookBackend -- "potentially delegates new user registration to" --> FacebookRegistrationBackend
FacebookBackend -- "uses" --> OpenFacebook
FacebookMiddleware -- "enforces authentication by leveraging" --> facebook_required
connect_user -- "calls" --> FacebookUser
connect_user -- "calls" --> FacebookRegistrationBackend
connect_user -- "uses" --> OpenFacebook
FacebookUser -- "relies on" --> OpenFacebook
facebook_required -- "delegates the actual user verification and authentication to" --> FacebookBackend
FacebookRegistrationBackend -- "leverages" --> FacebookBackend
The django-facebook subsystem is built around a clear separation of concerns, with Django's authentication system at its core. The FacebookMiddleware and facebook_required decorator act as the entry points for Facebook authentication, ensuring that only authenticated users can access protected views. The FacebookBackend then takes over, validating Facebook credentials and either authenticating existing users or initiating the registration process through FacebookRegistrationBackend. The connect_user function serves as a central orchestrator for linking Facebook profiles with Django users, managing access tokens, and updating user information. All interactions with the Facebook Graph API are abstracted through the OpenFacebook component, which handles the low-level details of API requests and responses. Finally, the FacebookUser model stores and manages Facebook-specific user data, including the crucial access tokens, which are extended using the OpenFacebook component to maintain persistent sessions. This architecture ensures a modular, maintainable, and scalable approach to integrating Facebook authentication into Django applications.
This component acts as a custom Django authentication backend. Its primary responsibility is to verify Facebook credentials (e.g., access tokens) and either retrieve an existing Django user or provision a new one based on the provided Facebook data. It integrates directly with Django's authentication system.
Related Classes/Methods:
django_facebook.connect.connect_user:40-115django_facebook.registration_backends.FacebookRegistrationBackend:80-117open_facebook.api.OpenFacebook:644-957
This middleware intercepts incoming HTTP requests to ensure that a valid Facebook session is active for the user. It acts as a gatekeeper, redirecting unauthenticated users to the Facebook OAuth flow when necessary to initiate the authentication process.
Related Classes/Methods:
A crucial utility function that orchestrates the linking of a Django user with their Facebook profile. It handles updating user information from Facebook, managing (acquiring, extending, and storing) Facebook access tokens, and coordinating the registration process for new users.
Related Classes/Methods:
django_facebook.models.FacebookUser:315-335django_facebook.registration_backends.FacebookRegistrationBackend:80-117open_facebook.api.OpenFacebook:644-957
This Django model represents a user's Facebook profile data, including their Facebook User ID and access token. Its extend_access_token method is specifically responsible for refreshing short-lived Facebook access tokens into long-lived ones, which is vital for maintaining persistent user sessions.
Related Classes/Methods:
A Django decorator designed to enforce Facebook authentication on specific views. When applied, it handles the redirection to Facebook for the OAuth process and processes the callback after successful authentication, ensuring that only authenticated users can access the decorated view.
Related Classes/Methods:
This component manages the specific logic for registering new users who sign up through Facebook. It integrates with Django's built-in user management system to create new user accounts based on data received from Facebook.
Related Classes/Methods:
This component provides a high-level abstraction for interacting with the Facebook Graph API. It handles constructing requests, making HTTP calls, and parsing responses. It is a critical dependency for token validation, user data retrieval, and token extension within this subsystem.
Related Classes/Methods: