QAbstractFileEngine: Add permission argument to open()

The new argument allows atomic creation of files with non-default
permissions.

Task-number: QTBUG-79750
Change-Id: I4c49455b41f924ba87148302c8d0f77f5de0832b
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>

src/corelib/io/qabstractfileengine.cpp

@@ -383,10 +383,16 @@ QAbstractFileEngine::~QAbstractFileEngine()
 
     The \a mode is an OR combination of QIODevice::OpenMode and
     QIODevice::HandlingMode values.
+
+    If the file is created as a result of this call, its permissions are
+    set according to \a permissision. Null value means an implementation-
+    specific default.
 */
-bool QAbstractFileEngine::open(QIODevice::OpenMode openMode)
+bool QAbstractFileEngine::open(QIODevice::OpenMode openMode,
+                               std::optional<QFile::Permissions> permissions)
 {
     Q_UNUSED(openMode);
+    Q_UNUSED(permissions);
     return false;
 }
 

src/corelib/io/qabstractfileengine_p.h

@@ -124,7 +124,8 @@ public:
 
     virtual ~QAbstractFileEngine();
 
-    virtual bool open(QIODevice::OpenMode openMode);
+    virtual bool open(QIODevice::OpenMode openMode,
+                      std::optional<QFile::Permissions> permissions = std::nullopt);
     virtual bool close();
     virtual bool flush();
     virtual bool syncToDisk();

src/corelib/io/qfsfileengine.cpp

@@ -226,7 +226,8 @@ void QFSFileEngine::setFileName(const QString &file)
 /*!
     \reimp
 */
-bool QFSFileEngine::open(QIODevice::OpenMode openMode)
+bool QFSFileEngine::open(QIODevice::OpenMode openMode,
+                         std::optional<QFile::Permissions> permissions)
 {
     Q_ASSERT_X(openMode & QIODevice::Unbuffered, "QFSFileEngine::open",
                "QFSFileEngine no longer supports buffered mode; upper layer must buffer");
@@ -250,7 +251,7 @@ bool QFSFileEngine::open(QIODevice::OpenMode openMode)
     d->fh = nullptr;
     d->fd = -1;
 
-    return d->nativeOpen(d->openMode);
+    return d->nativeOpen(d->openMode, permissions);
 }
 
 /*!

src/corelib/io/qfsfileengine_p.h

@@ -59,6 +59,10 @@
 
 #include <optional>
 
+#ifdef Q_OS_UNIX
+#include <sys/types.h> // for mode_t
+#endif
+
 #ifndef QT_NO_FSFILEENGINE
 
 QT_BEGIN_NAMESPACE
@@ -81,7 +85,7 @@ public:
     explicit QFSFileEngine(const QString &file);
     ~QFSFileEngine();
 
-    bool open(QIODevice::OpenMode openMode) override;
+    bool open(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions) override;
     bool open(QIODevice::OpenMode flags, FILE *fh);
     bool close() override;
     bool flush() override;
@@ -156,7 +160,7 @@ public:
     QFileSystemEntry fileEntry;
     QIODevice::OpenMode openMode;
 
-    bool nativeOpen(QIODevice::OpenMode openMode);
+    bool nativeOpen(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions);
     bool openFh(QIODevice::OpenMode flags, FILE *fh);
     bool openFd(QIODevice::OpenMode flags, int fd);
     bool nativeClose();
@@ -246,6 +250,10 @@ protected:
     void init();
 
     QAbstractFileEngine::FileFlags getPermissions(QAbstractFileEngine::FileFlags type) const;
+
+#ifdef Q_OS_UNIX
+    bool nativeOpenImpl(QIODevice::OpenMode openMode, mode_t mode);
+#endif
 };
 
 QT_END_NAMESPACE

src/corelib/io/qfsfileengine_unix.cpp

@@ -39,6 +39,7 @@
 
 #include "qplatformdefs.h"
 #include "private/qabstractfileengine_p.h"
+#include "private/qfiledevice_p.h"
 #include "private/qfsfileengine_p.h"
 #include "private/qcore_unix_p.h"
 #include "qfilesystementry_p.h"
@@ -107,7 +108,16 @@ static inline QString msgOpenDirectory()
 /*!
     \internal
 */
-bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode)
+bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode,
+                                      std::optional<QFile::Permissions> permissions)
+{
+    return nativeOpenImpl(openMode, permissions ? QtPrivate::toMode_t(*permissions) : 0666);
+}
+
+/*!
+    \internal
+*/
+bool QFSFileEnginePrivate::nativeOpenImpl(QIODevice::OpenMode openMode, mode_t mode)
 {
     Q_Q(QFSFileEngine);
 
@@ -118,7 +128,7 @@ bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode)
 
         // Try to open the file in unbuffered mode.
         do {
-            fd = QT_OPEN(fileEntry.nativeFilePath().constData(), flags, 0666);
+            fd = QT_OPEN(fileEntry.nativeFilePath().constData(), flags, mode);
         } while (fd == -1 && errno == EINTR);
 
         // On failure, return and report the error.

