diff --git a/apps/bogobot/Bogobot.java b/apps/bogobot/Bogobot.java new file mode 100644 index 0000000000000000000000000000000000000000..6e7e80c7779e4db34efee223ac632cae65c423f8 --- /dev/null +++ b/apps/bogobot/Bogobot.java @@ -0,0 +1,214 @@ +/* + * bogobot - A simple join/part stats logger bot for I2P IRC. + * + * Bogobot.java + * 2004 The I2P Project + * This code is public domain. + */ + +import java.io.File; +import java.io.IOException; + +import org.apache.log4j.DailyRollingFileAppender; +import org.apache.log4j.Level; +import org.apache.log4j.Logger; +import org.apache.log4j.PatternLayout; + +import org.jibble.pircbot.IrcException; +import org.jibble.pircbot.NickAlreadyInUseException; +import org.jibble.pircbot.PircBot; +import org.jibble.pircbot.User; + +/** + * TODO 0.4 Implement java.util.Properties for configuration. + * TODO 0.4 Add NickServ interface. + * TODO 0.5 Add multi-server capability. + * + * @author hypercubus + * @version 0.3.1 + */ +public class Bogobot extends PircBot { + + private static final String INTERVAL_DAILY = "daily"; + private static final String INTERVAL_MONTHLY = "monthly"; + private static final String INTERVAL_WEEKLY = "weekly"; + + private boolean _isIntentionalDisconnect = false; + private long _lastUserlistCommandTimestamp = 0; + private Logger _logger = Logger.getLogger(Bogobot.class); + /* + * The following will soon be moved to bogo.config and loaded via + * java.util.Properties when I get some time. + */ + private String _botPrimaryNick = "somebot"; + private String _botSecondaryNick = "somebot_"; + private String _botShutdownCommand = "take off eh"; + private long _commandAntiFloodInterval = 60; + private String _ircChannel = "#i2p-chat"; + private String _ircServer = "irc.duck.i2p"; + private int _ircServerPort = 6668; + private boolean _isLoggerEnabled = true; + private boolean _isUserlistCommandEnabled = true; + private String _logFilePrefix = "irc.duck.i2p.i2p-chat"; + private String _logFileRotationInterval = INTERVAL_DAILY; + private String _ownerPrimaryNick = "somenick"; + private String _ownerSecondaryNick = "somenick_"; + private String _userlistCommandTrigger = "!who"; + + public Bogobot() { + this.setName(_botPrimaryNick); + } + + public static void main(String[] args) { + + Bogobot bogobot = new Bogobot(); + + bogobot.setVerbose(true); + + if (bogobot._isLoggerEnabled) + bogobot.initLogger(); + + bogobot.connectToServer(); + } + + protected void onDisconnect() { + + if (_isIntentionalDisconnect) + System.exit(0); + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " quits *** " + this.getName() + " *** (Lost connection)"); + + try { + Thread.sleep(60000); + } catch (InterruptedException e) { + // No worries. + } + connectToServer(); + } + + protected void onJoin(String channel, String sender, String login, String hostname) { + if (sender.equals(this.getName())) { + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " joins *** " + _botPrimaryNick + " ***"); + + } else { + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " joins " + sender); + + } + } + + protected void onMessage(String channel, String sender, String login, String hostname, String message) { + message = message.replaceFirst("<.+?> ", ""); + if (_isUserlistCommandEnabled && message.equals(_userlistCommandTrigger)) { + + if (System.currentTimeMillis() - _lastUserlistCommandTimestamp < _commandAntiFloodInterval * 1000) + return; + + Object[] users = getUsers(_ircChannel); + String output = "Userlist for " + _ircChannel + ": "; + + for (int i = 0; i < users.length; i++) + output += "[" + ((User) users[i]).getNick() + "] "; + + sendMessage(_ircChannel, output); + _lastUserlistCommandTimestamp = System.currentTimeMillis(); + } + } + + protected void onPart(String channel, String sender, String login, String hostname) { + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " parts " + sender); + + } + + protected void onPrivateMessage(String sender, String login, String hostname, String message) { + /* + * Nobody else except the bot's owner can shut it down, unless of + * course the owner's nick isn't registered and someone's spoofing it. + */ + if ((sender.equals(_ownerPrimaryNick) || sender.equals(_ownerSecondaryNick)) && message.equals(_botShutdownCommand)) { + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " quits *** " + this.getName() + " ***"); + + _isIntentionalDisconnect = true; + disconnect(); + } + } + + protected void onQuit(String sourceNick, String sourceLogin, String sourceHostname, String reason) { + + if (_isLoggerEnabled) + _logger.info(System.currentTimeMillis() + " quits " + sourceNick + " " + reason); + + } + + private void connectToServer() { + + int loginAttempts = 0; + + while (true) { + try { + connect(_ircServer, _ircServerPort); + break; + } catch (NickAlreadyInUseException e) { + if (loginAttempts == 1) { + System.out.println("Sorry, the primary and secondary bot nicks are already taken. Exiting."); + System.exit(1); + } + loginAttempts++; + try { + Thread.sleep(5000); + } catch (InterruptedException e1) { + // Hmph. + } + + if (getName().equals(_botPrimaryNick)) + setName(_botSecondaryNick); + else + setName(_botPrimaryNick); + + continue; + } catch (IOException e) { + System.out.println("Error during login: "); + e.printStackTrace(); + System.exit(1); + } catch (IrcException e) { + System.out.println("Error during login: "); + e.printStackTrace(); + System.exit(1); + } + } + joinChannel(_ircChannel); + } + + private void initLogger() { + + String logFilePath = "logs" + File.separator + _logFilePrefix; + DailyRollingFileAppender rollingFileAppender = null; + + if (!(new File("logs").exists())) + (new File("logs")).mkdirs(); + + try { + + if (_logFileRotationInterval.equals("monthly")) + rollingFileAppender = new DailyRollingFileAppender(new PatternLayout("%m%n"), logFilePath, "'.'yyyy-MM'.log'"); + else if (_logFileRotationInterval.equals("weekly")) + rollingFileAppender = new DailyRollingFileAppender(new PatternLayout("%m%n"), logFilePath, "'.'yyyy-ww'.log'"); + else + rollingFileAppender = new DailyRollingFileAppender(new PatternLayout("%m%n"), logFilePath, "'.'yyyy-MM-dd'.log'"); + + rollingFileAppender.setThreshold(Level.INFO); + _logger.addAppender(rollingFileAppender); + } catch (IOException ex) { + System.out.println("Error: Couldn't create or open an existing log file. Exiting."); + System.exit(1); + } + } +} diff --git a/apps/bogobot/Bogoparser.java b/apps/bogobot/Bogoparser.java new file mode 100644 index 0000000000000000000000000000000000000000..55cd168970c991a803febcd9341b94602c5571a5 --- /dev/null +++ b/apps/bogobot/Bogoparser.java @@ -0,0 +1,352 @@ +/* + * bogoparser - A simple logfile analyzer for bogobot. + * + * Bogoparser.java + * 2004 The I2P Project + * This code is public domain. + */ + +import java.io.BufferedReader; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStreamReader; +import java.util.ArrayList; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * @author hypercubus + * @version 0.3.1 + */ +public class Bogoparser { + + private static void displayUsageAndExit() { + System.out.println("\r\nUsage:\r\n\r\n java Bogoparser [--by-duration] <logfile>\r\n"); + System.exit(1); + } + + public static void main(String[] args) { + + Bogoparser bogoparser; + + if (args.length < 1 || args.length > 2) + displayUsageAndExit(); + + if (args.length == 2) { + if (!args[0].equals("--by-duration")) + displayUsageAndExit(); + bogoparser = new Bogoparser(args[1], true); + } + + if (args.length == 1) + bogoparser = new Bogoparser(args[0], false); + } + + private Bogoparser(String logfile, boolean sortByDuration) { + + ArrayList sortedSessions; + + if (sortByDuration) { + sortedSessions = sortSessionsByDuration(calculateSessionDurations(sortSessionsByTime(readLogfile(logfile)))); + formatAndOutputByDuration(sortedSessions); + } else { + sortedSessions = calculateSessionDurations(sortSessionsByQuitReason(sortSessionsByNick(sortSessionsByTime(readLogfile(logfile))))); + formatAndOutput(sortedSessions); + } + } + + private ArrayList calculateSessionDurations(ArrayList sortedSessionsByQuitReasonOrDuration) { + + ArrayList calculatedSessionDurations = new ArrayList(); + + for (int i = 0; i+1 < sortedSessionsByQuitReasonOrDuration.size(); i += 2) { + + String joinsEntry = (String) sortedSessionsByQuitReasonOrDuration.get(i); + String[] joinsEntryFields = joinsEntry.split(" "); + + String quitsEntry = (String) sortedSessionsByQuitReasonOrDuration.get(i+1); + Pattern p = Pattern.compile("^([^ ]+) [^ ]+ ([^ ]+) (.*)$"); + Matcher m = p.matcher(quitsEntry); + + if (m.matches()) { + + String currentJoinTime = joinsEntryFields[0]; + String currentNick = m.group(2); + String currentQuitReason = m.group(3); + String currentQuitTime = m.group(1); + long joinsTimeInMilliseconds; + long quitsTimeInMilliseconds; + long sessionLengthInMilliseconds; + + joinsTimeInMilliseconds = Long.parseLong(currentJoinTime); + quitsTimeInMilliseconds = Long.parseLong(currentQuitTime); + sessionLengthInMilliseconds = quitsTimeInMilliseconds - joinsTimeInMilliseconds; + + String hours = "" + sessionLengthInMilliseconds/1000/60/60; + String minutes = "" + (sessionLengthInMilliseconds/1000/60)%60; + + if (hours.length() < 2) + hours = "0" + hours; + + if (hours.length() < 3) + hours = "0" + hours; + + if (minutes.length() < 2) + minutes = "0" + minutes; + + int columnPadding = 19-currentNick.length(); + String columnPaddingString = " "; + + for (int j = 0; j < columnPadding; j++) + columnPaddingString = columnPaddingString + " "; + + calculatedSessionDurations.add(sessionLengthInMilliseconds + " " + currentNick + columnPaddingString + " online " + hours + " hours " + minutes + " minutes " + currentQuitReason); + } else { + System.out.println("\r\nError: Unexpected entry in logfile: " + quitsEntry); + System.exit(1); + } + } + return calculatedSessionDurations; + } + + private void formatAndOutput(ArrayList sortedSessions) { + + String quitReason = null; + + for (int i = 0; i < sortedSessions.size(); i++) { + + String entry = (String) sortedSessions.get(i); + Pattern p = Pattern.compile("^[\\d]+ ([^ ]+ +online [\\d]+ hours [\\d]+ minutes) (.*)$"); + Matcher m = p.matcher(entry); + + if (m.matches()) { + + if (quitReason == null) { + quitReason = m.group(2); + System.out.println("\r\nQUIT: " + ((m.group(2).equals("")) ? "No Reason Given" : quitReason) + "\r\n"); + } + + String tempQuitReason = m.group(2); + String tempSession = m.group(1); + + if (tempQuitReason.equals(quitReason)) { + System.out.println(" " + tempSession); + } else { + quitReason = null; + i -= 1; + continue; + } + } else { + System.out.println("\r\nError: Unexpected entry in logfile: " + entry); + System.exit(1); + } + } + System.out.println("\r\n"); + } + + private void formatAndOutputByDuration(ArrayList sortedSessions) { + System.out.println("\r\n"); + + for (int i = 0; i < sortedSessions.size(); i++) { + String[] columns = ((String) sortedSessions.get(i)).split(" ", 2); + System.out.println(columns[1]); + } + + System.out.println("\r\n"); + } + + private ArrayList readLogfile(String logfile) { + + ArrayList log = new ArrayList(); + + try { + BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(logfile))); + + for (String line; (line = in.readLine()) != null; ) + log.add(line); + + in.close(); + + } catch (FileNotFoundException e) { + System.out.println("\r\nError: Can't find logfile '" + logfile + "'.\r\n"); + System.exit(1); + + } catch (IOException e) { + System.out.println("\r\nError: Can't read logfile '" + logfile + "'.\r\n"); + System.exit(1); + } + return log; + } + + /* + * Performs an odd-even transposition sort. + */ + private ArrayList sortSessionsByDuration(ArrayList calculatedSessionDurations) { + + for (int i = 0; i < calculatedSessionDurations.size()/2; i++) { + for (int j = 0; j+1 < calculatedSessionDurations.size(); j += 2) { + + String[] currentDurationString = ((String) calculatedSessionDurations.get(j)).split(" ", 2); + long currentDuration = Long.parseLong(currentDurationString[0]); + String[] nextDurationString = ((String) calculatedSessionDurations.get(j+1)).split(" ", 2); + long nextDuration = Long.parseLong(nextDurationString[0]); + + if (currentDuration > nextDuration) { + calculatedSessionDurations.add(j, calculatedSessionDurations.get(j+1)); + calculatedSessionDurations.remove(j+2); + } + } + + for (int j = 1; j+1 < calculatedSessionDurations.size(); j += 2) { + + String[] currentDurationString = ((String) calculatedSessionDurations.get(j)).split(" ", 2); + long currentDuration = Long.parseLong(currentDurationString[0]); + String[] nextDurationString = ((String) calculatedSessionDurations.get(j+1)).split(" ", 2); + long nextDuration = Long.parseLong(nextDurationString[0]); + + if (currentDuration > nextDuration) { + calculatedSessionDurations.add(j, calculatedSessionDurations.get(j+1)); + calculatedSessionDurations.remove(j+2); + } + } + } + return calculatedSessionDurations; + } + + private ArrayList sortSessionsByNick(ArrayList sortedSessionsByTime) { + + ArrayList sortedSessionsByNick = new ArrayList(); + + while (sortedSessionsByTime.size() != 0) { + + String entry = (String) sortedSessionsByTime.get(0); + String[] entryFields = entry.split(" "); + String currentNick = entryFields[2]; + + sortedSessionsByNick.add(entry); + sortedSessionsByNick.add(sortedSessionsByTime.get(1)); + sortedSessionsByTime.remove(0); + sortedSessionsByTime.remove(0); + for (int i = 0; i+1 < sortedSessionsByTime.size(); i += 2) { + + String nextEntry = (String) sortedSessionsByTime.get(i); + String[] nextEntryFields = nextEntry.split(" "); + + if (nextEntryFields[2].equals(currentNick)) { + sortedSessionsByNick.add(nextEntry); + sortedSessionsByNick.add(sortedSessionsByTime.get(i+1)); + sortedSessionsByTime.remove(i); + sortedSessionsByTime.remove(i); + i -= 2; + } + } + } + return sortedSessionsByNick; + } + + private ArrayList sortSessionsByQuitReason(ArrayList sortedSessionsByNick) { + + ArrayList sortedSessionsByQuitReason = new ArrayList(); + + while (sortedSessionsByNick.size() != 0) { + + String entry = (String) sortedSessionsByNick.get(1); + Pattern p = Pattern.compile("^[^ ]+ [^ ]+ [^ ]+ (.*)$"); + Matcher m = p.matcher(entry); + + if (m.matches()) { + + String currentQuitReason = m.group(1); + + sortedSessionsByQuitReason.add(sortedSessionsByNick.get(0)); + sortedSessionsByQuitReason.add(entry); + sortedSessionsByNick.remove(0); + sortedSessionsByNick.remove(0); + for (int i = 0; i+1 < sortedSessionsByNick.size(); i += 2) { + + String nextEntry = (String) sortedSessionsByNick.get(i+1); + Pattern p2 = Pattern.compile("^[^ ]+ [^ ]+ [^ ]+ (.*)$"); + Matcher m2 = p2.matcher(nextEntry); + + if (m2.matches()) { + + String nextQuitReason = m2.group(1); + + if (nextQuitReason.equals(currentQuitReason)) { + sortedSessionsByQuitReason.add(sortedSessionsByNick.get(i)); + sortedSessionsByQuitReason.add(nextEntry); + sortedSessionsByNick.remove(i); + sortedSessionsByNick.remove(i); + i -= 2; + } + } else { + System.out.println("\r\nError: Unexpected entry in logfile: " + nextEntry); + System.exit(1); + } + } + } else { + System.out.println("\r\nError: Unexpected entry in logfile: " + entry); + System.exit(1); + } + } + return sortedSessionsByQuitReason; + } + + /** + * Sessions terminated with "parts" messages instead of "quits" are filtered + * out. + */ + private ArrayList sortSessionsByTime(ArrayList log) { + + ArrayList sortedSessionsByTime = new ArrayList(); + + mainLoop: + while (log.size() > 0) { + + String entry = (String) log.get(0); + String[] entryFields = entry.split(" "); + + if (entryFields[1].equals("quits") && !entryFields[1].equals("joins")) { + /* + * Discard entry. The specified log either doesn't contain + * the corresponding "joins" time for this quit entry or the + * entry is a "parts" or unknown message, and in both cases + * the entry's data is useless. + */ + log.remove(0); + continue; + } + + for (int i = 1; i < log.size(); i++) { // Find corresponding "quits" entry. + + String tempEntry = (String) log.get(i); + String[] tempEntryFields = tempEntry.split(" "); + + if (tempEntryFields[2].equals(entryFields[2])) { // Check if the nick fields for the two entries match. + if (!tempEntryFields[1].equals("quits")) { + if (tempEntryFields[1].equals("joins")) { // Don't discard a subsequent "joins" entry. + log.remove(0); + continue mainLoop; + } + log.remove(i); + continue; + } + sortedSessionsByTime.add(entry); + sortedSessionsByTime.add(tempEntry); + log.remove(i); + break; + } + } + /* + * Discard "joins" entry. The specified log doesn't contain the + * corresponding "quits" time for this entry so the entry's + * data is useless. + */ + + log.remove(0); + } + + return sortedSessionsByTime; + } +} diff --git a/apps/bogobot/LICENSE_log4j.txt b/apps/bogobot/LICENSE_log4j.txt new file mode 100644 index 0000000000000000000000000000000000000000..030564fc13327d7344c1867f57ea747cff7eb915 --- /dev/null +++ b/apps/bogobot/LICENSE_log4j.txt @@ -0,0 +1,48 @@ +/* + * ============================================================================ + * The Apache Software License, Version 1.1 + * ============================================================================ + * + * Copyright (C) 1999 The Apache Software Foundation. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modifica- + * tion, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. The end-user documentation included with the redistribution, if any, must + * include the following acknowledgment: "This product includes software + * developed by the Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, if + * and wherever such third-party acknowledgments normally appear. + * + * 4. The names "log4j" and "Apache Software Foundation" must not be used to + * endorse or promote products derived from this software without prior + * written permission. For written permission, please contact + * apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", nor may + * "Apache" appear in their name, without prior written permission of the + * Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU- + * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * This software consists of voluntary contributions made by many individuals + * on behalf of the Apache Software Foundation. For more information on the + * Apache Software Foundation, please see <http://www.apache.org/>. + * + */ diff --git a/apps/bogobot/LICENSE_pircbot.txt b/apps/bogobot/LICENSE_pircbot.txt new file mode 100644 index 0000000000000000000000000000000000000000..dcfa4c235e830d9b57c04515dd4b5a80e36075e6 --- /dev/null +++ b/apps/bogobot/LICENSE_pircbot.txt @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + 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 + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/apps/bogobot/bogo.config b/apps/bogobot/bogo.config new file mode 100644 index 0000000000000000000000000000000000000000..61616b8cdfaf97d8f96f85937bcf649f66382aa0 --- /dev/null +++ b/apps/bogobot/bogo.config @@ -0,0 +1,69 @@ +##### +# Bogobot user configuration (This file is not yet used.) +##### + +### +# The bot's nick and backup nick. You will probably want to register these with +# the IRC server's NickServ.(a NickServ interface is forthcoming). +# +botPrimaryNick=somebot +botSecondaryNick=somebot_ + +##### +# The bot owner's nick and backup nick. One of these must match the owner's +# currently-used nick or else remote shutdown will not be possible. You will +# probably want to register these with the IRC server's NickServ. +# +ownerPrimaryNick=somenick +ownerSecondaryNick=somenick_ + +### +# The bot will disconnect and shut down when sent this command via private +# message (aka query) from either of the owner nicks specified above. +# +botShutdownCommand=take off eh + +### +# The server, channel, and port the bot will connect to. +# +ircChannel=#i2p-chat +ircServer=irc.duck.i2p +ircServerPort=6668 + +### +# Set to "true" to enable logging, else "false" (but don't use quotation marks). +# +isLoggerEnabled=true + +### +# The prefix to be used for the filenames of logs. +# +logFilePrefix=irc.duck.i2p.i2p-chat + +### +# How often the logs should be rotated. Either "daily", "weekly", or "monthly" +# (but don't use quotation marks). +# +logFileRotationInterval=daily + +### +# Set to "true" to enable the userlist command, else "false" (but don't use +# quotation marks). +# +isUserlistCommandEnabled=true + +### +# The userlist trigger command to listen for. It is a good idea to prefix +# triggers with some non-alphanumeric character in order to avoid accidental +# trigger use during normal channel conversation. In most cases you will +# probably want to choose a unique trigger here that no other bots in the +# channel will respond to. +# +userlistCommandTrigger=!who + +### +# The number of seconds to rest after replying to a userlist command issued by +# a user in the channel. The bot will ignore subsequent userlist commands during +# this period. This helps prevent flooding. +# +commandAntiFloodInterval=60 diff --git a/apps/bogobot/bogobot.bat b/apps/bogobot/bogobot.bat new file mode 100644 index 0000000000000000000000000000000000000000..4c17f7f482e27c197de9c467818c96fcd73b5293 --- /dev/null +++ b/apps/bogobot/bogobot.bat @@ -0,0 +1 @@ +java -cp .;log4j-1.2.8.jar;pircbot.jar Bogobot diff --git a/apps/bogobot/bogobot.sh b/apps/bogobot/bogobot.sh new file mode 100644 index 0000000000000000000000000000000000000000..7da4e2b3d8143cfaf1187e687c311e44a9b0bfbb --- /dev/null +++ b/apps/bogobot/bogobot.sh @@ -0,0 +1,2 @@ +#!/bin/sh +java -cp .:log4j-1.2.8.jar:pircbot.jar Bogobot diff --git a/apps/bogobot/build.xml b/apps/bogobot/build.xml new file mode 100644 index 0000000000000000000000000000000000000000..568b2af4ca53241eaf4e4e15d5dd8d015f67db8d --- /dev/null +++ b/apps/bogobot/build.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- ********************************************************** --> +<!-- bogobot - A simple join/part stats logger bot for I2P IRC. --> +<!-- --> +<!-- build.xml --> +<!-- 2004 The I2P Project --> +<!-- This code is public domain. --> +<!-- --> +<!-- author hypercubus --> +<!-- version 0.3.1 --> +<!-- ********************************************************** --> + +<project basedir="." default="compile" name="Bogobot"> + + <!-- init: + Create distribution directory if missing and initialize time stamp for + archive naming --> + <target name="init"> + <mkdir dir="dist" /> + <tstamp> + <format pattern="yyyy-MM-dd" property="DSTAMP" /> + </tstamp> + </target> + + <!-- compile: + Compile source code --> + <target depends="init" description="Compile source code" name="compile"> + <javac classpath="${basedir}" source="1.4" srcdir="." /> + </target> + + <!-- dist.bin: + Create the binary distribution archive --> + <target depends="init,compile" description="Create the binary distribution archive" name="dist.bin"> + <zip destfile="dist/Bogobot_${DSTAMP}.zip"> + <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" /> + </zip> + </target> + + <!-- dist.source: + Create the source distribution archive --> + <target depends="init" description="Create the source distribution archive" name="dist.source"> + <zip destfile="dist/Bogobot_source_${DSTAMP}.zip"> + <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" /> + </zip> + </target> + + <!-- dist: + Create both the binary and source distribution archives --> + <target depends="dist.bin,dist.source" description="Create both the binary and source distribution archives" name="dist"> + <echo message="Successfully created binary and source distribution archives in directory 'dist'." /> + </target> + + <!-- clean: + Delete all class files and temporary directories --> + <target description="Delete all class files and temporary directories" name="clean"> + <delete> + <fileset dir="${basedir}" includes="**/*.class" /> + </delete> + <echo message="Clean successful." /> + </target> + +</project> diff --git a/apps/bogobot/build_eclipse.xml b/apps/bogobot/build_eclipse.xml new file mode 100644 index 0000000000000000000000000000000000000000..456fb27d6d3229f4affaadca794be4f822c436ef --- /dev/null +++ b/apps/bogobot/build_eclipse.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- ********************************************************** --> +<!-- bogobot - A simple join/part stats logger bot for I2P IRC. --> +<!-- --> +<!-- build_eclipse.xml --> +<!-- 2004 The I2P Project --> +<!-- This code is public domain. --> +<!-- --> +<!-- author hypercubus --> +<!-- version 0.3.1 --> +<!-- ********************************************************** --> + +<project basedir="." default="dist" name="Bogobot"> + + <!-- init: + Create distribution directory if missing and initialize time stamp for + archive naming --> + <target name="init"> + <mkdir dir="dist" /> + <tstamp> + <format pattern="yyyy-MM-dd" property="DSTAMP" /> + </tstamp> + </target> + + <!-- dist.bin: + Create the binary distribution archive --> + <target depends="init" description="Create the binary distribution archive" name="dist.bin"> + <zip destfile="dist/Bogobot_${DSTAMP}.zip"> + <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.class bogobot.sh Bogoparser.class LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" /> + </zip> + </target> + + <!-- dist.source: + Create the source distribution archive --> + <target depends="init" description="Create the source distribution archive" name="dist.source"> + <zip destfile="dist/Bogobot_source_${DSTAMP}.zip"> + <zipfileset dir="${basedir}" includes="bogobot.bat Bogobot.java bogobot.sh Bogoparser.java build.xml build_eclipse.xml LICENSE_log4j.txt LICENSE_pircbot.txt log4j-1.2.8.jar pircbot.jar" /> + </zip> + </target> + + <!-- dist: + Create both the binary and source distribution archives --> + <target depends="dist.bin,dist.source" description="Create both the binary and source distribution archives" name="dist"> + <echo message="Successfully created binary and source distribution archives in directory 'dist'." /> + </target> + + <!-- clean: + Delete all class files and temporary directories --> + <target description="Delete all class files and temporary directories" name="clean"> + <delete> + <fileset dir="${basedir}" includes="**/*.class" /> + </delete> + <echo message="Clean successful." /> + </target> + +</project> diff --git a/apps/bogobot/log4j-1.2.8.jar b/apps/bogobot/log4j-1.2.8.jar new file mode 100644 index 0000000000000000000000000000000000000000..493a3ccc1361b0d84889798a995a351138826511 Binary files /dev/null and b/apps/bogobot/log4j-1.2.8.jar differ diff --git a/apps/bogobot/pircbot.jar b/apps/bogobot/pircbot.jar new file mode 100644 index 0000000000000000000000000000000000000000..d936d70ca958e5b5ba51da8b067090aad3c56abb Binary files /dev/null and b/apps/bogobot/pircbot.jar differ