পুনরাবৃত্তি লগইন পরিচালনা করুন

এটি ক্লাসরুম অ্যাড-অন ওয়াকথ্রু সিরিজের তৃতীয় পর্ব।

এই নির্দেশিকায়, আপনি ব্যবহারকারীর পূর্বে প্রদত্ত ক্রেডেনশিয়াল স্বয়ংক্রিয়ভাবে পুনরুদ্ধার করার মাধ্যমে আমাদের অ্যাড-অনে তাদের বারবার ভিজিট পরিচালনা করবেন। এরপর আপনি ব্যবহারকারীদের এমন পেজে পাঠাবেন যেখান থেকে তারা অবিলম্বে এপিআই (API) অনুরোধ পাঠাতে পারবে। ক্লাসরুম অ্যাড-অনগুলির জন্য এটি একটি আবশ্যক আচরণ।

এই নির্দেশিকাটি অনুসরণ করার সময়, আপনাকে নিম্নলিখিত কাজগুলো সম্পন্ন করতে হবে:

• আমাদের ব্যবহারকারীর পরিচয়পত্রের জন্য স্থায়ী সংরক্ষণ ব্যবস্থা চালু করুন।
• login_hint অ্যাড-অন কোয়েরি প্যারামিটারটি পুনরুদ্ধার ও মূল্যায়ন করুন। এটি হলো সাইন-ইন করা ব্যবহারকারীর একটি অনন্য গুগল আইডি নম্বর।

দ্রষ্টব্য: ব্যবহারকারী আপনার অ্যাপকে অনুমোদন দেওয়ার পরেই কেবল login_hint পাঠানো হয়। কোনো ব্যবহারকারী প্রথমবার আপনার অ্যাড-অন চালু করলে এটি পাঠানো হবে না।

একবার সম্পন্ন হলে, আপনি আপনার ওয়েব অ্যাপে ব্যবহারকারীদের সম্পূর্ণ অনুমোদন দিতে এবং গুগল এপিআই-তে কল করতে পারবেন।

গুরুত্বপূর্ণ: এই ওয়াকথ্রুটি অনুসরণ করার আগে, সিরিজের পূর্ববর্তী ওয়াকথ্রুগুলো সম্পূর্ণ করুন। এই ওয়াকথ্রুটি পূর্ববর্তী ওয়াকথ্রুগুলোতে তৈরি করা ওয়েব অ্যাপটিকে আরও সম্প্রসারিত করে। আপনি ওভারভিউ পৃষ্ঠা থেকে সমস্ত ওয়াকথ্রুর সম্পূর্ণ সোর্স কোড ডাউনলোড করতে পারেন। এই নির্দিষ্ট ওয়াকথ্রুটির কোড /03-query-parameters/ ডিরেক্টরিতে পাওয়া যাবে।

আইফ্রেম কোয়েরি প্যারামিটার বুঝুন

ক্লাসরুম খোলার সময় আপনার অ্যাড-অনের অ্যাটাচমেন্ট সেটআপ ইউআরআই লোড করে। ক্লাসরুম ইউআরআই-এর সাথে বেশ কয়েকটি GET কোয়েরি প্যারামিটার যুক্ত করে; এগুলিতে দরকারি প্রাসঙ্গিক তথ্য থাকে। উদাহরণস্বরূপ, যদি আপনার অ্যাটাচমেন্ট ডিসকভারি ইউআরআই হয় https://example.com/addon , তাহলে ক্লাসরুম আইফ্রেমটি তৈরি করে যার সোর্স ইউআরএল সেট করা হয় https://example.com/addon?courseId=XXX&itemId=YYY&itemType=courseWork&addOnToken=ZZZ , যেখানে XXX , YYY , এবং ZZZ হলো স্ট্রিং আইডি। এই পরিস্থিতিটির বিস্তারিত বিবরণের জন্য আইফ্রেম গাইডটি দেখুন।

