]> git.decadent.org.uk Git - dak.git/blob - dak/generate_packages_sources2.py
Include short description.
[dak.git] / dak / generate_packages_sources2.py
1 #!/usr/bin/python
2
3 """
4 Generate Packages/Sources files
5
6 @contact: Debian FTP Master <ftpmaster@debian.org>
7 @copyright: 2011  Ansgar Burchardt <ansgar@debian.org>
8 @copyright: Based on daklib/lists.py and dak/generate_filelist.py:
9             2009-2011  Torsten Werner <twerner@debian.org>
10 @copyright: Based on dak/generate_packages_sources.py:
11             2000, 2001, 2002, 2006  James Troup <james@nocrew.org>
12             2009  Mark Hymers <mhy@debian.org>
13             2010  Joerg Jaspert <joerg@debian.org>
14 @license: GNU General Public License version 2 or later
15 """
16
17 # This program is free software; you can redistribute it and/or modify
18 # it under the terms of the GNU General Public License as published by
19 # the Free Software Foundation; either version 2 of the License, or
20 # (at your option) any later version.
21
22 # This program is distributed in the hope that it will be useful,
23 # but WITHOUT ANY WARRANTY; without even the implied warranty of
24 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 # GNU General Public License for more details.
26
27 # You should have received a copy of the GNU General Public License
28 # along with this program; if not, write to the Free Software
29 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30
31 import apt_pkg, sys
32
33 def usage():
34     print """Usage: dak generate-packages-sources2 [OPTIONS]
35 Generate the Packages/Sources files
36
37   -s, --suite=SUITE            process this suite
38                                Default: All suites not marked 'untouchable'
39   -f, --force                  Allow processing of untouchable suites
40                                CAREFUL: Only to be used at point release time!
41   -5, --description-md5        Allow to use Description-md5 instead of
42                                Description for Packages index and generate
43                                Translation-en
44                                NOTE: suite.include_long_descriptions needs to
45                                be set to false for this.
46   -h, --help                   show this help and exit
47
48 SUITE can be a space seperated list, e.g.
49    --suite=unstable testing
50 """
51     sys.exit()
52
53 #############################################################################
54
55 # Here be dragons.
56 _sources_query = R"""
57 SELECT
58
59   (SELECT
60      STRING_AGG(
61        CASE
62          WHEN key = 'Source' THEN 'Package\: '
63          WHEN key = 'Files' THEN E'Files\:\n ' || f.md5sum || ' ' || f.size || ' ' || SUBSTRING(f.filename FROM E'/([^/]*)\\Z')
64          WHEN key = 'Checksums-Sha1' THEN E'Checksums-Sha1\:\n ' || f.sha1sum || ' ' || f.size || ' ' || SUBSTRING(f.filename FROM E'/([^/]*)\\Z')
65          WHEN key = 'Checksums-Sha256' THEN E'Checksums-Sha256\:\n ' || f.sha256sum || ' ' || f.size || ' ' || SUBSTRING(f.filename FROM E'/([^/]*)\\Z')
66          ELSE key || '\: '
67        END || value, E'\n' ORDER BY mk.ordering, mk.key)
68    FROM
69      source_metadata sm
70      JOIN metadata_keys mk ON mk.key_id = sm.key_id
71    WHERE s.id=sm.src_id
72   )
73   ||
74   E'\nDirectory\: pool/' || SUBSTRING(f.filename FROM E'\\A(.*)/[^/]*\\Z')
75   ||
76   E'\nPriority\: ' || pri.priority
77   ||
78   E'\nSection\: ' || sec.section
79
80 FROM
81
82 source s
83 JOIN src_associations sa ON s.id = sa.source
84 JOIN files f ON s.file=f.id
85 JOIN override o ON o.package = s.source
86 JOIN section sec ON o.section = sec.id
87 JOIN priority pri ON o.priority = pri.id
88
89 WHERE
90   sa.suite = :suite
91   AND o.suite = :overridesuite AND o.component = :component AND o.type = :dsc_type
92
93 ORDER BY
94 s.source, s.version
95 """
96
97 def generate_sources(suite_id, component_id):
98     global _sources_query
99     from daklib.filewriter import SourcesFileWriter
100     from daklib.dbconn import Component, DBConn, OverrideType, Suite
101     from daklib.dakmultiprocessing import PROC_STATUS_SUCCESS
102
103     session = DBConn().session()
104     dsc_type = session.query(OverrideType).filter_by(overridetype='dsc').one().overridetype_id
105
106     suite = session.query(Suite).get(suite_id)
107     component = session.query(Component).get(component_id)
108
109     overridesuite_id = suite.get_overridesuite().suite_id
110
111     writer = SourcesFileWriter(suite=suite.suite_name, component=component.component_name)
112     output = writer.open()
113
114     # run query and write Sources
115     r = session.execute(_sources_query, {"suite": suite_id, "component": component_id, "dsc_type": dsc_type, "overridesuite": overridesuite_id})
116     for (stanza,) in r:
117         print >>output, stanza
118         print >>output, ""
119
120     writer.close()
121
122     message = ["generate sources", suite.suite_name, component.component_name]
123     session.rollback()
124     return (PROC_STATUS_SUCCESS, message)
125
126 #############################################################################
127
128 # Here be large dragons.
129 _packages_query = R"""
130 WITH
131
132   tmp AS (
133     SELECT
134       b.id AS binary_id,
135       b.package AS package,
136       b.version AS version,
137       b.architecture AS architecture,
138       b.source AS source_id,
139       s.source AS source,
140       f.filename AS filename,
141       f.size AS size,
142       f.md5sum AS md5sum,
143       f.sha1sum AS sha1sum,
144       f.sha256sum AS sha256sum
145     FROM
146       binaries b
147       JOIN bin_associations ba ON b.id = ba.bin
148       JOIN files f ON f.id = b.file
149       JOIN location l ON l.id = f.location
150       JOIN source s ON b.source = s.id
151     WHERE
152       (b.architecture = :arch_all OR b.architecture = :arch) AND b.type = :type_name
153       AND ba.suite = :suite
154       AND l.component = :component
155   )
156
157 SELECT
158   (SELECT
159      STRING_AGG(key || '\: ' || value, E'\n' ORDER BY ordering, key)
160    FROM
161      (SELECT key, ordering,
162         CASE WHEN :include_long_description = 'false' AND key = 'Description'
163           THEN SUBSTRING(value FROM E'\\A[^\n]*')
164           ELSE value
165         END AS value
166       FROM
167         binaries_metadata bm
168         JOIN metadata_keys mk ON mk.key_id = bm.key_id
169       WHERE
170         bm.bin_id = tmp.binary_id
171         AND key != ALL (:metadata_skip)
172      ) AS metadata
173   )
174   || COALESCE(E'\n' || (SELECT
175      STRING_AGG(key || '\: ' || value, E'\n' ORDER BY key)
176    FROM external_overrides eo
177    WHERE
178      eo.package = tmp.package
179      AND eo.suite = :overridesuite AND eo.component = :component
180   ), '')
181   || E'\nSection\: ' || sec.section
182   || E'\nPriority\: ' || pri.priority
183   || E'\nFilename\: pool/' || tmp.filename
184   || E'\nSize\: ' || tmp.size
185   || E'\nMD5sum\: ' || tmp.md5sum
186   || E'\nSHA1\: ' || tmp.sha1sum
187   || E'\nSHA256\: ' || tmp.sha256sum
188
189 FROM
190   tmp
191   JOIN override o ON o.package = tmp.package
192   JOIN section sec ON sec.id = o.section
193   JOIN priority pri ON pri.id = o.priority
194
195 WHERE
196   (
197       architecture <> :arch_all
198     OR
199       (architecture = :arch_all AND source_id IN (SELECT source_id FROM tmp WHERE architecture <> :arch_all))
200     OR
201       (architecture = :arch_all AND source NOT IN (SELECT DISTINCT source FROM tmp WHERE architecture <> :arch_all))
202   )
203   AND
204     o.type = :type_id AND o.suite = :overridesuite AND o.component = :component
205
206 ORDER BY tmp.source, tmp.package, tmp.version
207 """
208
209 def generate_packages(suite_id, component_id, architecture_id, type_name, use_description_md5):
210     global _packages_query
211     from daklib.filewriter import PackagesFileWriter
212     from daklib.dbconn import Architecture, Component, DBConn, OverrideType, Suite
213     from daklib.dakmultiprocessing import PROC_STATUS_SUCCESS
214
215     session = DBConn().session()
216     arch_all_id = session.query(Architecture).filter_by(arch_string='all').one().arch_id
217     type_id = session.query(OverrideType).filter_by(overridetype=type_name).one().overridetype_id
218
219     suite = session.query(Suite).get(suite_id)
220     component = session.query(Component).get(component_id)
221     architecture = session.query(Architecture).get(architecture_id)
222
223     overridesuite_id = suite.get_overridesuite().suite_id
224     include_long_description = suite.include_long_description or not use_description_md5
225
226     # We currently filter out the "Tag" line. They are set by external
227     # overrides and NOT by the maintainer. And actually having it set by
228     # maintainer means we output it twice at the moment -> which breaks
229     # dselect.
230     metadata_skip = ["Section", "Priority", "Tag"]
231     if include_long_description:
232         metadata_skip.append("Description-md5")
233
234     writer = PackagesFileWriter(suite=suite.suite_name, component=component.component_name,
235             architecture=architecture.arch_string, debtype=type_name)
236     output = writer.open()
237
238     r = session.execute(_packages_query, {"suite": suite_id, "component": component_id,
239         "arch": architecture_id, "type_id": type_id, "type_name": type_name, "arch_all": arch_all_id,
240         "overridesuite": overridesuite_id, "metadata_skip": metadata_skip,
241         "include_long_description": 'true' if include_long_description else 'false'})
242     for (stanza,) in r:
243         print >>output, stanza
244         print >>output, ""
245
246     writer.close()
247
248     message = ["generate-packages", suite.suite_name, component.component_name, architecture.arch_string]
249     session.rollback()
250     return (PROC_STATUS_SUCCESS, message)
251
252 #############################################################################
253
254 _translations_query = """
255 WITH
256   override_suite AS
257     (SELECT
258       s.id AS id,
259       COALESCE(os.id, s.id) AS overridesuite_id
260       FROM suite AS s LEFT JOIN suite AS os ON s.overridesuite = os.suite_name)
261
262 SELECT
263      'Package\: ' || b.package
264   || E'\nDescription-md5\: ' || bm_description_md5.value
265   || E'\nDescription-en\: ' || bm_description.value
266   || E'\n'
267 FROM binaries b
268   -- join tables for suite and component
269   JOIN bin_associations ba ON b.id = ba.bin
270   JOIN override_suite os ON os.id = ba.suite
271   JOIN override o ON b.package = o.package AND o.suite = os.overridesuite_id AND o.type = (SELECT id FROM override_type WHERE type = 'deb')
272
273   -- join tables for Description and Description-md5
274   JOIN binaries_metadata bm_description ON b.id = bm_description.bin_id AND bm_description.key_id = (SELECT key_id FROM metadata_keys WHERE key = 'Description')
275   JOIN binaries_metadata bm_description_md5 ON b.id = bm_description_md5.bin_id AND bm_description_md5.key_id = (SELECT key_id FROM metadata_keys WHERE key = 'Description-md5')
276
277   -- we want to sort by source name
278   JOIN source s ON b.source = s.id
279
280 WHERE ba.suite = :suite AND o.component = :component
281 GROUP BY s.source, b.package, bm_description_md5.value, bm_description.value
282 ORDER BY s.source, b.package, bm_description_md5.value
283 """
284
285 def generate_translations(suite_id, component_id):
286     global _translations_query
287     from daklib.filewriter import TranslationFileWriter
288     from daklib.dbconn import DBConn, Suite, Component
289     from daklib.dakmultiprocessing import PROC_STATUS_SUCCESS
290
291     session = DBConn().session()
292     suite = session.query(Suite).get(suite_id)
293     component = session.query(Component).get(component_id)
294
295     writer = TranslationFileWriter(suite=suite.suite_name, component=component.component_name, language="en")
296     output = writer.open()
297
298     r = session.execute(_translations_query, {"suite": suite_id, "component": component_id})
299     for (stanza,) in r:
300         print >>output, stanza
301
302     writer.close()
303
304     message = ["generate-translations", suite.suite_name, component.component_name]
305     session.rollback()
306     return (PROC_STATUS_SUCCESS, message)
307
308 #############################################################################
309
310 def main():
311     from daklib.config import Config
312     from daklib import daklog
313
314     cnf = Config()
315
316     Arguments = [('h',"help","Generate-Packages-Sources::Options::Help"),
317                  ('5','description-md5',"Generate-Packages-Sources::Options::Description-md5"),
318                  ('s',"suite","Generate-Packages-Sources::Options::Suite"),
319                  ('f',"force","Generate-Packages-Sources::Options::Force"),
320                  ('o','option','','ArbItem')]
321
322     suite_names = apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
323     try:
324         Options = cnf.SubTree("Generate-Packages-Sources::Options")
325     except KeyError:
326         Options = {}
327
328     if Options.has_key("Help"):
329         usage()
330
331     from daklib.dakmultiprocessing import DakProcessPool, PROC_STATUS_SUCCESS, PROC_STATUS_SIGNALRAISED
332     pool = DakProcessPool()
333
334     logger = daklog.Logger('generate-packages-sources2')
335
336     from daklib.dbconn import Component, DBConn, get_suite, Suite
337     session = DBConn().session()
338     session.execute("SELECT add_missing_description_md5()")
339     session.commit()
340
341     if Options.has_key("Suite"):
342         suites = []
343         for s in suite_names:
344             suite = get_suite(s.lower(), session)
345             if suite:
346                 suites.append(suite)
347             else:
348                 print "I: Cannot find suite %s" % s
349                 logger.log(['Cannot find suite %s' % s])
350     else:
351         suites = session.query(Suite).filter(Suite.untouchable == False).all()
352
353     use_description_md5 = Options.has_key("Description-md5") and Options["Description-md5"]
354     force = Options.has_key("Force") and Options["Force"]
355
356     component_ids = [ c.component_id for c in session.query(Component).all() ]
357
358     def parse_results(message):
359         # Split out into (code, msg)
360         code, msg = message
361         if code == PROC_STATUS_SUCCESS:
362             logger.log([msg])
363         elif code == PROC_STATUS_SIGNALRAISED:
364             logger.log(['E: Subprocess recieved signal ', msg])
365         else:
366             logger.log(['E: ', msg])
367
368     for s in suites:
369         if s.untouchable and not force:
370             utils.fubar("Refusing to touch %s (untouchable and not forced)" % s.suite_name)
371         for c in component_ids:
372             pool.apply_async(generate_sources, [s.suite_id, c], callback=parse_results)
373             if use_description_md5 and not s.include_long_description:
374                 pool.apply_async(generate_translations, [s.suite_id, c], callback=parse_results)
375             for a in s.architectures:
376                 if a == 'source':
377                     continue
378                 pool.apply_async(generate_packages, [s.suite_id, c, a.arch_id, 'deb', use_description_md5], callback=parse_results)
379                 pool.apply_async(generate_packages, [s.suite_id, c, a.arch_id, 'udeb', use_description_md5], callback=parse_results)
380
381     pool.close()
382     pool.join()
383
384     # this script doesn't change the database
385     session.close()
386
387     logger.close()
388
389     sys.exit(pool.overall_status())
390
391 if __name__ == '__main__':
392     main()