src/corelib/io/qfsfileengine_win.cpp

@@ -39,6 +39,7 @@
 
 #include "qplatformdefs.h"
 #include "private/qabstractfileengine_p.h"
+#include "private/qfiledevice_p.h"
 #include "private/qfsfileengine_p.h"
 #include "qfilesystemengine_p.h"
 #include <qdebug.h>
@@ -95,7 +96,8 @@ QString QFSFileEnginePrivate::longFileName(const QString &path)
 /*
     \internal
 */
-bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode)
+bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode,
+                                      std::optional<QFile::Permissions> permissions)
 {
     Q_Q(QFSFileEngine);
 
@@ -115,11 +117,14 @@ bool QFSFileEnginePrivate::nativeOpen(QIODevice::OpenMode openMode)
                                 ? OPEN_ALWAYS
                                 : OPEN_EXISTING;
     // Create the file handle.
-    SECURITY_ATTRIBUTES securityAtts = { sizeof(SECURITY_ATTRIBUTES), NULL, FALSE };
+    QNativeFilePermissions nativePermissions(permissions, false);
+    if (!nativePermissions.isOk())
+        return false;
+
     fileHandle = CreateFile((const wchar_t*)fileEntry.nativeFilePath().utf16(),
                             accessRights,
                             shareMode,
-                            &securityAtts,
+                            nativePermissions.securityAttributes(),
                             creationDisp,
                             FILE_ATTRIBUTE_NORMAL,
                             NULL);

src/corelib/io/qresource.cpp

@@ -1409,8 +1409,11 @@ void QResourceFileEngine::setFileName(const QString &file)
     d->resource.setFileName(file);
 }
 
