image_edit_fns.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/files/file/file_edit_fns.inc';

class Image_Edit_Fns extends File_Edit_Fns
{


    function paintFileUpload(&$asset, &$o, $prefix)
    {
        parent::paintFileUpload($asset, $o, $prefix);

        if ((!$asset->id) && file_exists(SQ_FUDGE_PATH.'/image_editor/imagej.jar')) {
            // we are in the create screen, so offer the editor too unless we are on Safari Windows
            echo '<p>';
            normal_button($prefix.'_use_editor_button', translate('core_use_image_editor_button'), 'this.parentNode.parentNode.parentNode.style.display=\'none\'; document.getElementById(\''.$prefix.'_hide_editor_button\').parentNode.parentNode.style.display=\'\';', 'style=display:none;');
            ?>
            <script type="text/javascript">
                if (!(navigator.userAgent.match(/Windows/i) && navigator.userAgent.match(/Safari/i))) {
                    document.getElementById('<?php echo $prefix; ?>_use_editor_button').style.display = 'inline';
                }
            </script>
            <?php
            echo '</p>';
        }

        return TRUE;

    }//end paintFileUpload()


    function paintEmbeddedData(&$asset, &$o, $prefix)
    {
        $embedded_data = $asset->attr('embedded_data');

        if (empty($embedded_data)) {
            $o->note('Not found');
            return;
        }

        echo '<table class="sq-backend-table">';
        echo '<tr><th>'.translate('name').'</th>';
        echo '<th>'.translate('keyword').'</th>';
        echo '<th>'.translate('value').'</th></tr>';
        foreach ($embedded_data as $keyword => $value_set) {
            $code = array_get_index($value_set, 'name');
            echo '<tr>';
            echo '<td>';
            echo $code;
            echo '</td>';
            echo '<td>';
            echo '%image_embedded_'.$keyword.'%';
            echo '</td>';
            echo '<td>';
            foreach (array_get_index($value_set, 'value', Array()) as $data_item) {
                echo $data_item;
                echo '<br />';
            }
            echo '</td></tr>';
        }
        echo '</table>';

    }//end paintEmbeddedData()


    function processFileUpload(&$asset, &$o, $prefix, $info=Array(),$redirect_in_limbo=TRUE, $asset_cloned=FALSE)
    {
        if (!parent::processFileUpload($asset, $o, $prefix, $info,$redirect_in_limbo, $asset_cloned)) {
            return FALSE;
        }

        // assetid will not be set if we are creating
        if (!$asset->id) return TRUE;

        $info = $asset->getExistingFile();
        if (!empty($info)) {
            if (!$asset->setAttrValue('width', $info['width'])) {
                return FALSE;
            }
            if (!$asset->setAttrValue('height', $info['height'])) {
                return FALSE;
            }
            if (!$asset->setAttrValue('size', $info['size'])) {
                return FALSE;
            }
        }//end if

        $this->_recreateVarietyImages($asset);


        // extract Photoshop metadata
        $meta = $this->_extractImageMetadata($info['path']);
        if (!$asset->setAttrValue('embedded_data', $meta)) {
            return FALSE;
        }

        if (!$asset->saveAttributes()) {
            trigger_localised_error('CORE0052', E_USER_WARNING);
            return FALSE;
        }

        return TRUE;

    }//end processFileUpload()


    function paintCreateEditor(&$asset, &$o, $prefix)
    {
        if (!$asset->id) {
            // we are in the create screen, so we'll print
            normal_button($prefix.'_hide_editor_button', translate('core_use_simple_upload_button'), 'this.parentNode.parentNode.style.display=\'none\'; document.getElementById(\''.$prefix.'_use_editor_button\').parentNode.parentNode.parentNode.style.display=\'\';', 'style="margin-bottom: 5px"');
            echo '<br />';
            $this->_paintApplet($asset, $o, $prefix);
        }
        return TRUE;

    }//end paintCreateEditor()


    function processCreateEditor(&$asset, &$o, $prefix)
    {
        if (isset($_POST[$prefix.'_applet_temp_filename']) && !empty($_POST[$prefix.'_applet_temp_filename'])) {
            $_POST[$prefix.'_server_file'] = $_POST[$prefix.'_applet_temp_filename'];
            // processFileChooser, called from File::create(), can now do the rest
        }
        return TRUE;

    }//end processCreateEditor()


