modernize: Use raw string literals instead of escaped strings
[quassel.git] / src / common / identity.cpp
index c35b841..9d885e0 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
+#include "identity.h"
+
 #include <QMetaProperty>
 #include <QVariantMap>
+#include <QString>
 
-#include "identity.h"
+#ifdef Q_OS_MAC
+#  include <CoreServices/CoreServices.h>
+#  include "mac_utils.h"
+#endif
+
+#ifdef Q_OS_UNIX
+#  include <sys/types.h>
+#  include <pwd.h>
+#  include <unistd.h>
+#endif
+
+#ifdef Q_OS_WIN
+#  include <windows.h>
+#  include <Winbase.h>
+#  define SECURITY_WIN32
+#  include <Security.h>
+#endif
+
+Identity::Identity(IdentityId id, QObject *parent)
+    : SyncableObject(parent),
+    _identityId(id)
+{
+    init();
+    setToDefaults();
+}
+
+
+Identity::Identity(const Identity &other, QObject *parent)
+    : SyncableObject(parent),
+    _identityId(other.id()),
+    _identityName(other.identityName()),
+    _realName(other.realName()),
+    _nicks(other.nicks()),
+    _awayNick(other.awayNick()),
+    _awayNickEnabled(other.awayNickEnabled()),
+    _awayReason(other.awayReason()),
+    _awayReasonEnabled(other.awayReasonEnabled()),
+    _autoAwayEnabled(other.autoAwayEnabled()),
+    _autoAwayTime(other.autoAwayTime()),
+    _autoAwayReason(other.autoAwayReason()),
+    _autoAwayReasonEnabled(other.autoAwayReasonEnabled()),
+    _detachAwayEnabled(other.detachAwayEnabled()),
+    _detachAwayReason(other.detachAwayReason()),
+    _detachAwayReasonEnabled(other.detachAwayReasonEnabled()),
+    _ident(other.ident()),
+    _kickReason(other.kickReason()),
+    _partReason(other.partReason()),
+    _quitReason(other.quitReason())
+{
+    init();
+}
+
+
+#ifdef Q_OS_WIN
+#ifdef UNICODE
+QString tcharToQString(TCHAR *tchar)
+{
+    return QString::fromUtf16(reinterpret_cast<ushort *>(tchar));
+}
+
+
+#else
+QString tcharToQString(TCHAR *tchar)
+{
+    return QString::fromLocal8Bit(tchar);
+}
+
+
+#endif
+
+#endif
+void Identity::init()
+{
+    setObjectName(QString::number(id().toInt()));
+    setAllowClientUpdates(true);
+}
+
+
+QString Identity::defaultNick()
+{
+    QString nick = QString("quassel%1").arg(qrand() & 0xff); // FIXME provide more sensible default nicks
+
+#ifdef Q_OS_MAC
+    QString shortUserName = CFStringToQString(CSCopyUserName(true));
+    if (!shortUserName.isEmpty())
+        nick = shortUserName;
+
+#elif defined(Q_OS_UNIX)
+    QString userName;
+    struct passwd *pwd = getpwuid(getuid());
+    if (pwd)
+        userName = pwd->pw_name;
+    if (!userName.isEmpty())
+        nick = userName;
+
+#elif defined(Q_OS_WIN)
+    TCHAR infoBuf[128];
+    DWORD bufCharCount = 128;
+    //if(GetUserNameEx(/* NameSamCompatible */ 1, infoBuf, &bufCharCount))
+    if (GetUserNameEx(NameSamCompatible, infoBuf, &bufCharCount)) {
+        QString nickName(tcharToQString(infoBuf));
+        int lastBs = nickName.lastIndexOf('\\');
+        if (lastBs != -1) {
+            nickName = nickName.mid(lastBs + 1);
+        }
+        if (!nickName.isEmpty())
+            nick = nickName;
+    }
+#endif
+
+    // cleaning forbidden characters from nick
+    QRegExp rx(QString("(^[\\d-]+|[^A-Za-z0-9\x5b-\x60\x7b-\x7d])"));  // NOLINT(modernize-raw-string-literal)
+    nick.remove(rx);
+    return nick;
+}
+
+
+QString Identity::defaultRealName()
+{
+    QString generalDefault = tr("Quassel IRC User");
+
+#ifdef Q_OS_MAC
+    return CFStringToQString(CSCopyUserName(false));
+
+#elif defined(Q_OS_UNIX)
+    QString realName;
+    struct passwd *pwd = getpwuid(getuid());
+    if (pwd)
+        realName = QString::fromUtf8(pwd->pw_gecos);
+    if (!realName.isEmpty())
+        return realName;
+    else
+        return generalDefault;
+
+#elif defined(Q_OS_WIN)
+    TCHAR infoBuf[128];
+    DWORD bufCharCount = 128;
+    if (GetUserName(infoBuf, &bufCharCount))
+        return tcharToQString(infoBuf);
+    else
+        return generalDefault;
+#else
+    return generalDefault;
+#endif
+}
 
