gmodeler.py 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909
  1. """!
  2. @package gmodeler.py
  3. @brief Graphical modeler to create edit, and manage models
  4. Classes:
  5. - Model
  6. - ModelFrame
  7. - ModelCanvas
  8. - ModelAction
  9. - ModelSearchDialog
  10. - ModelData
  11. - ModelDataDialog
  12. - ModelRelation
  13. - ProcessModelFile
  14. - WriteModelFile
  15. - PreferencesDialog
  16. (C) 2010 by the GRASS Development Team
  17. This program is free software under the GNU General Public License
  18. (>=v2). Read the file COPYING that comes with GRASS for details.
  19. @author Martin Landa <landa.martin gmail.com>
  20. """
  21. import os
  22. import sys
  23. import shlex
  24. import time
  25. import traceback
  26. import getpass
  27. import stat
  28. import textwrap
  29. try:
  30. import xml.etree.ElementTree as etree
  31. except ImportError:
  32. import elementtree.ElementTree as etree # Python <= 2.4
  33. import globalvar
  34. if not os.getenv("GRASS_WXBUNDLED"):
  35. globalvar.CheckForWx()
  36. import wx
  37. import wx.lib.ogl as ogl
  38. import wx.lib.flatnotebook as FN
  39. import wx.lib.colourselect as csel
  40. import menu
  41. import menudata
  42. import toolbars
  43. import menuform
  44. import prompt
  45. import utils
  46. import goutput
  47. import gselect
  48. from debug import Debug
  49. from gcmd import GMessage, GError
  50. from gdialogs import ElementDialog, GetImageHandlers
  51. from preferences import PreferencesBaseDialog, globalSettings as UserSettings
  52. from grass.script import core as grass
  53. class Model(object):
  54. """!Class representing the model"""
  55. def __init__(self, canvas = None):
  56. self.actions = list() # list of recorded actions
  57. self.data = list() # list of recorded data items
  58. self.canvas = canvas
  59. def GetCanvas(self):
  60. """!Get canvas or None"""
  61. return self.canvas
  62. def GetActions(self):
  63. """!Return list of actions"""
  64. return self.actions
  65. def GetData(self):
  66. """!Return list of data"""
  67. return self.data
  68. def Reset(self):
  69. """!Reset model"""
  70. self.actions = list()
  71. self.data = list()
  72. def AddAction(self, item):
  73. """!Add action to the model"""
  74. self.actions.append(item)
  75. def AddData(self, item):
  76. """!Add data to the model"""
  77. self.data.append(item)
  78. def FindAction(self, id):
  79. """!Find action by id"""
  80. for action in self.actions:
  81. if action.GetId() == id:
  82. return action
  83. return None
  84. def FindData(self, value, prompt):
  85. """!Find data by value, and prompt"""
  86. for data in self.data:
  87. if data.GetValue() == value and \
  88. data.GetPrompt() == prompt:
  89. return data
  90. return None
  91. def LoadModel(self, filename):
  92. """!Load model definition stored in GRASS Model XML file (gxm)
  93. @todo Validate against DTD
  94. Raise exception on error.
  95. """
  96. dtdFilename = os.path.join(globalvar.ETCWXDIR, "xml", "grass-gxm.dtd")
  97. # parse workspace file
  98. try:
  99. gxmXml = ProcessModelFile(etree.parse(filename))
  100. except StandardError, e:
  101. raise GError(e)
  102. # load model.GetActions()
  103. for action in gxmXml.actions:
  104. actionItem = ModelAction(parent = self,
  105. x = action['pos'][0],
  106. y = action['pos'][1],
  107. width = action['size'][0],
  108. height = action['size'][1],
  109. cmd = action['cmd'])
  110. actionItem.SetId(action['id'])
  111. self.actions.append(actionItem)
  112. task = menuform.GUI().ParseCommand(cmd = actionItem.GetLog(string = False),
  113. show = None)
  114. valid = True
  115. for p in task.get_options()['params']:
  116. if p.get('value', '') == '' and \
  117. p.get('default', '') == '':
  118. valid = False
  119. break
  120. actionItem.SetValid(valid)
  121. # load data & connections
  122. for data in gxmXml.data:
  123. dataItem = ModelData(parent = self,
  124. x = data['pos'][0],
  125. y = data['pos'][1],
  126. width = data['size'][0],
  127. height = data['size'][1],
  128. name = data['name'],
  129. prompt = data['prompt'],
  130. value = data['value'])
  131. dataItem.SetIntermediate(data['intermediate'])
  132. for idx in range(len(data['id'])):
  133. actionItem = self.FindAction(data['id'][idx])
  134. if data['from'][idx] is True:
  135. dataItem.AddAction(actionItem, direction = 'from')
  136. elif data['from'][idx] is False:
  137. dataItem.AddAction(actionItem, direction = 'to')
  138. self.data.append(dataItem)
  139. actionItem.AddData(dataItem)
  140. def IsValid(self):
  141. """Return True if model is valid"""
  142. if self.Validate():
  143. return False
  144. return True
  145. def Validate(self):
  146. """!Validate model, return None if model is valid otherwise
  147. error string"""
  148. errList = list()
  149. for action in self.actions:
  150. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  151. show = None)
  152. errList += task.getCmdError()
  153. return errList
  154. def Run(self, log, onDone):
  155. """!Run model"""
  156. for action in self.actions:
  157. log.RunCmd(command = action.GetLog(string = False),
  158. onDone = onDone)
  159. def DeleteIntermediateData(self, log):
  160. """!Detele intermediate data"""
  161. rast, vect, rast3d, msg = self.GetIntermediateData()
  162. if rast:
  163. log.RunCmd(['g.remove', 'rast=%s' %','.join(rast)])
  164. if rast3d:
  165. log.RunCmd(['g.remove', 'rast3d=%s' %','.join(rast3d)])
  166. if vect:
  167. log.RunCmd(['g.remove', 'vect=%s' %','.join(vect)])
  168. def GetIntermediateData(self):
  169. """!Get info about intermediate data"""
  170. rast = list()
  171. rast3d = list()
  172. vect = list()
  173. for data in self.data:
  174. if not data.IsIntermediate():
  175. continue
  176. name = data.GetValue()
  177. prompt = data.GetPrompt()
  178. if prompt == 'raster':
  179. rast.append(name)
  180. elif prompt == 'vector':
  181. vect.append(name)
  182. elif prompt == 'rast3d':
  183. rast3d.append(name)
  184. msg = ''
  185. if rast:
  186. msg += '\n\n%s: ' % _('Raster maps')
  187. msg += ', '.join(rast)
  188. if rast3d:
  189. msg += '\n\n%s: ' % _('3D raster maps')
  190. msg += ', '.join(rast3d)
  191. if vect:
  192. msg += '\n\n%s: ' % _('Vector maps')
  193. msg += ', '.join(vect)
  194. return rast, vect, rast3d, msg
  195. def Update(self):
  196. """!Update model"""
  197. for action in self.actions:
  198. action.Update()
  199. class ModelFrame(wx.Frame):
  200. def __init__(self, parent, id = wx.ID_ANY, title = _("Graphical modeler (under development)"), **kwargs):
  201. """!Graphical modeler main window
  202. @param parent parent window
  203. @param id window id
  204. @param title window title
  205. @param kwargs wx.Frames' arguments
  206. """
  207. self.parent = parent
  208. self.searchDialog = None # module search dialog
  209. self.baseTitle = title
  210. self.modelFile = None # loaded model
  211. self.modelChanged = False
  212. self.cursors = {
  213. "default" : wx.StockCursor(wx.CURSOR_ARROW),
  214. "cross" : wx.StockCursor(wx.CURSOR_CROSS),
  215. }
  216. wx.Frame.__init__(self, parent = parent, id = id, title = title, **kwargs)
  217. self.SetName("Modeler")
  218. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  219. self.menubar = menu.Menu(parent = self, data = menudata.ModelerData())
  220. self.SetMenuBar(self.menubar)
  221. self.toolbar = toolbars.ModelToolbar(parent = self)
  222. self.SetToolBar(self.toolbar)
  223. self.statusbar = self.CreateStatusBar(number = 1)
  224. self.notebook = FN.FlatNotebook(parent = self, id = wx.ID_ANY,
  225. style = FN.FNB_FANCY_TABS | FN.FNB_BOTTOM |
  226. FN.FNB_NO_NAV_BUTTONS | FN.FNB_NO_X_BUTTON)
  227. self.canvas = ModelCanvas(self)
  228. self.canvas.SetBackgroundColour(wx.WHITE)
  229. self.canvas.SetCursor(self.cursors["default"])
  230. self.model = Model(self.canvas)
  231. self.goutput = goutput.GMConsole(parent = self, pageid = 1)
  232. self.modelPage = self.notebook.AddPage(self.canvas, text=_('Model'))
  233. self.commandPage = self.notebook.AddPage(self.goutput, text=_('Command output'))
  234. wx.CallAfter(self.notebook.SetSelection, 0)
  235. self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
  236. self._layout()
  237. self.SetMinSize((350, 200))
  238. self.SetSize((640, 480))
  239. # fix goutput's pane size
  240. if self.goutput:
  241. self.goutput.SetSashPosition(int(self.GetSize()[1] * .75))
  242. def _layout(self):
  243. """!Do layout"""
  244. sizer = wx.BoxSizer(wx.VERTICAL)
  245. sizer.Add(item = self.notebook, proportion = 1,
  246. flag = wx.EXPAND)
  247. self.SetAutoLayout(True)
  248. self.SetSizer(sizer)
  249. sizer.Fit(self)
  250. self.Layout()
  251. def _addEvent(self, item):
  252. """!Add event to item"""
  253. evthandler = ModelEvtHandler(self.statusbar,
  254. self)
  255. evthandler.SetShape(item)
  256. evthandler.SetPreviousHandler(item.GetEventHandler())
  257. item.SetEventHandler(evthandler)
  258. def GetCanvas(self):
  259. """!Get canvas"""
  260. return self.canvas
  261. def GetModel(self):
  262. """!Get model"""
  263. return self.model
  264. def ModelChanged(self):
  265. """!Update window title"""
  266. if not self.modelChanged:
  267. self.modelChanged = True
  268. if self.modelFile:
  269. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile) + '*')
  270. def OnCloseWindow(self, event):
  271. """!Close window"""
  272. self.Destroy()
  273. def OnPreferences(self, event):
  274. """!Open preferences dialog"""
  275. dlg = PreferencesDialog(parent = self)
  276. dlg.CenterOnParent()
  277. dlg.ShowModal()
  278. self.canvas.Refresh()
  279. def OnModelProperties(self, event):
  280. """!Model properties dialog"""
  281. def OnDeleteData(self, event):
  282. """!Delete intermediate data"""
  283. rast, vect, rast3d, msg = self.model.GetIntermediateData()
  284. if not rast and not vect and not rast3d:
  285. GMessage(parent = self,
  286. message = _('Nothing to delete.'),
  287. msgType = 'info')
  288. return
  289. dlg = wx.MessageDialog(parent = self,
  290. message= _("Do you want to permanently delete data?%s" % msg),
  291. caption=_("Delete intermediate data?"),
  292. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  293. ret = dlg.ShowModal()
  294. if ret == wx.ID_YES:
  295. dlg.Destroy()
  296. if rast:
  297. self.goutput.RunCmd(['g.remove', 'rast=%s' %','.join(rast)])
  298. if rast3d:
  299. self.goutput.RunCmd(['g.remove', 'rast3d=%s' %','.join(rast3d)])
  300. if vect:
  301. self.goutput.RunCmd(['g.remove', 'vect=%s' %','.join(vect)])
  302. self.SetStatusText(_("%d maps deleted from current mapset") % \
  303. int(len(rast) + len(rast3d) + len(vect)))
  304. return
  305. dlg.Destroy()
  306. def OnModelNew(self, event):
  307. """!Create new model"""
  308. Debug.msg(4, "ModelFrame.OnModelNew():")
  309. # ask user to save current model
  310. if self.modelFile and self.modelChanged:
  311. self.OnModelSave()
  312. elif self.modelFile is None and \
  313. (len(self.model.GetActions()) > 0 or len(self.model.GetData()) > 0):
  314. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  315. "Do you want to store current settings "
  316. "to model file?"),
  317. caption=_("Create new model?"),
  318. style=wx.YES_NO | wx.YES_DEFAULT |
  319. wx.CANCEL | wx.ICON_QUESTION)
  320. ret = dlg.ShowModal()
  321. if ret == wx.ID_YES:
  322. self.OnModelSaveAs()
  323. elif ret == wx.ID_CANCEL:
  324. dlg.Destroy()
  325. return
  326. dlg.Destroy()
  327. # delete all items
  328. self.canvas.GetDiagram().DeleteAllShapes()
  329. self.model.Reset()
  330. self.canvas.Refresh()
  331. # no model file loaded
  332. self.modelFile = None
  333. self.modelChanged = False
  334. self.SetTitle(self.baseTitle)
  335. def OnModelOpen(self, event):
  336. """!Load model from file"""
  337. filename = ''
  338. dlg = wx.FileDialog(parent = self, message=_("Choose model file"),
  339. defaultDir = os.getcwd(),
  340. wildcard=_("GRASS Model File (*.gxm)|*.gxm"))
  341. if dlg.ShowModal() == wx.ID_OK:
  342. filename = dlg.GetPath()
  343. if not filename:
  344. return
  345. Debug.msg(4, "ModelFrame.OnModelOpen(): filename=%s" % filename)
  346. # close current model
  347. self.OnModelClose()
  348. self.LoadModelFile(filename)
  349. self.modelFile = filename
  350. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  351. self.SetStatusText(_('%d actions loaded into model') % len(self.model.GetActions()), 0)
  352. def OnModelSave(self, event = None):
  353. """!Save model to file"""
  354. if self.modelFile and self.modelChanged:
  355. dlg = wx.MessageDialog(self, message=_("Model file <%s> already exists. "
  356. "Do you want to overwrite this file?") % \
  357. self.modelFile,
  358. caption=_("Save model"),
  359. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  360. if dlg.ShowModal() == wx.ID_NO:
  361. dlg.Destroy()
  362. else:
  363. Debug.msg(4, "ModelFrame.OnModelSave(): filename=%s" % self.modelFile)
  364. self.WriteModelFile(self.modelFile)
  365. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  366. elif not self.modelFile:
  367. self.OnModelSaveAs(None)
  368. def OnModelSaveAs(self, event):
  369. """!Create model to file as"""
  370. filename = ''
  371. dlg = wx.FileDialog(parent = self,
  372. message = _("Choose file to save current model"),
  373. defaultDir = os.getcwd(),
  374. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  375. style=wx.FD_SAVE)
  376. if dlg.ShowModal() == wx.ID_OK:
  377. filename = dlg.GetPath()
  378. if not filename:
  379. return
  380. # check for extension
  381. if filename[-4:] != ".gxm":
  382. filename += ".gxm"
  383. if os.path.exists(filename):
  384. dlg = wx.MessageDialog(parent = self,
  385. message=_("Model file <%s> already exists. "
  386. "Do you want to overwrite this file?") % filename,
  387. caption=_("File already exists"),
  388. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  389. if dlg.ShowModal() != wx.ID_YES:
  390. dlg.Destroy()
  391. return
  392. Debug.msg(4, "GMFrame.OnModelSaveAs(): filename=%s" % filename)
  393. self.WriteModelFile(filename)
  394. self.modelFile = filename
  395. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  396. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  397. def OnModelClose(self, event = None):
  398. """!Close model file"""
  399. Debug.msg(4, "ModelFrame.OnModelClose(): file=%s" % self.modelFile)
  400. # ask user to save current model
  401. if self.modelFile and self.modelChanged:
  402. self.OnModelSave()
  403. elif self.modelFile is None and \
  404. (len(self.model.GetActions()) > 0 or len(self.model.GetData()) > 0):
  405. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  406. "Do you want to store current settings "
  407. "to model file?"),
  408. caption=_("Create new model?"),
  409. style=wx.YES_NO | wx.YES_DEFAULT |
  410. wx.CANCEL | wx.ICON_QUESTION)
  411. ret = dlg.ShowModal()
  412. if ret == wx.ID_YES:
  413. self.OnModelSaveAs()
  414. elif ret == wx.ID_CANCEL:
  415. dlg.Destroy()
  416. return
  417. dlg.Destroy()
  418. self.modelFile = None
  419. self.SetTitle(self.baseTitle)
  420. self.canvas.GetDiagram().DeleteAllShapes()
  421. self.model.Reset()
  422. self.canvas.Refresh()
  423. def OnRunModel(self, event):
  424. """!Run entire model"""
  425. if len(self.model.GetActions()) < 1:
  426. GMessage(parent = self,
  427. message = _('Model is empty. Nothing to run.'),
  428. msgType = 'info')
  429. return
  430. errList = self._validateModel()
  431. if errList:
  432. dlg = wx.MessageDialog(parent = self,
  433. message = _('Model is not valid. Do you want to '
  434. 'run the model anyway?\n\n%s') % '\n'.join(errList),
  435. caption=_("Run model?"),
  436. style = wx.YES_NO | wx.NO_DEFAULT |
  437. wx.ICON_QUESTION | wx.CENTRE)
  438. ret = dlg.ShowModal()
  439. if ret != wx.ID_YES:
  440. return
  441. for action in self.model.GetActions():
  442. self.SetStatusText(_('Running model...'), 0)
  443. self.goutput.RunCmd(command = action.GetLog(string = False),
  444. onDone = self.OnDone)
  445. def OnDone(self, returncode):
  446. """!Computation finished"""
  447. self.SetStatusText('', 0)
  448. def OnValidateModel(self, event, showMsg = True):
  449. """!Validate entire model"""
  450. if len(self.model.GetActions()) < 1:
  451. GMessage(parent = self,
  452. message = _('Model is empty. Nothing to validate.'),
  453. msgType = 'info')
  454. return
  455. errList = self._validateModel()
  456. if errList:
  457. GMessage(parent = self,
  458. message = _('Model is not valid.\n\n%s') % '\n'.join(errList),
  459. msgType = 'warning')
  460. else:
  461. GMessage(parent = self,
  462. message = _('Model is valid.'),
  463. msgType = 'info')
  464. def OnExportImage(self, event):
  465. """!Export model to image (default image)
  466. """
  467. xminImg = 0
  468. xmaxImg = 0
  469. yminImg = 0
  470. ymaxImg = 0
  471. for shape in self.canvas.GetDiagram().GetShapeList():
  472. w, h = shape.GetBoundingBoxMax()
  473. x = shape.GetX()
  474. y = shape.GetY()
  475. xmin = x - w / 2
  476. xmax = x + w / 2
  477. ymin = y - h / 2
  478. ymax = y + h / 2
  479. if xmin < xminImg:
  480. xminImg = xmin
  481. if xmax > xmaxImg:
  482. xmaxImg = xmax
  483. if ymin < yminImg:
  484. xminImg = xmin
  485. if ymax < ymaxImg:
  486. xminImg = xmin
  487. size = wx.Size(int(xmaxImg - xminImg),
  488. int(ymaxImg - ymaxImg))
  489. bitmap = wx.EmptyBitmap(width = size.width, height = size.height)
  490. filetype, ltype = GetImageHandlers(wx.ImageFromBitmap(bitmap))
  491. dlg = wx.FileDialog(parent = self,
  492. message = _("Choose a file name to save the image (no need to add extension)"),
  493. defaultDir = "",
  494. defaultFile = "",
  495. wildcard = filetype,
  496. style=wx.SAVE | wx.FD_OVERWRITE_PROMPT)
  497. if dlg.ShowModal() == wx.ID_OK:
  498. path = dlg.GetPath()
  499. if not path:
  500. dlg.Destroy()
  501. return
  502. base, ext = os.path.splitext(path)
  503. fileType = ltype[dlg.GetFilterIndex()]['type']
  504. extType = ltype[dlg.GetFilterIndex()]['ext']
  505. if ext != extType:
  506. path = base + '.' + extType
  507. dc = wx.MemoryDC(bitmap)
  508. dc.SetBackground(wx.WHITE_BRUSH)
  509. dc.SetBackgroundMode(wx.SOLID)
  510. dc.BeginDrawing()
  511. self.canvas.GetDiagram().Clear(dc)
  512. self.canvas.GetDiagram().Redraw(dc)
  513. dc.EndDrawing()
  514. bitmap.SaveFile(path, fileType)
  515. self.SetStatusText(_("Model exported to <%s>") % path)
  516. dlg.Destroy()
  517. def OnExportPython(self, event):
  518. """!Export model to Python script"""
  519. filename = ''
  520. dlg = wx.FileDialog(parent = self,
  521. message = _("Choose file to save"),
  522. defaultDir = os.getcwd(),
  523. wildcard=_("Python script (*.py)|*.py"),
  524. style=wx.FD_SAVE)
  525. if dlg.ShowModal() == wx.ID_OK:
  526. filename = dlg.GetPath()
  527. if not filename:
  528. return
  529. # check for extension
  530. if filename[-3:] != ".py":
  531. filename += ".py"
  532. if os.path.exists(filename):
  533. dlg = wx.MessageDialog(self, message=_("File <%s> already exists. "
  534. "Do you want to overwrite this file?") % filename,
  535. caption=_("Save file"),
  536. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  537. if dlg.ShowModal() == wx.ID_NO:
  538. dlg.Destroy()
  539. return
  540. dlg.Destroy()
  541. fd = open(filename, "w")
  542. try:
  543. self._writePython(fd)
  544. finally:
  545. fd.close()
  546. # executable file
  547. os.chmod(filename, stat.S_IRWXU | stat.S_IWUSR)
  548. self.SetStatusText(_("Model exported to <%s>") % filename)
  549. def _writePython(self, fd):
  550. """!Write model to file"""
  551. fd.write(
  552. r"""#!/usr/bin/env python
  553. #
  554. ############################################################################
  555. #
  556. # MODULE: Graphical modeler script
  557. #
  558. # AUTHOR(S): %s
  559. #
  560. # PURPOSE: Script generated by wxGUI Graphical Modeler
  561. #
  562. # DATE: %s
  563. #
  564. #############################################################################
  565. """ % (getpass.getuser(), time.asctime()))
  566. fd.write(
  567. r"""
  568. import sys
  569. import os
  570. import grass.script as grass
  571. import atexit
  572. """)
  573. fd.write(
  574. r"""
  575. def cleanup():
  576. pass
  577. """)
  578. fd.write("\ndef main():\n")
  579. for action in self.model.GetActions():
  580. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  581. show = None)
  582. opts = task.get_options()
  583. flags = ''
  584. params = list()
  585. strcmd = " grass.run_command("
  586. indent = len(strcmd)
  587. fd.write(strcmd + "'%s',\n" % task.get_name())
  588. for f in opts['flags']:
  589. if f.get('value', False) == True:
  590. name = f.get('name', '')
  591. if len(name) > 1:
  592. params.append('%s=True' % name)
  593. else:
  594. flags += name
  595. for p in opts['params']:
  596. name = p.get('name', None)
  597. value = p.get('value', None)
  598. if name and value:
  599. ptype = p.get('type', 'string')
  600. if ptype == 'string':
  601. params.append("%s='%s'" % (name, value))
  602. else:
  603. params.append("%s=%s" % (name, value))
  604. for opt in params[:-1]:
  605. fd.write("%s%s,\n" % (' ' * indent, opt))
  606. fd.write("%s%s)\n" % (' ' * indent, params[-1]))
  607. fd.write("\n return 0\n")
  608. fd.write(
  609. r"""
  610. if __name__ == "__main__":
  611. options, flags = grass.parser()
  612. atexit.register(cleanup)
  613. sys.exit(main())
  614. """)
  615. def _validateModel(self):
  616. """!Validate model"""
  617. self.SetStatusText(_('Validating model...'), 0)
  618. errList = self.model.Validate()
  619. self.SetStatusText('', 0)
  620. return errList
  621. def OnRemoveItem(self, event):
  622. """!Remove item from model"""
  623. pass
  624. def OnDefineRelation(self, event):
  625. """!Define relation between data and action items"""
  626. self.canvas.SetCursor(self.cursors["cross"])
  627. def OnAddAction(self, event):
  628. """!Add action to model"""
  629. if self.searchDialog is None:
  630. self.searchDialog = ModelSearchDialog(self)
  631. self.searchDialog.CentreOnParent()
  632. else:
  633. self.searchDialog.Reset()
  634. if self.searchDialog.ShowModal() == wx.ID_CANCEL:
  635. self.searchDialog.Hide()
  636. return
  637. cmd = self.searchDialog.GetCmd()
  638. self.searchDialog.Hide()
  639. self.ModelChanged()
  640. # add action to canvas
  641. width, height = self.canvas.GetSize()
  642. action = ModelAction(self, cmd = cmd, x = width/2, y = height/2)
  643. self.canvas.diagram.AddShape(action)
  644. action.Show(True)
  645. self._addEvent(action)
  646. self.model.AddAction(action)
  647. self.canvas.Refresh()
  648. time.sleep(.1)
  649. # show properties dialog
  650. win = action.GetPropDialog()
  651. if not win:
  652. module = menuform.GUI().ParseCommand(action.GetLog(string = False),
  653. completed = (self.GetOptData, action, action.GetParams()),
  654. parentframe = self, show = True)
  655. elif not win.IsShown():
  656. win.Show()
  657. if win:
  658. win.Raise()
  659. def OnAddData(self, event):
  660. """!Add data item to model"""
  661. # add action to canvas
  662. width, height = self.canvas.GetSize()
  663. data = ModelData(self, x = width/2, y = height/2)
  664. self.canvas.diagram.AddShape(data)
  665. data.Show(True)
  666. self._addEvent(data)
  667. self.model.AddData(data)
  668. self.canvas.Refresh()
  669. def OnHelp(self, event):
  670. """!Display manual page"""
  671. grass.run_command('g.manual',
  672. entry = 'wxGUI.Modeler')
  673. def OnAbout(self, event):
  674. """!Display About window"""
  675. info = wx.AboutDialogInfo()
  676. info.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  677. info.SetName(_('wxGUI Graphical Modeler'))
  678. info.SetWebSite('http://grass.osgeo.org')
  679. info.SetDescription(_('(C) 2010 by the GRASS Development Team\n\n') +
  680. '\n'.join(textwrap.wrap(_('This program is free software under the GNU General Public License'
  681. '(>=v2). Read the file COPYING that comes with GRASS for details.'), 75)))
  682. wx.AboutBox(info)
  683. def GetOptData(self, dcmd, layer, params, propwin):
  684. """!Process action data"""
  685. if params: # add data items
  686. for p in params['params']:
  687. if p.get('prompt', '') in ('raster', 'vector', 'raster3d'):
  688. try:
  689. name, mapset = p.get('value', '').split('@', 1)
  690. except (ValueError, IndexError):
  691. continue
  692. if mapset != grass.gisenv()['MAPSET']:
  693. continue
  694. # don't use fully qualified names
  695. p['value'] = p.get('value', '').split('@')[0]
  696. for idx in range(1, len(dcmd)):
  697. if p.get('name', '') in dcmd[idx]:
  698. dcmd[idx] = p.get('name', '') + '=' + p.get('value', '')
  699. break
  700. width, height = self.canvas.GetSize()
  701. x = [width/2 + 200, width/2 - 200]
  702. for p in params['params']:
  703. if p.get('prompt', '') in ('raster', 'vector', 'raster3d') and \
  704. (p.get('value', None) or \
  705. p.get('age', 'old') != 'old'):
  706. data = layer.FindData(p.get('name', ''))
  707. if data:
  708. data.SetValue(p.get('value', ''))
  709. continue
  710. data = self.FindData(p.get('value', ''),
  711. p.get('prompt', ''))
  712. if data:
  713. if p.get('age', 'old') == 'old':
  714. self._addLine(data, layer)
  715. data.AddAction(layer, direction = 'from')
  716. else:
  717. self._addLine(layer, data)
  718. data.AddAction(layer, direction = 'to')
  719. continue
  720. data = ModelData(self, name = p.get('name', ''),
  721. value = p.get('value', ''),
  722. prompt = p.get('prompt', ''),
  723. x = x.pop(), y = height/2)
  724. layer.AddData(data)
  725. self.canvas.diagram.AddShape(data)
  726. data.Show(True)
  727. self._addEvent(data)
  728. self.model.AddData(data)
  729. if p.get('age', 'old') == 'old':
  730. self._addLine(data, layer)
  731. data.AddAction(layer, direction = 'from')
  732. else:
  733. self._addLine(layer, data)
  734. data.AddAction(layer, direction = 'to')
  735. # valid ?
  736. valid = True
  737. for p in params['params']:
  738. if p.get('value', '') == '' and \
  739. p.get('default', '') == '':
  740. valid = False
  741. break
  742. layer.SetValid(valid)
  743. self.canvas.Refresh()
  744. if dcmd:
  745. layer.SetProperties(dcmd, params, propwin)
  746. self.SetStatusText(layer.GetLog(), 0)
  747. def _addLine(self, fromShape, toShape):
  748. """!Add connection
  749. @param fromShape from
  750. @param toShape to
  751. """
  752. line = ModelRelation()
  753. line.SetCanvas(self)
  754. line.SetPen(wx.BLACK_PEN)
  755. line.SetBrush(wx.BLACK_BRUSH)
  756. line.AddArrow(ogl.ARROW_ARROW)
  757. line.MakeLineControlPoints(2)
  758. self._addEvent(line)
  759. fromShape.AddLine(line, toShape)
  760. self.canvas.diagram.AddShape(line)
  761. line.Show(True)
  762. def LoadModelFile(self, filename):
  763. """!Load model definition stored in GRASS Model XML file (gxm)
  764. """
  765. try:
  766. self.model.LoadModel(filename)
  767. except GError, e:
  768. GMessage(parent = self,
  769. message = _("Reading model file <%s> failed.\n"
  770. "Invalid file, unable to parse XML document.") % filename)
  771. self.modelFile = filename
  772. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  773. self.SetStatusText(_("Please wait, loading model..."), 0)
  774. # load actions
  775. for action in self.model.GetActions():
  776. self._addEvent(action)
  777. self.canvas.diagram.AddShape(action)
  778. action.Show(True)
  779. # load data & relations
  780. for data in self.model.GetData():
  781. self._addEvent(data)
  782. self.canvas.diagram.AddShape(data)
  783. data.Show(True)
  784. for action in data.GetActions('from'):
  785. self._addLine(data, action)
  786. for action in data.GetActions('to'):
  787. self._addLine(action, data)
  788. self.SetStatusText('', 0)
  789. self.canvas.Refresh(True)
  790. def WriteModelFile(self, filename):
  791. """!Save model to model file
  792. @return True on success
  793. @return False on failure
  794. """
  795. try:
  796. file = open(filename, "w")
  797. except IOError:
  798. wx.MessageBox(parent = self,
  799. message = _("Unable to open file <%s> for writing.") % filename,
  800. caption = _("Error"),
  801. style = wx.OK | wx.ICON_ERROR | wx.CENTRE)
  802. return False
  803. try:
  804. WriteModelFile(fd = file, actions = self.model.GetActions(), data = self.model.GetData())
  805. except StandardError:
  806. file.close()
  807. GMessage(parent = self,
  808. message = _("Writing current settings to model file failed."))
  809. return False
  810. file.close()
  811. return True
  812. class ModelCanvas(ogl.ShapeCanvas):
  813. """!Canvas where model is drawn"""
  814. def __init__(self, parent):
  815. ogl.OGLInitialize()
  816. ogl.ShapeCanvas.__init__(self, parent)
  817. self.diagram = ogl.Diagram()
  818. self.SetDiagram(self.diagram)
  819. self.diagram.SetCanvas(self)
  820. self.SetScrollbars(20, 20, 1000/20, 1000/20)
  821. class ModelAction(ogl.RectangleShape):
  822. """!Action class (GRASS module)"""
  823. def __init__(self, parent, x, y, cmd = None, width = 100, height = 50):
  824. self.parent = parent
  825. self.cmd = cmd
  826. if self.cmd:
  827. task = menuform.GUI().ParseCommand(cmd = self.cmd,
  828. show = None)
  829. self.params = task.get_options()
  830. else:
  831. self.params = None
  832. self.propWin = None
  833. self.id = -1 # used for gxm file
  834. self.data = list() # list of connected data items
  835. self.isValid = False
  836. if self.parent.GetCanvas():
  837. ogl.RectangleShape.__init__(self, width, height)
  838. self.SetCanvas(self.parent)
  839. self.SetX(x)
  840. self.SetY(y)
  841. self.SetPen(wx.BLACK_PEN)
  842. self._setBrush(False)
  843. if self.cmd and len(self.cmd) > 0:
  844. self.AddText(self.cmd[0])
  845. else:
  846. self.AddText('<<module>>')
  847. def _setBrush(self, isvalid):
  848. """!Set brush"""
  849. if isvalid:
  850. color = UserSettings.Get(group='modeler', key='action',
  851. subkey=('color', 'valid'))
  852. else:
  853. color = UserSettings.Get(group='modeler', key='action',
  854. subkey=('color', 'invalid'))
  855. wxColor = wx.Color(color[0], color[1], color[2])
  856. self.SetBrush(wx.Brush(wxColor))
  857. def GetId(self):
  858. """!Get id"""
  859. return self.id
  860. def SetId(self, id):
  861. """!Set id"""
  862. self.id = id
  863. def SetProperties(self, dcmd, params, propwin):
  864. """!Record properties dialog"""
  865. self.cmd = dcmd
  866. self.params = params
  867. self.propWin = propwin
  868. def GetPropDialog(self):
  869. """!Get properties dialog"""
  870. return self.propWin
  871. def GetLog(self, string = True):
  872. """!Get logging info"""
  873. if string:
  874. if self.cmd is None:
  875. return ''
  876. else:
  877. return ' '.join(self.cmd)
  878. return self.cmd
  879. def GetName(self):
  880. """!Get name"""
  881. if self.cmd and len(self.cmd) > 0:
  882. return self.cmd[0]
  883. return _('unknown')
  884. def GetParams(self):
  885. """!Get dictionary of parameters"""
  886. return self.params
  887. def SetParams(self, params, cmd):
  888. """!Set dictionary of parameters"""
  889. self.params = params
  890. self.cmd = cmd
  891. def SetValid(self, isvalid):
  892. """!Set instance to be valid/invalid"""
  893. self.isValid = isvalid
  894. self._setBrush(isvalid)
  895. def AddData(self, item):
  896. """!Register new data item"""
  897. if item not in self.data:
  898. self.data.append(item)
  899. def FindData(self, name):
  900. """!Find data item by name"""
  901. for d in self.data:
  902. if d.GetName() == name:
  903. return d
  904. return None
  905. def Update(self):
  906. """!Update action"""
  907. self._setBrush(self.isValid)
  908. class ModelData(ogl.EllipseShape):
  909. """!Data item class"""
  910. def __init__(self, parent, x, y, name = '', value = '', prompt = '', width = 175, height = 50):
  911. self.parent = parent
  912. self.name = name
  913. self.value = value
  914. self.prompt = prompt
  915. self.intermediate = False
  916. self.propWin = None
  917. self.actions = { 'from' : list(), 'to' : list() }
  918. if self.parent.GetCanvas():
  919. ogl.EllipseShape.__init__(self, width, height)
  920. self.SetCanvas(self.parent)
  921. self.SetX(x)
  922. self.SetY(y)
  923. self.SetPen(wx.BLACK_PEN)
  924. if self.prompt == 'raster':
  925. self.SetBrush(wx.Brush(wx.Colour(215, 215, 248)))
  926. elif self.prompt == 'vector':
  927. self.SetBrush(wx.Brush(wx.Colour(248, 215, 215)))
  928. else:
  929. self.SetBrush(wx.LIGHT_GREY_BRUSH)
  930. if name:
  931. self.AddText(name)
  932. else:
  933. self.AddText(_('unknown'))
  934. if value:
  935. self.AddText(value)
  936. else:
  937. self.AddText('\n')
  938. def IsIntermediate(self):
  939. """!Checks if data item is intermediate"""
  940. return self.intermediate
  941. def SetIntermediate(self, im):
  942. """!Set intermediate flag"""
  943. self.intermediate = im
  944. def OnDraw(self, dc):
  945. pen = self.GetPen()
  946. if self.intermediate:
  947. pen.SetStyle(wx.SHORT_DASH)
  948. else:
  949. pen.SetStyle(wx.SOLID)
  950. self.SetPen(pen)
  951. ogl.EllipseShape.OnDraw(self, dc)
  952. def GetLog(self, string = True):
  953. """!Get logging info"""
  954. if self.name:
  955. return self.name + '=' + self.value + ' (' + self.prompt + ')'
  956. else:
  957. return _('unknown')
  958. def GetName(self):
  959. """!Get name"""
  960. return self.name
  961. def GetPrompt(self):
  962. """!Get prompt"""
  963. return self.prompt
  964. def GetValue(self):
  965. """!Get value"""
  966. return self.value
  967. def SetValue(self, value):
  968. """!Set value"""
  969. self.value = value
  970. self.ClearText()
  971. self.AddText(self.name)
  972. if value:
  973. self.AddText(self.value)
  974. else:
  975. self.AddText('\n')
  976. for direction in ('from', 'to'):
  977. for action in self.actions[direction]:
  978. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  979. show = None)
  980. task.set_param(self.name, self.value)
  981. action.SetParams(params = task.get_options(),
  982. cmd = task.getCmd(ignoreErrors = True))
  983. def GetActions(self, direction):
  984. """!Get related actions
  985. @param direction direction - 'from' or 'to'
  986. """
  987. return self.actions[direction]
  988. def AddAction(self, action, direction):
  989. """!Record related actions
  990. @param action action to be recoreded
  991. @param direction direction of relation
  992. """
  993. self.actions[direction].append(action)
  994. def GetPropDialog(self):
  995. """!Get properties dialog"""
  996. return self.propWin
  997. def SetPropDialog(self, win):
  998. """!Get properties dialog"""
  999. self.propWin = win
  1000. class ModelDataDialog(ElementDialog):
  1001. """!Data item properties dialog"""
  1002. def __init__(self, parent, shape, id = wx.ID_ANY, title = _("Data properties"),
  1003. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER):
  1004. self.parent = parent
  1005. self.shape = shape
  1006. prompt = shape.GetPrompt()
  1007. if prompt == 'raster':
  1008. label = _('Name of raster map:')
  1009. elif prompt == 'vector':
  1010. label = _('Name of vector map:')
  1011. else:
  1012. label = _('Name of element:')
  1013. ElementDialog.__init__(self, parent, title, label = label)
  1014. self.element = gselect.Select(parent = self.panel, id = wx.ID_ANY,
  1015. size = globalvar.DIALOG_GSELECT_SIZE,
  1016. type = prompt)
  1017. self.element.SetValue(shape.GetValue())
  1018. self.Bind(wx.EVT_BUTTON, self.OnOK, self.btnOK)
  1019. self.Bind(wx.EVT_BUTTON, self.OnCancel, self.btnCancel)
  1020. self.PostInit()
  1021. self._layout()
  1022. self.SetMinSize(self.GetSize())
  1023. def _layout(self):
  1024. """!Do layout"""
  1025. self.dataSizer.Add(self.element, proportion=0,
  1026. flag=wx.EXPAND | wx.ALL, border=1)
  1027. self.panel.SetSizer(self.sizer)
  1028. self.sizer.Fit(self)
  1029. def OnOK(self, event):
  1030. """!Ok pressed"""
  1031. self.shape.SetValue(self.GetElement())
  1032. self.parent.canvas.Refresh()
  1033. self.parent.SetStatusText('', 0)
  1034. self.OnCancel(event)
  1035. def OnCancel(self, event):
  1036. """!Cancel pressed"""
  1037. self.shape.SetPropDialog(None)
  1038. self.Destroy()
  1039. class ModelEvtHandler(ogl.ShapeEvtHandler):
  1040. """!Model event handler class"""
  1041. def __init__(self, log, frame):
  1042. ogl.ShapeEvtHandler.__init__(self)
  1043. self.log = log
  1044. self.frame = frame
  1045. def OnLeftClick(self, x, y, keys = 0, attachment = 0):
  1046. """!Left mouse button pressed -> select item & update statusbar"""
  1047. shape = self.GetShape()
  1048. canvas = shape.GetCanvas()
  1049. dc = wx.ClientDC(canvas)
  1050. canvas.PrepareDC(dc)
  1051. if shape.Selected():
  1052. shape.Select(False, dc)
  1053. else:
  1054. redraw = False
  1055. shapeList = canvas.GetDiagram().GetShapeList()
  1056. toUnselect = list()
  1057. for s in shapeList:
  1058. if s.Selected():
  1059. toUnselect.append(s)
  1060. shape.Select(True, dc)
  1061. for s in toUnselect:
  1062. s.Select(False, dc)
  1063. canvas.Refresh(False)
  1064. if hasattr(shape, "GetLog"):
  1065. self.log.SetStatusText(shape.GetLog(), 0)
  1066. def OnLeftDoubleClick(self, x, y, keys = 0, attachment = 0):
  1067. """!Left mouse button pressed (double-click) -> show properties"""
  1068. self.OnProperties()
  1069. def OnProperties(self, event = None):
  1070. """!Show properties dialog"""
  1071. self.frame.ModelChanged()
  1072. shape = self.GetShape()
  1073. # win = shape.GetPropDialog()
  1074. if isinstance(shape, ModelAction):
  1075. module = menuform.GUI().ParseCommand(shape.GetLog(string = False),
  1076. completed = (self.frame.GetOptData, shape, shape.GetParams()),
  1077. parentframe = self.frame, show = True)
  1078. elif isinstance(shape, ModelData):
  1079. dlg = ModelDataDialog(parent = self.frame, shape = shape)
  1080. shape.SetPropDialog(dlg)
  1081. dlg.CentreOnParent()
  1082. dlg.Show()
  1083. def OnBeginDragLeft(self, x, y, keys = 0, attachment = 0):
  1084. """!Drag shape"""
  1085. self.frame.ModelChanged()
  1086. if self._previousHandler:
  1087. self._previousHandler.OnBeginDragLeft(x, y, keys, attachment)
  1088. def OnRightClick(self, x, y, keys = 0, attachment = 0):
  1089. """!Right click -> pop-up menu"""
  1090. if not hasattr (self, "popupID1"):
  1091. self.popupID1 = wx.NewId()
  1092. self.popupID2 = wx.NewId()
  1093. self.popupID3 = wx.NewId()
  1094. shape = self.GetShape()
  1095. popupMenu = wx.Menu()
  1096. popupMenu.Append(self.popupID1, text=_('Remove'))
  1097. self.frame.Bind(wx.EVT_MENU, self.OnRemove, id = self.popupID1)
  1098. if isinstance(shape, ModelData) and '@' not in shape.GetValue():
  1099. popupMenu.AppendSeparator()
  1100. popupMenu.Append(self.popupID3, text=_('Intermediate'),
  1101. kind = wx.ITEM_CHECK)
  1102. if self.GetShape().IsIntermediate():
  1103. popupMenu.Check(self.popupID3, True)
  1104. self.frame.Bind(wx.EVT_MENU, self.OnIntermediate, id = self.popupID3)
  1105. if isinstance(shape, ModelData) or \
  1106. isinstance(shape, ModelAction):
  1107. popupMenu.AppendSeparator()
  1108. popupMenu.Append(self.popupID2, text=_('Properties'))
  1109. self.frame.Bind(wx.EVT_MENU, self.OnProperties, id = self.popupID2)
  1110. self.frame.PopupMenu(popupMenu)
  1111. popupMenu.Destroy()
  1112. def OnIntermediate(self, event):
  1113. """!Mark data as intermediate"""
  1114. self.frame.ModelChanged()
  1115. shape = self.GetShape()
  1116. shape.SetIntermediate(event.IsChecked())
  1117. self.frame.canvas.Refresh()
  1118. def OnRemove(self, event):
  1119. """!Remove shape
  1120. @todo complex remove
  1121. """
  1122. self.frame.ModelChanged()
  1123. shapes = [self.GetShape()]
  1124. for shape in shapes:
  1125. if isinstance(shape, ModelAction):
  1126. pass
  1127. if isinstance(shape, ModelData):
  1128. pass
  1129. shape.Select(False)
  1130. self.frame.canvas.GetDiagram().RemoveShape(shape)
  1131. self.frame.canvas.Refresh()
  1132. class ModelSearchDialog(wx.Dialog):
  1133. def __init__(self, parent, id = wx.ID_ANY, title = _("Select GRASS module"),
  1134. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER, **kwargs):
  1135. """!Graphical modeler module search window
  1136. @param parent parent window
  1137. @param id window id
  1138. @param title window title
  1139. @param kwargs wx.Dialogs' arguments
  1140. """
  1141. self.parent = parent
  1142. wx.Dialog.__init__(self, parent = parent, id = id, title = title, **kwargs)
  1143. self.SetName("ModelerDialog")
  1144. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  1145. self.panel = wx.Panel(parent = self, id = wx.ID_ANY)
  1146. self.findBox = wx.StaticBox(parent = self.panel, id = wx.ID_ANY,
  1147. label=" %s " % _("Find module(s) by"))
  1148. self.cmdBox = wx.StaticBox(parent = self.panel, id = wx.ID_ANY,
  1149. label=" %s " % _("Command"))
  1150. self.searchBy = wx.Choice(parent = self.panel, id = wx.ID_ANY,
  1151. choices = [_("description"),
  1152. _("keywords")])
  1153. self.searchBy.SetSelection(0)
  1154. self.search = wx.TextCtrl(parent = self.panel, id = wx.ID_ANY,
  1155. value = "", size = (-1, 25))
  1156. self.searchTip = menuform.StaticWrapText(parent = self.panel, id = wx.ID_ANY,
  1157. size = (-1, 35))
  1158. self.searchChoice = wx.Choice(parent = self.panel, id = wx.ID_ANY)
  1159. self.cmd_prompt = prompt.GPromptSTC(parent = self)
  1160. # get commands
  1161. items = self.cmd_prompt.GetCommandItems()
  1162. self.searchTip.SetLabel(_("%d modules found") % len(items))
  1163. self.searchChoice.SetItems(items)
  1164. self.btnCancel = wx.Button(self.panel, wx.ID_CANCEL)
  1165. self.btnOk = wx.Button(self.panel, wx.ID_OK)
  1166. self.btnOk.SetDefault()
  1167. self.search.Bind(wx.EVT_TEXT, self.OnSearchModule)
  1168. self.searchChoice.Bind(wx.EVT_CHOICE, self.OnSelectModule)
  1169. self._layout()
  1170. self.SetSize((500, 275))
  1171. def _layout(self):
  1172. btnSizer = wx.StdDialogButtonSizer()
  1173. btnSizer.AddButton(self.btnCancel)
  1174. btnSizer.AddButton(self.btnOk)
  1175. btnSizer.Realize()
  1176. findSizer = wx.StaticBoxSizer(self.findBox, wx.HORIZONTAL)
  1177. gridSizer = wx.GridBagSizer(hgap = 3, vgap = 3)
  1178. gridSizer.AddGrowableCol(1)
  1179. cmdSizer = wx.StaticBoxSizer(self.cmdBox, wx.VERTICAL)
  1180. gridSizer.Add(item = self.searchBy,
  1181. flag=wx.ALIGN_CENTER_VERTICAL, pos = (0, 0))
  1182. gridSizer.Add(item = self.search,
  1183. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (0, 1))
  1184. gridSizer.Add(item = self.searchTip,
  1185. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (1, 0), span = (1, 2))
  1186. gridSizer.Add(item = self.searchChoice,
  1187. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (2, 0), span = (1, 2))
  1188. findSizer.Add(item = gridSizer, proportion = 1)
  1189. cmdSizer.Add(item=self.cmd_prompt, proportion=1,
  1190. flag=wx.EXPAND | wx.ALL, border=1)
  1191. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1192. mainSizer.Add(item=findSizer, proportion=0,
  1193. flag=wx.EXPAND | wx.ALL, border=5)
  1194. mainSizer.Add(item=cmdSizer, proportion=1,
  1195. flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM, border = 5)
  1196. mainSizer.Add(item=btnSizer, proportion=0,
  1197. flag=wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border=5)
  1198. self.panel.SetSizer(mainSizer)
  1199. mainSizer.Fit(self.panel)
  1200. self.Layout()
  1201. def GetPanel(self):
  1202. """!Get dialog panel"""
  1203. return self.panel
  1204. def GetCmd(self):
  1205. """!Get command"""
  1206. line = self.cmd_prompt.GetCurLine()[0].strip()
  1207. if len(line) == 0:
  1208. list()
  1209. try:
  1210. cmd = shlex.split(str(line))
  1211. except UnicodeError:
  1212. cmd = shlex.split(utils.EncodeString((line)))
  1213. return cmd
  1214. def OnSearchModule(self, event):
  1215. """!Search module by keywords or description"""
  1216. text = event.GetString()
  1217. if not text:
  1218. self.cmd_prompt.SetFilter(None)
  1219. return
  1220. modules = dict()
  1221. iFound = 0
  1222. for module, data in self.cmd_prompt.moduleDesc.iteritems():
  1223. found = False
  1224. if self.searchBy.GetSelection() == 0: # -> description
  1225. if text in data['desc']:
  1226. found = True
  1227. else: # -> keywords
  1228. if self.cmd_prompt.CheckKey(text, data['keywords']):
  1229. found = True
  1230. if found:
  1231. iFound += 1
  1232. try:
  1233. group, name = module.split('.')
  1234. except ValueError:
  1235. continue # TODO
  1236. if not modules.has_key(group):
  1237. modules[group] = list()
  1238. modules[group].append(name)
  1239. self.cmd_prompt.SetFilter(modules)
  1240. self.searchTip.SetLabel(_("%d modules found") % iFound)
  1241. self.searchChoice.SetItems(self.cmd_prompt.GetCommandItems())
  1242. def OnSelectModule(self, event):
  1243. """!Module selected from choice, update command prompt"""
  1244. cmd = event.GetString().split(' ', 1)[0]
  1245. text = cmd + ' '
  1246. pos = len(text)
  1247. self.cmd_prompt.SetText(text)
  1248. self.cmd_prompt.SetSelectionStart(pos)
  1249. self.cmd_prompt.SetCurrentPos(pos)
  1250. self.cmd_prompt.SetFocus()
  1251. desc = self.cmd_prompt.GetCommandDesc(cmd)
  1252. self.searchTip.SetLabel(desc)
  1253. def OnOk(self, event):
  1254. self.btnOk.SetFocus()
  1255. def Reset(self):
  1256. """!Reset dialog"""
  1257. self.searchBy.SetSelection(0)
  1258. self.search.SetValue('')
  1259. self.cmd_prompt.OnCmdErase(None)
  1260. class ModelRelation(ogl.LineShape):
  1261. """!Data - action relation"""
  1262. def __init__(self):
  1263. ogl.LineShape.__init__(self)
  1264. class ProcessModelFile:
  1265. """!Process GRASS model file (gxm)"""
  1266. def __init__(self, tree):
  1267. """!A ElementTree handler for the GXM XML file, as defined in
  1268. grass-gxm.dtd.
  1269. """
  1270. self.tree = tree
  1271. self.root = self.tree.getroot()
  1272. # list of actions, data
  1273. self.actions = list()
  1274. self.data = list()
  1275. self._processActions()
  1276. self._processData()
  1277. def _filterValue(self, value):
  1278. """!Filter value
  1279. @param value
  1280. """
  1281. value = value.replace('&lt;', '<')
  1282. value = value.replace('&gt;', '>')
  1283. return value
  1284. def _getNodeText(self, node, tag, default = ''):
  1285. """!Get node text"""
  1286. p = node.find(tag)
  1287. if p is not None:
  1288. if p.text:
  1289. return utils.normalize_whitespace(p.text)
  1290. else:
  1291. return ''
  1292. return default
  1293. def _processActions(self):
  1294. """!Process model file"""
  1295. for action in self.root.findall('action'):
  1296. pos, size = self._getDim(action)
  1297. task = action.find('task')
  1298. if task:
  1299. cmd = self._processTask(task)
  1300. else:
  1301. cmd = None
  1302. aId = int(action.get('id', -1))
  1303. self.actions.append({ 'pos' : pos,
  1304. 'size': size,
  1305. 'cmd' : cmd,
  1306. 'id' : aId })
  1307. def _getDim(self, node):
  1308. """!Get position and size of shape"""
  1309. pos = size = None
  1310. posAttr = node.get('pos', None)
  1311. if posAttr:
  1312. posVal = map(int, posAttr.split(','))
  1313. try:
  1314. pos = (posVal[0], posVal[1])
  1315. except:
  1316. pos = None
  1317. sizeAttr = node.get('size', None)
  1318. if sizeAttr:
  1319. sizeVal = map(int, sizeAttr.split(','))
  1320. try:
  1321. size = (sizeVal[0], sizeVal[1])
  1322. except:
  1323. size = None
  1324. return pos, size
  1325. def _processData(self):
  1326. """!Process model file"""
  1327. for data in self.root.findall('data'):
  1328. pos, size = self._getDim(data)
  1329. param = data.find('data-parameter')
  1330. name = prompt = value = None
  1331. if param is not None:
  1332. name = param.get('name', None)
  1333. prompt = param.get('prompt', None)
  1334. value = self._filterValue(self._getNodeText(param, 'value'))
  1335. if data.find('intermediate') is None:
  1336. intermediate = False
  1337. else:
  1338. intermediate = True
  1339. aId = list()
  1340. fromDir = list()
  1341. for action in data.findall('data-action'):
  1342. aId.append(int(action.get('id', None)))
  1343. if action.get('dir', 'to') == 'to':
  1344. fromDir.append(False)
  1345. else:
  1346. fromDir.append(True)
  1347. self.data.append({ 'pos' : pos,
  1348. 'size': size,
  1349. 'name' : name,
  1350. 'prompt' : prompt,
  1351. 'value' : value,
  1352. 'intermediate' : intermediate,
  1353. 'id' : aId,
  1354. 'from' : fromDir })
  1355. def _processTask(self, node):
  1356. """!Process task"""
  1357. cmd = list()
  1358. name = node.get('name', None)
  1359. if not name:
  1360. return cmd
  1361. cmd.append(name)
  1362. # flags
  1363. for p in node.findall('flag'):
  1364. flag = p.get('name', '')
  1365. if len(flag) > 1:
  1366. cmd.append('--' + flag)
  1367. else:
  1368. cmd.append('-' + flag)
  1369. # parameters
  1370. for p in node.findall('parameter'):
  1371. cmd.append('%s=%s' % (p.get('name', ''),
  1372. self._filterValue(self._getNodeText(p, 'value'))))
  1373. return cmd
  1374. class WriteModelFile:
  1375. """!Generic class for writing model file"""
  1376. def __init__(self, fd, actions, data):
  1377. self.fd = fd
  1378. self.actions = actions
  1379. self.data = data
  1380. self.indent = 0
  1381. self._header()
  1382. self._actions()
  1383. self._data()
  1384. self._footer()
  1385. def _filterValue(self, value):
  1386. """!Make value XML-valid"""
  1387. value = value.replace('<', '&lt;')
  1388. value = value.replace('>', '&gt;')
  1389. return value
  1390. def _header(self):
  1391. """!Write header"""
  1392. self.fd.write('<?xml version="1.0" encoding="UTF-8"?>\n')
  1393. self.fd.write('<!DOCTYPE gxm SYSTEM "grass-gxm.dtd">\n')
  1394. self.fd.write('%s<gxm>\n' % (' ' * self.indent))
  1395. def _footer(self):
  1396. """!Write footer"""
  1397. self.fd.write('%s</gxm>\n' % (' ' * self.indent))
  1398. def _actions(self):
  1399. """!Write actions"""
  1400. id = 1
  1401. self.indent += 4
  1402. for action in self.actions:
  1403. action.SetId(id)
  1404. self.fd.write('%s<action id="%d" name="%s" pos="%d,%d" size="%d,%d">\n' % \
  1405. (' ' * self.indent, id, action.GetName(), action.GetX(), action.GetY(),
  1406. action.GetWidth(), action.GetHeight()))
  1407. self.indent += 4
  1408. self.fd.write('%s<task name="%s">\n' % (' ' * self.indent, action.GetLog(string = False)[0]))
  1409. self.indent += 4
  1410. for key, val in action.GetParams().iteritems():
  1411. if key == 'flags':
  1412. for f in val:
  1413. if f.get('value', False):
  1414. self.fd.write('%s<flag name="%s" />\n' %
  1415. (' ' * self.indent, f.get('name', '')))
  1416. else: # parameter
  1417. for p in val:
  1418. if not p.get('value', ''):
  1419. continue
  1420. self.fd.write('%s<parameter name="%s">\n' %
  1421. (' ' * self.indent, p.get('name', '')))
  1422. self.indent += 4
  1423. self.fd.write('%s<value>%s</value>\n' %
  1424. (' ' * self.indent, self._filterValue(p.get('value', ''))))
  1425. self.indent -= 4
  1426. self.fd.write('%s</parameter>\n' % (' ' * self.indent))
  1427. self.indent -= 4
  1428. self.fd.write('%s</task>\n' % (' ' * self.indent))
  1429. self.indent -= 4
  1430. self.fd.write('%s</action>\n' % (' ' * self.indent))
  1431. id += 1
  1432. self.indent -= 4
  1433. def _data(self):
  1434. """!Write data"""
  1435. self.indent += 4
  1436. for data in self.data:
  1437. self.fd.write('%s<data pos="%d,%d" size="%d,%d">\n' % \
  1438. (' ' * self.indent, data.GetX(), data.GetY(),
  1439. data.GetWidth(), data.GetHeight()))
  1440. self.indent += 4
  1441. self.fd.write('%s<data-parameter name="%s" prompt="%s">\n' % \
  1442. (' ' * self.indent, data.GetName(), data.GetPrompt()))
  1443. self.indent += 4
  1444. self.fd.write('%s<value>%s</value>\n' %
  1445. (' ' * self.indent, self._filterValue(data.GetValue())))
  1446. self.indent -= 4
  1447. self.fd.write('%s</data-parameter>\n' % (' ' * self.indent))
  1448. if data.IsIntermediate():
  1449. self.fd.write('%s<intermediate />\n' % (' ' * self.indent))
  1450. for action in data.GetActions('from'):
  1451. id = action.GetId()
  1452. self.fd.write('%s<data-action id="%d" dir="from" />\n' % \
  1453. (' ' * self.indent, id))
  1454. for action in data.GetActions('to'):
  1455. id = action.GetId()
  1456. self.fd.write('%s<data-action id="%d" dir="to" />\n' % \
  1457. (' ' * self.indent, id))
  1458. self.indent -= 4
  1459. self.fd.write('%s</data>\n' % (' ' * self.indent))
  1460. self.indent -= 4
  1461. class PreferencesDialog(PreferencesBaseDialog):
  1462. """!User preferences dialog"""
  1463. def __init__(self, parent, settings = UserSettings,
  1464. title = _("Modeler settings")):
  1465. PreferencesBaseDialog.__init__(self, parent = parent, title = title,
  1466. settings = settings)
  1467. # create notebook pages
  1468. self._createDiagramPage(self.notebook)
  1469. self.SetMinSize(self.GetBestSize())
  1470. self.SetSize(self.size)
  1471. def _createDiagramPage(self, notebook):
  1472. """!Create notebook page for diagram settings"""
  1473. panel = wx.Panel(parent = notebook, id = wx.ID_ANY)
  1474. notebook.AddPage(page = panel, text = _("Diagram"))
  1475. #
  1476. # action
  1477. #
  1478. border = wx.BoxSizer(wx.VERTICAL)
  1479. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1480. label = " %s " % _("Action settings"))
  1481. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1482. gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
  1483. gridSizer.AddGrowableCol(0)
  1484. # colors
  1485. row = 0
  1486. gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
  1487. label=_("Valid:")),
  1488. flag=wx.ALIGN_LEFT |
  1489. wx.ALIGN_CENTER_VERTICAL,
  1490. pos=(row, 0))
  1491. vColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1492. colour = self.settings.Get(group='modeler', key='action', subkey=('color', 'valid')),
  1493. size = globalvar.DIALOG_COLOR_SIZE)
  1494. vColor.SetName('GetColour')
  1495. self.winId['modeler:action:color:valid'] = vColor.GetId()
  1496. gridSizer.Add(item=vColor,
  1497. flag=wx.ALIGN_RIGHT |
  1498. wx.ALIGN_CENTER_VERTICAL,
  1499. pos=(row, 1))
  1500. row = 1
  1501. gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
  1502. label=_("Invalid:")),
  1503. flag=wx.ALIGN_LEFT |
  1504. wx.ALIGN_CENTER_VERTICAL,
  1505. pos=(row, 0))
  1506. iColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1507. colour = self.settings.Get(group='modeler', key='action', subkey=('color', 'invalid')),
  1508. size = globalvar.DIALOG_COLOR_SIZE)
  1509. iColor.SetName('GetColour')
  1510. self.winId['modeler:action:color:invalid'] = iColor.GetId()
  1511. gridSizer.Add(item=iColor,
  1512. flag=wx.ALIGN_RIGHT |
  1513. wx.ALIGN_CENTER_VERTICAL,
  1514. pos=(row, 1))
  1515. sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
  1516. border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
  1517. #
  1518. # data
  1519. #
  1520. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1521. label = " %s " % _("Data settings"))
  1522. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1523. gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
  1524. gridSizer.AddGrowableCol(0)
  1525. sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
  1526. border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
  1527. panel.SetSizer(border)
  1528. return panel
  1529. def OnApply(self, event):
  1530. """!Button 'Apply' pressed"""
  1531. PreferencesBaseDialog.OnApply(self, event)
  1532. self.parent.GetModel().Update()
  1533. self.parent.GetCanvas().Refresh()
  1534. def main():
  1535. app = wx.PySimpleApp()
  1536. wx.InitAllImageHandlers()
  1537. frame = ModelFrame(parent = None)
  1538. if len(sys.argv) > 1:
  1539. frame.LoadModelFile(sys.argv[1])
  1540. # frame.CentreOnScreen()
  1541. frame.Show()
  1542. app.MainLoop()
  1543. if __name__ == "__main__":
  1544. main()