File size: 7,345 Bytes
56d74b6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | # coding=utf-8
from ..base import BitbucketServerBase
class Permissions(BitbucketServerBase):
ADMIN = "ADMIN"
WRITE = "WRITE"
READ = "READ"
def __init__(self, url, permission_prefix, *args, **kwargs):
self.__permission_prefix = permission_prefix
super(Permissions, self).__init__(url, *args, **kwargs)
def __permission(self, permission):
""" Internal function to get the permission for the put request. """
return "{}_{}".format(self.__permission_prefix, permission)
def admin(self, name):
"""
Add the admin permission for a group/user.
"""
return self.add(name, self.__permission(self.ADMIN))
def write(self, name):
"""
Add the write permission for a group/user.
"""
return self.add(name, self.__permission(self.WRITE))
def read(self, name):
"""
Add the read permission for a group/user.
"""
return self.add(name, self.__permission(self.READ))
def add(self, name, permission):
"""
Add the permission for a group/user.
:param name: string: The names of the groups/users
:param permission: string: The permission to grant.
API docs:
- For project groups see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp160
- For project users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp166
- For repository groups see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp282
- For repository users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp288
"""
self.put(name, permission)
return
def each(self, filter=None):
"""
Get all groups/users.
:params filter: string: If specified only group/user names containing the supplied string will be returned
:return: A generator for the group/user permission objects
API docs:
- For project groups see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp159
- For project users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp165
- For repository groupss see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp280
- For repository users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp286
"""
params = {}
if filter is not None:
params["filter"] = filter
for entry in self._get_paged(None, params=params):
entry = self._get_object(entry)
entry.url = self.url
yield entry
def each_none(self, filter=None):
"""
Get all not granted groups/users.
:params filter: string: If specified only group/user names containing the supplied string will be returned
:return: A generator for the group/user permission objects
API docs:
- For project groups see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp163
- For project users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp169
- For repository groups see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp284
- For repository users see https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp290
"""
params = {}
if filter is not None:
params["filter"] = filter
for entry in self._get_paged("none", params=params):
yield self._get_object(entry)
def get(self, name):
"""
Returns the requested group/user
:param name: string: The requested element name.
:return: The requested group/user object
"""
for entry in self.each(filter=name):
if entry.name == name:
return entry
raise Exception("Unknown group/user '{}'".format(name))
class Groups(Permissions):
def __init__(self, url, permission_prefix, *args, **kwargs):
super(Groups, self).__init__(url, permission_prefix, *args, **kwargs)
def _get_object(self, data):
return Group(data, **self._new_session_args)
class Users(Permissions):
def __init__(self, url, permission_prefix, *args, **kwargs):
super(Users, self).__init__(url, permission_prefix, *args, **kwargs)
def _get_object(self, data):
return User(data, **self._new_session_args)
class PermissionBase(BitbucketServerBase):
def delete(self):
"""
Delete the permission.
:return: The response on success
"""
if self.url is None:
raise NotImplementedError("Delete not implemented for this object type.")
return super(BitbucketServerBase, self).delete(None, params={"name": self.name})
@property
def permission(self):
if self.url is None:
raise NotImplementedError("Pemission not implemented for this object type.")
return self.get_data("permission")
@property
def is_admin(self):
""" True if group/user is admin """
return True if self.permission == Permissions.ADMIN else False
@property
def is_write(self):
""" True if group/user has write permission """
return True if self.permission == Permissions.WRITE else False
@property
def is_read(self):
""" True if group/user has read premission """
return True if self.permission == Permissions.READ else False
@property
def can_write(self):
""" True if group/user can write """
return True if self.permission in (Permissions.ADMIN, Permissions.WRITE) else False
class Group(PermissionBase):
def __init__(self, data, *args, **kwargs):
super(Group, self).__init__(None, *args, data=data, **kwargs)
@property
def name(self):
""" The name of the group """
if self.url is None:
return self.get_data("name")
return self.get_data("group")["name"]
class User(PermissionBase):
def __init__(self, data, *args, **kwargs):
super(User, self).__init__(None, *args, data=data, **kwargs)
def __userdata(self, key):
"""
Internal getter for the user data.
:param key: string: The user data to get
:return: The requested user data
"""
if self.url is None:
return self.get_data(key)
return self.get_data("user")[key]
@property
def name(self):
""" The name of the user """
return self.__userdata("name")
@property
def email(self):
""" The email of the user """
return self.__userdata("emailAddress")
@property
def displayname(self):
""" The displayname of the user """
return self.__userdata("displayName")
@property
def active(self):
""" The active flag of the user """
return self.__userdata("active")
@property
def slug(self):
""" The slug of the user """
return self.__userdata("slug")
@property
def id(self):
""" The id of the user """
return self.__userdata("id")
|