Source code for scipion.install.plugin_manager

# **************************************************************************
# *
# * Authors:    Yunior C. Fonseca Reyna (cfonseca@cnb.csic.es)
# *
# * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
# *
# * This program is free software; you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation; either version 3 of the License, or
# * (at your option) any later version.
# *
# * This program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with this program; if not, write to the Free Software
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# * 02111-1307  USA
# *
# *  All comments concerning this program package may be sent to the
# *  e-mail address 'scipion@cnb.csic.es'
# *
# **************************************************************************

from tkinter import *
import threading

from pyworkflow.gui.project import ProjectManagerWindow
from pyworkflow.project import MenuConfig
from pyworkflow.utils.log import ScipionLogger
from pyworkflow.gui import *
import pyworkflow.gui.dialog as pwgui
from scipion.install.plugin_funcs import PluginRepository, PluginInfo, NULL_VERSION

from pyworkflow.utils.properties import *
from pyworkflow.utils import redStr

PLUGIN_LOG_NAME = 'Plugin.log'
PLUGIN_ERRORS_LOG_NAME = 'Plugin.err'

pluginRepo = PluginRepository()
pluginDict = None


[docs]class PluginTree(ttk.Treeview): """ Treeview widget with checkboxes left of each item. The checkboxes are done via the image attribute of the item, so to keep the checkbox, you cannot add an image to the item. """ def __init__(self, master=None, **kw): ttk.Treeview.__init__(self, master, **kw) self.im_checked = gui.getImage(Icon.CHECKED) self.im_unchecked = gui.getImage(Icon.UNCHECKED) self.im_install = gui.getImage(Icon.INSTALL) self.im_uninstall = gui.getImage(Icon.UNINSTALL) self.im_to_install = gui.getImage(Icon.TO_INSTALL) self.im_installed = gui.getImage(Icon.INSTALLED) self.im_processing = gui.getImage(Icon.PROCESSING) self.im_failure = gui.getImage(Icon.FAILURE) self.im_availableRelease = gui.getImage(Icon.CHECKED) self.im_to_update = gui.getImage(Icon.TO_UPDATE) self.im_undo = gui.getImage(Icon.ACTION_UNDO) self.im_success = gui.getImage(Icon.INSTALLED) self.im_errors = gui.getImage(Icon.FAILURE) self.im_pluginName = gui.getImage(Icon.PLUGIN_PACKAGE) self.im_pluginVersion = gui.getImage(Icon.PLUGIN_VERSION) self.im_pluginReleaseDate = gui.getImage(Icon.PLUGIN_RELEASE_DATE) self.im_pluginDescription = gui.getImage(Icon.PLUGIN_DESCRIPTION) self.im_pluginUrl = gui.getImage(Icon.HOME) self.im_pluginAuthors = gui.getImage(Icon.PLUGIN_AUTHORS) standardFont = getDefaultFont() self.tag_configure(PluginStates.UNCHECKED, image=self.im_unchecked, font=standardFont) self.tag_configure(PluginStates.CHECKED, image=self.im_checked, font=standardFont) self.tag_configure(PluginStates.INSTALL, image=self.im_install, font=standardFont) self.tag_configure(PluginStates.UNINSTALL, image=self.im_uninstall, font=standardFont) self.tag_configure(PluginStates.TO_INSTALL, image=self.im_to_install, font=standardFont) self.tag_configure(PluginStates.INSTALLED, image=self.im_installed, font=standardFont) self.tag_configure(PluginStates.PRECESSING, image=self.im_processing, font=standardFont) self.tag_configure(PluginStates.FAILURE, image=self.im_failure, font=standardFont) self.tag_configure(PluginStates.TO_UPDATE, image=self.im_to_update, font=standardFont) self.tag_configure(PluginStates.SUCCESS, image=self.im_success, font=standardFont) self.tag_configure(PluginStates.ERRORS, image=self.im_errors, font=standardFont) self.tag_configure(PluginInformation.PLUGIN_URL, image=self.im_pluginUrl, font=standardFont, foreground='blue') self.tag_configure(PluginInformation.PLUGIN_NAME, image=self.im_pluginName, font=standardFont) self.tag_configure(PluginInformation.PLUGIN_VERSION, image=self.im_pluginVersion, font=standardFont) self.tag_configure(PluginInformation.PLUGIN_RELEASE_DATE, image=self.im_pluginReleaseDate, font=standardFont) self.tag_configure(PluginInformation.PLUGIN_DESCRIPTION, image=self.im_pluginDescription, font=standardFont) self.tag_configure(PluginInformation.PLUGIN_AUTHORS, image=self.im_pluginAuthors, font=standardFont) toUpdateFont = getNamedFont(FONT_BOLD) self.tag_configure(PluginStates.AVAILABLE_RELEASE, image=self.im_availableRelease, font=toUpdateFont) self.selectedItem = None
[docs] def insert(self, parent, index, iid=None, **kw): """ same method as for standard treeview but add the tag 'unchecked' automatically if no tag among ('checked', 'unchecked') is given """ if "tags" not in kw: kw["tags"] = (PluginStates.UNCHECKED,) elif not (PluginStates.UNCHECKED in kw["tags"] or PluginStates.CHECKED in kw["tags"] or PluginStates.TO_INSTALL in kw["tags"] or PluginStates.INSTALLED in kw["tags"] or PluginStates.INSTALL in kw["tags"] or PluginStates.AVAILABLE_RELEASE in kw["tags"] or PluginStates.TO_UPDATE in kw["tags"] or PluginStates.SUCCESS in kw["tags"] or PluginStates.FAILURE in kw["tags"] or PluginStates.ERRORS in kw["tags"] or PluginInformation.PLUGIN_NAME in kw['tags'] or PluginInformation.PLUGIN_VERSION in kw['tags'] or PluginInformation.PLUGIN_RELEASE_DATE in kw['tags'] or PluginInformation.PLUGIN_DESCRIPTION in kw['tags'] or PluginInformation.PLUGIN_URL in kw['tags'] or PluginInformation.PLUGIN_AUTHORS in kw['tags']): kw["tags"] = (PluginStates.UNCHECKED,) ttk.Treeview.insert(self, parent, index, iid, **kw)
[docs] def check_item(self, item): """ check the box of item and change the state of the boxes of item's ancestors accordingly """ if PluginStates.UNCHECKED in self.item(item, 'tags'): self.item(item, tags=(PluginStates.INSTALL,)) elif PluginStates.TO_UPDATE in self.item(item, 'tags'): self.item(item, tags=(PluginStates.AVAILABLE_RELEASE,)) else: self.item(item, tags=(PluginStates.CHECKED,))
[docs] def uncheck_item(self, item): """ uncheck the boxes of item's descendant """ if (PluginStates.CHECKED in self.item(item, 'tags') or PluginStates.AVAILABLE_RELEASE in self.item(item, 'tags')): self.item(item, tags=(PluginStates.UNINSTALL,)) children = self.get_children(item) for iid in children: self.delete(iid) else: self.item(item, tags=(PluginStates.UNCHECKED,))
[docs] def update_item(self, item): """ change the boxes item to update item's """ if PluginStates.AVAILABLE_RELEASE in self.item(item, 'tags'): self.item(item, tags=(PluginStates.TO_UPDATE,))
[docs] def processing_item(self, item): """change the box item to processing item""" self.item(item, tags=(PluginStates.PRECESSING,))
[docs] def installed_item(self, item): """change the box item to processing item""" self.item(item, tags=(PluginStates.INSTALLED,))
[docs] def failure_item(self, item): """change the box item to failure item""" self.item(item, tags=(PluginStates.FAILURE,))
[docs] def disable(self): self.state(('disabled',))
[docs] def enable(self): self.state(('!disabled',))
[docs] def is_disabled(self): return 'disabled' in self.state()
[docs] def is_enabled(self): return not self.is_disabled()
[docs]class Operation: """ This class contain the object(plugin/binary) operation details """ def __init__(self, objName, objType=PluginStates.PLUGIN, objStatus=PluginStates.INSTALL, objParent=None): self.objName = objName self.objText = objName.split('[')[0] self.objType = objType self.objStatus = objStatus self.objParent = objParent
[docs] def getObjName(self): """ Get the object(plugin/binary) name """ return self.objName
[docs] def getObjText(self): """ Get the object(plugin/binary) text """ return self.objText
[docs] def getObjType(self): """ Get the object type (plugin or binary) """ return self.objType
[docs] def getObjStatus(self): """ Get the object status (installed, uninstalled, to install,...) """ return self.objStatus
[docs] def setObjStatus(self, status): """ Set the object status """ self.objStatus = status
[docs] def getObjParent(self): """ Get the object parent in the tree. If the object is a bynary, this method return None """ return self.objParent
[docs] def runOperation(self, processors, handleBins=True): """ This method install or uninstall a plugin/binary operation :param processors: number of processors to compilation :param handleBins: deal with binaries installation/uninstallation if true (default) """ if self.objType == PluginStates.PLUGIN: if (self.objStatus == PluginStates.INSTALL or self.objStatus == PluginStates.TO_UPDATE): plugin = pluginDict.get(self.objName, None) if plugin is not None: installed = plugin.installPipModule() if installed and handleBins: plugin.installBin({'args': ['-j', processors]}) elif self.objStatus == PluginStates.UNINSTALL: plugin = PluginInfo(self.objName, self.objName, remote=False) if plugin is not None: if handleBins: plugin.uninstallBins() plugin.uninstallPip() else: plugin = PluginInfo(self.objParent, self.objParent, remote=False) if self.objStatus == PluginStates.INSTALL: plugin.installBin({'args': [self.objText, '-j', processors]}) else: plugin.uninstallBins([self.objText])
[docs]class OperationList: """ This class contain a plugins/binaries operations list and allow execute it """ def __init__(self): self.operationList = []
[docs] def insertOperation(self, operation): """ This method insert into the list a given operation. If the operation was inserted previously is eliminated """ index = self.operationIndex(operation) if index is not None: self.removeOperation(index) else: tag = PluginStates.UNINSTALL if operation.getObjStatus() == PluginStates.UNCHECKED: tag = PluginStates.INSTALL elif operation.getObjStatus() == PluginStates.TO_UPDATE: tag = PluginStates.TO_UPDATE operation.setObjStatus(tag) self.operationList.append(operation)
[docs] def removeOperation(self, index): """ Remove an operation from the list based on an index """ self.operationList.pop(index)
[docs] def operationIndex(self, operation): """ Returns the index of an operation within the list """ index = None for i in range(0, len(self.operationList)): if self.operationList[i].getObjName() == operation.getObjName(): return i return index
[docs] def getOperations(self, op): """ Return the operation List. If the operation is not None return a list with only the operation op """ if op is None: return self.operationList else: return [self.getOperationByName(op.getObjName())]
[docs] def getOperationByName(self, opName): """ Return an operation that match with a given name """ operation = [op for op in self.operationList if op.getObjName() == opName] if len(operation): return operation[0] return None
[docs] def applyOperations(self): """ Execute a operation list """ for op in self.operationList: op.runOperation()
[docs] def clearOperations(self): """ Clear the operation List """ del self.operationList[:]
[docs]class PluginBrowser(tk.Frame): """ This class will implement a frame. It will display a list of plugin at the left panel. A TreeProvider will be used to populate the list (Tree). At the right panel provide a plugin/binary information(top panel) and a list of operation (bottom panel) """ def __init__(self, master, **args): tk.Frame.__init__(self, master, **args) self._lastSelected = None self.operationList = OperationList() gui.configureWeigths(self) # Creating the layout where all application elements will be placed parentFrame = tk.Frame(master) parentFrame.grid(row=0, column=0, sticky='news') gui.configureWeigths(parentFrame, 1) self._lunchProgressBar(master) self._fillPluginManagerGui(parentFrame) def _lunchProgressBar(self, parent): self.progressbarLabel = ttk.Label(parent, text='Loading Plugins...', background='white') self.progressbarLabel.place(x=480, y=65, width=200) self.progressbar = ttk.Progressbar(parent) self.progressbar.place(x=450, y=85 + cfgFontSize, width=200) self.progressbar.step(1) self.progressbar.start(200) def _closeProgressBar(self): self.progressbar.stop() self.progressbar.destroy() self.progressbarLabel.destroy() def _fillPluginManagerGui(self, parentFrame): """ Fill the Plugin Manager GUI """ # The main layout will be two panes: # At the left containing the plugin list # and the right containing a description and the operation list mainFrame = tk.PanedWindow(parentFrame, orient=tk.HORIZONTAL) mainFrame.grid(row=1, column=0, sticky='news') # --------------------------------------------------------------- # Left Panel leftPanel = tk.Frame(mainFrame) # Create a left panel to put the tree leftPanel.grid(row=0, column=0, padx=0, pady=0, sticky='news') self._fillLeftPanel(leftPanel) # Fill the left panel # --------------------------------------------------------------- # Right Panel: will be two vertical panes # At the Top contain the plugin or binary information # At the Bottom contain a tab widget with an operation list and # a system terminal that show the operation steps rightPanel = tk.PanedWindow(mainFrame, orient=tk.VERTICAL) rightPanel.grid(row=0, column=1, padx=0, pady=0, sticky='news') # Top Panel # Panel to put the plugin information topPanel = ttk.Frame(rightPanel) topPanel.pack(side=TOP, fill=BOTH, expand=Y) topPanel.configure(cursor='hand1') self._createRightTopPanel(topPanel) # Bottom Panel # This section show the plugin operation and a console bottomPanel = ttk.Frame(rightPanel) tabControl = ttk.Notebook(bottomPanel) # Create Tab Control tabControl.grid(row=1, column=0, sticky='news') operationTab = ttk.Frame(tabControl) # Create a operation tab operationTab.grid(row=0, column=0, padx=0, pady=0) self._fillRightBottomOperationsPanel(operationTab) consoleTab = ttk.Frame(tabControl) # Create a console self._fillRightBottomOutputLogPanel(consoleTab) tabControl.add(operationTab, text='Operations') # Add the Operation tab tabControl.add(consoleTab, text='Output Log') tabControl.pack(expand=1, fill="both") # Pack to make visible # Add the widgets to Right Panel rightPanel.add(topPanel, padx=0, pady=0) rightPanel.add(bottomPanel, padx=0, pady=0) # Add the Plugin list at left mainFrame.add(leftPanel, padx=0, pady=0) mainFrame.paneconfig(leftPanel, minsize=200) # Add the Plugins or Binaries information and Operation list at right mainFrame.add(rightPanel, padx=0, pady=0) mainFrame.paneconfig(rightPanel, minsize=200) def _fillToolbar(self, frame): """ Fill the toolbar frame with some buttons. """ self._col = 0 self.executeOpsBtn = self._addButton(frame, '', Icon.TO_INSTALL, Message.EXECUTE_PLUGINS_MANAGER_OPERATION, 'disable', self._applyAllOperations) self.cancelOpsBtn = self._addButton(frame, '', Icon.DELETE_OPERATION, Message.CANCEL_SELECTED_OPERATION, 'disable', self._deleteSelectedOperation) # Add option to cancel binaries installation self._col += 1 self.skipBinaries = tk.BooleanVar() self.skipBinaries.set(False) installBinsEntry = tk.Checkbutton(frame, variable=self.skipBinaries, font=getDefaultFont(), text="Skip binaries") installBinsEntry.grid(row=0, column=self._col, sticky='ew', padx=5) # Number of processors to use when compiling self._col += 1 tk.Label(frame, text='Number of processors:').grid(row=0, column=self._col, padx=5) self._col += 1 self.numberProcessors = tk.StringVar() self.numberProcessors.set('4') processorsEntry = tk.Entry(frame, textvariable=self.numberProcessors, font=getDefaultFont()) processorsEntry.grid(row=0, column=self._col, sticky='ew', padx=5) def _addButton(self, frame, text, image, tooltip, state, command): btn = IconButton(frame, text, image, command=command, tooltip=tooltip, bg=None) btn.config(relief="flat", activebackground=None, compound='left', fg='black', overrelief="raised", state=state) btn.bind('<Button-1>', command) btn.grid(row=0, column=self._col, sticky='nw', padx=3, pady=7) self._col += 1 return btn def _getStandardTreeStyle(self): styleName = 'style.Treeview' font = getDefaultFont() font.metrics() fontheight = font.metrics()['linespace'] style = ttk.Style() style.configure(styleName, rowheight=fontheight) return styleName def _fillLeftPanel(self, leftFrame): """ Fill the left Panel with the plugins list """ gui.configureWeigths(leftFrame) # This 5! lines are only to set the row height!! Should be centralized self.tree = PluginTree(leftFrame, show="tree", style=self._getStandardTreeStyle()) self.tree.grid(row=0, column=0, sticky='news') self.yscrollbar = ttk.Scrollbar(leftFrame, orient='vertical', command=self.tree.yview) self.yscrollbar.grid(row=0, column=1, sticky='news') self.tree.configure(yscrollcommand=self.yscrollbar.set) self.yscrollbar.configure(command=self.tree.yview) # check / uncheck boxes(plugin or binary) on right click self.tree.bind("<Button-1>", self._onPluginTreeClick, True) # add a popup menu to update a selected plugin self.popup_menu = tk.Menu(self.tree, tearoff=0) self.popup_menu.add_command(label="Update ", underline=0, image=self.tree.im_to_update, compound=tk.LEFT, command=self._updatePlugin) self.popup_menu.add_command(label="Install", underline=1, image=self.tree.im_install, compound=tk.LEFT, command=self._treeOperation) self.popup_menu.add_command(label="Uninstall", underline=2, image=self.tree.im_uninstall, compound=tk.LEFT, command=self._treeOperation) self.popup_menu.add_separator() self.popup_menu.add_command(label="Undo", underline=4, image=self.tree.im_undo, compound=tk.LEFT, command=self._treeOperation) self.tree.bind("<Button-3>", self._popup) # Button-3 on Plugin self.tree.bind("<FocusOut>", self._popupFocusOut) # Load all plugins and fill the tree view threadLoadPlugin = threading.Thread(name="loading_plugin", target=self.loadPlugins) threadLoadPlugin.start() def _popup(self, event): try: x, y, widget = event.x, event.y, event.widget self.tree.selectedItem = self.tree.identify_row(y) self.popup_menu.selection = self.tree.set( self.tree.identify_row(event.y)) tags = self.tree.item(self.tree.selectedItem, "tags") self.popup_menu.entryconfigure(0, state=tk.DISABLED) self.popup_menu.entryconfigure(1, state=tk.DISABLED) self.popup_menu.entryconfigure(2, state=tk.DISABLED) self.popup_menu.entryconfigure(4, state=tk.DISABLED) # Activate the menu if the new plugin release is available if tags[0] == PluginStates.AVAILABLE_RELEASE: self.popup_menu.entryconfigure(0, state=tk.NORMAL) elif tags[0] == PluginStates.CHECKED: self.popup_menu.entryconfigure(2, state=tk.NORMAL) elif tags[0] == PluginStates.UNCHECKED: self.popup_menu.entryconfigure(1, state=tk.NORMAL) else: self.popup_menu.entryconfigure(4, state=tk.NORMAL) self.popup_menu.post(event.x_root, event.y_root) finally: self.popup_menu.grab_release() def _popupFocusOut(self, event=None): self.popup_menu.unpost() def _updatePlugin(self): objType = self.tree.item(self.tree.selectedItem, "value") parent = self.tree.parent(self.tree.selectedItem) operation = Operation(self.tree.selectedItem, objType[0], PluginStates.TO_UPDATE, parent) self.operationList.insertOperation(operation) self.tree.update_item(self.tree.selectedItem) children = self.tree.get_children(self.tree.selectedItem) for iid in children: self.deleteOperation(iid) self.tree.delete(iid) self.showOperationList() self.executeOpsBtn.config(state='normal') def _treeOperation(self): tags = self.tree.item(self.tree.selectedItem, "tags") objType = self.tree.item(self.tree.selectedItem, "value") parent = self.tree.parent(self.tree.selectedItem) operation = Operation(self.tree.selectedItem, objType[0], tags[0], parent) self.operationList.insertOperation(operation) if tags[0] == PluginStates.UNCHECKED: self.tree.check_item(self.tree.selectedItem) elif tags[0] == PluginStates.UNINSTALL: if objType[0] == PluginStates.PLUGIN: self.reloadInstalledPlugin(self.tree.selectedItem) else: self.tree.check_item(self.tree.selectedItem) elif tags[0] == PluginStates.TO_UPDATE: self.tree.check_item(self.tree.selectedItem) self.reloadInstalledPlugin(self.tree.selectedItem) else: children = self.tree.get_children(self.tree.selectedItem) for iid in children: self.deleteOperation(iid) self.tree.uncheck_item(self.tree.selectedItem) self.showPluginInformation(self.tree.selectedItem) self.cancelOpsBtn.config(state='disable') self.showOperationList() def _createRightTopPanel(self, topPanel): """ Create a right top panel """ self.topPanelTree = PluginTree(topPanel, show='tree', cursor='hand2', style=self._getStandardTreeStyle()) self.topPanelTree.grid(row=0, column=0, sticky='news') # configure vertical scroollbar ysb = ttk.Scrollbar(topPanel, orient='vertical', command=self.topPanelTree.yview) ysb.grid(row=0, column=1, sticky='news') self.topPanelTree.configure(yscrollcommand=ysb.set) ysb.configure(command=self.topPanelTree.yview) xsb = ttk.Scrollbar(topPanel, orient='horizontal', command=self.topPanelTree.yview) xsb.grid(row=1, column=0, sticky='news') self.topPanelTree.configure(xscrollcommand=xsb.set) xsb.configure(command=self.topPanelTree.xview) topPanel.rowconfigure(0, weight=1) topPanel.columnconfigure(0, weight=1) self.topPanelTree.bind("<Button-1>", self.linkToWebSite, True) def _fillRightBottomOperationsPanel(self, panel): """ Create the Operations Tab """ gui.configureWeigths(panel) # Define a Tool Bar opPanel = tk.Frame(panel) opPanel.grid(row=0, column=0, sticky='news') gui.configureWeigths(opPanel, 1) toolBarFrame = tk.Frame(opPanel) toolBarFrame.grid(row=0, column=0, sticky=W) self._fillToolbar(toolBarFrame) gui.configureWeigths(toolBarFrame) # Fill the operation tab self.operationTree = PluginTree(opPanel, show="tree", style=self._getStandardTreeStyle()) self.operationTree.grid(row=1, column=0, sticky='news') yscrollbar = ttk.Scrollbar(opPanel, orient='vertical', command=self.operationTree.yview) yscrollbar.grid(row=1, column=1, sticky='news') self.operationTree.configure(yscrollcommand=yscrollbar.set) yscrollbar.configure(command=self.operationTree.yview) self.operationTree.bind("<Button-1>", self.operationInformation, True) def _fillRightBottomOutputLogPanel(self, panel): """ Create and fill the output log with two tabs(plugin.log and plugin.err)""" # Fill the Output Log gui.configureWeigths(panel) self.terminal = tk.Frame(panel) self.terminal.grid(row=0, column=0, sticky='news') gui.configureWeigths(self.terminal) self.Textlog = TextFileViewer(self.terminal, font=getDefaultFont(), height=10) self.Textlog.grid(row=0, column=0, sticky='news') logSufix = '_' + time.strftime("%y%m%d_%H%M%S") pluginLogName = PLUGIN_LOG_NAME + logSufix pluginErrorsLogName = PLUGIN_ERRORS_LOG_NAME + logSufix self.file_log_path = os.path.join(Config.getLogsFolder(), pluginLogName) self.file_errors_path = os.path.join(Config.getLogsFolder(), pluginErrorsLogName) self.fileLog = open(self.file_log_path, 'w') self.fileLogErr = open(self.file_errors_path, 'w') self.plug_log = ScipionLogger(self.file_log_path) self.plug_errors_log = ScipionLogger(self.file_errors_path) # Create two tabs where the log and errors will appears self.Textlog.createWidgets([self.file_log_path, self.file_errors_path]) def _onPluginTreeClick(self, event): """ check or uncheck a plugin or binary box when clicked """ if self.tree.is_enabled(): self.popup_menu.unpost() x, y, widget = event.x, event.y, event.widget elem = widget.identify("element", x, y) self.tree.selectedItem = self.tree.identify_row(y) if "image" in elem: # a box was clicked self._treeOperation() else: if self.tree.selectedItem is not None: if self.isPlugin(self.tree.item(self.tree.selectedItem, "values")[0]): self.showPluginInformation(self.tree.selectedItem) else: parent = self.tree.parent(self.tree.selectedItem) self.showPluginInformation(parent) if len(self.operationList.getOperations(None)): self.executeOpsBtn.config(state='normal') else: self.executeOpsBtn.config(state='disable') def _deleteSelectedOperation(self, e=None): """ Delete a selected operation """ if self.operationTree.selectedItem: item = self.operationTree.selectedItem operation = self.operationList.getOperationByName(item) index = self.operationList.operationIndex(operation) if index is not None: self.operationList.removeOperation(index) self.showOperationList() if PluginStates.INSTALL in self.tree.item(item, 'tags'): self.tree.item(self.operationTree.selectedItem, tags=(PluginStates.UNCHECKED,)) else: if operation.getObjType() == PluginStates.PLUGIN: self.reloadInstalledPlugin(item) else: self.reloadInstalledPlugin(self.tree.parent(item)) self.operationTree.selectedItem = None self.cancelOpsBtn.config(state='disable') if not len(self.operationList.getOperations(None)): self.executeOpsBtn.config(state='disable') def _applyAllOperations(self, event=None): """ Execute the operation list """ # Disable the execute and cancel button self.executeOpsBtn.config(state='disable') self.cancelOpsBtn.config(state='disable') # Disable the TreeView self.tree.disable() if event is not None: self.threadOp = threading.Thread(name="plugin-manager", target=self._applyOperations, args=(None,)) self.threadOp.start() self.threadRefresh = threading.Thread(name="refresh_log", target=self._refreshLogsComponent, args=(2,)) self.threadRefresh.start() def _refreshLogsComponent(self, wait=3): """ Refresh the Plugin Manager log """ import time while self.threadOp.is_alive(): time.sleep(wait) # Taking the vertical scroll position vsPos = self.Textlog.taList[0].getVScroll() if vsPos[1] == 1.0: self.Textlog.refreshAll(goEnd=True) else: self.Textlog.refreshAll(goEnd=False) def _applyOperations(self, operation=None): """ Execute one operation. If operation is None, then execute the operation list """ # Take the standard system out and errors oldstdout = sys.stdout oldstderr = sys.stderr sys.stdout = self.fileLog sys.stderr = self.fileLogErr strErr = None defaultModeMessage = 'Executing...' message = pwgui.FloatingMessage(self.operationTree, defaultModeMessage, xPos=300, yPos=20) message.show() for op in self.operationList.getOperations(operation): item = op.getObjName() try: self.operationTree.processing_item(item) op.runOperation(self.numberProcessors.get(), not self.skipBinaries.get()) self.operationTree.installed_item(item) if (op.getObjStatus() == PluginStates.INSTALL or op.getObjStatus() == PluginStates.TO_UPDATE): if op.getObjType() == PluginStates.PLUGIN: self.reloadInstalledPlugin(item) else: self.tree.check_item(item) else: self.tree.uncheck_item(item) except AssertionError as err: self.operationTree.failure_item(item) if op.getObjType() == PluginStates.BINARY: self.reloadInstalledPlugin(op.getObjParent()) else: self.reloadInstalledPlugin(item) self.operationTree.update() strErr = str('Error executing the operation: ' + op.getObjStatus() + ' ' + op.getObjName()) self.plug_log.info(redStr(strErr), False) self.plug_errors_log.error(redStr(strErr), False) self.operationList.clearOperations() sys.stdout.flush() sys.stderr.flush() sys.stdout = oldstdout sys.stderr = oldstderr # Enable the treeview self.tree.enable() message.close() text = 'FINISHED SUCCESSFULLY' tag = PluginStates.SUCCESS self.operationTree.tag_configure(PluginStates.SUCCESS, foreground='green') if strErr is not None: text = 'FINISHED WITH ERRORS' tag = PluginStates.ERRORS self.operationTree.tag_configure(PluginStates.ERRORS, foreground='red') self.operationTree.insert("", 'end', text, text=text, value=text, tags=tag)
[docs] def linkToWebSite(self, event): """ Load the plugin url """ x, y, widget = event.x, event.y, event.widget item = self.topPanelTree.selectedItem = self.topPanelTree.identify_row(y) if (len(self.topPanelTree.selectedItem) and self.topPanelTree.item(item, 'value')[0] == 'pluginUrl'): browser = webbrowser.get() browser.open(item)
[docs] def operationInformation(self, event): """Update the operationTree selected item""" x, y, widget = event.x, event.y, event.widget item = self.operationTree.selectedItem = self.operationTree.identify_row(y) if (len(item) and len(self.operationList.getOperations(None)) and self.executeOpsBtn["state"] == tk.NORMAL): self.cancelOpsBtn.config(state='normal')
[docs] def deleteOperation(self, operationName): """ Delete an operation given the object name """ for op in self.operationList.getOperations(None): if operationName == op.getObjName(): self.operationList.insertOperation(op)
[docs] def showOperationList(self): """ Shows the operation list at left bottom panel :return: """ self.operationTree.delete(*self.operationTree.get_children()) operations = self.operationList.getOperations(None) if len(operations) > 0: for op in operations: self.operationTree.insert("", 'end', op.getObjName(), text=str(op.getObjStatus().upper() + ' --> ' + op.getObjText()), tags=op.getObjStatus()) self.executeOpsBtn.config(state='normal') else: self.executeOpsBtn.config(state='disable') self.operationTree.update()
[docs] def isPlugin(self, value): return value == PluginStates.PLUGIN
[docs] def showPluginInformation(self, pluginName): """Shows the information associated with a given plugin""" plugin = pluginDict.get(pluginName, None) if plugin is not None: self.topPanelTree.delete(*self.topPanelTree.get_children()) pluginName = plugin.getPipName() pluginVersion = plugin.latestRelease if pluginVersion and pluginVersion != NULL_VERSION: pluginUploadedDate = plugin.getReleaseDate(pluginVersion) else: pluginUploadedDate = 'Not uploaded yet?' pluginDescription = plugin.getSummary() pluginUrl = plugin.getHomePage() pluginAuthor = plugin.getAuthor() self.topPanelTree.insert('', 'end', pluginName, text=' ' + pluginName, values='pluginName', tags=('pluginName',)) if PluginStates.AVAILABLE_RELEASE in self.tree.item(pluginName, 'tags'): pluginVersion = (plugin.getPipVersion() + ' *(Version ' + plugin.latestRelease + ' available. Right-click on the ' 'plugin to update it)') self.topPanelTree.tag_configure('pluginVersion', foreground=Color.RED_COLOR) else: self.topPanelTree.tag_configure('pluginVersion', foreground='black') self.topPanelTree.insert('', 'end', pluginVersion, text=' ' + pluginVersion, values='pluginVersion', tags=('pluginVersion',)) self.topPanelTree.insert('', 'end', pluginUploadedDate, text=' ' + pluginUploadedDate.split('T')[0], values='pluginUploadedDate', tags=('pluginUploadedDate',)) self.topPanelTree.insert('', 'end', pluginDescription, text=' ' + pluginDescription, values='pluginDescription', tags=('pluginDescription',)) self.topPanelTree.insert('', 'end', pluginUrl, text=' ' + pluginUrl, values='pluginUrl', tags=('pluginURL',)) self.topPanelTree.insert('', 'end', pluginAuthor, text=' ' + pluginAuthor, values='pluginAuthor', tags=('pluginAuthor',))
[docs] def reloadInstalledPlugin(self, pluginName): """ Reload a given plugin and update the tree view """ plugin = PluginInfo(pluginName, pluginName, remote=True) if plugin is not None: # Insert all binaries of plugin on the tree if plugin.isInstalled(): pluginBinaryList = plugin.getInstallenv() if pluginBinaryList is not None: binaryList = pluginBinaryList.getPackages() keys = sorted(binaryList.keys()) for k in keys: pVersions = binaryList[k] for binary, version in pVersions: installed = pluginBinaryList._isInstalled(binary, version) tag = PluginStates.UNCHECKED if installed: tag = PluginStates.CHECKED binaryName = str(binary) if version: binaryName += str('-' + version) self.tree.insert(pluginName, "end", binaryName + "[" + pluginName + "]", text=binaryName, tags=tag, values='binary') tag = PluginStates.CHECKED if plugin.latestRelease != plugin.pipVersion: tag = PluginStates.AVAILABLE_RELEASE self.tree.item(pluginName, tags=(tag,)) self.showPluginInformation(pluginName) else: if PluginStates.UNINSTALL in self.tree.item(pluginName, 'tags'): self.tree.item(pluginName, tags=(PluginStates.UNCHECKED,)) else: self.tree.item(pluginName, tags=(PluginStates.UNCHECKED,))
[docs] def loadPlugins(self): """ Load all plugins and fill the tree view widget """ global pluginDict pluginDict = pluginRepo.getPlugins(getPipData=True) pluginList = sorted(pluginDict.keys(), reverse=True) countPlugin = self.progressbar['value'] self.tree.delete(*self.tree.get_children()) self.progressbar["maximum"] = countPlugin + len(pluginList) for pluginName in pluginList: countPlugin = countPlugin + 1 self.progressbar['value'] = countPlugin plugin = PluginInfo(pluginName, pluginName, remote=False) if plugin is not None: tag = PluginStates.UNCHECKED if plugin._getPlugin(): # Insert the plugin name in the tree latestRelease = pluginDict.get(pluginName).getLatestRelease() tag = PluginStates.CHECKED if latestRelease and plugin.pipVersion != latestRelease\ and latestRelease != NULL_VERSION: tag = PluginStates.AVAILABLE_RELEASE self.tree.insert("", 0, pluginName, text=pluginName, tags=tag, values=PluginStates.PLUGIN) # Insert all binaries of plugin on the tree pluginBinaryList = plugin.getInstallenv() if pluginBinaryList is not None: binaryList = pluginBinaryList.getPackages() keys = sorted(binaryList.keys()) for k in keys: pVersions = binaryList[k] for binary, version in pVersions: installed = pluginBinaryList._isInstalled(binary, version) tag = PluginStates.UNCHECKED if installed: tag = PluginStates.CHECKED binaryName = str(binary) if version: binaryName += str('-' + version) self.tree.insert(pluginName, "end", binaryName + "[" + pluginName + "]", text=binaryName, tags=tag, values=PluginStates.BINARY) else: latestRelease = pluginDict.get(pluginName).getLatestRelease() if latestRelease != NULL_VERSION: self.tree.insert("", 0, pluginName, text=pluginName, tags=tag, values=PluginStates.PLUGIN) self._closeProgressBar() if len(self.tree.get_children()) == 0: pwgui.showInfo("No plugins loaded", "We haven't found any plugins. " "Either this is a early stage of a new release or this is a bug. " "Please, check the terminal output and contact us if you still think" " this is a bug.", self)
[docs]class PluginManagerWindow(gui.Window): """ Windows to hold a plugin manager frame inside. """ def __init__(self, title, master=None, **kwargs): if 'minsize' not in kwargs: kwargs['minsize'] = (900, 300) gui.Window.__init__(self, title, master, **kwargs) self.parent = master menu = MenuConfig() fileMenu = menu.addSubMenu('File') fileMenu.addSubMenu('Exit', 'exit', icon='fa-sign-out.png') configMenu = menu.addSubMenu('Configuration') configMenu.addSubMenu('User', 'user') configMenu.addSubMenu('Variables', 'variables') helpMenu = menu.addSubMenu('Help') helpMenu.addSubMenu('Help', 'help', icon='fa-question-circle.png') self.menuCfg = menu gui.Window.createMainMenu(self, self.menuCfg)
[docs] def onExit(self): self.close()
[docs] def onUser(self): import pyworkflow as pw ProjectManagerWindow._openConfigFile(pw.Config.SCIPION_LOCAL_CONFIG)
[docs] def onVariables(self): if pluginDict is not None: msg = "" pluginsVars = dict() for plugin in pluginDict.values(): if plugin.isInstalled(): pluginsVars.update(plugin.getPluginClass().getVars()) sortedVars = sorted(pluginsVars) if sortedVars: for var in sortedVars: msg = msg + '{} = {}\n'.format(var, pluginsVars[var]) else: msg = "There are no variables to display" pwgui.showInfo("Plugin variables", msg, tk.Frame())
[docs] def onHelp(self): PluginHelp('Plugin manager glossary', self).show()
[docs] def close(self, e=None): sys.exit()
[docs]class PluginHelp(gui.Window): """ Windows to hold a plugin manager help """ def __init__(self, title, master=None, **kwargs): if 'minsize' not in kwargs: kwargs['minsize'] = (500, 300) gui.Window.__init__(self, title, master, **kwargs) self.root.resizable(0, 0) self.createHelp()
[docs] def createHelp(self): helpFrame = tk.Frame(self.root) helpFrame.grid(row=0, column=0, sticky='news') photo = PhotoImage(file=pw.findResource(Icon.CHECKED)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=0, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='INSTALLED Plugin/Binary') btn.grid(row=0, column=1, sticky='sw', padx=0, pady=5) photo = PhotoImage(file=pw.findResource(Icon.UNCHECKED)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=1, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='UNINSTALLED Plugin/Binary') btn.grid(row=1, column=1, sticky='sw', padx=0, pady=5) photo = PhotoImage(file=pw.findResource(Icon.INSTALL)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=2, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='Plugin/Binary TO INSTALL') btn.grid(row=2, column=1, sticky='sw', padx=0, pady=5) photo = PhotoImage(file=pw.findResource(Icon.UNINSTALL)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=3, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='Plugin/Binary TO UNINSTALL') btn.grid(row=3, column=1, sticky='sw', padx=0, pady=5) photo = PhotoImage(file=pw.findResource(Icon.TO_INSTALL)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=4, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='Execute the selected operations') btn.grid(row=4, column=1, sticky='sw', padx=0, pady=5) photo = PhotoImage(file=pw.findResource(Icon.DELETE_OPERATION)) btn = Label(helpFrame, image=photo) btn.photo = photo btn.grid(row=5, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='Cancel a selected operation') btn.grid(row=5, column=1, sticky='sw', padx=0, pady=5) btn = Label(helpFrame, text='(Right Click) ') btn.grid(row=6, column=0, sticky='sw', padx=10, pady=5) btn = Label(helpFrame, text='Apply an operation to the selected plugin') btn.grid(row=6, column=1, sticky='sw', padx=0, pady=5)
[docs]class PluginManager(PluginManagerWindow): """ Windows to hold a frame inside. """ def __init__(self, title, master=None, **kwargs): PluginManagerWindow.__init__(self, title, master, **kwargs) browser = PluginBrowser(self.root, **kwargs)
[docs]def main(): PluginManager("Plugin manager", None).show()
if __name__ == '__main__': main()