df/d4c/class_8ilWebDAVUtil_8php_source.html

 <?php

 class ilWebDAVUtil
 {
     protected static $clientBrowser = "firefox";
     protected static $clientOS = "windows";
     protected static $clientFlavor = "nichtxp";

     public static function _isActionsVisible()
     {
         global $DIC;
         return $DIC->clientIni()->readVariable('file_access', 'webdav_actions_visible') == '1';
     }

     public function showMountInstructions(&$objDAV, &$options)
     {
         global $DIC;
         $lng = $DIC->language();
         $ilUser = $DIC->user();

         $path = $this->davDeslashify($options['path']);

         // The $path variable may contain a full or a shortened DAV path.
         // We convert it into an object path, which we can then use to
         // construct a new full DAV path.
         $objectPath = $this->toObjectPath($path);

         // Construct a (possibly) full DAV path from the object path.
         $fullPath = '';
         foreach ($objectPath as $object) {
             if ($object->getRefId() == 1 && $this->isFileHidden($object)) {
                 // If the repository root object is hidden, we can not
                 // create a full path, because nothing would appear in the
                 // webfolder. We resort to a shortened path instead.
                 $fullPath .= '/ref_1';
             } else {
                 $fullPath .= '/' . $this->davUrlEncode($object->getResourceName());
             }
         }

         // Construct a shortened DAV path from the object path.
         $shortenedPath = '/ref_' .
             $objectPath[count($objectPath) - 1]->getRefId();

         if ($objDAV->isCollection()) {
             $shortenedPath .= '/';
             $fullPath .= '/';
         }

         // Prepend client id to path
         $shortenedPath = '/' . CLIENT_ID . $shortenedPath;
         $fullPath = '/' . CLIENT_ID . $fullPath;

         // Construct webfolder URI's. The URI's are used for mounting the
         // webfolder. Since mounting using URI's is not standardized, we have
         // to create different URI's for different browsers.
         $webfolderURI = $this->base_uri . $shortenedPath;
         $webfolderURI_Konqueror = ($this->isWebDAVoverHTTPS() ? "webdavs" : "webdav") .
             substr($this->base_uri, strrpos($this->base_uri, ':')) .
             $shortenedPath;
         ;
         $webfolderURI_Nautilus = ($this->isWebDAVoverHTTPS() ? "davs" : "dav") .
             substr($this->base_uri, strrpos($this->base_uri, ':')) .
             $shortenedPath
             ;
         $webfolderURI_IE = $this->base_uri . $shortenedPath;

         $webfolderTitle = $objectPath[count($objectPath) - 1]->getResourceName();

         header('Content-Type: text/html; charset=UTF-8');
         echo "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
         echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN\"\n";
         echo "  \"http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd\">\n";
         echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n";
         echo "  <head>\n";
         echo "  <title>" . sprintf($lng->txt('webfolder_instructions_titletext'), $webfolderTitle) . "</title>\n";
         echo "  </head>\n";
         echo "  <body>\n";

         echo ilDAVServer::_getWebfolderInstructionsFor(
             $webfolderTitle,
             $webfolderURI,
             $webfolderURI_IE,
             $webfolderURI_Konqueror,
             $webfolderURI_Nautilus,
             $this->clientOS,
             $this->clientOSFlavor
         );

         echo "  </body>\n";
         echo "</html>\n";

         // Logout anonymous user to force authentication after calling mount uri
         if ($ilUser->getId() == ANONYMOUS_USER_ID) {
             $DIC['ilAuthSession']->logout();
         }

         exit;
     }

     protected function checkLock($path)
     {
         global $DIC;

         $this->writelog('checkLock(' . $path . ')');
         $result = null;

         // get dav object for path
         //$objDAV = $this->getObject($path);

         // convert DAV path into ilObjectDAV path
         $objPath = $this->toObjectPath($path);
         if (!is_null($objPath)) {
             $objDAV = $objPath[count($objPath) - 1];
             $locks = $this->locks->getLocksOnPathDAV($objPath);
             foreach ($locks as $lock) {
                 $isLastPathComponent = $lock['obj_id'] == $objDAV->getObjectId()
                 && $lock['node_id'] == $objDAV->getNodeId();

                 // Check all locks on last object in path,
                 // but only locks with depth infinity on parent objects.
                 if ($isLastPathComponent || $lock['depth'] == 'infinity') {
                     // DAV Clients expects to see their own owner name in
                     // the locks. Since these names are not unique (they may
                     // just be the name of the local user running the DAV client)
                     // we return the ILIAS user name in all other cases.
                     if ($lock['ilias_owner'] == $DIC->user()->getId()) {
                         $owner = $lock['dav_owner'];
                     } else {
                         $owner = $this->getLogin($lock['ilias_owner']);
                     }

                     // FIXME - Shouldn't we collect all locks instead of
                     //         using an arbitrary one?
                     $result = array(
                         "type" => "write",
                         "obj_id" => $lock['obj_id'],
                         "node_id" => $lock['node_id'],
                         "scope" => $lock['scope'],
                         "depth" => $lock['depth'],
                         "owner" => $owner,
                         "token" => $lock['token'],
                         "expires" => $lock['expires']
                     );
                     if ($lock['scope'] == 'exclusive') {
                         // If there is an exclusive lock in the path, it
                         // takes precedence over all non-exclusive locks in
                         // parent nodes. Therefore we can can finish collecting
                         // locks.
                         break;
                     }
                 }
             }
         }
         $this->writelog('checkLock(' . $path . '):' . var_export($result, true));

         return $result;
     }

     protected function getLogin($userId)
     {
         $login = ilObjUser::_lookupLogin($userId);
         $this->writelog('getLogin(' . $userId . '):' . var_export($login, true));
         return $login;
     }


     private function getObject($davPath)
     {
         global $DIC;
         $tree = $DIC->repositoryTree();


         // If the second path elements starts with 'file_', the following
         // characters of the path element directly identify the ref_id of
         // a file object.
         $davPathComponents = explode('/', substr($davPath, 1));

         if (count($davPathComponents) > 1 &&
             substr($davPathComponents[1], 0, 5) == 'file_') {
             $ref_id = substr($davPathComponents[1], 5);
             $nodePath = $tree->getNodePath($ref_id, $tree->root_id);

             // Poor IE needs this, in order to successfully display
             // PDF documents
             header('Pragma: private');
         } else {
             $nodePath = $this->toNodePath($davPath);
             if ($nodePath == null && count($davPathComponents) == 1) {
                 return ilObjectDAV::createObject(-1, 'mountPoint');
             }
         }
         if (is_null($nodePath)) {
             return null;
         } else {
             $top = $nodePath[count($nodePath) - 1];
             return ilObjectDAV::createObject($top['child'], $top['type']);
         }
     }
     private function toObjectPath($davPath)
     {
         $this->writelog('toObjectPath(' . $davPath);

         $nodePath = $this->toNodePath($davPath);

         if (is_null($nodePath)) {
             return null;
         } else {
             $objectPath = array();
             foreach ($nodePath as $node) {
                 $pathElement = ilObjectDAV::createObject($node['child'], $node['type']);
                 if (is_null($pathElement)) {
                     break;
                 }
                 $objectPath[] = $pathElement;
             }
             return $objectPath;
         }
     }

     public function toNodePath($davPath)
     {
         global $DIC;
         $tree = $DIC->repositoryTree();

         $this->writelog('toNodePath(' . $davPath . ')...');

         // Split the davPath into path titles
         $titlePath = explode('/', substr($davPath, 1));

         // Remove the client id from the beginning of the title path
         if (count($titlePath) > 0) {
             array_shift($titlePath);
         }

         // If the last path title is empty, remove it
         if (count($titlePath) > 0 && $titlePath[count($titlePath) - 1] == '') {
             array_pop($titlePath);
         }

         // If the path is empty, return null
         if (count($titlePath) == 0) {
             $this->writelog('toNodePath(' . $davPath . '):null, because path is empty.');
             return null;
         }

         // If the path is an absolute path, ref_id is null.
         $ref_id = null;

         // If the path is a relative folder path, convert it into an absolute path
         if (count($titlePath) > 0 && substr($titlePath[0], 0, 4) == 'ref_') {
             $ref_id = substr($titlePath[0], 4);
             array_shift($titlePath);
         }

         $nodePath = $tree->getNodePathForTitlePath($titlePath, $ref_id);

         $this->writelog('toNodePath():' . var_export($nodePath, true));
         return $nodePath;
     }

     private function davDeslashify($path)
     {
         $path = UtfNormal::toNFC($path);

         if ($path[strlen($path) - 1] == '/') {
             $path = substr($path, 0, strlen($path) - 1);
         }
         return $path;
     }

     private function davBasename($path)
     {
         $components = explode('/', $path);
         return count($components) == 0 ? '' : $components[count($components) - 1];
     }

     public static function getFolderURI($refId, $nodeId = 0, $ressourceName = null, $parentRefId = null)
     {
         if (self::$clientOS == 'windows') {
             $baseUri = "https:";
             $query = null;
         } elseif (self::$clientBrowser == 'konqueror') {
             $baseUri = "webdavs:";
             $query = null;
         } elseif (self::$clientBrowser == 'nautilus') {
             $baseUri = "davs:";
             $query = null;
         } else {
             $baseUri = "https:";
             $query = null;
         }
         $baseUri .= "//$_SERVER[HTTP_HOST]$_SERVER[SCRIPT_NAME]";
         $baseUri = substr($baseUri, 0, strrpos($baseUri, '/')) . '/webdav.php/' . CLIENT_ID;

         $uri = $baseUri . '/ref_' . $refId . '/';
         if ($query != null) {
             $uri .= '?' . $query;
         }

         return $uri;
     }


     public static function getMountURI($refId, $nodeId = 0, $ressourceName = null, $parentRefId = null, $genericURI = false)
     {
         if ($genericURI) {
             $baseUri = "https:";
             $query = null;
         } elseif (self::$clientOS == 'windows') {
             $baseUri = "http:";
             $query = 'mount-instructions';
         } elseif (self::$clientBrowser == 'konqueror') {
             $baseUri = "webdavs:";
             $query = null;
         } elseif (self::$clientBrowser == 'nautilus') {
             $baseUri = "davs:";
             $query = null;
         } else {
             $baseUri = "https:";
             $query = 'mount-instructions';
         }
         $baseUri .= "//$_SERVER[HTTP_HOST]$_SERVER[SCRIPT_NAME]";
         $baseUri = substr($baseUri, 0, strrpos($baseUri, '/')) . '/webdav.php/' . CLIENT_ID;

         $uri = $baseUri . '/ref_' . $refId . '/';
         if ($query != null) {
             $uri .= '?' . $query;
         }

         return $uri;
     }

     public function getObjectURI($refId, $ressourceName = null, $parentRefId = null)
     {
         global $DIC;
         $nodeId = 0;
         $baseUri = ($this->isWebDAVoverHTTPS() ? "https:" : "http:") .
         "//$_SERVER[HTTP_HOST]$_SERVER[SCRIPT_NAME]";
         $baseUri = substr($baseUri, 0, strrpos($baseUri, '/')) . '/webdav.php/' . CLIENT_ID;

         if (!is_null($ressourceName) && !is_null($parentRefId)) {
             // Quickly create URI from the known data without needing SQL queries
             $uri = $baseUri . '/ref_' . $parentRefId . '/' . $this->davUrlEncode($ressourceName);
         } else {
             // Create URI and use some SQL queries to get the missing data
             $nodePath = $DIC->repositoryTree()->getNodePath($refId);

             if (is_null($nodePath) || count($nodePath) < 2) {
                 // No object path? Return null - file is not in repository.
                 $uri = null;
             } else {
                 $uri = $baseUri . '/ref_' . $nodePath[count($nodePath) - 2]['child'] . '/' .
                     $this->davUrlEncode($nodePath[count($nodePath) - 1]['title']);
             }
         }
         return $uri;
     }

     public function getFileURI($refId, $ressourceName = null, $parentRefId = null)
     {
         global $DIC;
         $nodeId = 0;
         $baseUri = ($this->isWebDAVoverHTTPS() ? "https:" : "http:") .
         "//$_SERVER[HTTP_HOST]$_SERVER[SCRIPT_NAME]";
         $baseUri = substr($baseUri, 0, strrpos($baseUri, '/')) . '/webdav.php/' . CLIENT_ID;

         if (!is_null($ressourceName) && !is_null($parentRefId)) {
             // Quickly create URI from the known data without needing SQL queries
             $uri = $baseUri . '/file_' . $refId . '/' . $this->davUrlEncode($ressourceName);
         } else {
             // Create URI and use some SQL queries to get the missing data
             $nodePath = $DIC->repositoryTree()->getNodePath($refId);

             if (is_null($nodePath) || count($nodePath) < 2) {
                 // No object path? Return null - file is not in repository.
                 $uri = null;
             } else {
                 $uri = $baseUri . '/file_' . $nodePath[count($nodePath) - 1]['child'] . '/' .
                     $this->davUrlEncode($nodePath[count($nodePath) - 1]['title']);
             }
         }
         return $uri;
     }

     public function isWebDAVoverHTTPS()
     {
         if ($this->isHTTPS == null) {
             global $DIC;
             $ilSetting = $DIC->settings();
             require_once './Services/Http/classes/class.ilHTTPS.php';
             $https = new ilHTTPS();
             $this->isHTTPS = $https->isDetected() || $ilSetting->get('https');
         }
         return $this->isHTTPS;
     }

     public static function _isActive()
     {
         global $DIC;
         return $DIC->clientIni()->readVariable('file_access', 'webdav_enabled') == '1';
     }

     private function getUploadMaxFilesize()
     {
         $val = ini_get('upload_max_filesize');

         $val = trim($val);
         $last = strtolower($val[strlen($val) - 1]);
         switch ($last) {
             // The 'G' modifier is available since PHP 5.1.0
             case 'g':
                 $val *= 1024;
                 // no break
             case 'm':
                 $val *= 1024;
                 // no break
             case 'k':
                 $val *= 1024;
         }

         return $val;
     }

     private static $instance = null;

     private $pwd_instruction = null;

     private function __construct()
     {
     }

     public static function getInstance()
     {
         if (self::$instance) {
             return self::$instance;
         }
         return self::$instance = new ilWebDAVUtil();
     }

     public function isLocalPasswordInstructionRequired()
     {
         global $DIC;
         $ilUser = $DIC->user();

         if ($this->pwd_instruction !== null) {
             return $this->pwd_instruction;
         }
         include_once './Services/Authentication/classes/class.ilAuthUtils.php';
         $status = ilAuthUtils::supportsLocalPasswordValidation($ilUser->getAuthMode(true));
         if ($status != ilAuthUtils::LOCAL_PWV_USER) {
             return $this->pwd_instruction = false;
         }
         // Check if user has local password
         return $this->pwd_instruction = (bool) !strlen($ilUser->getPasswd());
     }
 }
