2010-10-20 23:15:20 +00:00
|
|
|
/*
|
2014-04-04 22:03:18 +00:00
|
|
|
* WorldEdit, a Minecraft world manipulation toolkit
|
|
|
|
* Copyright (C) sk89q <http://www.sk89q.com>
|
|
|
|
* Copyright (C) WorldEdit team and contributors
|
2010-10-20 23:15:20 +00:00
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU Lesser General Public License as published by the
|
|
|
|
* Free Software Foundation, either version 3 of the License, or
|
2010-10-20 23:15:20 +00:00
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* 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 Lesser General Public License
|
|
|
|
* for more details.
|
2010-10-20 23:15:20 +00:00
|
|
|
*
|
2014-04-04 22:03:18 +00:00
|
|
|
* You should have received a copy of the GNU Lesser General Public License
|
2010-10-20 23:15:20 +00:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2011-08-05 10:29:49 +00:00
|
|
|
*/
|
2014-04-04 22:03:18 +00:00
|
|
|
|
|
|
|
// $Id$
|
|
|
|
|
2014-04-03 02:08:50 +00:00
|
|
|
package com.sk89q.worldedit.world.snapshot;
|
2010-10-20 23:15:20 +00:00
|
|
|
|
2014-07-29 18:04:04 +00:00
|
|
|
import com.sk89q.worldedit.world.storage.MissingWorldException;
|
|
|
|
|
|
|
|
import javax.annotation.Nullable;
|
2011-12-25 23:36:23 +00:00
|
|
|
import java.io.File;
|
|
|
|
import java.io.FilenameFilter;
|
2011-03-14 03:23:55 +00:00
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.Calendar;
|
2010-10-20 23:15:20 +00:00
|
|
|
import java.util.Collections;
|
2011-03-14 03:23:55 +00:00
|
|
|
import java.util.List;
|
2010-10-20 23:15:20 +00:00
|
|
|
|
|
|
|
/**
|
2014-07-29 18:04:04 +00:00
|
|
|
* A repository contains zero or more snapshots.
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
|
|
|
public class SnapshotRepository {
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
protected File dir;
|
2011-08-05 10:29:49 +00:00
|
|
|
protected List<SnapshotDateParser> dateParsers = new ArrayList<SnapshotDateParser>();
|
2010-10-20 23:15:20 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new instance of a repository.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param dir the directory
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
|
|
|
public SnapshotRepository(File dir) {
|
|
|
|
this.dir = dir;
|
2014-07-29 18:04:04 +00:00
|
|
|
|
|
|
|
// If folder doesn't exist, make it
|
2011-08-05 10:29:49 +00:00
|
|
|
dir.mkdirs();
|
2011-03-14 03:23:55 +00:00
|
|
|
|
|
|
|
dateParsers.add(new YYMMDDHHIISSParser());
|
|
|
|
dateParsers.add(new ModificationTimerParser());
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new instance of a repository.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param dir the directory
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
|
|
|
public SnapshotRepository(String dir) {
|
2011-03-14 03:23:55 +00:00
|
|
|
this(new File(dir));
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a list of snapshots in a directory. The newest snapshot is
|
|
|
|
* near the top of the array.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param newestFirst true to get the newest first
|
|
|
|
* @return a list of snapshots
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
2014-07-29 18:04:04 +00:00
|
|
|
public List<Snapshot> getSnapshots(boolean newestFirst, String worldName) throws MissingWorldException {
|
2010-10-20 23:15:20 +00:00
|
|
|
FilenameFilter filter = new FilenameFilter() {
|
2013-02-24 06:53:14 +00:00
|
|
|
@Override
|
2010-10-20 23:15:20 +00:00
|
|
|
public boolean accept(File dir, String name) {
|
|
|
|
File f = new File(dir, name);
|
2010-11-06 05:50:22 +00:00
|
|
|
return isValidSnapshot(f);
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2011-08-05 10:29:49 +00:00
|
|
|
File[] snapshotFiles = dir.listFiles();
|
2013-02-24 06:53:14 +00:00
|
|
|
if (snapshotFiles == null) {
|
2014-07-29 18:04:04 +00:00
|
|
|
throw new MissingWorldException(worldName);
|
2013-02-24 06:53:14 +00:00
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
List<Snapshot> list = new ArrayList<Snapshot>(snapshotFiles.length);
|
|
|
|
|
|
|
|
for (File file : snapshotFiles) {
|
|
|
|
if (isValidSnapshot(file)) {
|
|
|
|
Snapshot snapshot = new Snapshot(this, file.getName());
|
2014-07-29 18:04:04 +00:00
|
|
|
if (snapshot.containsWorld(worldName)) {
|
2011-08-05 10:29:49 +00:00
|
|
|
detectDate(snapshot);
|
|
|
|
list.add(snapshot);
|
|
|
|
}
|
2014-07-29 18:04:04 +00:00
|
|
|
} else if (file.isDirectory() && file.getName().equalsIgnoreCase(worldName)) {
|
2011-08-05 10:29:49 +00:00
|
|
|
for (String name : file.list(filter)) {
|
|
|
|
Snapshot snapshot = new Snapshot(this, file.getName() + "/" + name);
|
|
|
|
detectDate(snapshot);
|
|
|
|
list.add(snapshot);
|
|
|
|
}
|
|
|
|
}
|
2011-03-14 03:23:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (newestFirst) {
|
|
|
|
Collections.sort(list, Collections.reverseOrder());
|
|
|
|
} else {
|
|
|
|
Collections.sort(list);
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
return list;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
/**
|
|
|
|
* Get the first snapshot after a date.
|
2011-09-24 19:32:03 +00:00
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param date a date
|
|
|
|
* @return a snapshot or null
|
2011-03-14 03:23:55 +00:00
|
|
|
*/
|
2014-07-29 18:04:04 +00:00
|
|
|
@Nullable
|
2011-08-05 10:29:49 +00:00
|
|
|
public Snapshot getSnapshotAfter(Calendar date, String world) throws MissingWorldException {
|
|
|
|
List<Snapshot> snapshots = getSnapshots(true, world);
|
2011-03-14 03:23:55 +00:00
|
|
|
Snapshot last = null;
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
for (Snapshot snapshot : snapshots) {
|
2014-07-29 18:04:04 +00:00
|
|
|
if (snapshot.getDate() != null && snapshot.getDate().before(date)) {
|
2011-03-14 03:23:55 +00:00
|
|
|
return last;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
last = snapshot;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
return last;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
/**
|
|
|
|
* Get the first snapshot before a date.
|
2011-09-24 19:32:03 +00:00
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param date a date
|
|
|
|
* @return a snapshot or null
|
2011-03-14 03:23:55 +00:00
|
|
|
*/
|
2014-07-29 18:04:04 +00:00
|
|
|
@Nullable
|
2011-08-05 10:29:49 +00:00
|
|
|
public Snapshot getSnapshotBefore(Calendar date, String world) throws MissingWorldException {
|
|
|
|
List<Snapshot> snapshots = getSnapshots(false, world);
|
2011-03-14 03:23:55 +00:00
|
|
|
Snapshot last = null;
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
for (Snapshot snapshot : snapshots) {
|
|
|
|
if (snapshot.getDate().after(date)) {
|
|
|
|
return last;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
last = snapshot;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
return last;
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
/**
|
|
|
|
* Attempt to detect a snapshot's date and assign it.
|
2011-09-24 19:32:03 +00:00
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param snapshot the snapshot
|
2011-03-14 03:23:55 +00:00
|
|
|
*/
|
|
|
|
protected void detectDate(Snapshot snapshot) {
|
|
|
|
for (SnapshotDateParser parser : dateParsers) {
|
|
|
|
Calendar date = parser.detectDate(snapshot.getFile());
|
|
|
|
if (date != null) {
|
|
|
|
snapshot.setDate(date);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2011-08-05 10:29:49 +00:00
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
snapshot.setDate(null);
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the default snapshot.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param world the world name
|
|
|
|
* @return a snapshot or null
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
2014-07-29 18:04:04 +00:00
|
|
|
@Nullable
|
2011-08-05 10:29:49 +00:00
|
|
|
public Snapshot getDefaultSnapshot(String world) throws MissingWorldException {
|
|
|
|
List<Snapshot> snapshots = getSnapshots(true, world);
|
2010-10-20 23:15:20 +00:00
|
|
|
|
2014-07-29 18:04:04 +00:00
|
|
|
if (snapshots.isEmpty()) {
|
2010-10-20 23:15:20 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2011-03-14 03:23:55 +00:00
|
|
|
return snapshots.get(0);
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check to see if a snapshot is valid.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param snapshot a snapshot name
|
2010-10-20 23:15:20 +00:00
|
|
|
* @return whether it is a valid snapshot
|
|
|
|
*/
|
|
|
|
public boolean isValidSnapshotName(String snapshot) {
|
2010-11-06 05:50:22 +00:00
|
|
|
return isValidSnapshot(new File(dir, snapshot));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check to see if a snapshot is valid.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param file the file to the snapshot
|
2010-11-06 05:50:22 +00:00
|
|
|
* @return whether it is a valid snapshot
|
|
|
|
*/
|
2014-07-29 18:04:04 +00:00
|
|
|
protected boolean isValidSnapshot(File file) {
|
|
|
|
if (!file.getName().matches("^[A-Za-z0-9_\\- \\./\\\\'\\$@~!%\\^\\*\\(\\)\\[\\]\\+\\{\\},\\?]+$")) {
|
2010-10-20 23:15:20 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2014-07-29 18:04:04 +00:00
|
|
|
return (file.isDirectory() && (new File(file, "level.dat")).exists())
|
|
|
|
|| (file.isFile() && (file.getName().toLowerCase().endsWith(".zip")
|
|
|
|
|| file.getName().toLowerCase().endsWith(".tar.bz2")
|
|
|
|
|| file.getName().toLowerCase().endsWith(".tar.gz")
|
|
|
|
|| file.getName().toLowerCase().endsWith(".tar")));
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a snapshot.
|
2011-09-24 19:32:03 +00:00
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @param name the name of the snapshot
|
|
|
|
* @return a snapshot
|
|
|
|
* @throws InvalidSnapshotException if the snapshot is invalid
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
|
|
|
public Snapshot getSnapshot(String name) throws InvalidSnapshotException {
|
|
|
|
if (!isValidSnapshotName(name)) {
|
|
|
|
throw new InvalidSnapshotException();
|
|
|
|
}
|
|
|
|
|
|
|
|
return new Snapshot(this, name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the snapshot directory.
|
|
|
|
*
|
2014-07-29 18:04:04 +00:00
|
|
|
* @return a path
|
2010-10-20 23:15:20 +00:00
|
|
|
*/
|
|
|
|
public File getDirectory() {
|
|
|
|
return dir;
|
|
|
|
}
|
2014-07-29 18:04:04 +00:00
|
|
|
|
2010-10-20 23:15:20 +00:00
|
|
|
}
|