-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
install.py
507 lines (407 loc) · 16 KB
/
install.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
"""
pgxnclient -- installation/loading commands implementation
"""
# Copyright (C) 2011 Daniele Varrazzo
# This file is part of the PGXN client
import os
import re
import sys
import shutil
import difflib
import logging
from subprocess import PIPE
from pgxnclient import SemVer
from pgxnclient.i18n import _, N_
from pgxnclient.utils import sha1
from pgxnclient.errors import BadChecksum, PgxnClientException
from pgxnclient.network import download
from pgxnclient.commands import Command, WithDatabase, WithMake, WithPgConfig
from pgxnclient.commands import WithSpec, WithSpecLocal, WithSudo
from pgxnclient.utils.strings import Identifier
logger = logging.getLogger('pgxnclient.commands')
class Download(WithSpec, Command):
name = 'download'
description = N_("download a distribution from the network")
@classmethod
def customize_parser(self, parser, subparsers, **kwargs):
subp = super(Download, self).customize_parser(
parser, subparsers, **kwargs)
subp.add_argument('--target', metavar='PATH', default='.',
help = _('Target directory and/or filename to save'))
return subp
def run(self):
spec = self.get_spec()
data = self.get_meta(spec)
try:
chk = data['sha1']
except KeyError:
raise PgxnClientException(
"sha1 missing from the distribution meta")
fin = self.api.download(data['name'], SemVer(data['version']))
fn = self._get_local_file_name(fin.url)
fn = download(fin, fn, rename=True)
self.verify_checksum(fn, chk)
return fn
def verify_checksum(self, fn, chk):
"""Verify that a downloaded file has the expected sha1."""
sha = sha1()
logger.debug(_("checking sha1 of '%s'"), fn)
f = open(fn, "rb")
try:
while 1:
data = f.read(8192)
if not data: break
sha.update(data)
finally:
f.close()
sha = sha.hexdigest()
if sha != chk:
os.unlink(fn)
logger.error(_("file %s has sha1 %s instead of %s"),
fn, sha, chk)
raise BadChecksum(_("bad sha1 in downloaded file"))
def _get_local_file_name(self, url):
from urlparse import urlsplit
if os.path.isdir(self.opts.target):
basename = urlsplit(url)[2].rsplit('/', 1)[-1]
fn = os.path.join(self.opts.target, basename)
else:
fn = self.opts.target
return os.path.abspath(fn)
class InstallUninstall(WithMake, WithSpecLocal, Command):
"""
Base class to implement the ``install`` and ``uninstall`` commands.
"""
def run(self):
return self.call_with_temp_dir(self._run)
def _run(self, dir):
spec = self.get_spec()
if spec.is_dir():
pdir = spec.dirname
elif spec.is_file():
pdir = self.unpack(spec.filename, dir)
else: # download
self.opts.target = dir
fn = Download(self.opts).run()
pdir = self.unpack(fn, dir)
self.maybe_run_configure(pdir)
self._inun(pdir)
def _inun(self, pdir):
"""Run the specific command, implemented in the subclass."""
raise NotImplementedError
def maybe_run_configure(self, dir):
fn = os.path.join(dir, 'configure')
logger.debug("checking '%s'", fn)
if not os.path.exists(fn):
return
logger.info(_("running configure"))
p = self.popen(fn, cwd=dir)
p.communicate()
if p.returncode:
raise PgxnClientException(
_("configure failed with return code %s") % p.returncode)
class Install(WithSudo, InstallUninstall):
name = 'install'
description = N_("download, build and install a distribution")
def _inun(self, pdir):
logger.info(_("building extension"))
self.run_make('all', dir=pdir)
logger.info(_("installing extension"))
self.run_make('install', dir=pdir, sudo=self.opts.sudo)
class Uninstall(WithSudo, InstallUninstall):
name = 'uninstall'
description = N_("remove a distribution from the system")
def _inun(self, pdir):
logger.info(_("removing extension"))
self.run_make('uninstall', dir=pdir, sudo=self.opts.sudo)
class Check(WithDatabase, InstallUninstall):
name = 'check'
description = N_("run a distribution's test")
def _inun(self, pdir):
logger.info(_("checking extension"))
upenv = self.get_psql_env()
logger.debug("additional env: %s", upenv)
env = os.environ.copy()
env.update(upenv)
cmd = ['installcheck']
if 'PGDATABASE' in upenv:
cmd.append("CONTRIB_TESTDB=" + env['PGDATABASE'])
try:
self.run_make(cmd, dir=pdir, env=env)
except PgxnClientException:
# if the test failed, copy locally the regression result
for ext in ('out', 'diffs'):
fn = os.path.join(pdir, 'regression.' + ext)
if os.path.exists(fn):
dest = './regression.' + ext
if not os.path.exists(dest) or not os.path.samefile(fn, dest):
logger.info(_('copying regression.%s'), ext)
shutil.copy(fn, dest)
raise
class LoadUnload(WithPgConfig, WithDatabase, WithSpecLocal, Command):
"""
Base class to implement the ``load`` and ``unload`` commands.
"""
@classmethod
def customize_parser(self, parser, subparsers, **kwargs):
subp = super(LoadUnload, self).customize_parser(
parser, subparsers, **kwargs)
subp.add_argument('--schema', metavar="SCHEMA",
type=Identifier.parse_arg,
help=_("use SCHEMA instead of the default schema"))
subp.add_argument('extensions', metavar='EXT', nargs='*',
help = _("only specified extensions [default: all]"))
return subp
def get_pg_version(self):
"""Return the version of the selected database."""
data = self.call_psql('SELECT version();')
pgver = self.parse_pg_version(data)
logger.debug("PostgreSQL version: %d.%d.%d", *pgver)
return pgver
def parse_pg_version(self, data):
m = re.match(r'\S+\s+(\d+)\.(\d+)(?:\.(\d+))?', data)
if m is None:
raise PgxnClientException(
"cannot parse version number from '%s'" % data)
return (int(m.group(1)), int(m.group(2)), int(m.group(3) or 0))
def is_extension(self, name):
fn = os.path.join(self.call_pg_config('sharedir'),
"extension", name + ".control")
logger.debug("checking if exists %s", fn)
return os.path.exists(fn)
def call_psql(self, command):
cmdline = [self.find_psql()]
cmdline.extend(self.get_psql_options())
if command is not None:
cmdline.append('-tA') # tuple only, unaligned
cmdline.extend(['-c', command])
logger.debug("calling %s", cmdline)
p = self.popen(cmdline, stdout=PIPE)
out, err = p.communicate()
if p.returncode:
raise PgxnClientException(
"psql returned %s running command" % (p.returncode))
return out.decode('utf-8')
def load_sql(self, filename=None, data=None):
cmdline = [self.find_psql()]
cmdline.extend(self.get_psql_options())
# load via pipe to enable psql commands in the file
if not data:
fin = open(filename, 'r')
p = self.popen(cmdline, stdin=fin)
p.communicate()
else:
p = self.popen(cmdline, stdin=PIPE)
p.communicate(data)
if p.returncode:
raise PgxnClientException(
"psql returned %s loading extension" % (p.returncode))
def find_psql(self):
return self.call_pg_config('bindir') + '/psql'
def find_sql_file(self, name, sqlfile):
# In the extension the sql can be specified with a directory,
# butit gets flattened into the target dir by the Makefile
sqlfile = os.path.basename(sqlfile)
sharedir = self.call_pg_config('sharedir')
# TODO: we only check in contrib and in <name>: actually it may be
# somewhere else - only the makefile knows!
tries = [
name + '/' + sqlfile,
sqlfile.rsplit('.', 1)[0] + '/' + sqlfile,
'contrib/' + sqlfile,
]
tried = set()
for fn in tries:
if fn in tried:
continue
tried.add(fn)
fn = sharedir + '/' + fn
logger.debug("checking sql file in %s" % fn)
if os.path.exists(fn):
return fn
else:
raise PgxnClientException(
"cannot find sql file for extension '%s': '%s'"
% (name, sqlfile))
def patch_for_schema(self, fn):
"""
Patch a sql file to set the schema where the commands are executed.
If no schema has been requested, return the data unchanged.
Else, ask for confirmation and return the data for a patched file.
The schema is only useful for PG < 9.1: for proper PG extensions there
is no need to patch the sql.
"""
schema = self.opts.schema
f = open(fn)
try: data = f.read()
finally: f.close()
if not schema:
return data
self._check_schema_exists(schema)
re_path = re.compile(r'SET\s+search_path\s*(?:=|to)\s*([^;]+);', re.I)
m = re_path.search(data)
if m is None:
newdata = ("SET search_path = %s;\n\n" % schema) + data
else:
newdata = re_path.sub("SET search_path = %s;" % schema, data)
diff = ''.join(difflib.unified_diff(
[r + '\n' for r in data.splitlines()],
[r + '\n' for r in newdata.splitlines()],
fn, fn + ".schema"))
msg = _("""
In order to operate in the schema %s, the following changes will be
performed:\n\n%s\n\nDo you want to continue?""")
self.confirm(msg % (schema, diff))
return newdata
def _register_loaded(self, fn):
if not hasattr(self, '_loaded'):
self._loaded = []
self._loaded.append(fn)
def _is_loaded(self, fn):
return hasattr(self, '_loaded') and fn in self._loaded
def _check_schema_exists(self, schema):
cmdline = [self.find_psql()]
cmdline.extend(self.get_psql_options())
cmdline.extend(['-c', 'SET search_path=%s' % schema])
p = self.popen(cmdline, stdin=PIPE, stdout=PIPE, stderr=PIPE)
p.communicate()
if p.returncode:
raise PgxnClientException(
"schema %s does not exist" % schema)
def _get_extensions(self):
"""
Return a list of pairs (name, sql file) to be loaded/unloaded.
Items are in loading order.
"""
spec = self.get_spec()
dist = self.get_meta(spec)
if 'provides' not in dist:
# No 'provides' specified: assume a single extension named
# after the distribution. This is automatically done by PGXN,
# but we should do ourselves to deal with local META files
# not mangled by the PGXN upload script yet.
name = dist['name']
for ext in self.opts.extensions:
if ext <> name:
raise PgxnClientException(
"can't find extension '%s' in the distribution '%s'"
% (name, spec))
return [ (name, None) ]
rv = []
if not self.opts.extensions:
# All the extensions, in the order specified
if len(dist['provides']) > 1 and sys.version_info < (2, 5):
logger.warn(_("can't guarantee extensions load order "
"with Python < 2.5"))
for name, data in dist['provides'].items():
rv.append((name, data.get('file')))
else:
# Only the specified extensions
for name in self.opts.extensions:
try:
data = dist['provides'][name]
except KeyError:
raise PgxnClientException(
"can't find extension '%s' in the distribution '%s'"
% (name, spec))
rv.append((name, data.get('file')))
return rv
class Load(LoadUnload):
name = 'load'
description = N_("load a distribution's extensions into a database")
def run(self):
items = self._get_extensions()
for (name, sql) in items:
self.load_ext(name, sql)
def load_ext(self, name, sqlfile):
logger.debug(_("loading extension '%s' with file: %s"),
name, sqlfile)
if sqlfile and not sqlfile.endswith('.sql'):
logger.info(
_("the specified file '%s' doesn't seem SQL:"
" assuming '%s' is not a PostgreSQL extension"),
sqlfile, name)
return
pgver = self.get_pg_version()
if pgver >= (9,1,0):
if self.is_extension(name):
self.create_extension(name)
return
else:
self.confirm(_("""\
The extension '%s' doesn't contain a control file:
it will be installed as a loose set of objects.
Do you want to continue?""")
% name)
confirm = False
if not sqlfile:
sqlfile = name + '.sql'
confirm = True
fn = self.find_sql_file(name, sqlfile)
if confirm:
self.confirm(_("""\
The extension '%s' doesn't specify a SQL file.
'%s' is probably the right one.
Do you want to load it?""")
% (name, fn))
# TODO: is confirmation asked only once? Also, check for repetition
# in unload.
if self._is_loaded(fn):
logger.info(_("file %s already loaded"), fn)
else:
data = self.patch_for_schema(fn)
self.load_sql(data=data)
self._register_loaded(fn)
def create_extension(self, name):
name = Identifier(name)
schema = self.opts.schema
cmd = ["CREATE EXTENSION", name]
if schema:
cmd.extend(["SCHEMA", schema])
cmd = " ".join(cmd) + ';'
self.load_sql(data=cmd)
class Unload(LoadUnload):
name = 'unload'
description = N_("unload a distribution's extensions from a database")
def run(self):
items = self._get_extensions()
if not self.opts.extensions:
items.reverse()
for (name, sql) in items:
self.unload_ext(name, sql)
def unload_ext(self, name, sqlfile):
logger.debug(_("unloading extension '%s' with file: %s"),
name, sqlfile)
if sqlfile and not sqlfile.endswith('.sql'):
logger.info(
_("the specified file '%s' doesn't seem SQL:"
" assuming '%s' is not a PostgreSQL extension"),
sqlfile, name)
return
pgver = self.get_pg_version()
if pgver >= (9,1,0):
if self.is_extension(name):
self.drop_extension(name)
return
else:
self.confirm(_("""\
The extension '%s' doesn't contain a control file:
will look for an SQL script to unload the objects.
Do you want to continue?""")
% name)
if not sqlfile:
sqlfile = name + '.sql'
tmp = os.path.split(sqlfile)
sqlfile = os.path.join(tmp[0], 'uninstall_' + tmp[1])
fn = self.find_sql_file(name, sqlfile)
self.confirm(_("""\
In order to unload the extension '%s' looks like you will have
to load the file '%s'.
Do you want to execute it?""")
% (name, fn))
data = self.patch_for_schema(fn)
self.load_sql(data=data)
def drop_extension(self, name):
# TODO: cascade
cmd = "DROP EXTENSION %s;" % Identifier(name)
self.load_sql(data=cmd)