Context Navigation

ldapstorage.py @ 2754

Revision 2754, 94.1 kB (checked in by jerome, 18 years ago)
Huge speed improvement in data retrieval when wildcards are not used.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`

Rev	Line
[1016]	1	# PyKota
[1144]	2	# -- coding: ISO-8859-15 --
[1016]	3	#
	4	# PyKota : Print Quotas for CUPS and LPRng
	5	#
[2622]	6	# (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com>
[1016]	7	# This program is free software; you can redistribute it and/or modify
	8	# it under the terms of the GNU General Public License as published by
	9	# the Free Software Foundation; either version 2 of the License, or
	10	# (at your option) any later version.
	11	#
	12	# This program is distributed in the hope that it will be useful,
	13	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	# GNU General Public License for more details.
	16	#
	17	# You should have received a copy of the GNU General Public License
	18	# along with this program; if not, write to the Free Software
[2302]	19	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
[1016]	20	#
	21	# $Id$
	22	#
[2107]	23	#
[1016]	24
	25	#
	26	# My IANA assigned number, for
	27	# "Conseil Internet & Logiciels Libres, J�me Alet"
	28	# is 16868. Use this as a base to create the LDAP schema.
	29	#
	30
[2221]	31	import sys
[1750]	32	import os
[1240]	33	import types
[1030]	34	import time
	35	import md5
[2460]	36	import base64
[2679]	37	import random
	38
[1522]	39	from mx import DateTime
[1016]	40
[2380]	41	from pykota.storage import PyKotaStorageError, BaseStorage, StorageObject, \
	42	StorageUser, StorageGroup, StoragePrinter, \
	43	StorageJob, StorageLastJob, StorageUserPQuota, \
	44	StorageGroupPQuota, StorageBillingCode
[1016]	45
	46	try :
	47	import ldap
[1356]	48	import ldap.modlist
[1016]	49	except ImportError :
	50	raise PyKotaStorageError, "This python version (%s) doesn't seem to have the python-ldap module installed correctly." % sys.version.split()[0]
[2221]	51	else :
	52	try :
	53	from ldap.cidict import cidict
	54	except ImportError :
	55	import UserDict
	56	sys.stderr.write("ERROR: PyKota requires a newer version of python-ldap. Workaround activated. Please upgrade python-ldap !\n")
	57	class cidict(UserDict.UserDict) :
	58	pass # Fake it all, and don't care for case insensitivity : users who need it will have to upgrade.
[1016]	59
[1130]	60	class Storage(BaseStorage) :
[1021]	61	def __init__(self, pykotatool, host, dbname, user, passwd) :
[1016]	62	"""Opens the LDAP connection."""
[1966]	63	self.savedtool = pykotatool
	64	self.savedhost = host
	65	self.saveddbname = dbname
	66	self.saveduser = user
	67	self.savedpasswd = passwd
	68	self.secondStageInit()
	69
	70	def secondStageInit(self) :
	71	"""Second stage initialisation."""
	72	BaseStorage.__init__(self, self.savedtool)
	73	self.info = self.tool.config.getLDAPInfo()
	74	message = ""
	75	for tryit in range(3) :
	76	try :
[2418]	77	self.tool.logdebug("Trying to open database (host=%s, dbname=%s, user=%s)..." % (self.savedhost, self.saveddbname, self.saveduser))
[1966]	78	self.database = ldap.initialize(self.savedhost)
[1968]	79	if self.info["ldaptls"] :
	80	# we want TLS
	81	ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, self.info["cacert"])
	82	self.database.set_option(ldap.OPT_X_TLS, ldap.OPT_X_TLS_DEMAND)
	83	self.database.start_tls_s()
[1966]	84	self.database.simple_bind_s(self.saveduser, self.savedpasswd)
	85	self.basedn = self.saveddbname
	86	except ldap.SERVER_DOWN :
	87	message = "LDAP backend for PyKota seems to be down !"
	88	self.tool.printInfo("%s" % message, "error")
	89	self.tool.printInfo("Trying again in 2 seconds...", "warn")
	90	time.sleep(2)
	91	except ldap.LDAPError :
	92	message = "Unable to connect to LDAP server %s as %s." % (self.savedhost, self.saveduser)
	93	self.tool.printInfo("%s" % message, "error")
	94	self.tool.printInfo("Trying again in 2 seconds...", "warn")
	95	time.sleep(2)
	96	else :
	97	self.useldapcache = self.tool.config.getLDAPCache()
	98	if self.useldapcache :
	99	self.tool.logdebug("Low-Level LDAP Caching enabled.")
	100	self.ldapcache = {} # low-level cache specific to LDAP backend
	101	self.closed = 0
	102	self.tool.logdebug("Database opened (host=%s, dbname=%s, user=%s)" % (self.savedhost, self.saveddbname, self.saveduser))
	103	return # All is fine here.
	104	raise PyKotaStorageError, message
[1016]	105
[1113]	106	def close(self) :
[1016]	107	"""Closes the database connection."""
	108	if not self.closed :
[1170]	109	self.database.unbind_s()
[1016]	110	self.closed = 1
[1130]	111	self.tool.logdebug("Database closed.")
[1016]	112
[1030]	113	def genUUID(self) :
	114	"""Generates an unique identifier.
	115
	116	TODO : this one is not unique accross several print servers, but should be sufficient for testing.
	117	"""
[2680]	118	return md5.md5("%s-%s" % (time.time(), random.random())).hexdigest()
[1030]	119
[1240]	120	def normalizeFields(self, fields) :
	121	"""Ensure all items are lists."""
	122	for (k, v) in fields.items() :
	123	if type(v) not in (types.TupleType, types.ListType) :
	124	if not v :
	125	del fields[k]
	126	else :
	127	fields[k] = [ v ]
	128	return fields
	129
[1041]	130	def beginTransaction(self) :
	131	"""Starts a transaction."""
[1130]	132	self.tool.logdebug("Transaction begins... WARNING : No transactions in LDAP !")
[1041]	133
	134	def commitTransaction(self) :
	135	"""Commits a transaction."""
[1130]	136	self.tool.logdebug("Transaction committed. WARNING : No transactions in LDAP !")
[1041]	137
	138	def rollbackTransaction(self) :
	139	"""Rollbacks a transaction."""
[1130]	140	self.tool.logdebug("Transaction aborted. WARNING : No transaction in LDAP !")
[1041]	141
[1356]	142	def doSearch(self, key, fields=None, base="", scope=ldap.SCOPE_SUBTREE, flushcache=0) :
[1016]	143	"""Does an LDAP search query."""
[1966]	144	message = ""
	145	for tryit in range(3) :
	146	try :
	147	base = base or self.basedn
	148	if self.useldapcache :
	149	# Here we overwrite the fields the app want, to try and
	150	# retrieve ALL user defined attributes ("*")
	151	# + the createTimestamp attribute, needed by job history
	152	#
	153	# This may not work with all LDAP servers
	154	# but works at least in OpenLDAP (2.1.25)
	155	# and iPlanet Directory Server (5.1 SP3)
	156	fields = ["*", "createTimestamp"]
	157
	158	if self.useldapcache and (not flushcache) and (scope == ldap.SCOPE_BASE) and self.ldapcache.has_key(base) :
	159	entry = self.ldapcache[base]
	160	self.tool.logdebug("LDAP cache hit %s => %s" % (base, entry))
	161	result = [(base, entry)]
	162	else :
	163	self.tool.logdebug("QUERY : Filter : %s, BaseDN : %s, Scope : %s, Attributes : %s" % (key, base, scope, fields))
	164	result = self.database.search_s(base, scope, key, fields)
	165	except ldap.NO_SUCH_OBJECT, msg :
	166	raise PyKotaStorageError, (_("Search base %s doesn't seem to exist. Probable misconfiguration. Please double check /etc/pykota/pykota.conf : %s") % (base, msg))
	167	except ldap.LDAPError, msg :
	168	message = (_("Search for %s(%s) from %s(scope=%s) returned no answer.") % (key, fields, base, scope)) + " : %s" % str(msg)
	169	self.tool.printInfo("LDAP error : %s" % message, "error")
	170	self.tool.printInfo("LDAP connection will be closed and reopened.", "warn")
	171	self.close()
	172	self.secondStageInit()
	173	else :
	174	self.tool.logdebug("QUERY : Result : %s" % result)
[2221]	175	result = [ (dn, cidict(attrs)) for (dn, attrs) in result ]
[1966]	176	if self.useldapcache :
	177	for (dn, attributes) in result :
	178	self.tool.logdebug("LDAP cache store %s => %s" % (dn, attributes))
	179	self.ldapcache[dn] = attributes
	180	return result
	181	raise PyKotaStorageError, message
[1030]	182
	183	def doAdd(self, dn, fields) :
	184	"""Adds an entry in the LDAP directory."""
[2221]	185	fields = self.normalizeFields(cidict(fields))
[1966]	186	message = ""
	187	for tryit in range(3) :
	188	try :
	189	self.tool.logdebug("QUERY : ADD(%s, %s)" % (dn, str(fields)))
	190	entry = ldap.modlist.addModlist(fields)
	191	self.tool.logdebug("%s" % entry)
	192	self.database.add_s(dn, entry)
[2749]	193	except ldap.ALREADY_EXISTS, msg :
[2751]	194	raise PyKotaStorageError, "Entry %s already exists : %s" % (dn, str(msg))
[1966]	195	except ldap.LDAPError, msg :
	196	message = (_("Problem adding LDAP entry (%s, %s)") % (dn, str(fields))) + " : %s" % str(msg)
	197	self.tool.printInfo("LDAP error : %s" % message, "error")
	198	self.tool.printInfo("LDAP connection will be closed and reopened.", "warn")
	199	self.close()
	200	self.secondStageInit()
	201	else :
	202	if self.useldapcache :
	203	self.tool.logdebug("LDAP cache add %s => %s" % (dn, fields))
	204	self.ldapcache[dn] = fields
	205	return dn
	206	raise PyKotaStorageError, message
[1030]	207
[1041]	208	def doDelete(self, dn) :
	209	"""Deletes an entry from the LDAP directory."""
[1966]	210	message = ""
	211	for tryit in range(3) :
	212	try :
	213	self.tool.logdebug("QUERY : Delete(%s)" % dn)
	214	self.database.delete_s(dn)
[2751]	215	except ldap.NO_SUCH_OBJECT :
	216	self.tool.printInfo("Entry %s was already missing before we deleted it. This MAY be normal." % dn, "info")
[1966]	217	except ldap.LDAPError, msg :
	218	message = (_("Problem deleting LDAP entry (%s)") % dn) + " : %s" % str(msg)
	219	self.tool.printInfo("LDAP error : %s" % message, "error")
	220	self.tool.printInfo("LDAP connection will be closed and reopened.", "warn")
	221	self.close()
	222	self.secondStageInit()
	223	else :
	224	if self.useldapcache :
	225	try :
	226	self.tool.logdebug("LDAP cache del %s" % dn)
	227	del self.ldapcache[dn]
	228	except KeyError :
	229	pass
	230	return
	231	raise PyKotaStorageError, message
[1041]	232
[1356]	233	def doModify(self, dn, fields, ignoreold=1, flushcache=0) :
[1030]	234	"""Modifies an entry in the LDAP directory."""
[2221]	235	fields = cidict(fields)
[1966]	236	for tryit in range(3) :
	237	try :
	238	# TODO : take care of, and update LDAP specific cache
	239	if self.useldapcache and not flushcache :
	240	if self.ldapcache.has_key(dn) :
	241	old = self.ldapcache[dn]
	242	self.tool.logdebug("LDAP cache hit %s => %s" % (dn, old))
	243	oldentry = {}
	244	for (k, v) in old.items() :
	245	if k != "createTimestamp" :
	246	oldentry[k] = v
[1269]	247	else :
[1966]	248	self.tool.logdebug("LDAP cache miss %s" % dn)
	249	oldentry = self.doSearch("objectClass=*", base=dn, scope=ldap.SCOPE_BASE)[0][1]
	250	else :
	251	oldentry = self.doSearch("objectClass=*", base=dn, scope=ldap.SCOPE_BASE, flushcache=flushcache)[0][1]
	252	for (k, v) in fields.items() :
	253	if type(v) == type({}) :
	254	try :
	255	oldvalue = v["convert"](oldentry.get(k, [0])[0])
	256	except ValueError :
	257	self.tool.logdebug("Error converting %s with %s(%s)" % (oldentry.get(k), k, v))
	258	oldvalue = 0
	259	if v["operator"] == '+' :
	260	newvalue = oldvalue + v["value"]
	261	else :
	262	newvalue = oldvalue - v["value"]
	263	fields[k] = str(newvalue)
	264	fields = self.normalizeFields(fields)
	265	self.tool.logdebug("QUERY : Modify(%s, %s ==> %s)" % (dn, oldentry, fields))
	266	entry = ldap.modlist.modifyModlist(oldentry, fields, ignore_oldexistent=ignoreold)
	267	modentry = []
[1356]	268	for (mop, mtyp, mval) in entry :
[2191]	269	if mtyp and (mtyp.lower() != "createtimestamp") :
[1966]	270	modentry.append((mop, mtyp, mval))
	271	self.tool.logdebug("MODIFY : %s ==> %s ==> %s" % (fields, entry, modentry))
	272	if modentry :
	273	self.database.modify_s(dn, modentry)
	274	except ldap.LDAPError, msg :
	275	message = (_("Problem modifying LDAP entry (%s, %s)") % (dn, fields)) + " : %s" % str(msg)
	276	self.tool.printInfo("LDAP error : %s" % message, "error")
	277	self.tool.printInfo("LDAP connection will be closed and reopened.", "warn")
	278	self.close()
	279	self.secondStageInit()
	280	else :
	281	if self.useldapcache :
	282	cachedentry = self.ldapcache[dn]
	283	for (mop, mtyp, mval) in entry :
	284	if mop in (ldap.MOD_ADD, ldap.MOD_REPLACE) :
	285	cachedentry[mtyp] = mval
	286	else :
	287	try :
	288	del cachedentry[mtyp]
	289	except KeyError :
	290	pass
	291	self.tool.logdebug("LDAP cache update %s => %s" % (dn, cachedentry))
	292	return dn
	293	raise PyKotaStorageError, message
[1016]	294
[2652]	295	def filterNames(self, records, attribute, patterns=None) :
[2107]	296	"""Returns a list of 'attribute' from a list of records.
	297
	298	Logs any missing attribute.
	299	"""
	300	result = []
[2191]	301	for (dn, record) in records :
	302	attrval = record.get(attribute, [None])[0]
[2107]	303	if attrval is None :
[2191]	304	self.tool.printInfo("Object %s has no %s attribute !" % (dn, attribute), "error")
[2652]	305	else :
[2653]	306	attrval = self.databaseToUserCharset(attrval)
[2652]	307	if patterns :
	308	if (not isinstance(patterns, type([]))) and (not isinstance(patterns, type(()))) :
	309	patterns = [ patterns ]
	310	if self.tool.matchString(attrval, patterns) :
	311	result.append(attrval)
	312	else :
	313	result.append(attrval)
[2107]	314	return result
	315
[2386]	316	def getAllBillingCodes(self, billingcode=None) :
	317	"""Extracts all billing codes or only the billing codes matching the optional parameter."""
	318	ldapfilter = "objectClass=pykotaBilling"
	319	result = self.doSearch(ldapfilter, ["pykotaBillingCode"], base=self.info["billingcodebase"])
	320	if result :
[2652]	321	return [self.databaseToUserCharset(bc) for bc in self.filterNames(result, "pykotaBillingCode", billingcode)]
	322	else :
	323	return []
[2386]	324
[1993]	325	def getAllPrintersNames(self, printername=None) :
	326	"""Extracts all printer names or only the printers' names matching the optional parameter."""
	327	ldapfilter = "objectClass=pykotaPrinter"
	328	result = self.doSearch(ldapfilter, ["pykotaPrinterName"], base=self.info["printerbase"])
[1754]	329	if result :
[2652]	330	return self.filterNames(result, "pykotaPrinterName", printername)
	331	else :
	332	return []
[1754]	333
[1993]	334	def getAllUsersNames(self, username=None) :
	335	"""Extracts all user names or only the users' names matching the optional parameter."""
	336	ldapfilter = "objectClass=pykotaAccount"
	337	result = self.doSearch(ldapfilter, ["pykotaUserName"], base=self.info["userbase"])
[1179]	338	if result :
[2652]	339	return self.filterNames(result, "pykotaUserName", username)
	340	else :
	341	return []
[1179]	342
[1993]	343	def getAllGroupsNames(self, groupname=None) :
	344	"""Extracts all group names or only the groups' names matching the optional parameter."""
	345	ldapfilter = "objectClass=pykotaGroup"
	346	result = self.doSearch(ldapfilter, ["pykotaGroupName"], base=self.info["groupbase"])
[1179]	347	if result :
[2652]	348	return self.filterNames(result, "pykotaGroupName", groupname)
	349	else :
	350	return []
[1179]	351
[1806]	352	def getUserNbJobsFromHistory(self, user) :
	353	"""Returns the number of jobs the user has in history."""
[2652]	354	result = self.doSearch("(&(pykotaUserName=%s)(objectClass=pykotaJob))" % self.userCharsetToDatabase(user.Name), None, base=self.info["jobbase"])
[1806]	355	return len(result)
	356
[1130]	357	def getUserFromBackend(self, username) :
[1041]	358	"""Extracts user information given its name."""
	359	user = StorageUser(self, username)
[2652]	360	username = self.userCharsetToDatabase(username)
[2721]	361	result = self.doSearch("(&(objectClass=pykotaAccount)(\|(pykotaUserName=%s)(%s=%s)))" % (username, self.info["userrdn"], username), ["pykotaUserName", "pykotaLimitBy", self.info["usermail"], "pykotaOverCharge", "description"], base=self.info["userbase"])
[1016]	362	if result :
[1041]	363	fields = result[0][1]
	364	user.ident = result[0][0]
[2721]	365	user.Description = self.databaseToUserCharset(fields.get("description", [None])[0])
[2054]	366	user.Email = fields.get(self.info["usermail"], [None])[0]
	367	user.LimitBy = fields.get("pykotaLimitBy", ["quota"])[0]
	368	user.OverCharge = float(fields.get("pykotaOverCharge", [1.0])[0])
[1522]	369	result = self.doSearch("(&(objectClass=pykotaAccountBalance)(\|(pykotaUserName=%s)(%s=%s)))" % (username, self.info["balancerdn"], username), ["pykotaBalance", "pykotaLifeTimePaid", "pykotaPayments"], base=self.info["balancebase"])
[1742]	370	if not result :
	371	raise PyKotaStorageError, _("No pykotaAccountBalance object found for user %s. Did you create LDAP entries manually ?") % username
	372	else :
[1041]	373	fields = result[0][1]
	374	user.idbalance = result[0][0]
	375	user.AccountBalance = fields.get("pykotaBalance")
	376	if user.AccountBalance is not None :
	377	if user.AccountBalance[0].upper() == "NONE" :
	378	user.AccountBalance = None
	379	else :
	380	user.AccountBalance = float(user.AccountBalance[0])
	381	user.AccountBalance = user.AccountBalance or 0.0
	382	user.LifeTimePaid = fields.get("pykotaLifeTimePaid")
	383	if user.LifeTimePaid is not None :
	384	if user.LifeTimePaid[0].upper() == "NONE" :
	385	user.LifeTimePaid = None
	386	else :
	387	user.LifeTimePaid = float(user.LifeTimePaid[0])
	388	user.LifeTimePaid = user.LifeTimePaid or 0.0
[1522]	389	user.Payments = []
	390	for payment in fields.get("pykotaPayments", []) :
[2452]	391	try :
	392	(date, amount, description) = payment.split(" # ")
	393	except ValueError :
	394	# Payment with no description (old Payment)
	395	(date, amount) = payment.split(" # ")
	396	description = ""
	397	else :
[2460]	398	description = self.databaseToUserCharset(base64.decodestring(description))
[2452]	399	user.Payments.append((date, float(amount), description))
[1041]	400	user.Exists = 1
	401	return user
	402
[1130]	403	def getGroupFromBackend(self, groupname) :
[1041]	404	"""Extracts group information given its name."""
	405	group = StorageGroup(self, groupname)
[2652]	406	groupname = self.userCharsetToDatabase(groupname)
[2721]	407	result = self.doSearch("(&(objectClass=pykotaGroup)(\|(pykotaGroupName=%s)(%s=%s)))" % (groupname, self.info["grouprdn"], groupname), ["pykotaGroupName", "pykotaLimitBy", "description"], base=self.info["groupbase"])
[1030]	408	if result :
[1041]	409	fields = result[0][1]
	410	group.ident = result[0][0]
[2652]	411	group.Name = fields.get("pykotaGroupName", [self.databaseToUserCharset(groupname)])[0]
[2721]	412	group.Description = self.databaseToUserCharset(fields.get("description", [None])[0])
[2054]	413	group.LimitBy = fields.get("pykotaLimitBy", ["quota"])[0]
[1041]	414	group.AccountBalance = 0.0
	415	group.LifeTimePaid = 0.0
[1137]	416	for member in self.getGroupMembers(group) :
[1075]	417	if member.Exists :
	418	group.AccountBalance += member.AccountBalance
	419	group.LifeTimePaid += member.LifeTimePaid
[1041]	420	group.Exists = 1
	421	return group
	422
[1130]	423	def getPrinterFromBackend(self, printername) :
[1451]	424	"""Extracts printer information given its name : returns first matching printer."""
[1041]	425	printer = StoragePrinter(self, printername)
[2652]	426	printername = self.userCharsetToDatabase(printername)
[2459]	427	result = self.doSearch("(&(objectClass=pykotaPrinter)(\|(pykotaPrinterName=%s)(%s=%s)))" \
	428	% (printername, self.info["printerrdn"], printername), \
	429	["pykotaPrinterName", "pykotaPricePerPage", \
	430	"pykotaPricePerJob", "pykotaMaxJobSize", \
	431	"pykotaPassThrough", "uniqueMember", "description"], \
	432	base=self.info["printerbase"])
[1016]	433	if result :
[1451]	434	fields = result[0][1] # take only first matching printer, ignore the rest
[1041]	435	printer.ident = result[0][0]
[2652]	436	printer.Name = fields.get("pykotaPrinterName", [self.databaseToUserCharset(printername)])[0]
[2054]	437	printer.PricePerJob = float(fields.get("pykotaPricePerJob", [0.0])[0])
	438	printer.PricePerPage = float(fields.get("pykotaPricePerPage", [0.0])[0])
[2459]	439	printer.MaxJobSize = int(fields.get("pykotaMaxJobSize", [0])[0])
	440	printer.PassThrough = fields.get("pykotaPassThrough", [None])[0]
	441	if printer.PassThrough in (1, "1", "t", "true", "TRUE", "True") :
	442	printer.PassThrough = 1
	443	else :
	444	printer.PassThrough = 0
[1258]	445	printer.uniqueMember = fields.get("uniqueMember", [])
[1790]	446	printer.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
[1041]	447	printer.Exists = 1
	448	return printer
	449
[1130]	450	def getUserPQuotaFromBackend(self, user, printer) :
[1041]	451	"""Extracts a user print quota."""
	452	userpquota = StorageUserPQuota(self, user, printer)
[1228]	453	if printer.Exists and user.Exists :
[1969]	454	if self.info["userquotabase"].lower() == "user" :
[1998]	455	base = user.ident
[1969]	456	else :
[1998]	457	base = self.info["userquotabase"]
[2652]	458	result = self.doSearch("(&(objectClass=pykotaUserPQuota)(pykotaUserName=%s)(pykotaPrinterName=%s))" % \
	459	(self.userCharsetToDatabase(user.Name), self.userCharsetToDatabase(printer.Name)), \
[2749]	460	["pykotaPageCounter", "pykotaLifePageCounter", "pykotaSoftLimit", "pykotaHardLimit", "pykotaDateLimit", "pykotaWarnCount", "pykotaMaxJobSize"], \
[2652]	461	base=base)
[1017]	462	if result :
[1041]	463	fields = result[0][1]
	464	userpquota.ident = result[0][0]
[2054]	465	userpquota.PageCounter = int(fields.get("pykotaPageCounter", [0])[0])
	466	userpquota.LifePageCounter = int(fields.get("pykotaLifePageCounter", [0])[0])
	467	userpquota.WarnCount = int(fields.get("pykotaWarnCount", [0])[0])
[1041]	468	userpquota.SoftLimit = fields.get("pykotaSoftLimit")
	469	if userpquota.SoftLimit is not None :
	470	if userpquota.SoftLimit[0].upper() == "NONE" :
	471	userpquota.SoftLimit = None
	472	else :
	473	userpquota.SoftLimit = int(userpquota.SoftLimit[0])
	474	userpquota.HardLimit = fields.get("pykotaHardLimit")
	475	if userpquota.HardLimit is not None :
	476	if userpquota.HardLimit[0].upper() == "NONE" :
	477	userpquota.HardLimit = None
	478	elif userpquota.HardLimit is not None :
	479	userpquota.HardLimit = int(userpquota.HardLimit[0])
	480	userpquota.DateLimit = fields.get("pykotaDateLimit")
	481	if userpquota.DateLimit is not None :
	482	if userpquota.DateLimit[0].upper() == "NONE" :
	483	userpquota.DateLimit = None
	484	else :
	485	userpquota.DateLimit = userpquota.DateLimit[0]
[2749]	486	userpquota.MaxJobSize = fields.get("pykotaMaxJobSize")
	487	if userpquota.MaxJobSize is not None :
	488	if userpquota.MaxJobSize[0].upper() == "NONE" :
	489	userpquota.MaxJobSize = None
	490	else :
	491	userpquota.MaxJobSize = int(userpquota.MaxJobSize[0])
[1041]	492	userpquota.Exists = 1
	493	return userpquota
[1016]	494
[1130]	495	def getGroupPQuotaFromBackend(self, group, printer) :
[1041]	496	"""Extracts a group print quota."""
	497	grouppquota = StorageGroupPQuota(self, group, printer)
	498	if group.Exists :
[1969]	499	if self.info["groupquotabase"].lower() == "group" :
[1998]	500	base = group.ident
[1969]	501	else :
[1998]	502	base = self.info["groupquotabase"]
[2652]	503	result = self.doSearch("(&(objectClass=pykotaGroupPQuota)(pykotaGroupName=%s)(pykotaPrinterName=%s))" % \
	504	(self.userCharsetToDatabase(group.Name), self.userCharsetToDatabase(printer.Name)), \
[2749]	505	["pykotaSoftLimit", "pykotaHardLimit", "pykotaDateLimit", "pykotaMaxJobSize"], \
[2652]	506	base=base)
[1041]	507	if result :
	508	fields = result[0][1]
	509	grouppquota.ident = result[0][0]
	510	grouppquota.SoftLimit = fields.get("pykotaSoftLimit")
	511	if grouppquota.SoftLimit is not None :
	512	if grouppquota.SoftLimit[0].upper() == "NONE" :
	513	grouppquota.SoftLimit = None
	514	else :
	515	grouppquota.SoftLimit = int(grouppquota.SoftLimit[0])
	516	grouppquota.HardLimit = fields.get("pykotaHardLimit")
	517	if grouppquota.HardLimit is not None :
	518	if grouppquota.HardLimit[0].upper() == "NONE" :
	519	grouppquota.HardLimit = None
	520	else :
	521	grouppquota.HardLimit = int(grouppquota.HardLimit[0])
	522	grouppquota.DateLimit = fields.get("pykotaDateLimit")
	523	if grouppquota.DateLimit is not None :
	524	if grouppquota.DateLimit[0].upper() == "NONE" :
	525	grouppquota.DateLimit = None
	526	else :
	527	grouppquota.DateLimit = grouppquota.DateLimit[0]
[2749]	528	grouppquota.MaxJobSize = fields.get("pykotaMaxJobSize")
	529	if grouppquota.MaxJobSize is not None :
	530	if grouppquota.MaxJobSize[0].upper() == "NONE" :
	531	grouppquota.MaxJobSize = None
	532	else :
	533	grouppquota.MaxJobSize = int(grouppquota.MaxJobSize[0])
[1041]	534	grouppquota.PageCounter = 0
	535	grouppquota.LifePageCounter = 0
[2652]	536	usernamesfilter = "".join(["(pykotaUserName=%s)" % self.userCharsetToDatabase(member.Name) for member in self.getGroupMembers(group)])
[1361]	537	if usernamesfilter :
	538	usernamesfilter = "(\|%s)" % usernamesfilter
[1998]	539	if self.info["userquotabase"].lower() == "user" :
	540	base = self.info["userbase"]
	541	else :
	542	base = self.info["userquotabase"]
[2652]	543	result = self.doSearch("(&(objectClass=pykotaUserPQuota)(pykotaPrinterName=%s)%s)" % \
	544	(self.userCharsetToDatabase(printer.Name), usernamesfilter), \
	545	["pykotaPageCounter", "pykotaLifePageCounter"], base=base)
[1041]	546	if result :
	547	for userpquota in result :
[1392]	548	grouppquota.PageCounter += int(userpquota[1].get("pykotaPageCounter", [0])[0] or 0)
	549	grouppquota.LifePageCounter += int(userpquota[1].get("pykotaLifePageCounter", [0])[0] or 0)
[1041]	550	grouppquota.Exists = 1
	551	return grouppquota
	552
[1130]	553	def getPrinterLastJobFromBackend(self, printer) :
[1041]	554	"""Extracts a printer's last job information."""
	555	lastjob = StorageLastJob(self, printer)
[2652]	556	pname = self.userCharsetToDatabase(printer.Name)
	557	result = self.doSearch("(&(objectClass=pykotaLastjob)(\|(pykotaPrinterName=%s)(%s=%s)))" % \
	558	(pname, self.info["printerrdn"], pname), \
	559	["pykotaLastJobIdent"], \
	560	base=self.info["lastjobbase"])
[1016]	561	if result :
[1041]	562	lastjob.lastjobident = result[0][0]
	563	lastjobident = result[0][1]["pykotaLastJobIdent"][0]
[1692]	564	result = None
	565	try :
[2211]	566	result = self.doSearch("objectClass=pykotaJob", [ "pykotaJobSizeBytes",
	567	"pykotaHostName",
	568	"pykotaUserName",
	569	"pykotaPrinterName",
	570	"pykotaJobId",
	571	"pykotaPrinterPageCounter",
	572	"pykotaJobSize",
	573	"pykotaAction",
	574	"pykotaJobPrice",
	575	"pykotaFileName",
	576	"pykotaTitle",
	577	"pykotaCopies",
	578	"pykotaOptions",
	579	"pykotaBillingCode",
	580	"pykotaPages",
	581	"pykotaMD5Sum",
[2455]	582	"pykotaPrecomputedJobSize",
	583	"pykotaPrecomputedJobPrice",
[2211]	584	"createTimestamp" ],
	585	base="cn=%s,%s" % (lastjobident, self.info["jobbase"]), scope=ldap.SCOPE_BASE)
[1692]	586	except PyKotaStorageError :
	587	pass # Last job entry exists, but job probably doesn't exist anymore.
[1017]	588	if result :
[1041]	589	fields = result[0][1]
	590	lastjob.ident = result[0][0]
	591	lastjob.JobId = fields.get("pykotaJobId")[0]
[2652]	592	lastjob.UserName = self.databaseToUserCharset(fields.get("pykotaUserName")[0])
[2054]	593	lastjob.PrinterPageCounter = int(fields.get("pykotaPrinterPageCounter", [0])[0])
[1601]	594	try :
	595	lastjob.JobSize = int(fields.get("pykotaJobSize", [0])[0])
	596	except ValueError :
	597	lastjob.JobSize = None
	598	try :
	599	lastjob.JobPrice = float(fields.get("pykotaJobPrice", [0.0])[0])
	600	except ValueError :
	601	lastjob.JobPrice = None
[1393]	602	lastjob.JobAction = fields.get("pykotaAction", [""])[0]
[1790]	603	lastjob.JobFileName = self.databaseToUserCharset(fields.get("pykotaFileName", [""])[0])
	604	lastjob.JobTitle = self.databaseToUserCharset(fields.get("pykotaTitle", [""])[0])
[1203]	605	lastjob.JobCopies = int(fields.get("pykotaCopies", [0])[0])
[1790]	606	lastjob.JobOptions = self.databaseToUserCharset(fields.get("pykotaOptions", [""])[0])
[1502]	607	lastjob.JobHostName = fields.get("pykotaHostName", [""])[0]
[1520]	608	lastjob.JobSizeBytes = fields.get("pykotaJobSizeBytes", [0L])[0]
[2217]	609	lastjob.JobBillingCode = self.databaseToUserCharset(fields.get("pykotaBillingCode", [None])[0])
[2054]	610	lastjob.JobMD5Sum = fields.get("pykotaMD5Sum", [None])[0]
	611	lastjob.JobPages = fields.get("pykotaPages", [""])[0]
[2455]	612	try :
	613	lastjob.PrecomputedJobSize = int(fields.get("pykotaPrecomputedJobSize", [0])[0])
	614	except ValueError :
	615	lastjob.PrecomputedJobSize = None
	616	try :
	617	lastjob.PrecomputedJobPrice = float(fields.get("pykotaPrecomputedJobPrice", [0.0])[0])
	618	except ValueError :
	619	lastjob.PrecomputedJobPrice = None
[2287]	620	if lastjob.JobTitle == lastjob.JobFileName == lastjob.JobOptions == "hidden" :
	621	(lastjob.JobTitle, lastjob.JobFileName, lastjob.JobOptions) = (_("Hidden because of privacy concerns"),) * 3
[2538]	622	date = fields.get("createTimestamp", ["19700101000000Z"])[0] # It's in UTC !
	623	mxtime = DateTime.strptime(date[:14], "%Y%m%d%H%M%S").localtime()
	624	lastjob.JobDate = mxtime.strftime("%Y%m%d %H:%M:%S")
[1041]	625	lastjob.Exists = 1
	626	return lastjob
[1016]	627
[1137]	628	def getGroupMembersFromBackend(self, group) :
	629	"""Returns the group's members list."""
	630	groupmembers = []
[2652]	631	gname = self.userCharsetToDatabase(group.Name)
	632	result = self.doSearch("(&(objectClass=pykotaGroup)(\|(pykotaGroupName=%s)(%s=%s)))" % \
	633	(gname, self.info["grouprdn"], gname), \
	634	[self.info["groupmembers"]], \
	635	base=self.info["groupbase"])
[1137]	636	if result :
	637	for username in result[0][1].get(self.info["groupmembers"], []) :
[2652]	638	groupmembers.append(self.getUser(self.databaseToUserCharset(username)))
[1137]	639	return groupmembers
	640
	641	def getUserGroupsFromBackend(self, user) :
[1130]	642	"""Returns the user's groups list."""
	643	groups = []
[2652]	644	uname = self.userCharsetToDatabase(user.Name)
	645	result = self.doSearch("(&(objectClass=pykotaGroup)(%s=%s))" % \
	646	(self.info["groupmembers"], uname), \
	647	[self.info["grouprdn"], "pykotaGroupName", "pykotaLimitBy"], \
	648	base=self.info["groupbase"])
[1130]	649	if result :
	650	for (groupid, fields) in result :
[2652]	651	groupname = self.databaseToUserCharset((fields.get("pykotaGroupName", [None]) or fields.get(self.info["grouprdn"], [None]))[0])
[1147]	652	group = self.getFromCache("GROUPS", groupname)
	653	if group is None :
	654	group = StorageGroup(self, groupname)
	655	group.ident = groupid
	656	group.LimitBy = fields.get("pykotaLimitBy")
	657	if group.LimitBy is not None :
	658	group.LimitBy = group.LimitBy[0]
[2000]	659	else :
	660	group.LimitBy = "quota"
[1147]	661	group.AccountBalance = 0.0
	662	group.LifeTimePaid = 0.0
	663	for member in self.getGroupMembers(group) :
	664	if member.Exists :
	665	group.AccountBalance += member.AccountBalance
	666	group.LifeTimePaid += member.LifeTimePaid
	667	group.Exists = 1
	668	self.cacheEntry("GROUPS", group.Name, group)
	669	groups.append(group)
[1130]	670	return groups
	671
[1249]	672	def getParentPrintersFromBackend(self, printer) :
	673	"""Get all the printer groups this printer is a member of."""
	674	pgroups = []
[2652]	675	result = self.doSearch("(&(objectClass=pykotaPrinter)(uniqueMember=%s))" % \
	676	printer.ident, \
	677	["pykotaPrinterName"], \
	678	base=self.info["printerbase"])
[1249]	679	if result :
	680	for (printerid, fields) in result :
	681	if printerid != printer.ident : # In case of integrity violation.
[2652]	682	parentprinter = self.getPrinter(self.databaseToUserCharset(fields.get("pykotaPrinterName")[0]))
[1249]	683	if parentprinter.Exists :
	684	pgroups.append(parentprinter)
	685	return pgroups
	686
[1041]	687	def getMatchingPrinters(self, printerpattern) :
	688	"""Returns the list of all printers for which name matches a certain pattern."""
	689	printers = []
	690	# see comment at the same place in pgstorage.py
[2657]	691	result = self.doSearch("objectClass=pykotaPrinter", \
[2652]	692	["pykotaPrinterName", "pykotaPricePerPage", "pykotaPricePerJob", "pykotaMaxJobSize", "pykotaPassThrough", "uniqueMember", "description"], \
	693	base=self.info["printerbase"])
[1016]	694	if result :
[2657]	695	patterns = printerpattern.split(",")
[2754]	696	try :
	697	patdict = {}.fromkeys(patterns)
	698	except AttributeError :
	699	# Python v2.2 or earlier
	700	patdict = {}
	701	for p in patterns :
	702	patdict[p] = None
[1041]	703	for (printerid, fields) in result :
[2652]	704	printername = self.databaseToUserCharset(fields.get("pykotaPrinterName", [""])[0] or fields.get(self.info["printerrdn"], [""])[0])
[2754]	705	if patdict.has_key(printername) or self.tool.matchString(printername, patterns) :
[2657]	706	printer = StoragePrinter(self, printername)
	707	printer.ident = printerid
	708	printer.PricePerJob = float(fields.get("pykotaPricePerJob", [0.0])[0] or 0.0)
	709	printer.PricePerPage = float(fields.get("pykotaPricePerPage", [0.0])[0] or 0.0)
	710	printer.MaxJobSize = int(fields.get("pykotaMaxJobSize", [0])[0])
	711	printer.PassThrough = fields.get("pykotaPassThrough", [None])[0]
	712	if printer.PassThrough in (1, "1", "t", "true", "TRUE", "True") :
	713	printer.PassThrough = 1
	714	else :
	715	printer.PassThrough = 0
	716	printer.uniqueMember = fields.get("uniqueMember", [])
	717	printer.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
	718	printer.Exists = 1
	719	printers.append(printer)
	720	self.cacheEntry("PRINTERS", printer.Name, printer)
[1041]	721	return printers
[1016]	722
[2657]	723	def getMatchingUsers(self, userpattern) :
	724	"""Returns the list of all users for which name matches a certain pattern."""
	725	users = []
	726	# see comment at the same place in pgstorage.py
	727	result = self.doSearch("objectClass=pykotaAccount", \
[2721]	728	["pykotaUserName", "pykotaLimitBy", self.info["usermail"], "pykotaOverCharge", "description"], \
[2657]	729	base=self.info["userbase"])
	730	if result :
	731	patterns = userpattern.split(",")
[2754]	732	try :
	733	patdict = {}.fromkeys(patterns)
	734	except AttributeError :
	735	# Python v2.2 or earlier
	736	patdict = {}
	737	for p in patterns :
	738	patdict[p] = None
[2657]	739	for (userid, fields) in result :
	740	username = self.databaseToUserCharset(fields.get("pykotaUserName", [""])[0] or fields.get(self.info["userrdn"], [""])[0])
[2754]	741	if patdict.has_key(username) or self.tool.matchString(username, patterns) :
[2657]	742	user = StorageUser(self, username)
	743	user.ident = userid
	744	user.Email = fields.get(self.info["usermail"], [None])[0]
	745	user.LimitBy = fields.get("pykotaLimitBy", ["quota"])[0]
	746	user.OverCharge = float(fields.get("pykotaOverCharge", [1.0])[0])
[2721]	747	user.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
[2657]	748	uname = self.userCharsetToDatabase(username)
	749	result = self.doSearch("(&(objectClass=pykotaAccountBalance)(\|(pykotaUserName=%s)(%s=%s)))" % \
	750	(uname, self.info["balancerdn"], uname), \
	751	["pykotaBalance", "pykotaLifeTimePaid", "pykotaPayments"], \
	752	base=self.info["balancebase"])
	753	if not result :
	754	raise PyKotaStorageError, _("No pykotaAccountBalance object found for user %s. Did you create LDAP entries manually ?") % username
	755	else :
	756	fields = result[0][1]
	757	user.idbalance = result[0][0]
	758	user.AccountBalance = fields.get("pykotaBalance")
	759	if user.AccountBalance is not None :
	760	if user.AccountBalance[0].upper() == "NONE" :
	761	user.AccountBalance = None
	762	else :
	763	user.AccountBalance = float(user.AccountBalance[0])
	764	user.AccountBalance = user.AccountBalance or 0.0
	765	user.LifeTimePaid = fields.get("pykotaLifeTimePaid")
	766	if user.LifeTimePaid is not None :
	767	if user.LifeTimePaid[0].upper() == "NONE" :
	768	user.LifeTimePaid = None
	769	else :
	770	user.LifeTimePaid = float(user.LifeTimePaid[0])
	771	user.LifeTimePaid = user.LifeTimePaid or 0.0
	772	user.Payments = []
	773	for payment in fields.get("pykotaPayments", []) :
	774	try :
	775	(date, amount, description) = payment.split(" # ")
	776	except ValueError :
	777	# Payment with no description (old Payment)
	778	(date, amount) = payment.split(" # ")
	779	description = ""
	780	else :
	781	description = self.databaseToUserCharset(base64.decodestring(description))
	782	user.Payments.append((date, float(amount), description))
	783	user.Exists = 1
	784	users.append(user)
	785	self.cacheEntry("USERS", user.Name, user)
	786	return users
	787
	788	def getMatchingGroups(self, grouppattern) :
	789	"""Returns the list of all groups for which name matches a certain pattern."""
	790	groups = []
	791	# see comment at the same place in pgstorage.py
	792	result = self.doSearch("objectClass=pykotaGroup", \
[2721]	793	["pykotaGroupName", "pykotaLimitBy", "description"], \
[2657]	794	base=self.info["groupbase"])
	795	if result :
	796	patterns = grouppattern.split(",")
[2754]	797	try :
	798	patdict = {}.fromkeys(patterns)
	799	except AttributeError :
	800	# Python v2.2 or earlier
	801	patdict = {}
	802	for p in patterns :
	803	patdict[p] = None
[2657]	804	for (groupid, fields) in result :
	805	groupname = self.databaseToUserCharset(fields.get("pykotaGroupName", [""])[0] or fields.get(self.info["grouprdn"], [""])[0])
[2754]	806	if patdict.has_key(groupname) or self.tool.matchString(groupname, patterns) :
[2657]	807	group = StorageGroup(self, groupname)
	808	group.ident = groupid
	809	group.Name = fields.get("pykotaGroupName", [self.databaseToUserCharset(groupname)])[0]
	810	group.LimitBy = fields.get("pykotaLimitBy", ["quota"])[0]
[2721]	811	group.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
[2657]	812	group.AccountBalance = 0.0
	813	group.LifeTimePaid = 0.0
	814	for member in self.getGroupMembers(group) :
	815	if member.Exists :
	816	group.AccountBalance += member.AccountBalance
	817	group.LifeTimePaid += member.LifeTimePaid
	818	group.Exists = 1
[2752]	819	groups.append(group)
	820	self.cacheEntry("GROUPS", group.Name, group)
[2657]	821	return groups
	822
[1133]	823	def getPrinterUsersAndQuotas(self, printer, names=["*"]) :
[1041]	824	"""Returns the list of users who uses a given printer, along with their quotas."""
	825	usersandquotas = []
[2652]	826	pname = self.userCharsetToDatabase(printer.Name)
	827	names = [self.userCharsetToDatabase(n) for n in names]
[1998]	828	if self.info["userquotabase"].lower() == "user" :
	829	base = self.info["userbase"]
	830	else :
	831	base = self.info["userquotabase"]
[2652]	832	result = self.doSearch("(&(objectClass=pykotaUserPQuota)(pykotaPrinterName=%s)(\|%s))" % \
	833	(pname, "".join(["(pykotaUserName=%s)" % uname for uname in names])), \
	834	["pykotaUserName", "pykotaPageCounter", "pykotaLifePageCounter", "pykotaSoftLimit", "pykotaHardLimit", "pykotaDateLimit", "pykotaWarnCount"], \
	835	base=base)
[1041]	836	if result :
	837	for (userquotaid, fields) in result :
[2652]	838	user = self.getUser(self.databaseToUserCharset(fields.get("pykotaUserName")[0]))
[1133]	839	userpquota = StorageUserPQuota(self, user, printer)
	840	userpquota.ident = userquotaid
[2054]	841	userpquota.PageCounter = int(fields.get("pykotaPageCounter", [0])[0])
	842	userpquota.LifePageCounter = int(fields.get("pykotaLifePageCounter", [0])[0])
	843	userpquota.WarnCount = int(fields.get("pykotaWarnCount", [0])[0])
[1133]	844	userpquota.SoftLimit = fields.get("pykotaSoftLimit")
	845	if userpquota.SoftLimit is not None :
	846	if userpquota.SoftLimit[0].upper() == "NONE" :
	847	userpquota.SoftLimit = None
	848	else :
	849	userpquota.SoftLimit = int(userpquota.SoftLimit[0])
	850	userpquota.HardLimit = fields.get("pykotaHardLimit")
	851	if userpquota.HardLimit is not None :
	852	if userpquota.HardLimit[0].upper() == "NONE" :
	853	userpquota.HardLimit = None
	854	elif userpquota.HardLimit is not None :
	855	userpquota.HardLimit = int(userpquota.HardLimit[0])
	856	userpquota.DateLimit = fields.get("pykotaDateLimit")
	857	if userpquota.DateLimit is not None :
	858	if userpquota.DateLimit[0].upper() == "NONE" :
	859	userpquota.DateLimit = None
	860	else :
	861	userpquota.DateLimit = userpquota.DateLimit[0]
	862	userpquota.Exists = 1
	863	usersandquotas.append((user, userpquota))
	864	self.cacheEntry("USERPQUOTAS", "%s@%s" % (user.Name, printer.Name), userpquota)
[1051]	865	usersandquotas.sort(lambda x, y : cmp(x[0].Name, y[0].Name))
[1041]	866	return usersandquotas
	867
[2726]	868	def getPrintersUsersAndPQuotas(self, pnames = [""], unames=[""]) :
[2722]	869	"""Returns all printers, users and users print quota entries which match a set of names."""
	870	printers = {}
	871	users = {}
	872	upquotas = {}
	873	for printer in self.getMatchingPrinters(",".join(pnames)) :
	874	printers[printer.Name] = printer
	875	for user in self.getMatchingUsers(",".join(unames)) :
	876	users[user.Name] = user
	877	for (p, printer) in printers.items() :
	878	for (u, user) in users.items() :
	879	upqkey = "%s@%s" % (u, p)
	880	upquotas[upqkey] = self.getUserPQuota(user, printer)
	881	return (printers, users, upquotas)
	882
[2726]	883	def getPrintersGroupsAndPQuotas(self, pnames = [""], gnames=[""]) :
[2722]	884	"""Returns all printers, groups and groups print quota entries which match a set of names."""
	885	printers = {}
	886	groups = {}
	887	gpquotas = {}
	888	for printer in self.getMatchingPrinters(",".join(pnames)) :
	889	printers[printer.Name] = printer
	890	for group in self.getMatchingGroups(",".join(gnames)) :
	891	groups[group.Name] = group
	892	for (p, printer) in printers.items() :
	893	for (g, group) in groups.items() :
	894	gpqkey = "%s@%s" % (g, p)
	895	gpquotas[gpqkey] = self.getGroupPQuota(group, printer)
	896	return (printers, groups, gpquotas)
	897
[1133]	898	def getPrinterGroupsAndQuotas(self, printer, names=["*"]) :
[1041]	899	"""Returns the list of groups which uses a given printer, along with their quotas."""
	900	groupsandquotas = []
[2652]	901	pname = self.userCharsetToDatabase(printer.Name)
	902	names = [self.userCharsetToDatabase(n) for n in names]
[1998]	903	if self.info["groupquotabase"].lower() == "group" :
	904	base = self.info["groupbase"]
	905	else :
	906	base = self.info["groupquotabase"]
[2652]	907	result = self.doSearch("(&(objectClass=pykotaGroupPQuota)(pykotaPrinterName=%s)(\|%s))" % \
	908	(pname, "".join(["(pykotaGroupName=%s)" % gname for gname in names])), \
	909	["pykotaGroupName"], \
	910	base=base)
[1041]	911	if result :
	912	for (groupquotaid, fields) in result :
[2652]	913	group = self.getGroup(self.databaseToUserCharset(fields.get("pykotaGroupName")[0]))
[1133]	914	grouppquota = self.getGroupPQuota(group, printer)
	915	groupsandquotas.append((group, grouppquota))
[1051]	916	groupsandquotas.sort(lambda x, y : cmp(x[0].Name, y[0].Name))
[1041]	917	return groupsandquotas
[1016]	918
	919	def addPrinter(self, printername) :
[1041]	920	"""Adds a printer to the quota storage, returns it."""
[2652]	921	printername = self.userCharsetToDatabase(printername)
[1030]	922	fields = { self.info["printerrdn"] : printername,
	923	"objectClass" : ["pykotaObject", "pykotaPrinter"],
[1041]	924	"cn" : printername,
[1030]	925	"pykotaPrinterName" : printername,
	926	"pykotaPricePerPage" : "0.0",
	927	"pykotaPricePerJob" : "0.0",
[2459]	928	"pykotaMaxJobSize" : "0",
	929	"pykotaPassThrough" : "0",
[1030]	930	}
	931	dn = "%s=%s,%s" % (self.info["printerrdn"], printername, self.info["printerbase"])
[1041]	932	self.doAdd(dn, fields)
	933	return self.getPrinter(printername)
[1016]	934
[1041]	935	def addUser(self, user) :
	936	"""Adds a user to the quota storage, returns it."""
[2652]	937	uname = self.userCharsetToDatabase(user.Name)
[1105]	938	newfields = {
[2652]	939	"pykotaUserName" : uname,
[1742]	940	"pykotaLimitBy" : (user.LimitBy or "quota"),
[2054]	941	"pykotaOverCharge" : str(user.OverCharge),
[2721]	942	"description" : self.userCharsetToDatabase(user.Description or "")
[1105]	943	}
[1742]	944
[1224]	945	if user.Email :
	946	newfields.update({self.info["usermail"]: user.Email})
[1105]	947	mustadd = 1
	948	if self.info["newuser"].lower() != 'below' :
[1510]	949	try :
	950	(where, action) = [s.strip() for s in self.info["newuser"].split(",")]
	951	except ValueError :
	952	(where, action) = (self.info["newuser"].strip(), "fail")
[2652]	953	result = self.doSearch("(&(objectClass=%s)(%s=%s))" % \
	954	(where, self.info["userrdn"], uname), \
	955	None, \
	956	base=self.info["userbase"])
[1105]	957	if result :
	958	(dn, fields) = result[0]
[2188]	959	oc = fields.get("objectClass", fields.get("objectclass", []))
	960	oc.extend(["pykotaAccount", "pykotaAccountBalance"])
[1105]	961	fields.update(newfields)
[1742]	962	fields.update({ "pykotaBalance" : str(user.AccountBalance or 0.0),
	963	"pykotaLifeTimePaid" : str(user.LifeTimePaid or 0.0), })
[1105]	964	self.doModify(dn, fields)
	965	mustadd = 0
[1510]	966	else :
[1534]	967	message = _("Unable to find an existing objectClass %s entry with %s=%s to attach pykotaAccount objectClass") % (where, self.info["userrdn"], user.Name)
[1510]	968	if action.lower() == "warn" :
[2191]	969	self.tool.printInfo(_("%s. A new entry will be created instead.") % message, "warn")
[1510]	970	else : # 'fail' or incorrect setting
	971	raise PyKotaStorageError, "%s. Action aborted. Please check your configuration." % message
[1105]	972
	973	if mustadd :
[1742]	974	if self.info["userbase"] == self.info["balancebase"] :
[2652]	975	fields = { self.info["userrdn"] : uname,
[1742]	976	"objectClass" : ["pykotaObject", "pykotaAccount", "pykotaAccountBalance"],
[2652]	977	"cn" : uname,
[1742]	978	"pykotaBalance" : str(user.AccountBalance or 0.0),
	979	"pykotaLifeTimePaid" : str(user.LifeTimePaid or 0.0),
	980	}
	981	else :
[2652]	982	fields = { self.info["userrdn"] : uname,
[1742]	983	"objectClass" : ["pykotaObject", "pykotaAccount"],
[2652]	984	"cn" : uname,
[1742]	985	}
[1105]	986	fields.update(newfields)
[2652]	987	dn = "%s=%s,%s" % (self.info["userrdn"], uname, self.info["userbase"])
[1105]	988	self.doAdd(dn, fields)
[1742]	989	if self.info["userbase"] != self.info["balancebase"] :
[2652]	990	fields = { self.info["balancerdn"] : uname,
[1742]	991	"objectClass" : ["pykotaObject", "pykotaAccountBalance"],
[2652]	992	"cn" : uname,
[1742]	993	"pykotaBalance" : str(user.AccountBalance or 0.0),
	994	"pykotaLifeTimePaid" : str(user.LifeTimePaid or 0.0),
	995	}
[2652]	996	dn = "%s=%s,%s" % (self.info["balancerdn"], uname, self.info["balancebase"])
[1742]	997	self.doAdd(dn, fields)
	998
[1041]	999	return self.getUser(user.Name)
[1016]	1000
[1041]	1001	def addGroup(self, group) :
	1002	"""Adds a group to the quota storage, returns it."""
[2652]	1003	gname = self.userCharsetToDatabase(group.Name)
[1105]	1004	newfields = {
[2652]	1005	"pykotaGroupName" : gname,
[2054]	1006	"pykotaLimitBy" : (group.LimitBy or "quota"),
[2721]	1007	"description" : self.userCharsetToDatabase(group.Description or "")
[1105]	1008	}
	1009	mustadd = 1
	1010	if self.info["newgroup"].lower() != 'below' :
[1510]	1011	try :
	1012	(where, action) = [s.strip() for s in self.info["newgroup"].split(",")]
	1013	except ValueError :
	1014	(where, action) = (self.info["newgroup"].strip(), "fail")
[2652]	1015	result = self.doSearch("(&(objectClass=%s)(%s=%s))" % \
	1016	(where, self.info["grouprdn"], gname), \
	1017	None, \
	1018	base=self.info["groupbase"])
[1105]	1019	if result :
	1020	(dn, fields) = result[0]
[2188]	1021	oc = fields.get("objectClass", fields.get("objectclass", []))
	1022	oc.extend(["pykotaGroup"])
[1105]	1023	fields.update(newfields)
	1024	self.doModify(dn, fields)
	1025	mustadd = 0
[1510]	1026	else :
	1027	message = _("Unable to find an existing entry to attach pykotaGroup objectclass %s") % group.Name
	1028	if action.lower() == "warn" :
[1584]	1029	self.tool.printInfo("%s. A new entry will be created instead." % message, "warn")
[1510]	1030	else : # 'fail' or incorrect setting
	1031	raise PyKotaStorageError, "%s. Action aborted. Please check your configuration." % message
[1105]	1032
	1033	if mustadd :
[2652]	1034	fields = { self.info["grouprdn"] : gname,
[1105]	1035	"objectClass" : ["pykotaObject", "pykotaGroup"],
[2652]	1036	"cn" : gname,
[1105]	1037	}
	1038	fields.update(newfields)
[2652]	1039	dn = "%s=%s,%s" % (self.info["grouprdn"], gname, self.info["groupbase"])
[1105]	1040	self.doAdd(dn, fields)
[1041]	1041	return self.getGroup(group.Name)
[1016]	1042
[1041]	1043	def addUserToGroup(self, user, group) :
	1044	"""Adds an user to a group."""
[1141]	1045	if user.Name not in [u.Name for u in self.getGroupMembers(group)] :
[1041]	1046	result = self.doSearch("objectClass=pykotaGroup", None, base=group.ident, scope=ldap.SCOPE_BASE)
	1047	if result :
	1048	fields = result[0][1]
[1070]	1049	if not fields.has_key(self.info["groupmembers"]) :
	1050	fields[self.info["groupmembers"]] = []
[2652]	1051	fields[self.info["groupmembers"]].append(self.userCharsetToDatabase(user.Name))
[1041]	1052	self.doModify(group.ident, fields)
	1053	group.Members.append(user)
	1054
[2706]	1055	def delUserFromGroup(self, user, group) :
	1056	"""Removes an user from a group."""
[2753]	1057	if user.Name in [u.Name for u in self.getGroupMembers(group)] :
[2750]	1058	result = self.doSearch("objectClass=pykotaGroup", None, base=group.ident, scope=ldap.SCOPE_BASE)
	1059	if result :
	1060	fields = result[0][1]
	1061	if not fields.has_key(self.info["groupmembers"]) :
	1062	fields[self.info["groupmembers"]] = []
	1063	try :
	1064	fields[self.info["groupmembers"]].remove(self.userCharsetToDatabase(user.Name))
	1065	except ValueError :
	1066	pass # TODO : Strange, shouldn't it be there ?
	1067	else :
	1068	self.doModify(group.ident, fields)
	1069	group.Members.remove(user)
[2706]	1070
[2749]	1071	def addUserPQuota(self, upq) :
[1041]	1072	"""Initializes a user print quota on a printer."""
[2749]	1073	# first check if an entry already exists
	1074	oldentry = self.getUserPQuota(upq.User, upq.Printer)
	1075	if oldentry.Exists :
	1076	return oldentry # we return the existing entry
[1030]	1077	uuid = self.genUUID()
[2749]	1078	uname = self.userCharsetToDatabase(upq.User.Name)
	1079	pname = self.userCharsetToDatabase(upq.Printer.Name)
[1041]	1080	fields = { "cn" : uuid,
	1081	"objectClass" : ["pykotaObject", "pykotaUserPQuota"],
[2652]	1082	"pykotaUserName" : uname,
	1083	"pykotaPrinterName" : pname,
[2749]	1084	"pykotaSoftLimit" : str(upq.SoftLimit),
	1085	"pykotaHardLimit" : str(upq.HardLimit),
	1086	"pykotaDateLimit" : str(upq.DateLimit),
	1087	"pykotaPageCounter" : str(upq.PageCounter or 0),
	1088	"pykotaLifePageCounter" : str(upq.LifePageCounter or 0),
	1089	"pykotaWarnCount" : str(upq.WarnCount or 0),
	1090	"pykotaMaxJobSize" : str(upq.MaxJobSize or 0),
[1030]	1091	}
[1969]	1092	if self.info["userquotabase"].lower() == "user" :
[2749]	1093	dn = "cn=%s,%s" % (uuid, upq.User.ident)
[1969]	1094	else :
	1095	dn = "cn=%s,%s" % (uuid, self.info["userquotabase"])
[1031]	1096	self.doAdd(dn, fields)
[2749]	1097	upq.isDirty = False
	1098	return None # the entry created doesn't need further modification
[1016]	1099
[2749]	1100	def addGroupPQuota(self, gpq) :
[1041]	1101	"""Initializes a group print quota on a printer."""
[2749]	1102	oldentry = self.getGroupPQuota(gpq.Group, gpq.Printer)
	1103	if oldentry.Exists :
	1104	return oldentry # we return the existing entry
[1030]	1105	uuid = self.genUUID()
[2749]	1106	gname = self.userCharsetToDatabase(gpq.Group.Name)
	1107	pname = self.userCharsetToDatabase(gpq.Printer.Name)
[1041]	1108	fields = { "cn" : uuid,
	1109	"objectClass" : ["pykotaObject", "pykotaGroupPQuota"],
[2652]	1110	"pykotaGroupName" : gname,
	1111	"pykotaPrinterName" : pname,
[1030]	1112	"pykotaDateLimit" : "None",
	1113	}
[1969]	1114	if self.info["groupquotabase"].lower() == "group" :
[2749]	1115	dn = "cn=%s,%s" % (uuid, gpq.Group.ident)
[1969]	1116	else :
	1117	dn = "cn=%s,%s" % (uuid, self.info["groupquotabase"])
[1031]	1118	self.doAdd(dn, fields)
[2749]	1119	gpq.isDirty = False
	1120	return None # the entry created doesn't need further modification
[1016]	1121
[2686]	1122	def savePrinter(self, printer) :
	1123	"""Saves the printer to the database in a single operation."""
[1041]	1124	fields = {
[2686]	1125	"pykotaPassThrough" : (printer.PassThrough and "t") or "f",
	1126	"pykotaMaxJobSize" : (printer.MaxJobSize and str(printer.MaxJobSize)) or "0",
	1127	"description" : self.userCharsetToDatabase(printer.Description or ""),
[1041]	1128	"pykotaPricePerPage" : str(printer.PricePerPage),
	1129	"pykotaPricePerJob" : str(printer.PricePerJob),
	1130	}
	1131	self.doModify(printer.ident, fields)
[1016]	1132
[2706]	1133	def saveUser(self, user) :
	1134	"""Saves the user to the database in a single operation."""
	1135	newfields = {
	1136	"pykotaLimitBy" : (user.LimitBy or "quota"),
	1137	"pykotaOverCharge" : str(user.OverCharge),
[2721]	1138	"description" : self.userCharsetToDatabase(user.Description or ""),
[2706]	1139	}
	1140	if user.Email :
	1141	newfields.update({self.info["usermail"]: user.Email})
	1142	self.doModify(user.ident, newfields)
[2054]	1143
[2707]	1144	newfields = { "pykotaBalance" : str(user.AccountBalance or 0.0),
	1145	"pykotaLifeTimePaid" : str(user.LifeTimePaid or 0.0),
	1146	}
	1147	self.doModify(user.idbalance, newfields)
	1148
[2706]	1149	def saveGroup(self, group) :
	1150	"""Saves the group to the database in a single operation."""
	1151	newfields = {
	1152	"pykotaLimitBy" : (group.LimitBy or "quota"),
[2721]	1153	"description" : self.userCharsetToDatabase(group.Description or ""),
[2706]	1154	}
	1155	self.doModify(group.ident, newfields)
[1016]	1156
[1041]	1157	def writeUserPQuotaDateLimit(self, userpquota, datelimit) :
	1158	"""Sets the date limit permanently for a user print quota."""
[1031]	1159	fields = {
[1240]	1160	"pykotaDateLimit" : datelimit,
[1031]	1161	}
[1041]	1162	return self.doModify(userpquota.ident, fields)
	1163
	1164	def writeGroupPQuotaDateLimit(self, grouppquota, datelimit) :
	1165	"""Sets the date limit permanently for a group print quota."""
[1031]	1166	fields = {
[1240]	1167	"pykotaDateLimit" : datelimit,
[1031]	1168	}
[1041]	1169	return self.doModify(grouppquota.ident, fields)
[1016]	1170
[1269]	1171	def increaseUserPQuotaPagesCounters(self, userpquota, nbpages) :
	1172	"""Increase page counters for a user print quota."""
	1173	fields = {
	1174	"pykotaPageCounter" : { "operator" : "+", "value" : nbpages, "convert" : int },
	1175	"pykotaLifePageCounter" : { "operator" : "+", "value" : nbpages, "convert" : int },
	1176	}
	1177	return self.doModify(userpquota.ident, fields)
	1178
	1179	def decreaseUserAccountBalance(self, user, amount) :
	1180	"""Decreases user's account balance from an amount."""
	1181	fields = {
	1182	"pykotaBalance" : { "operator" : "-", "value" : amount, "convert" : float },
	1183	}
[1356]	1184	return self.doModify(user.idbalance, fields, flushcache=1)
[1269]	1185
[2452]	1186	def writeNewPayment(self, user, amount, comment="") :
[1522]	1187	"""Adds a new payment to the payments history."""
	1188	payments = []
	1189	for payment in user.Payments :
[2461]	1190	payments.append("%s # %s # %s" % (payment[0], str(payment[1]), base64.encodestring(self.userCharsetToDatabase(payment[2])).strip()))
[2460]	1191	payments.append("%s # %s # %s" % (str(DateTime.now()), str(amount), base64.encodestring(self.userCharsetToDatabase(comment)).strip()))
[1522]	1192	fields = {
	1193	"pykotaPayments" : payments,
	1194	}
	1195	return self.doModify(user.idbalance, fields)
	1196
[1203]	1197	def writeLastJobSize(self, lastjob, jobsize, jobprice) :
[1041]	1198	"""Sets the last job's size permanently."""
	1199	fields = {
	1200	"pykotaJobSize" : str(jobsize),
[1203]	1201	"pykotaJobPrice" : str(jobprice),
[1041]	1202	}
	1203	self.doModify(lastjob.ident, fields)
	1204
[2455]	1205	def writeJobNew(self, printer, user, jobid, pagecounter, action, jobsize=None, jobprice=None, filename=None, title=None, copies=None, options=None, clienthost=None, jobsizebytes=None, jobmd5sum=None, jobpages=None, jobbilling=None, precomputedsize=None, precomputedprice=None) :
[1041]	1206	"""Adds a job in a printer's history."""
[2652]	1207	uname = self.userCharsetToDatabase(user.Name)
	1208	pname = self.userCharsetToDatabase(printer.Name)
[1149]	1209	if (not self.disablehistory) or (not printer.LastJob.Exists) :
	1210	uuid = self.genUUID()
	1211	dn = "cn=%s,%s" % (uuid, self.info["jobbase"])
	1212	else :
	1213	uuid = printer.LastJob.ident[3:].split(",")[0]
	1214	dn = printer.LastJob.ident
[1875]	1215	if self.privacy :
	1216	# For legal reasons, we want to hide the title, filename and options
[2287]	1217	title = filename = options = "hidden"
[1032]	1218	fields = {
	1219	"objectClass" : ["pykotaObject", "pykotaJob"],
	1220	"cn" : uuid,
[2652]	1221	"pykotaUserName" : uname,
	1222	"pykotaPrinterName" : pname,
[1032]	1223	"pykotaJobId" : jobid,
	1224	"pykotaPrinterPageCounter" : str(pagecounter),
	1225	"pykotaAction" : action,
[1790]	1226	"pykotaFileName" : ((filename is None) and "None") or self.userCharsetToDatabase(filename),
	1227	"pykotaTitle" : ((title is None) and "None") or self.userCharsetToDatabase(title),
[1200]	1228	"pykotaCopies" : str(copies),
[1790]	1229	"pykotaOptions" : ((options is None) and "None") or self.userCharsetToDatabase(options),
[1502]	1230	"pykotaHostName" : str(clienthost),
[1520]	1231	"pykotaJobSizeBytes" : str(jobsizebytes),
[2057]	1232	"pykotaMD5Sum" : str(jobmd5sum),
[2217]	1233	"pykotaPages" : jobpages, # don't add this attribute if it is not set, so no string conversion
	1234	"pykotaBillingCode" : self.userCharsetToDatabase(jobbilling), # don't add this attribute if it is not set, so no string conversion
[2455]	1235	"pykotaPrecomputedJobSize" : str(precomputedsize),
[2456]	1236	"pykotaPrecomputedJobPrice" : str(precomputedprice),
[1032]	1237	}
[1149]	1238	if (not self.disablehistory) or (not printer.LastJob.Exists) :
	1239	if jobsize is not None :
[1203]	1240	fields.update({ "pykotaJobSize" : str(jobsize), "pykotaJobPrice" : str(jobprice) })
[1149]	1241	self.doAdd(dn, fields)
	1242	else :
	1243	# here we explicitly want to reset jobsize to 'None' if needed
[1203]	1244	fields.update({ "pykotaJobSize" : str(jobsize), "pykotaJobPrice" : str(jobprice) })
[1149]	1245	self.doModify(dn, fields)
	1246
[1041]	1247	if printer.LastJob.Exists :
[1032]	1248	fields = {
	1249	"pykotaLastJobIdent" : uuid,
	1250	}
[1041]	1251	self.doModify(printer.LastJob.lastjobident, fields)
[1032]	1252	else :
	1253	lastjuuid = self.genUUID()
[1067]	1254	lastjdn = "cn=%s,%s" % (lastjuuid, self.info["lastjobbase"])
[1032]	1255	fields = {
	1256	"objectClass" : ["pykotaObject", "pykotaLastJob"],
	1257	"cn" : lastjuuid,
[2652]	1258	"pykotaPrinterName" : pname,
[1032]	1259	"pykotaLastJobIdent" : uuid,
	1260	}
	1261	self.doAdd(lastjdn, fields)
[1041]	1262
[2735]	1263	def saveUserPQuota(self, userpquota) :
	1264	"""Saves an user print quota entry."""
[1041]	1265	fields = {
[2735]	1266	"pykotaSoftLimit" : str(userpquota.SoftLimit),
	1267	"pykotaHardLimit" : str(userpquota.HardLimit),
	1268	"pykotaDateLimit" : str(userpquota.DateLimit),
[2749]	1269	"pykotaWarnCount" : str(userpquota.WarnCount or 0),
	1270	"pykotaPageCounter" : str(userpquota.PageCounter or 0),
	1271	"pykotaLifePageCounter" : str(userpquota.LifePageCounter or 0),
	1272	"pykotaMaxJobSize" : str(userpquota.MaxJobSize or 0),
[1041]	1273	}
	1274	self.doModify(userpquota.ident, fields)
	1275
[2054]	1276	def writeUserPQuotaWarnCount(self, userpquota, warncount) :
	1277	"""Sets the warn counter value for a user quota."""
	1278	fields = {
	1279	"pykotaWarnCount" : str(warncount or 0),
	1280	}
	1281	self.doModify(userpquota.ident, fields)
	1282
	1283	def increaseUserPQuotaWarnCount(self, userpquota) :
	1284	"""Increases the warn counter value for a user quota."""
	1285	fields = {
	1286	"pykotaWarnCount" : { "operator" : "+", "value" : 1, "convert" : int },
	1287	}
	1288	return self.doModify(userpquota.ident, fields)
	1289
[2735]	1290	def saveGroupPQuota(self, grouppquota) :
	1291	"""Saves a group print quota entry."""
[1041]	1292	fields = {
[2735]	1293	"pykotaSoftLimit" : str(grouppquota.SoftLimit),
	1294	"pykotaHardLimit" : str(grouppquota.HardLimit),
	1295	"pykotaDateLimit" : str(grouppquota.DateLimit),
[2749]	1296	"pykotaMaxJobSize" : str(userpquota.MaxJobSize or 0),
[1041]	1297	}
	1298	self.doModify(grouppquota.ident, fields)
	1299
[1258]	1300	def writePrinterToGroup(self, pgroup, printer) :
	1301	"""Puts a printer into a printer group."""
[1259]	1302	if printer.ident not in pgroup.uniqueMember :
[1269]	1303	pgroup.uniqueMember.append(printer.ident)
[1258]	1304	fields = {
[1269]	1305	"uniqueMember" : pgroup.uniqueMember
[1258]	1306	}
	1307	self.doModify(pgroup.ident, fields)
[1274]	1308
[1332]	1309	def removePrinterFromGroup(self, pgroup, printer) :
	1310	"""Removes a printer from a printer group."""
	1311	try :
	1312	pgroup.uniqueMember.remove(printer.ident)
	1313	except ValueError :
	1314	pass
	1315	else :
	1316	fields = {
	1317	"uniqueMember" : pgroup.uniqueMember,
	1318	}
	1319	self.doModify(pgroup.ident, fields)
	1320
[2266]	1321	def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, limit=100, start=None, end=None) :
	1322	"""Retrieves all print jobs for user on printer (or all) between start and end date, limited to first 100 results."""
[1274]	1323	precond = "(objectClass=pykotaJob)"
	1324	where = []
[2222]	1325	if user is not None :
[2652]	1326	where.append("(pykotaUserName=%s)" % self.userCharsetToDatabase(user.Name))
[2222]	1327	if printer is not None :
[2652]	1328	where.append("(pykotaPrinterName=%s)" % self.userCharsetToDatabase(printer.Name))
[1502]	1329	if hostname is not None :
	1330	where.append("(pykotaHostName=%s)" % hostname)
[2218]	1331	if billingcode is not None :
	1332	where.append("(pykotaBillingCode=%s)" % self.userCharsetToDatabase(billingcode))
[1274]	1333	if where :
	1334	where = "(&%s)" % "".join([precond] + where)
	1335	else :
	1336	where = precond
	1337	jobs = []
[2211]	1338	result = self.doSearch(where, fields=[ "pykotaJobSizeBytes",
	1339	"pykotaHostName",
	1340	"pykotaUserName",
	1341	"pykotaPrinterName",
	1342	"pykotaJobId",
	1343	"pykotaPrinterPageCounter",
	1344	"pykotaAction",
	1345	"pykotaJobSize",
	1346	"pykotaJobPrice",
	1347	"pykotaFileName",
	1348	"pykotaTitle",
	1349	"pykotaCopies",
	1350	"pykotaOptions",
	1351	"pykotaBillingCode",
	1352	"pykotaPages",
	1353	"pykotaMD5Sum",
[2455]	1354	"pykotaPrecomputedJobSize",
	1355	"pykotaPrecomputedJobPrice",
[2211]	1356	"createTimestamp" ],
	1357	base=self.info["jobbase"])
[1274]	1358	if result :
	1359	for (ident, fields) in result :
	1360	job = StorageJob(self)
	1361	job.ident = ident
	1362	job.JobId = fields.get("pykotaJobId")[0]
[1392]	1363	job.PrinterPageCounter = int(fields.get("pykotaPrinterPageCounter", [0])[0] or 0)
[1601]	1364	try :
	1365	job.JobSize = int(fields.get("pykotaJobSize", [0])[0])
	1366	except ValueError :
	1367	job.JobSize = None
	1368	try :
	1369	job.JobPrice = float(fields.get("pykotaJobPrice", [0.0])[0])
	1370	except ValueError :
	1371	job.JobPrice = None
[1392]	1372	job.JobAction = fields.get("pykotaAction", [""])[0]
[1790]	1373	job.JobFileName = self.databaseToUserCharset(fields.get("pykotaFileName", [""])[0])
	1374	job.JobTitle = self.databaseToUserCharset(fields.get("pykotaTitle", [""])[0])
[1274]	1375	job.JobCopies = int(fields.get("pykotaCopies", [0])[0])
[1790]	1376	job.JobOptions = self.databaseToUserCharset(fields.get("pykotaOptions", [""])[0])
[1502]	1377	job.JobHostName = fields.get("pykotaHostName", [""])[0]
[1520]	1378	job.JobSizeBytes = fields.get("pykotaJobSizeBytes", [0L])[0]
[2217]	1379	job.JobBillingCode = self.databaseToUserCharset(fields.get("pykotaBillingCode", [None])[0])
[2211]	1380	job.JobMD5Sum = fields.get("pykotaMD5Sum", [None])[0]
	1381	job.JobPages = fields.get("pykotaPages", [""])[0]
[2455]	1382	try :
	1383	job.PrecomputedJobSize = int(fields.get("pykotaPrecomputedJobSize", [0])[0])
	1384	except ValueError :
	1385	job.PrecomputedJobSize = None
	1386	try :
	1387	job.PrecomputedJobPrice = float(fields.get("pykotaPrecomputedJobPrice", [0.0])[0])
	1388	except ValueError :
	1389	job.PrecomputedJobPrice = None
[2287]	1390	if job.JobTitle == job.JobFileName == job.JobOptions == "hidden" :
	1391	(job.JobTitle, job.JobFileName, job.JobOptions) = (_("Hidden because of privacy concerns"),) * 3
[2538]	1392	date = fields.get("createTimestamp", ["19700101000000Z"])[0] # It's in UTC !
	1393	mxtime = DateTime.strptime(date[:14], "%Y%m%d%H%M%S").localtime()
	1394	job.JobDate = mxtime.strftime("%Y%m%d %H:%M:%S")
[2266]	1395	if ((start is None) and (end is None)) or \
	1396	((start is None) and (job.JobDate <= end)) or \
	1397	((end is None) and (job.JobDate >= start)) or \
	1398	((job.JobDate >= start) and (job.JobDate <= end)) :
[2652]	1399	job.UserName = self.databaseToUserCharset(fields.get("pykotaUserName")[0])
	1400	job.PrinterName = self.databaseToUserCharset(fields.get("pykotaPrinterName")[0])
[1274]	1401	job.Exists = 1
	1402	jobs.append(job)
[1874]	1403	jobs.sort(lambda x, y : cmp(y.JobDate, x.JobDate))
[1274]	1404	if limit :
	1405	jobs = jobs[:int(limit)]
	1406	return jobs
[1258]	1407
[1041]	1408	def deleteUser(self, user) :
	1409	"""Completely deletes an user from the Quota Storage."""
[2652]	1410	uname = self.userCharsetToDatabase(user.Name)
[1692]	1411	todelete = []
[2652]	1412	result = self.doSearch("(&(objectClass=pykotaJob)(pykotaUserName=%s))" % uname, base=self.info["jobbase"])
[1041]	1413	for (ident, fields) in result :
[1692]	1414	todelete.append(ident)
[1998]	1415	if self.info["userquotabase"].lower() == "user" :
	1416	base = self.info["userbase"]
	1417	else :
	1418	base = self.info["userquotabase"]
[2652]	1419	result = self.doSearch("(&(objectClass=pykotaUserPQuota)(pykotaUserName=%s))" % uname, \
	1420	["pykotaPrinterName", "pykotaUserName"], \
	1421	base=base)
[1041]	1422	for (ident, fields) in result :
[1692]	1423	# ensure the user print quota entry will be deleted
	1424	todelete.append(ident)
	1425
	1426	# if last job of current printer was printed by the user
	1427	# to delete, we also need to delete the printer's last job entry.
[2652]	1428	printer = self.getPrinter(self.databaseToUserCharset(fields["pykotaPrinterName"][0]))
[1692]	1429	if printer.LastJob.UserName == user.Name :
	1430	todelete.append(printer.LastJob.lastjobident)
	1431
	1432	for ident in todelete :
[1041]	1433	self.doDelete(ident)
[1692]	1434
[1041]	1435	result = self.doSearch("objectClass=pykotaAccount", None, base=user.ident, scope=ldap.SCOPE_BASE)
[1032]	1436	if result :
[1041]	1437	fields = result[0][1]
	1438	for k in fields.keys() :
	1439	if k.startswith("pykota") :
	1440	del fields[k]
	1441	elif k.lower() == "objectclass" :
	1442	todelete = []
	1443	for i in range(len(fields[k])) :
	1444	if fields[k][i].startswith("pykota") :
	1445	todelete.append(i)
	1446	todelete.sort()
	1447	todelete.reverse()
	1448	for i in todelete :
	1449	del fields[k][i]
[1119]	1450	if fields.get("objectClass") or fields.get("objectclass") :
[1041]	1451	self.doModify(user.ident, fields, ignoreold=0)
	1452	else :
	1453	self.doDelete(user.ident)
[2652]	1454	result = self.doSearch("(&(objectClass=pykotaAccountBalance)(pykotaUserName=%s))" % \
	1455	uname, \
	1456	["pykotaUserName"], \
	1457	base=self.info["balancebase"])
[1041]	1458	for (ident, fields) in result :
	1459	self.doDelete(ident)
	1460
	1461	def deleteGroup(self, group) :
	1462	"""Completely deletes a group from the Quota Storage."""
[2652]	1463	gname = self.userCharsetToDatabase(group.Name)
[1998]	1464	if self.info["groupquotabase"].lower() == "group" :
	1465	base = self.info["groupbase"]
	1466	else :
	1467	base = self.info["groupquotabase"]
[2652]	1468	result = self.doSearch("(&(objectClass=pykotaGroupPQuota)(pykotaGroupName=%s))" % \
	1469	gname, \
	1470	["pykotaGroupName"], \
	1471	base=base)
[1041]	1472	for (ident, fields) in result :
	1473	self.doDelete(ident)
	1474	result = self.doSearch("objectClass=pykotaGroup", None, base=group.ident, scope=ldap.SCOPE_BASE)
[1016]	1475	if result :
[1027]	1476	fields = result[0][1]
[1041]	1477	for k in fields.keys() :
	1478	if k.startswith("pykota") :
	1479	del fields[k]
	1480	elif k.lower() == "objectclass" :
	1481	todelete = []
	1482	for i in range(len(fields[k])) :
	1483	if fields[k][i].startswith("pykota") :
	1484	todelete.append(i)
	1485	todelete.sort()
	1486	todelete.reverse()
	1487	for i in todelete :
	1488	del fields[k][i]
[1119]	1489	if fields.get("objectClass") or fields.get("objectclass") :
[1041]	1490	self.doModify(group.ident, fields, ignoreold=0)
	1491	else :
	1492	self.doDelete(group.ident)
[1330]	1493
[2749]	1494	def deleteManyUserPQuotas(self, printers, users) :
	1495	"""Deletes many user print quota entries."""
	1496	# TODO : grab all with a single (possibly VERY huge) filter if possible (might depend on the LDAP server !)
	1497	for printer in printers :
	1498	for user in users :
	1499	upq = self.getUserPQuota(user, printer)
	1500	if upq.Exists :
	1501	upq.delete()
	1502
	1503	def deleteManyGroupPQuotas(self, printers, groups) :
	1504	"""Deletes many group print quota entries."""
	1505	# TODO : grab all with a single (possibly VERY huge) filter if possible (might depend on the LDAP server !)
	1506	for printer in printers :
	1507	for group in groups :
	1508	gpq = self.getGroupPQuota(group, printer)
	1509	if gpq.Exists :
	1510	gpq.delete()
	1511
[2717]	1512	def deleteUserPQuota(self, upquota) :
	1513	"""Completely deletes an user print quota entry from the database."""
	1514	uname = self.userCharsetToDatabase(upquota.User.Name)
	1515	pname = self.userCharsetToDatabase(upquota.Printer.Name)
	1516	result = self.doSearch("(&(objectClass=pykotaJob)(pykotaUserName=%s)(pykotaPrinterName=%s))" \
	1517	% (uname, pname), \
	1518	base=self.info["jobbase"])
	1519	for (ident, fields) in result :
	1520	self.doDelete(ident)
[2718]	1521	if upquota.Printer.LastJob.UserName == upquota.User.Name :
	1522	self.doDelete(upquota.Printer.LastJob.lastjobident)
[2717]	1523	self.doDelete(upquota.ident)
	1524
	1525	def deleteGroupPQuota(self, gpquota) :
	1526	"""Completely deletes a group print quota entry from the database."""
	1527	self.doDelete(gpquota.ident)
	1528
[1330]	1529	def deletePrinter(self, printer) :
[2358]	1530	"""Completely deletes a printer from the Quota Storage."""
[2652]	1531	pname = self.userCharsetToDatabase(printer.Name)
	1532	result = self.doSearch("(&(objectClass=pykotaLastJob)(pykotaPrinterName=%s))" % pname, base=self.info["lastjobbase"])
[1330]	1533	for (ident, fields) in result :
	1534	self.doDelete(ident)
[2652]	1535	result = self.doSearch("(&(objectClass=pykotaJob)(pykotaPrinterName=%s))" % pname, base=self.info["jobbase"])
[1330]	1536	for (ident, fields) in result :
	1537	self.doDelete(ident)
[1998]	1538	if self.info["groupquotabase"].lower() == "group" :
	1539	base = self.info["groupbase"]
	1540	else :
	1541	base = self.info["groupquotabase"]
[2652]	1542	result = self.doSearch("(&(objectClass=pykotaGroupPQuota)(pykotaPrinterName=%s))" % pname, base=base)
[1330]	1543	for (ident, fields) in result :
	1544	self.doDelete(ident)
[1998]	1545	if self.info["userquotabase"].lower() == "user" :
	1546	base = self.info["userbase"]
	1547	else :
	1548	base = self.info["userquotabase"]
[2652]	1549	result = self.doSearch("(&(objectClass=pykotaUserPQuota)(pykotaPrinterName=%s))" % pname, base=base)
[1330]	1550	for (ident, fields) in result :
	1551	self.doDelete(ident)
	1552	for parent in self.getParentPrinters(printer) :
[1332]	1553	try :
	1554	parent.uniqueMember.remove(printer.ident)
	1555	except ValueError :
	1556	pass
	1557	else :
	1558	fields = {
	1559	"uniqueMember" : parent.uniqueMember,
	1560	}
	1561	self.doModify(parent.ident, fields)
[1330]	1562	self.doDelete(printer.ident)
[1754]	1563
[2358]	1564	def deleteBillingCode(self, code) :
	1565	"""Deletes a billing code from the Quota Storage (no entries are deleted from the history)"""
	1566	self.doDelete(code.ident)
	1567
[1990]	1568	def extractPrinters(self, extractonly={}) :
[1754]	1569	"""Extracts all printer records."""
[1993]	1570	pname = extractonly.get("printername")
	1571	entries = [p for p in [self.getPrinter(name) for name in self.getAllPrintersNames(pname)] if p.Exists]
[1754]	1572	if entries :
[2459]	1573	result = [ ("dn", "printername", "priceperpage", "priceperjob", "description", "maxjobsize", "passthrough") ]
[1754]	1574	for entry in entries :
[2459]	1575	if entry.PassThrough in (1, "1", "t", "true", "T", "TRUE", "True") :
	1576	passthrough = "t"
	1577	else :
	1578	passthrough = "f"
	1579	result.append((entry.ident, entry.Name, entry.PricePerPage, entry.PricePerJob, entry.Description, entry.MaxJobSize, passthrough))
[1754]	1580	return result
	1581
[1990]	1582	def extractUsers(self, extractonly={}) :
[1754]	1583	"""Extracts all user records."""
[1993]	1584	uname = extractonly.get("username")
	1585	entries = [u for u in [self.getUser(name) for name in self.getAllUsersNames(uname)] if u.Exists]
[1754]	1586	if entries :
[2721]	1587	result = [ ("dn", "username", "balance", "lifetimepaid", "limitby", "email", "description") ]
[1754]	1588	for entry in entries :
[2721]	1589	result.append((entry.ident, entry.Name, entry.AccountBalance, entry.LifeTimePaid, entry.LimitBy, entry.Email, entry.Description))
[1754]	1590	return result
	1591
[2358]	1592	def extractBillingcodes(self, extractonly={}) :
	1593	"""Extracts all billing codes records."""
	1594	billingcode = extractonly.get("billingcode")
	1595	entries = [b for b in [self.getBillingCode(label) for label in self.getAllBillingCodes(billingcode)] if b.Exists]
	1596	if entries :
	1597	result = [ ("dn", "billingcode", "balance", "pagecounter", "description") ]
	1598	for entry in entries :
	1599	result.append((entry.ident, entry.BillingCode, entry.Balance, entry.PageCounter, entry.Description))
	1600	return result
	1601
[1990]	1602	def extractGroups(self, extractonly={}) :
[1754]	1603	"""Extracts all group records."""
[1993]	1604	gname = extractonly.get("groupname")
	1605	entries = [g for g in [self.getGroup(name) for name in self.getAllGroupsNames(gname)] if g.Exists]
[1754]	1606	if entries :
[2721]	1607	result = [ ("dn", "groupname", "limitby", "balance", "lifetimepaid", "description") ]
[1754]	1608	for entry in entries :
[2721]	1609	result.append((entry.ident, entry.Name, entry.LimitBy, entry.AccountBalance, entry.LifeTimePaid, entry.Description))
[1754]	1610	return result
	1611
[1990]	1612	def extractPayments(self, extractonly={}) :
[1754]	1613	"""Extracts all payment records."""
[1993]	1614	uname = extractonly.get("username")
	1615	entries = [u for u in [self.getUser(name) for name in self.getAllUsersNames(uname)] if u.Exists]
[1765]	1616	if entries :
[2452]	1617	result = [ ("username", "amount", "date", "description") ]
[1765]	1618	for entry in entries :
[2452]	1619	for (date, amount, description) in entry.Payments :
	1620	result.append((entry.Name, amount, date, description))
[1765]	1621	return result
[1754]	1622
[1990]	1623	def extractUpquotas(self, extractonly={}) :
[1754]	1624	"""Extracts all userpquota records."""
[1993]	1625	pname = extractonly.get("printername")
	1626	entries = [p for p in [self.getPrinter(name) for name in self.getAllPrintersNames(pname)] if p.Exists]
[1754]	1627	if entries :
[1995]	1628	result = [ ("username", "printername", "dn", "userdn", "printerdn", "lifepagecounter", "pagecounter", "softlimit", "hardlimit", "datelimit") ]
[2040]	1629	uname = extractonly.get("username")
[1764]	1630	for entry in entries :
[2041]	1631	for (user, userpquota) in self.getPrinterUsersAndQuotas(entry, names=[uname or "*"]) :
	1632	result.append((user.Name, entry.Name, userpquota.ident, user.ident, entry.ident, userpquota.LifePageCounter, userpquota.PageCounter, userpquota.SoftLimit, userpquota.HardLimit, userpquota.DateLimit))
[1768]	1633	return result
[1754]	1634
[1990]	1635	def extractGpquotas(self, extractonly={}) :
[1754]	1636	"""Extracts all grouppquota records."""
[1993]	1637	pname = extractonly.get("printername")
	1638	entries = [p for p in [self.getPrinter(name) for name in self.getAllPrintersNames(pname)] if p.Exists]
[1754]	1639	if entries :
[1995]	1640	result = [ ("groupname", "printername", "dn", "groupdn", "printerdn", "lifepagecounter", "pagecounter", "softlimit", "hardlimit", "datelimit") ]
[1993]	1641	gname = extractonly.get("groupname")
[1764]	1642	for entry in entries :
[2042]	1643	for (group, grouppquota) in self.getPrinterGroupsAndQuotas(entry, names=[gname or "*"]) :
	1644	result.append((group.Name, entry.Name, grouppquota.ident, group.ident, entry.ident, grouppquota.LifePageCounter, grouppquota.PageCounter, grouppquota.SoftLimit, grouppquota.HardLimit, grouppquota.DateLimit))
[1768]	1645	return result
[1754]	1646
[1990]	1647	def extractUmembers(self, extractonly={}) :
[1754]	1648	"""Extracts all user groups members."""
[1993]	1649	gname = extractonly.get("groupname")
	1650	entries = [g for g in [self.getGroup(name) for name in self.getAllGroupsNames(gname)] if g.Exists]
[1754]	1651	if entries :
[1995]	1652	result = [ ("groupname", "username", "groupdn", "userdn") ]
[1993]	1653	uname = extractonly.get("username")
[1754]	1654	for entry in entries :
	1655	for member in entry.Members :
[1993]	1656	if (uname is None) or (member.Name == uname) :
	1657	result.append((entry.Name, member.Name, entry.ident, member.ident))
[1754]	1658	return result
	1659
[1990]	1660	def extractPmembers(self, extractonly={}) :
[1754]	1661	"""Extracts all printer groups members."""
[1993]	1662	pname = extractonly.get("printername")
	1663	entries = [p for p in [self.getPrinter(name) for name in self.getAllPrintersNames(pname)] if p.Exists]
[1754]	1664	if entries :
[1995]	1665	result = [ ("pgroupname", "printername", "pgroupdn", "printerdn") ]
[1993]	1666	pgname = extractonly.get("pgroupname")
[1754]	1667	for entry in entries :
	1668	for parent in self.getParentPrinters(entry) :
[1993]	1669	if (pgname is None) or (parent.Name == pgname) :
	1670	result.append((parent.Name, entry.Name, parent.ident, entry.ident))
[1754]	1671	return result
	1672
[1990]	1673	def extractHistory(self, extractonly={}) :
[1754]	1674	"""Extracts all jobhistory records."""
[1993]	1675	uname = extractonly.get("username")
	1676	if uname :
	1677	user = self.getUser(uname)
	1678	else :
	1679	user = None
	1680	pname = extractonly.get("printername")
	1681	if pname :
	1682	printer = self.getPrinter(pname)
	1683	else :
	1684	printer = None
[2266]	1685	startdate = extractonly.get("start")
	1686	enddate = extractonly.get("end")
	1687	(startdate, enddate) = self.cleanDates(startdate, enddate)
	1688	entries = self.retrieveHistory(user, printer, hostname=extractonly.get("hostname"), billingcode=extractonly.get("billingcode"), limit=None, start=startdate, end=enddate)
[1754]	1689	if entries :
[2455]	1690	result = [ ("username", "printername", "dn", "jobid", "pagecounter", "jobsize", "action", "jobdate", "filename", "title", "copies", "options", "jobprice", "hostname", "jobsizebytes", "md5sum", "pages", "billingcode", "precomputedjobsize", "precomputedjobprice") ]
[1754]	1691	for entry in entries :
[2455]	1692	result.append((entry.UserName, entry.PrinterName, entry.ident, entry.JobId, entry.PrinterPageCounter, entry.JobSize, entry.JobAction, entry.JobDate, entry.JobFileName, entry.JobTitle, entry.JobCopies, entry.JobOptions, entry.JobPrice, entry.JobHostName, entry.JobSizeBytes, entry.JobMD5Sum, entry.JobPages, entry.JobBillingCode, entry.PrecomputedJobSize, entry.PrecomputedJobPrice))
[2358]	1693	return result
	1694
[2372]	1695	def getBillingCodeFromBackend(self, label) :
	1696	"""Extracts billing code information given its label : returns first matching billing code."""
	1697	code = StorageBillingCode(self, label)
[2375]	1698	ulabel = self.userCharsetToDatabase(label)
[2652]	1699	result = self.doSearch("(&(objectClass=pykotaBilling)(pykotaBillingCode=%s))" % \
	1700	ulabel, \
	1701	["pykotaBillingCode", "pykotaBalance", "pykotaPageCounter", "description"], \
	1702	base=self.info["billingcodebase"])
[2372]	1703	if result :
	1704	fields = result[0][1] # take only first matching code, ignore the rest
	1705	code.ident = result[0][0]
[2375]	1706	code.BillingCode = self.databaseToUserCharset(fields.get("pykotaBillingCode", [ulabel])[0])
[2372]	1707	code.PageCounter = int(fields.get("pykotaPageCounter", [0])[0])
	1708	code.Balance = float(fields.get("pykotaBalance", [0.0])[0])
	1709	code.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
	1710	code.Exists = 1
	1711	return code
[2375]	1712
	1713	def addBillingCode(self, label) :
	1714	"""Adds a billing code to the quota storage, returns it."""
	1715	uuid = self.genUUID()
	1716	dn = "cn=%s,%s" % (uuid, self.info["billingcodebase"])
	1717	fields = { "objectClass" : ["pykotaObject", "pykotaBilling"],
	1718	"cn" : uuid,
	1719	"pykotaBillingCode" : self.userCharsetToDatabase(label),
	1720	"pykotaPageCounter" : "0",
	1721	"pykotaBalance" : "0.0",
	1722	}
	1723	self.doAdd(dn, fields)
	1724	return self.getBillingCode(label)
	1725
[2676]	1726	def saveBillingCode(self, code) :
[2375]	1727	"""Sets the new description for a billing code."""
	1728	fields = {
	1729	"description" : self.userCharsetToDatabase(code.Description or ""),
[2676]	1730	"pykotaPageCounter" : str(code.PageCounter),
	1731	"pykotaBalance" : str(code.Balance),
[2375]	1732	}
[2676]	1733	self.doModify(code.ident, fields)
[2358]	1734
[2380]	1735	def getMatchingBillingCodes(self, billingcodepattern) :
	1736	"""Returns the list of all billing codes which match a certain pattern."""
	1737	codes = []
[2657]	1738	result = self.doSearch("objectClass=pykotaBilling", \
[2380]	1739	["pykotaBillingCode", "description", "pykotaPageCounter", "pykotaBalance"], \
	1740	base=self.info["billingcodebase"])
	1741	if result :
[2657]	1742	patterns = billingcodepattern.split(",")
[2380]	1743	for (codeid, fields) in result :
[2678]	1744	codename = self.databaseToUserCharset(fields.get("pykotaBillingCode", [""])[0])
	1745	if self.tool.matchString(codename, patterns) :
[2657]	1746	code = StorageBillingCode(self, codename)
	1747	code.ident = codeid
	1748	code.PageCounter = int(fields.get("pykotaPageCounter", [0])[0])
	1749	code.Balance = float(fields.get("pykotaBalance", [0.0])[0])
	1750	code.Description = self.databaseToUserCharset(fields.get("description", [""])[0])
	1751	code.Exists = 1
	1752	codes.append(code)
	1753	self.cacheEntry("BILLINGCODES", code.BillingCode, code)
[2380]	1754	return codes
	1755
[2388]	1756	def consumeBillingCode(self, code, pagecounter, balance) :
[2384]	1757	"""Consumes from a billing code."""
	1758	fields = {
	1759	"pykotaBalance" : { "operator" : "-", "value" : balance, "convert" : float },
	1760	"pykotaPageCounter" : { "operator" : "+", "value" : pagecounter, "convert" : int },
	1761	}
	1762	return self.doModify(code.ident, fields)

Note: See TracBrowser for help on using the browser.

Context Navigation

root / pykota / trunk / pykota / storages / ldapstorage.py @ 2754

Download in other formats: