} responseItems Key/value map of data
* response information
* @param {Boolean} opt_globalError Optional field indicating whether there were
* any errors generating this data response
*
* @private
* @constructor
*/
opensocial.DataResponse = function(responseItems, opt_globalError,
opt_errorMessage) {
this.responseItems_ = responseItems;
this.globalError_ = opt_globalError;
this.errorMessage_ = opt_errorMessage;
};
/**
* Returns true if there was an error in fetching this data from the server.
*
* @return {Boolean} True if there was an error; otherwise, false
* @member opensocial.DataResponse
*/
opensocial.DataResponse.prototype.hadError = function() {
return !!this.globalError_;
};
/**
* If the entire request had a batch level error, returns the error message.
*
* @return {String} A human-readable description of the error that occurred.
*/
opensocial.DataResponse.prototype.getErrorMessage = function() {
return this.errorMessage_;
};
/**
* Gets the ResponseItem for the requested field.
*
* @return {opensocial.ResponseItem} The requested
* response calculated by the
* server
* @member opensocial.DataResponse
*/
opensocial.DataResponse.prototype.get = function(key) {
return this.responseItems_[key];
};
/*
* 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 ResponseItem containing information about a specific response
* from the server.
*/
/**
* @class
* Represents a response that was generated
* by processing a data request item on the server.
*
* @name opensocial.ResponseItem
*/
/**
* Represents a response that was generated by processing a data request item
* on the server.
*
* @private
* @constructor
*/
opensocial.ResponseItem = function(originalDataRequest, data,
opt_errorCode, opt_errorMessage) {
this.originalDataRequest_ = originalDataRequest;
this.data_ = data;
this.errorCode_ = opt_errorCode;
this.errorMessage_ = opt_errorMessage;
};
/**
* Returns true if there was an error in fetching this data from the server.
*
* @return {Boolean} True if there was an error; otherwise, false
*/
opensocial.ResponseItem.prototype.hadError = function() {
return !!this.errorCode_;
};
/**
* @static
* @class
*
* Error codes that a response item can return.
*
* @name opensocial.ResponseItem.Error
*/
opensocial.ResponseItem.Error = {
/**
* This container does not support the request that was made.
*
* @member opensocial.ResponseItem.Error
*/
NOT_IMPLEMENTED : 'notImplemented',
/**
* The gadget does not have access to the requested data.
* To get access, use
*
* opensocial.requestPermission().
*
* @member opensocial.ResponseItem.Error
*/
UNAUTHORIZED : 'unauthorized',
/**
* The gadget can never have access to the requested data.
*
* @member opensocial.ResponseItem.Error
*/
FORBIDDEN : 'forbidden',
/**
* The request was invalid. Example: 'max' was -1.
*
* @member opensocial.ResponseItem.Error
*/
BAD_REQUEST : 'badRequest',
/**
* The request encountered an unexpected condition that
* prevented it from fulfilling the request.
*
* @member opensocial.ResponseItem.Error
*/
INTERNAL_ERROR : 'internalError',
/**
* The gadget exceeded a quota on the request. Example quotas include a
* max number of calls per day, calls per user per day, calls within a
* certain time period and so forth.
*
* @member opensocial.ResponseItem.Error
*/
LIMIT_EXCEEDED : 'limitExceeded'
};
/**
* If the request had an error, returns the error code.
* The error code can be container-specific
* or one of the values defined by
* Error.
*
* @return {String} The error code, or null if no error occurred
*/
opensocial.ResponseItem.prototype.getErrorCode = function() {
return this.errorCode_;
};
/**
* If the request had an error, returns the error message.
*
* @return {String} A human-readable description of the error that occurred;
* can be null, even if an error occurred
*/
opensocial.ResponseItem.prototype.getErrorMessage = function() {
return this.errorMessage_;
};
/**
* Returns the original data request.
*
* @return {opensocial.DataRequest} The data request used to fetch this data
* response
*/
opensocial.ResponseItem.prototype.getOriginalDataRequest = function() {
return this.originalDataRequest_;
};
/**
* Gets the response data.
*
* @return {Object} The requested value calculated by the server; the type of
* this value is defined by the type of request that was made
*/
opensocial.ResponseItem.prototype.getData = function() {
return this.data_;
};
/*
* 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
* Representation of an activity.
*
* Activities are rendered with a title and an optional activity body.
*
* You may set the title and body directly as strings when calling
* opensocial.createActivity.
*
* However, it is usually beneficial to create activities using
* Activity Templates for the title and body. Activity Templates support:
*
* - Internationalization
* - Replacement variables in the message
* - Activity Summaries, which are message variations used to summarize
* repeated activities that share something in common.
*
*
* Activity Templates are defined as messages in the gadget specification.
* To define messages, you create and reference message bundle XML files for
* each locale you support.
*
* Example module spec in gadget XML:
*
* <ModulePrefs title="ListenToThis">
* <Locale messages="http://www.listentostuff.com/messages.xml"/>
* <Locale lang="de" messages="http://www.listentostuff.com/messages-DE.xml"/>
* </ModulePrefs>
*
*
*
* Example message bundle:
*
* <messagebundle>
* <msg name="LISTEN_TO_THIS_SONG">
* ${Subject.DisplayName} told ${Owner.DisplayName} to
* listen to a song!
* </msg>
* </messagebundle>
*
*
*
* You can set custom key/value string pairs when posting an activity.
* These values will be used for variable substitution in the templates.
* Example JS call:
*
* var owner = ...;
* var viewer = ...;
* var activity = opensocial.newActivity('LISTEN_TO_THIS_SONG',
* {Song: 'Do That There - (Young Einstein hoo-hoo mix)',
* Artist: 'Lyrics Born', Subject: viewer, Owner: owner})
*
*
*
* Associated message:
*
* <msg name="LISTEN_TO_THIS_SONG">
* ${Subject.DisplayName} told ${Owner.DisplayName} to listen
* to ${Song} by ${Artist}
* </msg>
*
*
*
* People can also be set as values in key/value pairs when posting
* an activity. You can then reference the following fields on a person:
*
* - ${Person.DisplayName} The person's name
* - ${Person.Id} The user ID of the person
* - ${Person.ProfileUrl} The profile URL of the person
* - ${Person} This will show the display name, but containers may optionally
* provide special formatting, such as showing the name as a link
*
*
* Users will have many activities in their activity streams, and containers
* will not show every activity that is visible to a user. To help display
* large numbers of activities, containers will summarize a list of activities
* from a given source to a single entry.
*
* You can provide Activity Summaries to customize the text shown when
* multiple activities are summarized. If no customization is provided, a
* container may ignore your activities altogether or provide default text
* such as "Bob changed his status message + 20 other events like this."
*
* - Activity Summaries will always summarize around a specific key in a
* key/value pair. This is so that the summary can say something concrete
* (this is clearer in the example below).
* - Other variables will have synthetic "Count" variables created with
* the total number of items summarized.
* - Message ID of the summary is the message ID of the main template + ":" +
* the data key
*
*
* Example summaries:
*
* <messagebundle>
* <msg name="LISTEN_TO_THIS_SONG:Artist">
* ${Subject.Count} of your friends have suggested listening to songs
* by ${Artist}!
* </msg>
* <msg name="LISTEN_TO_THIS_SONG:Song">
* ${Subject.Count} of your friends have suggested listening to ${Song}
* !</msg>
* <msg name="LISTEN_TO_THIS_SONG:Subject">
* ${Subject.DisplayName} has recommended ${Song.Count} songs to you.
* </msg>
* </messagebundle>
*
*
* Activity Templates may only have the following HTML tags: <b>,
* <i>, <a>, <span>. The container also has the option
* to strip out these tags when rendering the activity.
*
*
* See also:
* opensocial.newActivity(),
*
* opensocial.requestCreateActivity()
*
* @name opensocial.Activity
*/
/**
* Base interface for all activity objects.
*
* Private, see opensocial.createActivity() for usage.
*
* @param {Map.<opensocial.Activity.Field, Object>} params
* Parameters defining the activity.
* @private
* @constructor
*/
opensocial.Activity = function(params) {
this.fields_ = params || {};
};
/**
* @static
* @class
* All of the fields that activities can have.
*
*
It is only required to set one of TITLE_ID or TITLE. In addition, if you
* are using any variables in your title or title template,
* you must set TEMPLATE_PARAMS.
*
* Other possible fields to set are: URL, MEDIA_ITEMS, BODY_ID, BODY,
* EXTERNAL_ID, PRIORITY, STREAM_TITLE, STREAM_URL, STREAM_SOURCE_URL,
* and STREAM_FAVICON_URL.
*
* Containers are only required to use TITLE_ID or TITLE, they may ignore
* additional parameters.
*
*
* See also:
* opensocial.Activity.getField()
*
*
* @name opensocial.Activity.Field
*/
opensocial.Activity.Field = {
/**
* A string specifying the title template message ID in the gadget
* spec.
*
* The title is the primary text of an activity.
*
* Titles may only have the following HTML tags: <b> <i>,
* <a>, <span>.
* The container may ignore this formatting when rendering the activity.
*
* @member opensocial.Activity.Field
*/
TITLE_ID : 'titleId',
/**
* A string specifying the primary text of an activity.
*
* Titles may only have the following HTML tags: <b> <i>,
* <a>, <span>.
* The container may ignore this formatting when rendering the activity.
*
* @member opensocial.Activity.Field
*/
TITLE : 'title',
/**
* A map of custom keys to values associated with this activity.
* These will be used for evaluation in templates.
*
* The data has type Map<String, Object>. The
* object may be either a String or an opensocial.Person.
*
* When passing in a person with key PersonKey, can use the following
* replacement variables in the template:
*
* - PersonKey.DisplayName - Display name for the person
* - PersonKey.ProfileUrl. URL of the person's profile
* - PersonKey.Id - The ID of the person
* - PersonKey - Container may replace with DisplayName, but may also
* optionally link to the user.
*
*
* @member opensocial.Activity.Field
*/
TEMPLATE_PARAMS : 'templateParams',
/**
* A string specifying the
* URL that represents this activity.
* @member opensocial.Activity.Field
*/
URL : 'url',
/**
* Any photos, videos, or images that should be associated
* with the activity. Higher priority ones are higher in the list.
* The data has type Array<
* MediaItem>.
* @member opensocial.Activity.Field
*/
MEDIA_ITEMS : 'mediaItems',
/**
* A string specifying the body template message ID in the gadget spec.
*
* The body is an optional expanded version of an activity.
*
* Bodies may only have the following HTML tags: <b> <i>,
* <a>, <span>.
* The container may ignore this formatting when rendering the activity.
*
* @member opensocial.Activity.Field
*/
BODY_ID : 'bodyId',
/**
* A string specifying an optional expanded version of an activity.
*
* Bodies may only have the following HTML tags: <b> <i>,
* <a>, <span>.
* The container may ignore this formatting when rendering the activity.
*
* @member opensocial.Activity.Field
*/
BODY : 'body',
/**
* An optional string ID generated by the posting application.
* @member opensocial.Activity.Field
*/
EXTERNAL_ID : 'externalId',
/**
* A string specifing the title of the stream.
* @member opensocial.Activity.Field
*/
STREAM_TITLE : 'streamTitle',
/**
* A string specifying the stream's URL.
* @member opensocial.Activity.Field
*/
STREAM_URL : 'streamUrl',
/**
* A string specifying the stream's source URL.
* @member opensocial.Activity.Field
*/
STREAM_SOURCE_URL : 'streamSourceUrl',
/**
* A string specifying the URL for the stream's favicon.
* @member opensocial.Activity.Field
*/
STREAM_FAVICON_URL : 'streamFaviconUrl',
/**
* A number between 0 and 1 representing the relative priority of
* this activity in relation to other activities from the same source
* @member opensocial.Activity.Field
*/
PRIORITY : 'priority',
/**
* A string ID that is permanently associated with this activity.
* This value can not be set.
* @member opensocial.Activity.Field
*/
ID : 'id',
/**
* The string ID of the user who this activity is for.
* This value can not be set.
* @member opensocial.Activity.Field
*/
USER_ID : 'userId',
/**
* A string specifying the application that this activity is associated with.
* This value can not be set.
* @member opensocial.Activity.Field
*/
APP_ID : 'appId',
/**
* A string specifying the time at which this activity took place
* in milliseconds since the epoch.
* This value can not be set.
* @member opensocial.Activity.Field
*/
POSTED_TIME : 'postedTime'
};
/**
* Gets an ID that can be permanently associated with this activity.
*
* @return {String} The ID
* @member opensocial.Activity
*/
opensocial.Activity.prototype.getId = function() {
return this.getField(opensocial.Activity.Field.ID);
};
/**
* Gets the activity data that's associated with the specified key.
*
* @param {String} key The key to get data for;
* see the Field class
* for possible values
* @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* params
* to pass to the request.
* @return {String} The data
* @member opensocial.Activity
*/
opensocial.Activity.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
};
/**
* Sets data for this activity associated with the given key.
*
* @param {String} key The key to set data for
* @param {String} data The data to set
*/
opensocial.Activity.prototype.setField = function(key, data) {
return this.fields_[key] = data;
};/*
* 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 Representation of a message.
*/
/**
* @class
* Base interface for all message objects.
*
*
* See also:
* opensocial.newMessage(),
*
* opensocial.requestSendMessage()
*
* @name opensocial.Message
*/
/**
* Base interface for all message objects.
*
* @param {String} body The main text of the message.
* @param {Map.} opt_params Any other
* fields that should be set on the message object. All of the defined
* Fields are supported.
* @private
* @constructor
*/
opensocial.Message = function(body, opt_params) {
this.fields_ = opt_params || {};
this.fields_[opensocial.Message.Field.BODY] = body;
};
/**
* @static
* @class
* All of the fields that messages can have.
*
*
* See also:
* opensocial.Message.getField()
*
*
* @name opensocial.Message.Field
*/
opensocial.Message.Field = {
/**
* The title of the message, specified as an opensocial.Message.Type.
* @member opensocial.Message.Field
*/
TYPE : 'type',
/**
* The title of the message. HTML attributes are allowed and are
* sanitized by the container.
* @member opensocial.Message.Field
*/
TITLE : 'title',
/**
* The main text of the message. HTML attributes are allowed and are
* sanitized by the container.
* @member opensocial.Message.Field
*/
BODY : 'body',
/**
* The title of the message as a message template. Specifies the
* message ID to use in the gadget xml.
* @member opensocial.Message.Field
*/
TITLE_ID : 'titleId',
/**
* The main text of the message as a message template. Specifies the
* message ID to use in the gadget xml.
* @member opensocial.Message.Field
*/
BODY_ID : 'bodyId'
};
/**
* @static
* @class
* The types of messages that can be sent.
*
* @name opensocial.Message.Type
*/
opensocial.Message.Type = {
/**
* An email.
*
* @member opensocial.Message.Type
*/
EMAIL : 'email',
/**
* A short private message.
*
* @member opensocial.Message.Type
*/
NOTIFICATION : 'notification',
/**
* A message to a specific user that can be seen only by that user.
*
* @member opensocial.Message.Type
*/
PRIVATE_MESSAGE : 'privateMessage',
/**
* A message to a specific user that can be seen by more than that user.
* @member opensocial.Message.Type
*/
PUBLIC_MESSAGE : 'publicMessage'
};
/**
* Gets the message data that's associated with the specified key.
*
* @param {String} key The key to get data for;
* see the Field class
* for possible values
* @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* params
* to pass to the request.
* @return {String} The data
* @member opensocial.Message
*/
opensocial.Message.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
};
/**
* Sets data for this message associated with the given key.
*
* @param {String} key The key to set data for
* @param {String} data The data to set
*/
opensocial.Message.prototype.setField = function(key, data) {
return this.fields_[key] = data;
};
/*
* 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
* Represents images, movies, and audio.
* Create a MediaItem object using the
*
* opensocial.newMediaItem() method.
*
* @name opensocial.MediaItem
*/
/**
* Represents images, movies, and audio.
*
* @param {String} mimeType The media's type
* @param {String} url The media's location
* @param {Map.} opt_params
* Any other fields that should be set on the media item object.
* All of the defined Fields are supported.
* @constructor
* @private
*/
opensocial.MediaItem = function(mimeType, url, opt_params) {
this.fields_ = opt_params || {};
this.fields_[opensocial.MediaItem.Field.MIME_TYPE] = mimeType;
this.fields_[opensocial.MediaItem.Field.URL] = url;
};
/**
* @static
* @class
* The possible types of media items.
*
*
* See also:
*
* opensocial.MediaItem.Field
*
*
* @name opensocial.MediaItem.Type
*/
opensocial.MediaItem.Type = {
/** @member opensocial.MediaItem.Type */
IMAGE : 'image',
/** @member opensocial.MediaItem.Type */
VIDEO : 'video',
/** @member opensocial.MediaItem.Type */
AUDIO : 'audio'
}
/**
* @static
* @class
* All of the fields that media items have.
*
*
* See also:
*
* opensocial.MediaItem.getField()
*
*
* @name opensocial.MediaItem.Field
*/
opensocial.MediaItem.Field = {
/**
* The type of media, specified as a
*
* MediaItem.Type object.
* @member opensocial.MediaItem.Field
*/
TYPE : 'type',
/**
* The MIME type of media, specified as a String.
* @member opensocial.MediaItem.Field
*/
MIME_TYPE : 'mimeType',
/**
* A string specifying the URL where the media can be found.
* @member opensocial.MediaItem.Field
*/
URL : 'url'
};
/**
* Gets the media item data that's associated with the specified key.
*
* @param {String} key The key to get data for; see the
* Field class
* for possible values
* @return {String} The data
*/
opensocial.MediaItem.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
};
/**
* Sets data for this media item associated with the given key.
*
* @param {String} key The key to set data for
* @param {String} data The data to set
*/
opensocial.MediaItem.prototype.setField = function(key, data) {
return this.fields_[key] = data;
};
/**
* Copyright 2007 Fox Interactive Media
*
* @fileoverview Interface for container and associated classes; everything needed to query/update MySpace API data via OpenSocial interface.
*
* @author mnewbould [_at_] myspace [_dot_] com (Max Newbould)
* @author crussell [_at_] myspace [_dot_] com (Chad Russell)
* @author jreyes [_at_] myspace [_dot_] com (Jorge Reyes)
* @author jmay [_at_] myspace [_dot_] com (Justin May)
*/
if (typeof(MyOpenSpace) == "undefined")
/**
* Namespace for top level MyOpenSpace functions.
* @constructor (note: a constructor for JsDoc purposes)
*/
MyOpenSpace = { Version: "0.8" };
/**
* @internal
*/
MyOpenSpace.PrefetchParameters = { params_: {} };
/**
*
* @param {Object} key
* @param {Object} value
* @internal
*/
MyOpenSpace.PrefetchParameters.registerParam = function(key, value) {
this.params_[key] = value;
//gadgets.views.getParams()[key] = value;
};
/**
* @internal
*/
MyOpenSpace.PrefetchParameters.syncParams = function() {
for (var key in this.params_) {
if (typeof(gadgets.views.getParams()[key]) === "undefined") gadgets.views.getParams()[key] = this.params_[key];
}
};
/**
*
* @param {Object} key
* @internal
*/
MyOpenSpace.PrefetchParameters.getParam = function(key) {
if (typeof (gadgets.views.getParams()[key]) !== "undefined") {
return gadgets.views.getParams()[key];
} else {
return this.params_[key];
}
};
/**
* Defines the default page size for paginated requests.
* Used as max/default for MAX of pagination.
* @static
* @constant
*/
MyOpenSpace.DefaultPageSize = 20;
/**
* Defines the type of idSpec mapping value
* @static
* @class
* @name MyOpenSpace.IdSpecMapping_
* @constructor (note: a constructor for JsDoc purposes)
* @internal
*/
MyOpenSpace.IdSpecMapping_ = {
/**
* The idSpec mapping for viewer friends.
* @memberOf MyOpenSpace.IdSpecMapping_
* @constant
* @internal
*/
VIEWER_FRIENDS:"VIEWER_FRIENDS",
/**
* The idSpec mapping for owner friends.
* @memberOf MyOpenSpace.IdSpecMapping_
* @constant
* @internal
*/
OWNER_FRIENDS:"OWNER_FRIENDS",
/**
* The idSpec mapping for viewer.
* @memberOf MyOpenSpace.IdSpecMapping_
* @constant
* @internal
*/
VIEWER : "VIEWER",
/**
* The idSpec mapping for owner.
* @memberOf MyOpenSpace.IdSpecMapping_
* @constant
* @internal
*/
OWNER : "OWNER"
};
/**
* Enumerates the types of requests that can be made.
* It is used to retreive ResponseItems if opt_key was not
* set when adding the request.
*
* If more that one request of the same type is made, the first item can be retrieve
* directly using the enumeration value, the rest will have a "_#" postfix added
* to the enumeration value where # will be a sequential number starting with 1.
* @static
* @class
* @name MyOpenSpace.RequestType
* @example
* var container = MSID.Container.get();
* var request = this.container.newDataRequest();
* var fetchViewer = request.newFetchPersonRequest(opensocial.IdSpec.PersonId.VIEWER);
* var fetchOwner = request.newFetchPersonRequest(opensocial.IdSpec.PersonId.OWNER);
* request.add(fetchViewer); // opt_key not set
* request.add(fetchOwner); // opt_key not set
* request.send(callback);
* function callback(response){
* var viewer = response.get(MyOpenSpace.RequestType.FETCH_PERSON);
* var owner = response.get(MyOpenSpace.RequestType.FETCH_PERSON + “_1â€);
* }
*/
MyOpenSpace.RequestType = {
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.newFetchPerson.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PERSON:"FETCH_PERSON",
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.DataRequest.newFetchPeople.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PEOPLE:"FETCH_PEOPLE",
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.DataRequest.newFetchPersonAppDataRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PERSON_DATA:"FETCH_PERSON_DATA",
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.DataRequest.newFetchPersonAppDataRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
UPDATE_PERSON_DATA:"UPDATE_PERSON_DATA",
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.DataRequest.newRemovePersonAppDataRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
REMOVE_PERSON_DATA:"REMOVE_PERSON_DATA",
/**
* Default key to retreive the opensocial.ResponseItem from an
* opensocial.DataRequest.newFetchActivitiesRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_ACTIVITIES:"FETCH_ACTIVITIES",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchAlbumsRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_ALBUMS:"FETCH_ALBUMS",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchAlbumRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_ALBUM:"FETCH_ALBUM",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchVideosRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_VIDEOS:"FETCH_VIDEOS",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchVideoRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_VIDEO:"FETCH_VIDEO",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchPhotosRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PHOTOS:"FETCH_PHOTOS",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchPhotoRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PHOTO:"FETCH_PHOTO",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchIndicatorsRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_INDICATORS:"FETCH_INDICATORS",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchPersonStatusRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PERSON_STATUS:"FETCH_PERSON_STATUS",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newFetchPersonMoodRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PERSON_MOOD:"FETCH_PERSON_MOOD",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newPeopleFriendshipRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PEOPLE_FRIENDSHIP: "FETCH_PEOPLE_FRIENDSHIP",
/**
* Default key to retreive the opensocial.ResponseItem from a
* MyOpenSpace.DataRequest.newPersonFriendshipRequest.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
FETCH_PERSON_FRIENDSHIP: "FETCH_PERSON_FRIENDSHIP",
/**
* Default key to retreive the opensocial.ResponseItem for a
* notification request.
* @memberOf MyOpenSpace.RequestType
* @constant
*/
INSERT_NOTIFICATION: "INSERT_NOTIFICATION"
};
MyOpenSpace.RequestParameters = {
NO_TIMESTAMP: "noTimestamp"
};
/**
* @static
* @class
* A helper enum used for certain built-in media items.
* @name MyOpenSpace.MediaItemHelper
*/
MyOpenSpace.MediaItemHelper = {
/**
* The user's current profile picture
* @member MyOpenSpace.MediaItemHelper
*/
PROFILE_PICTURE : 'profilePicture'
};
/**
* @ignore
*/
MyOpenSpace.Util = {};
/**
* @ignore
*/
MyOpenSpace.Util.idSpecMap = function(idspec){
if(!idspec || !idspec.getField){
return {
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Invalid idSpec."
};
}
if(typeof(idspec.getField(opensocial.IdSpec.Field.USER_ID)) === "undefined"){
return {
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "USER_ID was not provided."
};
}
var userId = idspec.getField(opensocial.IdSpec.Field.USER_ID);
var networkDistance = 0;
if (typeof(idspec.getField(opensocial.IdSpec.Field.NETWORK_DISTANCE)) !== 'undefined') {
if (typeof(idspec.getField(opensocial.IdSpec.Field.NETWORK_DISTANCE)) !== 'number') {
return {
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "NETWORK_DISTANCE must be an integer."
};
}
networkDistance = idspec.getField(opensocial.IdSpec.Field.NETWORK_DISTANCE);
if (networkDistance < 0 || networkDistance > 1) {
return {
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "NETWORK_DISTANCE must be 0 or 1."
};
}
}
else if (typeof(idspec.getField(opensocial.IdSpec.Field.GROUP_ID)) !== 'undefined') {
var groupId = idspec.getField(opensocial.IdSpec.Field.GROUP_ID);
if (groupId === "FRIENDS"){
networkDistance = 1;
}
else if (groupId === "SELF"){
networkDistance = 0;
}
else{
return {
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "GROUP_ID is not valid accepted values are FRIENDS or SELF."};
}
}
if (userId === opensocial.IdSpec.PersonId.OWNER) {
if (networkDistance === 0) {
return MyOpenSpace.IdSpecMapping_.OWNER;
}
else if (networkDistance === 1) {
return MyOpenSpace.IdSpecMapping_.OWNER_FRIENDS;
}
}
else if (userId === opensocial.IdSpec.PersonId.VIEWER) {
if (networkDistance === 0) {
return MyOpenSpace.IdSpecMapping_.VIEWER;
}
else if (networkDistance === 1) {
return MyOpenSpace.IdSpecMapping_.VIEWER_FRIENDS;
}
}
else if (userId.constructor === Array) {
if (networkDistance > 0) {
return { "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED, "errorMessage": "NETWORK_DISTANCE greater than 0 is not been implemented for arrays of Ids." };
}
var idArray = [];
for (var i in userId) {
var results = MyOpenSpace.Util.parseIdPrefix(userId[i]);
if (results === null) {
return { "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "opensocial.IdSpec.Field.USER_ID array contains invalid elements." };
}
idArray[i] = results;
}
return idArray;
}
else {
var results = MyOpenSpace.Util.parseIdPrefix(userId);
if(null === results){
return { "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Invalid opensocial.IdSpec.Field.USER_ID value." };
}
return results;
}
};
MyOpenSpace.Util.parseIdPrefix = function(id){
var results = ('' + id).match(/^(?:myspace\.com:)?(\d+)$/);
if (results === null || results.length === 0) {
return null;
}
return results[1];
};/**
* Internal implementation of a simple hash table.
* @private
*/
MyOpenSpace.Hash = function(){
this._hash = {};
this._num = 0;
};
MyOpenSpace.Hash.prototype = {
_hash:null,
_num:null,
/**
* Add element to the hash
* @param {Object} key
* @param {Object} value
* @private
*/
add:function(key, value){
if (typeof key !== 'string') return;
if (!this.has(key)){
this._num++;
}
this._hash[key] = {
"value": value
};
},
/**
* Remove element from the hash
* @param {Object} key
* @private
*/
remove:function(key){
if (typeof key !== 'string') return;
var val = null;
if("undefined" !== typeof(this._hash[key])){
val = this._hash[key];
delete this._hash[key];
this._num--;
}
return val;
},
/**
*
* @param {Object} key
* @private
*/
get:function(key){
if (typeof key !== 'string') return undefined;
if (this.has(key)){
return this._hash[key].value;
}
else{
return undefined;
}
},
/**
* @private
*/
size:function(){
return this._num;
},
/**
*
* @param {Object} key
* @private
*/
has:function(key){
if (typeof key !== 'string') return false;
return "undefined" !== typeof(this._hash[key]);
}
};/**
* MySpace extension of the opensocial.Environment object.
* @constructor
* @param {Array} supportedPostToTargets A string array of supported PostTo targets
* @param {MyOpenSpace.Application} app An object representing the current application executing in the container
* @class
* @name MyOpenSpace.Environment
* @private
* @internal
*/
MyOpenSpace.Environment = function(supportedPostToTargets, app){
var supportedMapped = [];
for (var i in supportedPostToTargets) {
switch (supportedPostToTargets[i]){
case MyOpenSpace.PostTo.Targets.SEND_MESSAGE:
supportedMapped.push(opensocial.Message.Type.PRIVATE_MESSAGE);
break;
case MyOpenSpace.PostTo.Targets.BULLETINS:
supportedMapped.push(opensocial.Message.Type.NOTIFICATION);
break;
case MyOpenSpace.PostTo.Targets.COMMENTS:
supportedMapped.push(opensocial.Message.Type.PUBLIC_MESSAGE);
break;
default:
supportedMapped.push(supportedPostToTargets[i]);
break;
}
}
this.supportedPostToTargets = supportedMapped;
this.currentApplication = app;
};
/**
* Accessor for the supportedPostToTargets array
* @memberOf MyOpenSpace.Environment
* @private
*/
MyOpenSpace.Environment.prototype.getSupportedPostToTargets = function(){
return this.supportedPostToTargets;
};
/**
* Accessor for the current Application executing in the environment
* @memberOf MyOpenSpace.Environment
* @private
*/
MyOpenSpace.Environment.prototype.getApplication = function(){
return this.currentApplication;
};
/**
* The types of extended objects in this container.
* @static
* @class
* @name MyOpenSpace.Environment.ObjectType
*/
MyOpenSpace.Environment.ObjectType = {
/**
* @member MyOpenSpace.Environment.ObjectType
*/
VIDEO : "VIDEO",
/**
* @member MyOpenSpace.Environment.ObjectType
*/
PHOTO : "PHOTO",
/**
* @member MyOpenSpace.Environment.ObjectType
*/
ALBUM : "ALBUM",
/**
* @member MyOpenSpace.Environment.ObjectType
*/
PERSON : "PERSON"
};/* ================================================================
* MyOpenSpace.Indicators
* ================================================================
*/
/**
* A class representing an Indicators.
* @constructor
* @private
*/
MyOpenSpace.Indicators = function() {};
/**
* The fields for MyOpenSpace.Indicators
* @class
* @name MyOpenSpace.Indicators.Field
* @static
*/
MyOpenSpace.Indicators.Field = {
/**
* A boolean indicating the peroson has a mail.
* @memberOf MyOpenSpace.Indicators.Field
*/
MAIL:"MAIL",
/**
* A string containing the mail url.
* @memberOf MyOpenSpace.Indicators.Field
*/
MAIL_URL:"MAIL_URL",
/**
* A boolean indication the person has a birthday.
* @memberOf MyOpenSpace.Indicators.Field
*/
BIRTHDAY:"BIRTHDAY",
/**
* A string containing the birthday url.
* @memberOf MyOpenSpace.Indicators.Field
*/
BIRTHDAY_URL:"BIRTHDAY_URL",
/**
* A boolean indicating the person has a blog comment.
* @memberOf MyOpenSpace.Indicators.Field
*/
BLOG_COMMENT:"BLOG_COMMENT",
/**
* A string containing the blog comment url.
* @memberOf MyOpenSpace.Indicators.Field
*/
BLOG_COMMENT_URL:"BLOG_COMMENT_URL",
/**
* A boolean indicating the person has a blog subscrition post.
* @memberOf MyOpenSpace.Indicators.Field
*/
BLOG_SUBSCRIPTION_POST:"BLOG_SUBSCRIPTION_POST",
/**
* A string containing the blog subscription post url.
* @memberOf MyOpenSpace.Indicators.Field
*/
BLOG_SUBSCRIPTION_POST_URL:"BLOG_SUBSCRIPTION_POST_URL",
/**
* A boolean indicating the person has a comment.
* @memberOf MyOpenSpace.Indicators.Field
*/
COMMENT:"COMMENT",
/**
* A string containing the comment url.
* @memberOf MyOpenSpace.Indicators.Field
*/
COMMENT_URL:"COMMENT_URL",
/**
* A boolean indicating the person has a event invitation.
* @memberOf MyOpenSpace.Indicators.Field
*/
EVENT_INVITATION:"EVENT_INVITATION",
/**
* A string containing the event invitation url.
* @memberOf MyOpenSpace.Indicators.Field
*/
EVENT_INVITATION_URL:"EVENT_INVITATION_URL",
/**
* A boolean indicating the person has a friend request.
* @memberOf MyOpenSpace.Indicators.Field
*/
FRIEND_REQUEST:"FRIEND_REQUEST",
/**
* A string containing the friend request invitation url.
* @memberOf MyOpenSpace.Indicators.Field
*/
FRIEND_REQUEST_URL:"FRIEND_REQUEST_URL",
/**
* A boolean indicating the person has a group notification.
* @memberOf MyOpenSpace.Indicators.Field
*/
GROUP_NOTIFICATION:"GROUP_NOTIFICATION",
/**
* A string containing the group notification url.
* @memberOf MyOpenSpace.Indicators.Field
*/
GROUP_NOTIFICATION_URL:"GROUP_NOTIFICATION_URL",
/**
* A boolean indicating the person has a photo tag approval.
* @memberOf MyOpenSpace.Indicators.Field
*/
PHOTO_TAG_APPROVAL:"PHOTO_TAG_APPROVAL",
/**
* A string containing the photo tag approval url.
* @memberOf MyOpenSpace.Indicators.Field
*/
PHOTO_TAG_APPROVAL_URL:"PHOTO_TAG_APPROVAL_URL",
/**
* A boolean indicating the person has a picture comment.
* @memberOf MyOpenSpace.Indicators.Field
*/
PICTURE_COMMENT:"PICTURE_COMMENT",
/**
* A string containing the picture comment url.
* @memberOf MyOpenSpace.Indicators.Field
*/
PICTURE_COMMENT_URL:"PICTURE_COMMENT_URL",
/**
* A boolean indicating the person has a recently added friend.
* @memberOf MyOpenSpace.Indicators.Field
*/
RECENTLY_ADDED_FRIEND:"RECENTLY_ADDED_FRIEND",
/**
* A string containing the recently added friend url.
* @memberOf MyOpenSpace.Indicators.Field
*/
RECENTLY_ADDED_FRIEND_URL:"RECENTLY_ADDED_FRIEND_URL",
/**
* A boolean indicating the person has a video comment.
* @memberOf MyOpenSpace.Indicators.Field
*/
VIDEO_COMMENT:"VIDEO_COMMENT",
/**
* A string containing the video comment url.
* @memberOf MyOpenSpace.Indicators.Field
*/
VIDEO_COMMENT_URL:"VIDEO_COMMENT_URL",
/**
* A boolean indicating the person has a video process.
* @memberOf MyOpenSpace.Indicators.Field
*/
VIDEO_PROCESS:"VIDEO_PROCESS",
/**
* A string containing the video process url.
* @memberOf MyOpenSpace.Indicators.Field
*/
VIDEO_PROCESS_URL:"VIDEO_PROCESS_URL"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.Indicators || undefined} The indicators if found, nothing otherwise.
*/
MyOpenSpace.Indicators.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.Indicators.prototype.setField_ = function(key,val) { this[key] = val; };/**
* An extension of opensocial.Person
* @constructor
* @private
* @param {Array<opensocial.Person.Field || MyOpenSpace.Person.Field>} opt_params Contains an Array with opensocial.Person.Field or MyOpenSpace.Person.Field values with which to populate the object
* @param {Boolean} opt_isOwner Sets the person as the owner
* @param {Boolean} opt_isOwner Sets the person as the viewer
*/
MyOpenSpace.Person = function(opt_params, opt_isOwner, opt_isViewer) {
opensocial.Person.call(this, opt_params, opt_isOwner, opt_isViewer);
this["setField_"] = function(key,val) { this.fields_[key] = val; }; //TODO: find a better way to extend
this._type = 0;
};
/**
* The fields for the extended MyOpenSpace.Person
* @class
* @name MyOpenSpace.Person.Field
* @static
*/
MyOpenSpace.Person.Field = opensocial.Person.Field;
/**
* The URL of the medium version of the user's thumbnail
* @memberOf MyOpenSpace.Person.Field
*/
MyOpenSpace.Person.Field.MEDIUM_IMAGE = "mediumImage";
/**
* The URL of the large version of the user's thumbnail
* @memberOf MyOpenSpace.Person.Field
*/
MyOpenSpace.Person.Field.LARGE_IMAGE ="largeImage";
MyOpenSpace.Person.inherits(opensocial.Person);
/**
* A class representing an PersonMood.
* @constructor
* @private
*/
MyOpenSpace.PersonMood = function() {};
/**
* The fields for MyOpenSpace.PersonMood
* @class
* @name MyOpenSpace.PersonMood.Field
* @static
*/
MyOpenSpace.PersonMood.Field = {
/**
* A string indicating the person mood.
* @memberOf MyOpenSpace.PersonMood.Field
*/
MOOD:"MOOD",
/**
* A string indicating the person mood image url.
* @memberOf MyOpenSpace.PersonMood.Field
*/
MOOD_IMAGE_URL:"MOOD_IMAGE_URL",
/**
* A string indicating the last date time the mood was modified.
* @memberOf MyOpenSpace.PersonMood.Field
*/
MOOD_LAST_UPDATED:"MOOD_LAST_UPDATED"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.PersonMood || undefined} The PersonMood if found, nothing otherwise.
*/
MyOpenSpace.PersonMood.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.PersonMood.prototype.setField_ = function(key,val) { this[key] = val; };/**
* A class representing an PersonStatus.
* @constructor
* @private
*/
MyOpenSpace.PersonStatus = function() {};
/**
* The fields for MyOpenSpace.PersonStatus
* @class
* @name MyOpenSpace.PersonStatus.Field
* @static
*/
MyOpenSpace.PersonStatus.Field = {
/**
* A string indicating the person status.
* @memberOf MyOpenSpace.PersonStatus.Field
*/
STATUS:"STATUS"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.PersonStatus || undefined} The PersonStatus if found, nothing otherwise.
*/
MyOpenSpace.PersonStatus.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.PersonStatus.prototype.setField_ = function(key,val) { this[key] = val; };/**
* A class representing an FriendshipStatus.
* @constructor
* @private
*/
MyOpenSpace.Friendship = function() {};
/**
* The fields for MyOpenSpace.Friendship
* @class
* @name MyOpenSpace.Friendship.Field
* @static
*/
MyOpenSpace.Friendship.Field = {
/**
* A boolean indicating if the person is friend.
* @memberOf MyOpenSpace.Friendship.Field
*/
IS_FRIEND:"IS_FRIEND",
/**
* A string indicating the friend id.
* @memberOf MyOpenSpace.Friendship.Field
*/
FRIEND_ID:"FRIEND_ID"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.Friendship || undefined} The Frienship Field value if found, nothing otherwise.
*/
MyOpenSpace.Friendship.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.Friendship.prototype.setField_ = function(key,val) { this[key] = val; };/**
* Copyright 2007 Fox Interactive Media
*
* @fileoverview Interface for container and associated classes; everything needed to query/update MySpace API data via OpenSocial interface.
*
* @author mnewbould [_at_] myspace [_dot_] com (Max Newbould)
* @author crussell [_at_] myspace [_dot_] com (Chad Russell)
* @author jreyes [_at_] myspace [_dot_] com (Jorge Reyes)
*/
/**
* Maps JSON responses from the API into the various objects
* @class
* @constructor
* @name MyOpenSpace.DataMapper_
* @internal
*/
MyOpenSpace.DataMapper_ = function() {
this.mapData[MyOpenSpace.RequestType.FETCH_PEOPLE_FRIENDSHIP] = this.mapPeopleFriendship_;
this.mapData[MyOpenSpace.RequestType.FETCH_PERSON_FRIENDSHIP] = this.mapPersonFriendship_;
this.mapData[MyOpenSpace.RequestType.FETCH_PERSON] = this.mapPerson_;
this.mapData[MyOpenSpace.RequestType.FETCH_INDICATORS] = this.mapIndicators_;
this.mapData[MyOpenSpace.RequestType.FETCH_PERSON_STATUS] = this.mapPersonStatus_;
this.mapData[MyOpenSpace.RequestType.FETCH_PERSON_MOOD] = this.mapPersonMood_;
this.mapData[MyOpenSpace.RequestType.FETCH_PEOPLE] = this.mapPeople_;
this.mapData[MyOpenSpace.RequestType.FETCH_ALBUMS] = this.mapAlbums_;
this.mapData[MyOpenSpace.RequestType.FETCH_ALBUM] = this.mapAlbum_;
this.mapData[MyOpenSpace.RequestType.FETCH_VIDEOS] = this.mapVideos_;
this.mapData[MyOpenSpace.RequestType.FETCH_VIDEO] = this.mapVideo_;
this.mapData[MyOpenSpace.RequestType.FETCH_PHOTOS] = this.mapPhotos_;
this.mapData[MyOpenSpace.RequestType.FETCH_PHOTO] = this.mapPhoto_;
this.mapData[MyOpenSpace.RequestType.FETCH_PERSON_DATA] = this.mapPersonAppData_;
this.mapData[MyOpenSpace.RequestType.FETCH_ACTIVITIES] = this.mapActivities_;
this.mapData['mapSimplePersonData_'] = this.mapSimplePersonData_;
this.mapData['mapPersonData_'] = this.mapPersonData_;
};
MyOpenSpace.DataMapper_.prototype = {
/**
* Object that contains the mapping of MyOpenSpace.RequestType Enum element to the function that will
* map the server response data.
* @memberOf MyOpenSpace.DataMapper_
* @private
* @internal
*/
mapData: {},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Photo objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @memberOf MyOpenSpace.DataMapper_
* @internal
*/
mapPhotos_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var photos = [];
var photo;
var ns = MyOpenSpace.Photo.Field;
if (unmapped.photos) {
for (var i = 0; i < unmapped.photos.length; i++) {
photo = new MSID.Container.get().newPhoto();
photo.setField_(ns.PHOTO_ID, unmapped.photos[i].id);
photo.setField_(ns.PHOTO_URI, unmapped.photos[i].photoUri);
photo.setField_(ns.IMAGE_URI, unmapped.photos[i].imageUri);
photo.setField_(ns.CAPTION, unmapped.photos[i].caption);
//photo.setField_(ns.COMMENTS_COUNT,unmapped.photos[i].commentsCount);
photos.push(photo);
}
}
return MSID.Container.get().newCollection(photos, 0, unmapped.count);
},
/**
* Maps a server response into a MyOpenSpace.Photo object
* @function
* @return {MyOpenSpace.Photo}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPhoto_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var photo = new MSID.Container.get().newPhoto();
var ns = MyOpenSpace.Photo.Field;
if (unmapped) {
photo.setField_(ns.PHOTO_ID, unmapped.id);
photo.setField_(ns.PHOTO_URI, unmapped.photoUri);
photo.setField_(ns.IMAGE_URI, unmapped.imageUri);
photo.setField_(ns.CAPTION, unmapped.caption);
//photo.setField_(ns.COMMENTS_COUNT,unmapped.commentsCount);
}
return photo;
},
/**
* Maps a server response into a valid JSON Object.
* @function
* @return {Object}
* @param {XMLHttpRequest} obj The response from the server
* @param {opensocial.EscapeType}encoding Enum value to determine if the results will be html escape or not
* @internal
*/
mapPersonAppData_: function(obj, encoding) {
if(null === obj || "undefined" === typeof(obj)) return null;
var appDataXML = obj.responseXML;
if (null === appDataXML ||
"undefined" === typeof (appDataXML) ||
"undefined" === typeof(appDataXML.childNodes))
return null;
var userCount = appDataXML.childNodes.length;
var userNode = appDataXML.firstChild;
var userId;
var appDataNode;
var appDataCount = 0;
for (var i = 0; i < userNode.childNodes.length; i++) {
if ("userid" === userNode.childNodes[i].nodeName)
userId = userNode.childNodes[i].firstChild.nodeValue;
if ("appdata" === userNode.childNodes[i].nodeName)
appDataNode = userNode.childNodes[i];
if ("appdatafriends" === userNode.childNodes[i].nodeName)
appDataNode = userNode.childNodes[i];
}
i = 0;
var personAppData = {};
if ("appdatafriends" === appDataNode.nodeName) {
var friendId = 0;
var friendNode;
var friendAppDataNode;
for (var k = 0; k < appDataNode.childNodes.length; k++) {
friendNode = appDataNode.childNodes[k];
for (var m = 0; m < friendNode.childNodes.length; m++) {
if ("friendid" === friendNode.childNodes[m].nodeName) {
friendId = friendNode.childNodes[m].firstChild.nodeValue;
}
if ("appdata" === friendNode.childNodes[m].nodeName) {
friendAppDataNode = friendNode.childNodes[m];
}
}
personAppData[friendId] = {};
appDataCount = friendAppDataNode.getAttribute("count");
for (var j = 0; j < friendAppDataNode.childNodes.length; j++) {
personAppData[friendId][friendAppDataNode.childNodes[j].getAttribute("name")] = friendAppDataNode.childNodes[j].getAttribute("value");
}
}
} else {
personAppData[userId] = {};
appDataCount = appDataNode.getAttribute("count");
for (var i = 0; i < appDataNode.childNodes.length; i++) {
if ("key" === appDataNode.childNodes[i].nodeName) {
var dataKey = appDataNode.childNodes[i].getAttribute("name");
var dataValue = gadgets.json.parse(appDataNode.childNodes[i].getAttribute("value"));
if(!dataValue){
// for legacy 0.7 app data, which won't parse
dataValue = appDataNode.childNodes[i].getAttribute("value");
}
if (encoding !== opensocial.EscapeType.NONE) {
dataValue = gadgets.util.escape(dataValue, true);
}
personAppData[userId][dataKey] = dataValue;
}
}
}
return personAppData;
},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Album objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapAlbums_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var albums = [];
var album;
var ns = MyOpenSpace.Album.Field;
if (unmapped.albums) {
for (var i = 0; i < unmapped.albums.length; i++) {
album = new MSID.Container.get().newAlbum();
album.setField_(ns.ALBUM_ID, unmapped.albums[i].id);
album.setField_(ns.ALBUM_URI, unmapped.albums[i].albumUri);
album.setField_(ns.TITLE, unmapped.albums[i].title);
album.setField_(ns.LOCATION, unmapped.albums[i].location);
album.setField_(ns.DEFAULT_IMAGE, unmapped.albums[i].defaultImage);
album.setField_(ns.PRIVACY, unmapped.albums[i].privacy);
album.setField_(ns.PHOTO_COUNT, unmapped.albums[i].photoCount);
album.setField_(ns.PHOTOS_URI, unmapped.albums[i].photosUri);
albums.push(album);
}
}
return MSID.Container.get().newCollection(albums, 0, unmapped.count);
},
/**
* Maps a server response into a MyOpenSpace.Indicator object
* @function
* @return {MyOpenSpace.Indicators}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapIndicators_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var indicators = new MSID.Container.get().newIndicators();
var ns = MyOpenSpace.Indicators.Field;
if (unmapped) {
indicators.setField_(ns.MAIL, unmapped.mailurl ? true : false);
indicators.setField_(ns.MAIL_URL, unmapped.mailurl);
indicators.setField_(ns.BIRTHDAY, unmapped.birthdayurl ? true : false);
indicators.setField_(ns.BIRTHDAY_URL, unmapped.birthdayurl);
indicators.setField_(ns.BLOG_COMMENT, unmapped.blogcommenturl ? true : false);
indicators.setField_(ns.BLOG_COMMENT_URL, unmapped.blogcommenturl);
indicators.setField_(ns.BLOG_SUBSCRIPTION_POST, unmapped.blogsubscriptionposturl ? true : false);
indicators.setField_(ns.BLOG_SUBSCRIPTION_POST_URL, unmapped.blogsubscriptionposturl);
indicators.setField_(ns.COMMENT, unmapped.commenturl ? true : false);
indicators.setField_(ns.COMMENT_URL, unmapped.commenturl);
indicators.setField_(ns.EVENT_INVITATION, unmapped.eventinvitationurl ? true : false);
indicators.setField_(ns.EVENT_INVITATION_URL, unmapped.eventinvitationurl);
indicators.setField_(ns.FRIEND_REQUEST, unmapped.friendsrequesturl ? true : false);
indicators.setField_(ns.FRIEND_REQUEST_URL, unmapped.friendsrequesturl);
indicators.setField_(ns.GROUP_NOTIFICATION, unmapped.groupnotificationurl ? true : false);
indicators.setField_(ns.GROUP_NOTIFICATION_URL, unmapped.groupnotificationurl);
indicators.setField_(ns.PHOTO_TAG_APPROVAL, unmapped.phototagapprovalurl ? true : false);
indicators.setField_(ns.PHOTO_TAG_APPROVAL_URL, unmapped.phototagapprovalurl);
indicators.setField_(ns.PICTURE_COMMENT, unmapped.picturecommenturl ? true : false);
indicators.setField_(ns.PICTURE_COMMENT_URL, unmapped.picturecommenturl);
indicators.setField_(ns.RECENTLY_ADDED_FRIEND, unmapped.recentlyaddedfriendurl ? true : false);
indicators.setField_(ns.RECENTLY_ADDED_FRIEND_URL, unmapped.recentlyaddedfriendurl);
indicators.setField_(ns.VIDEO_COMMENT, unmapped.videocommenturl ? true : false);
indicators.setField_(ns.VIDEO_COMMENT_URL, unmapped.videocommenturl);
indicators.setField_(ns.VIDEO_PROCESS, unmapped.videoprocessurl ? true : false);
indicators.setField_(ns.VIDEO_PROCESS_URL, unmapped.videoprocessurl);
}
return indicators;
},
/**
* Maps a server response into a MyOpenSpace.PersonStatus object
* @function
* @return {MyOpenSpace.PersonStatus}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPersonStatus_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var personStatus = new MSID.Container.get().newPersonStatus();
var ns = MyOpenSpace.PersonStatus.Field;
if (unmapped) {
personStatus.setField_(ns.STATUS, unmapped.status);
}
return personStatus;
},
/**
* Maps a server response into a MyOpenSpace.PersonMood object
* @function
* @return {MyOpenSpace.PersonMood}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPersonMood_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var personMood = new MSID.Container.get().newPersonMood();
var ns = MyOpenSpace.PersonMood.Field;
if (unmapped) {
personMood.setField_(ns.MOOD, unmapped.mood);
personMood.setField_(ns.MOOD_IMAGE_URL, unmapped.moodImageUrl);
personMood.setField_(ns.MOOD_LAST_UPDATED, unmapped.moodLastUpdated);
}
return personMood;
},
/**
* Maps a server response into a MyOpenSpace.Album object
* @function
* @return {MyOpenSpace.Album}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapAlbum_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var album = new MSID.Container.get().newAlbum();
var ns = MyOpenSpace.Album.Field;
if (unmapped) {
album.setField_(ns.ALBUM_ID, unmapped.id);
album.setField_(ns.ALBUM_URI, unmapped.albumUri);
album.setField_(ns.TITLE, unmapped.title);
album.setField_(ns.LOCATION, unmapped.location);
album.setField_(ns.DEFAULT_IMAGE, unmapped.defaultImage);
album.setField_(ns.PRIVACY, unmapped.privacy);
album.setField_(ns.PHOTO_COUNT, unmapped.photoCount);
album.setField_(ns.PHOTOS_URI, unmapped.photosUri);
}
return album;
},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Friendship objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPersonFriendship_: function(obj) {
var unmapped;
try {
unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var friendship = new MSID.Container.get().newFriendship();
var ns = MyOpenSpace.Friendship.Field;
if (unmapped.friendship) {
friendship.setField_(ns.IS_FRIEND, unmapped.friendship[0].areFriends);
friendship.setField_(ns.FRIEND_ID, unmapped.friendship[0].friendId);
}
return friendship;
},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Friendship objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPeopleFriendship_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var friendships = [];
var ns = MyOpenSpace.Friendship.Field;
if (unmapped.friendship) {
for (var i = 0; i < unmapped.friendship.length; i++) {
var friendship = new MSID.Container.get().newFriendship();
friendship.setField_(ns.IS_FRIEND, unmapped.friendship[i].areFriends);
friendship.setField_(ns.FRIEND_ID, unmapped.friendship[i].friendId);
friendships.push(friendship);
}
}
return MSID.Container.get().newCollection(friendships, 0, friendships.length);
},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Video objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapVideos_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var videos = [];
var video;
var ns = MyOpenSpace.Video.Field;
if (unmapped.videos) {
for (var i = 0; i < unmapped.videos.length; i++) {
video = new MSID.Container.get().newVideo();
video.setField_(ns.VIDEO_ID, unmapped.videos[i].id);
video.setField_(ns.VIDEO_URI, unmapped.videos[i].videoUri);
video.setField_(ns.TITLE, unmapped.videos[i].title);
video.setField_(ns.DATE_CREATED, unmapped.videos[i].datecreated);
video.setField_(ns.LAST_UPDATE, unmapped.videos[i].dateupdated);
video.setField_(ns.MEDIA_TYPE, unmapped.videos[i].mediatype);
video.setField_(ns.THUMB_URI, unmapped.videos[i].thumbnail);
video.setField_(ns.DESCRIPTION, unmapped.videos[i].description);
video.setField_(ns.MEDIA_STATUS, unmapped.videos[i].mediastatus);
video.setField_(ns.RUN_TIME, unmapped.videos[i].runtime);
video.setField_(ns.TOTAL_VIEWS, unmapped.videos[i].totalviews);
video.setField_(ns.TOTAL_COMMENTS, unmapped.videos[i].totalcomments);
video.setField_(ns.TOTAL_RATING, unmapped.videos[i].totalrating);
video.setField_(ns.TOTAL_VOTES, unmapped.videos[i].totalvotes);
video.setField_(ns.COUNTRY, unmapped.videos[i].country);
video.setField_(ns.LANGUAGE, unmapped.videos[i].language);
videos.push(video);
}
}
return MSID.Container.get().newCollection(videos, 0, unmapped.count);
},
/**
* Maps a server response into a MyOpenSpace.Video object
* @function
* @return {MyOpenSpace.Video}
* @param {XMLHttpRequest} obj The response from the server
* @internal
* @private
*/
mapVideo_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var video = new MSID.Container.get().newVideo();
var ns = MyOpenSpace.Video.Field;
if (unmapped) {
video.setField_(ns.VIDEO_ID, unmapped.id);
video.setField_(ns.VIDEO_URI, unmapped.videoUri);
video.setField_(ns.TITLE, unmapped.title);
video.setField_(ns.DATE_CREATED, unmapped.datecreated);
video.setField_(ns.LAST_UPDATE, unmapped.dateupdated);
video.setField_(ns.MEDIA_TYPE, unmapped.mediatype);
video.setField_(ns.THUMB_URI, unmapped.thumbnail);
video.setField_(ns.DESCRIPTION, unmapped.description);
video.setField_(ns.MEDIA_STATUS, unmapped.mediastatus);
video.setField_(ns.RUN_TIME, unmapped.runtime);
video.setField_(ns.TOTAL_VIEWS, unmapped.totalviews);
video.setField_(ns.TOTAL_COMMENTS, unmapped.totalcomments);
video.setField_(ns.TOTAL_RATING, unmapped.totalrating);
video.setField_(ns.TOTAL_VOTES, unmapped.totalvotes);
video.setField_(ns.COUNTRY, unmapped.country);
video.setField_(ns.LANGUAGE, unmapped.language);
}
return video;
},
/**
* Maps a server response into a opensocial.Collection of MyOpenSpace.Person objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
* @private
*/
mapPeople_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
var friends = [];
var person;
var unmappedData;
if (typeof (unmapped.users) !== 'undefined') {
unmappedData = [];
for (var j in unmapped.users) {
unmappedData[j] = {
"id": "myspace.com:" + unmapped.users[j].userId,
"nickname": unmapped.users[j].name,
"thumbnailUrl": unmapped.users[j].image,
"profileUrl": unmapped.users[j].webUri
};
}
}
else if (typeof (unmapped.entry) === 'undefined') {
return MSID.Container.get().newCollection([], 0, 0);
}
else if (unmapped.entry.constructor == Array) {
unmappedData = unmapped.entry;
}
else {
unmappedData = [unmapped.entry];
}
var person;
var friends = [];
for (var i in unmappedData) {
person = this.mapSimplePersonData_(unmappedData[i]);
friends[i] = person;
}
var startIndex = 0;
if (typeof (unmapped.startIndex) != 'undefined' && typeof (unmapped.itemsPerPage) != 'undefined') {
startIndex = ((unmapped.startIndex - 1) * unmapped.itemsPerPage) + 1;
}
return MSID.Container.get().newCollection(friends, startIndex, unmapped.totalResults);
},
/**
* Maps server response data object to a MyOpenSpace.Person object filling ID, Thumbnail,
* nickname, profileUrl and name fiedls
* @function
* @return {MyOpenSpace.Person}
* @param {Object} unmappedData The response person object from the server
* @internal
*/
mapSimplePersonData_: function(unmappedData) {
var isOwner = false;
var isViewer = false;
if (typeof (unmappedData.id) !== 'undefined') {
var id = unmappedData.id.split(":")[1];
var viewerId = gadgets.views.getParams().viewerId;
var ownerId = gadgets.views.getParams().ownerId;
isOwner = (id === ownerId);
isViewer = (id === viewerId);
}
var person = new MSID.Container.get().newPerson(null, isOwner, isViewer);
var ns = opensocial.Person.Field;
/**
* Generic method Populates person field specify by personField if obj is different from undefined.
* @param {Object} personField Field to map.
* @param {Object} obj Data to map
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapGeneric = function(personField, obj, explicitPerson) {
if (typeof (obj) === 'undefined') return;
var personObject = person || explicitPerson;
personObject.setField_(personField, obj);
};
/**
* Populates person HAS_APP field if hasApp parameter is present.
* @param {Object} hasApp Value to map.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapHasApp = function(hasApp, explicitPerson) {
if (typeof (hasApp) === 'undefined') return;
var personObject = person || explicitPerson;
var hasAppObj = (('' + hasApp).toLowerCase() === 'true');
personObject.setField_(ns.HAS_APP, hasAppObj);
};
/**
* Populates person Name field with the information provided in name, familyName, givenName.
* @param {Object} name Display name
* @param {Object} familyName Family name
* @param {Object} givenName Given Name
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapName = function(name, familyName, givenName, explicitPerson) {
if (typeof (name) === 'undefined' && typeof (familyName) === 'undefined' && typeof (givenName) === 'undefined') return;
var personObject = person || explicitPerson;
var nameParams = {};
if (typeof (name) !== 'undefined') nameParams[opensocial.Name.Field.UNSTRUCTURED] = name;
if (typeof (givenName) !== 'undefined') nameParams[opensocial.Name.Field.GIVEN_NAME] = givenName;
if (typeof (familyName) !== 'undefined') nameParams[opensocial.Name.Field.FAMILY_NAME] = familyName;
var personName = new opensocial.Name(nameParams);
personObject.setField_(ns.NAME, personName);
};
mapGeneric(ns.ID, unmappedData.id);
mapGeneric(ns.THUMBNAIL_URL, unmappedData.thumbnailUrl);
mapGeneric(ns.NICKNAME, unmappedData.nickname);
mapGeneric(ns.PROFILE_URL, unmappedData.profileUrl);
mapName(unmappedData.displayName, unmappedData.familyName, unmappedData.givenName);
mapHasApp(unmappedData.hasApp || unmappedData.hasAppInstalled);
return person;
},
/**
* Maps a server response data object to a MyOpenSpace.Person object
* @function
* @return {MyOpenSpace.Person}
* @param {Object} The response person object from the server
* @internal
*/
mapPersonData_: function(unmappedData) {
var person = this.mapSimplePersonData_(unmappedData);
var ns = opensocial.Person.Field;
var mns = MyOpenSpace.Person.Field;
/**
* Generic method Populates person field specify by personField if obj is different from undefined.
* @param {Object} personField Field to map.
* @param {Object} obj data to map
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapGeneric = function(personField, obj, explicitPerson) {
if (typeof (obj) === 'undefined') return;
var personObject = person || explicitPerson;
personObject.setField_(personField, obj);
};
/**
* Populates BODY_TYPE person field if bodyType is different from undefined.
* @param {Object} bodyType Body type value.
* @param {Object} explicitPerson pPerson object to use. If undefined the default person object will be used.
* @internal
*/
var mapBodyType = function(bodyType, explicitPerson) {
if (typeof (bodyType) === 'undefined') return;
var personObject = person || explicitPerson;
var bodyTypeParams = {};
bodyTypeParams[opensocial.BodyType.Field.BUILD] = bodyType.build;
bodyTypeParams[opensocial.BodyType.Field.HEIGHT] = bodyType.height;
var bodyTypeObj = new opensocial.BodyType(bodyTypeParams);
personObject.setField_(ns.BODY_TYPE, bodyTypeObj);
};
/**
* Populates CURRENT_LOCATION person field if currentLocation is different from undefined.
* @param {Object} currentLocation Current location value.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapCurrentLocation = function(currentLocation, explicitPerson) {
if (typeof (currentLocation) === 'undefined') return;
var personObject = person || explicitPerson;
var addressParams = {};
addressParams[opensocial.Address.Field.REGION] = currentLocation.region;
addressParams[opensocial.Address.Field.POSTAL_CODE] = currentLocation.postalCode;
addressParams[opensocial.Address.Field.COUNTRY] = currentLocation.country;
var currentLocationObj = new opensocial.Address(addressParams);
personObject.setField_(ns.CURRENT_LOCATION, currentLocationObj);
};
/**
* Populates DATE_OF_BIRTH person field if dateOfBirth is different from undefined.
* The date should be formatted yyyy-MM-ddTHH:mm:ss-00:00:00
* @param {Object} dateOfBirth Formated date of birth value.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapDateOfBirth = function(dateOfBirth, explicitPerson) {
if (typeof (dateOfBirth) === 'undefined') return;
var personObject = person || explicitPerson;
var dateOfBirthObj = new Date();
dateOfBirthObj.setDate(dateOfBirth.substr(8, 2));
dateOfBirthObj.setMonth(dateOfBirth.substr(5, 2) - 1);
dateOfBirthObj.setFullYear(dateOfBirth.substr(0, 4));
dateOfBirthObj.setHours(0);
dateOfBirthObj.setMinutes(0);
dateOfBirthObj.setSeconds(0);
dateOfBirthObj.setMilliseconds(0);
personObject.setField_(ns.DATE_OF_BIRTH, dateOfBirthObj);
};
/**
* Populates DRINKER person field if drinker is different from undefined.
* @param {Object} drinker Drinker value object.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapDrinker = function(drinker, explicitPerson) {
if (typeof (drinker) === 'undefined') return;
if (typeof (drinker.key) === 'undefined' && drinker.value === 'undefined') return;
var personObject = person || explicitPerson;
var drinkerKey = null;
var drinkerValue = drinker.value;
if (drinker.key !== null && typeof (drinker.key) !== 'undefined') {
if (drinker.key.toLowerCase() === 'yes') drinkerKey = opensocial.Enum.Drinker.YES;
else if (drinker.key.toLowerCase() === 'no') drinkerKey = opensocial.Enum.Drinker.NO;
else if (drinker.key.toLowerCase() === 'heavily') drinkerKey = opensocial.Enum.Drinker.HEAVILY;
else if (drinker.key.toLowerCase() === 'occasionally') drinkerKey = opensocial.Enum.Drinker.OCCASIONALLY;
else if (drinker.key.toLowerCase() === 'quit') drinkerKey = opensocial.Enum.Drinker.QUIT;
else if (drinker.key.toLowerCase() === 'quitting') drinkerKey = opensocial.Enum.Drinker.QUITTING;
else if (drinker.key.toLowerCase() === 'regularly') drinkerKey = opensocial.Enum.Drinker.REGULARLY;
else if (drinker.key.toLowerCase() === 'socially') drinkerKey = opensocial.Enum.Drinker.SOCIALLY;
};
personObject.setField_(ns.DRINKER, new opensocial.Enum(drinkerKey, drinkerValue));
};
/**
* Populates GENDER person field if gender is different from undefined.
* @param {Object} gender Gender value object
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapGender = function(gender, explicitPerson) {
if (typeof (gender) === 'undefined') return;
var personObject = person || explicitPerson;
var genderObj;
if (gender.toLowerCase() === "male") genderObj = opensocial.Enum.Gender.MALE;
else if (gender.toLowerCase() === "female") genderObj = opensocial.Enum.Gender.FEMALE;
if (typeof (genderObj) !== 'undefined')
personObject.setField_(ns.GENDER, new opensocial.Enum(genderObj, genderObj));
};
/**
* Populates JOBS person field if jobs is different from undefined.
* @param {Object} jobs Array of jobs objects to map.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapJobs = function(jobs, explicitPerson) {
if (typeof (jobs) === 'undefined') return;
var personObject = person || explicitPerson;
var jobsObj = [];
for (var i in jobs) {
var organizationParams = {};
organizationParams[opensocial.Organization.Field.NAME] = jobs[i].name;
organizationParams[opensocial.Organization.Field.TITLE] = jobs[i].title;
jobsObj[i] = new opensocial.Organization(organizationParams);
}
personObject.setField_(ns.JOBS, jobsObj);
};
/**
* Populates NETWORK_PRESENCE person field if networkPresence is different from undefined.
* @param {Object} networkPresence Network presence value object
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapNetworkPresence = function(networkPresence, explicitPerson) {
if (typeof (networkPresence) === 'undefined') return;
if (typeof (networkPresence.key) === 'undefined' && typeof (networkPresence.value) === 'undefined') return;
var personObject = person || explicitPerson;
var networkPresenceKey = null;
var networkValue = networkPresence.value;
if (networkPresence.key != null && typeof (networkPresence.key) !== 'undefined') {
if (networkPresence.key.toLowerCase() === 'offline') networkPresenceKey = opensocial.Enum.Presence.OFFLINE;
else if (networkPresence.key.toLowerCase() === 'online') networkPresenceKey = opensocial.Enum.Presence.ONLINE;
else if (networkPresence.key.toLowerCase() === 'away') networkPresenceKey = opensocial.Enum.Presence.AWAY;
else if (networkPresence.key.toLowerCase() === 'chat') networkPresenceKey = opensocial.Enum.Presence.CHAT;
else if (networkPresence.key.toLowerCase() === 'dnd') networkPresenceKey = opensocial.Enum.Presence.DND;
else if (networkPresence.key.toLowerCase() === 'xa') networkPresenceKey = opensocial.Enum.Presence.XA;
}
personObject.setField_(ns.NETWORK_PRESENCE, new opensocial.Enum(networkPresenceKey, networkValue));
};
/**
* Populates PROFILE_SONG person field if profileSong is different from undefined.
* @param {Object} profileSong Profile song value.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapProfileSong = function(profileSong, explicitPerson) {
if (typeof (profileSong) === 'undefined') return;
var personObject = person || explicitPerson;
var urlParams = {};
urlParams[opensocial.Url.Field.LINK_TEXT] = profileSong;
var urlObj = new opensocial.Url(urlParams);
personObject.setField_(ns.PROFILE_SONG, urlObj);
};
/**
* Populates LOOKING_FOR person field if lookingFor is different from undefined.
* @param {Object} lookingFor Looking for value.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapLookingFor = function(lookingFor, explicitPerson) {
if (typeof (lookingFor) === 'undefined') return;
var personObject = person || explicitPerson;
personObject.setField_(ns.LOOKING_FOR, new opensocial.Enum(null, lookingFor));
};
/**
* Populates SMOKER person field if smoker is different from undefined.
* @param {Object} smoker smoker value object.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapSmoker = function(smoker, explicitPerson) {
if (typeof (smoker) === 'undefined') return;
if (typeof (smoker.key) === 'undefined' && somoker.value === 'undefined') return;
var personObject = person || explicitPerson;
var smokerKey = null;
var smokerValue = smoker.value;
if (smoker.key !== null && typeof (smoker.key) !== 'undefined') {
if (smoker.key.toLowerCase() === 'heavily') smokerKey = opensocial.Enum.Smoker.HEAVILY;
else if (smoker.key.toLowerCase() === 'no') smokerKey = opensocial.Enum.Smoker.NO;
else if (smoker.key.toLowerCase() === 'occasionally') smokerKey = opensocial.Enum.Smoker.OCCASIONALLY;
else if (smoker.key.toLowerCase() === 'quit') smokerKey = opensocial.Enum.Smoker.QUIT;
else if (smoker.key.toLowerCase() === 'quitting') smokerKey = opensocial.Enum.Smoker.QUITTING;
else if (smoker.key.toLowerCase() === 'regularly') smokerKey = opensocial.Enum.Smoker.REGULARLY;
else if (smoker.key.toLowerCase() === 'socially') smokerKey = opensocial.Enum.Smoker.SOCIALLY;
else if (smoker.key.toLowerCase() === 'yes') smokerKey = opensocial.Enum.Smoker.YES;
}
personObject.setField_(ns.SMOKER, new opensocial.Enum(smokerKey, smokerValue));
};
/**
* Populates URLS person field if urls is different from undefined.
* @param {Object} urls Array of urls objects.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapUrls = function(urls, explicitPerson) {
if (typeof (urls) === 'undefined') return;
var personObject = person || explicitPerson;
var urlsObj = [];
for (var i in urls) {
var urlParams = {};
urlParams[opensocial.Url.Field.ADDRESS] = urls[i].value;
urlParams[opensocial.Url.Field.TYPE] = urls[i].type;
urlsObj[i] = new opensocial.Url(urlParams);
}
personObject.setField_(ns.URLS, urlsObj);
};
/**
* Populates the MySpace LARGE_IMAGE and MEDIUM_IMAGE extensions fields if photos is different from undefined.
* @param {Object} photos photos value object.
* @param {Object} explicitPerson Person object to use. If undefined the default person object will be used.
* @internal
*/
var mapPhotos = function(photos, explicitPerson) {
if (typeof (photos) === 'undefined') return;
var personObject = person || explicitPerson;
var image;
var urlParams;
for (var i in photos) {
var type = photos[i].type;
var val = photos[i].value;
if (type === 'medium' && typeof (val) !== 'undefined') {
urlParams = {};
urlParams[opensocial.Url.Field.ADDRESS] = val;
urlParams[opensocial.Url.Field.TYPE] = 'medium image';
personObject.setField_(mns.MEDIUM_IMAGE, new opensocial.Url(urlParams));
}
else if (type === 'large' && typeof (val) !== 'undefined') {
urlParams = {};
urlParams[opensocial.Url.Field.ADDRESS] = val;
urlParams[opensocial.Url.Field.TYPE] = 'large image';
personObject.setField_(mns.LARGE_IMAGE, new opensocial.Url(urlParams));
}
}
}
var addressns = opensocial.Address.Field;
mapGeneric(ns.ABOUT_ME, unmappedData.aboutMe);
mapGeneric(ns.AGE, unmappedData.age);
mapBodyType(unmappedData.bodyType);
mapGeneric(ns.BOOKS, unmappedData.books);
mapGeneric(ns.CHILDREN, unmappedData.children);
mapCurrentLocation(unmappedData.currentLocation);
mapDateOfBirth(unmappedData.dateOfBirth);
mapDrinker(unmappedData.drinker);
mapGeneric(ns.ETHNICITY, unmappedData.ethnicity);
mapGender(unmappedData.gender);
mapGeneric(ns.HEROES, unmappedData.heroes);
mapGeneric(ns.INTERESTS, unmappedData.interests);
mapJobs(unmappedData.organizations);
mapGeneric(ns.MOVIES, unmappedData.movies);
mapGeneric(ns.MUSIC, unmappedData.music);
mapNetworkPresence(unmappedData.networkPresence);
mapLookingFor(unmappedData.lookingFor);
mapProfileSong(unmappedData.profileSong);
mapGeneric(ns.RELATIONSHIP_STATUS, unmappedData.relationshipStatus);
mapGeneric(ns.RELIGION, unmappedData.religion);
mapGeneric(ns.SEXUAL_ORIENTATION, unmappedData.sexualOrientation);
mapSmoker(unmappedData.smoker);
mapGeneric(ns.STATUS, unmappedData.status);
mapGeneric(ns.TV_SHOWS, unmappedData.tvShows);
mapUrls(unmappedData.urls);
//MySpace Extensions
mapPhotos(unmappedData.photos);
return person;
},
/**
* Maps a server response into a MyOpenSpace.Person object
* @function
* @return {MyOpenSpace.Person}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapPerson_: function(obj) {
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
if (typeof (unmapped) === 'undefined') return null;
if (false === unmapped && !obj.responseText && Object === obj.constructor) unmapped = obj;
if (typeof (unmapped.entry) === 'undefined' && typeof (unmapped.users) === 'undefined') return null;
if (typeof (unmapped.users) !== 'undefined') {
unmappedData = {
"id": "myspace.com:" + unmapped.users[0].userId,
"nickname": unmapped.users[0].name,
"thumbnailUrl": unmapped.users[0].image,
"displayName": unmapped.users[0].name,
"profileUrl": unmapped.users[0].webUri
};
}
else {
unmappedData = unmapped.entry[0] || unmapped.entry;
}
return this.mapPersonData_(unmappedData);
},
/**
* Maps a server response into a opensocial.Collection of opensocial.Activity objects
* @function
* @return {opensocial.Collection}
* @param {XMLHttpRequest} obj The response from the server
* @internal
*/
mapActivities_: function(obj) {
if (!obj) {
return null;
}
if (obj && (!obj.responseText || obj.responseText.length < 1)) {
return MSID.Container.get().newCollection([], 0, 0);
}
try {
var unmapped = gadgets.json.parse(obj.responseText);
}
catch (err) {
return null;
}
if (!unmapped) {
return null;
}
var activities = [];
var activity;
var ns = opensocial.Activity.Field;
if (unmapped.entry) {
for (var i = 0; i < unmapped.entry.length; i++) {
activity = new MSID.newActivity();
activity.setField(ns.APP_ID, unmapped.entry[i].appId);
activity.setField(ns.USER_ID, unmapped.entry[i].userId);
activity.setField(ns.BODY, unmapped.entry[i].body);
activity.setField(ns.POSTED_TIME, unmapped.entry[i].postedTime);
activity.setField(ns.STREAM_FAVICON_URL, unmapped.entry[i].streamFavIconUrl);
activity.setField(ns.TITLE, unmapped.entry[i].title);
activity.setField(ns.TITLE_ID, unmapped.entry[i].titleId);
activities.push(activity);
}
}
return MSID.Container.get().newCollection(activities, 0, unmapped.count);
}
};/**
* Just a place-holder in order to extend MyOpenSpace.PostTo
* @constructor
*/
MyOpenSpace.PostTo = {};
/**
* Enumerates the targets for PostTo
* @static
* @class
* @internal
* @name MyOpenSpace.PostTo.Targets
*/
MyOpenSpace.PostTo.Targets = {
/**
* A user's profile, the specific section is specified on the Post To UI
* @memberOf MyOpenSpace.PostTo.Targets
*/
PROFILE:"PROFILE",
/**
* A message to another user's inbox
* @memberOf MyOpenSpace.PostTo.Targets
*/
SEND_MESSAGE:"SEND_MESSAGE",
/**
* A user's comments
* @memberOf MyOpenSpace.PostTo.Targets
*/
COMMENTS:"COMMENTS",
/**
* A user's bulletins
* @memberOf MyOpenSpace.PostTo.Targets
*/
BULLETINS:"BULLETINS",
/**
* A user's blog
* @memberOf MyOpenSpace.PostTo.Targets
*/
BLOG:"BLOG",
/**
* Request to share an app with another user
* @memberOf MyOpenSpace.PostTo.Targets
*/
SHARE_APP:"SHARE_APP",
/**
* Request to send a one to many notification
* @memberOf MyOpenSpace.PostTo.Targets
*/
ACTIVITY: "ACTIVITY",
/**
* Request to upload photos
* @memberOf MyOpenSpace.PostTo.Targets
*/
PHOTOS: "PHOTOS"
};
/**
* Enumerates the PostTo result
* @static
* @class
* @name MyOpenSpace.PostTo.Result
*/
MyOpenSpace.PostTo.Result = {
/**
* An error occurred in postTo request
* @memberOf MyOpenSpace.PostTo.Result
*/
ERROR: -1,
/**
* User pressed cancel before completion
* @memberOf MyOpenSpace.PostTo.Result
*/
CANCELLED: 0,
/**
* Successful postTo request completed
* @memberOf MyOpenSpace.PostTo.Result
*/
SUCCESS: 1
};
/**
* A class representing a video.
* @constructor
* @private
*/
MyOpenSpace.Video = function() {};
/**
* The fields for MyOpenSpace.Video
* @class
* @name MyOpenSpace.Video.Field
* @static
*/
MyOpenSpace.Video.Field = {
/**
* A number representing a Video's unique identifier.
* @memberOf MyOpenSpace.Video.Field
*/
VIDEO_ID:"VIDEO_ID",
/**
* The RESTFUL URI with which to access the video on the API.
* @memberOf MyOpenSpace.Video.Field
*/
VIDEO_URI:"VIDEO_URI",
/**
* The video's title.
* @memberOf MyOpenSpace.Video.Field
*/
TITLE:"TITLE",
/**
* The date the video was created.
* @memberOf MyOpenSpace.Video.Field
*/
DATE_CREATED:"DATE_CREATED",
/**
* The date the video was last updated.
* @memberOf MyOpenSpace.Video.Field
*/
LAST_UPDATE:"LAST_UPDATE",
/**
* An integer representing the media type for this video.
* @memberOf MyOpenSpace.Video.Field
*/
MEDIA_TYPE:"MEDIA_TYPE",
/**
* A URL for the thumbnail image associated with this video.
* @memberOf MyOpenSpace.Video.Field
*/
THUMB_URI:"THUMB_URI",
/**
* A description of the video.
* @memberOf MyOpenSpace.Video.Field
*/
DESCRIPTION:"DESCRIPTION",
/**
* The current status of the video, such as "ProcessingFailed"
* @memberOf MyOpenSpace.Video.Field
*/
MEDIA_STATUS:"MEDIA_STATUS",
/**
* The length of the video.
* @memberOf MyOpenSpace.Video.Field
*/
RUN_TIME:"RUN_TIME",
/**
* An integer representing the number of views the video has currently received.
* @memberOf MyOpenSpace.Video.Field
*/
TOTAL_VIEWS:"TOTAL_VIEWS",
/**
* An integer representing the number of comments the video has currently received.
* @memberOf MyOpenSpace.Video.Field
*/
TOTAL_COMMENTS:"TOTAL_COMMENTS",
/**
* An integer representing the rating the video has currently received.
* @memberOf MyOpenSpace.Video.Field
*/
TOTAL_RATING:"TOTAL_RATING",
/**
* An integer representing the number of votes the video has currently received.
* @memberOf MyOpenSpace.Video.Field
*/
TOTAL_VOTES:"TOTAL_VOTES",
/**
* A string representing the video's country, in terms of identifying culture, not necessarily geographic location.
* @memberOf MyOpenSpace.Video.Field
*/
COUNTRY:"COUNTRY",
/**
* A string representing the video's language.
* @memberOf MyOpenSpace.Video.Field
*/
LANGUAGE:"LANGUAGE"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.Video || undefined} The video if found, nothing otherwise.
*/
MyOpenSpace.Video.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.Video.prototype.setField_ = function(key,val) { this[key] = val; };/* ================================================================
* MyOpenSpace.Album
* ================================================================
*/
/**
* A class representing an album.
* @constructor
* @private
* @name MyOpenSpace.Album
*/
MyOpenSpace.Album = function() {};
/**
* The fields for MyOpenSpace.Album
* @class
* @name MyOpenSpace.Album.Field
* @static
*/
MyOpenSpace.Album.Field = {
/**
* A number representing an Album's unique identifier.
* @memberOf MyOpenSpace.Album.Field
*/
ALBUM_ID:"ALBUM_ID",
/**
* The RESTFUL URI with which to access the album on the API.
* @memberOf MyOpenSpace.Album.Field
*/
ALBUM_URI:"ALBUM_URI",
/**
* The album's title.
* @memberOf MyOpenSpace.Album.Field
*/
TITLE:"TITLE",
/**
* The geographic location where the album's pictures were taken.
* @memberOf MyOpenSpace.Album.Field
*/
LOCATION:"LOCATION",
/**
* A URL for the album's default image.
* @memberOf MyOpenSpace.Album.Field
*/
DEFAULT_IMAGE:"DEFAULT_IMAGE",
/**
* A string representing the album's privacy setting, such as "Public" or "Private"
* @memberOf MyOpenSpace.Album.Field
*/
PRIVACY:"PRIVACY",
/**
* An integer representing the total number of photos in the album (not the number of photos actually contained within the current object).
* @memberOf MyOpenSpace.Album.Field
*/
PHOTO_COUNT:"PHOTO_COUNT",
/**
* A RESTFUL URI with which to access the photos contained in the album.
* @memberOf MyOpenSpace.Album.Field
*/
PHOTOS_URI:"PHOTOS_URI"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.Album || undefined} The album if found, nothing otherwise.
*/
MyOpenSpace.Album.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.Album.prototype.setField_ = function(key,val) { this[key] = val; };/**
* A class representing a photo.
* @constructor
* @private
*/
MyOpenSpace.Photo = function() {};
/**
* The fields for MyOpenSpace.Photo
* @class
* @name MyOpenSpace.Photo.Field
* @static
*/
MyOpenSpace.Photo.Field = {
/**
* A number representing a Photo's unique identifier.
* @memberOf MyOpenSpace.Photo.Field
*/
PHOTO_ID:"PHOTO_ID",
/**
* The RESTFUL URI with which to access the photo on the API.
* @memberOf MyOpenSpace.Photo.Field
*/
PHOTO_URI:"PHOTO_URI",
/**
* The URL of the photo.
* @memberOf MyOpenSpace.Photo.Field
*/
IMAGE_URI:"IMAGE_URI",
/**
* The photo's caption.
* @memberOf MyOpenSpace.Photo.Field
*/
CAPTION:"CAPTION"
};
/**
* Returns the field specified by key
* @param {String} key The key to search by
* @return {MyOpenSpace.Photo || undefined} The photo if found, nothing otherwise.
*/
MyOpenSpace.Photo.prototype.getField = function(key) { return this[key]; };
/**
* Writes a value to the field specified by the key
* @param {String} key The key to search by.
* @param {String} val The value to set.
* @private
* @internal
*/
MyOpenSpace.Photo.prototype.setField_ = function(key,val) { this[key] = val; };//------------------------------------------//
// Non namespaced global functions below
//------------------------------------------//
/**
* @ignore
*/
Function.prototype.inherits = function(parentCtor) {
function tempCtor() {};
tempCtor.prototype = parentCtor.prototype;
this.superClass_ = parentCtor.prototype;
this.prototype = new tempCtor();
this.prototype.constructor = this;
};
/**
* @ignore
* debugging utilities - reflect through an object's properties and trace values
*/
function reflect(obj, opt_dept, opt_currentDept){
opt_dept = (opt_dept == undefined) ? 0 : opt_dept;
opt_currentDept = (opt_currentDept == undefined) ? 0 : opt_currentDept;
//trace(obj);
if (typeof(obj) == "object"){
for (var i in obj){
var levelPrefix = '';
for (var j = 0; j < opt_currentDept + 1; j++){
levelPrefix += " "
}
trace( levelPrefix + i + " -> " + obj[i] + "\n");
if (typeof(obj[i]) == "object"){
if (opt_dept > opt_currentDept){
reflect(obj[i], opt_dept, opt_currentDept + 1);
}
}
}
}
}
var batchTrace = "";
/**
* @ignore
*/
function tracePublicMembers(obj, propertyDepth) {
propertyDepth = propertyDepth || 0;
for (var prop in obj) {
if (typeof(obj[prop]) == "function") return;
if (typeof(obj[prop]) == "object")
{
traceIndent(propertyDepth);
dumpToBatch("" + prop + "
", propertyDepth);
tracePublicMembers(obj[prop], propertyDepth+1);
}
else
{
if (prop.substring(prop.length-3) != "___") {
traceIndent(propertyDepth);
dumpToBatch("" + prop + ": " + obj[prop] + "
", propertyDepth);
}
}
}
if (propertyDepth == 0) flushBatchTrace();
}
/**
* @ignore
*/
function flushBatchTrace() {
trace(batchTrace);
batchTrace="";
}
/**
* @ignore
*/
function dumpToBatch(msg, depth) {
if (depth == 0) {
batchTrace = msg + batchTrace;
}
else
{
batchTrace += msg;
}
}
/**
* @ignore
*/
function traceIndent(depth) {
if (depth>0) {
dumpToBatch("|", depth);
for (var i = 0;i", depth);
}
}
var debugMessageDiv;
var debugElementEnable;
/**
* @ignore
*/
function trace(msg, opt_no_break) {
if (typeof (debugElementEnable) === 'undefined') {
debugMessageDiv = document.getElementById('debugMessages');
if (debugMessageDiv) {
debugElementEnable = true;
}
else {
debugElementEnable = false;
}
}
if (debugElementEnable) {
opt_no_break = (opt_no_break) ? "" : "
";
debugMessageDiv.innerHTML += opt_no_break + msg;
}
}
/**
* @ignore
*/
function jsonp(url, name, query, allowCaching) {
if (url.indexOf("?") > -1)
url += "&jsonp="
else
url += "?jsonp="
url += name + "&";
if (query)
url += encodeURIComponent(query);
if (allowCaching === false){
url += "&";
url += new Date().getTime().toString(); // prevent caching
}
var script = document.createElement("script");
script.setAttribute("src", url);
script.setAttribute("type", "text/javascript");
document.getElementsByTagName("head")[0].appendChild(script);
}
/**
* Borrowed from prototype
* @ignore
*/
var Try = {
/**
* @function
* @param Array of statements to evaluate for returnValues.
* @ignore
*/
these: function() {
var returnValue;
for (var i = 0, length = arguments.length; i < length; i++) {
var lambda = arguments[i];
try {
returnValue = lambda();
break;
} catch (e) {}
}
return returnValue;
}
};
function parseUrl(url){
var exp = /^(?:(\w+):\/\/(.+?)(?:\x3A(\d+))?)?(\/.*?)?(?:\?(.*?))?(?:\#(.*))?$/
var match = exp.exec(url);
if (match != null){
var scheme = match[1];
var domain = match[2];
var port = match[3];
var path = match[4];
var query = match[5];
var fragment = match[6];
var items =[];
if (typeof query !== 'undefined') {
var params = query.split("&");
for (var i = 0; i < params.length; i++) {
var item = params[i];
var keyValue = item.split('=');
items.push({
"key": keyValue[0],
"value": keyValue[1]
});
}
}
return {
"scheme" : scheme,
"domain" : domain,
"port" : port,
"path" : path,
"query" : query,
"queryValues" : items,
"fragment" : fragment
}
}
else{
return null;
}
}
/**
* API cache hashtable, used for REST calls to API only
* @class
* @internal
* @static
*/
var APICache = {
/**
* TODO Document
*/
init: function() {
if (this.cache == null) {
this.cache = new MyOpenSpace.Hash();
}
},
/**
* TODO Document
*/
cachableTypes: {
'FETCH_PERSON': { cachable: true, defaultTTL: 600 },
'FETCH_PEOPLE': { cachable: true, defaultTTL: 600 },
'FETCH_INDICATORS': { cachable: false, defaultTTL: 0 },
'FETCH_PERSON_STATUS': { cachable: false, defaultTTL: 0 },
'FETCH_PERSON_MOOD': { cachable: false, defaultTTL: 0 },
'FETCH_PERSON_FRIENDSHIP': { cachable: false, defaultTTL: 0 },
'FETCH_PEOPLE_FRIENDSHIP': { cachable: false, defaultTTL: 0 },
'FETCH_PHOTO': { cachable: false, defaultTTL: 0 },
'FETCH_PHOTOS': { cachable: false, defaultTTL: 0 },
'FETCH_ALBUM': { cachable: false, defaultTTL: 0 },
'FETCH_ALBUMS': { cachable: false, defaultTTL: 0 },
'FETCH_VIDEO': { cachable: false, defaultTTL: 0 },
'FETCH_VIDEOS': { cachable: false, defaultTTL: 0 },
'FETCH_PERSON_DATA': { cachable: false, defaultTTL: 0 },
'UPDATE_PERSON_DATA': { cachable: false, defaultTTL: 0 },
'REMOVE_PERSON_DATA': { cachable: false, defaultTTL: 0 },
'FETCH_ACTIVITIES': { cachable: false, defaultTTL: 0 },
'INSERT_NOTIFICATION': { cachable: false, defaultTTL: 0 }
},
getUniqueKey: function(endPoint) {
var urlComponents = parseUrl(endPoint);
if (urlComponents === null) return null;
var key = urlComponents.path;
for (var i = 0; i < urlComponents.queryValues.length; i++) {
var keyValue = urlComponents.queryValues[i];
if (keyValue.key === 'ts') continue;
key += "&" + keyValue.key + "=" + keyValue.value;
}
return key;
},
add: function(endPoint, value, type) {
if (MyOpenSpace.EnableClientCache !== true) { return; }
if (typeof endPoint !== 'string' ||
typeof value === 'undefined' || value === null ||
typeof type !== 'string') return;
cacheInfo = this.cachableTypes[type];
//We just cache cachable types.
if (typeof cacheInfo === 'undefined' || cacheInfo.cachable !== true) return;
var key = APICache.getUniqueKey(endPoint);
this.cache[key] = {
'value': value,
'timestamp': (new Date()).getTime(),
'defaultTTL': cacheInfo.defaultTTL
};
},
/**
* TODO Document
*/
isCached: function(endPoint) {
if (MyOpenSpace.EnableClientCache !== true) { return false; }
if (typeof endPoint !== 'string') return false;
var key = APICache.getUniqueKey(endPoint);
return "undefined" !== typeof (this.cache[key]);
},
/**
* TODO Document
*/
retrieve: function(endPoint) {
if (MyOpenSpace.EnableClientCache !== true) { return undefined; }
if (typeof endPoint !== 'string') return undefined;
var key = APICache.getUniqueKey(endPoint);
return this.cache[key].value;
},
/**
* TODO Document
*/
isExpired: function(endPoint, timeToLive) {
if (MyOpenSpace.EnableClientCache !== true) { return true; }
if (typeof endPoint !== 'string') return true;
var key = APICache.getUniqueKey(endPoint);
if (!this.isCached(endPoint)) return true;
var val = this.cache[key];
var ttl = typeof timeToLive !== 'number' ? val.defaultTTL : timeToLive;
if (ttl === 0) return false;
ttl = ttl * 1000;
var lifespan = new Date().getTime() - val.timestamp;
return (lifespan > ttl) ? true : false;
}
};MyOpenSpace.EndPoint = function(userInfo, osToken, osMode) {
var self = this;
self.Server = {
Localhost: 'http://localhost',
Development: "http://local-api.myspace.com",
Production: "http://{SUBDOMAIN}api.myspace.com"
};
self.ServerApiMySpace = {
Localhost: "http://localhost",
Development: "http://local-api.myspace.com",
Production: "http://api.myspace.com"
};
self.People = {
Viewer: "/myspaceid/v1/users/{VIEWER}",
Owner: "/myspaceid/v1/users/{OWNER}",
ID: "/myspaceid/v1/users/{PERSON_ID}",
ViewerFriends: "/myspaceid/v1/users/{VIEWER}/friends",
OwnerFriends: "/myspaceid/v1/users/{OWNER}/friends"
};
self.Person = {
Viewer: "/myspaceid/v1/users/{VIEWER}",
Owner: "/myspaceid/v1/users/{OWNER}",
ID: "/myspaceid/v1/users/{PERSON_ID}"
};
self.Indicators = {
Viewer: "/myspaceid/v1/users/{VIEWER}/indicators",
Owner: "/myspaceid/v1/users/{OWNER}/indicators"
};
self.Friendship = {
Viewer: "/myspaceid/v1/users/{VIEWER}/friendship/{PERSON_IDS}",
Owner: "/myspaceid/v1/users/{OWNER}/friendship/{PERSON_IDS}"
};
self.PersonStatus = {
Viewer: "/myspaceid/v1/users/{VIEWER}/status",
Owner: "/myspaceid/v1/users/{OWNER}/status"
};
self.PersonMood = {
Viewer: "/myspaceid/v1/users/{VIEWER}/mood",
Owner: "/myspaceid/v1/users/{OWNER}/mood"
};
self.Albums = {
Viewer: "/myspaceid/v1/users/{VIEWER}/albums",
Owner: "/myspaceid/v1/users/{OWNER}/albums"
};
self.Album = {
Viewer: "/myspaceid/v1/users/{VIEWER}/albums/{ALBUM_ID}",
Owner: "/myspaceid/v1/users/{OWNER}/albums/{ALBUM_ID}"
};
self.Videos = {
Viewer: "/myspaceid/v1/users/{VIEWER}/videos",
Owner: "/myspaceid/v1/users/{OWNER}/videos"
};
self.Video = {
Viewer: "/myspaceid/v1/users/{VIEWER}/videos/{VIDEO_ID}",
Owner: "/myspaceid/v1/users/{OWNER}/videos/{VIDEO_ID}"
};
self.Photos = {
Viewer: "/myspaceid/v1/users/{VIEWER}/photos",
Owner: "/myspaceid/v1/users/{OWNER}/photos"
};
self.AlbumPhotos = {
Viewer: "/myspaceid/v1/users/{VIEWER}/albums/{ALBUM_ID}/photos",
Owner: "/myspaceid/v1/users/{OWNER}/albums/{ALBUM_ID}/photos"
};
self.Photo = {
Viewer: "/myspaceid/v1/users/{VIEWER}/photos/{PHOTO_ID}",
Owner: "/myspaceid/v1/users/{OWNER}/photos/{PHOTO_ID}"
};
self.Permissions = {
Viewer: "/v1/users/{PERSON_ID}/apps.jsnp",
Owner: "/v1/users/{PERSON_ID}/apps.jsnp"
};
self.Activities = {
Viewer: "/myspaceid/v1/users/{VIEWER}/activities/app",
Owner: "/myspaceid/v1/users/{OWNER}/activities/app",
ViewerFriends: "/myspaceid/v1/users/{VIEWER}/friends/activities/app",
OwnerFriends: "/myspaceid/v1/users/{OWNER}/friends/activities/app",
ViewerInsert: "/myspaceid/v1/users/{VIEWER}/activities/app"
};
self.Notification = {
//ViewerInsert: "/api-v2.svc/json/messages/@me/@notifications",
OwnerInsert: "/myspaceid/v1/users/{SENDER_ID}/notifications"
};
self.PersonAppData = {
Viewer: "/myspaceid/v1/users/{VIEWER}/appdata{KEYS}",
ViewerFriends: "/myspaceid/v1/users/{VIEWER}/friends/appdata{KEYS}",
Owner: "/myspaceid/v1/users/{OWNER}/appdata{KEYS}",
OwnerFriends: "/myspaceid/v1/users/{OWNER}/friends/appdata{KEYS}",
Global: "/myspaceid/v1/users/{VIEWER}/appdata/global{KEYS}"
};
self.CommonQueryString = "ts={TIME_STAMP}";
self.DetailQueryString = "&fields={DETAIL_TYPE}";
self.PagingQueryString = "&page={PAGE}&page_size={SIZE}";
self.PagingQueryStringV2 = "&startIndex={PAGE}&count={SIZE}";
self.FilterQueryString = "&filterBy={FILTER}";
self.SortQueryString = "&sortBy={SORT_BY}&sortOrder={SORT_ORDER}";
self.FormatQueryString = "&format=JSON";
if (osToken === undefined || osToken === null) return;
var server = MSID.baseUrl;
var timeStamp = new Date().getTime();
var params = gadgets.views.getParams();
var ownerId = MyOpenSpace.PrefetchParameters.getParam("ownerid");
var viewerId = MyOpenSpace.PrefetchParameters.getParam("viewerId");
if ("undefined" === typeof (ownerId) && params) { ownerId = params.ownerId; }
if ("undefined" === typeof (viewerId) && params) { viewerId = params.viewerId; }
//endPoint.CommonQueryString = endPoint.CommonQueryString.replace("{OS_MODE}", osMode.getName()).replace("{TIME_STAMP}", timeStamp);
self.CommonQueryString = self.CommonQueryString.replace("{TIME_STAMP}", timeStamp);
self.Person.Viewer = server + self.Person.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.DetailQueryString + self.FormatQueryString;
self.Person.Owner = server + self.Person.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.DetailQueryString + self.FormatQueryString;
self.People.ID = server + self.People.ID + "?" + self.CommonQueryString + self.FormatQueryString;
self.People.Viewer = server + self.People.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.FormatQueryString;
self.People.Owner = server + self.People.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.FormatQueryString;
self.People.ViewerFriends = server + self.People.ViewerFriends.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.PagingQueryStringV2 + self.FormatQueryString;
self.People.OwnerFriends = server + self.People.OwnerFriends.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.PagingQueryStringV2 + self.FormatQueryString;
self.Indicators.Viewer = server + self.Indicators.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.Indicators.Owner = server + self.Indicators.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.PersonStatus.Viewer = server + self.PersonStatus.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.PersonStatus.Owner = server + self.PersonStatus.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.PersonMood.Viewer = server + self.PersonMood.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.PersonMood.Owner = server + self.PersonMood.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.Friendship.Viewer = server + self.Friendship.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.Friendship.Owner = server + self.Friendship.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.Albums.Viewer = server + self.Albums.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Albums.Owner = server + self.Albums.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Album.Viewer = server + self.Album.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.Album.Owner = server + self.Album.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.Videos.Viewer = server + self.Videos.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Videos.Owner = server + self.Videos.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Video.Viewer = server + self.Video.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.Video.Owner = server + self.Video.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.Photos.Viewer = server + self.Photos.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Photos.Owner = server + self.Photos.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Photo.Viewer = server + self.Photo.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.Photo.Owner = server + self.Photo.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString;
self.AlbumPhotos.Viewer = server + self.AlbumPhotos.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.AlbumPhotos.Owner = server + self.AlbumPhotos.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString + self.PagingQueryString;
self.Activities.Viewer = server + self.Activities.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString,
self.Activities.Owner = server + self.Activities.Owner.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString,
self.Activities.ViewerFriends = server + self.Activities.ViewerFriends.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString,
self.Activities.OwnerFriends = server + self.Activities.OwnerFriends.replace("{OWNER}", ownerId) + "?" + self.CommonQueryString,
self.Activities.ViewerInsert = server + self.Activities.ViewerInsert.replace("{PERSON_ID}", ownerId) + "?" + self.CommonQueryString,
self.Notification.OwnerInsert = server + self.Notification.OwnerInsert.replace("{SENDER_ID}", ownerId) + "?" + self.CommonQueryString,
self.PersonAppData.Viewer = server + self.PersonAppData.Viewer.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.PersonAppData.ViewerFriends = server + self.PersonAppData.ViewerFriends.replace("{VIEWER}", viewerId) + "?" + self.CommonQueryString;
self.PersonAppData.Owner = server + self.PersonAppData.Owner.replace("{OWNER}", userInfo.OWNER) + "?" + self.CommonQueryString;
self.PersonAppData.OwnerFriends = server + self.PersonAppData.OwnerFriends.replace("{OWNER}", userInfo.OWNER) + "?" + self.CommonQueryString;
self.PersonAppData.Global = server + self.PersonAppData.Global + "?" + self.CommonQueryString;
};
/**
* DataRequest is the internal MySpace implementation of an OpenSocial DataRequest
* @constructor Creates a new DataRequest factory and execution model
* @param {String} osToken OpenSocial token
* @param {MyOpenSpace.EndPoint} endPoint MyOpenSpace.EndPoint object for service endpoints
* @class
* @name MyOpenSpace.DataRequest
*
*/
MyOpenSpace.DataRequest = function(osToken, endPoint, opt_consumerKey) {
this.osToken_ = osToken;
this.endPoint_ = endPoint;
if(opt_consumerKey)
this.consumerKey_ = opt_consumerKey;
this.requestProcessor_ = new MyOpenSpace.RequestProcessor_();
this.requestObjects_ = new MyOpenSpace.Hash();
this.requestObjectCount_ = 0;
this.busy_ = false;
this.authTemplate_ = null;
};
MyOpenSpace.DataRequest.prototype = new opensocial.DataRequest();
/**
* Enumerates the extended filter types
* @static
* @class
* @name MyOpenSpace.DataRequest.FilterType
*/
MyOpenSpace.DataRequest.FilterType = {
/**
* The friends that are currently online.
* @memberOf MyOpenSpace.DataRequest.FilterType
*/
ONLINE_FRIENDS: "ONLINE_FRIENDS"
};
/**
* Enumerates the extended sort order types
* @static
* @class
* @name MyOpenSpace.DataRequest.SortOrder
*/
MyOpenSpace.DataRequest.SortOrder = {
/**
* The friends that are currently online.
* @memberOf MyOpenSpace.DataRequest.FilterType
*/
ID: "ID"
};
/**
* Enumerates cache control mechanism for API calls
* @static
* @class
* @name MyOpenSpace.DataRequest.CacheControl
*/
MyOpenSpace.DataRequest.CacheControl = {
/**
* Enable/disable the cache layer - boolean
* @memberOf MyOpenSpace.DataRequest.CacheControl
*/
USE_CACHE: "USE_CACHE",
/**
* Specify a TTL for the item in cache - specified in seconds: 0 means no expiration
* @memberOf MyOpenSpace.DataRequest.CacheControl
*/
REFRESH_INTERVAL: "REFRESH_INTERVAL"
};
/**
* Enumerates the request fields used by the Photo entity
* @static
* @class
* @name MyOpenSpace.DataRequest.PhotoRequestFields
*/
MyOpenSpace.DataRequest.PhotoRequestFields = {
/**
* Used to filter a photos request by album id, returns all photos for a particular album.
* @memberOf MyOpenSpace.DataRequest.PhotoRequestFields
*/
ALBUM_ID: "ALBUM_ID"
};
/**
* Holds some commonly used constants
* @static
* @class
* @internal
* @name MyOpenSpace.DataRequest.Constants
*/
MyOpenSpace.DataRequest.Constants = {
/**
* Lists the opensocial.Person.Fields that define a 'basic' person
* @internal
* @memberOf MyOpenSpace.DataRequest.Constants
*/
BASIC_PERSON_FIELDS: "familyName,givenName,id,name,nickname,profileUrl,thumbnailUrl",
/**
* Lists the opensocial.Person.Fields that define a name
* @internal
* @memberOf MyOpenSpace.DataRequest.Constants
*/
NAME_FIELDS: "familyName,givenName,name"
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the photo
* @param {Number} photo_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPhotoRequest = function(id, photo_id, opt_params) {
return MSID.Container.get().newFetchPhotoRequest(id, photo_id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the photos
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the photos.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPhotosRequest = function(id, opt_params) {
return MSID.Container.get().newFetchPhotosRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the album
* @param {Number} album_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchAlbumRequest = function(id, album_id, opt_params) {
return MSID.Container.get().newFetchAlbumRequest(id, album_id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the albums
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the albums.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchAlbumsRequest = function(id, opt_params) {
return MSID.Container.get().newFetchAlbumsRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the album
* @param {Number} video_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchVideoRequest = function(id, video_id, opt_params) {
return MSID.Container.get().newFetchVideoRequest(id, video_id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchIndicatorsRequest = function(id, opt_params) {
return MSID.Container.get().newFetchIndicatorsRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPersonStatusRequest = function(id, opt_params) {
return MSID.Container.get().newFetchPersonStatusRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPersonMoodRequest = function(id, opt_params) {
return MSID.Container.get().newFetchPersonMoodRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person
* @param {String} key The ID of the person to verify friendship
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPersonFriendshipRequest = function(id, key, opt_parms) {
return MSID.Container.get().newFetchPersonFriendshipRequest(id, key, opt_parms);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person
* @param {Array} key The array of IDs of the people to verify friendship.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchPeopleFriendshipRequest = function(id, key, opt_parms) {
return MSID.Container.get().newFetchPeopleFriendshipRequest(id, key, opt_parms);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the albums
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the videos.
* @return {Object} A request object
* @static
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newFetchVideosRequest = function(id, opt_params) {
return MSID.Container.get().newFetchVideosRequest(id, opt_params);
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID, only OWNER is supported
* @param {MyOpenSpace.Notification} notification The notification object.
* @return {Object} A request object
* @static
* @internal
* @memberOf MyOpenSpace.DataRequest
*/
MyOpenSpace.DataRequest.newInsertNotificationRequest = function(recipient, notification, params){
return MSID.Container.get().newInsertNotificationRequest(recipient, notification, params);
};
MyOpenSpace.DataRequest.prototype = {
allRequestsCompleteCallback_: function() {},
getRequestObjects: function() {
return this.requestObjects_;
},
add: function(request, opt_key){
if(!this.busy_){
opt_key ? request.key = opt_key : request.key = null;
if("undefined" === typeof(opt_key) || !this.requestObjects_.has(opt_key)){ // check for duplicate entry
this.requestProcessor_.addWorkItem(request);
var id = request.type;
if(request.parameters){
if(request.parameters.id) id += "-" + request.parameters.id;
else if(request.parameters.idSpec) id += "-" + request.parameters.idSpec;
}
opt_key ? this.requestObjects_.add(opt_key, request) : this.requestObjects_.add(id, request);
this.requestObjectCount_++;
}
}
},
send: function(opt_callback){
if(!this.busy_ && this.requestObjectCount_ > 0){
this.busy_ = true;
if(opt_callback) this.allRequestsCompleteCallback_ = opt_callback;
MSID.Container.get().requestData(this, opt_callback);
}
},
newFetchPersonRequest: function(id, opt_params) {
return MSID.Container.get().newFetchPersonRequest(id, opt_params);
},
newFetchPeopleRequest: function(id, opt_params) {
return MSID.Container.get().newFetchPeopleRequest(id, opt_params);
},
newFetchGlobalAppDataRequest: function() {
return MSID.Container.get().newFetchGlobalAppDataRequest();
},
newFetchInstanceAppDataRequest: function() {
return MSID.Container.get().newFetchInstanceAppDataRequest();
},
newUpdateInstanceAppDataRequest: function() {
return MSID.Container.get().newUpdateInstanceAppDataRequest();
},
newFetchPersonAppDataRequest: function(id, keys, opt_params) {
return MSID.Container.get().newFetchPersonAppDataRequest(id, keys, opt_params);
},
newUpdatePersonAppDataRequest: function(id, key, value) {
return MSID.Container.get().newUpdatePersonAppDataRequest(id, key, value);
},
newFetchActivitiesRequest: function(idSpec, opt_params) {
return MSID.Container.get().newFetchActivitiesRequest(idSpec, opt_params);
},
newRemovePersonAppDataRequest: function(id,keys){
return MSID.Container.get().newRemovePersonAppDataRequest(id,keys);
}
};
/**
* @constructor
* @name MyOpenSpace.DataRequest.RequestActions_
* @internal
*/
MyOpenSpace.DataRequest.RequestActions_ = function(dataRequest) {
this.dataRequest_ = dataRequest;
this.itemsProcessed_ = 0;
this.dataResponseValues_ = {};
};
/**
* Does the logic for the requests and sets up callbacks
* @memberOf MyOpenSpace.DataRequest
* @private
* @internal
*/
MyOpenSpace.DataRequest.RequestActions_.prototype = {
itemsProcessed_: 0,
dataResponseValues_: {},
errored_: false,
getRequestId_: function getRequestId_(id) {
var table = this.dataRequest_.ReqestIdTable_;
if (typeof table === 'undefined' || table === null) {
this.dataRequest_.ReqestIdTable_ = {};
table = this.dataRequest_.ReqestIdTable_;
}
var requestId = table[id];
if (typeof requestId === 'undefined') {
table[id] = 0;
requestId = "";
}
else {
table[id] += 1;
requestId = "_" + table[id];
}
return requestId;
},
isViewerDenied: function(type, workitem, addResponse) {
return false;
},
isBasicPerson: function(fields) {
var sorted_string;
if (fields.constructor === String) {
if (Array.sort) {
sorted_string = Array.sort(fields.split(",")).join(",");
}
else {
sorted_string = fields.split(",").sort().join(",");
}
}
else if (fields.constructor === Array) {
if (Array.sort) {
sorted_string = Array.sort(fields).join(",");
}
else {
sorted_string = fields.sort().join(",");
}
}
else {
return false;
}
return (sorted_string === MyOpenSpace.DataRequest.Constants.BASIC_PERSON_FIELDS);
},
/**
* Internal method that handles fetch person requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PERSON": function FETCH_PERSON(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_PERSON;
var use_ifpc = false;
var url;
var profileDetail = workitem.parameters.profileDetail;
if (profileDetail.unsupported != null) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED, "errorMessage": "Request contains not implemented fields:" + profileDetail.unsupported }, workitem.key, true);
return;
}
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Person.Viewer.replace("{DETAIL_TYPE}", profileDetail.fields);
use_ifpc = (this.isBasicPerson(profileDetail.fields)) ? true : false;
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Person.Owner.replace("{DETAIL_TYPE}", profileDetail.fields);
}
else {
var results = MyOpenSpace.Util.parseIdPrefix(personId);
if (results === null) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Unsupported id"
}, type, true, workitem.key);
return;
}
url = this.dataRequest_.endPoint_.Person.ID.replace("{PERSON_ID}", results);
}
this.invoke_(this, url, type, workitem.key, workitem.opt_params, use_ifpc);
},
/**
* Internal method that handles fetch people requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PEOPLE": function FETCH_PEOPLE(workitem) {
var idSpec = MyOpenSpace.Util.idSpecMap(workitem.parameters.idSpec);
var type = MyOpenSpace.RequestType.FETCH_PEOPLE;
var url;
if (typeof (idSpec.errorCode) !== 'undefined') {
this.addResponseItem_(idSpec, type, true, workitem.key);
return;
}
var first = workitem.parameters.first;
var max = workitem.parameters.max;
var filter = workitem.parameters.filter;
var sort = workitem.parameters.sortOrder;
var details = workitem.parameters.details;
var sortToken = "";
var filterToken = "";
//details
if (typeof (details) !== 'undefined') {
this.addResponseItem_({
"errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED,
"errorMessage": "opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS is not implemented."
}, type, true, workitem.key);
return;
}
// paging
var pagingError = this.getPagingError(first, max);
if (pagingError !== "") {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": pagingError },
type, true, workitem.key);
return;
}
var paging = this.mapPagingParams_(workitem.parameters.first, workitem.parameters.max);
// sorting
if (typeof (sort) !== 'undefined') {
if (opensocial.DataRequest.SortOrder.NAME === sort) {
sortToken = this.dataRequest_.endPoint_.SortQueryString.replace("{SORT_BY}", "nickName").replace("{SORT_ORDER}", "asc");
}
else if (MyOpenSpace.DataRequest.SortOrder.ID === sort) {
sortToken = this.dataRequest_.endPoint_.SortQueryString.replace("{SORT_BY}", "id").replace("{SORT_ORDER}", "asc");
}
else if (opensocial.DataRequest.SortOrder.TOP_FRIENDS === sort) {
this.addResponseItem_({
"errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED,
"errorMessage": "Sort order value opensocial.DataRequest.SortOrder.TOP_FRIENDS is not implemented. If you want to filter top friends use opensocial.DataRequest.PeopleRequestFields.FILTER instead."
}, type, true, workitem.key);
return;
}
else {
this.addResponseItem_({
"errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Invalid sort order value."
}, type, true, workitem.key);
return;
}
}
// filter
// we can only have one filter at a time, so if more than one are specified we need to create an order of precedence
if (filter) {
if (opensocial.DataRequest.FilterType.HAS_APP === filter) filterToken = "app";
else if (MyOpenSpace.DataRequest.FilterType.ONLINE_FRIENDS === filter) filterToken = "online";
else if (opensocial.DataRequest.FilterType.TOP_FRIENDS === filter) filterToken = "top";
else if (opensocial.DataRequest.FilterType.ALL === filter) filterToken = "all";
else if (opensocial.DataRequest.FilterType.IS_FRIENDS_WITH === filter) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED, "errorMessage": "opensocial.DataRequest.FilterType.IS_FRIENDS_WITH is not implemented." },
type, true, workitem.key);
return;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "invalid filter." },
type, true, workitem.key);
return;
}
filterToken = this.dataRequest_.endPoint_.FilterQueryString.replace("{FILTER}", filterToken);
}
if ("number" === typeof (idSpec) || !isNaN(parseInt(idSpec, 10))) {
url = this.dataRequest_.endPoint_.People.ID.replace("{PERSON_ID}", idSpec);
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER_FRIENDS) {
url = this.dataRequest_.endPoint_.People.ViewerFriends.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]) + filterToken + sortToken;
if (this.isViewerDenied(type, workitem)) return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER_FRIENDS) {
url = this.dataRequest_.endPoint_.People.OwnerFriends.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]) + filterToken + sortToken;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED,
"errorMessage": "Unsupported idSpec. To get owner information use fetchPersonRequest."
}, type, true, workitem.key);
return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED,
"errorMessage": "Unsupported idSpec To get viewer information use fetchPersonRequest."
},
type, true, workitem.key);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Unsupported idSpec"
},
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key, workitem.opt_params);
},
/**
* Internal method that handles fetch indicators requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_INDICATORS": function FETCH_INDICATORS(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_INDICATORS;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Indicators.Viewer;
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Indicators.Owner;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" }, type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch person status requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PERSON_STATUS": function FETCH_PERSON_STATUS(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_PERSON_STATUS;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.PersonStatus.Viewer;
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.PersonStatus.Owner;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch person mood requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PERSON_MOOD": function FETCH_PERSON_MOOD(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_PERSON_MOOD;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.PersonMood.Viewer;
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.PersonMood.Owner;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch person friendship requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PERSON_FRIENDSHIP": function FETCH_PERSON_FRIENDSHIP(workitem) {
var personId = workitem.parameters.id;
var key = workitem.parameters.key;
var type = MyOpenSpace.RequestType.FETCH_PERSON_FRIENDSHIP;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Friendship.Viewer.replace("{PERSON_IDS}", key);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Friendship.Owner.replace("{PERSON_IDS}", key);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch people friendship requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PEOPLE_FRIENDSHIP": function FETCH_PEOPLE_FRIENDSHIP(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_PEOPLE_FRIENDSHIP;
var key = workitem.parameters.key;
var url;
if (key.constructor != Array) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Key must be an array." },
type, true, workitem.key);
return;
}
if (key.length === 0) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Key must be an array with at least one element."
}, type, true, workitem.key);
return;
}
var idArray = [];
for (var i = 0; i < key.length; i++) {
var results = MyOpenSpace.Util.parseIdPrefix(key[i]);
if (results === null) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Key user array element is not an user Id."
},
type, true, workitem.key);
return;
}
idArray[i] = results;
}
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Friendship.Viewer.replace("{PERSON_IDS}", idArray.join(";"));
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Friendship.Owner.replace("{PERSON_IDS}", idArray.join(";"));
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch photo requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PHOTO": function FETCH_PHOTO(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_PHOTO;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Photo.Viewer.replace("{PHOTO_ID}", workitem.parameters.photo_id);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Photo.Owner.replace("{PHOTO_ID}", workitem.parameters.photo_id);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch photos requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PHOTOS": function FETCH_PHOTOS(workitem) {
var personId = workitem.parameters.id;
var albumId = workitem.parameters.album_id;
var type = MyOpenSpace.RequestType.FETCH_PHOTOS;
//test to see if the page request is in the form first = a(n) +1 where n = max;
var first = workitem.parameters.first;
var max = workitem.parameters.max;
var pagingError = this.getPagingError(first, max);
if (pagingError !== "") {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": pagingError },
type, true, workitem.key);
return;
}
var paging = this.mapPagingParams_(workitem.parameters.first, workitem.parameters.max);
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
if (null !== albumId) {
url = this.dataRequest_.endPoint_.AlbumPhotos.Viewer.replace("{ALBUM_ID}", albumId).replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
else {
url = this.dataRequest_.endPoint_.Photos.Viewer.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
if (null !== albumId) {
url = this.dataRequest_.endPoint_.AlbumPhotos.Owner.replace("{ALBUM_ID}", albumId).replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
else {
url = this.dataRequest_.endPoint_.Photos.Owner.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch album requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_ALBUM": function FETCH_ALBUM(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_ALBUM;
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Album.Viewer.replace("{ALBUM_ID}", workitem.parameters.album_id);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Album.Owner.replace("{ALBUM_ID}", workitem.parameters.album_id);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported id" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch people albums requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_ALBUMS": function FETCH_ALBUMS(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_ALBUMS;
var first = workitem.parameters.first;
var max = workitem.parameters.max;
var pagingError = this.getPagingError(first, max);
if (pagingError !== "") {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": pagingError },
type, true, workitem.key);
return;
}
var paging = this.mapPagingParams_(workitem.parameters.first, workitem.parameters.max);
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Albums.Viewer.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Albums.Owner.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch video requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_VIDEO": function FETCH_VIDEO(workitem) {
var personId = workitem.parameters.id;
var url;
var type = MyOpenSpace.RequestType.FETCH_VIDEO;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Video.Viewer.replace("{VIDEO_ID}", workitem.parameters.video_id);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Video.Owner.replace("{VIDEO_ID}", workitem.parameters.video_id);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch videos requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_VIDEOS": function FETCH_VIDEOS(workitem) {
var personId = workitem.parameters.id;
var type = MyOpenSpace.RequestType.FETCH_VIDEOS;
var first = workitem.parameters.first;
var max = workitem.parameters.max;
var pagingError = this.getPagingError(first, max);
if (pagingError !== "") {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": pagingError },
type, true, workitem.key);
return;
}
var paging = this.mapPagingParams_(workitem.parameters.first, workitem.parameters.max);
var url;
if (personId === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.Videos.Viewer.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
if (this.isViewerDenied(type, workitem)) return;
}
else if (personId === opensocial.IdSpec.PersonId.OWNER) {
url = this.dataRequest_.endPoint_.Videos.Owner.replace("{PAGE}", paging[0]).replace("{SIZE}", paging[1]);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch person data requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_PERSON_DATA": function FETCH_PERSON_DATA(workitem) {
var idSpec = MyOpenSpace.Util.idSpecMap(workitem.parameters.idSpec);
var type = MyOpenSpace.RequestType.FETCH_PERSON_DATA;
if (typeof (idSpec.errorCode) !== 'undefined') {
this.addResponseItem_(idSpec, type, true, workitem.key);
return;
}
var keys = workitem.parameters.keys || "";
var opt_params = workitem.parameters.opt_params;
var getId = false;
var requestId;
var url;
var arrayError = false;
if (keys === "*") {
keys = "";
}
else if (keys.constructor === Array) {
for (var i = 0; i < keys.length; i++) {
if (keys[i] === "" || keys[i] === "*") {
arrayError = true;
break;
}
}
keys = "/" + keys.join(';');
}
else {
requestId = "_" + keys;
keys = "/" + keys;
}
var pointer = this;
if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER) {
url = this.dataRequest_.endPoint_.PersonAppData.Viewer.replace("{KEYS}", keys);
if (this.isViewerDenied(type, workitem)) return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER_FRIENDS) {
url = this.dataRequest_.endPoint_.PersonAppData.ViewerFriends.replace("{KEYS}", keys);
if (this.isViewerDenied(type, workitem)) return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER) {
url = this.dataRequest_.endPoint_.PersonAppData.Owner.replace("{KEYS}", keys);
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER_FRIENDS) {
url = this.dataRequest_.endPoint_.PersonAppData.OwnerFriends.replace("{KEYS}", keys);
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
if (arrayError) {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "Invalid key array element. Array can contain neither empty string nor '*'. "
}, type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key, opt_params);
},
/**
* Internal method that handles update person data requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"UPDATE_PERSON_DATA": function UPDATE_PERSON_DATA(workitem) {
var idSpec = workitem.parameters.id;
var value = workitem.parameters.value;
var key = workitem.parameters.key;
var type = MyOpenSpace.RequestType.UPDATE_PERSON_DATA;
var url;
var validateAppDataKeyName = function(keyName) {
var validRE = /^([a-z0-9\-_\.])+$/i;
return validRE.test(keyName);
}
var validateAppDataValueSize = function(str) {
if (str) {
return str.length < 1024;
}
return true;
}
var getInvalidJsonErrorObject = function() {
return { "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "AppData value must be valid JSON." };
};
//if it's an object, stringify it, then try to jsonify it
if ("object" === typeof (value)) {
value = gadgets.json.stringify(value);
if (!gadgets.json.parse(value)) {
this.addResponseItem_(getInvalidJsonErrorObject(), type, true, workitem.key);
return;
}
}
else if ("string" === typeof (value)) {
if (!gadgets.json.parse(value)) {
this.addResponseItem_(getInvalidJsonErrorObject(), type, true, workitem.key);
return;
}
}
else {
this.addResponseItem_(getInvalidJsonErrorObject(), type, true, workitem.key);
return;
}
if (!validateAppDataKeyName(key)) { // bad key name
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "AppData key names can only consist of alphanumerics, dots, dashes and underscores."
}, type, true, workitem.key);
return;
}
if (!validateAppDataValueSize(value)) { // value too long
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST,
"errorMessage": "AppData value must be less than 1kB (1024 bytes) in size, string size is: " + value.length + " bytes."
}, type, true, workitem.key);
return;
}
value = escape(value);
value = value.replace(/\+/g, '%2B');
this.dataRequest_.params = key + "=" + value;
if (idSpec === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.PersonAppData.Viewer.replace("{KEYS}", "");
if (this.isViewerDenied(type, workitem)) return;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles remove person data requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"REMOVE_PERSON_DATA": function REMOVE_PERSON_DATA(workitem) {
var keys = workitem.parameters.keys || "";
var type = MyOpenSpace.RequestType.REMOVE_PERSON_DATA;
var requestId;
var url;
if (keys === "*" || keys === "") {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED,
"errorMessage": "You must supply a key or an array of keys to remove, note that * isn't implemented."
},
type, true, workitem.key);
return;
}
else if (keys.constructor === Array) {
keys = "/" + keys.join(';');
}
else {
requestId = "_" + keys;
keys = "/" + keys;
}
var id = workitem.parameters.id;
var pointer = this;
if (id === opensocial.IdSpec.PersonId.VIEWER) {
url = this.dataRequest_.endPoint_.PersonAppData.Viewer.replace("{KEYS}", keys);
if (this.isViewerDenied(type, workitem)) return;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.NOT_IMPLEMENTED, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.dataRequest_.params = "";
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles fetch activities requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"FETCH_ACTIVITIES": function FETCH_ACTIVITIES(workitem) {
var idSpec = MyOpenSpace.Util.idSpecMap(workitem.parameters.idSpec);
var type = MyOpenSpace.RequestType.FETCH_ACTIVITIES;
if (typeof (idSpec.errorCode) !== 'undefined') {
this.addResponseItem_(idSpec, type, true, workitem.key);
return;
}
var url;
if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER) {
url = this.dataRequest_.endPoint_.Activities.Viewer;
if (this.isViewerDenied(type, workitem)) return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER) {
url = this.dataRequest_.endPoint_.Activities.Owner;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.VIEWER_FRIENDS) {
url = this.dataRequest_.endPoint_.Activities.ViewerFriends;
if (this.isViewerDenied(type, workitem)) return;
}
else if (idSpec === MyOpenSpace.IdSpecMapping_.OWNER_FRIENDS) {
url = this.dataRequest_.endPoint_.Activities.OwnerFriends;
}
else {
this.addResponseItem_({ "errorCode": opensocial.ResponseItem.Error.BAD_REQUEST, "errorMessage": "Unsupported idSpec" },
type, true, workitem.key);
return;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal method that handles insert notification requests
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} workitem
*/
"INSERT_NOTIFICATION": function INSERT_NOTIFICATION(workitem) {
var recipient = workitem.parameters.recipient;
var params = workitem.parameters.params;
var type = MyOpenSpace.RequestType.INSERT_NOTIFICATION;
var template_params = params[MyOpenSpace.Notification.Field.TEMPLATE_PARAMS] || "";
var media_items = params[MyOpenSpace.Notification.Field.MEDIA_ITEMS] || "";
if (!this.hasPermissionAndSetRI(MyOpenSpace.Permission.VIEWER_SEND_NOTIFICATIONS, type, workitem.key)) {
return;
}
var url = this.dataRequest_.endPoint_.Notification.OwnerInsert;
this.dataRequest_.params = "recipients=" + recipient + "&"; // these are already escaped appropriately
if (template_params && template_params.length > 0) {
this.dataRequest_.params += "templateParameters=" + template_params + "&";
}
if (media_items && media_items.length > 0) {
this.dataRequest_.params += "mediaItems=" + media_items;
}
this.invoke_(this, url, type, workitem.key);
},
/**
* Internal utility method that handles permissions, if perms aren't granted, add the response item
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {MyOpenSpace.Permission} permission
* @param {String} type
* @param {String} key
*/
hasPermissionAndSetRI: function(permission, type, key) {
var has = opensocial.hasPermission(permission);
if (!has) {
this.addResponseItem_(
{
"errorCode": opensocial.ResponseItem.Error.UNAUTHORIZED,
"errorMessage": "You don't have permission to make requests of type: " + type
},
type, true, key);
}
return has;
},
/**
* Internal utility method that handles verify pagin values
* @internal
* @memberOf MyOpenSpace.DataRequest.RequestActions_
* @param {Object} first
* @param {Object} max
*/
getPagingError: function(first, max) {
if (isNaN(first) && first !== "") {
return ("Paging Error: first must be an integer");
}
if (isNaN(max) && max !== "") {
return ("Paging Error: max must be an integer");
}
if (first <= 0 && first !== "") {
return ("Paging Error: first must be a positive integer greater than zero"); ;
}
if (max <= 0 && max !== "") {
return ("Paging Error: max must be a positive integer greater than zero"); ;
}
if (((first % max !== 1) && max != 1 && !(first === "" || max === ""))) {
return ("Paging Error: paging data must be in the form of max = n and first = x(n) + 1 where x is any positive integer. i.e max=5, first= 2(5)+1 =11");
}
return "";
},
mapPagingParams_: function(first, max) {
if (first === null || typeof (first) === "undefined" || first < 1) first = 1;
if (max === null || typeof (max) === "undefined" || max < 1) max = MyOpenSpace.DefaultPageSize;
// page is not 0 indexed, it starts at 1
var page_size = max;
var page = Math.floor(first / page_size);
if ((first % page_size) !== 0)
page += 1;
return [page, page_size];
},
invoke_: function(requestActions, url, type, opt_key, opt_params, use_ifpc) {
var callback = function(item, errored, opt_key) {
requestActions.addResponseItem_(item, type, errored, opt_key);
};
var dataRequestAction = requestActions.dataRequest_;
switch (type) {
case MyOpenSpace.RequestType.UPDATE_PERSON_DATA:
dataRequestAction.method = "PUT";
break;
case MyOpenSpace.RequestType.INSERT_NOTIFICATION:
dataRequestAction.method = "POST";
break;
case MyOpenSpace.RequestType.REMOVE_PERSON_DATA:
dataRequestAction.method = "DELETE";
break;
default:
dataRequestAction.method = "GET";
dataRequestAction.params = "";
break;
}
dataRequestAction.endPoint = url;
opt_params = (typeof opt_params !== 'object' || opt_params === null) ? {} : opt_params;
if (typeof opt_params.useCache === 'undefined' || opt_params.useCache !== false) {
if (APICache.isCached(dataRequestAction.endPoint)) {
if (!APICache.isExpired(dataRequestAction.endPoint, opt_params.refreshInterval)) {
callback(APICache.retrieve(dataRequestAction.endPoint), false, opt_key);
return;
}
}
}
MSID.Relay.sendRequest(dataRequestAction, type, completed_, errored_, true, opt_key);
function completed_(response, type, opt_key) {
var error = null;
var result = null;
var map = new MyOpenSpace.DataMapper_();
if (type === MyOpenSpace.RequestType.REMOVE_PERSON_DATA ||
type === MyOpenSpace.RequestType.UPDATE_PERSON_DATA ||
type === MyOpenSpace.RequestType.INSERT_NOTIFICATION
) {
callback(null, false, opt_key);
return;
}
else if (type === MyOpenSpace.RequestType.FETCH_PERSON_DATA) {
var encoding = opensocial.EscapeType.HTML_ESCAPE;
if (typeof (opt_params) !== "undefined") {
encoding = opt_params[opensocial.DataRequest.DataRequestFields.ESCAPE_TYPE];
if (typeof (opt_params) === "undefined") {
encoding = opensocial.EscapeType.HTML_ESCAPE;
}
}
result = map.mapData[MyOpenSpace.RequestType.FETCH_PERSON_DATA](response, encoding);
}
else {
result = map.mapData[type](response);
}
if (null === result) {
callback({ "errorCode": opensocial.ResponseItem.Error.INTERNAL_ERROR, "errorMessage": "Unable to map entity" }, true, opt_key);
} else {
// short circuit for only cachable types here
APICache.add(dataRequestAction.endPoint, result, type);
callback(result, false, opt_key);
}
}
function errored_(response, opt_key) {
callback(response, true, opt_key);
}
},
responseWrapper: function(responseValues, errored) {
this.statusCode = 0;
this.statusMessage = '';
if (errored) {
this.statusCode = -1;
this.statusMessage = 'error';
}
else {
this.statusCode = 1;
this.statusMessage = 'hello';
}
},
addResponseItem_: function(item, type, errored, opt_key) {
var ri, error;
if (errored) {
error = MSID.Connect.Enums.getError(item.errorCode, item.errorMessage);
ri = MSID.Container.get().newResponseItem(this.dataRequest_, null, error.code, error.message);
this.errored_ = true;
}
else
ri = MSID.Container.get().newResponseItem(this.dataRequest_, item, "", "");
var responseKey;
if (typeof (opt_key) === 'undefined' || opt_key === null) {
responseKey = type + this.getRequestId_(type);
}
else {
responseKey = opt_key;
}
this.dataResponseValues_[responseKey] = ri;
this.itemsProcessed_++;
//check to see if we're all done
if (this.itemsProcessed_ === this.dataRequest_.requestObjectCount_) {
this.dataRequest_.ReqestIdTable_ = null;
this.dataRequest_.requestObjectCount_ = 0;
this.dataRequest_.requestObjects_ = new MyOpenSpace.Hash();
this.dataRequest_.busy_ = false;
this.dataRequest_.allRequestsCompleteCallback_(MSID.Container.get().newDataResponse(this.dataResponseValues_, this.errored_));
//debugger;
//this.dataRequest_.allRequestsCompleteCallback_(new this.responseWrapper(this.dataResponseValues_, this.errored_));
}
else if (this.dataRequest_.requestProcessor_.executionModel_ === MyOpenSpace.RequestProcessor_.ExecutionModel_.SERIAL)
this.dataRequest_.requestProcessor_.startProcessing();
}
};
/**
* The MySpace container class, extends MSID.Container. Use MSID.Container.get() to retrieve this singleton.
* @constructor
*/
MyOpenSpace.MySpaceContainer = function(viewerId, ownerId, sessionToken, consumerKey, sideBySide) {
var urlParams = gadgets.util.getUrlParameters();
urlParams.views = "";
var config = {};
var supported_views = {};
supported_views["default"] = new gadgets.views.View(gadgets.views.ViewType.EXTERNAL, true);
supported_views[gadgets.views.ViewType.EXTERNAL] = new gadgets.views.View(gadgets.views.ViewType.EXTERNAL, true);
config["views"] = supported_views;
var uriFragment = window.location.hash;
if (uriFragment && uriFragment.length >= 0) {
uriFragment = uriFragment.substring(1, uriFragment.length);
if (uriFragment.indexOf("&") >= 0) {
uriFragment = uriFragment.substring(0, uriFragment.indexOf("&"));
}
}
//TODO: set osToken/session token, should osToken_ be renamed or reused?
this.osToken_ = sessionToken;
this.consumerKey_ = consumerKey;
gadgets.config.init(config);
APICache.init();
this.osMode_ = gadgets.views.getCurrentView();
this.params_ = {};
//New param registrations
this.registerParam("ownerId", ownerId);
this.registerParam("viewerId", viewerId);
//TODO: configure permissions
if (urlParams.perm) {
var perm = gadgets.json.parse('{"permissions":' + urlParams.perm + '}');
this.registerParam("ownerPerm", perm.permissions);
if (urlParams.viewerId === urlParams.ownerId) {
this.registerParam("viewerPerm", perm.permissions);
}
else if (urlParams.viewer_perm) {
perm = gadgets.json.parse('"permissions":' + urlParams.viewer_perm);
this.registerParam("viewerPerm", perm.permissions);
}
}
if (urlParams.userLoggedOut) {
this.registerParam("loggedOut", true);
}
else {
this.registerParam("loggedOut", false);
}
if (urlParams.installState) {
this.registerParam("installState", urlParams.installState);
}
var supportedPostToTargets = "";
if (urlParams && urlParams.pto) {
supportedPostToTargets = urlParams.pto.split(",");
this.myspaceenvironment_ = this.newMySpaceEnvironment(supportedPostToTargets);
}
MyOpenSpace.EnableClientCache = false;
if (urlParams && urlParams.mc) {
var mc = urlParams.mc.split(",");
for (var i = 0; i < mc.length; i++) {
switch (mc[i]) {
case "UOC":
MyOpenSpace.MDPContainerUseOpenCanvas = false;
break;
case "RSAMR":
MyOpenSpace.MDPContainerRSAMultipleRecipients = false;
break;
case "ECC":
MyOpenSpace.EnableClientCache = true;
break;
}
}
}
var supportedPersonFields = {};
supportedPersonFields[opensocial.Person.Field.ABOUT_ME] = true;
supportedPersonFields[opensocial.Person.Field.AGE] = true;
supportedPersonFields[opensocial.Person.Field.BODY_TYPE] = true;
supportedPersonFields[opensocial.Person.Field.BOOKS] = true;
supportedPersonFields[opensocial.Person.Field.CHILDREN] = true;
supportedPersonFields[opensocial.Person.Field.CURRENT_LOCATION] = true;
supportedPersonFields[opensocial.Person.Field.DATE_OF_BIRTH] = true;
supportedPersonFields[opensocial.Person.Field.DRINKER] = true;
supportedPersonFields[opensocial.Person.Field.ETHNICITY] = true;
supportedPersonFields[opensocial.Person.Field.GENDER] = true;
supportedPersonFields[opensocial.Person.Field.HAS_APP] = true;
supportedPersonFields[opensocial.Person.Field.HEROES] = true;
supportedPersonFields[opensocial.Person.Field.ID] = true;
supportedPersonFields[opensocial.Person.Field.INTERESTS] = true;
supportedPersonFields[opensocial.Person.Field.JOBS] = true;
supportedPersonFields[opensocial.Person.Field.LOOKING_FOR] = true;
supportedPersonFields[opensocial.Person.Field.MOVIES] = true;
supportedPersonFields[opensocial.Person.Field.MUSIC] = true;
supportedPersonFields[opensocial.Person.Field.NAME] = true;
supportedPersonFields[opensocial.Person.Field.NETWORK_PRESENCE] = true;
supportedPersonFields[opensocial.Person.Field.NICKNAME] = true;
supportedPersonFields[opensocial.Person.Field.PROFILE_SONG] = true;
supportedPersonFields[opensocial.Person.Field.PROFILE_URL] = true;
supportedPersonFields[opensocial.Person.Field.RELATIONSHIP_STATUS] = true;
supportedPersonFields[opensocial.Person.Field.RELIGION] = true;
supportedPersonFields[opensocial.Person.Field.SEXUAL_ORIENTATION] = true;
supportedPersonFields[opensocial.Person.Field.SMOKER] = true;
supportedPersonFields[opensocial.Person.Field.STATUS] = true;
supportedPersonFields[opensocial.Person.Field.THUMBNAIL_URL] = true;
supportedPersonFields[opensocial.Person.Field.TV_SHOWS] = true;
supportedPersonFields[opensocial.Person.Field.URLS] = true;
supportedPersonFields[MyOpenSpace.Person.Field.MEDIUM_IMAGE] = true;
supportedPersonFields[MyOpenSpace.Person.Field.LARGE_IMAGE] = true;
var supportedFilters = {};
supportedFilters[opensocial.DataRequest.FilterType.ALL] = true;
supportedFilters[opensocial.DataRequest.FilterType.HAS_APP] = true;
supportedFilters[opensocial.DataRequest.FilterType.TOP_FRIENDS] = true;
var supportedFields = {};
supportedFields[opensocial.Environment.ObjectType.PERSON] = supportedPersonFields;
supportedFields[MyOpenSpace.Environment.ObjectType.PERSON] = supportedPersonFields;
supportedFields[MyOpenSpace.Environment.ObjectType.VIDEO] = MyOpenSpace.Video.Field;
supportedFields[MyOpenSpace.Environment.ObjectType.ALBUM] = MyOpenSpace.Album.Field;
supportedFields[MyOpenSpace.Environment.ObjectType.PHOTO] = MyOpenSpace.Photo.Field;
supportedFields[opensocial.Environment.ObjectType.FILTER_TYPE] = supportedFilters;
this.environment_ = this.newEnvironment("myspace.com", supportedFields);
this.endPoint_ = new MyOpenSpace.EndPoint(opensocial.IdSpec.PersonId, this.osToken_, this.osMode_);
// Expose as property for now
MyOpenSpace.MySpaceContainer.OSToken = this.osToken_;
this.sideBySide = sideBySide;
MSID.Container.call(this, false);
MSID.Container.setContainer(this);
if(!this.sideBySide) {
opensocial.Container.call(this, false);
opensocial.Container.setContainer(this);
}
};
MyOpenSpace.MySpaceContainer.inherits(opensocial.Container);
/**
* The parameters that are passed between surfaces.
* @private
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.params_ = null;
/**
* Private instance of the request processor, use MySpaceContainer.getRequestProcessor to access.
* @type {MyOpenSpace.RequestProcessor_}
* @private
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.requestProcessor_ = null;
/**
* Private instance of the environment, use MySpaceContainer.getEnvironment to access.
* @type {opensocial.Environment}
* @private
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.environment_ = null;
/**
* Private instance of the MySpace environment, use MySpaceContainer.getMySpaceEnvironment to access.
* @type {MyOpenSpace.Environment}
* @private
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.myspaceenvironment_ = null;
/**
* Returns the container's MySpace environment object
* @return {MyOpenSpace.Environment}
*/
MyOpenSpace.MySpaceContainer.prototype.getMySpaceEnvironment = function() { return this.myspaceenvironment_; };
/**
* Returns the container's request processor
* @return {MyOpenSpace.RequestProcessor_}
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.getRequestProcessor = function() { return this.requestProcessor_; };
/**
* Returns the container's environment object.
* @return {opensocial.Environment}
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.getEnvironment = function() { return this.environment_; };
MyOpenSpace.MySpaceContainer.prototype.disable = function() {
MSID.Container.get().osToken_ = null;
}
/**
* Returns a new MyOpenSpace.Person instance
* @param {Map<opensocial.DataRequest.PeopleRequestFields>} opt_params Optional parameters specified when creating the person.
* @param {Boolean} opt_isViewer True if this is the viewer of the page otherwise, false.
* @param {Boolean} opt_isOwner True if this is the owner of the page otherwise, false.
* @return {MyOpenSpace.Person} The person object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newPerson = function(opt_params, opt_isOwner, opt_isViewer){
return new MyOpenSpace.Person(opt_params, opt_isOwner, opt_isViewer);
};
MyOpenSpace.MySpaceContainer.prototype.newName = function(opt_params){
return new opensocial.Name(opt_params);
};
/**
* Returns a new MyOpenSpace.Album instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.Album} The album object
*/
MyOpenSpace.MySpaceContainer.prototype.newAlbum = function(opt_params){
return new MyOpenSpace.Album(opt_params);
};
/**
* Returns a new MyOpenSpace.Indicators instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.Indicators} The indicators object
*/
MyOpenSpace.MySpaceContainer.prototype.newIndicators = function(opt_params){
return new MyOpenSpace.Indicators(opt_params);
};
/**
* Returns a new MyOpenSpace.PersonStatus instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.PersonStatus} The PersonStatus object
*/
MyOpenSpace.MySpaceContainer.prototype.newPersonStatus = function(opt_params){
return new MyOpenSpace.PersonStatus(opt_params);
};
/**
* Returns a new MyOpenSpace.PersonMood instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.PersonStatus} The PersonMood object
*/
MyOpenSpace.MySpaceContainer.prototype.newPersonMood = function(opt_params){
return new MyOpenSpace.PersonMood(opt_params);
};
/**
* Returns a new MyOpenSpace.Friendship instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.Friendship} The Friendship object
*/
MyOpenSpace.MySpaceContainer.prototype.newFriendship = function(opt_params){
return new MyOpenSpace.Friendship(opt_params);
};
/**
* Returns a new MyOpenSpace.Video instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.Video} The album object
*/
MyOpenSpace.MySpaceContainer.prototype.newVideo = function(opt_params){
return new MyOpenSpace.Video(opt_params);
};
/**
* Returns a new MyOpenSpace.Photo instance
* @param {undefined} opt_params Unused at this time.
* @return {MyOpenSpace.Photo} The photo object
*/
MyOpenSpace.MySpaceContainer.prototype.newPhoto = function(opt_params){
return new MyOpenSpace.Photo(opt_params);
};
/**
* Returns a new opensocial.DataRequest instance, which is overridden locally
* @function
* @return {opensocial.DataRequest} The data request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newDataRequest = function(){
return new MyOpenSpace.DataRequest(this.osToken_, this.endPoint_, this.consumerKey_);
};
/**
* Returns a new opensocial.ResponseItem instance
* @function
* @param {opensocial.DataRequest} originalDataRequest The ID of the photo to fetch
* @param {Object || null} data The object retrieved, can be any entity, or null if nothing was found.
* @param {String} opt_errorCode A code defining the error that occurred, if any.
* @param {String} opt_errorMessage A message detailing the error that occurred, if any.
* @return {opensocial.ResponseItem} The response item object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newResponseItem = function(originalDataRequest, data, opt_errorCode, opt_errorMessage) {
return new opensocial.ResponseItem(originalDataRequest, data, opt_errorCode, opt_errorMessage);
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPersonRequest = function(id, opt_params) {
opt_params = opt_params || {};
return {
type: MyOpenSpace.RequestType.FETCH_PERSON,
parameters: {
id:id,
profileDetail: this.mapPersonDetails_(opt_params)
},
'opt_params': {
useCache: (opt_params[MyOpenSpace.DataRequest.CacheControl.USE_CACHE]),
refreshInterval: (opt_params[MyOpenSpace.DataRequest.CacheControl.REFRESH_INTERVAL])
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the photo
* @param {Number} photo_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPhotoRequest = function(id, photo_id, opt_params){
return {
type: MyOpenSpace.RequestType.FETCH_PHOTO,
parameters: {
id:id,
photo_id:photo_id
}
};
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the photos
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the photos.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPhotosRequest = function(id, opt_params){
opt_params = opt_params || {};
return {
type: MyOpenSpace.RequestType.FETCH_PHOTOS,
parameters: {
id:id,
album_id: opt_params[MyOpenSpace.DataRequest.PhotoRequestFields.ALBUM_ID] || null,
first: opt_params[opensocial.DataRequest.PeopleRequestFields.FIRST] || 1,
max: opt_params[opensocial.DataRequest.PeopleRequestFields.MAX] || MyOpenSpace.DefaultPageSize
}
};
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the album
* @param {Number} album_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchAlbumRequest = function(id, album_id, opt_params){
return {
type: MyOpenSpace.RequestType.FETCH_ALBUM,
parameters: {
id:id,
album_id:album_id
}
};
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the albums
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the albums.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchAlbumsRequest = function(id, opt_params){
opt_params = opt_params || {};
return {
type: MyOpenSpace.RequestType.FETCH_ALBUMS,
parameters: {
id:id,
first: opt_params[opensocial.DataRequest.PeopleRequestFields.FIRST] || 1,
max: opt_params[opensocial.DataRequest.PeopleRequestFields.MAX] || MyOpenSpace.DefaultPageSize
}
};
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person who owns the album
* @param {Number} video_id The ID of the photo to fetch
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchVideoRequest = function(id, video_id, opt_params){
return {
type: MyOpenSpace.RequestType.FETCH_VIDEO,
parameters: {
id:id,
video_id:video_id
}
};
};
/**
* Creates an object to be used when sending to the server
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {Map<opensocial.DataRequest.PeopleRequestFields.FIRST || opensocial.DataRequest.PeopleRequestFields.MAX>} opt_params Optional parameters specified when creating the videos.
* @return {Object} A request object
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchVideosRequest = function(id, opt_params){
opt_params = opt_params || {};
return {
type: MyOpenSpace.RequestType.FETCH_VIDEOS,
parameters: {
id:id,
first: opt_params[opensocial.DataRequest.PeopleRequestFields.FIRST] || 1,
max: opt_params[opensocial.DataRequest.PeopleRequestFields.MAX] || MyOpenSpace.DefaultPageSize
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchIndicatorsRequest = function(id, opt_parms){
return {
type: MyOpenSpace.RequestType.FETCH_INDICATORS,
parameters: {
id: id
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPersonStatusRequest = function(id, opt_parms){
return {
type: MyOpenSpace.RequestType.FETCH_PERSON_STATUS,
parameters: {
id: id
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPersonMoodRequest = function(id, opt_parms){
return {
type: MyOpenSpace.RequestType.FETCH_PERSON_MOOD,
parameters: {
id: id
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {String} person id.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPersonFriendshipRequest = function(id, key, opt_parms){
return {
type: MyOpenSpace.RequestType.FETCH_PERSON_FRIENDSHIP,
parameters: {
id: id,
key: key
}
};
};
/**
* Creates an object to be used when sending to the server.
* @param {String} id The ID (VIEWER or OWNER) of the person.
* @param {Array} array of person ids.
* @param {undefined} opt_params Not used at this time.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPeopleFriendshipRequest = function(id, key, opt_parms){
return {
type: MyOpenSpace.RequestType.FETCH_PEOPLE_FRIENDSHIP,
parameters: {
id: id,
key: key
}
};
};
/**
* Creates an item to request friends from the server.
* When processed, returns an opensocial.Collection<MyOpenSpace.Person> object.
* @param {Array.<String> | String} idSpec An ID reference used to specify which people to fetch; the supported keys VIEWER_FRIENDS or OWNER_FRIENDS.
* @param {Map.<opensocial.DataRequest.PeopleRequestFields} opt_params Additional opensocial.DataRequest.PeopleRequestFields params to pass to the request.
* @return {Object} A request object.
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.newFetchPeopleRequest = function(idSpec, opt_params) {
opt_params = opt_params || {};
var fields = opensocial.DataRequest.PeopleRequestFields;
var groups = opensocial.DataRequest.Group;
var type = MyOpenSpace.RequestType.FETCH_PEOPLE;
return {
type: type,
parameters: {
idSpec:idSpec,
sortOrder:opt_params[fields.SORT_ORDER],
details:opt_params[fields.PROFILE_DETAILS],
filter:opt_params[fields.FILTER] || opensocial.DataRequest.FilterType.ALL,
first: (typeof opt_params[fields.FIRST] === 'undefined')?1:opt_params[fields.FIRST],
max: (typeof opt_params[fields.MAX] === 'undefined') ? MyOpenSpace.DefaultPageSize :opt_params[fields.MAX]
},
'opt_params': {
useCache: (opt_params[MyOpenSpace.DataRequest.CacheControl.USE_CACHE]),
refreshInterval: (opt_params[MyOpenSpace.DataRequest.CacheControl.REFRESH_INTERVAL])
}
};
};
/**
* Determines if the requested Person will be mapped internally to BASIC, FULL or EXTENDED
* @function
* @return {MyOpenSpace.DetailType} The detail type of the requested person
* @private
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.mapPersonDetails_ = function(params) {
var details = params && params[opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS];
if(!details) return { fields : MyOpenSpace.DataRequest.Constants.BASIC_PERSON_FIELDS, unsupported : null };
var fields = [];
var unsupported = [];
fields[opensocial.Person.Field.ID] = opensocial.Person.Field.ID;
fields[opensocial.Person.Field.NAME] = MyOpenSpace.DataRequest.Constants.NAME_FIELDS;
fields[opensocial.Person.Field.NICKNAME] = opensocial.Person.Field.NICKNAME;
fields[opensocial.Person.Field.THUMBNAIL_URL] = opensocial.Person.Field.THUMBNAIL_URL;
fields[opensocial.Person.Field.PROFILE_URL] = opensocial.Person.Field.PROFILE_URL;
var environment = opensocial.getEnvironment();
for(var i = 0; i < details.length; i++){
switch (details[i]){
case opensocial.Person.Field.NAME:
//Default value Inclueded by default
break;
case opensocial.Person.Field.JOBS:
fields[opensocial.Person.Field.JOBS] = 'organizations';
break;
case MyOpenSpace.Person.Field.LARGE_IMAGE:
case MyOpenSpace.Person.Field.MEDIUM_IMAGE:
fields['photos'] = 'photos';
break;
default:
if (environment.supportsField(opensocial.Environment.ObjectType.PERSON, details[i])){
fields[details[i]] = details[i];
}
else{
unsupported[details[i]] = true;
}
break;
}
}
unsupportedStr = '';
for (var i in unsupported){
if (unsupported.hasOwnProperty(i)){
unsupportedStr += i + ',';
}
}
if (unsupportedStr === '') {
unsupportedStr = null;
}
else {
unsupportedStr = unsupportedStr.substr(0, unsupportedStr.length - 1);
}
if(Array.sort){
fields = Array.sort(fields);
}
else{
fields = fields.sort(fields);
}
var fieldsStr = '';
for (var i in fields) {
if (fields.hasOwnProperty(i)) {
fieldsStr += fields[i] + ',';
}
}
fieldsStr = fieldsStr.substr(0, fieldsStr.length - 1);
return { fields : fieldsStr, unsupported : unsupportedStr };
};
/**
* Get a new MySpace environment object.
* @return {MyOpenSpace.Environment} the MySpace environment object
* @private
*/
MyOpenSpace.MySpaceContainer.prototype.newMySpaceEnvironment = function(supportedPostToTargets, app) {
return new MyOpenSpace.Environment(supportedPostToTargets, app);
};
/**
* Starts the sending process
* @param {opensocial.DataRequest} dataRequest The request to get processed and sent
* @internal
*/
MyOpenSpace.MySpaceContainer.prototype.requestData = function(dataRequest, callback) {
dataRequest.requestProcessor_.prepareForSend(dataRequest);
dataRequest.requestProcessor_.startProcessing();
};
MyOpenSpace.MySpaceContainer.prototype.newFetchGlobalAppDataRequest = function() {
return {
type: MyOpenSpace.RequestType.FETCH_GLOBAL_DATA
};
};
MyOpenSpace.MySpaceContainer.prototype.newFetchInstanceAppDataRequest = function() {
return {
type: MyOpenSpace.RequestType.FETCH_INSTANCE_DATA
};
};
MyOpenSpace.MySpaceContainer.prototype.newUpdateInstanceAppDataRequest = function() {
return {
type: MyOpenSpace.RequestType.UPDATE_INSTANCE_DATA
};
};
MyOpenSpace.MySpaceContainer.prototype.newFetchPersonAppDataRequest = function(idSpec, keys, opt_params) {
return {
type: MyOpenSpace.RequestType.FETCH_PERSON_DATA,
parameters : {
idSpec: idSpec,
keys: keys,
opt_params: opt_params
}
};
};
MyOpenSpace.MySpaceContainer.prototype.newUpdatePersonAppDataRequest = function(id, key, value) {
return {
type: MyOpenSpace.RequestType.UPDATE_PERSON_DATA,
parameters : {
id: id,
key : key,
value : value
}
};
};
MyOpenSpace.MySpaceContainer.prototype.newRemovePersonAppDataRequest = function(id, keys) {
return {
type: MyOpenSpace.RequestType.REMOVE_PERSON_DATA,
parameters : {
id: id,
keys: keys
}
};
};
MyOpenSpace.MySpaceContainer.prototype.newFetchActivitiesRequest = function(idSpec, opt_params) {
return {
type: MyOpenSpace.RequestType.FETCH_ACTIVITIES,
parameters : {
idSpec: idSpec
}
};
};
MyOpenSpace.MySpaceContainer.prototype.requestCreateActivity = function(activity, priority, opt_callback){
if (!activity || !activity.getField(opensocial.Activity.Field.TITLE_ID)) {
if(opt_callback){
var ri = MSID.Container.get().newResponseItem(null, null, opensocial.ResponseItem.Error.BAD_REQUEST, "You must supply an opensocial.Activity object with a TITLE_ID.");
opt_callback(ri);
}
return;
}
var convertActivityToMessage = function(activity){
var body, title, title_id, body_id, type = MyOpenSpace.PostTo.Targets.ACTIVITY;
var miArray = activity.getField(opensocial.Activity.Field.MEDIA_ITEMS);
var returnError = function(code, message){
if(opt_callback){
var ri = MSID.Container.get().newResponseItem(null, null,
code, message);
opt_callback(ri);
}
}
if(miArray){
if(miArray.constructor !== Array){
returnError(opensocial.ResponseItem.Error.BAD_REQUEST,
"Media items must be supplied in an array.");
return;
}
if(miArray.length > 3){
returnError(opensocial.ResponseItem.Error.BAD_REQUEST,
"You may only supply up to three media items for activities at this time.")
return;
}
for (var i = 0; i < miArray.length; i++){
var mediaItem = miArray[i];
if (typeof(mediaItem.getField) === 'undefined'){
returnError(
opensocial.ResponseItem.Error.BAD_REQUEST,
"Invalid MediaItem object.");
return;
}
if (typeof(mediaItem.getField(opensocial.MediaItem.Field.URL)) === 'undefined'){
returnError(opensocial.ResponseItem.Error.BAD_REQUEST,
"MediaItem should contain a URL.");
return;
}
}
}
// parse media items, save them to the message body
var miJson = MyOpenSpace.MySpaceContainer.parseMediaItemsToJson(miArray);
if(miJson && miJson.length > 0){
body = escape(miJson);
}
// parse template params, save them to the title
var templateParams = activity.getField(opensocial.Activity.Field.TEMPLATE_PARAMS);
if (typeof(templateParams) !== 'undefined') {
if (typeof(templateParams) === 'object') {
title = escape(gadgets.json.stringify(activity.getField(opensocial.Activity.Field.TEMPLATE_PARAMS)));
for (var key in templateParams) {
var templateValue = templateParams[key];
if (typeof(templateValue) === 'string') {
continue;
}
else
if (typeof(templateValue) === 'number') {
continue;
}
else {
returnError(opensocial.ResponseItem.Error.BAD_REQUEST, "Field opensocial.Activity.Field.TEMPLATE_PARAMS contains invalid types. Values shuold be strings.");
return;
}
}
}
else {
returnError(opensocial.ResponseItem.Error.BAD_REQUEST, "Field opensocial.Activity.Field.TEMPLATE_PARAMS is not an object.");
return;
}
}
// parse title id, save them to the title id
title_id = escape(activity.getField(opensocial.Activity.Field.TITLE_ID));
// parse priority, save them to the body id
body_id = activity.getField(opensocial.Activity.Field.PRIORITY);
var params = {};
params[opensocial.Message.Field.TITLE] = title;
params[opensocial.Message.Field.TITLE_ID] = title_id;
params[opensocial.Message.Field.TYPE] = type;
params[opensocial.Message.Field.BODY_ID] = priority;
return opensocial.newMessage(body, params);
};
if(priority) activity.setField(opensocial.Activity.Field.PRIORITY, priority);
var message = convertActivityToMessage(activity);
var activityParams = null;
if(message.getField(opensocial.Message.Field.BODY) != null
&& typeof(message.getField(opensocial.Message.Field.BODY)) !== 'undefined'){
activityParams = {"template" : message.getField(opensocial.Message.Field.TITLE_ID),
"templateParams" : message.getField(opensocial.Message.Field.TITLE),
"mediaItems" : message.getField(opensocial.Message.Field.BODY)}
}
else{
activityParams = {"template" : message.getField(opensocial.Message.Field.TITLE_ID),
"templateParams" : message.getField(opensocial.Message.Field.TITLE)}
}
if (typeof(activityParams) !== 'undefined'){
MSID.Activity.action_raiseActivity(opt_callback, activityParams);
}
};
MyOpenSpace.MySpaceContainer.parseMediaItemsToJson = function(miArray){
if(!miArray) return "";
var miJson = "{";
var miUrl
for(var i = 0; i < miArray.length; i++){
if(0 !== i){
miJson += ",";
}
if(miArray[i].getField(opensocial.MediaItem.Field.URL) === MyOpenSpace.MediaItemHelper.PROFILE_PICTURE){
miUrl = "http://api.myspace.com/v1/users/" + gadgets.views.getParams().ownerId;
}
else{
miUrl = miArray[i].getField(opensocial.MediaItem.Field.URL);
}
miJson += "\"" + miUrl + "\"";
}
miJson += "}";
return miJson;
};
MyOpenSpace.MySpaceContainer.prototype.registerParam = function(key, value) {
this.params_[key] = value;
gadgets.views.getParams()[key] = value;
};
MyOpenSpace.MySpaceContainer.container_ = null;if (typeof (MyOpenSpace.RequestProcessor_) == "undefined") MyOpenSpace.RequestProcessor_ = {};
/**
* MySpace's implementation of a data request manager; linking security, queueing, callbacks, responses, and request actions all together.
* Created to abstract away from OpenSocial's base objects so MySpace can link in EXTENDED entities/methods more easily.
* @class
* @name MyOpenSpace.RequestProcessor_
* @private
* @internal
*/
MyOpenSpace.RequestProcessor_ = function(){
//this._resultCache = new QuickHash();
this.executionInterval_ = 200;
//this.executionModel_ = MyOpenSpace.RequestProcessor_.ExecutionModel_.ASYNC;
this.executionModel_ = MyOpenSpace.RequestProcessor_.ExecutionModel_.SERIAL;
//this.executionModel_ = MyOpenSpace.RequestProcessor_.ExecutionModel_.THROTTLED
this.requestActions_ = null;
this.TotalWorkItems;
this.WorkItemsToProcess;
this.WorkItemsProcessed;
//this._readyToSend = false;
this.paused_ = false;
this.aborted_ = false;
this.authorizationSchemaSet_ = false;
this.init();
};
/**
* Specifies how the RequestProcessor will process the queue of work items.
* @static
* @class
* @internal
*/
MyOpenSpace.RequestProcessor_.ExecutionModel_ = {
/**
* TODO document
* @property {int} SERIAL Executes the queue async one after each other. Essentially a blocking async.
* @internal
*/
SERIAL: "SERIAL",
/**
* Not currently supported.
* @property {int} ASYNC Executes the queue async one after each other, without blocking.
* @internal
*/
ASYNC: "ASYNC",
/**
* Not currently supported.
* @property {int} THROTTLED Same as SERIAL, but with a delay between each work item processed. Use throttleProcessingSpeed(msDelay) to set delay time.
* @internal
*/
THROTTLED: "THROTTLED"
};
MyOpenSpace.RequestProcessor_.prototype = {
/**
* Init handles all initialization for the RequestProcessor_.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
init: function() {
this.workItemPool_ = new this.delayShiftQueue();
},
/**
* prepareForSend will setup the queue in preparation for processing the work items.
* @param {opensocial.DataRequest} ptr Pointer to DataRequest
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
prepareForSend : function(ptr) {
//this._readyToSend = true;
this.requestActions_ = new MyOpenSpace.DataRequest.RequestActions_(ptr);
//startProcessing();
//this.workItemPool_.prioritize();
},
/**
* setAuthorization sets the authorization template used to verify/set authorizations on each DataRequest's request.
* @memberOf MyOpenSpace.RequestProcessor_
* @param {Object} template The authorization template to apply to this DataRequest.
* @internal
*/
setAuthorization: function(template) {
this.authTemplate_ = template;
this.authorizationSchemaSet_ = true;
},
/**
* addWorkItem will add a work item to the RequestProcessor's queue.
* @memberOf MyOpenSpace.RequestProcessor_
* @param {MyOpenSpace.RequestProcessor_.WorkItem} workItem The work item to add to the queue.
* @internal
*/
addWorkItem: function(workItem) { // was:addWorkItem: function(workItem, priority) {
//if (!this._readyToSend){
//TODO: put hasPermission/requestPermission here
//workItem.priority = priority;
this.workItemPool_.push(workItem);
//}
},
/**
* startProcessing will being executing work items from the queue, as defined by the ExecutionModel_.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
startProcessing: function() {
switch (this.executionModel_) {
case MyOpenSpace.RequestProcessor_.ExecutionModel_.SERIAL: //one after the other
this.process();
break;
case MyOpenSpace.RequestProcessor_.ExecutionModel_.ASYNC: // all async at once
for (var i=0;i<=this.workItemPool_.size();i++)
{
var workItem = this.workItemPool_.pop();
this.process(workItem);
}
break;
case MyOpenSpace.RequestProcessor_.ExecutionModel_.THROTTLED: // one after the other + delay
this.processWithDelay();
break;
}
},
/**
* process will execute a workItem
* @param {MyOpenSpace.RequestProcessor_.WorkItem} workItem to process; if omitted - pop the next work item from queue.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
process: function(workItem) {
if (workItem) {
this.requestActions_[workItem.type](workItem);
return;
}
workItem = this.workItemPool_.pop();
if(workItem)
this.requestActions_[workItem.type](workItem);
if(this.executionModel_ === MyOpenSpace.RequestProcessor_.ExecutionModel_.THROTTLED)
this.processWithDelay();
//else if (this.workItemPool_.size() > 0 && !this.paused_ && !this.aborted_)
//this.process(); // queue up next work item immediately
},
/**
* processWithDelay will execute a workItem, then set an interval of executionInterval before executing the next work item; so long as pauseProcessing() or abortProcessing() has not be invoked.
* @param {MyOpenSpace.RequestProcessor_.WorkItem} workItem to process; if omitted - pop the next work item from queue.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
processWithDelay: function() {
//var workItem = this.workItemPool_.pop();
var pointer = this;
if (pointer.workItemPool_.size() > 0 && !pointer.paused_ && !pointer.aborted_)
setTimeout(function () { pointer.process(); }, pointer.executionInterval_); // queue up next work item after executionInterval ms
//this.requestActions_[workItem.type](workItem);
},
/**
* pauseProcessing will pause the execution of SERIAL and THROTTLED execution models, resumeProcessing() will continue execution.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
pauseProcessing: function() {
this.paused_ = true;
},
/**
* abortProcessing will stop the execution of SERIAL and THROTTLED execution models, with no option to recover.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
abortProcessing: function() {
this.aborted_ = true;
},
/**
* resumeProcessing will unpause the execution of SERIAL and THROTTLED execution models.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
resumeProcessing: function() {
this.paused_ = false;
},
/**
* throttleProcessingSpeed sets the delay between work item processing in THROTTLED execution model.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
throttleProcessingSpeed: function(msDelay) {
this.executionInterval_ = msDelay;
},
/**
* delayShiftQueue is a delay shift queue implementation. Only shifts queue after (len/2) pops to save cycles.
* @memberOf MyOpenSpace.RequestProcessor_
* @internal
*/
delayShiftQueue: function(){
var q=new Array();
var qSpace=0;
/**
* push will add a work item to the queue
* @param {MyOpenSpace.RequestProcessor_.WorkItem} element Work item to add to the queue.
* @internal
*/
this.push=function(element){
q.push(element);
};
/**
* pop will return the next work item in the queue. Queue will be shifted once length/2 calls have been made to this function.
* @internal
*/
this.pop=function(){
if (q.length){
var element=q[qSpace];
if (++qSpace*2 >= q.length){
for (var i=qSpace;i b.priority) return -1;
if (a.priority == b.priority) return 0;
if (a.priority < b.priority) return 1;
};
}
};
if (typeof(MyOpenSpace.RequestProcessor_.WorkItem) == "undefined") MyOpenSpace.RequestProcessor_.WorkItem = {};
/**
* Adds work item properties to a DataRequest for processing within the queue.
* @constructor MyOpenSpace.RequestProcessor_.WorkItem
* @param {MyOpenSpace._DataRequest} request The datarequest associated with the work item.
* @internal
*/
MyOpenSpace.RequestProcessor_.WorkItem = new function(request){
this.Request = request;
this.CreationTime = new Date().getTime(); //ms in epoch time
this.QueueTime = null;
this.WorkItemType = null;
this.ProcessStartTime = null;
this.ProcessEndTime = null;
this.Priority = MyOpenSpace.RequestProcessor_.WorkItem.NORMAL;
};
/**
* Defines level of priority for work items. Processed in this order: CRITICAL -> HIGH -> NORMAL -> LOW
* Allows for a queue's priority to be calculated as a sum of all work item's priorities.
* We may want to add in a dependency object for work items, so one may process first if another depends on it
* Note: Currently we don't use priorities for anything.
* @static
* @class
* @name Priority
* @internal
*/
MyOpenSpace.RequestProcessor_.WorkItem.Priority = {
/**
* The integer weight for a low priority item. Decreases queue priority.
* @memberOf MyOpenSpace.RequestProcessor_.WorkItem.Priority
* @internal
*/
"LOW": -1,
/**
* The integer weight for a normal priority item. Does not affect queue priority.
* @memberOf MyOpenSpace.RequestProcessor_.WorkItem.Priority
* @internal
*/
"NORMAL": 0,
/**
* The integer weight for a high priority item. Increases queue's priority.
* @memberOf MyOpenSpace.RequestProcessor_.WorkItem.Priority
* @internal
*/
"HIGH": 1,
/**
* The integer weight for a critical priority item. Increases queue's priority by twice magnitude of high.
* @memberOf MyOpenSpace.RequestProcessor_.WorkItem.Priority
* @internal
*/
"CRITICAL": 2
};
