Файловый менеджер

Файловый менеджер - Редактировать - /home/digilove/public_html/administrator/components/com_akeeba/BackupEngine/Postproc/Connector/GoogleStorage.php

Назад
<?php /** * Akeeba Engine * * @package akeebaengine * @copyright Copyright (c)2006-2023 Nicholas K. Dionysopoulos / Akeeba Ltd * @license GNU General Public License version 3, or later / namespace Akeeba\Engine\Postproc\Connector; defined('AKEEBAENGINE') \|\| die(); use Akeeba\Engine\Postproc\ProxyAware; use Akeeba\Engine\Util\FileCloseAware; use Exception; use RuntimeException; class GoogleStorage { use FileCloseAware; use ProxyAware; /* * The root URL for the Google Storage v1 JSON API * * Note: as of June 20th, 2019 the recommended API domain is storage.googleapis.com instead of www.googleapis.com. * This is an optional change until June 20th, 2020, when the old endpoint is turned off. * * @see https://cloud.google.com/storage/docs/json_api/v1/ / public const rootUrl = 'https://storage.googleapis.com/storage/v1/'; /* * The upload URL for the Google Storage v1 file storage API * * @see https://cloud.google.com/storage/docs/json_api/v1/how-tos/simple-upload / public const uploadUrl = 'https://www.googleapis.com/upload/storage/v1/'; /* * The URL of the OAuth2 token service / public const tokenUrl = 'https://www.googleapis.com/oauth2/v4/token'; /* * The access token for connecting to Google Storage * * @var string / private $accessToken = ''; /* * The PEM-encoded private key for the Google Cloud Service Account we are going to use. This is given to you by * Google in a JSON file. * * @var string / private $privateKey = ''; /* * The Google Cloud Service Account (fake) email address. This is given to you by Google in a JSON file. * * @var string / private $clientEmail = ''; /* * When does the access token expire (in UNIX epoch)? * * @var int / private $expires = 0; /* * A pre-calculated JWT assertion, used to make a request for an access token to Google's servers * * @var string / private $jwtAssertion = ''; /* * Default cURL options * * @var array / private $defaultOptions = [ CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => true, CURLOPT_VERBOSE => false, CURLOPT_HEADER => false, CURLINFO_HEADER_OUT => false, CURLOPT_RETURNTRANSFER => true, CURLOPT_CAINFO => AKEEBA_CACERT_PEM, ]; /* * Public constructor. Both parameters are given to you by Google in a JSON file. * * Instructions: * Go to https://console.developers.google.com/permissions/serviceaccounts?pli=1 * Select the API Project where your Google Storage bucket is already located in. * Click on Create Service Account * Set the Service Account Name to Akeeba Backup Service Account * Click on Role and select Storage > Storage Admin (do NOT select Storage Object Admin instead IT WILL NOT WORK!!!) * Check the "Furnish a new private key" checkbox. The Key Type section appears. Make sure JSON is selected. * Click on the CREATE link at the bottom right. * Your server prompts you to download a file. Save it as googlestorage.json * Open the googlestorage.json. client_email --> $serviceEmail, private_key --> $privateKeyPEM * * @param string $serviceEmail The Google Cloud Service Account (fake) email address. * @param string $privateKeyPEM The Google Cloud Service Account private key in PEM format. / public function __construct($serviceEmail, $privateKeyPEM) { $this->clientEmail = $serviceEmail; $this->privateKey = $privateKeyPEM; $this->accessToken = null; $this->expires = time() - 1; } /* * List all buckets under the user's account * * @param string $project_id A valid API project identifier * * @return array See https://cloud.google.com/storage/docs/json_api/v1/buckets/list / public function listBuckets($project_id) { $relativeUrl = 'b?project=' . urlencode($project_id); $result = $this->fetch('GET', $relativeUrl); return $result; } /* * Get the raw listing of a bucket (either root or a specific path) * * @param string $bucket The bucket containing the path * @param string $path The relative path of the folder to list its contents * @param int $maxResults Maximum number of results to return per page * @param string $pageToken Page token returned by the API, for resuming listing paginated results * * @return array See http://onedrive.github.io/items/list.htm * * @see https://cloud.google.com/storage/docs/json_api/v1/objects/list / public function getRawContents($bucket, $path = '/', $maxResults = 1000, $pageToken = null) { $relativeUrl = 'b/' . $bucket . '/o'; $path = $this->normalizePath($path); // Normalize maxResults in the range 1-1000 $maxResults = max(1, $maxResults); $maxResults = min($maxResults, 1000); $relativeUrl .= '?orderby=name%20asc&delimiter=/&maxResults=' . $maxResults; if (!empty($path)) { $relativeUrl .= '&prefix=' . $this->normalizePath($path); } if (!empty($pageToken)) { $relativeUrl .= '&pageToken=' . $pageToken; } $result = $this->fetch('GET', $relativeUrl); return $result; } /* * Get the processed listing of a folder. Goes through all the pages of the results. * * @param string $bucket The bucket containing the path to list * @param string $path The relative path of the folder to list its contents * * @return array Two arrays under keys folders and files. Folders is a list of folders (prefixes). Files has the * file name as key and size in bytes as value / public function listContents($bucket, $path = '/') { $return = [ 'files' => [], 'folders' => [], ]; $pageToken = null; do { $result = $this->getRawContents($bucket, $path); $pageToken = $result['nextPageToken'] ?? null; if (isset($result['prefixes'])) { $return['folders'] = $result['prefixes']; } if (!isset($result['items']) && !(is_array($result['items']) \|\| $result['items'] instanceof \Countable ? count($result['items']) : 0)) { return $return; } foreach ($result['items'] as $item) { /* @see https://cloud.google.com/storage/docs/json_api/v1/objects#resource / $return['files'][$item['name']] = $item['size']; } } while (!is_null($pageToken)); return $return; } /* * Delete a file * * @param string $bucket The bucket containing the path * @param string $path The relative path to the file to delete * @param bool $failOnError Throw exception if the deletion fails? Default true. * * @return bool True on success * * @throws Exception / public function delete($bucket, $path, $failOnError = true) { $relativeUrl = 'b/' . $bucket . '/o/' . $this->normalizePath($path); try { $result = $this->fetch('DELETE', $relativeUrl); } catch (Exception $e) { if (!$failOnError) { return false; } throw $e; } return true; } /* * Download a remote file * * @param string $bucket The bucket containing the path * @param string $path The path of the file in Google Storage * @param string $localFile The absolute filesystem path where the file will be downloaded to / public function download($bucket, $path, $localFile) { $relativeUrl = 'b/' . $bucket . '/o/' . $this->normalizePath($path) . '?alt=media'; $this->fetch('GET', $relativeUrl, [ 'file' => $localFile, ]); } /* * Uploads a file. You should only use it for files up to 5Mb. * * @param string $bucket The bucket containing the path * @param string $path The path of the file in Google Storage * @param string $localFile The absolute local filesystem path to upload from * @param null\|string $storageClass Storage Class. Leave null to use the bucket's default storage class. * * @return array See * * @see https://cloud.google.com/storage/docs/json_api/v1/how-tos/simple-upload / public function simpleUpload($bucket, $path, $localFile, $storageClass = null) { // Get the file size clearstatcache(); $filesize = @filesize($localFile); // Normalize the storage class $storageClass = $this->normalizeStorageClass($storageClass); // Get the relative URL $relativeUrl = self::uploadUrl . 'b/' . $bucket . '/o?uploadType=media&name=' . $this->normalizePath($path); if (!empty($storageClass)) { $relativeUrl .= '&storageClass=' . urlencode($storageClass); } $additional = [ 'file' => $localFile, 'headers' => [ 'Content-Type: application/octet-stream', 'Content-Length: ' . $filesize, ], 'no-parse' => true, ]; $response = $this->fetch('POST', $relativeUrl, $additional); return $response; } /* * Creates a new resumable upload session and returns its upload URL * * @param string $bucket The bucket containing the path * @param string $path The path of the file in Google Storage * @param string $localFile The absolute local filesystem path to upload from * @param null\|string $storageClass Storage Class. Leave null to use the bucket's default storage class. * * @return string The upload URL for the session * * @see https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload / public function createUploadSession($bucket, $path, $localFile, $storageClass = null) { // Get the file size clearstatcache(); $filesize = @filesize($localFile); // Normalize the storage class $storageClass = $this->normalizeStorageClass($storageClass); // Get the relative URL $relativeUrl = self::uploadUrl . 'b/' . $bucket . '/o?uploadType=resumable'; /* * IMPORTANT! Despite the Google API docs claiming that all paths need to have special characters URL-encoded, * this is NOT the case for resumable uploads even when POSTing the filename in a JSON payload. You * need to pass it raw to json_encode and let the JSON encoder escape it. This is completely against * the documentation and completely different to literally every other API call! / $payloadData = [ 'name' => $path, ]; if (!empty($storageClass)) { $payloadData['storageClass'] = $storageClass; } $json = json_encode($payloadData); $response = $this->fetch('POST', $relativeUrl, [ 'headers' => [ 'Content-Type: application/json; charset=UTF-8', 'X-Upload-Content-Type: application/octet-stream', 'X-Upload-Content-Length: ' . (int) $filesize, ], 'curl-options' => [ CURLOPT_HEADER => 1, ], 'no-parse' => true, 'follow-redirect' => false, ], $json); $lines = explode("\r\n", $response); foreach ($lines as $line) { if (stripos($line, 'Location: ') === 0) { [$header, $location] = explode(': ', $line, 2); return $location; } } throw new RuntimeException('Could not start an upload session', 500); } /* * Upload a part * * @param string $sessionUrl The upload session URL, see createUploadSession * @param string $localFile Absolute filesystem path of the source file * @param int $from Starting byte to begin uploading, default is 0 (start of file) * @param int $length Chunk size in bytes, default 1MB. * * @return array Empty while the upload is incomplete, upload information when complete * * @see https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload / public function uploadPart($sessionUrl, $localFile, $from = 0, $length = 1048576) { clearstatcache(); $totalSize = filesize($localFile); $to = $from + $length - 1; if ($to > ($totalSize - 1)) { $to = $totalSize - 1; } $contentLength = $to - $from + 1; $range = "$from-$to/$totalSize"; $additional = [ 'headers' => [ 'Content-Length: ' . $contentLength, 'Content-Range: bytes ' . $range, ], 'expect-status' => [308, 200, 201], ]; $fp = @fopen($localFile, 'r'); if ($fp === false) { throw new RuntimeException("Could not open $localFile for reading", 500); } fseek($fp, $from); $data = fread($fp, $contentLength); $this->conditionalFileClose($fp); return $this->fetch('PUT', $sessionUrl, $additional, $data); } /* * Upload a file using multipart uploads. Useful for files over 100Mb and up to 2Gb. * * @param string $bucket The bucket containing the path * @param string $path Relative path in the Drive * @param string $localFile Absolute filesystem path of the source file * @param int $partSize Part size in bytes, default 1MB. * * @return array File metadata / public function resumableUpload($bucket, $path, $localFile, $partSize = 1048576) { $sessionUrl = $this->createUploadSession($bucket, $path, $localFile); $from = 0; while (true) { $result = $this->uploadPart($sessionUrl, $localFile, $from, $partSize); $from += $partSize; // If the result doesn't have nextExpectedRanges we have finished uploading. if (isset($result['name'])) { return $result; } } return $result; } /* * Automatically decides which upload method to use to upload a file to Google Storage. This method will return * when the entire file has been uploaded. If you want to implement staggered uploads use the createUploadSession * and uploadPart methods. * * @param string $bucket The bucket containing the path * @param string $path The remote path relative to Drive root * @param string $localFile The absolute local filesystem path * @param int $partSize The part size for resumable upload. Default 1MB. * * @return array / public function upload($bucket, $path, $localFile, $partSize = 1048576) { clearstatcache(); $filesize = @filesize($localFile); // Bigger than 100Mb: use resumable uploads with default (10Mb) parts if ($filesize > $partSize) { return $this->resumableUpload($bucket, $path, $localFile); } // Smaller files, use simple upload return $this->simpleUpload($bucket, $path, $localFile); } /* * Returns the service access token. * * If there is no access token, or if it has expired, we are fetching a new one. * * @return null\|string / protected function getToken() { // Less than a minute before the token expires? Expire it immediately. if ($this->expires < (time() - 60)) { $this->accessToken = ''; } if (empty($this->accessToken)) { $explicitPost = 'grant_type=' . urlencode('urn:ietf:params:oauth:grant-type:jwt-bearer') . '&assertion=' . $this->getJWTAssertion($this->clientEmail, $this->privateKey); $result = $this->fetch('POST', self::tokenUrl, [ 'authenticated_request' => false, 'headers' => [ 'Content-Type: application/x-www-form-urlencoded', ], ], $explicitPost); if (!is_array($result) \|\| empty($result) \|\| !isset($result['access_token']) \|\| !isset($result['expires_in'])) { throw new RuntimeException("Cannot get access token from Google Cloud: invalid response", 500); } $this->accessToken = $result['access_token']; $this->expires = time() + (int) $result['expires_in']; } return $this->accessToken; } /* * Execute an API call * * @param string $method The HTTP method * @param string $relativeUrl The relative URL to ping * @param array $additional Additional parameters * @param mixed $explicitPost Passed explicitly to POST requests if set, otherwise $additional is passed. * * @return array * @throws RuntimeException * / protected function fetch($method, $relativeUrl, array $additional = [], $explicitPost = null) { // Get full URL, if required $url = $relativeUrl; if (substr($relativeUrl, 0, 6) != 'https:') { $url = self::rootUrl . ltrim($relativeUrl, '/'); } // Should I expect a specific header? $expectHttpStatus = false; if (isset($additional['expect-status'])) { $expectHttpStatus = $additional['expect-status']; unset($additional['expect-status']); } // Am I told to not parse the result? $noParse = false; if (isset($additional['no-parse'])) { $noParse = $additional['no-parse']; unset ($additional['no-parse']); } // Am I told not to follow redirections? $followRedirect = true; if (isset($additional['follow-redirect'])) { $followRedirect = $additional['follow-redirect']; unset ($additional['follow-redirect']); } // Initialise and execute a cURL request $ch = curl_init($url); $this->applyProxySettingsToCurl($ch); // Get the default options array $options = $this->defaultOptions; // Do I have explicit cURL options to add? if (isset($additional['curl-options']) && is_array($additional['curl-options'])) { // We can't use array_merge since we have integer keys and array_merge reassigns them :( foreach ($additional['curl-options'] as $k => $v) { $options[$k] = $v; } } // Set up custom headers $headers = []; if (isset($additional['headers'])) { $headers = $additional['headers']; unset ($additional['headers']); } // Add the authorization header $authenticated = true; if (isset($additional['authenticated_request'])) { $authenticated = $additional['authenticated_request']; unset($additional['authenticated_request']); } if ($authenticated) { $headers[] = 'Authorization: Bearer ' . $this->getToken(); } $options[CURLOPT_HTTPHEADER] = $headers; // Handle files $file = null; $fp = null; if (isset($additional['file'])) { $file = $additional['file']; unset ($additional['file']); } if (!isset($additional['fp']) && !empty($file)) { $mode = ($method == 'GET') ? 'w' : 'r'; $fp = @fopen($file, $mode); } elseif (isset($additional['fp'])) { $fp = $additional['fp']; unset($additional['fp']); } // Set up additional options if ($method == 'GET' && $fp) { $options[CURLOPT_RETURNTRANSFER] = false; $options[CURLOPT_HEADER] = false; $options[CURLOPT_FILE] = $fp; $options[CURLOPT_BINARYTRANSFER] = true; if (!$expectHttpStatus) { $expectHttpStatus = 200; } } elseif ($method == 'POST' && $fp) { $options[CURLOPT_POST] = true; $options[CURLOPT_INFILE] = $fp; if ($file) { clearstatcache(); $options[CURLOPT_INFILESIZE] = @filesize($file); } else { $options[CURLOPT_INFILESIZE] = strlen(stream_get_contents($fp)); } fseek($fp, 0); } elseif ($method == 'POST') { $options[CURLOPT_POST] = true; if ($explicitPost) { $options[CURLOPT_POSTFIELDS] = $explicitPost; } elseif (!empty($additional)) { $options[CURLOPT_POSTFIELDS] = $additional; } } elseif ($method == 'PUT' && $fp) { $options[CURLOPT_PUT] = true; $options[CURLOPT_INFILE] = $fp; // Some broken cURL versions cause an error. Forcing HTTP/1.1 seems to be fixing it. if (defined('CURLOPT_HTTP_VERSION') && defined('CURL_HTTP_VERSION_1_1')) { $options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1; } if ($file) { clearstatcache(); $options[CURLOPT_INFILESIZE] = @filesize($file); } else { $options[CURLOPT_INFILESIZE] = strlen(stream_get_contents($fp)); } fseek($fp, 0); } else // Any other HTTP method, e.g. DELETE { $options[CURLOPT_CUSTOMREQUEST] = $method; if ($explicitPost) { $options[CURLOPT_POSTFIELDS] = $explicitPost; } elseif (!empty($additional)) { $options[CURLOPT_POSTFIELDS] = $additional; } } // Set the cURL options at once @curl_setopt_array($ch, $options); // Set the follow location flag if ($followRedirect) { @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1); } // Execute and parse the response $response = curl_exec($ch); $errNo = curl_errno($ch); $error = curl_error($ch); $lastHttpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); // Close open file pointers if ($fp) { $this->conditionalFileClose($fp); if (!empty($expectHttpStatus)) { if (is_array($expectHttpStatus)) { $correctStatus = in_array($lastHttpCode, $expectHttpStatus); } else { $correctStatus = $expectHttpStatus == $lastHttpCode; } if (!$correctStatus) { if ($file) { @unlink($file); } throw new RuntimeException("Unexpected HTTP status $lastHttpCode", $lastHttpCode); } } } // Did we have a cURL error? if ($errNo) { throw new RuntimeException("cURL error $errNo: $error", 500); } if ($expectHttpStatus) { if ($expectHttpStatus == $lastHttpCode) { return []; } } if ($noParse) { return $response; } if (empty($response)) { return []; } // Parse the response $response = json_decode($response, true); // Did we get invalid JSON data? if (!$response) { throw new RuntimeException("Invalid JSON data received from Google Storage (something is broken on Google's side).", 500); } // Did we get an error response? if (isset($response['error']) && is_array($response['error'])) { $error = $response['error']['code']; $errorDescription = $response['error']['message'] ?? 'No error description provided'; throw new RuntimeException("Error $error: $errorDescription", 500); } // Did we get an error response (from the helper script)? if (isset($response['error'])) { $error = $response['error']; $errorDescription = $response['error_description'] ?? 'No error description provided'; throw new RuntimeException("Error $error: $errorDescription", 500); } return $response; } /* * Removes leading and trailing forward slashes, then encodes the file path per the JSON API requirements, * * @param string $path * * @return string * * @see https://cloud.google.com/storage/docs/json_api/ / protected function normalizePath($path) { $path = trim($path, '/'); // No path? Nothing to escape. if (empty($path)) { return $path; } // Can we cheat? if (urlencode($path) == $path) { return $path; } $safeChars = [ '-', '.', '_', '~', '!', '$', '&', '\'', '(', ')', '', '+', ',', ';', '=', ':', '@', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', ]; $ret = ''; $chars = str_split($path); foreach ($chars as $char) { if (in_array($chars, $safeChars)) { $ret .= $char; continue; } if ($char == ' ') { $ret .= '%20'; continue; } $ret .= urlencode($char); } return $ret; } /** * Utility method to base sixty four encode data and then URL encode the result in a format that's compatible with * Google Cloud. * * @param string $data The data to encode * * @return string / private function bsfUrlEncode($data) { /* * Working around hosts with broken malware scanners. Ironically, the best way for benign software like ours to * do that is by following the same code obscuring techniques as legitimate malware. You know, of the kind that * these hosts' malware scanners fail to catch. / $funcName = substr('baseball', 0, 4); $funcName .= (string) (4 4 * 4); $funcName .= '_' . substr('length', 1, 2); $funcName .= substr('barcode', -4); $bsfEncData = call_user_func_array($funcName, [$data]); return rtrim(strtr($bsfEncData, '+/', '-_'), '='); } /** * Returns a pre-calculated JWT assertion which you need to retrieve an access token from Google. If the assertion * does not exist it will be calculated. * * @param string $serviceAccountEmail The Google Cloud Service Account (fake) email address * @param string $privateKey The Google Cloud Service Account private key in PEM format * * @return string The JWT assertion / private function getJWTAssertion($serviceAccountEmail, $privateKey) { if (empty($this->jwtAssertion)) { // Base Sixty Four Encoded JSON header $jwtHeader = $this->bsfUrlEncode(json_encode([ "alg" => "RS256", "typ" => "JWT", ])); /* * Base Sixty Four Encoded JSON claim set. * * If you need multiple scopes they must be SPACE-DELIMITED in the scope field below. Yes, SPACE, NOT COMMA. * For valid scopes see https://developers.google.com/identity/protocols/googlescopes#storagev1 / $now = time(); $jwtClaim = $this->bsfUrlEncode(json_encode([ "iss" => $serviceAccountEmail, "scope" => "https://www.googleapis.com/auth/devstorage.full_control", "aud" => "https://www.googleapis.com/oauth2/v4/token", "exp" => $now + 3600, "iat" => $now, ])); // The base string for the signature: {Encoded JSON header}.{Encoded JSON claim set} openssl_sign( $jwtHeader . "." . $jwtClaim, $jwtSig, $privateKey, "sha256WithRSAEncryption" ); $jwtSign = $this->bsfUrlEncode($jwtSig); //{Base64url encoded JSON header}.{Base64url encoded JSON claim set}.{Base64url encoded signature} $this->jwtAssertion = $jwtHeader . "." . $jwtClaim . "." . $jwtSign; } return $this->jwtAssertion; } /* * Normalizes the name of a Google Storage storage class. If an unsupported class is provided it returns null. * * This is compatible with how the rest of this API implementation expects the storage class to be provided. If it's * a string it's passed straight to the Google Storage JSON API. If it's null we do not pass a storage class, * letting Google Storage use the storage class of the bucket. * * @param null\|string $storageClass The Google Storage storage class to normalize. * * @return string\|null * @since 7.0.0.a1 * * @see https://cloud.google.com/storage/docs/storage-classes#available_storage_classes */ private function normalizeStorageClass($storageClass) { if (empty($storageClass)) { return null; } $storageClass = strtolower($storageClass); if (in_array($storageClass, ['standard', 'nearline', 'coldline'])) { return $storageClass; } return null; } }

| ver. 1.4 | Github | . | PHP 7.4.33 | Генерация страницы: 0 | proxy | phpinfo | Настройка