user.py 5.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. # -*- coding: utf-8 -*-
  2. import threading
  3. from smtplib import SMTPException
  4. import transaction
  5. import typing as typing
  6. from tracim.exceptions import NotificationNotSend
  7. from tracim.lib.mail_notifier.notifier import get_email_manager
  8. from sqlalchemy.orm import Session
  9. from tracim import CFG
  10. from tracim.models.auth import User
  11. from sqlalchemy.orm.exc import NoResultFound
  12. from tracim.exceptions import WrongUserPassword, UserNotExist
  13. from tracim.exceptions import AuthenticationFailed
  14. from tracim.models.context_models import UserInContext
  15. class UserApi(object):
  16. def __init__(
  17. self,
  18. current_user: typing.Optional[User],
  19. session: Session,
  20. config: CFG,
  21. ) -> None:
  22. self._session = session
  23. self._user = current_user
  24. self._config = config
  25. def _base_query(self):
  26. return self._session.query(User)
  27. def get_user_with_context(self, user: User) -> UserInContext:
  28. """
  29. Return UserInContext object from User
  30. """
  31. user = UserInContext(
  32. user=user,
  33. dbsession=self._session,
  34. config=self._config,
  35. )
  36. return user
  37. # Getters
  38. def get_one(self, user_id: int) -> User:
  39. """
  40. Get one user by user id
  41. """
  42. return self._base_query().filter(User.user_id == user_id).one()
  43. def get_one_by_email(self, email: str) -> User:
  44. """
  45. Get one user by email
  46. :param email: Email of the user
  47. :return: one user
  48. """
  49. return self._base_query().filter(User.email == email).one()
  50. # FIXME - G.M - 24-04-2018 - Duplicate method with get_one.
  51. def get_one_by_id(self, id: int) -> User:
  52. return self.get_one(user_id=id)
  53. def get_current_user(self) -> User:
  54. """
  55. Get current_user
  56. """
  57. if not self._user:
  58. raise UserNotExist()
  59. return self._user
  60. def get_all(self) -> typing.Iterable[User]:
  61. return self._session.query(User).order_by(User.display_name).all()
  62. # Check methods
  63. def user_with_email_exists(self, email: str) -> bool:
  64. try:
  65. self.get_one_by_email(email)
  66. return True
  67. # TODO - G.M - 09-04-2018 - Better exception
  68. except:
  69. return False
  70. def authenticate_user(self, email: str, password: str) -> User:
  71. """
  72. Authenticate user with email and password, raise AuthenticationFailed
  73. if uncorrect.
  74. :param email: email of the user
  75. :param password: cleartext password of the user
  76. :return: User who was authenticated.
  77. """
  78. try:
  79. user = self.get_one_by_email(email)
  80. if user.validate_password(password):
  81. return user
  82. else:
  83. raise WrongUserPassword()
  84. except (WrongUserPassword, NoResultFound):
  85. raise AuthenticationFailed()
  86. # Actions
  87. def update(
  88. self,
  89. user: User,
  90. name: str=None,
  91. email: str=None,
  92. password: str=None,
  93. timezone: str='',
  94. do_save=True,
  95. ) -> None:
  96. if name is not None:
  97. user.display_name = name
  98. if email is not None:
  99. user.email = email
  100. if password is not None:
  101. user.password = password
  102. user.timezone = timezone
  103. if do_save:
  104. self.save(user)
  105. def create_user(
  106. self,
  107. email,
  108. password: str = None,
  109. name: str = None,
  110. timezone: str = '',
  111. groups=[],
  112. do_save: bool=True,
  113. do_notify: bool=True,
  114. ) -> User:
  115. new_user = self.create_minimal_user(email, groups, save_now=False)
  116. self.update(
  117. user=new_user,
  118. name=name,
  119. email=email,
  120. password=password,
  121. timezone=timezone,
  122. do_save=False,
  123. )
  124. if do_notify:
  125. try:
  126. email_manager = get_email_manager(self._config, self._session)
  127. email_manager.notify_created_account(
  128. new_user,
  129. password=password
  130. )
  131. except SMTPException as e:
  132. raise NotificationNotSend()
  133. if do_save:
  134. self.save(new_user)
  135. return new_user
  136. def create_minimal_user(
  137. self,
  138. email,
  139. groups=[],
  140. save_now=False
  141. ) -> User:
  142. """Previous create_user method"""
  143. user = User()
  144. user.email = email
  145. for group in groups:
  146. user.groups.append(group)
  147. self._session.add(user)
  148. if save_now:
  149. self._session.flush()
  150. return user
  151. def save(self, user: User):
  152. self._session.flush()
  153. def execute_created_user_actions(self, created_user: User) -> None:
  154. """
  155. Execute actions when user just been created
  156. :return:
  157. """
  158. # NOTE: Cyclic import
  159. # TODO - G.M - 28-03-2018 - [Calendar] Reenable Calendar stuff
  160. #from tracim.lib.calendar import CalendarManager
  161. #from tracim.model.organisational import UserCalendar
  162. # TODO - G.M - 04-04-2018 - [auth]
  163. # Check if this is already needed with
  164. # new auth system
  165. created_user.ensure_auth_token(
  166. session=self._session,
  167. validity_seconds=self._config.USER_AUTH_TOKEN_VALIDITY
  168. )
  169. # Ensure database is up-to-date
  170. self._session.flush()
  171. transaction.commit()
  172. # TODO - G.M - 28-03-2018 - [Calendar] Reenable Calendar stuff
  173. # calendar_manager = CalendarManager(created_user)
  174. # calendar_manager.create_then_remove_fake_event(
  175. # calendar_class=UserCalendar,
  176. # related_object_id=created_user.user_id,
  177. # )