├── .gitignore ├── Makefile ├── README.md ├── backlog.cpp └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.so 2 | tags 3 | .*.un~ 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | backlog: backlog.cpp 2 | znc-buildmod backlog.cpp 3 | 4 | clean: 5 | rm -f *.so 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | znc-backlog 2 | =========== 3 | 4 | znc-backlog is a ZNC module that makes it easy to request backlog. Its intended 5 | use is for when you have just launched your IRC client and gotten a few lines of 6 | backlog sent to you, but want to read more. Instead of having to deal with 7 | shelling into the box where you run ZNC and manually sifting through the logs, 8 | you can issue a short command in your IRC client to request any amount of the 9 | most recent lines of log. 10 | 11 | Dependencies 12 | ------------ 13 | 14 | Requires make and znc-buildmod to build (should come bundled with ZNC) 15 | 16 | Compiling & Installing 17 | ---------------------- 18 | 19 | git clone https://github.com/FruitieX/znc-backlog 20 | cd znc-backlog 21 | make 22 | cp backlog.so /path/to/znc/modules/ 23 | 24 | Usage 25 | ----- 26 | 27 | Upon loading the module for the first time, you have to specify a path to your 28 | log files with the LogPath command. (can also be specified by passing the 29 | path as an argument when loading the module) 30 | 31 | LogPath /path/to/your/logs/$USER_$NETWORK_$WINDOW_*.log 32 | 33 | **$USER** will be replaced with your ZNC username, **$NETWORK** with the current 34 | network and **$WINDOW** with the requested channel/window name. **$user** and 35 | **$network** can also be used to force the string to be lowercase. The last found 36 | asterisk character **'\*'** in the string is assumed to be a date, and the order in 37 | which the files are read is determined by a simple alphabetical sort. (ie. 38 | date format order must be year-month-date) 39 | 40 | After the module is loaded and LogPath is set, you can request for logs with: 41 | 42 | /msg *backlog 43 | 44 | A handy alias for weechat: 45 | 46 | /alias bl msg *backlog $channel $1 47 | 48 | Now you can: 49 | 50 | /bl 42 51 | 52 | to request 42 lines from the current window or just: 53 | 54 | /bl 55 | 56 | to request the default amount (150) of lines from the current window. 57 | 58 | TODO 59 | ---- 60 | - Currently the module can only be loaded on a per-network basis. 61 | - Autodetect LogPath if possible 62 | - Optimize? 63 | - Server-time for timestamp, http://ircv3.org/extensions/server-time-3.2 64 | - make install rules (see kylef's plugins) 65 | - CDir instead of opendir(), see FileUtils.h 66 | - see how timestamps are created in buffer playback code 67 | - investigate '\*' lines in XChat server window, maybe random space somewhere? 68 | -------------------------------------------------------------------------------- /backlog.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2004-2013 ZNC, see the NOTICE file for details. 3 | * Copyright (C) 2013 Rasmus Eskola 4 | * based on sample.cpp sample module code 5 | * 6 | * Licensed under the Apache License, Version 2.0 (the "License"); 7 | * you may not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, software 13 | * distributed under the License is distributed on an "AS IS" BASIS, 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | * See the License for the specific language governing permissions and 16 | * limitations under the License. 17 | */ 18 | 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | class CBacklogMod : public CModule { 30 | public: 31 | MODCONSTRUCTOR(CBacklogMod) {} 32 | 33 | virtual bool OnLoad(const CString& sArgs, CString& sMessage); 34 | virtual ~CBacklogMod(); 35 | virtual void OnModCommand(const CString& sCommand); 36 | }; 37 | 38 | bool CBacklogMod::OnLoad(const CString& sArgs, CString& sMessage) { 39 | CString LogPath = sArgs; 40 | 41 | if(LogPath.empty()) { 42 | LogPath = GetNV("LogPath"); 43 | if(LogPath.empty()) { 44 | // TODO: guess logpath? 45 | PutModule("LogPath is empty, set it with the LogPath command (help for more info)"); 46 | } 47 | } else { 48 | SetNV("LogPath", LogPath); 49 | PutModule("LogPath set to: " + LogPath); 50 | } 51 | return true; 52 | } 53 | 54 | CBacklogMod::~CBacklogMod() { 55 | } 56 | 57 | void CBacklogMod::OnModCommand(const CString& sCommand) { 58 | CString Arg = sCommand.Token(1); 59 | if (sCommand.Token(0).Equals("help")) { 60 | // TODO: proper help text, look how AddHelpCommand() does it in other ZNC code 61 | PutModule("Usage:"); 62 | PutModule(" [num-lines] (e.g. #foo 42)"); 63 | PutModule(""); 64 | PutModule("Commands:"); 65 | PutModule("Help (print this text)"); 66 | PutModule("LogPath (use keywords $USER, $NETWORK, $WINDOW, $user, $network and an asterisk * for date)"); 67 | PutModule("PrintStatusMsgs true/false (print join/part/rename messages)"); 68 | return; 69 | } else if (sCommand.Token(0).Equals("logpath")) { 70 | if(Arg.empty()) { 71 | PutModule("Usage: LogPath (use keywords $USER, $NETWORK, $WINDOW, $user, $network and an asterisk * for date:)"); 72 | PutModule("Current LogPath is set to: " + GetNV("LogPath")); 73 | return; 74 | } 75 | 76 | CString LogPath = sCommand.Token(1, true); 77 | SetNV("LogPath", LogPath); 78 | PutModule("LogPath set to: " + LogPath); 79 | return; 80 | } else if (sCommand.Token(0).Equals("PrintStatusMsgs")) { 81 | if(Arg.empty() || (!Arg.Equals("true", true) && !Arg.Equals("false", true))) { 82 | PutModule("Usage: PrintStatusMsgs true/false"); 83 | return; 84 | } 85 | 86 | SetNV("PrintStatusMsgs", Arg); 87 | PutModule("PrintStatusMsgs set to: " + Arg); 88 | return; 89 | } 90 | 91 | // TODO: handle these differently depending on how the module was loaded 92 | CString User = (m_pUser ? m_pUser->GetUserName() : "UNKNOWN"); 93 | CString Network = (m_pNetwork ? m_pNetwork->GetName() : "znc"); 94 | CString Channel = sCommand.Token(0); 95 | 96 | int printedLines = 0; 97 | int reqLines = sCommand.Token(1).ToInt(); 98 | if(reqLines <= 0) { 99 | reqLines = 150; 100 | } 101 | reqLines = std::max(std::min(reqLines, 1000), 1); 102 | 103 | CString Path = GetNV("LogPath").substr(); // make copy 104 | Path.Replace("$NETWORK", Network); 105 | Path.Replace("$network", Network.AsLower()); 106 | Path.Replace("$WINDOW", CString(Channel.Replace_n("/", "-").Replace_n("\\", "-")).AsLower()); 107 | Path.Replace("$USER", User); 108 | Path.Replace("$user", User.AsLower()); 109 | 110 | CString DirPath = Path.substr(0, Path.find_last_of("/")); 111 | CString FilePath; 112 | 113 | std::vector FileList; 114 | std::vector LinesToPrint; 115 | 116 | // gather list of all log files for requested channel/window 117 | DIR *dir; 118 | struct dirent *ent; 119 | if ((dir = opendir (DirPath.c_str())) != NULL) { 120 | while ((ent = readdir (dir)) != NULL) { 121 | FilePath = DirPath + "/" + ent->d_name; 122 | //PutModule("DEBUG: " + FilePath + " " + Path); 123 | if(FilePath.AsLower().StrCmp(Path.AsLower(), Path.find_last_of("*")) == 0) { 124 | FileList.push_back(FilePath); 125 | } 126 | } 127 | closedir (dir); 128 | } else { 129 | PutModule("Could not list directory " + DirPath + ": " + strerror(errno)); 130 | return; 131 | } 132 | 133 | std::sort(FileList.begin(), FileList.end()); 134 | 135 | // loop through list of log files one by one starting from most recent... 136 | for (std::vector::reverse_iterator it = FileList.rbegin(); it != FileList.rend(); ++it) { 137 | CFile LogFile(*it); 138 | CString Line; 139 | std::vector Lines; 140 | 141 | if (LogFile.GetShortName() == "." || LogFile.GetShortName() == "..") { 142 | continue; 143 | } 144 | 145 | if (LogFile.Open()) { 146 | Lines.push_back("[00:00:00] <***> File: " + LogFile.GetShortName()); //Parse name to get date prettier? 147 | printedLines--; 148 | while (LogFile.ReadLine(Line)) { 149 | try { 150 | // is line a part/join/rename etc message (nick ***), do we want to print it? 151 | // find nick by finding first whitespace, then moving one char right 152 | if(Line.at(Line.find_first_of(' ') + 1) == '*' && !GetNV("PrintStatusMsgs").ToBool()) { 153 | continue; 154 | } 155 | 156 | Lines.push_back(Line); 157 | } catch (int e) { 158 | // malformed log line, ignore 159 | PutModule("Malformed log line found in " + *it + ": " + Line); 160 | } 161 | } 162 | } else { 163 | PutModule("Could not open log file [" + sCommand + "]: " + strerror(errno)); 164 | continue; 165 | } 166 | 167 | LogFile.Close(); 168 | 169 | // loop through Lines in reverse order, push to LinesToPrint 170 | for (std::vector::reverse_iterator itl = Lines.rbegin(); itl != Lines.rend(); ++itl) { 171 | LinesToPrint.push_back(*itl); 172 | printedLines++; 173 | 174 | if(printedLines >= reqLines) { 175 | break; 176 | } 177 | } 178 | 179 | if(printedLines >= reqLines) { 180 | break; 181 | } 182 | } 183 | 184 | if(printedLines <= 0) { 185 | m_pNetwork->PutUser(":***!znc@znc.in PRIVMSG " + Channel + " :No log files found for window " + Channel + " in " + DirPath + "/", GetClient()); 186 | return; 187 | } else { 188 | //RFC prefixes: # ! & + 189 | if (Channel.StartsWith("#") || Channel.StartsWith("&") || 190 | Channel.StartsWith("!") || Channel.StartsWith("+")) { //Normal channel 191 | m_pNetwork->PutUser(":***!znc@znc.in PRIVMSG " + Channel + " :Backlog playback...", GetClient()); 192 | } else { 193 | m_pNetwork->PutUser(":" + Channel + "!znc@znc.in PRIVMSG " + Channel + " :<***> Backlog playback...", GetClient()); 194 | } 195 | } 196 | 197 | // now actually print 198 | for (std::vector::reverse_iterator it = LinesToPrint.rbegin(); it != LinesToPrint.rend(); ++it) { 199 | CString Line = *it; 200 | size_t FirstWS = Line.find_first_of(' '); // position of first whitespace char in line 201 | size_t NickLen = 3; 202 | CString Nick = "***"; 203 | CString MessageType = "PRIVMSG "; 204 | 205 | try { 206 | // a log line looks like: [HH:MM:SS] Message 207 | // < and > are illegal characters in nicknames, so we can 208 | // search for these 209 | if(Line.at(FirstWS + 1) == '<') { // normal message 210 | // nicklen includes surrounding < > 211 | NickLen = Line.find_first_of('>') - Line.find_first_of('<') + 1; 212 | // but we don't want them in Nick so subtract by two 213 | Nick = Line.substr(FirstWS + 2, NickLen - 2); 214 | } 215 | else if(Line.at(FirstWS + 1) == '-') { // IRC notice 216 | // nicklen includes surrounding - - 217 | NickLen = Line.find_first_of('-', FirstWS + 2) - Line.find_first_of('-') + 1; 218 | // but we don't want them in Nick so subtract by two 219 | Nick = Line.substr(FirstWS + 2, NickLen - 2); 220 | MessageType = "NOTICE "; 221 | } 222 | 223 | //RFC prefixes: # ! & + 224 | if (Channel.StartsWith("#") || Channel.StartsWith("&") || 225 | Channel.StartsWith("!") || Channel.StartsWith("+")) { //Normal channel 226 | m_pNetwork->PutUser(":" + Nick + "!znc@znc.in " + MessageType + Channel + " :" + Line.substr(0, FirstWS) + Line.substr(FirstWS + NickLen + 1, Line.npos), GetClient()); 227 | } else { //Privmsg 228 | m_pNetwork->PutUser(":" + Channel + "!znc@znc.in " + MessageType + Channel + " :" + Line.substr(0, FirstWS) + " <" + Nick + ">" + Line.substr(FirstWS + NickLen + 1, Line.npos), GetClient()); 229 | } 230 | 231 | 232 | } catch (int e) { 233 | PutModule("Malformed log line! " + Line); 234 | } 235 | } 236 | 237 | if (Channel.StartsWith("#") || Channel.StartsWith("&") || 238 | Channel.StartsWith("!") || Channel.StartsWith("+")) { //Normal channel 239 | m_pNetwork->PutUser(":***!znc@znc.in PRIVMSG " + Channel + " :" + "Playback Complete.", GetClient()); 240 | } else { 241 | m_pNetwork->PutUser(":" + Channel + "!znc@znc.in PRIVMSG " + Channel + " :<***> " + "Playback Complete.", GetClient()); 242 | } 243 | } 244 | 245 | template<> void TModInfo(CModInfo& Info) { 246 | Info.AddType(CModInfo::NetworkModule); 247 | Info.AddType(CModInfo::GlobalModule); 248 | Info.SetWikiPage("backlog"); 249 | Info.SetArgsHelpText("Takes as optional argument (and if given, sets) the log path, use keywords: $USER, $NETWORK and $WINDOW"); 250 | Info.SetHasArgs(true); 251 | } 252 | 253 | NETWORKMODULEDEFS(CBacklogMod, "Module for getting the last X lines of a channels log.") 254 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------