ডিসকভারি ইউআরএল-এর জন্য পাঁচটি সম্ভাব্য কোয়েরি প্যারামিটার রয়েছে:

• courseId : বর্তমান ক্লাসরুম কোর্সের আইডি।
• itemId : ব্যবহারকারী যে স্ট্রিম আইটেমটি সম্পাদনা বা তৈরি করছেন, তার আইডি।
• itemType : ব্যবহারকারী যে ধরনের স্ট্রিম আইটেম তৈরি বা সম্পাদনা করছেন, তা হলো courseWork , courseWorkMaterial , বা announcement এর মধ্যে যেকোনো একটি।
• addOnToken : ক্লাসরুমের নির্দিষ্ট কিছু অ্যাড-অন কার্যক্রম অনুমোদন করার জন্য ব্যবহৃত একটি টোকেন।
• login_hint : বর্তমান ব্যবহারকারীর গুগল আইডি।

গুরুত্বপূর্ণ: login_hint শুধুমাত্র তখনই পাঠানো হয় যখন ব্যবহারকারী আপনার অ্যাপ্লিকেশনটিকে আগে থেকেই অনুমোদন দিয়েছেন। যদি তারা এটি প্রথমবারের জন্য চালু করেন, login_hint পাঠানো হবে না।

এই নির্দেশিকাটি login_hint নিয়ে আলোচনা করে। এই কোয়েরি প্যারামিটারটি প্রদান করা হয়েছে কি না, তার উপর ভিত্তি করে ব্যবহারকারীদের পাঠানো হয়; এটি অনুপস্থিত থাকলে অনুমোদন প্রক্রিয়ায় (authorization flow) এবং উপস্থিত থাকলে অ্যাড-অন আবিষ্কার পৃষ্ঠায় (add-on discovery page) পাঠানো হয়।

কোয়েরি প্যারামিটারগুলি অ্যাক্সেস করুন

কোয়েরি প্যারামিটারগুলো URI স্ট্রিং-এর মাধ্যমে আপনার ওয়েব অ্যাপ্লিকেশনে পাঠানো হয়। এই মানগুলো আপনার সেশনে সংরক্ষণ করুন; এগুলো অথরাইজেশন ফ্লো-তে এবং ব্যবহারকারীর তথ্য সংরক্ষণ ও পুনরুদ্ধার করতে ব্যবহৃত হয়। এই কোয়েরি প্যারামিটারগুলো শুধুমাত্র অ্যাড-অনটি প্রথমবার খোলার সময়ই পাঠানো হয়।

পাইথন

আপনার 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()

জাভা

আপনার কন্ট্রোলার ক্লাসে অ্যাড-অন ল্যান্ডিং রুটে যান (প্রদত্ত উদাহরণে AuthController.java তে /addon-discovery )। এই রুটের শুরুতে, login_hint কোয়েরি প্যারামিটারটি গ্রহণ করে সংরক্ষণ করুন।

/** Retrieve the login_hint query parameter from the request URL if present. */
String login_hint = request.getParameter("login_hint");

নিশ্চিত করুন যে login_hint (যদি থাকে) সেশনে সংরক্ষিত আছে। এই মানগুলি সংরক্ষণ করার জন্য এটি একটি উপযুক্ত স্থান; এগুলি ক্ষণস্থায়ী এবং অ্যাড-অনটি খোলার সময় আপনি নতুন মান পাবেন।

/** If login_hint wasn't sent, use the values in the session. */
if (login_hint == null) {
    login_hint = (String) session.getAttribute("login_hint");
}

/** If the there is still no login_hint, route the user to the authorization
 *  page. */
