芝麻web文件管理V1.00
编辑当前文件:/home/pulsehostuk9/public_html/invoicer.pulsehost.co.uk/vendor/spatie/dropbox-api/src/Client.php
|TokenProvider|null $accessTokenOrAppCredentials * @param int $maxChunkSize Set max chunk size per request (determines when to switch from "one shot upload" to upload session and defines chunk size for uploads via session). * @param int $maxUploadChunkRetries How many times to retry an upload session start or append after RequestException. * @param ?string $teamMemberId The team member ID to be specified for Dropbox business accounts */ public function __construct( string|array|TokenProvider|null $accessTokenOrAppCredentials = null, ClientInterface $client = null, int $maxChunkSize = self::MAX_CHUNK_SIZE, protected int $maxUploadChunkRetries = 0, protected ?string $teamMemberId = null, ) { if (is_array($accessTokenOrAppCredentials)) { [$this->appKey, $this->appSecret] = $accessTokenOrAppCredentials; } if ($accessTokenOrAppCredentials instanceof TokenProvider) { $this->tokenProvider = $accessTokenOrAppCredentials; } if (is_string($accessTokenOrAppCredentials)) { $this->tokenProvider = new InMemoryTokenProvider($accessTokenOrAppCredentials); } $this->client = $client ?? new GuzzleClient(['handler' => GuzzleFactory::handler()]); $this->maxChunkSize = ($maxChunkSize < self::MAX_CHUNK_SIZE ? max($maxChunkSize, 1) : self::MAX_CHUNK_SIZE); } /** * Copy a file or folder to a different location in the user's Dropbox. * * If the source path is a folder all its contents will be copied. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-copy_v2 */ public function copy(string $fromPath, string $toPath): array { $parameters = [ 'from_path' => $this->normalizePath($fromPath), 'to_path' => $this->normalizePath($toPath), ]; return $this->rpcEndpointRequest('files/copy_v2', $parameters); } /** * Create a folder at a given path. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder */ public function createFolder(string $path): array { $parameters = [ 'path' => $this->normalizePath($path), ]; $object = $this->rpcEndpointRequest('files/create_folder', $parameters); $object['.tag'] = 'folder'; return $object; } /** * Create a shared link with custom settings. * * If no settings are given then the default visibility is RequestedVisibility.public. * The resolved visibility, though, may depend on other aspects such as team and * shared folder settings). Only for paid users. * * @param array
$settings * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#sharing-create_shared_link_with_settings */ public function createSharedLinkWithSettings(string $path, array $settings = []): array { $parameters = [ 'path' => $this->normalizePath($path), ]; if (count($settings)) { $parameters = array_merge(compact('settings'), $parameters); } return $this->rpcEndpointRequest('sharing/create_shared_link_with_settings', $parameters); } /** * Search a file or folder in the user's Dropbox. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-search */ public function search(string $query, bool $includeHighlights = false): array { $parameters = [ 'query' => $query, 'include_highlights' => $includeHighlights, ]; return $this->rpcEndpointRequest('files/search_v2', $parameters); } /** * List shared links. * * For empty path returns a list of all shared links. For non-empty path * returns a list of all shared links with access to the given path. * * If direct_only is set true, only direct links to the path will be returned, otherwise * it may return link to the path itself and parent folders as described on docs. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links */ public function listSharedLinks(string $path = null, bool $direct_only = false, string $cursor = null): array { $parameters = [ 'path' => $path ? $this->normalizePath($path) : null, 'cursor' => $cursor, 'direct_only' => $direct_only, ]; $body = $this->rpcEndpointRequest('sharing/list_shared_links', $parameters); return $body['links']; } /** * Delete the file or folder at a given path. * * If the path is a folder, all its contents will be deleted too. * A successful response indicates that the file or folder was deleted. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-delete */ public function delete(string $path): array { $parameters = [ 'path' => $this->normalizePath($path), ]; return $this->rpcEndpointRequest('files/delete', $parameters); } /** * Download a file from a user's Dropbox. * * * @return resource * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-download */ public function download(string $path) { $arguments = [ 'path' => $this->normalizePath($path), ]; $response = $this->contentEndpointRequest('files/download', $arguments); return StreamWrapper::getResource($response->getBody()); } /** * Download a folder from the user's Dropbox, as a zip file. * The folder must be less than 20 GB in size and have fewer than 10,000 total files. * The input cannot be a single file. Any single file must be less than 4GB in size. * * * @return resource * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip */ public function downloadZip(string $path) { $arguments = [ 'path' => $this->normalizePath($path), ]; $response = $this->contentEndpointRequest('files/download_zip', $arguments); return StreamWrapper::getResource($response->getBody()); } /** * Returns the metadata for a file or folder. * * Note: Metadata for the root folder is unsupported. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata */ public function getMetadata(string $path): array { $parameters = [ 'path' => $this->normalizePath($path), ]; return $this->rpcEndpointRequest('files/get_metadata', $parameters); } /** * Get a temporary link to stream content of a file. * * This link will expire in four hours and afterwards you will get 410 Gone. * Content-Type of the link is determined automatically by the file's mime type. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link */ public function getTemporaryLink(string $path): string { $parameters = [ 'path' => $this->normalizePath($path), ]; $body = $this->rpcEndpointRequest('files/get_temporary_link', $parameters); return $body['link']; } /** * Get a thumbnail for an image. * * This method currently supports files with the following file extensions: * jpg, jpeg, png, tiff, tif, gif and bmp. * * Photos that are larger than 20MB in size won't be converted to a thumbnail. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail */ public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64'): string { $arguments = [ 'path' => $this->normalizePath($path), 'format' => $format, 'size' => $size, ]; $response = $this->contentEndpointRequest('files/get_thumbnail', $arguments); return (string) $response->getBody(); } /** * Starts returning the contents of a folder. * * If the result's ListFolderResult.has_more field is true, call * list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries. * * Note: auth.RateLimitError may be returned if multiple list_folder or list_folder/continue calls * with same parameters are made simultaneously by same API app for same user. If your app implements * retry logic, please hold off the retry until the previous request finishes. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder */ public function listFolder(string $path = '', bool $recursive = false): array { $parameters = [ 'path' => $this->normalizePath($path), 'recursive' => $recursive, ]; return $this->rpcEndpointRequest('files/list_folder', $parameters); } /** * Once a cursor has been retrieved from list_folder, use this to paginate through all files and * retrieve updates to the folder, following the same rules as documented for list_folder. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue */ public function listFolderContinue(string $cursor = ''): array { return $this->rpcEndpointRequest('files/list_folder/continue', compact('cursor')); } /** * Move a file or folder to a different location in the user's Dropbox. * * If the source path is a folder all its contents will be moved. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#files-move_v2 */ public function move(string $fromPath, string $toPath, bool $autorename = false): array { $parameters = [ 'from_path' => $this->normalizePath($fromPath), 'to_path' => $this->normalizePath($toPath), 'autorename' => $autorename, ]; return $this->rpcEndpointRequest('files/move_v2', $parameters); } /** * The file should be uploaded in chunks if its size exceeds the 150 MB threshold * or if the resource size could not be determined (eg. a popen() stream). * * @param string|resource $contents */ protected function shouldUploadChunked(mixed $contents): bool { $size = is_string($contents) ? strlen($contents) : fstat($contents)['size']; if ($this->isPipe($contents)) { return true; } return $size > $this->maxChunkSize; } /** * Check if the contents is a pipe stream (not seekable, no size defined). * * @param string|resource $contents */ protected function isPipe(mixed $contents): bool { return is_resource($contents) && (fstat($contents)['mode'] & 010000) != 0; } /** * Create a new file with the contents provided in the request. * * Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload * * @param string|resource $contents * @return array
*/ public function upload(string $path, mixed $contents, string $mode = 'add', bool $autorename = false): array { if ($this->shouldUploadChunked($contents)) { return $this->uploadChunked($path, $contents, $mode); } $arguments = [ 'path' => $this->normalizePath($path), 'mode' => $mode, 'autorename' => $autorename, ]; $response = $this->contentEndpointRequest('files/upload', $arguments, $contents); $metadata = json_decode($response->getBody(), true); $metadata['.tag'] = 'file'; return $metadata; } /** * Upload file split in chunks. This allows uploading large files, since * Dropbox API v2 limits the content size to 150MB. * * The chunk size will affect directly the memory usage, so be careful. * Large chunks tends to speed up the upload, while smaller optimizes memory usage. * * @param string|resource $contents * @return array
*/ public function uploadChunked(string $path, mixed $contents, string $mode = 'add', ?int $chunkSize = null): array { if ($chunkSize === null || $chunkSize > $this->maxChunkSize) { $chunkSize = $this->maxChunkSize; } $stream = $this->getStream($contents); $cursor = $this->uploadChunk(self::UPLOAD_SESSION_START, $stream, $chunkSize, null); while (! $stream->eof()) { $cursor = $this->uploadChunk(self::UPLOAD_SESSION_APPEND, $stream, $chunkSize, $cursor); } return $this->uploadSessionFinish('', $cursor, $path, $mode); } /** * @throws Exception */ protected function uploadChunk(int $type, StreamInterface &$stream, int $chunkSize, ?UploadSessionCursor $cursor = null): UploadSessionCursor { $maximumTries = $stream->isSeekable() ? $this->maxUploadChunkRetries : 0; $pos = $stream->tell(); $tries = 0; tryUpload: try { $tries++; $chunkStream = new Psr7\LimitStream($stream, $chunkSize, $stream->tell()); if ($type === self::UPLOAD_SESSION_START) { return $this->uploadSessionStart($chunkStream); } if ($type === self::UPLOAD_SESSION_APPEND && $cursor !== null) { return $this->uploadSessionAppend($chunkStream, $cursor); } throw new Exception('Invalid type'); } catch (RequestException $exception) { if ($tries < $maximumTries) { // rewind $stream->seek($pos, SEEK_SET); goto tryUpload; } throw $exception; } } /** * Upload sessions allow you to upload a single file in one or more requests, * for example where the size of the file is greater than 150 MB. * This call starts a new upload session with the given data. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-start * * @param string|resource|StreamInterface $contents */ public function uploadSessionStart(mixed $contents, bool $close = false): UploadSessionCursor { $arguments = compact('close'); $response = json_decode( $this->contentEndpointRequest('files/upload_session/start', $arguments, $contents)->getBody(), true ); return new UploadSessionCursor($response['session_id'], ($contents instanceof StreamInterface ? $contents->tell() : strlen($contents))); } /** * Append more data to an upload session. * When the parameter close is set, this call will close the session. * A single request should not upload more than 150 MB. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-append_v2 */ public function uploadSessionAppend(string|StreamInterface $contents, UploadSessionCursor $cursor, bool $close = false): UploadSessionCursor { $arguments = compact('cursor', 'close'); $pos = $contents instanceof StreamInterface ? $contents->tell() : 0; $this->contentEndpointRequest('files/upload_session/append_v2', $arguments, $contents); $cursor->offset += $contents instanceof StreamInterface ? ($contents->tell() - $pos) : strlen($contents); return $cursor; } /** * Finish an upload session and save the uploaded data to the given file path. * A single request should not upload more than 150 MB. * * @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload_session-finish * * @param string|resource|StreamInterface $contents * @return array
*/ public function uploadSessionFinish(mixed $contents, UploadSessionCursor $cursor, string $path, string $mode = 'add', bool $autorename = false, bool $mute = false): array { $arguments = compact('cursor'); $arguments['commit'] = compact('path', 'mode', 'autorename', 'mute'); $response = $this->contentEndpointRequest( 'files/upload_session/finish', $arguments, ($contents == '') ? null : $contents ); $metadata = json_decode($response->getBody(), true); $metadata['.tag'] = 'file'; return $metadata; } /** * Get Account Info for current authenticated user. * * @return array
* * @link https://www.dropbox.com/developers/documentation/http/documentation#users-get_current_account */ public function getAccountInfo(): array { return $this->rpcEndpointRequest('users/get_current_account'); } /** * Revoke current access token. * * @link https://www.dropbox.com/developers/documentation/http/documentation#auth-token-revoke */ public function revokeToken(): void { $this->rpcEndpointRequest('auth/token/revoke'); } protected function normalizePath(string $path): string { if (preg_match("/^id:.*|^rev:.*|^(ns:[0-9]+(\/.*)?)/", $path) === 1) { return $path; } $path = trim($path, '/'); return ($path === '') ? '' : '/'.$path; } protected function getEndpointUrl(string $subdomain, string $endpoint): string { if (count($parts = explode('::', $endpoint)) === 2) { [$subdomain, $endpoint] = $parts; } return "https://{$subdomain}.dropboxapi.com/2/{$endpoint}"; } /** * @param array
$arguments * @param string|resource|StreamInterface $body * * @throws \Exception */ public function contentEndpointRequest(string $endpoint, array $arguments, mixed $body = '', bool $isRefreshed = false): ResponseInterface { $headers = ['Dropbox-API-Arg' => json_encode($arguments)]; if ($body !== '') { $headers['Content-Type'] = 'application/octet-stream'; } try { $response = $this->client->request('POST', $this->getEndpointUrl('content', $endpoint), [ 'headers' => $this->getHeaders($headers), 'body' => $body, ]); } catch (ClientException $exception) { if ( $isRefreshed || ! $this->tokenProvider instanceof RefreshableTokenProvider || ! $this->tokenProvider->refresh($exception) ) { throw $this->determineException($exception); } $response = $this->contentEndpointRequest($endpoint, $arguments, $body, true); } return $response; } /** * @param array
>|null $parameters * @return array
*/ public function rpcEndpointRequest(string $endpoint, array $parameters = null, bool $isRefreshed = false): array { try { $options = ['headers' => $this->getHeaders()]; if ($parameters) { $options['json'] = $parameters; } $response = $this->client->request('POST', $this->getEndpointUrl('api', $endpoint), $options); } catch (ClientException $exception) { if ( $isRefreshed || ! $this->tokenProvider instanceof RefreshableTokenProvider || ! $this->tokenProvider->refresh($exception) ) { throw $this->determineException($exception); } return $this->rpcEndpointRequest($endpoint, $parameters, true); } return json_decode($response->getBody(), true) ?? []; } protected function determineException(ClientException $exception): Exception { if (in_array($exception->getResponse()->getStatusCode(), [400, 409])) { return new BadRequest($exception->getResponse()); } return $exception; } /** * @param string|resource $contents */ protected function getStream(mixed $contents): StreamInterface { if ($this->isPipe($contents)) { /* @var resource $contents */ return new PumpStream(function ($length) use ($contents) { $data = fread($contents, $length); if (strlen($data) === 0) { return false; } return $data; }); } return Psr7\Utils::streamFor($contents); } /** * Get the access token. */ public function getAccessToken(): string { return $this->tokenProvider->getToken(); } /** * Set the access token. */ public function setAccessToken(string $accessToken): self { $this->tokenProvider = new InMemoryTokenProvider($accessToken); return $this; } /** * Set the namespace ID. */ public function setNamespaceId(string $namespaceId): self { $this->namespaceId = $namespaceId; return $this; } /** * Get the HTTP headers. * * @param array
$headers * @return array
*/ protected function getHeaders(array $headers = []): array { $auth = []; if ($this->tokenProvider || ($this->appKey && $this->appSecret)) { $auth = $this->tokenProvider ? $this->getHeadersForBearerToken($this->tokenProvider->getToken()) : $this->getHeadersForCredentials(); } if ($this->teamMemberId) { $auth = array_merge( $auth, [ 'Dropbox-API-Select-User' => $this->teamMemberId, ] ); } if ($this->namespaceId) { $headers = array_merge( $headers, [ 'Dropbox-API-Path-Root' => json_encode([ '.tag' => 'namespace_id', 'namespace_id' => $this->namespaceId, ]), ] ); } return array_merge($auth, $headers); } /** * @return array{Authorization: string} */ protected function getHeadersForBearerToken(string $token): array { return [ 'Authorization' => "Bearer {$token}", ]; } /** * @return array{Authorization: string} */ protected function getHeadersForCredentials(): array { return [ 'Authorization' => 'Basic '.base64_encode("{$this->appKey}:{$this->appSecret}"), ]; } }