1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
|
"""
@package modules.extensions
@brief GRASS Addons extensions management classes
Classes:
- extensions::InstallExtensionWindow
- extensions::ExtensionTreeModelBuilder
- extensions::ManageExtensionWindow
- extensions::CheckListExtension
(C) 2008-2016 by the GRASS Development Team
This program is free software under the GNU General Public License
(>=v2). Read the file COPYING that comes with GRASS for details.
@author Martin Landa <landa.martin gmail.com>
@author Anna Petrasova <kratochanna gmail.com>
"""
import os
import sys
import wx
from grass.script import task as gtask
from core import globalvar
from core.gcmd import GError, RunCommand, GException, GMessage
from core.utils import SetAddOnPath
from core.gthread import gThread
from core.menutree import TreeModel, ModuleNode
from gui_core.widgets import GListCtrl
from gui_core.treeview import CTreeView
from core.toolboxes import toolboxesOutdated
from gui_core.wrap import Button, StaticBox, Menu, NewId, SearchCtrl
class InstallExtensionWindow(wx.Frame):
def __init__(
self,
parent,
giface,
id=wx.ID_ANY,
title=_("Fetch & install extension from GRASS Addons"),
**kwargs,
):
self.parent = parent
self._giface = giface
self.options = dict() # list of options
wx.Frame.__init__(self, parent=parent, id=id, title=title, **kwargs)
self.SetIcon(
wx.Icon(os.path.join(globalvar.ICONDIR, "grass.ico"), wx.BITMAP_TYPE_ICO)
)
self.panel = wx.Panel(parent=self, id=wx.ID_ANY)
# self.repoBox = StaticBox(
# parent=self.panel, id=wx.ID_ANY, label=" %s " %
# _("Repository (leave empty to use the official one)"))
self.treeBox = StaticBox(
parent=self.panel,
id=wx.ID_ANY,
label=" %s " % _("List of extensions - double-click to install"),
)
# self.repo = TextCtrl(parent=self.panel, id=wx.ID_ANY)
# modelBuilder loads data into tree model
self.modelBuilder = ExtensionTreeModelBuilder()
# tree view displays model data
self.tree = CTreeView(parent=self.panel, model=self.modelBuilder.GetModel())
self.search = SearchCtrl(self.panel)
self.search.SetDescriptiveText(_("Search"))
self.search.ShowCancelButton(True)
# load data in different thread
self.thread = gThread()
self.optionBox = StaticBox(
parent=self.panel, id=wx.ID_ANY, label=" %s " % _("Options")
)
task = gtask.parse_interface("g.extension")
ignoreFlags = ["l", "c", "g", "a", "f", "t", "help", "quiet"]
if sys.platform == "win32":
ignoreFlags.append("d")
ignoreFlags.append("i")
for f in task.get_options()["flags"]:
name = f.get("name", "")
desc = f.get("label", "")
if not desc:
desc = f.get("description", "")
if not name and not desc:
continue
if name in ignoreFlags:
continue
self.options[name] = wx.CheckBox(
parent=self.panel, id=wx.ID_ANY, label=desc
)
# defaultUrl = '' # default/official one will be used when option empty
# self.repo.SetValue(
# task.get_param(
# value='url').get(
# 'default',
# defaultUrl))
self.statusbar = self.CreateStatusBar(number=1)
# self.btnFetch = Button(parent=self.panel, id=wx.ID_ANY,
# label=_("&Fetch"))
# self.btnFetch.SetToolTip(_("Fetch list of available tools "
# "from GRASS Addons repository"))
self.btnClose = Button(parent=self.panel, id=wx.ID_CLOSE)
self.btnInstall = Button(parent=self.panel, id=wx.ID_ANY, label=_("&Install"))
self.btnInstall.SetToolTip(_("Install selected add-ons GRASS tool"))
self.btnInstall.Enable(False)
self.btnHelp = Button(parent=self.panel, id=wx.ID_HELP)
self.btnHelp.SetToolTip(_("Show g.extension manual page"))
self.btnClose.Bind(wx.EVT_BUTTON, lambda evt: self.Close())
# self.btnFetch.Bind(wx.EVT_BUTTON, self.OnFetch)
self.btnInstall.Bind(wx.EVT_BUTTON, self.OnInstall)
self.btnHelp.Bind(wx.EVT_BUTTON, self.OnHelp)
self.search.Bind(wx.EVT_TEXT, lambda evt: self.Filter(evt.GetString()))
self.search.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN, lambda evt: self.Filter(""))
self.tree.selectionChanged.connect(self.OnItemSelected)
self.tree.itemActivated.connect(self.OnItemActivated)
self.tree.contextMenu.connect(self.OnContextMenu)
wx.CallAfter(self._fetch)
self._layout()
def _layout(self):
"""Do layout"""
sizer = wx.BoxSizer(wx.VERTICAL)
# repoSizer = wx.StaticBoxSizer(self.repoBox, wx.VERTICAL)
# repo1Sizer = wx.BoxSizer(wx.HORIZONTAL)
# repo1Sizer.Add(self.repo, proportion=1,
# flag=wx.ALL | wx.ALIGN_CENTER_VERTICAL, border=1)
# repo1Sizer.Add(self.btnFetch, proportion=0,
# flag=wx.ALL | wx.ALIGN_CENTER_VERTICAL, border=1)
# repoSizer.Add(repo1Sizer,
# flag=wx.EXPAND)
sizer.Add(self.search, proportion=0, flag=wx.EXPAND | wx.ALL, border=3)
treeSizer = wx.StaticBoxSizer(self.treeBox, wx.HORIZONTAL)
treeSizer.Add(self.tree, proportion=1, flag=wx.ALL | wx.EXPAND, border=1)
# options
optionSizer = wx.StaticBoxSizer(self.optionBox, wx.VERTICAL)
for key in self.options.keys():
optionSizer.Add(self.options[key], proportion=0)
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
btnSizer.Add(self.btnHelp, proportion=0)
btnSizer.AddStretchSpacer()
btnSizer.Add(self.btnClose, proportion=0, flag=wx.RIGHT, border=5)
btnSizer.Add(self.btnInstall, proportion=0)
# sizer.Add(repoSizer, proportion=0,
# flag=wx.ALL | wx.EXPAND, border=3)
sizer.Add(
treeSizer,
proportion=1,
flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND,
border=3,
)
sizer.Add(
optionSizer,
proportion=0,
flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND,
border=3,
)
sizer.Add(btnSizer, proportion=0, flag=wx.ALL | wx.EXPAND, border=5)
self.panel.SetSizer(sizer)
sizer.Fit(self.panel)
self.Layout()
def _getCmd(self):
item = self.tree.GetSelected()
if not item or "command" not in item[0].data:
GError(_("Extension not defined"), parent=self)
return
name = item[0].data["command"]
flags = list()
for key in self.options.keys():
if self.options[key].IsChecked():
if len(key) == 1:
flags.append("-%s" % key)
else:
flags.append("--%s" % key)
# 'url=' + self.repo.GetValue().strip()]
return ["g.extension"] + flags + ["extension={}".format(name)]
def OnFetch(self, event):
"""Fetch list of available extensions"""
self._fetch()
def _fetch(self):
"""Fetch list of available extensions"""
wx.BeginBusyCursor()
self.SetStatusText(
_("Fetching list of tools from GRASS-Addons (be patient)..."), 0
)
try:
self.thread.Run(
callable=self.modelBuilder.Load,
url="", # self.repo.GetValue().strip(),
ondone=lambda event: self._fetchDone(),
)
except GException as error:
self._fetchDone()
GError(str(error), parent=self, showTraceback=False)
def _fetchDone(self):
self.tree.RefreshItems()
nitems = len(self.modelBuilder.GetModel().SearchNodes(key="command", value="*"))
self.SetStatusText(_("%d extensions loaded") % nitems, 0)
wx.EndBusyCursor()
def Filter(self, text):
model = self.modelBuilder.GetModel()
if text:
model = model.Filtered(
key=["command", "keywords", "description"], value=text
)
self.tree.SetModel(model)
self.tree.ExpandAll()
else:
self.tree.SetModel(model)
def OnContextMenu(self, node):
if not hasattr(self, "popupID"):
self.popupID = dict()
for key in ("install", "help"):
self.popupID[key] = NewId()
data = node.data
if data and "command" in data:
self.popupMenu = Menu()
self.popupMenu.Append(self.popupID["install"], _("Install"))
self.Bind(wx.EVT_MENU, self.OnInstall, id=self.popupID["install"])
self.popupMenu.AppendSeparator()
self.popupMenu.Append(self.popupID["help"], _("Show manual page"))
self.Bind(wx.EVT_MENU, self.OnItemHelp, id=self.popupID["help"])
self.PopupMenu(self.popupMenu)
self.popupMenu.Destroy()
def OnItemActivated(self, node):
data = node.data
if data and "command" in data:
self.OnInstall(event=None)
def OnInstall(self, event):
"""Install selected extension"""
log = self.parent.GetLogWindow()
cmd = self._getCmd()
if cmd:
log.RunCmd(cmd, onDone=self.OnDone)
def OnDone(self, event):
if event.returncode == 0:
if not os.getenv("GRASS_ADDON_BASE"):
SetAddOnPath(key="BASE")
globalvar.UpdateGRASSAddOnCommands()
toolboxesOutdated()
def OnItemHelp(self, event):
item = self.tree.GetSelected()
if not item or "command" not in item[0].data:
return
self._giface.Help(entry=item[0].data["command"], online=True)
def OnHelp(self, event):
self._giface.Help(entry="g.extension")
def OnItemSelected(self, node):
"""Item selected"""
data = node.data
if data is None:
self.SetStatusText("", 0)
self.btnInstall.Enable(False)
else:
self.SetStatusText(data.get("description", ""), 0)
self.btnInstall.Enable(True)
class ExtensionTreeModelBuilder:
"""Tree model of available extensions."""
def __init__(self):
self.mainNodes = dict()
self.model = TreeModel(ModuleNode)
for prefix in (
"display",
"database",
"general",
"imagery",
"misc",
"postscript",
"paint",
"raster",
"raster3D",
"sites",
"temporal",
"vector",
"wxGUI",
"other",
):
node = self.model.AppendNode(parent=self.model.root, label=prefix)
self.mainNodes[prefix] = node
def GetModel(self):
return self.model
def _emptyTree(self):
"""Remove modules from tree keeping the main structure"""
for node in self.mainNodes.values():
for child in reversed(node.children):
self.model.RemoveNode(child)
def _expandPrefix(self, c):
name = {
"d": "display",
"db": "database",
"g": "general",
"i": "imagery",
"m": "misc",
"ps": "postscript",
"p": "paint",
"r": "raster",
"r3": "raster3D",
"s": "sites",
"t": "temporal",
"v": "vector",
"wx": "wxGUI",
"": "other",
}
if c in name:
return name[c]
return c
def Load(self, url, full=True):
"""Load list of extensions"""
self._emptyTree()
if full:
flags = "g"
else:
flags = "l"
retcode, ret, msg = RunCommand(
"g.extension", read=True, getErrorMsg=True, url=url, flags=flags, quiet=True
)
if retcode != 0:
raise GException(_("Unable to load extensions. %s") % msg)
currentNode = None
for line in ret.splitlines():
if full:
try:
key, value = line.split("=", 1)
except ValueError:
key = "name"
value = line
if key == "name":
try:
prefix, name = value.split(".", 1)
except ValueError:
prefix = ""
name = value
mainNode = self.mainNodes[self._expandPrefix(prefix)]
currentNode = self.model.AppendNode(parent=mainNode, label=value)
currentNode.data = {"command": value}
else:
if currentNode is not None:
currentNode.data[key] = value
else:
try:
prefix, name = line.strip().split(".", 1)
except ValueError:
prefix = ""
name = line.strip()
if self._expandPrefix(prefix) == prefix:
prefix = ""
module = prefix + "." + name
mainNode = self.mainNodes[self._expandPrefix(prefix)]
currentNode = self.model.AppendNode(parent=mainNode, label=module)
currentNode.data = {
"command": module,
"keywords": "",
"description": "",
}
class ManageExtensionWindow(wx.Frame):
def __init__(
self,
parent,
id=wx.ID_ANY,
title=_("Manage installed GRASS Addons extensions"),
**kwargs,
):
self.parent = parent
wx.Frame.__init__(self, parent=parent, id=id, title=title, **kwargs)
self.SetIcon(
wx.Icon(os.path.join(globalvar.ICONDIR, "grass.ico"), wx.BITMAP_TYPE_ICO)
)
self.panel = wx.Panel(parent=self, id=wx.ID_ANY)
self.extBox = StaticBox(
parent=self.panel,
id=wx.ID_ANY,
label=" %s " % _("List of installed extensions"),
)
self.extList = CheckListExtension(parent=self.panel)
# buttons
self.btnUninstall = Button(
parent=self.panel, id=wx.ID_REMOVE, label=_("Uninstall")
)
self.btnUninstall.SetToolTip(_("Uninstall selected Addons extensions"))
self.btnUpdate = Button(
parent=self.panel, id=wx.ID_REFRESH, label=_("Reinstall")
)
self.btnUpdate.SetToolTip(_("Reinstall selected Addons extensions"))
self.btnClose = Button(parent=self.panel, id=wx.ID_CLOSE)
self.btnUninstall.Bind(wx.EVT_BUTTON, self.OnUninstall)
self.btnUpdate.Bind(wx.EVT_BUTTON, self.OnUpdate)
self.btnClose.Bind(wx.EVT_BUTTON, lambda evt: self.Close())
self._layout()
def _layout(self):
"""Do layout"""
sizer = wx.BoxSizer(wx.VERTICAL)
extSizer = wx.StaticBoxSizer(self.extBox, wx.HORIZONTAL)
extSizer.Add(self.extList, proportion=1, flag=wx.ALL | wx.EXPAND, border=1)
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
btnSizer.Add(self.btnClose, proportion=0, flag=wx.RIGHT, border=5)
btnSizer.Add(self.btnUpdate, proportion=0, flag=wx.RIGHT, border=5)
btnSizer.Add(self.btnUninstall, proportion=0)
sizer.Add(extSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=3)
sizer.Add(btnSizer, proportion=0, flag=wx.ALIGN_RIGHT | wx.ALL, border=5)
self.panel.SetSizer(sizer)
sizer.Fit(self.panel)
self.Layout()
def _getSelectedExtensions(self):
eList = self.extList.GetExtensions()
if not eList:
GMessage(_("No extension selected. " "Operation canceled."), parent=self)
return []
return eList
def OnUninstall(self, event):
"""Uninstall selected extensions"""
eList = self._getSelectedExtensions()
if not eList:
return
for ext in eList:
files = RunCommand(
"g.extension",
parent=self,
read=True,
quiet=True,
extension=ext,
operation="remove",
).splitlines()
if len(files) > 10:
files = files[:10]
files.append("...")
dlg = wx.MessageDialog(
parent=self,
message=_(
"List of files to be removed:\n%(files)s\n\n"
"Do you want really to remove <%(ext)s> extension?"
)
% {"files": os.linesep.join(files), "ext": ext},
caption=_("Remove extension"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION,
)
if dlg.ShowModal() == wx.ID_YES:
RunCommand(
"g.extension",
flags="f",
parent=self,
quiet=True,
extension=ext,
operation="remove",
)
self.extList.LoadData()
# update prompt
globalvar.UpdateGRASSAddOnCommands(eList)
toolboxesOutdated()
def OnUpdate(self, event):
"""Update selected extensions"""
eList = self._getSelectedExtensions()
if not eList:
return
log = self.parent.GetLogWindow()
for ext in eList:
log.RunCmd(["g.extension", "extension=%s" % ext, "operation=add"])
class CheckListExtension(GListCtrl):
"""List of mapset/owner/group"""
def __init__(self, parent):
GListCtrl.__init__(self, parent)
# load extensions
self.InsertColumn(0, _("Extension"))
self.LoadData()
def LoadData(self):
"""Load data into list"""
self.DeleteAllItems()
for ext in RunCommand(
"g.extension", quiet=True, parent=self, read=True, flags="a"
).splitlines():
if ext:
self.InsertItem(self.GetItemCount(), ext)
def GetExtensions(self):
"""Get extensions to be un-installed"""
extList = list()
for i in range(self.GetItemCount()):
if self.IsItemChecked(i):
name = self.GetItemText(i)
if name:
extList.append(name)
return extList
|