-
Notifications
You must be signed in to change notification settings - Fork 0
/
_extutil.py
449 lines (421 loc) · 18 KB
/
_extutil.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
# -*- coding: utf-8 -*-
################################################################################
# _extutil.py
#
# 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; either version 2
# of the License, or (at your option) any later version.
#
# 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
################################################################################
from pkg_resources import WorkingSet, Requirement, ResourceManager
EXTENSIONS = {
'zms3.behave': ['0.1.0',
'Manage tests based on feature/scenario/step descriptions using Behavior-driven development (BDD) practices',
'https://github.com/zms-publishing/zms3.behave',
'developed by Christian Meier'],
'zms3.formulator': ['3.4.11',
'Submit JSON-based HTML-Forms into a SQL-Storage with protection by reCAPTCHA',
'https://github.com/zms-publishing/zms3.formulator',
'developed by SNTL Publishing'],
'zms3.mindmap': ['0.1.5',
'Manage and browse mind maps',
'https://github.com/zms-publishing/zms3.mindmap',
'developed by Christian Meier'],
'zms3.deployment': ['0.2.5',
'Handle continuous delivery by automation of deployment and installation tasks',
'https://pypi.python.org/pypi/zms3.deployment',
'developed by SNTL Publishing'],
'zms3.themes': ['0.2.1',
'Additional Themes based on Start Bootstrap',
'https://bitbucket.org/zms3/themes',
'developed by SNTL Publishing'],
'zms3.photodb': ['0.2.1',
'Handle EXIF/XMP/IPTC metadata',
'https://github.com/zms-publishing/zms3.photodb',
'developed by Christian Meier'],
'zms3.qrcode': ['0.1.1',
'Generate Quick Response Codes (QR codes)',
'https://github.com/zms-publishing/zms3.qrcode',
'developed by Christian Meier'],
'Pillow': ['3.3.1',
'The friendly PIL (Python Imaging Library) fork',
'https://pypi.python.org/pypi/Pillow',
'developed by Alex Clark'],
'python-ldap': ['2.4.27',
'Object-oriented API to access LDAP servers',
'https://pypi.python.org/pypi/python-ldap',
'developed by python-ldap.org'],
'MySQL-python': ['1.2.5',
'Python Interface to MySQL',
'https://pypi.python.org/pypi/MySQL-python',
'developed by Andy Dustman'],
'SQLAlchemy': ['1.0.15',
'Python SQL Toolkit and Object Relational Mapper',
'https://pypi.python.org/pypi/SQLAlchemy',
'developed by Mike Bayer'],
'Products.ZCatalog': ['3.1',
'Built in search engine of Zope',
'https://pypi.python.org/pypi/Products.ZCatalog',
'developed by Zope Foundation and Contributors'],
'Products.ZMySQLDA': ['3.1.1',
'MySQL Database Adapter',
'https://pypi.python.org/pypi/Products.ZMySQLDA',
'developed by John Eikenberry'],
'Products.ZSQLiteDA': ['0.6.1',
'SQLite Database Adapter',
'https://pypi.python.org/pypi/Products.ZSQLiteDA',
'developed by Hajime Nakagami'],
'Products.ZSQLMethods': ['2.13.4',
'SQL Method Support',
'https://pypi.python.org/pypi/Products.ZSQLMethods',
'developed by Zope Foundation and Contributors'],
'Products.CMFCore': ['2.2.10',
'File System Directory Views',
'https://pypi.python.org/pypi/Products.CMFCore',
'developed by Zope Foundation and Contributors'],
'Products.PluggableAuthService': ['1.11.0',
'Pluggable authentication / authorization framework',
'https://pypi.python.org/pypi/Products.PluggableAuthService',
'developed by Zope Foundation and Contributors'],
'lesscpy': ['0.11.1',
'Python LESS Compiler',
'https://pypi.python.org/pypi/lesscpy',
'developed by Jóhann T Maríusson'],
'behave': ['1.2.5',
'Library to write tests in a Domain Specific Language (DSL) automated by Python code',
'https://pypi.python.org/pypi/behave',
'developed by Benno Rice, Richard Jones and Jens Engel'],
'mock': ['2.0.0',
'Library for testing in Python to replace parts of the system under test with mock objects and make assertions',
'https://pypi.python.org/pypi/mock',
'developed by Testing Cabal'],
'beautifulsoup4': ['4.5.1',
'Library to provide Pythonic idioms for iterating, searching, and modifying an HTML/XML parse tree',
'https://pypi.python.org/pypi/beautifulsoup4',
'developed by Leonard Richardson'],
'ftfy': ['4.1.1',
'Library for fixing Unicode that is broken in various ways',
'https://pypi.python.org/pypi/ftfy',
'developed by Rob Speer'],
'PyQRCode': ['1.2.1',
'A QR code generator written purely in Python with SVG, EPS, PNG and terminal output',
'https://pypi.python.org/pypi/PyQRCode',
'developed by Michael Nooner'],
'Zope2': ['2.13.24',
'Open-source web application server',
'https://github.com/zopefoundation/Zope',
'developed by Zope Foundation and Contributors'],
'ZODB': ['4.2.0',
'Set of tools for using the Zope Object Database',
'https://github.com/zopefoundation/ZODB',
'developed by Zope Foundation and Contributors'],
'ZopeUndo': ['2.12.0',
'Support the undo log (Prefix object) in a ZEO server, without pulling in all of Zope',
'https://github.com/zopefoundation/ZopeUndo',
'developed by Zope Foundation and Contributors'],
'zope.publisher': ['3.13.4',
'Map requests from HTTP/WebDAV/FTP clients, web browsers and XML-RPC onto Python objects',
'https://github.com/zopefoundation/zope.publisher',
'developed by Zope Foundation and Contributors'],
'zope.pagetemplate': ['4.2.1',
'Templating mechanism that achieves a clean separation of presentation and application logic',
'https://github.com/zopefoundation/zope.pagetemplate',
'developed by Zope Foundation and Contributors'],
'zope.sendmail': ['3.7.5',
'Send mails using transaction mechanism and queuing',
'https://github.com/zopefoundation/zope.sendmail',
'developed by Zope Foundation and Contributors']
}
class ZMSExtensions():
"""
Utility to handle zms3.extensions
Management interface is at ZMS > Configuration > System > Installed Libraries
@see zpt/ZMS/manage_customize.zpt
@see _confmanager.py
"""
getAll__roles__ = None
getAllExtensions__roles__ = None
getAllThemes__roles__ = None
getAllProducts__roles__ = None
getAllOthers__roles__ = None
getAllProjspecs__roles__ = None
getAllFramework__roles__ = None
isEnabled__roles__ = None
isThemeInstalled__roles__ = None
installTheme__roles__ = None
getHint__roles__ = None
getInfo__roles__ = None
getVersionAvailable__roles__ = None
getVersionInstalled__roles__ = None
getFiles__roles__ = None
getFilesToImport__roles__ = None
getExample__roles__ = None
getExampleToImport__roles__ = None
importExample__roles__ = None
getUrl__roles__ = None
getUrlPackage__roles__ = None
def __init__(self):
self.pkg = {}
self.pkg_names = []
self.pkg_available = []
self.pkg_hints = []
self.pkg_infos = []
self.pkg_ready = []
self.pkg_confs = []
self.pkg_installed = []
self.pkg_urls = []
for name, info in sorted(EXTENSIONS.iteritems()):
self.pkg_names.append(name)
self.pkg_available.append(info[0])
self.pkg_hints.append(info[1])
self.pkg_infos.append(info[3])
self.pkg_urls.append(info[2])
package = str(WorkingSet().find(Requirement.parse(name))).split()
if ((name in package) and (len(package) == 2)):
# TODO: **Normalize Versions** acc. to `PEP 440`: http://legacy.python.org/dev/peps/pep-0440/
# The version specified requires normalization, consider using '3.2.0.dev3' instead of '3.2.0dev3' etc. +
# pip v6.0.6 does not append svn revision specified in `setup.cfg` as v1.5.6 before
# => `zms.zms_version()` have to be adjusted too...
self.pkg_installed.append(package[1].replace('.dev', 'dev').replace('dev0', 'dev'))
self.pkg_ready.append(True)
try:
confres = ResourceManager().resource_listdir(name, 'conf')
except:
confres = None
if confres:
confxml = filter(lambda ob: ob.endswith('.xml') or ob.endswith('.zip'), confres)
if len(confxml) > 0:
self.pkg_confs.append(confxml)
else:
self.pkg_confs.append(None)
else:
self.pkg_confs.append(None)
else:
self.pkg_installed.append(None)
self.pkg_confs.append(None)
self.pkg_ready.append(False)
def getAll(self):
"""
Return all defined extensions
"""
return self.pkg_names
def getAllExtensions(self, prj=None):
"""
Return all zms3.* extensions
"""
pkg = filter(lambda x: x.startswith('zms3.'), self.pkg_names)
if prj is not None:
pkg = filter(lambda x: x not in self.getAllProjspecs(prj), pkg)
return pkg
def getAllThemes(self, prj=None):
"""
Return all themes identified by an entry in configure.zcml representing a subfolder of /skins
"""
pkg = []
try:
import Products.CMFCore.DirectoryView
for directory in Products.CMFCore.DirectoryView.manage_listAvailableDirectories():
if 'Products.zms:skins' in directory or 'zms3.themes:skins' in directory:
d = directory.split('/', 1)[1]
if '/' not in d:
pkg.append(d)
except:
pass
if prj is not None:
pkg = filter(lambda x: x not in self.getAllProjspecs(prj), pkg)
return pkg
def isThemeInstalled(self, context, ext=None):
"""
Return TRUE if given theme is available as Filesystem Directory View in root folder of ZMS
otherwise FALSE
"""
if ext in map(lambda x: x.getId(), context.getHome().objectValues('Filesystem Directory View')):
return True
else:
return False
def installTheme(self, context, ext=None):
"""
Create Filesystem Directory View of given theme in root folder of ZMS
"""
try:
import Products.CMFCore.DirectoryView
for directory in Products.CMFCore.DirectoryView.manage_listAvailableDirectories():
if 'Products.zms:skins' in directory or 'zms3.themes:skins' in directory:
d = directory.split('/', 1)[1]
if '/' not in d:
if ext in directory:
Products.CMFCore.DirectoryView.manage_addDirectoryView(context.getHome(), directory)
break
return True
except:
return False
def getAllProducts(self):
"""
Return all Products.* extensions
"""
pkg = filter(lambda x: x.startswith('Products.'), self.pkg_names)
return pkg
def getAllOthers(self):
"""
Return all other extensions
"""
pkg = filter(lambda x: not x.startswith('zms3.') and not x.startswith('Products.') and x not in self.getAllFramework(), self.pkg_names)
return pkg
def getAllProjspecs(self, prj=None):
"""
Return all project specific extensions (define parameter ZMS.Project at ZMS > System > Miscelleanous)
"""
if prj is not None:
pkg = filter(lambda x: x.startswith('zms3.%s' % prj.lower()), self.pkg_names)
return pkg
return []
def getAllFramework(self):
"""
Return all framework specific packages
"""
pkg = filter(lambda x: x.startswith('Zope') or x.startswith('ZODB') or x.find('zope') >= 0, self.pkg_names)
return pkg
def isEnabled(self, ext=None):
"""
Return TRUE if given extension is available as python package in environment
otherwise FALSE
"""
if ext in self.pkg_names:
return self.pkg_ready[self.pkg_names.index(ext)]
else:
return False
def getHint(self, ext=None):
"""
Return short description of given extension
"""
if ext in self.pkg_names:
return self.pkg_hints[self.pkg_names.index(ext)]
else:
return None
def getInfo(self, ext=None):
"""
Return info about given extension to display as hover-link-title
"""
if ext in self.pkg_names:
return self.pkg_infos[self.pkg_names.index(ext)]
else:
return None
def getVersionAvailable(self, ext=None):
"""
Return python package version of given extension configured above
"""
if ext in self.pkg_names:
return self.pkg_available[self.pkg_names.index(ext)]
else:
return None
def getVersionInstalled(self, ext=None):
"""
Return python package version of given extension installed in environment
"""
if ext in self.pkg_names:
return self.pkg_installed[self.pkg_names.index(ext)]
else:
return None
def getFiles(self, ext=None):
"""
Return configuration files found at $LIBS/zms3/{ext}/conf/*.xml
"""
if ext in self.pkg_names:
files = self.pkg_confs[self.pkg_names.index(ext)]
files = filter(lambda filename: not filename.endswith('.example.xml') and not filename.endswith('.example.zip'), files)
return files
else:
return None
def getFilesToImport(self, ext=None, context=None):
"""
Return list of configuration files of given extension with full pathnames
"""
if ext in self.pkg_names:
files = self.pkg_confs[self.pkg_names.index(ext)]
if files:
filenames = []
for f in files:
filename = ResourceManager().resource_filename(ext, 'conf/' + f)
filenames.append(filename)
# if ZMSActions are included but no Provider available - create it
if context is not None:
if ('.metacmd.' in f) \
and ('ZMSMetacmdProvider' not in map(lambda x: x.meta_type, context.objectValues())) \
and ('ZMSMetacmdProviderAcquired' not in map(lambda x: x.meta_type, context.objectValues())):
context.REQUEST.set('meta_type', 'ZMSMetacmdProvider')
context.manage_customizeSystem('Add', 'Manager', context.REQUEST['lang'], context.REQUEST)
return filenames
return []
def getExample(self, ext=None):
"""
Return an available *.example.xml or *.example.zip file of given extension
"""
if ext in self.pkg_names:
files = self.pkg_confs[self.pkg_names.index(ext)]
if files:
for filename in files:
if filename.endswith('.example.xml') or filename.endswith('.example.zip'):
return filename
return None
def getExampleToImport(self, ext=None):
"""
Return an available example file of given extension with full pathname
"""
example = self.getExample(ext)
if example is not None:
files = self.getFilesToImport(ext)
for filename in files:
if filename.endswith(example):
return filename
return None
def importExample(self, ext=None, context=None, request=None):
"""
Import example file of given extension at given context
"""
import _fileutil
import _importable
example = self.getExample(ext)
if example is not None:
filename = self.getExampleToImport(ext)
contents = open(_fileutil.getOSPath(filename), 'rb')
_importable.importFile(context, contents, request, _importable.importContent)
contents.close()
def getUrl(self, ext=None):
"""
Return url to package website of given extension if available
"""
if ext in self.pkg_names:
str_url = self.pkg_urls[self.pkg_names.index(ext)]
if str_url.startswith('https://bitbucket.org'):
str_url += '/downloads'
return str_url
else:
return None
def getUrlPackage(self, ext=None, mode='install'):
"""
Return url to package download of given extension for install/update
"""
if ext in self.pkg_names:
str_ins = str_upd = str_url = self.getUrl(ext)
if str_url.startswith('https://bitbucket.org') and str_url.endswith('/downloads'):
str_ins = '%s/get/%s.zip'%(str_url[:-10], self.getVersionAvailable(ext))
str_upd = '%s/get/HEAD.zip'%(str_url[:-10])
if ext=='zms3.deployment':
str_ins = str_upd = 'zms3.deployment==0.2.5'
if mode=='install':
return str_ins
elif mode=='update':
return str_upd
else:
return 'n/a'
else:
return None