ilObjUser\_lookupLogin
static _lookupLogin($a_user_id)
lookup login
Definition: class.ilObjUser.php:811

ilWebDAVUtil\getObjectURI
getObjectURI($refId, $ressourceName=null, $parentRefId=null)
TODO: Check if needed and refactor Returns an URI for getting a object using WebDAV by its name...
Definition: class.ilWebDAVUtil.php:454

$path
$path
Definition: aliased.php:25

ilWebDAVUtil\$clientOS
static $clientOS
Definition: class.ilWebDAVUtil.php:15

$result
$result
Definition: CleanUpTest.php:463

ilWebDAVUtil\checkLock
checkLock($path)
TODO: Check if needed and refactor checkLock() helper.
Definition: class.ilWebDAVUtil.php:135

$DIC
global $DIC
Definition: saml.php:7

ilWebDAVUtil\getUploadMaxFilesize
getUploadMaxFilesize()
TODO: Check if needed and refactor Gets the maximum permitted upload filesize from php...
Definition: class.ilWebDAVUtil.php:563

ilWebDAVUtil\toNodePath
toNodePath($davPath)
TODO: Check if needed and refactor Converts a DAV path into a node path.
Definition: class.ilWebDAVUtil.php:286

ilWebDAVUtil\isLocalPasswordInstructionRequired
isLocalPasswordInstructionRequired()
Definition: class.ilWebDAVUtil.php:612

