// $Id: popups.js,v 1.9.8.12 2009/03/21 00:57:15 starbow Exp $

/**

 * Popup Modal Dialog API

 *

 * Provide an API for building and displaying JavaScript, in-page, popups modal dialogs.

 * Modality is provided by a fixed, semi-opaque div, positioned in front of the page contents.

 *

 */

/*

 * TODO

 * * Return key in add node form not working.

 * * Tabledrag breaking after ahah reload.

 */

// ***************************************************************************

// DRUPAL Namespace

// ***************************************************************************

/**

 * Attach the popups bevior to the all the requested links on the page.

 *

 * @param context

 *   The jQuery object to apply the behaviors to.

 */

Drupal.behaviors.popups = function(context) {

  Popups.saveSettings();

  var $body = $('body');

  if(!$body.hasClass('popups-processed')) {

    $body.addClass('popups-processed');

    $(document).bind('keydown', Popups.keyHandle);

    var $popit = $('#popit');

    if ($popit.length) {

      $popit.remove();

      Popups.message($popit.html());

    }

  }

  // Add the popups-link-in-dialog behavior to links defined in Drupal.settings.popups.links array.

  // Get these from current Drupal.settings, not Popups.originalSettings, as each page has it's own hooks.

  if (Drupal.settings.popups && Drupal.settings.popups.links) {

    jQuery.each(Drupal.settings.popups.links, function (link, options) { 

      Popups.attach(context, link, Popups.options(options));

    });

  }

  Popups.attach(context, '.popups', Popups.options({updateMethod: 'none'}));  

  Popups.attach(context, '.popups-form', Popups.options({updateMethod: 'ajax'})); // ajax reload.

  Popups.attach(context, '.popups-form-reload', Popups.options({updateMethod: 'reload'})); // whole page reload. 

  Popups.attach(context, '.popups-form-noupdate', Popups.options({updateMethod: 'none'}));  // no reload at all.

};

// ***************************************************************************

// Popups Namespace **********************************************************

// ***************************************************************************

/**

 * The Popups namespace contains:

 * * An ordered stack of Popup objects,

 * * The state of the original page,

 * * Functions for managing both of the above.

 */

Popups = function(){};

/**

 * Static variables in the Popups namespace.

 */

Popups.popupStack = []; 

Popups.addedCSS = [];

Popups.addedJS = [];

Popups.originalSettings = null; // The initial popup options of the page.

/**

 * Each popup object gets it's own set of options.

 * These are the defaults.

 */

Popups.defaultOptions = {

  doneTest: null, // null, *path*, *regexp*. how do we know when a multiform flow is done?

  updateMethod: 'ajax', // none, ajax, reload, callback

  updateSource: 'initial', // initial, final. Only used if updateMethod != none.

  href: null, 

  width: null, // Override the width specified in the css.

  targetSelectors: null, // Hash of jQuery selectors that define the content to be swapped out.

  titleSelectors: null, // Array of jQuery selectors to place the new page title.

  reloadOnError: false, // Force the entire page to reload if the popup href is unaccessable.

  noMessage: false, // Don't show drupal_set_message messages.   

  skipDirtyCheck: false, // If true, this popup will not check for edits on the originating page.  

  hijackDestination: true, // Use the destiination param to force a form submit to return to the originating page. 

  onUpdate: null // Callback used for the updateMethod: 'callback' type

};

// ***************************************************************************

// Popups.Popup Object *******************************************************

// ***************************************************************************

/**

 * A Popup is a single modal dialog.

 * The popup object encapslated all the info about a single popup.

 */

Popups.Popup = function() {

  this.id = 'popups-' + Popups.nextCounter();

  // These properties are needed if the popup contains a form that will be ajax submitted.

  this.parent = null; // The popup that spawned this one. If parent is null, this popup was spawned by the original page.

  this.path = null; // If popup is showing content from a url, this is that path.

  this.element = null; // The DOM element that was clicked to launch this popup.

  this.options = null; // An option array that control how the popup behaves.  See Popups.defaultOptions for explainations.

};

