File size: 6,217 Bytes
ae01f49 | 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 | ##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2024, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################
import os
import sys
import getpass
from pgadmin.utils.constants import KERBEROS
FAILED_CREATE_DIR = \
"ERROR : Failed to create the directory {}:\n {}"
def _create_directory_if_not_exists(_path):
if _path and not os.path.exists(_path):
os.mkdir(_path)
return True
return False
def create_app_data_directory(config):
"""
Create the required directories (if not present).
"""
# Create the directory containing the configuration file (if not present).
is_directory_created = False
try:
is_directory_created = _create_directory_if_not_exists(
os.path.dirname(config.SQLITE_PATH))
except PermissionError as e:
print(FAILED_CREATE_DIR.format(os.path.dirname(config.SQLITE_PATH), e))
print(
"HINT : Create the directory {}, ensure it is writeable by\n"
" '{}', and try again, or, create a config_local.py file\n"
" and override the SQLITE_PATH setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
os.path.dirname(config.SQLITE_PATH),
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
# Try to set the permissions on the directory, but don't complain
# if we can't. This may be the case on a mounted directory, e.g. in
# OpenShift. We'll still secure the config database anyway.
if os.name != 'nt' and is_directory_created:
try:
os.chmod(os.path.dirname(config.SQLITE_PATH), 0o700)
except Exception as e:
# The flask app isn't setup yet, so we can't use the logger
print('WARNING: Failed to set ACL on the directory containing the '
'configuration database:\n {}'.format(e))
print("HINT : You may need to manually set the permissions on\n"
" {} to allow {} to write to it.".
format(os.path.dirname(config.SQLITE_PATH),
getpass.getuser()))
# Create the directory containing the log file (if not present).
try:
_create_directory_if_not_exists(os.path.dirname(config.LOG_FILE))
except PermissionError as e:
print(FAILED_CREATE_DIR.format(os.path.dirname(config.LOG_FILE), e))
print(
"HINT : Create the directory {}, ensure it is writeable by\n"
" '{}', and try again, or, create a config_local.py file\n"
" and override the LOG_FILE setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
os.path.dirname(config.LOG_FILE),
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
# Create the session directory (if not present).
try:
is_directory_created = \
_create_directory_if_not_exists(config.SESSION_DB_PATH)
except PermissionError as e:
print(FAILED_CREATE_DIR.format(config.SESSION_DB_PATH, e))
print(
"HINT : Create the directory {}, ensure it is writeable by\n"
" '{}', and try again, or, create a config_local.py file\n"
" and override the SESSION_DB_PATH setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
config.SESSION_DB_PATH,
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
if os.name != 'nt' and is_directory_created:
os.chmod(config.SESSION_DB_PATH, 0o700)
# Create the storage directory (if not present).
try:
_create_directory_if_not_exists(config.STORAGE_DIR)
except PermissionError as e:
print(FAILED_CREATE_DIR.format(config.STORAGE_DIR, e))
print(
"HINT : Create the directory {}, ensure it is writable by\n"
" '{}', and try again, or, create a config_local.py file\n"
" and override the STORAGE_DIR setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
config.STORAGE_DIR,
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
# Create Azure Credential Cache directory (if not present).
try:
_create_directory_if_not_exists(config.AZURE_CREDENTIAL_CACHE_DIR)
except PermissionError as e:
print(FAILED_CREATE_DIR.format(config.AZURE_CREDENTIAL_CACHE_DIR, e))
print(
"HINT : Create the directory {}, ensure it is writable by\n"
"'{}', and try again, or, create a config_local.py file\n"
" and override the AZURE_CREDENTIAL_CACHE_DIR setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
config.AZURE_CREDENTIAL_CACHE_DIR,
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
# Create Kerberos Credential Cache directory (if not present).
if config.SERVER_MODE and KERBEROS in config.AUTHENTICATION_SOURCES:
try:
_create_directory_if_not_exists(config.KERBEROS_CCACHE_DIR)
except PermissionError as e:
print(FAILED_CREATE_DIR.format(config.KERBEROS_CCACHE_DIR, e))
print(
"HINT : Create the directory {}, ensure it is writable by\n"
"'{}', and try again, or, create a config_local.py file\n"
" and override the KERBEROS_CCACHE_DIR setting per\n"
" https://www.pgadmin.org/docs/pgadmin4/{}/config_py.html".
format(
config.KERBEROS_CCACHE_DIR,
getpass.getuser(),
config.APP_VERSION))
sys.exit(1)
|