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
|
#
# Copyright (C) 2016 FreeIPA Contributors see COPYING for license
#
import collections
import errno
import fcntl
import json
import os
import sys
import time
import types
import zipfile
import six
from ipaclient.frontend import ClientCommand, ClientMethod
from ipalib import errors, parameters, plugable
from ipalib.frontend import Object
from ipalib.output import Output
from ipalib.parameters import DefaultFrom, Flag, Password, Str
from ipaplatform.paths import paths
from ipapython.ipautil import fsdecode
from ipapython.dn import DN
from ipapython.dnsutil import DNSName
from ipapython.ipa_log_manager import log_mgr
FORMAT = '1'
if six.PY3:
unicode = str
_TYPES = {
'DN': DN,
'DNSName': DNSName,
'Principal': unicode,
'NoneType': type(None),
'Sequence': collections.Sequence,
'bool': bool,
'dict': dict,
'int': int,
'list': list,
'tuple': tuple,
'unicode': unicode,
}
_PARAMS = {
'Decimal': parameters.Decimal,
'DN': parameters.DNParam,
'DNSName': parameters.DNSNameParam,
'Principal': parameters.Principal,
'bool': parameters.Bool,
'bytes': parameters.Bytes,
'datetime': parameters.DateTime,
'dict': parameters.Dict,
'int': parameters.Int,
'str': parameters.Str,
}
logger = log_mgr.get_logger(__name__)
class _SchemaCommand(ClientCommand):
pass
class _SchemaMethod(ClientMethod):
@property
def obj_name(self):
return self.api.Object[self.obj_full_name].name
@property
def obj_version(self):
return self.api.Object[self.obj_full_name].version
class _SchemaObject(Object):
pass
class _SchemaPlugin(object):
bases = None
schema_key = None
def __init__(self, schema, full_name):
self.name, _slash, self.version = full_name.partition('/')
self.full_name = full_name
self._schema = schema
self._class = None
@property
def doc(self):
if self._class is not None:
return self._class.doc
else:
schema = self._schema[self.schema_key][self.full_name]
try:
return schema['doc']
except KeyError:
return None
@property
def summary(self):
if self._class is not None:
return self._class.summary
else:
self._schema.load_help()
schema = self._schema[self.schema_key][self.full_name]
try:
return schema['summary']
except KeyError:
return u'<%s>' % self.full_name
def _create_default_from(self, api, name, keys):
cmd_name = self.full_name
def get_default(*args):
kw = dict(zip(keys, args))
result = api.Command.command_defaults(
unicode(cmd_name),
params=[unicode(name)],
kw=kw,
)['result']
return result.get(name)
if keys:
def callback(*args):
return get_default(*args)
else:
def callback():
return get_default()
callback.__name__ = '{0}_{1}_default'.format(self.name, name)
return DefaultFrom(callback, *keys)
def _create_param(self, api, schema):
name = str(schema['name'])
type_name = str(schema['type'])
sensitive = schema.get('sensitive', False)
if type_name == 'str' and sensitive:
cls = Password
sensitive = False
elif (type_name == 'bool' and
'default' in schema and schema['default'][0] == u'False' and
not schema.get('alwaysask', False)):
cls = Flag
del schema['default']
else:
try:
cls = _PARAMS[type_name]
except KeyError:
cls = Str
kwargs = {}
default = None
for key, value in schema.items():
if key in ('alwaysask',
'doc',
'label',
'multivalue',
'no_convert',
'option_group',
'required'):
kwargs[key] = value
elif key in ('cli_metavar',
'cli_name'):
kwargs[key] = str(value)
elif key == 'confirm':
kwargs[key] = value
elif key == 'default':
default = value
elif key == 'default_from_param':
keys = tuple(str(k) for k in value)
kwargs['default_from'] = (
self._create_default_from(api, name, keys))
elif key in ('exclude',
'include'):
kwargs[key] = tuple(str(v) for v in value)
if default is not None:
tmp = cls(name, **dict(kwargs, no_convert=False))
if tmp.multivalue:
default = tuple(tmp._convert_scalar(d) for d in default)
else:
default = tmp._convert_scalar(default[0])
kwargs['default'] = default
if 'default' in kwargs or 'default_from' in kwargs:
kwargs['autofill'] = not kwargs.pop('alwaysask', False)
param = cls(name, **kwargs)
if sensitive:
object.__setattr__(param, 'password', True)
return param
def _create_class(self, api, schema):
class_dict = {}
class_dict['name'] = str(schema['name'])
class_dict['version'] = str(schema['version'])
class_dict['full_name'] = str(schema['full_name'])
if 'doc' in schema:
class_dict['doc'] = schema['doc']
if 'topic_topic' in schema:
class_dict['topic'] = str(schema['topic_topic']).partition('/')[0]
else:
class_dict['topic'] = None
class_dict['takes_params'] = tuple(self._create_param(api, s)
for s in schema.get('params', []))
return self.name, self.bases, class_dict
def __call__(self, api):
if self._class is None:
schema = api._schema[self.schema_key][self.full_name]
name, bases, class_dict = self._create_class(api, schema)
self._class = type(name, bases, class_dict)
return self._class(api)
class _SchemaCommandPlugin(_SchemaPlugin):
bases = (_SchemaCommand,)
schema_key = 'commands'
@property
def topic(self):
if self._class is not None:
return self._class.topic
else:
self._schema.load_help()
schema = self._schema[self.schema_key][self.full_name]
try:
return str(schema['topic_topic']).partition('/')[0]
except KeyError:
return None
@property
def NO_CLI(self):
if self._class is not None:
return self._class.NO_CLI
else:
self._schema.load_help()
schema = self._schema[self.schema_key][self.full_name]
return 'cli' in schema.get('exclude', [])
def _create_output(self, api, schema):
if schema.get('multivalue', False):
type_type = (tuple, list)
if not schema.get('required', True):
type_type = type_type + (type(None),)
else:
try:
type_type = _TYPES[schema['type']]
except KeyError:
type_type = None
else:
if not schema.get('required', True):
type_type = (type_type, type(None))
kwargs = {}
kwargs['type'] = type_type
if 'doc' in schema:
kwargs['doc'] = schema['doc']
if schema.get('no_display', False):
kwargs['flags'] = ('no_display',)
return Output(str(schema['name']), **kwargs)
def _create_class(self, api, schema):
name, bases, class_dict = (
super(_SchemaCommandPlugin, self)._create_class(api, schema))
if 'obj_class' in schema or 'attr_name' in schema:
bases = (_SchemaMethod,)
if 'obj_class' in schema:
class_dict['obj_full_name'] = str(schema['obj_class'])
if 'attr_name' in schema:
class_dict['attr_name'] = str(schema['attr_name'])
if 'exclude' in schema and u'cli' in schema['exclude']:
class_dict['NO_CLI'] = True
args = set(str(s['name']) for s in schema['params']
if s.get('positional', s.get('required', True)))
class_dict['takes_args'] = tuple(
p for p in class_dict['takes_params'] if p.name in args)
class_dict['takes_options'] = tuple(
p for p in class_dict['takes_params'] if p.name not in args)
del class_dict['takes_params']
class_dict['has_output'] = tuple(
self._create_output(api, s) for s in schema['output'])
return name, bases, class_dict
class _SchemaObjectPlugin(_SchemaPlugin):
bases = (_SchemaObject,)
schema_key = 'classes'
class _LockedZipFile(zipfile.ZipFile):
""" Add locking to zipfile.ZipFile
Shared lock is used with read mode, exclusive with write mode.
"""
def __enter__(self):
if 'r' in self.mode:
fcntl.flock(self.fp, fcntl.LOCK_SH)
elif 'w' in self.mode or 'a' in self.mode:
fcntl.flock(self.fp, fcntl.LOCK_EX)
return super(_LockedZipFile, self).__enter__()
def __exit__(self, type_, value, traceback):
fcntl.flock(self.fp, fcntl.LOCK_UN)
return super(_LockedZipFile, self).__exit__(type_, value, traceback)
class _SchemaNameSpace(collections.Mapping):
def __init__(self, schema, name):
self.name = name
self._schema = schema
def __getitem__(self, key):
try:
return self._schema.read_namespace_member(self.name, key)
except KeyError:
raise KeyError(key)
def __iter__(self):
for key in self._schema.iter_namespace(self.name):
yield key
def __len__(self):
return len(list(self._schema.iter_namespace(self.name)))
class NotAvailable(Exception):
pass
class Schema(object):
"""
Store and provide schema for commands and topics
Create api instance
>>> from ipalib import api
>>> api.bootstrap(context='cli')
>>> api.finalize()
Get schema object
>>> m = Schema(api)
From now on we can access schema for commands stored in cache
>>> m['commands'][u'ping'][u'doc']
u'Ping a remote server.'
>>> m['topics'][u'ping'][u'doc']
u'Ping the remote IPA server to ...'
"""
namespaces = {'classes', 'commands', 'topics'}
_DIR = os.path.join(paths.USER_CACHE_PATH, 'ipa', 'schema', FORMAT)
def __init__(self, api, server_info, client):
self._dict = {}
self._namespaces = {}
self._help = None
for ns in self.namespaces:
self._dict[ns] = {}
self._namespaces[ns] = _SchemaNameSpace(self, ns)
is_known = False
if not api.env.force_schema_check:
try:
self._fingerprint = server_info['fingerprint']
self._expiration = server_info['expiration']
except KeyError:
pass
else:
is_known = True
if is_known:
try:
self._read_schema()
except Exception:
pass
else:
return
try:
self._fetch(client)
except NotAvailable:
raise
else:
self._write_schema()
finally:
try:
server_info['fingerprint'] = self._fingerprint
server_info['expiration'] = self._expiration
except AttributeError:
pass
def _open_schema(self, filename, mode):
path = os.path.join(self._DIR, filename)
return _LockedZipFile(path, mode)
def _fetch(self, client):
if not client.isconnected():
client.connect(verbose=False)
try:
fps = [fsdecode(f) for f in os.listdir(self._DIR)]
except EnvironmentError:
fps = []
kwargs = {u'version': u'2.170'}
if fps:
kwargs[u'known_fingerprints'] = fps
try:
schema = client.forward(u'schema', **kwargs)['result']
except errors.CommandError:
raise NotAvailable()
except errors.SchemaUpToDate as e:
fp = e.fingerprint
ttl = e.ttl
else:
fp = schema['fingerprint']
ttl = schema.pop('ttl', 0)
schema.pop('version', None)
for key, value in schema.items():
if key in self.namespaces:
value = {m['full_name']: m for m in value}
self._dict[key] = value
self._fingerprint = fp
self._expiration = ttl + time.time()
def _read_schema(self):
with self._open_schema(self._fingerprint, 'r') as schema:
for name in schema.namelist():
ns, _slash, key = name.partition('/')
if ns in self.namespaces:
self._dict[ns][key] = {}
def __getitem__(self, key):
try:
return self._namespaces[key]
except KeyError:
return self._dict[key]
def _generate_help(self, schema):
halp = {}
for namespace in ('commands', 'topics'):
halp[namespace] = {}
for member_schema in schema[namespace].values():
member_full_name = member_schema['full_name']
topic = halp[namespace].setdefault(member_full_name, {})
topic['name'] = member_schema['name']
if 'doc' in member_schema:
topic['summary'] = (
member_schema['doc'].split('\n\n', 1)[0].strip())
if 'topic_topic' in member_schema:
topic['topic_topic'] = member_schema['topic_topic']
if 'exclude' in member_schema:
topic['exclude'] = member_schema['exclude']
return halp
def _write_schema(self):
try:
os.makedirs(self._DIR)
except EnvironmentError as e:
if e.errno != errno.EEXIST:
logger.warning("Failed ti write schema: {}".format(e))
return
with self._open_schema(self._fingerprint, 'w') as schema:
for key, value in self._dict.items():
if key in self.namespaces:
ns = value
for member in ns:
path = '{}/{}'.format(key, member)
schema.writestr(path, json.dumps(ns[member]))
else:
schema.writestr(key, json.dumps(value))
schema.writestr('_help',
json.dumps(self._generate_help(self._dict)))
def _read(self, path):
with self._open_schema(self._fingerprint, 'r') as zf:
return json.loads(zf.read(path))
def read_namespace_member(self, namespace, member):
value = self._dict[namespace][member]
if (not value) or ('full_name' not in value):
path = '{}/{}'.format(namespace, member)
value = self._dict[namespace].setdefault(
member, {}
).update(self._read(path))
return value
def iter_namespace(self, namespace):
return iter(self._dict[namespace])
def load_help(self):
if not self._help:
self._help = self._read('_help')
for ns in self._help:
for member in self._help[ns]:
self._dict[ns][member].update(self._help[ns][member])
def get_package(api, server_info, client):
try:
schema = api._schema
except AttributeError:
schema = Schema(api, server_info, client)
object.__setattr__(api, '_schema', schema)
fingerprint = str(server_info['fingerprint'])
package_name = '{}${}'.format(__name__, fingerprint)
package_dir = '{}${}'.format(os.path.splitext(__file__)[0], fingerprint)
try:
return sys.modules[package_name]
except KeyError:
pass
package = types.ModuleType(package_name)
package.__file__ = os.path.join(package_dir, '__init__.py')
package.modules = ['plugins']
sys.modules[package_name] = package
module_name = '.'.join((package_name, 'plugins'))
module = types.ModuleType(module_name)
module.__file__ = os.path.join(package_dir, 'plugins.py')
module.register = plugable.Registry()
for plugin_cls in (_SchemaCommandPlugin, _SchemaObjectPlugin):
for full_name in schema[plugin_cls.schema_key]:
plugin = plugin_cls(schema, str(full_name))
plugin = module.register()(plugin)
sys.modules[module_name] = module
for full_name, topic in six.iteritems(schema['topics']):
name = str(topic['name'])
module_name = '.'.join((package_name, name))
try:
module = sys.modules[module_name]
except KeyError:
module = sys.modules[module_name] = types.ModuleType(module_name)
module.__file__ = os.path.join(package_dir, '{}.py'.format(name))
module.__doc__ = topic.get('doc')
if 'topic_topic' in topic:
module.topic = str(topic['topic_topic']).partition('/')[0]
else:
module.topic = None
return package
|