التعامل مع عمليات تسجيل الدخول المتكرّرة

هذه هي الجولة التفصيلية الثالثة ضمن سلسلة الجولات التفصيلية حول إضافات Classroom.

في هذه الجولة التفصيلية، يمكنك التعامل مع الزيارات المتكررة إلى الإضافة من خلال الاسترداد التلقائي لبيانات اعتماد المستخدم التي تم منحها سابقًا. وتقوم بعد ذلك بتوجيه المستخدمين إلى صفحات يمكنهم من خلالها إصدار طلبات واجهة برمجة التطبيقات على الفور. وهذا السلوك مطلوب لإضافات Classroom.

خلال هذه الجولة التفصيلية، يمكنك إكمال ما يلي:

  • استخدام التخزين الثابت لبيانات اعتماد المستخدم لدينا
  • استعِد مَعلمة طلب البحث لإضافة "login_hint" وقيِّمها. وهو رقم تعريف Google فريد للمستخدم الذي سجّل الدخول.

بعد الانتهاء، يمكنك منح المستخدمين الإذن بالكامل في تطبيق الويب وإصدار طلبات إلى Google APIs.

فهم مَعلمات طلب البحث لإطار iframe

يُحمِّل Classroom معرّف الموارد المنتظم (URI) لإعداد المرفقات للإضافة عند فتحها. يُلحق Classroom العديد من مَعلمات طلب البحث GET بمعرّف الموارد المنتظم (URI) الذي يحتوي على معلومات سياقية مفيدة. على سبيل المثال، إذا كان معرِّف الموارد المنتظم (URI) الخاص بميزة "اكتشاف المرفقات" هو https://example.com/addon، ينشئ Classroom إطار iframe مع ضبط عنوان URL المصدر على https://example.com/addon?courseId=XXX&itemId=YYY&itemType=courseWork&addOnToken=ZZZ، حيث يكون XXX وYYY وZZZ أرقام تعريف سلاسل. راجِع دليل إطارات iframe للحصول على وصف تفصيلي لهذا السيناريو.

هناك خمس مَعلمات طلب بحث محتملة لعنوان URL الخاص بميزة "اقتراحات":

  • courseId: رقم تعريف الدورة التدريبية الحالية في Classroom.
  • itemId: رقم تعريف عنصر ساحة المشاركات الذي يعدّله المستخدم أو ينشئه
  • itemType: نوع عنصر البث الذي ينشئه المستخدم أو يعدّله، سواء كان courseWork أو courseWorkMaterial أو announcement.
  • addOnToken: هو رمز مميّز يُستخدم لتفويض إجراءات معيّنة لإضافة Classroom.
  • login_hint: رقم تعريف Google للمستخدم الحالي

تتناول هذه الجولة التفصيلية login_hint. يتم توجيه المستخدمين استنادًا إلى ما إذا تم توفير معلمة طلب البحث هذه، إما إلى تدفق التفويض في حالة عدم وجوده أو إلى صفحة اكتشاف الإضافة إن وجدت.

الوصول إلى مَعلمات طلب البحث

يتم تمرير مَعلمات طلب البحث إلى تطبيق الويب في سلسلة معرّف الموارد المنتظم (URI). ويمكنك تخزين هذه القيم في جلستك، حيث تُستخدم في تدفق التفويض ولتخزين معلومات حول المستخدم واستردادها. لا يتم تمرير معلمات الاستعلام هذه إلا عند فتح الإضافة لأول مرة.

Python

انتقِل إلى تعريفات مسارات Flask (routes.py إذا كنت تتّبع المثال المقدَّم). في أعلى المسار المقصود للإضافة (/classroom-addon في المثال المقدّم)، عليك استرداد مَعلمة طلب البحث login_hint وتخزينها:

# If the login_hint query parameter is available, we'll store it in the session.
if flask.request.args.get("login_hint"):
    flask.session["login_hint"] = flask.request.args.get("login_hint")

تأكَّد من تخزين "login_hint" (في حال توفّره) في الجلسة. هذا مكان مناسب لتخزين هذه القيم؛ فهي مؤقتة وتتلقى قيمًا جديدة عند فتح الإضافة.

