2 # vim:set et ts=4 sw=4:
4 """ Handles NEW and BYHAND packages
6 @contact: Debian FTP Master <ftpmaster@debian.org>
7 @copyright: 2001, 2002, 2003, 2004, 2005, 2006 James Troup <james@nocrew.org>
8 @copyright: 2009 Joerg Jaspert <joerg@debian.org>
9 @copyright: 2009 Frank Lichtenheld <djpig@debian.org>
10 @license: GNU General Public License version 2 or later
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 2 of the License, or
15 # (at your option) any later version.
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License
23 # along with this program; if not, write to the Free Software
24 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 ################################################################################
28 # 23:12|<aj> I will not hush!
30 # 23:12|<aj> Where there is injustice in the world, I shall be there!
31 # 23:13|<aj> I shall not be silenced!
32 # 23:13|<aj> The world shall know!
33 # 23:13|<aj> The world *must* know!
34 # 23:13|<elmo> oh dear, he's gone back to powerpuff girls... ;-)
35 # 23:13|<aj> yay powerpuff girls!!
36 # 23:13|<aj> buttercup's my favourite, who's yours?
37 # 23:14|<aj> you're backing away from the keyboard right now aren't you?
38 # 23:14|<aj> *AREN'T YOU*?!
39 # 23:15|<aj> I will not be treated like this.
40 # 23:15|<aj> I shall have my revenge.
41 # 23:15|<aj> I SHALL!!!
43 ################################################################################
54 import apt_pkg, apt_inst
55 import examine_package
58 from daklib.dbconn import *
59 from daklib.queue import *
60 from daklib import daklog
61 from daklib import utils
62 from daklib.regexes import re_no_epoch, re_default_answer, re_isanum, re_package
63 from daklib.dak_exceptions import CantOpenError, AlreadyLockedError, CantGetLockError
64 from daklib.summarystats import SummaryStats
65 from daklib.config import Config
66 from daklib.policy import UploadCopy, PolicyQueueUploadHandler
67 from sqlalchemy.sql import not_
76 ################################################################################
77 ################################################################################
78 ################################################################################
80 class Section_Completer:
81 def __init__ (self, session):
84 for s, in session.query(Section.section):
85 self.sections.append(s)
87 def complete(self, text, state):
91 for word in self.sections:
93 self.matches.append(word)
95 return self.matches[state]
99 ############################################################
101 class Priority_Completer:
102 def __init__ (self, session):
105 for p, in session.query(Priority.priority):
106 self.priorities.append(p)
108 def complete(self, text, state):
112 for word in self.priorities:
114 self.matches.append(word)
116 return self.matches[state]
120 ################################################################################
122 def claimed_overrides(upload, missing, session):
123 source = [upload.source.source]
124 binaries = set([x.package for x in upload.binaries])
125 suites = ('unstable','experimental')
127 if m['type'] != 'dsc':
128 binaries.remove(m['package'])
130 return session.query(DBBinary.package, DBSource.source).distinct(). \
131 filter(DBBinary.package.in_(binaries)). \
132 join(DBBinary.source). \
133 filter(not_(DBSource.source.in_(source))). \
134 join(DBBinary.suites). \
135 filter(Suite.suite_name.in_(suites)). \
136 order_by(DBSource.source, DBBinary.package)
140 ################################################################################
142 def print_new (upload, missing, indexed, session, file=sys.stdout):
143 check_valid(missing, session)
147 if m['type'] != 'deb':
148 package = '{0}:{1}'.format(m['type'], m['package'])
150 package = m['package']
151 section = m['section']
152 priority = m['priority']
154 line = "(%s): %-20s %-20s %-20s" % (index, package, priority, section)
156 line = "%-20s %-20s %-20s" % (package, priority, section)
161 claimed = claimed_overrides(upload, missing, session)
162 if claimed and claimed.count():
163 print '\nCLAIMED OVERRIDES'
165 print '%s: %s' % (c.source, c.package)
166 notes = get_new_comments(upload.policy_queue, upload.changes.source)
168 print "\nAuthor: %s\nVersion: %s\nTimestamp: %s\n\n%s" \
169 % (note.author, note.version, note.notedate, note.comment)
171 return len(notes) > 0
173 ################################################################################
175 def index_range (index):
179 return "1-%s" % (index)
181 ################################################################################
182 ################################################################################
184 def edit_new (overrides, upload, session):
185 # Write the current data to a temporary file
186 (fd, temp_filename) = utils.temp_filename()
187 temp_file = os.fdopen(fd, 'w')
188 print_new (upload, overrides, indexed=0, session=session, file=temp_file)
190 # Spawn an editor on that file
191 editor = os.environ.get("EDITOR","vi")
192 result = os.system("%s %s" % (editor, temp_filename))
194 utils.fubar ("%s invocation failed for %s." % (editor, temp_filename), result)
195 # Read the edited data back in
196 temp_file = utils.open_file(temp_filename)
197 lines = temp_file.readlines()
199 os.unlink(temp_filename)
201 overrides_map = dict([ ((o['type'], o['package']), o) for o in overrides ])
206 if line == "" or line[0] == '#':
209 # Pad the list if necessary
210 s[len(s):3] = [None] * (3-len(s))
211 (pkg, priority, section) = s[:3]
212 if pkg.find(':') != -1:
213 type, pkg = pkg.split(':', 1)
216 if (type, pkg) not in overrides_map:
217 utils.warn("Ignoring unknown package '%s'" % (pkg))
219 if section.find('/') != -1:
220 component = section.split('/', 1)[0]
223 new_overrides.append(dict(
232 ################################################################################
234 def edit_index (new, upload, index):
235 package = new[index]['package']
236 priority = new[index]["priority"]
237 section = new[index]["section"]
238 ftype = new[index]["type"]
241 print "\t".join([package, priority, section])
245 prompt = "[B]oth, Priority, Section, Done ? "
247 prompt = "[S]ection, Done ? "
248 edit_priority = edit_section = 0
250 while prompt.find(answer) == -1:
251 answer = utils.our_raw_input(prompt)
252 m = re_default_answer.match(prompt)
255 answer = answer[:1].upper()
262 edit_priority = edit_section = 1
268 readline.set_completer(Priorities.complete)
270 while not got_priority:
271 new_priority = utils.our_raw_input("New priority: ").strip()
272 if new_priority not in Priorities.priorities:
273 print "E: '%s' is not a valid priority, try again." % (new_priority)
276 priority = new_priority
280 readline.set_completer(Sections.complete)
282 while not got_section:
283 new_section = utils.our_raw_input("New section: ").strip()
284 if new_section not in Sections.sections:
285 print "E: '%s' is not a valid section, try again." % (new_section)
288 section = new_section
290 # Reset the readline completer
291 readline.set_completer(None)
293 new[index]["priority"] = priority
294 new[index]["section"] = section
295 if section.find('/') != -1:
296 component = section.split('/', 1)[0]
299 new[index]['component'] = component
303 ################################################################################
305 def edit_overrides (new, upload, session):
309 print_new (upload, new, indexed=1, session=session)
310 prompt = "edit override <n>, Editor, Done ? "
313 while not got_answer:
314 answer = utils.our_raw_input(prompt)
315 if not answer.isdigit():
316 answer = answer[:1].upper()
317 if answer == "E" or answer == "D":
319 elif re_isanum.match (answer):
321 if answer < 1 or answer > len(new):
322 print "{0} is not a valid index. Please retry.".format(answer)
327 new = edit_new(new, upload, session)
331 edit_index (new, upload, answer - 1)
336 ################################################################################
338 def check_pkg (upload, upload_copy, session):
340 save_stdout = sys.stdout
341 changes = os.path.join(upload_copy.directory, upload.changes.changesname)
342 suite_name = upload.target_suite.suite_name
343 handler = PolicyQueueUploadHandler(upload, session)
344 missing = [(m['type'], m["package"]) for m in handler.missing_overrides(hints=missing)]
346 sys.stdout = os.popen("less -R -", 'w', 0)
347 print examine_package.display_changes(suite_name, changes)
349 source = upload.source
350 if source is not None:
351 source_file = os.path.join(upload_copy.directory, os.path.basename(source.poolfile.filename))
352 print examine_package.check_dsc(suite_name, source_file)
354 for binary in upload.binaries:
355 binary_file = os.path.join(upload_copy.directory, os.path.basename(binary.poolfile.filename))
356 examined = examine_package.check_deb(suite_name, binary_file)
357 # We always need to call check_deb to display package relations for every binary,
358 # but we print its output only if new overrides are being added.
359 if ("deb", binary.package) in missing:
362 print examine_package.output_package_relations()
364 if e.errno == errno.EPIPE:
365 utils.warn("[examine_package] Caught EPIPE; skipping.")
368 except KeyboardInterrupt:
369 utils.warn("[examine_package] Caught C-c; skipping.")
371 sys.stdout = save_stdout
373 ################################################################################
375 ## FIXME: horribly Debian specific
377 def do_bxa_notification(new, upload, session):
380 new = set([ o['package'] for o in new if o['type'] == 'deb' ])
384 key = session.query(MetadataKey).filter_by(key='Description').one()
386 for binary in upload.binaries:
387 if binary.package not in new:
389 description = session.query(BinaryMetadata).filter_by(binary=binary, key=key).one().value
391 summary += "Package: {0}\n".format(binary.package)
392 summary += "Description: {0}\n".format(description)
395 '__DISTRO__': cnf['Dinstall::MyDistribution'],
396 '__BCC__': 'X-DAK: dak process-new',
397 '__BINARY_DESCRIPTIONS__': summary,
400 bxa_mail = utils.TemplateSubst(subst,os.path.join(cnf["Dir::Templates"], "process-new.bxa_notification"))
401 utils.send_mail(bxa_mail)
403 ################################################################################
405 def add_overrides (new_overrides, suite, session):
406 if suite.overridesuite is not None:
407 suite = session.query(Suite).filter_by(suite_name=suite.overridesuite).one()
409 for override in new_overrides:
410 package = override['package']
411 priority = session.query(Priority).filter_by(priority=override['priority']).first()
412 section = session.query(Section).filter_by(section=override['section']).first()
413 component = get_mapped_component(override['component'], session)
414 overridetype = session.query(OverrideType).filter_by(overridetype=override['type']).one()
417 raise Exception('Invalid priority {0} for package {1}'.format(priority, package))
419 raise Exception('Invalid section {0} for package {1}'.format(section, package))
420 if component is None:
421 raise Exception('Invalid component {0} for package {1}'.format(component, package))
423 o = Override(package=package, suite=suite, component=component, priority=priority, section=section, overridetype=overridetype)
428 ################################################################################
430 def run_user_inspect_command(upload, upload_copy):
431 command = os.environ.get('DAK_INSPECT_UPLOAD')
435 directory = upload_copy.directory
437 dsc = os.path.basename(upload.source.poolfile.filename)
440 changes = upload.changes.changesname
442 shell_command = command.format(
448 subprocess.check_call(shell_command, shell=True)
450 ################################################################################
452 def get_reject_reason(reason=''):
453 """get reason for rejection
456 @return: string giving the reason for the rejection or C{None} if the
457 rejection should be cancelled
460 if Options['Automatic']:
464 reason = utils.call_editor(reason)
465 print "Reject message:"
466 print utils.prefix_multi_line_string(reason, " ", include_blank_lines=1)
467 prompt = "[R]eject, Edit, Abandon, Quit ?"
469 while prompt.find(answer) == -1:
470 answer = utils.our_raw_input(prompt)
471 m = re_default_answer.search(prompt)
474 answer = answer[:1].upper()
483 ################################################################################
485 def do_new(upload, upload_copy, handler, session):
488 run_user_inspect_command(upload, upload_copy)
490 # The main NEW processing loop
494 queuedir = upload.policy_queue.path
495 byhand = upload.byhand
497 missing = handler.missing_overrides(hints=missing)
498 broken = not check_valid(missing, session)
500 changesname = os.path.basename(upload.changes.changesname)
504 print "-" * len(changesname)
506 print " Target: {0}".format(upload.target_suite.suite_name)
507 print " Changed-By: {0}".format(upload.changes.changedby)
510 #if len(byhand) == 0 and len(missing) == 0:
517 if Options["No-Action"] or Options["Automatic"]:
520 note = print_new(upload, missing, indexed=0, session=session)
523 has_unprocessed_byhand = False
525 path = os.path.join(queuedir, f.filename)
526 if not f.processed and os.path.exists(path):
527 print "W: {0} still present; please process byhand components and try again".format(f.filename)
528 has_unprocessed_byhand = True
530 if not has_unprocessed_byhand and not broken and not note:
531 if len(missing) == 0:
535 prompt = "Add overrides, "
537 print "W: [!] marked entries must be fixed before package can be processed."
539 print "W: note must be removed before package can be processed."
540 prompt += "RemOve all notes, Remove note, "
542 prompt += "Edit overrides, Check, Manual reject, Note edit, Prod, [S]kip, Quit ?"
544 while prompt.find(answer) == -1:
545 answer = utils.our_raw_input(prompt)
546 m = re_default_answer.search(prompt)
549 answer = answer[:1].upper()
551 if answer in ( 'A', 'E', 'M', 'O', 'R' ) and Options["Trainee"]:
552 utils.warn("Trainees can't do that")
555 if answer == 'A' and not Options["Trainee"]:
556 add_overrides(missing, upload.target_suite, session)
557 if Config().find_b("Dinstall::BXANotify"):
558 do_bxa_notification(missing, upload, session)
561 Logger.log(["NEW ACCEPT", upload.changes.changesname])
563 check_pkg(upload, upload_copy, session)
564 elif answer == 'E' and not Options["Trainee"]:
565 missing = edit_overrides (missing, upload, session)
566 elif answer == 'M' and not Options["Trainee"]:
567 reason = Options.get('Manual-Reject', '') + "\n"
568 reason = reason + "\n\n=====\n\n".join([n.comment for n in get_new_comments(upload.policy_queue, upload.changes.source, session=session)])
569 reason = get_reject_reason(reason)
570 if reason is not None:
571 Logger.log(["NEW REJECT", upload.changes.changesname])
572 handler.reject(reason)
575 if edit_note(get_new_comments(upload.policy_queue, upload.changes.source, session=session),
576 upload, session, bool(Options["Trainee"])) == 0:
579 elif answer == 'P' and not Options["Trainee"]:
580 if prod_maintainer(get_new_comments(upload.policy_queue, upload.changes.source, session=session),
584 Logger.log(["NEW PROD", upload.changes.changesname])
585 elif answer == 'R' and not Options["Trainee"]:
586 confirm = utils.our_raw_input("Really clear note (y/N)? ").lower()
588 for c in get_new_comments(upload.policy_queue, upload.changes.source, upload.changes.version, session=session):
591 elif answer == 'O' and not Options["Trainee"]:
592 confirm = utils.our_raw_input("Really clear all notes (y/N)? ").lower()
594 for c in get_new_comments(upload.policy_queue, upload.changes.source, session=session):
604 if handler.get_action():
605 print "PENDING %s\n" % handler.get_action()
607 ################################################################################
608 ################################################################################
609 ################################################################################
611 def usage (exit_code=0):
612 print """Usage: dak process-new [OPTION]... [CHANGES]...
613 -a, --automatic automatic run
614 -b, --no-binaries do not sort binary-NEW packages first
615 -c, --comments show NEW comments
616 -h, --help show this help and exit.
617 -m, --manual-reject=MSG manual reject with `msg'
618 -n, --no-action don't do anything
619 -q, --queue=QUEUE operate on a different queue
620 -t, --trainee FTP Trainee mode
621 -V, --version display the version number and exit
623 ENVIRONMENT VARIABLES
625 DAK_INSPECT_UPLOAD: shell command to run to inspect a package
626 The command is automatically run in a shell when an upload
627 is checked. The following substitutions are available:
629 {directory}: directory the upload is contained in
630 {dsc}: name of the included dsc or the empty string
631 {changes}: name of the changes file
633 Note that Python's 'format' method is used to format the command.
635 Example: run mc in a tmux session to inspect the upload
637 export DAK_INSPECT_UPLOAD='tmux new-session -d -s process-new 2>/dev/null; tmux new-window -n "{changes}" -t process-new:0 -k "cd {directory}; mc"'
641 tmux attach -t process-new
643 in a separate terminal session.
647 ################################################################################
649 @contextlib.contextmanager
650 def lock_package(package):
652 Lock C{package} so that noone else jumps in processing it.
654 @type package: string
655 @param package: source package name to lock
660 path = os.path.join(cnf.get("Process-New::LockDir", cnf['Dir::Lock']), package)
663 fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDONLY)
665 if e.errno == errno.EEXIST or e.errno == errno.EACCES:
666 user = pwd.getpwuid(os.stat(path)[stat.ST_UID])[4].split(',')[0].replace('.', '')
667 raise AlreadyLockedError(user)
674 def do_pkg(upload, session):
675 # Try to get an included dsc
679 group = cnf.get('Dinstall::UnprivGroup') or None
681 #bcc = "X-DAK: dak process-new"
682 #if cnf.has_key("Dinstall::Bcc"):
683 # u.Subst["__BCC__"] = bcc + "\nBcc: %s" % (cnf["Dinstall::Bcc"])
685 # u.Subst["__BCC__"] = bcc
688 with lock_package(upload.changes.source):
689 with UploadCopy(upload, group=group) as upload_copy:
690 handler = PolicyQueueUploadHandler(upload, session)
691 if handler.get_action() is not None:
692 print "PENDING %s\n" % handler.get_action()
695 do_new(upload, upload_copy, handler, session)
696 except AlreadyLockedError as e:
697 print "Seems to be locked by %s already, skipping..." % (e)
699 def show_new_comments(uploads, session):
700 sources = [ upload.changes.source for upload in uploads ]
701 if len(sources) == 0:
704 query = """SELECT package, version, comment, author
706 WHERE package IN :sources
707 ORDER BY package, version"""
709 r = session.execute(query, params=dict(sources=tuple(sources)))
712 print "%s_%s\n%s\n(%s)\n\n\n" % (i[0], i[1], i[2], i[3])
716 ################################################################################
718 def sort_uploads(new_queue, uploads, session, nobinaries=False):
721 suitesrc = [s.source for s in session.query(DBSource.source). \
722 filter(DBSource.suites.any(Suite.suite_name.in_(['unstable', 'experimental'])))]
723 comments = [p.package for p in session.query(NewComment.package). \
724 filter_by(trainee=False, policy_queue=new_queue).distinct()]
725 for upload in uploads:
726 source = upload.changes.source
727 if not source in sources:
729 sources[source].append({'upload': upload,
730 'date': upload.changes.created,
732 'binary': True if source in suitesrc else False,
733 'comments': True if source in comments else False})
735 if len(sources[src]) > 1:
736 changes = sources[src]
737 firstseen = sorted(changes, key=lambda k: (k['date']))[0]['date']
738 changes.sort(key=lambda item:item['date'])
739 for i in range (0, len(changes)):
740 changes[i]['date'] = firstseen
741 changes[i]['stack'] = i + 1
742 sorteduploads += sources[src]
744 sorteduploads = [u["upload"] for u in sorted(sorteduploads,
745 key=lambda k: (k["comments"], k["binary"],
746 k["date"], -k["stack"]))]
748 sorteduploads = [u["upload"] for u in sorted(sorteduploads,
749 key=lambda k: (k["comments"], -k["binary"],
750 k["date"], -k["stack"]))]
753 ################################################################################
756 accept_count = SummaryStats().accept_count
757 accept_bytes = SummaryStats().accept_bytes
763 sys.stderr.write("Accepted %d package %s, %s.\n" % (accept_count, sets, utils.size_type(int(accept_bytes))))
764 Logger.log(["total",accept_count,accept_bytes])
766 if not Options["No-Action"] and not Options["Trainee"]:
769 ################################################################################
772 global Options, Logger, Sections, Priorities
775 session = DBConn().session()
777 Arguments = [('a',"automatic","Process-New::Options::Automatic"),
778 ('b',"no-binaries","Process-New::Options::No-Binaries"),
779 ('c',"comments","Process-New::Options::Comments"),
780 ('h',"help","Process-New::Options::Help"),
781 ('m',"manual-reject","Process-New::Options::Manual-Reject", "HasArg"),
782 ('t',"trainee","Process-New::Options::Trainee"),
783 ('q','queue','Process-New::Options::Queue', 'HasArg'),
784 ('n',"no-action","Process-New::Options::No-Action")]
786 changes_files = apt_pkg.parse_commandline(cnf.Cnf,Arguments,sys.argv)
788 for i in ["automatic", "no-binaries", "comments", "help", "manual-reject", "no-action", "version", "trainee"]:
789 if not cnf.has_key("Process-New::Options::%s" % (i)):
790 cnf["Process-New::Options::%s" % (i)] = ""
792 queue_name = cnf.get('Process-New::Options::Queue', 'new')
793 new_queue = session.query(PolicyQueue).filter_by(queue_name=queue_name).one()
794 if len(changes_files) == 0:
795 uploads = new_queue.uploads
797 uploads = session.query(PolicyQueueUpload).filter_by(policy_queue=new_queue) \
798 .join(DBChange).filter(DBChange.changesname.in_(changes_files)).all()
800 Options = cnf.subtree("Process-New::Options")
805 if not Options["No-Action"]:
807 Logger = daklog.Logger("process-new")
808 except CantOpenError as e:
809 Options["Trainee"] = "True"
811 Sections = Section_Completer(session)
812 Priorities = Priority_Completer(session)
813 readline.parse_and_bind("tab: complete")
816 sys.stderr.write("Sorting changes...\n")
817 uploads = sort_uploads(new_queue, uploads, session, Options["No-Binaries"])
819 if Options["Comments"]:
820 show_new_comments(uploads, session)
822 for upload in uploads:
823 do_pkg (upload, session)
827 ################################################################################
829 if __name__ == '__main__':