OCA\Music\Hooks\FileHooks

Complexity

Total Complexity

17

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	updated()	0	19	3
A	deleted()	0	9	2
A	__construct()	0	2	1
A	userHasMusicLib()	0	3	1
A	postRenamed()	0	6	1
A	register()	0	5	1
A	handleUpdated()	0	18	6
A	preRenamed()	0	6	2

<?php declare(strict_types=1);

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Pauli Järvinen <pauli.jarvinen@gmail.com>
 * @copyright Morris Jobke 2014
 * @copyright Pauli Järvinen 2017 - 2021
 */

namespace OCA\Music\Hooks;

use OCP\AppFramework\IAppContainer;
use OCP\Files\FileInfo;
use OCP\Files\Node;

use OCA\Music\App\Music;

class FileHooks {
	private $filesystemRoot;

	public function __construct($filesystemRoot) {
		$this->filesystemRoot = $filesystemRoot;
	}

	/**
	 * Invoke auto update of music database after file or folder deletion
	 * @param Node $node pointing to the file or folder
	 */
	public static function deleted(Node $node) {
		$app = \OC::$server->query(Music::class);
		$container = $app->getContainer();
		$scanner = $container->query('Scanner');

		if ($node->getType() == FileInfo::TYPE_FILE) {
			$scanner->delete($node->getId());
		} else {
			$scanner->deleteFolder($node);
		}
	}

	/**
	 * Invoke auto update of music database after file update or file creation
	 * @param Node $node pointing to the file
	 */
	public static function updated(Node $node) {
		// At least on Nextcloud 13, it sometimes happens that this hook is triggered
		// when the core creates some temporary file and trying to access the provided
		// node throws an exception, probably because the temp file is already removed
		// by the time the execution gets here. See #636.
		// Furthermore, when the core opens a file in stream mode for writing using
		// File::fopen, this hook gets triggered immediately after the opening succeeds,
		// before anything is actually written and while the file is *exlusively locked
		// because of the write mode*. See #638.
		$app = \OC::$server->query(Music::class);
		$container = $app->getContainer();
		try {
			self::handleUpdated($node, $container);
		} catch (\OCP\Files\NotFoundException $e) {
			$logger = $container->query('Logger');
			$logger->log('FileHooks::updated triggered for a non-existing file', 'warn');
		} catch (\OCP\Lock\LockedException $e) {
			$logger = $container->query('Logger');
			$logger->log('FileHooks::updated triggered for a locked file ' . $node->getName(), 'warn');
		}
	}

	private static function handleUpdated(Node $node, IAppContainer $container) {
		// we are interested only about updates on files, not on folders
		if ($node->getType() == FileInfo::TYPE_FILE) {
			$scanner = $container->query('Scanner');
			$userId = $container->query('UserId');

			// When a file is uploaded to a folder shared by link, we end up here without current user.
			// In that case, fall back to using file owner
			if (empty($userId)) {
				$owner = $node->getOwner();
				$userId = $owner ? $owner->getUID() : null; // @phpstan-ignore-line At least some versions of NC may violate their PhpDoc and return null owner

$owner is of type OCP\IUser, thus it always evaluated to true.

			}

			// Ignore event if we got no user or folder or the user has not yet scanned the music
			// collection. The last condition is especially to prevent problems when creating new user
			// and the default file set contains one or more audio files (see the discussion in #638).
			if (!empty($userId) && self::userHasMusicLib($userId, $container)) {
				$scanner->update($node, $userId, $node->getPath());
			}
		}
	}

	/**
	 * Check if user has any scanned tracks in his/her music library
	 * @param string $userId
	 * @param IAppContainer $container
	 */
	private static function userHasMusicLib(string $userId, IAppContainer $container) {
		$trackBusinessLayer = $container->query('TrackBusinessLayer');
		return 0 < $trackBusinessLayer->count($userId);
	}

	public static function preRenamed(Node $source, Node $target) {
		// We are interested only if the path of the folder of the file changes:
		// that could move a music file out of the scanned folder or remove a
		// cover image file from album folder.
		if ($source->getParent()->getId() != $target->getParent()->getId()) {
			self::deleted($source);
			// $target here doesn't point to an existing file, hence we need also
			// the postRenamed hook
		}
	}

	public static function postRenamed(Node $source, Node $target) {
		// Renaming/moving file may
		// a) move it into the folder scanned by Music app
		// b) have influence on the display name of the track
		// Both of these cases can be handled like file addition/modification.
		self::updated($target);
	}

	public function register() {
		$this->filesystemRoot->listen('\OC\Files', 'postWrite', [__CLASS__, 'updated']);
		$this->filesystemRoot->listen('\OC\Files', 'preDelete', [__CLASS__, 'deleted']);
		$this->filesystemRoot->listen('\OC\Files', 'preRename', [__CLASS__, 'preRenamed']);
		$this->filesystemRoot->listen('\OC\Files', 'postRename', [__CLASS__, 'postRenamed']);
	}
}