settings.py
523 lines
| 20.5 KiB
| text/x-python
|
PythonLexer
r779 | # -*- coding: utf-8 -*- | |||
""" | ||||
r860 | rhodecode.controllers.admin.settings | |||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||
r1203 | ||||
r779 | settings controller for rhodecode admin | |||
r1203 | ||||
r779 | :created_on: Jul 14, 2010 | |||
:author: marcink | ||||
r1824 | :copyright: (C) 2010-2012 Marcin Kuzminski <marcin@python-works.com> | |||
r779 | :license: GPLv3, see COPYING for more details. | |||
""" | ||||
r1206 | # This program is free software: you can redistribute it and/or modify | |||
# it under the terms of the GNU General Public License as published by | ||||
# the Free Software Foundation, either version 3 of the License, or | ||||
# (at your option) any later version. | ||||
r1203 | # | |||
r547 | # This program is distributed in the hope that it will be useful, | |||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
# GNU General Public License for more details. | ||||
r1203 | # | |||
r547 | # You should have received a copy of the GNU General Public License | |||
r1206 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
r779 | ||||
r890 | import logging | |||
import traceback | ||||
import formencode | ||||
r2192 | import pkg_resources | |||
import platform | ||||
r890 | ||||
r1022 | from sqlalchemy import func | |||
r547 | from formencode import htmlfill | |||
r1036 | from pylons import request, session, tmpl_context as c, url, config | |||
r547 | from pylons.controllers.util import abort, redirect | |||
from pylons.i18n.translation import _ | ||||
r890 | ||||
r547 | from rhodecode.lib import helpers as h | |||
from rhodecode.lib.auth import LoginRequired, HasPermissionAllDecorator, \ | ||||
r3333 | HasPermissionAnyDecorator, NotAnonymous, HasPermissionAny,\ | |||
r3455 | HasReposGroupPermissionAll, HasReposGroupPermissionAny, AuthUser | |||
r547 | from rhodecode.lib.base import BaseController, render | |||
r705 | from rhodecode.lib.celerylib import tasks, run_task | |||
r3693 | from rhodecode.lib.utils import repo2db_mapper, set_rhodecode_config, \ | |||
check_git_version | ||||
r1633 | from rhodecode.model.db import RhodeCodeUi, Repository, RepoGroup, \ | |||
r2625 | RhodeCodeSetting, PullRequest, PullRequestReviewers | |||
r547 | from rhodecode.model.forms import UserForm, ApplicationSettingsForm, \ | |||
r2674 | ApplicationUiSettingsForm, ApplicationVisualisationForm | |||
r3714 | from rhodecode.model.scm import ScmModel, RepoGroupList | |||
r629 | from rhodecode.model.user import UserModel | |||
r3154 | from rhodecode.model.repo import RepoModel | |||
r1501 | from rhodecode.model.db import User | |||
r1718 | from rhodecode.model.notification import EmailNotificationModel | |||
r1749 | from rhodecode.model.meta import Session | |||
r3145 | from rhodecode.lib.utils2 import str2bool, safe_unicode | |||
r3154 | from rhodecode.lib.compat import json | |||
r547 | log = logging.getLogger(__name__) | |||
class SettingsController(BaseController): | ||||
"""REST Controller styled on the Atom Publishing Protocol""" | ||||
# To properly map this controller, ensure your config/routing.py | ||||
# file has a resource setup: | ||||
r1203 | # map.resource('setting', 'settings', controller='admin/settings', | |||
r547 | # path_prefix='/admin', name_prefix='admin_') | |||
@LoginRequired() | ||||
def __before__(self): | ||||
r3712 | super(SettingsController, self).__before__() | |||
r2207 | c.modules = sorted([(p.project_name, p.version) | |||
r2890 | for p in pkg_resources.working_set] | |||
+ [('git', check_git_version())], | ||||
r2223 | key=lambda k: k[0].lower()) | |||
r2192 | c.py_version = platform.python_version() | |||
r2207 | c.platform = platform.platform() | |||
r629 | ||||
@HasPermissionAllDecorator('hg.admin') | ||||
r547 | def index(self, format='html'): | |||
"""GET /admin/settings: All items in the collection""" | ||||
# url('admin_settings') | ||||
r1633 | defaults = RhodeCodeSetting.get_app_settings() | |||
r2708 | defaults.update(self._get_hg_ui_settings()) | |||
r2192 | ||||
r547 | return htmlfill.render( | |||
render('admin/settings/settings.html'), | ||||
defaults=defaults, | ||||
encoding="UTF-8", | ||||
force_defaults=False | ||||
r629 | ) | |||
r547 | @HasPermissionAllDecorator('hg.admin') | |||
def create(self): | ||||
"""POST /admin/settings: Create a new item""" | ||||
# url('admin_settings') | ||||
r629 | ||||
r547 | @HasPermissionAllDecorator('hg.admin') | |||
def new(self, format='html'): | ||||
"""GET /admin/settings/new: Form to create a new item""" | ||||
# url('admin_new_setting') | ||||
r629 | ||||
r547 | @HasPermissionAllDecorator('hg.admin') | |||
def update(self, setting_id): | ||||
"""PUT /admin/settings/setting_id: Update an existing item""" | ||||
# Forms posted to this method should contain a hidden field: | ||||
# <input type="hidden" name="_method" value="PUT" /> | ||||
# Or using helpers: | ||||
# h.form(url('admin_setting', setting_id=ID), | ||||
# method='put') | ||||
# url('admin_setting', setting_id=ID) | ||||
r2662 | ||||
r547 | if setting_id == 'mapping': | |||
rm_obsolete = request.POST.get('destroy', False) | ||||
r3951 | invalidate_cache = request.POST.get('invalidate', False) | |||
r3953 | log.debug('rescanning repo location with destroy obsolete=%s' | |||
r3951 | % (rm_obsolete,)) | |||
if invalidate_cache: | ||||
log.debug('invalidating all repositories cache') | ||||
r3953 | for repo in Repository.get_all(): | |||
ScmModel().mark_for_invalidation(repo.repo_name) | ||||
r665 | ||||
r3953 | filesystem_repos = ScmModel().repo_scan() | |||
added, removed = repo2db_mapper(filesystem_repos, rm_obsolete) | ||||
r3145 | _repr = lambda l: ', '.join(map(safe_unicode, l)) or '-' | |||
h.flash(_('Repositories successfully ' | ||||
'rescanned added: %s ; removed: %s') % | ||||
(_repr(added), _repr(removed)), | ||||
|
r3142 | category='success') | ||
r629 | ||||
r547 | if setting_id == 'whoosh': | |||
r2708 | repo_location = self._get_hg_ui_settings()['paths_root_path'] | |||
r547 | full_index = request.POST.get('full_index', False) | |||
r1164 | run_task(tasks.whoosh_index, repo_location, full_index) | |||
r2662 | h.flash(_('Whoosh reindex task scheduled'), category='success') | |||
r629 | ||||
r547 | if setting_id == 'global': | |||
r629 | ||||
r547 | application_form = ApplicationSettingsForm()() | |||
try: | ||||
form_result = application_form.to_python(dict(request.POST)) | ||||
r2662 | except formencode.Invalid, errors: | |||
return htmlfill.render( | ||||
render('admin/settings/settings.html'), | ||||
defaults=errors.value, | ||||
errors=errors.error_dict or {}, | ||||
prefix_error=False, | ||||
encoding="UTF-8" | ||||
) | ||||
r629 | ||||
r2662 | try: | |||
r2674 | sett1 = RhodeCodeSetting.get_by_name_or_create('title') | |||
r2662 | sett1.app_settings_value = form_result['rhodecode_title'] | |||
Session().add(sett1) | ||||
r629 | ||||
r2674 | sett2 = RhodeCodeSetting.get_by_name_or_create('realm') | |||
r2662 | sett2.app_settings_value = form_result['rhodecode_realm'] | |||
Session().add(sett2) | ||||
r629 | ||||
r2674 | sett3 = RhodeCodeSetting.get_by_name_or_create('ga_code') | |||
r2662 | sett3.app_settings_value = form_result['rhodecode_ga_code'] | |||
Session().add(sett3) | ||||
Session().commit() | ||||
set_rhodecode_config(config) | ||||
h.flash(_('Updated application settings'), category='success') | ||||
r629 | ||||
r2662 | except Exception: | |||
log.error(traceback.format_exc()) | ||||
|
r3565 | h.flash(_('Error occurred during updating ' | ||
r2662 | 'application settings'), | |||
category='error') | ||||
r629 | ||||
r2674 | if setting_id == 'visual': | |||
application_form = ApplicationVisualisationForm()() | ||||
try: | ||||
form_result = application_form.to_python(dict(request.POST)) | ||||
except formencode.Invalid, errors: | ||||
return htmlfill.render( | ||||
render('admin/settings/settings.html'), | ||||
defaults=errors.value, | ||||
errors=errors.error_dict or {}, | ||||
prefix_error=False, | ||||
encoding="UTF-8" | ||||
) | ||||
try: | ||||
r3904 | #TODO: rewrite this to something less ugly | |||
r2674 | sett1 = RhodeCodeSetting.get_by_name_or_create('show_public_icon') | |||
sett1.app_settings_value = \ | ||||
form_result['rhodecode_show_public_icon'] | ||||
r2936 | Session().add(sett1) | |||
r2674 | ||||
sett2 = RhodeCodeSetting.get_by_name_or_create('show_private_icon') | ||||
sett2.app_settings_value = \ | ||||
form_result['rhodecode_show_private_icon'] | ||||
r2936 | Session().add(sett2) | |||
r2674 | ||||
sett3 = RhodeCodeSetting.get_by_name_or_create('stylify_metatags') | ||||
sett3.app_settings_value = \ | ||||
form_result['rhodecode_stylify_metatags'] | ||||
r2936 | Session().add(sett3) | |||
r2674 | ||||
r3308 | sett4 = RhodeCodeSetting.get_by_name_or_create('repository_fields') | |||
sett4.app_settings_value = \ | ||||
form_result['rhodecode_repository_fields'] | ||||
Session().add(sett4) | ||||
r3904 | sett5 = RhodeCodeSetting.get_by_name_or_create('dashboard_items') | |||
sett5.app_settings_value = \ | ||||
form_result['rhodecode_dashboard_items'] | ||||
Session().add(sett5) | ||||
r3910 | sett6 = RhodeCodeSetting.get_by_name_or_create('show_version') | |||
sett6.app_settings_value = \ | ||||
form_result['rhodecode_show_version'] | ||||
Session().add(sett6) | ||||
r2674 | Session().commit() | |||
set_rhodecode_config(config) | ||||
h.flash(_('Updated visualisation settings'), | ||||
category='success') | ||||
except Exception: | ||||
log.error(traceback.format_exc()) | ||||
|
r3565 | h.flash(_('Error occurred during updating ' | ||
r2674 | 'visualisation settings'), | |||
category='error') | ||||
r2662 | if setting_id == 'vcs': | |||
application_form = ApplicationUiSettingsForm()() | ||||
try: | ||||
form_result = application_form.to_python(dict(request.POST)) | ||||
r564 | except formencode.Invalid, errors: | |||
r547 | return htmlfill.render( | |||
render('admin/settings/settings.html'), | ||||
defaults=errors.value, | ||||
errors=errors.error_dict or {}, | ||||
prefix_error=False, | ||||
r2662 | encoding="UTF-8" | |||
) | ||||
r629 | ||||
r547 | try: | |||
r2708 | sett = RhodeCodeUi.get_by_key('push_ssl') | |||
sett.ui_value = form_result['web_push_ssl'] | ||||
Session().add(sett) | ||||
r3920 | if c.visual.allow_repo_location_change: | |||
sett = RhodeCodeUi.get_by_key('/') | ||||
sett.ui_value = form_result['paths_root_path'] | ||||
Session().add(sett) | ||||
r629 | ||||
r2662 | #HOOKS | |||
r2708 | sett = RhodeCodeUi.get_by_key(RhodeCodeUi.HOOK_UPDATE) | |||
|
r3570 | sett.ui_active = form_result['hooks_changegroup_update'] | ||
r2708 | Session().add(sett) | |||
r629 | ||||
r2708 | sett = RhodeCodeUi.get_by_key(RhodeCodeUi.HOOK_REPO_SIZE) | |||
|
r3570 | sett.ui_active = form_result['hooks_changegroup_repo_size'] | ||
r2708 | Session().add(sett) | |||
sett = RhodeCodeUi.get_by_key(RhodeCodeUi.HOOK_PUSH) | ||||
|
r3570 | sett.ui_active = form_result['hooks_changegroup_push_logger'] | ||
r2708 | Session().add(sett) | |||
r629 | ||||
r2708 | sett = RhodeCodeUi.get_by_key(RhodeCodeUi.HOOK_PULL) | |||
|
r3570 | sett.ui_active = form_result['hooks_outgoing_pull_logger'] | ||
r2708 | ||||
Session().add(sett) | ||||
r629 | ||||
r2708 | ## EXTENSIONS | |||
sett = RhodeCodeUi.get_by_key('largefiles') | ||||
r2844 | if not sett: | |||
#make one if it's not there ! | ||||
sett = RhodeCodeUi() | ||||
sett.ui_key = 'largefiles' | ||||
sett.ui_section = 'extensions' | ||||
|
r3570 | sett.ui_active = form_result['extensions_largefiles'] | ||
r2708 | Session().add(sett) | |||
r629 | ||||
r2708 | sett = RhodeCodeUi.get_by_key('hgsubversion') | |||
r2844 | if not sett: | |||
#make one if it's not there ! | ||||
sett = RhodeCodeUi() | ||||
sett.ui_key = 'hgsubversion' | ||||
sett.ui_section = 'extensions' | ||||
|
r3570 | sett.ui_active = form_result['extensions_hgsubversion'] | ||
r2708 | Session().add(sett) | |||
# sett = RhodeCodeUi.get_by_key('hggit') | ||||
r2844 | # if not sett: | |||
# #make one if it's not there ! | ||||
# sett = RhodeCodeUi() | ||||
# sett.ui_key = 'hggit' | ||||
# sett.ui_section = 'extensions' | ||||
# | ||||
|
r3570 | # sett.ui_active = form_result['extensions_hggit'] | ||
r2708 | # Session().add(sett) | |||
r2662 | Session().commit() | |||
r629 | ||||
r2708 | h.flash(_('Updated VCS settings'), category='success') | |||
r629 | ||||
r2662 | except Exception: | |||
log.error(traceback.format_exc()) | ||||
|
r3565 | h.flash(_('Error occurred during updating ' | ||
r2662 | 'application settings'), category='error') | |||
r629 | ||||
r1460 | if setting_id == 'hooks': | |||
ui_key = request.POST.get('new_hook_ui_key') | ||||
ui_value = request.POST.get('new_hook_ui_value') | ||||
try: | ||||
r1673 | ||||
r1460 | if ui_value and ui_key: | |||
RhodeCodeUi.create_or_update_hook(ui_key, ui_value) | ||||
h.flash(_('Added new hook'), | ||||
category='success') | ||||
# check for edits | ||||
update = False | ||||
_d = request.POST.dict_of_lists() | ||||
r1798 | for k, v in zip(_d.get('hook_ui_key', []), | |||
_d.get('hook_ui_value_new', [])): | ||||
r1460 | RhodeCodeUi.create_or_update_hook(k, v) | |||
update = True | ||||
if update: | ||||
h.flash(_('Updated hooks'), category='success') | ||||
r2662 | Session().commit() | |||
except Exception: | ||||
r1460 | log.error(traceback.format_exc()) | |||
|
r3565 | h.flash(_('Error occurred during hook creation'), | ||
r1460 | category='error') | |||
return redirect(url('admin_edit_setting', setting_id='hooks')) | ||||
r1673 | if setting_id == 'email': | |||
test_email = request.POST.get('test_email') | ||||
test_email_subj = 'RhodeCode TestEmail' | ||||
test_email_body = 'RhodeCode Email test' | ||||
r1798 | ||||
r1717 | test_email_html_body = EmailNotificationModel()\ | |||
r1798 | .get_email_tmpl(EmailNotificationModel.TYPE_DEFAULT, | |||
body=test_email_body) | ||||
r1673 | ||||
|
r3140 | recipients = [test_email] if test_email else None | ||
r1798 | ||||
run_task(tasks.send_email, recipients, test_email_subj, | ||||
r1717 | test_email_body, test_email_html_body) | |||
r1673 | h.flash(_('Email task created'), category='success') | |||
r547 | return redirect(url('admin_settings')) | |||
r629 | ||||
r547 | @HasPermissionAllDecorator('hg.admin') | |||
def delete(self, setting_id): | ||||
"""DELETE /admin/settings/setting_id: Delete an existing item""" | ||||
# Forms posted to this method should contain a hidden field: | ||||
# <input type="hidden" name="_method" value="DELETE" /> | ||||
# Or using helpers: | ||||
# h.form(url('admin_setting', setting_id=ID), | ||||
# method='delete') | ||||
# url('admin_setting', setting_id=ID) | ||||
r1460 | if setting_id == 'hooks': | |||
hook_id = request.POST.get('hook_id') | ||||
RhodeCodeUi.delete(hook_id) | ||||
r2662 | Session().commit() | |||
r1673 | ||||
r547 | @HasPermissionAllDecorator('hg.admin') | |||
def show(self, setting_id, format='html'): | ||||
r1245 | """ | |||
GET /admin/settings/setting_id: Show a specific item""" | ||||
r547 | # url('admin_setting', setting_id=ID) | |||
r629 | ||||
@HasPermissionAllDecorator('hg.admin') | ||||
r547 | def edit(self, setting_id, format='html'): | |||
r1245 | """ | |||
GET /admin/settings/setting_id/edit: Form to | ||||
edit an existing item""" | ||||
r547 | # url('admin_edit_setting', setting_id=ID) | |||
r1460 | c.hooks = RhodeCodeUi.get_builtin_hooks() | |||
c.custom_hooks = RhodeCodeUi.get_custom_hooks() | ||||
return htmlfill.render( | ||||
render('admin/settings/hooks.html'), | ||||
defaults={}, | ||||
encoding="UTF-8", | ||||
force_defaults=False | ||||
) | ||||
r3159 | def _load_my_repos_data(self): | |||
repos_list = Session().query(Repository)\ | ||||
.filter(Repository.user_id == | ||||
self.rhodecode_user.user_id)\ | ||||
.order_by(func.lower(Repository.repo_name)).all() | ||||
repos_data = RepoModel().get_repos_as_dict(repos_list=repos_list, | ||||
admin=True) | ||||
#json used to render the grid | ||||
return json.dumps(repos_data) | ||||
r779 | @NotAnonymous() | |||
r547 | def my_account(self): | |||
""" | ||||
r1203 | GET /_admin/my_account Displays info about my account | |||
r547 | """ | |||
r779 | # url('admin_settings_my_account') | |||
r665 | ||||
r1501 | c.user = User.get(self.rhodecode_user.user_id) | |||
r3455 | c.perm_user = AuthUser(user_id=self.rhodecode_user.user_id, | |||
ip_addr=self.ip_addr) | ||||
r3159 | c.ldap_dn = c.user.ldap_dn | |||
r629 | ||||
r547 | if c.user.username == 'default': | |||
r629 | h.flash(_("You can't edit this user since it's" | |||
r547 | " crucial for entire application"), category='warning') | |||
return redirect(url('users')) | ||||
r629 | ||||
r3154 | #json used to render the grid | |||
r3159 | c.data = self._load_my_repos_data() | |||
r3154 | ||||
r832 | defaults = c.user.get_dict() | |||
r2353 | ||||
c.form = htmlfill.render( | ||||
render('admin/users/user_edit_my_account_form.html'), | ||||
r547 | defaults=defaults, | |||
encoding="UTF-8", | ||||
force_defaults=False | ||||
r629 | ) | |||
r2353 | return render('admin/users/user_edit_my_account.html') | |||
r547 | ||||
r2626 | @NotAnonymous() | |||
r547 | def my_account_update(self): | |||
"""PUT /_admin/my_account_update: Update an existing item""" | ||||
# Forms posted to this method should contain a hidden field: | ||||
# <input type="hidden" name="_method" value="PUT" /> | ||||
# Or using helpers: | ||||
# h.form(url('admin_settings_my_account_update'), | ||||
# method='put') | ||||
# url('admin_settings_my_account_update', id=ID) | ||||
r1121 | uid = self.rhodecode_user.user_id | |||
r3159 | c.user = User.get(self.rhodecode_user.user_id) | |||
r3455 | c.perm_user = AuthUser(user_id=self.rhodecode_user.user_id, | |||
ip_addr=self.ip_addr) | ||||
r3159 | c.ldap_dn = c.user.ldap_dn | |||
r2544 | email = self.rhodecode_user.email | |||
r1245 | _form = UserForm(edit=True, | |||
r2544 | old_data={'user_id': uid, 'email': email})() | |||
r547 | form_result = {} | |||
try: | ||||
form_result = _form.to_python(dict(request.POST)) | ||||
r3159 | skip_attrs = ['admin', 'active'] # skip attr for my account | |||
if c.ldap_dn: | ||||
#forbid updating username for ldap accounts | ||||
skip_attrs.append('username') | ||||
UserModel().update(uid, form_result, skip_attrs=skip_attrs) | ||||
r779 | h.flash(_('Your account was updated successfully'), | |||
r547 | category='success') | |||
r2662 | Session().commit() | |||
r564 | except formencode.Invalid, errors: | |||
r3159 | #json used to render the grid | |||
c.data = self._load_my_repos_data() | ||||
r2353 | c.form = htmlfill.render( | |||
render('admin/users/user_edit_my_account_form.html'), | ||||
r547 | defaults=errors.value, | |||
errors=errors.error_dict or {}, | ||||
prefix_error=False, | ||||
encoding="UTF-8") | ||||
r2353 | return render('admin/users/user_edit_my_account.html') | |||
r547 | except Exception: | |||
log.error(traceback.format_exc()) | ||||
|
r3565 | h.flash(_('Error occurred during update of user %s') \ | ||
r547 | % form_result.get('username'), category='error') | |||
r629 | ||||
r547 | return redirect(url('my_account')) | |||
r2662 | ||||
r2626 | @NotAnonymous() | |||
r2625 | def my_account_my_pullrequests(self): | |||
r3404 | c.show_closed = request.GET.get('pr_show_closed') | |||
def _filter(pr): | ||||
s = sorted(pr, key=lambda o: o.created_on, reverse=True) | ||||
if not c.show_closed: | ||||
s = filter(lambda p: p.status != PullRequest.STATUS_CLOSED, s) | ||||
return s | ||||
c.my_pull_requests = _filter(PullRequest.query()\ | ||||
r3154 | .filter(PullRequest.user_id == | |||
r2625 | self.rhodecode_user.user_id)\ | |||
r3404 | .all()) | |||
r3389 | ||||
r3404 | c.participate_in_pull_requests = _filter([ | |||
x.pull_request for x in PullRequestReviewers.query()\ | ||||
.filter(PullRequestReviewers.user_id == | ||||
self.rhodecode_user.user_id).all()]) | ||||
r3389 | ||||
r2625 | return render('admin/users/user_edit_my_account_pullrequests.html') | |||
r2708 | def _get_hg_ui_settings(self): | |||
r2662 | ret = RhodeCodeUi.query().all() | |||
r756 | ||||
if not ret: | ||||
raise Exception('Could not get application ui settings !') | ||||
settings = {} | ||||
for each in ret: | ||||
k = each.ui_key | ||||
v = each.ui_value | ||||
if k == '/': | ||||
k = 'root_path' | ||||
r2821 | if k == 'push_ssl': | |||
v = str2bool(v) | ||||
r756 | if k.find('.') != -1: | |||
k = k.replace('.', '_') | ||||
r2708 | if each.ui_section in ['hooks', 'extensions']: | |||
r756 | v = each.ui_active | |||
settings[each.ui_section + '_' + k] = v | ||||
return settings | ||||