IO/files processing methods. More...

#include <iofactory.h>

Collaboration diagram for IOFactory:

Static Public Member Functions
static void	playWaveFile (const QString &file_path)
	Plays selected file with default audio output. More...

static bool	copyFile (const QString &source, const QString &destination)
	Copies source file into destination path. More...

static bool	copyDirectory (QString source, QString destination)
	Copies source directory into destination path. More...

static bool	removeDirectory (const QString &directory_name, const QStringList &exception_file_list=QStringList(), const QStringList &exception_folder_list=QStringList())
	Removes given directory and all its contents if not exceptions are given. More...

static QByteArray	fileToBase64 (const QString &file_name)
	Takes input file and reads it into base64 byte array. More...

static bool	base64ToFile (const QString &source_data, const QString &target_file)
	Takes base64 byte array and saves it into file. More...

Detailed Description

IO/files processing methods.

Definition at line 39 of file iofactory.h.

Member Function Documentation

bool IOFactory::base64ToFile	(	const QString &	source_data,
		const QString &	target_file
	)

static

Takes base64 byte array and saves it into file.

Parameters

source_data	Source base64 string.
target_file	Path to target file.

Returns: Returns true if data was saved to file, false otherwise.

Definition at line 125 of file iofactory.cpp.

                                                                                    {
   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;
 }

Here is the caller graph for this function:

bool IOFactory::copyDirectory	(	QString	source,
		QString	destination
	)

static

Copies source directory into destination path.

Parameters

source	Path to source directory.
destination	Path to destination directory.

Returns: Returns true if copy operation was successfull.

Note: If destination exists, then it is overwritten.

Definition at line 137 of file iofactory.cpp.

                                                                  {
   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;
 }

bool IOFactory::copyFile	(	const QString &	source,
		const QString &	destination
	)

static

Copies source file into destination path.

Parameters

source	Path to source file.
destination	Path to destination path.

Returns: Returns true if copy operation was successfull.

Warning: If destination exists, then it is overwritten.

Definition at line 69 of file iofactory.cpp.

                                                                           {
   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);
 }

Here is the caller graph for this function:

QByteArray IOFactory::fileToBase64 ( const QString & file_name )

static

Takes input file and reads it into base64 byte array.

Parameters

file_name Path to file.

Returns: Returns base64 byte array on success or empty array on failure.

Definition at line 111 of file iofactory.cpp.

                                                            {
   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();
   }
 }

Here is the caller graph for this function:

void IOFactory::playWaveFile ( const QString & file_path )

static

Plays selected file with default audio output.

Parameters

file_path Path to file to play, it should be WAVE file.

Definition at line 52 of file iofactory.cpp.

                                                      {
 #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::removeDirectory	(	const QString &	directory_name,
		const QStringList &	exception_file_list = `QStringList()`,
		const QStringList &	exception_folder_list = `QStringList()`
	)

static

Removes given directory and all its contents if not exceptions are given.

Parameters

directory_name	Path to directory.
exception_file_list	List of file names which should be skipped.
exception_folder_list	List of folder names which should be skipped.

Returns: Returns true if delete operation was successfull.

Definition at line 85 of file iofactory.cpp.

                                                                           {
   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;
 }

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

Static Public Member Functions

Detailed Description

Member Function Documentation