# It's possible that we might return to this route later, in which case the
# parameters will not be passed in. Instead, use the values cached in the
# session.
login_hint = flask.session.get("login_hint")

# If there's still no login_hint query parameter, this must be their first
# time signing in, so send the user to the sign in page.
if login_hint is None:
    return start_auth_flow()

Java

انتقِل إلى المسار المقصود للإضافة في فئة وحدة التحكّم (/addon-discovery في AuthController.java في المثال المقدَّم). في بداية هذا المسار، يمكنك استرداد معلَمة طلب البحث login_hint وتخزينها.

/** Retrieve the login_hint or hd query parameters from the request URL. */
String login_hint = request.getParameter("login_hint");
String hd = request.getParameter("hd");

تأكَّد من تخزين "login_hint" (في حال توفّره) في الجلسة. هذا مكان مناسب لتخزين هذه القيم؛ فهي مؤقتة وتتلقى قيمًا جديدة عند فتح الإضافة.

/** If neither query parameter is sent, use the values in the session. */
if (login_hint == null && hd == null) {
    login_hint = (String) session.getAttribute("login_hint");
    hd = (String) session.getAttribute("hd");
}

/** If the hd query parameter is provided, add hd to the session and route
*   the user to the authorization page. */
else if (hd != null) {
    session.setAttribute("hd", hd);
    return startAuthFlow(model);
}

/** If the login_hint query parameter is provided, add it to the session. */
else if (login_hint != null) {
    session.setAttribute("login_hint", login_hint);
}

أضِف مَعلمات طلب البحث إلى مسار التفويض.

يجب تمرير المعلَمة login_hint إلى خوادم مصادقة Google أيضًا. ويسهِّل ذلك عملية المصادقة، فإذا كان التطبيق يعرف أي مستخدم يحاول المصادقة، يستخدم الخادم التلميح لتبسيط عملية تسجيل الدخول عن طريق ملء حقل البريد الإلكتروني مسبقًا في نموذج تسجيل الدخول.

Python

انتقِل إلى مسار التفويض في ملف خادم Flask (/authorize في المثال المقدَّم). إضافة الوسيطة login_hint إلى طلب flow.authorization_url.

authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type="offline",
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes="true",
    # The user will automatically be selected if we have the login_hint.
    login_hint=flask.session.get("login_hint"),

Java

الانتقال إلى الطريقة authorize() في الصف AuthService.java أضِف login_hint وhd كمَعلمتَين إلى الطريقة، وأضِف الوسيطات login_hint وhd إلى أداة إنشاء عناوين URL للتفويض.

String authUrl = flow
    .newAuthorizationUrl()
    .setState(state)
    .set("login_hint", login_hint)
    .set("hd", hd)
    .setRedirectUri(REDIRECT_URI)
    .build();

إضافة مساحة تخزين دائمة لبيانات اعتماد المستخدم

إذا تلقّيت login_hint كمَعلمة طلب بحث عند تحميل الإضافة، يشير ذلك إلى أنّ المستخدم قد أكمل مسار التفويض في تطبيقنا. ينبغي لك استرداد بيانات الاعتماد السابقة بدلاً من إجبارهم على تسجيل الدخول مرة أخرى.

تذكّر أنّك تلقّيت رمزًا مميّزًا لإعادة التحميل عند اكتمال عملية التفويض. احفظ هذا الرمز المميّز، لإعادة استخدامه للحصول على رمز دخول قصير الأجل وضروري لاستخدام Google APIs. لقد حفظت بيانات الاعتماد هذه سابقًا في الجلسة، ولكنك تحتاج إلى تخزين بيانات الاعتماد للتعامل مع الزيارات المتكررة.

تحديد مخطط المستخدم وإعداد قاعدة البيانات

إعداد مخطّط قاعدة بيانات لـ User

Python

تحديد مخطط المستخدم

