Class ilWebDAVMountInstructionsGUI. More...

Collaboration diagram for ilWebDAVMountInstructionsGUI:

Public Member Functions
	__construct (ilWebDAVBaseMountInstructions $a_mount_instruction)

	buildGUIFromGivenMountInstructions ($a_mount_instructions, $a_render_async=false)

	renderMountInstructionsContent ()

Protected Attributes
	$protocol_prefixes

	$base_url

	$ref_id

	$mount_instruction

	$il_lang

	$ui

	$http

Private Member Functions
	determineOSfromUserAgent ()

Detailed Description

Class ilWebDAVMountInstructionsGUI.

This class delivers or prints a representation of the mount instructions

Author: Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 11 of file class.ilWebDAVMountInstructionsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebDAVMountInstructionsGUI::__construct ( ilWebDAVBaseMountInstructions $a_mount_instruction )

Definition at line 26 of file class.ilWebDAVMountInstructionsGUI.php.

    {
        global $DIC;
 
        $this->uri_builder = new ilWebDAVUriBuilder($DIC->http()->request());
        $this->mount_instruction = $a_mount_instruction;
        $this->il_lang = $DIC->language();
        $this->ui = $DIC->ui();
        $this->http = $DIC->http();
    }

References $DIC, ILIAS\FileDelivery\http(), and ui().

Here is the call graph for this function:

Member Function Documentation

◆ buildGUIFromGivenMountInstructions()

ilWebDAVMountInstructionsGUI::buildGUIFromGivenMountInstructions	(	$a_mount_instructions,
		$a_render_async = `false`
	)

Definition at line 37 of file class.ilWebDAVMountInstructionsGUI.php.

    {
        $os = $this->determineOSfromUserAgent();
        
        $f = $this->ui->factory();
        $r = $this->ui->renderer();
 
        // List of all components to render
        $comps = array();
 
        // This is an additional legacy component. It contains the java script function to substitute the shown instructions
        $js_function_legacy = $f->legacy('<script>'
            . 'il.UI.showMountInstructions = function (e, id){'
            // e['target'] is the id for the button which was clicked (e.g. 'button#il_ui_fw_1234')
            . "obj = $(e['target']);"
            // Sets all buttons to the "unclicked" state
            . "obj.siblings().removeClass('engaged disabled ilSubmitInactive').attr('aria-pressed', 'false');"
            . "obj.siblings().removeAttr('disabled');"
            // Sets the clicked button into the "clicked" state
            . "obj.addClass('engaged ilSubmitInactive').attr('aria-pressed', 'true');"
            // Hide all instruction divs at first
            . '$(".instructions").hide();'
            // Show the div which is given as an argument
            . '$("#"+id).show();}</script>');
 
        /*
         * The document might just contain a single entry, then we don't need a view control and just return it.
         */
        if (count($a_mount_instructions) === 1) {
            $content = $f->legacy("<div class='instructions'>" . array_shift($a_mount_instructions) . "</div>");
            
            return $a_render_async ? $r->renderAsync($content) : $r->render($content);
        }
        
        /*
         * This is an associative array. The key is the title of the button, the value the used signal. E.g.:
         * array(
         *      "WINDOWS" => signal_for_windows_legacy_component,
         *      "MAC" => signal_for_mac_legacy_component,
         *      "LINUX" => signal_for_linux_legacy_component);
         */
        $view_control_actions = array();
        
        /*
         * If we can determine the os and we find a corresponding string in the
         * title of the instructions we automatically set it.
         */
        
        foreach ($a_mount_instructions as $key => $value) {
            $selected = $a_mount_instructions[$key];
            break;
        }
        
        
        foreach ($a_mount_instructions as $title => $text) {
            foreach ($os as $os_string) {
                if (stristr($title, $os_string) !== false) {
                    $selected = $title;
                    break 2;
                }
            }
        }
        
        foreach ($a_mount_instructions as $title => $text) {
            if ($title == $selected) {
                $hidden = '';
            } else {
                $hidden = 'style="display: none;"';
            }
            
            // Create legacy component for mount instructions. Mount instructions text is wrapped in a <div>-tag
            $legacy = $f->legacy("<div id='$title' class='instructions' $hidden>$text</div>")
                ->withCustomSignal($title, "il.UI.showMountInstructions(event, '$title');");
 
            // Add to the list of components to render
            $comps[] = $legacy;
 
            // Add signal to the list for the view control
            $view_control_actions[$title] = $legacy->getCustomSignal($title);
        }
 
        $view_control = $f->viewControl()->mode($view_control_actions, "mount-instruction-buttons")->withActive($selected);
 
        // Add view control and legacy add the beginning of the array (so they will be rendered first)
        $header_comps = array(
            $f->legacy("<div class='webdav-view-control'>"),
            $view_control,
            $f->legacy("</div>"),
            $js_function_legacy);
 
        $comps = array_merge($header_comps, $comps);
 
        return $a_render_async ? $r->renderAsync($comps) : $r->render($comps);
    }

References Vendor\Package\$f, determineOSfromUserAgent(), and ui().

Referenced by renderMountInstructionsContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineOSfromUserAgent()

ilWebDAVMountInstructionsGUI::determineOSfromUserAgent ( )

private

Definition at line 149 of file class.ilWebDAVMountInstructionsGUI.php.

                                                : array
    {
        $ua = $this->http->request()->getHeader('User-Agent')[0];
        
        if (stristr($ua, 'windows') !== false
            || strpos($ua, 'microsoft') !== false) {
            return ['win'];
        }
        
        if (stristr($this->user_agent, 'darwin') !== false
            || stristr($ua, 'macintosh') !== false) {
            return ['mac', 'osx'];
        }
            
        if (stristr($ua, 'linux') !== false
            || stristr($ua, 'solaris') !== false
            || stristr($ua, 'aix') !== false
            || stristr($ua, 'unix') !== false
            || stristr($ua, 'gvfs') !== false // nautilus browser uses this ID
            ) {
            return ['linux'];
        }
 
        return ['unknown'];
    }

References ILIAS\FileDelivery\http().

Referenced by buildGUIFromGivenMountInstructions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderMountInstructionsContent()

ilWebDAVMountInstructionsGUI::renderMountInstructionsContent ( )

Definition at line 132 of file class.ilWebDAVMountInstructionsGUI.php.

    {
        try {
            $instructions = $this->mount_instruction->getMountInstructionsAsArray();
        } catch (InvalidArgumentException $e) {
            $document_processor = new ilWebDAVMountInstructionsHtmlDocumentProcessor(new ilWebDAVMountInstructionsDocumentPurifier());
            $instructions = $document_processor->processMountInstructions($this->il_lang->txt('webfolder_instructions_text'));
            $instructions = $this->mount_instruction->getMountInstructionsAsArray($instructions);
            if ($instructions == '' || $instructions == '-webfolder_instructions_text-') {
                $instructions = ["<div class='alert alert-danger'>" . $this->il_lang->txt('error') . ": " . $this->il_lang->txt('webdav_missing_lang') . "</div>"];
            }
        }
 
        echo $this->buildGUIFromGivenMountInstructions($instructions, true);
        exit;
    }