Merge pull request #47 from Choco31415/development

Fixes README, #45, #46.

Author: Choco31415

README.md

@@ -10,8 +10,7 @@ To set up JavaMediawikiBot for an IDE, run `./gradlew eclipse` or `./gradlew ide
 
 ### Making a Wiki Family
 
-A wiki family is a group of wikis that a bot can see and edit. It also
-contains information pertinent to the wikis.
+A wiki family is a group of wikis that a bot knows about, and hence can edit. It also stores wiki specific information.
 
 To make a new wiki family, simply run `src/WikiBot/MediawikiData/FamilyGenerator.java`.
 This can be done via your IDE (console required), or through the command line:
@@ -33,22 +32,29 @@ these two classes:
 
 When extending a class, the constructor must include either:
 
-`
-super(String family, String homeWikiLanguage)
-super(File family, String homeWikiLanguage)
-`
+`super(String family, String homeWikiLanguage)`
 
-`family` specifies a wiki family file. A bot may then access the wikis in the family file. A String `family` refers to a default included wiki family, and must be "Scratch", "DwarfFortress", or "Wikipedia". A File `family` simply must point to a wiki family file.
+`super(File family, String homeWikiLanguage)`
+
+`family` specifies a wiki family file. A bot may then access the wikis in the family file. A String `family` refers to a default included wiki family, and must be "Scratch", "DwarfFortress", or "Wikipedia". A File `family` must point to a local wiki family file.
 
 `homeWikiLanguage` specifies the default wiki of a bot.
 
 ### Coding the bot.
 
-Half of the API commands are recommended used raw, half are not. This can be checked in the command's class documentation.
+JavaMediawikiBot offers two ways to accomplish what you want.
+
+GenericBot methods are abstractions of the Mediawiki API, and are mostly for querying data.
+
+APIcommand classes are also abstractions to the Mediawiki API, and are meant to be used as
+Objects. For example:
 
-If a command is recommended used raw, then simply run `APIcommand(APIcommand command)`.
+```
+APIcommand command = new AppendText(loc, "\n[[de:Scratch Katze]]", "This page needs an interwiki. ^.^ ");
+proposeEdit(command);
+```
 
-If a command is not recommended user raw, then use GenericBot methods.
+Half of the API commands are recommended used raw, half are not. This can be checked in the command's class documentation. If not recommended used raw, use GenericBot methods instead.
 
 ### Tips
 
@@ -77,18 +83,4 @@ Useful bot methods and bot settings may be found in various places.
 
 `src/WikiBot/core/NetworkingBase.java`
 
-* For logger methods.
-
-JavaMediawikiBot uses several classes to store data. A few classes that store general information include:
-
-`src/WikiBot/ContentRep/Revision.java`
-
-* This class stores information on page revisions.
-
-`src/WikiBot/ContentRep/ImageInfo.java`
-
-* This class stores information on images. This might or might not include: direct url, dimension, size, ect...
-
-`src/WikiBot/ContentRep/PageLocation.java`
-
-* This class stores information on how to find a page. Spefically, it contains the page title and wiki.
+* For logging + networking methods.

src/main/java/WikiBot/Core/GenericBot.java

@@ -164,7 +164,7 @@ public SimplePage getWikiSimplePage(PageLocation loc) {
 	public boolean doesPageExist(PageLocation loc) {
 		JsonNode serverOutput = getWikiPageJsonCode(loc);
 
-		return !serverOutput.has("missing");
+		return serverOutput.findValue("missing") == null; // If contains missing tag, the page is missing.
 	}
 
 	private JsonNode getWikiPageJsonCode(PageLocation loc) {		
@@ -1696,7 +1696,7 @@ private String APIcommandPOST(APIcommand command) {
 		//Send the command!
         response = getPOST(baseURL + "/api.php?", keys, values);
         try {
-			String serverOutput = EntityUtils.toString(response);
+			String serverOutput = removeBOM(EntityUtils.toString(response));
 
 			return serverOutput;
 		} catch (org.apache.http.ParseException | IOException e) {
@@ -1726,7 +1726,7 @@ private String APIcommandHttpEntity(APIcommand command) {
 		HttpEntity response = getPOST(url, entity);
 
 		try {
-			String serverOutput = EntityUtils.toString(response);
+			String serverOutput = removeBOM(EntityUtils.toString(response));
 
 			return serverOutput;
 		} catch (org.apache.http.ParseException | IOException e) {
@@ -1786,7 +1786,7 @@ protected String getToken(APIcommand command) {
 
 		String token = "";
 		try {
-			String serverOutput = EntityUtils.toString(entity);
+			String serverOutput = removeBOM(EntityUtils.toString(entity));
 
 			logFinest("Received token response: " + serverOutput);
 

src/main/java/WikiBot/Core/NetworkingBase.java

@@ -20,6 +20,7 @@
 
 import javax.net.ssl.SSLHandshakeException;
 
+import org.apache.http.Header;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpResponse;
 import org.apache.http.NameValuePair;
@@ -61,6 +62,9 @@ public class NetworkingBase extends javax.swing.JPanel {
     private HttpClient httpclient;
 	private HttpClientContext context;
 
+	//Special characters.
+	private static final String UTF8_BOM = "\uFEFF";
+	
 	//Instantiation.
 	public NetworkingBase() {
 		httpclient = HttpClientBuilder.create().build();
@@ -208,6 +212,7 @@ protected String[] getURL(String ur, boolean unescapeHTML4) throws IOException {
         	if (unescapeHTML4) {
         		inputLine = StringEscapeUtils.unescapeHtml4(StringEscapeUtils.unescapeHtml4(inputLine));
         	}
+        	inputLine = removeBOM(inputLine);
 
             page.add(inputLine);
         }
@@ -313,6 +318,16 @@ public String URLdecode(String url) {
 		}
 	}
 
+	public String removeBOM(String text) {
+		String toReturn = text;
+		
+		if (text.startsWith(UTF8_BOM)) {
+			toReturn = toReturn.substring(1);
+		}
+		
+		return toReturn;
+	}
+	
 	/**
 	 * Log these cookies using the log() method.
 	 * @param cookies