1515use OCP \Files \File as NcFile ;
1616use OCP \Files \Folder as NcFolder ;
1717use OCP \Files \Node as NcNode ;
18+ use OCP \IConfig ;
1819use OCP \IDateTimeZone ;
20+ use OCP \IL10N ;
21+ use OCP \L10N \IFactory ;
1922use Psr \Log \LoggerInterface ;
2023use Sabre \DAV \Server ;
2124use Sabre \DAV \ServerPlugin ;
@@ -37,13 +40,22 @@ class ZipFolderPlugin extends ServerPlugin {
3740 * Reference to main server object
3841 */
3942 private ?Server $ servernull ;
43+ private bool $ reportMissingFiles
44+ private array $ missingInfo
4045
4146 public function __construct (
4247 private Tree $ tree
4348 private LoggerInterface $ logger
4449 private IEventDispatcher $ eventDispatcher
4550 private IDateTimeZone $ timezoneFactory
51+ private IConfig $ config
52+ private IL10N $ l10n
4653 ) {
54+ $ this reportMissingFiles = $ this config ->getSystemValueBool ('archive_report_missing_files ' , false );
55+
56+ if ($ this reportMissingFiles ) {
57+ stream_filter_register ('count.bytes ' , ByteCounterFilter::class);
58+ }
4759 }
4860
4961 /**
@@ -62,46 +74,79 @@ public function initialize(Server $server): void {
6274 }
6375
6476 /**
65- * @return iterable<NcNode>
77+ * Adding a node to the archive streamer.
78+ * @return ?string an error message if an error occurred and reporting is enabled, null otherwise
6679 */
67- protected function createIterator (array $ rootNodesiterable {
68- foreach ($ rootNodesas $ rootNode
69- yield from $ this iterateNodes ($ rootNode
80+ protected function streamNode (Streamer $ streamerNcNode $ nodestring $ rootPathstring {
81+ // Remove the root path from the filename to make it relative to the requested folder
82+ $ filenamestr_replace ($ rootPath'' , $ nodegetPath ());
83+
84+ $ mtime$ nodegetMTime ();
85+ if ($ nodeinstanceof NcFolder) {
86+ $ streameraddEmptyDir ($ filename$ mtime
87+ return null ;
7088 }
71- }
7289
73- /**
74- * Recursively iterate over all nodes in a folder.
75- * @return iterable<NcNode>
76- */
77- protected function iterateNodes (NcNode $ nodeiterable {
78- yield $ node
90+ if ($ nodeinstanceof NcFile) {
91+ $ nodeSize$ nodegetSize ();
92+ try {
93+ $ stream$ nodefopen ('rb ' );
94+ } catch (\Exception $ e
95+ // opening failed, log the failure as reason for the missing file
96+ if ($ this reportMissingFiles ) {
97+ $ exceptionClassget_class ($ e
98+ return $ this l10n ->t ('Error while opening the file: %s ' , [$ exceptionClass
99+ }
79100
80- if ($ nodeinstanceof NcFolder) {
81- foreach ($ nodegetDirectoryListing () as $ childNode
82- yield from $ this iterateNodes ($ childNode
101+ throw $ e
83102 }
103+
104+ if ($ this reportMissingFiles ) {
105+ if ($ streamfalse ) {
106+ return $ this l10n ->t ('File could not be opened (fopen). Please check the server logs for more information. ' );
107+ }
108+
109+ $ byteCounternew StreamByteCounter ();
110+ $ wrappedstream_filter_append ($ stream'count.bytes ' , STREAM_FILTER_READ , ['counter ' => $ byteCounter
111+ if ($ wrappedfalse ) {
112+ return $ this l10n ->t ('Unable to check file for consistency check ' );
113+ }
114+ }
115+
116+ $ fileAddedToStream$ streameraddFileFromStream ($ stream$ filename$ nodeSize$ mtime
117+ if ($ this reportMissingFiles ) {
118+ if (!$ fileAddedToStream
119+ return $ this l10n ->t ('The archive was already finalized ' );
120+ }
121+
122+ return $ this logStreamErrors ($ stream$ filename$ nodeSize$ byteCounterbytes );
123+ }
124+
84125 }
126+
127+ return null ;
85128 }
86129
87130 /**
88- * Adding a node to the archive streamer.
131+ * Checks whether $stream was fully streamed or if there were other issues
132+ * with the stream, logging the error if necessary.
133+ *
89134 */
90- protected function streamNode (Streamer $ streamerNcNode $ nodestring $ rootPathvoid {
91- // Remove the root path from the filename to make it relative to the requested folder
92- $ filenamestr_replace ($ rootPath'' , $ nodegetPath ());
135+ private function logStreamErrors (mixed $ streamstring $ pathfloat |int $ expectedFileSizefloat |int $ readFileSizestring {
136+ $ streamMetadatastream_get_meta_data ($ stream
137+ if (!is_resource ($ streamget_resource_type ($ stream'stream ' ) {
138+ return $ this l10n ->t ('Resource is not a stream or is closed. ' );
139+ }
93140
94- $ mtime$ nodegetMTime ();
95- if ($ nodeinstanceof NcFile) {
96- $ resource$ nodefopen ('rb ' );
97- if ($ resourcefalse ) {
98- $ this logger ->info ('Cannot read file for zip stream ' , ['filePath ' => $ nodegetPath ()]);
99- throw new \Sabre \DAV \Exception \ServiceUnavailable ('Requested file can currently not be accessed. ' );
100- }
101- $ streameraddFileFromStream ($ resource$ filename$ nodegetSize (), $ mtime
102- } elseif ($ nodeinstanceof NcFolder) {
103- $ streameraddEmptyDir ($ filename$ mtime
141+ if ($ streamMetadata'timed_out ' ] ?? false ) {
142+ return $ this l10n ->t ('Timeout while reading from stream. ' );
104143 }
144+
145+ if (!($ streamMetadata'eof ' ] ?? true ) || $ readFileSize$ expectedFileSize
146+ return $ this l10n ->t ('Read %d out of %d bytes from storage. This means the connection may have been closed due to a network/storage error. ' , [$ expectedFileSize$ readFileSize
147+ }
148+
149+ return null ;
105150 }
106151
107152 /**
@@ -155,14 +200,7 @@ public function handleDownload(Request $request, Response $response): ?bool {
155200 }
156201
157202 $ folder$ nodegetNode ();
158- $ rootNodesempty ($ files$ foldergetDirectoryListing () : [];
159- foreach ($ filesas $ path
160- $ child$ nodegetChild ($ path
161- assert ($ childinstanceof Node);
162- $ rootNodes$ childgetNode ();
163- }
164-
165- $ eventnew BeforeZipCreatedEvent ($ folder$ files$ this createIterator ($ rootNodes
203+ $ eventnew BeforeZipCreatedEvent ($ folder$ files$ this reportMissingFiles );
166204 $ this eventDispatcher ->dispatchTyped ($ event
167205 if ((!$ eventisSuccessful ()) || $ eventgetErrorMessage () !== null ) {
168206 $ errorMessage$ eventgetErrorMessage ();
@@ -175,6 +213,17 @@ public function handleDownload(Request $request, Response $response): ?bool {
175213 throw new Forbidden ($ errorMessage
176214 }
177215
216+ // At this point either the event handlers did not block the download
217+ // or they support the new mechanism that filters out nodes that are not
218+ // downloadable, in either case we can use the new API to set the iterator
219+ $ contentempty ($ files$ foldergetDirectoryListing () : [];
220+ foreach ($ filesas $ path
221+ $ child$ nodegetChild ($ path
222+ assert ($ childinstanceof Node);
223+ $ content$ childgetNode ();
224+ }
225+ $ eventsetNodesIterable ($ this getIterableFromNodes ($ content
226+
178227 $ archiveName$ foldergetName ();
179228 if (count (explode ('/ ' , trim ($ foldergetPath (), '/ ' ), 3 )) === 2 ) {
180229 // this is a download of the root folder
@@ -187,31 +236,71 @@ public function handleDownload(Request $request, Response $response): ?bool {
187236 $ rootPathdirname ($ foldergetPath ());
188237 }
189238
190- $ streamernew Streamer ($ tarRequest1 , count ($ rootNodes$ this timezoneFactory );
239+ // numberOfFiles is irrelevant as size=-1 forces the use of zip64 already
240+ $ streamernew Streamer ($ tarRequest1 , 0 , $ this timezoneFactory );
191241 $ streamersendHeaders ($ archiveName
192242 // For full folder downloads we also add the folder itself to the archive
193243 if (empty ($ files
194244 $ streameraddEmptyDir ($ archiveName
195245 }
196- foreach ($ eventgetNodes () as $ node
197- $ this streamNode ($ streamer$ node$ rootPath
246+
247+ foreach ($ eventgetNodes () as $ path$ node$ reason
248+ $ filenamestr_replace ($ rootPath'' , $ path
249+ if ($ nodenull ) {
250+ if ($ this reportMissingFiles ) {
251+ $ this missingInfo [$ filename$ reason
252+ }
253+ continue ;
254+ }
255+
256+ $ streamError$ this streamNode ($ streamer$ node$ rootPath
257+ if ($ this reportMissingFiles && $ streamErrornull ) {
258+ $ this missingInfo [$ filename$ streamError
259+ }
260+ }
261+
262+ if ($ this reportMissingFiles && !empty ($ this missingInfo )) {
263+ $ jsonjson_encode ($ this missingInfo , JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT );
264+ $ streamfopen ('php://temp ' , 'r+ ' );
265+ fwrite ($ stream$ json
266+ rewind ($ stream
267+ $ streameraddFileFromStream ($ stream'missing_files.json ' , (float )strlen ($ jsonfalse );
198268 }
199269 $ streamerfinalize ();
200270 return false ;
201271 }
202272
203273 /**
204- * Tell sabre/dav not to trigger it's own response sending logic as the handleDownload will have already send the response
274+ * Given a set of nodes, produces a list of all nodes contained in them
275+ * recursively.
276+ *
277+ * @param NcNode[] $nodes
278+ * @return iterable<NcNode>
279+ */
280+ private function getIterableFromNodes (array $ nodesiterable {
281+ foreach ($ nodesas $ node
282+ yield $ node
283+
284+ if ($ nodeinstanceof NcFolder) {
285+ foreach ($ nodegetDirectoryListing () as $ child
286+ yield from $ this getIterableFromNodes ([$ child
287+ }
288+ }
289+ }
290+ }
291+
292+ /**
293+ * Tell sabre/dav not to trigger its own response sending logic as the handleDownload will have already send the response
205294 *
206295 * @return false|null
207296 */
208297 public function afterDownload (Request $ requestResponse $ responsebool {
209298 $ node$ this tree ->getNodeForPath ($ requestgetPath ());
210- if (!( $ nodeinstanceof Directory) ) {
299+ if ($ nodeinstanceof Directory) {
211300 // only handle directories
212- return null ;
213- } else {
214301 return false ;
215302 }
303+
304+ return null ;
216305 }
217306}
0 commit comments