From f43d52b6805b265ea71cfd953d35664f6411c631 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomi=20Lepp=C3=A4nen?= Date: Tue, 3 Mar 2020 13:29:53 +0200 Subject: [PATCH] [nemo-systemsettings] Add UserInfo. Contributes to JB#49173 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Implement UserInfo class that displays user information. Default constructor creates user for currently logged in user. UserInfo doesn't update automatically by itself but the data is shared between instances and thus updating one instance of the same user will change the others. Signed-off-by: Tomi Leppänen --- rpm/nemo-qml-plugin-systemsettings.spec | 1 + src/plugin/plugin.cpp | 2 + src/src.pro | 11 +- src/userinfo.cpp | 289 ++++++++++++++++++++++++ src/userinfo.h | 97 ++++++++ src/userinfo_p.h | 62 +++++ 6 files changed, 458 insertions(+), 4 deletions(-) create mode 100644 src/userinfo.cpp create mode 100644 src/userinfo.h create mode 100644 src/userinfo_p.h diff --git a/rpm/nemo-qml-plugin-systemsettings.spec b/rpm/nemo-qml-plugin-systemsettings.spec index fb7c665..aa37c89 100644 --- a/rpm/nemo-qml-plugin-systemsettings.spec +++ b/rpm/nemo-qml-plugin-systemsettings.spec @@ -32,6 +32,7 @@ BuildRequires: pkgconfig(ssu-sysinfo) >= 1.1.0 BuildRequires: pkgconfig(packagekitqt5) BuildRequires: pkgconfig(glib-2.0) BuildRequires: pkgconfig(sailfishaccesscontrol) +BuildRequires: pkgconfig(libsystemd) %description %{summary}. diff --git a/src/plugin/plugin.cpp b/src/plugin/plugin.cpp index 3db1b4a..8ffdebd 100644 --- a/src/plugin/plugin.cpp +++ b/src/plugin/plugin.cpp @@ -51,6 +51,7 @@ #include "locationsettings.h" #include "deviceinfo.h" #include "nfcsettings.h" +#include "userinfo.h" template static QObject *api_factory(QQmlEngine *, QJSEngine *) @@ -91,6 +92,7 @@ class SystemSettingsPlugin : public QQmlExtensionPlugin qmlRegisterType(uri, 1, 0, "LocationSettings"); qmlRegisterType(uri, 1, 0, "DeviceInfo"); qmlRegisterType(uri, 1, 0, "NfcSettings"); + qmlRegisterType(uri, 1, 0, "UserInfo"); } }; diff --git a/src/src.pro b/src/src.pro index d5e865b..a07fb07 100644 --- a/src/src.pro +++ b/src/src.pro @@ -7,7 +7,7 @@ QT -= gui CONFIG += c++11 hide_symbols link_pkgconfig PKGCONFIG += profile mlite5 mce timed-qt5 libshadowutils blkid libcrypto nemomodels-qt5 libsailfishkeyprovider connman-qt5 glib-2.0 -PKGCONFIG += ssu-sysinfo nemodbus packagekitqt5 +PKGCONFIG += ssu-sysinfo nemodbus packagekitqt5 libsystemd system(qdbusxml2cpp -p mceiface.h:mceiface.cpp mce.xml) @@ -37,7 +37,8 @@ SOURCES += \ udisks2block.cpp \ udisks2blockdevices.cpp \ udisks2job.cpp \ - udisks2monitor.cpp + udisks2monitor.cpp \ + userinfo.cpp PUBLIC_HEADERS = \ languagemodel.h \ @@ -60,7 +61,8 @@ PUBLIC_HEADERS = \ systemsettingsglobal.h \ deviceinfo.h \ locationsettings.h \ - timezoneinfo.h + timezoneinfo.h \ + userinfo.h HEADERS += \ $$PUBLIC_HEADERS \ @@ -76,7 +78,8 @@ HEADERS += \ partitionmanager_p.h \ udisks2blockdevices_p.h \ udisks2job_p.h \ - udisks2monitor_p.h + udisks2monitor_p.h \ + userinfo_p.h DEFINES += \ SYSTEMSETTINGS_BUILD_LIBRARY diff --git a/src/userinfo.cpp b/src/userinfo.cpp new file mode 100644 index 0000000..d2823f4 --- /dev/null +++ b/src/userinfo.cpp @@ -0,0 +1,289 @@ +/* + * Copyright (C) 2020 Open Mobile Platform LLC. + * + * You may use this file under the terms of the BSD license as follows: + * + * "Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Nemo Mobile nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + */ + +#include "userinfo.h" +#include "userinfo_p.h" + +#include +#include +#include + +namespace { + +enum SpecialIds : uid_t { + DeviceOwnerId = 100000, + InvalidId = (uid_t)(-1), +}; + +QString nameFromGecos(const char *gecos) +{ + // typically GECOS has (sub)fields separated by "," + // and the first one of them is full name of the user. + // Sometimes it contains just the full name or it might be empty, + // thus do this on best effort basis. + auto name = QString::fromUtf8(gecos); + int i = name.indexOf(QStringLiteral(",")); + if (i != -1) + name.truncate(i); + return name; +} + +} + +UserInfoPrivate::UserInfoPrivate() + : m_uid(InvalidId) + , m_loggedIn(false) +{ +} + +UserInfoPrivate::UserInfoPrivate(struct passwd *pwd) + : m_uid(pwd->pw_uid) + , m_username(QString::fromUtf8(pwd->pw_name)) + , m_name(nameFromGecos(pwd->pw_gecos)) + // require_active == false -> both online and active are logged in. + // Specifying seat should make sure that remote users are not + // counted as they don't have seats. + , m_loggedIn(sd_uid_is_on_seat(m_uid, 0, "seat0") > 0) +{ +} + +UserInfoPrivate::~UserInfoPrivate() +{ +} + +QWeakPointer UserInfoPrivate::s_current; + +void UserInfoPrivate::set(struct passwd *pwd) +{ + QString username; + QString name; + + if (pwd) { + Q_ASSERT(pwd->pw_uid == m_uid); + username = QString::fromUtf8(pwd->pw_name); + name = nameFromGecos(pwd->pw_gecos); + } else if (m_uid != InvalidId) { + m_uid = InvalidId; + emit uidChanged(); + } + + if (m_username != username) { + m_username = username; + emit usernameChanged(); + } + + if (m_name != name) { + m_name = name; + emit nameChanged(); + } +} + +/** + * Construct UserInfo for the current user + * + * If it has been constructed before, this reuses the old data. + */ +UserInfo::UserInfo() +{ + if (!UserInfoPrivate::s_current.isNull()) { + d_ptr = QSharedPointer(UserInfoPrivate::s_current); + } + if (d_ptr.isNull()) { + uid_t uid = InvalidId; + struct passwd *pwd; + if (sd_seat_get_active("seat0", NULL, &uid) < 0 || uid == InvalidId || !(pwd = getpwuid(uid))) { + d_ptr = QSharedPointer(new UserInfoPrivate); + } else { + d_ptr = QSharedPointer(new UserInfoPrivate(pwd)); + } + // pwd must not be free'd + } + if (current()) + UserInfoPrivate::s_current = d_ptr; + connectSignals(); +} + +UserInfo::UserInfo(const UserInfo &other) + : QObject(other.parent()) + , d_ptr(other.d_ptr) +{ + connectSignals(); +} + +/** + * Construct UserInfo by uid + */ +UserInfo::UserInfo(int uid) +{ + struct passwd *pwd = (uid_t)uid != InvalidId ? getpwuid((uid_t)uid) : nullptr; + if (pwd) { + d_ptr = QSharedPointer(new UserInfoPrivate(pwd)); + } else { + d_ptr = QSharedPointer(new UserInfoPrivate); + } + // pwd must not be free'd + if (current()) + UserInfoPrivate::s_current = d_ptr; + connectSignals(); +} + +/** + * Construct UserInfo by username + */ +UserInfo::UserInfo(QString username) +{ + struct passwd *pwd = getpwnam(username.toUtf8().constData()); + if (pwd) { + d_ptr = QSharedPointer(new UserInfoPrivate(pwd)); + } else { + d_ptr = QSharedPointer(new UserInfoPrivate); + } + // pwd must not be free'd + if (current()) + UserInfoPrivate::s_current = d_ptr; + connectSignals(); +} + +/** + * Construct a placeholder user that doesn't exist + * + * Placeholder users are always invalid. + */ +UserInfo UserInfo::placeholder() +{ + return UserInfo(InvalidId); +} + +UserInfo::~UserInfo() +{ +} + +/** + * Returns true if user exists + */ +bool UserInfo::isValid() const +{ + Q_D(const UserInfo); + return d->m_uid != InvalidId; +} + +QString UserInfo::username() const +{ + Q_D(const UserInfo); + return d->m_username; +} + +void UserInfo::setUsername(QString username) +{ + Q_D(UserInfo); + if (d->m_username != username) { + d->m_username = username; + emit d_ptr->usernameChanged(); + } +} + +QString UserInfo::name() const +{ + Q_D(const UserInfo); + return d->m_name; +} + +void UserInfo::setName(QString name) +{ + Q_D(UserInfo); + if (d->m_name != name) { + d->m_name = name; + emit d_ptr->nameChanged(); + } +} + +UserInfo::UserType UserInfo::type() const +{ + Q_D(const UserInfo); + // Device lock considers user with id 100000 as device owner. + // Some other places consider the user belonging to sailfish-system + // as device owner. We have to pick one here. + return (d->m_uid == DeviceOwnerId) ? DeviceOwner : User; +} + +int UserInfo::uid() const +{ + Q_D(const UserInfo); + return (int)d->m_uid; +} + +/** + * Returs true if user is logged in on seat0 and is the active user, i.e. the current user + */ +bool UserInfo::current() const +{ + Q_D(const UserInfo); + // Any logged in user (on seat0) must be the current one + // since we don't have multisession. + return d->m_loggedIn; +} + +void UserInfo::reset() +{ + Q_D(UserInfo); + d->set((isValid()) ? getpwuid(d->m_uid) : nullptr); +} + +UserInfo &UserInfo::operator=(const UserInfo &other) +{ + if (this == &other) + return *this; + + d_ptr = other.d_ptr; + + return *this; +} + +bool UserInfo::operator==(const UserInfo &other) const +{ + if (!isValid()) + return false; + return d_ptr == other.d_ptr; +} + +bool UserInfo::operator!=(const UserInfo &other) const +{ + if (!isValid()) + return true; + return d_ptr != other.d_ptr; +} + +void UserInfo::connectSignals() +{ + connect(d_ptr.data(), &UserInfoPrivate::usernameChanged, this, &UserInfo::usernameChanged); + connect(d_ptr.data(), &UserInfoPrivate::nameChanged, this, &UserInfo::nameChanged); + connect(d_ptr.data(), &UserInfoPrivate::uidChanged, this, &UserInfo::uidChanged); +} diff --git a/src/userinfo.h b/src/userinfo.h new file mode 100644 index 0000000..e3efe18 --- /dev/null +++ b/src/userinfo.h @@ -0,0 +1,97 @@ +/* + * Copyright (C) 2020 Open Mobile Platform LLC. + * + * You may use this file under the terms of the BSD license as follows: + * + * "Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Nemo Mobile nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + */ + +#ifndef USERINFO_H +#define USERINFO_H + +#include +#include +#include + +#include "systemsettingsglobal.h" + +class UserInfoPrivate; + +class SYSTEMSETTINGS_EXPORT UserInfo: public QObject +{ + Q_OBJECT + Q_DECLARE_PRIVATE(UserInfo) + + Q_PROPERTY(QString username READ username NOTIFY usernameChanged) + Q_PROPERTY(QString name READ name NOTIFY nameChanged) + Q_PROPERTY(UserType type READ type CONSTANT) + Q_PROPERTY(int uid READ uid NOTIFY uidChanged) + Q_PROPERTY(bool current READ current CONSTANT) + +public: + enum UserType { + User = 0, + DeviceOwner = 1, + }; + Q_ENUM(UserType) + + UserInfo(); + UserInfo(const UserInfo &other); + ~UserInfo(); + + static UserInfo placeholder(); + + bool isValid() const; + + QString username() const; + QString name() const; + UserType type() const; + int uid() const; + bool current() const; + + Q_INVOKABLE void reset(); + + UserInfo &operator=(const UserInfo &other); + bool operator==(const UserInfo &other) const; + bool operator!=(const UserInfo &other) const; + +signals: + void usernameChanged(); + void nameChanged(); + void uidChanged(); + +private: + explicit UserInfo(int uid); + explicit UserInfo(QString username); + + void setUsername(QString username); + void setName(QString name); + + void connectSignals(); + + QSharedPointer d_ptr; +}; +#endif /* USERINFO_H */ diff --git a/src/userinfo_p.h b/src/userinfo_p.h new file mode 100644 index 0000000..9e61568 --- /dev/null +++ b/src/userinfo_p.h @@ -0,0 +1,62 @@ +/* + * Copyright (C) 2020 Open Mobile Platform LLC. + * + * You may use this file under the terms of the BSD license as follows: + * + * "Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Nemo Mobile nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + */ + +#ifndef USERINFOPRIVATE_H +#define USERINFOPRIVATE_H + +#include +#include +#include + +class UserInfoPrivate : public QObject +{ + Q_OBJECT + +public: + UserInfoPrivate(); + UserInfoPrivate(struct passwd *pwd); + ~UserInfoPrivate(); + + uid_t m_uid; + QString m_username; + QString m_name; + bool m_loggedIn; + static QWeakPointer s_current; + + void set(struct passwd *pwd); + +signals: + void usernameChanged(); + void nameChanged(); + void uidChanged(); +}; + +#endif /* USERINFOPRIVATE_H */