rhodecode/apps/my_account/views/my_account.py

# -*- coding: utf-8 -*-

# Copyright (C) 2016-2020 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/

import logging
import datetime
import string

import formencode
import formencode.htmlfill
import peppercorn
from pyramid.httpexceptions import HTTPFound, HTTPNotFound

from rhodecode.apps._base import BaseAppView, DataGridAppView
from rhodecode import forms
from rhodecode.lib import helpers as h
from rhodecode.lib import audit_logger
from rhodecode.lib.ext_json import json
from rhodecode.lib.auth import (
    LoginRequired, NotAnonymous, CSRFRequired,
    HasRepoPermissionAny, HasRepoGroupPermissionAny, AuthUser)
from rhodecode.lib.channelstream import (
    channelstream_request, ChannelstreamException)
from rhodecode.lib.utils2 import safe_int, md5, str2bool
from rhodecode.model.auth_token import AuthTokenModel
from rhodecode.model.comment import CommentsModel
from rhodecode.model.db import (
    IntegrityError, or_, in_filter_generator,
    Repository, UserEmailMap, UserApiKeys, UserFollowing,
    PullRequest, UserBookmark, RepoGroup)
from rhodecode.model.meta import Session
from rhodecode.model.pull_request import PullRequestModel
from rhodecode.model.user import UserModel
from rhodecode.model.user_group import UserGroupModel
from rhodecode.model.validation_schema.schemas import user_schema

log = logging.getLogger(__name__)


