├── README.md
├── minecraft
└── LICENSE


/README.md:
--------------------------------------------------------------------------------
  1 | ## minecraft-init-script
  2 | 
  3 | by Jamie Bainbridge <<jamie.bainbridge@gmail.com>>
  4 | 
  5 | This is an initscript to run a Minecraft or CraftBukkit server on CentOS, Fedora, and Ubuntu.
  6 | 
  7 | ### Note
  8 | 
  9 | As of 2015, this script is no longer actively maintained. All the supported distros are moving to systemd, making the concept of an LSB initscript rather outdated. All issues I see are related to bugs in Ubuntu's implementation of Upstart, it works perfectly on CentOS. However I think you are much better learning to use containers like Docker to control a single process and its files. There are many instructions around the internet on how to do this.
 10 | 
 11 | Thanks to all supporters over the years. You are welcome to fork this repo if you wish to continue development.
 12 | 
 13 | ### Features
 14 | 
 15 | *   Start, stop, restart CraftBukkit as a system service
 16 | *   Automatic (via cron) and manual logfile rotation
 17 | *   Automatic (via cron) and manual backups
 18 | *   Backup compression and rotation (keeps 7 days worth of backups)
 19 | *   Allows use of third-party backup solutions
 20 | *   Check latest Recommended Build and update to it if required
 21 | *   Information display including Java path, current memory usage, current TCP connections
 22 | *   Able to run multiple separate instances of the server at once
 23 | 
 24 | ### Supported Distributions
 25 | 
 26 | *   CentOS 6, CentOS 5, Fedora 14 (probably works on Fedora Core 6 and later, untested)
 27 | *   Ubuntu Server 12.04 LTS
 28 | 
 29 | Other distros which use SysV Init or Upstart will probably work.
 30 | 
 31 | Distros using systemd (Fedora 15+, Arch Linux, etc) may not work.
 32 | 
 33 | ### Requirements
 34 | 
 35 | *   `screen`, `rsync`
 36 | 
 37 |     (you may need to install these)
 38 | 
 39 | *   `bash`, `chkconfig` or `sysv-rc`, `coreutils`, `cronie`, `curl`, `diffutils`, `grep`, `initscripts`, `net-tools`, `procps`, `tar`
 40 | 
 41 |   (these should all be installed by default)
 42 | 
 43 | *   Oracle Java 7
 44 | 
 45 | *   Enough disk space to save your map twice, plus another ~5 times for a week of compressed backup space.
 46 | 
 47 |   ie: If your map is 1Gb then you probably need at least 7Gb, plus any space your plugins require and any additional backups you'll be making.
 48 | 
 49 | ### Installation
 50 | 
 51 | As the root user:
 52 | 
 53 | *   Install Sun Java (CentOS/Fedora)
 54 | 
 55 |     Download the RPM from <http://www.java.com/>
 56 | 
 57 |     `yum localinstall jre-<version>.rpm`
 58 | 
 59 | *   Install Sun Java (Ubuntu)
 60 | 
 61 |     ~~~
 62 |     sudo add-apt-repository ppa:webupd8team/java
 63 |     sudo apt-get update
 64 |     sudo apt-get install oracle-java7-installer
 65 |     ~~~
 66 | 
 67 | *   Confirm your JVM installation
 68 | 
 69 |     ~~~
 70 |     java -version
 71 |     ~~~
 72 | 
 73 | *   Create a new user with a home directory
 74 | 
 75 |     ~~~
 76 |     useradd -m bukkit
 77 |     ~~~
 78 |     
 79 | *   Save the script as `/etc/init.d/minecraft` and make it executable
 80 | 
 81 |     ~~~
 82 |     chmod +x /etc/init.d/minecraft
 83 |     ~~~
 84 |     
 85 | *   Copy between the `<<COMMENT` and `COMMENT` lines and place the copy at `/etc/default/minecraft`
 86 | 
 87 |     If you need to edit settings, edit the `/etc/default/minecraft` file, not the initscript
 88 | 
 89 | *   Allow the bukkit user to run the init script without needing root access
 90 | 
 91 |     Type `visudo` and add this line to the bottom:
 92 | 
 93 |     ~~~
 94 |     bukkit localhost=NOPASSWD:/etc/init.d/minecraft*
 95 |     ~~~
 96 | 
 97 | *   Create an alias so you only have to type `minecraft` to run the script
 98 | 
 99 |     Add the following line to both root and bukkit's `~/.bashrc` file:
100 | 
101 |     ~~~
102 |     alias minecraft='/etc/init.d/minecraft'
103 |     ~~~
104 | 
105 | *   Start the server on system boot if desired (CentOS/Fedora)
106 |   
107 |     ~~~
108 |     chkconfig --add minecraft
109 |     chkconfig minecraft on
110 |     ~~~
111 | 
112 | *   Start the server on system boot if desired (Ubuntu)
113 | 
114 |     ~~~
115 |     update-rc.d minecraft defaults
116 |     ~~~
117 | 
118 | As the regular user, bukkit:
119 | 
120 | *   Make the required paths
121 | 
122 |     ~~~
123 |     mkdir -p ~/backups && mkdir -p ~/craftbukkit
124 |     ~~~
125 | 
126 | *   Put your `craftbukkit.jar`, world, plugins, `server.properties`, etc into `~/craftbukkit`
127 | 
128 | ### Backups
129 | 
130 | *   Create cron jobs to do regular backups and rotations around 4am
131 | 
132 |     Type `crontab -e` to open the cron interface and add the following
133 | 
134 |     ~~~
135 |      0 4 * * * /etc/init.d/minecraft backup              # backup world at 4:00am
136 |      5 4 * * * /etc/init.d/minecraft logrotate           # rotate logs at 4:05am
137 |     15 4 * * * /etc/init.d/minecraft removeoldbackups    # remove old backups at 4:30am
138 |     ~~~
139 | 
140 | *   If you have multiple worlds, you can pass the worldname as a parameter to the regular backup
141 | 
142 |     ~~~
143 |      0 4 * * * /etc/init.d/minecraft backup world1       # backup world1 at 4:00am
144 |      5 4 * * * /etc/init.d/minecraft logrotate           # rotate logs at 4:05am
145 |     15 4 * * * /etc/init.d/minecraft backup world2       # backup world2 at 4:15am
146 |     30 4 * * * /etc/init.d/minecraft removeoldbackups    # remove old backups at 4:30am
147 |     ~~~
148 | 
149 | *   If you wish to use a third-party backup solution, just disable world writes
150 | 
151 |     ~~~
152 |     minecraft save-off
153 |     ~~~
154 | 
155 |     Then run your backup tool. Then re-enable world writes
156 | 
157 |     ~~~
158 |     minecraft save-on
159 |     ~~~
160 | 
161 | ### Multiple Instances
162 | 
163 | It is possible to run multiple instances, for example a Creative server and a Survival server, on the same system.
164 | 
165 | *   Copy the script to two new files
166 | 
167 |     ~~~
168 |     cp /etc/init.d/minecraft /etc/init.d/minecraft-creative
169 |     cp /etc/init.d/minecraft /etc/init.d/minecraft-survival
170 |     ~~~
171 | 
172 | *   Edit the `Provides` section on Line 6 to the same as the new filename
173 | 
174 |     ~~~
175 |     # Provides: minecraft-creative
176 |     # Provides: minecraft-survival
177 |     ~~~
178 | 
179 | *   Create a settings file for each instance in `/etc/default/` using the same name as the script
180 | 
181 |     ~~~
182 |     /etc/default/minecraft-creative
183 |     /etc/default/minecraft-creative
184 |     ~~~
185 | 
186 | *   Set an alias for each server in `~/.bashrc`
187 | 
188 |     ~~~
189 |     alias creative='/etc/init.d/minecraft-creative'
190 |     alias survival='/etc/init.d/minecraft-survival'
191 |     ~~~
192 | 
193 | *   Add the new scripts to `chkconfig` or `update-rc.d`
194 | 
195 | *   Set the paths of the separate maps in each script
196 | 
197 |     ~~~
198 |     MCPATH="/home/bukkit/craftbukkit-creative"
199 |     MCPATH="/home/bukkit/craftbukkit-survival"
200 |     ~~~
201 |  
202 | *   Change your screen session names in each script
203 | 
204 |     ~~~
205 |     SCRNAME="creative"
206 |     SCRNAME="survival"
207 |     ~~~
208 | 
209 | ### Usage
210 | 
211 | *   Start the server
212 | 
213 |     ~~~
214 |     minecraft start
215 |     ~~~
216 | 
217 | *   Stop the server
218 | 
219 |     ~~~
220 |     minecraft stop
221 |     ~~~
222 | 
223 | *   Restart the server
224 | 
225 |     ~~~
226 |     minecraft restart
227 |     ~~~
228 | 
229 | *   Back up the map and executable
230 | 
231 |     ~~~
232 |     minecraft backup
233 |     ~~~
234 | 
235 |     The final compressed backup is done when the `.md5` file appears in the backup directory.
236 | 
237 | *   Back up multiple maps
238 | 
239 |     ~~~
240 |     minecraft backup world1
241 |     minecraft backup world2
242 |     ~~~
243 | 
244 | *   Check the server is running
245 | 
246 |     ~~~
247 |     minecraft status
248 |     ~~~
249 | 
250 | *   Get some more info
251 | 
252 |     ~~~
253 |     minecraft info
254 | 
255 |     * CraftBukkit (pid 9037) is running...
256 |     - Java Path : /usr/java/jre1.6.0_31/bin/java
257 |     - Start Command : java -Xms512M -Xmx3584M -jar craftbukkit.jar nogui
258 |     - Server Path : /home/bukkit/craftbukkit
259 |     - World Name : world
260 |     - Process ID : 9037
261 |     - Memory Usage : 742796 kb
262 |     - Active Connections :
263 |     Proto Recv-Q Send-Q Local Address Foreign Address State
264 |     tcp 0 0 0.0.0.0:25565 0.0.0.0:* LISTEN
265 |     tcp 0 0 192.168.2.99:25565 192.168.2.69:55507 ESTABLISHED
266 |     ~~~
267 | 
268 | *   Broadcast a message to the server
269 | 
270 |     ~~~
271 |     minecraft say
272 |     ~~~
273 | 
274 |     Note that some punctuation like 'apostrophes' will not work.
275 | 
276 | ### License
277 | 
278 | **GNU GPLv3**
279 | 
280 | This program is free software: you can redistribute it and/or modify
281 | it under the terms of the GNU General Public License as published by
282 | the Free Software Foundation, either version 3 of the License, or
283 | (at your option) any later version.
284 | 
285 | This program is distributed in the hope that it will be useful,
286 | but WITHOUT ANY WARRANTY; without even the implied warranty of
287 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
288 | GNU General Public License for more details.
289 | 
290 | You should have received a copy of the GNU General Public License
291 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
292 | 
293 | ### Contributors
294 | 
295 | *   Jamie Bainbridge <<jamie.bainbridge@gmail.com>>
296 | *   Polhemic on GitHub
297 | *   Mooash on GitHub
298 | *   Jon Stephens
299 | 
300 | Initial concept based off
301 | 
302 | *   http://forums.bukkit.org/threads/tutorial-centos-bukkit-installation.56371/
303 | *   http://www.minecraftwiki.net/wiki/M3tal_Warrior_Server_Startup_Script
304 | *   http://forums.bukkit.org/threads/admin-linux-init-script-for-bukkit.53235/
305 | 


--------------------------------------------------------------------------------
/minecraft:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | # /etc/init.d/minecraft
  3 | # version 2014-08-16 (YYYY-MM-DD)
  4 | 
  5 | ### BEGIN INIT INFO
  6 | # Provides: minecraft
  7 | # Required-Start: $local_fs $remote_fs
  8 | # Required-Stop: $local_fs $remote_fs
  9 | # Should-Start: $network
 10 | # Should-Stop: $network
 11 | # Default-Start: 2 3 4 5
 12 | # Default-Stop: 0 1 6
 13 | # Short-Description: Minecraft server
 14 | # Description: Starts the CraftBukkit Minecraft server
 15 | ### END INIT INFO
 16 | 
 17 | # minecraft-init-script - An initscript to start Minecraft or CraftBukkit
 18 | # Copyright (C) 2011-2014 Super Jamie <jamie@superjamie.net>
 19 | #
 20 | # This program is free software: you can redistribute it and/or modify
 21 | # it under the terms of the GNU General Public License as published by
 22 | # the Free Software Foundation, either version 3 of the License, or
 23 | # (at your option) any later version.
 24 | #
 25 | # This program is distributed in the hope that it will be useful,
 26 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
 27 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 28 | # GNU General Public License for more details.
 29 | #
 30 | # You should have received a copy of the GNU General Public License
 31 | # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 32 | 
 33 | # Source the function library
 34 | ## CentOS/Fedora
 35 | if [ -f /etc/rc.d/init.d/functions ]
 36 |  then
 37 |  . /etc/rc.d/init.d/functions
 38 | fi
 39 | ## Ubuntu
 40 | if [ -f /lib/lsb/init-functions ]
 41 |  then
 42 |  . /lib/lsb/init-functions
 43 | fi
 44 | 
 45 | <<COMMENT
 46 | ## ---------------------------------------------------------
 47 | ## copy between these lines and place them at /etc/default/minecraft
 48 | ## do not include the <<COMMENT and COMMENT words
 49 | 
 50 | ## Settings for minecraft-init-script
 51 | 
 52 | # Nice looking name of service for script to report back to users
 53 | SERVERNAME="CraftBukkit"
 54 | 
 55 | # Filename of server binary
 56 | SERVICE="craftbukkit.jar"
 57 | 
 58 | # URL of server executable for update checking - http://cbukk.it/craftbukkit.jar is the recommended latest Craftbukkit URL
 59 | SERVER_URL="http://cbukk.it/craftbukkit.jar"
 60 | 
 61 | # Username of non-root user who will run the server
 62 | USERNAME="bukkit"
 63 | 
 64 | # Path of server binary and world
 65 | MCPATH="/home/bukkit/craftbukkit"
 66 | 
 67 | # Number of CPU cores to thread across if using multithreaded garbage collection
 68 | CPU_COUNT="2"
 69 | 
 70 | # Where backups go
 71 | BACKUPPATH="/home/bukkit/backups"
 72 | 
 73 | # How many days worth of backups to keep (default 7)
 74 | BACKUPS_TO_KEEP="7"
 75 | 
 76 | # Name of Screen session
 77 | SCRNAME="minecraft"
 78 | 
 79 | ## The Java command to run the server, uncomment one INVOCATION line only!
 80 | 
 81 | # Nothing special, just start the server with 1Gb RAM
 82 | # INVOCATION="java -Xms1024M -Xmx1024M -Djava.net.preferIPv4Stack=true -jar $SERVICE nogui"
 83 | 
 84 | # This is what I run my server with, tune your RAM usage accordingly
 85 | # Tested fastest GC - Default parallel new gen collector, plus parallel old gen collector
 86 | INVOCATION="java -Xms1024M -Xmx1024M -Djava.net.preferIPv4Stack=true -XX:MaxPermSize=128M -XX:UseSSE=3 -XX:-DisableExplicitGC -XX:+UseParallelOldGC -XX:ParallelGCThreads=$CPU_COUNT -XX:+AggressiveOpts -XX:+UseCompressedStrings -jar $SERVICE nogui"
 87 | 
 88 | # I removed these "performance" commands as I don't see any difference with them
 89 | # -XX:+UseFastAccessorMethods -XX:+UseAdaptiveGCBoundary
 90 | 
 91 | # I've had a suggestion from a Java tuning engineer to use these
 92 | # -XX:+AggressiveOpts -XX:+UseCompressedStrings
 93 | 
 94 | # Add HugePage support if you have it configured on the OS
 95 | # You should be using HugePages if you give more than 4Gb on the Java invocation line
 96 | # -XX:+UseLargePages
 97 | 
 98 | SETTINGS_FILE_WORKING="1"
 99 | ## End of settings file
