qquickfiledialog.cpp

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include "qquickfiledialog_p.h"
 
#include <QtCore/qlist.h>
#include <QtCore/qloggingcategory.h>
#include <QtQml/qqmlfile.h>
#include <QtQml/qqmlinfo.h>
#if QT_CONFIG(quick_listview) && QT_CONFIG(quick_draganddrop)
#include <QtQuickDialogs2QuickImpl/private/qquickplatformfiledialog_p.h>
#include <QtQuickDialogs2QuickImpl/private/qquickfiledialogimpl_p.h>
#endif
 
#include <QtQuickDialogs2Utils/private/qquickfilenamefilter_p.h>
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
Q_STATIC_LOGGING_CATEGORY(lcFileDialog, "qt.quick.dialogs.filedialog")
 
/*!
    \qmltype FileDialog
    \inherits Dialog
//!     \nativetype QQuickFileDialog
    \inqmlmodule QtQuick.Dialogs
    \since 6.2
    \brief A file dialog.
 
    The FileDialog type provides a QML API for file dialogs.
 
    \image qtquickdialogs-filedialog-gtk.png {The file dialog type allow dialogs to copy the native look and feel of the platform}
 
    To show a file dialog, construct an instance of FileDialog, set the desired
    properties, and call \l {Dialog::}{open()}. The \l currentFolder property
    can be used to determine the folder in which the dialog opens. The
    \l selectedFile and \l selectedFiles properties can be used to determine
    which file(s) are selected when the dialog opens, and are also updated
    when the user selects a file in the dialog and when the dialog is accepted.
 
    \snippet qtquickdialogs-filedialog.qml file
 
    \section2 Availability
 
    A native platform file dialog is currently available on the following platforms:
 
    \list
    \li Android
    \li iOS
    \li Linux (when running with the GTK+ platform theme)
    \li macOS
    \li Windows
    \endlist
 
    \include includes/fallback.qdocinc
 
    \sa FolderDialog, {QtCore::}{StandardPaths}
*/
 
QQuickFileDialog::QQuickFileDialog(QObject *parent)
    : QQuickAbstractDialog(QQuickDialogType::FileDialog, parent),
      m_fileMode(OpenFile),
      m_options(QFileDialogOptions::create()),
      m_selectedNameFilter(nullptr)
{
    m_options->setFileMode(QFileDialogOptions::ExistingFile);
    m_options->setAcceptMode(QFileDialogOptions::AcceptOpen);
    m_options->setSupportedSchemes({u"file"_s});
}
 
/*!
    \qmlproperty enumeration QtQuick.Dialogs::FileDialog::fileMode
 
    This property holds the mode of the dialog.
 
    Available values:
    \value FileDialog.OpenFile The dialog is used to select an existing file (default).
    \value FileDialog.OpenFiles The dialog is used to select multiple existing files.
    \value FileDialog.SaveFile The dialog is used to select any file. The file does not have to exist.
    \value FileDialog.OpenUrl The dialog is used to select an existing URL.
    \value FileDialog.OpenUrls The dialog is used to select multiple existing URLs.
    \value FileDialog.SaveUrl The dialog is used to select any URL. The file does not have to exist.
*/
QQuickFileDialog::FileMode QQuickFileDialog::fileMode() const
{
    return m_fileMode;
}
 
void QQuickFileDialog::setFileMode(FileMode mode)
{
    qCDebug(lcFileDialog) << "setFileMode called with" << mode;
    if (mode == m_fileMode)
        return;
 
    m_options->setSupportedSchemes(QStringList());
    switch (mode) {
    case OpenFile:
        m_options->setSupportedSchemes(QStringList(u"file"_s));
        [[fallthrough]];
    case OpenUrl:
        m_options->setFileMode(QFileDialogOptions::ExistingFile);
        m_options->setAcceptMode(QFileDialogOptions::AcceptOpen);
        break;
    case OpenFiles:
        m_options->setSupportedSchemes(QStringList(u"file"_s));
        [[fallthrough]];
    case OpenUrls:
        m_options->setFileMode(QFileDialogOptions::ExistingFiles);
        m_options->setAcceptMode(QFileDialogOptions::AcceptOpen);
        break;
    case SaveFile:
        m_options->setSupportedSchemes(QStringList(u"file"_s));
        [[fallthrough]];
    case SaveUrl:
        m_options->setFileMode(QFileDialogOptions::AnyFile);
        m_options->setAcceptMode(QFileDialogOptions::AcceptSave);
        break;
    default:
        break;
    }
 
    m_fileMode = mode;
    emit fileModeChanged();
}
 