-Identity::Identity(IdentityId id, QObject *parent) : QObject(parent), _identityId(id) {
-  init();
-  setToDefaults();
+
+void Identity::setToDefaults()
+{
+    setIdentityName(tr("<empty>"));
+    setRealName(defaultRealName());
+    QStringList n = QStringList() << defaultNick();
+    setNicks(n);
+    setAwayNick("");
+    setAwayNickEnabled(false);
+    setAwayReason(tr("Gone fishing."));
+    setAwayReasonEnabled(true);
+    setAutoAwayEnabled(false);
+    setAutoAwayTime(10);
+    setAutoAwayReason(tr("Not here. No, really. not here!"));
+    setAutoAwayReasonEnabled(false);
+    setDetachAwayEnabled(false);
+    setDetachAwayReason(tr("All Quassel clients vanished from the face of the earth..."));
+    setDetachAwayReasonEnabled(false);
+    setIdent("quassel");
+    setKickReason(tr("Kindergarten is elsewhere!"));
+    setPartReason(tr("https://quassel-irc.org - Chat comfortably. Anywhere."));
+    setQuitReason(tr("https://quassel-irc.org - Chat comfortably. Anywhere."));
 }
 
-Identity::Identity(const Identity &other, QObject *parent) : QObject(parent),
-            _identityId(other.id()),
-            _identityName(other.identityName()),
-            _realName(other.realName()),
-            _nicks(other.nicks()),
-            _awayNick(other.awayNick()),
-            _awayReason(other.awayReason()),
-            _returnMessage(other.returnMessage()) {
-  init();
+
+/*** setters ***/
+
+void Identity::setId(IdentityId _id)
+{
+    _identityId = _id;
+    SYNC(ARG(_id))
+    emit idSet(_id);
+    renameObject(QString::number(id().toInt()));
 }
 
-void Identity::init() {
-  _initialized = false;
-  setObjectName(QString::number(id()));
+
+void Identity::setIdentityName(const QString &identityName)
+{
+    _identityName = identityName;
+    SYNC(ARG(identityName))
 }
 
-void Identity::setToDefaults() {
-  setIdentityName(tr("Default Identity"));
-  setRealName(tr("Quassel IRC User"));
-  QStringList n;
-  n << QString("quassel%1").arg(qrand() & 0xff); // FIXME provide more sensible default nicks
-  setNicks(n);
-  setAwayNick("");
-  setAwayReason(tr("Gone fishing."));
-  setReturnMessage(tr("Brought fish."));
 
+void Identity::setRealName(const QString &realName)
+{
+    _realName = realName;
+    SYNC(ARG(realName))
 }
 
-bool Identity::initialized() const {
-  return _initialized;
+
+void Identity::setNicks(const QStringList &nicks)
+{
+    _nicks = nicks;
+    SYNC(ARG(nicks))
+    emit nicksSet(nicks);
 }
 
-void Identity::setInitialized() {
-  _initialized = true;
+
+void Identity::setAwayNick(const QString &nick)
+{
+    _awayNick = nick;
+    SYNC(ARG(nick))
 }
 
-IdentityId Identity::id() const {
-  return _identityId;
+
+void Identity::setAwayReason(const QString &reason)
+{
+    _awayReason = reason;
+    SYNC(ARG(reason))
 }
 
-QString Identity::identityName() const {
-  return _identityName;
+
+void Identity::setAwayNickEnabled(bool enabled)
+{
+    _awayNickEnabled = enabled;
+    SYNC(ARG(enabled))
 }
 
-QString Identity::realName() const {
-  return _realName;
+
+void Identity::setAwayReasonEnabled(bool enabled)
+{
+    _awayReasonEnabled = enabled;
+    SYNC(ARG(enabled))
 }
 
-QStringList Identity::nicks() const {
-  return _nicks;
+
+void Identity::setAutoAwayEnabled(bool enabled)
+{
+    _autoAwayEnabled = enabled;
+    SYNC(ARG(enabled))
+}
+
+
+void Identity::setAutoAwayTime(int time)
+{
+    _autoAwayTime = time;
+    SYNC(ARG(time))
 }
 
-QString Identity::awayNick() const {
-  return _awayNick;
+
+void Identity::setAutoAwayReason(const QString &reason)
+{
+    _autoAwayReason = reason;
+    SYNC(ARG(reason))
+}
+
+
+void Identity::setAutoAwayReasonEnabled(bool enabled)
+{
+    _autoAwayReasonEnabled = enabled;
+    SYNC(ARG(enabled))
 }
 
-QString Identity::awayReason() const {
-  return _awayReason;
+
+void Identity::setDetachAwayEnabled(bool enabled)
+{
+    _detachAwayEnabled = enabled;
+    SYNC(ARG(enabled))
 }
 
-QString Identity::returnMessage() const {
-  return _returnMessage;
+
+void Identity::setDetachAwayReason(const QString &reason)
+{
+    _detachAwayReason = reason;
+    SYNC(ARG(reason))
 }
 
-//////////////////////
 
-void Identity::setIdentityName(const QString &identityName) {
-  _identityName = identityName;
-  emit identityNameSet(identityName);
+void Identity::setDetachAwayReasonEnabled(bool enabled)
+{
+    _detachAwayReasonEnabled = enabled;
+    SYNC(ARG(enabled))
 }
 
-void Identity::setRealName(const QString &realName) {
-  _realName = realName;
-  emit realNameSet(realName);
+
+void Identity::setIdent(const QString &ident)
+{
+    _ident = ident;
+    SYNC(ARG(ident))
 }
 
-void Identity::setNicks(const QStringList &nicks) {
-  _nicks = nicks;
-  emit nicksSet(nicks);
+
+void Identity::setKickReason(const QString &reason)
+{
+    _kickReason = reason;
+    SYNC(ARG(reason))
 }
 
-void Identity::setAwayNick(const QString &nick) {
-  _awayNick = nick;
-  emit awayNickSet(nick);
+
+void Identity::setPartReason(const QString &reason)
+{
+    _partReason = reason;
+    SYNC(ARG(reason))
 }
 
-void Identity::setAwayReason(const QString &reason) {
-  _awayReason = reason;
-  emit awayReasonSet(reason);
+
+void Identity::setQuitReason(const QString &reason)
+{
+    _quitReason = reason;
+    SYNC(ARG(reason))
 }
 
-void Identity::setReturnMessage(const QString &message) {
-  _returnMessage = message;
-  emit returnMessageSet(message);
+
+/***  ***/
+
+void Identity::copyFrom(const Identity &other)
+{
+    for (int idx = staticMetaObject.propertyOffset(); idx < staticMetaObject.propertyCount(); idx++) {
+        QMetaProperty metaProp = staticMetaObject.property(idx);
+        Q_ASSERT(metaProp.isValid());
+        if (this->property(metaProp.name()) != other.property(metaProp.name())) {
+            setProperty(metaProp.name(), other.property(metaProp.name()));
+        }
+    }
 }
 
-void Identity::update(const Identity &other) {
-  for(int idx = 0; idx < metaObject()->propertyCount(); idx++) {
-    QMetaProperty metaProp = metaObject()->property(metaObject()->propertyOffset() + idx);
-    Q_ASSERT(metaProp.isValid());
-    if(this->property(metaProp.name()) != other.property(metaProp.name())) {
-      setProperty(metaProp.name(), other.property(metaProp.name()));
+
+bool Identity::operator==(const Identity &other) const
+{
+    for (int idx = staticMetaObject.propertyOffset(); idx < staticMetaObject.propertyCount(); idx++) {
+        QMetaProperty metaProp = staticMetaObject.property(idx);
+        Q_ASSERT(metaProp.isValid());
+        QVariant v1 = this->property(metaProp.name());
+        QVariant v2 = other.property(metaProp.name()); // qDebug() << v1 << v2;
+        // QVariant cannot compare custom types, so we need to check for this special case
+        if (QString(v1.typeName()) == "IdentityId") {
+            if (v1.value<IdentityId>() != v2.value<IdentityId>()) return false;
+        }
+        else {
+            if (v1 != v2) return false;
+        }
     }
-  }
+    return true;
+}
+
+
+bool Identity::operator!=(const Identity &other) const
+{
+    return !(*this == other);
 }
 
+
 ///////////////////////////////
 
-// we use a hash, so we can easily extend identities without breaking saved ones
-QDataStream &operator<<(QDataStream &out, const Identity &id) {
-  QVariantMap i;
-  i["IdentityId"] = id.id();
-  i["IdentityName"] = id.identityName();
-  i["RealName"] = id.realName();
-  i["Nicks"] = id.nicks();
-  i["AwayNick"] = id.awayNick();
-  i["AwayReason"] = id.awayReason();
-  i["ReturnMessage"] = id.returnMessage();
-  out << i;
-  return out;
-}
-
-QDataStream &operator>>(QDataStream &in, Identity &id) {
-  QVariantMap i;
-  in >> i;
-  id._identityId = i["IdentityId"].toUInt();
-  id.setIdentityName(i["IdentityName"].toString());
-  id.setRealName(i["RealName"].toString());
-  id.setNicks(i["Nicks"].toStringList());
-  id.setAwayNick(i["AwayNick"].toString());
-  id.setAwayReason(i["AwayReason"].toString());
-  id.setReturnMessage(i["ReturnMessage"].toString());
-  return in;
+QDataStream &operator<<(QDataStream &out, Identity id)
+{
+    out << id.toVariantMap();
+    return out;
+}
+
+
+QDataStream &operator>>(QDataStream &in, Identity &id)
+{
+    QVariantMap i;
+    in >> i;
+    id.fromVariantMap(i);
+    return in;
 }