' . esc_html__('Upgrade', 'duplicator-pro') . '' ); return false; } return true; } /** * Get default config * * @return array */ protected static function getDefaultConfig(): array { $config = parent::getDefaultConfig(); return array_merge( $config, [ 'v2_access_token' => '', 'authorized' => false, 'token_json' => false, ] ); } /** * Get priority, used to sort storages. * 100 is neutral value, 0 is the highest priority * * @return int */ public static function getPriority(): int { return 310; } /** * Return the storage type * * @return int */ public static function getSType(): int { return 1; } /** * Returns the storage type icon URL * * @return string Returns the storage icon URL */ public static function getStypeIconURL(): string { return DropboxAddon::getAddonUrl() . '/assets/img/dropbox.svg'; } /** * Returns the storage type name. * * @return string */ public static function getStypeName(): string { return __('Dropbox', 'duplicator-pro'); } /** * Get storage location string * * @return string */ public function getLocationString(): string { $dropBoxInfo = $this->getAccountInfo(); if (!isset($dropBoxInfo['locale']) || $dropBoxInfo['locale'] == 'en') { return "https://dropbox.com/home/Apps/Duplicator%20Pro/" . ltrim($this->getStorageFolder(), '/'); } else { return "https://dropbox.com/home"; } } /** * Renders a link to the Dropbox folder. * * @return string HTML anchor */ protected function getConnectedLocationHtml(): string { return '' . esc_html($this->getStorageFolder()) . ''; } /** * Check if storage is valid * * @param ?string $errorMsg Reference to store error message * @param bool $force Force the storage to be revalidated * * @return bool Return true if storage is valid and ready to use, false otherwise */ protected function realIsValid(?string &$errorMsg = '', bool $force = false): bool { if (!$this->isAuthorized()) { $errorMsg = __('Not connected.', 'duplicator-pro'); return false; } if (!$this->getToken()->isValid()) { $errorMsg = __('Dropbox token is invalid.', 'duplicator-pro'); return false; } return true; } /** * Is autorized * * @return bool */ public function isAuthorized(): bool { return (bool) ($this->config['authorized'] ?? false); } /** * Authorized from HTTP request * * @param string $message Message * * @return bool True if authorized, false if failed */ public function authorizeFromRequest(&$message = ''): bool { try { if (($refreshToken = SnapUtil::sanitizeTextInput(SnapUtil::INPUT_REQUEST, 'auth_code')) === '') { throw new Exception(__('Authorization code is empty', 'duplicator-pro')); } $this->name = SnapUtil::sanitizeTextInput(SnapUtil::INPUT_REQUEST, 'name', ''); $this->notes = SnapUtil::sanitizeDefaultInput(SnapUtil::INPUT_REQUEST, 'notes', ''); $this->config['max_packages'] = SnapUtil::sanitizeIntInput(SnapUtil::INPUT_REQUEST, 'max_packages', 10); $this->config['storage_folder'] = self::getSanitizedInputFolder('storage_folder', 'remove'); $this->revokeAuthorization(); $token = new TokenEntity(self::getSType(), ['refresh_token' => $refreshToken]); if ($token->refresh(true) === false) { DupLog::infoTrace("Problem initializing Dropbox with {$refreshToken}"); throw new Exception(__("Couldn't connect. Dropbox access token is invalid or doesn't have required permissions.", 'duplicator-pro')); } $this->setTokenConfig($token); $this->config['authorized'] = true; } catch (Exception $e) { DupLog::trace("Problem authorizing Dropbox access token msg: " . $e->getMessage()); $message = $e->getMessage(); return false; } $message = __('Dropbox is connected successfully and Storage Provider Updated.', 'duplicator-pro'); return true; } /** * Revokes authorization * * @param string $message Message * * @return bool True if authorized, false if failed */ public function revokeAuthorization(&$message = ''): bool { if (!$this->isAuthorized()) { $message = __('Dropbox isn\'t authorized.', 'duplicator-pro'); return true; } try { $client = $this->getAdapter()->getClient(); $client->revokeToken(); } catch (Exception $e) { DupLog::trace("Problem revoking Dropbox access token msg: " . $e->getMessage()); } finally { $this->config['v2_access_token'] = ''; $this->config['authorized'] = false; $this->config['token_json'] = false; } $message = __('Dropbox is disconnected successfully.', 'duplicator-pro'); return true; } /** * Get authorization URL * * @todo: This should be refactored to use the new TokenService class. * * @return string */ public function getAuthorizationUrl(): string { return (new TokenService(static::getSType()))->getRedirectUri(); } /** * Returns the config fields template data * * @return array */ protected function getConfigFieldsData(): array { $accountInfo = $this->getAccountInfo(); $quotaInfo = $this->getQuota(); return array_merge($this->getDefaultConfigFieldsData(), [ 'accountInfo' => is_array($accountInfo) ? $accountInfo : [], 'quotaInfo' => is_array($quotaInfo) ? $quotaInfo : [], ]); } /** * Returns the default config fields template data * * @return array */ protected function getDefaultConfigFieldsData(): array { return [ 'storage' => $this, 'accountInfo' => [], 'quotaInfo' => [], 'storageFolder' => $this->config['storage_folder'], 'maxPackages' => $this->config['max_packages'], ]; } /** * Returns the config fields template path * * @return string */ protected function getConfigFieldsTemplatePath(): string { return 'dropboxaddon/configs/dropbox'; } /** * Update data from http request, this method don't save data, just update object properties * * @param string $message Message * * @return bool True if success and all data is valid, false otherwise */ public function updateFromHttpRequest(&$message = ''): bool { if ((parent::updateFromHttpRequest($message) === false)) { return false; } $this->config['max_packages'] = SnapUtil::sanitizeIntInput(SnapUtil::INPUT_REQUEST, 'dropbox_max_files', 10); $this->config['storage_folder'] = self::getSanitizedInputFolder('_dropbox_storage_folder', 'remove'); $message = sprintf( __('Dropbox Storage Updated. Folder: %1$s', 'duplicator-pro'), $this->getStorageFolder() ); return true; } /** * Get the storage adapter * * @return DropboxAdapter */ protected function getAdapter(): DropboxAdapter { if (! $this->adapter) { $global = GlobalEntity::getInstance(); $this->getToken(); // Ensure any required token refresh happens and config is up-to-date. $this->adapter = new DropboxAdapter( $this->config['v2_access_token'], $this->getStorageFolder(), $global->isSslVerifyEnabled(), $global->getSslCertPath(), $global->ipv4_only ); } return $this->adapter; } /** * @return array */ protected function getTokenConfig(): array { return is_array($this->config['token_json'] ?? null) ? $this->config['token_json'] : []; } /** * Persist the refreshed token data back to the storage config. * * @param TokenEntity $token The refreshed token entity * * @return void */ protected function setTokenConfig(TokenEntity $token): void { /** @todo Config should contain scalar data but it was chosen to assign complex structures ignoring the type. this should be fixed sooner or later. */ $this->config['token_json'] = [ // @phpstan-ignore assign.propertyType 'refresh_token' => $token->getRefreshToken(), 'access_token' => $token->getAccessToken(), 'expires_in' => $token->getExpiresIn(), 'created' => $token->getCreated(), 'scope' => $token->getScope(), ]; $this->config['v2_access_token'] = $token->getAccessToken(); } /** * Get account info * * @return false|array */ protected function getAccountInfo() { if (!$this->isAuthorized()) { return false; } try { return $this->getAdapter()->getClient()->getAccountInfo(); } catch (Exception $e) { DupLog::trace("Problem getting Dropbox account info. " . $e->getMessage()); } return false; } /** * Get dropbox quota * * @return false|array{used:int,total:int,perc:float,available:string} */ protected function getQuota() { if (!$this->isAuthorized()) { return false; } $quota = $this->getAdapter()->getClient()->getQuota(); if ( !isset($quota['used']) || !isset($quota['allocation']['allocated']) || $quota['allocation']['allocated'] <= 0 ) { return false; } $quota_used = $quota['used']; $quota_total = $quota['allocation']['allocated']; $used_perc = round($quota_used * 100 / $quota_total, 1); $available_quota = $quota_total - $quota_used; $available_quota_str = size_format($available_quota) ?: 'unknown'; return [ 'used' => $quota_used, 'total' => $quota_total, 'perc' => $used_perc, 'available' => $available_quota_str, ]; } /** * Get upload chunk size in bytes * * @return int bytes */ public function getUploadChunkSize(): int { $dGlobal = DynamicGlobalEntity::getInstance(); return $dGlobal->getValInt('dropbox_upload_chunksize_in_kb', 2000) * KB_IN_BYTES; } /** * Get download chunk size in bytes * * @return int bytes */ public function getDownloadChunkSize(): int { $dGlobal = DynamicGlobalEntity::getInstance(); return $dGlobal->getValInt('dropbox_download_chunksize_in_kb', 10000) * KB_IN_BYTES; } /** * @return void */ public static function registerStorageSubtype(): void { parent::registerStorageSubtype(); add_action('duplicator_update_global_storage_settings', function (): void { $dGlobal = DynamicGlobalEntity::getInstance(); foreach (static::getDefaultSettings() as $key => $default) { $value = SnapUtil::sanitizeIntInput(SnapUtil::INPUT_REQUEST, $key, $default); $dGlobal->setValInt($key, $value); } }); } /** * Get default settings * * @return array */ protected static function getDefaultSettings(): array { return [ 'dropbox_upload_chunksize_in_kb' => 2000, 'dropbox_download_chunksize_in_kb' => 10000, ]; } /** * @return void */ public static function renderGlobalOptions(): void { $dGlobal = DynamicGlobalEntity::getInstance(); TplMng::getInstance()->render( 'dropboxaddon/configs/global_options', [ 'uploadChunkSize' => $dGlobal->getValInt('dropbox_upload_chunksize_in_kb', 2000), 'downloadChunkSize' => $dGlobal->getValInt('dropbox_download_chunksize_in_kb', 10000), ] ); } }