Initial commit

This is a quite large commit containing:

 * The main extension that runs and initializes Python
 * Some (example) bindings
 * An initial build script for the main extension
 * Optional binding and examples of how to create them
 * An initial build script for the optional bindings
 * A simple extension manager written in Python
 * A few example Python extensions
 * Some documentation (both in the code and as markdown files)
 * A collection of helpful python scripts
 * A small collection of unit tests
 * A TODO list

For any additional details the code / docs should be consulted.

Change-Id: I3937886cfefa2f64d5a78013889a8e097eec8261
Reviewed-by: Eike Ziller <eike.ziller@qt.io>

4 files changed, 288 insertions, 0 deletions

diff --git a/python/extensionmanager/actions.py b/python/extensionmanager/actions.py
new file mode 100644
index 0000000..0efaae4
--- /dev/null
+++ b/python/extensionmanager/actions.py
@@ -0,0 +1,72 @@
+#############################################################################
+##
+## Copyright (C) 2018 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Python Extensions Plugin for QtCreator.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+# Functions for installing and deleting extensions
+
+import sys, zipfile
+from PythonExtension import PluginInstance as instance
+from send2trash import send2trash
+
+def install(path):
+    try:
+        extZip = zipfile.ZipFile(path, "r")
+        # Verify all files are in the same directory
+        # NOTE: This is vulnerable to things like ../
+        if len(extZip.namelist()) < 1:
+            extZip.close()
+            return "The .zip file is empty."
+        extName = extZip.namelist()[0].split("/")[0]
+        for path in extZip.namelist():
+            if extName != path.split("/")[0] or len(extName) < 1:
+                extZip.close()
+                return "The .zip file is malformed."
+        # Make sure the extension manager does not overwrite
+        # extensions that are already installed
+        for ext in instance.extensionList():
+            if extName == ext:
+                return "The extension \"{}\" is already installed. Uninstall it before trying again.".format(ext)
+        extZip.extractall(instance.extensionDir().absolutePath())
+        extZip.close()
+    except Exception as e:
+        return str(e)
+    return True
+
+def uninstall(ext):
+    send2trash(instance.extensionDir().absolutePath() + "/" + ext)
diff --git a/python/extensionmanager/list.py b/python/extensionmanager/list.py
new file mode 100644
index 0000000..9850964
--- /dev/null
+++ b/python/extensionmanager/list.py
@@ -0,0 +1,162 @@
+#############################################################################
+##
+## Copyright (C) 2018 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Python Extensions Plugin for QtCreator.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+# Ui for extension list view
+
+from PySide2 import QtCore, QtWidgets, QtGui
+from PythonExtension import PluginInstance as instance
+import actions
+
+class ExtensionList(QtWidgets.QListWidget):
+    def __init__(self):
+        super(ExtensionList, self).__init__()
+
+        self.itemClicked.connect(self.showInfo)
+
+    def showInfo(self, item):
+        return
+
+    def loadExtensionList(self):
+        i = 0
+        for ext in instance.extensionList():
+            item = QtWidgets.QListWidgetItem(self)
+            if not ext in instance.extensionList(True):
+                item.setText(ext + " [did not load]")
+                item.setIcon(QtGui.QIcon.fromTheme("dialog-error"))
+            else:
+                item.setText(ext)
+                item.setIcon(QtGui.QIcon.fromTheme("applications-development"))
+            if i % 2 == 1:
+                item.setBackground(QtGui.QBrush(QtGui.QColor.fromRgb(240, 240, 240)))
+            i += 1
+
+
+# View that lists all extensions
+class ListView(QtWidgets.QDialog):
+    def __init__(self, parent):
+        super(ListView, self).__init__(parent, QtCore.Qt.WindowSystemMenuHint | QtCore.Qt.WindowTitleHint)
+
+        self.setWindowTitle("Installed Python Extensions")
+
+        self.layout = QtWidgets.QVBoxLayout(self)
+
+        self.label = QtWidgets.QLabel()
+        self.label.setText("Manage Python extensions installed to \"{0}\".".format(instance.extensionDir().absolutePath()))
+        self.label.setWordWrap(True)
+        self.layout.addWidget(self.label)
+
+        self.list = ExtensionList()
+        self.layout.addWidget(self.list)
+
+        self.buttonDone = QtWidgets.QPushButton("Close")
+        self.buttonDone.setDefault(True)
+        self.buttonDone.clicked.connect(self.close)
+
+        self.buttonDelete = QtWidgets.QPushButton("Uninstall")
+        self.buttonDelete.setAutoDefault(False)
+        self.buttonDelete.clicked.connect(self.actionDelete)
+
+        self.buttonAdd = QtWidgets.QPushButton("Install")
+        self.buttonAdd.setAutoDefault(False)
+        self.buttonAdd.clicked.connect(self.actionAdd)
+
+        self.buttonBox = QtWidgets.QDialogButtonBox(QtCore.Qt.Horizontal)
+        self.buttonBox.addButton(self.buttonDone, QtWidgets.QDialogButtonBox.AcceptRole)
+        self.buttonBox.addButton(self.buttonDelete, QtWidgets.QDialogButtonBox.ActionRole)
+        self.buttonBox.addButton(self.buttonAdd, QtWidgets.QDialogButtonBox.ActionRole)
+        self.layout.addWidget(self.buttonBox)
+
+        self.reloadExtensionList()
+
+        self.resize(400, 350)
+
+    def reloadExtensionList(self):
+        self.list.clear()
+        self.list.loadExtensionList()
+
+    def actionDelete(self):
+        selected = self.list.selectedIndexes()
+        if len(selected) >= 1:
+            selected = selected[0].row()
+            ext = instance.extensionList()[selected]
+            if ext == "extensionmanager":
+                QtWidgets.QMessageBox.warning(self, "Can not Uninstall", "The Extension Manager can not uninstall itself.")
+            else:
+                ret = QtWidgets.QMessageBox.warning(
+                    self,
+                    "Uninstall \"" + ext + "\"?",
+                    "You are about to uninstall \"" + ext + "\". This action can not be undone. Do you want to proceed?",
+                    QtWidgets.QMessageBox.Cancel | QtWidgets.QMessageBox.Yes,
+                    QtWidgets.QMessageBox.Cancel
+                )
+                if ret == QtWidgets.QMessageBox.Yes:
+                    actions.uninstall(ext)
+                    self.reloadExtensionList()
+                    QtWidgets.QMessageBox.information(
+                        self,
+                        "Removed \"" + ext + "\"",
+                        "The extension was uninstalled. Please restart QtCreator to apply this change."
+                    )
+        else:
+            QtWidgets.QMessageBox.warning(self, "Select an Extension", "Please select an extension to uninstall.")
+
+    def actionAdd(self):
+        fileName = QtWidgets.QFileDialog.getOpenFileName(
+            self,
+            "Select Extension",
+            "/",
+            "QtCreator Python Extensions (*.zip)"
+        )
+        oldExtensions = list(instance.extensionList())
+        result = actions.install(fileName[0])
+        if result == True:
+            QtWidgets.QMessageBox.information(
+                self,
+                "Extension Installed",
+                "The extension from \"" + fileName[0] + "\" was installed successfully. Please restart QtCreator to apply this change."
+                        )
+            self.reloadExtensionList()
+        else:
+            box = QtWidgets.QMessageBox(self)
+            box.setWindowTitle("Could not Install Extension")
+            box.setText("There was a problem installing your extension.")
+            box.setDetailedText(str(result))
+            box.setIcon(QtWidgets.QMessageBox.Warning)
+            box.exec_()
diff --git a/python/extensionmanager/main.py b/python/extensionmanager/main.py
new file mode 100644
index 0000000..6f22f0a
--- /dev/null
+++ b/python/extensionmanager/main.py
@@ -0,0 +1,52 @@
+#############################################################################
+##
+## Copyright (C) 2018 The Qt Company Ltd.
+## Contact: http://www.qt.io/licensing/
+##
+## This file is part of the Python Extensions Plugin for QtCreator.
+##
+## $QT_BEGIN_LICENSE:BSD$
+## You may use this file under the terms of the BSD license as follows:
+##
+## "Redistribution and use in source and binary forms, with or without
+## modification, are permitted provided that the following conditions are
+## met:
+##   * Redistributions of source code must retain the above copyright
+##     notice, this list of conditions and the following disclaimer.
+##   * Redistributions in binary form must reproduce the above copyright
+##     notice, this list of conditions and the following disclaimer in
+##     the documentation and/or other materials provided with the
+##     distribution.
+##   * Neither the name of The Qt Company Ltd nor the names of its
+##     contributors may be used to endorse or promote products derived
+##     from this software without specific prior written permission.
+##
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+## "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+## LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+## A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+## OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+## DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+## THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+## (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+## OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+# Entry point of the Python extension
+
+from PythonExtension import QtCreator
+from list import *
+
+# Actions
+def showExtensionList():
+    dialog = ListView(QtCreator.Core.ICore.dialogParent())
+    dialog.exec_()
+
+helpMenu = QtCreator.Core.ActionManager.actionContainer("QtCreator.Menu.Help")
+helpMenu.menu().addAction("About Python Extensions...", showExtensionList)
diff --git a/python/extensionmanager/requirements.txt b/python/extensionmanager/requirements.txt
new file mode 100644
index 0000000..97ffc1a
--- /dev/null
+++ b/python/extensionmanager/requirements.txt
@@ -0,0 +1,2 @@
+# Needed packages
+Send2Trash