Coding standards
Security in ResourceSpace
Developer reference
Database
Action functions
Admin functions
Ajax functions
Annotation functions
API functions
Collections functions
Comment functions
Config functions
CSV export functions
Dash functions
Debug functions
Encryption functions
Facial recognition functions
File functions
General functions
Language functions
Log functions
Login functions
Message functions
Migration functions
Node functions
PDF functions
Plugin functions
Render functions
Reporting functions
Request functions
Research functions
Slideshow functions
Theme permission functions
User functions
Video functions
Database functions
Metadata functions
Resource functions
Search functions
Map functions
Job functions
Tab functions
Test functions

render_resource_view_image()

Description

Render image on view.php

"access" - Resource access
"edit_access" - Resource edit access

Parameters

ColumnTypeDefaultDescription
$resource array Resource data
$context array Array with following named elements

Return

void *

Location

include/render_functions.php lines 6859 to 7245

Definition

 
function render_resource_view_image(array $resource, array $context)
    {
    global $lang;
    $imageurl="";   
    
    $use_watermark = check_use_watermark();
    $access = $context["access"] ?? 1; // Default to restricted
    $edit_access = $context["edit_access"] ?? 0;

    // Set the preview sizes to look for. Access will be checked by get_resource_preview()
    // Retina mode uses 'scr' size
    $viewsizes = (($GLOBALS["retina_mode"] || !$GLOBALS["resource_view_use_pre"]) && $access === 0) ? ["scr"]: [];
    $viewsizes[] = "pre";
    $viewsizes[] = "thm";

    $imagepre = get_resource_preview($resource,$viewsizes, $access, $use_watermark);
    if($imagepre)
        {
        $imageurl = $imagepre["url"];
        $imagepath = $imagepre["path"];
        $image_width = $imagepre["width"];
        $image_height = $imagepre["height"];
        $validimage = true;
        }
    else
        {
        ?>
        <div id="previewimagewrapper">
         echo get_nopreview_html((string) $resource["file_extension"]); ?>
        </div>
         
        return true;
        }

    $previewimagelink = generateURL("{$GLOBALS["baseurl"]}/pages/preview.php", $GLOBALS["urlparams"], array("ext" => $resource["preview_extension"])) . "&" . hook("previewextraurl");
    $previewimagelink_onclick = 'return CentralSpaceLoad(this);';

    if (!hook("replacepreviewlink"))
        {
        ?>
        <div id="previewimagewrapper">
            <a id="previewimagelink"
                class="enterLink"
                href=" echo $previewimagelink; ?>"
                title=" echo escape($lang["fullscreenpreview"]); ?>"
                style="position:relative;"
                onclick=" echo $previewimagelink_onclick; ?>">
        
        }
    ?>
    <img id="previewimage"
        class="Picture"
        src=" echo $imageurl; ?>" 
        alt=" echo escape($lang['fullscreenpreview']); ?>" 
        onload="jQuery('.DownloadDBlend').css('pointer-events','auto')"
        GALLERYIMG="no"
    
    if($GLOBALS["annotate_enabled"])
        {
        ?>
        data-original=" echo "{$GLOBALS["baseurl"]}/annotation/resource/" . (int) $resource["ref"]; ?>"
        
        }

    if($GLOBALS["retina_mode"])
        {
        ?>
        onload="this.width/=1.8;this.onload=null;"
        
        }
        ?>/>
    </a>

    
    hook('aftersearchimg', '', array($resource["ref"]));
    hook('previewextras'); ?>
        
    
    if($validimage)
        {
        if ($GLOBALS["image_preview_zoom"])
            {
            $GLOBALS["image_preview_zoom"] = false;
            $tile_region_support = false;
            $not_jpg = strtolower((string)$resource['file_extension']) != "jpg";
            $fulljpgsize = $not_jpg ? "hpr" : "";
            $fulljpgext = $not_jpg ? 'jpg' : $resource['file_extension'];
            $zoom_image_path = get_resource_path($resource["ref"], true, $fulljpgsize, false, $fulljpgext, true, 1, $use_watermark);

            if($GLOBALS["preview_tiles"] && file_exists($zoom_image_path) && resource_download_allowed($resource["ref"], '', $resource['resource_type']))
                {
                $image_size = get_original_imagesize($resource["ref"], $zoom_image_path);
                $image_width = (int) $image_size[1];
                $image_height = (int) $image_size[2];

                $tiles = compute_tiles_at_scale_factor(1, $image_width, $image_height);
                $first_tile = (isset($tiles[0]['id']) ? $tiles[0]['id'] : '');
                $last_tile = (isset($tiles[count($tiles) - 1]['id']) ? $tiles[count($tiles) - 1]['id'] : '');
                if(
                    $first_tile !== '' && $last_tile !== ''
                    && file_exists(get_resource_path($resource["ref"], true, $first_tile, false))
                    && file_exists(get_resource_path($resource["ref"], true, $last_tile, false))
                )
                    {
                    $tile_region_support = true;
                    }
                }

            if ($tile_region_support)
                {
                // Force $hide_real_filepath temporarily to get the download URL
                $orig_hrfp = $GLOBALS["hide_real_filepath"];
                $GLOBALS["hide_real_filepath"] = true;
                $tile_url = get_resource_path($resource["ref"], false, '', false, $resource['file_extension'], true, 1, $use_watermark);
                $GLOBALS["hide_real_filepath"] = $orig_hrfp;

                // Generate the custom tile source object for OpenSeadragon
                ?>
                <script>
                var openseadragon_custom_tile_source = {
                    height:  echo $image_height; ?>,
                    width:   echo $image_width; ?>,
                    tileSize:  echo (int) $GLOBALS["preview_tile_size"]; ?>,
                    minLevel: 11,
                    getTileUrl: function(level, x, y)
                        {
                        var scale_factor = Math.pow(2, this.maxLevel - level);
                        var tile_url = ' echo $tile_url; ?>';
                            tile_url += '&tile_region=1';
                            tile_url += '&tile_scale=' + scale_factor;
                            tile_url += '&tile_row=' + y;
                            tile_url += '&tile_col=' + x;

                        console.info('[OpenSeadragon] level = %o, x (column) = %o, y (row) = %o, scale_factor = %o', level, x, y, scale_factor);
                        console.debug('[OpenSeadragon] tile_url = %o', tile_url);
                        return tile_url;
                        }
                };
                </script>
                
                $GLOBALS["image_preview_zoom"] = true;
                }
            else
                {
                // Use static image of a higher resolution (lpr/scr) preview
                foreach(['lpr', 'scr'] as $hrs)
                    {
                    $zoom_image_path = get_resource_path($resource["ref"], true, $hrs, false, $resource['preview_extension'], true, 1, $use_watermark);
                    $allowed_static_image_size = resource_download_allowed($resource["ref"], $hrs, $resource['resource_type']);
                    if(file_exists($zoom_image_path) && !resource_has_access_denied_by_RT_size($resource['resource_type'], $hrs) && $allowed_static_image_size)
                        {
                        $preview_url = get_resource_path($resource["ref"], false, $hrs, false, $resource['preview_extension'], true, 1, $use_watermark);

                        // Generate the custom tile source object for OpenSeadragon
                        $GLOBALS["image_preview_zoom_lib_required"] = true;
                        ?>
                        <script>
                        var openseadragon_custom_tile_source = { type: 'image', url: ' echo $preview_url; ?>' };
                        </script>
                        
                        $GLOBALS["image_preview_zoom"] = true;
                        break;
                        }
                    }
                }
            }

        if (canSeePreviewTools())
            {
            if ($GLOBALS["annotate_enabled"])
                {
                include_once '../include/annotation_functions.php';
                }
                ?>

            <!-- Available tools to manipulate previews -->
            <div id="PreviewTools" >
                <script>
                function is_another_tool_option_enabled(element)
                    {
                    var current_selected_tool = jQuery(element);
                    var tool_options_enabled = jQuery('#PreviewToolsOptionsWrapper')
                        .find('.ToolsOptionLink.Enabled')
                        .not(current_selected_tool);

                    if(tool_options_enabled.length === 0)
                        {
                        return false;
                        }

                    styledalert(' echo escape($lang['not_allowed']); ?>', ' echo escape($lang['error_multiple_preview_tools']); ?>');
                    return true;
                    }

                function toggleMode(element)
                    {
                    jQuery(element).toggleClass('Enabled');
                    }
                </script>

                <div id="PreviewToolsOptionsWrapper">
                    
                    if($GLOBALS["annotate_enabled"] && file_exists($imagepath) && canSeeAnnotationsFields())
                        {
                        ?>
                        <a class="ToolsOptionLink AnnotationsOption" href="#" onclick="toggleAnnotationsOption(this); return false;">
                            <i class='fa fa-pencil-square-o' aria-hidden="true"></i>
                        </a>

                        <script>
                        var rs_tagging_plugin_added = false;

                        function toggleAnnotationsOption(element)
                            {
                            var option             = jQuery(element);
                            var preview_image      = jQuery('#previewimage');
                            var preview_image_link = jQuery('#previewimagelink');
                            var img_copy_id        = 'previewimagecopy';
                            var img_src            = preview_image.attr('src');

                            // Setup Annotorious (has to be done only once)
                            if(!rs_tagging_plugin_added)
                                {
                                anno.addPlugin('RSTagging',
                                    {
                                    select              : ' echo escape($lang['annotate_select'])?>',
                                    annotations_endpoint: ' echo $GLOBALS["baseurl"]; ?>/pages/ajax/annotations.php',
                                    nodes_endpoint      : ' echo $GLOBALS["baseurl"]; ?>/pages/ajax/get_nodes.php',
                                    resource            :  echo (int) $resource["ref"]; ?>,
                                    read_only           :  echo $edit_access ? 'false' : 'true'; ?>,
                                    // We pass CSRF token identifier separately in order to know what to get in the Annotorious plugin file
                                    csrf_identifier: ' echo $GLOBALS["CSRF_token_identifier"]; ?>',
                                     echo generateAjaxToken('RSTagging'); ?>
                                    });

                                 if ($GLOBALS["facial_recognition"]) { ?>
                                    anno.addPlugin('RSFaceRecognition',
                                        {
                                        annotations_endpoint: ' echo $GLOBALS["baseurl"]; ?>/pages/ajax/annotations.php',
                                        facial_recognition_endpoint: ' echo $GLOBALS["baseurl"]; ?>/pages/ajax/facial_recognition.php',
                                        resource:  echo (int) $resource["ref"]; ?>,
                                        facial_recognition_tag_field:  echo (int) $GLOBALS["facial_recognition_tag_field"]; ?>,
                                        // We pass CSRF token identifier separately in order to know what to get in the Annotorious plugin file
                                        fr_csrf_identifier: ' echo $GLOBALS["CSRF_token_identifier"]; ?>',
                                         echo generateAjaxToken('RSFaceRecognition'); ?>
                                        });
                                 } ?>

                                rs_tagging_plugin_added = true;

                                // We have to wait for initialisation process to finish as this does ajax calls
                                // in order to set itself up
                                setTimeout(function ()
                                    {
                                    toggleAnnotationsOption(element);
                                    }, 
                                    1000);

                                return false;
                                }

                            // Feature enabled? Then disable it.
                            if(option.hasClass('Enabled'))
                                {
                                anno.destroy(preview_image.data('original'));

                                // Remove the copy and show the linked image again
                                jQuery('#' + img_copy_id).remove();
                                preview_image_link.show();

                                toggleMode(element);

                                return false;
                                }

                            // Always check no other conflicting preview tool option is enabled
                            if(is_another_tool_option_enabled(element))
                                {
                                return false;
                                }

                            // Enable feature
                            // Hide the linked image for now and use a copy of it to annotate
                            var preview_image_copy = preview_image.clone(true);
                            preview_image_copy.prop('id', img_copy_id);
                            preview_image_copy.prop('src', img_src);

                            // Set the width and height of the image otherwise if the source of the file
                            // is fetched from download.php, Annotorious will not be able to determine its
                            // size
                            var preview_image_width=preview_image.width();
                            var preview_image_height=preview_image.height();
                            preview_image_copy.width( preview_image_width );
                            preview_image_copy.height( preview_image_height );

                            preview_image_copy.insertAfter(preview_image_link);
                            preview_image_link.hide();

                            anno.makeAnnotatable(document.getElementById(img_copy_id));

                            toggleMode(element);

                            return false;
                            }
                        </script>
                        
                        }

                    if($GLOBALS["image_preview_zoom"])
                        {
                        # Process rotation from preview tweaks and use it to display the openseadragon preview in the correct orientation.
                        if (isset($resource['preview_tweaks']))
                            {
                            $preview_tweak_parts = explode('|', $resource['preview_tweaks']);
                            $osd_preview_rotation = 0;
                            if ($preview_tweak_parts[0] > 0 && is_numeric($preview_tweak_parts[0]))
                                {
                                $osd_preview_rotation = 360 - $preview_tweak_parts[0];
                                }
                            } ?>

                        <a class="ToolsOptionLink ImagePreviewZoomOption" href="#" onclick="return toggleImagePreviewZoomOption(this);">
                            <i class='fa fa-search-plus' aria-hidden="true"></i>
                        </a>

                        <script>
                        var openseadragon_viewer = null;
                        function toggleImagePreviewZoomOption(element)
                            {
                            var zoom_option_enabled = jQuery(element).hasClass('Enabled');

                            if(!zoom_option_enabled && is_another_tool_option_enabled(element))
                                {
                                // Don't enable the tool while a conflicting preview tool is enabled
                                return false;
                                }
                            else if(!zoom_option_enabled)
                                {
                                console.debug('Enabling image zoom with OpenSeadragon');

                                jQuery('#previewimagewrapper').prepend('<div id="openseadragon_viewer"></div>');

                                // Hide the usual preview image of the resource
                                jQuery('#previewimagelink').toggleClass('DisplayNone');

                                openseadragon_viewer = OpenSeadragon({
                                    id: "openseadragon_viewer",
                                    prefixUrl: " echo $GLOBALS["baseurl"] . LIB_OPENSEADRAGON; ?>/images/",
                                    degrees:  echo (int) $osd_preview_rotation; ?>,
                                    // debugMode: true,
                                    // debugGridColor: ['red'],

                                    tileSources: openseadragon_custom_tile_source
                                });
                                }
                            else if(zoom_option_enabled)
                                {
                                console.debug('Disabling image zoom with OpenSeadragon');
                                openseadragon_viewer.destroy();
                                openseadragon_viewer = null;
                                jQuery('#openseadragon_viewer').remove();

                                // Show the usual preview image of the resource
                                jQuery('#previewimagelink').toggleClass('DisplayNone');
                                }
                            else
                                {
                                console.error('Something went wrong with toggleImagePreviewZoomOption');
                                }

                            toggleMode(element);

                            return false;
                            }
                        </script>
                        
                        }
                        ?>
                </div>
            </div>
            
            } /* end of canSeePreviewTools() */
        }
        ?>
    </div>
    
    }

This article was last updated 17th November 2024 15:05 Europe/London time based on the source file dated 13th November 2024 14:05 Europe/London time.