diff --git a/lib/drivers/seafile/seafile_api.php b/lib/drivers/seafile/seafile_api.php index 3ee3fff..d4a50e7 100644 --- a/lib/drivers/seafile/seafile_api.php +++ b/lib/drivers/seafile/seafile_api.php @@ -1,1406 +1,1383 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ /** * Class implementing access via SeaFile Web API v2 */ class seafile_api { const STATUS_OK = 200; const CREATED = 201; const ACCEPTED = 202; const MOVED_PERMANENTLY = 301; const BAD_REQUEST = 400; const FORBIDDEN = 403; const NOT_FOUND = 404; const CONFLICT = 409; const TOO_MANY_REQUESTS = 429; const REPO_PASSWD_REQUIRED = 440; const REPO_PASSWD_MAGIC_REQUIRED = 441; const INTERNAL_SERVER_ERROR = 500; const OPERATION_FAILED = 520; const CONNECTION_ERROR = 550; private $status = null; /** * Specifies how long max. we'll wait and renew throttled request (in seconds) */ const WAIT_LIMIT = 30; /** * Configuration * * @var array */ protected $config = array(); /** - * HTTP request handle + * HTTP client * - * @var HTTP_Request + * @var GuzzleHttp\Client */ - protected $request; + protected $client = null; /** * Web API URI prefix * * @var string */ protected $url; /** * Session token * * @var string */ protected $token; /** * API URL prefix (schema and host[:port]) * * @var string */ protected $url_prefix; public function __construct($config = array()) { $this->config = $config; $this->token = $config['token']; // set Web API URI $this->url = rtrim(trim($config['host']), '/') ?: 'localhost'; if (!preg_match('|^https?://|i', $this->url)) { $this->url = 'https://' . $this->url; } if (!preg_match('|/api2$|', $this->url)) { $this->url .= '/api2/'; } $this->url_prefix = preg_replace('|^(https?://[^/]+).*$|i', '\\1', $this->url); } - /** - * - * @param array Configuration for this Request instance, that will be merged - * with default configuration - * - * @return HTTP_Request2 Request object - */ - public static function http_request($config = array()) - { - // remove unknown config, otherwise HTTP_Request will throw an error - $config = array_intersect_key($config, array_flip(array( - 'connect_timeout', 'timeout', 'use_brackets', 'protocol_version', - 'buffer_size', 'store_body', 'follow_redirects', 'max_redirects', - 'strict_redirects', 'ssl_verify_peer', 'ssl_verify_host', - 'ssl_cafile', 'ssl_capath', 'ssl_local_cert', 'ssl_passphrase' - ))); - - // force CURL adapter, this allows to handle correctly - // compressed responses with simple SplObserver registered - $config['adapter'] = 'HTTP_Request2_Adapter_Curl'; - - try { - $request = new HTTP_Request2(); - $request->setConfig($config); - } - catch (Exception $e) { - rcube::raise_error($e, true, false); - return; - } - - return $request; - } - /** * Send HTTP request * * @param string $method Request method ('OPTIONS','GET','HEAD','POST','PUT','DELETE','TRACE','CONNECT') * @param string $url Request API URL * @param array $get GET parameters * @param array $post POST parameters * @param array $upload Uploaded files data * @param string $version API version (to replace "api2" with "api/v$version" in the URL * * @return string|array Server response */ protected function request($method, $url, $get = null, $post = null, $upload = null, $version = null) { if (!preg_match('/^https?:\/\//', $url)) { $url = $this->url . $url; // Note: It didn't work for me without the last backslash $url = rtrim($url, '/') . '/'; } else { $url = $this->mod_url($url); } if ($version && $version != 2) { $url = str_replace('/api2/', "/api/v$version/", $url); } - if (!$this->request) { - $this->config['store_body'] = true; - // some methods respond with 301 redirect, we'll not follow them - // also because of https://github.com/haiwen/seahub/issues/288 - $this->config['follow_redirects'] = false; - - $this->request = self::http_request($this->config); - - if (!$this->request) { - $this->status = self::CONNECTION_ERROR; - return; - } - } - - // cleanup - try { - $this->request->setBody(''); - $this->request->setUrl($url); - } - catch (Exception $e) { - rcube::raise_error($e, true, false); - $this->status = self::CONNECTION_ERROR; - return; + if (!$this->client) { + $this->client = new \GuzzleHttp\Client( + [ + 'http_errors' => true, + 'verify' => false, + 'connect_timeout' => 10, + 'timeout' => 300, + ] + ); } if ($this->config['debug']) { $log_line = "SeaFile $method: $url"; $json_opt = PHP_VERSION_ID >= 50400 ? JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE : 0; if (!empty($get)) { $log_line .= ", GET: " . @json_encode($get, $json_opt); } if (!empty($post)) { $log_line .= ", POST: " . preg_replace('/("password":)[^\},]+/', '\\1"*"', @json_encode($post, $json_opt)); } if (!empty($upload)) { $log_line .= ", Files: " . @json_encode(array_keys($upload), $json_opt); } rcube::write_log('console', $log_line); } - $this->request->setMethod($method ?: HTTP_Request2::METHOD_GET); - - if (!empty($get)) { - $_url = $this->request->getUrl(); - $_url->setQueryVariables($get); - $this->request->setUrl($_url); - } + // send request to the SeaFile API server + try { + $headers = [ + 'Accept' => "application/json,text/javascript,*/*", + 'User-Agent' => $_SERVER['HTTP_USER_AGENT'] + ]; - // HTTP_Request2 does not support POST params on PUT requests - if (!empty($post) && $method == 'PUT') { - $body = http_build_query($post, '', '&'); - $body = str_replace('%7E', '~', $body); // support RFC 3986 by not encoding '~' symbol - $post = null; + if ($this->token) { + $headers['Authorization'] = "Token " . $this->token; + } - $this->request->setBody($body); - $this->request->setHeader('content-type', 'application/x-www-form-urlencoded'); - } + $options = []; - if (!empty($post)) { - $this->request->addPostParameter($post); - } - if (!empty($upload)) { - foreach ($upload as $field_name => $file) { - $this->request->addUpload($field_name, $file['data'], $file['name'], $file['type']); + if (!empty($get)) { + $options['query'] = $get; } - } - - if ($this->token) { - $this->request->setHeader('Authorization', "Token " . $this->token); - } - // some HTTP server configurations require this header - $this->request->setHeader('Accept', "application/json,text/javascript,*/*"); + if (!empty($upload)) { + if (!empty($post['target_file'])) { + $filename = basename($post['target_file']); + } else { + $filename = $upload['file']['name']; + } + $multipart = [ + [ + 'headers' => ['Content-Type' => 'application/octet-stream'], + 'name' => 'file', + 'filename' => $filename, + 'contents' => $upload['file']['data'] + ], + [ + 'name' => 'name', + 'contents' => $upload['file']['name'], + ], + [ + 'name' => 'type', + 'contents' => $upload['file']['type'], + ], + ]; + + if (array_key_exists('parent_dir', $post)) { + $multipart[] = [ + 'name' => 'parent_dir', + 'contents' => $post['parent_dir'] + ]; + } + if (array_key_exists('target_file', $post)) { + $multipart[] = [ + 'name' => 'target_file', + 'contents' => $post['target_file'] + ]; + } + $options['multipart'] = $multipart; + } else { + if (!empty($post)) { + $options['form_params'] = $post; + } + } - // proxy User-Agent string - $this->request->setHeader('User-Agent', $_SERVER['HTTP_USER_AGENT']); + if (!empty($headers)) { + $options['headers'] = $headers; + } + $response = $this->client->request($method ?: "GET", $url, $options); - // send request to the SeaFile API server - try { - $response = $this->request->send(); - $this->status = $response->getStatus(); - $body = $response->getBody(); + $this->status = $response->getStatusCode(); + $body = $response->getBody(); } catch (Exception $e) { rcube::raise_error($e, true, false); $this->status = self::CONNECTION_ERROR; } if ($this->config['debug']) { rcube::write_log('console', "SeaFile Response [$this->status]: " . trim($body)); } // request throttled, try again if ($this->status == self::TOO_MANY_REQUESTS) { if (preg_match('/([0-9]+) second/', $body, $m) && ($seconds = $m[1]) < self::WAIT_LIMIT) { sleep($seconds); return $this->request($method, $url, $get, $post, $upload); } } if ($this->status < 400) { $body = @json_decode($body, true); } // Sometimes we can get an error with response code 200 if ($this->status == 200 && ($method == 'PUT' || $method == 'POST') && !empty($body) && is_array($body) && !empty($body['failed']) && empty($body['success']) ) { // Note: $body['failed'] is an array where each element is an array with 'error_msg' item // TODO: Support partial success/error result $this->status = 520; } // decode response return $this->status >= 400 ? false : $body; } /** * Return error code of last operation */ public function is_error() { return $this->status >= 400 ? $this->status : false; } /** * Authenticate to SeaFile API and get auth token * * @param string $username User name (email) * @param string $password User password * * @return string|null Authentication token */ public function authenticate($username, $password) { // sanity checks if ($username === '' || !is_string($username) || $password === '' || !is_string($password)) { $this->status = self::BAD_REQUEST; return false; } $result = $this->request('POST', 'auth-token', null, array( 'username' => $username, 'password' => $password, )); if ($result['token']) { return $this->token = $result['token']; } } /** * Get account information * * @return array Account info (usage, total, email) */ public function account_info() { return $this->request('GET', "account/info"); } /** * Delete a directory * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool True on success, False on failure */ public function directory_delete($repo_id, $dir) { // sanity checks if ($dir === '' || $dir === '/' || !is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } $this->request('DELETE', "repos/$repo_id/dir", array('p' => $dir)); return $this->is_error() === false; } /** * Rename a directory * * @param string $repo_id Library identifier * @param string $src_dir Directory name (with path) * @param string $dest_dir New directory name (with path) * * @return bool True on success, False on failure */ public function directory_rename($repo_id, $src_dir, $dest_dir) { // sanity checks if ($src_dir === '' || $src_dir === '/' || !is_string($src_dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dest_dir === '' || $dest_dir === '/' || !is_string($dest_dir) || $dest_dir === $src_dir) { $this->status = self::BAD_REQUEST; return false; } $result = $this->request('POST', "repos/$repo_id/dir", array('p' => $src_dir), array( 'operation' => 'rename', 'newname' => $dest_dir, )); return $this->is_error() === false; } /** * Rename a directory * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool True on success, False on failure */ public function directory_create($repo_id, $dir) { // sanity checks if ($dir === '' || $dir === '/' || !is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } $result = $this->request('POST', "repos/$repo_id/dir", array('p' => $dir), array( 'operation' => 'mkdir', )); return $this->is_error() === false; } /** * List directory entries (files and directories) * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $type Entry type ('dir' or 'file') (requires Seafile 4.4.1) * @param bool $recursive Enable recursive call for 'dir' listing (requires Seafile 4.4.1) * * @return bool|array List of directories/files on success, False on failure */ public function directory_entries($repo_id, $dir, $type = null, $recursive = false) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } // args: p=<$name> ('/' is a root, default), oid=? // sample result // [{ // "id": "0000000000000000000000000000000000000000", // "type": "file", // "name": "test1.c", // "size": 0 // },{ // "id": "e4fe14c8cda2206bb9606907cf4fca6b30221cf9", // "type": "dir", // "name": "test_dir" // }] $params = array('p' => $dir); if ($type) { $params['t'] = $type == 'dir' ? 'd' : 'f'; } if ($recursive && $type == 'dir') { $params['recursive'] = 1; } return $this->request('GET', "repos/$repo_id/dir", $params); } /** * Get directory information. * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool|array Directory properties on success, False on failure */ public function directory_info($repo_id, $dir) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } $params = array('path' => $dir); return $this->request('GET', "repos/$repo_id/dir/detail", $params, null, null, '2.1'); } /** * Update a file * * @param string $repo_id Library identifier * @param string $filename File name (with path) * @param array $file File data (data, type, name) * * @return bool True on success, False on failure */ public function file_update($repo_id, $filename, $file) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } // first get the update link $result = $this->request('GET', "repos/$repo_id/update-link"); if ($this->is_error() || empty($result)) { return false; } $path = explode('/', $filename); $fn = array_pop($path); // then update file $result = $this->request('POST', $result, null, array( 'filename' => $fn, 'target_file' => $filename, ), array('file' => $file) ); return $this->is_error() === false; } /** * Upload a file * * @param string $repo_id Library identifier * @param string $filename File name (with path) * @param array $file File data (data, type, name) * * @return bool True on success, False on failure */ public function file_upload($repo_id, $filename, $file) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } // first get upload link $parent_dir = '/'; $result = $this->request('GET', "repos/$repo_id/upload-link/?p=$parent_dir"); if ($this->is_error() || empty($result)) { return false; } $path = explode('/', $filename); $filename = array_pop($path); $dir = ltrim(implode('/', $path), '/'); $file['name'] = $filename; // then update file $result = $this->request('POST', $result, null, array( 'parent_dir' => $parent_dir, 'relative_path' => $dir ), array('file' => $file) ); return $this->is_error() === false; } /** * Delete a file * * @param string $repo_id Library identifier * @param string $filename File name (with path) * * @return bool True on success, False on failure */ public function file_delete($repo_id, $filename) { // sanity check if ($filename === '' || $filename === '/' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } $this->request('DELETE', "repos/$repo_id/file", array('p' => $filename)); return $this->is_error() === false; } /** * Copy file(s) (no rename here) * * @param string $repo_id Library identifier * @param string|array $files List of files (without path) * @param string $src_dir Source directory * @param string $dest_dir Destination directory * @param string $dest_repo Destination library (optional) * * @return bool True on success, False on failure */ public function file_copy($repo_id, $files, $src_dir, $dest_dir, $dest_repo) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($src_dir === '' || !is_string($src_dir)) { $this->status = self::BAD_REQUEST; return false; } if ($dest_dir === '' || !is_string($dest_dir)) { $this->status = self::BAD_REQUEST; return false; } if ((!is_array($files) && !strlen($files)) || (is_array($files) && empty($files))) { $this->status = self::BAD_REQUEST; return false; } if (empty($dest_repo)) { $dest_repo = $repo_id; } $result = $this->request('POST', "repos/$repo_id/fileops/copy", array('p' => $src_dir), array( 'file_names' => implode(':', (array) $files), 'dst_dir' => $dest_dir, 'dst_repo' => $dest_repo, )); return $this->is_error() === false; } /** * Move a file (no rename here) * * @param string $repo_id Library identifier * @param string $filename File name (with path) * @param string $dst_dir Destination directory * @param string $dst_repo Destination library (optional) * * @return bool True on success, False on failure */ public function file_move($repo_id, $filename, $dst_dir, $dst_repo = null) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($filename === '' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } if ($dst_dir === '' || !is_string($dst_dir)) { $this->status = self::BAD_REQUEST; return false; } if (empty($dst_repo)) { $dst_repo = $repo_id; } $result = $this->request('POST', "repos/$repo_id/file", array('p' => $filename), array( 'operation' => 'move', 'dst_dir' => $dst_dir, 'dst_repo' => $dst_repo, )); return $this->is_error() === false; } /** * Rename a file * * @param string $repo_id Library identifier * @param string $filename File name (with path) * @param string $new_name New file name (without path) * * @return bool True on success, False on failure */ public function file_rename($repo_id, $filename, $new_name) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($filename === '' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } if ($new_name === '' || !is_string($new_name)) { $this->status = self::BAD_REQUEST; return false; } $result = $this->request('POST', "repos/$repo_id/file", array('p' => $filename), array( 'operation' => 'rename', 'newname' => $new_name, )); return $this->is_error() === false; } /** * Create an empty file * * @param string $repo_id Library identifier * @param string $filename File name (with path) * * @return bool True on success, False on failure */ public function file_create($repo_id, $filename) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($filename === '' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } $result = $this->request('POST', "repos/$repo_id/file", array('p' => $filename), array( 'operation' => 'create', )); return $this->is_error() === false; } /** * Get file info * * @param string $repo_id Library identifier * @param string $filename File name (with path) * * @return bool|array File info on success, False on failure */ public function file_info($repo_id, $filename) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($filename === '' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } // sample result: // "id": "013d3d38fed38b3e8e26b21bb3463eab6831194f", // "mtime": 1398148877, // "type": "file", // "name": "foo.py", // "size": 22 return $this->request('GET', "repos/$repo_id/file/detail", array('p' => $filename)); } /** * Get file content * * @param string $repo_id Library identifier * @param string $filename File name (with path) * * @return bool|string File download URI on success, False on failure */ public function file_get($repo_id, $filename) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($filename === '' || !is_string($filename)) { $this->status = self::BAD_REQUEST; return false; } return $this->request('GET', "repos/$repo_id/file", array('p' => $filename)); } /** * List libraries (repositories) * * @return array|bool List of libraries on success, False on failure */ public function library_list() { $result = $this->request('GET', "repos"); // sample result // [{ // "permission": "rw", // "encrypted": false, // "mtime": 1400054900, // "owner": "user@mail.com", // "id": "f158d1dd-cc19-412c-b143-2ac83f352290", // "size": 0, // "name": "foo", // "type": "repo", // "virtual": false, // "desc": "new library", // "root": "0000000000000000000000000000000000000000" // }] return $result; } /** * Get library info * * @param string $repo_id Library identifier * * @return array|bool Library info on success, False on failure */ public function library_info($repo_id) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } return $this->request('GET', "repos/$repo_id"); } /** * Create library * * @param string $name Library name * @param string $description Library description * * @return bool|array Library info on success, False on failure */ public function library_create($name, $description = '') { if ($name === '' || !is_string($name)) { $this->status = self::BAD_REQUEST; return false; } return $this->request('POST', "repos", null, array( 'name' => $name, 'desc' => $description, )); } /** * Rename library * * @param string $repo_id Library identifier * @param string $new_name Library description * * @return bool True on success, False on failure */ public function library_rename($repo_id, $name, $description = '') { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($name === '' || !is_string($name)) { $this->status = self::BAD_REQUEST; return false; } // Note: probably by mistake the 'op' is a GET parameter // maybe changed in future to be consistent with other methods $this->request('POST', "repos/$repo_id", array('op' => 'rename'), array( 'repo_name' => $name, 'repo_desc' => $description, )); return $this->is_error() === false; } /** * Delete library * * @param string $repo_id Library identifier * * @return bool True on success, False on failure */ public function library_delete($repo_id) { if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } $this->request('DELETE', "repos/$repo_id"); return $this->is_error() === false; } /** * Ping the API server * * @param string $token If set, auth token will be used * * @param bool True on success, False on failure */ public function ping($token = null) { // can be used to check if token is still valid if ($token) { $this->token = $token; $result = $this->request('GET', 'auth/ping', null, null); } // or if api works else { $result = $this->request('GET', 'ping', null, null); } return $this->is_error() === false; } /** * Share a directory (or library) * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $right Permission ('r' or 'rw' or 'admin') * @param string $mode Mode ('user' or 'group') * @param string $who Username or Group ID * @param bool $update Update an existing entry * * @return bool True on success, False on failure */ public function shared_item_add($repo_id, $dir, $right, $mode, $who, $update = false) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($mode != 'user' && $mode != 'group') { $this->status = self::BAD_REQUEST; return false; } if ($right != 'r' && $right != 'rw' && $right != 'admin') { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } $post = array( 'permission' => $right, 'share_type' => $mode, ); $post[$mode == 'group' ? 'group_id' : 'username'] = $who; $this->request($update ? 'POST' : 'PUT', "repos/$repo_id/dir/shared_items", array('p' => $dir), $post); return $this->is_error() === false; } /** * Update shared item permissions * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $right Permission ('r' or 'rw' or 'admin') * @param string $mode Mode ('user' or 'group') * @param string $who Username or Group ID * * @return bool True on success, False on failure */ public function shared_item_update($repo_id, $dir, $right, $mode, $who) { return $this->shared_item_add($repo_id, $dir, $right, $mode, $who, true); } /** * Un-Share a directory (or library) * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $mode Mode ('user' or 'group') * @param string $who Username or Group ID * * @return bool True on success, False on failure */ public function shared_item_delete($repo_id, $dir, $mode, $who) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($mode != 'user' && $mode != 'group') { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } $get = array( 'share_type' => $mode, 'p' => $dir ); $get[$mode == 'group' ? 'group_id' : 'username'] = $who; $this->request('DELETE', "repos/$repo_id/dir/shared_items", $get); return $this->is_error() === false; } /** * List directory permissions (shares) * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool|array List of user/group info on success, False on failure */ public function shared_item_list($repo_id, $dir) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } // Example result: // [ // { // "group_info": { "id": 17, "name": "Group Name" }, // "is_admin": false, // "share_type": "group", // "permission": "rw" // }, // { // "user_info": { "nickname": "user", "name": "user@domain.com" }, // "share_type": "user", // "permission": "r" // } // ] return $this->request('GET', "repos/$repo_id/dir/shared_items", array('p' => $dir)); } /** * List share (download) links * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool|array List of shared links on success, False on failure */ public function share_link_list($repo_id, $dir) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } // Example result: // [ // { // "username": "lian@lian.com", // "repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf", // "ctime": "2017-04-01T02:35:29+00:00", // "expire_date": "", // "token": "0c4eb0cb104a43caaeef", // "view_cnt": 0, // "link": "https://cloud.seafile.com/d/0c4eb0cb104a43caaeef/", // "obj_name": "folder", // "path": "/folder/", // "is_dir": true, // "is_expired": false, // "repo_name": "for-test-web-api" // } // ] return $this->request('GET', "share-links", array('repo_id' => $repo_id, 'path' => $dir), null, null, '2.1'); } /** * Create a shared (download) link * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $password Password * @param string $expire Days to expire * * @return bool Link info on success, False on failure */ public function share_link_add($repo_id, $dir, $password = '', $expire = 0) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if (!empty($expire) && !is_numeric($expire)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } $post = array( 'repo_id' => $repo_id, 'path' => $dir, ); if (strlen($password)) { $post['password'] = $password; } if ($expire > 0) { $post['expire_days'] = $expire; } $result = $this->request('POST', "share-links", array(), $post, null, '2.1'); // Sample response: // { // "token": "0c4eb0cb104a43caaeef", // "link": "https://cloud.seafile.com/d/db1a50e686/", // ... // } if (is_array($result) && !empty($result['link'])) { return $result; } return false; } /** * Delete a share (download) link * * @param string $token Link identifier (token) * * @return bool True on success, False on failure */ public function share_link_delete($token) { // sanity checks if ($token === '' || !is_string($token)) { $this->status = self::BAD_REQUEST; return false; } $this->request('DELETE', "share-links/{$token}", null, null, null, '2.1'); return $this->is_error() === false; } /** * List upload links * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * * @return bool|array List of upload links on success, False on failure */ public function upload_link_list($repo_id, $dir) { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } // Example result: // [ // { // "username": "lian@lian.com", // "repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf", // "ctime": "2017-04-01T02:35:29+00:00", // "expire_date": "", // "token": "0c4eb0cb104a43caaeef", // "view_cnt": 0, // "link": "https://cloud.seafile.com/d/0c4eb0cb104a43caaeef/", // "obj_name": "folder", // "path": "/folder/", // "is_dir": true, // "is_expired": false, // "repo_name": "for-test-web-api" // } // ] return $this->request('GET', "upload-links", array('repo_id' => $repo_id, 'path' => $dir), null, null, '2.1'); } /** * Create an upload link * * @param string $repo_id Library identifier * @param string $dir Directory name (with path) * @param string $password Password * * @return bool Link info on success, False on failure */ public function upload_link_add($repo_id, $dir, $password = '') { // sanity checks if (!is_string($dir)) { $this->status = self::BAD_REQUEST; return false; } if ($repo_id === '' || !is_string($repo_id)) { $this->status = self::BAD_REQUEST; return false; } if ($dir === '') { $dir = '/'; } $post = array( 'repo_id' => $repo_id, 'path' => $dir, ); if (strlen($password)) { $post['password'] = $password; } $result = $this->request('POST', "upload-links", array(), $post, null, '2.1'); // Sample response: // { // "token": "0c4eb0cb104a43caaeef", // "link": "https://cloud.seafile.com/d/db1a50e686/", // ... // } if (is_array($result) && !empty($result['link'])) { return $result; } return false; } /** * Delete an upload link * * @param string $token Link identifier (token) * * @return bool True on success, False on failure */ public function upload_link_delete($token) { // sanity checks if ($token === '' || !is_string($token)) { $this->status = self::BAD_REQUEST; return false; } $this->request('DELETE', "upload-links/{$token}", null, null, null, '2.1'); return $this->is_error() === false; } /** * List user groups * * @return bool|array List of groups on success, False on failure */ public function group_list() { // Sample result: // [ // { // "ctime": 1398134171327948, // "creator": "user@example.com", // "msgnum": 0, // "mtime": 1398231100, // "id": 1, // "name": "lian" // } // ] }, $result = $this->request('GET', "groups"); if (is_array($result)) { $result = (array) $result['groups']; } return $result; } /** * List users * * @param string $search Search keyword * * @return bool|array List of users on success, False on failure */ public function user_search($search = null) { // Sample response: // [ // { // 'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png', // 'contact_email': 'foo@foo.com', // 'email': 'foo@foo.com', // 'name': 'foo' // } // ] $result = $this->request('GET', "search-user", array('q' => $search)); if (is_array($result)) { $result = (array) $result['users']; } return $result; } /** * Parse and fix API request URLs */ public function mod_url($url) { // If Seafile is behind a proxy and different port, it will return // wrong URL for file uploads/downloads. We force the original URL prefix here if (stripos($url, $this->url_prefix) !== 0) { $url = $this->url_prefix . preg_replace('|^(https?://[^/]+)|i', '', $url); } return $url; } } diff --git a/lib/drivers/seafile/seafile_file_storage.php b/lib/drivers/seafile/seafile_file_storage.php index 6044e42..5e2752d 100644 --- a/lib/drivers/seafile/seafile_file_storage.php +++ b/lib/drivers/seafile/seafile_file_storage.php @@ -1,1703 +1,1711 @@ | +--------------------------------------------------------------------------+ | Author: Aleksander Machniak | +--------------------------------------------------------------------------+ */ class seafile_file_storage implements file_storage { /** * @var rcube */ protected $rc; /** * @var array */ protected $config = array(); /** * @var seafile_api */ protected $api; /** * List of SeaFile libraries * * @var array */ protected $libraries; /** * Instance title (mount point) * * @var string */ protected $title; /** * Class constructor */ public function __construct() { $this->rc = rcube::get_instance(); } /** * Authenticates a user * * @param string $username User name * @param string $password User password * * @param bool True on success, False on failure */ public function authenticate($username, $password) { $this->init(true); $token = $this->api->authenticate($username, $password); if ($token) { $_SESSION[$this->title . 'seafile_user'] = $username; $_SESSION[$this->title . 'seafile_token'] = $this->rc->encrypt($token); $_SESSION[$this->title . 'seafile_pass'] = $this->rc->encrypt($password); return true; } $this->api = false; return false; } /** * Get password and name of authenticated user * * @return array Authenticated user data */ public function auth_info() { return array( 'username' => $_SESSION[$this->title . 'seafile_user'], 'password' => $this->rc->decrypt($_SESSION[$this->title . 'seafile_pass']), ); } /** * Initialize SeaFile Web API connection */ protected function init($skip_auth = false) { if ($this->api !== null) { return $this->api !== false; } // read configuration $config = array( 'host' => $this->rc->config->get('fileapi_seafile_host', 'localhost'), 'ssl_verify_peer' => $this->rc->config->get('fileapi_seafile_ssl_verify_peer', true), 'ssl_verify_host' => $this->rc->config->get('fileapi_seafile_ssl_verify_host', true), 'cache' => $this->rc->config->get('fileapi_seafile_cache'), 'cache_ttl' => $this->rc->config->get('fileapi_seafile_cache_ttl', '14d'), 'debug' => $this->rc->config->get('fileapi_seafile_debug', false), 'token' => $_SESSION[$this->title . 'seafile_token'] ? $this->rc->decrypt($_SESSION[$this->title . 'seafile_token']) : null, ); $this->config = array_merge($config, $this->config); // initialize Web API $this->api = new seafile_api($this->config); if ($skip_auth) { return true; } if ($this->config['cache']) { $cache = $this->rc->get_cache('seafile_' . $this->title, $this->config['cache'], $this->config['cache_ttl'], true); } // try session token if ($config['token']) { // With caching we know the last successful token use, so we can // skip ping call, which is a big win for case of parallel folders listing if ($cache) { $valid = ($ping = $cache->get('ping')) && $ping + 15 >= time(); } if (empty($valid)) { $valid = $this->api->ping($config['token']); if ($cache && $valid) { $cache->write('ping', time()); } } } if (!$valid) { // already authenticated in session if ($_SESSION[$this->title . 'seafile_user']) { $user = $_SESSION[$this->title . 'seafile_user']; $pass = $this->rc->decrypt($_SESSION[$this->title . 'seafile_pass']); } // try user/pass of the main driver else { $user = $this->config['username']; $pass = $this->config['password']; } if ($user) { $valid = $this->authenticate($user, $pass); if ($cache) { $cache->remove('ping'); } } } // throw special exception, so we can ask user for the credentials if (!$valid && empty($_SESSION[$this->title . 'seafile_user'])) { throw new Exception("User credentials not provided", file_storage::ERROR_NOAUTH); } else if (!$valid && !$this->api) { throw new Exception("SeaFile storage unavailable", file_storage::ERROR); } else if (!$valid && $this->api->is_error() == seafile_api::TOO_MANY_REQUESTS) { throw new Exception("SeaFile storage temporarily unavailable (too many requests)", file_storage::ERROR); } return $valid; } /** * Configures environment * * @param array $config Configuration * @param string $title Source identifier */ public function configure($config, $title = null) { $this->config = array_merge($this->config, $config); $this->title = $title; } /** * Returns current instance title * * @return string Instance title (mount point) */ public function title() { return $this->title; } /** * Storage driver capabilities * * @return array List of capabilities */ public function capabilities() { // find max filesize value $max_filesize = parse_bytes(ini_get('upload_max_filesize')); $max_postsize = parse_bytes(ini_get('post_max_size')); if ($max_postsize && $max_postsize < $max_filesize) { $max_filesize = $max_postsize; } return array( file_storage::CAPS_MAX_UPLOAD => $max_filesize, file_storage::CAPS_QUOTA => true, file_storage::CAPS_LOCKS => true, file_storage::CAPS_ACL => true, ); } /** * Save configuration of external driver (mount point) * * @param array $driver Driver data * * @throws Exception */ public function driver_create($driver) { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Delete configuration of external driver (mount point) * * @param string $title Driver instance name * * @throws Exception */ public function driver_delete($title) { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Return list of registered drivers (mount points) * * @return array List of drivers data * @throws Exception */ public function driver_list() { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Update configuration of external driver (mount point) * * @param string $title Driver instance name * @param array $driver Driver data * * @throws Exception */ public function driver_update($title, $driver) { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Returns metadata of the driver * * @return array Driver meta data (image, name, form) */ public function driver_metadata() { $image_content = file_get_contents(__DIR__ . '/seafile.png'); $metadata = array( 'image' => 'data:image/png;base64,' . base64_encode($image_content), 'name' => 'SeaFile', 'ref' => 'http://seafile.com', 'description' => 'Storage implementing SeaFile API access', 'form' => array( 'host' => 'hostname', 'username' => 'username', 'password' => 'password', ), ); // these are returned when authentication on folders list fails if ($this->config['username']) { $metadata['form_values'] = array( 'host' => $this->config['host'], 'username' => $this->config['username'], ); } return $metadata; } /** * Validate metadata (config) of the driver * * @param array $metadata Driver metadata * * @return array Driver meta data to be stored in configuration * @throws Exception */ public function driver_validate($metadata) { if (!is_string($metadata['username']) || !strlen($metadata['username'])) { throw new Exception("Missing user name.", file_storage::ERROR); } if (!is_string($metadata['password']) || !strlen($metadata['password'])) { throw new Exception("Missing user password.", file_storage::ERROR); } if (!is_string($metadata['host']) || !strlen($metadata['host'])) { throw new Exception("Missing host name.", file_storage::ERROR); } $this->config['host'] = $metadata['host']; if (!$this->authenticate($metadata['username'], $metadata['password'])) { throw new Exception("Unable to authenticate user", file_storage::ERROR_NOAUTH); } return array( 'host' => $metadata['host'], 'username' => $metadata['username'], 'password' => $metadata['password'], ); } /** * Create a file. * * @param string $file_name Name of a file (with folder path) * @param array $file File data (path, type) * * @throws Exception */ public function file_create($file_name, $file) { list($fn, $repo_id) = $this->find_library($file_name); if (empty($repo_id)) { throw new Exception("Storage error. Folder not found.", file_storage::ERROR); } if ($file['path']) { $file['data'] = $file['path']; } else if (is_resource($file['content'])) { $file['data'] = $file['content']; } else { $fp = fopen('php://temp', 'wb'); fwrite($fp, $file['content'], strlen($file['content'])); $file['data'] = $fp; unset($file['content']); } $created = $this->api->file_upload($repo_id, $fn, $file); - if ($fp) { - fclose($fp); - } if (!$created) { rcube::raise_error(array( 'code' => 600, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Error saving file to SeaFile server"), true, false); throw new Exception("Storage error. Saving file failed.", file_storage::ERROR); } } /** * Update a file. * * @param string $file_name Name of a file (with folder path) * @param array $file File data (path, type) * * @throws Exception */ public function file_update($file_name, $file) { list($fn, $repo_id) = $this->find_library($file_name); if (empty($repo_id)) { throw new Exception("Storage error. Folder not found.", file_storage::ERROR); } if ($file['path']) { $file['data'] = $file['path']; } else if (is_resource($file['content'])) { $file['data'] = $file['content']; } else { $fp = fopen('php://temp', 'wb'); fwrite($fp, $file['content'], strlen($file['content'])); $file['data'] = $fp; unset($file['content']); } $saved = $this->api->file_update($repo_id, $fn, $file); - if ($fp) { - fclose($fp); - } if (!$saved) { rcube::raise_error(array( 'code' => 600, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Error saving file to SeaFile server"), true, false); throw new Exception("Storage error. Saving file failed.", file_storage::ERROR); } } /** * Delete a file. * * @param string $file_name Name of a file (with folder path) * * @throws Exception */ public function file_delete($file_name) { list($file_name, $repo_id) = $this->find_library($file_name); if ($repo_id && $file_name != '/') { $deleted = $this->api->file_delete($repo_id, $file_name); } if (!$deleted) { rcube::raise_error(array( 'code' => 600, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Error deleting object from SeaFile server"), true, false); throw new Exception("Storage error. Deleting file failed.", file_storage::ERROR); } } /** * Return file body. * * @param string $file_name Name of a file (with folder path) * @param array $params Parameters (force-download, force-type, head) * @param resource $fp Print to file pointer instead (send no headers) * * @throws Exception */ public function file_get($file_name, $params = array(), $fp = null) { list($fn, $repo_id) = $this->find_library($file_name); $file = $this->api->file_info($repo_id, $fn); if (empty($file)) { throw new Exception("Storage error. File not found.", file_storage::ERROR); } $file = $this->from_file_object($file); // get file location on SeaFile server for download if ($file['size'] && empty($params['head'])) { $link = $this->api->file_get($repo_id, $fn); } // write to file pointer, send no headers if ($fp) { if ($file['size']) { $this->save_file_content($link, $fp); } return; } if (!empty($params['force-download'])) { $disposition = 'attachment'; header("Content-Type: application/octet-stream"); // @TODO // if ($browser->ie) // header("Content-Type: application/force-download"); } else { $mimetype = file_utils::real_mimetype($params['force-type'] ? $params['force-type'] : $file['type']); $disposition = 'inline'; header("Content-Transfer-Encoding: binary"); header("Content-Type: $mimetype"); } $filename = addcslashes($file['name'], '"'); // Workaround for nasty IE bug (#1488844) // If Content-Disposition header contains string "attachment" e.g. in filename // IE handles data as attachment not inline /* @TODO if ($disposition == 'inline' && $browser->ie && $browser->ver < 9) { $filename = str_ireplace('attachment', 'attach', $filename); } */ header("Content-Length: " . $file['size']); header("Content-Disposition: $disposition; filename=\"$filename\""); // just send redirect to SeaFile server if ($file['size'] && empty($params['head'])) { $allow_redirects = $this->rc->config->get('fileapi_seafile_allow_redirects'); // In view-mode we can't redirect to SeaFile server because: // - it responds with Content-Disposition: attachment, which causes that // e.g. previewing images is not possible // - pdf/odf viewers can't follow redirects for some reason (#4590) if ($allow_redirects && !empty($params['force-download'])) { header("Location: $link"); } else if ($fp = fopen('php://output', 'wb')) { $this->save_file_content($link, $fp); - fclose($fp); } } } /** * Returns file metadata. * * @param string $file_name Name of a file (with folder path) * * @throws Exception */ public function file_info($file_name) { list($file, $repo_id) = $this->find_library($file_name); $file = $this->api->file_info($repo_id, $file); if (empty($file)) { throw new Exception("Storage error. File not found.", file_storage::ERROR); } $file = $this->from_file_object($file); return array( 'name' => $file['name'], 'size' => (int) $file['size'], 'type' => (string) $file['type'], 'mtime' => file_utils::date_format($file['changed'], $this->config['date_format'], $this->config['timezone']), 'ctime' => file_utils::date_format($file['created'], $this->config['date_format'], $this->config['timezone']), 'modified' => $file['changed'] ? $file['changed']->format('U') : 0, 'created' => $file['created'] ? $file['created']->format('U') : 0, ); } /** * List files in a folder. * * @param string $folder_name Name of a folder with full path * @param array $params List parameters ('sort', 'reverse', 'search', 'prefix') * * @return array List of files (file properties array indexed by filename) * @throws Exception */ public function file_list($folder_name, $params = array()) { // mount point contains only folders if (!is_string($folder_name) || $folder_name === '') { return array(); } list($folder, $repo_id) = $this->find_library($folder_name); // prepare search filter if (!empty($params['search'])) { foreach ($params['search'] as $idx => $value) { if ($idx == 'name') { $params['search'][$idx] = mb_strtoupper($value); } else if ($idx == 'class') { $params['search'][$idx] = file_utils::class2mimetypes($value); } } } // get directory entries $entries = $this->api->directory_entries($repo_id, $folder, 'file'); $result = array(); foreach ((array) $entries as $idx => $file) { if ($file['type'] != 'file') { continue; } $file = $this->from_file_object($file); // search filter if (!empty($params['search'])) { foreach ($params['search'] as $idx => $value) { if ($idx == 'name') { if (strpos(mb_strtoupper($file['name']), $value) === false) { continue 2; } } else if ($idx == 'class') { foreach ($value as $v) { if (stripos($file['type'], $v) !== false) { continue 2; } } continue 2; } } } $filename = $params['prefix'] . $folder_name . file_storage::SEPARATOR . $file['name']; $result[$filename] = array( 'name' => $file['name'], 'size' => (int) $file['size'], 'type' => (string) $file['type'], 'mtime' => file_utils::date_format($file['changed'], $this->config['date_format'], $this->config['timezone']), 'ctime' => file_utils::date_format($file['created'], $this->config['date_format'], $this->config['timezone']), 'modified' => $file['changed'] ? $file['changed']->format('U') : 0, 'created' => $file['created'] ? $file['created']->format('U') : 0, ); unset($entries[$idx]); } // @TODO: pagination, search (by filename, mimetype) // Sorting $sort = !empty($params['sort']) ? $params['sort'] : 'name'; $index = array(); if ($sort == 'mtime') { $sort = 'modified'; } if (in_array($sort, array('name', 'size', 'modified'))) { foreach ($result as $key => $val) { $index[$key] = $val[$sort]; } array_multisort($index, SORT_ASC, SORT_NUMERIC, $result); } if ($params['reverse']) { $result = array_reverse($result, true); } return $result; } /** * Copy a file. * * @param string $file_name Name of a file (with folder path) * @param string $new_name New name of a file (with folder path) * * @throws Exception */ public function file_copy($file_name, $new_name) { list($src_name, $repo_id) = $this->find_library($file_name); list($dst_name, $dst_repo_id) = $this->find_library($new_name); if ($repo_id && $dst_repo_id) { $path_src = explode('/', $src_name); $path_dst = explode('/', $dst_name); $f_src = array_pop($path_src); $f_dst = array_pop($path_dst); $src_dir = '/' . ltrim(implode('/', $path_src), '/'); $dst_dir = '/' . ltrim(implode('/', $path_dst), '/'); $success = $this->api->file_copy($repo_id, $f_src, $src_dir, $dst_dir, $dst_repo_id); // now rename the file if needed if ($success && $f_src != $f_dst) { $success = $this->api->file_rename($dst_repo_id, rtrim($dst_dir, '/') . '/' . $f_src, $f_dst); } } if (!$success) { rcube::raise_error(array( 'code' => 600, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Error copying file on SeaFile server"), true, false); throw new Exception("Storage error. File copying failed.", file_storage::ERROR); } } /** * Move (or rename) a file. * * @param string $file_name Name of a file (with folder path) * @param string $new_name New name of a file (with folder path) * * @throws Exception */ public function file_move($file_name, $new_name) { list($src_name, $repo_id) = $this->find_library($file_name); list($dst_name, $dst_repo_id) = $this->find_library($new_name); if ($repo_id && $dst_repo_id) { $path_src = explode('/', $src_name); $path_dst = explode('/', $dst_name); $f_src = array_pop($path_src); $f_dst = array_pop($path_dst); $src_dir = '/' . ltrim(implode('/', $path_src), '/'); $dst_dir = '/' . ltrim(implode('/', $path_dst), '/'); if ($src_dir == $dst_dir && $repo_id == $dst_repo_id) { $success = true; } else { $success = $this->api->file_move($repo_id, $src_name, $dst_dir, $dst_repo_id); } // now rename the file if needed if ($success && $f_src != $f_dst) { $success = $this->api->file_rename($dst_repo_id, rtrim($dst_dir, '/') . '/' . $f_src, $f_dst); } } if (!$success) { rcube::raise_error(array( 'code' => 600, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Error moving file on SeaFile server"), true, false); throw new Exception("Storage error. File rename failed.", file_storage::ERROR); } } /** * Create a folder. * * @param string $folder_name Name of a folder with full path * * @throws Exception on error */ public function folder_create($folder_name) { list($folder, $repo_id) = $this->find_library($folder_name, true); if (empty($repo_id)) { $success = $this->api->library_create($folder_name); } else if ($folder != '/') { $success = $this->api->directory_create($repo_id, $folder); } if (!$success) { throw new Exception("Storage error. Unable to create folder", file_storage::ERROR); } // clear the cache if (empty($repo_id)) { $this->libraries = null; } } /** * Delete a folder. * * @param string $folder_name Name of a folder with full path * * @throws Exception on error */ public function folder_delete($folder_name) { list($folder, $repo_id) = $this->find_library($folder_name, true); if ($repo_id && $folder == '/') { $success = $this->api->library_delete($repo_id); } else if ($repo_id) { $success = $this->api->directory_delete($repo_id, $folder); } if (!$success) { throw new Exception("Storage error. Unable to delete folder.", file_storage::ERROR); } } /** * Move/Rename a folder. * * @param string $folder_name Name of a folder with full path * @param string $new_name New name of a folder with full path * * @throws Exception on error */ public function folder_move($folder_name, $new_name) { list($folder, $repo_id, $library) = $this->find_library($folder_name, true); list($dest_folder, $dest_repo_id) = $this->find_library($new_name, true); // folders rename/move is possible only in the same library and folder // @TODO: support folder move between libraries and folders // @TODO: support converting library into a folder and vice-versa // library rename if ($repo_id && !$dest_repo_id && $folder == '/' && strpos($new_name, '/') === false) { $success = $this->api->library_rename($repo_id, $new_name, $library['desc']); } // folder rename else if ($folder != '/' && $dest_folder != '/' && $repo_id && $repo_id == $dest_repo_id) { $path_src = explode('/', $folder); $path_dst = explode('/', $dest_folder); $f_src = array_pop($path_src); $f_dst = array_pop($path_dst); $src_dir = implode('/', $path_src); $dst_dir = implode('/', $path_dst); if ($src_dir == $dst_dir) { $success = $this->api->directory_rename($repo_id, $folder, $f_dst); } } if (!$success) { throw new Exception("Storage error. Unable to rename/move folder", file_storage::ERROR); } } /** * Subscribe a folder. * * @param string $folder_name Name of a folder with full path * * @throws Exception */ public function folder_subscribe($folder_name) { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Unsubscribe a folder. * * @param string $folder_name Name of a folder with full path * * @throws Exception */ public function folder_unsubscribe($folder_name) { throw new Exception("Not implemented", file_storage::ERROR_UNSUPPORTED); } /** * Returns list of folders. * * @param array $params List parameters ('type', 'search', 'path', 'level') * * @return array List of folders * @throws Exception */ public function folder_list($params = array()) { $libraries = $this->libraries(); $writable = ($params['type'] & file_storage::FILTER_WRITABLE) ? true : false; $prefix = (string) $params['path']; $prefix_len = strlen($prefix); $folders = array(); if ($prefix_len) { $path = explode('/', $prefix); $lib_search = array_shift($path); $params['path'] = implode('/', $path); } foreach ($libraries as $library) { if ($library['virtual'] || $library['encrypted']) { continue; } if ($prefix_len && $lib_search !== $library['name']) { continue; } if (!strlen($params['path'])) { $folders[$library['name']] = array( 'mtime' => $library['mtime'], 'permission' => $library['permission'], ); } if ($params['level'] == 1 && !$prefix_len) { // Only list of libraries has been requested continue; } foreach ($this->folders_tree($library, $params) as $folder_name => $folder) { $folders[$library['name'] . '/' . $folder_name] = $folder; } } if (empty($libraries)) { throw new Exception("Storage error. Unable to get folders list.", file_storage::ERROR); } // remove read-only folders when requested if ($writable) { foreach ($folders as $folder_name => $folder) { if (strpos($folder['permission'], 'w') === false) { unset($folders[$folder_name]); } } } // In extended format we return array of arrays if (!empty($params['extended'])) { foreach ($folders as $folder_name => $folder) { $item = array('folder' => $folder_name); // check if folder is readonly if (!$writable && $params['permissions']) { if (strpos($folder['permission'], 'w') === false) { $item['readonly'] = true; } } $folders[$folder_name] = $item; } } else { $folders = array_keys($folders); } // sort folders usort($folders, array('file_utils', 'sort_folder_comparator')); return $folders; } /** * Check folder rights. * * @param string $folder_name Name of a folder with full path * * @return int Folder rights (sum of file_storage::ACL_*) */ public function folder_rights($folder_name) { // It is not possible (yet) to assign a specified library/folder // to the mount point. So, it is a "virtual" folder. if (!strlen($folder_name)) { return 0; } list($folder, $repo_id, $library) = $this->find_library($folder_name); // @TODO: we should check directory permission not library // However, there's no API for this, we'd need to get a list // of directories of a parent folder/library /* if (strpos($folder, '/')) { // @TODO } else { $acl = $library['permission']; } */ $acl = $library['permission']; $rights = 0; $map = array( 'r' => file_storage::ACL_READ, 'w' => file_storage::ACL_WRITE, ); foreach ($map as $key => $value) { if (strpos($acl, $key) !== false) { $rights |= $value; } } return $rights; } /** * Returns a list of locks * * This method should return all the locks for a particular URI, including * locks that might be set on a parent URI. * * If child_locks is set to true, this method should also look for * any locks in the subtree of the URI for locks. * * @param string $path File/folder path * @param bool $child_locks Enables subtree checks * * @return array List of locks * @throws Exception */ public function lock_list($path, $child_locks = false) { $this->init_lock_db(); // convert URI to global resource string $uri = $this->path2uri($path); // get locks list $list = $this->lock_db->lock_list($uri, $child_locks); // convert back resource string into URIs foreach ($list as $idx => $lock) { $list[$idx]['uri'] = $this->uri2path($lock['uri']); } return $list; } /** * Locks a URI * * @param string $path File/folder path * @param array $lock Lock data * - depth: 0/'infinite' * - scope: 'shared'/'exclusive' * - owner: string * - token: string * - timeout: int * * @throws Exception */ public function lock($path, $lock) { $this->init_lock_db(); // convert URI to global resource string $uri = $this->path2uri($path); if (!$this->lock_db->lock($uri, $lock)) { throw new Exception("Database error. Unable to create a lock.", file_storage::ERROR); } } /** * Removes a lock from a URI * * @param string $path File/folder path * @param array $lock Lock data * * @throws Exception */ public function unlock($path, $lock) { $this->init_lock_db(); // convert URI to global resource string $uri = $this->path2uri($path); if (!$this->lock_db->unlock($uri, $lock)) { throw new Exception("Database error. Unable to remove a lock.", file_storage::ERROR); } } /** * Return disk quota information for specified folder. * * @param string $folder_name Name of a folder with full path * * @return array Quota * @throws Exception */ public function quota($folder) { if (!$this->init()) { throw new Exception("Storage error. Unable to get SeaFile account info.", file_storage::ERROR); } $account_info = $this->api->account_info(); if (empty($account_info)) { throw new Exception("Storage error. Unable to get SeaFile account info.", file_storage::ERROR); } $quota = array( // expected values in kB 'total' => intval($account_info['total'] / 1024), 'used' => intval($account_info['usage'] / 1024), ); return $quota; } /** * Sharing interface * * @param string $folder_name Name of a folder with full path * @param int $mode Sharing action mode * @param array $args POST/GET parameters * * @return mixed Sharing response * @throws Exception */ public function sharing($folder, $mode, $args = array()) { if ($mode == file_storage::SHARING_MODE_FORM) { $form = array( 'shares' => array( 'title' => 'share.permissions', 'form' => array( 'user' => array( 'title' => 'share.usergroup', 'type' => 'input', 'autocomplete' => 'user,group', ), 'right' => array( 'title' => 'share.permission', 'type' => 'select', 'options' => array( 'r' => 'share.readonly', 'rw' => 'share.readwrite', ), ), ), 'extra_fields' => array( 'type' => 'user', 'id' => '', ), ), 'download-link' => array( 'title' => 'share.download-link', 'label' => 'share.generate', 'single' => true, 'list_column' => 'link', 'list_column_label' => 'share.link', 'form' => array( 'password' => array( 'title' => 'share.password', 'type' => 'password', ), 'expire' => array( 'title' => 'share.expire', 'placeholder' => 'share.expiredays', 'type' => 'input', ), ), 'extra_fields' => array( 'id' => '', ), ), 'upload-link' => array( 'title' => 'share.upload-link', 'label' => 'share.generate', 'single' => true, 'list_column' => 'link', 'list_column_label' => 'share.link', 'form' => array( 'password' => array( 'title' => 'share.password', 'type' => 'password', ), ), 'extra_fields' => array( 'id' => '', ), ), ); return $form; } if ($mode == file_storage::SHARING_MODE_RIGHTS) { if (!$this->init()) { throw new Exception("Storage error. Unable to get shares of SeaFile folder/lib.", file_storage::ERROR); } list($path, $repo_id) = $this->find_library($folder); $result = array(); if ($shares = $this->api->shared_item_list($repo_id, $path)) { foreach ($shares as $share) { if (!empty($share['group_info'])) { $name = $share['group_info']['name']; $name = $share['group_info']['id']; } else { $name = $this->user_label($share['user_info']['nickname'], $share['user_info']['name']); $id = $share['user_info']['name']; } $result[] = array( 'mode' => 'shares', 'type' => $share['share_type'], 'right' => $share['permission'], 'user' => $name, 'id' => $id, ); } } if ($links = $this->api->share_link_list($repo_id, $path)) { foreach ($links as $link) { $result[] = array( 'mode' => 'download-link', 'id' => $link['token'], 'link' => $link['link'], ); } } if ($links = $this->api->upload_link_list($repo_id, $path)) { foreach ($links as $link) { $result[] = array( 'mode' => 'upload-link', 'id' => $link['token'], 'link' => $link['link'], ); } } return $result; } if ($mode == file_storage::SHARING_MODE_UPDATE) { if (!$this->init()) { throw new Exception("Storage error. Unable to update shares of SeaFile folder/lib.", file_storage::ERROR); } list($path, $repo_id) = $this->find_library($folder); if ($args['mode'] == 'shares') { $share_id = $args['id'] ?: $args['user']; switch ($args['action']) { case 'submit': $result = $this->api->shared_item_add($repo_id, $path, $args['right'], $args['type'], $share_id); break; case 'update': $result = $this->api->shared_item_update($repo_id, $path, $args['right'], $args['type'], $share_id); break; case 'delete': $result = $this->api->shared_item_delete($repo_id, $path, $args['type'], $share_id); break; } } else if ($args['mode'] == 'download-link') { switch ($args['action']) { case 'submit': $result = $this->api->share_link_add($repo_id, $path, $args['password'], $args['expire']); if ($result) { $result['id'] = $result['token']; $result['mode'] = 'download-link'; } break; case 'delete': $result = $this->api->share_link_delete($args['id']); break; } } else if ($args['mode'] == 'upload-link') { switch ($args['action']) { case 'submit': $result = $this->api->upload_link_add($repo_id, $path, $args['password']); if ($result) { $result['id'] = $result['token']; $result['mode'] = 'upload-link'; } break; case 'delete': $result = $this->api->upload_link_delete($args['id']); break; } } else { throw new Exception("Invalid input.", file_storage::ERROR); } if (empty($result)) { throw new Exception("Storage error. Failed to update share.", file_storage::ERROR); } return $result; } } /** * User/group search (autocompletion) * * @param string $search Search string * @param int $mode Search mode * * @return array Users/Groups list * @throws Exception */ public function autocomplete($search, $mode) { if (!$this->init()) { throw new Exception("Storage error. Failed to init Seafile storage connection.", file_storage::ERROR); } $limit = (int) $this->rc->config->get('autocomplete_max', 15); $result = array(); $index = array(); if ($mode & file_storage::SEARCH_USER) { $users = $this->api->user_search($search); if (!is_array($users)) { throw new Exception("Storage error. Failed to search users.", file_storage::ERROR); } foreach ($users as $user) { $index[] = $user['name']; $result[] = array( 'name' => $this->user_label($user['name'], $user['email']), 'id' => $user['email'], 'type' => 'user', ); } } if (count($result) < $limit && ($mode & file_storage::SEARCH_GROUP)) { if ($groups = $this->api->group_list()) { $search = mb_strtoupper($search); foreach ($groups as $group) { if (strpos(mb_strtoupper($group['name']), $search) !== false) { $index[] = $group['name']; $result[] = array( 'name' => $group['name'], 'id' => $group['id'], 'type' => 'group', ); } } } } if (count($result)) { array_multisort($index, SORT_ASC, SORT_LOCALE_STRING, $result); } if (count($result) > $limit) { $result = array_slice($result, 0, $limit); } return $result; } /** * Convert file/folder path into a global URI. * * @param string $path File/folder path * * @return string URI * @throws Exception */ public function path2uri($path) { // Remove protocol prefix and path, we work with host only $host = preg_replace('#(^https?://|/.*$)#i', '', $this->config['host']); if (!is_string($path) || !strlen($path)) { $user = $_SESSION[$this->title . 'seafile_user']; return 'seafile://' . rawurlencode($user) . '@' . $host . '/'; } list($file, $repo_id, $library) = $this->find_library($path); return 'seafile://' . rawurlencode($library['owner']) . '@' . $host . '/' . file_utils::encode_path($path); } /** * Convert global URI into file/folder path. * * @param string $uri URI * * @return string File/folder path * @throws Exception */ public function uri2path($uri) { if (!preg_match('|^seafile://([^@]+)@([^/]+)/(.*)$|', $uri, $matches)) { throw new Exception("Internal storage error. Unexpected data format.", file_storage::ERROR); } $user = rawurldecode($matches[1]); $host = $matches[2]; $path = file_utils::decode_path($matches[3]); $c_host = preg_replace('#(^https?://|/.*$)#i', '', $this->config['host']); if (strlen($path)) { list($file, $repo_id, $library) = $this->find_library($path, true); if (empty($library) || $host != $c_host || $user != $library['owner']) { throw new Exception("Internal storage error. Unresolvable URI.", file_storage::ERROR); } } return $path; } /** * Get folders tree in the Seafile library */ protected function folders_tree($library, $params = array()) { $root = ''; if (is_string($params['path']) && strlen($params['path'])) { $root = trim($params['path'], '/'); } if ($this->config['cache'] && empty($params['recursive'])) { $cache = $this->rc->get_cache('seafile_' . $this->title, $this->config['cache'], $this->config['cache_ttl'], true); if ($cache) { $cache_key = 'folders.' . md5(sprintf('%s:%d:%s', $library['id'], $params['level'], $root)); $folders = $cache->get($cache_key); if (is_string($folders) && preg_match('/^([0-9]+):[\{\[]/', $folders, $m)) { $cache_mtime = $m[1]; $folders = json_decode(substr($folders, strlen($cache_mtime)+1), true); } else { $folders = null; } if (strlen($root)) { $info = $this->api->directory_info($library['id'], $root); if ($info && $info['mtime']) { try { $dt = new DateTime($info['mtime']); $mtime = $dt->format('U'); } catch (Exception $e) { // ignore rcube::raise_error($e, true, false); } } } else { $mtime = $library['mtime']; } if (is_array($folders) && $mtime && $cache_mtime && intval($mtime) === intval($cache_mtime)) { return $folders; } } } $folders = array(); $add_folder = function($item, &$result, $parent) { if ($item['type'] == 'dir' && strlen($item['name'])) { $name = (strlen($parent) > 0 ? "$parent/" : '') . $item['name']; $result[$name] = array( 'mtime' => $item['mtime'], 'permission' => $item['permission'], ); return $name; } }; // Full folder hierarchy requested, we can get all in one request... if (empty($params['recursive']) && empty($params['level'])) { if ($content = $this->api->directory_entries($library['id'], $root, 'dir', true)) { foreach ($content as $item) { $add_folder($item, $folders, trim($item['parent_dir'], '/')); } } } // Only part of the folder tree has been requested... else if ($content = $this->api->directory_entries($library['id'], $root, 'dir', false)) { $params['recursive'] = true; $params['level'] -= 1; // Recursively add sub-folders tree foreach ($content as $item) { $folder = $add_folder($item, $folders, $root); // FIXME: id="0000000000000000000000000000000000000000" means the folder is empty? if ($folder !== null && $params['level'] > 1 && $item['id'] !== "0000000000000000000000000000000000000000") { $params['path'] = $folder; $tree = $this->folders_tree($library, $params); if (!empty($tree)) { $folders = array_merge($folders, $tree); } } } } if ($cache_key && is_array($content) && $mtime && ($_folders = json_encode($folders))) { $cache->set($cache_key, intval($mtime) . ':' . $_folders); } return $folders; } /** * Get list of SeaFile libraries */ protected function libraries() { // get from memory if ($this->libraries !== null) { return $this->libraries; } if (!$this->init()) { throw new Exception("Storage error. Unable to get list of SeaFile libraries.", file_storage::ERROR); } if ($this->config['cache']) { $cache = $this->rc->get_cache('seafile_' . $this->title, $this->config['cache'], $this->config['cache_ttl'], true); if ($cache) { $repos = $cache->get('repos'); if (is_string($repos) && preg_match('/^([0-9]+):[\{\[]/', $repos, $m)) { $mtime = $m[1]; $repos = json_decode(substr($repos, strlen($mtime)+1), true); // We use the cached value for up to 15 seconds // It should be enough to improve parallel folders listing requests if (is_array($repos) && $mtime + 15 >= time()) { return $repos; } } } } $mtime = time(); if ($list = $this->api->library_list()) { $this->libraries = $list; if ($cache) { $cache->write('repos', $mtime . ':' . json_encode($list)); } } else { $this->libraries = array(); } return $this->libraries; } /** * Find library ID from folder name */ protected function find_library($folder_name, $no_exception = false) { $libraries = $this->libraries(); foreach ($libraries as $lib) { $path = $lib['name'] . '/'; if ($folder_name == $lib['name'] || strpos($folder_name, $path) === 0) { if (empty($library) || strlen($library['name']) < strlen($lib['name'])) { $library = $lib; } } } if (empty($library)) { if (!$no_exception) { throw new Exception("Storage error. Library not found.", file_storage::ERROR); } } else { $folder = substr($folder_name, strlen($library['name']) + 1); } return array( '/' . ($folder ? $folder : ''), $library['id'], $library ); } /** * Simplify internal structure of the file object */ protected function from_file_object($file) { if ($file['type'] != 'file') { return null; } // file modification time if ($file['mtime']) { try { $file['changed'] = new DateTime('@' . $file['mtime']); } catch (Exception $e) { } } // find file mimetype from extension $file['type'] = file_utils::ext_to_type($file['name']); unset($file['id']); unset($file['mtime']); return $file; } /** * Save remote file into file pointer */ protected function save_file_content($location, $fp) { if (!$fp || !$location) { return false; } $config = array_merge($this->config, array('store_bodies' => true)); - $request = seafile_api::http_request($config); - if (!$request) { + $config = array_intersect_key($config, array_flip(array( + 'connect_timeout', 'timeout', 'use_brackets', 'protocol_version', + 'buffer_size', 'store_body', 'follow_redirects', 'max_redirects', + 'strict_redirects', 'ssl_verify_peer', 'ssl_verify_host', + 'ssl_cafile', 'ssl_capath', 'ssl_local_cert', 'ssl_passphrase' + ))); + + // force CURL adapter, this allows to handle correctly + // compressed responses with simple SplObserver registered + $config['adapter'] = 'HTTP_Request2_Adapter_Curl'; + + try { + $request = new HTTP_Request2(); + $request->setConfig($config); + } + catch (Exception $e) { + rcube::raise_error($e, true, false); return false; } $observer = new seafile_request_observer(); $observer->set_fp($fp); try { $request->setUrl($this->api->mod_url($location)); $request->attach($observer); $response = $request->send(); $status = $response->getStatus(); $response->getBody(); // returns nothing $request->detach($observer); if ($status != 200) { throw new Exception("Unable to save file. Status $status."); } } catch (Exception $e) { rcube::raise_error($e, true, false); return false; } return true; } /** * Initializes file_locks object */ protected function init_lock_db() { if (!$this->lock_db) { $this->lock_db = new file_locks; } } /** * Create display-username-with-email string */ protected function user_label($name, $email) { if ($name && $name != $email) { $label = "{$name} ({$email})"; } else { $label = $email; } return $label; } }