mobile_template 0.0.1

data/templates/cordova_android/framework/src/org/apache/cordova/api/PluginManager.java

@@ -0,0 +1,359 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+package org.apache.cordova.api;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map.Entry;
+
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.xmlpull.v1.XmlPullParserException;
+
+import android.content.Intent;
+import android.content.res.XmlResourceParser;
+import android.util.Log;
+import android.webkit.WebView;
+
+/**
+ * PluginManager is exposed to JavaScript in the Cordova WebView.
+ * 
+ * Calling native plugin code can be done by calling PluginManager.exec(...)
+ * from JavaScript.
+ */
+public class PluginManager {
+
+	private HashMap<String, IPlugin> plugins = new HashMap<String,IPlugin>();
+	private HashMap<String, String> services = new HashMap<String,String>();
+	
+	private final CordovaInterface ctx;
+	private final WebView app;
+	
+    // Map URL schemes like foo: to plugins that want to handle those schemes
+    // This would allow how all URLs are handled to be offloaded to a plugin
+    protected HashMap<String, String> urlMap = new HashMap<String,String>();
+	
+	/**
+	 * Constructor.
+	 * 
+	 * @param app
+	 * @param ctx
+	 */
+	public PluginManager(WebView app, CordovaInterface ctx) {
+		this.ctx = ctx;
+		this.app = app;
+		this.loadPlugins();
+	}
+	
+	/**
+	 * Re-init when loading a new HTML page into webview.
+	 */
+	public void reinit() {
+	    
+	    // Stop plugins on current HTML page and discard
+	    this.onPause(false);
+	    this.onDestroy();
+	    this.plugins = new HashMap<String, IPlugin>();
+	}
+	
+	/**
+	 * Load plugins from res/xml/plugins.xml
+	 */
+	public void loadPlugins() {
+		int id = ctx.getResources().getIdentifier("plugins", "xml", ctx.getPackageName());
+		if (id == 0) { pluginConfigurationMissing(); }
+		XmlResourceParser xml = ctx.getResources().getXml(id);
+		int eventType = -1;
+		String pluginClass = "", pluginName = "";
+		while (eventType != XmlResourceParser.END_DOCUMENT) {
+			if (eventType == XmlResourceParser.START_TAG) {
+				String strNode = xml.getName();
+				if (strNode.equals("plugin")) {
+					pluginClass = xml.getAttributeValue(null, "value");
+					pluginName = xml.getAttributeValue(null, "name");
+					//System.out.println("Plugin: "+name+" => "+value);
+					this.addService(pluginName, pluginClass);
+					
+					// Create plugin at load time if attribute "onload"
+					if ("true".equals(xml.getAttributeValue(null, "onload"))) {
+					    this.getPlugin(pluginName);
+					}
+				} else if (strNode.equals("url-filter")) {
+					this.urlMap.put(xml.getAttributeValue(null, "value"), pluginName);
+				}
+			}
+			try {
+				eventType = xml.next();
+			} catch (XmlPullParserException e) {
+				e.printStackTrace();
+			} catch (IOException e) {
+				e.printStackTrace();
+			}
+		}
+	}
+
+	/**
+	 * Receives a request for execution and fulfills it by finding the appropriate
+	 * Java class and calling it's execute method.
+	 * 
+	 * PluginManager.exec can be used either synchronously or async. In either case, a JSON encoded 
+	 * string is returned that will indicate if any errors have occurred when trying to find
+	 * or execute the class denoted by the clazz argument.
+	 * 
+	 * @param service 		String containing the service to run
+	 * @param action 		String containt the action that the class is supposed to perform. This is
+	 * 						passed to the plugin execute method and it is up to the plugin developer 
+	 * 						how to deal with it.
+	 * @param callbackId 	String containing the id of the callback that is execute in JavaScript if
+	 * 						this is an async plugin call.
+	 * @param args 			An Array literal string containing any arguments needed in the
+	 * 						plugin execute method.
+	 * @param async 		Boolean indicating whether the calling JavaScript code is expecting an
+	 * 						immediate return value. If true, either Cordova.callbackSuccess(...) or 
+	 * 						Cordova.callbackError(...) is called once the plugin code has executed.
+	 * 
+	 * @return 				JSON encoded string with a response message and status.
+	 */
+	@SuppressWarnings("unchecked")
+	public String exec(final String service, final String action, final String callbackId, final String jsonArgs, final boolean async) {
+		PluginResult cr = null;
+		boolean runAsync = async;
+		try {
+			final JSONArray args = new JSONArray(jsonArgs);
+			final IPlugin plugin = this.getPlugin(service); 
+			final CordovaInterface ctx = this.ctx;
+			if (plugin != null) {
+				runAsync = async && !plugin.isSynch(action);
+				if (runAsync) {
+					// Run this on a different thread so that this one can return back to JS
+					Thread thread = new Thread(new Runnable() {
+						public void run() {
+							try {
+								// Call execute on the plugin so that it can do it's thing
+								PluginResult cr = plugin.execute(action, args, callbackId);
+								int status = cr.getStatus();
+
+								// If no result to be sent and keeping callback, then no need to sent back to JavaScript
+								if ((status == PluginResult.Status.NO_RESULT.ordinal()) && cr.getKeepCallback()) {
+								}
+
+								// Check the success (OK, NO_RESULT & !KEEP_CALLBACK)
+								else if ((status == PluginResult.Status.OK.ordinal()) || (status == PluginResult.Status.NO_RESULT.ordinal())) {
+									ctx.sendJavascript(cr.toSuccessCallbackString(callbackId));
+								} 
+								
+								// If error
+								else {
+									ctx.sendJavascript(cr.toErrorCallbackString(callbackId));
+								}
+							} catch (Exception e) {
+								PluginResult cr = new PluginResult(PluginResult.Status.ERROR, e.getMessage());
+								ctx.sendJavascript(cr.toErrorCallbackString(callbackId));
+							}
+						}
+					});
+					thread.start();
+					return "";
+				} else {
+					// Call execute on the plugin so that it can do it's thing
+					cr = plugin.execute(action, args, callbackId);
+
+					// If no result to be sent and keeping callback, then no need to sent back to JavaScript
+					if ((cr.getStatus() == PluginResult.Status.NO_RESULT.ordinal()) && cr.getKeepCallback()) {
+						return "";
+					}
+				}
+			}
+		} catch (JSONException e) {
+			System.out.println("ERROR: "+e.toString());
+			cr = new PluginResult(PluginResult.Status.JSON_EXCEPTION);
+		}
+		// if async we have already returned at this point unless there was an error...
+		if (runAsync) {
+			if (cr == null) {
+				cr = new PluginResult(PluginResult.Status.CLASS_NOT_FOUND_EXCEPTION);				
+			}
+			ctx.sendJavascript(cr.toErrorCallbackString(callbackId));
+		}
+		return ( cr != null ? cr.getJSONString() : "{ status: 0, message: 'all good' }" );
+	}
+	
+	/**
+	 * Get the class.
+	 * 
+	 * @param clazz
+	 * @return
+	 * @throws ClassNotFoundException
+	 */
+	@SuppressWarnings("unchecked")
+	private Class getClassByName(final String clazz) throws ClassNotFoundException {
+		Class c = null;
+		if (clazz != null) {
+			c = Class.forName(clazz);
+		}
+		return c;
+	}
+
+	/**
+	 * Get the interfaces that a class implements and see if it implements the
+	 * org.apache.cordova.api.Plugin interface.
+	 * 
+	 * @param c The class to check the interfaces of.
+	 * @return Boolean indicating if the class implements org.apache.cordova.api.Plugin
+	 */
+	@SuppressWarnings("unchecked")
+	private boolean isCordovaPlugin(Class c) {
+		if (c != null) {
+			return org.apache.cordova.api.Plugin.class.isAssignableFrom(c) || org.apache.cordova.api.IPlugin.class.isAssignableFrom(c);
+		}
+		return false;
+	}
+
+    /**
+     * Add plugin to be loaded and cached.  This creates an instance of the plugin.
+     * If plugin is already created, then just return it.
+     * 
+     * @param className				The class to load
+     * @param clazz					The class object (must be a class object of the className)
+     * @param callbackId			The callback id to use when calling back into JavaScript
+     * @return						The plugin
+     */
+	@SuppressWarnings("unchecked")
+	private IPlugin addPlugin(String pluginName, String className) {
+		try {
+			Class c = getClassByName(className);
+			if (isCordovaPlugin(c)) {
+				IPlugin plugin = (IPlugin)c.newInstance();
+				this.plugins.put(className, plugin);
+				plugin.setContext(this.ctx);
+				plugin.setView(this.app);
+				return plugin;
+			}
+    	} catch (Exception e) {
+    		  e.printStackTrace();
+    		  System.out.println("Error adding plugin "+className+".");
+    	}
+    	return null;
+    }
+    
+    /**
+     * Get the loaded plugin.
+     * 
+     * If the plugin is not already loaded then load it.
+     * 
+     * @param className				The class of the loaded plugin.
+     * @return
+     */
+    private IPlugin getPlugin(String pluginName) {
+		String className = this.services.get(pluginName);
+    	if (this.plugins.containsKey(className)) {
+    		return this.plugins.get(className);
+    	} else {
+	    	return this.addPlugin(pluginName, className);
+	    }
+    }
+    
+    /**
+     * Add a class that implements a service.
+     * This does not create the class instance.  It just maps service name to class name.
+     * 
+     * @param serviceType
+     * @param className
+     */
+    public void addService(String serviceType, String className) {
+    	this.services.put(serviceType, className);
+    }
+
+    /**
+     * Called when the system is about to start resuming a previous activity. 
+     * 
+     * @param multitasking		Flag indicating if multitasking is turned on for app
+     */
+    public void onPause(boolean multitasking) {
+        for (IPlugin plugin : this.plugins.values()) {
+            plugin.onPause(multitasking);
+        }
+    }
+    
+    /**
+     * Called when the activity will start interacting with the user. 
+     * 
+     * @param multitasking		Flag indicating if multitasking is turned on for app
+     */
+    public void onResume(boolean multitasking) {
+        for (IPlugin plugin : this.plugins.values()) {
+            plugin.onResume(multitasking);
+        }
+    }
+
+    /**
+     * The final call you receive before your activity is destroyed. 
+     */
+    public void onDestroy() {
+        for (IPlugin plugin : this.plugins.values()) {
+            plugin.onDestroy();
+        }
+    }
+
+    /**
+     * Send a message to all plugins. 
+     * 
+     * @param id            The message id
+     * @param data          The message data
+     */
+    public void postMessage(String id, Object data) {
+        for (IPlugin plugin : this.plugins.values()) {
+            plugin.onMessage(id, data);
+        }
+    }
+
+    /**
+     * Called when the activity receives a new intent. 
+     */    
+    public void onNewIntent(Intent intent) {
+        for (IPlugin plugin : this.plugins.values()) {
+            plugin.onNewIntent(intent);
+        }
+    }
+
+    /**
+     * Called when the URL of the webview changes.
+     * 
+     * @param url The URL that is being changed to.
+     * @return Return false to allow the URL to load, return true to prevent the URL from loading.
+     */
+    public boolean onOverrideUrlLoading(String url) {
+    	Iterator<Entry<String, String>> it = this.urlMap.entrySet().iterator();
+        while (it.hasNext()) {
+            HashMap.Entry<String, String> pairs = it.next();
+            if (url.startsWith(pairs.getKey())) {
+            	return this.getPlugin(pairs.getValue()).onOverrideUrlLoading(url);
+            }
+        }
+    	return false;
+    }
+
+	private void pluginConfigurationMissing() {
+		System.err.println("=====================================================================================");
+		System.err.println("ERROR: plugin.xml is missing.  Add res/xml/plugins.xml to your project.");      
+		System.err.println("https://git-wip-us.apache.org/repos/asf?p=incubator-cordova-android.git;a=blob;f=framework/res/xml/plugins.xml");        
+		System.err.println("=====================================================================================");
+	}
+}

