User setting (#12)

* refactor: use SQLAlchemy Mapped and mapped_column for type hints

The SQLAlchemy models now use `Mapped` and `mapped_column` for
defining columns, which provides better type hinting and improves
code readability.

* fix: welcome message quickreply error

* feat: add roles, accpted_terms, and language fields to User model

* feat(user_repository.py): add methods to update user attributes

* feat: user data updates on postback events

The typo in the `update__accpted_terms` method name in
`user_repository.py` has been corrected to `update_accpted_terms`.
The `handle_postback_event` function in `postback.py` now updates
user data (accepted terms, language, role) in the database based
on the postback data reeived. The `WelcomeService` now validates
the reply token to prevent errors when the token is missing.

* docs: add log to user setting

* feat: handle unknown postback event

* feat: handle unhandled postback events

* feat: add clear_conversation_id and reset_user postback handlers

Author: yenslife

linebot/app/models/user.py

@@ -1,5 +1,6 @@
 # use sqlite
-from sqlalchemy import Column, Integer, String
+from sqlalchemy import String
+from sqlalchemy.orm import Mapped, mapped_column
 from app.db.database import Base
 from dataclasses import dataclass
 from typing import Optional
@@ -8,8 +9,11 @@
 class User(Base):
     __tablename__ = "users"
 
-    line_id = Column(String, primary_key=True, index=True)
-    conversation_id = Column(String, nullable=True)
+    line_id: Mapped[str] = mapped_column(String, primary_key=True, index=True)
+    conversation_id: Mapped[Optional[str]] = mapped_column(String, nullable=True)
+    roles: Mapped[str] = mapped_column(String, default="role_student")
+    accpted_terms: Mapped[bool] = mapped_column(default=False)
+    language: Mapped[str] = mapped_column(String, default="zh-TW")
 
     def __repr__(self):
         return f"<User line_id={self.line_id}>"

linebot/app/repositories/user_repository.py

@@ -1,4 +1,3 @@
-from sqlalchemy.orm import Session
 from ..models.user import User
 from ..db.database import SessionLocal
 
@@ -23,6 +22,24 @@ def update_conversation_id(self, line_id: str, conversation_id: str) -> None:
         user.conversation_id = conversation_id
         self.db.commit()
 
+    def update_accpted_terms(self, line_id: str, accepted: bool) -> None:
+        """更新用戶是否接受服務條款"""
+        user = self.get_user(line_id)
+        user.accpted_terms = accepted
+        self.db.commit()
+
+    def update_language(self, line_id: str, language: str) -> None:
+        """更新用戶的語言設定"""
+        user = self.get_user(line_id)
+        user.language = language
+        self.db.commit()
+
+    def update_roles(self, line_id: str, roles: str) -> None:
+        """更新用戶的角色"""
+        user = self.get_user(line_id)
+        user.roles = roles
+        self.db.commit()
+
     def __del__(self):
         """確保資料庫連接被正確關閉"""
         self.db.close()

linebot/app/routers/linebot.py

@@ -60,6 +60,9 @@ def handle_follow_event(event):
 def handle_postback_event(event):
     logger.info("收到按鈕事件")
     reply_messages = postback_service.handle_postback_event(event)
+    if not reply_messages:
+        logger.warning("未知的 postback event，可能是換 rich menu 頁面")
+        return
     postback_service.send_message(event.reply_token, reply_messages)
 
 

linebot/app/services/handlers/postback.py

@@ -6,9 +6,12 @@
     MessageAction,
 )
 from ...config.logger import get_logger
+from ...config.line_config import line_bot_api
 from ..utils import flex_message_convert_to_json
+from ...repositories.user_repository import UserRepository
 
 logger = get_logger(__name__)
