class.ilWebDAVMountInstructions.php

Go to the documentation of this file.

<?php
 
class ilWebDAVMountInstructions
{
    protected $user_agent;
    protected $request_uri;
    protected $http_host;
    protected $script_name;
    protected $client_id;
    protected $path_to_template;
    
    protected $clientOSFlavor;
    protected $clientOS;
    
    protected $settings;
    protected $lng;
    
    protected $ref_id;
    protected $obj_id;
    protected $obj_title;
    
    public function __construct($a_user_agent = '', $a_request_uri = '', $a_http_host = '', $a_script_name = '', $a_client_id = '')
    {
        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);
    }
    
    protected function setValuesFromUserAgent($a_user_agent)
    {
        // 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';
            }
        }
    }
    
    public function instructionsTplFileExists()
    {
        return is_file($this->path_to_template);
    }
    
    public function getInstructionsFromTplFile()
    {
        return fread(fopen($this->path_to_template, "rb"), filesize($this->path_to_template));
    }
    
    public function getCustomInstruction()
    {
        return $this->settings->get('custom_webfolder_instructions');
    }
    
    public function getDefaultInstruction()
    {
        return $this->lng->txt('webfolder_instructions_text');
    }
    
    public function getWebfolderTitle()
    {
        return $this->obj_title;
    }
    
    public function getDefaultUri()
    {
        return $this->protocol_prefixes['default'] . $this->base_uri;
    }
    
    public function getIEUri()
    {
        // Was in the old webdav the same like default uri and is now still the same
        return $this->protocol_prefixes['default'] . $this->base_uri;
    }
    
    public function getKonquerorUri()
    {
        return $this->protocol_prefixes['konqueror'] . $this->base_uri;
    }
    
    public function getNautilusUri()
    {
        return $this->protocol_prefixes['nautilus'] . $this->base_uri;
    }
    
    public function setInstructionPlaceholders($a_instruction_tpl)
    {
        $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;
    }
}