class MyAccountView(BaseAppView, DataGridAppView):
    ALLOW_SCOPED_TOKENS = False
    """
    This view has alternative version inside EE, if modified please take a look
    in there as well.
    """

    def load_default_context(self):
        c = self._get_local_tmpl_context()
        c.user = c.auth_user.get_instance()
        c.allow_scoped_tokens = self.ALLOW_SCOPED_TOKENS
        return c

    @LoginRequired()
    @NotAnonymous()
    def my_account_profile(self):
        c = self.load_default_context()
        c.active = 'profile'
        c.extern_type = c.user.extern_type
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    def my_account_edit(self):
        c = self.load_default_context()
        c.active = 'profile_edit'
        c.extern_type = c.user.extern_type
        c.extern_name = c.user.extern_name

        schema = user_schema.UserProfileSchema().bind(
            username=c.user.username, user_emails=c.user.emails)
        appstruct = {
            'username': c.user.username,
            'email': c.user.email,
            'firstname': c.user.firstname,
            'lastname': c.user.lastname,
            'description': c.user.description,
        }
        c.form = forms.RcForm(
            schema, appstruct=appstruct,
            action=h.route_path('my_account_update'),
            buttons=(forms.buttons.save, forms.buttons.reset))

        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_update(self):
        _ = self.request.translate
        c = self.load_default_context()
        c.active = 'profile_edit'
        c.perm_user = c.auth_user
        c.extern_type = c.user.extern_type
        c.extern_name = c.user.extern_name

        schema = user_schema.UserProfileSchema().bind(
            username=c.user.username, user_emails=c.user.emails)
        form = forms.RcForm(
            schema, buttons=(forms.buttons.save, forms.buttons.reset))

        controls = self.request.POST.items()
        try:
            valid_data = form.validate(controls)
            skip_attrs = ['admin', 'active', 'extern_type', 'extern_name',
                          'new_password', 'password_confirmation']
            if c.extern_type != "rhodecode":
                # forbid updating username for external accounts
                skip_attrs.append('username')
            old_email = c.user.email
            UserModel().update_user(
                     self._rhodecode_user.user_id, skip_attrs=skip_attrs,
                     **valid_data)
            if old_email != valid_data['email']:
                old = UserEmailMap.query() \
                    .filter(UserEmailMap.user == c.user)\
                    .filter(UserEmailMap.email == valid_data['email'])\
                    .first()
                old.email = old_email
            h.flash(_('Your account was updated successfully'), category='success')
            Session().commit()
        except forms.ValidationFailure as e:
            c.form = e
            return self._get_template_context(c)
        except Exception:
            log.exception("Exception updating user")
            h.flash(_('Error occurred during update of user'),
                    category='error')
        raise HTTPFound(h.route_path('my_account_profile'))

    @LoginRequired()
    @NotAnonymous()
    def my_account_password(self):
        c = self.load_default_context()
        c.active = 'password'
        c.extern_type = c.user.extern_type

        schema = user_schema.ChangePasswordSchema().bind(
            username=c.user.username)

        form = forms.Form(
            schema,
            action=h.route_path('my_account_password_update'),
            buttons=(forms.buttons.save, forms.buttons.reset))

        c.form = form
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_password_update(self):
        _ = self.request.translate
        c = self.load_default_context()
        c.active = 'password'
        c.extern_type = c.user.extern_type

        schema = user_schema.ChangePasswordSchema().bind(
            username=c.user.username)

        form = forms.Form(
            schema, buttons=(forms.buttons.save, forms.buttons.reset))

        if c.extern_type != 'rhodecode':
            raise HTTPFound(self.request.route_path('my_account_password'))

        controls = self.request.POST.items()
        try:
            valid_data = form.validate(controls)
            UserModel().update_user(c.user.user_id, **valid_data)
            c.user.update_userdata(force_password_change=False)
            Session().commit()
        except forms.ValidationFailure as e:
            c.form = e
            return self._get_template_context(c)

        except Exception:
            log.exception("Exception updating password")
            h.flash(_('Error occurred during update of user password'),
                    category='error')
        else:
            instance = c.auth_user.get_instance()
            self.session.setdefault('rhodecode_user', {}).update(
                {'password': md5(instance.password)})
            self.session.save()
            h.flash(_("Successfully updated password"), category='success')

        raise HTTPFound(self.request.route_path('my_account_password'))

    @LoginRequired()
    @NotAnonymous()
    def my_account_auth_tokens(self):
        _ = self.request.translate

        c = self.load_default_context()
        c.active = 'auth_tokens'
        c.lifetime_values = AuthTokenModel.get_lifetime_values(translator=_)
        c.role_values = [
            (x, AuthTokenModel.cls._get_role_name(x))
            for x in AuthTokenModel.cls.ROLES]
        c.role_options = [(c.role_values, _("Role"))]
        c.user_auth_tokens = AuthTokenModel().get_auth_tokens(
            c.user.user_id, show_expired=True)
        c.role_vcs = AuthTokenModel.cls.ROLE_VCS
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_auth_tokens_view(self):
        _ = self.request.translate
        c = self.load_default_context()

        auth_token_id = self.request.POST.get('auth_token_id')

        if auth_token_id:
            token = UserApiKeys.get_or_404(auth_token_id)
            if token.user.user_id != c.user.user_id:
                raise HTTPNotFound()

            return {
                'auth_token': token.api_key
            }

    def maybe_attach_token_scope(self, token):
        # implemented in EE edition
        pass

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_auth_tokens_add(self):
        _ = self.request.translate
        c = self.load_default_context()

        lifetime = safe_int(self.request.POST.get('lifetime'), -1)
        description = self.request.POST.get('description')
        role = self.request.POST.get('role')

        token = UserModel().add_auth_token(
            user=c.user.user_id,
            lifetime_minutes=lifetime, role=role, description=description,
            scope_callback=self.maybe_attach_token_scope)
        token_data = token.get_api_data()

        audit_logger.store_web(
            'user.edit.token.add', action_data={
                'data': {'token': token_data, 'user': 'self'}},
            user=self._rhodecode_user, )
        Session().commit()

        h.flash(_("Auth token successfully created"), category='success')
        return HTTPFound(h.route_path('my_account_auth_tokens'))

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_auth_tokens_delete(self):
        _ = self.request.translate
        c = self.load_default_context()

        del_auth_token = self.request.POST.get('del_auth_token')

        if del_auth_token:
            token = UserApiKeys.get_or_404(del_auth_token)
            token_data = token.get_api_data()

            AuthTokenModel().delete(del_auth_token, c.user.user_id)
            audit_logger.store_web(
                'user.edit.token.delete', action_data={
                    'data': {'token': token_data, 'user': 'self'}},
                user=self._rhodecode_user,)
            Session().commit()
            h.flash(_("Auth token successfully deleted"), category='success')

        return HTTPFound(h.route_path('my_account_auth_tokens'))

    @LoginRequired()
    @NotAnonymous()
    def my_account_emails(self):
        _ = self.request.translate

        c = self.load_default_context()
        c.active = 'emails'

        c.user_email_map = UserEmailMap.query()\
            .filter(UserEmailMap.user == c.user).all()

        schema = user_schema.AddEmailSchema().bind(
            username=c.user.username, user_emails=c.user.emails)

        form = forms.RcForm(schema,
                            action=h.route_path('my_account_emails_add'),
                            buttons=(forms.buttons.save, forms.buttons.reset))

        c.form = form
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_emails_add(self):
        _ = self.request.translate
        c = self.load_default_context()
        c.active = 'emails'

        schema = user_schema.AddEmailSchema().bind(
            username=c.user.username, user_emails=c.user.emails)

        form = forms.RcForm(
            schema, action=h.route_path('my_account_emails_add'),
            buttons=(forms.buttons.save, forms.buttons.reset))

        controls = self.request.POST.items()
        try:
            valid_data = form.validate(controls)
            UserModel().add_extra_email(c.user.user_id, valid_data['email'])
            audit_logger.store_web(
                'user.edit.email.add', action_data={
                    'data': {'email': valid_data['email'], 'user': 'self'}},
                user=self._rhodecode_user,)
            Session().commit()
        except formencode.Invalid as error:
            h.flash(h.escape(error.error_dict['email']), category='error')
        except forms.ValidationFailure as e:
            c.user_email_map = UserEmailMap.query() \
                .filter(UserEmailMap.user == c.user).all()
            c.form = e
            return self._get_template_context(c)
        except Exception:
            log.exception("Exception adding email")
            h.flash(_('Error occurred during adding email'),
                    category='error')
        else:
            h.flash(_("Successfully added email"), category='success')

        raise HTTPFound(self.request.route_path('my_account_emails'))

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_emails_delete(self):
        _ = self.request.translate
        c = self.load_default_context()

        del_email_id = self.request.POST.get('del_email_id')
        if del_email_id:
            email = UserEmailMap.get_or_404(del_email_id).email
            UserModel().delete_extra_email(c.user.user_id, del_email_id)
            audit_logger.store_web(
                'user.edit.email.delete', action_data={
                    'data': {'email': email, 'user': 'self'}},
                user=self._rhodecode_user,)
            Session().commit()
            h.flash(_("Email successfully deleted"),
                    category='success')
        return HTTPFound(h.route_path('my_account_emails'))

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_notifications_test_channelstream(self):
        message = 'Test message sent via Channelstream by user: {}, on {}'.format(
            self._rhodecode_user.username, datetime.datetime.now())
        payload = {
            # 'channel': 'broadcast',
            'type': 'message',
            'timestamp': datetime.datetime.utcnow(),
            'user': 'system',
            'pm_users': [self._rhodecode_user.username],
            'message': {
                'message': message,
                'level': 'info',
                'topic': '/notifications'
            }
        }

        registry = self.request.registry
        rhodecode_plugins = getattr(registry, 'rhodecode_plugins', {})
        channelstream_config = rhodecode_plugins.get('channelstream', {})

        try:
            channelstream_request(channelstream_config, [payload], '/message')
        except ChannelstreamException as e:
            log.exception('Failed to send channelstream data')
            return {"response": 'ERROR: {}'.format(e.__class__.__name__)}
        return {"response": 'Channelstream data sent. '
                            'You should see a new live message now.'}

    def _load_my_repos_data(self, watched=False):

        allowed_ids = [-1] + self._rhodecode_user.repo_acl_ids_from_stack(AuthUser.repo_read_perms)

        if watched:
            # repos user watch
            repo_list = Session().query(
                    Repository
                ) \
                .join(
                    (UserFollowing, UserFollowing.follows_repo_id == Repository.repo_id)
                ) \
                .filter(
                    UserFollowing.user_id == self._rhodecode_user.user_id
                ) \
                .filter(or_(
                    # generate multiple IN to fix limitation problems
                    *in_filter_generator(Repository.repo_id, allowed_ids))
                ) \
                .order_by(Repository.repo_name) \
                .all()

        else:
            # repos user is owner of
            repo_list = Session().query(
                    Repository
                ) \
                .filter(
                    Repository.user_id == self._rhodecode_user.user_id
                ) \
                .filter(or_(
                    # generate multiple IN to fix limitation problems
                    *in_filter_generator(Repository.repo_id, allowed_ids))
                ) \
                .order_by(Repository.repo_name) \
                .all()

        _render = self.request.get_partial_renderer(
            'rhodecode:templates/data_table/_dt_elements.mako')

        def repo_lnk(name, rtype, rstate, private, archived, fork_of):
            return _render('repo_name', name, rtype, rstate, private, archived, fork_of,
                           short_name=False, admin=False)

        repos_data = []
        for repo in repo_list:
            row = {
                "name": repo_lnk(repo.repo_name, repo.repo_type, repo.repo_state,
                                 repo.private, repo.archived, repo.fork),
                "name_raw": repo.repo_name.lower(),
            }

            repos_data.append(row)

        # json used to render the grid
        return json.dumps(repos_data)

    @LoginRequired()
    @NotAnonymous()
    def my_account_repos(self):
        c = self.load_default_context()
        c.active = 'repos'

        # json used to render the grid
        c.data = self._load_my_repos_data()
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    def my_account_watched(self):
        c = self.load_default_context()
        c.active = 'watched'

        # json used to render the grid
        c.data = self._load_my_repos_data(watched=True)
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    def my_account_bookmarks(self):
        c = self.load_default_context()
        c.active = 'bookmarks'
        c.bookmark_items = UserBookmark.get_bookmarks_for_user(
            self._rhodecode_db_user.user_id, cache=False)
        return self._get_template_context(c)

    def _process_bookmark_entry(self, entry, user_id):
        position = safe_int(entry.get('position'))
        cur_position = safe_int(entry.get('cur_position'))
        if position is None:
            return

        # check if this is an existing entry
        is_new = False
        db_entry = UserBookmark().get_by_position_for_user(cur_position, user_id)

        if db_entry and str2bool(entry.get('remove')):
            log.debug('Marked bookmark %s for deletion', db_entry)
            Session().delete(db_entry)
            return

        if not db_entry:
            # new
            db_entry = UserBookmark()
            is_new = True

        should_save = False
        default_redirect_url = ''

        # save repo
        if entry.get('bookmark_repo') and safe_int(entry.get('bookmark_repo')):
            repo = Repository.get(entry['bookmark_repo'])
            perm_check = HasRepoPermissionAny(
                'repository.read', 'repository.write', 'repository.admin')
            if repo and perm_check(repo_name=repo.repo_name):
                db_entry.repository = repo
                should_save = True
                default_redirect_url = '${repo_url}'
        # save repo group
        elif entry.get('bookmark_repo_group') and safe_int(entry.get('bookmark_repo_group')):
            repo_group = RepoGroup.get(entry['bookmark_repo_group'])
            perm_check = HasRepoGroupPermissionAny(
                'group.read', 'group.write', 'group.admin')

            if repo_group and perm_check(group_name=repo_group.group_name):
                db_entry.repository_group = repo_group
                should_save = True
                default_redirect_url = '${repo_group_url}'
        # save generic info
        elif entry.get('title') and entry.get('redirect_url'):
            should_save = True

        if should_save:
            # mark user and position
            db_entry.user_id = user_id
            db_entry.position = position
            db_entry.title = entry.get('title')
            db_entry.redirect_url = entry.get('redirect_url') or default_redirect_url
            log.debug('Saving bookmark %s, new:%s', db_entry, is_new)

            Session().add(db_entry)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_account_bookmarks_update(self):
        _ = self.request.translate
        c = self.load_default_context()
        c.active = 'bookmarks'

        controls = peppercorn.parse(self.request.POST.items())
        user_id = c.user.user_id

        # validate positions
        positions = {}
        for entry in controls.get('bookmarks', []):
            position = safe_int(entry['position'])
            if position is None:
                continue

            if position in positions:
                h.flash(_("Position {} is defined twice. "
                          "Please correct this error.").format(position), category='error')
                return HTTPFound(h.route_path('my_account_bookmarks'))

            entry['position'] = position
            entry['cur_position'] = safe_int(entry.get('cur_position'))
            positions[position] = entry

        try:
            for entry in positions.values():
                self._process_bookmark_entry(entry, user_id)

            Session().commit()
            h.flash(_("Update Bookmarks"), category='success')
        except IntegrityError:
            h.flash(_("Failed to update bookmarks. "
                      "Make sure an unique position is used."), category='error')

        return HTTPFound(h.route_path('my_account_bookmarks'))

    @LoginRequired()
    @NotAnonymous()
    def my_account_goto_bookmark(self):

        bookmark_id = self.request.matchdict['bookmark_id']
        user_bookmark = UserBookmark().query()\
            .filter(UserBookmark.user_id == self.request.user.user_id) \
            .filter(UserBookmark.position == bookmark_id).scalar()

        redirect_url = h.route_path('my_account_bookmarks')
        if not user_bookmark:
            raise HTTPFound(redirect_url)

        # repository set
        if user_bookmark.repository:
            repo_name = user_bookmark.repository.repo_name
            base_redirect_url = h.route_path(
                'repo_summary', repo_name=repo_name)
            if user_bookmark.redirect_url and \
                    '${repo_url}' in user_bookmark.redirect_url:
                redirect_url = string.Template(user_bookmark.redirect_url)\
                    .safe_substitute({'repo_url': base_redirect_url})
            else:
                redirect_url = base_redirect_url
        # repository group set
        elif user_bookmark.repository_group:
            repo_group_name = user_bookmark.repository_group.group_name
            base_redirect_url = h.route_path(
                'repo_group_home', repo_group_name=repo_group_name)
            if user_bookmark.redirect_url and \
                    '${repo_group_url}' in user_bookmark.redirect_url:
                redirect_url = string.Template(user_bookmark.redirect_url)\
                    .safe_substitute({'repo_group_url': base_redirect_url})
            else:
                redirect_url = base_redirect_url
        # custom URL set
        elif user_bookmark.redirect_url:
            server_url = h.route_url('home').rstrip('/')
            redirect_url = string.Template(user_bookmark.redirect_url) \
                .safe_substitute({'server_url': server_url})

        log.debug('Redirecting bookmark %s to %s', user_bookmark, redirect_url)
        raise HTTPFound(redirect_url)

    @LoginRequired()
    @NotAnonymous()
    def my_account_perms(self):
        c = self.load_default_context()
        c.active = 'perms'

        c.perm_user = c.auth_user
        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    def my_notifications(self):
        c = self.load_default_context()
        c.active = 'notifications'

        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    @CSRFRequired()
    def my_notifications_toggle_visibility(self):
        user = self._rhodecode_db_user
        new_status = not user.user_data.get('notification_status', True)
        user.update_userdata(notification_status=new_status)
        Session().commit()
        return user.user_data['notification_status']

    def _get_pull_requests_list(self, statuses):
        draw, start, limit = self._extract_chunk(self.request)
        search_q, order_by, order_dir = self._extract_ordering(self.request)

        _render = self.request.get_partial_renderer(
            'rhodecode:templates/data_table/_dt_elements.mako')

        pull_requests = PullRequestModel().get_im_participating_in(
            user_id=self._rhodecode_user.user_id,
            statuses=statuses, query=search_q,
            offset=start, length=limit, order_by=order_by,
            order_dir=order_dir)

        pull_requests_total_count = PullRequestModel().count_im_participating_in(
            user_id=self._rhodecode_user.user_id, statuses=statuses, query=search_q)

        data = []
        comments_model = CommentsModel()
        for pr in pull_requests:
            repo_id = pr.target_repo_id
            comments_count = comments_model.get_all_comments(
                repo_id, pull_request=pr, include_drafts=False, count_only=True)
            owned = pr.user_id == self._rhodecode_user.user_id

            data.append({
                'target_repo': _render('pullrequest_target_repo',
                                       pr.target_repo.repo_name),
                'name': _render('pullrequest_name',
                                pr.pull_request_id, pr.pull_request_state,
                                pr.work_in_progress, pr.target_repo.repo_name,
                                short=True),
                'name_raw': pr.pull_request_id,
                'status': _render('pullrequest_status',
                                  pr.calculated_review_status()),
                'title': _render('pullrequest_title', pr.title, pr.description),
                'description': h.escape(pr.description),
                'updated_on': _render('pullrequest_updated_on',
                                      h.datetime_to_time(pr.updated_on),
                                      pr.versions_count),
                'updated_on_raw': h.datetime_to_time(pr.updated_on),
                'created_on': _render('pullrequest_updated_on',
                                      h.datetime_to_time(pr.created_on)),
                'created_on_raw': h.datetime_to_time(pr.created_on),
                'state': pr.pull_request_state,
                'author': _render('pullrequest_author',
                                  pr.author.full_contact, ),
                'author_raw': pr.author.full_name,
                'comments': _render('pullrequest_comments', comments_count),
                'comments_raw': comments_count,
                'closed': pr.is_closed(),
                'owned': owned
            })

        # json used to render the grid
        data = ({
            'draw': draw,
            'data': data,
            'recordsTotal': pull_requests_total_count,
            'recordsFiltered': pull_requests_total_count,
        })
        return data

    @LoginRequired()
    @NotAnonymous()
    def my_account_pullrequests(self):
        c = self.load_default_context()
        c.active = 'pullrequests'
        req_get = self.request.GET

        c.closed = str2bool(req_get.get('pr_show_closed'))

        return self._get_template_context(c)

    @LoginRequired()
    @NotAnonymous()
    def my_account_pullrequests_data(self):
        self.load_default_context()
        req_get = self.request.GET
        closed = str2bool(req_get.get('closed'))

        statuses = [PullRequest.STATUS_NEW, PullRequest.STATUS_OPEN]
        if closed:
            statuses += [PullRequest.STATUS_CLOSED]

        data = self._get_pull_requests_list(statuses=statuses)
        return data

    @LoginRequired()
    @NotAnonymous()
    def my_account_user_group_membership(self):
        c = self.load_default_context()
        c.active = 'user_group_membership'
        groups = [UserGroupModel.get_user_groups_as_dict(group.users_group)
                  for group in self._rhodecode_db_user.group_member]
        c.user_groups = json.dumps(groups)
        return self._get_template_context(c)