Class ilWebDAVMountInstructions. More...

Collaboration diagram for ilWebDAVMountInstructions:

Public Member Functions
	__construct ($a_user_agent='', $a_request_uri='', $a_http_host='', $a_script_name='', $a_client_id='')

	instructionsTplFileExists ()

	getInstructionsFromTplFile ()

	getCustomInstruction ()

	getDefaultInstruction ()

	getWebfolderTitle ()

	getDefaultUri ()

	getIEUri ()

	getKonquerorUri ()

	getNautilusUri ()

	setInstructionPlaceholders ($a_instruction_tpl)
	Gets Webfolder mount instructions for the specified webfolder. More...

Protected Member Functions
	setValuesFromUserAgent ($a_user_agent)

Protected Attributes
	$user_agent

	$request_uri

	$http_host

	$script_name

	$client_id

	$path_to_template

	$clientOSFlavor

	$clientOS

	$settings

	$lng

	$ref_id

	$obj_id

	$obj_title

Detailed Description

Class ilWebDAVMountInstructions.

This class creates the page and links for the WebDAV mount instruction page

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.ilWebDAVMountInstructions.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebDAVMountInstructions::__construct	(	$a_user_agent = `''`,
		$a_request_uri = `''`,
		$a_http_host = `''`,
		$a_script_name = `''`,
		$a_client_id = `''`
	)

Definition at line 30 of file class.ilWebDAVMountInstructions.php.

    {
        global $DIC;
        
        $this->settings = new ilSetting('file_access');
        $this->lng = $DIC->language();
        
        $this->user_agent = $a_user_agent == '' ? strtolower($_SERVER['HTTP_USER_AGENT']) : $a_user_agent;
        $this->request_uri = $a_request_uri == '' ? $_SERVER['REQUEST_URI'] : $a_request_uri;
        $this->http_host = $a_http_host == '' ? $_SERVER['HTTP_HOST'] : $a_http_host;
        $this->script_name = $a_http_host == '' ? $_SERVER['SCRIPT_NAME'] : $a_script_name;
        $this->client_id = $a_http_host == '' ? CLIENT_ID : $a_client_id;
        $this->path_to_template = 'Customizing/clients/' . $this->client_id . '/webdavtemplate.htm';
        
        $this->ref_id = 0;
        foreach (explode('/', $this->request_uri) as $uri_part) {
            if (strpos($uri_part, 'ref_') !== false && $this->ref_id == 0) {
                $this->ref_id = (int) explode('_', $uri_part)[1];
            }
        }
        if ($this->ref_id == 0) {
            throw new Exception('Bad Request: No ref id given!');
        } else {
            $this->obj_id = ilObject::_lookupObjectId($this->ref_id);
            $this->obj_title = ilObject::_lookupTitle($this->obj_id);
        }
        
        $this->base_uri = $this->http_host . $this->script_name . '/' . $this->client_id . '/ref_' . $this->ref_id . '/';
        
        $this->protocol_prefixes = array(
            'default' => 'https://',
            'konqueror' => 'webdavs://',
            'nautilus' => 'davs://'
        );
        
        $this->setValuesFromUserAgent($this->user_agent);
    }

References $_SERVER, $DIC, ilObject\_lookupObjectId(), ilObject\_lookupTitle(), settings(), and setValuesFromUserAgent().

Here is the call graph for this function:

Member Function Documentation

◆ getCustomInstruction()

ilWebDAVMountInstructions::getCustomInstruction ( )

Definition at line 113 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->settings->get('custom_webfolder_instructions');
    }

References settings().

Here is the call graph for this function:

◆ getDefaultInstruction()

ilWebDAVMountInstructions::getDefaultInstruction ( )

Definition at line 118 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->lng->txt('webfolder_instructions_text');
    }

◆ getDefaultUri()

ilWebDAVMountInstructions::getDefaultUri ( )

Definition at line 128 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->protocol_prefixes['default'] . $this->base_uri;
    }

Referenced by setInstructionPlaceholders().

Here is the caller graph for this function:

◆ getIEUri()

ilWebDAVMountInstructions::getIEUri ( )

Definition at line 133 of file class.ilWebDAVMountInstructions.php.

    {
        // Was in the old webdav the same like default uri and is now still the same
        return $this->protocol_prefixes['default'] . $this->base_uri;
    }

Referenced by setInstructionPlaceholders().

Here is the caller graph for this function:

◆ getInstructionsFromTplFile()

ilWebDAVMountInstructions::getInstructionsFromTplFile ( )

Definition at line 108 of file class.ilWebDAVMountInstructions.php.

    {
        return fread(fopen($this->path_to_template, "rb"), filesize($this->path_to_template));
    }

◆ getKonquerorUri()

ilWebDAVMountInstructions::getKonquerorUri ( )

Definition at line 139 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->protocol_prefixes['konqueror'] . $this->base_uri;
    }

Referenced by setInstructionPlaceholders().

Here is the caller graph for this function:

◆ getNautilusUri()

ilWebDAVMountInstructions::getNautilusUri ( )

Definition at line 144 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->protocol_prefixes['nautilus'] . $this->base_uri;
    }

Referenced by setInstructionPlaceholders().

Here is the caller graph for this function:

◆ getWebfolderTitle()

ilWebDAVMountInstructions::getWebfolderTitle ( )

Definition at line 123 of file class.ilWebDAVMountInstructions.php.

    {
        return $this->obj_title;
    }

References $obj_title.