تحتوي User على السمات التالية:

  • id: رقم تعريف Google للمستخدم ويجب أن تتطابق مع القيم المقدّمة في معلَمة طلب البحث login_hint.
  • display_name: الاسم الأول واسم العائلة للمستخدِم، مثل "أليكس سلام"
  • email: عنوان البريد الإلكتروني الخاص بالمستخدم
  • portrait_url: عنوان URL لصورة الملف الشخصي للمستخدم
  • refresh_token: الرمز المميز الذي تم الحصول عليه سابقًا لإعادة التحميل.

ينفذ هذا المثال التخزين باستخدام SQLite، والتي تدعمها بايثون في الأصل. وهو يستخدم وحدة flask_sqlalchemy لتسهيل إدارة قاعدة البيانات الخاصة بنا.

إعداد قاعدة البيانات

أولاً، حدد مكان ملف لقاعدة البيانات لدينا. انتقِل إلى ملف إعداد الخادم (config.py في المثال المقدّم) وأضِف ما يلي.

import os

# Point to a database file in the project root.
DATABASE_FILE_NAME = os.path.join(
    os.path.abspath(os.path.dirname(__file__)), 'data.sqlite')

class Config(object):
    SQLALCHEMY_DATABASE_URI = f"sqlite:///{DATABASE_FILE_NAME}"
    SQLALCHEMY_TRACK_MODIFICATIONS = False

يؤدي هذا الإجراء إلى توجيه Flask إلى الملف data.sqlite في الدليل نفسه الذي يتضمّن ملف main.py.

انتقِل بعد ذلك إلى دليل الوحدات وأنشِئ ملف models.py جديدًا. هذه هي القيمة webapp/models.py إذا كنت تتبع المثال الذي نقدّمه. أضِف ما يلي إلى الملف الجديد لتحديد جدول User، مع استبدال اسم الوحدة بـ webapp إذا كان مختلفًا.

from webapp import db

# Database model to represent a user.
class User(db.Model):
    # The user's identifying information:
    id = db.Column(db.String(120), primary_key=True)
    display_name = db.Column(db.String(80))
    email = db.Column(db.String(120), unique=True)
    portrait_url = db.Column(db.Text())

    # The user's refresh token, which will be used to obtain an access token.
    # Note that refresh tokens will become invalid if:
    # - The refresh token has not been used for six months.
    # - The user revokes your app's access permissions.
    # - The user changes passwords.
    # - The user belongs to a Google Cloud organization
    #   that has session control policies in effect.
    refresh_token = db.Column(db.Text())

أخيرًا، في ملف __init__.py الخاص بالوحدة، أضِف ما يلي لاستيراد النماذج الجديدة وإنشاء قاعدة البيانات.

from webapp import models
from os import path
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy(app)

# Initialize the database file if not created.
if not path.exists(config.DATABASE_FILE_NAME):
    db.create_all()

Java

تحديد مخطط المستخدم

تحتوي User على السمات التالية:

  • id: رقم تعريف Google للمستخدم ويجب أن تتطابق مع القيمة المقدّمة في معلَمة طلب البحث login_hint.
  • email: عنوان البريد الإلكتروني الخاص بالمستخدم

أنشِئ ملف schema.sql في دليل resources الخاص بالوحدة. يقرأ Spring هذا الملف وينشئ مخططًا لقاعدة البيانات وفقًا لذلك. حدِّد الجدول باسم جدول وusers وأعمدة لتمثيل السمتَين User، وهما id وemail.

CREATE TABLE IF NOT EXISTS users (
    id VARCHAR(255) PRIMARY KEY, -- user's unique Google ID
    email VARCHAR(255), -- user's email address
);

يمكنك إنشاء فئة Java لتحديد نموذج User لقاعدة البيانات. هذه القيمة هي User.java في المثال المقدّم.

يمكنك إضافة تعليق @Entity التوضيحي للإشارة إلى أنّ هذا الهدف هو أمر POJO يمكن حفظه في قاعدة البيانات. أضِف التعليق التوضيحي @Table مع اسم الجدول المقابل الذي ضبطته في schema.sql.

