Introduce a Message type (#506)

src/Message.cpp

@@ -0,0 +1,177 @@
+/*
+ * Copyright (C) 2004-2015 ZNC, see the NOTICE file for details.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <znc/Message.h>
+#include <znc/Utils.h>
+
+CMessage::CMessage(const CString& sMessage)
+{
+	Parse(sMessage);
+	InitTime();
+}
+
+CMessage::CMessage(const CNick& Nick, const CString& sCommand, const VCString& vsParams, const MCString& mssTags)
+	: m_Nick(Nick), m_sCommand(sCommand), m_vsParams(vsParams), m_mssTags(mssTags)
+{
+	InitTime();
+}
+
+CString CMessage::GetParams(unsigned int uIdx, unsigned int uLen) const
+{
+	VCString vsParams;
+	if (uLen > m_vsParams.size() - uIdx - 1) {
+		uLen = m_vsParams.size() - uIdx - 1;
+	}
+	for (unsigned int i = uIdx; i <= uIdx + uLen; ++i) {
+		CString sParam = m_vsParams[i];
+		if (sParam.Contains(" ")) {
+			sParam = ":" + sParam;
+		}
+		vsParams.push_back(sParam);
+	}
+	return CString(" ").Join(vsParams.begin(), vsParams.end());
+}
+
+CString CMessage::GetParam(unsigned int uIdx) const
+{
+	if (uIdx >= m_vsParams.size()) {
+		return "";
+	}
+	return m_vsParams[uIdx];
+}
+
+void CMessage::SetParam(unsigned int uIdx, const CString& sParam)
+{
+	if (uIdx >= m_vsParams.size()) {
+		m_vsParams.resize(uIdx + 1);
+	}
+	m_vsParams[uIdx] = sParam;
+}
+
+CString CMessage::GetTag(const CString& sKey) const
+{
+	MCString::const_iterator it = m_mssTags.find(sKey);
+	if (it != m_mssTags.end()) {
+		return it->second;
+	}
+	return "";
+}
+
+void CMessage::SetTag(const CString& sKey, const CString& sValue)
+{
+	m_mssTags[sKey] = sValue;
+}
+
+CString CMessage::ToString(unsigned int uFlags) const
+{
+	CString sMessage;
+
+	// <prefix>
+	if (!(uFlags & ExcludePrefix)) {
+		CString sPrefix = m_Nick.GetHostMask();
+		if (!sPrefix.empty()) {
+			sMessage += ":" + sPrefix;
+		}
+	}
+
+	// <command>
+	if (!m_sCommand.empty()) {
+		if (!sMessage.empty()) {
+			sMessage += " ";
+		}
+		sMessage += m_sCommand;
+	}
+
+	// <params>
+	for (const CString& sParam : m_vsParams) {
+		sMessage += " ";
+		if (sParam.Contains(" ")) {
+			sMessage += ":";
+		}
+		sMessage += sParam;
+	}
+
+	// <tags>
+	if (!(uFlags & ExcludeTags)) {
+		CUtils::SetMessageTags(sMessage, m_mssTags);
+	}
+
+	return sMessage;
+}
+
+void CMessage::Parse(CString sMessage)
+{
+	// <tags>
+	if (sMessage.StartsWith("@")) {
+		m_mssTags = CUtils::GetMessageTags(sMessage);
+		sMessage = sMessage.Token(1, true);
+	}
+
+	//  <message>  ::= [':' <prefix> <SPACE> ] <command> <params> <crlf>
+	//  <prefix>   ::= <servername> | <nick> [ '!' <user> ] [ '@' <host> ]
+	//  <command>  ::= <letter> { <letter> } | <number> <number> <number>
+	//  <SPACE>    ::= ' ' { ' ' }
+	//  <params>   ::= <SPACE> [ ':' <trailing> | <middle> <params> ]
+	//  <middle>   ::= <Any *non-empty* sequence of octets not including SPACE
+	//                 or NUL or CR or LF, the first of which may not be ':'>
+	//  <trailing> ::= <Any, possibly *empty*, sequence of octets not including
+	//                   NUL or CR or LF>
+
+	// <prefix>
+	if (sMessage.TrimLeft(":")) {
+		m_Nick.Parse(sMessage.Token(0));
+		sMessage = sMessage.Token(1, true);
+	}
+
+	// <command>
+	m_sCommand = sMessage.Token(0);
+	sMessage = sMessage.Token(1, true);
+
+	// <params>
+	m_vsParams.clear();
+	while (!sMessage.empty()) {
+		if (sMessage.TrimLeft(":")) {
+			m_vsParams.push_back(sMessage);
+			sMessage.clear();
+		} else {
+			m_vsParams.push_back(sMessage.Token(0));
+			sMessage = sMessage.Token(1, true);
+		}
+	}
+}
+
+void CMessage::InitTime()
+{
+	auto it = m_mssTags.find("time");
+	if (it != m_mssTags.end()) {
+		m_time = CUtils::ParseServerTime(it->second);
+		return;
+	}
+
+#ifdef HAVE_CLOCK_GETTIME
+	timespec ts;
+	if (clock_gettime(CLOCK_REALTIME, &ts) == 0) {
+		m_time.tv_sec = ts.tv_sec;
+		m_time.tv_usec = ts.tv_nsec / 1000;
+		return;
+	}
+#endif
+
+	if (!gettimeofday(&m_time, nullptr)) {
+		m_time.tv_sec = time(nullptr);
+		m_time.tv_usec = 0;
+	}
+}