# This module contains helper methods to assist in including the multi bit shift flash applet for attributes created with the acts_as_mbs_files
# method.   It will be automatically included into ActionView::Base, thereby making this module�s methods available in all your views.
#
# Note: This documentation heavily influenced by the open source plugin FileColumn's documentation.
module MultiBitShiftHelper

  # Returns a multi bit shift field input tailored for accessing a specified attribute (identified by method) on an object assigned to
  # the template (identified by object).  A hidden field is used to persist the guid over multiple validation attempts.
  # The width and height options are set to 420 and 240 by default, and the applicationToken is automatically set to guid of the field.
  # In addition, the actions for the uploadURL and removeFileURL are automatically set, to upload_file, and remove_files respectively.  Finally,
  # the existing files are passed into the applet.  A validation object can be passed using the validation_object index of the options hash.
  #
  # By default, this helper is used with the Multi Bit Shift applet.  To use with the advanced applet, mbs_version option should be set to 'Advanced',
  # and the width and height should be set to pixel values.  Addtionally, the done button should be disabled.
  # 
  # The other options that can be specified using the options hash can be found in the queryStringLoader parameters 
  # documentation of the flash applet, which can be located at http://multibitshift.com/documentation/view.  These options will be passed to the
  # flash applet and can be used to customize the applet at runtime.
  def multi_bit_shift_field(object_name, method, options={})
    if options['width'].nil?
      options['width'] = '420'
    end
    if options['height'].nil?
      options['height'] = '240'
    end
    if options['applicationToken'].nil?
      options['applicationToken'] = self.instance_variable_get("@#{object_name}").method("#{method}_guid").call
    end
    if options['uploadURL'].nil?
      options['uploadURL'] = url_for(:action => 'upload_file')
    end
    if options['removeFileURL'].nil?
      options['removeFileURL'] = url_for(:action => 'remove_files')
    end
    if !options['validation_object'].nil?
      count = 1
      for file in Object.const_get(options['validation_object'].file_class).find_all_by_associated_with(options['applicationToken'])
        options["uploadedFileName#{count}"] = file["file_name"]
        options["uploadedFileSize#{count}"] = File.size(file.file_name).to_s
        count = count + 1
      end
      options = options['validation_object'].convert_to_flash_params.merge(options)
      options.delete('validation_object')      
    end
        
    output = []
    output << hidden_field(object_name, method)
    output << multi_bit_shift_flash(options)
    output.join('')
  end

  # Inserts the javascript and HTML to present the multi bit shift flash file.  
  # The options hash contains the options (for all options, see 
  # http://multibitshift.com/docs/multi_bit_shift/docs/files/as/queryStringLoader-as.html) 
  # to pass to the flash file, as well as additional options as listed below:
  # * <tt>'width'</tt> - Width of the applet, defaults to 100%
  # * <tt>'height'</tt> - Height of the applet, defaults to 100%
  # * <tt>'ajax_safe'</tt> - Determines if the applet will be inserted via ajax.  If set to true, the applet does not make use of javascript to load,
  #   and instead is directly embedded.  Defaults to false.
  # * <tt>'mbs_version'</tt> - What version of the Multi Bit Shift Applet to include.  This method sets the file_name attribute to flashFileHelperAdvanced
  #   when "Advanced" is set.  Accepted values are "Regular" and "Advanced", defaults to "Regular".
  # * <tt>'file_name'</tt> - Sets the file name of the swf file to load.  This parameter should not be modified directly, instead the mbs_version property
  #   should be set.  Defaults to "flashFileHelper".
  # * <tt>'uploadURL'</tt> - URL that files should be uploaded to.  Defaults to action 'upload_file'.
  # * <tt>'removeFileURL'</tt> - URL that files should be removed with.  Defaults to action 'remove_files'.
  # * <tt>'fileListURL'</tt> - URL that lists files.  Defaults to action 'files_on_server'.
  # * <tt>'renameFileURL'</tt> - URL that files should be renamed with.  Defaults to action 'rename_file'.
  # * <tt>'rotateCWURL'</tt> - URL that clockwise rotation requests will be sent to.  Defaults to ''.
  # * <tt>'rotateCCWURL'</tt> - URL that counter-clockwise rotation requests will be sent to.  Defaults to ''.
  # * <tt>'doneURL'</tt> - URL that Done button redirects to.  Defaults to action 'index'.
  # * <tt>'jsDoneCallback'</tt> - Javascript function to call when done button is clicked.  Setting this overrides doneURL.  Defaults to ''.
  # * <tt>'flashCSS'</tt> - URL of compiled CSS to use.  Defaults to /flash/css/siu.swf.
  # 
  # The other options can be found in the queryStringLoader parameters 
  # documentation of the flash applet, which can be located at http://multibitshift.com/documentation/view.
  # 
  # The code that is generated is based entirely on output from Macromedia Flex.
  def multi_bit_shift_flash(options={})    
    if options['width'].nil?
      width = '100%'
    else
      width = options['width']
    end
    
    if options['height'].nil?
      height = '100%'
    else
      height = options['height']
    end
    
    if options['ajax_safe'].nil?
      options['ajax_safe'] = false.to_s
    else
      options['ajax_safe'] = options['ajax_safe'].to_s
    end
    
    if !options['mbs_version'].nil? and options['mbs_version'] == "Advanced"
      options['file_name'] = "flashFileHelperAdvanced"
    end
    
    if options['file_name'].nil?
      file_name = "flashFileHelper"
    else
      file_name = options['file_name']
      options.delete('file_name')
    end
    
    if options['uploadURL'].nil?
      options['uploadURL'] = url_for(:action => 'upload_file')
    end
    
    if options['removeFileURL'].nil?
      options['removeFileURL'] = url_for(:action => 'remove_files')
    end
    
    if options['fileListURL'].nil?
      options['fileListURL'] = url_for(:action => 'files_on_server')
    end
    
    if options['renameFileURL'].nil?
      options['renameFileURL'] = url_for(:action => 'rename_file')
    end
    
    if options['doneURL'].nil?
      options['doneURL'] = url_for(:action => 'index')
    end
    
    if options['flashCSS'].nil?
      options['flashCSS'] = '/flash/css/siu.swf'
    end
    
    if options['rotateCWImageURL'].nil?
      options['rotateCWImageURL'] = '/flash/cw.gif'
    end
    
    if options['rotateCCWImageURL'].nil?
      options['rotateCCWImageURL'] = '/flash/ccw.gif'
    end
    
    
    options.each{ |key,value|
      options[key] = URI.escape(value)
    }
    parameters = []
    options.each{ |key,value|
      parameters << "#{key}=#{value}"
    }
    parameters = parameters.join('&')
    
    if options['ajax_safe'] == "true"
      insert_string = <<END
    <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
      id="#{file_name}" width="#{width}" height="#{height}"
      codebase="http://fpdownload.macromedia.com/get/flashplayer/current/swflash.cab">
      <param name="movie" value="#{file_path(file_name + '.swf')}?#{parameters}" />
      <param name="quality" value="high" />
      <param name="bgcolor" value="#ffffff" />
      <param name="flashvars" value="#{parameters}" />
      <param name="allowScriptAccess" value="sameDomain" />
      <embed src="#{file_path(file_name + '.swf')}" quality="high" bgcolor="#ffffff"
        width="#{width}" height="#{height}" name="#{file_name}" align="middle" flashvars="#{parameters}"
        play="true"
        loop="false"
        quality="high"
        allowScriptAccess="sameDomain"
        type="application/x-shockwave-flash"
        pluginspage="http://www.adobe.com/go/getflashplayer">
      </embed>
  </object>