data/templates/cordova_android/framework/src/org/apache/cordova/api/PluginResult.java

@@ -0,0 +1,119 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+package org.apache.cordova.api;
+
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+import android.util.Log;
+
+public class PluginResult {
+	private final int status;
+	private final String message;
+	private boolean keepCallback = false;
+	
+	public PluginResult(Status status) {
+		this.status = status.ordinal();
+		this.message = "'" + PluginResult.StatusMessages[this.status] + "'";
+	}
+	
+	public PluginResult(Status status, String message) {
+		this.status = status.ordinal();
+		this.message = JSONObject.quote(message);
+	}
+
+	public PluginResult(Status status, JSONArray message) {
+		this.status = status.ordinal();
+		this.message = message.toString();
+	}
+
+	public PluginResult(Status status, JSONObject message) {
+		this.status = status.ordinal();
+		this.message = message.toString();
+	}
+
+	public PluginResult(Status status, int i) {
+		this.status = status.ordinal();
+		this.message = ""+i;
+	}
+
+	public PluginResult(Status status, float f) {
+		this.status = status.ordinal();
+		this.message = ""+f;
+	}
+
+	public PluginResult(Status status, boolean b) {
+		this.status = status.ordinal();
+		this.message = ""+b;
+	}
+	
+	public void setKeepCallback(boolean b) {
+		this.keepCallback = b;
+	}
+	
+	public int getStatus() {
+		return status;
+	}
+
+	public String getMessage() {
+		return message;
+	}
+	
+	public boolean getKeepCallback() {
+		return this.keepCallback;
+	}
+	
+	public String getJSONString() {
+		return "{status:" + this.status + ",message:" + this.message + ",keepCallback:" + this.keepCallback + "}";
+	}
+	
+	public String toSuccessCallbackString(String callbackId) {
+		return "require('cordova').callbackSuccess('"+callbackId+"',"+this.getJSONString()+");";
+	}
+	
+	public String toErrorCallbackString(String callbackId) {
+		return "require('cordova').callbackError('"+callbackId+"', " + this.getJSONString()+ ");";
+	}
+	
+	public static String[] StatusMessages = new String[] {
+		"No result",
+		"OK",
+		"Class not found",
+		"Illegal access",
+		"Instantiation error",
+		"Malformed url",
+		"IO error",
+		"Invalid action",
+		"JSON error",
+		"Error"
+	};
+	
+	public enum Status {
+		NO_RESULT,
+		OK,
+		CLASS_NOT_FOUND_EXCEPTION,
+		ILLEGAL_ACCESS_EXCEPTION,
+		INSTANTIATION_EXCEPTION,
+		MALFORMED_URL_EXCEPTION,
+		IO_EXCEPTION,
+		INVALID_ACTION,
+		JSON_EXCEPTION,
+		ERROR
+	}
+}

