| 1 | # PyKota |
|---|
| 2 | # -*- coding: ISO-8859-15 -*- |
|---|
| 3 | # |
|---|
| 4 | # PyKota : Print Quotas for CUPS and LPRng |
|---|
| 5 | # |
|---|
| 6 | # (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com> |
|---|
| 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 |
|---|
| 19 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
|---|
| 20 | # |
|---|
| 21 | # $Id$ |
|---|
| 22 | # |
|---|
| 23 | # |
|---|
| 24 | |
|---|
| 25 | from pykota.storage import PyKotaStorageError, BaseStorage, StorageObject, \ |
|---|
| 26 | StorageUser, StorageGroup, StoragePrinter, \ |
|---|
| 27 | StorageJob, StorageLastJob, StorageUserPQuota, \ |
|---|
| 28 | StorageGroupPQuota, StorageBillingCode |
|---|
| 29 | |
|---|
| 30 | class SQLStorage : |
|---|
| 31 | def createFilter(self, only) : |
|---|
| 32 | """Returns the appropriate SQL filter.""" |
|---|
| 33 | if only : |
|---|
| 34 | expressions = [] |
|---|
| 35 | for (k, v) in only.items() : |
|---|
| 36 | expressions.append("%s=%s" % (k, self.doQuote(self.userCharsetToDatabase(v)))) |
|---|
| 37 | return " AND ".join(expressions) |
|---|
| 38 | return "" |
|---|
| 39 | |
|---|
| 40 | def extractPrinters(self, extractonly={}) : |
|---|
| 41 | """Extracts all printer records.""" |
|---|
| 42 | thefilter = self.createFilter(extractonly) |
|---|
| 43 | if thefilter : |
|---|
| 44 | thefilter = "WHERE %s" % thefilter |
|---|
| 45 | result = self.doRawSearch("SELECT * FROM printers %s ORDER BY id ASC" % thefilter) |
|---|
| 46 | return self.prepareRawResult(result) |
|---|
| 47 | |
|---|
| 48 | def extractUsers(self, extractonly={}) : |
|---|
| 49 | """Extracts all user records.""" |
|---|
| 50 | thefilter = self.createFilter(extractonly) |
|---|
| 51 | if thefilter : |
|---|
| 52 | thefilter = "WHERE %s" % thefilter |
|---|
| 53 | result = self.doRawSearch("SELECT * FROM users %s ORDER BY id ASC" % thefilter) |
|---|
| 54 | return self.prepareRawResult(result) |
|---|
| 55 | |
|---|
| 56 | def extractBillingcodes(self, extractonly={}) : |
|---|
| 57 | """Extracts all billing codes records.""" |
|---|
| 58 | thefilter = self.createFilter(extractonly) |
|---|
| 59 | if thefilter : |
|---|
| 60 | thefilter = "WHERE %s" % thefilter |
|---|
| 61 | result = self.doRawSearch("SELECT * FROM billingcodes %s ORDER BY id ASC" % thefilter) |
|---|
| 62 | return self.prepareRawResult(result) |
|---|
| 63 | |
|---|
| 64 | def extractGroups(self, extractonly={}) : |
|---|
| 65 | """Extracts all group records.""" |
|---|
| 66 | thefilter = self.createFilter(extractonly) |
|---|
| 67 | if thefilter : |
|---|
| 68 | thefilter = "WHERE %s" % thefilter |
|---|
| 69 | result = self.doRawSearch("SELECT groups.*,COALESCE(SUM(balance), 0) AS balance, COALESCE(SUM(lifetimepaid), 0) as lifetimepaid FROM groups LEFT OUTER JOIN users ON users.id IN (SELECT userid FROM groupsmembers WHERE groupid=groups.id) %s GROUP BY groups.id,groups.groupname,groups.limitby,groups.description ORDER BY groups.id ASC" % thefilter) |
|---|
| 70 | return self.prepareRawResult(result) |
|---|
| 71 | |
|---|
| 72 | def extractPayments(self, extractonly={}) : |
|---|
| 73 | """Extracts all payment records.""" |
|---|
| 74 | thefilter = self.createFilter(extractonly) |
|---|
| 75 | if thefilter : |
|---|
| 76 | thefilter = "AND %s" % thefilter |
|---|
| 77 | result = self.doRawSearch("SELECT username,payments.* FROM users,payments WHERE users.id=payments.userid %s ORDER BY payments.id ASC" % thefilter) |
|---|
| 78 | return self.prepareRawResult(result) |
|---|
| 79 | |
|---|
| 80 | def extractUpquotas(self, extractonly={}) : |
|---|
| 81 | """Extracts all userpquota records.""" |
|---|
| 82 | thefilter = self.createFilter(extractonly) |
|---|
| 83 | if thefilter : |
|---|
| 84 | thefilter = "AND %s" % thefilter |
|---|
| 85 | result = self.doRawSearch("SELECT users.username,printers.printername,userpquota.* FROM users,printers,userpquota WHERE users.id=userpquota.userid AND printers.id=userpquota.printerid %s ORDER BY userpquota.id ASC" % thefilter) |
|---|
| 86 | return self.prepareRawResult(result) |
|---|
| 87 | |
|---|
| 88 | def extractGpquotas(self, extractonly={}) : |
|---|
| 89 | """Extracts all grouppquota records.""" |
|---|
| 90 | thefilter = self.createFilter(extractonly) |
|---|
| 91 | if thefilter : |
|---|
| 92 | thefilter = "AND %s" % thefilter |
|---|
| 93 | result = self.doRawSearch("SELECT groups.groupname,printers.printername,grouppquota.*,coalesce(sum(pagecounter), 0) AS pagecounter,coalesce(sum(lifepagecounter), 0) AS lifepagecounter FROM groups,printers,grouppquota,userpquota WHERE groups.id=grouppquota.groupid AND printers.id=grouppquota.printerid AND userpquota.printerid=grouppquota.printerid AND userpquota.userid IN (SELECT userid FROM groupsmembers WHERE groupsmembers.groupid=grouppquota.groupid) %s GROUP BY grouppquota.id,grouppquota.groupid,grouppquota.printerid,grouppquota.softlimit,grouppquota.hardlimit,grouppquota.datelimit,grouppquota.maxjobsize,groups.groupname,printers.printername ORDER BY grouppquota.id" % thefilter) |
|---|
| 94 | return self.prepareRawResult(result) |
|---|
| 95 | |
|---|
| 96 | def extractUmembers(self, extractonly={}) : |
|---|
| 97 | """Extracts all user groups members.""" |
|---|
| 98 | thefilter = self.createFilter(extractonly) |
|---|
| 99 | if thefilter : |
|---|
| 100 | thefilter = "AND %s" % thefilter |
|---|
| 101 | result = self.doRawSearch("SELECT groups.groupname, users.username, groupsmembers.* FROM groups,users,groupsmembers WHERE users.id=groupsmembers.userid AND groups.id=groupsmembers.groupid %s ORDER BY groupsmembers.groupid, groupsmembers.userid ASC" % thefilter) |
|---|
| 102 | return self.prepareRawResult(result) |
|---|
| 103 | |
|---|
| 104 | def extractPmembers(self, extractonly={}) : |
|---|
| 105 | """Extracts all printer groups members.""" |
|---|
| 106 | for (k, v) in extractonly.items() : |
|---|
| 107 | if k == "pgroupname" : |
|---|
| 108 | del extractonly[k] |
|---|
| 109 | extractonly["p1.printername"] = v |
|---|
| 110 | elif k == "printername" : |
|---|
| 111 | del extractonly[k] |
|---|
| 112 | extractonly["p2.printername"] = v |
|---|
| 113 | thefilter = self.createFilter(extractonly) |
|---|
| 114 | if thefilter : |
|---|
| 115 | thefilter = "AND %s" % thefilter |
|---|
| 116 | result = self.doRawSearch("SELECT p1.printername as pgroupname, p2.printername as printername, printergroupsmembers.* FROM printers p1, printers p2, printergroupsmembers WHERE p1.id=printergroupsmembers.groupid AND p2.id=printergroupsmembers.printerid %s ORDER BY printergroupsmembers.groupid, printergroupsmembers.printerid ASC" % thefilter) |
|---|
| 117 | return self.prepareRawResult(result) |
|---|
| 118 | |
|---|
| 119 | def extractHistory(self, extractonly={}) : |
|---|
| 120 | """Extracts all jobhistory records.""" |
|---|
| 121 | startdate = extractonly.get("start") |
|---|
| 122 | enddate = extractonly.get("end") |
|---|
| 123 | for limit in ("start", "end") : |
|---|
| 124 | try : |
|---|
| 125 | del extractonly[limit] |
|---|
| 126 | except KeyError : |
|---|
| 127 | pass |
|---|
| 128 | thefilter = self.createFilter(extractonly) |
|---|
| 129 | if thefilter : |
|---|
| 130 | thefilter = "AND %s" % thefilter |
|---|
| 131 | (startdate, enddate) = self.cleanDates(startdate, enddate) |
|---|
| 132 | if startdate : |
|---|
| 133 | thefilter = "%s AND jobdate>=%s" % (thefilter, self.doQuote(startdate)) |
|---|
| 134 | if enddate : |
|---|
| 135 | thefilter = "%s AND jobdate<=%s" % (thefilter, self.doQuote(enddate)) |
|---|
| 136 | result = self.doRawSearch("SELECT users.username,printers.printername,jobhistory.* FROM users,printers,jobhistory WHERE users.id=jobhistory.userid AND printers.id=jobhistory.printerid %s ORDER BY jobhistory.id ASC" % thefilter) |
|---|
| 137 | return self.prepareRawResult(result) |
|---|
| 138 | |
|---|
| 139 | def filterNames(self, records, attribute, patterns=None) : |
|---|
| 140 | """Returns a list of 'attribute' from a list of records. |
|---|
| 141 | |
|---|
| 142 | Logs any missing attribute. |
|---|
| 143 | """ |
|---|
| 144 | result = [] |
|---|
| 145 | for record in records : |
|---|
| 146 | attrval = record.get(attribute, [None]) |
|---|
| 147 | if attrval is None : |
|---|
| 148 | self.tool.printInfo("Object %s has no %s attribute !" % (repr(record), attribute), "error") |
|---|
| 149 | else : |
|---|
| 150 | attrval = self.databaseToUserCharset(attrval) |
|---|
| 151 | if patterns : |
|---|
| 152 | if (not isinstance(patterns, type([]))) and (not isinstance(patterns, type(()))) : |
|---|
| 153 | patterns = [ patterns ] |
|---|
| 154 | if self.tool.matchString(attrval, patterns) : |
|---|
| 155 | result.append(attrval) |
|---|
| 156 | else : |
|---|
| 157 | result.append(attrval) |
|---|
| 158 | return result |
|---|
| 159 | |
|---|
| 160 | def getAllBillingCodes(self, billingcode=None) : |
|---|
| 161 | """Extracts all billing codes or only the billing codes matching the optional parameter.""" |
|---|
| 162 | result = self.doSearch("SELECT billingcode FROM billingcodes") |
|---|
| 163 | if result : |
|---|
| 164 | return self.filterNames(result, "billingcode", billingcode) |
|---|
| 165 | else : |
|---|
| 166 | return [] |
|---|
| 167 | |
|---|
| 168 | def getAllPrintersNames(self, printername=None) : |
|---|
| 169 | """Extracts all printer names or only the printers' names matching the optional parameter.""" |
|---|
| 170 | result = self.doSearch("SELECT printername FROM printers") |
|---|
| 171 | if result : |
|---|
| 172 | return self.filterNames(result, "printername", printername) |
|---|
| 173 | else : |
|---|
| 174 | return [] |
|---|
| 175 | |
|---|
| 176 | def getAllUsersNames(self, username=None) : |
|---|
| 177 | """Extracts all user names.""" |
|---|
| 178 | result = self.doSearch("SELECT username FROM users") |
|---|
| 179 | if result : |
|---|
| 180 | return self.filterNames(result, "username", username) |
|---|
| 181 | else : |
|---|
| 182 | return [] |
|---|
| 183 | |
|---|
| 184 | def getAllGroupsNames(self, groupname=None) : |
|---|
| 185 | """Extracts all group names.""" |
|---|
| 186 | result = self.doSearch("SELECT groupname FROM groups") |
|---|
| 187 | if result : |
|---|
| 188 | return self.filterNames(result, "groupname", groupname) |
|---|
| 189 | else : |
|---|
| 190 | return [] |
|---|
| 191 | |
|---|
| 192 | def getUserNbJobsFromHistory(self, user) : |
|---|
| 193 | """Returns the number of jobs the user has in history.""" |
|---|
| 194 | result = self.doSearch("SELECT COUNT(*) FROM jobhistory WHERE userid=%s" % self.doQuote(user.ident)) |
|---|
| 195 | if result : |
|---|
| 196 | return result[0]["count"] |
|---|
| 197 | return 0 |
|---|
| 198 | |
|---|
| 199 | def getUserFromBackend(self, username) : |
|---|
| 200 | """Extracts user information given its name.""" |
|---|
| 201 | user = StorageUser(self, username) |
|---|
| 202 | username = self.userCharsetToDatabase(username) |
|---|
| 203 | result = self.doSearch("SELECT * FROM users WHERE username=%s LIMIT 1" % self.doQuote(username)) |
|---|
| 204 | if result : |
|---|
| 205 | fields = result[0] |
|---|
| 206 | user.ident = fields.get("id") |
|---|
| 207 | user.LimitBy = fields.get("limitby") or "quota" |
|---|
| 208 | user.AccountBalance = fields.get("balance") |
|---|
| 209 | user.LifeTimePaid = fields.get("lifetimepaid") |
|---|
| 210 | user.Email = fields.get("email") |
|---|
| 211 | user.Description = self.databaseToUserCharset(fields.get("description")) |
|---|
| 212 | user.OverCharge = fields.get("overcharge", 1.0) |
|---|
| 213 | user.Exists = 1 |
|---|
| 214 | return user |
|---|
| 215 | |
|---|
| 216 | def getGroupFromBackend(self, groupname) : |
|---|
| 217 | """Extracts group information given its name.""" |
|---|
| 218 | group = StorageGroup(self, groupname) |
|---|
| 219 | groupname = self.userCharsetToDatabase(groupname) |
|---|
| 220 | result = self.doSearch("SELECT groups.*,COALESCE(SUM(balance), 0.0) AS balance, COALESCE(SUM(lifetimepaid), 0.0) AS lifetimepaid FROM groups LEFT OUTER JOIN users ON users.id IN (SELECT userid FROM groupsmembers WHERE groupid=groups.id) WHERE groupname=%s GROUP BY groups.id,groups.groupname,groups.limitby,groups.description LIMIT 1" % self.doQuote(groupname)) |
|---|
| 221 | if result : |
|---|
| 222 | fields = result[0] |
|---|
| 223 | group.ident = fields.get("id") |
|---|
| 224 | group.LimitBy = fields.get("limitby") or "quota" |
|---|
| 225 | group.AccountBalance = fields.get("balance") |
|---|
| 226 | group.LifeTimePaid = fields.get("lifetimepaid") |
|---|
| 227 | group.Description = self.databaseToUserCharset(fields.get("description")) |
|---|
| 228 | group.Exists = 1 |
|---|
| 229 | return group |
|---|
| 230 | |
|---|
| 231 | def getPrinterFromBackend(self, printername) : |
|---|
| 232 | """Extracts printer information given its name.""" |
|---|
| 233 | printer = StoragePrinter(self, printername) |
|---|
| 234 | printername = self.userCharsetToDatabase(printername) |
|---|
| 235 | result = self.doSearch("SELECT * FROM printers WHERE printername=%s LIMIT 1" % self.doQuote(printername)) |
|---|
| 236 | if result : |
|---|
| 237 | fields = result[0] |
|---|
| 238 | printer.ident = fields.get("id") |
|---|
| 239 | printer.PricePerJob = fields.get("priceperjob") or 0.0 |
|---|
| 240 | printer.PricePerPage = fields.get("priceperpage") or 0.0 |
|---|
| 241 | printer.MaxJobSize = fields.get("maxjobsize") or 0 |
|---|
| 242 | printer.PassThrough = fields.get("passthrough") or 0 |
|---|
| 243 | if printer.PassThrough in (1, "1", "t", "true", "TRUE", "True") : |
|---|
| 244 | printer.PassThrough = 1 |
|---|
| 245 | else : |
|---|
| 246 | printer.PassThrough = 0 |
|---|
| 247 | printer.Description = self.databaseToUserCharset(fields.get("description") or "") |
|---|
| 248 | printer.Exists = 1 |
|---|
| 249 | return printer |
|---|
| 250 | |
|---|
| 251 | def getBillingCodeFromBackend(self, label) : |
|---|
| 252 | """Extracts a billing code information given its name.""" |
|---|
| 253 | code = StorageBillingCode(self, label) |
|---|
| 254 | result = self.doSearch("SELECT * FROM billingcodes WHERE billingcode=%s LIMIT 1" % self.doQuote(self.userCharsetToDatabase(label))) |
|---|
| 255 | if result : |
|---|
| 256 | fields = result[0] |
|---|
| 257 | code.ident = fields.get("id") |
|---|
| 258 | code.Description = self.databaseToUserCharset(fields.get("description") or "") |
|---|
| 259 | code.Balance = fields.get("balance") or 0.0 |
|---|
| 260 | code.PageCounter = fields.get("pagecounter") or 0 |
|---|
| 261 | code.Exists = 1 |
|---|
| 262 | return code |
|---|
| 263 | |
|---|
| 264 | def getUserPQuotaFromBackend(self, user, printer) : |
|---|
| 265 | """Extracts a user print quota.""" |
|---|
| 266 | userpquota = StorageUserPQuota(self, user, printer) |
|---|
| 267 | if printer.Exists and user.Exists : |
|---|
| 268 | result = self.doSearch("SELECT * FROM userpquota WHERE userid=%s AND printerid=%s;" % (self.doQuote(user.ident), self.doQuote(printer.ident))) |
|---|
| 269 | if result : |
|---|
| 270 | fields = result[0] |
|---|
| 271 | userpquota.ident = fields.get("id") |
|---|
| 272 | userpquota.PageCounter = fields.get("pagecounter") |
|---|
| 273 | userpquota.LifePageCounter = fields.get("lifepagecounter") |
|---|
| 274 | userpquota.SoftLimit = fields.get("softlimit") |
|---|
| 275 | userpquota.HardLimit = fields.get("hardlimit") |
|---|
| 276 | userpquota.DateLimit = fields.get("datelimit") |
|---|
| 277 | userpquota.WarnCount = fields.get("warncount") |
|---|
| 278 | userpquota.Exists = 1 |
|---|
| 279 | return userpquota |
|---|
| 280 | |
|---|
| 281 | def getGroupPQuotaFromBackend(self, group, printer) : |
|---|
| 282 | """Extracts a group print quota.""" |
|---|
| 283 | grouppquota = StorageGroupPQuota(self, group, printer) |
|---|
| 284 | if group.Exists : |
|---|
| 285 | result = self.doSearch("SELECT * FROM grouppquota WHERE groupid=%s AND printerid=%s" % (self.doQuote(group.ident), self.doQuote(printer.ident))) |
|---|
| 286 | if result : |
|---|
| 287 | fields = result[0] |
|---|
| 288 | grouppquota.ident = fields.get("id") |
|---|
| 289 | grouppquota.SoftLimit = fields.get("softlimit") |
|---|
| 290 | grouppquota.HardLimit = fields.get("hardlimit") |
|---|
| 291 | grouppquota.DateLimit = fields.get("datelimit") |
|---|
| 292 | result = self.doSearch("SELECT SUM(lifepagecounter) AS lifepagecounter, SUM(pagecounter) AS pagecounter FROM userpquota WHERE printerid=%s AND userid IN (SELECT userid FROM groupsmembers WHERE groupid=%s)" % (self.doQuote(printer.ident), self.doQuote(group.ident))) |
|---|
| 293 | if result : |
|---|
| 294 | fields = result[0] |
|---|
| 295 | grouppquota.PageCounter = fields.get("pagecounter") or 0 |
|---|
| 296 | grouppquota.LifePageCounter = fields.get("lifepagecounter") or 0 |
|---|
| 297 | grouppquota.Exists = 1 |
|---|
| 298 | return grouppquota |
|---|
| 299 | |
|---|
| 300 | def getPrinterLastJobFromBackend(self, printer) : |
|---|
| 301 | """Extracts a printer's last job information.""" |
|---|
| 302 | lastjob = StorageLastJob(self, printer) |
|---|
| 303 | result = self.doSearch("SELECT jobhistory.id, jobid, userid, username, pagecounter, jobsize, jobprice, filename, title, copies, options, hostname, jobdate, md5sum, pages, billingcode, precomputedjobsize, precomputedjobprice FROM jobhistory, users WHERE printerid=%s AND userid=users.id ORDER BY jobdate DESC LIMIT 1" % self.doQuote(printer.ident)) |
|---|
| 304 | if result : |
|---|
| 305 | fields = result[0] |
|---|
| 306 | lastjob.ident = fields.get("id") |
|---|
| 307 | lastjob.JobId = fields.get("jobid") |
|---|
| 308 | lastjob.UserName = self.databaseToUserCharset(fields.get("username")) |
|---|
| 309 | lastjob.PrinterPageCounter = fields.get("pagecounter") |
|---|
| 310 | lastjob.JobSize = fields.get("jobsize") |
|---|
| 311 | lastjob.JobPrice = fields.get("jobprice") |
|---|
| 312 | lastjob.JobAction = fields.get("action") |
|---|
| 313 | lastjob.JobFileName = self.databaseToUserCharset(fields.get("filename") or "") |
|---|
| 314 | lastjob.JobTitle = self.databaseToUserCharset(fields.get("title") or "") |
|---|
| 315 | lastjob.JobCopies = fields.get("copies") |
|---|
| 316 | lastjob.JobOptions = self.databaseToUserCharset(fields.get("options") or "") |
|---|
| 317 | lastjob.JobDate = fields.get("jobdate") |
|---|
| 318 | lastjob.JobHostName = fields.get("hostname") |
|---|
| 319 | lastjob.JobSizeBytes = fields.get("jobsizebytes") |
|---|
| 320 | lastjob.JobMD5Sum = fields.get("md5sum") |
|---|
| 321 | lastjob.JobPages = fields.get("pages") |
|---|
| 322 | lastjob.JobBillingCode = self.databaseToUserCharset(fields.get("billingcode")) |
|---|
| 323 | lastjob.PrecomputedJobSize = fields.get("precomputedjobsize") |
|---|
| 324 | lastjob.PrecomputedJobPrice = fields.get("precomputedjobprice") |
|---|
| 325 | if lastjob.JobTitle == lastjob.JobFileName == lastjob.JobOptions == "hidden" : |
|---|
| 326 | (lastjob.JobTitle, lastjob.JobFileName, lastjob.JobOptions) = (_("Hidden because of privacy concerns"),) * 3 |
|---|
| 327 | lastjob.Exists = 1 |
|---|
| 328 | return lastjob |
|---|
| 329 | |
|---|
| 330 | def getGroupMembersFromBackend(self, group) : |
|---|
| 331 | """Returns the group's members list.""" |
|---|
| 332 | groupmembers = [] |
|---|
| 333 | result = self.doSearch("SELECT * FROM groupsmembers JOIN users ON groupsmembers.userid=users.id WHERE groupid=%s" % self.doQuote(group.ident)) |
|---|
| 334 | if result : |
|---|
| 335 | for record in result : |
|---|
| 336 | user = StorageUser(self, self.databaseToUserCharset(record.get("username"))) |
|---|
| 337 | user.ident = record.get("userid") |
|---|
| 338 | user.LimitBy = record.get("limitby") or "quota" |
|---|
| 339 | user.AccountBalance = record.get("balance") |
|---|
| 340 | user.LifeTimePaid = record.get("lifetimepaid") |
|---|
| 341 | user.Email = record.get("email") |
|---|
| 342 | user.OverCharge = record.get("overcharge") |
|---|
| 343 | user.Exists = 1 |
|---|
| 344 | groupmembers.append(user) |
|---|
| 345 | self.cacheEntry("USERS", user.Name, user) |
|---|
| 346 | return groupmembers |
|---|
| 347 | |
|---|
| 348 | def getUserGroupsFromBackend(self, user) : |
|---|
| 349 | """Returns the user's groups list.""" |
|---|
| 350 | groups = [] |
|---|
| 351 | result = self.doSearch("SELECT groupname FROM groupsmembers JOIN groups ON groupsmembers.groupid=groups.id WHERE userid=%s" % self.doQuote(user.ident)) |
|---|
| 352 | if result : |
|---|
| 353 | for record in result : |
|---|
| 354 | groups.append(self.getGroup(self.databaseToUserCharset(record.get("groupname")))) |
|---|
| 355 | return groups |
|---|
| 356 | |
|---|
| 357 | def getParentPrintersFromBackend(self, printer) : |
|---|
| 358 | """Get all the printer groups this printer is a member of.""" |
|---|
| 359 | pgroups = [] |
|---|
| 360 | result = self.doSearch("SELECT groupid,printername FROM printergroupsmembers JOIN printers ON groupid=id WHERE printerid=%s" % self.doQuote(printer.ident)) |
|---|
| 361 | if result : |
|---|
| 362 | for record in result : |
|---|
| 363 | if record["groupid"] != printer.ident : # in case of integrity violation |
|---|
| 364 | parentprinter = self.getPrinter(self.databaseToUserCharset(record.get("printername"))) |
|---|
| 365 | if parentprinter.Exists : |
|---|
| 366 | pgroups.append(parentprinter) |
|---|
| 367 | return pgroups |
|---|
| 368 | |
|---|
| 369 | def getMatchingPrinters(self, printerpattern) : |
|---|
| 370 | """Returns the list of all printers for which name matches a certain pattern.""" |
|---|
| 371 | printers = [] |
|---|
| 372 | # We 'could' do a SELECT printername FROM printers WHERE printername LIKE ... |
|---|
| 373 | # but we don't because other storages semantics may be different, so every |
|---|
| 374 | # storage should use fnmatch to match patterns and be storage agnostic |
|---|
| 375 | result = self.doSearch("SELECT * FROM printers") |
|---|
| 376 | if result : |
|---|
| 377 | patterns = printerpattern.split(",") |
|---|
| 378 | try : |
|---|
| 379 | patdict = {}.fromkeys(patterns) |
|---|
| 380 | except AttributeError : |
|---|
| 381 | # Python v2.2 or earlier |
|---|
| 382 | patdict = {} |
|---|
| 383 | for p in patterns : |
|---|
| 384 | patdict[p] = None |
|---|
| 385 | for record in result : |
|---|
| 386 | pname = self.databaseToUserCharset(record["printername"]) |
|---|
| 387 | if patdict.has_key(pname) or self.tool.matchString(pname, patterns) : |
|---|
| 388 | printer = StoragePrinter(self, pname) |
|---|
| 389 | printer.ident = record.get("id") |
|---|
| 390 | printer.PricePerJob = record.get("priceperjob") or 0.0 |
|---|
| 391 | printer.PricePerPage = record.get("priceperpage") or 0.0 |
|---|
| 392 | printer.Description = self.databaseToUserCharset(record.get("description") or "") |
|---|
| 393 | printer.MaxJobSize = record.get("maxjobsize") or 0 |
|---|
| 394 | printer.PassThrough = record.get("passthrough") or 0 |
|---|
| 395 | if printer.PassThrough in (1, "1", "t", "true", "TRUE", "True") : |
|---|
| 396 | printer.PassThrough = 1 |
|---|
| 397 | else : |
|---|
| 398 | printer.PassThrough = 0 |
|---|
| 399 | printer.Exists = 1 |
|---|
| 400 | printers.append(printer) |
|---|
| 401 | self.cacheEntry("PRINTERS", printer.Name, printer) |
|---|
| 402 | return printers |
|---|
| 403 | |
|---|
| 404 | def getMatchingUsers(self, userpattern) : |
|---|
| 405 | """Returns the list of all users for which name matches a certain pattern.""" |
|---|
| 406 | users = [] |
|---|
| 407 | # We 'could' do a SELECT username FROM users WHERE username LIKE ... |
|---|
| 408 | # but we don't because other storages semantics may be different, so every |
|---|
| 409 | # storage should use fnmatch to match patterns and be storage agnostic |
|---|
| 410 | result = self.doSearch("SELECT * FROM users") |
|---|
| 411 | if result : |
|---|
| 412 | patterns = userpattern.split(",") |
|---|
| 413 | try : |
|---|
| 414 | patdict = {}.fromkeys(patterns) |
|---|
| 415 | except AttributeError : |
|---|
| 416 | # Python v2.2 or earlier |
|---|
| 417 | patdict = {} |
|---|
| 418 | for p in patterns : |
|---|
| 419 | patdict[p] = None |
|---|
| 420 | for record in result : |
|---|
| 421 | uname = self.databaseToUserCharset(record["username"]) |
|---|
| 422 | if patdict.has_key(uname) or self.tool.matchString(uname, patterns) : |
|---|
| 423 | user = StorageUser(self, uname) |
|---|
| 424 | user.ident = record.get("id") |
|---|
| 425 | user.LimitBy = record.get("limitby") or "quota" |
|---|
| 426 | user.AccountBalance = record.get("balance") |
|---|
| 427 | user.LifeTimePaid = record.get("lifetimepaid") |
|---|
| 428 | user.Email = record.get("email") |
|---|
| 429 | user.Description = self.databaseToUserCharset(record.get("description")) |
|---|
| 430 | user.OverCharge = record.get("overcharge", 1.0) |
|---|
| 431 | user.Exists = 1 |
|---|
| 432 | users.append(user) |
|---|
| 433 | self.cacheEntry("USERS", user.Name, user) |
|---|
| 434 | return users |
|---|
| 435 | |
|---|
| 436 | def getMatchingGroups(self, grouppattern) : |
|---|
| 437 | """Returns the list of all groups for which name matches a certain pattern.""" |
|---|
| 438 | groups = [] |
|---|
| 439 | # We 'could' do a SELECT groupname FROM groups WHERE groupname LIKE ... |
|---|
| 440 | # but we don't because other storages semantics may be different, so every |
|---|
| 441 | # storage should use fnmatch to match patterns and be storage agnostic |
|---|
| 442 | result = self.doSearch("SELECT groups.*,COALESCE(SUM(balance), 0.0) AS balance, COALESCE(SUM(lifetimepaid), 0.0) AS lifetimepaid FROM groups LEFT OUTER JOIN users ON users.id IN (SELECT userid FROM groupsmembers WHERE groupid=groups.id) GROUP BY groups.id,groups.groupname,groups.limitby,groups.description") |
|---|
| 443 | if result : |
|---|
| 444 | patterns = grouppattern.split(",") |
|---|
| 445 | try : |
|---|
| 446 | patdict = {}.fromkeys(patterns) |
|---|
| 447 | except AttributeError : |
|---|
| 448 | # Python v2.2 or earlier |
|---|
| 449 | patdict = {} |
|---|
| 450 | for p in patterns : |
|---|
| 451 | patdict[p] = None |
|---|
| 452 | for record in result : |
|---|
| 453 | gname = self.databaseToUserCharset(record["groupname"]) |
|---|
| 454 | if patdict.has_key(gname) or self.tool.matchString(gname, patterns) : |
|---|
| 455 | group = StorageGroup(self, gname) |
|---|
| 456 | group.ident = record.get("id") |
|---|
| 457 | group.LimitBy = record.get("limitby") or "quota" |
|---|
| 458 | group.AccountBalance = record.get("balance") |
|---|
| 459 | group.LifeTimePaid = record.get("lifetimepaid") |
|---|
| 460 | group.Description = self.databaseToUserCharset(record.get("description")) |
|---|
| 461 | group.Exists = 1 |
|---|
| 462 | groups.append(group) |
|---|
| 463 | self.cacheEntry("GROUPS", group.Name, group) |
|---|
| 464 | return groups |
|---|
| 465 | |
|---|
| 466 | def getMatchingBillingCodes(self, billingcodepattern) : |
|---|
| 467 | """Returns the list of all billing codes for which the label matches a certain pattern.""" |
|---|
| 468 | codes = [] |
|---|
| 469 | result = self.doSearch("SELECT * FROM billingcodes") |
|---|
| 470 | if result : |
|---|
| 471 | patterns = billingcodepattern.split(",") |
|---|
| 472 | for record in result : |
|---|
| 473 | codename = self.databaseToUserCharset(record["billingcode"]) |
|---|
| 474 | if self.tool.matchString(codename, patterns) : |
|---|
| 475 | code = StorageBillingCode(self, codename) |
|---|
| 476 | code.ident = record.get("id") |
|---|
| 477 | code.Balance = record.get("balance") or 0.0 |
|---|
| 478 | code.PageCounter = record.get("pagecounter") or 0 |
|---|
| 479 | code.Description = self.databaseToUserCharset(record.get("description") or "") |
|---|
| 480 | code.Exists = 1 |
|---|
| 481 | codes.append(code) |
|---|
| 482 | self.cacheEntry("BILLINGCODES", code.BillingCode, code) |
|---|
| 483 | return codes |
|---|
| 484 | |
|---|
| 485 | def getPrinterUsersAndQuotas(self, printer, names=["*"]) : |
|---|
| 486 | """Returns the list of users who uses a given printer, along with their quotas.""" |
|---|
| 487 | usersandquotas = [] |
|---|
| 488 | result = self.doSearch("SELECT users.id as uid,username,description,balance,lifetimepaid,limitby,email,overcharge,userpquota.id,lifepagecounter,pagecounter,softlimit,hardlimit,datelimit,warncount FROM users JOIN userpquota ON users.id=userpquota.userid AND printerid=%s ORDER BY username ASC" % self.doQuote(printer.ident)) |
|---|
| 489 | if result : |
|---|
| 490 | for record in result : |
|---|
| 491 | uname = self.databaseToUserCharset(record.get("username")) |
|---|
| 492 | if self.tool.matchString(uname, names) : |
|---|
| 493 | user = StorageUser(self, uname) |
|---|
| 494 | user.ident = record.get("uid") |
|---|
| 495 | user.LimitBy = record.get("limitby") or "quota" |
|---|
| 496 | user.AccountBalance = record.get("balance") |
|---|
| 497 | user.LifeTimePaid = record.get("lifetimepaid") |
|---|
| 498 | user.Email = record.get("email") |
|---|
| 499 | user.OverCharge = record.get("overcharge") |
|---|
| 500 | user.Description = self.databaseToUserCharset(record.get("description")) |
|---|
| 501 | user.Exists = 1 |
|---|
| 502 | userpquota = StorageUserPQuota(self, user, printer) |
|---|
| 503 | userpquota.ident = record.get("id") |
|---|
| 504 | userpquota.PageCounter = record.get("pagecounter") |
|---|
| 505 | userpquota.LifePageCounter = record.get("lifepagecounter") |
|---|
| 506 | userpquota.SoftLimit = record.get("softlimit") |
|---|
| 507 | userpquota.HardLimit = record.get("hardlimit") |
|---|
| 508 | userpquota.DateLimit = record.get("datelimit") |
|---|
| 509 | userpquota.WarnCount = record.get("warncount") |
|---|
| 510 | userpquota.Exists = 1 |
|---|
| 511 | usersandquotas.append((user, userpquota)) |
|---|
| 512 | self.cacheEntry("USERS", user.Name, user) |
|---|
| 513 | self.cacheEntry("USERPQUOTAS", "%s@%s" % (user.Name, printer.Name), userpquota) |
|---|
| 514 | return usersandquotas |
|---|
| 515 | |
|---|
| 516 | def getPrinterGroupsAndQuotas(self, printer, names=["*"]) : |
|---|
| 517 | """Returns the list of groups which uses a given printer, along with their quotas.""" |
|---|
| 518 | groupsandquotas = [] |
|---|
| 519 | result = self.doSearch("SELECT groupname FROM groups JOIN grouppquota ON groups.id=grouppquota.groupid AND printerid=%s ORDER BY groupname ASC" % self.doQuote(printer.ident)) |
|---|
| 520 | if result : |
|---|
| 521 | for record in result : |
|---|
| 522 | gname = self.databaseToUserCharset(record.get("groupname")) |
|---|
| 523 | if self.tool.matchString(gname, names) : |
|---|
| 524 | group = self.getGroup(gname) |
|---|
| 525 | grouppquota = self.getGroupPQuota(group, printer) |
|---|
| 526 | groupsandquotas.append((group, grouppquota)) |
|---|
| 527 | return groupsandquotas |
|---|
| 528 | |
|---|
| 529 | def addPrinter(self, printername) : |
|---|
| 530 | """Adds a printer to the quota storage, returns it.""" |
|---|
| 531 | self.doModify("INSERT INTO printers (printername) VALUES (%s)" % self.doQuote(self.userCharsetToDatabase(printername))) |
|---|
| 532 | return self.getPrinter(printername) |
|---|
| 533 | |
|---|
| 534 | def addBillingCode(self, label) : |
|---|
| 535 | """Adds a billing code to the quota storage, returns it.""" |
|---|
| 536 | self.doModify("INSERT INTO billingcodes (billingcode) VALUES (%s)" % self.doQuote(self.userCharsetToDatabase(label))) |
|---|
| 537 | return self.getBillingCode(label) |
|---|
| 538 | |
|---|
| 539 | def addUser(self, user) : |
|---|
| 540 | """Adds a user to the quota storage, returns it.""" |
|---|
| 541 | self.doModify("INSERT INTO users (username, limitby, balance, lifetimepaid, email, overcharge, description) VALUES (%s, %s, %s, %s, %s, %s, %s)" % \ |
|---|
| 542 | (self.doQuote(self.userCharsetToDatabase(user.Name)), \ |
|---|
| 543 | self.doQuote(user.LimitBy or 'quota'), \ |
|---|
| 544 | self.doQuote(user.AccountBalance or 0.0), \ |
|---|
| 545 | self.doQuote(user.LifeTimePaid or 0.0), \ |
|---|
| 546 | self.doQuote(user.Email), \ |
|---|
| 547 | self.doQuote(user.OverCharge), \ |
|---|
| 548 | self.doQuote(self.userCharsetToDatabase(user.Description)))) |
|---|
| 549 | return self.getUser(user.Name) |
|---|
| 550 | |
|---|
| 551 | def addGroup(self, group) : |
|---|
| 552 | """Adds a group to the quota storage, returns it.""" |
|---|
| 553 | self.doModify("INSERT INTO groups (groupname, limitby, description) VALUES (%s, %s, %s)" % \ |
|---|
| 554 | (self.doQuote(self.userCharsetToDatabase(group.Name)), \ |
|---|
| 555 | self.doQuote(group.LimitBy or "quota"), \ |
|---|
| 556 | self.doQuote(self.userCharsetToDatabase(group.Description)))) |
|---|
| 557 | return self.getGroup(group.Name) |
|---|
| 558 | |
|---|
| 559 | def addUserToGroup(self, user, group) : |
|---|
| 560 | """Adds an user to a group.""" |
|---|
| 561 | result = self.doSearch("SELECT COUNT(*) AS mexists FROM groupsmembers WHERE groupid=%s AND userid=%s" % (self.doQuote(group.ident), self.doQuote(user.ident))) |
|---|
| 562 | try : |
|---|
| 563 | mexists = int(result[0].get("mexists")) |
|---|
| 564 | except (IndexError, TypeError) : |
|---|
| 565 | mexists = 0 |
|---|
| 566 | if not mexists : |
|---|
| 567 | self.doModify("INSERT INTO groupsmembers (groupid, userid) VALUES (%s, %s)" % (self.doQuote(group.ident), self.doQuote(user.ident))) |
|---|
| 568 | |
|---|
| 569 | def delUserFromGroup(self, user, group) : |
|---|
| 570 | """Removes an user from a group.""" |
|---|
| 571 | self.doModify("DELETE FROM groupsmembers WHERE groupid=%s AND userid=%s" % \ |
|---|
| 572 | (self.doQuote(group.ident), self.doQuote(user.ident))) |
|---|
| 573 | |
|---|
| 574 | def addUserPQuota(self, upq) : |
|---|
| 575 | """Initializes a user print quota on a printer.""" |
|---|
| 576 | try : |
|---|
| 577 | self.doModify("INSERT INTO userpquota (userid, printerid, softlimit, hardlimit, warncount, datelimit, pagecounter, lifepagecounter, maxjobsize) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)" \ |
|---|
| 578 | % (self.doQuote(upq.User.ident), \ |
|---|
| 579 | self.doQuote(upq.Printer.ident), \ |
|---|
| 580 | self.doQuote(upq.SoftLimit), \ |
|---|
| 581 | self.doQuote(upq.HardLimit), \ |
|---|
| 582 | self.doQuote(upq.WarnCount), \ |
|---|
| 583 | self.doQuote(upq.DateLimit), \ |
|---|
| 584 | self.doQuote(upq.PageCounter or 0), \ |
|---|
| 585 | self.doQuote(upq.LifePageCounter or 0), \ |
|---|
| 586 | self.doQuote(upq.MaxJobSize))) |
|---|
| 587 | except PyKotaStorageError : |
|---|
| 588 | # TODO : check if this is an error different from a duplicate insert |
|---|
| 589 | # return the existing entry which has to be modified |
|---|
| 590 | return self.getUserPQuota(upq.User, upq.Printer) |
|---|
| 591 | else : |
|---|
| 592 | upq.isDirty = False |
|---|
| 593 | return None # the entry created doesn't need further modification |
|---|
| 594 | |
|---|
| 595 | def addGroupPQuota(self, gpq) : |
|---|
| 596 | """Initializes a group print quota on a printer.""" |
|---|
| 597 | try : |
|---|
| 598 | self.doModify("INSERT INTO grouppquota (groupid, printerid, softlimit, hardlimit, datelimit, maxjobsize) VALUES (%s, %s, %s, %s, %s, %s)" \ |
|---|
| 599 | % (self.doQuote(gpq.Group.ident), \ |
|---|
| 600 | self.doQuote(gpq.Printer.ident), \ |
|---|
| 601 | self.doQuote(gpq.SoftLimit), \ |
|---|
| 602 | self.doQuote(gpq.HardLimit), \ |
|---|
| 603 | self.doQuote(gpq.DateLimit), \ |
|---|
| 604 | self.doQuote(gpq.MaxJobSize))) |
|---|
| 605 | except PyKotaStorageError : |
|---|
| 606 | # TODO : check if this is an error different from a duplicate insert |
|---|
| 607 | # return the existing entry which has to be modified |
|---|
| 608 | return self.getGroupPQuota(gpq.Group, gpq.Printer) |
|---|
| 609 | else : |
|---|
| 610 | gpq.isDirty = False |
|---|
| 611 | return None # the entry created doesn't need further modification |
|---|
| 612 | |
|---|
| 613 | def savePrinter(self, printer) : |
|---|
| 614 | """Saves the printer to the database in a single operation.""" |
|---|
| 615 | self.doModify("UPDATE printers SET passthrough=%s, maxjobsize=%s, description=%s, priceperpage=%s, priceperjob=%s WHERE id=%s" \ |
|---|
| 616 | % (self.doQuote((printer.PassThrough and "t") or "f"), \ |
|---|
| 617 | self.doQuote(printer.MaxJobSize), \ |
|---|
| 618 | self.doQuote(self.userCharsetToDatabase(printer.Description)), \ |
|---|
| 619 | self.doQuote(printer.PricePerPage), \ |
|---|
| 620 | self.doQuote(printer.PricePerJob), \ |
|---|
| 621 | self.doQuote(printer.ident))) |
|---|
| 622 | |
|---|
| 623 | def saveUser(self, user) : |
|---|
| 624 | """Saves the user to the database in a single operation.""" |
|---|
| 625 | self.doModify("UPDATE users SET limitby=%s, balance=%s, lifetimepaid=%s, email=%s, overcharge=%s, description=%s WHERE id=%s" \ |
|---|
| 626 | % (self.doQuote(user.LimitBy or 'quota'), \ |
|---|
| 627 | self.doQuote(user.AccountBalance or 0.0), \ |
|---|
| 628 | self.doQuote(user.LifeTimePaid or 0.0), \ |
|---|
| 629 | self.doQuote(user.Email), \ |
|---|
| 630 | self.doQuote(user.OverCharge), \ |
|---|
| 631 | self.doQuote(self.userCharsetToDatabase(user.Description)), \ |
|---|
| 632 | self.doQuote(user.ident))) |
|---|
| 633 | |
|---|
| 634 | def saveGroup(self, group) : |
|---|
| 635 | """Saves the group to the database in a single operation.""" |
|---|
| 636 | self.doModify("UPDATE groups SET limitby=%s, description=%s WHERE id=%s" \ |
|---|
| 637 | % (self.doQuote(group.LimitBy or 'quota'), \ |
|---|
| 638 | self.doQuote(self.userCharsetToDatabase(group.Description)), \ |
|---|
| 639 | self.doQuote(group.ident))) |
|---|
| 640 | |
|---|
| 641 | def writeUserPQuotaDateLimit(self, userpquota, datelimit) : |
|---|
| 642 | """Sets the date limit permanently for a user print quota.""" |
|---|
| 643 | self.doModify("UPDATE userpquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(userpquota.ident))) |
|---|
| 644 | |
|---|
| 645 | def writeGroupPQuotaDateLimit(self, grouppquota, datelimit) : |
|---|
| 646 | """Sets the date limit permanently for a group print quota.""" |
|---|
| 647 | self.doModify("UPDATE grouppquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(grouppquota.ident))) |
|---|
| 648 | |
|---|
| 649 | def increaseUserPQuotaPagesCounters(self, userpquota, nbpages) : |
|---|
| 650 | """Increase page counters for a user print quota.""" |
|---|
| 651 | self.doModify("UPDATE userpquota SET pagecounter=pagecounter + %s,lifepagecounter=lifepagecounter + %s WHERE id=%s" % (self.doQuote(nbpages), self.doQuote(nbpages), self.doQuote(userpquota.ident))) |
|---|
| 652 | |
|---|
| 653 | def saveBillingCode(self, code) : |
|---|
| 654 | """Saves the billing code to the database.""" |
|---|
| 655 | self.doModify("UPDATE billingcodes SET balance=%s, pagecounter=%s, description=%s WHERE id=%s" \ |
|---|
| 656 | % (self.doQuote(code.Balance or 0.0), \ |
|---|
| 657 | self.doQuote(code.PageCounter or 0), \ |
|---|
| 658 | self.doQuote(self.userCharsetToDatabase(code.Description)), \ |
|---|
| 659 | self.doQuote(code.ident))) |
|---|
| 660 | |
|---|
| 661 | def consumeBillingCode(self, code, pagecounter, balance) : |
|---|
| 662 | """Consumes from a billing code.""" |
|---|
| 663 | self.doModify("UPDATE billingcodes SET balance=balance + %s, pagecounter=pagecounter + %s WHERE id=%s" % (self.doQuote(balance), self.doQuote(pagecounter), self.doQuote(code.ident))) |
|---|
| 664 | |
|---|
| 665 | def decreaseUserAccountBalance(self, user, amount) : |
|---|
| 666 | """Decreases user's account balance from an amount.""" |
|---|
| 667 | self.doModify("UPDATE users SET balance=balance - %s WHERE id=%s" % (self.doQuote(amount), self.doQuote(user.ident))) |
|---|
| 668 | |
|---|
| 669 | def writeNewPayment(self, user, amount, comment="") : |
|---|
| 670 | """Adds a new payment to the payments history.""" |
|---|
| 671 | self.doModify("INSERT INTO payments (userid, amount, description) VALUES (%s, %s, %s)" % (self.doQuote(user.ident), self.doQuote(amount), self.doQuote(self.userCharsetToDatabase(comment)))) |
|---|
| 672 | |
|---|
| 673 | def writeLastJobSize(self, lastjob, jobsize, jobprice) : |
|---|
| 674 | """Sets the last job's size permanently.""" |
|---|
| 675 | self.doModify("UPDATE jobhistory SET jobsize=%s, jobprice=%s WHERE id=%s" % (self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(lastjob.ident))) |
|---|
| 676 | |
|---|
| 677 | 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) : |
|---|
| 678 | """Adds a job in a printer's history.""" |
|---|
| 679 | if self.privacy : |
|---|
| 680 | # For legal reasons, we want to hide the title, filename and options |
|---|
| 681 | title = filename = options = "hidden" |
|---|
| 682 | filename = self.userCharsetToDatabase(filename) |
|---|
| 683 | title = self.userCharsetToDatabase(title) |
|---|
| 684 | options = self.userCharsetToDatabase(options) |
|---|
| 685 | jobbilling = self.userCharsetToDatabase(jobbilling) |
|---|
| 686 | if (not self.disablehistory) or (not printer.LastJob.Exists) : |
|---|
| 687 | if jobsize is not None : |
|---|
| 688 | self.doModify("INSERT INTO jobhistory (userid, printerid, jobid, pagecounter, action, jobsize, jobprice, filename, title, copies, options, hostname, jobsizebytes, md5sum, pages, billingcode, precomputedjobsize, precomputedjobprice) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options), self.doQuote(clienthost), self.doQuote(jobsizebytes), self.doQuote(jobmd5sum), self.doQuote(jobpages), self.doQuote(jobbilling), self.doQuote(precomputedsize), self.doQuote(precomputedprice))) |
|---|
| 689 | else : |
|---|
| 690 | self.doModify("INSERT INTO jobhistory (userid, printerid, jobid, pagecounter, action, filename, title, copies, options, hostname, jobsizebytes, md5sum, pages, billingcode, precomputedjobsize, precomputedjobprice) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options), self.doQuote(clienthost), self.doQuote(jobsizebytes), self.doQuote(jobmd5sum), self.doQuote(jobpages), self.doQuote(jobbilling), self.doQuote(precomputedsize), self.doQuote(precomputedprice))) |
|---|
| 691 | else : |
|---|
| 692 | # here we explicitly want to reset jobsize to NULL if needed |
|---|
| 693 | self.doModify("UPDATE jobhistory SET userid=%s, jobid=%s, pagecounter=%s, action=%s, jobsize=%s, jobprice=%s, filename=%s, title=%s, copies=%s, options=%s, hostname=%s, jobsizebytes=%s, md5sum=%s, pages=%s, billingcode=%s, precomputedjobsize=%s, precomputedjobprice=%s, jobdate=now() WHERE id=%s" % (self.doQuote(user.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options), self.doQuote(clienthost), self.doQuote(jobsizebytes), self.doQuote(jobmd5sum), self.doQuote(jobpages), self.doQuote(jobbilling), self.doQuote(precomputedsize), self.doQuote(precomputedprice), self.doQuote(printer.LastJob.ident))) |
|---|
| 694 | |
|---|
| 695 | def saveUserPQuota(self, userpquota) : |
|---|
| 696 | """Saves an user print quota entry.""" |
|---|
| 697 | self.doModify("UPDATE userpquota SET softlimit=%s, hardlimit=%s, warncount=%s, datelimit=%s, pagecounter=%s, lifepagecounter=%s, maxjobsize=%s WHERE id=%s" \ |
|---|
| 698 | % (self.doQuote(userpquota.SoftLimit), \ |
|---|
| 699 | self.doQuote(userpquota.HardLimit), \ |
|---|
| 700 | self.doQuote(userpquota.WarnCount), \ |
|---|
| 701 | self.doQuote(userpquota.DateLimit), \ |
|---|
| 702 | self.doQuote(userpquota.PageCounter or 0), \ |
|---|
| 703 | self.doQuote(userpquota.LifePageCounter or 0), \ |
|---|
| 704 | self.doQuote(userpquota.MaxJobSize), \ |
|---|
| 705 | self.doQuote(userpquota.ident))) |
|---|
| 706 | |
|---|
| 707 | def writeUserPQuotaWarnCount(self, userpquota, warncount) : |
|---|
| 708 | """Sets the warn counter value for a user quota.""" |
|---|
| 709 | self.doModify("UPDATE userpquota SET warncount=%s WHERE id=%s" % (self.doQuote(warncount), self.doQuote(userpquota.ident))) |
|---|
| 710 | |
|---|
| 711 | def increaseUserPQuotaWarnCount(self, userpquota) : |
|---|
| 712 | """Increases the warn counter value for a user quota.""" |
|---|
| 713 | self.doModify("UPDATE userpquota SET warncount=warncount+1 WHERE id=%s" % self.doQuote(userpquota.ident)) |
|---|
| 714 | |
|---|
| 715 | def saveGroupPQuota(self, grouppquota) : |
|---|
| 716 | """Saves a group print quota entry.""" |
|---|
| 717 | self.doModify("UPDATE grouppquota SET softlimit=%s, hardlimit=%s, datelimit=%s WHERE id=%s" \ |
|---|
| 718 | % (self.doQuote(grouppquota.SoftLimit), \ |
|---|
| 719 | self.doQuote(grouppquota.HardLimit), \ |
|---|
| 720 | self.doQuote(grouppquota.DateLimit), \ |
|---|
| 721 | self.doQuote(grouppquota.ident))) |
|---|
| 722 | |
|---|
| 723 | def writePrinterToGroup(self, pgroup, printer) : |
|---|
| 724 | """Puts a printer into a printer group.""" |
|---|
| 725 | children = [] |
|---|
| 726 | result = self.doSearch("SELECT printerid FROM printergroupsmembers WHERE groupid=%s" % self.doQuote(pgroup.ident)) |
|---|
| 727 | if result : |
|---|
| 728 | for record in result : |
|---|
| 729 | children.append(record.get("printerid")) # TODO : put this into the database integrity rules |
|---|
| 730 | if printer.ident not in children : |
|---|
| 731 | self.doModify("INSERT INTO printergroupsmembers (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(pgroup.ident), self.doQuote(printer.ident))) |
|---|
| 732 | |
|---|
| 733 | def removePrinterFromGroup(self, pgroup, printer) : |
|---|
| 734 | """Removes a printer from a printer group.""" |
|---|
| 735 | self.doModify("DELETE FROM printergroupsmembers WHERE groupid=%s AND printerid=%s" % (self.doQuote(pgroup.ident), self.doQuote(printer.ident))) |
|---|
| 736 | |
|---|
| 737 | def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, limit=100, start=None, end=None) : |
|---|
| 738 | """Retrieves all print jobs for user on printer (or all) between start and end date, limited to first 100 results.""" |
|---|
| 739 | query = "SELECT jobhistory.*,username,printername FROM jobhistory,users,printers WHERE users.id=userid AND printers.id=printerid" |
|---|
| 740 | where = [] |
|---|
| 741 | if user is not None : # user.ident is None anyway if user doesn't exist |
|---|
| 742 | where.append("userid=%s" % self.doQuote(user.ident)) |
|---|
| 743 | if printer is not None : # printer.ident is None anyway if printer doesn't exist |
|---|
| 744 | where.append("printerid=%s" % self.doQuote(printer.ident)) |
|---|
| 745 | if hostname is not None : |
|---|
| 746 | where.append("hostname=%s" % self.doQuote(hostname)) |
|---|
| 747 | if billingcode is not None : |
|---|
| 748 | where.append("billingcode=%s" % self.doQuote(self.userCharsetToDatabase(billingcode))) |
|---|
| 749 | if start is not None : |
|---|
| 750 | where.append("jobdate>=%s" % self.doQuote(start)) |
|---|
| 751 | if end is not None : |
|---|
| 752 | where.append("jobdate<=%s" % self.doQuote(end)) |
|---|
| 753 | if where : |
|---|
| 754 | query += " AND %s" % " AND ".join(where) |
|---|
| 755 | query += " ORDER BY jobhistory.id DESC" |
|---|
| 756 | if limit : |
|---|
| 757 | query += " LIMIT %s" % self.doQuote(int(limit)) |
|---|
| 758 | jobs = [] |
|---|
| 759 | result = self.doSearch(query) |
|---|
| 760 | if result : |
|---|
| 761 | for fields in result : |
|---|
| 762 | job = StorageJob(self) |
|---|
| 763 | job.ident = fields.get("id") |
|---|
| 764 | job.JobId = fields.get("jobid") |
|---|
| 765 | job.PrinterPageCounter = fields.get("pagecounter") |
|---|
| 766 | job.JobSize = fields.get("jobsize") |
|---|
| 767 | job.JobPrice = fields.get("jobprice") |
|---|
| 768 | job.JobAction = fields.get("action") |
|---|
| 769 | job.JobFileName = self.databaseToUserCharset(fields.get("filename") or "") |
|---|
| 770 | job.JobTitle = self.databaseToUserCharset(fields.get("title") or "") |
|---|
| 771 | job.JobCopies = fields.get("copies") |
|---|
| 772 | job.JobOptions = self.databaseToUserCharset(fields.get("options") or "") |
|---|
| 773 | job.JobDate = fields.get("jobdate") |
|---|
| 774 | job.JobHostName = fields.get("hostname") |
|---|
| 775 | job.JobSizeBytes = fields.get("jobsizebytes") |
|---|
| 776 | job.JobMD5Sum = fields.get("md5sum") |
|---|
| 777 | job.JobPages = fields.get("pages") |
|---|
| 778 | job.JobBillingCode = self.databaseToUserCharset(fields.get("billingcode") or "") |
|---|
| 779 | job.PrecomputedJobSize = fields.get("precomputedjobsize") |
|---|
| 780 | job.PrecomputedJobPrice = fields.get("precomputedjobprice") |
|---|
| 781 | job.UserName = self.databaseToUserCharset(fields.get("username")) |
|---|
| 782 | job.PrinterName = self.databaseToUserCharset(fields.get("printername")) |
|---|
| 783 | if job.JobTitle == job.JobFileName == job.JobOptions == "hidden" : |
|---|
| 784 | (job.JobTitle, job.JobFileName, job.JobOptions) = (_("Hidden because of privacy concerns"),) * 3 |
|---|
| 785 | job.Exists = 1 |
|---|
| 786 | jobs.append(job) |
|---|
| 787 | return jobs |
|---|
| 788 | |
|---|
| 789 | def deleteUser(self, user) : |
|---|
| 790 | """Completely deletes an user from the database.""" |
|---|
| 791 | # TODO : What should we do if we delete the last person who used a given printer ? |
|---|
| 792 | # TODO : we can't reassign the last job to the previous one, because next user would be |
|---|
| 793 | # TODO : incorrectly charged (overcharged). |
|---|
| 794 | for q in [ |
|---|
| 795 | "DELETE FROM payments WHERE userid=%s" % self.doQuote(user.ident), |
|---|
| 796 | "DELETE FROM groupsmembers WHERE userid=%s" % self.doQuote(user.ident), |
|---|
| 797 | "DELETE FROM jobhistory WHERE userid=%s" % self.doQuote(user.ident), |
|---|
| 798 | "DELETE FROM userpquota WHERE userid=%s" % self.doQuote(user.ident), |
|---|
| 799 | "DELETE FROM users WHERE id=%s" % self.doQuote(user.ident), |
|---|
| 800 | ] : |
|---|
| 801 | self.doModify(q) |
|---|
| 802 | |
|---|
| 803 | def deleteInTransaction(self, queries) : |
|---|
| 804 | """Does many deletions in a single transaction.""" |
|---|
| 805 | self.beginTransaction() |
|---|
| 806 | try : |
|---|
| 807 | for q in queries : |
|---|
| 808 | self.doModify(q) |
|---|
| 809 | except : |
|---|
| 810 | self.rollbackTransaction() |
|---|
| 811 | raise |
|---|
| 812 | else : |
|---|
| 813 | self.commitTransaction() |
|---|
| 814 | |
|---|
| 815 | def deleteManyBillingCodesFromNames(self, billingcodes) : |
|---|
| 816 | """Deletes many billing codes from their names.""" |
|---|
| 817 | codelabels = ", ".join(["%s" % self.doQuote(b) for b in billingcodes]) |
|---|
| 818 | self.deleteInTransaction([ |
|---|
| 819 | "DELETE FROM billingcodes WHERE billingcode IN (%s)" % codelabels,]) |
|---|
| 820 | |
|---|
| 821 | def deleteManyUsersFromNames(self, usernames) : |
|---|
| 822 | """Deletes many users from their names.""" |
|---|
| 823 | usernames = ", ".join(["%s" % self.doQuote(u) for u in usernames]) |
|---|
| 824 | self.deleteInTransaction([ |
|---|
| 825 | "DELETE FROM payments WHERE userid IN (SELECT id FROM users WHERE username IN %s)" % usernames, |
|---|
| 826 | "DELETE FROM groupsmembers WHERE userid IN (SELECT id FROM users WHERE username IN %s)" % usernames, |
|---|
| 827 | "DELETE FROM jobhistory WHERE userid IN (SELECT id FROM users WHERE username IN %s)" % usernames, |
|---|
| 828 | "DELETE FROM userpquota WHERE userid IN (SELECT id FROM users WHERE username IN %s)" % usernames, |
|---|
| 829 | "DELETE FROM users WHERE username IN %s" % usernames,]) |
|---|
| 830 | |
|---|
| 831 | def deleteManyPrintersFromNames(self, printernames) : |
|---|
| 832 | """Deletes many printers from their names.""" |
|---|
| 833 | printernames = ", ".join(["%s" % self.doQuote(p) for p in printernames]) |
|---|
| 834 | self.deleteInTransaction([ |
|---|
| 835 | "DELETE FROM printergroupsmembers WHERE groupid=%s OR printerid=%s" % (self.doQuote(printer.ident), self.doQuote(printer.ident)), |
|---|
| 836 | "DELETE FROM jobhistory WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 837 | "DELETE FROM grouppquota WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 838 | "DELETE FROM userpquota WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 839 | "DELETE FROM printers WHERE id=%s" % self.doQuote(printer.ident),]) |
|---|
| 840 | |
|---|
| 841 | def deleteManyUserPQuotas(self, printers, users) : |
|---|
| 842 | """Deletes many user print quota entries.""" |
|---|
| 843 | printerids = ", ".join(["%s" % self.doQuote(p.ident) for p in printers]) |
|---|
| 844 | userids = ", ".join(["%s" % self.doQuote(u.ident) for u in users]) |
|---|
| 845 | self.deleteInTransaction([ |
|---|
| 846 | "DELETE FROM jobhistory WHERE userid IN (%s) AND printerid IN (%s)" \ |
|---|
| 847 | % (userids, printerids), |
|---|
| 848 | "DELETE FROM userpquota WHERE userid IN (%s) AND printerid IN (%s)" \ |
|---|
| 849 | % (userids, printerids),]) |
|---|
| 850 | |
|---|
| 851 | def deleteManyGroupPQuotas(self, printers, groups) : |
|---|
| 852 | """Deletes many group print quota entries.""" |
|---|
| 853 | printerids = ", ".join(["%s" % self.doQuote(p.ident) for p in printers]) |
|---|
| 854 | groupids = ", ".join(["%s" % self.doQuote(g.ident) for g in groups]) |
|---|
| 855 | self.deleteInTransaction([ |
|---|
| 856 | "DELETE FROM grouppquota WHERE groupid IN (%s) AND printerid IN (%s)" \ |
|---|
| 857 | % (groupids, printerids),]) |
|---|
| 858 | |
|---|
| 859 | def deleteUserPQuota(self, upquota) : |
|---|
| 860 | """Completely deletes an user print quota entry from the database.""" |
|---|
| 861 | for q in [ |
|---|
| 862 | "DELETE FROM jobhistory WHERE userid=%s AND printerid=%s" \ |
|---|
| 863 | % (self.doQuote(upquota.User.ident), self.doQuote(upquota.Printer.ident)), |
|---|
| 864 | "DELETE FROM userpquota WHERE id=%s" % self.doQuote(upquota.ident), |
|---|
| 865 | ] : |
|---|
| 866 | self.doModify(q) |
|---|
| 867 | |
|---|
| 868 | def deleteGroupPQuota(self, gpquota) : |
|---|
| 869 | """Completely deletes a group print quota entry from the database.""" |
|---|
| 870 | for q in [ |
|---|
| 871 | "DELETE FROM grouppquota WHERE id=%s" % self.doQuote(gpquota.ident), |
|---|
| 872 | ] : |
|---|
| 873 | self.doModify(q) |
|---|
| 874 | |
|---|
| 875 | def deleteGroup(self, group) : |
|---|
| 876 | """Completely deletes a group from the database.""" |
|---|
| 877 | for q in [ |
|---|
| 878 | "DELETE FROM groupsmembers WHERE groupid=%s" % self.doQuote(group.ident), |
|---|
| 879 | "DELETE FROM grouppquota WHERE groupid=%s" % self.doQuote(group.ident), |
|---|
| 880 | "DELETE FROM groups WHERE id=%s" % self.doQuote(group.ident), |
|---|
| 881 | ] : |
|---|
| 882 | self.doModify(q) |
|---|
| 883 | |
|---|
| 884 | def deletePrinter(self, printer) : |
|---|
| 885 | """Completely deletes a printer from the database.""" |
|---|
| 886 | for q in [ |
|---|
| 887 | "DELETE FROM printergroupsmembers WHERE groupid=%s OR printerid=%s" % (self.doQuote(printer.ident), self.doQuote(printer.ident)), |
|---|
| 888 | "DELETE FROM jobhistory WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 889 | "DELETE FROM grouppquota WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 890 | "DELETE FROM userpquota WHERE printerid=%s" % self.doQuote(printer.ident), |
|---|
| 891 | "DELETE FROM printers WHERE id=%s" % self.doQuote(printer.ident), |
|---|
| 892 | ] : |
|---|
| 893 | self.doModify(q) |
|---|
| 894 | |
|---|
| 895 | def deleteBillingCode(self, code) : |
|---|
| 896 | """Completely deletes a billing code from the database.""" |
|---|
| 897 | for q in [ |
|---|
| 898 | "DELETE FROM billingcodes WHERE id=%s" % self.doQuote(code.ident), |
|---|
| 899 | ] : |
|---|
| 900 | self.doModify(q) |
|---|
| 901 | |
|---|
