drupalgap.js

var drupalgap = {
  'modules':{
    'core':[
       {'name':'api'},
       {'name':'block'},
       {'name':'comment'},
       {'name':'entity'},
       {'name':'field'},
       {'name':'image'},
       {'name':'menu'},
       {'name':'mvc'},
       {'name':'node'},
       {'name':'services',
         'includes':[
           {'name':'comment'},
           {'name':'drupalgap_content'},
           {'name':'drupalgap_system'},
           {'name':'drupalgap_taxonomy'},
           {'name':'drupalgap_user'},
           {'name':'file'},
           {'name':'node'},
           {'name':'services'},
           {'name':'system'},
           {'name':'taxonomy_term'},
           {'name':'taxonomy_vocabulary'},
           {'name':'user'},
         ]
       },
       {'name':'system'},
       {'name':'taxonomy'},
       {'name':'user'},
       {'name':'views_datasource'},
     ]
  },
  'module_paths':[],
  'includes':[
      {'name':'common'},
      {'name':'file'},
      {'name':'form'},
      {'name':'menu'},
      {'name':'module'},
      {'name':'theme'},
  ],
  /**
   * User Default Values
   *   Do not change these values unless you are feeling adventurous.
   */
  'user':{
    'uid':0,
    'name':'Anonymous', /* TODO - this value should come from the drupal site */
    'roles':{
      '1':'anonymous user'
    },
  },
  'online':false,
  'destination':'',
  'api':{},
  'back':false, /* moving backwards or not */
  'back_path':'', /* the path to move back to */
  'blocks':[],
  'entity_info':{},
  'field_info_fields':{},
  'field_info_instances':{},
  /*field_widget_info:{},*/
  'form_errors':{},
  'form_states':[],
  loading:false, /* indicates if the loading message is shown or not */
  'menus':{},
  'menu_links':{},
  'menu_router':{},
  'mvc':{
    'models':{},
    'views':{},
    'controllers':{}
  },
  'output':'', /* hold output generated by menu_execute_active_handler() */
  'page':{
    'jqm_events':[],
    'title':'',
    'variables':{},
    'process':true,
    options:{}, /* holds onto the current page's options, e.g. reloadPage, etc. */
  },
  'pages':[], /* Collection of page ids that are loaded into the DOM. */
  'path':'', /* The current menu path. */
  'router_path':'', /* The current menu router path. */
  'services':{},
  'sessid':null,
  taxonomy_vocabularies:false, /* holds the services index of vocabularies */
  'theme_path':'',
  'themes':[],
  'theme_registry':{},
  'views_datasource':{},
}; // <!-- drupalgap -->

/**
 * Given a path to a javascript file relative to the app's www directory,
 * this will load the javascript file so it will be available in scope.
 */
function drupalgap_add_js() {
  try {
    var data;
    if (arguments[0]) { data = arguments[0]; }
    jQuery.ajax({
      async:false,
      type:'GET',
      url:data,
      data:null,
      success:function(){
        if (drupalgap.settings.debug) {
          // Print the js path to the console.
          console.log(data);
        }
      },
      dataType:'script',
      error: function(xhr, textStatus, errorThrown) {
        console.log(JSON.stringify(xhr));
        alert('drupalgap_add_js - error - (' + data + ' : ' + textStatus + ') ' + errorThrown);
      }
    });
  }
  catch (error) {
    alert('drupalgap_add_js - ' + error);
  }
}

/**
 * Given a path to a css file relative to the app's www directory, this will
 * attempt to load the css file so it will be available in scope.
 */
function drupalgap_add_css() {
  try {
    var data;
    if (arguments[0]) { data = arguments[0]; }
    $('<link/>', {rel: 'stylesheet', href: data}).appendTo('head');
  }
  catch (error) {
    alert('drupalgap_add_css - ' + error);
  }
}

/**
 * Rounds up all blocks defined by hook_block_info and places them in the
 * drupalgap.blocks array.
 */
function drupalgap_blocks_load() {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_blocks_load()');
      console.log(JSON.stringify(arguments));
    }
    /*drupalgap.blocks[0] = {};
    var modules = module_implements('block_info');
    if (modules) {
      $.each(modules, function(index, module){
          var blocks = module_invoke(module, 'block_info');
          if (blocks) {
            $.each(blocks, function(delta, block){
              // Assign the delta as the name of the block, set the delta of the
              // block as well, and set the module name on the block for reference.
              block.name = delta;
              block.delta = delta;
              block.module = module;
              // Add the block to drupalgap.blocks.
              eval("drupalgap.blocks[0]." + delta + " = block;");
              //drupalgap.blocks[delta] = block;
            });
          }
      });
    }*/
    drupalgap.blocks = module_invoke_all('block_info');
    if (drupalgap.settings.debug) {
      console.log(JSON.stringify(drupalgap.blocks));
    }
  }
  catch (error) {
    alert('drupalgap_blocks_load - ' + error);
  }
}

