model.py 92 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674
  1. """
  2. @package gmodeler.model
  3. @brief wxGUI Graphical Modeler (base classes & read/write)
  4. Classes:
  5. - model::Model
  6. - model::ModelObject
  7. - model::ModelAction
  8. - model::ModelData
  9. - model::ModelRelation
  10. - model::ModelItem
  11. - model::ModelLoop
  12. - model::ModelCondition
  13. - model::ModelComment
  14. - model::ProcessModelFile
  15. - model::WriteModelFile
  16. - model::WritePythonFile
  17. - model::ModelParamDialog
  18. (C) 2010-2016 by the GRASS Development Team
  19. This program is free software under the GNU General Public License
  20. (>=v2). Read the file COPYING that comes with GRASS for details.
  21. @author Martin Landa <landa.martin gmail.com>
  22. """
  23. import os
  24. import getpass
  25. import copy
  26. import re
  27. import mimetypes
  28. import time
  29. try:
  30. import xml.etree.ElementTree as etree
  31. except ImportError:
  32. import elementtree.ElementTree as etree # Python <= 2.4
  33. import xml.sax.saxutils as saxutils
  34. import wx
  35. from wx.lib import ogl
  36. from core import globalvar
  37. from core import utils
  38. from core.utils import _
  39. from core.gcmd import GMessage, GException, GError, RunCommand, EncodeString, GWarning, GetDefaultEncoding
  40. from core.settings import UserSettings
  41. from gui_core.forms import GUI, CmdPanel
  42. from gui_core.widgets import GNotebook
  43. from gmodeler.giface import GraphicalModelerGrassInterface
  44. from grass.script import core as grass
  45. from grass.script import task as gtask
  46. class Model(object):
  47. """Class representing the model"""
  48. def __init__(self, canvas = None):
  49. self.items = list() # list of ordered items (action/loop/condition)
  50. # model properties
  51. self.properties = { 'name' : _("model"),
  52. 'description' : _("Script generated by wxGUI Graphical Modeler."),
  53. 'author' : getpass.getuser() }
  54. # model variables
  55. self.variables = dict()
  56. self.variablesParams = dict()
  57. self.canvas = canvas
  58. def GetCanvas(self):
  59. """Get canvas or None"""
  60. return self.canvas
  61. def GetItems(self, objType = None):
  62. """Get list of model items
  63. :param objType: Object type to filter model objects
  64. """
  65. if not objType:
  66. return self.items
  67. result = list()
  68. for item in self.items:
  69. if isinstance(item, objType):
  70. result.append(item)
  71. return result
  72. def GetItem(self, aId, objType=None):
  73. """Get item of given id
  74. :param aId: item id
  75. :return: Model* instance
  76. :return: None if no item found
  77. """
  78. ilist = self.GetItems(objType)
  79. for item in ilist:
  80. if item.GetId() == aId:
  81. return item
  82. return None
  83. def GetItemIndex(self, item):
  84. """Return list index of given item"""
  85. return self.items.index(item)
  86. def GetNumItems(self, actionOnly = False):
  87. """Get number of items"""
  88. if actionOnly:
  89. return len(self.GetItems(objType = ModelAction))
  90. return len(self.GetItems())
  91. def ReorderItems(self, idxList):
  92. items = list()
  93. for oldIdx, newIdx in idxList.iteritems():
  94. item = self.items.pop(oldIdx)
  95. items.append(item)
  96. self.items.insert(newIdx, item)
  97. try:
  98. nextItem = self.items[newIdx+1]
  99. except IndexError:
  100. continue # newIdx is the last item in the list
  101. items.append(nextItem)
  102. x = item.GetX()
  103. y = item.GetY()
  104. item.SetX(nextItem.GetX())
  105. item.SetY(nextItem.GetY())
  106. nextItem.SetX(x)
  107. nextItem.SetY(y)
  108. dc = wx.ClientDC(self.canvas)
  109. for item in items:
  110. item.MoveLinks(dc)
  111. for mo in item.GetBlock():
  112. if isinstance(mo, ModelLoop):
  113. self.canvas.parent.DefineLoop(mo)
  114. elif isinstance(mo, ModelCondition):
  115. self.canvas.parent.DefineCondition(mo)
  116. def Normalize(self):
  117. # check for inconsistecies
  118. for idx in range(1, len(self.items)):
  119. if not self.items[idx].GetBlock() and \
  120. isinstance(self.items[idx-1], ModelLoop):
  121. # swap action not-in-block with previously defined
  122. # loop
  123. itemPrev = self.items[idx-1]
  124. self.items[idx-1] = self.items[idx]
  125. self.items[idx] = itemPrev
  126. # update ids
  127. iId = 1
  128. for item in self.items:
  129. item.SetId(iId)
  130. item.SetLabel()
  131. iId += 1
  132. def GetNextId(self):
  133. """Get next id (data ignored)
  134. :return: next id to be used (default: 1)
  135. """
  136. if len(self.items) < 1:
  137. return 1
  138. currId = self.items[-1].GetId()
  139. if currId > 0:
  140. return currId + 1
  141. return 1
  142. def GetProperties(self):
  143. """Get model properties"""
  144. return self.properties
  145. def GetVariables(self, params = False):
  146. """Get model variables"""
  147. if params:
  148. return self.variablesParams
  149. return self.variables
  150. def SetVariables(self, data):
  151. """Set model variables"""
  152. self.variables = data
  153. def Reset(self):
  154. """Reset model"""
  155. self.items = list()
  156. def RemoveItem(self, item, reference=None):
  157. """Remove item from model
  158. :item: item to be removed
  159. :reference: reference item valid for deletion
  160. :return: list of related items to remove/update
  161. """
  162. relList = list()
  163. upList = list()
  164. doRemove = True
  165. if isinstance(item, ModelAction):
  166. for rel in item.GetRelations():
  167. relList.append(rel)
  168. data = rel.GetData()
  169. if len(data.GetRelations()) < 2:
  170. relList.append(data)
  171. else:
  172. upList.append(data)
  173. elif isinstance(item, ModelData):
  174. for rel in item.GetRelations():
  175. otherItem = rel.GetTo() if rel.GetFrom() == item else rel.GetFrom()
  176. if reference and reference != otherItem:
  177. doRemove = False
  178. continue # avoid recursive deletion
  179. relList.append(rel)
  180. if reference and reference != otherItem:
  181. relList.append(otherItem)
  182. if not doRemove:
  183. upList.append(item)
  184. elif isinstance(item, ModelLoop):
  185. for rel in item.GetRelations():
  186. relList.append(rel)
  187. for action in self.GetItems():
  188. action.UnSetBlock(item)
  189. if doRemove and item in self.items:
  190. self.items.remove(item)
  191. return relList, upList
  192. def FindAction(self, aId):
  193. """Find action by id"""
  194. alist = self.GetItems(objType = ModelAction)
  195. for action in alist:
  196. if action.GetId() == aId:
  197. return action
  198. return None
  199. def GetMaps(self, prompt):
  200. """Get list of maps of selected type
  201. :param prompt: to filter maps"""
  202. maps = list()
  203. for data in self.GetData():
  204. if prompt == data.GetPrompt():
  205. mapName = data.GetValue()
  206. if not mapName or mapName[0] is '%':
  207. continue # skip variables
  208. maps.append(mapName)
  209. return maps
  210. def GetData(self):
  211. """Get list of data items"""
  212. result = list()
  213. dataItems = self.GetItems(objType = ModelData)
  214. for action in self.GetItems(objType = ModelAction):
  215. for rel in action.GetRelations():
  216. dataItem = rel.GetData()
  217. if dataItem not in result:
  218. result.append(dataItem)
  219. if dataItem in dataItems:
  220. dataItems.remove(dataItem)
  221. # standalone data
  222. if dataItems:
  223. result += dataItems
  224. return result
  225. def FindData(self, value, prompt):
  226. """Find data item in the model
  227. :param value: value
  228. :param prompt: prompt
  229. :return: ModelData instance
  230. :return: None if not found
  231. """
  232. for data in self.GetData():
  233. if data.GetValue() == value and \
  234. data.GetPrompt() == prompt:
  235. return data
  236. return None
  237. def LoadModel(self, filename):
  238. """Load model definition stored in GRASS Model XML file (gxm)
  239. .. todo::
  240. Validate against DTD
  241. Raise exception on error.
  242. """
  243. dtdFilename = os.path.join(globalvar.WXGUIDIR, "xml", "grass-gxm.dtd")
  244. # parse workspace file
  245. try:
  246. gxmXml = ProcessModelFile(etree.parse(filename))
  247. except StandardError as e:
  248. raise GException(unicode(e))
  249. if self.canvas:
  250. win = self.canvas.parent
  251. if gxmXml.pos:
  252. win.SetPosition(gxmXml.pos)
  253. if gxmXml.size:
  254. win.SetSize(gxmXml.size)
  255. # load properties
  256. self.properties = gxmXml.properties
  257. self.variables = gxmXml.variables
  258. # load actions
  259. for action in gxmXml.actions:
  260. actionItem = ModelAction(parent = self,
  261. x = action['pos'][0],
  262. y = action['pos'][1],
  263. width = action['size'][0],
  264. height = action['size'][1],
  265. task = action['task'],
  266. id = action['id'],
  267. label = action['label'],
  268. comment = action['comment'])
  269. if action['disabled']:
  270. actionItem.Enable(False)
  271. self.AddItem(actionItem, pos = actionItem.GetId()-1)
  272. actionItem.SetValid(actionItem.GetTask().get_options())
  273. actionItem.GetLog() # substitute variables (-> valid/invalid)
  274. # load data & relations
  275. for data in gxmXml.data:
  276. dataItem = ModelData(parent = self,
  277. x = data['pos'][0],
  278. y = data['pos'][1],
  279. width = data['size'][0],
  280. height = data['size'][1],
  281. prompt = data['prompt'],
  282. value = data['value'])
  283. dataItem.SetIntermediate(data['intermediate'])
  284. for rel in data['rels']:
  285. actionItem = self.FindAction(rel['id'])
  286. if rel['dir'] == 'from':
  287. relation = ModelRelation(parent = self, fromShape = dataItem,
  288. toShape = actionItem, param = rel['name'])
  289. else:
  290. relation = ModelRelation(parent = self, fromShape = actionItem,
  291. toShape = dataItem, param = rel['name'])
  292. relation.SetControlPoints(rel['points'])
  293. actionItem.AddRelation(relation)
  294. dataItem.AddRelation(relation)
  295. if self.canvas:
  296. dataItem.Update()
  297. # load loops
  298. for loop in gxmXml.loops:
  299. loopItem = ModelLoop(parent = self,
  300. x = loop['pos'][0],
  301. y = loop['pos'][1],
  302. width = loop['size'][0],
  303. height = loop['size'][1],
  304. label = loop['text'],
  305. id = loop['id'])
  306. self.AddItem(loopItem, pos = loopItem.GetId()-1)
  307. # load conditions
  308. for condition in gxmXml.conditions:
  309. conditionItem = ModelCondition(parent = self,
  310. x = condition['pos'][0],
  311. y = condition['pos'][1],
  312. width = condition['size'][0],
  313. height = condition['size'][1],
  314. label = condition['text'],
  315. id = condition['id'])
  316. self.AddItem(conditionItem, pos = conditionItem.GetId()-1)
  317. # define loops & if/else items
  318. for loop in gxmXml.loops:
  319. loopItem = self.GetItem(loop['id'], objType=ModelLoop)
  320. loopItem.SetItems(loop['items'])
  321. for idx in loop['items']:
  322. action = self.GetItem(idx, objType=ModelAction)
  323. action.SetBlock(loopItem)
  324. for condition in gxmXml.conditions:
  325. conditionItem = self.GetItem(condition['id'])
  326. for b in condition['items'].keys():
  327. alist = list()
  328. for aId in condition['items'][b]:
  329. action = self.GetItem(aId)
  330. alist.append(action)
  331. conditionItem.SetItems(alist, branch = b)
  332. items = conditionItem.GetItems()
  333. for b in items.keys():
  334. for action in items[b]:
  335. action.SetBlock(conditionItem)
  336. # load comments
  337. for comment in gxmXml.comments:
  338. commentItem = ModelComment(parent = self,
  339. x = comment['pos'][0],
  340. y = comment['pos'][1],
  341. width = comment['size'][0],
  342. height = comment['size'][1],
  343. id = comment['id'],
  344. label = comment['text'])
  345. self.AddItem(commentItem, pos = commentItem.GetId()-1)
  346. def AddItem(self, newItem, pos = -1):
  347. """Add item to the list"""
  348. if pos != -1:
  349. self.items.insert(pos, newItem)
  350. else:
  351. self.items.append(newItem)
  352. # i = 1
  353. # for item in self.items:
  354. # item.SetId(i)
  355. # i += 1
  356. def IsValid(self):
  357. """Return True if model is valid"""
  358. if self.Validate():
  359. return False
  360. return True
  361. def Validate(self):
  362. """Validate model, return None if model is valid otherwise
  363. error string"""
  364. errList = list()
  365. variables = self.GetVariables().keys()
  366. pattern = re.compile(r'(.*)(%.+\s?)(.*)')
  367. for action in self.GetItems(objType = ModelAction):
  368. cmd = action.GetLog(string = False)
  369. task = GUI(show = None).ParseCommand(cmd = cmd)
  370. errList += map(lambda x: cmd[0] + ': ' + x, task.get_cmd_error())
  371. # check also variables
  372. for opt in cmd[1:]:
  373. if '=' not in opt:
  374. continue
  375. key, value = opt.split('=', 1)
  376. sval = pattern.search(value)
  377. if sval:
  378. var = sval.group(2).strip()[1:] # strip '%' from beginning
  379. found = False
  380. for v in variables:
  381. if var.startswith(v):
  382. found = True
  383. break
  384. if not found:
  385. report = True
  386. for item in filter(lambda x: isinstance(x, ModelLoop), action.GetBlock()):
  387. if var in item.GetLabel():
  388. report = False
  389. break
  390. if report:
  391. errList.append(cmd[0] + ": " + _("undefined variable '%s'") % var)
  392. ### TODO: check variables in file only optionally
  393. ### errList += self._substituteFile(action, checkOnly = True)
  394. return errList
  395. def _substituteFile(self, item, params = None, checkOnly = False):
  396. """Subsitute variables in command file inputs
  397. :param bool checkOnly: tuble - True to check variable, don't touch files
  398. :return: list of undefined variables
  399. """
  400. errList = list()
  401. self.fileInput = dict()
  402. # collect ascii inputs
  403. for p in item.GetParams()['params']:
  404. if p.get('element', '') == 'file' and \
  405. p.get('prompt', '') == 'input' and \
  406. p.get('age', '') == 'old':
  407. filename = p.get('value', p.get('default', ''))
  408. if filename and \
  409. mimetypes.guess_type(filename)[0] == 'text/plain':
  410. self.fileInput[filename] = None
  411. for finput in self.fileInput:
  412. # read lines
  413. fd = open(finput, "r")
  414. try:
  415. data = self.fileInput[finput] = fd.read()
  416. finally:
  417. fd.close()
  418. # substitute variables
  419. write = False
  420. variables = self.GetVariables()
  421. for variable in variables:
  422. pattern = re.compile('%' + variable)
  423. value = ''
  424. if params and 'variables' in params:
  425. for p in params['variables']['params']:
  426. if variable == p.get('name', ''):
  427. if p.get('type', 'string') == 'string':
  428. value = p.get('value', '')
  429. else:
  430. value = str(p.get('value', ''))
  431. break
  432. if not value:
  433. value = variables[variable].get('value', '')
  434. data = pattern.sub(value, data)
  435. if not checkOnly:
  436. write = True
  437. pattern = re.compile(r'(.*)(%.+\s?)(.*)')
  438. sval = pattern.search(data)
  439. if sval:
  440. var = sval.group(2).strip()[1:] # ignore '%'
  441. cmd = item.GetLog(string = False)[0]
  442. errList.append(cmd + ": " + _("undefined variable '%s'") % var)
  443. if not checkOnly:
  444. if write:
  445. fd = open(finput, "w")
  446. try:
  447. fd.write(data)
  448. finally:
  449. fd.close()
  450. else:
  451. self.fileInput[finput] = None
  452. return errList
  453. def OnPrepare(self, item, params):
  454. self._substituteFile(item, params, checkOnly = False)
  455. def RunAction(self, item, params, log, onDone, onPrepare = None, statusbar = None):
  456. """Run given action
  457. :param item: action item
  458. :param params: parameters dict
  459. :param log: logging window
  460. :param onDone: on-done method
  461. :param onPrepare: on-prepare method
  462. :param statusbar: wx.StatusBar instance or None
  463. """
  464. name = '({0}) {1}'.format(item.GetId(), item.GetLabel())
  465. if name in params:
  466. paramsOrig = item.GetParams(dcopy = True)
  467. item.MergeParams(params[name])
  468. if statusbar:
  469. statusbar.SetStatusText(_('Running model...'), 0)
  470. data = { 'item' : item,
  471. 'params' : copy.deepcopy(params) }
  472. log.RunCmd(command = item.GetLog(string = False, substitute = params),
  473. onDone = onDone, onPrepare = self.OnPrepare, userData = data)
  474. if name in params:
  475. item.SetParams(paramsOrig)
  476. def Run(self, log, onDone, parent = None):
  477. """Run model
  478. :param log: logging window (see gconsole.GConsole)
  479. :param onDone: on-done method
  480. :param parent: window for messages or None
  481. """
  482. if self.GetNumItems() < 1:
  483. GMessage(parent = parent,
  484. message = _('Model is empty. Nothing to run.'))
  485. return
  486. statusbar = None
  487. if isinstance(parent, wx.Frame):
  488. statusbar = parent.GetStatusBar()
  489. # validation
  490. if statusbar:
  491. statusbar.SetStatusText(_('Validating model...'), 0)
  492. errList = self.Validate()
  493. if statusbar:
  494. statusbar.SetStatusText('', 0)
  495. if errList:
  496. dlg = wx.MessageDialog(parent = parent,
  497. message = _('Model is not valid. Do you want to '
  498. 'run the model anyway?\n\n%s') % '\n'.join(errList),
  499. caption = _("Run model?"),
  500. style = wx.YES_NO | wx.NO_DEFAULT |
  501. wx.ICON_QUESTION | wx.CENTRE)
  502. ret = dlg.ShowModal()
  503. dlg.Destroy()
  504. if ret != wx.ID_YES:
  505. return
  506. # parametrization
  507. params = self.Parameterize()
  508. delInterData = False
  509. if params:
  510. dlg = ModelParamDialog(parent = parent,
  511. model = self,
  512. params = params)
  513. dlg.CenterOnParent()
  514. ret = dlg.ShowModal()
  515. if ret != wx.ID_OK:
  516. dlg.Destroy()
  517. return
  518. err = dlg.GetErrors()
  519. delInterData = dlg.DeleteIntermediateData()
  520. dlg.Destroy()
  521. if err:
  522. GError(parent = parent, message = unicode('\n'.join(err)))
  523. return
  524. err = list()
  525. for key, item in params.iteritems():
  526. for p in item['params']:
  527. if p.get('value', '') == '':
  528. err.append((key, p.get('name', ''), p.get('description', '')))
  529. if err:
  530. GError(parent = parent,
  531. message = _("Variables below not defined:") + \
  532. "\n\n" + unicode('\n'.join(map(lambda x: "%s: %s (%s)" % (x[0], x[1], x[2]), err))))
  533. return
  534. log.cmdThread.SetId(-1)
  535. for item in self.GetItems():
  536. if not item.IsEnabled():
  537. continue
  538. if isinstance(item, ModelAction):
  539. if item.GetBlockId():
  540. continue
  541. self.RunAction(item, params, log, onDone)
  542. elif isinstance(item, ModelLoop):
  543. cond = item.GetLabel()
  544. # substitute variables in condition
  545. variables = self.GetVariables()
  546. for variable in variables:
  547. pattern = re.compile('%' + variable)
  548. if pattern.search(cond):
  549. value = ''
  550. if params and 'variables' in params:
  551. for p in params['variables']['params']:
  552. if variable == p.get('name', ''):
  553. value = p.get('value', '')
  554. break
  555. if not value:
  556. value = variables[variable].get('value', '')
  557. if not value:
  558. continue
  559. vtype = variables[variable].get('type', 'string')
  560. if vtype == 'string':
  561. value = '"' + value + '"'
  562. cond = pattern.sub(value, cond)
  563. # split condition
  564. ### TODO: this part needs some better solution
  565. condVar, condText = map(lambda x: x.strip(), re.split('\s* in \s*', cond))
  566. pattern = re.compile('%' + condVar)
  567. ### for vars()[condVar] in eval(condText): ?
  568. vlist = list()
  569. if condText[0] == '`' and condText[-1] == '`':
  570. # run command
  571. cmd, dcmd = utils.CmdToTuple(condText[1:-1].split(' '))
  572. ret = RunCommand(cmd,
  573. read = True,
  574. **dcmd)
  575. if ret:
  576. vlist = ret.splitlines()
  577. else:
  578. vlist = eval(condText)
  579. if 'variables' not in params:
  580. params['variables'] = { 'params' : [] }
  581. varDict = { 'name' : condVar, 'value' : '' }
  582. params['variables']['params'].append(varDict)
  583. for var in vlist:
  584. for action in item.GetItems(self.GetItems()):
  585. if not action.IsEnabled():
  586. continue
  587. varDict['value'] = var
  588. self.RunAction(item = action, params = params,
  589. log = log, onDone = onDone)
  590. params['variables']['params'].remove(varDict)
  591. if delInterData:
  592. self.DeleteIntermediateData(log)
  593. # discard values
  594. if params:
  595. for item in params.itervalues():
  596. for p in item['params']:
  597. p['value'] = ''
  598. def DeleteIntermediateData(self, log):
  599. """Detele intermediate data"""
  600. rast, vect, rast3d, msg = self.GetIntermediateData()
  601. if rast:
  602. log.RunCmd(['g.remove', '-f', 'type=raster', 'name=%s' %','.join(rast)])
  603. if rast3d:
  604. log.RunCmd(['g.remove', '-f', 'type=raster_3d', 'name=%s' %','.join(rast3d)])
  605. if vect:
  606. log.RunCmd(['g.remove', '-f', 'type=vector', 'name=%s' %','.join(vect)])
  607. def GetIntermediateData(self):
  608. """Get info about intermediate data"""
  609. rast = list()
  610. rast3d = list()
  611. vect = list()
  612. for data in self.GetData():
  613. if not data.IsIntermediate():
  614. continue
  615. name = data.GetValue()
  616. prompt = data.GetPrompt()
  617. if prompt == 'raster':
  618. rast.append(name)
  619. elif prompt == 'vector':
  620. vect.append(name)
  621. elif prompt == 'raster_3d':
  622. rast3d.append(name)
  623. msg = ''
  624. if rast:
  625. msg += '\n\n%s: ' % _('Raster maps')
  626. msg += ', '.join(rast)
  627. if rast3d:
  628. msg += '\n\n%s: ' % _('3D raster maps')
  629. msg += ', '.join(rast3d)
  630. if vect:
  631. msg += '\n\n%s: ' % _('Vector maps')
  632. msg += ', '.join(vect)
  633. return rast, vect, rast3d, msg
  634. def Update(self):
  635. """Update model"""
  636. for item in self.items:
  637. item.Update()
  638. def IsParameterized(self):
  639. """Return True if model is parameterized"""
  640. if self.Parameterize():
  641. return True
  642. return False
  643. def Parameterize(self):
  644. """Return parameterized options"""
  645. result = dict()
  646. idx = 0
  647. if self.variables:
  648. params = list()
  649. result["variables"] = { 'flags' : list(),
  650. 'params' : params,
  651. 'idx' : idx }
  652. for name, values in self.variables.iteritems():
  653. gtype = values.get('type', 'string')
  654. if gtype in ('raster', 'vector', 'mapset', 'file', 'region', 'dir'):
  655. gisprompt = True
  656. prompt = gtype
  657. if gtype == 'raster':
  658. element = 'cell'
  659. else:
  660. element = gtype
  661. ptype = 'string'
  662. else:
  663. gisprompt = False
  664. prompt = None
  665. element = None
  666. ptype = gtype
  667. params.append({ 'gisprompt' : gisprompt,
  668. 'multiple' : False,
  669. 'description' : values.get('description', ''),
  670. 'guidependency' : '',
  671. 'default' : '',
  672. 'age' : None,
  673. 'required' : True,
  674. 'value' : values.get('value', ''),
  675. 'label' : '',
  676. 'guisection' : '',
  677. 'key_desc' : '',
  678. 'values' : list(),
  679. 'parameterized' : False,
  680. 'values_desc' : list(),
  681. 'prompt' : prompt,
  682. 'element' : element,
  683. 'type' : ptype,
  684. 'name' : name })
  685. idx += 1
  686. for action in self.GetItems(objType = ModelAction):
  687. if not action.IsEnabled():
  688. continue
  689. name = '({0}) {1}'.format(action.GetId(), action.GetLabel())
  690. params = action.GetParams()
  691. increment = False
  692. for f in params['flags']:
  693. if f.get('parameterized', False):
  694. if name not in result:
  695. increment = True
  696. result[name] = { 'flags' : list(),
  697. 'params': list(),
  698. 'idx' : idx }
  699. result[name]['flags'].append(f)
  700. for p in params['params']:
  701. if p.get('parameterized', False):
  702. if name not in result:
  703. increment = True
  704. result[name] = { 'flags' : list(),
  705. 'params': list(),
  706. 'idx' : idx }
  707. result[name]['params'].append(p)
  708. if increment:
  709. idx += 1
  710. self.variablesParams = result # record parameters
  711. return result
  712. class ModelObject(object):
  713. def __init__(self, id = -1, label = ''):
  714. self.id = id # internal id, should be not changed
  715. self.label = ''
  716. self.rels = list() # list of ModelRelations
  717. self.isEnabled = True
  718. self.inBlock = list() # list of related loops/conditions
  719. def __del__(self):
  720. pass
  721. def GetLabel(self):
  722. """Get label"""
  723. return self.label
  724. def SetLabel(self, label=''):
  725. """Set label"""
  726. self.label = label
  727. def GetId(self):
  728. """Get id"""
  729. return self.id
  730. def SetId(self, newId):
  731. """Set id"""
  732. if self.inBlock:
  733. for loop in self.inBlock:
  734. # update block item
  735. loop.UpdateItem(self.id, newId)
  736. self.id = newId
  737. def AddRelation(self, rel):
  738. """Record new relation
  739. """
  740. self.rels.append(rel)
  741. def GetRelations(self, fdir = None):
  742. """Get list of relations
  743. :param bool fdir: True for 'from'
  744. """
  745. if fdir is None:
  746. return self.rels
  747. result = list()
  748. for rel in self.rels:
  749. if fdir == 'from':
  750. if rel.GetFrom() == self:
  751. result.append(rel)
  752. else:
  753. if rel.GetTo() == self:
  754. result.append(rel)
  755. return result
  756. def IsEnabled(self):
  757. """Get True if action is enabled, otherwise False"""
  758. return self.isEnabled
  759. def Enable(self, enabled = True):
  760. """Enable/disable action"""
  761. self.isEnabled = enabled
  762. self.Update()
  763. def Update(self):
  764. pass
  765. def SetBlock(self, item):
  766. """Add object to the block (loop/condition)
  767. :param item: reference to ModelLoop or ModelCondition which
  768. defines loops/condition
  769. """
  770. if item not in self.inBlock:
  771. self.inBlock.append(item)
  772. def UnSetBlock(self, item):
  773. """Remove object from the block (loop/consition)
  774. :param item: reference to ModelLoop or ModelCondition which
  775. defines loops/codition
  776. """
  777. if item in self.inBlock:
  778. self.inBlock.remove(item)
  779. def GetBlock(self):
  780. """Get list of related ModelObject(s) which defines block
  781. (loop/condition)
  782. :return: list of ModelObjects
  783. """
  784. return self.inBlock
  785. def GetBlockId(self):
  786. """Get list of related ids which defines block
  787. :return: list of ids
  788. """
  789. ret = list()
  790. for mo in self.inBlock:
  791. ret.append(mo.GetId())
  792. return ret
  793. class ModelAction(ModelObject, ogl.DividedShape):
  794. """Action class (GRASS module)"""
  795. def __init__(self, parent, x, y, id = -1, cmd = None, task = None,
  796. width = None, height = None, label = None, comment = ''):
  797. ModelObject.__init__(self, id, label)
  798. self.parent = parent
  799. self.task = task
  800. self.comment = comment
  801. if not width:
  802. width = UserSettings.Get(group='modeler', key='action', subkey=('size', 'width'))
  803. if not height:
  804. height = UserSettings.Get(group='modeler', key='action', subkey=('size', 'height'))
  805. if cmd:
  806. self.task = GUI(show = None).ParseCommand(cmd = cmd)
  807. else:
  808. if task:
  809. self.task = task
  810. else:
  811. self.task = None
  812. self.propWin = None
  813. self.data = list() # list of connected data items
  814. self.isValid = False
  815. self.isParameterized = False
  816. if self.parent.GetCanvas():
  817. ogl.DividedShape.__init__(self, width, height)
  818. self.regionLabel = ogl.ShapeRegion()
  819. self.regionLabel.SetFormatMode(ogl.FORMAT_CENTRE_HORIZ | ogl.FORMAT_CENTRE_VERT)
  820. self.AddRegion(self.regionLabel)
  821. self.regionComment = None
  822. self.SetCanvas(self.parent)
  823. self.SetX(x)
  824. self.SetY(y)
  825. self._setPen()
  826. self._setBrush()
  827. self.SetLabel(label)
  828. if comment:
  829. self.SetComment(comment)
  830. self.SetRegionSizes()
  831. self.ReformatRegions()
  832. if self.task:
  833. self.SetValid(self.task.get_options())
  834. def _setBrush(self, running = False):
  835. """Set brush"""
  836. if running:
  837. color = UserSettings.Get(group='modeler', key='action',
  838. subkey=('color', 'running'))
  839. elif not self.isEnabled:
  840. color = UserSettings.Get(group='modeler', key='disabled',
  841. subkey='color')
  842. elif self.isValid:
  843. color = UserSettings.Get(group='modeler', key='action',
  844. subkey=('color', 'valid'))
  845. else:
  846. color = UserSettings.Get(group='modeler', key='action',
  847. subkey=('color', 'invalid'))
  848. wxColor = wx.Colour(color[0], color[1], color[2])
  849. self.SetBrush(wx.Brush(wxColor))
  850. def _setPen(self):
  851. """Set pen"""
  852. if self.isParameterized:
  853. width = int(UserSettings.Get(group='modeler', key='action',
  854. subkey=('width', 'parameterized')))
  855. else:
  856. width = int(UserSettings.Get(group='modeler', key='action',
  857. subkey=('width', 'default')))
  858. if self.isEnabled:
  859. style = wx.SOLID
  860. else:
  861. style = wx.DOT
  862. pen = wx.Pen(wx.BLACK, width, style)
  863. self.SetPen(pen)
  864. def ReformatRegions(self):
  865. rnum = 0
  866. canvas = self.parent.GetCanvas()
  867. dc = wx.ClientDC(canvas) # used for measuring
  868. for region in self.GetRegions():
  869. text = region.GetText()
  870. self.FormatText(dc, text, rnum)
  871. rnum += 1
  872. def OnSizingEndDragLeft(self, pt, x, y, keys, attch):
  873. ogl.DividedShape.OnSizingEndDragLeft(self, pt, x, y, keys, attch)
  874. self.SetRegionSizes()
  875. self.ReformatRegions()
  876. self.GetCanvas().Refresh()
  877. def SetLabel(self, label=None):
  878. """Set label
  879. :param label: if None use command string instead
  880. """
  881. if label:
  882. self.label = label
  883. elif self.label:
  884. label = self.label
  885. else:
  886. try:
  887. label = self.task.get_cmd(ignoreErrors = True)[0]
  888. except:
  889. label = _("unknown")
  890. idx = self.GetId()
  891. self.regionLabel.SetText('(%d) %s' % (idx, label))
  892. self.SetRegionSizes()
  893. self.ReformatRegions()
  894. def SetComment(self, comment):
  895. """Set comment"""
  896. self.comment = comment
  897. if self.regionComment is None:
  898. self.regionComment = ogl.ShapeRegion()
  899. self.regionComment.SetFormatMode(ogl.FORMAT_CENTRE_HORIZ)
  900. font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
  901. font.SetStyle(wx.ITALIC)
  902. self.regionComment.SetFont(font)
  903. ### clear doesn't work
  904. ### self.regionComment.ClearText()
  905. self.regionComment.SetText(comment)
  906. self.ClearRegions()
  907. self.AddRegion(self.regionLabel)
  908. self.regionLabel.SetProportions(0.0, 1.0)
  909. if self.comment:
  910. self.AddRegion(self.regionComment)
  911. self.regionLabel.SetProportions(0.0, 0.4)
  912. self.SetRegionSizes()
  913. self.ReformatRegions()
  914. def GetComment(self):
  915. """Get comment"""
  916. return self.comment
  917. def SetProperties(self, params, propwin):
  918. """Record properties dialog"""
  919. self.task.params = params['params']
  920. self.task.flags = params['flags']
  921. self.propWin = propwin
  922. def GetPropDialog(self):
  923. """Get properties dialog"""
  924. return self.propWin
  925. def GetLog(self, string = True, substitute = None):
  926. """Get logging info
  927. :param string: True to get cmd as a string otherwise a list
  928. :param substitute: dictionary of parameter to substitute or None
  929. """
  930. cmd = self.task.get_cmd(ignoreErrors = True, ignoreRequired = True,
  931. ignoreDefault = False)
  932. # substitute variables
  933. if substitute:
  934. variables = []
  935. if 'variables' in substitute:
  936. for p in substitute['variables']['params']:
  937. variables.append(p.get('name', ''))
  938. else:
  939. variables = self.parent.GetVariables()
  940. # order variables by length
  941. for variable in sorted(variables, key=len, reverse=True):
  942. pattern= re.compile('%' + variable)
  943. value = ''
  944. if substitute and 'variables' in substitute:
  945. for p in substitute['variables']['params']:
  946. if variable == p.get('name', ''):
  947. if p.get('type', 'string') == 'string':
  948. value = p.get('value', '')
  949. else:
  950. value = str(p.get('value', ''))
  951. break
  952. if not value:
  953. value = variables[variable].get('value', '')
  954. if not value:
  955. continue
  956. for idx in range(len(cmd)):
  957. if pattern.search(cmd[idx]):
  958. cmd[idx] = pattern.sub(value, cmd[idx])
  959. idx += 1
  960. if string:
  961. if cmd is None:
  962. return ''
  963. else:
  964. return ' '.join(cmd)
  965. return cmd
  966. def GetLabel(self):
  967. """Get name"""
  968. if self.label:
  969. return self.label
  970. cmd = self.task.get_cmd(ignoreErrors = True)
  971. if cmd and len(cmd) > 0:
  972. return cmd[0]
  973. return _('unknown')
  974. def GetParams(self, dcopy = False):
  975. """Get dictionary of parameters"""
  976. if dcopy:
  977. return copy.deepcopy(self.task.get_options())
  978. return self.task.get_options()
  979. def GetTask(self):
  980. """Get grassTask instance"""
  981. return self.task
  982. def SetParams(self, params):
  983. """Set dictionary of parameters"""
  984. self.task.params = params['params']
  985. self.task.flags = params['flags']
  986. def MergeParams(self, params):
  987. """Merge dictionary of parameters"""
  988. if 'flags' in params:
  989. for f in params['flags']:
  990. self.task.set_flag(f['name'],
  991. f.get('value', False))
  992. if 'params' in params:
  993. for p in params['params']:
  994. self.task.set_param(p['name'],
  995. p.get('value', ''))
  996. def SetValid(self, options):
  997. """Set validity for action
  998. :param options: dictionary with flags and params (gtask)
  999. """
  1000. self.isValid = True
  1001. for f in options['flags']:
  1002. if f.get('parameterized', False):
  1003. self.isParameterized = True
  1004. break
  1005. for p in options['params']:
  1006. if self.isValid and p.get('required', False) and \
  1007. p.get('value', '') == '' and \
  1008. p.get('default', '') == '':
  1009. self.isValid = False
  1010. if not self.isParameterized and p.get('parameterized', False):
  1011. self.isParameterized = True
  1012. if self.parent.GetCanvas():
  1013. self._setBrush()
  1014. self._setPen()
  1015. def IsValid(self):
  1016. """Check validity (all required parameters set)"""
  1017. return self.isValid
  1018. def IsParameterized(self):
  1019. """Check if action is parameterized"""
  1020. return self.isParameterized
  1021. def GetParameterizedParams(self):
  1022. """Return parameterized flags and options"""
  1023. param = { 'flags': [], 'params' : [] }
  1024. options = self.GetParams()
  1025. for f in options['flags']:
  1026. if f.get('parameterized', False):
  1027. param['flags'].append(f)
  1028. for p in options['params']:
  1029. if p.get('parameterized', False):
  1030. param['params'].append(p)
  1031. return param
  1032. def FindData(self, name):
  1033. """Find data item by name"""
  1034. for rel in self.GetRelations():
  1035. data = rel.GetData()
  1036. if name == rel.GetLabel() and name in data.GetLabel():
  1037. return data
  1038. return None
  1039. def Update(self, running = False):
  1040. """Update action"""
  1041. if running:
  1042. self._setBrush(running = True)
  1043. else:
  1044. self._setBrush()
  1045. self._setPen()
  1046. def OnDraw(self, dc):
  1047. """Draw action in canvas"""
  1048. self._setBrush()
  1049. self._setPen()
  1050. ogl.RectangleShape.Recentre(self, dc) # re-center text
  1051. ogl.RectangleShape.OnDraw(self, dc)
  1052. class ModelData(ModelObject, ogl.EllipseShape):
  1053. def __init__(self, parent, x, y, value = '', prompt = '', width = None, height = None):
  1054. """Data item class
  1055. :param parent: window parent
  1056. :param x, y: position of the shape
  1057. :param fname, tname: list of parameter names from / to
  1058. :param value: value
  1059. :param prompt: type of GIS element
  1060. :param width, height: dimension of the shape
  1061. """
  1062. ModelObject.__init__(self)
  1063. self.parent = parent
  1064. self.value = value
  1065. self.prompt = prompt
  1066. self.intermediate = False
  1067. self.propWin = None
  1068. if not width:
  1069. width = UserSettings.Get(group='modeler', key='data', subkey=('size', 'width'))
  1070. if not height:
  1071. height = UserSettings.Get(group='modeler', key='data', subkey=('size', 'height'))
  1072. if self.parent.GetCanvas():
  1073. ogl.EllipseShape.__init__(self, width, height)
  1074. self.SetCanvas(self.parent)
  1075. self.SetX(x)
  1076. self.SetY(y)
  1077. self._setPen()
  1078. self._setBrush()
  1079. self.SetLabel()
  1080. def IsIntermediate(self):
  1081. """Checks if data item is intermediate"""
  1082. return self.intermediate
  1083. def SetIntermediate(self, im):
  1084. """Set intermediate flag"""
  1085. self.intermediate = im
  1086. def OnDraw(self, dc):
  1087. self._setPen()
  1088. ogl.EllipseShape.OnDraw(self, dc)
  1089. def GetLog(self, string = True):
  1090. """Get logging info"""
  1091. name = list()
  1092. for rel in self.GetRelations():
  1093. name.append(rel.GetLabel())
  1094. if name:
  1095. return '/'.join(name) + '=' + self.value + ' (' + self.prompt + ')'
  1096. else:
  1097. return self.value + ' (' + self.prompt + ')'
  1098. def GetLabel(self):
  1099. """Get list of names"""
  1100. name = list()
  1101. for rel in self.GetRelations():
  1102. name.append(rel.GetLabel())
  1103. return name
  1104. def GetPrompt(self):
  1105. """Get prompt"""
  1106. return self.prompt
  1107. def SetPrompt(self, prompt):
  1108. """Set prompt
  1109. :param prompt:
  1110. """
  1111. self.prompt = prompt
  1112. def GetValue(self):
  1113. """Get value"""
  1114. return self.value
  1115. def SetValue(self, value):
  1116. """Set value
  1117. :param value:
  1118. """
  1119. self.value = value
  1120. self.SetLabel()
  1121. for direction in ('from', 'to'):
  1122. for rel in self.GetRelations(direction):
  1123. if direction == 'from':
  1124. action = rel.GetTo()
  1125. else:
  1126. action = rel.GetFrom()
  1127. task = GUI(show = None).ParseCommand(cmd = action.GetLog(string = False))
  1128. task.set_param(rel.GetLabel(), self.value)
  1129. action.MergeParams(task.get_options())
  1130. def GetPropDialog(self):
  1131. """Get properties dialog"""
  1132. return self.propWin
  1133. def SetPropDialog(self, win):
  1134. """Get properties dialog"""
  1135. self.propWin = win
  1136. def _setBrush(self):
  1137. """Set brush"""
  1138. if self.prompt == 'raster':
  1139. color = UserSettings.Get(group = 'modeler', key = 'data',
  1140. subkey = ('color', 'raster'))
  1141. elif self.prompt == 'raster_3d':
  1142. color = UserSettings.Get(group = 'modeler', key = 'data',
  1143. subkey = ('color', 'raster3d'))
  1144. elif self.prompt == 'vector':
  1145. color = UserSettings.Get(group = 'modeler', key = 'data',
  1146. subkey = ('color', 'vector'))
  1147. elif self.prompt == 'dbtable':
  1148. color = UserSettings.Get(group = 'modeler', key = 'data',
  1149. subkey = ('color', 'dbtable'))
  1150. else:
  1151. color = UserSettings.Get(group = 'modeler', key = 'action',
  1152. subkey = ('color', 'invalid'))
  1153. wxColor = wx.Colour(color[0], color[1], color[2])
  1154. self.SetBrush(wx.Brush(wxColor))
  1155. def _setPen(self):
  1156. """Set pen"""
  1157. isParameterized = False
  1158. for rel in self.GetRelations('from'):
  1159. if rel.GetTo().IsParameterized():
  1160. isParameterized = True
  1161. break
  1162. if not isParameterized:
  1163. for rel in self.GetRelations('to'):
  1164. if rel.GetFrom().IsParameterized():
  1165. isParameterized = True
  1166. break
  1167. if isParameterized:
  1168. width = int(UserSettings.Get(group = 'modeler', key = 'action',
  1169. subkey = ('width', 'parameterized')))
  1170. else:
  1171. width = int(UserSettings.Get(group = 'modeler', key = 'action',
  1172. subkey = ('width', 'default')))
  1173. if self.intermediate:
  1174. style = wx.DOT
  1175. else:
  1176. style = wx.SOLID
  1177. pen = wx.Pen(wx.BLACK, width, style)
  1178. self.SetPen(pen)
  1179. def SetLabel(self):
  1180. """Update text"""
  1181. self.ClearText()
  1182. name = []
  1183. for rel in self.GetRelations():
  1184. name.append(rel.GetLabel())
  1185. self.AddText('/'.join(name))
  1186. if self.value:
  1187. self.AddText(self.value)
  1188. else:
  1189. self.AddText(_('<not defined>'))
  1190. def Update(self):
  1191. """Update action"""
  1192. self._setBrush()
  1193. self._setPen()
  1194. self.SetLabel()
  1195. class ModelRelation(ogl.LineShape):
  1196. """Data - action relation"""
  1197. def __init__(self, parent, fromShape, toShape, param = ''):
  1198. self.fromShape = fromShape
  1199. self.toShape = toShape
  1200. self.param = param
  1201. self.parent = parent
  1202. self._points = None
  1203. if self.parent.GetCanvas():
  1204. ogl.LineShape.__init__(self)
  1205. def __del__(self):
  1206. if self in self.fromShape.rels:
  1207. self.fromShape.rels.remove(self)
  1208. if self in self.toShape.rels:
  1209. self.toShape.rels.remove(self)
  1210. def GetFrom(self):
  1211. """Get id of 'from' shape"""
  1212. return self.fromShape
  1213. def GetTo(self):
  1214. """Get id of 'to' shape"""
  1215. return self.toShape
  1216. def GetData(self):
  1217. """Get related ModelData instance
  1218. :return: ModelData instance
  1219. :return: None if not found
  1220. """
  1221. if isinstance(self.fromShape, ModelData):
  1222. return self.fromShape
  1223. elif isinstance(self.toShape, ModelData):
  1224. return self.toShape
  1225. return None
  1226. def GetLabel(self):
  1227. """Get parameter name"""
  1228. return self.param
  1229. def ResetShapes(self):
  1230. """Reset related objects"""
  1231. self.fromShape.ResetControlPoints()
  1232. self.toShape.ResetControlPoints()
  1233. self.ResetControlPoints()
  1234. def SetControlPoints(self, points):
  1235. """Set control points"""
  1236. self._points = points
  1237. def GetControlPoints(self):
  1238. """Get list of control points"""
  1239. return self._points
  1240. def _setPen(self):
  1241. """Set pen"""
  1242. pen = wx.Pen(wx.BLACK, 1, wx.SOLID)
  1243. self.SetPen(pen)
  1244. def OnDraw(self, dc):
  1245. """Draw relation"""
  1246. self._setPen()
  1247. ogl.LineShape.OnDraw(self, dc)
  1248. def SetName(self, param):
  1249. self.param = param
  1250. class ModelItem(ModelObject):
  1251. def __init__(self, parent, x, y, id = -1, width = None, height = None, label = '', items = []):
  1252. """Abstract class for loops and conditions"""
  1253. ModelObject.__init__(self, id, label)
  1254. self.parent = parent
  1255. def _setPen(self):
  1256. """Set pen"""
  1257. if self.isEnabled:
  1258. style = wx.SOLID
  1259. else:
  1260. style = wx.DOT
  1261. pen = wx.Pen(wx.BLACK, 1, style)
  1262. self.SetPen(pen)
  1263. def SetId(self, id):
  1264. """Set loop id"""
  1265. self.id = id
  1266. def SetLabel(self, label=''):
  1267. """Set loop text (condition)"""
  1268. if label:
  1269. self.label = label
  1270. self.ClearText()
  1271. self.AddText('(' + str(self.id) + ') ' + self.label)
  1272. def GetLog(self):
  1273. """Get log info"""
  1274. if self.label:
  1275. return _("Condition: ") + self.label
  1276. else:
  1277. return _("Condition: not defined")
  1278. def AddRelation(self, rel):
  1279. """Record relation"""
  1280. self.rels.append(rel)
  1281. def Clear(self):
  1282. """Clear object, remove rels"""
  1283. self.rels = list()
  1284. class ModelLoop(ModelItem, ogl.RectangleShape):
  1285. def __init__(self, parent, x, y, id=-1, idx=-1, width = None, height = None, label = '', items = []):
  1286. """Defines a loop"""
  1287. ModelItem.__init__(self, parent, x, y, id, width, height, label, items)
  1288. self.itemIds = list() # unordered
  1289. if not width:
  1290. width = UserSettings.Get(group='modeler', key='loop', subkey=('size', 'width'))
  1291. if not height:
  1292. height = UserSettings.Get(group='modeler', key='loop', subkey=('size', 'height'))
  1293. if self.parent.GetCanvas():
  1294. ogl.RectangleShape.__init__(self, width, height)
  1295. self.SetCanvas(self.parent)
  1296. self.SetX(x)
  1297. self.SetY(y)
  1298. self._setPen()
  1299. self._setBrush()
  1300. self.SetCornerRadius(100)
  1301. self.SetLabel(label)
  1302. def _setBrush(self):
  1303. """Set brush"""
  1304. if not self.isEnabled:
  1305. color = UserSettings.Get(group='modeler', key='disabled',
  1306. subkey='color')
  1307. else:
  1308. color = UserSettings.Get(group='modeler', key='loop',
  1309. subkey=('color', 'valid'))
  1310. wxColor = wx.Colour(color[0], color[1], color[2])
  1311. self.SetBrush(wx.Brush(wxColor))
  1312. def Enable(self, enabled = True):
  1313. """Enable/disable action"""
  1314. for idx in self.itemIds:
  1315. item = self.parent.FindAction(idx)
  1316. if item:
  1317. item.Enable(enabled)
  1318. ModelObject.Enable(self, enabled)
  1319. self.Update()
  1320. def Update(self):
  1321. self._setPen()
  1322. self._setBrush()
  1323. def GetItems(self, items):
  1324. """Get sorted items by id"""
  1325. result = list()
  1326. for item in items:
  1327. if item.GetId() in self.itemIds:
  1328. result.append(item)
  1329. return result
  1330. def SetItems(self, items):
  1331. """Set items (id)"""
  1332. self.itemIds = items
  1333. def UpdateItem(self, oldId, newId):
  1334. """Update item in the list"""
  1335. idx = self.itemIds.index(oldId)
  1336. if idx != -1:
  1337. self.itemIds[idx] = newId
  1338. def OnDraw(self, dc):
  1339. """Draw loop in canvas"""
  1340. self._setBrush()
  1341. ogl.RectangleShape.Recentre(self, dc) # re-center text
  1342. ogl.RectangleShape.OnDraw(self, dc)
  1343. class ModelCondition(ModelItem, ogl.PolygonShape):
  1344. def __init__(self, parent, x, y, id = -1, width = None, height = None, label = '',
  1345. items = { 'if' : [], 'else' : [] }):
  1346. """Defines a if-else condition"""
  1347. ModelItem.__init__(self, parent, x, y, id, width, height, label, items)
  1348. self.itemIds = {'if' : [], 'else': []}
  1349. if not width:
  1350. self.width = UserSettings.Get(group='modeler', key='if-else', subkey=('size', 'width'))
  1351. else:
  1352. self.width = width
  1353. if not height:
  1354. self.height = UserSettings.Get(group='modeler', key='if-else', subkey=('size', 'height'))
  1355. else:
  1356. self.height = height
  1357. if self.parent.GetCanvas():
  1358. ogl.PolygonShape.__init__(self)
  1359. points = [(0, - self.height / 2),
  1360. (self.width / 2, 0),
  1361. (0, self.height / 2),
  1362. (- self.width / 2, 0)]
  1363. self.Create(points)
  1364. self.SetCanvas(self.parent)
  1365. self.SetX(x)
  1366. self.SetY(y)
  1367. self.SetPen(wx.BLACK_PEN)
  1368. if label:
  1369. self.AddText('(' + str(self.id) + ') ' + label)
  1370. else:
  1371. self.AddText('(' + str(self.id) + ')')
  1372. def GetLabel(self):
  1373. """Get name"""
  1374. return _("if-else")
  1375. def GetWidth(self):
  1376. """Get object width"""
  1377. return self.width
  1378. def GetHeight(self):
  1379. """Get object height"""
  1380. return self.height
  1381. def GetItems(self, items):
  1382. """Get sorted items by id"""
  1383. result = {'if' : [], 'else': []}
  1384. for item in items:
  1385. if item.GetId() in self.itemIds['if']:
  1386. result['if'].append(item)
  1387. elif item.GetId() in self.itemIds['else']:
  1388. result['else'].append(item)
  1389. return result
  1390. def SetItems(self, items, branch = 'if'):
  1391. """Set items (id)
  1392. :param items: list of items
  1393. :param branch: 'if' / 'else'
  1394. """
  1395. if branch in ['if', 'else']:
  1396. self.itemIds[branch] = items
  1397. class ModelComment(ModelObject, ogl.RectangleShape):
  1398. def __init__(self, parent, x, y, id = -1, width = None, height = None, label = ''):
  1399. """Defines a model comment"""
  1400. ModelObject.__init__(self, id, label)
  1401. if not width:
  1402. width = UserSettings.Get(group='modeler', key='comment', subkey=('size', 'width'))
  1403. if not height:
  1404. height = UserSettings.Get(group='modeler', key='comment', subkey=('size', 'height'))
  1405. if parent.GetCanvas():
  1406. ogl.RectangleShape.__init__(self, width, height)
  1407. self.SetCanvas(parent)
  1408. self.SetX(x)
  1409. self.SetY(y)
  1410. font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
  1411. font.SetStyle(wx.ITALIC)
  1412. self.SetFont(font)
  1413. self._setPen()
  1414. self._setBrush()
  1415. self.SetLabel(label)
  1416. def _setBrush(self, running = False):
  1417. """Set brush"""
  1418. color = UserSettings.Get(group='modeler', key='comment',
  1419. subkey='color')
  1420. wxColor = wx.Colour(color[0], color[1], color[2])
  1421. self.SetBrush(wx.Brush(wxColor))
  1422. def _setPen(self):
  1423. """Set pen"""
  1424. pen = wx.Pen(wx.BLACK, 1, wx.DOT)
  1425. self.SetPen(pen)
  1426. def SetLabel(self, label=None):
  1427. """Set label
  1428. :param label: if None use command string instead
  1429. """
  1430. if label:
  1431. self.label = label
  1432. elif self.label:
  1433. label = self.label
  1434. else:
  1435. label = ''
  1436. idx = self.GetId()
  1437. self.ClearText()
  1438. self.AddText('(%d) %s' % (idx, label))
  1439. def GetComment(self):
  1440. return self.GetLabel()
  1441. def SetComment(self, comment):
  1442. self.SetLabel(comment)
  1443. self.GetCanvas().Refresh()
  1444. class ProcessModelFile:
  1445. """Process GRASS model file (gxm)"""
  1446. def __init__(self, tree):
  1447. """A ElementTree handler for the GXM XML file, as defined in
  1448. grass-gxm.dtd.
  1449. """
  1450. self.tree = tree
  1451. self.root = self.tree.getroot()
  1452. # check if input is a valid GXM file
  1453. if self.root is None or self.root.tag != 'gxm':
  1454. if self.root is not None:
  1455. tagName = self.root.tag
  1456. else:
  1457. tabName = _("empty")
  1458. raise GException(_("Details: unsupported tag name '{}'.").format(tagName))
  1459. # list of actions, data
  1460. self.properties = dict()
  1461. self.variables = dict()
  1462. self.actions = list()
  1463. self.data = list()
  1464. self.loops = list()
  1465. self.conditions = list()
  1466. self.comments = list()
  1467. self._processWindow()
  1468. self._processProperties()
  1469. self._processVariables()
  1470. self._processItems()
  1471. self._processData()
  1472. def _filterValue(self, value):
  1473. """Filter value
  1474. :param value:
  1475. """
  1476. value = value.replace('&lt;', '<')
  1477. value = value.replace('&gt;', '>')
  1478. return value
  1479. def _getNodeText(self, node, tag, default = ''):
  1480. """Get node text"""
  1481. p = node.find(tag)
  1482. if p is not None:
  1483. if p.text:
  1484. return utils.normalize_whitespace(p.text)
  1485. else:
  1486. return ''
  1487. return default
  1488. def _processWindow(self):
  1489. """Process window properties"""
  1490. node = self.root.find('window')
  1491. if node is None:
  1492. self.pos = self.size = None
  1493. return
  1494. self.pos, self.size = self._getDim(node)
  1495. def _processProperties(self):
  1496. """Process model properties"""
  1497. node = self.root.find('properties')
  1498. if node is None:
  1499. return
  1500. for key in ('name', 'description', 'author'):
  1501. self._processProperty(node, key)
  1502. for f in node.findall('flag'):
  1503. name = f.get('name', '')
  1504. if name == 'overwrite':
  1505. self.properties['overwrite'] = True
  1506. def _processProperty(self, pnode, name):
  1507. """Process given property"""
  1508. node = pnode.find(name)
  1509. if node is not None:
  1510. self.properties[name] = node.text
  1511. else:
  1512. self.properties[name] = ''
  1513. def _processVariables(self):
  1514. """Process model variables"""
  1515. vnode = self.root.find('variables')
  1516. if vnode is None:
  1517. return
  1518. for node in vnode.findall('variable'):
  1519. name = node.get('name', '')
  1520. if not name:
  1521. continue # should not happen
  1522. self.variables[name] = { 'type' : node.get('type', 'string') }
  1523. for key in ('description', 'value'):
  1524. self._processVariable(node, name, key)
  1525. def _processVariable(self, pnode, name, key):
  1526. """Process given variable"""
  1527. node = pnode.find(key)
  1528. if node is not None:
  1529. if node.text:
  1530. self.variables[name][key] = node.text
  1531. def _processItems(self):
  1532. """Process model items (actions, loops, conditions)"""
  1533. self._processActions()
  1534. self._processLoops()
  1535. self._processConditions()
  1536. self._processComments()
  1537. def _processActions(self):
  1538. """Process model file"""
  1539. for action in self.root.findall('action'):
  1540. pos, size = self._getDim(action)
  1541. disabled = False
  1542. task = action.find('task')
  1543. if task is not None:
  1544. if task.find('disabled') is not None:
  1545. disabled = True
  1546. task = self._processTask(task)
  1547. else:
  1548. task = None
  1549. aId = int(action.get('id', -1))
  1550. label = action.get('name')
  1551. comment = action.find('comment')
  1552. if comment is not None:
  1553. commentString = comment.text
  1554. else:
  1555. commentString = ''
  1556. self.actions.append({ 'pos' : pos,
  1557. 'size' : size,
  1558. 'task' : task,
  1559. 'id' : aId,
  1560. 'disabled' : disabled,
  1561. 'label' : label,
  1562. 'comment' : commentString})
  1563. def _getDim(self, node):
  1564. """Get position and size of shape"""
  1565. pos = size = None
  1566. posAttr = node.get('pos', None)
  1567. if posAttr:
  1568. posVal = map(int, posAttr.split(','))
  1569. try:
  1570. pos = (posVal[0], posVal[1])
  1571. except:
  1572. pos = None
  1573. sizeAttr = node.get('size', None)
  1574. if sizeAttr:
  1575. sizeVal = map(int, sizeAttr.split(','))
  1576. try:
  1577. size = (sizeVal[0], sizeVal[1])
  1578. except:
  1579. size = None
  1580. return pos, size
  1581. def _processData(self):
  1582. """Process model file"""
  1583. for data in self.root.findall('data'):
  1584. pos, size = self._getDim(data)
  1585. param = data.find('data-parameter')
  1586. prompt = value = None
  1587. if param is not None:
  1588. prompt = param.get('prompt', None)
  1589. value = self._filterValue(self._getNodeText(param, 'value'))
  1590. if data.find('intermediate') is None:
  1591. intermediate = False
  1592. else:
  1593. intermediate = True
  1594. rels = list()
  1595. for rel in data.findall('relation'):
  1596. defrel = { 'id' : int(rel.get('id', -1)),
  1597. 'dir' : rel.get('dir', 'to'),
  1598. 'name' : rel.get('name', '') }
  1599. points = list()
  1600. for point in rel.findall('point'):
  1601. x = self._filterValue(self._getNodeText(point, 'x'))
  1602. y = self._filterValue(self._getNodeText(point, 'y'))
  1603. points.append((float(x), float(y)))
  1604. defrel['points'] = points
  1605. rels.append(defrel)
  1606. self.data.append({ 'pos' : pos,
  1607. 'size': size,
  1608. 'prompt' : prompt,
  1609. 'value' : value,
  1610. 'intermediate' : intermediate,
  1611. 'rels' : rels })
  1612. def _processTask(self, node):
  1613. """Process task
  1614. :return: grassTask instance
  1615. :return: None on error
  1616. """
  1617. cmd = list()
  1618. parameterized = list()
  1619. name = node.get('name', None)
  1620. if not name:
  1621. return None
  1622. cmd.append(name)
  1623. # flags
  1624. for f in node.findall('flag'):
  1625. flag = f.get('name', '')
  1626. if f.get('parameterized', '0') == '1':
  1627. parameterized.append(('flag', flag))
  1628. if f.get('value', '1') == '0':
  1629. continue
  1630. if len(flag) > 1:
  1631. cmd.append('--' + flag)
  1632. else:
  1633. cmd.append('-' + flag)
  1634. # parameters
  1635. for p in node.findall('parameter'):
  1636. name = p.get('name', '')
  1637. if p.find('parameterized') is not None:
  1638. parameterized.append(('param', name))
  1639. cmd.append('%s=%s' % (name,
  1640. self._filterValue(self._getNodeText(p, 'value'))))
  1641. task, err = GUI(show = None, checkError = True).ParseCommand(cmd = cmd)
  1642. if err:
  1643. GWarning(os.linesep.join(err))
  1644. for opt, name in parameterized:
  1645. if opt == 'flag':
  1646. task.set_flag(name, True, element = 'parameterized')
  1647. else:
  1648. task.set_param(name, True, element = 'parameterized')
  1649. return task
  1650. def _processLoops(self):
  1651. """Process model loops"""
  1652. for node in self.root.findall('loop'):
  1653. pos, size = self._getDim(node)
  1654. text = self._filterValue(self._getNodeText(node, 'condition')).strip()
  1655. aid = list()
  1656. for anode in node.findall('item'):
  1657. try:
  1658. aid.append(int(anode.text))
  1659. except ValueError:
  1660. pass
  1661. self.loops.append({ 'pos' : pos,
  1662. 'size' : size,
  1663. 'text' : text,
  1664. 'id' : int(node.get('id', -1)),
  1665. 'items' : aid })
  1666. def _processConditions(self):
  1667. """Process model conditions"""
  1668. for node in self.root.findall('if-else'):
  1669. pos, size = self._getDim(node)
  1670. text = self._filterValue(self._getNodeText(node, 'condition')).strip()
  1671. aid = { 'if' : list(),
  1672. 'else' : list() }
  1673. for b in aid.keys():
  1674. bnode = node.find(b)
  1675. if bnode is None:
  1676. continue
  1677. for anode in bnode.findall('item'):
  1678. try:
  1679. aid[b].append(int(anode.text))
  1680. except ValueError:
  1681. pass
  1682. self.conditions.append({ 'pos' : pos,
  1683. 'size' : size,
  1684. 'text' : text,
  1685. 'id' : int(node.get('id', -1)),
  1686. 'items' : aid })
  1687. def _processComments(self):
  1688. """Process model comments"""
  1689. for node in self.root.findall('comment'):
  1690. pos, size = self._getDim(node)
  1691. text = self._filterValue(node.text)
  1692. self.comments.append({ 'pos' : pos,
  1693. 'size' : size,
  1694. 'text' : text,
  1695. 'id' : int(node.get('id', -1)),
  1696. 'text' : text })
  1697. class WriteModelFile:
  1698. """Generic class for writing model file"""
  1699. def __init__(self, fd, model):
  1700. self.fd = fd
  1701. self.model = model
  1702. self.properties = model.GetProperties()
  1703. self.variables = model.GetVariables()
  1704. self.items = model.GetItems()
  1705. self.indent = 0
  1706. self._header()
  1707. self._window()
  1708. self._properties()
  1709. self._variables()
  1710. self._items()
  1711. dataList = list()
  1712. for action in model.GetItems(objType = ModelAction):
  1713. for rel in action.GetRelations():
  1714. dataItem = rel.GetData()
  1715. if dataItem not in dataList:
  1716. dataList.append(dataItem)
  1717. self._data(dataList)
  1718. self._footer()
  1719. def _filterValue(self, value):
  1720. """Escapes value to be stored in XML.
  1721. :param value: string to be escaped as XML
  1722. :return: a XML-valid string
  1723. """
  1724. value = saxutils.escape(value)
  1725. return value
  1726. def _header(self):
  1727. """Write header"""
  1728. self.fd.write('<?xml version="1.0" encoding="%s"?>\n' % GetDefaultEncoding(forceUTF8 = True))
  1729. self.fd.write('<!DOCTYPE gxm SYSTEM "grass-gxm.dtd">\n')
  1730. self.fd.write('%s<gxm>\n' % (' ' * self.indent))
  1731. self.indent += 4
  1732. def _footer(self):
  1733. """Write footer"""
  1734. self.indent -= 4
  1735. self.fd.write('%s</gxm>\n' % (' ' * self.indent))
  1736. def _window(self):
  1737. """Write window properties"""
  1738. canvas = self.model.GetCanvas()
  1739. if canvas is None:
  1740. return
  1741. win = canvas.parent
  1742. pos = win.GetPosition()
  1743. size = win.GetSize()
  1744. self.fd.write('%s<window pos="%d,%d" size="%d,%d" />\n' % \
  1745. (' ' * self.indent, pos[0], pos[1], size[0], size[1]))
  1746. def _properties(self):
  1747. """Write model properties"""
  1748. self.fd.write('%s<properties>\n' % (' ' * self.indent))
  1749. self.indent += 4
  1750. if self.properties['name']:
  1751. self.fd.write('%s<name>%s</name>\n' % (' ' * self.indent, EncodeString(self.properties['name'])))
  1752. if self.properties['description']:
  1753. self.fd.write('%s<description>%s</description>\n' % (' ' * self.indent,
  1754. EncodeString(self.properties['description'])))
  1755. if self.properties['author']:
  1756. self.fd.write('%s<author>%s</author>\n' % (' ' * self.indent,
  1757. EncodeString(self.properties['author'])))
  1758. if 'overwrite' in self.properties and \
  1759. self.properties['overwrite']:
  1760. self.fd.write('%s<flag name="overwrite" />\n' % (' ' * self.indent))
  1761. self.indent -= 4
  1762. self.fd.write('%s</properties>\n' % (' ' * self.indent))
  1763. def _variables(self):
  1764. """Write model variables"""
  1765. if not self.variables:
  1766. return
  1767. self.fd.write('%s<variables>\n' % (' ' * self.indent))
  1768. self.indent += 4
  1769. for name, values in self.variables.iteritems():
  1770. self.fd.write('%s<variable name="%s" type="%s">\n' % \
  1771. (' ' * self.indent, EncodeString(name), values['type']))
  1772. self.indent += 4
  1773. if 'value' in values:
  1774. self.fd.write('%s<value>%s</value>\n' % \
  1775. (' ' * self.indent, EncodeString(values['value'])))
  1776. if 'description' in values:
  1777. self.fd.write('%s<description>%s</description>\n' % \
  1778. (' ' * self.indent, EncodeString(values['description'])))
  1779. self.indent -= 4
  1780. self.fd.write('%s</variable>\n' % (' ' * self.indent))
  1781. self.indent -= 4
  1782. self.fd.write('%s</variables>\n' % (' ' * self.indent))
  1783. def _items(self):
  1784. """Write actions/loops/conditions"""
  1785. for item in self.items:
  1786. if isinstance(item, ModelAction):
  1787. self._action(item)
  1788. elif isinstance(item, ModelLoop):
  1789. self._loop(item)
  1790. elif isinstance(item, ModelCondition):
  1791. self._condition(item)
  1792. elif isinstance(item, ModelComment):
  1793. self._comment(item)
  1794. def _action(self, action):
  1795. """Write actions"""
  1796. self.fd.write('%s<action id="%d" name="%s" pos="%d,%d" size="%d,%d">\n' % \
  1797. (' ' * self.indent, action.GetId(), EncodeString(action.GetLabel()), action.GetX(), action.GetY(),
  1798. action.GetWidth(), action.GetHeight()))
  1799. self.indent += 4
  1800. comment = action.GetComment()
  1801. if comment:
  1802. self.fd.write('%s<comment>%s</comment>\n' % (' ' * self.indent, EncodeString(comment)))
  1803. self.fd.write('%s<task name="%s">\n' % (' ' * self.indent, action.GetLog(string = False)[0]))
  1804. self.indent += 4
  1805. if not action.IsEnabled():
  1806. self.fd.write('%s<disabled />\n' % (' ' * self.indent))
  1807. for key, val in action.GetParams().iteritems():
  1808. if key == 'flags':
  1809. for f in val:
  1810. if f.get('value', False) or f.get('parameterized', False):
  1811. if f.get('parameterized', False):
  1812. if f.get('value', False) == False:
  1813. self.fd.write('%s<flag name="%s" value="0" parameterized="1" />\n' %
  1814. (' ' * self.indent, f.get('name', '')))
  1815. else:
  1816. self.fd.write('%s<flag name="%s" parameterized="1" />\n' %
  1817. (' ' * self.indent, f.get('name', '')))
  1818. else:
  1819. self.fd.write('%s<flag name="%s" />\n' %
  1820. (' ' * self.indent, f.get('name', '')))
  1821. else: # parameter
  1822. for p in val:
  1823. if not p.get('value', '') and not p.get('parameterized', False):
  1824. continue
  1825. self.fd.write('%s<parameter name="%s">\n' %
  1826. (' ' * self.indent, p.get('name', '')))
  1827. self.indent += 4
  1828. if p.get('parameterized', False):
  1829. self.fd.write('%s<parameterized />\n' % (' ' * self.indent))
  1830. self.fd.write('%s<value>%s</value>\n' %
  1831. (' ' * self.indent, self._filterValue(p.get('value', ''))))
  1832. self.indent -= 4
  1833. self.fd.write('%s</parameter>\n' % (' ' * self.indent))
  1834. self.indent -= 4
  1835. self.fd.write('%s</task>\n' % (' ' * self.indent))
  1836. self.indent -= 4
  1837. self.fd.write('%s</action>\n' % (' ' * self.indent))
  1838. def _data(self, dataList):
  1839. """Write data"""
  1840. for data in dataList:
  1841. self.fd.write('%s<data pos="%d,%d" size="%d,%d">\n' % \
  1842. (' ' * self.indent, data.GetX(), data.GetY(),
  1843. data.GetWidth(), data.GetHeight()))
  1844. self.indent += 4
  1845. self.fd.write('%s<data-parameter prompt="%s">\n' % \
  1846. (' ' * self.indent, data.GetPrompt()))
  1847. self.indent += 4
  1848. self.fd.write('%s<value>%s</value>\n' %
  1849. (' ' * self.indent, self._filterValue(data.GetValue())))
  1850. self.indent -= 4
  1851. self.fd.write('%s</data-parameter>\n' % (' ' * self.indent))
  1852. if data.IsIntermediate():
  1853. self.fd.write('%s<intermediate />\n' % (' ' * self.indent))
  1854. # relations
  1855. for ft in ('from', 'to'):
  1856. for rel in data.GetRelations(ft):
  1857. if ft == 'from':
  1858. aid = rel.GetTo().GetId()
  1859. else:
  1860. aid = rel.GetFrom().GetId()
  1861. self.fd.write('%s<relation dir="%s" id="%d" name="%s">\n' % \
  1862. (' ' * self.indent, ft, aid, rel.GetLabel()))
  1863. self.indent += 4
  1864. for point in rel.GetLineControlPoints()[1:-1]:
  1865. self.fd.write('%s<point>\n' % (' ' * self.indent))
  1866. self.indent += 4
  1867. x, y = point.Get()
  1868. self.fd.write('%s<x>%d</x>\n' % (' ' * self.indent, int(x)))
  1869. self.fd.write('%s<y>%d</y>\n' % (' ' * self.indent, int(y)))
  1870. self.indent -= 4
  1871. self.fd.write('%s</point>\n' % (' ' * self.indent))
  1872. self.indent -= 4
  1873. self.fd.write('%s</relation>\n' % (' ' * self.indent))
  1874. self.indent -= 4
  1875. self.fd.write('%s</data>\n' % (' ' * self.indent))
  1876. def _loop(self, loop):
  1877. """Write loops"""
  1878. self.fd.write('%s<loop id="%d" pos="%d,%d" size="%d,%d">\n' % \
  1879. (' ' * self.indent, loop.GetId(), loop.GetX(), loop.GetY(),
  1880. loop.GetWidth(), loop.GetHeight()))
  1881. self.indent += 4
  1882. cond = loop.GetLabel()
  1883. if cond:
  1884. self.fd.write('%s<condition>%s</condition>\n' %
  1885. (' ' * self.indent, self._filterValue(cond)))
  1886. for item in loop.GetItems(self.model.GetItems(objType=ModelAction)):
  1887. self.fd.write('%s<item>%d</item>\n' %
  1888. (' ' * self.indent, item.GetId()))
  1889. self.indent -= 4
  1890. self.fd.write('%s</loop>\n' % (' ' * self.indent))
  1891. def _condition(self, condition):
  1892. """Write conditions"""
  1893. bbox = condition.GetBoundingBoxMin()
  1894. self.fd.write('%s<if-else id="%d" pos="%d,%d" size="%d,%d">\n' % \
  1895. (' ' * self.indent, condition.GetId(), condition.GetX(), condition.GetY(),
  1896. bbox[0], bbox[1]))
  1897. text = condition.GetLabel()
  1898. self.indent += 4
  1899. if text:
  1900. self.fd.write('%s<condition>%s</condition>\n' %
  1901. (' ' * self.indent, self._filterValue(text)))
  1902. items = condition.GetItems()
  1903. for b in items.keys():
  1904. if len(items[b]) < 1:
  1905. continue
  1906. self.fd.write('%s<%s>\n' % (' ' * self.indent, b))
  1907. self.indent += 4
  1908. for item in items[b]:
  1909. self.fd.write('%s<item>%d</item>\n' %
  1910. (' ' * self.indent, item.GetId()))
  1911. self.indent -= 4
  1912. self.fd.write('%s</%s>\n' % (' ' * self.indent, b))
  1913. self.indent -= 4
  1914. self.fd.write('%s</if-else>\n' % (' ' * self.indent))
  1915. def _comment(self, comment):
  1916. """Write comment"""
  1917. self.fd.write('%s<comment id="%d" pos="%d,%d" size="%d,%d">%s</comment>\n' % \
  1918. (' ' * self.indent, comment.GetId(), comment.GetX(), comment.GetY(),
  1919. comment.GetWidth(), comment.GetHeight(), EncodeString(comment.GetLabel())))
  1920. class WritePythonFile:
  1921. def __init__(self, fd, model):
  1922. """Class for exporting model to Python script
  1923. :param fd: file descriptor
  1924. """
  1925. self.fd = fd
  1926. self.model = model
  1927. self.indent = 4
  1928. self._writePython()
  1929. def _getStandardizedOption(self, string):
  1930. if string == 'raster':
  1931. return 'G_OPT_R_MAP'
  1932. elif string == 'vector':
  1933. return 'G_OPT_V_MAP'
  1934. elif string == 'mapset':
  1935. return 'G_OPT_M_MAPSET'
  1936. elif string == 'file':
  1937. return 'G_OPT_F_INPUT'
  1938. elif string == 'dir':
  1939. return 'G_OPT_M_DIR'
  1940. elif string == 'region':
  1941. return 'G_OPT_M_REGION'
  1942. return ''
  1943. def _writePython(self):
  1944. """Write model to file"""
  1945. properties = self.model.GetProperties()
  1946. # header
  1947. self.fd.write(
  1948. r"""#!/usr/bin/env python
  1949. #
  1950. #%s
  1951. #
  1952. # MODULE: %s
  1953. #
  1954. # AUTHOR(S): %s
  1955. #
  1956. # PURPOSE: %s
  1957. #
  1958. # DATE: %s
  1959. #
  1960. #%s
  1961. """% ('#' * 77,
  1962. EncodeString(properties['name']),
  1963. EncodeString(properties['author']),
  1964. EncodeString('\n# '.join(properties['description'].splitlines())),
  1965. time.asctime(),
  1966. '#' * 77))
  1967. # UI
  1968. self.fd.write(
  1969. r"""
  1970. #%%module
  1971. #%% description: %s
  1972. #%%end
  1973. """% (EncodeString(' '.join(properties['description'].splitlines()))))
  1974. variables = self.model.GetVariables()
  1975. for key, data in variables.iteritems():
  1976. otype = self._getStandardizedOption(data['type'])
  1977. self.fd.write(
  1978. r"""
  1979. #%%option %s
  1980. #%% key: %s
  1981. #%% description: %s
  1982. #%% required: yes
  1983. """% (otype, key, data['description']))
  1984. if 'value' in data:
  1985. self.fd.write("#%% answer: %s\n" % data['value'])
  1986. self.fd.write("#% end\n")
  1987. # import modules
  1988. self.fd.write(
  1989. r"""
  1990. import sys
  1991. import os
  1992. import atexit
  1993. from grass.script import parser, run_command
  1994. """)
  1995. # cleanup()
  1996. rast, vect, rast3d, msg = self.model.GetIntermediateData()
  1997. self.fd.write(
  1998. r"""
  1999. def cleanup():
  2000. """)
  2001. if rast:
  2002. self.fd.write(
  2003. r""" run_command('g.remove', flags='f', type='raster',
  2004. name=%s)
  2005. """% ','.join(map(lambda x: "'" + x + "'", rast)))
  2006. if vect:
  2007. self.fd.write(
  2008. r""" run_command('g.remove', flags='f', type='vector',
  2009. name=%s)
  2010. """% ','.join(map(lambda x: "'" + x + "'", vect)))
  2011. if rast3d:
  2012. self.fd.write(
  2013. r""" run_command('g.remove', flags='f', type='raster_3d',
  2014. name=%s)
  2015. """% ','.join(map(lambda x: "'" + x + "'", rast3d)))
  2016. if not rast and not vect and not rast3d:
  2017. self.fd.write(' pass\n')
  2018. self.fd.write("\ndef main():\n")
  2019. for item in self.model.GetItems():
  2020. self._writePythonItem(item, variables = self.model.GetVariables())
  2021. self.fd.write("\n return 0\n")
  2022. self.fd.write(
  2023. r"""
  2024. if __name__ == "__main__":
  2025. options, flags = parser()
  2026. atexit.register(cleanup)
  2027. sys.exit(main())
  2028. """)
  2029. def _writePythonItem(self, item, ignoreBlock = True, variables = {}):
  2030. """Write model object to Python file"""
  2031. if isinstance(item, ModelAction):
  2032. if ignoreBlock and item.GetBlockId(): # ignore items in loops of conditions
  2033. return
  2034. self._writePythonAction(item, variables = variables)
  2035. elif isinstance(item, ModelLoop) or isinstance(item, ModelCondition):
  2036. # substitute condition
  2037. cond = item.GetLabel()
  2038. for variable in self.model.GetVariables():
  2039. pattern = re.compile('%' + variable)
  2040. if pattern.search(cond):
  2041. value = variables[variable].get('value', '')
  2042. if variables[variable].get('type', 'string') == 'string':
  2043. value = '"' + value + '"'
  2044. cond = pattern.sub(value, cond)
  2045. if isinstance(item, ModelLoop):
  2046. condVar, condText = map(lambda x: x.strip(), re.split('\s* in \s*', cond))
  2047. cond = "%sfor %s in " % (' ' * self.indent, condVar)
  2048. if condText[0] == '`' and condText[-1] == '`':
  2049. task = GUI(show = None).ParseCommand(cmd = utils.split(condText[1:-1]))
  2050. cond += "grass.read_command("
  2051. cond += self._getPythonActionCmd(task, len(cond), variables = [condVar]) + ".splitlines()"
  2052. else:
  2053. cond += condText
  2054. self.fd.write('%s:\n' % cond)
  2055. self.indent += 4
  2056. variablesLoop = variables.copy()
  2057. variablesLoop[condVar] = None
  2058. for action in item.GetItems(self.model.GetItems(objType=ModelAction)):
  2059. self._writePythonItem(action, ignoreBlock = False, variables = variablesLoop)
  2060. self.indent -= 4
  2061. if isinstance(item, ModelCondition):
  2062. self.fd.write('%sif %s:\n' % (' ' * self.indent, cond))
  2063. self.indent += 4
  2064. condItems = item.GetItems()
  2065. for action in condItems['if']:
  2066. self._writePythonItem(action, ignoreBlock = False)
  2067. if condItems['else']:
  2068. self.indent -= 4
  2069. self.fd.write('%selse:\n' % (' ' * self.indent))
  2070. self.indent += 4
  2071. for action in condItems['else']:
  2072. self._writePythonItem(action, ignoreBlock = False)
  2073. self.indent += 4
  2074. self.fd.write('\n')
  2075. if isinstance(item, ModelComment):
  2076. self._writePythonComment(item)
  2077. def _writePythonAction(self, item, variables = {}):
  2078. """Write model action to Python file"""
  2079. task = GUI(show = None).ParseCommand(cmd = item.GetLog(string = False))
  2080. strcmd = "%srun_command(" % (' ' * self.indent)
  2081. self.fd.write(strcmd + self._getPythonActionCmd(task, len(strcmd), variables) + '\n')
  2082. def _getPythonActionCmd(self, task, cmdIndent, variables = {}):
  2083. opts = task.get_options()
  2084. ret = ''
  2085. flags = ''
  2086. params = list()
  2087. for f in opts['flags']:
  2088. if f.get('value', False):
  2089. name = f.get('name', '')
  2090. if len(name) > 1:
  2091. params.append('%s = True' % name)
  2092. else:
  2093. flags += name
  2094. for p in opts['params']:
  2095. name = p.get('name', None)
  2096. value = p.get('value', None)
  2097. if name and value:
  2098. ptype = p.get('type', 'string')
  2099. foundVar = False
  2100. for var in sorted(variables, key=len, reverse=True):
  2101. data = variables[var]
  2102. if '%' + var in value:
  2103. value = self._substituteVariable(value, var, data)
  2104. foundVar = True
  2105. if foundVar or ptype != 'string':
  2106. params.append("%s = %s" % (name, value))
  2107. else:
  2108. params.append('%s = "%s"' % (name, value))
  2109. ret += '"%s"' % task.get_name()
  2110. if flags:
  2111. ret += ",\n%sflags = '%s'" % (' ' * cmdIndent, flags)
  2112. if len(params) > 0:
  2113. ret += ",\n"
  2114. for opt in params[:-1]:
  2115. ret += "%s%s,\n" % (' ' * cmdIndent, opt)
  2116. ret += "%s%s)" % (' ' * cmdIndent, params[-1])
  2117. else:
  2118. ret += ")"
  2119. return ret
  2120. def _writePythonComment(self, item):
  2121. """Write model comment to Python file"""
  2122. for line in item.GetLabel().splitlines():
  2123. self.fd.write('#' + line + '\n')
  2124. def _substituteVariable(self, string, variable, data):
  2125. """Substitute variable in the string
  2126. :param string: string to be modified
  2127. :param variable: variable to be substituted
  2128. :param data: data related to the variable
  2129. :return: modified string
  2130. """
  2131. result = ''
  2132. ss = re.split("\w*(%"+variable+")w*", string)
  2133. if not ss[0] and not ss[-1]:
  2134. if data:
  2135. return "options['%s']" % variable
  2136. else:
  2137. return variable
  2138. for s in ss:
  2139. if not s or s == '"':
  2140. continue
  2141. if s == '%' + variable:
  2142. if data:
  2143. result += "+options['%s']+" % variable
  2144. else:
  2145. result += '+%s+' % variable
  2146. else:
  2147. result += '"' + s
  2148. if not s.endswith(']'): # options
  2149. result += '"'
  2150. return result.strip('+')
  2151. class ModelParamDialog(wx.Dialog):
  2152. def __init__(self, parent, model, params, id = wx.ID_ANY, title = _("Model parameters"),
  2153. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER, **kwargs):
  2154. """Model parameters dialog
  2155. """
  2156. self.parent = parent
  2157. self._model = model
  2158. self.params = params
  2159. self.tasks = list() # list of tasks/pages
  2160. wx.Dialog.__init__(self, parent = parent, id = id, title = title, style = style, **kwargs)
  2161. self.notebook = GNotebook(parent = self,
  2162. style = globalvar.FNPageDStyle)
  2163. panel = self._createPages()
  2164. wx.CallAfter(self.notebook.SetSelection, 0)
  2165. # intermediate data?
  2166. self.interData = wx.CheckBox(parent = self, label = _("Delete intermediate data when finish"))
  2167. self.interData.SetValue(True)
  2168. rast, vect, rast3d, msg = self._model.GetIntermediateData()
  2169. if not rast and not vect and not rast3d:
  2170. self.interData.Hide()
  2171. self.btnCancel = wx.Button(parent = self, id = wx.ID_CANCEL)
  2172. self.btnRun = wx.Button(parent = self, id = wx.ID_OK,
  2173. label = _("&Run"))
  2174. self.btnRun.SetDefault()
  2175. self._layout()
  2176. size = self.GetBestSize()
  2177. self.SetMinSize(size)
  2178. self.SetSize((size.width, size.height +
  2179. panel.constrained_size[1] -
  2180. panel.panelMinHeight))
  2181. def _layout(self):
  2182. btnSizer = wx.StdDialogButtonSizer()
  2183. btnSizer.AddButton(self.btnCancel)
  2184. btnSizer.AddButton(self.btnRun)
  2185. btnSizer.Realize()
  2186. mainSizer = wx.BoxSizer(wx.VERTICAL)
  2187. mainSizer.Add(item = self.notebook, proportion = 1,
  2188. flag = wx.EXPAND)
  2189. if self.interData.IsShown():
  2190. mainSizer.Add(item = self.interData, proportion = 0,
  2191. flag = wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border = 5)
  2192. mainSizer.Add(item = wx.StaticLine(parent = self, id = wx.ID_ANY,
  2193. style = wx.LI_HORIZONTAL),
  2194. proportion = 0,
  2195. flag = wx.EXPAND | wx.LEFT | wx.RIGHT, border = 5)
  2196. mainSizer.Add(item = btnSizer, proportion = 0,
  2197. flag = wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border = 5)
  2198. self.SetSizer(mainSizer)
  2199. mainSizer.Fit(self)
  2200. def _createPages(self):
  2201. """Create for each parameterized module its own page"""
  2202. nameOrdered = [''] * len(self.params.keys())
  2203. for name, params in self.params.iteritems():
  2204. nameOrdered[params['idx']] = name
  2205. for name in nameOrdered:
  2206. params = self.params[name]
  2207. panel = self._createPage(name, params)
  2208. if name == 'variables':
  2209. name = _('Variables')
  2210. self.notebook.AddPage(page = panel, text = name)
  2211. return panel
  2212. def _createPage(self, name, params):
  2213. """Define notebook page"""
  2214. if name in globalvar.grassCmd:
  2215. task = gtask.grassTask(name)
  2216. else:
  2217. task = gtask.grassTask()
  2218. task.flags = params['flags']
  2219. task.params = params['params']
  2220. panel = CmdPanel(parent = self, id = wx.ID_ANY, task = task,
  2221. giface = GraphicalModelerGrassInterface(self._model))
  2222. self.tasks.append(task)
  2223. return panel
  2224. def GetErrors(self):
  2225. """Check for errors, get list of messages"""
  2226. errList = list()
  2227. for task in self.tasks:
  2228. errList += task.get_cmd_error()
  2229. return errList
  2230. def DeleteIntermediateData(self):
  2231. """Check if to detele intermediate data"""
  2232. if self.interData.IsShown() and self.interData.IsChecked():
  2233. return True
  2234. return False