| @@ -21,7 +21,6 @@ | ||
| 21 | 21 | namespace OCA\DAV\CardDAV\Xml; | 
| 22 | 22 | |
| 23 | 23 | use Sabre\Xml\XmlSerializable; | 
| 24 | -use Sabre\Xml\Element; | |
| 25 | 24 | use Sabre\Xml\Writer; | 
| 26 | 25 | |
| 27 | 26 |  class Groups implements XmlSerializable { | 
| @@ -26,21 +26,21 @@ | ||
| 26 | 26 | use Sabre\Xml\Writer; | 
| 27 | 27 | |
| 28 | 28 |  class Groups implements XmlSerializable { | 
| 29 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 29 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 30 | 30 | |
| 31 | - /** @var string[] of TYPE:CHECKSUM */ | |
| 32 | - private $groups; | |
| 31 | + /** @var string[] of TYPE:CHECKSUM */ | |
| 32 | + private $groups; | |
| 33 | 33 | |
| 34 | - /** | |
| 35 | - * @param string $groups | |
| 36 | - */ | |
| 37 | -	public function __construct($groups) { | |
| 38 | - $this->groups = $groups; | |
| 39 | - } | |
| 34 | + /** | |
| 35 | + * @param string $groups | |
| 36 | + */ | |
| 37 | +    public function __construct($groups) { | |
| 38 | + $this->groups = $groups; | |
| 39 | + } | |
| 40 | 40 | |
| 41 | -	function xmlSerialize(Writer $writer) { | |
| 42 | -		foreach ($this->groups as $group) { | |
| 43 | -			$writer->writeElement('{' . self::NS_OWNCLOUD . '}group', $group); | |
| 44 | - } | |
| 45 | - } | |
| 41 | +    function xmlSerialize(Writer $writer) { | |
| 42 | +        foreach ($this->groups as $group) { | |
| 43 | +            $writer->writeElement('{' . self::NS_OWNCLOUD . '}group', $group); | |
| 44 | + } | |
| 45 | + } | |
| 46 | 46 | } | 
| @@ -40,7 +40,7 @@ | ||
| 40 | 40 | |
| 41 | 41 |  	function xmlSerialize(Writer $writer) { | 
| 42 | 42 |  		foreach ($this->groups as $group) { | 
| 43 | -			$writer->writeElement('{' . self::NS_OWNCLOUD . '}group', $group); | |
| 43 | +			$writer->writeElement('{'.self::NS_OWNCLOUD.'}group', $group); | |
| 44 | 44 | } | 
| 45 | 45 | } | 
| 46 | 46 | } | 
| @@ -22,11 +22,6 @@ | ||
| 22 | 22 | namespace OCA\DAV\Command; | 
| 23 | 23 | |
| 24 | 24 | use OCA\DAV\CardDAV\CardDavBackend; | 
| 25 | -use OCA\DAV\Connector\Sabre\Principal; | |
| 26 | -use OCP\IConfig; | |
| 27 | -use OCP\IDBConnection; | |
| 28 | -use OCP\IGroupManager; | |
| 29 | -use OCP\ILogger; | |
| 30 | 25 | use OCP\IUserManager; | 
| 31 | 26 | use Symfony\Component\Console\Command\Command; | 
| 32 | 27 | use Symfony\Component\Console\Input\InputArgument; | 
| @@ -36,43 +36,43 @@ | ||
| 36 | 36 | |
| 37 | 37 |  class CreateAddressBook extends Command { | 
| 38 | 38 | |
| 39 | - /** @var IUserManager */ | |
| 40 | - private $userManager; | |
| 39 | + /** @var IUserManager */ | |
| 40 | + private $userManager; | |
| 41 | 41 | |
| 42 | - /** @var CardDavBackend */ | |
| 43 | - private $cardDavBackend; | |
| 42 | + /** @var CardDavBackend */ | |
| 43 | + private $cardDavBackend; | |
| 44 | 44 | |
| 45 | - /** | |
| 46 | - * @param IUserManager $userManager | |
| 47 | - * @param CardDavBackend $cardDavBackend | |
| 48 | - */ | |
| 49 | - function __construct(IUserManager $userManager, | |
| 50 | - CardDavBackend $cardDavBackend | |
| 51 | -	) { | |
| 52 | - parent::__construct(); | |
| 53 | - $this->userManager = $userManager; | |
| 54 | - $this->cardDavBackend = $cardDavBackend; | |
| 55 | - } | |
| 45 | + /** | |
| 46 | + * @param IUserManager $userManager | |
| 47 | + * @param CardDavBackend $cardDavBackend | |
| 48 | + */ | |
| 49 | + function __construct(IUserManager $userManager, | |
| 50 | + CardDavBackend $cardDavBackend | |
| 51 | +    ) { | |
| 52 | + parent::__construct(); | |
| 53 | + $this->userManager = $userManager; | |
| 54 | + $this->cardDavBackend = $cardDavBackend; | |
| 55 | + } | |
| 56 | 56 | |
| 57 | -	protected function configure() { | |
| 58 | - $this | |
| 59 | -				->setName('dav:create-addressbook') | |
| 60 | -				->setDescription('Create a dav addressbook') | |
| 61 | -				->addArgument('user', | |
| 62 | - InputArgument::REQUIRED, | |
| 63 | - 'User for whom the addressbook will be created') | |
| 64 | -				->addArgument('name', | |
| 65 | - InputArgument::REQUIRED, | |
| 66 | - 'Name of the addressbook'); | |
| 67 | - } | |
| 57 | +    protected function configure() { | |
| 58 | + $this | |
| 59 | +                ->setName('dav:create-addressbook') | |
| 60 | +                ->setDescription('Create a dav addressbook') | |
| 61 | +                ->addArgument('user', | |
| 62 | + InputArgument::REQUIRED, | |
| 63 | + 'User for whom the addressbook will be created') | |
| 64 | +                ->addArgument('name', | |
| 65 | + InputArgument::REQUIRED, | |
| 66 | + 'Name of the addressbook'); | |
| 67 | + } | |
| 68 | 68 | |
| 69 | -	protected function execute(InputInterface $input, OutputInterface $output) { | |
| 70 | -		$user = $input->getArgument('user'); | |
| 71 | -		if (!$this->userManager->userExists($user)) { | |
| 72 | -			throw new \InvalidArgumentException("User <$user> in unknown."); | |
| 73 | - } | |
| 69 | +    protected function execute(InputInterface $input, OutputInterface $output) { | |
| 70 | +        $user = $input->getArgument('user'); | |
| 71 | +        if (!$this->userManager->userExists($user)) { | |
| 72 | +            throw new \InvalidArgumentException("User <$user> in unknown."); | |
| 73 | + } | |
| 74 | 74 | |
| 75 | -		$name = $input->getArgument('name'); | |
| 76 | -		$this->cardDavBackend->createAddressBook("principals/users/$user", $name, []); | |
| 77 | - } | |
| 75 | +        $name = $input->getArgument('name'); | |
| 76 | +        $this->cardDavBackend->createAddressBook("principals/users/$user", $name, []); | |
| 77 | + } | |
| 78 | 78 | } | 
| @@ -21,10 +21,8 @@ | ||
| 21 | 21 | namespace OCA\DAV\Command; | 
| 22 | 22 | |
| 23 | 23 | use OCA\DAV\CardDAV\SyncService; | 
| 24 | -use OCP\IUserManager; | |
| 25 | 24 | use Symfony\Component\Console\Command\Command; | 
| 26 | 25 | use Symfony\Component\Console\Helper\ProgressBar; | 
| 27 | -use Symfony\Component\Console\Input\InputArgument; | |
| 28 | 26 | use Symfony\Component\Console\Input\InputInterface; | 
| 29 | 27 | use Symfony\Component\Console\Output\OutputInterface; | 
| 30 | 28 | |
| @@ -31,36 +31,36 @@ | ||
| 31 | 31 | |
| 32 | 32 |  class SyncSystemAddressBook extends Command { | 
| 33 | 33 | |
| 34 | - /** @var SyncService */ | |
| 35 | - private $syncService; | |
| 34 | + /** @var SyncService */ | |
| 35 | + private $syncService; | |
| 36 | 36 | |
| 37 | - /** | |
| 38 | - * @param SyncService $syncService | |
| 39 | - */ | |
| 40 | -	function __construct(SyncService $syncService) { | |
| 41 | - parent::__construct(); | |
| 42 | - $this->syncService = $syncService; | |
| 43 | - } | |
| 37 | + /** | |
| 38 | + * @param SyncService $syncService | |
| 39 | + */ | |
| 40 | +    function __construct(SyncService $syncService) { | |
| 41 | + parent::__construct(); | |
| 42 | + $this->syncService = $syncService; | |
| 43 | + } | |
| 44 | 44 | |
| 45 | -	protected function configure() { | |
| 46 | - $this | |
| 47 | -			->setName('dav:sync-system-addressbook') | |
| 48 | -			->setDescription('Synchronizes users to the system addressbook'); | |
| 49 | - } | |
| 45 | +    protected function configure() { | |
| 46 | + $this | |
| 47 | +            ->setName('dav:sync-system-addressbook') | |
| 48 | +            ->setDescription('Synchronizes users to the system addressbook'); | |
| 49 | + } | |
| 50 | 50 | |
| 51 | - /** | |
| 52 | - * @param InputInterface $input | |
| 53 | - * @param OutputInterface $output | |
| 54 | - */ | |
| 55 | -	protected function execute(InputInterface $input, OutputInterface $output) { | |
| 56 | -		$output->writeln('Syncing users ...'); | |
| 57 | - $progress = new ProgressBar($output); | |
| 58 | - $progress->start(); | |
| 59 | -		$this->syncService->syncInstance(function() use ($progress) { | |
| 60 | - $progress->advance(); | |
| 61 | - }); | |
| 51 | + /** | |
| 52 | + * @param InputInterface $input | |
| 53 | + * @param OutputInterface $output | |
| 54 | + */ | |
| 55 | +    protected function execute(InputInterface $input, OutputInterface $output) { | |
| 56 | +        $output->writeln('Syncing users ...'); | |
| 57 | + $progress = new ProgressBar($output); | |
| 58 | + $progress->start(); | |
| 59 | +        $this->syncService->syncInstance(function() use ($progress) { | |
| 60 | + $progress->advance(); | |
| 61 | + }); | |
| 62 | 62 | |
| 63 | - $progress->finish(); | |
| 64 | -		$output->writeln(''); | |
| 65 | - } | |
| 63 | + $progress->finish(); | |
| 64 | +        $output->writeln(''); | |
| 65 | + } | |
| 66 | 66 | } | 
| @@ -93,7 +93,7 @@ | ||
| 93 | 93 | /** | 
| 94 | 94 | * returns a list of all possible property names | 
| 95 | 95 | * | 
| 96 | - * @return array | |
| 96 | + * @return string[] | |
| 97 | 97 | */ | 
| 98 | 98 |  	static public function getPropertyNames() { | 
| 99 | 99 | return [ | 
| @@ -36,270 +36,270 @@ | ||
| 36 | 36 | use Sabre\DAV\PropPatch; | 
| 37 | 37 | |
| 38 | 38 |  class CommentNode implements \Sabre\DAV\INode, \Sabre\DAV\IProperties { | 
| 39 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 39 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 40 | 40 | |
| 41 | -	const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread'; | |
| 42 | -	const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message'; | |
| 43 | -	const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName'; | |
| 44 | -	const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions'; | |
| 45 | -	const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention'; | |
| 46 | -	const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType'; | |
| 47 | -	const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId'; | |
| 48 | -	const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName'; | |
| 41 | +    const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}isUnread'; | |
| 42 | +    const PROPERTY_NAME_MESSAGE = '{http://owncloud.org/ns}message'; | |
| 43 | +    const PROPERTY_NAME_ACTOR_DISPLAYNAME = '{http://owncloud.org/ns}actorDisplayName'; | |
| 44 | +    const PROPERTY_NAME_MENTIONS = '{http://owncloud.org/ns}mentions'; | |
| 45 | +    const PROPERTY_NAME_MENTION = '{http://owncloud.org/ns}mention'; | |
| 46 | +    const PROPERTY_NAME_MENTION_TYPE = '{http://owncloud.org/ns}mentionType'; | |
| 47 | +    const PROPERTY_NAME_MENTION_ID = '{http://owncloud.org/ns}mentionId'; | |
| 48 | +    const PROPERTY_NAME_MENTION_DISPLAYNAME = '{http://owncloud.org/ns}mentionDisplayName'; | |
| 49 | 49 | |
| 50 | - /** @var IComment */ | |
| 51 | - public $comment; | |
| 50 | + /** @var IComment */ | |
| 51 | + public $comment; | |
| 52 | 52 | |
| 53 | - /** @var ICommentsManager */ | |
| 54 | - protected $commentsManager; | |
| 53 | + /** @var ICommentsManager */ | |
| 54 | + protected $commentsManager; | |
| 55 | 55 | |
| 56 | - /** @var ILogger */ | |
| 57 | - protected $logger; | |
| 56 | + /** @var ILogger */ | |
| 57 | + protected $logger; | |
| 58 | 58 | |
| 59 | - /** @var array list of properties with key being their name and value their setter */ | |
| 60 | - protected $properties = []; | |
| 59 | + /** @var array list of properties with key being their name and value their setter */ | |
| 60 | + protected $properties = []; | |
| 61 | 61 | |
| 62 | - /** @var IUserManager */ | |
| 63 | - protected $userManager; | |
| 62 | + /** @var IUserManager */ | |
| 63 | + protected $userManager; | |
| 64 | 64 | |
| 65 | - /** @var IUserSession */ | |
| 66 | - protected $userSession; | |
| 65 | + /** @var IUserSession */ | |
| 66 | + protected $userSession; | |
| 67 | 67 | |
| 68 | - /** | |
| 69 | - * CommentNode constructor. | |
| 70 | - * | |
| 71 | - * @param ICommentsManager $commentsManager | |
| 72 | - * @param IComment $comment | |
| 73 | - * @param IUserManager $userManager | |
| 74 | - * @param IUserSession $userSession | |
| 75 | - * @param ILogger $logger | |
| 76 | - */ | |
| 77 | - public function __construct( | |
| 78 | - ICommentsManager $commentsManager, | |
| 79 | - IComment $comment, | |
| 80 | - IUserManager $userManager, | |
| 81 | - IUserSession $userSession, | |
| 82 | - ILogger $logger | |
| 83 | -	) { | |
| 84 | - $this->commentsManager = $commentsManager; | |
| 85 | - $this->comment = $comment; | |
| 86 | - $this->logger = $logger; | |
| 68 | + /** | |
| 69 | + * CommentNode constructor. | |
| 70 | + * | |
| 71 | + * @param ICommentsManager $commentsManager | |
| 72 | + * @param IComment $comment | |
| 73 | + * @param IUserManager $userManager | |
| 74 | + * @param IUserSession $userSession | |
| 75 | + * @param ILogger $logger | |
| 76 | + */ | |
| 77 | + public function __construct( | |
| 78 | + ICommentsManager $commentsManager, | |
| 79 | + IComment $comment, | |
| 80 | + IUserManager $userManager, | |
| 81 | + IUserSession $userSession, | |
| 82 | + ILogger $logger | |
| 83 | +    ) { | |
| 84 | + $this->commentsManager = $commentsManager; | |
| 85 | + $this->comment = $comment; | |
| 86 | + $this->logger = $logger; | |
| 87 | 87 | |
| 88 | - $methods = get_class_methods($this->comment); | |
| 89 | -		$methods = array_filter($methods, function($name){ | |
| 90 | - return strpos($name, 'get') === 0; | |
| 91 | - }); | |
| 92 | -		foreach($methods as $getter) { | |
| 93 | -			if($getter === 'getMentions') { | |
| 94 | - continue; // special treatment | |
| 95 | - } | |
| 96 | -			$name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3)); | |
| 97 | - $this->properties[$name] = $getter; | |
| 98 | - } | |
| 99 | - $this->userManager = $userManager; | |
| 100 | - $this->userSession = $userSession; | |
| 101 | - } | |
| 88 | + $methods = get_class_methods($this->comment); | |
| 89 | +        $methods = array_filter($methods, function($name){ | |
| 90 | + return strpos($name, 'get') === 0; | |
| 91 | + }); | |
| 92 | +        foreach($methods as $getter) { | |
| 93 | +            if($getter === 'getMentions') { | |
| 94 | + continue; // special treatment | |
| 95 | + } | |
| 96 | +            $name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3)); | |
| 97 | + $this->properties[$name] = $getter; | |
| 98 | + } | |
| 99 | + $this->userManager = $userManager; | |
| 100 | + $this->userSession = $userSession; | |
| 101 | + } | |
| 102 | 102 | |
| 103 | - /** | |
| 104 | - * returns a list of all possible property names | |
| 105 | - * | |
| 106 | - * @return array | |
| 107 | - */ | |
| 108 | -	static public function getPropertyNames() { | |
| 109 | - return [ | |
| 110 | -			'{http://owncloud.org/ns}id', | |
| 111 | -			'{http://owncloud.org/ns}parentId', | |
| 112 | -			'{http://owncloud.org/ns}topmostParentId', | |
| 113 | -			'{http://owncloud.org/ns}childrenCount', | |
| 114 | -			'{http://owncloud.org/ns}verb', | |
| 115 | -			'{http://owncloud.org/ns}actorType', | |
| 116 | -			'{http://owncloud.org/ns}actorId', | |
| 117 | -			'{http://owncloud.org/ns}creationDateTime', | |
| 118 | -			'{http://owncloud.org/ns}latestChildDateTime', | |
| 119 | -			'{http://owncloud.org/ns}objectType', | |
| 120 | -			'{http://owncloud.org/ns}objectId', | |
| 121 | - // re-used property names are defined as constants | |
| 122 | - self::PROPERTY_NAME_MESSAGE, | |
| 123 | - self::PROPERTY_NAME_ACTOR_DISPLAYNAME, | |
| 124 | - self::PROPERTY_NAME_UNREAD, | |
| 125 | - self::PROPERTY_NAME_MENTIONS, | |
| 126 | - self::PROPERTY_NAME_MENTION, | |
| 127 | - self::PROPERTY_NAME_MENTION_TYPE, | |
| 128 | - self::PROPERTY_NAME_MENTION_ID, | |
| 129 | - self::PROPERTY_NAME_MENTION_DISPLAYNAME, | |
| 130 | - ]; | |
| 131 | - } | |
| 103 | + /** | |
| 104 | + * returns a list of all possible property names | |
| 105 | + * | |
| 106 | + * @return array | |
| 107 | + */ | |
| 108 | +    static public function getPropertyNames() { | |
| 109 | + return [ | |
| 110 | +            '{http://owncloud.org/ns}id', | |
| 111 | +            '{http://owncloud.org/ns}parentId', | |
| 112 | +            '{http://owncloud.org/ns}topmostParentId', | |
| 113 | +            '{http://owncloud.org/ns}childrenCount', | |
| 114 | +            '{http://owncloud.org/ns}verb', | |
| 115 | +            '{http://owncloud.org/ns}actorType', | |
| 116 | +            '{http://owncloud.org/ns}actorId', | |
| 117 | +            '{http://owncloud.org/ns}creationDateTime', | |
| 118 | +            '{http://owncloud.org/ns}latestChildDateTime', | |
| 119 | +            '{http://owncloud.org/ns}objectType', | |
| 120 | +            '{http://owncloud.org/ns}objectId', | |
| 121 | + // re-used property names are defined as constants | |
| 122 | + self::PROPERTY_NAME_MESSAGE, | |
| 123 | + self::PROPERTY_NAME_ACTOR_DISPLAYNAME, | |
| 124 | + self::PROPERTY_NAME_UNREAD, | |
| 125 | + self::PROPERTY_NAME_MENTIONS, | |
| 126 | + self::PROPERTY_NAME_MENTION, | |
| 127 | + self::PROPERTY_NAME_MENTION_TYPE, | |
| 128 | + self::PROPERTY_NAME_MENTION_ID, | |
| 129 | + self::PROPERTY_NAME_MENTION_DISPLAYNAME, | |
| 130 | + ]; | |
| 131 | + } | |
| 132 | 132 | |
| 133 | -	protected function checkWriteAccessOnComment() { | |
| 134 | - $user = $this->userSession->getUser(); | |
| 135 | - if( $this->comment->getActorType() !== 'users' | |
| 136 | - || is_null($user) | |
| 137 | - || $this->comment->getActorId() !== $user->getUID() | |
| 138 | -		) { | |
| 139 | -			throw new Forbidden('Only authors are allowed to edit their comment.'); | |
| 140 | - } | |
| 141 | - } | |
| 133 | +    protected function checkWriteAccessOnComment() { | |
| 134 | + $user = $this->userSession->getUser(); | |
| 135 | + if( $this->comment->getActorType() !== 'users' | |
| 136 | + || is_null($user) | |
| 137 | + || $this->comment->getActorId() !== $user->getUID() | |
| 138 | +        ) { | |
| 139 | +            throw new Forbidden('Only authors are allowed to edit their comment.'); | |
| 140 | + } | |
| 141 | + } | |
| 142 | 142 | |
| 143 | - /** | |
| 144 | - * Deleted the current node | |
| 145 | - * | |
| 146 | - * @return void | |
| 147 | - */ | |
| 148 | -	function delete() { | |
| 149 | - $this->checkWriteAccessOnComment(); | |
| 150 | - $this->commentsManager->delete($this->comment->getId()); | |
| 151 | - } | |
| 143 | + /** | |
| 144 | + * Deleted the current node | |
| 145 | + * | |
| 146 | + * @return void | |
| 147 | + */ | |
| 148 | +    function delete() { | |
| 149 | + $this->checkWriteAccessOnComment(); | |
| 150 | + $this->commentsManager->delete($this->comment->getId()); | |
| 151 | + } | |
| 152 | 152 | |
| 153 | - /** | |
| 154 | - * Returns the name of the node. | |
| 155 | - * | |
| 156 | - * This is used to generate the url. | |
| 157 | - * | |
| 158 | - * @return string | |
| 159 | - */ | |
| 160 | -	function getName() { | |
| 161 | - return $this->comment->getId(); | |
| 162 | - } | |
| 153 | + /** | |
| 154 | + * Returns the name of the node. | |
| 155 | + * | |
| 156 | + * This is used to generate the url. | |
| 157 | + * | |
| 158 | + * @return string | |
| 159 | + */ | |
| 160 | +    function getName() { | |
| 161 | + return $this->comment->getId(); | |
| 162 | + } | |
| 163 | 163 | |
| 164 | - /** | |
| 165 | - * Renames the node | |
| 166 | - * | |
| 167 | - * @param string $name The new name | |
| 168 | - * @throws MethodNotAllowed | |
| 169 | - */ | |
| 170 | -	function setName($name) { | |
| 171 | - throw new MethodNotAllowed(); | |
| 172 | - } | |
| 164 | + /** | |
| 165 | + * Renames the node | |
| 166 | + * | |
| 167 | + * @param string $name The new name | |
| 168 | + * @throws MethodNotAllowed | |
| 169 | + */ | |
| 170 | +    function setName($name) { | |
| 171 | + throw new MethodNotAllowed(); | |
| 172 | + } | |
| 173 | 173 | |
| 174 | - /** | |
| 175 | - * Returns the last modification time, as a unix timestamp | |
| 176 | - * | |
| 177 | - * @return int | |
| 178 | - */ | |
| 179 | -	function getLastModified() { | |
| 180 | - return null; | |
| 181 | - } | |
| 174 | + /** | |
| 175 | + * Returns the last modification time, as a unix timestamp | |
| 176 | + * | |
| 177 | + * @return int | |
| 178 | + */ | |
| 179 | +    function getLastModified() { | |
| 180 | + return null; | |
| 181 | + } | |
| 182 | 182 | |
| 183 | - /** | |
| 184 | - * update the comment's message | |
| 185 | - * | |
| 186 | - * @param $propertyValue | |
| 187 | - * @return bool | |
| 188 | - * @throws BadRequest | |
| 189 | - * @throws \Exception | |
| 190 | - */ | |
| 191 | -	public function updateComment($propertyValue) { | |
| 192 | - $this->checkWriteAccessOnComment(); | |
| 193 | -		try { | |
| 194 | - $this->comment->setMessage($propertyValue); | |
| 195 | - $this->commentsManager->save($this->comment); | |
| 196 | - return true; | |
| 197 | -		} catch (\Exception $e) { | |
| 198 | - $this->logger->logException($e, ['app' => 'dav/comments']); | |
| 199 | -			if($e instanceof MessageTooLongException) { | |
| 200 | - $msg = 'Message exceeds allowed character limit of '; | |
| 201 | - throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 202 | - } | |
| 203 | - throw $e; | |
| 204 | - } | |
| 205 | - } | |
| 183 | + /** | |
| 184 | + * update the comment's message | |
| 185 | + * | |
| 186 | + * @param $propertyValue | |
| 187 | + * @return bool | |
| 188 | + * @throws BadRequest | |
| 189 | + * @throws \Exception | |
| 190 | + */ | |
| 191 | +    public function updateComment($propertyValue) { | |
| 192 | + $this->checkWriteAccessOnComment(); | |
| 193 | +        try { | |
| 194 | + $this->comment->setMessage($propertyValue); | |
| 195 | + $this->commentsManager->save($this->comment); | |
| 196 | + return true; | |
| 197 | +        } catch (\Exception $e) { | |
| 198 | + $this->logger->logException($e, ['app' => 'dav/comments']); | |
| 199 | +            if($e instanceof MessageTooLongException) { | |
| 200 | + $msg = 'Message exceeds allowed character limit of '; | |
| 201 | + throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 202 | + } | |
| 203 | + throw $e; | |
| 204 | + } | |
| 205 | + } | |
| 206 | 206 | |
| 207 | - /** | |
| 208 | - * Updates properties on this node. | |
| 209 | - * | |
| 210 | - * This method received a PropPatch object, which contains all the | |
| 211 | - * information about the update. | |
| 212 | - * | |
| 213 | - * To update specific properties, call the 'handle' method on this object. | |
| 214 | - * Read the PropPatch documentation for more information. | |
| 215 | - * | |
| 216 | - * @param PropPatch $propPatch | |
| 217 | - * @return void | |
| 218 | - */ | |
| 219 | -	function propPatch(PropPatch $propPatch) { | |
| 220 | - // other properties than 'message' are read only | |
| 221 | - $propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']); | |
| 222 | - } | |
| 207 | + /** | |
| 208 | + * Updates properties on this node. | |
| 209 | + * | |
| 210 | + * This method received a PropPatch object, which contains all the | |
| 211 | + * information about the update. | |
| 212 | + * | |
| 213 | + * To update specific properties, call the 'handle' method on this object. | |
| 214 | + * Read the PropPatch documentation for more information. | |
| 215 | + * | |
| 216 | + * @param PropPatch $propPatch | |
| 217 | + * @return void | |
| 218 | + */ | |
| 219 | +    function propPatch(PropPatch $propPatch) { | |
| 220 | + // other properties than 'message' are read only | |
| 221 | + $propPatch->handle(self::PROPERTY_NAME_MESSAGE, [$this, 'updateComment']); | |
| 222 | + } | |
| 223 | 223 | |
| 224 | - /** | |
| 225 | - * Returns a list of properties for this nodes. | |
| 226 | - * | |
| 227 | - * The properties list is a list of propertynames the client requested, | |
| 228 | -	 * encoded in clark-notation {xmlnamespace}tagname | |
| 229 | - * | |
| 230 | - * If the array is empty, it means 'all properties' were requested. | |
| 231 | - * | |
| 232 | - * Note that it's fine to liberally give properties back, instead of | |
| 233 | - * conforming to the list of requested properties. | |
| 234 | - * The Server class will filter out the extra. | |
| 235 | - * | |
| 236 | - * @param array $properties | |
| 237 | - * @return array | |
| 238 | - */ | |
| 239 | -	function getProperties($properties) { | |
| 240 | - $properties = array_keys($this->properties); | |
| 224 | + /** | |
| 225 | + * Returns a list of properties for this nodes. | |
| 226 | + * | |
| 227 | + * The properties list is a list of propertynames the client requested, | |
| 228 | +     * encoded in clark-notation {xmlnamespace}tagname | |
| 229 | + * | |
| 230 | + * If the array is empty, it means 'all properties' were requested. | |
| 231 | + * | |
| 232 | + * Note that it's fine to liberally give properties back, instead of | |
| 233 | + * conforming to the list of requested properties. | |
| 234 | + * The Server class will filter out the extra. | |
| 235 | + * | |
| 236 | + * @param array $properties | |
| 237 | + * @return array | |
| 238 | + */ | |
| 239 | +    function getProperties($properties) { | |
| 240 | + $properties = array_keys($this->properties); | |
| 241 | 241 | |
| 242 | - $result = []; | |
| 243 | -		foreach($properties as $property) { | |
| 244 | - $getter = $this->properties[$property]; | |
| 245 | -			if(method_exists($this->comment, $getter)) { | |
| 246 | - $result[$property] = $this->comment->$getter(); | |
| 247 | - } | |
| 248 | - } | |
| 242 | + $result = []; | |
| 243 | +        foreach($properties as $property) { | |
| 244 | + $getter = $this->properties[$property]; | |
| 245 | +            if(method_exists($this->comment, $getter)) { | |
| 246 | + $result[$property] = $this->comment->$getter(); | |
| 247 | + } | |
| 248 | + } | |
| 249 | 249 | |
| 250 | -		if($this->comment->getActorType() === 'users') { | |
| 251 | - $user = $this->userManager->get($this->comment->getActorId()); | |
| 252 | - $displayName = is_null($user) ? null : $user->getDisplayName(); | |
| 253 | - $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName; | |
| 254 | - } | |
| 250 | +        if($this->comment->getActorType() === 'users') { | |
| 251 | + $user = $this->userManager->get($this->comment->getActorId()); | |
| 252 | + $displayName = is_null($user) ? null : $user->getDisplayName(); | |
| 253 | + $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName; | |
| 254 | + } | |
| 255 | 255 | |
| 256 | - $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue(); | |
| 256 | + $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue(); | |
| 257 | 257 | |
| 258 | - $unread = null; | |
| 259 | - $user = $this->userSession->getUser(); | |
| 260 | -		if(!is_null($user)) { | |
| 261 | - $readUntil = $this->commentsManager->getReadMark( | |
| 262 | - $this->comment->getObjectType(), | |
| 263 | - $this->comment->getObjectId(), | |
| 264 | - $user | |
| 265 | - ); | |
| 266 | -			if(is_null($readUntil)) { | |
| 267 | - $unread = 'true'; | |
| 268 | -			} else { | |
| 269 | - $unread = $this->comment->getCreationDateTime() > $readUntil; | |
| 270 | - // re-format for output | |
| 271 | - $unread = $unread ? 'true' : 'false'; | |
| 272 | - } | |
| 273 | - } | |
| 274 | - $result[self::PROPERTY_NAME_UNREAD] = $unread; | |
| 258 | + $unread = null; | |
| 259 | + $user = $this->userSession->getUser(); | |
| 260 | +        if(!is_null($user)) { | |
| 261 | + $readUntil = $this->commentsManager->getReadMark( | |
| 262 | + $this->comment->getObjectType(), | |
| 263 | + $this->comment->getObjectId(), | |
| 264 | + $user | |
| 265 | + ); | |
| 266 | +            if(is_null($readUntil)) { | |
| 267 | + $unread = 'true'; | |
| 268 | +            } else { | |
| 269 | + $unread = $this->comment->getCreationDateTime() > $readUntil; | |
| 270 | + // re-format for output | |
| 271 | + $unread = $unread ? 'true' : 'false'; | |
| 272 | + } | |
| 273 | + } | |
| 274 | + $result[self::PROPERTY_NAME_UNREAD] = $unread; | |
| 275 | 275 | |
| 276 | - return $result; | |
| 277 | - } | |
| 276 | + return $result; | |
| 277 | + } | |
| 278 | 278 | |
| 279 | - /** | |
| 280 | - * transforms a mentions array as returned from IComment->getMentions to an | |
| 281 | - * array with DAV-compatible structure that can be assigned to the | |
| 282 | - * PROPERTY_NAME_MENTION property. | |
| 283 | - * | |
| 284 | - * @return array | |
| 285 | - */ | |
| 286 | -	protected function composeMentionsPropertyValue() { | |
| 287 | -		return array_map(function($mention) { | |
| 288 | -			try { | |
| 289 | - $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']); | |
| 290 | -			} catch (\OutOfBoundsException $e) { | |
| 291 | - $this->logger->logException($e); | |
| 292 | - // No displayname, upon client's discretion what to display. | |
| 293 | - $displayName = ''; | |
| 294 | - } | |
| 279 | + /** | |
| 280 | + * transforms a mentions array as returned from IComment->getMentions to an | |
| 281 | + * array with DAV-compatible structure that can be assigned to the | |
| 282 | + * PROPERTY_NAME_MENTION property. | |
| 283 | + * | |
| 284 | + * @return array | |
| 285 | + */ | |
| 286 | +    protected function composeMentionsPropertyValue() { | |
| 287 | +        return array_map(function($mention) { | |
| 288 | +            try { | |
| 289 | + $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']); | |
| 290 | +            } catch (\OutOfBoundsException $e) { | |
| 291 | + $this->logger->logException($e); | |
| 292 | + // No displayname, upon client's discretion what to display. | |
| 293 | + $displayName = ''; | |
| 294 | + } | |
| 295 | 295 | |
| 296 | - return [ | |
| 297 | - self::PROPERTY_NAME_MENTION => [ | |
| 298 | - self::PROPERTY_NAME_MENTION_TYPE => $mention['type'], | |
| 299 | - self::PROPERTY_NAME_MENTION_ID => $mention['id'], | |
| 300 | - self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName, | |
| 301 | - ] | |
| 302 | - ]; | |
| 303 | - }, $this->comment->getMentions()); | |
| 304 | - } | |
| 296 | + return [ | |
| 297 | + self::PROPERTY_NAME_MENTION => [ | |
| 298 | + self::PROPERTY_NAME_MENTION_TYPE => $mention['type'], | |
| 299 | + self::PROPERTY_NAME_MENTION_ID => $mention['id'], | |
| 300 | + self::PROPERTY_NAME_MENTION_DISPLAYNAME => $displayName, | |
| 301 | + ] | |
| 302 | + ]; | |
| 303 | + }, $this->comment->getMentions()); | |
| 304 | + } | |
| 305 | 305 | } | 
| @@ -86,14 +86,14 @@ discard block | ||
| 86 | 86 | $this->logger = $logger; | 
| 87 | 87 | |
| 88 | 88 | $methods = get_class_methods($this->comment); | 
| 89 | -		$methods = array_filter($methods, function($name){ | |
| 89 | +		$methods = array_filter($methods, function($name) { | |
| 90 | 90 | return strpos($name, 'get') === 0; | 
| 91 | 91 | }); | 
| 92 | -		foreach($methods as $getter) { | |
| 93 | -			if($getter === 'getMentions') { | |
| 94 | - continue; // special treatment | |
| 92 | +		foreach ($methods as $getter) { | |
| 93 | +			if ($getter === 'getMentions') { | |
| 94 | + continue; // special treatment | |
| 95 | 95 | } | 
| 96 | -			$name = '{'.self::NS_OWNCLOUD.'}' . lcfirst(substr($getter, 3)); | |
| 96 | +			$name = '{'.self::NS_OWNCLOUD.'}'.lcfirst(substr($getter, 3)); | |
| 97 | 97 | $this->properties[$name] = $getter; | 
| 98 | 98 | } | 
| 99 | 99 | $this->userManager = $userManager; | 
| @@ -132,7 +132,7 @@ discard block | ||
| 132 | 132 | |
| 133 | 133 |  	protected function checkWriteAccessOnComment() { | 
| 134 | 134 | $user = $this->userSession->getUser(); | 
| 135 | - if( $this->comment->getActorType() !== 'users' | |
| 135 | + if ($this->comment->getActorType() !== 'users' | |
| 136 | 136 | || is_null($user) | 
| 137 | 137 | || $this->comment->getActorId() !== $user->getUID() | 
| 138 | 138 |  		) { | 
| @@ -196,9 +196,9 @@ discard block | ||
| 196 | 196 | return true; | 
| 197 | 197 |  		} catch (\Exception $e) { | 
| 198 | 198 | $this->logger->logException($e, ['app' => 'dav/comments']); | 
| 199 | -			if($e instanceof MessageTooLongException) { | |
| 199 | +			if ($e instanceof MessageTooLongException) { | |
| 200 | 200 | $msg = 'Message exceeds allowed character limit of '; | 
| 201 | - throw new BadRequest($msg . IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 201 | + throw new BadRequest($msg.IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 202 | 202 | } | 
| 203 | 203 | throw $e; | 
| 204 | 204 | } | 
| @@ -240,14 +240,14 @@ discard block | ||
| 240 | 240 | $properties = array_keys($this->properties); | 
| 241 | 241 | |
| 242 | 242 | $result = []; | 
| 243 | -		foreach($properties as $property) { | |
| 243 | +		foreach ($properties as $property) { | |
| 244 | 244 | $getter = $this->properties[$property]; | 
| 245 | -			if(method_exists($this->comment, $getter)) { | |
| 245 | +			if (method_exists($this->comment, $getter)) { | |
| 246 | 246 | $result[$property] = $this->comment->$getter(); | 
| 247 | 247 | } | 
| 248 | 248 | } | 
| 249 | 249 | |
| 250 | -		if($this->comment->getActorType() === 'users') { | |
| 250 | +		if ($this->comment->getActorType() === 'users') { | |
| 251 | 251 | $user = $this->userManager->get($this->comment->getActorId()); | 
| 252 | 252 | $displayName = is_null($user) ? null : $user->getDisplayName(); | 
| 253 | 253 | $result[self::PROPERTY_NAME_ACTOR_DISPLAYNAME] = $displayName; | 
| @@ -256,14 +256,14 @@ discard block | ||
| 256 | 256 | $result[self::PROPERTY_NAME_MENTIONS] = $this->composeMentionsPropertyValue(); | 
| 257 | 257 | |
| 258 | 258 | $unread = null; | 
| 259 | - $user = $this->userSession->getUser(); | |
| 260 | -		if(!is_null($user)) { | |
| 259 | + $user = $this->userSession->getUser(); | |
| 260 | +		if (!is_null($user)) { | |
| 261 | 261 | $readUntil = $this->commentsManager->getReadMark( | 
| 262 | 262 | $this->comment->getObjectType(), | 
| 263 | 263 | $this->comment->getObjectId(), | 
| 264 | 264 | $user | 
| 265 | 265 | ); | 
| 266 | -			if(is_null($readUntil)) { | |
| 266 | +			if (is_null($readUntil)) { | |
| 267 | 267 | $unread = 'true'; | 
| 268 | 268 |  			} else { | 
| 269 | 269 | $unread = $this->comment->getCreationDateTime() > $readUntil; | 
| @@ -138,7 +138,7 @@ | ||
| 138 | 138 |  	 * This will be used in the {DAV:}supported-report-set property. | 
| 139 | 139 | * | 
| 140 | 140 | * @param string $uri | 
| 141 | - * @return array | |
| 141 | + * @return string[] | |
| 142 | 142 | */ | 
| 143 | 143 |  	public function getSupportedReportSet($uri) { | 
| 144 | 144 | return [self::REPORT_NAME]; | 
| @@ -43,213 +43,213 @@ | ||
| 43 | 43 | * Sabre plugin to handle comments: | 
| 44 | 44 | */ | 
| 45 | 45 |  class CommentsPlugin extends ServerPlugin { | 
| 46 | - // namespace | |
| 47 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 48 | - | |
| 49 | -	const REPORT_NAME            = '{http://owncloud.org/ns}filter-comments'; | |
| 50 | -	const REPORT_PARAM_LIMIT     = '{http://owncloud.org/ns}limit'; | |
| 51 | -	const REPORT_PARAM_OFFSET    = '{http://owncloud.org/ns}offset'; | |
| 52 | -	const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; | |
| 53 | - | |
| 54 | - /** @var ICommentsManager */ | |
| 55 | - protected $commentsManager; | |
| 56 | - | |
| 57 | - /** @var \Sabre\DAV\Server $server */ | |
| 58 | - private $server; | |
| 59 | - | |
| 60 | - /** @var \OCP\IUserSession */ | |
| 61 | - protected $userSession; | |
| 62 | - | |
| 63 | - /** | |
| 64 | - * Comments plugin | |
| 65 | - * | |
| 66 | - * @param ICommentsManager $commentsManager | |
| 67 | - * @param IUserSession $userSession | |
| 68 | - */ | |
| 69 | -	public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { | |
| 70 | - $this->commentsManager = $commentsManager; | |
| 71 | - $this->userSession = $userSession; | |
| 72 | - } | |
| 73 | - | |
| 74 | - /** | |
| 75 | - * This initializes the plugin. | |
| 76 | - * | |
| 77 | - * This function is called by Sabre\DAV\Server, after | |
| 78 | - * addPlugin is called. | |
| 79 | - * | |
| 80 | - * This method should set up the required event subscriptions. | |
| 81 | - * | |
| 82 | - * @param Server $server | |
| 83 | - * @return void | |
| 84 | - */ | |
| 85 | -	function initialize(Server $server) { | |
| 86 | - $this->server = $server; | |
| 87 | -		if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { | |
| 88 | - return; | |
| 89 | - } | |
| 90 | - | |
| 91 | - $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; | |
| 92 | - | |
| 93 | -		$this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { | |
| 94 | - $writer->write(\Sabre\HTTP\toDate($value)); | |
| 95 | - }; | |
| 96 | - | |
| 97 | -		$this->server->on('report', [$this, 'onReport']); | |
| 98 | -		$this->server->on('method:POST', [$this, 'httpPost']); | |
| 99 | - } | |
| 100 | - | |
| 101 | - /** | |
| 102 | - * POST operation on Comments collections | |
| 103 | - * | |
| 104 | - * @param RequestInterface $request request object | |
| 105 | - * @param ResponseInterface $response response object | |
| 106 | - * @return null|false | |
| 107 | - */ | |
| 108 | -	public function httpPost(RequestInterface $request, ResponseInterface $response) { | |
| 109 | - $path = $request->getPath(); | |
| 110 | - $node = $this->server->tree->getNodeForPath($path); | |
| 111 | -		if (!$node instanceof EntityCollection) { | |
| 112 | - return null; | |
| 113 | - } | |
| 114 | - | |
| 115 | - $data = $request->getBodyAsString(); | |
| 116 | - $comment = $this->createComment( | |
| 117 | - $node->getName(), | |
| 118 | - $node->getId(), | |
| 119 | - $data, | |
| 120 | -			$request->getHeader('Content-Type') | |
| 121 | - ); | |
| 122 | - | |
| 123 | - // update read marker for the current user/poster to avoid | |
| 124 | - // having their own comments marked as unread | |
| 125 | - $node->setReadMarker(null); | |
| 126 | - | |
| 127 | - $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); | |
| 128 | - | |
| 129 | -		$response->setHeader('Content-Location', $url); | |
| 130 | - | |
| 131 | - // created | |
| 132 | - $response->setStatus(201); | |
| 133 | - return false; | |
| 134 | - } | |
| 135 | - | |
| 136 | - /** | |
| 137 | - * Returns a list of reports this plugin supports. | |
| 138 | - * | |
| 139 | -	 * This will be used in the {DAV:}supported-report-set property. | |
| 140 | - * | |
| 141 | - * @param string $uri | |
| 142 | - * @return array | |
| 143 | - */ | |
| 144 | -	public function getSupportedReportSet($uri) { | |
| 145 | - return [self::REPORT_NAME]; | |
| 146 | - } | |
| 147 | - | |
| 148 | - /** | |
| 149 | - * REPORT operations to look for comments | |
| 150 | - * | |
| 151 | - * @param string $reportName | |
| 152 | - * @param array $report | |
| 153 | - * @param string $uri | |
| 154 | - * @return bool | |
| 155 | - * @throws NotFound | |
| 156 | - * @throws ReportNotSupported | |
| 157 | - */ | |
| 158 | -	public function onReport($reportName, $report, $uri) { | |
| 159 | - $node = $this->server->tree->getNodeForPath($uri); | |
| 160 | -		if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { | |
| 161 | - throw new ReportNotSupported(); | |
| 162 | - } | |
| 163 | - $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; | |
| 164 | - $acceptableParameters = [ | |
| 165 | - $this::REPORT_PARAM_LIMIT, | |
| 166 | - $this::REPORT_PARAM_OFFSET, | |
| 167 | - $this::REPORT_PARAM_TIMESTAMP | |
| 168 | - ]; | |
| 169 | -		$ns = '{' . $this::NS_OWNCLOUD . '}'; | |
| 170 | -		foreach($report as $parameter) { | |
| 171 | -			if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { | |
| 172 | - continue; | |
| 173 | - } | |
| 174 | - $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; | |
| 175 | - } | |
| 176 | - | |
| 177 | -		if(!is_null($args['datetime'])) { | |
| 178 | - $args['datetime'] = new \DateTime($args['datetime']); | |
| 179 | - } | |
| 180 | - | |
| 181 | - $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); | |
| 182 | - | |
| 183 | - $responses = []; | |
| 184 | -		foreach($results as $node) { | |
| 185 | - $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); | |
| 186 | - $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); | |
| 187 | -			if(isset($resultSet[0]) && isset($resultSet[0][200])) { | |
| 188 | - $responses[] = new Response( | |
| 189 | - $this->server->getBaseUri() . $nodePath, | |
| 190 | - [200 => $resultSet[0][200]], | |
| 191 | - 200 | |
| 192 | - ); | |
| 193 | - } | |
| 194 | - | |
| 195 | - } | |
| 196 | - | |
| 197 | - $xml = $this->server->xml->write( | |
| 198 | -			'{DAV:}multistatus', | |
| 199 | - new MultiStatus($responses) | |
| 200 | - ); | |
| 201 | - | |
| 202 | - $this->server->httpResponse->setStatus(207); | |
| 203 | -		$this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); | |
| 204 | - $this->server->httpResponse->setBody($xml); | |
| 205 | - | |
| 206 | - return false; | |
| 207 | - } | |
| 208 | - | |
| 209 | - /** | |
| 210 | - * Creates a new comment | |
| 211 | - * | |
| 212 | - * @param string $objectType e.g. "files" | |
| 213 | - * @param string $objectId e.g. the file id | |
| 214 | - * @param string $data JSON encoded string containing the properties of the tag to create | |
| 215 | - * @param string $contentType content type of the data | |
| 216 | - * @return IComment newly created comment | |
| 217 | - * | |
| 218 | - * @throws BadRequest if a field was missing | |
| 219 | - * @throws UnsupportedMediaType if the content type is not supported | |
| 220 | - */ | |
| 221 | -	private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { | |
| 222 | -		if (explode(';', $contentType)[0] === 'application/json') { | |
| 223 | - $data = json_decode($data, true); | |
| 224 | -		} else { | |
| 225 | - throw new UnsupportedMediaType(); | |
| 226 | - } | |
| 227 | - | |
| 228 | - $actorType = $data['actorType']; | |
| 229 | - $actorId = null; | |
| 230 | -		if($actorType === 'users') { | |
| 231 | - $user = $this->userSession->getUser(); | |
| 232 | -			if(!is_null($user)) { | |
| 233 | - $actorId = $user->getUID(); | |
| 234 | - } | |
| 235 | - } | |
| 236 | -		if(is_null($actorId)) { | |
| 237 | -			throw new BadRequest('Invalid actor "' .  $actorType .'"'); | |
| 238 | - } | |
| 239 | - | |
| 240 | -		try { | |
| 241 | - $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); | |
| 242 | - $comment->setMessage($data['message']); | |
| 243 | - $comment->setVerb($data['verb']); | |
| 244 | - $this->commentsManager->save($comment); | |
| 245 | - return $comment; | |
| 246 | -		} catch (\InvalidArgumentException $e) { | |
| 247 | -			throw new BadRequest('Invalid input values', 0, $e); | |
| 248 | -		} catch (\OCP\Comments\MessageTooLongException $e) { | |
| 249 | - $msg = 'Message exceeds allowed character limit of '; | |
| 250 | - throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 251 | - } | |
| 252 | - } | |
| 46 | + // namespace | |
| 47 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 48 | + | |
| 49 | +    const REPORT_NAME            = '{http://owncloud.org/ns}filter-comments'; | |
| 50 | +    const REPORT_PARAM_LIMIT     = '{http://owncloud.org/ns}limit'; | |
| 51 | +    const REPORT_PARAM_OFFSET    = '{http://owncloud.org/ns}offset'; | |
| 52 | +    const REPORT_PARAM_TIMESTAMP = '{http://owncloud.org/ns}datetime'; | |
| 53 | + | |
| 54 | + /** @var ICommentsManager */ | |
| 55 | + protected $commentsManager; | |
| 56 | + | |
| 57 | + /** @var \Sabre\DAV\Server $server */ | |
| 58 | + private $server; | |
| 59 | + | |
| 60 | + /** @var \OCP\IUserSession */ | |
| 61 | + protected $userSession; | |
| 62 | + | |
| 63 | + /** | |
| 64 | + * Comments plugin | |
| 65 | + * | |
| 66 | + * @param ICommentsManager $commentsManager | |
| 67 | + * @param IUserSession $userSession | |
| 68 | + */ | |
| 69 | +    public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) { | |
| 70 | + $this->commentsManager = $commentsManager; | |
| 71 | + $this->userSession = $userSession; | |
| 72 | + } | |
| 73 | + | |
| 74 | + /** | |
| 75 | + * This initializes the plugin. | |
| 76 | + * | |
| 77 | + * This function is called by Sabre\DAV\Server, after | |
| 78 | + * addPlugin is called. | |
| 79 | + * | |
| 80 | + * This method should set up the required event subscriptions. | |
| 81 | + * | |
| 82 | + * @param Server $server | |
| 83 | + * @return void | |
| 84 | + */ | |
| 85 | +    function initialize(Server $server) { | |
| 86 | + $this->server = $server; | |
| 87 | +        if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { | |
| 88 | + return; | |
| 89 | + } | |
| 90 | + | |
| 91 | + $this->server->xml->namespaceMap[self::NS_OWNCLOUD] = 'oc'; | |
| 92 | + | |
| 93 | +        $this->server->xml->classMap['DateTime'] = function(Writer $writer, \DateTime $value) { | |
| 94 | + $writer->write(\Sabre\HTTP\toDate($value)); | |
| 95 | + }; | |
| 96 | + | |
| 97 | +        $this->server->on('report', [$this, 'onReport']); | |
| 98 | +        $this->server->on('method:POST', [$this, 'httpPost']); | |
| 99 | + } | |
| 100 | + | |
| 101 | + /** | |
| 102 | + * POST operation on Comments collections | |
| 103 | + * | |
| 104 | + * @param RequestInterface $request request object | |
| 105 | + * @param ResponseInterface $response response object | |
| 106 | + * @return null|false | |
| 107 | + */ | |
| 108 | +    public function httpPost(RequestInterface $request, ResponseInterface $response) { | |
| 109 | + $path = $request->getPath(); | |
| 110 | + $node = $this->server->tree->getNodeForPath($path); | |
| 111 | +        if (!$node instanceof EntityCollection) { | |
| 112 | + return null; | |
| 113 | + } | |
| 114 | + | |
| 115 | + $data = $request->getBodyAsString(); | |
| 116 | + $comment = $this->createComment( | |
| 117 | + $node->getName(), | |
| 118 | + $node->getId(), | |
| 119 | + $data, | |
| 120 | +            $request->getHeader('Content-Type') | |
| 121 | + ); | |
| 122 | + | |
| 123 | + // update read marker for the current user/poster to avoid | |
| 124 | + // having their own comments marked as unread | |
| 125 | + $node->setReadMarker(null); | |
| 126 | + | |
| 127 | + $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); | |
| 128 | + | |
| 129 | +        $response->setHeader('Content-Location', $url); | |
| 130 | + | |
| 131 | + // created | |
| 132 | + $response->setStatus(201); | |
| 133 | + return false; | |
| 134 | + } | |
| 135 | + | |
| 136 | + /** | |
| 137 | + * Returns a list of reports this plugin supports. | |
| 138 | + * | |
| 139 | +     * This will be used in the {DAV:}supported-report-set property. | |
| 140 | + * | |
| 141 | + * @param string $uri | |
| 142 | + * @return array | |
| 143 | + */ | |
| 144 | +    public function getSupportedReportSet($uri) { | |
| 145 | + return [self::REPORT_NAME]; | |
| 146 | + } | |
| 147 | + | |
| 148 | + /** | |
| 149 | + * REPORT operations to look for comments | |
| 150 | + * | |
| 151 | + * @param string $reportName | |
| 152 | + * @param array $report | |
| 153 | + * @param string $uri | |
| 154 | + * @return bool | |
| 155 | + * @throws NotFound | |
| 156 | + * @throws ReportNotSupported | |
| 157 | + */ | |
| 158 | +    public function onReport($reportName, $report, $uri) { | |
| 159 | + $node = $this->server->tree->getNodeForPath($uri); | |
| 160 | +        if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { | |
| 161 | + throw new ReportNotSupported(); | |
| 162 | + } | |
| 163 | + $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; | |
| 164 | + $acceptableParameters = [ | |
| 165 | + $this::REPORT_PARAM_LIMIT, | |
| 166 | + $this::REPORT_PARAM_OFFSET, | |
| 167 | + $this::REPORT_PARAM_TIMESTAMP | |
| 168 | + ]; | |
| 169 | +        $ns = '{' . $this::NS_OWNCLOUD . '}'; | |
| 170 | +        foreach($report as $parameter) { | |
| 171 | +            if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { | |
| 172 | + continue; | |
| 173 | + } | |
| 174 | + $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; | |
| 175 | + } | |
| 176 | + | |
| 177 | +        if(!is_null($args['datetime'])) { | |
| 178 | + $args['datetime'] = new \DateTime($args['datetime']); | |
| 179 | + } | |
| 180 | + | |
| 181 | + $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); | |
| 182 | + | |
| 183 | + $responses = []; | |
| 184 | +        foreach($results as $node) { | |
| 185 | + $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); | |
| 186 | + $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); | |
| 187 | +            if(isset($resultSet[0]) && isset($resultSet[0][200])) { | |
| 188 | + $responses[] = new Response( | |
| 189 | + $this->server->getBaseUri() . $nodePath, | |
| 190 | + [200 => $resultSet[0][200]], | |
| 191 | + 200 | |
| 192 | + ); | |
| 193 | + } | |
| 194 | + | |
| 195 | + } | |
| 196 | + | |
| 197 | + $xml = $this->server->xml->write( | |
| 198 | +            '{DAV:}multistatus', | |
| 199 | + new MultiStatus($responses) | |
| 200 | + ); | |
| 201 | + | |
| 202 | + $this->server->httpResponse->setStatus(207); | |
| 203 | +        $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8'); | |
| 204 | + $this->server->httpResponse->setBody($xml); | |
| 205 | + | |
| 206 | + return false; | |
| 207 | + } | |
| 208 | + | |
| 209 | + /** | |
| 210 | + * Creates a new comment | |
| 211 | + * | |
| 212 | + * @param string $objectType e.g. "files" | |
| 213 | + * @param string $objectId e.g. the file id | |
| 214 | + * @param string $data JSON encoded string containing the properties of the tag to create | |
| 215 | + * @param string $contentType content type of the data | |
| 216 | + * @return IComment newly created comment | |
| 217 | + * | |
| 218 | + * @throws BadRequest if a field was missing | |
| 219 | + * @throws UnsupportedMediaType if the content type is not supported | |
| 220 | + */ | |
| 221 | +    private function createComment($objectType, $objectId, $data, $contentType = 'application/json') { | |
| 222 | +        if (explode(';', $contentType)[0] === 'application/json') { | |
| 223 | + $data = json_decode($data, true); | |
| 224 | +        } else { | |
| 225 | + throw new UnsupportedMediaType(); | |
| 226 | + } | |
| 227 | + | |
| 228 | + $actorType = $data['actorType']; | |
| 229 | + $actorId = null; | |
| 230 | +        if($actorType === 'users') { | |
| 231 | + $user = $this->userSession->getUser(); | |
| 232 | +            if(!is_null($user)) { | |
| 233 | + $actorId = $user->getUID(); | |
| 234 | + } | |
| 235 | + } | |
| 236 | +        if(is_null($actorId)) { | |
| 237 | +            throw new BadRequest('Invalid actor "' .  $actorType .'"'); | |
| 238 | + } | |
| 239 | + | |
| 240 | +        try { | |
| 241 | + $comment = $this->commentsManager->create($actorType, $actorId, $objectType, $objectId); | |
| 242 | + $comment->setMessage($data['message']); | |
| 243 | + $comment->setVerb($data['verb']); | |
| 244 | + $this->commentsManager->save($comment); | |
| 245 | + return $comment; | |
| 246 | +        } catch (\InvalidArgumentException $e) { | |
| 247 | +            throw new BadRequest('Invalid input values', 0, $e); | |
| 248 | +        } catch (\OCP\Comments\MessageTooLongException $e) { | |
| 249 | + $msg = 'Message exceeds allowed character limit of '; | |
| 250 | + throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 251 | + } | |
| 252 | + } | |
| 253 | 253 | |
| 254 | 254 | |
| 255 | 255 | |
| @@ -84,7 +84,7 @@ discard block | ||
| 84 | 84 | */ | 
| 85 | 85 |  	function initialize(Server $server) { | 
| 86 | 86 | $this->server = $server; | 
| 87 | -		if(strpos($this->server->getRequestUri(), 'comments/') !== 0) { | |
| 87 | +		if (strpos($this->server->getRequestUri(), 'comments/') !== 0) { | |
| 88 | 88 | return; | 
| 89 | 89 | } | 
| 90 | 90 | |
| @@ -124,7 +124,7 @@ discard block | ||
| 124 | 124 | // having their own comments marked as unread | 
| 125 | 125 | $node->setReadMarker(null); | 
| 126 | 126 | |
| 127 | - $url = rtrim($request->getUrl(), '/') . '/' . urlencode($comment->getId()); | |
| 127 | + $url = rtrim($request->getUrl(), '/').'/'.urlencode($comment->getId()); | |
| 128 | 128 | |
| 129 | 129 |  		$response->setHeader('Content-Location', $url); | 
| 130 | 130 | |
| @@ -157,7 +157,7 @@ discard block | ||
| 157 | 157 | */ | 
| 158 | 158 |  	public function onReport($reportName, $report, $uri) { | 
| 159 | 159 | $node = $this->server->tree->getNodeForPath($uri); | 
| 160 | -		if(!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { | |
| 160 | +		if (!$node instanceof EntityCollection || $reportName !== self::REPORT_NAME) { | |
| 161 | 161 | throw new ReportNotSupported(); | 
| 162 | 162 | } | 
| 163 | 163 | $args = ['limit' => 0, 'offset' => 0, 'datetime' => null]; | 
| @@ -166,27 +166,27 @@ discard block | ||
| 166 | 166 | $this::REPORT_PARAM_OFFSET, | 
| 167 | 167 | $this::REPORT_PARAM_TIMESTAMP | 
| 168 | 168 | ]; | 
| 169 | -		$ns = '{' . $this::NS_OWNCLOUD . '}'; | |
| 170 | -		foreach($report as $parameter) { | |
| 171 | -			if(!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { | |
| 169 | +		$ns = '{'.$this::NS_OWNCLOUD.'}'; | |
| 170 | +		foreach ($report as $parameter) { | |
| 171 | +			if (!in_array($parameter['name'], $acceptableParameters) || empty($parameter['value'])) { | |
| 172 | 172 | continue; | 
| 173 | 173 | } | 
| 174 | 174 | $args[str_replace($ns, '', $parameter['name'])] = $parameter['value']; | 
| 175 | 175 | } | 
| 176 | 176 | |
| 177 | -		if(!is_null($args['datetime'])) { | |
| 177 | +		if (!is_null($args['datetime'])) { | |
| 178 | 178 | $args['datetime'] = new \DateTime($args['datetime']); | 
| 179 | 179 | } | 
| 180 | 180 | |
| 181 | 181 | $results = $node->findChildren($args['limit'], $args['offset'], $args['datetime']); | 
| 182 | 182 | |
| 183 | 183 | $responses = []; | 
| 184 | -		foreach($results as $node) { | |
| 185 | - $nodePath = $this->server->getRequestUri() . '/' . $node->comment->getId(); | |
| 184 | +		foreach ($results as $node) { | |
| 185 | + $nodePath = $this->server->getRequestUri().'/'.$node->comment->getId(); | |
| 186 | 186 | $resultSet = $this->server->getPropertiesForPath($nodePath, CommentNode::getPropertyNames()); | 
| 187 | -			if(isset($resultSet[0]) && isset($resultSet[0][200])) { | |
| 187 | +			if (isset($resultSet[0]) && isset($resultSet[0][200])) { | |
| 188 | 188 | $responses[] = new Response( | 
| 189 | - $this->server->getBaseUri() . $nodePath, | |
| 189 | + $this->server->getBaseUri().$nodePath, | |
| 190 | 190 | [200 => $resultSet[0][200]], | 
| 191 | 191 | 200 | 
| 192 | 192 | ); | 
| @@ -227,14 +227,14 @@ discard block | ||
| 227 | 227 | |
| 228 | 228 | $actorType = $data['actorType']; | 
| 229 | 229 | $actorId = null; | 
| 230 | -		if($actorType === 'users') { | |
| 230 | +		if ($actorType === 'users') { | |
| 231 | 231 | $user = $this->userSession->getUser(); | 
| 232 | -			if(!is_null($user)) { | |
| 232 | +			if (!is_null($user)) { | |
| 233 | 233 | $actorId = $user->getUID(); | 
| 234 | 234 | } | 
| 235 | 235 | } | 
| 236 | -		if(is_null($actorId)) { | |
| 237 | -			throw new BadRequest('Invalid actor "' .  $actorType .'"'); | |
| 236 | +		if (is_null($actorId)) { | |
| 237 | +			throw new BadRequest('Invalid actor "'.$actorType.'"'); | |
| 238 | 238 | } | 
| 239 | 239 | |
| 240 | 240 |  		try { | 
| @@ -247,7 +247,7 @@ discard block | ||
| 247 | 247 |  			throw new BadRequest('Invalid input values', 0, $e); | 
| 248 | 248 |  		} catch (\OCP\Comments\MessageTooLongException $e) { | 
| 249 | 249 | $msg = 'Message exceeds allowed character limit of '; | 
| 250 | - throw new BadRequest($msg . \OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 250 | + throw new BadRequest($msg.\OCP\Comments\IComment::MAX_MESSAGE_LENGTH, 0, $e); | |
| 251 | 251 | } | 
| 252 | 252 | } | 
| 253 | 253 | |
| @@ -115,7 +115,7 @@ | ||
| 115 | 115 | /** | 
| 116 | 116 | * Returns an array with all the child nodes | 
| 117 | 117 | * | 
| 118 | - * @return \Sabre\DAV\INode[] | |
| 118 | + * @return CommentNode[] | |
| 119 | 119 | */ | 
| 120 | 120 |  	function getChildren() { | 
| 121 | 121 | return $this->findChildren(); | 
| @@ -41,156 +41,156 @@ | ||
| 41 | 41 | * @package OCA\DAV\Comments | 
| 42 | 42 | */ | 
| 43 | 43 |  class EntityCollection extends RootCollection implements IProperties { | 
| 44 | -	const PROPERTY_NAME_READ_MARKER  = '{http://owncloud.org/ns}readMarker'; | |
| 44 | +    const PROPERTY_NAME_READ_MARKER  = '{http://owncloud.org/ns}readMarker'; | |
| 45 | 45 | |
| 46 | - /** @var string */ | |
| 47 | - protected $id; | |
| 46 | + /** @var string */ | |
| 47 | + protected $id; | |
| 48 | 48 | |
| 49 | - /** @var ILogger */ | |
| 50 | - protected $logger; | |
| 49 | + /** @var ILogger */ | |
| 50 | + protected $logger; | |
| 51 | 51 | |
| 52 | - /** | |
| 53 | - * @param string $id | |
| 54 | - * @param string $name | |
| 55 | - * @param ICommentsManager $commentsManager | |
| 56 | - * @param IUserManager $userManager | |
| 57 | - * @param IUserSession $userSession | |
| 58 | - * @param ILogger $logger | |
| 59 | - */ | |
| 60 | - public function __construct( | |
| 61 | - $id, | |
| 62 | - $name, | |
| 63 | - ICommentsManager $commentsManager, | |
| 64 | - IUserManager $userManager, | |
| 65 | - IUserSession $userSession, | |
| 66 | - ILogger $logger | |
| 67 | -	) { | |
| 68 | -		foreach(['id', 'name'] as $property) { | |
| 69 | - $$property = trim($$property); | |
| 70 | -			if(empty($$property) || !is_string($$property)) { | |
| 71 | -				throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); | |
| 72 | - } | |
| 73 | - } | |
| 74 | - $this->id = $id; | |
| 75 | - $this->name = $name; | |
| 76 | - $this->commentsManager = $commentsManager; | |
| 77 | - $this->logger = $logger; | |
| 78 | - $this->userManager = $userManager; | |
| 79 | - $this->userSession = $userSession; | |
| 80 | - } | |
| 52 | + /** | |
| 53 | + * @param string $id | |
| 54 | + * @param string $name | |
| 55 | + * @param ICommentsManager $commentsManager | |
| 56 | + * @param IUserManager $userManager | |
| 57 | + * @param IUserSession $userSession | |
| 58 | + * @param ILogger $logger | |
| 59 | + */ | |
| 60 | + public function __construct( | |
| 61 | + $id, | |
| 62 | + $name, | |
| 63 | + ICommentsManager $commentsManager, | |
| 64 | + IUserManager $userManager, | |
| 65 | + IUserSession $userSession, | |
| 66 | + ILogger $logger | |
| 67 | +    ) { | |
| 68 | +        foreach(['id', 'name'] as $property) { | |
| 69 | + $$property = trim($$property); | |
| 70 | +            if(empty($$property) || !is_string($$property)) { | |
| 71 | +                throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); | |
| 72 | + } | |
| 73 | + } | |
| 74 | + $this->id = $id; | |
| 75 | + $this->name = $name; | |
| 76 | + $this->commentsManager = $commentsManager; | |
| 77 | + $this->logger = $logger; | |
| 78 | + $this->userManager = $userManager; | |
| 79 | + $this->userSession = $userSession; | |
| 80 | + } | |
| 81 | 81 | |
| 82 | - /** | |
| 83 | - * returns the ID of this entity | |
| 84 | - * | |
| 85 | - * @return string | |
| 86 | - */ | |
| 87 | -	public function getId() { | |
| 88 | - return $this->id; | |
| 89 | - } | |
| 82 | + /** | |
| 83 | + * returns the ID of this entity | |
| 84 | + * | |
| 85 | + * @return string | |
| 86 | + */ | |
| 87 | +    public function getId() { | |
| 88 | + return $this->id; | |
| 89 | + } | |
| 90 | 90 | |
| 91 | - /** | |
| 92 | - * Returns a specific child node, referenced by its name | |
| 93 | - * | |
| 94 | - * This method must throw Sabre\DAV\Exception\NotFound if the node does not | |
| 95 | - * exist. | |
| 96 | - * | |
| 97 | - * @param string $name | |
| 98 | - * @return \Sabre\DAV\INode | |
| 99 | - * @throws NotFound | |
| 100 | - */ | |
| 101 | -	function getChild($name) { | |
| 102 | -		try { | |
| 103 | - $comment = $this->commentsManager->get($name); | |
| 104 | - return new CommentNode( | |
| 105 | - $this->commentsManager, | |
| 106 | - $comment, | |
| 107 | - $this->userManager, | |
| 108 | - $this->userSession, | |
| 109 | - $this->logger | |
| 110 | - ); | |
| 111 | -		} catch (NotFoundException $e) { | |
| 112 | - throw new NotFound(); | |
| 113 | - } | |
| 114 | - } | |
| 91 | + /** | |
| 92 | + * Returns a specific child node, referenced by its name | |
| 93 | + * | |
| 94 | + * This method must throw Sabre\DAV\Exception\NotFound if the node does not | |
| 95 | + * exist. | |
| 96 | + * | |
| 97 | + * @param string $name | |
| 98 | + * @return \Sabre\DAV\INode | |
| 99 | + * @throws NotFound | |
| 100 | + */ | |
| 101 | +    function getChild($name) { | |
| 102 | +        try { | |
| 103 | + $comment = $this->commentsManager->get($name); | |
| 104 | + return new CommentNode( | |
| 105 | + $this->commentsManager, | |
| 106 | + $comment, | |
| 107 | + $this->userManager, | |
| 108 | + $this->userSession, | |
| 109 | + $this->logger | |
| 110 | + ); | |
| 111 | +        } catch (NotFoundException $e) { | |
| 112 | + throw new NotFound(); | |
| 113 | + } | |
| 114 | + } | |
| 115 | 115 | |
| 116 | - /** | |
| 117 | - * Returns an array with all the child nodes | |
| 118 | - * | |
| 119 | - * @return \Sabre\DAV\INode[] | |
| 120 | - */ | |
| 121 | -	function getChildren() { | |
| 122 | - return $this->findChildren(); | |
| 123 | - } | |
| 116 | + /** | |
| 117 | + * Returns an array with all the child nodes | |
| 118 | + * | |
| 119 | + * @return \Sabre\DAV\INode[] | |
| 120 | + */ | |
| 121 | +    function getChildren() { | |
| 122 | + return $this->findChildren(); | |
| 123 | + } | |
| 124 | 124 | |
| 125 | - /** | |
| 126 | - * Returns an array of comment nodes. Result can be influenced by offset, | |
| 127 | - * limit and date time parameters. | |
| 128 | - * | |
| 129 | - * @param int $limit | |
| 130 | - * @param int $offset | |
| 131 | - * @param \DateTime|null $datetime | |
| 132 | - * @return CommentNode[] | |
| 133 | - */ | |
| 134 | -	function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { | |
| 135 | - $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); | |
| 136 | - $result = []; | |
| 137 | -		foreach($comments as $comment) { | |
| 138 | - $result[] = new CommentNode( | |
| 139 | - $this->commentsManager, | |
| 140 | - $comment, | |
| 141 | - $this->userManager, | |
| 142 | - $this->userSession, | |
| 143 | - $this->logger | |
| 144 | - ); | |
| 145 | - } | |
| 146 | - return $result; | |
| 147 | - } | |
| 125 | + /** | |
| 126 | + * Returns an array of comment nodes. Result can be influenced by offset, | |
| 127 | + * limit and date time parameters. | |
| 128 | + * | |
| 129 | + * @param int $limit | |
| 130 | + * @param int $offset | |
| 131 | + * @param \DateTime|null $datetime | |
| 132 | + * @return CommentNode[] | |
| 133 | + */ | |
| 134 | +    function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { | |
| 135 | + $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); | |
| 136 | + $result = []; | |
| 137 | +        foreach($comments as $comment) { | |
| 138 | + $result[] = new CommentNode( | |
| 139 | + $this->commentsManager, | |
| 140 | + $comment, | |
| 141 | + $this->userManager, | |
| 142 | + $this->userSession, | |
| 143 | + $this->logger | |
| 144 | + ); | |
| 145 | + } | |
| 146 | + return $result; | |
| 147 | + } | |
| 148 | 148 | |
| 149 | - /** | |
| 150 | - * Checks if a child-node with the specified name exists | |
| 151 | - * | |
| 152 | - * @param string $name | |
| 153 | - * @return bool | |
| 154 | - */ | |
| 155 | -	function childExists($name) { | |
| 156 | -		try { | |
| 157 | - $this->commentsManager->get($name); | |
| 158 | - return true; | |
| 159 | -		} catch (NotFoundException $e) { | |
| 160 | - return false; | |
| 161 | - } | |
| 162 | - } | |
| 149 | + /** | |
| 150 | + * Checks if a child-node with the specified name exists | |
| 151 | + * | |
| 152 | + * @param string $name | |
| 153 | + * @return bool | |
| 154 | + */ | |
| 155 | +    function childExists($name) { | |
| 156 | +        try { | |
| 157 | + $this->commentsManager->get($name); | |
| 158 | + return true; | |
| 159 | +        } catch (NotFoundException $e) { | |
| 160 | + return false; | |
| 161 | + } | |
| 162 | + } | |
| 163 | 163 | |
| 164 | - /** | |
| 165 | - * Sets the read marker to the specified date for the logged in user | |
| 166 | - * | |
| 167 | - * @param \DateTime $value | |
| 168 | - * @return bool | |
| 169 | - */ | |
| 170 | -	public function setReadMarker($value) { | |
| 171 | - $dateTime = new \DateTime($value); | |
| 172 | - $user = $this->userSession->getUser(); | |
| 173 | - $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user); | |
| 174 | - return true; | |
| 175 | - } | |
| 164 | + /** | |
| 165 | + * Sets the read marker to the specified date for the logged in user | |
| 166 | + * | |
| 167 | + * @param \DateTime $value | |
| 168 | + * @return bool | |
| 169 | + */ | |
| 170 | +    public function setReadMarker($value) { | |
| 171 | + $dateTime = new \DateTime($value); | |
| 172 | + $user = $this->userSession->getUser(); | |
| 173 | + $this->commentsManager->setReadMark($this->name, $this->id, $dateTime, $user); | |
| 174 | + return true; | |
| 175 | + } | |
| 176 | 176 | |
| 177 | - /** | |
| 178 | - * @inheritdoc | |
| 179 | - */ | |
| 180 | -	function propPatch(PropPatch $propPatch) { | |
| 181 | - $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']); | |
| 182 | - } | |
| 177 | + /** | |
| 178 | + * @inheritdoc | |
| 179 | + */ | |
| 180 | +    function propPatch(PropPatch $propPatch) { | |
| 181 | + $propPatch->handle(self::PROPERTY_NAME_READ_MARKER, [$this, 'setReadMarker']); | |
| 182 | + } | |
| 183 | 183 | |
| 184 | - /** | |
| 185 | - * @inheritdoc | |
| 186 | - */ | |
| 187 | -	function getProperties($properties) { | |
| 188 | - $marker = null; | |
| 189 | - $user = $this->userSession->getUser(); | |
| 190 | -		if(!is_null($user)) { | |
| 191 | - $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); | |
| 192 | - } | |
| 193 | - return [self::PROPERTY_NAME_READ_MARKER => $marker]; | |
| 194 | - } | |
| 184 | + /** | |
| 185 | + * @inheritdoc | |
| 186 | + */ | |
| 187 | +    function getProperties($properties) { | |
| 188 | + $marker = null; | |
| 189 | + $user = $this->userSession->getUser(); | |
| 190 | +        if(!is_null($user)) { | |
| 191 | + $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); | |
| 192 | + } | |
| 193 | + return [self::PROPERTY_NAME_READ_MARKER => $marker]; | |
| 194 | + } | |
| 195 | 195 | } | 
| 196 | 196 | |
| @@ -41,7 +41,7 @@ discard block | ||
| 41 | 41 | * @package OCA\DAV\Comments | 
| 42 | 42 | */ | 
| 43 | 43 |  class EntityCollection extends RootCollection implements IProperties { | 
| 44 | -	const PROPERTY_NAME_READ_MARKER  = '{http://owncloud.org/ns}readMarker'; | |
| 44 | +	const PROPERTY_NAME_READ_MARKER = '{http://owncloud.org/ns}readMarker'; | |
| 45 | 45 | |
| 46 | 46 | /** @var string */ | 
| 47 | 47 | protected $id; | 
| @@ -65,10 +65,10 @@ discard block | ||
| 65 | 65 | IUserSession $userSession, | 
| 66 | 66 | ILogger $logger | 
| 67 | 67 |  	) { | 
| 68 | -		foreach(['id', 'name'] as $property) { | |
| 68 | +		foreach (['id', 'name'] as $property) { | |
| 69 | 69 | $$property = trim($$property); | 
| 70 | -			if(empty($$property) || !is_string($$property)) { | |
| 71 | -				throw new \InvalidArgumentException('"' . $property . '" parameter must be non-empty string'); | |
| 70 | +			if (empty($$property) || !is_string($$property)) { | |
| 71 | +				throw new \InvalidArgumentException('"'.$property.'" parameter must be non-empty string'); | |
| 72 | 72 | } | 
| 73 | 73 | } | 
| 74 | 74 | $this->id = $id; | 
| @@ -134,7 +134,7 @@ discard block | ||
| 134 | 134 |  	function findChildren($limit = 0, $offset = 0, \DateTime $datetime = null) { | 
| 135 | 135 | $comments = $this->commentsManager->getForObject($this->name, $this->id, $limit, $offset, $datetime); | 
| 136 | 136 | $result = []; | 
| 137 | -		foreach($comments as $comment) { | |
| 137 | +		foreach ($comments as $comment) { | |
| 138 | 138 | $result[] = new CommentNode( | 
| 139 | 139 | $this->commentsManager, | 
| 140 | 140 | $comment, | 
| @@ -187,7 +187,7 @@ discard block | ||
| 187 | 187 |  	function getProperties($properties) { | 
| 188 | 188 | $marker = null; | 
| 189 | 189 | $user = $this->userSession->getUser(); | 
| 190 | -		if(!is_null($user)) { | |
| 190 | +		if (!is_null($user)) { | |
| 191 | 191 | $marker = $this->commentsManager->getReadMark($this->name, $this->id, $user); | 
| 192 | 192 | } | 
| 193 | 193 | return [self::PROPERTY_NAME_READ_MARKER => $marker]; | 
| @@ -21,7 +21,6 @@ | ||
| 21 | 21 | namespace OCA\DAV\Connector\Sabre; | 
| 22 | 22 | |
| 23 | 23 | use Sabre\Xml\XmlSerializable; | 
| 24 | -use Sabre\Xml\Element; | |
| 25 | 24 | use Sabre\Xml\Writer; | 
| 26 | 25 | |
| 27 | 26 | /** | 
| @@ -32,41 +32,41 @@ | ||
| 32 | 32 | * checksum name. | 
| 33 | 33 | */ | 
| 34 | 34 |  class ChecksumList implements XmlSerializable { | 
| 35 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 35 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; | |
| 36 | 36 | |
| 37 | - /** @var string[] of TYPE:CHECKSUM */ | |
| 38 | - private $checksums; | |
| 37 | + /** @var string[] of TYPE:CHECKSUM */ | |
| 38 | + private $checksums; | |
| 39 | 39 | |
| 40 | - /** | |
| 41 | - * @param string $checksum | |
| 42 | - */ | |
| 43 | -	public function __construct($checksum) { | |
| 44 | -		$this->checksums = explode(',', $checksum); | |
| 45 | - } | |
| 40 | + /** | |
| 41 | + * @param string $checksum | |
| 42 | + */ | |
| 43 | +    public function __construct($checksum) { | |
| 44 | +        $this->checksums = explode(',', $checksum); | |
| 45 | + } | |
| 46 | 46 | |
| 47 | - /** | |
| 48 | - * The xmlSerialize metod is called during xml writing. | |
| 49 | - * | |
| 50 | - * Use the $writer argument to write its own xml serialization. | |
| 51 | - * | |
| 52 | - * An important note: do _not_ create a parent element. Any element | |
| 53 | - * implementing XmlSerializble should only ever write what's considered | |
| 54 | - * its 'inner xml'. | |
| 55 | - * | |
| 56 | - * The parent of the current element is responsible for writing a | |
| 57 | - * containing element. | |
| 58 | - * | |
| 59 | - * This allows serializers to be re-used for different element names. | |
| 60 | - * | |
| 61 | - * If you are opening new elements, you must also close them again. | |
| 62 | - * | |
| 63 | - * @param Writer $writer | |
| 64 | - * @return void | |
| 65 | - */ | |
| 66 | -	function xmlSerialize(Writer $writer) { | |
| 47 | + /** | |
| 48 | + * The xmlSerialize metod is called during xml writing. | |
| 49 | + * | |
| 50 | + * Use the $writer argument to write its own xml serialization. | |
| 51 | + * | |
| 52 | + * An important note: do _not_ create a parent element. Any element | |
| 53 | + * implementing XmlSerializble should only ever write what's considered | |
| 54 | + * its 'inner xml'. | |
| 55 | + * | |
| 56 | + * The parent of the current element is responsible for writing a | |
| 57 | + * containing element. | |
| 58 | + * | |
| 59 | + * This allows serializers to be re-used for different element names. | |
| 60 | + * | |
| 61 | + * If you are opening new elements, you must also close them again. | |
| 62 | + * | |
| 63 | + * @param Writer $writer | |
| 64 | + * @return void | |
| 65 | + */ | |
| 66 | +    function xmlSerialize(Writer $writer) { | |
| 67 | 67 | |
| 68 | -		foreach ($this->checksums as $checksum) { | |
| 69 | -			$writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); | |
| 70 | - } | |
| 71 | - } | |
| 68 | +        foreach ($this->checksums as $checksum) { | |
| 69 | +            $writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); | |
| 70 | + } | |
| 71 | + } | |
| 72 | 72 | } | 
| @@ -66,7 +66,7 @@ | ||
| 66 | 66 |  	function xmlSerialize(Writer $writer) { | 
| 67 | 67 | |
| 68 | 68 |  		foreach ($this->checksums as $checksum) { | 
| 69 | -			$writer->writeElement('{' . self::NS_OWNCLOUD . '}checksum', $checksum); | |
| 69 | +			$writer->writeElement('{'.self::NS_OWNCLOUD.'}checksum', $checksum); | |
| 70 | 70 | } | 
| 71 | 71 | } | 
| 72 | 72 | } | 
| @@ -75,7 +75,7 @@ | ||
| 75 | 75 | private $cache = []; | 
| 76 | 76 | |
| 77 | 77 | /** | 
| 78 | - * @param Tree $tree node tree | |
| 78 | + * @param ObjectTree $tree node tree | |
| 79 | 79 | * @param IDBConnection $connection database connection | 
| 80 | 80 | * @param IUser $user owner of the tree and properties | 
| 81 | 81 | */ | 
| @@ -36,322 +36,322 @@ | ||
| 36 | 36 | |
| 37 | 37 |  class CustomPropertiesBackend implements BackendInterface { | 
| 38 | 38 | |
| 39 | - /** | |
| 40 | - * Ignored properties | |
| 41 | - * | |
| 42 | - * @var array | |
| 43 | - */ | |
| 44 | - private $ignoredProperties = array( | |
| 45 | -		'{DAV:}getcontentlength', | |
| 46 | -		'{DAV:}getcontenttype', | |
| 47 | -		'{DAV:}getetag', | |
| 48 | -		'{DAV:}quota-used-bytes', | |
| 49 | -		'{DAV:}quota-available-bytes', | |
| 50 | -		'{DAV:}quota-available-bytes', | |
| 51 | -		'{http://owncloud.org/ns}permissions', | |
| 52 | -		'{http://owncloud.org/ns}downloadURL', | |
| 53 | -		'{http://owncloud.org/ns}dDC', | |
| 54 | -		'{http://owncloud.org/ns}size', | |
| 55 | - ); | |
| 56 | - | |
| 57 | - /** | |
| 58 | - * @var Tree | |
| 59 | - */ | |
| 60 | - private $tree; | |
| 61 | - | |
| 62 | - /** | |
| 63 | - * @var IDBConnection | |
| 64 | - */ | |
| 65 | - private $connection; | |
| 66 | - | |
| 67 | - /** | |
| 68 | - * @var IUser | |
| 69 | - */ | |
| 70 | - private $user; | |
| 71 | - | |
| 72 | - /** | |
| 73 | - * Properties cache | |
| 74 | - * | |
| 75 | - * @var array | |
| 76 | - */ | |
| 77 | - private $cache = []; | |
| 78 | - | |
| 79 | - /** | |
| 80 | - * @param Tree $tree node tree | |
| 81 | - * @param IDBConnection $connection database connection | |
| 82 | - * @param IUser $user owner of the tree and properties | |
| 83 | - */ | |
| 84 | - public function __construct( | |
| 85 | - Tree $tree, | |
| 86 | - IDBConnection $connection, | |
| 87 | -		IUser $user) { | |
| 88 | - $this->tree = $tree; | |
| 89 | - $this->connection = $connection; | |
| 90 | - $this->user = $user->getUID(); | |
| 91 | - } | |
| 92 | - | |
| 93 | - /** | |
| 94 | - * Fetches properties for a path. | |
| 95 | - * | |
| 96 | - * @param string $path | |
| 97 | - * @param PropFind $propFind | |
| 98 | - * @return void | |
| 99 | - */ | |
| 100 | -	public function propFind($path, PropFind $propFind) { | |
| 101 | -		try { | |
| 102 | - $node = $this->tree->getNodeForPath($path); | |
| 103 | -			if (!($node instanceof Node)) { | |
| 104 | - return; | |
| 105 | - } | |
| 106 | -		} catch (ServiceUnavailable $e) { | |
| 107 | - // might happen for unavailable mount points, skip | |
| 108 | - return; | |
| 109 | -		} catch (NotFound $e) { | |
| 110 | - // in some rare (buggy) cases the node might not be found, | |
| 111 | - // we catch the exception to prevent breaking the whole list with a 404 | |
| 112 | - // (soft fail) | |
| 113 | - \OC::$server->getLogger()->warning( | |
| 114 | - 'Could not get node for path: \"' . $path . '\" : ' . $e->getMessage(), | |
| 115 | -				array('app' => 'files') | |
| 116 | - ); | |
| 117 | - return; | |
| 118 | - } | |
| 119 | - | |
| 120 | - $requestedProps = $propFind->get404Properties(); | |
| 121 | - | |
| 122 | - // these might appear | |
| 123 | - $requestedProps = array_diff( | |
| 124 | - $requestedProps, | |
| 125 | - $this->ignoredProperties | |
| 126 | - ); | |
| 127 | - | |
| 128 | -		if (empty($requestedProps)) { | |
| 129 | - return; | |
| 130 | - } | |
| 131 | - | |
| 132 | - if ($node instanceof Directory | |
| 133 | - && $propFind->getDepth() !== 0 | |
| 134 | -		) { | |
| 135 | - // note: pre-fetching only supported for depth <= 1 | |
| 136 | - $this->loadChildrenProperties($node, $requestedProps); | |
| 137 | - } | |
| 138 | - | |
| 139 | - $props = $this->getProperties($node, $requestedProps); | |
| 140 | -		foreach ($props as $propName => $propValue) { | |
| 141 | - $propFind->set($propName, $propValue); | |
| 142 | - } | |
| 143 | - } | |
| 144 | - | |
| 145 | - /** | |
| 146 | - * Updates properties for a path | |
| 147 | - * | |
| 148 | - * @param string $path | |
| 149 | - * @param PropPatch $propPatch | |
| 150 | - * | |
| 151 | - * @return void | |
| 152 | - */ | |
| 153 | -	public function propPatch($path, PropPatch $propPatch) { | |
| 154 | - $node = $this->tree->getNodeForPath($path); | |
| 155 | -		if (!($node instanceof Node)) { | |
| 156 | - return; | |
| 157 | - } | |
| 158 | - | |
| 159 | -		$propPatch->handleRemaining(function($changedProps) use ($node) { | |
| 160 | - return $this->updateProperties($node, $changedProps); | |
| 161 | - }); | |
| 162 | - } | |
| 163 | - | |
| 164 | - /** | |
| 165 | - * This method is called after a node is deleted. | |
| 166 | - * | |
| 167 | - * @param string $path path of node for which to delete properties | |
| 168 | - */ | |
| 169 | -	public function delete($path) { | |
| 170 | - $statement = $this->connection->prepare( | |
| 171 | - 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?' | |
| 172 | - ); | |
| 173 | - $statement->execute(array($this->user, '/' . $path)); | |
| 174 | - $statement->closeCursor(); | |
| 175 | - | |
| 176 | - unset($this->cache[$path]); | |
| 177 | - } | |
| 178 | - | |
| 179 | - /** | |
| 180 | - * This method is called after a successful MOVE | |
| 181 | - * | |
| 182 | - * @param string $source | |
| 183 | - * @param string $destination | |
| 184 | - * | |
| 185 | - * @return void | |
| 186 | - */ | |
| 187 | -	public function move($source, $destination) { | |
| 188 | - $statement = $this->connection->prepare( | |
| 189 | - 'UPDATE `*PREFIX*properties` SET `propertypath` = ?' . | |
| 190 | - ' WHERE `userid` = ? AND `propertypath` = ?' | |
| 191 | - ); | |
| 192 | -		$statement->execute(array('/' . $destination, $this->user, '/' . $source)); | |
| 193 | - $statement->closeCursor(); | |
| 194 | - } | |
| 195 | - | |
| 196 | - /** | |
| 197 | - * Returns a list of properties for this nodes.; | |
| 198 | - * @param Node $node | |
| 199 | - * @param array $requestedProperties requested properties or empty array for "all" | |
| 200 | - * @return array | |
| 201 | - * @note The properties list is a list of propertynames the client | |
| 202 | - * requested, encoded as xmlnamespace#tagName, for example: | |
| 203 | - * http://www.example.org/namespace#author If the array is empty, all | |
| 204 | - * properties should be returned | |
| 205 | - */ | |
| 206 | -	private function getProperties(Node $node, array $requestedProperties) { | |
| 207 | - $path = $node->getPath(); | |
| 208 | -		if (isset($this->cache[$path])) { | |
| 209 | - return $this->cache[$path]; | |
| 210 | - } | |
| 211 | - | |
| 212 | - // TODO: chunking if more than 1000 properties | |
| 213 | - $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?'; | |
| 214 | - | |
| 215 | - $whereValues = array($this->user, $path); | |
| 216 | - $whereTypes = array(null, null); | |
| 217 | - | |
| 218 | -		if (!empty($requestedProperties)) { | |
| 219 | - // request only a subset | |
| 220 | - $sql .= ' AND `propertyname` in (?)'; | |
| 221 | - $whereValues[] = $requestedProperties; | |
| 222 | - $whereTypes[] = \Doctrine\DBAL\Connection::PARAM_STR_ARRAY; | |
| 223 | - } | |
| 224 | - | |
| 225 | - $result = $this->connection->executeQuery( | |
| 226 | - $sql, | |
| 227 | - $whereValues, | |
| 228 | - $whereTypes | |
| 229 | - ); | |
| 230 | - | |
| 231 | - $props = []; | |
| 232 | -		while ($row = $result->fetch()) { | |
| 233 | - $props[$row['propertyname']] = $row['propertyvalue']; | |
| 234 | - } | |
| 235 | - | |
| 236 | - $result->closeCursor(); | |
| 237 | - | |
| 238 | - $this->cache[$path] = $props; | |
| 239 | - return $props; | |
| 240 | - } | |
| 241 | - | |
| 242 | - /** | |
| 243 | - * Update properties | |
| 244 | - * | |
| 245 | - * @param Node $node node for which to update properties | |
| 246 | - * @param array $properties array of properties to update | |
| 247 | - * | |
| 248 | - * @return bool | |
| 249 | - */ | |
| 250 | -	private function updateProperties($node, $properties) { | |
| 251 | - $path = $node->getPath(); | |
| 252 | - | |
| 253 | - $deleteStatement = 'DELETE FROM `*PREFIX*properties`' . | |
| 254 | - ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | |
| 255 | - | |
| 256 | - $insertStatement = 'INSERT INTO `*PREFIX*properties`' . | |
| 257 | - ' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)'; | |
| 258 | - | |
| 259 | - $updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?' . | |
| 260 | - ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | |
| 261 | - | |
| 262 | - // TODO: use "insert or update" strategy ? | |
| 263 | - $existing = $this->getProperties($node, array()); | |
| 264 | - $this->connection->beginTransaction(); | |
| 265 | -		foreach ($properties as $propertyName => $propertyValue) { | |
| 266 | - // If it was null, we need to delete the property | |
| 267 | -			if (is_null($propertyValue)) { | |
| 268 | -				if (array_key_exists($propertyName, $existing)) { | |
| 269 | - $this->connection->executeUpdate($deleteStatement, | |
| 270 | - array( | |
| 271 | - $this->user, | |
| 272 | - $path, | |
| 273 | - $propertyName | |
| 274 | - ) | |
| 275 | - ); | |
| 276 | - } | |
| 277 | -			} else { | |
| 278 | -				if (!array_key_exists($propertyName, $existing)) { | |
| 279 | - $this->connection->executeUpdate($insertStatement, | |
| 280 | - array( | |
| 281 | - $this->user, | |
| 282 | - $path, | |
| 283 | - $propertyName, | |
| 284 | - $propertyValue | |
| 285 | - ) | |
| 286 | - ); | |
| 287 | -				} else { | |
| 288 | - $this->connection->executeUpdate($updateStatement, | |
| 289 | - array( | |
| 290 | - $propertyValue, | |
| 291 | - $this->user, | |
| 292 | - $path, | |
| 293 | - $propertyName | |
| 294 | - ) | |
| 295 | - ); | |
| 296 | - } | |
| 297 | - } | |
| 298 | - } | |
| 299 | - | |
| 300 | - $this->connection->commit(); | |
| 301 | - unset($this->cache[$path]); | |
| 302 | - | |
| 303 | - return true; | |
| 304 | - } | |
| 305 | - | |
| 306 | - /** | |
| 307 | - * Bulk load properties for directory children | |
| 308 | - * | |
| 309 | - * @param Directory $node | |
| 310 | - * @param array $requestedProperties requested properties | |
| 311 | - * | |
| 312 | - * @return void | |
| 313 | - */ | |
| 314 | -	private function loadChildrenProperties(Directory $node, $requestedProperties) { | |
| 315 | - $path = $node->getPath(); | |
| 316 | -		if (isset($this->cache[$path])) { | |
| 317 | - // we already loaded them at some point | |
| 318 | - return; | |
| 319 | - } | |
| 320 | - | |
| 321 | - $childNodes = $node->getChildren(); | |
| 322 | - // pre-fill cache | |
| 323 | -		foreach ($childNodes as $childNode) { | |
| 324 | - $this->cache[$childNode->getPath()] = []; | |
| 325 | - } | |
| 326 | - | |
| 327 | - $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` LIKE ?'; | |
| 328 | - $sql .= ' AND `propertyname` in (?) ORDER BY `propertypath`, `propertyname`'; | |
| 329 | - | |
| 330 | - $result = $this->connection->executeQuery( | |
| 331 | - $sql, | |
| 332 | - array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties), | |
| 333 | - array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY) | |
| 334 | - ); | |
| 335 | - | |
| 336 | - $oldPath = null; | |
| 337 | - $props = []; | |
| 338 | -		while ($row = $result->fetch()) { | |
| 339 | - $path = $row['propertypath']; | |
| 340 | -			if ($oldPath !== $path) { | |
| 341 | - // save previously gathered props | |
| 342 | - $this->cache[$oldPath] = $props; | |
| 343 | - $oldPath = $path; | |
| 344 | - // prepare props for next path | |
| 345 | - $props = []; | |
| 346 | - } | |
| 347 | - $props[$row['propertyname']] = $row['propertyvalue']; | |
| 348 | - } | |
| 349 | -		if (!is_null($oldPath)) { | |
| 350 | - // save props from last run | |
| 351 | - $this->cache[$oldPath] = $props; | |
| 352 | - } | |
| 353 | - | |
| 354 | - $result->closeCursor(); | |
| 355 | - } | |
| 39 | + /** | |
| 40 | + * Ignored properties | |
| 41 | + * | |
| 42 | + * @var array | |
| 43 | + */ | |
| 44 | + private $ignoredProperties = array( | |
| 45 | +        '{DAV:}getcontentlength', | |
| 46 | +        '{DAV:}getcontenttype', | |
| 47 | +        '{DAV:}getetag', | |
| 48 | +        '{DAV:}quota-used-bytes', | |
| 49 | +        '{DAV:}quota-available-bytes', | |
| 50 | +        '{DAV:}quota-available-bytes', | |
| 51 | +        '{http://owncloud.org/ns}permissions', | |
| 52 | +        '{http://owncloud.org/ns}downloadURL', | |
| 53 | +        '{http://owncloud.org/ns}dDC', | |
| 54 | +        '{http://owncloud.org/ns}size', | |
| 55 | + ); | |
| 56 | + | |
| 57 | + /** | |
| 58 | + * @var Tree | |
| 59 | + */ | |
| 60 | + private $tree; | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * @var IDBConnection | |
| 64 | + */ | |
| 65 | + private $connection; | |
| 66 | + | |
| 67 | + /** | |
| 68 | + * @var IUser | |
| 69 | + */ | |
| 70 | + private $user; | |
| 71 | + | |
| 72 | + /** | |
| 73 | + * Properties cache | |
| 74 | + * | |
| 75 | + * @var array | |
| 76 | + */ | |
| 77 | + private $cache = []; | |
| 78 | + | |
| 79 | + /** | |
| 80 | + * @param Tree $tree node tree | |
| 81 | + * @param IDBConnection $connection database connection | |
| 82 | + * @param IUser $user owner of the tree and properties | |
| 83 | + */ | |
| 84 | + public function __construct( | |
| 85 | + Tree $tree, | |
| 86 | + IDBConnection $connection, | |
| 87 | +        IUser $user) { | |
| 88 | + $this->tree = $tree; | |
| 89 | + $this->connection = $connection; | |
| 90 | + $this->user = $user->getUID(); | |
| 91 | + } | |
| 92 | + | |
| 93 | + /** | |
| 94 | + * Fetches properties for a path. | |
| 95 | + * | |
| 96 | + * @param string $path | |
| 97 | + * @param PropFind $propFind | |
| 98 | + * @return void | |
| 99 | + */ | |
| 100 | +    public function propFind($path, PropFind $propFind) { | |
| 101 | +        try { | |
| 102 | + $node = $this->tree->getNodeForPath($path); | |
| 103 | +            if (!($node instanceof Node)) { | |
| 104 | + return; | |
| 105 | + } | |
| 106 | +        } catch (ServiceUnavailable $e) { | |
| 107 | + // might happen for unavailable mount points, skip | |
| 108 | + return; | |
| 109 | +        } catch (NotFound $e) { | |
| 110 | + // in some rare (buggy) cases the node might not be found, | |
| 111 | + // we catch the exception to prevent breaking the whole list with a 404 | |
| 112 | + // (soft fail) | |
| 113 | + \OC::$server->getLogger()->warning( | |
| 114 | + 'Could not get node for path: \"' . $path . '\" : ' . $e->getMessage(), | |
| 115 | +                array('app' => 'files') | |
| 116 | + ); | |
| 117 | + return; | |
| 118 | + } | |
| 119 | + | |
| 120 | + $requestedProps = $propFind->get404Properties(); | |
| 121 | + | |
| 122 | + // these might appear | |
| 123 | + $requestedProps = array_diff( | |
| 124 | + $requestedProps, | |
| 125 | + $this->ignoredProperties | |
| 126 | + ); | |
| 127 | + | |
| 128 | +        if (empty($requestedProps)) { | |
| 129 | + return; | |
| 130 | + } | |
| 131 | + | |
| 132 | + if ($node instanceof Directory | |
| 133 | + && $propFind->getDepth() !== 0 | |
| 134 | +        ) { | |
| 135 | + // note: pre-fetching only supported for depth <= 1 | |
| 136 | + $this->loadChildrenProperties($node, $requestedProps); | |
| 137 | + } | |
| 138 | + | |
| 139 | + $props = $this->getProperties($node, $requestedProps); | |
| 140 | +        foreach ($props as $propName => $propValue) { | |
| 141 | + $propFind->set($propName, $propValue); | |
| 142 | + } | |
| 143 | + } | |
| 144 | + | |
| 145 | + /** | |
| 146 | + * Updates properties for a path | |
| 147 | + * | |
| 148 | + * @param string $path | |
| 149 | + * @param PropPatch $propPatch | |
| 150 | + * | |
| 151 | + * @return void | |
| 152 | + */ | |
| 153 | +    public function propPatch($path, PropPatch $propPatch) { | |
| 154 | + $node = $this->tree->getNodeForPath($path); | |
| 155 | +        if (!($node instanceof Node)) { | |
| 156 | + return; | |
| 157 | + } | |
| 158 | + | |
| 159 | +        $propPatch->handleRemaining(function($changedProps) use ($node) { | |
| 160 | + return $this->updateProperties($node, $changedProps); | |
| 161 | + }); | |
| 162 | + } | |
| 163 | + | |
| 164 | + /** | |
| 165 | + * This method is called after a node is deleted. | |
| 166 | + * | |
| 167 | + * @param string $path path of node for which to delete properties | |
| 168 | + */ | |
| 169 | +    public function delete($path) { | |
| 170 | + $statement = $this->connection->prepare( | |
| 171 | + 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?' | |
| 172 | + ); | |
| 173 | + $statement->execute(array($this->user, '/' . $path)); | |
| 174 | + $statement->closeCursor(); | |
| 175 | + | |
| 176 | + unset($this->cache[$path]); | |
| 177 | + } | |
| 178 | + | |
| 179 | + /** | |
| 180 | + * This method is called after a successful MOVE | |
| 181 | + * | |
| 182 | + * @param string $source | |
| 183 | + * @param string $destination | |
| 184 | + * | |
| 185 | + * @return void | |
| 186 | + */ | |
| 187 | +    public function move($source, $destination) { | |
| 188 | + $statement = $this->connection->prepare( | |
| 189 | + 'UPDATE `*PREFIX*properties` SET `propertypath` = ?' . | |
| 190 | + ' WHERE `userid` = ? AND `propertypath` = ?' | |
| 191 | + ); | |
| 192 | +        $statement->execute(array('/' . $destination, $this->user, '/' . $source)); | |
| 193 | + $statement->closeCursor(); | |
| 194 | + } | |
| 195 | + | |
| 196 | + /** | |
| 197 | + * Returns a list of properties for this nodes.; | |
| 198 | + * @param Node $node | |
| 199 | + * @param array $requestedProperties requested properties or empty array for "all" | |
| 200 | + * @return array | |
| 201 | + * @note The properties list is a list of propertynames the client | |
| 202 | + * requested, encoded as xmlnamespace#tagName, for example: | |
| 203 | + * http://www.example.org/namespace#author If the array is empty, all | |
| 204 | + * properties should be returned | |
| 205 | + */ | |
| 206 | +    private function getProperties(Node $node, array $requestedProperties) { | |
| 207 | + $path = $node->getPath(); | |
| 208 | +        if (isset($this->cache[$path])) { | |
| 209 | + return $this->cache[$path]; | |
| 210 | + } | |
| 211 | + | |
| 212 | + // TODO: chunking if more than 1000 properties | |
| 213 | + $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?'; | |
| 214 | + | |
| 215 | + $whereValues = array($this->user, $path); | |
| 216 | + $whereTypes = array(null, null); | |
| 217 | + | |
| 218 | +        if (!empty($requestedProperties)) { | |
| 219 | + // request only a subset | |
| 220 | + $sql .= ' AND `propertyname` in (?)'; | |
| 221 | + $whereValues[] = $requestedProperties; | |
| 222 | + $whereTypes[] = \Doctrine\DBAL\Connection::PARAM_STR_ARRAY; | |
| 223 | + } | |
| 224 | + | |
| 225 | + $result = $this->connection->executeQuery( | |
| 226 | + $sql, | |
| 227 | + $whereValues, | |
| 228 | + $whereTypes | |
| 229 | + ); | |
| 230 | + | |
| 231 | + $props = []; | |
| 232 | +        while ($row = $result->fetch()) { | |
| 233 | + $props[$row['propertyname']] = $row['propertyvalue']; | |
| 234 | + } | |
| 235 | + | |
| 236 | + $result->closeCursor(); | |
| 237 | + | |
| 238 | + $this->cache[$path] = $props; | |
| 239 | + return $props; | |
| 240 | + } | |
| 241 | + | |
| 242 | + /** | |
| 243 | + * Update properties | |
| 244 | + * | |
| 245 | + * @param Node $node node for which to update properties | |
| 246 | + * @param array $properties array of properties to update | |
| 247 | + * | |
| 248 | + * @return bool | |
| 249 | + */ | |
| 250 | +    private function updateProperties($node, $properties) { | |
| 251 | + $path = $node->getPath(); | |
| 252 | + | |
| 253 | + $deleteStatement = 'DELETE FROM `*PREFIX*properties`' . | |
| 254 | + ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | |
| 255 | + | |
| 256 | + $insertStatement = 'INSERT INTO `*PREFIX*properties`' . | |
| 257 | + ' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)'; | |
| 258 | + | |
| 259 | + $updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?' . | |
| 260 | + ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | |
| 261 | + | |
| 262 | + // TODO: use "insert or update" strategy ? | |
| 263 | + $existing = $this->getProperties($node, array()); | |
| 264 | + $this->connection->beginTransaction(); | |
| 265 | +        foreach ($properties as $propertyName => $propertyValue) { | |
| 266 | + // If it was null, we need to delete the property | |
| 267 | +            if (is_null($propertyValue)) { | |
| 268 | +                if (array_key_exists($propertyName, $existing)) { | |
| 269 | + $this->connection->executeUpdate($deleteStatement, | |
| 270 | + array( | |
| 271 | + $this->user, | |
| 272 | + $path, | |
| 273 | + $propertyName | |
| 274 | + ) | |
| 275 | + ); | |
| 276 | + } | |
| 277 | +            } else { | |
| 278 | +                if (!array_key_exists($propertyName, $existing)) { | |
| 279 | + $this->connection->executeUpdate($insertStatement, | |
| 280 | + array( | |
| 281 | + $this->user, | |
| 282 | + $path, | |
| 283 | + $propertyName, | |
| 284 | + $propertyValue | |
| 285 | + ) | |
| 286 | + ); | |
| 287 | +                } else { | |
| 288 | + $this->connection->executeUpdate($updateStatement, | |
| 289 | + array( | |
| 290 | + $propertyValue, | |
| 291 | + $this->user, | |
| 292 | + $path, | |
| 293 | + $propertyName | |
| 294 | + ) | |
| 295 | + ); | |
| 296 | + } | |
| 297 | + } | |
| 298 | + } | |
| 299 | + | |
| 300 | + $this->connection->commit(); | |
| 301 | + unset($this->cache[$path]); | |
| 302 | + | |
| 303 | + return true; | |
| 304 | + } | |
| 305 | + | |
| 306 | + /** | |
| 307 | + * Bulk load properties for directory children | |
| 308 | + * | |
| 309 | + * @param Directory $node | |
| 310 | + * @param array $requestedProperties requested properties | |
| 311 | + * | |
| 312 | + * @return void | |
| 313 | + */ | |
| 314 | +    private function loadChildrenProperties(Directory $node, $requestedProperties) { | |
| 315 | + $path = $node->getPath(); | |
| 316 | +        if (isset($this->cache[$path])) { | |
| 317 | + // we already loaded them at some point | |
| 318 | + return; | |
| 319 | + } | |
| 320 | + | |
| 321 | + $childNodes = $node->getChildren(); | |
| 322 | + // pre-fill cache | |
| 323 | +        foreach ($childNodes as $childNode) { | |
| 324 | + $this->cache[$childNode->getPath()] = []; | |
| 325 | + } | |
| 326 | + | |
| 327 | + $sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` LIKE ?'; | |
| 328 | + $sql .= ' AND `propertyname` in (?) ORDER BY `propertypath`, `propertyname`'; | |
| 329 | + | |
| 330 | + $result = $this->connection->executeQuery( | |
| 331 | + $sql, | |
| 332 | + array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties), | |
| 333 | + array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY) | |
| 334 | + ); | |
| 335 | + | |
| 336 | + $oldPath = null; | |
| 337 | + $props = []; | |
| 338 | +        while ($row = $result->fetch()) { | |
| 339 | + $path = $row['propertypath']; | |
| 340 | +            if ($oldPath !== $path) { | |
| 341 | + // save previously gathered props | |
| 342 | + $this->cache[$oldPath] = $props; | |
| 343 | + $oldPath = $path; | |
| 344 | + // prepare props for next path | |
| 345 | + $props = []; | |
| 346 | + } | |
| 347 | + $props[$row['propertyname']] = $row['propertyvalue']; | |
| 348 | + } | |
| 349 | +        if (!is_null($oldPath)) { | |
| 350 | + // save props from last run | |
| 351 | + $this->cache[$oldPath] = $props; | |
| 352 | + } | |
| 353 | + | |
| 354 | + $result->closeCursor(); | |
| 355 | + } | |
| 356 | 356 | |
| 357 | 357 | } | 
| @@ -111,7 +111,7 @@ discard block | ||
| 111 | 111 | // we catch the exception to prevent breaking the whole list with a 404 | 
| 112 | 112 | // (soft fail) | 
| 113 | 113 | \OC::$server->getLogger()->warning( | 
| 114 | - 'Could not get node for path: \"' . $path . '\" : ' . $e->getMessage(), | |
| 114 | + 'Could not get node for path: \"'.$path.'\" : '.$e->getMessage(), | |
| 115 | 115 |  				array('app' => 'files') | 
| 116 | 116 | ); | 
| 117 | 117 | return; | 
| @@ -170,7 +170,7 @@ discard block | ||
| 170 | 170 | $statement = $this->connection->prepare( | 
| 171 | 171 | 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?' | 
| 172 | 172 | ); | 
| 173 | - $statement->execute(array($this->user, '/' . $path)); | |
| 173 | + $statement->execute(array($this->user, '/'.$path)); | |
| 174 | 174 | $statement->closeCursor(); | 
| 175 | 175 | |
| 176 | 176 | unset($this->cache[$path]); | 
| @@ -186,10 +186,10 @@ discard block | ||
| 186 | 186 | */ | 
| 187 | 187 |  	public function move($source, $destination) { | 
| 188 | 188 | $statement = $this->connection->prepare( | 
| 189 | - 'UPDATE `*PREFIX*properties` SET `propertypath` = ?' . | |
| 189 | + 'UPDATE `*PREFIX*properties` SET `propertypath` = ?'. | |
| 190 | 190 | ' WHERE `userid` = ? AND `propertypath` = ?' | 
| 191 | 191 | ); | 
| 192 | -		$statement->execute(array('/' . $destination, $this->user, '/' . $source)); | |
| 192 | +		$statement->execute(array('/'.$destination, $this->user, '/'.$source)); | |
| 193 | 193 | $statement->closeCursor(); | 
| 194 | 194 | } | 
| 195 | 195 | |
| @@ -250,13 +250,13 @@ discard block | ||
| 250 | 250 |  	private function updateProperties($node, $properties) { | 
| 251 | 251 | $path = $node->getPath(); | 
| 252 | 252 | |
| 253 | - $deleteStatement = 'DELETE FROM `*PREFIX*properties`' . | |
| 253 | + $deleteStatement = 'DELETE FROM `*PREFIX*properties`'. | |
| 254 | 254 | ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | 
| 255 | 255 | |
| 256 | - $insertStatement = 'INSERT INTO `*PREFIX*properties`' . | |
| 256 | + $insertStatement = 'INSERT INTO `*PREFIX*properties`'. | |
| 257 | 257 | ' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)'; | 
| 258 | 258 | |
| 259 | - $updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?' . | |
| 259 | + $updateStatement = 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?'. | |
| 260 | 260 | ' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?'; | 
| 261 | 261 | |
| 262 | 262 | // TODO: use "insert or update" strategy ? | 
| @@ -329,7 +329,7 @@ discard block | ||
| 329 | 329 | |
| 330 | 330 | $result = $this->connection->executeQuery( | 
| 331 | 331 | $sql, | 
| 332 | - array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')) . '/%', $requestedProperties), | |
| 332 | + array($this->user, $this->connection->escapeLikeParameter(rtrim($path, '/')).'/%', $requestedProperties), | |
| 333 | 333 | array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY) | 
| 334 | 334 | ); | 
| 335 | 335 | |
| @@ -232,6 +232,9 @@ | ||
| 232 | 232 | return '"' . $this->info->getEtag() . '"'; | 
| 233 | 233 | } | 
| 234 | 234 | |
| 235 | + /** | |
| 236 | + * @param string $path | |
| 237 | + */ | |
| 235 | 238 |  	private function getPartFileBasePath($path) { | 
| 236 | 239 |  		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true); | 
| 237 | 240 |  		if ($partFileInStorage) { | 
| @@ -92,7 +92,7 @@ discard block | ||
| 92 | 92 | throw new Forbidden(); | 
| 93 | 93 | } | 
| 94 | 94 |  		} catch (StorageNotAvailableException $e) { | 
| 95 | -			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage()); | |
| 95 | +			throw new ServiceUnavailable("File is not updatable: ".$e->getMessage()); | |
| 96 | 96 | } | 
| 97 | 97 | |
| 98 | 98 | // verify path of the target | 
| @@ -112,7 +112,7 @@ discard block | ||
| 112 | 112 | |
| 113 | 113 |  		if ($needsPartFile) { | 
| 114 | 114 | // mark file as partial while uploading (ignored by the scanner) | 
| 115 | - $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part'; | |
| 115 | + $partFilePath = $this->getPartFileBasePath($this->path).'.ocTransferId'.rand().'.part'; | |
| 116 | 116 |  		} else { | 
| 117 | 117 | // upload file directly as the final path | 
| 118 | 118 | $partFilePath = $this->path; | 
| @@ -138,7 +138,7 @@ discard block | ||
| 138 | 138 |  				if (isset($_SERVER['CONTENT_LENGTH'])) { | 
| 139 | 139 | $expected = $_SERVER['CONTENT_LENGTH']; | 
| 140 | 140 | } | 
| 141 | -				throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )'); | |
| 141 | +				throw new Exception('Error while copying file to target location (copied bytes: '.$count.', expected filesize: '.$expected.' )'); | |
| 142 | 142 | } | 
| 143 | 143 | |
| 144 | 144 | // if content length is sent by client: | 
| @@ -147,7 +147,7 @@ discard block | ||
| 147 | 147 |  			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') { | 
| 148 | 148 | $expected = $_SERVER['CONTENT_LENGTH']; | 
| 149 | 149 |  				if ($count != $expected) { | 
| 150 | -					throw new BadRequest('expected filesize ' . $expected . ' got ' . $count); | |
| 150 | +					throw new BadRequest('expected filesize '.$expected.' got '.$count); | |
| 151 | 151 | } | 
| 152 | 152 | } | 
| 153 | 153 | |
| @@ -227,10 +227,10 @@ discard block | ||
| 227 | 227 | } | 
| 228 | 228 | |
| 229 | 229 |  		} catch (StorageNotAvailableException $e) { | 
| 230 | -			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage()); | |
| 230 | +			throw new ServiceUnavailable("Failed to check file size: ".$e->getMessage()); | |
| 231 | 231 | } | 
| 232 | 232 | |
| 233 | - return '"' . $this->info->getEtag() . '"'; | |
| 233 | + return '"'.$this->info->getEtag().'"'; | |
| 234 | 234 | } | 
| 235 | 235 | |
| 236 | 236 |  	private function getPartFileBasePath($path) { | 
| @@ -309,9 +309,9 @@ discard block | ||
| 309 | 309 | return $res; | 
| 310 | 310 |  		} catch (GenericEncryptionException $e) { | 
| 311 | 311 | // returning 503 will allow retry of the operation at a later point in time | 
| 312 | -			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage()); | |
| 312 | +			throw new ServiceUnavailable("Encryption not ready: ".$e->getMessage()); | |
| 313 | 313 |  		} catch (StorageNotAvailableException $e) { | 
| 314 | -			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage()); | |
| 314 | +			throw new ServiceUnavailable("Failed to open file: ".$e->getMessage()); | |
| 315 | 315 |  		} catch (ForbiddenException $ex) { | 
| 316 | 316 | throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | 
| 317 | 317 |  		} catch (LockedException $e) { | 
| @@ -336,7 +336,7 @@ discard block | ||
| 336 | 336 | throw new Forbidden(); | 
| 337 | 337 | } | 
| 338 | 338 |  		} catch (StorageNotAvailableException $e) { | 
| 339 | -			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage()); | |
| 339 | +			throw new ServiceUnavailable("Failed to unlink: ".$e->getMessage()); | |
| 340 | 340 |  		} catch (ForbiddenException $ex) { | 
| 341 | 341 | throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | 
| 342 | 342 |  		} catch (LockedException $e) { | 
| @@ -403,7 +403,7 @@ discard block | ||
| 403 | 403 |  				if ($bytesWritten != $expected) { | 
| 404 | 404 | $chunk_handler->remove($info['index']); | 
| 405 | 405 | throw new BadRequest( | 
| 406 | - 'expected filesize ' . $expected . ' got ' . $bytesWritten); | |
| 406 | + 'expected filesize '.$expected.' got '.$bytesWritten); | |
| 407 | 407 | } | 
| 408 | 408 | } | 
| 409 | 409 | } | 
| @@ -413,7 +413,7 @@ discard block | ||
| 413 | 413 | $needsPartFile = $this->needsPartFile($storage); | 
| 414 | 414 | $partFile = null; | 
| 415 | 415 | |
| 416 | - $targetPath = $path . '/' . $info['name']; | |
| 416 | + $targetPath = $path.'/'.$info['name']; | |
| 417 | 417 | /** @var \OC\Files\Storage\Storage $targetStorage */ | 
| 418 | 418 | list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath); | 
| 419 | 419 | |
| @@ -429,7 +429,7 @@ discard block | ||
| 429 | 429 | |
| 430 | 430 |  				if ($needsPartFile) { | 
| 431 | 431 | // we first assembly the target file as a part file | 
| 432 | - $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part'; | |
| 432 | + $partFile = $this->getPartFileBasePath($path.'/'.$info['name']).'.ocTransferId'.$info['transferid'].'.part'; | |
| 433 | 433 | /** @var \OC\Files\Storage\Storage $targetStorage */ | 
| 434 | 434 | list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile); | 
| 435 | 435 | |
| @@ -548,10 +548,10 @@ discard block | ||
| 548 | 548 | } | 
| 549 | 549 |  		if ($e instanceof GenericEncryptionException) { | 
| 550 | 550 | // returning 503 will allow retry of the operation at a later point in time | 
| 551 | -			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e); | |
| 551 | +			throw new ServiceUnavailable('Encryption not ready: '.$e->getMessage(), 0, $e); | |
| 552 | 552 | } | 
| 553 | 553 |  		if ($e instanceof StorageNotAvailableException) { | 
| 554 | -			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e); | |
| 554 | +			throw new ServiceUnavailable('Failed to write file contents: '.$e->getMessage(), 0, $e); | |
| 555 | 555 | } | 
| 556 | 556 | |
| 557 | 557 | throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e); | 
| @@ -57,517 +57,517 @@ | ||
| 57 | 57 | |
| 58 | 58 |  class File extends Node implements IFile { | 
| 59 | 59 | |
| 60 | - /** | |
| 61 | - * Updates the data | |
| 62 | - * | |
| 63 | - * The data argument is a readable stream resource. | |
| 64 | - * | |
| 65 | - * After a successful put operation, you may choose to return an ETag. The | |
| 66 | - * etag must always be surrounded by double-quotes. These quotes must | |
| 67 | - * appear in the actual string you're returning. | |
| 68 | - * | |
| 69 | - * Clients may use the ETag from a PUT request to later on make sure that | |
| 70 | - * when they update the file, the contents haven't changed in the mean | |
| 71 | - * time. | |
| 72 | - * | |
| 73 | - * If you don't plan to store the file byte-by-byte, and you return a | |
| 74 | - * different object on a subsequent GET you are strongly recommended to not | |
| 75 | - * return an ETag, and just return null. | |
| 76 | - * | |
| 77 | - * @param resource $data | |
| 78 | - * | |
| 79 | - * @throws Forbidden | |
| 80 | - * @throws UnsupportedMediaType | |
| 81 | - * @throws BadRequest | |
| 82 | - * @throws Exception | |
| 83 | - * @throws EntityTooLarge | |
| 84 | - * @throws ServiceUnavailable | |
| 85 | - * @throws FileLocked | |
| 86 | - * @return string|null | |
| 87 | - */ | |
| 88 | -	public function put($data) { | |
| 89 | -		try { | |
| 90 | - $exists = $this->fileView->file_exists($this->path); | |
| 91 | -			if ($this->info && $exists && !$this->info->isUpdateable()) { | |
| 92 | - throw new Forbidden(); | |
| 93 | - } | |
| 94 | -		} catch (StorageNotAvailableException $e) { | |
| 95 | -			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage()); | |
| 96 | - } | |
| 97 | - | |
| 98 | - // verify path of the target | |
| 99 | - $this->verifyPath(); | |
| 100 | - | |
| 101 | - // chunked handling | |
| 102 | -		if (isset($_SERVER['HTTP_OC_CHUNKED'])) { | |
| 103 | -			try { | |
| 104 | - return $this->createFileChunked($data); | |
| 105 | -			} catch (\Exception $e) { | |
| 106 | - $this->convertToSabreException($e); | |
| 107 | - } | |
| 108 | - } | |
| 109 | - | |
| 110 | - list($partStorage) = $this->fileView->resolvePath($this->path); | |
| 111 | - $needsPartFile = $this->needsPartFile($partStorage) && (strlen($this->path) > 1); | |
| 112 | - | |
| 113 | -		if ($needsPartFile) { | |
| 114 | - // mark file as partial while uploading (ignored by the scanner) | |
| 115 | - $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part'; | |
| 116 | -		} else { | |
| 117 | - // upload file directly as the final path | |
| 118 | - $partFilePath = $this->path; | |
| 119 | - } | |
| 120 | - | |
| 121 | - // the part file and target file might be on a different storage in case of a single file storage (e.g. single file share) | |
| 122 | - /** @var \OC\Files\Storage\Storage $partStorage */ | |
| 123 | - list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath); | |
| 124 | - /** @var \OC\Files\Storage\Storage $storage */ | |
| 125 | - list($storage, $internalPath) = $this->fileView->resolvePath($this->path); | |
| 126 | -		try { | |
| 127 | - $target = $partStorage->fopen($internalPartPath, 'wb'); | |
| 128 | -			if ($target === false) { | |
| 129 | -				\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::fopen() failed', \OCP\Util::ERROR); | |
| 130 | - // because we have no clue about the cause we can only throw back a 500/Internal Server Error | |
| 131 | -				throw new Exception('Could not write file contents'); | |
| 132 | - } | |
| 133 | - list($count, $result) = \OC_Helper::streamCopy($data, $target); | |
| 134 | - fclose($target); | |
| 135 | - | |
| 136 | -			if ($result === false) { | |
| 137 | - $expected = -1; | |
| 138 | -				if (isset($_SERVER['CONTENT_LENGTH'])) { | |
| 139 | - $expected = $_SERVER['CONTENT_LENGTH']; | |
| 140 | - } | |
| 141 | -				throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )'); | |
| 142 | - } | |
| 143 | - | |
| 144 | - // if content length is sent by client: | |
| 145 | - // double check if the file was fully received | |
| 146 | - // compare expected and actual size | |
| 147 | -			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') { | |
| 148 | - $expected = $_SERVER['CONTENT_LENGTH']; | |
| 149 | -				if ($count != $expected) { | |
| 150 | -					throw new BadRequest('expected filesize ' . $expected . ' got ' . $count); | |
| 151 | - } | |
| 152 | - } | |
| 153 | - | |
| 154 | -		} catch (\Exception $e) { | |
| 155 | -			if ($needsPartFile) { | |
| 156 | - $partStorage->unlink($internalPartPath); | |
| 157 | - } | |
| 158 | - $this->convertToSabreException($e); | |
| 159 | - } | |
| 160 | - | |
| 161 | -		try { | |
| 162 | - $view = \OC\Files\Filesystem::getView(); | |
| 163 | -			if ($view) { | |
| 164 | - $run = $this->emitPreHooks($exists); | |
| 165 | -			} else { | |
| 166 | - $run = true; | |
| 167 | - } | |
| 168 | - | |
| 169 | -			try { | |
| 170 | - $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE); | |
| 171 | -			} catch (LockedException $e) { | |
| 172 | -				if ($needsPartFile) { | |
| 173 | - $partStorage->unlink($internalPartPath); | |
| 174 | - } | |
| 175 | - throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 176 | - } | |
| 177 | - | |
| 178 | -			if ($needsPartFile) { | |
| 179 | - // rename to correct path | |
| 180 | -				try { | |
| 181 | -					if ($run) { | |
| 182 | - $renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath); | |
| 183 | - $fileExists = $storage->file_exists($internalPath); | |
| 184 | - } | |
| 185 | -					if (!$run || $renameOkay === false || $fileExists === false) { | |
| 186 | -						\OCP\Util::writeLog('webdav', 'renaming part file to final file failed', \OCP\Util::ERROR); | |
| 187 | -						throw new Exception('Could not rename part file to final file'); | |
| 188 | - } | |
| 189 | -				} catch (ForbiddenException $ex) { | |
| 190 | - throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 191 | -				} catch (\Exception $e) { | |
| 192 | - $partStorage->unlink($internalPartPath); | |
| 193 | - $this->convertToSabreException($e); | |
| 194 | - } | |
| 195 | - } | |
| 196 | - | |
| 197 | - // since we skipped the view we need to scan and emit the hooks ourselves | |
| 198 | - $storage->getUpdater()->update($internalPath); | |
| 199 | - | |
| 200 | -			try { | |
| 201 | - $this->changeLock(ILockingProvider::LOCK_SHARED); | |
| 202 | -			} catch (LockedException $e) { | |
| 203 | - throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 204 | - } | |
| 205 | - | |
| 206 | - // allow sync clients to send the mtime along in a header | |
| 207 | - $request = \OC::$server->getRequest(); | |
| 208 | -			if (isset($request->server['HTTP_X_OC_MTIME'])) { | |
| 209 | - $mtimeStr = $request->server['HTTP_X_OC_MTIME']; | |
| 210 | -				if (!is_numeric($mtimeStr)) { | |
| 211 | -					throw new \InvalidArgumentException('X-OC-Mtime header must be an integer (unix timestamp).'); | |
| 212 | - } | |
| 213 | - $mtime = intval($mtimeStr); | |
| 214 | -				if ($this->fileView->touch($this->path, $mtime)) { | |
| 215 | -					header('X-OC-MTime: accepted'); | |
| 216 | - } | |
| 217 | - } | |
| 60 | + /** | |
| 61 | + * Updates the data | |
| 62 | + * | |
| 63 | + * The data argument is a readable stream resource. | |
| 64 | + * | |
| 65 | + * After a successful put operation, you may choose to return an ETag. The | |
| 66 | + * etag must always be surrounded by double-quotes. These quotes must | |
| 67 | + * appear in the actual string you're returning. | |
| 68 | + * | |
| 69 | + * Clients may use the ETag from a PUT request to later on make sure that | |
| 70 | + * when they update the file, the contents haven't changed in the mean | |
| 71 | + * time. | |
| 72 | + * | |
| 73 | + * If you don't plan to store the file byte-by-byte, and you return a | |
| 74 | + * different object on a subsequent GET you are strongly recommended to not | |
| 75 | + * return an ETag, and just return null. | |
| 76 | + * | |
| 77 | + * @param resource $data | |
| 78 | + * | |
| 79 | + * @throws Forbidden | |
| 80 | + * @throws UnsupportedMediaType | |
| 81 | + * @throws BadRequest | |
| 82 | + * @throws Exception | |
| 83 | + * @throws EntityTooLarge | |
| 84 | + * @throws ServiceUnavailable | |
| 85 | + * @throws FileLocked | |
| 86 | + * @return string|null | |
| 87 | + */ | |
| 88 | +    public function put($data) { | |
| 89 | +        try { | |
| 90 | + $exists = $this->fileView->file_exists($this->path); | |
| 91 | +            if ($this->info && $exists && !$this->info->isUpdateable()) { | |
| 92 | + throw new Forbidden(); | |
| 93 | + } | |
| 94 | +        } catch (StorageNotAvailableException $e) { | |
| 95 | +            throw new ServiceUnavailable("File is not updatable: " . $e->getMessage()); | |
| 96 | + } | |
| 97 | + | |
| 98 | + // verify path of the target | |
| 99 | + $this->verifyPath(); | |
| 100 | + | |
| 101 | + // chunked handling | |
| 102 | +        if (isset($_SERVER['HTTP_OC_CHUNKED'])) { | |
| 103 | +            try { | |
| 104 | + return $this->createFileChunked($data); | |
| 105 | +            } catch (\Exception $e) { | |
| 106 | + $this->convertToSabreException($e); | |
| 107 | + } | |
| 108 | + } | |
| 109 | + | |
| 110 | + list($partStorage) = $this->fileView->resolvePath($this->path); | |
| 111 | + $needsPartFile = $this->needsPartFile($partStorage) && (strlen($this->path) > 1); | |
| 112 | + | |
| 113 | +        if ($needsPartFile) { | |
| 114 | + // mark file as partial while uploading (ignored by the scanner) | |
| 115 | + $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part'; | |
| 116 | +        } else { | |
| 117 | + // upload file directly as the final path | |
| 118 | + $partFilePath = $this->path; | |
| 119 | + } | |
| 120 | + | |
| 121 | + // the part file and target file might be on a different storage in case of a single file storage (e.g. single file share) | |
| 122 | + /** @var \OC\Files\Storage\Storage $partStorage */ | |
| 123 | + list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath); | |
| 124 | + /** @var \OC\Files\Storage\Storage $storage */ | |
| 125 | + list($storage, $internalPath) = $this->fileView->resolvePath($this->path); | |
| 126 | +        try { | |
| 127 | + $target = $partStorage->fopen($internalPartPath, 'wb'); | |
| 128 | +            if ($target === false) { | |
| 129 | +                \OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::fopen() failed', \OCP\Util::ERROR); | |
| 130 | + // because we have no clue about the cause we can only throw back a 500/Internal Server Error | |
| 131 | +                throw new Exception('Could not write file contents'); | |
| 132 | + } | |
| 133 | + list($count, $result) = \OC_Helper::streamCopy($data, $target); | |
| 134 | + fclose($target); | |
| 135 | + | |
| 136 | +            if ($result === false) { | |
| 137 | + $expected = -1; | |
| 138 | +                if (isset($_SERVER['CONTENT_LENGTH'])) { | |
| 139 | + $expected = $_SERVER['CONTENT_LENGTH']; | |
| 140 | + } | |
| 141 | +                throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )'); | |
| 142 | + } | |
| 143 | + | |
| 144 | + // if content length is sent by client: | |
| 145 | + // double check if the file was fully received | |
| 146 | + // compare expected and actual size | |
| 147 | +            if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') { | |
| 148 | + $expected = $_SERVER['CONTENT_LENGTH']; | |
| 149 | +                if ($count != $expected) { | |
| 150 | +                    throw new BadRequest('expected filesize ' . $expected . ' got ' . $count); | |
| 151 | + } | |
| 152 | + } | |
| 153 | + | |
| 154 | +        } catch (\Exception $e) { | |
| 155 | +            if ($needsPartFile) { | |
| 156 | + $partStorage->unlink($internalPartPath); | |
| 157 | + } | |
| 158 | + $this->convertToSabreException($e); | |
| 159 | + } | |
| 160 | + | |
| 161 | +        try { | |
| 162 | + $view = \OC\Files\Filesystem::getView(); | |
| 163 | +            if ($view) { | |
| 164 | + $run = $this->emitPreHooks($exists); | |
| 165 | +            } else { | |
| 166 | + $run = true; | |
| 167 | + } | |
| 168 | + | |
| 169 | +            try { | |
| 170 | + $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE); | |
| 171 | +            } catch (LockedException $e) { | |
| 172 | +                if ($needsPartFile) { | |
| 173 | + $partStorage->unlink($internalPartPath); | |
| 174 | + } | |
| 175 | + throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 176 | + } | |
| 177 | + | |
| 178 | +            if ($needsPartFile) { | |
| 179 | + // rename to correct path | |
| 180 | +                try { | |
| 181 | +                    if ($run) { | |
| 182 | + $renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath); | |
| 183 | + $fileExists = $storage->file_exists($internalPath); | |
| 184 | + } | |
| 185 | +                    if (!$run || $renameOkay === false || $fileExists === false) { | |
| 186 | +                        \OCP\Util::writeLog('webdav', 'renaming part file to final file failed', \OCP\Util::ERROR); | |
| 187 | +                        throw new Exception('Could not rename part file to final file'); | |
| 188 | + } | |
| 189 | +                } catch (ForbiddenException $ex) { | |
| 190 | + throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 191 | +                } catch (\Exception $e) { | |
| 192 | + $partStorage->unlink($internalPartPath); | |
| 193 | + $this->convertToSabreException($e); | |
| 194 | + } | |
| 195 | + } | |
| 196 | + | |
| 197 | + // since we skipped the view we need to scan and emit the hooks ourselves | |
| 198 | + $storage->getUpdater()->update($internalPath); | |
| 199 | + | |
| 200 | +            try { | |
| 201 | + $this->changeLock(ILockingProvider::LOCK_SHARED); | |
| 202 | +            } catch (LockedException $e) { | |
| 203 | + throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 204 | + } | |
| 205 | + | |
| 206 | + // allow sync clients to send the mtime along in a header | |
| 207 | + $request = \OC::$server->getRequest(); | |
| 208 | +            if (isset($request->server['HTTP_X_OC_MTIME'])) { | |
| 209 | + $mtimeStr = $request->server['HTTP_X_OC_MTIME']; | |
| 210 | +                if (!is_numeric($mtimeStr)) { | |
| 211 | +                    throw new \InvalidArgumentException('X-OC-Mtime header must be an integer (unix timestamp).'); | |
| 212 | + } | |
| 213 | + $mtime = intval($mtimeStr); | |
| 214 | +                if ($this->fileView->touch($this->path, $mtime)) { | |
| 215 | +                    header('X-OC-MTime: accepted'); | |
| 216 | + } | |
| 217 | + } | |
| 218 | 218 | |
| 219 | -			if ($view) { | |
| 220 | - $this->emitPostHooks($exists); | |
| 221 | - } | |
| 222 | - | |
| 223 | - $this->refreshInfo(); | |
| 224 | - | |
| 225 | -			if (isset($request->server['HTTP_OC_CHECKSUM'])) { | |
| 226 | - $checksum = trim($request->server['HTTP_OC_CHECKSUM']); | |
| 227 | - $this->fileView->putFileInfo($this->path, ['checksum' => $checksum]); | |
| 228 | - $this->refreshInfo(); | |
| 229 | -			} else if ($this->getChecksum() !== null && $this->getChecksum() !== '') { | |
| 230 | - $this->fileView->putFileInfo($this->path, ['checksum' => '']); | |
| 231 | - $this->refreshInfo(); | |
| 232 | - } | |
| 233 | - | |
| 234 | -		} catch (StorageNotAvailableException $e) { | |
| 235 | -			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage()); | |
| 236 | - } | |
| 237 | - | |
| 238 | - return '"' . $this->info->getEtag() . '"'; | |
| 239 | - } | |
| 240 | - | |
| 241 | -	private function getPartFileBasePath($path) { | |
| 242 | -		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true); | |
| 243 | -		if ($partFileInStorage) { | |
| 244 | - return $path; | |
| 245 | -		} else { | |
| 246 | - return md5($path); // will place it in the root of the view with a unique name | |
| 247 | - } | |
| 248 | - } | |
| 249 | - | |
| 250 | - /** | |
| 251 | - * @param string $path | |
| 252 | - */ | |
| 253 | -	private function emitPreHooks($exists, $path = null) { | |
| 254 | -		if (is_null($path)) { | |
| 255 | - $path = $this->path; | |
| 256 | - } | |
| 257 | - $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path)); | |
| 258 | - $run = true; | |
| 259 | - | |
| 260 | -		if (!$exists) { | |
| 261 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, array( | |
| 262 | - \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 263 | - \OC\Files\Filesystem::signal_param_run => &$run, | |
| 264 | - )); | |
| 265 | -		} else { | |
| 266 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, array( | |
| 267 | - \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 268 | - \OC\Files\Filesystem::signal_param_run => &$run, | |
| 269 | - )); | |
| 270 | - } | |
| 271 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, array( | |
| 272 | - \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 273 | - \OC\Files\Filesystem::signal_param_run => &$run, | |
| 274 | - )); | |
| 275 | - return $run; | |
| 276 | - } | |
| 277 | - | |
| 278 | - /** | |
| 279 | - * @param string $path | |
| 280 | - */ | |
| 281 | -	private function emitPostHooks($exists, $path = null) { | |
| 282 | -		if (is_null($path)) { | |
| 283 | - $path = $this->path; | |
| 284 | - } | |
| 285 | - $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path)); | |
| 286 | -		if (!$exists) { | |
| 287 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, array( | |
| 288 | - \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 289 | - )); | |
| 290 | -		} else { | |
| 291 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, array( | |
| 292 | - \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 293 | - )); | |
| 294 | - } | |
| 295 | - \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, array( | |
| 296 | - \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 297 | - )); | |
| 298 | - } | |
| 299 | - | |
| 300 | - /** | |
| 301 | - * Returns the data | |
| 302 | - * | |
| 303 | - * @return resource | |
| 304 | - * @throws Forbidden | |
| 305 | - * @throws ServiceUnavailable | |
| 306 | - */ | |
| 307 | -	public function get() { | |
| 308 | - //throw exception if encryption is disabled but files are still encrypted | |
| 309 | -		try { | |
| 310 | - $res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb'); | |
| 311 | -			if ($res === false) { | |
| 312 | -				throw new ServiceUnavailable("Could not open file"); | |
| 313 | - } | |
| 314 | - return $res; | |
| 315 | -		} catch (GenericEncryptionException $e) { | |
| 316 | - // returning 503 will allow retry of the operation at a later point in time | |
| 317 | -			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage()); | |
| 318 | -		} catch (StorageNotAvailableException $e) { | |
| 319 | -			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage()); | |
| 320 | -		} catch (ForbiddenException $ex) { | |
| 321 | - throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 322 | -		} catch (LockedException $e) { | |
| 323 | - throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 324 | - } | |
| 325 | - } | |
| 326 | - | |
| 327 | - /** | |
| 328 | - * Delete the current file | |
| 329 | - * | |
| 330 | - * @throws Forbidden | |
| 331 | - * @throws ServiceUnavailable | |
| 332 | - */ | |
| 333 | -	public function delete() { | |
| 334 | -		if (!$this->info->isDeletable()) { | |
| 335 | - throw new Forbidden(); | |
| 336 | - } | |
| 337 | - | |
| 338 | -		try { | |
| 339 | -			if (!$this->fileView->unlink($this->path)) { | |
| 340 | - // assume it wasn't possible to delete due to permissions | |
| 341 | - throw new Forbidden(); | |
| 342 | - } | |
| 343 | -		} catch (StorageNotAvailableException $e) { | |
| 344 | -			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage()); | |
| 345 | -		} catch (ForbiddenException $ex) { | |
| 346 | - throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 347 | -		} catch (LockedException $e) { | |
| 348 | - throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 349 | - } | |
| 350 | - } | |
| 351 | - | |
| 352 | - /** | |
| 353 | - * Returns the mime-type for a file | |
| 354 | - * | |
| 355 | - * If null is returned, we'll assume application/octet-stream | |
| 356 | - * | |
| 357 | - * @return string | |
| 358 | - */ | |
| 359 | -	public function getContentType() { | |
| 360 | - $mimeType = $this->info->getMimetype(); | |
| 361 | - | |
| 362 | - // PROPFIND needs to return the correct mime type, for consistency with the web UI | |
| 363 | -		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') { | |
| 364 | - return $mimeType; | |
| 365 | - } | |
| 366 | - return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType); | |
| 367 | - } | |
| 368 | - | |
| 369 | - /** | |
| 370 | - * @return array|false | |
| 371 | - */ | |
| 372 | -	public function getDirectDownload() { | |
| 373 | -		if (\OCP\App::isEnabled('encryption')) { | |
| 374 | - return []; | |
| 375 | - } | |
| 376 | - /** @var \OCP\Files\Storage $storage */ | |
| 377 | - list($storage, $internalPath) = $this->fileView->resolvePath($this->path); | |
| 378 | -		if (is_null($storage)) { | |
| 379 | - return []; | |
| 380 | - } | |
| 381 | - | |
| 382 | - return $storage->getDirectDownload($internalPath); | |
| 383 | - } | |
| 384 | - | |
| 385 | - /** | |
| 386 | - * @param resource $data | |
| 387 | - * @return null|string | |
| 388 | - * @throws Exception | |
| 389 | - * @throws BadRequest | |
| 390 | - * @throws NotImplemented | |
| 391 | - * @throws ServiceUnavailable | |
| 392 | - */ | |
| 393 | -	private function createFileChunked($data) { | |
| 394 | - list($path, $name) = \Sabre\HTTP\URLUtil::splitPath($this->path); | |
| 395 | - | |
| 396 | - $info = \OC_FileChunking::decodeName($name); | |
| 397 | -		if (empty($info)) { | |
| 398 | -			throw new NotImplemented('Invalid chunk name'); | |
| 399 | - } | |
| 400 | - | |
| 401 | - $chunk_handler = new \OC_FileChunking($info); | |
| 402 | - $bytesWritten = $chunk_handler->store($info['index'], $data); | |
| 403 | - | |
| 404 | - //detect aborted upload | |
| 405 | -		if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') { | |
| 406 | -			if (isset($_SERVER['CONTENT_LENGTH'])) { | |
| 407 | - $expected = $_SERVER['CONTENT_LENGTH']; | |
| 408 | -				if ($bytesWritten != $expected) { | |
| 409 | - $chunk_handler->remove($info['index']); | |
| 410 | - throw new BadRequest( | |
| 411 | - 'expected filesize ' . $expected . ' got ' . $bytesWritten); | |
| 412 | - } | |
| 413 | - } | |
| 414 | - } | |
| 415 | - | |
| 416 | -		if ($chunk_handler->isComplete()) { | |
| 417 | - list($storage,) = $this->fileView->resolvePath($path); | |
| 418 | - $needsPartFile = $this->needsPartFile($storage); | |
| 419 | - $partFile = null; | |
| 420 | - | |
| 421 | - $targetPath = $path . '/' . $info['name']; | |
| 422 | - /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 423 | - list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath); | |
| 424 | - | |
| 425 | - $exists = $this->fileView->file_exists($targetPath); | |
| 426 | - | |
| 427 | -			try { | |
| 428 | - $this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED); | |
| 429 | - | |
| 430 | - $this->emitPreHooks($exists, $targetPath); | |
| 431 | - $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE); | |
| 432 | - /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 433 | - list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath); | |
| 434 | - | |
| 435 | -				if ($needsPartFile) { | |
| 436 | - // we first assembly the target file as a part file | |
| 437 | - $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part'; | |
| 438 | - /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 439 | - list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile); | |
| 440 | - | |
| 441 | - | |
| 442 | - $chunk_handler->file_assemble($partStorage, $partInternalPath); | |
| 443 | - | |
| 444 | - // here is the final atomic rename | |
| 445 | - $renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath); | |
| 446 | - $fileExists = $targetStorage->file_exists($targetInternalPath); | |
| 447 | -					if ($renameOkay === false || $fileExists === false) { | |
| 448 | -						\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::rename() failed', \OCP\Util::ERROR); | |
| 449 | - // only delete if an error occurred and the target file was already created | |
| 450 | -						if ($fileExists) { | |
| 451 | - // set to null to avoid double-deletion when handling exception | |
| 452 | - // stray part file | |
| 453 | - $partFile = null; | |
| 454 | - $targetStorage->unlink($targetInternalPath); | |
| 455 | - } | |
| 456 | - $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED); | |
| 457 | -						throw new Exception('Could not rename part file assembled from chunks'); | |
| 458 | - } | |
| 459 | -				} else { | |
| 460 | - // assemble directly into the final file | |
| 461 | - $chunk_handler->file_assemble($targetStorage, $targetInternalPath); | |
| 462 | - } | |
| 463 | - | |
| 464 | - // allow sync clients to send the mtime along in a header | |
| 465 | - $request = \OC::$server->getRequest(); | |
| 466 | -				if (isset($request->server['HTTP_X_OC_MTIME'])) { | |
| 467 | -					if ($targetStorage->touch($targetInternalPath, $request->server['HTTP_X_OC_MTIME'])) { | |
| 468 | -						header('X-OC-MTime: accepted'); | |
| 469 | - } | |
| 470 | - } | |
| 471 | - | |
| 472 | - // since we skipped the view we need to scan and emit the hooks ourselves | |
| 473 | - $targetStorage->getUpdater()->update($targetInternalPath); | |
| 474 | - | |
| 475 | - $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED); | |
| 476 | - | |
| 477 | - $this->emitPostHooks($exists, $targetPath); | |
| 478 | - | |
| 479 | - // FIXME: should call refreshInfo but can't because $this->path is not the of the final file | |
| 480 | - $info = $this->fileView->getFileInfo($targetPath); | |
| 481 | - | |
| 482 | -				if (isset($request->server['HTTP_OC_CHECKSUM'])) { | |
| 483 | - $checksum = trim($request->server['HTTP_OC_CHECKSUM']); | |
| 484 | - $this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]); | |
| 485 | -				} else if ($info->getChecksum() !== null && $info->getChecksum() !== '') { | |
| 486 | - $this->fileView->putFileInfo($this->path, ['checksum' => '']); | |
| 487 | - } | |
| 488 | - | |
| 489 | - $this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED); | |
| 490 | - | |
| 491 | - return $info->getEtag(); | |
| 492 | -			} catch (\Exception $e) { | |
| 493 | -				if ($partFile !== null) { | |
| 494 | - $targetStorage->unlink($targetInternalPath); | |
| 495 | - } | |
| 496 | - $this->convertToSabreException($e); | |
| 497 | - } | |
| 498 | - } | |
| 499 | - | |
| 500 | - return null; | |
| 501 | - } | |
| 502 | - | |
| 503 | - /** | |
| 504 | - * Returns whether a part file is needed for the given storage | |
| 505 | - * or whether the file can be assembled/uploaded directly on the | |
| 506 | - * target storage. | |
| 507 | - * | |
| 508 | - * @param \OCP\Files\Storage $storage | |
| 509 | - * @return bool true if the storage needs part file handling | |
| 510 | - */ | |
| 511 | -	private function needsPartFile($storage) { | |
| 512 | - // TODO: in the future use ChunkHandler provided by storage | |
| 513 | -		return !$storage->instanceOfStorage('OCA\Files_Sharing\External\Storage') && | |
| 514 | -			!$storage->instanceOfStorage('OC\Files\Storage\OwnCloud') && | |
| 515 | - $storage->needsPartFile(); | |
| 516 | - } | |
| 517 | - | |
| 518 | - /** | |
| 519 | - * Convert the given exception to a SabreException instance | |
| 520 | - * | |
| 521 | - * @param \Exception $e | |
| 522 | - * | |
| 523 | - * @throws \Sabre\DAV\Exception | |
| 524 | - */ | |
| 525 | -	private function convertToSabreException(\Exception $e) { | |
| 526 | -		if ($e instanceof \Sabre\DAV\Exception) { | |
| 527 | - throw $e; | |
| 528 | - } | |
| 529 | -		if ($e instanceof NotPermittedException) { | |
| 530 | - // a more general case - due to whatever reason the content could not be written | |
| 531 | - throw new Forbidden($e->getMessage(), 0, $e); | |
| 532 | - } | |
| 533 | -		if ($e instanceof ForbiddenException) { | |
| 534 | - // the path for the file was forbidden | |
| 535 | - throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e); | |
| 536 | - } | |
| 537 | -		if ($e instanceof EntityTooLargeException) { | |
| 538 | - // the file is too big to be stored | |
| 539 | - throw new EntityTooLarge($e->getMessage(), 0, $e); | |
| 540 | - } | |
| 541 | -		if ($e instanceof InvalidContentException) { | |
| 542 | - // the file content is not permitted | |
| 543 | - throw new UnsupportedMediaType($e->getMessage(), 0, $e); | |
| 544 | - } | |
| 545 | -		if ($e instanceof InvalidPathException) { | |
| 546 | - // the path for the file was not valid | |
| 547 | - // TODO: find proper http status code for this case | |
| 548 | - throw new Forbidden($e->getMessage(), 0, $e); | |
| 549 | - } | |
| 550 | -		if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) { | |
| 551 | - // the file is currently being written to by another process | |
| 552 | - throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 553 | - } | |
| 554 | -		if ($e instanceof GenericEncryptionException) { | |
| 555 | - // returning 503 will allow retry of the operation at a later point in time | |
| 556 | -			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e); | |
| 557 | - } | |
| 558 | -		if ($e instanceof StorageNotAvailableException) { | |
| 559 | -			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e); | |
| 560 | - } | |
| 561 | - | |
| 562 | - throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e); | |
| 563 | - } | |
| 564 | - | |
| 565 | - /** | |
| 566 | - * Get the checksum for this file | |
| 567 | - * | |
| 568 | - * @return string | |
| 569 | - */ | |
| 570 | -	public function getChecksum() { | |
| 571 | - return $this->info->getChecksum(); | |
| 572 | - } | |
| 219 | +            if ($view) { | |
| 220 | + $this->emitPostHooks($exists); | |
| 221 | + } | |
| 222 | + | |
| 223 | + $this->refreshInfo(); | |
| 224 | + | |
| 225 | +            if (isset($request->server['HTTP_OC_CHECKSUM'])) { | |
| 226 | + $checksum = trim($request->server['HTTP_OC_CHECKSUM']); | |
| 227 | + $this->fileView->putFileInfo($this->path, ['checksum' => $checksum]); | |
| 228 | + $this->refreshInfo(); | |
| 229 | +            } else if ($this->getChecksum() !== null && $this->getChecksum() !== '') { | |
| 230 | + $this->fileView->putFileInfo($this->path, ['checksum' => '']); | |
| 231 | + $this->refreshInfo(); | |
| 232 | + } | |
| 233 | + | |
| 234 | +        } catch (StorageNotAvailableException $e) { | |
| 235 | +            throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage()); | |
| 236 | + } | |
| 237 | + | |
| 238 | + return '"' . $this->info->getEtag() . '"'; | |
| 239 | + } | |
| 240 | + | |
| 241 | +    private function getPartFileBasePath($path) { | |
| 242 | +        $partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true); | |
| 243 | +        if ($partFileInStorage) { | |
| 244 | + return $path; | |
| 245 | +        } else { | |
| 246 | + return md5($path); // will place it in the root of the view with a unique name | |
| 247 | + } | |
| 248 | + } | |
| 249 | + | |
| 250 | + /** | |
| 251 | + * @param string $path | |
| 252 | + */ | |
| 253 | +    private function emitPreHooks($exists, $path = null) { | |
| 254 | +        if (is_null($path)) { | |
| 255 | + $path = $this->path; | |
| 256 | + } | |
| 257 | + $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path)); | |
| 258 | + $run = true; | |
| 259 | + | |
| 260 | +        if (!$exists) { | |
| 261 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, array( | |
| 262 | + \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 263 | + \OC\Files\Filesystem::signal_param_run => &$run, | |
| 264 | + )); | |
| 265 | +        } else { | |
| 266 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, array( | |
| 267 | + \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 268 | + \OC\Files\Filesystem::signal_param_run => &$run, | |
| 269 | + )); | |
| 270 | + } | |
| 271 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, array( | |
| 272 | + \OC\Files\Filesystem::signal_param_path => $hookPath, | |
| 273 | + \OC\Files\Filesystem::signal_param_run => &$run, | |
| 274 | + )); | |
| 275 | + return $run; | |
| 276 | + } | |
| 277 | + | |
| 278 | + /** | |
| 279 | + * @param string $path | |
| 280 | + */ | |
| 281 | +    private function emitPostHooks($exists, $path = null) { | |
| 282 | +        if (is_null($path)) { | |
| 283 | + $path = $this->path; | |
| 284 | + } | |
| 285 | + $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path)); | |
| 286 | +        if (!$exists) { | |
| 287 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, array( | |
| 288 | + \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 289 | + )); | |
| 290 | +        } else { | |
| 291 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, array( | |
| 292 | + \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 293 | + )); | |
| 294 | + } | |
| 295 | + \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, array( | |
| 296 | + \OC\Files\Filesystem::signal_param_path => $hookPath | |
| 297 | + )); | |
| 298 | + } | |
| 299 | + | |
| 300 | + /** | |
| 301 | + * Returns the data | |
| 302 | + * | |
| 303 | + * @return resource | |
| 304 | + * @throws Forbidden | |
| 305 | + * @throws ServiceUnavailable | |
| 306 | + */ | |
| 307 | +    public function get() { | |
| 308 | + //throw exception if encryption is disabled but files are still encrypted | |
| 309 | +        try { | |
| 310 | + $res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb'); | |
| 311 | +            if ($res === false) { | |
| 312 | +                throw new ServiceUnavailable("Could not open file"); | |
| 313 | + } | |
| 314 | + return $res; | |
| 315 | +        } catch (GenericEncryptionException $e) { | |
| 316 | + // returning 503 will allow retry of the operation at a later point in time | |
| 317 | +            throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage()); | |
| 318 | +        } catch (StorageNotAvailableException $e) { | |
| 319 | +            throw new ServiceUnavailable("Failed to open file: " . $e->getMessage()); | |
| 320 | +        } catch (ForbiddenException $ex) { | |
| 321 | + throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 322 | +        } catch (LockedException $e) { | |
| 323 | + throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 324 | + } | |
| 325 | + } | |
| 326 | + | |
| 327 | + /** | |
| 328 | + * Delete the current file | |
| 329 | + * | |
| 330 | + * @throws Forbidden | |
| 331 | + * @throws ServiceUnavailable | |
| 332 | + */ | |
| 333 | +    public function delete() { | |
| 334 | +        if (!$this->info->isDeletable()) { | |
| 335 | + throw new Forbidden(); | |
| 336 | + } | |
| 337 | + | |
| 338 | +        try { | |
| 339 | +            if (!$this->fileView->unlink($this->path)) { | |
| 340 | + // assume it wasn't possible to delete due to permissions | |
| 341 | + throw new Forbidden(); | |
| 342 | + } | |
| 343 | +        } catch (StorageNotAvailableException $e) { | |
| 344 | +            throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage()); | |
| 345 | +        } catch (ForbiddenException $ex) { | |
| 346 | + throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry()); | |
| 347 | +        } catch (LockedException $e) { | |
| 348 | + throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 349 | + } | |
| 350 | + } | |
| 351 | + | |
| 352 | + /** | |
| 353 | + * Returns the mime-type for a file | |
| 354 | + * | |
| 355 | + * If null is returned, we'll assume application/octet-stream | |
| 356 | + * | |
| 357 | + * @return string | |
| 358 | + */ | |
| 359 | +    public function getContentType() { | |
| 360 | + $mimeType = $this->info->getMimetype(); | |
| 361 | + | |
| 362 | + // PROPFIND needs to return the correct mime type, for consistency with the web UI | |
| 363 | +        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') { | |
| 364 | + return $mimeType; | |
| 365 | + } | |
| 366 | + return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType); | |
| 367 | + } | |
| 368 | + | |
| 369 | + /** | |
| 370 | + * @return array|false | |
| 371 | + */ | |
| 372 | +    public function getDirectDownload() { | |
| 373 | +        if (\OCP\App::isEnabled('encryption')) { | |
| 374 | + return []; | |
| 375 | + } | |
| 376 | + /** @var \OCP\Files\Storage $storage */ | |
| 377 | + list($storage, $internalPath) = $this->fileView->resolvePath($this->path); | |
| 378 | +        if (is_null($storage)) { | |
| 379 | + return []; | |
| 380 | + } | |
| 381 | + | |
| 382 | + return $storage->getDirectDownload($internalPath); | |
| 383 | + } | |
| 384 | + | |
| 385 | + /** | |
| 386 | + * @param resource $data | |
| 387 | + * @return null|string | |
| 388 | + * @throws Exception | |
| 389 | + * @throws BadRequest | |
| 390 | + * @throws NotImplemented | |
| 391 | + * @throws ServiceUnavailable | |
| 392 | + */ | |
| 393 | +    private function createFileChunked($data) { | |
| 394 | + list($path, $name) = \Sabre\HTTP\URLUtil::splitPath($this->path); | |
| 395 | + | |
| 396 | + $info = \OC_FileChunking::decodeName($name); | |
| 397 | +        if (empty($info)) { | |
| 398 | +            throw new NotImplemented('Invalid chunk name'); | |
| 399 | + } | |
| 400 | + | |
| 401 | + $chunk_handler = new \OC_FileChunking($info); | |
| 402 | + $bytesWritten = $chunk_handler->store($info['index'], $data); | |
| 403 | + | |
| 404 | + //detect aborted upload | |
| 405 | +        if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') { | |
| 406 | +            if (isset($_SERVER['CONTENT_LENGTH'])) { | |
| 407 | + $expected = $_SERVER['CONTENT_LENGTH']; | |
| 408 | +                if ($bytesWritten != $expected) { | |
| 409 | + $chunk_handler->remove($info['index']); | |
| 410 | + throw new BadRequest( | |
| 411 | + 'expected filesize ' . $expected . ' got ' . $bytesWritten); | |
| 412 | + } | |
| 413 | + } | |
| 414 | + } | |
| 415 | + | |
| 416 | +        if ($chunk_handler->isComplete()) { | |
| 417 | + list($storage,) = $this->fileView->resolvePath($path); | |
| 418 | + $needsPartFile = $this->needsPartFile($storage); | |
| 419 | + $partFile = null; | |
| 420 | + | |
| 421 | + $targetPath = $path . '/' . $info['name']; | |
| 422 | + /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 423 | + list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath); | |
| 424 | + | |
| 425 | + $exists = $this->fileView->file_exists($targetPath); | |
| 426 | + | |
| 427 | +            try { | |
| 428 | + $this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED); | |
| 429 | + | |
| 430 | + $this->emitPreHooks($exists, $targetPath); | |
| 431 | + $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE); | |
| 432 | + /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 433 | + list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath); | |
| 434 | + | |
| 435 | +                if ($needsPartFile) { | |
| 436 | + // we first assembly the target file as a part file | |
| 437 | + $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part'; | |
| 438 | + /** @var \OC\Files\Storage\Storage $targetStorage */ | |
| 439 | + list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile); | |
| 440 | + | |
| 441 | + | |
| 442 | + $chunk_handler->file_assemble($partStorage, $partInternalPath); | |
| 443 | + | |
| 444 | + // here is the final atomic rename | |
| 445 | + $renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath); | |
| 446 | + $fileExists = $targetStorage->file_exists($targetInternalPath); | |
| 447 | +                    if ($renameOkay === false || $fileExists === false) { | |
| 448 | +                        \OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::rename() failed', \OCP\Util::ERROR); | |
| 449 | + // only delete if an error occurred and the target file was already created | |
| 450 | +                        if ($fileExists) { | |
| 451 | + // set to null to avoid double-deletion when handling exception | |
| 452 | + // stray part file | |
| 453 | + $partFile = null; | |
| 454 | + $targetStorage->unlink($targetInternalPath); | |
| 455 | + } | |
| 456 | + $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED); | |
| 457 | +                        throw new Exception('Could not rename part file assembled from chunks'); | |
| 458 | + } | |
| 459 | +                } else { | |
| 460 | + // assemble directly into the final file | |
| 461 | + $chunk_handler->file_assemble($targetStorage, $targetInternalPath); | |
| 462 | + } | |
| 463 | + | |
| 464 | + // allow sync clients to send the mtime along in a header | |
| 465 | + $request = \OC::$server->getRequest(); | |
| 466 | +                if (isset($request->server['HTTP_X_OC_MTIME'])) { | |
| 467 | +                    if ($targetStorage->touch($targetInternalPath, $request->server['HTTP_X_OC_MTIME'])) { | |
| 468 | +                        header('X-OC-MTime: accepted'); | |
| 469 | + } | |
| 470 | + } | |
| 471 | + | |
| 472 | + // since we skipped the view we need to scan and emit the hooks ourselves | |
| 473 | + $targetStorage->getUpdater()->update($targetInternalPath); | |
| 474 | + | |
| 475 | + $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED); | |
| 476 | + | |
| 477 | + $this->emitPostHooks($exists, $targetPath); | |
| 478 | + | |
| 479 | + // FIXME: should call refreshInfo but can't because $this->path is not the of the final file | |
| 480 | + $info = $this->fileView->getFileInfo($targetPath); | |
| 481 | + | |
| 482 | +                if (isset($request->server['HTTP_OC_CHECKSUM'])) { | |
| 483 | + $checksum = trim($request->server['HTTP_OC_CHECKSUM']); | |
| 484 | + $this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]); | |
| 485 | +                } else if ($info->getChecksum() !== null && $info->getChecksum() !== '') { | |
| 486 | + $this->fileView->putFileInfo($this->path, ['checksum' => '']); | |
| 487 | + } | |
| 488 | + | |
| 489 | + $this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED); | |
| 490 | + | |
| 491 | + return $info->getEtag(); | |
| 492 | +            } catch (\Exception $e) { | |
| 493 | +                if ($partFile !== null) { | |
| 494 | + $targetStorage->unlink($targetInternalPath); | |
| 495 | + } | |
| 496 | + $this->convertToSabreException($e); | |
| 497 | + } | |
| 498 | + } | |
| 499 | + | |
| 500 | + return null; | |
| 501 | + } | |
| 502 | + | |
| 503 | + /** | |
| 504 | + * Returns whether a part file is needed for the given storage | |
| 505 | + * or whether the file can be assembled/uploaded directly on the | |
| 506 | + * target storage. | |
| 507 | + * | |
| 508 | + * @param \OCP\Files\Storage $storage | |
| 509 | + * @return bool true if the storage needs part file handling | |
| 510 | + */ | |
| 511 | +    private function needsPartFile($storage) { | |
| 512 | + // TODO: in the future use ChunkHandler provided by storage | |
| 513 | +        return !$storage->instanceOfStorage('OCA\Files_Sharing\External\Storage') && | |
| 514 | +            !$storage->instanceOfStorage('OC\Files\Storage\OwnCloud') && | |
| 515 | + $storage->needsPartFile(); | |
| 516 | + } | |
| 517 | + | |
| 518 | + /** | |
| 519 | + * Convert the given exception to a SabreException instance | |
| 520 | + * | |
| 521 | + * @param \Exception $e | |
| 522 | + * | |
| 523 | + * @throws \Sabre\DAV\Exception | |
| 524 | + */ | |
| 525 | +    private function convertToSabreException(\Exception $e) { | |
| 526 | +        if ($e instanceof \Sabre\DAV\Exception) { | |
| 527 | + throw $e; | |
| 528 | + } | |
| 529 | +        if ($e instanceof NotPermittedException) { | |
| 530 | + // a more general case - due to whatever reason the content could not be written | |
| 531 | + throw new Forbidden($e->getMessage(), 0, $e); | |
| 532 | + } | |
| 533 | +        if ($e instanceof ForbiddenException) { | |
| 534 | + // the path for the file was forbidden | |
| 535 | + throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e); | |
| 536 | + } | |
| 537 | +        if ($e instanceof EntityTooLargeException) { | |
| 538 | + // the file is too big to be stored | |
| 539 | + throw new EntityTooLarge($e->getMessage(), 0, $e); | |
| 540 | + } | |
| 541 | +        if ($e instanceof InvalidContentException) { | |
| 542 | + // the file content is not permitted | |
| 543 | + throw new UnsupportedMediaType($e->getMessage(), 0, $e); | |
| 544 | + } | |
| 545 | +        if ($e instanceof InvalidPathException) { | |
| 546 | + // the path for the file was not valid | |
| 547 | + // TODO: find proper http status code for this case | |
| 548 | + throw new Forbidden($e->getMessage(), 0, $e); | |
| 549 | + } | |
| 550 | +        if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) { | |
| 551 | + // the file is currently being written to by another process | |
| 552 | + throw new FileLocked($e->getMessage(), $e->getCode(), $e); | |
| 553 | + } | |
| 554 | +        if ($e instanceof GenericEncryptionException) { | |
| 555 | + // returning 503 will allow retry of the operation at a later point in time | |
| 556 | +            throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e); | |
| 557 | + } | |
| 558 | +        if ($e instanceof StorageNotAvailableException) { | |
| 559 | +            throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e); | |
| 560 | + } | |
| 561 | + | |
| 562 | + throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e); | |
| 563 | + } | |
| 564 | + | |
| 565 | + /** | |
| 566 | + * Get the checksum for this file | |
| 567 | + * | |
| 568 | + * @return string | |
| 569 | + */ | |
| 570 | +    public function getChecksum() { | |
| 571 | + return $this->info->getChecksum(); | |
| 572 | + } | |
| 573 | 573 | } |