if (login_hint == null) {
    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 প্যারামিটারটি গুগলের অথেনটিকেশন সার্ভারগুলোতেও পাঠানো উচিত। এটি অথেনটিকেশন প্রক্রিয়াকে সহজ করে; যদি আপনার অ্যাপ্লিকেশনটি জানতে পারে কোন ব্যবহারকারী অথেনটিকেশন করার চেষ্টা করছেন, তবে সার্ভারটি সাইন-ইন ফর্মের ইমেল ফিল্ডটি আগে থেকেই পূরণ করে দিয়ে লগইন প্রক্রিয়াকে সহজ করার জন্য হিন্টটি ব্যবহার করে।

পাইথন

আপনার Flask সার্ভার ফাইলে অথরাইজেশন রুটে যান (আমাদের দেওয়া উদাহরণে /authorize )। flow.authorization_url কলে login_hint আর্গুমেন্টটি যোগ করুন।

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"),

জাভা

AuthService.java ক্লাসের authorize() মেথডে যান। মেথডটিতে login_hint একটি প্যারামিটার হিসেবে যোগ করুন এবং authorization URL builder-এ login_hint আর্গুমেন্টটি যুক্ত করুন।

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

ব্যবহারকারীর পরিচয়পত্রের জন্য স্থায়ী স্টোরেজ যোগ করুন

অ্যাড-অনটি লোড হওয়ার সময় যদি আপনি কোয়েরি প্যারামিটার হিসেবে login_hint পান, তবে এটি নির্দেশ করে যে ব্যবহারকারী আমাদের অ্যাপ্লিকেশনের জন্য অনুমোদন প্রক্রিয়াটি ইতিমধ্যেই সম্পন্ন করেছেন। তাদের আবার সাইন ইন করতে বাধ্য করার পরিবর্তে, আপনার উচিত তাদের পূর্ববর্তী ক্রেডেনশিয়ালগুলো সংগ্রহ করা।

মনে রাখবেন যে, অনুমোদন প্রক্রিয়াটি সম্পন্ন হওয়ার পর আপনি একটি রিফ্রেশ টোকেন পেয়েছিলেন। এই টোকেনটি সংরক্ষণ করুন; এটি একটি অ্যাক্সেস টোকেন পাওয়ার জন্য পুনরায় ব্যবহার করা যাবে, যা স্বল্পস্থায়ী এবং গুগল এপিআই (Google APIs) ব্যবহারের জন্য প্রয়োজনীয়। আপনি পূর্বে এই ক্রেডেনশিয়ালগুলো সেশনে সংরক্ষণ করেছিলেন, কিন্তু বারবার পরিদর্শনের জন্য আপনাকে ক্রেডেনশিয়ালগুলো সংরক্ষণ করতে হবে।

গুরুত্বপূর্ণ: আপনি যদি রিফ্রেশ টোকেনটি সংরক্ষণ না করেন, তাহলে অ্যাক্সেস টোকেন পাওয়ার জন্য আপনাকে অবশ্যই ব্যবহারকারীকে আবার অনুমোদন প্রক্রিয়ার মধ্য দিয়ে পাঠাতে হবে। আপনার কাছে রিফ্রেশ টোকেন থাকলে, আপনি গুগলের অথেন্টিকেশন সার্ভার থেকে একটি নতুন অ্যাক্সেস টোকেনের জন্য অনুরোধ করতে পারেন।

ব্যবহারকারী যখন প্রথমবার আপনার অ্যাপ্লিকেশনটিকে অনুমোদন দেন, শুধুমাত্র তখনই রিফ্রেশ টোকেন দেওয়া হয়।

ব্যবহারকারী স্কিমা নির্ধারণ করুন এবং ডাটাবেস সেট আপ করুন।

একজন User জন্য একটি ডাটাবেস স্কিমা তৈরি করুন।

পাইথন

ব্যবহারকারী স্কিমা সংজ্ঞায়িত করুন

একজন User নিম্নলিখিত বৈশিষ্ট্যগুলো থাকে:

• id : ব্যবহারকারীর গুগল আইডি। এটি login_hint কোয়েরি প্যারামিটারে প্রদত্ত মানের সাথে অবশ্যই মিলতে হবে।
• display_name : ব্যবহারকারীর প্রথম এবং শেষ নাম, যেমন "অ্যালেক্স স্মিথ"।
• email : ব্যবহারকারীর ইমেইল ঠিকানা।
• portrait_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-কে আপনার main.py ফাইলের একই ডিরেক্টরিতে থাকা data.sqlite ফাইলটির দিকে নির্দেশ করে।

এরপর, আপনার মডিউল ডিরেক্টরিতে যান এবং একটি নতুন 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()

জাভা

ব্যবহারকারী স্কিমা সংজ্ঞায়িত করুন

একজন User নিম্নলিখিত বৈশিষ্ট্যগুলো থাকে:

• id : ব্যবহারকারীর গুগল আইডি। এটি login_hint কোয়েরি প্যারামিটারে দেওয়া মানের সাথে অবশ্যই মিলতে হবে।
• email : ব্যবহারকারীর ইমেইল ঠিকানা।

দ্রষ্টব্য: এই অ্যাট্রিবিউটগুলো স্ট্রিং টাইপের।

মডিউলের resources ডিরেক্টরিতে একটি schema.sql ফাইল তৈরি করুন। 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
);