PHPMailer\PHPMailer\$options
$options
Definition: get_oauth_token.php:91

ilWebDAVUtil\__construct
__construct()
Singleton constructor.
Definition: class.ilWebDAVUtil.php:592

ilWebDAVUtil\toObjectPath
toObjectPath($davPath)
TODO: Check if needed and refactor Converts a DAV path into an array of DAV objects.
Definition: class.ilWebDAVUtil.php:253

ilAuthUtils\supportsLocalPasswordValidation
static supportsLocalPasswordValidation($a_authmode)
Check if local password validation is supported.
Definition: class.ilAuthUtils.php:777

ilWebDAVUtil\getLogin
getLogin($userId)
TODO: Check if needed and refactor Returns the login for the specified user id, or null if the user d...
Definition: class.ilWebDAVUtil.php:199

ilWebDAVUtil
This class contains some functions from the old ilDAVServer.
Definition: class.ilWebDAVUtil.php:12

ilWebDAVUtil\$instance
static $instance
Definition: class.ilWebDAVUtil.php:584

ilWebDAVUtil\getMountURI
static getMountURI($refId, $nodeId=0, $ressourceName=null, $parentRefId=null, $genericURI=false)
TODO: Check if needed and refactor Returns an URI for mounting the repository object as a webfolder...
Definition: class.ilWebDAVUtil.php:413