100 | ## ---------------------------------------------------------
101 | COMMENT
102 | 
103 | ### ### ### ### ### ### ### ### ### ### ### ### ### ###
104 | ### You shouldn't need to edit anything below here! ###
105 | ### ### ### ### ### ### ### ### ### ### ### ### ### ###
106 | 
107 | ## Apply the settings file
108 | 
109 | # define the location of the settings file from the name of this script
110 | SETTINGSFILE="/etc/default/$(basename $0)"
111 | 
112 | # check the file exists, and fail if not
113 | if [ ! -f "$SETTINGSFILE" ]
114 |  then
115 |  echo " * [ERROR] Settings file $SETTINGSFILE does not exist. Can't run!"
116 |  exit 1;
117 | fi
118 | 
119 | # if exists so source it
120 | . "$SETTINGSFILE"
121 | 
122 | # if the settings are not applying for some reason, then fail
123 | if [ ! "$SETTINGS_FILE_WORKING" == "1" ]
124 |  then
125 |  echo " * [ERROR] Settings file $SETTINGSFILE is not applying. Can't run!"
126 |  echo " Check your options are uncommented and you haven't copied the <<COMMENT block."
127 |  exit 1;
128 | fi
129 | 
130 | ## Get some more info from the settings file
131 | 
132 | # Find the world name from the existing server file
133 | WORLDNAME="$(grep -E 'level-name' $MCPATH/server.properties | sed -e s/.*level-name=//)"
134 | 
135 | # Find the port number from the existing server file
136 | SERVERPORT="$(grep -E 'server-port' $MCPATH/server.properties | sed -e s/.*server-port=//)"
137 | 
138 | ## Runs all commands as the non-root user
139 | 
140 | as_user() {
141 |   ME="$(whoami)"
142 |   if [ "$ME" == "$USERNAME" ]
143 |   then
144 |     bash -c "$1"
145 |   else
146 |     su - "$USERNAME" -c "$1"
147 |   fi
148 | }
149 | 
150 | ## Check if the server is running or not, and get the Java Process ID if it is
151 | 
152 | server_running() {
153 |   # Get the PID of the running Screen session:
154 |   # ps, remove grep, look for screen, look for the screen session $SCRNAME to differentiate between multiple servers, awk out everything but the pid
155 |   SCREENPID=""
156 |   SCREENPID="$(ps -ef | grep -v grep | grep -i screen | grep $SCRNAME | awk '{print $2}')"
157 |   # if the screen session with $SCRNAME is not running, then the server is not running, so we return 1 and exit the function
158 |   if [ -z "$SCREENPID" ]
159 |   then
160 |    return 1
161 |   fi
162 |   # PID="$(ps -ef | grep -v grep | grep -i screen | grep $SCRNAME | awk '{print $2}' | xargs ps -f --ppid | grep $SERVICE | awk '{print $2}')"
163 |   # use the screen session pid to get the parent pid, which is the actual pid of the java process, check that process is actually $SERVICE
164 |   JAVAPID="$(ps -f --ppid $SCREENPID | grep $SERVICE | awk '{print $2}')"
165 |   # if the java process is not running, then the server is not running, so we return 1 to exit the function
166 |   if [ -z "$JAVAPID" ]
167 |   then
168 |     return 1
169 |   fi
170 |   # if we haven't failed those two tests, we have a running server, so we return success
171 |   return 0
172 | }
173 | 
174 | ## Start the server executable as a service
175 | 
176 | mc_start() {
177 |   if server_running
178 |   then
179 |     echo " * [ERROR] $SERVERNAME was already running (pid $JAVAPID). Not starting!"
180 |     exit 1
181 |   else
182 |     echo " * $SERVERNAME was not already running. Starting..."
183 |     echo " * Using map named \"$WORLDNAME\"..."
184 |     as_user "cd \"$MCPATH\" && screen -c /dev/null -dmS $SCRNAME $INVOCATION"
185 |     echo " * Checking $SERVERNAME is running..."
186 | 
187 |     # start a counter and check for 15 seconds if the server is running or not
188 |     COUNT=0
189 |     while [ $COUNT -lt 15 ]; do
190 |       if server_running
191 |       then
192 |         echo " * [OK] $SERVERNAME is now running (pid $JAVAPID)."
193 | 	exit 0
194 |       else
195 |         let COUNT=COUNT+1
196 |         sleep 1
197 |       fi
198 |     done
199 |     # if we've reached here, the server hasn't started in 15 seconds
200 |     echo " * [ERROR] Could not start $SERVERNAME."
201 |     exit 1
202 |   fi
203 | }
204 | 
205 | ## Stop the executable
206 | 
207 | mc_stop() {
208 |   if server_running
209 |   then
210 |     echo " * $SERVERNAME is running (pid $JAVAPID). Commencing shutdown..."
211 |     echo " * Notifying users of shutdown..."
212 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"say SERVER SHUTTING DOWN IN 10 SECONDS. Saving map...\"\015'"
213 |     echo -n " * Saving map named \"$WORLDNAME\" to disk"
214 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"save-all\"\015'"
215 | 
216 |     # start a counter and check for 20 seconds for when the world has saved
217 |     COUNT=0
218 |     while [ $COUNT -lt 10 ]; do
219 |       echo -n "."
220 |       sleep 2
221 |       if [ -f "$MCPATH/logs/latest.log" ]
222 |       then
223 |         if [[ "$(tail -n 20 $MCPATH/logs/latest.log | grep -E 'Save complete|Saved the world' | wc -l)" -gt 0 ]]; then
224 |           COUNT=99
225 |         fi
226 |       fi
227 |       let COUNT=COUNT+1
228 |     done
229 |     echo ""
230 | 
231 |     echo -n " * Stopping $SERVERNAME"
232 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"stop\"\015'"
233 | 
234 |     # start a counter and check for 15 seconds if the server is running or not
235 |     COUNT=0
236 |     while [ $COUNT -lt 15 ]; do
237 |       if server_running
238 |       then
239 |         echo -n "."
240 |         let COUNT=COUNT+1
241 |         sleep 1
242 |       else
243 |         echo ""
244 |         echo " * [OK] $SERVERNAME is shut down."
245 |         exit 0
246 |       fi
247 |     done
248 |     echo ""
249 |     # if we've reached here, the server hasn't stopped in 15 seconds
250 |     echo " * [ERROR] $SERVERNAME is still running (pid $JAVAPID). Could not be shutdown!"
251 |     exit 1
252 |   else
253 |     echo " * [OK] $SERVERNAME is shut down."
254 |   fi
255 | }
256 | 
257 | ## Set the server read-only, save the map, and have Linux sync filesystem buffers to disk
258 | 
259 | mc_saveoff() {
260 |   if server_running
261 |   then
262 |     echo " * $SERVERNAME is running. Commencing save..."
263 |     echo " * Notifying users of save..."
264 |     as_user "screen -p 0 -S $SCRNAME  -X eval 'stuff \"say SERVER BACKUP STARTING. Server going read-only...\"\015'"
265 |     echo " * Setting server read-only..."
266 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"save-off\"\015'"
267 |     echo " * Saving map named \"$WORLDNAME\" to disk..."
268 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"save-all\"\015'"
269 |     sync
270 |     sleep 10
271 |     echo " * [OK] Map saved."
272 |   else
273 |     echo " * [INFO] $SERVERNAME was not running. Not suspending saves."
274 |   fi
275 | }
276 | 
277 | ## Set the server read-write
278 | 
279 | mc_saveon() {
280 |   if server_running
281 |   then
282 |     echo " * $SERVERNAME is running. Re-enabling saves..."
283 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"say SERVER BACKUP ENDED. Server going read-write...\"\015'"
284 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"save-on\"\015'"
285 |   else
286 |     echo " * [INFO] $SERVERNAME was not running. Not resuming saves."
287 |   fi
288 | }
289 | 
290 | ## Checks for update, exits if update not required, updates if the server is not running
291 | 
292 | mc_updatecheck() {
293 |   echo " * Downloading latest $SERVERNAME executable..."
294 |   as_user "cd \"$MCPATH\" && curl -# -L -o \"$MCPATH/$SERVICE.update\" \"$SERVER_URL\""
295 | 
296 |   if [ -f "$MCPATH/$SERVICE.update" ]
297 |   then
298 |     echo " * Checking downloaded update against existing server..."
299 | 
300 |     if $(diff "$MCPATH/$SERVICE" "$MCPATH/$SERVICE.update" >/dev/null)
301 |     then
302 |       echo " * You are already running the latest version of $SERVERNAME!"
303 |       exit 0; # keep this exit in as we don't need to do anything
304 |     fi
305 | 
306 |   else
307 |     echo " * [ERROR] $SERVERNAME update could not be downloaded."
308 |     exit 1
309 |   fi
310 | 
311 |   if server_running
312 |   then
313 |     echo " * $SERVERNAME is running (pid $JAVAPID). Shutting down for update..."
314 |   else
315 |     as_user "/bin/cp \"$MCPATH/$SERVICE.update\" \"$MCPATH/$SERVICE\""
316 |     echo " * [OK] $SERVERNAME successfully updated."
317 |   fi
318 | }
319 | 
320 | ## Actually do the executable update
321 | 
322 | mc_updatedo() {
323 |   if server_running
324 |   then
325 |     echo " * [ERROR] $SERVICE is still running (pid $JAVAPID). Cannot update!"
326 |     exit 1
327 |   else
328 |     as_user "/bin/cp \"$MCPATH/$SERVICE.update\" \"$MCPATH/$SERVICE\""
329 |     echo " * [OK] $SERVERNAME successfully updated."
330 |   fi
331 | }
332 | 
333 | ## Check and see if a worldname was given to the backup command. Use the default world, or check the optional world exists and exit if it doesn't.
334 | 
335 | mc_checkbackup() {
336 |   if [ -n "$1" ]
337 |     then
338 |     WORLDNAME="$1"
339 |       if [ -d "$MCPATH/$WORLDNAME" ]
340 |         then
341 |         echo " * Found world named \"$MCPATH/$WORLDNAME\""
342 |       else
343 |         echo " * Could not find world named \"$MCPATH/$WORLDNAME\""
344 |         exit 1
345 |       fi
346 |   fi
347 | }
348 | 
349 | ## Backs up map by rsyncing current world to backup location, creates tar.gz with datestamp
350 | 
351 | mc_backupmap() {
352 |   echo " * Backing up $SERVERNAME map named \"$WORLDNAME\"..."
353 |   echo " * Syncing \"$MCPATH/$WORLDNAME\" to \"$BACKUPPATH/$WORLDNAME\""
354 |   as_user "rsync --checksum --group --human-readable --copy-links --owner --perms --recursive --times --update --delete \"$MCPATH/$WORLDNAME\" \"$BACKUPPATH\""
355 |   # if the nether exists, back it up
356 |   WORLDNETHER="$WORLDNAME""_nether"
357 |   if [ -d "$MCPATH/$WORLDNETHER" ]
358 |     then
359 |     echo " * Syncing \"$MCPATH/$WORLDNETHER\" to \"$BACKUPPATH/$WORLDNETHER\""
360 |   as_user "rsync --checksum --group --human-readable --copy-links --owner --perms --recursive --times --update --delete \"$MCPATH/$WORLDNETHER\" \"$BACKUPPATH\""
361 |   else
362 |     echo " * \"$MCPATH/$WORLDNETHER\" doesn't exist, skipping."
363 |   fi
364 |   # if the end exists, back it up
365 |   WORLDTHEEND="$WORLDNAME""_the_end"
366 |   if [ -d "$MCPATH/$WORLDTHEEND" ]
367 |     then
368 |     echo " * Syncing \"$MCPATH/$WORLDTHEEND\" to \"$BACKUPPATH/$WORLDTHEEND\""
369 |     as_user "rsync --checksum --group --human-readable --copy-links --owner --perms --recursive --times --update --delete \"$MCPATH/$WORLDTHEEND\" \"$BACKUPPATH\""
370 |   else
371 |     echo " * \"$MCPATH/$WORLDTHEEND\" doesn't exist, skipping."
372 |   fi
373 |   sleep 10
374 |   echo " * Creating compressed backup..."
375 |   NOW="$(date +%Y-%m-%d.%H-%M-%S)"
376 |   # Create a compressed backup file and background it so we can get back to restarting the server
377 |   # You can tell when the compression is done as it makes an md5sum file of the backup
378 |   as_user "cd "$BACKUPPATH" && tar cfz \""$WORLDNAME"_backup_"$NOW".tar.gz\" \"$WORLDNAME\" && md5sum \""$WORLDNAME"_backup_"$NOW".tar.gz\" > \""$WORLDNAME"_backup_"$NOW".tar.gz.md5\" &"
379 |   echo " * [OK] Backed up map \"$WORLDNAME\"."
380 |   # if we backed up the nether, create a backup of that too
381 |   if [ -d "$BACKUPPATH/$WORLDNETHER" ]
382 |     then
383 |     as_user "cd "$BACKUPPATH" && tar cfz \""$WORLDNETHER"_backup_"$NOW".tar.gz\" \"$WORLDNETHER\" && md5sum \""$WORLDNETHER"_backup_"$NOW".tar.gz\" > \""$WORLDNETHER"_backup_"$NOW".tar.gz.md5\" &"
384 |     echo " * [OK] Backed up map \"$WORLDNETHER\"."
385 |   fi
386 |   # if we backed up the end, create a backup of that too
387 |   if [ -d "$BACKUPPATH/$WORLDTHEEND" ]
388 |     then
389 |     as_user "cd "$BACKUPPATH" && tar cfz \""$WORLDTHEEND"_backup_"$NOW".tar.gz\" \"$WORLDTHEEND\" && md5sum \""$WORLDTHEEND"_backup_"$NOW".tar.gz\" > \""$WORLDTHEEND"_backup_"$NOW".tar.gz.md5\" &"
390 |     echo " * [OK] Backed up map \"$WORLDTHEEND\"."
391 |   fi
392 |   # we can safely background the above commands and get back to restarting the server
393 | }
394 | 
395 | ## Backs up executable by copying it to backup location
396 | 
397 | mc_backupexe() {
398 |   echo " * Backing up the $SERVERNAME server executable..."
399 |   NOW="$(date +%Y-%m-%d.%H-%M-%S)"
400 |   as_user "cp \""$MCPATH"/"$SERVICE"\" \""$BACKUPPATH"/"$SERVICE"_backup_"$NOW".jar\""
401 |   echo " * [OK] Backed up executable."
402 | }
403 | 
404 | ## Removes any backups older than $BACKUPS_TO_KEEP days, designed to be called by daily cron job
405 | 
406 | mc_removeoldbackups() {
407 |   echo " * Removing backups older than $BACKUPS_TO_KEEP days..."
408 |   as_user "cd \"$BACKUPPATH\" && find . -name \"*backup*\" -type f -mtime +$BACKUPS_TO_KEEP | xargs rm -fv"
409 |   echo " * Removed old backups."
410 | }
411 | 
412 | ## Rotates logfile to server.1 through server.7, designed to be called by daily cron job
413 | 
414 | mc_logrotate() {
415 |   # Define a function to copy the old logfile to the new
416 |   mc_copylog() {
417 |     as_user "/bin/cp $logfile $MCPATH/$LOGNEW"
418 |   }
419 | 
420 |   # Server logfiles in chronological order
421 |   LOGLIST="$(ls -r $MCPATH/server.log* | grep -v lck)"
422 |   # How many logs to keep
423 |   COUNT="6"
424 |   # Look at all the logfiles
425 |   for logfile in $LOGLIST; do
426 |     LOGTMP="$(basename $logfile | cut -d '.' -f 3)"
427 |     # If we're working with server.log then append .1
428 |     if [ -z "$LOGTMP" ]
429 |     then
430 |       LOGNEW="server.log.1"
431 |       mc_copylog
432 |     # Otherwise, check if the file number is under $COUNT
433 |     elif [ "$LOGTMP" -gt "$COUNT" ]
434 |     then
435 |       # If so, delete it
436 |       as_user "rm -f $logfile"
437 |     else
438 |       # Otherwise, add one to the number
439 |       LOGBASE="$(basename $logfile | cut -d '.' -f 1-2)"
440 |       LOGNEW="$LOGBASE.$(($LOGTMP+1))"
441 |       mc_copylog
442 |     fi
443 |   done
444 |   # Blank the existing logfile to renew it
445 |   as_user "echo -n \"\" > $MCPATH/server.log"
446 | }
447 | 
448 | ## Check if server is running and display PID
449 | 
450 | mc_status() {
451 |   if server_running
452 |   then
453 |     echo " * $SERVERNAME status: Running (pid $JAVAPID)."
454 |   else
455 |     echo " * $SERVERNAME status: Not running."
456 |     exit 1
457 |   fi
458 | }
459 | 
460 | ## Display some extra environment informaton
461 | 
462 | mc_info() {
463 |   if server_running
464 |   then
465 |     RSS="$(ps --pid $JAVAPID --format rss | grep -v RSS)"
466 |     echo " - Java Path          : $(readlink -f $(which java))"
467 |     echo " - Start Command      : $INVOCATION"
468 |     echo " - Server Path        : $MCPATH"
469 |     echo " - World Name         : $WORLDNAME"
470 |     echo " - Process ID         : $JAVAPID"
471 |     echo " - Screen Session     : $SCRNAME"
472 |     echo " - Memory Usage       : $((RSS/1024)) Mb ($RSS kb)"
473 |   # Check for HugePages support in kernel, display statistics if HugePages are available, otherwise skip
474 |   if [ -n "$(grep HugePages_Total /proc/meminfo | awk '{print $2}')" -a "$(grep HugePages_Total /proc/meminfo | awk '{print $2}')" ]
475 |   then
476 |     HP_SIZE="$(grep Hugepagesize /proc/meminfo | awk '{print $2}')"
477 |     HP_TOTAL="$(grep HugePages_Total /proc/meminfo | awk '{print $2}')"
478 |     HP_FREE="$(grep HugePages_Free /proc/meminfo | awk '{print $2}')"
479 |     HP_RSVD="$(grep HugePages_Rsvd /proc/meminfo | awk '{print $2}')"
480 |     HP_USED="$((HP_TOTAL-HP_FREE+HP_RSVD))"
481 |     TOTALMEM="$((RSS+(HP_USED*HP_SIZE)))"
482 |     echo " - HugePage Usage     : $((HP_USED*(HP_SIZE/1024))) Mb ($HP_USED HugePages)"
483 |     echo " - Total Memory Usage : $((TOTALMEM/1024)) Mb ($TOTALMEM kb)"
484 |   fi
485 |     echo " - Active Connections : "
486 |     netstat --inet -tna | grep -E "Proto|$SERVERPORT"
487 |   else
488 |     echo " * $SERVERNAME is not running. Unable to give info."
489 |     exit 1
490 |   fi
491 | }
492 |  
493 | ## Connect to the active Screen session, disconnect with Ctrl+a then d
494 | 
495 | mc_console() {
496 |   if server_running
497 |   then
498 |     as_user "screen -S $SCRNAME -dr"
499 |   else
500 |     echo " * [ERROR] $SERVERNAME was not running! Unable to console."
501 |     exit 1
502 |   fi
503 | }
504 | 
505 | ## Broadcasts a message
506 | 
507 | mc_say() {
508 |   say_string="${@:1}"
509 |   if [[ -z "$say_string" ]]
510 |   then
511 |     echo " * You need to enter your message. Usage; \"minecraft say message\""
512 |   elif server_running
513 |   then
514 |     echo " * Broadcasting \"$say_string\""
515 |     as_user "screen -p 0 -S $SCRNAME -X eval 'stuff \"say $say_string\"\015'"
516 |   else
517 |     echo " * [ERROR] $SERVERNAME was not running!"
518 |     exit 1
519 |   fi
520 | }
521 | 
522 | ## These are the parameters passed to the script
523 | 
524 | case "$1" in
525 |   start)
526 |  mc_start
527 |  ;;
528 |   stop)
529 |  mc_stop
530 |  ;;
531 |   restart)
532 |  mc_stop
533 |  sleep 1
534 |  mc_start
535 |  ;;
536 |   update)
537 |  mc_updatecheck
538 |  mc_stop
539 |  mc_backupmap
540 |  mc_backupexe
541 |  mc_updatedo
542 |  mc_start
543 |  ;;
544 |   backup)
545 |  mc_checkbackup "$2"
546 |  mc_saveoff
547 |  mc_backupmap
548 |  mc_backupexe
549 |  mc_saveon
550 |  ;;
551 |   status)
552 |  mc_status
553 |  ;;
554 |   info)
555 |  mc_info
556 |  ;;
557 |   console)
558 |  mc_console
559 |  ;;
560 | # These are intended for cron usage, not regular users.
561 |   removeoldbackups)
562 |  mc_removeoldbackups
563 |  ;;
564 |   logrotate)
565 |  mc_logrotate
566 |  ;;
567 |   save-off)
568 |  mc_saveoff
569 |  ;;
570 |   save-on)
571 |  mc_saveon
572 |  ;;
573 | # Debug usage only
574 |   justbackup) # don't use this while the server is running!!!
575 |  mc_checkbackup
576 |  mc_backupmap
577 |  mc_backupexe
578 |  ;;
579 |   say)
580 |  mc_say "${@:2}"
581 |  ;;
582 |   *)
583 |  echo " * Usage: minecraft {start|stop|restart|backup (worldname)|save-on|save-off|update|status|info|console|say}"
584 |  exit 1
585 |  ;;
586 | esac
587 | 
588 | exit 0
589 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------