/**
 * Loads up all necessary assets to make DrupalGap ready.
 */
function drupalgap_bootstrap() {
  try {
    // Load up settings.
    drupalgap_settings_load();
    // Load up includes.
    drupalgap_includes_load();
    // Load up modules.
    drupalgap_modules_load();
    // Load up the theme.
    drupalgap_theme_load();
    // Load up blocks.
    drupalgap_blocks_load();
    // Initialize menu links.
    menu_router_build();
    // Initialize menus.
    drupalgap_menus_load();
    // Initialize the theme registry.
    drupalgap_theme_registry_build();
    // Initialize field widgets.
    //drupalgap_field_widgets_load();
    // Attach device back button handler (Android).
    document.addEventListener("backbutton", drupalgap_back, false); 
  }
  catch (error) {
    alert('drupalgap_bootstrap - ' + error);
  }
}

/**
 * Takes option set 2, grabs the success/error callback(s), if any,
 * and appends them onto option set 1's callback(s), then returns
 * the newly assembled option set.
 */
function drupalgap_chain_callbacks(options_set_1, options_set_2) {

  //console.log(JSON.stringify(options_set_1));
  //console.log(JSON.stringify(options_set_2));

  // Setup the new options.
  var new_options_set = {};
  $.extend(true, new_options_set, options_set_1);

  // Chain the success callbacks.
  if (options_set_2.success) {
    if (new_options_set.success) {
      if (!$.isArray(new_options_set.success)) {
        var backup = new_options_set.success;
        new_options_set.success = [];
        new_options_set.success.push(backup);
      }
      new_options_set.success.push(options_set_2.success);
    }
    else {
      new_options_set.success = options_set_2.success;
    }
  }

  // Chain the error callbacks.
  if (options_set_2.error) {
    if (new_options_set.error) {
      if (!$.isArray(new_options_set.error)) {
        var backup = new_options_set.error;
        new_options_set.error = [];
        new_options_set.error.push(backup);
      }
      new_options_set.error.push(options_set_2.error);
    }
    else {
      new_options_set.error = options_set_2.error;
    }
  }

  // For all other variables in option set 2, add them to the new option set.
  $.each(options_set_2, function(index, object){
    if (index != 'success' && index != 'error') {
      new_options_set[index] = object;
    }
  });

  // Return the new option set.
  //console.log(JSON.stringify(new_options_set));
  return new_options_set;
}

/**
 * Checks the devices connection and sets drupalgap.online to true if the
 * device has a connection, false otherwise.
 * @returns A string indicating the type of connection according to PhoneGap.
 */
function drupalgap_check_connection() {
  try {
    // We'll assume that Ripple emulation always has a connection, for now.
    // http://stackoverflow.com/q/15950382/763010
    if (typeof parent.window.ripple === 'function') {
      drupalgap.online = true;
      return 'Ethernet connection';
    }
    
    var networkState = navigator.connection.type;
    var states = {};
    states[Connection.UNKNOWN]  = 'Unknown connection';
    states[Connection.ETHERNET] = 'Ethernet connection';
    states[Connection.WIFI]     = 'WiFi connection';
    states[Connection.CELL_2G]  = 'Cell 2G connection';
    states[Connection.CELL_3G]  = 'Cell 3G connection';
    states[Connection.CELL_4G]  = 'Cell 4G connection';
    states[Connection.NONE]     = 'No network connection';
    if (states[networkState] == 'No network connection') {
      drupalgap.online = false;
    }
    else {
      drupalgap.online = true;
    }
    return states[networkState];
  }
  catch (error) {
    alert('drupalgap_check_connection - ' + error);
  }
}

/**
 * Implements PhoneGap's deviceready().
 */