يُرجى العِلم بأنّ مثال الرمز البرمجي يتضمن الدوال الإنشائية وأدوات الضبط للسمتَين. وتُستخدم الدالة الإنشائية وأدوات الضبط في AuthController.java لإنشاء مستخدم أو تعديله في قاعدة البيانات. ويمكنك أيضًا تضمين القيمة getters وطريقة toString على النحو الذي تراه مناسبًا، ولكن بالنسبة إلى هذه الجولة التفصيلية تحديدًا، لا يتم استخدام هذه الطرق ويتم حذفها من مثال الرمز البرمجي في هذه الصفحة للإيجاز.

/** An entity class that provides a model to store user information. */
@Entity
@Table(name = "users")
public class User {
    /** The user's unique Google ID. The @Id annotation specifies that this
     *   is the primary key. */
    @Id
    @Column
    private String id;

    /** The user's email address. */
    @Column
    private String email;

    /** Required User class no args constructor. */
    public User() {
    }

    /** The User class constructor that creates a User object with the
    *   specified parameters.
    *   @param id the user's unique Google ID
    *   @param email the user's email address
    */
    public User(String id, String email) {
        this.id = id;
        this.email = email;
    }

    public void setId(String id) { this.id = id; }

    public void setEmail(String email) { this.email = email; }
}

أنشئ واجهة تُسمى UserRepository.java للتعامل مع عمليات CRUD في قاعدة البيانات. توسّع هذه الواجهة واجهة CrudRepository.

/** Provides CRUD operations for the User class by extending the
 *   CrudRepository interface. */
@Repository
public interface UserRepository extends CrudRepository<User, String> {
}

وتسهّل فئة وحدة التحكّم إمكانية التواصل بين العميل والمستودع. وبالتالي، عليك تحديث الدالة الإنشائية لفئة وحدة التحكّم لإدخال الفئة UserRepository.

/** Declare UserRepository to be used in the Controller class constructor. */
private final UserRepository userRepository;

/**
*   ...
*   @param userRepository the class that interacts with User objects stored in
*   persistent storage.
*/
public AuthController(AuthService authService, UserRepository userRepository) {
    this.authService = authService;
    this.userRepository = userRepository;
}

إعداد قاعدة البيانات

لتخزين المعلومات المتعلقة بالمستخدم، يمكنك استخدام قاعدة بيانات H2 متوافقة بشكل أساسي مع Spring Boot. تُستخدم قاعدة البيانات هذه أيضًا في الجولات التفصيلية اللاحقة لتخزين المعلومات الأخرى المتعلقة بخدمة Classroom. يتطلب إعداد قاعدة بيانات H2 إضافة الإعدادات التالية إلى application.properties.

# Enable configuration for persistent storage using an H2 database
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:file:./h2/userdb
spring.datasource.username=<USERNAME>
spring.datasource.password=<PASSWORD>
spring.jpa.hibernate.ddl-auto=update
spring.jpa.open-in-view=false

تنشئ إعدادات spring.datasource.url دليلاً باسم h2، يتضمّن الملف userdb مخزّنًا فيه. أضِف المسار إلى قاعدة بيانات H2 إلى .gitignore. يجب تحديث spring.datasource.username وspring.datasource.password قبل تشغيل التطبيق لضبط قاعدة البيانات من خلال اسم مستخدم وكلمة مرور من اختيارك. لتعديل اسم المستخدم وكلمة المرور لقاعدة البيانات بعد تشغيل التطبيق، احذف دليل h2 الذي تم إنشاؤه وعدِّل الإعدادات وأعِد تشغيل التطبيق.

يضمن ضبط إعدادات spring.jpa.hibernate.ddl-auto على update الاحتفاظ بالبيانات المخزَّنة في قاعدة البيانات عند إعادة تشغيل التطبيق. لمحو قاعدة البيانات في كل مرة تتم فيها إعادة تشغيل التطبيق، اضبط هذه الإعدادات على create.

اضبط إعدادات spring.jpa.open-in-view على false. يتم تفعيل هذا الإعداد تلقائيًا، وقد يؤدّي ذلك إلى حدوث مشاكل في الأداء يصعب تشخيصها في مرحلة الإنتاج.

