##// END OF EJS Templates
caches: store computation time inside context manager as helper. Since the with block is full...
marcink -
r2936:776b3361 default
parent child Browse files
Show More
@@ -1,244 +1,242 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2017-2018 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 import time
21 20 import pytz
22 21 import logging
23 22
24 23 from pyramid.view import view_config
25 24 from pyramid.response import Response
26 25 from webhelpers.feedgenerator import Rss201rev2Feed, Atom1Feed
27 26
28 27 from rhodecode.apps._base import RepoAppView
29 28 from rhodecode.lib import audit_logger
30 29 from rhodecode.lib import rc_cache
31 30 from rhodecode.lib import helpers as h
32 31 from rhodecode.lib.auth import (
33 32 LoginRequired, HasRepoPermissionAnyDecorator)
34 33 from rhodecode.lib.diffs import DiffProcessor, LimitedDiffContainer
35 34 from rhodecode.lib.utils2 import str2bool, safe_int, md5_safe
36 35 from rhodecode.model.db import UserApiKeys, CacheKey
37 36
38 37 log = logging.getLogger(__name__)
39 38
40 39
41 40 class RepoFeedView(RepoAppView):
42 41 def load_default_context(self):
43 42 c = self._get_local_tmpl_context()
44 43
45 44
46 45 self._load_defaults()
47 46 return c
48 47
49 48 def _get_config(self):
50 49 import rhodecode
51 50 config = rhodecode.CONFIG
52 51
53 52 return {
54 53 'language': 'en-us',
55 54 'feed_ttl': '5', # TTL of feed,
56 55 'feed_include_diff':
57 56 str2bool(config.get('rss_include_diff', False)),
58 57 'feed_items_per_page':
59 58 safe_int(config.get('rss_items_per_page', 20)),
60 59 'feed_diff_limit':
61 60 # we need to protect from parsing huge diffs here other way
62 61 # we can kill the server
63 62 safe_int(config.get('rss_cut_off_limit', 32 * 1024)),
64 63 }
65 64
66 65 def _load_defaults(self):
67 66 _ = self.request.translate
68 67 config = self._get_config()
69 68 # common values for feeds
70 69 self.description = _('Changes on %s repository')
71 70 self.title = self.title = _('%s %s feed') % (self.db_repo_name, '%s')
72 71 self.language = config["language"]
73 72 self.ttl = config["feed_ttl"]
74 73 self.feed_include_diff = config['feed_include_diff']
75 74 self.feed_diff_limit = config['feed_diff_limit']
76 75 self.feed_items_per_page = config['feed_items_per_page']
77 76
78 77 def _changes(self, commit):
79 78 diff_processor = DiffProcessor(
80 79 commit.diff(), diff_limit=self.feed_diff_limit)
81 80 _parsed = diff_processor.prepare(inline_diff=False)
82 81 limited_diff = isinstance(_parsed, LimitedDiffContainer)
83 82
84 83 return diff_processor, _parsed, limited_diff
85 84
86 85 def _get_title(self, commit):
87 86 return h.shorter(commit.message, 160)
88 87
89 88 def _get_description(self, commit):
90 89 _renderer = self.request.get_partial_renderer(
91 90 'rhodecode:templates/feed/atom_feed_entry.mako')
92 91 diff_processor, parsed_diff, limited_diff = self._changes(commit)
93 92 filtered_parsed_diff, has_hidden_changes = self.path_filter.filter_patchset(parsed_diff)
94 93 return _renderer(
95 94 'body',
96 95 commit=commit,
97 96 parsed_diff=filtered_parsed_diff,
98 97 limited_diff=limited_diff,
99 98 feed_include_diff=self.feed_include_diff,
100 99 diff_processor=diff_processor,
101 100 has_hidden_changes=has_hidden_changes
102 101 )
103 102
104 103 def _set_timezone(self, date, tzinfo=pytz.utc):
105 104 if not getattr(date, "tzinfo", None):
106 105 date.replace(tzinfo=tzinfo)
107 106 return date
108 107
109 108 def _get_commits(self):
110 109 return list(self.rhodecode_vcs_repo[-self.feed_items_per_page:])
111 110
112 111 def uid(self, repo_id, commit_id):
113 112 return '{}:{}'.format(md5_safe(repo_id), md5_safe(commit_id))
114 113
115 114 @LoginRequired(auth_token_access=[UserApiKeys.ROLE_FEED])
116 115 @HasRepoPermissionAnyDecorator(
117 116 'repository.read', 'repository.write', 'repository.admin')
118 117 @view_config(
119 118 route_name='atom_feed_home', request_method='GET',
120 119 renderer=None)
121 120 def atom(self):
122 121 """
123 122 Produce an atom-1.0 feed via feedgenerator module
124 123 """
125 124 self.load_default_context()
126 125
127 126 cache_namespace_uid = 'cache_repo_instance.{}_{}'.format(
128 127 self.db_repo.repo_id, CacheKey.CACHE_TYPE_FEED)
129 128 invalidation_namespace = CacheKey.REPO_INVALIDATION_NAMESPACE.format(
130 129 repo_id=self.db_repo.repo_id)
131 130
132 131 region = rc_cache.get_or_create_region('cache_repo_longterm',
133 132 cache_namespace_uid)
134 133
135 134 condition = not self.path_filter.is_enabled
136 135
137 136 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid,
138 137 condition=condition)
139 138 def generate_atom_feed(repo_id, _repo_name, _feed_type):
140 139 feed = Atom1Feed(
141 140 title=self.title % _repo_name,
142 141 link=h.route_url('repo_summary', repo_name=_repo_name),
143 142 description=self.description % _repo_name,
144 143 language=self.language,
145 144 ttl=self.ttl
146 145 )
147 146
148 147 for commit in reversed(self._get_commits()):
149 148 date = self._set_timezone(commit.date)
150 149 feed.add_item(
151 150 unique_id=self.uid(repo_id, commit.raw_id),
152 151 title=self._get_title(commit),
153 152 author_name=commit.author,
154 153 description=self._get_description(commit),
155 154 link=h.route_url(
156 155 'repo_commit', repo_name=_repo_name,
157 156 commit_id=commit.raw_id),
158 157 pubdate=date,)
159 158
160 159 return feed.mime_type, feed.writeString('utf-8')
161 160
162 start = time.time()
163 161 inv_context_manager = rc_cache.InvalidationContext(
164 162 uid=cache_namespace_uid, invalidation_namespace=invalidation_namespace)
165 163 with inv_context_manager as invalidation_context:
166 164 # check for stored invalidation signal, and maybe purge the cache
167 165 # before computing it again
168 166 if invalidation_context.should_invalidate():
169 167 generate_atom_feed.invalidate(
170 168 self.db_repo.repo_id, self.db_repo.repo_name, 'atom')
171 169
172 170 mime_type, feed = generate_atom_feed(
173 171 self.db_repo.repo_id, self.db_repo.repo_name, 'atom')
174 compute_time = time.time() - start
175 log.debug('Repo ATOM feed computed in %.3fs', compute_time)
172
173 log.debug('Repo ATOM feed computed in %.3fs',
174 inv_context_manager.compute_time)
176 175
177 176 response = Response(feed)
178 177 response.content_type = mime_type
179 178 return response
180 179
181 180 @LoginRequired(auth_token_access=[UserApiKeys.ROLE_FEED])
182 181 @HasRepoPermissionAnyDecorator(
183 182 'repository.read', 'repository.write', 'repository.admin')
184 183 @view_config(
185 184 route_name='rss_feed_home', request_method='GET',
186 185 renderer=None)
187 186 def rss(self):
188 187 """
189 188 Produce an rss2 feed via feedgenerator module
190 189 """
191 190 self.load_default_context()
192 191
193 192 cache_namespace_uid = 'cache_repo_instance.{}_{}'.format(
194 193 self.db_repo.repo_id, CacheKey.CACHE_TYPE_FEED)
195 194 invalidation_namespace = CacheKey.REPO_INVALIDATION_NAMESPACE.format(
196 195 repo_id=self.db_repo.repo_id)
197 196 region = rc_cache.get_or_create_region('cache_repo_longterm',
198 197 cache_namespace_uid)
199 198
200 199 condition = not self.path_filter.is_enabled
201 200
202 201 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid,
203 202 condition=condition)
204 203 def generate_rss_feed(repo_id, _repo_name, _feed_type):
205 204 feed = Rss201rev2Feed(
206 205 title=self.title % _repo_name,
207 206 link=h.route_url('repo_summary', repo_name=_repo_name),
208 207 description=self.description % _repo_name,
209 208 language=self.language,
210 209 ttl=self.ttl
211 210 )
212 211
213 212 for commit in reversed(self._get_commits()):
214 213 date = self._set_timezone(commit.date)
215 214 feed.add_item(
216 215 unique_id=self.uid(repo_id, commit.raw_id),
217 216 title=self._get_title(commit),
218 217 author_name=commit.author,
219 218 description=self._get_description(commit),
220 219 link=h.route_url(
221 220 'repo_commit', repo_name=_repo_name,
222 221 commit_id=commit.raw_id),
223 222 pubdate=date,)
224 223
225 224 return feed.mime_type, feed.writeString('utf-8')
226 225
227 start = time.time()
228 226 inv_context_manager = rc_cache.InvalidationContext(
229 227 uid=cache_namespace_uid, invalidation_namespace=invalidation_namespace)
230 228 with inv_context_manager as invalidation_context:
231 229 # check for stored invalidation signal, and maybe purge the cache
232 230 # before computing it again
233 231 if invalidation_context.should_invalidate():
234 232 generate_rss_feed.invalidate(
235 233 self.db_repo.repo_id, self.db_repo.repo_name, 'rss')
236 234
237 235 mime_type, feed = generate_rss_feed(
238 236 self.db_repo.repo_id, self.db_repo.repo_name, 'rss')
239 compute_time = time.time() - start
240 log.debug('Repo RSS feed computed in %.3fs', compute_time)
237 log.debug(
238 'Repo RSS feed computed in %.3fs', inv_context_manager.compute_time)
241 239
242 240 response = Response(feed)
243 241 response.content_type = mime_type
244 242 return response
@@ -1,392 +1,392 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2011-2018 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 import time
22 21 import logging
23 22 import string
24 23 import rhodecode
25 24
26 25 from pyramid.view import view_config
27 26
28 27 from rhodecode.controllers import utils
29 28 from rhodecode.apps._base import RepoAppView
30 29 from rhodecode.config.conf import (LANGUAGES_EXTENSIONS_MAP)
31 30 from rhodecode.lib import helpers as h, rc_cache
32 31 from rhodecode.lib.utils2 import safe_str, safe_int
33 32 from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAnyDecorator
34 33 from rhodecode.lib.markup_renderer import MarkupRenderer, relative_links
35 34 from rhodecode.lib.ext_json import json
36 35 from rhodecode.lib.vcs.backends.base import EmptyCommit
37 36 from rhodecode.lib.vcs.exceptions import (
38 37 CommitError, EmptyRepositoryError, CommitDoesNotExistError)
39 38 from rhodecode.model.db import Statistics, CacheKey, User
40 39 from rhodecode.model.meta import Session
41 40 from rhodecode.model.repo import ReadmeFinder
42 41 from rhodecode.model.scm import ScmModel
43 42
44 43 log = logging.getLogger(__name__)
45 44
46 45
47 46 class RepoSummaryView(RepoAppView):
48 47
49 48 def load_default_context(self):
50 49 c = self._get_local_tmpl_context(include_app_defaults=True)
51 50 c.rhodecode_repo = None
52 51 if not c.repository_requirements_missing:
53 52 c.rhodecode_repo = self.rhodecode_vcs_repo
54 53 return c
55 54
56 55 def _get_readme_data(self, db_repo, renderer_type):
57 56
58 57 log.debug('Looking for README file')
59 58
60 59 cache_namespace_uid = 'cache_repo_instance.{}_{}'.format(
61 60 db_repo.repo_id, CacheKey.CACHE_TYPE_README)
62 61 invalidation_namespace = CacheKey.REPO_INVALIDATION_NAMESPACE.format(
63 62 repo_id=self.db_repo.repo_id)
64 63 region = rc_cache.get_or_create_region('cache_repo_longterm', cache_namespace_uid)
65 64
66 65 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid)
67 66 def generate_repo_readme(repo_id, _repo_name, _renderer_type):
68 67 readme_data = None
69 68 readme_node = None
70 69 readme_filename = None
71 70 commit = self._get_landing_commit_or_none(db_repo)
72 71 if commit:
73 72 log.debug("Searching for a README file.")
74 73 readme_node = ReadmeFinder(_renderer_type).search(commit)
75 74 if readme_node:
76 75 relative_urls = {
77 76 'raw': h.route_path(
78 77 'repo_file_raw', repo_name=_repo_name,
79 78 commit_id=commit.raw_id, f_path=readme_node.path),
80 79 'standard': h.route_path(
81 80 'repo_files', repo_name=_repo_name,
82 81 commit_id=commit.raw_id, f_path=readme_node.path),
83 82 }
84 83 readme_data = self._render_readme_or_none(
85 84 commit, readme_node, relative_urls)
86 85 readme_filename = readme_node.path
87 86 return readme_data, readme_filename
88 87
89 start = time.time()
90 88 inv_context_manager = rc_cache.InvalidationContext(
91 89 uid=cache_namespace_uid, invalidation_namespace=invalidation_namespace)
92 90 with inv_context_manager as invalidation_context:
93 91 # check for stored invalidation signal, and maybe purge the cache
94 92 # before computing it again
95 93 if invalidation_context.should_invalidate():
96 94 generate_repo_readme.invalidate(
97 95 db_repo.repo_id, db_repo.repo_name, renderer_type)
98 96
99 97 instance = generate_repo_readme(
100 98 db_repo.repo_id, db_repo.repo_name, renderer_type)
101 compute_time = time.time() - start
102 log.debug('Repo readme generated and computed in %.3fs', compute_time)
99
100 log.debug(
101 'Repo readme generated and computed in %.3fs',
102 inv_context_manager.compute_time)
103 103 return instance
104 104
105 105 def _get_landing_commit_or_none(self, db_repo):
106 106 log.debug("Getting the landing commit.")
107 107 try:
108 108 commit = db_repo.get_landing_commit()
109 109 if not isinstance(commit, EmptyCommit):
110 110 return commit
111 111 else:
112 112 log.debug("Repository is empty, no README to render.")
113 113 except CommitError:
114 114 log.exception(
115 115 "Problem getting commit when trying to render the README.")
116 116
117 117 def _render_readme_or_none(self, commit, readme_node, relative_urls):
118 118 log.debug(
119 119 'Found README file `%s` rendering...', readme_node.path)
120 120 renderer = MarkupRenderer()
121 121 try:
122 122 html_source = renderer.render(
123 123 readme_node.content, filename=readme_node.path)
124 124 if relative_urls:
125 125 return relative_links(html_source, relative_urls)
126 126 return html_source
127 127 except Exception:
128 128 log.exception(
129 129 "Exception while trying to render the README")
130 130
131 131 def _load_commits_context(self, c):
132 132 p = safe_int(self.request.GET.get('page'), 1)
133 133 size = safe_int(self.request.GET.get('size'), 10)
134 134
135 135 def url_generator(**kw):
136 136 query_params = {
137 137 'size': size
138 138 }
139 139 query_params.update(kw)
140 140 return h.route_path(
141 141 'repo_summary_commits',
142 142 repo_name=c.rhodecode_db_repo.repo_name, _query=query_params)
143 143
144 144 pre_load = ['author', 'branch', 'date', 'message']
145 145 try:
146 146 collection = self.rhodecode_vcs_repo.get_commits(pre_load=pre_load)
147 147 except EmptyRepositoryError:
148 148 collection = self.rhodecode_vcs_repo
149 149
150 150 c.repo_commits = h.RepoPage(
151 151 collection, page=p, items_per_page=size, url=url_generator)
152 152 page_ids = [x.raw_id for x in c.repo_commits]
153 153 c.comments = self.db_repo.get_comments(page_ids)
154 154 c.statuses = self.db_repo.statuses(page_ids)
155 155
156 156 @LoginRequired()
157 157 @HasRepoPermissionAnyDecorator(
158 158 'repository.read', 'repository.write', 'repository.admin')
159 159 @view_config(
160 160 route_name='repo_summary_commits', request_method='GET',
161 161 renderer='rhodecode:templates/summary/summary_commits.mako')
162 162 def summary_commits(self):
163 163 c = self.load_default_context()
164 164 self._load_commits_context(c)
165 165 return self._get_template_context(c)
166 166
167 167 @LoginRequired()
168 168 @HasRepoPermissionAnyDecorator(
169 169 'repository.read', 'repository.write', 'repository.admin')
170 170 @view_config(
171 171 route_name='repo_summary', request_method='GET',
172 172 renderer='rhodecode:templates/summary/summary.mako')
173 173 @view_config(
174 174 route_name='repo_summary_slash', request_method='GET',
175 175 renderer='rhodecode:templates/summary/summary.mako')
176 176 @view_config(
177 177 route_name='repo_summary_explicit', request_method='GET',
178 178 renderer='rhodecode:templates/summary/summary.mako')
179 179 def summary(self):
180 180 c = self.load_default_context()
181 181
182 182 # Prepare the clone URL
183 183 username = ''
184 184 if self._rhodecode_user.username != User.DEFAULT_USER:
185 185 username = safe_str(self._rhodecode_user.username)
186 186
187 187 _def_clone_uri = _def_clone_uri_id = c.clone_uri_tmpl
188 188 _def_clone_uri_ssh = c.clone_uri_ssh_tmpl
189 189
190 190 if '{repo}' in _def_clone_uri:
191 191 _def_clone_uri_id = _def_clone_uri.replace(
192 192 '{repo}', '_{repoid}')
193 193 elif '{repoid}' in _def_clone_uri:
194 194 _def_clone_uri_id = _def_clone_uri.replace(
195 195 '_{repoid}', '{repo}')
196 196
197 197 c.clone_repo_url = self.db_repo.clone_url(
198 198 user=username, uri_tmpl=_def_clone_uri)
199 199 c.clone_repo_url_id = self.db_repo.clone_url(
200 200 user=username, uri_tmpl=_def_clone_uri_id)
201 201 c.clone_repo_url_ssh = self.db_repo.clone_url(
202 202 uri_tmpl=_def_clone_uri_ssh, ssh=True)
203 203
204 204 # If enabled, get statistics data
205 205
206 206 c.show_stats = bool(self.db_repo.enable_statistics)
207 207
208 208 stats = Session().query(Statistics) \
209 209 .filter(Statistics.repository == self.db_repo) \
210 210 .scalar()
211 211
212 212 c.stats_percentage = 0
213 213
214 214 if stats and stats.languages:
215 215 c.no_data = False is self.db_repo.enable_statistics
216 216 lang_stats_d = json.loads(stats.languages)
217 217
218 218 # Sort first by decreasing count and second by the file extension,
219 219 # so we have a consistent output.
220 220 lang_stats_items = sorted(lang_stats_d.iteritems(),
221 221 key=lambda k: (-k[1], k[0]))[:10]
222 222 lang_stats = [(x, {"count": y,
223 223 "desc": LANGUAGES_EXTENSIONS_MAP.get(x)})
224 224 for x, y in lang_stats_items]
225 225
226 226 c.trending_languages = json.dumps(lang_stats)
227 227 else:
228 228 c.no_data = True
229 229 c.trending_languages = json.dumps({})
230 230
231 231 scm_model = ScmModel()
232 232 c.enable_downloads = self.db_repo.enable_downloads
233 233 c.repository_followers = scm_model.get_followers(self.db_repo)
234 234 c.repository_forks = scm_model.get_forks(self.db_repo)
235 235 c.repository_is_user_following = scm_model.is_following_repo(
236 236 self.db_repo_name, self._rhodecode_user.user_id)
237 237
238 238 # first interaction with the VCS instance after here...
239 239 if c.repository_requirements_missing:
240 240 self.request.override_renderer = \
241 241 'rhodecode:templates/summary/missing_requirements.mako'
242 242 return self._get_template_context(c)
243 243
244 244 c.readme_data, c.readme_file = \
245 245 self._get_readme_data(self.db_repo, c.visual.default_renderer)
246 246
247 247 # loads the summary commits template context
248 248 self._load_commits_context(c)
249 249
250 250 return self._get_template_context(c)
251 251
252 252 def get_request_commit_id(self):
253 253 return self.request.matchdict['commit_id']
254 254
255 255 @LoginRequired()
256 256 @HasRepoPermissionAnyDecorator(
257 257 'repository.read', 'repository.write', 'repository.admin')
258 258 @view_config(
259 259 route_name='repo_stats', request_method='GET',
260 260 renderer='json_ext')
261 261 def repo_stats(self):
262 262 commit_id = self.get_request_commit_id()
263 263 show_stats = bool(self.db_repo.enable_statistics)
264 264 repo_id = self.db_repo.repo_id
265 265
266 266 cache_seconds = safe_int(
267 267 rhodecode.CONFIG.get('rc_cache.cache_repo.expiration_time'))
268 268 cache_on = cache_seconds > 0
269 269 log.debug(
270 270 'Computing REPO TREE for repo_id %s commit_id `%s` '
271 271 'with caching: %s[TTL: %ss]' % (
272 272 repo_id, commit_id, cache_on, cache_seconds or 0))
273 273
274 274 cache_namespace_uid = 'cache_repo.{}'.format(repo_id)
275 275 region = rc_cache.get_or_create_region('cache_repo', cache_namespace_uid)
276 276
277 277 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid,
278 278 condition=cache_on)
279 279 def compute_stats(repo_id, commit_id, show_stats):
280 280 code_stats = {}
281 281 size = 0
282 282 try:
283 283 scm_instance = self.db_repo.scm_instance()
284 284 commit = scm_instance.get_commit(commit_id)
285 285
286 286 for node in commit.get_filenodes_generator():
287 287 size += node.size
288 288 if not show_stats:
289 289 continue
290 290 ext = string.lower(node.extension)
291 291 ext_info = LANGUAGES_EXTENSIONS_MAP.get(ext)
292 292 if ext_info:
293 293 if ext in code_stats:
294 294 code_stats[ext]['count'] += 1
295 295 else:
296 296 code_stats[ext] = {"count": 1, "desc": ext_info}
297 297 except (EmptyRepositoryError, CommitDoesNotExistError):
298 298 pass
299 299 return {'size': h.format_byte_size_binary(size),
300 300 'code_stats': code_stats}
301 301
302 302 stats = compute_stats(self.db_repo.repo_id, commit_id, show_stats)
303 303 return stats
304 304
305 305 @LoginRequired()
306 306 @HasRepoPermissionAnyDecorator(
307 307 'repository.read', 'repository.write', 'repository.admin')
308 308 @view_config(
309 309 route_name='repo_refs_data', request_method='GET',
310 310 renderer='json_ext')
311 311 def repo_refs_data(self):
312 312 _ = self.request.translate
313 313 self.load_default_context()
314 314
315 315 repo = self.rhodecode_vcs_repo
316 316 refs_to_create = [
317 317 (_("Branch"), repo.branches, 'branch'),
318 318 (_("Tag"), repo.tags, 'tag'),
319 319 (_("Bookmark"), repo.bookmarks, 'book'),
320 320 ]
321 321 res = self._create_reference_data(
322 322 repo, self.db_repo_name, refs_to_create)
323 323 data = {
324 324 'more': False,
325 325 'results': res
326 326 }
327 327 return data
328 328
329 329 @LoginRequired()
330 330 @HasRepoPermissionAnyDecorator(
331 331 'repository.read', 'repository.write', 'repository.admin')
332 332 @view_config(
333 333 route_name='repo_refs_changelog_data', request_method='GET',
334 334 renderer='json_ext')
335 335 def repo_refs_changelog_data(self):
336 336 _ = self.request.translate
337 337 self.load_default_context()
338 338
339 339 repo = self.rhodecode_vcs_repo
340 340
341 341 refs_to_create = [
342 342 (_("Branches"), repo.branches, 'branch'),
343 343 (_("Closed branches"), repo.branches_closed, 'branch_closed'),
344 344 # TODO: enable when vcs can handle bookmarks filters
345 345 # (_("Bookmarks"), repo.bookmarks, "book"),
346 346 ]
347 347 res = self._create_reference_data(
348 348 repo, self.db_repo_name, refs_to_create)
349 349 data = {
350 350 'more': False,
351 351 'results': res
352 352 }
353 353 return data
354 354
355 355 def _create_reference_data(self, repo, full_repo_name, refs_to_create):
356 356 format_ref_id = utils.get_format_ref_id(repo)
357 357
358 358 result = []
359 359 for title, refs, ref_type in refs_to_create:
360 360 if refs:
361 361 result.append({
362 362 'text': title,
363 363 'children': self._create_reference_items(
364 364 repo, full_repo_name, refs, ref_type,
365 365 format_ref_id),
366 366 })
367 367 return result
368 368
369 369 def _create_reference_items(self, repo, full_repo_name, refs, ref_type,
370 370 format_ref_id):
371 371 result = []
372 372 is_svn = h.is_svn(repo)
373 373 for ref_name, raw_id in refs.iteritems():
374 374 files_url = self._create_files_url(
375 375 repo, full_repo_name, ref_name, raw_id, is_svn)
376 376 result.append({
377 377 'text': ref_name,
378 378 'id': format_ref_id(ref_name, raw_id),
379 379 'raw_id': raw_id,
380 380 'type': ref_type,
381 381 'files_url': files_url,
382 382 })
383 383 return result
384 384
385 385 def _create_files_url(self, repo, full_repo_name, ref_name, raw_id, is_svn):
386 386 use_commit_id = '/' in ref_name or is_svn
387 387 return h.route_path(
388 388 'repo_files',
389 389 repo_name=full_repo_name,
390 390 f_path=ref_name if is_svn else '',
391 391 commit_id=raw_id if use_commit_id else ref_name,
392 392 _query=dict(at=ref_name))
@@ -1,318 +1,319 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2015-2018 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20 import os
21 import time
21 22 import logging
22 23 import functools
23 24 import threading
24 25
25 26 from dogpile.cache import CacheRegion
26 27 from dogpile.cache.util import compat
27 28
28 29 import rhodecode
29 30 from rhodecode.lib.utils import safe_str, sha1
30 31 from rhodecode.lib.utils2 import safe_unicode, str2bool
31 32 from rhodecode.model.db import Session, CacheKey, IntegrityError
32 33
33 34 from . import region_meta
34 35
35 36 log = logging.getLogger(__name__)
36 37
37 38
38 39 class RhodeCodeCacheRegion(CacheRegion):
39 40
40 41 def conditional_cache_on_arguments(
41 42 self, namespace=None,
42 43 expiration_time=None,
43 44 should_cache_fn=None,
44 45 to_str=compat.string_type,
45 46 function_key_generator=None,
46 47 condition=True):
47 48 """
48 49 Custom conditional decorator, that will not touch any dogpile internals if
49 50 condition isn't meet. This works a bit different than should_cache_fn
50 51 And it's faster in cases we don't ever want to compute cached values
51 52 """
52 53 expiration_time_is_callable = compat.callable(expiration_time)
53 54
54 55 if function_key_generator is None:
55 56 function_key_generator = self.function_key_generator
56 57
57 58 def decorator(fn):
58 59 if to_str is compat.string_type:
59 60 # backwards compatible
60 61 key_generator = function_key_generator(namespace, fn)
61 62 else:
62 63 key_generator = function_key_generator(namespace, fn, to_str=to_str)
63 64
64 65 @functools.wraps(fn)
65 66 def decorate(*arg, **kw):
66 67 key = key_generator(*arg, **kw)
67 68
68 69 @functools.wraps(fn)
69 70 def creator():
70 71 return fn(*arg, **kw)
71 72
72 73 if not condition:
73 74 return creator()
74 75
75 76 timeout = expiration_time() if expiration_time_is_callable \
76 77 else expiration_time
77 78
78 79 return self.get_or_create(key, creator, timeout, should_cache_fn)
79 80
80 81 def invalidate(*arg, **kw):
81 82 key = key_generator(*arg, **kw)
82 83 self.delete(key)
83 84
84 85 def set_(value, *arg, **kw):
85 86 key = key_generator(*arg, **kw)
86 87 self.set(key, value)
87 88
88 89 def get(*arg, **kw):
89 90 key = key_generator(*arg, **kw)
90 91 return self.get(key)
91 92
92 93 def refresh(*arg, **kw):
93 94 key = key_generator(*arg, **kw)
94 95 value = fn(*arg, **kw)
95 96 self.set(key, value)
96 97 return value
97 98
98 99 decorate.set = set_
99 100 decorate.invalidate = invalidate
100 101 decorate.refresh = refresh
101 102 decorate.get = get
102 103 decorate.original = fn
103 104 decorate.key_generator = key_generator
104 105
105 106 return decorate
106 107
107 108 return decorator
108 109
109 110
110 111 def make_region(*arg, **kw):
111 112 return RhodeCodeCacheRegion(*arg, **kw)
112 113
113 114
114 115 def get_default_cache_settings(settings, prefixes=None):
115 116 prefixes = prefixes or []
116 117 cache_settings = {}
117 118 for key in settings.keys():
118 119 for prefix in prefixes:
119 120 if key.startswith(prefix):
120 121 name = key.split(prefix)[1].strip()
121 122 val = settings[key]
122 123 if isinstance(val, basestring):
123 124 val = val.strip()
124 125 cache_settings[name] = val
125 126 return cache_settings
126 127
127 128
128 129 def compute_key_from_params(*args):
129 130 """
130 131 Helper to compute key from given params to be used in cache manager
131 132 """
132 133 return sha1("_".join(map(safe_str, args)))
133 134
134 135
135 136 def key_generator(namespace, fn):
136 137 fname = fn.__name__
137 138
138 139 def generate_key(*args):
139 140 namespace_pref = namespace or 'default'
140 141 arg_key = compute_key_from_params(*args)
141 142 final_key = "{}:{}_{}".format(namespace_pref, fname, arg_key)
142 143
143 144 return final_key
144 145
145 146 return generate_key
146 147
147 148
148 149 def get_or_create_region(region_name, region_namespace=None):
149 150 from rhodecode.lib.rc_cache.backends import FileNamespaceBackend
150 151 region_obj = region_meta.dogpile_cache_regions.get(region_name)
151 152 if not region_obj:
152 153 raise EnvironmentError(
153 154 'Region `{}` not in configured: {}.'.format(
154 155 region_name, region_meta.dogpile_cache_regions.keys()))
155 156
156 157 region_uid_name = '{}:{}'.format(region_name, region_namespace)
157 158 if isinstance(region_obj.actual_backend, FileNamespaceBackend):
158 159 region_exist = region_meta.dogpile_cache_regions.get(region_namespace)
159 160 if region_exist:
160 161 log.debug('Using already configured region: %s', region_namespace)
161 162 return region_exist
162 163 cache_dir = region_meta.dogpile_config_defaults['cache_dir']
163 164 expiration_time = region_obj.expiration_time
164 165
165 166 if not os.path.isdir(cache_dir):
166 167 os.makedirs(cache_dir)
167 168 new_region = make_region(
168 169 name=region_uid_name, function_key_generator=key_generator
169 170 )
170 171 namespace_filename = os.path.join(
171 172 cache_dir, "{}.cache.dbm".format(region_namespace))
172 173 # special type that allows 1db per namespace
173 174 new_region.configure(
174 175 backend='dogpile.cache.rc.file_namespace',
175 176 expiration_time=expiration_time,
176 177 arguments={"filename": namespace_filename}
177 178 )
178 179
179 180 # create and save in region caches
180 181 log.debug('configuring new region: %s',region_uid_name)
181 182 region_obj = region_meta.dogpile_cache_regions[region_namespace] = new_region
182 183
183 184 return region_obj
184 185
185 186
186 187 def clear_cache_namespace(cache_region, cache_namespace_uid):
187 188 region = get_or_create_region(cache_region, cache_namespace_uid)
188 189 cache_keys = region.backend.list_keys(prefix=cache_namespace_uid)
189 190 region.delete_multi(cache_keys)
190 191 return len(cache_keys)
191 192
192 193
193 194 class ActiveRegionCache(object):
194 195 def __init__(self, context):
195 196 self.context = context
196 197
197 198 def should_invalidate(self):
198 199 return False
199 200
200 201
201 202 class FreshRegionCache(object):
202 203 def __init__(self, context):
203 204 self.context = context
204 205
205 206 def should_invalidate(self):
206 207 return True
207 208
208 209
209 210 class InvalidationContext(object):
210 211 """
211 212 usage::
212 213
213 import time
214 214 from rhodecode.lib import rc_cache
215 my_id = 1
216 cache_namespace_uid = 'cache_demo.{}'.format(my_id)
217 invalidation_namespace = 'repo_cache:1'
215
216 cache_namespace_uid = CacheKey.SOME_NAMESPACE.format(1)
218 217 region = rc_cache.get_or_create_region('cache_perms', cache_namespace_uid)
219 218
220 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid,
221 expiration_time=30,
222 condition=True)
219 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid, condition=True)
223 220 def heavy_compute(cache_name, param1, param2):
224 221 print('COMPUTE {}, {}, {}'.format(cache_name, param1, param2))
225 import time
226 time.sleep(30)
227 return True
228 222
229 start = time.time()
223 # invalidation namespace is shared namespace key for all process caches
224 # we use it to send a global signal
225 invalidation_namespace = 'repo_cache:1'
226
230 227 inv_context_manager = rc_cache.InvalidationContext(
231 228 uid=cache_namespace_uid, invalidation_namespace=invalidation_namespace)
232 229 with inv_context_manager as invalidation_context:
233 230 # check for stored invalidation signal, and maybe purge the cache
234 231 # before computing it again
235 232 if invalidation_context.should_invalidate():
236 233 heavy_compute.invalidate('some_name', 'param1', 'param2')
237 234
238 235 result = heavy_compute('some_name', 'param1', 'param2')
239 compute_time = time.time() - start
236 compute_time = inv_context_manager.compute_time
240 237 print(compute_time)
241 238
242 239 # To send global invalidation signal, simply run
243 240 CacheKey.set_invalidate(invalidation_namespace)
244 241
245 242 """
246 243
247 244 def __repr__(self):
248 245 return '<InvalidationContext:{}[{}]>'.format(
249 246 safe_str(self.cache_key), safe_str(self.uid))
250 247
251 248 def __init__(self, uid, invalidation_namespace='',
252 249 raise_exception=False, thread_scoped=None):
253 250 self.uid = uid
254 251 self.invalidation_namespace = invalidation_namespace
255 252 self.raise_exception = raise_exception
256 253 self.proc_id = safe_unicode(rhodecode.CONFIG.get('instance_id') or 'DEFAULT')
257 254 self.thread_id = 'global'
258 255
259 256 if thread_scoped is None:
260 257 # if we set "default" we can override this via .ini settings
261 258 thread_scoped = str2bool(rhodecode.CONFIG.get('cache_thread_scoped'))
262 259
263 260 # Append the thread id to the cache key if this invalidation context
264 261 # should be scoped to the current thread.
265 262 if thread_scoped is True:
266 263 self.thread_id = threading.current_thread().ident
267 264
268 265 self.cache_key = compute_key_from_params(uid)
269 266 self.cache_key = 'proc:{}_thread:{}_{}'.format(
270 267 self.proc_id, self.thread_id, self.cache_key)
268 self.compute_time = 0
271 269
272 270 def get_or_create_cache_obj(self, uid, invalidation_namespace=''):
273 271 log.debug('Checking if %s cache key is present and active', self.cache_key)
274 272 cache_obj = CacheKey.get_active_cache(self.cache_key)
275 273 invalidation_namespace = invalidation_namespace or self.invalidation_namespace
276 274 if not cache_obj:
277 275 cache_obj = CacheKey(self.cache_key, cache_args=invalidation_namespace)
278 276 return cache_obj
279 277
280 278 def __enter__(self):
281 279 """
282 280 Test if current object is valid, and return CacheRegion function
283 281 that does invalidation and calculation
284 282 """
285 283 # register or get a new key based on uid
286 284 self.cache_obj = self.get_or_create_cache_obj(uid=self.uid)
287
285 self._start_time = time.time()
288 286 if self.cache_obj.cache_active:
289 287 # means our cache obj is existing and marked as it's
290 288 # cache is not outdated, we return ActiveRegionCache
291 289 self.skip_cache_active_change = True
290
292 291 return ActiveRegionCache(context=self)
293 292
294 # the key is either not existing or set to False, we return
293 # the key is either not existing or set to False, we return
295 294 # the real invalidator which re-computes value. We additionally set
296 295 # the flag to actually update the Database objects
297 296 self.skip_cache_active_change = False
298 297 return FreshRegionCache(context=self)
299 298
300 299 def __exit__(self, exc_type, exc_val, exc_tb):
300 # save compute time
301 self.compute_time = time.time() - self._start_time
301 302
302 303 if self.skip_cache_active_change:
303 304 return
304 305
305 306 try:
306 307 self.cache_obj.cache_active = True
307 308 Session().add(self.cache_obj)
308 309 Session().commit()
309 310 except IntegrityError:
310 311 # if we catch integrity error, it means we inserted this object
311 312 # assumption is that's really an edge race-condition case and
312 313 # it's safe is to skip it
313 314 Session().rollback()
314 315 except Exception:
315 316 log.exception('Failed to commit on cache key update')
316 317 Session().rollback()
317 318 if self.raise_exception:
318 319 raise
@@ -1,4510 +1,4509 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2010-2018 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21 """
22 22 Database Models for RhodeCode Enterprise
23 23 """
24 24
25 25 import re
26 26 import os
27 27 import time
28 28 import hashlib
29 29 import logging
30 30 import datetime
31 31 import warnings
32 32 import ipaddress
33 33 import functools
34 34 import traceback
35 35 import collections
36 36
37 37 from sqlalchemy import (
38 38 or_, and_, not_, func, TypeDecorator, event,
39 39 Index, Sequence, UniqueConstraint, ForeignKey, CheckConstraint, Column,
40 40 Boolean, String, Unicode, UnicodeText, DateTime, Integer, LargeBinary,
41 41 Text, Float, PickleType)
42 42 from sqlalchemy.sql.expression import true, false
43 43 from sqlalchemy.sql.functions import coalesce, count # noqa
44 44 from sqlalchemy.orm import (
45 45 relationship, joinedload, class_mapper, validates, aliased)
46 46 from sqlalchemy.ext.declarative import declared_attr
47 47 from sqlalchemy.ext.hybrid import hybrid_property
48 48 from sqlalchemy.exc import IntegrityError # noqa
49 49 from sqlalchemy.dialects.mysql import LONGTEXT
50 50 from zope.cachedescriptors.property import Lazy as LazyProperty
51 51
52 52 from pyramid.threadlocal import get_current_request
53 53
54 54 from rhodecode.translation import _
55 55 from rhodecode.lib.vcs import get_vcs_instance
56 56 from rhodecode.lib.vcs.backends.base import EmptyCommit, Reference
57 57 from rhodecode.lib.utils2 import (
58 58 str2bool, safe_str, get_commit_safe, safe_unicode, sha1_safe,
59 59 time_to_datetime, aslist, Optional, safe_int, get_clone_url, AttributeDict,
60 60 glob2re, StrictAttributeDict, cleaned_uri)
61 61 from rhodecode.lib.jsonalchemy import MutationObj, MutationList, JsonType, \
62 62 JsonRaw
63 63 from rhodecode.lib.ext_json import json
64 64 from rhodecode.lib.caching_query import FromCache
65 65 from rhodecode.lib.encrypt import AESCipher
66 66
67 67 from rhodecode.model.meta import Base, Session
68 68
69 69 URL_SEP = '/'
70 70 log = logging.getLogger(__name__)
71 71
72 72 # =============================================================================
73 73 # BASE CLASSES
74 74 # =============================================================================
75 75
76 76 # this is propagated from .ini file rhodecode.encrypted_values.secret or
77 77 # beaker.session.secret if first is not set.
78 78 # and initialized at environment.py
79 79 ENCRYPTION_KEY = None
80 80
81 81 # used to sort permissions by types, '#' used here is not allowed to be in
82 82 # usernames, and it's very early in sorted string.printable table.
83 83 PERMISSION_TYPE_SORT = {
84 84 'admin': '####',
85 85 'write': '###',
86 86 'read': '##',
87 87 'none': '#',
88 88 }
89 89
90 90
91 91 def display_user_sort(obj):
92 92 """
93 93 Sort function used to sort permissions in .permissions() function of
94 94 Repository, RepoGroup, UserGroup. Also it put the default user in front
95 95 of all other resources
96 96 """
97 97
98 98 if obj.username == User.DEFAULT_USER:
99 99 return '#####'
100 100 prefix = PERMISSION_TYPE_SORT.get(obj.permission.split('.')[-1], '')
101 101 return prefix + obj.username
102 102
103 103
104 104 def display_user_group_sort(obj):
105 105 """
106 106 Sort function used to sort permissions in .permissions() function of
107 107 Repository, RepoGroup, UserGroup. Also it put the default user in front
108 108 of all other resources
109 109 """
110 110
111 111 prefix = PERMISSION_TYPE_SORT.get(obj.permission.split('.')[-1], '')
112 112 return prefix + obj.users_group_name
113 113
114 114
115 115 def _hash_key(k):
116 116 return sha1_safe(k)
117 117
118 118
119 119 def in_filter_generator(qry, items, limit=500):
120 120 """
121 121 Splits IN() into multiple with OR
122 122 e.g.::
123 123 cnt = Repository.query().filter(
124 124 or_(
125 125 *in_filter_generator(Repository.repo_id, range(100000))
126 126 )).count()
127 127 """
128 128 if not items:
129 129 # empty list will cause empty query which might cause security issues
130 130 # this can lead to hidden unpleasant results
131 131 items = [-1]
132 132
133 133 parts = []
134 134 for chunk in xrange(0, len(items), limit):
135 135 parts.append(
136 136 qry.in_(items[chunk: chunk + limit])
137 137 )
138 138
139 139 return parts
140 140
141 141
142 142 base_table_args = {
143 143 'extend_existing': True,
144 144 'mysql_engine': 'InnoDB',
145 145 'mysql_charset': 'utf8',
146 146 'sqlite_autoincrement': True
147 147 }
148 148
149 149
150 150 class EncryptedTextValue(TypeDecorator):
151 151 """
152 152 Special column for encrypted long text data, use like::
153 153
154 154 value = Column("encrypted_value", EncryptedValue(), nullable=False)
155 155
156 156 This column is intelligent so if value is in unencrypted form it return
157 157 unencrypted form, but on save it always encrypts
158 158 """
159 159 impl = Text
160 160
161 161 def process_bind_param(self, value, dialect):
162 162 if not value:
163 163 return value
164 164 if value.startswith('enc$aes$') or value.startswith('enc$aes_hmac$'):
165 165 # protect against double encrypting if someone manually starts
166 166 # doing
167 167 raise ValueError('value needs to be in unencrypted format, ie. '
168 168 'not starting with enc$aes')
169 169 return 'enc$aes_hmac$%s' % AESCipher(
170 170 ENCRYPTION_KEY, hmac=True).encrypt(value)
171 171
172 172 def process_result_value(self, value, dialect):
173 173 import rhodecode
174 174
175 175 if not value:
176 176 return value
177 177
178 178 parts = value.split('$', 3)
179 179 if not len(parts) == 3:
180 180 # probably not encrypted values
181 181 return value
182 182 else:
183 183 if parts[0] != 'enc':
184 184 # parts ok but without our header ?
185 185 return value
186 186 enc_strict_mode = str2bool(rhodecode.CONFIG.get(
187 187 'rhodecode.encrypted_values.strict') or True)
188 188 # at that stage we know it's our encryption
189 189 if parts[1] == 'aes':
190 190 decrypted_data = AESCipher(ENCRYPTION_KEY).decrypt(parts[2])
191 191 elif parts[1] == 'aes_hmac':
192 192 decrypted_data = AESCipher(
193 193 ENCRYPTION_KEY, hmac=True,
194 194 strict_verification=enc_strict_mode).decrypt(parts[2])
195 195 else:
196 196 raise ValueError(
197 197 'Encryption type part is wrong, must be `aes` '
198 198 'or `aes_hmac`, got `%s` instead' % (parts[1]))
199 199 return decrypted_data
200 200
201 201
202 202 class BaseModel(object):
203 203 """
204 204 Base Model for all classes
205 205 """
206 206
207 207 @classmethod
208 208 def _get_keys(cls):
209 209 """return column names for this model """
210 210 return class_mapper(cls).c.keys()
211 211
212 212 def get_dict(self):
213 213 """
214 214 return dict with keys and values corresponding
215 215 to this model data """
216 216
217 217 d = {}
218 218 for k in self._get_keys():
219 219 d[k] = getattr(self, k)
220 220
221 221 # also use __json__() if present to get additional fields
222 222 _json_attr = getattr(self, '__json__', None)
223 223 if _json_attr:
224 224 # update with attributes from __json__
225 225 if callable(_json_attr):
226 226 _json_attr = _json_attr()
227 227 for k, val in _json_attr.iteritems():
228 228 d[k] = val
229 229 return d
230 230
231 231 def get_appstruct(self):
232 232 """return list with keys and values tuples corresponding
233 233 to this model data """
234 234
235 235 lst = []
236 236 for k in self._get_keys():
237 237 lst.append((k, getattr(self, k),))
238 238 return lst
239 239
240 240 def populate_obj(self, populate_dict):
241 241 """populate model with data from given populate_dict"""
242 242
243 243 for k in self._get_keys():
244 244 if k in populate_dict:
245 245 setattr(self, k, populate_dict[k])
246 246
247 247 @classmethod
248 248 def query(cls):
249 249 return Session().query(cls)
250 250
251 251 @classmethod
252 252 def get(cls, id_):
253 253 if id_:
254 254 return cls.query().get(id_)
255 255
256 256 @classmethod
257 257 def get_or_404(cls, id_):
258 258 from pyramid.httpexceptions import HTTPNotFound
259 259
260 260 try:
261 261 id_ = int(id_)
262 262 except (TypeError, ValueError):
263 263 raise HTTPNotFound()
264 264
265 265 res = cls.query().get(id_)
266 266 if not res:
267 267 raise HTTPNotFound()
268 268 return res
269 269
270 270 @classmethod
271 271 def getAll(cls):
272 272 # deprecated and left for backward compatibility
273 273 return cls.get_all()
274 274
275 275 @classmethod
276 276 def get_all(cls):
277 277 return cls.query().all()
278 278
279 279 @classmethod
280 280 def delete(cls, id_):
281 281 obj = cls.query().get(id_)
282 282 Session().delete(obj)
283 283
284 284 @classmethod
285 285 def identity_cache(cls, session, attr_name, value):
286 286 exist_in_session = []
287 287 for (item_cls, pkey), instance in session.identity_map.items():
288 288 if cls == item_cls and getattr(instance, attr_name) == value:
289 289 exist_in_session.append(instance)
290 290 if exist_in_session:
291 291 if len(exist_in_session) == 1:
292 292 return exist_in_session[0]
293 293 log.exception(
294 294 'multiple objects with attr %s and '
295 295 'value %s found with same name: %r',
296 296 attr_name, value, exist_in_session)
297 297
298 298 def __repr__(self):
299 299 if hasattr(self, '__unicode__'):
300 300 # python repr needs to return str
301 301 try:
302 302 return safe_str(self.__unicode__())
303 303 except UnicodeDecodeError:
304 304 pass
305 305 return '<DB:%s>' % (self.__class__.__name__)
306 306
307 307
308 308 class RhodeCodeSetting(Base, BaseModel):
309 309 __tablename__ = 'rhodecode_settings'
310 310 __table_args__ = (
311 311 UniqueConstraint('app_settings_name'),
312 312 base_table_args
313 313 )
314 314
315 315 SETTINGS_TYPES = {
316 316 'str': safe_str,
317 317 'int': safe_int,
318 318 'unicode': safe_unicode,
319 319 'bool': str2bool,
320 320 'list': functools.partial(aslist, sep=',')
321 321 }
322 322 DEFAULT_UPDATE_URL = 'https://rhodecode.com/api/v1/info/versions'
323 323 GLOBAL_CONF_KEY = 'app_settings'
324 324
325 325 app_settings_id = Column("app_settings_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
326 326 app_settings_name = Column("app_settings_name", String(255), nullable=True, unique=None, default=None)
327 327 _app_settings_value = Column("app_settings_value", String(4096), nullable=True, unique=None, default=None)
328 328 _app_settings_type = Column("app_settings_type", String(255), nullable=True, unique=None, default=None)
329 329
330 330 def __init__(self, key='', val='', type='unicode'):
331 331 self.app_settings_name = key
332 332 self.app_settings_type = type
333 333 self.app_settings_value = val
334 334
335 335 @validates('_app_settings_value')
336 336 def validate_settings_value(self, key, val):
337 337 assert type(val) == unicode
338 338 return val
339 339
340 340 @hybrid_property
341 341 def app_settings_value(self):
342 342 v = self._app_settings_value
343 343 _type = self.app_settings_type
344 344 if _type:
345 345 _type = self.app_settings_type.split('.')[0]
346 346 # decode the encrypted value
347 347 if 'encrypted' in self.app_settings_type:
348 348 cipher = EncryptedTextValue()
349 349 v = safe_unicode(cipher.process_result_value(v, None))
350 350
351 351 converter = self.SETTINGS_TYPES.get(_type) or \
352 352 self.SETTINGS_TYPES['unicode']
353 353 return converter(v)
354 354
355 355 @app_settings_value.setter
356 356 def app_settings_value(self, val):
357 357 """
358 358 Setter that will always make sure we use unicode in app_settings_value
359 359
360 360 :param val:
361 361 """
362 362 val = safe_unicode(val)
363 363 # encode the encrypted value
364 364 if 'encrypted' in self.app_settings_type:
365 365 cipher = EncryptedTextValue()
366 366 val = safe_unicode(cipher.process_bind_param(val, None))
367 367 self._app_settings_value = val
368 368
369 369 @hybrid_property
370 370 def app_settings_type(self):
371 371 return self._app_settings_type
372 372
373 373 @app_settings_type.setter
374 374 def app_settings_type(self, val):
375 375 if val.split('.')[0] not in self.SETTINGS_TYPES:
376 376 raise Exception('type must be one of %s got %s'
377 377 % (self.SETTINGS_TYPES.keys(), val))
378 378 self._app_settings_type = val
379 379
380 380 def __unicode__(self):
381 381 return u"<%s('%s:%s[%s]')>" % (
382 382 self.__class__.__name__,
383 383 self.app_settings_name, self.app_settings_value,
384 384 self.app_settings_type
385 385 )
386 386
387 387
388 388 class RhodeCodeUi(Base, BaseModel):
389 389 __tablename__ = 'rhodecode_ui'
390 390 __table_args__ = (
391 391 UniqueConstraint('ui_key'),
392 392 base_table_args
393 393 )
394 394
395 395 HOOK_REPO_SIZE = 'changegroup.repo_size'
396 396 # HG
397 397 HOOK_PRE_PULL = 'preoutgoing.pre_pull'
398 398 HOOK_PULL = 'outgoing.pull_logger'
399 399 HOOK_PRE_PUSH = 'prechangegroup.pre_push'
400 400 HOOK_PRETX_PUSH = 'pretxnchangegroup.pre_push'
401 401 HOOK_PUSH = 'changegroup.push_logger'
402 402 HOOK_PUSH_KEY = 'pushkey.key_push'
403 403
404 404 # TODO: johbo: Unify way how hooks are configured for git and hg,
405 405 # git part is currently hardcoded.
406 406
407 407 # SVN PATTERNS
408 408 SVN_BRANCH_ID = 'vcs_svn_branch'
409 409 SVN_TAG_ID = 'vcs_svn_tag'
410 410
411 411 ui_id = Column(
412 412 "ui_id", Integer(), nullable=False, unique=True, default=None,
413 413 primary_key=True)
414 414 ui_section = Column(
415 415 "ui_section", String(255), nullable=True, unique=None, default=None)
416 416 ui_key = Column(
417 417 "ui_key", String(255), nullable=True, unique=None, default=None)
418 418 ui_value = Column(
419 419 "ui_value", String(255), nullable=True, unique=None, default=None)
420 420 ui_active = Column(
421 421 "ui_active", Boolean(), nullable=True, unique=None, default=True)
422 422
423 423 def __repr__(self):
424 424 return '<%s[%s]%s=>%s]>' % (self.__class__.__name__, self.ui_section,
425 425 self.ui_key, self.ui_value)
426 426
427 427
428 428 class RepoRhodeCodeSetting(Base, BaseModel):
429 429 __tablename__ = 'repo_rhodecode_settings'
430 430 __table_args__ = (
431 431 UniqueConstraint(
432 432 'app_settings_name', 'repository_id',
433 433 name='uq_repo_rhodecode_setting_name_repo_id'),
434 434 base_table_args
435 435 )
436 436
437 437 repository_id = Column(
438 438 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
439 439 nullable=False)
440 440 app_settings_id = Column(
441 441 "app_settings_id", Integer(), nullable=False, unique=True,
442 442 default=None, primary_key=True)
443 443 app_settings_name = Column(
444 444 "app_settings_name", String(255), nullable=True, unique=None,
445 445 default=None)
446 446 _app_settings_value = Column(
447 447 "app_settings_value", String(4096), nullable=True, unique=None,
448 448 default=None)
449 449 _app_settings_type = Column(
450 450 "app_settings_type", String(255), nullable=True, unique=None,
451 451 default=None)
452 452
453 453 repository = relationship('Repository')
454 454
455 455 def __init__(self, repository_id, key='', val='', type='unicode'):
456 456 self.repository_id = repository_id
457 457 self.app_settings_name = key
458 458 self.app_settings_type = type
459 459 self.app_settings_value = val
460 460
461 461 @validates('_app_settings_value')
462 462 def validate_settings_value(self, key, val):
463 463 assert type(val) == unicode
464 464 return val
465 465
466 466 @hybrid_property
467 467 def app_settings_value(self):
468 468 v = self._app_settings_value
469 469 type_ = self.app_settings_type
470 470 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
471 471 converter = SETTINGS_TYPES.get(type_) or SETTINGS_TYPES['unicode']
472 472 return converter(v)
473 473
474 474 @app_settings_value.setter
475 475 def app_settings_value(self, val):
476 476 """
477 477 Setter that will always make sure we use unicode in app_settings_value
478 478
479 479 :param val:
480 480 """
481 481 self._app_settings_value = safe_unicode(val)
482 482
483 483 @hybrid_property
484 484 def app_settings_type(self):
485 485 return self._app_settings_type
486 486
487 487 @app_settings_type.setter
488 488 def app_settings_type(self, val):
489 489 SETTINGS_TYPES = RhodeCodeSetting.SETTINGS_TYPES
490 490 if val not in SETTINGS_TYPES:
491 491 raise Exception('type must be one of %s got %s'
492 492 % (SETTINGS_TYPES.keys(), val))
493 493 self._app_settings_type = val
494 494
495 495 def __unicode__(self):
496 496 return u"<%s('%s:%s:%s[%s]')>" % (
497 497 self.__class__.__name__, self.repository.repo_name,
498 498 self.app_settings_name, self.app_settings_value,
499 499 self.app_settings_type
500 500 )
501 501
502 502
503 503 class RepoRhodeCodeUi(Base, BaseModel):
504 504 __tablename__ = 'repo_rhodecode_ui'
505 505 __table_args__ = (
506 506 UniqueConstraint(
507 507 'repository_id', 'ui_section', 'ui_key',
508 508 name='uq_repo_rhodecode_ui_repository_id_section_key'),
509 509 base_table_args
510 510 )
511 511
512 512 repository_id = Column(
513 513 "repository_id", Integer(), ForeignKey('repositories.repo_id'),
514 514 nullable=False)
515 515 ui_id = Column(
516 516 "ui_id", Integer(), nullable=False, unique=True, default=None,
517 517 primary_key=True)
518 518 ui_section = Column(
519 519 "ui_section", String(255), nullable=True, unique=None, default=None)
520 520 ui_key = Column(
521 521 "ui_key", String(255), nullable=True, unique=None, default=None)
522 522 ui_value = Column(
523 523 "ui_value", String(255), nullable=True, unique=None, default=None)
524 524 ui_active = Column(
525 525 "ui_active", Boolean(), nullable=True, unique=None, default=True)
526 526
527 527 repository = relationship('Repository')
528 528
529 529 def __repr__(self):
530 530 return '<%s[%s:%s]%s=>%s]>' % (
531 531 self.__class__.__name__, self.repository.repo_name,
532 532 self.ui_section, self.ui_key, self.ui_value)
533 533
534 534
535 535 class User(Base, BaseModel):
536 536 __tablename__ = 'users'
537 537 __table_args__ = (
538 538 UniqueConstraint('username'), UniqueConstraint('email'),
539 539 Index('u_username_idx', 'username'),
540 540 Index('u_email_idx', 'email'),
541 541 base_table_args
542 542 )
543 543
544 544 DEFAULT_USER = 'default'
545 545 DEFAULT_USER_EMAIL = 'anonymous@rhodecode.org'
546 546 DEFAULT_GRAVATAR_URL = 'https://secure.gravatar.com/avatar/{md5email}?d=identicon&s={size}'
547 547
548 548 user_id = Column("user_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
549 549 username = Column("username", String(255), nullable=True, unique=None, default=None)
550 550 password = Column("password", String(255), nullable=True, unique=None, default=None)
551 551 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
552 552 admin = Column("admin", Boolean(), nullable=True, unique=None, default=False)
553 553 name = Column("firstname", String(255), nullable=True, unique=None, default=None)
554 554 lastname = Column("lastname", String(255), nullable=True, unique=None, default=None)
555 555 _email = Column("email", String(255), nullable=True, unique=None, default=None)
556 556 last_login = Column("last_login", DateTime(timezone=False), nullable=True, unique=None, default=None)
557 557 last_activity = Column('last_activity', DateTime(timezone=False), nullable=True, unique=None, default=None)
558 558
559 559 extern_type = Column("extern_type", String(255), nullable=True, unique=None, default=None)
560 560 extern_name = Column("extern_name", String(255), nullable=True, unique=None, default=None)
561 561 _api_key = Column("api_key", String(255), nullable=True, unique=None, default=None)
562 562 inherit_default_permissions = Column("inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
563 563 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
564 564 _user_data = Column("user_data", LargeBinary(), nullable=True) # JSON data
565 565
566 566 user_log = relationship('UserLog')
567 567 user_perms = relationship('UserToPerm', primaryjoin="User.user_id==UserToPerm.user_id", cascade='all')
568 568
569 569 repositories = relationship('Repository')
570 570 repository_groups = relationship('RepoGroup')
571 571 user_groups = relationship('UserGroup')
572 572
573 573 user_followers = relationship('UserFollowing', primaryjoin='UserFollowing.follows_user_id==User.user_id', cascade='all')
574 574 followings = relationship('UserFollowing', primaryjoin='UserFollowing.user_id==User.user_id', cascade='all')
575 575
576 576 repo_to_perm = relationship('UserRepoToPerm', primaryjoin='UserRepoToPerm.user_id==User.user_id', cascade='all')
577 577 repo_group_to_perm = relationship('UserRepoGroupToPerm', primaryjoin='UserRepoGroupToPerm.user_id==User.user_id', cascade='all')
578 578 user_group_to_perm = relationship('UserUserGroupToPerm', primaryjoin='UserUserGroupToPerm.user_id==User.user_id', cascade='all')
579 579
580 580 group_member = relationship('UserGroupMember', cascade='all')
581 581
582 582 notifications = relationship('UserNotification', cascade='all')
583 583 # notifications assigned to this user
584 584 user_created_notifications = relationship('Notification', cascade='all')
585 585 # comments created by this user
586 586 user_comments = relationship('ChangesetComment', cascade='all')
587 587 # user profile extra info
588 588 user_emails = relationship('UserEmailMap', cascade='all')
589 589 user_ip_map = relationship('UserIpMap', cascade='all')
590 590 user_auth_tokens = relationship('UserApiKeys', cascade='all')
591 591 user_ssh_keys = relationship('UserSshKeys', cascade='all')
592 592
593 593 # gists
594 594 user_gists = relationship('Gist', cascade='all')
595 595 # user pull requests
596 596 user_pull_requests = relationship('PullRequest', cascade='all')
597 597 # external identities
598 598 extenal_identities = relationship(
599 599 'ExternalIdentity',
600 600 primaryjoin="User.user_id==ExternalIdentity.local_user_id",
601 601 cascade='all')
602 602 # review rules
603 603 user_review_rules = relationship('RepoReviewRuleUser', cascade='all')
604 604
605 605 def __unicode__(self):
606 606 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
607 607 self.user_id, self.username)
608 608
609 609 @hybrid_property
610 610 def email(self):
611 611 return self._email
612 612
613 613 @email.setter
614 614 def email(self, val):
615 615 self._email = val.lower() if val else None
616 616
617 617 @hybrid_property
618 618 def first_name(self):
619 619 from rhodecode.lib import helpers as h
620 620 if self.name:
621 621 return h.escape(self.name)
622 622 return self.name
623 623
624 624 @hybrid_property
625 625 def last_name(self):
626 626 from rhodecode.lib import helpers as h
627 627 if self.lastname:
628 628 return h.escape(self.lastname)
629 629 return self.lastname
630 630
631 631 @hybrid_property
632 632 def api_key(self):
633 633 """
634 634 Fetch if exist an auth-token with role ALL connected to this user
635 635 """
636 636 user_auth_token = UserApiKeys.query()\
637 637 .filter(UserApiKeys.user_id == self.user_id)\
638 638 .filter(or_(UserApiKeys.expires == -1,
639 639 UserApiKeys.expires >= time.time()))\
640 640 .filter(UserApiKeys.role == UserApiKeys.ROLE_ALL).first()
641 641 if user_auth_token:
642 642 user_auth_token = user_auth_token.api_key
643 643
644 644 return user_auth_token
645 645
646 646 @api_key.setter
647 647 def api_key(self, val):
648 648 # don't allow to set API key this is deprecated for now
649 649 self._api_key = None
650 650
651 651 @property
652 652 def reviewer_pull_requests(self):
653 653 return PullRequestReviewers.query() \
654 654 .options(joinedload(PullRequestReviewers.pull_request)) \
655 655 .filter(PullRequestReviewers.user_id == self.user_id) \
656 656 .all()
657 657
658 658 @property
659 659 def firstname(self):
660 660 # alias for future
661 661 return self.name
662 662
663 663 @property
664 664 def emails(self):
665 665 other = UserEmailMap.query()\
666 666 .filter(UserEmailMap.user == self) \
667 667 .order_by(UserEmailMap.email_id.asc()) \
668 668 .all()
669 669 return [self.email] + [x.email for x in other]
670 670
671 671 @property
672 672 def auth_tokens(self):
673 673 auth_tokens = self.get_auth_tokens()
674 674 return [x.api_key for x in auth_tokens]
675 675
676 676 def get_auth_tokens(self):
677 677 return UserApiKeys.query()\
678 678 .filter(UserApiKeys.user == self)\
679 679 .order_by(UserApiKeys.user_api_key_id.asc())\
680 680 .all()
681 681
682 682 @LazyProperty
683 683 def feed_token(self):
684 684 return self.get_feed_token()
685 685
686 686 def get_feed_token(self, cache=True):
687 687 feed_tokens = UserApiKeys.query()\
688 688 .filter(UserApiKeys.user == self)\
689 689 .filter(UserApiKeys.role == UserApiKeys.ROLE_FEED)
690 690 if cache:
691 691 feed_tokens = feed_tokens.options(
692 692 FromCache("sql_cache_short", "get_user_feed_token_%s" % self.user_id))
693 693
694 694 feed_tokens = feed_tokens.all()
695 695 if feed_tokens:
696 696 return feed_tokens[0].api_key
697 697 return 'NO_FEED_TOKEN_AVAILABLE'
698 698
699 699 @classmethod
700 700 def get(cls, user_id, cache=False):
701 701 if not user_id:
702 702 return
703 703
704 704 user = cls.query()
705 705 if cache:
706 706 user = user.options(
707 707 FromCache("sql_cache_short", "get_users_%s" % user_id))
708 708 return user.get(user_id)
709 709
710 710 @classmethod
711 711 def extra_valid_auth_tokens(cls, user, role=None):
712 712 tokens = UserApiKeys.query().filter(UserApiKeys.user == user)\
713 713 .filter(or_(UserApiKeys.expires == -1,
714 714 UserApiKeys.expires >= time.time()))
715 715 if role:
716 716 tokens = tokens.filter(or_(UserApiKeys.role == role,
717 717 UserApiKeys.role == UserApiKeys.ROLE_ALL))
718 718 return tokens.all()
719 719
720 720 def authenticate_by_token(self, auth_token, roles=None, scope_repo_id=None):
721 721 from rhodecode.lib import auth
722 722
723 723 log.debug('Trying to authenticate user: %s via auth-token, '
724 724 'and roles: %s', self, roles)
725 725
726 726 if not auth_token:
727 727 return False
728 728
729 729 crypto_backend = auth.crypto_backend()
730 730
731 731 roles = (roles or []) + [UserApiKeys.ROLE_ALL]
732 732 tokens_q = UserApiKeys.query()\
733 733 .filter(UserApiKeys.user_id == self.user_id)\
734 734 .filter(or_(UserApiKeys.expires == -1,
735 735 UserApiKeys.expires >= time.time()))
736 736
737 737 tokens_q = tokens_q.filter(UserApiKeys.role.in_(roles))
738 738
739 739 plain_tokens = []
740 740 hash_tokens = []
741 741
742 742 for token in tokens_q.all():
743 743 # verify scope first
744 744 if token.repo_id:
745 745 # token has a scope, we need to verify it
746 746 if scope_repo_id != token.repo_id:
747 747 log.debug(
748 748 'Scope mismatch: token has a set repo scope: %s, '
749 749 'and calling scope is:%s, skipping further checks',
750 750 token.repo, scope_repo_id)
751 751 # token has a scope, and it doesn't match, skip token
752 752 continue
753 753
754 754 if token.api_key.startswith(crypto_backend.ENC_PREF):
755 755 hash_tokens.append(token.api_key)
756 756 else:
757 757 plain_tokens.append(token.api_key)
758 758
759 759 is_plain_match = auth_token in plain_tokens
760 760 if is_plain_match:
761 761 return True
762 762
763 763 for hashed in hash_tokens:
764 764 # TODO(marcink): this is expensive to calculate, but most secure
765 765 match = crypto_backend.hash_check(auth_token, hashed)
766 766 if match:
767 767 return True
768 768
769 769 return False
770 770
771 771 @property
772 772 def ip_addresses(self):
773 773 ret = UserIpMap.query().filter(UserIpMap.user == self).all()
774 774 return [x.ip_addr for x in ret]
775 775
776 776 @property
777 777 def username_and_name(self):
778 778 return '%s (%s %s)' % (self.username, self.first_name, self.last_name)
779 779
780 780 @property
781 781 def username_or_name_or_email(self):
782 782 full_name = self.full_name if self.full_name is not ' ' else None
783 783 return self.username or full_name or self.email
784 784
785 785 @property
786 786 def full_name(self):
787 787 return '%s %s' % (self.first_name, self.last_name)
788 788
789 789 @property
790 790 def full_name_or_username(self):
791 791 return ('%s %s' % (self.first_name, self.last_name)
792 792 if (self.first_name and self.last_name) else self.username)
793 793
794 794 @property
795 795 def full_contact(self):
796 796 return '%s %s <%s>' % (self.first_name, self.last_name, self.email)
797 797
798 798 @property
799 799 def short_contact(self):
800 800 return '%s %s' % (self.first_name, self.last_name)
801 801
802 802 @property
803 803 def is_admin(self):
804 804 return self.admin
805 805
806 806 def AuthUser(self, **kwargs):
807 807 """
808 808 Returns instance of AuthUser for this user
809 809 """
810 810 from rhodecode.lib.auth import AuthUser
811 811 return AuthUser(user_id=self.user_id, username=self.username, **kwargs)
812 812
813 813 @hybrid_property
814 814 def user_data(self):
815 815 if not self._user_data:
816 816 return {}
817 817
818 818 try:
819 819 return json.loads(self._user_data)
820 820 except TypeError:
821 821 return {}
822 822
823 823 @user_data.setter
824 824 def user_data(self, val):
825 825 if not isinstance(val, dict):
826 826 raise Exception('user_data must be dict, got %s' % type(val))
827 827 try:
828 828 self._user_data = json.dumps(val)
829 829 except Exception:
830 830 log.error(traceback.format_exc())
831 831
832 832 @classmethod
833 833 def get_by_username(cls, username, case_insensitive=False,
834 834 cache=False, identity_cache=False):
835 835 session = Session()
836 836
837 837 if case_insensitive:
838 838 q = cls.query().filter(
839 839 func.lower(cls.username) == func.lower(username))
840 840 else:
841 841 q = cls.query().filter(cls.username == username)
842 842
843 843 if cache:
844 844 if identity_cache:
845 845 val = cls.identity_cache(session, 'username', username)
846 846 if val:
847 847 return val
848 848 else:
849 849 cache_key = "get_user_by_name_%s" % _hash_key(username)
850 850 q = q.options(
851 851 FromCache("sql_cache_short", cache_key))
852 852
853 853 return q.scalar()
854 854
855 855 @classmethod
856 856 def get_by_auth_token(cls, auth_token, cache=False):
857 857 q = UserApiKeys.query()\
858 858 .filter(UserApiKeys.api_key == auth_token)\
859 859 .filter(or_(UserApiKeys.expires == -1,
860 860 UserApiKeys.expires >= time.time()))
861 861 if cache:
862 862 q = q.options(
863 863 FromCache("sql_cache_short", "get_auth_token_%s" % auth_token))
864 864
865 865 match = q.first()
866 866 if match:
867 867 return match.user
868 868
869 869 @classmethod
870 870 def get_by_email(cls, email, case_insensitive=False, cache=False):
871 871
872 872 if case_insensitive:
873 873 q = cls.query().filter(func.lower(cls.email) == func.lower(email))
874 874
875 875 else:
876 876 q = cls.query().filter(cls.email == email)
877 877
878 878 email_key = _hash_key(email)
879 879 if cache:
880 880 q = q.options(
881 881 FromCache("sql_cache_short", "get_email_key_%s" % email_key))
882 882
883 883 ret = q.scalar()
884 884 if ret is None:
885 885 q = UserEmailMap.query()
886 886 # try fetching in alternate email map
887 887 if case_insensitive:
888 888 q = q.filter(func.lower(UserEmailMap.email) == func.lower(email))
889 889 else:
890 890 q = q.filter(UserEmailMap.email == email)
891 891 q = q.options(joinedload(UserEmailMap.user))
892 892 if cache:
893 893 q = q.options(
894 894 FromCache("sql_cache_short", "get_email_map_key_%s" % email_key))
895 895 ret = getattr(q.scalar(), 'user', None)
896 896
897 897 return ret
898 898
899 899 @classmethod
900 900 def get_from_cs_author(cls, author):
901 901 """
902 902 Tries to get User objects out of commit author string
903 903
904 904 :param author:
905 905 """
906 906 from rhodecode.lib.helpers import email, author_name
907 907 # Valid email in the attribute passed, see if they're in the system
908 908 _email = email(author)
909 909 if _email:
910 910 user = cls.get_by_email(_email, case_insensitive=True)
911 911 if user:
912 912 return user
913 913 # Maybe we can match by username?
914 914 _author = author_name(author)
915 915 user = cls.get_by_username(_author, case_insensitive=True)
916 916 if user:
917 917 return user
918 918
919 919 def update_userdata(self, **kwargs):
920 920 usr = self
921 921 old = usr.user_data
922 922 old.update(**kwargs)
923 923 usr.user_data = old
924 924 Session().add(usr)
925 925 log.debug('updated userdata with ', kwargs)
926 926
927 927 def update_lastlogin(self):
928 928 """Update user lastlogin"""
929 929 self.last_login = datetime.datetime.now()
930 930 Session().add(self)
931 931 log.debug('updated user %s lastlogin', self.username)
932 932
933 933 def update_password(self, new_password):
934 934 from rhodecode.lib.auth import get_crypt_password
935 935
936 936 self.password = get_crypt_password(new_password)
937 937 Session().add(self)
938 938
939 939 @classmethod
940 940 def get_first_super_admin(cls):
941 941 user = User.query().filter(User.admin == true()).first()
942 942 if user is None:
943 943 raise Exception('FATAL: Missing administrative account!')
944 944 return user
945 945
946 946 @classmethod
947 947 def get_all_super_admins(cls):
948 948 """
949 949 Returns all admin accounts sorted by username
950 950 """
951 951 return User.query().filter(User.admin == true())\
952 952 .order_by(User.username.asc()).all()
953 953
954 954 @classmethod
955 955 def get_default_user(cls, cache=False, refresh=False):
956 956 user = User.get_by_username(User.DEFAULT_USER, cache=cache)
957 957 if user is None:
958 958 raise Exception('FATAL: Missing default account!')
959 959 if refresh:
960 960 # The default user might be based on outdated state which
961 961 # has been loaded from the cache.
962 962 # A call to refresh() ensures that the
963 963 # latest state from the database is used.
964 964 Session().refresh(user)
965 965 return user
966 966
967 967 def _get_default_perms(self, user, suffix=''):
968 968 from rhodecode.model.permission import PermissionModel
969 969 return PermissionModel().get_default_perms(user.user_perms, suffix)
970 970
971 971 def get_default_perms(self, suffix=''):
972 972 return self._get_default_perms(self, suffix)
973 973
974 974 def get_api_data(self, include_secrets=False, details='full'):
975 975 """
976 976 Common function for generating user related data for API
977 977
978 978 :param include_secrets: By default secrets in the API data will be replaced
979 979 by a placeholder value to prevent exposing this data by accident. In case
980 980 this data shall be exposed, set this flag to ``True``.
981 981
982 982 :param details: details can be 'basic|full' basic gives only a subset of
983 983 the available user information that includes user_id, name and emails.
984 984 """
985 985 user = self
986 986 user_data = self.user_data
987 987 data = {
988 988 'user_id': user.user_id,
989 989 'username': user.username,
990 990 'firstname': user.name,
991 991 'lastname': user.lastname,
992 992 'email': user.email,
993 993 'emails': user.emails,
994 994 }
995 995 if details == 'basic':
996 996 return data
997 997
998 998 auth_token_length = 40
999 999 auth_token_replacement = '*' * auth_token_length
1000 1000
1001 1001 extras = {
1002 1002 'auth_tokens': [auth_token_replacement],
1003 1003 'active': user.active,
1004 1004 'admin': user.admin,
1005 1005 'extern_type': user.extern_type,
1006 1006 'extern_name': user.extern_name,
1007 1007 'last_login': user.last_login,
1008 1008 'last_activity': user.last_activity,
1009 1009 'ip_addresses': user.ip_addresses,
1010 1010 'language': user_data.get('language')
1011 1011 }
1012 1012 data.update(extras)
1013 1013
1014 1014 if include_secrets:
1015 1015 data['auth_tokens'] = user.auth_tokens
1016 1016 return data
1017 1017
1018 1018 def __json__(self):
1019 1019 data = {
1020 1020 'full_name': self.full_name,
1021 1021 'full_name_or_username': self.full_name_or_username,
1022 1022 'short_contact': self.short_contact,
1023 1023 'full_contact': self.full_contact,
1024 1024 }
1025 1025 data.update(self.get_api_data())
1026 1026 return data
1027 1027
1028 1028
1029 1029 class UserApiKeys(Base, BaseModel):
1030 1030 __tablename__ = 'user_api_keys'
1031 1031 __table_args__ = (
1032 1032 Index('uak_api_key_idx', 'api_key', unique=True),
1033 1033 Index('uak_api_key_expires_idx', 'api_key', 'expires'),
1034 1034 base_table_args
1035 1035 )
1036 1036 __mapper_args__ = {}
1037 1037
1038 1038 # ApiKey role
1039 1039 ROLE_ALL = 'token_role_all'
1040 1040 ROLE_HTTP = 'token_role_http'
1041 1041 ROLE_VCS = 'token_role_vcs'
1042 1042 ROLE_API = 'token_role_api'
1043 1043 ROLE_FEED = 'token_role_feed'
1044 1044 ROLE_PASSWORD_RESET = 'token_password_reset'
1045 1045
1046 1046 ROLES = [ROLE_ALL, ROLE_HTTP, ROLE_VCS, ROLE_API, ROLE_FEED]
1047 1047
1048 1048 user_api_key_id = Column("user_api_key_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1049 1049 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1050 1050 api_key = Column("api_key", String(255), nullable=False, unique=True)
1051 1051 description = Column('description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
1052 1052 expires = Column('expires', Float(53), nullable=False)
1053 1053 role = Column('role', String(255), nullable=True)
1054 1054 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1055 1055
1056 1056 # scope columns
1057 1057 repo_id = Column(
1058 1058 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
1059 1059 nullable=True, unique=None, default=None)
1060 1060 repo = relationship('Repository', lazy='joined')
1061 1061
1062 1062 repo_group_id = Column(
1063 1063 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
1064 1064 nullable=True, unique=None, default=None)
1065 1065 repo_group = relationship('RepoGroup', lazy='joined')
1066 1066
1067 1067 user = relationship('User', lazy='joined')
1068 1068
1069 1069 def __unicode__(self):
1070 1070 return u"<%s('%s')>" % (self.__class__.__name__, self.role)
1071 1071
1072 1072 def __json__(self):
1073 1073 data = {
1074 1074 'auth_token': self.api_key,
1075 1075 'role': self.role,
1076 1076 'scope': self.scope_humanized,
1077 1077 'expired': self.expired
1078 1078 }
1079 1079 return data
1080 1080
1081 1081 def get_api_data(self, include_secrets=False):
1082 1082 data = self.__json__()
1083 1083 if include_secrets:
1084 1084 return data
1085 1085 else:
1086 1086 data['auth_token'] = self.token_obfuscated
1087 1087 return data
1088 1088
1089 1089 @hybrid_property
1090 1090 def description_safe(self):
1091 1091 from rhodecode.lib import helpers as h
1092 1092 return h.escape(self.description)
1093 1093
1094 1094 @property
1095 1095 def expired(self):
1096 1096 if self.expires == -1:
1097 1097 return False
1098 1098 return time.time() > self.expires
1099 1099
1100 1100 @classmethod
1101 1101 def _get_role_name(cls, role):
1102 1102 return {
1103 1103 cls.ROLE_ALL: _('all'),
1104 1104 cls.ROLE_HTTP: _('http/web interface'),
1105 1105 cls.ROLE_VCS: _('vcs (git/hg/svn protocol)'),
1106 1106 cls.ROLE_API: _('api calls'),
1107 1107 cls.ROLE_FEED: _('feed access'),
1108 1108 }.get(role, role)
1109 1109
1110 1110 @property
1111 1111 def role_humanized(self):
1112 1112 return self._get_role_name(self.role)
1113 1113
1114 1114 def _get_scope(self):
1115 1115 if self.repo:
1116 1116 return repr(self.repo)
1117 1117 if self.repo_group:
1118 1118 return repr(self.repo_group) + ' (recursive)'
1119 1119 return 'global'
1120 1120
1121 1121 @property
1122 1122 def scope_humanized(self):
1123 1123 return self._get_scope()
1124 1124
1125 1125 @property
1126 1126 def token_obfuscated(self):
1127 1127 if self.api_key:
1128 1128 return self.api_key[:4] + "****"
1129 1129
1130 1130
1131 1131 class UserEmailMap(Base, BaseModel):
1132 1132 __tablename__ = 'user_email_map'
1133 1133 __table_args__ = (
1134 1134 Index('uem_email_idx', 'email'),
1135 1135 UniqueConstraint('email'),
1136 1136 base_table_args
1137 1137 )
1138 1138 __mapper_args__ = {}
1139 1139
1140 1140 email_id = Column("email_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1141 1141 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1142 1142 _email = Column("email", String(255), nullable=True, unique=False, default=None)
1143 1143 user = relationship('User', lazy='joined')
1144 1144
1145 1145 @validates('_email')
1146 1146 def validate_email(self, key, email):
1147 1147 # check if this email is not main one
1148 1148 main_email = Session().query(User).filter(User.email == email).scalar()
1149 1149 if main_email is not None:
1150 1150 raise AttributeError('email %s is present is user table' % email)
1151 1151 return email
1152 1152
1153 1153 @hybrid_property
1154 1154 def email(self):
1155 1155 return self._email
1156 1156
1157 1157 @email.setter
1158 1158 def email(self, val):
1159 1159 self._email = val.lower() if val else None
1160 1160
1161 1161
1162 1162 class UserIpMap(Base, BaseModel):
1163 1163 __tablename__ = 'user_ip_map'
1164 1164 __table_args__ = (
1165 1165 UniqueConstraint('user_id', 'ip_addr'),
1166 1166 base_table_args
1167 1167 )
1168 1168 __mapper_args__ = {}
1169 1169
1170 1170 ip_id = Column("ip_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1171 1171 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1172 1172 ip_addr = Column("ip_addr", String(255), nullable=True, unique=False, default=None)
1173 1173 active = Column("active", Boolean(), nullable=True, unique=None, default=True)
1174 1174 description = Column("description", String(10000), nullable=True, unique=None, default=None)
1175 1175 user = relationship('User', lazy='joined')
1176 1176
1177 1177 @hybrid_property
1178 1178 def description_safe(self):
1179 1179 from rhodecode.lib import helpers as h
1180 1180 return h.escape(self.description)
1181 1181
1182 1182 @classmethod
1183 1183 def _get_ip_range(cls, ip_addr):
1184 1184 net = ipaddress.ip_network(safe_unicode(ip_addr), strict=False)
1185 1185 return [str(net.network_address), str(net.broadcast_address)]
1186 1186
1187 1187 def __json__(self):
1188 1188 return {
1189 1189 'ip_addr': self.ip_addr,
1190 1190 'ip_range': self._get_ip_range(self.ip_addr),
1191 1191 }
1192 1192
1193 1193 def __unicode__(self):
1194 1194 return u"<%s('user_id:%s=>%s')>" % (self.__class__.__name__,
1195 1195 self.user_id, self.ip_addr)
1196 1196
1197 1197
1198 1198 class UserSshKeys(Base, BaseModel):
1199 1199 __tablename__ = 'user_ssh_keys'
1200 1200 __table_args__ = (
1201 1201 Index('usk_ssh_key_fingerprint_idx', 'ssh_key_fingerprint'),
1202 1202
1203 1203 UniqueConstraint('ssh_key_fingerprint'),
1204 1204
1205 1205 base_table_args
1206 1206 )
1207 1207 __mapper_args__ = {}
1208 1208
1209 1209 ssh_key_id = Column('ssh_key_id', Integer(), nullable=False, unique=True, default=None, primary_key=True)
1210 1210 ssh_key_data = Column('ssh_key_data', String(10240), nullable=False, unique=None, default=None)
1211 1211 ssh_key_fingerprint = Column('ssh_key_fingerprint', String(255), nullable=False, unique=None, default=None)
1212 1212
1213 1213 description = Column('description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
1214 1214
1215 1215 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1216 1216 accessed_on = Column('accessed_on', DateTime(timezone=False), nullable=True, default=None)
1217 1217 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
1218 1218
1219 1219 user = relationship('User', lazy='joined')
1220 1220
1221 1221 def __json__(self):
1222 1222 data = {
1223 1223 'ssh_fingerprint': self.ssh_key_fingerprint,
1224 1224 'description': self.description,
1225 1225 'created_on': self.created_on
1226 1226 }
1227 1227 return data
1228 1228
1229 1229 def get_api_data(self):
1230 1230 data = self.__json__()
1231 1231 return data
1232 1232
1233 1233
1234 1234 class UserLog(Base, BaseModel):
1235 1235 __tablename__ = 'user_logs'
1236 1236 __table_args__ = (
1237 1237 base_table_args,
1238 1238 )
1239 1239
1240 1240 VERSION_1 = 'v1'
1241 1241 VERSION_2 = 'v2'
1242 1242 VERSIONS = [VERSION_1, VERSION_2]
1243 1243
1244 1244 user_log_id = Column("user_log_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1245 1245 user_id = Column("user_id", Integer(), ForeignKey('users.user_id',ondelete='SET NULL'), nullable=True, unique=None, default=None)
1246 1246 username = Column("username", String(255), nullable=True, unique=None, default=None)
1247 1247 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id', ondelete='SET NULL'), nullable=True, unique=None, default=None)
1248 1248 repository_name = Column("repository_name", String(255), nullable=True, unique=None, default=None)
1249 1249 user_ip = Column("user_ip", String(255), nullable=True, unique=None, default=None)
1250 1250 action = Column("action", Text().with_variant(Text(1200000), 'mysql'), nullable=True, unique=None, default=None)
1251 1251 action_date = Column("action_date", DateTime(timezone=False), nullable=True, unique=None, default=None)
1252 1252
1253 1253 version = Column("version", String(255), nullable=True, default=VERSION_1)
1254 1254 user_data = Column('user_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=LONGTEXT()))))
1255 1255 action_data = Column('action_data_json', MutationObj.as_mutable(JsonType(dialect_map=dict(mysql=LONGTEXT()))))
1256 1256
1257 1257 def __unicode__(self):
1258 1258 return u"<%s('id:%s:%s')>" % (
1259 1259 self.__class__.__name__, self.repository_name, self.action)
1260 1260
1261 1261 def __json__(self):
1262 1262 return {
1263 1263 'user_id': self.user_id,
1264 1264 'username': self.username,
1265 1265 'repository_id': self.repository_id,
1266 1266 'repository_name': self.repository_name,
1267 1267 'user_ip': self.user_ip,
1268 1268 'action_date': self.action_date,
1269 1269 'action': self.action,
1270 1270 }
1271 1271
1272 1272 @hybrid_property
1273 1273 def entry_id(self):
1274 1274 return self.user_log_id
1275 1275
1276 1276 @property
1277 1277 def action_as_day(self):
1278 1278 return datetime.date(*self.action_date.timetuple()[:3])
1279 1279
1280 1280 user = relationship('User')
1281 1281 repository = relationship('Repository', cascade='')
1282 1282
1283 1283
1284 1284 class UserGroup(Base, BaseModel):
1285 1285 __tablename__ = 'users_groups'
1286 1286 __table_args__ = (
1287 1287 base_table_args,
1288 1288 )
1289 1289
1290 1290 users_group_id = Column("users_group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1291 1291 users_group_name = Column("users_group_name", String(255), nullable=False, unique=True, default=None)
1292 1292 user_group_description = Column("user_group_description", String(10000), nullable=True, unique=None, default=None)
1293 1293 users_group_active = Column("users_group_active", Boolean(), nullable=True, unique=None, default=None)
1294 1294 inherit_default_permissions = Column("users_group_inherit_default_permissions", Boolean(), nullable=False, unique=None, default=True)
1295 1295 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
1296 1296 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1297 1297 _group_data = Column("group_data", LargeBinary(), nullable=True) # JSON data
1298 1298
1299 1299 members = relationship('UserGroupMember', cascade="all, delete, delete-orphan", lazy="joined")
1300 1300 users_group_to_perm = relationship('UserGroupToPerm', cascade='all')
1301 1301 users_group_repo_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1302 1302 users_group_repo_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
1303 1303 user_user_group_to_perm = relationship('UserUserGroupToPerm', cascade='all')
1304 1304 user_group_user_group_to_perm = relationship('UserGroupUserGroupToPerm ', primaryjoin="UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id", cascade='all')
1305 1305
1306 1306 user_group_review_rules = relationship('RepoReviewRuleUserGroup', cascade='all')
1307 1307 user = relationship('User', primaryjoin="User.user_id==UserGroup.user_id")
1308 1308
1309 1309 @classmethod
1310 1310 def _load_group_data(cls, column):
1311 1311 if not column:
1312 1312 return {}
1313 1313
1314 1314 try:
1315 1315 return json.loads(column) or {}
1316 1316 except TypeError:
1317 1317 return {}
1318 1318
1319 1319 @hybrid_property
1320 1320 def description_safe(self):
1321 1321 from rhodecode.lib import helpers as h
1322 1322 return h.escape(self.user_group_description)
1323 1323
1324 1324 @hybrid_property
1325 1325 def group_data(self):
1326 1326 return self._load_group_data(self._group_data)
1327 1327
1328 1328 @group_data.expression
1329 1329 def group_data(self, **kwargs):
1330 1330 return self._group_data
1331 1331
1332 1332 @group_data.setter
1333 1333 def group_data(self, val):
1334 1334 try:
1335 1335 self._group_data = json.dumps(val)
1336 1336 except Exception:
1337 1337 log.error(traceback.format_exc())
1338 1338
1339 1339 @classmethod
1340 1340 def _load_sync(cls, group_data):
1341 1341 if group_data:
1342 1342 return group_data.get('extern_type')
1343 1343
1344 1344 @property
1345 1345 def sync(self):
1346 1346 return self._load_sync(self.group_data)
1347 1347
1348 1348 def __unicode__(self):
1349 1349 return u"<%s('id:%s:%s')>" % (self.__class__.__name__,
1350 1350 self.users_group_id,
1351 1351 self.users_group_name)
1352 1352
1353 1353 @classmethod
1354 1354 def get_by_group_name(cls, group_name, cache=False,
1355 1355 case_insensitive=False):
1356 1356 if case_insensitive:
1357 1357 q = cls.query().filter(func.lower(cls.users_group_name) ==
1358 1358 func.lower(group_name))
1359 1359
1360 1360 else:
1361 1361 q = cls.query().filter(cls.users_group_name == group_name)
1362 1362 if cache:
1363 1363 q = q.options(
1364 1364 FromCache("sql_cache_short", "get_group_%s" % _hash_key(group_name)))
1365 1365 return q.scalar()
1366 1366
1367 1367 @classmethod
1368 1368 def get(cls, user_group_id, cache=False):
1369 1369 if not user_group_id:
1370 1370 return
1371 1371
1372 1372 user_group = cls.query()
1373 1373 if cache:
1374 1374 user_group = user_group.options(
1375 1375 FromCache("sql_cache_short", "get_users_group_%s" % user_group_id))
1376 1376 return user_group.get(user_group_id)
1377 1377
1378 1378 def permissions(self, with_admins=True, with_owner=True):
1379 1379 q = UserUserGroupToPerm.query().filter(UserUserGroupToPerm.user_group == self)
1380 1380 q = q.options(joinedload(UserUserGroupToPerm.user_group),
1381 1381 joinedload(UserUserGroupToPerm.user),
1382 1382 joinedload(UserUserGroupToPerm.permission),)
1383 1383
1384 1384 # get owners and admins and permissions. We do a trick of re-writing
1385 1385 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1386 1386 # has a global reference and changing one object propagates to all
1387 1387 # others. This means if admin is also an owner admin_row that change
1388 1388 # would propagate to both objects
1389 1389 perm_rows = []
1390 1390 for _usr in q.all():
1391 1391 usr = AttributeDict(_usr.user.get_dict())
1392 1392 usr.permission = _usr.permission.permission_name
1393 1393 perm_rows.append(usr)
1394 1394
1395 1395 # filter the perm rows by 'default' first and then sort them by
1396 1396 # admin,write,read,none permissions sorted again alphabetically in
1397 1397 # each group
1398 1398 perm_rows = sorted(perm_rows, key=display_user_sort)
1399 1399
1400 1400 _admin_perm = 'usergroup.admin'
1401 1401 owner_row = []
1402 1402 if with_owner:
1403 1403 usr = AttributeDict(self.user.get_dict())
1404 1404 usr.owner_row = True
1405 1405 usr.permission = _admin_perm
1406 1406 owner_row.append(usr)
1407 1407
1408 1408 super_admin_rows = []
1409 1409 if with_admins:
1410 1410 for usr in User.get_all_super_admins():
1411 1411 # if this admin is also owner, don't double the record
1412 1412 if usr.user_id == owner_row[0].user_id:
1413 1413 owner_row[0].admin_row = True
1414 1414 else:
1415 1415 usr = AttributeDict(usr.get_dict())
1416 1416 usr.admin_row = True
1417 1417 usr.permission = _admin_perm
1418 1418 super_admin_rows.append(usr)
1419 1419
1420 1420 return super_admin_rows + owner_row + perm_rows
1421 1421
1422 1422 def permission_user_groups(self):
1423 1423 q = UserGroupUserGroupToPerm.query().filter(UserGroupUserGroupToPerm.target_user_group == self)
1424 1424 q = q.options(joinedload(UserGroupUserGroupToPerm.user_group),
1425 1425 joinedload(UserGroupUserGroupToPerm.target_user_group),
1426 1426 joinedload(UserGroupUserGroupToPerm.permission),)
1427 1427
1428 1428 perm_rows = []
1429 1429 for _user_group in q.all():
1430 1430 usr = AttributeDict(_user_group.user_group.get_dict())
1431 1431 usr.permission = _user_group.permission.permission_name
1432 1432 perm_rows.append(usr)
1433 1433
1434 1434 perm_rows = sorted(perm_rows, key=display_user_group_sort)
1435 1435 return perm_rows
1436 1436
1437 1437 def _get_default_perms(self, user_group, suffix=''):
1438 1438 from rhodecode.model.permission import PermissionModel
1439 1439 return PermissionModel().get_default_perms(user_group.users_group_to_perm, suffix)
1440 1440
1441 1441 def get_default_perms(self, suffix=''):
1442 1442 return self._get_default_perms(self, suffix)
1443 1443
1444 1444 def get_api_data(self, with_group_members=True, include_secrets=False):
1445 1445 """
1446 1446 :param include_secrets: See :meth:`User.get_api_data`, this parameter is
1447 1447 basically forwarded.
1448 1448
1449 1449 """
1450 1450 user_group = self
1451 1451 data = {
1452 1452 'users_group_id': user_group.users_group_id,
1453 1453 'group_name': user_group.users_group_name,
1454 1454 'group_description': user_group.user_group_description,
1455 1455 'active': user_group.users_group_active,
1456 1456 'owner': user_group.user.username,
1457 1457 'sync': user_group.sync,
1458 1458 'owner_email': user_group.user.email,
1459 1459 }
1460 1460
1461 1461 if with_group_members:
1462 1462 users = []
1463 1463 for user in user_group.members:
1464 1464 user = user.user
1465 1465 users.append(user.get_api_data(include_secrets=include_secrets))
1466 1466 data['users'] = users
1467 1467
1468 1468 return data
1469 1469
1470 1470
1471 1471 class UserGroupMember(Base, BaseModel):
1472 1472 __tablename__ = 'users_groups_members'
1473 1473 __table_args__ = (
1474 1474 base_table_args,
1475 1475 )
1476 1476
1477 1477 users_group_member_id = Column("users_group_member_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1478 1478 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
1479 1479 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
1480 1480
1481 1481 user = relationship('User', lazy='joined')
1482 1482 users_group = relationship('UserGroup')
1483 1483
1484 1484 def __init__(self, gr_id='', u_id=''):
1485 1485 self.users_group_id = gr_id
1486 1486 self.user_id = u_id
1487 1487
1488 1488
1489 1489 class RepositoryField(Base, BaseModel):
1490 1490 __tablename__ = 'repositories_fields'
1491 1491 __table_args__ = (
1492 1492 UniqueConstraint('repository_id', 'field_key'), # no-multi field
1493 1493 base_table_args,
1494 1494 )
1495 1495
1496 1496 PREFIX = 'ex_' # prefix used in form to not conflict with already existing fields
1497 1497
1498 1498 repo_field_id = Column("repo_field_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
1499 1499 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
1500 1500 field_key = Column("field_key", String(250))
1501 1501 field_label = Column("field_label", String(1024), nullable=False)
1502 1502 field_value = Column("field_value", String(10000), nullable=False)
1503 1503 field_desc = Column("field_desc", String(1024), nullable=False)
1504 1504 field_type = Column("field_type", String(255), nullable=False, unique=None)
1505 1505 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
1506 1506
1507 1507 repository = relationship('Repository')
1508 1508
1509 1509 @property
1510 1510 def field_key_prefixed(self):
1511 1511 return 'ex_%s' % self.field_key
1512 1512
1513 1513 @classmethod
1514 1514 def un_prefix_key(cls, key):
1515 1515 if key.startswith(cls.PREFIX):
1516 1516 return key[len(cls.PREFIX):]
1517 1517 return key
1518 1518
1519 1519 @classmethod
1520 1520 def get_by_key_name(cls, key, repo):
1521 1521 row = cls.query()\
1522 1522 .filter(cls.repository == repo)\
1523 1523 .filter(cls.field_key == key).scalar()
1524 1524 return row
1525 1525
1526 1526
1527 1527 class Repository(Base, BaseModel):
1528 1528 __tablename__ = 'repositories'
1529 1529 __table_args__ = (
1530 1530 Index('r_repo_name_idx', 'repo_name', mysql_length=255),
1531 1531 base_table_args,
1532 1532 )
1533 1533 DEFAULT_CLONE_URI = '{scheme}://{user}@{netloc}/{repo}'
1534 1534 DEFAULT_CLONE_URI_ID = '{scheme}://{user}@{netloc}/_{repoid}'
1535 1535 DEFAULT_CLONE_URI_SSH = 'ssh://{sys_user}@{hostname}/{repo}'
1536 1536
1537 1537 STATE_CREATED = 'repo_state_created'
1538 1538 STATE_PENDING = 'repo_state_pending'
1539 1539 STATE_ERROR = 'repo_state_error'
1540 1540
1541 1541 LOCK_AUTOMATIC = 'lock_auto'
1542 1542 LOCK_API = 'lock_api'
1543 1543 LOCK_WEB = 'lock_web'
1544 1544 LOCK_PULL = 'lock_pull'
1545 1545
1546 1546 NAME_SEP = URL_SEP
1547 1547
1548 1548 repo_id = Column(
1549 1549 "repo_id", Integer(), nullable=False, unique=True, default=None,
1550 1550 primary_key=True)
1551 1551 _repo_name = Column(
1552 1552 "repo_name", Text(), nullable=False, default=None)
1553 1553 _repo_name_hash = Column(
1554 1554 "repo_name_hash", String(255), nullable=False, unique=True)
1555 1555 repo_state = Column("repo_state", String(255), nullable=True)
1556 1556
1557 1557 clone_uri = Column(
1558 1558 "clone_uri", EncryptedTextValue(), nullable=True, unique=False,
1559 1559 default=None)
1560 1560 push_uri = Column(
1561 1561 "push_uri", EncryptedTextValue(), nullable=True, unique=False,
1562 1562 default=None)
1563 1563 repo_type = Column(
1564 1564 "repo_type", String(255), nullable=False, unique=False, default=None)
1565 1565 user_id = Column(
1566 1566 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
1567 1567 unique=False, default=None)
1568 1568 private = Column(
1569 1569 "private", Boolean(), nullable=True, unique=None, default=None)
1570 1570 enable_statistics = Column(
1571 1571 "statistics", Boolean(), nullable=True, unique=None, default=True)
1572 1572 enable_downloads = Column(
1573 1573 "downloads", Boolean(), nullable=True, unique=None, default=True)
1574 1574 description = Column(
1575 1575 "description", String(10000), nullable=True, unique=None, default=None)
1576 1576 created_on = Column(
1577 1577 'created_on', DateTime(timezone=False), nullable=True, unique=None,
1578 1578 default=datetime.datetime.now)
1579 1579 updated_on = Column(
1580 1580 'updated_on', DateTime(timezone=False), nullable=True, unique=None,
1581 1581 default=datetime.datetime.now)
1582 1582 _landing_revision = Column(
1583 1583 "landing_revision", String(255), nullable=False, unique=False,
1584 1584 default=None)
1585 1585 enable_locking = Column(
1586 1586 "enable_locking", Boolean(), nullable=False, unique=None,
1587 1587 default=False)
1588 1588 _locked = Column(
1589 1589 "locked", String(255), nullable=True, unique=False, default=None)
1590 1590 _changeset_cache = Column(
1591 1591 "changeset_cache", LargeBinary(), nullable=True) # JSON data
1592 1592
1593 1593 fork_id = Column(
1594 1594 "fork_id", Integer(), ForeignKey('repositories.repo_id'),
1595 1595 nullable=True, unique=False, default=None)
1596 1596 group_id = Column(
1597 1597 "group_id", Integer(), ForeignKey('groups.group_id'), nullable=True,
1598 1598 unique=False, default=None)
1599 1599
1600 1600 user = relationship('User', lazy='joined')
1601 1601 fork = relationship('Repository', remote_side=repo_id, lazy='joined')
1602 1602 group = relationship('RepoGroup', lazy='joined')
1603 1603 repo_to_perm = relationship(
1604 1604 'UserRepoToPerm', cascade='all',
1605 1605 order_by='UserRepoToPerm.repo_to_perm_id')
1606 1606 users_group_to_perm = relationship('UserGroupRepoToPerm', cascade='all')
1607 1607 stats = relationship('Statistics', cascade='all', uselist=False)
1608 1608
1609 1609 followers = relationship(
1610 1610 'UserFollowing',
1611 1611 primaryjoin='UserFollowing.follows_repo_id==Repository.repo_id',
1612 1612 cascade='all')
1613 1613 extra_fields = relationship(
1614 1614 'RepositoryField', cascade="all, delete, delete-orphan")
1615 1615 logs = relationship('UserLog')
1616 1616 comments = relationship(
1617 1617 'ChangesetComment', cascade="all, delete, delete-orphan")
1618 1618 pull_requests_source = relationship(
1619 1619 'PullRequest',
1620 1620 primaryjoin='PullRequest.source_repo_id==Repository.repo_id',
1621 1621 cascade="all, delete, delete-orphan")
1622 1622 pull_requests_target = relationship(
1623 1623 'PullRequest',
1624 1624 primaryjoin='PullRequest.target_repo_id==Repository.repo_id',
1625 1625 cascade="all, delete, delete-orphan")
1626 1626 ui = relationship('RepoRhodeCodeUi', cascade="all")
1627 1627 settings = relationship('RepoRhodeCodeSetting', cascade="all")
1628 1628 integrations = relationship('Integration',
1629 1629 cascade="all, delete, delete-orphan")
1630 1630
1631 1631 scoped_tokens = relationship('UserApiKeys', cascade="all")
1632 1632
1633 1633 def __unicode__(self):
1634 1634 return u"<%s('%s:%s')>" % (self.__class__.__name__, self.repo_id,
1635 1635 safe_unicode(self.repo_name))
1636 1636
1637 1637 @hybrid_property
1638 1638 def description_safe(self):
1639 1639 from rhodecode.lib import helpers as h
1640 1640 return h.escape(self.description)
1641 1641
1642 1642 @hybrid_property
1643 1643 def landing_rev(self):
1644 1644 # always should return [rev_type, rev]
1645 1645 if self._landing_revision:
1646 1646 _rev_info = self._landing_revision.split(':')
1647 1647 if len(_rev_info) < 2:
1648 1648 _rev_info.insert(0, 'rev')
1649 1649 return [_rev_info[0], _rev_info[1]]
1650 1650 return [None, None]
1651 1651
1652 1652 @landing_rev.setter
1653 1653 def landing_rev(self, val):
1654 1654 if ':' not in val:
1655 1655 raise ValueError('value must be delimited with `:` and consist '
1656 1656 'of <rev_type>:<rev>, got %s instead' % val)
1657 1657 self._landing_revision = val
1658 1658
1659 1659 @hybrid_property
1660 1660 def locked(self):
1661 1661 if self._locked:
1662 1662 user_id, timelocked, reason = self._locked.split(':')
1663 1663 lock_values = int(user_id), timelocked, reason
1664 1664 else:
1665 1665 lock_values = [None, None, None]
1666 1666 return lock_values
1667 1667
1668 1668 @locked.setter
1669 1669 def locked(self, val):
1670 1670 if val and isinstance(val, (list, tuple)):
1671 1671 self._locked = ':'.join(map(str, val))
1672 1672 else:
1673 1673 self._locked = None
1674 1674
1675 1675 @hybrid_property
1676 1676 def changeset_cache(self):
1677 1677 from rhodecode.lib.vcs.backends.base import EmptyCommit
1678 1678 dummy = EmptyCommit().__json__()
1679 1679 if not self._changeset_cache:
1680 1680 return dummy
1681 1681 try:
1682 1682 return json.loads(self._changeset_cache)
1683 1683 except TypeError:
1684 1684 return dummy
1685 1685 except Exception:
1686 1686 log.error(traceback.format_exc())
1687 1687 return dummy
1688 1688
1689 1689 @changeset_cache.setter
1690 1690 def changeset_cache(self, val):
1691 1691 try:
1692 1692 self._changeset_cache = json.dumps(val)
1693 1693 except Exception:
1694 1694 log.error(traceback.format_exc())
1695 1695
1696 1696 @hybrid_property
1697 1697 def repo_name(self):
1698 1698 return self._repo_name
1699 1699
1700 1700 @repo_name.setter
1701 1701 def repo_name(self, value):
1702 1702 self._repo_name = value
1703 1703 self._repo_name_hash = hashlib.sha1(safe_str(value)).hexdigest()
1704 1704
1705 1705 @classmethod
1706 1706 def normalize_repo_name(cls, repo_name):
1707 1707 """
1708 1708 Normalizes os specific repo_name to the format internally stored inside
1709 1709 database using URL_SEP
1710 1710
1711 1711 :param cls:
1712 1712 :param repo_name:
1713 1713 """
1714 1714 return cls.NAME_SEP.join(repo_name.split(os.sep))
1715 1715
1716 1716 @classmethod
1717 1717 def get_by_repo_name(cls, repo_name, cache=False, identity_cache=False):
1718 1718 session = Session()
1719 1719 q = session.query(cls).filter(cls.repo_name == repo_name)
1720 1720
1721 1721 if cache:
1722 1722 if identity_cache:
1723 1723 val = cls.identity_cache(session, 'repo_name', repo_name)
1724 1724 if val:
1725 1725 return val
1726 1726 else:
1727 1727 cache_key = "get_repo_by_name_%s" % _hash_key(repo_name)
1728 1728 q = q.options(
1729 1729 FromCache("sql_cache_short", cache_key))
1730 1730
1731 1731 return q.scalar()
1732 1732
1733 1733 @classmethod
1734 1734 def get_by_id_or_repo_name(cls, repoid):
1735 1735 if isinstance(repoid, (int, long)):
1736 1736 try:
1737 1737 repo = cls.get(repoid)
1738 1738 except ValueError:
1739 1739 repo = None
1740 1740 else:
1741 1741 repo = cls.get_by_repo_name(repoid)
1742 1742 return repo
1743 1743
1744 1744 @classmethod
1745 1745 def get_by_full_path(cls, repo_full_path):
1746 1746 repo_name = repo_full_path.split(cls.base_path(), 1)[-1]
1747 1747 repo_name = cls.normalize_repo_name(repo_name)
1748 1748 return cls.get_by_repo_name(repo_name.strip(URL_SEP))
1749 1749
1750 1750 @classmethod
1751 1751 def get_repo_forks(cls, repo_id):
1752 1752 return cls.query().filter(Repository.fork_id == repo_id)
1753 1753
1754 1754 @classmethod
1755 1755 def base_path(cls):
1756 1756 """
1757 1757 Returns base path when all repos are stored
1758 1758
1759 1759 :param cls:
1760 1760 """
1761 1761 q = Session().query(RhodeCodeUi)\
1762 1762 .filter(RhodeCodeUi.ui_key == cls.NAME_SEP)
1763 1763 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1764 1764 return q.one().ui_value
1765 1765
1766 1766 @classmethod
1767 1767 def get_all_repos(cls, user_id=Optional(None), group_id=Optional(None),
1768 1768 case_insensitive=True):
1769 1769 q = Repository.query()
1770 1770
1771 1771 if not isinstance(user_id, Optional):
1772 1772 q = q.filter(Repository.user_id == user_id)
1773 1773
1774 1774 if not isinstance(group_id, Optional):
1775 1775 q = q.filter(Repository.group_id == group_id)
1776 1776
1777 1777 if case_insensitive:
1778 1778 q = q.order_by(func.lower(Repository.repo_name))
1779 1779 else:
1780 1780 q = q.order_by(Repository.repo_name)
1781 1781 return q.all()
1782 1782
1783 1783 @property
1784 1784 def forks(self):
1785 1785 """
1786 1786 Return forks of this repo
1787 1787 """
1788 1788 return Repository.get_repo_forks(self.repo_id)
1789 1789
1790 1790 @property
1791 1791 def parent(self):
1792 1792 """
1793 1793 Returns fork parent
1794 1794 """
1795 1795 return self.fork
1796 1796
1797 1797 @property
1798 1798 def just_name(self):
1799 1799 return self.repo_name.split(self.NAME_SEP)[-1]
1800 1800
1801 1801 @property
1802 1802 def groups_with_parents(self):
1803 1803 groups = []
1804 1804 if self.group is None:
1805 1805 return groups
1806 1806
1807 1807 cur_gr = self.group
1808 1808 groups.insert(0, cur_gr)
1809 1809 while 1:
1810 1810 gr = getattr(cur_gr, 'parent_group', None)
1811 1811 cur_gr = cur_gr.parent_group
1812 1812 if gr is None:
1813 1813 break
1814 1814 groups.insert(0, gr)
1815 1815
1816 1816 return groups
1817 1817
1818 1818 @property
1819 1819 def groups_and_repo(self):
1820 1820 return self.groups_with_parents, self
1821 1821
1822 1822 @LazyProperty
1823 1823 def repo_path(self):
1824 1824 """
1825 1825 Returns base full path for that repository means where it actually
1826 1826 exists on a filesystem
1827 1827 """
1828 1828 q = Session().query(RhodeCodeUi).filter(
1829 1829 RhodeCodeUi.ui_key == self.NAME_SEP)
1830 1830 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
1831 1831 return q.one().ui_value
1832 1832
1833 1833 @property
1834 1834 def repo_full_path(self):
1835 1835 p = [self.repo_path]
1836 1836 # we need to split the name by / since this is how we store the
1837 1837 # names in the database, but that eventually needs to be converted
1838 1838 # into a valid system path
1839 1839 p += self.repo_name.split(self.NAME_SEP)
1840 1840 return os.path.join(*map(safe_unicode, p))
1841 1841
1842 1842 @property
1843 1843 def cache_keys(self):
1844 1844 """
1845 1845 Returns associated cache keys for that repo
1846 1846 """
1847 1847 invalidation_namespace = CacheKey.REPO_INVALIDATION_NAMESPACE.format(
1848 1848 repo_id=self.repo_id)
1849 1849 return CacheKey.query()\
1850 1850 .filter(CacheKey.cache_args == invalidation_namespace)\
1851 1851 .order_by(CacheKey.cache_key)\
1852 1852 .all()
1853 1853
1854 1854 @property
1855 1855 def cached_diffs_relative_dir(self):
1856 1856 """
1857 1857 Return a relative to the repository store path of cached diffs
1858 1858 used for safe display for users, who shouldn't know the absolute store
1859 1859 path
1860 1860 """
1861 1861 return os.path.join(
1862 1862 os.path.dirname(self.repo_name),
1863 1863 self.cached_diffs_dir.split(os.path.sep)[-1])
1864 1864
1865 1865 @property
1866 1866 def cached_diffs_dir(self):
1867 1867 path = self.repo_full_path
1868 1868 return os.path.join(
1869 1869 os.path.dirname(path),
1870 1870 '.__shadow_diff_cache_repo_{}'.format(self.repo_id))
1871 1871
1872 1872 def cached_diffs(self):
1873 1873 diff_cache_dir = self.cached_diffs_dir
1874 1874 if os.path.isdir(diff_cache_dir):
1875 1875 return os.listdir(diff_cache_dir)
1876 1876 return []
1877 1877
1878 1878 def shadow_repos(self):
1879 1879 shadow_repos_pattern = '.__shadow_repo_{}'.format(self.repo_id)
1880 1880 return [
1881 1881 x for x in os.listdir(os.path.dirname(self.repo_full_path))
1882 1882 if x.startswith(shadow_repos_pattern)]
1883 1883
1884 1884 def get_new_name(self, repo_name):
1885 1885 """
1886 1886 returns new full repository name based on assigned group and new new
1887 1887
1888 1888 :param group_name:
1889 1889 """
1890 1890 path_prefix = self.group.full_path_splitted if self.group else []
1891 1891 return self.NAME_SEP.join(path_prefix + [repo_name])
1892 1892
1893 1893 @property
1894 1894 def _config(self):
1895 1895 """
1896 1896 Returns db based config object.
1897 1897 """
1898 1898 from rhodecode.lib.utils import make_db_config
1899 1899 return make_db_config(clear_session=False, repo=self)
1900 1900
1901 1901 def permissions(self, with_admins=True, with_owner=True):
1902 1902 q = UserRepoToPerm.query().filter(UserRepoToPerm.repository == self)
1903 1903 q = q.options(joinedload(UserRepoToPerm.repository),
1904 1904 joinedload(UserRepoToPerm.user),
1905 1905 joinedload(UserRepoToPerm.permission),)
1906 1906
1907 1907 # get owners and admins and permissions. We do a trick of re-writing
1908 1908 # objects from sqlalchemy to named-tuples due to sqlalchemy session
1909 1909 # has a global reference and changing one object propagates to all
1910 1910 # others. This means if admin is also an owner admin_row that change
1911 1911 # would propagate to both objects
1912 1912 perm_rows = []
1913 1913 for _usr in q.all():
1914 1914 usr = AttributeDict(_usr.user.get_dict())
1915 1915 usr.permission = _usr.permission.permission_name
1916 1916 perm_rows.append(usr)
1917 1917
1918 1918 # filter the perm rows by 'default' first and then sort them by
1919 1919 # admin,write,read,none permissions sorted again alphabetically in
1920 1920 # each group
1921 1921 perm_rows = sorted(perm_rows, key=display_user_sort)
1922 1922
1923 1923 _admin_perm = 'repository.admin'
1924 1924 owner_row = []
1925 1925 if with_owner:
1926 1926 usr = AttributeDict(self.user.get_dict())
1927 1927 usr.owner_row = True
1928 1928 usr.permission = _admin_perm
1929 1929 owner_row.append(usr)
1930 1930
1931 1931 super_admin_rows = []
1932 1932 if with_admins:
1933 1933 for usr in User.get_all_super_admins():
1934 1934 # if this admin is also owner, don't double the record
1935 1935 if usr.user_id == owner_row[0].user_id:
1936 1936 owner_row[0].admin_row = True
1937 1937 else:
1938 1938 usr = AttributeDict(usr.get_dict())
1939 1939 usr.admin_row = True
1940 1940 usr.permission = _admin_perm
1941 1941 super_admin_rows.append(usr)
1942 1942
1943 1943 return super_admin_rows + owner_row + perm_rows
1944 1944
1945 1945 def permission_user_groups(self):
1946 1946 q = UserGroupRepoToPerm.query().filter(
1947 1947 UserGroupRepoToPerm.repository == self)
1948 1948 q = q.options(joinedload(UserGroupRepoToPerm.repository),
1949 1949 joinedload(UserGroupRepoToPerm.users_group),
1950 1950 joinedload(UserGroupRepoToPerm.permission),)
1951 1951
1952 1952 perm_rows = []
1953 1953 for _user_group in q.all():
1954 1954 usr = AttributeDict(_user_group.users_group.get_dict())
1955 1955 usr.permission = _user_group.permission.permission_name
1956 1956 perm_rows.append(usr)
1957 1957
1958 1958 perm_rows = sorted(perm_rows, key=display_user_group_sort)
1959 1959 return perm_rows
1960 1960
1961 1961 def get_api_data(self, include_secrets=False):
1962 1962 """
1963 1963 Common function for generating repo api data
1964 1964
1965 1965 :param include_secrets: See :meth:`User.get_api_data`.
1966 1966
1967 1967 """
1968 1968 # TODO: mikhail: Here there is an anti-pattern, we probably need to
1969 1969 # move this methods on models level.
1970 1970 from rhodecode.model.settings import SettingsModel
1971 1971 from rhodecode.model.repo import RepoModel
1972 1972
1973 1973 repo = self
1974 1974 _user_id, _time, _reason = self.locked
1975 1975
1976 1976 data = {
1977 1977 'repo_id': repo.repo_id,
1978 1978 'repo_name': repo.repo_name,
1979 1979 'repo_type': repo.repo_type,
1980 1980 'clone_uri': repo.clone_uri or '',
1981 1981 'push_uri': repo.push_uri or '',
1982 1982 'url': RepoModel().get_url(self),
1983 1983 'private': repo.private,
1984 1984 'created_on': repo.created_on,
1985 1985 'description': repo.description_safe,
1986 1986 'landing_rev': repo.landing_rev,
1987 1987 'owner': repo.user.username,
1988 1988 'fork_of': repo.fork.repo_name if repo.fork else None,
1989 1989 'fork_of_id': repo.fork.repo_id if repo.fork else None,
1990 1990 'enable_statistics': repo.enable_statistics,
1991 1991 'enable_locking': repo.enable_locking,
1992 1992 'enable_downloads': repo.enable_downloads,
1993 1993 'last_changeset': repo.changeset_cache,
1994 1994 'locked_by': User.get(_user_id).get_api_data(
1995 1995 include_secrets=include_secrets) if _user_id else None,
1996 1996 'locked_date': time_to_datetime(_time) if _time else None,
1997 1997 'lock_reason': _reason if _reason else None,
1998 1998 }
1999 1999
2000 2000 # TODO: mikhail: should be per-repo settings here
2001 2001 rc_config = SettingsModel().get_all_settings()
2002 2002 repository_fields = str2bool(
2003 2003 rc_config.get('rhodecode_repository_fields'))
2004 2004 if repository_fields:
2005 2005 for f in self.extra_fields:
2006 2006 data[f.field_key_prefixed] = f.field_value
2007 2007
2008 2008 return data
2009 2009
2010 2010 @classmethod
2011 2011 def lock(cls, repo, user_id, lock_time=None, lock_reason=None):
2012 2012 if not lock_time:
2013 2013 lock_time = time.time()
2014 2014 if not lock_reason:
2015 2015 lock_reason = cls.LOCK_AUTOMATIC
2016 2016 repo.locked = [user_id, lock_time, lock_reason]
2017 2017 Session().add(repo)
2018 2018 Session().commit()
2019 2019
2020 2020 @classmethod
2021 2021 def unlock(cls, repo):
2022 2022 repo.locked = None
2023 2023 Session().add(repo)
2024 2024 Session().commit()
2025 2025
2026 2026 @classmethod
2027 2027 def getlock(cls, repo):
2028 2028 return repo.locked
2029 2029
2030 2030 def is_user_lock(self, user_id):
2031 2031 if self.lock[0]:
2032 2032 lock_user_id = safe_int(self.lock[0])
2033 2033 user_id = safe_int(user_id)
2034 2034 # both are ints, and they are equal
2035 2035 return all([lock_user_id, user_id]) and lock_user_id == user_id
2036 2036
2037 2037 return False
2038 2038
2039 2039 def get_locking_state(self, action, user_id, only_when_enabled=True):
2040 2040 """
2041 2041 Checks locking on this repository, if locking is enabled and lock is
2042 2042 present returns a tuple of make_lock, locked, locked_by.
2043 2043 make_lock can have 3 states None (do nothing) True, make lock
2044 2044 False release lock, This value is later propagated to hooks, which
2045 2045 do the locking. Think about this as signals passed to hooks what to do.
2046 2046
2047 2047 """
2048 2048 # TODO: johbo: This is part of the business logic and should be moved
2049 2049 # into the RepositoryModel.
2050 2050
2051 2051 if action not in ('push', 'pull'):
2052 2052 raise ValueError("Invalid action value: %s" % repr(action))
2053 2053
2054 2054 # defines if locked error should be thrown to user
2055 2055 currently_locked = False
2056 2056 # defines if new lock should be made, tri-state
2057 2057 make_lock = None
2058 2058 repo = self
2059 2059 user = User.get(user_id)
2060 2060
2061 2061 lock_info = repo.locked
2062 2062
2063 2063 if repo and (repo.enable_locking or not only_when_enabled):
2064 2064 if action == 'push':
2065 2065 # check if it's already locked !, if it is compare users
2066 2066 locked_by_user_id = lock_info[0]
2067 2067 if user.user_id == locked_by_user_id:
2068 2068 log.debug(
2069 2069 'Got `push` action from user %s, now unlocking', user)
2070 2070 # unlock if we have push from user who locked
2071 2071 make_lock = False
2072 2072 else:
2073 2073 # we're not the same user who locked, ban with
2074 2074 # code defined in settings (default is 423 HTTP Locked) !
2075 2075 log.debug('Repo %s is currently locked by %s', repo, user)
2076 2076 currently_locked = True
2077 2077 elif action == 'pull':
2078 2078 # [0] user [1] date
2079 2079 if lock_info[0] and lock_info[1]:
2080 2080 log.debug('Repo %s is currently locked by %s', repo, user)
2081 2081 currently_locked = True
2082 2082 else:
2083 2083 log.debug('Setting lock on repo %s by %s', repo, user)
2084 2084 make_lock = True
2085 2085
2086 2086 else:
2087 2087 log.debug('Repository %s do not have locking enabled', repo)
2088 2088
2089 2089 log.debug('FINAL locking values make_lock:%s,locked:%s,locked_by:%s',
2090 2090 make_lock, currently_locked, lock_info)
2091 2091
2092 2092 from rhodecode.lib.auth import HasRepoPermissionAny
2093 2093 perm_check = HasRepoPermissionAny('repository.write', 'repository.admin')
2094 2094 if make_lock and not perm_check(repo_name=repo.repo_name, user=user):
2095 2095 # if we don't have at least write permission we cannot make a lock
2096 2096 log.debug('lock state reset back to FALSE due to lack '
2097 2097 'of at least read permission')
2098 2098 make_lock = False
2099 2099
2100 2100 return make_lock, currently_locked, lock_info
2101 2101
2102 2102 @property
2103 2103 def last_db_change(self):
2104 2104 return self.updated_on
2105 2105
2106 2106 @property
2107 2107 def clone_uri_hidden(self):
2108 2108 clone_uri = self.clone_uri
2109 2109 if clone_uri:
2110 2110 import urlobject
2111 2111 url_obj = urlobject.URLObject(cleaned_uri(clone_uri))
2112 2112 if url_obj.password:
2113 2113 clone_uri = url_obj.with_password('*****')
2114 2114 return clone_uri
2115 2115
2116 2116 @property
2117 2117 def push_uri_hidden(self):
2118 2118 push_uri = self.push_uri
2119 2119 if push_uri:
2120 2120 import urlobject
2121 2121 url_obj = urlobject.URLObject(cleaned_uri(push_uri))
2122 2122 if url_obj.password:
2123 2123 push_uri = url_obj.with_password('*****')
2124 2124 return push_uri
2125 2125
2126 2126 def clone_url(self, **override):
2127 2127 from rhodecode.model.settings import SettingsModel
2128 2128
2129 2129 uri_tmpl = None
2130 2130 if 'with_id' in override:
2131 2131 uri_tmpl = self.DEFAULT_CLONE_URI_ID
2132 2132 del override['with_id']
2133 2133
2134 2134 if 'uri_tmpl' in override:
2135 2135 uri_tmpl = override['uri_tmpl']
2136 2136 del override['uri_tmpl']
2137 2137
2138 2138 ssh = False
2139 2139 if 'ssh' in override:
2140 2140 ssh = True
2141 2141 del override['ssh']
2142 2142
2143 2143 # we didn't override our tmpl from **overrides
2144 2144 if not uri_tmpl:
2145 2145 rc_config = SettingsModel().get_all_settings(cache=True)
2146 2146 if ssh:
2147 2147 uri_tmpl = rc_config.get(
2148 2148 'rhodecode_clone_uri_ssh_tmpl') or self.DEFAULT_CLONE_URI_SSH
2149 2149 else:
2150 2150 uri_tmpl = rc_config.get(
2151 2151 'rhodecode_clone_uri_tmpl') or self.DEFAULT_CLONE_URI
2152 2152
2153 2153 request = get_current_request()
2154 2154 return get_clone_url(request=request,
2155 2155 uri_tmpl=uri_tmpl,
2156 2156 repo_name=self.repo_name,
2157 2157 repo_id=self.repo_id, **override)
2158 2158
2159 2159 def set_state(self, state):
2160 2160 self.repo_state = state
2161 2161 Session().add(self)
2162 2162 #==========================================================================
2163 2163 # SCM PROPERTIES
2164 2164 #==========================================================================
2165 2165
2166 2166 def get_commit(self, commit_id=None, commit_idx=None, pre_load=None):
2167 2167 return get_commit_safe(
2168 2168 self.scm_instance(), commit_id, commit_idx, pre_load=pre_load)
2169 2169
2170 2170 def get_changeset(self, rev=None, pre_load=None):
2171 2171 warnings.warn("Use get_commit", DeprecationWarning)
2172 2172 commit_id = None
2173 2173 commit_idx = None
2174 2174 if isinstance(rev, basestring):
2175 2175 commit_id = rev
2176 2176 else:
2177 2177 commit_idx = rev
2178 2178 return self.get_commit(commit_id=commit_id, commit_idx=commit_idx,
2179 2179 pre_load=pre_load)
2180 2180
2181 2181 def get_landing_commit(self):
2182 2182 """
2183 2183 Returns landing commit, or if that doesn't exist returns the tip
2184 2184 """
2185 2185 _rev_type, _rev = self.landing_rev
2186 2186 commit = self.get_commit(_rev)
2187 2187 if isinstance(commit, EmptyCommit):
2188 2188 return self.get_commit()
2189 2189 return commit
2190 2190
2191 2191 def update_commit_cache(self, cs_cache=None, config=None):
2192 2192 """
2193 2193 Update cache of last changeset for repository, keys should be::
2194 2194
2195 2195 short_id
2196 2196 raw_id
2197 2197 revision
2198 2198 parents
2199 2199 message
2200 2200 date
2201 2201 author
2202 2202
2203 2203 :param cs_cache:
2204 2204 """
2205 2205 from rhodecode.lib.vcs.backends.base import BaseChangeset
2206 2206 if cs_cache is None:
2207 2207 # use no-cache version here
2208 2208 scm_repo = self.scm_instance(cache=False, config=config)
2209 2209 if scm_repo:
2210 2210 cs_cache = scm_repo.get_commit(
2211 2211 pre_load=["author", "date", "message", "parents"])
2212 2212 else:
2213 2213 cs_cache = EmptyCommit()
2214 2214
2215 2215 if isinstance(cs_cache, BaseChangeset):
2216 2216 cs_cache = cs_cache.__json__()
2217 2217
2218 2218 def is_outdated(new_cs_cache):
2219 2219 if (new_cs_cache['raw_id'] != self.changeset_cache['raw_id'] or
2220 2220 new_cs_cache['revision'] != self.changeset_cache['revision']):
2221 2221 return True
2222 2222 return False
2223 2223
2224 2224 # check if we have maybe already latest cached revision
2225 2225 if is_outdated(cs_cache) or not self.changeset_cache:
2226 2226 _default = datetime.datetime.utcnow()
2227 2227 last_change = cs_cache.get('date') or _default
2228 2228 if self.updated_on and self.updated_on > last_change:
2229 2229 # we check if last update is newer than the new value
2230 2230 # if yes, we use the current timestamp instead. Imagine you get
2231 2231 # old commit pushed 1y ago, we'd set last update 1y to ago.
2232 2232 last_change = _default
2233 2233 log.debug('updated repo %s with new cs cache %s',
2234 2234 self.repo_name, cs_cache)
2235 2235 self.updated_on = last_change
2236 2236 self.changeset_cache = cs_cache
2237 2237 Session().add(self)
2238 2238 Session().commit()
2239 2239 else:
2240 2240 log.debug('Skipping update_commit_cache for repo:`%s` '
2241 2241 'commit already with latest changes', self.repo_name)
2242 2242
2243 2243 @property
2244 2244 def tip(self):
2245 2245 return self.get_commit('tip')
2246 2246
2247 2247 @property
2248 2248 def author(self):
2249 2249 return self.tip.author
2250 2250
2251 2251 @property
2252 2252 def last_change(self):
2253 2253 return self.scm_instance().last_change
2254 2254
2255 2255 def get_comments(self, revisions=None):
2256 2256 """
2257 2257 Returns comments for this repository grouped by revisions
2258 2258
2259 2259 :param revisions: filter query by revisions only
2260 2260 """
2261 2261 cmts = ChangesetComment.query()\
2262 2262 .filter(ChangesetComment.repo == self)
2263 2263 if revisions:
2264 2264 cmts = cmts.filter(ChangesetComment.revision.in_(revisions))
2265 2265 grouped = collections.defaultdict(list)
2266 2266 for cmt in cmts.all():
2267 2267 grouped[cmt.revision].append(cmt)
2268 2268 return grouped
2269 2269
2270 2270 def statuses(self, revisions=None):
2271 2271 """
2272 2272 Returns statuses for this repository
2273 2273
2274 2274 :param revisions: list of revisions to get statuses for
2275 2275 """
2276 2276 statuses = ChangesetStatus.query()\
2277 2277 .filter(ChangesetStatus.repo == self)\
2278 2278 .filter(ChangesetStatus.version == 0)
2279 2279
2280 2280 if revisions:
2281 2281 # Try doing the filtering in chunks to avoid hitting limits
2282 2282 size = 500
2283 2283 status_results = []
2284 2284 for chunk in xrange(0, len(revisions), size):
2285 2285 status_results += statuses.filter(
2286 2286 ChangesetStatus.revision.in_(
2287 2287 revisions[chunk: chunk+size])
2288 2288 ).all()
2289 2289 else:
2290 2290 status_results = statuses.all()
2291 2291
2292 2292 grouped = {}
2293 2293
2294 2294 # maybe we have open new pullrequest without a status?
2295 2295 stat = ChangesetStatus.STATUS_UNDER_REVIEW
2296 2296 status_lbl = ChangesetStatus.get_status_lbl(stat)
2297 2297 for pr in PullRequest.query().filter(PullRequest.source_repo == self).all():
2298 2298 for rev in pr.revisions:
2299 2299 pr_id = pr.pull_request_id
2300 2300 pr_repo = pr.target_repo.repo_name
2301 2301 grouped[rev] = [stat, status_lbl, pr_id, pr_repo]
2302 2302
2303 2303 for stat in status_results:
2304 2304 pr_id = pr_repo = None
2305 2305 if stat.pull_request:
2306 2306 pr_id = stat.pull_request.pull_request_id
2307 2307 pr_repo = stat.pull_request.target_repo.repo_name
2308 2308 grouped[stat.revision] = [str(stat.status), stat.status_lbl,
2309 2309 pr_id, pr_repo]
2310 2310 return grouped
2311 2311
2312 2312 # ==========================================================================
2313 2313 # SCM CACHE INSTANCE
2314 2314 # ==========================================================================
2315 2315
2316 2316 def scm_instance(self, **kwargs):
2317 2317 import rhodecode
2318 2318
2319 2319 # Passing a config will not hit the cache currently only used
2320 2320 # for repo2dbmapper
2321 2321 config = kwargs.pop('config', None)
2322 2322 cache = kwargs.pop('cache', None)
2323 2323 full_cache = str2bool(rhodecode.CONFIG.get('vcs_full_cache'))
2324 2324 # if cache is NOT defined use default global, else we have a full
2325 2325 # control over cache behaviour
2326 2326 if cache is None and full_cache and not config:
2327 2327 return self._get_instance_cached()
2328 2328 return self._get_instance(cache=bool(cache), config=config)
2329 2329
2330 2330 def _get_instance_cached(self):
2331 2331 from rhodecode.lib import rc_cache
2332 2332
2333 2333 cache_namespace_uid = 'cache_repo_instance.{}'.format(self.repo_id)
2334 2334 invalidation_namespace = CacheKey.REPO_INVALIDATION_NAMESPACE.format(
2335 2335 repo_id=self.repo_id)
2336 2336 region = rc_cache.get_or_create_region('cache_repo_longterm', cache_namespace_uid)
2337 2337
2338 2338 @region.conditional_cache_on_arguments(namespace=cache_namespace_uid)
2339 2339 def get_instance_cached(repo_id):
2340 2340 return self._get_instance()
2341 2341
2342 start = time.time()
2343 2342 inv_context_manager = rc_cache.InvalidationContext(
2344 2343 uid=cache_namespace_uid, invalidation_namespace=invalidation_namespace)
2345 2344 with inv_context_manager as invalidation_context:
2346 2345 # check for stored invalidation signal, and maybe purge the cache
2347 2346 # before computing it again
2348 2347 if invalidation_context.should_invalidate():
2349 2348 get_instance_cached.invalidate(self.repo_id)
2350 2349
2351 2350 instance = get_instance_cached(self.repo_id)
2352 compute_time = time.time() - start
2353 log.debug('Repo instance fetched in %.3fs', compute_time)
2351 log.debug(
2352 'Repo instance fetched in %.3fs', inv_context_manager.compute_time)
2354 2353 return instance
2355 2354
2356 2355 def _get_instance(self, cache=True, config=None):
2357 2356 config = config or self._config
2358 2357 custom_wire = {
2359 2358 'cache': cache # controls the vcs.remote cache
2360 2359 }
2361 2360 repo = get_vcs_instance(
2362 2361 repo_path=safe_str(self.repo_full_path),
2363 2362 config=config,
2364 2363 with_wire=custom_wire,
2365 2364 create=False,
2366 2365 _vcs_alias=self.repo_type)
2367 2366
2368 2367 return repo
2369 2368
2370 2369 def __json__(self):
2371 2370 return {'landing_rev': self.landing_rev}
2372 2371
2373 2372 def get_dict(self):
2374 2373
2375 2374 # Since we transformed `repo_name` to a hybrid property, we need to
2376 2375 # keep compatibility with the code which uses `repo_name` field.
2377 2376
2378 2377 result = super(Repository, self).get_dict()
2379 2378 result['repo_name'] = result.pop('_repo_name', None)
2380 2379 return result
2381 2380
2382 2381
2383 2382 class RepoGroup(Base, BaseModel):
2384 2383 __tablename__ = 'groups'
2385 2384 __table_args__ = (
2386 2385 UniqueConstraint('group_name', 'group_parent_id'),
2387 2386 CheckConstraint('group_id != group_parent_id'),
2388 2387 base_table_args,
2389 2388 )
2390 2389 __mapper_args__ = {'order_by': 'group_name'}
2391 2390
2392 2391 CHOICES_SEPARATOR = '/' # used to generate select2 choices for nested groups
2393 2392
2394 2393 group_id = Column("group_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2395 2394 group_name = Column("group_name", String(255), nullable=False, unique=True, default=None)
2396 2395 group_parent_id = Column("group_parent_id", Integer(), ForeignKey('groups.group_id'), nullable=True, unique=None, default=None)
2397 2396 group_description = Column("group_description", String(10000), nullable=True, unique=None, default=None)
2398 2397 enable_locking = Column("enable_locking", Boolean(), nullable=False, unique=None, default=False)
2399 2398 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=False, default=None)
2400 2399 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
2401 2400 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=datetime.datetime.now)
2402 2401 personal = Column('personal', Boolean(), nullable=True, unique=None, default=None)
2403 2402
2404 2403 repo_group_to_perm = relationship('UserRepoGroupToPerm', cascade='all', order_by='UserRepoGroupToPerm.group_to_perm_id')
2405 2404 users_group_to_perm = relationship('UserGroupRepoGroupToPerm', cascade='all')
2406 2405 parent_group = relationship('RepoGroup', remote_side=group_id)
2407 2406 user = relationship('User')
2408 2407 integrations = relationship('Integration',
2409 2408 cascade="all, delete, delete-orphan")
2410 2409
2411 2410 def __init__(self, group_name='', parent_group=None):
2412 2411 self.group_name = group_name
2413 2412 self.parent_group = parent_group
2414 2413
2415 2414 def __unicode__(self):
2416 2415 return u"<%s('id:%s:%s')>" % (
2417 2416 self.__class__.__name__, self.group_id, self.group_name)
2418 2417
2419 2418 @hybrid_property
2420 2419 def description_safe(self):
2421 2420 from rhodecode.lib import helpers as h
2422 2421 return h.escape(self.group_description)
2423 2422
2424 2423 @classmethod
2425 2424 def _generate_choice(cls, repo_group):
2426 2425 from webhelpers.html import literal as _literal
2427 2426 _name = lambda k: _literal(cls.CHOICES_SEPARATOR.join(k))
2428 2427 return repo_group.group_id, _name(repo_group.full_path_splitted)
2429 2428
2430 2429 @classmethod
2431 2430 def groups_choices(cls, groups=None, show_empty_group=True):
2432 2431 if not groups:
2433 2432 groups = cls.query().all()
2434 2433
2435 2434 repo_groups = []
2436 2435 if show_empty_group:
2437 2436 repo_groups = [(-1, u'-- %s --' % _('No parent'))]
2438 2437
2439 2438 repo_groups.extend([cls._generate_choice(x) for x in groups])
2440 2439
2441 2440 repo_groups = sorted(
2442 2441 repo_groups, key=lambda t: t[1].split(cls.CHOICES_SEPARATOR)[0])
2443 2442 return repo_groups
2444 2443
2445 2444 @classmethod
2446 2445 def url_sep(cls):
2447 2446 return URL_SEP
2448 2447
2449 2448 @classmethod
2450 2449 def get_by_group_name(cls, group_name, cache=False, case_insensitive=False):
2451 2450 if case_insensitive:
2452 2451 gr = cls.query().filter(func.lower(cls.group_name)
2453 2452 == func.lower(group_name))
2454 2453 else:
2455 2454 gr = cls.query().filter(cls.group_name == group_name)
2456 2455 if cache:
2457 2456 name_key = _hash_key(group_name)
2458 2457 gr = gr.options(
2459 2458 FromCache("sql_cache_short", "get_group_%s" % name_key))
2460 2459 return gr.scalar()
2461 2460
2462 2461 @classmethod
2463 2462 def get_user_personal_repo_group(cls, user_id):
2464 2463 user = User.get(user_id)
2465 2464 if user.username == User.DEFAULT_USER:
2466 2465 return None
2467 2466
2468 2467 return cls.query()\
2469 2468 .filter(cls.personal == true()) \
2470 2469 .filter(cls.user == user).scalar()
2471 2470
2472 2471 @classmethod
2473 2472 def get_all_repo_groups(cls, user_id=Optional(None), group_id=Optional(None),
2474 2473 case_insensitive=True):
2475 2474 q = RepoGroup.query()
2476 2475
2477 2476 if not isinstance(user_id, Optional):
2478 2477 q = q.filter(RepoGroup.user_id == user_id)
2479 2478
2480 2479 if not isinstance(group_id, Optional):
2481 2480 q = q.filter(RepoGroup.group_parent_id == group_id)
2482 2481
2483 2482 if case_insensitive:
2484 2483 q = q.order_by(func.lower(RepoGroup.group_name))
2485 2484 else:
2486 2485 q = q.order_by(RepoGroup.group_name)
2487 2486 return q.all()
2488 2487
2489 2488 @property
2490 2489 def parents(self):
2491 2490 parents_recursion_limit = 10
2492 2491 groups = []
2493 2492 if self.parent_group is None:
2494 2493 return groups
2495 2494 cur_gr = self.parent_group
2496 2495 groups.insert(0, cur_gr)
2497 2496 cnt = 0
2498 2497 while 1:
2499 2498 cnt += 1
2500 2499 gr = getattr(cur_gr, 'parent_group', None)
2501 2500 cur_gr = cur_gr.parent_group
2502 2501 if gr is None:
2503 2502 break
2504 2503 if cnt == parents_recursion_limit:
2505 2504 # this will prevent accidental infinit loops
2506 2505 log.error(('more than %s parents found for group %s, stopping '
2507 2506 'recursive parent fetching' % (parents_recursion_limit, self)))
2508 2507 break
2509 2508
2510 2509 groups.insert(0, gr)
2511 2510 return groups
2512 2511
2513 2512 @property
2514 2513 def last_db_change(self):
2515 2514 return self.updated_on
2516 2515
2517 2516 @property
2518 2517 def children(self):
2519 2518 return RepoGroup.query().filter(RepoGroup.parent_group == self)
2520 2519
2521 2520 @property
2522 2521 def name(self):
2523 2522 return self.group_name.split(RepoGroup.url_sep())[-1]
2524 2523
2525 2524 @property
2526 2525 def full_path(self):
2527 2526 return self.group_name
2528 2527
2529 2528 @property
2530 2529 def full_path_splitted(self):
2531 2530 return self.group_name.split(RepoGroup.url_sep())
2532 2531
2533 2532 @property
2534 2533 def repositories(self):
2535 2534 return Repository.query()\
2536 2535 .filter(Repository.group == self)\
2537 2536 .order_by(Repository.repo_name)
2538 2537
2539 2538 @property
2540 2539 def repositories_recursive_count(self):
2541 2540 cnt = self.repositories.count()
2542 2541
2543 2542 def children_count(group):
2544 2543 cnt = 0
2545 2544 for child in group.children:
2546 2545 cnt += child.repositories.count()
2547 2546 cnt += children_count(child)
2548 2547 return cnt
2549 2548
2550 2549 return cnt + children_count(self)
2551 2550
2552 2551 def _recursive_objects(self, include_repos=True):
2553 2552 all_ = []
2554 2553
2555 2554 def _get_members(root_gr):
2556 2555 if include_repos:
2557 2556 for r in root_gr.repositories:
2558 2557 all_.append(r)
2559 2558 childs = root_gr.children.all()
2560 2559 if childs:
2561 2560 for gr in childs:
2562 2561 all_.append(gr)
2563 2562 _get_members(gr)
2564 2563
2565 2564 _get_members(self)
2566 2565 return [self] + all_
2567 2566
2568 2567 def recursive_groups_and_repos(self):
2569 2568 """
2570 2569 Recursive return all groups, with repositories in those groups
2571 2570 """
2572 2571 return self._recursive_objects()
2573 2572
2574 2573 def recursive_groups(self):
2575 2574 """
2576 2575 Returns all children groups for this group including children of children
2577 2576 """
2578 2577 return self._recursive_objects(include_repos=False)
2579 2578
2580 2579 def get_new_name(self, group_name):
2581 2580 """
2582 2581 returns new full group name based on parent and new name
2583 2582
2584 2583 :param group_name:
2585 2584 """
2586 2585 path_prefix = (self.parent_group.full_path_splitted if
2587 2586 self.parent_group else [])
2588 2587 return RepoGroup.url_sep().join(path_prefix + [group_name])
2589 2588
2590 2589 def permissions(self, with_admins=True, with_owner=True):
2591 2590 q = UserRepoGroupToPerm.query().filter(UserRepoGroupToPerm.group == self)
2592 2591 q = q.options(joinedload(UserRepoGroupToPerm.group),
2593 2592 joinedload(UserRepoGroupToPerm.user),
2594 2593 joinedload(UserRepoGroupToPerm.permission),)
2595 2594
2596 2595 # get owners and admins and permissions. We do a trick of re-writing
2597 2596 # objects from sqlalchemy to named-tuples due to sqlalchemy session
2598 2597 # has a global reference and changing one object propagates to all
2599 2598 # others. This means if admin is also an owner admin_row that change
2600 2599 # would propagate to both objects
2601 2600 perm_rows = []
2602 2601 for _usr in q.all():
2603 2602 usr = AttributeDict(_usr.user.get_dict())
2604 2603 usr.permission = _usr.permission.permission_name
2605 2604 perm_rows.append(usr)
2606 2605
2607 2606 # filter the perm rows by 'default' first and then sort them by
2608 2607 # admin,write,read,none permissions sorted again alphabetically in
2609 2608 # each group
2610 2609 perm_rows = sorted(perm_rows, key=display_user_sort)
2611 2610
2612 2611 _admin_perm = 'group.admin'
2613 2612 owner_row = []
2614 2613 if with_owner:
2615 2614 usr = AttributeDict(self.user.get_dict())
2616 2615 usr.owner_row = True
2617 2616 usr.permission = _admin_perm
2618 2617 owner_row.append(usr)
2619 2618
2620 2619 super_admin_rows = []
2621 2620 if with_admins:
2622 2621 for usr in User.get_all_super_admins():
2623 2622 # if this admin is also owner, don't double the record
2624 2623 if usr.user_id == owner_row[0].user_id:
2625 2624 owner_row[0].admin_row = True
2626 2625 else:
2627 2626 usr = AttributeDict(usr.get_dict())
2628 2627 usr.admin_row = True
2629 2628 usr.permission = _admin_perm
2630 2629 super_admin_rows.append(usr)
2631 2630
2632 2631 return super_admin_rows + owner_row + perm_rows
2633 2632
2634 2633 def permission_user_groups(self):
2635 2634 q = UserGroupRepoGroupToPerm.query().filter(UserGroupRepoGroupToPerm.group == self)
2636 2635 q = q.options(joinedload(UserGroupRepoGroupToPerm.group),
2637 2636 joinedload(UserGroupRepoGroupToPerm.users_group),
2638 2637 joinedload(UserGroupRepoGroupToPerm.permission),)
2639 2638
2640 2639 perm_rows = []
2641 2640 for _user_group in q.all():
2642 2641 usr = AttributeDict(_user_group.users_group.get_dict())
2643 2642 usr.permission = _user_group.permission.permission_name
2644 2643 perm_rows.append(usr)
2645 2644
2646 2645 perm_rows = sorted(perm_rows, key=display_user_group_sort)
2647 2646 return perm_rows
2648 2647
2649 2648 def get_api_data(self):
2650 2649 """
2651 2650 Common function for generating api data
2652 2651
2653 2652 """
2654 2653 group = self
2655 2654 data = {
2656 2655 'group_id': group.group_id,
2657 2656 'group_name': group.group_name,
2658 2657 'group_description': group.description_safe,
2659 2658 'parent_group': group.parent_group.group_name if group.parent_group else None,
2660 2659 'repositories': [x.repo_name for x in group.repositories],
2661 2660 'owner': group.user.username,
2662 2661 }
2663 2662 return data
2664 2663
2665 2664
2666 2665 class Permission(Base, BaseModel):
2667 2666 __tablename__ = 'permissions'
2668 2667 __table_args__ = (
2669 2668 Index('p_perm_name_idx', 'permission_name'),
2670 2669 base_table_args,
2671 2670 )
2672 2671
2673 2672 PERMS = [
2674 2673 ('hg.admin', _('RhodeCode Super Administrator')),
2675 2674
2676 2675 ('repository.none', _('Repository no access')),
2677 2676 ('repository.read', _('Repository read access')),
2678 2677 ('repository.write', _('Repository write access')),
2679 2678 ('repository.admin', _('Repository admin access')),
2680 2679
2681 2680 ('group.none', _('Repository group no access')),
2682 2681 ('group.read', _('Repository group read access')),
2683 2682 ('group.write', _('Repository group write access')),
2684 2683 ('group.admin', _('Repository group admin access')),
2685 2684
2686 2685 ('usergroup.none', _('User group no access')),
2687 2686 ('usergroup.read', _('User group read access')),
2688 2687 ('usergroup.write', _('User group write access')),
2689 2688 ('usergroup.admin', _('User group admin access')),
2690 2689
2691 2690 ('hg.repogroup.create.false', _('Repository Group creation disabled')),
2692 2691 ('hg.repogroup.create.true', _('Repository Group creation enabled')),
2693 2692
2694 2693 ('hg.usergroup.create.false', _('User Group creation disabled')),
2695 2694 ('hg.usergroup.create.true', _('User Group creation enabled')),
2696 2695
2697 2696 ('hg.create.none', _('Repository creation disabled')),
2698 2697 ('hg.create.repository', _('Repository creation enabled')),
2699 2698 ('hg.create.write_on_repogroup.true', _('Repository creation enabled with write permission to a repository group')),
2700 2699 ('hg.create.write_on_repogroup.false', _('Repository creation disabled with write permission to a repository group')),
2701 2700
2702 2701 ('hg.fork.none', _('Repository forking disabled')),
2703 2702 ('hg.fork.repository', _('Repository forking enabled')),
2704 2703
2705 2704 ('hg.register.none', _('Registration disabled')),
2706 2705 ('hg.register.manual_activate', _('User Registration with manual account activation')),
2707 2706 ('hg.register.auto_activate', _('User Registration with automatic account activation')),
2708 2707
2709 2708 ('hg.password_reset.enabled', _('Password reset enabled')),
2710 2709 ('hg.password_reset.hidden', _('Password reset hidden')),
2711 2710 ('hg.password_reset.disabled', _('Password reset disabled')),
2712 2711
2713 2712 ('hg.extern_activate.manual', _('Manual activation of external account')),
2714 2713 ('hg.extern_activate.auto', _('Automatic activation of external account')),
2715 2714
2716 2715 ('hg.inherit_default_perms.false', _('Inherit object permissions from default user disabled')),
2717 2716 ('hg.inherit_default_perms.true', _('Inherit object permissions from default user enabled')),
2718 2717 ]
2719 2718
2720 2719 # definition of system default permissions for DEFAULT user
2721 2720 DEFAULT_USER_PERMISSIONS = [
2722 2721 'repository.read',
2723 2722 'group.read',
2724 2723 'usergroup.read',
2725 2724 'hg.create.repository',
2726 2725 'hg.repogroup.create.false',
2727 2726 'hg.usergroup.create.false',
2728 2727 'hg.create.write_on_repogroup.true',
2729 2728 'hg.fork.repository',
2730 2729 'hg.register.manual_activate',
2731 2730 'hg.password_reset.enabled',
2732 2731 'hg.extern_activate.auto',
2733 2732 'hg.inherit_default_perms.true',
2734 2733 ]
2735 2734
2736 2735 # defines which permissions are more important higher the more important
2737 2736 # Weight defines which permissions are more important.
2738 2737 # The higher number the more important.
2739 2738 PERM_WEIGHTS = {
2740 2739 'repository.none': 0,
2741 2740 'repository.read': 1,
2742 2741 'repository.write': 3,
2743 2742 'repository.admin': 4,
2744 2743
2745 2744 'group.none': 0,
2746 2745 'group.read': 1,
2747 2746 'group.write': 3,
2748 2747 'group.admin': 4,
2749 2748
2750 2749 'usergroup.none': 0,
2751 2750 'usergroup.read': 1,
2752 2751 'usergroup.write': 3,
2753 2752 'usergroup.admin': 4,
2754 2753
2755 2754 'hg.repogroup.create.false': 0,
2756 2755 'hg.repogroup.create.true': 1,
2757 2756
2758 2757 'hg.usergroup.create.false': 0,
2759 2758 'hg.usergroup.create.true': 1,
2760 2759
2761 2760 'hg.fork.none': 0,
2762 2761 'hg.fork.repository': 1,
2763 2762 'hg.create.none': 0,
2764 2763 'hg.create.repository': 1
2765 2764 }
2766 2765
2767 2766 permission_id = Column("permission_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2768 2767 permission_name = Column("permission_name", String(255), nullable=True, unique=None, default=None)
2769 2768 permission_longname = Column("permission_longname", String(255), nullable=True, unique=None, default=None)
2770 2769
2771 2770 def __unicode__(self):
2772 2771 return u"<%s('%s:%s')>" % (
2773 2772 self.__class__.__name__, self.permission_id, self.permission_name
2774 2773 )
2775 2774
2776 2775 @classmethod
2777 2776 def get_by_key(cls, key):
2778 2777 return cls.query().filter(cls.permission_name == key).scalar()
2779 2778
2780 2779 @classmethod
2781 2780 def get_default_repo_perms(cls, user_id, repo_id=None):
2782 2781 q = Session().query(UserRepoToPerm, Repository, Permission)\
2783 2782 .join((Permission, UserRepoToPerm.permission_id == Permission.permission_id))\
2784 2783 .join((Repository, UserRepoToPerm.repository_id == Repository.repo_id))\
2785 2784 .filter(UserRepoToPerm.user_id == user_id)
2786 2785 if repo_id:
2787 2786 q = q.filter(UserRepoToPerm.repository_id == repo_id)
2788 2787 return q.all()
2789 2788
2790 2789 @classmethod
2791 2790 def get_default_repo_perms_from_user_group(cls, user_id, repo_id=None):
2792 2791 q = Session().query(UserGroupRepoToPerm, Repository, Permission)\
2793 2792 .join(
2794 2793 Permission,
2795 2794 UserGroupRepoToPerm.permission_id == Permission.permission_id)\
2796 2795 .join(
2797 2796 Repository,
2798 2797 UserGroupRepoToPerm.repository_id == Repository.repo_id)\
2799 2798 .join(
2800 2799 UserGroup,
2801 2800 UserGroupRepoToPerm.users_group_id ==
2802 2801 UserGroup.users_group_id)\
2803 2802 .join(
2804 2803 UserGroupMember,
2805 2804 UserGroupRepoToPerm.users_group_id ==
2806 2805 UserGroupMember.users_group_id)\
2807 2806 .filter(
2808 2807 UserGroupMember.user_id == user_id,
2809 2808 UserGroup.users_group_active == true())
2810 2809 if repo_id:
2811 2810 q = q.filter(UserGroupRepoToPerm.repository_id == repo_id)
2812 2811 return q.all()
2813 2812
2814 2813 @classmethod
2815 2814 def get_default_group_perms(cls, user_id, repo_group_id=None):
2816 2815 q = Session().query(UserRepoGroupToPerm, RepoGroup, Permission)\
2817 2816 .join((Permission, UserRepoGroupToPerm.permission_id == Permission.permission_id))\
2818 2817 .join((RepoGroup, UserRepoGroupToPerm.group_id == RepoGroup.group_id))\
2819 2818 .filter(UserRepoGroupToPerm.user_id == user_id)
2820 2819 if repo_group_id:
2821 2820 q = q.filter(UserRepoGroupToPerm.group_id == repo_group_id)
2822 2821 return q.all()
2823 2822
2824 2823 @classmethod
2825 2824 def get_default_group_perms_from_user_group(
2826 2825 cls, user_id, repo_group_id=None):
2827 2826 q = Session().query(UserGroupRepoGroupToPerm, RepoGroup, Permission)\
2828 2827 .join(
2829 2828 Permission,
2830 2829 UserGroupRepoGroupToPerm.permission_id ==
2831 2830 Permission.permission_id)\
2832 2831 .join(
2833 2832 RepoGroup,
2834 2833 UserGroupRepoGroupToPerm.group_id == RepoGroup.group_id)\
2835 2834 .join(
2836 2835 UserGroup,
2837 2836 UserGroupRepoGroupToPerm.users_group_id ==
2838 2837 UserGroup.users_group_id)\
2839 2838 .join(
2840 2839 UserGroupMember,
2841 2840 UserGroupRepoGroupToPerm.users_group_id ==
2842 2841 UserGroupMember.users_group_id)\
2843 2842 .filter(
2844 2843 UserGroupMember.user_id == user_id,
2845 2844 UserGroup.users_group_active == true())
2846 2845 if repo_group_id:
2847 2846 q = q.filter(UserGroupRepoGroupToPerm.group_id == repo_group_id)
2848 2847 return q.all()
2849 2848
2850 2849 @classmethod
2851 2850 def get_default_user_group_perms(cls, user_id, user_group_id=None):
2852 2851 q = Session().query(UserUserGroupToPerm, UserGroup, Permission)\
2853 2852 .join((Permission, UserUserGroupToPerm.permission_id == Permission.permission_id))\
2854 2853 .join((UserGroup, UserUserGroupToPerm.user_group_id == UserGroup.users_group_id))\
2855 2854 .filter(UserUserGroupToPerm.user_id == user_id)
2856 2855 if user_group_id:
2857 2856 q = q.filter(UserUserGroupToPerm.user_group_id == user_group_id)
2858 2857 return q.all()
2859 2858
2860 2859 @classmethod
2861 2860 def get_default_user_group_perms_from_user_group(
2862 2861 cls, user_id, user_group_id=None):
2863 2862 TargetUserGroup = aliased(UserGroup, name='target_user_group')
2864 2863 q = Session().query(UserGroupUserGroupToPerm, UserGroup, Permission)\
2865 2864 .join(
2866 2865 Permission,
2867 2866 UserGroupUserGroupToPerm.permission_id ==
2868 2867 Permission.permission_id)\
2869 2868 .join(
2870 2869 TargetUserGroup,
2871 2870 UserGroupUserGroupToPerm.target_user_group_id ==
2872 2871 TargetUserGroup.users_group_id)\
2873 2872 .join(
2874 2873 UserGroup,
2875 2874 UserGroupUserGroupToPerm.user_group_id ==
2876 2875 UserGroup.users_group_id)\
2877 2876 .join(
2878 2877 UserGroupMember,
2879 2878 UserGroupUserGroupToPerm.user_group_id ==
2880 2879 UserGroupMember.users_group_id)\
2881 2880 .filter(
2882 2881 UserGroupMember.user_id == user_id,
2883 2882 UserGroup.users_group_active == true())
2884 2883 if user_group_id:
2885 2884 q = q.filter(
2886 2885 UserGroupUserGroupToPerm.user_group_id == user_group_id)
2887 2886
2888 2887 return q.all()
2889 2888
2890 2889
2891 2890 class UserRepoToPerm(Base, BaseModel):
2892 2891 __tablename__ = 'repo_to_perm'
2893 2892 __table_args__ = (
2894 2893 UniqueConstraint('user_id', 'repository_id', 'permission_id'),
2895 2894 base_table_args
2896 2895 )
2897 2896
2898 2897 repo_to_perm_id = Column("repo_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2899 2898 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2900 2899 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2901 2900 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2902 2901
2903 2902 user = relationship('User')
2904 2903 repository = relationship('Repository')
2905 2904 permission = relationship('Permission')
2906 2905
2907 2906 @classmethod
2908 2907 def create(cls, user, repository, permission):
2909 2908 n = cls()
2910 2909 n.user = user
2911 2910 n.repository = repository
2912 2911 n.permission = permission
2913 2912 Session().add(n)
2914 2913 return n
2915 2914
2916 2915 def __unicode__(self):
2917 2916 return u'<%s => %s >' % (self.user, self.repository)
2918 2917
2919 2918
2920 2919 class UserUserGroupToPerm(Base, BaseModel):
2921 2920 __tablename__ = 'user_user_group_to_perm'
2922 2921 __table_args__ = (
2923 2922 UniqueConstraint('user_id', 'user_group_id', 'permission_id'),
2924 2923 base_table_args
2925 2924 )
2926 2925
2927 2926 user_user_group_to_perm_id = Column("user_user_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2928 2927 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2929 2928 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2930 2929 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2931 2930
2932 2931 user = relationship('User')
2933 2932 user_group = relationship('UserGroup')
2934 2933 permission = relationship('Permission')
2935 2934
2936 2935 @classmethod
2937 2936 def create(cls, user, user_group, permission):
2938 2937 n = cls()
2939 2938 n.user = user
2940 2939 n.user_group = user_group
2941 2940 n.permission = permission
2942 2941 Session().add(n)
2943 2942 return n
2944 2943
2945 2944 def __unicode__(self):
2946 2945 return u'<%s => %s >' % (self.user, self.user_group)
2947 2946
2948 2947
2949 2948 class UserToPerm(Base, BaseModel):
2950 2949 __tablename__ = 'user_to_perm'
2951 2950 __table_args__ = (
2952 2951 UniqueConstraint('user_id', 'permission_id'),
2953 2952 base_table_args
2954 2953 )
2955 2954
2956 2955 user_to_perm_id = Column("user_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2957 2956 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
2958 2957 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2959 2958
2960 2959 user = relationship('User')
2961 2960 permission = relationship('Permission', lazy='joined')
2962 2961
2963 2962 def __unicode__(self):
2964 2963 return u'<%s => %s >' % (self.user, self.permission)
2965 2964
2966 2965
2967 2966 class UserGroupRepoToPerm(Base, BaseModel):
2968 2967 __tablename__ = 'users_group_repo_to_perm'
2969 2968 __table_args__ = (
2970 2969 UniqueConstraint('repository_id', 'users_group_id', 'permission_id'),
2971 2970 base_table_args
2972 2971 )
2973 2972
2974 2973 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
2975 2974 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
2976 2975 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
2977 2976 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=None, default=None)
2978 2977
2979 2978 users_group = relationship('UserGroup')
2980 2979 permission = relationship('Permission')
2981 2980 repository = relationship('Repository')
2982 2981
2983 2982 @classmethod
2984 2983 def create(cls, users_group, repository, permission):
2985 2984 n = cls()
2986 2985 n.users_group = users_group
2987 2986 n.repository = repository
2988 2987 n.permission = permission
2989 2988 Session().add(n)
2990 2989 return n
2991 2990
2992 2991 def __unicode__(self):
2993 2992 return u'<UserGroupRepoToPerm:%s => %s >' % (self.users_group, self.repository)
2994 2993
2995 2994
2996 2995 class UserGroupUserGroupToPerm(Base, BaseModel):
2997 2996 __tablename__ = 'user_group_user_group_to_perm'
2998 2997 __table_args__ = (
2999 2998 UniqueConstraint('target_user_group_id', 'user_group_id', 'permission_id'),
3000 2999 CheckConstraint('target_user_group_id != user_group_id'),
3001 3000 base_table_args
3002 3001 )
3003 3002
3004 3003 user_group_user_group_to_perm_id = Column("user_group_user_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3005 3004 target_user_group_id = Column("target_user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
3006 3005 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
3007 3006 user_group_id = Column("user_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
3008 3007
3009 3008 target_user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.target_user_group_id==UserGroup.users_group_id')
3010 3009 user_group = relationship('UserGroup', primaryjoin='UserGroupUserGroupToPerm.user_group_id==UserGroup.users_group_id')
3011 3010 permission = relationship('Permission')
3012 3011
3013 3012 @classmethod
3014 3013 def create(cls, target_user_group, user_group, permission):
3015 3014 n = cls()
3016 3015 n.target_user_group = target_user_group
3017 3016 n.user_group = user_group
3018 3017 n.permission = permission
3019 3018 Session().add(n)
3020 3019 return n
3021 3020
3022 3021 def __unicode__(self):
3023 3022 return u'<UserGroupUserGroup:%s => %s >' % (self.target_user_group, self.user_group)
3024 3023
3025 3024
3026 3025 class UserGroupToPerm(Base, BaseModel):
3027 3026 __tablename__ = 'users_group_to_perm'
3028 3027 __table_args__ = (
3029 3028 UniqueConstraint('users_group_id', 'permission_id',),
3030 3029 base_table_args
3031 3030 )
3032 3031
3033 3032 users_group_to_perm_id = Column("users_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3034 3033 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
3035 3034 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
3036 3035
3037 3036 users_group = relationship('UserGroup')
3038 3037 permission = relationship('Permission')
3039 3038
3040 3039
3041 3040 class UserRepoGroupToPerm(Base, BaseModel):
3042 3041 __tablename__ = 'user_repo_group_to_perm'
3043 3042 __table_args__ = (
3044 3043 UniqueConstraint('user_id', 'group_id', 'permission_id'),
3045 3044 base_table_args
3046 3045 )
3047 3046
3048 3047 group_to_perm_id = Column("group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3049 3048 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
3050 3049 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
3051 3050 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
3052 3051
3053 3052 user = relationship('User')
3054 3053 group = relationship('RepoGroup')
3055 3054 permission = relationship('Permission')
3056 3055
3057 3056 @classmethod
3058 3057 def create(cls, user, repository_group, permission):
3059 3058 n = cls()
3060 3059 n.user = user
3061 3060 n.group = repository_group
3062 3061 n.permission = permission
3063 3062 Session().add(n)
3064 3063 return n
3065 3064
3066 3065
3067 3066 class UserGroupRepoGroupToPerm(Base, BaseModel):
3068 3067 __tablename__ = 'users_group_repo_group_to_perm'
3069 3068 __table_args__ = (
3070 3069 UniqueConstraint('users_group_id', 'group_id'),
3071 3070 base_table_args
3072 3071 )
3073 3072
3074 3073 users_group_repo_group_to_perm_id = Column("users_group_repo_group_to_perm_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3075 3074 users_group_id = Column("users_group_id", Integer(), ForeignKey('users_groups.users_group_id'), nullable=False, unique=None, default=None)
3076 3075 group_id = Column("group_id", Integer(), ForeignKey('groups.group_id'), nullable=False, unique=None, default=None)
3077 3076 permission_id = Column("permission_id", Integer(), ForeignKey('permissions.permission_id'), nullable=False, unique=None, default=None)
3078 3077
3079 3078 users_group = relationship('UserGroup')
3080 3079 permission = relationship('Permission')
3081 3080 group = relationship('RepoGroup')
3082 3081
3083 3082 @classmethod
3084 3083 def create(cls, user_group, repository_group, permission):
3085 3084 n = cls()
3086 3085 n.users_group = user_group
3087 3086 n.group = repository_group
3088 3087 n.permission = permission
3089 3088 Session().add(n)
3090 3089 return n
3091 3090
3092 3091 def __unicode__(self):
3093 3092 return u'<UserGroupRepoGroupToPerm:%s => %s >' % (self.users_group, self.group)
3094 3093
3095 3094
3096 3095 class Statistics(Base, BaseModel):
3097 3096 __tablename__ = 'statistics'
3098 3097 __table_args__ = (
3099 3098 base_table_args
3100 3099 )
3101 3100
3102 3101 stat_id = Column("stat_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3103 3102 repository_id = Column("repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=False, unique=True, default=None)
3104 3103 stat_on_revision = Column("stat_on_revision", Integer(), nullable=False)
3105 3104 commit_activity = Column("commit_activity", LargeBinary(1000000), nullable=False)#JSON data
3106 3105 commit_activity_combined = Column("commit_activity_combined", LargeBinary(), nullable=False)#JSON data
3107 3106 languages = Column("languages", LargeBinary(1000000), nullable=False)#JSON data
3108 3107
3109 3108 repository = relationship('Repository', single_parent=True)
3110 3109
3111 3110
3112 3111 class UserFollowing(Base, BaseModel):
3113 3112 __tablename__ = 'user_followings'
3114 3113 __table_args__ = (
3115 3114 UniqueConstraint('user_id', 'follows_repository_id'),
3116 3115 UniqueConstraint('user_id', 'follows_user_id'),
3117 3116 base_table_args
3118 3117 )
3119 3118
3120 3119 user_following_id = Column("user_following_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3121 3120 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None, default=None)
3122 3121 follows_repo_id = Column("follows_repository_id", Integer(), ForeignKey('repositories.repo_id'), nullable=True, unique=None, default=None)
3123 3122 follows_user_id = Column("follows_user_id", Integer(), ForeignKey('users.user_id'), nullable=True, unique=None, default=None)
3124 3123 follows_from = Column('follows_from', DateTime(timezone=False), nullable=True, unique=None, default=datetime.datetime.now)
3125 3124
3126 3125 user = relationship('User', primaryjoin='User.user_id==UserFollowing.user_id')
3127 3126
3128 3127 follows_user = relationship('User', primaryjoin='User.user_id==UserFollowing.follows_user_id')
3129 3128 follows_repository = relationship('Repository', order_by='Repository.repo_name')
3130 3129
3131 3130 @classmethod
3132 3131 def get_repo_followers(cls, repo_id):
3133 3132 return cls.query().filter(cls.follows_repo_id == repo_id)
3134 3133
3135 3134
3136 3135 class CacheKey(Base, BaseModel):
3137 3136 __tablename__ = 'cache_invalidation'
3138 3137 __table_args__ = (
3139 3138 UniqueConstraint('cache_key'),
3140 3139 Index('key_idx', 'cache_key'),
3141 3140 base_table_args,
3142 3141 )
3143 3142
3144 3143 CACHE_TYPE_FEED = 'FEED'
3145 3144 CACHE_TYPE_README = 'README'
3146 3145 # namespaces used to register process/thread aware caches
3147 3146 REPO_INVALIDATION_NAMESPACE = 'repo_cache:{repo_id}'
3148 3147
3149 3148 cache_id = Column("cache_id", Integer(), nullable=False, unique=True, default=None, primary_key=True)
3150 3149 cache_key = Column("cache_key", String(255), nullable=True, unique=None, default=None)
3151 3150 cache_args = Column("cache_args", String(255), nullable=True, unique=None, default=None)
3152 3151 cache_active = Column("cache_active", Boolean(), nullable=True, unique=None, default=False)
3153 3152
3154 3153 def __init__(self, cache_key, cache_args=''):
3155 3154 self.cache_key = cache_key
3156 3155 self.cache_args = cache_args
3157 3156 self.cache_active = False
3158 3157
3159 3158 def __unicode__(self):
3160 3159 return u"<%s('%s:%s[%s]')>" % (
3161 3160 self.__class__.__name__,
3162 3161 self.cache_id, self.cache_key, self.cache_active)
3163 3162
3164 3163 def _cache_key_partition(self):
3165 3164 prefix, repo_name, suffix = self.cache_key.partition(self.cache_args)
3166 3165 return prefix, repo_name, suffix
3167 3166
3168 3167 def get_prefix(self):
3169 3168 """
3170 3169 Try to extract prefix from existing cache key. The key could consist
3171 3170 of prefix, repo_name, suffix
3172 3171 """
3173 3172 # this returns prefix, repo_name, suffix
3174 3173 return self._cache_key_partition()[0]
3175 3174
3176 3175 def get_suffix(self):
3177 3176 """
3178 3177 get suffix that might have been used in _get_cache_key to
3179 3178 generate self.cache_key. Only used for informational purposes
3180 3179 in repo_edit.mako.
3181 3180 """
3182 3181 # prefix, repo_name, suffix
3183 3182 return self._cache_key_partition()[2]
3184 3183
3185 3184 @classmethod
3186 3185 def delete_all_cache(cls):
3187 3186 """
3188 3187 Delete all cache keys from database.
3189 3188 Should only be run when all instances are down and all entries
3190 3189 thus stale.
3191 3190 """
3192 3191 cls.query().delete()
3193 3192 Session().commit()
3194 3193
3195 3194 @classmethod
3196 3195 def set_invalidate(cls, cache_uid, delete=False):
3197 3196 """
3198 3197 Mark all caches of a repo as invalid in the database.
3199 3198 """
3200 3199
3201 3200 try:
3202 3201 qry = Session().query(cls).filter(cls.cache_args == cache_uid)
3203 3202 if delete:
3204 3203 qry.delete()
3205 3204 log.debug('cache objects deleted for cache args %s',
3206 3205 safe_str(cache_uid))
3207 3206 else:
3208 3207 qry.update({"cache_active": False})
3209 3208 log.debug('cache objects marked as invalid for cache args %s',
3210 3209 safe_str(cache_uid))
3211 3210
3212 3211 Session().commit()
3213 3212 except Exception:
3214 3213 log.exception(
3215 3214 'Cache key invalidation failed for cache args %s',
3216 3215 safe_str(cache_uid))
3217 3216 Session().rollback()
3218 3217
3219 3218 @classmethod
3220 3219 def get_active_cache(cls, cache_key):
3221 3220 inv_obj = cls.query().filter(cls.cache_key == cache_key).scalar()
3222 3221 if inv_obj:
3223 3222 return inv_obj
3224 3223 return None
3225 3224
3226 3225
3227 3226 class ChangesetComment(Base, BaseModel):
3228 3227 __tablename__ = 'changeset_comments'
3229 3228 __table_args__ = (
3230 3229 Index('cc_revision_idx', 'revision'),
3231 3230 base_table_args,
3232 3231 )
3233 3232
3234 3233 COMMENT_OUTDATED = u'comment_outdated'
3235 3234 COMMENT_TYPE_NOTE = u'note'
3236 3235 COMMENT_TYPE_TODO = u'todo'
3237 3236 COMMENT_TYPES = [COMMENT_TYPE_NOTE, COMMENT_TYPE_TODO]
3238 3237
3239 3238 comment_id = Column('comment_id', Integer(), nullable=False, primary_key=True)
3240 3239 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3241 3240 revision = Column('revision', String(40), nullable=True)
3242 3241 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3243 3242 pull_request_version_id = Column("pull_request_version_id", Integer(), ForeignKey('pull_request_versions.pull_request_version_id'), nullable=True)
3244 3243 line_no = Column('line_no', Unicode(10), nullable=True)
3245 3244 hl_lines = Column('hl_lines', Unicode(512), nullable=True)
3246 3245 f_path = Column('f_path', Unicode(1000), nullable=True)
3247 3246 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=False)
3248 3247 text = Column('text', UnicodeText().with_variant(UnicodeText(25000), 'mysql'), nullable=False)
3249 3248 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3250 3249 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3251 3250 renderer = Column('renderer', Unicode(64), nullable=True)
3252 3251 display_state = Column('display_state', Unicode(128), nullable=True)
3253 3252
3254 3253 comment_type = Column('comment_type', Unicode(128), nullable=True, default=COMMENT_TYPE_NOTE)
3255 3254 resolved_comment_id = Column('resolved_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'), nullable=True)
3256 3255 resolved_comment = relationship('ChangesetComment', remote_side=comment_id, backref='resolved_by')
3257 3256 author = relationship('User', lazy='joined')
3258 3257 repo = relationship('Repository')
3259 3258 status_change = relationship('ChangesetStatus', cascade="all, delete, delete-orphan", lazy='joined')
3260 3259 pull_request = relationship('PullRequest', lazy='joined')
3261 3260 pull_request_version = relationship('PullRequestVersion')
3262 3261
3263 3262 @classmethod
3264 3263 def get_users(cls, revision=None, pull_request_id=None):
3265 3264 """
3266 3265 Returns user associated with this ChangesetComment. ie those
3267 3266 who actually commented
3268 3267
3269 3268 :param cls:
3270 3269 :param revision:
3271 3270 """
3272 3271 q = Session().query(User)\
3273 3272 .join(ChangesetComment.author)
3274 3273 if revision:
3275 3274 q = q.filter(cls.revision == revision)
3276 3275 elif pull_request_id:
3277 3276 q = q.filter(cls.pull_request_id == pull_request_id)
3278 3277 return q.all()
3279 3278
3280 3279 @classmethod
3281 3280 def get_index_from_version(cls, pr_version, versions):
3282 3281 num_versions = [x.pull_request_version_id for x in versions]
3283 3282 try:
3284 3283 return num_versions.index(pr_version) +1
3285 3284 except (IndexError, ValueError):
3286 3285 return
3287 3286
3288 3287 @property
3289 3288 def outdated(self):
3290 3289 return self.display_state == self.COMMENT_OUTDATED
3291 3290
3292 3291 def outdated_at_version(self, version):
3293 3292 """
3294 3293 Checks if comment is outdated for given pull request version
3295 3294 """
3296 3295 return self.outdated and self.pull_request_version_id != version
3297 3296
3298 3297 def older_than_version(self, version):
3299 3298 """
3300 3299 Checks if comment is made from previous version than given
3301 3300 """
3302 3301 if version is None:
3303 3302 return self.pull_request_version_id is not None
3304 3303
3305 3304 return self.pull_request_version_id < version
3306 3305
3307 3306 @property
3308 3307 def resolved(self):
3309 3308 return self.resolved_by[0] if self.resolved_by else None
3310 3309
3311 3310 @property
3312 3311 def is_todo(self):
3313 3312 return self.comment_type == self.COMMENT_TYPE_TODO
3314 3313
3315 3314 @property
3316 3315 def is_inline(self):
3317 3316 return self.line_no and self.f_path
3318 3317
3319 3318 def get_index_version(self, versions):
3320 3319 return self.get_index_from_version(
3321 3320 self.pull_request_version_id, versions)
3322 3321
3323 3322 def __repr__(self):
3324 3323 if self.comment_id:
3325 3324 return '<DB:Comment #%s>' % self.comment_id
3326 3325 else:
3327 3326 return '<DB:Comment at %#x>' % id(self)
3328 3327
3329 3328 def get_api_data(self):
3330 3329 comment = self
3331 3330 data = {
3332 3331 'comment_id': comment.comment_id,
3333 3332 'comment_type': comment.comment_type,
3334 3333 'comment_text': comment.text,
3335 3334 'comment_status': comment.status_change,
3336 3335 'comment_f_path': comment.f_path,
3337 3336 'comment_lineno': comment.line_no,
3338 3337 'comment_author': comment.author,
3339 3338 'comment_created_on': comment.created_on
3340 3339 }
3341 3340 return data
3342 3341
3343 3342 def __json__(self):
3344 3343 data = dict()
3345 3344 data.update(self.get_api_data())
3346 3345 return data
3347 3346
3348 3347
3349 3348 class ChangesetStatus(Base, BaseModel):
3350 3349 __tablename__ = 'changeset_statuses'
3351 3350 __table_args__ = (
3352 3351 Index('cs_revision_idx', 'revision'),
3353 3352 Index('cs_version_idx', 'version'),
3354 3353 UniqueConstraint('repo_id', 'revision', 'version'),
3355 3354 base_table_args
3356 3355 )
3357 3356
3358 3357 STATUS_NOT_REVIEWED = DEFAULT = 'not_reviewed'
3359 3358 STATUS_APPROVED = 'approved'
3360 3359 STATUS_REJECTED = 'rejected'
3361 3360 STATUS_UNDER_REVIEW = 'under_review'
3362 3361
3363 3362 STATUSES = [
3364 3363 (STATUS_NOT_REVIEWED, _("Not Reviewed")), # (no icon) and default
3365 3364 (STATUS_APPROVED, _("Approved")),
3366 3365 (STATUS_REJECTED, _("Rejected")),
3367 3366 (STATUS_UNDER_REVIEW, _("Under Review")),
3368 3367 ]
3369 3368
3370 3369 changeset_status_id = Column('changeset_status_id', Integer(), nullable=False, primary_key=True)
3371 3370 repo_id = Column('repo_id', Integer(), ForeignKey('repositories.repo_id'), nullable=False)
3372 3371 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False, unique=None)
3373 3372 revision = Column('revision', String(40), nullable=False)
3374 3373 status = Column('status', String(128), nullable=False, default=DEFAULT)
3375 3374 changeset_comment_id = Column('changeset_comment_id', Integer(), ForeignKey('changeset_comments.comment_id'))
3376 3375 modified_at = Column('modified_at', DateTime(), nullable=False, default=datetime.datetime.now)
3377 3376 version = Column('version', Integer(), nullable=False, default=0)
3378 3377 pull_request_id = Column("pull_request_id", Integer(), ForeignKey('pull_requests.pull_request_id'), nullable=True)
3379 3378
3380 3379 author = relationship('User', lazy='joined')
3381 3380 repo = relationship('Repository')
3382 3381 comment = relationship('ChangesetComment', lazy='joined')
3383 3382 pull_request = relationship('PullRequest', lazy='joined')
3384 3383
3385 3384 def __unicode__(self):
3386 3385 return u"<%s('%s[v%s]:%s')>" % (
3387 3386 self.__class__.__name__,
3388 3387 self.status, self.version, self.author
3389 3388 )
3390 3389
3391 3390 @classmethod
3392 3391 def get_status_lbl(cls, value):
3393 3392 return dict(cls.STATUSES).get(value)
3394 3393
3395 3394 @property
3396 3395 def status_lbl(self):
3397 3396 return ChangesetStatus.get_status_lbl(self.status)
3398 3397
3399 3398 def get_api_data(self):
3400 3399 status = self
3401 3400 data = {
3402 3401 'status_id': status.changeset_status_id,
3403 3402 'status': status.status,
3404 3403 }
3405 3404 return data
3406 3405
3407 3406 def __json__(self):
3408 3407 data = dict()
3409 3408 data.update(self.get_api_data())
3410 3409 return data
3411 3410
3412 3411
3413 3412 class _PullRequestBase(BaseModel):
3414 3413 """
3415 3414 Common attributes of pull request and version entries.
3416 3415 """
3417 3416
3418 3417 # .status values
3419 3418 STATUS_NEW = u'new'
3420 3419 STATUS_OPEN = u'open'
3421 3420 STATUS_CLOSED = u'closed'
3422 3421
3423 3422 title = Column('title', Unicode(255), nullable=True)
3424 3423 description = Column(
3425 3424 'description', UnicodeText().with_variant(UnicodeText(10240), 'mysql'),
3426 3425 nullable=True)
3427 3426 description_renderer = Column('description_renderer', Unicode(64), nullable=True)
3428 3427
3429 3428 # new/open/closed status of pull request (not approve/reject/etc)
3430 3429 status = Column('status', Unicode(255), nullable=False, default=STATUS_NEW)
3431 3430 created_on = Column(
3432 3431 'created_on', DateTime(timezone=False), nullable=False,
3433 3432 default=datetime.datetime.now)
3434 3433 updated_on = Column(
3435 3434 'updated_on', DateTime(timezone=False), nullable=False,
3436 3435 default=datetime.datetime.now)
3437 3436
3438 3437 @declared_attr
3439 3438 def user_id(cls):
3440 3439 return Column(
3441 3440 "user_id", Integer(), ForeignKey('users.user_id'), nullable=False,
3442 3441 unique=None)
3443 3442
3444 3443 # 500 revisions max
3445 3444 _revisions = Column(
3446 3445 'revisions', UnicodeText().with_variant(UnicodeText(20500), 'mysql'))
3447 3446
3448 3447 @declared_attr
3449 3448 def source_repo_id(cls):
3450 3449 # TODO: dan: rename column to source_repo_id
3451 3450 return Column(
3452 3451 'org_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3453 3452 nullable=False)
3454 3453
3455 3454 source_ref = Column('org_ref', Unicode(255), nullable=False)
3456 3455
3457 3456 @declared_attr
3458 3457 def target_repo_id(cls):
3459 3458 # TODO: dan: rename column to target_repo_id
3460 3459 return Column(
3461 3460 'other_repo_id', Integer(), ForeignKey('repositories.repo_id'),
3462 3461 nullable=False)
3463 3462
3464 3463 target_ref = Column('other_ref', Unicode(255), nullable=False)
3465 3464 _shadow_merge_ref = Column('shadow_merge_ref', Unicode(255), nullable=True)
3466 3465
3467 3466 # TODO: dan: rename column to last_merge_source_rev
3468 3467 _last_merge_source_rev = Column(
3469 3468 'last_merge_org_rev', String(40), nullable=True)
3470 3469 # TODO: dan: rename column to last_merge_target_rev
3471 3470 _last_merge_target_rev = Column(
3472 3471 'last_merge_other_rev', String(40), nullable=True)
3473 3472 _last_merge_status = Column('merge_status', Integer(), nullable=True)
3474 3473 merge_rev = Column('merge_rev', String(40), nullable=True)
3475 3474
3476 3475 reviewer_data = Column(
3477 3476 'reviewer_data_json', MutationObj.as_mutable(
3478 3477 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
3479 3478
3480 3479 @property
3481 3480 def reviewer_data_json(self):
3482 3481 return json.dumps(self.reviewer_data)
3483 3482
3484 3483 @hybrid_property
3485 3484 def description_safe(self):
3486 3485 from rhodecode.lib import helpers as h
3487 3486 return h.escape(self.description)
3488 3487
3489 3488 @hybrid_property
3490 3489 def revisions(self):
3491 3490 return self._revisions.split(':') if self._revisions else []
3492 3491
3493 3492 @revisions.setter
3494 3493 def revisions(self, val):
3495 3494 self._revisions = ':'.join(val)
3496 3495
3497 3496 @hybrid_property
3498 3497 def last_merge_status(self):
3499 3498 return safe_int(self._last_merge_status)
3500 3499
3501 3500 @last_merge_status.setter
3502 3501 def last_merge_status(self, val):
3503 3502 self._last_merge_status = val
3504 3503
3505 3504 @declared_attr
3506 3505 def author(cls):
3507 3506 return relationship('User', lazy='joined')
3508 3507
3509 3508 @declared_attr
3510 3509 def source_repo(cls):
3511 3510 return relationship(
3512 3511 'Repository',
3513 3512 primaryjoin='%s.source_repo_id==Repository.repo_id' % cls.__name__)
3514 3513
3515 3514 @property
3516 3515 def source_ref_parts(self):
3517 3516 return self.unicode_to_reference(self.source_ref)
3518 3517
3519 3518 @declared_attr
3520 3519 def target_repo(cls):
3521 3520 return relationship(
3522 3521 'Repository',
3523 3522 primaryjoin='%s.target_repo_id==Repository.repo_id' % cls.__name__)
3524 3523
3525 3524 @property
3526 3525 def target_ref_parts(self):
3527 3526 return self.unicode_to_reference(self.target_ref)
3528 3527
3529 3528 @property
3530 3529 def shadow_merge_ref(self):
3531 3530 return self.unicode_to_reference(self._shadow_merge_ref)
3532 3531
3533 3532 @shadow_merge_ref.setter
3534 3533 def shadow_merge_ref(self, ref):
3535 3534 self._shadow_merge_ref = self.reference_to_unicode(ref)
3536 3535
3537 3536 def unicode_to_reference(self, raw):
3538 3537 """
3539 3538 Convert a unicode (or string) to a reference object.
3540 3539 If unicode evaluates to False it returns None.
3541 3540 """
3542 3541 if raw:
3543 3542 refs = raw.split(':')
3544 3543 return Reference(*refs)
3545 3544 else:
3546 3545 return None
3547 3546
3548 3547 def reference_to_unicode(self, ref):
3549 3548 """
3550 3549 Convert a reference object to unicode.
3551 3550 If reference is None it returns None.
3552 3551 """
3553 3552 if ref:
3554 3553 return u':'.join(ref)
3555 3554 else:
3556 3555 return None
3557 3556
3558 3557 def get_api_data(self, with_merge_state=True):
3559 3558 from rhodecode.model.pull_request import PullRequestModel
3560 3559
3561 3560 pull_request = self
3562 3561 if with_merge_state:
3563 3562 merge_status = PullRequestModel().merge_status(pull_request)
3564 3563 merge_state = {
3565 3564 'status': merge_status[0],
3566 3565 'message': safe_unicode(merge_status[1]),
3567 3566 }
3568 3567 else:
3569 3568 merge_state = {'status': 'not_available',
3570 3569 'message': 'not_available'}
3571 3570
3572 3571 merge_data = {
3573 3572 'clone_url': PullRequestModel().get_shadow_clone_url(pull_request),
3574 3573 'reference': (
3575 3574 pull_request.shadow_merge_ref._asdict()
3576 3575 if pull_request.shadow_merge_ref else None),
3577 3576 }
3578 3577
3579 3578 data = {
3580 3579 'pull_request_id': pull_request.pull_request_id,
3581 3580 'url': PullRequestModel().get_url(pull_request),
3582 3581 'title': pull_request.title,
3583 3582 'description': pull_request.description,
3584 3583 'status': pull_request.status,
3585 3584 'created_on': pull_request.created_on,
3586 3585 'updated_on': pull_request.updated_on,
3587 3586 'commit_ids': pull_request.revisions,
3588 3587 'review_status': pull_request.calculated_review_status(),
3589 3588 'mergeable': merge_state,
3590 3589 'source': {
3591 3590 'clone_url': pull_request.source_repo.clone_url(),
3592 3591 'repository': pull_request.source_repo.repo_name,
3593 3592 'reference': {
3594 3593 'name': pull_request.source_ref_parts.name,
3595 3594 'type': pull_request.source_ref_parts.type,
3596 3595 'commit_id': pull_request.source_ref_parts.commit_id,
3597 3596 },
3598 3597 },
3599 3598 'target': {
3600 3599 'clone_url': pull_request.target_repo.clone_url(),
3601 3600 'repository': pull_request.target_repo.repo_name,
3602 3601 'reference': {
3603 3602 'name': pull_request.target_ref_parts.name,
3604 3603 'type': pull_request.target_ref_parts.type,
3605 3604 'commit_id': pull_request.target_ref_parts.commit_id,
3606 3605 },
3607 3606 },
3608 3607 'merge': merge_data,
3609 3608 'author': pull_request.author.get_api_data(include_secrets=False,
3610 3609 details='basic'),
3611 3610 'reviewers': [
3612 3611 {
3613 3612 'user': reviewer.get_api_data(include_secrets=False,
3614 3613 details='basic'),
3615 3614 'reasons': reasons,
3616 3615 'review_status': st[0][1].status if st else 'not_reviewed',
3617 3616 }
3618 3617 for obj, reviewer, reasons, mandatory, st in
3619 3618 pull_request.reviewers_statuses()
3620 3619 ]
3621 3620 }
3622 3621
3623 3622 return data
3624 3623
3625 3624
3626 3625 class PullRequest(Base, _PullRequestBase):
3627 3626 __tablename__ = 'pull_requests'
3628 3627 __table_args__ = (
3629 3628 base_table_args,
3630 3629 )
3631 3630
3632 3631 pull_request_id = Column(
3633 3632 'pull_request_id', Integer(), nullable=False, primary_key=True)
3634 3633
3635 3634 def __repr__(self):
3636 3635 if self.pull_request_id:
3637 3636 return '<DB:PullRequest #%s>' % self.pull_request_id
3638 3637 else:
3639 3638 return '<DB:PullRequest at %#x>' % id(self)
3640 3639
3641 3640 reviewers = relationship('PullRequestReviewers',
3642 3641 cascade="all, delete, delete-orphan")
3643 3642 statuses = relationship('ChangesetStatus',
3644 3643 cascade="all, delete, delete-orphan")
3645 3644 comments = relationship('ChangesetComment',
3646 3645 cascade="all, delete, delete-orphan")
3647 3646 versions = relationship('PullRequestVersion',
3648 3647 cascade="all, delete, delete-orphan",
3649 3648 lazy='dynamic')
3650 3649
3651 3650 @classmethod
3652 3651 def get_pr_display_object(cls, pull_request_obj, org_pull_request_obj,
3653 3652 internal_methods=None):
3654 3653
3655 3654 class PullRequestDisplay(object):
3656 3655 """
3657 3656 Special object wrapper for showing PullRequest data via Versions
3658 3657 It mimics PR object as close as possible. This is read only object
3659 3658 just for display
3660 3659 """
3661 3660
3662 3661 def __init__(self, attrs, internal=None):
3663 3662 self.attrs = attrs
3664 3663 # internal have priority over the given ones via attrs
3665 3664 self.internal = internal or ['versions']
3666 3665
3667 3666 def __getattr__(self, item):
3668 3667 if item in self.internal:
3669 3668 return getattr(self, item)
3670 3669 try:
3671 3670 return self.attrs[item]
3672 3671 except KeyError:
3673 3672 raise AttributeError(
3674 3673 '%s object has no attribute %s' % (self, item))
3675 3674
3676 3675 def __repr__(self):
3677 3676 return '<DB:PullRequestDisplay #%s>' % self.attrs.get('pull_request_id')
3678 3677
3679 3678 def versions(self):
3680 3679 return pull_request_obj.versions.order_by(
3681 3680 PullRequestVersion.pull_request_version_id).all()
3682 3681
3683 3682 def is_closed(self):
3684 3683 return pull_request_obj.is_closed()
3685 3684
3686 3685 @property
3687 3686 def pull_request_version_id(self):
3688 3687 return getattr(pull_request_obj, 'pull_request_version_id', None)
3689 3688
3690 3689 attrs = StrictAttributeDict(pull_request_obj.get_api_data())
3691 3690
3692 3691 attrs.author = StrictAttributeDict(
3693 3692 pull_request_obj.author.get_api_data())
3694 3693 if pull_request_obj.target_repo:
3695 3694 attrs.target_repo = StrictAttributeDict(
3696 3695 pull_request_obj.target_repo.get_api_data())
3697 3696 attrs.target_repo.clone_url = pull_request_obj.target_repo.clone_url
3698 3697
3699 3698 if pull_request_obj.source_repo:
3700 3699 attrs.source_repo = StrictAttributeDict(
3701 3700 pull_request_obj.source_repo.get_api_data())
3702 3701 attrs.source_repo.clone_url = pull_request_obj.source_repo.clone_url
3703 3702
3704 3703 attrs.source_ref_parts = pull_request_obj.source_ref_parts
3705 3704 attrs.target_ref_parts = pull_request_obj.target_ref_parts
3706 3705 attrs.revisions = pull_request_obj.revisions
3707 3706
3708 3707 attrs.shadow_merge_ref = org_pull_request_obj.shadow_merge_ref
3709 3708 attrs.reviewer_data = org_pull_request_obj.reviewer_data
3710 3709 attrs.reviewer_data_json = org_pull_request_obj.reviewer_data_json
3711 3710
3712 3711 return PullRequestDisplay(attrs, internal=internal_methods)
3713 3712
3714 3713 def is_closed(self):
3715 3714 return self.status == self.STATUS_CLOSED
3716 3715
3717 3716 def __json__(self):
3718 3717 return {
3719 3718 'revisions': self.revisions,
3720 3719 }
3721 3720
3722 3721 def calculated_review_status(self):
3723 3722 from rhodecode.model.changeset_status import ChangesetStatusModel
3724 3723 return ChangesetStatusModel().calculated_review_status(self)
3725 3724
3726 3725 def reviewers_statuses(self):
3727 3726 from rhodecode.model.changeset_status import ChangesetStatusModel
3728 3727 return ChangesetStatusModel().reviewers_statuses(self)
3729 3728
3730 3729 @property
3731 3730 def workspace_id(self):
3732 3731 from rhodecode.model.pull_request import PullRequestModel
3733 3732 return PullRequestModel()._workspace_id(self)
3734 3733
3735 3734 def get_shadow_repo(self):
3736 3735 workspace_id = self.workspace_id
3737 3736 vcs_obj = self.target_repo.scm_instance()
3738 3737 shadow_repository_path = vcs_obj._get_shadow_repository_path(
3739 3738 self.target_repo.repo_id, workspace_id)
3740 3739 if os.path.isdir(shadow_repository_path):
3741 3740 return vcs_obj._get_shadow_instance(shadow_repository_path)
3742 3741
3743 3742
3744 3743 class PullRequestVersion(Base, _PullRequestBase):
3745 3744 __tablename__ = 'pull_request_versions'
3746 3745 __table_args__ = (
3747 3746 base_table_args,
3748 3747 )
3749 3748
3750 3749 pull_request_version_id = Column(
3751 3750 'pull_request_version_id', Integer(), nullable=False, primary_key=True)
3752 3751 pull_request_id = Column(
3753 3752 'pull_request_id', Integer(),
3754 3753 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3755 3754 pull_request = relationship('PullRequest')
3756 3755
3757 3756 def __repr__(self):
3758 3757 if self.pull_request_version_id:
3759 3758 return '<DB:PullRequestVersion #%s>' % self.pull_request_version_id
3760 3759 else:
3761 3760 return '<DB:PullRequestVersion at %#x>' % id(self)
3762 3761
3763 3762 @property
3764 3763 def reviewers(self):
3765 3764 return self.pull_request.reviewers
3766 3765
3767 3766 @property
3768 3767 def versions(self):
3769 3768 return self.pull_request.versions
3770 3769
3771 3770 def is_closed(self):
3772 3771 # calculate from original
3773 3772 return self.pull_request.status == self.STATUS_CLOSED
3774 3773
3775 3774 def calculated_review_status(self):
3776 3775 return self.pull_request.calculated_review_status()
3777 3776
3778 3777 def reviewers_statuses(self):
3779 3778 return self.pull_request.reviewers_statuses()
3780 3779
3781 3780
3782 3781 class PullRequestReviewers(Base, BaseModel):
3783 3782 __tablename__ = 'pull_request_reviewers'
3784 3783 __table_args__ = (
3785 3784 base_table_args,
3786 3785 )
3787 3786
3788 3787 @hybrid_property
3789 3788 def reasons(self):
3790 3789 if not self._reasons:
3791 3790 return []
3792 3791 return self._reasons
3793 3792
3794 3793 @reasons.setter
3795 3794 def reasons(self, val):
3796 3795 val = val or []
3797 3796 if any(not isinstance(x, basestring) for x in val):
3798 3797 raise Exception('invalid reasons type, must be list of strings')
3799 3798 self._reasons = val
3800 3799
3801 3800 pull_requests_reviewers_id = Column(
3802 3801 'pull_requests_reviewers_id', Integer(), nullable=False,
3803 3802 primary_key=True)
3804 3803 pull_request_id = Column(
3805 3804 "pull_request_id", Integer(),
3806 3805 ForeignKey('pull_requests.pull_request_id'), nullable=False)
3807 3806 user_id = Column(
3808 3807 "user_id", Integer(), ForeignKey('users.user_id'), nullable=True)
3809 3808 _reasons = Column(
3810 3809 'reason', MutationList.as_mutable(
3811 3810 JsonType('list', dialect_map=dict(mysql=UnicodeText(16384)))))
3812 3811
3813 3812 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
3814 3813 user = relationship('User')
3815 3814 pull_request = relationship('PullRequest')
3816 3815
3817 3816 rule_data = Column(
3818 3817 'rule_data_json',
3819 3818 JsonType(dialect_map=dict(mysql=UnicodeText(16384))))
3820 3819
3821 3820 def rule_user_group_data(self):
3822 3821 """
3823 3822 Returns the voting user group rule data for this reviewer
3824 3823 """
3825 3824
3826 3825 if self.rule_data and 'vote_rule' in self.rule_data:
3827 3826 user_group_data = {}
3828 3827 if 'rule_user_group_entry_id' in self.rule_data:
3829 3828 # means a group with voting rules !
3830 3829 user_group_data['id'] = self.rule_data['rule_user_group_entry_id']
3831 3830 user_group_data['name'] = self.rule_data['rule_name']
3832 3831 user_group_data['vote_rule'] = self.rule_data['vote_rule']
3833 3832
3834 3833 return user_group_data
3835 3834
3836 3835 def __unicode__(self):
3837 3836 return u"<%s('id:%s')>" % (self.__class__.__name__,
3838 3837 self.pull_requests_reviewers_id)
3839 3838
3840 3839
3841 3840 class Notification(Base, BaseModel):
3842 3841 __tablename__ = 'notifications'
3843 3842 __table_args__ = (
3844 3843 Index('notification_type_idx', 'type'),
3845 3844 base_table_args,
3846 3845 )
3847 3846
3848 3847 TYPE_CHANGESET_COMMENT = u'cs_comment'
3849 3848 TYPE_MESSAGE = u'message'
3850 3849 TYPE_MENTION = u'mention'
3851 3850 TYPE_REGISTRATION = u'registration'
3852 3851 TYPE_PULL_REQUEST = u'pull_request'
3853 3852 TYPE_PULL_REQUEST_COMMENT = u'pull_request_comment'
3854 3853
3855 3854 notification_id = Column('notification_id', Integer(), nullable=False, primary_key=True)
3856 3855 subject = Column('subject', Unicode(512), nullable=True)
3857 3856 body = Column('body', UnicodeText().with_variant(UnicodeText(50000), 'mysql'), nullable=True)
3858 3857 created_by = Column("created_by", Integer(), ForeignKey('users.user_id'), nullable=True)
3859 3858 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3860 3859 type_ = Column('type', Unicode(255))
3861 3860
3862 3861 created_by_user = relationship('User')
3863 3862 notifications_to_users = relationship('UserNotification', lazy='joined',
3864 3863 cascade="all, delete, delete-orphan")
3865 3864
3866 3865 @property
3867 3866 def recipients(self):
3868 3867 return [x.user for x in UserNotification.query()\
3869 3868 .filter(UserNotification.notification == self)\
3870 3869 .order_by(UserNotification.user_id.asc()).all()]
3871 3870
3872 3871 @classmethod
3873 3872 def create(cls, created_by, subject, body, recipients, type_=None):
3874 3873 if type_ is None:
3875 3874 type_ = Notification.TYPE_MESSAGE
3876 3875
3877 3876 notification = cls()
3878 3877 notification.created_by_user = created_by
3879 3878 notification.subject = subject
3880 3879 notification.body = body
3881 3880 notification.type_ = type_
3882 3881 notification.created_on = datetime.datetime.now()
3883 3882
3884 3883 # For each recipient link the created notification to his account
3885 3884 for u in recipients:
3886 3885 assoc = UserNotification()
3887 3886 assoc.user_id = u.user_id
3888 3887 assoc.notification = notification
3889 3888
3890 3889 # if created_by is inside recipients mark his notification
3891 3890 # as read
3892 3891 if u.user_id == created_by.user_id:
3893 3892 assoc.read = True
3894 3893 Session().add(assoc)
3895 3894
3896 3895 Session().add(notification)
3897 3896
3898 3897 return notification
3899 3898
3900 3899
3901 3900 class UserNotification(Base, BaseModel):
3902 3901 __tablename__ = 'user_to_notification'
3903 3902 __table_args__ = (
3904 3903 UniqueConstraint('user_id', 'notification_id'),
3905 3904 base_table_args
3906 3905 )
3907 3906
3908 3907 user_id = Column('user_id', Integer(), ForeignKey('users.user_id'), primary_key=True)
3909 3908 notification_id = Column("notification_id", Integer(), ForeignKey('notifications.notification_id'), primary_key=True)
3910 3909 read = Column('read', Boolean, default=False)
3911 3910 sent_on = Column('sent_on', DateTime(timezone=False), nullable=True, unique=None)
3912 3911
3913 3912 user = relationship('User', lazy="joined")
3914 3913 notification = relationship('Notification', lazy="joined",
3915 3914 order_by=lambda: Notification.created_on.desc(),)
3916 3915
3917 3916 def mark_as_read(self):
3918 3917 self.read = True
3919 3918 Session().add(self)
3920 3919
3921 3920
3922 3921 class Gist(Base, BaseModel):
3923 3922 __tablename__ = 'gists'
3924 3923 __table_args__ = (
3925 3924 Index('g_gist_access_id_idx', 'gist_access_id'),
3926 3925 Index('g_created_on_idx', 'created_on'),
3927 3926 base_table_args
3928 3927 )
3929 3928
3930 3929 GIST_PUBLIC = u'public'
3931 3930 GIST_PRIVATE = u'private'
3932 3931 DEFAULT_FILENAME = u'gistfile1.txt'
3933 3932
3934 3933 ACL_LEVEL_PUBLIC = u'acl_public'
3935 3934 ACL_LEVEL_PRIVATE = u'acl_private'
3936 3935
3937 3936 gist_id = Column('gist_id', Integer(), primary_key=True)
3938 3937 gist_access_id = Column('gist_access_id', Unicode(250))
3939 3938 gist_description = Column('gist_description', UnicodeText().with_variant(UnicodeText(1024), 'mysql'))
3940 3939 gist_owner = Column('user_id', Integer(), ForeignKey('users.user_id'), nullable=True)
3941 3940 gist_expires = Column('gist_expires', Float(53), nullable=False)
3942 3941 gist_type = Column('gist_type', Unicode(128), nullable=False)
3943 3942 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3944 3943 modified_at = Column('modified_at', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
3945 3944 acl_level = Column('acl_level', Unicode(128), nullable=True)
3946 3945
3947 3946 owner = relationship('User')
3948 3947
3949 3948 def __repr__(self):
3950 3949 return '<Gist:[%s]%s>' % (self.gist_type, self.gist_access_id)
3951 3950
3952 3951 @hybrid_property
3953 3952 def description_safe(self):
3954 3953 from rhodecode.lib import helpers as h
3955 3954 return h.escape(self.gist_description)
3956 3955
3957 3956 @classmethod
3958 3957 def get_or_404(cls, id_):
3959 3958 from pyramid.httpexceptions import HTTPNotFound
3960 3959
3961 3960 res = cls.query().filter(cls.gist_access_id == id_).scalar()
3962 3961 if not res:
3963 3962 raise HTTPNotFound()
3964 3963 return res
3965 3964
3966 3965 @classmethod
3967 3966 def get_by_access_id(cls, gist_access_id):
3968 3967 return cls.query().filter(cls.gist_access_id == gist_access_id).scalar()
3969 3968
3970 3969 def gist_url(self):
3971 3970 from rhodecode.model.gist import GistModel
3972 3971 return GistModel().get_url(self)
3973 3972
3974 3973 @classmethod
3975 3974 def base_path(cls):
3976 3975 """
3977 3976 Returns base path when all gists are stored
3978 3977
3979 3978 :param cls:
3980 3979 """
3981 3980 from rhodecode.model.gist import GIST_STORE_LOC
3982 3981 q = Session().query(RhodeCodeUi)\
3983 3982 .filter(RhodeCodeUi.ui_key == URL_SEP)
3984 3983 q = q.options(FromCache("sql_cache_short", "repository_repo_path"))
3985 3984 return os.path.join(q.one().ui_value, GIST_STORE_LOC)
3986 3985
3987 3986 def get_api_data(self):
3988 3987 """
3989 3988 Common function for generating gist related data for API
3990 3989 """
3991 3990 gist = self
3992 3991 data = {
3993 3992 'gist_id': gist.gist_id,
3994 3993 'type': gist.gist_type,
3995 3994 'access_id': gist.gist_access_id,
3996 3995 'description': gist.gist_description,
3997 3996 'url': gist.gist_url(),
3998 3997 'expires': gist.gist_expires,
3999 3998 'created_on': gist.created_on,
4000 3999 'modified_at': gist.modified_at,
4001 4000 'content': None,
4002 4001 'acl_level': gist.acl_level,
4003 4002 }
4004 4003 return data
4005 4004
4006 4005 def __json__(self):
4007 4006 data = dict(
4008 4007 )
4009 4008 data.update(self.get_api_data())
4010 4009 return data
4011 4010 # SCM functions
4012 4011
4013 4012 def scm_instance(self, **kwargs):
4014 4013 full_repo_path = os.path.join(self.base_path(), self.gist_access_id)
4015 4014 return get_vcs_instance(
4016 4015 repo_path=safe_str(full_repo_path), create=False)
4017 4016
4018 4017
4019 4018 class ExternalIdentity(Base, BaseModel):
4020 4019 __tablename__ = 'external_identities'
4021 4020 __table_args__ = (
4022 4021 Index('local_user_id_idx', 'local_user_id'),
4023 4022 Index('external_id_idx', 'external_id'),
4024 4023 base_table_args
4025 4024 )
4026 4025
4027 4026 external_id = Column('external_id', Unicode(255), default=u'',
4028 4027 primary_key=True)
4029 4028 external_username = Column('external_username', Unicode(1024), default=u'')
4030 4029 local_user_id = Column('local_user_id', Integer(),
4031 4030 ForeignKey('users.user_id'), primary_key=True)
4032 4031 provider_name = Column('provider_name', Unicode(255), default=u'',
4033 4032 primary_key=True)
4034 4033 access_token = Column('access_token', String(1024), default=u'')
4035 4034 alt_token = Column('alt_token', String(1024), default=u'')
4036 4035 token_secret = Column('token_secret', String(1024), default=u'')
4037 4036
4038 4037 @classmethod
4039 4038 def by_external_id_and_provider(cls, external_id, provider_name,
4040 4039 local_user_id=None):
4041 4040 """
4042 4041 Returns ExternalIdentity instance based on search params
4043 4042
4044 4043 :param external_id:
4045 4044 :param provider_name:
4046 4045 :return: ExternalIdentity
4047 4046 """
4048 4047 query = cls.query()
4049 4048 query = query.filter(cls.external_id == external_id)
4050 4049 query = query.filter(cls.provider_name == provider_name)
4051 4050 if local_user_id:
4052 4051 query = query.filter(cls.local_user_id == local_user_id)
4053 4052 return query.first()
4054 4053
4055 4054 @classmethod
4056 4055 def user_by_external_id_and_provider(cls, external_id, provider_name):
4057 4056 """
4058 4057 Returns User instance based on search params
4059 4058
4060 4059 :param external_id:
4061 4060 :param provider_name:
4062 4061 :return: User
4063 4062 """
4064 4063 query = User.query()
4065 4064 query = query.filter(cls.external_id == external_id)
4066 4065 query = query.filter(cls.provider_name == provider_name)
4067 4066 query = query.filter(User.user_id == cls.local_user_id)
4068 4067 return query.first()
4069 4068
4070 4069 @classmethod
4071 4070 def by_local_user_id(cls, local_user_id):
4072 4071 """
4073 4072 Returns all tokens for user
4074 4073
4075 4074 :param local_user_id:
4076 4075 :return: ExternalIdentity
4077 4076 """
4078 4077 query = cls.query()
4079 4078 query = query.filter(cls.local_user_id == local_user_id)
4080 4079 return query
4081 4080
4082 4081
4083 4082 class Integration(Base, BaseModel):
4084 4083 __tablename__ = 'integrations'
4085 4084 __table_args__ = (
4086 4085 base_table_args
4087 4086 )
4088 4087
4089 4088 integration_id = Column('integration_id', Integer(), primary_key=True)
4090 4089 integration_type = Column('integration_type', String(255))
4091 4090 enabled = Column('enabled', Boolean(), nullable=False)
4092 4091 name = Column('name', String(255), nullable=False)
4093 4092 child_repos_only = Column('child_repos_only', Boolean(), nullable=False,
4094 4093 default=False)
4095 4094
4096 4095 settings = Column(
4097 4096 'settings_json', MutationObj.as_mutable(
4098 4097 JsonType(dialect_map=dict(mysql=UnicodeText(16384)))))
4099 4098 repo_id = Column(
4100 4099 'repo_id', Integer(), ForeignKey('repositories.repo_id'),
4101 4100 nullable=True, unique=None, default=None)
4102 4101 repo = relationship('Repository', lazy='joined')
4103 4102
4104 4103 repo_group_id = Column(
4105 4104 'repo_group_id', Integer(), ForeignKey('groups.group_id'),
4106 4105 nullable=True, unique=None, default=None)
4107 4106 repo_group = relationship('RepoGroup', lazy='joined')
4108 4107
4109 4108 @property
4110 4109 def scope(self):
4111 4110 if self.repo:
4112 4111 return repr(self.repo)
4113 4112 if self.repo_group:
4114 4113 if self.child_repos_only:
4115 4114 return repr(self.repo_group) + ' (child repos only)'
4116 4115 else:
4117 4116 return repr(self.repo_group) + ' (recursive)'
4118 4117 if self.child_repos_only:
4119 4118 return 'root_repos'
4120 4119 return 'global'
4121 4120
4122 4121 def __repr__(self):
4123 4122 return '<Integration(%r, %r)>' % (self.integration_type, self.scope)
4124 4123
4125 4124
4126 4125 class RepoReviewRuleUser(Base, BaseModel):
4127 4126 __tablename__ = 'repo_review_rules_users'
4128 4127 __table_args__ = (
4129 4128 base_table_args
4130 4129 )
4131 4130
4132 4131 repo_review_rule_user_id = Column('repo_review_rule_user_id', Integer(), primary_key=True)
4133 4132 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4134 4133 user_id = Column("user_id", Integer(), ForeignKey('users.user_id'), nullable=False)
4135 4134 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4136 4135 user = relationship('User')
4137 4136
4138 4137 def rule_data(self):
4139 4138 return {
4140 4139 'mandatory': self.mandatory
4141 4140 }
4142 4141
4143 4142
4144 4143 class RepoReviewRuleUserGroup(Base, BaseModel):
4145 4144 __tablename__ = 'repo_review_rules_users_groups'
4146 4145 __table_args__ = (
4147 4146 base_table_args
4148 4147 )
4149 4148
4150 4149 VOTE_RULE_ALL = -1
4151 4150
4152 4151 repo_review_rule_users_group_id = Column('repo_review_rule_users_group_id', Integer(), primary_key=True)
4153 4152 repo_review_rule_id = Column("repo_review_rule_id", Integer(), ForeignKey('repo_review_rules.repo_review_rule_id'))
4154 4153 users_group_id = Column("users_group_id", Integer(),ForeignKey('users_groups.users_group_id'), nullable=False)
4155 4154 mandatory = Column("mandatory", Boolean(), nullable=False, default=False)
4156 4155 vote_rule = Column("vote_rule", Integer(), nullable=True, default=VOTE_RULE_ALL)
4157 4156 users_group = relationship('UserGroup')
4158 4157
4159 4158 def rule_data(self):
4160 4159 return {
4161 4160 'mandatory': self.mandatory,
4162 4161 'vote_rule': self.vote_rule
4163 4162 }
4164 4163
4165 4164 @property
4166 4165 def vote_rule_label(self):
4167 4166 if not self.vote_rule or self.vote_rule == self.VOTE_RULE_ALL:
4168 4167 return 'all must vote'
4169 4168 else:
4170 4169 return 'min. vote {}'.format(self.vote_rule)
4171 4170
4172 4171
4173 4172 class RepoReviewRule(Base, BaseModel):
4174 4173 __tablename__ = 'repo_review_rules'
4175 4174 __table_args__ = (
4176 4175 base_table_args
4177 4176 )
4178 4177
4179 4178 repo_review_rule_id = Column(
4180 4179 'repo_review_rule_id', Integer(), primary_key=True)
4181 4180 repo_id = Column(
4182 4181 "repo_id", Integer(), ForeignKey('repositories.repo_id'))
4183 4182 repo = relationship('Repository', backref='review_rules')
4184 4183
4185 4184 review_rule_name = Column('review_rule_name', String(255))
4186 4185 _branch_pattern = Column("branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4187 4186 _target_branch_pattern = Column("target_branch_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4188 4187 _file_pattern = Column("file_pattern", UnicodeText().with_variant(UnicodeText(255), 'mysql'), default=u'*') # glob
4189 4188
4190 4189 use_authors_for_review = Column("use_authors_for_review", Boolean(), nullable=False, default=False)
4191 4190 forbid_author_to_review = Column("forbid_author_to_review", Boolean(), nullable=False, default=False)
4192 4191 forbid_commit_author_to_review = Column("forbid_commit_author_to_review", Boolean(), nullable=False, default=False)
4193 4192 forbid_adding_reviewers = Column("forbid_adding_reviewers", Boolean(), nullable=False, default=False)
4194 4193
4195 4194 rule_users = relationship('RepoReviewRuleUser')
4196 4195 rule_user_groups = relationship('RepoReviewRuleUserGroup')
4197 4196
4198 4197 def _validate_pattern(self, value):
4199 4198 re.compile('^' + glob2re(value) + '$')
4200 4199
4201 4200 @hybrid_property
4202 4201 def source_branch_pattern(self):
4203 4202 return self._branch_pattern or '*'
4204 4203
4205 4204 @source_branch_pattern.setter
4206 4205 def source_branch_pattern(self, value):
4207 4206 self._validate_pattern(value)
4208 4207 self._branch_pattern = value or '*'
4209 4208
4210 4209 @hybrid_property
4211 4210 def target_branch_pattern(self):
4212 4211 return self._target_branch_pattern or '*'
4213 4212
4214 4213 @target_branch_pattern.setter
4215 4214 def target_branch_pattern(self, value):
4216 4215 self._validate_pattern(value)
4217 4216 self._target_branch_pattern = value or '*'
4218 4217
4219 4218 @hybrid_property
4220 4219 def file_pattern(self):
4221 4220 return self._file_pattern or '*'
4222 4221
4223 4222 @file_pattern.setter
4224 4223 def file_pattern(self, value):
4225 4224 self._validate_pattern(value)
4226 4225 self._file_pattern = value or '*'
4227 4226
4228 4227 def matches(self, source_branch, target_branch, files_changed):
4229 4228 """
4230 4229 Check if this review rule matches a branch/files in a pull request
4231 4230
4232 4231 :param source_branch: source branch name for the commit
4233 4232 :param target_branch: target branch name for the commit
4234 4233 :param files_changed: list of file paths changed in the pull request
4235 4234 """
4236 4235
4237 4236 source_branch = source_branch or ''
4238 4237 target_branch = target_branch or ''
4239 4238 files_changed = files_changed or []
4240 4239
4241 4240 branch_matches = True
4242 4241 if source_branch or target_branch:
4243 4242 if self.source_branch_pattern == '*':
4244 4243 source_branch_match = True
4245 4244 else:
4246 4245 if self.source_branch_pattern.startswith('re:'):
4247 4246 source_pattern = self.source_branch_pattern[3:]
4248 4247 else:
4249 4248 source_pattern = '^' + glob2re(self.source_branch_pattern) + '$'
4250 4249 source_branch_regex = re.compile(source_pattern)
4251 4250 source_branch_match = bool(source_branch_regex.search(source_branch))
4252 4251 if self.target_branch_pattern == '*':
4253 4252 target_branch_match = True
4254 4253 else:
4255 4254 if self.target_branch_pattern.startswith('re:'):
4256 4255 target_pattern = self.target_branch_pattern[3:]
4257 4256 else:
4258 4257 target_pattern = '^' + glob2re(self.target_branch_pattern) + '$'
4259 4258 target_branch_regex = re.compile(target_pattern)
4260 4259 target_branch_match = bool(target_branch_regex.search(target_branch))
4261 4260
4262 4261 branch_matches = source_branch_match and target_branch_match
4263 4262
4264 4263 files_matches = True
4265 4264 if self.file_pattern != '*':
4266 4265 files_matches = False
4267 4266 if self.file_pattern.startswith('re:'):
4268 4267 file_pattern = self.file_pattern[3:]
4269 4268 else:
4270 4269 file_pattern = glob2re(self.file_pattern)
4271 4270 file_regex = re.compile(file_pattern)
4272 4271 for filename in files_changed:
4273 4272 if file_regex.search(filename):
4274 4273 files_matches = True
4275 4274 break
4276 4275
4277 4276 return branch_matches and files_matches
4278 4277
4279 4278 @property
4280 4279 def review_users(self):
4281 4280 """ Returns the users which this rule applies to """
4282 4281
4283 4282 users = collections.OrderedDict()
4284 4283
4285 4284 for rule_user in self.rule_users:
4286 4285 if rule_user.user.active:
4287 4286 if rule_user.user not in users:
4288 4287 users[rule_user.user.username] = {
4289 4288 'user': rule_user.user,
4290 4289 'source': 'user',
4291 4290 'source_data': {},
4292 4291 'data': rule_user.rule_data()
4293 4292 }
4294 4293
4295 4294 for rule_user_group in self.rule_user_groups:
4296 4295 source_data = {
4297 4296 'user_group_id': rule_user_group.users_group.users_group_id,
4298 4297 'name': rule_user_group.users_group.users_group_name,
4299 4298 'members': len(rule_user_group.users_group.members)
4300 4299 }
4301 4300 for member in rule_user_group.users_group.members:
4302 4301 if member.user.active:
4303 4302 key = member.user.username
4304 4303 if key in users:
4305 4304 # skip this member as we have him already
4306 4305 # this prevents from override the "first" matched
4307 4306 # users with duplicates in multiple groups
4308 4307 continue
4309 4308
4310 4309 users[key] = {
4311 4310 'user': member.user,
4312 4311 'source': 'user_group',
4313 4312 'source_data': source_data,
4314 4313 'data': rule_user_group.rule_data()
4315 4314 }
4316 4315
4317 4316 return users
4318 4317
4319 4318 def user_group_vote_rule(self):
4320 4319 rules = []
4321 4320 if self.rule_user_groups:
4322 4321 for user_group in self.rule_user_groups:
4323 4322 rules.append(user_group)
4324 4323 return rules
4325 4324
4326 4325 def __repr__(self):
4327 4326 return '<RepoReviewerRule(id=%r, repo=%r)>' % (
4328 4327 self.repo_review_rule_id, self.repo)
4329 4328
4330 4329
4331 4330 class ScheduleEntry(Base, BaseModel):
4332 4331 __tablename__ = 'schedule_entries'
4333 4332 __table_args__ = (
4334 4333 UniqueConstraint('schedule_name', name='s_schedule_name_idx'),
4335 4334 UniqueConstraint('task_uid', name='s_task_uid_idx'),
4336 4335 base_table_args,
4337 4336 )
4338 4337
4339 4338 schedule_types = ['crontab', 'timedelta', 'integer']
4340 4339 schedule_entry_id = Column('schedule_entry_id', Integer(), primary_key=True)
4341 4340
4342 4341 schedule_name = Column("schedule_name", String(255), nullable=False, unique=None, default=None)
4343 4342 schedule_description = Column("schedule_description", String(10000), nullable=True, unique=None, default=None)
4344 4343 schedule_enabled = Column("schedule_enabled", Boolean(), nullable=False, unique=None, default=True)
4345 4344
4346 4345 _schedule_type = Column("schedule_type", String(255), nullable=False, unique=None, default=None)
4347 4346 schedule_definition = Column('schedule_definition_json', MutationObj.as_mutable(JsonType(default=lambda: "", dialect_map=dict(mysql=LONGTEXT()))))
4348 4347
4349 4348 schedule_last_run = Column('schedule_last_run', DateTime(timezone=False), nullable=True, unique=None, default=None)
4350 4349 schedule_total_run_count = Column('schedule_total_run_count', Integer(), nullable=True, unique=None, default=0)
4351 4350
4352 4351 # task
4353 4352 task_uid = Column("task_uid", String(255), nullable=False, unique=None, default=None)
4354 4353 task_dot_notation = Column("task_dot_notation", String(4096), nullable=False, unique=None, default=None)
4355 4354 task_args = Column('task_args_json', MutationObj.as_mutable(JsonType(default=list, dialect_map=dict(mysql=LONGTEXT()))))
4356 4355 task_kwargs = Column('task_kwargs_json', MutationObj.as_mutable(JsonType(default=dict, dialect_map=dict(mysql=LONGTEXT()))))
4357 4356
4358 4357 created_on = Column('created_on', DateTime(timezone=False), nullable=False, default=datetime.datetime.now)
4359 4358 updated_on = Column('updated_on', DateTime(timezone=False), nullable=True, unique=None, default=None)
4360 4359
4361 4360 @hybrid_property
4362 4361 def schedule_type(self):
4363 4362 return self._schedule_type
4364 4363
4365 4364 @schedule_type.setter
4366 4365 def schedule_type(self, val):
4367 4366 if val not in self.schedule_types:
4368 4367 raise ValueError('Value must be on of `{}` and got `{}`'.format(
4369 4368 val, self.schedule_type))
4370 4369
4371 4370 self._schedule_type = val
4372 4371
4373 4372 @classmethod
4374 4373 def get_uid(cls, obj):
4375 4374 args = obj.task_args
4376 4375 kwargs = obj.task_kwargs
4377 4376 if isinstance(args, JsonRaw):
4378 4377 try:
4379 4378 args = json.loads(args)
4380 4379 except ValueError:
4381 4380 args = tuple()
4382 4381
4383 4382 if isinstance(kwargs, JsonRaw):
4384 4383 try:
4385 4384 kwargs = json.loads(kwargs)
4386 4385 except ValueError:
4387 4386 kwargs = dict()
4388 4387
4389 4388 dot_notation = obj.task_dot_notation
4390 4389 val = '.'.join(map(safe_str, [
4391 4390 sorted(dot_notation), args, sorted(kwargs.items())]))
4392 4391 return hashlib.sha1(val).hexdigest()
4393 4392
4394 4393 @classmethod
4395 4394 def get_by_schedule_name(cls, schedule_name):
4396 4395 return cls.query().filter(cls.schedule_name == schedule_name).scalar()
4397 4396
4398 4397 @classmethod
4399 4398 def get_by_schedule_id(cls, schedule_id):
4400 4399 return cls.query().filter(cls.schedule_entry_id == schedule_id).scalar()
4401 4400
4402 4401 @property
4403 4402 def task(self):
4404 4403 return self.task_dot_notation
4405 4404
4406 4405 @property
4407 4406 def schedule(self):
4408 4407 from rhodecode.lib.celerylib.utils import raw_2_schedule
4409 4408 schedule = raw_2_schedule(self.schedule_definition, self.schedule_type)
4410 4409 return schedule
4411 4410
4412 4411 @property
4413 4412 def args(self):
4414 4413 try:
4415 4414 return list(self.task_args or [])
4416 4415 except ValueError:
4417 4416 return list()
4418 4417
4419 4418 @property
4420 4419 def kwargs(self):
4421 4420 try:
4422 4421 return dict(self.task_kwargs or {})
4423 4422 except ValueError:
4424 4423 return dict()
4425 4424
4426 4425 def _as_raw(self, val):
4427 4426 if hasattr(val, 'de_coerce'):
4428 4427 val = val.de_coerce()
4429 4428 if val:
4430 4429 val = json.dumps(val)
4431 4430
4432 4431 return val
4433 4432
4434 4433 @property
4435 4434 def schedule_definition_raw(self):
4436 4435 return self._as_raw(self.schedule_definition)
4437 4436
4438 4437 @property
4439 4438 def args_raw(self):
4440 4439 return self._as_raw(self.task_args)
4441 4440
4442 4441 @property
4443 4442 def kwargs_raw(self):
4444 4443 return self._as_raw(self.task_kwargs)
4445 4444
4446 4445 def __repr__(self):
4447 4446 return '<DB:ScheduleEntry({}:{})>'.format(
4448 4447 self.schedule_entry_id, self.schedule_name)
4449 4448
4450 4449
4451 4450 @event.listens_for(ScheduleEntry, 'before_update')
4452 4451 def update_task_uid(mapper, connection, target):
4453 4452 target.task_uid = ScheduleEntry.get_uid(target)
4454 4453
4455 4454
4456 4455 @event.listens_for(ScheduleEntry, 'before_insert')
4457 4456 def set_task_uid(mapper, connection, target):
4458 4457 target.task_uid = ScheduleEntry.get_uid(target)
4459 4458
4460 4459
4461 4460 class DbMigrateVersion(Base, BaseModel):
4462 4461 __tablename__ = 'db_migrate_version'
4463 4462 __table_args__ = (
4464 4463 base_table_args,
4465 4464 )
4466 4465
4467 4466 repository_id = Column('repository_id', String(250), primary_key=True)
4468 4467 repository_path = Column('repository_path', Text)
4469 4468 version = Column('version', Integer)
4470 4469
4471 4470 @classmethod
4472 4471 def set_version(cls, version):
4473 4472 """
4474 4473 Helper for forcing a different version, usually for debugging purposes via ishell.
4475 4474 """
4476 4475 ver = DbMigrateVersion.query().first()
4477 4476 ver.version = version
4478 4477 Session().commit()
4479 4478
4480 4479
4481 4480 class DbSession(Base, BaseModel):
4482 4481 __tablename__ = 'db_session'
4483 4482 __table_args__ = (
4484 4483 base_table_args,
4485 4484 )
4486 4485
4487 4486 def __repr__(self):
4488 4487 return '<DB:DbSession({})>'.format(self.id)
4489 4488
4490 4489 id = Column('id', Integer())
4491 4490 namespace = Column('namespace', String(255), primary_key=True)
4492 4491 accessed = Column('accessed', DateTime, nullable=False)
4493 4492 created = Column('created', DateTime, nullable=False)
4494 4493 data = Column('data', PickleType, nullable=False)
4495 4494
4496 4495
4497 4496 class BeakerCache(Base, BaseModel):
4498 4497 __tablename__ = 'beaker_cache'
4499 4498 __table_args__ = (
4500 4499 base_table_args,
4501 4500 )
4502 4501
4503 4502 def __repr__(self):
4504 4503 return '<DB:DbSession({})>'.format(self.id)
4505 4504
4506 4505 id = Column('id', Integer())
4507 4506 namespace = Column('namespace', String(255), primary_key=True)
4508 4507 accessed = Column('accessed', DateTime, nullable=False)
4509 4508 created = Column('created', DateTime, nullable=False)
4510 4509 data = Column('data', PickleType, nullable=False)
General Comments 0
You need to be logged in to leave comments. Login now