END
    else
      insert_string = <<END
<script language="JavaScript" type="text/javascript">
<!--
// -----------------------------------------------------------------------------
// Globals
// Major version of Flash required
var requiredMajorVersion = 9;
// Minor version of Flash required
var requiredMinorVersion = 0;
// Minor version of Flash required
var requiredRevision = 0;
// -----------------------------------------------------------------------------
// -->
</script>
<script src="#{file_path('AC_OETags.js')}" language="javascript"></script>
<script language="JavaScript" type="text/javascript">
<!--
// Version check for the Flash Player that has the ability to start Player Product Install (6.0r65)
var hasProductInstall = DetectFlashVer(6, 0, 65);

// Version check based upon the values defined in globals
var hasRequestedVersion = DetectFlashVer(requiredMajorVersion, requiredMinorVersion, requiredRevision);


// Check to see if a player with Flash Product Install is available and the version does not meet the requirements for playback
if ( hasProductInstall && !hasRequestedVersion ) {
  // MMdoctitle is the stored document.title value used by the installation process to close the window that started the process
  // This is necessary in order to close browser windows that are still utilizing the older version of the player after installation has completed
  // DO NOT MODIFY THE FOLLOWING FOUR LINES
  // Location visited after installation is complete if installation is required
  var MMPlayerType = (isIE == true) ? "ActiveX" : "PlugIn";
  var MMredirectURL = window.location;
    document.title = document.title.slice(0, 47) + " - Flash Player Installation";
    var MMdoctitle = document.title;

  AC_FL_RunContent(
    "src", "#{file_path('playerProductInstall')}",
    "FlashVars", "MMredirectURL="+MMredirectURL+'&MMplayerType='+MMPlayerType+'&MMdoctitle='+MMdoctitle+"",
    "width", "#{width}",
    "height", "#{height}",
    "align", "middle",
    "id", "#{file_name}",
    "quality", "high",
    "bgcolor", "#ffffff",
    "name", "#{file_name}",
    "allowScriptAccess","sameDomain",
    "type", "application/x-shockwave-flash",
    "pluginspage", "http://www.adobe.com/go/getflashplayer"
  );
} else if (hasRequestedVersion) {
  // if we've detected an acceptable version
  // embed the Flash Content SWF when all tests are passed
  AC_FL_RunContent(
      "src", "#{file_path(file_name)}",
      "width", "#{width}",
      "height", "#{height}",
      "align", "middle",
      "id", "#{file_name}",
      "quality", "high",
      "bgcolor", "#ffffff",
      "name", "#{file_name}",
      "flashvars",'#{parameters}',
      "allowScriptAccess","sameDomain",
      "type", "application/x-shockwave-flash",
      "pluginspage", "http://www.adobe.com/go/getflashplayer"
  );
  } else {  // flash is too old or we can't detect the plugin
    var alternateContent = 'Alternate HTML content should be placed here. '
    + 'This content requires the Adobe Flash Player. '
    + '<a href=http://www.adobe.com/go/getflash/>Get Flash</a>';
    document.write(alternateContent);  // insert non-flash content
  }
// -->
</script>
<noscript>
    <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"
      id="#{file_name}" width="#{width}" height="#{height}"
      codebase="http://fpdownload.macromedia.com/get/flashplayer/current/swflash.cab">
      <param name="movie" value="#{file_path(file_name + '.swf')}?#{parameters}" />
      <param name="quality" value="high" />
      <param name="bgcolor" value="#ffffff" />
      <param name="flashvars" value="#{parameters}" />
      <param name="allowScriptAccess" value="sameDomain" />
      <embed src="#{file_path(file_name + '.swf')}" quality="high" bgcolor="#ffffff"
        width="#{width}" height="#{height}" name="#{file_name}" align="middle" flashvars="#{parameters}"
        play="true"
        loop="false"
        quality="high"
        allowScriptAccess="sameDomain"
        type="application/x-shockwave-flash"
        pluginspage="http://www.adobe.com/go/getflashplayer">
      </embed>
  </object>
</noscript>
END
    end

    return insert_string
  end

private
  # Calls the compute_public_path function to generate a path link to the public item.
  def file_path(source)
    path = compute_public_path(source, 'flash', '')
    if path[-1..-1] == "."
      path = path[0..-2]
    end
    path
  end
  
end