[3411] | 1 | # -*- coding: utf-8 -*-*- |
---|
[695] | 2 | # |
---|
[3260] | 3 | # PyKota : Print Quotas for CUPS |
---|
| 4 | # |
---|
[3275] | 5 | # (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> |
---|
[3260] | 6 | # This program is free software: you can redistribute it and/or modify |
---|
[873] | 7 | # it under the terms of the GNU General Public License as published by |
---|
[3260] | 8 | # the Free Software Foundation, either version 3 of the License, or |
---|
[873] | 9 | # (at your option) any later version. |
---|
[3413] | 10 | # |
---|
[873] | 11 | # This program is distributed in the hope that it will be useful, |
---|
| 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 14 | # GNU General Public License for more details. |
---|
[3413] | 15 | # |
---|
[873] | 16 | # You should have received a copy of the GNU General Public License |
---|
[3260] | 17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
---|
[695] | 18 | # |
---|
| 19 | # $Id$ |
---|
| 20 | # |
---|
[2093] | 21 | # |
---|
[695] | 22 | |
---|
[3184] | 23 | """This module defines the base classes for PyKota command line tools.""" |
---|
| 24 | |
---|
[695] | 25 | import sys |
---|
[1193] | 26 | import os |
---|
[1960] | 27 | import pwd |
---|
[817] | 28 | import fnmatch |
---|
[715] | 29 | import getopt |
---|
[695] | 30 | import smtplib |
---|
[782] | 31 | import locale |
---|
[1469] | 32 | import socket |
---|
[2783] | 33 | import time |
---|
[2643] | 34 | from email.MIMEText import MIMEText |
---|
| 35 | from email.Header import Header |
---|
[3013] | 36 | import email.Utils |
---|
[695] | 37 | |
---|
[708] | 38 | from mx import DateTime |
---|
| 39 | |
---|
[3295] | 40 | from pykota import utils |
---|
[3288] | 41 | from pykota.errors import PyKotaCommandLineError |
---|
[2830] | 42 | from pykota import config, storage, logger |
---|
[2344] | 43 | from pykota.version import __version__, __author__, __years__, __gplblurb__ |
---|
[695] | 44 | |
---|
[2782] | 45 | class Percent : |
---|
| 46 | """A class to display progress.""" |
---|
[2783] | 47 | def __init__(self, app, size=None) : |
---|
[2782] | 48 | """Initializes the engine.""" |
---|
[3429] | 49 | self.isatty = sys.stdout.isatty() |
---|
[2782] | 50 | self.app = app |
---|
[2783] | 51 | self.size = None |
---|
| 52 | if size : |
---|
| 53 | self.setSize(size) |
---|
| 54 | self.previous = None |
---|
| 55 | self.before = time.time() |
---|
[3413] | 56 | |
---|
| 57 | def setSize(self, size) : |
---|
[2783] | 58 | """Sets the total size.""" |
---|
| 59 | self.number = 0 |
---|
[2782] | 60 | self.size = size |
---|
[2793] | 61 | if size : |
---|
| 62 | self.factor = 100.0 / float(size) |
---|
[3413] | 63 | |
---|
| 64 | def display(self, msg) : |
---|
[2782] | 65 | """Displays the value.""" |
---|
[3429] | 66 | if self.isatty : |
---|
| 67 | self.app.display(msg) |
---|
| 68 | sys.stdout.flush() |
---|
[3413] | 69 | |
---|
| 70 | def oneMore(self) : |
---|
[2782] | 71 | """Increments internal counter.""" |
---|
[2783] | 72 | if self.size : |
---|
| 73 | self.number += 1 |
---|
| 74 | percent = "%.02f" % (float(self.number) * self.factor) |
---|
| 75 | if percent != self.previous : # optimize for large number of items |
---|
| 76 | self.display("\r%s%%" % percent) |
---|
| 77 | self.previous = percent |
---|
[3413] | 78 | |
---|
| 79 | def done(self) : |
---|
[2782] | 80 | """Displays the 'done' message.""" |
---|
[2783] | 81 | after = time.time() |
---|
| 82 | if self.size : |
---|
[3251] | 83 | try : |
---|
[3286] | 84 | speed = self.size / ((after - self.before) + 0.00000000001) # adds an epsilon to avoid an user's problem I can't reproduce... |
---|
[3413] | 85 | except ZeroDivisionError : |
---|
[3271] | 86 | speed = 1 # Fake value in case of division by zero, shouldn't happen anyway with the epsilon above... |
---|
[2788] | 87 | self.display("\r100.00%%\r \r%s. %s : %.2f %s.\n" \ |
---|
[2783] | 88 | % (_("Done"), _("Average speed"), speed, _("entries per second"))) |
---|
[3413] | 89 | else : |
---|
[2783] | 90 | self.display("\r100.00%%\r \r%s.\n" % _("Done")) |
---|
[3413] | 91 | |
---|
[1911] | 92 | class Tool : |
---|
| 93 | """Base class for tools with no database access.""" |
---|
[3295] | 94 | def __init__(self, doc="PyKota v%(__version__)s (c) %(__years__)s %(__author__)s") : |
---|
[695] | 95 | """Initializes the command line tool.""" |
---|
[3187] | 96 | self.debug = True # in case of early failure |
---|
[3188] | 97 | self.logger = logger.openLogger("stderr") |
---|
[3413] | 98 | |
---|
[3294] | 99 | # Saves a copy of the locale settings |
---|
[3055] | 100 | (self.language, self.charset) = locale.getlocale() |
---|
[3298] | 101 | if not self.language : |
---|
| 102 | self.language = "C" |
---|
[3295] | 103 | if not self.charset : |
---|
| 104 | self.charset = "UTF-8" |
---|
[3413] | 105 | |
---|
[772] | 106 | # pykota specific stuff |
---|
[715] | 107 | self.documentation = doc |
---|
[3413] | 108 | |
---|
[3276] | 109 | # Extract the effective username |
---|
| 110 | uid = os.geteuid() |
---|
| 111 | try : |
---|
| 112 | self.effectiveUserName = pwd.getpwuid(uid)[0] |
---|
[3413] | 113 | except (KeyError, IndexError), msg : |
---|
[3276] | 114 | self.printInfo(_("Strange problem with uid(%s) : %s") % (uid, msg), "warn") |
---|
| 115 | self.effectiveUserName = os.getlogin() |
---|
[3413] | 116 | |
---|
| 117 | def deferredInit(self) : |
---|
[2210] | 118 | """Deferred initialization.""" |
---|
[3045] | 119 | confdir = os.environ.get("PYKOTA_HOME") |
---|
| 120 | environHome = True |
---|
| 121 | missingUser = False |
---|
| 122 | if confdir is None : |
---|
| 123 | environHome = False |
---|
| 124 | # check for config files in the 'pykota' user's home directory. |
---|
| 125 | try : |
---|
| 126 | self.pykotauser = pwd.getpwnam("pykota") |
---|
| 127 | confdir = self.pykotauser[5] |
---|
[3413] | 128 | except KeyError : |
---|
[3045] | 129 | self.pykotauser = None |
---|
| 130 | confdir = "/etc/pykota" |
---|
| 131 | missingUser = True |
---|
[3413] | 132 | |
---|
[2210] | 133 | self.config = config.PyKotaConfig(confdir) |
---|
| 134 | self.debug = self.config.getDebug() |
---|
| 135 | self.smtpserver = self.config.getSMTPServer() |
---|
| 136 | self.maildomain = self.config.getMailDomain() |
---|
| 137 | self.logger = logger.openLogger(self.config.getLoggingBackend()) |
---|
[3413] | 138 | |
---|
| 139 | # TODO : We NEED this here, even when not in an accounting filter/backend |
---|
[1497] | 140 | self.softwareJobSize = 0 |
---|
[1495] | 141 | self.softwareJobPrice = 0.0 |
---|
[3413] | 142 | |
---|
[3045] | 143 | if environHome : |
---|
| 144 | self.printInfo("PYKOTA_HOME environment variable is set. Configuration files were searched in %s" % confdir, "info") |
---|
| 145 | else : |
---|
[3413] | 146 | if missingUser : |
---|
[3045] | 147 | self.printInfo("The 'pykota' system account is missing. Configuration files were searched in %s instead." % confdir, "warn") |
---|
[3413] | 148 | |
---|
[3055] | 149 | self.logdebug("Language in use : %s" % self.language) |
---|
[1761] | 150 | self.logdebug("Charset in use : %s" % self.charset) |
---|
[3413] | 151 | |
---|
[1872] | 152 | arguments = " ".join(['"%s"' % arg for arg in sys.argv]) |
---|
| 153 | self.logdebug("Command line arguments : %s" % arguments) |
---|
[3413] | 154 | |
---|
[2657] | 155 | def display(self, message) : |
---|
[3429] | 156 | """Display a message after ensuring the correct charset is used.""" |
---|
| 157 | sys.stdout.write(message.encode(self.charset, |
---|
[3287] | 158 | "replace")) |
---|
[3413] | 159 | |
---|
| 160 | def logdebug(self, message) : |
---|
[1130] | 161 | """Logs something to debug output if debug is enabled.""" |
---|
| 162 | if self.debug : |
---|
[3298] | 163 | self.logger.log_message(message.encode(self.charset, \ |
---|
[3287] | 164 | "replace"), \ |
---|
| 165 | "debug") |
---|
[3413] | 166 | |
---|
| 167 | def printInfo(self, message, level="info") : |
---|
[1582] | 168 | """Sends a message to standard error.""" |
---|
[3287] | 169 | sys.stderr.write("%s: %s\n" % (level.upper(), \ |
---|
[3298] | 170 | message.encode(self.charset, \ |
---|
[3287] | 171 | "replace"))) |
---|
[1582] | 172 | sys.stderr.flush() |
---|
[3413] | 173 | |
---|
[3367] | 174 | def adminOnly(self, restricted=True) : |
---|
| 175 | """Raises an exception if the user is not a PyKota administrator.""" |
---|
| 176 | if restricted and not self.config.isAdmin : |
---|
| 177 | raise PyKotaCommandLineError, "%s : %s" % (pwd.getpwuid(os.geteuid())[0], _("You're not allowed to use this command.")) |
---|
[3413] | 178 | |
---|
[2210] | 179 | def matchString(self, s, patterns) : |
---|
[2650] | 180 | """Returns True if the string s matches one of the patterns, else False.""" |
---|
| 181 | if not patterns : |
---|
| 182 | return True # No pattern, always matches. |
---|
[3413] | 183 | else : |
---|
[2650] | 184 | for pattern in patterns : |
---|
| 185 | if fnmatch.fnmatchcase(s, pattern) : |
---|
| 186 | return True |
---|
| 187 | return False |
---|
[3413] | 188 | |
---|
[2762] | 189 | def sanitizeNames(self, options, names) : |
---|
| 190 | """Ensures that an user can only see the datas he is allowed to see, by modifying the list of names.""" |
---|
| 191 | if not self.config.isAdmin : |
---|
| 192 | username = pwd.getpwuid(os.geteuid())[0] |
---|
| 193 | if not options["list"] : |
---|
| 194 | raise PyKotaCommandLineError, "%s : %s" % (username, _("You're not allowed to use this command.")) |
---|
| 195 | else : |
---|
| 196 | if options["groups"] : |
---|
| 197 | user = self.storage.getUser(username) |
---|
| 198 | if user.Exists : |
---|
| 199 | return [ g.Name for g in self.storage.getUserGroups(user) ] |
---|
| 200 | return [ username ] |
---|
[3413] | 201 | elif not names : |
---|
[2762] | 202 | return ["*"] |
---|
[3413] | 203 | else : |
---|
[2762] | 204 | return names |
---|
[3413] | 205 | |
---|
[715] | 206 | def display_version_and_quit(self) : |
---|
| 207 | """Displays version number, then exists successfully.""" |
---|
[1923] | 208 | try : |
---|
| 209 | self.clean() |
---|
[3413] | 210 | except AttributeError : |
---|
[1923] | 211 | pass |
---|
[3430] | 212 | self.display("%s\n" % __version__) |
---|
[715] | 213 | sys.exit(0) |
---|
[3413] | 214 | |
---|
[715] | 215 | def display_usage_and_quit(self) : |
---|
| 216 | """Displays command line usage, then exists successfully.""" |
---|
[1923] | 217 | try : |
---|
| 218 | self.clean() |
---|
[3413] | 219 | except AttributeError : |
---|
[1923] | 220 | pass |
---|
[3430] | 221 | self.display("%s\n" % (_(self.documentation) % globals())) |
---|
| 222 | self.display("%s\n\n" % __gplblurb__) |
---|
| 223 | self.display("%s %s\n" % (_("Please report bugs to :"), __author__)) |
---|
[715] | 224 | sys.exit(0) |
---|
[3413] | 225 | |
---|
| 226 | def crashed(self, message="Bug in PyKota") : |
---|
[1517] | 227 | """Outputs a crash message, and optionally sends it to software author.""" |
---|
[3295] | 228 | msg = utils.crashed(message) |
---|
[2229] | 229 | fullmessage = "========== Traceback :\n\n%s\n\n========== sys.argv :\n\n%s\n\n========== Environment :\n\n%s\n" % \ |
---|
| 230 | (msg, \ |
---|
| 231 | "\n".join([" %s" % repr(a) for a in sys.argv]), \ |
---|
[3317] | 232 | "\n".join([" %s=%s" % (k, repr(v)) for (k, v) in os.environ.items()])) |
---|
[1541] | 233 | try : |
---|
| 234 | crashrecipient = self.config.getCrashRecipient() |
---|
| 235 | if crashrecipient : |
---|
[1517] | 236 | admin = self.config.getAdminMail("global") # Nice trick, isn't it ? |
---|
| 237 | server = smtplib.SMTP(self.smtpserver) |
---|
[3317] | 238 | msg = MIMEText(fullmessage.encode(self.charset, "replace"), _charset=self.charset) |
---|
[3136] | 239 | msg["Subject"] = Header("PyKota v%s crash traceback !" \ |
---|
[3300] | 240 | % __version__, charset=self.charset, errors="replace") |
---|
[2795] | 241 | msg["From"] = admin |
---|
| 242 | msg["To"] = crashrecipient |
---|
| 243 | msg["Cc"] = admin |
---|
[3013] | 244 | msg["Date"] = email.Utils.formatdate(localtime=True) |
---|
[2795] | 245 | server.sendmail(admin, [admin, crashrecipient], msg.as_string()) |
---|
[1517] | 246 | server.quit() |
---|
[1541] | 247 | except : |
---|
[3317] | 248 | self.printInfo("PyKota double crash !", "error") |
---|
| 249 | raise |
---|
[3413] | 250 | return fullmessage |
---|
| 251 | |
---|
[729] | 252 | def parseCommandline(self, argv, short, long, allownothing=0) : |
---|
[715] | 253 | """Parses the command line, controlling options.""" |
---|
| 254 | # split options in two lists: those which need an argument, those which don't need any |
---|
[2605] | 255 | short = "%sA:" % short |
---|
| 256 | long.append("arguments=") |
---|
[715] | 257 | withoutarg = [] |
---|
| 258 | witharg = [] |
---|
| 259 | lgs = len(short) |
---|
| 260 | i = 0 |
---|
| 261 | while i < lgs : |
---|
| 262 | ii = i + 1 |
---|
| 263 | if (ii < lgs) and (short[ii] == ':') : |
---|
| 264 | # needs an argument |
---|
| 265 | witharg.append(short[i]) |
---|
| 266 | ii = ii + 1 # skip the ':' |
---|
| 267 | else : |
---|
| 268 | # doesn't need an argument |
---|
| 269 | withoutarg.append(short[i]) |
---|
| 270 | i = ii |
---|
[3413] | 271 | |
---|
[715] | 272 | for option in long : |
---|
| 273 | if option[-1] == '=' : |
---|
| 274 | # needs an argument |
---|
| 275 | witharg.append(option[:-1]) |
---|
| 276 | else : |
---|
| 277 | # doesn't need an argument |
---|
| 278 | withoutarg.append(option) |
---|
[3413] | 279 | |
---|
[715] | 280 | # then we parse the command line |
---|
[2605] | 281 | done = 0 |
---|
| 282 | while not done : |
---|
| 283 | # we begin with all possible options unset |
---|
| 284 | parsed = {} |
---|
| 285 | for option in withoutarg + witharg : |
---|
| 286 | parsed[option] = None |
---|
| 287 | args = [] # to not break if something unexpected happened |
---|
| 288 | try : |
---|
| 289 | options, args = getopt.getopt(argv, short, long) |
---|
| 290 | if options : |
---|
| 291 | for (o, v) in options : |
---|
| 292 | # we skip the '-' chars |
---|
| 293 | lgo = len(o) |
---|
| 294 | i = 0 |
---|
| 295 | while (i < lgo) and (o[i] == '-') : |
---|
| 296 | i = i + 1 |
---|
| 297 | o = o[i:] |
---|
| 298 | if o in witharg : |
---|
| 299 | # needs an argument : set it |
---|
| 300 | parsed[o] = v |
---|
| 301 | elif o in withoutarg : |
---|
| 302 | # doesn't need an argument : boolean |
---|
| 303 | parsed[o] = 1 |
---|
| 304 | else : |
---|
| 305 | # should never occur |
---|
[2610] | 306 | raise PyKotaCommandLineError, "Unexpected problem when parsing command line" |
---|
[2605] | 307 | elif (not args) and (not allownothing) and sys.stdin.isatty() : # no option and no argument, we display help if we are a tty |
---|
| 308 | self.display_usage_and_quit() |
---|
| 309 | except getopt.error, msg : |
---|
[2610] | 310 | raise PyKotaCommandLineError, str(msg) |
---|
[3413] | 311 | else : |
---|
[2605] | 312 | if parsed["arguments"] or parsed["A"] : |
---|
| 313 | # arguments are in a file, we ignore all other arguments |
---|
| 314 | # and reset the list of arguments to the lines read from |
---|
| 315 | # the file. |
---|
[3294] | 316 | argsfile = open(parsed["arguments"] or parsed["A"], "r") # TODO : charset decoding |
---|
[2605] | 317 | argv = [ l.strip() for l in argsfile.readlines() ] |
---|
| 318 | argsfile.close() |
---|
| 319 | for i in range(len(argv)) : |
---|
| 320 | argi = argv[i] |
---|
| 321 | if argi.startswith('"') and argi.endswith('"') : |
---|
| 322 | argv[i] = argi[1:-1] |
---|
[3413] | 323 | else : |
---|
[2605] | 324 | done = 1 |
---|
[715] | 325 | return (parsed, args) |
---|
[3413] | 326 | |
---|
| 327 | class PyKotaTool(Tool) : |
---|
[1911] | 328 | """Base class for all PyKota command line tools.""" |
---|
[3413] | 329 | def deferredInit(self) : |
---|
[2210] | 330 | """Deferred initialization.""" |
---|
| 331 | Tool.deferredInit(self) |
---|
| 332 | self.storage = storage.openConnection(self) |
---|
| 333 | if self.config.isAdmin : # TODO : We don't know this before, fix this ! |
---|
| 334 | self.logdebug("Beware : running as a PyKota administrator !") |
---|
[3413] | 335 | else : |
---|
[2210] | 336 | self.logdebug("Don't Panic : running as a mere mortal !") |
---|
[3413] | 337 | |
---|
| 338 | def clean(self) : |
---|
[1911] | 339 | """Ensures that the database is closed.""" |
---|
| 340 | try : |
---|
| 341 | self.storage.close() |
---|
[3413] | 342 | except (TypeError, NameError, AttributeError) : |
---|
[1911] | 343 | pass |
---|
[3413] | 344 | |
---|
[764] | 345 | def isValidName(self, name) : |
---|
| 346 | """Checks if a user or printer name is valid.""" |
---|
[1725] | 347 | invalidchars = "/@?*,;&|" |
---|
[1637] | 348 | for c in list(invalidchars) : |
---|
[1593] | 349 | if c in name : |
---|
[1394] | 350 | return 0 |
---|
[3413] | 351 | return 1 |
---|
| 352 | |
---|
| 353 | def _checkUserPQuota(self, userpquota) : |
---|
[1365] | 354 | """Checks the user quota on a printer and deny or accept the job.""" |
---|
| 355 | # then we check the user's own quota |
---|
| 356 | # if we get there we are sure that policy is not EXTERNAL |
---|
| 357 | user = userpquota.User |
---|
| 358 | printer = userpquota.Printer |
---|
[1495] | 359 | enforcement = self.config.getPrinterEnforcement(printer.Name) |
---|
[1365] | 360 | self.logdebug("Checking user %s's quota on printer %s" % (user.Name, printer.Name)) |
---|
| 361 | (policy, dummy) = self.config.getPrinterPolicy(userpquota.Printer.Name) |
---|
| 362 | if not userpquota.Exists : |
---|
[3413] | 363 | # Unknown userquota |
---|
[1365] | 364 | if policy == "ALLOW" : |
---|
| 365 | action = "POLICY_ALLOW" |
---|
[3413] | 366 | else : |
---|
[1365] | 367 | action = "POLICY_DENY" |
---|
[1584] | 368 | self.printInfo(_("Unable to match user %s on printer %s, applying default policy (%s)") % (user.Name, printer.Name, action)) |
---|
[3413] | 369 | else : |
---|
[1365] | 370 | pagecounter = int(userpquota.PageCounter or 0) |
---|
[1495] | 371 | if enforcement == "STRICT" : |
---|
| 372 | pagecounter += self.softwareJobSize |
---|
[1365] | 373 | if userpquota.SoftLimit is not None : |
---|
| 374 | softlimit = int(userpquota.SoftLimit) |
---|
| 375 | if pagecounter < softlimit : |
---|
| 376 | action = "ALLOW" |
---|
[3413] | 377 | else : |
---|
[1365] | 378 | if userpquota.HardLimit is None : |
---|
| 379 | # only a soft limit, this is equivalent to having only a hard limit |
---|
| 380 | action = "DENY" |
---|
[3413] | 381 | else : |
---|
[1365] | 382 | hardlimit = int(userpquota.HardLimit) |
---|
[3413] | 383 | if softlimit <= pagecounter < hardlimit : |
---|
[1365] | 384 | now = DateTime.now() |
---|
| 385 | if userpquota.DateLimit is not None : |
---|
[3050] | 386 | datelimit = DateTime.ISO.ParseDateTime(str(userpquota.DateLimit)[:19]) |
---|
[1365] | 387 | else : |
---|
| 388 | datelimit = now + self.config.getGraceDelay(printer.Name) |
---|
| 389 | userpquota.setDateLimit(datelimit) |
---|
| 390 | if now < datelimit : |
---|
| 391 | action = "WARN" |
---|
[3413] | 392 | else : |
---|
[1365] | 393 | action = "DENY" |
---|
[3413] | 394 | else : |
---|
[1365] | 395 | action = "DENY" |
---|
[3413] | 396 | else : |
---|
[1365] | 397 | if userpquota.HardLimit is not None : |
---|
| 398 | # no soft limit, only a hard one. |
---|
| 399 | hardlimit = int(userpquota.HardLimit) |
---|
| 400 | if pagecounter < hardlimit : |
---|
| 401 | action = "ALLOW" |
---|
[3413] | 402 | else : |
---|
[1365] | 403 | action = "DENY" |
---|
| 404 | else : |
---|
| 405 | # Both are unset, no quota, i.e. accounting only |
---|
| 406 | action = "ALLOW" |
---|
| 407 | return action |
---|
[3413] | 408 | |
---|
| 409 | def checkGroupPQuota(self, grouppquota) : |
---|
[927] | 410 | """Checks the group quota on a printer and deny or accept the job.""" |
---|
[1041] | 411 | group = grouppquota.Group |
---|
| 412 | printer = grouppquota.Printer |
---|
[1495] | 413 | enforcement = self.config.getPrinterEnforcement(printer.Name) |
---|
[1365] | 414 | self.logdebug("Checking group %s's quota on printer %s" % (group.Name, printer.Name)) |
---|
[3413] | 415 | if group.LimitBy and (group.LimitBy.lower() == "balance") : |
---|
[1666] | 416 | val = group.AccountBalance or 0.0 |
---|
[3413] | 417 | if enforcement == "STRICT" : |
---|
[1495] | 418 | val -= self.softwareJobPrice # use precomputed size. |
---|
[2692] | 419 | balancezero = self.config.getBalanceZero() |
---|
| 420 | if val <= balancezero : |
---|
[1041] | 421 | action = "DENY" |
---|
[3413] | 422 | elif val <= self.config.getPoorMan() : |
---|
[1077] | 423 | action = "WARN" |
---|
[3413] | 424 | else : |
---|
[1041] | 425 | action = "ALLOW" |
---|
[2692] | 426 | if (enforcement == "STRICT") and (val == balancezero) : |
---|
[1529] | 427 | action = "WARN" # we can still print until account is 0 |
---|
[927] | 428 | else : |
---|
[1665] | 429 | val = grouppquota.PageCounter or 0 |
---|
[1495] | 430 | if enforcement == "STRICT" : |
---|
[2992] | 431 | val += int(self.softwareJobSize) # TODO : this is not a fix, problem is elsewhere in grouppquota.PageCounter |
---|
[1041] | 432 | if grouppquota.SoftLimit is not None : |
---|
| 433 | softlimit = int(grouppquota.SoftLimit) |
---|
[1495] | 434 | if val < softlimit : |
---|
[1041] | 435 | action = "ALLOW" |
---|
[3413] | 436 | else : |
---|
[1041] | 437 | if grouppquota.HardLimit is None : |
---|
| 438 | # only a soft limit, this is equivalent to having only a hard limit |
---|
| 439 | action = "DENY" |
---|
[3413] | 440 | else : |
---|
[1041] | 441 | hardlimit = int(grouppquota.HardLimit) |
---|
[3413] | 442 | if softlimit <= val < hardlimit : |
---|
[1041] | 443 | now = DateTime.now() |
---|
| 444 | if grouppquota.DateLimit is not None : |
---|
[3050] | 445 | datelimit = DateTime.ISO.ParseDateTime(str(grouppquota.DateLimit)[:19]) |
---|
[1041] | 446 | else : |
---|
| 447 | datelimit = now + self.config.getGraceDelay(printer.Name) |
---|
| 448 | grouppquota.setDateLimit(datelimit) |
---|
| 449 | if now < datelimit : |
---|
| 450 | action = "WARN" |
---|
[3413] | 451 | else : |
---|
[927] | 452 | action = "DENY" |
---|
[3413] | 453 | else : |
---|
[927] | 454 | action = "DENY" |
---|
[3413] | 455 | else : |
---|
[1041] | 456 | if grouppquota.HardLimit is not None : |
---|
| 457 | # no soft limit, only a hard one. |
---|
| 458 | hardlimit = int(grouppquota.HardLimit) |
---|
[1495] | 459 | if val < hardlimit : |
---|
[927] | 460 | action = "ALLOW" |
---|
[3413] | 461 | else : |
---|
[1041] | 462 | action = "DENY" |
---|
| 463 | else : |
---|
| 464 | # Both are unset, no quota, i.e. accounting only |
---|
| 465 | action = "ALLOW" |
---|
[927] | 466 | return action |
---|
[3413] | 467 | |
---|
[1041] | 468 | def checkUserPQuota(self, userpquota) : |
---|
[1365] | 469 | """Checks the user quota on a printer and all its parents and deny or accept the job.""" |
---|
[1041] | 470 | user = userpquota.User |
---|
| 471 | printer = userpquota.Printer |
---|
[3413] | 472 | |
---|
[1365] | 473 | # indicates that a warning needs to be sent |
---|
[3413] | 474 | warned = 0 |
---|
| 475 | |
---|
[927] | 476 | # first we check any group the user is a member of |
---|
[1041] | 477 | for group in self.storage.getUserGroups(user) : |
---|
[2452] | 478 | # No need to check anything if the group is in noquota mode |
---|
| 479 | if group.LimitBy != "noquota" : |
---|
| 480 | grouppquota = self.storage.getGroupPQuota(group, printer) |
---|
| 481 | # for the printer and all its parents |
---|
| 482 | for gpquota in [ grouppquota ] + grouppquota.ParentPrintersGroupPQuota : |
---|
| 483 | if gpquota.Exists : |
---|
| 484 | action = self.checkGroupPQuota(gpquota) |
---|
| 485 | if action == "DENY" : |
---|
| 486 | return action |
---|
[3413] | 487 | elif action == "WARN" : |
---|
[2452] | 488 | warned = 1 |
---|
[3413] | 489 | |
---|
[1365] | 490 | # Then we check the user's account balance |
---|
[1152] | 491 | # if we get there we are sure that policy is not EXTERNAL |
---|
| 492 | (policy, dummy) = self.config.getPrinterPolicy(printer.Name) |
---|
[3413] | 493 | if user.LimitBy and (user.LimitBy.lower() == "balance") : |
---|
[1365] | 494 | self.logdebug("Checking account balance for user %s" % user.Name) |
---|
[1041] | 495 | if user.AccountBalance is None : |
---|
[956] | 496 | if policy == "ALLOW" : |
---|
[925] | 497 | action = "POLICY_ALLOW" |
---|
[3413] | 498 | else : |
---|
[925] | 499 | action = "POLICY_DENY" |
---|
[1584] | 500 | self.printInfo(_("Unable to find user %s's account balance, applying default policy (%s) for printer %s") % (user.Name, action, printer.Name)) |
---|
[3413] | 501 | return action |
---|
| 502 | else : |
---|
[2054] | 503 | if user.OverCharge == 0.0 : |
---|
| 504 | self.printInfo(_("User %s will not be charged for printing.") % user.Name) |
---|
| 505 | action = "ALLOW" |
---|
[1529] | 506 | else : |
---|
[2054] | 507 | val = float(user.AccountBalance or 0.0) |
---|
| 508 | enforcement = self.config.getPrinterEnforcement(printer.Name) |
---|
[3413] | 509 | if enforcement == "STRICT" : |
---|
[2054] | 510 | val -= self.softwareJobPrice # use precomputed size. |
---|
[3413] | 511 | balancezero = self.config.getBalanceZero() |
---|
[2692] | 512 | if val <= balancezero : |
---|
[2054] | 513 | action = "DENY" |
---|
[3413] | 514 | elif val <= self.config.getPoorMan() : |
---|
[2054] | 515 | action = "WARN" |
---|
| 516 | else : |
---|
| 517 | action = "ALLOW" |
---|
[2692] | 518 | if (enforcement == "STRICT") and (val == balancezero) : |
---|
[2054] | 519 | action = "WARN" # we can still print until account is 0 |
---|
[3413] | 520 | return action |
---|
[925] | 521 | else : |
---|
[3413] | 522 | # Then check the user quota on current printer and all its parents. |
---|
[1365] | 523 | policyallowed = 0 |
---|
[3413] | 524 | for upquota in [ userpquota ] + userpquota.ParentPrintersUserPQuota : |
---|
[1365] | 525 | action = self._checkUserPQuota(upquota) |
---|
| 526 | if action in ("DENY", "POLICY_DENY") : |
---|
| 527 | return action |
---|
[3413] | 528 | elif action == "WARN" : |
---|
[1365] | 529 | warned = 1 |
---|
[3413] | 530 | elif action == "POLICY_ALLOW" : |
---|
[1365] | 531 | policyallowed = 1 |
---|
[3413] | 532 | if warned : |
---|
[1365] | 533 | return "WARN" |
---|
[3413] | 534 | elif policyallowed : |
---|
| 535 | return "POLICY_ALLOW" |
---|
| 536 | else : |
---|
[1365] | 537 | return "ALLOW" |
---|
[3413] | 538 | |
---|
[1196] | 539 | def externalMailTo(self, cmd, action, user, printer, message) : |
---|
[1192] | 540 | """Warns the user with an external command.""" |
---|
| 541 | username = user.Name |
---|
[1196] | 542 | printername = printer.Name |
---|
[1192] | 543 | email = user.Email or user.Name |
---|
| 544 | if "@" not in email : |
---|
[1353] | 545 | email = "%s@%s" % (email, self.maildomain or self.smtpserver) |
---|
[1192] | 546 | os.system(cmd % locals()) |
---|
[3413] | 547 | |
---|
[1196] | 548 | def formatCommandLine(self, cmd, user, printer) : |
---|
| 549 | """Executes an external command.""" |
---|
| 550 | username = user.Name |
---|
| 551 | printername = printer.Name |
---|
| 552 | return cmd % locals() |
---|