user.py 7.2KB

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