Author: scottbw
Date: Tue Mar 9 22:10:45 2010
New Revision: 921160
URL: http://svn.apache.org/viewvc?rev=921160&view=rev
Log:
This is part 2 of 3 updates of the Shindig integration code that brings it up
to date with the other changes to the Wookie core code; See WOOKIE-52 for more
information on wookie-shindig integration.
Added:
incubator/wookie/trunk/shindig/features/core.prefs/
incubator/wookie/trunk/shindig/features/core.prefs/feature.xml
incubator/wookie/trunk/shindig/features/core.prefs/prefs.js
incubator/wookie/trunk/shindig/features/core.prefs/taming.js
Added: incubator/wookie/trunk/shindig/features/core.prefs/feature.xml
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/shindig/features/core.prefs/feature.xml?rev=921160&view=auto
==============================================================================
--- incubator/wookie/trunk/shindig/features/core.prefs/feature.xml (added)
+++ incubator/wookie/trunk/shindig/features/core.prefs/feature.xml Tue Mar 9
22:10:45 2010
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+<feature>
+ <name>core.prefs</name>
+ <dependency>core.util</dependency>
+ <gadget>
+ <!--- wookie integration js -->
+ <script src="http://localhost:8080/wookie/dwr/util.js"/>
+ <script src="http://localhost:8080//wookie/dwr/engine.js"/>
+ <script src="http://localhost:8080//wookie/dwr/interface/WidgetImpl.js"/>
+ <script
src="http://localhost:8080//wookie/shared/js/wookie-wrapper.js"/>
+
+ <script src="prefs.js"/>
+ <script src="taming.js"/>
+ </gadget>
+</feature>
Added: incubator/wookie/trunk/shindig/features/core.prefs/prefs.js
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/shindig/features/core.prefs/prefs.js?rev=921160&view=auto
==============================================================================
--- incubator/wookie/trunk/shindig/features/core.prefs/prefs.js (added)
+++ incubator/wookie/trunk/shindig/features/core.prefs/prefs.js Tue Mar 9
22:10:45 2010
@@ -0,0 +1,317 @@
+/*
+ * 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.
+ */
+
+/**
+ * @fileoverview
+ *
+ * Provides access to user prefs, module dimensions, and messages.
+ *
+ * <p>Clients can access their preferences by constructing an instance of
+ * gadgets.Prefs and passing in their module id. Example:
+ *
+ * <pre>
+ * var prefs = new gadgets.Prefs();
+ * var name = prefs.getString("name");
+ * var lang = prefs.getLang();
+ * </pre>
+ *
+ * <p>Modules with type=url can also use this library to parse arguments passed
+ * by URL, but this is not the common case:
+ *
+ * <script src="http://apache.org/shindig/prefs.js"></script>
+ * <script>
+ * gadgets.Prefs.parseUrl();
+ * var prefs = new gadgets.Prefs();
+ * var name = prefs.getString("name");
+ * </script>
+ */
+
+(function() {
+
+var instance = null;
+var prefs = {};
+var esc = gadgets.util.escapeString;
+var messages = {};
+var defaultPrefs = {};
+var language = "en";
+var country = "US";
+var moduleId = 0;
+
+/**
+ * Parses all parameters from the url and stores them
+ * for later use when creating a new gadgets.Prefs object.
+ */
+function parseUrl() {
+ var params = gadgets.util.getUrlParameters();
+ for (var i in params) {
+ if (params.hasOwnProperty(i)) {
+ if (i.indexOf("up_") === 0 && i.length > 3) {
+ prefs[i.substr(3)] = String(params[i]);
+ } else if (i === "country") {
+ country = params[i];
+ } else if (i === "lang") {
+ language = params[i];
+ } else if (i === "mid") {
+ moduleId = params[i];
+ }
+ }
+ }
+}
+
+/**
+ * Sets default pref values for values left unspecified in the
+ * rendering call, but with default_value provided in the spec.
+ */
+function mergeDefaults() {
+ for (var name in defaultPrefs) {
+ if (typeof prefs[name] === 'undefined') {
+ prefs[name] = defaultPrefs[name];
+ }
+ }
+};
+
+/// WOOKIE ADDITION
+/**
+ * Loads the persisted preferences from Wookie
+ */
+function loadPrefs(){
+ Widget.init();
+ for (var x=0;x<Widget.preferences.length;x++){
+ key = Widget.preferences.key(x);
+ prefs[key] = Widget.preferences.getItem(key);
+ }
+};
+
+/**
+ * @class
+ * Provides access to user preferences, module dimensions, and messages.
+ *
+ * Clients can access their preferences by constructing an instance of
+ * gadgets.Prefs and passing in their module id. Example:
+ *
+<pre>var prefs = new gadgets.Prefs();
+var name = prefs.getString("name");
+var lang = prefs.getLang();</pre>
+ *
+ * @description Creates a new Prefs object.
+ *
+ * Note: this is actually a singleton. All prefs are linked. If you're
wondering
+ * why this is a singleton and not just a collection of package functions, the
+ * simple answer is that it's how the spec is written. The spec is written this
+ * way for legacy compatibility with igoogle.
+ */
+gadgets.Prefs = function() {
+ if (!instance) {
+ parseUrl();
+ mergeDefaults();
+ /// WOOKIE ADDITION
+ loadPrefs();
+ instance = this;
+ }
+
+ return instance;
+};
+
+/**
+ * Sets internal values
+ * @return {boolean} True if the prefs is modified.
+ */
+gadgets.Prefs.setInternal_ = function(key, value) {
+ var wasModified = false;
+ if (typeof key === "string") {
+ if (!prefs.hasOwnProperty(key) || prefs[key] !== value) {
+ // WOOKIE ADDITION
+ Widget.preferences.setItem(key,value);
+ /// END WOOKIE ADDITIOn
+ wasModified = true;
+ }
+ prefs[key] = value;
+ } else {
+ for (var k in key) {
+ if (key.hasOwnProperty(k)) {
+ var v = key[k];
+ if (!prefs.hasOwnProperty(k) || prefs[k] !== v) {
+ /// WOOKIE ADDITION
+ Widget.preferences.setItem(k,key[k]);
+ /// END WOOKIE ADDITION
+ wasModified = true;
+ }
+ prefs[k] = v;
+ }
+ }
+ }
+ return wasModified;
+};
+
+/**
+ * Initializes message bundles.
+ */
+gadgets.Prefs.setMessages_ = function(msgs) {
+ messages = msgs;
+};
+
+/**
+ * Initializes default user prefs values.
+ */
+gadgets.Prefs.setDefaultPrefs_ = function(defprefs) {
+ defaultPrefs = defprefs;
+};
+
+/**
+ * Retrieves a preference as a string.
+ * Returned value will be html entity escaped.
+ *
+ * @param {string} key The preference to fetch
+ * @return {string} The preference; if not set, an empty string
+ */
+gadgets.Prefs.prototype.getString = function(key) {
+ if (key === ".lang") { key = "lang"; }
+ return prefs[key] ? esc(prefs[key]) : "";
+};
+
+/*
+ * Indicates not to escape string values when retrieving them.
+ * This is an internal detail used by _IG_Prefs for backward compatibility.
+ */
+gadgets.Prefs.prototype.setDontEscape_ = function() {
+ esc = function(k) { return k; };
+};
+
+/**
+ * Retrieves a preference as an integer.
+ * @param {string} key The preference to fetch
+ * @return {number} The preference; if not set, 0
+ */
+gadgets.Prefs.prototype.getInt = function(key) {
+ var val = parseInt(prefs[key], 10);
+ return isNaN(val) ? 0 : val;
+};
+
+/**
+ * Retrieves a preference as a floating-point value.
+ * @param {string} key The preference to fetch
+ * @return {number} The preference; if not set, 0
+ */
+gadgets.Prefs.prototype.getFloat = function(key) {
+ var val = parseFloat(prefs[key]);
+ return isNaN(val) ? 0 : val;
+};
+
+/**
+ * Retrieves a preference as a boolean.
+ * @param {string} key The preference to fetch
+ * @return {boolean} The preference; if not set, false
+ */
+gadgets.Prefs.prototype.getBool = function(key) {
+ var val = prefs[key];
+ if (val) {
+ return val === "true" || val === true || !!parseInt(val, 10);
+ }
+ return false;
+};
+
+/**
+ * Stores a preference.
+ * To use this call,
+ * the gadget must require the feature setprefs.
+ *
+ * <p class="note">
+ * <b>Note:</b>
+ * If the gadget needs to store an Array it should use setArray instead of
+ * this call.
+ * </p>
+ *
+ * @param {string} key The pref to store
+ * @param {Object} val The values to store
+ */
+gadgets.Prefs.prototype.set = function(key, value) {
+ throw new Error("setprefs feature required to make this call.");
+};
+
+/**
+ * Retrieves a preference as an array.
+ * UserPref values that were not declared as lists are treated as
+ * one-element arrays.
+ *
+ * @param {string} key The preference to fetch
+ * @return {Array.<string>} The preference; if not set, an empty array
+ */
+gadgets.Prefs.prototype.getArray = function(key) {
+ var val = prefs[key];
+ if (val) {
+ var arr = val.split("|");
+ // Decode pipe characters.
+ for (var i = 0, j = arr.length; i < j; ++i) {
+ arr[i] = esc(arr[i].replace(/%7C/g, "|"));
+ }
+ return arr;
+ }
+ return [];
+};
+
+/**
+ * Stores an array preference.
+ * To use this call,
+ * the gadget must require the feature setprefs.
+ *
+ * @param {string} key The pref to store
+ * @param {Array} val The values to store
+ */
+gadgets.Prefs.prototype.setArray = function(key, val) {
+ throw new Error("setprefs feature required to make this call.");
+};
+
+/**
+ * Fetches an unformatted message.
+ * @param {string} key The message to fetch
+ * @return {string} The message
+ */
+gadgets.Prefs.prototype.getMsg = function(key) {
+ return messages[key] || "";
+};
+
+/**
+ * Gets the current country, returned as ISO 3166-1 alpha-2 code.
+ *
+ * @return {string} The country for this module instance
+ */
+gadgets.Prefs.prototype.getCountry = function() {
+ return country;
+};
+
+/**
+ * Gets the current language the gadget should use when rendering, returned as
a
+ * ISO 639-1 language code.
+ *
+ * @return {string} The language for this module instance
+ */
+gadgets.Prefs.prototype.getLang = function() {
+ return language;
+};
+
+/**
+ * Gets the module id for the current instance.
+ *
+ * @return {string | number} The module id for this module instance
+ */
+gadgets.Prefs.prototype.getModuleId = function() {
+ return moduleId;
+};
+
+})();
Added: incubator/wookie/trunk/shindig/features/core.prefs/taming.js
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/shindig/features/core.prefs/taming.js?rev=921160&view=auto
==============================================================================
--- incubator/wookie/trunk/shindig/features/core.prefs/taming.js (added)
+++ incubator/wookie/trunk/shindig/features/core.prefs/taming.js Tue Mar 9
22:10:45 2010
@@ -0,0 +1,41 @@
+/*
+ * 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.
+ */
+
+/**
+ * @class
+ * Tame and expose core gadgets.* API to cajoled gadgets
+ */
+var tamings___ = tamings___ || [];
+tamings___.push(function(imports) {
+ caja___.whitelistCtors([
+ [gadgets, 'Prefs', Object]
+ ]);
+ caja___.whitelistMeths([
+ [gadgets.Prefs, 'getArray'],
+ [gadgets.Prefs, 'getBool'],
+ [gadgets.Prefs, 'getCountry'],
+ [gadgets.Prefs, 'getFloat'],
+ [gadgets.Prefs, 'getInt'],
+ [gadgets.Prefs, 'getLang'],
+ [gadgets.Prefs, 'getMsg'],
+ [gadgets.Prefs, 'getString'],
+ [gadgets.Prefs, 'set'],
+ [gadgets.Prefs, 'setArray']
+ ]);
+});
