diff rhodecode/model/repo_group.py @ 4116:ffd45b185016 rhodecode-2.2.5-gpl

Imported some of the GPLv3'd changes from RhodeCode v2.2.5. This imports changes between changesets 21af6c4eab3d and 6177597791c2 in RhodeCode's original repository, including only changes to Python files and HTML. RhodeCode clearly licensed its changes to these files under GPLv3 in their /LICENSE file, which states the following: The Python code and integrated HTML are licensed under the GPLv3 license. (See: https://code.rhodecode.com/rhodecode/files/v2.2.5/LICENSE or http://web.archive.org/web/20140512193334/https://code.rhodecode.com/rhodecode/files/f3b123159901f15426d18e3dc395e8369f70ebe0/LICENSE for an online copy of that LICENSE file) Conservancy reviewed these changes and confirmed that they can be licensed as a whole to the Kallithea project under GPLv3-only. While some of the contents committed herein are clearly licensed GPLv3-or-later, on the whole we must assume the are GPLv3-only, since the statement above from RhodeCode indicates that they intend GPLv3-only as their license, per GPLv3ยง14 and other relevant sections of GPLv3.
author Bradley M. Kuhn <bkuhn@sfconservancy.org>
date Wed, 02 Jul 2014 19:03:13 -0400
parents
children 7e5f8c12a3fc
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/rhodecode/model/repo_group.py	Wed Jul 02 19:03:13 2014 -0400
@@ -0,0 +1,540 @@
+# -*- coding: utf-8 -*-
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+rhodecode.model.user_group
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+repo group model for RhodeCode
+
+:created_on: Jan 25, 2011
+:author: marcink
+:copyright: (c) 2013 RhodeCode GmbH.
+:license: GPLv3, see LICENSE for more details.
+"""
+
+
+import os
+import logging
+import traceback
+import shutil
+import datetime
+
+from rhodecode.lib.utils2 import LazyProperty
+
+from rhodecode.model import BaseModel
+from rhodecode.model.db import RepoGroup, RhodeCodeUi, UserRepoGroupToPerm, \
+    User, Permission, UserGroupRepoGroupToPerm, UserGroup, Repository
+
+log = logging.getLogger(__name__)
+
+
+class RepoGroupModel(BaseModel):
+
+    cls = RepoGroup
+
+    def _get_user_group(self, users_group):
+        return self._get_instance(UserGroup, users_group,
+                                  callback=UserGroup.get_by_group_name)
+
+    def _get_repo_group(self, repo_group):
+        return self._get_instance(RepoGroup, repo_group,
+                                  callback=RepoGroup.get_by_group_name)
+
+    @LazyProperty
+    def repos_path(self):
+        """
+        Gets the repositories root path from database
+        """
+
+        q = RhodeCodeUi.get_by_key('/')
+        return q.ui_value
+
+    def _create_default_perms(self, new_group):
+        # create default permission
+        default_perm = 'group.read'
+        def_user = User.get_default_user()
+        for p in def_user.user_perms:
+            if p.permission.permission_name.startswith('group.'):
+                default_perm = p.permission.permission_name
+                break
+
+        repo_group_to_perm = UserRepoGroupToPerm()
+        repo_group_to_perm.permission = Permission.get_by_key(default_perm)
+
+        repo_group_to_perm.group = new_group
+        repo_group_to_perm.user_id = def_user.user_id
+        return repo_group_to_perm
+
+    def _create_group(self, group_name):
+        """
+        makes repository group on filesystem
+
+        :param repo_name:
+        :param parent_id:
+        """
+
+        create_path = os.path.join(self.repos_path, group_name)
+        log.debug('creating new group in %s' % create_path)
+
+        if os.path.isdir(create_path):
+            raise Exception('That directory already exists !')
+
+        os.makedirs(create_path)
+        log.debug('Created group in %s' % create_path)
+
+    def _rename_group(self, old, new):
+        """
+        Renames a group on filesystem
+
+        :param group_name:
+        """
+
+        if old == new:
+            log.debug('skipping group rename')
+            return
+
+        log.debug('renaming repository group from %s to %s' % (old, new))
+
+        old_path = os.path.join(self.repos_path, old)
+        new_path = os.path.join(self.repos_path, new)
+
+        log.debug('renaming repos paths from %s to %s' % (old_path, new_path))
+
+        if os.path.isdir(new_path):
+            raise Exception('Was trying to rename to already '
+                            'existing dir %s' % new_path)
+        shutil.move(old_path, new_path)
+
+    def _delete_group(self, group, force_delete=False):
+        """
+        Deletes a group from a filesystem
+
+        :param group: instance of group from database
+        :param force_delete: use shutil rmtree to remove all objects
+        """
+        paths = group.full_path.split(RepoGroup.url_sep())
+        paths = os.sep.join(paths)
+
+        rm_path = os.path.join(self.repos_path, paths)
+        log.info("Removing group %s" % (rm_path))
+        # delete only if that path really exists
+        if os.path.isdir(rm_path):
+            if force_delete:
+                shutil.rmtree(rm_path)
+            else:
+                #archive that group`
+                _now = datetime.datetime.now()
+                _ms = str(_now.microsecond).rjust(6, '0')
+                _d = 'rm__%s_GROUP_%s' % (_now.strftime('%Y%m%d_%H%M%S_' + _ms),
+                                          group.name)
+                shutil.move(rm_path, os.path.join(self.repos_path, _d))
+
+    def create(self, group_name, group_description, owner, parent=None,
+               just_db=False, copy_permissions=False):
+        try:
+            user = self._get_user(owner)
+            parent_group = self._get_repo_group(parent)
+            new_repo_group = RepoGroup()
+            new_repo_group.user = user
+            new_repo_group.group_description = group_description or group_name
+            new_repo_group.parent_group = parent_group
+            new_repo_group.group_name = new_repo_group.get_new_name(group_name)
+
+            self.sa.add(new_repo_group)
+
+            # create an ADMIN permission for owner except if we're super admin,
+            # later owner should go into the owner field of groups
+            if not user.is_admin:
+                self.grant_user_permission(repo_group=new_repo_group,
+                                           user=owner, perm='group.admin')
+
+            if parent_group and copy_permissions:
+                # copy permissions from parent
+                user_perms = UserRepoGroupToPerm.query() \
+                    .filter(UserRepoGroupToPerm.group == parent_group).all()
+
+                group_perms = UserGroupRepoGroupToPerm.query() \
+                    .filter(UserGroupRepoGroupToPerm.group == parent_group).all()
+
+                for perm in user_perms:
+                    # don't copy over the permission for user who is creating
+                    # this group, if he is not super admin he get's admin
+                    # permission set above
+                    if perm.user != user or user.is_admin:
+                        UserRepoGroupToPerm.create(perm.user, new_repo_group, perm.permission)
+
+                for perm in group_perms:
+                    UserGroupRepoGroupToPerm.create(perm.users_group, new_repo_group, perm.permission)
+            else:
+                perm_obj = self._create_default_perms(new_repo_group)
+                self.sa.add(perm_obj)
+
+            if not just_db:
+                # we need to flush here, in order to check if database won't
+                # throw any exceptions, create filesystem dirs at the very end
+                self.sa.flush()
+                self._create_group(new_repo_group.group_name)
+
+            return new_repo_group
+        except Exception:
+            log.error(traceback.format_exc())
+            raise
+
+    def _update_permissions(self, repo_group, perms_new=None,
+                            perms_updates=None, recursive=None,
+                            check_perms=True):
+        from rhodecode.model.repo import RepoModel
+        from rhodecode.lib.auth import HasUserGroupPermissionAny
+
+        if not perms_new:
+            perms_new = []
+        if not perms_updates:
+            perms_updates = []
+
+        def _set_perm_user(obj, user, perm):
+            if isinstance(obj, RepoGroup):
+                self.grant_user_permission(repo_group=obj, user=user, perm=perm)
+            elif isinstance(obj, Repository):
+                # private repos will not allow to change the default permissions
+                # using recursive mode
+                if obj.private and user == User.DEFAULT_USER:
+                    return
+
+                # we set group permission but we have to switch to repo
+                # permission
+                perm = perm.replace('group.', 'repository.')
+                RepoModel().grant_user_permission(
+                    repo=obj, user=user, perm=perm
+                )
+
+        def _set_perm_group(obj, users_group, perm):
+            if isinstance(obj, RepoGroup):
+                self.grant_user_group_permission(repo_group=obj,
+                                                  group_name=users_group,
+                                                  perm=perm)
+            elif isinstance(obj, Repository):
+                # we set group permission but we have to switch to repo
+                # permission
+                perm = perm.replace('group.', 'repository.')
+                RepoModel().grant_user_group_permission(
+                    repo=obj, group_name=users_group, perm=perm
+                )
+
+        # start updates
+        updates = []
+        log.debug('Now updating permissions for %s in recursive mode:%s'
+                  % (repo_group, recursive))
+
+        for obj in repo_group.recursive_groups_and_repos():
+            # iterated obj is an instance of a repos group or repository in
+            # that group, recursive option can be: none, repos, groups, all
+            if recursive == 'all':
+                obj = obj
+            elif recursive == 'repos':
+                # skip groups, other than this one
+                if isinstance(obj, RepoGroup) and not obj == repo_group:
+                    continue
+            elif recursive == 'groups':
+                # skip repos
+                if isinstance(obj, Repository):
+                    continue
+            else:  # recursive == 'none': # DEFAULT don't apply to iterated objects
+                obj = repo_group
+                # also we do a break at the end of this loop.
+
+            # update permissions
+            for member, perm, member_type in perms_updates:
+                ## set for user
+                if member_type == 'user':
+                    # this updates also current one if found
+                    _set_perm_user(obj, user=member, perm=perm)
+                ## set for user group
+                else:
+                    #check if we have permissions to alter this usergroup
+                    req_perms = ('usergroup.read', 'usergroup.write', 'usergroup.admin')
+                    if not check_perms or HasUserGroupPermissionAny(*req_perms)(member):
+                        _set_perm_group(obj, users_group=member, perm=perm)
+            # set new permissions
+            for member, perm, member_type in perms_new:
+                if member_type == 'user':
+                    _set_perm_user(obj, user=member, perm=perm)
+                else:
+                    #check if we have permissions to alter this usergroup
+                    req_perms = ('usergroup.read', 'usergroup.write', 'usergroup.admin')
+                    if not check_perms or HasUserGroupPermissionAny(*req_perms)(member):
+                        _set_perm_group(obj, users_group=member, perm=perm)
+            updates.append(obj)
+            # if it's not recursive call for all,repos,groups
+            # break the loop and don't proceed with other changes
+            if recursive not in ['all', 'repos', 'groups']:
+                break
+
+        return updates
+
+    def update(self, repo_group, form_data):
+
+        try:
+            repo_group = self._get_repo_group(repo_group)
+            old_path = repo_group.full_path
+
+            # change properties
+            repo_group.group_description = form_data['group_description']
+            repo_group.group_parent_id = form_data['group_parent_id']
+            repo_group.enable_locking = form_data['enable_locking']
+
+            repo_group.parent_group = RepoGroup.get(form_data['group_parent_id'])
+            repo_group.group_name = repo_group.get_new_name(form_data['group_name'])
+            new_path = repo_group.full_path
+            self.sa.add(repo_group)
+
+            # iterate over all members of this groups and do fixes
+            # set locking if given
+            # if obj is a repoGroup also fix the name of the group according
+            # to the parent
+            # if obj is a Repo fix it's name
+            # this can be potentially heavy operation
+            for obj in repo_group.recursive_groups_and_repos():
+                #set the value from it's parent
+                obj.enable_locking = repo_group.enable_locking
+                if isinstance(obj, RepoGroup):
+                    new_name = obj.get_new_name(obj.name)
+                    log.debug('Fixing group %s to new name %s' \
+                                % (obj.group_name, new_name))
+                    obj.group_name = new_name
+                elif isinstance(obj, Repository):
+                    # we need to get all repositories from this new group and
+                    # rename them accordingly to new group path
+                    new_name = obj.get_new_name(obj.just_name)
+                    log.debug('Fixing repo %s to new name %s' \
+                                % (obj.repo_name, new_name))
+                    obj.repo_name = new_name
+                self.sa.add(obj)
+
+            self._rename_group(old_path, new_path)
+
+            return repo_group
+        except Exception:
+            log.error(traceback.format_exc())
+            raise
+
+    def delete(self, repo_group, force_delete=False):
+        repo_group = self._get_repo_group(repo_group)
+        try:
+            self.sa.delete(repo_group)
+            self._delete_group(repo_group, force_delete)
+        except Exception:
+            log.error('Error removing repo_group %s' % repo_group)
+            raise
+
+    def add_permission(self, repo_group, obj, obj_type, perm, recursive):
+        from rhodecode.model.repo import RepoModel
+        repo_group = self._get_repo_group(repo_group)
+        perm = self._get_perm(perm)
+
+        for el in repo_group.recursive_groups_and_repos():
+            # iterated obj is an instance of a repos group or repository in
+            # that group, recursive option can be: none, repos, groups, all
+            if recursive == 'all':
+                el = el
+            elif recursive == 'repos':
+                # skip groups, other than this one
+                if isinstance(el, RepoGroup) and not el == repo_group:
+                    continue
+            elif recursive == 'groups':
+                # skip repos
+                if isinstance(el, Repository):
+                    continue
+            else:  # recursive == 'none': # DEFAULT don't apply to iterated objects
+                el = repo_group
+                # also we do a break at the end of this loop.
+
+            if isinstance(el, RepoGroup):
+                if obj_type == 'user':
+                    RepoGroupModel().grant_user_permission(el, user=obj, perm=perm)
+                elif obj_type == 'user_group':
+                    RepoGroupModel().grant_user_group_permission(el, group_name=obj, perm=perm)
+                else:
+                    raise Exception('undefined object type %s' % obj_type)
+            elif isinstance(el, Repository):
+                # for repos we need to hotfix the name of permission
+                _perm = perm.permission_name.replace('group.', 'repository.')
+                if obj_type == 'user':
+                    RepoModel().grant_user_permission(el, user=obj, perm=_perm)
+                elif obj_type == 'user_group':
+                    RepoModel().grant_user_group_permission(el, group_name=obj, perm=_perm)
+                else:
+                    raise Exception('undefined object type %s' % obj_type)
+            else:
+                raise Exception('el should be instance of Repository or '
+                                'RepositoryGroup got %s instead' % type(el))
+
+            # if it's not recursive call for all,repos,groups
+            # break the loop and don't proceed with other changes
+            if recursive not in ['all', 'repos', 'groups']:
+                break
+
+    def delete_permission(self, repo_group, obj, obj_type, recursive):
+        """
+        Revokes permission for repo_group for given obj(user or users_group),
+        obj_type can be user or user group
+
+        :param repo_group:
+        :param obj: user or user group id
+        :param obj_type: user or user group type
+        :param recursive: recurse to all children of group
+        """
+        from rhodecode.model.repo import RepoModel
+        repo_group = self._get_repo_group(repo_group)
+
+        for el in repo_group.recursive_groups_and_repos():
+            # iterated obj is an instance of a repos group or repository in
+            # that group, recursive option can be: none, repos, groups, all
+            if recursive == 'all':
+                el = el
+            elif recursive == 'repos':
+                # skip groups, other than this one
+                if isinstance(el, RepoGroup) and not el == repo_group:
+                    continue
+            elif recursive == 'groups':
+                # skip repos
+                if isinstance(el, Repository):
+                    continue
+            else:  # recursive == 'none': # DEFAULT don't apply to iterated objects
+                el = repo_group
+                # also we do a break at the end of this loop.
+
+            if isinstance(el, RepoGroup):
+                if obj_type == 'user':
+                    RepoGroupModel().revoke_user_permission(el, user=obj)
+                elif obj_type == 'user_group':
+                    RepoGroupModel().revoke_user_group_permission(el, group_name=obj)
+                else:
+                    raise Exception('undefined object type %s' % obj_type)
+            elif isinstance(el, Repository):
+                if obj_type == 'user':
+                    RepoModel().revoke_user_permission(el, user=obj)
+                elif obj_type == 'user_group':
+                    RepoModel().revoke_user_group_permission(el, group_name=obj)
+                else:
+                    raise Exception('undefined object type %s' % obj_type)
+            else:
+                raise Exception('el should be instance of Repository or '
+                                'RepositoryGroup got %s instead' % type(el))
+
+            # if it's not recursive call for all,repos,groups
+            # break the loop and don't proceed with other changes
+            if recursive not in ['all', 'repos', 'groups']:
+                break
+
+    def grant_user_permission(self, repo_group, user, perm):
+        """
+        Grant permission for user on given repository group, or update
+        existing one if found
+
+        :param repo_group: Instance of RepoGroup, repositories_group_id,
+            or repositories_group name
+        :param user: Instance of User, user_id or username
+        :param perm: Instance of Permission, or permission_name
+        """
+
+        repo_group = self._get_repo_group(repo_group)
+        user = self._get_user(user)
+        permission = self._get_perm(perm)
+
+        # check if we have that permission already
+        obj = self.sa.query(UserRepoGroupToPerm)\
+            .filter(UserRepoGroupToPerm.user == user)\
+            .filter(UserRepoGroupToPerm.group == repo_group)\
+            .scalar()
+        if obj is None:
+            # create new !
+            obj = UserRepoGroupToPerm()
+        obj.group = repo_group
+        obj.user = user
+        obj.permission = permission
+        self.sa.add(obj)
+        log.debug('Granted perm %s to %s on %s' % (perm, user, repo_group))
+        return obj
+
+    def revoke_user_permission(self, repo_group, user):
+        """
+        Revoke permission for user on given repository group
+
+        :param repo_group: Instance of RepoGroup, repositories_group_id,
+            or repositories_group name
+        :param user: Instance of User, user_id or username
+        """
+
+        repo_group = self._get_repo_group(repo_group)
+        user = self._get_user(user)
+
+        obj = self.sa.query(UserRepoGroupToPerm)\
+            .filter(UserRepoGroupToPerm.user == user)\
+            .filter(UserRepoGroupToPerm.group == repo_group)\
+            .scalar()
+        if obj:
+            self.sa.delete(obj)
+            log.debug('Revoked perm on %s on %s' % (repo_group, user))
+
+    def grant_user_group_permission(self, repo_group, group_name, perm):
+        """
+        Grant permission for user group on given repository group, or update
+        existing one if found
+
+        :param repo_group: Instance of RepoGroup, repositories_group_id,
+            or repositories_group name
+        :param group_name: Instance of UserGroup, users_group_id,
+            or user group name
+        :param perm: Instance of Permission, or permission_name
+        """
+        repo_group = self._get_repo_group(repo_group)
+        group_name = self._get_user_group(group_name)
+        permission = self._get_perm(perm)
+
+        # check if we have that permission already
+        obj = self.sa.query(UserGroupRepoGroupToPerm)\
+            .filter(UserGroupRepoGroupToPerm.group == repo_group)\
+            .filter(UserGroupRepoGroupToPerm.users_group == group_name)\
+            .scalar()
+
+        if obj is None:
+            # create new
+            obj = UserGroupRepoGroupToPerm()
+
+        obj.group = repo_group
+        obj.users_group = group_name
+        obj.permission = permission
+        self.sa.add(obj)
+        log.debug('Granted perm %s to %s on %s' % (perm, group_name, repo_group))
+        return obj
+
+    def revoke_user_group_permission(self, repo_group, group_name):
+        """
+        Revoke permission for user group on given repository group
+
+        :param repo_group: Instance of RepoGroup, repositories_group_id,
+            or repositories_group name
+        :param group_name: Instance of UserGroup, users_group_id,
+            or user group name
+        """
+        repo_group = self._get_repo_group(repo_group)
+        group_name = self._get_user_group(group_name)
+
+        obj = self.sa.query(UserGroupRepoGroupToPerm)\
+            .filter(UserGroupRepoGroupToPerm.group == repo_group)\
+            .filter(UserGroupRepoGroupToPerm.users_group == group_name)\
+            .scalar()
+        if obj:
+            self.sa.delete(obj)
+            log.debug('Revoked perm to %s on %s' % (repo_group, group_name))