function drupalgap_deviceready() {
  // PhoneGap is loaded and it is now safe for DrupalGap to start...
  drupalgap_bootstrap();
  
  // Verify site path is set.
  if (!drupalgap.settings.site_path || drupalgap.settings.site_path == '') {
    navigator.notification.alert(
        'No site path to Drupal set in the app/settings.js file!',
        function(){},
        'Error',
        'OK'
    );
    return false;
  }
  // Check device connection. If the device is offline, warn the user and then
  // go to the offline page.
  drupalgap_check_connection();
  if (!drupalgap.online) {
    module_invoke_all('device_offline');
    navigator.notification.alert(
        'No connection found!',
        function(){ drupalgap_goto('offline'); },
        'Offline',
        'OK'
    );
    return false;
  }
  else {

    // Device is online, let's call any implementations of hook_deviceready().
    // If any implementation returns false, that means they don't want DrupalGap
    // to continue with the System Connect call, so we'll skip that and go
    // straight to the App's front page.
    var proceed = true;
    var invocation_results = module_invoke_all('deviceready');
    if (invocation_results && invocation_results.length > 0) {
      $.each(invocation_results, function(index, object){
          if (object === false) {
            proceed = false;
            return false;
          }
      });
    }
    if (!proceed) {
      drupalgap_goto('');
      // TODO - if module's are going to skip the System Connect call, then we
      // need to make sure drupalgap.user is set up with appropriate defaults.
    }
    else {
      // Device is online, let's build the default system connect options.
      var options = {
        'success':function(result){
          // Call all hook_device_connected implementations then go to
          // the front page.
          module_invoke_all('device_connected');
          drupalgap_goto('');
        },
        'error':function(jqXHR, textStatus, errorThrown) {
          // Build an informative error message and display it.
          var msg = 'drupalgap_deviceready() - failed connection to ' +
            drupalgap.settings.site_path;
          if (errorThrown != '') { msg += ' - ' + errorThrown; }
          msg += ' - Check your device\'s connection and check that ' + drupalgap.settings.site_path +
                 ' is online. If you continue to have problems visit ' + 
                 'www.drupalgap.org for troubleshooting info.';
          navigator.notification.alert(
              msg,
              function(){ drupalgap_goto('offline'); },
              'Unable to Connect to Drupal',
              'OK'
          );
        }
      };
      
      // If we have a session id in local storage, then we'll use it as the
      // CSRF token when making the initial call to system connect. This will
      // determine if the user is still authenticated with Drupal or not.
      var token = window.localStorage.getItem('sessid');
      if (token) {
        drupalgap.sessid = token;
        options.token = token;
        options.beforeSend = function (request) {
          request.setRequestHeader("X-CSRF-Token", options.token);
        };
      }
      
      // DrupalGap System Connect Service Resource
      drupalgap.services.drupalgap_system.connect.call(options);
    }
  }
}

/**
 * Returns true if given value is empty. A generic way to test for emptiness.
 */
function drupalgap_empty(value) {
  return (typeof value === "undefined" || value === null || value == '');
}

/**
 *
 */
/*function drupalgap_field_widgets_load() {
  try {
    var modules = module_implements('field_widget_info');
    if (!modules) { return null; }
    $.each(modules, function(i, module){
        var field_widgets = module_invoke(module, 'field_widget_info');
        if (!field_widgets) { return; }
        $.each(field_widgets, function(name, field_widget){
            $.each(field_widget.field_types, function(j, field_type){
                drupalgap.field_widget_info[field_type] = {
                  'module':module,
                  'field_widget':name
                };
            });
        });
    });
  }
  catch (error) {
    alert('drupalgap_field_widgets_load - ' + error);
  }
}*/

/**
 * Checks if a given file exists, returns true or false.
 * @param  {string} path
 *   A path to a file
 * @return {bool}
 *   True if file exists, else flase
 */
function drupalgap_file_exists(path) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_file_exists(' + path + ')');
    }
    var file_exists = false;
    jQuery.ajax({
      async:false,
      type:'HEAD',
      url:path,
      success:function(){ file_exists = true; },
      error:function(xhr, textStatus, errorThrown) { }
    });
    return file_exists;
  }
  catch (error) {
    alert('drupalgap_file_exists - ' + error);
  }
}

/**
 * Reads entire file into a string and returns the string. Returns false if
 * it fails.
 */
function drupalgap_file_get_contents(path, options) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_file_get_contents(' + path + ')');
    }
    var file = false;
    var default_options = {
      type:'GET',
      url:path,
      dataType:'html',
      data:null,
      async:false,
      success:function(data){ file = data; },
      error: function(xhr, textStatus, errorThrown) {
        console.log('drupalgap_file_get_contents - failed to load file (' + path + ')');
      }
    };
    $.extend(default_options, options);
    jQuery.ajax(default_options);
    return file;
  }
  catch (error) {
    alert('drupalgap_file_get_contents - ' + error);
  }
}


/**
 * See drupal_format_plural() for more information.
 * http://api.drupal.org/api/drupal/includes%21common.inc/function/format_plural/7
 */
function drupalgap_format_plural(count, singular, plural) {
  try {
    if (count == 1) {
      return singular;
    }
    return plural;
  }
  catch (error) {
    alert('drupalgap_format_plural - ' + error);
  }
  return null;
}

/**
 * Given a JS function, this returns true if the function is available in the
 * scope, false otherwise.
 */
function drupalgap_function_exists(name) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_function_exists(' + name + ')');
    }
    return (eval('typeof ' + name) == 'function');
  }
  catch (error) {
    alert('drupalgap_function_exists - ' + error);
  }
}

/**
 * Given an html string from a *.tpl.html file, this will extract all of the
 * placeholders names and return them in an array. Returns false otherwise.
 */
function drupalgap_get_placeholders_from_html(html) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_get_placeholders_from_html()');
      console.log(JSON.stringify(arguments));
    }
    var placeholders = false;
    if (html) {
      placeholders = html.match(/(?!{:)([\w]+)(?=:})/g);
    }
    return placeholders;
  }
  catch (error) {
    alert('drupalgap_get_placeholders_from_html - ' + error);
  }
}


/**
 *
 * @param type
 * @param name
 */
