Update mechanism for effects.

[kdenlive] / src / documentvalidator.cpp

diff --git a/src/documentvalidator.cpp b/src/documentvalidator.cpp
index 44fd3a41b43d2ba8428dfddc8c3c025e2576580c..ce1c83ab03e8e72c990c7e54488a890b8dc4f99e 100644 (file)
--- a/src/documentvalidator.cpp
+++ b/src/documentvalidator.cpp
@@ -20,17 +20,26 @@
 
 #include "documentvalidator.h"
 #include "definitions.h"
+#include "initeffects.h"
+#include "mainwindow.h"
 
 #include <KDebug>
 #include <KMessageBox>
 #include <KApplication>
 #include <KLocale>
+#include <KUrl>
+#include <KStandardDirs>
 
 #include <QFile>
 #include <QColor>
+#include <QString>
+#include <QDir>
+#include <QScriptEngine>
 
 #include <mlt++/Mlt.h>
 
+#include "locale.h"
+
 
 DocumentValidator::DocumentValidator(QDomDocument doc):
         m_doc(doc),
@@ -48,8 +57,30 @@ bool DocumentValidator::validate(const double currentVersion)
     // Check if we're validating a Kdenlive project
     if (kdenliveDoc.isNull())
         return false;
+
+    // Previous MLT / Kdenlive versions used C locale by default
+    QLocale documentLocale = QLocale::c();
+    
+    if (mlt.hasAttribute("LC_NUMERIC")) {
+        // Set locale for the document
+        // WARNING: what should be done in case the locale does not exist on the system?
+        setlocale(LC_NUMERIC, mlt.attribute("LC_NUMERIC").toUtf8().constData());
+        documentLocale = QLocale(mlt.attribute("LC_NUMERIC"));
+    }
+    
+    documentLocale.setNumberOptions(QLocale::OmitGroupSeparator);
+    if (documentLocale != QLocale()) {
+        QLocale::setDefault(documentLocale);
+        // locale conversion might need to be redone
+        initEffects::parseEffectFiles();
+    }
+
+    // TODO: remove after string freeze
+    if (0)
+        KMessageBox::sorry(kapp->activeWindow(), i18n("The document you are opening uses a different locale (%1) than your system. You can only open and render it, no editing is supported unless you change your system's locale.", mlt.attribute("LC_NUMERIC")), i18n("Read only project"));
+
     // Upgrade the document to the latest version
-    if (!upgrade(kdenliveDoc.attribute("version").toDouble(), currentVersion))
+    if (!upgrade(documentLocale.toDouble(kdenliveDoc.attribute("version")), currentVersion))
         return false;
 
     /*
@@ -91,7 +122,7 @@ bool DocumentValidator::validate(const double currentVersion)
                 // Looks like one MLT track is missing, remove the extra Kdenlive track if there is one.
                 if (tracksinfo.count() != tracks.count() - 1) {
                     // The Kdenlive tracks are not ok, clear and rebuild them
-                    QDomNode tinfo = kdenliveDoc.elementsByTagName("tracksinfo").at(0);
+                    QDomNode tinfo = kdenliveDoc.firstChildElement("tracksinfo");
                     QDomNode tnode = tinfo.firstChild();
                     while (!tnode.isNull()) {
                         tinfo.removeChild(tnode);
@@ -152,6 +183,8 @@ bool DocumentValidator::validate(const double currentVersion)
         
     }
 
+    updateEffects();
+
     return true;
 }
 
@@ -888,6 +921,12 @@ bool DocumentValidator::upgrade(double version, const double currentVersion)
         }
     }
 
+    if (version <= 0.87) {
+        if (!m_doc.firstChildElement("mlt").hasAttribute("LC_NUMERIC")) {
+            m_doc.firstChildElement("mlt").setAttribute("LC_NUMERIC", "C");
+        }
+    }
+
     // The document has been converted: mark it as modified
     infoXml.setAttribute("version", currentVersion);
     m_modified = true;
@@ -989,3 +1028,75 @@ bool DocumentValidator::isModified() const
 {
     return m_modified;
 }
+
+void DocumentValidator::updateEffects()
+{
+    // WARNING: order by findDirs will determine which js file to use (in case multiple for the same filter exist)
+    QMap <QString, KUrl> paths;
+    QMap <QString, QScriptProgram> scripts;
+    QStringList directories = KGlobal::dirs()->findDirs("appdata", "effects/update");
+    foreach (const QString &directoryName, directories) {
+        QDir directory(directoryName);
+        QStringList fileList = directory.entryList(QStringList() << "*.js", QDir::Files);
+        foreach (const QString &fileName, fileList) {
+            QString identifier = fileName;
+            identifier.chop(3);
+            identifier.replace('_', '.');
+            paths.insert(identifier, KUrl(directoryName + fileName));
+        }
+    }
+
+    QDomNodeList effects = m_doc.elementsByTagName("filter");
+
+    for(int i = 0; i < effects.count(); ++i) {
+        QDomElement effect = effects.at(i).toElement();
+        QString effectId = EffectsList::property(effect, "kdenlive_id");
+        QString effectTag = EffectsList::property(effect, "tag");
+        QString effectVersionStr = EffectsList::property(effect, "version");
+        double effectVersion = effectVersionStr.isNull() ? -1 : effectVersionStr.toDouble();
+
+        QDomElement effectDescr = MainWindow::customEffects.getEffectByTag(QString(), effectId);
+        if (effectDescr.isNull()) {
+            effectDescr = MainWindow::videoEffects.getEffectByTag(effectTag, effectId);
+        }
+        if (effectDescr.isNull()) {
+            effectDescr = MainWindow::audioEffects.getEffectByTag(effectTag, effectId);
+        }
+        if (!effectDescr.isNull()) {
+            double serviceVersion = -1;
+            QDomElement serviceVersionElem = effectDescr.firstChildElement("version");
+            if (!serviceVersionElem.isNull()) {
+                serviceVersion = serviceVersionElem.text().toDouble();
+            }
+            if (serviceVersion != effectVersion && paths.contains(effectId)) {
+                if (!scripts.contains(effectId)) {
+                    QFile scriptFile(paths.value(effectId).path());
+                    if (!scriptFile.open(QIODevice::ReadOnly)) {
+                        continue;
+                    }
+                    QScriptProgram scriptProgram(scriptFile.readAll());
+                    scriptFile.close();
+                    scripts.insert(effectId, scriptProgram);
+                }
+
+                QDomDocument scriptDoc;
+                scriptDoc.appendChild(scriptDoc.importNode(effect, true));
+
+                QScriptEngine scriptEngine;
+                scriptEngine.importExtension("qt.core");
+                scriptEngine.importExtension("qt.xml");
+                scriptEngine.evaluate(scripts.value(effectId));
+                QString effectString = scriptEngine.globalObject().property("update").call(QScriptValue(), QScriptValueList()  << serviceVersion << effectVersion << scriptDoc.toString()).toString();
+
+                if (!effectString.isEmpty()) {
+                    scriptDoc.setContent(effectString);
+                    QDomNode updatedEffect = effect.ownerDocument().importNode(scriptDoc.documentElement(), true);
+                    effect.parentNode().replaceChild(updatedEffect, effect);
+                    // TODO: set version to avoid dependency on latest MLT
+                    m_modified = true;
+                }
+            }
+        }
+    }
+}
+