    function paintEditor(&$asset, &$o, $prefix)
    {
        if ($asset->writeAccess('attributes')) {
            $this->_paintApplet($asset, $o, $prefix);
            return TRUE;
        } else {
            $asset_url = $GLOBALS['SQ_SYSTEM']->am->getAssetURL($asset->id);
            $root_url = $GLOBALS['SQ_SYSTEM']->am->getRootURL(strip_url($asset_url, TRUE));
            ?>
            <img src="<?php echo current_protocol().'://'.$root_url['url'].'?a='.$asset->id; ?>&t=<?php echo time(); ?>" />
            <?php
            return FALSE;
        }

    }//end paintEditor()


    function processEditor(&$asset, $o, $prefix)
    {
        if (isset($_POST[$prefix.'_applet_temp_filename'])) {
            $_POST[$prefix.'_server_file'] = $_POST[$prefix.'_applet_temp_filename'];
            // processServerFile can now do the rest
            $this->processFileChooser($asset, $o, $prefix);
        }
        return TRUE;

    }//end processEditor()


    function hasVarieties(&$asset, $prefix)
    {
        $varieties = $asset->attr('varieties');
        return (!empty($varieties['data']));

    }//end hasVarieties()


    function paintCurrentVarieties(&$asset, &$o, $prefix)
    {
        $wa = $asset->writeAccess('attributes');

        $varieties = $asset->attr('varieties');
        if (!empty($varieties)) {
            foreach ($varieties['data'] as $varid => $data) {
                $variety = $asset->getAsset($asset->id.':'.$varid);
                if (is_null($variety)) continue;
                $edit_fns = $variety->getEditFns();

                $o->openSection($variety->name);
                    $edit_fns->paintInlineInterface($variety, $o, $prefix.'_'.$variety->id);
                    if ($wa) {
                        $o->openField(translate('delete_question'));
                            check_box($prefix.'_delete[]', $variety->id);
                        $o->closeField();
                    }
                $o->closeSection();

            }// end foreach
        }// endif

        return $wa;

    }//end paintCurrentVarieties()


    function processCurrentVarieties(&$asset, $o, $prefix)
    {
        if (!$asset->writeAccess('attributes')) return FALSE;

        $changes_made = FALSE;

        if (!empty($_POST[$prefix.'_delete']) && is_array($_POST[$prefix.'_delete'])) {
            foreach ($_POST[$prefix.'_delete'] as $assetid) {
                list(, $varid) = explode(':', $assetid, 2);
                if ($asset->deleteVariety($assetid)) {
                    $changes_made = TRUE;
                }
            }// end foreach
        }// end if

        $varieties = $asset->attr('varieties');
        if (!empty($varieties)) {
            foreach ($varieties['data'] as $varid => $data) {
                $variety = $asset->getAsset($asset->id.':'.$varid);
                if (is_null($variety)) continue;
                $edit_fns = $variety->getEditFns();
                // If the interface has not been painted, and no file is uploaded for this variety, that means it is new,
                // processNewVariety should already taken care of it
                if (!isset($_FILES[$prefix.'_'.$variety->id]) && !isset($_POST[$prefix.'_'.$variety->id.'_variety_type_posted'])) continue;
                if ($edit_fns->processInlineInterface($variety, $o, $prefix.'_'.$variety->id) && !($asset->status & SQ_SC_STATUS_SAFE_EDITING)) {
                    // update the public version with the new file if not in safe edit
                    if ($variety->checkFileState($asset->effectiveUnrestricted() && $asset->attr('allow_unrestricted'))) {
                        $changes_made = TRUE;
                    }
                }
            }// end foreach
        }// end if

        return $changes_made;

    }//end processCurrentVarieties()


    function paintNewVariety(&$asset, &$o, $prefix)
    {
        $wa = $asset->writeAccess('attributes');

        $GLOBALS['SQ_SYSTEM']->am->includeAsset('image_variety');
        $variety = new Image_Variety($asset->id.':v0');

        $edit_fns = $variety->getEditFns();

        $o->openSection(translate('new_variety'));
            $edit_fns->paintInlineInterface($variety, $o, $prefix.'_new');
        $o->closeSection();

        return $wa;

    }//end paintNewVariety()


    function processNewVariety(&$asset, $o, $prefix)
    {
        if (!$asset->writeAccess('attributes')) return FALSE;
        if (!isset($_POST[$prefix.'_new_name']) || trim($_POST[$prefix.'_new_name']) == '') {
            return TRUE;
        }
        $GLOBALS['SQ_SYSTEM']->am->includeAsset('image_variety');
        $variety = new Image_Variety($asset->id.':v0');

        $edit_fns = $variety->getEditFns();
        if (!$edit_fns->processInlineInterface($variety, $o, $prefix.'_new')) {
            return FALSE;
        }

        return (bool) $asset->saveVariety($variety);

    }//end processNewVariety()


//--        HELPERS        --//


