Files
@ 8305790b9533
Branch filter:
Location: kallithea/kallithea/lib/db_manage.py - annotation
8305790b9533
13.6 KiB
text/x-python
db: better support for databases with "odd" characters in the name, such as "-"
Add missing quoting, using the quoting flavour preferred by the DB.
Tested with
echo "CREATE USER 'kallithea-test'@'localhost' IDENTIFIED BY 'password'"|sudo -u mysql mysql
echo "GRANT ALL PRIVILEGES ON \`kallithea-test\`.* TO 'kallithea-test'@'localhost'" | sudo -u mysql mysql
TEST_DB='mysql://kallithea-test:password@localhost/kallithea-test?charset=utf8mb4' py.test
sudo -u postgres createuser 'kallithea-test' --pwprompt --createdb
TEST_DB='postgresql://kallithea-test:password@localhost/kallithea-test' py.test
Add missing quoting, using the quoting flavour preferred by the DB.
Tested with
echo "CREATE USER 'kallithea-test'@'localhost' IDENTIFIED BY 'password'"|sudo -u mysql mysql
echo "GRANT ALL PRIVILEGES ON \`kallithea-test\`.* TO 'kallithea-test'@'localhost'" | sudo -u mysql mysql
TEST_DB='mysql://kallithea-test:password@localhost/kallithea-test?charset=utf8mb4' py.test
sudo -u postgres createuser 'kallithea-test' --pwprompt --createdb
TEST_DB='postgresql://kallithea-test:password@localhost/kallithea-test' py.test
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 24c0d584ba86 d1addaf7a91e d1addaf7a91e 1948ede028ef 1948ede028ef d1addaf7a91e d1addaf7a91e 1948ede028ef ad38f9f93b3b d1addaf7a91e d1addaf7a91e 0a277465fddf d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 0a277465fddf c095a2f38add 0a277465fddf 0a277465fddf c095a2f38add d75d9ce1320d 1b598ea781b2 0a277465fddf 0a277465fddf 0a277465fddf d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 5b3568c99cc3 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 32cdc6f70f13 d1addaf7a91e d1addaf7a91e 4bcaf1ca2e08 4bcaf1ca2e08 d1addaf7a91e d1addaf7a91e 4bcaf1ca2e08 0f9e7dbfa5d2 4bcaf1ca2e08 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 7691290837d2 5b3568c99cc3 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 4bcaf1ca2e08 d1addaf7a91e a8e6bb9ee9ea d1addaf7a91e d1addaf7a91e 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 8305790b9533 8305790b9533 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 6849b3fad164 8305790b9533 8305790b9533 6849b3fad164 6849b3fad164 6849b3fad164 d1addaf7a91e d1addaf7a91e d1addaf7a91e c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add c095a2f38add 0210d0b769d4 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 4bcaf1ca2e08 4bcaf1ca2e08 4bcaf1ca2e08 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e aa093e05a1c6 d1addaf7a91e d1addaf7a91e d1addaf7a91e 7691290837d2 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e aa093e05a1c6 d1addaf7a91e d1addaf7a91e d1addaf7a91e 8d98924c58b1 ff764c0e7792 ff764c0e7792 ff764c0e7792 ff764c0e7792 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e de26de99ac5b 48a00daba2f2 48a00daba2f2 0210d0b769d4 d1addaf7a91e 9daad8c50b37 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e fcfc62767107 fcfc62767107 9daad8c50b37 0210d0b769d4 d1addaf7a91e 9daad8c50b37 d1addaf7a91e d1addaf7a91e bb5650d4a914 4bcaf1ca2e08 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e aa093e05a1c6 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 0210d0b769d4 d1addaf7a91e d1addaf7a91e d1addaf7a91e 0210d0b769d4 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 0210d0b769d4 d1addaf7a91e d1addaf7a91e d1addaf7a91e 0210d0b769d4 4bcaf1ca2e08 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 104ec4bfe449 104ec4bfe449 d1addaf7a91e bb5650d4a914 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 0210d0b769d4 d1addaf7a91e d1addaf7a91e d1addaf7a91e bb5650d4a914 d1addaf7a91e bb5650d4a914 79fd9b50bd3e 79fd9b50bd3e 79fd9b50bd3e 79fd9b50bd3e bb5650d4a914 79fd9b50bd3e 79fd9b50bd3e d1addaf7a91e bac0ddd79c74 bac0ddd79c74 bac0ddd79c74 bac0ddd79c74 bac0ddd79c74 bac0ddd79c74 d1addaf7a91e d1addaf7a91e d1addaf7a91e 24c0d584ba86 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 97ea346aa4bd 19f15cde2cdb d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 574218777086 d1addaf7a91e d1addaf7a91e 9daad8c50b37 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e bac0ddd79c74 d1addaf7a91e d1addaf7a91e 0210d0b769d4 d1addaf7a91e e63bcce18fef d1addaf7a91e 12bc5b6057a7 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 2045d30919e6 d1addaf7a91e d1addaf7a91e e63bcce18fef e63bcce18fef dabdc356393b dabdc356393b d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 3760df6251e0 d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e d1addaf7a91e 2045d30919e6 | # -*- coding: utf-8 -*-
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
kallithea.lib.db_manage
~~~~~~~~~~~~~~~~~~~~~~~
Database creation, and setup module for Kallithea. Used for creation
of database as well as for migration operations
This file was forked by the Kallithea project in July 2014.
Original author and date, and relevant copyright and licensing information is below:
:created_on: Apr 10, 2010
:author: marcink
:copyright: (c) 2013 RhodeCode GmbH, and others.
:license: GPLv3, see LICENSE.md for more details.
"""
import logging
import os
import sys
import uuid
import alembic.command
import alembic.config
import sqlalchemy
from sqlalchemy.engine import create_engine
from kallithea.model.base import init_model
from kallithea.model.db import Repository, Setting, Ui, User
from kallithea.model.meta import Base, Session
from kallithea.model.permission import PermissionModel
from kallithea.model.user import UserModel
log = logging.getLogger(__name__)
class DbManage(object):
def __init__(self, dbconf, root, tests=False, SESSION=None, cli_args=None):
self.dbname = dbconf.split('/')[-1]
self.tests = tests
self.root = root
self.dburi = dbconf
self.cli_args = cli_args or {}
self.init_db(SESSION=SESSION)
def _ask_ok(self, msg):
"""Invoke ask_ok unless the force_ask option provides the answer"""
force_ask = self.cli_args.get('force_ask')
if force_ask is not None:
return force_ask
from kallithea.lib.utils2 import ask_ok
return ask_ok(msg)
def init_db(self, SESSION=None):
if SESSION:
self.sa = SESSION
else:
# init new sessions
engine = create_engine(self.dburi)
init_model(engine)
self.sa = Session()
def create_tables(self, override=False):
"""
Create a auth database
"""
log.info("Any existing database is going to be destroyed")
if self.tests:
destroy = True
else:
destroy = self._ask_ok('Are you sure to destroy old database ? [y/n]')
if not destroy:
print('Nothing done.')
sys.exit(0)
if destroy:
# drop and re-create old schemas
url = sqlalchemy.engine.url.make_url(self.dburi)
database = url.database
# Some databases enforce foreign key constraints and Base.metadata.drop_all() doesn't work
if url.drivername == 'mysql':
url.database = None # don't connect to the database (it might not exist)
engine = sqlalchemy.create_engine(url)
with engine.connect() as conn:
conn.execute('DROP DATABASE IF EXISTS `%s`' % database)
conn.execute('CREATE DATABASE `%s`' % database)
elif url.drivername == 'postgresql':
from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT
url.database = 'postgres' # connect to the system database (as the real one might not exist)
engine = sqlalchemy.create_engine(url)
with engine.connect() as conn:
conn.connection.set_isolation_level(ISOLATION_LEVEL_AUTOCOMMIT)
conn.execute('DROP DATABASE IF EXISTS "%s"' % database)
conn.execute('CREATE DATABASE "%s"' % database)
else:
# known to work on SQLite - possibly not on other databases with strong referential integrity
Base.metadata.drop_all()
checkfirst = not override
Base.metadata.create_all(checkfirst=checkfirst)
# Create an Alembic configuration and generate the version table,
# "stamping" it with the most recent Alembic migration revision, to
# tell Alembic that all the schema upgrades are already in effect.
alembic_cfg = alembic.config.Config()
alembic_cfg.set_main_option('script_location', 'kallithea:alembic')
alembic_cfg.set_main_option('sqlalchemy.url', self.dburi)
# This command will give an error in an Alembic multi-head scenario,
# but in practice, such a scenario should not come up during database
# creation, even during development.
alembic.command.stamp(alembic_cfg, 'head')
log.info('Created tables for %s', self.dbname)
def admin_prompt(self, second=False):
if not self.tests:
import getpass
username = self.cli_args.get('username')
password = self.cli_args.get('password')
email = self.cli_args.get('email')
def get_password():
password = getpass.getpass('Specify admin password '
'(min 6 chars):')
confirm = getpass.getpass('Confirm password:')
if password != confirm:
log.error('passwords mismatch')
return False
if len(password) < 6:
log.error('password is to short use at least 6 characters')
return False
return password
if username is None:
username = input('Specify admin username:')
if password is None:
password = get_password()
if not password:
# second try
password = get_password()
if not password:
sys.exit()
if email is None:
email = input('Specify admin email:')
self.create_user(username, password, email, True)
else:
log.info('creating admin and regular test users')
from kallithea.tests.base import TEST_USER_ADMIN_LOGIN, \
TEST_USER_ADMIN_PASS, TEST_USER_ADMIN_EMAIL, \
TEST_USER_REGULAR_LOGIN, TEST_USER_REGULAR_PASS, \
TEST_USER_REGULAR_EMAIL, TEST_USER_REGULAR2_LOGIN, \
TEST_USER_REGULAR2_PASS, TEST_USER_REGULAR2_EMAIL
self.create_user(TEST_USER_ADMIN_LOGIN, TEST_USER_ADMIN_PASS,
TEST_USER_ADMIN_EMAIL, True)
self.create_user(TEST_USER_REGULAR_LOGIN, TEST_USER_REGULAR_PASS,
TEST_USER_REGULAR_EMAIL, False)
self.create_user(TEST_USER_REGULAR2_LOGIN, TEST_USER_REGULAR2_PASS,
TEST_USER_REGULAR2_EMAIL, False)
def create_auth_plugin_options(self, skip_existing=False):
"""
Create default auth plugin settings, and make it active
:param skip_existing:
"""
for k, v, t in [('auth_plugins', 'kallithea.lib.auth_modules.auth_internal', 'list'),
('auth_internal_enabled', 'True', 'bool')]:
if skip_existing and Setting.get_by_name(k) is not None:
log.debug('Skipping option %s', k)
continue
setting = Setting(k, v, t)
self.sa.add(setting)
def create_default_options(self, skip_existing=False):
"""Creates default settings"""
for k, v, t in [
('default_repo_enable_downloads', False, 'bool'),
('default_repo_enable_statistics', False, 'bool'),
('default_repo_private', False, 'bool'),
('default_repo_type', 'hg', 'unicode')
]:
if skip_existing and Setting.get_by_name(k) is not None:
log.debug('Skipping option %s', k)
continue
setting = Setting(k, v, t)
self.sa.add(setting)
def prompt_repo_root_path(self, test_repo_path='', retries=3):
_path = self.cli_args.get('repos_location')
if retries == 3:
log.info('Setting up repositories config')
if _path is not None:
path = _path
elif not self.tests and not test_repo_path:
path = input(
'Enter a valid absolute path to store repositories. '
'All repositories in that path will be added automatically:'
)
else:
path = test_repo_path
path_ok = True
# check proper dir
if not os.path.isdir(path):
path_ok = False
log.error('Given path %s is not a valid directory', path)
elif not os.path.isabs(path):
path_ok = False
log.error('Given path %s is not an absolute path', path)
# check if path is at least readable.
if not os.access(path, os.R_OK):
path_ok = False
log.error('Given path %s is not readable', path)
# check write access, warn user about non writeable paths
elif not os.access(path, os.W_OK) and path_ok:
log.warning('No write permission to given path %s', path)
if not self._ask_ok('Given path %s is not writeable, do you want to '
'continue with read only mode ? [y/n]' % (path,)):
log.error('Canceled by user')
sys.exit(-1)
if retries == 0:
sys.exit('max retries reached')
if not path_ok:
if _path is not None:
sys.exit('Invalid repo path: %s' % _path)
retries -= 1
return self.prompt_repo_root_path(test_repo_path, retries) # recursing!!!
real_path = os.path.normpath(os.path.realpath(path))
if real_path != os.path.normpath(path):
log.warning('Using normalized path %s instead of %s', real_path, path)
return real_path
def create_settings(self, repo_root_path):
ui_config = [
('paths', '/', repo_root_path, True),
#('phases', 'publish', 'false', False)
('hooks', Ui.HOOK_UPDATE, 'hg update >&2', False),
('hooks', Ui.HOOK_REPO_SIZE, 'python:kallithea.lib.hooks.repo_size', True),
('extensions', 'largefiles', '', True),
('largefiles', 'usercache', os.path.join(repo_root_path, '.cache', 'largefiles'), True),
('extensions', 'hgsubversion', '', False),
('extensions', 'hggit', '', False),
]
for ui_section, ui_key, ui_value, ui_active in ui_config:
ui_conf = Ui(
ui_section=ui_section,
ui_key=ui_key,
ui_value=ui_value,
ui_active=ui_active)
self.sa.add(ui_conf)
settings = [
('realm', 'Kallithea', 'unicode'),
('title', '', 'unicode'),
('ga_code', '', 'unicode'),
('show_public_icon', True, 'bool'),
('show_private_icon', True, 'bool'),
('stylify_metalabels', False, 'bool'),
('dashboard_items', 100, 'int'), # TODO: call it page_size
('admin_grid_items', 25, 'int'),
('show_version', True, 'bool'),
('use_gravatar', True, 'bool'),
('gravatar_url', User.DEFAULT_GRAVATAR_URL, 'unicode'),
('clone_uri_tmpl', Repository.DEFAULT_CLONE_URI, 'unicode'),
('clone_ssh_tmpl', Repository.DEFAULT_CLONE_SSH, 'unicode'),
]
for key, val, type_ in settings:
sett = Setting(key, val, type_)
self.sa.add(sett)
self.create_auth_plugin_options()
self.create_default_options()
log.info('Populated Ui and Settings defaults')
def create_user(self, username, password, email='', admin=False):
log.info('creating user %s', username)
UserModel().create_or_update(username, password, email,
firstname='Kallithea', lastname='Admin',
active=True, admin=admin,
extern_type=User.DEFAULT_AUTH_TYPE)
def create_default_user(self):
log.info('creating default user')
# create default user for handling default permissions.
user = UserModel().create_or_update(username=User.DEFAULT_USER_NAME,
password=str(uuid.uuid1())[:20],
email='anonymous@kallithea-scm.org',
firstname='Anonymous',
lastname='User')
# based on configuration options activate/deactivate this user which
# controls anonymous access
if self.cli_args.get('public_access') is False:
log.info('Public access disabled')
user.active = False
Session().commit()
def create_permissions(self):
"""
Creates all permissions defined in the system
"""
# module.(access|create|change|delete)_[name]
# module.(none|read|write|admin)
log.info('creating permissions')
PermissionModel().create_permissions()
def populate_default_permissions(self):
"""
Populate default permissions. It will create only the default
permissions that are missing, and not alter already defined ones
"""
log.info('creating default user permissions')
PermissionModel().create_default_permissions(user=User.DEFAULT_USER_NAME)
|