ডাটাবেসের জন্য User মডেল সংজ্ঞায়িত করতে একটি জাভা ক্লাস তৈরি করুন। প্রদত্ত উদাহরণে এটি হলো User.java ।

এটি যে একটি POJO এবং ডাটাবেসে সংরক্ষণ করা যাবে, তা বোঝাতে @Entity অ্যানোটেশনটি যোগ করুন। schema.sql এ আপনার কনফিগার করা সংশ্লিষ্ট টেবিলের নামটিসহ @Table অ্যানোটেশনটি যোগ করুন।

লক্ষ্য করুন যে কোড উদাহরণটিতে দুটি অ্যাট্রিবিউটের জন্য কনস্ট্রাক্টর এবং সেটার অন্তর্ভুক্ত রয়েছে। ডেটাবেসে একজন ব্যবহারকারীকে তৈরি বা আপডেট করার জন্য AuthController.java তে এই কনস্ট্রাক্টর এবং সেটারগুলো ব্যবহৃত হয়। আপনি আপনার প্রয়োজন অনুযায়ী গেটার এবং একটি 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; }
}

ডাটাবেসে CRUD অপারেশন পরিচালনা করার জন্য UserRepository.java নামে একটি ইন্টারফেস তৈরি করুন। এই ইন্টারফেসটি 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;
}

ডাটাবেস সেট আপ করুন

ব্যবহারকারী-সম্পর্কিত তথ্য সংরক্ষণ করতে, Spring Boot-এ অন্তর্নিহিতভাবে সমর্থিত একটি H2 ডাটাবেস ব্যবহার করুন। এই ডাটাবেসটি পরবর্তী ওয়াকথ্রুগুলোতে অন্যান্য ক্লাসরুম-সম্পর্কিত তথ্য সংরক্ষণের জন্যও ব্যবহৃত হয়। 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;
}

AuthService.java এর getFlow() মেথডটি আপডেট করে GoogleAuthorizationCodeFlow Builder() মেথডের মধ্যে setDataStoreFactory অন্তর্ভুক্ত করুন এবং ডেটাস্টোর সেট করার জন্য getCredentialDataStore() কল করুন।

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

এরপরে, getAndSaveCredentials(String authorizationCode) মেথডটি আপডেট করুন। পূর্বে, এই মেথডটি ক্রেডেনশিয়ালগুলো কোথাও সংরক্ষণ না করেই সংগ্রহ করত। মেথডটি এমনভাবে আপডেট করুন যাতে এটি ইউজার আইডি দ্বারা ইনডেক্স করা ডেটাস্টোরে ক্রেডেনশিয়ালগুলো সংরক্ষণ করে।