    function printExistingFileInfo(&$asset)
    {
        parent::printExistingFileInfo($asset);
        $existing = $asset->getExistingFile();
        if (!empty($existing)) {
            echo translate('core_dimensions', $existing['width'], $existing['height'])?><br/><?php
        }

    }//end printExistingFileInfo()


    function getChosenFileInfo($prefix)
    {
        $info = parent::getChosenFileInfo($prefix);
        if (isset($_POST[$prefix.'_applet_filename']) && !empty($_POST[$prefix.'_applet_filename'])) {
            $info['name'] = $_POST[$prefix.'_applet_filename'];
            $info['tmp_name'] = SQ_TEMP_PATH.'/'.$_POST[$prefix.'_applet_temp_filename'];
        }
        return $info;

    }//end getChosenFileInfo()


    function getPreUploadOptions(&$asset)
    {
        require_once(SQ_FUDGE_PATH.'/general/file_system.inc');
        $options = Array();
        foreach (list_files(SQ_TEMP_PATH) as $filename) {
            if (in_array(get_file_type($filename), $asset->allowed_extensions)) {
                $options[$filename] = $filename;
            }
        }
        return $options;

    }//end getPreUploadOptions()


    function _paintApplet(&$asset, &$o, $prefix)
    {
        if (!file_exists(SQ_FUDGE_PATH.'/image_editor/imagej.jar')) {
            return FALSE;
        }
        $time = time();
        $open_url = $asset->getURL();
        if (empty($open_url)) {
            $open_url = current_url(TRUE, TRUE).'?a='.$asset->id;
        }
        $open_url .= ((strpos($open_url, '?') === FALSE) ? '?' : '&').'SESSION_ID='.session_id().'&SESSION_KEY='.$GLOBALS['SQ_SYSTEM']->getUniqueSessionKey().'&t='.$time;
        ?>

        <script type="text/javascript"><!--

            function getAppletName()
            {
                var applet = document.getElementById('<?php echo $prefix; ?>_image_editor');
                if (applet.parentNode.parentNode.style.display != 'none') {
                    var tempNameFile = applet.getFilename();
                    if (tempNameFile.length < 5 ){
                        return false ;
                    }
                    return true;
                } else {
                    return true;
                }
            }

            function getAppletResult()
            {
                var applet = document.getElementById('<?php echo $prefix; ?>_image_editor');
                if (applet.parentNode.parentNode.style.display != 'none') {
                    var tempFilename = applet.doUpload();
                    if ((tempFilename !== null) && (tempFilename != '')) {
                        document.getElementById('<?php echo $prefix; ?>_applet_temp_filename').value = tempFilename;
                        document.getElementById('<?php echo $prefix; ?>_applet_filename').value = applet.getFilename();
                        return true;
                    } else {
                        return false;
                    }
                }
                return true;
            }

            forms = document.getElementsByTagName('FORM');
            if (forms[0].onsubmit) {
                var otherOnSubmit = forms[0].onsubmit;
                forms[0].onsubmit =
                function()
                {
                    if (getAppletName()) {
                        otherOnSubmit();
                        return getAppletResult();
                    } else  {
                        window.alert("You must give a filename before committing");
                    }
                }
            } else {
                forms[0].onsubmit = function() { return getAppletResult(); }
            }
            // -->
        </script>

        &nbsp;
        <input type="hidden" name="<?php echo $prefix; ?>_applet_temp_filename" id="<?php echo $prefix; ?>_applet_temp_filename" value="" />
        <input type="hidden" name="<?php echo $prefix; ?>_applet_filename" id="<?php echo $prefix; ?>_applet_filename" value="" />

        <applet id="<?php echo $prefix; ?>_image_editor" name="<?php echo $prefix; ?>_image_editor" archive="<?php echo sq_web_path('fudge'); ?>/image_editor/imagej.jar?t=<?php echo $time; ?>" code="ij.ImageJ.class" width="90%" height="350">
            <param name="SUBMIT_URL"
                   value="<?php echo sq_web_path('lib'); ?>/web/accept_file_upload.php?SESSION_ID=<?php echo session_id(); ?>&SESSION_KEY=<?php echo $GLOBALS['SQ_SYSTEM']->getUniqueSessionKey(); ?>" />
            <param name="FILE_FIELD_NAME" value="<?php echo $prefix; ?>" />
        <?php
        if ($asset->id) {
            ?>
            <param name="OPEN_URL" value="<?php echo $open_url; ?>" />
            <?php
        }
        ?>
        </applet>

        <script type="text/javascript"><!--
            // do not display applet for Safari Windows - problems exist currently with the JRE bundled with the browser, in particular the LiveConnect API
            // ... And let Chrome through since it is OK and uses Web Kit
            if (navigator.userAgent.match(/Windows/i) && navigator.userAgent.match(/Safari/i) && !navigator.userAgent.match(/Chrome/i)) {
                var applet = document.getElementById('<?php echo $prefix; ?>_image_editor');
                // cannot set display:none because Safari Windows will not respect this with an applet tag
                applet.style.width = '0';
                applet.style.height = '0';
                var element = document.createElement('div');
                element.innerHTML = js_translate('image_editor_disabled');
                applet.parentNode.appendChild(element);
            }
            // -->
        </script>
        <?php
        return TRUE;

    }//end _paintApplet()


