model.py 92 KB

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