oak-editor/engine/common/filefunctions.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2022 Olive Team
  Modifications Copyright (C) 2025 mikesolar

  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 3 of the License, or
  (at your option) any later version.

  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 "filefunctions.h"

#include <QCoreApplication>
#include <QCryptographicHash>
#include <QDateTime>
#include <QDir>
#include <QFileInfo>
#include <QStandardPaths>

#include "config/config.h"

namespace olive
{

QString FileFunctions::get_unique_file_identifier(const QString &filename)
{
	QFileInfo info(filename);

	if (!info.exists()) {
		return QString();
	}

	QCryptographicHash hash(QCryptographicHash::Sha1);

	hash.addData(info.absoluteFilePath().toUtf8());

	hash.addData(
		QString::number(info.lastModified().toMSecsSinceEpoch()).toUtf8());

	QByteArray result = hash.result();

	return QString(result.toHex());
}

QString FileFunctions::get_configuration_location()
{
	if (is_portable()) {
		return get_application_path();
	} else {
		QString s =
			QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
		QDir(s).mkpath(".");
		return s;
	}
}

bool FileFunctions::is_portable()
{
	return QFileInfo::exists(QDir(get_application_path()).filePath("portable"));
}

QString FileFunctions::get_application_path()
{
	return QCoreApplication::applicationDirPath();
}

QString FileFunctions::get_temp_file_path()
{
	QString temp_path =
		QDir(
			QDir(QStandardPaths::writableLocation(QStandardPaths::TempLocation))
				.filePath(QCoreApplication::organizationName()))
			.filePath(QCoreApplication::applicationName());

	// Ensure it exists
	QDir(temp_path).mkpath(".");

	return temp_path;
}

bool FileFunctions::can_copy_directory_without_overwriting(const QString &source,
													   const QString &dest)
{
	QFileInfoList info_list = QDir(source).entryInfoList();

	foreach (const QFileInfo &info, info_list) {
		// QDir::NoDotAndDotDot continues to not work, so we have to check manually
		if (info.fileName() == QStringLiteral(".") ||
			info.fileName() == QStringLiteral("..")) {
			continue;
		}

		QString dest_equivalent = QDir(dest).filePath(info.fileName());

		if (info.isDir()) {
			if (!can_copy_directory_without_overwriting(info.absoluteFilePath(),
													dest_equivalent)) {
				return false;
			}
		} else if (QFileInfo::exists(dest_equivalent)) {
			return false;
		}
	}

	return true;
}

void FileFunctions::copy_directory(const QString &source, const QString &dest,
								  bool overwrite)
{
	QDir d(source);

	if (!d.exists()) {
		qCritical()
			<< "Failed to copy directory, source" << source << "didn't exist";
		return;
	}

	QDir dest_dir(dest);

	if (!dest_dir.mkpath(QStringLiteral("."))) {
		qCritical() << "Failed to create destination directory" << dest;
		return;
	}

	QFileInfoList l = d.entryInfoList();

	foreach (const QFileInfo &info, l) {
		// QDir::NoDotAndDotDot continues to not work, so we have to check manually
		if (info.fileName() == QStringLiteral(".") ||
			info.fileName() == QStringLiteral("..")) {
			continue;
		}

		QString dest_file_path = dest_dir.filePath(info.fileName());

		if (info.isDir()) {
			// Copy dir
			copy_directory(info.absoluteFilePath(), dest_file_path, overwrite);
		} else {
			// Copy file
			if (overwrite && QFile::exists(dest_file_path)) {
				QFile file(dest_file_path);
				file.setPermissions(
					file.permissions() | QFileDevice::WriteOwner |
					QFileDevice::WriteUser | QFileDevice::WriteGroup |
					QFileDevice::WriteOther);
				file.remove();
			}

			QFile::copy(info.absoluteFilePath(), dest_file_path);
		}
	}
}

bool FileFunctions::directory_is_valid(const QDir &d,
									 bool try_to_create_if_not_exists)
{
	// Return whether the directory exists, or whether it could be created if it doesn't
	return d.exists() ||
		   (try_to_create_if_not_exists && d.mkpath(QStringLiteral(".")));
}

QString FileFunctions::ensure_filename_extension(QString fn,
											   const QString &extension)
{
	// No-op if either input is empty
	if (!fn.isEmpty() && !extension.isEmpty()) {
		QString extension_with_dot;

		extension_with_dot.append('.');
		extension_with_dot.append(extension);

		if (!fn.endsWith(extension_with_dot, Qt::CaseInsensitive)) {
			fn.append(extension_with_dot);
		}
	}

	return fn;
}

QString FileFunctions::read_file_as_string(const QString &filename)
{
	QFile f(filename);
	QString file_data;
	if (f.open(QFile::ReadOnly | QFile::Text)) {
		QTextStream text_stream(&f);
		file_data = text_stream.readAll();
		f.close();
	}
	return file_data;
}

QString FileFunctions::get_safe_temporary_filename(const QString &original)
{
	int counter = 0;

	QFileInfo original_info(original);
	QString basename = original_info.baseName();
	QString complete_suffix = original_info.completeSuffix();

	// If we have a complete suffix, make sure there's a period in it
	if (!complete_suffix.isEmpty()) {
		complete_suffix.prepend('.');
	}

	QString temp_abs_path;
	do {
		temp_abs_path = original_info.dir().filePath(
			QStringLiteral("%1.tmp%2%3")
				.arg(basename, QString::number(counter), complete_suffix));
		counter++;
	} while (QFileInfo::exists(temp_abs_path));

	return temp_abs_path;
}

bool FileFunctions::rename_file_allow_overwrite(const QString &from,
											 const QString &to)
{
	if (QFileInfo::exists(to) && !QFile::remove(to)) {
		qCritical() << "Couldn't remove existing file" << to << "for overwrite";
		return false;
	}

	// By this point, we can assume `to` either never existed or has now been deleted
	if (!QFile::rename(from, to)) {
		qCritical() << "Failed to rename file" << from << "to" << to;
		return false;
	}

	return true;
}

QString FileFunctions::get_auto_recovery_root()
{
	return QDir(QStandardPaths::writableLocation(
					QStandardPaths::AppLocalDataLocation))
		.filePath(QStringLiteral("autorecovery"));
}

}