Popups.Popup.prototype.$popup = function() {

  return $('#' + this.id);

};

Popups.Popup.prototype.$popupBody = function() {

  return $('#' + this.id + ' .popups-body');

};

Popups.Popup.prototype.$popupClose = function() {

  return $('#' + this.id + ' .popups-close');

};

Popups.Popup.prototype.$popupTitle = function() {

  return $('#' + this.id + ' .popups-title');

};

Popups.Popup.prototype.$popupButtons = function() {

  return $('#' + this.id + ' .popups-buttons');

};

Popups.Popup.prototype.$popupFooter = function() {

  return $('#' + this.id + ' .popups-footer');

};

/**

 * Create the jQuery wrapped html at the heart of the popup object.

 * 

 * @param title

 *   String

 * @param body

 *   String/HTML

 * @param buttons

 *   Hash/Object

 * @return

 *   The $popup.

 */

Popups.Popup.prototype.fill = function(title, body, buttons) {

  return $(Drupal.theme('popupDialog', this.id, title, body, buttons));

}

/**

 * Hide the popup by pushing it off to the side. 

 * Just making it display:none causes flash in FF2.

 */

Popups.Popup.prototype.hide = function() {

  this.$popup().css('left', '-9999px');

};

Popups.Popup.prototype.show = function() {

  Popups.resizeAndCenter(this);

};

Popups.Popup.prototype.open = function(title, body, buttons, width){

  return Popups.open(this, title, body, buttons, width);

};

Popups.Popup.prototype.removePopup = function() { 

  Popups.removePopup(this);

}; 

/**

 * Remove everything.

 */

Popups.Popup.prototype.close = function() {

  return Popups.close(this);

};

/**

 * Set the focus on the popups to the first visible, enabled form element, or the close link.

 */

Popups.Popup.prototype.refocus = function() {

  // Select the first visible enabled input element.

  var $popup = this.$popup();

  var $focus = $popup.find(':input:visible:enabled:first');

  if (!$focus.length) {

    // There is no visible enabled input element, so select the close link.

    $focus = $popup.find('.popups-close a');

  }

  $focus.focus();

};

/**

 * Return a selector that will find target content on the layer that spawned this popup.

 * This is needed for the popup to do ajax updates. 

 */

Popups.Popup.prototype.targetLayerSelector = function() {

  if (this.parent === null) {

    return 'body'; // Select content in the original page.

  }

  else {

    return '#' + this.parent.id; // Select content in the parent popup.

  } 

};

/**

 * Determine if we are at an end point of a form flow, or just moving from one popups to another.

 * 

 * @param path

 *   The path of the page that the form flow has moved to.

 *   This path is relative to the base_path.  

 *   Ex: node/add/story, not http://localhost/drupal6/node/add/story or drupa6/node/add/story.

 * @return bool

 */ 

Popups.Popup.prototype.isDone = function(path) {

//  console.log("Doing isDone for popup: " + this.id + ", now at " + path );

  var done;

  if (this.options.doneTest) {

    // Test if we are at the path specified by doneTest.

    done = (path === this.options.doneTest || path.match(this.options.doneTest));    

  }

  else { 

    if (this.parent) {

       // Test if we are back to the parent popup's path.

      done = (path === this.parent.path);     

//      console.log("Lookin at parent: " + this.parent.path + ". Done = " + done); 

    }

    else {

       // Test if we are back to the original page's path.

      done = (path === Popups.originalSettings.popups.originalPath);

//      console.log("Lookin at original page: " + Popups.originalSettings.popups.originalPath + ". Done = " + done); 

    }

  }; 

  return done;  

};

// ***************************************************************************

// Popups Functions **********************************************************

// ***************************************************************************

/**

 * Test if the param has been set. 

 * Used to distinguish between a value set to null or false and on not yet unset.

 */

Popups.isset = function(v) {

  return (typeof(v) !== 'undefined');

};

/**

 * Get the currently active popup in the page.

 * Currently it is the only one visible, but that could change.

 */