data/templates/cordova_android/framework/src/org/apache/cordova/file/EncodingException.java

@@ -0,0 +1,28 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+package org.apache.cordova.file;
+
+public class EncodingException extends Exception {
+
+	public EncodingException(String message) {
+		super(message);
+	}
+	
+}

data/templates/cordova_android/framework/src/org/apache/cordova/file/FileExistsException.java

@@ -0,0 +1,28 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+package org.apache.cordova.file;
+
+public class FileExistsException extends Exception {
+
+	public FileExistsException(String msg) {
+		super(msg);
+	}
+
+}

data/templates/cordova_android/framework/src/org/apache/cordova/file/InvalidModificationException.java

@@ -0,0 +1,29 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+
+package org.apache.cordova.file;
+
+public class InvalidModificationException extends Exception {
+
+	public InvalidModificationException(String message) {
+		super(message);
+	}
+
+}

data/templates/cordova_android/framework/src/org/apache/cordova/file/NoModificationAllowedException.java

@@ -0,0 +1,28 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+package org.apache.cordova.file;
+
+public class NoModificationAllowedException extends Exception {
+
+	public NoModificationAllowedException(String message) {
+		super(message);
+	}
+
+}

data/templates/cordova_android/framework/src/org/apache/cordova/file/TypeMismatchException.java

