YUI Library JavaScript DHTML


            

    
Advanced Uploader Example With Cookie Submission as a POST variable

/*margin and padding on body element
  can introduce errors in determining
  element position and are not recommended;
  we turn them off as a foundation for YUI
  CSS treatments. */
body {
  margin:0;
  padding:0;
}









Advanced Uploader Example With Cookie Submission as a POST variable


  One of the major limitations of the Flash-based uploader is that it cannot use browser cookies to authenticate file uploads. In this example, we provide sample code that demonstrates how to attach the page cookie as a variable in the body of the upload POST request, rather than in the header. The code will generate a cookie with a username and the last uploaded file name, and send the value along with the file that needs to be uploaded. We also provide a sample backend script that accepts the file upload and echoes the POST variables accompanying the upload (thus ascertaining that the cookie data was received by the server).  We show how we can retrieve the data returned by the server and display it to the user.

Note: This is a static example, which means that you will not be able to try it out on our server. You will need to set up the code on your own server in order to run it.

Note: The YUI Uploader Control requires Flash Player 9.0.45 or higher. The latest version of Flash Player is available at the Adobe Flash Player Download Center.

Note: The YUI Uploader Control requires the uploader.swf Flash file that is distributed as part of the YUI package, in the uploader/assets folder. Copy the uploader.swf to your server and set the YAHOO.Uploader.SWFURL variable to its full path.