function drupalgap_get_path(type, name) {
  try {
    var path = '';
    var found_it = false;
    if (type == 'module') {
      $.each(drupalgap.modules, function(bundle, modules){
        $.each(modules, function(index, module){
          if (name == module.name) {
            path = drupalgap_modules_get_bundle_directory(bundle) + '/';
            path += module.name;
            found_it = true;
          }
          if (found_it) {
            return false;
          }
        });
        if (found_it) {
          return false;
        }
      });
    }
    return path;
  }
  catch (error) {
    alert('drupalgap_get_path - ' + error);
  }
  return null;
}

/**
 * Implementation of drupal_get_title().
 */
function drupalgap_get_title() {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_get_title()');
      console.log(JSON.stringify(arguments));
    }
    return drupalgap.page.title;
  }
  catch (error) {
    alert('drupalgap_get_title - ' + error);
  }
}

/**
 * Given a router path, this will return an array containing the indexes of
 * where the wildcards (%) are present in the router path. Returns false if
 * there are no wildcards present.
 */
function drupalgap_get_wildcards_from_router_path(router_path) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_get_wildcards_from_router_path(' + router_path + ')');
    }
    var wildcards = false;

    return wildcards;
  }
  catch (error) {
    alert('drupalgap_get_wildcards_from_router_path - ' + error);
  }
}


/**
 * Given a drupal image file uri, this will return the path to the image on the
 * Drupal site.
 */
function drupalgap_image_path(uri) {
  try {
    var altered = false;
    // If any modules want to alter the path, let them do it.
    var modules = module_implements('image_path_alter');
    if (modules) {
      $.each(modules, function(index, module){
          var result = module_invoke(module, 'image_path_alter', uri);
          if (result) {
            altered = true;
            uri = result;
            return false;
          }
      });
    }
    if (!altered) {
      // No one modified the image path, we'll use the default approach to
      // generating the image src path.
      var src = drupalgap.settings.site_path + drupalgap.settings.base_path + uri;
      if (src.indexOf('public://') != -1) {
        src = src.replace('public://', drupalgap.settings.file_public_path + '/');
      }
      return src;
    }
    else { return uri; }
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Loads the js files in includes specified by drupalgap.includes.
 */
function drupalgap_includes_load() {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_includes_load()');
      console.log(JSON.stringify(drupalgap.includes));
    }
    if (drupalgap.includes != null && drupalgap.includes.length != 0) {
      $.each(drupalgap.includes, function(index, include){
          var include_path =  'includes/' + include.name + '.inc.js';
          jQuery.ajax({
              async:false,
              type:'GET',
              url:include_path,
              data:null,
              success:function(){
                if (drupalgap.settings.debug) {
                  // Print the include path to the console.
                  console.log(include_path);
                }
              },
              dataType:'script',
              error: function(xhr, textStatus, errorThrown) {
                console.log(errorThrown);
                  // Look at the `textStatus` and/or `errorThrown` properties.
              }
          });
      });
    }
  }
  catch (error) {
    alert('drupalgap_includes_load - ' + error);
  }
}

/**
 * Given an html list element id and an array of items, this will clear the
 * list, populate it with the items, and then refresh the list.
 */
