]> git.decadent.org.uk Git - dak.git/blob - dak/queue_report.py
dinstall
[dak.git] / dak / queue_report.py
1 #!/usr/bin/env python
2
3 """ Produces a report on NEW and BYHAND packages """
4 # Copyright (C) 2001, 2002, 2003, 2005, 2006  James Troup <james@nocrew.org>
5
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10
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.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20 ################################################################################
21
22 # <o-o> XP runs GCC, XFREE86, SSH etc etc,.,, I feel almost like linux....
23 # <o-o> I am very confident that I can replicate any Linux application on XP
24 # <willy> o-o: *boggle*
25 # <o-o> building from source.
26 # <o-o> Viiru: I already run GIMP under XP
27 # <willy> o-o: why do you capitalise the names of all pieces of software?
28 # <o-o> willy: because I want the EMPHASIZE them....
29 # <o-o> grr s/the/to/
30 # <willy> o-o: it makes you look like ZIPPY the PINHEAD
31 # <o-o> willy: no idea what you are talking about.
32 # <willy> o-o: do some research
33 # <o-o> willy: for what reason?
34
35 ################################################################################
36
37 from copy import copy
38 import glob, os, stat, sys, time
39 import apt_pkg
40
41 from daklib import utils
42 from daklib.queue import Upload
43 from daklib.dbconn import DBConn, has_new_comment
44 from daklib.textutils import fix_maintainer
45 from daklib.dak_exceptions import *
46
47 Cnf = None
48 direction = []
49 row_number = 0
50
51 ################################################################################
52
53 def usage(exit_code=0):
54     print """Usage: dak queue-report
55 Prints a report of packages in queue directories (usually new and byhand).
56
57   -h, --help                show this help and exit.
58   -8, --822                 writes 822 formated output to the location set in dak.conf
59   -n, --new                 produce html-output
60   -s, --sort=key            sort output according to key, see below.
61   -a, --age=key             if using sort by age, how should time be treated?
62                             If not given a default of hours will be used.
63   -d, --directories=key     A comma seperated list of queues to be scanned
64
65      Sorting Keys: ao=age,   oldest first.   an=age,   newest first.
66                    na=name,  ascending       nd=name,  descending
67                    nf=notes, first           nl=notes, last
68
69      Age Keys: m=minutes, h=hours, d=days, w=weeks, o=months, y=years
70
71 """
72     sys.exit(exit_code)
73
74 ################################################################################
75
76 def plural(x):
77     if x > 1:
78         return "s"
79     else:
80         return ""
81
82 ################################################################################
83
84 def time_pp(x):
85     if x < 60:
86         unit="second"
87     elif x < 3600:
88         x /= 60
89         unit="minute"
90     elif x < 86400:
91         x /= 3600
92         unit="hour"
93     elif x < 604800:
94         x /= 86400
95         unit="day"
96     elif x < 2419200:
97         x /= 604800
98         unit="week"
99     elif x < 29030400:
100         x /= 2419200
101         unit="month"
102     else:
103         x /= 29030400
104         unit="year"
105     x = int(x)
106     return "%s %s%s" % (x, unit, plural(x))
107
108 ################################################################################
109
110 def sg_compare (a, b):
111     a = a[1]
112     b = b[1]
113     """Sort by have note, time of oldest upload."""
114     # Sort by have note
115     a_note_state = a["note_state"]
116     b_note_state = b["note_state"]
117     if a_note_state < b_note_state:
118         return -1
119     elif a_note_state > b_note_state:
120         return 1
121
122     # Sort by time of oldest upload
123     return cmp(a["oldest"], b["oldest"])
124
125 ############################################################
126
127 def sortfunc(a,b):
128     for sorting in direction:
129         (sortkey, way, time) = sorting
130         ret = 0
131         if time == "m":
132             x=int(a[sortkey]/60)
133             y=int(b[sortkey]/60)
134         elif time == "h":
135             x=int(a[sortkey]/3600)
136             y=int(b[sortkey]/3600)
137         elif time == "d":
138             x=int(a[sortkey]/86400)
139             y=int(b[sortkey]/86400)
140         elif time == "w":
141             x=int(a[sortkey]/604800)
142             y=int(b[sortkey]/604800)
143         elif time == "o":
144             x=int(a[sortkey]/2419200)
145             y=int(b[sortkey]/2419200)
146         elif time == "y":
147             x=int(a[sortkey]/29030400)
148             y=int(b[sortkey]/29030400)
149         else:
150             x=a[sortkey]
151             y=b[sortkey]
152         if x < y:
153             ret = -1
154         elif x > y:
155             ret = 1
156         if ret != 0:
157             if way < 0:
158                 ret = ret*-1
159             return ret
160     return 0
161
162 ############################################################
163
164 def header():
165     print """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
166 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
167 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
168   <head>
169     <meta http-equiv="content-type" content="text/xhtml+xml; charset=utf-8" />
170     <link type="text/css" rel="stylesheet" href="style.css" />
171     <link rel="shortcut icon" href="http://www.debian.org/favicon.ico" />
172     <title>
173       Debian NEW and BYHAND Packages
174     </title>
175   </head>
176   <body id="NEW">
177     <div id="logo">
178       <a href="http://www.debian.org/">
179         <img src="http://www.debian.org/logos/openlogo-nd-50.png"
180         alt="debian logo" /></a>
181       <a href="http://www.debian.org/">
182         <img src="http://www.debian.org/Pics/debian.png"
183         alt="Debian Project" /></a>
184     </div>
185     <div id="titleblock">
186
187       <img src="http://www.debian.org/Pics/red-upperleft.png"
188       id="red-upperleft" alt="corner image"/>
189       <img src="http://www.debian.org/Pics/red-lowerleft.png"
190       id="red-lowerleft" alt="corner image"/>
191       <img src="http://www.debian.org/Pics/red-upperright.png"
192       id="red-upperright" alt="corner image"/>
193       <img src="http://www.debian.org/Pics/red-lowerright.png"
194       id="red-lowerright" alt="corner image"/>
195       <span class="title">
196         Debian NEW and BYHAND Packages
197       </span>
198     </div>
199     """
200
201 def footer():
202     print "<p class=\"timestamp\">Timestamp: %s (UTC)</p>" % (time.strftime("%d.%m.%Y / %H:%M:%S", time.gmtime()))
203
204     print """
205     <div class="footer">
206     <p>Hint: Age is the youngest upload of the package, if there is more than
207     one version.<br />
208     You may want to look at <a href="http://ftp-master.debian.org/REJECT-FAQ.html">the REJECT-FAQ</a>
209       for possible reasons why one of the above packages may get rejected.</p>
210       <p>
211       <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10"
212         alt="Valid XHTML 1.0 Strict" height="31" width="88" /></a>
213       <a href="http://jigsaw.w3.org/css-validator/">
214         <img style="border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss"
215         alt="Valid CSS!" />
216       </a>
217       </p>
218     </div> </body> </html>
219     """
220
221 def table_header(type, source_count, total_count):
222     print "<h1>Summary for: %s</h1>" % (type)
223     print """
224     <table class="NEW">
225       <caption>
226     """
227     print "Package count in <strong>%s</strong>: <em>%s</em>&nbsp;|&nbsp; Total Package count: <em>%s</em>" % (type, source_count, total_count)
228     print """
229       </caption>
230       <thead>
231         <tr>
232           <th>Package</th>
233           <th>Version</th>
234           <th>Arch</th>
235           <th>Distribution</th>
236           <th>Age</th>
237           <th>Upload info</th>
238           <th>Closes</th>
239         </tr>
240       </thead>
241       <tbody>
242     """
243
244 def table_footer(type):
245     print "</tbody></table>"
246
247
248 def table_row(source, version, arch, last_mod, maint, distribution, closes, fingerprint, sponsor, changedby):
249
250     global row_number
251
252     trclass = "sid"
253     for dist in distribution:
254         if dist == "experimental":
255             trclass = "exp"
256
257     if row_number % 2 != 0:
258         print "<tr class=\"%s even\">" % (trclass)
259     else:
260         print "<tr class=\"%s odd\">" % (trclass)
261
262     print "<td class=\"package\">%s</td>" % (source)
263     print "<td class=\"version\">"
264     for vers in version.split():
265         print "<a href=\"/new/%s_%s.html\">%s</a><br/>" % (source, utils.html_escape(vers), utils.html_escape(vers))
266     print "</td>"
267     print "<td class=\"arch\">%s</td>" % (arch)
268     print "<td class=\"distribution\">"
269     for dist in distribution:
270         print "%s<br/>" % (dist)
271     print "</td>"
272     print "<td class=\"age\">%s</td>" % (last_mod)
273     (name, mail) = maint.split(":", 1)
274
275     print "<td class=\"upload-data\">"
276     print "<span class=\"maintainer\">Maintainer: <a href=\"http://qa.debian.org/developer.php?login=%s\">%s</a></span><br/>" % (utils.html_escape(mail), utils.html_escape(name))
277     (name, mail) = changedby.split(":", 1)
278     print "<span class=\"changed-by\">Changed-By: <a href=\"http://qa.debian.org/developer.php?login=%s\">%s</a></span><br/>" % (utils.html_escape(mail), utils.html_escape(name))
279
280     try:
281         (login, domain) = sponsor.split("@", 1)
282         print "<span class=\"sponsor\">Sponsor: <a href=\"http://qa.debian.org/developer.php?login=%s\">%s</a></span>@debian.org<br/>" % (utils.html_escape(login), utils.html_escape(login))
283     except Exception, e:
284         print "WARNING: Exception %s" % e
285         pass
286
287     print "<span class=\"signature\">Fingerprint: %s</span>" % (fingerprint)
288     print "</td>"
289
290     print "<td class=\"closes\">"
291     for close in closes:
292         print "<a href=\"http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=%s\">#%s</a><br/>" % (utils.html_escape(close), utils.html_escape(close))
293     print "</td></tr>"
294     row_number+=1
295
296 ############################################################
297
298 def process_changes_files(changes_files, type, log):
299     msg = ""
300     cache = {}
301     # Read in all the .changes files
302     for filename in changes_files:
303         try:
304             u = Upload()
305             u.load_changes(filename)
306             cache[filename] = copy(u.pkg.changes)
307             cache[filename]["filename"] = filename
308         except Exception, e:
309             print "WARNING: Exception %s" % e
310             continue
311     # Divide the .changes into per-source groups
312     per_source = {}
313     for filename in cache.keys():
314         source = cache[filename]["source"]
315         if not per_source.has_key(source):
316             per_source[source] = {}
317             per_source[source]["list"] = []
318         per_source[source]["list"].append(cache[filename])
319     # Determine oldest time and have note status for each source group
320     for source in per_source.keys():
321         source_list = per_source[source]["list"]
322         first = source_list[0]
323         oldest = os.stat(first["filename"])[stat.ST_MTIME]
324         have_note = 0
325         for d in per_source[source]["list"]:
326             mtime = os.stat(d["filename"])[stat.ST_MTIME]
327             if Cnf.has_key("Queue-Report::Options::New"):
328                 if mtime > oldest:
329                     oldest = mtime
330             else:
331                 if mtime < oldest:
332                     oldest = mtime
333             have_note += has_new_comment(d["source"], d["version"])
334         per_source[source]["oldest"] = oldest
335         if not have_note:
336             per_source[source]["note_state"] = 0; # none
337         elif have_note < len(source_list):
338             per_source[source]["note_state"] = 1; # some
339         else:
340             per_source[source]["note_state"] = 2; # all
341     per_source_items = per_source.items()
342     per_source_items.sort(sg_compare)
343
344     entries = []
345     max_source_len = 0
346     max_version_len = 0
347     max_arch_len = 0
348     for i in per_source_items:
349         maintainer = {}
350         maint=""
351         distribution=""
352         closes=""
353         fingerprint=""
354         changeby = {}
355         changedby=""
356         sponsor=""
357         filename=i[1]["list"][0]["filename"]
358         last_modified = time.time()-i[1]["oldest"]
359         source = i[1]["list"][0]["source"]
360         if len(source) > max_source_len:
361             max_source_len = len(source)
362         arches = {}
363         versions = {}
364         for j in i[1]["list"]:
365             if Cnf.has_key("Queue-Report::Options::New") or Cnf.has_key("Queue-Report::Options::822"):
366                 try:
367                     (maintainer["maintainer822"], maintainer["maintainer2047"],
368                     maintainer["maintainername"], maintainer["maintaineremail"]) = \
369                     fix_maintainer (j["maintainer"])
370                 except ParseMaintError, msg:
371                     print "Problems while parsing maintainer address\n"
372                     maintainer["maintainername"] = "Unknown"
373                     maintainer["maintaineremail"] = "Unknown"
374                 maint="%s:%s" % (maintainer["maintainername"], maintainer["maintaineremail"])
375                 # ...likewise for the Changed-By: field if it exists.
376                 try:
377                     (changeby["changedby822"], changeby["changedby2047"],
378                      changeby["changedbyname"], changeby["changedbyemail"]) = \
379                      fix_maintainer (j["changed-by"])
380                 except ParseMaintError, msg:
381                     (changeby["changedby822"], changeby["changedby2047"],
382                      changeby["changedbyname"], changeby["changedbyemail"]) = \
383                      ("", "", "", "")
384                 changedby="%s:%s" % (changeby["changedbyname"], changeby["changedbyemail"])
385
386                 distribution=j["distribution"].keys()
387                 closes=j["closes"].keys()
388                 fingerprint=j["fingerprint"]
389                 if j.has_key("sponsoremail"):
390                     sponsor=j["sponsoremail"]
391             for arch in j["architecture"].keys():
392                 arches[arch] = ""
393             version = j["version"]
394             versions[version] = ""
395         arches_list = arches.keys()
396         arches_list.sort(utils.arch_compare_sw)
397         arch_list = " ".join(arches_list)
398         version_list = " ".join(versions.keys())
399         if len(version_list) > max_version_len:
400             max_version_len = len(version_list)
401         if len(arch_list) > max_arch_len:
402             max_arch_len = len(arch_list)
403         if i[1]["note_state"]:
404             note = " | [N]"
405         else:
406             note = ""
407         entries.append([source, version_list, arch_list, note, last_modified, maint, distribution, closes, fingerprint, sponsor, changedby, filename])
408
409     # direction entry consists of "Which field, which direction, time-consider" where
410     # time-consider says how we should treat last_modified. Thats all.
411
412     # Look for the options for sort and then do the sort.
413     age = "h"
414     if Cnf.has_key("Queue-Report::Options::Age"):
415         age =  Cnf["Queue-Report::Options::Age"]
416     if Cnf.has_key("Queue-Report::Options::New"):
417     # If we produce html we always have oldest first.
418         direction.append([4,-1,"ao"])
419     else:
420         if Cnf.has_key("Queue-Report::Options::Sort"):
421             for i in Cnf["Queue-Report::Options::Sort"].split(","):
422                 if i == "ao":
423                     # Age, oldest first.
424                     direction.append([4,-1,age])
425                 elif i == "an":
426                     # Age, newest first.
427                     direction.append([4,1,age])
428                 elif i == "na":
429                     # Name, Ascending.
430                     direction.append([0,1,0])
431                 elif i == "nd":
432                     # Name, Descending.
433                     direction.append([0,-1,0])
434                 elif i == "nl":
435                     # Notes last.
436                     direction.append([3,1,0])
437                 elif i == "nf":
438                     # Notes first.
439                     direction.append([3,-1,0])
440     entries.sort(lambda x, y: sortfunc(x, y))
441     # Yes, in theory you can add several sort options at the commandline with. But my mind is to small
442     # at the moment to come up with a real good sorting function that considers all the sidesteps you
443     # have with it. (If you combine options it will simply take the last one at the moment).
444     # Will be enhanced in the future.
445
446     if Cnf.has_key("Queue-Report::Options::822"):
447         # print stuff out in 822 format
448         for entry in entries:
449             (source, version_list, arch_list, note, last_modified, maint, distribution, closes, fingerprint, sponsor, changedby, changes_file) = entry
450
451             # We'll always have Source, Version, Arch, Mantainer, and Dist
452             # For the rest, check to see if we have them, then print them out
453             log.write("Source: " + source + "\n")
454             log.write("Version: " + version_list + "\n")
455             log.write("Architectures: ")
456             log.write( (", ".join(arch_list.split(" "))) + "\n")
457             log.write("Age: " + time_pp(last_modified) + "\n")
458             log.write("Last-Modified: " + str(int(time.time()) - int(last_modified)) + "\n")
459             log.write("Queue: " + type + "\n")
460
461             (name, mail) = maint.split(":", 1)
462             log.write("Maintainer: " + name + " <"+mail+">" + "\n")
463             if changedby:
464                (name, mail) = changedby.split(":", 1)
465                log.write("Changed-By: " + name + " <"+mail+">" + "\n")
466             if sponsor:
467                log.write("Sponsored-By: " + sponsor + "\n")
468             log.write("Distribution:")
469             for dist in distribution:
470                log.write(" " + dist)
471             log.write("\n")
472             log.write("Fingerprint: " + fingerprint + "\n")
473             if closes:
474                 bug_string = ""
475                 for bugs in closes:
476                     bug_string += "#"+bugs+", "
477                 log.write("Closes: " + bug_string[:-2] + "\n")
478             log.write("Changes-File: " + os.path.basename(changes_file) + "\n")
479             log.write("\n")
480
481     if Cnf.has_key("Queue-Report::Options::New"):
482         direction.append([4,1,"ao"])
483         entries.sort(lambda x, y: sortfunc(x, y))
484     # Output for a html file. First table header. then table_footer.
485     # Any line between them is then a <tr> printed from subroutine table_row.
486         if len(entries) > 0:
487             total_count = len(changes_files)
488             source_count = len(per_source_items)
489             table_header(type.upper(), source_count, total_count)
490             for entry in entries:
491                 (source, version_list, arch_list, note, last_modified, maint, distribution, closes, fingerprint, sponsor, changedby, undef) = entry
492                 table_row(source, version_list, arch_list, time_pp(last_modified), maint, distribution, closes, fingerprint, sponsor, changedby)
493             table_footer(type.upper())
494     elif not Cnf.has_key("Queue-Report::Options::822"):
495     # The "normal" output without any formatting.
496         format="%%-%ds | %%-%ds | %%-%ds%%s | %%s old\n" % (max_source_len, max_version_len, max_arch_len)
497
498         msg = ""
499         for entry in entries:
500             (source, version_list, arch_list, note, last_modified, undef, undef, undef, undef, undef, undef, undef) = entry
501             msg += format % (source, version_list, arch_list, note, time_pp(last_modified))
502
503         if msg:
504             total_count = len(changes_files)
505             source_count = len(per_source_items)
506             print type.upper()
507             print "-"*len(type)
508             print
509             print msg
510             print "%s %s source package%s / %s %s package%s in total." % (source_count, type, plural(source_count), total_count, type, plural(total_count))
511             print
512
513
514 ################################################################################
515
516 def main():
517     global Cnf
518
519     Cnf = utils.get_conf()
520     Arguments = [('h',"help","Queue-Report::Options::Help"),
521                  ('n',"new","Queue-Report::Options::New"),
522                  ('8','822',"Queue-Report::Options::822"),
523                  ('s',"sort","Queue-Report::Options::Sort", "HasArg"),
524                  ('a',"age","Queue-Report::Options::Age", "HasArg"),
525                  ('d',"directories","Queue-Report::Options::Directories", "HasArg")]
526     for i in [ "help" ]:
527         if not Cnf.has_key("Queue-Report::Options::%s" % (i)):
528             Cnf["Queue-Report::Options::%s" % (i)] = ""
529
530     apt_pkg.ParseCommandLine(Cnf, Arguments, sys.argv)
531
532     Options = Cnf.SubTree("Queue-Report::Options")
533     if Options["Help"]:
534         usage()
535
536     if Cnf.has_key("Queue-Report::Options::New"):
537         header()
538
539     # Initialize db so we can get the NEW comments
540     dbconn = DBConn()
541
542     directories = [ ]
543
544     if Cnf.has_key("Queue-Report::Options::Directories"):
545         for i in Cnf["Queue-Report::Options::Directories"].split(","):
546             directories.append(i)
547     elif Cnf.has_key("Queue-Report::Directories"):
548         directories = Cnf.ValueList("Queue-Report::Directories")
549     else:
550         directories = [ "byhand", "new" ]
551
552     f = None
553     if Cnf.has_key("Queue-Report::Options::822"):
554         # Open the report file
555         f = open(Cnf["Queue-Report::ReportLocations::822Location"], "w")
556
557     for directory in directories:
558         changes_files = glob.glob("%s/*.changes" % (Cnf["Dir::Queue::%s" % (directory)]))
559         process_changes_files(changes_files, directory, f)
560
561     if Cnf.has_key("Queue-Report::Options::822"):
562         f.close()
563
564     if Cnf.has_key("Queue-Report::Options::New"):
565         footer()
566
567 ################################################################################
568
569 if __name__ == '__main__':
570     main()