+user_repository = UserRepository()
 
 WELCOME_MESSAGE_AFTER_SETTING = """👋 嗨！歡迎使用「成大 Linebot」🌳✨
 無論是校園資訊、活動查詢、選課資訊還是校內生活大小事，我都可以為你服務！
@@ -33,7 +36,11 @@ def create_quickreply():
 
 def handle_postback_event(event):
     data = event.postback.data
+    user_id = event.source.user_id
+    user_profile = line_bot_api.get_profile(user_id)
+    user_display_name = user_profile.display_name
     if data == "read_terms":
+        logger.info(f"User {user_id} requested to read terms.")
         return [
             TextSendMessage(text=f"{TERMS_MESSAGE}"),
             FlexSendMessage(
@@ -44,6 +51,8 @@ def handle_postback_event(event):
             ),
         ]
     elif data == "accept_terms":
+        logger.info(f"User {user_id} accepted terms.")
+        user_repository.update_accpted_terms(user_id, True)
         return [
             TextSendMessage(text="感謝您的回覆，接下來我們來設定您的個人資料吧！"),
             FlexSendMessage(
@@ -54,8 +63,11 @@ def handle_postback_event(event):
             ),
         ]
     elif data == "reject_terms":
+        logger.info(f"User {user_id} rejected terms.")
+        user_repository.update_accpted_terms(user_id, False)
         return [TextSendMessage(text="感謝您的回覆，如果有需要隨時可以點擊同意歐")]
     elif data == "zh-TW":
+        user_repository.update_language(user_id, "zh-TW")
         return [
             TextSendMessage(text="感謝您的回覆，接下來我們來設定您的個人資料吧！"),
             FlexSendMessage(
@@ -66,6 +78,8 @@ def handle_postback_event(event):
             ),
         ]
     elif data == "en":
+        logger.info(f"User {user_id} selected English language.")
+        user_repository.update_language(user_id, "en")
         return [
             TextSendMessage(
                 text="Thank you for your reply, let's set up your profile next!"
@@ -78,27 +92,55 @@ def handle_postback_event(event):
             ),
         ]
     elif data == "role_faculty":
-        welcome_test_message = "hahahaha"
+        logger.info(f"User {user_id} selected faculty role.")
+        user_repository.update_roles(user_id, "faculty")
         return [
             TextSendMessage(text="您已經設定為教職員身份，鵝子歡迎您！"),
             TextSendMessage(
                 text=WELCOME_MESSAGE_AFTER_SETTING, quick_reply=create_quickreply()
             ),
         ]
     elif data == "role_student":
+        logger.info(f"User {user_id} selected student role.")
+        user_repository.update_roles(user_id, "student")
         return [
             TextSendMessage(text="您已經設定為學生身份，鵝子歡迎您！"),
             TextSendMessage(
                 text=WELCOME_MESSAGE_AFTER_SETTING, quick_reply=create_quickreply()
             ),
-            create_quickreply(),
         ]
     elif data == "role_visitor":
+        logger.info(f"User {user_id} selected visitor role.")
+        user_repository.update_roles(user_id, "visitor")
         return [
             TextSendMessage(text="您已經設定為校外人士身份"),
             TextSendMessage(
                 text=WELCOME_MESSAGE_AFTER_SETTING, quick_reply=create_quickreply()
             ),
         ]
+    elif data == "clear_conversation_id":
+        logger.info(f"User {user_id} requested to clear conversation ID.")
+        return_value = user_repository.update_conversation_id(user_id, "")
+        logger.info(f"Conversation ID cleared for user {user_id}: {return_value}")
+        return [
+            TextSendMessage(
+                text=f"逼..嗶茲..！＠清除對話紀錄成功，雖然我忘了這段時間和{user_display_name}的點點滴滴，不過我還是期待和你重新開始吧！"
+            )
+        ]
+    elif data == "reset_user":
+        logger.info(f"User {user_id} requested to reset user data.")
+        user_repository.update_conversation_id(user_id, "")
+        user_repository.update_accpted_terms(user_id, False)
+        user_repository.update_language(user_id, "zh-TW")
+        user_repository.update_roles(user_id, "visitor")
+        return [
+            TextSendMessage(text=f"已清空{user_display_name}的資料，請開始設定吧"),
+            FlexSendMessage(
+                alt_text="請閱讀服務條款",
+                contents=flex_message_convert_to_json(
+                    "flex_messages/welcome/terms.json"
+                ),
+            ),
+        ]
     else:
-        return [TextSendMessage(text="請選擇一個選項")]
+        logger.warning(f"Unknown postback data: {data} from user {user_id}")

linebot/app/services/postback_service.py

@@ -15,8 +15,12 @@ class PostbackService:
 
     def handle_postback_event(self, event):
         """處理按鈕事件"""
+        result = handle_postback_event(event)
+        if not result:
+            logger.warning(f"未處理的按鈕事件: {event.postback.data}")
+            return None
         show_loading_animation(event.source.user_id)
-        return handle_postback_event(event)
+        return result
 
     def send_message(self, reply_token, messages):
         """發送訊息到 LINE"""

linebot/app/services/welcome_service.py

@@ -31,6 +31,11 @@ def send_welcome_message(self, event: FollowEvent):
         if event.type != "follow":
             self.logger.info(f"Not a follow event: {event}")
             return
+        reply_token = event.reply_token
+
+        if not reply_token:
+            self.logger.warning("No reply token found in the event.")
+            return
 
         user_id = event.source.user_id
         user_profile = self.line_bot_api.get_profile(user_id)
@@ -42,7 +47,7 @@ def send_welcome_message(self, event: FollowEvent):
         self.logger.info(f"Sending welcome message to user: {user_id}")
         flex_message_json = flex_message_convert_to_json("flex_messages/welcome/1.json")
         send_message(
-            event.reply_token,
+            reply_token,
             [
                 TextSendMessage(
                     text=WELCOME_MESSAGE_1.format(user_display_name=user_display_name)