/*!
    \qmlproperty url QtQuick.Dialogs::FileDialog::selectedFile
 
    This property holds the last file that was selected in the dialog.
 
    It can be set to control the file that is selected when the dialog is
    opened.
 
    If there are multiple selected files, this property refers to the first
    file.
 
    The value of this property is updated each time the user selects a file in
    the dialog, and when the dialog is accepted. Handle the
    \l {Dialog::}{accepted()} signal to get the final selection.
 
    \sa selectedFiles, {Dialog::}{accepted()}, currentFolder
*/
QUrl QQuickFileDialog::selectedFile() const
{
    return addDefaultSuffix(m_selectedFiles.value(0));
}
 
void QQuickFileDialog::setSelectedFile(const QUrl &selectedFile)
{
    setSelectedFiles({ selectedFile });
}
 
/*!
    \qmlproperty list<url> QtQuick.Dialogs::FileDialog::selectedFiles
 
    This property holds the last files that were selected in the dialog.
 
    The value of this property is updated each time the user selects files in
    the dialog, and when the dialog is accepted. Handle the
    \l {Dialog::}{accepted()} signal to get the final selection.
 
    \sa {Dialog::}{accepted()}, currentFolder
*/
QList<QUrl> QQuickFileDialog::selectedFiles() const
{
    return addDefaultSuffixes(m_selectedFiles);
}
 
void QQuickFileDialog::setSelectedFiles(const QList<QUrl> &selectedFiles)
{
    qCDebug(lcFileDialog) << "setSelectedFiles called with" << selectedFiles;
    if (m_selectedFiles == selectedFiles)
        return;
 
    if ((m_fileMode == SaveFile || m_fileMode == SaveUrl) && selectedFiles.size() > 1) {
        qmlWarning(this) << "Cannot set more than one selected file when fileMode is SaveFile";
        return;
    }
 
    if (m_fileMode != SaveFile && m_fileMode != SaveUrl) {
        for (const auto &selectedFile : selectedFiles) {
            if ((m_fileMode == OpenUrl || m_fileMode == OpenUrls) && selectedFile.scheme() != "file"_L1)
                // we can't test existence for non-local URLs
                continue;
            const QString selectedFilePath = QQmlFile::urlToLocalFileOrQrc(selectedFile);
            if (!QFileInfo::exists(selectedFilePath)) {
                qmlWarning(this) << "Cannot set " << selectedFilePath
                    << " as a selected file because it doesn't exist";
                return;
            }
        }
    }
 
    const auto newFirstSelectedFile = selectedFiles.value(0);
    const bool firstChanged = m_selectedFiles.value(0) != newFirstSelectedFile;
    m_selectedFiles = selectedFiles;
    m_options->setInitiallySelectedFiles(m_selectedFiles);
    if (firstChanged) {
        emit selectedFileChanged();
        emit currentFileChanged();
    }
    emit selectedFilesChanged();
    emit currentFilesChanged();
}
 
/*!
    \qmlproperty url QtQuick.Dialogs::FileDialog::currentFile
    \deprecated [6.3] Use \l selectedFile instead.
 
    This property holds the currently selected file in the dialog.
 
    \sa selectedFile, currentFiles, currentFolder
*/
QUrl QQuickFileDialog::currentFile() const
{
    return selectedFile();
}
 
void QQuickFileDialog::setCurrentFile(const QUrl &file)
{
    setSelectedFiles(QList<QUrl>() << file);
}
 
/*!
    \qmlproperty list<url> QtQuick.Dialogs::FileDialog::currentFiles
    \deprecated [6.3] Use \l selectedFiles instead.
 
    This property holds the currently selected files in the dialog.
 
    \sa selectedFiles, currentFile, currentFolder
*/
QList<QUrl> QQuickFileDialog::currentFiles() const
{
    return selectedFiles();
}
 
void QQuickFileDialog::setCurrentFiles(const QList<QUrl> &currentFiles)
{
    setSelectedFiles(currentFiles);
}
 
