iofactory.cpp

/*
  Copyright (c) 2012, BuildmLearn Contributors listed at http://buildmlearn.org/people/
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

  * Neither the name of the BuildmLearn nor the names of its
    contributors may be used to endorse or promote products derived from
    this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include "miscellaneous/iofactory.h"

#include "miscellaneous/application.h"

#include <QDir>
#include <QFile>
#include <QTextStream>

#if !defined(Q_OS_OS2)
#if QT_VERSION >= 0x050000
#include <QSound>
#else
#include <MediaObject>
#include <AudioOutput>
#endif
#endif


IOFactory::IOFactory() {
}

void IOFactory::playWaveFile(const QString &file_path) {
#if QT_VERSION >= 0x050000
  QSound::play(file_path);
#elif !defined(Q_OS_OS2)
  Phonon::AudioOutput *out = new Phonon::AudioOutput(Phonon::MusicCategory, qApp);
  out->setVolume(100.0f);
  out->setMuted(false);

  Phonon::MediaObject *music = Phonon::createPlayer(Phonon::MusicCategory, Phonon::MediaSource(file_path));

  Phonon::createPath(music, out);
  music->play();
  QObject::connect(music, SIGNAL(finished()), music, SLOT(deleteLater()));
  QObject::connect(music, SIGNAL(finished()), out, SLOT(deleteLater()));
#endif
}

bool IOFactory::copyFile(const QString &source, const QString &destination) {
  if (!QFile::exists(source)) {
    qDebug("Source file \'%s\' does not exist.", qPrintable(QDir::toNativeSeparators(source)));
    return false;
  }

  if (QFile::exists(destination)) {
    if (!QFile::remove(destination)) {
      qDebug("Destination file \'%s\' could not be removed.", qPrintable(QDir::toNativeSeparators(destination)));
      return false;
    }
  }

  return QFile::copy(source, destination);
}

bool IOFactory::removeDirectory(const QString& directory_name,
                                const QStringList& exception_file_list,
                                const QStringList& exception_folder_list) {
  bool result = true;
  QDir dir(directory_name);

  if (dir.exists(directory_name)) {
    foreach (QFileInfo info,
             dir.entryInfoList(QDir::NoDotAndDotDot | QDir::System |
                               QDir::Hidden  | QDir::AllDirs | QDir::Files, QDir::DirsFirst)) {
      if (info.isDir()) {
        if (!exception_folder_list.contains(info.fileName())) {
          result &= removeDirectory(info.absoluteFilePath(), exception_file_list);
        }
      }
      else if (!exception_file_list.contains(info.fileName())) {
        result &= QFile::remove(info.absoluteFilePath());
      }
    }

    result &= dir.rmdir(directory_name);
  }

  return result;
}

QByteArray IOFactory::fileToBase64(const QString &file_name) {
  QFile file(file_name);

  if (!file.open(QIODevice::ReadOnly | QIODevice::Unbuffered)) {
    return QByteArray();
  }
  else {
    QByteArray file_contents = file.readAll();
    file.flush();
    file.close();
    return file_contents.toBase64();
  }
}

bool IOFactory::base64ToFile(const QString &source_data, const QString &target_file) {
  QFile target(target_file);

  if (!target.open(QIODevice::Unbuffered | QIODevice::WriteOnly | QIODevice::Truncate)) {
    return false;
  }

  target.write(QByteArray::fromBase64(source_data.toUtf8()));
  target.close();
  return true;
}

bool IOFactory::copyDirectory(QString source, QString destination) {
  QDir dir(source);

  if (! dir.exists()) {
    return false;
  }

  foreach (QString d, dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)) {
    QString dst_path = destination + QDir::separator() + d;
    dir.mkpath(dst_path);
    copyDirectory(source + QDir::separator() + d, dst_path);
  }

  foreach (QString f, dir.entryList(QDir::Files)) {
    QString original_file = source + QDir::separator() + f;
    QString destination_file = destination + QDir::separator() + f;

    if (!QFile::exists(destination_file) || QFile::remove(destination_file)) {
      if (!QFile::copy(original_file, destination_file)) {
        qDebug("Failed to copy file \'%s\'.", qPrintable(QDir::toNativeSeparators(original_file)));
      }
    }
    else {
      qDebug("Failed to remove file \'%s\'.", qPrintable(QDir::toNativeSeparators(original_file)));
    }
  }

  return true;
}