@@ -0,0 +1,29 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+
+package org.apache.cordova.file;
+
+public class TypeMismatchException extends Exception {
+
+	public TypeMismatchException(String message) {
+		super(message);
+	}
+
+}

data/templates/cordova_android/framework/test/org/apache/cordova/PreferenceNodeTest.java

@@ -0,0 +1,53 @@
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+import org.junit.*;
+import static org.junit.Assert.*;
+
+import org.apache.cordova.PreferenceNode;
+
+public class PreferenceNodeTest {
+    @Test
+        public void testConstructor() {
+            PreferenceNode foo = new org.apache.cordova.PreferenceNode("fullscreen", "false", false);
+            assertEquals("fullscreen", foo.name);
+            assertEquals("false", foo.value);
+            assertEquals(false, foo.readonly);
+        }
+
+    @Test
+        public void testNameAssignment() {
+            PreferenceNode foo = new org.apache.cordova.PreferenceNode("fullscreen", "false", false);
+            foo.name = "widescreen";
+            assertEquals("widescreen", foo.name);
+        }
+
+    @Test
+        public void testValueAssignment() {
+            PreferenceNode foo = new org.apache.cordova.PreferenceNode("fullscreen", "false", false);
+            foo.value = "maybe";
+            assertEquals("maybe", foo.value);
+        }
+
+    @Test
+        public void testReadonlyAssignment() {
+            PreferenceNode foo = new org.apache.cordova.PreferenceNode("fullscreen", "false", false);
+            foo.readonly = true;
+            assertEquals(true, foo.readonly);
+        }
+}