-bool QResourceFileEngine::open(QIODevice::OpenMode flags)
+bool QResourceFileEngine::open(QIODevice::OpenMode flags,
+                               std::optional<QFile::Permissions> permissions)
 {
+    Q_UNUSED(permissions);
+
     Q_D(QResourceFileEngine);
     if (d->resource.fileName().isEmpty()) {
         qWarning("QResourceFileEngine::open: Missing file name");

src/corelib/io/qresource_p.h

@@ -66,7 +66,7 @@ public:
 
     void setFileName(const QString &file) override;
 
-    bool open(QIODevice::OpenMode flags) override;
+    bool open(QIODevice::OpenMode flags, std::optional<QFile::Permissions> permissions) override;
     bool close() override;
     bool flush() override;
     qint64 size() const override;

src/corelib/io/qtemporaryfile.cpp

@@ -340,7 +340,8 @@ void QTemporaryFileEngine::setFileName(const QString &file)
     QFSFileEngine::setFileName(file);
 }
 
-bool QTemporaryFileEngine::open(QIODevice::OpenMode openMode)
+bool QTemporaryFileEngine::open(QIODevice::OpenMode openMode,
+                                std::optional<QFile::Permissions> permissions)
 {
     Q_D(QFSFileEngine);
     Q_ASSERT(!isReallyOpen());
@@ -348,7 +349,7 @@ bool QTemporaryFileEngine::open(QIODevice::OpenMode openMode)
     openMode |= QIODevice::ReadWrite;
 
     if (!filePathIsTemplate)
-        return QFSFileEngine::open(openMode);
+        return QFSFileEngine::open(openMode, permissions);
 
     QTemporaryFileName tfn(templateName);
 

src/corelib/io/qtemporaryfile_p.h

@@ -133,7 +133,7 @@ public:
     bool isReallyOpen() const;
     void setFileName(const QString &file) override;
 
-    bool open(QIODevice::OpenMode flags) override;
+    bool open(QIODevice::OpenMode flags, std::optional<QFile::Permissions> permissions) override;
     bool remove() override;
     bool rename(const QString &newName) override;
     bool renameOverwrite(const QString &newName) override;

src/plugins/platforms/android/androidcontentfileengine.cpp

@@ -54,8 +54,10 @@ AndroidContentFileEngine::AndroidContentFileEngine(const QString &f)
     setFileName(f);
 }
 
-bool AndroidContentFileEngine::open(QIODevice::OpenMode openMode)
+bool AndroidContentFileEngine::open(QIODevice::OpenMode openMode,
+                                    std::optional<QFile::Permissions> permissions)
 {
+    Q_UNUSED(permissions);
     QString openModeStr;
     if (openMode & QFileDevice::ReadOnly) {
         openModeStr += QLatin1Char('r');

src/plugins/platforms/android/androidcontentfileengine.h

@@ -46,7 +46,7 @@ class AndroidContentFileEngine : public QFSFileEngine
 {
 public:
     AndroidContentFileEngine(const QString &fileName);
-    bool open(QIODevice::OpenMode openMode) override;
+    bool open(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions) override;
     qint64 size() const override;
     FileFlags fileFlags(FileFlags type = FileInfoAll) const override;
     QString fileName(FileName file = DefaultName) const override;

src/plugins/platforms/android/qandroidassetsfileenginehandler.cpp

@@ -261,8 +261,10 @@ public:
         close();
     }
 
-    bool open(QIODevice::OpenMode openMode) override
+    bool open(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions) override
     {
+        Q_UNUSED(permissions);
+
         if (m_isFolder || (openMode & QIODevice::WriteOnly))
             return false;
         close();
@@ -358,7 +360,7 @@ public:
         m_fileName = cleanedAssetPath(file);
         switch (FolderIterator::fileType(m_fileName)) {
         case AssetItem::Type::File:
-            open(QIODevice::ReadOnly);
+            open(QIODevice::ReadOnly, std::nullopt);
             break;
         case AssetItem::Type::Folder:
             m_isFolder = true;

src/plugins/platforms/ios/optional/nsphotolibrarysupport/qiosfileengineassetslibrary.h

@@ -54,7 +54,7 @@ public:
     QIOSFileEngineAssetsLibrary(const QString &fileName);
     ~QIOSFileEngineAssetsLibrary();
 
-    bool open(QIODevice::OpenMode openMode) override;
+    bool open(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions) override;
     bool close() override;
     FileFlags fileFlags(FileFlags type) const override;
     qint64 size() const override;

src/plugins/platforms/ios/optional/nsphotolibrarysupport/qiosfileengineassetslibrary.mm

@@ -353,8 +353,11 @@ ALAsset *QIOSFileEngineAssetsLibrary::loadAsset() const
     return m_data->m_asset;
 }
 
-bool QIOSFileEngineAssetsLibrary::open(QIODevice::OpenMode openMode)
+bool QIOSFileEngineAssetsLibrary::open(QIODevice::OpenMode openMode,
+                                       std::optional<QFile::Permissions> permissions)
 {
+    Q_UNUSED(permissions);
+
     if (openMode & (QIODevice::WriteOnly | QIODevice::Text))
         return false;
     return loadAsset();

tests/auto/corelib/io/qabstractfileengine/tst_qabstractfileengine.cpp

@@ -76,8 +76,10 @@ public:
     {
     }
 
-    bool open(QIODevice::OpenMode openMode) override
+    bool open(QIODevice::OpenMode openMode, std::optional<QFile::Permissions> permissions) override
     {
+        Q_UNUSED(permissions);
+
         if (openForRead_ || openForWrite_) {
             qWarning("%s: file is already open for %s",
                      Q_FUNC_INFO,

tests/benchmarks/corelib/io/qfile/tst_bench_qfile.cpp

@@ -263,7 +263,7 @@ void tst_qfile::readBigFile()
 #ifdef QT_BUILD_INTERNAL
         case QFSFileEngineBenchmark: {
             QFSFileEngine fse(tempDir.filename);
-            fse.open(QIODevice::ReadOnly|textMode|bufferedMode);
+            fse.open(QIODevice::ReadOnly | textMode | bufferedMode, std::nullopt);
             QBENCHMARK {
                 //qWarning() << fse.supportsExtension(QAbstractFileEngine::AtEndExtension);
                 while (fse.read(buffer, blockSize)) {}
@@ -349,7 +349,7 @@ void tst_qfile::seek()
 #ifdef QT_BUILD_INTERNAL
         case QFSFileEngineBenchmark: {
             QFSFileEngine fse(tempDir.filename);
-            fse.open(QIODevice::ReadOnly | QIODevice::Unbuffered);
+            fse.open(QIODevice::ReadOnly | QIODevice::Unbuffered, std::nullopt);
             QBENCHMARK {
                 i=(i+1)%sp_size;
                 fse.seek(seekpos[i]);
@@ -426,7 +426,7 @@ void tst_qfile::open()
         case QFSFileEngineBenchmark: {
             QBENCHMARK {
                 QFSFileEngine fse(tempDir.filename);
-                fse.open(QIODevice::ReadOnly | QIODevice::Unbuffered);
+                fse.open(QIODevice::ReadOnly | QIODevice::Unbuffered, std::nullopt);
                 fse.close();
             }
         }
@@ -550,7 +550,7 @@ void tst_qfile::readSmallFiles()
             QList<QFSFileEngine*> fileList;
             for (const QString &file : files) {
                 QFSFileEngine *fse = new QFSFileEngine(tempDir.filePath(file));
-                fse->open(QIODevice::ReadOnly|textMode|bufferedMode);
+                fse->open(QIODevice::ReadOnly | textMode | bufferedMode, std::nullopt);
                 fileList.append(fse);
             }