/*!
    \qmlproperty url QtQuick.Dialogs::FileDialog::currentFolder
 
    This property holds the folder where files are selected. It can be set to
    control the initial directory that is shown when the dialog is opened.
 
    For selecting a folder, use \l FolderDialog instead.
*/
QUrl QQuickFileDialog::currentFolder() const
{
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(handle()))
        return fileDialog->directory();
 
    // If we're not using a native file dialog and the folder is invalid,
    // return the current directory.
    if (!m_options->initialDirectory().isValid())
        return QUrl::fromLocalFile(QDir::currentPath());
 
    return m_options->initialDirectory();
}
 
void QQuickFileDialog::setCurrentFolder(const QUrl &currentFolder)
{
    qCDebug(lcFileDialog) << "setCurrentFolder called with" << currentFolder;
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(handle()))
        fileDialog->setDirectory(currentFolder);
    m_options->setInitialDirectory(currentFolder);
}
 
/*!
    \qmlproperty flags QtQuick.Dialogs::FileDialog::options
 
    This property holds the various options that affect the look and feel of the dialog.
 
    By default, all options are disabled.
 
    Options should be set before showing the dialog. Setting them while the dialog is
    visible is not guaranteed to have an immediate effect on the dialog (depending on
    the option and on the platform).
 
    Available options:
    \value FileDialog.DontResolveSymlinks Don't resolve symlinks in the file dialog. By default symlinks are resolved.
    \value FileDialog.DontConfirmOverwrite Don't ask for confirmation if an existing file is selected. By default confirmation is requested.
    \value FileDialog.ReadOnly Indicates that the dialog doesn't allow creating directories.
    \value FileDialog.HideNameFilterDetails Indicates if the file name filter details are hidden or not.
    \value FileDialog.DontUseNativeDialog Forces the dialog to use a non-native quick implementation.
*/
QFileDialogOptions::FileDialogOptions QQuickFileDialog::options() const
{
    return m_options->options();
}
 
void QQuickFileDialog::setOptions(QFileDialogOptions::FileDialogOptions options)
{
    if (options == m_options->options())
        return;
 
    m_options->setOptions(options);
    emit optionsChanged();
}
 
void QQuickFileDialog::resetOptions()
{
    setOptions({});
}
 
/*!
    \qmlproperty list<string> QtQuick.Dialogs::FileDialog::nameFilters
 
    This property holds the filters that restrict the types of files that
    can be selected.
 
    \code
    FileDialog {
        nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
    }
    \endcode
 
    Different platforms may restrict the files that can be selected in
    different ways. For example, macOS will disable file entries that do not
    match the filters, whereas Windows will hide them.
 
    \note \b{*.*} is not a portable filter, because the historical assumption
    that the file extension determines the file type is not consistent on every
    operating system. It is possible to have a file with no dot in its name (for
    example, \c Makefile). In a native Windows file dialog, \b{*.*} will match
    such files, while in other types of file dialogs it may not. So it is better
    to use \b{*} if you mean to select any file.
 
    \sa selectedNameFilter
*/
QStringList QQuickFileDialog::nameFilters() const
{
    return m_options->nameFilters();
}
 
void QQuickFileDialog::setNameFilters(const QStringList &filters)
{
    qCDebug(lcFileDialog).nospace() << "setNameFilters called with " << filters
        << " (old filters were: " << m_options->nameFilters() << ")";
    if (filters == m_options->nameFilters())
        return;
 
    m_options->setNameFilters(filters);
    if (m_selectedNameFilter) {
        int index = m_selectedNameFilter->index();
        if (index < 0 || index >= filters.size())
            index = 0;
        m_selectedNameFilter->update(filters.value(index));
    }
    emit nameFiltersChanged();
}
 
void QQuickFileDialog::resetNameFilters()
{
    setNameFilters(QStringList());
}
 