وكما هو موضّح سابقًا، يجب أن تتمكّن من استرداد بيانات اعتماد مستخدم متكرّر. ويتم تسهيل هذا الأمر من خلال دعم متجر بيانات الاعتماد المضمَّن المُقدَّم من GoogleAuthorizationCodeFlow.

في الفئة AuthService.java، حدِّد مسارًا إلى الملف الذي يتم تخزين فئة بيانات الاعتماد فيه. في هذا المثال، يتم إنشاء الملف في الدليل /credentialStore. أضِف المسار إلى مخزن بيانات الاعتماد إلى .gitignore. ويتم إنشاء هذا الدليل عندما يبدأ المستخدم تدفق التفويض.

private static final File dataDirectory = new File("credentialStore");

بعد ذلك، أنشِئ طريقة في ملف AuthService.java تُنشئ كائن FileDataStoreFactory ويعرضها. هذا هو مخزن البيانات الذي يخزِّن بيانات الاعتماد.

/** Creates and returns FileDataStoreFactory object to store credentials.
 *   @return FileDataStoreFactory dataStore used to save and obtain users ids
 *   mapped to Credentials.
 *   @throws IOException if creating the dataStore is unsuccessful.
 */
public FileDataStoreFactory getCredentialDataStore() throws IOException {
    FileDataStoreFactory dataStore = new FileDataStoreFactory(dataDirectory);
    return dataStore;
}

عدِّل طريقة getFlow() في AuthService.java لتضمين setDataStoreFactory في طريقة GoogleAuthorizationCodeFlow Builder()، واطلب getCredentialDataStore() لضبط مخزن البيانات.

GoogleAuthorizationCodeFlow authorizationCodeFlow =
    new GoogleAuthorizationCodeFlow.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY,
        getClientSecrets(),
        getScopes())
    .setAccessType("offline")
    .setDataStoreFactory(getCredentialDataStore())
    .build();

بعد ذلك، عدِّل طريقة getAndSaveCredentials(String authorizationCode). في السابق، كانت هذه الطريقة تحصل على بيانات الاعتماد بدون تخزينها في أي مكان. عدِّل طريقة تخزين بيانات الاعتماد في مخزن البيانات المفهرَسة من خلال رقم تعريف المستخدم.

يمكن الحصول على رقم تعريف المستخدم من عنصر TokenResponse باستخدام id_token، ولكن يجب إثبات ملكيته أولاً. بخلاف ذلك، قد تتمكن تطبيقات العميل من انتحال هوية المستخدمين من خلال إرسال معرّفات مستخدمين معدّلة إلى الخادم. ننصحك باستخدام مكتبات برامج Google API للتحقق من id_token. للحصول على مزيد من المعلومات، يمكنك الاطّلاع على [صفحة هوية Google التي تتناول إثبات الملكية باستخدام الرمز المميّز لمعرّف Google].

// Obtaining the id_token will help determine which user signed in to the application.
String idTokenString = tokenResponse.get("id_token").toString();

// Validate the id_token using the GoogleIdTokenVerifier object.
GoogleIdTokenVerifier googleIdTokenVerifier = new GoogleIdTokenVerifier.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY)
    .setAudience(Collections.singletonList(
        googleClientSecrets.getWeb().getClientId()))
    .build();

GoogleIdToken idToken = googleIdTokenVerifier.verify(idTokenString);

if (idToken == null) {
    throw new Exception("Invalid ID token.");
}

بعد إثبات ملكية id_token، عليك الحصول على userId لتخزين بيانات الاعتماد التي تم الحصول عليها.

// Obtain the user id from the id_token.
Payload payload = idToken.getPayload();
String userId = payload.getSubject();

يُرجى تعديل المكالمة إلى flow.createAndStoreCredential لتضمين userId.

// Save the user id and credentials to the configured FileDataStoreFactory.
Credential credential = flow.createAndStoreCredential(tokenResponse, userId);

أضِف طريقة إلى الفئة AuthService.java تعرض بيانات الاعتماد لمستخدم محدّد إذا كانت متوفّرة في مخزن البيانات.