UtfNormal\toNFC
static toNFC($string)
Convert a UTF-8 string to normal form C, canonical composition.
Definition: UtfNormal.php:157

ilHTTPS
HTTPS.
Definition: class.ilHTTPS.php:13

$tree
$tree
Definition: calendarserver.php:37

$lng
$lng
Definition: save_question_post_data.php:23

ilWebDAVUtil\davBasename
davBasename($path)
TODO: Check if needed and refactor Private implementation of PHP basename() function.
Definition: class.ilWebDAVUtil.php:351

ilWebDAVUtil\davDeslashify
davDeslashify($path)
TODO: Check if needed and refactor davDeslashify - make sure path does not end in a slash...
Definition: class.ilWebDAVUtil.php:334

ilAuthUtils\LOCAL_PWV_USER
const LOCAL_PWV_USER
Definition: class.ilAuthUtils.php:72

$ilUser
$ilUser
Definition: imgupload.php:18

$https
$https
Definition: imgupload.php:19

ilWebDAVUtil\$clientBrowser
static $clientBrowser
Definition: class.ilWebDAVUtil.php:14

ilWebDAVUtil\$clientFlavor
static $clientFlavor
Definition: class.ilWebDAVUtil.php:16

$query
$query
Definition: proxy_ylocal.php:13

