* @author Jörn Friedrich Dreyer * @author Morris Jobke * @author Robin Appelman * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OC\Files\ObjectStore; use Icewind\Streams\CallbackWrapper; use Icewind\Streams\IteratorDirectory; use OC\Files\Cache\CacheEntry; use OCP\Files\ObjectStore\IObjectStore; class ObjectStoreStorage extends \OC\Files\Storage\Common { /** * @var \OCP\Files\ObjectStore\IObjectStore $objectStore */ protected $objectStore; /** * @var string $id */ protected $id; /** * @var \OC\User\User $user */ protected $user; private $objectPrefix = 'urn:oid:'; private $logger; public function __construct($params) { if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { $this->objectStore = $params['objectstore']; } else { throw new \Exception('missing IObjectStore instance'); } if (isset($params['storageid'])) { $this->id = 'object::store:' . $params['storageid']; } else { $this->id = 'object::store:' . $this->objectStore->getStorageId(); } if (isset($params['objectPrefix'])) { $this->objectPrefix = $params['objectPrefix']; } //initialize cache with root directory in cache if (!$this->is_dir('/')) { $this->mkdir('/'); } $this->logger = \OC::$server->getLogger(); } public function mkdir($path) { $path = $this->normalizePath($path); if ($this->file_exists($path)) { return false; } $mTime = time(); $data = [ 'mimetype' => 'httpd/unix-directory', 'size' => 0, 'mtime' => $mTime, 'storage_mtime' => $mTime, 'permissions' => \OCP\Constants::PERMISSION_ALL, ]; if ($path === '') { //create root on the fly $data['etag'] = $this->getETag(''); $this->getCache()->put('', $data); return true; } else { // if parent does not exist, create it $parent = $this->normalizePath(dirname($path)); $parentType = $this->filetype($parent); if ($parentType === false) { if (!$this->mkdir($parent)) { // something went wrong return false; } } else if ($parentType === 'file') { // parent is a file return false; } // finally create the new dir $mTime = time(); // update mtime $data['mtime'] = $mTime; $data['storage_mtime'] = $mTime; $data['etag'] = $this->getETag($path); $this->getCache()->put($path, $data); return true; } } /** * @param string $path * @return string */ private function normalizePath($path) { $path = trim($path, '/'); //FIXME why do we sometimes get a path like 'files//username'? $path = str_replace('//', '/', $path); // dirname('/folder') returns '.' but internally (in the cache) we store the root as '' if (!$path || $path === '.') { $path = ''; } return $path; } /** * Object Stores use a NoopScanner because metadata is directly stored in * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere. * * @param string $path * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner * @return \OC\Files\ObjectStore\NoopScanner */ public function getScanner($path = '', $storage = null) { if (!$storage) { $storage = $this; } if (!isset($this->scanner)) { $this->scanner = new NoopScanner($storage); } return $this->scanner; } public function getId() { return $this->id; } public function rmdir($path) { $path = $this->normalizePath($path); if (!$this->is_dir($path)) { return false; } $this->rmObjects($path); $this->getCache()->remove($path); return true; } private function rmObjects($path) { $children = $this->getCache()->getFolderContents($path); foreach ($children as $child) { if ($child['mimetype'] === 'httpd/unix-directory') { $this->rmObjects($child['path']); } else { $this->unlink($child['path']); } } } public function unlink($path) { $path = $this->normalizePath($path); $stat = $this->stat($path); if ($stat && isset($stat['fileid'])) { if ($stat['mimetype'] === 'httpd/unix-directory') { return $this->rmdir($path); } try { $this->objectStore->deleteObject($this->getURN($stat['fileid'])); } catch (\Exception $ex) { if ($ex->getCode() !== 404) { $this->logger->logException($ex, [ 'app' => 'objectstore', 'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path, ]); return false; } //removing from cache is ok as it does not exist in the objectstore anyway } $this->getCache()->remove($path); return true; } return false; } public function stat($path) { $path = $this->normalizePath($path); $cacheEntry = $this->getCache()->get($path); if ($cacheEntry instanceof CacheEntry) { return $cacheEntry->getData(); } else { return false; } } /** * Override this method if you need a different unique resource identifier for your object storage implementation. * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users. * You may need a mapping table to store your URN if it cannot be generated from the fileid. * * @param int $fileId the fileid * @return null|string the unified resource name used to identify the object */ protected function getURN($fileId) { if (is_numeric($fileId)) { return $this->objectPrefix . $fileId; } return null; } public function opendir($path) { $path = $this->normalizePath($path); try { $files = array(); $folderContents = $this->getCache()->getFolderContents($path); foreach ($folderContents as $file) { $files[] = $file['name']; } return IteratorDirectory::wrap($files); } catch (\Exception $e) { $this->logger->logException($e); return false; } } public function filetype($path) { $path = $this->normalizePath($path); $stat = $this->stat($path); if ($stat) { if ($stat['mimetype'] === 'httpd/unix-directory') { return 'dir'; } return 'file'; } else { return false; } } public function fopen($path, $mode) { $path = $this->normalizePath($path); if (strrpos($path, '.') !== false) { $ext = substr($path, strrpos($path, '.')); } else { $ext = ''; } switch ($mode) { case 'r': case 'rb': $stat = $this->stat($path); if (is_array($stat)) { try { return $this->objectStore->readObject($this->getURN($stat['fileid'])); } catch (\Exception $ex) { $this->logger->logException($ex, [ 'app' => 'objectstore', 'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path, ]); return false; } } else { return false; } case 'w': case 'wb': case 'w+': case 'wb+': $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); $handle = fopen($tmpFile, $mode); return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { $this->writeBack($tmpFile, $path); }); case 'a': case 'ab': case 'r+': case 'a+': case 'x': case 'x+': case 'c': case 'c+': $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); if ($this->file_exists($path)) { $source = $this->fopen($path, 'r'); file_put_contents($tmpFile, $source); } $handle = fopen($tmpFile, $mode); return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { $this->writeBack($tmpFile, $path); }); } return false; } public function file_exists($path) { $path = $this->normalizePath($path); return (bool)$this->stat($path); } public function rename($source, $target) { $source = $this->normalizePath($source); $target = $this->normalizePath($target); $this->remove($target); $this->getCache()->move($source, $target); $this->touch(dirname($target)); return true; } public function getMimeType($path) { $path = $this->normalizePath($path); $stat = $this->stat($path); if (is_array($stat)) { return $stat['mimetype']; } else { return false; } } public function touch($path, $mtime = null) { if (is_null($mtime)) { $mtime = time(); } $path = $this->normalizePath($path); $dirName = dirname($path); $parentExists = $this->is_dir($dirName); if (!$parentExists) { return false; } $stat = $this->stat($path); if (is_array($stat)) { // update existing mtime in db $stat['mtime'] = $mtime; $this->getCache()->update($stat['fileid'], $stat); } else { try { //create a empty file, need to have at least on char to make it // work with all object storage implementations $this->file_put_contents($path, ' '); $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); $stat = array( 'etag' => $this->getETag($path), 'mimetype' => $mimeType, 'size' => 0, 'mtime' => $mtime, 'storage_mtime' => $mtime, 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, ); $this->getCache()->put($path, $stat); } catch (\Exception $ex) { $this->logger->logException($ex, [ 'app' => 'objectstore', 'message' => 'Could not create object for ' . $path, ]); throw $ex; } } return true; } public function writeBack($tmpFile, $path) { $stat = $this->stat($path); if (empty($stat)) { // create new file $stat = array( 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, ); } // update stat with new data $mTime = time(); $stat['size'] = filesize($tmpFile); $stat['mtime'] = $mTime; $stat['storage_mtime'] = $mTime; // run path based detection first, to use file extension because $tmpFile is only a random string $mimetypeDetector = \OC::$server->getMimeTypeDetector(); $mimetype = $mimetypeDetector->detectPath($path); if ($mimetype === 'application/octet-stream') { $mimetype = $mimetypeDetector->detect($tmpFile); } $stat['mimetype'] = $mimetype; $stat['etag'] = $this->getETag($path); $fileId = $this->getCache()->put($path, $stat); try { //upload to object storage $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); } catch (\Exception $ex) { $this->getCache()->remove($path); $this->logger->logException($ex, [ 'app' => 'objectstore', 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, ]); throw $ex; // make this bubble up } } /** * external changes are not supported, exclusive access to the object storage is assumed * * @param string $path * @param int $time * @return false */ public function hasUpdated($path, $time) { return false; } public function needsPartFile() { return false; } } d/main-fix-npm-audit Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Http/Client/ClientService.php
blob: b719f3d369d140688fe5a7d222e074070dff456f (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OC\Http\Client;

use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use OCP\Diagnostics\IEventLogger;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\ICertificateManager;
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use Psr\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;

/**
 * Class ClientService
 *
 * @package OC\Http
 */
class ClientService implements IClientService {
	/** @var IConfig */
	private $config;
	/** @var ICertificateManager */
	private $certificateManager;
	/** @var DnsPinMiddleware */
	private $dnsPinMiddleware;
	private IRemoteHostValidator $remoteHostValidator;
	private IEventLogger $eventLogger;

	public function __construct(
		IConfig $config,
		ICertificateManager $certificateManager,
		DnsPinMiddleware $dnsPinMiddleware,
		IRemoteHostValidator $remoteHostValidator,
		IEventLogger $eventLogger,
		protected LoggerInterface $logger,
	) {
		$this->config = $config;
		$this->certificateManager = $certificateManager;
		$this->dnsPinMiddleware = $dnsPinMiddleware;
		$this->remoteHostValidator = $remoteHostValidator;
		$this->eventLogger = $eventLogger;
	}

	/**
	 * @return Client
	 */
	public function newClient(): IClient {
		$handler = new CurlHandler();
		$stack = HandlerStack::create($handler);
		if ($this->config->getSystemValueBool('dns_pinning', true)) {
			$stack->push($this->dnsPinMiddleware->addDnsPinning());
		}
		$stack->push(Middleware::tap(function (RequestInterface $request) {
			$this->eventLogger->start('http:request', $request->getMethod() . ' request to ' . $request->getRequestTarget());
		}, function () {
			$this->eventLogger->end('http:request');
		}), 'event logger');

		$client = new GuzzleClient(['handler' => $stack]);

		return new Client(
			$this->config,
			$this->certificateManager,
			$client,
			$this->remoteHostValidator,
			$this->logger,
		);
	}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-02 02:59:34 +0000