Removed unused imports.

.classpath

@@ -1,12 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
 	<classpathentry kind="src" path="src"/>
-	<classpathentry kind="lib" path="/Users/tobi/Code/craftbukkit-1.4.5-R1.0.jar" sourcepath="/Users/tobi/Code/Bukkit">
-		<attributes>
-			<attribute name="source_encoding" value="UTF-8"/>
-		</attributes>
-	</classpathentry>
 	<classpathentry kind="lib" path="/Users/tobi/Code/Vault.jar"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="lib" path="/Users/tobi/Code/craftbukkit-1.5.1-R0.1.jar"/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>

changelog.md

@@ -1,4 +1,7 @@
-## 2.1.0 (not yet released)
+## 2.1.1
+* Made the list command more reliable.
+* Error messages will be displayed less frequent.
+## 2.1.0
 * Command outputs are now colored.
 * Fixed a bug where players in creative mode would not be teleported correctly.
 * Made various commands available via the server console.

plugin.yml

@@ -1,5 +1,5 @@
 name: Craft Inc. Gates
-version: 2.1.0
+version: 2.1.1
 description: A plugin to create gates for fast traveling.
 softdepend: [Vault]
 author: tomco, s1m0ne

src/de/craftinc/gates/commands/CommandList.java

@@ -15,6 +15,15 @@ import de.craftinc.gates.util.TextUtil;
 
 public class CommandList extends BaseCommand
 {
+	protected static final int linesPerPage = 10; 
+	protected static final int charactersPerLine = 52; /* this is actually no true. the 
+														  font used by minecraft is not
+														  monospace. but I don't think 
+														  there is a (easy) way for a 
+														  bukkit plugin to calculate 
+														  the drawing-size of a string. 
+														*/
+	
 	public CommandList() 
 	{
 		aliases.add("list");
@@ -32,42 +41,121 @@ public class CommandList extends BaseCommand
 	}
 	
 	
-	protected String intToTitleString(int i)
+	protected static List<String> linesOfGateIds(List<String> gates)
 	{
+		List<String> lines = new ArrayList<String>();
+		
+		int index = 0;
+		List<String> gateIdsForCurrentLine = new ArrayList<String>();
+		int numCharactersInCurrentLine = 0;
+		
+		
+		while (index < gates.size()) {
+			String gateId = gates.get(index);
+			int gateIdLength = gateId.length() + 2; // actual length + comma + whitespace
+			
+			// special case: very long gate id
+			if (gateIdLength > charactersPerLine && numCharactersInCurrentLine == 0) {
+				gateIdsForCurrentLine = new ArrayList<String>();
+				numCharactersInCurrentLine = 0;
+				
+				while ((gateId.length() + 2) > charactersPerLine) {
+					
+					int cutPos = charactersPerLine;
+					
+					// is the id too long to add comma and whitespace but not longer than the line?
+					if (gateId.length() <= charactersPerLine) {
+						cutPos -= 2;
+					}
+					
+					lines.add(gateId.substring(0, cutPos));
+					gateId = gateId.substring(cutPos, gateId.length());
+					
+				}
+
+				gateIdsForCurrentLine.add(gateId);
+				
+				numCharactersInCurrentLine += gateId.length();
+				index++;
+			}
+			
+			// gate fits into current line
+			else if ((numCharactersInCurrentLine + gateIdLength) <= charactersPerLine) {
+				gateIdsForCurrentLine.add(gateId);
+				numCharactersInCurrentLine += gateIdLength;
+				
+				index++;
+			}
+			
+			// the current gate does not fit on the
+			else {  
+				lines.add(TextUtil.implode(gateIdsForCurrentLine, ", ") + ", ");
+				
+				gateIdsForCurrentLine = new ArrayList<String>();
+				numCharactersInCurrentLine = 0;
+			}	
+		}
+		
+		lines.add(TextUtil.implode(gateIdsForCurrentLine, ", "));
+		return lines;
+	}
+	
+	
+	protected static String intToTitleString(int i, boolean addPreviousPageNote, boolean addNextPageNote)
+	{
+		String retVal = ChatColor.DARK_AQUA + "";
+		
 		if ( i < 26 ) {
-			return ChatColor.DARK_AQUA + "" + (char)(i+65) + ":";
+			retVal += (char)(i+65);
 		}
 		else if ( i == 26 ) {
-			return ChatColor.DARK_AQUA + "0 - 9:";
+			retVal += "0-9";
 		} 
 		else {
-			return ChatColor.DARK_AQUA + "!@#$:";
+			retVal += "!@#$";
 		}
+		
+		if (addPreviousPageNote && addNextPageNote) {
+			retVal += " (more on previous and next page)";
+		}
+		else if (addPreviousPageNote) {
+			retVal += " (more on previous page)";
+		}
+		else if (addNextPageNote) {
+			retVal += " (more on next page)";
+		}
+		
+		return retVal + "\n";
 	}
 	
 	
 	/**
-	 * Method for returning a collection of gates the player is allowed to see.
+	 * Method for getting a collection of gates the player is allowed to see.
 	 */
 	protected Collection<Gate> getAllGates()
 	{
 		Collection<Gate> gates = Gate.getAll();
 		
-		
+		if (this.sender instanceof Player && Plugin.permission != null) {
-		if (this.sender instanceof Player && Plugin.permission != null)
-		{
 			Player p = (Player)this.sender;
-			Collection<Gate> gatesCopy = new ArrayList<Gate>(gates); // create a copy since we cannot iterate over a collection while modifying it!
+			
+			// create a copy since we cannot iterate over a collection while modifying it!
+			Collection<Gate> gatesCopy = new ArrayList<Gate>(gates); 
 			
 			for (Gate gate : gatesCopy) {
 				
-				if (!Plugin.permission.has(gate.getLocation().getWorld(), p.getName(), this.requiredPermission)) 
+				boolean permissionAtGateLocation = Plugin.permission.has(gate.getLocation().getWorld(), p.getName(), this.requiredPermission);
-				{
+				if (!permissionAtGateLocation) {
+					gates.remove(gate);
+					continue;
+				}
+				
+				if (gate.getExit() != null) {
+					
+					boolean permissionAtGateExit = Plugin.permission.has(gate.getExit().getWorld(), p.getName(), this.requiredPermission);
+					if (!permissionAtGateExit) {
 						gates.remove(gate);
 					}
-				else if (gate.getExit() != null && !Plugin.permission.has(gate.getExit().getWorld(), p.getName(), this.requiredPermission)) 
-				{
-					gates.remove(gate);
 				}
 			}
 		}
@@ -76,30 +164,24 @@ public class CommandList extends BaseCommand
 	}
 	
 	
-	
+	/**
-	// pages start at 1
+	 * Sorts all gates by there first character.
-	// will return null if requested page not availible
+	 * Puts gates in corresponding Lists: (all returned lists will be sorted alphabetically)
-	protected List<String> message(int page)
+	 * 	list 0-25: a,b,c,..,z
-	{
-		Collection<Gate> gates = this.getAllGates();
-		
-		if (gates.size() == 0) {
-			return null;
-		}
-		
-		/* sort all gates by there first character
-		 * put gates in corresponding Lists
-		 * list 0-25: a,b,c, ... ,z
 	 * 	list 26: 0-9
 	 * 	list 27: other
 	 */
+	protected static List<List<String>> gatesSortedByName(Collection<Gate> allGates)
+	{
+		// create the lists
 		List<List<String>> ids = new ArrayList<List<String>>();
 		
 		for (int i=0; i<28; i++) {
 			ids.add(new ArrayList<String>());
 		}
 		
-		for (Gate gate : gates) {
+		// put all gates into correct lists
+		for (Gate gate : allGates) {
 			String id = gate.getId();
 			int first = id.charAt(0);
 			
@@ -119,92 +201,103 @@ public class CommandList extends BaseCommand
 			ids.get(first).add(id);
 		}
 		
+		// sort everything
+		for (int i=0; i<28; i++) {
+			Collections.sort(ids.get(i));
+		}
 		
-		/* calculating which gates will be displayed on which page.
+		return ids;
-		 * this is a little bit fuzzy. but hopefully it will look
+	}
-		 * great. (tell me if there is a better way!)
+	
+	
+	/**
+	 * Returns a list of strings.
+	 * Each string is the text for a page.
+	 * The maximum number of lines per page is 'linesPerPage' minus 1.
+	 * Will return an empty list if no gates are availible.
 	 */
-		
+	protected List<String> pagedGateIds()
-		int currentPage = 1;
-		int currentStartingCharList = 0;
-		boolean finishedCurrentIds = true;
-		
-		List<String> pageMessages = new ArrayList<String>();
-		
-		while (currentStartingCharList < ids.size()) {
-			int linesLeftOnCurrentPage = 9;
-			
-			while (linesLeftOnCurrentPage > 1 && currentStartingCharList < ids.size()) {
-				List<String> currentIds = ids.get(currentStartingCharList);
-				
-				if (currentIds.size() > 0) {
-					// add header line
-					if (currentPage == page) {
-						pageMessages.add(intToTitleString(currentStartingCharList));
-					}
-					
-					//sort
-					Collections.sort(currentIds);
-				
-					// add ids
-					int numLinesForCurrentChar = TextUtil.implode(currentIds, ", ").length() / 52 + 2;
-					
-					if (numLinesForCurrentChar <= linesLeftOnCurrentPage) { // all ids fit on current page
-						linesLeftOnCurrentPage -= numLinesForCurrentChar;
-						
-						if (currentPage == page) {
-							pageMessages.add(ChatColor.AQUA + TextUtil.implode(currentIds, ", "));
-							if (finishedCurrentIds == false) {
-								pageMessages.set(pageMessages.size() -2, pageMessages.get(pageMessages.size() -2) + " (more on previous page)");
-							}
-						}
-						
-						finishedCurrentIds = true;
-					}
-					else { // NOT all ids fit on current page
-						int charsAvailible = (linesLeftOnCurrentPage - 1) * 52;
-						int idsPos = 0;
-						
-						do {
-							charsAvailible -= currentIds.get(idsPos).length() + 2;				
-							idsPos++;
-						} while (charsAvailible > 0);
-						
-						List<String> idsToPutOnCurrentPage = currentIds.subList(0, idsPos);
-						currentIds.remove(idsToPutOnCurrentPage);
-						
-						String stringToPutOnCurrentPage = TextUtil.implode(idsToPutOnCurrentPage, ", ");
-						
-						if (currentPage == page) {
-							pageMessages.add(ChatColor.AQUA + stringToPutOnCurrentPage);
-							pageMessages.set(pageMessages.size() -2, pageMessages.get(pageMessages.size() -2) + " (more on next page)");
-						}
-						
-						linesLeftOnCurrentPage -= stringToPutOnCurrentPage.length() / 52 + 2;
-						
-						finishedCurrentIds = false;
-					}
-				}
-				
-				if (finishedCurrentIds) {
-					currentStartingCharList++;
-				}
-			}
-			
-			currentPage++;
-		}
-		
-		if (pageMessages.isEmpty()) 
 	{
+		Collection<Gate> gates = this.getAllGates();
+		
+		if (gates.size() == 0) {
 			return null;
 		}
-		else {
-			ArrayList<String> retVal = new ArrayList<String>();
-			retVal.add(TextUtil.titleize("List of all gates (" + page + "/" + --currentPage + ")"));
-			retVal.addAll(pageMessages);
 		
-			return retVal;
+		List<List<String>> gatesSortedByName = gatesSortedByName(gates);
+		List<String> allPages = new ArrayList<String>();
+		int linesLeftOnPage = linesPerPage - 1;
+		String currentPageString = "";
+		
+		for (int i=0; i<gatesSortedByName.size(); i++) {
+			
+			List<String> currentGates = gatesSortedByName.get(i);
+			
+			if(currentGates.isEmpty()) {
+				continue;
 			}
+			
+			List<String> currentGatesAsLines = linesOfGateIds(currentGates);
+			boolean moreGatesOnLastPage = false;
+			
+			while (!currentGatesAsLines.isEmpty()) {
+				
+				if (linesLeftOnPage < 2) {
+					currentPageString = currentPageString.substring(0, currentPageString.length()-2); // remove newlines add the end of the page
+					allPages.add(currentPageString);
+					currentPageString = "";
+					
+					linesLeftOnPage = linesPerPage - 1;
+				}
+				
+				// calculate number of lines to add to current page
+				int linesNecessaryForCurrentGates = currentGatesAsLines.size();
+				int linesToFill;
+				boolean moreGatesOnNextPage;
+					
+				if (linesNecessaryForCurrentGates < linesLeftOnPage) {
+					linesToFill = linesNecessaryForCurrentGates;
+					moreGatesOnNextPage = false;
+				}
+				else {
+					linesToFill = linesLeftOnPage -1;
+					moreGatesOnNextPage = true;
+				}
+				
+				// add title
+				currentPageString += intToTitleString(i, moreGatesOnLastPage, moreGatesOnNextPage);
+				currentPageString +=  ChatColor.AQUA;
+				linesLeftOnPage--;
+				
+				// add gate lines
+				for (int j=0; j<linesToFill; j++) {
+					currentPageString += currentGatesAsLines.get(j) + "\n";
+				}
+				
+				// remove lines added
+				for (int j=0; j<linesToFill; j++) {
+					currentGatesAsLines.remove(0);
+				}
+				
+				// cleanup
+				if (linesNecessaryForCurrentGates < linesLeftOnPage) {
+					moreGatesOnLastPage = false;
+				}
+				else {
+					moreGatesOnLastPage = true;
+				}
+				
+				linesLeftOnPage -= linesToFill;
+			}
+		}
+		
+		// add the last page
+		if (!currentPageString.isEmpty()) {
+			currentPageString = currentPageString.substring(0, currentPageString.length()-2); // remove newlines add the end of the page
+			allPages.add(currentPageString);
+		}
+		
+		return allPages;
 	}
 	
 	
@@ -224,26 +317,23 @@ public class CommandList extends BaseCommand
 	public void perform() 
 	{
 		int page = this.getPageParameter();
+		List<String> allPages = this.pagedGateIds();
 
-		List<String> messages = message(page);
+		if (allPages == null) {	// no gates exist
-		
-		if (messages == null) 
-		{	
-			if (page == 1) // no gates exist
-			{
 			sendMessage(ChatColor.RED + "There are no gates yet. " + ChatColor.RESET + 
 					    "(Note that you might not be allowed to get information about certain gates)");
-			}
+			return;
-			else // the requested page does not exist
-			{
-				sendMessage(ChatColor.RED + "The requested page is not availible");
 		}
 			
+		if (page > allPages.size() || page < 1) {
+			sendMessage(ChatColor.RED + "The requested page is not availible");
+			return;
 		}
-		else 
+		
-		{
+		String message = TextUtil.titleize("List of all gates (" + page + "/" + allPages.size() + ")") + "\n";
-			sendMessage(messages);
+		message += allPages.get(page-1);
-		}
+
+		sendMessage(message);
 	}
 }
 

src/de/craftinc/gates/listeners/PluginPlayerListener.java

@@ -1,5 +1,7 @@
 package de.craftinc.gates.listeners;
 
+import java.util.Calendar;
+import java.util.HashMap;
 import java.util.logging.Level;
 
 import org.bukkit.ChatColor;
@@ -20,6 +22,8 @@ import de.craftinc.gates.util.GateUtil;
 
 public class PluginPlayerListener implements Listener 
 {
+	protected HashMap<String, Long> lastBorderMessage = new HashMap<String, Long>();
+	
 	@EventHandler(priority = EventPriority.NORMAL)
 	public void onPlayerMove(PlayerMoveEvent event) 
 	{
@@ -38,7 +42,22 @@ public class PluginPlayerListener implements Listener
 		
 		// Check for permission
 		if (!hasPermission(event.getPlayer(), gateAtLocation)) {
-			event.getPlayer().sendMessage(ChatColor.RED + "Sorry, you are not allowed to use this gate!");
+			
+			String playerName = event.getPlayer().getName();
+			
+			if (playerName == null) {
+				return;
+			}
+	        
+	        // get the current time
+	        Long now = Calendar.getInstance().getTimeInMillis();
+			
+			// do not display messages more often than once per second
+			if (!this.lastBorderMessage.containsKey(playerName) || this.lastBorderMessage.get(playerName) < now - 10000L) {
+				event.getPlayer().sendMessage(ChatColor.RED + "You are not allowed to use this gate!");
+				this.lastBorderMessage.put(playerName, now);
+			}
+			
 			return;
 		}
 		
@@ -80,7 +99,7 @@ public class PluginPlayerListener implements Listener
 	
 	protected boolean hasPermission(Player player, Gate gate) 
 	{
-		if (Plugin.permission == null) // fallback <20> use the standard bukkit permission system
+		if (Plugin.permission == null) // fallback: use the standard bukkit permission system
 		{
 			return player.hasPermission(Plugin.permissionUse);
 		}