features.opensocial-base.fieldtranslations.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shindig-features
Packages all the features that shindig provides into a single jar file to allow loading from the classpath
The newest version!
/*
 * 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 Helper class used to translate from the 0.8 server apis to the 0.8 js apis
 * (which are unfortunately not the same).
 */

window['FieldTranslations'] = (function() {
  // code that is used internally
  function translateEnumJson(enumJson) {
    if (enumJson) {
      enumJson.key = enumJson.value;
    }
  };

  function translateUrlJson(urlJson) {
    if (urlJson) {
      urlJson.address = urlJson.value;
    }
  };

  return {
    'translateEnumJson' : translateEnumJson,
    'translateUrlJson' : translateUrlJson,
    'translateServerPersonToJsPerson' :
        function(serverJson, opt_params) {
          if (serverJson.emails) {
            for (var i = 0; i < serverJson.emails.length; i++) {
              serverJson.emails[i].address = serverJson.emails[i].value;
            }
          }

          if (serverJson.phoneNumbers) {
            for (var p = 0; p < serverJson.phoneNumbers.length; p++) {
              serverJson.phoneNumbers[p].number = serverJson.phoneNumbers[p].value;
            }
          }

          if (serverJson.birthday) {
            serverJson.dateOfBirth = serverJson.birthday;
          }

          if (serverJson.utcOffset) {
            serverJson.timeZone = serverJson.utcOffset;
          }

          if (serverJson.addresses) {
            for (var j = 0; j < serverJson.addresses.length; j++) {
              serverJson.addresses[j].unstructuredAddress = serverJson.addresses[j].formatted;
            }
          }

          if (serverJson.gender) {
            var key = serverJson.gender == 'male' ? 'MALE' :
                (serverJson.gender == 'female') ? 'FEMALE' :
                null;
            serverJson.gender = {key: key, displayValue: serverJson.gender};
          }

          translateUrlJson(serverJson.profileSong);
          translateUrlJson(serverJson.profileVideo);

          if (serverJson.urls) {
            for (var u = 0; u < serverJson.urls.length; u++) {
              translateUrlJson(serverJson.urls[u]);
            }
          }

          translateEnumJson(serverJson.drinker);
          translateEnumJson(serverJson.lookingFor);
          translateEnumJson(serverJson.networkPresence);
          translateEnumJson(serverJson.smoker);

          if (serverJson.organizations) {
            serverJson.jobs = [];
            serverJson.schools = [];

            for (var o = 0; o < serverJson.organizations.length; o++) {
              var org = serverJson.organizations[o];
              if (org.type == 'job') {
                serverJson.jobs.push(org);
              } else if (org.type == 'school') {
                serverJson.schools.push(org);
              }
            }
          }

          if (serverJson.name) {
            serverJson.name.unstructured = serverJson.name.formatted;
          }

          if (serverJson.appData) {
            serverJson.appData = opensocial.Container.escape(
                serverJson.appData, opt_params, true);
          }

        },


    'translateJsPersonFieldsToServerFields' :
        function(fields) {
          for (var i = 0; i < fields.length; i++) {
            if (fields[i] == 'dateOfBirth') {
              fields[i] = 'birthday';
            } else if (fields[i] == 'timeZone') {
              fields[i] = 'utcOffset';
            } else if (fields[i] == 'jobs') {
              fields[i] = 'organizations';
            } else if (fields[i] == 'schools') {
              fields[i] = 'organizations';
            }
          }

          // displayName and id always need to be requested
          fields.push('id');
          fields.push('displayName');
        },

    'translateIsoStringToDate' : function(isoString) {
      // Date parsing code from http://delete.me.uk/2005/03/iso8601.html
      var regexp = '([0-9]{4})(-([0-9]{2})(-([0-9]{2})' +
          '(T([0-9]{2}):([0-9]{2})(:([0-9]{2})(\.([0-9]+))?)?' +
          '(Z|(([-+])([0-9]{2}):([0-9]{2})))?)?)?)?';
      var d = isoString.match(new RegExp(regexp));

      var offset = 0;
      var date = new Date(d[1], 0, 1);

      if (d[3]) { date.setMonth(d[3] - 1); }
      if (d[5]) { date.setDate(d[5]); }
      if (d[7]) { date.setHours(d[7]); }
      if (d[8]) { date.setMinutes(d[8]); }
      if (d[10]) { date.setSeconds(d[10]); }
      if (d[12]) { date.setMilliseconds(Number('0.' + d[12]) * 1000); }
      if (d[14]) {
        offset = (Number(d[16]) * 60) + Number(d[17]);
        offset *= ((d[15] == '-') ? 1 : -1);
      }

      offset -= date.getTimezoneOffset();
      var time = (Number(date) + (offset * 60 * 1000));

      return new Date(Number(time));
    },

    /**
     * AppData is provided by the REST and JSON-RPC protocols using
     * an "appData" or "appData.key" field, but is described by
     * the JS fetchPerson() API in terms of an appData param.  Translate
     * between the two.
     */
    'addAppDataAsProfileFields' : function(opt_params) {
      if (opt_params) {
        // Push the appData keys in as profileDetails
        if (opt_params['appData']) {
          var appDataKeys = opt_params['appData'];
          if (typeof appDataKeys === 'string') {
            appDataKeys = [appDataKeys];
          }

          var profileDetail = opt_params['profileDetail'] || [];
          for (var i = 0; i < appDataKeys.length; i++) {
            if (appDataKeys[i] === '*') {
              profileDetail.push('appData');
            } else {
              profileDetail.push('appData.' + appDataKeys[i]);
            }
          }

          opt_params['appData'] = appDataKeys;
        }
      }
    },

    /**
     * Translate standard Javascript arguments to JSON-RPC protocol format.
     */
    'translateStandardArguments' :
        function(opt_params, rpc_params) {
          if (opt_params['first']) {
            rpc_params.startIndex = opt_params['first'];
          }
          if (opt_params['max']) {
            rpc_params.count = opt_params['max'];
          }
          if (opt_params['sortOrder']) {
            rpc_params.sortBy = opt_params['sortOrder'];
          }
          if (opt_params['filter']) {
            rpc_params.filterBy = opt_params['filter'];
          }
          if (opt_params['filterOp']) {
            rpc_params.filterOp = opt_params['filterOp'];
          }
          if (opt_params['filterValue']) {
            rpc_params.filterValue = opt_params['filterValue'];
          }
          if (opt_params['fields']) {
            rpc_params.fields = opt_params['fields'];
          }
        },

    /**
     * Translate network distance from id spec to JSON-RPC parameters.
     */
    'translateNetworkDistance' :
        function(idSpec, rpc_params) {
          if (idSpec.getField('networkDistance')) {
            rpc_params.networkDistance = idSpec.getField('networkDistance');
          }
        }
        // end of returned Object, please no commas
  };
})();