function drupalgap_item_list_populate(list_css_selector, items) {
  try {
    // TODO - this could use some validation and alerts for improper input.
    $(list_css_selector).html("");
    for (var i = 0; i < items.length; i ++) {
      $(list_css_selector).append($("<li></li>",{"html":items[i]}));
    }
    $(list_css_selector).listview('refresh').listview();
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Given a jQM page event, and the corresponding callback function name that
 * handles the event, this function will call the callback function, if it has
 * not already been called on the current page. This really is only used by
 * menu_execute_active_handler() to prevent jQM from firing inline page event
 * handlers more than once.
 */
function drupalgap_jqm_page_event_fire(event, callback, page_arguments) {
  try {
    // Concatenate the event name and the callback name together into a unique
    // key so multiple callbacks can handle the same event.
    var key = event + '-' + callback;
    if ($.inArray(key, drupalgap.page.jqm_events) == -1 && drupalgap_function_exists(callback)) {
      drupalgap.page.jqm_events.push(key);
      var fn = window[callback];
      if (page_arguments) {
        // If the page arguments aren't an array, place them into an array so
        // they can be applied to the callback function.
        if (!$.isArray(page_arguments)) { page_arguments = [page_arguments]; }
        fn.apply(null, Array.prototype.slice.call(page_arguments));
      }
      else { fn(); }
    }
  }
  catch (error) {
    alert('drupalgap_jqm_page_event_fire - ' + error);
  }
}

/**
 * Returns array of jQM Page event names.
 *   http://api.jquerymobile.com/category/events/
 */
function drupalgap_jqm_page_events() {
  try {
    return [
      'pagebeforechange',
      'pagebeforecreate',
      'pagebeforehide',
      'pagebeforeload',
      'pagebeforeshow',
      'pagechange',
      'pagechangefailed',
      'pagecreate',
      'pagehide',
      'pageinit',
      'pageload',
      'pageloadfailed',
      'pageremove',
      'pageshow'
    ];        
  }
  catch (error) {
    alert('drupalgap_jqm_page_events - ' + error);
  }
}

/**
 * Given a JSON object with a page id, a jQM page event name, a callback
 * function to handle the jQM page event and any page arguments, this function
 * will return the inline JS code needed to handle the event.
 */
function drupalgap_jqm_page_event_script_code(options) {
  try {
    var script_code = '<script type="text/javascript">' +
      '$("#' + options.page_id + '").on("' + options.jqm_page_event + '", drupalgap_jqm_page_event_fire("' +
        options.jqm_page_event + '", "' +
        options.jqm_page_event_callback + '", ' +
        options.jqm_page_event_args +
      '));' +
    '</script>';
    return script_code;
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Show the jQueryMobile loading message.
 */
function drupalgap_loading_message_show() {
  try {
    // Backwards compatability for versions prior to 7.x-1.6-alpha
    if (drupalgap.loading === 'undefined') { drupalgap.loading = false; }
    // Return if the loading message is already shown.
    if (drupalgap.loading) { return; }
    // Set default options. Override the options if any were set or sent in.
    var options = {
      text: 'Loading...',
      textVisible: true
    };
    if (drupalgap.settings.loading) { options = drupalgap.settings.loading; }
    if (arguments[0]) { options = arguments[0]; }
    // Show the loading message.
    $.mobile.loading("show", options);
    drupalgap.loading = true;
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Hide the jQueryMobile loading message.
 */
function drupalgap_loading_message_hide() {
  try {
    $.mobile.hidePageLoadingMsg();
    drupalgap.loading = false;
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Returns the suggested max width for elements within the content area.
 */
function drupalgap_max_width() {
  try {
    var padding = parseInt($('.ui-content').css('padding'));
    if (isNaN(padding)) { padding = 16; } // use a 16px default if needed
    return $(document).width() - padding*2;
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Checks to see if the current user has access to the given path. Returns true
 * if the user has access, false otherwise. You may optionally pass in a user
 * account object as the second argument to check access on a specific user.
 */
function drupalgap_menu_access(path) {
  try {
    // User #1 is allowed to do anything, I mean anything.
    if (drupalgap.user.uid == 1) { return true; }
    // Everybody else will not have access unless we prove otherwise.
    var access = false;
    if (drupalgap.menu_links[path]) {
      // Check to see if there is an access callback specified with the menu link.
      if (typeof drupalgap.menu_links[path].access_callback === 'undefined') {
        // No access call back specified, if there are any access arguments
        // on the menu link, then it is assumed they are user permission machine
        // names, so check that user account's role(s) for that permission to
        // grant access.
        if (drupalgap.menu_links[path].access_arguments) {
          // TODO - implement
        }
        else {
          // There is no access callback and no access arguments specified with
          // the menu link, so we'll assume everyone has access.
          access = true;
        }
      }
      else {
        
        // An access callback function is specified for this path...
        
        // START HERE: https://github.com/signalpoint/DrupalGap/issues/191
        
        var function_name = drupalgap.menu_links[path].access_callback;
        if (drupalgap_function_exists(function_name)) {
          // Grab the access callback function and make a copy of the path's
          // access arguments.
          var fn = window[function_name];
          var access_arguments = drupalgap.menu_links[path].access_arguments.slice(0);
          var args = arg();
          drupalgap_prepare_argument_entities(access_arguments, args);
          return fn.apply(null, Array.prototype.slice.call(access_arguments));
        }
        else {
          alert('drupalgap_menu_access - access call back (' + function_name + ') does not exist');
        }
      }
    }
    else {
      alert('drupalgap_menu_access - path (' + path + ') does not exist');
    }
    return access;
  }
  catch (error) {
    alert('drupalgap_menu_access - ' + error);
  }
}

/**
 * Given a module name, this will return the module inside drupalgap.modules.
 */
function drupalgap_module_load(module_name) {
  try {
    var loaded_module = null;
    $.each(drupalgap.modules, function(bundle, modules){
        if (!loaded_module) {
          $.each(modules, function(index, module){
              if (module.name == module_name) {
                // Save reference to module, then break out of loop.
                loaded_module = module;
                return false;
              }
          });
        }
        else {
          // Module loaded, break out of loop.
          return false;
        }
    });
    return loaded_module;
  }
  catch (error) { alert('drupalgap_module_load - ' + error); }
}

/**
 * Given a module bundle type, this will return the path to that module bundle's
 * directory.
 */
function drupalgap_modules_get_bundle_directory(bundle) {
  try {
    dir = '';
    if (bundle == 'core') { dir = 'modules'; }
    else if (bundle == 'contrib') { dir = 'app/modules'; }
    else if (bundle == 'custom') { dir = 'app/modules/custom'; }
    return dir;
  }
  catch (error) {
    alert('drupalgap_modules_get_bundle_directory - ' + error);
  }
  return '';
}

/**
 * Loads each drupalgap module so they are available in the JS scope.
 */
function drupalgap_modules_load() {
  if (drupalgap.modules != null && drupalgap.modules.length != 0) {
    $.each(drupalgap.modules, function(bundle, modules){
      $.each(modules, function(index, module){
        // Determine module directory.
        dir = drupalgap_modules_get_bundle_directory(bundle);
        module_base_path = dir + '/' + module.name;
        // Add module .js file to array of paths to load.
        module_path =  module_base_path + '/' + module.name + '.js';
        modules_paths = [module_path];
        // If there are any includes with this module, add them to the list of
        // paths to include.
        if (module.includes != null && module.includes.length != 0) {
          $.each(module.includes, function(include_index, include_object){
            modules_paths.push(module_base_path + '/' + include_object.name + '.js');
          });
        }
        // Now load all the paths for this module.
        $.each(modules_paths, function(modules_paths_index, modules_paths_object){
          jQuery.ajax({
              async:false,
              type:'GET',
              url:modules_paths_object,
              data:null,
              success:function(){
                if (drupalgap.settings.debug) {
                  // Print the module path to the console.
                  console.log(modules_paths_object);
                }
              },
              dataType:'script',
              error: function(xhr, textStatus, errorThrown) {
                alert('Failed to load module! (' + module.name + ')');
                  // Look at the `textStatus` and/or `errorThrown` properties.
              }
          });
        });
      });
    });
    // Now invoke hook_install on all modules.
    module_invoke_all('install');
  }
}

/**
 * Given a router path (and optional path, defaults to current drupalgap path if
 * one isn't provided), this takes the path's arguments and replaces any
 * wildcards (%) in the router path with the corresponding path argument(s). It
 * then returns the assembled path. Returns false otherwise.
 */
function drupalgap_place_args_in_path(input_path) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_place_args_in_path(' + input_path + ')');
    }
    var assembled_path = false;
    if (input_path) {

      // Determine path to use and break it up into its args.
      var path = drupalgap_path_get();
      if (arguments[1]) { path = arguments[1]; }
      var path_args = arg(null, path);

      // Grab wild cards from router path then replace each wild card with
      // the corresponding path arg.
      var wildcards;
      var input_path_args = arg(null, input_path);
      if (input_path_args && input_path_args.length > 0) {
        $.each(input_path_args, function(index, arg){
            if (arg == '%') {
              if (!wildcards) { wildcards = []; }
              wildcards.push(index);
            }
        });
        if (wildcards && wildcards.length > 0) {
          $.each(wildcards, function(index, wildcard){
              if (path_args[wildcard]) {
                input_path_args[wildcard] = path_args[wildcard];
              }
          });
          assembled_path = input_path_args.join('/');
        }
      }
    }
    return assembled_path;
  }
  catch (error) {
    alert('drupalgap_place_args_in_path - ' + error);
  }
}
/**
 * Converts a hook_menu items page_arguments path like node/123 so arg zero
 * would be 'node' and arg 1 would be the loaded entity node. Also works for MVC
 * page paths, converts the integer into an MVC item.
 */
function drupalgap_prepare_argument_entities(page_arguments, args) {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_prepare_argument_entities()');
      console.log(JSON.stringify(arguments));
    }
    // If argument zero is an entity type (or base type, e.g. taxonomy), and we
    // have at least one integer argument, replace the page call back's integer
    // argument index with the loaded entity.
    if (args.length > 1 &&
          (
            args[0] == 'comment' ||
            args[0] == 'node' ||
            (args[0] == 'taxonomy' && (args[1] == 'vocabulary' || args[1] == 'term')) ||
            args[0] == 'user' ||
            args[0] == 'item'
          )
    ) {
      var found_int_arg = false;
      var int_arg_index = null;
      for (var i = 0; i < args.length; i++) {
        if (is_int(parseInt(args[i]))) {
          int_arg_index = i; // Save the arg index so we can replace it later.
          found_int_arg = true;
          break;
        }
      }
      if (!found_int_arg) { return; }
      // Determine the naming convention for the entity load function.
      var load_function_prefix = args[0]; // default
      if (args[0] == 'taxonomy') {
        if (args[1] == 'vocabulary' || args[1] == 'term') {
          load_function_prefix = args[0] + '_' + args[1];
        }
      }
      var load_function = load_function_prefix + '_load';
      // If the load function exists, load the entity.
      if (drupalgap_function_exists(load_function)) {
        var entity_fn = window[load_function];
        var entity = null;
        // Load the entity. MVC items need to pass along the module name and
        // model type to its load function. All other entity load functions just
        // need the entity id.
        if (args[0] == 'item') {
          entity = entity_fn(args[1], args[2], parseInt(args[int_arg_index]));
        }
        else {
          // Force a reload (reset) when we load the entity if we are editing
          // the entity.
          if (arg(2) == 'edit') {
            entity = entity_fn(parseInt(args[int_arg_index]), {reset:true});
          }
          else {
             entity = entity_fn(parseInt(args[int_arg_index]));
          }
        }
        // Now that we have the entity loaded, replace the first integer we find
        // in the page arguments with the loaded entity.
        $.each(page_arguments, function(index, page_argument){
            if (is_int(parseInt(page_argument))) {
              page_arguments[index] = entity;
              return false;
            }
        });
      }
      else {
        alert('drupalgap_prepare_argument_entities - load function not implemented! ' + load_function);
      }
    }
  }
  catch (error) {
    alert('drupalgap_prepare_argument_entities - ' + error);
  }
}

/**
 * Given a page id, this will remove it from the DOM.
 */
function drupalgap_remove_page_from_dom(page_id) {
  try {
    $('#' + page_id).empty().remove();
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Implementation of drupal_set_title().
 */
function drupalgap_set_title(title) {
  try {
    if (title) { drupalgap.page.title = title; }
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Loads the settings specified in app/settings.js into the app.
 */
function drupalgap_settings_load() {
  try {
    settings_file_path = 'app/settings.js';
    jQuery.ajax({
      async:false,
      type:'GET',
      url:settings_file_path,
      data:null,
      success:function(){
        if (drupalgap.settings.debug) {
          // Set the title to the settings title.
          drupalgap_set_title(drupalgap.settings.title);
        }
      },
      dataType:'script',
      error: function(xhr, textStatus, errorThrown) {
        navigator.notification.alert(
          'Failed to load the settings.js file in the app folder!',
          function(){},
          'Error',
          'OK'
        );
      }
    });
  }
  catch(error) {
    alert('drupalgap_settings_load - ' + error);
  }
}

/**
 * Load the theme specified by drupalgap.settings.theme into drupalgap.theme
 * Returns true on success, false if it fails.
 */
function drupalgap_theme_load() {
  try {
    if (!drupalgap.settings.theme) {
      alert('drupalgap_theme_load - no theme specified in settings.js');
    }
    else {
      // Pull the theme name from the settings.js file.
      var theme_name = drupalgap.settings.theme;
      // Let's try to load to theme's js file first by looking in the core
      // themes directory, then in the app/themes directory.
      var theme_path = 'themes/' + theme_name + '/' + theme_name + '.js';
      if (!drupalgap_file_exists(theme_path)) {
        theme_path = 'app/themes/' + theme_name + '/' + theme_name + '.js';
        if (!drupalgap_file_exists(theme_path)) {
          alert("drupalgap_theme_load - Failed to load theme! The theme's JS file does not exist: " + theme_path + ')');
          return false;
        }
      }
      // We found the theme's js file, add it to the page.
      drupalgap_add_js(theme_path);
      // Call the theme's template_info implementation.
      var template_info_function = theme_name + '_info';
      if (drupalgap_function_exists(template_info_function)) {
        var fn = window[template_info_function];
        drupalgap.theme = fn();
        if (drupalgap.settings.debug) {
          console.log('theme loaded: ' + theme_name);
          console.log(JSON.stringify(drupalgap.theme));
        }
        // For each region in the name, set the 'name' value on the region JSON.
        $.each(drupalgap.theme.regions, function(name, region){
            drupalgap.theme.regions[name].name = name;
        });
        // Make sure the theme implements the required regions.
        var regions = system_regions_list();
        for (var i = 0; i < regions.length; i++) {
          var region = regions[i];
          if (typeof drupalgap.theme.regions[region] === 'undefined') {
            console.log('WARNING: drupalgap_theme_load() - The "' +
                        theme_name + '" theme does not have the "' + region +
                        '" region specified in "' + theme_name + '_info()."');
          }
        }
        // Theme loaded successfully! Set the drupalgap.theme_path and return
        // true.
        drupalgap.theme_path = theme_path.replace('/' + theme_name + '.js', '');
        return true;
      }
      else {
        alert('drupalgap_theme_load() - failed - ' + template_info_function + '() does not exist!');
      }
    }
    return false;
  }
  catch (error) {
    alert('drupalgap_theme_load - ' + error);
  }
}

/**
 * This calls all implements of hook_theme and builds the DrupalGap theme
 * registry.
 */
function drupalgap_theme_registry_build() {
  try {
    if (drupalgap.settings.debug) {
      console.log('drupalgap_theme_registry_build()');
      console.log(JSON.stringify(arguments));
    }
    var modules = module_implements('theme');
    $.each(modules, function(index, module){
        var function_name = module + '_theme';
        var fn = window[function_name];
        var hook_theme = fn();
        $.each(hook_theme, function(element, variables){
            variables.path = drupalgap_get_path('module', module);
            eval('drupalgap.theme_registry.' + element + ' = variables;');
        });
    });
  }
  catch (error) {
    alert('drupalgap_theme_registry_build - ' + error);
  }
}

/**
 * This is called once the <body> element's onload is fired. We then set the
 * PhoneGap 'deviceready' event listener to drupalgap_deviceready().
 */
function drupalgap_onload() {
  document.addEventListener("deviceready", drupalgap_deviceready, false);
}

/*
 * Given a drupal permission machine name, this function returns true if the
 * current user has that permission, false otherwise.
 */
function user_access(permission) {
  try {
    // Make sure they provided a permission.
    if (permission == null) { return false; }
    // User 1 always has permission.
    if (drupalgap.user.uid == 1) { return true; }
    // For everyone else, assume they don't have permission. Iterate over
    // drupalgap.user.permissions to see if the current user has the given
    // permission, then return the result.
    var access = false;
    if (drupalgap.user.permissions && drupalgap.user.permissions.length != 0) {
      $.each(drupalgap.user.permissions, function(index, user_permission){
        if (permission == user_permission) {
          access = true;
          return;
        }
      });
    }
    return access;
  }
  catch (error) {
    alert("user_access - " + error);
  }
  return false;
}

/**
 * Given a variable name and value, this will save the value to local storage,
 * keyed by its name.
 */
function variable_set(name, value) {
  try {
    if (!value) { value = ' '; } // store null values as a single space*
    else if (is_int(value)) { value = value.toString(); }
    else if (typeof value === 'object') { value = JSON.stringify(value); }
    return window.localStorage.setItem(name, value);
    // * phonegap won't set us store an empty string in local storage
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Given a variable name and a default value, this will first attempt to load
 * the variable from local storage, if it can't then the default value will be
 * returned.
 */
function variable_get(name, default_value) {
  try {
    var value = window.localStorage.getItem(name);
    if (!value) { value = default_value; }
    if (value == ' ') { value = ''; } // convert single spaces to empty strings
    return value;
  }
  catch (error) { drupalgap_error(error); }
}

/**
 * Given an JSON object, this will output it to the console. It accepts an
 * optional boolean as second argument, if it is false the output sent to the
 * console will not use pretty printing in a Chrome/Ripple environment.
 */
function dpm(data) {
  try {
    if (data) {
      // If we're in ripple we can output it directly to the console and it will
      // have pretty printing, otherwise we'll stringify it first.
      // TODO - be careful, when just using console.log() with ripple, it will
      // always print out the final value of data (because of pass by reference)
      // this can be very misleading for debugging things.
      if (typeof parent.window.ripple === 'function') {
        if (typeof arguments[1] !== 'undefined' && arguments[1] == false) {
          console.log(JSON.stringify(data));
        }
        else {
          console.log(data);
        }
      }
      else {
        console.log(JSON.stringify(data));
      }
    }
    else {
      console.log('<null>');
    }
  }
  catch (error) {
    alert('dpm - ' + error);
  }
}

/**
 * Returns the current time as a string with the format: "yyyy-mm-dd hh:mm:ss".
 */
function date_yyyy_mm_dd_hh_mm_ss() {
  try {
    var result;
    if (arguments[0]) { result = arguments[0]; }
    else { result = date_yyyy_mm_dd_hh_mm_ss_parts(); }
    return result['year'] + "-" + result['month'] + "-" + result['day'] + " " +
           result['hour'] + ":" + result['minute'] + ":" + result['second'];
  }
  catch (error) { drupalgap_error(error); }
}
           
/**
 *
 */
function date_yyyy_mm_dd_hh_mm_ss_parts() {
  try {
    var result = [];
    var now = new Date();
    var year = "" + now.getFullYear();
    var month = "" + (now.getMonth() + 1); if (month.length == 1) { month = "0" + month; }
    var day = "" + now.getDate(); if (day.length == 1) { day = "0" + day; }
    var hour = "" + now.getHours(); if (hour.length == 1) { hour = "0" + hour; }
    var minute = "" + now.getMinutes(); if (minute.length == 1) { minute = "0" + minute; }
    var second = "" + now.getSeconds(); if (second.length == 1) { second = "0" + second; }
    result['year'] = year;
    result['month'] = month;
    result['day'] = day;
    result['hour'] = hour;
    result['minute'] = minute;
    result['second'] = second;
    return result;
  }
  catch (error) { drupalgap_error(error); }
}

// http://stackoverflow.com/a/3886106/763010
function is_int(n) {
  if (typeof n === 'string') {
    n = parseInt(n);
  }
  return typeof n === 'number' && n % 1 == 0;
}

/**
 * Javascript equivalent of php's time() function.
 */
function time() {
  var d = new Date();
  return Math.floor(d/1000);
}

function ucfirst (str) {
  // http://kevin.vanzonneveld.net
  // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // +   bugfixed by: Onno Marsman
  // +   improved by: Brett Zamir (http://brett-zamir.me)
  // *     example 1: ucfirst('kevin van zonneveld');
  // *     returns 1: 'Kevin van zonneveld'
  str += '';
  var f = str.charAt(0).toUpperCase();
  return f + str.substr(1);
}