1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
|
# -*- coding: utf-8 -*-
__doc__ = """GNUmed connection pooler.
Currently, only readonly connections are pooled.
This pool is thread safe.
"""
#============================================================
# SPDX-License-Identifier: GPL-2.0-or-later
__author__ = "karsten.hilbert@gmx.net"
__license__ = "GPL v2 or later (details at http://www.gnu.org)"
_DISABLE_CONNECTION_POOL = False # set to True to disable the connection pool for debugging (= always return new connection)
# standard library imports
import os
import sys
import codecs
import inspect
import logging
import threading
import re as regex
import datetime as pydt
# 3rd party library imports
import psycopg2 as dbapi
if not (float(dbapi.apilevel) >= 2.0):
raise ImportError('gmPG2: supported DB-API level too low')
if not (dbapi.threadsafety == 2):
raise ImportError('gmPG2: lacking minimum thread safety in psycopg2')
if not (dbapi.paramstyle == 'pyformat'):
raise ImportError('gmPG2: lacking pyformat (%%(<name>)s style) placeholder support in psycopg2')
try:
dbapi.__version__.index('dt')
except ValueError:
raise ImportError('gmPG2: lacking datetime support in psycopg2')
try:
dbapi.__version__.index('ext')
except ValueError:
raise ImportError('gmPG2: lacking extensions support in psycopg2')
try:
dbapi.__version__.index('pq3')
except ValueError:
raise ImportError('gmPG2: lacking v3 backend protocol support in psycopg2')
import psycopg2.extensions
import psycopg2.extras
import psycopg2.errorcodes as SQL_error_codes
# GNUmed module imports
if __name__ == '__main__':
sys.path.insert(0, '../../')
from Gnumed.pycommon import gmBorg
from Gnumed.pycommon import gmI18N
from Gnumed.pycommon import gmLog2
from Gnumed.pycommon import gmTools
from Gnumed.pycommon import gmDateTime
# CONSTANTS
_SQL_expand_tz_name = """
SELECT DISTINCT ON (abbrev) name
FROM pg_timezone_names
WHERE
abbrev = %(tz)s
AND
name ~ '^[^/]+/[^/]+$'
AND
name !~ '^Etc/'
"""
# globals
_log = logging.getLogger('gm.db_pool')
_log.info('psycopg2 module version: %s' % dbapi.__version__)
_log.info('PostgreSQL via DB-API module "%s": API level %s, thread safety %s, parameter style "%s"' % (dbapi, dbapi.apilevel, dbapi.threadsafety, dbapi.paramstyle))
_log.info('libpq version (compiled in): %s', psycopg2.__libpq_version__)
_log.info('libpq version (loaded now) : %s', psycopg2.extensions.libpq_version())
#if '2.8' in dbapi.__version__:
# _log.info('psycopg2 v2.8 detected, disabling connection pooling for the time being')
# _DISABLE_CONNECTION_POOL = True
postgresql_version = None
_timestamp_template = "cast('%s' as timestamp with time zone)" # MUST NOT be uniocde or else getquoted will not work (true in py3 ?)
_map_psyco_tx_status2str = [
'TRANSACTION_STATUS_IDLE',
'TRANSACTION_STATUS_ACTIVE',
'TRANSACTION_STATUS_INTRANS',
'TRANSACTION_STATUS_INERROR',
'TRANSACTION_STATUS_UNKNOWN'
]
_map_psyco_conn_status2str = [
'0 - ?',
'STATUS_READY',
'STATUS_BEGIN_ALIAS_IN_TRANSACTION',
'STATUS_PREPARED'
]
_map_psyco_iso_level2str = {
None: 'ISOLATION_LEVEL_DEFAULT (configured on server)',
0: 'ISOLATION_LEVEL_AUTOCOMMIT',
1: 'ISOLATION_LEVEL_READ_UNCOMMITTED',
2: 'ISOLATION_LEVEL_REPEATABLE_READ',
3: 'ISOLATION_LEVEL_SERIALIZABLE',
4: 'ISOLATION_LEVEL_READ_UNCOMMITTED'
}
#============================================================
class cPGCredentials:
def __init__(self) -> None:
self.__host = None # None: left out -> defaults to $PGHOST or implicit <localhost>
self.__port = None # None: left out -> defaults to $PGPORT or libpq compiled-in default (typically 5432)
self.__database = None # must be set before connecting
self.__user = None # must be set before connecting
self.__password = None # None: left out
# -> try password-less connect (TRUST/IDENT/PEER)
# -> try connect with password from <passfile> parameter or $PGPASSFILE or ~/.pgpass
#--------------------------------------------------
# properties
#--------------------------------------------------
def __format_credentials(self):
cred_parts = [
'dbname=%s' % self.__database,
'host=%s' % self.__host,
'port=%s' % self.__port,
'user=%s' % self.__user
]
return ' '.join(cred_parts)
formatted_credentials = property(__format_credentials)
#--------------------------------------------------
def generate_credentials_kwargs(self, connection_name=None):
assert (self.__database is not None), 'self.__database must be defined'
assert (self.__user is not None), 'self.__user must be defined'
kwargs = {
'dbname': self.__database,
'user': self.__user,
'application_name': gmTools.coalesce(connection_name, 'GNUmed'),
'fallback_application_name': 'GNUmed',
'sslmode': 'prefer',
# try to enforce a useful encoding early on so that we
# have a good chance of decoding authentication errors
# containing foreign language characters
'client_encoding': 'UTF8'
}
if self.__host is not None:
kwargs['host'] = self.__host
if self.__port is not None:
kwargs['port'] = self.__port
if self.__password is not None:
kwargs['password'] = self.__password
return kwargs
credentials_kwargs = property(generate_credentials_kwargs)
#--------------------------------------------------
def _get_database(self):
return self.__database
def _set_database(self, database=None):
assert (database is not None), '<database> must not be None'
assert ('salaam.homeunix' not in database), 'The public database is not hosted by <salaam.homeunix.com> anymore.\n\nPlease point your configuration files to <publicdb.gnumed.de>.'
self.__database = database.strip()
_log.info('[%s]', self.__database)
database = property(_get_database, _set_database)
#--------------------------------------------------
def _get_host(self):
return self.__host
def _set_host(self, host=None):
if host is None or host.strip() == '':
self.__host = None
else:
self.__host = host.strip()
_log.info('[%s]', self.__host)
host = property(_get_host, _set_host)
#--------------------------------------------------
def _get_port(self):
return self.__port
def _set_port(self, port=None):
_log.info('[%s]', port)
if port is None:
self.__port = None
return
self.__port = int(port)
port = property(_get_port, _set_port)
#--------------------------------------------------
def _get_user(self):
return self.__user
def _set_user(self, user=None):
assert (user is not None), '<user> must not be None'
assert (user.strip() != ''), '<user> must not be empty'
self.__user = user.strip()
_log.info('[%s]', self.__user)
user = property(_get_user, _set_user)
#--------------------------------------------------
def _get_password(self):
return self.__password
def _set_password(self, password=None):
if password is not None:
gmLog2.add_word2hide(password)
self.__password = password
_log.info('password was set')
password = property(_get_password, _set_password)
#============================================================
class gmConnectionPool(gmBorg.cBorg):
def __init__(self) -> None:
try:
self.__initialized
return
except AttributeError:
self.__initialized = True
_log.info('[%s]: first instantiation', self.__class__.__name__)
self.__ro_conn_pool = {} # keyed by "credentials::thread ID"
self.__SQL_set_client_timezone = None
self.__client_timezone = None
self.__creds = None
self.__log_auth_environment()
#--------------------------------------------------
# connection API
#--------------------------------------------------
def get_connection(self, readonly=True, verbose=False, pooled=True, connection_name=None, autocommit=False, credentials=None):
if _DISABLE_CONNECTION_POOL:
pooled = False
if credentials is not None:
pooled = False
conn = None
if readonly and pooled:
try:
conn = self.__ro_conn_pool[self.pool_key]
except KeyError:
_log.info('pooled RO conn with key [%s] requested, but not in pool, setting up', self.pool_key)
if conn is not None:
#if verbose:
# _log.debug('using pooled conn [%s]', self.pool_key)
return conn
if conn is None:
conn = self.get_raw_connection (
verbose = verbose,
readonly = readonly,
connection_name = connection_name,
autocommit = autocommit,
credentials = credentials
)
if readonly and pooled:
# monkey patch close() for pooled RO connections
conn.original_close = conn.close
conn.close = _raise_exception_on_pooled_ro_conn_close
# set connection properties
# - client encoding
encoding = 'UTF8'
_log.debug('desired client (wire) encoding: [%s]', encoding)
# check whether psycopg2 can handle this encoding
if encoding not in psycopg2.extensions.encodings:
_log.warning('psycopg2 does not know about client (wire) encoding [%s]', encoding)
py_enc = encoding
else:
py_enc = psycopg2.extensions.encodings[encoding]
# check whether Python can handle this encoding
try:
codecs.lookup(py_enc)
except LookupError:
_log.warning('<codecs> module can NOT handle encoding [psycopg2::<%s> -> Python::<%s>]', encoding, py_enc)
conn.set_client_encoding(encoding)
# - transaction isolation level
if not readonly:
conn.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_SERIALIZABLE)
# - client time zone
_log.debug('client timezone [%s]', self.__client_timezone)
curs = conn.cursor()
curs.execute(self.__SQL_set_client_timezone, {'tz': self.__client_timezone})
curs.close()
conn.commit()
if readonly and pooled:
# put into pool
_log.debug('putting RO conn with key [%s] into pool', self.pool_key)
self.__ro_conn_pool[self.pool_key] = conn
if verbose:
log_conn_state(conn)
return conn
#--------------------------------------------------
def get_rw_conn(self, verbose=False, connection_name=None, autocommit=False):
return self.get_connection(verbose = verbose, readonly = False, connection_name = connection_name, autocommit = autocommit)
#--------------------------------------------------
def get_ro_conn(self, verbose=False, connection_name=None, autocommit=False):
return self.get_connection(verbose = verbose, readonly = False, connection_name = connection_name, autocommit = autocommit)
#--------------------------------------------------
def get_raw_connection(self, verbose=False, readonly=True, connection_name=None, autocommit=False, credentials=None):
"""Get a raw, unadorned connection.
- this will not set any parameters such as encoding, timezone, datestyle
- hence it can be used for "service" connections for verifying encodings etc
"""
# # FIXME: support verbose
if credentials is None:
creds2use = self.__creds
else:
creds2use = credentials
creds_kwargs = creds2use.generate_credentials_kwargs(connection_name = connection_name)
try:
# DictConnection now _is_ a real dictionary
conn = dbapi.connect(connection_factory = psycopg2.extras.DictConnection, **creds_kwargs)
except dbapi.OperationalError as e:
_log.error('failed to establish connection [%s]', creds2use.formatted_credentials)
t, v, tb = sys.exc_info()
try:
msg = e.args[0]
except (AttributeError, IndexError, TypeError):
raise
if not self.__is_auth_fail_msg(msg):
raise
raise cAuthenticationError(creds2use.formatted_credentials, msg).with_traceback(tb)
_log.debug('established connection "%s", backend PID: %s', gmTools.coalesce(connection_name, 'anonymous'), conn.get_backend_pid())
# - inspect server
self.__log_on_first_contact(conn)
# - verify PG understands client time zone
self.__detect_client_timezone(conn)
# - set access mode
if readonly:
_log.debug('readonly: forcing autocommit=True to avoid <IDLE IN TRANSACTION>')
autocommit = True
else:
_log.debug('autocommit is desired to be: %s', autocommit)
conn.commit()
conn.autocommit = autocommit
conn.readonly = readonly
# - assume verbose=True to mean we want debugging in the database, too
if verbose:
_log.debug('enabling <plpgsql.extra_warnings/_errors>')
curs = conn.cursor()
try:
curs.execute("SET plpgsql.extra_warnings TO 'all'")
except Exception:
_log.exception('cannot enable <plpgsql.extra_warnings>')
finally:
curs.close()
conn.commit()
curs = conn.cursor()
try:
curs.execute("SET plpgsql.extra_errors TO 'all'")
except Exception:
_log.exception('cannot enable <plpgsql.extra_errors>')
finally:
curs.close()
conn.commit()
return conn
#--------------------------------------------------
def get_dbowner_connection(self, readonly=True, verbose=False, connection_name=None, autocommit=False, dbo_password=None, dbo_account='gm-dbo'):
dbo_creds = cPGCredentials()
dbo_creds.user = dbo_account
dbo_creds.password = dbo_password
dbo_creds.database = self.__creds.database
dbo_creds.host = self.__creds.host
dbo_creds.port = self.__creds.port
return self.get_connection (
pooled = False,
readonly = readonly,
verbose = verbose,
connection_name = connection_name,
autocommit = autocommit,
credentials = dbo_creds
)
#--------------------------------------------------
def discard_pooled_connection_of_thread(self):
try:
conn = self.__ro_conn_pool[self.pool_key]
except KeyError:
_log.debug('no connection pooled for thread [%s]', self.pool_key)
return
del self.__ro_conn_pool[self.pool_key]
if conn.closed:
return
conn.close = conn.original_close
conn.close()
#--------------------------------------------------
def shutdown(self):
for conn_key in self.__ro_conn_pool:
conn = self.__ro_conn_pool[conn_key]
if conn.closed:
continue
_log.debug('closing open database connection, pool key: %s', conn_key)
log_conn_state(conn)
conn.close = conn.original_close
conn.close()
del self.__ro_conn_pool
#--------------------------------------------------
# utility functions
#--------------------------------------------------
def __log_on_first_contact(self, conn):
global postgresql_version
if postgresql_version is not None:
return
_log.debug('heed Prime Directive')
# FIXME: verify PG version
curs = conn.cursor()
curs.execute ("""
SELECT
substring(setting, E'^\\\\d{1,2}\\\\.\\\\d{1,2}')::numeric AS version
FROM
pg_settings
WHERE
name = 'server_version'"""
)
postgresql_version = curs.fetchone()['version']
_log.info('PostgreSQL version (numeric): %s' % postgresql_version)
try:
curs.execute("SELECT pg_size_pretty(pg_database_size(current_database()))")
_log.info('database size: %s', curs.fetchone()[0])
except Exception:
_log.exception('cannot get database size')
finally:
curs.close()
conn.commit()
curs = conn.cursor()
log_pg_settings(curs = curs)
curs.close()
conn.commit()
_log.debug('done')
#--------------------------------------------------
def __log_auth_environment(self):
pgpass_file = os.path.expanduser(os.path.join('~', '.pgpass'))
if os.path.exists(pgpass_file):
_log.debug('standard .pgpass (%s) exists', pgpass_file)
else:
_log.debug('standard .pgpass (%s) not found', pgpass_file)
pgpass_var = os.getenv('PGPASSFILE')
if pgpass_var is None:
_log.debug('$PGPASSFILE not set')
else:
if os.path.exists(pgpass_var):
_log.debug('$PGPASSFILE=%s -> file exists', pgpass_var)
else:
_log.debug('$PGPASSFILE=%s -> file not found')
#--------------------------------------------------
def __detect_client_timezone(self, conn):
"""This is run on the very first connection."""
if self.__client_timezone is not None:
return
_log.debug('trying to detect timezone from system')
# we need gmDateTime to be initialized
if gmDateTime.current_local_iso_numeric_timezone_string is None:
gmDateTime.init()
tz_candidates = [gmDateTime.current_local_timezone_name]
try:
tz_candidates.append(os.environ['TZ'])
except KeyError:
pass
expanded_tzs = []
for tz in tz_candidates:
expanded = self.__expand_timezone(conn, timezone = tz)
if expanded != tz:
expanded_tzs.append(expanded)
tz_candidates.extend(expanded_tzs)
_log.debug('candidates: %s', tz_candidates)
# find best among candidates
found = False
for tz in tz_candidates:
if self.__validate_timezone(conn = conn, timezone = tz):
self.__client_timezone = tz
self.__SQL_set_client_timezone = 'SET timezone TO %(tz)s'
found = True
break
if not found:
self.__client_timezone = gmDateTime.current_local_iso_numeric_timezone_string
self.__SQL_set_client_timezone = 'set time zone interval %(tz)s hour to minute'
_log.info('client system timezone detected as equivalent to [%s]', self.__client_timezone)
# FIXME: check whether server.timezone is the same
# FIXME: value as what we eventually detect
#--------------------------------------------------
def __expand_timezone(self, conn, timezone):
"""Some timezone defs are abbreviations so try to expand
them because "set time zone" doesn't take abbreviations"""
cmd = _SQL_expand_tz_name
args = {'tz': timezone}
conn.commit()
curs = conn.cursor()
result = timezone
try:
curs.execute(cmd, args)
rows = curs.fetchall()
except Exception:
_log.exception('cannot expand timezone abbreviation [%s]', timezone)
finally:
curs.close()
conn.rollback()
if rows:
result = rows[0]['name']
_log.debug('[%s] maps to [%s]', timezone, result)
return result
#---------------------------------------------------
def __validate_timezone(self, conn, timezone):
_log.debug('validating timezone [%s]', timezone)
cmd = 'SET timezone TO %(tz)s'
args = {'tz': timezone}
curs = conn.cursor()
try:
curs.execute(cmd, args)
_log.info('time zone [%s] is settable', timezone)
except dbapi.DataError:
_log.warning('timezone [%s] is not settable', timezone)
return False
except Exception:
_log.exception('failed to set timezone to [%s]', timezone)
return False
finally:
conn.rollback()
# can we actually use it, though ?
cmd = "SELECT '1920-01-19 23:00:00+01'::timestamp with time zone"
try:
curs.execute(cmd)
curs.fetchone()
_log.info('timezone [%s] is usable', timezone)
except Exception:
_log.exception('error using timezone [%s]', timezone)
#_log.error('error using timezone [%s]', timezone)
return False
finally:
curs.close()
conn.rollback()
return True
#--------------------------------------------------
# properties
#--------------------------------------------------
def _get_credentials(self):
return self.__creds
def _set_credentials(self, creds=None):
if self.__creds is not None:
_log.debug('invalidating pooled connections on credentials change')
curr_creds = self.__creds.formatted_credentials + '::'
for conn_key in self.__ro_conn_pool:
if not conn_key.startswith(curr_creds):
continue
conn = self.__ro_conn_pool[conn_key]
self.__ro_conn_pool[conn_key] = None
if conn.closed:
del conn
continue
_log.debug('closing open database connection, pool key: %s', conn_key)
log_conn_state(conn)
conn.close = conn.original_close
conn.close()
del conn
self.__creds = creds
credentials = property(_get_credentials, _set_credentials)
#--------------------------------------------------
def _get_pool_key(self):
return '%s::%s' % (
self.__creds.formatted_credentials,
threading.current_thread().ident
)
pool_key = property(_get_pool_key)
#--------------------------------------------------
def __is_auth_fail_msg(self, msg):
if 'fe_sendauth' in msg:
return True
if regex.search('user ".*" does not exist', msg) is not None:
return True
if 'uthenti' in msg:
return True
if ((
(regex.search('user ".*"', msg) is not None)
or
(regex.search('(R|r)ol{1,2}e', msg) is not None)
)
and ('exist' in msg)
and (regex.search('n(o|ich)t', msg) is not None)
):
return True
# to the best of our knowledge
return False
#============================================================
# internal helpers
#------------------------------------------------------------
def exception_is_connection_loss(exc):
if not isinstance(exc, dbapi.Error):
# not a PG exception
return False
try:
msg = '%s' % exc.args[0]
except (AttributeError, IndexError, TypeError):
_log.debug('cannot extract message from exception')
# cannot process message
return False
_log.debug('interpreting: %s', msg)
is_conn_loss = (
# OperationalError
('erver' in msg)
and
(
('terminat' in msg)
or
('abnorm' in msg)
or
('end' in msg)
# or
# ('oute' in msg)
)
) or (
# InterfaceError
('onnect' in msg)
and
(
('close' in msg)
or
('end' in msg)
)
)
if is_conn_loss:
_log.debug('indicates connection loss')
return is_conn_loss
#------------------------------------------------------------
def log_pg_exception_details(exc):
if not isinstance(exc, dbapi.Error):
return False
try:
args = exc.args
for arg in args:
_log.debug('exc.arg: %s', arg)
except AttributeError:
_log.debug('exception has no <.args>')
_log.debug('pgerror: [%s]', exc.pgerror)
if exc.pgcode is None:
_log.debug('pgcode : %s', exc.pgcode)
else:
_log.debug('pgcode : %s (%s)', exc.pgcode, SQL_error_codes.lookup(exc.pgcode))
if exc.cursor is None:
_log.debug('cursor: None')
else:
log_cursor_state(exc.cursor)
try:
exc.diag
for attr in dir(exc.diag):
if attr.startswith('__'):
continue
val = getattr(exc.diag, attr)
if val is None:
continue
_log.debug('%s: %s', attr, val)
except AttributeError:
_log.debug('diag: not available')
return True
#--------------------------------------------------
def log_pg_settings(curs):
try:
curs.execute('SELECT * FROM pg_settings')
except dbapi.Error:
_log.exception('cannot retrieve PG settings ("SELECT ... FROM pg_settings" failed)')
return False
settings = curs.fetchall()
for setting in settings:
if setting['unit'] is None:
unit = ''
else:
unit = ' %s' % setting['unit']
if setting['sourcefile'] is None:
sfile = ''
else:
sfile = '// %s @ %s' % (setting['sourcefile'], setting['sourceline'])
pending_restart = u''
try:
if setting['pending_restart']:
pending_restart = u'// needs restart'
except KeyError:
# 'pending_restart' does not exist in PG 9.4 yet
pass
_log.debug('%s: %s%s (set from: [%s] // sess RESET will set to: [%s]%s%s)',
setting['name'],
setting['setting'],
unit,
setting['source'],
setting['reset_val'],
pending_restart,
sfile
)
try:
curs.execute('select pg_available_extensions()')
except Exception:
_log.exception('cannot log available PG extensions')
return False
extensions = curs.fetchall()
if extensions is None:
_log.error('no PG extensions available')
return False
for ext in extensions:
_log.debug('PG extension: %s', ext['pg_available_extensions'])
return True
#--------------------------------------------------
def log_cursor_state(cursor):
conn = cursor.connection
tx_status = conn.get_transaction_status()
if tx_status in [ psycopg2.extensions.TRANSACTION_STATUS_INERROR, psycopg2.extensions.TRANSACTION_STATUS_UNKNOWN ]:
isolation_level = '<tx aborted or unknown, cannot retrieve>'
else:
isolation_level = conn.isolation_level
try:
conn_deferrable = conn.deferrable
except AttributeError:
conn_deferrable = '<unavailable>'
if cursor.query is None:
query = '<no query>'
else:
query = cursor.query.decode(errors = 'replace')
if conn.closed != 0:
backend_pid = '<conn closed, cannot retrieve>'
else:
backend_pid = conn.get_backend_pid()
txt = """Cursor
identity: %s; name: %s
closed: %s; scrollable: %s; with hold: %s; arraysize: %s; itersize: %s;
last rowcount: %s; rownumber: %s; lastrowid (OID): %s;
last description: %s
statusmessage: %s
Connection
identity: %s; backend pid: %s; protocol version: %s;
closed: %s; autocommit: %s; isolation level: %s; encoding: %s; async: %s; deferrable: %s; readonly: %s;
TX status: %s; CX status: %s; executing async op: %s;
Query
%s""" % (
# cursor level:
id(cursor),
cursor.name,
cursor.closed,
cursor.scrollable,
cursor.withhold,
cursor.arraysize,
cursor.itersize,
cursor.rowcount,
cursor.rownumber,
cursor.lastrowid,
cursor.description,
cursor.statusmessage,
# connection level:
id(conn),
backend_pid,
conn.protocol_version,
conn.closed,
conn.autocommit,
isolation_level,
conn.encoding,
conn.async_,
conn_deferrable,
conn.readonly,
_map_psyco_tx_status2str[tx_status],
_map_psyco_conn_status2str[conn.status],
conn.isexecuting(),
# query level:
query
)
gmLog2.log_multiline(logging.DEBUG, message = 'Link state:', line_prefix = '', text = txt)
#--------------------------------------------------
def log_conn_state(conn):
tx_status = conn.get_transaction_status()
if tx_status in [ psycopg2.extensions.TRANSACTION_STATUS_INERROR, psycopg2.extensions.TRANSACTION_STATUS_UNKNOWN ]:
isolation_level = '%s (tx aborted or unknown, cannot retrieve)' % conn.isolation_level
else:
isolation_level = '%s (%s)' % (conn.isolation_level, _map_psyco_iso_level2str[conn.isolation_level])
conn_status = '%s (%s)' % (conn.status, _map_psyco_conn_status2str[conn.status])
if conn.closed != 0:
conn_status = 'undefined (%s)' % conn_status
backend_pid = '<conn closed, cannot retrieve>'
else:
backend_pid = conn.get_backend_pid()
try:
conn_deferrable = conn.deferrable
except AttributeError:
conn_deferrable = '<unavailable>'
d = {
'identity': id(conn),
'backend PID': backend_pid,
'protocol version': conn.protocol_version,
'encoding': conn.encoding,
'closed': conn.closed,
'readonly': conn.readonly,
'autocommit': conn.autocommit,
'isolation level (psyco)': isolation_level,
'async': conn.async_,
'deferrable': conn_deferrable,
'transaction status': '%s (%s)' % (tx_status, _map_psyco_tx_status2str[tx_status]),
'connection status': conn_status,
'executing async op': conn.isexecuting(),
'type': type(conn)
}
_log.debug(conn)
for key in d:
_log.debug('%s: %s', key, d[key])
#------------------------------------------------------------
def _raise_exception_on_pooled_ro_conn_close():
call_stack = inspect.stack()
call_stack.reverse()
for idx in range(1, len(call_stack)):
caller = call_stack[idx]
_log.debug('%s[%s] @ [%s] in [%s]', ' '* idx, caller[3], caller[2], caller[1])
del call_stack
raise TypeError('close() called on read-only connection')
#========================================================================
class cAuthenticationError(dbapi.OperationalError):
def __init__(self, creds=None, prev_val=None):
self.creds = creds
self.prev_val = prev_val
def __str__(self):
return 'PostgreSQL: %sDSN: %s' % (self.prev_val, self.creds)
#============================================================
# Python -> PostgreSQL
#------------------------------------------------------------
# test when Squeeze (and thus psycopg2 2.2 becomes Stable
class cAdapterPyDateTime(object):
def __init__(self, dt):
if dt.tzinfo is None:
raise ValueError('datetime.datetime instance is lacking a time zone: [%s]' % _timestamp_template % dt.isoformat())
self.__dt = dt
def getquoted(self):
return _timestamp_template % self.__dt.isoformat()
#============================================================
# main
#------------------------------------------------------------
# make sure psycopg2 knows how to handle unicode ...
psycopg2.extensions.register_type(psycopg2.extensions.UNICODE)
psycopg2.extensions.register_type(psycopg2._psycopg.UNICODEARRAY)
# tell psycopg2 how to adapt datetime types with timestamps when locales are in use
# check in 0.9:
psycopg2.extensions.register_adapter(pydt.datetime, cAdapterPyDateTime)
# turn dict()s into JSON - only works > 9.2
#psycopg2.extensions.register_adapter(dict, psycopg2.extras.Json)
# do NOT adapt *lists* to "... IN (*) ..." syntax because we want
# them adapted to "... ARRAY[]..." so we can support PG arrays
#============================================================
if __name__ == "__main__":
if len(sys.argv) < 2:
sys.exit()
if sys.argv[1] != 'test':
sys.exit()
#--------------------------------------------------------------------
def test_exceptions():
print("testing exceptions")
try:
raise cAuthenticationError('no credentials', 'no previous exception')
except cAuthenticationError:
t, v, tb = sys.exc_info()
print(t)
print(v)
print(tb)
#--------------------------------------------------------------------
def test_get_connection():
print("testing get_connection() from new pool")
pool = gmConnectionPool()
creds = cPGCredentials()
pool.credentials = creds
print('')
try:
_log.debug('3')
conn = pool.get_connection()
print("1) ERROR: get_connection() did not fail")
except AssertionError:
_log.error('failed, as expected')
print("1) SUCCESS: get_connection(%s) failed as expected" % pool)
t, v = sys.exc_info()[:2]
print (' ', t)
print (' ', v)
print('')
creds.database = 'gnumed_v22'
try:
conn = pool.get_connection()
print("2) ERROR: get_connection() did not fail")
except AssertionError:
_log.error('failed, as expected')
print("2) SUCCESS: get_connection() failed as expected")
t, v = sys.exc_info()[:2]
print(' ', t)
print(' ', v)
print('')
creds.database = 'gnumed_v22'
creds.user = 'abc'
try:
conn = pool.get_connection()
print("3) ERROR: get_connection() did not fail")
except cAuthenticationError:
_log.error('failed, as expected')
print("3) SUCCESS: get_connection() failed as expected")
t, v = sys.exc_info()[:2]
print(' ', t)
print(' ', v)
print('')
creds.database = 'gnumed_v22'
creds.user = 'any-doc'
creds.password = 'abcd'
try:
conn = pool.get_connection()
print("4) ERROR: get_connection() did not fail")
except cAuthenticationError:
_log.error('failed, as expected')
print("4) SUCCESS: get_connection() failed as expected")
t, v = sys.exc_info()[:2]
print(' ', t)
print(' ', v)
print('')
creds.password = 'any-doc'
conn = pool.get_connection(readonly=True)
print('5) SUCCESS: get_connection(ro)')
print('')
conn = pool.get_connection(readonly=False, verbose=True)
print('6) SUCCESS: get_connection(rw)')
print('')
try:
conn = pool.get_connection()
print("7) SUCCESS:")
print('pid:', conn.get_backend_pid())
except cAuthenticationError:
print("7) SUCCESS: get_connection() failed")
t, v = sys.exc_info()[:2]
print(' ', t)
print(' ', v)
try:
conn = pool.get_connection()
curs = conn.cursor()
input('hit enter to run query')
curs.execute('selec 1')
except Exception as exc:
_log.error('failed, as expected')
print('ERROR')
_log.exception('exception occurred')
log_pg_exception_details(exc)
if exception_is_connection_loss(exc):
_log.error('lost connection')
try:
conn = pool.get_connection()
curs = conn.cursor()
input('hit enter to run query')
curs.execute('select 1 from table_does_not_exist')
except Exception as exc:
_log.error('failed, as expected')
print('ERROR')
_log.exception('exception occurred')
log_pg_exception_details(exc)
if exception_is_connection_loss(exc):
_log.error('lost connection')
#--------------------------------------------------------------------
def test_change_creds():
print("testing credentials change")
pool = gmConnectionPool()
creds = cPGCredentials()
creds.database = 'gnumed_v22'
creds.user = 'any-doc'
pool.credentials = creds
conn = pool.get_connection()
_log.debug('changing credentials')
creds.user = 'gm-dbo'
pool.credentials = creds
conn = pool.get_connection()
#--------------------------------------------------------------------
def test_credentials():
print("testing credentials with spaces")
pool = gmConnectionPool()
creds = cPGCredentials()
creds.database = 'gnumed_v22'
creds.user = 'any-doc'
creds.password = 'any-doc'
pool.credentials = creds
conn = pool.get_connection()
print(conn)
creds.password = 'a - b'
pool.credentials = creds
conn = pool.get_connection()
#--------------------------------------------------------------------
test_credentials()
#test_exceptions()
#test_get_connection()
#test_change_creds()
|