shutdown-at-night-0.16/0000755000000000000000000000000012607433344011720 5ustar shutdown-at-night-0.16/Makefile0000644000000000000000000000107412231711112013343 0ustar DESTDIR = prefix = /usr sbindir = $(prefix)/sbin sysconfdir= /etc pkgsysconfdir= $(sysconfdir)/shutdown-at-night # Install scripts in lib/, to make it trivial to rewrite the internal tools # in any language, even compiled ones, without having to update the path used # by the callers. pkglibdir = $(prefix)/lib/shutdown-at-night INSTALL = install all: install: $(INSTALL) -d $(DESTDIR)$(pkglibdir)/. $(DESTDIR)$(pkgsysconfdir)/. $(INSTALL) shutdown-at-night $(DESTDIR)$(pkglibdir)/. $(INSTALL) wakeupclients $(DESTDIR)$(pkglibdir)/. distclean: clean clean: shutdown-at-night-0.16/wakeupclients0000755000000000000000000000446712607432724014540 0ustar #!/usr/bin/perl # Copyright (C) 2008-2015 Petter Reinholdtsen # # 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., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA use strict; use warnings; use Sys::Syslog qw(openlog syslog closelog LOG_NOTICE); my $delay = 5; my $wakeuplist = "/etc/shutdown-at-night/clients"; my $wakeupgenerator = "/etc/shutdown-at-night/clients-generator"; my %hwaddrs; sub load_clients { my $fh = shift; while (<$fh>) { chomp; my ($ip, $hwaddr) = split(/\s+/); $hwaddrs{$ip} = $hwaddr; } } # Locate hosts to wake up, from file if ( -f $wakeuplist ) { if (open(CLIENTS, "<", $wakeuplist)) { load_clients(*CLIENTS); close(CLIENTS); } } # Or using a dynamic script if ( -x $wakeupgenerator ) { if (open(CLIENTS, "$wakeupgenerator |")) { load_clients(*CLIENTS); close(CLIENTS); } } my %alive; map { $alive{$_} = 1; } get_alive_list(keys %hwaddrs); # Calculate when to start, assuming 20-30 seconds between each host #my $duration = $delay * scalar keys %hwaddrs; #my $allup = time(); # Start sending wakeup calls for my $ip (sort keys %hwaddrs) { if (! defined $alive{$ip}) { logmsg("sending wake-on-lan to $ip [$hwaddrs{$ip}]"); wakeup($ip, $hwaddrs{$ip}); sleep $delay; } else { logmsg("not sending wake-on-lan to already awake $ip [$hwaddrs{$ip}]"); } } # exit exit 0; sub wakeup { my ($ip, $hwaddr) = @_; `wakeonlan $hwaddr`; } sub get_alive_list { my @addresses = @_; return split(/\s+/, `fping -a @addresses 2>/dev/null`); } sub logmsg { my $msg = shift; openlog("wakeupclients", undef, 'user'); syslog(LOG_NOTICE, "%s", $msg); closelog; } shutdown-at-night-0.16/README0000644000000000000000000000462712231711112012572 0ustar Saving power by turning off clients at night ============================================ It is possible to save power by turning off clients at night, and turn them automatically on in the morning. There are some considerations to make when doing this: - The clients should not be shut down when someone is using them. This is done by checking the output from 'who', and as a special case, checking for the LDM ssh connection command to work with LTSP thin clients. - To avoid breaking fuses, it is a good idea to make sure all clients do not start at the same time. - There are two different methods available to wake up clients. One uses a BIOS feature and require a working and correct hardware clock, as well as a motherboard and BIOS version supported by nvram-wakeup, The other require a server with knowledge about all the clients to wake up and for all the clients to have support for wake-on-lan. How to set it up ---------------- On clients that should turn off at night, touch /etc/shutdown-at-night/shutdown-at-night, or add the hostname (ie the output from 'uname -n' or 'hostname -s' on the client) to the netgroup "shutdown-at-night-hosts". The clients might need to have wake-on-lan configured in the BIOS. It is also important that the switches and routers used between the wake-on-lan server and the clients will pass the WOL packages to the clients even if the clients are turned off. Some switches fail to pass on packages to clients that are missing in the ARP table on the switch, and this block the WOL packages. To enable wake-on-lan on the server, add the clients to /etc/shutdown-at-night/clients, with one line per client, IP address first, and MAC address (ethernet address) next, with space between them, or create a script /etc/shutdown-at-night/clients-generator to generate the list of clients on the fly. Here is an example /etc/shutdown-at-night/clients-generator for use with sitesummary: #!/bin/sh PATH=/usr/sbin:$PATH export PATH sitesummary-nodes -w An alternative if the netgroup is used to activate shutdown-at-night on clients is this script using the netgroup tool from the ng-utils package: #!/bin/sh PATH=/usr/sbin:$PATH export PATH netgroup -h shutdown-at-night-hosts License ------- This package is licensed using GNU General Public License v2 or later. Bugreporting ------------ Report issues to the debian-edu@lists.debian.org mailing list. shutdown-at-night-0.16/debian/0000755000000000000000000000000012607434173013143 5ustar shutdown-at-night-0.16/debian/shutdown-at-night.docs0000644000000000000000000000000712466073672017404 0ustar README shutdown-at-night-0.16/debian/patches/0000755000000000000000000000000012231714577014574 5ustar shutdown-at-night-0.16/debian/compat0000644000000000000000000000000212466073672014347 0ustar 9 shutdown-at-night-0.16/debian/control0000644000000000000000000000300112607434057014541 0ustar Source: shutdown-at-night Section: misc Priority: optional Maintainer: Debian Edu Packaging Team Uploaders: Petter Reinholdtsen , Mike Gabriel , Alexander Alemayhu , Standards-Version: 3.9.6 Build-Depends: debhelper (>= 9), Vcs-Git: git://anonscm.debian.org/debian-edu/pkg-team/shutdown-at-night.git Vcs-Browser: http://anonscm.debian.org/gitweb/?p=debian-edu/pkg-team/shutdown-at-night.git Package: shutdown-at-night Architecture: all Depends: cron | cron-daemon, ethtool, fping, ng-utils, wakeonlan, x11-utils, ${misc:Depends}, ${perl:Depends}, Recommends: nvram-wakeup, Suggests: sitesummary (>= 0.0.41), Description: System to shut down clients at night, and wake them in the morning With this tool you can schedule regular shutdowns of workstations in the evening, and also wake them up every morning, using either nvram-wakeup, ACPI wakeup or wake-on-lan. . For the wake-on-lan wake-up sequence you need one awake machine on your local network / subnet. This can be a server machine or a client machine that got just previously woken up by nvram-wakeup. . The shutdown sequence will be initiated hourly after 4pm via a CRON job. However, only machines that appear inactive / unused will be shut down. Machines that are currently in use will remain up and running. . The Shutdown-at-Night tool can be activated via a config file or via membership in a NIS netgroup called shutdown-at-night-hosts. shutdown-at-night-0.16/debian/source/0000755000000000000000000000000012466073672014451 5ustar shutdown-at-night-0.16/debian/source/format0000644000000000000000000000000412466073672015656 0ustar 1.0 shutdown-at-night-0.16/debian/cron.d0000644000000000000000000000063212231711112014232 0ustar # /etc/cron.d/shutdown-at-night SHELL=/bin/sh PATH=/sbin:/bin:/usr/sbin:/usr/bin # Shutdown clients 0 16,17,18,19,20,21,22,23,0,1,2,3,4,5,6 * * * root test -x /usr/lib/shutdown-at-night/shutdown-at-night && /usr/lib/shutdown-at-night/shutdown-at-night # Try to wake up clients on work days 30 6 * * 1,2,3,4,5 root test -x /usr/lib/shutdown-at-night/wakeupclients && /usr/lib/shutdown-at-night/wakeupclients shutdown-at-night-0.16/debian/rules0000755000000000000000000000003512466073672014227 0ustar #!/usr/bin/make -f %: dh $@ shutdown-at-night-0.16/debian/changelog0000644000000000000000000001737512607434173015032 0ustar shutdown-at-night (0.16) unstable; urgency=medium [ Wolfgang Schweer ] * Fix the xsession test to match the special case of gdm3 greeter no longer running gdm-simple-greeter. (Closes: #787566). [ Mike Gabriel ] * Provide support for blacklisting shutdown of individual hosts when NIS netgroups are used for controlling shutdown-at-night. (Use "no-shutdown-at-night-hosts" NIS netgroup for black listing hosts that should not shutdown). * Rename NIS netgroup for blacklisting shutdowns to shutdown-at-night-hosts-blacklist. Thanks to Petter Reinholdtsen for feedback. * debian/control: + Bump Standards: to 3.9.6. No changes needed. + Process with wrap-and-sort (options: -ast). + Update D (shutdown-at-night) for cron alternatives: cron | cron-daemon (Closes: #796875). * shutdown-at-night, wakeupclients: Add copyright header to files. * Add COPYING file (containing GPL-2(+)) license. * debian/copyright: + Switch to DEP-5 compliant format. -- Mike Gabriel Wed, 14 Oct 2015 13:11:53 +0200 shutdown-at-night (0.15) unstable; urgency=medium [ Wolfgang Schweer ] * Adjust the 'who' command to exclude the special case of gdm3 greeter running as user '(unknown)' to be assumed as a logged in user (Closes: #775608). -- Holger Levsen Tue, 17 Feb 2015 10:53:25 +0100 shutdown-at-night (0.14) unstable; urgency=low * Updated Standards-Version from 3.9.4 to 3.9.5. No changes needed * Raise debhelper compat level from 5 to 9. * Replace cdbs with dh in rules file. The minimal verision is enough. Drop cdbs dependency. * Add Alexander Alemayhu as uploader. -- Petter Reinholdtsen Sat, 30 Aug 2014 10:18:28 +0200 shutdown-at-night (0.13) unstable; urgency=low [ Mike Gabriel ] * Package becomes team-maintained: Debian Edu Packaging Team. * debian/control: + Package migrated to Git. Update Vcs-*: fields and point to Git on Alioth. + Bump Standards: to 3.9.4. No changes necessary. + Improve LONG_DESCRIPTION. + Mention ACP wakeup functionality in LONG_DESCRIPTION. * debian/source/format: + Add file. Use format 1.0 to match capabilities of Debian Edu's dak. [ Petter Reinholdtsen ] * Rewrite logic checking if a host is unused to look for the KDM, Gnome or lightdm login screen to confirm the X sessions are unused (Closes: #729553). * Add depend on x11-utils for the xlsclients tool used to check unused X sessions. -- Petter Reinholdtsen Fri, 22 Nov 2013 20:22:08 +0100 shutdown-at-night (0.12) unstable; urgency=low [ Petter Reinholdtsen ] * Add support for using the ACPI RTC wakeup interface to wake up the machine (Closes: #717441). * Correct time zone calculations, try to ensure that the 07:00 wake up time is in the local time zone and not UTC. * Make sure to syslog that ACPI RTC is used to set wakeup time when it is used. [ Mike Gabriel ] * The -i option in the wakeonlan executable is only useful on networks with static ARP tables available. For networks using dynamic ARP tables (common with most switches), a broadcast address instead of a host IP should be given here. The wakeonlan default (255.255.255.255) is just fine for most network setups. So we omit the -i option completely when calling wakeonlan in the wakeupclients script. * debian/control: + Add myself to Uploaders: field. -- Mike Gabriel Wed, 23 Oct 2013 11:13:51 +0200 shutdown-at-night (0.11) unstable; urgency=low * Quiet down cron job to wake up client to not complain when fping notice they are unavailable. * Add support for extending the "busy" detection in shutdown-at-night by adding code to run hooks in /etc/shutdown-at-night/unused.d and /usr/lib/shutdown-at-night/unused.d. (Closes: #619950) -- Petter Reinholdtsen Mon, 15 Jul 2013 17:26:07 +0200 shutdown-at-night (0.10) unstable; urgency=low * Do not shut down if uptime is less then an hour. Based on patch and idea from Jonathan Jackson in BTS report #619950. * Fix typo in syslog message (ist -> is). * Update standards-version from 3.8.0 to 3.9.2. No changes needed. -- Petter Reinholdtsen Mon, 13 Feb 2012 23:42:41 +0100 shutdown-at-night (0.9) unstable; urgency=low * Sync with Ubuntu version 0.8ubuntu1: - Apply patch from Mike Gabriel clarifying reasons for host(s) not shutting down. (LP: #608616) (Closes: #636672) - Add ethtool as a dependency. (LP: #607021) (Closes: #636671) -- Petter Reinholdtsen Wed, 04 Jan 2012 14:43:31 +0100 shutdown-at-night (0.8) unstable; urgency=low * Make sure netgroup membership is checked using both the full and short hostname, to work with different netgroup styles (Solves Skolelinux bug #1435). -- Petter Reinholdtsen Wed, 03 Mar 2010 22:02:07 +0100 shutdown-at-night (0.7) unstable; urgency=low [ Petter Reinholdtsen ] * Rename netgroup used to enable shutdown-at-night, from host-shutdown-at-night to shutdown-at-night-hosts, to match the name structure used in Debian Edu. * Updated Standards-Version from 3.7.3 to 3.8.0. No changes needed. [ Holger Levsen ] * Add Vcs: headers to debian/control. -- Petter Reinholdtsen Wed, 16 Jul 2008 14:34:35 +0200 shutdown-at-night (0.6) unstable; urgency=low * Change GPL file reference in copyright to use GPL-2 instead of GPL, to avoid surprises when the content of the GPL file changes between Debian versions. -- Petter Reinholdtsen Sun, 22 Jun 2008 00:20:25 +0200 shutdown-at-night (0.5) unstable; urgency=low * Make sure to not give the same wakeup time to all BIOSes, to avoid machines with good hardware clock to wake up at the same time and thus reduce the chance that a fuse breaks. * Add comment in Makefile explaining why the internal scripts are in /usr/lib/ and not /usr/share/. * Improve copyright file on request from the Debian ftpmasters. * Adjust return value from nvramwakeup() in shutdown-at-night, to return success if the BIOS wakeup time was updated. -- Petter Reinholdtsen Sun, 15 Jun 2008 19:28:09 +0200 shutdown-at-night (0.4) unstable; urgency=low * Make sure the /etc/shutdown-at-night/ directory is part of the package. * Change shutdown-at-night to abort the shutdown if wake-on-lan could not be enabled. * Add 'cron | fcron' as dependency, to make sure the cron jobs run as they should. * Improve setup instructions in the README. -- Petter Reinholdtsen Sun, 15 Jun 2008 00:40:36 +0200 shutdown-at-night (0.3) unstable; urgency=low * Convert wakeupclients to use syslog. * Add suggests on sitesummary (>= 0.0.41) to suggest a version that can generate the client list automatically. * Add support in wakeupclients to run a script /etc/shutdown-at-night/clients-generator to extract the clients to wake up dynamically. * Add ${perl:Depends} to package dependencies. -- Petter Reinholdtsen Fri, 13 Jun 2008 11:06:29 +0200 shutdown-at-night (0.2) unstable; urgency=low * Add server side cron job to start waking up clients Monday-Friday at 06:30. * Change wakeupclients to log progress, and to check if a client is up before trying to wake it. * Change wakeupclients to use fping to check for alive clints, to speed up the script. Reduce sleep time between wakeups to 5 seconds. * Correct typos in the shutdown-at-night script. -- Petter Reinholdtsen Fri, 13 Jun 2008 08:58:00 +0200 shutdown-at-night (0.1) unstable; urgency=low * Initial package. -- Petter Reinholdtsen Sun, 8 Jun 2008 18:18:53 +0200 shutdown-at-night-0.16/debian/copyright0000644000000000000000000000260712607433630015100 0ustar Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: shutdown-at-night Source: http://anonscm.debian.org/cgit/debian-edu/pkg-team/shutdown-at-night.git/ Files: wakeupclients shutdown-at-night Copyright: 2008-2015, Petter Reinholdtsen License: GPL-2.0+ Files: Makefile README COPYING Copyright: 2008-2015, Petter Reinholdtsen License: GPL-2.0+ Comment: Assuming copyright holder as main code files. Assuming license as found in COPYING file. Files: debian/* Copyright: 2008-2015, Petter Reinholdtsen License: GPL-2.0+ License: GPL-2.0+ 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 package 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, see . . On Debian systems, the complete text of the GNU General Public License version 2 can be found in "/usr/share/common-licenses/GPL-2". shutdown-at-night-0.16/shutdown-at-night0000755000000000000000000001357612607432710015242 0ustar #!/bin/bash # Copyright (C) 2008-2015 Petter Reinholdtsen # # 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., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA # Using /bin/bash and not /bin/sh to get a shell with support for random number # generation. # # Automatically turn off computers at night, defined as 16:00 - 06:00. # Should schedule wakeup in the morning. # How do we decide if it should be enabled for this host? Netgroup # membership? LDAP search? Flag file? #set -e wakeuptime="07:00" hostname="$(uname -n)" netgroupname="shutdown-at-night-hosts" netgroupname_noshutdown="shutdown-at-night-hosts-blacklist" # Hook directories to allow custom code to detect if a machine is used # or not. unuseddlist="/etc/shutdown-at-night/unused.d /usr/lib/shutdown-at-night/unused.d" in_netgroup() { # Try both long and short name for h in "$(uname -n)" "$(hostname -s)" ; do if innetgr -h "$h" "$netgroupname_noshutdown"; then return 1 elif innetgr -h "$h" "$netgroupname" ; then return 0 fi done return 1 } enabled_for_host() { # Flag for now if [ -f /etc/shutdown-at-night/shutdown-at-night ] || in_netgroup; then return 0 fi return 1 } # Take wakeup hour:minute in local time zone and return wake up time # in seconds since EPOC UTC, radomized around the target wakeup time. whentowakeup() { wakeuptime=$1 # Spread the BIOS wakeup time across a 20 minute period, to avoid # all of them waking up at the same time, killing a fuse. # Convert local target time in seconds since EPOC UTC targettime=$(date +%s -d "tomorrow $wakeuptime $(date +%z)") echo $(( $targettime - 600 + $RANDOM % 1200)) } nvramwakeup() { # http://www.vdr-portal.de/board/thread.php?threadid=75582&sid=b7aced20e710aef12ffa56b5197fe168 wakeuptime=$1 when=$(whentowakeup $wakeuptime) # Make sure HW clock is correct, as it is used to decide when to # wake up. /etc/init.d/hwclock.sh stop > /dev/null # Make sure /dev/nvram is available modprobe nvram # This require a supported motherboard if nvram-wakeup -s $when > /dev/null ; then logger -t shutdown-at-night "scheduled $hostname to turn itself on at $wakeuptime using nvram-wakeup." return 0 else return 1 fi } # This method might not work if the hardware clock is updated during # shutdown. Changing /etc/default/hwclock to list HWCLOCKACCESS=yes # to disable it. # Based on acpiwakeup() { wakeuptime="$1" if [ -e /sys/class/rtc/rtc0/wakealarm ] ; then when=$(whentowakeup $wakeuptime) # First reset alarm echo 0 > /sys/class/rtc/rtc0/wakealarm # Next, set it to our selected time echo $when > /sys/class/rtc/rtc0/wakealarm logger -t shutdown-at-night "scheduled $hostname to turn itself on at $wakeuptime using /sys/class/rtc/rtc0/wakealarm." return 0 else return 1 fi } prepare_wakeonlan() { interface="$(/sbin/route -n | awk '/^0\.0\.0\.0 / { print $8 }')" ethtool -s $interface wol g } # Return true if local user is logged in, false otherwise is_local_user() { if [ "$(who | grep -v '\(unknown\)')" ] ; then return 0 else return 1 fi } # Return true if ldm login is active is_active_ldm_session() { if ps -efwww | egrep -q ' ssh .*LTSP_CLIEN[T]' ; then return 0 else return 1 fi } # Return false if X session is confirmed unused (ie login screen is # shown). If not sure, claim it is used to be safe. is_xsession_used() { for s in \ /var/run/gdm3/auth-for-Debian-gdm-*/database \ /var/lib/lightdm/.Xauthority \ /var/run/xauth/* \ /run/xauth/*; do if [ -e "$s" ] ; then if [ XAUTHORITY="$s" DISPLAY=:0 xlsclients | egrep -q 'kdmgreet|lightdm-gtk-greeter|razor-lightdm-greeter|lightdm-kde-greeter' ] \ || [ -d /var/run/gdm3/greeter ] ; then return 1 fi fi done return 0 } is_host_unused() { # Logged in users, or ldm connection to a remote server if is_xsession_used || is_local_user || is_active_ldm_session; then return 1 fi # Uptime is less than one hour if (( $(cat /proc/uptime | awk '{print int($1)}') < 3600 )) ; then return 1 fi for dir in $unuseddlist ; do if [ -d $dir ] ; then for f in $dir/* ; do if [ -x $f ] && ! $f ; then return 1 fi done fi done return 0 } fatal() { logger -t shutdown-at-night "$1" exit 1 } if enabled_for_host ; then if is_host_unused; then logger -t shutdown-at-night "turning off unused client $hostname." if type nvram-wakeup >/dev/null 2>&1 ; then nvramwakeup $wakeuptime fi acpiwakeup $waketime prepare_wakeonlan || fatal "unable to enable wake-on-lan - aborting shutdown." shutdown -h 5 "Unused host being turned off for the night (cron)." < /dev/null > /dev/null 2>&1 & else logger -t shutdown-at-night "client $hostname is in use; shutdown sequence will NOT be initiated." fi else logger -t shutdown-at-night "shutdown-at-night is not enabled for client $hostname." fi shutdown-at-night-0.16/COPYING0000644000000000000000000003556412567444451012776 0ustar GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 Lesser 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