Note: this example is static, which means that it will not work properly on this page. To try it, you will need to download its source code and set it up on your own server. To do so, click "View example in new window", and save the source of that page.


      Select File
    
    Upload File
    
    Progress: 
    
    
    Data returned by the server:
    
      
    
    


   // init messageContainer.
  function init() { 
    var curCookie = YAHOO.util.Cookie.get("myCookie");
    var messageContainer = document.getElementById("messageContainer");
    var newHtml;
    var currentUser = YAHOO.util.Cookie.getSub("myCookie","currentUser");
    var lastUploadedFile = YAHOO.util.Cookie.getSub("myCookie","lastUploadedFile");
  
    if(curCookie == null || currentUser == null) {
      // If there is no existing cookie or username, this wiil show the text input and a button to add user name to the cookie.
      YAHOO.util.Cookie.set("myCookie", document.cookie);
      newHtml = 'Hi, there. Add your name in the box below.
';
      newHtml +='';
    }else{
      // If there is an existing cookie, this wiil show welcome message with an option of removing the username and file name from the cookie.
      newHtml = currentUser+', welcome back!
';
      if(lastUploadedFile) {
        newHtml += 'Your last uploaded file was '+lastUploadedFile+'
';
      }
      newHtml +='';
    };
    messageContainer.innerHTML = newHtml;
  
    // reset progressReport and serverData feild.
    this.serverData = document.getElementById("serverData");
    this.serverData.value = "";
  
    this.progressReport = document.getElementById("progressReport");
    this.progressReport.value ="";
  };
  // when DOM is ready, call init().
  YAHOO.util.Event.onDOMReady(init);
  
  // Button Event: "Set User" button clicked. Adds the username to the cookie.
  YAHOO.util.Event.on("btnAdd", "click", function(){
      var newUser = document.getElementById("userInput").value;
    YAHOO.util.Cookie.setSub("myCookie","currentUser",newUser);
    var newHtml = "Hi, "+ newUser +"!";
    var messageContainer = document.getElementById("messageContainer");
    messageContainer.innerHTML = newHtml;
  });
  
  // Button Event: "Remove User" button clicked. Removes username and last Uploaded File name from the cookie.
  YAHOO.util.Event.on("btnRemove", "click", function(){
     YAHOO.util.Cookie.removeSub("myCookie","currentUser");
    YAHOO.util.Cookie.removeSub("myCookie","lastUploadedFile");
    init();
  });
  YAHOO.util.Event.onDOMReady(function () { 
    var uiLayer = YAHOO.util.Dom.getRegion('selectLink');
    var overlay = YAHOO.util.Dom.get('uploaderOverlay');
    YAHOO.util.Dom.setStyle(overlay, 'width', uiLayer.right-uiLayer.left + "px");
    YAHOO.util.Dom.setStyle(overlay, 'height', uiLayer.bottom-uiLayer.top + "px");
  });
  // Custom URL for the uploader swf file (same folder).
  YAHOO.widget.Uploader.SWFURL = "yui_2.7.0b-assets/uploader-assets/uploader.swf";
    // Instantiate the uploader and write it to its placeholder div.
  var uploader = new YAHOO.widget.Uploader( "uploaderOverlay" );
  
  // Add event listeners to various events on the uploader.
  // Methods on the uploader should only be called once the 
  // contentReady event has fired.
  
  uploader.addListener('contentReady', handleContentReady);
  uploader.addListener('fileSelect', onFileSelect)
  uploader.addListener('uploadStart', onUploadStart);
  uploader.addListener('uploadProgress', onUploadProgress);
  uploader.addListener('uploadCancel', onUploadCancel);
  uploader.addListener('uploadComplete', onUploadComplete);
  uploader.addListener('uploadCompleteData', onUploadResponse);
  uploader.addListener('uploadError', onUploadError);
    uploader.addListener('rollOver', handleRollOver);
    uploader.addListener('rollOut', handleRollOut);
    uploader.addListener('click', handleClick);
      
    // Variable for holding the selected file id.
  var fileID;
  // Variable for holding the selected file name.
  var fileName;
  // When the mouse rolls over the uploader, this function
  // is called in response to the rollOver event.
  // It changes the appearance of the UI element below the Flash overlay.
  function handleRollOver () {
    YAHOO.util.Dom.setStyle(YAHOO.util.Dom.get('selectLink'), 'color', "#FFFFFF");
    YAHOO.util.Dom.setStyle(YAHOO.util.Dom.get('selectLink'), 'background-color', "#000000");
  }
  
  // On rollOut event, this function is called, which changes the appearance of the
  // UI element below the Flash layer back to its original state.
  function handleRollOut () {
    YAHOO.util.Dom.setStyle(YAHOO.util.Dom.get('selectLink'), 'color', "#0000CC");
    YAHOO.util.Dom.setStyle(YAHOO.util.Dom.get('selectLink'), 'background-color', "#FFFFFF");
  }
  
  // When the Flash layer is clicked, the "Browse" dialog is invoked.
  // The click event handler allows you to do something else if you need to.
  function handleClick () {
  }
  
  // When contentReady event is fired, you can call methods on the uploader.
  function handleContentReady () {
      // Allows the uploader to send log messages to trace, as well as to YAHOO.log
    uploader.setAllowLogging(true);
    
    // Disallows multiple file selection in "Browse" dialog.
    uploader.setAllowMultipleFiles(false);
    
    // New set of file filters.
    var ff = new Array({description:"Images", extensions:"*.jpg;*.png;*.gif"},
                       {description:"Videos", extensions:"*.avi;*.mov;*.mpg"});
                       
    // Apply new set of file filters to the uploader.
    uploader.setFileFilters(ff);
  }
  // Actually uploads the files. Since we are only allowing one file
  // to be selected, we use the upload function, in conjunction with the id 
  // of the selected file (returned by the fileSelect event). We are also including
  // the cookie as a variable.
  function upload() {
    
  if (fileID != null) {
    var docCookie = YAHOO.util.Cookie.get("myCookie");
    
    uploader.upload(fileID, "YOUR_DOMAIN_SAME_AS_PAGE_DOMAIN_HERE", 
                    "POST", 
                    {cookieVar:docCookie });
  }  
  }
  
  // Fired when the user selects files in the "Browse" dialog
  // and clicks "Ok". Here, we set the value of the progress
  // report textfield to reflect the fact that a file has been
  // selected.
  
  function onFileSelect(event) {
    for (var file in event.fileList) {
        if(YAHOO.lang.hasOwnProperty(event.fileList, file)) {
        fileID = event.fileList[file].id;
      }
    }
    
    this.progressReport = document.getElementById("progressReport");
    fileName =  event.fileList[fileID].name;
    this.progressReport.value = "Selected " + fileName
  }
    // When the upload starts, we inform the user about it via
  // the progress report textfield. 
  function onUploadStart(event) {
    this.progressReport.value = "Starting upload...";
  }
  
  // As upload progresses, we report back to the user via the
  // progress report textfield.
  function onUploadProgress(event) {
    prog = Math.round(100*(event["bytesLoaded"]/event["bytesTotal"]));
    this.progressReport.value = prog + "% uploaded...";
  }
  
  // Report back to the user that the upload has completed.
  function onUploadComplete(event) {
    YAHOO.util.Cookie.setSub("myCookie","lastUploadedFile",fileName);
    this.progressReport.value = "Upload complete.";
  }
  
  // Report back to the user if there has been an error.
  function onUploadError(event) {
    this.progressReport.value = "Upload error.";
  }
  
  // Do something if an upload is canceled.
  function onUploadCancel(event) {
  }
  
  // When the data is received back from the server, display it to the user
  // in the server data text area.
  function onUploadResponse(event) {
    
    this.serverData = document.getElementById("serverData");
    this.serverData.value = event.data;
    
  }



   
   
yui_2.7.0b.zip( 4,431 k)