    function _recreateVarietyImages(&$asset)
    {
        $varieties = $asset->attr('varieties');
        if (!empty($varieties)) {
            foreach ($varieties['data'] as $varid => $data) {
                $variety = $asset->getAsset($asset->id.':'.$varid);
                if (is_null($variety)) continue;
                $asset->saveVariety($variety, TRUE, FALSE);
            }// end foreach
        }// end if

    }//end _recreateVarietyImages()


    function _extractImageMetadata($filename)
    {
        $meta = Array();

        if (!SQ_TOOL_JPEG_TOOLKIT_ENABLED) return $meta;

        if (!defined('META_TOOLKIT_DIR')) {
            define ('META_TOOLKIT_DIR', SQ_TOOL_JPEG_TOOLKIT_PATH);
        }

        if (!file_exists(META_TOOLKIT_DIR.'/JPEG.php')) {
            trigger_error('JPEG Metadata Toolkit Path is invalid', E_USER_WARNING);
            return $meta;
        }

        include_once META_TOOLKIT_DIR.'/JPEG.php';
        include_once META_TOOLKIT_DIR.'/JFIF.php';
        include_once META_TOOLKIT_DIR.'/PictureInfo.php';
        include_once META_TOOLKIT_DIR.'/XMP.php';
        include_once META_TOOLKIT_DIR.'/Photoshop_IRB.php';
        include_once META_TOOLKIT_DIR.'/EXIF.php';
        include_once META_TOOLKIT_DIR.'/Photoshop_File_Info.php';

        // we start the buffer because the tool prints stuff to screen on error. nOObs
        ob_start();
        $jpeg_header_data = get_jpeg_header_data($filename);
        $XMP_array = read_XMP_array_from_text( get_XMP_text( $jpeg_header_data ) );
        ob_end_clean();

        if (empty($XMP_array)) return $meta;

        // the bit below is hardcoded to look for dc: prefix in tag name
        foreach ($XMP_array as $xmp_item) {
            if ($xmp_item['tag'] != 'x:xmpmeta') continue;
            if (!isset($xmp_item['children'])) continue;

            foreach ($xmp_item['children'] as $xmp_meta_item) {
                if ($xmp_meta_item['tag'] != 'rdf:RDF') continue;
                if (!isset($xmp_meta_item['children'])) continue;

                foreach ($xmp_meta_item['children'] as $rdf_data) {
                    if ($rdf_data['tag'] == 'rdf:Description') {
                        if (!isset($rdf_data['children'])) continue;

                        foreach ($rdf_data['children'] as $description_data) {
                            $tag_name = $description_data['tag'];
                            if (strpos($tag_name, 'dc:') !== 0) continue;

                            if (!isset($description_data['children'])) continue;

                            $ns = 'dc';
                            // 3 is the length of 'dc:'
                            $current_tag = substr($tag_name, 3);
                            $keyword = $ns.'--'.$current_tag;

                            foreach ($description_data['children'] as $tag_value_list) {
                                if (!isset($tag_value_list['children'])) continue;

                                $meta[$keyword]['name'] = $tag_name;
                                foreach ($tag_value_list['children'] as $tag_value) {
                                    // sometimes value tag is missing in image header, checking first!
                                    if (!isset($tag_value['value'])) {
                                        $meta[$keyword]['value'][] = '';
                                    } else {
                                        $meta[$keyword]['value'][] = $tag_value['value'];
                                    }
                                }
                            }
                        }

                    }//end if

                }//end foreach

            }//end foreach

        }//end foreach

        return $meta;

    }//end _extractImageMetadata()


}//end class

?>