Differential D4847 Diff 12309 src/buffer/katesecuretextbuffer_p.h

Changeset View

Standalone View

src/buffer/katesecuretextbuffer_p.h

This file was added.

1		/* This file is part of the KTextEditor project.
2		*
3		* Copyright (C) 2017 KDE Developers
4		*
5		* This library is free software; you can redistribute it and/or
6		* modify it under the terms of the GNU Library General Public
7		* License as published by the Free Software Foundation; either
8		* version 2 of the License, or (at your option) any later version.
9		*
10		* This library is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Library General Public License for more details.
14		*
15		* You should have received a copy of the GNU Library General Public License
16		* along with this library; see the file COPYING.LIB. If not, write to
17		* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18		* Boston, MA 02110-1301, USA.
19		*/
20
21		#ifndef KATE_SECURE_TEXTBUFFER_H
	dfaureUnsubmitted Done ...._P_H to match the header filename dfaure: ...._P_H to match the header filename
22		#define KATE_SECURE_TEXTBUFFER_H
23
24		#include <QObject>
25		#include <QString>
26
27		#include <kauth.h>
28
29		using namespace KAuth;
30
31		/**
32		* Class used as KAuth helper binary.
33		* It is supposed to be called through KAuth action.
34		*
35		* It also contains couple of common methods intended to be used
36		* directly by TextBuffer as well as from helper binary.
37		*
38		* This class should only be used by TextBuffer.
39		*/
40		class SecureTextBuffer : public QObject
41		{
42		Q_OBJECT
43
44		public:
45
46		/**
47		* We support Prepare action for temporary file creation
48		* and Move action for moving final file to its destination
49		*/
50		enum ActionMode {
51		Prepare = 1,
52		Move = 2
53		};
54
55		SecureTextBuffer() {}
56
57		~SecureTextBuffer() {}
58
59		/**
60		* Common helper methods
61		*/
62		static void setOwner(const QString &filename, const uint ownerId, const uint groupId);
63		static void syncToDisk(const int fd);
64
65		private:
66		/**
67		* Creates temporary file based on given target file path.
68		* Temporary file is set to not be deleted on object destroy
69		* so KTextEditor can save contents in it.
70		*/
71		static QString prepareTempFileInternal(const QString &targetFile, const uint ownerId);
72
73		/**
74		* Move file to its given destination and set owner.
75		*/
76		static bool moveFileInternal(const QString &sourceFile, const QString &targetFile, const uint ownerId, const uint groupId);
77
78		public Q_SLOTS:
79		/**
80		* KAuth action to perform both prepare or move work based on given parameters.
81		* We keep this code in one method to prevent multiple KAuth user queries during one save action.
82		*/
83		static ActionReply savefile(const QVariantMap &args);
	dfaureUnsubmitted Not Done A static slot is.... creative ;-) But if it works, that's fine. dfaure: A static slot is.... creative ;-) But if it works, that's fine.
84
85		};
86
87		#endif