/*!
    \qmlproperty int QtQuick.Dialogs::FileDialog::selectedNameFilter.index
    \qmlproperty string QtQuick.Dialogs::FileDialog::selectedNameFilter.name
    \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.extensions
    \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.globs
 
    These properties hold the currently selected name filter.
 
    \table
    \header
        \li Name
        \li Description
    \row
        \li \b index : int
        \li This property determines which \l {nameFilters}{name filter} is selected.
            The specified filter is selected when the dialog is opened. The value is
            updated when the user selects another filter.
    \row
        \li [read-only] \b name : string
        \li This property holds the name of the selected filter. In the
            example below, the name of the first filter is \c {"Text files"}
            and the second is \c {"HTML files"}.
    \row
        \li [read-only] \b extensions : list<string>
        \li This property holds the list of extensions of the selected filter.
            In the example below, the list of extensions of the first filter is
            \c {["txt"]} and the second is \c {["html", "htm"]}.
    \row
        \li [read-only] \b globs : list<string>
        \li This property holds the list of globs of the selected filter.
            In the example below, the list of globs of the first filter is
            \c {["*.txt"]} and the second is \c {["*.html", "*.htm"]}.
 
            This property is useful in conjunction with \l {FolderListModel}'s
            \l {FolderListModel::}{nameFilters} property, for example.
    \endtable
 
    \code
    FileDialog {
        id: fileDialog
        selectedNameFilter.index: 1
        nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
    }
 
    MyDocument {
        id: document
        fileType: fileDialog.selectedNameFilter.extensions[0]
    }
    \endcode
 
    \sa nameFilters
*/
QQuickFileNameFilter *QQuickFileDialog::selectedNameFilter() const
{
    if (!m_selectedNameFilter) {
        QQuickFileDialog *that = const_cast<QQuickFileDialog *>(this);
        m_selectedNameFilter = new QQuickFileNameFilter(that);
        m_selectedNameFilter->setOptions(m_options);
    }
    return m_selectedNameFilter;
}
 
/*!
    \qmlproperty string QtQuick.Dialogs::FileDialog::defaultSuffix
 
    This property holds a suffix that is added to selected files that have
    no suffix specified. The suffix is typically used to indicate the file
    type (e.g. "txt" indicates a text file).
 
    If the first character is a dot ('.'), it is removed.
*/
QString QQuickFileDialog::defaultSuffix() const
{
    return m_options->defaultSuffix();
}
 
void QQuickFileDialog::setDefaultSuffix(const QString &suffix)
{
    if (suffix == m_options->defaultSuffix())
        return;
 
    m_options->setDefaultSuffix(suffix);
    emit defaultSuffixChanged();
}
 
void QQuickFileDialog::resetDefaultSuffix()
{
    setDefaultSuffix(QString());
}
 
/*!
    \qmlproperty string QtQuick.Dialogs::FileDialog::acceptLabel
 
    This property holds the label text shown on the button that accepts the dialog.
 
    When set to an empty string, the default label of the underlying platform is used.
    The default label is typically \uicontrol Open or \uicontrol Save depending on which
    \l fileMode the dialog is used in.
 
    The default value is an empty string.
 
    \sa rejectLabel
*/
QString QQuickFileDialog::acceptLabel() const
{
    return m_options->labelText(QFileDialogOptions::Accept);
}
 
void QQuickFileDialog::setAcceptLabel(const QString &label)
{
    if (label == m_options->labelText(QFileDialogOptions::Accept))
        return;
 
    m_options->setLabelText(QFileDialogOptions::Accept, label);
    emit acceptLabelChanged();
}
 
void QQuickFileDialog::resetAcceptLabel()
{
    setAcceptLabel(QString());
}
 
/*!
    \qmlproperty string QtQuick.Dialogs::FileDialog::rejectLabel
 
    This property holds the label text shown on the button that rejects the dialog.
 
    When set to an empty string, the default label of the underlying platform is used.
    The default label is typically \uicontrol Cancel.
 
    The default value is an empty string.
 
    \sa acceptLabel
*/
QString QQuickFileDialog::rejectLabel() const
{
    return m_options->labelText(QFileDialogOptions::Reject);
}
 
void QQuickFileDialog::setRejectLabel(const QString &label)
{
    if (label == m_options->labelText(QFileDialogOptions::Reject))
        return;
 
    m_options->setLabelText(QFileDialogOptions::Reject, label);
    emit rejectLabelChanged();
}
 
void QQuickFileDialog::resetRejectLabel()
{
    setRejectLabel(QString());
}
 
bool QQuickFileDialog::useNativeDialog() const
{
    if (!QQuickAbstractDialog::useNativeDialog())
        return false;
 
    if (m_options->testOption(QFileDialogOptions::DontUseNativeDialog)) {
        qCDebug(lcDialogs) << "  - the FileDialog was told not to use a native dialog; not using native dialog";
        return false;
    }
 
    return true;
}
 
