Files
@ 8628c8706bf8
Branch filter:
Location: kallithea/rhodecode/controllers/api/api.py - annotation
8628c8706bf8
12.7 KiB
text/x-python
[API] Update doc
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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | 256e729a94cd 256e729a94cd 256e729a94cd c78f6bf52e9c 3338a0994472 c78f6bf52e9c c78f6bf52e9c 8898a79ac628 3338a0994472 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 8898a79ac628 307ec693bdf2 307ec693bdf2 256e729a94cd 8898a79ac628 256e729a94cd c78f6bf52e9c 8898a79ac628 c78f6bf52e9c c78f6bf52e9c 3338a0994472 3338a0994472 c78f6bf52e9c c78f6bf52e9c 3338a0994472 c78f6bf52e9c 3338a0994472 3338a0994472 3338a0994472 c78f6bf52e9c 3338a0994472 c78f6bf52e9c c78f6bf52e9c 8898a79ac628 8898a79ac628 c78f6bf52e9c c78f6bf52e9c 3338a0994472 3338a0994472 256e729a94cd 256e729a94cd c78f6bf52e9c c78f6bf52e9c 8898a79ac628 8898a79ac628 8898a79ac628 c78f6bf52e9c 8898a79ac628 c78f6bf52e9c c78f6bf52e9c 8898a79ac628 c78f6bf52e9c 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 c78f6bf52e9c 0b63a0d2cede 0b63a0d2cede 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 8898a79ac628 8898a79ac628 256e729a94cd 8898a79ac628 3338a0994472 256e729a94cd 256e729a94cd 256e729a94cd 256e729a94cd 256e729a94cd 256e729a94cd 3338a0994472 3338a0994472 3338a0994472 256e729a94cd 3338a0994472 307ec693bdf2 307ec693bdf2 307ec693bdf2 256e729a94cd 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 256e729a94cd 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 c78f6bf52e9c 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 3338a0994472 8898a79ac628 3338a0994472 3338a0994472 3338a0994472 2ccb32ddcfd7 3338a0994472 2ccb32ddcfd7 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 3338a0994472 3338a0994472 8898a79ac628 8898a79ac628 256e729a94cd 256e729a94cd 3338a0994472 256e729a94cd 256e729a94cd 256e729a94cd 2ccb32ddcfd7 307ec693bdf2 307ec693bdf2 307ec693bdf2 256e729a94cd 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 256e729a94cd 8898a79ac628 8898a79ac628 3338a0994472 8898a79ac628 8898a79ac628 3338a0994472 3338a0994472 3338a0994472 3338a0994472 8898a79ac628 3338a0994472 3338a0994472 3338a0994472 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 8898a79ac628 8898a79ac628 307ec693bdf2 0b63a0d2cede 307ec693bdf2 8898a79ac628 8898a79ac628 8898a79ac628 3338a0994472 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 307ec693bdf2 0b63a0d2cede 307ec693bdf2 8898a79ac628 3338a0994472 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 3338a0994472 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 8898a79ac628 8898a79ac628 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 8898a79ac628 307ec693bdf2 307ec693bdf2 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 3338a0994472 2ccb32ddcfd7 307ec693bdf2 0b63a0d2cede 307ec693bdf2 8898a79ac628 3338a0994472 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 307ec693bdf2 3338a0994472 8898a79ac628 8898a79ac628 3338a0994472 8898a79ac628 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 3338a0994472 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 2ccb32ddcfd7 307ec693bdf2 0b63a0d2cede 307ec693bdf2 8898a79ac628 2ccb32ddcfd7 307ec693bdf2 0b63a0d2cede 307ec693bdf2 8898a79ac628 2ccb32ddcfd7 8898a79ac628 2ccb32ddcfd7 8898a79ac628 8898a79ac628 2ccb32ddcfd7 2ccb32ddcfd7 | import traceback
import logging
from rhodecode.controllers.api import JSONRPCController, JSONRPCError
from rhodecode.lib.auth import HasPermissionAllDecorator, HasPermissionAnyDecorator
from rhodecode.model.scm import ScmModel
from rhodecode.model.db import User, UsersGroup, Group, Repository
from rhodecode.model.repo import RepoModel
from rhodecode.model.user import UserModel
from rhodecode.model.repo_permission import RepositoryPermissionModel
from rhodecode.model.users_group import UsersGroupModel
from rhodecode.model import users_group
from rhodecode.model.repos_group import ReposGroupModel
from sqlalchemy.orm.exc import NoResultFound
log = logging.getLogger( __name__ )
class ApiController( JSONRPCController ):
"""
API Controller
Each method needs to have USER as argument this is then based on given
API_KEY propagated as instance of user object
Preferably this should be first argument also
Each function should also **raise** JSONRPCError for any
errors that happens
"""
@HasPermissionAllDecorator( 'hg.admin' )
def pull( self, apiuser, repo ):
"""
Dispatch pull action on given repo
:param user:
:param repo:
"""
if Repository.is_valid( repo ) is False:
raise JSONRPCError( 'Unknown repo "%s"' % repo )
try:
ScmModel().pull_changes( repo, self.rhodecode_user.username )
return 'Pulled from %s' % repo
except Exception:
raise JSONRPCError( 'Unable to pull changes from "%s"' % repo )
@HasPermissionAllDecorator( 'hg.admin' )
def get_user( self, apiuser, username ):
""""
Get a user by username
:param apiuser
:param username
"""
user = User.get_by_username( username )
if not user:
return None
return dict( id = user.user_id,
username = user.username,
firstname = user.name,
lastname = user.lastname,
email = user.email,
active = user.active,
admin = user.admin,
ldap = user.ldap_dn )
@HasPermissionAllDecorator( 'hg.admin' )
def get_users( self, apiuser ):
""""
Get all users
:param apiuser
"""
result = []
for user in User.getAll():
result.append( dict( id = user.user_id,
username = user.username,
firstname = user.name,
lastname = user.lastname,
email = user.email,
active = user.active,
admin = user.admin,
ldap = user.ldap_dn ) )
return result
@HasPermissionAllDecorator( 'hg.admin' )
def create_user( self, apiuser, username, password, firstname,
lastname, email, active = True, admin = False, ldap_dn = None ):
"""
Create new user
:param apiuser:
:param username:
:param password:
:param name:
:param lastname:
:param email:
:param active:
:param admin:
:param ldap_dn:
"""
if self.get_user( apiuser, username ):
raise JSONRPCError( "user %s already exist" % username )
try:
form_data = dict( username = username,
password = password,
active = active,
admin = admin,
name = firstname,
lastname = lastname,
email = email,
ldap_dn = ldap_dn )
UserModel().create_ldap( username, password, ldap_dn, form_data )
return dict( msg = 'created new user %s' % username )
except Exception:
log.error( traceback.format_exc() )
raise JSONRPCError( 'failed to create user %s' % username )
@HasPermissionAllDecorator( 'hg.admin' )
def get_users_group( self, apiuser, group_name ):
""""
Get users group by name
:param apiuser
:param group_name
"""
users_group = UsersGroup.get_by_group_name( group_name )
if not users_group:
return None
members = []
for user in users_group.members:
user = user.user
members.append( dict( id = user.user_id,
username = user.username,
firstname = user.name,
lastname = user.lastname,
email = user.email,
active = user.active,
admin = user.admin,
ldap = user.ldap_dn ) )
return dict( id = users_group.users_group_id,
name = users_group.users_group_name,
active = users_group.users_group_active,
members = members )
@HasPermissionAllDecorator( 'hg.admin' )
def get_users_groups( self, apiuser ):
""""
Get all users groups
:param apiuser
"""
result = []
for users_group in UsersGroup.getAll():
members = []
for user in users_group.members:
user = user.user
members.append( dict( id = user.user_id,
username = user.username,
firstname = user.name,
lastname = user.lastname,
email = user.email,
active = user.active,
admin = user.admin,
ldap = user.ldap_dn ) )
result.append( dict( id = users_group.users_group_id,
name = users_group.users_group_name,
active = users_group.users_group_active,
members = members ) )
return result
@HasPermissionAllDecorator( 'hg.admin' )
def create_users_group( self, apiuser, name, active = True ):
"""
Creates an new usergroup
:param name:
:param active:
"""
if self.get_users_group( apiuser, name ):
raise JSONRPCError( "users group %s already exist" % name )
try:
form_data = dict( users_group_name = name,
users_group_active = active )
ug = UsersGroup.create( form_data )
return dict( id = ug.users_group_id,
msg = 'created new users group %s' % name )
except Exception:
log.error( traceback.format_exc() )
raise JSONRPCError( 'failed to create group %s' % name )
@HasPermissionAllDecorator( 'hg.admin' )
def add_user_to_users_group( self, apiuser, group_name, user_name ):
""""
Add a user to a group
:param apiuser
:param group_name
:param user_name
"""
try:
users_group = UsersGroup.get_by_group_name( group_name )
if not users_group:
raise JSONRPCError( 'unknown users group %s' % group_name )
try:
user = User.get_by_username( user_name )
except NoResultFound:
raise JSONRPCError( 'unknown user %s' % user_name )
ugm = UsersGroupModel().add_user_to_group( users_group, user )
return dict( id = ugm.users_group_member_id,
msg = 'created new users group member' )
except Exception:
log.error( traceback.format_exc() )
raise JSONRPCError( 'failed to create users group member' )
@HasPermissionAnyDecorator( 'hg.admin' )
def get_repo( self, apiuser, repo_name ):
""""
Get repository by name
:param apiuser
:param repo_name
"""
try:
repo = Repository.get_by_repo_name( repo_name )
except NoResultFound:
return None
members = []
for user in repo.repo_to_perm:
perm = user.permission.permission_name
user = user.user
members.append( dict( type_ = "user",
id = user.user_id,
username = user.username,
firstname = user.name,
lastname = user.lastname,
email = user.email,
active = user.active,
admin = user.admin,
ldap = user.ldap_dn,
permission = perm ) )
for users_group in repo.users_group_to_perm:
perm = users_group.permission.permission_name
users_group = users_group.users_group
members.append( dict( type_ = "users_group",
id = users_group.users_group_id,
name = users_group.users_group_name,
active = users_group.users_group_active,
permission = perm ) )
return dict( id = repo.repo_id,
name = repo.repo_name,
type = repo.repo_type,
description = repo.description,
members = members )
@HasPermissionAnyDecorator( 'hg.admin' )
def get_repos( self, apiuser ):
""""
Get all repositories
:param apiuser
"""
result = []
for repository in Repository.getAll():
result.append( dict( id = repository.repo_id,
name = repository.repo_name,
type = repository.repo_type,
description = repository.description ) )
return result
@HasPermissionAnyDecorator( 'hg.admin', 'hg.create.repository' )
def create_repo( self, apiuser, name, owner_name, description = '', repo_type = 'hg', \
private = False ):
"""
Create a repository
:param apiuser
:param name
:param description
:param type
:param private
:param owner_name
"""
try:
try:
owner = User.get_by_username( owner_name )
except NoResultFound:
raise JSONRPCError( 'unknown user %s' % owner )
if self.get_repo( apiuser, name ):
raise JSONRPCError( "repo %s already exist" % name )
groups = name.split( '/' )
real_name = groups[-1]
groups = groups[:-1]
parent_id = None
for g in groups:
group = Group.get_by_group_name( g )
if not group:
group = ReposGroupModel().create( dict( group_name = g,
group_description = '',
group_parent_id = parent_id ) )
parent_id = group.group_id
RepoModel().create( dict( repo_name = real_name,
repo_name_full = name,
description = description,
private = private,
repo_type = repo_type,
repo_group = parent_id,
clone_uri = None ), owner )
except Exception:
log.error( traceback.format_exc() )
raise JSONRPCError( 'failed to create repository %s' % name )
@HasPermissionAnyDecorator( 'hg.admin' )
def add_user_to_repo( self, apiuser, repo_name, user_name, perm ):
"""
Add permission for a user to a repository
:param apiuser
:param repo_name
:param user_name
:param perm
"""
try:
try:
repo = Repository.get_by_repo_name( repo_name )
except NoResultFound:
raise JSONRPCError( 'unknown repository %s' % repo )
try:
user = User.get_by_username( user_name )
except NoResultFound:
raise JSONRPCError( 'unknown user %s' % user )
RepositoryPermissionModel().updateOrDeleteUserPermission( repo, user, perm )
except Exception:
log.error( traceback.format_exc() )
raise JSONRPCError( 'failed to edit permission %(repo)s for %(user)s'
% dict( user = user_name, repo = repo_name ) )
|