Skip to content

Commit

Permalink
Get rid of stream copy (close #60, close #134)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pulsejet
pulsejet committed Oct 31, 2022
1 parent 465df6d commit c98edee
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 169 deletions.
9 changes: 3 additions & 6 deletions lib/Command/Index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,23 +220,20 @@ protected function executeWithOpts(OutputInterface $output, bool &$refresh): int
private function testExif()
{
$testfile = __DIR__.'/../../exiftest.jpg';
$stream = fopen($testfile, 'r');
if (!$stream) {
error_log("Couldn't open Exif test file {$testfile}");
if (!file_exists($testfile)) {
error_log("Couldn't find Exif test file {$testfile}");

return false;
}

$exif = null;

try {
$exif = \OCA\Memories\Exif::getExifFromStream($stream);
$exif = \OCA\Memories\Exif::getExifFromLocalPath($testfile);
} catch (\Exception $e) {
error_log("Couldn't read Exif data from test file: ".$e->getMessage());

return false;
} finally {
fclose($stream);
}

if (!$exif) {
Expand Down
181 changes: 18 additions & 163 deletions lib/Exif.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,25 +104,12 @@ public static function removeLeadingSlash(string $path)
*/
public static function getExifFromFile(File &$file)
{
// Borrowed from previews
// https://github.com/nextcloud/server/blob/19f68b3011a3c040899fb84975a28bd746bddb4b/lib/private/Preview/ProviderV2.php
if (!$file->isEncrypted() && $file->getStorage()->isLocal()) {
$path = $file->getStorage()->getLocalFile($file->getInternalPath());
if (\is_string($path)) {
return self::getExifFromLocalPath($path);
}
}

// Fallback to reading as a stream
$handle = $file->fopen('rb');
if (!$handle) {
throw new \Exception('Could not open file');
$path = $file->getStorage()->getLocalFile($file->getInternalPath());
if (!\is_string($path)) {
throw new \Exception('Failed to get local file path');
}

$exif = self::getExifFromStream($handle);
fclose($handle);

return $exif;
return self::getExifFromLocalPath($path);
}

/** Get exif data as a JSON object from a local file path */
Expand All @@ -137,45 +124,6 @@ public static function getExifFromLocalPath(string &$path)
return self::getExifFromLocalPathWithSeparateProc($path);
}

/**
* Get exif data as a JSON object from a stream.
*
* @param resource $handle
*/
public static function getExifFromStream(&$handle)
{
// Start exiftool and output to json
$pipes = [];
$proc = proc_open(array_merge(self::getExiftool(), ['-api', 'QuickTimeUTC=1', '-n', '-json', '-fast', '-']), [
0 => ['pipe', 'rb'],
1 => ['pipe', 'w'],
2 => ['pipe', 'w'],
], $pipes);

// Write the file to exiftool's stdin
// Warning: this is slow for big files
// Copy a maximum of 20MB; this may be $$$
stream_copy_to_stream($handle, $pipes[0], 20 * 1024 * 1024);
fclose($pipes[0]);

// Get output from exiftool
stream_set_blocking($pipes[1], false);

try {
$stdout = self::readOrTimeout($pipes[1], 5000);

return self::processStdout($stdout);
} catch (\Exception $ex) {
error_log('Exiftool timeout for file stream: '.$ex->getMessage());

throw new \Exception('Could not read from Exiftool');
} finally {
fclose($pipes[1]);
fclose($pipes[2]);
proc_terminate($proc);
}
}

/**
* Parse date from exif format and throw error if invalid.
*
Expand Down Expand Up @@ -283,114 +231,23 @@ public static function getDimensions(array &$exif)
*/
public static function updateExifDate(File &$file, string $newDate)
{
// Check for local files -- this is easier
if (!$file->isEncrypted() && $file->getStorage()->isLocal()) {
$path = $file->getStorage()->getLocalFile($file->getInternalPath());
if (\is_string($path)) {
return self::updateExifDateForLocalFile($path, $newDate);
}
// Don't want to mess these up, definitely
if ($file->isEncrypted()) {
throw new \Exception('Cannot update exif date on encrypted files');
}

// Use a stream
return self::updateExifDateForStreamFile($file, $newDate);
}

/**
* Update exif date for stream.
*
* @param string $newDate formatted in standard Exif format (YYYY:MM:DD HH:MM:SS)
*/
public static function updateExifDateForStreamFile(File &$file, string $newDate)
{
// Temp file for output, so we can compare sizes before writing to the actual file
$tmpfile = tmpfile();

try {
// Start exiftool and output to json
$pipes = [];
$proc = proc_open(array_merge(self::getExiftool(), [
'-api', 'QuickTimeUTC=1',
'-overwrite_original', '-DateTimeOriginal='.$newDate, '-',
]), [
0 => ['pipe', 'rb'],
1 => ['pipe', 'w'],
2 => ['pipe', 'w'],
], $pipes);

// Write the file to exiftool's stdin
// Warning: this is slow for big files
$in = $file->fopen('rb');
if (!$in) {
throw new \Exception('Could not open file');
}
$origLen = stream_copy_to_stream($in, $pipes[0]);
fclose($in);
fclose($pipes[0]);

// Get output from exiftool
stream_set_blocking($pipes[1], false);
$newLen = 0;

try {
// Read and copy stdout of exiftool to the temp file
$waitedMs = 0;
$timeout = 300000;
while ($waitedMs < $timeout && !feof($pipes[1])) {
$r = stream_copy_to_stream($pipes[1], $tmpfile, 1024 * 1024);
$newLen += $r;
if (0 === $r) {
++$waitedMs;
usleep(1000);

continue;
}
}
if ($waitedMs >= $timeout) {
throw new \Exception('Timeout');
}
} catch (\Exception $ex) {
error_log('Exiftool timeout for file stream: '.$ex->getMessage());

throw new \Exception('Could not read from Exiftool');
} finally {
// Close the pipes
fclose($pipes[1]);
fclose($pipes[2]);
proc_terminate($proc);
}

// Check the new length of the file
// If the new length and old length are more different than 1KB, abort
if (abs($newLen - $origLen) > 1024) {
error_log("Exiftool error: new length {$newLen}, old length {$origLen}");

throw new \Exception("Exiftool error: new length {$newLen}, old length {$origLen}");
}

// Write the temp file to the actual file
fseek($tmpfile, 0);
$out = $file->fopen('wb');
if (!$out) {
throw new \Exception('Could not open file for writing');
}
$wroteBytes = 0;
// Get path to local (copy) of the file
$path = $file->getStorage()->getLocalFile($file->getInternalPath());
if (!\is_string($path)) {
throw new \Exception('Failed to get local file path');
}

try {
$wroteBytes = stream_copy_to_stream($tmpfile, $out);
} finally {
fclose($out);
}
if ($wroteBytes !== $newLen) {
error_log("Exiftool error: wrote {$r} bytes, expected {$newLen}");
// Update exif data
self::updateExifDateForLocalFile($path, $newDate);

throw new \Exception('Could not write to file');
}

// All done at this point
return true;
} finally {
// Close the temp file
fclose($tmpfile);
// Update remote file if not local
if (!$file->getStorage()->isLocal()) {
$file->putContent(fopen($path, 'r')); // closes the handler
}
}

Expand Down Expand Up @@ -574,7 +431,7 @@ private static function processStdout(string &$stdout)
*
* @param string $newDate formatted in standard Exif format (YYYY:MM:DD HH:MM:SS)
*
* @return bool
* @throws \Exception on failure
*/
private static function updateExifDateForLocalFile(string $path, string $newDate)
{
Expand All @@ -592,7 +449,5 @@ private static function updateExifDateForLocalFile(string $path, string $newDate

throw new \Exception('Could not update exif date: '.$stdout);
}

return true;
}
}

0 comments on commit c98edee

Please sign in to comment.