TokenResponse অবজেক্টের id_token ব্যবহার করে ইউজার আইডি পাওয়া যায়, কিন্তু প্রথমে এটি অবশ্যই যাচাই করতে হবে। অন্যথায়, ক্লায়েন্ট অ্যাপ্লিকেশনগুলো সার্ভারে পরিবর্তিত ইউজার আইডি পাঠিয়ে ব্যবহারকারীদের ছদ্মবেশ ধারণ করতে পারে। id_token যাচাই করার জন্য Google API ক্লায়েন্ট লাইব্রেরি ব্যবহার করার পরামর্শ দেওয়া হচ্ছে। আরও তথ্যের জন্য [Google ID টোকেন যাচাই করার বিষয়ে Google Identity পৃষ্ঠা] দেখুন।

// 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 আনার জন্য একটি পদ্ধতি সংজ্ঞায়িত করুন। আপনাকে login_hint কোয়েরি প্যারামিটারে একটি id দেওয়া হয়, যা ব্যবহার করে আপনি একটি নির্দিষ্ট ব্যবহারকারীর রেকর্ড পুনরুদ্ধার করতে পারেন।

পাইথন

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

জাভা

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;
}

স্টোরের পরিচয়পত্র

ক্রেডেনশিয়াল সংরক্ষণের ক্ষেত্রে দুটি পরিস্থিতি রয়েছে। যদি ব্যবহারকারীর id ইতিমধ্যেই ডেটাবেসে থাকে, তাহলে বিদ্যমান রেকর্ডটি নতুন মান দিয়ে আপডেট করুন। অন্যথায়, একটি নতুন User রেকর্ড তৈরি করুন এবং এটি ডেটাবেসে যুক্ত করুন।

দ্রষ্টব্য: এই উদাহরণ কোডটি login_hint সেশন কী-এর উপর নির্ভর করে, যা পূর্ববর্তী ধাপে সংরক্ষণ করা হয়েছিল।

পাইথন

প্রথমে একটি ইউটিলিটি মেথড সংজ্ঞায়িত করুন যা ডেটা সংরক্ষণ বা আপডেট করার আচরণটি বাস্তবায়ন করে।

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()

দুটি ক্ষেত্রে আপনি আপনার ডাটাবেসে ক্রেডেনশিয়াল সংরক্ষণ করতে পারেন: যখন ব্যবহারকারী অনুমোদন প্রক্রিয়ার শেষে আপনার অ্যাপ্লিকেশনে ফিরে আসেন এবং যখন কোনো এপিআই (API) কল করা হয়। এই ক্ষেত্রগুলিতেই আমরা পূর্বে সেশন credentials কী (key) সেট করেছিলাম।

আপনার callback রুটের শেষে save_user_credentials কল করুন। শুধু ব্যবহারকারীর নাম বের না করে 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)

জাভা

প্রথমে এমন একটি মেথড নির্ধারণ করুন যা H2 ডেটাবেসে একটি User অবজেক্ট সংরক্ষণ বা আপডেট করে।

