#!/usr/bin/env python # coding:utf-8 import logging from threading import Thread import os from PySide2.QtCore import Slot, QJsonValue, QObject, QUrl, Property, Signal from meshroom.common.qt import QObjectListModel from meshroom.core import graph from meshroom.ui import commands class ChunksMonitor(QObject): """ ChunksMonitor regularly check NodeChunks' status files for modification and trigger their update on change. When working locally, status changes are reflected through the emission of 'statusChanged' signals. But when a graph is being computed externally - either via a Submitter or on another machine, NodeChunks status files are modified by another instance, potentially outside this machine file system scope. Same goes when status files are deleted/modified manually. Thus, for genericity, monitoring is based on regular polling and not file system watching. """ def __init__(self, chunks=(), parent=None): super(ChunksMonitor, self).__init__(parent) self.chunkByStatusFile = dict() self.lastModificationRecords = dict() self.setChunks(chunks) # Check status files every x seconds # TODO: adapt frequency according to graph compute status self.startTimer(5000) def setChunks(self, chunks): """ Set the list of chunks to monitor. """ self.clear() for chunk in chunks: f = chunk.statusFile() self.chunkByStatusFile[f] = chunk # For local use, handle statusChanged emitted directly from the node chunk chunk.statusChanged.connect(lambda ch=chunk: self.onChunkStatusChanged(chunk)) self.lastModificationRecords[f] = os.path.getmtime(f) if os.path.exists(f) else -1 self.chunkStatusChanged.emit(None, -1) def clear(self): """ Clear the list of monitored chunks""" self.chunkByStatusFile.clear() self.lastModificationRecords.clear() def timerEvent(self, evt): self.checkFileTimes() def onChunkStatusChanged(self, chunk): """ React to change of status coming from the NodeChunk itself. Args: chunk (graph.NodeChunk): the chunk that emitted statusChanged signal """ f = chunk.statusFile() assert f in self.lastModificationRecords # Update record entry for this file so that it's up-to-date on next timerEvent self.lastModificationRecords[f] = self.getFileLastModTime(f) self.chunkStatusChanged.emit(chunk, chunk.status.status) @staticmethod def getFileLastModTime(f): """ Return 'mtime' of the file if it exists, -1 otherwise. """ return os.path.getmtime(f) if os.path.exists(f) else -1 def checkFileTimes(self): """ Check status files last modification time and compare with stored value """ for f, t in self.lastModificationRecords.items(): lastMod = self.getFileLastModTime(f) if lastMod != t: self.lastModificationRecords[f] = lastMod self.chunkByStatusFile[f].updateStatusFromCache() logging.debug("Status for node {} changed: {}".format(self.chunkByStatusFile[f].node, self.chunkByStatusFile[f].status.status)) def isLocked(self): return any([ch.status.status in (graph.Status.RUNNING, graph.Status.SUBMITTED) for ch in self.chunkByStatusFile.values()]) chunkStatusChanged = Signal(graph.NodeChunk, int) class UIGraph(QObject): """ High level wrapper over core.Graph, with additional features dedicated to UI integration. UIGraph exposes undoable methods on its graph and computation in a separate thread. It also provides a monitoring of all its computation units (NodeChunks). """ def __init__(self, filepath='', parent=None): super(UIGraph, self).__init__(parent) self._undoStack = commands.UndoStack(self) self._graph = graph.Graph('', self) self._chunksMonitor = ChunksMonitor(parent=self) self._chunksMonitor.chunkStatusChanged.connect(self.onChunkStatusChanged) self._computeThread = Thread() self._orderedChunks = QObjectListModel(parent=self) self._running = self._submitted = False if filepath: self.load(filepath) def setGraph(self, g): """ Set the internal graph. """ if self._graph: self.clear() self._graph = g self._graph.updated.connect(self.onGraphUpdated) self._graph.update() self.graphChanged.emit() def onGraphUpdated(self): """ Callback to any kind of graph modification. """ # TODO: handle this with a better granularity # TODO: make sure the list of chunks has changed before resetting it chunks = self._graph.getOrderedChunks() self._orderedChunks.setObjectList(chunks) self._chunksMonitor.setChunks(chunks) def clear(self): if self._graph: self._graph.deleteLater() self._graph = None self._undoStack.clear() def load(self, filepath): g = graph.Graph('') g.load(filepath) if not os.path.exists(g.cacheDir): os.mkdir(g.cacheDir) self.setGraph(g) @Slot(QUrl) def loadUrl(self, url): self.load(url.toLocalFile()) @Slot(QUrl) def saveAs(self, url): self._graph.save(url.toLocalFile()) self._undoStack.setClean() @Slot() def save(self): self._graph.save() self._undoStack.setClean() @Slot(graph.Node) def execute(self, node=None): if self.computing: return nodes = [node] if node else None self._computeThread = Thread(target=self._execute, args=(nodes,)) self._computeThread.start() def _execute(self, nodes): self.computeStatusChanged.emit() try: graph.execute(self._graph, nodes) except Exception as e: logging.error("Error during Graph execution {}".format(e)) finally: self.computeStatusChanged.emit() @Slot() def stopExecution(self): if not self.isComputingLocally(): return self._graph.stopExecution() self._computeThread.join() self.computeStatusChanged.emit() @Slot() def submit(self): """ Submit the whole graph to the default Submitter. """ self.save() # graph must be saved before being submitted graph.submitGraph(self._graph, os.environ.get('MESHROOM_DEFAULT_SUBMITTER', '')) def onChunkStatusChanged(self, chunk, status): # update graph computing status running = any([ch.status.status == graph.Status.RUNNING for ch in self._orderedChunks]) submitted = any([ch.status.status == graph.Status.SUBMITTED for ch in self._orderedChunks]) if self._running != running or self._submitted != submitted: self._running = running self._submitted = submitted self.computeStatusChanged.emit() def isComputing(self): """ Whether is graph is being computed, either locally or externally. """ return self.isComputingLocally() or self.isComputingExternally() def isComputingExternally(self): """ Whether this graph is being computed externally. """ return (self._running or self._submitted) and not self.isComputingLocally() def isComputingLocally(self): """ Whether this graph is being computed locally (i.e computation can be stopped). """ return self._computeThread.is_alive() def push(self, command): """ Try and push the given command to the undo stack. Args: command (commands.UndoCommand): the command to push """ self._undoStack.tryAndPush(command) def groupedGraphModification(self, title): """ Get a GroupedGraphModification for this Reconstruction. Args: title (str): the title of the macro command Returns: GroupedGraphModification: the instantiated context manager """ return commands.GroupedGraphModification(self._graph, self._undoStack, title) @Slot(str) def addNode(self, nodeType): self.push(commands.AddNodeCommand(self._graph, nodeType)) @Slot(graph.Node) def removeNode(self, node): self.push(commands.RemoveNodeCommand(self._graph, node)) @Slot(graph.Attribute, graph.Attribute) def addEdge(self, src, dst): if isinstance(dst, graph.ListAttribute): with self.groupedGraphModification("Insert and Add Edge on {}".format(dst.fullName())): self.appendAttribute(dst) self.push(commands.AddEdgeCommand(self._graph, src, dst[-1])) else: self.push(commands.AddEdgeCommand(self._graph, src, dst)) @Slot(graph.Edge) def removeEdge(self, edge): if isinstance(edge.dst.root, graph.ListAttribute): with self.groupedGraphModification("Remove Edge and Delete {}".format(edge.dst.fullName())): self.push(commands.RemoveEdgeCommand(self._graph, edge)) self.removeAttribute(edge.dst) else: self.push(commands.RemoveEdgeCommand(self._graph, edge)) @Slot(graph.Attribute, "QVariant") def setAttribute(self, attribute, value): self.push(commands.SetAttributeCommand(self._graph, attribute, value)) @Slot(graph.Attribute, QJsonValue) def appendAttribute(self, attribute, value=QJsonValue()): if value.isArray(): pyValue = value.toArray().toVariantList() else: pyValue = None if value.isNull() else value.toObject() self.push(commands.ListAttributeAppendCommand(self._graph, attribute, pyValue)) @Slot(graph.Attribute) def removeAttribute(self, attribute): self.push(commands.ListAttributeRemoveCommand(self._graph, attribute)) undoStack = Property(QObject, lambda self: self._undoStack, constant=True) graphChanged = Signal() graph = Property(graph.Graph, lambda self: self._graph, notify=graphChanged) computeStatusChanged = Signal() computing = Property(bool, isComputing, notify=computeStatusChanged) computingExternally = Property(bool, isComputingExternally, notify=computeStatusChanged) computingLocally = Property(bool, isComputingLocally, notify=computeStatusChanged) chunksMonitor = Property(ChunksMonitor, lambda self: self._chunksMonitor, constant=True) # The list of NodeChunks in this graph sorted by processing order orderedChunks = Property(QObject, lambda self: self._orderedChunks, constant=True) lockedChanged = Signal()