|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace MongoDB\GridFS; |
| 4 | + |
| 5 | +use MongoDB\Driver\Server; |
| 6 | +use MongoDB\Exception\InvalidArgumentException; |
| 7 | +use MongoDB\Exception\InvalidArgumentTypeException; |
| 8 | +use MongoDB\Exception\RuntimeException; |
| 9 | +use MongoDB\Exception\UnexpectedValueException; |
| 10 | + |
| 11 | +/** |
| 12 | + * Stream wrapper for reading and writing a GridFS file. |
| 13 | + * |
| 14 | + * @internal |
| 15 | + * @see MongoDB\GridFS\Bucket::openUploadStream() |
| 16 | + */ |
| 17 | +class StreamWrapper |
| 18 | +{ |
| 19 | + public $context; |
| 20 | + |
| 21 | + private $bucket; |
| 22 | + private $filename; |
| 23 | + private $options; |
| 24 | + |
| 25 | + private $protocol = 'gridfs'; |
| 26 | + |
| 27 | + private $at; |
| 28 | + private $hashContext; |
| 29 | + |
| 30 | + /** |
| 31 | + * Register the GridFS stream wrapper. |
| 32 | + * |
| 33 | + * @param Manager $manager Manager instance from the driver |
| 34 | + * @param string $protocol Protocol to register |
| 35 | + */ |
| 36 | + public static function register(Manager $manager, $protocol = 'gridfs') |
| 37 | + { |
| 38 | + if (in_array($protocol, stream_get_wrappers())) { |
| 39 | + stream_wrapper_unregister($protocol); |
| 40 | + } |
| 41 | + |
| 42 | + // Set the client passed in as the default stream context client |
| 43 | + stream_wrapper_register($protocol, get_called_class(), STREAM_IS_URL); |
| 44 | + $default = stream_context_get_options(stream_context_get_default()); |
| 45 | + $default[$protocol]['manager'] = $manager; |
| 46 | + stream_context_set_default($default); |
| 47 | + } |
| 48 | + |
| 49 | + public function stream_open($path, $mode, $options, &$openedPath) |
| 50 | + { |
| 51 | + $this->initProtocol($path); |
| 52 | + $this->params = $this->getDatabase($path); |
| 53 | + $this->mode = rtrim($mode, 'bt'); |
| 54 | + |
| 55 | + if ($errors = $this->validate($path, $this->mode)) { |
| 56 | + return $this->triggerError($errors); |
| 57 | + } |
| 58 | + |
| 59 | + return $this->boolCall(function() use ($path) { |
| 60 | + switch ($this->mode) { |
| 61 | + case 'r': return $this->openReadStream($path); |
| 62 | + case 'a': return $this->openAppendStream($path); |
| 63 | + default: return $this->openWriteStream($path); |
| 64 | + } |
| 65 | + }); |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * Validates the provided stream arguments for fopen and returns an array |
| 70 | + * of errors. |
| 71 | + */ |
| 72 | + private function validate($path, $mode) |
| 73 | + { |
| 74 | + $errors = []; |
| 75 | + if (!$this->getOption('Key')) { |
| 76 | + $errors[] = 'Cannot open a bucket. You must specify a path in the ' |
| 77 | + . 'form of s3://bucket/key'; |
| 78 | + } |
| 79 | + if (!in_array($mode, ['r', 'w', 'a', 'x'])) { |
| 80 | + $errors[] = "Mode not supported: {$mode}. " |
| 81 | + . "Use one 'r', 'w', 'a', or 'x'."; |
| 82 | + } |
| 83 | + // When using mode "x" validate if the file exists before attempting |
| 84 | + // to read |
| 85 | + if ($mode == 'x' && |
| 86 | + $this->getClient()->doesObjectExist( |
| 87 | + $this->getOption('Bucket'), |
| 88 | + $this->getOption('Key'), |
| 89 | + $this->getOptions(true) |
| 90 | + ) |
| 91 | + ) { |
| 92 | + $errors[] = "{$path} already exists on Amazon S3"; |
| 93 | + } |
| 94 | + return $errors; |
| 95 | + } |
| 96 | + |
| 97 | + /** |
| 98 | + * Trigger one or more errors |
| 99 | + * |
| 100 | + * @param string|array $errors Errors to trigger |
| 101 | + * @param mixed $flags If set to STREAM_URL_STAT_QUIET, then no |
| 102 | + * error or exception occurs |
| 103 | + * |
| 104 | + * @return bool Returns false |
| 105 | + * @throws \RuntimeException if throw_errors is true |
| 106 | + */ |
| 107 | + private function triggerError($errors, $flags = null) |
| 108 | + { |
| 109 | + // This is triggered with things like file_exists() |
| 110 | + if ($flags & STREAM_URL_STAT_QUIET) { |
| 111 | + return $flags & STREAM_URL_STAT_LINK |
| 112 | + // This is triggered for things like is_link() |
| 113 | + ? $this->formatUrlStat(false) |
| 114 | + : false; |
| 115 | + } |
| 116 | + // This is triggered when doing things like lstat() or stat() |
| 117 | + trigger_error(implode("\n", (array) $errors), E_USER_WARNING); |
| 118 | + return false; |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Constructs a writable upload stream. |
| 123 | + * |
| 124 | + * Supported options: |
| 125 | + * |
| 126 | + * * chunkSizeBytes (integer): The number of bytes per chunk of this file. |
| 127 | + * Defaults to the chunkSizeBytes of the Bucket. |
| 128 | + * |
| 129 | + * * metadata (document): User data for the "metadata" field of the files |
| 130 | + * collection document. |
| 131 | + * |
| 132 | + * The following options are deprecated: |
| 133 | + * |
| 134 | + * * aliases (string[]): An array of aliases (i.e. filenames). Applications |
| 135 | + * wishing to store aliases should add an aliases field to the metadata |
| 136 | + * document instead. |
| 137 | + * |
| 138 | + * * contentType (string): A valid MIME type. Applications wishing to store |
| 139 | + * a contentType should add a contentType field to the metadata document |
| 140 | + * instead. |
| 141 | + * |
| 142 | + * @param Bucket $bucket Database name |
| 143 | + * @param string $filename Filename |
| 144 | + * @param array $options Upload options |
| 145 | + * @throws InvalidArgumentException |
| 146 | + */ |
| 147 | + public function __construct(Bucket $bucket, $filename, array $options = []) |
| 148 | + { |
| 149 | + $options += [ |
| 150 | + 'chunkSizeBytes' => $bucket->getChunkSizeBytes(), |
| 151 | + ]; |
| 152 | + |
| 153 | + if (isset($options['chunkSizeBytes']) && ! is_integer($options['chunkSizeBytes'])) { |
| 154 | + throw new InvalidArgumentTypeException('"chunkSizeBytes" option', $options['chunkSizeBytes'], 'integer'); |
| 155 | + } |
| 156 | + |
| 157 | + if (isset($options['metadata']) && ! is_array($options['metadata']) && ! is_object($options['metadata'])) { |
| 158 | + throw new InvalidArgumentTypeException('"metadata" option', $options['metadata'], 'array or object'); |
| 159 | + } |
| 160 | + |
| 161 | + if (isset($options['aliases'])) { |
| 162 | + if ( ! is_array($options['aliases'])) { |
| 163 | + throw new InvalidArgumentTypeException('"aliases" option', $options['aliases'], 'array or object'); |
| 164 | + } |
| 165 | + |
| 166 | + $expectedIndex = 0; |
| 167 | + |
| 168 | + foreach ($options['aliases'] as $i => $alias) { |
| 169 | + if ($i !== $expectedIndex) { |
| 170 | + throw new InvalidArgumentException(sprintf('"aliases" option is not a list (unexpected index: "%s")', $i)); |
| 171 | + } |
| 172 | + |
| 173 | + if ( ! is_string($alias)) { |
| 174 | + throw new InvalidArgumentTypeException(sprintf('$options["aliases"][%d]', $i), $alias, 'string'); |
| 175 | + } |
| 176 | + |
| 177 | + $expectedIndex += 1; |
| 178 | + } |
| 179 | + } |
| 180 | + |
| 181 | + if (isset($options['contentType']) && ! is_string($options['contentType'])) { |
| 182 | + throw new InvalidArgumentTypeException('"contentType" option', $options['contentType'], 'string'); |
| 183 | + } |
| 184 | + |
| 185 | + $this->bucket = $bucket; |
| 186 | + $this->filename = (string) $filename; |
| 187 | + $this->options = $options; |
| 188 | + $this->hashContext = hash_init('md5'); |
| 189 | + } |
| 190 | + |
| 191 | + function stream_write($data) |
| 192 | + { |
| 193 | + hash_update($this->hashContext, $data); |
| 194 | + |
| 195 | + fopen('php://memory', ) |
| 196 | + } |
| 197 | +} |
0 commit comments