/** 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);
    }
}

দুটি ক্ষেত্রে আপনি আপনার ডাটাবেসে ক্রেডেনশিয়াল সংরক্ষণ করতে পারেন: যখন ব্যবহারকারী অনুমোদন প্রক্রিয়ার শেষে আপনার অ্যাপ্লিকেশনে ফিরে আসেন এবং যখন কোনো এপিআই (API) কল করা হয়। এই ক্ষেত্রগুলিতেই আমরা পূর্বে সেশন credentials কী (key) সেট করেছিলাম।

/callback রুটের শেষে saveUser কল করুন। শুধু ব্যবহারকারীর ইমেইল বের না করে 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);

মেয়াদোত্তীর্ণ পরিচয়পত্র

মনে রাখবেন, কয়েকটি কারণে রিফ্রেশ টোকেন অবৈধ হয়ে যেতে পারে। এর মধ্যে রয়েছে:

• রিফ্রেশ টোকেনটি ছয় মাস ধরে ব্যবহার করা হয়নি।
• ব্যবহারকারী আপনার অ্যাপের অ্যাক্সেস অনুমতি প্রত্যাহার করে নেন।
• ব্যবহারকারী পাসওয়ার্ড পরিবর্তন করেন।
• ব্যবহারকারী এমন একটি গুগল ক্লাউড সংস্থার অন্তর্ভুক্ত যেখানে সেশন নিয়ন্ত্রণ নীতি কার্যকর রয়েছে।

যদি ব্যবহারকারীর পরিচয়পত্র অবৈধ হয়ে যায়, তবে তাকে পুনরায় অনুমোদন প্রক্রিয়ার মধ্য দিয়ে পাঠিয়ে নতুন টোকেন সংগ্রহ করুন।

ব্যবহারকারীকে স্বয়ংক্রিয়ভাবে রুট করুন

ব্যবহারকারী পূর্বে আমাদের অ্যাপ্লিকেশনটিকে অনুমোদন দিয়েছেন কিনা তা শনাক্ত করতে অ্যাড-অন ল্যান্ডিং রুটটি পরিবর্তন করুন। যদি দিয়ে থাকেন, তবে তাদেরকে আমাদের মূল অ্যাড-অন পৃষ্ঠায় পাঠিয়ে দিন। অন্যথায়, তাদেরকে সাইন ইন করতে বলুন।

পাইথন

অ্যাপ্লিকেশনটি চালু হওয়ার সময় ডাটাবেস ফাইলটি তৈরি হয়েছে কিনা তা নিশ্চিত করুন। নিম্নলিখিত কোডটি একটি মডিউল ইনিশিয়ালাইজারে (যেমন আমাদের দেওয়া উদাহরণে 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.")

জাভা

আপনার অ্যাড-অন ল্যান্ডিং রুটে যান (প্রদত্ত উদাহরণে /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";

অ্যাড-অনটি পরীক্ষা করুন

গুরুত্বপূর্ণ: যদিও আপনি সরাসরি একটি ওয়েব ব্রাউজার ব্যবহার করে আপনার অ্যাপ্লিকেশনটি পরীক্ষা করতে পারেন, তবে প্রাথমিকভাবে এটি ক্লাসরুম অ্যাড-অন আইফ্রেমে পরীক্ষা করা উচিত। একটি আইফ্রেমে আপনার ওয়েব অ্যাপ লোড করলে কিছু অস্বাভাবিক আচরণ দেখা দিতে পারে। প্রতিটি আইফ্রেমের বিবরণের জন্য আমাদের আইফ্রেম এবং কোয়েরি প্যারামিটার গাইড পৃষ্ঠাটি পড়ুন। এই ওয়াকথ্রুতে প্রদত্ত সমস্ত নির্দেশাবলী এই অনুমানের উপর ভিত্তি করে দেওয়া হয়েছে যে অ্যাড-অনটি একটি আইফ্রেমের প্রেক্ষাপটে ব্যবহারযোগ্য।

আপনার টিচার টেস্ট ইউজারদের একজন হিসেবে গুগল ক্লাসরুমে সাইন ইন করুন। ক্লাসওয়ার্ক ট্যাবে যান এবং একটি নতুন অ্যাসাইনমেন্ট তৈরি করুন। টেক্সট এরিয়ার নিচে থাকা অ্যাড-অনস বাটনে ক্লিক করুন, তারপর আপনার অ্যাড-অনটি বেছে নিন। আইফ্রেমটি খুলবে এবং অ্যাড-অনটি সেই অ্যাটাচমেন্ট সেটআপ ইউআরআই লোড করবে যা আপনি গুগল ওয়ার্কস্পেস মার্কেটপ্লেস এসডিকে-এর অ্যাপ কনফিগারেশন পেজে নির্দিষ্ট করেছিলেন।

অভিনন্দন! আপনি এখন পরবর্তী ধাপে যাওয়ার জন্য প্রস্তুত: সংযুক্তি তৈরি করা এবং ব্যবহারকারীর ভূমিকা শনাক্ত করা ।