void QQuickFileDialog::onCreate(QPlatformDialogHelper *dialog)
{
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(dialog)) {
        connect(fileDialog, &QPlatformFileDialogHelper::currentChanged,
                this, [this, fileDialog](){ setSelectedFiles(fileDialog->selectedFiles()); });
        connect(fileDialog, &QPlatformFileDialogHelper::directoryEntered, this, &QQuickFileDialog::currentFolderChanged);
        fileDialog->setOptions(m_options);
 
        // If the user didn't set an initial selectedFile, ensure that we are synced
        // with the underlying dialog in case it has set an initially selected file
        // (as QQuickFileDialogImplPrivate::updateSelectedFile does).
        if (m_options->initiallySelectedFiles().isEmpty()) {
            const auto selectedFiles = fileDialog->selectedFiles();
            if (!selectedFiles.isEmpty())
                setSelectedFiles(selectedFiles);
        }
    }
}
 
void QQuickFileDialog::onShow(QPlatformDialogHelper *dialog)
{
    m_options->setWindowTitle(title());
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(dialog)) {
        // Ensure that a name filter is always selected.
        int index = selectedNameFilter()->index();
        if (index == -1)
            index = 0;
        const QString filter = m_options->nameFilters().value(index);
        m_options->setInitiallySelectedNameFilter(filter);
 
        fileDialog->setOptions(m_options); // setOptions only assigns a member and isn't virtual
 
        connect(fileDialog, &QPlatformFileDialogHelper::filterSelected, m_selectedNameFilter, &QQuickFileNameFilter::update);
        fileDialog->selectNameFilter(filter);
 
        // If both selectedFile and currentFolder are set, prefer the former.
        if (!m_options->initiallySelectedFiles().isEmpty()) {
            // The user set an initial selectedFile.
            const QUrl selectedFile = m_options->initiallySelectedFiles().first();
            fileDialog->selectFile(selectedFile);
        } else {
            // The user set an initial currentFolder.
            const QUrl initialDir = m_options->initialDirectory();
            // If it's not valid, or it's a file and not a directory, we shouldn't set it.
            if (m_firstShow && initialDir.isValid() && QDir(QQmlFile::urlToLocalFileOrQrc(initialDir)).exists())
                fileDialog->setDirectory(m_options->initialDirectory());
        }
    }
#if QT_CONFIG(quick_listview) && QT_CONFIG(quick_draganddrop)
    if (QQuickPlatformFileDialog *fileDialog = qobject_cast<QQuickPlatformFileDialog *>(dialog); fileDialog && fileDialog->dialog())
        fileDialog->dialog()->setPopupType(m_popupType);
#endif
 
    QQuickAbstractDialog::onShow(dialog);
}
 
void QQuickFileDialog::onHide(QPlatformDialogHelper *dialog)
{
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(dialog)) {
        if (m_selectedNameFilter)
            disconnect(fileDialog, &QPlatformFileDialogHelper::filterSelected, m_selectedNameFilter, &QQuickFileNameFilter::update);
    }
}
 
QUrl QQuickFileDialog::addDefaultSuffix(const QUrl &file) const
{
    QUrl url = file;
    const QString path = url.path();
    const QString suffix = m_options->defaultSuffix();
    // Urls with "content" scheme do not require suffixes. Such schemes are
    // used on Android.
    const bool isContentScheme = url.scheme() == u"content"_s;
    if (!isContentScheme && !suffix.isEmpty() && !path.endsWith(QLatin1Char('/'))
        && path.lastIndexOf(QLatin1Char('.')) == -1) {
        url.setPath(path + QLatin1Char('.') + suffix);
    }
    return url;
}
 
void QQuickFileDialog::accept()
{
    if (QPlatformFileDialogHelper *fileDialog = qobject_cast<QPlatformFileDialogHelper *>(handle())) {
        // Take the currently selected files and make them the final set of files.
        setSelectedFiles(fileDialog->selectedFiles());
    }
    QQuickAbstractDialog::accept();
}
 
QList<QUrl> QQuickFileDialog::addDefaultSuffixes(const QList<QUrl> &files) const
{
    QList<QUrl> urls;
    urls.reserve(files.size());
    for (const QUrl &file : files)
        urls += addDefaultSuffix(file);
    return urls;
}
 
QT_END_NAMESPACE
 
#include "moc_qquickfiledialog_p.cpp"