/** Find credentials in the datastore based on a specific user id.
*   @param userId key to find in the file datastore.
*   @return Credential object to be returned if a matching key is found in the datastore. Null if
*   the key doesn't exist.
*   @throws Exception if building flow object or checking for userId key is unsuccessful. */
public Credential loadFromCredentialDataStore(String userId) throws Exception {
    try {
        GoogleAuthorizationCodeFlow flow = getFlow();
        Credential credential = flow.loadCredential(userId);
        return credential;
    } catch (Exception e) {
        e.printStackTrace();
        throw e;
    }
}

استرداد بيانات الاعتماد

حدِّد طريقة لاسترجاع Users. يتم توفير id في معلَمة طلب البحث login_hint، والتي يمكنك استخدامها لاسترداد سجلّ مستخدم معيّن.

Python

def get_credentials_from_storage(id):
    """
    Retrieves credentials from the storage and returns them as a dictionary.
    """
    return User.query.get(id)

Java

في الفئة AuthController.java، حدِّد طريقة لاسترداد مستخدم من قاعدة البيانات استنادًا إلى رقم تعريف المستخدم.

/** Retrieves stored credentials based on the user id.
*   @param id the id of the current user
*   @return User the database entry corresponding to the current user or null
*   if the user doesn't exist in the database.
*/
public User getUser(String id) {
    if (id != null) {
        Optional<User> user = userRepository.findById(id);
        if (user.isPresent()) {
            return user.get();
        }
    }
    return null;
}

بيانات الاعتماد الخاصة بمتجر Play

هناك سيناريوهان عند تخزين بيانات الاعتماد. إذا كان عنصر id للمستخدم مُدرجًا في قاعدة البيانات، يمكنك تعديل السجلّ الحالي باستخدام أي قيم جديدة. يمكنك بدلاً من ذلك إنشاء سجلّ User جديد وإضافته إلى قاعدة البيانات.

Python

حدد أولاً طريقة الأداة التي تنفذ التخزين أو سلوك التحديث.

def save_user_credentials(credentials=None, user_info=None):
    """
    Updates or adds a User to the database. A new user is added only if both
    credentials and user_info are provided.

    Args:
        credentials: An optional Credentials object.
        user_info: An optional dict containing user info returned by the
            OAuth 2.0 API.
    """

    existing_user = get_credentials_from_storage(
        flask.session.get("login_hint"))

    if existing_user:
        if user_info:
            existing_user.id = user_info.get("id")
            existing_user.display_name = user_info.get("name")
            existing_user.email = user_info.get("email")
            existing_user.portrait_url = user_info.get("picture")

        if credentials and credentials.refresh_token is not None:
            existing_user.refresh_token = credentials.refresh_token

    elif credentials and user_info:
        new_user = User(id=user_info.get("id"),
                        display_name=user_info.get("name"),
                        email=user_info.get("email"),
                        portrait_url=user_info.get("picture"),
                        refresh_token=credentials.refresh_token)

        db.session.add(new_user)

    db.session.commit()

هناك حالتان يمكنك فيهما حفظ بيانات الاعتماد في قاعدة البيانات: عندما يعود المستخدم إلى تطبيقك في نهاية مسار التفويض وعند إصدار طلب بيانات من واجهة برمجة التطبيقات. هذه هي المكان الذي ضبطنا فيه مفتاح credentials للجلسة.

يمكنك الاتصال بـ "save_user_credentials" في نهاية مسار "callback". احتفِظ بالكائن user_info بدلاً من استخراج اسم المستخدم فقط.

# The flow is complete! We'll use the credentials to fetch the user's info.
user_info_service = googleapiclient.discovery.build(
    serviceName="oauth2", version="v2", credentials=credentials)

user_info = user_info_service.userinfo().get().execute()

flask.session["username"] = user_info.get("name")

save_user_credentials(credentials, user_info)

وعليك أيضًا تعديل بيانات الاعتماد بعد طلب البيانات من واجهة برمجة التطبيقات. وفي هذه الحالة، يمكنك تقديم بيانات الاعتماد المعدَّلة كوسيطات في طريقة save_user_credentials.

# Save credentials in case access token was refreshed.
flask.session["credentials"] = credentials_to_dict(credentials)
save_user_credentials(credentials)

Java

