Cleanup allowing for tags to be available at later points, adds TAGMSG
[quassel.git] / src / common / message.cpp
index 3a8dbc6..1367b40 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-2019 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 "message.h"
-
-#include "util.h"
+#include <utility>
 
 #include <QDataStream>
 
-Message::Message(BufferInfo __buffer, Type __type, QString __text, QString __sender, quint8 __flags)
-  : _buffer(__buffer), _text(__text), _sender(__sender), _type(__type), _flags(__flags) {
-  _timestamp = QDateTime::currentDateTime().toUTC();
-}
-
-Message::Message(QDateTime __ts, BufferInfo __buffer, Type __type, QString __text, QString __sender, quint8 __flags)
-  : _timestamp(__ts), _buffer(__buffer), _text(__text), _sender(__sender), _type(__type), _flags(__flags) {
-
-}
-
-MsgId Message::msgId() const {
-  return _msgId;
-}
+#include "message.h"
+#include "peer.h"
+#include "signalproxy.h"
+#include "util.h"
 
-void Message::setMsgId(MsgId _id) {
-  _msgId = _id;
-}
+Message::Message(BufferInfo bufferInfo,
+                 Type type,
+                 QString contents,
+                 QString sender,
+                 QString senderPrefixes,
+                 QString realName,
+                 QString avatarUrl,
+                 Flags flags)
+    : _timestamp(QDateTime::currentDateTime().toUTC())
+    , _bufferInfo(std::move(bufferInfo))
+    , _contents(std::move(contents))
+    , _sender(std::move(sender))
+    , _senderPrefixes(std::move(senderPrefixes))
+    , _realName(std::move(realName))
+    , _avatarUrl(std::move(avatarUrl))
+    , _type(type)
+    , _flags(flags)
+{}
+
+Message::Message(QDateTime ts,
+                 BufferInfo bufferInfo,
+                 Type type,
+                 QString contents,
+                 QString sender,
+                 QString senderPrefixes,
+                 QString realName,
+                 QString avatarUrl,
+                 Flags flags)
+    : _timestamp(std::move(ts))
+    , _bufferInfo(std::move(bufferInfo))
+    , _contents(std::move(contents))
+    , _sender(std::move(sender))
+    , _senderPrefixes(std::move(senderPrefixes))
+    , _realName(std::move(realName))
+    , _avatarUrl(std::move(avatarUrl))
+    , _type(type)
+    , _flags(flags)
+{}
+
+QDataStream& operator<<(QDataStream& out, const Message& msg)
+{
+    Q_ASSERT(SignalProxy::current());
+    Q_ASSERT(SignalProxy::current()->targetPeer());
+
+    // We do not serialize the sender prefixes until we have a new protocol or client-features implemented
+    out << msg.msgId();
+
+    if (SignalProxy::current()->targetPeer()->hasFeature(Quassel::Feature::LongTime)) {
+        // toMSecs returns a qint64, signed rather than unsigned
+        out << (qint64) msg.timestamp().toMSecsSinceEpoch();
+    }
+    else {
+        out << (quint32) msg.timestamp().toTime_t();
+    }
 
-BufferInfo Message::buffer() const {
-  return _buffer;
-}
+    out << (quint32) msg.type()
+        << (quint8) msg.flags()
+        << msg.bufferInfo()
+        << msg.sender().toUtf8();
 
-QString Message::text() const {
-  return _text;
-}
+    if (SignalProxy::current()->targetPeer()->hasFeature(Quassel::Feature::SenderPrefixes))
+        out << msg.senderPrefixes().toUtf8();
 
-QString Message::sender() const {
-  return _sender;
-}
+    if (SignalProxy::current()->targetPeer()->hasFeature(Quassel::Feature::RichMessages)) {
+        out << msg.realName().toUtf8();
+        out << msg.avatarUrl().toUtf8();
+    }
 
-Message::Type Message::type() const {
-   return _type;
+    out << msg.contents().toUtf8();
+    return out;
 }
 
-quint8 Message::flags() const {
-   return _flags;
-}
+QDataStream& operator>>(QDataStream& in, Message& msg)
+{
+    Q_ASSERT(SignalProxy::current());
+    Q_ASSERT(SignalProxy::current()->sourcePeer());
 
-QDateTime Message::timestamp() const {
-  return _timestamp;
-}
+    in >> msg._msgId;
 
-QString Message::mircToInternal(QString mirc) {
-  mirc.replace('%', "%%");      // escape % just to be sure
-  mirc.replace('\x02', "%B");
-  mirc.replace('\x0f', "%O");
-  mirc.replace('\x12', "%R");
-  mirc.replace('\x16', "%R");
-  mirc.replace('\x1d', "%S");
-  mirc.replace('\x1f', "%U");
-
-  // Now we bring the color codes (\x03) in a sane format that can be parsed more easily later.
-  // %Dcfxx is foreground, %Dcbxx is background color, where xx is a 2 digit dec number denoting the color code.
-  // %Dc- turns color off.
-  // Note: We use the "mirc standard" as described in <http://www.mirc.co.uk/help/color.txt>.
-  //       This means that we don't accept something like \x03,5 (even though others, like WeeChat, do).
-  int pos = 0;
-  for(;;) {
-    pos = mirc.indexOf('\x03', pos);
-    if(pos < 0) break; // no more mirc color codes
-    QString ins, num;
-    int l = mirc.length();
-    int i = pos + 1;
-    // check for fg color
-    if(i < l && mirc[i].isDigit()) {
-      num = mirc[i++];
-      if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
-      else num.prepend('0');
-      ins = QString("%Dcf%1").arg(num);
-
-      if(i+1 < l && mirc[i] == ',' && mirc[i+1].isDigit()) {
-        i++;
-        num = mirc[i++];
-        if(i < l && mirc[i].isDigit()) num.append(mirc[i++]);
-        else num.prepend('0');
-        ins += QString("%Dcb%1").arg(num);
-      }
-    } else {
-      ins = "%Dc-";
+    if (SignalProxy::current()->sourcePeer()->hasFeature(Quassel::Feature::LongTime)) {
+        // timestamp is a qint64, signed rather than unsigned
+        qint64 timeStamp;
+        in >> timeStamp;
+        msg._timestamp = QDateTime::fromMSecsSinceEpoch(timeStamp);
     }
-    mirc.replace(pos, i-pos, ins);
-  }
-  return mirc;
-}
-
-void Message::format() {
-  if(!_formattedText.isNull()) return; // already done
-  QString user = userFromMask(sender());
-  QString host = hostFromMask(sender());
-  QString nick = nickFromMask(sender());
-  QString txt = mircToInternal(text());
-  QString networkName = buffer().network();
-  QString bufferName = buffer().buffer();
-
-  _formattedTimestamp = tr("%DT[%1]").arg(timestamp().toLocalTime().toString("hh:mm:ss"));
-
-  QString s, t;
-  switch(type()) {
-    case Message::Plain:
-      s = tr("%DS<%1>").arg(nick); t = tr("%D0%1").arg(txt); break;
-    case Message::Server:
-      s = tr("%Ds*"); t = tr("%Ds%1").arg(txt); break;
-    case Message::Error:
-      s = tr("%De*"); t = tr("%De%1").arg(txt); break;
-    case Message::Join:
-      s = tr("%Dj-->"); t = tr("%Dj%DN%DU%1%DU%DN %DH(%2@%3)%DH has joined %DC%DU%4%DU%DC").arg(nick, user, host, bufferName); break;
-    case Message::Part:
-      s = tr("%Dp<--"); t = tr("%Dp%DN%DU%1%DU%DN %DH(%2@%3)%DH has left %DC%DU%4%DU%DC").arg(nick, user, host, bufferName);
-      if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
-      break;
-    case Message::Quit:
-      s = tr("%Dq<--"); t = tr("%Dq%DN%DU%1%DU%DN %DH(%2@%3)%DH has quit").arg(nick, user, host);
-      if(!txt.isEmpty()) t = QString("%1 (%2)").arg(t).arg(txt);
-      break;
-    case Message::Kick:
-    { s = tr("%Dk<-*");
-    QString victim = txt.section(" ", 0, 0);
-        //if(victim == ui.ownNick->currentText()) victim = tr("you");
-    QString kickmsg = txt.section(" ", 1);
-    t = tr("%Dk%DN%DU%1%DU%DN has kicked %DN%DU%2%DU%DN from %DC%DU%3%DU%DC").arg(nick).arg(victim).arg(bufferName);
-    if(!kickmsg.isEmpty()) t = QString("%1 (%2)").arg(t).arg(kickmsg);
+    else {
+        quint32 timeStamp;
+        in >> timeStamp;
+        msg._timestamp = QDateTime::fromTime_t(timeStamp);
     }
-    break;
-    case Message::Nick:
-      s = tr("%Dr<->");
-      if(nick == text()) t = tr("%DrYou are now known as %DN%1%DN").arg(txt);
-      else t = tr("%Dr%DN%1%DN is now known as %DN%DU%2%DU%DN").arg(nick, txt);
-      break;
-    case Message::Mode:
-      s = tr("%Dm***");
-      if(nick.isEmpty()) t = tr("%DmUser mode: %DM%1%DM").arg(text());
-      else t = tr("%DmMode %DM%1%DM by %DN%DU%2%DU%DN").arg(txt, nick);
-      break;
-    case Message::Action:
-      s = tr("%Da-*-");
-      t = tr("%Da%DN%DU%1%DU%DN %2").arg(nick).arg(txt);
-      break;
-    default:
-      s = tr("%De%1").arg(sender());
-      t = tr("%De[%1]").arg(txt);
-  }
-  _formattedSender = s;
-  _formattedText = t;
-}
 
-QString Message::formattedTimestamp() {
-  format();
-  return _formattedTimestamp;
-}
+    quint32 type;
+    in >> type;
+    msg._type = Message::Type(type);
 
-QString Message::formattedSender() {
-  format();
-  return _formattedSender;
-}
+    quint8 flags;
+    in >> flags;
+    msg._flags = Message::Flags(flags);
 
-QString Message::formattedText() {
-  format();
-  return _formattedText;
-}
+    in >> msg._bufferInfo;
 
-/*
-QString Message::formattedToHtml(const QString &f) {
+    QByteArray sender;
+    in >> sender;
+    msg._sender = QString::fromUtf8(sender);
 
+    QByteArray senderPrefixes;
+    if (SignalProxy::current()->sourcePeer()->hasFeature(Quassel::Feature::SenderPrefixes))
+        in >> senderPrefixes;
+    msg._senderPrefixes = QString::fromUtf8(senderPrefixes);
 
-  return f;
-}
-*/
+    QByteArray realName;
+    QByteArray avatarUrl;
+    if (SignalProxy::current()->sourcePeer()->hasFeature(Quassel::Feature::RichMessages)) {
+        in >> realName;
+        in >> avatarUrl;
+    }
+    msg._realName = QString::fromUtf8(realName);
+    msg._avatarUrl = QString::fromUtf8(avatarUrl);
 
-QDataStream &operator<<(QDataStream &out, const Message &msg) {
-  out << (quint32)msg.timestamp().toTime_t() << (quint8)msg.type() << (quint8)msg.flags()
-      << msg.buffer() << msg.sender().toUtf8() << msg.text().toUtf8();
-  return out;
-}
+    QByteArray contents;
+    in >> contents;
+    msg._contents = QString::fromUtf8(contents);
 
-QDataStream &operator>>(QDataStream &in, Message &msg) {
-  quint8 t, f;
-  quint32 ts;
-  QByteArray s, m;
-  BufferInfo buf;
-  in >> ts >> t >> f >> buf >> s >> m;
-  msg._type = (Message::Type)t;
-  msg._flags = (quint8)f;
-  msg._buffer = buf;
-  msg._timestamp = QDateTime::fromTime_t(ts);
-  msg._sender = QString::fromUtf8(s);
-  msg._text = QString::fromUtf8(m);
-  return in;
+    return in;
 }
 
+QDebug operator<<(QDebug dbg, const Message& msg)
+{
+    dbg.nospace() << qPrintable(QString("Message(MsgId:")) << msg.msgId()
+                  << qPrintable(QString(",")) << msg.timestamp()
+                  << qPrintable(QString(", Type:")) << msg.type()
+                  << qPrintable(QString(", RealName:")) << msg.realName()
+                  << qPrintable(QString(", AvatarURL:")) << msg.avatarUrl()
+                  << qPrintable(QString(", Flags:")) << msg.flags()
+                  << qPrintable(QString(")"))
+                  << msg.senderPrefixes() << msg.sender() << ":"
+                  << msg.contents();
+    return dbg;
+}