1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
|
/*
* Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
* Author: imaginos <imaginos@imaginos.net>
*
* 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.
*/
/*
* Quiet Away and message logger
*
* I originally wrote this module for when I had multiple clients connected to
*ZNC. I would leave work and forget to close my client, arriving at home
* and re-attaching there someone may have messaged me in commute and I wouldn't
*know it until I would arrive back at work the next day. I wrote it such that
* my xchat client would monitor desktop activity and ping the module to let it
*know I was active. Within a few minutes of inactivity the pinging stops and
* the away module sets the user as away and logging commences.
*/
#define REQUIRESSL
#include <znc/main.h>
#include <znc/User.h>
#include <znc/IRCNetwork.h>
#include <znc/FileUtils.h>
#include <znc/Modules.h>
#include <znc/Chan.h>
using std::vector;
using std::map;
#define CRYPT_VERIFICATION_TOKEN "::__:AWAY:__::"
class CAway;
class CAwayJob : public CTimer {
public:
CAwayJob(CModule* pModule, unsigned int uInterval, unsigned int uCycles,
const CString& sLabel, const CString& sDescription)
: CTimer(pModule, uInterval, uCycles, sLabel, sDescription) {}
~CAwayJob() override {}
protected:
void RunJob() override;
};
class CAway : public CModule {
void AwayCommand(const CString& sCommand) {
CString sReason;
timeval curtime;
gettimeofday(&curtime, nullptr);
if (sCommand.Token(1) != "-quiet") {
sReason = CUtils::FormatTime(curtime, sCommand.Token(1, true),
GetUser()->GetTimezone());
PutModNotice(t_s("You have been marked as away"));
} else {
sReason = CUtils::FormatTime(curtime, sCommand.Token(2, true),
GetUser()->GetTimezone());
}
Away(false, sReason);
}
void BackCommand(const CString& sCommand) {
if ((m_vMessages.empty()) && (sCommand.Token(1) != "-quiet"))
PutModNotice(t_s("Welcome back!"));
Ping();
Back();
}
void MessagesCommand(const CString& sCommand) {
for (u_int a = 0; a < m_vMessages.size(); a++)
PutModule(m_vMessages[a]);
}
void ReplayCommand(const CString& sCommand) {
CString nick = GetClient()->GetNick();
for (u_int a = 0; a < m_vMessages.size(); a++) {
CString sWhom = m_vMessages[a].Token(1, false, ":");
CString sMessage = m_vMessages[a].Token(2, true, ":");
PutUser(":" + sWhom + " PRIVMSG " + nick + " :" + sMessage);
}
}
void DeleteCommand(const CString& sCommand) {
CString sWhich = sCommand.Token(1);
if (sWhich == "all") {
PutModNotice(t_f("Deleted {1} messages")(m_vMessages.size()));
for (u_int a = 0; a < m_vMessages.size(); a++)
m_vMessages.erase(m_vMessages.begin() + a--);
} else if (sWhich.empty()) {
PutModNotice(t_s("USAGE: delete <num|all>"));
return;
} else {
u_int iNum = sWhich.ToUInt();
if (iNum >= m_vMessages.size()) {
PutModNotice(t_s("Illegal message # requested"));
return;
} else {
m_vMessages.erase(m_vMessages.begin() + iNum);
PutModNotice(t_s("Message erased"));
}
SaveBufferToDisk();
}
}
void SaveCommand(const CString& sCommand) {
if (m_saveMessages) {
SaveBufferToDisk();
PutModNotice(t_s("Messages saved to disk"));
} else {
PutModNotice(t_s("There are no messages to save"));
}
}
void PingCommand(const CString& sCommand) {
Ping();
if (m_bIsAway) Back();
}
void PassCommand(const CString& sCommand) {
m_sPassword = sCommand.Token(1);
PutModNotice(t_f("Password updated to [{1}]")(m_sPassword));
}
void ShowCommand(const CString& sCommand) {
map<CString, vector<CString>> msvOutput;
for (u_int a = 0; a < m_vMessages.size(); a++) {
CString sTime = m_vMessages[a].Token(0, false);
CString sWhom = m_vMessages[a].Token(1, false);
CString sMessage = m_vMessages[a].Token(2, true);
if ((sTime.empty()) || (sWhom.empty()) || (sMessage.empty())) {
// illegal format
PutModule(t_f("Corrupt message! [{1}]")(m_vMessages[a]));
m_vMessages.erase(m_vMessages.begin() + a--);
continue;
}
time_t iTime = sTime.ToULong();
char szFormat[64];
struct tm t;
localtime_r(&iTime, &t);
size_t iCount = strftime(szFormat, 64, "%F %T", &t);
if (iCount <= 0) {
PutModule(t_f("Corrupt time stamp! [{1}]")(m_vMessages[a]));
m_vMessages.erase(m_vMessages.begin() + a--);
continue;
}
CString sTmp = " " + CString(a) + ") [";
sTmp.append(szFormat, iCount);
sTmp += "] ";
sTmp += sMessage;
msvOutput[sWhom].push_back(sTmp);
}
for (map<CString, vector<CString>>::iterator it = msvOutput.begin();
it != msvOutput.end(); ++it) {
PutModule(it->first);
for (u_int a = 0; a < it->second.size(); a++)
PutModule(it->second[a]);
}
PutModule(t_s("#--- End of messages"));
}
void EnableTimerCommand(const CString& sCommand) {
SetAwayTime(300);
PutModule(t_s("Timer set to 300 seconds"));
}
void DisableTimerCommand(const CString& sCommand) {
SetAwayTime(0);
PutModule(t_s("Timer disabled"));
}
void SetTimerCommand(const CString& sCommand) {
int iSetting = sCommand.Token(1).ToInt();
SetAwayTime(iSetting);
if (iSetting == 0)
PutModule(t_s("Timer disabled"));
else
PutModule(t_f("Timer set to {1} seconds")(iSetting));
}
void TimerCommand(const CString& sCommand) {
PutModule(t_f("Current timer setting: {1} seconds")(GetAwayTime()));
}
public:
MODCONSTRUCTOR(CAway) {
Ping();
m_bIsAway = false;
m_bBootError = false;
m_saveMessages = true;
m_chanMessages = false;
SetAwayTime(300);
AddTimer(
new CAwayJob(this, 60, 0, "AwayJob",
"Checks for idle and saves messages every 1 minute"));
AddHelpCommand();
AddCommand("Away",
static_cast<CModCommand::ModCmdFunc>(&CAway::AwayCommand),
"[-quiet]");
AddCommand("Back",
static_cast<CModCommand::ModCmdFunc>(&CAway::BackCommand),
"[-quiet]");
AddCommand("Messages",
static_cast<CModCommand::ModCmdFunc>(&CAway::BackCommand));
AddCommand("Delete",
static_cast<CModCommand::ModCmdFunc>(&CAway::DeleteCommand),
"delete <num|all>");
AddCommand("Save",
static_cast<CModCommand::ModCmdFunc>(&CAway::SaveCommand));
AddCommand("Ping",
static_cast<CModCommand::ModCmdFunc>(&CAway::PingCommand));
AddCommand("Pass",
static_cast<CModCommand::ModCmdFunc>(&CAway::PassCommand));
AddCommand("Show",
static_cast<CModCommand::ModCmdFunc>(&CAway::ShowCommand));
AddCommand("Replay",
static_cast<CModCommand::ModCmdFunc>(&CAway::ReplayCommand));
AddCommand("EnableTimer", static_cast<CModCommand::ModCmdFunc>(
&CAway::EnableTimerCommand));
AddCommand("DisableTimer", static_cast<CModCommand::ModCmdFunc>(
&CAway::DisableTimerCommand));
AddCommand("SetTimer", static_cast<CModCommand::ModCmdFunc>(
&CAway::SetTimerCommand),
"<secs>");
AddCommand("Timer",
static_cast<CModCommand::ModCmdFunc>(&CAway::TimerCommand));
}
~CAway() override {
if (!m_bBootError) SaveBufferToDisk();
}
bool OnLoad(const CString& sArgs, CString& sMessage) override {
CString sMyArgs = sArgs;
size_t uIndex = 0;
if (sMyArgs.Token(0) == "-nostore") {
uIndex++;
m_saveMessages = false;
}
if (sMyArgs.Token(uIndex) == "-chans") {
uIndex++;
m_chanMessages = true;
}
if (sMyArgs.Token(uIndex) == "-notimer") {
SetAwayTime(0);
sMyArgs = sMyArgs.Token(uIndex + 1, true);
} else if (sMyArgs.Token(uIndex) == "-timer") {
SetAwayTime(sMyArgs.Token(uIndex + 1).ToInt());
sMyArgs = sMyArgs.Token(uIndex + 2, true);
}
if (m_saveMessages) {
if (!sMyArgs.empty()) {
m_sPassword = CBlowfish::MD5(sMyArgs);
} else {
sMessage =
t_s("This module needs as an argument a keyphrase used for "
"encryption");
return false;
}
if (!BootStrap()) {
sMessage = t_s(
"Failed to decrypt your saved messages - "
"Did you give the right encryption key as an argument to "
"this module?");
m_bBootError = true;
return false;
}
}
return true;
}
void OnIRCConnected() override {
if (m_bIsAway) {
Away(true); // reset away if we are reconnected
} else {
// ircd seems to remember your away if you killed the client and
// came back
Back();
}
}
bool BootStrap() {
CString sFile;
if (DecryptMessages(sFile)) {
VCString vsLines;
VCString::iterator it;
sFile.Split("\n", vsLines);
for (it = vsLines.begin(); it != vsLines.end(); ++it) {
CString sLine(*it);
sLine.Trim();
AddMessage(sLine);
}
} else {
m_sPassword = "";
CUtils::PrintError("[" + GetModName() +
".so] Failed to Decrypt Messages");
return (false);
}
return (true);
}
void SaveBufferToDisk() {
if (!m_sPassword.empty()) {
CString sFile = CRYPT_VERIFICATION_TOKEN;
for (u_int b = 0; b < m_vMessages.size(); b++)
sFile += m_vMessages[b] + "\n";
CBlowfish c(m_sPassword, BF_ENCRYPT);
sFile = c.Crypt(sFile);
CString sPath = GetPath();
if (!sPath.empty()) {
CFile File(sPath);
if (File.Open(O_WRONLY | O_CREAT | O_TRUNC, 0600)) {
File.Chmod(0600);
File.Write(sFile);
}
File.Close();
}
}
}
void OnClientLogin() override { Back(true); }
void OnClientDisconnect() override { Away(); }
CString GetPath() {
CString sBuffer = GetUser()->GetUsername();
CString sRet = GetSavePath();
sRet += "/.znc-away-" + CBlowfish::MD5(sBuffer, true);
return (sRet);
}
void Away(bool bForce = false, const CString& sReason = "") {
if ((!m_bIsAway) || (bForce)) {
if (!bForce)
m_sReason = sReason;
else if (!sReason.empty())
m_sReason = sReason;
time_t iTime = time(nullptr);
char* pTime = ctime(&iTime);
CString sTime;
if (pTime) {
sTime = pTime;
sTime.Trim();
}
if (m_sReason.empty()) m_sReason = "Auto Away at " + sTime;
PutIRC("AWAY :" + m_sReason);
m_bIsAway = true;
}
}
void Back(bool bUsePrivMessage = false) {
PutIRC("away");
m_bIsAway = false;
if (!m_vMessages.empty()) {
if (bUsePrivMessage) {
PutModule(t_s("Welcome back!"));
PutModule(t_f("You have {1} messages!")(m_vMessages.size()));
} else {
PutModNotice(t_s("Welcome back!"));
PutModNotice(t_f("You have {1} messages!")(m_vMessages.size()));
}
}
m_sReason = "";
}
EModRet OnPrivMsg(CNick& Nick, CString& sMessage) override {
if (m_bIsAway) AddMessage(time(nullptr), Nick, sMessage);
return (CONTINUE);
}
EModRet OnChanMsg(CNick& nick, CChan& channel, CString& sMessage) override {
if (m_bIsAway && m_chanMessages &&
sMessage.AsLower().find(m_pNetwork->GetCurNick().AsLower()) !=
CString::npos) {
AddMessage(time(nullptr), nick, channel.GetName() + " " + sMessage);
}
return (CONTINUE);
}
EModRet OnPrivAction(CNick& Nick, CString& sMessage) override {
if (m_bIsAway) {
AddMessage(time(nullptr), Nick, "* " + sMessage);
}
return (CONTINUE);
}
EModRet OnUserNotice(CString& sTarget, CString& sMessage) override {
Ping();
if (m_bIsAway) Back();
return (CONTINUE);
}
EModRet OnUserMsg(CString& sTarget, CString& sMessage) override {
Ping();
if (m_bIsAway) Back();
return (CONTINUE);
}
EModRet OnUserAction(CString& sTarget, CString& sMessage) override {
Ping();
if (m_bIsAway) Back();
return (CONTINUE);
}
time_t GetTimeStamp() const { return (m_iLastSentData); }
void Ping() { m_iLastSentData = time(nullptr); }
time_t GetAwayTime() { return m_iAutoAway; }
void SetAwayTime(time_t u) { m_iAutoAway = u; }
bool IsAway() { return (m_bIsAway); }
private:
CString m_sPassword;
bool m_bBootError;
bool DecryptMessages(CString& sBuffer) {
CString sMessages = GetPath();
CString sFile;
sBuffer = "";
CFile File(sMessages);
if (sMessages.empty() || !File.Open() || !File.ReadFile(sFile)) {
PutModule(t_s("Unable to find buffer"));
return (true); // gonna be successful here
}
File.Close();
if (!sFile.empty()) {
CBlowfish c(m_sPassword, BF_DECRYPT);
sBuffer = c.Crypt(sFile);
if (sBuffer.Left(strlen(CRYPT_VERIFICATION_TOKEN)) !=
CRYPT_VERIFICATION_TOKEN) {
// failed to decode :(
PutModule(t_s("Unable to decode encrypted messages"));
return (false);
}
sBuffer.erase(0, strlen(CRYPT_VERIFICATION_TOKEN));
}
return (true);
}
void AddMessage(time_t iTime, const CNick& Nick, const CString& sMessage) {
if (Nick.GetNick() == GetNetwork()->GetIRCNick().GetNick())
return; // ignore messages from self
AddMessage(CString(iTime) + " " + Nick.GetNickMask() + " " + sMessage);
}
void AddMessage(const CString& sText) {
if (m_saveMessages) {
m_vMessages.push_back(sText);
}
}
time_t m_iLastSentData;
bool m_bIsAway;
time_t m_iAutoAway;
vector<CString> m_vMessages;
CString m_sReason;
bool m_saveMessages;
bool m_chanMessages;
};
void CAwayJob::RunJob() {
CAway* p = (CAway*)GetModule();
p->SaveBufferToDisk();
if (!p->IsAway()) {
time_t iNow = time(nullptr);
if ((iNow - p->GetTimeStamp()) > p->GetAwayTime() &&
p->GetAwayTime() != 0)
p->Away();
}
}
template <>
void TModInfo<CAway>(CModInfo& Info) {
Info.SetWikiPage("awaystore");
Info.SetHasArgs(true);
Info.SetArgsHelpText(Info.t_s(
"[ -notimer | -timer N ] [-chans] passw0rd . N is number of seconds, "
"600 by default."));
}
NETWORKMODULEDEFS(
CAway, t_s("Adds auto-away with logging, useful when you use ZNC from "
"different locations"))
|