حدِّد أولاً طريقة لتخزين عنصر User أو تعديله في قاعدة بيانات H2.

/** Adds or updates a user in the database.
*   @param credential the credentials object to save or update in the database.
*   @param userinfo the userinfo object to save or update in the database.
*   @param session the current session.
*/
public void saveUser(Credential credential, Userinfo userinfo, HttpSession session) {
    User storedUser = null;
    if (session != null && session.getAttribute("login_hint") != null) {
        storedUser = getUser(session.getAttribute("login_hint").toString());
    }

    if (storedUser != null) {
        if (userinfo != null) {
            storedUser.setId(userinfo.getId());
            storedUser.setEmail(userinfo.getEmail());
        }
        userRepository.save(storedUser);
    } else if (credential != null && userinfo != null) {
        User newUser = new User(
            userinfo.getId(),
            userinfo.getEmail(),
        );
        userRepository.save(newUser);
    }
}

هناك حالتان يمكنك فيهما حفظ بيانات الاعتماد في قاعدة البيانات: عندما يعود المستخدم إلى تطبيقك في نهاية مسار التفويض وعند إصدار طلب بيانات من واجهة برمجة التطبيقات. هذه هي المكان الذي ضبطنا فيه مفتاح credentials للجلسة.

يمكنك الاتصال بـ saveUser في نهاية مسار /callback. عليك الاحتفاظ بالكائن user_info بدلاً من استخراج البريد الإلكتروني للمستخدم فقط.

/** This is the end of the auth flow. We should save user info to the database. */
Userinfo userinfo = authService.getUserInfo(credentials);
saveUser(credentials, userinfo, session);

وعليك أيضًا تعديل بيانات الاعتماد بعد طلب البيانات من واجهة برمجة التطبيقات. في هذه الحالة، يمكنك تقديم بيانات الاعتماد المعدّلة كوسيطات في طريقة saveUser.

/** Save credentials in case access token was refreshed. */
saveUser(credentials, null, session);

بيانات الاعتماد منتهية الصلاحية

لاحظ أن هناك بعض الأسباب التي قد تجعل الرموز المميزة لإعادة التحميل غير صالحة. ويشمل ذلك ما يلي:

  • لم يتم استخدام الرمز المميز لإعادة التحميل لمدة ستة أشهر.
  • يُبطِل المستخدم أذونات الوصول إلى تطبيقك.
  • تغيير المستخدم لكلمات المرور
  • ينتمي المستخدم إلى مؤسسة على Google Cloud تطبِّق سياسات للتحكُّم في الجلسات.

احصل على رموز مميزة جديدة عن طريق إرسال المستخدم عبر مسار التفويض مرة أخرى إذا أصبحت بيانات الاعتماد الخاصة به غير صالحة.

توجيه المستخدم تلقائيًا

يمكنك تعديل المسار المقصود للإضافة لمعرفة ما إذا كان المستخدم قد فوّض تطبيقنا سابقًا. إذا كان الأمر كذلك، يمكنك توجيهه إلى صفحة الإضافات الرئيسية. أو اطلب منهم تسجيل الدخول.

Python

تأكد من إنشاء ملف قاعدة البيانات عند تشغيل التطبيق. أدخِل ما يلي في مهيئ الوحدة (مثل webapp/__init__.py في المثال المقدّم) أو في الطريقة الرئيسية التي تشغّل الخادم.

# Initialize the database file if not created.
if not os.path.exists(DATABASE_FILE_NAME):
    db.create_all()

يجب أن تتعامل طريقتك بعد ذلك مع login_hint معلمة طلب البحث كما تمت مناقشته أعلاه. بعد ذلك، حمِّل بيانات اعتماد المتجر إذا كان هذا زائرًا متكررًا. أنت تعرف أنّه زائر متكرّر إذا تلقّيت login_hint. يمكنك استرداد أي بيانات اعتماد مخزَّنة لهذا المستخدم وتحميلها إلى الجلسة.

stored_credentials = get_credentials_from_storage(login_hint)

