HTTP Uploading

Overview

This section describes the HTTP uploading methods supported by the Flix Publisher plug-ins. It's broken up into two subsections:

• Modes
• Script Examples

Modes

This section describes the two HTTP uploading modes supported by the Flix Publisher API.

Form POST

The plug-ins use an implementation based upon the method outlined in RFC 1867: Form-based File Upload in HTML.

These are the basic steps involved in initiating a HTTP form upload using the Flix Publisher plug-ins:

• 1. set PublishMethod to kUploadModeHttpFormPost.
• 2. (optional) set form variable names and values.
• 3. (optional) set request headers names and values.
• 4. start the upload by calling the uploadFile() method on the plug-in interface.

Binary POST

Note:

Binary POST is not possible on the Mac.

The Flix Publisher plug-ins can upload files to web server using binary POST as well. In a binary POST, the uploaded file is the body of the request.

These are the basic steps involved in initiating a HTTP form upload using the Flix Publisher plug-ins:

• 1. set PublishMethod to kUploadModeHttpBinPost.
• 2. (optional) set request headers names and values.
• 3. start the upload by calling the uploadFile() method on the plug-in interface.

Reference Application Configuration

To learn about setting up the reference application for HTTP uploading, try the following links:

• HTTP POST settings
• upload_mode
• upload_md5_enable
• upload_form_var_names and upload_form_var_values
• upload_req_hdr_names and upload_req_hdr_values

---

Script Examples

This section contains example code that is taken directly from the reference application. The client side script examples were taken from flixpub_main.js.

The server side script, upload.php, demonstrates how one might handle form uploads on the server: Server PHP Example

Client Javascript Examples

This section describes the example uploading code included in the reference application. All of the examples assume that fileEncoded() or captureCompleted() have been fired. While this assumption is made here and throughout the reference application, it's important to note that uploadFile() can be used without first creating a file.

Example 1: fp_set_upload_settings()

The function fp_set_upload_settings can be found in flixpub_main.js. It is used by the reference application for all uploading.

function fp_set_upload_settings(pub) {
    var t = new Date();
    var upload_file_name = upload_username
        + "_"
        + String(t.getFullYear())
        + String(1+t.getMonth())
        + String(t.getDate())+String(t.getHours())
        + String(t.getMinutes())
        + String(t.getSeconds())
        + ".flv";
    t = 0;

    pub.PublishMethod = upload_mode;

    if (upload_mode == kUploadModeFtp) {
        // FTP upload
        pub.FtpSubDomain       = upload_sub_domain;
        pub.FtpMode            = "P";
        pub.FtpDestinationFile = upload_path_ftp + upload_file_name;
        pub.FtpUser            = upload_username;
        pub.FtpPassword        = upload_password_ftp;
    } else {
        // HTTP POST upload
        
        // set the variables/headers from the conf file
        try {
            fp_set_http_maps(pub, upload_mode);
        } catch (e) {};
        
        try {
            fp_set_md5_checksum(pub, upload_mode, upload_file_name);
        } catch (e) {};
    
        try {
            // backwards compatibility: this was done prior to v3.0.1.3
            //  some implementations of the publisher rely upon this behavior...
            if (pub.getHttpFormVar("username") == "") {
                pub.setHttpFormVar("username", upload_username);
            }
            if (pub.getHttpFormVar("filename") == "") {
                pub.setHttpFormVar("filename", upload_file_name);
            }
        } catch (e) {};

        pub.HttpSubDomain = upload_sub_domain;
        
        if (upload_http_target_is_file == true) 
            pub.HttpPath = upload_file_name;
        else 
            pub.HttpPath = upload_path_http;
    }
}

Example 2: fp_set_md5_checksum()

This example demonstrates how the reference application gets the MD5 checksum of the output file, and includes it within the POST as either form data or request header based on the value of upload_md5_form_var.

function fp_set_md5_checksum(pub, mode) {
    if (mode == kUploadModeFtp || upload_md5_enable == false) return;
    
    var cs;
    try {
      cs = pub.getMd5Checksum(pub.OutputFileName);
    } catch (e) {};
    
    if (cs.length) {
        if (mode == kUploadModeHttpFormPost && upload_md5_form_var == true) {
            pub.setHttpFormVar(upload_md5_name, cs);
        } else {
            pub.setHttpRequestHeader(upload_md5_name, cs);
        }
    }
}

Example 3: fp_start_upload()

This little function takes care of initiating the upload. The reference application calls the function for all uploads.

Note:

fp_start_upload() assumes that fp_set_upload_settings() was called first.

function fp_start_upload() {
    try {
        fp_set_upload_settings(on2pub);
        on2pub.uploadFile(on2pub.OutputFileName, upload_mode);
    } catch (e) {
        return false;
    }
    return true;
}

Server PHP Example

