Allow plugins to specify a "revision" to show in addition to the versionv4.5.2

To be used for the version control revision the plugin was built from.
Invent a QTC_PLUGIN_REVISION replacement string for the plugin .json.in
which can be set by the build process.

Task-number: QTCREATORBUG-19951
Change-Id: Id5fd64b5506383e0b7749bcfd34d178baf8fe7af
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

2 files changed, 45 insertions, 2 deletions

diff --git a/qbs/modules/pluginjson/pluginjson.qbs b/qbs/modules/pluginjson/pluginjson.qbs
index 03bdb0b076..8cba183437 100644
--- a/qbs/modules/pluginjson/pluginjson.qbs
+++ b/qbs/modules/pluginjson/pluginjson.qbs
@@ -1,11 +1,37 @@
 import qbs 1.0
-import qbs.TextFile
+import qbs.File
 import qbs.FileInfo
+import qbs.TextFile
+import qbs.Utilities
 
 Module {
     Depends { id: qtcore; name: "Qt.core" }
     Depends { name: "qtc" }
 
+    // TODO: Wrap the VCS specific stuff in a dedicated module
+    property bool hasVcs: Utilities.versionCompare(qbs.version, "1.10") >= 0
+    Depends { name: "vcs"; condition: hasVcs }
+    Properties {
+        condition: hasVcs
+        vcs.repoDir: {
+            // TODO: Could something like this be incorporated into the vcs module?
+            //       Currently, the default repo dir is project.sourceDirectory, which
+            //       does not make sense for Qt Creator.
+            var dir = sourceDirectory;
+            while (true) {
+                if (File.exists(FileInfo.joinPaths(dir, ".git")))
+                    return dir;
+                var newDir = FileInfo.path(dir);
+                if (newDir === dir || dir === project.sourceDirectory) {
+                    console.warn("No git repository found for product " + product.name
+                                 + ", revision information will not be evailable.");
+                    break;
+                }
+                dir = newDir;
+            }
+        }
+    }
+
     additionalProductTypes: ["qt_plugin_metadata"]
 
     Rule {
@@ -56,6 +82,8 @@ Module {
                 vars['IDE_VERSION_RELEASE'] = product.moduleProperty("qtc", "ide_version_release");
                 vars['QTCREATOR_COPYRIGHT_YEAR']
                         = product.moduleProperty("qtc", "qtcreator_copyright_year")
+                if (!vars['QTC_PLUGIN_REVISION'])
+                    vars['QTC_PLUGIN_REVISION'] = product.vcs ? (product.vcs.repoState || "") : "";
                 var deplist = [];
                 for (i in plugin_depends) {
                     deplist.push("        { \"Name\" : \"" + plugin_depends[i] + "\", \"Version\" : \"" + qtcVersion + "\" }");
diff --git a/src/libs/extensionsystem/plugindetailsview.cpp b/src/libs/extensionsystem/plugindetailsview.cpp
index 5d51a1e31d..13f24d3889 100644
--- a/src/libs/extensionsystem/plugindetailsview.cpp
+++ b/src/libs/extensionsystem/plugindetailsview.cpp
@@ -32,6 +32,8 @@
 #include <utils/algorithm.h>
 
 #include <QDir>
+#include <QJsonObject>
+#include <QJsonValue>
 #include <QRegExp>
 
 /*!
@@ -65,6 +67,16 @@ PluginDetailsView::~PluginDetailsView()
     delete m_ui;
 }
 
+// TODO: make API in PluginSpec
+static QString getSpecRevision(PluginSpec *spec)
+{
+    const QJsonObject metaData = spec->metaData();
+    const QJsonValue revision = metaData.value("Revision");
+    if (revision.isString())
+        return revision.toString();
+    return QString();
+}
+
 /*!
     Reads the given \a spec and displays its values
     in this PluginDetailsView.
@@ -72,7 +84,10 @@ PluginDetailsView::~PluginDetailsView()
 void PluginDetailsView::update(PluginSpec *spec)
 {
     m_ui->name->setText(spec->name());
-    m_ui->version->setText(spec->version());
+    const QString revision = getSpecRevision(spec);
+    const QString versionString = spec->version() + (revision.isEmpty() ? QString()
+                                                                        : " (" + revision + ")");
+    m_ui->version->setText(versionString);
     m_ui->compatVersion->setText(spec->compatVersion());
     m_ui->vendor->setText(spec->vendor());
     const QString link = QString::fromLatin1("<a href=\"%1\">%1</a>").arg(spec->url());