g.extension.py 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084
  1. #!/usr/bin/env python
  2. ############################################################################
  3. #
  4. # MODULE: g.extension
  5. # AUTHOR(S): Markus Neteler
  6. # Pythonized & upgraded for GRASS 7 by Martin Landa <landa.martin gmail.com>
  7. # PURPOSE: Tool to download and install extensions from GRASS Addons SVN into
  8. # local GRASS installation
  9. # COPYRIGHT: (C) 2009-2013 by Markus Neteler, and the GRASS Development Team
  10. #
  11. # This program is free software under the GNU General
  12. # Public License (>=v2). Read the file COPYING that
  13. # comes with GRASS for details.
  14. #
  15. # TODO: add sudo support where needed (i.e. check first permission to write into
  16. # $GISBASE directory)
  17. #############################################################################
  18. #%module
  19. #% label: Maintains GRASS Addons extensions in local GRASS installation.
  20. #% description: Downloads, installs extensions from GRASS Addons SVN repository into local GRASS installation or removes installed extensions.
  21. #% keywords: general
  22. #% keywords: installation
  23. #% keywords: extensions
  24. #%end
  25. #%option
  26. #% key: extension
  27. #% type: string
  28. #% key_desc: name
  29. #% label: Name of extension to install or remove
  30. #% description: Name of toolbox (set of extensions) when -t flag is given
  31. #% required: yes
  32. #%end
  33. #%option
  34. #% key: operation
  35. #% type: string
  36. #% description: Operation to be performed
  37. #% required: yes
  38. #% options: add,remove
  39. #% answer: add
  40. #%end
  41. #%option
  42. #% key: svnurl
  43. #% type: string
  44. #% key_desc: url
  45. #% description: SVN Addons repository URL
  46. #% answer: http://svn.osgeo.org/grass/grass-addons/grass7
  47. #%end
  48. #%option
  49. #% key: prefix
  50. #% type: string
  51. #% key_desc: path
  52. #% description: Prefix where to install extension (ignored when flag -s is given)
  53. #% answer: $GRASS_ADDON_BASE
  54. #% required: no
  55. #%end
  56. #%option
  57. #% key: proxy
  58. #% type: string
  59. #% key_desc: proxy
  60. #% description: Set the proxy with: "http=<value>,ftp=<value>"
  61. #% required: no
  62. #% multiple: yes
  63. #%end
  64. #%flag
  65. #% key: l
  66. #% description: List available extensions in the GRASS Addons SVN repository
  67. #% guisection: Print
  68. #% suppress_required: yes
  69. #%end
  70. #%flag
  71. #% key: c
  72. #% description: List available extensions in the GRASS Addons SVN repository including module description
  73. #% guisection: Print
  74. #% suppress_required: yes
  75. #%end
  76. #%flag
  77. #% key: g
  78. #% description: List available extensions in the GRASS Addons SVN repository (shell script style)
  79. #% guisection: Print
  80. #% suppress_required: yes
  81. #%end
  82. #%flag
  83. #% key: a
  84. #% description: List locally installed extensions
  85. #% guisection: Print
  86. #% suppress_required: yes
  87. #%end
  88. #%flag
  89. #% key: s
  90. #% description: Install system-wide (may need system administrator rights)
  91. #% guisection: Install
  92. #%end
  93. #%flag
  94. #% key: d
  95. #% description: Download source code and exit
  96. #% guisection: Install
  97. #%end
  98. #%flag
  99. #% key: i
  100. #% description: Don't install new extension, just compile it
  101. #% guisection: Install
  102. #%end
  103. #%flag
  104. #% key: f
  105. #% description: Force removal when uninstalling extension (operation=remove)
  106. #% guisection: Remove
  107. #%end
  108. #%flag
  109. #% key: t
  110. #% description: Operate on toolboxes instead of single modules (experimental)
  111. #% suppress_required: yes
  112. #%end
  113. import os
  114. import sys
  115. import re
  116. import atexit
  117. import shutil
  118. import zipfile
  119. import tempfile
  120. from urllib2 import HTTPError
  121. from urllib import urlopen
  122. try:
  123. import xml.etree.ElementTree as etree
  124. except ImportError:
  125. import elementtree.ElementTree as etree # Python <= 2.4
  126. from grass.script import core as grass
  127. # temp dir
  128. REMOVE_TMPDIR = True
  129. PROXIES = {}
  130. # check requirements
  131. def check_progs():
  132. for prog in ('svn', 'make', 'gcc'):
  133. if not grass.find_program(prog, '--help'):
  134. grass.fatal(_("'%s' required. Please install '%s' first.") % (prog, prog))
  135. # expand prefix to class name
  136. def expand_module_class_name(c):
  137. name = { 'd' : 'display',
  138. 'db' : 'database',
  139. 'g' : 'general',
  140. 'i' : 'imagery',
  141. 'm' : 'misc',
  142. 'ps' : 'postscript',
  143. 'p' : 'paint',
  144. 'r' : 'raster',
  145. 'r3' : 'raster3d',
  146. 's' : 'sites',
  147. 'v' : 'vector',
  148. 'wx' : 'gui/wxpython'
  149. }
  150. return name.get(c, c)
  151. # list installed extensions
  152. def get_installed_extensions(force = False):
  153. if flags['t']:
  154. return get_installed_toolboxes(force)
  155. return get_installed_modules(force)
  156. def get_installed_toolboxes(force = False):
  157. fXML = os.path.join(options['prefix'], 'toolboxes.xml')
  158. if not os.path.exists(fXML):
  159. write_xml_toolboxes(fXML)
  160. # read XML file
  161. fo = open(fXML, 'r')
  162. try:
  163. tree = etree.fromstring(fo.read())
  164. except:
  165. os.remove(fXML)
  166. write_xml_toolboxes(fXML)
  167. return []
  168. fo.close()
  169. ret = list()
  170. for tnode in tree.findall('toolbox'):
  171. ret.append(tnode.get('code'))
  172. return ret
  173. def get_installed_modules(force = False):
  174. fXML = os.path.join(options['prefix'], 'modules.xml')
  175. if not os.path.exists(fXML):
  176. if force:
  177. write_xml_modules(fXML)
  178. else:
  179. grass.warning(_("No metadata file available"))
  180. return []
  181. # read XML file
  182. fo = open(fXML, 'r')
  183. try:
  184. tree = etree.fromstring(fo.read())
  185. except:
  186. os.remove(fXML)
  187. write_xml_modules(fXML)
  188. return []
  189. fo.close()
  190. ret = list()
  191. for tnode in tree.findall('task'):
  192. ret.append(tnode.get('name').strip())
  193. return ret
  194. # list extensions (read XML file from grass.osgeo.org/addons)
  195. def list_available_extensions(url):
  196. if flags['t']:
  197. grass.message(_("List of available extensions (toolboxes):"))
  198. tlist = list_available_toolboxes(url)
  199. for toolbox_code, toolbox_data in tlist.iteritems():
  200. if flags['g']:
  201. print 'toolbox_name=' + toolbox_data['name']
  202. print 'toolbox_code=' + toolbox_code
  203. else:
  204. print '%s (%s)' % (toolbox_data['name'], toolbox_code)
  205. if flags['c'] or flags['g']:
  206. list_available_modules(url, toolbox_data['modules'])
  207. else:
  208. if toolbox_data['modules']:
  209. print os.linesep.join(map(lambda x: '* ' + x, toolbox_data['modules']))
  210. else:
  211. grass.message(_("List of available extensions (modules):"))
  212. list_available_modules(url)
  213. def list_available_toolboxes(url):
  214. tdict = dict()
  215. url = url + "toolboxes.xml"
  216. try:
  217. f = urlopen(url, proxies=PROXIES)
  218. tree = etree.fromstring(f.read())
  219. for tnode in tree.findall('toolbox'):
  220. mlist = list()
  221. clist = list()
  222. tdict[tnode.get('code')] = { 'name' : tnode.get('name'),
  223. 'correlate' : clist,
  224. 'modules' : mlist }
  225. for cnode in tnode.findall('correlate'):
  226. clist.append(cnode.get('name'))
  227. for mnode in tnode.findall('task'):
  228. mlist.append(mnode.get('name'))
  229. except HTTPError:
  230. grass.fatal(_("Unable to fetch metadata file"))
  231. return tdict
  232. def get_toolbox_modules(url, name):
  233. tlist = list()
  234. url = url + "toolboxes.xml"
  235. try:
  236. f = urlopen(url, proxies=PROXIES)
  237. tree = etree.fromstring(f.read())
  238. for tnode in tree.findall('toolbox'):
  239. if name == tnode.get('code'):
  240. for mnode in tnode.findall('task'):
  241. tlist.append(mnode.get('name'))
  242. break
  243. except HTTPError:
  244. grass.fatal(_("Unable to fetch metadata file"))
  245. return tlist
  246. def get_optional_params(mnode):
  247. try:
  248. desc = mnode.find('description').text
  249. except AttributeError:
  250. desc = ''
  251. if desc is None:
  252. desc = ''
  253. try:
  254. keyw = mnode.find('keywords').text
  255. except AttributeError:
  256. keyw = ''
  257. if keyw is None:
  258. keyw = ''
  259. return desc, keyw
  260. def list_available_modules(url, mlist = None):
  261. # try to download XML metadata file first
  262. url = url + "modules.xml"
  263. grass.debug("url=%s" % url, 1)
  264. try:
  265. f = urlopen(url, proxies=PROXIES)
  266. try:
  267. tree = etree.fromstring(f.read())
  268. except:
  269. grass.warning(_("Unable to parse '%s'. Trying to scan SVN (may take some time)...") % url)
  270. list_available_extensions_svn()
  271. return
  272. for mnode in tree.findall('task'):
  273. name = mnode.get('name').strip()
  274. if mlist and name not in mlist:
  275. continue
  276. if flags['c'] or flags['g']:
  277. desc, keyw = get_optional_params(mnode)
  278. if flags['g']:
  279. print 'name=' + name
  280. print 'description=' + desc
  281. print 'keywords=' + keyw
  282. elif flags['c']:
  283. if mlist:
  284. print '*',
  285. print name + ' - ' + desc
  286. else:
  287. print name
  288. except HTTPError:
  289. list_available_extensions_svn()
  290. # list extensions (scan SVN repo)
  291. def list_available_extensions_svn():
  292. grass.message(_('Fetching list of extensions from GRASS-Addons SVN (be patient)...'))
  293. pattern = re.compile(r'(<li><a href=".+">)(.+)(</a></li>)', re.IGNORECASE)
  294. if flags['c']:
  295. grass.warning(_("Flag 'c' ignored, metadata file not available"))
  296. if flags['g']:
  297. grass.warning(_("Flag 'g' ignored, metadata file not available"))
  298. prefix = ['d', 'db', 'g', 'i', 'm', 'ps',
  299. 'p', 'r', 'r3', 's', 'v']
  300. for d in prefix:
  301. modclass = expand_module_class_name(d)
  302. grass.verbose(_("Checking for '%s' modules...") % modclass)
  303. url = '%s/%s' % (options['svnurl'], modclass)
  304. grass.debug("url = %s" % url, debug = 2)
  305. try:
  306. f = urlopen(url, proxies=PROXIES)
  307. except HTTPError:
  308. grass.debug(_("Unable to fetch '%s'") % url, debug = 1)
  309. continue
  310. for line in f.readlines():
  311. # list extensions
  312. sline = pattern.search(line)
  313. if not sline:
  314. continue
  315. name = sline.group(2).rstrip('/')
  316. if name.split('.', 1)[0] == d:
  317. print name
  318. # get_wxgui_extensions()
  319. # list wxGUI extensions
  320. def get_wxgui_extensions():
  321. mlist = list()
  322. grass.debug('Fetching list of wxGUI extensions from GRASS-Addons SVN (be patient)...')
  323. pattern = re.compile(r'(<li><a href=".+">)(.+)(</a></li>)', re.IGNORECASE)
  324. grass.verbose(_("Checking for '%s' modules...") % 'gui/wxpython')
  325. url = '%s/%s' % (options['svnurl'], 'gui/wxpython')
  326. grass.debug("url = %s" % url, debug = 2)
  327. f = urlopen(url, proxies=PROXIES)
  328. if not f:
  329. grass.warning(_("Unable to fetch '%s'") % url)
  330. return
  331. for line in f.readlines():
  332. # list extensions
  333. sline = pattern.search(line)
  334. if not sline:
  335. continue
  336. name = sline.group(2).rstrip('/')
  337. if name not in ('..', 'Makefile'):
  338. mlist.append(name)
  339. return mlist
  340. def cleanup():
  341. if REMOVE_TMPDIR:
  342. grass.try_rmdir(TMPDIR)
  343. else:
  344. grass.message(_("Path to the source code:"))
  345. sys.stderr.write('%s\n' % os.path.join(TMPDIR, options['extension']))
  346. # write out meta-file
  347. def write_xml_modules(name, tree = None):
  348. fo = open(name, 'w')
  349. fo.write('<?xml version="1.0" encoding="UTF-8"?>\n')
  350. fo.write('<!DOCTYPE task SYSTEM "grass-addons.dtd">\n')
  351. fo.write('<addons version="%s">\n' % version[0])
  352. libgisRev = grass.version()['libgis_revision']
  353. if tree is not None:
  354. for tnode in tree.findall('task'):
  355. indent = 4
  356. fo.write('%s<task name="%s">\n' % (' ' * indent, tnode.get('name')))
  357. indent += 4
  358. fo.write('%s<description>%s</description>\n' % \
  359. (' ' * indent, tnode.find('description').text))
  360. fo.write('%s<keywords>%s</keywords>\n' % \
  361. (' ' * indent, tnode.find('keywords').text))
  362. bnode = tnode.find('binary')
  363. if bnode is not None:
  364. fo.write('%s<binary>\n' % (' ' * indent))
  365. indent += 4
  366. for fnode in bnode.findall('file'):
  367. fo.write('%s<file>%s</file>\n' % \
  368. (' ' * indent, os.path.join(options['prefix'], fnode.text)))
  369. indent -= 4
  370. fo.write('%s</binary>\n' % (' ' * indent))
  371. fo.write('%s<libgis revision="%s" />\n' % \
  372. (' ' * indent, libgisRev))
  373. indent -= 4
  374. fo.write('%s</task>\n' % (' ' * indent))
  375. fo.write('</addons>\n')
  376. fo.close()
  377. def write_xml_toolboxes(name, tree = None):
  378. fo = open(name, 'w')
  379. fo.write('<?xml version="1.0" encoding="UTF-8"?>\n')
  380. fo.write('<!DOCTYPE toolbox SYSTEM "grass-addons.dtd">\n')
  381. fo.write('<addons version="%s">\n' % version[0])
  382. if tree is not None:
  383. for tnode in tree.findall('toolbox'):
  384. indent = 4
  385. fo.write('%s<toolbox name="%s" code="%s">\n' % \
  386. (' ' * indent, tnode.get('name'), tnode.get('code')))
  387. indent += 4
  388. for cnode in tnode.findall('correlate'):
  389. fo.write('%s<correlate code="%s" />\n' % \
  390. (' ' * indent, tnode.get('code')))
  391. for mnode in tnode.findall('task'):
  392. fo.write('%s<task name="%s" />\n' % \
  393. (' ' * indent, mnode.get('name')))
  394. indent -= 4
  395. fo.write('%s</toolbox>\n' % (' ' * indent))
  396. fo.write('</addons>\n')
  397. fo.close()
  398. # install extension - toolbox or module
  399. def install_extension(url):
  400. gisbase = os.getenv('GISBASE')
  401. if not gisbase:
  402. grass.fatal(_('$GISBASE not defined'))
  403. if options['extension'] in get_installed_extensions(force = True):
  404. grass.warning(_("Extension <%s> already installed. Re-installing...") % options['extension'])
  405. if flags['t']:
  406. grass.message(_("Installing toolbox <%s>...") % options['extension'])
  407. mlist = get_toolbox_modules(url, options['extension'])
  408. else:
  409. mlist = [options['extension']]
  410. if not mlist:
  411. grass.warning(_("Nothing to install"))
  412. return
  413. ret = 0
  414. for module in mlist:
  415. if sys.platform == "win32":
  416. ret += install_extension_win(module)
  417. else:
  418. ret += install_extension_other(module)
  419. if len(mlist) > 1:
  420. print '-' * 60
  421. if flags['d']:
  422. return
  423. if ret != 0:
  424. grass.warning(_('Installation failed, sorry. Please check above error messages.'))
  425. else:
  426. grass.message(_("Updating metadata file..."))
  427. blist = install_extension_xml(url, mlist)
  428. for module in blist:
  429. update_manual_page(module)
  430. grass.message(_("Installation of <%s> successfully finished") % options['extension'])
  431. if not os.getenv('GRASS_ADDON_BASE'):
  432. grass.warning(_('This add-on module will not function until you set the '
  433. 'GRASS_ADDON_BASE environment variable (see "g.manual variables")'))
  434. # update local meta-file when installing new extension (toolbox / modules)
  435. def install_toolbox_xml(url, name):
  436. # read metadata from remote server (toolboxes)
  437. url = url + "toolboxes.xml"
  438. data = dict()
  439. try:
  440. f = urlopen(url, proxies=PROXIES)
  441. tree = etree.fromstring(f.read())
  442. for tnode in tree.findall('toolbox'):
  443. clist = list()
  444. for cnode in tnode.findall('correlate'):
  445. clist.append(cnode.get('code'))
  446. mlist = list()
  447. for mnode in tnode.findall('task'):
  448. mlist.append(mnode.get('name'))
  449. code = tnode.get('code')
  450. data[code] = {
  451. 'name' : tnode.get('name'),
  452. 'correlate' : clist,
  453. 'modules' : mlist,
  454. }
  455. except HTTPError:
  456. grass.error(_("Unable to read metadata file from the remote server"))
  457. if not data:
  458. grass.warning(_("No metadata available"))
  459. return
  460. if name not in data:
  461. grass.warning(_("No metadata available for <%s>") % name)
  462. return
  463. fXML = os.path.join(options['prefix'], 'toolboxes.xml')
  464. # create an empty file if not exists
  465. if not os.path.exists(fXML):
  466. write_xml_modules(fXML)
  467. # read XML file
  468. fo = open(fXML, 'r')
  469. tree = etree.fromstring(fo.read())
  470. fo.close()
  471. # update tree
  472. tnode = None
  473. for node in tree.findall('toolbox'):
  474. if node.get('code') == name:
  475. tnode = node
  476. break
  477. tdata = data[name]
  478. if tnode is not None:
  479. # update existing node
  480. for cnode in tnode.findall('correlate'):
  481. tnode.remove(cnode)
  482. for mnode in tnode.findall('task'):
  483. tnode.remove(mnode)
  484. else:
  485. # create new node for task
  486. tnode = etree.Element('toolbox', attrib = { 'name' : tdata['name'], 'code' : name })
  487. tree.append(tnode)
  488. for cname in tdata['correlate']:
  489. cnode = etree.Element('correlate', attrib = { 'code' : cname })
  490. tnode.append(cnode)
  491. for tname in tdata['modules']:
  492. mnode = etree.Element('task', attrib = { 'name' : tname })
  493. tnode.append(mnode)
  494. write_xml_toolboxes(fXML, tree)
  495. # return list of executables for update_manual_page()
  496. def install_extension_xml(url, mlist):
  497. if len(mlist) > 1:
  498. # read metadata from remote server (toolboxes)
  499. install_toolbox_xml(url, options['extension'])
  500. # read metadata from remote server (modules)
  501. url = url + "modules.xml"
  502. data = {}
  503. bList = []
  504. try:
  505. f = urlopen(url, proxies=PROXIES)
  506. try:
  507. tree = etree.fromstring(f.read())
  508. except:
  509. grass.warning(_("Unable to parse '%s'. Metadata file not updated.") % url)
  510. return bList
  511. for mnode in tree.findall('task'):
  512. name = mnode.get('name')
  513. if name not in mlist:
  514. continue
  515. fList = list()
  516. bnode = mnode.find('binary')
  517. windows = sys.platform == 'win32'
  518. if bnode is not None:
  519. for fnode in bnode.findall('file'):
  520. path = fnode.text.split('/')
  521. if path[0] == 'bin':
  522. bList.append(path[-1])
  523. if windows:
  524. path[-1] += '.exe'
  525. elif path[0] == 'scripts':
  526. bList.append(path[-1])
  527. if windows:
  528. path[-1] += '.py'
  529. fList.append(os.path.sep.join(path))
  530. desc, keyw = get_optional_params(mnode)
  531. data[name] = {
  532. 'desc' : desc,
  533. 'keyw' : keyw,
  534. 'files' : fList,
  535. }
  536. except HTTPError:
  537. grass.error(_("Unable to read metadata file from the remote server"))
  538. if not data:
  539. grass.warning(_("No metadata available"))
  540. return []
  541. fXML = os.path.join(options['prefix'], 'modules.xml')
  542. # create an empty file if not exists
  543. if not os.path.exists(fXML):
  544. write_xml_modules(fXML)
  545. # read XML file
  546. fo = open(fXML, 'r')
  547. tree = etree.fromstring(fo.read())
  548. fo.close()
  549. # update tree
  550. for name in mlist:
  551. tnode = None
  552. for node in tree.findall('task'):
  553. if node.get('name') == name:
  554. tnode = node
  555. break
  556. if name not in data:
  557. grass.warning(_("No metadata found for <%s>") % name)
  558. continue
  559. ndata = data[name]
  560. if tnode is not None:
  561. # update existing node
  562. dnode = tnode.find('description')
  563. if dnode is not None:
  564. dnode.text = ndata['desc']
  565. knode = tnode.find('keywords')
  566. if knode is not None:
  567. knode.text = ndata['keyw']
  568. bnode = tnode.find('binary')
  569. if bnode is not None:
  570. tnode.remove(bnode)
  571. bnode = etree.Element('binary')
  572. for f in ndata['files']:
  573. fnode = etree.Element('file')
  574. fnode.text = f
  575. bnode.append(fnode)
  576. tnode.append(bnode)
  577. else:
  578. # create new node for task
  579. tnode = etree.Element('task', attrib = { 'name' : name })
  580. dnode = etree.Element('description')
  581. dnode.text = ndata['desc']
  582. tnode.append(dnode)
  583. knode = etree.Element('keywords')
  584. knode.text = ndata['keyw']
  585. tnode.append(knode)
  586. bnode = etree.Element('binary')
  587. for f in ndata['files']:
  588. fnode = etree.Element('file')
  589. fnode.text = f
  590. bnode.append(fnode)
  591. tnode.append(bnode)
  592. tree.append(tnode)
  593. write_xml_modules(fXML, tree)
  594. return bList
  595. # install extension on MS Windows
  596. def install_extension_win(name):
  597. ### TODO: do not use hardcoded url - http://wingrass.fsv.cvut.cz/grassXX/addonsX.X.X
  598. grass.message(_("Downloading precompiled GRASS Addons <%s>...") % options['extension'])
  599. url = "http://wingrass.fsv.cvut.cz/grass%s%s/addons" % (version[0], version[1])
  600. grass.debug("url=%s" % url, 1)
  601. try:
  602. f = urlopen(url + '/' + name + '.zip', proxies=PROXIES)
  603. # create addons dir if not exists
  604. if not os.path.exists(options['prefix']):
  605. os.mkdir(options['prefix'])
  606. # download data
  607. fo = tempfile.TemporaryFile()
  608. fo.write(f.read())
  609. zfobj = zipfile.ZipFile(fo)
  610. for name in zfobj.namelist():
  611. if name.endswith('/'):
  612. d = os.path.join(options['prefix'], name)
  613. if not os.path.exists(d):
  614. os.mkdir(d)
  615. else:
  616. outfile = open(os.path.join(options['prefix'], name), 'wb')
  617. outfile.write(zfobj.read(name))
  618. outfile.close()
  619. fo.close()
  620. except HTTPError:
  621. grass.fatal(_("GRASS Addons <%s> not found") % name)
  622. return 0
  623. # install extension on other plaforms
  624. def install_extension_other(name):
  625. gisbase = os.getenv('GISBASE')
  626. classchar = name.split('.', 1)[0]
  627. moduleclass = expand_module_class_name(classchar)
  628. url = options['svnurl'] + '/' + moduleclass + '/' + name
  629. if classchar == 'wx' and not flags['s']:
  630. grass.fatal(_("Installation of wxGUI extension requires -%s flag.") % 's')
  631. grass.message(_("Fetching <%s> from GRASS-Addons SVN (be patient)...") % name)
  632. os.chdir(TMPDIR)
  633. if grass.verbosity() <= 2:
  634. outdev = open(os.devnull, 'w')
  635. else:
  636. outdev = sys.stdout
  637. if grass.call(['svn', 'checkout',
  638. url], stdout = outdev) != 0:
  639. grass.fatal(_("GRASS Addons <%s> not found") % name)
  640. dirs = { 'bin' : os.path.join(TMPDIR, name, 'bin'),
  641. 'docs' : os.path.join(TMPDIR, name, 'docs'),
  642. 'html' : os.path.join(TMPDIR, name, 'docs', 'html'),
  643. 'rest' : os.path.join(TMPDIR, name, 'docs', 'rest'),
  644. 'man' : os.path.join(TMPDIR, name, 'docs', 'man', 'man1'),
  645. 'scripts' : os.path.join(TMPDIR, name, 'scripts'),
  646. 'etc' : os.path.join(TMPDIR, name, 'etc'),
  647. }
  648. if classchar != 'wx':
  649. makeCmd = ['make',
  650. 'MODULE_TOPDIR=%s' % gisbase.replace(' ', '\ '),
  651. 'RUN_GISRC=%s' % os.environ['GISRC'],
  652. 'BIN=%s' % dirs['bin'],
  653. 'HTMLDIR=%s' % dirs['html'],
  654. 'RESTDIR=%s' % dirs['rest'],
  655. 'MANDIR=%s' % dirs['man'],
  656. 'SCRIPTDIR=%s' % dirs['scripts'],
  657. 'ETC=%s' % os.path.join(dirs['etc'], name)
  658. ]
  659. else:
  660. makeCmd = ['make',
  661. 'MODULE_TOPDIR=%s' % gisbase.replace(' ', '\ ')
  662. ]
  663. installCmd = ['make',
  664. 'MODULE_TOPDIR=%s' % gisbase,
  665. 'ARCH_DISTDIR=%s' % os.path.join(TMPDIR, name),
  666. 'INST_DIR=%s' % options['prefix'],
  667. 'install'
  668. ]
  669. if flags['d']:
  670. grass.message(_("To compile run:"))
  671. sys.stderr.write(' '.join(makeCmd) + '\n')
  672. grass.message(_("To install run:"))
  673. sys.stderr.write(' '.join(installCmd) + '\n')
  674. return 0
  675. os.chdir(os.path.join(TMPDIR, name))
  676. grass.message(_("Compiling..."))
  677. if 0 != grass.call(makeCmd,
  678. stdout = outdev):
  679. grass.fatal(_('Compilation failed, sorry. Please check above error messages.'))
  680. if flags['i'] or classchar == 'wx':
  681. return 0
  682. grass.message(_("Installing..."))
  683. return grass.call(installCmd,
  684. stdout = outdev)
  685. # remove existing extension - toolbox or module
  686. def remove_extension(force = False):
  687. if flags['t']:
  688. mlist = get_toolbox_modules(options['extension'])
  689. else:
  690. mlist = [options['extension']]
  691. if force:
  692. grass.verbose(_("List of removed files:"))
  693. else:
  694. grass.info(_("Files to be removed (use flag 'f' to force removal):"))
  695. remove_modules(mlist, force)
  696. if force:
  697. grass.message(_("Updating metadata file..."))
  698. remove_extension_xml(mlist)
  699. grass.message(_("Extension <%s> successfully uninstalled.") % options['extension'])
  700. else:
  701. grass.warning(_("Extension <%s> not removed.\n"
  702. "Re-run '%s' with 'f' flag to force removal") % (options['extension'], 'g.extension'))
  703. # remove existing extension(s) (reading XML file)
  704. def remove_modules(mlist, force = False):
  705. # try to read XML metadata file first
  706. fXML = os.path.join(options['prefix'], 'modules.xml')
  707. installed = get_installed_modules()
  708. if os.path.exists(fXML):
  709. f = open(fXML, 'r')
  710. tree = etree.fromstring(f.read())
  711. f.close()
  712. else:
  713. tree = None
  714. for name in mlist:
  715. if name not in installed:
  716. # try even if module does not seem to be available,
  717. # as the user may be trying to get rid of left over cruft
  718. grass.warning(_("Extension <%s> not found") % name)
  719. if tree is not None:
  720. flist = []
  721. for task in tree.findall('task'):
  722. if name == task.get('name') and \
  723. task.find('binary') is not None:
  724. for f in task.find('binary').findall('file'):
  725. flist.append(f.text)
  726. break
  727. if flist:
  728. removed = False
  729. err = list()
  730. for fpath in flist:
  731. try:
  732. if force:
  733. grass.verbose(fpath)
  734. removed = True
  735. os.remove(fpath)
  736. else:
  737. print fpath
  738. except OSError:
  739. err.append((_("Unable to remove file '%s'") % fpath))
  740. if force and not removed:
  741. grass.fatal(_("Extension <%s> not found") % name)
  742. if err:
  743. for e in err:
  744. grass.error(e)
  745. else:
  746. remove_extension_std(name, force)
  747. else:
  748. remove_extension_std(name, force)
  749. # remove exising extension (using standard files layout)
  750. def remove_extension_std(name, force = False):
  751. for fpath in [os.path.join(options['prefix'], 'bin', name),
  752. os.path.join(options['prefix'], 'scripts', name),
  753. os.path.join(options['prefix'], 'docs', 'html', name + '.html'),
  754. os.path.join(options['prefix'], 'docs', 'rest', name + '.txt'),
  755. os.path.join(options['prefix'], 'docs', 'man', 'man1', name + '.1')]:
  756. if os.path.isfile(fpath):
  757. if force:
  758. grass.verbose(fpath)
  759. os.remove(fpath)
  760. else:
  761. print fpath
  762. # update local meta-file when removing existing extension
  763. def remove_toolbox_xml(name):
  764. fXML = os.path.join(options['prefix'], 'toolboxes.xml')
  765. if not os.path.exists(fXML):
  766. return
  767. # read XML file
  768. fo = open(fXML, 'r')
  769. tree = etree.fromstring(fo.read())
  770. fo.close()
  771. for node in tree.findall('toolbox'):
  772. if node.get('code') != name:
  773. continue
  774. tree.remove(node)
  775. write_xml_toolboxes(fXML, tree)
  776. def remove_extension_xml(modules):
  777. if len(modules) > 1:
  778. # update also toolboxes metadata
  779. remove_toolbox_xml(options['extension'])
  780. fXML = os.path.join(options['prefix'], 'modules.xml')
  781. if not os.path.exists(fXML):
  782. return
  783. # read XML file
  784. fo = open(fXML, 'r')
  785. tree = etree.fromstring(fo.read())
  786. fo.close()
  787. for name in modules:
  788. for node in tree.findall('task'):
  789. if node.get('name') != name:
  790. continue
  791. tree.remove(node)
  792. write_xml_modules(fXML, tree)
  793. # check links in CSS
  794. def check_style_files(fil):
  795. dist_file = os.path.join(os.getenv('GISBASE'), 'docs', 'html', fil)
  796. addons_file = os.path.join(options['prefix'], 'docs', 'html', fil)
  797. if os.path.isfile(addons_file):
  798. return
  799. try:
  800. shutil.copyfile(dist_file, addons_file)
  801. except OSError, e:
  802. grass.fatal(_("Unable to create '%s': %s") % (addons_file, e))
  803. def create_dir(path):
  804. if os.path.isdir(path):
  805. return
  806. try:
  807. os.makedirs(path)
  808. except OSError, e:
  809. grass.fatal(_("Unable to create '%s': %s") % (path, e))
  810. grass.debug("'%s' created" % path)
  811. def check_dirs():
  812. create_dir(os.path.join(options['prefix'], 'bin'))
  813. create_dir(os.path.join(options['prefix'], 'docs', 'html'))
  814. create_dir(os.path.join(options['prefix'], 'docs', 'rest'))
  815. check_style_files('grass_logo.png')
  816. check_style_files('grassdocs.css')
  817. create_dir(os.path.join(options['prefix'], 'etc'))
  818. create_dir(os.path.join(options['prefix'], 'docs', 'man', 'man1'))
  819. create_dir(os.path.join(options['prefix'], 'scripts'))
  820. # fix file URI in manual page
  821. def update_manual_page(module):
  822. if module.split('.', 1)[0] == 'wx':
  823. return # skip for GUI modules
  824. grass.verbose(_("Manual page for <%s> updated") % module)
  825. # read original html file
  826. htmlfile = os.path.join(options['prefix'], 'docs', 'html', module + '.html')
  827. try:
  828. f = open(htmlfile)
  829. shtml = f.read()
  830. except IOError, e:
  831. grass.fatal(_("Unable to read manual page: %s") % e)
  832. else:
  833. f.close()
  834. # find URIs
  835. pattern = r'''<a href="([^"]+)">([^>]+)</a>'''
  836. addons = get_installed_extensions(force = True)
  837. pos = []
  838. for match in re.finditer(pattern, shtml):
  839. if match.group(1)[:7] == 'http://':
  840. continue
  841. if match.group(1).replace('.html', '') in addons:
  842. continue
  843. pos.append(match.start(1))
  844. if not pos:
  845. return # no match
  846. # replace file URIs
  847. prefix = 'file://' + '/'.join([os.getenv('GISBASE'), 'docs', 'html'])
  848. ohtml = shtml[:pos[0]]
  849. for i in range(1, len(pos)):
  850. ohtml += prefix + '/' + shtml[pos[i-1]:pos[i]]
  851. ohtml += prefix + '/' + shtml[pos[-1]:]
  852. # write updated html file
  853. try:
  854. f = open(htmlfile, 'w')
  855. f.write(ohtml)
  856. except IOError, e:
  857. grass.fatal(_("Unable for write manual page: %s") % e)
  858. else:
  859. f.close()
  860. def main():
  861. # check dependecies
  862. if sys.platform != "win32":
  863. check_progs()
  864. # manage proxies
  865. global PROXIES
  866. if options['proxy']:
  867. PROXIES = {}
  868. for ptype, purl in (p.split('=') for p in options['proxy'].split(',')):
  869. PROXIES[ptype] = purl
  870. # define path
  871. if flags['s']:
  872. options['prefix'] = os.environ['GISBASE']
  873. if options['prefix'] == '$GRASS_ADDON_BASE':
  874. if not os.getenv('GRASS_ADDON_BASE'):
  875. grass.warning(_("GRASS_ADDON_BASE is not defined, "
  876. "installing to ~/.grass%s/addons") % version[0])
  877. options['prefix'] = os.path.join(os.environ['HOME'], '.grass%s' % version[0], 'addons')
  878. else:
  879. options['prefix'] = os.environ['GRASS_ADDON_BASE']
  880. if 'svn.osgeo.org/grass/grass-addons/grass7' in options['svnurl']:
  881. # use pregenerated modules XML file
  882. xmlurl = "http://grass.osgeo.org/addons/grass%s" % version[0]
  883. else:
  884. # try to get modules XMl from SVN repository
  885. xmlurl = options['svnurl']
  886. if not xmlurl.endswith('/'):
  887. xmlurl = xmlurl + "/"
  888. # list available extensions
  889. if flags['l'] or flags['c'] or flags['g']:
  890. list_available_extensions(xmlurl)
  891. return 0
  892. elif flags['a']:
  893. elist = get_installed_extensions()
  894. if elist:
  895. if flags['t']:
  896. grass.message(_("List of installed extensions (toolboxes):"))
  897. else:
  898. grass.message(_("List of installed extensions (modules):"))
  899. sys.stdout.write('\n'.join(elist))
  900. sys.stdout.write('\n')
  901. else:
  902. if flags['t']:
  903. grass.info(_("No extension (toolbox) installed"))
  904. else:
  905. grass.info(_("No extension (module) installed"))
  906. return 0
  907. else:
  908. if not options['extension']:
  909. grass.fatal(_('You need to define an extension name or use -l/c/g/a'))
  910. if flags['d']:
  911. if options['operation'] != 'add':
  912. grass.warning(_("Flag 'd' is relevant only to 'operation=add'. Ignoring this flag."))
  913. else:
  914. global REMOVE_TMPDIR
  915. REMOVE_TMPDIR = False
  916. if options['operation'] == 'add':
  917. check_dirs()
  918. install_extension(xmlurl)
  919. else: # remove
  920. remove_extension(flags['f'])
  921. return 0
  922. if __name__ == "__main__":
  923. options, flags = grass.parser()
  924. global TMPDIR
  925. TMPDIR = grass.tempdir()
  926. atexit.register(cleanup)
  927. version = grass.version()['version'].split('.')
  928. sys.exit(main())