users.py 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. import logging
  2. from typing import Optional
  3. from open_webui.apps.webui.models.auths import Auths
  4. from open_webui.apps.webui.models.chats import Chats
  5. from open_webui.apps.webui.models.users import (
  6. UserModel,
  7. UserRoleUpdateForm,
  8. Users,
  9. UserSettings,
  10. UserUpdateForm,
  11. )
  12. from open_webui.constants import ERROR_MESSAGES
  13. from open_webui.env import SRC_LOG_LEVELS
  14. from fastapi import APIRouter, Depends, HTTPException, Request, status
  15. from pydantic import BaseModel
  16. from open_webui.utils.utils import get_admin_user, get_password_hash, get_verified_user
  17. log = logging.getLogger(__name__)
  18. log.setLevel(SRC_LOG_LEVELS["MODELS"])
  19. router = APIRouter()
  20. ############################
  21. # GetUsers
  22. ############################
  23. @router.get("/", response_model=list[UserModel])
  24. async def get_users(skip: int = 0, limit: int = 50, user=Depends(get_admin_user)):
  25. return Users.get_users(skip, limit)
  26. ############################
  27. # User Permissions
  28. ############################
  29. @router.get("/permissions/user")
  30. async def get_user_permissions(request: Request, user=Depends(get_admin_user)):
  31. return request.app.state.config.USER_PERMISSIONS
  32. @router.post("/permissions/user")
  33. async def update_user_permissions(
  34. request: Request, form_data: dict, user=Depends(get_admin_user)
  35. ):
  36. request.app.state.config.USER_PERMISSIONS = form_data
  37. return request.app.state.config.USER_PERMISSIONS
  38. ############################
  39. # UpdateUserRole
  40. ############################
  41. @router.post("/update/role", response_model=Optional[UserModel])
  42. async def update_user_role(form_data: UserRoleUpdateForm, user=Depends(get_admin_user)):
  43. if user.id != form_data.id and form_data.id != Users.get_first_user().id:
  44. return Users.update_user_role_by_id(form_data.id, form_data.role)
  45. raise HTTPException(
  46. status_code=status.HTTP_403_FORBIDDEN,
  47. detail=ERROR_MESSAGES.ACTION_PROHIBITED,
  48. )
  49. ############################
  50. # GetUserSettingsBySessionUser
  51. ############################
  52. @router.get("/user/settings", response_model=Optional[UserSettings])
  53. async def get_user_settings_by_session_user(user=Depends(get_verified_user)):
  54. user = Users.get_user_by_id(user.id)
  55. if user:
  56. return user.settings
  57. else:
  58. raise HTTPException(
  59. status_code=status.HTTP_400_BAD_REQUEST,
  60. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  61. )
  62. ############################
  63. # UpdateUserSettingsBySessionUser
  64. ############################
  65. @router.post("/user/settings/update", response_model=UserSettings)
  66. async def update_user_settings_by_session_user(
  67. form_data: UserSettings, user=Depends(get_verified_user)
  68. ):
  69. user = Users.update_user_by_id(user.id, {"settings": form_data.model_dump()})
  70. if user:
  71. return user.settings
  72. else:
  73. raise HTTPException(
  74. status_code=status.HTTP_400_BAD_REQUEST,
  75. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  76. )
  77. ############################
  78. # GetUserInfoBySessionUser
  79. ############################
  80. @router.get("/user/info", response_model=Optional[dict])
  81. async def get_user_info_by_session_user(user=Depends(get_verified_user)):
  82. user = Users.get_user_by_id(user.id)
  83. if user:
  84. return user.info
  85. else:
  86. raise HTTPException(
  87. status_code=status.HTTP_400_BAD_REQUEST,
  88. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  89. )
  90. ############################
  91. # UpdateUserInfoBySessionUser
  92. ############################
  93. @router.post("/user/info/update", response_model=Optional[dict])
  94. async def update_user_info_by_session_user(
  95. form_data: dict, user=Depends(get_verified_user)
  96. ):
  97. user = Users.get_user_by_id(user.id)
  98. if user:
  99. if user.info is None:
  100. user.info = {}
  101. user = Users.update_user_by_id(user.id, {"info": {**user.info, **form_data}})
  102. if user:
  103. return user.info
  104. else:
  105. raise HTTPException(
  106. status_code=status.HTTP_400_BAD_REQUEST,
  107. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  108. )
  109. else:
  110. raise HTTPException(
  111. status_code=status.HTTP_400_BAD_REQUEST,
  112. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  113. )
  114. ############################
  115. # GetUserById
  116. ############################
  117. class UserResponse(BaseModel):
  118. name: str
  119. profile_image_url: str
  120. @router.get("/{user_id}", response_model=UserResponse)
  121. async def get_user_by_id(user_id: str, user=Depends(get_verified_user)):
  122. # Check if user_id is a shared chat
  123. # If it is, get the user_id from the chat
  124. if user_id.startswith("shared-"):
  125. chat_id = user_id.replace("shared-", "")
  126. chat = Chats.get_chat_by_id(chat_id)
  127. if chat:
  128. user_id = chat.user_id
  129. else:
  130. raise HTTPException(
  131. status_code=status.HTTP_400_BAD_REQUEST,
  132. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  133. )
  134. user = Users.get_user_by_id(user_id)
  135. if user:
  136. return UserResponse(name=user.name, profile_image_url=user.profile_image_url)
  137. else:
  138. raise HTTPException(
  139. status_code=status.HTTP_400_BAD_REQUEST,
  140. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  141. )
  142. ############################
  143. # UpdateUserById
  144. ############################
  145. @router.post("/{user_id}/update", response_model=Optional[UserModel])
  146. async def update_user_by_id(
  147. user_id: str,
  148. form_data: UserUpdateForm,
  149. session_user=Depends(get_admin_user),
  150. ):
  151. user = Users.get_user_by_id(user_id)
  152. if user:
  153. if form_data.email.lower() != user.email:
  154. email_user = Users.get_user_by_email(form_data.email.lower())
  155. if email_user:
  156. raise HTTPException(
  157. status_code=status.HTTP_400_BAD_REQUEST,
  158. detail=ERROR_MESSAGES.EMAIL_TAKEN,
  159. )
  160. if form_data.password:
  161. hashed = get_password_hash(form_data.password)
  162. log.debug(f"hashed: {hashed}")
  163. Auths.update_user_password_by_id(user_id, hashed)
  164. Auths.update_email_by_id(user_id, form_data.email.lower())
  165. updated_user = Users.update_user_by_id(
  166. user_id,
  167. {
  168. "name": form_data.name,
  169. "email": form_data.email.lower(),
  170. "profile_image_url": form_data.profile_image_url,
  171. },
  172. )
  173. if updated_user:
  174. return updated_user
  175. raise HTTPException(
  176. status_code=status.HTTP_400_BAD_REQUEST,
  177. detail=ERROR_MESSAGES.DEFAULT(),
  178. )
  179. raise HTTPException(
  180. status_code=status.HTTP_400_BAD_REQUEST,
  181. detail=ERROR_MESSAGES.USER_NOT_FOUND,
  182. )
  183. ############################
  184. # DeleteUserById
  185. ############################
  186. @router.delete("/{user_id}", response_model=bool)
  187. async def delete_user_by_id(user_id: str, user=Depends(get_admin_user)):
  188. if user.id != user_id:
  189. result = Auths.delete_auth_by_id(user_id)
  190. if result:
  191. return True
  192. raise HTTPException(
  193. status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
  194. detail=ERROR_MESSAGES.DELETE_USER_ERROR,
  195. )
  196. raise HTTPException(
  197. status_code=status.HTTP_403_FORBIDDEN,
  198. detail=ERROR_MESSAGES.ACTION_PROHIBITED,
  199. )