1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 David Faure <faure+bluesystems@kde.org>
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QLOCKFILE_P_H
41 #define QLOCKFILE_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtCore/private/qglobal_p.h>
55 #include <QtCore/qlockfile.h>
56 #include <QtCore/qfile.h>
57 
58 #include <qplatformdefs.h>
59 
60 #ifdef Q_OS_WIN
61 #include <io.h>
62 #include <qt_windows.h>
63 #endif
64 
65 QT_BEGIN_NAMESPACE
66 
67 class QLockFilePrivate
68 {
69 public:
QLockFilePrivate(const QString & fn)70     QLockFilePrivate(const QString &fn)
71         : fileName(fn),
72 #ifdef Q_OS_WIN
73           fileHandle(INVALID_HANDLE_VALUE),
74 #else
75           fileHandle(-1),
76 #endif
77           staleLockTime(30 * 1000), // 30 seconds
78           lockError(QLockFile::NoError),
79           isLocked(false)
80     {
81     }
82     QLockFile::LockError tryLock_sys();
83     bool removeStaleLock();
84     QByteArray lockFileContents() const;
85     // Returns \c true if the lock belongs to dead PID, or is old.
86     // The attempt to delete it will tell us if it was really stale or not, though.
87     bool isApparentlyStale() const;
88 
89     // used in dbusmenu
90     Q_CORE_EXPORT static QString processNameByPid(qint64 pid);
91     static bool isProcessRunning(qint64 pid, const QString &appname);
92 
93     QString fileName;
94 #ifdef Q_OS_WIN
95     Qt::HANDLE fileHandle;
96 #else
97     int fileHandle;
98 #endif
99     int staleLockTime; // "int milliseconds" is big enough for 24 days
100     QLockFile::LockError lockError;
101     bool isLocked;
102 
getLockFileHandle(QLockFile * f)103     static int getLockFileHandle(QLockFile *f)
104     {
105         int fd;
106 #ifdef Q_OS_WIN
107         // Use of this function on Windows WILL leak a file descriptor.
108         fd = _open_osfhandle(intptr_t(f->d_func()->fileHandle), 0);
109 #else
110         fd = f->d_func()->fileHandle;
111 #endif
112         QT_LSEEK(fd, 0, SEEK_SET);
113         return fd;
114     }
115 };
116 
117 QT_END_NAMESPACE
118 
119 #endif /* QLOCKFILE_P_H */
120