1/*
2 SPDX-FileCopyrightText: 2000-2002 Stephan Kulow <coolo@kde.org>
3 SPDX-FileCopyrightText: 2000-2002 David Faure <faure@kde.org>
4 SPDX-FileCopyrightText: 2000-2002 Waldo Bastian <bastian@kde.org>
5
6 SPDX-License-Identifier: LGPL-2.0-or-later
7*/
8
9#ifndef __file_h__
10#define __file_h__
11
12#include <kio/global.h>
13#include <kio/workerbase.h>
14
15#include <KUser>
16#include <QFile>
17#include <QHash>
18#include <QObject>
19
20#include <config-kioworker-file.h>
21#include <qplatformdefs.h> // mode_t
22
23#if HAVE_SYS_ACL_H
24#include <sys/acl.h>
25#endif
26#if HAVE_ACL_LIBACL_H
27#include <acl/libacl.h>
28#endif
29
30#include "file_p.h"
31
32#include <QLoggingCategory>
33Q_DECLARE_LOGGING_CATEGORY(KIO_FILE)
34
35class FileProtocol : public QObject, public KIO::WorkerBase
36{
37 Q_OBJECT
38public:
39 FileProtocol(const QByteArray &pool, const QByteArray &app);
40 ~FileProtocol() override;
41
42 KIO::WorkerResult get(const QUrl &url) override;
43 KIO::WorkerResult put(const QUrl &url, int _mode, KIO::JobFlags _flags) override;
44 KIO::WorkerResult copy(const QUrl &src, const QUrl &dest, int mode, KIO::JobFlags flags) override;
45 KIO::WorkerResult rename(const QUrl &src, const QUrl &dest, KIO::JobFlags flags) override;
46 KIO::WorkerResult symlink(const QString &target, const QUrl &dest, KIO::JobFlags flags) override;
47
48 KIO::WorkerResult stat(const QUrl &url) override;
49 KIO::WorkerResult listDir(const QUrl &url) override;
50 KIO::WorkerResult mkdir(const QUrl &url, int permissions) override;
51 KIO::WorkerResult chmod(const QUrl &url, int permissions) override;
52 KIO::WorkerResult chown(const QUrl &url, const QString &owner, const QString &group) override;
53 KIO::WorkerResult setModificationTime(const QUrl &url, const QDateTime &mtime) override;
54 KIO::WorkerResult del(const QUrl &url, bool isfile) override;
55 KIO::WorkerResult open(const QUrl &url, QIODevice::OpenMode mode) override;
56 KIO::WorkerResult read(KIO::filesize_t size) override;
57 KIO::WorkerResult write(const QByteArray &data) override;
58 KIO::WorkerResult seek(KIO::filesize_t offset) override;
59 KIO::WorkerResult truncate(KIO::filesize_t length) override;
60 bool copyXattrs(const int src_fd, const int dest_fd);
61 KIO::WorkerResult close() override;
62
63 KIO::WorkerResult fileSystemFreeSpace(const QUrl &url) override;
64
65 /*!
66 * Special commands supported by this worker:
67 * 1 - mount
68 * 2 - unmount
69 */
70 KIO::WorkerResult special(const QByteArray &data) override;
71 KIO::WorkerResult unmount(const QString &point);
72 KIO::WorkerResult mount(bool _ro, const char *_fstype, const QString &dev, const QString &point);
73
74#if HAVE_POSIX_ACL
75 static bool isExtendedACL(acl_t acl);
76#endif
77
78private:
79 int setACL(const char *path, mode_t perm, bool _directoryDefault);
80 KIO::WorkerResult deleteRecursive(const QString &path);
81
82 bool privilegeOperationUnitTestMode();
83 KIO::WorkerResult execWithElevatedPrivilege(ActionType action, const QVariantList &args, int errcode);
84 KIO::WorkerResult tryOpen(QFile &f, const QByteArray &path, int flags, int mode, int errcode);
85
86 // We want to execute chmod/chown/utime with elevated privileges (in copy & put)
87 // only during the brief period privileges are elevated. If it's not the case show
88 // a warning and continue.
89 KIO::WorkerResult tryChangeFileAttr(ActionType action, const QVariantList &args, int errcode);
90
91 KIO::WorkerResult redirect(const QUrl &url);
92
93 // Close without calling finish(). Use this to close after error.
94 void closeWithoutFinish();
95
96private:
97 QFile *mFile;
98
99 bool resultWasCancelled(KIO::WorkerResult result);
100
101 bool testMode = false;
102 KIO::StatDetails getStatDetails();
103};
104
105#endif
106

source code of kio/src/kioworkers/file/file.h