webapp.py: fuse two sql queries in get_details
[~helmut/debian-dedup.git] / webapp.py
1 #!/usr/bin/python3
2
3 import argparse
4 import contextlib
5 import datetime
6 import io
7 import sqlite3
8 from wsgiref.simple_server import make_server
9
10 import jinja2
11 from werkzeug.exceptions import HTTPException, NotFound
12 from werkzeug.routing import Map, Rule
13 from werkzeug.utils import redirect
14 from werkzeug.wrappers import Request, Response
15 try:
16     from werkzeug.middleware.shared_data import SharedDataMiddleware
17 except ImportError:
18     from werkzeug.wsgi import SharedDataMiddleware
19
20 from dedup.utils import fetchiter
21
22 jinjaenv = jinja2.Environment(loader=jinja2.PackageLoader("dedup", "templates"))
23
24 def format_size(size):
25     sizef = float(size)
26     fmt = "%d B"
27     if sizef >= 1024:
28         sizef /= 1024
29         fmt = "%.1f KB"
30     if sizef >= 1024:
31         sizef /= 1024
32         fmt = "%.1f MB"
33     if sizef >= 1024:
34         sizef /= 1024
35         fmt = "%.1f GB"
36     return fmt % sizef
37
38 def function_combination(function1, function2):
39     if function1 == function2:
40         return function1
41     return "%s -> %s" % (function1, function2)
42
43 # Workaround for jinja bug #59 (broken filesizeformat)
44 jinjaenv.filters["filesizeformat"] = format_size
45
46 base_template = jinjaenv.get_template("base.html")
47 package_template = jinjaenv.get_template("binary.html")
48 detail_template = jinjaenv.get_template("compare.html")
49 hash_template = jinjaenv.get_template("hash.html")
50 index_template = jinjaenv.get_template("index.html")
51 source_template = jinjaenv.get_template("source.html")
52
53 def encode_and_buffer(stream):
54     stream.enable_buffering(16)
55     buff = io.BytesIO()
56     for elem in stream:
57         buff.write(elem.encode("utf8"))
58         if buff.tell() >= 2048:
59             yield buff.getvalue()
60             buff = io.BytesIO()
61     if buff.tell() > 0:
62         yield buff.getvalue()
63
64 def html_response(unicode_iterator, max_age=24 * 60 * 60):
65     resp = Response(encode_and_buffer(unicode_iterator), mimetype="text/html")
66     resp.cache_control.max_age = max_age
67     resp.expires = datetime.datetime.now() + datetime.timedelta(seconds=max_age)
68     return resp
69
70 class InternalRedirect(Exception):
71     def __init__(self, target, code=301):
72         Exception.__init__(self)
73         self.target = target
74         self.code = code
75
76 class Application:
77     def __init__(self, db):
78         self.db = db
79         self.routingmap = Map([
80             Rule("/", methods=("GET",), endpoint="index"),
81             Rule("/binary/<package>", methods=("GET",), endpoint="package"),
82             Rule("/compare/<package1>/<package2>", methods=("GET",), endpoint="detail"),
83             Rule("/hash/<function>/<hashvalue>", methods=("GET",), endpoint="hash"),
84             Rule("/source/<package>", methods=("GET",), endpoint="source"),
85         ])
86
87     def cursor(self):
88         return contextlib.closing(self.db.cursor())
89
90     @Request.application
91     def __call__(self, request):
92         mapadapter = self.routingmap.bind_to_environ(request.environ)
93         try:
94             endpoint, args = mapadapter.match()
95             if endpoint == "index" and not request.environ["PATH_INFO"]:
96                 raise InternalRedirect("/")
97             method = getattr(self, "show_" + endpoint, None)
98             if method is None:
99                 return NotFound()
100             return method(**args)
101         except InternalRedirect as r:
102             return redirect(request.environ["SCRIPT_NAME"] + r.target, r.code)
103         except HTTPException as e:
104             return e
105
106     def get_details(self, package):
107         with self.cursor() as cur:
108             cur.execute("SELECT p.id, version, architecture, count(filename), ifnull(sum(size), 0) FROM package AS p LEFT JOIN content ON p.id = content.pid WHERE name = ? GROUP BY p.id;",
109                         (package,))
110             row = cur.fetchone()
111         if not row:
112             raise NotFound()
113         return dict(
114             package=package,
115             pid=row[0],
116             version=row[1],
117             architecture=row[2],
118             num_files=row[3],
119             total_size=row[4],
120         )
121
122     def get_dependencies(self, pid):
123         with self.cursor() as cur:
124             cur.execute("SELECT required FROM dependency WHERE pid = ?;",
125                         (pid,))
126             return set(row[0] for row in fetchiter(cur))
127
128     def cached_sharedstats(self, pid):
129         sharedstats = {}
130         with self.cursor() as cur:
131             cur.execute("SELECT pid2, package.name, f1.name, f2.name, files, size FROM sharing JOIN package ON sharing.pid2 = package.id JOIN function AS f1 ON sharing.fid1 = f1.id JOIN function AS f2 ON sharing.fid2 = f2.id WHERE pid1 = ? AND f1.eqclass = f2.eqclass;",
132                         (pid,))
133             for pid2, package2, func1, func2, files, size in fetchiter(cur):
134                 curstats = sharedstats.setdefault(
135                         function_combination(func1, func2), list())
136                 if pid2 == pid:
137                     package2 = None
138                 curstats.append(dict(package=package2, duplicate=files,
139                                      savable=size))
140         return sharedstats
141
142     def show_index(self):
143         return html_response(index_template.stream(dict(urlroot="")))
144
145     def show_package(self, *, package):
146         params = self.get_details(package)
147         params["dependencies"] = self.get_dependencies(params["pid"])
148         params["shared"] = self.cached_sharedstats(params["pid"])
149         params["urlroot"] = ".."
150         with self.cursor() as cur:
151             cur.execute("SELECT content.filename, issue.issue FROM content JOIN issue ON content.id = issue.cid WHERE content.pid = ?;",
152                         (params["pid"],))
153             params["issues"] = dict(cur.fetchall())
154         return html_response(package_template.stream(params))
155
156     def compute_comparison(self, pid1, pid2):
157         """Compute a sequence of comparison objects ordered by the size of the
158         object in the first package. Each element of the sequence is a dict
159         defining the following keys:
160          * filenames: A set of filenames in package 1 (pid1) all referring to
161            the same object.
162          * size: Size of the object in bytes.
163          * matches: A mapping from filenames in package 2 (pid2) to a mapping
164            from hash function pairs to hash values.
165         """
166         with self.cursor() as cur, self.cursor() as cur2:
167             cur.execute("SELECT content.id, content.filename, content.size, hash.hash FROM content JOIN hash ON content.id = hash.cid JOIN duplicate ON content.id = duplicate.cid JOIN function ON hash.fid = function.id WHERE pid = ? AND function.name = 'sha512' ORDER BY size DESC;",
168                         (pid1,))
169             cursize = -1
170             files = dict()
171             minmatch = 2 if pid1 == pid2 else 1
172             cur2 = self.db.cursor()
173             for cid, filename, size, hashvalue in fetchiter(cur):
174                 if cursize != size:
175                     for entry in files.values():
176                         if len(entry["matches"]) >= minmatch:
177                             yield entry
178                     files.clear()
179                     cursize = size
180
181                 if hashvalue in files:
182                     files[hashvalue]["filenames"].add(filename)
183                     continue
184
185                 entry = dict(filenames=set((filename,)), size=size, matches={})
186                 files[hashvalue] = entry
187
188                 cur2.execute("SELECT fa.name, ha.hash, fb.name, filename FROM hash AS ha JOIN hash AS hb ON ha.hash = hb.hash JOIN content ON hb.cid = content.id JOIN function AS fa ON ha.fid = fa.id JOIN function AS fb ON hb.fid = fb.id WHERE ha.cid = ? AND pid = ? AND fa.eqclass = fb.eqclass;",
189                              (cid, pid2))
190                 for func1, hashvalue, func2, filename in fetchiter(cur2):
191                     entry["matches"].setdefault(filename, {})[func1, func2] = \
192                             hashvalue
193
194         for entry in files.values():
195             if len(entry["matches"]) >= minmatch:
196                 yield entry
197
198     def show_detail(self, *, package1, package2):
199         details1 = details2 = self.get_details(package1)
200         if package1 != package2:
201             details2 = self.get_details(package2)
202
203         shared = self.compute_comparison(details1["pid"], details2["pid"])
204         params = dict(
205             details1=details1,
206             details2=details2,
207             urlroot="../..",
208             shared=shared)
209         return html_response(detail_template.stream(params))
210
211     def show_hash(self, *, function, hashvalue):
212         if function == "image_sha512":
213             # backwards compatibility
214             raise InternalRedirect("/hash/png_sha512/%s" % hashvalue)
215
216         with self.cursor() as cur:
217             cur.execute("SELECT package.name, content.filename, content.size, f2.name FROM hash JOIN content ON hash.cid = content.id JOIN package ON content.pid = package.id JOIN function AS f2 ON hash.fid = f2.id JOIN function AS f1 ON f2.eqclass = f1.eqclass WHERE f1.name = ? AND hash = ?;",
218                         (function, hashvalue,))
219             entries = [dict(package=package, filename=filename, size=size,
220                             function=otherfunc)
221                        for package, filename, size, otherfunc in fetchiter(cur)]
222             if not entries:
223                 # Assumption: '~' serves as an infinite character larger than
224                 # any other character in the hash column.
225                 cur.execute("SELECT DISTINCT hash.hash FROM hash JOIN function ON hash.fid = function.id WHERE function.name = ? AND hash.hash >= ? AND hash.hash <= ? LIMIT 2;",
226                             (function, hashvalue, hashvalue + '~'))
227                 values = cur.fetchall()
228                 if len(values) == 1:
229                     raise InternalRedirect("/hash/%s/%s" %
230                                            (function, values[0][0]), 302)
231                 raise NotFound()
232         params = dict(function=function, hashvalue=hashvalue, entries=entries,
233                       urlroot="../..")
234         return html_response(hash_template.stream(params))
235
236     def show_source(self, *, package):
237         with self.cursor() as cur:
238             cur.execute("SELECT name FROM package WHERE source = ?;",
239                         (package,))
240             binpkgs = dict.fromkeys(pkg for pkg, in fetchiter(cur))
241             if not binpkgs:
242                 raise NotFound
243             cur.execute("SELECT p1.name, p2.name, f1.name, f2.name, sharing.files, sharing.size FROM sharing JOIN package AS p1 ON sharing.pid1 = p1.id JOIN package AS p2 ON sharing.pid2 = p2.id JOIN function AS f1 ON sharing.fid1 = f1.id JOIN function AS f2 ON sharing.fid2 = f2.id WHERE p1.source = ?;",
244                         (package,))
245             for binary, otherbin, func1, func2, files, size in fetchiter(cur):
246                 entry = dict(package=otherbin,
247                              funccomb=function_combination(func1, func2),
248                              duplicate=files, savable=size)
249                 oldentry = binpkgs.get(binary)
250                 if not (oldentry and oldentry["savable"] >= size):
251                     binpkgs[binary] = entry
252         params = dict(source=package, packages=binpkgs, urlroot="..")
253         return html_response(source_template.stream(params))
254
255 def main():
256     parser = argparse.ArgumentParser()
257     parser.add_argument("-d", "--database", action="store",
258                         default="test.sqlite3",
259                         help="path to the sqlite3 database file")
260     args = parser.parse_args()
261     app = Application(sqlite3.connect(args.database))
262     app = SharedDataMiddleware(app, {"/static": ("dedup", "static")})
263     make_server("0.0.0.0", 8800, app).serve_forever()
264
265 if __name__ == "__main__":
266     main()