#include "documentvalidator.h"
#include "definitions.h"
#include "initeffects.h"
+#include "mainwindow.h"
#include <KDebug>
#include <KMessageBox>
#include <KApplication>
#include <KLocale>
+#include <KStandardDirs>
#include <QFile>
#include <QColor>
#include <QString>
+#include <QDir>
+#include <QScriptEngine>
#include <mlt++/Mlt.h>
-#include "locale.h"
+#include <locale>
-DocumentValidator::DocumentValidator(QDomDocument doc):
+DocumentValidator::DocumentValidator(QDomDocument doc, KUrl documentUrl):
m_doc(doc),
+ m_url(documentUrl),
m_modified(false)
{}
// Check if we're validating a Kdenlive project
if (kdenliveDoc.isNull())
return false;
+
+ QString rootDir = mlt.attribute("root");
+ if (rootDir == "$CURRENTPATH") {
+ // The document was extracted from a Kdenlive archived project, fix root directory
+ QString playlist = m_doc.toString();
+ playlist.replace("$CURRENTPATH", m_url.directory(KUrl::IgnoreTrailingSlash));
+ m_doc.setContent(playlist);
+ mlt = m_doc.firstChildElement("mlt");
+ kdenliveDoc = mlt.firstChildElement("kdenlivedoc");
+ }
// 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());
+ // Set locale for the document
+ const QString newLocale = setlocale(LC_NUMERIC, mlt.attribute("LC_NUMERIC").toUtf8().constData());
documentLocale = QLocale(mlt.attribute("LC_NUMERIC"));
- }
+ // Make sure Qt locale and C++ locale have the same numeric separator, might not be the case
+ // With some locales since C++ and Qt use a different database for locales
+ char *separator = localeconv()->decimal_point;
+ if (newLocale.isEmpty()) {
+ // Requested locale not available, ask for install
+ KMessageBox::sorry(kapp->activeWindow(), i18n("The document was created in \"%1\" locale, which is not installed on your system. Please install that language pack. Until then, Kdenlive might not be able to correctly open the document.", mlt.attribute("LC_NUMERIC")));
+ }
+
+ if (separator != documentLocale.decimalPoint()) {
+ KMessageBox::sorry(kapp->activeWindow(), i18n("There is a locale conflict on your system. The document uses locale %1 which uses a \"%2\" as numeric separator (in system libraries) but Qt expects \"%3\". You might not be able to correctly open the project.", mlt.attribute("LC_NUMERIC"), separator, documentLocale.decimalPoint()));
+ kDebug()<<"------\n!!! system locale is not similar to Qt's locale... be prepared for bugs!!!\n------";
+ // HACK: There is a locale conflict, so set locale to at least have correct decimal point
+ if (strncmp(separator, ".", 1) == 0) documentLocale = QLocale::c();
+ else if (strncmp(separator, ",", 1) == 0) documentLocale = QLocale("fr_FR.UTF-8");
+ }
+ }
+
documentLocale.setNumberOptions(QLocale::OmitGroupSeparator);
+ if (documentLocale.decimalPoint() != QLocale().decimalPoint()) {
+ // If loading an older MLT file without LC_NUMERIC, set locale to C which was previously the default
+ if (!mlt.hasAttribute("LC_NUMERIC")) {
+ setlocale(LC_NUMERIC, "C");
+ }
- if (documentLocale != QLocale()) {
QLocale::setDefault(documentLocale);
// locale conversion might need to be redone
- initEffects::parseEffectFiles();
+ initEffects::parseEffectFiles(setlocale(LC_NUMERIC, NULL));
}
- // 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"));
-
+ bool ok;
+ double version = documentLocale.toDouble(kdenliveDoc.attribute("version"), &ok);
+ if (!ok) {
+ // Could not parse version number, there is probably a conflict in decimal separator
+ QLocale tempLocale = QLocale(mlt.attribute("LC_NUMERIC"));
+ version = tempLocale.toDouble(kdenliveDoc.attribute("version"), &ok);
+ if (!ok) version = kdenliveDoc.attribute("version").toDouble(&ok);
+ if (!ok) {
+ // Last try: replace comma with a dot
+ QString versionString = kdenliveDoc.attribute("version");
+ if (versionString.contains(',')) versionString.replace(',', '.');
+ version = versionString.toDouble(&ok);
+ if (!ok) kDebug()<<"// CANNOT PARSE VERSION NUMBER, ERROR!";
+ }
+ }
+
// Upgrade the document to the latest version
- if (!upgrade(documentLocale.toDouble(kdenliveDoc.attribute("version")), currentVersion))
+ if (!upgrade(version, currentVersion))
return false;
/*
// 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);
}
+ updateEffects();
+
return true;
}
{
return m_modified;
}
+
+void DocumentValidator::updateEffects()
+{
+ // WARNING: order by findDirs will determine which js file to use (in case multiple scripts for the same filter exist)
+ QMap <QString, KUrl> paths;
+#if QT_VERSION >= 0x040700
+ QMap <QString, QScriptProgram> scripts;
+#else
+ QMap <QString, QString> scripts;
+#endif
+ 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;
+ // remove extension (".js")
+ identifier.chop(3);
+ paths.insert(identifier, KUrl(directoryName + fileName));
+ }
+ }
+
+ QDomNodeList effects = m_doc.elementsByTagName("filter");
+ int max = effects.count();
+ QStringList safeEffects;
+ for(int i = 0; i < max; ++i) {
+ QDomElement effect = effects.at(i).toElement();
+ QString effectId = EffectsList::property(effect, "kdenlive_id");
+ if (safeEffects.contains(effectId)) {
+ // Do not check the same effect twice if it is at the correct version
+ // (assume we don't have different versions of the same effect in a project file)
+ continue;
+ }
+ 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;
+ }
+#if QT_VERSION >= 0x040700
+ QScriptProgram scriptProgram(scriptFile.readAll());
+#else
+ QString scriptProgram = scriptFile.readAll();
+#endif
+ scriptFile.close();
+ scripts.insert(effectId, scriptProgram);
+ }
+
+ QScriptEngine scriptEngine;
+ scriptEngine.importExtension("qt.core");
+ scriptEngine.importExtension("qt.xml");
+ scriptEngine.evaluate(scripts.value(effectId));
+ QScriptValue updateRules = scriptEngine.globalObject().property("update");
+ if (!updateRules.isValid())
+ continue;
+ if (updateRules.isFunction()) {
+ QDomDocument scriptDoc;
+ scriptDoc.appendChild(scriptDoc.importNode(effect, true));
+
+ QString effectString = updateRules.call(QScriptValue(), QScriptValueList() << serviceVersion << effectVersion << scriptDoc.toString()).toString();
+
+ if (!effectString.isEmpty() && !scriptEngine.hasUncaughtException()) {
+ scriptDoc.setContent(effectString);
+ QDomNode updatedEffect = effect.ownerDocument().importNode(scriptDoc.documentElement(), true);
+ effect.parentNode().replaceChild(updatedEffect, effect);
+ m_modified = true;
+ }
+ } else {
+ m_modified = updateEffectParameters(effect.childNodes(), &updateRules, serviceVersion, effectVersion);
+ }
+
+ // set version number since MLT won't change it (only initially set it)
+ QDomElement versionElem = effect.firstChildElement("version");
+ if (EffectsList::property(effect, "version").isNull()) {
+ versionElem = effect.ownerDocument().createTextNode(QLocale().toString(serviceVersion)).toElement();
+ versionElem.setTagName("property");
+ versionElem.setAttribute("name", "version");
+ effect.appendChild(versionElem);
+ } else {
+ EffectsList::setProperty(effect, "version", QLocale().toString(serviceVersion));
+ }
+ }
+ else safeEffects.append(effectId);
+ }
+ }
+}
+
+bool DocumentValidator::updateEffectParameters(QDomNodeList parameters, const QScriptValue* updateRules, const double serviceVersion, const double effectVersion)
+{
+ bool updated = false;
+ bool isDowngrade = serviceVersion < effectVersion;
+ for (int i = 0; i < parameters.count(); ++i) {
+ QDomElement parameter = parameters.at(i).toElement();
+ QScriptValue rules = updateRules->property(parameter.attribute("name"));
+ if (rules.isValid() && rules.isArray()) {
+ int rulesCount = rules.property("length").toInt32();
+ if (isDowngrade) {
+ // start with the highest version and downgrade step by step
+ for (int j = rulesCount - 1; j >= 0; --j) {
+ double version = rules.property(j).property(0).toNumber();
+ if (version <= effectVersion && version > serviceVersion) {
+ parameter.firstChild().setNodeValue(rules.property(j).property(1).call(QScriptValue(), QScriptValueList() << parameter.text() << isDowngrade).toString());
+ updated = true;
+ }
+ }
+ } else {
+ for (int j = 0; j < rulesCount; ++j) {
+ double version = rules.property(j).property(0).toNumber();
+ if (version > effectVersion && version <= serviceVersion) {
+ parameter.firstChild().setNodeValue(rules.property(j).property(1).call(QScriptValue(), QScriptValueList() << parameter.text() << isDowngrade).toString());
+ updated = true;
+ }
+ }
+ }
+ }
+ }
+ return updated;
+}
projects / kdenlive / blobdiff