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
57 import daklib.daksubprocess
58 from sqlalchemy import or_
60 from daklib.dbconn import *
61 from daklib.queue import *
62 from daklib import daklog
63 from daklib import utils
64 from daklib.regexes import re_no_epoch, re_default_answer, re_isanum, re_package
65 from daklib.dak_exceptions import CantOpenError, AlreadyLockedError, CantGetLockError
66 from daklib.summarystats import SummaryStats
67 from daklib.config import Config
68 from daklib.policy import UploadCopy, PolicyQueueUploadHandler
77 ################################################################################
78 ################################################################################
79 ################################################################################
81 class Section_Completer:
82 def __init__ (self, session):
85 for s, in session.query(Section.section):
86 self.sections.append(s)
88 def complete(self, text, state):
92 for word in self.sections:
94 self.matches.append(word)
96 return self.matches[state]
100 ############################################################
102 class Priority_Completer:
103 def __init__ (self, session):
106 for p, in session.query(Priority.priority):
107 self.priorities.append(p)
109 def complete(self, text, state):
113 for word in self.priorities:
115 self.matches.append(word)
117 return self.matches[state]
121 ################################################################################
123 def takenover_binaries(upload, missing, session):
125 binaries = set([x.package for x in upload.binaries])
127 if m['type'] != 'dsc':
128 binaries.discard(m['package'])
130 source = upload.binaries[0].source.source
131 suite = upload.target_suite.overridesuite or \
132 upload.target_suite.suite_name
133 suites = [s[0] for s in session.query(Suite.suite_name).filter \
134 (or_(Suite.suite_name == suite,
135 Suite.overridesuite == suite)).all()]
136 rows = session.query(DBSource.source, DBBinary.package).distinct(). \
137 filter(DBBinary.package.in_(binaries)). \
138 join(DBBinary.source). \
139 filter(DBSource.source != source). \
140 join(DBBinary.suites). \
141 filter(Suite.suite_name.in_(suites)). \
142 order_by(DBSource.source, DBBinary.package).all()
145 ################################################################################
147 def print_new (upload, missing, indexed, session, file=sys.stdout):
148 check_valid(missing, session)
152 if m['type'] != 'deb':
153 package = '{0}:{1}'.format(m['type'], m['package'])
155 package = m['package']
156 section = m['section']
157 priority = m['priority']
159 line = "(%s): %-20s %-20s %-20s" % (index, package, priority, section)
161 line = "%-20s %-20s %-20s" % (package, priority, section)
166 takenover = takenover_binaries(upload, missing, session)
168 print '\n\nBINARIES TAKEN OVER\n'
170 print '%s: %s' % (t[0], t[1])
171 notes = get_new_comments(upload.policy_queue, upload.changes.source)
173 print "\nAuthor: %s\nVersion: %s\nTimestamp: %s\n\n%s" \
174 % (note.author, note.version, note.notedate, note.comment)
176 return len(notes) > 0
178 ################################################################################
180 def index_range (index):
184 return "1-%s" % (index)
186 ################################################################################
187 ################################################################################
189 def edit_new (overrides, upload, session):
190 # Write the current data to a temporary file
191 (fd, temp_filename) = utils.temp_filename()
192 temp_file = os.fdopen(fd, 'w')
193 print_new (upload, overrides, indexed=0, session=session, file=temp_file)
195 # Spawn an editor on that file
196 editor = os.environ.get("EDITOR","vi")
197 result = os.system("%s %s" % (editor, temp_filename))
199 utils.fubar ("%s invocation failed for %s." % (editor, temp_filename), result)
200 # Read the edited data back in
201 temp_file = utils.open_file(temp_filename)
202 lines = temp_file.readlines()
204 os.unlink(temp_filename)
206 overrides_map = dict([ ((o['type'], o['package']), o) for o in overrides ])
211 if line == "" or line[0] == '#':
214 # Pad the list if necessary
215 s[len(s):3] = [None] * (3-len(s))
216 (pkg, priority, section) = s[:3]
217 if pkg.find(':') != -1:
218 type, pkg = pkg.split(':', 1)
221 if (type, pkg) not in overrides_map:
222 utils.warn("Ignoring unknown package '%s'" % (pkg))
224 if section.find('/') != -1:
225 component = section.split('/', 1)[0]
228 new_overrides.append(dict(
237 ################################################################################
239 def edit_index (new, upload, index):
240 package = new[index]['package']
241 priority = new[index]["priority"]
242 section = new[index]["section"]
243 ftype = new[index]["type"]
246 print "\t".join([package, priority, section])
250 prompt = "[B]oth, Priority, Section, Done ? "
252 prompt = "[S]ection, Done ? "
253 edit_priority = edit_section = 0
255 while prompt.find(answer) == -1:
256 answer = utils.our_raw_input(prompt)
257 m = re_default_answer.match(prompt)
260 answer = answer[:1].upper()
267 edit_priority = edit_section = 1
273 readline.set_completer(Priorities.complete)
275 while not got_priority:
276 new_priority = utils.our_raw_input("New priority: ").strip()
277 if new_priority not in Priorities.priorities:
278 print "E: '%s' is not a valid priority, try again." % (new_priority)
281 priority = new_priority
285 readline.set_completer(Sections.complete)
287 while not got_section:
288 new_section = utils.our_raw_input("New section: ").strip()
289 if new_section not in Sections.sections:
290 print "E: '%s' is not a valid section, try again." % (new_section)
293 section = new_section
295 # Reset the readline completer
296 readline.set_completer(None)
298 new[index]["priority"] = priority
299 new[index]["section"] = section
300 if section.find('/') != -1:
301 component = section.split('/', 1)[0]
304 new[index]['component'] = component
308 ################################################################################
310 def edit_overrides (new, upload, session):
314 print_new (upload, new, indexed=1, session=session)
315 prompt = "edit override <n>, Editor, Done ? "
318 while not got_answer:
319 answer = utils.our_raw_input(prompt)
320 if not answer.isdigit():
321 answer = answer[:1].upper()
322 if answer == "E" or answer == "D":
324 elif re_isanum.match (answer):
326 if answer < 1 or answer > len(new):
327 print "{0} is not a valid index. Please retry.".format(answer)
332 new = edit_new(new, upload, session)
336 edit_index (new, upload, answer - 1)
341 ################################################################################
343 def check_pkg (upload, upload_copy, session):
345 save_stdout = sys.stdout
346 changes = os.path.join(upload_copy.directory, upload.changes.changesname)
347 suite_name = upload.target_suite.suite_name
348 handler = PolicyQueueUploadHandler(upload, session)
349 missing = [(m['type'], m["package"]) for m in handler.missing_overrides(hints=missing)]
351 less_cmd = ("less", "-R", "-")
352 less_process = daklib.daksubprocess.Popen(less_cmd, bufsize=0, stdin=subprocess.PIPE)
354 sys.stdout = less_process.stdin
355 print examine_package.display_changes(suite_name, changes)
357 source = upload.source
358 if source is not None:
359 source_file = os.path.join(upload_copy.directory, os.path.basename(source.poolfile.filename))
360 print examine_package.check_dsc(suite_name, source_file)
362 for binary in upload.binaries:
363 binary_file = os.path.join(upload_copy.directory, os.path.basename(binary.poolfile.filename))
364 examined = examine_package.check_deb(suite_name, binary_file)
365 # We always need to call check_deb to display package relations for every binary,
366 # but we print its output only if new overrides are being added.
367 if ("deb", binary.package) in missing:
370 print examine_package.output_package_relations()
371 less_process.stdin.close()
373 if e.errno == errno.EPIPE:
374 utils.warn("[examine_package] Caught EPIPE; skipping.")
377 except KeyboardInterrupt:
378 utils.warn("[examine_package] Caught C-c; skipping.")
381 sys.stdout = save_stdout
383 ################################################################################
385 ## FIXME: horribly Debian specific
387 def do_bxa_notification(new, upload, session):
390 new = set([ o['package'] for o in new if o['type'] == 'deb' ])
394 key = session.query(MetadataKey).filter_by(key='Description').one()
396 for binary in upload.binaries:
397 if binary.package not in new:
399 description = session.query(BinaryMetadata).filter_by(binary=binary, key=key).one().value
401 summary += "Package: {0}\n".format(binary.package)
402 summary += "Description: {0}\n".format(description)
405 '__DISTRO__': cnf['Dinstall::MyDistribution'],
406 '__BCC__': 'X-DAK: dak process-new',
407 '__BINARY_DESCRIPTIONS__': summary,
410 bxa_mail = utils.TemplateSubst(subst,os.path.join(cnf["Dir::Templates"], "process-new.bxa_notification"))
411 utils.send_mail(bxa_mail)
413 ################################################################################
415 def add_overrides (new_overrides, suite, session):
416 if suite.overridesuite is not None:
417 suite = session.query(Suite).filter_by(suite_name=suite.overridesuite).one()
419 for override in new_overrides:
420 package = override['package']
421 priority = session.query(Priority).filter_by(priority=override['priority']).first()
422 section = session.query(Section).filter_by(section=override['section']).first()
423 component = get_mapped_component(override['component'], session)
424 overridetype = session.query(OverrideType).filter_by(overridetype=override['type']).one()
427 raise Exception('Invalid priority {0} for package {1}'.format(priority, package))
429 raise Exception('Invalid section {0} for package {1}'.format(section, package))
430 if component is None:
431 raise Exception('Invalid component {0} for package {1}'.format(component, package))
433 o = Override(package=package, suite=suite, component=component, priority=priority, section=section, overridetype=overridetype)
438 ################################################################################
440 def run_user_inspect_command(upload, upload_copy):
441 command = os.environ.get('DAK_INSPECT_UPLOAD')
445 directory = upload_copy.directory
447 dsc = os.path.basename(upload.source.poolfile.filename)
450 changes = upload.changes.changesname
452 shell_command = command.format(
458 daklib.daksubprocess.check_call(shell_command, shell=True)
460 ################################################################################
462 def get_reject_reason(reason=''):
463 """get reason for rejection
466 @return: string giving the reason for the rejection or C{None} if the
467 rejection should be cancelled
470 if Options['Automatic']:
474 reason = utils.call_editor(reason)
475 print "Reject message:"
476 print utils.prefix_multi_line_string(reason, " ", include_blank_lines=1)
477 prompt = "[R]eject, Edit, Abandon, Quit ?"
479 while prompt.find(answer) == -1:
480 answer = utils.our_raw_input(prompt)
481 m = re_default_answer.search(prompt)
484 answer = answer[:1].upper()
493 ################################################################################
495 def do_new(upload, upload_copy, handler, session):
498 run_user_inspect_command(upload, upload_copy)
500 # The main NEW processing loop
504 queuedir = upload.policy_queue.path
505 byhand = upload.byhand
507 missing = handler.missing_overrides(hints=missing)
508 broken = not check_valid(missing, session)
510 changesname = os.path.basename(upload.changes.changesname)
514 print "-" * len(changesname)
516 print " Target: {0}".format(upload.target_suite.suite_name)
517 print " Changed-By: {0}".format(upload.changes.changedby)
520 #if len(byhand) == 0 and len(missing) == 0:
527 if Options["No-Action"] or Options["Automatic"]:
530 note = print_new(upload, missing, indexed=0, session=session)
533 has_unprocessed_byhand = False
535 path = os.path.join(queuedir, f.filename)
536 if not f.processed and os.path.exists(path):
537 print "W: {0} still present; please process byhand components and try again".format(f.filename)
538 has_unprocessed_byhand = True
540 if not has_unprocessed_byhand and not broken and not note:
541 if len(missing) == 0:
545 prompt = "Add overrides, "
547 print "W: [!] marked entries must be fixed before package can be processed."
549 print "W: note must be removed before package can be processed."
550 prompt += "RemOve all notes, Remove note, "
552 prompt += "Edit overrides, Check, Manual reject, Note edit, Prod, [S]kip, Quit ?"
554 while prompt.find(answer) == -1:
555 answer = utils.our_raw_input(prompt)
556 m = re_default_answer.search(prompt)
559 answer = answer[:1].upper()
561 if answer in ( 'A', 'E', 'M', 'O', 'R' ) and Options["Trainee"]:
562 utils.warn("Trainees can't do that")
565 if answer == 'A' and not Options["Trainee"]:
566 add_overrides(missing, upload.target_suite, session)
567 if Config().find_b("Dinstall::BXANotify"):
568 do_bxa_notification(missing, upload, session)
571 Logger.log(["NEW ACCEPT", upload.changes.changesname])
573 check_pkg(upload, upload_copy, session)
574 elif answer == 'E' and not Options["Trainee"]:
575 missing = edit_overrides (missing, upload, session)
576 elif answer == 'M' and not Options["Trainee"]:
577 reason = Options.get('Manual-Reject', '') + "\n"
578 reason = reason + "\n\n=====\n\n".join([n.comment for n in get_new_comments(upload.policy_queue, upload.changes.source, session=session)])
579 reason = get_reject_reason(reason)
580 if reason is not None:
581 Logger.log(["NEW REJECT", upload.changes.changesname])
582 handler.reject(reason)
585 if edit_note(get_new_comments(upload.policy_queue, upload.changes.source, session=session),
586 upload, session, bool(Options["Trainee"])) == 0:
589 elif answer == 'P' and not Options["Trainee"]:
590 if prod_maintainer(get_new_comments(upload.policy_queue, upload.changes.source, session=session),
594 Logger.log(["NEW PROD", upload.changes.changesname])
595 elif answer == 'R' and not Options["Trainee"]:
596 confirm = utils.our_raw_input("Really clear note (y/N)? ").lower()
598 for c in get_new_comments(upload.policy_queue, upload.changes.source, upload.changes.version, session=session):
601 elif answer == 'O' and not Options["Trainee"]:
602 confirm = utils.our_raw_input("Really clear all notes (y/N)? ").lower()
604 for c in get_new_comments(upload.policy_queue, upload.changes.source, session=session):
614 if handler.get_action():
615 print "PENDING %s\n" % handler.get_action()
617 ################################################################################
618 ################################################################################
619 ################################################################################
621 def usage (exit_code=0):
622 print """Usage: dak process-new [OPTION]... [CHANGES]...
623 -a, --automatic automatic run
624 -b, --no-binaries do not sort binary-NEW packages first
625 -c, --comments show NEW comments
626 -h, --help show this help and exit.
627 -m, --manual-reject=MSG manual reject with `msg'
628 -n, --no-action don't do anything
629 -q, --queue=QUEUE operate on a different queue
630 -t, --trainee FTP Trainee mode
631 -V, --version display the version number and exit
633 ENVIRONMENT VARIABLES
635 DAK_INSPECT_UPLOAD: shell command to run to inspect a package
636 The command is automatically run in a shell when an upload
637 is checked. The following substitutions are available:
639 {directory}: directory the upload is contained in
640 {dsc}: name of the included dsc or the empty string
641 {changes}: name of the changes file
643 Note that Python's 'format' method is used to format the command.
645 Example: run mc in a tmux session to inspect the upload
647 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"'
651 tmux attach -t process-new
653 in a separate terminal session.
657 ################################################################################
659 @contextlib.contextmanager
660 def lock_package(package):
662 Lock C{package} so that noone else jumps in processing it.
664 @type package: string
665 @param package: source package name to lock
670 path = os.path.join(cnf.get("Process-New::LockDir", cnf['Dir::Lock']), package)
673 fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDONLY)
675 if e.errno == errno.EEXIST or e.errno == errno.EACCES:
676 user = pwd.getpwuid(os.stat(path)[stat.ST_UID])[4].split(',')[0].replace('.', '')
677 raise AlreadyLockedError(user)
684 def do_pkg(upload, session):
685 # Try to get an included dsc
689 group = cnf.get('Dinstall::UnprivGroup') or None
691 #bcc = "X-DAK: dak process-new"
692 #if cnf.has_key("Dinstall::Bcc"):
693 # u.Subst["__BCC__"] = bcc + "\nBcc: %s" % (cnf["Dinstall::Bcc"])
695 # u.Subst["__BCC__"] = bcc
698 with lock_package(upload.changes.source):
699 with UploadCopy(upload, group=group) as upload_copy:
700 handler = PolicyQueueUploadHandler(upload, session)
701 if handler.get_action() is not None:
702 print "PENDING %s\n" % handler.get_action()
705 do_new(upload, upload_copy, handler, session)
706 except AlreadyLockedError as e:
707 print "Seems to be locked by %s already, skipping..." % (e)
709 def show_new_comments(uploads, session):
710 sources = [ upload.changes.source for upload in uploads ]
711 if len(sources) == 0:
714 query = """SELECT package, version, comment, author
716 WHERE package IN :sources
717 ORDER BY package, version"""
719 r = session.execute(query, params=dict(sources=tuple(sources)))
722 print "%s_%s\n%s\n(%s)\n\n\n" % (i[0], i[1], i[2], i[3])
726 ################################################################################
728 def sort_uploads(new_queue, uploads, session, nobinaries=False):
731 suitesrc = [s.source for s in session.query(DBSource.source). \
732 filter(DBSource.suites.any(Suite.suite_name.in_(['unstable', 'experimental'])))]
733 comments = [p.package for p in session.query(NewComment.package). \
734 filter_by(trainee=False, policy_queue=new_queue).distinct()]
735 for upload in uploads:
736 source = upload.changes.source
737 if not source in sources:
739 sources[source].append({'upload': upload,
740 'date': upload.changes.created,
742 'binary': True if source in suitesrc else False,
743 'comments': True if source in comments else False})
745 if len(sources[src]) > 1:
746 changes = sources[src]
747 firstseen = sorted(changes, key=lambda k: (k['date']))[0]['date']
748 changes.sort(key=lambda item:item['date'])
749 for i in range (0, len(changes)):
750 changes[i]['date'] = firstseen
751 changes[i]['stack'] = i + 1
752 sorteduploads += sources[src]
754 sorteduploads = [u["upload"] for u in sorted(sorteduploads,
755 key=lambda k: (k["comments"], k["binary"],
756 k["date"], -k["stack"]))]
758 sorteduploads = [u["upload"] for u in sorted(sorteduploads,
759 key=lambda k: (k["comments"], -k["binary"],
760 k["date"], -k["stack"]))]
763 ################################################################################
766 accept_count = SummaryStats().accept_count
767 accept_bytes = SummaryStats().accept_bytes
773 sys.stderr.write("Accepted %d package %s, %s.\n" % (accept_count, sets, utils.size_type(int(accept_bytes))))
774 Logger.log(["total",accept_count,accept_bytes])
776 if not Options["No-Action"] and not Options["Trainee"]:
779 ################################################################################
782 global Options, Logger, Sections, Priorities
785 session = DBConn().session()
787 Arguments = [('a',"automatic","Process-New::Options::Automatic"),
788 ('b',"no-binaries","Process-New::Options::No-Binaries"),
789 ('c',"comments","Process-New::Options::Comments"),
790 ('h',"help","Process-New::Options::Help"),
791 ('m',"manual-reject","Process-New::Options::Manual-Reject", "HasArg"),
792 ('t',"trainee","Process-New::Options::Trainee"),
793 ('q','queue','Process-New::Options::Queue', 'HasArg'),
794 ('n',"no-action","Process-New::Options::No-Action")]
796 changes_files = apt_pkg.parse_commandline(cnf.Cnf,Arguments,sys.argv)
798 for i in ["automatic", "no-binaries", "comments", "help", "manual-reject", "no-action", "version", "trainee"]:
799 if not cnf.has_key("Process-New::Options::%s" % (i)):
800 cnf["Process-New::Options::%s" % (i)] = ""
802 queue_name = cnf.get('Process-New::Options::Queue', 'new')
803 new_queue = session.query(PolicyQueue).filter_by(queue_name=queue_name).one()
804 if len(changes_files) == 0:
805 uploads = new_queue.uploads
807 uploads = session.query(PolicyQueueUpload).filter_by(policy_queue=new_queue) \
808 .join(DBChange).filter(DBChange.changesname.in_(changes_files)).all()
810 Options = cnf.subtree("Process-New::Options")
815 if not Options["No-Action"]:
817 Logger = daklog.Logger("process-new")
818 except CantOpenError as e:
819 Options["Trainee"] = "True"
821 Sections = Section_Completer(session)
822 Priorities = Priority_Completer(session)
823 readline.parse_and_bind("tab: complete")
826 sys.stderr.write("Sorting changes...\n")
827 uploads = sort_uploads(new_queue, uploads, session, Options["No-Binaries"])
829 if Options["Comments"]:
830 show_new_comments(uploads, session)
832 for upload in uploads:
833 do_pkg (upload, session)
837 ################################################################################
839 if __name__ == '__main__':