Popups.activePopup = function() {

  if (Popups.popupStack.length) {

    return Popups.popupStack[Popups.popupStack.length - 1]; // top of stack.

  }

  else {

    return null;

  }

};

/**

 * Manage the page wide popupStack.

 */

Popups.push = function(popup) {

  Popups.popupStack.push(popup);

};

// Should I integrate this with popupRemove??

Popups.pop = function(popup) {

  return Popups.popupStack.pop();

};

/**

 * Build an options hash from defaults.

 * 

 * @param overrides

 *   Hash of values to override the defaults.

 */

Popups.options = function(overrides) {

  var defaults = Popups.defaultOptions;

  return Popups.overrideOptions(defaults, overrides);  

}

/**

 * Build an options hash.  

 * Also maps deprecated options to current options.

 * 

 * @param defaults

 *   Hash of default values

 * @param overrides

 *   Hash of values to override the defaults with.

 */

Popups.overrideOptions = function(defaults, overrides) {

  var options = {};

  for(var option in defaults) {

    var value;

    if (Popups.isset(overrides[option])) {

      options[option] = overrides[option];

    }

    else {     

      options[option] = defaults[option];

    }

  }

  // Map deprecated options.

  if (overrides['noReload'] || overrides['noUpdate']) {

    options['updateMethod'] = 'none';

  } 

  if (overrides['reloadWhenDone']) {

    options['updateMethod'] = 'reload';

  } 

  if (overrides['afterSubmit']) {

    options['updateMethod'] = 'callback';

    options['onUpdate'] = overrides['afterSubmit'];

  } 

  if (overrides['forceReturn']) {

    options['doneTest'] = overrides['forceReturn'];

  } 

  return options;

}

/**

 * Attach the popups behavior to all elements inside the context that match the selector.

 *

 * @param context

 *   Chunk of html to search.

 * @param selector

 *   jQuery selector for elements to attach popups behavior to.

 * @param options

 *   Hash of options associated with these links.

 */

Popups.attach = function(context, selector, options) {

//  console.log(options);

  $(selector, context).not('.popups-processed').each(function() {

    var $element = $(this);  

    // Mark the element as processed.    

    $element.addClass('popups-processed');

    // Append note to link title.

    var title = '';

    if ($element.attr('title')) {

      title = $element.attr('title') + ' ';

    }

    title += Drupal.t('[Popup]');

    $element.attr('title', title); 

    // Attach the on-click popup behavior to the element.

    $element.click(function(event){

      return Popups.clickPopupElement(this, options);

    });

  });

};    

/**

 * Respond to click by opening a popup.

 * 

 * @param element

 *   The element that was clicked.

 * @param options

 *   Hash of options associated with the element.

 */

Popups.clickPopupElement = function(element, options) {

  Popups.saveSettings();

  // If the element contains a on-popups-options attribute, override default options param.

  if ($(element).attr('on-popups-options')) {

    var overrides = Drupal.parseJson($(element).attr('on-popups-options')); 

    options = Popups.overrideOptions(options, overrides);

  }

  // The parent of the new popup is the currently active popup.

  var parent = Popups.activePopup();

  // If the option is distructive, check if the page is already modified, and offer to save.

  var willModifyOriginal = !(options.updateMethod === 'none' || options.skipDirtyCheck);

  if (willModifyOriginal && Popups.activeLayerIsEdited()) {

    // The user will lose modifications, so show dialog offering to save current state.

    Popups.offerToSave(element, options, parent);

  }

  else {

    // Page is clean, or popup is safe, so just open it.

    Popups.openPath(element, options, parent);

  }

  return false; 

};

/**

 * Test if the active layer been edited.

 * Active layer is either the original page, or the active Popup.

 */

Popups.activeLayerIsEdited = function() {

  var layer = Popups.activePopup();

  var $context = Popups.getLayerContext(layer);

  // TODO: better test for edited page, maybe capture change event on :inputs.   

  var edited = $context.find('span.tabledrag-changed').length;  

  return edited;

}

/**

 * Show dialog offering to save form on parent layer.

 *