Differential D6197 Diff 16738 src/ioslaves/file/kauth/filehelper.h

Changeset View

Standalone View

View Options

src/ioslaves/file/kauth/filehelper.h

  • This file was added.
1​/***
2​ Copyright (C) 2017 by Chinmoy Ranjan Pradhan <chinmoyrp65@gmail.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Lesser General Public
6​ License as published by the Free Software Foundation; either
7​ version 2.1 of the License, or (at your option) version 3, or any
8​ later version accepted by the membership of KDE e.V. (or its
9​ successor approved by the membership of KDE e.V.), which shall
10​ act as a proxy defined in Section 6 of version 3 of the license.
11​
12​ This library is distributed in the hope that it will be useful,
13​ but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ Lesser General Public License for more details.
16​
17​ You should have received a copy of the GNU Lesser General Public
18​ License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​***/
20​
21​
22​#ifndef HELPER_H
23​#define HELPER_H
dfaureUnsubmitted
Not Done

should be FILEHELPER_H to match the filename

dfaure: should be FILEHELPER_H to match the filename
24​
25​#include <KAuth>
26​
27​using namespace KAuth;
28​
29​/**
30​ * The KAuth Helper class responsible for performing file operations after
31​ * privileges are elevated.
32​ *
33​ * @since 5.37
34​ */
dfaureUnsubmitted
Not Done

This isn't public API -> no @since.

dfaure: This isn't public API -> no @since.
35​class FileHelper : public QObject
36​{
37​ Q_OBJECT
38​
39​public Q_SLOTS:
40​ /**
41​ * Change file permission(s), ownership and timestamp.
42​ *
43​ * @param args the path of file and the changes.
44​ **/
45​ ActionReply change(const QVariantMap &args);
46​
47​ /**
48​ * Create an empty directory or a symlink.
49​ *
50​ * @param args the path of new directory or symlink and its target.
51​ **/
52​ ActionReply create(const QVariantMap &args);
53​
54​ /**
55​ * Delete a file or an empty directory.
56​ *
57​ * @param args the path of file or directory to delete
58​ */
59​ ActionReply del(const QVariantMap &args);
60​
61​ /**
62​ * Open a file with restricted read access for reading or for writing
63​ * inside a write-protected directory and send the open file descriptor
64​ * back to file ioslave by means of unix local domain sockets.
65​ *
66​ * @param args the path of file to open
67​ */
68​ ActionReply open(const QVariantMap &args);
69​
70​ /**
71​ * Rename a file.
72​ *
73​ * @param args the path of file to rename and the new name.
74​ */
75​ ActionReply rename(const QVariantMap &args);
76​};
77​
78​#endif