History of LibertyMime

<?php
<package>/liberty_plugins/
?>

<?php
/**
 * setup
 */
global $gLibertySystem;

/**
 *  This is the name of the plugin - max char length is 16
 * As a naming convention, the liberty mime handler definition should start with:
 * PLUGIN_MIME_GUID_
 */
define( 'PLUGIN_MIME_GUID_IMAGE', 'mimeimage' );

$pluginParams = array (
    // Set of functions and what they are called in this paricular plugin
    // Use the GUID as your namespace
    // in some of these function calls, we directly call the default functions if there's nothing special for us to do
    'verify_function'     => 'mime_default_verify',
    'store_function'      => 'mime_image_store',
    'update_function'     => 'mime_image_update',
    'load_function'       => 'mime_image_load',
    'download_function'   => 'mime_default_download',
    'expunge_function'    => 'mime_default_expunge',

    // Brief description of what the plugin does
    'title'               => 'Extract image meta data',
    'description'         => 'Extract image meta data and display relevant information to the user.',

    // Templates to display the files
    //'view_tpl'            => 'bitpackage:liberty/mime_image_view_inc.tpl',
    //'inline_tpl'          => 'bitpackage:liberty/mime_image_inline_inc.tpl',
    //'edit_tpl'            => 'bitpackage:liberty/mime_image_edit_inc.tpl',

    // URL to page with options for this plugin
    //'plugin_settings_url' => LIBERTY_PKG_URL.'admin/mime_image.php',

    // This should be the same for all mime plugins
    'plugin_type'         => MIME_PLUGIN,

    // Set this to TRUE if you want the plugin active right after installation
    'auto_activate'       => FALSE,

    // Help page on bitweaver.org
    //'help_page'           => 'LibertyMime+Image+Plugin',

    // here we can enter an array of perl regular expression patters that will
    // be used to find out what plugin will be used on upload. this should pick
    // up all images
    'mimetypes'           => array(
        '#image/.*#i',
    ),
);
$gLibertySystem->registerPlugin( PLUGIN_MIME_GUID_IMAGE, $pluginParams );

// depending on the scan the default file might not be included yet. we need to get it manually - simply use the relative path
require_once( 'mime.default.php' );
?>

<?php
/**
 * Store the data in the database
 *
 * @param array $pStoreRow File data needed to store details in the database - sanitised and generated in the verify function
 * @access public
 * @return TRUE on success, FALSE on failure - $pStoreRow['errors'] will contain reason
 */
function mime_image_store( &$pStoreRow ) {
    // this will set the correct pluign guid, even if we let default handle the store process
    $pStoreRow['attachment_plugin_guid'] = PLUGIN_MIME_GUID_IMAGE;
    $pStoreRow['log'] = array();

    // if storing works, we process the image
    if( $ret = mime_default_store( $pStoreRow )) {
        if( !mime_image_store_exif_data( $pStoreRow )) {
            // if it all goes tits up, we'll know why
            $pStoreRow['errors'] = $pStoreRow['log'];
            $ret = FALSE;
        }
    }
    return $ret;
}

/**
 * mime_image_update update file information in the database if there were changes.
 *
 * @param array $pStoreRow File data
 * @param array $pParams This is additional data passed back from the update form
 * @access public
 * @return TRUE on success, FALSE on failure - $pStoreHash[errors] will contain reason for failure
 */
function mime_image_update( &$pStoreRow, $pParams = NULL ) {
    $ret = FALSE;

    // this will set the correct pluign guid, even if we let default handle the store process
    $pStoreRow['attachment_plugin_guid'] = PLUGIN_MIME_GUID_IMAGE;

    // if storing works, we process the image
    if( !empty( $pStoreRow['upload'] ) && $ret = mime_default_update( $pStoreRow )) {
        if( !mime_image_store_exif_data( $pStoreRow )) {
            // if it all goes tits up, we'll know why
            $pStoreRow['errors'] = $pStoreRow['log'];
            $ret = FALSE;
        }
    }
    return $ret;
}

/**
 * Load file data from the database
 *
 * @param array $pFileHash Contains all file information
 * @param array $pPrefs Attachment preferences taken liberty_attachment_prefs
 * @param array $pParams Parameters for loading the plugin - e.g.: might contain values such as thumbnail size from the view page
 * @access public
 * @return TRUE on success, FALSE on failure - $pStoreHash[errors] will contain reason for failure
 */
function mime_image_load( &$pFileHash, &$pPrefs, $pParams = NULL ) {
    global $gLibertySystem, $gBitThemes;

    // don't load a mime image if we don't have an image for this file
    if( $ret = mime_default_load( $pFileHash, $pPrefs, $pParams )) {
        // fetch meta data from the db
        $ret['meta'] = LibertyMime::getMetaData( $pFileHash['attachment_id'], "EXIF" );
    }
    return $ret;
}

/**
 * mime_image_store_exif_data Process a JPEG and store its EXIF data as meta data.
 *
 * @param array $pFileHash file details.
 * @param array $pFileHash[upload] should contain a complete hash from $_FILES
 * @access public
 * @return TRUE on success, FALSE on failure
 */
function mime_image_store_exif_data( $pFileHash ) {
    if( !empty( $pFileHash['upload'] )) {
        $upload = &$pFileHash['upload'];
    }

    if( @BitBase::verifyId( $pFileHash['attachment_id'] ) && function_exists( 'exif_read_data' ) && !empty( $upload['source_file'] ) && is_file( $upload['source_file'] ) && preg_match( "#/(jpeg|tiff)#i", $upload['type'] )) {
        $exifHash = exif_read_data( $upload['source_file'], 0, TRUE );
        LibertyMime::storeMetaData( $pFileHash['attachment_id'], 'EXIF', $exifHash['EXIF'] );
    }

    return TRUE;
}
?>