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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
|
#!/usr/bin/python
# Authors:
# Endi S. Dewata <edewata@redhat.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2013 Red Hat, Inc.
# All rights reserved.
#
import functools
import os
import re
import shutil
import traceback
import pki
import pki.util
DEFAULT_VERSION = '10.0.0'
UPGRADE_DIR = pki.SHARE_DIR + '/upgrade'
BACKUP_DIR = pki.LOG_DIR + '/upgrade'
SYSTEM_TRACKER = pki.CONF_DIR + '/pki.version'
verbose = False
@functools.total_ordering
class Version(object):
def __init__(self, obj):
if isinstance(obj, str):
# parse <version>-<release>
pos = obj.find('-')
if pos > 0:
self.version = obj[0:pos]
elif pos < 0:
self.version = obj
else:
raise Exception('Invalid version number: ' + obj)
# parse <major>.<minor>.<patch>
match = re.match(r'^(\d+)\.(\d+)\.(\d+)$', self.version)
if match is None:
raise Exception('Invalid version number: ' + self.version)
self.major = int(match.group(1))
self.minor = int(match.group(2))
self.patch = int(match.group(3))
elif isinstance(obj, Version):
self.major = obj.major
self.minor = obj.minor
self.patch = obj.patch
else:
raise Exception('Unsupported version type: ' + str(type(obj)))
# release is ignored in comparisons
def __eq__(self, other):
return (self.major == other.major and
self.minor == other.minor and
self.patch == other.patch)
def __lt__(self, other):
if self.major < other.major:
return True
if self.major == other.major and self.minor < other.minor:
return True
if (self.major == other.major and
self.minor == other.minor and
self.patch < other.patch):
return True
return False
def __repr__(self):
return self.version
class PKIUpgradeTracker(object):
def __init__(self, name, filename, delimiter='=',
version_key='PKI_VERSION',
index_key='PKI_UPGRADE_INDEX'):
self.name = name
self.filename = filename
self.version_key = version_key
self.index_key = index_key
# properties must be read and written immediately to avoid
# interfering with scriptlets that update the same file
self.properties = pki.PropertyFile(filename, delimiter)
def remove(self):
if verbose:
print 'Removing ' + self.name + ' tracker.'
self.remove_version()
self.remove_index()
def set(self, version):
if verbose:
print 'Setting ' + self.name + ' tracker to version ' +\
str(version) + '.'
self.set_version(version)
self.remove_index()
def show(self):
print self.name + ':'
version = self.get_version()
print ' Configuration version: ' + str(version)
index = self.get_index()
if index > 0:
print ' Last completed scriptlet: ' + str(index)
print
def get_index(self):
self.properties.read()
index = self.properties.get(self.index_key)
if index:
return int(index)
return 0
def set_index(self, index):
self.properties.read()
# find index
i = self.properties.index(self.index_key)
if i >= 0:
# if already exists, update index
self.properties.set(self.index_key, str(index))
else:
# find version
i = self.properties.index(self.version_key)
if i >= 0:
# if version exists, add index after version
self.properties.set(self.index_key, str(index), index=i + 1)
else:
# otherwise, add index at the end separated by a blank line
# if last line is not empty, append empty line
length = len(self.properties.lines)
if length > 0 and self.properties.lines[length - 1] != '':
self.properties.insert_line(length, '')
length += 1
# add index
self.properties.set(self.index_key, str(index), index=length)
self.properties.write()
def remove_index(self):
self.properties.read()
self.properties.remove(self.index_key)
self.properties.write()
def get_version(self):
self.properties.read()
version = self.properties.get(self.version_key)
if version:
return Version(version)
return Version(DEFAULT_VERSION)
def set_version(self, version):
self.properties.read()
# find version
i = self.properties.index(self.version_key)
if i >= 0:
# if already exists, update version
self.properties.set(self.version_key, str(version))
else:
# otherwise, add version at the end separated by a blank line
# if last line is not empty, append empty line
length = len(self.properties.lines)
if length > 0 and self.properties.lines[length - 1] != '':
self.properties.insert_line(length, '')
length += 1
# add version
self.properties.set(self.version_key, str(version), index=length)
self.properties.write()
def remove_version(self):
self.properties.read()
self.properties.remove(self.version_key)
self.properties.write()
@functools.total_ordering
class PKIUpgradeScriptlet(object):
def __init__(self):
self.version = None
self.index = None
self.last = False
self.message = None
self.upgrader = None
def get_backup_dir(self):
return BACKUP_DIR + '/' + str(self.version) + '/' + str(self.index)
def can_upgrade(self):
# A scriptlet can run if the version matches the tracker and
# the index is the next to be executed.
tracker = self.upgrader.get_tracker()
return self.version == tracker.get_version() and \
self.index == tracker.get_index() + 1
def update_tracker(self):
# Increment the index in the tracker. If it's the last scriptlet
# in this version, update the tracker version.
tracker = self.upgrader.get_tracker()
self.backup(tracker.filename)
if not self.last:
tracker.set_index(self.index)
else:
tracker.remove_index()
tracker.set_version(self.version.next)
def upgrade_system(self):
# Callback method to upgrade the system.
pass
def init(self):
backup_dir = self.get_backup_dir()
if os.path.exists(backup_dir):
# remove old backup dir
shutil.rmtree(backup_dir)
# create backup dir
os.makedirs(backup_dir)
def upgrade(self):
try:
if not self.can_upgrade():
if verbose:
print 'Skipping system.'
return
if verbose:
print 'Upgrading system.'
self.upgrade_system()
self.update_tracker()
except Exception as e:
if verbose:
traceback.print_exc()
else:
print 'ERROR: ' + e.message
message = 'Failed upgrading system.'
if self.upgrader.silent:
print message
else:
result = pki.read_text(
message + ' Continue (Yes/No)',
options=['Y', 'N'], default='Y', delimiter='?',
case_sensitive=False).lower()
if result == 'y':
return
raise pki.PKIException('Upgrade failed: ' + e.message, e)
def revert(self):
backup_dir = self.get_backup_dir()
if not os.path.exists(backup_dir):
return
oldfiles = backup_dir + '/oldfiles'
if os.path.exists(oldfiles):
# restore all backed up files
for sourcepath, _, filenames in os.walk(oldfiles):
#unused item _ for dirnames
destpath = sourcepath[len(oldfiles):]
if destpath == '':
destpath = '/'
if not os.path.isdir(destpath):
if verbose:
print 'Restoring ' + destpath
pki.util.copydirs(sourcepath, destpath)
for filename in filenames:
sourcefile = os.path.join(sourcepath, filename)
targetfile = os.path.join(destpath, filename)
if verbose:
print 'Restoring ' + targetfile
pki.util.copyfile(sourcefile, targetfile)
newfiles = backup_dir + '/newfiles'
if os.path.exists(newfiles):
# get paths that did not exist before upgrade
paths = []
with open(newfiles, 'r') as f:
for path in f:
path = path.strip('\n')
paths.append(path)
# remove paths in reverse order
paths.reverse()
for path in paths:
if not os.path.exists(path):
continue
if verbose:
print 'Deleting ' + path
if os.path.isfile(path):
os.remove(path)
else:
shutil.rmtree(path)
def backup(self, path):
backup_dir = self.get_backup_dir()
if not os.path.exists(backup_dir):
os.makedirs(backup_dir)
if os.path.exists(path):
# if path exists, keep a copy
oldfiles = backup_dir + '/oldfiles'
if not os.path.exists(oldfiles):
os.mkdir(oldfiles)
dest = oldfiles + path
sourceparent = os.path.dirname(path)
destparent = os.path.dirname(dest)
pki.util.copydirs(sourceparent, destparent)
if os.path.isfile(path):
if verbose:
print 'Saving ' + path
# do not overwrite initial backup
pki.util.copyfile(path, dest, overwrite=False)
else:
for sourcepath, _, filenames in os.walk(path):
relpath = sourcepath[len(path):]
destpath = dest + relpath
if verbose:
print 'Saving ' + sourcepath
pki.util.copydirs(sourcepath, destpath)
for filename in filenames:
sourcefile = os.path.join(sourcepath, filename)
targetfile = os.path.join(destpath, filename)
if verbose:
print 'Saving ' + sourcefile
# do not overwrite initial backup
pki.util.copyfile(sourcefile, targetfile,
overwrite=False)
else:
# otherwise, record the name
if verbose:
print 'Recording ' + path
with open(backup_dir + '/newfiles', 'a') as f:
f.write(path + '\n')
def __eq__(self, other):
return self.version == other.version and self.index == other.index
def __lt__(self, other):
if self.version < other.version:
return True
return self.version == other.version and self.index < other.index
class PKIUpgrader(object):
def __init__(self, upgrade_dir=UPGRADE_DIR, version=None, index=None,
silent=False):
self.upgrade_dir = upgrade_dir
self.version = version
self.index = index
self.silent = silent
if version and not os.path.exists(self.version_dir(version)):
raise pki.PKIException(
'Invalid scriptlet version: ' + str(version))
self.system_tracker = None
def version_dir(self, version):
return os.path.join(self.upgrade_dir, str(version))
def all_versions(self):
all_versions = []
if os.path.exists(self.upgrade_dir):
for version in os.listdir(self.upgrade_dir):
version = Version(version)
all_versions.append(version)
all_versions.sort()
return all_versions
def versions(self):
current_version = self.get_current_version()
target_version = self.get_target_version()
current_versions = []
for version in self.all_versions():
# skip old versions
if version >= current_version:
current_versions.append(version)
current_versions.sort()
versions = []
for index, version in enumerate(current_versions):
# link versions
if index < len(current_versions) - 1:
version.next = current_versions[index + 1]
else:
version.next = target_version
# if no scriptlet version is specified, add all versions to the list
# if scriptlet version is specified, add only that version to the
# list
if not self.version or str(version) == self.version:
versions.append(version)
return versions
def scriptlets(self, version):
scriptlets = []
version_dir = self.version_dir(version)
if not os.path.exists(version_dir):
return scriptlets
filenames = os.listdir(version_dir)
for filename in filenames:
# parse <index>-<classname>
try:
i = filename.index('-')
except ValueError as e:
raise pki.PKIException('Invalid scriptlet name: ' + filename, e)
index = int(filename[0:i])
classname = filename[i + 1:]
if self.index and index != self.index:
continue
# load scriptlet class
variables = {}
execfile(os.path.join(version_dir, filename), variables)
# create scriptlet object
scriptlet = variables[classname]()
scriptlet.upgrader = self
scriptlet.version = version
scriptlet.index = index
scriptlet.last = index == len(filenames)
scriptlets.append(scriptlet)
# sort scriptlets based on index
scriptlets.sort()
return scriptlets
def get_tracker(self):
if self.system_tracker:
tracker = self.system_tracker
else:
tracker = PKIUpgradeTracker(
'system',
SYSTEM_TRACKER,
delimiter=': ',
version_key='Configuration-Version',
index_key='Scriptlet-Index')
self.system_tracker = tracker
return tracker
def get_current_version(self):
tracker = self.get_tracker()
return tracker.get_version()
def get_target_version(self):
return Version(pki.implementation_version())
def is_complete(self):
current_version = self.get_current_version()
target_version = self.get_target_version()
return current_version == target_version
def upgrade_version(self, version):
print 'Upgrading from version ' + str(version) + ' to ' +\
str(version.next) + ':'
scriptlets = self.scriptlets(version)
if len(scriptlets) == 0:
print 'No upgrade scriptlets.'
self.set_tracker(version.next)
return
# execute scriptlets
for scriptlet in scriptlets:
message = str(scriptlet.index) + '. ' + scriptlet.message
if self.silent:
print message
else:
result = pki.read_text(
message + ' (Yes/No)',
options=['Y', 'N'],
default='Y',
case_sensitive=False).lower()
if result == 'n':
raise pki.PKIException('Upgrade canceled.')
try:
scriptlet.init()
scriptlet.upgrade()
except pki.PKIException:
raise
except Exception as e: # pylint: disable=W0703
print
message = 'Upgrade failed: ' + e.message
if verbose:
traceback.print_exc()
else:
print e.message
print
result = pki.read_text(
'Continue (Yes/No)',
options=['Y', 'N'],
default='Y',
delimiter='?',
case_sensitive=False).lower()
if result == 'n':
raise pki.PKIException(message, e)
def upgrade(self):
versions = self.versions()
for version in versions:
self.upgrade_version(version)
print
if self.is_complete():
print 'Upgrade complete.'
else:
self.show_tracker()
print 'Upgrade incomplete.'
def revert_version(self, version):
print 'Reverting to version ' + str(version) + ':'
scriptlets = self.scriptlets(version)
scriptlets.reverse()
for scriptlet in scriptlets:
message = str(scriptlet.index) + '. ' + scriptlet.message
if self.silent:
print message
else:
result = pki.read_text(
message + ' (Yes/No)',
options=['Y', 'N'], default='Y',
case_sensitive=False).lower()
if result == 'n':
raise pki.PKIException('Revert canceled.')
try:
scriptlet.revert()
except pki.PKIException:
raise
except Exception as e: # pylint: disable=W0703
print
message = 'Revert failed: ' + e.message
if verbose:
traceback.print_exc()
else:
print e.message
print
result = pki.read_text(
'Continue (Yes/No)', options=['Y', 'N'],
default='Y', delimiter='?', case_sensitive=False).lower()
if result == 'n':
raise pki.PKIException(message, e)
self.set_tracker(version)
def revert(self):
current_version = self.get_current_version()
versions = self.all_versions()
versions.reverse()
# find the first version smaller than the current version
for version in versions:
if version >= current_version:
continue
self.revert_version(version)
return
print 'Unable to revert from version ' + str(current_version) + '.'
def show_tracker(self):
tracker = self.get_tracker()
tracker.show()
def status(self):
self.show_tracker()
if self.is_complete():
print 'Upgrade complete.'
else:
print 'Upgrade incomplete.'
def set_tracker(self, version):
tracker = self.get_tracker()
tracker.set(version)
print 'Tracker has been set to version ' + str(version) + '.'
def reset_tracker(self):
target_version = self.get_target_version()
self.set_tracker(target_version)
def remove_tracker(self):
tracker = self.get_tracker()
tracker.remove()
print 'Tracker has been removed.'
|