1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
|
<?php
namespace Files\Backend\Webdav;
require_once __DIR__ . "/sabredav/FilesWebDavClient.php";
require_once __DIR__ . "/../class.abstract_backend.php";
require_once __DIR__ . "/../class.exception.php";
use Files\Backend\AbstractBackend;
use Files\Backend\iFeatureQuota;
use Files\Backend\iFeatureStreaming;
use Files\Backend\iFeatureVersionInfo;
use Files\Backend\Webdav\sabredav\FilesWebDavClient;
use Files\Backend\Exception as BackendException;
use \Sabre\DAV\Exception as Exception;
use \Sabre\HTTP\ClientException;
/**
* This is a file backend for webdav servers.
*
* @class Backend
* @extends AbstractBackend
*/
class Backend extends AbstractBackend implements iFeatureQuota, iFeatureVersionInfo
{
/**
* Error codes
* see @parseErrorCodeToMessage for description
*/
const WD_ERR_UNAUTHORIZED = 401;
const WD_ERR_FORBIDDEN = 403;
const WD_ERR_NOTFOUND = 404;
const WD_ERR_NOTALLOWED = 405;
const WD_ERR_TIMEOUT = 408;
const WD_ERR_LOCKED = 423;
const WD_ERR_FAILED_DEPENDENCY = 423;
const WD_ERR_INTERNAL = 500;
const WD_ERR_UNREACHABLE = 800;
const WD_ERR_TMP = 801;
const WD_ERR_FEATURES = 802;
const WD_ERR_NO_CURL = 803;
/**
* Configuration data for the extjs metaform.
*/
protected $formConfig;
protected $formFields;
protected $metaConfig;
/**
* @var boolean debuggin flag, if true, debugging is enabled
*/
var $debug = false;
/**
* @var int webdav server port
*/
var $port = 80;
/**
* @var string hostname or ip
*/
var $server = "localhost";
/**
* @var string global path prefix for all requests
*/
var $path = "/webdav.php";
/**
* @var boolean if true, ssl is used
*/
var $ssl = false;
/**
* @var boolean allow self signed certificates
*/
var $allowselfsigned = true;
/**
* @var string the username
*/
var $user = "";
/**
* @var string the password
*/
var $pass = "";
/**
* @var FilesWebDavClient the SabreDAV client object.
*/
var $sabre_client;
/**
* @constructor
*/
function __construct()
{
// initialization
$this->debug = PLUGIN_FILESBROWSER_LOGLEVEL === "DEBUG" ? true : false;
$this->init_form();
// set backend description
$this->backendDescription = dgettext('plugin_files', "With this backend, you can connect to any webdav server (e.g. Owncloud).");
// set backend display name
$this->backendDisplayName = "Webdav";
// set backend version
// TODO: this should be changed on every release
$this->backendVersion = "1.0";
}
/**
* Initialise form fields
*/
private function init_form()
{
$this->formConfig = array(
"labelAlign" => "left",
"columnCount" => 1,
"labelWidth" => 80,
"defaults" => array(
"width" => 292
)
);
$this->formFields = array(
array(
"name" => "server_address",
"fieldLabel" => dgettext('plugin_files', 'Server address'),
"editor" => array(
"allowBlank" => false
)
),
array(
"name" => "server_port",
"fieldLabel" => dgettext('plugin_files', 'Server port'),
"editor" => array(
"ref" => "../../portField",
"allowBlank" => false
)
),
array(
"name" => "server_ssl",
"fieldLabel" => dgettext('plugin_files', 'Use SSL'),
"editor" => array(
"xtype" => "checkbox",
"listeners" => array(
"check" => "Zarafa.plugins.files.data.Actions.onCheckSSL" // this javascript function will be called!
)
)
),
array(
"name" => "server_path",
"fieldLabel" => dgettext('plugin_files', 'Webdav base path'),
"editor" => array(
)
),
array(
"name" => "user",
"fieldLabel" => dgettext('plugin_files', 'Username'),
"editor" => array(
"ref" => "../../usernameField"
)
),
array(
"name" => "password",
"fieldLabel" => dgettext('plugin_files', 'Password'),
"editor" => array(
"ref" => "../../passwordField",
"inputType" => "password"
)
),
array(
"name" => "use_zarafa_credentials",
"fieldLabel" => dgettext('plugin_files', 'Use Kopano credentials'),
"editor" => array(
"xtype" => "checkbox",
"listeners" => array(
"check" => "Zarafa.plugins.files.data.Actions.onCheckCredentials" // this javascript function will be called!
)
)
),
);
$this->metaConfig = array(
"success" => true,
"metaData" => array(
"fields" => $this->formFields,
"formConfig" => $this->formConfig
),
"data" => array( // here we can specify the default values.
"server_address" => "files.demo.com",
"server_port" => "80",
"server_path" => "/remote.php/webdav"
)
);
}
/**
* Initialize backend from $backend_config array
* @param $backend_config
*/
public function init_backend($backend_config)
{
$this->set_server($backend_config["server_address"]);
$this->set_port($backend_config["server_port"]);
$this->set_base($backend_config["server_path"]);
$this->set_ssl($backend_config["server_ssl"]);
// set user and password
if ($backend_config["use_zarafa_credentials"] === FALSE) {
$this->set_user($backend_config["user"]);
$this->set_pass($backend_config["password"]);
} else {
// For backward compatibility we will check if the Encryption store exists. If not,
// we will fall back to the old way of retrieving the password from the session.
if ( class_exists('EncryptionStore') ) {
// Get the username and password from the Encryption store
$encryptionStore = \EncryptionStore::getInstance();
$this->set_user($encryptionStore->get('username'));
$this->set_pass($encryptionStore->get('password'));
} else {
$this->set_user($GLOBALS['mapisession']->getUserName());
$password = $_SESSION['password'];
if(function_exists('openssl_decrypt')) {
// In PHP 5.3.3 the iv parameter was added
if(version_compare(phpversion(), "5.3.3", "<")) {
$this->set_pass(openssl_decrypt($password, "des-ede3-cbc", PASSWORD_KEY, 0));
} else {
$this->set_pass(openssl_decrypt($password, "des-ede3-cbc", PASSWORD_KEY, 0, PASSWORD_IV));
}
}
}
}
}
/**
* Set webdav server. FQN or IP address.
*
* @param string $server hostname or ip of the ftp server
*
* @return void
*/
public function set_server($server)
{
$this->server = $server;
}
/**
* Set base path
*
* @param string $pp the global path prefix
*
* @return void
*/
public function set_base($pp)
{
$this->path = $pp;
$this->log('Base path set to ' . $this->path);
}
/**
* Set ssl
*
* @param int /bool $ssl (1 = true, 0 = false)
*
* @return void
*/
public function set_ssl($ssl)
{
$this->ssl = $ssl ? true : false;
$this->log('SSL extension was set to ' . $this->ssl);
}
/**
* Allow self signed certificates - unimplemented
*
* @param bool $allowselfsigned Allow self signed certificates. Not yet implemented.
*
* @return void
*/
public function set_selfsigned($allowselfsigned)
{
$this->allowselfsigned = $allowselfsigned;
}
/**
* Set tcp port of webdav server. Default is 80.
*
* @param int $port the port of the ftp server
*
* @return void
*/
public function set_port($port)
{
$this->port = $port;
}
/**
* set user name for authentication
*
* @param string $user username
*
* @return void
*/
public function set_user($user)
{
$this->user = $user;
}
/**
* Set password for authentication
*
* @param string $pass password
*
* @return void
*/
public function set_pass($pass)
{
$this->pass = $pass;
}
/**
* set debug on (1) or off (0).
* produces a lot of debug messages in webservers error log if set to on (1).
*
* @param boolean $debug enable or disable debugging
*
* @return void
*/
public function set_debug($debug)
{
$this->debug = $debug;
}
/**
* Opens the connection to the webdav server.
*
* @throws BackendException if connection is not successful
* @return boolean true if action succeeded
*/
public function open()
{
// check if curl is available
$serverHasCurl = function_exists('curl_version');
if (!$serverHasCurl) {
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_NO_CURL), 500);
}
$davsettings = array(
'baseUri' => $this->webdavUrl(),
'userName' => $this->user,
'password' => $this->pass,
'authType' => \Sabre\DAV\Client::AUTH_BASIC,
);
try {
$this->sabre_client = new FilesWebDavClient($davsettings);
$this->sabre_client->addCurlSetting(CURLOPT_SSL_VERIFYPEER, !$this->allowselfsigned);
return true;
} catch (Exception $e) {
$this->log('Failed to open: ' . $e->getMessage());
if (intval($e->getHTTPCode()) == 401) {
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_UNAUTHORIZED), $e->getHTTPCode());
} else {
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_UNREACHABLE), $e->getHTTPCode());
}
}
}
/**
* show content of a directory
*
* @param string $path directory path
* @param boolean $hidefirst Optional parameter to hide the root entry. Default true
*
* @throws BackendException if request is not successful
*
* @return mixed array with directory content
*/
public function ls($dir, $hidefirst = true)
{
$time_start = microtime(true);
$dir = $this->removeSlash($dir);
$lsdata = array();
$this->log("[LS] start for dir: $dir");
try {
$response = $this->sabre_client->propFind($dir, array(
'{DAV:}resourcetype',
'{DAV:}getcontentlength',
'{DAV:}getlastmodified',
'{DAV:}getcontenttype',
'{DAV:}quota-used-bytes',
'{DAV:}quota-available-bytes',
), 1);
$this->log("[LS] backend fetched in: " . (microtime(true) - $time_start) . " seconds.");
foreach ($response as $name => $fields) {
if ($hidefirst) {
$hidefirst = false; // skip the first line - its the requested dir itself
continue;
}
$name = substr($name, strlen($this->path)); // skip the webdav path
$name = urldecode($name);
$type = $fields["{DAV:}resourcetype"]->resourceType;
if (is_array($type) && !empty($type)) {
$type = $type[0] == "{DAV:}collection" ? "collection" : "file";
} else {
$type = "file"; // fall back to file if detection fails... less harmful
}
$lsdata[$name] = array(
"resourcetype" => $type,
"getcontentlength" => isset($fields["{DAV:}getcontentlength"]) ? $fields["{DAV:}getcontentlength"] : null,
"getlastmodified" => isset($fields["{DAV:}getlastmodified"]) ? $fields["{DAV:}getlastmodified"] : null,
"getcontenttype" => isset($fields["{DAV:}getcontenttype"]) ? $fields["{DAV:}getcontenttype"] : null,
"quota-used-bytes" => isset($fields["{DAV:}quota-used-bytes"]) ? $fields["{DAV:}quota-used-bytes"] : null,
"quota-available-bytes" => isset($fields["{DAV:}quota-available-bytes"]) ? $fields["{DAV:}quota-available-bytes"] : null,
);
}
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[LS] done in $time seconds");
return $lsdata;
} catch (ClientException $e) {
$this->log('ls sabre error: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('ls fatal: ' . $e->getMessage() . " [" . $e->getHTTPCode() . "]");
// THIS IS A FIX FOR OWNCLOUD - It does return 500 instead of 401...
$err_code = $e->getHTTPCode();
// check if code is 500 - then we should try to parse the error message
if($err_code === 500) {
// message example: HTTP-Code: 401
$regx = '/[0-9]{3}/';
if(preg_match($regx, $e->getMessage(), $found)) {
$err_code = $found[0];
}
}
throw new BackendException($this->parseErrorCodeToMessage($err_code), $err_code);
}
}
/**
* create a new directory
*
* @param string $dir directory path
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function mkcol($dir)
{
$time_start = microtime(true);
$dir = $this->removeSlash($dir);
$this->log("[MKCOL] start for dir: $dir");
try {
$response = $this->sabre_client->request("MKCOL", $dir, null);
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[MKCOL] done in $time seconds: " . $response['statusCode']);
return true;
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('[MKCOL] fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* delete a file or directory
*
* @param string $path file/directory path
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function delete($path)
{
$time_start = microtime(true);
$path = $this->removeSlash($path);
$this->log("[DELETE] start for dir: $path");
try {
$response = $this->sabre_client->request("DELETE", $path, null);
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[DELETE] done in $time seconds: " . $response['statusCode']);
return true;
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('delete fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* Move a file or collection on webdav server (serverside)
* If you set param overwrite as true, the target will be overwritten.
*
* @param string $src_path Source path
* @param string $dest_path Destination path
* @param boolean $overwrite Overwrite file if exists in $dest_path
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function move($src_path, $dst_path, $overwrite = false)
{
$time_start = microtime(true);
$src_path = $this->removeSlash($src_path);
$dst_path = $this->webdavUrl() . $this->removeSlash($dst_path);
$this->log("[MOVE] start for dir: $src_path -> $dst_path");
if ($overwrite) {
$overwrite = 'T';
} else {
$overwrite = 'F';
}
try {
$response = $this->sabre_client->request("MOVE", $src_path, null, array("Destination" => $dst_path, 'Overwrite' => $overwrite));
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[MOVE] done in $time seconds: " . $response['statusCode']);
return true;
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('move fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* Puts a file into a collection.
*
* @param string $path Destination path
*
* @string mixed $data Any kind of data
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function put($path, $data)
{
$time_start = microtime(true);
$path = $this->removeSlash($path);
$this->log("[PUT] start for dir: $path strlen: " . strlen($data));
try {
$response = $this->sabre_client->request("PUT", $path, $data);
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[PUT] done in $time seconds: " . $response['statusCode']);
return true;
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('[PUT] put fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* Upload a local file
*
* @param string $path Destination path on the server
* @param string $filename Local filename for the file that should be uploaded
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function put_file($path, $filename)
{
$buffer = file_get_contents($filename);
if ($buffer !== false) {
return $this->put($path, $buffer);
} else {
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_TMP), self::WD_ERR_TMP);
}
}
/**
* Gets a file from a webdav collection.
*
* @param string $path The source path on the server
* @param mixed $buffer Buffer for the received data
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function get($path, &$buffer)
{
$tmpfile = tempnam(TMP_PATH, stripslashes(base64_encode($path)));
$this->log("[GET] buffer path: $tmpfile");
$this->get_file($path, $tmpfile);
$buffer = file_get_contents($tmpfile);
unlink($tmpfile);
}
/**
* Gets a file from a collection into local filesystem.
*
* @param string $srcpath Source path on server
* @param string $localpath Destination path on local filesystem
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function get_file($srcpath, $localpath)
{
$time_start = microtime(true);
$path = $this->removeSlash($srcpath);
$this->log("[GET_FILE] start for dir: $path");
$this->log("[GET_FILE] local path (" . $localpath . ") writeable: " . is_writable($localpath));
try {
$response = $this->sabre_client->getFile($path, $localpath);
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[GET_FILE] done in $time seconds: " . $response['statusCode']);
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('[GET_FILE] fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* Public method copy_file
*
* Copy a file on webdav server
* Duplicates a file on the webdav server (serverside).
* All work is done on the webdav server. If you set param overwrite as true,
* the target will be overwritten.
*
* @param string $src_path Source path
* @param string $dest_path Destination path
* @param bool $overwrite Overwrite if file exists in $dst_path
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function copy_file($src_path, $dst_path, $overwrite = false)
{
return $this->copy($src_path, $dst_path, $overwrite, false);
}
/**
* Public method copy_coll
*
* Copy a collection on webdav server
* Duplicates a collection on the webdav server (serverside).
* All work is done on the webdav server. If you set param overwrite as true,
* the target will be overwritten.
*
* @param string $src_path Source path
* @param string $dest_path Destination path
* @param bool $overwrite Overwrite if collection exists in $dst_path
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
public function copy_coll($src_path, $dst_path, $overwrite = false)
{
return $this->copy($src_path, $dst_path, $overwrite, true);
}
/**
* Get's path information from webdav server for one element
*
* @param string $path Path to file or folder
*
* @throws BackendException if request is not successful
*
* @return array directory info
*/
public function gpi($path)
{
$path = $this->removeSlash($path);
$response = $this->sabre_client->propFind($path, array(
'{DAV:}resourcetype',
'{DAV:}getcontentlength',
'{DAV:}getlastmodified',
'{DAV:}getcontenttype',
'{DAV:}quota-used-bytes',
'{DAV:}quota-available-bytes',
));
$type = $response["{DAV:}resourcetype"]->resourceType;
if (is_array($type) && !empty($type)) {
$type = $type[0] == "{DAV:}collection" ? "collection" : "file";
} else {
$type = "file"; // fall back to file if detection fails... less harmful
}
$gpi = array(
"resourcetype" => $type,
"getcontentlength" => isset($response["{DAV:}getcontentlength"]) ? $response["{DAV:}getcontentlength"] : null,
"getlastmodified" => isset($response["{DAV:}getlastmodified"]) ? $response["{DAV:}getlastmodified"] : null,
"getcontenttype" => isset($response["{DAV:}getcontenttype"]) ? $response["{DAV:}getcontenttype"] : null,
"quota-used-bytes" => isset($response["{DAV:}quota-used-bytes"]) ? $response["{DAV:}quota-used-bytes"] : null,
"quota-available-bytes" => isset($response["{DAV:}quota-available-bytes"]) ? $response["{DAV:}quota-available-bytes"] : null,
);
return $gpi;
}
/**
* Get's server information
*
* @throws BackendException if request is not successful
* @return array with all header fields returned from webdav server.
*/
public function options()
{
$features = $this->sabre_client->options();
// be sure it is an array
if (is_array($features)) {
return $features;
}
$this->log('options: error getting server features');
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_FEATURES), self::WD_ERR_FEATURES);
}
/**
* Gather whether a path points to a file or not
*
* @param string $path Path to file or folder
*
* @return boolean true if path points to a file, false otherwise
*/
public function is_file($path)
{
$item = $this->gpi($path);
return $item === false ? false : ($item['resourcetype'] != 'collection');
}
/**
* Gather whether a path points to a directory
*
* @param string $path Path to file or folder
*
* @return boolean true if path points to a directory, false otherwise
*/
public function is_dir($path)
{
$item = $this->gpi($path);
return $item === false ? false : ($item['resourcetype'] == 'collection');
}
/**
* check if file/directory exists
*
* @param string $path Path to file or folder
*
* @return boolean true if path exists, false otherwise
*/
public function exists($path)
{
return ($this->is_dir($path) || $this->is_file($path));
}
/**
* Copy a collection on webdav server
* Duplicates a collection on the webdav server (serverside).
* All work is done on the webdav server. If you set param overwrite as true,
* the target will be overwritten.
*
* @access private
*
* @param string $src_path Source path
* @param string $dest_path Destination path
* @param bool $overwrite Overwrite if collection exists in $dst_path
* @param bool $coll Set this to true if you want to copy a folder.
*
* @throws BackendException if request is not successful
*
* @return boolean true if action succeeded
*/
private function copy($src_path, $dst_path, $overwrite, $coll)
{
$time_start = microtime(true);
$src_path = $this->removeSlash($src_path);
$dst_path = $this->webdavUrl() . $this->removeSlash($dst_path);
$this->log("[COPY] start for dir: $src_path -> $dst_path");
if ($overwrite) {
$overwrite = 'T';
} else {
$overwrite = 'F';
}
array("Destination" => $dst_path, 'Overwrite' => $overwrite);
if ($coll) {
$settings = array("Destination" => $dst_path, 'Depth' => 'Infinity');
}
try {
$response = $this->sabre_client->request("COPY", $src_path, null, $settings);
$time_end = microtime(true);
$time = $time_end - $time_start;
$this->log("[COPY] done in $time seconds: " . $response['statusCode']);
return true;
} catch (ClientException $e) {
throw new BackendException($this->parseErrorCodeToMessage($e->getCode()), $e->getCode());
} catch (Exception $e) {
$this->log('[COPY] fatal: ' . $e->getMessage());
throw new BackendException($this->parseErrorCodeToMessage($e->getHTTPCode()), $e->getHTTPCode());
}
}
/**
* Create the base webdav url
*
* @access protected
* @return string baseURL
*/
protected function webdavUrl()
{
if ($this->ssl) {
$url = "https://";
} else {
$url = "http://";
}
// make sure that we do not have any trailing / in our url
$server = rtrim($this->server, '/');
$path = rtrim($this->path, '/');
$url .= $server . ":" . $this->port . $path . "/";
return $url;
}
/**
* Removes the leading slash from the folder path
*
* @access private
*
* @param string $dir directory path
*
* @return string trimmed directory path
*/
function removeSlash($dir)
{
if (strpos($dir, '/') === 0) {
$dir = substr($dir, 1);
}
// remove all html entities and urlencode the path...
$nohtml = html_entity_decode($dir);
$dir = implode("/", array_map("rawurlencode", explode("/", $nohtml)));
return $dir;
}
/**
* This function will return a user friendly error string.
*
* @param number $error_code A error code
*
* @return string userfriendly error message
*/
private function parseErrorCodeToMessage($error_code)
{
$error = intval($error_code);
$msg = dgettext('plugin_files', 'Unknown error');
switch ($error) {
case CURLE_BAD_PASSWORD_ENTERED:
case self::WD_ERR_UNAUTHORIZED:
$msg = dgettext('plugin_files', 'Unauthorized. Wrong username or password.');
break;
case CURLE_SSL_CONNECT_ERROR:
case CURLE_COULDNT_RESOLVE_HOST:
case CURLE_COULDNT_CONNECT:
case CURLE_OPERATION_TIMEOUTED:
case self::WD_ERR_UNREACHABLE:
$msg = dgettext('plugin_files', 'File-server is not reachable. Wrong IP entered?');
break;
case self::WD_ERR_NOTALLOWED:
$msg = dgettext('plugin_files', 'File-server is not reachable. Incorrect URL?');
break;
case self::WD_ERR_FORBIDDEN:
$msg = dgettext('plugin_files', 'You don\'t have enough permissions for this operation.');
break;
case self::WD_ERR_NOTFOUND:
$msg = dgettext('plugin_files', 'File is not available any more.');
break;
case self::WD_ERR_TIMEOUT:
$msg = dgettext('plugin_files', 'Connection to server timed out. Retry later.');
break;
case self::WD_ERR_LOCKED:
$msg = dgettext('plugin_files', 'This file is locked by another user.');
break;
case self::WD_ERR_FAILED_DEPENDENCY:
$msg = dgettext('plugin_files', 'The request failed due to failure of a previous request.');
break;
case self::WD_ERR_INTERNAL:
$msg = dgettext('plugin_files', 'File-server encountered a problem. Wrong IP entered?');
break; // this comes most likely from a wrong ip
case self::WD_ERR_TMP:
$msg = dgettext('plugin_files', 'Could not write to temporary directory. Contact the server administrator.');
break;
case self::WD_ERR_FEATURES:
$msg = dgettext('plugin_files', 'Could not retrieve list of server features. Contact the server administrator.');
break;
case self::WD_ERR_NO_CURL:
$msg = dgettext('plugin_files', 'PHP-Curl is not available. Contact your system administrator.');
break;
}
return $msg;
}
public function getFormConfig()
{
$json = json_encode($this->metaConfig);
if ($json === FALSE) {
error_log(json_last_error());
}
return $json;
}
public function getFormConfigWithData()
{
return json_encode($this->metaConfig);
}
/**
* a simple php error_log wrapper.
*
* @access private
*
* @param string $err_string error message
*
* @return void
*/
private function log($err_string)
{
if ($this->debug) {
error_log("[BACKEND_WEBDAV]: " . $err_string);
}
}
/**
* ============================ FEATURE FUNCTIONS ========================
*/
/**
* Returns the bytes that are currently used.
*
* @param string $dir directory to check
*
* @return int bytes that are used or -1 on error
*/
public function getQuotaBytesUsed($dir)
{
$lsdata = $this->ls($dir, false);
if (isset($lsdata) && is_array($lsdata)) {
return $lsdata[$dir]["quota-used-bytes"];
} else {
return -1;
}
}
/**
* Returns the bytes that are currently available.
*
* @param string $dir directory to check
*
* @return int bytes that are available or -1 on error
*/
public function getQuotaBytesAvailable($dir)
{
$lsdata = $this->ls($dir, false);
if (isset($lsdata) && is_array($lsdata)) {
return $lsdata[$dir]["quota-available-bytes"];
} else {
return -1;
}
}
/**
* Return the version string of the server backend.
* @return String
* @throws BackendException
*/
public function getServerVersion()
{
// check if curl is available
$serverHasCurl = function_exists('curl_version');
if (!$serverHasCurl) {
throw new BackendException($this->parseErrorCodeToMessage(self::WD_ERR_NO_CURL), 500);
}
$webdavurl = $this->webdavUrl();
$url = substr($webdavurl, 0, strlen($webdavurl) - strlen("remote.php/webdav/")) . "status.php";
// try to get the contents of the owncloud status page
$ch = curl_init();
curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
curl_setopt($ch, CURLOPT_TIMEOUT, 3); // timeout of 3 seconds
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
if ($this->allowselfsigned) {
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
}
$versiondata = curl_exec($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpcode && $httpcode == "200" && $versiondata) {
$versions = json_decode($versiondata);
$version = $versions->versionstring;
} else {
$version = "Undetected (no Owncloud?)";
}
return $version;
}
}
|