Source code for lib_openmolar.common.datatypes.connection_data
#! /usr/bin/env python
# -*- coding: utf-8 -*-
###############################################################################
## ##
## Copyright 2010, Neil Wallace <rowinggolfer@googlemail.com> ##
## ##
## 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/>. ##
## ##
###############################################################################
'''
A custom datatype, capable of parsing conf files in the following format
'''
import ConfigParser
import getpass
import types
[docs]class ConnectionData(object):
'''
A custom data type to store information on how the application can connect
to a postgres database.
'''
#:
TCP_IP = 0
#:
SOCKET = 1
CONNECTION_TYPE = TCP_IP
'''
the default connection is TCP/IP
(ie. username and password connection to a specific database name
on a known host and port)
'''
conf_file = None
'an attribute to store the location of the conf file for this connection'
[docs] def __init__(self, connection_name="", user="", password="", host="",
port=5432, db_name=""):
self._connection_name = connection_name
#:
self.user = user
self._password = password
#:
self.host = host
#:
self.port = port
#:
self.db_name = db_name
[docs] def demo_connection(self):
'''
returns params for a TCP_IP connection on localhost:5432 to
openmolar_demo with the default user and password.
'''
self.CONNECTION_TYPE = self.TCP_IP
self._connection_name = "openmolar_demo"
self.user = "om_demo"
self._password = "password"
self.host = "localhost"
self.port = 5432
self.db_name = "openmolar_demo"
[docs] def from_conf_file(self, conf_file):
'''
parse a conf_filefor connection params
'''
f = open(conf_file)
parser = ConfigParser.SafeConfigParser()
parser.readfp(f)
if parser.get("CONNECTION", "type") == "TCP/IP":
self._from_tcpconf(parser)
self.conf_file = conf_file
else:
raise IOError("unable to parse %s"% f)
def _from_tcpconf(self, parser):
'''
populate params from a config where the connection type is tcp/ip
'''
self.CONNECTION_TYPE = self.TCP_IP
self._connection_name = parser.get("CONNECTION", "name")
self.user = parser.get("CONNECTION", "user")
self.host = parser.get("CONNECTION", "host")
self.port = parser.getint("CONNECTION", "port")
self.db_name = parser.get("CONNECTION", "db_name")
if parser.get("CONNECTION", "auth") == "plain_password":
self._password = parser.get("CONNECTION", "password")
else:
self._password = (self.get_password,
"Please enter a password for the connection %s"%(
self.connection_name))
@property
[docs] def password(self):
if type(self._password) == types.TupleType:
self._password = self._password[0].__call__(self._password[1])
return self._password
[docs] def get_password(self, prompt_):
'''
prompt the user for a password.
(should be overwritten if subclassing)
'''
return getpass.getpass(prompt=prompt_)
@property
[docs] def brief_name(self):
'''
a short, readable name for this connection.
'''
return "'%s'" % self._connection_name
@property
[docs] def connection_name(self):
'''
a detailed, readable name for this connection.
'''
if self.CONNECTION_TYPE == self.TCP_IP:
return "'%s' %s on %s:%s"% (
self._connection_name, self.user, self.host, self.port)
return "?? connection type, %s"% self._connection_name
[docs] def set_connection_name(self, name):
'''
set a readable name for this connection
'''
self._connection_name = name
[docs] def to_html(self):
'''
returns an html table to show the params (password hidden)
'''
html = u'''<h2 align="center">%s</h2>
<table width="100%%" border="1">
<tr><td>host</td><td><b>%s</b></td></tr>
<tr><td>port</td><td><b>%s</b></td></tr>
<tr><td>user</td><td><b>%s</b></td></tr>
<tr><td>password</td><td><b>%s</b></td></tr>
<tr><td>database</td><td><b>%s</b></td></tr></table>'''% (
self.brief_name,
self.host,
self.port,
self.user,
("*" * len(self.password))[:4],
self.db_name)
return html
def __repr__(self):
return "ConnectionData - '%s'"% self.connection_name
def __cmp__(self, other):
def str_atts(obj):
return "%s%s%s%s%s%s%s"% (
obj.connection_name,
obj.user,
obj.password,
obj.host,
obj.port,
obj.db_name,
obj.CONNECTION_TYPE)
return cmp(str_atts(self), str_atts(other))
def _test():
import gettext
gettext.install("")
obj = ConnectionData()
obj.demo_connection()
obj2 = ConnectionData()
obj2.from_conf_file("/etc/openmolar/client-connections/demo")
print obj == obj2
print obj.to_html()
if __name__ == "__main__":
_test()