◆ instructionsTplFileExists()

ilWebDAVMountInstructions::instructionsTplFileExists ( )

Definition at line 103 of file class.ilWebDAVMountInstructions.php.

    {
        return is_file($this->path_to_template);
    }

◆ setInstructionPlaceholders()

ilWebDAVMountInstructions::setInstructionPlaceholders ( $a_instruction_tpl )

Gets Webfolder mount instructions for the specified webfolder.

The following placeholders are currently supported:

[WEBFOLDER_TITLE] - the title of the webfolder [WEBFOLDER_URI] - the URL for mounting the webfolder with standard compliant WebDAV clients [WEBFOLDER_URI_IE] - the URL for mounting the webfolder with Internet Explorer [WEBFOLDER_URI_KONQUEROR] - the URL for mounting the webfolder with Konqueror [WEBFOLDER_URI_NAUTILUS] - the URL for mounting the webfolder with Nautilus [IF_WINDOWS]...[/IF_WINDOWS] - conditional contents, with instructions for Windows [IF_MAC]...[/IF_MAC] - conditional contents, with instructions for Mac OS X [IF_LINUX]...[/IF_LINUX] - conditional contents, with instructions for Linux [ADMIN_MAIL] - the mailbox address of the system administrator

Parameters

unknown $a_instruction_tpl

Returns: mixed

Definition at line 168 of file class.ilWebDAVMountInstructions.php.

    {
        $a_instruction_tpl = str_replace("[WEBFOLDER_ID]", $this->ref_id, $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[WEBFOLDER_TITLE]", $this->obj_title, $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[WEBFOLDER_URI]", $this->getDefaultUri(), $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[WEBFOLDER_URI_IE]", $this->getIEUri(), $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[WEBFOLDER_URI_KONQUEROR]", $this->getKonquerorUri(), $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[WEBFOLDER_URI_NAUTILUS]", $this->getNautilusUri(), $a_instruction_tpl);
        $a_instruction_tpl = str_replace("[ADMIN_MAIL]", $this->settings->get("admin_email"), $a_instruction_tpl);
        
        if (strpos($this->user_agent, 'MSIE') !== false) {
            $a_instruction_tpl = preg_replace('/\[IF_IEXPLORE\](?:(.*))\[\/IF_IEXPLORE\]/s', '\1', $a_instruction_tpl);
        } else {
            $a_instruction_tpl = preg_replace('/\[IF_NOTIEXPLORE\](?:(.*))\[\/IF_NOTIEXPLORE\]/s', '\1', $a_instruction_tpl);
        }
        
        switch ($this->clientOS) {
            case 'windows':
                $operatingSystem = 'WINDOWS';
                break;
            case 'unix':
                switch ($this->clientOSFlavor) {
                    case 'osx':
                        $operatingSystem = 'MAC';
                        break;
                    case 'linux':
                        $operatingSystem = 'LINUX';
                        break;
                    default:
                        $operatingSystem = 'LINUX';
                        break;
                }
                break;
            default:
                $operatingSystem = 'UNKNOWN';
                break;
        }
        if ($operatingSystem != 'UNKNOWN') {
            $a_instruction_tpl = preg_replace('/\[IF_' . $operatingSystem . '\](?:(.*))\[\/IF_' . $operatingSystem . '\]/s', '\1', $a_instruction_tpl);
            $a_instruction_tpl = preg_replace('/\[IF_([A-Z_]+)\](?:(.*))\[\/IF_\1\]/s', '', $a_instruction_tpl);
        } else {
            $a_instruction_tpl = preg_replace('/\[IF_([A-Z_]+)\](?:(.*))\[\/IF_\1\]/s', '\2', $a_instruction_tpl);
        }
        
        return $a_instruction_tpl;
    }

References getDefaultUri(), getIEUri(), getKonquerorUri(), getNautilusUri(), and settings().

Here is the call graph for this function:

◆ setValuesFromUserAgent()

ilWebDAVMountInstructions::setValuesFromUserAgent ( $a_user_agent )

protected

Definition at line 68 of file class.ilWebDAVMountInstructions.php.

    {
        // Guess operating system, operating system flavor and browser of the webdav client
        //
        // - We need to know the operating system in order to properly
        // hide hidden resources in directory listings.
        //
        // - We need the operating system flavor and the browser to
        // properly support mounting of a webdav folder.
        //
        if (strpos($a_user_agent, 'windows') !== false
            || strpos($a_user_agent, 'microsoft') !== false) {
            $this->clientOS = 'windows';
            if (strpos($a_user_agent, 'nt 5.1') !== false) {
                $this->clientOSFlavor = 'xp';
            } else {
                $this->clientOSFlavor = 'nichtxp';
            }
        } elseif (strpos($this->user_agent, 'darwin') !== false
            || strpos($a_user_agent, 'macintosh') !== false
            || strpos($a_user_agent, 'linux') !== false
            || strpos($a_user_agent, 'solaris') !== false
            || strpos($a_user_agent, 'aix') !== false
            || strpos($a_user_agent, 'unix') !== false
            || strpos($a_user_agent, 'gvfs') !== false // nautilus browser uses this ID
            ) {
            $this->clientOS = 'unix';
            if (strpos($a_user_agent, 'linux') !== false) {
                $this->clientOSFlavor = 'linux';
            } elseif (strpos($a_user_agent, 'macintosh') !== false) {
                $this->clientOSFlavor = 'osx';
            }
        }
    }