# If we have stored credentials, store them in the session.
if stored_credentials:
    # Load the client secrets file contents.
    client_secrets_dict = json.load(
        open(CLIENT_SECRETS_FILE)).get("web")

    # Update the credentials in the session.
    if not flask.session.get("credentials"):
        flask.session["credentials"] = {}

    flask.session["credentials"] = {
        "token": stored_credentials.access_token,
        "refresh_token": stored_credentials.refresh_token,
        "token_uri": client_secrets_dict["token_uri"],
        "client_id": client_secrets_dict["client_id"],
        "client_secret": client_secrets_dict["client_secret"],
        "scopes": SCOPES
    }

    # Set the username in the session.
    flask.session["username"] = stored_credentials.display_name

أخيرًا، يمكنك توجيه المستخدم إلى صفحة تسجيل الدخول إذا لم تكن لدينا بيانات اعتماد. وإذا فعلنا ذلك، يمكنك توجيهه إلى صفحة الإضافات الرئيسية.

if "credentials" not in flask.session or \
    flask.session["credentials"]["refresh_token"] is None:
    return flask.render_template("authorization.html")

return flask.render_template(
    "addon-discovery.html",
    message="You've reached the addon discovery page.")

Java

انتقِل إلى المسار المقصود للإضافة (/addon-discovery في المثال المقدَّم). كما ناقشنا أعلاه، هذا هو المكان الذي تعاملت فيه مع معلَمة طلب البحث login_hint.

أولاً، تأكَّد من توفّر بيانات الاعتماد في الجلسة. وإذا لم يظهر الإذن، يمكنك توجيه المستخدم عبر مسار المصادقة من خلال طلب إجراء startAuthFlow.

/** Check if the credentials exist in the session. The session could have
 *   been cleared when the user clicked the Sign-Out button, and the expected
 *   behavior after sign-out would be to display the sign-in page when the
 *   iframe is opened again. */
if (session.getAttribute("credentials") == null) {
    return startAuthFlow(model);
}

بعد ذلك، عليك تحميل بيانات المستخدم من قاعدة بيانات H2 إذا كان هذا المستخدم زائرًا متكرّرًا. يكون هذا المستخدم زائرًا متكررًا إذا تلقّيت معلَمة طلب البحث login_hint. إذا كان المستخدم متوفرًا في قاعدة بيانات H2، يُرجى تحميل بيانات الاعتماد من إعداد مخزن بيانات بيانات الاعتماد سابقًا، وإعداد بيانات الاعتماد في الجلسة. إذا لم يتم الحصول على بيانات الاعتماد من مخزن بيانات الاعتماد، يمكنك توجيه المستخدم عبر مسار المصادقة من خلال طلب startAuthFlow.

/** At this point, we know that credentials exist in the session, but we
 *   should update the session credentials with the credentials in persistent
 *   storage in case they were refreshed. If the credentials in persistent
 *   storage are null, we should navigate the user to the authorization flow
 *   to obtain persisted credentials. */

User storedUser = getUser(login_hint);

if (storedUser != null) {
    Credential credential = authService.loadFromCredentialDataStore(login_hint);
    if (credential != null) {
        session.setAttribute("credentials", credential);
    } else {
        return startAuthFlow(model);
    }
}

وأخيرًا، وجِّه المستخدم إلى الصفحة المقصودة للإضافة.

/** Finally, if there are credentials in the session and in persistent
 *   storage, direct the user to the addon-discovery page. */
return "addon-discovery";

اختبار الإضافة

سجِّل الدخول إلى Google Classroom بصفتك أحد المستخدمين الاختباريين المعلّمين. انتقِل إلى علامة التبويب الواجب الدراسي وأنشئ مهمة جديدة. انقر على الزر الإضافات أسفل مربّع النص، ثم اختَر الإضافة التي تريدها. يتم فتح إطار iframe وتحمِّل الإضافة معرّف الموارد المنتظم (URI) لإعداد مُرفَقات الذي حدّدته في صفحة إعدادات التطبيق في حزمة تطوير البرامج (SDK) في Google Workspace Marketplace.

تهانينا! يمكنك الآن المتابعة إلى الخطوة التالية: إنشاء المرفقات وتحديد دور المستخدم.