root / pykota / trunk / bin / dumpykota @ 2512

Revision 2512, 6.5 kB (checked in by jerome, 19 years ago)

Ensure that human made errors (like incorrect command line options)
don't produce a traceback anymore. No need to frighten users with
such complete tracebacks and email reporting each time they mistype
some command.
Makes pykosd check more carefully the values of its command line options.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
RevLine 
[1583]1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3
4# PyKota Print Quota Data Dumper
5#
6# PyKota - Print Quotas for CUPS and LPRng
7#
[2028]8# (c) 2003, 2004, 2005 Jerome Alet <alet@librelogiciel.com>
[1583]9# This program is free software; you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation; either version 2 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program; if not, write to the Free Software
[2303]21# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
[1583]22#
23# $Id$
24#
[2028]25#
[1583]26
27import sys
28import os
29
30from pykota import version
[2512]31from pykota.tool import PyKotaToolError, PyKotaCommandLineError, crashed, N_
[2016]32from pykota.dumper import DumPyKota
[1583]33
[2344]34__doc__ = N_("""dumpykota v%(__version__)s (c) %(__years__)s %(__author__)s
[1583]35
36Dumps PyKota database's content.
37
38command line usage :
39
[1991]40  dumpykota [options] [filterexpr]
[1583]41
42options :
43
[1779]44  -v | --version       Prints dumpykota's version number then exits.
[1583]45  -h | --help          Prints this message then exits.
46 
[1717]47  -d | --data type     Dumps 'type' datas. Allowed types are :
[1583]48                       
49                         - history : dumps the jobs history.
50                         - users : dumps users.
51                         - groups : dumps user groups.
52                         - printers : dump printers.
[1724]53                         - upquotas : dump user quotas.
54                         - gpquotas : dump user groups quotas.
[1717]55                         - payments : dumps user payments.
[1718]56                         - pmembers : dumps printer groups members.
57                         - umembers : dumps user groups members.
[2342]58                         - billingcodes : dumps billing codes.
[1717]59                         
60                       NB : the -d | --data command line option   
61                       is MANDATORY.
[1583]62 
63  -f | --format fmt    Dumps datas in the 'fmt' format. When not specified,
64                       the format is to dump datas in the csv format (comma
65                       separated values). All data dumped is between double
66                       quotes. Allowed formats are :
67                       
68                         - csv : separate datas with commas
69                         - ssv : separate datas with semicolons
70                         - tsv : separate datas with tabs
[1771]71                         - xml : dump data as XML
[2013]72                         - cups : dump datas in CUPS' page_log format :
73                                  ONLY AVAILABLE WITH --data history
[1771]74                         
75  -o | --output fname  All datas will be dumped to the file instead of
76                       to the standard output. The special '-' filename
77                       is the default value and means stdout.
78                       WARNING : existing files are truncated !
[2282]79
80  -s | --sum           Summarize the selected datas.
81                           ONLY AVAILABLE WITH --data history or payments
82
[1991]83  Use the filter expressions to extract only parts of the
84  datas. Allowed filters are of the form :
85               
86         key=value
87                         
88  Allowed keys for now are : 
89                       
90         username       User's name
91         groupname      Users group's name
92         printername    Printer's name
93         pgroupname     Printers group's name
[2218]94         hostname       Client's hostname
95         billingcode    Job's billing code
[2266]96         start          Job's date of printing
97         end            Job's date of printing
[1991]98         
99  Contrary to other PyKota management tools, wildcard characters are not
100  expanded, so you can't use them.
[1583]101 
[1991]102  NB : not all keys are allowed for each data type, so the result may be
103  empty if you use a key not available for a particular data type.
104 
[1771]105Examples :
106
107  $ dumpykota --data history --format csv >myfile.csv
108 
109  This dumps the history in a comma separated values file, for possible
110  use in a spreadsheet.
111 
112  $ dumpykota --data users --format xml -o users.xml
113 
114  Dumps all users datas to the users.xml file.
115 
[1991]116  $ dumpykota --data history printername=HP2100 username=jerome
[1990]117 
[1991]118  Dumps the job history for user jerome on printer HP2100 only.
[1990]119 
[2266]120  $ dumpykota --data history start=200503 end=20050730234615
121 
122  Dumps all jobs printed between March 1st 2005 at midnight and
123  July 30th 2005 at 23 hours 46 minutes and 15 secondes included.
[2344]124""")
[1583]125       
126if __name__ == "__main__" : 
[1720]127    retcode = 0
[1583]128    try :
129        defaults = { \
[1717]130                     "format" : "csv", \
[1771]131                     "output" : "-", \
[1583]132                   }
[2282]133        short_options = "vhd:f:o:s"
134        long_options = ["help", "version", "data=", "format=", "output=", "sum"]
[1583]135       
136        # Initializes the command line tool
137        dumper = DumPyKota(doc=__doc__)
[2210]138        dumper.deferredInit()
[1583]139       
140        # parse and checks the command line
141        (options, args) = dumper.parseCommandline(sys.argv[1:], short_options, long_options, allownothing=1)
142       
143        # sets long options
144        options["help"] = options["h"] or options["help"]
145        options["version"] = options["v"] or options["version"]
[1717]146        options["data"] = options["d"] or options["data"]
147        options["format"] = options["f"] or options["format"] or defaults["format"]
[1771]148        options["output"] = options["o"] or options["output"] or defaults["output"]
[2282]149        options["sum"] = options["s"] or options["sum"]
[1583]150       
151        if options["help"] :
152            dumper.display_usage_and_quit()
153        elif options["version"] :
154            dumper.display_version_and_quit()
[1717]155        elif options["data"] is None :   
[2512]156            raise PyKotaCommandLineError, _("The -d | --data command line option is mandatory, see help.")
[1583]157        else :
158            retcode = dumper.main(args, options)
[2216]159    except KeyboardInterrupt :       
160        sys.stderr.write("\nInterrupted with Ctrl+C !\n")
[2512]161    except PyKotaCommandLineError, msg :   
162        sys.stderr.write("%s : %s\n" % (sys.argv[0], msg))
[1583]163    except SystemExit :       
164        pass
165    except :
166        try :
[1717]167            dumper.crashed("dumpykota failed")
[1583]168        except :   
[1720]169            crashed("dumpykota failed")
[1583]170        retcode = -1
171
172    try :
173        dumper.storage.close()
174    except (TypeError, NameError, AttributeError) :   
175        pass
176       
177    sys.exit(retcode)   
Note: See TracBrowser for help on using the browser.