File indexing completed on 2024-05-12 16:46:08

 /***************************************************************************
     Copyright (C) 2003-2009 Robby Stephenson <robby@periapsis.org>
  ***************************************************************************/
 
 /***************************************************************************
  *                                                                         *
  *   This program is free software; you can redistribute it and/or         *
  *   modify it under the terms of the GNU General Public License as        *
  *   published by the Free Software Foundation; either version 2 of        *
  *   the License or (at your option) version 3 or any later version        *
  *   accepted by the membership of KDE e.V. (or its successor approved     *
  *   by the membership of KDE e.V.), which shall act as a proxy            *
  *   defined in Section 14 of version 3 of the license.                    *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  *                                                                         *
  ***************************************************************************/
 
 #include "image.h"
 #include "../utils/string_utils.h"
 #include "../tellico_debug.h"
 
 #include <QBuffer>
 #include <QRegularExpression>
 #include <QImageReader>
 #include <QImageWriter>
 #include <QCryptographicHash>
 
 using Tellico::Data::Image;
 
 const Image Image::null;
 QList<QByteArray> Image::s_outputFormats;
 
 Image::Image() : QImage(), m_linkOnly(false) {
 }
 
 Image::Image(const Image& other) : QImage(other)
   , m_id(other.m_id)
   , m_format(other.m_format)
   , m_linkOnly(other.m_linkOnly) {
 }
 
 Image& Image::operator=(const Image& other) {
   QImage::operator=(other);
   if(this != &other) {
     m_id = other.m_id;
     m_format = other.m_format;
     m_linkOnly = other.m_linkOnly;
   }
   return *this;
 }
 
 // I'm using the MD5 hash as the id. I consider it rather unlikely that two images in one
 // collection could ever have the same hash, and this lets me do a fast comparison of two images
 // simply by comparing their ids.
 Image::Image(const QString& filename_, const QString& id_) : QImage(), m_id(idClean(id_)), m_linkOnly(false) {
   QImageReader reader;
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 5, 0))
   reader.setAutoTransform(true);
 #endif
   reader.setFileName(filename_);
   m_format = reader.format();
   if(!reader.read(this)) {
     // Tellico had an earlier bug where images were written in PNG format with a GIF extension
     // and for some reason, qt doesn't recognize the file then, so fall back and try to load as PNG
     reader.setFormat("PNG");
     if(reader.read(this)) {
       myWarning() << filename_ << "loaded as PNG image";
       m_format = "PNG";
     }
   }
   if(m_id.isEmpty()) {
     calculateID();
   }
 }
 
 Image::Image(const QImage& img_, const QString& format_) : QImage(img_), m_format(format_.toLatin1()), m_linkOnly(false) {
   calculateID();
 }
 
 Image::Image(const QByteArray& data_, const QString& format_, const QString& id_)
     : QImage(QImage::fromData(data_)), m_id(idClean(id_)), m_format(format_.toLatin1()), m_linkOnly(false) {
   if(isNull()) {
     m_id.clear();
   }
 }
 
 Image::~Image() {
 }
 
 QByteArray Image::byteArray() const {
   return byteArray(*this, outputFormat(m_format));
 }
 
 // TODO: once the min qt version is raised to 5.10, this can be removed
 qsizetype Image::byteSize() const {
 #if (QT_VERSION < QT_VERSION_CHECK(5, 10, 0))
   return byteCount();
 #else
   return sizeInBytes();
 #endif
 }
 
 bool Image::isNull() const {
   // 1x1 images are considered null for Tellico. Amazon returns some like that.
   return QImage::isNull() || (width() < 2 && height() < 2);
 }
 
 QPixmap Image::convertToPixmap() const {
   return QPixmap::fromImage(*this);
 }
 
 QPixmap Image::convertToPixmap(int w_, int h_) const {
   if(w_ < width() || h_ < height()) {
     return QPixmap::fromImage(*this).scaled(w_, h_, Qt::KeepAspectRatio);
   } else {
     return QPixmap::fromImage(*this);
   }
 }
 
 QByteArray Image::outputFormat(const QByteArray& inputFormat) {
   if(s_outputFormats.isEmpty()) {
     QList<QByteArray> list = QImageWriter::supportedImageFormats();
     foreach(const QByteArray& format, list) {
       s_outputFormats.append(format.toUpper());
     }
   }
   if(s_outputFormats.contains(inputFormat.toUpper())) {
     return inputFormat;
   }
   myWarning() << "writing" << inputFormat << "as PNG";
   return "PNG";
 }
 
 QByteArray Image::byteArray(const QImage& img_, const QByteArray& outputFormat_) {
   QByteArray ba;
   QBuffer buf(&ba);
   buf.open(QIODevice::WriteOnly);
   QImageWriter writer(&buf, outputFormat_);
   if(!writer.write(img_)) {
     myDebug() << writer.errorString();
   }
   buf.close();
   return ba;
 }
 
 QString Image::idClean(const QString& id_) {
   static const QRegularExpression rx(QLatin1Char('[') + QRegularExpression::escape(QLatin1String("/@<>#\"&%?={}|^~[]'`\\:+")) + QLatin1Char(']'));
   QString clean = id_;
   return Tellico::shareString(clean.remove(rx));
 }
 
 void Image::setID(const QString& id_) {
   // don't clean the id if we're linking only
   m_id = m_linkOnly ? id_ : idClean(id_);
 }
 
 void Image::calculateID() {
   // the id will eventually be used as a filename
   if(!isNull()) {
     m_id = calculateID(byteArray(), QLatin1String(m_format));
   }
 }
 
 QString Image::calculateID(const QByteArray& data_, const QString& format_) {
   QCryptographicHash md5(QCryptographicHash::Md5);
   md5.addData(data_);
   QString id = QLatin1String(md5.result().toHex()) + QLatin1Char('.') + format_.toLower();
   return idClean(id);
 }