ক্লাসরুম অ্যাড-অন ওয়াকথ্রু সিরিজে এটি তৃতীয় ওয়াকথ্রু।
এই ওয়াকথ্রুতে, আপনি একজন ব্যবহারকারীর পূর্বে প্রদত্ত শংসাপত্রগুলি স্বয়ংক্রিয়ভাবে পুনরুদ্ধার করে আমাদের অ্যাড-অনে বারবার ভিজিট পরিচালনা করেন। তারপরে আপনি ব্যবহারকারীদের সেই পৃষ্ঠাগুলিতে রুট করুন যেখান থেকে তারা অবিলম্বে API অনুরোধগুলি ইস্যু করতে পারে। ক্লাসরুম অ্যাড-অনগুলির জন্য এটি একটি প্রয়োজনীয় আচরণ।
এই ওয়াকথ্রু চলাকালীন, আপনি নিম্নলিখিতগুলি সম্পূর্ণ করবেন:
- আমাদের ব্যবহারকারীর শংসাপত্রের জন্য অবিরাম সঞ্চয়স্থান প্রয়োগ করুন।
-
login_hint
অ্যাড-অন ক্যোয়ারী প্যারামিটার পুনরুদ্ধার এবং মূল্যায়ন করুন। এটি সাইন ইন করা ব্যবহারকারীর একটি অনন্য Google ID নম্বর৷
একবার শেষ হয়ে গেলে, আপনি আপনার ওয়েব অ্যাপে ব্যবহারকারীদের সম্পূর্ণরূপে অনুমোদন করতে পারেন এবং Google API-এ কল ইস্যু করতে পারেন।
iframe ক্যোয়ারী প্যারামিটার বুঝুন
ক্লাসরুম খোলার পরে আপনার অ্যাড-অনের সংযুক্তি সেটআপ ইউআরআই লোড করে। শ্রেণীকক্ষ URI-তে কয়েকটি GET
ক্যোয়ারী প্যারামিটার যুক্ত করে; এই দরকারী প্রাসঙ্গিক তথ্য আছে. উদাহরণস্বরূপ, যদি আপনার সংযুক্তি আবিষ্কার URI হয় https://example.com/addon
, ক্লাসরুমটি https://example.com/addon?courseId=XXX&itemId=YYY&itemType=courseWork&addOnToken=ZZZ
এ সেট করা উৎস URL দিয়ে আইফ্রেম তৈরি করে যেখানে XXX
, YYY
, এবং ZZZ
হল স্ট্রিং আইডি৷ এই দৃশ্যের বিস্তারিত বিবরণের জন্য iframes গাইড দেখুন।
আবিষ্কার URL-এর জন্য পাঁচটি সম্ভাব্য ক্যোয়ারী প্যারামিটার রয়েছে:
-
courseId
: বর্তমান ক্লাসরুম কোর্সের আইডি। -
itemId
: ব্যবহারকারী যে স্ট্রিম আইটেমটি সম্পাদনা করছেন বা তৈরি করছেন তার আইডি৷ -
itemType
: ব্যবহারকারী যে ধরনের স্ট্রিম আইটেম তৈরি বা সম্পাদনা করছেন,courseWork
,courseWorkMaterial
বাannouncement
। -
addOnToken
: একটি টোকেন নির্দিষ্ট ক্লাসরুম অ্যাড-অন অ্যাকশন অনুমোদন করতে ব্যবহৃত হয়। -
login_hint
: বর্তমান ব্যবহারকারীর Google ID।
এই ওয়াকথ্রু ঠিকানা login_hint
. ব্যবহারকারীদের এই ক্যোয়ারী প্যারামিটার প্রদান করা হয়েছে কিনা, অনুপস্থিত থাকলে অনুমোদনের প্রবাহে অথবা উপস্থিত থাকলে অ্যাড-অন আবিষ্কারের পৃষ্ঠার উপর ভিত্তি করে রাউট করা হয়।
ক্যোয়ারী প্যারামিটার অ্যাক্সেস করুন
ক্যোয়ারী প্যারামিটারগুলি URI স্ট্রিং-এ আপনার ওয়েব অ্যাপ্লিকেশনে পাঠানো হয়। আপনার সেশনে এই মানগুলি সংরক্ষণ করুন; এগুলি অনুমোদনের প্রবাহে এবং ব্যবহারকারী সম্পর্কে তথ্য সংরক্ষণ ও পুনরুদ্ধার করতে ব্যবহৃত হয়। এই ক্যোয়ারী প্যারামিটারগুলি শুধুমাত্র তখনই পাস হয় যখন অ্যাড-অনটি প্রথম খোলা হয়।
পাইথন
আপনার ফ্লাস্ক রুটের সংজ্ঞা নেভিগেট করুন ( যদি আপনি আমাদের প্রদত্ত উদাহরণ অনুসরণ করেন তাহলে 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
প্যারামিটারটি Google এর প্রমাণীকরণ সার্ভারগুলিতেও পাস করা উচিত। এটি প্রমাণীকরণ প্রক্রিয়া সহজতর করে; আপনার অ্যাপ্লিকেশন যদি জানে কোন ব্যবহারকারী প্রমাণীকরণের চেষ্টা করছে, সার্ভার সাইন-ইন ফর্মে ইমেল ক্ষেত্রটি প্রিফিলিং করে লগইন প্রবাহকে সহজ করার জন্য ইঙ্গিতটি ব্যবহার করে।
পাইথন
আপনার ফ্লাস্ক সার্ভার ফাইলে অনুমোদন রুটে নেভিগেট করুন ( /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
যোগ করুন এবং অনুমোদন URL বিল্ডারে login_hint
এবং যুক্তি যোগ করুন।
String authUrl = flow
.newAuthorizationUrl()
.setState(state)
.set("login_hint", login_hint)
.setRedirectUri(REDIRECT_URI)
.build();
ব্যবহারকারীর শংসাপত্রের জন্য স্থায়ী সঞ্চয়স্থান যোগ করুন
অ্যাড-অন লোড হওয়ার সময় আপনি যদি একটি ক্যোয়ারী প্যারামিটার হিসাবে login_hint
পান তবে এটি একটি ইঙ্গিত দেয় যে ব্যবহারকারী ইতিমধ্যেই আমাদের অ্যাপ্লিকেশনের জন্য অনুমোদনের প্রবাহ সম্পূর্ণ করেছেন৷ তাদের আবার সাইন ইন করতে বাধ্য করার পরিবর্তে আপনার তাদের আগের শংসাপত্রগুলি পুনরুদ্ধার করা উচিত৷
প্রত্যাহার করুন যে অনুমোদনের প্রবাহ শেষ হওয়ার পরে আপনি একটি রিফ্রেশ টোকেন পেয়েছেন। এই টোকেন সংরক্ষণ করুন; এটি একটি অ্যাক্সেস টোকেন পাওয়ার জন্য পুনরায় ব্যবহার করা হবে, যা স্বল্পস্থায়ী এবং Google API ব্যবহার করার জন্য প্রয়োজনীয়। আপনি আগে সেশনে এই শংসাপত্রগুলি সংরক্ষণ করেছিলেন, তবে পুনরাবৃত্তি ভিজিট পরিচালনা করতে আপনাকে শংসাপত্রগুলি সংরক্ষণ করতে হবে৷
ব্যবহারকারী স্কিমা সংজ্ঞায়িত করুন এবং ডাটাবেস সেট আপ করুন
একটি User
জন্য একটি ডাটাবেস স্কিমা সেট আপ করুন।
পাইথন
ব্যবহারকারীর স্কিমা সংজ্ঞায়িত করুন
একজন User
নিম্নলিখিত বৈশিষ্ট্য ধারণ করে:
-
id
: ব্যবহারকারীর গুগল আইডি। এটিlogin_hint
ক্যোয়ারী প্যারামিটারে প্রদত্ত মানগুলির সাথে মেলে। -
display_name
: ব্যবহারকারীর প্রথম এবং শেষ নাম, যেমন "Alex Smith"। -
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
এটি ফ্লাস্ককে আপনার 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
ফাইল তৈরি করুন। স্প্রিং এই ফাইলটি পড়ে এবং সেই অনুযায়ী ডাটাবেসের জন্য একটি স্কিমা তৈরি করে। User
গুণাবলী, id
এবং email
প্রতিনিধিত্ব করতে একটি টেবিলের নাম, users
এবং কলাম দিয়ে টেবিলটিকে সংজ্ঞায়িত করুন।
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;
}
ডাটাবেস সেট আপ করুন
ব্যবহারকারী-সম্পর্কিত তথ্য সংরক্ষণ করতে, একটি 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
। .gitignore
এ H2 ডাটাবেসের পাথ যোগ করুন। আপনার পছন্দের ব্যবহারকারীর নাম এবং পাসওয়ার্ড দিয়ে ডাটাবেস সেট করতে অ্যাপ্লিকেশন চালানোর আগে আপনাকে অবশ্যই spring.datasource.username
এবং spring.datasource.password
আপডেট করতে হবে। অ্যাপ্লিকেশন চালানোর পরে ডাটাবেসের জন্য ব্যবহারকারীর নাম এবং পাসওয়ার্ড আপডেট করতে, তৈরি করা h2
ডিরেক্টরি মুছুন, কনফিগারেশন আপডেট করুন এবং অ্যাপ্লিকেশনটি পুনরায় চালান।
update
জন্য spring.jpa.hibernate.ddl-auto
কনফিগারেশন সেট করা নিশ্চিত করে যে অ্যাপ্লিকেশনটি পুনরায় চালু হলে ডাটাবেসে সংরক্ষিত ডেটা সংরক্ষণ করা হয়। প্রতিবার অ্যাপ্লিকেশনটি পুনরায় চালু করার সময় ডাটাবেসটি সাফ করতে, এই কনফিগারেশনটি 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;
}
GoogleAuthorizationCodeFlow Builder()
পদ্ধতিতে setDataStoreFactory
অন্তর্ভুক্ত করতে AuthService.java
তে getFlow()
পদ্ধতি আপডেট করুন এবং datastore সেট করতে getCredentialDataStore()
এ কল করুন।
GoogleAuthorizationCodeFlow authorizationCodeFlow =
new GoogleAuthorizationCodeFlow.Builder(
HTTP_TRANSPORT,
JSON_FACTORY,
getClientSecrets(),
getScopes())
.setAccessType("offline")
.setDataStoreFactory(getCredentialDataStore())
.build();
এরপর, getAndSaveCredentials(String authorizationCode)
পদ্ধতি আপডেট করুন। পূর্বে, এই পদ্ধতিটি কোথাও সংরক্ষণ না করেই শংসাপত্র প্রাপ্ত করত। ব্যবহারকারী আইডি দ্বারা সূচীকৃত ডেটাস্টোরে শংসাপত্রগুলি সংরক্ষণ করার পদ্ধতিটি আপডেট করুন।
id_token
ব্যবহার করে TokenResponse
অবজেক্ট থেকে ব্যবহারকারীর আইডি পাওয়া যেতে পারে, তবে প্রথমে এটি যাচাই করতে হবে । অন্যথায়, ক্লায়েন্ট অ্যাপ্লিকেশনগুলি সার্ভারে সংশোধিত ব্যবহারকারী আইডি পাঠিয়ে ব্যবহারকারীদের ছদ্মবেশী করতে সক্ষম হতে পারে। এটি সুপারিশ করা হয় যে আপনি id_token
যাচাই করতে Google API ক্লায়েন্ট লাইব্রেরি ব্যবহার করুন। আরও তথ্যের জন্য [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();
userId
অন্তর্ভুক্ত করতে flow.createAndStoreCredential
এ কল আপডেট করুন।
// 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
রেকর্ড তৈরি করুন এবং এটি ডাটাবেসে যোগ করুন।
পাইথন
প্রথমে একটি ইউটিলিটি পদ্ধতি সংজ্ঞায়িত করুন যা স্টোরেজ বা আপডেট আচরণ প্রয়োগ করে।
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
কী সেট করেছিলাম।
আপনার 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
কী সেট করেছিলাম।
/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);
মেয়াদোত্তীর্ণ শংসাপত্র
নোট করুন যে কয়েকটি কারণ রয়েছে যেগুলি রিফ্রেশ টোকেনগুলি অবৈধ হয়ে যেতে পারে৷ এর মধ্যে রয়েছে:
- রিফ্রেশ টোকেনটি ছয় মাস ধরে ব্যবহার করা হয়নি।
- ব্যবহারকারী আপনার অ্যাপের অ্যাক্সেস অনুমতি প্রত্যাহার করে।
- ব্যবহারকারী পাসওয়ার্ড পরিবর্তন করে।
- ব্যবহারকারী একটি Google ক্লাউড সংস্থার অন্তর্গত যার সেশন নিয়ন্ত্রণ নীতি কার্যকর রয়েছে৷
ব্যবহারকারীর শংসাপত্রগুলি অবৈধ হয়ে গেলে আবার অনুমোদন প্রবাহের মাধ্যমে পাঠিয়ে নতুন টোকেনগুলি অর্জন করুন৷
স্বয়ংক্রিয়ভাবে ব্যবহারকারীকে রুট করুন
ব্যবহারকারী পূর্বে আমাদের আবেদন অনুমোদন করেছে কিনা তা সনাক্ত করতে অ্যাড-অন ল্যান্ডিং রুট পরিবর্তন করুন। যদি তাই হয়, আমাদের প্রধান অ্যাড-অন পৃষ্ঠায় তাদের রুট করুন। অন্যথায়, তাদের সাইন ইন করতে অনুরোধ করুন।
পাইথন
অ্যাপ্লিকেশন চালু হলে ডাটাবেস ফাইল তৈরি করা হয়েছে তা নিশ্চিত করুন। একটি মডিউল ইনিশিয়ালাইজারে নিম্নলিখিতটি সন্নিবেশ করান (যেমন 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";
অ্যাড-অন পরীক্ষা করুন
আপনার শিক্ষক পরীক্ষার ব্যবহারকারীদের একজন হিসাবে Google ক্লাসরুমে সাইন ইন করুন৷ ক্লাসওয়ার্ক ট্যাবে নেভিগেট করুন এবং একটি নতুন অ্যাসাইনমেন্ট তৈরি করুন। পাঠ্য এলাকার নীচে অ্যাড-অন বোতামে ক্লিক করুন, তারপর আপনার অ্যাড-অন নির্বাচন করুন। iframe খোলে এবং অ্যাড-অন অ্যাটাচমেন্ট সেটআপ URI লোড করে যা আপনি Google Workspace Marketplace SDK-এর অ্যাপ কনফিগারেশন পৃষ্ঠায় উল্লেখ করেছেন।
অভিনন্দন! আপনি পরবর্তী ধাপে এগিয়ে যাওয়ার জন্য প্রস্তুত: সংযুক্তি তৈরি করা এবং ব্যবহারকারীর ভূমিকা চিহ্নিত করা ।