$baseUri
$baseUri
Definition: addressbookserver.php:16

ilWebDAVUtil\getFolderURI
static getFolderURI($refId, $nodeId=0, $ressourceName=null, $parentRefId=null)
TODO: Check if needed and refactor Returns an URI for mounting the repository object as a webfolder u...
Definition: class.ilWebDAVUtil.php:372

echo

exit
exit
Definition: backend.php:16

ilWebDAVUtil\getInstance
static getInstance()
Get singleton instance.
Definition: class.ilWebDAVUtil.php:600

ilWebDAVUtil\_isActionsVisible
static _isActionsVisible()
Static getter.
Definition: class.ilWebDAVUtil.php:23

$ilSetting
global $ilSetting
Definition: privfeed.php:17

ilWebDAVUtil\isWebDAVoverHTTPS
isWebDAVoverHTTPS()
TODO: Check if needed and refactor Returns true, if the WebDAV server transfers data over HTTPS...
Definition: class.ilWebDAVUtil.php:530

$login
$login
Definition: cron.php:13

php

ilWebDAVUtil\getFileURI
getFileURI($refId, $ressourceName=null, $parentRefId=null)
TODO: Check if needed and refactor Returns an URI for getting a file object using WebDAV...
Definition: class.ilWebDAVUtil.php:498

ilWebDAVUtil\getObject
getObject($davPath)
TODO: Check if needed and refactor Gets a DAV object for the specified path.
Definition: class.ilWebDAVUtil.php:214

ilWebDAVUtil\_isActive
static _isActive()
TODO: Check if needed and refactor Static getter.
Definition: class.ilWebDAVUtil.php:551

ilWebDAVUtil\showMountInstructions
showMountInstructions(&$objDAV, &$options)
TODO: Check if needed and refactor Mount instructions method handler for directories.
Definition: class.ilWebDAVUtil.php:36

ilWebDAVUtil\$pwd_instruction
$pwd_instruction
Definition: class.ilWebDAVUtil.php:586