Merge pull request #20 from Choco31415/Development

Development

Author: Choco31415

build.gradle

@@ -24,6 +24,8 @@ repositories {
 }
 
 dependencies {
+	compile 'com.fasterxml.jackson.core:jackson-core:2.8.0'
+	compile 'com.fasterxml.jackson.core:jackson-databind:2.8.0'
     compile 'org.apache.commons:commons-lang3:3.4'
     compile 'commons-logging:commons-logging:1.2'
     compile 'org.apache.httpcomponents:httpclient:4.5.2'

src/main/java/WikiBot/APIcommands/APIcommand.java

@@ -7,13 +7,18 @@
 import WikiBot.Errors.UnsupportedError;
 import WikiBot.MediawikiData.MediawikiDataManager;
 import WikiBot.MediawikiData.VersionNumber;
+import WikiBot.Utils.ArrayUtils;
 
-//TODO: Update edit token and family files
+/**
+ * This class is a base for making APIcommands.
+ * 
+ * APIcommands are commands to a wiki's API.
+ */
 public class APIcommand extends PageLocationContainer {
 
-	protected String commandSummary;//One or two words to summarize what this edit does.
+	protected String commandName;//One or two words to summarize what this edit does.
 
-	protected boolean requiresGET = false;
+	protected boolean requiresPOST = false;
 	protected boolean unescapeText = false;
 	protected boolean unescapeHTML = true;
 
@@ -23,78 +28,41 @@ public class APIcommand extends PageLocationContainer {
 	protected ArrayList<String> keys = new ArrayList<String>();
 	protected ArrayList<String> values = new ArrayList<String>();
 
-
-	public APIcommand(String commandSummary_, PageLocation pl_, ArrayList<String> keys_, ArrayList<String> values_, boolean requiresGET_, String oldTokenType_, String newTokenType_) {
+	public APIcommand(String commandName_, PageLocation pl_, boolean requiresPOST_, String oldTokenType_, String newTokenType_) {
 		super(pl_);
-		commandSummary = commandSummary_;
-		keys.addAll(keys_);
-		values.addAll(values_);
-		requiresGET = requiresGET_;
+		commandName = commandName_;
+		requiresPOST = requiresPOST_;
 		oldTokenType = oldTokenType_;
 		newTokenType = newTokenType_;
 	}
 
-	
-	public APIcommand(String commandSummary_, PageLocation pl_, ArrayList<String> keys_, ArrayList<String> values_) {
+	public APIcommand(String commandName_, PageLocation pl_) {
 		super(pl_);
-		commandSummary = commandSummary_;
-		keys.addAll(keys_);
-		values.addAll(values_);
+		commandName = commandName_;
 	}
 
-	public APIcommand(String commandSummary_, PageLocation pl_, boolean requiresGET_, String oldTokenType_, String newTokenType_) {
-		super(pl_);
-		commandSummary = commandSummary_;
-		requiresGET = requiresGET_;
-		oldTokenType = oldTokenType_;
-		newTokenType = newTokenType_;
-	}
-	
-	public APIcommand(String commandSummary_, PageLocation pl_) {
-		super(pl_);
-		commandSummary = commandSummary_;
-	}	
-	
-	public APIcommand(String commandSummary_, String language, ArrayList<String> keys_, ArrayList<String> values_, boolean requiresGET_, String oldTokenType_, String newTokenType_) {
+	public APIcommand(String commandName_, String language, boolean requiresPOST_, String oldTokenType_, String newTokenType_) {
 		super(new PageLocation("null", language));
-		commandSummary = commandSummary_;
-		keys.addAll(keys_);
-		values.addAll(values_);
-		requiresGET = requiresGET_;
+		commandName = commandName_;
+		requiresPOST = requiresPOST_;
 		oldTokenType = oldTokenType_;
 		newTokenType = newTokenType_;
 	}
 
-	
-	public APIcommand(String commandSummary_, String language, ArrayList<String> keys_, ArrayList<String> values_) {
-		super(new PageLocation("null", language));
-		commandSummary = commandSummary_;
-		keys.addAll(keys_);
-		values.addAll(values_);
-	}
-	
-	public APIcommand(String commandSummary_, String language, boolean requiresGET_, String oldTokenType_, String newTokenType_) {
+	public APIcommand(String commandName_, String language) {
 		super(new PageLocation("null", language));
-		commandSummary = commandSummary_;
-		requiresGET = requiresGET_;
-		oldTokenType = oldTokenType_;
-		newTokenType = newTokenType_;
+		commandName = commandName_;
 	}
 
-	public APIcommand(String commandSummary_, String language) {
-		super(new PageLocation("null", language));
-		commandSummary = commandSummary_;
-	}
-	
-	protected void enforceMWVersion(VersionNumber introduced) {
+	protected void enforceMWVersion(String introduced) {
 		enforceMWVersion(introduced, null);
 	}
 
-	protected void enforceMWVersion(VersionNumber introduced, VersionNumber removed) {
+	protected void enforceMWVersion(String introduced, String removed) {
 		VersionNumber myVersion = getMWVersion();
 
 		if ((myVersion.compareTo(introduced) < 0 || introduced == null) && (myVersion.compareTo(removed) > 0 || removed == null)) {
-			throw new UnsupportedError("The " + getLanguage() + " wiki does not support this API command.");
+			throw new UnsupportedError("The " + getLanguage() + " wiki does not support this API command. (command name: " + commandName + ")");
 		}
 	}
 
@@ -117,6 +85,16 @@ public void addParameter(String key, String value) {
 		values.add(value);
 	}
 
+	public boolean setParameter(String key, String value) {
+		if (keys.contains(key)) {
+			values.set(keys.indexOf(key), value);
+			return true;
+		} else {
+			addParameter(key, value);
+			return false;
+		}
+	}
+	
 	public boolean removeParameter(String key) {
 		if (keys.contains(key)) {
 			values.remove(keys.indexOf(key));
@@ -163,16 +141,16 @@ public String getValue(String key) {
 		return values.get(keys.indexOf(key));
 	}
 
-	public void setRequiresGET(boolean bool) { requiresGET = bool; }
-	public boolean requiresGET() { return requiresGET; }
+	public void setRequiresPOST(boolean bool) { requiresPOST = bool; }
+	public boolean requiresPOST() { return requiresPOST; }
 	public void setUnescapeText(boolean bool) { unescapeText = bool; }
 	public boolean shouldUnescapeText() { return unescapeText; }
 	public void setUnescapeHTML(boolean bool) { unescapeHTML = bool; }
 	public boolean shouldUnescapeHTML() { return unescapeHTML; }
 
 	//A simple one or two words to summarize what this edit does.
-	public String getShortCommandSummary() {
-		return commandSummary;
+	public String getCommandName() {
+		return commandName;
 	}
 
 	public String getSummary() {
@@ -190,6 +168,25 @@ public String getSummary() {
 		}
 		return temp;
 	}
+	
+	protected String compactPLArray(ArrayList<PageLocation> array, String delimitor) {
+		//This takes an array of strings and compacts it into one string.
+		String output = "";
+		
+		for (int i = 0; i < array.size(); i++) {
+			output += array.get(i).getTitle();
+			if (i != array.size()-1) {
+				output += delimitor;
+			}
+		}
+		
+		return output;
+	}
+	
+	protected String compactArray(ArrayList<String> array, String delimitor) {
+		//This takes an array of strings and compacts it into one string.
+		return ArrayUtils.compactArray(array, delimitor);
+	}
 
 	@Override
 	public boolean equals(Object obj) {

src/main/java/WikiBot/APIcommands/AppendText.java

@@ -2,6 +2,15 @@
 
 import WikiBot.ContentRep.PageLocation;
 
+/**
+ * This command appends text to a page.
+ * 
+ * Rights required:
+ * edit
+ * 
+ * MW version required:
+ * 1.13+
+ */
 public class AppendText extends APIcommand {
 	public AppendText(PageLocation pl_, String appendText_, String editSummary_) {
 		super("Append text", pl_, true, "edit", "csrf");
@@ -15,5 +24,7 @@ public AppendText(PageLocation pl_, String appendText_, String editSummary_) {
 		values.add(editSummary_);
 		keys.add("bot");
 		values.add("true");
+		
+		enforceMWVersion("1.13");
 	}
 }

src/main/java/WikiBot/APIcommands/DeletePage.java

@@ -3,7 +3,13 @@
 import WikiBot.ContentRep.PageLocation;
 
 /**
- * This action requires the "delete" right.
+ * This command deletes a page.
+ * 
+ * Rights required:
+ * delete
+ * 
+ * MW version required:
+ * 1.12+
  */
 public class DeletePage extends APIcommand {
 
@@ -15,5 +21,7 @@ public DeletePage(PageLocation pl_, String editSummary_) {
 		values.add(getTitle());
 		keys.add("reason");
 		values.add(editSummary_);
+		
+		enforceMWVersion("1.12");
 	}
 }

src/main/java/WikiBot/APIcommands/EditPage.java

@@ -2,6 +2,16 @@
 
 import WikiBot.ContentRep.PageLocation;
 
+/**
+ * This command edits a page, or creates one if the
+ * page location does not exist.
+ * 
+ * Rights required:
+ * edit
+ * 
+ * MW version required:
+ * 1.13+
+ */
 public class EditPage extends APIcommand {
 
 	public EditPage(PageLocation pl_, String text_, String editSummary_) {
@@ -16,5 +26,7 @@ public EditPage(PageLocation pl_, String text_, String editSummary_) {
 		values.add(editSummary_);
 		keys.add("bot");
 		values.add("true");
+		
+		enforceMWVersion("1.13");
 	}
 }

src/main/java/WikiBot/APIcommands/EditSection.java

@@ -2,8 +2,24 @@
 
 import WikiBot.ContentRep.PageLocation;
 
+/**
+ * This command edits a page section.
+ * 
+ * Rights required:
+ * edit
+ * 
+ * MW version required:
+ * 1.13+
+ */
 public class EditSection extends APIcommand {
 
+	/**
+	 * Edit a section on the page.
+	 * @param pl_ The page.
+	 * @param sectionID_ 0 for the top section. "new" to add a new section.
+	 * @param text_ Section content.
+	 * @param editSummary_
+	 */
 	public EditSection(PageLocation pl_, int sectionID_, String text_, String editSummary_) {
 		super("Edit section", pl_, true, "edit", "csrf");
 		keys.add("action");
@@ -18,5 +34,7 @@ public EditSection(PageLocation pl_, int sectionID_, String text_, String editSu
 		values.add(editSummary_);
 		keys.add("bot");
 		values.add("true");
+		
+		enforceMWVersion("1.13");
 	}
 }

src/main/java/WikiBot/APIcommands/MovePage.java

@@ -3,7 +3,16 @@
 import WikiBot.ContentRep.PageLocation;
 
 /**
- * To move a page and leave no redirect behind, the suppressredirect right is needed. By default, this is only given to bots and sysops.
+ * This command moves a page.
+ * 
+ * Rights required:
+ * move
+ * movefile (To move files.)
+ * move-subpages (To move subpages.)
+ * suppressredirect (To move a page and leave no redirect behind.)
+ * 
+ * MW version required:
+ * 1.12+
  */
 public class MovePage extends APIcommand {
 
@@ -31,6 +40,8 @@ public MovePage(PageLocation from_, PageLocation to_, String editSummary_, boole
 			keys.add("noredirect");
 			values.add(null);
 		}
+		
+		enforceMWVersion("1.12");
 	}
 
 	/**
@@ -48,5 +59,7 @@ public MovePage(PageLocation from_, PageLocation to_, String editSummary_) {
 		values.add(editSummary_);
 		keys.add("format");
 		values.add("xml");
+		
+		enforceMWVersion("1.12");
 	}
 }

src/main/java/WikiBot/APIcommands/Query/QueryAllPages.java

@@ -1,17 +1,30 @@
 package WikiBot.APIcommands.Query;
 
-/*
- * APnamespace - The id associated with a namespace in a wiki.
+/**
+ * This command gets a list of all pages on the wiki.
+ * 
+ * Rights required:
+ * none
+ * 
+ * MW version required:
+ * all
  */
-
 public class QueryAllPages extends QueryList {
+	/**
+	 * This constructor assumes the main namespace.
+	 * @param language The wiki language.
+	 * @param depth How many pages to get.
+	 */
 	public QueryAllPages(String language, int depth) {
 		super("Query all pages", language, "allpages");
 		keys.add("aplimit");
 		values.add("" + depth);
 		unescapeText = true;
 	}
 
+	/*
+	 * Use for continuing large queries.
+	 */
 	public QueryAllPages(String language, int depth, String apcontinue) {
 		super("Query all pages", language, "allpages");
 		keys.add("aplimit");
@@ -22,6 +35,12 @@ public QueryAllPages(String language, int depth, String apcontinue) {
 		unescapeHTML = false;
 	}
 
+	/**
+	 * 
+	 * @param language The wiki language.
+	 * @param depth How many pages to get.
+	 * @param apcontinue The namespace id to query.
+	 */
 	public QueryAllPages(String language, int depth, int apnamespace) {
 		super("Query all pages", language, "allpages");
 		keys.add("aplimit");
@@ -32,6 +51,9 @@ public QueryAllPages(String language, int depth, int apnamespace) {
 		unescapeHTML = false;
 	}
 
+	/*
+	 * Use for continuing large queries.
+	 */
 	public QueryAllPages(String language, int depth, String apcontinue, int apnamespace) {
 		super("Query all pages", language, "allpages");
 		keys.add("aplimit");