File indexing completed on 2025-01-19 03:50:57

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2024-02-11
  * Description : apply metadata batch tool with ExifTool.
  *
  * SPDX-FileCopyrightText: 2024 by Maik Qualmann <metzpinguin at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #include "applymetadata.h"
 
 // Qt includes
 
 #include <QDir>
 #include <QFile>
 #include <QLabel>
 #include <QWidget>
 #include <QFileInfo>
 #include <QGridLayout>
 #include <QTemporaryDir>
 #include <QScopedPointer>
 
 // KDE includes
 
 #include <klocalizedstring.h>
 
 // Local includes
 
 #include "dimg.h"
 #include "dmetadata.h"
 #include "dfileselector.h"
 #include "exiftoolparser.h"
 #include "dfileoperations.h"
 
 namespace DigikamBqmApplyMetadataPlugin
 {
 
 class Q_DECL_HIDDEN ApplyMetadata::Private
 {
 public:
 
     Private() = default;
 
 public:
 
     DFileSelector* fileSelector   = nullptr;
     QLabel*        descFileLabel  = nullptr;
 
     bool           changeSettings = false;
 };
 
 ApplyMetadata::ApplyMetadata(QObject* const parent)
     : BatchTool(QLatin1String("ApplyMetadata"), MetadataTool, parent),
       d        (new Private)
 {
 }
 
 ApplyMetadata::~ApplyMetadata()
 {
     delete d;
 }
 
 BatchTool* ApplyMetadata::clone(QObject* const parent) const
 {
     return new ApplyMetadata(parent);
 }
 
 void ApplyMetadata::registerSettingsWidget()
 {
     QWidget* const panel    = new QWidget;
     QGridLayout* const grid = new QGridLayout(panel);
 
     d->descFileLabel        = new QLabel(i18n("Select an image or JSON file supported by ExifTool "
                                               "to apply the file metadata to the images."), panel);
     d->descFileLabel->setWordWrap(true);
     d->fileSelector         = new DFileSelector(panel);
     d->fileSelector->setFileDlgMode(QFileDialog::ExistingFile);
 
     grid->addWidget(d->descFileLabel, 0, 0, 1, 1);
     grid->addWidget(d->fileSelector,  1, 0, 1, 1);
     grid->setRowStretch(2, 10);
 
     m_settingsWidget = panel;
 
     connect(d->fileSelector, SIGNAL(signalUrlSelected(QUrl)),
             this, SLOT(slotSettingsChanged()));
 
     BatchTool::registerSettingsWidget();
 }
 
 BatchToolSettings ApplyMetadata::defaultSettings()
 {
     BatchToolSettings settings;
 
     settings.insert(QLatin1String("MetadataFile"), QString());
 
     return settings;
 }
 
 void ApplyMetadata::slotAssignSettings2Widget()
 {
     d->changeSettings = false;
 
     d->fileSelector->setFileDlgPath(settings()[QLatin1String("MetadataFile")].toString());
 
     d->changeSettings = true;
 }
 
 void ApplyMetadata::slotSettingsChanged()
 {
     if (d->changeSettings)
     {
         BatchToolSettings settings;
 
         settings.insert(QLatin1String("MetadataFile"), d->fileSelector->fileDlgPath());
 
         BatchTool::slotSettingsChanged(settings);
     }
 }
 
 bool ApplyMetadata::toolOperations()
 {
     bool ret = true;
 
     if (image().isNull())
     {
         QFile::remove(outputUrl().toLocalFile());
         ret = DFileOperations::copyFile(inputUrl().toLocalFile(), outputUrl().toLocalFile());
     }
     else
     {
         ret = savefromDImg();
     }
 
     QFileInfo metaInfo(settings()[QLatin1String("MetadataFile")].toString());
 
     if (!ret || !metaInfo.exists())
     {
         setErrorDescription(i18nc("@info", "Apply Metadata: No image or JSON file selected."));
         return false;
     }
 
     QScopedPointer<ExifToolParser> const parser(new ExifToolParser(this));
 
     if (!parser->exifToolAvailable())
     {
         setErrorDescription(i18nc("@info", "Apply Metadata: ExifTool is not available."));
         return false;
     }
 
     if (metaInfo.suffix().toUpper() == QLatin1String("JSON"))
     {
         QString dirTemplate = QDir::tempPath() + QLatin1String("/bqm-apply-metadata-XXXXXX");
         QTemporaryDir tempDir(dirTemplate);
 
         if (!tempDir.isValid())
         {
             return false;
         }
 
         QFile jsonFileRead(metaInfo.filePath());
 
         if (!jsonFileRead.open(QIODevice::ReadOnly))
         {
             return false;
         }
 
         QString metaFile   = tempDir.path() + QLatin1Char('/') + metaInfo.fileName();
         QString jsonSource = QString::fromUtf8("\"SourceFile\": \"%1\",");
         QString jsonString = QString::fromUtf8(jsonFileRead.readAll());
         jsonFileRead.close();
 
         if (!jsonString.contains(jsonSource.arg(imageInfo().name(), Qt::CaseInsensitive)))
         {
             setErrorDescription(i18nc("@info", "Apply Metadata: File name not exist in JSON file."));
             return false;
         }
 
         jsonString.replace(jsonSource.arg(imageInfo().name()),
                            jsonSource.arg(outputUrl().toLocalFile(), Qt::CaseInsensitive));
 
         QFile jsonFileWrite(metaFile);
 
         if (!jsonFileWrite.open(QIODevice::WriteOnly))
         {
             return false;
         }
 
         jsonFileWrite.write(jsonString.toUtf8());
         jsonFileWrite.close();
 
         ret = parser->applyMetadataFile(outputUrl().toLocalFile(), metaFile);
     }
     else
     {
         ret = parser->applyMetadataFile(outputUrl().toLocalFile(), metaInfo.filePath());
     }
 
     if (!ret)
     {
         setErrorDescription(i18nc("@info", "Apply Metadata: ExifTool reported an error."));
         return false;
     }
 
     return true;
 }
 
 } // namespace DigikamBqmApplyMetadataPlugin
 
 #include "moc_applymetadata.cpp"