This section contains the example server side script, upload.php.

The following source code block contains the entire contents of the file. The file itself is included with the SDK in the samples directory.

Note:

For all form file uploads initiated by the Flix Publisher plug-ins, the form's name is 'uploadedfile'.

For more information about upload.php, please read the comments within:

<?php
//=============================================================================
// upload.php
//  File:  $Workfile: upload.php$
//         $Revision: 1$
//
//  Date:  $DateUTC: 2007-03-29 19:28:24Z$
//  
//  Brief: Simple PHP example of capturing and storing a file uploaded by 
//         on2 flix publisher sample # 3 with HTTP uploading enabled
//
//  Info:  http://on2.com/cms-data/pdf/publisher/
//         http://on2.com/cms-data/pdf/publisher/httpuploadpage.html
//
//=============================================================================

// uploads_directory MUST BE SET TO A DIRECTORY THAT PHP CAN WRITE TO
$uploads_directory = "/http-uploads/";


// This script relies upon three predefined PHP "superglobal" variables:
// 1. $_FILES
// 2. $_GET
// 3. $_POST
// For basic information regarding the usage of these variables, please see:
// http://www.php.net/manual/en/reserved.variables.php


// To use this script, the client script must specify action=upload in the
// query string.  Extract the action value from the $_GET array.
$action = $_GET['action'];

// Default result/error string (this will get sent back to the client if the 
// upload action is not specified):
// NOTE: This is optional, you do *not* need to return an informative response 
//       to the client.  The responses in this example code are sent back to the 
//       client in order to help you trouble shoot problems with your uploading 
//       code.
$result = "client attempting upload did not specify upload action!\n";

// Do you wish to send extended diagnostic information with the response?
// If enabled, the diagnostic information can be viewed in one of two ways:
//  1. Turn logging on in the publisher plug-ins - the server's response will 
//     be included in the log file when HTTP uploading is enabled.
//  2. If using the v3 reference application, set fp_debug to true to add a
//     debug_str(on2pub.getHttpResponse()); to the function uploadFailed() and 
//     uploadComplete().
//  3. Using a packet sniffer, view the response to the POST initiated
//     by the call to publishFile() on the publisher interface (the sniff
//     would need to be run on the client side)
// NOTE: This is optional.
$include_debug_info_in_response = 1;

if ($action == "upload") {
    // The following comming assume that the v3 reference application was used
    // to upload the file. 
    
    
    // The username entry in the $_POST array came from a call to setHttpFormVar 
    // in the javascript function fp_set_upload_settings(), which is in the file
    // flixpub_main.js
    $username = $_POST['username']; 
    
    // Same as above, but the filename form var this time:
    $fname_on_server_suggested = $_POST['filename'];

    // The publisher plug-ins submit multipart/form-data using the method 
    // described in RFC 1867: Form-based File Upload in HTML.  The RFC can be
    // viewed at: http://www.ietf.org/rfc/rfc1867.txt
    // The publisher plug-ins submit output files using form input of type 
    // 'file' named 'uploadedfile'.  To access the file and information about 
    // it, use the 'uploadedfile' entry of the $_FILES array.  The uploadedfile 
    // entry is an array with the following fields:
    // [name] => The original name of the file on the client machine.
    // [type] => The mime type of the file.  Always 'application/octet-stream' 
    //           for uploads from the publisher plug-ins.
    // [tmp_name] => The temporary filename of the file in which the uploaded 
    //               file was stored on the server.
    // [error] => upload success/error code.  0 means success.  For more 
    //            information, see: 
    //            http://www.php.net/manual/en/features.file-upload.errors.php
    // [size] => The size, in bytes, of the uploaded file.
    
    // extract the client side file name:
    $fname_on_user_system = $_FILES['uploadedfile']['name'];
    
    // change .'s to -'s in the client file name (this is purely cosmetic)
    $fname_on_user_system = str_replace(".", "-", $fname_on_user_system);
    
    // construct the output file name and path for the call to move_uploaded_file()
    $output_file = $uploads_directory . $username . "__" 
        . $fname_on_user_system . "__" . $fname_on_server_suggested;
    
    // move the file to uploads_directory:
    if (move_uploaded_file($_FILES['uploadedfile']['tmp_name'], $output_file)) {
        // success
        $result = "File successfully uploaded.\n";
    } else {
        // failure
        $result = "Couldn't write uploaded file to uploads directory!\n";
    }
}

echo "\n" . $result . "\n"; 

if ($include_debug_info_in_response) {
    echo "debug info:\n";
    
    echo '$_FILES:' . "\n";
    print_r($_FILES);
    echo "\n";
    
    echo '$_GET:' . "\n";
    print_r($_GET);
    echo "\n";
    
    echo '$_POST:' . "\n";
    print_r($_POST);
    echo "\n";
}

?> 

---